blob: 8094142d95ea1172d1ed7a13ff211aced48f8f94 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/types.h>
14#include <linux/unistd.h>
15#include <linux/dirent.h>
16#include <linux/fs.h>
Andreas Gruenbachera257cdd2005-06-22 17:16:26 +000017#include <linux/posix_acl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#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 int 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;
NeilBrown70c3b762005-11-07 01:00:25 -080062extern struct svc_serv *nfsd_serv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063/*
64 * Function prototypes.
65 */
66int nfsd_svc(unsigned short port, int nrservs);
67int nfsd_dispatch(struct svc_rqst *rqstp, u32 *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);
75int nfsd_lookup(struct svc_rqst *, struct svc_fh *,
76 const char *, int, struct svc_fh *);
77int nfsd_setattr(struct svc_rqst *, struct svc_fh *,
78 struct iattr *, int, time_t);
79#ifdef CONFIG_NFSD_V4
80int 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 */
84int 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
88int nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
89int 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);
93int nfsd_commit(struct svc_rqst *, struct svc_fh *,
94 loff_t, unsigned long);
95#endif /* CONFIG_NFSD_V3 */
96int nfsd_open(struct svc_rqst *, struct svc_fh *, int,
97 int, struct file **);
98void nfsd_close(struct file *);
99int nfsd_read(struct svc_rqst *, struct svc_fh *, struct file *,
100 loff_t, struct kvec *, int, unsigned long *);
101int nfsd_write(struct svc_rqst *, struct svc_fh *,struct file *,
102 loff_t, struct kvec *,int, unsigned long, int *);
103int nfsd_readlink(struct svc_rqst *, struct svc_fh *,
104 char *, int *);
105int nfsd_symlink(struct svc_rqst *, struct svc_fh *,
106 char *name, int len, char *path, int plen,
107 struct svc_fh *res, struct iattr *);
108int nfsd_link(struct svc_rqst *, struct svc_fh *,
109 char *, int, struct svc_fh *);
110int nfsd_rename(struct svc_rqst *,
111 struct svc_fh *, char *, int,
112 struct svc_fh *, char *, int);
113int nfsd_remove(struct svc_rqst *,
114 struct svc_fh *, char *, int);
115int 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);
119int nfsd_readdir(struct svc_rqst *, struct svc_fh *,
120 loff_t *, struct readdir_cd *, encode_dent_fn);
121int nfsd_statfs(struct svc_rqst *, struct svc_fh *,
122 struct kstatfs *);
123
124int nfsd_notify_change(struct inode *, struct iattr *);
125int nfsd_permission(struct svc_export *, struct dentry *, int);
YAMAMOTO Takashif193fba2006-01-18 17:43:13 -0800126int nfsd_sync_dir(struct dentry *dp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Andreas Gruenbachera257cdd2005-06-22 17:16:26 +0000128#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
NeilBrown6658d3a2006-10-02 02:17:46 -0700143enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
144int nfsd_vers(int vers, enum vers_op change);
145void nfsd_reset_versions(void);
NeilBrownb41b66d2006-10-02 02:17:48 -0700146int nfsd_create_serv(void);
NeilBrown6658d3a2006-10-02 02:17:46 -0700147
NeilBrown596bbe52006-10-04 02:15:48 -0700148extern int nfsd_max_blksize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150/*
151 * NFSv4 State
152 */
153#ifdef CONFIG_NFSD_V4
NeilBrownac4d8ff22005-06-23 22:03:30 -0700154void nfs4_state_init(void);
NeilBrown76a35502005-06-23 22:03:26 -0700155int nfs4_state_start(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156void nfs4_state_shutdown(void);
157time_t nfs4_lease_time(void);
158void nfs4_reset_lease(time_t leasetime);
NeilBrown0964a3d2005-06-23 22:04:32 -0700159int nfs4_reset_recoverydir(char *recdir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160#else
NeilBrownac4d8ff22005-06-23 22:03:30 -0700161static inline void nfs4_state_init(void){};
NeilBrown76a35502005-06-23 22:03:26 -0700162static inline int nfs4_state_start(void){return 0;}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163static 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){}
NeilBrown0964a3d2005-06-23 22:04:32 -0700166static inline int nfs4_reset_recoverydir(char *recdir) {return 0;}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167#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_nofilehandle __constant_htonl(NFSERR_NOFILEHANDLE)
220#define nfserr_minor_vers_mismatch __constant_htonl(NFSERR_MINOR_VERS_MISMATCH)
221#define nfserr_share_denied __constant_htonl(NFSERR_SHARE_DENIED)
222#define nfserr_stale_stateid __constant_htonl(NFSERR_STALE_STATEID)
223#define nfserr_old_stateid __constant_htonl(NFSERR_OLD_STATEID)
224#define nfserr_bad_stateid __constant_htonl(NFSERR_BAD_STATEID)
225#define nfserr_bad_seqid __constant_htonl(NFSERR_BAD_SEQID)
226#define nfserr_symlink __constant_htonl(NFSERR_SYMLINK)
227#define nfserr_not_same __constant_htonl(NFSERR_NOT_SAME)
228#define nfserr_restorefh __constant_htonl(NFSERR_RESTOREFH)
229#define nfserr_attrnotsupp __constant_htonl(NFSERR_ATTRNOTSUPP)
230#define nfserr_bad_xdr __constant_htonl(NFSERR_BAD_XDR)
231#define nfserr_openmode __constant_htonl(NFSERR_OPENMODE)
232#define nfserr_locks_held __constant_htonl(NFSERR_LOCKS_HELD)
233#define nfserr_op_illegal __constant_htonl(NFSERR_OP_ILLEGAL)
234#define nfserr_grace __constant_htonl(NFSERR_GRACE)
235#define nfserr_no_grace __constant_htonl(NFSERR_NO_GRACE)
236#define nfserr_reclaim_bad __constant_htonl(NFSERR_RECLAIM_BAD)
237#define nfserr_badname __constant_htonl(NFSERR_BADNAME)
238#define nfserr_cb_path_down __constant_htonl(NFSERR_CB_PATH_DOWN)
NeilBrownb7009492005-07-07 17:59:23 -0700239#define nfserr_locked __constant_htonl(NFSERR_LOCKED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241/* error codes for internal use */
242/* if a request fails due to kmalloc failure, it gets dropped.
243 * Client should resend eventually
244 */
245#define nfserr_dropit __constant_htonl(30000)
246/* end-of-file indicator in readdir */
247#define nfserr_eof __constant_htonl(30001)
248
249/* Check for dir entries '.' and '..' */
250#define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
251
252/*
253 * Time of server startup
254 */
255extern struct timeval nfssvc_boot;
256
257static inline int is_fsid(struct svc_fh *fh, struct knfsd_fh *reffh)
258{
259 if (fh->fh_export->ex_flags & NFSEXP_FSID) {
260 struct vfsmount *mnt = fh->fh_export->ex_mnt;
261 if (!old_valid_dev(mnt->mnt_sb->s_dev) ||
262 (reffh->fh_version == 1 && reffh->fh_fsid_type == 1))
263 return 1;
264 }
265 return 0;
266}
267
268
269#ifdef CONFIG_NFSD_V4
270
271/* before processing a COMPOUND operation, we have to check that there
272 * is enough space in the buffer for XDR encode to succeed. otherwise,
273 * we might process an operation with side effects, and be unable to
274 * tell the client that the operation succeeded.
275 *
276 * COMPOUND_SLACK_SPACE - this is the minimum amount of buffer space
277 * needed to encode an "ordinary" _successful_ operation. (GETATTR,
278 * READ, READDIR, and READLINK have their own buffer checks.) if we
279 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
280 *
281 * COMPOUND_ERR_SLACK_SPACE - this is the minimum amount of buffer space
282 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
283 * care is taken to ensure that we never fall below this level for any
284 * reason.
285 */
286#define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
287#define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
288
289#define NFSD_LEASE_TIME (nfs4_lease_time())
290#define NFSD_LAUNDROMAT_MINTIMEOUT 10 /* seconds */
291
292/*
293 * The following attributes are currently not supported by the NFSv4 server:
294 * ARCHIVE (deprecated anyway)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 * HIDDEN (unlikely to be supported any time soon)
296 * MIMETYPE (unlikely to be supported any time soon)
297 * QUOTA_* (will be supported in a forthcoming patch)
298 * SYSTEM (unlikely to be supported any time soon)
299 * TIME_BACKUP (unlikely to be supported any time soon)
300 * TIME_CREATE (unlikely to be supported any time soon)
301 */
302#define NFSD_SUPPORTED_ATTRS_WORD0 \
303(FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
304 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
305 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
306 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
307 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
308 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
309 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
J.Bruce Fields81c3f412006-10-04 02:16:19 -0700310 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
312 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL)
313
314#define NFSD_SUPPORTED_ATTRS_WORD1 \
315(FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
316 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
317 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
318 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
319 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
320 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
321
322/* These will return ERR_INVAL if specified in GETATTR or READDIR. */
323#define NFSD_WRITEONLY_ATTRS_WORD1 \
324(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
325
326/* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
327#define NFSD_WRITEABLE_ATTRS_WORD0 \
328(FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL )
329#define NFSD_WRITEABLE_ATTRS_WORD1 \
330(FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
331 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_METADATA | FATTR4_WORD1_TIME_MODIFY_SET)
332
333#endif /* CONFIG_NFSD_V4 */
334
335#endif /* __KERNEL__ */
336
337#endif /* LINUX_NFSD_NFSD_H */