blob: d756f443fc444ced1ad3b160bbd1eeb057e6eab9 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * 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
ChenXiaoSong52e89102023-12-02 21:07:25 +000034#include <linux/nfs4.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/sunrpc/clnt.h>
Kinglong Meed531c002014-03-24 11:59:46 +080036#include <linux/sunrpc/xprt.h>
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -050037#include <linux/sunrpc/svc_xprt.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090038#include <linux/slab.h>
Boaz Harrosh9a74af22009-12-03 20:30:56 +020039#include "nfsd.h"
40#include "state.h"
Stanislav Kinsbursky3d733712012-11-27 14:11:44 +030041#include "netns.h"
Chuck Lever1eace0d2020-04-05 14:15:29 -040042#include "trace.h"
J. Bruce Fields06b332a2013-04-09 11:34:36 -040043#include "xdr4cb.h"
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -040044#include "xdr4.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46#define NFSDDBG_FACILITY NFSDDBG_PROC
47
Chuck Lever627fb182024-01-26 12:46:13 -050048static void nfsd4_mark_cb_fault(struct nfs4_client *clp);
Benny Halevy54237322011-10-19 19:12:58 -070049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#define NFSPROC4_CB_NULL 0
51#define NFSPROC4_CB_COMPOUND 1
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053/* Index of predefined Linux callback client operations */
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055struct nfs4_cb_compound_hdr {
Andy Adamson38524ab2009-09-10 12:25:59 +030056 /* args */
57 u32 ident; /* minorversion 0 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 u32 nops;
Andy Adamsonef52bff2009-06-16 04:20:50 +030059 __be32 *nops_p;
Andy Adamsonab52ae62009-06-16 04:20:53 +030060 u32 minorversion;
Andy Adamson38524ab2009-09-10 12:25:59 +030061 /* res */
62 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063};
64
Chuck Levera033db42010-12-14 14:57:22 +000065static __be32 *xdr_encode_empty_array(__be32 *p)
66{
67 *p++ = xdr_zero;
68 return p;
69}
70
Linus Torvalds1da177e2005-04-16 15:20:36 -070071/*
Chuck Levera033db42010-12-14 14:57:22 +000072 * 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"
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 */
79
Dai Ngo39590662022-11-16 19:44:46 -080080static 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{
Dai Ngo6487a132024-02-15 14:05:21 -080088 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;
Dai Ngo39590662022-11-16 19:44:46 -0800103}
104
Chuck Levera033db42010-12-14 14:57:22 +0000105static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
Benny Halevy9303bbd2010-05-25 09:50:23 +0300106{
107 __be32 *p;
108
Chuck Levera033db42010-12-14 14:57:22 +0000109 p = xdr_reserve_space(xdr, 4);
110 *p = cpu_to_be32(op);
Benny Halevy9303bbd2010-05-25 09:50:23 +0300111}
112
Chuck Levera033db42010-12-14 14:57:22 +0000113/*
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);
NeilBrownd8b26072021-09-02 11:16:32 +1000125 xdr_encode_opaque(p, &fh->fh_raw, length);
Chuck Levera033db42010-12-14 14:57:22 +0000126}
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/*
Chuck Lever85a56482010-12-14 14:57:32 +0000161 * 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
Stefan Agner47299f72018-03-19 23:37:05 +0100220static int decode_cb_op_status(struct xdr_stream *xdr,
221 enum nfs_cb_opnum4 expected, int *status)
Chuck Lever85a56482010-12-14 14:57:32 +0000222{
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;
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200232 *status = nfs_cb_stat_to_errno(be32_to_cpup(p));
Chuck Lever85a56482010-12-14 14:57:32 +0000233 return 0;
234out_overflow:
Chuck Lever85a56482010-12-14 14:57:32 +0000235 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/*
Chuck Levera033db42010-12-14 14:57:22 +0000243 * 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254{
Al Virof00f3282006-10-19 23:29:01 -0700255 __be32 * p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Chuck Levera033db42010-12-14 14:57:22 +0000257 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
Andy Adamsonef52bff2009-06-16 04:20:50 +0300262 hdr->nops_p = p;
Chuck Levera033db42010-12-14 14:57:22 +0000263 *p = cpu_to_be32(hdr->nops); /* argarray element count */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264}
265
Chuck Levera033db42010-12-14 14:57:22 +0000266/*
267 * Update argarray element count
268 */
Andy Adamsonef52bff2009-06-16 04:20:50 +0300269static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
270{
Chuck Levera033db42010-12-14 14:57:22 +0000271 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
272 *hdr->nops_p = cpu_to_be32(hdr->nops);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300273}
274
Chuck Levera033db42010-12-14 14:57:22 +0000275/*
Chuck Lever85a56482010-12-14 14:57:32 +0000276 * 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, 4 + 4);
291 if (unlikely(p == NULL))
292 goto out_overflow;
293 hdr->status = be32_to_cpup(p++);
294 /* Ignore the tag */
295 length = be32_to_cpup(p++);
296 p = xdr_inline_decode(xdr, length + 4);
297 if (unlikely(p == NULL))
298 goto out_overflow;
Kinglong Meee86a40b2017-02-05 09:57:37 +0800299 p += XDR_QUADLEN(length);
Chuck Lever85a56482010-12-14 14:57:32 +0000300 hdr->nops = be32_to_cpup(p);
301 return 0;
302out_overflow:
Chuck Lever85a56482010-12-14 14:57:32 +0000303 return -EIO;
304}
305
306/*
Chuck Levera033db42010-12-14 14:57:22 +0000307 * 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318{
Al Virof00f3282006-10-19 23:29:01 -0700319 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Chuck Levera033db42010-12-14 14:57:22 +0000321 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -0400322 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
Chuck Levera033db42010-12-14 14:57:22 +0000323
324 p = xdr_reserve_space(xdr, 4);
325 *p++ = xdr_zero; /* truncate */
326
Trond Myklebust11b91642014-07-29 21:34:08 -0400327 encode_nfs_fh4(xdr, &dp->dl_stid.sc_file->fi_fhandle);
Chuck Levera033db42010-12-14 14:57:22 +0000328
Andy Adamsonef52bff2009-06-16 04:20:50 +0300329 hdr->nops++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330}
331
Chuck Levera033db42010-12-14 14:57:22 +0000332/*
Dai Ngo39590662022-11-16 19:44:46 -0800333 * 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/*
Dai Ngo6487a132024-02-15 14:05:21 -0800351 * 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
368 encode_nfs_cb_opnum4(xdr, OP_CB_GETATTR);
369 encode_nfs_fh4(xdr, fh);
370 encode_bitmap4(xdr, fattr->ncf_cb_bmap, ARRAY_SIZE(fattr->ncf_cb_bmap));
371 hdr->nops++;
372}
373
374/*
Chuck Levera033db42010-12-14 14:57:22 +0000375 * CB_SEQUENCE4args
376 *
377 * struct CB_SEQUENCE4args {
378 * sessionid4 csa_sessionid;
379 * sequenceid4 csa_sequenceid;
380 * slotid4 csa_slotid;
381 * slotid4 csa_highest_slotid;
382 * bool csa_cachethis;
383 * referring_call_list4 csa_referring_call_lists<>;
384 * };
385 */
386static void encode_cb_sequence4args(struct xdr_stream *xdr,
387 const struct nfsd4_callback *cb,
388 struct nfs4_cb_compound_hdr *hdr)
Benny Halevy2af73582009-09-10 12:26:51 +0300389{
Chuck Levera033db42010-12-14 14:57:22 +0000390 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
Benny Halevy2af73582009-09-10 12:26:51 +0300391 __be32 *p;
392
393 if (hdr->minorversion == 0)
394 return;
395
Chuck Levera033db42010-12-14 14:57:22 +0000396 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
397 encode_sessionid4(xdr, session);
Benny Halevy2af73582009-09-10 12:26:51 +0300398
Chuck Levera033db42010-12-14 14:57:22 +0000399 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
400 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
401 *p++ = xdr_zero; /* csa_slotid */
402 *p++ = xdr_zero; /* csa_highest_slotid */
403 *p++ = xdr_zero; /* csa_cachethis */
404 xdr_encode_empty_array(p); /* csa_referring_call_lists */
405
Benny Halevy2af73582009-09-10 12:26:51 +0300406 hdr->nops++;
407}
408
Chuck Levera033db42010-12-14 14:57:22 +0000409/*
Chuck Lever85a56482010-12-14 14:57:32 +0000410 * CB_SEQUENCE4resok
411 *
412 * struct CB_SEQUENCE4resok {
413 * sessionid4 csr_sessionid;
414 * sequenceid4 csr_sequenceid;
415 * slotid4 csr_slotid;
416 * slotid4 csr_highest_slotid;
417 * slotid4 csr_target_highest_slotid;
418 * };
419 *
420 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
421 * case NFS4_OK:
422 * CB_SEQUENCE4resok csr_resok4;
423 * default:
424 * void;
425 * };
426 *
427 * Our current back channel implmentation supports a single backchannel
428 * with a single slot.
429 */
430static int decode_cb_sequence4resok(struct xdr_stream *xdr,
431 struct nfsd4_callback *cb)
432{
433 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
Kinglong Mee82743382017-02-05 09:57:48 +0800434 int status = -ESERVERFAULT;
Chuck Lever85a56482010-12-14 14:57:32 +0000435 __be32 *p;
436 u32 dummy;
437
Chuck Lever85a56482010-12-14 14:57:32 +0000438 /*
439 * If the server returns different values for sessionID, slotID or
440 * sequence number, the server is looney tunes.
441 */
Benny Halevy2c9c8f32011-02-22 14:43:22 -0800442 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
Chuck Lever85a56482010-12-14 14:57:32 +0000443 if (unlikely(p == NULL))
444 goto out_overflow;
Kinglong Mee82743382017-02-05 09:57:48 +0800445
446 if (memcmp(p, session->se_sessionid.data, NFS4_MAX_SESSIONID_LEN)) {
Chuck Lever85a56482010-12-14 14:57:32 +0000447 dprintk("NFS: %s Invalid session id\n", __func__);
448 goto out;
449 }
450 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
451
452 dummy = be32_to_cpup(p++);
453 if (dummy != session->se_cb_seq_nr) {
454 dprintk("NFS: %s Invalid sequence number\n", __func__);
455 goto out;
456 }
457
458 dummy = be32_to_cpup(p++);
459 if (dummy != 0) {
460 dprintk("NFS: %s Invalid slotid\n", __func__);
461 goto out;
462 }
463
464 /*
465 * FIXME: process highest slotid and target highest slotid
466 */
467 status = 0;
468out:
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800469 cb->cb_seq_status = status;
Chuck Lever85a56482010-12-14 14:57:32 +0000470 return status;
471out_overflow:
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800472 status = -EIO;
473 goto out;
Chuck Lever85a56482010-12-14 14:57:32 +0000474}
475
476static int decode_cb_sequence4res(struct xdr_stream *xdr,
477 struct nfsd4_callback *cb)
478{
Chuck Lever85a56482010-12-14 14:57:32 +0000479 int status;
480
Jeff Layton89dfdc92016-08-16 13:29:27 -0400481 if (cb->cb_clp->cl_minorversion == 0)
Chuck Lever85a56482010-12-14 14:57:32 +0000482 return 0;
483
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800484 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &cb->cb_seq_status);
485 if (unlikely(status || cb->cb_seq_status))
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200486 return status;
487
488 return decode_cb_sequence4resok(xdr, cb);
Chuck Lever85a56482010-12-14 14:57:32 +0000489}
490
491/*
Chuck Levera033db42010-12-14 14:57:22 +0000492 * NFSv4.0 and NFSv4.1 XDR encode functions
493 *
494 * NFSv4.0 callback argument types are defined in section 15 of RFC
495 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
496 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
497 * Protocol".
498 */
499
500/*
501 * NB: Without this zero space reservation, callbacks over krb5p fail
502 */
Chuck Lever9f06c712010-12-14 14:59:18 +0000503static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
Christoph Hellwig1502c812017-05-08 14:47:53 +0200504 const void *__unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
Chuck Levera033db42010-12-14 14:57:22 +0000506 xdr_reserve_space(xdr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507}
508
Chuck Levera033db42010-12-14 14:57:22 +0000509/*
Dai Ngo6487a132024-02-15 14:05:21 -0800510 * 20.1. Operation 3: CB_GETATTR - Get Attributes
511 */
512static void nfs4_xdr_enc_cb_getattr(struct rpc_rqst *req,
513 struct xdr_stream *xdr, const void *data)
514{
515 const struct nfsd4_callback *cb = data;
516 struct nfs4_cb_fattr *ncf =
517 container_of(cb, struct nfs4_cb_fattr, ncf_getattr);
518 struct nfs4_cb_compound_hdr hdr = {
519 .ident = cb->cb_clp->cl_cb_ident,
520 .minorversion = cb->cb_clp->cl_minorversion,
521 };
522
523 encode_cb_compound4args(xdr, &hdr);
524 encode_cb_sequence4args(xdr, cb, &hdr);
525 encode_cb_getattr4args(xdr, &hdr, ncf);
526 encode_cb_nops(&hdr);
527}
528
529/*
Chuck Levera033db42010-12-14 14:57:22 +0000530 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
531 */
Chuck Lever9f06c712010-12-14 14:59:18 +0000532static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
Christoph Hellwig1502c812017-05-08 14:47:53 +0200533 const void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534{
Christoph Hellwig1502c812017-05-08 14:47:53 +0200535 const struct nfsd4_callback *cb = data;
Jeff Layton34549ab2014-10-01 08:05:22 -0400536 const struct nfs4_delegation *dp = cb_to_delegation(cb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 struct nfs4_cb_compound_hdr hdr = {
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400538 .ident = cb->cb_clp->cl_cb_ident,
Jeff Layton89dfdc92016-08-16 13:29:27 -0400539 .minorversion = cb->cb_clp->cl_minorversion,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 };
541
Chuck Lever9f06c712010-12-14 14:59:18 +0000542 encode_cb_compound4args(xdr, &hdr);
543 encode_cb_sequence4args(xdr, cb, &hdr);
Christoph Hellwig2faf3b42014-09-24 12:19:16 +0200544 encode_cb_recall4args(xdr, dp, &hdr);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300545 encode_cb_nops(&hdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546}
547
Dai Ngo39590662022-11-16 19:44:46 -0800548/*
549 * 20.6. Operation 8: CB_RECALL_ANY - Keep Any N Recallable Objects
550 */
551static void
552nfs4_xdr_enc_cb_recall_any(struct rpc_rqst *req,
553 struct xdr_stream *xdr, const void *data)
554{
555 const struct nfsd4_callback *cb = data;
556 struct nfsd4_cb_recall_any *ra;
557 struct nfs4_cb_compound_hdr hdr = {
558 .ident = cb->cb_clp->cl_cb_ident,
559 .minorversion = cb->cb_clp->cl_minorversion,
560 };
561
562 ra = container_of(cb, struct nfsd4_cb_recall_any, ra_cb);
563 encode_cb_compound4args(xdr, &hdr);
564 encode_cb_sequence4args(xdr, cb, &hdr);
565 encode_cb_recallany4args(xdr, &hdr, ra);
566 encode_cb_nops(&hdr);
567}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
Chuck Lever85a56482010-12-14 14:57:32 +0000569/*
570 * NFSv4.0 and NFSv4.1 XDR decode functions
571 *
572 * NFSv4.0 callback result types are defined in section 15 of RFC
573 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
574 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
575 * Protocol".
576 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
Chuck Leverbf269552010-12-14 14:59:29 +0000578static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
579 void *__unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 return 0;
582}
583
Benny Halevy2af73582009-09-10 12:26:51 +0300584/*
Dai Ngo6487a132024-02-15 14:05:21 -0800585 * 20.1. Operation 3: CB_GETATTR - Get Attributes
586 */
587static int nfs4_xdr_dec_cb_getattr(struct rpc_rqst *rqstp,
588 struct xdr_stream *xdr,
589 void *data)
590{
591 struct nfsd4_callback *cb = data;
592 struct nfs4_cb_compound_hdr hdr;
593 int status;
594 u32 bitmap[3] = {0};
595 u32 attrlen;
596 struct nfs4_cb_fattr *ncf =
597 container_of(cb, struct nfs4_cb_fattr, ncf_getattr);
598
599 status = decode_cb_compound4res(xdr, &hdr);
600 if (unlikely(status))
601 return status;
602
603 status = decode_cb_sequence4res(xdr, cb);
604 if (unlikely(status || cb->cb_seq_status))
605 return status;
606
607 status = decode_cb_op_status(xdr, OP_CB_GETATTR, &cb->cb_status);
608 if (status)
609 return status;
610 if (xdr_stream_decode_uint32_array(xdr, bitmap, 3) < 0)
611 return -NFSERR_BAD_XDR;
612 if (xdr_stream_decode_u32(xdr, &attrlen) < 0)
613 return -NFSERR_BAD_XDR;
614 if (attrlen > (sizeof(ncf->ncf_cb_change) + sizeof(ncf->ncf_cb_fsize)))
615 return -NFSERR_BAD_XDR;
616 status = decode_cb_fattr4(xdr, bitmap, ncf);
617 return status;
618}
619
620/*
Chuck Lever85a56482010-12-14 14:57:32 +0000621 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
Benny Halevy2af73582009-09-10 12:26:51 +0300622 */
Chuck Leverbf269552010-12-14 14:59:29 +0000623static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
624 struct xdr_stream *xdr,
Christoph Hellwigd39916c2017-05-08 15:04:45 +0200625 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
Christoph Hellwigd39916c2017-05-08 15:04:45 +0200627 struct nfsd4_callback *cb = data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 struct nfs4_cb_compound_hdr hdr;
629 int status;
630
Chuck Leverbf269552010-12-14 14:59:29 +0000631 status = decode_cb_compound4res(xdr, &hdr);
Chuck Lever85a56482010-12-14 14:57:32 +0000632 if (unlikely(status))
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200633 return status;
Chuck Lever85a56482010-12-14 14:57:32 +0000634
J. Bruce Fields10fa8ac2019-07-30 19:06:38 -0400635 status = decode_cb_sequence4res(xdr, cb);
636 if (unlikely(status || cb->cb_seq_status))
637 return status;
Chuck Lever85a56482010-12-14 14:57:32 +0000638
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200639 return decode_cb_op_status(xdr, OP_CB_RECALL, &cb->cb_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640}
641
Dai Ngo39590662022-11-16 19:44:46 -0800642/*
643 * 20.6. Operation 8: CB_RECALL_ANY - Keep Any N Recallable Objects
644 */
645static int
646nfs4_xdr_dec_cb_recall_any(struct rpc_rqst *rqstp,
647 struct xdr_stream *xdr,
648 void *data)
649{
650 struct nfsd4_callback *cb = data;
651 struct nfs4_cb_compound_hdr hdr;
652 int status;
653
654 status = decode_cb_compound4res(xdr, &hdr);
655 if (unlikely(status))
656 return status;
657 status = decode_cb_sequence4res(xdr, cb);
658 if (unlikely(status || cb->cb_seq_status))
659 return status;
660 status = decode_cb_op_status(xdr, OP_CB_RECALL_ANY, &cb->cb_status);
661 return status;
662}
663
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200664#ifdef CONFIG_NFSD_PNFS
665/*
666 * CB_LAYOUTRECALL4args
667 *
668 * struct layoutrecall_file4 {
669 * nfs_fh4 lor_fh;
670 * offset4 lor_offset;
671 * length4 lor_length;
672 * stateid4 lor_stateid;
673 * };
674 *
675 * union layoutrecall4 switch(layoutrecall_type4 lor_recalltype) {
676 * case LAYOUTRECALL4_FILE:
677 * layoutrecall_file4 lor_layout;
678 * case LAYOUTRECALL4_FSID:
679 * fsid4 lor_fsid;
680 * case LAYOUTRECALL4_ALL:
681 * void;
682 * };
683 *
684 * struct CB_LAYOUTRECALL4args {
685 * layouttype4 clora_type;
686 * layoutiomode4 clora_iomode;
687 * bool clora_changed;
688 * layoutrecall4 clora_recall;
689 * };
690 */
691static void encode_cb_layout4args(struct xdr_stream *xdr,
692 const struct nfs4_layout_stateid *ls,
693 struct nfs4_cb_compound_hdr *hdr)
694{
695 __be32 *p;
696
697 BUG_ON(hdr->minorversion == 0);
698
699 p = xdr_reserve_space(xdr, 5 * 4);
700 *p++ = cpu_to_be32(OP_CB_LAYOUTRECALL);
701 *p++ = cpu_to_be32(ls->ls_layout_type);
702 *p++ = cpu_to_be32(IOMODE_ANY);
703 *p++ = cpu_to_be32(1);
704 *p = cpu_to_be32(RETURN_FILE);
705
706 encode_nfs_fh4(xdr, &ls->ls_stid.sc_file->fi_fhandle);
707
708 p = xdr_reserve_space(xdr, 2 * 8);
709 p = xdr_encode_hyper(p, 0);
710 xdr_encode_hyper(p, NFS4_MAX_UINT64);
711
712 encode_stateid4(xdr, &ls->ls_recall_sid);
713
714 hdr->nops++;
715}
716
717static void nfs4_xdr_enc_cb_layout(struct rpc_rqst *req,
718 struct xdr_stream *xdr,
Christoph Hellwig1502c812017-05-08 14:47:53 +0200719 const void *data)
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200720{
Christoph Hellwig1502c812017-05-08 14:47:53 +0200721 const struct nfsd4_callback *cb = data;
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200722 const struct nfs4_layout_stateid *ls =
723 container_of(cb, struct nfs4_layout_stateid, ls_recall);
724 struct nfs4_cb_compound_hdr hdr = {
725 .ident = 0,
Jeff Layton89dfdc92016-08-16 13:29:27 -0400726 .minorversion = cb->cb_clp->cl_minorversion,
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200727 };
728
729 encode_cb_compound4args(xdr, &hdr);
730 encode_cb_sequence4args(xdr, cb, &hdr);
731 encode_cb_layout4args(xdr, ls, &hdr);
732 encode_cb_nops(&hdr);
733}
734
735static int nfs4_xdr_dec_cb_layout(struct rpc_rqst *rqstp,
736 struct xdr_stream *xdr,
Christoph Hellwigd39916c2017-05-08 15:04:45 +0200737 void *data)
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200738{
Christoph Hellwigd39916c2017-05-08 15:04:45 +0200739 struct nfsd4_callback *cb = data;
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200740 struct nfs4_cb_compound_hdr hdr;
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200741 int status;
742
743 status = decode_cb_compound4res(xdr, &hdr);
744 if (unlikely(status))
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200745 return status;
746
J. Bruce Fields10fa8ac2019-07-30 19:06:38 -0400747 status = decode_cb_sequence4res(xdr, cb);
748 if (unlikely(status || cb->cb_seq_status))
749 return status;
750
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200751 return decode_cb_op_status(xdr, OP_CB_LAYOUTRECALL, &cb->cb_status);
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200752}
753#endif /* CONFIG_NFSD_PNFS */
754
Jeff Laytona188620e2016-09-16 16:28:23 -0400755static void encode_stateowner(struct xdr_stream *xdr, struct nfs4_stateowner *so)
756{
757 __be32 *p;
758
759 p = xdr_reserve_space(xdr, 8 + 4 + so->so_owner.len);
760 p = xdr_encode_opaque_fixed(p, &so->so_client->cl_clientid, 8);
761 xdr_encode_opaque(p, so->so_owner.data, so->so_owner.len);
762}
763
764static void nfs4_xdr_enc_cb_notify_lock(struct rpc_rqst *req,
765 struct xdr_stream *xdr,
Christoph Hellwig1502c812017-05-08 14:47:53 +0200766 const void *data)
Jeff Laytona188620e2016-09-16 16:28:23 -0400767{
Christoph Hellwig1502c812017-05-08 14:47:53 +0200768 const struct nfsd4_callback *cb = data;
Jeff Laytona188620e2016-09-16 16:28:23 -0400769 const struct nfsd4_blocked_lock *nbl =
770 container_of(cb, struct nfsd4_blocked_lock, nbl_cb);
Jeff Layton05580bb2024-01-31 18:02:23 -0500771 struct nfs4_lockowner *lo = (struct nfs4_lockowner *)nbl->nbl_lock.c.flc_owner;
Jeff Laytona188620e2016-09-16 16:28:23 -0400772 struct nfs4_cb_compound_hdr hdr = {
773 .ident = 0,
774 .minorversion = cb->cb_clp->cl_minorversion,
775 };
776
777 __be32 *p;
778
779 BUG_ON(hdr.minorversion == 0);
780
781 encode_cb_compound4args(xdr, &hdr);
782 encode_cb_sequence4args(xdr, cb, &hdr);
783
784 p = xdr_reserve_space(xdr, 4);
785 *p = cpu_to_be32(OP_CB_NOTIFY_LOCK);
786 encode_nfs_fh4(xdr, &nbl->nbl_fh);
787 encode_stateowner(xdr, &lo->lo_owner);
788 hdr.nops++;
789
790 encode_cb_nops(&hdr);
791}
792
793static int nfs4_xdr_dec_cb_notify_lock(struct rpc_rqst *rqstp,
794 struct xdr_stream *xdr,
Christoph Hellwigd39916c2017-05-08 15:04:45 +0200795 void *data)
Jeff Laytona188620e2016-09-16 16:28:23 -0400796{
Christoph Hellwigd39916c2017-05-08 15:04:45 +0200797 struct nfsd4_callback *cb = data;
Jeff Laytona188620e2016-09-16 16:28:23 -0400798 struct nfs4_cb_compound_hdr hdr;
799 int status;
800
801 status = decode_cb_compound4res(xdr, &hdr);
802 if (unlikely(status))
803 return status;
804
J. Bruce Fields10fa8ac2019-07-30 19:06:38 -0400805 status = decode_cb_sequence4res(xdr, cb);
806 if (unlikely(status || cb->cb_seq_status))
807 return status;
808
Jeff Laytona188620e2016-09-16 16:28:23 -0400809 return decode_cb_op_status(xdr, OP_CB_NOTIFY_LOCK, &cb->cb_status);
810}
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812/*
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400813 * struct write_response4 {
814 * stateid4 wr_callback_id<1>;
815 * length4 wr_count;
816 * stable_how4 wr_committed;
817 * verifier4 wr_writeverf;
818 * };
819 * union offload_info4 switch (nfsstat4 coa_status) {
820 * case NFS4_OK:
821 * write_response4 coa_resok4;
822 * default:
Chuck Levera11ada92022-07-27 14:41:18 -0400823 * length4 coa_bytes_copied;
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400824 * };
825 * struct CB_OFFLOAD4args {
826 * nfs_fh4 coa_fh;
827 * stateid4 coa_stateid;
828 * offload_info4 coa_offload_info;
829 * };
830 */
831static void encode_offload_info4(struct xdr_stream *xdr,
Chuck Levera11ada92022-07-27 14:41:18 -0400832 const struct nfsd4_cb_offload *cbo)
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400833{
834 __be32 *p;
835
836 p = xdr_reserve_space(xdr, 4);
Chuck Levera11ada92022-07-27 14:41:18 -0400837 *p = cbo->co_nfserr;
838 switch (cbo->co_nfserr) {
839 case nfs_ok:
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400840 p = xdr_reserve_space(xdr, 4 + 8 + 4 + NFS4_VERIFIER_SIZE);
841 p = xdr_encode_empty_array(p);
Chuck Levera11ada92022-07-27 14:41:18 -0400842 p = xdr_encode_hyper(p, cbo->co_res.wr_bytes_written);
843 *p++ = cpu_to_be32(cbo->co_res.wr_stable_how);
844 p = xdr_encode_opaque_fixed(p, cbo->co_res.wr_verifier.data,
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400845 NFS4_VERIFIER_SIZE);
Chuck Levera11ada92022-07-27 14:41:18 -0400846 break;
847 default:
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400848 p = xdr_reserve_space(xdr, 8);
849 /* We always return success if bytes were written */
850 p = xdr_encode_hyper(p, 0);
851 }
852}
853
854static void encode_cb_offload4args(struct xdr_stream *xdr,
Chuck Levera11ada92022-07-27 14:41:18 -0400855 const struct nfsd4_cb_offload *cbo,
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400856 struct nfs4_cb_compound_hdr *hdr)
857{
858 __be32 *p;
859
860 p = xdr_reserve_space(xdr, 4);
Chuck Levera11ada92022-07-27 14:41:18 -0400861 *p = cpu_to_be32(OP_CB_OFFLOAD);
862 encode_nfs_fh4(xdr, &cbo->co_fh);
863 encode_stateid4(xdr, &cbo->co_res.cb_stateid);
864 encode_offload_info4(xdr, cbo);
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400865
866 hdr->nops++;
867}
868
869static void nfs4_xdr_enc_cb_offload(struct rpc_rqst *req,
870 struct xdr_stream *xdr,
871 const void *data)
872{
873 const struct nfsd4_callback *cb = data;
Chuck Levera11ada92022-07-27 14:41:18 -0400874 const struct nfsd4_cb_offload *cbo =
875 container_of(cb, struct nfsd4_cb_offload, co_cb);
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400876 struct nfs4_cb_compound_hdr hdr = {
877 .ident = 0,
878 .minorversion = cb->cb_clp->cl_minorversion,
879 };
880
881 encode_cb_compound4args(xdr, &hdr);
882 encode_cb_sequence4args(xdr, cb, &hdr);
Chuck Levera11ada92022-07-27 14:41:18 -0400883 encode_cb_offload4args(xdr, cbo, &hdr);
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400884 encode_cb_nops(&hdr);
885}
886
887static int nfs4_xdr_dec_cb_offload(struct rpc_rqst *rqstp,
888 struct xdr_stream *xdr,
889 void *data)
890{
891 struct nfsd4_callback *cb = data;
892 struct nfs4_cb_compound_hdr hdr;
893 int status;
894
895 status = decode_cb_compound4res(xdr, &hdr);
896 if (unlikely(status))
897 return status;
898
J. Bruce Fields10fa8ac2019-07-30 19:06:38 -0400899 status = decode_cb_sequence4res(xdr, cb);
900 if (unlikely(status || cb->cb_seq_status))
901 return status;
902
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400903 return decode_cb_op_status(xdr, OP_CB_OFFLOAD, &cb->cb_status);
904}
905/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 * RPC procedure tables
907 */
Chuck Lever7d93bd712010-12-14 14:57:42 +0000908#define PROC(proc, call, argtype, restype) \
909[NFSPROC4_CLNT_##proc] = { \
910 .p_proc = NFSPROC4_CB_##call, \
Christoph Hellwig1502c812017-05-08 14:47:53 +0200911 .p_encode = nfs4_xdr_enc_##argtype, \
Christoph Hellwigd39916c2017-05-08 15:04:45 +0200912 .p_decode = nfs4_xdr_dec_##restype, \
Chuck Lever7d93bd712010-12-14 14:57:42 +0000913 .p_arglen = NFS4_enc_##argtype##_sz, \
914 .p_replen = NFS4_dec_##restype##_sz, \
915 .p_statidx = NFSPROC4_CB_##call, \
916 .p_name = #proc, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917}
918
Christoph Hellwig499b4982017-05-12 15:36:49 +0200919static const struct rpc_procinfo nfs4_cb_procedures[] = {
Chuck Lever7d93bd712010-12-14 14:57:42 +0000920 PROC(CB_NULL, NULL, cb_null, cb_null),
921 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200922#ifdef CONFIG_NFSD_PNFS
923 PROC(CB_LAYOUT, COMPOUND, cb_layout, cb_layout),
924#endif
Jeff Laytona188620e2016-09-16 16:28:23 -0400925 PROC(CB_NOTIFY_LOCK, COMPOUND, cb_notify_lock, cb_notify_lock),
Olga Kornievskaia9eb190fca8f2018-07-20 18:19:17 -0400926 PROC(CB_OFFLOAD, COMPOUND, cb_offload, cb_offload),
Dai Ngo39590662022-11-16 19:44:46 -0800927 PROC(CB_RECALL_ANY, COMPOUND, cb_recall_any, cb_recall_any),
Dai Ngo6487a132024-02-15 14:05:21 -0800928 PROC(CB_GETATTR, COMPOUND, cb_getattr, cb_getattr),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929};
930
Christoph Hellwig1c5876d2017-05-08 23:27:10 +0200931static unsigned int nfs4_cb_counts[ARRAY_SIZE(nfs4_cb_procedures)];
Christoph Hellwig02be49f2017-05-12 15:58:06 +0200932static const struct rpc_version nfs_cb_version4 = {
J. Bruce Fieldsb7299f42010-05-14 17:57:35 -0400933/*
934 * Note on the callback rpc program version number: despite language in rfc
935 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
936 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
937 * in practice that appears to be what implementations use. The section
938 * 18.36.3 language is expected to be fixed in an erratum.
939 */
Chuck Lever7d93bd712010-12-14 14:57:42 +0000940 .number = 1,
941 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
Christoph Hellwig1c5876d2017-05-08 23:27:10 +0200942 .procs = nfs4_cb_procedures,
943 .counts = nfs4_cb_counts,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944};
945
Trond Myklebusteff79362017-07-16 22:57:27 +0000946static const struct rpc_version *nfs_cb_version[2] = {
947 [1] = &nfs_cb_version4,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948};
949
Trond Myklebusta613fa12012-01-20 13:53:56 -0500950static const struct rpc_program cb_program;
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400951
952static struct rpc_stat cb_stats = {
Chuck Lever7d93bd712010-12-14 14:57:42 +0000953 .program = &cb_program
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400954};
955
956#define NFS4_CALLBACK 0x40000000
Trond Myklebusta613fa12012-01-20 13:53:56 -0500957static const struct rpc_program cb_program = {
Chuck Lever7d93bd712010-12-14 14:57:42 +0000958 .name = "nfs4_cb",
959 .number = NFS4_CALLBACK,
960 .nrvers = ARRAY_SIZE(nfs_cb_version),
961 .version = nfs_cb_version,
962 .stats = &cb_stats,
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400963 .pipe_dir_name = "nfsd4_cb",
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400964};
965
Stanislav Kinsbursky3d733712012-11-27 14:11:44 +0300966static int max_cb_time(struct net *net)
J. Bruce Fields595947a2009-03-05 17:18:10 -0500967{
Stanislav Kinsbursky3d733712012-11-27 14:11:44 +0300968 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
Arnd Bergmann20b7d862019-11-04 16:31:52 +0100969
970 /*
971 * nfsd4_lease is set to at most one hour in __nfsd4_write_time,
972 * so we can use 32-bit math on it. Warn if that assumption
973 * ever stops being true.
974 */
975 if (WARN_ON_ONCE(nn->nfsd4_lease > 3600))
976 return 360 * HZ;
977
978 return max(((u32)nn->nfsd4_lease)/10, 1u) * HZ;
J. Bruce Fields595947a2009-03-05 17:18:10 -0500979}
980
Trond Myklebust2bbfed92019-10-23 17:43:18 -0400981static bool nfsd4_queue_cb(struct nfsd4_callback *cb)
982{
Chuck Lever38f080f2024-04-01 16:05:39 -0400983 struct nfs4_client *clp = cb->cb_clp;
984
985 trace_nfsd_cb_queue(clp, cb);
986 return queue_work(clp->cl_callback_wq, &cb->cb_work);
Trond Myklebust2bbfed92019-10-23 17:43:18 -0400987}
988
989static void nfsd41_cb_inflight_begin(struct nfs4_client *clp)
990{
991 atomic_inc(&clp->cl_cb_inflight);
992}
993
994static void nfsd41_cb_inflight_end(struct nfs4_client *clp)
995{
996
997 if (atomic_dec_and_test(&clp->cl_cb_inflight))
998 wake_up_var(&clp->cl_cb_inflight);
999}
1000
1001static void nfsd41_cb_inflight_wait_complete(struct nfs4_client *clp)
1002{
1003 wait_var_event(&clp->cl_cb_inflight,
1004 !atomic_read(&clp->cl_cb_inflight));
1005}
1006
NeilBrowna52458b2018-12-03 11:30:31 +11001007static const struct cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001008{
1009 if (clp->cl_minorversion == 0) {
NeilBrown5e169232018-12-03 11:30:30 +11001010 client->cl_principal = clp->cl_cred.cr_targ_princ ?
1011 clp->cl_cred.cr_targ_princ : "nfs";
Chuck Levercb25e7b2018-08-16 12:06:04 -04001012
NeilBrowna52458b2018-12-03 11:30:31 +11001013 return get_cred(rpc_machine_cred());
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001014 } else {
NeilBrown97f68c6b2018-12-03 11:30:30 +11001015 struct cred *kcred;
NeilBrown97f68c6b2018-12-03 11:30:30 +11001016
Kees Cook5a17f042022-10-26 16:31:11 -07001017 kcred = prepare_kernel_cred(&init_task);
NeilBrown97f68c6b2018-12-03 11:30:30 +11001018 if (!kcred)
1019 return NULL;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001020
Dai Ngo7de82c22023-04-01 13:22:08 -07001021 kcred->fsuid = ses->se_cb_sec.uid;
1022 kcred->fsgid = ses->se_cb_sec.gid;
NeilBrowna52458b2018-12-03 11:30:31 +11001023 return kcred;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001024 }
1025}
J. Bruce Fields2b47eec2007-07-27 18:06:50 -04001026
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001027static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
J. Bruce Fields2b47eec2007-07-27 18:06:50 -04001028{
Jeff Layton3758cf72014-04-15 08:51:48 -04001029 int maxtime = max_cb_time(clp->net);
Chuck Leverae5c7942006-08-22 20:06:21 -04001030 struct rpc_timeout timeparms = {
Jeff Layton3758cf72014-04-15 08:51:48 -04001031 .to_initval = maxtime,
J. Bruce Fields595947a2009-03-05 17:18:10 -05001032 .to_retries = 0,
Jeff Layton3758cf72014-04-15 08:51:48 -04001033 .to_maxval = maxtime,
Chuck Leverae5c7942006-08-22 20:06:21 -04001034 };
Chuck Leverae5c7942006-08-22 20:06:21 -04001035 struct rpc_create_args args = {
Stanislav Kinsburskyc212cec2012-11-14 18:21:10 +03001036 .net = clp->net,
J. Bruce Fields07263f12010-05-31 19:09:40 -04001037 .address = (struct sockaddr *) &conn->cb_addr,
1038 .addrsize = conn->cb_addrlen,
Takuma Umeya6f3d7722010-12-15 14:09:01 +09001039 .saddress = (struct sockaddr *) &conn->cb_saddr,
Chuck Leverae5c7942006-08-22 20:06:21 -04001040 .timeout = &timeparms,
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -04001041 .program = &cb_program,
Trond Myklebusteff79362017-07-16 22:57:27 +00001042 .version = 1,
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001043 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
Trond Myklebust79caa5f2019-04-24 17:46:42 -04001044 .cred = current_cred(),
Chuck Leverae5c7942006-08-22 20:06:21 -04001045 };
J. Bruce Fields63c86712007-10-25 19:00:26 -04001046 struct rpc_clnt *client;
NeilBrowna52458b2018-12-03 11:30:31 +11001047 const struct cred *cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -04001049 if (clp->cl_minorversion == 0) {
J. Bruce Fields03a4e1f2012-05-14 19:55:22 -04001050 if (!clp->cl_cred.cr_principal &&
Chuck Lever1eace0d2020-04-05 14:15:29 -04001051 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5)) {
1052 trace_nfsd_cb_setup_err(clp, -EINVAL);
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -04001053 return -EINVAL;
Chuck Lever1eace0d2020-04-05 14:15:29 -04001054 }
J. Bruce Fields03a4e1f2012-05-14 19:55:22 -04001055 args.client_name = clp->cl_cred.cr_principal;
Himangi Saraogifc8e5a62014-07-23 20:12:31 +05301056 args.prognumber = conn->cb_prog;
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -04001057 args.protocol = XPRT_TRANSPORT_TCP;
J. Bruce Fields39307652012-08-16 17:01:21 -04001058 args.authflavor = clp->cl_cred.cr_flavor;
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -04001059 clp->cl_cb_ident = conn->cb_ident;
1060 } else {
Chuck Lever9f57c602021-05-14 15:56:56 -04001061 if (!conn->cb_xprt)
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001062 return -EINVAL;
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001063 clp->cl_cb_session = ses;
J. Bruce Fields07263f12010-05-31 19:09:40 -04001064 args.bc_xprt = conn->cb_xprt;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -04001065 args.prognumber = clp->cl_cb_session->se_cb_prog;
Chuck Lever3c45ddf2014-07-16 15:38:32 -04001066 args.protocol = conn->cb_xprt->xpt_class->xcl_ident |
1067 XPRT_TRANSPORT_BC;
J. Bruce Fields12fc3e92012-11-05 16:01:48 -05001068 args.authflavor = ses->se_cb_sec.flavor;
Alexandros Batsakis3ddc8bf2009-09-10 12:27:21 +03001069 }
Chuck Leverae5c7942006-08-22 20:06:21 -04001070 /* Create RPC client */
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -04001071 client = rpc_create(&args);
J. Bruce Fieldse1cab5a52009-02-23 10:45:27 -08001072 if (IS_ERR(client)) {
Chuck Lever1eace0d2020-04-05 14:15:29 -04001073 trace_nfsd_cb_setup_err(clp, PTR_ERR(client));
J. Bruce Fieldse1cab5a52009-02-23 10:45:27 -08001074 return PTR_ERR(client);
1075 }
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001076 cred = get_backchannel_cred(clp, client, ses);
Dan Carpenter1c3da442019-01-04 09:47:03 +03001077 if (!cred) {
Chuck Lever1eace0d2020-04-05 14:15:29 -04001078 trace_nfsd_cb_setup_err(clp, -ENOMEM);
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001079 rpc_shutdown_client(client);
Dan Carpenter1c3da442019-01-04 09:47:03 +03001080 return -ENOMEM;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001081 }
Dan Aloni3bc8edc2022-12-12 13:11:06 +02001082
1083 if (clp->cl_minorversion != 0)
1084 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001085 clp->cl_cb_client = client;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001086 clp->cl_cb_cred = cred;
J. Bruce Fields05570a22021-06-14 11:20:49 -04001087 rcu_read_lock();
Chuck Lever3c92fba2021-05-14 15:57:02 -04001088 trace_nfsd_cb_setup(clp, rpc_peeraddr2str(client, RPC_DISPLAY_NETID),
1089 args.authflavor);
J. Bruce Fields05570a22021-06-14 11:20:49 -04001090 rcu_read_unlock();
J. Bruce Fieldse1cab5a52009-02-23 10:45:27 -08001091 return 0;
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -08001092}
1093
Chuck Lever8476c692021-05-14 15:56:31 -04001094static void nfsd4_mark_cb_state(struct nfs4_client *clp, int newstate)
1095{
1096 if (clp->cl_cb_state != newstate) {
1097 clp->cl_cb_state = newstate;
Chuck Levera7cdf062024-01-26 12:45:54 -05001098 trace_nfsd_cb_new_state(clp);
Chuck Lever8476c692021-05-14 15:56:31 -04001099 }
1100}
1101
Chuck Lever627fb182024-01-26 12:46:13 -05001102static void nfsd4_mark_cb_down(struct nfs4_client *clp)
J. Bruce Fields77a35692010-04-30 18:51:44 -04001103{
J. Bruce Fieldsd4f72cb2015-11-24 15:43:03 -07001104 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
1105 return;
Chuck Lever8476c692021-05-14 15:56:31 -04001106 nfsd4_mark_cb_state(clp, NFSD4_CB_DOWN);
J. Bruce Fields77a35692010-04-30 18:51:44 -04001107}
1108
Chuck Lever627fb182024-01-26 12:46:13 -05001109static void nfsd4_mark_cb_fault(struct nfs4_client *clp)
Benny Halevy54237322011-10-19 19:12:58 -07001110{
J. Bruce Fieldsd4f72cb2015-11-24 15:43:03 -07001111 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
1112 return;
Chuck Lever8476c692021-05-14 15:56:31 -04001113 nfsd4_mark_cb_state(clp, NFSD4_CB_FAULT);
Benny Halevy54237322011-10-19 19:12:58 -07001114}
1115
J. Bruce Fieldse300a632009-03-05 15:01:11 -05001116static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
1117{
J. Bruce Fieldscee277d2010-05-26 17:52:14 -04001118 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
J. Bruce Fieldse300a632009-03-05 15:01:11 -05001119
1120 if (task->tk_status)
Chuck Lever627fb182024-01-26 12:46:13 -05001121 nfsd4_mark_cb_down(clp);
Chuck Lever8476c692021-05-14 15:56:31 -04001122 else
1123 nfsd4_mark_cb_state(clp, NFSD4_CB_UP);
J. Bruce Fieldse300a632009-03-05 15:01:11 -05001124}
1125
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001126static void nfsd4_cb_probe_release(void *calldata)
1127{
1128 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
1129
1130 nfsd41_cb_inflight_end(clp);
1131
1132}
1133
J. Bruce Fieldse300a632009-03-05 15:01:11 -05001134static const struct rpc_call_ops nfsd4_cb_probe_ops = {
J. Bruce Fieldscee277d2010-05-26 17:52:14 -04001135 /* XXX: release method to ensure we set the cb channel down if
1136 * necessary on early failure? */
J. Bruce Fieldse300a632009-03-05 15:01:11 -05001137 .rpc_call_done = nfsd4_cb_probe_done,
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001138 .rpc_release = nfsd4_cb_probe_release,
J. Bruce Fieldse300a632009-03-05 15:01:11 -05001139};
1140
J. Bruce Fields63c86712007-10-25 19:00:26 -04001141/*
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -04001142 * Poke the callback thread to process any updates to the callback
1143 * parameters, and send a null probe.
J. Bruce Fields63c86712007-10-25 19:00:26 -04001144 */
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -04001145void nfsd4_probe_callback(struct nfs4_client *clp)
1146{
Chuck Lever4ade8922021-05-14 15:57:26 -04001147 trace_nfsd_cb_probe(clp);
Chuck Lever8476c692021-05-14 15:56:31 -04001148 nfsd4_mark_cb_state(clp, NFSD4_CB_UNKNOWN);
Jeff Laytona52d7262012-03-21 09:52:02 -04001149 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001150 nfsd4_run_cb(&clp->cl_cb_null);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -04001151}
1152
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -05001153void nfsd4_probe_callback_sync(struct nfs4_client *clp)
1154{
1155 nfsd4_probe_callback(clp);
Chuck Lever38f080f2024-04-01 16:05:39 -04001156 flush_workqueue(clp->cl_callback_wq);
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -05001157}
1158
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -04001159void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
J. Bruce Fields63c86712007-10-25 19:00:26 -04001160{
Chuck Lever8476c692021-05-14 15:56:31 -04001161 nfsd4_mark_cb_state(clp, NFSD4_CB_UNKNOWN);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001162 spin_lock(&clp->cl_lock);
1163 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001164 spin_unlock(&clp->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165}
1166
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001167/*
1168 * There's currently a single callback channel slot.
1169 * If the slot is available, then mark it busy. Otherwise, set the
1170 * thread for sleeping on the callback RPC wait queue.
1171 */
Trond Myklebust12357f12019-11-07 17:11:57 -05001172static bool nfsd41_cb_get_slot(struct nfsd4_callback *cb, struct rpc_task *task)
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001173{
Trond Myklebust12357f12019-11-07 17:11:57 -05001174 struct nfs4_client *clp = cb->cb_clp;
1175
1176 if (!cb->cb_holds_slot &&
1177 test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001178 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
Trond Myklebustc6c15e12014-11-19 12:47:50 -05001179 /* Race breaker */
1180 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
1181 dprintk("%s slot is busy\n", __func__);
1182 return false;
1183 }
1184 rpc_wake_up_queued_task(&clp->cl_cb_waitq, task);
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001185 }
Trond Myklebust12357f12019-11-07 17:11:57 -05001186 cb->cb_holds_slot = true;
J. Bruce Fields3ff36002011-01-10 16:37:51 -05001187 return true;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001188}
1189
Trond Myklebust12357f12019-11-07 17:11:57 -05001190static void nfsd41_cb_release_slot(struct nfsd4_callback *cb)
1191{
1192 struct nfs4_client *clp = cb->cb_clp;
1193
1194 if (cb->cb_holds_slot) {
1195 cb->cb_holds_slot = false;
1196 clear_bit(0, &clp->cl_cb_slot_busy);
1197 rpc_wake_up_next(&clp->cl_cb_waitq);
1198 }
1199}
1200
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001201static void nfsd41_destroy_cb(struct nfsd4_callback *cb)
1202{
1203 struct nfs4_client *clp = cb->cb_clp;
1204
Chuck Lever9a026ae2024-01-26 12:46:01 -05001205 trace_nfsd_cb_destroy(clp, cb);
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001206 nfsd41_cb_release_slot(cb);
1207 if (cb->cb_ops && cb->cb_ops->release)
1208 cb->cb_ops->release(cb);
1209 nfsd41_cb_inflight_end(clp);
1210}
1211
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001212/*
1213 * TODO: cb_sequence should support referring call lists, cachethis, multiple
1214 * slots, and mark callback channel down on communication errors.
1215 */
1216static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
1217{
J. Bruce Fields58784532010-05-16 16:47:08 -04001218 struct nfsd4_callback *cb = calldata;
J. Bruce Fields8be2d232013-03-21 10:59:29 -04001219 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fields8323c3b2010-10-19 19:36:51 -04001220 u32 minorversion = clp->cl_minorversion;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001221
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001222 /*
1223 * cb_seq_status is only set in decode_cb_sequence4res,
1224 * and so will remain 1 if an rpc level failure occurs.
1225 */
1226 cb->cb_seq_status = 1;
Kinglong Mee43993962015-06-02 18:59:19 +08001227 cb->cb_status = 0;
Trond Myklebust12357f12019-11-07 17:11:57 -05001228 if (minorversion && !nfsd41_cb_get_slot(cb, task))
1229 return;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001230 rpc_call_start(task);
1231}
1232
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001233static bool nfsd4_cb_sequence_done(struct rpc_task *task, struct nfsd4_callback *cb)
1234{
1235 struct nfs4_client *clp = cb->cb_clp;
1236 struct nfsd4_session *session = clp->cl_cb_session;
1237 bool ret = true;
1238
1239 if (!clp->cl_minorversion) {
1240 /*
1241 * If the backchannel connection was shut down while this
1242 * task was queued, we need to resubmit it after setting up
1243 * a new backchannel connection.
1244 *
1245 * Note that if we lost our callback connection permanently
1246 * the submission code will error out, so we don't need to
1247 * handle that case here.
1248 */
Trond Myklebustae67bd32019-04-07 13:58:44 -04001249 if (RPC_SIGNALLED(task))
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001250 goto need_restart;
1251
1252 return true;
1253 }
1254
Trond Myklebuste6abc8c2019-04-05 08:54:37 -07001255 if (!cb->cb_holds_slot)
1256 goto need_restart;
1257
Chuck Lever86266642024-01-26 12:45:48 -05001258 /* This is the operation status code for CB_SEQUENCE */
1259 trace_nfsd_cb_seq_status(task, cb);
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001260 switch (cb->cb_seq_status) {
1261 case 0:
1262 /*
1263 * No need for lock, access serialized in nfsd4_cb_prepare
1264 *
1265 * RFC5661 20.9.3
1266 * If CB_SEQUENCE returns an error, then the state of the slot
1267 * (sequence ID, cached reply) MUST NOT change.
1268 */
1269 ++session->se_cb_seq_nr;
1270 break;
1271 case -ESERVERFAULT:
1272 ++session->se_cb_seq_nr;
Chuck Lever627fb182024-01-26 12:46:13 -05001273 nfsd4_mark_cb_fault(cb->cb_clp);
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001274 ret = false;
1275 break;
Chuck Lever43b02db2024-01-26 12:45:36 -05001276 case 1:
1277 /*
1278 * cb_seq_status remains 1 if an RPC Reply was never
1279 * received. NFSD can't know if the client processed
1280 * the CB_SEQUENCE operation. Ask the client to send a
1281 * DESTROY_SESSION to recover.
1282 */
1283 fallthrough;
1284 case -NFS4ERR_BADSESSION:
Chuck Lever627fb182024-01-26 12:46:13 -05001285 nfsd4_mark_cb_fault(cb->cb_clp);
Chuck Lever43b02db2024-01-26 12:45:36 -05001286 ret = false;
1287 goto need_restart;
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001288 case -NFS4ERR_DELAY:
Chuck Lever961b4b52024-01-26 12:45:17 -05001289 cb->cb_seq_status = 1;
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001290 if (!rpc_restart_call(task))
1291 goto out;
1292
1293 rpc_delay(task, 2 * HZ);
1294 return false;
1295 case -NFS4ERR_BADSLOT:
1296 goto retry_nowait;
1297 case -NFS4ERR_SEQ_MISORDERED:
1298 if (session->se_cb_seq_nr != 1) {
1299 session->se_cb_seq_nr = 1;
1300 goto retry_nowait;
1301 }
1302 break;
1303 default:
Chuck Lever627fb182024-01-26 12:46:13 -05001304 nfsd4_mark_cb_fault(cb->cb_clp);
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001305 }
Trond Myklebust12357f12019-11-07 17:11:57 -05001306 nfsd41_cb_release_slot(cb);
Chuck Lever86266642024-01-26 12:45:48 -05001307
1308 trace_nfsd_cb_free_slot(task, cb);
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001309
Trond Myklebustae67bd32019-04-07 13:58:44 -04001310 if (RPC_SIGNALLED(task))
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001311 goto need_restart;
1312out:
1313 return ret;
1314retry_nowait:
1315 if (rpc_restart_call_prepare(task))
1316 ret = false;
1317 goto out;
1318need_restart:
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001319 if (!test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags)) {
Chuck Lever9a026ae2024-01-26 12:46:01 -05001320 trace_nfsd_cb_restart(clp, cb);
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001321 task->tk_status = 0;
1322 cb->cb_need_restart = true;
1323 }
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001324 return false;
1325}
1326
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +03001327static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
1328{
J. Bruce Fields58784532010-05-16 16:47:08 -04001329 struct nfsd4_callback *cb = calldata;
J. Bruce Fields8be2d232013-03-21 10:59:29 -04001330 struct nfs4_client *clp = cb->cb_clp;
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +03001331
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001332 if (!nfsd4_cb_sequence_done(task, cb))
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -05001333 return;
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -05001334
Christoph Hellwigef2a1b32015-04-30 11:49:23 +02001335 if (cb->cb_status) {
1336 WARN_ON_ONCE(task->tk_status);
1337 task->tk_status = cb->cb_status;
1338 }
1339
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001340 switch (cb->cb_ops->done(cb, task)) {
J. Bruce Fields172c85d2010-05-30 11:53:12 -04001341 case 0:
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001342 task->tk_status = 0;
1343 rpc_restart_call_prepare(task);
1344 return;
1345 case 1:
Scott Mayhew1c73b9d2019-05-02 13:32:12 -04001346 switch (task->tk_status) {
1347 case -EIO:
1348 case -ETIMEDOUT:
Olga Kornievskaiab4250dd2021-03-11 10:55:00 -05001349 case -EACCES:
Chuck Lever627fb182024-01-26 12:46:13 -05001350 nfsd4_mark_cb_down(clp);
Scott Mayhew1c73b9d2019-05-02 13:32:12 -04001351 }
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001352 break;
1353 default:
1354 BUG();
J. Bruce Fields63e48632009-05-01 22:36:55 -04001355 }
J. Bruce Fields63e48632009-05-01 22:36:55 -04001356}
1357
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001358static void nfsd4_cb_release(void *calldata)
J. Bruce Fields63e48632009-05-01 22:36:55 -04001359{
J. Bruce Fields58784532010-05-16 16:47:08 -04001360 struct nfsd4_callback *cb = calldata;
J. Bruce Fields63e48632009-05-01 22:36:55 -04001361
Christoph Hellwigcba5f622015-04-30 11:49:24 +02001362 if (cb->cb_need_restart)
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001363 nfsd4_queue_cb(cb);
Christoph Hellwigcba5f622015-04-30 11:49:24 +02001364 else
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001365 nfsd41_destroy_cb(cb);
Christoph Hellwigcba5f622015-04-30 11:49:24 +02001366
J. Bruce Fields63e48632009-05-01 22:36:55 -04001367}
1368
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001369static const struct rpc_call_ops nfsd4_cb_ops = {
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001370 .rpc_call_prepare = nfsd4_cb_prepare,
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001371 .rpc_call_done = nfsd4_cb_done,
1372 .rpc_release = nfsd4_cb_release,
J. Bruce Fields63e48632009-05-01 22:36:55 -04001373};
1374
Benny Halevyab707e152010-05-12 00:14:06 +03001375/* must be called under the state lock */
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001376void nfsd4_shutdown_callback(struct nfs4_client *clp)
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001377{
Chuck Leverb200f0e2021-05-14 15:56:49 -04001378 if (clp->cl_cb_state != NFSD4_CB_UNKNOWN)
1379 trace_nfsd_cb_shutdown(clp);
1380
Jeff Laytona52d7262012-03-21 09:52:02 -04001381 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001382 /*
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001383 * Note this won't actually result in a null callback;
Jeff Layton02e12152014-07-16 10:31:57 -04001384 * instead, nfsd4_run_cb_null() will detect the killed
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001385 * client, destroy the rpc client, and stop:
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001386 */
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001387 nfsd4_run_cb(&clp->cl_cb_null);
Chuck Lever38f080f2024-04-01 16:05:39 -04001388 flush_workqueue(clp->cl_callback_wq);
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001389 nfsd41_cb_inflight_wait_complete(clp);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001390}
1391
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001392static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
1393{
1394 struct nfsd4_session *s;
1395 struct nfsd4_conn *c;
1396
Chuck Lever112bdd52024-01-26 12:46:20 -05001397 lockdep_assert_held(&clp->cl_lock);
1398
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001399 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
1400 list_for_each_entry(c, &s->se_conns, cn_persession) {
1401 if (c->cn_flags & NFS4_CDFC4_BACK)
1402 return c;
1403 }
1404 }
1405 return NULL;
1406}
1407
J. Bruce Fieldscc1ce2f2019-10-29 16:02:18 -04001408/*
1409 * Note there isn't a lot of locking in this code; instead we depend on
Chuck Lever38f080f2024-04-01 16:05:39 -04001410 * the fact that it is run from clp->cl_callback_wq, which won't run two
1411 * work items at once. So, for example, clp->cl_callback_wq handles all
1412 * access of cl_cb_client and all calls to rpc_create or rpc_shutdown_client.
J. Bruce Fieldscc1ce2f2019-10-29 16:02:18 -04001413 */
Kirill A. Shutemov65e4c892010-12-16 15:25:54 +02001414static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001415{
1416 struct nfs4_cb_conn conn;
1417 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001418 struct nfsd4_session *ses = NULL;
1419 struct nfsd4_conn *c;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001420 int err;
1421
Chuck Lever9a026ae2024-01-26 12:46:01 -05001422 trace_nfsd_cb_bc_update(clp, cb);
1423
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001424 /*
1425 * This is either an update, or the client dying; in either case,
1426 * kill the old client:
1427 */
1428 if (clp->cl_cb_client) {
Chuck Lever9a026ae2024-01-26 12:46:01 -05001429 trace_nfsd_cb_bc_shutdown(clp, cb);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001430 rpc_shutdown_client(clp->cl_cb_client);
1431 clp->cl_cb_client = NULL;
NeilBrowna52458b2018-12-03 11:30:31 +11001432 put_cred(clp->cl_cb_cred);
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001433 clp->cl_cb_cred = NULL;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001434 }
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001435 if (clp->cl_cb_conn.cb_xprt) {
1436 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
1437 clp->cl_cb_conn.cb_xprt = NULL;
1438 }
Jeff Laytona52d7262012-03-21 09:52:02 -04001439 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001440 return;
Chuck Lever9a026ae2024-01-26 12:46:01 -05001441
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001442 spin_lock(&clp->cl_lock);
1443 /*
1444 * Only serialized callback code is allowed to clear these
1445 * flags; main nfsd code can only set them:
1446 */
Chuck Lever84ebf022024-01-26 12:46:26 -05001447 WARN_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
Jeff Laytona52d7262012-03-21 09:52:02 -04001448 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
Chuck Lever84ebf022024-01-26 12:46:26 -05001449
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001450 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001451 c = __nfsd4_find_backchannel(clp);
1452 if (c) {
1453 svc_xprt_get(c->cn_xprt);
1454 conn.cb_xprt = c->cn_xprt;
1455 ses = c->cn_session;
1456 }
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001457 spin_unlock(&clp->cl_lock);
1458
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001459 err = setup_callback_client(clp, &conn, ses);
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001460 if (err) {
Chuck Lever627fb182024-01-26 12:46:13 -05001461 nfsd4_mark_cb_down(clp);
Xiyu Yanga4abc6b2020-05-25 22:15:41 +08001462 if (c)
1463 svc_xprt_put(c->cn_xprt);
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001464 return;
1465 }
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001466}
1467
Jeff Layton02e12152014-07-16 10:31:57 -04001468static void
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001469nfsd4_run_cb_work(struct work_struct *work)
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001470{
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001471 struct nfsd4_callback *cb =
Chuck Lever8ddb7142024-04-23 17:52:24 -04001472 container_of(work, struct nfsd4_callback, cb_work);
J. Bruce Fieldsfb003922010-05-31 18:21:37 -04001473 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001474 struct rpc_clnt *clnt;
Chuck Lever6221f1d2020-04-17 12:40:31 -04001475 int flags;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001476
Chuck Levera7cdf062024-01-26 12:45:54 -05001477 trace_nfsd_cb_start(clp);
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001478
Jeff Laytona52d7262012-03-21 09:52:02 -04001479 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001480 nfsd4_process_cb_update(cb);
1481
1482 clnt = clp->cl_cb_client;
1483 if (!clnt) {
Chuck Lever9c8ecb92024-04-23 17:48:43 -04001484 /* Callback channel broken, or client killed; give up: */
1485 nfsd41_destroy_cb(cb);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001486 return;
J. Bruce Fields58784532010-05-16 16:47:08 -04001487 }
Christoph Hellwig4bd9e9b2015-04-30 11:49:25 +02001488
1489 /*
1490 * Don't send probe messages for 4.1 or later.
1491 */
1492 if (!cb->cb_ops && clp->cl_minorversion) {
Chuck Lever8476c692021-05-14 15:56:31 -04001493 nfsd4_mark_cb_state(clp, NFSD4_CB_UP);
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001494 nfsd41_destroy_cb(cb);
Christoph Hellwig4bd9e9b2015-04-30 11:49:25 +02001495 return;
1496 }
1497
Chuck Leverc1ccfcf2024-01-26 12:45:29 -05001498 if (cb->cb_need_restart) {
1499 cb->cb_need_restart = false;
1500 } else {
1501 if (cb->cb_ops && cb->cb_ops->prepare)
1502 cb->cb_ops->prepare(cb);
1503 }
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001504 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
Chuck Lever6221f1d2020-04-17 12:40:31 -04001505 flags = clp->cl_minorversion ? RPC_TASK_NOCONNECT : RPC_TASK_SOFTCONN;
1506 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | flags,
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001507 cb->cb_ops ? &nfsd4_cb_ops : &nfsd4_cb_probe_ops, cb);
Jeff Layton02e12152014-07-16 10:31:57 -04001508}
1509
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001510void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
Julia Lawallc4cb8972015-11-21 22:57:39 +01001511 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op)
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001512{
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001513 cb->cb_clp = clp;
Christoph Hellwig326129d2014-09-24 12:19:17 +02001514 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[op];
J. Bruce Fieldsfb003922010-05-31 18:21:37 -04001515 cb->cb_msg.rpc_argp = cb;
1516 cb->cb_msg.rpc_resp = cb;
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001517 cb->cb_ops = ops;
Chuck Lever8ddb7142024-04-23 17:52:24 -04001518 INIT_WORK(&cb->cb_work, nfsd4_run_cb_work);
Christoph Hellwigef2a1b32015-04-30 11:49:23 +02001519 cb->cb_status = 0;
Christoph Hellwigcba5f622015-04-30 11:49:24 +02001520 cb->cb_need_restart = false;
Trond Myklebuste6abc8c2019-04-05 08:54:37 -07001521 cb->cb_holds_slot = false;
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001522}
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001523
Jeff Laytonb95239c2022-09-26 14:41:01 -04001524/**
1525 * nfsd4_run_cb - queue up a callback job to run
1526 * @cb: callback to queue
1527 *
1528 * Kick off a callback to do its thing. Returns false if it was already
1529 * on a queue, true otherwise.
1530 */
1531bool nfsd4_run_cb(struct nfsd4_callback *cb)
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001532{
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001533 struct nfs4_client *clp = cb->cb_clp;
Jeff Laytonb95239c2022-09-26 14:41:01 -04001534 bool queued;
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001535
1536 nfsd41_cb_inflight_begin(clp);
Jeff Laytonb95239c2022-09-26 14:41:01 -04001537 queued = nfsd4_queue_cb(cb);
1538 if (!queued)
Trond Myklebust2bbfed92019-10-23 17:43:18 -04001539 nfsd41_cb_inflight_end(clp);
Jeff Laytonb95239c2022-09-26 14:41:01 -04001540 return queued;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001541}