LXR linux/include/linux/nfsd/nfsd.h

   1/*
   2 * linux/include/linux/nfsd/nfsd.h
   3 *
   4 * Hodge-podge collection of knfsd-related stuff.
   5 * I will sort this out later.
   6 *
   7 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
   8 */
   9
  10#ifndef LINUX_NFSD_NFSD_H
  11#define LINUX_NFSD_NFSD_H
  12
  13#include <linux/types.h>
  14#include <linux/unistd.h>
  15#include <linux/dirent.h>
  16#include <linux/fs.h>
  17#include <linux/posix_acl.h>
  18#include <linux/mount.h>
  19
  20#include <linux/nfsd/debug.h>
  21#include <linux/nfsd/nfsfh.h>
  22#include <linux/nfsd/export.h>
  23#include <linux/nfsd/stats.h>
  24/*
  25 * nfsd version
  26 */
  27#define NFSD_VERSION            "0.5"
  28#define NFSD_SUPPORTED_MINOR_VERSION    0
  29
  30#ifdef __KERNEL__
  31/*
  32 * Special flags for nfsd_permission. These must be different from MAY_READ,
  33 * MAY_WRITE, and MAY_EXEC.
  34 */
  35#define MAY_NOP                 0
  36#define MAY_SATTR               8
  37#define MAY_TRUNC               16
  38#define MAY_LOCK                32
  39#define MAY_OWNER_OVERRIDE      64
  40#define MAY_LOCAL_ACCESS        128 /* IRIX doing local access check on device special file*/
  41#if (MAY_SATTR | MAY_TRUNC | MAY_LOCK | MAY_OWNER_OVERRIDE | MAY_LOCAL_ACCESS) & (MAY_READ | MAY_WRITE | MAY_EXEC)
  42# error "please use a different value for MAY_SATTR or MAY_TRUNC or MAY_LOCK or MAY_LOCAL_ACCESS or MAY_OWNER_OVERRIDE."
  43#endif
  44#define MAY_CREATE              (MAY_EXEC|MAY_WRITE)
  45#define MAY_REMOVE              (MAY_EXEC|MAY_WRITE|MAY_TRUNC)
  46
  47/*
  48 * Callback function for readdir
  49 */
  50struct readdir_cd {
  51        __be32                  err;    /* 0, nfserr, or nfserr_eof */
  52};
  53typedef int (*nfsd_dirop_t)(struct inode *, struct dentry *, int, int);
  54
  55extern struct svc_program       nfsd_program;
  56extern struct svc_version       nfsd_version2, nfsd_version3,
  57                                nfsd_version4;
  58extern struct svc_serv          *nfsd_serv;
  59/*
  60 * Function prototypes.
  61 */
  62int             nfsd_svc(unsigned short port, int nrservs);
  63int             nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp);
  64
  65/* nfsd/vfs.c */
  66int             fh_lock_parent(struct svc_fh *, struct dentry *);
  67int             nfsd_racache_init(int);
  68void            nfsd_racache_shutdown(void);
  69int             nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
  70                                struct svc_export **expp);
  71__be32          nfsd_lookup(struct svc_rqst *, struct svc_fh *,
  72                                const char *, unsigned int, struct svc_fh *);
  73__be32           nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
  74                                const char *, unsigned int,
  75                                struct svc_export **, struct dentry **);
  76__be32          nfsd_setattr(struct svc_rqst *, struct svc_fh *,
  77                                struct iattr *, int, time_t);
  78#ifdef CONFIG_NFSD_V4
  79__be32          nfsd4_set_nfs4_acl(struct svc_rqst *, struct svc_fh *,
  80                    struct nfs4_acl *);
  81int             nfsd4_get_nfs4_acl(struct svc_rqst *, struct dentry *, struct nfs4_acl **);
  82#endif /* CONFIG_NFSD_V4 */
  83__be32          nfsd_create(struct svc_rqst *, struct svc_fh *,
  84                                char *name, int len, struct iattr *attrs,
  85                                int type, dev_t rdev, struct svc_fh *res);
  86#ifdef CONFIG_NFSD_V3
  87__be32          nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
  88__be32          nfsd_create_v3(struct svc_rqst *, struct svc_fh *,
  89                                char *name, int len, struct iattr *attrs,
  90                                struct svc_fh *res, int createmode,
  91                                u32 *verifier, int *truncp, int *created);
  92__be32          nfsd_commit(struct svc_rqst *, struct svc_fh *,
  93                                loff_t, unsigned long);
  94#endif /* CONFIG_NFSD_V3 */
  95__be32          nfsd_open(struct svc_rqst *, struct svc_fh *, int,
  96                                int, struct file **);
  97void            nfsd_close(struct file *);
  98__be32          nfsd_read(struct svc_rqst *, struct svc_fh *, struct file *,
  99                                loff_t, struct kvec *, int, unsigned long *);
 100__be32          nfsd_write(struct svc_rqst *, struct svc_fh *,struct file *,
 101                                loff_t, struct kvec *,int, unsigned long, int *);
 102__be32          nfsd_readlink(struct svc_rqst *, struct svc_fh *,
 103                                char *, int *);
 104__be32          nfsd_symlink(struct svc_rqst *, struct svc_fh *,
 105                                char *name, int len, char *path, int plen,
 106                                struct svc_fh *res, struct iattr *);
 107__be32          nfsd_link(struct svc_rqst *, struct svc_fh *,
 108                                char *, int, struct svc_fh *);
 109__be32          nfsd_rename(struct svc_rqst *,
 110                                struct svc_fh *, char *, int,
 111                                struct svc_fh *, char *, int);
 112__be32          nfsd_remove(struct svc_rqst *,
 113                                struct svc_fh *, char *, int);
 114__be32          nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
 115                                char *name, int len);
 116int             nfsd_truncate(struct svc_rqst *, struct svc_fh *,
 117                                unsigned long size);
 118__be32          nfsd_readdir(struct svc_rqst *, struct svc_fh *,
 119                             loff_t *, struct readdir_cd *, filldir_t);
 120__be32          nfsd_statfs(struct svc_rqst *, struct svc_fh *,
 121                                struct kstatfs *);
 122
 123int             nfsd_notify_change(struct inode *, struct iattr *);
 124__be32          nfsd_permission(struct svc_rqst *, struct svc_export *,
 125                                struct dentry *, int);
 126int             nfsd_sync_dir(struct dentry *dp);
 127
 128#if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
 129#ifdef CONFIG_NFSD_V2_ACL
 130extern struct svc_version nfsd_acl_version2;
 131#else
 132#define nfsd_acl_version2 NULL
 133#endif
 134#ifdef CONFIG_NFSD_V3_ACL
 135extern struct svc_version nfsd_acl_version3;
 136#else
 137#define nfsd_acl_version3 NULL
 138#endif
 139struct posix_acl *nfsd_get_posix_acl(struct svc_fh *, int);
 140int nfsd_set_posix_acl(struct svc_fh *, int, struct posix_acl *);
 141#endif
 142
 143enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
 144int nfsd_vers(int vers, enum vers_op change);
 145void nfsd_reset_versions(void);
 146int nfsd_create_serv(void);
 147
 148extern int nfsd_max_blksize;
 149
 150/* 
 151 * NFSv4 State
 152 */
 153#ifdef CONFIG_NFSD_V4
 154extern unsigned int max_delegations;
 155int nfs4_state_init(void);
 156void nfsd4_free_slabs(void);
 157void nfs4_state_start(void);
 158void nfs4_state_shutdown(void);
 159time_t nfs4_lease_time(void);
 160void nfs4_reset_lease(time_t leasetime);
 161int nfs4_reset_recoverydir(char *recdir);
 162#else
 163static inline int nfs4_state_init(void) { return 0; }
 164static inline void nfsd4_free_slabs(void) { }
 165static inline void nfs4_state_start(void) { }
 166static inline void nfs4_state_shutdown(void) { }
 167static inline time_t nfs4_lease_time(void) { return 0; }
 168static inline void nfs4_reset_lease(time_t leasetime) { }
 169static inline int nfs4_reset_recoverydir(char *recdir) { return 0; }
 170#endif
 171
 172/*
 173 * lockd binding
 174 */
 175void            nfsd_lockd_init(void);
 176void            nfsd_lockd_shutdown(void);
 177
 178
 179/*
 180 * These macros provide pre-xdr'ed values for faster operation.
 181 */
 182#define nfs_ok                  __constant_htonl(NFS_OK)
 183#define nfserr_perm             __constant_htonl(NFSERR_PERM)
 184#define nfserr_noent            __constant_htonl(NFSERR_NOENT)
 185#define nfserr_io               __constant_htonl(NFSERR_IO)
 186#define nfserr_nxio             __constant_htonl(NFSERR_NXIO)
 187#define nfserr_eagain           __constant_htonl(NFSERR_EAGAIN)
 188#define nfserr_acces            __constant_htonl(NFSERR_ACCES)
 189#define nfserr_exist            __constant_htonl(NFSERR_EXIST)
 190#define nfserr_xdev             __constant_htonl(NFSERR_XDEV)
 191#define nfserr_nodev            __constant_htonl(NFSERR_NODEV)
 192#define nfserr_notdir           __constant_htonl(NFSERR_NOTDIR)
 193#define nfserr_isdir            __constant_htonl(NFSERR_ISDIR)
 194#define nfserr_inval            __constant_htonl(NFSERR_INVAL)
 195#define nfserr_fbig             __constant_htonl(NFSERR_FBIG)
 196#define nfserr_nospc            __constant_htonl(NFSERR_NOSPC)
 197#define nfserr_rofs             __constant_htonl(NFSERR_ROFS)
 198#define nfserr_mlink            __constant_htonl(NFSERR_MLINK)
 199#define nfserr_opnotsupp        __constant_htonl(NFSERR_OPNOTSUPP)
 200#define nfserr_nametoolong      __constant_htonl(NFSERR_NAMETOOLONG)
 201#define nfserr_notempty         __constant_htonl(NFSERR_NOTEMPTY)
 202#define nfserr_dquot            __constant_htonl(NFSERR_DQUOT)
 203#define nfserr_stale            __constant_htonl(NFSERR_STALE)
 204#define nfserr_remote           __constant_htonl(NFSERR_REMOTE)
 205#define nfserr_wflush           __constant_htonl(NFSERR_WFLUSH)
 206#define nfserr_badhandle        __constant_htonl(NFSERR_BADHANDLE)
 207#define nfserr_notsync          __constant_htonl(NFSERR_NOT_SYNC)
 208#define nfserr_badcookie        __constant_htonl(NFSERR_BAD_COOKIE)
 209#define nfserr_notsupp          __constant_htonl(NFSERR_NOTSUPP)
 210#define nfserr_toosmall         __constant_htonl(NFSERR_TOOSMALL)
 211#define nfserr_serverfault      __constant_htonl(NFSERR_SERVERFAULT)
 212#define nfserr_badtype          __constant_htonl(NFSERR_BADTYPE)
 213#define nfserr_jukebox          __constant_htonl(NFSERR_JUKEBOX)
 214#define nfserr_denied           __constant_htonl(NFSERR_DENIED)
 215#define nfserr_deadlock         __constant_htonl(NFSERR_DEADLOCK)
 216#define nfserr_expired          __constant_htonl(NFSERR_EXPIRED)
 217#define nfserr_bad_cookie       __constant_htonl(NFSERR_BAD_COOKIE)
 218#define nfserr_same             __constant_htonl(NFSERR_SAME)
 219#define nfserr_clid_inuse       __constant_htonl(NFSERR_CLID_INUSE)
 220#define nfserr_stale_clientid   __constant_htonl(NFSERR_STALE_CLIENTID)
 221#define nfserr_resource         __constant_htonl(NFSERR_RESOURCE)
 222#define nfserr_moved            __constant_htonl(NFSERR_MOVED)
 223#define nfserr_nofilehandle     __constant_htonl(NFSERR_NOFILEHANDLE)
 224#define nfserr_minor_vers_mismatch      __constant_htonl(NFSERR_MINOR_VERS_MISMATCH)
 225#define nfserr_share_denied     __constant_htonl(NFSERR_SHARE_DENIED)
 226#define nfserr_stale_stateid    __constant_htonl(NFSERR_STALE_STATEID)
 227#define nfserr_old_stateid      __constant_htonl(NFSERR_OLD_STATEID)
 228#define nfserr_bad_stateid      __constant_htonl(NFSERR_BAD_STATEID)
 229#define nfserr_bad_seqid        __constant_htonl(NFSERR_BAD_SEQID)
 230#define nfserr_symlink          __constant_htonl(NFSERR_SYMLINK)
 231#define nfserr_not_same         __constant_htonl(NFSERR_NOT_SAME)
 232#define nfserr_restorefh        __constant_htonl(NFSERR_RESTOREFH)
 233#define nfserr_attrnotsupp      __constant_htonl(NFSERR_ATTRNOTSUPP)
 234#define nfserr_bad_xdr          __constant_htonl(NFSERR_BAD_XDR)
 235#define nfserr_openmode         __constant_htonl(NFSERR_OPENMODE)
 236#define nfserr_locks_held       __constant_htonl(NFSERR_LOCKS_HELD)
 237#define nfserr_op_illegal       __constant_htonl(NFSERR_OP_ILLEGAL)
 238#define nfserr_grace            __constant_htonl(NFSERR_GRACE)
 239#define nfserr_no_grace         __constant_htonl(NFSERR_NO_GRACE)
 240#define nfserr_reclaim_bad      __constant_htonl(NFSERR_RECLAIM_BAD)
 241#define nfserr_badname          __constant_htonl(NFSERR_BADNAME)
 242#define nfserr_cb_path_down     __constant_htonl(NFSERR_CB_PATH_DOWN)
 243#define nfserr_locked           __constant_htonl(NFSERR_LOCKED)
 244#define nfserr_wrongsec         __constant_htonl(NFSERR_WRONGSEC)
 245#define nfserr_replay_me        __constant_htonl(NFSERR_REPLAY_ME)
 246
 247/* error codes for internal use */
 248/* if a request fails due to kmalloc failure, it gets dropped.
 249 *  Client should resend eventually
 250 */
 251#define nfserr_dropit           __constant_htonl(30000)
 252/* end-of-file indicator in readdir */
 253#define nfserr_eof              __constant_htonl(30001)
 254
 255/* Check for dir entries '.' and '..' */
 256#define isdotent(n, l)  (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
 257
 258/*
 259 * Time of server startup
 260 */
 261extern struct timeval   nfssvc_boot;
 262
 263#ifdef CONFIG_NFSD_V4
 264
 265/* before processing a COMPOUND operation, we have to check that there
 266 * is enough space in the buffer for XDR encode to succeed.  otherwise,
 267 * we might process an operation with side effects, and be unable to
 268 * tell the client that the operation succeeded.
 269 *
 270 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
 271 * needed to encode an "ordinary" _successful_ operation.  (GETATTR,
 272 * READ, READDIR, and READLINK have their own buffer checks.)  if we
 273 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
 274 *
 275 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
 276 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
 277 * care is taken to ensure that we never fall below this level for any
 278 * reason.
 279 */
 280#define COMPOUND_SLACK_SPACE            140    /* OP_GETFH */
 281#define COMPOUND_ERR_SLACK_SPACE        12     /* OP_SETATTR */
 282
 283#define NFSD_LEASE_TIME                 (nfs4_lease_time())
 284#define NFSD_LAUNDROMAT_MINTIMEOUT      10   /* seconds */
 285
 286/*
 287 * The following attributes are currently not supported by the NFSv4 server:
 288 *    ARCHIVE       (deprecated anyway)
 289 *    HIDDEN        (unlikely to be supported any time soon)
 290 *    MIMETYPE      (unlikely to be supported any time soon)
 291 *    QUOTA_*       (will be supported in a forthcoming patch)
 292 *    SYSTEM        (unlikely to be supported any time soon)
 293 *    TIME_BACKUP   (unlikely to be supported any time soon)
 294 *    TIME_CREATE   (unlikely to be supported any time soon)
 295 */
 296#define NFSD_SUPPORTED_ATTRS_WORD0                                                          \
 297(FATTR4_WORD0_SUPPORTED_ATTRS   | FATTR4_WORD0_TYPE         | FATTR4_WORD0_FH_EXPIRE_TYPE   \
 298 | FATTR4_WORD0_CHANGE          | FATTR4_WORD0_SIZE         | FATTR4_WORD0_LINK_SUPPORT     \
 299 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR   | FATTR4_WORD0_FSID             \
 300 | FATTR4_WORD0_UNIQUE_HANDLES  | FATTR4_WORD0_LEASE_TIME   | FATTR4_WORD0_RDATTR_ERROR     \
 301 | FATTR4_WORD0_ACLSUPPORT      | FATTR4_WORD0_CANSETTIME   | FATTR4_WORD0_CASE_INSENSITIVE \
 302 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED                             \
 303 | FATTR4_WORD0_FILEHANDLE      | FATTR4_WORD0_FILEID       | FATTR4_WORD0_FILES_AVAIL      \
 304 | FATTR4_WORD0_FILES_FREE      | FATTR4_WORD0_FILES_TOTAL  | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS      \
 305 | FATTR4_WORD0_MAXFILESIZE     | FATTR4_WORD0_MAXLINK      | FATTR4_WORD0_MAXNAME          \
 306 | FATTR4_WORD0_MAXREAD         | FATTR4_WORD0_MAXWRITE     | FATTR4_WORD0_ACL)
 307
 308#define NFSD_SUPPORTED_ATTRS_WORD1                                                          \
 309(FATTR4_WORD1_MODE              | FATTR4_WORD1_NO_TRUNC     | FATTR4_WORD1_NUMLINKS         \
 310 | FATTR4_WORD1_OWNER           | FATTR4_WORD1_OWNER_GROUP  | FATTR4_WORD1_RAWDEV           \
 311 | FATTR4_WORD1_SPACE_AVAIL     | FATTR4_WORD1_SPACE_FREE   | FATTR4_WORD1_SPACE_TOTAL      \
 312 | FATTR4_WORD1_SPACE_USED      | FATTR4_WORD1_TIME_ACCESS  | FATTR4_WORD1_TIME_ACCESS_SET  \
 313 | FATTR4_WORD1_TIME_DELTA   | FATTR4_WORD1_TIME_METADATA    \
 314 | FATTR4_WORD1_TIME_MODIFY     | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
 315
 316/* These will return ERR_INVAL if specified in GETATTR or READDIR. */
 317#define NFSD_WRITEONLY_ATTRS_WORD1                                                          \
 318(FATTR4_WORD1_TIME_ACCESS_SET   | FATTR4_WORD1_TIME_MODIFY_SET)
 319
 320/* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
 321#define NFSD_WRITEABLE_ATTRS_WORD0                                                          \
 322(FATTR4_WORD0_SIZE              | FATTR4_WORD0_ACL                                         )
 323#define NFSD_WRITEABLE_ATTRS_WORD1                                                          \
 324(FATTR4_WORD1_MODE              | FATTR4_WORD1_OWNER         | FATTR4_WORD1_OWNER_GROUP     \
 325 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_METADATA | FATTR4_WORD1_TIME_MODIFY_SET)
 326
 327#endif /* CONFIG_NFSD_V4 */
 328
 329#endif /* __KERNEL__ */
 330
 331#endif /* LINUX_NFSD_NFSD_H */
 332