Loading...
1/*
2 * Copyright (c) 2001 The Regents of the University of Michigan.
3 * All rights reserved.
4 *
5 * Kendrick Smith <kmsmith@umich.edu>
6 * Andy Adamson <andros@umich.edu>
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
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.
20 *
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.
32 */
33
34#include <linux/sunrpc/clnt.h>
35#include <linux/sunrpc/xprt.h>
36#include <linux/sunrpc/svc_xprt.h>
37#include <linux/slab.h>
38#include "nfsd.h"
39#include "state.h"
40#include "netns.h"
41#include "xdr4cb.h"
42
43#define NFSDDBG_FACILITY NFSDDBG_PROC
44
45static void nfsd4_mark_cb_fault(struct nfs4_client *, int reason);
46
47#define NFSPROC4_CB_NULL 0
48#define NFSPROC4_CB_COMPOUND 1
49
50/* Index of predefined Linux callback client operations */
51
52enum {
53 NFSPROC4_CLNT_CB_NULL = 0,
54 NFSPROC4_CLNT_CB_RECALL,
55 NFSPROC4_CLNT_CB_SEQUENCE,
56};
57
58struct nfs4_cb_compound_hdr {
59 /* args */
60 u32 ident; /* minorversion 0 only */
61 u32 nops;
62 __be32 *nops_p;
63 u32 minorversion;
64 /* res */
65 int status;
66};
67
68/*
69 * Handle decode buffer overflows out-of-line.
70 */
71static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
72{
73 dprintk("NFS: %s prematurely hit the end of our receive buffer. "
74 "Remaining buffer length is %tu words.\n",
75 func, xdr->end - xdr->p);
76}
77
78static __be32 *xdr_encode_empty_array(__be32 *p)
79{
80 *p++ = xdr_zero;
81 return p;
82}
83
84/*
85 * Encode/decode NFSv4 CB basic data types
86 *
87 * Basic NFSv4 callback data types are defined in section 15 of RFC
88 * 3530: "Network File System (NFS) version 4 Protocol" and section
89 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
90 * 1 Protocol"
91 */
92
93/*
94 * nfs_cb_opnum4
95 *
96 * enum nfs_cb_opnum4 {
97 * OP_CB_GETATTR = 3,
98 * ...
99 * };
100 */
101enum nfs_cb_opnum4 {
102 OP_CB_GETATTR = 3,
103 OP_CB_RECALL = 4,
104 OP_CB_LAYOUTRECALL = 5,
105 OP_CB_NOTIFY = 6,
106 OP_CB_PUSH_DELEG = 7,
107 OP_CB_RECALL_ANY = 8,
108 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
109 OP_CB_RECALL_SLOT = 10,
110 OP_CB_SEQUENCE = 11,
111 OP_CB_WANTS_CANCELLED = 12,
112 OP_CB_NOTIFY_LOCK = 13,
113 OP_CB_NOTIFY_DEVICEID = 14,
114 OP_CB_ILLEGAL = 10044
115};
116
117static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
118{
119 __be32 *p;
120
121 p = xdr_reserve_space(xdr, 4);
122 *p = cpu_to_be32(op);
123}
124
125/*
126 * nfs_fh4
127 *
128 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
129 */
130static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
131{
132 u32 length = fh->fh_size;
133 __be32 *p;
134
135 BUG_ON(length > NFS4_FHSIZE);
136 p = xdr_reserve_space(xdr, 4 + length);
137 xdr_encode_opaque(p, &fh->fh_base, length);
138}
139
140/*
141 * stateid4
142 *
143 * struct stateid4 {
144 * uint32_t seqid;
145 * opaque other[12];
146 * };
147 */
148static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
149{
150 __be32 *p;
151
152 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
153 *p++ = cpu_to_be32(sid->si_generation);
154 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
155}
156
157/*
158 * sessionid4
159 *
160 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
161 */
162static void encode_sessionid4(struct xdr_stream *xdr,
163 const struct nfsd4_session *session)
164{
165 __be32 *p;
166
167 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
168 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
169 NFS4_MAX_SESSIONID_LEN);
170}
171
172/*
173 * nfsstat4
174 */
175static const struct {
176 int stat;
177 int errno;
178} nfs_cb_errtbl[] = {
179 { NFS4_OK, 0 },
180 { NFS4ERR_PERM, -EPERM },
181 { NFS4ERR_NOENT, -ENOENT },
182 { NFS4ERR_IO, -EIO },
183 { NFS4ERR_NXIO, -ENXIO },
184 { NFS4ERR_ACCESS, -EACCES },
185 { NFS4ERR_EXIST, -EEXIST },
186 { NFS4ERR_XDEV, -EXDEV },
187 { NFS4ERR_NOTDIR, -ENOTDIR },
188 { NFS4ERR_ISDIR, -EISDIR },
189 { NFS4ERR_INVAL, -EINVAL },
190 { NFS4ERR_FBIG, -EFBIG },
191 { NFS4ERR_NOSPC, -ENOSPC },
192 { NFS4ERR_ROFS, -EROFS },
193 { NFS4ERR_MLINK, -EMLINK },
194 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
195 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
196 { NFS4ERR_DQUOT, -EDQUOT },
197 { NFS4ERR_STALE, -ESTALE },
198 { NFS4ERR_BADHANDLE, -EBADHANDLE },
199 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
200 { NFS4ERR_NOTSUPP, -ENOTSUPP },
201 { NFS4ERR_TOOSMALL, -ETOOSMALL },
202 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
203 { NFS4ERR_BADTYPE, -EBADTYPE },
204 { NFS4ERR_LOCKED, -EAGAIN },
205 { NFS4ERR_RESOURCE, -EREMOTEIO },
206 { NFS4ERR_SYMLINK, -ELOOP },
207 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
208 { NFS4ERR_DEADLOCK, -EDEADLK },
209 { -1, -EIO }
210};
211
212/*
213 * If we cannot translate the error, the recovery routines should
214 * handle it.
215 *
216 * Note: remaining NFSv4 error codes have values > 10000, so should
217 * not conflict with native Linux error codes.
218 */
219static int nfs_cb_stat_to_errno(int status)
220{
221 int i;
222
223 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
224 if (nfs_cb_errtbl[i].stat == status)
225 return nfs_cb_errtbl[i].errno;
226 }
227
228 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
229 return -status;
230}
231
232static int decode_cb_op_status(struct xdr_stream *xdr, enum nfs_opnum4 expected,
233 enum nfsstat4 *status)
234{
235 __be32 *p;
236 u32 op;
237
238 p = xdr_inline_decode(xdr, 4 + 4);
239 if (unlikely(p == NULL))
240 goto out_overflow;
241 op = be32_to_cpup(p++);
242 if (unlikely(op != expected))
243 goto out_unexpected;
244 *status = be32_to_cpup(p);
245 return 0;
246out_overflow:
247 print_overflow_msg(__func__, xdr);
248 return -EIO;
249out_unexpected:
250 dprintk("NFSD: Callback server returned operation %d but "
251 "we issued a request for %d\n", op, expected);
252 return -EIO;
253}
254
255/*
256 * CB_COMPOUND4args
257 *
258 * struct CB_COMPOUND4args {
259 * utf8str_cs tag;
260 * uint32_t minorversion;
261 * uint32_t callback_ident;
262 * nfs_cb_argop4 argarray<>;
263 * };
264*/
265static void encode_cb_compound4args(struct xdr_stream *xdr,
266 struct nfs4_cb_compound_hdr *hdr)
267{
268 __be32 * p;
269
270 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
271 p = xdr_encode_empty_array(p); /* empty tag */
272 *p++ = cpu_to_be32(hdr->minorversion);
273 *p++ = cpu_to_be32(hdr->ident);
274
275 hdr->nops_p = p;
276 *p = cpu_to_be32(hdr->nops); /* argarray element count */
277}
278
279/*
280 * Update argarray element count
281 */
282static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
283{
284 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
285 *hdr->nops_p = cpu_to_be32(hdr->nops);
286}
287
288/*
289 * CB_COMPOUND4res
290 *
291 * struct CB_COMPOUND4res {
292 * nfsstat4 status;
293 * utf8str_cs tag;
294 * nfs_cb_resop4 resarray<>;
295 * };
296 */
297static int decode_cb_compound4res(struct xdr_stream *xdr,
298 struct nfs4_cb_compound_hdr *hdr)
299{
300 u32 length;
301 __be32 *p;
302
303 p = xdr_inline_decode(xdr, 4 + 4);
304 if (unlikely(p == NULL))
305 goto out_overflow;
306 hdr->status = be32_to_cpup(p++);
307 /* Ignore the tag */
308 length = be32_to_cpup(p++);
309 p = xdr_inline_decode(xdr, length + 4);
310 if (unlikely(p == NULL))
311 goto out_overflow;
312 hdr->nops = be32_to_cpup(p);
313 return 0;
314out_overflow:
315 print_overflow_msg(__func__, xdr);
316 return -EIO;
317}
318
319/*
320 * CB_RECALL4args
321 *
322 * struct CB_RECALL4args {
323 * stateid4 stateid;
324 * bool truncate;
325 * nfs_fh4 fh;
326 * };
327 */
328static void encode_cb_recall4args(struct xdr_stream *xdr,
329 const struct nfs4_delegation *dp,
330 struct nfs4_cb_compound_hdr *hdr)
331{
332 __be32 *p;
333
334 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
335 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
336
337 p = xdr_reserve_space(xdr, 4);
338 *p++ = xdr_zero; /* truncate */
339
340 encode_nfs_fh4(xdr, &dp->dl_fh);
341
342 hdr->nops++;
343}
344
345/*
346 * CB_SEQUENCE4args
347 *
348 * struct CB_SEQUENCE4args {
349 * sessionid4 csa_sessionid;
350 * sequenceid4 csa_sequenceid;
351 * slotid4 csa_slotid;
352 * slotid4 csa_highest_slotid;
353 * bool csa_cachethis;
354 * referring_call_list4 csa_referring_call_lists<>;
355 * };
356 */
357static void encode_cb_sequence4args(struct xdr_stream *xdr,
358 const struct nfsd4_callback *cb,
359 struct nfs4_cb_compound_hdr *hdr)
360{
361 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
362 __be32 *p;
363
364 if (hdr->minorversion == 0)
365 return;
366
367 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
368 encode_sessionid4(xdr, session);
369
370 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
371 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
372 *p++ = xdr_zero; /* csa_slotid */
373 *p++ = xdr_zero; /* csa_highest_slotid */
374 *p++ = xdr_zero; /* csa_cachethis */
375 xdr_encode_empty_array(p); /* csa_referring_call_lists */
376
377 hdr->nops++;
378}
379
380/*
381 * CB_SEQUENCE4resok
382 *
383 * struct CB_SEQUENCE4resok {
384 * sessionid4 csr_sessionid;
385 * sequenceid4 csr_sequenceid;
386 * slotid4 csr_slotid;
387 * slotid4 csr_highest_slotid;
388 * slotid4 csr_target_highest_slotid;
389 * };
390 *
391 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
392 * case NFS4_OK:
393 * CB_SEQUENCE4resok csr_resok4;
394 * default:
395 * void;
396 * };
397 *
398 * Our current back channel implmentation supports a single backchannel
399 * with a single slot.
400 */
401static int decode_cb_sequence4resok(struct xdr_stream *xdr,
402 struct nfsd4_callback *cb)
403{
404 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
405 struct nfs4_sessionid id;
406 int status;
407 __be32 *p;
408 u32 dummy;
409
410 status = -ESERVERFAULT;
411
412 /*
413 * If the server returns different values for sessionID, slotID or
414 * sequence number, the server is looney tunes.
415 */
416 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
417 if (unlikely(p == NULL))
418 goto out_overflow;
419 memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
420 if (memcmp(id.data, session->se_sessionid.data,
421 NFS4_MAX_SESSIONID_LEN) != 0) {
422 dprintk("NFS: %s Invalid session id\n", __func__);
423 goto out;
424 }
425 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
426
427 dummy = be32_to_cpup(p++);
428 if (dummy != session->se_cb_seq_nr) {
429 dprintk("NFS: %s Invalid sequence number\n", __func__);
430 goto out;
431 }
432
433 dummy = be32_to_cpup(p++);
434 if (dummy != 0) {
435 dprintk("NFS: %s Invalid slotid\n", __func__);
436 goto out;
437 }
438
439 /*
440 * FIXME: process highest slotid and target highest slotid
441 */
442 status = 0;
443out:
444 if (status)
445 nfsd4_mark_cb_fault(cb->cb_clp, status);
446 return status;
447out_overflow:
448 print_overflow_msg(__func__, xdr);
449 return -EIO;
450}
451
452static int decode_cb_sequence4res(struct xdr_stream *xdr,
453 struct nfsd4_callback *cb)
454{
455 enum nfsstat4 nfserr;
456 int status;
457
458 if (cb->cb_minorversion == 0)
459 return 0;
460
461 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &nfserr);
462 if (unlikely(status))
463 goto out;
464 if (unlikely(nfserr != NFS4_OK))
465 goto out_default;
466 status = decode_cb_sequence4resok(xdr, cb);
467out:
468 return status;
469out_default:
470 return nfs_cb_stat_to_errno(nfserr);
471}
472
473/*
474 * NFSv4.0 and NFSv4.1 XDR encode functions
475 *
476 * NFSv4.0 callback argument types are defined in section 15 of RFC
477 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
478 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
479 * Protocol".
480 */
481
482/*
483 * NB: Without this zero space reservation, callbacks over krb5p fail
484 */
485static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
486 void *__unused)
487{
488 xdr_reserve_space(xdr, 0);
489}
490
491/*
492 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
493 */
494static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
495 const struct nfsd4_callback *cb)
496{
497 const struct nfs4_delegation *args = cb->cb_op;
498 struct nfs4_cb_compound_hdr hdr = {
499 .ident = cb->cb_clp->cl_cb_ident,
500 .minorversion = cb->cb_minorversion,
501 };
502
503 encode_cb_compound4args(xdr, &hdr);
504 encode_cb_sequence4args(xdr, cb, &hdr);
505 encode_cb_recall4args(xdr, args, &hdr);
506 encode_cb_nops(&hdr);
507}
508
509
510/*
511 * NFSv4.0 and NFSv4.1 XDR decode functions
512 *
513 * NFSv4.0 callback result types are defined in section 15 of RFC
514 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
515 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
516 * Protocol".
517 */
518
519static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
520 void *__unused)
521{
522 return 0;
523}
524
525/*
526 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
527 */
528static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
529 struct xdr_stream *xdr,
530 struct nfsd4_callback *cb)
531{
532 struct nfs4_cb_compound_hdr hdr;
533 enum nfsstat4 nfserr;
534 int status;
535
536 status = decode_cb_compound4res(xdr, &hdr);
537 if (unlikely(status))
538 goto out;
539
540 if (cb != NULL) {
541 status = decode_cb_sequence4res(xdr, cb);
542 if (unlikely(status))
543 goto out;
544 }
545
546 status = decode_cb_op_status(xdr, OP_CB_RECALL, &nfserr);
547 if (unlikely(status))
548 goto out;
549 if (unlikely(nfserr != NFS4_OK))
550 status = nfs_cb_stat_to_errno(nfserr);
551out:
552 return status;
553}
554
555/*
556 * RPC procedure tables
557 */
558#define PROC(proc, call, argtype, restype) \
559[NFSPROC4_CLNT_##proc] = { \
560 .p_proc = NFSPROC4_CB_##call, \
561 .p_encode = (kxdreproc_t)nfs4_xdr_enc_##argtype, \
562 .p_decode = (kxdrdproc_t)nfs4_xdr_dec_##restype, \
563 .p_arglen = NFS4_enc_##argtype##_sz, \
564 .p_replen = NFS4_dec_##restype##_sz, \
565 .p_statidx = NFSPROC4_CB_##call, \
566 .p_name = #proc, \
567}
568
569static struct rpc_procinfo nfs4_cb_procedures[] = {
570 PROC(CB_NULL, NULL, cb_null, cb_null),
571 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
572};
573
574static struct rpc_version nfs_cb_version4 = {
575/*
576 * Note on the callback rpc program version number: despite language in rfc
577 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
578 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
579 * in practice that appears to be what implementations use. The section
580 * 18.36.3 language is expected to be fixed in an erratum.
581 */
582 .number = 1,
583 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
584 .procs = nfs4_cb_procedures
585};
586
587static const struct rpc_version *nfs_cb_version[] = {
588 &nfs_cb_version4,
589};
590
591static const struct rpc_program cb_program;
592
593static struct rpc_stat cb_stats = {
594 .program = &cb_program
595};
596
597#define NFS4_CALLBACK 0x40000000
598static const struct rpc_program cb_program = {
599 .name = "nfs4_cb",
600 .number = NFS4_CALLBACK,
601 .nrvers = ARRAY_SIZE(nfs_cb_version),
602 .version = nfs_cb_version,
603 .stats = &cb_stats,
604 .pipe_dir_name = "nfsd4_cb",
605};
606
607static int max_cb_time(struct net *net)
608{
609 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
610 return max(nn->nfsd4_lease/10, (time_t)1) * HZ;
611}
612
613static struct rpc_cred *callback_cred;
614
615int set_callback_cred(void)
616{
617 if (callback_cred)
618 return 0;
619 callback_cred = rpc_lookup_machine_cred("nfs");
620 if (!callback_cred)
621 return -ENOMEM;
622 return 0;
623}
624
625static struct rpc_cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
626{
627 if (clp->cl_minorversion == 0) {
628 return get_rpccred(callback_cred);
629 } else {
630 struct rpc_auth *auth = client->cl_auth;
631 struct auth_cred acred = {};
632
633 acred.uid = ses->se_cb_sec.uid;
634 acred.gid = ses->se_cb_sec.gid;
635 return auth->au_ops->lookup_cred(client->cl_auth, &acred, 0);
636 }
637}
638
639static struct rpc_clnt *create_backchannel_client(struct rpc_create_args *args)
640{
641 struct rpc_xprt *xprt;
642
643 if (args->protocol != XPRT_TRANSPORT_BC_TCP)
644 return rpc_create(args);
645
646 xprt = args->bc_xprt->xpt_bc_xprt;
647 if (xprt) {
648 xprt_get(xprt);
649 return rpc_create_xprt(args, xprt);
650 }
651
652 return rpc_create(args);
653}
654
655static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
656{
657 int maxtime = max_cb_time(clp->net);
658 struct rpc_timeout timeparms = {
659 .to_initval = maxtime,
660 .to_retries = 0,
661 .to_maxval = maxtime,
662 };
663 struct rpc_create_args args = {
664 .net = clp->net,
665 .address = (struct sockaddr *) &conn->cb_addr,
666 .addrsize = conn->cb_addrlen,
667 .saddress = (struct sockaddr *) &conn->cb_saddr,
668 .timeout = &timeparms,
669 .program = &cb_program,
670 .version = 0,
671 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
672 };
673 struct rpc_clnt *client;
674 struct rpc_cred *cred;
675
676 if (clp->cl_minorversion == 0) {
677 if (!clp->cl_cred.cr_principal &&
678 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5))
679 return -EINVAL;
680 args.client_name = clp->cl_cred.cr_principal;
681 args.prognumber = conn->cb_prog,
682 args.protocol = XPRT_TRANSPORT_TCP;
683 args.authflavor = clp->cl_cred.cr_flavor;
684 clp->cl_cb_ident = conn->cb_ident;
685 } else {
686 if (!conn->cb_xprt)
687 return -EINVAL;
688 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
689 clp->cl_cb_session = ses;
690 args.bc_xprt = conn->cb_xprt;
691 args.prognumber = clp->cl_cb_session->se_cb_prog;
692 args.protocol = XPRT_TRANSPORT_BC_TCP;
693 args.authflavor = ses->se_cb_sec.flavor;
694 }
695 /* Create RPC client */
696 client = create_backchannel_client(&args);
697 if (IS_ERR(client)) {
698 dprintk("NFSD: couldn't create callback client: %ld\n",
699 PTR_ERR(client));
700 return PTR_ERR(client);
701 }
702 cred = get_backchannel_cred(clp, client, ses);
703 if (IS_ERR(cred)) {
704 rpc_shutdown_client(client);
705 return PTR_ERR(cred);
706 }
707 clp->cl_cb_client = client;
708 clp->cl_cb_cred = cred;
709 return 0;
710}
711
712static void warn_no_callback_path(struct nfs4_client *clp, int reason)
713{
714 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
715 (int)clp->cl_name.len, clp->cl_name.data, reason);
716}
717
718static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
719{
720 clp->cl_cb_state = NFSD4_CB_DOWN;
721 warn_no_callback_path(clp, reason);
722}
723
724static void nfsd4_mark_cb_fault(struct nfs4_client *clp, int reason)
725{
726 clp->cl_cb_state = NFSD4_CB_FAULT;
727 warn_no_callback_path(clp, reason);
728}
729
730static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
731{
732 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
733
734 if (task->tk_status)
735 nfsd4_mark_cb_down(clp, task->tk_status);
736 else
737 clp->cl_cb_state = NFSD4_CB_UP;
738}
739
740static const struct rpc_call_ops nfsd4_cb_probe_ops = {
741 /* XXX: release method to ensure we set the cb channel down if
742 * necessary on early failure? */
743 .rpc_call_done = nfsd4_cb_probe_done,
744};
745
746static struct workqueue_struct *callback_wq;
747
748static void run_nfsd4_cb(struct nfsd4_callback *cb)
749{
750 queue_work(callback_wq, &cb->cb_work);
751}
752
753static void do_probe_callback(struct nfs4_client *clp)
754{
755 struct nfsd4_callback *cb = &clp->cl_cb_null;
756
757 cb->cb_op = NULL;
758 cb->cb_clp = clp;
759
760 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL];
761 cb->cb_msg.rpc_argp = NULL;
762 cb->cb_msg.rpc_resp = NULL;
763
764 cb->cb_ops = &nfsd4_cb_probe_ops;
765
766 run_nfsd4_cb(cb);
767}
768
769/*
770 * Poke the callback thread to process any updates to the callback
771 * parameters, and send a null probe.
772 */
773void nfsd4_probe_callback(struct nfs4_client *clp)
774{
775 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
776 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
777 do_probe_callback(clp);
778}
779
780void nfsd4_probe_callback_sync(struct nfs4_client *clp)
781{
782 nfsd4_probe_callback(clp);
783 flush_workqueue(callback_wq);
784}
785
786void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
787{
788 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
789 spin_lock(&clp->cl_lock);
790 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
791 spin_unlock(&clp->cl_lock);
792}
793
794/*
795 * There's currently a single callback channel slot.
796 * If the slot is available, then mark it busy. Otherwise, set the
797 * thread for sleeping on the callback RPC wait queue.
798 */
799static bool nfsd41_cb_get_slot(struct nfs4_client *clp, struct rpc_task *task)
800{
801 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
802 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
803 dprintk("%s slot is busy\n", __func__);
804 return false;
805 }
806 return true;
807}
808
809/*
810 * TODO: cb_sequence should support referring call lists, cachethis, multiple
811 * slots, and mark callback channel down on communication errors.
812 */
813static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
814{
815 struct nfsd4_callback *cb = calldata;
816 struct nfs4_client *clp = cb->cb_clp;
817 u32 minorversion = clp->cl_minorversion;
818
819 cb->cb_minorversion = minorversion;
820 if (minorversion) {
821 if (!nfsd41_cb_get_slot(clp, task))
822 return;
823 }
824 spin_lock(&clp->cl_lock);
825 if (list_empty(&cb->cb_per_client)) {
826 /* This is the first call, not a restart */
827 cb->cb_done = false;
828 list_add(&cb->cb_per_client, &clp->cl_callbacks);
829 }
830 spin_unlock(&clp->cl_lock);
831 rpc_call_start(task);
832}
833
834static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
835{
836 struct nfsd4_callback *cb = calldata;
837 struct nfs4_client *clp = cb->cb_clp;
838
839 dprintk("%s: minorversion=%d\n", __func__,
840 clp->cl_minorversion);
841
842 if (clp->cl_minorversion) {
843 /* No need for lock, access serialized in nfsd4_cb_prepare */
844 ++clp->cl_cb_session->se_cb_seq_nr;
845 clear_bit(0, &clp->cl_cb_slot_busy);
846 rpc_wake_up_next(&clp->cl_cb_waitq);
847 dprintk("%s: freed slot, new seqid=%d\n", __func__,
848 clp->cl_cb_session->se_cb_seq_nr);
849
850 /* We're done looking into the sequence information */
851 task->tk_msg.rpc_resp = NULL;
852 }
853}
854
855
856static void nfsd4_cb_recall_done(struct rpc_task *task, void *calldata)
857{
858 struct nfsd4_callback *cb = calldata;
859 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
860 struct nfs4_client *clp = cb->cb_clp;
861 struct rpc_clnt *current_rpc_client = clp->cl_cb_client;
862
863 nfsd4_cb_done(task, calldata);
864
865 if (current_rpc_client != task->tk_client) {
866 /* We're shutting down or changing cl_cb_client; leave
867 * it to nfsd4_process_cb_update to restart the call if
868 * necessary. */
869 return;
870 }
871
872 if (cb->cb_done)
873 return;
874 switch (task->tk_status) {
875 case 0:
876 cb->cb_done = true;
877 return;
878 case -EBADHANDLE:
879 case -NFS4ERR_BAD_STATEID:
880 /* Race: client probably got cb_recall
881 * before open reply granting delegation */
882 break;
883 default:
884 /* Network partition? */
885 nfsd4_mark_cb_down(clp, task->tk_status);
886 }
887 if (dp->dl_retries--) {
888 rpc_delay(task, 2*HZ);
889 task->tk_status = 0;
890 rpc_restart_call_prepare(task);
891 return;
892 }
893 nfsd4_mark_cb_down(clp, task->tk_status);
894 cb->cb_done = true;
895}
896
897static void nfsd4_cb_recall_release(void *calldata)
898{
899 struct nfsd4_callback *cb = calldata;
900 struct nfs4_client *clp = cb->cb_clp;
901 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
902
903 if (cb->cb_done) {
904 spin_lock(&clp->cl_lock);
905 list_del(&cb->cb_per_client);
906 spin_unlock(&clp->cl_lock);
907 nfs4_put_delegation(dp);
908 }
909}
910
911static const struct rpc_call_ops nfsd4_cb_recall_ops = {
912 .rpc_call_prepare = nfsd4_cb_prepare,
913 .rpc_call_done = nfsd4_cb_recall_done,
914 .rpc_release = nfsd4_cb_recall_release,
915};
916
917int nfsd4_create_callback_queue(void)
918{
919 callback_wq = create_singlethread_workqueue("nfsd4_callbacks");
920 if (!callback_wq)
921 return -ENOMEM;
922 return 0;
923}
924
925void nfsd4_destroy_callback_queue(void)
926{
927 destroy_workqueue(callback_wq);
928}
929
930/* must be called under the state lock */
931void nfsd4_shutdown_callback(struct nfs4_client *clp)
932{
933 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
934 /*
935 * Note this won't actually result in a null callback;
936 * instead, nfsd4_do_callback_rpc() will detect the killed
937 * client, destroy the rpc client, and stop:
938 */
939 do_probe_callback(clp);
940 flush_workqueue(callback_wq);
941}
942
943static void nfsd4_release_cb(struct nfsd4_callback *cb)
944{
945 if (cb->cb_ops->rpc_release)
946 cb->cb_ops->rpc_release(cb);
947}
948
949/* requires cl_lock: */
950static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
951{
952 struct nfsd4_session *s;
953 struct nfsd4_conn *c;
954
955 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
956 list_for_each_entry(c, &s->se_conns, cn_persession) {
957 if (c->cn_flags & NFS4_CDFC4_BACK)
958 return c;
959 }
960 }
961 return NULL;
962}
963
964static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
965{
966 struct nfs4_cb_conn conn;
967 struct nfs4_client *clp = cb->cb_clp;
968 struct nfsd4_session *ses = NULL;
969 struct nfsd4_conn *c;
970 int err;
971
972 /*
973 * This is either an update, or the client dying; in either case,
974 * kill the old client:
975 */
976 if (clp->cl_cb_client) {
977 rpc_shutdown_client(clp->cl_cb_client);
978 clp->cl_cb_client = NULL;
979 put_rpccred(clp->cl_cb_cred);
980 clp->cl_cb_cred = NULL;
981 }
982 if (clp->cl_cb_conn.cb_xprt) {
983 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
984 clp->cl_cb_conn.cb_xprt = NULL;
985 }
986 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
987 return;
988 spin_lock(&clp->cl_lock);
989 /*
990 * Only serialized callback code is allowed to clear these
991 * flags; main nfsd code can only set them:
992 */
993 BUG_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
994 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
995 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
996 c = __nfsd4_find_backchannel(clp);
997 if (c) {
998 svc_xprt_get(c->cn_xprt);
999 conn.cb_xprt = c->cn_xprt;
1000 ses = c->cn_session;
1001 }
1002 spin_unlock(&clp->cl_lock);
1003
1004 err = setup_callback_client(clp, &conn, ses);
1005 if (err) {
1006 nfsd4_mark_cb_down(clp, err);
1007 return;
1008 }
1009 /* Yay, the callback channel's back! Restart any callbacks: */
1010 list_for_each_entry(cb, &clp->cl_callbacks, cb_per_client)
1011 run_nfsd4_cb(cb);
1012}
1013
1014static void nfsd4_do_callback_rpc(struct work_struct *w)
1015{
1016 struct nfsd4_callback *cb = container_of(w, struct nfsd4_callback, cb_work);
1017 struct nfs4_client *clp = cb->cb_clp;
1018 struct rpc_clnt *clnt;
1019
1020 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
1021 nfsd4_process_cb_update(cb);
1022
1023 clnt = clp->cl_cb_client;
1024 if (!clnt) {
1025 /* Callback channel broken, or client killed; give up: */
1026 nfsd4_release_cb(cb);
1027 return;
1028 }
1029 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
1030 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
1031 cb->cb_ops, cb);
1032}
1033
1034void nfsd4_init_callback(struct nfsd4_callback *cb)
1035{
1036 INIT_WORK(&cb->cb_work, nfsd4_do_callback_rpc);
1037}
1038
1039void nfsd4_cb_recall(struct nfs4_delegation *dp)
1040{
1041 struct nfsd4_callback *cb = &dp->dl_recall;
1042 struct nfs4_client *clp = dp->dl_stid.sc_client;
1043
1044 dp->dl_retries = 1;
1045 cb->cb_op = dp;
1046 cb->cb_clp = clp;
1047 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL];
1048 cb->cb_msg.rpc_argp = cb;
1049 cb->cb_msg.rpc_resp = cb;
1050
1051 cb->cb_ops = &nfsd4_cb_recall_ops;
1052
1053 INIT_LIST_HEAD(&cb->cb_per_client);
1054 cb->cb_done = true;
1055
1056 run_nfsd4_cb(&dp->dl_recall);
1057}
1/*
2 * Copyright (c) 2001 The Regents of the University of Michigan.
3 * All rights reserved.
4 *
5 * Kendrick Smith <kmsmith@umich.edu>
6 * Andy Adamson <andros@umich.edu>
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
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.
20 *
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.
32 */
33
34#include <linux/sunrpc/clnt.h>
35#include <linux/sunrpc/xprt.h>
36#include <linux/sunrpc/svc_xprt.h>
37#include <linux/slab.h>
38#include "nfsd.h"
39#include "state.h"
40#include "netns.h"
41#include "xdr4cb.h"
42#include "xdr4.h"
43
44#define NFSDDBG_FACILITY NFSDDBG_PROC
45
46static void nfsd4_mark_cb_fault(struct nfs4_client *, int reason);
47
48#define NFSPROC4_CB_NULL 0
49#define NFSPROC4_CB_COMPOUND 1
50
51/* Index of predefined Linux callback client operations */
52
53struct nfs4_cb_compound_hdr {
54 /* args */
55 u32 ident; /* minorversion 0 only */
56 u32 nops;
57 __be32 *nops_p;
58 u32 minorversion;
59 /* res */
60 int status;
61};
62
63static __be32 *xdr_encode_empty_array(__be32 *p)
64{
65 *p++ = xdr_zero;
66 return p;
67}
68
69/*
70 * Encode/decode NFSv4 CB basic data types
71 *
72 * Basic NFSv4 callback data types are defined in section 15 of RFC
73 * 3530: "Network File System (NFS) version 4 Protocol" and section
74 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
75 * 1 Protocol"
76 */
77
78/*
79 * nfs_cb_opnum4
80 *
81 * enum nfs_cb_opnum4 {
82 * OP_CB_GETATTR = 3,
83 * ...
84 * };
85 */
86enum nfs_cb_opnum4 {
87 OP_CB_GETATTR = 3,
88 OP_CB_RECALL = 4,
89 OP_CB_LAYOUTRECALL = 5,
90 OP_CB_NOTIFY = 6,
91 OP_CB_PUSH_DELEG = 7,
92 OP_CB_RECALL_ANY = 8,
93 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
94 OP_CB_RECALL_SLOT = 10,
95 OP_CB_SEQUENCE = 11,
96 OP_CB_WANTS_CANCELLED = 12,
97 OP_CB_NOTIFY_LOCK = 13,
98 OP_CB_NOTIFY_DEVICEID = 14,
99 OP_CB_OFFLOAD = 15,
100 OP_CB_ILLEGAL = 10044
101};
102
103static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
104{
105 __be32 *p;
106
107 p = xdr_reserve_space(xdr, 4);
108 *p = cpu_to_be32(op);
109}
110
111/*
112 * nfs_fh4
113 *
114 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
115 */
116static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
117{
118 u32 length = fh->fh_size;
119 __be32 *p;
120
121 BUG_ON(length > NFS4_FHSIZE);
122 p = xdr_reserve_space(xdr, 4 + length);
123 xdr_encode_opaque(p, &fh->fh_base, length);
124}
125
126/*
127 * stateid4
128 *
129 * struct stateid4 {
130 * uint32_t seqid;
131 * opaque other[12];
132 * };
133 */
134static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
135{
136 __be32 *p;
137
138 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
139 *p++ = cpu_to_be32(sid->si_generation);
140 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
141}
142
143/*
144 * sessionid4
145 *
146 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
147 */
148static void encode_sessionid4(struct xdr_stream *xdr,
149 const struct nfsd4_session *session)
150{
151 __be32 *p;
152
153 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
154 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
155 NFS4_MAX_SESSIONID_LEN);
156}
157
158/*
159 * nfsstat4
160 */
161static const struct {
162 int stat;
163 int errno;
164} nfs_cb_errtbl[] = {
165 { NFS4_OK, 0 },
166 { NFS4ERR_PERM, -EPERM },
167 { NFS4ERR_NOENT, -ENOENT },
168 { NFS4ERR_IO, -EIO },
169 { NFS4ERR_NXIO, -ENXIO },
170 { NFS4ERR_ACCESS, -EACCES },
171 { NFS4ERR_EXIST, -EEXIST },
172 { NFS4ERR_XDEV, -EXDEV },
173 { NFS4ERR_NOTDIR, -ENOTDIR },
174 { NFS4ERR_ISDIR, -EISDIR },
175 { NFS4ERR_INVAL, -EINVAL },
176 { NFS4ERR_FBIG, -EFBIG },
177 { NFS4ERR_NOSPC, -ENOSPC },
178 { NFS4ERR_ROFS, -EROFS },
179 { NFS4ERR_MLINK, -EMLINK },
180 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
181 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
182 { NFS4ERR_DQUOT, -EDQUOT },
183 { NFS4ERR_STALE, -ESTALE },
184 { NFS4ERR_BADHANDLE, -EBADHANDLE },
185 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
186 { NFS4ERR_NOTSUPP, -ENOTSUPP },
187 { NFS4ERR_TOOSMALL, -ETOOSMALL },
188 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
189 { NFS4ERR_BADTYPE, -EBADTYPE },
190 { NFS4ERR_LOCKED, -EAGAIN },
191 { NFS4ERR_RESOURCE, -EREMOTEIO },
192 { NFS4ERR_SYMLINK, -ELOOP },
193 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
194 { NFS4ERR_DEADLOCK, -EDEADLK },
195 { -1, -EIO }
196};
197
198/*
199 * If we cannot translate the error, the recovery routines should
200 * handle it.
201 *
202 * Note: remaining NFSv4 error codes have values > 10000, so should
203 * not conflict with native Linux error codes.
204 */
205static int nfs_cb_stat_to_errno(int status)
206{
207 int i;
208
209 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
210 if (nfs_cb_errtbl[i].stat == status)
211 return nfs_cb_errtbl[i].errno;
212 }
213
214 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
215 return -status;
216}
217
218static int decode_cb_op_status(struct xdr_stream *xdr,
219 enum nfs_cb_opnum4 expected, int *status)
220{
221 __be32 *p;
222 u32 op;
223
224 p = xdr_inline_decode(xdr, 4 + 4);
225 if (unlikely(p == NULL))
226 goto out_overflow;
227 op = be32_to_cpup(p++);
228 if (unlikely(op != expected))
229 goto out_unexpected;
230 *status = nfs_cb_stat_to_errno(be32_to_cpup(p));
231 return 0;
232out_overflow:
233 return -EIO;
234out_unexpected:
235 dprintk("NFSD: Callback server returned operation %d but "
236 "we issued a request for %d\n", op, expected);
237 return -EIO;
238}
239
240/*
241 * CB_COMPOUND4args
242 *
243 * struct CB_COMPOUND4args {
244 * utf8str_cs tag;
245 * uint32_t minorversion;
246 * uint32_t callback_ident;
247 * nfs_cb_argop4 argarray<>;
248 * };
249*/
250static void encode_cb_compound4args(struct xdr_stream *xdr,
251 struct nfs4_cb_compound_hdr *hdr)
252{
253 __be32 * p;
254
255 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
256 p = xdr_encode_empty_array(p); /* empty tag */
257 *p++ = cpu_to_be32(hdr->minorversion);
258 *p++ = cpu_to_be32(hdr->ident);
259
260 hdr->nops_p = p;
261 *p = cpu_to_be32(hdr->nops); /* argarray element count */
262}
263
264/*
265 * Update argarray element count
266 */
267static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
268{
269 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
270 *hdr->nops_p = cpu_to_be32(hdr->nops);
271}
272
273/*
274 * CB_COMPOUND4res
275 *
276 * struct CB_COMPOUND4res {
277 * nfsstat4 status;
278 * utf8str_cs tag;
279 * nfs_cb_resop4 resarray<>;
280 * };
281 */
282static int decode_cb_compound4res(struct xdr_stream *xdr,
283 struct nfs4_cb_compound_hdr *hdr)
284{
285 u32 length;
286 __be32 *p;
287
288 p = xdr_inline_decode(xdr, 4 + 4);
289 if (unlikely(p == NULL))
290 goto out_overflow;
291 hdr->status = be32_to_cpup(p++);
292 /* Ignore the tag */
293 length = be32_to_cpup(p++);
294 p = xdr_inline_decode(xdr, length + 4);
295 if (unlikely(p == NULL))
296 goto out_overflow;
297 p += XDR_QUADLEN(length);
298 hdr->nops = be32_to_cpup(p);
299 return 0;
300out_overflow:
301 return -EIO;
302}
303
304/*
305 * CB_RECALL4args
306 *
307 * struct CB_RECALL4args {
308 * stateid4 stateid;
309 * bool truncate;
310 * nfs_fh4 fh;
311 * };
312 */
313static void encode_cb_recall4args(struct xdr_stream *xdr,
314 const struct nfs4_delegation *dp,
315 struct nfs4_cb_compound_hdr *hdr)
316{
317 __be32 *p;
318
319 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
320 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
321
322 p = xdr_reserve_space(xdr, 4);
323 *p++ = xdr_zero; /* truncate */
324
325 encode_nfs_fh4(xdr, &dp->dl_stid.sc_file->fi_fhandle);
326
327 hdr->nops++;
328}
329
330/*
331 * CB_SEQUENCE4args
332 *
333 * struct CB_SEQUENCE4args {
334 * sessionid4 csa_sessionid;
335 * sequenceid4 csa_sequenceid;
336 * slotid4 csa_slotid;
337 * slotid4 csa_highest_slotid;
338 * bool csa_cachethis;
339 * referring_call_list4 csa_referring_call_lists<>;
340 * };
341 */
342static void encode_cb_sequence4args(struct xdr_stream *xdr,
343 const struct nfsd4_callback *cb,
344 struct nfs4_cb_compound_hdr *hdr)
345{
346 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
347 __be32 *p;
348
349 if (hdr->minorversion == 0)
350 return;
351
352 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
353 encode_sessionid4(xdr, session);
354
355 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
356 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
357 *p++ = xdr_zero; /* csa_slotid */
358 *p++ = xdr_zero; /* csa_highest_slotid */
359 *p++ = xdr_zero; /* csa_cachethis */
360 xdr_encode_empty_array(p); /* csa_referring_call_lists */
361
362 hdr->nops++;
363}
364
365/*
366 * CB_SEQUENCE4resok
367 *
368 * struct CB_SEQUENCE4resok {
369 * sessionid4 csr_sessionid;
370 * sequenceid4 csr_sequenceid;
371 * slotid4 csr_slotid;
372 * slotid4 csr_highest_slotid;
373 * slotid4 csr_target_highest_slotid;
374 * };
375 *
376 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
377 * case NFS4_OK:
378 * CB_SEQUENCE4resok csr_resok4;
379 * default:
380 * void;
381 * };
382 *
383 * Our current back channel implmentation supports a single backchannel
384 * with a single slot.
385 */
386static int decode_cb_sequence4resok(struct xdr_stream *xdr,
387 struct nfsd4_callback *cb)
388{
389 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
390 int status = -ESERVERFAULT;
391 __be32 *p;
392 u32 dummy;
393
394 /*
395 * If the server returns different values for sessionID, slotID or
396 * sequence number, the server is looney tunes.
397 */
398 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
399 if (unlikely(p == NULL))
400 goto out_overflow;
401
402 if (memcmp(p, session->se_sessionid.data, NFS4_MAX_SESSIONID_LEN)) {
403 dprintk("NFS: %s Invalid session id\n", __func__);
404 goto out;
405 }
406 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
407
408 dummy = be32_to_cpup(p++);
409 if (dummy != session->se_cb_seq_nr) {
410 dprintk("NFS: %s Invalid sequence number\n", __func__);
411 goto out;
412 }
413
414 dummy = be32_to_cpup(p++);
415 if (dummy != 0) {
416 dprintk("NFS: %s Invalid slotid\n", __func__);
417 goto out;
418 }
419
420 /*
421 * FIXME: process highest slotid and target highest slotid
422 */
423 status = 0;
424out:
425 cb->cb_seq_status = status;
426 return status;
427out_overflow:
428 status = -EIO;
429 goto out;
430}
431
432static int decode_cb_sequence4res(struct xdr_stream *xdr,
433 struct nfsd4_callback *cb)
434{
435 int status;
436
437 if (cb->cb_clp->cl_minorversion == 0)
438 return 0;
439
440 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &cb->cb_seq_status);
441 if (unlikely(status || cb->cb_seq_status))
442 return status;
443
444 return decode_cb_sequence4resok(xdr, cb);
445}
446
447/*
448 * NFSv4.0 and NFSv4.1 XDR encode functions
449 *
450 * NFSv4.0 callback argument types are defined in section 15 of RFC
451 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
452 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
453 * Protocol".
454 */
455
456/*
457 * NB: Without this zero space reservation, callbacks over krb5p fail
458 */
459static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
460 const void *__unused)
461{
462 xdr_reserve_space(xdr, 0);
463}
464
465/*
466 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
467 */
468static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
469 const void *data)
470{
471 const struct nfsd4_callback *cb = data;
472 const struct nfs4_delegation *dp = cb_to_delegation(cb);
473 struct nfs4_cb_compound_hdr hdr = {
474 .ident = cb->cb_clp->cl_cb_ident,
475 .minorversion = cb->cb_clp->cl_minorversion,
476 };
477
478 encode_cb_compound4args(xdr, &hdr);
479 encode_cb_sequence4args(xdr, cb, &hdr);
480 encode_cb_recall4args(xdr, dp, &hdr);
481 encode_cb_nops(&hdr);
482}
483
484
485/*
486 * NFSv4.0 and NFSv4.1 XDR decode functions
487 *
488 * NFSv4.0 callback result types are defined in section 15 of RFC
489 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
490 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
491 * Protocol".
492 */
493
494static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
495 void *__unused)
496{
497 return 0;
498}
499
500/*
501 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
502 */
503static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
504 struct xdr_stream *xdr,
505 void *data)
506{
507 struct nfsd4_callback *cb = data;
508 struct nfs4_cb_compound_hdr hdr;
509 int status;
510
511 status = decode_cb_compound4res(xdr, &hdr);
512 if (unlikely(status))
513 return status;
514
515 status = decode_cb_sequence4res(xdr, cb);
516 if (unlikely(status || cb->cb_seq_status))
517 return status;
518
519 return decode_cb_op_status(xdr, OP_CB_RECALL, &cb->cb_status);
520}
521
522#ifdef CONFIG_NFSD_PNFS
523/*
524 * CB_LAYOUTRECALL4args
525 *
526 * struct layoutrecall_file4 {
527 * nfs_fh4 lor_fh;
528 * offset4 lor_offset;
529 * length4 lor_length;
530 * stateid4 lor_stateid;
531 * };
532 *
533 * union layoutrecall4 switch(layoutrecall_type4 lor_recalltype) {
534 * case LAYOUTRECALL4_FILE:
535 * layoutrecall_file4 lor_layout;
536 * case LAYOUTRECALL4_FSID:
537 * fsid4 lor_fsid;
538 * case LAYOUTRECALL4_ALL:
539 * void;
540 * };
541 *
542 * struct CB_LAYOUTRECALL4args {
543 * layouttype4 clora_type;
544 * layoutiomode4 clora_iomode;
545 * bool clora_changed;
546 * layoutrecall4 clora_recall;
547 * };
548 */
549static void encode_cb_layout4args(struct xdr_stream *xdr,
550 const struct nfs4_layout_stateid *ls,
551 struct nfs4_cb_compound_hdr *hdr)
552{
553 __be32 *p;
554
555 BUG_ON(hdr->minorversion == 0);
556
557 p = xdr_reserve_space(xdr, 5 * 4);
558 *p++ = cpu_to_be32(OP_CB_LAYOUTRECALL);
559 *p++ = cpu_to_be32(ls->ls_layout_type);
560 *p++ = cpu_to_be32(IOMODE_ANY);
561 *p++ = cpu_to_be32(1);
562 *p = cpu_to_be32(RETURN_FILE);
563
564 encode_nfs_fh4(xdr, &ls->ls_stid.sc_file->fi_fhandle);
565
566 p = xdr_reserve_space(xdr, 2 * 8);
567 p = xdr_encode_hyper(p, 0);
568 xdr_encode_hyper(p, NFS4_MAX_UINT64);
569
570 encode_stateid4(xdr, &ls->ls_recall_sid);
571
572 hdr->nops++;
573}
574
575static void nfs4_xdr_enc_cb_layout(struct rpc_rqst *req,
576 struct xdr_stream *xdr,
577 const void *data)
578{
579 const struct nfsd4_callback *cb = data;
580 const struct nfs4_layout_stateid *ls =
581 container_of(cb, struct nfs4_layout_stateid, ls_recall);
582 struct nfs4_cb_compound_hdr hdr = {
583 .ident = 0,
584 .minorversion = cb->cb_clp->cl_minorversion,
585 };
586
587 encode_cb_compound4args(xdr, &hdr);
588 encode_cb_sequence4args(xdr, cb, &hdr);
589 encode_cb_layout4args(xdr, ls, &hdr);
590 encode_cb_nops(&hdr);
591}
592
593static int nfs4_xdr_dec_cb_layout(struct rpc_rqst *rqstp,
594 struct xdr_stream *xdr,
595 void *data)
596{
597 struct nfsd4_callback *cb = data;
598 struct nfs4_cb_compound_hdr hdr;
599 int status;
600
601 status = decode_cb_compound4res(xdr, &hdr);
602 if (unlikely(status))
603 return status;
604
605 status = decode_cb_sequence4res(xdr, cb);
606 if (unlikely(status || cb->cb_seq_status))
607 return status;
608
609 return decode_cb_op_status(xdr, OP_CB_LAYOUTRECALL, &cb->cb_status);
610}
611#endif /* CONFIG_NFSD_PNFS */
612
613static void encode_stateowner(struct xdr_stream *xdr, struct nfs4_stateowner *so)
614{
615 __be32 *p;
616
617 p = xdr_reserve_space(xdr, 8 + 4 + so->so_owner.len);
618 p = xdr_encode_opaque_fixed(p, &so->so_client->cl_clientid, 8);
619 xdr_encode_opaque(p, so->so_owner.data, so->so_owner.len);
620}
621
622static void nfs4_xdr_enc_cb_notify_lock(struct rpc_rqst *req,
623 struct xdr_stream *xdr,
624 const void *data)
625{
626 const struct nfsd4_callback *cb = data;
627 const struct nfsd4_blocked_lock *nbl =
628 container_of(cb, struct nfsd4_blocked_lock, nbl_cb);
629 struct nfs4_lockowner *lo = (struct nfs4_lockowner *)nbl->nbl_lock.fl_owner;
630 struct nfs4_cb_compound_hdr hdr = {
631 .ident = 0,
632 .minorversion = cb->cb_clp->cl_minorversion,
633 };
634
635 __be32 *p;
636
637 BUG_ON(hdr.minorversion == 0);
638
639 encode_cb_compound4args(xdr, &hdr);
640 encode_cb_sequence4args(xdr, cb, &hdr);
641
642 p = xdr_reserve_space(xdr, 4);
643 *p = cpu_to_be32(OP_CB_NOTIFY_LOCK);
644 encode_nfs_fh4(xdr, &nbl->nbl_fh);
645 encode_stateowner(xdr, &lo->lo_owner);
646 hdr.nops++;
647
648 encode_cb_nops(&hdr);
649}
650
651static int nfs4_xdr_dec_cb_notify_lock(struct rpc_rqst *rqstp,
652 struct xdr_stream *xdr,
653 void *data)
654{
655 struct nfsd4_callback *cb = data;
656 struct nfs4_cb_compound_hdr hdr;
657 int status;
658
659 status = decode_cb_compound4res(xdr, &hdr);
660 if (unlikely(status))
661 return status;
662
663 status = decode_cb_sequence4res(xdr, cb);
664 if (unlikely(status || cb->cb_seq_status))
665 return status;
666
667 return decode_cb_op_status(xdr, OP_CB_NOTIFY_LOCK, &cb->cb_status);
668}
669
670/*
671 * struct write_response4 {
672 * stateid4 wr_callback_id<1>;
673 * length4 wr_count;
674 * stable_how4 wr_committed;
675 * verifier4 wr_writeverf;
676 * };
677 * union offload_info4 switch (nfsstat4 coa_status) {
678 * case NFS4_OK:
679 * write_response4 coa_resok4;
680 * default:
681 * length4 coa_bytes_copied;
682 * };
683 * struct CB_OFFLOAD4args {
684 * nfs_fh4 coa_fh;
685 * stateid4 coa_stateid;
686 * offload_info4 coa_offload_info;
687 * };
688 */
689static void encode_offload_info4(struct xdr_stream *xdr,
690 __be32 nfserr,
691 const struct nfsd4_copy *cp)
692{
693 __be32 *p;
694
695 p = xdr_reserve_space(xdr, 4);
696 *p++ = nfserr;
697 if (!nfserr) {
698 p = xdr_reserve_space(xdr, 4 + 8 + 4 + NFS4_VERIFIER_SIZE);
699 p = xdr_encode_empty_array(p);
700 p = xdr_encode_hyper(p, cp->cp_res.wr_bytes_written);
701 *p++ = cpu_to_be32(cp->cp_res.wr_stable_how);
702 p = xdr_encode_opaque_fixed(p, cp->cp_res.wr_verifier.data,
703 NFS4_VERIFIER_SIZE);
704 } else {
705 p = xdr_reserve_space(xdr, 8);
706 /* We always return success if bytes were written */
707 p = xdr_encode_hyper(p, 0);
708 }
709}
710
711static void encode_cb_offload4args(struct xdr_stream *xdr,
712 __be32 nfserr,
713 const struct knfsd_fh *fh,
714 const struct nfsd4_copy *cp,
715 struct nfs4_cb_compound_hdr *hdr)
716{
717 __be32 *p;
718
719 p = xdr_reserve_space(xdr, 4);
720 *p++ = cpu_to_be32(OP_CB_OFFLOAD);
721 encode_nfs_fh4(xdr, fh);
722 encode_stateid4(xdr, &cp->cp_res.cb_stateid);
723 encode_offload_info4(xdr, nfserr, cp);
724
725 hdr->nops++;
726}
727
728static void nfs4_xdr_enc_cb_offload(struct rpc_rqst *req,
729 struct xdr_stream *xdr,
730 const void *data)
731{
732 const struct nfsd4_callback *cb = data;
733 const struct nfsd4_copy *cp =
734 container_of(cb, struct nfsd4_copy, cp_cb);
735 struct nfs4_cb_compound_hdr hdr = {
736 .ident = 0,
737 .minorversion = cb->cb_clp->cl_minorversion,
738 };
739
740 encode_cb_compound4args(xdr, &hdr);
741 encode_cb_sequence4args(xdr, cb, &hdr);
742 encode_cb_offload4args(xdr, cp->nfserr, &cp->fh, cp, &hdr);
743 encode_cb_nops(&hdr);
744}
745
746static int nfs4_xdr_dec_cb_offload(struct rpc_rqst *rqstp,
747 struct xdr_stream *xdr,
748 void *data)
749{
750 struct nfsd4_callback *cb = data;
751 struct nfs4_cb_compound_hdr hdr;
752 int status;
753
754 status = decode_cb_compound4res(xdr, &hdr);
755 if (unlikely(status))
756 return status;
757
758 status = decode_cb_sequence4res(xdr, cb);
759 if (unlikely(status || cb->cb_seq_status))
760 return status;
761
762 return decode_cb_op_status(xdr, OP_CB_OFFLOAD, &cb->cb_status);
763}
764/*
765 * RPC procedure tables
766 */
767#define PROC(proc, call, argtype, restype) \
768[NFSPROC4_CLNT_##proc] = { \
769 .p_proc = NFSPROC4_CB_##call, \
770 .p_encode = nfs4_xdr_enc_##argtype, \
771 .p_decode = nfs4_xdr_dec_##restype, \
772 .p_arglen = NFS4_enc_##argtype##_sz, \
773 .p_replen = NFS4_dec_##restype##_sz, \
774 .p_statidx = NFSPROC4_CB_##call, \
775 .p_name = #proc, \
776}
777
778static const struct rpc_procinfo nfs4_cb_procedures[] = {
779 PROC(CB_NULL, NULL, cb_null, cb_null),
780 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
781#ifdef CONFIG_NFSD_PNFS
782 PROC(CB_LAYOUT, COMPOUND, cb_layout, cb_layout),
783#endif
784 PROC(CB_NOTIFY_LOCK, COMPOUND, cb_notify_lock, cb_notify_lock),
785 PROC(CB_OFFLOAD, COMPOUND, cb_offload, cb_offload),
786};
787
788static unsigned int nfs4_cb_counts[ARRAY_SIZE(nfs4_cb_procedures)];
789static const struct rpc_version nfs_cb_version4 = {
790/*
791 * Note on the callback rpc program version number: despite language in rfc
792 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
793 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
794 * in practice that appears to be what implementations use. The section
795 * 18.36.3 language is expected to be fixed in an erratum.
796 */
797 .number = 1,
798 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
799 .procs = nfs4_cb_procedures,
800 .counts = nfs4_cb_counts,
801};
802
803static const struct rpc_version *nfs_cb_version[2] = {
804 [1] = &nfs_cb_version4,
805};
806
807static const struct rpc_program cb_program;
808
809static struct rpc_stat cb_stats = {
810 .program = &cb_program
811};
812
813#define NFS4_CALLBACK 0x40000000
814static const struct rpc_program cb_program = {
815 .name = "nfs4_cb",
816 .number = NFS4_CALLBACK,
817 .nrvers = ARRAY_SIZE(nfs_cb_version),
818 .version = nfs_cb_version,
819 .stats = &cb_stats,
820 .pipe_dir_name = "nfsd4_cb",
821};
822
823static int max_cb_time(struct net *net)
824{
825 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
826 return max(nn->nfsd4_lease/10, (time_t)1) * HZ;
827}
828
829static const struct cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
830{
831 if (clp->cl_minorversion == 0) {
832 client->cl_principal = clp->cl_cred.cr_targ_princ ?
833 clp->cl_cred.cr_targ_princ : "nfs";
834
835 return get_cred(rpc_machine_cred());
836 } else {
837 struct cred *kcred;
838
839 kcred = prepare_kernel_cred(NULL);
840 if (!kcred)
841 return NULL;
842
843 kcred->uid = ses->se_cb_sec.uid;
844 kcred->gid = ses->se_cb_sec.gid;
845 return kcred;
846 }
847}
848
849static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
850{
851 int maxtime = max_cb_time(clp->net);
852 struct rpc_timeout timeparms = {
853 .to_initval = maxtime,
854 .to_retries = 0,
855 .to_maxval = maxtime,
856 };
857 struct rpc_create_args args = {
858 .net = clp->net,
859 .address = (struct sockaddr *) &conn->cb_addr,
860 .addrsize = conn->cb_addrlen,
861 .saddress = (struct sockaddr *) &conn->cb_saddr,
862 .timeout = &timeparms,
863 .program = &cb_program,
864 .version = 1,
865 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
866 .cred = current_cred(),
867 };
868 struct rpc_clnt *client;
869 const struct cred *cred;
870
871 if (clp->cl_minorversion == 0) {
872 if (!clp->cl_cred.cr_principal &&
873 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5))
874 return -EINVAL;
875 args.client_name = clp->cl_cred.cr_principal;
876 args.prognumber = conn->cb_prog;
877 args.protocol = XPRT_TRANSPORT_TCP;
878 args.authflavor = clp->cl_cred.cr_flavor;
879 clp->cl_cb_ident = conn->cb_ident;
880 } else {
881 if (!conn->cb_xprt)
882 return -EINVAL;
883 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
884 clp->cl_cb_session = ses;
885 args.bc_xprt = conn->cb_xprt;
886 args.prognumber = clp->cl_cb_session->se_cb_prog;
887 args.protocol = conn->cb_xprt->xpt_class->xcl_ident |
888 XPRT_TRANSPORT_BC;
889 args.authflavor = ses->se_cb_sec.flavor;
890 }
891 /* Create RPC client */
892 client = rpc_create(&args);
893 if (IS_ERR(client)) {
894 dprintk("NFSD: couldn't create callback client: %ld\n",
895 PTR_ERR(client));
896 return PTR_ERR(client);
897 }
898 cred = get_backchannel_cred(clp, client, ses);
899 if (!cred) {
900 rpc_shutdown_client(client);
901 return -ENOMEM;
902 }
903 clp->cl_cb_client = client;
904 clp->cl_cb_cred = cred;
905 return 0;
906}
907
908static void warn_no_callback_path(struct nfs4_client *clp, int reason)
909{
910 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
911 (int)clp->cl_name.len, clp->cl_name.data, reason);
912}
913
914static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
915{
916 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
917 return;
918 clp->cl_cb_state = NFSD4_CB_DOWN;
919 warn_no_callback_path(clp, reason);
920}
921
922static void nfsd4_mark_cb_fault(struct nfs4_client *clp, int reason)
923{
924 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
925 return;
926 clp->cl_cb_state = NFSD4_CB_FAULT;
927 warn_no_callback_path(clp, reason);
928}
929
930static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
931{
932 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
933
934 if (task->tk_status)
935 nfsd4_mark_cb_down(clp, task->tk_status);
936 else
937 clp->cl_cb_state = NFSD4_CB_UP;
938}
939
940static const struct rpc_call_ops nfsd4_cb_probe_ops = {
941 /* XXX: release method to ensure we set the cb channel down if
942 * necessary on early failure? */
943 .rpc_call_done = nfsd4_cb_probe_done,
944};
945
946static struct workqueue_struct *callback_wq;
947
948/*
949 * Poke the callback thread to process any updates to the callback
950 * parameters, and send a null probe.
951 */
952void nfsd4_probe_callback(struct nfs4_client *clp)
953{
954 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
955 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
956 nfsd4_run_cb(&clp->cl_cb_null);
957}
958
959void nfsd4_probe_callback_sync(struct nfs4_client *clp)
960{
961 nfsd4_probe_callback(clp);
962 flush_workqueue(callback_wq);
963}
964
965void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
966{
967 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
968 spin_lock(&clp->cl_lock);
969 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
970 spin_unlock(&clp->cl_lock);
971}
972
973/*
974 * There's currently a single callback channel slot.
975 * If the slot is available, then mark it busy. Otherwise, set the
976 * thread for sleeping on the callback RPC wait queue.
977 */
978static bool nfsd41_cb_get_slot(struct nfs4_client *clp, struct rpc_task *task)
979{
980 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
981 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
982 /* Race breaker */
983 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
984 dprintk("%s slot is busy\n", __func__);
985 return false;
986 }
987 rpc_wake_up_queued_task(&clp->cl_cb_waitq, task);
988 }
989 return true;
990}
991
992/*
993 * TODO: cb_sequence should support referring call lists, cachethis, multiple
994 * slots, and mark callback channel down on communication errors.
995 */
996static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
997{
998 struct nfsd4_callback *cb = calldata;
999 struct nfs4_client *clp = cb->cb_clp;
1000 u32 minorversion = clp->cl_minorversion;
1001
1002 /*
1003 * cb_seq_status is only set in decode_cb_sequence4res,
1004 * and so will remain 1 if an rpc level failure occurs.
1005 */
1006 cb->cb_seq_status = 1;
1007 cb->cb_status = 0;
1008 if (minorversion) {
1009 if (!cb->cb_holds_slot && !nfsd41_cb_get_slot(clp, task))
1010 return;
1011 cb->cb_holds_slot = true;
1012 }
1013 rpc_call_start(task);
1014}
1015
1016static bool nfsd4_cb_sequence_done(struct rpc_task *task, struct nfsd4_callback *cb)
1017{
1018 struct nfs4_client *clp = cb->cb_clp;
1019 struct nfsd4_session *session = clp->cl_cb_session;
1020 bool ret = true;
1021
1022 if (!clp->cl_minorversion) {
1023 /*
1024 * If the backchannel connection was shut down while this
1025 * task was queued, we need to resubmit it after setting up
1026 * a new backchannel connection.
1027 *
1028 * Note that if we lost our callback connection permanently
1029 * the submission code will error out, so we don't need to
1030 * handle that case here.
1031 */
1032 if (RPC_SIGNALLED(task))
1033 goto need_restart;
1034
1035 return true;
1036 }
1037
1038 if (!cb->cb_holds_slot)
1039 goto need_restart;
1040
1041 switch (cb->cb_seq_status) {
1042 case 0:
1043 /*
1044 * No need for lock, access serialized in nfsd4_cb_prepare
1045 *
1046 * RFC5661 20.9.3
1047 * If CB_SEQUENCE returns an error, then the state of the slot
1048 * (sequence ID, cached reply) MUST NOT change.
1049 */
1050 ++session->se_cb_seq_nr;
1051 break;
1052 case -ESERVERFAULT:
1053 ++session->se_cb_seq_nr;
1054 /* Fall through */
1055 case 1:
1056 case -NFS4ERR_BADSESSION:
1057 nfsd4_mark_cb_fault(cb->cb_clp, cb->cb_seq_status);
1058 ret = false;
1059 break;
1060 case -NFS4ERR_DELAY:
1061 if (!rpc_restart_call(task))
1062 goto out;
1063
1064 rpc_delay(task, 2 * HZ);
1065 return false;
1066 case -NFS4ERR_BADSLOT:
1067 goto retry_nowait;
1068 case -NFS4ERR_SEQ_MISORDERED:
1069 if (session->se_cb_seq_nr != 1) {
1070 session->se_cb_seq_nr = 1;
1071 goto retry_nowait;
1072 }
1073 break;
1074 default:
1075 dprintk("%s: unprocessed error %d\n", __func__,
1076 cb->cb_seq_status);
1077 }
1078
1079 cb->cb_holds_slot = false;
1080 clear_bit(0, &clp->cl_cb_slot_busy);
1081 rpc_wake_up_next(&clp->cl_cb_waitq);
1082 dprintk("%s: freed slot, new seqid=%d\n", __func__,
1083 clp->cl_cb_session->se_cb_seq_nr);
1084
1085 if (RPC_SIGNALLED(task))
1086 goto need_restart;
1087out:
1088 return ret;
1089retry_nowait:
1090 if (rpc_restart_call_prepare(task))
1091 ret = false;
1092 goto out;
1093need_restart:
1094 task->tk_status = 0;
1095 cb->cb_need_restart = true;
1096 return false;
1097}
1098
1099static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
1100{
1101 struct nfsd4_callback *cb = calldata;
1102 struct nfs4_client *clp = cb->cb_clp;
1103
1104 dprintk("%s: minorversion=%d\n", __func__,
1105 clp->cl_minorversion);
1106
1107 if (!nfsd4_cb_sequence_done(task, cb))
1108 return;
1109
1110 if (cb->cb_status) {
1111 WARN_ON_ONCE(task->tk_status);
1112 task->tk_status = cb->cb_status;
1113 }
1114
1115 switch (cb->cb_ops->done(cb, task)) {
1116 case 0:
1117 task->tk_status = 0;
1118 rpc_restart_call_prepare(task);
1119 return;
1120 case 1:
1121 switch (task->tk_status) {
1122 case -EIO:
1123 case -ETIMEDOUT:
1124 nfsd4_mark_cb_down(clp, task->tk_status);
1125 }
1126 break;
1127 default:
1128 BUG();
1129 }
1130}
1131
1132static void nfsd4_cb_release(void *calldata)
1133{
1134 struct nfsd4_callback *cb = calldata;
1135
1136 if (cb->cb_need_restart)
1137 nfsd4_run_cb(cb);
1138 else
1139 cb->cb_ops->release(cb);
1140
1141}
1142
1143static const struct rpc_call_ops nfsd4_cb_ops = {
1144 .rpc_call_prepare = nfsd4_cb_prepare,
1145 .rpc_call_done = nfsd4_cb_done,
1146 .rpc_release = nfsd4_cb_release,
1147};
1148
1149int nfsd4_create_callback_queue(void)
1150{
1151 callback_wq = alloc_ordered_workqueue("nfsd4_callbacks", 0);
1152 if (!callback_wq)
1153 return -ENOMEM;
1154 return 0;
1155}
1156
1157void nfsd4_destroy_callback_queue(void)
1158{
1159 destroy_workqueue(callback_wq);
1160}
1161
1162/* must be called under the state lock */
1163void nfsd4_shutdown_callback(struct nfs4_client *clp)
1164{
1165 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
1166 /*
1167 * Note this won't actually result in a null callback;
1168 * instead, nfsd4_run_cb_null() will detect the killed
1169 * client, destroy the rpc client, and stop:
1170 */
1171 nfsd4_run_cb(&clp->cl_cb_null);
1172 flush_workqueue(callback_wq);
1173}
1174
1175/* requires cl_lock: */
1176static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
1177{
1178 struct nfsd4_session *s;
1179 struct nfsd4_conn *c;
1180
1181 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
1182 list_for_each_entry(c, &s->se_conns, cn_persession) {
1183 if (c->cn_flags & NFS4_CDFC4_BACK)
1184 return c;
1185 }
1186 }
1187 return NULL;
1188}
1189
1190static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
1191{
1192 struct nfs4_cb_conn conn;
1193 struct nfs4_client *clp = cb->cb_clp;
1194 struct nfsd4_session *ses = NULL;
1195 struct nfsd4_conn *c;
1196 int err;
1197
1198 /*
1199 * This is either an update, or the client dying; in either case,
1200 * kill the old client:
1201 */
1202 if (clp->cl_cb_client) {
1203 rpc_shutdown_client(clp->cl_cb_client);
1204 clp->cl_cb_client = NULL;
1205 put_cred(clp->cl_cb_cred);
1206 clp->cl_cb_cred = NULL;
1207 }
1208 if (clp->cl_cb_conn.cb_xprt) {
1209 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
1210 clp->cl_cb_conn.cb_xprt = NULL;
1211 }
1212 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
1213 return;
1214 spin_lock(&clp->cl_lock);
1215 /*
1216 * Only serialized callback code is allowed to clear these
1217 * flags; main nfsd code can only set them:
1218 */
1219 BUG_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
1220 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
1221 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
1222 c = __nfsd4_find_backchannel(clp);
1223 if (c) {
1224 svc_xprt_get(c->cn_xprt);
1225 conn.cb_xprt = c->cn_xprt;
1226 ses = c->cn_session;
1227 }
1228 spin_unlock(&clp->cl_lock);
1229
1230 err = setup_callback_client(clp, &conn, ses);
1231 if (err) {
1232 nfsd4_mark_cb_down(clp, err);
1233 return;
1234 }
1235}
1236
1237static void
1238nfsd4_run_cb_work(struct work_struct *work)
1239{
1240 struct nfsd4_callback *cb =
1241 container_of(work, struct nfsd4_callback, cb_work);
1242 struct nfs4_client *clp = cb->cb_clp;
1243 struct rpc_clnt *clnt;
1244
1245 if (cb->cb_need_restart) {
1246 cb->cb_need_restart = false;
1247 } else {
1248 if (cb->cb_ops && cb->cb_ops->prepare)
1249 cb->cb_ops->prepare(cb);
1250 }
1251
1252 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
1253 nfsd4_process_cb_update(cb);
1254
1255 clnt = clp->cl_cb_client;
1256 if (!clnt) {
1257 /* Callback channel broken, or client killed; give up: */
1258 if (cb->cb_ops && cb->cb_ops->release)
1259 cb->cb_ops->release(cb);
1260 return;
1261 }
1262
1263 /*
1264 * Don't send probe messages for 4.1 or later.
1265 */
1266 if (!cb->cb_ops && clp->cl_minorversion) {
1267 clp->cl_cb_state = NFSD4_CB_UP;
1268 return;
1269 }
1270
1271 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
1272 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
1273 cb->cb_ops ? &nfsd4_cb_ops : &nfsd4_cb_probe_ops, cb);
1274}
1275
1276void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
1277 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op)
1278{
1279 cb->cb_clp = clp;
1280 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[op];
1281 cb->cb_msg.rpc_argp = cb;
1282 cb->cb_msg.rpc_resp = cb;
1283 cb->cb_ops = ops;
1284 INIT_WORK(&cb->cb_work, nfsd4_run_cb_work);
1285 cb->cb_seq_status = 1;
1286 cb->cb_status = 0;
1287 cb->cb_need_restart = false;
1288 cb->cb_holds_slot = false;
1289}
1290
1291void nfsd4_run_cb(struct nfsd4_callback *cb)
1292{
1293 queue_work(callback_wq, &cb->cb_work);
1294}