nfsd: use service net instead of hard-coded net where possible
[linux-2.6-block.git] / fs / nfsd / nfs4callback.c
CommitLineData
1da177e4 1/*
1da177e4
LT
2 * Copyright (c) 2001 The Regents of the University of Michigan.
3 * All rights reserved.
4 *
5 * Kendrick Smith <kmsmith@umich.edu>
6 * Andy Adamson <andros@umich.edu>
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the University nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
22 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
1da177e4 34#include <linux/sunrpc/clnt.h>
b5a1a81e 35#include <linux/sunrpc/svc_xprt.h>
5a0e3ad6 36#include <linux/slab.h>
9a74af21
BH
37#include "nfsd.h"
38#include "state.h"
1da177e4
LT
39
40#define NFSDDBG_FACILITY NFSDDBG_PROC
41
5423732a
BH
42static void nfsd4_mark_cb_fault(struct nfs4_client *, int reason);
43
1da177e4
LT
44#define NFSPROC4_CB_NULL 0
45#define NFSPROC4_CB_COMPOUND 1
46
1da177e4
LT
47/* Index of predefined Linux callback client operations */
48
49enum {
4be36ca0 50 NFSPROC4_CLNT_CB_NULL = 0,
1da177e4 51 NFSPROC4_CLNT_CB_RECALL,
38524ab3 52 NFSPROC4_CLNT_CB_SEQUENCE,
1da177e4
LT
53};
54
1da177e4
LT
55#define NFS4_MAXTAGLEN 20
56
57#define NFS4_enc_cb_null_sz 0
58#define NFS4_dec_cb_null_sz 0
59#define cb_compound_enc_hdr_sz 4
60#define cb_compound_dec_hdr_sz (3 + (NFS4_MAXTAGLEN >> 2))
38524ab3
AA
61#define sessionid_sz (NFS4_MAX_SESSIONID_LEN >> 2)
62#define cb_sequence_enc_sz (sessionid_sz + 4 + \
63 1 /* no referring calls list yet */)
64#define cb_sequence_dec_sz (op_dec_sz + sessionid_sz + 4)
65
1da177e4
LT
66#define op_enc_sz 1
67#define op_dec_sz 2
68#define enc_nfs4_fh_sz (1 + (NFS4_FHSIZE >> 2))
0ac68d17 69#define enc_stateid_sz (NFS4_STATEID_SIZE >> 2)
1da177e4 70#define NFS4_enc_cb_recall_sz (cb_compound_enc_hdr_sz + \
38524ab3 71 cb_sequence_enc_sz + \
1da177e4
LT
72 1 + enc_stateid_sz + \
73 enc_nfs4_fh_sz)
74
75#define NFS4_dec_cb_recall_sz (cb_compound_dec_hdr_sz + \
38524ab3 76 cb_sequence_dec_sz + \
1da177e4
LT
77 op_dec_sz)
78
1da177e4 79struct nfs4_cb_compound_hdr {
38524ab3
AA
80 /* args */
81 u32 ident; /* minorversion 0 only */
1da177e4 82 u32 nops;
ef52bff8 83 __be32 *nops_p;
ab52ae6d 84 u32 minorversion;
38524ab3
AA
85 /* res */
86 int status;
1da177e4
LT
87};
88
85a56480
CL
89/*
90 * Handle decode buffer overflows out-of-line.
91 */
92static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
1da177e4 93{
85a56480
CL
94 dprintk("NFS: %s prematurely hit the end of our receive buffer. "
95 "Remaining buffer length is %tu words.\n",
96 func, xdr->end - xdr->p);
1da177e4
LT
97}
98
a033db48
CL
99static __be32 *xdr_encode_empty_array(__be32 *p)
100{
101 *p++ = xdr_zero;
102 return p;
103}
104
105/*
106 * Encode/decode NFSv4 CB basic data types
107 *
108 * Basic NFSv4 callback data types are defined in section 15 of RFC
109 * 3530: "Network File System (NFS) version 4 Protocol" and section
110 * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version
111 * 1 Protocol"
112 */
113
114/*
115 * nfs_cb_opnum4
116 *
117 * enum nfs_cb_opnum4 {
118 * OP_CB_GETATTR = 3,
119 * ...
120 * };
121 */
122enum nfs_cb_opnum4 {
123 OP_CB_GETATTR = 3,
124 OP_CB_RECALL = 4,
125 OP_CB_LAYOUTRECALL = 5,
126 OP_CB_NOTIFY = 6,
127 OP_CB_PUSH_DELEG = 7,
128 OP_CB_RECALL_ANY = 8,
129 OP_CB_RECALLABLE_OBJ_AVAIL = 9,
130 OP_CB_RECALL_SLOT = 10,
131 OP_CB_SEQUENCE = 11,
132 OP_CB_WANTS_CANCELLED = 12,
133 OP_CB_NOTIFY_LOCK = 13,
134 OP_CB_NOTIFY_DEVICEID = 14,
135 OP_CB_ILLEGAL = 10044
136};
137
138static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op)
139{
140 __be32 *p;
141
142 p = xdr_reserve_space(xdr, 4);
143 *p = cpu_to_be32(op);
144}
145
146/*
147 * nfs_fh4
148 *
149 * typedef opaque nfs_fh4<NFS4_FHSIZE>;
150 */
151static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh)
152{
153 u32 length = fh->fh_size;
154 __be32 *p;
155
156 BUG_ON(length > NFS4_FHSIZE);
157 p = xdr_reserve_space(xdr, 4 + length);
158 xdr_encode_opaque(p, &fh->fh_base, length);
159}
160
1da177e4 161/*
a033db48
CL
162 * stateid4
163 *
164 * struct stateid4 {
165 * uint32_t seqid;
166 * opaque other[12];
167 * };
1da177e4 168 */
a033db48
CL
169static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid)
170{
171 __be32 *p;
1da177e4 172
a033db48
CL
173 p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE);
174 *p++ = cpu_to_be32(sid->si_generation);
175 xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE);
176}
177
178/*
179 * sessionid4
180 *
181 * typedef opaque sessionid4[NFS4_SESSIONID_SIZE];
182 */
183static void encode_sessionid4(struct xdr_stream *xdr,
184 const struct nfsd4_session *session)
9303bbd3
BH
185{
186 __be32 *p;
187
a033db48
CL
188 p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN);
189 xdr_encode_opaque_fixed(p, session->se_sessionid.data,
190 NFS4_MAX_SESSIONID_LEN);
9303bbd3
BH
191}
192
85a56480
CL
193/*
194 * nfsstat4
195 */
196static const struct {
197 int stat;
198 int errno;
199} nfs_cb_errtbl[] = {
200 { NFS4_OK, 0 },
201 { NFS4ERR_PERM, -EPERM },
202 { NFS4ERR_NOENT, -ENOENT },
203 { NFS4ERR_IO, -EIO },
204 { NFS4ERR_NXIO, -ENXIO },
205 { NFS4ERR_ACCESS, -EACCES },
206 { NFS4ERR_EXIST, -EEXIST },
207 { NFS4ERR_XDEV, -EXDEV },
208 { NFS4ERR_NOTDIR, -ENOTDIR },
209 { NFS4ERR_ISDIR, -EISDIR },
210 { NFS4ERR_INVAL, -EINVAL },
211 { NFS4ERR_FBIG, -EFBIG },
212 { NFS4ERR_NOSPC, -ENOSPC },
213 { NFS4ERR_ROFS, -EROFS },
214 { NFS4ERR_MLINK, -EMLINK },
215 { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG },
216 { NFS4ERR_NOTEMPTY, -ENOTEMPTY },
217 { NFS4ERR_DQUOT, -EDQUOT },
218 { NFS4ERR_STALE, -ESTALE },
219 { NFS4ERR_BADHANDLE, -EBADHANDLE },
220 { NFS4ERR_BAD_COOKIE, -EBADCOOKIE },
221 { NFS4ERR_NOTSUPP, -ENOTSUPP },
222 { NFS4ERR_TOOSMALL, -ETOOSMALL },
223 { NFS4ERR_SERVERFAULT, -ESERVERFAULT },
224 { NFS4ERR_BADTYPE, -EBADTYPE },
225 { NFS4ERR_LOCKED, -EAGAIN },
226 { NFS4ERR_RESOURCE, -EREMOTEIO },
227 { NFS4ERR_SYMLINK, -ELOOP },
228 { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP },
229 { NFS4ERR_DEADLOCK, -EDEADLK },
230 { -1, -EIO }
231};
232
233/*
234 * If we cannot translate the error, the recovery routines should
235 * handle it.
236 *
237 * Note: remaining NFSv4 error codes have values > 10000, so should
238 * not conflict with native Linux error codes.
239 */
240static int nfs_cb_stat_to_errno(int status)
241{
242 int i;
243
244 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
245 if (nfs_cb_errtbl[i].stat == status)
246 return nfs_cb_errtbl[i].errno;
247 }
248
249 dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status);
250 return -status;
251}
252
253static int decode_cb_op_status(struct xdr_stream *xdr, enum nfs_opnum4 expected,
254 enum nfsstat4 *status)
255{
256 __be32 *p;
257 u32 op;
258
259 p = xdr_inline_decode(xdr, 4 + 4);
260 if (unlikely(p == NULL))
261 goto out_overflow;
262 op = be32_to_cpup(p++);
263 if (unlikely(op != expected))
264 goto out_unexpected;
265 *status = be32_to_cpup(p);
266 return 0;
267out_overflow:
268 print_overflow_msg(__func__, xdr);
269 return -EIO;
270out_unexpected:
271 dprintk("NFSD: Callback server returned operation %d but "
272 "we issued a request for %d\n", op, expected);
273 return -EIO;
274}
275
a033db48
CL
276/*
277 * CB_COMPOUND4args
278 *
279 * struct CB_COMPOUND4args {
280 * utf8str_cs tag;
281 * uint32_t minorversion;
282 * uint32_t callback_ident;
283 * nfs_cb_argop4 argarray<>;
284 * };
285*/
286static void encode_cb_compound4args(struct xdr_stream *xdr,
287 struct nfs4_cb_compound_hdr *hdr)
1da177e4 288{
f00f328f 289 __be32 * p;
1da177e4 290
a033db48
CL
291 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4);
292 p = xdr_encode_empty_array(p); /* empty tag */
293 *p++ = cpu_to_be32(hdr->minorversion);
294 *p++ = cpu_to_be32(hdr->ident);
295
ef52bff8 296 hdr->nops_p = p;
a033db48 297 *p = cpu_to_be32(hdr->nops); /* argarray element count */
1da177e4
LT
298}
299
a033db48
CL
300/*
301 * Update argarray element count
302 */
ef52bff8
AA
303static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
304{
a033db48
CL
305 BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS);
306 *hdr->nops_p = cpu_to_be32(hdr->nops);
ef52bff8
AA
307}
308
85a56480
CL
309/*
310 * CB_COMPOUND4res
311 *
312 * struct CB_COMPOUND4res {
313 * nfsstat4 status;
314 * utf8str_cs tag;
315 * nfs_cb_resop4 resarray<>;
316 * };
317 */
318static int decode_cb_compound4res(struct xdr_stream *xdr,
319 struct nfs4_cb_compound_hdr *hdr)
320{
321 u32 length;
322 __be32 *p;
323
324 p = xdr_inline_decode(xdr, 4 + 4);
325 if (unlikely(p == NULL))
326 goto out_overflow;
327 hdr->status = be32_to_cpup(p++);
328 /* Ignore the tag */
329 length = be32_to_cpup(p++);
330 p = xdr_inline_decode(xdr, length + 4);
331 if (unlikely(p == NULL))
332 goto out_overflow;
333 hdr->nops = be32_to_cpup(p);
334 return 0;
335out_overflow:
336 print_overflow_msg(__func__, xdr);
337 return -EIO;
338}
339
a033db48
CL
340/*
341 * CB_RECALL4args
342 *
343 * struct CB_RECALL4args {
344 * stateid4 stateid;
345 * bool truncate;
346 * nfs_fh4 fh;
347 * };
348 */
349static void encode_cb_recall4args(struct xdr_stream *xdr,
350 const struct nfs4_delegation *dp,
351 struct nfs4_cb_compound_hdr *hdr)
1da177e4 352{
f00f328f 353 __be32 *p;
a033db48
CL
354
355 encode_nfs_cb_opnum4(xdr, OP_CB_RECALL);
d5477a8d 356 encode_stateid4(xdr, &dp->dl_stid.sc_stateid);
a033db48
CL
357
358 p = xdr_reserve_space(xdr, 4);
359 *p++ = xdr_zero; /* truncate */
360
361 encode_nfs_fh4(xdr, &dp->dl_fh);
362
ef52bff8 363 hdr->nops++;
1da177e4
LT
364}
365
a033db48
CL
366/*
367 * CB_SEQUENCE4args
368 *
369 * struct CB_SEQUENCE4args {
370 * sessionid4 csa_sessionid;
371 * sequenceid4 csa_sequenceid;
372 * slotid4 csa_slotid;
373 * slotid4 csa_highest_slotid;
374 * bool csa_cachethis;
375 * referring_call_list4 csa_referring_call_lists<>;
376 * };
377 */
378static void encode_cb_sequence4args(struct xdr_stream *xdr,
379 const struct nfsd4_callback *cb,
380 struct nfs4_cb_compound_hdr *hdr)
2af73580 381{
a033db48 382 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
2af73580
BH
383 __be32 *p;
384
385 if (hdr->minorversion == 0)
386 return;
387
a033db48
CL
388 encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE);
389 encode_sessionid4(xdr, session);
390
391 p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4);
392 *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */
393 *p++ = xdr_zero; /* csa_slotid */
394 *p++ = xdr_zero; /* csa_highest_slotid */
395 *p++ = xdr_zero; /* csa_cachethis */
396 xdr_encode_empty_array(p); /* csa_referring_call_lists */
2af73580 397
2af73580
BH
398 hdr->nops++;
399}
400
85a56480
CL
401/*
402 * CB_SEQUENCE4resok
403 *
404 * struct CB_SEQUENCE4resok {
405 * sessionid4 csr_sessionid;
406 * sequenceid4 csr_sequenceid;
407 * slotid4 csr_slotid;
408 * slotid4 csr_highest_slotid;
409 * slotid4 csr_target_highest_slotid;
410 * };
411 *
412 * union CB_SEQUENCE4res switch (nfsstat4 csr_status) {
413 * case NFS4_OK:
414 * CB_SEQUENCE4resok csr_resok4;
415 * default:
416 * void;
417 * };
418 *
419 * Our current back channel implmentation supports a single backchannel
420 * with a single slot.
421 */
422static int decode_cb_sequence4resok(struct xdr_stream *xdr,
423 struct nfsd4_callback *cb)
424{
425 struct nfsd4_session *session = cb->cb_clp->cl_cb_session;
426 struct nfs4_sessionid id;
427 int status;
428 __be32 *p;
429 u32 dummy;
430
431 status = -ESERVERFAULT;
432
433 /*
434 * If the server returns different values for sessionID, slotID or
435 * sequence number, the server is looney tunes.
436 */
2c9c8f36 437 p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4);
85a56480
CL
438 if (unlikely(p == NULL))
439 goto out_overflow;
440 memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
441 if (memcmp(id.data, session->se_sessionid.data,
442 NFS4_MAX_SESSIONID_LEN) != 0) {
443 dprintk("NFS: %s Invalid session id\n", __func__);
444 goto out;
445 }
446 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
447
448 dummy = be32_to_cpup(p++);
449 if (dummy != session->se_cb_seq_nr) {
450 dprintk("NFS: %s Invalid sequence number\n", __func__);
451 goto out;
452 }
453
454 dummy = be32_to_cpup(p++);
455 if (dummy != 0) {
456 dprintk("NFS: %s Invalid slotid\n", __func__);
457 goto out;
458 }
459
460 /*
461 * FIXME: process highest slotid and target highest slotid
462 */
463 status = 0;
464out:
5423732a
BH
465 if (status)
466 nfsd4_mark_cb_fault(cb->cb_clp, status);
85a56480
CL
467 return status;
468out_overflow:
469 print_overflow_msg(__func__, xdr);
470 return -EIO;
471}
472
473static int decode_cb_sequence4res(struct xdr_stream *xdr,
474 struct nfsd4_callback *cb)
475{
476 enum nfsstat4 nfserr;
477 int status;
478
479 if (cb->cb_minorversion == 0)
480 return 0;
481
482 status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &nfserr);
483 if (unlikely(status))
484 goto out;
485 if (unlikely(nfserr != NFS4_OK))
486 goto out_default;
487 status = decode_cb_sequence4resok(xdr, cb);
488out:
489 return status;
490out_default:
0af3f814 491 return nfs_cb_stat_to_errno(nfserr);
85a56480
CL
492}
493
a033db48
CL
494/*
495 * NFSv4.0 and NFSv4.1 XDR encode functions
496 *
497 * NFSv4.0 callback argument types are defined in section 15 of RFC
498 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
499 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
500 * Protocol".
501 */
502
503/*
504 * NB: Without this zero space reservation, callbacks over krb5p fail
505 */
9f06c719
CL
506static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
507 void *__unused)
1da177e4 508{
a033db48 509 xdr_reserve_space(xdr, 0);
1da177e4
LT
510}
511
a033db48
CL
512/*
513 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
514 */
9f06c719
CL
515static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr,
516 const struct nfsd4_callback *cb)
1da177e4 517{
a033db48 518 const struct nfs4_delegation *args = cb->cb_op;
1da177e4 519 struct nfs4_cb_compound_hdr hdr = {
6ff8da08 520 .ident = cb->cb_clp->cl_cb_ident,
fb003923 521 .minorversion = cb->cb_minorversion,
1da177e4
LT
522 };
523
9f06c719
CL
524 encode_cb_compound4args(xdr, &hdr);
525 encode_cb_sequence4args(xdr, cb, &hdr);
526 encode_cb_recall4args(xdr, args, &hdr);
ef52bff8 527 encode_cb_nops(&hdr);
1da177e4
LT
528}
529
530
2af73580 531/*
85a56480
CL
532 * NFSv4.0 and NFSv4.1 XDR decode functions
533 *
534 * NFSv4.0 callback result types are defined in section 15 of RFC
535 * 3530: "Network File System (NFS) version 4 Protocol" and section 20
536 * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1
537 * Protocol".
2af73580 538 */
2af73580 539
bf269551
CL
540static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr,
541 void *__unused)
1da177e4
LT
542{
543 return 0;
544}
545
85a56480
CL
546/*
547 * 20.2. Operation 4: CB_RECALL - Recall a Delegation
548 */
bf269551
CL
549static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp,
550 struct xdr_stream *xdr,
85a56480 551 struct nfsd4_callback *cb)
1da177e4 552{
1da177e4 553 struct nfs4_cb_compound_hdr hdr;
85a56480 554 enum nfsstat4 nfserr;
1da177e4
LT
555 int status;
556
bf269551 557 status = decode_cb_compound4res(xdr, &hdr);
85a56480 558 if (unlikely(status))
1da177e4 559 goto out;
85a56480
CL
560
561 if (cb != NULL) {
bf269551 562 status = decode_cb_sequence4res(xdr, cb);
85a56480 563 if (unlikely(status))
0421b5c5
RL
564 goto out;
565 }
85a56480 566
bf269551 567 status = decode_cb_op_status(xdr, OP_CB_RECALL, &nfserr);
85a56480
CL
568 if (unlikely(status))
569 goto out;
570 if (unlikely(nfserr != NFS4_OK))
0af3f814 571 status = nfs_cb_stat_to_errno(nfserr);
1da177e4
LT
572out:
573 return status;
574}
575
576/*
577 * RPC procedure tables
578 */
7d93bd71
CL
579#define PROC(proc, call, argtype, restype) \
580[NFSPROC4_CLNT_##proc] = { \
581 .p_proc = NFSPROC4_CB_##call, \
9f06c719 582 .p_encode = (kxdreproc_t)nfs4_xdr_enc_##argtype, \
bf269551 583 .p_decode = (kxdrdproc_t)nfs4_xdr_dec_##restype, \
7d93bd71
CL
584 .p_arglen = NFS4_enc_##argtype##_sz, \
585 .p_replen = NFS4_dec_##restype##_sz, \
586 .p_statidx = NFSPROC4_CB_##call, \
587 .p_name = #proc, \
1da177e4
LT
588}
589
7d93bd71
CL
590static struct rpc_procinfo nfs4_cb_procedures[] = {
591 PROC(CB_NULL, NULL, cb_null, cb_null),
592 PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall),
1da177e4
LT
593};
594
7d93bd71 595static struct rpc_version nfs_cb_version4 = {
b7299f44
BF
596/*
597 * Note on the callback rpc program version number: despite language in rfc
598 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
599 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
600 * in practice that appears to be what implementations use. The section
601 * 18.36.3 language is expected to be fixed in an erratum.
602 */
7d93bd71
CL
603 .number = 1,
604 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
605 .procs = nfs4_cb_procedures
1da177e4
LT
606};
607
a613fa16 608static const struct rpc_version *nfs_cb_version[] = {
1da177e4
LT
609 &nfs_cb_version4,
610};
611
a613fa16 612static const struct rpc_program cb_program;
ff7d9756
OK
613
614static struct rpc_stat cb_stats = {
7d93bd71 615 .program = &cb_program
ff7d9756
OK
616};
617
618#define NFS4_CALLBACK 0x40000000
a613fa16 619static const struct rpc_program cb_program = {
7d93bd71
CL
620 .name = "nfs4_cb",
621 .number = NFS4_CALLBACK,
622 .nrvers = ARRAY_SIZE(nfs_cb_version),
623 .version = nfs_cb_version,
624 .stats = &cb_stats,
0157d021 625 .pipe_dir_name = "nfsd4_cb",
ff7d9756
OK
626};
627
595947ac
BF
628static int max_cb_time(void)
629{
cf07d2ea 630 return max(nfsd4_lease/10, (time_t)1) * HZ;
595947ac
BF
631}
632
c6bb3ca2
BF
633static struct rpc_cred *callback_cred;
634
635int set_callback_cred(void)
636{
637 if (callback_cred)
638 return 0;
639 callback_cred = rpc_lookup_machine_cred("nfs");
640 if (!callback_cred)
641 return -ENOMEM;
642 return 0;
643}
644
2b4cf668 645static struct rpc_cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses)
c6bb3ca2
BF
646{
647 if (clp->cl_minorversion == 0) {
648 return get_rpccred(callback_cred);
649 } else {
650 struct rpc_auth *auth = client->cl_auth;
651 struct auth_cred acred = {};
652
653 acred.uid = ses->se_cb_sec.uid;
654 acred.gid = ses->se_cb_sec.gid;
655 return auth->au_ops->lookup_cred(client->cl_auth, &acred, 0);
656 }
657}
2b47eece 658
dcbeaa68 659static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
2b47eece 660{
ae5c7947 661 struct rpc_timeout timeparms = {
595947ac
BF
662 .to_initval = max_cb_time(),
663 .to_retries = 0,
ae5c7947 664 };
ae5c7947 665 struct rpc_create_args args = {
c653ce3f 666 .net = &init_net,
07263f1e
BF
667 .address = (struct sockaddr *) &conn->cb_addr,
668 .addrsize = conn->cb_addrlen,
6f3d772f 669 .saddress = (struct sockaddr *) &conn->cb_saddr,
ae5c7947 670 .timeout = &timeparms,
ff7d9756 671 .program = &cb_program,
b7299f44 672 .version = 0,
b6b6152c 673 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
ae5c7947 674 };
63c86716 675 struct rpc_clnt *client;
c6bb3ca2 676 struct rpc_cred *cred;
1da177e4 677
5d18c1c2 678 if (clp->cl_minorversion == 0) {
03a4e1f6 679 if (!clp->cl_cred.cr_principal &&
39307655 680 (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5))
5d18c1c2 681 return -EINVAL;
03a4e1f6 682 args.client_name = clp->cl_cred.cr_principal;
5d18c1c2
BF
683 args.prognumber = conn->cb_prog,
684 args.protocol = XPRT_TRANSPORT_TCP;
39307655 685 args.authflavor = clp->cl_cred.cr_flavor;
5d18c1c2
BF
686 clp->cl_cb_ident = conn->cb_ident;
687 } else {
dcbeaa68
BF
688 if (!conn->cb_xprt)
689 return -EINVAL;
690 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
691 clp->cl_cb_session = ses;
07263f1e 692 args.bc_xprt = conn->cb_xprt;
8b5ce5cd 693 args.prognumber = clp->cl_cb_session->se_cb_prog;
3ddc8bf5 694 args.protocol = XPRT_TRANSPORT_BC_TCP;
12fc3e92 695 args.authflavor = ses->se_cb_sec.flavor;
3ddc8bf5 696 }
ae5c7947 697 /* Create RPC client */
63c86716 698 client = rpc_create(&args);
e1cab5a5 699 if (IS_ERR(client)) {
a601caed
BF
700 dprintk("NFSD: couldn't create callback client: %ld\n",
701 PTR_ERR(client));
e1cab5a5
BF
702 return PTR_ERR(client);
703 }
c6bb3ca2
BF
704 cred = get_backchannel_cred(clp, client, ses);
705 if (IS_ERR(cred)) {
706 rpc_shutdown_client(client);
707 return PTR_ERR(cred);
708 }
6ff8da08 709 clp->cl_cb_client = client;
c6bb3ca2 710 clp->cl_cb_cred = cred;
e1cab5a5 711 return 0;
a601caed
BF
712}
713
ecdd03b7
BF
714static void warn_no_callback_path(struct nfs4_client *clp, int reason)
715{
716 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
717 (int)clp->cl_name.len, clp->cl_name.data, reason);
718}
719
77a3569d
BF
720static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
721{
722 clp->cl_cb_state = NFSD4_CB_DOWN;
723 warn_no_callback_path(clp, reason);
724}
725
5423732a
BH
726static void nfsd4_mark_cb_fault(struct nfs4_client *clp, int reason)
727{
728 clp->cl_cb_state = NFSD4_CB_FAULT;
729 warn_no_callback_path(clp, reason);
730}
731
e300a63c
BF
732static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
733{
cee277d9 734 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
e300a63c
BF
735
736 if (task->tk_status)
77a3569d 737 nfsd4_mark_cb_down(clp, task->tk_status);
e300a63c 738 else
77a3569d 739 clp->cl_cb_state = NFSD4_CB_UP;
e300a63c
BF
740}
741
742static const struct rpc_call_ops nfsd4_cb_probe_ops = {
cee277d9
BF
743 /* XXX: release method to ensure we set the cb channel down if
744 * necessary on early failure? */
e300a63c
BF
745 .rpc_call_done = nfsd4_cb_probe_done,
746};
747
cee277d9 748static struct workqueue_struct *callback_wq;
80fc015b 749
229b2a08
BF
750static void run_nfsd4_cb(struct nfsd4_callback *cb)
751{
752 queue_work(callback_wq, &cb->cb_work);
753}
754
5a3c9d71 755static void do_probe_callback(struct nfs4_client *clp)
a601caed 756{
cee277d9 757 struct nfsd4_callback *cb = &clp->cl_cb_null;
a601caed 758
fb003923
BF
759 cb->cb_op = NULL;
760 cb->cb_clp = clp;
cee277d9
BF
761
762 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL];
763 cb->cb_msg.rpc_argp = NULL;
764 cb->cb_msg.rpc_resp = NULL;
cee277d9
BF
765
766 cb->cb_ops = &nfsd4_cb_probe_ops;
767
229b2a08 768 run_nfsd4_cb(cb);
63c86716
BF
769}
770
771/*
5a3c9d71
BF
772 * Poke the callback thread to process any updates to the callback
773 * parameters, and send a null probe.
63c86716 774 */
5a3c9d71
BF
775void nfsd4_probe_callback(struct nfs4_client *clp)
776{
77a3569d 777 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
a52d726b 778 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
5a3c9d71
BF
779 do_probe_callback(clp);
780}
781
84f5f7cc 782void nfsd4_probe_callback_sync(struct nfs4_client *clp)
63c86716 783{
84f5f7cc
BF
784 nfsd4_probe_callback(clp);
785 flush_workqueue(callback_wq);
786}
63c86716 787
5a3c9d71 788void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
63c86716 789{
77a3569d 790 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
6ff8da08
BF
791 spin_lock(&clp->cl_lock);
792 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
6ff8da08 793 spin_unlock(&clp->cl_lock);
1da177e4
LT
794}
795
2a1d1b59
RL
796/*
797 * There's currently a single callback channel slot.
798 * If the slot is available, then mark it busy. Otherwise, set the
799 * thread for sleeping on the callback RPC wait queue.
800 */
3ff3600e 801static bool nfsd41_cb_get_slot(struct nfs4_client *clp, struct rpc_task *task)
2a1d1b59 802{
2a1d1b59
RL
803 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
804 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
805 dprintk("%s slot is busy\n", __func__);
3ff3600e 806 return false;
2a1d1b59 807 }
3ff3600e 808 return true;
2a1d1b59
RL
809}
810
811/*
812 * TODO: cb_sequence should support referring call lists, cachethis, multiple
813 * slots, and mark callback channel down on communication errors.
814 */
815static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
816{
5878453d
BF
817 struct nfsd4_callback *cb = calldata;
818 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
2a74aba7 819 struct nfs4_client *clp = dp->dl_stid.sc_client;
8323c3b2 820 u32 minorversion = clp->cl_minorversion;
2a1d1b59 821
fb003923 822 cb->cb_minorversion = minorversion;
2a1d1b59 823 if (minorversion) {
3ff3600e 824 if (!nfsd41_cb_get_slot(clp, task))
2a1d1b59 825 return;
2a1d1b59 826 }
5ce8ba25 827 spin_lock(&clp->cl_lock);
a8f2800b
BF
828 if (list_empty(&cb->cb_per_client)) {
829 /* This is the first call, not a restart */
830 cb->cb_done = false;
831 list_add(&cb->cb_per_client, &clp->cl_callbacks);
832 }
5ce8ba25 833 spin_unlock(&clp->cl_lock);
2a1d1b59
RL
834 rpc_call_start(task);
835}
836
0421b5c5
RL
837static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
838{
5878453d
BF
839 struct nfsd4_callback *cb = calldata;
840 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
2a74aba7 841 struct nfs4_client *clp = dp->dl_stid.sc_client;
0421b5c5
RL
842
843 dprintk("%s: minorversion=%d\n", __func__,
8323c3b2 844 clp->cl_minorversion);
0421b5c5 845
8323c3b2 846 if (clp->cl_minorversion) {
0421b5c5 847 /* No need for lock, access serialized in nfsd4_cb_prepare */
ac7c46f2 848 ++clp->cl_cb_session->se_cb_seq_nr;
0421b5c5
RL
849 clear_bit(0, &clp->cl_cb_slot_busy);
850 rpc_wake_up_next(&clp->cl_cb_waitq);
851 dprintk("%s: freed slot, new seqid=%d\n", __func__,
ac7c46f2 852 clp->cl_cb_session->se_cb_seq_nr);
0421b5c5
RL
853
854 /* We're done looking into the sequence information */
855 task->tk_msg.rpc_resp = NULL;
856 }
857}
858
4b21d0de 859
63e4863f
BF
860static void nfsd4_cb_recall_done(struct rpc_task *task, void *calldata)
861{
5878453d
BF
862 struct nfsd4_callback *cb = calldata;
863 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
2a74aba7 864 struct nfs4_client *clp = dp->dl_stid.sc_client;
4b21d0de 865 struct rpc_clnt *current_rpc_client = clp->cl_cb_client;
63e4863f 866
0421b5c5
RL
867 nfsd4_cb_done(task, calldata);
868
a8f2800b
BF
869 if (current_rpc_client != task->tk_client) {
870 /* We're shutting down or changing cl_cb_client; leave
871 * it to nfsd4_process_cb_update to restart the call if
872 * necessary. */
4b21d0de
BF
873 return;
874 }
875
5ce8ba25
BF
876 if (cb->cb_done)
877 return;
63e4863f 878 switch (task->tk_status) {
172c85dd 879 case 0:
5ce8ba25 880 cb->cb_done = true;
172c85dd
BF
881 return;
882 case -EBADHANDLE:
883 case -NFS4ERR_BAD_STATEID:
884 /* Race: client probably got cb_recall
885 * before open reply granting delegation */
886 break;
887 default:
63e4863f 888 /* Network partition? */
77a3569d 889 nfsd4_mark_cb_down(clp, task->tk_status);
63e4863f
BF
890 }
891 if (dp->dl_retries--) {
892 rpc_delay(task, 2*HZ);
893 task->tk_status = 0;
c18c821f 894 rpc_restart_call_prepare(task);
0421b5c5 895 return;
63e4863f 896 }
5ce8ba25
BF
897 nfsd4_mark_cb_down(clp, task->tk_status);
898 cb->cb_done = true;
63e4863f
BF
899}
900
901static void nfsd4_cb_recall_release(void *calldata)
902{
5878453d 903 struct nfsd4_callback *cb = calldata;
5ce8ba25 904 struct nfs4_client *clp = cb->cb_clp;
5878453d 905 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
63e4863f 906
5ce8ba25
BF
907 if (cb->cb_done) {
908 spin_lock(&clp->cl_lock);
909 list_del(&cb->cb_per_client);
910 spin_unlock(&clp->cl_lock);
911 nfs4_put_delegation(dp);
912 }
63e4863f
BF
913}
914
915static const struct rpc_call_ops nfsd4_cb_recall_ops = {
2a1d1b59 916 .rpc_call_prepare = nfsd4_cb_prepare,
63e4863f
BF
917 .rpc_call_done = nfsd4_cb_recall_done,
918 .rpc_release = nfsd4_cb_recall_release,
919};
920
b5a1a81e
BF
921int nfsd4_create_callback_queue(void)
922{
923 callback_wq = create_singlethread_workqueue("nfsd4_callbacks");
924 if (!callback_wq)
925 return -ENOMEM;
926 return 0;
927}
928
929void nfsd4_destroy_callback_queue(void)
930{
931 destroy_workqueue(callback_wq);
932}
933
ab707e15 934/* must be called under the state lock */
6ff8da08 935void nfsd4_shutdown_callback(struct nfs4_client *clp)
b5a1a81e 936{
a52d726b 937 set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags);
b5a1a81e 938 /*
6ff8da08
BF
939 * Note this won't actually result in a null callback;
940 * instead, nfsd4_do_callback_rpc() will detect the killed
941 * client, destroy the rpc client, and stop:
b5a1a81e 942 */
6ff8da08 943 do_probe_callback(clp);
b5a1a81e 944 flush_workqueue(callback_wq);
b5a1a81e
BF
945}
946
65e4c894 947static void nfsd4_release_cb(struct nfsd4_callback *cb)
1da177e4 948{
5878453d
BF
949 if (cb->cb_ops->rpc_release)
950 cb->cb_ops->rpc_release(cb);
951}
952
dcbeaa68
BF
953/* requires cl_lock: */
954static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
955{
956 struct nfsd4_session *s;
957 struct nfsd4_conn *c;
958
959 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
960 list_for_each_entry(c, &s->se_conns, cn_persession) {
961 if (c->cn_flags & NFS4_CDFC4_BACK)
962 return c;
963 }
964 }
965 return NULL;
966}
967
65e4c894 968static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
6ff8da08
BF
969{
970 struct nfs4_cb_conn conn;
971 struct nfs4_client *clp = cb->cb_clp;
dcbeaa68
BF
972 struct nfsd4_session *ses = NULL;
973 struct nfsd4_conn *c;
6ff8da08
BF
974 int err;
975
976 /*
977 * This is either an update, or the client dying; in either case,
978 * kill the old client:
979 */
980 if (clp->cl_cb_client) {
981 rpc_shutdown_client(clp->cl_cb_client);
982 clp->cl_cb_client = NULL;
c6bb3ca2
BF
983 put_rpccred(clp->cl_cb_cred);
984 clp->cl_cb_cred = NULL;
6ff8da08 985 }
dcbeaa68
BF
986 if (clp->cl_cb_conn.cb_xprt) {
987 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
988 clp->cl_cb_conn.cb_xprt = NULL;
989 }
a52d726b 990 if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags))
6ff8da08
BF
991 return;
992 spin_lock(&clp->cl_lock);
993 /*
994 * Only serialized callback code is allowed to clear these
995 * flags; main nfsd code can only set them:
996 */
a52d726b
JL
997 BUG_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK));
998 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags);
6ff8da08 999 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
dcbeaa68
BF
1000 c = __nfsd4_find_backchannel(clp);
1001 if (c) {
1002 svc_xprt_get(c->cn_xprt);
1003 conn.cb_xprt = c->cn_xprt;
1004 ses = c->cn_session;
1005 }
6ff8da08
BF
1006 spin_unlock(&clp->cl_lock);
1007
dcbeaa68 1008 err = setup_callback_client(clp, &conn, ses);
5ce8ba25 1009 if (err) {
8546ee51 1010 nfsd4_mark_cb_down(clp, err);
5ce8ba25
BF
1011 return;
1012 }
1013 /* Yay, the callback channel's back! Restart any callbacks: */
1014 list_for_each_entry(cb, &clp->cl_callbacks, cb_per_client)
1015 run_nfsd4_cb(cb);
6ff8da08
BF
1016}
1017
57725155 1018static void nfsd4_do_callback_rpc(struct work_struct *w)
5878453d
BF
1019{
1020 struct nfsd4_callback *cb = container_of(w, struct nfsd4_callback, cb_work);
fb003923 1021 struct nfs4_client *clp = cb->cb_clp;
6ff8da08 1022 struct rpc_clnt *clnt;
1da177e4 1023
a52d726b 1024 if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)
6ff8da08
BF
1025 nfsd4_process_cb_update(cb);
1026
1027 clnt = clp->cl_cb_client;
1028 if (!clnt) {
1029 /* Callback channel broken, or client killed; give up: */
5878453d 1030 nfsd4_release_cb(cb);
6ff8da08 1031 return;
ac94bf58 1032 }
c6bb3ca2 1033 cb->cb_msg.rpc_cred = clp->cl_cb_cred;
cee277d9
BF
1034 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
1035 cb->cb_ops, cb);
1da177e4 1036}
b5a1a81e 1037
57725155
BF
1038void nfsd4_init_callback(struct nfsd4_callback *cb)
1039{
1040 INIT_WORK(&cb->cb_work, nfsd4_do_callback_rpc);
1041}
1042
5878453d 1043void nfsd4_cb_recall(struct nfs4_delegation *dp)
b5a1a81e 1044{
5878453d 1045 struct nfsd4_callback *cb = &dp->dl_recall;
2a74aba7 1046 struct nfs4_client *clp = dp->dl_stid.sc_client;
b5a1a81e 1047
5878453d 1048 dp->dl_retries = 1;
fb003923 1049 cb->cb_op = dp;
5ce8ba25 1050 cb->cb_clp = clp;
5878453d 1051 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL];
fb003923
BF
1052 cb->cb_msg.rpc_argp = cb;
1053 cb->cb_msg.rpc_resp = cb;
5878453d
BF
1054
1055 cb->cb_ops = &nfsd4_cb_recall_ops;
b5a1a81e 1056
9ee1ba54 1057 INIT_LIST_HEAD(&cb->cb_per_client);
5ce8ba25
BF
1058 cb->cb_done = true;
1059
229b2a08 1060 run_nfsd4_cb(&dp->dl_recall);
b5a1a81e 1061}