printf: Remove unused 'bprintf'
[drm/drm-misc.git] / fs / nfsd / vfs.c
blob29cb7b812d713c233f4c5c8b3696518f542dfd9c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * File operations used by nfsd. Some of these have been ripped from
4 * other parts of the kernel because they weren't exported, others
5 * are partial duplicates with added or changed functionality.
7 * Note that several functions dget() the dentry upon which they want
8 * to act, most notably those that create directory entries. Response
9 * dentry's are dput()'d if necessary in the release callback.
10 * So if you notice code paths that apparently fail to dput() the
11 * dentry, don't worry--they have been taken care of.
13 * Copyright (C) 1995-1999 Olaf Kirch <okir@monad.swb.de>
14 * Zerocpy NFS support (C) 2002 Hirokazu Takahashi <taka@valinux.co.jp>
17 #include <linux/fs.h>
18 #include <linux/file.h>
19 #include <linux/splice.h>
20 #include <linux/falloc.h>
21 #include <linux/fcntl.h>
22 #include <linux/namei.h>
23 #include <linux/delay.h>
24 #include <linux/fsnotify.h>
25 #include <linux/posix_acl_xattr.h>
26 #include <linux/xattr.h>
27 #include <linux/jhash.h>
28 #include <linux/pagemap.h>
29 #include <linux/slab.h>
30 #include <linux/uaccess.h>
31 #include <linux/exportfs.h>
32 #include <linux/writeback.h>
33 #include <linux/security.h>
35 #include "xdr3.h"
37 #ifdef CONFIG_NFSD_V4
38 #include "acl.h"
39 #include "idmap.h"
40 #include "xdr4.h"
41 #endif /* CONFIG_NFSD_V4 */
43 #include "nfsd.h"
44 #include "vfs.h"
45 #include "filecache.h"
46 #include "trace.h"
48 #define NFSDDBG_FACILITY NFSDDBG_FILEOP
50 /**
51 * nfserrno - Map Linux errnos to NFS errnos
52 * @errno: POSIX(-ish) error code to be mapped
54 * Returns the appropriate (net-endian) nfserr_* (or nfs_ok if errno is 0). If
55 * it's an error we don't expect, log it once and return nfserr_io.
57 __be32
58 nfserrno (int errno)
60 static struct {
61 __be32 nfserr;
62 int syserr;
63 } nfs_errtbl[] = {
64 { nfs_ok, 0 },
65 { nfserr_perm, -EPERM },
66 { nfserr_noent, -ENOENT },
67 { nfserr_io, -EIO },
68 { nfserr_nxio, -ENXIO },
69 { nfserr_fbig, -E2BIG },
70 { nfserr_stale, -EBADF },
71 { nfserr_acces, -EACCES },
72 { nfserr_exist, -EEXIST },
73 { nfserr_xdev, -EXDEV },
74 { nfserr_mlink, -EMLINK },
75 { nfserr_nodev, -ENODEV },
76 { nfserr_notdir, -ENOTDIR },
77 { nfserr_isdir, -EISDIR },
78 { nfserr_inval, -EINVAL },
79 { nfserr_fbig, -EFBIG },
80 { nfserr_nospc, -ENOSPC },
81 { nfserr_rofs, -EROFS },
82 { nfserr_mlink, -EMLINK },
83 { nfserr_nametoolong, -ENAMETOOLONG },
84 { nfserr_notempty, -ENOTEMPTY },
85 { nfserr_dquot, -EDQUOT },
86 { nfserr_stale, -ESTALE },
87 { nfserr_jukebox, -ETIMEDOUT },
88 { nfserr_jukebox, -ERESTARTSYS },
89 { nfserr_jukebox, -EAGAIN },
90 { nfserr_jukebox, -EWOULDBLOCK },
91 { nfserr_jukebox, -ENOMEM },
92 { nfserr_io, -ETXTBSY },
93 { nfserr_notsupp, -EOPNOTSUPP },
94 { nfserr_toosmall, -ETOOSMALL },
95 { nfserr_serverfault, -ESERVERFAULT },
96 { nfserr_serverfault, -ENFILE },
97 { nfserr_io, -EREMOTEIO },
98 { nfserr_stale, -EOPENSTALE },
99 { nfserr_io, -EUCLEAN },
100 { nfserr_perm, -ENOKEY },
101 { nfserr_no_grace, -ENOGRACE},
102 { nfserr_io, -EBADMSG },
104 int i;
106 for (i = 0; i < ARRAY_SIZE(nfs_errtbl); i++) {
107 if (nfs_errtbl[i].syserr == errno)
108 return nfs_errtbl[i].nfserr;
110 WARN_ONCE(1, "nfsd: non-standard errno: %d\n", errno);
111 return nfserr_io;
115 * Called from nfsd_lookup and encode_dirent. Check if we have crossed
116 * a mount point.
117 * Returns -EAGAIN or -ETIMEDOUT leaving *dpp and *expp unchanged,
118 * or nfs_ok having possibly changed *dpp and *expp
121 nfsd_cross_mnt(struct svc_rqst *rqstp, struct dentry **dpp,
122 struct svc_export **expp)
124 struct svc_export *exp = *expp, *exp2 = NULL;
125 struct dentry *dentry = *dpp;
126 struct path path = {.mnt = mntget(exp->ex_path.mnt),
127 .dentry = dget(dentry)};
128 unsigned int follow_flags = 0;
129 int err = 0;
131 if (exp->ex_flags & NFSEXP_CROSSMOUNT)
132 follow_flags = LOOKUP_AUTOMOUNT;
134 err = follow_down(&path, follow_flags);
135 if (err < 0)
136 goto out;
137 if (path.mnt == exp->ex_path.mnt && path.dentry == dentry &&
138 nfsd_mountpoint(dentry, exp) == 2) {
139 /* This is only a mountpoint in some other namespace */
140 path_put(&path);
141 goto out;
144 exp2 = rqst_exp_get_by_name(rqstp, &path);
145 if (IS_ERR(exp2)) {
146 err = PTR_ERR(exp2);
148 * We normally allow NFS clients to continue
149 * "underneath" a mountpoint that is not exported.
150 * The exception is V4ROOT, where no traversal is ever
151 * allowed without an explicit export of the new
152 * directory.
154 if (err == -ENOENT && !(exp->ex_flags & NFSEXP_V4ROOT))
155 err = 0;
156 path_put(&path);
157 goto out;
159 if (nfsd_v4client(rqstp) ||
160 (exp->ex_flags & NFSEXP_CROSSMOUNT) || EX_NOHIDE(exp2)) {
161 /* successfully crossed mount point */
163 * This is subtle: path.dentry is *not* on path.mnt
164 * at this point. The only reason we are safe is that
165 * original mnt is pinned down by exp, so we should
166 * put path *before* putting exp
168 *dpp = path.dentry;
169 path.dentry = dentry;
170 *expp = exp2;
171 exp2 = exp;
173 path_put(&path);
174 exp_put(exp2);
175 out:
176 return err;
179 static void follow_to_parent(struct path *path)
181 struct dentry *dp;
183 while (path->dentry == path->mnt->mnt_root && follow_up(path))
185 dp = dget_parent(path->dentry);
186 dput(path->dentry);
187 path->dentry = dp;
190 static int nfsd_lookup_parent(struct svc_rqst *rqstp, struct dentry *dparent, struct svc_export **exp, struct dentry **dentryp)
192 struct svc_export *exp2;
193 struct path path = {.mnt = mntget((*exp)->ex_path.mnt),
194 .dentry = dget(dparent)};
196 follow_to_parent(&path);
198 exp2 = rqst_exp_parent(rqstp, &path);
199 if (PTR_ERR(exp2) == -ENOENT) {
200 *dentryp = dget(dparent);
201 } else if (IS_ERR(exp2)) {
202 path_put(&path);
203 return PTR_ERR(exp2);
204 } else {
205 *dentryp = dget(path.dentry);
206 exp_put(*exp);
207 *exp = exp2;
209 path_put(&path);
210 return 0;
214 * For nfsd purposes, we treat V4ROOT exports as though there was an
215 * export at *every* directory.
216 * We return:
217 * '1' if this dentry *must* be an export point,
218 * '2' if it might be, if there is really a mount here, and
219 * '0' if there is no chance of an export point here.
221 int nfsd_mountpoint(struct dentry *dentry, struct svc_export *exp)
223 if (!d_inode(dentry))
224 return 0;
225 if (exp->ex_flags & NFSEXP_V4ROOT)
226 return 1;
227 if (nfsd4_is_junction(dentry))
228 return 1;
229 if (d_managed(dentry))
231 * Might only be a mountpoint in a different namespace,
232 * but we need to check.
234 return 2;
235 return 0;
238 __be32
239 nfsd_lookup_dentry(struct svc_rqst *rqstp, struct svc_fh *fhp,
240 const char *name, unsigned int len,
241 struct svc_export **exp_ret, struct dentry **dentry_ret)
243 struct svc_export *exp;
244 struct dentry *dparent;
245 struct dentry *dentry;
246 int host_err;
248 dprintk("nfsd: nfsd_lookup(fh %s, %.*s)\n", SVCFH_fmt(fhp), len,name);
250 dparent = fhp->fh_dentry;
251 exp = exp_get(fhp->fh_export);
253 /* Lookup the name, but don't follow links */
254 if (isdotent(name, len)) {
255 if (len==1)
256 dentry = dget(dparent);
257 else if (dparent != exp->ex_path.dentry)
258 dentry = dget_parent(dparent);
259 else if (!EX_NOHIDE(exp) && !nfsd_v4client(rqstp))
260 dentry = dget(dparent); /* .. == . just like at / */
261 else {
262 /* checking mountpoint crossing is very different when stepping up */
263 host_err = nfsd_lookup_parent(rqstp, dparent, &exp, &dentry);
264 if (host_err)
265 goto out_nfserr;
267 } else {
268 dentry = lookup_one_len_unlocked(name, dparent, len);
269 host_err = PTR_ERR(dentry);
270 if (IS_ERR(dentry))
271 goto out_nfserr;
272 if (nfsd_mountpoint(dentry, exp)) {
273 host_err = nfsd_cross_mnt(rqstp, &dentry, &exp);
274 if (host_err) {
275 dput(dentry);
276 goto out_nfserr;
280 *dentry_ret = dentry;
281 *exp_ret = exp;
282 return 0;
284 out_nfserr:
285 exp_put(exp);
286 return nfserrno(host_err);
290 * nfsd_lookup - look up a single path component for nfsd
292 * @rqstp: the request context
293 * @fhp: the file handle of the directory
294 * @name: the component name, or %NULL to look up parent
295 * @len: length of name to examine
296 * @resfh: pointer to pre-initialised filehandle to hold result.
298 * Look up one component of a pathname.
299 * N.B. After this call _both_ fhp and resfh need an fh_put
301 * If the lookup would cross a mountpoint, and the mounted filesystem
302 * is exported to the client with NFSEXP_NOHIDE, then the lookup is
303 * accepted as it stands and the mounted directory is
304 * returned. Otherwise the covered directory is returned.
305 * NOTE: this mountpoint crossing is not supported properly by all
306 * clients and is explicitly disallowed for NFSv3
309 __be32
310 nfsd_lookup(struct svc_rqst *rqstp, struct svc_fh *fhp, const char *name,
311 unsigned int len, struct svc_fh *resfh)
313 struct svc_export *exp;
314 struct dentry *dentry;
315 __be32 err;
317 err = fh_verify(rqstp, fhp, S_IFDIR, NFSD_MAY_EXEC);
318 if (err)
319 return err;
320 err = nfsd_lookup_dentry(rqstp, fhp, name, len, &exp, &dentry);
321 if (err)
322 return err;
323 err = check_nfsd_access(exp, rqstp, false);
324 if (err)
325 goto out;
327 * Note: we compose the file handle now, but as the
328 * dentry may be negative, it may need to be updated.
330 err = fh_compose(resfh, exp, dentry, fhp);
331 if (!err && d_really_is_negative(dentry))
332 err = nfserr_noent;
333 out:
334 dput(dentry);
335 exp_put(exp);
336 return err;
339 static void
340 commit_reset_write_verifier(struct nfsd_net *nn, struct svc_rqst *rqstp,
341 int err)
343 switch (err) {
344 case -EAGAIN:
345 case -ESTALE:
347 * Neither of these are the result of a problem with
348 * durable storage, so avoid a write verifier reset.
350 break;
351 default:
352 nfsd_reset_write_verifier(nn);
353 trace_nfsd_writeverf_reset(nn, rqstp, err);
358 * Commit metadata changes to stable storage.
360 static int
361 commit_inode_metadata(struct inode *inode)
363 const struct export_operations *export_ops = inode->i_sb->s_export_op;
365 if (export_ops->commit_metadata)
366 return export_ops->commit_metadata(inode);
367 return sync_inode_metadata(inode, 1);
370 static int
371 commit_metadata(struct svc_fh *fhp)
373 struct inode *inode = d_inode(fhp->fh_dentry);
375 if (!EX_ISSYNC(fhp->fh_export))
376 return 0;
377 return commit_inode_metadata(inode);
381 * Go over the attributes and take care of the small differences between
382 * NFS semantics and what Linux expects.
384 static void
385 nfsd_sanitize_attrs(struct inode *inode, struct iattr *iap)
387 /* Ignore mode updates on symlinks */
388 if (S_ISLNK(inode->i_mode))
389 iap->ia_valid &= ~ATTR_MODE;
391 /* sanitize the mode change */
392 if (iap->ia_valid & ATTR_MODE) {
393 iap->ia_mode &= S_IALLUGO;
394 iap->ia_mode |= (inode->i_mode & ~S_IALLUGO);
397 /* Revoke setuid/setgid on chown */
398 if (!S_ISDIR(inode->i_mode) &&
399 ((iap->ia_valid & ATTR_UID) || (iap->ia_valid & ATTR_GID))) {
400 iap->ia_valid |= ATTR_KILL_PRIV;
401 if (iap->ia_valid & ATTR_MODE) {
402 /* we're setting mode too, just clear the s*id bits */
403 iap->ia_mode &= ~S_ISUID;
404 if (iap->ia_mode & S_IXGRP)
405 iap->ia_mode &= ~S_ISGID;
406 } else {
407 /* set ATTR_KILL_* bits and let VFS handle it */
408 iap->ia_valid |= ATTR_KILL_SUID;
409 iap->ia_valid |=
410 setattr_should_drop_sgid(&nop_mnt_idmap, inode);
415 static __be32
416 nfsd_get_write_access(struct svc_rqst *rqstp, struct svc_fh *fhp,
417 struct iattr *iap)
419 struct inode *inode = d_inode(fhp->fh_dentry);
421 if (iap->ia_size < inode->i_size) {
422 __be32 err;
424 err = nfsd_permission(&rqstp->rq_cred,
425 fhp->fh_export, fhp->fh_dentry,
426 NFSD_MAY_TRUNC | NFSD_MAY_OWNER_OVERRIDE);
427 if (err)
428 return err;
430 return nfserrno(get_write_access(inode));
433 static int __nfsd_setattr(struct dentry *dentry, struct iattr *iap)
435 int host_err;
437 if (iap->ia_valid & ATTR_SIZE) {
439 * RFC5661, Section 18.30.4:
440 * Changing the size of a file with SETATTR indirectly
441 * changes the time_modify and change attributes.
443 * (and similar for the older RFCs)
445 struct iattr size_attr = {
446 .ia_valid = ATTR_SIZE | ATTR_CTIME | ATTR_MTIME,
447 .ia_size = iap->ia_size,
450 if (iap->ia_size < 0)
451 return -EFBIG;
453 host_err = notify_change(&nop_mnt_idmap, dentry, &size_attr, NULL);
454 if (host_err)
455 return host_err;
456 iap->ia_valid &= ~ATTR_SIZE;
459 * Avoid the additional setattr call below if the only other
460 * attribute that the client sends is the mtime, as we update
461 * it as part of the size change above.
463 if ((iap->ia_valid & ~ATTR_MTIME) == 0)
464 return 0;
467 if (!iap->ia_valid)
468 return 0;
470 iap->ia_valid |= ATTR_CTIME;
471 return notify_change(&nop_mnt_idmap, dentry, iap, NULL);
475 * nfsd_setattr - Set various file attributes.
476 * @rqstp: controlling RPC transaction
477 * @fhp: filehandle of target
478 * @attr: attributes to set
479 * @guardtime: do not act if ctime.tv_sec does not match this timestamp
481 * This call may adjust the contents of @attr (in particular, this
482 * call may change the bits in the na_iattr.ia_valid field).
484 * Returns nfs_ok on success, otherwise an NFS status code is
485 * returned. Caller must release @fhp by calling fh_put in either
486 * case.
488 __be32
489 nfsd_setattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
490 struct nfsd_attrs *attr, const struct timespec64 *guardtime)
492 struct dentry *dentry;
493 struct inode *inode;
494 struct iattr *iap = attr->na_iattr;
495 int accmode = NFSD_MAY_SATTR;
496 umode_t ftype = 0;
497 __be32 err;
498 int host_err = 0;
499 bool get_write_count;
500 bool size_change = (iap->ia_valid & ATTR_SIZE);
501 int retries;
503 if (iap->ia_valid & ATTR_SIZE) {
504 accmode |= NFSD_MAY_WRITE|NFSD_MAY_OWNER_OVERRIDE;
505 ftype = S_IFREG;
509 * If utimes(2) and friends are called with times not NULL, we should
510 * not set NFSD_MAY_WRITE bit. Otherwise fh_verify->nfsd_permission
511 * will return EACCES, when the caller's effective UID does not match
512 * the owner of the file, and the caller is not privileged. In this
513 * situation, we should return EPERM(notify_change will return this).
515 if (iap->ia_valid & (ATTR_ATIME | ATTR_MTIME)) {
516 accmode |= NFSD_MAY_OWNER_OVERRIDE;
517 if (!(iap->ia_valid & (ATTR_ATIME_SET | ATTR_MTIME_SET)))
518 accmode |= NFSD_MAY_WRITE;
521 /* Callers that do fh_verify should do the fh_want_write: */
522 get_write_count = !fhp->fh_dentry;
524 /* Get inode */
525 err = fh_verify(rqstp, fhp, ftype, accmode);
526 if (err)
527 return err;
528 if (get_write_count) {
529 host_err = fh_want_write(fhp);
530 if (host_err)
531 goto out;
534 dentry = fhp->fh_dentry;
535 inode = d_inode(dentry);
537 nfsd_sanitize_attrs(inode, iap);
540 * The size case is special, it changes the file in addition to the
541 * attributes, and file systems don't expect it to be mixed with
542 * "random" attribute changes. We thus split out the size change
543 * into a separate call to ->setattr, and do the rest as a separate
544 * setattr call.
546 if (size_change) {
547 err = nfsd_get_write_access(rqstp, fhp, iap);
548 if (err)
549 return err;
552 inode_lock(inode);
553 err = fh_fill_pre_attrs(fhp);
554 if (err)
555 goto out_unlock;
557 if (guardtime) {
558 struct timespec64 ctime = inode_get_ctime(inode);
559 if ((u32)guardtime->tv_sec != (u32)ctime.tv_sec ||
560 guardtime->tv_nsec != ctime.tv_nsec) {
561 err = nfserr_notsync;
562 goto out_fill_attrs;
566 for (retries = 1;;) {
567 struct iattr attrs;
570 * notify_change() can alter its iattr argument, making
571 * @iap unsuitable for submission multiple times. Make a
572 * copy for every loop iteration.
574 attrs = *iap;
575 host_err = __nfsd_setattr(dentry, &attrs);
576 if (host_err != -EAGAIN || !retries--)
577 break;
578 if (!nfsd_wait_for_delegreturn(rqstp, inode))
579 break;
581 if (attr->na_seclabel && attr->na_seclabel->len)
582 attr->na_labelerr = security_inode_setsecctx(dentry,
583 attr->na_seclabel->data, attr->na_seclabel->len);
584 if (IS_ENABLED(CONFIG_FS_POSIX_ACL) && attr->na_pacl)
585 attr->na_aclerr = set_posix_acl(&nop_mnt_idmap,
586 dentry, ACL_TYPE_ACCESS,
587 attr->na_pacl);
588 if (IS_ENABLED(CONFIG_FS_POSIX_ACL) &&
589 !attr->na_aclerr && attr->na_dpacl && S_ISDIR(inode->i_mode))
590 attr->na_aclerr = set_posix_acl(&nop_mnt_idmap,
591 dentry, ACL_TYPE_DEFAULT,
592 attr->na_dpacl);
593 out_fill_attrs:
595 * RFC 1813 Section 3.3.2 does not mandate that an NFS server
596 * returns wcc_data for SETATTR. Some client implementations
597 * depend on receiving wcc_data, however, to sort out partial
598 * updates (eg., the client requested that size and mode be
599 * modified, but the server changed only the file mode).
601 fh_fill_post_attrs(fhp);
602 out_unlock:
603 inode_unlock(inode);
604 if (size_change)
605 put_write_access(inode);
606 out:
607 if (!host_err)
608 host_err = commit_metadata(fhp);
609 return err != 0 ? err : nfserrno(host_err);
612 #if defined(CONFIG_NFSD_V4)
614 * NFS junction information is stored in an extended attribute.
616 #define NFSD_JUNCTION_XATTR_NAME XATTR_TRUSTED_PREFIX "junction.nfs"
619 * nfsd4_is_junction - Test if an object could be an NFS junction
621 * @dentry: object to test
623 * Returns 1 if "dentry" appears to contain NFS junction information.
624 * Otherwise 0 is returned.
626 int nfsd4_is_junction(struct dentry *dentry)
628 struct inode *inode = d_inode(dentry);
630 if (inode == NULL)
631 return 0;
632 if (inode->i_mode & S_IXUGO)
633 return 0;
634 if (!(inode->i_mode & S_ISVTX))
635 return 0;
636 if (vfs_getxattr(&nop_mnt_idmap, dentry, NFSD_JUNCTION_XATTR_NAME,
637 NULL, 0) <= 0)
638 return 0;
639 return 1;
642 static struct nfsd4_compound_state *nfsd4_get_cstate(struct svc_rqst *rqstp)
644 return &((struct nfsd4_compoundres *)rqstp->rq_resp)->cstate;
647 __be32 nfsd4_clone_file_range(struct svc_rqst *rqstp,
648 struct nfsd_file *nf_src, u64 src_pos,
649 struct nfsd_file *nf_dst, u64 dst_pos,
650 u64 count, bool sync)
652 struct file *src = nf_src->nf_file;
653 struct file *dst = nf_dst->nf_file;
654 errseq_t since;
655 loff_t cloned;
656 __be32 ret = 0;
658 since = READ_ONCE(dst->f_wb_err);
659 cloned = vfs_clone_file_range(src, src_pos, dst, dst_pos, count, 0);
660 if (cloned < 0) {
661 ret = nfserrno(cloned);
662 goto out_err;
664 if (count && cloned != count) {
665 ret = nfserrno(-EINVAL);
666 goto out_err;
668 if (sync) {
669 loff_t dst_end = count ? dst_pos + count - 1 : LLONG_MAX;
670 int status = vfs_fsync_range(dst, dst_pos, dst_end, 0);
672 if (!status)
673 status = filemap_check_wb_err(dst->f_mapping, since);
674 if (!status)
675 status = commit_inode_metadata(file_inode(src));
676 if (status < 0) {
677 struct nfsd_net *nn = net_generic(nf_dst->nf_net,
678 nfsd_net_id);
680 trace_nfsd_clone_file_range_err(rqstp,
681 &nfsd4_get_cstate(rqstp)->save_fh,
682 src_pos,
683 &nfsd4_get_cstate(rqstp)->current_fh,
684 dst_pos,
685 count, status);
686 commit_reset_write_verifier(nn, rqstp, status);
687 ret = nfserrno(status);
690 out_err:
691 return ret;
694 ssize_t nfsd_copy_file_range(struct file *src, u64 src_pos, struct file *dst,
695 u64 dst_pos, u64 count)
697 ssize_t ret;
700 * Limit copy to 4MB to prevent indefinitely blocking an nfsd
701 * thread and client rpc slot. The choice of 4MB is somewhat
702 * arbitrary. We might instead base this on r/wsize, or make it
703 * tunable, or use a time instead of a byte limit, or implement
704 * asynchronous copy. In theory a client could also recognize a
705 * limit like this and pipeline multiple COPY requests.
707 count = min_t(u64, count, 1 << 22);
708 ret = vfs_copy_file_range(src, src_pos, dst, dst_pos, count, 0);
710 if (ret == -EOPNOTSUPP || ret == -EXDEV)
711 ret = vfs_copy_file_range(src, src_pos, dst, dst_pos, count,
712 COPY_FILE_SPLICE);
713 return ret;
716 __be32 nfsd4_vfs_fallocate(struct svc_rqst *rqstp, struct svc_fh *fhp,
717 struct file *file, loff_t offset, loff_t len,
718 int flags)
720 int error;
722 if (!S_ISREG(file_inode(file)->i_mode))
723 return nfserr_inval;
725 error = vfs_fallocate(file, flags, offset, len);
726 if (!error)
727 error = commit_metadata(fhp);
729 return nfserrno(error);
731 #endif /* defined(CONFIG_NFSD_V4) */
734 * Check server access rights to a file system object
736 struct accessmap {
737 u32 access;
738 int how;
740 static struct accessmap nfs3_regaccess[] = {
741 { NFS3_ACCESS_READ, NFSD_MAY_READ },
742 { NFS3_ACCESS_EXECUTE, NFSD_MAY_EXEC },
743 { NFS3_ACCESS_MODIFY, NFSD_MAY_WRITE|NFSD_MAY_TRUNC },
744 { NFS3_ACCESS_EXTEND, NFSD_MAY_WRITE },
746 #ifdef CONFIG_NFSD_V4
747 { NFS4_ACCESS_XAREAD, NFSD_MAY_READ },
748 { NFS4_ACCESS_XAWRITE, NFSD_MAY_WRITE },
749 { NFS4_ACCESS_XALIST, NFSD_MAY_READ },
750 #endif
752 { 0, 0 }
755 static struct accessmap nfs3_diraccess[] = {
756 { NFS3_ACCESS_READ, NFSD_MAY_READ },
757 { NFS3_ACCESS_LOOKUP, NFSD_MAY_EXEC },
758 { NFS3_ACCESS_MODIFY, NFSD_MAY_EXEC|NFSD_MAY_WRITE|NFSD_MAY_TRUNC},
759 { NFS3_ACCESS_EXTEND, NFSD_MAY_EXEC|NFSD_MAY_WRITE },
760 { NFS3_ACCESS_DELETE, NFSD_MAY_REMOVE },
762 #ifdef CONFIG_NFSD_V4
763 { NFS4_ACCESS_XAREAD, NFSD_MAY_READ },
764 { NFS4_ACCESS_XAWRITE, NFSD_MAY_WRITE },
765 { NFS4_ACCESS_XALIST, NFSD_MAY_READ },
766 #endif
768 { 0, 0 }
771 static struct accessmap nfs3_anyaccess[] = {
772 /* Some clients - Solaris 2.6 at least, make an access call
773 * to the server to check for access for things like /dev/null
774 * (which really, the server doesn't care about). So
775 * We provide simple access checking for them, looking
776 * mainly at mode bits, and we make sure to ignore read-only
777 * filesystem checks
779 { NFS3_ACCESS_READ, NFSD_MAY_READ },
780 { NFS3_ACCESS_EXECUTE, NFSD_MAY_EXEC },
781 { NFS3_ACCESS_MODIFY, NFSD_MAY_WRITE|NFSD_MAY_LOCAL_ACCESS },
782 { NFS3_ACCESS_EXTEND, NFSD_MAY_WRITE|NFSD_MAY_LOCAL_ACCESS },
784 { 0, 0 }
787 __be32
788 nfsd_access(struct svc_rqst *rqstp, struct svc_fh *fhp, u32 *access, u32 *supported)
790 struct accessmap *map;
791 struct svc_export *export;
792 struct dentry *dentry;
793 u32 query, result = 0, sresult = 0;
794 __be32 error;
796 error = fh_verify(rqstp, fhp, 0, NFSD_MAY_NOP);
797 if (error)
798 goto out;
800 export = fhp->fh_export;
801 dentry = fhp->fh_dentry;
803 if (d_is_reg(dentry))
804 map = nfs3_regaccess;
805 else if (d_is_dir(dentry))
806 map = nfs3_diraccess;
807 else
808 map = nfs3_anyaccess;
811 query = *access;
812 for (; map->access; map++) {
813 if (map->access & query) {
814 __be32 err2;
816 sresult |= map->access;
818 err2 = nfsd_permission(&rqstp->rq_cred, export,
819 dentry, map->how);
820 switch (err2) {
821 case nfs_ok:
822 result |= map->access;
823 break;
825 /* the following error codes just mean the access was not allowed,
826 * rather than an error occurred */
827 case nfserr_rofs:
828 case nfserr_acces:
829 case nfserr_perm:
830 /* simply don't "or" in the access bit. */
831 break;
832 default:
833 error = err2;
834 goto out;
838 *access = result;
839 if (supported)
840 *supported = sresult;
842 out:
843 return error;
846 int nfsd_open_break_lease(struct inode *inode, int access)
848 unsigned int mode;
850 if (access & NFSD_MAY_NOT_BREAK_LEASE)
851 return 0;
852 mode = (access & NFSD_MAY_WRITE) ? O_WRONLY : O_RDONLY;
853 return break_lease(inode, mode | O_NONBLOCK);
857 * Open an existing file or directory.
858 * The may_flags argument indicates the type of open (read/write/lock)
859 * and additional flags.
860 * N.B. After this call fhp needs an fh_put
862 static int
863 __nfsd_open(struct svc_fh *fhp, umode_t type, int may_flags, struct file **filp)
865 struct path path;
866 struct inode *inode;
867 struct file *file;
868 int flags = O_RDONLY|O_LARGEFILE;
869 int host_err = -EPERM;
871 path.mnt = fhp->fh_export->ex_path.mnt;
872 path.dentry = fhp->fh_dentry;
873 inode = d_inode(path.dentry);
875 if (IS_APPEND(inode) && (may_flags & NFSD_MAY_WRITE))
876 goto out;
878 if (!inode->i_fop)
879 goto out;
881 host_err = nfsd_open_break_lease(inode, may_flags);
882 if (host_err) /* NOMEM or WOULDBLOCK */
883 goto out;
885 if (may_flags & NFSD_MAY_WRITE) {
886 if (may_flags & NFSD_MAY_READ)
887 flags = O_RDWR|O_LARGEFILE;
888 else
889 flags = O_WRONLY|O_LARGEFILE;
892 file = dentry_open(&path, flags, current_cred());
893 if (IS_ERR(file)) {
894 host_err = PTR_ERR(file);
895 goto out;
898 host_err = security_file_post_open(file, may_flags);
899 if (host_err) {
900 fput(file);
901 goto out;
904 *filp = file;
905 out:
906 return host_err;
909 __be32
910 nfsd_open(struct svc_rqst *rqstp, struct svc_fh *fhp, umode_t type,
911 int may_flags, struct file **filp)
913 __be32 err;
914 int host_err;
915 bool retried = false;
918 * If we get here, then the client has already done an "open",
919 * and (hopefully) checked permission - so allow OWNER_OVERRIDE
920 * in case a chmod has now revoked permission.
922 * Arguably we should also allow the owner override for
923 * directories, but we never have and it doesn't seem to have
924 * caused anyone a problem. If we were to change this, note
925 * also that our filldir callbacks would need a variant of
926 * lookup_one_len that doesn't check permissions.
928 if (type == S_IFREG)
929 may_flags |= NFSD_MAY_OWNER_OVERRIDE;
930 retry:
931 err = fh_verify(rqstp, fhp, type, may_flags);
932 if (!err) {
933 host_err = __nfsd_open(fhp, type, may_flags, filp);
934 if (host_err == -EOPENSTALE && !retried) {
935 retried = true;
936 fh_put(fhp);
937 goto retry;
939 err = nfserrno(host_err);
941 return err;
945 * nfsd_open_verified - Open a regular file for the filecache
946 * @fhp: NFS filehandle of the file to open
947 * @may_flags: internal permission flags
948 * @filp: OUT: open "struct file *"
950 * Returns zero on success, or a negative errno value.
953 nfsd_open_verified(struct svc_fh *fhp, int may_flags, struct file **filp)
955 return __nfsd_open(fhp, S_IFREG, may_flags, filp);
959 * Grab and keep cached pages associated with a file in the svc_rqst
960 * so that they can be passed to the network sendmsg routines
961 * directly. They will be released after the sending has completed.
963 * Return values: Number of bytes consumed, or -EIO if there are no
964 * remaining pages in rqstp->rq_pages.
966 static int
967 nfsd_splice_actor(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
968 struct splice_desc *sd)
970 struct svc_rqst *rqstp = sd->u.data;
971 struct page *page = buf->page; // may be a compound one
972 unsigned offset = buf->offset;
973 struct page *last_page;
975 last_page = page + (offset + sd->len - 1) / PAGE_SIZE;
976 for (page += offset / PAGE_SIZE; page <= last_page; page++) {
978 * Skip page replacement when extending the contents of the
979 * current page. But note that we may get two zero_pages in a
980 * row from shmem.
982 if (page == *(rqstp->rq_next_page - 1) &&
983 offset_in_page(rqstp->rq_res.page_base +
984 rqstp->rq_res.page_len))
985 continue;
986 if (unlikely(!svc_rqst_replace_page(rqstp, page)))
987 return -EIO;
989 if (rqstp->rq_res.page_len == 0) // first call
990 rqstp->rq_res.page_base = offset % PAGE_SIZE;
991 rqstp->rq_res.page_len += sd->len;
992 return sd->len;
995 static int nfsd_direct_splice_actor(struct pipe_inode_info *pipe,
996 struct splice_desc *sd)
998 return __splice_from_pipe(pipe, sd, nfsd_splice_actor);
1001 static u32 nfsd_eof_on_read(struct file *file, loff_t offset, ssize_t len,
1002 size_t expected)
1004 if (expected != 0 && len == 0)
1005 return 1;
1006 if (offset+len >= i_size_read(file_inode(file)))
1007 return 1;
1008 return 0;
1011 static __be32 nfsd_finish_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
1012 struct file *file, loff_t offset,
1013 unsigned long *count, u32 *eof, ssize_t host_err)
1015 if (host_err >= 0) {
1016 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
1018 nfsd_stats_io_read_add(nn, fhp->fh_export, host_err);
1019 *eof = nfsd_eof_on_read(file, offset, host_err, *count);
1020 *count = host_err;
1021 fsnotify_access(file);
1022 trace_nfsd_read_io_done(rqstp, fhp, offset, *count);
1023 return 0;
1024 } else {
1025 trace_nfsd_read_err(rqstp, fhp, offset, host_err);
1026 return nfserrno(host_err);
1031 * nfsd_splice_read - Perform a VFS read using a splice pipe
1032 * @rqstp: RPC transaction context
1033 * @fhp: file handle of file to be read
1034 * @file: opened struct file of file to be read
1035 * @offset: starting byte offset
1036 * @count: IN: requested number of bytes; OUT: number of bytes read
1037 * @eof: OUT: set non-zero if operation reached the end of the file
1039 * Returns nfs_ok on success, otherwise an nfserr stat value is
1040 * returned.
1042 __be32 nfsd_splice_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
1043 struct file *file, loff_t offset, unsigned long *count,
1044 u32 *eof)
1046 struct splice_desc sd = {
1047 .len = 0,
1048 .total_len = *count,
1049 .pos = offset,
1050 .u.data = rqstp,
1052 ssize_t host_err;
1054 trace_nfsd_read_splice(rqstp, fhp, offset, *count);
1055 host_err = rw_verify_area(READ, file, &offset, *count);
1056 if (!host_err)
1057 host_err = splice_direct_to_actor(file, &sd,
1058 nfsd_direct_splice_actor);
1059 return nfsd_finish_read(rqstp, fhp, file, offset, count, eof, host_err);
1063 * nfsd_iter_read - Perform a VFS read using an iterator
1064 * @rqstp: RPC transaction context
1065 * @fhp: file handle of file to be read
1066 * @file: opened struct file of file to be read
1067 * @offset: starting byte offset
1068 * @count: IN: requested number of bytes; OUT: number of bytes read
1069 * @base: offset in first page of read buffer
1070 * @eof: OUT: set non-zero if operation reached the end of the file
1072 * Some filesystems or situations cannot use nfsd_splice_read. This
1073 * function is the slightly less-performant fallback for those cases.
1075 * Returns nfs_ok on success, otherwise an nfserr stat value is
1076 * returned.
1078 __be32 nfsd_iter_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
1079 struct file *file, loff_t offset, unsigned long *count,
1080 unsigned int base, u32 *eof)
1082 unsigned long v, total;
1083 struct iov_iter iter;
1084 loff_t ppos = offset;
1085 struct page *page;
1086 ssize_t host_err;
1088 v = 0;
1089 total = *count;
1090 while (total) {
1091 page = *(rqstp->rq_next_page++);
1092 rqstp->rq_vec[v].iov_base = page_address(page) + base;
1093 rqstp->rq_vec[v].iov_len = min_t(size_t, total, PAGE_SIZE - base);
1094 total -= rqstp->rq_vec[v].iov_len;
1095 ++v;
1096 base = 0;
1098 WARN_ON_ONCE(v > ARRAY_SIZE(rqstp->rq_vec));
1100 trace_nfsd_read_vector(rqstp, fhp, offset, *count);
1101 iov_iter_kvec(&iter, ITER_DEST, rqstp->rq_vec, v, *count);
1102 host_err = vfs_iter_read(file, &iter, &ppos, 0);
1103 return nfsd_finish_read(rqstp, fhp, file, offset, count, eof, host_err);
1107 * Gathered writes: If another process is currently writing to the file,
1108 * there's a high chance this is another nfsd (triggered by a bulk write
1109 * from a client's biod). Rather than syncing the file with each write
1110 * request, we sleep for 10 msec.
1112 * I don't know if this roughly approximates C. Juszak's idea of
1113 * gathered writes, but it's a nice and simple solution (IMHO), and it
1114 * seems to work:-)
1116 * Note: we do this only in the NFSv2 case, since v3 and higher have a
1117 * better tool (separate unstable writes and commits) for solving this
1118 * problem.
1120 static int wait_for_concurrent_writes(struct file *file)
1122 struct inode *inode = file_inode(file);
1123 static ino_t last_ino;
1124 static dev_t last_dev;
1125 int err = 0;
1127 if (atomic_read(&inode->i_writecount) > 1
1128 || (last_ino == inode->i_ino && last_dev == inode->i_sb->s_dev)) {
1129 dprintk("nfsd: write defer %d\n", task_pid_nr(current));
1130 msleep(10);
1131 dprintk("nfsd: write resume %d\n", task_pid_nr(current));
1134 if (inode->i_state & I_DIRTY) {
1135 dprintk("nfsd: write sync %d\n", task_pid_nr(current));
1136 err = vfs_fsync(file, 0);
1138 last_ino = inode->i_ino;
1139 last_dev = inode->i_sb->s_dev;
1140 return err;
1143 __be32
1144 nfsd_vfs_write(struct svc_rqst *rqstp, struct svc_fh *fhp, struct nfsd_file *nf,
1145 loff_t offset, struct kvec *vec, int vlen,
1146 unsigned long *cnt, int stable,
1147 __be32 *verf)
1149 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
1150 struct file *file = nf->nf_file;
1151 struct super_block *sb = file_inode(file)->i_sb;
1152 struct svc_export *exp;
1153 struct iov_iter iter;
1154 errseq_t since;
1155 __be32 nfserr;
1156 int host_err;
1157 loff_t pos = offset;
1158 unsigned long exp_op_flags = 0;
1159 unsigned int pflags = current->flags;
1160 rwf_t flags = 0;
1161 bool restore_flags = false;
1163 trace_nfsd_write_opened(rqstp, fhp, offset, *cnt);
1165 if (sb->s_export_op)
1166 exp_op_flags = sb->s_export_op->flags;
1168 if (test_bit(RQ_LOCAL, &rqstp->rq_flags) &&
1169 !(exp_op_flags & EXPORT_OP_REMOTE_FS)) {
1171 * We want throttling in balance_dirty_pages()
1172 * and shrink_inactive_list() to only consider
1173 * the backingdev we are writing to, so that nfs to
1174 * localhost doesn't cause nfsd to lock up due to all
1175 * the client's dirty pages or its congested queue.
1177 current->flags |= PF_LOCAL_THROTTLE;
1178 restore_flags = true;
1181 exp = fhp->fh_export;
1183 if (!EX_ISSYNC(exp))
1184 stable = NFS_UNSTABLE;
1186 if (stable && !fhp->fh_use_wgather)
1187 flags |= RWF_SYNC;
1189 iov_iter_kvec(&iter, ITER_SOURCE, vec, vlen, *cnt);
1190 since = READ_ONCE(file->f_wb_err);
1191 if (verf)
1192 nfsd_copy_write_verifier(verf, nn);
1193 host_err = vfs_iter_write(file, &iter, &pos, flags);
1194 if (host_err < 0) {
1195 commit_reset_write_verifier(nn, rqstp, host_err);
1196 goto out_nfserr;
1198 *cnt = host_err;
1199 nfsd_stats_io_write_add(nn, exp, *cnt);
1200 fsnotify_modify(file);
1201 host_err = filemap_check_wb_err(file->f_mapping, since);
1202 if (host_err < 0)
1203 goto out_nfserr;
1205 if (stable && fhp->fh_use_wgather) {
1206 host_err = wait_for_concurrent_writes(file);
1207 if (host_err < 0)
1208 commit_reset_write_verifier(nn, rqstp, host_err);
1211 out_nfserr:
1212 if (host_err >= 0) {
1213 trace_nfsd_write_io_done(rqstp, fhp, offset, *cnt);
1214 nfserr = nfs_ok;
1215 } else {
1216 trace_nfsd_write_err(rqstp, fhp, offset, host_err);
1217 nfserr = nfserrno(host_err);
1219 if (restore_flags)
1220 current_restore_flags(pflags, PF_LOCAL_THROTTLE);
1221 return nfserr;
1225 * nfsd_read_splice_ok - check if spliced reading is supported
1226 * @rqstp: RPC transaction context
1228 * Return values:
1229 * %true: nfsd_splice_read() may be used
1230 * %false: nfsd_splice_read() must not be used
1232 * NFS READ normally uses splice to send data in-place. However the
1233 * data in cache can change after the reply's MIC is computed but
1234 * before the RPC reply is sent. To prevent the client from
1235 * rejecting the server-computed MIC in this somewhat rare case, do
1236 * not use splice with the GSS integrity and privacy services.
1238 bool nfsd_read_splice_ok(struct svc_rqst *rqstp)
1240 switch (svc_auth_flavor(rqstp)) {
1241 case RPC_AUTH_GSS_KRB5I:
1242 case RPC_AUTH_GSS_KRB5P:
1243 return false;
1245 return true;
1249 * nfsd_read - Read data from a file
1250 * @rqstp: RPC transaction context
1251 * @fhp: file handle of file to be read
1252 * @offset: starting byte offset
1253 * @count: IN: requested number of bytes; OUT: number of bytes read
1254 * @eof: OUT: set non-zero if operation reached the end of the file
1256 * The caller must verify that there is enough space in @rqstp.rq_res
1257 * to perform this operation.
1259 * N.B. After this call fhp needs an fh_put
1261 * Returns nfs_ok on success, otherwise an nfserr stat value is
1262 * returned.
1264 __be32 nfsd_read(struct svc_rqst *rqstp, struct svc_fh *fhp,
1265 loff_t offset, unsigned long *count, u32 *eof)
1267 struct nfsd_file *nf;
1268 struct file *file;
1269 __be32 err;
1271 trace_nfsd_read_start(rqstp, fhp, offset, *count);
1272 err = nfsd_file_acquire_gc(rqstp, fhp, NFSD_MAY_READ, &nf);
1273 if (err)
1274 return err;
1276 file = nf->nf_file;
1277 if (file->f_op->splice_read && nfsd_read_splice_ok(rqstp))
1278 err = nfsd_splice_read(rqstp, fhp, file, offset, count, eof);
1279 else
1280 err = nfsd_iter_read(rqstp, fhp, file, offset, count, 0, eof);
1282 nfsd_file_put(nf);
1283 trace_nfsd_read_done(rqstp, fhp, offset, *count);
1284 return err;
1288 * Write data to a file.
1289 * The stable flag requests synchronous writes.
1290 * N.B. After this call fhp needs an fh_put
1292 __be32
1293 nfsd_write(struct svc_rqst *rqstp, struct svc_fh *fhp, loff_t offset,
1294 struct kvec *vec, int vlen, unsigned long *cnt, int stable,
1295 __be32 *verf)
1297 struct nfsd_file *nf;
1298 __be32 err;
1300 trace_nfsd_write_start(rqstp, fhp, offset, *cnt);
1302 err = nfsd_file_acquire_gc(rqstp, fhp, NFSD_MAY_WRITE, &nf);
1303 if (err)
1304 goto out;
1306 err = nfsd_vfs_write(rqstp, fhp, nf, offset, vec,
1307 vlen, cnt, stable, verf);
1308 nfsd_file_put(nf);
1309 out:
1310 trace_nfsd_write_done(rqstp, fhp, offset, *cnt);
1311 return err;
1315 * nfsd_commit - Commit pending writes to stable storage
1316 * @rqstp: RPC request being processed
1317 * @fhp: NFS filehandle
1318 * @nf: target file
1319 * @offset: raw offset from beginning of file
1320 * @count: raw count of bytes to sync
1321 * @verf: filled in with the server's current write verifier
1323 * Note: we guarantee that data that lies within the range specified
1324 * by the 'offset' and 'count' parameters will be synced. The server
1325 * is permitted to sync data that lies outside this range at the
1326 * same time.
1328 * Unfortunately we cannot lock the file to make sure we return full WCC
1329 * data to the client, as locking happens lower down in the filesystem.
1331 * Return values:
1332 * An nfsstat value in network byte order.
1334 __be32
1335 nfsd_commit(struct svc_rqst *rqstp, struct svc_fh *fhp, struct nfsd_file *nf,
1336 u64 offset, u32 count, __be32 *verf)
1338 __be32 err = nfs_ok;
1339 u64 maxbytes;
1340 loff_t start, end;
1341 struct nfsd_net *nn;
1344 * Convert the client-provided (offset, count) range to a
1345 * (start, end) range. If the client-provided range falls
1346 * outside the maximum file size of the underlying FS,
1347 * clamp the sync range appropriately.
1349 start = 0;
1350 end = LLONG_MAX;
1351 maxbytes = (u64)fhp->fh_dentry->d_sb->s_maxbytes;
1352 if (offset < maxbytes) {
1353 start = offset;
1354 if (count && (offset + count - 1 < maxbytes))
1355 end = offset + count - 1;
1358 nn = net_generic(nf->nf_net, nfsd_net_id);
1359 if (EX_ISSYNC(fhp->fh_export)) {
1360 errseq_t since = READ_ONCE(nf->nf_file->f_wb_err);
1361 int err2;
1363 err2 = vfs_fsync_range(nf->nf_file, start, end, 0);
1364 switch (err2) {
1365 case 0:
1366 nfsd_copy_write_verifier(verf, nn);
1367 err2 = filemap_check_wb_err(nf->nf_file->f_mapping,
1368 since);
1369 err = nfserrno(err2);
1370 break;
1371 case -EINVAL:
1372 err = nfserr_notsupp;
1373 break;
1374 default:
1375 commit_reset_write_verifier(nn, rqstp, err2);
1376 err = nfserrno(err2);
1378 } else
1379 nfsd_copy_write_verifier(verf, nn);
1381 return err;
1385 * nfsd_create_setattr - Set a created file's attributes
1386 * @rqstp: RPC transaction being executed
1387 * @fhp: NFS filehandle of parent directory
1388 * @resfhp: NFS filehandle of new object
1389 * @attrs: requested attributes of new object
1391 * Returns nfs_ok on success, or an nfsstat in network byte order.
1393 __be32
1394 nfsd_create_setattr(struct svc_rqst *rqstp, struct svc_fh *fhp,
1395 struct svc_fh *resfhp, struct nfsd_attrs *attrs)
1397 struct iattr *iap = attrs->na_iattr;
1398 __be32 status;
1401 * Mode has already been set by file creation.
1403 iap->ia_valid &= ~ATTR_MODE;
1406 * Setting uid/gid works only for root. Irix appears to
1407 * send along the gid on create when it tries to implement
1408 * setgid directories via NFS:
1410 if (!uid_eq(current_fsuid(), GLOBAL_ROOT_UID))
1411 iap->ia_valid &= ~(ATTR_UID|ATTR_GID);
1414 * Callers expect new file metadata to be committed even
1415 * if the attributes have not changed.
1417 if (nfsd_attrs_valid(attrs))
1418 status = nfsd_setattr(rqstp, resfhp, attrs, NULL);
1419 else
1420 status = nfserrno(commit_metadata(resfhp));
1423 * Transactional filesystems had a chance to commit changes
1424 * for both parent and child simultaneously making the
1425 * following commit_metadata a noop in many cases.
1427 if (!status)
1428 status = nfserrno(commit_metadata(fhp));
1431 * Update the new filehandle to pick up the new attributes.
1433 if (!status)
1434 status = fh_update(resfhp);
1436 return status;
1439 /* HPUX client sometimes creates a file in mode 000, and sets size to 0.
1440 * setting size to 0 may fail for some specific file systems by the permission
1441 * checking which requires WRITE permission but the mode is 000.
1442 * we ignore the resizing(to 0) on the just new created file, since the size is
1443 * 0 after file created.
1445 * call this only after vfs_create() is called.
1446 * */
1447 static void
1448 nfsd_check_ignore_resizing(struct iattr *iap)
1450 if ((iap->ia_valid & ATTR_SIZE) && (iap->ia_size == 0))
1451 iap->ia_valid &= ~ATTR_SIZE;
1454 /* The parent directory should already be locked: */
1455 __be32
1456 nfsd_create_locked(struct svc_rqst *rqstp, struct svc_fh *fhp,
1457 struct nfsd_attrs *attrs,
1458 int type, dev_t rdev, struct svc_fh *resfhp)
1460 struct dentry *dentry, *dchild;
1461 struct inode *dirp;
1462 struct iattr *iap = attrs->na_iattr;
1463 __be32 err;
1464 int host_err;
1466 dentry = fhp->fh_dentry;
1467 dirp = d_inode(dentry);
1469 dchild = dget(resfhp->fh_dentry);
1470 err = nfsd_permission(&rqstp->rq_cred, fhp->fh_export, dentry,
1471 NFSD_MAY_CREATE);
1472 if (err)
1473 goto out;
1475 if (!(iap->ia_valid & ATTR_MODE))
1476 iap->ia_mode = 0;
1477 iap->ia_mode = (iap->ia_mode & S_IALLUGO) | type;
1479 if (!IS_POSIXACL(dirp))
1480 iap->ia_mode &= ~current_umask();
1482 err = 0;
1483 switch (type) {
1484 case S_IFREG:
1485 host_err = vfs_create(&nop_mnt_idmap, dirp, dchild,
1486 iap->ia_mode, true);
1487 if (!host_err)
1488 nfsd_check_ignore_resizing(iap);
1489 break;
1490 case S_IFDIR:
1491 host_err = vfs_mkdir(&nop_mnt_idmap, dirp, dchild, iap->ia_mode);
1492 if (!host_err && unlikely(d_unhashed(dchild))) {
1493 struct dentry *d;
1494 d = lookup_one_len(dchild->d_name.name,
1495 dchild->d_parent,
1496 dchild->d_name.len);
1497 if (IS_ERR(d)) {
1498 host_err = PTR_ERR(d);
1499 break;
1501 if (unlikely(d_is_negative(d))) {
1502 dput(d);
1503 err = nfserr_serverfault;
1504 goto out;
1506 dput(resfhp->fh_dentry);
1507 resfhp->fh_dentry = dget(d);
1508 err = fh_update(resfhp);
1509 dput(dchild);
1510 dchild = d;
1511 if (err)
1512 goto out;
1514 break;
1515 case S_IFCHR:
1516 case S_IFBLK:
1517 case S_IFIFO:
1518 case S_IFSOCK:
1519 host_err = vfs_mknod(&nop_mnt_idmap, dirp, dchild,
1520 iap->ia_mode, rdev);
1521 break;
1522 default:
1523 printk(KERN_WARNING "nfsd: bad file type %o in nfsd_create\n",
1524 type);
1525 host_err = -EINVAL;
1527 if (host_err < 0)
1528 goto out_nfserr;
1530 err = nfsd_create_setattr(rqstp, fhp, resfhp, attrs);
1532 out:
1533 dput(dchild);
1534 return err;
1536 out_nfserr:
1537 err = nfserrno(host_err);
1538 goto out;
1542 * Create a filesystem object (regular, directory, special).
1543 * Note that the parent directory is left locked.
1545 * N.B. Every call to nfsd_create needs an fh_put for _both_ fhp and resfhp
1547 __be32
1548 nfsd_create(struct svc_rqst *rqstp, struct svc_fh *fhp,
1549 char *fname, int flen, struct nfsd_attrs *attrs,
1550 int type, dev_t rdev, struct svc_fh *resfhp)
1552 struct dentry *dentry, *dchild = NULL;
1553 __be32 err;
1554 int host_err;
1556 if (isdotent(fname, flen))
1557 return nfserr_exist;
1559 err = fh_verify(rqstp, fhp, S_IFDIR, NFSD_MAY_NOP);
1560 if (err)
1561 return err;
1563 dentry = fhp->fh_dentry;
1565 host_err = fh_want_write(fhp);
1566 if (host_err)
1567 return nfserrno(host_err);
1569 inode_lock_nested(dentry->d_inode, I_MUTEX_PARENT);
1570 dchild = lookup_one_len(fname, dentry, flen);
1571 host_err = PTR_ERR(dchild);
1572 if (IS_ERR(dchild)) {
1573 err = nfserrno(host_err);
1574 goto out_unlock;
1576 err = fh_compose(resfhp, fhp->fh_export, dchild, fhp);
1578 * We unconditionally drop our ref to dchild as fh_compose will have
1579 * already grabbed its own ref for it.
1581 dput(dchild);
1582 if (err)
1583 goto out_unlock;
1584 err = fh_fill_pre_attrs(fhp);
1585 if (err != nfs_ok)
1586 goto out_unlock;
1587 err = nfsd_create_locked(rqstp, fhp, attrs, type, rdev, resfhp);
1588 fh_fill_post_attrs(fhp);
1589 out_unlock:
1590 inode_unlock(dentry->d_inode);
1591 return err;
1595 * Read a symlink. On entry, *lenp must contain the maximum path length that
1596 * fits into the buffer. On return, it contains the true length.
1597 * N.B. After this call fhp needs an fh_put
1599 __be32
1600 nfsd_readlink(struct svc_rqst *rqstp, struct svc_fh *fhp, char *buf, int *lenp)
1602 __be32 err;
1603 const char *link;
1604 struct path path;
1605 DEFINE_DELAYED_CALL(done);
1606 int len;
1608 err = fh_verify(rqstp, fhp, S_IFLNK, NFSD_MAY_NOP);
1609 if (unlikely(err))
1610 return err;
1612 path.mnt = fhp->fh_export->ex_path.mnt;
1613 path.dentry = fhp->fh_dentry;
1615 if (unlikely(!d_is_symlink(path.dentry)))
1616 return nfserr_inval;
1618 touch_atime(&path);
1620 link = vfs_get_link(path.dentry, &done);
1621 if (IS_ERR(link))
1622 return nfserrno(PTR_ERR(link));
1624 len = strlen(link);
1625 if (len < *lenp)
1626 *lenp = len;
1627 memcpy(buf, link, *lenp);
1628 do_delayed_call(&done);
1629 return 0;
1633 * nfsd_symlink - Create a symlink and look up its inode
1634 * @rqstp: RPC transaction being executed
1635 * @fhp: NFS filehandle of parent directory
1636 * @fname: filename of the new symlink
1637 * @flen: length of @fname
1638 * @path: content of the new symlink (NUL-terminated)
1639 * @attrs: requested attributes of new object
1640 * @resfhp: NFS filehandle of new object
1642 * N.B. After this call _both_ fhp and resfhp need an fh_put
1644 * Returns nfs_ok on success, or an nfsstat in network byte order.
1646 __be32
1647 nfsd_symlink(struct svc_rqst *rqstp, struct svc_fh *fhp,
1648 char *fname, int flen,
1649 char *path, struct nfsd_attrs *attrs,
1650 struct svc_fh *resfhp)
1652 struct dentry *dentry, *dnew;
1653 __be32 err, cerr;
1654 int host_err;
1656 err = nfserr_noent;
1657 if (!flen || path[0] == '\0')
1658 goto out;
1659 err = nfserr_exist;
1660 if (isdotent(fname, flen))
1661 goto out;
1663 err = fh_verify(rqstp, fhp, S_IFDIR, NFSD_MAY_CREATE);
1664 if (err)
1665 goto out;
1667 host_err = fh_want_write(fhp);
1668 if (host_err) {
1669 err = nfserrno(host_err);
1670 goto out;
1673 dentry = fhp->fh_dentry;
1674 inode_lock_nested(dentry->d_inode, I_MUTEX_PARENT);
1675 dnew = lookup_one_len(fname, dentry, flen);
1676 if (IS_ERR(dnew)) {
1677 err = nfserrno(PTR_ERR(dnew));
1678 inode_unlock(dentry->d_inode);
1679 goto out_drop_write;
1681 err = fh_fill_pre_attrs(fhp);
1682 if (err != nfs_ok)
1683 goto out_unlock;
1684 host_err = vfs_symlink(&nop_mnt_idmap, d_inode(dentry), dnew, path);
1685 err = nfserrno(host_err);
1686 cerr = fh_compose(resfhp, fhp->fh_export, dnew, fhp);
1687 if (!err)
1688 nfsd_create_setattr(rqstp, fhp, resfhp, attrs);
1689 fh_fill_post_attrs(fhp);
1690 out_unlock:
1691 inode_unlock(dentry->d_inode);
1692 if (!err)
1693 err = nfserrno(commit_metadata(fhp));
1694 dput(dnew);
1695 if (err==0) err = cerr;
1696 out_drop_write:
1697 fh_drop_write(fhp);
1698 out:
1699 return err;
1703 * Create a hardlink
1704 * N.B. After this call _both_ ffhp and tfhp need an fh_put
1706 __be32
1707 nfsd_link(struct svc_rqst *rqstp, struct svc_fh *ffhp,
1708 char *name, int len, struct svc_fh *tfhp)
1710 struct dentry *ddir, *dnew, *dold;
1711 struct inode *dirp;
1712 __be32 err;
1713 int host_err;
1715 err = fh_verify(rqstp, ffhp, S_IFDIR, NFSD_MAY_CREATE);
1716 if (err)
1717 goto out;
1718 err = fh_verify(rqstp, tfhp, 0, NFSD_MAY_NOP);
1719 if (err)
1720 goto out;
1721 err = nfserr_isdir;
1722 if (d_is_dir(tfhp->fh_dentry))
1723 goto out;
1724 err = nfserr_perm;
1725 if (!len)
1726 goto out;
1727 err = nfserr_exist;
1728 if (isdotent(name, len))
1729 goto out;
1731 host_err = fh_want_write(tfhp);
1732 if (host_err) {
1733 err = nfserrno(host_err);
1734 goto out;
1737 ddir = ffhp->fh_dentry;
1738 dirp = d_inode(ddir);
1739 inode_lock_nested(dirp, I_MUTEX_PARENT);
1741 dnew = lookup_one_len(name, ddir, len);
1742 if (IS_ERR(dnew)) {
1743 err = nfserrno(PTR_ERR(dnew));
1744 goto out_unlock;
1747 dold = tfhp->fh_dentry;
1749 err = nfserr_noent;
1750 if (d_really_is_negative(dold))
1751 goto out_dput;
1752 err = fh_fill_pre_attrs(ffhp);
1753 if (err != nfs_ok)
1754 goto out_dput;
1755 host_err = vfs_link(dold, &nop_mnt_idmap, dirp, dnew, NULL);
1756 fh_fill_post_attrs(ffhp);
1757 inode_unlock(dirp);
1758 if (!host_err) {
1759 err = nfserrno(commit_metadata(ffhp));
1760 if (!err)
1761 err = nfserrno(commit_metadata(tfhp));
1762 } else {
1763 err = nfserrno(host_err);
1765 dput(dnew);
1766 out_drop_write:
1767 fh_drop_write(tfhp);
1768 out:
1769 return err;
1771 out_dput:
1772 dput(dnew);
1773 out_unlock:
1774 inode_unlock(dirp);
1775 goto out_drop_write;
1778 static void
1779 nfsd_close_cached_files(struct dentry *dentry)
1781 struct inode *inode = d_inode(dentry);
1783 if (inode && S_ISREG(inode->i_mode))
1784 nfsd_file_close_inode_sync(inode);
1787 static bool
1788 nfsd_has_cached_files(struct dentry *dentry)
1790 bool ret = false;
1791 struct inode *inode = d_inode(dentry);
1793 if (inode && S_ISREG(inode->i_mode))
1794 ret = nfsd_file_is_cached(inode);
1795 return ret;
1799 * Rename a file
1800 * N.B. After this call _both_ ffhp and tfhp need an fh_put
1802 __be32
1803 nfsd_rename(struct svc_rqst *rqstp, struct svc_fh *ffhp, char *fname, int flen,
1804 struct svc_fh *tfhp, char *tname, int tlen)
1806 struct dentry *fdentry, *tdentry, *odentry, *ndentry, *trap;
1807 struct inode *fdir, *tdir;
1808 __be32 err;
1809 int host_err;
1810 bool close_cached = false;
1812 err = fh_verify(rqstp, ffhp, S_IFDIR, NFSD_MAY_REMOVE);
1813 if (err)
1814 goto out;
1815 err = fh_verify(rqstp, tfhp, S_IFDIR, NFSD_MAY_CREATE);
1816 if (err)
1817 goto out;
1819 fdentry = ffhp->fh_dentry;
1820 fdir = d_inode(fdentry);
1822 tdentry = tfhp->fh_dentry;
1823 tdir = d_inode(tdentry);
1825 err = nfserr_perm;
1826 if (!flen || isdotent(fname, flen) || !tlen || isdotent(tname, tlen))
1827 goto out;
1829 err = nfserr_xdev;
1830 if (ffhp->fh_export->ex_path.mnt != tfhp->fh_export->ex_path.mnt)
1831 goto out;
1832 if (ffhp->fh_export->ex_path.dentry != tfhp->fh_export->ex_path.dentry)
1833 goto out;
1835 retry:
1836 host_err = fh_want_write(ffhp);
1837 if (host_err) {
1838 err = nfserrno(host_err);
1839 goto out;
1842 trap = lock_rename(tdentry, fdentry);
1843 if (IS_ERR(trap)) {
1844 err = nfserr_xdev;
1845 goto out_want_write;
1847 err = fh_fill_pre_attrs(ffhp);
1848 if (err != nfs_ok)
1849 goto out_unlock;
1850 err = fh_fill_pre_attrs(tfhp);
1851 if (err != nfs_ok)
1852 goto out_unlock;
1854 odentry = lookup_one_len(fname, fdentry, flen);
1855 host_err = PTR_ERR(odentry);
1856 if (IS_ERR(odentry))
1857 goto out_nfserr;
1859 host_err = -ENOENT;
1860 if (d_really_is_negative(odentry))
1861 goto out_dput_old;
1862 host_err = -EINVAL;
1863 if (odentry == trap)
1864 goto out_dput_old;
1866 ndentry = lookup_one_len(tname, tdentry, tlen);
1867 host_err = PTR_ERR(ndentry);
1868 if (IS_ERR(ndentry))
1869 goto out_dput_old;
1870 host_err = -ENOTEMPTY;
1871 if (ndentry == trap)
1872 goto out_dput_new;
1874 if ((ndentry->d_sb->s_export_op->flags & EXPORT_OP_CLOSE_BEFORE_UNLINK) &&
1875 nfsd_has_cached_files(ndentry)) {
1876 close_cached = true;
1877 goto out_dput_old;
1878 } else {
1879 struct renamedata rd = {
1880 .old_mnt_idmap = &nop_mnt_idmap,
1881 .old_dir = fdir,
1882 .old_dentry = odentry,
1883 .new_mnt_idmap = &nop_mnt_idmap,
1884 .new_dir = tdir,
1885 .new_dentry = ndentry,
1887 int retries;
1889 for (retries = 1;;) {
1890 host_err = vfs_rename(&rd);
1891 if (host_err != -EAGAIN || !retries--)
1892 break;
1893 if (!nfsd_wait_for_delegreturn(rqstp, d_inode(odentry)))
1894 break;
1896 if (!host_err) {
1897 host_err = commit_metadata(tfhp);
1898 if (!host_err)
1899 host_err = commit_metadata(ffhp);
1902 out_dput_new:
1903 dput(ndentry);
1904 out_dput_old:
1905 dput(odentry);
1906 out_nfserr:
1907 err = nfserrno(host_err);
1909 if (!close_cached) {
1910 fh_fill_post_attrs(ffhp);
1911 fh_fill_post_attrs(tfhp);
1913 out_unlock:
1914 unlock_rename(tdentry, fdentry);
1915 out_want_write:
1916 fh_drop_write(ffhp);
1919 * If the target dentry has cached open files, then we need to
1920 * try to close them prior to doing the rename. Final fput
1921 * shouldn't be done with locks held however, so we delay it
1922 * until this point and then reattempt the whole shebang.
1924 if (close_cached) {
1925 close_cached = false;
1926 nfsd_close_cached_files(ndentry);
1927 dput(ndentry);
1928 goto retry;
1930 out:
1931 return err;
1935 * Unlink a file or directory
1936 * N.B. After this call fhp needs an fh_put
1938 __be32
1939 nfsd_unlink(struct svc_rqst *rqstp, struct svc_fh *fhp, int type,
1940 char *fname, int flen)
1942 struct dentry *dentry, *rdentry;
1943 struct inode *dirp;
1944 struct inode *rinode;
1945 __be32 err;
1946 int host_err;
1948 err = nfserr_acces;
1949 if (!flen || isdotent(fname, flen))
1950 goto out;
1951 err = fh_verify(rqstp, fhp, S_IFDIR, NFSD_MAY_REMOVE);
1952 if (err)
1953 goto out;
1955 host_err = fh_want_write(fhp);
1956 if (host_err)
1957 goto out_nfserr;
1959 dentry = fhp->fh_dentry;
1960 dirp = d_inode(dentry);
1961 inode_lock_nested(dirp, I_MUTEX_PARENT);
1963 rdentry = lookup_one_len(fname, dentry, flen);
1964 host_err = PTR_ERR(rdentry);
1965 if (IS_ERR(rdentry))
1966 goto out_unlock;
1968 if (d_really_is_negative(rdentry)) {
1969 dput(rdentry);
1970 host_err = -ENOENT;
1971 goto out_unlock;
1973 rinode = d_inode(rdentry);
1974 err = fh_fill_pre_attrs(fhp);
1975 if (err != nfs_ok)
1976 goto out_unlock;
1978 ihold(rinode);
1979 if (!type)
1980 type = d_inode(rdentry)->i_mode & S_IFMT;
1982 if (type != S_IFDIR) {
1983 int retries;
1985 if (rdentry->d_sb->s_export_op->flags & EXPORT_OP_CLOSE_BEFORE_UNLINK)
1986 nfsd_close_cached_files(rdentry);
1988 for (retries = 1;;) {
1989 host_err = vfs_unlink(&nop_mnt_idmap, dirp, rdentry, NULL);
1990 if (host_err != -EAGAIN || !retries--)
1991 break;
1992 if (!nfsd_wait_for_delegreturn(rqstp, rinode))
1993 break;
1995 } else {
1996 host_err = vfs_rmdir(&nop_mnt_idmap, dirp, rdentry);
1998 fh_fill_post_attrs(fhp);
2000 inode_unlock(dirp);
2001 if (!host_err)
2002 host_err = commit_metadata(fhp);
2003 dput(rdentry);
2004 iput(rinode); /* truncate the inode here */
2006 out_drop_write:
2007 fh_drop_write(fhp);
2008 out_nfserr:
2009 if (host_err == -EBUSY) {
2010 /* name is mounted-on. There is no perfect
2011 * error status.
2013 err = nfserr_file_open;
2014 } else {
2015 err = nfserrno(host_err);
2017 out:
2018 return err;
2019 out_unlock:
2020 inode_unlock(dirp);
2021 goto out_drop_write;
2025 * We do this buffering because we must not call back into the file
2026 * system's ->lookup() method from the filldir callback. That may well
2027 * deadlock a number of file systems.
2029 * This is based heavily on the implementation of same in XFS.
2031 struct buffered_dirent {
2032 u64 ino;
2033 loff_t offset;
2034 int namlen;
2035 unsigned int d_type;
2036 char name[];
2039 struct readdir_data {
2040 struct dir_context ctx;
2041 char *dirent;
2042 size_t used;
2043 int full;
2046 static bool nfsd_buffered_filldir(struct dir_context *ctx, const char *name,
2047 int namlen, loff_t offset, u64 ino,
2048 unsigned int d_type)
2050 struct readdir_data *buf =
2051 container_of(ctx, struct readdir_data, ctx);
2052 struct buffered_dirent *de = (void *)(buf->dirent + buf->used);
2053 unsigned int reclen;
2055 reclen = ALIGN(sizeof(struct buffered_dirent) + namlen, sizeof(u64));
2056 if (buf->used + reclen > PAGE_SIZE) {
2057 buf->full = 1;
2058 return false;
2061 de->namlen = namlen;
2062 de->offset = offset;
2063 de->ino = ino;
2064 de->d_type = d_type;
2065 memcpy(de->name, name, namlen);
2066 buf->used += reclen;
2068 return true;
2071 static __be32 nfsd_buffered_readdir(struct file *file, struct svc_fh *fhp,
2072 nfsd_filldir_t func, struct readdir_cd *cdp,
2073 loff_t *offsetp)
2075 struct buffered_dirent *de;
2076 int host_err;
2077 int size;
2078 loff_t offset;
2079 struct readdir_data buf = {
2080 .ctx.actor = nfsd_buffered_filldir,
2081 .dirent = (void *)__get_free_page(GFP_KERNEL)
2084 if (!buf.dirent)
2085 return nfserrno(-ENOMEM);
2087 offset = *offsetp;
2089 while (1) {
2090 unsigned int reclen;
2092 cdp->err = nfserr_eof; /* will be cleared on successful read */
2093 buf.used = 0;
2094 buf.full = 0;
2096 host_err = iterate_dir(file, &buf.ctx);
2097 if (buf.full)
2098 host_err = 0;
2100 if (host_err < 0)
2101 break;
2103 size = buf.used;
2105 if (!size)
2106 break;
2108 de = (struct buffered_dirent *)buf.dirent;
2109 while (size > 0) {
2110 offset = de->offset;
2112 if (func(cdp, de->name, de->namlen, de->offset,
2113 de->ino, de->d_type))
2114 break;
2116 if (cdp->err != nfs_ok)
2117 break;
2119 trace_nfsd_dirent(fhp, de->ino, de->name, de->namlen);
2121 reclen = ALIGN(sizeof(*de) + de->namlen,
2122 sizeof(u64));
2123 size -= reclen;
2124 de = (struct buffered_dirent *)((char *)de + reclen);
2126 if (size > 0) /* We bailed out early */
2127 break;
2129 offset = vfs_llseek(file, 0, SEEK_CUR);
2132 free_page((unsigned long)(buf.dirent));
2134 if (host_err)
2135 return nfserrno(host_err);
2137 *offsetp = offset;
2138 return cdp->err;
2142 * nfsd_readdir - Read entries from a directory
2143 * @rqstp: RPC transaction context
2144 * @fhp: NFS file handle of directory to be read
2145 * @offsetp: OUT: seek offset of final entry that was read
2146 * @cdp: OUT: an eof error value
2147 * @func: entry filler actor
2149 * This implementation ignores the NFSv3/4 verifier cookie.
2151 * NB: normal system calls hold file->f_pos_lock when calling
2152 * ->iterate_shared and ->llseek, but nfsd_readdir() does not.
2153 * Because the struct file acquired here is not visible to other
2154 * threads, it's internal state does not need mutex protection.
2156 * Returns nfs_ok on success, otherwise an nfsstat code is
2157 * returned.
2159 __be32
2160 nfsd_readdir(struct svc_rqst *rqstp, struct svc_fh *fhp, loff_t *offsetp,
2161 struct readdir_cd *cdp, nfsd_filldir_t func)
2163 __be32 err;
2164 struct file *file;
2165 loff_t offset = *offsetp;
2166 int may_flags = NFSD_MAY_READ;
2168 err = nfsd_open(rqstp, fhp, S_IFDIR, may_flags, &file);
2169 if (err)
2170 goto out;
2172 if (fhp->fh_64bit_cookies)
2173 file->f_mode |= FMODE_64BITHASH;
2174 else
2175 file->f_mode |= FMODE_32BITHASH;
2177 offset = vfs_llseek(file, offset, SEEK_SET);
2178 if (offset < 0) {
2179 err = nfserrno((int)offset);
2180 goto out_close;
2183 err = nfsd_buffered_readdir(file, fhp, func, cdp, offsetp);
2185 if (err == nfserr_eof || err == nfserr_toosmall)
2186 err = nfs_ok; /* can still be found in ->err */
2187 out_close:
2188 nfsd_filp_close(file);
2189 out:
2190 return err;
2194 * nfsd_filp_close: close a file synchronously
2195 * @fp: the file to close
2197 * nfsd_filp_close() is similar in behaviour to filp_close().
2198 * The difference is that if this is the final close on the
2199 * file, the that finalisation happens immediately, rather then
2200 * being handed over to a work_queue, as it the case for
2201 * filp_close().
2202 * When a user-space process closes a file (even when using
2203 * filp_close() the finalisation happens before returning to
2204 * userspace, so it is effectively synchronous. When a kernel thread
2205 * uses file_close(), on the other hand, the handling is completely
2206 * asynchronous. This means that any cost imposed by that finalisation
2207 * is not imposed on the nfsd thread, and nfsd could potentually
2208 * close files more quickly than the work queue finalises the close,
2209 * which would lead to unbounded growth in the queue.
2211 * In some contexts is it not safe to synchronously wait for
2212 * close finalisation (see comment for __fput_sync()), but nfsd
2213 * does not match those contexts. In partcilarly it does not, at the
2214 * time that this function is called, hold and locks and no finalisation
2215 * of any file, socket, or device driver would have any cause to wait
2216 * for nfsd to make progress.
2218 void nfsd_filp_close(struct file *fp)
2220 get_file(fp);
2221 filp_close(fp, NULL);
2222 __fput_sync(fp);
2226 * Get file system stats
2227 * N.B. After this call fhp needs an fh_put
2229 __be32
2230 nfsd_statfs(struct svc_rqst *rqstp, struct svc_fh *fhp, struct kstatfs *stat, int access)
2232 __be32 err;
2234 err = fh_verify(rqstp, fhp, 0, NFSD_MAY_NOP | access);
2235 if (!err) {
2236 struct path path = {
2237 .mnt = fhp->fh_export->ex_path.mnt,
2238 .dentry = fhp->fh_dentry,
2240 if (vfs_statfs(&path, stat))
2241 err = nfserr_io;
2243 return err;
2246 static int exp_rdonly(struct svc_cred *cred, struct svc_export *exp)
2248 return nfsexp_flags(cred, exp) & NFSEXP_READONLY;
2251 #ifdef CONFIG_NFSD_V4
2253 * Helper function to translate error numbers. In the case of xattr operations,
2254 * some error codes need to be translated outside of the standard translations.
2256 * ENODATA needs to be translated to nfserr_noxattr.
2257 * E2BIG to nfserr_xattr2big.
2259 * Additionally, vfs_listxattr can return -ERANGE. This means that the
2260 * file has too many extended attributes to retrieve inside an
2261 * XATTR_LIST_MAX sized buffer. This is a bug in the xattr implementation:
2262 * filesystems will allow the adding of extended attributes until they hit
2263 * their own internal limit. This limit may be larger than XATTR_LIST_MAX.
2264 * So, at that point, the attributes are present and valid, but can't
2265 * be retrieved using listxattr, since the upper level xattr code enforces
2266 * the XATTR_LIST_MAX limit.
2268 * This bug means that we need to deal with listxattr returning -ERANGE. The
2269 * best mapping is to return TOOSMALL.
2271 static __be32
2272 nfsd_xattr_errno(int err)
2274 switch (err) {
2275 case -ENODATA:
2276 return nfserr_noxattr;
2277 case -E2BIG:
2278 return nfserr_xattr2big;
2279 case -ERANGE:
2280 return nfserr_toosmall;
2282 return nfserrno(err);
2286 * Retrieve the specified user extended attribute. To avoid always
2287 * having to allocate the maximum size (since we are not getting
2288 * a maximum size from the RPC), do a probe + alloc. Hold a reader
2289 * lock on i_rwsem to prevent the extended attribute from changing
2290 * size while we're doing this.
2292 __be32
2293 nfsd_getxattr(struct svc_rqst *rqstp, struct svc_fh *fhp, char *name,
2294 void **bufp, int *lenp)
2296 ssize_t len;
2297 __be32 err;
2298 char *buf;
2299 struct inode *inode;
2300 struct dentry *dentry;
2302 err = fh_verify(rqstp, fhp, 0, NFSD_MAY_READ);
2303 if (err)
2304 return err;
2306 err = nfs_ok;
2307 dentry = fhp->fh_dentry;
2308 inode = d_inode(dentry);
2310 inode_lock_shared(inode);
2312 len = vfs_getxattr(&nop_mnt_idmap, dentry, name, NULL, 0);
2315 * Zero-length attribute, just return.
2317 if (len == 0) {
2318 *bufp = NULL;
2319 *lenp = 0;
2320 goto out;
2323 if (len < 0) {
2324 err = nfsd_xattr_errno(len);
2325 goto out;
2328 if (len > *lenp) {
2329 err = nfserr_toosmall;
2330 goto out;
2333 buf = kvmalloc(len, GFP_KERNEL);
2334 if (buf == NULL) {
2335 err = nfserr_jukebox;
2336 goto out;
2339 len = vfs_getxattr(&nop_mnt_idmap, dentry, name, buf, len);
2340 if (len <= 0) {
2341 kvfree(buf);
2342 buf = NULL;
2343 err = nfsd_xattr_errno(len);
2346 *lenp = len;
2347 *bufp = buf;
2349 out:
2350 inode_unlock_shared(inode);
2352 return err;
2356 * Retrieve the xattr names. Since we can't know how many are
2357 * user extended attributes, we must get all attributes here,
2358 * and have the XDR encode filter out the "user." ones.
2360 * While this could always just allocate an XATTR_LIST_MAX
2361 * buffer, that's a waste, so do a probe + allocate. To
2362 * avoid any changes between the probe and allocate, wrap
2363 * this in inode_lock.
2365 __be32
2366 nfsd_listxattr(struct svc_rqst *rqstp, struct svc_fh *fhp, char **bufp,
2367 int *lenp)
2369 ssize_t len;
2370 __be32 err;
2371 char *buf;
2372 struct inode *inode;
2373 struct dentry *dentry;
2375 err = fh_verify(rqstp, fhp, 0, NFSD_MAY_READ);
2376 if (err)
2377 return err;
2379 dentry = fhp->fh_dentry;
2380 inode = d_inode(dentry);
2381 *lenp = 0;
2383 inode_lock_shared(inode);
2385 len = vfs_listxattr(dentry, NULL, 0);
2386 if (len <= 0) {
2387 err = nfsd_xattr_errno(len);
2388 goto out;
2391 if (len > XATTR_LIST_MAX) {
2392 err = nfserr_xattr2big;
2393 goto out;
2396 buf = kvmalloc(len, GFP_KERNEL);
2397 if (buf == NULL) {
2398 err = nfserr_jukebox;
2399 goto out;
2402 len = vfs_listxattr(dentry, buf, len);
2403 if (len <= 0) {
2404 kvfree(buf);
2405 err = nfsd_xattr_errno(len);
2406 goto out;
2409 *lenp = len;
2410 *bufp = buf;
2412 err = nfs_ok;
2413 out:
2414 inode_unlock_shared(inode);
2416 return err;
2420 * nfsd_removexattr - Remove an extended attribute
2421 * @rqstp: RPC transaction being executed
2422 * @fhp: NFS filehandle of object with xattr to remove
2423 * @name: name of xattr to remove (NUL-terminate)
2425 * Pass in a NULL pointer for delegated_inode, and let the client deal
2426 * with NFS4ERR_DELAY (same as with e.g. setattr and remove).
2428 * Returns nfs_ok on success, or an nfsstat in network byte order.
2430 __be32
2431 nfsd_removexattr(struct svc_rqst *rqstp, struct svc_fh *fhp, char *name)
2433 __be32 err;
2434 int ret;
2436 err = fh_verify(rqstp, fhp, 0, NFSD_MAY_WRITE);
2437 if (err)
2438 return err;
2440 ret = fh_want_write(fhp);
2441 if (ret)
2442 return nfserrno(ret);
2444 inode_lock(fhp->fh_dentry->d_inode);
2445 err = fh_fill_pre_attrs(fhp);
2446 if (err != nfs_ok)
2447 goto out_unlock;
2448 ret = __vfs_removexattr_locked(&nop_mnt_idmap, fhp->fh_dentry,
2449 name, NULL);
2450 err = nfsd_xattr_errno(ret);
2451 fh_fill_post_attrs(fhp);
2452 out_unlock:
2453 inode_unlock(fhp->fh_dentry->d_inode);
2454 fh_drop_write(fhp);
2456 return err;
2459 __be32
2460 nfsd_setxattr(struct svc_rqst *rqstp, struct svc_fh *fhp, char *name,
2461 void *buf, u32 len, u32 flags)
2463 __be32 err;
2464 int ret;
2466 err = fh_verify(rqstp, fhp, 0, NFSD_MAY_WRITE);
2467 if (err)
2468 return err;
2470 ret = fh_want_write(fhp);
2471 if (ret)
2472 return nfserrno(ret);
2473 inode_lock(fhp->fh_dentry->d_inode);
2474 err = fh_fill_pre_attrs(fhp);
2475 if (err != nfs_ok)
2476 goto out_unlock;
2477 ret = __vfs_setxattr_locked(&nop_mnt_idmap, fhp->fh_dentry,
2478 name, buf, len, flags, NULL);
2479 fh_fill_post_attrs(fhp);
2480 err = nfsd_xattr_errno(ret);
2481 out_unlock:
2482 inode_unlock(fhp->fh_dentry->d_inode);
2483 fh_drop_write(fhp);
2484 return err;
2486 #endif
2489 * Check for a user's access permissions to this inode.
2491 __be32
2492 nfsd_permission(struct svc_cred *cred, struct svc_export *exp,
2493 struct dentry *dentry, int acc)
2495 struct inode *inode = d_inode(dentry);
2496 int err;
2498 if ((acc & NFSD_MAY_MASK) == NFSD_MAY_NOP)
2499 return 0;
2500 #if 0
2501 dprintk("nfsd: permission 0x%x%s%s%s%s%s%s%s mode 0%o%s%s%s\n",
2502 acc,
2503 (acc & NFSD_MAY_READ)? " read" : "",
2504 (acc & NFSD_MAY_WRITE)? " write" : "",
2505 (acc & NFSD_MAY_EXEC)? " exec" : "",
2506 (acc & NFSD_MAY_SATTR)? " sattr" : "",
2507 (acc & NFSD_MAY_TRUNC)? " trunc" : "",
2508 (acc & NFSD_MAY_NLM)? " nlm" : "",
2509 (acc & NFSD_MAY_OWNER_OVERRIDE)? " owneroverride" : "",
2510 inode->i_mode,
2511 IS_IMMUTABLE(inode)? " immut" : "",
2512 IS_APPEND(inode)? " append" : "",
2513 __mnt_is_readonly(exp->ex_path.mnt)? " ro" : "");
2514 dprintk(" owner %d/%d user %d/%d\n",
2515 inode->i_uid, inode->i_gid, current_fsuid(), current_fsgid());
2516 #endif
2518 /* Normally we reject any write/sattr etc access on a read-only file
2519 * system. But if it is IRIX doing check on write-access for a
2520 * device special file, we ignore rofs.
2522 if (!(acc & NFSD_MAY_LOCAL_ACCESS))
2523 if (acc & (NFSD_MAY_WRITE | NFSD_MAY_SATTR | NFSD_MAY_TRUNC)) {
2524 if (exp_rdonly(cred, exp) ||
2525 __mnt_is_readonly(exp->ex_path.mnt))
2526 return nfserr_rofs;
2527 if (/* (acc & NFSD_MAY_WRITE) && */ IS_IMMUTABLE(inode))
2528 return nfserr_perm;
2530 if ((acc & NFSD_MAY_TRUNC) && IS_APPEND(inode))
2531 return nfserr_perm;
2534 * The file owner always gets access permission for accesses that
2535 * would normally be checked at open time. This is to make
2536 * file access work even when the client has done a fchmod(fd, 0).
2538 * However, `cp foo bar' should fail nevertheless when bar is
2539 * readonly. A sensible way to do this might be to reject all
2540 * attempts to truncate a read-only file, because a creat() call
2541 * always implies file truncation.
2542 * ... but this isn't really fair. A process may reasonably call
2543 * ftruncate on an open file descriptor on a file with perm 000.
2544 * We must trust the client to do permission checking - using "ACCESS"
2545 * with NFSv3.
2547 if ((acc & NFSD_MAY_OWNER_OVERRIDE) &&
2548 uid_eq(inode->i_uid, current_fsuid()))
2549 return 0;
2551 /* This assumes NFSD_MAY_{READ,WRITE,EXEC} == MAY_{READ,WRITE,EXEC} */
2552 err = inode_permission(&nop_mnt_idmap, inode,
2553 acc & (MAY_READ | MAY_WRITE | MAY_EXEC));
2555 /* Allow read access to binaries even when mode 111 */
2556 if (err == -EACCES && S_ISREG(inode->i_mode) &&
2557 (acc == (NFSD_MAY_READ | NFSD_MAY_OWNER_OVERRIDE) ||
2558 acc == (NFSD_MAY_READ | NFSD_MAY_READ_IF_EXEC)))
2559 err = inode_permission(&nop_mnt_idmap, inode, MAY_EXEC);
2561 return err? nfserrno(err) : 0;