4 * Server-side procedures for NFSv4.
6 * Copyright (c) 2002 The Regents of the University of Michigan.
9 * Kendrick Smith <kmsmith@umich.edu>
10 * Andy Adamson <andros@umich.edu>
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its
22 * contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
26 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
27 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #include <linux/param.h>
39 #include <linux/major.h>
40 #include <linux/slab.h>
41 #include <linux/file.h>
43 #include <linux/sunrpc/svc.h>
44 #include <linux/nfsd/nfsd.h>
45 #include <linux/nfsd/cache.h>
46 #include <linux/nfs4.h>
47 #include <linux/nfsd/state.h>
48 #include <linux/nfsd/xdr4.h>
49 #include <linux/nfs4_acl.h>
50 #include <linux/sunrpc/gss_api.h>
52 #define NFSDDBG_FACILITY NFSDDBG_PROC
54 static u32 nfsd_attrmask[] = {
55 NFSD_WRITEABLE_ATTRS_WORD0,
56 NFSD_WRITEABLE_ATTRS_WORD1,
57 NFSD_WRITEABLE_ATTRS_WORD2
60 static u32 nfsd41_ex_attrmask[] = {
61 NFSD_SUPPATTR_EXCLCREAT_WORD0,
62 NFSD_SUPPATTR_EXCLCREAT_WORD1,
63 NFSD_SUPPATTR_EXCLCREAT_WORD2
67 check_attr_support(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
68 u32 *bmval, u32 *writable)
70 struct dentry *dentry = cstate->current_fh.fh_dentry;
71 struct svc_export *exp = cstate->current_fh.fh_export;
74 * Check about attributes are supported by the NFSv4 server or not.
75 * According to spec, unsupported attributes return ERR_ATTRNOTSUPP.
77 if ((bmval[0] & ~nfsd_suppattrs0(cstate->minorversion)) ||
78 (bmval[1] & ~nfsd_suppattrs1(cstate->minorversion)) ||
79 (bmval[2] & ~nfsd_suppattrs2(cstate->minorversion)))
80 return nfserr_attrnotsupp;
83 * Check FATTR4_WORD0_ACL & FATTR4_WORD0_FS_LOCATIONS can be supported
84 * in current environment or not.
86 if (bmval[0] & FATTR4_WORD0_ACL) {
87 if (!IS_POSIXACL(dentry->d_inode))
88 return nfserr_attrnotsupp;
90 if (bmval[0] & FATTR4_WORD0_FS_LOCATIONS) {
91 if (exp->ex_fslocs.locations == NULL)
92 return nfserr_attrnotsupp;
96 * According to spec, read-only attributes return ERR_INVAL.
99 if ((bmval[0] & ~writable[0]) || (bmval[1] & ~writable[1]) ||
100 (bmval[2] & ~writable[2]))
108 nfsd4_check_open_attributes(struct svc_rqst *rqstp,
109 struct nfsd4_compound_state *cstate, struct nfsd4_open *open)
111 __be32 status = nfs_ok;
113 if (open->op_create == NFS4_OPEN_CREATE) {
114 if (open->op_createmode == NFS4_CREATE_UNCHECKED
115 || open->op_createmode == NFS4_CREATE_GUARDED)
116 status = check_attr_support(rqstp, cstate,
117 open->op_bmval, nfsd_attrmask);
118 else if (open->op_createmode == NFS4_CREATE_EXCLUSIVE4_1)
119 status = check_attr_support(rqstp, cstate,
120 open->op_bmval, nfsd41_ex_attrmask);
127 fh_dup2(struct svc_fh *dst, struct svc_fh *src)
130 dget(src->fh_dentry);
132 cache_get(&src->fh_export->h);
137 do_open_permission(struct svc_rqst *rqstp, struct svc_fh *current_fh, struct nfsd4_open *open, int accmode)
141 if (open->op_truncate &&
142 !(open->op_share_access & NFS4_SHARE_ACCESS_WRITE))
145 if (open->op_share_access & NFS4_SHARE_ACCESS_READ)
146 accmode |= NFSD_MAY_READ;
147 if (open->op_share_access & NFS4_SHARE_ACCESS_WRITE)
148 accmode |= (NFSD_MAY_WRITE | NFSD_MAY_TRUNC);
149 if (open->op_share_deny & NFS4_SHARE_DENY_WRITE)
150 accmode |= NFSD_MAY_WRITE;
152 status = fh_verify(rqstp, current_fh, S_IFREG, accmode);
158 do_open_lookup(struct svc_rqst *rqstp, struct svc_fh *current_fh, struct nfsd4_open *open)
164 fh_init(&resfh, NFS4_FHSIZE);
165 open->op_truncate = 0;
167 if (open->op_create) {
168 /* FIXME: check session persistence and pnfs flags.
169 * The nfsv4.1 spec requires the following semantics:
171 * Persistent | pNFS | Server REQUIRED | Client Allowed
172 * Reply Cache | server | |
173 * -------------+--------+-----------------+--------------------
174 * no | no | EXCLUSIVE4_1 | EXCLUSIVE4_1
176 * | | and EXCLUSIVE4 | or EXCLUSIVE4
178 * no | yes | EXCLUSIVE4_1 | EXCLUSIVE4_1
179 * yes | no | GUARDED4 | GUARDED4
180 * yes | yes | GUARDED4 | GUARDED4
184 * Note: create modes (UNCHECKED,GUARDED...) are the same
187 status = nfsd_create_v3(rqstp, current_fh, open->op_fname.data,
188 open->op_fname.len, &open->op_iattr,
189 &resfh, open->op_createmode,
190 (u32 *)open->op_verf.data,
191 &open->op_truncate, &created);
194 * Following rfc 3530 14.2.16, use the returned bitmask
195 * to indicate which attributes we used to store the
198 if (open->op_createmode == NFS4_CREATE_EXCLUSIVE && status == 0)
199 open->op_bmval[1] = (FATTR4_WORD1_TIME_ACCESS |
200 FATTR4_WORD1_TIME_MODIFY);
202 status = nfsd_lookup(rqstp, current_fh,
203 open->op_fname.data, open->op_fname.len, &resfh);
204 fh_unlock(current_fh);
209 set_change_info(&open->op_cinfo, current_fh);
210 fh_dup2(current_fh, &resfh);
212 /* set reply cache */
213 fh_copy_shallow(&open->op_stateowner->so_replay.rp_openfh,
216 status = do_open_permission(rqstp, current_fh, open,
225 do_open_fhandle(struct svc_rqst *rqstp, struct svc_fh *current_fh, struct nfsd4_open *open)
229 /* Only reclaims from previously confirmed clients are valid */
230 if ((status = nfs4_check_open_reclaim(&open->op_clientid)))
233 /* We don't know the target directory, and therefore can not
234 * set the change info
237 memset(&open->op_cinfo, 0, sizeof(struct nfsd4_change_info));
239 /* set replay cache */
240 fh_copy_shallow(&open->op_stateowner->so_replay.rp_openfh,
241 ¤t_fh->fh_handle);
243 open->op_truncate = (open->op_iattr.ia_valid & ATTR_SIZE) &&
244 (open->op_iattr.ia_size == 0);
246 status = do_open_permission(rqstp, current_fh, open,
247 NFSD_MAY_OWNER_OVERRIDE);
253 copy_clientid(clientid_t *clid, struct nfsd4_session *session)
255 struct nfsd4_sessionid *sid =
256 (struct nfsd4_sessionid *)session->se_sessionid.data;
258 clid->cl_boot = sid->clientid.cl_boot;
259 clid->cl_id = sid->clientid.cl_id;
263 nfsd4_open(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
264 struct nfsd4_open *open)
267 struct nfsd4_compoundres *resp;
269 dprintk("NFSD: nfsd4_open filename %.*s op_stateowner %p\n",
270 (int)open->op_fname.len, open->op_fname.data,
271 open->op_stateowner);
273 /* This check required by spec. */
274 if (open->op_create && open->op_claim_type != NFS4_OPEN_CLAIM_NULL)
277 if (nfsd4_has_session(cstate))
278 copy_clientid(&open->op_clientid, cstate->session);
282 /* check seqid for replay. set nfs4_owner */
283 resp = rqstp->rq_resp;
284 status = nfsd4_process_open1(&resp->cstate, open);
285 if (status == nfserr_replay_me) {
286 struct nfs4_replay *rp = &open->op_stateowner->so_replay;
287 fh_put(&cstate->current_fh);
288 fh_copy_shallow(&cstate->current_fh.fh_handle,
290 status = fh_verify(rqstp, &cstate->current_fh, 0, NFSD_MAY_NOP);
292 dprintk("nfsd4_open: replay failed"
293 " restoring previous filehandle\n");
295 status = nfserr_replay_me;
300 status = nfsd4_check_open_attributes(rqstp, cstate, open);
304 /* Openowner is now set, so sequence id will get bumped. Now we need
305 * these checks before we do any creates: */
306 status = nfserr_grace;
307 if (locks_in_grace() && open->op_claim_type != NFS4_OPEN_CLAIM_PREVIOUS)
309 status = nfserr_no_grace;
310 if (!locks_in_grace() && open->op_claim_type == NFS4_OPEN_CLAIM_PREVIOUS)
313 switch (open->op_claim_type) {
314 case NFS4_OPEN_CLAIM_DELEGATE_CUR:
315 case NFS4_OPEN_CLAIM_NULL:
317 * (1) set CURRENT_FH to the file being opened,
318 * creating it if necessary, (2) set open->op_cinfo,
319 * (3) set open->op_truncate if the file is to be
320 * truncated after opening, (4) do permission checking.
322 status = do_open_lookup(rqstp, &cstate->current_fh,
327 case NFS4_OPEN_CLAIM_PREVIOUS:
328 open->op_stateowner->so_confirmed = 1;
330 * The CURRENT_FH is already set to the file being
331 * opened. (1) set open->op_cinfo, (2) set
332 * open->op_truncate if the file is to be truncated
333 * after opening, (3) do permission checking.
335 status = do_open_fhandle(rqstp, &cstate->current_fh,
340 case NFS4_OPEN_CLAIM_DELEGATE_PREV:
341 open->op_stateowner->so_confirmed = 1;
342 dprintk("NFSD: unsupported OPEN claim type %d\n",
343 open->op_claim_type);
344 status = nfserr_notsupp;
347 dprintk("NFSD: Invalid OPEN claim type %d\n",
348 open->op_claim_type);
349 status = nfserr_inval;
353 * nfsd4_process_open2() does the actual opening of the file. If
354 * successful, it (1) truncates the file if open->op_truncate was
355 * set, (2) sets open->op_stateid, (3) sets open->op_delegation.
357 status = nfsd4_process_open2(rqstp, &cstate->current_fh, open);
359 if (open->op_stateowner) {
360 nfs4_get_stateowner(open->op_stateowner);
361 cstate->replay_owner = open->op_stateowner;
368 * filehandle-manipulating ops.
371 nfsd4_getfh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
372 struct svc_fh **getfh)
374 if (!cstate->current_fh.fh_dentry)
375 return nfserr_nofilehandle;
377 *getfh = &cstate->current_fh;
382 nfsd4_putfh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
383 struct nfsd4_putfh *putfh)
385 fh_put(&cstate->current_fh);
386 cstate->current_fh.fh_handle.fh_size = putfh->pf_fhlen;
387 memcpy(&cstate->current_fh.fh_handle.fh_base, putfh->pf_fhval,
389 return fh_verify(rqstp, &cstate->current_fh, 0, NFSD_MAY_NOP);
393 nfsd4_putrootfh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
398 fh_put(&cstate->current_fh);
399 status = exp_pseudoroot(rqstp, &cstate->current_fh);
404 nfsd4_restorefh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
407 if (!cstate->save_fh.fh_dentry)
408 return nfserr_restorefh;
410 fh_dup2(&cstate->current_fh, &cstate->save_fh);
415 nfsd4_savefh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
418 if (!cstate->current_fh.fh_dentry)
419 return nfserr_nofilehandle;
421 fh_dup2(&cstate->save_fh, &cstate->current_fh);
429 nfsd4_access(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
430 struct nfsd4_access *access)
432 if (access->ac_req_access & ~NFS3_ACCESS_FULL)
435 access->ac_resp_access = access->ac_req_access;
436 return nfsd_access(rqstp, &cstate->current_fh, &access->ac_resp_access,
437 &access->ac_supported);
441 nfsd4_commit(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
442 struct nfsd4_commit *commit)
446 u32 *p = (u32 *)commit->co_verf.data;
447 *p++ = nfssvc_boot.tv_sec;
448 *p++ = nfssvc_boot.tv_usec;
450 status = nfsd_commit(rqstp, &cstate->current_fh, commit->co_offset,
452 if (status == nfserr_symlink)
453 status = nfserr_inval;
458 nfsd4_create(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
459 struct nfsd4_create *create)
465 fh_init(&resfh, NFS4_FHSIZE);
467 status = fh_verify(rqstp, &cstate->current_fh, S_IFDIR,
469 if (status == nfserr_symlink)
470 status = nfserr_notdir;
474 status = check_attr_support(rqstp, cstate, create->cr_bmval,
479 switch (create->cr_type) {
481 /* ugh! we have to null-terminate the linktext, or
482 * vfs_symlink() will choke. it is always safe to
483 * null-terminate by brute force, since at worst we
484 * will overwrite the first byte of the create namelen
485 * in the XDR buffer, which has already been extracted
488 create->cr_linkname[create->cr_linklen] = 0;
490 status = nfsd_symlink(rqstp, &cstate->current_fh,
491 create->cr_name, create->cr_namelen,
492 create->cr_linkname, create->cr_linklen,
493 &resfh, &create->cr_iattr);
497 rdev = MKDEV(create->cr_specdata1, create->cr_specdata2);
498 if (MAJOR(rdev) != create->cr_specdata1 ||
499 MINOR(rdev) != create->cr_specdata2)
501 status = nfsd_create(rqstp, &cstate->current_fh,
502 create->cr_name, create->cr_namelen,
503 &create->cr_iattr, S_IFBLK, rdev, &resfh);
507 rdev = MKDEV(create->cr_specdata1, create->cr_specdata2);
508 if (MAJOR(rdev) != create->cr_specdata1 ||
509 MINOR(rdev) != create->cr_specdata2)
511 status = nfsd_create(rqstp, &cstate->current_fh,
512 create->cr_name, create->cr_namelen,
513 &create->cr_iattr,S_IFCHR, rdev, &resfh);
517 status = nfsd_create(rqstp, &cstate->current_fh,
518 create->cr_name, create->cr_namelen,
519 &create->cr_iattr, S_IFSOCK, 0, &resfh);
523 status = nfsd_create(rqstp, &cstate->current_fh,
524 create->cr_name, create->cr_namelen,
525 &create->cr_iattr, S_IFIFO, 0, &resfh);
529 create->cr_iattr.ia_valid &= ~ATTR_SIZE;
530 status = nfsd_create(rqstp, &cstate->current_fh,
531 create->cr_name, create->cr_namelen,
532 &create->cr_iattr, S_IFDIR, 0, &resfh);
536 status = nfserr_badtype;
540 fh_unlock(&cstate->current_fh);
541 set_change_info(&create->cr_cinfo, &cstate->current_fh);
542 fh_dup2(&cstate->current_fh, &resfh);
550 nfsd4_getattr(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
551 struct nfsd4_getattr *getattr)
555 status = fh_verify(rqstp, &cstate->current_fh, 0, NFSD_MAY_NOP);
559 if (getattr->ga_bmval[1] & NFSD_WRITEONLY_ATTRS_WORD1)
562 getattr->ga_bmval[0] &= nfsd_suppattrs0(cstate->minorversion);
563 getattr->ga_bmval[1] &= nfsd_suppattrs1(cstate->minorversion);
564 getattr->ga_bmval[2] &= nfsd_suppattrs2(cstate->minorversion);
566 getattr->ga_fhp = &cstate->current_fh;
571 nfsd4_link(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
572 struct nfsd4_link *link)
574 __be32 status = nfserr_nofilehandle;
576 if (!cstate->save_fh.fh_dentry)
578 status = nfsd_link(rqstp, &cstate->current_fh,
579 link->li_name, link->li_namelen, &cstate->save_fh);
581 set_change_info(&link->li_cinfo, &cstate->current_fh);
586 nfsd4_lookupp(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
589 struct svc_fh tmp_fh;
592 fh_init(&tmp_fh, NFS4_FHSIZE);
593 ret = exp_pseudoroot(rqstp, &tmp_fh);
596 if (tmp_fh.fh_dentry == cstate->current_fh.fh_dentry) {
601 return nfsd_lookup(rqstp, &cstate->current_fh,
602 "..", 2, &cstate->current_fh);
606 nfsd4_lookup(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
607 struct nfsd4_lookup *lookup)
609 return nfsd_lookup(rqstp, &cstate->current_fh,
610 lookup->lo_name, lookup->lo_len,
611 &cstate->current_fh);
615 nfsd4_read(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
616 struct nfsd4_read *read)
620 /* no need to check permission - this will be done in nfsd_read() */
622 read->rd_filp = NULL;
623 if (read->rd_offset >= OFFSET_MAX)
628 if ((status = nfs4_preprocess_stateid_op(cstate, &read->rd_stateid,
629 RD_STATE, &read->rd_filp))) {
630 dprintk("NFSD: nfsd4_read: couldn't process stateid!\n");
634 get_file(read->rd_filp);
638 read->rd_rqstp = rqstp;
639 read->rd_fhp = &cstate->current_fh;
644 nfsd4_readdir(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
645 struct nfsd4_readdir *readdir)
647 u64 cookie = readdir->rd_cookie;
648 static const nfs4_verifier zeroverf;
650 /* no need to check permission - this will be done in nfsd_readdir() */
652 if (readdir->rd_bmval[1] & NFSD_WRITEONLY_ATTRS_WORD1)
655 readdir->rd_bmval[0] &= nfsd_suppattrs0(cstate->minorversion);
656 readdir->rd_bmval[1] &= nfsd_suppattrs1(cstate->minorversion);
657 readdir->rd_bmval[2] &= nfsd_suppattrs2(cstate->minorversion);
659 if ((cookie > ~(u32)0) || (cookie == 1) || (cookie == 2) ||
660 (cookie == 0 && memcmp(readdir->rd_verf.data, zeroverf.data, NFS4_VERIFIER_SIZE)))
661 return nfserr_bad_cookie;
663 readdir->rd_rqstp = rqstp;
664 readdir->rd_fhp = &cstate->current_fh;
669 nfsd4_readlink(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
670 struct nfsd4_readlink *readlink)
672 readlink->rl_rqstp = rqstp;
673 readlink->rl_fhp = &cstate->current_fh;
678 nfsd4_remove(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
679 struct nfsd4_remove *remove)
683 if (locks_in_grace())
685 status = nfsd_unlink(rqstp, &cstate->current_fh, 0,
686 remove->rm_name, remove->rm_namelen);
687 if (status == nfserr_symlink)
688 return nfserr_notdir;
690 fh_unlock(&cstate->current_fh);
691 set_change_info(&remove->rm_cinfo, &cstate->current_fh);
697 nfsd4_rename(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
698 struct nfsd4_rename *rename)
700 __be32 status = nfserr_nofilehandle;
702 if (!cstate->save_fh.fh_dentry)
704 if (locks_in_grace() && !(cstate->save_fh.fh_export->ex_flags
705 & NFSEXP_NOSUBTREECHECK))
707 status = nfsd_rename(rqstp, &cstate->save_fh, rename->rn_sname,
708 rename->rn_snamelen, &cstate->current_fh,
709 rename->rn_tname, rename->rn_tnamelen);
711 /* the underlying filesystem returns different error's than required
712 * by NFSv4. both save_fh and current_fh have been verified.. */
713 if (status == nfserr_isdir)
714 status = nfserr_exist;
715 else if ((status == nfserr_notdir) &&
716 (S_ISDIR(cstate->save_fh.fh_dentry->d_inode->i_mode) &&
717 S_ISDIR(cstate->current_fh.fh_dentry->d_inode->i_mode)))
718 status = nfserr_exist;
719 else if (status == nfserr_symlink)
720 status = nfserr_notdir;
723 set_change_info(&rename->rn_sinfo, &cstate->current_fh);
724 set_change_info(&rename->rn_tinfo, &cstate->save_fh);
730 nfsd4_secinfo(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
731 struct nfsd4_secinfo *secinfo)
734 struct svc_export *exp;
735 struct dentry *dentry;
738 fh_init(&resfh, NFS4_FHSIZE);
739 err = nfsd_lookup_dentry(rqstp, &cstate->current_fh,
740 secinfo->si_name, secinfo->si_namelen,
744 if (dentry->d_inode == NULL) {
748 secinfo->si_exp = exp;
754 nfsd4_setattr(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
755 struct nfsd4_setattr *setattr)
757 __be32 status = nfs_ok;
759 if (setattr->sa_iattr.ia_valid & ATTR_SIZE) {
761 status = nfs4_preprocess_stateid_op(cstate,
762 &setattr->sa_stateid, WR_STATE, NULL);
765 dprintk("NFSD: nfsd4_setattr: couldn't process stateid!\n");
769 status = mnt_want_write(cstate->current_fh.fh_export->ex_path.mnt);
774 status = check_attr_support(rqstp, cstate, setattr->sa_bmval,
779 if (setattr->sa_acl != NULL)
780 status = nfsd4_set_nfs4_acl(rqstp, &cstate->current_fh,
784 status = nfsd_setattr(rqstp, &cstate->current_fh, &setattr->sa_iattr,
787 mnt_drop_write(cstate->current_fh.fh_export->ex_path.mnt);
792 nfsd4_write(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
793 struct nfsd4_write *write)
795 stateid_t *stateid = &write->wr_stateid;
796 struct file *filp = NULL;
798 __be32 status = nfs_ok;
801 /* no need to check permission - this will be done in nfsd_write() */
803 if (write->wr_offset >= OFFSET_MAX)
807 status = nfs4_preprocess_stateid_op(cstate, stateid, WR_STATE, &filp);
813 dprintk("NFSD: nfsd4_write: couldn't process stateid!\n");
817 cnt = write->wr_buflen;
818 write->wr_how_written = write->wr_stable_how;
819 p = (u32 *)write->wr_verifier.data;
820 *p++ = nfssvc_boot.tv_sec;
821 *p++ = nfssvc_boot.tv_usec;
823 status = nfsd_write(rqstp, &cstate->current_fh, filp,
824 write->wr_offset, rqstp->rq_vec, write->wr_vlen,
825 &cnt, &write->wr_how_written);
829 write->wr_bytes_written = cnt;
831 if (status == nfserr_symlink)
832 status = nfserr_inval;
836 /* This routine never returns NFS_OK! If there are no other errors, it
837 * will return NFSERR_SAME or NFSERR_NOT_SAME depending on whether the
838 * attributes matched. VERIFY is implemented by mapping NFSERR_SAME
839 * to NFS_OK after the call; NVERIFY by mapping NFSERR_NOT_SAME to NFS_OK.
842 _nfsd4_verify(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
843 struct nfsd4_verify *verify)
849 status = fh_verify(rqstp, &cstate->current_fh, 0, NFSD_MAY_NOP);
853 status = check_attr_support(rqstp, cstate, verify->ve_bmval, NULL);
857 if ((verify->ve_bmval[0] & FATTR4_WORD0_RDATTR_ERROR)
858 || (verify->ve_bmval[1] & NFSD_WRITEONLY_ATTRS_WORD1))
860 if (verify->ve_attrlen & 3)
864 * bitmap_len(1) + bitmap(2) + attr_len(1) = 4
866 count = 4 + (verify->ve_attrlen >> 2);
867 buf = kmalloc(count << 2, GFP_KERNEL);
869 return nfserr_resource;
871 status = nfsd4_encode_fattr(&cstate->current_fh,
872 cstate->current_fh.fh_export,
873 cstate->current_fh.fh_dentry, buf,
874 &count, verify->ve_bmval,
877 /* this means that nfsd4_encode_fattr() ran out of space */
878 if (status == nfserr_resource && count == 0)
879 status = nfserr_not_same;
884 p = buf + 1 + ntohl(buf[0]);
885 status = nfserr_not_same;
886 if (ntohl(*p++) != verify->ve_attrlen)
888 if (!memcmp(p, verify->ve_attrval, verify->ve_attrlen))
889 status = nfserr_same;
897 nfsd4_nverify(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
898 struct nfsd4_verify *verify)
902 status = _nfsd4_verify(rqstp, cstate, verify);
903 return status == nfserr_not_same ? nfs_ok : status;
907 nfsd4_verify(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
908 struct nfsd4_verify *verify)
912 status = _nfsd4_verify(rqstp, cstate, verify);
913 return status == nfserr_same ? nfs_ok : status;
920 nfsd4_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
925 static inline void nfsd4_increment_op_stats(u32 opnum)
927 if (opnum >= FIRST_NFS4_OP && opnum <= LAST_NFS4_OP)
928 nfsdstats.nfs4_opcount[opnum]++;
931 typedef __be32(*nfsd4op_func)(struct svc_rqst *, struct nfsd4_compound_state *,
933 enum nfsd4_op_flags {
934 ALLOWED_WITHOUT_FH = 1 << 0, /* No current filehandle required */
935 ALLOWED_ON_ABSENT_FS = 2 << 0, /* ops processed on absent fs */
936 ALLOWED_AS_FIRST_OP = 3 << 0, /* ops reqired first in compound */
939 struct nfsd4_operation {
940 nfsd4op_func op_func;
945 static struct nfsd4_operation nfsd4_ops[];
947 static const char *nfsd4_op_name(unsigned opnum);
950 * This is a replay of a compound for which no cache entry pages
951 * were used. Encode the sequence operation, and if cachethis is FALSE
952 * encode the uncache rep error on the next operation.
955 nfsd4_enc_uncached_replay(struct nfsd4_compoundargs *args,
956 struct nfsd4_compoundres *resp)
960 dprintk("--> %s resp->opcnt %d ce_cachethis %u \n", __func__,
961 resp->opcnt, resp->cstate.slot->sl_cache_entry.ce_cachethis);
963 /* Encode the replayed sequence operation */
964 BUG_ON(resp->opcnt != 1);
965 op = &args->ops[resp->opcnt - 1];
966 nfsd4_encode_operation(resp, op);
968 /*return nfserr_retry_uncached_rep in next operation. */
969 if (resp->cstate.slot->sl_cache_entry.ce_cachethis == 0) {
970 op = &args->ops[resp->opcnt++];
971 op->status = nfserr_retry_uncached_rep;
972 nfsd4_encode_operation(resp, op);
978 * Enforce NFSv4.1 COMPOUND ordering rules.
981 * - enforce NFS4ERR_NOT_ONLY_OP,
982 * - DESTROY_SESSION MUST be the final operation in the COMPOUND request.
984 static bool nfs41_op_ordering_ok(struct nfsd4_compoundargs *args)
986 if (args->minorversion && args->opcnt > 0) {
987 struct nfsd4_op *op = &args->ops[0];
988 return (op->status == nfserr_op_illegal) ||
989 (nfsd4_ops[op->opnum].op_flags & ALLOWED_AS_FIRST_OP);
998 nfsd4_proc_compound(struct svc_rqst *rqstp,
999 struct nfsd4_compoundargs *args,
1000 struct nfsd4_compoundres *resp)
1002 struct nfsd4_op *op;
1003 struct nfsd4_operation *opdesc;
1004 struct nfsd4_compound_state *cstate = &resp->cstate;
1008 resp->xbuf = &rqstp->rq_res;
1009 resp->p = rqstp->rq_res.head[0].iov_base +
1010 rqstp->rq_res.head[0].iov_len;
1011 resp->tagp = resp->p;
1012 /* reserve space for: taglen, tag, and opcnt */
1013 resp->p += 2 + XDR_QUADLEN(args->taglen);
1014 resp->end = rqstp->rq_res.head[0].iov_base + PAGE_SIZE;
1015 resp->taglen = args->taglen;
1016 resp->tag = args->tag;
1018 resp->rqstp = rqstp;
1019 resp->cstate.minorversion = args->minorversion;
1020 resp->cstate.replay_owner = NULL;
1021 fh_init(&resp->cstate.current_fh, NFS4_FHSIZE);
1022 fh_init(&resp->cstate.save_fh, NFS4_FHSIZE);
1023 /* Use the deferral mechanism only for NFSv4.0 compounds */
1024 rqstp->rq_usedeferral = (args->minorversion == 0);
1027 * According to RFC3010, this takes precedence over all other errors.
1029 status = nfserr_minor_vers_mismatch;
1030 if (args->minorversion > nfsd_supported_minorversion)
1033 if (!nfs41_op_ordering_ok(args)) {
1035 op->status = nfserr_sequence_pos;
1040 while (!status && resp->opcnt < args->opcnt) {
1041 op = &args->ops[resp->opcnt++];
1043 dprintk("nfsv4 compound op #%d/%d: %d (%s)\n",
1044 resp->opcnt, args->opcnt, op->opnum,
1045 nfsd4_op_name(op->opnum));
1047 * The XDR decode routines may have pre-set op->status;
1048 * for example, if there is a miscellaneous XDR error
1049 * it will be set to nfserr_bad_xdr.
1054 /* We must be able to encode a successful response to
1055 * this operation, with enough room left over to encode a
1056 * failed response to the next operation. If we don't
1057 * have enough room, fail with ERR_RESOURCE.
1059 slack_bytes = (char *)resp->end - (char *)resp->p;
1060 if (slack_bytes < COMPOUND_SLACK_SPACE
1061 + COMPOUND_ERR_SLACK_SPACE) {
1062 BUG_ON(slack_bytes < COMPOUND_ERR_SLACK_SPACE);
1063 op->status = nfserr_resource;
1067 opdesc = &nfsd4_ops[op->opnum];
1069 if (!cstate->current_fh.fh_dentry) {
1070 if (!(opdesc->op_flags & ALLOWED_WITHOUT_FH)) {
1071 op->status = nfserr_nofilehandle;
1074 } else if (cstate->current_fh.fh_export->ex_fslocs.migrated &&
1075 !(opdesc->op_flags & ALLOWED_ON_ABSENT_FS)) {
1076 op->status = nfserr_moved;
1080 if (opdesc->op_func)
1081 op->status = opdesc->op_func(rqstp, cstate, &op->u);
1083 BUG_ON(op->status == nfs_ok);
1086 /* Only from SEQUENCE or CREATE_SESSION */
1087 if (resp->cstate.status == nfserr_replay_cache) {
1088 dprintk("%s NFS4.1 replay from cache\n", __func__);
1089 if (nfsd4_not_cached(resp))
1090 status = nfsd4_enc_uncached_replay(args, resp);
1092 status = op->status;
1095 if (op->status == nfserr_replay_me) {
1096 op->replay = &cstate->replay_owner->so_replay;
1097 nfsd4_encode_replay(resp, op);
1098 status = op->status = op->replay->rp_status;
1100 nfsd4_encode_operation(resp, op);
1101 status = op->status;
1104 dprintk("nfsv4 compound op %p opcnt %d #%d: %d: status %d\n",
1105 args->ops, args->opcnt, resp->opcnt, op->opnum,
1106 be32_to_cpu(status));
1108 if (cstate->replay_owner) {
1109 nfs4_put_stateowner(cstate->replay_owner);
1110 cstate->replay_owner = NULL;
1112 /* XXX Ugh, we need to get rid of this kind of special case: */
1113 if (op->opnum == OP_READ && op->u.read.rd_filp)
1114 fput(op->u.read.rd_filp);
1116 nfsd4_increment_op_stats(op->opnum);
1118 if (!rqstp->rq_usedeferral && status == nfserr_dropit) {
1119 dprintk("%s Dropit - send NFS4ERR_DELAY\n", __func__);
1120 status = nfserr_jukebox;
1123 resp->cstate.status = status;
1124 fh_put(&resp->cstate.current_fh);
1125 fh_put(&resp->cstate.save_fh);
1126 BUG_ON(resp->cstate.replay_owner);
1128 nfsd4_release_compoundargs(args);
1129 /* Reset deferral mechanism for RPC deferrals */
1130 rqstp->rq_usedeferral = 1;
1131 dprintk("nfsv4 compound returned %d\n", ntohl(status));
1135 static struct nfsd4_operation nfsd4_ops[] = {
1137 .op_func = (nfsd4op_func)nfsd4_access,
1138 .op_name = "OP_ACCESS",
1141 .op_func = (nfsd4op_func)nfsd4_close,
1142 .op_name = "OP_CLOSE",
1145 .op_func = (nfsd4op_func)nfsd4_commit,
1146 .op_name = "OP_COMMIT",
1149 .op_func = (nfsd4op_func)nfsd4_create,
1150 .op_name = "OP_CREATE",
1152 [OP_DELEGRETURN] = {
1153 .op_func = (nfsd4op_func)nfsd4_delegreturn,
1154 .op_name = "OP_DELEGRETURN",
1157 .op_func = (nfsd4op_func)nfsd4_getattr,
1158 .op_flags = ALLOWED_ON_ABSENT_FS,
1159 .op_name = "OP_GETATTR",
1162 .op_func = (nfsd4op_func)nfsd4_getfh,
1163 .op_name = "OP_GETFH",
1166 .op_func = (nfsd4op_func)nfsd4_link,
1167 .op_name = "OP_LINK",
1170 .op_func = (nfsd4op_func)nfsd4_lock,
1171 .op_name = "OP_LOCK",
1174 .op_func = (nfsd4op_func)nfsd4_lockt,
1175 .op_name = "OP_LOCKT",
1178 .op_func = (nfsd4op_func)nfsd4_locku,
1179 .op_name = "OP_LOCKU",
1182 .op_func = (nfsd4op_func)nfsd4_lookup,
1183 .op_name = "OP_LOOKUP",
1186 .op_func = (nfsd4op_func)nfsd4_lookupp,
1187 .op_name = "OP_LOOKUPP",
1190 .op_func = (nfsd4op_func)nfsd4_nverify,
1191 .op_name = "OP_NVERIFY",
1194 .op_func = (nfsd4op_func)nfsd4_open,
1195 .op_name = "OP_OPEN",
1197 [OP_OPEN_CONFIRM] = {
1198 .op_func = (nfsd4op_func)nfsd4_open_confirm,
1199 .op_name = "OP_OPEN_CONFIRM",
1201 [OP_OPEN_DOWNGRADE] = {
1202 .op_func = (nfsd4op_func)nfsd4_open_downgrade,
1203 .op_name = "OP_OPEN_DOWNGRADE",
1206 .op_func = (nfsd4op_func)nfsd4_putfh,
1207 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1208 .op_name = "OP_PUTFH",
1211 .op_func = (nfsd4op_func)nfsd4_putrootfh,
1212 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1213 .op_name = "OP_PUTPUBFH",
1216 .op_func = (nfsd4op_func)nfsd4_putrootfh,
1217 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1218 .op_name = "OP_PUTROOTFH",
1221 .op_func = (nfsd4op_func)nfsd4_read,
1222 .op_name = "OP_READ",
1225 .op_func = (nfsd4op_func)nfsd4_readdir,
1226 .op_name = "OP_READDIR",
1229 .op_func = (nfsd4op_func)nfsd4_readlink,
1230 .op_name = "OP_READLINK",
1233 .op_func = (nfsd4op_func)nfsd4_remove,
1234 .op_name = "OP_REMOVE",
1237 .op_name = "OP_RENAME",
1238 .op_func = (nfsd4op_func)nfsd4_rename,
1241 .op_func = (nfsd4op_func)nfsd4_renew,
1242 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1243 .op_name = "OP_RENEW",
1246 .op_func = (nfsd4op_func)nfsd4_restorefh,
1247 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1248 .op_name = "OP_RESTOREFH",
1251 .op_func = (nfsd4op_func)nfsd4_savefh,
1252 .op_name = "OP_SAVEFH",
1255 .op_func = (nfsd4op_func)nfsd4_secinfo,
1256 .op_name = "OP_SECINFO",
1259 .op_func = (nfsd4op_func)nfsd4_setattr,
1260 .op_name = "OP_SETATTR",
1262 [OP_SETCLIENTID] = {
1263 .op_func = (nfsd4op_func)nfsd4_setclientid,
1264 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1265 .op_name = "OP_SETCLIENTID",
1267 [OP_SETCLIENTID_CONFIRM] = {
1268 .op_func = (nfsd4op_func)nfsd4_setclientid_confirm,
1269 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1270 .op_name = "OP_SETCLIENTID_CONFIRM",
1273 .op_func = (nfsd4op_func)nfsd4_verify,
1274 .op_name = "OP_VERIFY",
1277 .op_func = (nfsd4op_func)nfsd4_write,
1278 .op_name = "OP_WRITE",
1280 [OP_RELEASE_LOCKOWNER] = {
1281 .op_func = (nfsd4op_func)nfsd4_release_lockowner,
1282 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1283 .op_name = "OP_RELEASE_LOCKOWNER",
1286 /* NFSv4.1 operations */
1287 [OP_EXCHANGE_ID] = {
1288 .op_func = (nfsd4op_func)nfsd4_exchange_id,
1289 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_AS_FIRST_OP,
1290 .op_name = "OP_EXCHANGE_ID",
1292 [OP_CREATE_SESSION] = {
1293 .op_func = (nfsd4op_func)nfsd4_create_session,
1294 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_AS_FIRST_OP,
1295 .op_name = "OP_CREATE_SESSION",
1297 [OP_DESTROY_SESSION] = {
1298 .op_func = (nfsd4op_func)nfsd4_destroy_session,
1299 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_AS_FIRST_OP,
1300 .op_name = "OP_DESTROY_SESSION",
1303 .op_func = (nfsd4op_func)nfsd4_sequence,
1304 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_AS_FIRST_OP,
1305 .op_name = "OP_SEQUENCE",
1309 static const char *nfsd4_op_name(unsigned opnum)
1311 if (opnum < ARRAY_SIZE(nfsd4_ops))
1312 return nfsd4_ops[opnum].op_name;
1313 return "unknown_operation";
1316 #define nfsd4_voidres nfsd4_voidargs
1317 struct nfsd4_voidargs { int dummy; };
1320 * TODO: At the present time, the NFSv4 server does not do XID caching
1321 * of requests. Implementing XID caching would not be a serious problem,
1322 * although it would require a mild change in interfaces since one
1323 * doesn't know whether an NFSv4 request is idempotent until after the
1324 * XDR decode. However, XID caching totally confuses pynfs (Peter
1325 * Astrand's regression testsuite for NFSv4 servers), which reuses
1326 * XID's liberally, so I've left it unimplemented until pynfs generates
1329 static struct svc_procedure nfsd_procedures4[2] = {
1331 .pc_func = (svc_procfunc) nfsd4_proc_null,
1332 .pc_encode = (kxdrproc_t) nfs4svc_encode_voidres,
1333 .pc_argsize = sizeof(struct nfsd4_voidargs),
1334 .pc_ressize = sizeof(struct nfsd4_voidres),
1335 .pc_cachetype = RC_NOCACHE,
1338 [NFSPROC4_COMPOUND] = {
1339 .pc_func = (svc_procfunc) nfsd4_proc_compound,
1340 .pc_decode = (kxdrproc_t) nfs4svc_decode_compoundargs,
1341 .pc_encode = (kxdrproc_t) nfs4svc_encode_compoundres,
1342 .pc_argsize = sizeof(struct nfsd4_compoundargs),
1343 .pc_ressize = sizeof(struct nfsd4_compoundres),
1344 .pc_cachetype = RC_NOCACHE,
1345 .pc_xdrressize = NFSD_BUFSIZE/4,
1349 struct svc_version nfsd_version4 = {
1352 .vs_proc = nfsd_procedures4,
1353 .vs_dispatch = nfsd_dispatch,
1354 .vs_xdrsize = NFS4_SVC_XDRSIZE,