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 "trace.h"
42#include "xdr4cb.h"
43#include "xdr4.h"
44
45#define NFSDDBG_FACILITY NFSDDBG_PROC
46
47static void nfsd4_mark_cb_fault(struct nfs4_client *, int reason);
48
49#define NFSPROC4_CB_NULL 0
50#define NFSPROC4_CB_COMPOUND 1
51
52/* Index of predefined Linux callback client operations */
53
54struct nfs4_cb_compound_hdr {
55 /* args */
56 u32 ident; /* minorversion 0 only */
57 u32 nops;
58 __be32 *nops_p;
59 u32 minorversion;
60 /* res */
61 int status;
62};
63
64static __be32 *xdr_encode_empty_array(__be32 *p)
65{
66 *p++ = xdr_zero;
67 return p;
68}
69
70/*
71 * Encode/decode NFSv4 CB basic data types
72 *
73 * Basic NFSv4 callback data types are defined in section 15 of RFC
74 * 3530: "Network File System (NFS) version 4 Protocol" and section
75 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
76 * 1 Protocol"
77 */
78
79static void encode_uint32(struct xdr_stream *xdr, u32 n)
80{
81 WARN_ON_ONCE(xdr_stream_encode_u32(xdr, n) < 0);
82}
83
84static void encode_bitmap4(struct xdr_stream *xdr, const __u32 *bitmap,
85 size_t len)
86{
87 WARN_ON_ONCE(xdr_stream_encode_uint32_array(xdr, bitmap, len) < 0);
88}
89
90/*
91 * nfs_cb_opnum4
92 *
93 * enum nfs_cb_opnum4 {
94 * OP_CB_GETATTR = 3,
95 * ...
96 * };
97 */
98enum nfs_cb_opnum4 {
99 OP_CB_GETATTR = 3,
100 OP_CB_RECALL = 4,
101 OP_CB_LAYOUTRECALL = 5,
102 OP_CB_NOTIFY = 6,
103 OP_CB_PUSH_DELEG = 7,
104 OP_CB_RECALL_ANY = 8,
105 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
106 OP_CB_RECALL_SLOT = 10,
107 OP_CB_SEQUENCE = 11,
108 OP_CB_WANTS_CANCELLED = 12,
109 OP_CB_NOTIFY_LOCK = 13,
110 OP_CB_NOTIFY_DEVICEID = 14,
111 OP_CB_OFFLOAD = 15,
112 OP_CB_ILLEGAL = 10044
113};
114
115static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
116{
117 __be32 *p;
118
119 p = xdr_reserve_space(xdr, 4);
120 *p = cpu_to_be32(op);
121}
122
123/*
124 * nfs_fh4
125 *
126 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
127 */
128static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
129{
130 u32 length = fh->fh_size;
131 __be32 *p;
132
133 BUG_ON(length > NFS4_FHSIZE);
134 p = xdr_reserve_space(xdr, 4 + length);
135 xdr_encode_opaque(p, &fh->fh_raw, length);
136}
137
138/*
139 * stateid4
140 *
141 * struct stateid4 {
142 * uint32_t seqid;
143 * opaque other[12];
144 * };
145 */
146static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
147{
148 __be32 *p;
149
150 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
151 *p++ = cpu_to_be32(sid->si_generation);
152 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
153}
154
155/*
156 * sessionid4
157 *
158 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
159 */
160static void encode_sessionid4(struct xdr_stream *xdr,
161 const struct nfsd4_session *session)
162{
163 __be32 *p;
164
165 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
166 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
167 NFS4_MAX_SESSIONID_LEN);
168}
169
170/*
171 * nfsstat4
172 */
173static const struct {
174 int stat;
175 int errno;
176} nfs_cb_errtbl[] = {
177 { NFS4_OK, 0 },
178 { NFS4ERR_PERM, -EPERM },
179 { NFS4ERR_NOENT, -ENOENT },
180 { NFS4ERR_IO, -EIO },
181 { NFS4ERR_NXIO, -ENXIO },
182 { NFS4ERR_ACCESS, -EACCES },
183 { NFS4ERR_EXIST, -EEXIST },
184 { NFS4ERR_XDEV, -EXDEV },
185 { NFS4ERR_NOTDIR, -ENOTDIR },
186 { NFS4ERR_ISDIR, -EISDIR },
187 { NFS4ERR_INVAL, -EINVAL },
188 { NFS4ERR_FBIG, -EFBIG },
189 { NFS4ERR_NOSPC, -ENOSPC },
190 { NFS4ERR_ROFS, -EROFS },
191 { NFS4ERR_MLINK, -EMLINK },
192 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
193 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
194 { NFS4ERR_DQUOT, -EDQUOT },
195 { NFS4ERR_STALE, -ESTALE },
196 { NFS4ERR_BADHANDLE, -EBADHANDLE },
197 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
198 { NFS4ERR_NOTSUPP, -ENOTSUPP },
199 { NFS4ERR_TOOSMALL, -ETOOSMALL },
200 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
201 { NFS4ERR_BADTYPE, -EBADTYPE },
202 { NFS4ERR_LOCKED, -EAGAIN },
203 { NFS4ERR_RESOURCE, -EREMOTEIO },
204 { NFS4ERR_SYMLINK, -ELOOP },
205 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
206 { NFS4ERR_DEADLOCK, -EDEADLK },
207 { -1, -EIO }
208};
209
210/*
211 * If we cannot translate the error, the recovery routines should
212 * handle it.
213 *
214 * Note: remaining NFSv4 error codes have values > 10000, so should
215 * not conflict with native Linux error codes.
216 */
217static int nfs_cb_stat_to_errno(int status)
218{
219 int i;
220
221 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
222 if (nfs_cb_errtbl[i].stat == status)
223 return nfs_cb_errtbl[i].errno;
224 }
225
226 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
227 return -status;
228}
229
230static int decode_cb_op_status(struct xdr_stream *xdr,
231 enum nfs_cb_opnum4 expected, int *status)
232{
233 __be32 *p;
234 u32 op;
235
236 p = xdr_inline_decode(xdr, 4 + 4);
237 if (unlikely(p == NULL))
238 goto out_overflow;
239 op = be32_to_cpup(p++);
240 if (unlikely(op != expected))
241 goto out_unexpected;
242 *status = nfs_cb_stat_to_errno(be32_to_cpup(p));
243 return 0;
244out_overflow:
245 return -EIO;
246out_unexpected:
247 dprintk("NFSD: Callback server returned operation %d but "
248 "we issued a request for %d\n", op, expected);
249 return -EIO;
250}
251
252/*
253 * CB_COMPOUND4args
254 *
255 * struct CB_COMPOUND4args {
256 * utf8str_cs tag;
257 * uint32_t minorversion;
258 * uint32_t callback_ident;
259 * nfs_cb_argop4 argarray<>;
260 * };
261*/
262static void encode_cb_compound4args(struct xdr_stream *xdr,
263 struct nfs4_cb_compound_hdr *hdr)
264{
265 __be32 * p;
266
267 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
268 p = xdr_encode_empty_array(p); /* empty tag */
269 *p++ = cpu_to_be32(hdr->minorversion);
270 *p++ = cpu_to_be32(hdr->ident);
271
272 hdr->nops_p = p;
273 *p = cpu_to_be32(hdr->nops); /* argarray element count */
274}
275
276/*
277 * Update argarray element count
278 */
279static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
280{
281 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
282 *hdr->nops_p = cpu_to_be32(hdr->nops);
283}
284
285/*
286 * CB_COMPOUND4res
287 *
288 * struct CB_COMPOUND4res {
289 * nfsstat4 status;
290 * utf8str_cs tag;
291 * nfs_cb_resop4 resarray<>;
292 * };
293 */
294static int decode_cb_compound4res(struct xdr_stream *xdr,
295 struct nfs4_cb_compound_hdr *hdr)
296{
297 u32 length;
298 __be32 *p;
299
300 p = xdr_inline_decode(xdr, 4 + 4);
301 if (unlikely(p == NULL))
302 goto out_overflow;
303 hdr->status = be32_to_cpup(p++);
304 /* Ignore the tag */
305 length = be32_to_cpup(p++);
306 p = xdr_inline_decode(xdr, length + 4);
307 if (unlikely(p == NULL))
308 goto out_overflow;
309 p += XDR_QUADLEN(length);
310 hdr->nops = be32_to_cpup(p);
311 return 0;
312out_overflow:
313 return -EIO;
314}
315
316/*
317 * CB_RECALL4args
318 *
319 * struct CB_RECALL4args {
320 * stateid4 stateid;
321 * bool truncate;
322 * nfs_fh4 fh;
323 * };
324 */
325static void encode_cb_recall4args(struct xdr_stream *xdr,
326 const struct nfs4_delegation *dp,
327 struct nfs4_cb_compound_hdr *hdr)
328{
329 __be32 *p;
330
331 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
332 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
333
334 p = xdr_reserve_space(xdr, 4);
335 *p++ = xdr_zero; /* truncate */
336
337 encode_nfs_fh4(xdr, &dp->dl_stid.sc_file->fi_fhandle);
338
339 hdr->nops++;
340}
341
342/*
343 * CB_RECALLANY4args
344 *
345 * struct CB_RECALLANY4args {
346 * uint32_t craa_objects_to_keep;
347 * bitmap4 craa_type_mask;
348 * };
349 */
350static void
351encode_cb_recallany4args(struct xdr_stream *xdr,
352 struct nfs4_cb_compound_hdr *hdr, struct nfsd4_cb_recall_any *ra)
353{
354 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL_ANY);
355 encode_uint32(xdr, ra->ra_keep);
356 encode_bitmap4(xdr, ra->ra_bmval, ARRAY_SIZE(ra->ra_bmval));
357 hdr->nops++;
358}
359
360/*
361 * CB_SEQUENCE4args
362 *
363 * struct CB_SEQUENCE4args {
364 * sessionid4 csa_sessionid;
365 * sequenceid4 csa_sequenceid;
366 * slotid4 csa_slotid;
367 * slotid4 csa_highest_slotid;
368 * bool csa_cachethis;
369 * referring_call_list4 csa_referring_call_lists<>;
370 * };
371 */
372static void encode_cb_sequence4args(struct xdr_stream *xdr,
373 const struct nfsd4_callback *cb,
374 struct nfs4_cb_compound_hdr *hdr)
375{
376 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
377 __be32 *p;
378
379 if (hdr->minorversion == 0)
380 return;
381
382 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
383 encode_sessionid4(xdr, session);
384
385 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
386 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
387 *p++ = xdr_zero; /* csa_slotid */
388 *p++ = xdr_zero; /* csa_highest_slotid */
389 *p++ = xdr_zero; /* csa_cachethis */
390 xdr_encode_empty_array(p); /* csa_referring_call_lists */
391
392 hdr->nops++;
393}
394
395/*
396 * CB_SEQUENCE4resok
397 *
398 * struct CB_SEQUENCE4resok {
399 * sessionid4 csr_sessionid;
400 * sequenceid4 csr_sequenceid;
401 * slotid4 csr_slotid;
402 * slotid4 csr_highest_slotid;
403 * slotid4 csr_target_highest_slotid;
404 * };
405 *
406 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
407 * case NFS4_OK:
408 * CB_SEQUENCE4resok csr_resok4;
409 * default:
410 * void;
411 * };
412 *
413 * Our current back channel implmentation supports a single backchannel
414 * with a single slot.
415 */
416static int decode_cb_sequence4resok(struct xdr_stream *xdr,
417 struct nfsd4_callback *cb)
418{
419 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
420 int status = -ESERVERFAULT;
421 __be32 *p;
422 u32 dummy;
423
424 /*
425 * If the server returns different values for sessionID, slotID or
426 * sequence number, the server is looney tunes.
427 */
428 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
429 if (unlikely(p == NULL))
430 goto out_overflow;
431
432 if (memcmp(p, session->se_sessionid.data, NFS4_MAX_SESSIONID_LEN)) {
433 dprintk("NFS: %s Invalid session id\n", __func__);
434 goto out;
435 }
436 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
437
438 dummy = be32_to_cpup(p++);
439 if (dummy != session->se_cb_seq_nr) {
440 dprintk("NFS: %s Invalid sequence number\n", __func__);
441 goto out;
442 }
443
444 dummy = be32_to_cpup(p++);
445 if (dummy != 0) {
446 dprintk("NFS: %s Invalid slotid\n", __func__);
447 goto out;
448 }
449
450 /*
451 * FIXME: process highest slotid and target highest slotid
452 */
453 status = 0;
454out:
455 cb->cb_seq_status = status;
456 return status;
457out_overflow:
458 status = -EIO;
459 goto out;
460}
461
462static int decode_cb_sequence4res(struct xdr_stream *xdr,
463 struct nfsd4_callback *cb)
464{
465 int status;
466
467 if (cb->cb_clp->cl_minorversion == 0)
468 return 0;
469
470 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &cb->cb_seq_status);
471 if (unlikely(status || cb->cb_seq_status))
472 return status;
473
474 return decode_cb_sequence4resok(xdr, cb);
475}
476
477/*
478 * NFSv4.0 and NFSv4.1 XDR encode functions
479 *
480 * NFSv4.0 callback argument types are defined in section 15 of RFC
481 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
482 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
483 * Protocol".
484 */
485
486/*
487 * NB: Without this zero space reservation, callbacks over krb5p fail
488 */
489static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
490 const void *__unused)
491{
492 xdr_reserve_space(xdr, 0);
493}
494
495/*
496 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
497 */
498static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
499 const void *data)
500{
501 const struct nfsd4_callback *cb = data;
502 const struct nfs4_delegation *dp = cb_to_delegation(cb);
503 struct nfs4_cb_compound_hdr hdr = {
504 .ident = cb->cb_clp->cl_cb_ident,
505 .minorversion = cb->cb_clp->cl_minorversion,
506 };
507
508 encode_cb_compound4args(xdr, &hdr);
509 encode_cb_sequence4args(xdr, cb, &hdr);
510 encode_cb_recall4args(xdr, dp, &hdr);
511 encode_cb_nops(&hdr);
512}
513
514/*
515 * 20.6. Operation 8: CB_RECALL_ANY - Keep Any N Recallable Objects
516 */
517static void
518nfs4_xdr_enc_cb_recall_any(struct rpc_rqst *req,
519 struct xdr_stream *xdr, const void *data)
520{
521 const struct nfsd4_callback *cb = data;
522 struct nfsd4_cb_recall_any *ra;
523 struct nfs4_cb_compound_hdr hdr = {
524 .ident = cb->cb_clp->cl_cb_ident,
525 .minorversion = cb->cb_clp->cl_minorversion,
526 };
527
528 ra = container_of(cb, struct nfsd4_cb_recall_any, ra_cb);
529 encode_cb_compound4args(xdr, &hdr);
530 encode_cb_sequence4args(xdr, cb, &hdr);
531 encode_cb_recallany4args(xdr, &hdr, ra);
532 encode_cb_nops(&hdr);
533}
534
535/*
536 * NFSv4.0 and NFSv4.1 XDR decode functions
537 *
538 * NFSv4.0 callback result types are defined in section 15 of RFC
539 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
540 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
541 * Protocol".
542 */
543
544static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
545 void *__unused)
546{
547 return 0;
548}
549
550/*
551 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
552 */
553static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
554 struct xdr_stream *xdr,
555 void *data)
556{
557 struct nfsd4_callback *cb = data;
558 struct nfs4_cb_compound_hdr hdr;
559 int status;
560
561 status = decode_cb_compound4res(xdr, &hdr);
562 if (unlikely(status))
563 return status;
564
565 status = decode_cb_sequence4res(xdr, cb);
566 if (unlikely(status || cb->cb_seq_status))
567 return status;
568
569 return decode_cb_op_status(xdr, OP_CB_RECALL, &cb->cb_status);
570}
571
572/*
573 * 20.6. Operation 8: CB_RECALL_ANY - Keep Any N Recallable Objects
574 */
575static int
576nfs4_xdr_dec_cb_recall_any(struct rpc_rqst *rqstp,
577 struct xdr_stream *xdr,
578 void *data)
579{
580 struct nfsd4_callback *cb = data;
581 struct nfs4_cb_compound_hdr hdr;
582 int status;
583
584 status = decode_cb_compound4res(xdr, &hdr);
585 if (unlikely(status))
586 return status;
587 status = decode_cb_sequence4res(xdr, cb);
588 if (unlikely(status || cb->cb_seq_status))
589 return status;
590 status = decode_cb_op_status(xdr, OP_CB_RECALL_ANY, &cb->cb_status);
591 return status;
592}
593
594#ifdef CONFIG_NFSD_PNFS
595/*
596 * CB_LAYOUTRECALL4args
597 *
598 * struct layoutrecall_file4 {
599 * nfs_fh4 lor_fh;
600 * offset4 lor_offset;
601 * length4 lor_length;
602 * stateid4 lor_stateid;
603 * };
604 *
605 * union layoutrecall4 switch(layoutrecall_type4 lor_recalltype) {
606 * case LAYOUTRECALL4_FILE:
607 * layoutrecall_file4 lor_layout;
608 * case LAYOUTRECALL4_FSID:
609 * fsid4 lor_fsid;
610 * case LAYOUTRECALL4_ALL:
611 * void;
612 * };
613 *
614 * struct CB_LAYOUTRECALL4args {
615 * layouttype4 clora_type;
616 * layoutiomode4 clora_iomode;
617 * bool clora_changed;
618 * layoutrecall4 clora_recall;
619 * };
620 */
621static void encode_cb_layout4args(struct xdr_stream *xdr,
622 const struct nfs4_layout_stateid *ls,
623 struct nfs4_cb_compound_hdr *hdr)
624{
625 __be32 *p;
626
627 BUG_ON(hdr->minorversion == 0);
628
629 p = xdr_reserve_space(xdr, 5 * 4);
630 *p++ = cpu_to_be32(OP_CB_LAYOUTRECALL);
631 *p++ = cpu_to_be32(ls->ls_layout_type);
632 *p++ = cpu_to_be32(IOMODE_ANY);
633 *p++ = cpu_to_be32(1);
634 *p = cpu_to_be32(RETURN_FILE);
635
636 encode_nfs_fh4(xdr, &ls->ls_stid.sc_file->fi_fhandle);
637
638 p = xdr_reserve_space(xdr, 2 * 8);
639 p = xdr_encode_hyper(p, 0);
640 xdr_encode_hyper(p, NFS4_MAX_UINT64);
641
642 encode_stateid4(xdr, &ls->ls_recall_sid);
643
644 hdr->nops++;
645}
646
647static void nfs4_xdr_enc_cb_layout(struct rpc_rqst *req,
648 struct xdr_stream *xdr,
649 const void *data)
650{
651 const struct nfsd4_callback *cb = data;
652 const struct nfs4_layout_stateid *ls =
653 container_of(cb, struct nfs4_layout_stateid, ls_recall);
654 struct nfs4_cb_compound_hdr hdr = {
655 .ident = 0,
656 .minorversion = cb->cb_clp->cl_minorversion,
657 };
658
659 encode_cb_compound4args(xdr, &hdr);
660 encode_cb_sequence4args(xdr, cb, &hdr);
661 encode_cb_layout4args(xdr, ls, &hdr);
662 encode_cb_nops(&hdr);
663}
664
665static int nfs4_xdr_dec_cb_layout(struct rpc_rqst *rqstp,
666 struct xdr_stream *xdr,
667 void *data)
668{
669 struct nfsd4_callback *cb = data;
670 struct nfs4_cb_compound_hdr hdr;
671 int status;
672
673 status = decode_cb_compound4res(xdr, &hdr);
674 if (unlikely(status))
675 return status;
676
677 status = decode_cb_sequence4res(xdr, cb);
678 if (unlikely(status || cb->cb_seq_status))
679 return status;
680
681 return decode_cb_op_status(xdr, OP_CB_LAYOUTRECALL, &cb->cb_status);
682}
683#endif /* CONFIG_NFSD_PNFS */
684
685static void encode_stateowner(struct xdr_stream *xdr, struct nfs4_stateowner *so)
686{
687 __be32 *p;
688
689 p = xdr_reserve_space(xdr, 8 + 4 + so->so_owner.len);
690 p = xdr_encode_opaque_fixed(p, &so->so_client->cl_clientid, 8);
691 xdr_encode_opaque(p, so->so_owner.data, so->so_owner.len);
692}
693
694static void nfs4_xdr_enc_cb_notify_lock(struct rpc_rqst *req,
695 struct xdr_stream *xdr,
696 const void *data)
697{
698 const struct nfsd4_callback *cb = data;
699 const struct nfsd4_blocked_lock *nbl =
700 container_of(cb, struct nfsd4_blocked_lock, nbl_cb);
701 struct nfs4_lockowner *lo = (struct nfs4_lockowner *)nbl->nbl_lock.fl_owner;
702 struct nfs4_cb_compound_hdr hdr = {
703 .ident = 0,
704 .minorversion = cb->cb_clp->cl_minorversion,
705 };
706
707 __be32 *p;
708
709 BUG_ON(hdr.minorversion == 0);
710
711 encode_cb_compound4args(xdr, &hdr);
712 encode_cb_sequence4args(xdr, cb, &hdr);
713
714 p = xdr_reserve_space(xdr, 4);
715 *p = cpu_to_be32(OP_CB_NOTIFY_LOCK);
716 encode_nfs_fh4(xdr, &nbl->nbl_fh);
717 encode_stateowner(xdr, &lo->lo_owner);
718 hdr.nops++;
719
720 encode_cb_nops(&hdr);
721}
722
723static int nfs4_xdr_dec_cb_notify_lock(struct rpc_rqst *rqstp,
724 struct xdr_stream *xdr,
725 void *data)
726{
727 struct nfsd4_callback *cb = data;
728 struct nfs4_cb_compound_hdr hdr;
729 int status;
730
731 status = decode_cb_compound4res(xdr, &hdr);
732 if (unlikely(status))
733 return status;
734
735 status = decode_cb_sequence4res(xdr, cb);
736 if (unlikely(status || cb->cb_seq_status))
737 return status;
738
739 return decode_cb_op_status(xdr, OP_CB_NOTIFY_LOCK, &cb->cb_status);
740}
741
742/*
743 * struct write_response4 {
744 * stateid4 wr_callback_id<1>;
745 * length4 wr_count;
746 * stable_how4 wr_committed;
747 * verifier4 wr_writeverf;
748 * };
749 * union offload_info4 switch (nfsstat4 coa_status) {
750 * case NFS4_OK:
751 * write_response4 coa_resok4;
752 * default:
753 * length4 coa_bytes_copied;
754 * };
755 * struct CB_OFFLOAD4args {
756 * nfs_fh4 coa_fh;
757 * stateid4 coa_stateid;
758 * offload_info4 coa_offload_info;
759 * };
760 */
761static void encode_offload_info4(struct xdr_stream *xdr,
762 const struct nfsd4_cb_offload *cbo)
763{
764 __be32 *p;
765
766 p = xdr_reserve_space(xdr, 4);
767 *p = cbo->co_nfserr;
768 switch (cbo->co_nfserr) {
769 case nfs_ok:
770 p = xdr_reserve_space(xdr, 4 + 8 + 4 + NFS4_VERIFIER_SIZE);
771 p = xdr_encode_empty_array(p);
772 p = xdr_encode_hyper(p, cbo->co_res.wr_bytes_written);
773 *p++ = cpu_to_be32(cbo->co_res.wr_stable_how);
774 p = xdr_encode_opaque_fixed(p, cbo->co_res.wr_verifier.data,
775 NFS4_VERIFIER_SIZE);
776 break;
777 default:
778 p = xdr_reserve_space(xdr, 8);
779 /* We always return success if bytes were written */
780 p = xdr_encode_hyper(p, 0);
781 }
782}
783
784static void encode_cb_offload4args(struct xdr_stream *xdr,
785 const struct nfsd4_cb_offload *cbo,
786 struct nfs4_cb_compound_hdr *hdr)
787{
788 __be32 *p;
789
790 p = xdr_reserve_space(xdr, 4);
791 *p = cpu_to_be32(OP_CB_OFFLOAD);
792 encode_nfs_fh4(xdr, &cbo->co_fh);
793 encode_stateid4(xdr, &cbo->co_res.cb_stateid);
794 encode_offload_info4(xdr, cbo);
795
796 hdr->nops++;
797}
798
799static void nfs4_xdr_enc_cb_offload(struct rpc_rqst *req,
800 struct xdr_stream *xdr,
801 const void *data)
802{
803 const struct nfsd4_callback *cb = data;
804 const struct nfsd4_cb_offload *cbo =
805 container_of(cb, struct nfsd4_cb_offload, co_cb);
806 struct nfs4_cb_compound_hdr hdr = {
807 .ident = 0,
808 .minorversion = cb->cb_clp->cl_minorversion,
809 };
810
811 encode_cb_compound4args(xdr, &hdr);
812 encode_cb_sequence4args(xdr, cb, &hdr);
813 encode_cb_offload4args(xdr, cbo, &hdr);
814 encode_cb_nops(&hdr);
815}
816
817static int nfs4_xdr_dec_cb_offload(struct rpc_rqst *rqstp,
818 struct xdr_stream *xdr,
819 void *data)
820{
821 struct nfsd4_callback *cb = data;
822 struct nfs4_cb_compound_hdr hdr;
823 int status;
824
825 status = decode_cb_compound4res(xdr, &hdr);
826 if (unlikely(status))
827 return status;
828
829 status = decode_cb_sequence4res(xdr, cb);
830 if (unlikely(status || cb->cb_seq_status))
831 return status;
832
833 return decode_cb_op_status(xdr, OP_CB_OFFLOAD, &cb->cb_status);
834}
835/*
836 * RPC procedure tables
837 */
838#define PROC(proc, call, argtype, restype) \
839[NFSPROC4_CLNT_##proc] = { \
840 .p_proc = NFSPROC4_CB_##call, \
841 .p_encode = nfs4_xdr_enc_##argtype, \
842 .p_decode = nfs4_xdr_dec_##restype, \
843 .p_arglen = NFS4_enc_##argtype##_sz, \
844 .p_replen = NFS4_dec_##restype##_sz, \
845 .p_statidx = NFSPROC4_CB_##call, \
846 .p_name = #proc, \
847}
848
849static const struct rpc_procinfo nfs4_cb_procedures[] = {
850 PROC(CB_NULL, NULL, cb_null, cb_null),
851 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
852#ifdef CONFIG_NFSD_PNFS
853 PROC(CB_LAYOUT, COMPOUND, cb_layout, cb_layout),
854#endif
855 PROC(CB_NOTIFY_LOCK, COMPOUND, cb_notify_lock, cb_notify_lock),
856 PROC(CB_OFFLOAD, COMPOUND, cb_offload, cb_offload),
857 PROC(CB_RECALL_ANY, COMPOUND, cb_recall_any, cb_recall_any),
858};
859
860static unsigned int nfs4_cb_counts[ARRAY_SIZE(nfs4_cb_procedures)];
861static const struct rpc_version nfs_cb_version4 = {
862/*
863 * Note on the callback rpc program version number: despite language in rfc
864 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
865 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
866 * in practice that appears to be what implementations use. The section
867 * 18.36.3 language is expected to be fixed in an erratum.
868 */
869 .number = 1,
870 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
871 .procs = nfs4_cb_procedures,
872 .counts = nfs4_cb_counts,
873};
874
875static const struct rpc_version *nfs_cb_version[2] = {
876 [1] = &nfs_cb_version4,
877};
878
879static const struct rpc_program cb_program;
880
881static struct rpc_stat cb_stats = {
882 .program = &cb_program
883};
884
885#define NFS4_CALLBACK 0x40000000
886static const struct rpc_program cb_program = {
887 .name = "nfs4_cb",
888 .number = NFS4_CALLBACK,
889 .nrvers = ARRAY_SIZE(nfs_cb_version),
890 .version = nfs_cb_version,
891 .stats = &cb_stats,
892 .pipe_dir_name = "nfsd4_cb",
893};
894
895static int max_cb_time(struct net *net)
896{
897 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
898
899 /*
900 * nfsd4_lease is set to at most one hour in __nfsd4_write_time,
901 * so we can use 32-bit math on it. Warn if that assumption
902 * ever stops being true.
903 */
904 if (WARN_ON_ONCE(nn->nfsd4_lease > 3600))
905 return 360 * HZ;
906
907 return max(((u32)nn->nfsd4_lease)/10, 1u) * HZ;
908}
909
910static struct workqueue_struct *callback_wq;
911
912static bool nfsd4_queue_cb(struct nfsd4_callback *cb)
913{
914 return queue_work(callback_wq, &cb->cb_work);
915}
916
917static void nfsd41_cb_inflight_begin(struct nfs4_client *clp)
918{
919 atomic_inc(&clp->cl_cb_inflight);
920}
921
922static void nfsd41_cb_inflight_end(struct nfs4_client *clp)
923{
924
925 if (atomic_dec_and_test(&clp->cl_cb_inflight))
926 wake_up_var(&clp->cl_cb_inflight);
927}
928
929static void nfsd41_cb_inflight_wait_complete(struct nfs4_client *clp)
930{
931 wait_var_event(&clp->cl_cb_inflight,
932 !atomic_read(&clp->cl_cb_inflight));
933}
934
935static const struct cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
936{
937 if (clp->cl_minorversion == 0) {
938 client->cl_principal = clp->cl_cred.cr_targ_princ ?
939 clp->cl_cred.cr_targ_princ : "nfs";
940
941 return get_cred(rpc_machine_cred());
942 } else {
943 struct cred *kcred;
944
945 kcred = prepare_kernel_cred(&init_task);
946 if (!kcred)
947 return NULL;
948
949 kcred->uid = ses->se_cb_sec.uid;
950 kcred->gid = ses->se_cb_sec.gid;
951 return kcred;
952 }
953}
954
955static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
956{
957 int maxtime = max_cb_time(clp->net);
958 struct rpc_timeout timeparms = {
959 .to_initval = maxtime,
960 .to_retries = 0,
961 .to_maxval = maxtime,
962 };
963 struct rpc_create_args args = {
964 .net = clp->net,
965 .address = (struct sockaddr *) &conn->cb_addr,
966 .addrsize = conn->cb_addrlen,
967 .saddress = (struct sockaddr *) &conn->cb_saddr,
968 .timeout = &timeparms,
969 .program = &cb_program,
970 .version = 1,
971 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
972 .cred = current_cred(),
973 };
974 struct rpc_clnt *client;
975 const struct cred *cred;
976
977 if (clp->cl_minorversion == 0) {
978 if (!clp->cl_cred.cr_principal &&
979 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5)) {
980 trace_nfsd_cb_setup_err(clp, -EINVAL);
981 return -EINVAL;
982 }
983 args.client_name = clp->cl_cred.cr_principal;
984 args.prognumber = conn->cb_prog;
985 args.protocol = XPRT_TRANSPORT_TCP;
986 args.authflavor = clp->cl_cred.cr_flavor;
987 clp->cl_cb_ident = conn->cb_ident;
988 } else {
989 if (!conn->cb_xprt)
990 return -EINVAL;
991 clp->cl_cb_session = ses;
992 args.bc_xprt = conn->cb_xprt;
993 args.prognumber = clp->cl_cb_session->se_cb_prog;
994 args.protocol = conn->cb_xprt->xpt_class->xcl_ident |
995 XPRT_TRANSPORT_BC;
996 args.authflavor = ses->se_cb_sec.flavor;
997 }
998 /* Create RPC client */
999 client = rpc_create(&args);
1000 if (IS_ERR(client)) {
1001 trace_nfsd_cb_setup_err(clp, PTR_ERR(client));
1002 return PTR_ERR(client);
1003 }
1004 cred = get_backchannel_cred(clp, client, ses);
1005 if (!cred) {
1006 trace_nfsd_cb_setup_err(clp, -ENOMEM);
1007 rpc_shutdown_client(client);
1008 return -ENOMEM;
1009 }
1010
1011 if (clp->cl_minorversion != 0)
1012 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
1013 clp->cl_cb_client = client;
1014 clp->cl_cb_cred = cred;
1015 rcu_read_lock();
1016 trace_nfsd_cb_setup(clp, rpc_peeraddr2str(client, RPC_DISPLAY_NETID),
1017 args.authflavor);
1018 rcu_read_unlock();
1019 return 0;
1020}
1021
1022static void nfsd4_mark_cb_state(struct nfs4_client *clp, int newstate)
1023{
1024 if (clp->cl_cb_state != newstate) {
1025 clp->cl_cb_state = newstate;
1026 trace_nfsd_cb_state(clp);
1027 }
1028}
1029
1030static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
1031{
1032 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
1033 return;
1034 nfsd4_mark_cb_state(clp, NFSD4_CB_DOWN);
1035}
1036
1037static void nfsd4_mark_cb_fault(struct nfs4_client *clp, int reason)
1038{
1039 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
1040 return;
1041 nfsd4_mark_cb_state(clp, NFSD4_CB_FAULT);
1042}
1043
1044static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
1045{
1046 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
1047
1048 if (task->tk_status)
1049 nfsd4_mark_cb_down(clp, task->tk_status);
1050 else
1051 nfsd4_mark_cb_state(clp, NFSD4_CB_UP);
1052}
1053
1054static void nfsd4_cb_probe_release(void *calldata)
1055{
1056 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
1057
1058 nfsd41_cb_inflight_end(clp);
1059
1060}
1061
1062static const struct rpc_call_ops nfsd4_cb_probe_ops = {
1063 /* XXX: release method to ensure we set the cb channel down if
1064 * necessary on early failure? */
1065 .rpc_call_done = nfsd4_cb_probe_done,
1066 .rpc_release = nfsd4_cb_probe_release,
1067};
1068
1069/*
1070 * Poke the callback thread to process any updates to the callback
1071 * parameters, and send a null probe.
1072 */
1073void nfsd4_probe_callback(struct nfs4_client *clp)
1074{
1075 trace_nfsd_cb_probe(clp);
1076 nfsd4_mark_cb_state(clp, NFSD4_CB_UNKNOWN);
1077 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
1078 nfsd4_run_cb(&clp->cl_cb_null);
1079}
1080
1081void nfsd4_probe_callback_sync(struct nfs4_client *clp)
1082{
1083 nfsd4_probe_callback(clp);
1084 flush_workqueue(callback_wq);
1085}
1086
1087void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
1088{
1089 nfsd4_mark_cb_state(clp, NFSD4_CB_UNKNOWN);
1090 spin_lock(&clp->cl_lock);
1091 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
1092 spin_unlock(&clp->cl_lock);
1093}
1094
1095/*
1096 * There's currently a single callback channel slot.
1097 * If the slot is available, then mark it busy. Otherwise, set the
1098 * thread for sleeping on the callback RPC wait queue.
1099 */
1100static bool nfsd41_cb_get_slot(struct nfsd4_callback *cb, struct rpc_task *task)
1101{
1102 struct nfs4_client *clp = cb->cb_clp;
1103
1104 if (!cb->cb_holds_slot &&
1105 test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
1106 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
1107 /* Race breaker */
1108 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
1109 dprintk("%s slot is busy\n", __func__);
1110 return false;
1111 }
1112 rpc_wake_up_queued_task(&clp->cl_cb_waitq, task);
1113 }
1114 cb->cb_holds_slot = true;
1115 return true;
1116}
1117
1118static void nfsd41_cb_release_slot(struct nfsd4_callback *cb)
1119{
1120 struct nfs4_client *clp = cb->cb_clp;
1121
1122 if (cb->cb_holds_slot) {
1123 cb->cb_holds_slot = false;
1124 clear_bit(0, &clp->cl_cb_slot_busy);
1125 rpc_wake_up_next(&clp->cl_cb_waitq);
1126 }
1127}
1128
1129static void nfsd41_destroy_cb(struct nfsd4_callback *cb)
1130{
1131 struct nfs4_client *clp = cb->cb_clp;
1132
1133 nfsd41_cb_release_slot(cb);
1134 if (cb->cb_ops && cb->cb_ops->release)
1135 cb->cb_ops->release(cb);
1136 nfsd41_cb_inflight_end(clp);
1137}
1138
1139/*
1140 * TODO: cb_sequence should support referring call lists, cachethis, multiple
1141 * slots, and mark callback channel down on communication errors.
1142 */
1143static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
1144{
1145 struct nfsd4_callback *cb = calldata;
1146 struct nfs4_client *clp = cb->cb_clp;
1147 u32 minorversion = clp->cl_minorversion;
1148
1149 /*
1150 * cb_seq_status is only set in decode_cb_sequence4res,
1151 * and so will remain 1 if an rpc level failure occurs.
1152 */
1153 cb->cb_seq_status = 1;
1154 cb->cb_status = 0;
1155 if (minorversion && !nfsd41_cb_get_slot(cb, task))
1156 return;
1157 rpc_call_start(task);
1158}
1159
1160static bool nfsd4_cb_sequence_done(struct rpc_task *task, struct nfsd4_callback *cb)
1161{
1162 struct nfs4_client *clp = cb->cb_clp;
1163 struct nfsd4_session *session = clp->cl_cb_session;
1164 bool ret = true;
1165
1166 if (!clp->cl_minorversion) {
1167 /*
1168 * If the backchannel connection was shut down while this
1169 * task was queued, we need to resubmit it after setting up
1170 * a new backchannel connection.
1171 *
1172 * Note that if we lost our callback connection permanently
1173 * the submission code will error out, so we don't need to
1174 * handle that case here.
1175 */
1176 if (RPC_SIGNALLED(task))
1177 goto need_restart;
1178
1179 return true;
1180 }
1181
1182 if (!cb->cb_holds_slot)
1183 goto need_restart;
1184
1185 switch (cb->cb_seq_status) {
1186 case 0:
1187 /*
1188 * No need for lock, access serialized in nfsd4_cb_prepare
1189 *
1190 * RFC5661 20.9.3
1191 * If CB_SEQUENCE returns an error, then the state of the slot
1192 * (sequence ID, cached reply) MUST NOT change.
1193 */
1194 ++session->se_cb_seq_nr;
1195 break;
1196 case -ESERVERFAULT:
1197 ++session->se_cb_seq_nr;
1198 fallthrough;
1199 case 1:
1200 case -NFS4ERR_BADSESSION:
1201 nfsd4_mark_cb_fault(cb->cb_clp, cb->cb_seq_status);
1202 ret = false;
1203 break;
1204 case -NFS4ERR_DELAY:
1205 if (!rpc_restart_call(task))
1206 goto out;
1207
1208 rpc_delay(task, 2 * HZ);
1209 return false;
1210 case -NFS4ERR_BADSLOT:
1211 goto retry_nowait;
1212 case -NFS4ERR_SEQ_MISORDERED:
1213 if (session->se_cb_seq_nr != 1) {
1214 session->se_cb_seq_nr = 1;
1215 goto retry_nowait;
1216 }
1217 break;
1218 default:
1219 nfsd4_mark_cb_fault(cb->cb_clp, cb->cb_seq_status);
1220 dprintk("%s: unprocessed error %d\n", __func__,
1221 cb->cb_seq_status);
1222 }
1223
1224 nfsd41_cb_release_slot(cb);
1225 dprintk("%s: freed slot, new seqid=%d\n", __func__,
1226 clp->cl_cb_session->se_cb_seq_nr);
1227
1228 if (RPC_SIGNALLED(task))
1229 goto need_restart;
1230out:
1231 return ret;
1232retry_nowait:
1233 if (rpc_restart_call_prepare(task))
1234 ret = false;
1235 goto out;
1236need_restart:
1237 if (!test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags)) {
1238 task->tk_status = 0;
1239 cb->cb_need_restart = true;
1240 }
1241 return false;
1242}
1243
1244static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
1245{
1246 struct nfsd4_callback *cb = calldata;
1247 struct nfs4_client *clp = cb->cb_clp;
1248
1249 if (!nfsd4_cb_sequence_done(task, cb))
1250 return;
1251
1252 if (cb->cb_status) {
1253 WARN_ON_ONCE(task->tk_status);
1254 task->tk_status = cb->cb_status;
1255 }
1256
1257 switch (cb->cb_ops->done(cb, task)) {
1258 case 0:
1259 task->tk_status = 0;
1260 rpc_restart_call_prepare(task);
1261 return;
1262 case 1:
1263 switch (task->tk_status) {
1264 case -EIO:
1265 case -ETIMEDOUT:
1266 case -EACCES:
1267 nfsd4_mark_cb_down(clp, task->tk_status);
1268 }
1269 break;
1270 default:
1271 BUG();
1272 }
1273}
1274
1275static void nfsd4_cb_release(void *calldata)
1276{
1277 struct nfsd4_callback *cb = calldata;
1278
1279 if (cb->cb_need_restart)
1280 nfsd4_queue_cb(cb);
1281 else
1282 nfsd41_destroy_cb(cb);
1283
1284}
1285
1286static const struct rpc_call_ops nfsd4_cb_ops = {
1287 .rpc_call_prepare = nfsd4_cb_prepare,
1288 .rpc_call_done = nfsd4_cb_done,
1289 .rpc_release = nfsd4_cb_release,
1290};
1291
1292int nfsd4_create_callback_queue(void)
1293{
1294 callback_wq = alloc_ordered_workqueue("nfsd4_callbacks", 0);
1295 if (!callback_wq)
1296 return -ENOMEM;
1297 return 0;
1298}
1299
1300void nfsd4_destroy_callback_queue(void)
1301{
1302 destroy_workqueue(callback_wq);
1303}
1304
1305/* must be called under the state lock */
1306void nfsd4_shutdown_callback(struct nfs4_client *clp)
1307{
1308 if (clp->cl_cb_state != NFSD4_CB_UNKNOWN)
1309 trace_nfsd_cb_shutdown(clp);
1310
1311 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
1312 /*
1313 * Note this won't actually result in a null callback;
1314 * instead, nfsd4_run_cb_null() will detect the killed
1315 * client, destroy the rpc client, and stop:
1316 */
1317 nfsd4_run_cb(&clp->cl_cb_null);
1318 flush_workqueue(callback_wq);
1319 nfsd41_cb_inflight_wait_complete(clp);
1320}
1321
1322/* requires cl_lock: */
1323static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
1324{
1325 struct nfsd4_session *s;
1326 struct nfsd4_conn *c;
1327
1328 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
1329 list_for_each_entry(c, &s->se_conns, cn_persession) {
1330 if (c->cn_flags & NFS4_CDFC4_BACK)
1331 return c;
1332 }
1333 }
1334 return NULL;
1335}
1336
1337/*
1338 * Note there isn't a lot of locking in this code; instead we depend on
1339 * the fact that it is run from the callback_wq, which won't run two
1340 * work items at once. So, for example, callback_wq handles all access
1341 * of cl_cb_client and all calls to rpc_create or rpc_shutdown_client.
1342 */
1343static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
1344{
1345 struct nfs4_cb_conn conn;
1346 struct nfs4_client *clp = cb->cb_clp;
1347 struct nfsd4_session *ses = NULL;
1348 struct nfsd4_conn *c;
1349 int err;
1350
1351 /*
1352 * This is either an update, or the client dying; in either case,
1353 * kill the old client:
1354 */
1355 if (clp->cl_cb_client) {
1356 rpc_shutdown_client(clp->cl_cb_client);
1357 clp->cl_cb_client = NULL;
1358 put_cred(clp->cl_cb_cred);
1359 clp->cl_cb_cred = NULL;
1360 }
1361 if (clp->cl_cb_conn.cb_xprt) {
1362 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
1363 clp->cl_cb_conn.cb_xprt = NULL;
1364 }
1365 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
1366 return;
1367 spin_lock(&clp->cl_lock);
1368 /*
1369 * Only serialized callback code is allowed to clear these
1370 * flags; main nfsd code can only set them:
1371 */
1372 BUG_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
1373 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
1374 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
1375 c = __nfsd4_find_backchannel(clp);
1376 if (c) {
1377 svc_xprt_get(c->cn_xprt);
1378 conn.cb_xprt = c->cn_xprt;
1379 ses = c->cn_session;
1380 }
1381 spin_unlock(&clp->cl_lock);
1382
1383 err = setup_callback_client(clp, &conn, ses);
1384 if (err) {
1385 nfsd4_mark_cb_down(clp, err);
1386 if (c)
1387 svc_xprt_put(c->cn_xprt);
1388 return;
1389 }
1390}
1391
1392static void
1393nfsd4_run_cb_work(struct work_struct *work)
1394{
1395 struct nfsd4_callback *cb =
1396 container_of(work, struct nfsd4_callback, cb_work);
1397 struct nfs4_client *clp = cb->cb_clp;
1398 struct rpc_clnt *clnt;
1399 int flags;
1400
1401 if (cb->cb_need_restart) {
1402 cb->cb_need_restart = false;
1403 } else {
1404 if (cb->cb_ops && cb->cb_ops->prepare)
1405 cb->cb_ops->prepare(cb);
1406 }
1407
1408 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
1409 nfsd4_process_cb_update(cb);
1410
1411 clnt = clp->cl_cb_client;
1412 if (!clnt) {
1413 /* Callback channel broken, or client killed; give up: */
1414 nfsd41_destroy_cb(cb);
1415 return;
1416 }
1417
1418 /*
1419 * Don't send probe messages for 4.1 or later.
1420 */
1421 if (!cb->cb_ops && clp->cl_minorversion) {
1422 nfsd4_mark_cb_state(clp, NFSD4_CB_UP);
1423 nfsd41_destroy_cb(cb);
1424 return;
1425 }
1426
1427 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
1428 flags = clp->cl_minorversion ? RPC_TASK_NOCONNECT : RPC_TASK_SOFTCONN;
1429 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | flags,
1430 cb->cb_ops ? &nfsd4_cb_ops : &nfsd4_cb_probe_ops, cb);
1431}
1432
1433void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
1434 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op)
1435{
1436 cb->cb_clp = clp;
1437 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[op];
1438 cb->cb_msg.rpc_argp = cb;
1439 cb->cb_msg.rpc_resp = cb;
1440 cb->cb_ops = ops;
1441 INIT_WORK(&cb->cb_work, nfsd4_run_cb_work);
1442 cb->cb_seq_status = 1;
1443 cb->cb_status = 0;
1444 cb->cb_need_restart = false;
1445 cb->cb_holds_slot = false;
1446}
1447
1448/**
1449 * nfsd4_run_cb - queue up a callback job to run
1450 * @cb: callback to queue
1451 *
1452 * Kick off a callback to do its thing. Returns false if it was already
1453 * on a queue, true otherwise.
1454 */
1455bool nfsd4_run_cb(struct nfsd4_callback *cb)
1456{
1457 struct nfs4_client *clp = cb->cb_clp;
1458 bool queued;
1459
1460 nfsd41_cb_inflight_begin(clp);
1461 queued = nfsd4_queue_cb(cb);
1462 if (!queued)
1463 nfsd41_cb_inflight_end(clp);
1464 return queued;
1465}
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/nfs4.h>
35#include <linux/sunrpc/clnt.h>
36#include <linux/sunrpc/xprt.h>
37#include <linux/sunrpc/svc_xprt.h>
38#include <linux/slab.h>
39#include "nfsd.h"
40#include "state.h"
41#include "netns.h"
42#include "trace.h"
43#include "xdr4cb.h"
44#include "xdr4.h"
45
46#define NFSDDBG_FACILITY NFSDDBG_PROC
47
48static void nfsd4_mark_cb_fault(struct nfs4_client *clp);
49
50#define NFSPROC4_CB_NULL 0
51#define NFSPROC4_CB_COMPOUND 1
52
53/* Index of predefined Linux callback client operations */
54
55struct nfs4_cb_compound_hdr {
56 /* args */
57 u32 ident; /* minorversion 0 only */
58 u32 nops;
59 __be32 *nops_p;
60 u32 minorversion;
61 /* res */
62 int status;
63};
64
65static __be32 *xdr_encode_empty_array(__be32 *p)
66{
67 *p++ = xdr_zero;
68 return p;
69}
70
71/*
72 * Encode/decode NFSv4 CB basic data types
73 *
74 * Basic NFSv4 callback data types are defined in section 15 of RFC
75 * 3530: "Network File System (NFS) version 4 Protocol" and section
76 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
77 * 1 Protocol"
78 */
79
80static void encode_uint32(struct xdr_stream *xdr, u32 n)
81{
82 WARN_ON_ONCE(xdr_stream_encode_u32(xdr, n) < 0);
83}
84
85static void encode_bitmap4(struct xdr_stream *xdr, const __u32 *bitmap,
86 size_t len)
87{
88 xdr_stream_encode_uint32_array(xdr, bitmap, len);
89}
90
91static int decode_cb_fattr4(struct xdr_stream *xdr, uint32_t *bitmap,
92 struct nfs4_cb_fattr *fattr)
93{
94 fattr->ncf_cb_change = 0;
95 fattr->ncf_cb_fsize = 0;
96 if (bitmap[0] & FATTR4_WORD0_CHANGE)
97 if (xdr_stream_decode_u64(xdr, &fattr->ncf_cb_change) < 0)
98 return -NFSERR_BAD_XDR;
99 if (bitmap[0] & FATTR4_WORD0_SIZE)
100 if (xdr_stream_decode_u64(xdr, &fattr->ncf_cb_fsize) < 0)
101 return -NFSERR_BAD_XDR;
102 return 0;
103}
104
105static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
106{
107 __be32 *p;
108
109 p = xdr_reserve_space(xdr, 4);
110 *p = cpu_to_be32(op);
111}
112
113/*
114 * nfs_fh4
115 *
116 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
117 */
118static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
119{
120 u32 length = fh->fh_size;
121 __be32 *p;
122
123 BUG_ON(length > NFS4_FHSIZE);
124 p = xdr_reserve_space(xdr, 4 + length);
125 xdr_encode_opaque(p, &fh->fh_raw, length);
126}
127
128/*
129 * stateid4
130 *
131 * struct stateid4 {
132 * uint32_t seqid;
133 * opaque other[12];
134 * };
135 */
136static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
137{
138 __be32 *p;
139
140 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
141 *p++ = cpu_to_be32(sid->si_generation);
142 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
143}
144
145/*
146 * sessionid4
147 *
148 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
149 */
150static void encode_sessionid4(struct xdr_stream *xdr,
151 const struct nfsd4_session *session)
152{
153 __be32 *p;
154
155 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
156 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
157 NFS4_MAX_SESSIONID_LEN);
158}
159
160/*
161 * nfsstat4
162 */
163static const struct {
164 int stat;
165 int errno;
166} nfs_cb_errtbl[] = {
167 { NFS4_OK, 0 },
168 { NFS4ERR_PERM, -EPERM },
169 { NFS4ERR_NOENT, -ENOENT },
170 { NFS4ERR_IO, -EIO },
171 { NFS4ERR_NXIO, -ENXIO },
172 { NFS4ERR_ACCESS, -EACCES },
173 { NFS4ERR_EXIST, -EEXIST },
174 { NFS4ERR_XDEV, -EXDEV },
175 { NFS4ERR_NOTDIR, -ENOTDIR },
176 { NFS4ERR_ISDIR, -EISDIR },
177 { NFS4ERR_INVAL, -EINVAL },
178 { NFS4ERR_FBIG, -EFBIG },
179 { NFS4ERR_NOSPC, -ENOSPC },
180 { NFS4ERR_ROFS, -EROFS },
181 { NFS4ERR_MLINK, -EMLINK },
182 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
183 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
184 { NFS4ERR_DQUOT, -EDQUOT },
185 { NFS4ERR_STALE, -ESTALE },
186 { NFS4ERR_BADHANDLE, -EBADHANDLE },
187 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
188 { NFS4ERR_NOTSUPP, -ENOTSUPP },
189 { NFS4ERR_TOOSMALL, -ETOOSMALL },
190 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
191 { NFS4ERR_BADTYPE, -EBADTYPE },
192 { NFS4ERR_LOCKED, -EAGAIN },
193 { NFS4ERR_RESOURCE, -EREMOTEIO },
194 { NFS4ERR_SYMLINK, -ELOOP },
195 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
196 { NFS4ERR_DEADLOCK, -EDEADLK },
197 { -1, -EIO }
198};
199
200/*
201 * If we cannot translate the error, the recovery routines should
202 * handle it.
203 *
204 * Note: remaining NFSv4 error codes have values > 10000, so should
205 * not conflict with native Linux error codes.
206 */
207static int nfs_cb_stat_to_errno(int status)
208{
209 int i;
210
211 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
212 if (nfs_cb_errtbl[i].stat == status)
213 return nfs_cb_errtbl[i].errno;
214 }
215
216 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
217 return -status;
218}
219
220static int decode_cb_op_status(struct xdr_stream *xdr,
221 enum nfs_cb_opnum4 expected, int *status)
222{
223 __be32 *p;
224 u32 op;
225
226 p = xdr_inline_decode(xdr, 4 + 4);
227 if (unlikely(p == NULL))
228 goto out_overflow;
229 op = be32_to_cpup(p++);
230 if (unlikely(op != expected))
231 goto out_unexpected;
232 *status = nfs_cb_stat_to_errno(be32_to_cpup(p));
233 return 0;
234out_overflow:
235 return -EIO;
236out_unexpected:
237 dprintk("NFSD: Callback server returned operation %d but "
238 "we issued a request for %d\n", op, expected);
239 return -EIO;
240}
241
242/*
243 * CB_COMPOUND4args
244 *
245 * struct CB_COMPOUND4args {
246 * utf8str_cs tag;
247 * uint32_t minorversion;
248 * uint32_t callback_ident;
249 * nfs_cb_argop4 argarray<>;
250 * };
251*/
252static void encode_cb_compound4args(struct xdr_stream *xdr,
253 struct nfs4_cb_compound_hdr *hdr)
254{
255 __be32 * p;
256
257 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
258 p = xdr_encode_empty_array(p); /* empty tag */
259 *p++ = cpu_to_be32(hdr->minorversion);
260 *p++ = cpu_to_be32(hdr->ident);
261
262 hdr->nops_p = p;
263 *p = cpu_to_be32(hdr->nops); /* argarray element count */
264}
265
266/*
267 * Update argarray element count
268 */
269static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
270{
271 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
272 *hdr->nops_p = cpu_to_be32(hdr->nops);
273}
274
275/*
276 * CB_COMPOUND4res
277 *
278 * struct CB_COMPOUND4res {
279 * nfsstat4 status;
280 * utf8str_cs tag;
281 * nfs_cb_resop4 resarray<>;
282 * };
283 */
284static int decode_cb_compound4res(struct xdr_stream *xdr,
285 struct nfs4_cb_compound_hdr *hdr)
286{
287 u32 length;
288 __be32 *p;
289
290 p = xdr_inline_decode(xdr, XDR_UNIT);
291 if (unlikely(p == NULL))
292 goto out_overflow;
293 hdr->status = be32_to_cpup(p);
294 /* Ignore the tag */
295 if (xdr_stream_decode_u32(xdr, &length) < 0)
296 goto out_overflow;
297 if (xdr_inline_decode(xdr, length) == NULL)
298 goto out_overflow;
299 if (xdr_stream_decode_u32(xdr, &hdr->nops) < 0)
300 goto out_overflow;
301 return 0;
302out_overflow:
303 return -EIO;
304}
305
306/*
307 * CB_RECALL4args
308 *
309 * struct CB_RECALL4args {
310 * stateid4 stateid;
311 * bool truncate;
312 * nfs_fh4 fh;
313 * };
314 */
315static void encode_cb_recall4args(struct xdr_stream *xdr,
316 const struct nfs4_delegation *dp,
317 struct nfs4_cb_compound_hdr *hdr)
318{
319 __be32 *p;
320
321 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
322 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
323
324 p = xdr_reserve_space(xdr, 4);
325 *p++ = xdr_zero; /* truncate */
326
327 encode_nfs_fh4(xdr, &dp->dl_stid.sc_file->fi_fhandle);
328
329 hdr->nops++;
330}
331
332/*
333 * CB_RECALLANY4args
334 *
335 * struct CB_RECALLANY4args {
336 * uint32_t craa_objects_to_keep;
337 * bitmap4 craa_type_mask;
338 * };
339 */
340static void
341encode_cb_recallany4args(struct xdr_stream *xdr,
342 struct nfs4_cb_compound_hdr *hdr, struct nfsd4_cb_recall_any *ra)
343{
344 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL_ANY);
345 encode_uint32(xdr, ra->ra_keep);
346 encode_bitmap4(xdr, ra->ra_bmval, ARRAY_SIZE(ra->ra_bmval));
347 hdr->nops++;
348}
349
350/*
351 * CB_GETATTR4args
352 * struct CB_GETATTR4args {
353 * nfs_fh4 fh;
354 * bitmap4 attr_request;
355 * };
356 *
357 * The size and change attributes are the only one
358 * guaranteed to be serviced by the client.
359 */
360static void
361encode_cb_getattr4args(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr,
362 struct nfs4_cb_fattr *fattr)
363{
364 struct nfs4_delegation *dp =
365 container_of(fattr, struct nfs4_delegation, dl_cb_fattr);
366 struct knfsd_fh *fh = &dp->dl_stid.sc_file->fi_fhandle;
367 u32 bmap[1];
368
369 bmap[0] = FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE;
370
371 encode_nfs_cb_opnum4(xdr, OP_CB_GETATTR);
372 encode_nfs_fh4(xdr, fh);
373 encode_bitmap4(xdr, bmap, ARRAY_SIZE(bmap));
374 hdr->nops++;
375}
376
377static u32 highest_slotid(struct nfsd4_session *ses)
378{
379 u32 idx;
380
381 spin_lock(&ses->se_lock);
382 idx = fls(~ses->se_cb_slot_avail);
383 if (idx > 0)
384 --idx;
385 idx = max(idx, ses->se_cb_highest_slot);
386 spin_unlock(&ses->se_lock);
387 return idx;
388}
389
390/*
391 * CB_SEQUENCE4args
392 *
393 * struct CB_SEQUENCE4args {
394 * sessionid4 csa_sessionid;
395 * sequenceid4 csa_sequenceid;
396 * slotid4 csa_slotid;
397 * slotid4 csa_highest_slotid;
398 * bool csa_cachethis;
399 * referring_call_list4 csa_referring_call_lists<>;
400 * };
401 */
402static void encode_cb_sequence4args(struct xdr_stream *xdr,
403 const struct nfsd4_callback *cb,
404 struct nfs4_cb_compound_hdr *hdr)
405{
406 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
407 __be32 *p;
408
409 if (hdr->minorversion == 0)
410 return;
411
412 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
413 encode_sessionid4(xdr, session);
414
415 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
416 *p++ = cpu_to_be32(session->se_cb_seq_nr[cb->cb_held_slot]); /* csa_sequenceid */
417 *p++ = cpu_to_be32(cb->cb_held_slot); /* csa_slotid */
418 *p++ = cpu_to_be32(highest_slotid(session)); /* csa_highest_slotid */
419 *p++ = xdr_zero; /* csa_cachethis */
420 xdr_encode_empty_array(p); /* csa_referring_call_lists */
421
422 hdr->nops++;
423}
424
425static void update_cb_slot_table(struct nfsd4_session *ses, u32 target)
426{
427 /* No need to do anything if nothing changed */
428 if (likely(target == READ_ONCE(ses->se_cb_highest_slot)))
429 return;
430
431 spin_lock(&ses->se_lock);
432 if (target > ses->se_cb_highest_slot) {
433 int i;
434
435 target = min(target, NFSD_BC_SLOT_TABLE_SIZE - 1);
436
437 /*
438 * Growing the slot table. Reset any new sequences to 1.
439 *
440 * NB: There is some debate about whether the RFC requires this,
441 * but the Linux client expects it.
442 */
443 for (i = ses->se_cb_highest_slot + 1; i <= target; ++i)
444 ses->se_cb_seq_nr[i] = 1;
445 }
446 ses->se_cb_highest_slot = target;
447 spin_unlock(&ses->se_lock);
448}
449
450/*
451 * CB_SEQUENCE4resok
452 *
453 * struct CB_SEQUENCE4resok {
454 * sessionid4 csr_sessionid;
455 * sequenceid4 csr_sequenceid;
456 * slotid4 csr_slotid;
457 * slotid4 csr_highest_slotid;
458 * slotid4 csr_target_highest_slotid;
459 * };
460 *
461 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
462 * case NFS4_OK:
463 * CB_SEQUENCE4resok csr_resok4;
464 * default:
465 * void;
466 * };
467 *
468 * Our current back channel implmentation supports a single backchannel
469 * with a single slot.
470 */
471static int decode_cb_sequence4resok(struct xdr_stream *xdr,
472 struct nfsd4_callback *cb)
473{
474 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
475 int status = -ESERVERFAULT;
476 __be32 *p;
477 u32 seqid, slotid, target;
478
479 /*
480 * If the server returns different values for sessionID, slotID or
481 * sequence number, the server is looney tunes.
482 */
483 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
484 if (unlikely(p == NULL))
485 goto out_overflow;
486
487 if (memcmp(p, session->se_sessionid.data, NFS4_MAX_SESSIONID_LEN)) {
488 dprintk("NFS: %s Invalid session id\n", __func__);
489 goto out;
490 }
491 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
492
493 seqid = be32_to_cpup(p++);
494 if (seqid != session->se_cb_seq_nr[cb->cb_held_slot]) {
495 dprintk("NFS: %s Invalid sequence number\n", __func__);
496 goto out;
497 }
498
499 slotid = be32_to_cpup(p++);
500 if (slotid != cb->cb_held_slot) {
501 dprintk("NFS: %s Invalid slotid\n", __func__);
502 goto out;
503 }
504
505 p++; // ignore current highest slot value
506
507 target = be32_to_cpup(p++);
508 update_cb_slot_table(session, target);
509 status = 0;
510out:
511 cb->cb_seq_status = status;
512 return status;
513out_overflow:
514 status = -EIO;
515 goto out;
516}
517
518static int decode_cb_sequence4res(struct xdr_stream *xdr,
519 struct nfsd4_callback *cb)
520{
521 int status;
522
523 if (cb->cb_clp->cl_minorversion == 0)
524 return 0;
525
526 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &cb->cb_seq_status);
527 if (unlikely(status || cb->cb_seq_status))
528 return status;
529
530 return decode_cb_sequence4resok(xdr, cb);
531}
532
533/*
534 * NFSv4.0 and NFSv4.1 XDR encode functions
535 *
536 * NFSv4.0 callback argument types are defined in section 15 of RFC
537 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
538 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
539 * Protocol".
540 */
541
542/*
543 * NB: Without this zero space reservation, callbacks over krb5p fail
544 */
545static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
546 const void *__unused)
547{
548 xdr_reserve_space(xdr, 0);
549}
550
551/*
552 * 20.1. Operation 3: CB_GETATTR - Get Attributes
553 */
554static void nfs4_xdr_enc_cb_getattr(struct rpc_rqst *req,
555 struct xdr_stream *xdr, const void *data)
556{
557 const struct nfsd4_callback *cb = data;
558 struct nfs4_cb_fattr *ncf =
559 container_of(cb, struct nfs4_cb_fattr, ncf_getattr);
560 struct nfs4_cb_compound_hdr hdr = {
561 .ident = cb->cb_clp->cl_cb_ident,
562 .minorversion = cb->cb_clp->cl_minorversion,
563 };
564
565 encode_cb_compound4args(xdr, &hdr);
566 encode_cb_sequence4args(xdr, cb, &hdr);
567 encode_cb_getattr4args(xdr, &hdr, ncf);
568 encode_cb_nops(&hdr);
569}
570
571/*
572 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
573 */
574static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
575 const void *data)
576{
577 const struct nfsd4_callback *cb = data;
578 const struct nfs4_delegation *dp = cb_to_delegation(cb);
579 struct nfs4_cb_compound_hdr hdr = {
580 .ident = cb->cb_clp->cl_cb_ident,
581 .minorversion = cb->cb_clp->cl_minorversion,
582 };
583
584 encode_cb_compound4args(xdr, &hdr);
585 encode_cb_sequence4args(xdr, cb, &hdr);
586 encode_cb_recall4args(xdr, dp, &hdr);
587 encode_cb_nops(&hdr);
588}
589
590/*
591 * 20.6. Operation 8: CB_RECALL_ANY - Keep Any N Recallable Objects
592 */
593static void
594nfs4_xdr_enc_cb_recall_any(struct rpc_rqst *req,
595 struct xdr_stream *xdr, const void *data)
596{
597 const struct nfsd4_callback *cb = data;
598 struct nfsd4_cb_recall_any *ra;
599 struct nfs4_cb_compound_hdr hdr = {
600 .ident = cb->cb_clp->cl_cb_ident,
601 .minorversion = cb->cb_clp->cl_minorversion,
602 };
603
604 ra = container_of(cb, struct nfsd4_cb_recall_any, ra_cb);
605 encode_cb_compound4args(xdr, &hdr);
606 encode_cb_sequence4args(xdr, cb, &hdr);
607 encode_cb_recallany4args(xdr, &hdr, ra);
608 encode_cb_nops(&hdr);
609}
610
611/*
612 * NFSv4.0 and NFSv4.1 XDR decode functions
613 *
614 * NFSv4.0 callback result types are defined in section 15 of RFC
615 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
616 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
617 * Protocol".
618 */
619
620static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
621 void *__unused)
622{
623 return 0;
624}
625
626/*
627 * 20.1. Operation 3: CB_GETATTR - Get Attributes
628 */
629static int nfs4_xdr_dec_cb_getattr(struct rpc_rqst *rqstp,
630 struct xdr_stream *xdr,
631 void *data)
632{
633 struct nfsd4_callback *cb = data;
634 struct nfs4_cb_compound_hdr hdr;
635 int status;
636 u32 bitmap[3] = {0};
637 u32 attrlen;
638 struct nfs4_cb_fattr *ncf =
639 container_of(cb, struct nfs4_cb_fattr, ncf_getattr);
640
641 status = decode_cb_compound4res(xdr, &hdr);
642 if (unlikely(status))
643 return status;
644
645 status = decode_cb_sequence4res(xdr, cb);
646 if (unlikely(status || cb->cb_seq_status))
647 return status;
648
649 status = decode_cb_op_status(xdr, OP_CB_GETATTR, &cb->cb_status);
650 if (status)
651 return status;
652 if (xdr_stream_decode_uint32_array(xdr, bitmap, 3) < 0)
653 return -NFSERR_BAD_XDR;
654 if (xdr_stream_decode_u32(xdr, &attrlen) < 0)
655 return -NFSERR_BAD_XDR;
656 if (attrlen > (sizeof(ncf->ncf_cb_change) + sizeof(ncf->ncf_cb_fsize)))
657 return -NFSERR_BAD_XDR;
658 status = decode_cb_fattr4(xdr, bitmap, ncf);
659 return status;
660}
661
662/*
663 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
664 */
665static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
666 struct xdr_stream *xdr,
667 void *data)
668{
669 struct nfsd4_callback *cb = data;
670 struct nfs4_cb_compound_hdr hdr;
671 int status;
672
673 status = decode_cb_compound4res(xdr, &hdr);
674 if (unlikely(status))
675 return status;
676
677 status = decode_cb_sequence4res(xdr, cb);
678 if (unlikely(status || cb->cb_seq_status))
679 return status;
680
681 return decode_cb_op_status(xdr, OP_CB_RECALL, &cb->cb_status);
682}
683
684/*
685 * 20.6. Operation 8: CB_RECALL_ANY - Keep Any N Recallable Objects
686 */
687static int
688nfs4_xdr_dec_cb_recall_any(struct rpc_rqst *rqstp,
689 struct xdr_stream *xdr,
690 void *data)
691{
692 struct nfsd4_callback *cb = data;
693 struct nfs4_cb_compound_hdr hdr;
694 int status;
695
696 status = decode_cb_compound4res(xdr, &hdr);
697 if (unlikely(status))
698 return status;
699 status = decode_cb_sequence4res(xdr, cb);
700 if (unlikely(status || cb->cb_seq_status))
701 return status;
702 status = decode_cb_op_status(xdr, OP_CB_RECALL_ANY, &cb->cb_status);
703 return status;
704}
705
706#ifdef CONFIG_NFSD_PNFS
707/*
708 * CB_LAYOUTRECALL4args
709 *
710 * struct layoutrecall_file4 {
711 * nfs_fh4 lor_fh;
712 * offset4 lor_offset;
713 * length4 lor_length;
714 * stateid4 lor_stateid;
715 * };
716 *
717 * union layoutrecall4 switch(layoutrecall_type4 lor_recalltype) {
718 * case LAYOUTRECALL4_FILE:
719 * layoutrecall_file4 lor_layout;
720 * case LAYOUTRECALL4_FSID:
721 * fsid4 lor_fsid;
722 * case LAYOUTRECALL4_ALL:
723 * void;
724 * };
725 *
726 * struct CB_LAYOUTRECALL4args {
727 * layouttype4 clora_type;
728 * layoutiomode4 clora_iomode;
729 * bool clora_changed;
730 * layoutrecall4 clora_recall;
731 * };
732 */
733static void encode_cb_layout4args(struct xdr_stream *xdr,
734 const struct nfs4_layout_stateid *ls,
735 struct nfs4_cb_compound_hdr *hdr)
736{
737 __be32 *p;
738
739 BUG_ON(hdr->minorversion == 0);
740
741 p = xdr_reserve_space(xdr, 5 * 4);
742 *p++ = cpu_to_be32(OP_CB_LAYOUTRECALL);
743 *p++ = cpu_to_be32(ls->ls_layout_type);
744 *p++ = cpu_to_be32(IOMODE_ANY);
745 *p++ = cpu_to_be32(1);
746 *p = cpu_to_be32(RETURN_FILE);
747
748 encode_nfs_fh4(xdr, &ls->ls_stid.sc_file->fi_fhandle);
749
750 p = xdr_reserve_space(xdr, 2 * 8);
751 p = xdr_encode_hyper(p, 0);
752 xdr_encode_hyper(p, NFS4_MAX_UINT64);
753
754 encode_stateid4(xdr, &ls->ls_recall_sid);
755
756 hdr->nops++;
757}
758
759static void nfs4_xdr_enc_cb_layout(struct rpc_rqst *req,
760 struct xdr_stream *xdr,
761 const void *data)
762{
763 const struct nfsd4_callback *cb = data;
764 const struct nfs4_layout_stateid *ls =
765 container_of(cb, struct nfs4_layout_stateid, ls_recall);
766 struct nfs4_cb_compound_hdr hdr = {
767 .ident = 0,
768 .minorversion = cb->cb_clp->cl_minorversion,
769 };
770
771 encode_cb_compound4args(xdr, &hdr);
772 encode_cb_sequence4args(xdr, cb, &hdr);
773 encode_cb_layout4args(xdr, ls, &hdr);
774 encode_cb_nops(&hdr);
775}
776
777static int nfs4_xdr_dec_cb_layout(struct rpc_rqst *rqstp,
778 struct xdr_stream *xdr,
779 void *data)
780{
781 struct nfsd4_callback *cb = data;
782 struct nfs4_cb_compound_hdr hdr;
783 int status;
784
785 status = decode_cb_compound4res(xdr, &hdr);
786 if (unlikely(status))
787 return status;
788
789 status = decode_cb_sequence4res(xdr, cb);
790 if (unlikely(status || cb->cb_seq_status))
791 return status;
792
793 return decode_cb_op_status(xdr, OP_CB_LAYOUTRECALL, &cb->cb_status);
794}
795#endif /* CONFIG_NFSD_PNFS */
796
797static void encode_stateowner(struct xdr_stream *xdr, struct nfs4_stateowner *so)
798{
799 __be32 *p;
800
801 p = xdr_reserve_space(xdr, 8 + 4 + so->so_owner.len);
802 p = xdr_encode_opaque_fixed(p, &so->so_client->cl_clientid, 8);
803 xdr_encode_opaque(p, so->so_owner.data, so->so_owner.len);
804}
805
806static void nfs4_xdr_enc_cb_notify_lock(struct rpc_rqst *req,
807 struct xdr_stream *xdr,
808 const void *data)
809{
810 const struct nfsd4_callback *cb = data;
811 const struct nfsd4_blocked_lock *nbl =
812 container_of(cb, struct nfsd4_blocked_lock, nbl_cb);
813 struct nfs4_lockowner *lo = (struct nfs4_lockowner *)nbl->nbl_lock.c.flc_owner;
814 struct nfs4_cb_compound_hdr hdr = {
815 .ident = 0,
816 .minorversion = cb->cb_clp->cl_minorversion,
817 };
818
819 __be32 *p;
820
821 BUG_ON(hdr.minorversion == 0);
822
823 encode_cb_compound4args(xdr, &hdr);
824 encode_cb_sequence4args(xdr, cb, &hdr);
825
826 p = xdr_reserve_space(xdr, 4);
827 *p = cpu_to_be32(OP_CB_NOTIFY_LOCK);
828 encode_nfs_fh4(xdr, &nbl->nbl_fh);
829 encode_stateowner(xdr, &lo->lo_owner);
830 hdr.nops++;
831
832 encode_cb_nops(&hdr);
833}
834
835static int nfs4_xdr_dec_cb_notify_lock(struct rpc_rqst *rqstp,
836 struct xdr_stream *xdr,
837 void *data)
838{
839 struct nfsd4_callback *cb = data;
840 struct nfs4_cb_compound_hdr hdr;
841 int status;
842
843 status = decode_cb_compound4res(xdr, &hdr);
844 if (unlikely(status))
845 return status;
846
847 status = decode_cb_sequence4res(xdr, cb);
848 if (unlikely(status || cb->cb_seq_status))
849 return status;
850
851 return decode_cb_op_status(xdr, OP_CB_NOTIFY_LOCK, &cb->cb_status);
852}
853
854/*
855 * struct write_response4 {
856 * stateid4 wr_callback_id<1>;
857 * length4 wr_count;
858 * stable_how4 wr_committed;
859 * verifier4 wr_writeverf;
860 * };
861 * union offload_info4 switch (nfsstat4 coa_status) {
862 * case NFS4_OK:
863 * write_response4 coa_resok4;
864 * default:
865 * length4 coa_bytes_copied;
866 * };
867 * struct CB_OFFLOAD4args {
868 * nfs_fh4 coa_fh;
869 * stateid4 coa_stateid;
870 * offload_info4 coa_offload_info;
871 * };
872 */
873static void encode_offload_info4(struct xdr_stream *xdr,
874 const struct nfsd4_cb_offload *cbo)
875{
876 __be32 *p;
877
878 p = xdr_reserve_space(xdr, 4);
879 *p = cbo->co_nfserr;
880 switch (cbo->co_nfserr) {
881 case nfs_ok:
882 p = xdr_reserve_space(xdr, 4 + 8 + 4 + NFS4_VERIFIER_SIZE);
883 p = xdr_encode_empty_array(p);
884 p = xdr_encode_hyper(p, cbo->co_res.wr_bytes_written);
885 *p++ = cpu_to_be32(cbo->co_res.wr_stable_how);
886 p = xdr_encode_opaque_fixed(p, cbo->co_res.wr_verifier.data,
887 NFS4_VERIFIER_SIZE);
888 break;
889 default:
890 p = xdr_reserve_space(xdr, 8);
891 /* We always return success if bytes were written */
892 p = xdr_encode_hyper(p, 0);
893 }
894}
895
896static void encode_cb_offload4args(struct xdr_stream *xdr,
897 const struct nfsd4_cb_offload *cbo,
898 struct nfs4_cb_compound_hdr *hdr)
899{
900 __be32 *p;
901
902 p = xdr_reserve_space(xdr, 4);
903 *p = cpu_to_be32(OP_CB_OFFLOAD);
904 encode_nfs_fh4(xdr, &cbo->co_fh);
905 encode_stateid4(xdr, &cbo->co_res.cb_stateid);
906 encode_offload_info4(xdr, cbo);
907
908 hdr->nops++;
909}
910
911static void nfs4_xdr_enc_cb_offload(struct rpc_rqst *req,
912 struct xdr_stream *xdr,
913 const void *data)
914{
915 const struct nfsd4_callback *cb = data;
916 const struct nfsd4_cb_offload *cbo =
917 container_of(cb, struct nfsd4_cb_offload, co_cb);
918 struct nfs4_cb_compound_hdr hdr = {
919 .ident = 0,
920 .minorversion = cb->cb_clp->cl_minorversion,
921 };
922
923 encode_cb_compound4args(xdr, &hdr);
924 encode_cb_sequence4args(xdr, cb, &hdr);
925 encode_cb_offload4args(xdr, cbo, &hdr);
926 encode_cb_nops(&hdr);
927}
928
929static int nfs4_xdr_dec_cb_offload(struct rpc_rqst *rqstp,
930 struct xdr_stream *xdr,
931 void *data)
932{
933 struct nfsd4_callback *cb = data;
934 struct nfs4_cb_compound_hdr hdr;
935 int status;
936
937 status = decode_cb_compound4res(xdr, &hdr);
938 if (unlikely(status))
939 return status;
940
941 status = decode_cb_sequence4res(xdr, cb);
942 if (unlikely(status || cb->cb_seq_status))
943 return status;
944
945 return decode_cb_op_status(xdr, OP_CB_OFFLOAD, &cb->cb_status);
946}
947/*
948 * RPC procedure tables
949 */
950#define PROC(proc, call, argtype, restype) \
951[NFSPROC4_CLNT_##proc] = { \
952 .p_proc = NFSPROC4_CB_##call, \
953 .p_encode = nfs4_xdr_enc_##argtype, \
954 .p_decode = nfs4_xdr_dec_##restype, \
955 .p_arglen = NFS4_enc_##argtype##_sz, \
956 .p_replen = NFS4_dec_##restype##_sz, \
957 .p_statidx = NFSPROC4_CB_##call, \
958 .p_name = #proc, \
959}
960
961static const struct rpc_procinfo nfs4_cb_procedures[] = {
962 PROC(CB_NULL, NULL, cb_null, cb_null),
963 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
964#ifdef CONFIG_NFSD_PNFS
965 PROC(CB_LAYOUT, COMPOUND, cb_layout, cb_layout),
966#endif
967 PROC(CB_NOTIFY_LOCK, COMPOUND, cb_notify_lock, cb_notify_lock),
968 PROC(CB_OFFLOAD, COMPOUND, cb_offload, cb_offload),
969 PROC(CB_RECALL_ANY, COMPOUND, cb_recall_any, cb_recall_any),
970 PROC(CB_GETATTR, COMPOUND, cb_getattr, cb_getattr),
971};
972
973static unsigned int nfs4_cb_counts[ARRAY_SIZE(nfs4_cb_procedures)];
974static const struct rpc_version nfs_cb_version4 = {
975/*
976 * Note on the callback rpc program version number: despite language in rfc
977 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
978 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
979 * in practice that appears to be what implementations use. The section
980 * 18.36.3 language is expected to be fixed in an erratum.
981 */
982 .number = 1,
983 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
984 .procs = nfs4_cb_procedures,
985 .counts = nfs4_cb_counts,
986};
987
988static const struct rpc_version *nfs_cb_version[2] = {
989 [1] = &nfs_cb_version4,
990};
991
992static const struct rpc_program cb_program;
993
994static struct rpc_stat cb_stats = {
995 .program = &cb_program
996};
997
998#define NFS4_CALLBACK 0x40000000
999static const struct rpc_program cb_program = {
1000 .name = "nfs4_cb",
1001 .number = NFS4_CALLBACK,
1002 .nrvers = ARRAY_SIZE(nfs_cb_version),
1003 .version = nfs_cb_version,
1004 .stats = &cb_stats,
1005 .pipe_dir_name = "nfsd4_cb",
1006};
1007
1008static int max_cb_time(struct net *net)
1009{
1010 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1011
1012 /*
1013 * nfsd4_lease is set to at most one hour in __nfsd4_write_time,
1014 * so we can use 32-bit math on it. Warn if that assumption
1015 * ever stops being true.
1016 */
1017 if (WARN_ON_ONCE(nn->nfsd4_lease > 3600))
1018 return 360 * HZ;
1019
1020 return max(((u32)nn->nfsd4_lease)/10, 1u) * HZ;
1021}
1022
1023static bool nfsd4_queue_cb(struct nfsd4_callback *cb)
1024{
1025 struct nfs4_client *clp = cb->cb_clp;
1026
1027 trace_nfsd_cb_queue(clp, cb);
1028 return queue_work(clp->cl_callback_wq, &cb->cb_work);
1029}
1030
1031static void nfsd41_cb_inflight_begin(struct nfs4_client *clp)
1032{
1033 atomic_inc(&clp->cl_cb_inflight);
1034}
1035
1036static void nfsd41_cb_inflight_end(struct nfs4_client *clp)
1037{
1038
1039 if (atomic_dec_and_test(&clp->cl_cb_inflight))
1040 wake_up_var(&clp->cl_cb_inflight);
1041}
1042
1043static void nfsd41_cb_inflight_wait_complete(struct nfs4_client *clp)
1044{
1045 wait_var_event(&clp->cl_cb_inflight,
1046 !atomic_read(&clp->cl_cb_inflight));
1047}
1048
1049static const struct cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
1050{
1051 if (clp->cl_minorversion == 0) {
1052 client->cl_principal = clp->cl_cred.cr_targ_princ ?
1053 clp->cl_cred.cr_targ_princ : "nfs";
1054
1055 return get_cred(rpc_machine_cred());
1056 } else {
1057 struct cred *kcred;
1058
1059 kcred = prepare_kernel_cred(&init_task);
1060 if (!kcred)
1061 return NULL;
1062
1063 kcred->fsuid = ses->se_cb_sec.uid;
1064 kcred->fsgid = ses->se_cb_sec.gid;
1065 return kcred;
1066 }
1067}
1068
1069static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
1070{
1071 int maxtime = max_cb_time(clp->net);
1072 struct rpc_timeout timeparms = {
1073 .to_initval = maxtime,
1074 .to_retries = 0,
1075 .to_maxval = maxtime,
1076 };
1077 struct rpc_create_args args = {
1078 .net = clp->net,
1079 .address = (struct sockaddr *) &conn->cb_addr,
1080 .addrsize = conn->cb_addrlen,
1081 .saddress = (struct sockaddr *) &conn->cb_saddr,
1082 .timeout = &timeparms,
1083 .program = &cb_program,
1084 .version = 1,
1085 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
1086 .cred = current_cred(),
1087 };
1088 struct rpc_clnt *client;
1089 const struct cred *cred;
1090
1091 if (clp->cl_minorversion == 0) {
1092 if (!clp->cl_cred.cr_principal &&
1093 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5)) {
1094 trace_nfsd_cb_setup_err(clp, -EINVAL);
1095 return -EINVAL;
1096 }
1097 args.client_name = clp->cl_cred.cr_principal;
1098 args.prognumber = conn->cb_prog;
1099 args.protocol = XPRT_TRANSPORT_TCP;
1100 args.authflavor = clp->cl_cred.cr_flavor;
1101 clp->cl_cb_ident = conn->cb_ident;
1102 } else {
1103 if (!conn->cb_xprt || !ses)
1104 return -EINVAL;
1105 clp->cl_cb_session = ses;
1106 args.bc_xprt = conn->cb_xprt;
1107 args.prognumber = clp->cl_cb_session->se_cb_prog;
1108 args.protocol = conn->cb_xprt->xpt_class->xcl_ident |
1109 XPRT_TRANSPORT_BC;
1110 args.authflavor = ses->se_cb_sec.flavor;
1111 }
1112 /* Create RPC client */
1113 client = rpc_create(&args);
1114 if (IS_ERR(client)) {
1115 trace_nfsd_cb_setup_err(clp, PTR_ERR(client));
1116 return PTR_ERR(client);
1117 }
1118 cred = get_backchannel_cred(clp, client, ses);
1119 if (!cred) {
1120 trace_nfsd_cb_setup_err(clp, -ENOMEM);
1121 rpc_shutdown_client(client);
1122 return -ENOMEM;
1123 }
1124
1125 if (clp->cl_minorversion != 0)
1126 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
1127 clp->cl_cb_client = client;
1128 clp->cl_cb_cred = cred;
1129 rcu_read_lock();
1130 trace_nfsd_cb_setup(clp, rpc_peeraddr2str(client, RPC_DISPLAY_NETID),
1131 args.authflavor);
1132 rcu_read_unlock();
1133 return 0;
1134}
1135
1136static void nfsd4_mark_cb_state(struct nfs4_client *clp, int newstate)
1137{
1138 if (clp->cl_cb_state != newstate) {
1139 clp->cl_cb_state = newstate;
1140 trace_nfsd_cb_new_state(clp);
1141 }
1142}
1143
1144static void nfsd4_mark_cb_down(struct nfs4_client *clp)
1145{
1146 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
1147 return;
1148 nfsd4_mark_cb_state(clp, NFSD4_CB_DOWN);
1149}
1150
1151static void nfsd4_mark_cb_fault(struct nfs4_client *clp)
1152{
1153 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
1154 return;
1155 nfsd4_mark_cb_state(clp, NFSD4_CB_FAULT);
1156}
1157
1158static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
1159{
1160 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
1161
1162 if (task->tk_status)
1163 nfsd4_mark_cb_down(clp);
1164 else
1165 nfsd4_mark_cb_state(clp, NFSD4_CB_UP);
1166}
1167
1168static void nfsd4_cb_probe_release(void *calldata)
1169{
1170 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
1171
1172 nfsd41_cb_inflight_end(clp);
1173
1174}
1175
1176static const struct rpc_call_ops nfsd4_cb_probe_ops = {
1177 /* XXX: release method to ensure we set the cb channel down if
1178 * necessary on early failure? */
1179 .rpc_call_done = nfsd4_cb_probe_done,
1180 .rpc_release = nfsd4_cb_probe_release,
1181};
1182
1183/*
1184 * Poke the callback thread to process any updates to the callback
1185 * parameters, and send a null probe.
1186 */
1187void nfsd4_probe_callback(struct nfs4_client *clp)
1188{
1189 trace_nfsd_cb_probe(clp);
1190 nfsd4_mark_cb_state(clp, NFSD4_CB_UNKNOWN);
1191 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
1192 nfsd4_run_cb(&clp->cl_cb_null);
1193}
1194
1195void nfsd4_probe_callback_sync(struct nfs4_client *clp)
1196{
1197 nfsd4_probe_callback(clp);
1198 flush_workqueue(clp->cl_callback_wq);
1199}
1200
1201void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
1202{
1203 nfsd4_mark_cb_state(clp, NFSD4_CB_UNKNOWN);
1204 spin_lock(&clp->cl_lock);
1205 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
1206 spin_unlock(&clp->cl_lock);
1207}
1208
1209static int grab_slot(struct nfsd4_session *ses)
1210{
1211 int idx;
1212
1213 spin_lock(&ses->se_lock);
1214 idx = ffs(ses->se_cb_slot_avail) - 1;
1215 if (idx < 0 || idx > ses->se_cb_highest_slot) {
1216 spin_unlock(&ses->se_lock);
1217 return -1;
1218 }
1219 /* clear the bit for the slot */
1220 ses->se_cb_slot_avail &= ~BIT(idx);
1221 spin_unlock(&ses->se_lock);
1222 return idx;
1223}
1224
1225/*
1226 * There's currently a single callback channel slot.
1227 * If the slot is available, then mark it busy. Otherwise, set the
1228 * thread for sleeping on the callback RPC wait queue.
1229 */
1230static bool nfsd41_cb_get_slot(struct nfsd4_callback *cb, struct rpc_task *task)
1231{
1232 struct nfs4_client *clp = cb->cb_clp;
1233 struct nfsd4_session *ses = clp->cl_cb_session;
1234
1235 if (cb->cb_held_slot >= 0)
1236 return true;
1237 cb->cb_held_slot = grab_slot(ses);
1238 if (cb->cb_held_slot < 0) {
1239 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
1240 /* Race breaker */
1241 cb->cb_held_slot = grab_slot(ses);
1242 if (cb->cb_held_slot < 0)
1243 return false;
1244 rpc_wake_up_queued_task(&clp->cl_cb_waitq, task);
1245 }
1246 return true;
1247}
1248
1249static void nfsd41_cb_release_slot(struct nfsd4_callback *cb)
1250{
1251 struct nfs4_client *clp = cb->cb_clp;
1252 struct nfsd4_session *ses = clp->cl_cb_session;
1253
1254 if (cb->cb_held_slot >= 0) {
1255 spin_lock(&ses->se_lock);
1256 ses->se_cb_slot_avail |= BIT(cb->cb_held_slot);
1257 spin_unlock(&ses->se_lock);
1258 cb->cb_held_slot = -1;
1259 rpc_wake_up_next(&clp->cl_cb_waitq);
1260 }
1261}
1262
1263static void nfsd41_destroy_cb(struct nfsd4_callback *cb)
1264{
1265 struct nfs4_client *clp = cb->cb_clp;
1266
1267 trace_nfsd_cb_destroy(clp, cb);
1268 nfsd41_cb_release_slot(cb);
1269 if (cb->cb_ops && cb->cb_ops->release)
1270 cb->cb_ops->release(cb);
1271 nfsd41_cb_inflight_end(clp);
1272}
1273
1274/*
1275 * TODO: cb_sequence should support referring call lists, cachethis,
1276 * and mark callback channel down on communication errors.
1277 */
1278static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
1279{
1280 struct nfsd4_callback *cb = calldata;
1281 struct nfs4_client *clp = cb->cb_clp;
1282 u32 minorversion = clp->cl_minorversion;
1283
1284 /*
1285 * cb_seq_status is only set in decode_cb_sequence4res,
1286 * and so will remain 1 if an rpc level failure occurs.
1287 */
1288 trace_nfsd_cb_rpc_prepare(clp);
1289 cb->cb_seq_status = 1;
1290 cb->cb_status = 0;
1291 if (minorversion && !nfsd41_cb_get_slot(cb, task))
1292 return;
1293 rpc_call_start(task);
1294}
1295
1296static bool nfsd4_cb_sequence_done(struct rpc_task *task, struct nfsd4_callback *cb)
1297{
1298 struct nfs4_client *clp = cb->cb_clp;
1299 struct nfsd4_session *session = clp->cl_cb_session;
1300 bool ret = true;
1301
1302 if (!clp->cl_minorversion) {
1303 /*
1304 * If the backchannel connection was shut down while this
1305 * task was queued, we need to resubmit it after setting up
1306 * a new backchannel connection.
1307 *
1308 * Note that if we lost our callback connection permanently
1309 * the submission code will error out, so we don't need to
1310 * handle that case here.
1311 */
1312 if (RPC_SIGNALLED(task))
1313 goto need_restart;
1314
1315 return true;
1316 }
1317
1318 if (cb->cb_held_slot < 0)
1319 goto need_restart;
1320
1321 /* This is the operation status code for CB_SEQUENCE */
1322 trace_nfsd_cb_seq_status(task, cb);
1323 switch (cb->cb_seq_status) {
1324 case 0:
1325 /*
1326 * No need for lock, access serialized in nfsd4_cb_prepare
1327 *
1328 * RFC5661 20.9.3
1329 * If CB_SEQUENCE returns an error, then the state of the slot
1330 * (sequence ID, cached reply) MUST NOT change.
1331 */
1332 ++session->se_cb_seq_nr[cb->cb_held_slot];
1333 break;
1334 case -ESERVERFAULT:
1335 ++session->se_cb_seq_nr[cb->cb_held_slot];
1336 nfsd4_mark_cb_fault(cb->cb_clp);
1337 ret = false;
1338 break;
1339 case 1:
1340 /*
1341 * cb_seq_status remains 1 if an RPC Reply was never
1342 * received. NFSD can't know if the client processed
1343 * the CB_SEQUENCE operation. Ask the client to send a
1344 * DESTROY_SESSION to recover.
1345 */
1346 fallthrough;
1347 case -NFS4ERR_BADSESSION:
1348 nfsd4_mark_cb_fault(cb->cb_clp);
1349 ret = false;
1350 goto need_restart;
1351 case -NFS4ERR_DELAY:
1352 cb->cb_seq_status = 1;
1353 if (!rpc_restart_call(task))
1354 goto out;
1355
1356 rpc_delay(task, 2 * HZ);
1357 return false;
1358 case -NFS4ERR_BADSLOT:
1359 goto retry_nowait;
1360 case -NFS4ERR_SEQ_MISORDERED:
1361 if (session->se_cb_seq_nr[cb->cb_held_slot] != 1) {
1362 session->se_cb_seq_nr[cb->cb_held_slot] = 1;
1363 goto retry_nowait;
1364 }
1365 break;
1366 default:
1367 nfsd4_mark_cb_fault(cb->cb_clp);
1368 }
1369 trace_nfsd_cb_free_slot(task, cb);
1370 nfsd41_cb_release_slot(cb);
1371
1372 if (RPC_SIGNALLED(task))
1373 goto need_restart;
1374out:
1375 return ret;
1376retry_nowait:
1377 if (rpc_restart_call_prepare(task))
1378 ret = false;
1379 goto out;
1380need_restart:
1381 if (!test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags)) {
1382 trace_nfsd_cb_restart(clp, cb);
1383 task->tk_status = 0;
1384 cb->cb_need_restart = true;
1385 }
1386 return false;
1387}
1388
1389static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
1390{
1391 struct nfsd4_callback *cb = calldata;
1392 struct nfs4_client *clp = cb->cb_clp;
1393
1394 trace_nfsd_cb_rpc_done(clp);
1395
1396 if (!nfsd4_cb_sequence_done(task, cb))
1397 return;
1398
1399 if (cb->cb_status) {
1400 WARN_ONCE(task->tk_status, "cb_status=%d tk_status=%d",
1401 cb->cb_status, task->tk_status);
1402 task->tk_status = cb->cb_status;
1403 }
1404
1405 switch (cb->cb_ops->done(cb, task)) {
1406 case 0:
1407 task->tk_status = 0;
1408 rpc_restart_call_prepare(task);
1409 return;
1410 case 1:
1411 switch (task->tk_status) {
1412 case -EIO:
1413 case -ETIMEDOUT:
1414 case -EACCES:
1415 nfsd4_mark_cb_down(clp);
1416 }
1417 break;
1418 default:
1419 BUG();
1420 }
1421}
1422
1423static void nfsd4_cb_release(void *calldata)
1424{
1425 struct nfsd4_callback *cb = calldata;
1426
1427 trace_nfsd_cb_rpc_release(cb->cb_clp);
1428
1429 if (cb->cb_need_restart)
1430 nfsd4_queue_cb(cb);
1431 else
1432 nfsd41_destroy_cb(cb);
1433
1434}
1435
1436static const struct rpc_call_ops nfsd4_cb_ops = {
1437 .rpc_call_prepare = nfsd4_cb_prepare,
1438 .rpc_call_done = nfsd4_cb_done,
1439 .rpc_release = nfsd4_cb_release,
1440};
1441
1442/* must be called under the state lock */
1443void nfsd4_shutdown_callback(struct nfs4_client *clp)
1444{
1445 if (clp->cl_cb_state != NFSD4_CB_UNKNOWN)
1446 trace_nfsd_cb_shutdown(clp);
1447
1448 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
1449 /*
1450 * Note this won't actually result in a null callback;
1451 * instead, nfsd4_run_cb_null() will detect the killed
1452 * client, destroy the rpc client, and stop:
1453 */
1454 nfsd4_run_cb(&clp->cl_cb_null);
1455 flush_workqueue(clp->cl_callback_wq);
1456 nfsd41_cb_inflight_wait_complete(clp);
1457}
1458
1459static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
1460{
1461 struct nfsd4_session *s;
1462 struct nfsd4_conn *c;
1463
1464 lockdep_assert_held(&clp->cl_lock);
1465
1466 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
1467 list_for_each_entry(c, &s->se_conns, cn_persession) {
1468 if (c->cn_flags & NFS4_CDFC4_BACK)
1469 return c;
1470 }
1471 }
1472 return NULL;
1473}
1474
1475/*
1476 * Note there isn't a lot of locking in this code; instead we depend on
1477 * the fact that it is run from clp->cl_callback_wq, which won't run two
1478 * work items at once. So, for example, clp->cl_callback_wq handles all
1479 * access of cl_cb_client and all calls to rpc_create or rpc_shutdown_client.
1480 */
1481static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
1482{
1483 struct nfs4_cb_conn conn;
1484 struct nfs4_client *clp = cb->cb_clp;
1485 struct nfsd4_session *ses = NULL;
1486 struct nfsd4_conn *c;
1487 int err;
1488
1489 trace_nfsd_cb_bc_update(clp, cb);
1490
1491 /*
1492 * This is either an update, or the client dying; in either case,
1493 * kill the old client:
1494 */
1495 if (clp->cl_cb_client) {
1496 trace_nfsd_cb_bc_shutdown(clp, cb);
1497 rpc_shutdown_client(clp->cl_cb_client);
1498 clp->cl_cb_client = NULL;
1499 put_cred(clp->cl_cb_cred);
1500 clp->cl_cb_cred = NULL;
1501 }
1502 if (clp->cl_cb_conn.cb_xprt) {
1503 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
1504 clp->cl_cb_conn.cb_xprt = NULL;
1505 }
1506 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
1507 return;
1508
1509 spin_lock(&clp->cl_lock);
1510 /*
1511 * Only serialized callback code is allowed to clear these
1512 * flags; main nfsd code can only set them:
1513 */
1514 WARN_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
1515 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
1516
1517 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
1518 c = __nfsd4_find_backchannel(clp);
1519 if (c) {
1520 svc_xprt_get(c->cn_xprt);
1521 conn.cb_xprt = c->cn_xprt;
1522 ses = c->cn_session;
1523 }
1524 spin_unlock(&clp->cl_lock);
1525
1526 err = setup_callback_client(clp, &conn, ses);
1527 if (err) {
1528 nfsd4_mark_cb_down(clp);
1529 if (c)
1530 svc_xprt_put(c->cn_xprt);
1531 return;
1532 }
1533}
1534
1535static void
1536nfsd4_run_cb_work(struct work_struct *work)
1537{
1538 struct nfsd4_callback *cb =
1539 container_of(work, struct nfsd4_callback, cb_work);
1540 struct nfs4_client *clp = cb->cb_clp;
1541 struct rpc_clnt *clnt;
1542 int flags;
1543
1544 trace_nfsd_cb_start(clp);
1545
1546 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
1547 nfsd4_process_cb_update(cb);
1548
1549 clnt = clp->cl_cb_client;
1550 if (!clnt || clp->cl_state == NFSD4_COURTESY) {
1551 /*
1552 * Callback channel broken, client killed or
1553 * nfs4_client in courtesy state; give up.
1554 */
1555 nfsd41_destroy_cb(cb);
1556 return;
1557 }
1558
1559 /*
1560 * Don't send probe messages for 4.1 or later.
1561 */
1562 if (!cb->cb_ops && clp->cl_minorversion) {
1563 nfsd4_mark_cb_state(clp, NFSD4_CB_UP);
1564 nfsd41_destroy_cb(cb);
1565 return;
1566 }
1567
1568 if (cb->cb_need_restart) {
1569 cb->cb_need_restart = false;
1570 } else {
1571 if (cb->cb_ops && cb->cb_ops->prepare)
1572 cb->cb_ops->prepare(cb);
1573 }
1574 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
1575 flags = clp->cl_minorversion ? RPC_TASK_NOCONNECT : RPC_TASK_SOFTCONN;
1576 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | flags,
1577 cb->cb_ops ? &nfsd4_cb_ops : &nfsd4_cb_probe_ops, cb);
1578}
1579
1580void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
1581 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op)
1582{
1583 cb->cb_clp = clp;
1584 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[op];
1585 cb->cb_msg.rpc_argp = cb;
1586 cb->cb_msg.rpc_resp = cb;
1587 cb->cb_ops = ops;
1588 INIT_WORK(&cb->cb_work, nfsd4_run_cb_work);
1589 cb->cb_status = 0;
1590 cb->cb_need_restart = false;
1591 cb->cb_held_slot = -1;
1592}
1593
1594/**
1595 * nfsd4_run_cb - queue up a callback job to run
1596 * @cb: callback to queue
1597 *
1598 * Kick off a callback to do its thing. Returns false if it was already
1599 * on a queue, true otherwise.
1600 */
1601bool nfsd4_run_cb(struct nfsd4_callback *cb)
1602{
1603 struct nfs4_client *clp = cb->cb_clp;
1604 bool queued;
1605
1606 nfsd41_cb_inflight_begin(clp);
1607 queued = nfsd4_queue_cb(cb);
1608 if (!queued)
1609 nfsd41_cb_inflight_end(clp);
1610 return queued;
1611}