2 * Copyright (c) 2001 The Regents of the University of Michigan.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the University nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include <linux/sunrpc/clnt.h>
35 #include <linux/sunrpc/xprt.h>
36 #include <linux/sunrpc/svc_xprt.h>
37 #include <linux/slab.h>
44 #define NFSDDBG_FACILITY NFSDDBG_PROC
46 static void nfsd4_mark_cb_fault(struct nfs4_client *, int reason);
48 #define NFSPROC4_CB_NULL 0
49 #define NFSPROC4_CB_COMPOUND 1
51 /* Index of predefined Linux callback client operations */
53 struct nfs4_cb_compound_hdr {
55 u32 ident; /* minorversion 0 only */
64 * Handle decode buffer overflows out-of-line.
66 static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
68 dprintk("NFS: %s prematurely hit the end of our receive buffer. "
69 "Remaining buffer length is %tu words.\n",
70 func, xdr->end - xdr->p);
73 static __be32 *xdr_encode_empty_array(__be32 *p)
80 * Encode/decode NFSv4 CB basic data types
82 * Basic NFSv4 callback data types are defined in section 15 of RFC
83 * 3530: "Network File System (NFS) version 4 Protocol" and section
84 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
91 * enum nfs_cb_opnum4 {
99 OP_CB_LAYOUTRECALL = 5,
101 OP_CB_PUSH_DELEG = 7,
102 OP_CB_RECALL_ANY = 8,
103 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
104 OP_CB_RECALL_SLOT = 10,
106 OP_CB_WANTS_CANCELLED = 12,
107 OP_CB_NOTIFY_LOCK = 13,
108 OP_CB_NOTIFY_DEVICEID = 14,
110 OP_CB_ILLEGAL = 10044
113 static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
117 p = xdr_reserve_space(xdr, 4);
118 *p = cpu_to_be32(op);
124 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
126 static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
128 u32 length = fh->fh_size;
131 BUG_ON(length > NFS4_FHSIZE);
132 p = xdr_reserve_space(xdr, 4 + length);
133 xdr_encode_opaque(p, &fh->fh_base, length);
144 static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
148 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
149 *p++ = cpu_to_be32(sid->si_generation);
150 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
156 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
158 static void encode_sessionid4(struct xdr_stream *xdr,
159 const struct nfsd4_session *session)
163 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
164 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
165 NFS4_MAX_SESSIONID_LEN);
171 static const struct {
174 } nfs_cb_errtbl[] = {
176 { NFS4ERR_PERM, -EPERM },
177 { NFS4ERR_NOENT, -ENOENT },
178 { NFS4ERR_IO, -EIO },
179 { NFS4ERR_NXIO, -ENXIO },
180 { NFS4ERR_ACCESS, -EACCES },
181 { NFS4ERR_EXIST, -EEXIST },
182 { NFS4ERR_XDEV, -EXDEV },
183 { NFS4ERR_NOTDIR, -ENOTDIR },
184 { NFS4ERR_ISDIR, -EISDIR },
185 { NFS4ERR_INVAL, -EINVAL },
186 { NFS4ERR_FBIG, -EFBIG },
187 { NFS4ERR_NOSPC, -ENOSPC },
188 { NFS4ERR_ROFS, -EROFS },
189 { NFS4ERR_MLINK, -EMLINK },
190 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
191 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
192 { NFS4ERR_DQUOT, -EDQUOT },
193 { NFS4ERR_STALE, -ESTALE },
194 { NFS4ERR_BADHANDLE, -EBADHANDLE },
195 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
196 { NFS4ERR_NOTSUPP, -ENOTSUPP },
197 { NFS4ERR_TOOSMALL, -ETOOSMALL },
198 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
199 { NFS4ERR_BADTYPE, -EBADTYPE },
200 { NFS4ERR_LOCKED, -EAGAIN },
201 { NFS4ERR_RESOURCE, -EREMOTEIO },
202 { NFS4ERR_SYMLINK, -ELOOP },
203 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
204 { NFS4ERR_DEADLOCK, -EDEADLK },
209 * If we cannot translate the error, the recovery routines should
212 * Note: remaining NFSv4 error codes have values > 10000, so should
213 * not conflict with native Linux error codes.
215 static int nfs_cb_stat_to_errno(int status)
219 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
220 if (nfs_cb_errtbl[i].stat == status)
221 return nfs_cb_errtbl[i].errno;
224 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
228 static int decode_cb_op_status(struct xdr_stream *xdr,
229 enum nfs_cb_opnum4 expected, int *status)
234 p = xdr_inline_decode(xdr, 4 + 4);
235 if (unlikely(p == NULL))
237 op = be32_to_cpup(p++);
238 if (unlikely(op != expected))
240 *status = nfs_cb_stat_to_errno(be32_to_cpup(p));
243 print_overflow_msg(__func__, xdr);
246 dprintk("NFSD: Callback server returned operation %d but "
247 "we issued a request for %d\n", op, expected);
254 * struct CB_COMPOUND4args {
256 * uint32_t minorversion;
257 * uint32_t callback_ident;
258 * nfs_cb_argop4 argarray<>;
261 static void encode_cb_compound4args(struct xdr_stream *xdr,
262 struct nfs4_cb_compound_hdr *hdr)
266 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
267 p = xdr_encode_empty_array(p); /* empty tag */
268 *p++ = cpu_to_be32(hdr->minorversion);
269 *p++ = cpu_to_be32(hdr->ident);
272 *p = cpu_to_be32(hdr->nops); /* argarray element count */
276 * Update argarray element count
278 static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
280 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
281 *hdr->nops_p = cpu_to_be32(hdr->nops);
287 * struct CB_COMPOUND4res {
290 * nfs_cb_resop4 resarray<>;
293 static int decode_cb_compound4res(struct xdr_stream *xdr,
294 struct nfs4_cb_compound_hdr *hdr)
299 p = xdr_inline_decode(xdr, 4 + 4);
300 if (unlikely(p == NULL))
302 hdr->status = be32_to_cpup(p++);
304 length = be32_to_cpup(p++);
305 p = xdr_inline_decode(xdr, length + 4);
306 if (unlikely(p == NULL))
308 p += XDR_QUADLEN(length);
309 hdr->nops = be32_to_cpup(p);
312 print_overflow_msg(__func__, xdr);
319 * struct CB_RECALL4args {
325 static void encode_cb_recall4args(struct xdr_stream *xdr,
326 const struct nfs4_delegation *dp,
327 struct nfs4_cb_compound_hdr *hdr)
331 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
332 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
334 p = xdr_reserve_space(xdr, 4);
335 *p++ = xdr_zero; /* truncate */
337 encode_nfs_fh4(xdr, &dp->dl_stid.sc_file->fi_fhandle);
345 * struct CB_SEQUENCE4args {
346 * sessionid4 csa_sessionid;
347 * sequenceid4 csa_sequenceid;
348 * slotid4 csa_slotid;
349 * slotid4 csa_highest_slotid;
350 * bool csa_cachethis;
351 * referring_call_list4 csa_referring_call_lists<>;
354 static void encode_cb_sequence4args(struct xdr_stream *xdr,
355 const struct nfsd4_callback *cb,
356 struct nfs4_cb_compound_hdr *hdr)
358 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
361 if (hdr->minorversion == 0)
364 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
365 encode_sessionid4(xdr, session);
367 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
368 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
369 *p++ = xdr_zero; /* csa_slotid */
370 *p++ = xdr_zero; /* csa_highest_slotid */
371 *p++ = xdr_zero; /* csa_cachethis */
372 xdr_encode_empty_array(p); /* csa_referring_call_lists */
380 * struct CB_SEQUENCE4resok {
381 * sessionid4 csr_sessionid;
382 * sequenceid4 csr_sequenceid;
383 * slotid4 csr_slotid;
384 * slotid4 csr_highest_slotid;
385 * slotid4 csr_target_highest_slotid;
388 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
390 * CB_SEQUENCE4resok csr_resok4;
395 * Our current back channel implmentation supports a single backchannel
396 * with a single slot.
398 static int decode_cb_sequence4resok(struct xdr_stream *xdr,
399 struct nfsd4_callback *cb)
401 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
402 int status = -ESERVERFAULT;
407 * If the server returns different values for sessionID, slotID or
408 * sequence number, the server is looney tunes.
410 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
411 if (unlikely(p == NULL))
414 if (memcmp(p, session->se_sessionid.data, NFS4_MAX_SESSIONID_LEN)) {
415 dprintk("NFS: %s Invalid session id\n", __func__);
418 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
420 dummy = be32_to_cpup(p++);
421 if (dummy != session->se_cb_seq_nr) {
422 dprintk("NFS: %s Invalid sequence number\n", __func__);
426 dummy = be32_to_cpup(p++);
428 dprintk("NFS: %s Invalid slotid\n", __func__);
433 * FIXME: process highest slotid and target highest slotid
437 cb->cb_seq_status = status;
440 print_overflow_msg(__func__, xdr);
445 static int decode_cb_sequence4res(struct xdr_stream *xdr,
446 struct nfsd4_callback *cb)
450 if (cb->cb_clp->cl_minorversion == 0)
453 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &cb->cb_seq_status);
454 if (unlikely(status || cb->cb_seq_status))
457 return decode_cb_sequence4resok(xdr, cb);
461 * NFSv4.0 and NFSv4.1 XDR encode functions
463 * NFSv4.0 callback argument types are defined in section 15 of RFC
464 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
465 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
470 * NB: Without this zero space reservation, callbacks over krb5p fail
472 static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
473 const void *__unused)
475 xdr_reserve_space(xdr, 0);
479 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
481 static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
484 const struct nfsd4_callback *cb = data;
485 const struct nfs4_delegation *dp = cb_to_delegation(cb);
486 struct nfs4_cb_compound_hdr hdr = {
487 .ident = cb->cb_clp->cl_cb_ident,
488 .minorversion = cb->cb_clp->cl_minorversion,
491 encode_cb_compound4args(xdr, &hdr);
492 encode_cb_sequence4args(xdr, cb, &hdr);
493 encode_cb_recall4args(xdr, dp, &hdr);
494 encode_cb_nops(&hdr);
499 * NFSv4.0 and NFSv4.1 XDR decode functions
501 * NFSv4.0 callback result types are defined in section 15 of RFC
502 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
503 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
507 static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
514 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
516 static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
517 struct xdr_stream *xdr,
520 struct nfsd4_callback *cb = data;
521 struct nfs4_cb_compound_hdr hdr;
524 status = decode_cb_compound4res(xdr, &hdr);
525 if (unlikely(status))
529 status = decode_cb_sequence4res(xdr, cb);
530 if (unlikely(status || cb->cb_seq_status))
534 return decode_cb_op_status(xdr, OP_CB_RECALL, &cb->cb_status);
537 #ifdef CONFIG_NFSD_PNFS
539 * CB_LAYOUTRECALL4args
541 * struct layoutrecall_file4 {
543 * offset4 lor_offset;
544 * length4 lor_length;
545 * stateid4 lor_stateid;
548 * union layoutrecall4 switch(layoutrecall_type4 lor_recalltype) {
549 * case LAYOUTRECALL4_FILE:
550 * layoutrecall_file4 lor_layout;
551 * case LAYOUTRECALL4_FSID:
553 * case LAYOUTRECALL4_ALL:
557 * struct CB_LAYOUTRECALL4args {
558 * layouttype4 clora_type;
559 * layoutiomode4 clora_iomode;
560 * bool clora_changed;
561 * layoutrecall4 clora_recall;
564 static void encode_cb_layout4args(struct xdr_stream *xdr,
565 const struct nfs4_layout_stateid *ls,
566 struct nfs4_cb_compound_hdr *hdr)
570 BUG_ON(hdr->minorversion == 0);
572 p = xdr_reserve_space(xdr, 5 * 4);
573 *p++ = cpu_to_be32(OP_CB_LAYOUTRECALL);
574 *p++ = cpu_to_be32(ls->ls_layout_type);
575 *p++ = cpu_to_be32(IOMODE_ANY);
576 *p++ = cpu_to_be32(1);
577 *p = cpu_to_be32(RETURN_FILE);
579 encode_nfs_fh4(xdr, &ls->ls_stid.sc_file->fi_fhandle);
581 p = xdr_reserve_space(xdr, 2 * 8);
582 p = xdr_encode_hyper(p, 0);
583 xdr_encode_hyper(p, NFS4_MAX_UINT64);
585 encode_stateid4(xdr, &ls->ls_recall_sid);
590 static void nfs4_xdr_enc_cb_layout(struct rpc_rqst *req,
591 struct xdr_stream *xdr,
594 const struct nfsd4_callback *cb = data;
595 const struct nfs4_layout_stateid *ls =
596 container_of(cb, struct nfs4_layout_stateid, ls_recall);
597 struct nfs4_cb_compound_hdr hdr = {
599 .minorversion = cb->cb_clp->cl_minorversion,
602 encode_cb_compound4args(xdr, &hdr);
603 encode_cb_sequence4args(xdr, cb, &hdr);
604 encode_cb_layout4args(xdr, ls, &hdr);
605 encode_cb_nops(&hdr);
608 static int nfs4_xdr_dec_cb_layout(struct rpc_rqst *rqstp,
609 struct xdr_stream *xdr,
612 struct nfsd4_callback *cb = data;
613 struct nfs4_cb_compound_hdr hdr;
616 status = decode_cb_compound4res(xdr, &hdr);
617 if (unlikely(status))
621 status = decode_cb_sequence4res(xdr, cb);
622 if (unlikely(status || cb->cb_seq_status))
625 return decode_cb_op_status(xdr, OP_CB_LAYOUTRECALL, &cb->cb_status);
627 #endif /* CONFIG_NFSD_PNFS */
629 static void encode_stateowner(struct xdr_stream *xdr, struct nfs4_stateowner *so)
633 p = xdr_reserve_space(xdr, 8 + 4 + so->so_owner.len);
634 p = xdr_encode_opaque_fixed(p, &so->so_client->cl_clientid, 8);
635 xdr_encode_opaque(p, so->so_owner.data, so->so_owner.len);
638 static void nfs4_xdr_enc_cb_notify_lock(struct rpc_rqst *req,
639 struct xdr_stream *xdr,
642 const struct nfsd4_callback *cb = data;
643 const struct nfsd4_blocked_lock *nbl =
644 container_of(cb, struct nfsd4_blocked_lock, nbl_cb);
645 struct nfs4_lockowner *lo = (struct nfs4_lockowner *)nbl->nbl_lock.fl_owner;
646 struct nfs4_cb_compound_hdr hdr = {
648 .minorversion = cb->cb_clp->cl_minorversion,
653 BUG_ON(hdr.minorversion == 0);
655 encode_cb_compound4args(xdr, &hdr);
656 encode_cb_sequence4args(xdr, cb, &hdr);
658 p = xdr_reserve_space(xdr, 4);
659 *p = cpu_to_be32(OP_CB_NOTIFY_LOCK);
660 encode_nfs_fh4(xdr, &nbl->nbl_fh);
661 encode_stateowner(xdr, &lo->lo_owner);
664 encode_cb_nops(&hdr);
667 static int nfs4_xdr_dec_cb_notify_lock(struct rpc_rqst *rqstp,
668 struct xdr_stream *xdr,
671 struct nfsd4_callback *cb = data;
672 struct nfs4_cb_compound_hdr hdr;
675 status = decode_cb_compound4res(xdr, &hdr);
676 if (unlikely(status))
680 status = decode_cb_sequence4res(xdr, cb);
681 if (unlikely(status || cb->cb_seq_status))
684 return decode_cb_op_status(xdr, OP_CB_NOTIFY_LOCK, &cb->cb_status);
688 * struct write_response4 {
689 * stateid4 wr_callback_id<1>;
691 * stable_how4 wr_committed;
692 * verifier4 wr_writeverf;
694 * union offload_info4 switch (nfsstat4 coa_status) {
696 * write_response4 coa_resok4;
698 * length4 coa_bytes_copied;
700 * struct CB_OFFLOAD4args {
702 * stateid4 coa_stateid;
703 * offload_info4 coa_offload_info;
706 static void encode_offload_info4(struct xdr_stream *xdr,
708 const struct nfsd4_copy *cp)
712 p = xdr_reserve_space(xdr, 4);
715 p = xdr_reserve_space(xdr, 4 + 8 + 4 + NFS4_VERIFIER_SIZE);
716 p = xdr_encode_empty_array(p);
717 p = xdr_encode_hyper(p, cp->cp_res.wr_bytes_written);
718 *p++ = cpu_to_be32(cp->cp_res.wr_stable_how);
719 p = xdr_encode_opaque_fixed(p, cp->cp_res.wr_verifier.data,
722 p = xdr_reserve_space(xdr, 8);
723 /* We always return success if bytes were written */
724 p = xdr_encode_hyper(p, 0);
728 static void encode_cb_offload4args(struct xdr_stream *xdr,
730 const struct knfsd_fh *fh,
731 const struct nfsd4_copy *cp,
732 struct nfs4_cb_compound_hdr *hdr)
736 p = xdr_reserve_space(xdr, 4);
737 *p++ = cpu_to_be32(OP_CB_OFFLOAD);
738 encode_nfs_fh4(xdr, fh);
739 encode_stateid4(xdr, &cp->cp_res.cb_stateid);
740 encode_offload_info4(xdr, nfserr, cp);
745 static void nfs4_xdr_enc_cb_offload(struct rpc_rqst *req,
746 struct xdr_stream *xdr,
749 const struct nfsd4_callback *cb = data;
750 const struct nfsd4_copy *cp =
751 container_of(cb, struct nfsd4_copy, cp_cb);
752 struct nfs4_cb_compound_hdr hdr = {
754 .minorversion = cb->cb_clp->cl_minorversion,
757 encode_cb_compound4args(xdr, &hdr);
758 encode_cb_sequence4args(xdr, cb, &hdr);
759 encode_cb_offload4args(xdr, cp->nfserr, &cp->fh, cp, &hdr);
760 encode_cb_nops(&hdr);
763 static int nfs4_xdr_dec_cb_offload(struct rpc_rqst *rqstp,
764 struct xdr_stream *xdr,
767 struct nfsd4_callback *cb = data;
768 struct nfs4_cb_compound_hdr hdr;
771 status = decode_cb_compound4res(xdr, &hdr);
772 if (unlikely(status))
776 status = decode_cb_sequence4res(xdr, cb);
777 if (unlikely(status || cb->cb_seq_status))
780 return decode_cb_op_status(xdr, OP_CB_OFFLOAD, &cb->cb_status);
783 * RPC procedure tables
785 #define PROC(proc, call, argtype, restype) \
786 [NFSPROC4_CLNT_##proc] = { \
787 .p_proc = NFSPROC4_CB_##call, \
788 .p_encode = nfs4_xdr_enc_##argtype, \
789 .p_decode = nfs4_xdr_dec_##restype, \
790 .p_arglen = NFS4_enc_##argtype##_sz, \
791 .p_replen = NFS4_dec_##restype##_sz, \
792 .p_statidx = NFSPROC4_CB_##call, \
796 static const struct rpc_procinfo nfs4_cb_procedures[] = {
797 PROC(CB_NULL, NULL, cb_null, cb_null),
798 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
799 #ifdef CONFIG_NFSD_PNFS
800 PROC(CB_LAYOUT, COMPOUND, cb_layout, cb_layout),
802 PROC(CB_NOTIFY_LOCK, COMPOUND, cb_notify_lock, cb_notify_lock),
803 PROC(CB_OFFLOAD, COMPOUND, cb_offload, cb_offload),
806 static unsigned int nfs4_cb_counts[ARRAY_SIZE(nfs4_cb_procedures)];
807 static const struct rpc_version nfs_cb_version4 = {
809 * Note on the callback rpc program version number: despite language in rfc
810 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
811 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
812 * in practice that appears to be what implementations use. The section
813 * 18.36.3 language is expected to be fixed in an erratum.
816 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
817 .procs = nfs4_cb_procedures,
818 .counts = nfs4_cb_counts,
821 static const struct rpc_version *nfs_cb_version[2] = {
822 [1] = &nfs_cb_version4,
825 static const struct rpc_program cb_program;
827 static struct rpc_stat cb_stats = {
828 .program = &cb_program
831 #define NFS4_CALLBACK 0x40000000
832 static const struct rpc_program cb_program = {
834 .number = NFS4_CALLBACK,
835 .nrvers = ARRAY_SIZE(nfs_cb_version),
836 .version = nfs_cb_version,
838 .pipe_dir_name = "nfsd4_cb",
841 static int max_cb_time(struct net *net)
843 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
844 return max(nn->nfsd4_lease/10, (time_t)1) * HZ;
847 static const struct cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
849 if (clp->cl_minorversion == 0) {
850 client->cl_principal = clp->cl_cred.cr_targ_princ ?
851 clp->cl_cred.cr_targ_princ : "nfs";
853 return get_cred(rpc_machine_cred());
857 kcred = prepare_kernel_cred(NULL);
861 kcred->uid = ses->se_cb_sec.uid;
862 kcred->gid = ses->se_cb_sec.gid;
867 static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
869 int maxtime = max_cb_time(clp->net);
870 struct rpc_timeout timeparms = {
871 .to_initval = maxtime,
873 .to_maxval = maxtime,
875 struct rpc_create_args args = {
877 .address = (struct sockaddr *) &conn->cb_addr,
878 .addrsize = conn->cb_addrlen,
879 .saddress = (struct sockaddr *) &conn->cb_saddr,
880 .timeout = &timeparms,
881 .program = &cb_program,
883 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
885 struct rpc_clnt *client;
886 const struct cred *cred;
888 if (clp->cl_minorversion == 0) {
889 if (!clp->cl_cred.cr_principal &&
890 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5))
892 args.client_name = clp->cl_cred.cr_principal;
893 args.prognumber = conn->cb_prog;
894 args.protocol = XPRT_TRANSPORT_TCP;
895 args.authflavor = clp->cl_cred.cr_flavor;
896 clp->cl_cb_ident = conn->cb_ident;
900 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
901 clp->cl_cb_session = ses;
902 args.bc_xprt = conn->cb_xprt;
903 args.prognumber = clp->cl_cb_session->se_cb_prog;
904 args.protocol = conn->cb_xprt->xpt_class->xcl_ident |
906 args.authflavor = ses->se_cb_sec.flavor;
908 /* Create RPC client */
909 client = rpc_create(&args);
910 if (IS_ERR(client)) {
911 dprintk("NFSD: couldn't create callback client: %ld\n",
913 return PTR_ERR(client);
915 cred = get_backchannel_cred(clp, client, ses);
917 rpc_shutdown_client(client);
918 return PTR_ERR(cred);
920 clp->cl_cb_client = client;
921 clp->cl_cb_cred = cred;
925 static void warn_no_callback_path(struct nfs4_client *clp, int reason)
927 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
928 (int)clp->cl_name.len, clp->cl_name.data, reason);
931 static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
933 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
935 clp->cl_cb_state = NFSD4_CB_DOWN;
936 warn_no_callback_path(clp, reason);
939 static void nfsd4_mark_cb_fault(struct nfs4_client *clp, int reason)
941 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
943 clp->cl_cb_state = NFSD4_CB_FAULT;
944 warn_no_callback_path(clp, reason);
947 static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
949 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
952 nfsd4_mark_cb_down(clp, task->tk_status);
954 clp->cl_cb_state = NFSD4_CB_UP;
957 static const struct rpc_call_ops nfsd4_cb_probe_ops = {
958 /* XXX: release method to ensure we set the cb channel down if
959 * necessary on early failure? */
960 .rpc_call_done = nfsd4_cb_probe_done,
963 static struct workqueue_struct *callback_wq;
966 * Poke the callback thread to process any updates to the callback
967 * parameters, and send a null probe.
969 void nfsd4_probe_callback(struct nfs4_client *clp)
971 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
972 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
973 nfsd4_run_cb(&clp->cl_cb_null);
976 void nfsd4_probe_callback_sync(struct nfs4_client *clp)
978 nfsd4_probe_callback(clp);
979 flush_workqueue(callback_wq);
982 void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
984 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
985 spin_lock(&clp->cl_lock);
986 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
987 spin_unlock(&clp->cl_lock);
991 * There's currently a single callback channel slot.
992 * If the slot is available, then mark it busy. Otherwise, set the
993 * thread for sleeping on the callback RPC wait queue.
995 static bool nfsd41_cb_get_slot(struct nfs4_client *clp, struct rpc_task *task)
997 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
998 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
1000 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
1001 dprintk("%s slot is busy\n", __func__);
1004 rpc_wake_up_queued_task(&clp->cl_cb_waitq, task);
1010 * TODO: cb_sequence should support referring call lists, cachethis, multiple
1011 * slots, and mark callback channel down on communication errors.
1013 static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
1015 struct nfsd4_callback *cb = calldata;
1016 struct nfs4_client *clp = cb->cb_clp;
1017 u32 minorversion = clp->cl_minorversion;
1020 * cb_seq_status is only set in decode_cb_sequence4res,
1021 * and so will remain 1 if an rpc level failure occurs.
1023 cb->cb_seq_status = 1;
1026 if (!nfsd41_cb_get_slot(clp, task))
1029 rpc_call_start(task);
1032 static bool nfsd4_cb_sequence_done(struct rpc_task *task, struct nfsd4_callback *cb)
1034 struct nfs4_client *clp = cb->cb_clp;
1035 struct nfsd4_session *session = clp->cl_cb_session;
1038 if (!clp->cl_minorversion) {
1040 * If the backchannel connection was shut down while this
1041 * task was queued, we need to resubmit it after setting up
1042 * a new backchannel connection.
1044 * Note that if we lost our callback connection permanently
1045 * the submission code will error out, so we don't need to
1046 * handle that case here.
1048 if (task->tk_flags & RPC_TASK_KILLED)
1054 switch (cb->cb_seq_status) {
1057 * No need for lock, access serialized in nfsd4_cb_prepare
1060 * If CB_SEQUENCE returns an error, then the state of the slot
1061 * (sequence ID, cached reply) MUST NOT change.
1063 ++session->se_cb_seq_nr;
1066 ++session->se_cb_seq_nr;
1069 case -NFS4ERR_BADSESSION:
1070 nfsd4_mark_cb_fault(cb->cb_clp, cb->cb_seq_status);
1073 case -NFS4ERR_DELAY:
1074 if (!rpc_restart_call(task))
1077 rpc_delay(task, 2 * HZ);
1079 case -NFS4ERR_BADSLOT:
1081 case -NFS4ERR_SEQ_MISORDERED:
1082 if (session->se_cb_seq_nr != 1) {
1083 session->se_cb_seq_nr = 1;
1088 dprintk("%s: unprocessed error %d\n", __func__,
1092 clear_bit(0, &clp->cl_cb_slot_busy);
1093 rpc_wake_up_next(&clp->cl_cb_waitq);
1094 dprintk("%s: freed slot, new seqid=%d\n", __func__,
1095 clp->cl_cb_session->se_cb_seq_nr);
1097 if (task->tk_flags & RPC_TASK_KILLED)
1102 if (rpc_restart_call_prepare(task))
1106 task->tk_status = 0;
1107 cb->cb_need_restart = true;
1111 static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
1113 struct nfsd4_callback *cb = calldata;
1114 struct nfs4_client *clp = cb->cb_clp;
1116 dprintk("%s: minorversion=%d\n", __func__,
1117 clp->cl_minorversion);
1119 if (!nfsd4_cb_sequence_done(task, cb))
1122 if (cb->cb_status) {
1123 WARN_ON_ONCE(task->tk_status);
1124 task->tk_status = cb->cb_status;
1127 switch (cb->cb_ops->done(cb, task)) {
1129 task->tk_status = 0;
1130 rpc_restart_call_prepare(task);
1135 /* Network partition? */
1136 nfsd4_mark_cb_down(clp, task->tk_status);
1143 static void nfsd4_cb_release(void *calldata)
1145 struct nfsd4_callback *cb = calldata;
1147 if (cb->cb_need_restart)
1150 cb->cb_ops->release(cb);
1154 static const struct rpc_call_ops nfsd4_cb_ops = {
1155 .rpc_call_prepare = nfsd4_cb_prepare,
1156 .rpc_call_done = nfsd4_cb_done,
1157 .rpc_release = nfsd4_cb_release,
1160 int nfsd4_create_callback_queue(void)
1162 callback_wq = alloc_ordered_workqueue("nfsd4_callbacks", 0);
1168 void nfsd4_destroy_callback_queue(void)
1170 destroy_workqueue(callback_wq);
1173 /* must be called under the state lock */
1174 void nfsd4_shutdown_callback(struct nfs4_client *clp)
1176 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
1178 * Note this won't actually result in a null callback;
1179 * instead, nfsd4_run_cb_null() will detect the killed
1180 * client, destroy the rpc client, and stop:
1182 nfsd4_run_cb(&clp->cl_cb_null);
1183 flush_workqueue(callback_wq);
1186 /* requires cl_lock: */
1187 static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
1189 struct nfsd4_session *s;
1190 struct nfsd4_conn *c;
1192 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
1193 list_for_each_entry(c, &s->se_conns, cn_persession) {
1194 if (c->cn_flags & NFS4_CDFC4_BACK)
1201 static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
1203 struct nfs4_cb_conn conn;
1204 struct nfs4_client *clp = cb->cb_clp;
1205 struct nfsd4_session *ses = NULL;
1206 struct nfsd4_conn *c;
1210 * This is either an update, or the client dying; in either case,
1211 * kill the old client:
1213 if (clp->cl_cb_client) {
1214 rpc_shutdown_client(clp->cl_cb_client);
1215 clp->cl_cb_client = NULL;
1216 put_cred(clp->cl_cb_cred);
1217 clp->cl_cb_cred = NULL;
1219 if (clp->cl_cb_conn.cb_xprt) {
1220 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
1221 clp->cl_cb_conn.cb_xprt = NULL;
1223 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
1225 spin_lock(&clp->cl_lock);
1227 * Only serialized callback code is allowed to clear these
1228 * flags; main nfsd code can only set them:
1230 BUG_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
1231 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
1232 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
1233 c = __nfsd4_find_backchannel(clp);
1235 svc_xprt_get(c->cn_xprt);
1236 conn.cb_xprt = c->cn_xprt;
1237 ses = c->cn_session;
1239 spin_unlock(&clp->cl_lock);
1241 err = setup_callback_client(clp, &conn, ses);
1243 nfsd4_mark_cb_down(clp, err);
1249 nfsd4_run_cb_work(struct work_struct *work)
1251 struct nfsd4_callback *cb =
1252 container_of(work, struct nfsd4_callback, cb_work);
1253 struct nfs4_client *clp = cb->cb_clp;
1254 struct rpc_clnt *clnt;
1256 if (cb->cb_need_restart) {
1257 cb->cb_need_restart = false;
1259 if (cb->cb_ops && cb->cb_ops->prepare)
1260 cb->cb_ops->prepare(cb);
1263 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
1264 nfsd4_process_cb_update(cb);
1266 clnt = clp->cl_cb_client;
1268 /* Callback channel broken, or client killed; give up: */
1269 if (cb->cb_ops && cb->cb_ops->release)
1270 cb->cb_ops->release(cb);
1275 * Don't send probe messages for 4.1 or later.
1277 if (!cb->cb_ops && clp->cl_minorversion) {
1278 clp->cl_cb_state = NFSD4_CB_UP;
1282 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
1283 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
1284 cb->cb_ops ? &nfsd4_cb_ops : &nfsd4_cb_probe_ops, cb);
1287 void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
1288 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op)
1291 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[op];
1292 cb->cb_msg.rpc_argp = cb;
1293 cb->cb_msg.rpc_resp = cb;
1295 INIT_WORK(&cb->cb_work, nfsd4_run_cb_work);
1296 cb->cb_seq_status = 1;
1298 cb->cb_need_restart = false;
1301 void nfsd4_run_cb(struct nfsd4_callback *cb)
1303 queue_work(callback_wq, &cb->cb_work);