tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
13#include <linux/types.h>
14#include <linux/unistd.h>
15#include <linux/dirent.h>
16#include <linux/fs.h>
17#include <linux/posix_acl.h>
18#include <linux/mount.h>
19
20#include <linux/nfsd/debug.h>
21#include <linux/nfsd/nfsfh.h>
22#include <linux/nfsd/export.h>
23#include <linux/nfsd/auth.h>
24#include <linux/nfsd/stats.h>
25#include <linux/nfsd/interface.h>
26/*
27 * nfsd version
28 */
29#define NFSD_VERSION "0.5"
30#define NFSD_SUPPORTED_MINOR_VERSION 0
31
32#ifdef __KERNEL__
33/*
34 * Special flags for nfsd_permission. These must be different from MAY_READ,
35 * MAY_WRITE, and MAY_EXEC.
36 */
37#define MAY_NOP 0
38#define MAY_SATTR 8
39#define MAY_TRUNC 16
40#define MAY_LOCK 32
41#define MAY_OWNER_OVERRIDE 64
42#define MAY_LOCAL_ACCESS 128 /* IRIX doing local access check on device special file*/
43#if (MAY_SATTR | MAY_TRUNC | MAY_LOCK | MAY_OWNER_OVERRIDE | MAY_LOCAL_ACCESS) & (MAY_READ | MAY_WRITE | MAY_EXEC)
44# error "please use a different value for MAY_SATTR or MAY_TRUNC or MAY_LOCK or MAY_LOCAL_ACCESS or MAY_OWNER_OVERRIDE."
45#endif
46#define MAY_CREATE (MAY_EXEC|MAY_WRITE)
47#define MAY_REMOVE (MAY_EXEC|MAY_WRITE|MAY_TRUNC)
48
49/*
50 * Callback function for readdir
51 */
52struct readdir_cd {
53 __be32 err; /* 0, nfserr, or nfserr_eof */
54};
55typedef int (*encode_dent_fn)(struct readdir_cd *, const char *,
56 int, loff_t, ino_t, unsigned int);
57typedef int (*nfsd_dirop_t)(struct inode *, struct dentry *, int, int);
58
59extern struct svc_program nfsd_program;
60extern struct svc_version nfsd_version2, nfsd_version3,
61 nfsd_version4;
62extern struct svc_serv *nfsd_serv;
63/*
64 * Function prototypes.
65 */
66int nfsd_svc(unsigned short port, int nrservs);
67int nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp);
68
69/* nfsd/vfs.c */
70int fh_lock_parent(struct svc_fh *, struct dentry *);
71int nfsd_racache_init(int);
72void nfsd_racache_shutdown(void);
73int nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
74 struct svc_export **expp);
75__be32 nfsd_lookup(struct svc_rqst *, struct svc_fh *,
76 const char *, int, struct svc_fh *);
77__be32 nfsd_setattr(struct svc_rqst *, struct svc_fh *,
78 struct iattr *, int, time_t);
79#ifdef CONFIG_NFSD_V4
80__be32 nfsd4_set_nfs4_acl(struct svc_rqst *, struct svc_fh *,
81 struct nfs4_acl *);
82int nfsd4_get_nfs4_acl(struct svc_rqst *, struct dentry *, struct nfs4_acl **);
83#endif /* CONFIG_NFSD_V4 */
84__be32 nfsd_create(struct svc_rqst *, struct svc_fh *,
85 char *name, int len, struct iattr *attrs,
86 int type, dev_t rdev, struct svc_fh *res);
87#ifdef CONFIG_NFSD_V3
88__be32 nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
89__be32 nfsd_create_v3(struct svc_rqst *, struct svc_fh *,
90 char *name, int len, struct iattr *attrs,
91 struct svc_fh *res, int createmode,
92 u32 *verifier, int *truncp);
93__be32 nfsd_commit(struct svc_rqst *, struct svc_fh *,
94 loff_t, unsigned long);
95#endif /* CONFIG_NFSD_V3 */
96__be32 nfsd_open(struct svc_rqst *, struct svc_fh *, int,
97 int, struct file **);
98void nfsd_close(struct file *);
99__be32 nfsd_read(struct svc_rqst *, struct svc_fh *, struct file *,
100 loff_t, struct kvec *, int, unsigned long *);
101__be32 nfsd_write(struct svc_rqst *, struct svc_fh *,struct file *,
102 loff_t, struct kvec *,int, unsigned long, int *);
103__be32 nfsd_readlink(struct svc_rqst *, struct svc_fh *,
104 char *, int *);
105__be32 nfsd_symlink(struct svc_rqst *, struct svc_fh *,
106 char *name, int len, char *path, int plen,
107 struct svc_fh *res, struct iattr *);
108__be32 nfsd_link(struct svc_rqst *, struct svc_fh *,
109 char *, int, struct svc_fh *);
110__be32 nfsd_rename(struct svc_rqst *,
111 struct svc_fh *, char *, int,
112 struct svc_fh *, char *, int);
113__be32 nfsd_remove(struct svc_rqst *,
114 struct svc_fh *, char *, int);
115__be32 nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
116 char *name, int len);
117int nfsd_truncate(struct svc_rqst *, struct svc_fh *,
118 unsigned long size);
119__be32 nfsd_readdir(struct svc_rqst *, struct svc_fh *,
120 loff_t *, struct readdir_cd *, encode_dent_fn);
121__be32 nfsd_statfs(struct svc_rqst *, struct svc_fh *,
122 struct kstatfs *);
123
124int nfsd_notify_change(struct inode *, struct iattr *);
125__be32 nfsd_permission(struct svc_export *, struct dentry *, int);
126int nfsd_sync_dir(struct dentry *dp);
127
128#if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
129#ifdef CONFIG_NFSD_V2_ACL
130extern struct svc_version nfsd_acl_version2;
131#else
132#define nfsd_acl_version2 NULL
133#endif
134#ifdef CONFIG_NFSD_V3_ACL
135extern struct svc_version nfsd_acl_version3;
136#else
137#define nfsd_acl_version3 NULL
138#endif
139struct posix_acl *nfsd_get_posix_acl(struct svc_fh *, int);
140int nfsd_set_posix_acl(struct svc_fh *, int, struct posix_acl *);
141#endif
142
143enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
144int nfsd_vers(int vers, enum vers_op change);
145void nfsd_reset_versions(void);
146int nfsd_create_serv(void);
147
148extern int nfsd_max_blksize;
149
150/*
151 * NFSv4 State
152 */
153#ifdef CONFIG_NFSD_V4
154void nfs4_state_init(void);
155int nfs4_state_start(void);
156void nfs4_state_shutdown(void);
157time_t nfs4_lease_time(void);
158void nfs4_reset_lease(time_t leasetime);
159int nfs4_reset_recoverydir(char *recdir);
160#else
161static inline void nfs4_state_init(void){};
162static inline int nfs4_state_start(void){return 0;}
163static inline void nfs4_state_shutdown(void){}
164static inline time_t nfs4_lease_time(void){return 0;}
165static inline void nfs4_reset_lease(time_t leasetime){}
166static inline int nfs4_reset_recoverydir(char *recdir) {return 0;}
167#endif
168
169/*
170 * lockd binding
171 */
172void nfsd_lockd_init(void);
173void nfsd_lockd_shutdown(void);
174
175
176/*
177 * These macros provide pre-xdr'ed values for faster operation.
178 */
179#define nfs_ok __constant_htonl(NFS_OK)
180#define nfserr_perm __constant_htonl(NFSERR_PERM)
181#define nfserr_noent __constant_htonl(NFSERR_NOENT)
182#define nfserr_io __constant_htonl(NFSERR_IO)
183#define nfserr_nxio __constant_htonl(NFSERR_NXIO)
184#define nfserr_eagain __constant_htonl(NFSERR_EAGAIN)
185#define nfserr_acces __constant_htonl(NFSERR_ACCES)
186#define nfserr_exist __constant_htonl(NFSERR_EXIST)
187#define nfserr_xdev __constant_htonl(NFSERR_XDEV)
188#define nfserr_nodev __constant_htonl(NFSERR_NODEV)
189#define nfserr_notdir __constant_htonl(NFSERR_NOTDIR)
190#define nfserr_isdir __constant_htonl(NFSERR_ISDIR)
191#define nfserr_inval __constant_htonl(NFSERR_INVAL)
192#define nfserr_fbig __constant_htonl(NFSERR_FBIG)
193#define nfserr_nospc __constant_htonl(NFSERR_NOSPC)
194#define nfserr_rofs __constant_htonl(NFSERR_ROFS)
195#define nfserr_mlink __constant_htonl(NFSERR_MLINK)
196#define nfserr_opnotsupp __constant_htonl(NFSERR_OPNOTSUPP)
197#define nfserr_nametoolong __constant_htonl(NFSERR_NAMETOOLONG)
198#define nfserr_notempty __constant_htonl(NFSERR_NOTEMPTY)
199#define nfserr_dquot __constant_htonl(NFSERR_DQUOT)
200#define nfserr_stale __constant_htonl(NFSERR_STALE)
201#define nfserr_remote __constant_htonl(NFSERR_REMOTE)
202#define nfserr_wflush __constant_htonl(NFSERR_WFLUSH)
203#define nfserr_badhandle __constant_htonl(NFSERR_BADHANDLE)
204#define nfserr_notsync __constant_htonl(NFSERR_NOT_SYNC)
205#define nfserr_badcookie __constant_htonl(NFSERR_BAD_COOKIE)
206#define nfserr_notsupp __constant_htonl(NFSERR_NOTSUPP)
207#define nfserr_toosmall __constant_htonl(NFSERR_TOOSMALL)
208#define nfserr_serverfault __constant_htonl(NFSERR_SERVERFAULT)
209#define nfserr_badtype __constant_htonl(NFSERR_BADTYPE)
210#define nfserr_jukebox __constant_htonl(NFSERR_JUKEBOX)
211#define nfserr_denied __constant_htonl(NFSERR_DENIED)
212#define nfserr_deadlock __constant_htonl(NFSERR_DEADLOCK)
213#define nfserr_expired __constant_htonl(NFSERR_EXPIRED)
214#define nfserr_bad_cookie __constant_htonl(NFSERR_BAD_COOKIE)
215#define nfserr_same __constant_htonl(NFSERR_SAME)
216#define nfserr_clid_inuse __constant_htonl(NFSERR_CLID_INUSE)
217#define nfserr_stale_clientid __constant_htonl(NFSERR_STALE_CLIENTID)
218#define nfserr_resource __constant_htonl(NFSERR_RESOURCE)
219#define nfserr_moved __constant_htonl(NFSERR_MOVED)
220#define nfserr_nofilehandle __constant_htonl(NFSERR_NOFILEHANDLE)
221#define nfserr_minor_vers_mismatch __constant_htonl(NFSERR_MINOR_VERS_MISMATCH)
222#define nfserr_share_denied __constant_htonl(NFSERR_SHARE_DENIED)
223#define nfserr_stale_stateid __constant_htonl(NFSERR_STALE_STATEID)
224#define nfserr_old_stateid __constant_htonl(NFSERR_OLD_STATEID)
225#define nfserr_bad_stateid __constant_htonl(NFSERR_BAD_STATEID)
226#define nfserr_bad_seqid __constant_htonl(NFSERR_BAD_SEQID)
227#define nfserr_symlink __constant_htonl(NFSERR_SYMLINK)
228#define nfserr_not_same __constant_htonl(NFSERR_NOT_SAME)
229#define nfserr_restorefh __constant_htonl(NFSERR_RESTOREFH)
230#define nfserr_attrnotsupp __constant_htonl(NFSERR_ATTRNOTSUPP)
231#define nfserr_bad_xdr __constant_htonl(NFSERR_BAD_XDR)
232#define nfserr_openmode __constant_htonl(NFSERR_OPENMODE)
233#define nfserr_locks_held __constant_htonl(NFSERR_LOCKS_HELD)
234#define nfserr_op_illegal __constant_htonl(NFSERR_OP_ILLEGAL)
235#define nfserr_grace __constant_htonl(NFSERR_GRACE)
236#define nfserr_no_grace __constant_htonl(NFSERR_NO_GRACE)
237#define nfserr_reclaim_bad __constant_htonl(NFSERR_RECLAIM_BAD)
238#define nfserr_badname __constant_htonl(NFSERR_BADNAME)
239#define nfserr_cb_path_down __constant_htonl(NFSERR_CB_PATH_DOWN)
240#define nfserr_locked __constant_htonl(NFSERR_LOCKED)
241#define nfserr_replay_me __constant_htonl(NFSERR_REPLAY_ME)
242
243/* error codes for internal use */
244/* if a request fails due to kmalloc failure, it gets dropped.
245 * Client should resend eventually
246 */
247#define nfserr_dropit __constant_htonl(30000)
248/* end-of-file indicator in readdir */
249#define nfserr_eof __constant_htonl(30001)
250
251/* Check for dir entries '.' and '..' */
252#define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
253
254/*
255 * Time of server startup
256 */
257extern struct timeval nfssvc_boot;
258
259static inline int is_fsid(struct svc_fh *fh, struct knfsd_fh *reffh)
260{
261 if (fh->fh_export->ex_flags & NFSEXP_FSID) {
262 struct vfsmount *mnt = fh->fh_export->ex_mnt;
263 if (!old_valid_dev(mnt->mnt_sb->s_dev) ||
264 (reffh->fh_version == 1 && reffh->fh_fsid_type == 1))
265 return 1;
266 }
267 return 0;
268}
269
270
271#ifdef CONFIG_NFSD_V4
272
273/* before processing a COMPOUND operation, we have to check that there
274 * is enough space in the buffer for XDR encode to succeed. otherwise,
275 * we might process an operation with side effects, and be unable to
276 * tell the client that the operation succeeded.
277 *
278 * COMPOUND_SLACK_SPACE - this is the minimum amount of buffer space
279 * needed to encode an "ordinary" _successful_ operation. (GETATTR,
280 * READ, READDIR, and READLINK have their own buffer checks.) if we
281 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
282 *
283 * COMPOUND_ERR_SLACK_SPACE - this is the minimum amount of buffer space
284 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
285 * care is taken to ensure that we never fall below this level for any
286 * reason.
287 */
288#define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
289#define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
290
291#define NFSD_LEASE_TIME (nfs4_lease_time())
292#define NFSD_LAUNDROMAT_MINTIMEOUT 10 /* seconds */
293
294/*
295 * The following attributes are currently not supported by the NFSv4 server:
296 * ARCHIVE (deprecated anyway)
297 * HIDDEN (unlikely to be supported any time soon)
298 * MIMETYPE (unlikely to be supported any time soon)
299 * QUOTA_* (will be supported in a forthcoming patch)
300 * SYSTEM (unlikely to be supported any time soon)
301 * TIME_BACKUP (unlikely to be supported any time soon)
302 * TIME_CREATE (unlikely to be supported any time soon)
303 */
304#define NFSD_SUPPORTED_ATTRS_WORD0 \
305(FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
306 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
307 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
308 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
309 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
310 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
311 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
312 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \
313 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
314 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL)
315
316#define NFSD_SUPPORTED_ATTRS_WORD1 \
317(FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
318 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
319 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
320 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
321 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
322 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
323
324/* These will return ERR_INVAL if specified in GETATTR or READDIR. */
325#define NFSD_WRITEONLY_ATTRS_WORD1 \
326(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
327
328/* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
329#define NFSD_WRITEABLE_ATTRS_WORD0 \
330(FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL )
331#define NFSD_WRITEABLE_ATTRS_WORD1 \
332(FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
333 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_METADATA | FATTR4_WORD1_TIME_MODIFY_SET)
334
335#endif /* CONFIG_NFSD_V4 */
336
337#endif /* __KERNEL__ */
338
339#endif /* LINUX_NFSD_NFSD_H */