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
55 fh_dup2(struct svc_fh *dst, struct svc_fh *src)
60 cache_get(&src->fh_export->h);
65 do_open_permission(struct svc_rqst *rqstp, struct svc_fh *current_fh, struct nfsd4_open *open, int accmode)
69 if (open->op_truncate &&
70 !(open->op_share_access & NFS4_SHARE_ACCESS_WRITE))
73 if (open->op_share_access & NFS4_SHARE_ACCESS_READ)
74 accmode |= NFSD_MAY_READ;
75 if (open->op_share_access & NFS4_SHARE_ACCESS_WRITE)
76 accmode |= (NFSD_MAY_WRITE | NFSD_MAY_TRUNC);
77 if (open->op_share_deny & NFS4_SHARE_DENY_WRITE)
78 accmode |= NFSD_MAY_WRITE;
80 status = fh_verify(rqstp, current_fh, S_IFREG, accmode);
86 do_open_lookup(struct svc_rqst *rqstp, struct svc_fh *current_fh, struct nfsd4_open *open)
92 fh_init(&resfh, NFS4_FHSIZE);
93 open->op_truncate = 0;
95 if (open->op_create) {
97 * Note: create modes (UNCHECKED,GUARDED...) are the same
100 status = nfsd_create_v3(rqstp, current_fh, open->op_fname.data,
101 open->op_fname.len, &open->op_iattr,
102 &resfh, open->op_createmode,
103 (u32 *)open->op_verf.data,
104 &open->op_truncate, &created);
107 * Following rfc 3530 14.2.16, use the returned bitmask
108 * to indicate which attributes we used to store the
111 if (open->op_createmode == NFS4_CREATE_EXCLUSIVE && status == 0)
112 open->op_bmval[1] = (FATTR4_WORD1_TIME_ACCESS |
113 FATTR4_WORD1_TIME_MODIFY);
115 status = nfsd_lookup(rqstp, current_fh,
116 open->op_fname.data, open->op_fname.len, &resfh);
117 fh_unlock(current_fh);
122 set_change_info(&open->op_cinfo, current_fh);
123 fh_dup2(current_fh, &resfh);
125 /* set reply cache */
126 fh_copy_shallow(&open->op_stateowner->so_replay.rp_openfh,
129 status = do_open_permission(rqstp, current_fh, open,
138 do_open_fhandle(struct svc_rqst *rqstp, struct svc_fh *current_fh, struct nfsd4_open *open)
142 /* Only reclaims from previously confirmed clients are valid */
143 if ((status = nfs4_check_open_reclaim(&open->op_clientid)))
146 /* We don't know the target directory, and therefore can not
147 * set the change info
150 memset(&open->op_cinfo, 0, sizeof(struct nfsd4_change_info));
152 /* set replay cache */
153 fh_copy_shallow(&open->op_stateowner->so_replay.rp_openfh,
154 ¤t_fh->fh_handle);
156 open->op_truncate = (open->op_iattr.ia_valid & ATTR_SIZE) &&
157 (open->op_iattr.ia_size == 0);
159 status = do_open_permission(rqstp, current_fh, open,
160 NFSD_MAY_OWNER_OVERRIDE);
166 copy_clientid(clientid_t *clid, struct nfsd4_session *session)
168 struct nfsd4_sessionid *sid =
169 (struct nfsd4_sessionid *)session->se_sessionid.data;
171 clid->cl_boot = sid->clientid.cl_boot;
172 clid->cl_id = sid->clientid.cl_id;
176 nfsd4_open(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
177 struct nfsd4_open *open)
180 struct nfsd4_compoundres *resp;
182 dprintk("NFSD: nfsd4_open filename %.*s op_stateowner %p\n",
183 (int)open->op_fname.len, open->op_fname.data,
184 open->op_stateowner);
186 /* This check required by spec. */
187 if (open->op_create && open->op_claim_type != NFS4_OPEN_CLAIM_NULL)
190 if (nfsd4_has_session(cstate))
191 copy_clientid(&open->op_clientid, cstate->session);
195 /* check seqid for replay. set nfs4_owner */
196 resp = rqstp->rq_resp;
197 status = nfsd4_process_open1(&resp->cstate, open);
198 if (status == nfserr_replay_me) {
199 struct nfs4_replay *rp = &open->op_stateowner->so_replay;
200 fh_put(&cstate->current_fh);
201 fh_copy_shallow(&cstate->current_fh.fh_handle,
203 status = fh_verify(rqstp, &cstate->current_fh, 0, NFSD_MAY_NOP);
205 dprintk("nfsd4_open: replay failed"
206 " restoring previous filehandle\n");
208 status = nfserr_replay_me;
213 /* Openowner is now set, so sequence id will get bumped. Now we need
214 * these checks before we do any creates: */
215 status = nfserr_grace;
216 if (locks_in_grace() && open->op_claim_type != NFS4_OPEN_CLAIM_PREVIOUS)
218 status = nfserr_no_grace;
219 if (!locks_in_grace() && open->op_claim_type == NFS4_OPEN_CLAIM_PREVIOUS)
222 switch (open->op_claim_type) {
223 case NFS4_OPEN_CLAIM_DELEGATE_CUR:
224 case NFS4_OPEN_CLAIM_NULL:
226 * (1) set CURRENT_FH to the file being opened,
227 * creating it if necessary, (2) set open->op_cinfo,
228 * (3) set open->op_truncate if the file is to be
229 * truncated after opening, (4) do permission checking.
231 status = do_open_lookup(rqstp, &cstate->current_fh,
236 case NFS4_OPEN_CLAIM_PREVIOUS:
237 open->op_stateowner->so_confirmed = 1;
239 * The CURRENT_FH is already set to the file being
240 * opened. (1) set open->op_cinfo, (2) set
241 * open->op_truncate if the file is to be truncated
242 * after opening, (3) do permission checking.
244 status = do_open_fhandle(rqstp, &cstate->current_fh,
249 case NFS4_OPEN_CLAIM_DELEGATE_PREV:
250 open->op_stateowner->so_confirmed = 1;
251 dprintk("NFSD: unsupported OPEN claim type %d\n",
252 open->op_claim_type);
253 status = nfserr_notsupp;
256 dprintk("NFSD: Invalid OPEN claim type %d\n",
257 open->op_claim_type);
258 status = nfserr_inval;
262 * nfsd4_process_open2() does the actual opening of the file. If
263 * successful, it (1) truncates the file if open->op_truncate was
264 * set, (2) sets open->op_stateid, (3) sets open->op_delegation.
266 status = nfsd4_process_open2(rqstp, &cstate->current_fh, open);
268 if (open->op_stateowner) {
269 nfs4_get_stateowner(open->op_stateowner);
270 cstate->replay_owner = open->op_stateowner;
277 * filehandle-manipulating ops.
280 nfsd4_getfh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
281 struct svc_fh **getfh)
283 if (!cstate->current_fh.fh_dentry)
284 return nfserr_nofilehandle;
286 *getfh = &cstate->current_fh;
291 nfsd4_putfh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
292 struct nfsd4_putfh *putfh)
294 fh_put(&cstate->current_fh);
295 cstate->current_fh.fh_handle.fh_size = putfh->pf_fhlen;
296 memcpy(&cstate->current_fh.fh_handle.fh_base, putfh->pf_fhval,
298 return fh_verify(rqstp, &cstate->current_fh, 0, NFSD_MAY_NOP);
302 nfsd4_putrootfh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
307 fh_put(&cstate->current_fh);
308 status = exp_pseudoroot(rqstp, &cstate->current_fh);
313 nfsd4_restorefh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
316 if (!cstate->save_fh.fh_dentry)
317 return nfserr_restorefh;
319 fh_dup2(&cstate->current_fh, &cstate->save_fh);
324 nfsd4_savefh(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
327 if (!cstate->current_fh.fh_dentry)
328 return nfserr_nofilehandle;
330 fh_dup2(&cstate->save_fh, &cstate->current_fh);
338 nfsd4_access(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
339 struct nfsd4_access *access)
341 if (access->ac_req_access & ~NFS3_ACCESS_FULL)
344 access->ac_resp_access = access->ac_req_access;
345 return nfsd_access(rqstp, &cstate->current_fh, &access->ac_resp_access,
346 &access->ac_supported);
350 nfsd4_commit(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
351 struct nfsd4_commit *commit)
355 u32 *p = (u32 *)commit->co_verf.data;
356 *p++ = nfssvc_boot.tv_sec;
357 *p++ = nfssvc_boot.tv_usec;
359 status = nfsd_commit(rqstp, &cstate->current_fh, commit->co_offset,
361 if (status == nfserr_symlink)
362 status = nfserr_inval;
367 nfsd4_create(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
368 struct nfsd4_create *create)
374 fh_init(&resfh, NFS4_FHSIZE);
376 status = fh_verify(rqstp, &cstate->current_fh, S_IFDIR,
378 if (status == nfserr_symlink)
379 status = nfserr_notdir;
383 switch (create->cr_type) {
385 /* ugh! we have to null-terminate the linktext, or
386 * vfs_symlink() will choke. it is always safe to
387 * null-terminate by brute force, since at worst we
388 * will overwrite the first byte of the create namelen
389 * in the XDR buffer, which has already been extracted
392 create->cr_linkname[create->cr_linklen] = 0;
394 status = nfsd_symlink(rqstp, &cstate->current_fh,
395 create->cr_name, create->cr_namelen,
396 create->cr_linkname, create->cr_linklen,
397 &resfh, &create->cr_iattr);
401 rdev = MKDEV(create->cr_specdata1, create->cr_specdata2);
402 if (MAJOR(rdev) != create->cr_specdata1 ||
403 MINOR(rdev) != create->cr_specdata2)
405 status = nfsd_create(rqstp, &cstate->current_fh,
406 create->cr_name, create->cr_namelen,
407 &create->cr_iattr, S_IFBLK, rdev, &resfh);
411 rdev = MKDEV(create->cr_specdata1, create->cr_specdata2);
412 if (MAJOR(rdev) != create->cr_specdata1 ||
413 MINOR(rdev) != create->cr_specdata2)
415 status = nfsd_create(rqstp, &cstate->current_fh,
416 create->cr_name, create->cr_namelen,
417 &create->cr_iattr,S_IFCHR, rdev, &resfh);
421 status = nfsd_create(rqstp, &cstate->current_fh,
422 create->cr_name, create->cr_namelen,
423 &create->cr_iattr, S_IFSOCK, 0, &resfh);
427 status = nfsd_create(rqstp, &cstate->current_fh,
428 create->cr_name, create->cr_namelen,
429 &create->cr_iattr, S_IFIFO, 0, &resfh);
433 create->cr_iattr.ia_valid &= ~ATTR_SIZE;
434 status = nfsd_create(rqstp, &cstate->current_fh,
435 create->cr_name, create->cr_namelen,
436 &create->cr_iattr, S_IFDIR, 0, &resfh);
440 status = nfserr_badtype;
444 fh_unlock(&cstate->current_fh);
445 set_change_info(&create->cr_cinfo, &cstate->current_fh);
446 fh_dup2(&cstate->current_fh, &resfh);
454 nfsd4_getattr(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
455 struct nfsd4_getattr *getattr)
459 status = fh_verify(rqstp, &cstate->current_fh, 0, NFSD_MAY_NOP);
463 if (getattr->ga_bmval[1] & NFSD_WRITEONLY_ATTRS_WORD1)
466 getattr->ga_bmval[0] &= NFSD_SUPPORTED_ATTRS_WORD0;
467 getattr->ga_bmval[1] &= NFSD_SUPPORTED_ATTRS_WORD1;
469 getattr->ga_fhp = &cstate->current_fh;
474 nfsd4_link(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
475 struct nfsd4_link *link)
477 __be32 status = nfserr_nofilehandle;
479 if (!cstate->save_fh.fh_dentry)
481 status = nfsd_link(rqstp, &cstate->current_fh,
482 link->li_name, link->li_namelen, &cstate->save_fh);
484 set_change_info(&link->li_cinfo, &cstate->current_fh);
489 nfsd4_lookupp(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
492 struct svc_fh tmp_fh;
495 fh_init(&tmp_fh, NFS4_FHSIZE);
496 ret = exp_pseudoroot(rqstp, &tmp_fh);
499 if (tmp_fh.fh_dentry == cstate->current_fh.fh_dentry) {
504 return nfsd_lookup(rqstp, &cstate->current_fh,
505 "..", 2, &cstate->current_fh);
509 nfsd4_lookup(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
510 struct nfsd4_lookup *lookup)
512 return nfsd_lookup(rqstp, &cstate->current_fh,
513 lookup->lo_name, lookup->lo_len,
514 &cstate->current_fh);
518 nfsd4_read(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
519 struct nfsd4_read *read)
523 /* no need to check permission - this will be done in nfsd_read() */
525 read->rd_filp = NULL;
526 if (read->rd_offset >= OFFSET_MAX)
531 if ((status = nfs4_preprocess_stateid_op(cstate, &read->rd_stateid,
532 RD_STATE, &read->rd_filp))) {
533 dprintk("NFSD: nfsd4_read: couldn't process stateid!\n");
537 get_file(read->rd_filp);
541 read->rd_rqstp = rqstp;
542 read->rd_fhp = &cstate->current_fh;
547 nfsd4_readdir(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
548 struct nfsd4_readdir *readdir)
550 u64 cookie = readdir->rd_cookie;
551 static const nfs4_verifier zeroverf;
553 /* no need to check permission - this will be done in nfsd_readdir() */
555 if (readdir->rd_bmval[1] & NFSD_WRITEONLY_ATTRS_WORD1)
558 readdir->rd_bmval[0] &= NFSD_SUPPORTED_ATTRS_WORD0;
559 readdir->rd_bmval[1] &= NFSD_SUPPORTED_ATTRS_WORD1;
561 if ((cookie > ~(u32)0) || (cookie == 1) || (cookie == 2) ||
562 (cookie == 0 && memcmp(readdir->rd_verf.data, zeroverf.data, NFS4_VERIFIER_SIZE)))
563 return nfserr_bad_cookie;
565 readdir->rd_rqstp = rqstp;
566 readdir->rd_fhp = &cstate->current_fh;
571 nfsd4_readlink(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
572 struct nfsd4_readlink *readlink)
574 readlink->rl_rqstp = rqstp;
575 readlink->rl_fhp = &cstate->current_fh;
580 nfsd4_remove(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
581 struct nfsd4_remove *remove)
585 if (locks_in_grace())
587 status = nfsd_unlink(rqstp, &cstate->current_fh, 0,
588 remove->rm_name, remove->rm_namelen);
589 if (status == nfserr_symlink)
590 return nfserr_notdir;
592 fh_unlock(&cstate->current_fh);
593 set_change_info(&remove->rm_cinfo, &cstate->current_fh);
599 nfsd4_rename(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
600 struct nfsd4_rename *rename)
602 __be32 status = nfserr_nofilehandle;
604 if (!cstate->save_fh.fh_dentry)
606 if (locks_in_grace() && !(cstate->save_fh.fh_export->ex_flags
607 & NFSEXP_NOSUBTREECHECK))
609 status = nfsd_rename(rqstp, &cstate->save_fh, rename->rn_sname,
610 rename->rn_snamelen, &cstate->current_fh,
611 rename->rn_tname, rename->rn_tnamelen);
613 /* the underlying filesystem returns different error's than required
614 * by NFSv4. both save_fh and current_fh have been verified.. */
615 if (status == nfserr_isdir)
616 status = nfserr_exist;
617 else if ((status == nfserr_notdir) &&
618 (S_ISDIR(cstate->save_fh.fh_dentry->d_inode->i_mode) &&
619 S_ISDIR(cstate->current_fh.fh_dentry->d_inode->i_mode)))
620 status = nfserr_exist;
621 else if (status == nfserr_symlink)
622 status = nfserr_notdir;
625 set_change_info(&rename->rn_sinfo, &cstate->current_fh);
626 set_change_info(&rename->rn_tinfo, &cstate->save_fh);
632 nfsd4_secinfo(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
633 struct nfsd4_secinfo *secinfo)
636 struct svc_export *exp;
637 struct dentry *dentry;
640 fh_init(&resfh, NFS4_FHSIZE);
641 err = nfsd_lookup_dentry(rqstp, &cstate->current_fh,
642 secinfo->si_name, secinfo->si_namelen,
646 if (dentry->d_inode == NULL) {
650 secinfo->si_exp = exp;
656 nfsd4_setattr(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
657 struct nfsd4_setattr *setattr)
659 __be32 status = nfs_ok;
661 if (setattr->sa_iattr.ia_valid & ATTR_SIZE) {
663 status = nfs4_preprocess_stateid_op(cstate,
664 &setattr->sa_stateid, WR_STATE, NULL);
667 dprintk("NFSD: nfsd4_setattr: couldn't process stateid!\n");
671 status = mnt_want_write(cstate->current_fh.fh_export->ex_path.mnt);
675 if (setattr->sa_acl != NULL)
676 status = nfsd4_set_nfs4_acl(rqstp, &cstate->current_fh,
680 status = nfsd_setattr(rqstp, &cstate->current_fh, &setattr->sa_iattr,
683 mnt_drop_write(cstate->current_fh.fh_export->ex_path.mnt);
688 nfsd4_write(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
689 struct nfsd4_write *write)
691 stateid_t *stateid = &write->wr_stateid;
692 struct file *filp = NULL;
694 __be32 status = nfs_ok;
697 /* no need to check permission - this will be done in nfsd_write() */
699 if (write->wr_offset >= OFFSET_MAX)
703 status = nfs4_preprocess_stateid_op(cstate, stateid, WR_STATE, &filp);
709 dprintk("NFSD: nfsd4_write: couldn't process stateid!\n");
713 cnt = write->wr_buflen;
714 write->wr_how_written = write->wr_stable_how;
715 p = (u32 *)write->wr_verifier.data;
716 *p++ = nfssvc_boot.tv_sec;
717 *p++ = nfssvc_boot.tv_usec;
719 status = nfsd_write(rqstp, &cstate->current_fh, filp,
720 write->wr_offset, rqstp->rq_vec, write->wr_vlen,
721 &cnt, &write->wr_how_written);
725 write->wr_bytes_written = cnt;
727 if (status == nfserr_symlink)
728 status = nfserr_inval;
732 /* This routine never returns NFS_OK! If there are no other errors, it
733 * will return NFSERR_SAME or NFSERR_NOT_SAME depending on whether the
734 * attributes matched. VERIFY is implemented by mapping NFSERR_SAME
735 * to NFS_OK after the call; NVERIFY by mapping NFSERR_NOT_SAME to NFS_OK.
738 _nfsd4_verify(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
739 struct nfsd4_verify *verify)
745 status = fh_verify(rqstp, &cstate->current_fh, 0, NFSD_MAY_NOP);
749 if ((verify->ve_bmval[0] & ~NFSD_SUPPORTED_ATTRS_WORD0)
750 || (verify->ve_bmval[1] & ~NFSD_SUPPORTED_ATTRS_WORD1))
751 return nfserr_attrnotsupp;
752 if ((verify->ve_bmval[0] & FATTR4_WORD0_RDATTR_ERROR)
753 || (verify->ve_bmval[1] & NFSD_WRITEONLY_ATTRS_WORD1))
755 if (verify->ve_attrlen & 3)
759 * bitmap_len(1) + bitmap(2) + attr_len(1) = 4
761 count = 4 + (verify->ve_attrlen >> 2);
762 buf = kmalloc(count << 2, GFP_KERNEL);
764 return nfserr_resource;
766 status = nfsd4_encode_fattr(&cstate->current_fh,
767 cstate->current_fh.fh_export,
768 cstate->current_fh.fh_dentry, buf,
769 &count, verify->ve_bmval,
772 /* this means that nfsd4_encode_fattr() ran out of space */
773 if (status == nfserr_resource && count == 0)
774 status = nfserr_not_same;
779 status = nfserr_not_same;
780 if (ntohl(*p++) != verify->ve_attrlen)
782 if (!memcmp(p, verify->ve_attrval, verify->ve_attrlen))
783 status = nfserr_same;
791 nfsd4_nverify(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
792 struct nfsd4_verify *verify)
796 status = _nfsd4_verify(rqstp, cstate, verify);
797 return status == nfserr_not_same ? nfs_ok : status;
801 nfsd4_verify(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate,
802 struct nfsd4_verify *verify)
806 status = _nfsd4_verify(rqstp, cstate, verify);
807 return status == nfserr_same ? nfs_ok : status;
814 nfsd4_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
819 static inline void nfsd4_increment_op_stats(u32 opnum)
821 if (opnum >= FIRST_NFS4_OP && opnum <= LAST_NFS4_OP)
822 nfsdstats.nfs4_opcount[opnum]++;
825 typedef __be32(*nfsd4op_func)(struct svc_rqst *, struct nfsd4_compound_state *,
827 enum nfsd4_op_flags {
828 ALLOWED_WITHOUT_FH = 1 << 0, /* No current filehandle required */
829 ALLOWED_ON_ABSENT_FS = 2 << 0, /* ops processed on absent fs */
830 ALLOWED_AS_FIRST_OP = 3 << 0, /* ops reqired first in compound */
833 struct nfsd4_operation {
834 nfsd4op_func op_func;
839 static struct nfsd4_operation nfsd4_ops[];
841 static const char *nfsd4_op_name(unsigned opnum);
844 * This is a replay of a compound for which no cache entry pages
845 * were used. Encode the sequence operation, and if cachethis is FALSE
846 * encode the uncache rep error on the next operation.
849 nfsd4_enc_uncached_replay(struct nfsd4_compoundargs *args,
850 struct nfsd4_compoundres *resp)
854 dprintk("--> %s resp->opcnt %d ce_cachethis %u \n", __func__,
855 resp->opcnt, resp->cstate.slot->sl_cache_entry.ce_cachethis);
857 /* Encode the replayed sequence operation */
858 BUG_ON(resp->opcnt != 1);
859 op = &args->ops[resp->opcnt - 1];
860 nfsd4_encode_operation(resp, op);
862 /*return nfserr_retry_uncached_rep in next operation. */
863 if (resp->cstate.slot->sl_cache_entry.ce_cachethis == 0) {
864 op = &args->ops[resp->opcnt++];
865 op->status = nfserr_retry_uncached_rep;
866 nfsd4_encode_operation(resp, op);
872 * Enforce NFSv4.1 COMPOUND ordering rules.
875 * - enforce NFS4ERR_NOT_ONLY_OP,
876 * - DESTROY_SESSION MUST be the final operation in the COMPOUND request.
878 static bool nfs41_op_ordering_ok(struct nfsd4_compoundargs *args)
880 if (args->minorversion && args->opcnt > 0) {
881 struct nfsd4_op *op = &args->ops[0];
882 return (op->status == nfserr_op_illegal) ||
883 (nfsd4_ops[op->opnum].op_flags & ALLOWED_AS_FIRST_OP);
892 nfsd4_proc_compound(struct svc_rqst *rqstp,
893 struct nfsd4_compoundargs *args,
894 struct nfsd4_compoundres *resp)
897 struct nfsd4_operation *opdesc;
898 struct nfsd4_compound_state *cstate = &resp->cstate;
902 resp->xbuf = &rqstp->rq_res;
903 resp->p = rqstp->rq_res.head[0].iov_base +
904 rqstp->rq_res.head[0].iov_len;
905 resp->tagp = resp->p;
906 /* reserve space for: taglen, tag, and opcnt */
907 resp->p += 2 + XDR_QUADLEN(args->taglen);
908 resp->end = rqstp->rq_res.head[0].iov_base + PAGE_SIZE;
909 resp->taglen = args->taglen;
910 resp->tag = args->tag;
913 resp->cstate.minorversion = args->minorversion;
914 resp->cstate.replay_owner = NULL;
915 fh_init(&resp->cstate.current_fh, NFS4_FHSIZE);
916 fh_init(&resp->cstate.save_fh, NFS4_FHSIZE);
917 /* Use the deferral mechanism only for NFSv4.0 compounds */
918 rqstp->rq_usedeferral = (args->minorversion == 0);
921 * According to RFC3010, this takes precedence over all other errors.
923 status = nfserr_minor_vers_mismatch;
924 if (args->minorversion > NFSD_SUPPORTED_MINOR_VERSION)
927 if (!nfs41_op_ordering_ok(args)) {
929 op->status = nfserr_sequence_pos;
934 while (!status && resp->opcnt < args->opcnt) {
935 op = &args->ops[resp->opcnt++];
937 dprintk("nfsv4 compound op #%d/%d: %d (%s)\n",
938 resp->opcnt, args->opcnt, op->opnum,
939 nfsd4_op_name(op->opnum));
941 * The XDR decode routines may have pre-set op->status;
942 * for example, if there is a miscellaneous XDR error
943 * it will be set to nfserr_bad_xdr.
948 /* We must be able to encode a successful response to
949 * this operation, with enough room left over to encode a
950 * failed response to the next operation. If we don't
951 * have enough room, fail with ERR_RESOURCE.
953 slack_bytes = (char *)resp->end - (char *)resp->p;
954 if (slack_bytes < COMPOUND_SLACK_SPACE
955 + COMPOUND_ERR_SLACK_SPACE) {
956 BUG_ON(slack_bytes < COMPOUND_ERR_SLACK_SPACE);
957 op->status = nfserr_resource;
961 opdesc = &nfsd4_ops[op->opnum];
963 if (!cstate->current_fh.fh_dentry) {
964 if (!(opdesc->op_flags & ALLOWED_WITHOUT_FH)) {
965 op->status = nfserr_nofilehandle;
968 } else if (cstate->current_fh.fh_export->ex_fslocs.migrated &&
969 !(opdesc->op_flags & ALLOWED_ON_ABSENT_FS)) {
970 op->status = nfserr_moved;
975 op->status = opdesc->op_func(rqstp, cstate, &op->u);
977 BUG_ON(op->status == nfs_ok);
980 /* Only from SEQUENCE or CREATE_SESSION */
981 if (resp->cstate.status == nfserr_replay_cache) {
982 dprintk("%s NFS4.1 replay from cache\n", __func__);
983 if (nfsd4_not_cached(resp))
984 status = nfsd4_enc_uncached_replay(args, resp);
989 if (op->status == nfserr_replay_me) {
990 op->replay = &cstate->replay_owner->so_replay;
991 nfsd4_encode_replay(resp, op);
992 status = op->status = op->replay->rp_status;
994 nfsd4_encode_operation(resp, op);
998 dprintk("nfsv4 compound op %p opcnt %d #%d: %d: status %d\n",
999 args->ops, args->opcnt, resp->opcnt, op->opnum,
1000 be32_to_cpu(status));
1002 if (cstate->replay_owner) {
1003 nfs4_put_stateowner(cstate->replay_owner);
1004 cstate->replay_owner = NULL;
1006 /* XXX Ugh, we need to get rid of this kind of special case: */
1007 if (op->opnum == OP_READ && op->u.read.rd_filp)
1008 fput(op->u.read.rd_filp);
1010 nfsd4_increment_op_stats(op->opnum);
1012 if (!rqstp->rq_usedeferral && status == nfserr_dropit) {
1013 dprintk("%s Dropit - send NFS4ERR_DELAY\n", __func__);
1014 status = nfserr_jukebox;
1017 resp->cstate.status = status;
1018 fh_put(&resp->cstate.current_fh);
1019 fh_put(&resp->cstate.save_fh);
1020 BUG_ON(resp->cstate.replay_owner);
1022 nfsd4_release_compoundargs(args);
1023 /* Reset deferral mechanism for RPC deferrals */
1024 rqstp->rq_usedeferral = 1;
1025 dprintk("nfsv4 compound returned %d\n", ntohl(status));
1029 static struct nfsd4_operation nfsd4_ops[] = {
1031 .op_func = (nfsd4op_func)nfsd4_access,
1032 .op_name = "OP_ACCESS",
1035 .op_func = (nfsd4op_func)nfsd4_close,
1036 .op_name = "OP_CLOSE",
1039 .op_func = (nfsd4op_func)nfsd4_commit,
1040 .op_name = "OP_COMMIT",
1043 .op_func = (nfsd4op_func)nfsd4_create,
1044 .op_name = "OP_CREATE",
1046 [OP_DELEGRETURN] = {
1047 .op_func = (nfsd4op_func)nfsd4_delegreturn,
1048 .op_name = "OP_DELEGRETURN",
1051 .op_func = (nfsd4op_func)nfsd4_getattr,
1052 .op_flags = ALLOWED_ON_ABSENT_FS,
1053 .op_name = "OP_GETATTR",
1056 .op_func = (nfsd4op_func)nfsd4_getfh,
1057 .op_name = "OP_GETFH",
1060 .op_func = (nfsd4op_func)nfsd4_link,
1061 .op_name = "OP_LINK",
1064 .op_func = (nfsd4op_func)nfsd4_lock,
1065 .op_name = "OP_LOCK",
1068 .op_func = (nfsd4op_func)nfsd4_lockt,
1069 .op_name = "OP_LOCKT",
1072 .op_func = (nfsd4op_func)nfsd4_locku,
1073 .op_name = "OP_LOCKU",
1076 .op_func = (nfsd4op_func)nfsd4_lookup,
1077 .op_name = "OP_LOOKUP",
1080 .op_func = (nfsd4op_func)nfsd4_lookupp,
1081 .op_name = "OP_LOOKUPP",
1084 .op_func = (nfsd4op_func)nfsd4_nverify,
1085 .op_name = "OP_NVERIFY",
1088 .op_func = (nfsd4op_func)nfsd4_open,
1089 .op_name = "OP_OPEN",
1091 [OP_OPEN_CONFIRM] = {
1092 .op_func = (nfsd4op_func)nfsd4_open_confirm,
1093 .op_name = "OP_OPEN_CONFIRM",
1095 [OP_OPEN_DOWNGRADE] = {
1096 .op_func = (nfsd4op_func)nfsd4_open_downgrade,
1097 .op_name = "OP_OPEN_DOWNGRADE",
1100 .op_func = (nfsd4op_func)nfsd4_putfh,
1101 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1102 .op_name = "OP_PUTFH",
1105 .op_func = (nfsd4op_func)nfsd4_putrootfh,
1106 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1107 .op_name = "OP_PUTPUBFH",
1110 .op_func = (nfsd4op_func)nfsd4_putrootfh,
1111 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1112 .op_name = "OP_PUTROOTFH",
1115 .op_func = (nfsd4op_func)nfsd4_read,
1116 .op_name = "OP_READ",
1119 .op_func = (nfsd4op_func)nfsd4_readdir,
1120 .op_name = "OP_READDIR",
1123 .op_func = (nfsd4op_func)nfsd4_readlink,
1124 .op_name = "OP_READLINK",
1127 .op_func = (nfsd4op_func)nfsd4_remove,
1128 .op_name = "OP_REMOVE",
1131 .op_name = "OP_RENAME",
1132 .op_func = (nfsd4op_func)nfsd4_rename,
1135 .op_func = (nfsd4op_func)nfsd4_renew,
1136 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1137 .op_name = "OP_RENEW",
1140 .op_func = (nfsd4op_func)nfsd4_restorefh,
1141 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1142 .op_name = "OP_RESTOREFH",
1145 .op_func = (nfsd4op_func)nfsd4_savefh,
1146 .op_name = "OP_SAVEFH",
1149 .op_func = (nfsd4op_func)nfsd4_secinfo,
1150 .op_name = "OP_SECINFO",
1153 .op_func = (nfsd4op_func)nfsd4_setattr,
1154 .op_name = "OP_SETATTR",
1156 [OP_SETCLIENTID] = {
1157 .op_func = (nfsd4op_func)nfsd4_setclientid,
1158 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1159 .op_name = "OP_SETCLIENTID",
1161 [OP_SETCLIENTID_CONFIRM] = {
1162 .op_func = (nfsd4op_func)nfsd4_setclientid_confirm,
1163 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1164 .op_name = "OP_SETCLIENTID_CONFIRM",
1167 .op_func = (nfsd4op_func)nfsd4_verify,
1168 .op_name = "OP_VERIFY",
1171 .op_func = (nfsd4op_func)nfsd4_write,
1172 .op_name = "OP_WRITE",
1174 [OP_RELEASE_LOCKOWNER] = {
1175 .op_func = (nfsd4op_func)nfsd4_release_lockowner,
1176 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_ON_ABSENT_FS,
1177 .op_name = "OP_RELEASE_LOCKOWNER",
1180 /* NFSv4.1 operations */
1181 [OP_EXCHANGE_ID] = {
1182 .op_func = (nfsd4op_func)nfsd4_exchange_id,
1183 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_AS_FIRST_OP,
1184 .op_name = "OP_EXCHANGE_ID",
1186 [OP_CREATE_SESSION] = {
1187 .op_func = (nfsd4op_func)nfsd4_create_session,
1188 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_AS_FIRST_OP,
1189 .op_name = "OP_CREATE_SESSION",
1191 [OP_DESTROY_SESSION] = {
1192 .op_func = (nfsd4op_func)nfsd4_destroy_session,
1193 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_AS_FIRST_OP,
1194 .op_name = "OP_DESTROY_SESSION",
1197 .op_func = (nfsd4op_func)nfsd4_sequence,
1198 .op_flags = ALLOWED_WITHOUT_FH | ALLOWED_AS_FIRST_OP,
1199 .op_name = "OP_SEQUENCE",
1203 static const char *nfsd4_op_name(unsigned opnum)
1205 if (opnum < ARRAY_SIZE(nfsd4_ops))
1206 return nfsd4_ops[opnum].op_name;
1207 return "unknown_operation";
1210 #define nfs4svc_decode_voidargs NULL
1211 #define nfs4svc_release_void NULL
1212 #define nfsd4_voidres nfsd4_voidargs
1213 #define nfs4svc_release_compound NULL
1214 struct nfsd4_voidargs { int dummy; };
1216 #define PROC(name, argt, rest, relt, cache, respsize) \
1217 { (svc_procfunc) nfsd4_proc_##name, \
1218 (kxdrproc_t) nfs4svc_decode_##argt##args, \
1219 (kxdrproc_t) nfs4svc_encode_##rest##res, \
1220 (kxdrproc_t) nfs4svc_release_##relt, \
1221 sizeof(struct nfsd4_##argt##args), \
1222 sizeof(struct nfsd4_##rest##res), \
1229 * TODO: At the present time, the NFSv4 server does not do XID caching
1230 * of requests. Implementing XID caching would not be a serious problem,
1231 * although it would require a mild change in interfaces since one
1232 * doesn't know whether an NFSv4 request is idempotent until after the
1233 * XDR decode. However, XID caching totally confuses pynfs (Peter
1234 * Astrand's regression testsuite for NFSv4 servers), which reuses
1235 * XID's liberally, so I've left it unimplemented until pynfs generates
1238 static struct svc_procedure nfsd_procedures4[2] = {
1239 PROC(null, void, void, void, RC_NOCACHE, 1),
1240 PROC(compound, compound, compound, compound, RC_NOCACHE, NFSD_BUFSIZE/4)
1243 struct svc_version nfsd_version4 = {
1246 .vs_proc = nfsd_procedures4,
1247 .vs_dispatch = nfsd_dispatch,
1248 .vs_xdrsize = NFS4_SVC_XDRSIZE,