2 * linux/include/linux/nfsd/nfsd.h
4 * Hodge-podge collection of knfsd-related stuff.
5 * I will sort this out later.
7 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
10 #ifndef LINUX_NFSD_NFSD_H
11 #define LINUX_NFSD_NFSD_H
13 #include <linux/types.h>
14 #include <linux/unistd.h>
16 #include <linux/posix_acl.h>
17 #include <linux/mount.h>
19 #include <linux/nfsd/debug.h>
20 #include <linux/nfsd/nfsfh.h>
21 #include <linux/nfsd/export.h>
22 #include <linux/nfsd/stats.h>
26 #define NFSD_SUPPORTED_MINOR_VERSION 0
29 * Flags for nfsd_permission
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
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)
46 * Callback function for readdir
49 __be32 err; /* 0, nfserr, or nfserr_eof */
51 typedef int (*nfsd_dirop_t)(struct inode *, struct dentry *, int, int);
53 extern struct svc_program nfsd_program;
54 extern struct svc_version nfsd_version2, nfsd_version3,
56 extern struct mutex nfsd_mutex;
57 extern struct svc_serv *nfsd_serv;
59 extern struct seq_operations nfs_exports_op;
62 * Function prototypes.
64 int nfsd_svc(unsigned short port, int nrservs);
65 int nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp);
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 *);
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);
86 __be32 nfsd4_set_nfs4_acl(struct svc_rqst *, struct svc_fh *,
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);
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 *,
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 *,
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);
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);
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;
139 #define nfsd_acl_version2 NULL
141 #ifdef CONFIG_NFSD_V3_ACL
142 extern struct svc_version nfsd_acl_version3;
144 #define nfsd_acl_version3 NULL
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 *);
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);
155 extern int nfsd_max_blksize;
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);
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; }
182 void nfsd_lockd_init(void);
183 void nfsd_lockd_shutdown(void);
187 * These macros provide pre-xdr'ed values for faster operation.
189 #define nfs_ok cpu_to_be32(NFS_OK)
190 #define nfserr_perm cpu_to_be32(NFSERR_PERM)
191 #define nfserr_noent cpu_to_be32(NFSERR_NOENT)
192 #define nfserr_io cpu_to_be32(NFSERR_IO)
193 #define nfserr_nxio cpu_to_be32(NFSERR_NXIO)
194 #define nfserr_eagain cpu_to_be32(NFSERR_EAGAIN)
195 #define nfserr_acces cpu_to_be32(NFSERR_ACCES)
196 #define nfserr_exist cpu_to_be32(NFSERR_EXIST)
197 #define nfserr_xdev cpu_to_be32(NFSERR_XDEV)
198 #define nfserr_nodev cpu_to_be32(NFSERR_NODEV)
199 #define nfserr_notdir cpu_to_be32(NFSERR_NOTDIR)
200 #define nfserr_isdir cpu_to_be32(NFSERR_ISDIR)
201 #define nfserr_inval cpu_to_be32(NFSERR_INVAL)
202 #define nfserr_fbig cpu_to_be32(NFSERR_FBIG)
203 #define nfserr_nospc cpu_to_be32(NFSERR_NOSPC)
204 #define nfserr_rofs cpu_to_be32(NFSERR_ROFS)
205 #define nfserr_mlink cpu_to_be32(NFSERR_MLINK)
206 #define nfserr_opnotsupp cpu_to_be32(NFSERR_OPNOTSUPP)
207 #define nfserr_nametoolong cpu_to_be32(NFSERR_NAMETOOLONG)
208 #define nfserr_notempty cpu_to_be32(NFSERR_NOTEMPTY)
209 #define nfserr_dquot cpu_to_be32(NFSERR_DQUOT)
210 #define nfserr_stale cpu_to_be32(NFSERR_STALE)
211 #define nfserr_remote cpu_to_be32(NFSERR_REMOTE)
212 #define nfserr_wflush cpu_to_be32(NFSERR_WFLUSH)
213 #define nfserr_badhandle cpu_to_be32(NFSERR_BADHANDLE)
214 #define nfserr_notsync cpu_to_be32(NFSERR_NOT_SYNC)
215 #define nfserr_badcookie cpu_to_be32(NFSERR_BAD_COOKIE)
216 #define nfserr_notsupp cpu_to_be32(NFSERR_NOTSUPP)
217 #define nfserr_toosmall cpu_to_be32(NFSERR_TOOSMALL)
218 #define nfserr_serverfault cpu_to_be32(NFSERR_SERVERFAULT)
219 #define nfserr_badtype cpu_to_be32(NFSERR_BADTYPE)
220 #define nfserr_jukebox cpu_to_be32(NFSERR_JUKEBOX)
221 #define nfserr_denied cpu_to_be32(NFSERR_DENIED)
222 #define nfserr_deadlock cpu_to_be32(NFSERR_DEADLOCK)
223 #define nfserr_expired cpu_to_be32(NFSERR_EXPIRED)
224 #define nfserr_bad_cookie cpu_to_be32(NFSERR_BAD_COOKIE)
225 #define nfserr_same cpu_to_be32(NFSERR_SAME)
226 #define nfserr_clid_inuse cpu_to_be32(NFSERR_CLID_INUSE)
227 #define nfserr_stale_clientid cpu_to_be32(NFSERR_STALE_CLIENTID)
228 #define nfserr_resource cpu_to_be32(NFSERR_RESOURCE)
229 #define nfserr_moved cpu_to_be32(NFSERR_MOVED)
230 #define nfserr_nofilehandle cpu_to_be32(NFSERR_NOFILEHANDLE)
231 #define nfserr_minor_vers_mismatch cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH)
232 #define nfserr_share_denied cpu_to_be32(NFSERR_SHARE_DENIED)
233 #define nfserr_stale_stateid cpu_to_be32(NFSERR_STALE_STATEID)
234 #define nfserr_old_stateid cpu_to_be32(NFSERR_OLD_STATEID)
235 #define nfserr_bad_stateid cpu_to_be32(NFSERR_BAD_STATEID)
236 #define nfserr_bad_seqid cpu_to_be32(NFSERR_BAD_SEQID)
237 #define nfserr_symlink cpu_to_be32(NFSERR_SYMLINK)
238 #define nfserr_not_same cpu_to_be32(NFSERR_NOT_SAME)
239 #define nfserr_restorefh cpu_to_be32(NFSERR_RESTOREFH)
240 #define nfserr_attrnotsupp cpu_to_be32(NFSERR_ATTRNOTSUPP)
241 #define nfserr_bad_xdr cpu_to_be32(NFSERR_BAD_XDR)
242 #define nfserr_openmode cpu_to_be32(NFSERR_OPENMODE)
243 #define nfserr_locks_held cpu_to_be32(NFSERR_LOCKS_HELD)
244 #define nfserr_op_illegal cpu_to_be32(NFSERR_OP_ILLEGAL)
245 #define nfserr_grace cpu_to_be32(NFSERR_GRACE)
246 #define nfserr_no_grace cpu_to_be32(NFSERR_NO_GRACE)
247 #define nfserr_reclaim_bad cpu_to_be32(NFSERR_RECLAIM_BAD)
248 #define nfserr_badname cpu_to_be32(NFSERR_BADNAME)
249 #define nfserr_cb_path_down cpu_to_be32(NFSERR_CB_PATH_DOWN)
250 #define nfserr_locked cpu_to_be32(NFSERR_LOCKED)
251 #define nfserr_wrongsec cpu_to_be32(NFSERR_WRONGSEC)
252 #define nfserr_badiomode cpu_to_be32(NFS4ERR_BADIOMODE)
253 #define nfserr_badlayout cpu_to_be32(NFS4ERR_BADLAYOUT)
254 #define nfserr_bad_session_digest cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST)
255 #define nfserr_badsession cpu_to_be32(NFS4ERR_BADSESSION)
256 #define nfserr_badslot cpu_to_be32(NFS4ERR_BADSLOT)
257 #define nfserr_complete_already cpu_to_be32(NFS4ERR_COMPLETE_ALREADY)
258 #define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
259 #define nfserr_deleg_already_wanted cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED)
260 #define nfserr_back_chan_busy cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY)
261 #define nfserr_layouttrylater cpu_to_be32(NFS4ERR_LAYOUTTRYLATER)
262 #define nfserr_layoutunavailable cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE)
263 #define nfserr_nomatching_layout cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT)
264 #define nfserr_recallconflict cpu_to_be32(NFS4ERR_RECALLCONFLICT)
265 #define nfserr_unknown_layouttype cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE)
266 #define nfserr_seq_misordered cpu_to_be32(NFS4ERR_SEQ_MISORDERED)
267 #define nfserr_sequence_pos cpu_to_be32(NFS4ERR_SEQUENCE_POS)
268 #define nfserr_req_too_big cpu_to_be32(NFS4ERR_REQ_TOO_BIG)
269 #define nfserr_rep_too_big cpu_to_be32(NFS4ERR_REP_TOO_BIG)
270 #define nfserr_rep_too_big_to_cache cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE)
271 #define nfserr_retry_uncached_rep cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP)
272 #define nfserr_unsafe_compound cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND)
273 #define nfserr_too_many_ops cpu_to_be32(NFS4ERR_TOO_MANY_OPS)
274 #define nfserr_op_not_in_session cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION)
275 #define nfserr_hash_alg_unsupp cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP)
276 #define nfserr_clientid_busy cpu_to_be32(NFS4ERR_CLIENTID_BUSY)
277 #define nfserr_pnfs_io_hole cpu_to_be32(NFS4ERR_PNFS_IO_HOLE)
278 #define nfserr_seq_false_retry cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY)
279 #define nfserr_bad_high_slot cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT)
280 #define nfserr_deadsession cpu_to_be32(NFS4ERR_DEADSESSION)
281 #define nfserr_encr_alg_unsupp cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP)
282 #define nfserr_pnfs_no_layout cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT)
283 #define nfserr_not_only_op cpu_to_be32(NFS4ERR_NOT_ONLY_OP)
284 #define nfserr_wrong_cred cpu_to_be32(NFS4ERR_WRONG_CRED)
285 #define nfserr_wrong_type cpu_to_be32(NFS4ERR_WRONG_TYPE)
286 #define nfserr_dirdeleg_unavail cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL)
287 #define nfserr_reject_deleg cpu_to_be32(NFS4ERR_REJECT_DELEG)
288 #define nfserr_returnconflict cpu_to_be32(NFS4ERR_RETURNCONFLICT)
289 #define nfserr_deleg_revoked cpu_to_be32(NFS4ERR_DELEG_REVOKED)
291 /* error codes for internal use */
292 /* if a request fails due to kmalloc failure, it gets dropped.
293 * Client should resend eventually
295 #define nfserr_dropit cpu_to_be32(30000)
296 /* end-of-file indicator in readdir */
297 #define nfserr_eof cpu_to_be32(30001)
298 /* replay detected */
299 #define nfserr_replay_me cpu_to_be32(11001)
300 /* nfs41 replay detected */
301 #define nfserr_replay_cache cpu_to_be32(11002)
303 /* Check for dir entries '.' and '..' */
304 #define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
307 * Time of server startup
309 extern struct timeval nfssvc_boot;
311 #ifdef CONFIG_NFSD_V4
313 /* before processing a COMPOUND operation, we have to check that there
314 * is enough space in the buffer for XDR encode to succeed. otherwise,
315 * we might process an operation with side effects, and be unable to
316 * tell the client that the operation succeeded.
318 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
319 * needed to encode an "ordinary" _successful_ operation. (GETATTR,
320 * READ, READDIR, and READLINK have their own buffer checks.) if we
321 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
323 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
324 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
325 * care is taken to ensure that we never fall below this level for any
328 #define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
329 #define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
331 #define NFSD_LEASE_TIME (nfs4_lease_time())
332 #define NFSD_LAUNDROMAT_MINTIMEOUT 10 /* seconds */
335 * The following attributes are currently not supported by the NFSv4 server:
336 * ARCHIVE (deprecated anyway)
337 * HIDDEN (unlikely to be supported any time soon)
338 * MIMETYPE (unlikely to be supported any time soon)
339 * QUOTA_* (will be supported in a forthcoming patch)
340 * SYSTEM (unlikely to be supported any time soon)
341 * TIME_BACKUP (unlikely to be supported any time soon)
342 * TIME_CREATE (unlikely to be supported any time soon)
344 #define NFSD_SUPPORTED_ATTRS_WORD0 \
345 (FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
346 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
347 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
348 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
349 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
350 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
351 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
352 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \
353 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
354 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL)
356 #define NFSD_SUPPORTED_ATTRS_WORD1 \
357 (FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
358 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
359 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
360 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
361 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
362 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
364 /* These will return ERR_INVAL if specified in GETATTR or READDIR. */
365 #define NFSD_WRITEONLY_ATTRS_WORD1 \
366 (FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
368 /* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
369 #define NFSD_WRITEABLE_ATTRS_WORD0 \
370 (FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL )
371 #define NFSD_WRITEABLE_ATTRS_WORD1 \
372 (FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
373 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
375 #endif /* CONFIG_NFSD_V4 */
377 #endif /* LINUX_NFSD_NFSD_H */