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/types.h>
14 #include <linux/unistd.h>
15 #include <linux/dirent.h>
17 #include <linux/posix_acl.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/stats.h>
27 #define NFSD_VERSION "0.5"
28 #define NFSD_SUPPORTED_MINOR_VERSION 0
31 * Special flags for nfsd_permission. These must be different from MAY_READ,
32 * MAY_WRITE, and MAY_EXEC.
38 #define MAY_OWNER_OVERRIDE 64
39 #define MAY_LOCAL_ACCESS 128 /* IRIX doing local access check on device special file*/
40 #if (MAY_SATTR | MAY_TRUNC | MAY_LOCK | MAY_OWNER_OVERRIDE | MAY_LOCAL_ACCESS) & (MAY_READ | MAY_WRITE | MAY_EXEC)
41 # error "please use a different value for MAY_SATTR or MAY_TRUNC or MAY_LOCK or MAY_LOCAL_ACCESS or MAY_OWNER_OVERRIDE."
43 #define MAY_CREATE (MAY_EXEC|MAY_WRITE)
44 #define MAY_REMOVE (MAY_EXEC|MAY_WRITE|MAY_TRUNC)
47 * Callback function for readdir
50 __be32 err
; /* 0, nfserr, or nfserr_eof */
52 typedef int (*nfsd_dirop_t
)(struct inode
*, struct dentry
*, int, int);
54 extern struct svc_program nfsd_program
;
55 extern struct svc_version nfsd_version2
, nfsd_version3
,
57 extern struct mutex nfsd_mutex
;
58 extern struct svc_serv
*nfsd_serv
;
60 extern struct seq_operations nfs_exports_op
;
63 * Function prototypes.
65 int nfsd_svc(unsigned short port
, int nrservs
);
66 int nfsd_dispatch(struct svc_rqst
*rqstp
, __be32
*statp
);
68 int nfsd_nrthreads(void);
69 int nfsd_nrpools(void);
70 int nfsd_get_nrthreads(int n
, int *);
71 int nfsd_set_nrthreads(int n
, int *);
74 int fh_lock_parent(struct svc_fh
*, struct dentry
*);
75 int nfsd_racache_init(int);
76 void nfsd_racache_shutdown(void);
77 int nfsd_cross_mnt(struct svc_rqst
*rqstp
, struct dentry
**dpp
,
78 struct svc_export
**expp
);
79 __be32
nfsd_lookup(struct svc_rqst
*, struct svc_fh
*,
80 const char *, unsigned int, struct svc_fh
*);
81 __be32
nfsd_lookup_dentry(struct svc_rqst
*, struct svc_fh
*,
82 const char *, unsigned int,
83 struct svc_export
**, struct dentry
**);
84 __be32
nfsd_setattr(struct svc_rqst
*, struct svc_fh
*,
85 struct iattr
*, int, time_t);
87 __be32
nfsd4_set_nfs4_acl(struct svc_rqst
*, struct svc_fh
*,
89 int nfsd4_get_nfs4_acl(struct svc_rqst
*, struct dentry
*, struct nfs4_acl
**);
90 #endif /* CONFIG_NFSD_V4 */
91 __be32
nfsd_create(struct svc_rqst
*, struct svc_fh
*,
92 char *name
, int len
, struct iattr
*attrs
,
93 int type
, dev_t rdev
, struct svc_fh
*res
);
95 __be32
nfsd_access(struct svc_rqst
*, struct svc_fh
*, u32
*, u32
*);
96 __be32
nfsd_create_v3(struct svc_rqst
*, struct svc_fh
*,
97 char *name
, int len
, struct iattr
*attrs
,
98 struct svc_fh
*res
, int createmode
,
99 u32
*verifier
, int *truncp
, int *created
);
100 __be32
nfsd_commit(struct svc_rqst
*, struct svc_fh
*,
101 loff_t
, unsigned long);
102 #endif /* CONFIG_NFSD_V3 */
103 __be32
nfsd_open(struct svc_rqst
*, struct svc_fh
*, int,
104 int, struct file
**);
105 void nfsd_close(struct file
*);
106 __be32
nfsd_read(struct svc_rqst
*, struct svc_fh
*, struct file
*,
107 loff_t
, struct kvec
*, int, unsigned long *);
108 __be32
nfsd_write(struct svc_rqst
*, struct svc_fh
*,struct file
*,
109 loff_t
, struct kvec
*,int, unsigned long, int *);
110 __be32
nfsd_readlink(struct svc_rqst
*, struct svc_fh
*,
112 __be32
nfsd_symlink(struct svc_rqst
*, struct svc_fh
*,
113 char *name
, int len
, char *path
, int plen
,
114 struct svc_fh
*res
, struct iattr
*);
115 __be32
nfsd_link(struct svc_rqst
*, struct svc_fh
*,
116 char *, int, struct svc_fh
*);
117 __be32
nfsd_rename(struct svc_rqst
*,
118 struct svc_fh
*, char *, int,
119 struct svc_fh
*, char *, int);
120 __be32
nfsd_remove(struct svc_rqst
*,
121 struct svc_fh
*, char *, int);
122 __be32
nfsd_unlink(struct svc_rqst
*, struct svc_fh
*, int type
,
123 char *name
, int len
);
124 int nfsd_truncate(struct svc_rqst
*, struct svc_fh
*,
126 __be32
nfsd_readdir(struct svc_rqst
*, struct svc_fh
*,
127 loff_t
*, struct readdir_cd
*, filldir_t
);
128 __be32
nfsd_statfs(struct svc_rqst
*, struct svc_fh
*,
131 int nfsd_notify_change(struct inode
*, struct iattr
*);
132 __be32
nfsd_permission(struct svc_rqst
*, struct svc_export
*,
133 struct dentry
*, int);
134 int nfsd_sync_dir(struct dentry
*dp
);
136 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
137 #ifdef CONFIG_NFSD_V2_ACL
138 extern struct svc_version nfsd_acl_version2
;
140 #define nfsd_acl_version2 NULL
142 #ifdef CONFIG_NFSD_V3_ACL
143 extern struct svc_version nfsd_acl_version3
;
145 #define nfsd_acl_version3 NULL
147 struct posix_acl
*nfsd_get_posix_acl(struct svc_fh
*, int);
148 int nfsd_set_posix_acl(struct svc_fh
*, int, struct posix_acl
*);
151 enum vers_op
{NFSD_SET
, NFSD_CLEAR
, NFSD_TEST
, NFSD_AVAIL
};
152 int nfsd_vers(int vers
, enum vers_op change
);
153 void nfsd_reset_versions(void);
154 int nfsd_create_serv(void);
156 extern int nfsd_max_blksize
;
161 #ifdef CONFIG_NFSD_V4
162 extern unsigned int max_delegations
;
163 int nfs4_state_init(void);
164 void nfsd4_free_slabs(void);
165 void nfs4_state_start(void);
166 void nfs4_state_shutdown(void);
167 time_t nfs4_lease_time(void);
168 void nfs4_reset_lease(time_t leasetime
);
169 int nfs4_reset_recoverydir(char *recdir
);
171 static inline int nfs4_state_init(void) { return 0; }
172 static inline void nfsd4_free_slabs(void) { }
173 static inline void nfs4_state_start(void) { }
174 static inline void nfs4_state_shutdown(void) { }
175 static inline time_t nfs4_lease_time(void) { return 0; }
176 static inline void nfs4_reset_lease(time_t leasetime
) { }
177 static inline int nfs4_reset_recoverydir(char *recdir
) { return 0; }
183 void nfsd_lockd_init(void);
184 void nfsd_lockd_shutdown(void);
188 * These macros provide pre-xdr'ed values for faster operation.
190 #define nfs_ok __constant_htonl(NFS_OK)
191 #define nfserr_perm __constant_htonl(NFSERR_PERM)
192 #define nfserr_noent __constant_htonl(NFSERR_NOENT)
193 #define nfserr_io __constant_htonl(NFSERR_IO)
194 #define nfserr_nxio __constant_htonl(NFSERR_NXIO)
195 #define nfserr_eagain __constant_htonl(NFSERR_EAGAIN)
196 #define nfserr_acces __constant_htonl(NFSERR_ACCES)
197 #define nfserr_exist __constant_htonl(NFSERR_EXIST)
198 #define nfserr_xdev __constant_htonl(NFSERR_XDEV)
199 #define nfserr_nodev __constant_htonl(NFSERR_NODEV)
200 #define nfserr_notdir __constant_htonl(NFSERR_NOTDIR)
201 #define nfserr_isdir __constant_htonl(NFSERR_ISDIR)
202 #define nfserr_inval __constant_htonl(NFSERR_INVAL)
203 #define nfserr_fbig __constant_htonl(NFSERR_FBIG)
204 #define nfserr_nospc __constant_htonl(NFSERR_NOSPC)
205 #define nfserr_rofs __constant_htonl(NFSERR_ROFS)
206 #define nfserr_mlink __constant_htonl(NFSERR_MLINK)
207 #define nfserr_opnotsupp __constant_htonl(NFSERR_OPNOTSUPP)
208 #define nfserr_nametoolong __constant_htonl(NFSERR_NAMETOOLONG)
209 #define nfserr_notempty __constant_htonl(NFSERR_NOTEMPTY)
210 #define nfserr_dquot __constant_htonl(NFSERR_DQUOT)
211 #define nfserr_stale __constant_htonl(NFSERR_STALE)
212 #define nfserr_remote __constant_htonl(NFSERR_REMOTE)
213 #define nfserr_wflush __constant_htonl(NFSERR_WFLUSH)
214 #define nfserr_badhandle __constant_htonl(NFSERR_BADHANDLE)
215 #define nfserr_notsync __constant_htonl(NFSERR_NOT_SYNC)
216 #define nfserr_badcookie __constant_htonl(NFSERR_BAD_COOKIE)
217 #define nfserr_notsupp __constant_htonl(NFSERR_NOTSUPP)
218 #define nfserr_toosmall __constant_htonl(NFSERR_TOOSMALL)
219 #define nfserr_serverfault __constant_htonl(NFSERR_SERVERFAULT)
220 #define nfserr_badtype __constant_htonl(NFSERR_BADTYPE)
221 #define nfserr_jukebox __constant_htonl(NFSERR_JUKEBOX)
222 #define nfserr_denied __constant_htonl(NFSERR_DENIED)
223 #define nfserr_deadlock __constant_htonl(NFSERR_DEADLOCK)
224 #define nfserr_expired __constant_htonl(NFSERR_EXPIRED)
225 #define nfserr_bad_cookie __constant_htonl(NFSERR_BAD_COOKIE)
226 #define nfserr_same __constant_htonl(NFSERR_SAME)
227 #define nfserr_clid_inuse __constant_htonl(NFSERR_CLID_INUSE)
228 #define nfserr_stale_clientid __constant_htonl(NFSERR_STALE_CLIENTID)
229 #define nfserr_resource __constant_htonl(NFSERR_RESOURCE)
230 #define nfserr_moved __constant_htonl(NFSERR_MOVED)
231 #define nfserr_nofilehandle __constant_htonl(NFSERR_NOFILEHANDLE)
232 #define nfserr_minor_vers_mismatch __constant_htonl(NFSERR_MINOR_VERS_MISMATCH)
233 #define nfserr_share_denied __constant_htonl(NFSERR_SHARE_DENIED)
234 #define nfserr_stale_stateid __constant_htonl(NFSERR_STALE_STATEID)
235 #define nfserr_old_stateid __constant_htonl(NFSERR_OLD_STATEID)
236 #define nfserr_bad_stateid __constant_htonl(NFSERR_BAD_STATEID)
237 #define nfserr_bad_seqid __constant_htonl(NFSERR_BAD_SEQID)
238 #define nfserr_symlink __constant_htonl(NFSERR_SYMLINK)
239 #define nfserr_not_same __constant_htonl(NFSERR_NOT_SAME)
240 #define nfserr_restorefh __constant_htonl(NFSERR_RESTOREFH)
241 #define nfserr_attrnotsupp __constant_htonl(NFSERR_ATTRNOTSUPP)
242 #define nfserr_bad_xdr __constant_htonl(NFSERR_BAD_XDR)
243 #define nfserr_openmode __constant_htonl(NFSERR_OPENMODE)
244 #define nfserr_locks_held __constant_htonl(NFSERR_LOCKS_HELD)
245 #define nfserr_op_illegal __constant_htonl(NFSERR_OP_ILLEGAL)
246 #define nfserr_grace __constant_htonl(NFSERR_GRACE)
247 #define nfserr_no_grace __constant_htonl(NFSERR_NO_GRACE)
248 #define nfserr_reclaim_bad __constant_htonl(NFSERR_RECLAIM_BAD)
249 #define nfserr_badname __constant_htonl(NFSERR_BADNAME)
250 #define nfserr_cb_path_down __constant_htonl(NFSERR_CB_PATH_DOWN)
251 #define nfserr_locked __constant_htonl(NFSERR_LOCKED)
252 #define nfserr_wrongsec __constant_htonl(NFSERR_WRONGSEC)
253 #define nfserr_replay_me __constant_htonl(NFSERR_REPLAY_ME)
255 /* error codes for internal use */
256 /* if a request fails due to kmalloc failure, it gets dropped.
257 * Client should resend eventually
259 #define nfserr_dropit __constant_htonl(30000)
260 /* end-of-file indicator in readdir */
261 #define nfserr_eof __constant_htonl(30001)
263 /* Check for dir entries '.' and '..' */
264 #define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
267 * Time of server startup
269 extern struct timeval nfssvc_boot
;
271 #ifdef CONFIG_NFSD_V4
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.
278 * COMPOUND_SLACK_SPACE - this is the minimum bytes 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.
283 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes 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
288 #define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
289 #define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
291 #define NFSD_LEASE_TIME (nfs4_lease_time())
292 #define NFSD_LAUNDROMAT_MINTIMEOUT 10 /* seconds */
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)
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)
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)
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)
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_MODIFY_SET)
335 #endif /* CONFIG_NFSD_V4 */
337 #endif /* LINUX_NFSD_NFSD_H */