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