Root/fs/nfsd/nfsd.h

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

Archive Download this file



interactive