blob: 02eb4edf0ece1ab240c86aaf1c9afc025a805199 [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>
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -050035#include <linux/sunrpc/svc_xprt.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090036#include <linux/slab.h>
Boaz Harrosh9a74af22009-12-03 20:30:56 +020037#include "nfsd.h"
38#include "state.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#define NFSDDBG_FACILITY NFSDDBG_PROC
41
42#define NFSPROC4_CB_NULL 0
43#define NFSPROC4_CB_COMPOUND 1
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045/* Index of predefined Linux callback client operations */
46
47enum {
Benny Halevy4be36ca2009-09-10 12:25:46 +030048 NFSPROC4_CLNT_CB_NULL = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 NFSPROC4_CLNT_CB_RECALL,
Andy Adamson38524ab2009-09-10 12:25:59 +030050 NFSPROC4_CLNT_CB_SEQUENCE,
Linus Torvalds1da177e2005-04-16 15:20:36 -070051};
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#define NFS4_MAXTAGLEN 20
54
55#define NFS4_enc_cb_null_sz 0
56#define NFS4_dec_cb_null_sz 0
57#define cb_compound_enc_hdr_sz 4
58#define cb_compound_dec_hdr_sz (3 + (NFS4_MAXTAGLEN >> 2))
Andy Adamson38524ab2009-09-10 12:25:59 +030059#define sessionid_sz (NFS4_MAX_SESSIONID_LEN >> 2)
60#define cb_sequence_enc_sz (sessionid_sz + 4 + \
61 1 /* no referring calls list yet */)
62#define cb_sequence_dec_sz (op_dec_sz + sessionid_sz + 4)
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#define op_enc_sz 1
65#define op_dec_sz 2
66#define enc_nfs4_fh_sz (1 + (NFS4_FHSIZE >> 2))
Benny Halevy0ac68d12007-07-17 04:04:37 -070067#define enc_stateid_sz (NFS4_STATEID_SIZE >> 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#define NFS4_enc_cb_recall_sz (cb_compound_enc_hdr_sz + \
Andy Adamson38524ab2009-09-10 12:25:59 +030069 cb_sequence_enc_sz + \
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 1 + enc_stateid_sz + \
71 enc_nfs4_fh_sz)
72
73#define NFS4_dec_cb_recall_sz (cb_compound_dec_hdr_sz + \
Andy Adamson38524ab2009-09-10 12:25:59 +030074 cb_sequence_dec_sz + \
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 op_dec_sz)
76
Linus Torvalds1da177e2005-04-16 15:20:36 -070077struct nfs4_cb_compound_hdr {
Andy Adamson38524ab2009-09-10 12:25:59 +030078 /* args */
79 u32 ident; /* minorversion 0 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 u32 nops;
Andy Adamsonef52bff2009-06-16 04:20:50 +030081 __be32 *nops_p;
Andy Adamsonab52ae62009-06-16 04:20:53 +030082 u32 minorversion;
Andy Adamson38524ab2009-09-10 12:25:59 +030083 /* res */
84 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085};
86
Chuck Lever85a56482010-12-14 14:57:32 +000087/*
88 * Handle decode buffer overflows out-of-line.
89 */
90static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
Chuck Lever85a56482010-12-14 14:57:32 +000092 dprintk("NFS: %s prematurely hit the end of our receive buffer. "
93 "Remaining buffer length is %tu words.\n",
94 func, xdr->end - xdr->p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095}
96
Chuck Levera033db42010-12-14 14:57:22 +000097static __be32 *xdr_encode_empty_array(__be32 *p)
98{
99 *p++ = xdr_zero;
100 return p;
101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103/*
Chuck Levera033db42010-12-14 14:57:22 +0000104 * Encode/decode NFSv4 CB basic data types
105 *
106 * Basic NFSv4 callback data types are defined in section 15 of RFC
107 * 3530: "Network File System (NFS) version 4 Protocol" and section
108 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
109 * 1 Protocol"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 */
111
Chuck Levera033db42010-12-14 14:57:22 +0000112/*
113 * nfs_cb_opnum4
114 *
115 * enum nfs_cb_opnum4 {
116 * OP_CB_GETATTR = 3,
117 * ...
118 * };
119 */
120enum nfs_cb_opnum4 {
121 OP_CB_GETATTR = 3,
122 OP_CB_RECALL = 4,
123 OP_CB_LAYOUTRECALL = 5,
124 OP_CB_NOTIFY = 6,
125 OP_CB_PUSH_DELEG = 7,
126 OP_CB_RECALL_ANY = 8,
127 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
128 OP_CB_RECALL_SLOT = 10,
129 OP_CB_SEQUENCE = 11,
130 OP_CB_WANTS_CANCELLED = 12,
131 OP_CB_NOTIFY_LOCK = 13,
132 OP_CB_NOTIFY_DEVICEID = 14,
133 OP_CB_ILLEGAL = 10044
134};
135
136static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
Benny Halevy9303bbd2010-05-25 09:50:23 +0300137{
138 __be32 *p;
139
Chuck Levera033db42010-12-14 14:57:22 +0000140 p = xdr_reserve_space(xdr, 4);
141 *p = cpu_to_be32(op);
Benny Halevy9303bbd2010-05-25 09:50:23 +0300142}
143
Chuck Levera033db42010-12-14 14:57:22 +0000144/*
145 * nfs_fh4
146 *
147 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
148 */
149static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
150{
151 u32 length = fh->fh_size;
152 __be32 *p;
153
154 BUG_ON(length > NFS4_FHSIZE);
155 p = xdr_reserve_space(xdr, 4 + length);
156 xdr_encode_opaque(p, &fh->fh_base, length);
157}
158
159/*
160 * stateid4
161 *
162 * struct stateid4 {
163 * uint32_t seqid;
164 * opaque other[12];
165 * };
166 */
167static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
168{
169 __be32 *p;
170
171 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
172 *p++ = cpu_to_be32(sid->si_generation);
173 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
174}
175
176/*
177 * sessionid4
178 *
179 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
180 */
181static void encode_sessionid4(struct xdr_stream *xdr,
182 const struct nfsd4_session *session)
183{
184 __be32 *p;
185
186 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
187 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
188 NFS4_MAX_SESSIONID_LEN);
189}
190
191/*
Chuck Lever85a56482010-12-14 14:57:32 +0000192 * nfsstat4
193 */
194static const struct {
195 int stat;
196 int errno;
197} nfs_cb_errtbl[] = {
198 { NFS4_OK, 0 },
199 { NFS4ERR_PERM, -EPERM },
200 { NFS4ERR_NOENT, -ENOENT },
201 { NFS4ERR_IO, -EIO },
202 { NFS4ERR_NXIO, -ENXIO },
203 { NFS4ERR_ACCESS, -EACCES },
204 { NFS4ERR_EXIST, -EEXIST },
205 { NFS4ERR_XDEV, -EXDEV },
206 { NFS4ERR_NOTDIR, -ENOTDIR },
207 { NFS4ERR_ISDIR, -EISDIR },
208 { NFS4ERR_INVAL, -EINVAL },
209 { NFS4ERR_FBIG, -EFBIG },
210 { NFS4ERR_NOSPC, -ENOSPC },
211 { NFS4ERR_ROFS, -EROFS },
212 { NFS4ERR_MLINK, -EMLINK },
213 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
214 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
215 { NFS4ERR_DQUOT, -EDQUOT },
216 { NFS4ERR_STALE, -ESTALE },
217 { NFS4ERR_BADHANDLE, -EBADHANDLE },
218 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
219 { NFS4ERR_NOTSUPP, -ENOTSUPP },
220 { NFS4ERR_TOOSMALL, -ETOOSMALL },
221 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
222 { NFS4ERR_BADTYPE, -EBADTYPE },
223 { NFS4ERR_LOCKED, -EAGAIN },
224 { NFS4ERR_RESOURCE, -EREMOTEIO },
225 { NFS4ERR_SYMLINK, -ELOOP },
226 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
227 { NFS4ERR_DEADLOCK, -EDEADLK },
228 { -1, -EIO }
229};
230
231/*
232 * If we cannot translate the error, the recovery routines should
233 * handle it.
234 *
235 * Note: remaining NFSv4 error codes have values > 10000, so should
236 * not conflict with native Linux error codes.
237 */
238static int nfs_cb_stat_to_errno(int status)
239{
240 int i;
241
242 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
243 if (nfs_cb_errtbl[i].stat == status)
244 return nfs_cb_errtbl[i].errno;
245 }
246
247 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
248 return -status;
249}
250
251static int decode_cb_op_status(struct xdr_stream *xdr, enum nfs_opnum4 expected,
252 enum nfsstat4 *status)
253{
254 __be32 *p;
255 u32 op;
256
257 p = xdr_inline_decode(xdr, 4 + 4);
258 if (unlikely(p == NULL))
259 goto out_overflow;
260 op = be32_to_cpup(p++);
261 if (unlikely(op != expected))
262 goto out_unexpected;
263 *status = be32_to_cpup(p);
264 return 0;
265out_overflow:
266 print_overflow_msg(__func__, xdr);
267 return -EIO;
268out_unexpected:
269 dprintk("NFSD: Callback server returned operation %d but "
270 "we issued a request for %d\n", op, expected);
271 return -EIO;
272}
273
274/*
Chuck Levera033db42010-12-14 14:57:22 +0000275 * CB_COMPOUND4args
276 *
277 * struct CB_COMPOUND4args {
278 * utf8str_cs tag;
279 * uint32_t minorversion;
280 * uint32_t callback_ident;
281 * nfs_cb_argop4 argarray<>;
282 * };
283*/
284static void encode_cb_compound4args(struct xdr_stream *xdr,
285 struct nfs4_cb_compound_hdr *hdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286{
Al Virof00f3282006-10-19 23:29:01 -0700287 __be32 * p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Chuck Levera033db42010-12-14 14:57:22 +0000289 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
290 p = xdr_encode_empty_array(p); /* empty tag */
291 *p++ = cpu_to_be32(hdr->minorversion);
292 *p++ = cpu_to_be32(hdr->ident);
293
Andy Adamsonef52bff2009-06-16 04:20:50 +0300294 hdr->nops_p = p;
Chuck Levera033db42010-12-14 14:57:22 +0000295 *p = cpu_to_be32(hdr->nops); /* argarray element count */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
297
Chuck Levera033db42010-12-14 14:57:22 +0000298/*
299 * Update argarray element count
300 */
Andy Adamsonef52bff2009-06-16 04:20:50 +0300301static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
302{
Chuck Levera033db42010-12-14 14:57:22 +0000303 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
304 *hdr->nops_p = cpu_to_be32(hdr->nops);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300305}
306
Chuck Levera033db42010-12-14 14:57:22 +0000307/*
Chuck Lever85a56482010-12-14 14:57:32 +0000308 * CB_COMPOUND4res
309 *
310 * struct CB_COMPOUND4res {
311 * nfsstat4 status;
312 * utf8str_cs tag;
313 * nfs_cb_resop4 resarray<>;
314 * };
315 */
316static int decode_cb_compound4res(struct xdr_stream *xdr,
317 struct nfs4_cb_compound_hdr *hdr)
318{
319 u32 length;
320 __be32 *p;
321
322 p = xdr_inline_decode(xdr, 4 + 4);
323 if (unlikely(p == NULL))
324 goto out_overflow;
325 hdr->status = be32_to_cpup(p++);
326 /* Ignore the tag */
327 length = be32_to_cpup(p++);
328 p = xdr_inline_decode(xdr, length + 4);
329 if (unlikely(p == NULL))
330 goto out_overflow;
331 hdr->nops = be32_to_cpup(p);
332 return 0;
333out_overflow:
334 print_overflow_msg(__func__, xdr);
335 return -EIO;
336}
337
338/*
Chuck Levera033db42010-12-14 14:57:22 +0000339 * CB_RECALL4args
340 *
341 * struct CB_RECALL4args {
342 * stateid4 stateid;
343 * bool truncate;
344 * nfs_fh4 fh;
345 * };
346 */
347static void encode_cb_recall4args(struct xdr_stream *xdr,
348 const struct nfs4_delegation *dp,
349 struct nfs4_cb_compound_hdr *hdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350{
Al Virof00f3282006-10-19 23:29:01 -0700351 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Chuck Levera033db42010-12-14 14:57:22 +0000353 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
354 encode_stateid4(xdr, &dp->dl_stateid);
355
356 p = xdr_reserve_space(xdr, 4);
357 *p++ = xdr_zero; /* truncate */
358
359 encode_nfs_fh4(xdr, &dp->dl_fh);
360
Andy Adamsonef52bff2009-06-16 04:20:50 +0300361 hdr->nops++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362}
363
Chuck Levera033db42010-12-14 14:57:22 +0000364/*
365 * CB_SEQUENCE4args
366 *
367 * struct CB_SEQUENCE4args {
368 * sessionid4 csa_sessionid;
369 * sequenceid4 csa_sequenceid;
370 * slotid4 csa_slotid;
371 * slotid4 csa_highest_slotid;
372 * bool csa_cachethis;
373 * referring_call_list4 csa_referring_call_lists<>;
374 * };
375 */
376static void encode_cb_sequence4args(struct xdr_stream *xdr,
377 const struct nfsd4_callback *cb,
378 struct nfs4_cb_compound_hdr *hdr)
Benny Halevy2af73582009-09-10 12:26:51 +0300379{
Chuck Levera033db42010-12-14 14:57:22 +0000380 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
Benny Halevy2af73582009-09-10 12:26:51 +0300381 __be32 *p;
382
383 if (hdr->minorversion == 0)
384 return;
385
Chuck Levera033db42010-12-14 14:57:22 +0000386 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
387 encode_sessionid4(xdr, session);
Benny Halevy2af73582009-09-10 12:26:51 +0300388
Chuck Levera033db42010-12-14 14:57:22 +0000389 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
390 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
391 *p++ = xdr_zero; /* csa_slotid */
392 *p++ = xdr_zero; /* csa_highest_slotid */
393 *p++ = xdr_zero; /* csa_cachethis */
394 xdr_encode_empty_array(p); /* csa_referring_call_lists */
395
Benny Halevy2af73582009-09-10 12:26:51 +0300396 hdr->nops++;
397}
398
Chuck Levera033db42010-12-14 14:57:22 +0000399/*
Chuck Lever85a56482010-12-14 14:57:32 +0000400 * CB_SEQUENCE4resok
401 *
402 * struct CB_SEQUENCE4resok {
403 * sessionid4 csr_sessionid;
404 * sequenceid4 csr_sequenceid;
405 * slotid4 csr_slotid;
406 * slotid4 csr_highest_slotid;
407 * slotid4 csr_target_highest_slotid;
408 * };
409 *
410 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
411 * case NFS4_OK:
412 * CB_SEQUENCE4resok csr_resok4;
413 * default:
414 * void;
415 * };
416 *
417 * Our current back channel implmentation supports a single backchannel
418 * with a single slot.
419 */
420static int decode_cb_sequence4resok(struct xdr_stream *xdr,
421 struct nfsd4_callback *cb)
422{
423 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
424 struct nfs4_sessionid id;
425 int status;
426 __be32 *p;
427 u32 dummy;
428
429 status = -ESERVERFAULT;
430
431 /*
432 * If the server returns different values for sessionID, slotID or
433 * sequence number, the server is looney tunes.
434 */
Benny Halevy2c9c8f32011-02-22 14:43:22 -0800435 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
Chuck Lever85a56482010-12-14 14:57:32 +0000436 if (unlikely(p == NULL))
437 goto out_overflow;
438 memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
439 if (memcmp(id.data, session->se_sessionid.data,
440 NFS4_MAX_SESSIONID_LEN) != 0) {
441 dprintk("NFS: %s Invalid session id\n", __func__);
442 goto out;
443 }
444 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
445
446 dummy = be32_to_cpup(p++);
447 if (dummy != session->se_cb_seq_nr) {
448 dprintk("NFS: %s Invalid sequence number\n", __func__);
449 goto out;
450 }
451
452 dummy = be32_to_cpup(p++);
453 if (dummy != 0) {
454 dprintk("NFS: %s Invalid slotid\n", __func__);
455 goto out;
456 }
457
458 /*
459 * FIXME: process highest slotid and target highest slotid
460 */
461 status = 0;
462out:
463 return status;
464out_overflow:
465 print_overflow_msg(__func__, xdr);
466 return -EIO;
467}
468
469static int decode_cb_sequence4res(struct xdr_stream *xdr,
470 struct nfsd4_callback *cb)
471{
472 enum nfsstat4 nfserr;
473 int status;
474
475 if (cb->cb_minorversion == 0)
476 return 0;
477
478 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &nfserr);
479 if (unlikely(status))
480 goto out;
481 if (unlikely(nfserr != NFS4_OK))
482 goto out_default;
483 status = decode_cb_sequence4resok(xdr, cb);
484out:
485 return status;
486out_default:
Benny Halevy0af3f812011-01-13 11:25:31 +0200487 return nfs_cb_stat_to_errno(nfserr);
Chuck Lever85a56482010-12-14 14:57:32 +0000488}
489
490/*
Chuck Levera033db42010-12-14 14:57:22 +0000491 * NFSv4.0 and NFSv4.1 XDR encode functions
492 *
493 * NFSv4.0 callback argument types are defined in section 15 of RFC
494 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
495 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
496 * Protocol".
497 */
498
499/*
500 * NB: Without this zero space reservation, callbacks over krb5p fail
501 */
Chuck Lever9f06c712010-12-14 14:59:18 +0000502static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
503 void *__unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
Chuck Levera033db42010-12-14 14:57:22 +0000505 xdr_reserve_space(xdr, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506}
507
Chuck Levera033db42010-12-14 14:57:22 +0000508/*
509 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
510 */
Chuck Lever9f06c712010-12-14 14:59:18 +0000511static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
512 const struct nfsd4_callback *cb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513{
Chuck Levera033db42010-12-14 14:57:22 +0000514 const struct nfs4_delegation *args = cb->cb_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 struct nfs4_cb_compound_hdr hdr = {
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400516 .ident = cb->cb_clp->cl_cb_ident,
J. Bruce Fieldsfb003922010-05-31 18:21:37 -0400517 .minorversion = cb->cb_minorversion,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 };
519
Chuck Lever9f06c712010-12-14 14:59:18 +0000520 encode_cb_compound4args(xdr, &hdr);
521 encode_cb_sequence4args(xdr, cb, &hdr);
522 encode_cb_recall4args(xdr, args, &hdr);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300523 encode_cb_nops(&hdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524}
525
526
Chuck Lever85a56482010-12-14 14:57:32 +0000527/*
528 * NFSv4.0 and NFSv4.1 XDR decode functions
529 *
530 * NFSv4.0 callback result types are defined in section 15 of RFC
531 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
532 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
533 * Protocol".
534 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Chuck Leverbf269552010-12-14 14:59:29 +0000536static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
537 void *__unused)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 return 0;
540}
541
Benny Halevy2af73582009-09-10 12:26:51 +0300542/*
Chuck Lever85a56482010-12-14 14:57:32 +0000543 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
Benny Halevy2af73582009-09-10 12:26:51 +0300544 */
Chuck Leverbf269552010-12-14 14:59:29 +0000545static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
546 struct xdr_stream *xdr,
Chuck Lever85a56482010-12-14 14:57:32 +0000547 struct nfsd4_callback *cb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 struct nfs4_cb_compound_hdr hdr;
Chuck Lever85a56482010-12-14 14:57:32 +0000550 enum nfsstat4 nfserr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 int status;
552
Chuck Leverbf269552010-12-14 14:59:29 +0000553 status = decode_cb_compound4res(xdr, &hdr);
Chuck Lever85a56482010-12-14 14:57:32 +0000554 if (unlikely(status))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 goto out;
Chuck Lever85a56482010-12-14 14:57:32 +0000556
557 if (cb != NULL) {
Chuck Leverbf269552010-12-14 14:59:29 +0000558 status = decode_cb_sequence4res(xdr, cb);
Chuck Lever85a56482010-12-14 14:57:32 +0000559 if (unlikely(status))
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300560 goto out;
561 }
Chuck Lever85a56482010-12-14 14:57:32 +0000562
Chuck Leverbf269552010-12-14 14:59:29 +0000563 status = decode_cb_op_status(xdr, OP_CB_RECALL, &nfserr);
Chuck Lever85a56482010-12-14 14:57:32 +0000564 if (unlikely(status))
565 goto out;
566 if (unlikely(nfserr != NFS4_OK))
Benny Halevy0af3f812011-01-13 11:25:31 +0200567 status = nfs_cb_stat_to_errno(nfserr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568out:
569 return status;
570}
571
572/*
573 * RPC procedure tables
574 */
Chuck Lever7d93bd712010-12-14 14:57:42 +0000575#define PROC(proc, call, argtype, restype) \
576[NFSPROC4_CLNT_##proc] = { \
577 .p_proc = NFSPROC4_CB_##call, \
Chuck Lever9f06c712010-12-14 14:59:18 +0000578 .p_encode = (kxdreproc_t)nfs4_xdr_enc_##argtype, \
Chuck Leverbf269552010-12-14 14:59:29 +0000579 .p_decode = (kxdrdproc_t)nfs4_xdr_dec_##restype, \
Chuck Lever7d93bd712010-12-14 14:57:42 +0000580 .p_arglen = NFS4_enc_##argtype##_sz, \
581 .p_replen = NFS4_dec_##restype##_sz, \
582 .p_statidx = NFSPROC4_CB_##call, \
583 .p_name = #proc, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584}
585
Chuck Lever7d93bd712010-12-14 14:57:42 +0000586static struct rpc_procinfo nfs4_cb_procedures[] = {
587 PROC(CB_NULL, NULL, cb_null, cb_null),
588 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589};
590
Chuck Lever7d93bd712010-12-14 14:57:42 +0000591static struct rpc_version nfs_cb_version4 = {
J. Bruce Fieldsb7299f42010-05-14 17:57:35 -0400592/*
593 * Note on the callback rpc program version number: despite language in rfc
594 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
595 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
596 * in practice that appears to be what implementations use. The section
597 * 18.36.3 language is expected to be fixed in an erratum.
598 */
Chuck Lever7d93bd712010-12-14 14:57:42 +0000599 .number = 1,
600 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
601 .procs = nfs4_cb_procedures
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602};
603
Chuck Lever7d93bd712010-12-14 14:57:42 +0000604static struct rpc_version *nfs_cb_version[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 &nfs_cb_version4,
606};
607
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400608static struct rpc_program cb_program;
609
610static struct rpc_stat cb_stats = {
Chuck Lever7d93bd712010-12-14 14:57:42 +0000611 .program = &cb_program
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400612};
613
614#define NFS4_CALLBACK 0x40000000
615static struct rpc_program cb_program = {
Chuck Lever7d93bd712010-12-14 14:57:42 +0000616 .name = "nfs4_cb",
617 .number = NFS4_CALLBACK,
618 .nrvers = ARRAY_SIZE(nfs_cb_version),
619 .version = nfs_cb_version,
620 .stats = &cb_stats,
621 .pipe_dir_name = "/nfsd4_cb",
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400622};
623
J. Bruce Fields595947a2009-03-05 17:18:10 -0500624static int max_cb_time(void)
625{
J. Bruce Fieldscf07d2e2010-02-28 23:20:19 -0500626 return max(nfsd4_lease/10, (time_t)1) * HZ;
J. Bruce Fields595947a2009-03-05 17:18:10 -0500627}
628
J. Bruce Fields2b47eec2007-07-27 18:06:50 -0400629
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400630static 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 -0400631{
Chuck Leverae5c7942006-08-22 20:06:21 -0400632 struct rpc_timeout timeparms = {
J. Bruce Fields595947a2009-03-05 17:18:10 -0500633 .to_initval = max_cb_time(),
634 .to_retries = 0,
Chuck Leverae5c7942006-08-22 20:06:21 -0400635 };
Chuck Leverae5c7942006-08-22 20:06:21 -0400636 struct rpc_create_args args = {
Pavel Emelyanovc653ce32010-09-29 16:04:45 +0400637 .net = &init_net,
J. Bruce Fields07263f12010-05-31 19:09:40 -0400638 .address = (struct sockaddr *) &conn->cb_addr,
639 .addrsize = conn->cb_addrlen,
Takuma Umeya6f3d7722010-12-15 14:09:01 +0900640 .saddress = (struct sockaddr *) &conn->cb_saddr,
Chuck Leverae5c7942006-08-22 20:06:21 -0400641 .timeout = &timeparms,
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400642 .program = &cb_program,
J. Bruce Fieldsb7299f42010-05-14 17:57:35 -0400643 .version = 0,
Olga Kornievskaia61054b12008-12-23 16:19:00 -0500644 .authflavor = clp->cl_flavor,
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400645 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
Chuck Leverae5c7942006-08-22 20:06:21 -0400646 };
J. Bruce Fields63c86712007-10-25 19:00:26 -0400647 struct rpc_clnt *client;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
J. Bruce Fields5d18c1c2010-10-19 23:00:12 -0400649 if (clp->cl_minorversion == 0) {
650 if (!clp->cl_principal && (clp->cl_flavor >= RPC_AUTH_GSS_KRB5))
651 return -EINVAL;
652 args.client_name = clp->cl_principal;
653 args.prognumber = conn->cb_prog,
654 args.protocol = XPRT_TRANSPORT_TCP;
655 clp->cl_cb_ident = conn->cb_ident;
656 } else {
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400657 if (!conn->cb_xprt)
658 return -EINVAL;
659 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
660 clp->cl_cb_session = ses;
J. Bruce Fields07263f12010-05-31 19:09:40 -0400661 args.bc_xprt = conn->cb_xprt;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400662 args.prognumber = clp->cl_cb_session->se_cb_prog;
Alexandros Batsakis3ddc8bf2009-09-10 12:27:21 +0300663 args.protocol = XPRT_TRANSPORT_BC_TCP;
664 }
Chuck Leverae5c7942006-08-22 20:06:21 -0400665 /* Create RPC client */
J. Bruce Fields63c86712007-10-25 19:00:26 -0400666 client = rpc_create(&args);
J. Bruce Fieldse1cab5a2009-02-23 10:45:27 -0800667 if (IS_ERR(client)) {
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800668 dprintk("NFSD: couldn't create callback client: %ld\n",
669 PTR_ERR(client));
J. Bruce Fieldse1cab5a2009-02-23 10:45:27 -0800670 return PTR_ERR(client);
671 }
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400672 clp->cl_cb_client = client;
J. Bruce Fieldse1cab5a2009-02-23 10:45:27 -0800673 return 0;
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800674
675}
676
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800677static void warn_no_callback_path(struct nfs4_client *clp, int reason)
678{
679 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
680 (int)clp->cl_name.len, clp->cl_name.data, reason);
681}
682
J. Bruce Fields77a35692010-04-30 18:51:44 -0400683static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
684{
685 clp->cl_cb_state = NFSD4_CB_DOWN;
686 warn_no_callback_path(clp, reason);
687}
688
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500689static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
690{
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400691 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500692
693 if (task->tk_status)
J. Bruce Fields77a35692010-04-30 18:51:44 -0400694 nfsd4_mark_cb_down(clp, task->tk_status);
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500695 else
J. Bruce Fields77a35692010-04-30 18:51:44 -0400696 clp->cl_cb_state = NFSD4_CB_UP;
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500697}
698
699static const struct rpc_call_ops nfsd4_cb_probe_ops = {
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400700 /* XXX: release method to ensure we set the cb channel down if
701 * necessary on early failure? */
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500702 .rpc_call_done = nfsd4_cb_probe_done,
703};
704
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400705static struct rpc_cred *callback_cred;
J. Bruce Fields3cef9ab2009-02-23 21:42:10 -0800706
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400707int set_callback_cred(void)
708{
J. Bruce Fields8d75da82010-03-03 16:13:29 -0500709 if (callback_cred)
710 return 0;
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400711 callback_cred = rpc_lookup_machine_cred();
712 if (!callback_cred)
713 return -ENOMEM;
714 return 0;
J. Bruce Fields3cef9ab2009-02-23 21:42:10 -0800715}
716
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400717static struct workqueue_struct *callback_wq;
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400718
J. Bruce Fields229b2a02010-12-10 17:37:44 -0500719static void run_nfsd4_cb(struct nfsd4_callback *cb)
720{
721 queue_work(callback_wq, &cb->cb_work);
722}
723
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400724static void do_probe_callback(struct nfs4_client *clp)
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800725{
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400726 struct nfsd4_callback *cb = &clp->cl_cb_null;
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800727
J. Bruce Fieldsfb003922010-05-31 18:21:37 -0400728 cb->cb_op = NULL;
729 cb->cb_clp = clp;
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400730
731 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL];
732 cb->cb_msg.rpc_argp = NULL;
733 cb->cb_msg.rpc_resp = NULL;
734 cb->cb_msg.rpc_cred = callback_cred;
735
736 cb->cb_ops = &nfsd4_cb_probe_ops;
737
J. Bruce Fields229b2a02010-12-10 17:37:44 -0500738 run_nfsd4_cb(cb);
J. Bruce Fields63c86712007-10-25 19:00:26 -0400739}
740
741/*
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400742 * Poke the callback thread to process any updates to the callback
743 * parameters, and send a null probe.
J. Bruce Fields63c86712007-10-25 19:00:26 -0400744 */
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400745void nfsd4_probe_callback(struct nfs4_client *clp)
746{
J. Bruce Fields77a35692010-04-30 18:51:44 -0400747 /* XXX: atomicity? Also, should we be using cl_cb_flags? */
748 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400749 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_cb_flags);
750 do_probe_callback(clp);
751}
752
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -0500753void nfsd4_probe_callback_sync(struct nfs4_client *clp)
754{
755 nfsd4_probe_callback(clp);
756 flush_workqueue(callback_wq);
757}
758
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400759void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
J. Bruce Fields63c86712007-10-25 19:00:26 -0400760{
J. Bruce Fields77a35692010-04-30 18:51:44 -0400761 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400762 spin_lock(&clp->cl_lock);
763 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400764 spin_unlock(&clp->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765}
766
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300767/*
768 * There's currently a single callback channel slot.
769 * If the slot is available, then mark it busy. Otherwise, set the
770 * thread for sleeping on the callback RPC wait queue.
771 */
J. Bruce Fields3ff36002011-01-10 16:37:51 -0500772static bool nfsd41_cb_get_slot(struct nfs4_client *clp, struct rpc_task *task)
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300773{
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300774 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
775 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
776 dprintk("%s slot is busy\n", __func__);
J. Bruce Fields3ff36002011-01-10 16:37:51 -0500777 return false;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300778 }
J. Bruce Fields3ff36002011-01-10 16:37:51 -0500779 return true;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300780}
781
782/*
783 * TODO: cb_sequence should support referring call lists, cachethis, multiple
784 * slots, and mark callback channel down on communication errors.
785 */
786static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
787{
J. Bruce Fields58784532010-05-16 16:47:08 -0400788 struct nfsd4_callback *cb = calldata;
789 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300790 struct nfs4_client *clp = dp->dl_client;
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400791 u32 minorversion = clp->cl_minorversion;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300792
J. Bruce Fieldsfb003922010-05-31 18:21:37 -0400793 cb->cb_minorversion = minorversion;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300794 if (minorversion) {
J. Bruce Fields3ff36002011-01-10 16:37:51 -0500795 if (!nfsd41_cb_get_slot(clp, task))
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300796 return;
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300797 }
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500798 spin_lock(&clp->cl_lock);
J. Bruce Fieldsa8f28002011-01-14 14:25:48 -0500799 if (list_empty(&cb->cb_per_client)) {
800 /* This is the first call, not a restart */
801 cb->cb_done = false;
802 list_add(&cb->cb_per_client, &clp->cl_callbacks);
803 }
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500804 spin_unlock(&clp->cl_lock);
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300805 rpc_call_start(task);
806}
807
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300808static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
809{
J. Bruce Fields58784532010-05-16 16:47:08 -0400810 struct nfsd4_callback *cb = calldata;
811 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300812 struct nfs4_client *clp = dp->dl_client;
813
814 dprintk("%s: minorversion=%d\n", __func__,
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400815 clp->cl_minorversion);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300816
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400817 if (clp->cl_minorversion) {
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300818 /* No need for lock, access serialized in nfsd4_cb_prepare */
J. Bruce Fieldsac7c46f2010-06-14 19:01:57 -0400819 ++clp->cl_cb_session->se_cb_seq_nr;
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300820 clear_bit(0, &clp->cl_cb_slot_busy);
821 rpc_wake_up_next(&clp->cl_cb_waitq);
822 dprintk("%s: freed slot, new seqid=%d\n", __func__,
J. Bruce Fieldsac7c46f2010-06-14 19:01:57 -0400823 clp->cl_cb_session->se_cb_seq_nr);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300824
825 /* We're done looking into the sequence information */
826 task->tk_msg.rpc_resp = NULL;
827 }
828}
829
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500830
J. Bruce Fields63e48632009-05-01 22:36:55 -0400831static void nfsd4_cb_recall_done(struct rpc_task *task, void *calldata)
832{
J. Bruce Fields58784532010-05-16 16:47:08 -0400833 struct nfsd4_callback *cb = calldata;
834 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
J. Bruce Fields63e48632009-05-01 22:36:55 -0400835 struct nfs4_client *clp = dp->dl_client;
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500836 struct rpc_clnt *current_rpc_client = clp->cl_cb_client;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400837
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300838 nfsd4_cb_done(task, calldata);
839
J. Bruce Fieldsa8f28002011-01-14 14:25:48 -0500840 if (current_rpc_client != task->tk_client) {
841 /* We're shutting down or changing cl_cb_client; leave
842 * it to nfsd4_process_cb_update to restart the call if
843 * necessary. */
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500844 return;
845 }
846
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500847 if (cb->cb_done)
848 return;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400849 switch (task->tk_status) {
J. Bruce Fields172c85d2010-05-30 11:53:12 -0400850 case 0:
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500851 cb->cb_done = true;
J. Bruce Fields172c85d2010-05-30 11:53:12 -0400852 return;
853 case -EBADHANDLE:
854 case -NFS4ERR_BAD_STATEID:
855 /* Race: client probably got cb_recall
856 * before open reply granting delegation */
857 break;
858 default:
J. Bruce Fields63e48632009-05-01 22:36:55 -0400859 /* Network partition? */
J. Bruce Fields77a35692010-04-30 18:51:44 -0400860 nfsd4_mark_cb_down(clp, task->tk_status);
J. Bruce Fields63e48632009-05-01 22:36:55 -0400861 }
862 if (dp->dl_retries--) {
863 rpc_delay(task, 2*HZ);
864 task->tk_status = 0;
Boaz Harroshc18c8212010-06-29 14:33:55 +0300865 rpc_restart_call_prepare(task);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300866 return;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400867 }
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500868 nfsd4_mark_cb_down(clp, task->tk_status);
869 cb->cb_done = true;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400870}
871
872static void nfsd4_cb_recall_release(void *calldata)
873{
J. Bruce Fields58784532010-05-16 16:47:08 -0400874 struct nfsd4_callback *cb = calldata;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500875 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fields58784532010-05-16 16:47:08 -0400876 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
J. Bruce Fields63e48632009-05-01 22:36:55 -0400877
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500878 if (cb->cb_done) {
879 spin_lock(&clp->cl_lock);
880 list_del(&cb->cb_per_client);
881 spin_unlock(&clp->cl_lock);
882 nfs4_put_delegation(dp);
883 }
J. Bruce Fields63e48632009-05-01 22:36:55 -0400884}
885
886static const struct rpc_call_ops nfsd4_cb_recall_ops = {
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300887 .rpc_call_prepare = nfsd4_cb_prepare,
J. Bruce Fields63e48632009-05-01 22:36:55 -0400888 .rpc_call_done = nfsd4_cb_recall_done,
889 .rpc_release = nfsd4_cb_recall_release,
890};
891
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500892int nfsd4_create_callback_queue(void)
893{
894 callback_wq = create_singlethread_workqueue("nfsd4_callbacks");
895 if (!callback_wq)
896 return -ENOMEM;
897 return 0;
898}
899
900void nfsd4_destroy_callback_queue(void)
901{
902 destroy_workqueue(callback_wq);
903}
904
Benny Halevyab707e12010-05-12 00:14:06 +0300905/* must be called under the state lock */
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400906void nfsd4_shutdown_callback(struct nfs4_client *clp)
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500907{
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400908 set_bit(NFSD4_CLIENT_KILL, &clp->cl_cb_flags);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500909 /*
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400910 * Note this won't actually result in a null callback;
911 * instead, nfsd4_do_callback_rpc() will detect the killed
912 * client, destroy the rpc client, and stop:
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500913 */
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400914 do_probe_callback(clp);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500915 flush_workqueue(callback_wq);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500916}
917
Kirill A. Shutemov65e4c892010-12-16 15:25:54 +0200918static void nfsd4_release_cb(struct nfsd4_callback *cb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919{
J. Bruce Fields58784532010-05-16 16:47:08 -0400920 if (cb->cb_ops->rpc_release)
921 cb->cb_ops->rpc_release(cb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922}
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500923
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400924/* requires cl_lock: */
925static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
926{
927 struct nfsd4_session *s;
928 struct nfsd4_conn *c;
929
930 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
931 list_for_each_entry(c, &s->se_conns, cn_persession) {
932 if (c->cn_flags & NFS4_CDFC4_BACK)
933 return c;
934 }
935 }
936 return NULL;
937}
938
Kirill A. Shutemov65e4c892010-12-16 15:25:54 +0200939static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400940{
941 struct nfs4_cb_conn conn;
942 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400943 struct nfsd4_session *ses = NULL;
944 struct nfsd4_conn *c;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400945 int err;
946
947 /*
948 * This is either an update, or the client dying; in either case,
949 * kill the old client:
950 */
951 if (clp->cl_cb_client) {
952 rpc_shutdown_client(clp->cl_cb_client);
953 clp->cl_cb_client = NULL;
954 }
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400955 if (clp->cl_cb_conn.cb_xprt) {
956 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
957 clp->cl_cb_conn.cb_xprt = NULL;
958 }
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400959 if (test_bit(NFSD4_CLIENT_KILL, &clp->cl_cb_flags))
960 return;
961 spin_lock(&clp->cl_lock);
962 /*
963 * Only serialized callback code is allowed to clear these
964 * flags; main nfsd code can only set them:
965 */
966 BUG_ON(!clp->cl_cb_flags);
967 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_cb_flags);
968 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400969 c = __nfsd4_find_backchannel(clp);
970 if (c) {
971 svc_xprt_get(c->cn_xprt);
972 conn.cb_xprt = c->cn_xprt;
973 ses = c->cn_session;
974 }
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400975 spin_unlock(&clp->cl_lock);
976
J. Bruce Fieldsdcbeaa62010-06-15 17:25:45 -0400977 err = setup_callback_client(clp, &conn, ses);
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500978 if (err) {
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400979 warn_no_callback_path(clp, err);
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500980 return;
981 }
982 /* Yay, the callback channel's back! Restart any callbacks: */
983 list_for_each_entry(cb, &clp->cl_callbacks, cb_per_client)
984 run_nfsd4_cb(cb);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400985}
986
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500987void nfsd4_do_callback_rpc(struct work_struct *w)
988{
J. Bruce Fields58784532010-05-16 16:47:08 -0400989 struct nfsd4_callback *cb = container_of(w, struct nfsd4_callback, cb_work);
J. Bruce Fieldsfb003922010-05-31 18:21:37 -0400990 struct nfs4_client *clp = cb->cb_clp;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400991 struct rpc_clnt *clnt;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500992
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400993 if (clp->cl_cb_flags)
994 nfsd4_process_cb_update(cb);
995
996 clnt = clp->cl_cb_client;
997 if (!clnt) {
998 /* Callback channel broken, or client killed; give up: */
J. Bruce Fields58784532010-05-16 16:47:08 -0400999 nfsd4_release_cb(cb);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -04001000 return;
J. Bruce Fields58784532010-05-16 16:47:08 -04001001 }
J. Bruce Fieldscee277d2010-05-26 17:52:14 -04001002 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
1003 cb->cb_ops, cb);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001004}
1005
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001006void nfsd4_cb_recall(struct nfs4_delegation *dp)
1007{
J. Bruce Fields58784532010-05-16 16:47:08 -04001008 struct nfsd4_callback *cb = &dp->dl_recall;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001009 struct nfs4_client *clp = dp->dl_client;
J. Bruce Fields58784532010-05-16 16:47:08 -04001010
1011 dp->dl_retries = 1;
J. Bruce Fieldsfb003922010-05-31 18:21:37 -04001012 cb->cb_op = dp;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001013 cb->cb_clp = clp;
J. Bruce Fields58784532010-05-16 16:47:08 -04001014 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL];
J. Bruce Fieldsfb003922010-05-31 18:21:37 -04001015 cb->cb_msg.rpc_argp = cb;
1016 cb->cb_msg.rpc_resp = cb;
J. Bruce Fields58784532010-05-16 16:47:08 -04001017 cb->cb_msg.rpc_cred = callback_cred;
1018
1019 cb->cb_ops = &nfsd4_cb_recall_ops;
1020 dp->dl_retries = 1;
1021
J. Bruce Fields9ee1ba52011-01-13 17:08:19 -05001022 INIT_LIST_HEAD(&cb->cb_per_client);
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -05001023 cb->cb_done = true;
1024
J. Bruce Fields229b2a02010-12-10 17:37:44 -05001025 run_nfsd4_cb(&dp->dl_recall);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -05001026}