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