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