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/mount.h>
16 #include <linux/nfsd/debug.h>
17 #include <linux/nfsd/export.h>
18 #include <linux/nfsd/stats.h>
22 #define NFSD_SUPPORTED_MINOR_VERSION 1
25 __be32 err; /* 0, nfserr, or nfserr_eof */
29 extern struct svc_program nfsd_program;
30 extern struct svc_version nfsd_version2, nfsd_version3,
32 extern u32 nfsd_supported_minorversion;
33 extern struct mutex nfsd_mutex;
34 extern struct svc_serv *nfsd_serv;
35 extern spinlock_t nfsd_drc_lock;
36 extern unsigned int nfsd_drc_max_mem;
37 extern unsigned int nfsd_drc_mem_used;
39 extern const struct seq_operations nfs_exports_op;
42 * Function prototypes.
44 int nfsd_svc(unsigned short port, int nrservs);
45 int nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp);
47 int nfsd_nrthreads(void);
48 int nfsd_nrpools(void);
49 int nfsd_get_nrthreads(int n, int *);
50 int nfsd_set_nrthreads(int n, int *);
52 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
53 #ifdef CONFIG_NFSD_V2_ACL
54 extern struct svc_version nfsd_acl_version2;
56 #define nfsd_acl_version2 NULL
58 #ifdef CONFIG_NFSD_V3_ACL
59 extern struct svc_version nfsd_acl_version3;
61 #define nfsd_acl_version3 NULL
65 enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
66 int nfsd_vers(int vers, enum vers_op change);
67 int nfsd_minorversion(u32 minorversion, enum vers_op change);
68 void nfsd_reset_versions(void);
69 int nfsd_create_serv(void);
71 extern int nfsd_max_blksize;
77 extern unsigned int max_delegations;
78 int nfs4_state_init(void);
79 void nfsd4_free_slabs(void);
80 int nfs4_state_start(void);
81 void nfs4_state_shutdown(void);
82 time_t nfs4_lease_time(void);
83 void nfs4_reset_lease(time_t leasetime);
84 int nfs4_reset_recoverydir(char *recdir);
86 static inline int nfs4_state_init(void) { return 0; }
87 static inline void nfsd4_free_slabs(void) { }
88 static inline int nfs4_state_start(void) { return 0; }
89 static inline void nfs4_state_shutdown(void) { }
90 static inline time_t nfs4_lease_time(void) { return 0; }
91 static inline void nfs4_reset_lease(time_t leasetime) { }
92 static inline int nfs4_reset_recoverydir(char *recdir) { return 0; }
98 void nfsd_lockd_init(void);
99 void nfsd_lockd_shutdown(void);
103 * These macros provide pre-xdr'ed values for faster operation.
105 #define nfs_ok cpu_to_be32(NFS_OK)
106 #define nfserr_perm cpu_to_be32(NFSERR_PERM)
107 #define nfserr_noent cpu_to_be32(NFSERR_NOENT)
108 #define nfserr_io cpu_to_be32(NFSERR_IO)
109 #define nfserr_nxio cpu_to_be32(NFSERR_NXIO)
110 #define nfserr_eagain cpu_to_be32(NFSERR_EAGAIN)
111 #define nfserr_acces cpu_to_be32(NFSERR_ACCES)
112 #define nfserr_exist cpu_to_be32(NFSERR_EXIST)
113 #define nfserr_xdev cpu_to_be32(NFSERR_XDEV)
114 #define nfserr_nodev cpu_to_be32(NFSERR_NODEV)
115 #define nfserr_notdir cpu_to_be32(NFSERR_NOTDIR)
116 #define nfserr_isdir cpu_to_be32(NFSERR_ISDIR)
117 #define nfserr_inval cpu_to_be32(NFSERR_INVAL)
118 #define nfserr_fbig cpu_to_be32(NFSERR_FBIG)
119 #define nfserr_nospc cpu_to_be32(NFSERR_NOSPC)
120 #define nfserr_rofs cpu_to_be32(NFSERR_ROFS)
121 #define nfserr_mlink cpu_to_be32(NFSERR_MLINK)
122 #define nfserr_opnotsupp cpu_to_be32(NFSERR_OPNOTSUPP)
123 #define nfserr_nametoolong cpu_to_be32(NFSERR_NAMETOOLONG)
124 #define nfserr_notempty cpu_to_be32(NFSERR_NOTEMPTY)
125 #define nfserr_dquot cpu_to_be32(NFSERR_DQUOT)
126 #define nfserr_stale cpu_to_be32(NFSERR_STALE)
127 #define nfserr_remote cpu_to_be32(NFSERR_REMOTE)
128 #define nfserr_wflush cpu_to_be32(NFSERR_WFLUSH)
129 #define nfserr_badhandle cpu_to_be32(NFSERR_BADHANDLE)
130 #define nfserr_notsync cpu_to_be32(NFSERR_NOT_SYNC)
131 #define nfserr_badcookie cpu_to_be32(NFSERR_BAD_COOKIE)
132 #define nfserr_notsupp cpu_to_be32(NFSERR_NOTSUPP)
133 #define nfserr_toosmall cpu_to_be32(NFSERR_TOOSMALL)
134 #define nfserr_serverfault cpu_to_be32(NFSERR_SERVERFAULT)
135 #define nfserr_badtype cpu_to_be32(NFSERR_BADTYPE)
136 #define nfserr_jukebox cpu_to_be32(NFSERR_JUKEBOX)
137 #define nfserr_denied cpu_to_be32(NFSERR_DENIED)
138 #define nfserr_deadlock cpu_to_be32(NFSERR_DEADLOCK)
139 #define nfserr_expired cpu_to_be32(NFSERR_EXPIRED)
140 #define nfserr_bad_cookie cpu_to_be32(NFSERR_BAD_COOKIE)
141 #define nfserr_same cpu_to_be32(NFSERR_SAME)
142 #define nfserr_clid_inuse cpu_to_be32(NFSERR_CLID_INUSE)
143 #define nfserr_stale_clientid cpu_to_be32(NFSERR_STALE_CLIENTID)
144 #define nfserr_resource cpu_to_be32(NFSERR_RESOURCE)
145 #define nfserr_moved cpu_to_be32(NFSERR_MOVED)
146 #define nfserr_nofilehandle cpu_to_be32(NFSERR_NOFILEHANDLE)
147 #define nfserr_minor_vers_mismatch cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH)
148 #define nfserr_share_denied cpu_to_be32(NFSERR_SHARE_DENIED)
149 #define nfserr_stale_stateid cpu_to_be32(NFSERR_STALE_STATEID)
150 #define nfserr_old_stateid cpu_to_be32(NFSERR_OLD_STATEID)
151 #define nfserr_bad_stateid cpu_to_be32(NFSERR_BAD_STATEID)
152 #define nfserr_bad_seqid cpu_to_be32(NFSERR_BAD_SEQID)
153 #define nfserr_symlink cpu_to_be32(NFSERR_SYMLINK)
154 #define nfserr_not_same cpu_to_be32(NFSERR_NOT_SAME)
155 #define nfserr_restorefh cpu_to_be32(NFSERR_RESTOREFH)
156 #define nfserr_attrnotsupp cpu_to_be32(NFSERR_ATTRNOTSUPP)
157 #define nfserr_bad_xdr cpu_to_be32(NFSERR_BAD_XDR)
158 #define nfserr_openmode cpu_to_be32(NFSERR_OPENMODE)
159 #define nfserr_locks_held cpu_to_be32(NFSERR_LOCKS_HELD)
160 #define nfserr_op_illegal cpu_to_be32(NFSERR_OP_ILLEGAL)
161 #define nfserr_grace cpu_to_be32(NFSERR_GRACE)
162 #define nfserr_no_grace cpu_to_be32(NFSERR_NO_GRACE)
163 #define nfserr_reclaim_bad cpu_to_be32(NFSERR_RECLAIM_BAD)
164 #define nfserr_badname cpu_to_be32(NFSERR_BADNAME)
165 #define nfserr_cb_path_down cpu_to_be32(NFSERR_CB_PATH_DOWN)
166 #define nfserr_locked cpu_to_be32(NFSERR_LOCKED)
167 #define nfserr_wrongsec cpu_to_be32(NFSERR_WRONGSEC)
168 #define nfserr_badiomode cpu_to_be32(NFS4ERR_BADIOMODE)
169 #define nfserr_badlayout cpu_to_be32(NFS4ERR_BADLAYOUT)
170 #define nfserr_bad_session_digest cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST)
171 #define nfserr_badsession cpu_to_be32(NFS4ERR_BADSESSION)
172 #define nfserr_badslot cpu_to_be32(NFS4ERR_BADSLOT)
173 #define nfserr_complete_already cpu_to_be32(NFS4ERR_COMPLETE_ALREADY)
174 #define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
175 #define nfserr_deleg_already_wanted cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED)
176 #define nfserr_back_chan_busy cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY)
177 #define nfserr_layouttrylater cpu_to_be32(NFS4ERR_LAYOUTTRYLATER)
178 #define nfserr_layoutunavailable cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE)
179 #define nfserr_nomatching_layout cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT)
180 #define nfserr_recallconflict cpu_to_be32(NFS4ERR_RECALLCONFLICT)
181 #define nfserr_unknown_layouttype cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE)
182 #define nfserr_seq_misordered cpu_to_be32(NFS4ERR_SEQ_MISORDERED)
183 #define nfserr_sequence_pos cpu_to_be32(NFS4ERR_SEQUENCE_POS)
184 #define nfserr_req_too_big cpu_to_be32(NFS4ERR_REQ_TOO_BIG)
185 #define nfserr_rep_too_big cpu_to_be32(NFS4ERR_REP_TOO_BIG)
186 #define nfserr_rep_too_big_to_cache cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE)
187 #define nfserr_retry_uncached_rep cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP)
188 #define nfserr_unsafe_compound cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND)
189 #define nfserr_too_many_ops cpu_to_be32(NFS4ERR_TOO_MANY_OPS)
190 #define nfserr_op_not_in_session cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION)
191 #define nfserr_hash_alg_unsupp cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP)
192 #define nfserr_clientid_busy cpu_to_be32(NFS4ERR_CLIENTID_BUSY)
193 #define nfserr_pnfs_io_hole cpu_to_be32(NFS4ERR_PNFS_IO_HOLE)
194 #define nfserr_seq_false_retry cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY)
195 #define nfserr_bad_high_slot cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT)
196 #define nfserr_deadsession cpu_to_be32(NFS4ERR_DEADSESSION)
197 #define nfserr_encr_alg_unsupp cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP)
198 #define nfserr_pnfs_no_layout cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT)
199 #define nfserr_not_only_op cpu_to_be32(NFS4ERR_NOT_ONLY_OP)
200 #define nfserr_wrong_cred cpu_to_be32(NFS4ERR_WRONG_CRED)
201 #define nfserr_wrong_type cpu_to_be32(NFS4ERR_WRONG_TYPE)
202 #define nfserr_dirdeleg_unavail cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL)
203 #define nfserr_reject_deleg cpu_to_be32(NFS4ERR_REJECT_DELEG)
204 #define nfserr_returnconflict cpu_to_be32(NFS4ERR_RETURNCONFLICT)
205 #define nfserr_deleg_revoked cpu_to_be32(NFS4ERR_DELEG_REVOKED)
207 /* error codes for internal use */
208 /* if a request fails due to kmalloc failure, it gets dropped.
209 * Client should resend eventually
211 #define nfserr_dropit cpu_to_be32(30000)
212 /* end-of-file indicator in readdir */
213 #define nfserr_eof cpu_to_be32(30001)
214 /* replay detected */
215 #define nfserr_replay_me cpu_to_be32(11001)
216 /* nfs41 replay detected */
217 #define nfserr_replay_cache cpu_to_be32(11002)
219 /* Check for dir entries '.' and '..' */
220 #define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
223 * Time of server startup
225 extern struct timeval nfssvc_boot;
227 #ifdef CONFIG_NFSD_V4
229 /* before processing a COMPOUND operation, we have to check that there
230 * is enough space in the buffer for XDR encode to succeed. otherwise,
231 * we might process an operation with side effects, and be unable to
232 * tell the client that the operation succeeded.
234 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
235 * needed to encode an "ordinary" _successful_ operation. (GETATTR,
236 * READ, READDIR, and READLINK have their own buffer checks.) if we
237 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
239 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
240 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
241 * care is taken to ensure that we never fall below this level for any
244 #define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
245 #define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
247 #define NFSD_LEASE_TIME (nfs4_lease_time())
248 #define NFSD_LAUNDROMAT_MINTIMEOUT 10 /* seconds */
251 * The following attributes are currently not supported by the NFSv4 server:
252 * ARCHIVE (deprecated anyway)
253 * HIDDEN (unlikely to be supported any time soon)
254 * MIMETYPE (unlikely to be supported any time soon)
255 * QUOTA_* (will be supported in a forthcoming patch)
256 * SYSTEM (unlikely to be supported any time soon)
257 * TIME_BACKUP (unlikely to be supported any time soon)
258 * TIME_CREATE (unlikely to be supported any time soon)
260 #define NFSD4_SUPPORTED_ATTRS_WORD0 \
261 (FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
262 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
263 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
264 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
265 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
266 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
267 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
268 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \
269 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
270 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL)
272 #define NFSD4_SUPPORTED_ATTRS_WORD1 \
273 (FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
274 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
275 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
276 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
277 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
278 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
280 #define NFSD4_SUPPORTED_ATTRS_WORD2 0
282 #define NFSD4_1_SUPPORTED_ATTRS_WORD0 \
283 NFSD4_SUPPORTED_ATTRS_WORD0
285 #define NFSD4_1_SUPPORTED_ATTRS_WORD1 \
286 NFSD4_SUPPORTED_ATTRS_WORD1
288 #define NFSD4_1_SUPPORTED_ATTRS_WORD2 \
289 (NFSD4_SUPPORTED_ATTRS_WORD2 | FATTR4_WORD2_SUPPATTR_EXCLCREAT)
291 static inline u32 nfsd_suppattrs0(u32 minorversion)
293 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD0
294 : NFSD4_SUPPORTED_ATTRS_WORD0;
297 static inline u32 nfsd_suppattrs1(u32 minorversion)
299 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD1
300 : NFSD4_SUPPORTED_ATTRS_WORD1;
303 static inline u32 nfsd_suppattrs2(u32 minorversion)
305 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD2
306 : NFSD4_SUPPORTED_ATTRS_WORD2;
309 /* These will return ERR_INVAL if specified in GETATTR or READDIR. */
310 #define NFSD_WRITEONLY_ATTRS_WORD1 \
311 (FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
313 /* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
314 #define NFSD_WRITEABLE_ATTRS_WORD0 \
315 (FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL )
316 #define NFSD_WRITEABLE_ATTRS_WORD1 \
317 (FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
318 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
319 #define NFSD_WRITEABLE_ATTRS_WORD2 0
321 #define NFSD_SUPPATTR_EXCLCREAT_WORD0 \
322 NFSD_WRITEABLE_ATTRS_WORD0
324 * we currently store the exclusive create verifier in the v_{a,m}time
325 * attributes so the client can't set these at create time using EXCLUSIVE4_1
327 #define NFSD_SUPPATTR_EXCLCREAT_WORD1 \
328 (NFSD_WRITEABLE_ATTRS_WORD1 & \
329 ~(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET))
330 #define NFSD_SUPPATTR_EXCLCREAT_WORD2 \
331 NFSD_WRITEABLE_ATTRS_WORD2
333 #endif /* CONFIG_NFSD_V4 */
335 #endif /* LINUX_NFSD_NFSD_H */