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