2 * Copyright (c) 2001 The Regents of the University of Michigan.
5 * Kendrick Smith <kmsmith@umich.edu>
6 * Andy Adamson <andros@umich.edu>
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>
43 #define NFSDDBG_FACILITY NFSDDBG_PROC
45 static void nfsd4_mark_cb_fault(struct nfs4_client *, int reason);
47 #define NFSPROC4_CB_NULL 0
48 #define NFSPROC4_CB_COMPOUND 1
50 /* Index of predefined Linux callback client operations */
52 struct nfs4_cb_compound_hdr {
54 u32 ident; /* minorversion 0 only */
63 * Handle decode buffer overflows out-of-line.
65 static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
67 dprintk("NFS: %s prematurely hit the end of our receive buffer. "
68 "Remaining buffer length is %tu words.\n",
69 func, xdr->end - xdr->p);
72 static __be32 *xdr_encode_empty_array(__be32 *p)
79 * Encode/decode NFSv4 CB basic data types
81 * Basic NFSv4 callback data types are defined in section 15 of RFC
82 * 3530: "Network File System (NFS) version 4 Protocol" and section
83 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
90 * enum nfs_cb_opnum4 {
98 OP_CB_LAYOUTRECALL = 5,
100 OP_CB_PUSH_DELEG = 7,
101 OP_CB_RECALL_ANY = 8,
102 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
103 OP_CB_RECALL_SLOT = 10,
105 OP_CB_WANTS_CANCELLED = 12,
106 OP_CB_NOTIFY_LOCK = 13,
107 OP_CB_NOTIFY_DEVICEID = 14,
108 OP_CB_ILLEGAL = 10044
111 static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
115 p = xdr_reserve_space(xdr, 4);
116 *p = cpu_to_be32(op);
122 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
124 static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
126 u32 length = fh->fh_size;
129 BUG_ON(length > NFS4_FHSIZE);
130 p = xdr_reserve_space(xdr, 4 + length);
131 xdr_encode_opaque(p, &fh->fh_base, length);
142 static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
146 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
147 *p++ = cpu_to_be32(sid->si_generation);
148 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
154 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
156 static void encode_sessionid4(struct xdr_stream *xdr,
157 const struct nfsd4_session *session)
161 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
162 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
163 NFS4_MAX_SESSIONID_LEN);
169 static const struct {
172 } nfs_cb_errtbl[] = {
174 { NFS4ERR_PERM, -EPERM },
175 { NFS4ERR_NOENT, -ENOENT },
176 { NFS4ERR_IO, -EIO },
177 { NFS4ERR_NXIO, -ENXIO },
178 { NFS4ERR_ACCESS, -EACCES },
179 { NFS4ERR_EXIST, -EEXIST },
180 { NFS4ERR_XDEV, -EXDEV },
181 { NFS4ERR_NOTDIR, -ENOTDIR },
182 { NFS4ERR_ISDIR, -EISDIR },
183 { NFS4ERR_INVAL, -EINVAL },
184 { NFS4ERR_FBIG, -EFBIG },
185 { NFS4ERR_NOSPC, -ENOSPC },
186 { NFS4ERR_ROFS, -EROFS },
187 { NFS4ERR_MLINK, -EMLINK },
188 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
189 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
190 { NFS4ERR_DQUOT, -EDQUOT },
191 { NFS4ERR_STALE, -ESTALE },
192 { NFS4ERR_BADHANDLE, -EBADHANDLE },
193 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
194 { NFS4ERR_NOTSUPP, -ENOTSUPP },
195 { NFS4ERR_TOOSMALL, -ETOOSMALL },
196 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
197 { NFS4ERR_BADTYPE, -EBADTYPE },
198 { NFS4ERR_LOCKED, -EAGAIN },
199 { NFS4ERR_RESOURCE, -EREMOTEIO },
200 { NFS4ERR_SYMLINK, -ELOOP },
201 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
202 { NFS4ERR_DEADLOCK, -EDEADLK },
207 * If we cannot translate the error, the recovery routines should
210 * Note: remaining NFSv4 error codes have values > 10000, so should
211 * not conflict with native Linux error codes.
213 static int nfs_cb_stat_to_errno(int status)
217 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
218 if (nfs_cb_errtbl[i].stat == status)
219 return nfs_cb_errtbl[i].errno;
222 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
226 static int decode_cb_op_status(struct xdr_stream *xdr, enum nfs_opnum4 expected,
232 p = xdr_inline_decode(xdr, 4 + 4);
233 if (unlikely(p == NULL))
235 op = be32_to_cpup(p++);
236 if (unlikely(op != expected))
238 *status = nfs_cb_stat_to_errno(be32_to_cpup(p));
241 print_overflow_msg(__func__, xdr);
244 dprintk("NFSD: Callback server returned operation %d but "
245 "we issued a request for %d\n", op, expected);
252 * struct CB_COMPOUND4args {
254 * uint32_t minorversion;
255 * uint32_t callback_ident;
256 * nfs_cb_argop4 argarray<>;
259 static void encode_cb_compound4args(struct xdr_stream *xdr,
260 struct nfs4_cb_compound_hdr *hdr)
264 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
265 p = xdr_encode_empty_array(p); /* empty tag */
266 *p++ = cpu_to_be32(hdr->minorversion);
267 *p++ = cpu_to_be32(hdr->ident);
270 *p = cpu_to_be32(hdr->nops); /* argarray element count */
274 * Update argarray element count
276 static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
278 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
279 *hdr->nops_p = cpu_to_be32(hdr->nops);
285 * struct CB_COMPOUND4res {
288 * nfs_cb_resop4 resarray<>;
291 static int decode_cb_compound4res(struct xdr_stream *xdr,
292 struct nfs4_cb_compound_hdr *hdr)
297 p = xdr_inline_decode(xdr, 4 + 4);
298 if (unlikely(p == NULL))
300 hdr->status = be32_to_cpup(p++);
302 length = be32_to_cpup(p++);
303 p = xdr_inline_decode(xdr, length + 4);
304 if (unlikely(p == NULL))
306 hdr->nops = be32_to_cpup(p);
309 print_overflow_msg(__func__, xdr);
316 * struct CB_RECALL4args {
322 static void encode_cb_recall4args(struct xdr_stream *xdr,
323 const struct nfs4_delegation *dp,
324 struct nfs4_cb_compound_hdr *hdr)
328 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
329 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
331 p = xdr_reserve_space(xdr, 4);
332 *p++ = xdr_zero; /* truncate */
334 encode_nfs_fh4(xdr, &dp->dl_stid.sc_file->fi_fhandle);
342 * struct CB_SEQUENCE4args {
343 * sessionid4 csa_sessionid;
344 * sequenceid4 csa_sequenceid;
345 * slotid4 csa_slotid;
346 * slotid4 csa_highest_slotid;
347 * bool csa_cachethis;
348 * referring_call_list4 csa_referring_call_lists<>;
351 static void encode_cb_sequence4args(struct xdr_stream *xdr,
352 const struct nfsd4_callback *cb,
353 struct nfs4_cb_compound_hdr *hdr)
355 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
358 if (hdr->minorversion == 0)
361 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
362 encode_sessionid4(xdr, session);
364 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
365 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
366 *p++ = xdr_zero; /* csa_slotid */
367 *p++ = xdr_zero; /* csa_highest_slotid */
368 *p++ = xdr_zero; /* csa_cachethis */
369 xdr_encode_empty_array(p); /* csa_referring_call_lists */
377 * struct CB_SEQUENCE4resok {
378 * sessionid4 csr_sessionid;
379 * sequenceid4 csr_sequenceid;
380 * slotid4 csr_slotid;
381 * slotid4 csr_highest_slotid;
382 * slotid4 csr_target_highest_slotid;
385 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
387 * CB_SEQUENCE4resok csr_resok4;
392 * Our current back channel implmentation supports a single backchannel
393 * with a single slot.
395 static int decode_cb_sequence4resok(struct xdr_stream *xdr,
396 struct nfsd4_callback *cb)
398 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
399 struct nfs4_sessionid id;
404 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))
413 memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
414 if (memcmp(id.data, session->se_sessionid.data,
415 NFS4_MAX_SESSIONID_LEN) != 0) {
416 dprintk("NFS: %s Invalid session id\n", __func__);
419 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
421 dummy = be32_to_cpup(p++);
422 if (dummy != session->se_cb_seq_nr) {
423 dprintk("NFS: %s Invalid sequence number\n", __func__);
427 dummy = be32_to_cpup(p++);
429 dprintk("NFS: %s Invalid slotid\n", __func__);
434 * FIXME: process highest slotid and target highest slotid
438 cb->cb_seq_status = status;
441 print_overflow_msg(__func__, xdr);
446 static int decode_cb_sequence4res(struct xdr_stream *xdr,
447 struct nfsd4_callback *cb)
451 if (cb->cb_clp->cl_minorversion == 0)
454 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &cb->cb_seq_status);
455 if (unlikely(status || cb->cb_seq_status))
458 return decode_cb_sequence4resok(xdr, cb);
462 * NFSv4.0 and NFSv4.1 XDR encode functions
464 * NFSv4.0 callback argument types are defined in section 15 of RFC
465 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
466 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
471 * NB: Without this zero space reservation, callbacks over krb5p fail
473 static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
476 xdr_reserve_space(xdr, 0);
480 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
482 static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
483 const struct nfsd4_callback *cb)
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,
518 struct nfsd4_callback *cb)
520 struct nfs4_cb_compound_hdr hdr;
523 status = decode_cb_compound4res(xdr, &hdr);
524 if (unlikely(status))
528 status = decode_cb_sequence4res(xdr, cb);
529 if (unlikely(status || cb->cb_seq_status))
533 return decode_cb_op_status(xdr, OP_CB_RECALL, &cb->cb_status);
536 #ifdef CONFIG_NFSD_PNFS
538 * CB_LAYOUTRECALL4args
540 * struct layoutrecall_file4 {
542 * offset4 lor_offset;
543 * length4 lor_length;
544 * stateid4 lor_stateid;
547 * union layoutrecall4 switch(layoutrecall_type4 lor_recalltype) {
548 * case LAYOUTRECALL4_FILE:
549 * layoutrecall_file4 lor_layout;
550 * case LAYOUTRECALL4_FSID:
552 * case LAYOUTRECALL4_ALL:
556 * struct CB_LAYOUTRECALL4args {
557 * layouttype4 clora_type;
558 * layoutiomode4 clora_iomode;
559 * bool clora_changed;
560 * layoutrecall4 clora_recall;
563 static void encode_cb_layout4args(struct xdr_stream *xdr,
564 const struct nfs4_layout_stateid *ls,
565 struct nfs4_cb_compound_hdr *hdr)
569 BUG_ON(hdr->minorversion == 0);
571 p = xdr_reserve_space(xdr, 5 * 4);
572 *p++ = cpu_to_be32(OP_CB_LAYOUTRECALL);
573 *p++ = cpu_to_be32(ls->ls_layout_type);
574 *p++ = cpu_to_be32(IOMODE_ANY);
575 *p++ = cpu_to_be32(1);
576 *p = cpu_to_be32(RETURN_FILE);
578 encode_nfs_fh4(xdr, &ls->ls_stid.sc_file->fi_fhandle);
580 p = xdr_reserve_space(xdr, 2 * 8);
581 p = xdr_encode_hyper(p, 0);
582 xdr_encode_hyper(p, NFS4_MAX_UINT64);
584 encode_stateid4(xdr, &ls->ls_recall_sid);
589 static void nfs4_xdr_enc_cb_layout(struct rpc_rqst *req,
590 struct xdr_stream *xdr,
591 const struct nfsd4_callback *cb)
593 const struct nfs4_layout_stateid *ls =
594 container_of(cb, struct nfs4_layout_stateid, ls_recall);
595 struct nfs4_cb_compound_hdr hdr = {
597 .minorversion = cb->cb_clp->cl_minorversion,
600 encode_cb_compound4args(xdr, &hdr);
601 encode_cb_sequence4args(xdr, cb, &hdr);
602 encode_cb_layout4args(xdr, ls, &hdr);
603 encode_cb_nops(&hdr);
606 static int nfs4_xdr_dec_cb_layout(struct rpc_rqst *rqstp,
607 struct xdr_stream *xdr,
608 struct nfsd4_callback *cb)
610 struct nfs4_cb_compound_hdr hdr;
613 status = decode_cb_compound4res(xdr, &hdr);
614 if (unlikely(status))
618 status = decode_cb_sequence4res(xdr, cb);
619 if (unlikely(status || cb->cb_seq_status))
622 return decode_cb_op_status(xdr, OP_CB_LAYOUTRECALL, &cb->cb_status);
624 #endif /* CONFIG_NFSD_PNFS */
626 static void encode_stateowner(struct xdr_stream *xdr, struct nfs4_stateowner *so)
630 p = xdr_reserve_space(xdr, 8 + 4 + so->so_owner.len);
631 p = xdr_encode_opaque_fixed(p, &so->so_client->cl_clientid, 8);
632 xdr_encode_opaque(p, so->so_owner.data, so->so_owner.len);
635 static void nfs4_xdr_enc_cb_notify_lock(struct rpc_rqst *req,
636 struct xdr_stream *xdr,
637 const struct nfsd4_callback *cb)
639 const struct nfsd4_blocked_lock *nbl =
640 container_of(cb, struct nfsd4_blocked_lock, nbl_cb);
641 struct nfs4_lockowner *lo = (struct nfs4_lockowner *)nbl->nbl_lock.fl_owner;
642 struct nfs4_cb_compound_hdr hdr = {
644 .minorversion = cb->cb_clp->cl_minorversion,
649 BUG_ON(hdr.minorversion == 0);
651 encode_cb_compound4args(xdr, &hdr);
652 encode_cb_sequence4args(xdr, cb, &hdr);
654 p = xdr_reserve_space(xdr, 4);
655 *p = cpu_to_be32(OP_CB_NOTIFY_LOCK);
656 encode_nfs_fh4(xdr, &nbl->nbl_fh);
657 encode_stateowner(xdr, &lo->lo_owner);
660 encode_cb_nops(&hdr);
663 static int nfs4_xdr_dec_cb_notify_lock(struct rpc_rqst *rqstp,
664 struct xdr_stream *xdr,
665 struct nfsd4_callback *cb)
667 struct nfs4_cb_compound_hdr hdr;
670 status = decode_cb_compound4res(xdr, &hdr);
671 if (unlikely(status))
675 status = decode_cb_sequence4res(xdr, cb);
676 if (unlikely(status || cb->cb_seq_status))
679 return decode_cb_op_status(xdr, OP_CB_NOTIFY_LOCK, &cb->cb_status);
683 * RPC procedure tables
685 #define PROC(proc, call, argtype, restype) \
686 [NFSPROC4_CLNT_##proc] = { \
687 .p_proc = NFSPROC4_CB_##call, \
688 .p_encode = (kxdreproc_t)nfs4_xdr_enc_##argtype, \
689 .p_decode = (kxdrdproc_t)nfs4_xdr_dec_##restype, \
690 .p_arglen = NFS4_enc_##argtype##_sz, \
691 .p_replen = NFS4_dec_##restype##_sz, \
692 .p_statidx = NFSPROC4_CB_##call, \
696 static struct rpc_procinfo nfs4_cb_procedures[] = {
697 PROC(CB_NULL, NULL, cb_null, cb_null),
698 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
699 #ifdef CONFIG_NFSD_PNFS
700 PROC(CB_LAYOUT, COMPOUND, cb_layout, cb_layout),
702 PROC(CB_NOTIFY_LOCK, COMPOUND, cb_notify_lock, cb_notify_lock),
705 static struct rpc_version nfs_cb_version4 = {
707 * Note on the callback rpc program version number: despite language in rfc
708 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
709 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
710 * in practice that appears to be what implementations use. The section
711 * 18.36.3 language is expected to be fixed in an erratum.
714 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
715 .procs = nfs4_cb_procedures
718 static const struct rpc_version *nfs_cb_version[] = {
722 static const struct rpc_program cb_program;
724 static struct rpc_stat cb_stats = {
725 .program = &cb_program
728 #define NFS4_CALLBACK 0x40000000
729 static const struct rpc_program cb_program = {
731 .number = NFS4_CALLBACK,
732 .nrvers = ARRAY_SIZE(nfs_cb_version),
733 .version = nfs_cb_version,
735 .pipe_dir_name = "nfsd4_cb",
738 static int max_cb_time(struct net *net)
740 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
741 return max(nn->nfsd4_lease/10, (time_t)1) * HZ;
744 static struct rpc_cred *callback_cred;
746 int set_callback_cred(void)
750 callback_cred = rpc_lookup_machine_cred("nfs");
756 void cleanup_callback_cred(void)
759 put_rpccred(callback_cred);
760 callback_cred = NULL;
764 static struct rpc_cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
766 if (clp->cl_minorversion == 0) {
767 return get_rpccred(callback_cred);
769 struct rpc_auth *auth = client->cl_auth;
770 struct auth_cred acred = {};
772 acred.uid = ses->se_cb_sec.uid;
773 acred.gid = ses->se_cb_sec.gid;
774 return auth->au_ops->lookup_cred(client->cl_auth, &acred, 0);
778 static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
780 int maxtime = max_cb_time(clp->net);
781 struct rpc_timeout timeparms = {
782 .to_initval = maxtime,
784 .to_maxval = maxtime,
786 struct rpc_create_args args = {
788 .address = (struct sockaddr *) &conn->cb_addr,
789 .addrsize = conn->cb_addrlen,
790 .saddress = (struct sockaddr *) &conn->cb_saddr,
791 .timeout = &timeparms,
792 .program = &cb_program,
794 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
796 struct rpc_clnt *client;
797 struct rpc_cred *cred;
799 if (clp->cl_minorversion == 0) {
800 if (!clp->cl_cred.cr_principal &&
801 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5))
803 args.client_name = clp->cl_cred.cr_principal;
804 args.prognumber = conn->cb_prog;
805 args.protocol = XPRT_TRANSPORT_TCP;
806 args.authflavor = clp->cl_cred.cr_flavor;
807 clp->cl_cb_ident = conn->cb_ident;
811 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
812 clp->cl_cb_session = ses;
813 args.bc_xprt = conn->cb_xprt;
814 args.prognumber = clp->cl_cb_session->se_cb_prog;
815 args.protocol = conn->cb_xprt->xpt_class->xcl_ident |
817 args.authflavor = ses->se_cb_sec.flavor;
819 /* Create RPC client */
820 client = rpc_create(&args);
821 if (IS_ERR(client)) {
822 dprintk("NFSD: couldn't create callback client: %ld\n",
824 return PTR_ERR(client);
826 cred = get_backchannel_cred(clp, client, ses);
828 rpc_shutdown_client(client);
829 return PTR_ERR(cred);
831 clp->cl_cb_client = client;
832 clp->cl_cb_cred = cred;
836 static void warn_no_callback_path(struct nfs4_client *clp, int reason)
838 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
839 (int)clp->cl_name.len, clp->cl_name.data, reason);
842 static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
844 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
846 clp->cl_cb_state = NFSD4_CB_DOWN;
847 warn_no_callback_path(clp, reason);
850 static void nfsd4_mark_cb_fault(struct nfs4_client *clp, int reason)
852 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
854 clp->cl_cb_state = NFSD4_CB_FAULT;
855 warn_no_callback_path(clp, reason);
858 static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
860 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
863 nfsd4_mark_cb_down(clp, task->tk_status);
865 clp->cl_cb_state = NFSD4_CB_UP;
868 static const struct rpc_call_ops nfsd4_cb_probe_ops = {
869 /* XXX: release method to ensure we set the cb channel down if
870 * necessary on early failure? */
871 .rpc_call_done = nfsd4_cb_probe_done,
874 static struct workqueue_struct *callback_wq;
877 * Poke the callback thread to process any updates to the callback
878 * parameters, and send a null probe.
880 void nfsd4_probe_callback(struct nfs4_client *clp)
882 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
883 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
884 nfsd4_run_cb(&clp->cl_cb_null);
887 void nfsd4_probe_callback_sync(struct nfs4_client *clp)
889 nfsd4_probe_callback(clp);
890 flush_workqueue(callback_wq);
893 void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
895 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
896 spin_lock(&clp->cl_lock);
897 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
898 spin_unlock(&clp->cl_lock);
902 * There's currently a single callback channel slot.
903 * If the slot is available, then mark it busy. Otherwise, set the
904 * thread for sleeping on the callback RPC wait queue.
906 static bool nfsd41_cb_get_slot(struct nfs4_client *clp, struct rpc_task *task)
908 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
909 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
911 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
912 dprintk("%s slot is busy\n", __func__);
915 rpc_wake_up_queued_task(&clp->cl_cb_waitq, task);
921 * TODO: cb_sequence should support referring call lists, cachethis, multiple
922 * slots, and mark callback channel down on communication errors.
924 static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
926 struct nfsd4_callback *cb = calldata;
927 struct nfs4_client *clp = cb->cb_clp;
928 u32 minorversion = clp->cl_minorversion;
931 * cb_seq_status is only set in decode_cb_sequence4res,
932 * and so will remain 1 if an rpc level failure occurs.
934 cb->cb_seq_status = 1;
937 if (!cb->cb_holds_slot && !nfsd41_cb_get_slot(clp, task))
939 cb->cb_holds_slot = true;
941 rpc_call_start(task);
944 static bool nfsd4_cb_sequence_done(struct rpc_task *task, struct nfsd4_callback *cb)
946 struct nfs4_client *clp = cb->cb_clp;
947 struct nfsd4_session *session = clp->cl_cb_session;
950 if (!clp->cl_minorversion) {
952 * If the backchannel connection was shut down while this
953 * task was queued, we need to resubmit it after setting up
954 * a new backchannel connection.
956 * Note that if we lost our callback connection permanently
957 * the submission code will error out, so we don't need to
958 * handle that case here.
960 if (task->tk_flags & RPC_TASK_KILLED)
966 if (!cb->cb_holds_slot)
969 switch (cb->cb_seq_status) {
972 * No need for lock, access serialized in nfsd4_cb_prepare
975 * If CB_SEQUENCE returns an error, then the state of the slot
976 * (sequence ID, cached reply) MUST NOT change.
978 ++session->se_cb_seq_nr;
981 ++session->se_cb_seq_nr;
983 case -NFS4ERR_BADSESSION:
984 nfsd4_mark_cb_fault(cb->cb_clp, cb->cb_seq_status);
988 if (!rpc_restart_call(task))
991 rpc_delay(task, 2 * HZ);
993 case -NFS4ERR_BADSLOT:
995 case -NFS4ERR_SEQ_MISORDERED:
996 if (session->se_cb_seq_nr != 1) {
997 session->se_cb_seq_nr = 1;
1002 dprintk("%s: unprocessed error %d\n", __func__,
1006 cb->cb_holds_slot = false;
1007 clear_bit(0, &clp->cl_cb_slot_busy);
1008 rpc_wake_up_next(&clp->cl_cb_waitq);
1009 dprintk("%s: freed slot, new seqid=%d\n", __func__,
1010 clp->cl_cb_session->se_cb_seq_nr);
1012 if (task->tk_flags & RPC_TASK_KILLED)
1017 if (rpc_restart_call_prepare(task))
1021 task->tk_status = 0;
1022 cb->cb_need_restart = true;
1026 static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
1028 struct nfsd4_callback *cb = calldata;
1029 struct nfs4_client *clp = cb->cb_clp;
1031 dprintk("%s: minorversion=%d\n", __func__,
1032 clp->cl_minorversion);
1034 if (!nfsd4_cb_sequence_done(task, cb))
1037 if (cb->cb_status) {
1038 WARN_ON_ONCE(task->tk_status);
1039 task->tk_status = cb->cb_status;
1042 switch (cb->cb_ops->done(cb, task)) {
1044 task->tk_status = 0;
1045 rpc_restart_call_prepare(task);
1050 /* Network partition? */
1051 nfsd4_mark_cb_down(clp, task->tk_status);
1058 static void nfsd4_cb_release(void *calldata)
1060 struct nfsd4_callback *cb = calldata;
1062 if (cb->cb_need_restart)
1065 cb->cb_ops->release(cb);
1069 static const struct rpc_call_ops nfsd4_cb_ops = {
1070 .rpc_call_prepare = nfsd4_cb_prepare,
1071 .rpc_call_done = nfsd4_cb_done,
1072 .rpc_release = nfsd4_cb_release,
1075 int nfsd4_create_callback_queue(void)
1077 callback_wq = create_singlethread_workqueue("nfsd4_callbacks");
1083 void nfsd4_destroy_callback_queue(void)
1085 destroy_workqueue(callback_wq);
1088 /* must be called under the state lock */
1089 void nfsd4_shutdown_callback(struct nfs4_client *clp)
1091 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
1093 * Note this won't actually result in a null callback;
1094 * instead, nfsd4_run_cb_null() will detect the killed
1095 * client, destroy the rpc client, and stop:
1097 nfsd4_run_cb(&clp->cl_cb_null);
1098 flush_workqueue(callback_wq);
1101 /* requires cl_lock: */
1102 static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
1104 struct nfsd4_session *s;
1105 struct nfsd4_conn *c;
1107 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
1108 list_for_each_entry(c, &s->se_conns, cn_persession) {
1109 if (c->cn_flags & NFS4_CDFC4_BACK)
1116 static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
1118 struct nfs4_cb_conn conn;
1119 struct nfs4_client *clp = cb->cb_clp;
1120 struct nfsd4_session *ses = NULL;
1121 struct nfsd4_conn *c;
1125 * This is either an update, or the client dying; in either case,
1126 * kill the old client:
1128 if (clp->cl_cb_client) {
1129 rpc_shutdown_client(clp->cl_cb_client);
1130 clp->cl_cb_client = NULL;
1131 put_rpccred(clp->cl_cb_cred);
1132 clp->cl_cb_cred = NULL;
1134 if (clp->cl_cb_conn.cb_xprt) {
1135 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
1136 clp->cl_cb_conn.cb_xprt = NULL;
1138 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
1140 spin_lock(&clp->cl_lock);
1142 * Only serialized callback code is allowed to clear these
1143 * flags; main nfsd code can only set them:
1145 BUG_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
1146 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
1147 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
1148 c = __nfsd4_find_backchannel(clp);
1150 svc_xprt_get(c->cn_xprt);
1151 conn.cb_xprt = c->cn_xprt;
1152 ses = c->cn_session;
1154 spin_unlock(&clp->cl_lock);
1156 err = setup_callback_client(clp, &conn, ses);
1158 nfsd4_mark_cb_down(clp, err);
1160 svc_xprt_put(c->cn_xprt);
1166 nfsd4_run_cb_work(struct work_struct *work)
1168 struct nfsd4_callback *cb =
1169 container_of(work, struct nfsd4_callback, cb_work);
1170 struct nfs4_client *clp = cb->cb_clp;
1171 struct rpc_clnt *clnt;
1173 if (cb->cb_need_restart) {
1174 cb->cb_need_restart = false;
1176 if (cb->cb_ops && cb->cb_ops->prepare)
1177 cb->cb_ops->prepare(cb);
1180 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
1181 nfsd4_process_cb_update(cb);
1183 clnt = clp->cl_cb_client;
1185 /* Callback channel broken, or client killed; give up: */
1186 if (cb->cb_ops && cb->cb_ops->release)
1187 cb->cb_ops->release(cb);
1192 * Don't send probe messages for 4.1 or later.
1194 if (!cb->cb_ops && clp->cl_minorversion) {
1195 clp->cl_cb_state = NFSD4_CB_UP;
1199 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
1200 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
1201 cb->cb_ops ? &nfsd4_cb_ops : &nfsd4_cb_probe_ops, cb);
1204 void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
1205 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op)
1208 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[op];
1209 cb->cb_msg.rpc_argp = cb;
1210 cb->cb_msg.rpc_resp = cb;
1212 INIT_WORK(&cb->cb_work, nfsd4_run_cb_work);
1213 cb->cb_seq_status = 1;
1215 cb->cb_need_restart = false;
1216 cb->cb_holds_slot = false;
1219 void nfsd4_run_cb(struct nfsd4_callback *cb)
1221 queue_work(callback_wq, &cb->cb_work);