blob: 7389cb1d7409cf16c31b041d88ae59cbe09d5322 [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/sunrpc/clnt.h>
Kinglong Meed531c002014-03-24 11:59:46 +080035#include <linux/sunrpc/xprt.h>
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -050036#include <linux/sunrpc/svc_xprt.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090037#include <linux/slab.h>
Boaz Harrosh9a74af22009-12-03 20:30:56 +020038#include "nfsd.h"
39#include "state.h"
Stanislav Kinsbursky3d733712012-11-27 14:11:44 +030040#include "netns.h"
J. Bruce Fields06b332a2013-04-09 11:34:36 -040041#include "xdr4cb.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43#define NFSDDBG_FACILITY NFSDDBG_PROC
44
Benny Halevy54237322011-10-19 19:12:58 -070045static void nfsd4_mark_cb_fault(struct nfs4_client *, int reason);
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define NFSPROC4_CB_NULL 0
48#define NFSPROC4_CB_COMPOUND 1
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/* Index of predefined Linux callback client operations */
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct nfs4_cb_compound_hdr {
Andy Adamson38524ab2009-09-10 12:25:59 +030053 /* args */
54 u32 ident; /* minorversion 0 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 u32 nops;
Andy Adamsonef52bff2009-06-16 04:20:50 +030056 __be32 *nops_p;
Andy Adamsonab52ae62009-06-16 04:20:53 +030057 u32 minorversion;
Andy Adamson38524ab2009-09-10 12:25:59 +030058 /* res */
59 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060};
61
Chuck Lever85a56482010-12-14 14:57:32 +000062/*
63 * Handle decode buffer overflows out-of-line.
64 */
65static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066{
Chuck Lever85a56482010-12-14 14:57:32 +000067 dprintk("NFS: %s prematurely hit the end of our receive buffer. "
68 "Remaining buffer length is %tu words.\n",
69 func, xdr->end - xdr->p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070}
71
Chuck Levera033db42010-12-14 14:57:22 +000072static __be32 *xdr_encode_empty_array(__be32 *p)
73{
74 *p++ = xdr_zero;
75 return p;
76}
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078/*
Chuck Levera033db42010-12-14 14:57:22 +000079 * Encode/decode NFSv4 CB basic data types
80 *
81 * Basic NFSv4 callback data types are defined in section 15 of RFC
82 * 3530: "Network File System (NFS) version 4 Protocol" and section
83 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
84 * 1 Protocol"
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 */
86
Chuck Levera033db42010-12-14 14:57:22 +000087/*
88 * nfs_cb_opnum4
89 *
90 * enum nfs_cb_opnum4 {
91 * OP_CB_GETATTR = 3,
92 * ...
93 * };
94 */
95enum nfs_cb_opnum4 {
96 OP_CB_GETATTR = 3,
97 OP_CB_RECALL = 4,
98 OP_CB_LAYOUTRECALL = 5,
99 OP_CB_NOTIFY = 6,
100 OP_CB_PUSH_DELEG = 7,
101 OP_CB_RECALL_ANY = 8,
102 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
103 OP_CB_RECALL_SLOT = 10,
104 OP_CB_SEQUENCE = 11,
105 OP_CB_WANTS_CANCELLED = 12,
106 OP_CB_NOTIFY_LOCK = 13,
107 OP_CB_NOTIFY_DEVICEID = 14,
108 OP_CB_ILLEGAL = 10044
109};
110
111static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
Benny Halevy9303bbd2010-05-25 09:50:23 +0300112{
113 __be32 *p;
114
Chuck Levera033db42010-12-14 14:57:22 +0000115 p = xdr_reserve_space(xdr, 4);
116 *p = cpu_to_be32(op);
Benny Halevy9303bbd2010-05-25 09:50:23 +0300117}
118
Chuck Levera033db42010-12-14 14:57:22 +0000119/*
120 * nfs_fh4
121 *
122 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
123 */
124static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
125{
126 u32 length = fh->fh_size;
127 __be32 *p;
128
129 BUG_ON(length > NFS4_FHSIZE);
130 p = xdr_reserve_space(xdr, 4 + length);
131 xdr_encode_opaque(p, &fh->fh_base, length);
132}
133
134/*
135 * stateid4
136 *
137 * struct stateid4 {
138 * uint32_t seqid;
139 * opaque other[12];
140 * };
141 */
142static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
143{
144 __be32 *p;
145
146 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
147 *p++ = cpu_to_be32(sid->si_generation);
148 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
149}
150
151/*
152 * sessionid4
153 *
154 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
155 */
156static void encode_sessionid4(struct xdr_stream *xdr,
157 const struct nfsd4_session *session)
158{
159 __be32 *p;
160
161 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
162 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
163 NFS4_MAX_SESSIONID_LEN);
164}
165
166/*
Chuck Lever85a56482010-12-14 14:57:32 +0000167 * nfsstat4
168 */
169static const struct {
170 int stat;
171 int errno;
172} nfs_cb_errtbl[] = {
173 { NFS4_OK, 0 },
174 { NFS4ERR_PERM, -EPERM },
175 { NFS4ERR_NOENT, -ENOENT },
176 { NFS4ERR_IO, -EIO },
177 { NFS4ERR_NXIO, -ENXIO },
178 { NFS4ERR_ACCESS, -EACCES },
179 { NFS4ERR_EXIST, -EEXIST },
180 { NFS4ERR_XDEV, -EXDEV },
181 { NFS4ERR_NOTDIR, -ENOTDIR },
182 { NFS4ERR_ISDIR, -EISDIR },
183 { NFS4ERR_INVAL, -EINVAL },
184 { NFS4ERR_FBIG, -EFBIG },
185 { NFS4ERR_NOSPC, -ENOSPC },
186 { NFS4ERR_ROFS, -EROFS },
187 { NFS4ERR_MLINK, -EMLINK },
188 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
189 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
190 { NFS4ERR_DQUOT, -EDQUOT },
191 { NFS4ERR_STALE, -ESTALE },
192 { NFS4ERR_BADHANDLE, -EBADHANDLE },
193 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
194 { NFS4ERR_NOTSUPP, -ENOTSUPP },
195 { NFS4ERR_TOOSMALL, -ETOOSMALL },
196 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
197 { NFS4ERR_BADTYPE, -EBADTYPE },
198 { NFS4ERR_LOCKED, -EAGAIN },
199 { NFS4ERR_RESOURCE, -EREMOTEIO },
200 { NFS4ERR_SYMLINK, -ELOOP },
201 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
202 { NFS4ERR_DEADLOCK, -EDEADLK },
203 { -1, -EIO }
204};
205
206/*
207 * If we cannot translate the error, the recovery routines should
208 * handle it.
209 *
210 * Note: remaining NFSv4 error codes have values > 10000, so should
211 * not conflict with native Linux error codes.
212 */
213static int nfs_cb_stat_to_errno(int status)
214{
215 int i;
216
217 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
218 if (nfs_cb_errtbl[i].stat == status)
219 return nfs_cb_errtbl[i].errno;
220 }
221
222 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
223 return -status;
224}
225
226static int decode_cb_op_status(struct xdr_stream *xdr, enum nfs_opnum4 expected,
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200227 int *status)
Chuck Lever85a56482010-12-14 14:57:32 +0000228{
229 __be32 *p;
230 u32 op;
231
232 p = xdr_inline_decode(xdr, 4 + 4);
233 if (unlikely(p == NULL))
234 goto out_overflow;
235 op = be32_to_cpup(p++);
236 if (unlikely(op != expected))
237 goto out_unexpected;
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200238 *status = nfs_cb_stat_to_errno(be32_to_cpup(p));
Chuck Lever85a56482010-12-14 14:57:32 +0000239 return 0;
240out_overflow:
241 print_overflow_msg(__func__, xdr);
242 return -EIO;
243out_unexpected:
244 dprintk("NFSD: Callback server returned operation %d but "
245 "we issued a request for %d\n", op, expected);
246 return -EIO;
247}
248
249/*
Chuck Levera033db42010-12-14 14:57:22 +0000250 * CB_COMPOUND4args
251 *
252 * struct CB_COMPOUND4args {
253 * utf8str_cs tag;
254 * uint32_t minorversion;
255 * uint32_t callback_ident;
256 * nfs_cb_argop4 argarray<>;
257 * };
258*/
259static void encode_cb_compound4args(struct xdr_stream *xdr,
260 struct nfs4_cb_compound_hdr *hdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
Al Virof00f3282006-10-19 23:29:01 -0700262 __be32 * p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Chuck Levera033db42010-12-14 14:57:22 +0000264 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
265 p = xdr_encode_empty_array(p); /* empty tag */
266 *p++ = cpu_to_be32(hdr->minorversion);
267 *p++ = cpu_to_be32(hdr->ident);
268
Andy Adamsonef52bff2009-06-16 04:20:50 +0300269 hdr->nops_p = p;
Chuck Levera033db42010-12-14 14:57:22 +0000270 *p = cpu_to_be32(hdr->nops); /* argarray element count */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271}
272
Chuck Levera033db42010-12-14 14:57:22 +0000273/*
274 * Update argarray element count
275 */
Andy Adamsonef52bff2009-06-16 04:20:50 +0300276static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
277{
Chuck Levera033db42010-12-14 14:57:22 +0000278 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
279 *hdr->nops_p = cpu_to_be32(hdr->nops);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300280}
281
Chuck Levera033db42010-12-14 14:57:22 +0000282/*
Chuck Lever85a56482010-12-14 14:57:32 +0000283 * CB_COMPOUND4res
284 *
285 * struct CB_COMPOUND4res {
286 * nfsstat4 status;
287 * utf8str_cs tag;
288 * nfs_cb_resop4 resarray<>;
289 * };
290 */
291static int decode_cb_compound4res(struct xdr_stream *xdr,
292 struct nfs4_cb_compound_hdr *hdr)
293{
294 u32 length;
295 __be32 *p;
296
297 p = xdr_inline_decode(xdr, 4 + 4);
298 if (unlikely(p == NULL))
299 goto out_overflow;
300 hdr->status = be32_to_cpup(p++);
301 /* Ignore the tag */
302 length = be32_to_cpup(p++);
303 p = xdr_inline_decode(xdr, length + 4);
304 if (unlikely(p == NULL))
305 goto out_overflow;
306 hdr->nops = be32_to_cpup(p);
307 return 0;
308out_overflow:
309 print_overflow_msg(__func__, xdr);
310 return -EIO;
311}
312
313/*
Chuck Levera033db42010-12-14 14:57:22 +0000314 * CB_RECALL4args
315 *
316 * struct CB_RECALL4args {
317 * stateid4 stateid;
318 * bool truncate;
319 * nfs_fh4 fh;
320 * };
321 */
322static void encode_cb_recall4args(struct xdr_stream *xdr,
323 const struct nfs4_delegation *dp,
324 struct nfs4_cb_compound_hdr *hdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325{
Al Virof00f3282006-10-19 23:29:01 -0700326 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Chuck Levera033db42010-12-14 14:57:22 +0000328 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -0400329 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
Chuck Levera033db42010-12-14 14:57:22 +0000330
331 p = xdr_reserve_space(xdr, 4);
332 *p++ = xdr_zero; /* truncate */
333
Trond Myklebust11b91642014-07-29 21:34:08 -0400334 encode_nfs_fh4(xdr, &dp->dl_stid.sc_file->fi_fhandle);
Chuck Levera033db42010-12-14 14:57:22 +0000335
Andy Adamsonef52bff2009-06-16 04:20:50 +0300336 hdr->nops++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337}
338
Chuck Levera033db42010-12-14 14:57:22 +0000339/*
340 * CB_SEQUENCE4args
341 *
342 * struct CB_SEQUENCE4args {
343 * sessionid4 csa_sessionid;
344 * sequenceid4 csa_sequenceid;
345 * slotid4 csa_slotid;
346 * slotid4 csa_highest_slotid;
347 * bool csa_cachethis;
348 * referring_call_list4 csa_referring_call_lists<>;
349 * };
350 */
351static void encode_cb_sequence4args(struct xdr_stream *xdr,
352 const struct nfsd4_callback *cb,
353 struct nfs4_cb_compound_hdr *hdr)
Benny Halevy2af73582009-09-10 12:26:51 +0300354{
Chuck Levera033db42010-12-14 14:57:22 +0000355 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
Benny Halevy2af73582009-09-10 12:26:51 +0300356 __be32 *p;
357
358 if (hdr->minorversion == 0)
359 return;
360
Chuck Levera033db42010-12-14 14:57:22 +0000361 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
362 encode_sessionid4(xdr, session);
Benny Halevy2af73582009-09-10 12:26:51 +0300363
Chuck Levera033db42010-12-14 14:57:22 +0000364 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
365 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
366 *p++ = xdr_zero; /* csa_slotid */
367 *p++ = xdr_zero; /* csa_highest_slotid */
368 *p++ = xdr_zero; /* csa_cachethis */
369 xdr_encode_empty_array(p); /* csa_referring_call_lists */
370
Benny Halevy2af73582009-09-10 12:26:51 +0300371 hdr->nops++;
372}
373
Chuck Levera033db42010-12-14 14:57:22 +0000374/*
Chuck Lever85a56482010-12-14 14:57:32 +0000375 * CB_SEQUENCE4resok
376 *
377 * struct CB_SEQUENCE4resok {
378 * sessionid4 csr_sessionid;
379 * sequenceid4 csr_sequenceid;
380 * slotid4 csr_slotid;
381 * slotid4 csr_highest_slotid;
382 * slotid4 csr_target_highest_slotid;
383 * };
384 *
385 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
386 * case NFS4_OK:
387 * CB_SEQUENCE4resok csr_resok4;
388 * default:
389 * void;
390 * };
391 *
392 * Our current back channel implmentation supports a single backchannel
393 * with a single slot.
394 */
395static int decode_cb_sequence4resok(struct xdr_stream *xdr,
396 struct nfsd4_callback *cb)
397{
398 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
399 struct nfs4_sessionid id;
400 int status;
401 __be32 *p;
402 u32 dummy;
403
404 status = -ESERVERFAULT;
405
406 /*
407 * If the server returns different values for sessionID, slotID or
408 * sequence number, the server is looney tunes.
409 */
Benny Halevy2c9c8f32011-02-22 14:43:22 -0800410 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
Chuck Lever85a56482010-12-14 14:57:32 +0000411 if (unlikely(p == NULL))
412 goto out_overflow;
413 memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
414 if (memcmp(id.data, session->se_sessionid.data,
415 NFS4_MAX_SESSIONID_LEN) != 0) {
416 dprintk("NFS: %s Invalid session id\n", __func__);
417 goto out;
418 }
419 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
420
421 dummy = be32_to_cpup(p++);
422 if (dummy != session->se_cb_seq_nr) {
423 dprintk("NFS: %s Invalid sequence number\n", __func__);
424 goto out;
425 }
426
427 dummy = be32_to_cpup(p++);
428 if (dummy != 0) {
429 dprintk("NFS: %s Invalid slotid\n", __func__);
430 goto out;
431 }
432
433 /*
434 * FIXME: process highest slotid and target highest slotid
435 */
436 status = 0;
437out:
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800438 cb->cb_seq_status = status;
Chuck Lever85a56482010-12-14 14:57:32 +0000439 return status;
440out_overflow:
441 print_overflow_msg(__func__, xdr);
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800442 status = -EIO;
443 goto out;
Chuck Lever85a56482010-12-14 14:57:32 +0000444}
445
446static int decode_cb_sequence4res(struct xdr_stream *xdr,
447 struct nfsd4_callback *cb)
448{
Chuck Lever85a56482010-12-14 14:57:32 +0000449 int status;
450
451 if (cb->cb_minorversion == 0)
452 return 0;
453
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800454 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &cb->cb_seq_status);
455 if (unlikely(status || cb->cb_seq_status))
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200456 return status;
457
458 return decode_cb_sequence4resok(xdr, cb);
Chuck Lever85a56482010-12-14 14:57:32 +0000459}
460
461/*
Chuck Levera033db42010-12-14 14:57:22 +0000462 * NFSv4.0 and NFSv4.1 XDR encode functions
463 *
464 * NFSv4.0 callback argument types are defined in section 15 of RFC
465 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
466 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
467 * Protocol".
468 */
469
470/*
471 * NB: Without this zero space reservation, callbacks over krb5p fail
472 */
Chuck Lever9f06c712010-12-14 14:59:18 +0000473static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
474 void *__unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
Chuck Levera033db42010-12-14 14:57:22 +0000476 xdr_reserve_space(xdr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477}
478
Chuck Levera033db42010-12-14 14:57:22 +0000479/*
480 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
481 */
Chuck Lever9f06c712010-12-14 14:59:18 +0000482static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
483 const struct nfsd4_callback *cb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484{
Jeff Layton34549ab2014-10-01 08:05:22 -0400485 const struct nfs4_delegation *dp = cb_to_delegation(cb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 struct nfs4_cb_compound_hdr hdr = {
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400487 .ident = cb->cb_clp->cl_cb_ident,
J. Bruce Fieldsfb003922010-05-31 18:21:37 -0400488 .minorversion = cb->cb_minorversion,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 };
490
Chuck Lever9f06c712010-12-14 14:59:18 +0000491 encode_cb_compound4args(xdr, &hdr);
492 encode_cb_sequence4args(xdr, cb, &hdr);
Christoph Hellwig2faf3b42014-09-24 12:19:16 +0200493 encode_cb_recall4args(xdr, dp, &hdr);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300494 encode_cb_nops(&hdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495}
496
497
Chuck Lever85a56482010-12-14 14:57:32 +0000498/*
499 * NFSv4.0 and NFSv4.1 XDR decode functions
500 *
501 * NFSv4.0 callback result types are defined in section 15 of RFC
502 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
503 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
504 * Protocol".
505 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Chuck Leverbf269552010-12-14 14:59:29 +0000507static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
508 void *__unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 return 0;
511}
512
Benny Halevy2af73582009-09-10 12:26:51 +0300513/*
Chuck Lever85a56482010-12-14 14:57:32 +0000514 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
Benny Halevy2af73582009-09-10 12:26:51 +0300515 */
Chuck Leverbf269552010-12-14 14:59:29 +0000516static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
517 struct xdr_stream *xdr,
Chuck Lever85a56482010-12-14 14:57:32 +0000518 struct nfsd4_callback *cb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 struct nfs4_cb_compound_hdr hdr;
521 int status;
522
Chuck Leverbf269552010-12-14 14:59:29 +0000523 status = decode_cb_compound4res(xdr, &hdr);
Chuck Lever85a56482010-12-14 14:57:32 +0000524 if (unlikely(status))
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200525 return status;
Chuck Lever85a56482010-12-14 14:57:32 +0000526
527 if (cb != NULL) {
Chuck Leverbf269552010-12-14 14:59:29 +0000528 status = decode_cb_sequence4res(xdr, cb);
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800529 if (unlikely(status || cb->cb_seq_status))
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200530 return status;
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300531 }
Chuck Lever85a56482010-12-14 14:57:32 +0000532
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200533 return decode_cb_op_status(xdr, OP_CB_RECALL, &cb->cb_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534}
535
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200536#ifdef CONFIG_NFSD_PNFS
537/*
538 * CB_LAYOUTRECALL4args
539 *
540 * struct layoutrecall_file4 {
541 * nfs_fh4 lor_fh;
542 * offset4 lor_offset;
543 * length4 lor_length;
544 * stateid4 lor_stateid;
545 * };
546 *
547 * union layoutrecall4 switch(layoutrecall_type4 lor_recalltype) {
548 * case LAYOUTRECALL4_FILE:
549 * layoutrecall_file4 lor_layout;
550 * case LAYOUTRECALL4_FSID:
551 * fsid4 lor_fsid;
552 * case LAYOUTRECALL4_ALL:
553 * void;
554 * };
555 *
556 * struct CB_LAYOUTRECALL4args {
557 * layouttype4 clora_type;
558 * layoutiomode4 clora_iomode;
559 * bool clora_changed;
560 * layoutrecall4 clora_recall;
561 * };
562 */
563static void encode_cb_layout4args(struct xdr_stream *xdr,
564 const struct nfs4_layout_stateid *ls,
565 struct nfs4_cb_compound_hdr *hdr)
566{
567 __be32 *p;
568
569 BUG_ON(hdr->minorversion == 0);
570
571 p = xdr_reserve_space(xdr, 5 * 4);
572 *p++ = cpu_to_be32(OP_CB_LAYOUTRECALL);
573 *p++ = cpu_to_be32(ls->ls_layout_type);
574 *p++ = cpu_to_be32(IOMODE_ANY);
575 *p++ = cpu_to_be32(1);
576 *p = cpu_to_be32(RETURN_FILE);
577
578 encode_nfs_fh4(xdr, &ls->ls_stid.sc_file->fi_fhandle);
579
580 p = xdr_reserve_space(xdr, 2 * 8);
581 p = xdr_encode_hyper(p, 0);
582 xdr_encode_hyper(p, NFS4_MAX_UINT64);
583
584 encode_stateid4(xdr, &ls->ls_recall_sid);
585
586 hdr->nops++;
587}
588
589static void nfs4_xdr_enc_cb_layout(struct rpc_rqst *req,
590 struct xdr_stream *xdr,
591 const struct nfsd4_callback *cb)
592{
593 const struct nfs4_layout_stateid *ls =
594 container_of(cb, struct nfs4_layout_stateid, ls_recall);
595 struct nfs4_cb_compound_hdr hdr = {
596 .ident = 0,
597 .minorversion = cb->cb_minorversion,
598 };
599
600 encode_cb_compound4args(xdr, &hdr);
601 encode_cb_sequence4args(xdr, cb, &hdr);
602 encode_cb_layout4args(xdr, ls, &hdr);
603 encode_cb_nops(&hdr);
604}
605
606static int nfs4_xdr_dec_cb_layout(struct rpc_rqst *rqstp,
607 struct xdr_stream *xdr,
608 struct nfsd4_callback *cb)
609{
610 struct nfs4_cb_compound_hdr hdr;
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200611 int status;
612
613 status = decode_cb_compound4res(xdr, &hdr);
614 if (unlikely(status))
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200615 return status;
616
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200617 if (cb) {
618 status = decode_cb_sequence4res(xdr, cb);
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800619 if (unlikely(status || cb->cb_seq_status))
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200620 return status;
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200621 }
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200622 return decode_cb_op_status(xdr, OP_CB_LAYOUTRECALL, &cb->cb_status);
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200623}
624#endif /* CONFIG_NFSD_PNFS */
625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626/*
627 * RPC procedure tables
628 */
Chuck Lever7d93bd712010-12-14 14:57:42 +0000629#define PROC(proc, call, argtype, restype) \
630[NFSPROC4_CLNT_##proc] = { \
631 .p_proc = NFSPROC4_CB_##call, \
Chuck Lever9f06c712010-12-14 14:59:18 +0000632 .p_encode = (kxdreproc_t)nfs4_xdr_enc_##argtype, \
Chuck Leverbf269552010-12-14 14:59:29 +0000633 .p_decode = (kxdrdproc_t)nfs4_xdr_dec_##restype, \
Chuck Lever7d93bd712010-12-14 14:57:42 +0000634 .p_arglen = NFS4_enc_##argtype##_sz, \
635 .p_replen = NFS4_dec_##restype##_sz, \
636 .p_statidx = NFSPROC4_CB_##call, \
637 .p_name = #proc, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638}
639
Chuck Lever7d93bd712010-12-14 14:57:42 +0000640static struct rpc_procinfo nfs4_cb_procedures[] = {
641 PROC(CB_NULL, NULL, cb_null, cb_null),
642 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200643#ifdef CONFIG_NFSD_PNFS
644 PROC(CB_LAYOUT, COMPOUND, cb_layout, cb_layout),
645#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646};
647
Chuck Lever7d93bd712010-12-14 14:57:42 +0000648static struct rpc_version nfs_cb_version4 = {
J. Bruce Fieldsb7299f42010-05-14 17:57:35 -0400649/*
650 * Note on the callback rpc program version number: despite language in rfc
651 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
652 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
653 * in practice that appears to be what implementations use. The section
654 * 18.36.3 language is expected to be fixed in an erratum.
655 */
Chuck Lever7d93bd712010-12-14 14:57:42 +0000656 .number = 1,
657 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
658 .procs = nfs4_cb_procedures
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659};
660
Trond Myklebusta613fa12012-01-20 13:53:56 -0500661static const struct rpc_version *nfs_cb_version[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 &nfs_cb_version4,
663};
664
Trond Myklebusta613fa12012-01-20 13:53:56 -0500665static const struct rpc_program cb_program;
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400666
667static struct rpc_stat cb_stats = {
Chuck Lever7d93bd712010-12-14 14:57:42 +0000668 .program = &cb_program
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400669};
670
671#define NFS4_CALLBACK 0x40000000
Trond Myklebusta613fa12012-01-20 13:53:56 -0500672static const struct rpc_program cb_program = {
Chuck Lever7d93bd712010-12-14 14:57:42 +0000673 .name = "nfs4_cb",
674 .number = NFS4_CALLBACK,
675 .nrvers = ARRAY_SIZE(nfs_cb_version),
676 .version = nfs_cb_version,
677 .stats = &cb_stats,
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400678 .pipe_dir_name = "nfsd4_cb",
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400679};
680
Stanislav Kinsbursky3d733712012-11-27 14:11:44 +0300681static int max_cb_time(struct net *net)
J. Bruce Fields595947a2009-03-05 17:18:10 -0500682{
Stanislav Kinsbursky3d733712012-11-27 14:11:44 +0300683 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
684 return max(nn->nfsd4_lease/10, (time_t)1) * HZ;
J. Bruce Fields595947a2009-03-05 17:18:10 -0500685}
686
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400687static struct rpc_cred *callback_cred;
688
689int set_callback_cred(void)
690{
691 if (callback_cred)
692 return 0;
693 callback_cred = rpc_lookup_machine_cred("nfs");
694 if (!callback_cred)
695 return -ENOMEM;
696 return 0;
697}
698
Fengguang Wu2b4cf662012-11-13 15:41:27 -0500699static struct rpc_cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400700{
701 if (clp->cl_minorversion == 0) {
702 return get_rpccred(callback_cred);
703 } else {
704 struct rpc_auth *auth = client->cl_auth;
705 struct auth_cred acred = {};
706
707 acred.uid = ses->se_cb_sec.uid;
708 acred.gid = ses->se_cb_sec.gid;
709 return auth->au_ops->lookup_cred(client->cl_auth, &acred, 0);
710 }
711}
J. Bruce Fields2b47eec2007-07-27 18:06:50 -0400712
Kinglong Meed531c002014-03-24 11:59:46 +0800713static struct rpc_clnt *create_backchannel_client(struct rpc_create_args *args)
714{
715 struct rpc_xprt *xprt;
716
717 if (args->protocol != XPRT_TRANSPORT_BC_TCP)
718 return rpc_create(args);
719
720 xprt = args->bc_xprt->xpt_bc_xprt;
721 if (xprt) {
722 xprt_get(xprt);
723 return rpc_create_xprt(args, xprt);
724 }
725
726 return rpc_create(args);
727}
728
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400729static 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 -0400730{
Jeff Layton3758cf72014-04-15 08:51:48 -0400731 int maxtime = max_cb_time(clp->net);
Chuck Leverae5c7942006-08-22 20:06:21 -0400732 struct rpc_timeout timeparms = {
Jeff Layton3758cf72014-04-15 08:51:48 -0400733 .to_initval = maxtime,
J. Bruce Fields595947a2009-03-05 17:18:10 -0500734 .to_retries = 0,
Jeff Layton3758cf72014-04-15 08:51:48 -0400735 .to_maxval = maxtime,
Chuck Leverae5c7942006-08-22 20:06:21 -0400736 };
Chuck Leverae5c7942006-08-22 20:06:21 -0400737 struct rpc_create_args args = {
Stanislav Kinsburskyc212cec2012-11-14 18:21:10 +0300738 .net = clp->net,
J. Bruce Fields07263f12010-05-31 19:09:40 -0400739 .address = (struct sockaddr *) &conn->cb_addr,
740 .addrsize = conn->cb_addrlen,
Takuma Umeya6f3d7722010-12-15 14:09:01 +0900741 .saddress = (struct sockaddr *) &conn->cb_saddr,
Chuck Leverae5c7942006-08-22 20:06:21 -0400742 .timeout = &timeparms,
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400743 .program = &cb_program,
J. Bruce Fieldsb7299f42010-05-14 17:57:35 -0400744 .version = 0,
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400745 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
Chuck Leverae5c7942006-08-22 20:06:21 -0400746 };
J. Bruce Fields63c86712007-10-25 19:00:26 -0400747 struct rpc_clnt *client;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400748 struct rpc_cred *cred;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -0400750 if (clp->cl_minorversion == 0) {
J. Bruce Fields03a4e1f2012-05-14 19:55:22 -0400751 if (!clp->cl_cred.cr_principal &&
J. Bruce Fields39307652012-08-16 17:01:21 -0400752 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5))
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -0400753 return -EINVAL;
J. Bruce Fields03a4e1f2012-05-14 19:55:22 -0400754 args.client_name = clp->cl_cred.cr_principal;
Himangi Saraogifc8e5a62014-07-23 20:12:31 +0530755 args.prognumber = conn->cb_prog;
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -0400756 args.protocol = XPRT_TRANSPORT_TCP;
J. Bruce Fields39307652012-08-16 17:01:21 -0400757 args.authflavor = clp->cl_cred.cr_flavor;
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -0400758 clp->cl_cb_ident = conn->cb_ident;
759 } else {
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400760 if (!conn->cb_xprt)
761 return -EINVAL;
762 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
763 clp->cl_cb_session = ses;
J. Bruce Fields07263f12010-05-31 19:09:40 -0400764 args.bc_xprt = conn->cb_xprt;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400765 args.prognumber = clp->cl_cb_session->se_cb_prog;
Chuck Lever3c45ddf2014-07-16 15:38:32 -0400766 args.protocol = conn->cb_xprt->xpt_class->xcl_ident |
767 XPRT_TRANSPORT_BC;
J. Bruce Fields12fc3e92012-11-05 16:01:48 -0500768 args.authflavor = ses->se_cb_sec.flavor;
Alexandros Batsakis3ddc8bf2009-09-10 12:27:21 +0300769 }
Chuck Leverae5c7942006-08-22 20:06:21 -0400770 /* Create RPC client */
Kinglong Meed531c002014-03-24 11:59:46 +0800771 client = create_backchannel_client(&args);
J. Bruce Fieldse1cab5a52009-02-23 10:45:27 -0800772 if (IS_ERR(client)) {
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800773 dprintk("NFSD: couldn't create callback client: %ld\n",
774 PTR_ERR(client));
J. Bruce Fieldse1cab5a52009-02-23 10:45:27 -0800775 return PTR_ERR(client);
776 }
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400777 cred = get_backchannel_cred(clp, client, ses);
778 if (IS_ERR(cred)) {
779 rpc_shutdown_client(client);
780 return PTR_ERR(cred);
781 }
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400782 clp->cl_cb_client = client;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400783 clp->cl_cb_cred = cred;
J. Bruce Fieldse1cab5a52009-02-23 10:45:27 -0800784 return 0;
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800785}
786
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800787static void warn_no_callback_path(struct nfs4_client *clp, int reason)
788{
789 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
790 (int)clp->cl_name.len, clp->cl_name.data, reason);
791}
792
J. Bruce Fields77a35692010-04-30 18:51:44 -0400793static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
794{
J. Bruce Fieldsd4f72cb2015-11-24 15:43:03 -0700795 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
796 return;
J. Bruce Fields77a35692010-04-30 18:51:44 -0400797 clp->cl_cb_state = NFSD4_CB_DOWN;
798 warn_no_callback_path(clp, reason);
799}
800
Benny Halevy54237322011-10-19 19:12:58 -0700801static void nfsd4_mark_cb_fault(struct nfs4_client *clp, int reason)
802{
J. Bruce Fieldsd4f72cb2015-11-24 15:43:03 -0700803 if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags))
804 return;
Benny Halevy54237322011-10-19 19:12:58 -0700805 clp->cl_cb_state = NFSD4_CB_FAULT;
806 warn_no_callback_path(clp, reason);
807}
808
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500809static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
810{
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400811 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500812
813 if (task->tk_status)
J. Bruce Fields77a35692010-04-30 18:51:44 -0400814 nfsd4_mark_cb_down(clp, task->tk_status);
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500815 else
J. Bruce Fields77a35692010-04-30 18:51:44 -0400816 clp->cl_cb_state = NFSD4_CB_UP;
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500817}
818
819static const struct rpc_call_ops nfsd4_cb_probe_ops = {
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400820 /* XXX: release method to ensure we set the cb channel down if
821 * necessary on early failure? */
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500822 .rpc_call_done = nfsd4_cb_probe_done,
823};
824
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400825static struct workqueue_struct *callback_wq;
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400826
J. Bruce Fields63c86712007-10-25 19:00:26 -0400827/*
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400828 * Poke the callback thread to process any updates to the callback
829 * parameters, and send a null probe.
J. Bruce Fields63c86712007-10-25 19:00:26 -0400830 */
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400831void nfsd4_probe_callback(struct nfs4_client *clp)
832{
J. Bruce Fields77a35692010-04-30 18:51:44 -0400833 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
Jeff Laytona52d7262012-03-21 09:52:02 -0400834 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
Christoph Hellwigf0b5de12014-09-24 12:19:18 +0200835 nfsd4_run_cb(&clp->cl_cb_null);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400836}
837
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -0500838void nfsd4_probe_callback_sync(struct nfs4_client *clp)
839{
840 nfsd4_probe_callback(clp);
841 flush_workqueue(callback_wq);
842}
843
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400844void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
J. Bruce Fields63c86712007-10-25 19:00:26 -0400845{
J. Bruce Fields77a35692010-04-30 18:51:44 -0400846 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400847 spin_lock(&clp->cl_lock);
848 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400849 spin_unlock(&clp->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850}
851
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300852/*
853 * There's currently a single callback channel slot.
854 * If the slot is available, then mark it busy. Otherwise, set the
855 * thread for sleeping on the callback RPC wait queue.
856 */
J. Bruce Fields3ff36002011-01-10 16:37:51 -0500857static bool nfsd41_cb_get_slot(struct nfs4_client *clp, struct rpc_task *task)
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300858{
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300859 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
860 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
Trond Myklebustc6c15e12014-11-19 12:47:50 -0500861 /* Race breaker */
862 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
863 dprintk("%s slot is busy\n", __func__);
864 return false;
865 }
866 rpc_wake_up_queued_task(&clp->cl_cb_waitq, task);
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300867 }
J. Bruce Fields3ff36002011-01-10 16:37:51 -0500868 return true;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300869}
870
871/*
872 * TODO: cb_sequence should support referring call lists, cachethis, multiple
873 * slots, and mark callback channel down on communication errors.
874 */
875static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
876{
J. Bruce Fields58784532010-05-16 16:47:08 -0400877 struct nfsd4_callback *cb = calldata;
J. Bruce Fields8be2d232013-03-21 10:59:29 -0400878 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400879 u32 minorversion = clp->cl_minorversion;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300880
J. Bruce Fieldsfb003922010-05-31 18:21:37 -0400881 cb->cb_minorversion = minorversion;
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800882 /*
883 * cb_seq_status is only set in decode_cb_sequence4res,
884 * and so will remain 1 if an rpc level failure occurs.
885 */
886 cb->cb_seq_status = 1;
Kinglong Mee43993962015-06-02 18:59:19 +0800887 cb->cb_status = 0;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300888 if (minorversion) {
J. Bruce Fields3ff36002011-01-10 16:37:51 -0500889 if (!nfsd41_cb_get_slot(clp, task))
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300890 return;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300891 }
892 rpc_call_start(task);
893}
894
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800895static bool nfsd4_cb_sequence_done(struct rpc_task *task, struct nfsd4_callback *cb)
896{
897 struct nfs4_client *clp = cb->cb_clp;
898 struct nfsd4_session *session = clp->cl_cb_session;
899 bool ret = true;
900
901 if (!clp->cl_minorversion) {
902 /*
903 * If the backchannel connection was shut down while this
904 * task was queued, we need to resubmit it after setting up
905 * a new backchannel connection.
906 *
907 * Note that if we lost our callback connection permanently
908 * the submission code will error out, so we don't need to
909 * handle that case here.
910 */
911 if (task->tk_flags & RPC_TASK_KILLED)
912 goto need_restart;
913
914 return true;
915 }
916
917 switch (cb->cb_seq_status) {
918 case 0:
919 /*
920 * No need for lock, access serialized in nfsd4_cb_prepare
921 *
922 * RFC5661 20.9.3
923 * If CB_SEQUENCE returns an error, then the state of the slot
924 * (sequence ID, cached reply) MUST NOT change.
925 */
926 ++session->se_cb_seq_nr;
927 break;
928 case -ESERVERFAULT:
929 ++session->se_cb_seq_nr;
930 case 1:
931 case -NFS4ERR_BADSESSION:
932 nfsd4_mark_cb_fault(cb->cb_clp, cb->cb_seq_status);
933 ret = false;
934 break;
935 case -NFS4ERR_DELAY:
936 if (!rpc_restart_call(task))
937 goto out;
938
939 rpc_delay(task, 2 * HZ);
940 return false;
941 case -NFS4ERR_BADSLOT:
942 goto retry_nowait;
943 case -NFS4ERR_SEQ_MISORDERED:
944 if (session->se_cb_seq_nr != 1) {
945 session->se_cb_seq_nr = 1;
946 goto retry_nowait;
947 }
948 break;
949 default:
950 dprintk("%s: unprocessed error %d\n", __func__,
951 cb->cb_seq_status);
952 }
953
954 clear_bit(0, &clp->cl_cb_slot_busy);
955 rpc_wake_up_next(&clp->cl_cb_waitq);
956 dprintk("%s: freed slot, new seqid=%d\n", __func__,
957 clp->cl_cb_session->se_cb_seq_nr);
958
959 if (task->tk_flags & RPC_TASK_KILLED)
960 goto need_restart;
961out:
962 return ret;
963retry_nowait:
964 if (rpc_restart_call_prepare(task))
965 ret = false;
966 goto out;
967need_restart:
968 task->tk_status = 0;
969 cb->cb_need_restart = true;
970 return false;
971}
972
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300973static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
974{
J. Bruce Fields58784532010-05-16 16:47:08 -0400975 struct nfsd4_callback *cb = calldata;
J. Bruce Fields8be2d232013-03-21 10:59:29 -0400976 struct nfs4_client *clp = cb->cb_clp;
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300977
978 dprintk("%s: minorversion=%d\n", __func__,
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400979 clp->cl_minorversion);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300980
Kinglong Mee7ba6cad2015-06-24 16:33:37 +0800981 if (!nfsd4_cb_sequence_done(task, cb))
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500982 return;
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500983
Christoph Hellwigef2a1b32015-04-30 11:49:23 +0200984 if (cb->cb_status) {
985 WARN_ON_ONCE(task->tk_status);
986 task->tk_status = cb->cb_status;
987 }
988
Christoph Hellwig0162ac22014-09-24 12:19:19 +0200989 switch (cb->cb_ops->done(cb, task)) {
J. Bruce Fields172c85d2010-05-30 11:53:12 -0400990 case 0:
Christoph Hellwig0162ac22014-09-24 12:19:19 +0200991 task->tk_status = 0;
992 rpc_restart_call_prepare(task);
993 return;
994 case 1:
Christoph Hellwig444b6e92014-09-23 08:58:48 +0200995 break;
Christoph Hellwig0162ac22014-09-24 12:19:19 +0200996 case -1:
J. Bruce Fields63e48632009-05-01 22:36:55 -0400997 /* Network partition? */
J. Bruce Fields77a35692010-04-30 18:51:44 -0400998 nfsd4_mark_cb_down(clp, task->tk_status);
Christoph Hellwig0162ac22014-09-24 12:19:19 +0200999 break;
1000 default:
1001 BUG();
J. Bruce Fields63e48632009-05-01 22:36:55 -04001002 }
J. Bruce Fields63e48632009-05-01 22:36:55 -04001003}
1004
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001005static void nfsd4_cb_release(void *calldata)
J. Bruce Fields63e48632009-05-01 22:36:55 -04001006{
J. Bruce Fields58784532010-05-16 16:47:08 -04001007 struct nfsd4_callback *cb = calldata;
J. Bruce Fields63e48632009-05-01 22:36:55 -04001008
Christoph Hellwigcba5f622015-04-30 11:49:24 +02001009 if (cb->cb_need_restart)
1010 nfsd4_run_cb(cb);
1011 else
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001012 cb->cb_ops->release(cb);
Christoph Hellwigcba5f622015-04-30 11:49:24 +02001013
J. Bruce Fields63e48632009-05-01 22:36:55 -04001014}
1015
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001016static const struct rpc_call_ops nfsd4_cb_ops = {
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +03001017 .rpc_call_prepare = nfsd4_cb_prepare,
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001018 .rpc_call_done = nfsd4_cb_done,
1019 .rpc_release = nfsd4_cb_release,
J. Bruce Fields63e48632009-05-01 22:36:55 -04001020};
1021
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001022int nfsd4_create_callback_queue(void)
1023{
1024 callback_wq = create_singlethread_workqueue("nfsd4_callbacks");
1025 if (!callback_wq)
1026 return -ENOMEM;
1027 return 0;
1028}
1029
1030void nfsd4_destroy_callback_queue(void)
1031{
1032 destroy_workqueue(callback_wq);
1033}
1034
Benny Halevyab707e152010-05-12 00:14:06 +03001035/* must be called under the state lock */
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001036void nfsd4_shutdown_callback(struct nfs4_client *clp)
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001037{
Jeff Laytona52d7262012-03-21 09:52:02 -04001038 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001039 /*
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001040 * Note this won't actually result in a null callback;
Jeff Layton02e12152014-07-16 10:31:57 -04001041 * instead, nfsd4_run_cb_null() will detect the killed
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001042 * client, destroy the rpc client, and stop:
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001043 */
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001044 nfsd4_run_cb(&clp->cl_cb_null);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001045 flush_workqueue(callback_wq);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001046}
1047
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001048/* requires cl_lock: */
1049static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
1050{
1051 struct nfsd4_session *s;
1052 struct nfsd4_conn *c;
1053
1054 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
1055 list_for_each_entry(c, &s->se_conns, cn_persession) {
1056 if (c->cn_flags & NFS4_CDFC4_BACK)
1057 return c;
1058 }
1059 }
1060 return NULL;
1061}
1062
Kirill A. Shutemov65e4c892010-12-16 15:25:54 +02001063static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001064{
1065 struct nfs4_cb_conn conn;
1066 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001067 struct nfsd4_session *ses = NULL;
1068 struct nfsd4_conn *c;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001069 int err;
1070
1071 /*
1072 * This is either an update, or the client dying; in either case,
1073 * kill the old client:
1074 */
1075 if (clp->cl_cb_client) {
1076 rpc_shutdown_client(clp->cl_cb_client);
1077 clp->cl_cb_client = NULL;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001078 put_rpccred(clp->cl_cb_cred);
1079 clp->cl_cb_cred = NULL;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001080 }
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001081 if (clp->cl_cb_conn.cb_xprt) {
1082 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
1083 clp->cl_cb_conn.cb_xprt = NULL;
1084 }
Jeff Laytona52d7262012-03-21 09:52:02 -04001085 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001086 return;
1087 spin_lock(&clp->cl_lock);
1088 /*
1089 * Only serialized callback code is allowed to clear these
1090 * flags; main nfsd code can only set them:
1091 */
Jeff Laytona52d7262012-03-21 09:52:02 -04001092 BUG_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
1093 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001094 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001095 c = __nfsd4_find_backchannel(clp);
1096 if (c) {
1097 svc_xprt_get(c->cn_xprt);
1098 conn.cb_xprt = c->cn_xprt;
1099 ses = c->cn_session;
1100 }
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001101 spin_unlock(&clp->cl_lock);
1102
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -04001103 err = setup_callback_client(clp, &conn, ses);
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001104 if (err) {
J. Bruce Fields8546ee52012-03-09 17:02:28 -05001105 nfsd4_mark_cb_down(clp, err);
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001106 return;
1107 }
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001108}
1109
Jeff Layton02e12152014-07-16 10:31:57 -04001110static void
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001111nfsd4_run_cb_work(struct work_struct *work)
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001112{
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001113 struct nfsd4_callback *cb =
1114 container_of(work, struct nfsd4_callback, cb_work);
J. Bruce Fieldsfb003922010-05-31 18:21:37 -04001115 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001116 struct rpc_clnt *clnt;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001117
Christoph Hellwigcba5f622015-04-30 11:49:24 +02001118 if (cb->cb_need_restart) {
1119 cb->cb_need_restart = false;
1120 } else {
1121 if (cb->cb_ops && cb->cb_ops->prepare)
1122 cb->cb_ops->prepare(cb);
1123 }
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001124
Jeff Laytona52d7262012-03-21 09:52:02 -04001125 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001126 nfsd4_process_cb_update(cb);
1127
1128 clnt = clp->cl_cb_client;
1129 if (!clnt) {
1130 /* Callback channel broken, or client killed; give up: */
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001131 if (cb->cb_ops && cb->cb_ops->release)
1132 cb->cb_ops->release(cb);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001133 return;
J. Bruce Fields58784532010-05-16 16:47:08 -04001134 }
Christoph Hellwig4bd9e9b2015-04-30 11:49:25 +02001135
1136 /*
1137 * Don't send probe messages for 4.1 or later.
1138 */
1139 if (!cb->cb_ops && clp->cl_minorversion) {
1140 clp->cl_cb_state = NFSD4_CB_UP;
1141 return;
1142 }
1143
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -04001144 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
J. Bruce Fieldscee277d2010-05-26 17:52:14 -04001145 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001146 cb->cb_ops ? &nfsd4_cb_ops : &nfsd4_cb_probe_ops, cb);
Jeff Layton02e12152014-07-16 10:31:57 -04001147}
1148
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001149void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
Julia Lawallc4cb8972015-11-21 22:57:39 +01001150 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op)
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001151{
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001152 cb->cb_clp = clp;
Christoph Hellwig326129d2014-09-24 12:19:17 +02001153 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[op];
J. Bruce Fieldsfb003922010-05-31 18:21:37 -04001154 cb->cb_msg.rpc_argp = cb;
1155 cb->cb_msg.rpc_resp = cb;
Christoph Hellwig0162ac22014-09-24 12:19:19 +02001156 cb->cb_ops = ops;
1157 INIT_WORK(&cb->cb_work, nfsd4_run_cb_work);
Kinglong Mee7ba6cad2015-06-24 16:33:37 +08001158 cb->cb_seq_status = 1;
Christoph Hellwigef2a1b32015-04-30 11:49:23 +02001159 cb->cb_status = 0;
Christoph Hellwigcba5f622015-04-30 11:49:24 +02001160 cb->cb_need_restart = false;
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001161}
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001162
Christoph Hellwigf0b5de12014-09-24 12:19:18 +02001163void nfsd4_run_cb(struct nfsd4_callback *cb)
1164{
Christoph Hellwig326129d2014-09-24 12:19:17 +02001165 queue_work(callback_wq, &cb->cb_work);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001166}