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