2 * linux/include/linux/nfsd/nfsd.h
4 * Hodge-podge collection of knfsd-related stuff.
5 * I will sort this out later.
7 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
10 #ifndef LINUX_NFSD_NFSD_H
11 #define LINUX_NFSD_NFSD_H
13 #include <linux/config.h>
14 #include <linux/types.h>
15 #include <linux/unistd.h>
16 #include <linux/dirent.h>
18 #include <linux/mount.h>
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>
29 #define NFSD_VERSION "0.5"
30 #define NFSD_SUPPORTED_MINOR_VERSION 0
34 * Special flags for nfsd_permission. These must be different from MAY_READ,
35 * MAY_WRITE, and MAY_EXEC.
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."
46 #define MAY_CREATE (MAY_EXEC|MAY_WRITE)
47 #define MAY_REMOVE (MAY_EXEC|MAY_WRITE|MAY_TRUNC)
50 * Callback function for readdir
53 int err; /* 0, nfserr, or nfserr_eof */
55 typedef int (*encode_dent_fn)(struct readdir_cd *, const char *,
56 int, loff_t, ino_t, unsigned int);
57 typedef int (*nfsd_dirop_t)(struct inode *, struct dentry *, int, int);
59 extern struct svc_program nfsd_program;
60 extern struct svc_version nfsd_version2, nfsd_version3,
64 * Function prototypes.
66 int nfsd_svc(unsigned short port, int nrservs);
67 int nfsd_dispatch(struct svc_rqst *rqstp, u32 *statp);
70 int fh_lock_parent(struct svc_fh *, struct dentry *);
71 int nfsd_racache_init(int);
72 void nfsd_racache_shutdown(void);
73 int nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
74 struct svc_export **expp);
75 int nfsd_lookup(struct svc_rqst *, struct svc_fh *,
76 const char *, int, struct svc_fh *);
77 int nfsd_setattr(struct svc_rqst *, struct svc_fh *,
78 struct iattr *, int, time_t);
79 int nfsd_create(struct svc_rqst *, struct svc_fh *,
80 char *name, int len, struct iattr *attrs,
81 int type, dev_t rdev, struct svc_fh *res);
83 int nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *);
84 int nfsd_create_v3(struct svc_rqst *, struct svc_fh *,
85 char *name, int len, struct iattr *attrs,
86 struct svc_fh *res, int createmode,
87 u32 *verifier, int *truncp);
88 int nfsd_commit(struct svc_rqst *, struct svc_fh *,
89 loff_t, unsigned long);
90 #endif /* CONFIG_NFSD_V3 */
91 int nfsd_open(struct svc_rqst *, struct svc_fh *, int,
93 void nfsd_close(struct file *);
94 int nfsd_read(struct svc_rqst *, struct svc_fh *,
95 loff_t, struct iovec *,int, unsigned long *);
96 int nfsd_write(struct svc_rqst *, struct svc_fh *,
97 loff_t, struct iovec *,int, unsigned long, int *);
98 int nfsd_readlink(struct svc_rqst *, struct svc_fh *,
100 int nfsd_symlink(struct svc_rqst *, struct svc_fh *,
101 char *name, int len, char *path, int plen,
102 struct svc_fh *res, struct iattr *);
103 int nfsd_link(struct svc_rqst *, struct svc_fh *,
104 char *, int, struct svc_fh *);
105 int nfsd_rename(struct svc_rqst *,
106 struct svc_fh *, char *, int,
107 struct svc_fh *, char *, int);
108 int nfsd_remove(struct svc_rqst *,
109 struct svc_fh *, char *, int);
110 int nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type,
111 char *name, int len);
112 int nfsd_truncate(struct svc_rqst *, struct svc_fh *,
114 int nfsd_readdir(struct svc_rqst *, struct svc_fh *,
115 loff_t *, struct readdir_cd *, encode_dent_fn);
116 int nfsd_statfs(struct svc_rqst *, struct svc_fh *,
119 int nfsd_notify_change(struct inode *, struct iattr *);
120 int nfsd_permission(struct svc_export *, struct dentry *, int);
126 #ifdef CONFIG_NFSD_V4
127 void nfs4_state_init(void);
128 void nfs4_state_shutdown(void);
130 void static inline nfs4_state_init(void){}
131 void static inline nfs4_state_shutdown(void){}
137 void nfsd_lockd_init(void);
138 void nfsd_lockd_shutdown(void);
142 * These macros provide pre-xdr'ed values for faster operation.
144 #define nfs_ok __constant_htonl(NFS_OK)
145 #define nfserr_perm __constant_htonl(NFSERR_PERM)
146 #define nfserr_noent __constant_htonl(NFSERR_NOENT)
147 #define nfserr_io __constant_htonl(NFSERR_IO)
148 #define nfserr_nxio __constant_htonl(NFSERR_NXIO)
149 #define nfserr_eagain __constant_htonl(NFSERR_EAGAIN)
150 #define nfserr_acces __constant_htonl(NFSERR_ACCES)
151 #define nfserr_exist __constant_htonl(NFSERR_EXIST)
152 #define nfserr_xdev __constant_htonl(NFSERR_XDEV)
153 #define nfserr_nodev __constant_htonl(NFSERR_NODEV)
154 #define nfserr_notdir __constant_htonl(NFSERR_NOTDIR)
155 #define nfserr_isdir __constant_htonl(NFSERR_ISDIR)
156 #define nfserr_inval __constant_htonl(NFSERR_INVAL)
157 #define nfserr_fbig __constant_htonl(NFSERR_FBIG)
158 #define nfserr_nospc __constant_htonl(NFSERR_NOSPC)
159 #define nfserr_rofs __constant_htonl(NFSERR_ROFS)
160 #define nfserr_mlink __constant_htonl(NFSERR_MLINK)
161 #define nfserr_opnotsupp __constant_htonl(NFSERR_OPNOTSUPP)
162 #define nfserr_nametoolong __constant_htonl(NFSERR_NAMETOOLONG)
163 #define nfserr_notempty __constant_htonl(NFSERR_NOTEMPTY)
164 #define nfserr_dquot __constant_htonl(NFSERR_DQUOT)
165 #define nfserr_stale __constant_htonl(NFSERR_STALE)
166 #define nfserr_remote __constant_htonl(NFSERR_REMOTE)
167 #define nfserr_wflush __constant_htonl(NFSERR_WFLUSH)
168 #define nfserr_badhandle __constant_htonl(NFSERR_BADHANDLE)
169 #define nfserr_notsync __constant_htonl(NFSERR_NOT_SYNC)
170 #define nfserr_badcookie __constant_htonl(NFSERR_BAD_COOKIE)
171 #define nfserr_notsupp __constant_htonl(NFSERR_NOTSUPP)
172 #define nfserr_toosmall __constant_htonl(NFSERR_TOOSMALL)
173 #define nfserr_serverfault __constant_htonl(NFSERR_SERVERFAULT)
174 #define nfserr_badtype __constant_htonl(NFSERR_BADTYPE)
175 #define nfserr_jukebox __constant_htonl(NFSERR_JUKEBOX)
176 #define nfserr_denied __constant_htonl(NFSERR_DENIED)
177 #define nfserr_deadlock __constant_htonl(NFSERR_DEADLOCK)
178 #define nfserr_expired __constant_htonl(NFSERR_EXPIRED)
179 #define nfserr_bad_cookie __constant_htonl(NFSERR_BAD_COOKIE)
180 #define nfserr_same __constant_htonl(NFSERR_SAME)
181 #define nfserr_clid_inuse __constant_htonl(NFSERR_CLID_INUSE)
182 #define nfserr_stale_clientid __constant_htonl(NFSERR_STALE_CLIENTID)
183 #define nfserr_resource __constant_htonl(NFSERR_RESOURCE)
184 #define nfserr_nofilehandle __constant_htonl(NFSERR_NOFILEHANDLE)
185 #define nfserr_minor_vers_mismatch __constant_htonl(NFSERR_MINOR_VERS_MISMATCH)
186 #define nfserr_share_denied __constant_htonl(NFSERR_SHARE_DENIED)
187 #define nfserr_stale_stateid __constant_htonl(NFSERR_STALE_STATEID)
188 #define nfserr_old_stateid __constant_htonl(NFSERR_OLD_STATEID)
189 #define nfserr_bad_stateid __constant_htonl(NFSERR_BAD_STATEID)
190 #define nfserr_bad_seqid __constant_htonl(NFSERR_BAD_SEQID)
191 #define nfserr_symlink __constant_htonl(NFSERR_SYMLINK)
192 #define nfserr_not_same __constant_htonl(NFSERR_NOT_SAME)
193 #define nfserr_restorefh __constant_htonl(NFSERR_RESTOREFH)
194 #define nfserr_attrnotsupp __constant_htonl(NFSERR_ATTRNOTSUPP)
195 #define nfserr_bad_xdr __constant_htonl(NFSERR_BAD_XDR)
196 #define nfserr_openmode __constant_htonl(NFSERR_OPENMODE)
197 #define nfserr_locks_held __constant_htonl(NFSERR_LOCKS_HELD)
198 #define nfserr_op_illegal __constant_htonl(NFSERR_OP_ILLEGAL)
199 #define nfserr_grace __constant_htonl(NFSERR_GRACE)
200 #define nfserr_no_grace __constant_htonl(NFSERR_NO_GRACE)
201 #define nfserr_reclaim_bad __constant_htonl(NFSERR_RECLAIM_BAD)
202 #define nfserr_badname __constant_htonl(NFSERR_BADNAME)
204 /* error codes for internal use */
205 /* if a request fails due to kmalloc failure, it gets dropped.
206 * Client should resend eventually
208 #define nfserr_dropit __constant_htonl(30000)
209 /* end-of-file indicator in readdir */
210 #define nfserr_eof __constant_htonl(30001)
212 /* Check for dir entries '.' and '..' */
213 #define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
216 * Time of server startup
218 extern struct timeval nfssvc_boot;
220 static inline int is_fsid(struct svc_fh *fh, struct knfsd_fh *reffh)
222 if (fh->fh_export->ex_flags & NFSEXP_FSID) {
223 struct vfsmount *mnt = fh->fh_export->ex_mnt;
224 if (!old_valid_dev(mnt->mnt_sb->s_dev) ||
225 (reffh->fh_version == 1 && reffh->fh_fsid_type == 1))
232 #ifdef CONFIG_NFSD_V4
234 /* before processing a COMPOUND operation, we have to check that there
235 * is enough space in the buffer for XDR encode to succeed. otherwise,
236 * we might process an operation with side effects, and be unable to
237 * tell the client that the operation succeeded.
239 * COMPOUND_SLACK_SPACE - this is the minimum amount of buffer space
240 * needed to encode an "ordinary" _successful_ operation. (GETATTR,
241 * READ, READDIR, and READLINK have their own buffer checks.) if we
242 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
244 * COMPOUND_ERR_SLACK_SPACE - this is the minimum amount of buffer space
245 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
246 * care is taken to ensure that we never fall below this level for any
249 #define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
250 #define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
252 #define NFSD_LEASE_TIME 60 /* seconds */
253 #define NFSD_LAUNDROMAT_MINTIMEOUT 10 /* seconds */
256 * The following attributes are currently not supported by the NFSv4 server:
257 * ACL (will be supported in a forthcoming patch)
258 * ARCHIVE (deprecated anyway)
259 * FS_LOCATIONS (will be supported eventually)
260 * HIDDEN (unlikely to be supported any time soon)
261 * MIMETYPE (unlikely to be supported any time soon)
262 * QUOTA_* (will be supported in a forthcoming patch)
263 * SYSTEM (unlikely to be supported any time soon)
264 * TIME_BACKUP (unlikely to be supported any time soon)
265 * TIME_CREATE (unlikely to be supported any time soon)
267 #define NFSD_SUPPORTED_ATTRS_WORD0 \
268 (FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
269 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
270 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
271 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
272 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
273 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
274 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
275 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_HOMOGENEOUS \
276 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
277 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE)
279 #define NFSD_SUPPORTED_ATTRS_WORD1 \
280 (FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
281 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
282 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
283 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
284 | FATTR4_WORD1_TIME_CREATE | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
285 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
287 /* These will return ERR_INVAL if specified in GETATTR or READDIR. */
288 #define NFSD_WRITEONLY_ATTRS_WORD1 \
289 (FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
291 /* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
292 #define NFSD_WRITEABLE_ATTRS_WORD0 FATTR4_WORD0_SIZE
293 #define NFSD_WRITEABLE_ATTRS_WORD1 \
294 (FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
295 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_METADATA | FATTR4_WORD1_TIME_MODIFY_SET)
297 #endif /* CONFIG_NFSD_V4 */
299 #endif /* __KERNEL__ */
301 #endif /* LINUX_NFSD_NFSD_H */