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/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 __be32 err
; /* 0, nfserr, or nfserr_eof */
55 typedef int (*nfsd_dirop_t
)(struct inode
*, struct dentry
*, int, int);
57 extern struct svc_program nfsd_program
;
58 extern struct svc_version nfsd_version2
, nfsd_version3
,
60 extern struct svc_serv
*nfsd_serv
;
62 * Function prototypes.
64 int nfsd_svc(unsigned short port
, int nrservs
);
65 int nfsd_dispatch(struct svc_rqst
*rqstp
, __be32
*statp
);
68 int fh_lock_parent(struct svc_fh
*, struct dentry
*);
69 int nfsd_racache_init(int);
70 void nfsd_racache_shutdown(void);
71 int nfsd_cross_mnt(struct svc_rqst
*rqstp
, struct dentry
**dpp
,
72 struct svc_export
**expp
);
73 __be32
nfsd_lookup(struct svc_rqst
*, struct svc_fh
*,
74 const char *, int, struct svc_fh
*);
75 __be32
nfsd_setattr(struct svc_rqst
*, struct svc_fh
*,
76 struct iattr
*, int, time_t);
78 __be32
nfsd4_set_nfs4_acl(struct svc_rqst
*, struct svc_fh
*,
80 int nfsd4_get_nfs4_acl(struct svc_rqst
*, struct dentry
*, struct nfs4_acl
**);
81 #endif /* CONFIG_NFSD_V4 */
82 __be32
nfsd_create(struct svc_rqst
*, struct svc_fh
*,
83 char *name
, int len
, struct iattr
*attrs
,
84 int type
, dev_t rdev
, struct svc_fh
*res
);
86 __be32
nfsd_access(struct svc_rqst
*, struct svc_fh
*, u32
*, u32
*);
87 __be32
nfsd_create_v3(struct svc_rqst
*, struct svc_fh
*,
88 char *name
, int len
, struct iattr
*attrs
,
89 struct svc_fh
*res
, int createmode
,
90 u32
*verifier
, int *truncp
, int *created
);
91 __be32
nfsd_commit(struct svc_rqst
*, struct svc_fh
*,
92 loff_t
, unsigned long);
93 #endif /* CONFIG_NFSD_V3 */
94 __be32
nfsd_open(struct svc_rqst
*, struct svc_fh
*, int,
96 void nfsd_close(struct file
*);
97 __be32
nfsd_read(struct svc_rqst
*, struct svc_fh
*, struct file
*,
98 loff_t
, struct kvec
*, int, unsigned long *);
99 __be32
nfsd_write(struct svc_rqst
*, struct svc_fh
*,struct file
*,
100 loff_t
, struct kvec
*,int, unsigned long, int *);
101 __be32
nfsd_readlink(struct svc_rqst
*, struct svc_fh
*,
103 __be32
nfsd_symlink(struct svc_rqst
*, struct svc_fh
*,
104 char *name
, int len
, char *path
, int plen
,
105 struct svc_fh
*res
, struct iattr
*);
106 __be32
nfsd_link(struct svc_rqst
*, struct svc_fh
*,
107 char *, int, struct svc_fh
*);
108 __be32
nfsd_rename(struct svc_rqst
*,
109 struct svc_fh
*, char *, int,
110 struct svc_fh
*, char *, int);
111 __be32
nfsd_remove(struct svc_rqst
*,
112 struct svc_fh
*, char *, int);
113 __be32
nfsd_unlink(struct svc_rqst
*, struct svc_fh
*, int type
,
114 char *name
, int len
);
115 int nfsd_truncate(struct svc_rqst
*, struct svc_fh
*,
117 __be32
nfsd_readdir(struct svc_rqst
*, struct svc_fh
*,
118 loff_t
*, struct readdir_cd
*, filldir_t
);
119 __be32
nfsd_statfs(struct svc_rqst
*, struct svc_fh
*,
122 int nfsd_notify_change(struct inode
*, struct iattr
*);
123 __be32
nfsd_permission(struct svc_export
*, struct dentry
*, int);
124 int nfsd_sync_dir(struct dentry
*dp
);
126 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
127 #ifdef CONFIG_NFSD_V2_ACL
128 extern struct svc_version nfsd_acl_version2
;
130 #define nfsd_acl_version2 NULL
132 #ifdef CONFIG_NFSD_V3_ACL
133 extern struct svc_version nfsd_acl_version3
;
135 #define nfsd_acl_version3 NULL
137 struct posix_acl
*nfsd_get_posix_acl(struct svc_fh
*, int);
138 int nfsd_set_posix_acl(struct svc_fh
*, int, struct posix_acl
*);
141 enum vers_op
{NFSD_SET
, NFSD_CLEAR
, NFSD_TEST
, NFSD_AVAIL
};
142 int nfsd_vers(int vers
, enum vers_op change
);
143 void nfsd_reset_versions(void);
144 int nfsd_create_serv(void);
146 extern int nfsd_max_blksize
;
151 #ifdef CONFIG_NFSD_V4
152 void nfs4_state_init(void);
153 int nfs4_state_start(void);
154 void nfs4_state_shutdown(void);
155 time_t nfs4_lease_time(void);
156 void nfs4_reset_lease(time_t leasetime
);
157 int nfs4_reset_recoverydir(char *recdir
);
159 static inline void nfs4_state_init(void){};
160 static inline int nfs4_state_start(void){return 0;}
161 static inline void nfs4_state_shutdown(void){}
162 static inline time_t nfs4_lease_time(void){return 0;}
163 static inline void nfs4_reset_lease(time_t leasetime
){}
164 static inline int nfs4_reset_recoverydir(char *recdir
) {return 0;}
170 void nfsd_lockd_init(void);
171 void nfsd_lockd_shutdown(void);
175 * These macros provide pre-xdr'ed values for faster operation.
177 #define nfs_ok __constant_htonl(NFS_OK)
178 #define nfserr_perm __constant_htonl(NFSERR_PERM)
179 #define nfserr_noent __constant_htonl(NFSERR_NOENT)
180 #define nfserr_io __constant_htonl(NFSERR_IO)
181 #define nfserr_nxio __constant_htonl(NFSERR_NXIO)
182 #define nfserr_eagain __constant_htonl(NFSERR_EAGAIN)
183 #define nfserr_acces __constant_htonl(NFSERR_ACCES)
184 #define nfserr_exist __constant_htonl(NFSERR_EXIST)
185 #define nfserr_xdev __constant_htonl(NFSERR_XDEV)
186 #define nfserr_nodev __constant_htonl(NFSERR_NODEV)
187 #define nfserr_notdir __constant_htonl(NFSERR_NOTDIR)
188 #define nfserr_isdir __constant_htonl(NFSERR_ISDIR)
189 #define nfserr_inval __constant_htonl(NFSERR_INVAL)
190 #define nfserr_fbig __constant_htonl(NFSERR_FBIG)
191 #define nfserr_nospc __constant_htonl(NFSERR_NOSPC)
192 #define nfserr_rofs __constant_htonl(NFSERR_ROFS)
193 #define nfserr_mlink __constant_htonl(NFSERR_MLINK)
194 #define nfserr_opnotsupp __constant_htonl(NFSERR_OPNOTSUPP)
195 #define nfserr_nametoolong __constant_htonl(NFSERR_NAMETOOLONG)
196 #define nfserr_notempty __constant_htonl(NFSERR_NOTEMPTY)
197 #define nfserr_dquot __constant_htonl(NFSERR_DQUOT)
198 #define nfserr_stale __constant_htonl(NFSERR_STALE)
199 #define nfserr_remote __constant_htonl(NFSERR_REMOTE)
200 #define nfserr_wflush __constant_htonl(NFSERR_WFLUSH)
201 #define nfserr_badhandle __constant_htonl(NFSERR_BADHANDLE)
202 #define nfserr_notsync __constant_htonl(NFSERR_NOT_SYNC)
203 #define nfserr_badcookie __constant_htonl(NFSERR_BAD_COOKIE)
204 #define nfserr_notsupp __constant_htonl(NFSERR_NOTSUPP)
205 #define nfserr_toosmall __constant_htonl(NFSERR_TOOSMALL)
206 #define nfserr_serverfault __constant_htonl(NFSERR_SERVERFAULT)
207 #define nfserr_badtype __constant_htonl(NFSERR_BADTYPE)
208 #define nfserr_jukebox __constant_htonl(NFSERR_JUKEBOX)
209 #define nfserr_denied __constant_htonl(NFSERR_DENIED)
210 #define nfserr_deadlock __constant_htonl(NFSERR_DEADLOCK)
211 #define nfserr_expired __constant_htonl(NFSERR_EXPIRED)
212 #define nfserr_bad_cookie __constant_htonl(NFSERR_BAD_COOKIE)
213 #define nfserr_same __constant_htonl(NFSERR_SAME)
214 #define nfserr_clid_inuse __constant_htonl(NFSERR_CLID_INUSE)
215 #define nfserr_stale_clientid __constant_htonl(NFSERR_STALE_CLIENTID)
216 #define nfserr_resource __constant_htonl(NFSERR_RESOURCE)
217 #define nfserr_moved __constant_htonl(NFSERR_MOVED)
218 #define nfserr_nofilehandle __constant_htonl(NFSERR_NOFILEHANDLE)
219 #define nfserr_minor_vers_mismatch __constant_htonl(NFSERR_MINOR_VERS_MISMATCH)
220 #define nfserr_share_denied __constant_htonl(NFSERR_SHARE_DENIED)
221 #define nfserr_stale_stateid __constant_htonl(NFSERR_STALE_STATEID)
222 #define nfserr_old_stateid __constant_htonl(NFSERR_OLD_STATEID)
223 #define nfserr_bad_stateid __constant_htonl(NFSERR_BAD_STATEID)
224 #define nfserr_bad_seqid __constant_htonl(NFSERR_BAD_SEQID)
225 #define nfserr_symlink __constant_htonl(NFSERR_SYMLINK)
226 #define nfserr_not_same __constant_htonl(NFSERR_NOT_SAME)
227 #define nfserr_restorefh __constant_htonl(NFSERR_RESTOREFH)
228 #define nfserr_attrnotsupp __constant_htonl(NFSERR_ATTRNOTSUPP)
229 #define nfserr_bad_xdr __constant_htonl(NFSERR_BAD_XDR)
230 #define nfserr_openmode __constant_htonl(NFSERR_OPENMODE)
231 #define nfserr_locks_held __constant_htonl(NFSERR_LOCKS_HELD)
232 #define nfserr_op_illegal __constant_htonl(NFSERR_OP_ILLEGAL)
233 #define nfserr_grace __constant_htonl(NFSERR_GRACE)
234 #define nfserr_no_grace __constant_htonl(NFSERR_NO_GRACE)
235 #define nfserr_reclaim_bad __constant_htonl(NFSERR_RECLAIM_BAD)
236 #define nfserr_badname __constant_htonl(NFSERR_BADNAME)
237 #define nfserr_cb_path_down __constant_htonl(NFSERR_CB_PATH_DOWN)
238 #define nfserr_locked __constant_htonl(NFSERR_LOCKED)
239 #define nfserr_replay_me __constant_htonl(NFSERR_REPLAY_ME)
241 /* error codes for internal use */
242 /* if a request fails due to kmalloc failure, it gets dropped.
243 * Client should resend eventually
245 #define nfserr_dropit __constant_htonl(30000)
246 /* end-of-file indicator in readdir */
247 #define nfserr_eof __constant_htonl(30001)
249 /* Check for dir entries '.' and '..' */
250 #define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
253 * Time of server startup
255 extern struct timeval nfssvc_boot
;
257 #ifdef CONFIG_NFSD_V4
259 /* before processing a COMPOUND operation, we have to check that there
260 * is enough space in the buffer for XDR encode to succeed. otherwise,
261 * we might process an operation with side effects, and be unable to
262 * tell the client that the operation succeeded.
264 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
265 * needed to encode an "ordinary" _successful_ operation. (GETATTR,
266 * READ, READDIR, and READLINK have their own buffer checks.) if we
267 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
269 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
270 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
271 * care is taken to ensure that we never fall below this level for any
274 #define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
275 #define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
277 #define NFSD_LEASE_TIME (nfs4_lease_time())
278 #define NFSD_LAUNDROMAT_MINTIMEOUT 10 /* seconds */
281 * The following attributes are currently not supported by the NFSv4 server:
282 * ARCHIVE (deprecated anyway)
283 * HIDDEN (unlikely to be supported any time soon)
284 * MIMETYPE (unlikely to be supported any time soon)
285 * QUOTA_* (will be supported in a forthcoming patch)
286 * SYSTEM (unlikely to be supported any time soon)
287 * TIME_BACKUP (unlikely to be supported any time soon)
288 * TIME_CREATE (unlikely to be supported any time soon)
290 #define NFSD_SUPPORTED_ATTRS_WORD0 \
291 (FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
292 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
293 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
294 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
295 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
296 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
297 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
298 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \
299 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
300 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL)
302 #define NFSD_SUPPORTED_ATTRS_WORD1 \
303 (FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
304 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
305 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
306 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
307 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
308 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
310 /* These will return ERR_INVAL if specified in GETATTR or READDIR. */
311 #define NFSD_WRITEONLY_ATTRS_WORD1 \
312 (FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
314 /* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
315 #define NFSD_WRITEABLE_ATTRS_WORD0 \
316 (FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL )
317 #define NFSD_WRITEABLE_ATTRS_WORD1 \
318 (FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
319 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_METADATA | FATTR4_WORD1_TIME_MODIFY_SET)
321 #endif /* CONFIG_NFSD_V4 */
323 #endif /* __KERNEL__ */
325 #endif /* LINUX_NFSD_NFSD_H */