2 * linux/fs/nfsd/nfsfh.c
4 * NFS server file handle treatment.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
7 * Portions Copyright (C) 1999 G. Allen Morris III <gam3@acm.org>
8 * Extensive rewrite by Neil Brown <neilb@cse.unsw.edu.au> Southern-Spring 1999
9 * ... and again Southern-Winter 2001 to support export_operations
12 #include <linux/slab.h>
14 #include <linux/unistd.h>
15 #include <linux/string.h>
16 #include <linux/stat.h>
17 #include <linux/dcache.h>
18 #include <linux/exportfs.h>
19 #include <linux/mount.h>
21 #include <linux/sunrpc/clnt.h>
22 #include <linux/sunrpc/svc.h>
23 #include <linux/nfsd/nfsd.h>
25 #define NFSDDBG_FACILITY NFSDDBG_FH
28 static int nfsd_nr_verified;
29 static int nfsd_nr_put;
32 * our acceptability function.
33 * if NOSUBTREECHECK, accept anything
34 * if not, require that we can walk up to exp->ex_dentry
35 * doing some checks on the 'x' bits
37 static int nfsd_acceptable(void *expv, struct dentry *dentry)
39 struct svc_export *exp = expv;
41 struct dentry *tdentry;
42 struct dentry *parent;
44 if (exp->ex_flags & NFSEXP_NOSUBTREECHECK)
47 tdentry = dget(dentry);
48 while (tdentry != exp->ex_dentry && ! IS_ROOT(tdentry)) {
49 /* make sure parents give x permission to user */
51 parent = dget_parent(tdentry);
52 err = permission(parent->d_inode, MAY_EXEC, NULL);
60 if (tdentry != exp->ex_dentry)
61 dprintk("nfsd_acceptable failed at %p %s\n", tdentry, tdentry->d_name.name);
62 rv = (tdentry == exp->ex_dentry);
67 /* Type check. The correct error return for type mismatches does not seem to be
68 * generally agreed upon. SunOS seems to use EISDIR if file isn't S_IFREG; a
69 * comment in the NFSv3 spec says this is incorrect (implementation notes for
73 nfsd_mode_check(struct svc_rqst *rqstp, umode_t mode, int type)
75 /* Type can be negative when creating hardlinks - not to a dir */
76 if (type > 0 && (mode & S_IFMT) != type) {
77 if (rqstp->rq_vers == 4 && (mode & S_IFMT) == S_IFLNK)
78 return nfserr_symlink;
79 else if (type == S_IFDIR)
81 else if ((mode & S_IFMT) == S_IFDIR)
86 if (type < 0 && (mode & S_IFMT) == -type) {
87 if (rqstp->rq_vers == 4 && (mode & S_IFMT) == S_IFLNK)
88 return nfserr_symlink;
89 else if (type == -S_IFDIR)
98 * Perform sanity checks on the dentry in a client's file handle.
100 * Note that the file handle dentry may need to be freed even after
103 * This is only called at the start of an nfsproc call, so fhp points to
104 * a svc_fh which is all 0 except for the over-the-wire file handle.
107 fh_verify(struct svc_rqst *rqstp, struct svc_fh *fhp, int type, int access)
109 struct knfsd_fh *fh = &fhp->fh_handle;
110 struct svc_export *exp = NULL;
111 struct dentry *dentry;
114 dprintk("nfsd: fh_verify(%s)\n", SVCFH_fmt(fhp));
116 if (!fhp->fh_dentry) {
118 __u32 tfh[3]; /* filehandle fragment for oldstyle filehandles */
120 int data_left = fh->fh_size/4;
122 error = nfserr_stale;
123 if (rqstp->rq_client == NULL)
125 if (rqstp->rq_vers > 2)
126 error = nfserr_badhandle;
127 if (rqstp->rq_vers == 4 && fh->fh_size == 0)
128 return nfserr_nofilehandle;
130 if (fh->fh_version == 1) {
133 if (--data_left<0) goto out;
134 switch (fh->fh_auth_type) {
138 len = key_len(fh->fh_fsid_type) / 4;
139 if (len == 0) goto out;
140 if (fh->fh_fsid_type == FSID_MAJOR_MINOR) {
141 /* deprecated, convert to type 3 */
142 len = key_len(FSID_ENCODE_DEV)/4;
143 fh->fh_fsid_type = FSID_ENCODE_DEV;
144 fh->fh_fsid[0] = new_encode_dev(MKDEV(ntohl(fh->fh_fsid[0]), ntohl(fh->fh_fsid[1])));
145 fh->fh_fsid[1] = fh->fh_fsid[2];
147 if ((data_left -= len)<0) goto out;
148 exp = exp_find(rqstp->rq_client, fh->fh_fsid_type, datap, &rqstp->rq_chandle);
153 if (fh->fh_size != NFS_FHSIZE)
155 /* assume old filehandle format */
156 xdev = old_decode_dev(fh->ofh_xdev);
157 xino = u32_to_ino_t(fh->ofh_xino);
158 mk_fsid(FSID_DEV, tfh, xdev, xino, 0, NULL);
159 exp = exp_find(rqstp->rq_client, FSID_DEV, tfh,
163 error = nfserr_stale;
164 if (PTR_ERR(exp) == -ENOENT)
168 error = nfserrno(PTR_ERR(exp));
172 /* Check if the request originated from a secure port. */
174 if (!rqstp->rq_secure && EX_SECURE(exp)) {
175 char buf[RPC_MAX_ADDRBUFLEN];
177 "nfsd: request from insecure port %s!\n",
178 svc_print_addr(rqstp, buf, sizeof(buf)));
182 /* Set user creds for this exportpoint */
183 error = nfserrno(nfsd_setuser(rqstp, exp));
188 * Look up the dentry using the NFS file handle.
190 error = nfserr_stale;
191 if (rqstp->rq_vers > 2)
192 error = nfserr_badhandle;
194 if (fh->fh_version != 1) {
195 tfh[0] = fh->ofh_ino;
196 tfh[1] = fh->ofh_generation;
197 tfh[2] = fh->ofh_dirino;
200 if (fh->ofh_dirino == 0)
205 fileid_type = fh->fh_fileid_type;
207 if (fileid_type == 0)
208 dentry = dget(exp->ex_dentry);
210 dentry = exportfs_decode_fh(exp->ex_mnt, datap,
211 data_left, fileid_type,
212 nfsd_acceptable, exp);
216 if (IS_ERR(dentry)) {
217 if (PTR_ERR(dentry) != -EINVAL)
218 error = nfserrno(PTR_ERR(dentry));
222 if (S_ISDIR(dentry->d_inode->i_mode) &&
223 (dentry->d_flags & DCACHE_DISCONNECTED)) {
224 printk("nfsd: find_fh_dentry returned a DISCONNECTED directory: %s/%s\n",
225 dentry->d_parent->d_name.name, dentry->d_name.name);
228 fhp->fh_dentry = dentry;
229 fhp->fh_export = exp;
232 /* just rechecking permissions
233 * (e.g. nfsproc_create calls fh_verify, then nfsd_create does as well)
235 dprintk("nfsd: fh_verify - just checking\n");
236 dentry = fhp->fh_dentry;
237 exp = fhp->fh_export;
238 /* Set user creds for this exportpoint; necessary even
239 * in the "just checking" case because this may be a
240 * filehandle that was created by fh_compose, and that
241 * is about to be used in another nfsv4 compound
243 error = nfserrno(nfsd_setuser(rqstp, exp));
250 error = nfsd_mode_check(rqstp, dentry->d_inode->i_mode, type);
254 /* Finally, check access permissions. */
255 error = nfsd_permission(exp, dentry, access);
258 dprintk("fh_verify: %s/%s permission failure, "
259 "acc=%x, error=%d\n",
260 dentry->d_parent->d_name.name,
262 access, ntohl(error));
265 if (exp && !IS_ERR(exp))
267 if (error == nfserr_stale)
268 nfsdstats.fh_stale++;
274 * Compose a file handle for an NFS reply.
276 * Note that when first composed, the dentry may not yet have
277 * an inode. In this case a call to fh_update should be made
278 * before the fh goes out on the wire ...
280 static inline int _fh_update(struct dentry *dentry, struct svc_export *exp,
281 __u32 *datap, int *maxsize)
283 if (dentry == exp->ex_dentry) {
288 return exportfs_encode_fh(dentry, datap, maxsize,
289 !(exp->ex_flags & NFSEXP_NOSUBTREECHECK));
293 * for composing old style file handles
295 static inline void _fh_update_old(struct dentry *dentry,
296 struct svc_export *exp,
299 fh->ofh_ino = ino_t_to_u32(dentry->d_inode->i_ino);
300 fh->ofh_generation = dentry->d_inode->i_generation;
301 if (S_ISDIR(dentry->d_inode->i_mode) ||
302 (exp->ex_flags & NFSEXP_NOSUBTREECHECK))
307 fh_compose(struct svc_fh *fhp, struct svc_export *exp, struct dentry *dentry,
308 struct svc_fh *ref_fh)
310 /* ref_fh is a reference file handle.
311 * if it is non-null and for the same filesystem, then we should compose
312 * a filehandle which is of the same version, where possible.
313 * Currently, that means that if ref_fh->fh_handle.fh_version == 0xca
314 * Then create a 32byte filehandle using nfs_fhbase_old
320 struct inode * inode = dentry->d_inode;
321 struct dentry *parent = dentry->d_parent;
323 dev_t ex_dev = exp->ex_dentry->d_inode->i_sb->s_dev;
324 int root_export = (exp->ex_dentry == exp->ex_dentry->d_sb->s_root);
326 dprintk("nfsd: fh_compose(exp %02x:%02x/%ld %s/%s, ino=%ld)\n",
327 MAJOR(ex_dev), MINOR(ex_dev),
328 (long) exp->ex_dentry->d_inode->i_ino,
329 parent->d_name.name, dentry->d_name.name,
330 (inode ? inode->i_ino : 0));
332 /* Choose filehandle version and fsid type based on
333 * the reference filehandle (if it is in the same export)
334 * or the export options.
338 if (ref_fh && ref_fh->fh_export == exp) {
339 version = ref_fh->fh_handle.fh_version;
340 fsid_type = ref_fh->fh_handle.fh_fsid_type;
348 fsid_type = FSID_DEV;
356 /* Need to check that this type works for this
357 * export point. As the fsid -> filesystem mapping
358 * was guided by user-space, there is no guarantee
359 * that the filesystem actually supports that fsid
360 * type. If it doesn't we loop around again without
365 if (!old_valid_dev(ex_dev))
368 case FSID_MAJOR_MINOR:
369 case FSID_ENCODE_DEV:
370 if (!(exp->ex_dentry->d_inode->i_sb->s_type->fs_flags
375 if (! (exp->ex_flags & NFSEXP_FSID))
383 case FSID_UUID4_INUM:
384 case FSID_UUID16_INUM:
385 if (exp->ex_uuid == NULL)
389 } else if (exp->ex_uuid) {
390 if (fhp->fh_maxsize >= 64) {
392 fsid_type = FSID_UUID16;
394 fsid_type = FSID_UUID16_INUM;
397 fsid_type = FSID_UUID8;
399 fsid_type = FSID_UUID4_INUM;
401 } else if (exp->ex_flags & NFSEXP_FSID)
402 fsid_type = FSID_NUM;
403 else if (!old_valid_dev(ex_dev))
404 /* for newer device numbers, we must use a newer fsid format */
405 fsid_type = FSID_ENCODE_DEV;
407 fsid_type = FSID_DEV;
412 if (fhp->fh_locked || fhp->fh_dentry) {
413 printk(KERN_ERR "fh_compose: fh %s/%s not initialized!\n",
414 parent->d_name.name, dentry->d_name.name);
416 if (fhp->fh_maxsize < NFS_FHSIZE)
417 printk(KERN_ERR "fh_compose: called with maxsize %d! %s/%s\n",
419 parent->d_name.name, dentry->d_name.name);
421 fhp->fh_dentry = dget(dentry); /* our internal copy */
422 fhp->fh_export = exp;
425 if (version == 0xca) {
426 /* old style filehandle please */
427 memset(&fhp->fh_handle.fh_base, 0, NFS_FHSIZE);
428 fhp->fh_handle.fh_size = NFS_FHSIZE;
429 fhp->fh_handle.ofh_dcookie = 0xfeebbaca;
430 fhp->fh_handle.ofh_dev = old_encode_dev(ex_dev);
431 fhp->fh_handle.ofh_xdev = fhp->fh_handle.ofh_dev;
432 fhp->fh_handle.ofh_xino =
433 ino_t_to_u32(exp->ex_dentry->d_inode->i_ino);
434 fhp->fh_handle.ofh_dirino = ino_t_to_u32(parent_ino(dentry));
436 _fh_update_old(dentry, exp, &fhp->fh_handle);
439 fhp->fh_handle.fh_version = 1;
440 fhp->fh_handle.fh_auth_type = 0;
441 datap = fhp->fh_handle.fh_auth+0;
442 fhp->fh_handle.fh_fsid_type = fsid_type;
443 mk_fsid(fsid_type, datap, ex_dev,
444 exp->ex_dentry->d_inode->i_ino,
445 exp->ex_fsid, exp->ex_uuid);
447 len = key_len(fsid_type);
449 fhp->fh_handle.fh_size = 4 + len;
452 int size = (fhp->fh_maxsize-len-4)/4;
453 fhp->fh_handle.fh_fileid_type =
454 _fh_update(dentry, exp, datap, &size);
455 fhp->fh_handle.fh_size += size*4;
457 if (fhp->fh_handle.fh_fileid_type == 255)
458 return nfserr_opnotsupp;
466 * Update file handle information after changing a dentry.
467 * This is only called by nfsd_create, nfsd_create_v3 and nfsd_proc_create
470 fh_update(struct svc_fh *fhp)
472 struct dentry *dentry;
478 dentry = fhp->fh_dentry;
479 if (!dentry->d_inode)
481 if (fhp->fh_handle.fh_version != 1) {
482 _fh_update_old(dentry, fhp->fh_export, &fhp->fh_handle);
485 if (fhp->fh_handle.fh_fileid_type != 0)
487 datap = fhp->fh_handle.fh_auth+
488 fhp->fh_handle.fh_size/4 -1;
489 size = (fhp->fh_maxsize - fhp->fh_handle.fh_size)/4;
490 fhp->fh_handle.fh_fileid_type =
491 _fh_update(dentry, fhp->fh_export, datap, &size);
492 fhp->fh_handle.fh_size += size*4;
493 if (fhp->fh_handle.fh_fileid_type == 255)
494 return nfserr_opnotsupp;
500 printk(KERN_ERR "fh_update: fh not verified!\n");
503 printk(KERN_ERR "fh_update: %s/%s still negative!\n",
504 dentry->d_parent->d_name.name, dentry->d_name.name);
509 * Release a file handle.
512 fh_put(struct svc_fh *fhp)
514 struct dentry * dentry = fhp->fh_dentry;
515 struct svc_export * exp = fhp->fh_export;
518 fhp->fh_dentry = NULL;
520 #ifdef CONFIG_NFSD_V3
521 fhp->fh_pre_saved = 0;
522 fhp->fh_post_saved = 0;
527 cache_put(&exp->h, &svc_export_cache);
528 fhp->fh_export = NULL;
534 * Shorthand for dprintk()'s
536 char * SVCFH_fmt(struct svc_fh *fhp)
538 struct knfsd_fh *fh = &fhp->fh_handle;
541 sprintf(buf, "%d: %08x %08x %08x %08x %08x %08x",
543 fh->fh_base.fh_pad[0],
544 fh->fh_base.fh_pad[1],
545 fh->fh_base.fh_pad[2],
546 fh->fh_base.fh_pad[3],
547 fh->fh_base.fh_pad[4],
548 fh->fh_base.fh_pad[5]);
552 enum fsid_source fsid_source(struct svc_fh *fhp)
554 if (fhp->fh_handle.fh_version != 1)
555 return FSIDSOURCE_DEV;
556 switch(fhp->fh_handle.fh_fsid_type) {
558 case FSID_ENCODE_DEV:
559 case FSID_MAJOR_MINOR:
560 return FSIDSOURCE_DEV;
562 return FSIDSOURCE_FSID;
564 if (fhp->fh_export->ex_flags & NFSEXP_FSID)
565 return FSIDSOURCE_FSID;
567 return FSIDSOURCE_UUID;