]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/nfsd/nfsd.h
nfs41: common protocol definitions
[mirror_ubuntu-artful-kernel.git] / include / linux / nfsd / nfsd.h
CommitLineData
1da177e4
LT
1/*
2 * linux/include/linux/nfsd/nfsd.h
3 *
4 * Hodge-podge collection of knfsd-related stuff.
5 * I will sort this out later.
6 *
7 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
8 */
9
10#ifndef LINUX_NFSD_NFSD_H
11#define LINUX_NFSD_NFSD_H
12
1da177e4
LT
13#include <linux/types.h>
14#include <linux/unistd.h>
1da177e4 15#include <linux/fs.h>
a257cdd0 16#include <linux/posix_acl.h>
1da177e4
LT
17#include <linux/mount.h>
18
19#include <linux/nfsd/debug.h>
20#include <linux/nfsd/nfsfh.h>
21#include <linux/nfsd/export.h>
1da177e4 22#include <linux/nfsd/stats.h>
1da177e4
LT
23/*
24 * nfsd version
25 */
1da177e4
LT
26#define NFSD_SUPPORTED_MINOR_VERSION 0
27
1da177e4 28/*
8837abca 29 * Flags for nfsd_permission
1da177e4 30 */
8837abca
MS
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*/
04716e66 40#define NFSD_MAY_BYPASS_GSS_ON_ROOT 256
8837abca
MS
41
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)
1da177e4
LT
44
45/*
46 * Callback function for readdir
47 */
48struct readdir_cd {
131a21c2 49 __be32 err; /* 0, nfserr, or nfserr_eof */
1da177e4 50};
1da177e4
LT
51typedef int (*nfsd_dirop_t)(struct inode *, struct dentry *, int, int);
52
53extern struct svc_program nfsd_program;
54extern struct svc_version nfsd_version2, nfsd_version3,
55 nfsd_version4;
bedbdd8b 56extern struct mutex nfsd_mutex;
70c3b76c 57extern struct svc_serv *nfsd_serv;
a254b246
HH
58
59extern struct seq_operations nfs_exports_op;
60
1da177e4
LT
61/*
62 * Function prototypes.
63 */
64int nfsd_svc(unsigned short port, int nrservs);
c7afef1f 65int nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp);
1da177e4 66
a254b246
HH
67int nfsd_nrthreads(void);
68int nfsd_nrpools(void);
69int nfsd_get_nrthreads(int n, int *);
70int nfsd_set_nrthreads(int n, int *);
71
1da177e4
LT
72/* nfsd/vfs.c */
73int fh_lock_parent(struct svc_fh *, struct dentry *);
74int nfsd_racache_init(int);
75void nfsd_racache_shutdown(void);
76int nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
77 struct svc_export **expp);
6264d69d 78__be32 nfsd_lookup(struct svc_rqst *, struct svc_fh *,
5a022fc8 79 const char *, unsigned int, struct svc_fh *);
dcb488a3 80__be32 nfsd_lookup_dentry(struct svc_rqst *, struct svc_fh *,
5a022fc8 81 const char *, unsigned int,
dcb488a3 82 struct svc_export **, struct dentry **);
6264d69d 83__be32 nfsd_setattr(struct svc_rqst *, struct svc_fh *,
1da177e4
LT
84 struct iattr *, int, time_t);
85#ifdef CONFIG_NFSD_V4
6264d69d 86__be32 nfsd4_set_nfs4_acl(struct svc_rqst *, struct svc_fh *,
1da177e4
LT
87 struct nfs4_acl *);
88int nfsd4_get_nfs4_acl(struct svc_rqst *, struct dentry *, struct nfs4_acl **);
89#endif /* CONFIG_NFSD_V4 */
6264d69d 90__be32 nfsd_create(struct svc_rqst *, struct svc_fh *,
1da177e4
LT
91 char *name, int len, struct iattr *attrs,
92 int type, dev_t rdev, struct svc_fh *res);
93#ifdef CONFIG_NFSD_V3
6264d69d
AV
94__be32 nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
95__be32 nfsd_create_v3(struct svc_rqst *, struct svc_fh *,
1da177e4
LT
96 char *name, int len, struct iattr *attrs,
97 struct svc_fh *res, int createmode,
81ac95c5 98 u32 *verifier, int *truncp, int *created);
6264d69d 99__be32 nfsd_commit(struct svc_rqst *, struct svc_fh *,
1da177e4
LT
100 loff_t, unsigned long);
101#endif /* CONFIG_NFSD_V3 */
6264d69d 102__be32 nfsd_open(struct svc_rqst *, struct svc_fh *, int,
1da177e4
LT
103 int, struct file **);
104void nfsd_close(struct file *);
6264d69d 105__be32 nfsd_read(struct svc_rqst *, struct svc_fh *, struct file *,
1da177e4 106 loff_t, struct kvec *, int, unsigned long *);
6264d69d 107__be32 nfsd_write(struct svc_rqst *, struct svc_fh *,struct file *,
31dec253 108 loff_t, struct kvec *,int, unsigned long *, int *);
6264d69d 109__be32 nfsd_readlink(struct svc_rqst *, struct svc_fh *,
1da177e4 110 char *, int *);
6264d69d 111__be32 nfsd_symlink(struct svc_rqst *, struct svc_fh *,
1da177e4
LT
112 char *name, int len, char *path, int plen,
113 struct svc_fh *res, struct iattr *);
6264d69d 114__be32 nfsd_link(struct svc_rqst *, struct svc_fh *,
1da177e4 115 char *, int, struct svc_fh *);
6264d69d 116__be32 nfsd_rename(struct svc_rqst *,
1da177e4
LT
117 struct svc_fh *, char *, int,
118 struct svc_fh *, char *, int);
6264d69d 119__be32 nfsd_remove(struct svc_rqst *,
1da177e4 120 struct svc_fh *, char *, int);
6264d69d 121__be32 nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
1da177e4
LT
122 char *name, int len);
123int nfsd_truncate(struct svc_rqst *, struct svc_fh *,
124 unsigned long size);
6264d69d 125__be32 nfsd_readdir(struct svc_rqst *, struct svc_fh *,
a0ad13ef 126 loff_t *, struct readdir_cd *, filldir_t);
6264d69d 127__be32 nfsd_statfs(struct svc_rqst *, struct svc_fh *,
04716e66 128 struct kstatfs *, int access);
1da177e4
LT
129
130int nfsd_notify_change(struct inode *, struct iattr *);
0ec757df
BF
131__be32 nfsd_permission(struct svc_rqst *, struct svc_export *,
132 struct dentry *, int);
f193fbab 133int nfsd_sync_dir(struct dentry *dp);
1da177e4 134
a257cdd0
AG
135#if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
136#ifdef CONFIG_NFSD_V2_ACL
137extern struct svc_version nfsd_acl_version2;
138#else
139#define nfsd_acl_version2 NULL
140#endif
141#ifdef CONFIG_NFSD_V3_ACL
142extern struct svc_version nfsd_acl_version3;
143#else
144#define nfsd_acl_version3 NULL
145#endif
146struct posix_acl *nfsd_get_posix_acl(struct svc_fh *, int);
147int nfsd_set_posix_acl(struct svc_fh *, int, struct posix_acl *);
148#endif
149
6658d3a7
N
150enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
151int nfsd_vers(int vers, enum vers_op change);
152void nfsd_reset_versions(void);
b41b66d6 153int nfsd_create_serv(void);
6658d3a7 154
596bbe53 155extern int nfsd_max_blksize;
1da177e4
LT
156
157/*
158 * NFSv4 State
159 */
160#ifdef CONFIG_NFSD_V4
c2f1a551 161extern unsigned int max_delegations;
e8ff2a84
BF
162int nfs4_state_init(void);
163void nfsd4_free_slabs(void);
164void nfs4_state_start(void);
1da177e4
LT
165void nfs4_state_shutdown(void);
166time_t nfs4_lease_time(void);
167void nfs4_reset_lease(time_t leasetime);
0964a3d3 168int nfs4_reset_recoverydir(char *recdir);
1da177e4 169#else
e8ff2a84
BF
170static inline int nfs4_state_init(void) { return 0; }
171static inline void nfsd4_free_slabs(void) { }
172static inline void nfs4_state_start(void) { }
173static inline void nfs4_state_shutdown(void) { }
174static inline time_t nfs4_lease_time(void) { return 0; }
175static inline void nfs4_reset_lease(time_t leasetime) { }
176static inline int nfs4_reset_recoverydir(char *recdir) { return 0; }
1da177e4
LT
177#endif
178
179/*
180 * lockd binding
181 */
182void nfsd_lockd_init(void);
183void nfsd_lockd_shutdown(void);
184
185
186/*
187 * These macros provide pre-xdr'ed values for faster operation.
188 */
77f18f5e
HH
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_replay_me cpu_to_be32(NFSERR_REPLAY_ME)
1da177e4
LT
253
254/* error codes for internal use */
255/* if a request fails due to kmalloc failure, it gets dropped.
256 * Client should resend eventually
257 */
77f18f5e 258#define nfserr_dropit cpu_to_be32(30000)
1da177e4 259/* end-of-file indicator in readdir */
77f18f5e 260#define nfserr_eof cpu_to_be32(30001)
1da177e4
LT
261
262/* Check for dir entries '.' and '..' */
263#define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
264
265/*
266 * Time of server startup
267 */
268extern struct timeval nfssvc_boot;
269
1da177e4
LT
270#ifdef CONFIG_NFSD_V4
271
272/* before processing a COMPOUND operation, we have to check that there
273 * is enough space in the buffer for XDR encode to succeed. otherwise,
274 * we might process an operation with side effects, and be unable to
275 * tell the client that the operation succeeded.
276 *
e5710199 277 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
1da177e4
LT
278 * needed to encode an "ordinary" _successful_ operation. (GETATTR,
279 * READ, READDIR, and READLINK have their own buffer checks.) if we
280 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
281 *
e5710199 282 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
1da177e4
LT
283 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
284 * care is taken to ensure that we never fall below this level for any
285 * reason.
286 */
287#define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
288#define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
289
290#define NFSD_LEASE_TIME (nfs4_lease_time())
291#define NFSD_LAUNDROMAT_MINTIMEOUT 10 /* seconds */
292
293/*
294 * The following attributes are currently not supported by the NFSv4 server:
295 * ARCHIVE (deprecated anyway)
1da177e4
LT
296 * HIDDEN (unlikely to be supported any time soon)
297 * MIMETYPE (unlikely to be supported any time soon)
298 * QUOTA_* (will be supported in a forthcoming patch)
299 * SYSTEM (unlikely to be supported any time soon)
300 * TIME_BACKUP (unlikely to be supported any time soon)
301 * TIME_CREATE (unlikely to be supported any time soon)
302 */
303#define NFSD_SUPPORTED_ATTRS_WORD0 \
304(FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
305 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
306 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
307 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
308 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
309 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
310 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
81c3f413 311 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \
1da177e4
LT
312 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
313 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL)
314
315#define NFSD_SUPPORTED_ATTRS_WORD1 \
316(FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
317 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
318 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
319 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
320 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
321 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
322
323/* These will return ERR_INVAL if specified in GETATTR or READDIR. */
324#define NFSD_WRITEONLY_ATTRS_WORD1 \
325(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
326
327/* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
328#define NFSD_WRITEABLE_ATTRS_WORD0 \
329(FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL )
330#define NFSD_WRITEABLE_ATTRS_WORD1 \
331(FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
e36cd4a2 332 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
1da177e4
LT
333
334#endif /* CONFIG_NFSD_V4 */
335
1da177e4 336#endif /* LINUX_NFSD_NFSD_H */