]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - fs/nfsd/nfs4callback.c
nfsd4: give out delegations more quickly in 4.1 case
[mirror_ubuntu-jammy-kernel.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
42#define NFSPROC4_CB_NULL 0
43#define NFSPROC4_CB_COMPOUND 1
44
1da177e4
LT
45/* Index of predefined Linux callback client operations */
46
47enum {
4be36ca0 48 NFSPROC4_CLNT_CB_NULL = 0,
1da177e4 49 NFSPROC4_CLNT_CB_RECALL,
38524ab3 50 NFSPROC4_CLNT_CB_SEQUENCE,
1da177e4
LT
51};
52
53enum nfs_cb_opnum4 {
54 OP_CB_RECALL = 4,
38524ab3 55 OP_CB_SEQUENCE = 11,
1da177e4
LT
56};
57
58#define NFS4_MAXTAGLEN 20
59
60#define NFS4_enc_cb_null_sz 0
61#define NFS4_dec_cb_null_sz 0
62#define cb_compound_enc_hdr_sz 4
63#define cb_compound_dec_hdr_sz (3 + (NFS4_MAXTAGLEN >> 2))
38524ab3
AA
64#define sessionid_sz (NFS4_MAX_SESSIONID_LEN >> 2)
65#define cb_sequence_enc_sz (sessionid_sz + 4 + \
66 1 /* no referring calls list yet */)
67#define cb_sequence_dec_sz (op_dec_sz + sessionid_sz + 4)
68
1da177e4
LT
69#define op_enc_sz 1
70#define op_dec_sz 2
71#define enc_nfs4_fh_sz (1 + (NFS4_FHSIZE >> 2))
0ac68d17 72#define enc_stateid_sz (NFS4_STATEID_SIZE >> 2)
1da177e4 73#define NFS4_enc_cb_recall_sz (cb_compound_enc_hdr_sz + \
38524ab3 74 cb_sequence_enc_sz + \
1da177e4
LT
75 1 + enc_stateid_sz + \
76 enc_nfs4_fh_sz)
77
78#define NFS4_dec_cb_recall_sz (cb_compound_dec_hdr_sz + \
38524ab3 79 cb_sequence_dec_sz + \
1da177e4
LT
80 op_dec_sz)
81
82/*
83* Generic encode routines from fs/nfs/nfs4xdr.c
84*/
f00f328f
AV
85static inline __be32 *
86xdr_writemem(__be32 *p, const void *ptr, int nbytes)
1da177e4
LT
87{
88 int tmp = XDR_QUADLEN(nbytes);
89 if (!tmp)
90 return p;
91 p[tmp-1] = 0;
92 memcpy(p, ptr, nbytes);
93 return p + tmp;
94}
95
96#define WRITE32(n) *p++ = htonl(n)
97#define WRITEMEM(ptr,nbytes) do { \
98 p = xdr_writemem(p, ptr, nbytes); \
99} while (0)
100#define RESERVE_SPACE(nbytes) do { \
101 p = xdr_reserve_space(xdr, nbytes); \
8e24eea7 102 if (!p) dprintk("NFSD: RESERVE_SPACE(%d) failed in function %s\n", (int) (nbytes), __func__); \
1da177e4
LT
103 BUG_ON(!p); \
104} while (0)
105
106/*
107 * Generic decode routines from fs/nfs/nfs4xdr.c
108 */
109#define DECODE_TAIL \
110 status = 0; \
111out: \
112 return status; \
113xdr_error: \
114 dprintk("NFSD: xdr error! (%s:%d)\n", __FILE__, __LINE__); \
115 status = -EIO; \
116 goto out
117
118#define READ32(x) (x) = ntohl(*p++)
119#define READ64(x) do { \
120 (x) = (u64)ntohl(*p++) << 32; \
121 (x) |= ntohl(*p++); \
122} while (0)
123#define READTIME(x) do { \
124 p++; \
125 (x.tv_sec) = ntohl(*p++); \
126 (x.tv_nsec) = ntohl(*p++); \
127} while (0)
128#define READ_BUF(nbytes) do { \
129 p = xdr_inline_decode(xdr, nbytes); \
130 if (!p) { \
3e3b4800 131 dprintk("NFSD: %s: reply buffer overflowed in line %d.\n", \
8e24eea7 132 __func__, __LINE__); \
1da177e4
LT
133 return -EIO; \
134 } \
135} while (0)
136
137struct nfs4_cb_compound_hdr {
38524ab3
AA
138 /* args */
139 u32 ident; /* minorversion 0 only */
1da177e4 140 u32 nops;
ef52bff8 141 __be32 *nops_p;
ab52ae6d 142 u32 minorversion;
38524ab3
AA
143 /* res */
144 int status;
1da177e4
LT
145};
146
147static struct {
148int stat;
149int errno;
150} nfs_cb_errtbl[] = {
151 { NFS4_OK, 0 },
152 { NFS4ERR_PERM, EPERM },
153 { NFS4ERR_NOENT, ENOENT },
154 { NFS4ERR_IO, EIO },
155 { NFS4ERR_NXIO, ENXIO },
156 { NFS4ERR_ACCESS, EACCES },
157 { NFS4ERR_EXIST, EEXIST },
158 { NFS4ERR_XDEV, EXDEV },
159 { NFS4ERR_NOTDIR, ENOTDIR },
160 { NFS4ERR_ISDIR, EISDIR },
161 { NFS4ERR_INVAL, EINVAL },
162 { NFS4ERR_FBIG, EFBIG },
163 { NFS4ERR_NOSPC, ENOSPC },
164 { NFS4ERR_ROFS, EROFS },
165 { NFS4ERR_MLINK, EMLINK },
166 { NFS4ERR_NAMETOOLONG, ENAMETOOLONG },
167 { NFS4ERR_NOTEMPTY, ENOTEMPTY },
168 { NFS4ERR_DQUOT, EDQUOT },
169 { NFS4ERR_STALE, ESTALE },
170 { NFS4ERR_BADHANDLE, EBADHANDLE },
171 { NFS4ERR_BAD_COOKIE, EBADCOOKIE },
172 { NFS4ERR_NOTSUPP, ENOTSUPP },
173 { NFS4ERR_TOOSMALL, ETOOSMALL },
174 { NFS4ERR_SERVERFAULT, ESERVERFAULT },
175 { NFS4ERR_BADTYPE, EBADTYPE },
176 { NFS4ERR_LOCKED, EAGAIN },
177 { NFS4ERR_RESOURCE, EREMOTEIO },
178 { NFS4ERR_SYMLINK, ELOOP },
179 { NFS4ERR_OP_ILLEGAL, EOPNOTSUPP },
180 { NFS4ERR_DEADLOCK, EDEADLK },
181 { -1, EIO }
182};
183
184static int
185nfs_cb_stat_to_errno(int stat)
186{
187 int i;
188 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
189 if (nfs_cb_errtbl[i].stat == stat)
190 return nfs_cb_errtbl[i].errno;
191 }
192 /* If we cannot translate the error, the recovery routines should
193 * handle it.
194 * Note: remaining NFSv4 error codes have values > 10000, so should
195 * not conflict with native Linux error codes.
196 */
197 return stat;
198}
199
200/*
201 * XDR encode
202 */
203
9303bbd3
BH
204static void
205encode_stateid(struct xdr_stream *xdr, stateid_t *sid)
206{
207 __be32 *p;
208
209 RESERVE_SPACE(sizeof(stateid_t));
210 WRITE32(sid->si_generation);
211 WRITEMEM(&sid->si_opaque, sizeof(stateid_opaque_t));
212}
213
ef52bff8 214static void
1da177e4
LT
215encode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr)
216{
f00f328f 217 __be32 * p;
1da177e4
LT
218
219 RESERVE_SPACE(16);
220 WRITE32(0); /* tag length is always 0 */
ab52ae6d 221 WRITE32(hdr->minorversion);
1da177e4 222 WRITE32(hdr->ident);
ef52bff8 223 hdr->nops_p = p;
1da177e4 224 WRITE32(hdr->nops);
1da177e4
LT
225}
226
ef52bff8
AA
227static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
228{
229 *hdr->nops_p = htonl(hdr->nops);
230}
231
232static void
233encode_cb_recall(struct xdr_stream *xdr, struct nfs4_delegation *dp,
234 struct nfs4_cb_compound_hdr *hdr)
1da177e4 235{
f00f328f 236 __be32 *p;
b53d40c5 237 int len = dp->dl_fh.fh_size;
1da177e4 238
9303bbd3 239 RESERVE_SPACE(4);
1da177e4 240 WRITE32(OP_CB_RECALL);
9303bbd3
BH
241 encode_stateid(xdr, &dp->dl_stateid);
242 RESERVE_SPACE(8 + (XDR_QUADLEN(len) << 2));
6707bd3d 243 WRITE32(0); /* truncate optimization not implemented */
1da177e4 244 WRITE32(len);
b53d40c5 245 WRITEMEM(&dp->dl_fh.fh_base, len);
ef52bff8 246 hdr->nops++;
1da177e4
LT
247}
248
2af73580 249static void
fb003923 250encode_cb_sequence(struct xdr_stream *xdr, struct nfsd4_callback *cb,
2af73580
BH
251 struct nfs4_cb_compound_hdr *hdr)
252{
253 __be32 *p;
90c8145b 254 struct nfsd4_session *ses = cb->cb_clp->cl_cb_session;
2af73580
BH
255
256 if (hdr->minorversion == 0)
257 return;
258
259 RESERVE_SPACE(1 + NFS4_MAX_SESSIONID_LEN + 20);
260
261 WRITE32(OP_CB_SEQUENCE);
90c8145b 262 WRITEMEM(ses->se_sessionid.data, NFS4_MAX_SESSIONID_LEN);
ac7c46f2 263 WRITE32(ses->se_cb_seq_nr);
2af73580
BH
264 WRITE32(0); /* slotid, always 0 */
265 WRITE32(0); /* highest slotid always 0 */
266 WRITE32(0); /* cachethis always 0 */
267 WRITE32(0); /* FIXME: support referring_call_lists */
268 hdr->nops++;
269}
270
1da177e4 271static int
f00f328f 272nfs4_xdr_enc_cb_null(struct rpc_rqst *req, __be32 *p)
1da177e4
LT
273{
274 struct xdr_stream xdrs, *xdr = &xdrs;
275
276 xdr_init_encode(&xdrs, &req->rq_snd_buf, p);
277 RESERVE_SPACE(0);
278 return 0;
279}
280
281static int
0421b5c5 282nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, __be32 *p,
fb003923 283 struct nfsd4_callback *cb)
1da177e4
LT
284{
285 struct xdr_stream xdr;
fb003923 286 struct nfs4_delegation *args = cb->cb_op;
1da177e4 287 struct nfs4_cb_compound_hdr hdr = {
6ff8da08 288 .ident = cb->cb_clp->cl_cb_ident,
fb003923 289 .minorversion = cb->cb_minorversion,
1da177e4
LT
290 };
291
292 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
293 encode_cb_compound_hdr(&xdr, &hdr);
fb003923 294 encode_cb_sequence(&xdr, cb, &hdr);
ef52bff8
AA
295 encode_cb_recall(&xdr, args, &hdr);
296 encode_cb_nops(&hdr);
297 return 0;
1da177e4
LT
298}
299
300
301static int
302decode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr){
f00f328f 303 __be32 *p;
68a4b48c 304 u32 taglen;
1da177e4
LT
305
306 READ_BUF(8);
307 READ32(hdr->status);
68a4b48c
BF
308 /* We've got no use for the tag; ignore it: */
309 READ32(taglen);
310 READ_BUF(taglen + 4);
311 p += XDR_QUADLEN(taglen);
1da177e4
LT
312 READ32(hdr->nops);
313 return 0;
314}
315
316static int
317decode_cb_op_hdr(struct xdr_stream *xdr, enum nfs_opnum4 expected)
318{
f00f328f 319 __be32 *p;
1da177e4
LT
320 u32 op;
321 int32_t nfserr;
322
323 READ_BUF(8);
324 READ32(op);
325 if (op != expected) {
326 dprintk("NFSD: decode_cb_op_hdr: Callback server returned "
327 " operation %d but we issued a request for %d\n",
328 op, expected);
329 return -EIO;
330 }
331 READ32(nfserr);
332 if (nfserr != NFS_OK)
333 return -nfs_cb_stat_to_errno(nfserr);
334 return 0;
335}
336
2af73580
BH
337/*
338 * Our current back channel implmentation supports a single backchannel
339 * with a single slot.
340 */
341static int
fb003923 342decode_cb_sequence(struct xdr_stream *xdr, struct nfsd4_callback *cb,
2af73580
BH
343 struct rpc_rqst *rqstp)
344{
90c8145b 345 struct nfsd4_session *ses = cb->cb_clp->cl_cb_session;
2af73580
BH
346 struct nfs4_sessionid id;
347 int status;
348 u32 dummy;
349 __be32 *p;
350
fb003923 351 if (cb->cb_minorversion == 0)
2af73580
BH
352 return 0;
353
354 status = decode_cb_op_hdr(xdr, OP_CB_SEQUENCE);
355 if (status)
356 return status;
357
358 /*
359 * If the server returns different values for sessionID, slotID or
360 * sequence number, the server is looney tunes.
361 */
362 status = -ESERVERFAULT;
363
364 READ_BUF(NFS4_MAX_SESSIONID_LEN + 16);
365 memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
366 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
90c8145b 367 if (memcmp(id.data, ses->se_sessionid.data, NFS4_MAX_SESSIONID_LEN)) {
2af73580
BH
368 dprintk("%s Invalid session id\n", __func__);
369 goto out;
370 }
371 READ32(dummy);
ac7c46f2 372 if (dummy != ses->se_cb_seq_nr) {
2af73580
BH
373 dprintk("%s Invalid sequence number\n", __func__);
374 goto out;
375 }
376 READ32(dummy); /* slotid must be 0 */
377 if (dummy != 0) {
378 dprintk("%s Invalid slotid\n", __func__);
379 goto out;
380 }
381 /* FIXME: process highest slotid and target highest slotid */
382 status = 0;
383out:
384 return status;
385}
386
387
1da177e4 388static int
f00f328f 389nfs4_xdr_dec_cb_null(struct rpc_rqst *req, __be32 *p)
1da177e4
LT
390{
391 return 0;
392}
393
394static int
0421b5c5 395nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp, __be32 *p,
fb003923 396 struct nfsd4_callback *cb)
1da177e4
LT
397{
398 struct xdr_stream xdr;
399 struct nfs4_cb_compound_hdr hdr;
400 int status;
401
402 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
403 status = decode_cb_compound_hdr(&xdr, &hdr);
404 if (status)
405 goto out;
fb003923
BF
406 if (cb) {
407 status = decode_cb_sequence(&xdr, cb, rqstp);
0421b5c5
RL
408 if (status)
409 goto out;
410 }
1da177e4
LT
411 status = decode_cb_op_hdr(&xdr, OP_CB_RECALL);
412out:
413 return status;
414}
415
416/*
417 * RPC procedure tables
418 */
1da177e4
LT
419#define PROC(proc, call, argtype, restype) \
420[NFSPROC4_CLNT_##proc] = { \
421 .p_proc = NFSPROC4_CB_##call, \
422 .p_encode = (kxdrproc_t) nfs4_xdr_##argtype, \
423 .p_decode = (kxdrproc_t) nfs4_xdr_##restype, \
2bea90d4
CL
424 .p_arglen = NFS4_##argtype##_sz, \
425 .p_replen = NFS4_##restype##_sz, \
cc0175c1
CL
426 .p_statidx = NFSPROC4_CB_##call, \
427 .p_name = #proc, \
1da177e4
LT
428}
429
fd39ca9a 430static struct rpc_procinfo nfs4_cb_procedures[] = {
1da177e4
LT
431 PROC(CB_NULL, NULL, enc_cb_null, dec_cb_null),
432 PROC(CB_RECALL, COMPOUND, enc_cb_recall, dec_cb_recall),
433};
434
fd39ca9a 435static struct rpc_version nfs_cb_version4 = {
b7299f44
BF
436/*
437 * Note on the callback rpc program version number: despite language in rfc
438 * 5661 section 18.36.3 requiring servers to use 4 in this field, the
439 * official xdr descriptions for both 4.0 and 4.1 specify version 1, and
440 * in practice that appears to be what implementations use. The section
441 * 18.36.3 language is expected to be fixed in an erratum.
442 */
1da177e4 443 .number = 1,
e8c96f8c 444 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
1da177e4
LT
445 .procs = nfs4_cb_procedures
446};
447
448static struct rpc_version * nfs_cb_version[] = {
1da177e4
LT
449 &nfs_cb_version4,
450};
451
ff7d9756
OK
452static struct rpc_program cb_program;
453
454static struct rpc_stat cb_stats = {
455 .program = &cb_program
456};
457
458#define NFS4_CALLBACK 0x40000000
459static struct rpc_program cb_program = {
460 .name = "nfs4_cb",
461 .number = NFS4_CALLBACK,
462 .nrvers = ARRAY_SIZE(nfs_cb_version),
463 .version = nfs_cb_version,
464 .stats = &cb_stats,
61054b14 465 .pipe_dir_name = "/nfsd4_cb",
ff7d9756
OK
466};
467
595947ac
BF
468static int max_cb_time(void)
469{
cf07d2ea 470 return max(nfsd4_lease/10, (time_t)1) * HZ;
595947ac
BF
471}
472
2b47eece 473
dcbeaa68 474static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses)
2b47eece 475{
ae5c7947 476 struct rpc_timeout timeparms = {
595947ac
BF
477 .to_initval = max_cb_time(),
478 .to_retries = 0,
ae5c7947 479 };
ae5c7947 480 struct rpc_create_args args = {
c653ce3f 481 .net = &init_net,
07263f1e
BF
482 .address = (struct sockaddr *) &conn->cb_addr,
483 .addrsize = conn->cb_addrlen,
6f3d772f 484 .saddress = (struct sockaddr *) &conn->cb_saddr,
ae5c7947 485 .timeout = &timeparms,
ff7d9756 486 .program = &cb_program,
b7299f44 487 .version = 0,
61054b14 488 .authflavor = clp->cl_flavor,
b6b6152c 489 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
ae5c7947 490 };
63c86716 491 struct rpc_clnt *client;
1da177e4 492
5d18c1c2
BF
493 if (clp->cl_minorversion == 0) {
494 if (!clp->cl_principal && (clp->cl_flavor >= RPC_AUTH_GSS_KRB5))
495 return -EINVAL;
496 args.client_name = clp->cl_principal;
497 args.prognumber = conn->cb_prog,
498 args.protocol = XPRT_TRANSPORT_TCP;
499 clp->cl_cb_ident = conn->cb_ident;
500 } else {
dcbeaa68
BF
501 if (!conn->cb_xprt)
502 return -EINVAL;
503 clp->cl_cb_conn.cb_xprt = conn->cb_xprt;
504 clp->cl_cb_session = ses;
07263f1e 505 args.bc_xprt = conn->cb_xprt;
8b5ce5cd 506 args.prognumber = clp->cl_cb_session->se_cb_prog;
3ddc8bf5
AB
507 args.protocol = XPRT_TRANSPORT_BC_TCP;
508 }
ae5c7947 509 /* Create RPC client */
63c86716 510 client = rpc_create(&args);
e1cab5a5 511 if (IS_ERR(client)) {
a601caed
BF
512 dprintk("NFSD: couldn't create callback client: %ld\n",
513 PTR_ERR(client));
e1cab5a5
BF
514 return PTR_ERR(client);
515 }
6ff8da08 516 clp->cl_cb_client = client;
e1cab5a5 517 return 0;
a601caed
BF
518
519}
520
ecdd03b7
BF
521static void warn_no_callback_path(struct nfs4_client *clp, int reason)
522{
523 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
524 (int)clp->cl_name.len, clp->cl_name.data, reason);
525}
526
77a3569d
BF
527static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason)
528{
529 clp->cl_cb_state = NFSD4_CB_DOWN;
530 warn_no_callback_path(clp, reason);
531}
532
e300a63c
BF
533static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
534{
cee277d9 535 struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null);
e300a63c
BF
536
537 if (task->tk_status)
77a3569d 538 nfsd4_mark_cb_down(clp, task->tk_status);
e300a63c 539 else
77a3569d 540 clp->cl_cb_state = NFSD4_CB_UP;
e300a63c
BF
541}
542
543static const struct rpc_call_ops nfsd4_cb_probe_ops = {
cee277d9
BF
544 /* XXX: release method to ensure we set the cb channel down if
545 * necessary on early failure? */
e300a63c
BF
546 .rpc_call_done = nfsd4_cb_probe_done,
547};
548
80fc015b
BF
549static struct rpc_cred *callback_cred;
550
551int set_callback_cred(void)
3cef9ab2 552{
8d75da8a
BF
553 if (callback_cred)
554 return 0;
80fc015b
BF
555 callback_cred = rpc_lookup_machine_cred();
556 if (!callback_cred)
557 return -ENOMEM;
558 return 0;
3cef9ab2
BF
559}
560
cee277d9 561static struct workqueue_struct *callback_wq;
80fc015b 562
229b2a08
BF
563static void run_nfsd4_cb(struct nfsd4_callback *cb)
564{
565 queue_work(callback_wq, &cb->cb_work);
566}
567
5a3c9d71 568static void do_probe_callback(struct nfs4_client *clp)
a601caed 569{
cee277d9 570 struct nfsd4_callback *cb = &clp->cl_cb_null;
a601caed 571
fb003923
BF
572 cb->cb_op = NULL;
573 cb->cb_clp = clp;
cee277d9
BF
574
575 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL];
576 cb->cb_msg.rpc_argp = NULL;
577 cb->cb_msg.rpc_resp = NULL;
578 cb->cb_msg.rpc_cred = callback_cred;
579
580 cb->cb_ops = &nfsd4_cb_probe_ops;
581
229b2a08 582 run_nfsd4_cb(cb);
63c86716
BF
583}
584
585/*
5a3c9d71
BF
586 * Poke the callback thread to process any updates to the callback
587 * parameters, and send a null probe.
63c86716 588 */
5a3c9d71
BF
589void nfsd4_probe_callback(struct nfs4_client *clp)
590{
77a3569d
BF
591 /* XXX: atomicity? Also, should we be using cl_cb_flags? */
592 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
5a3c9d71
BF
593 set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_cb_flags);
594 do_probe_callback(clp);
595}
596
84f5f7cc
BF
597void nfsd4_probe_callback_sync(struct nfs4_client *clp)
598{
599 nfsd4_probe_callback(clp);
600 flush_workqueue(callback_wq);
601}
602
5a3c9d71 603void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn)
63c86716 604{
77a3569d 605 clp->cl_cb_state = NFSD4_CB_UNKNOWN;
6ff8da08
BF
606 spin_lock(&clp->cl_lock);
607 memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn));
6ff8da08 608 spin_unlock(&clp->cl_lock);
1da177e4
LT
609}
610
2a1d1b59
RL
611/*
612 * There's currently a single callback channel slot.
613 * If the slot is available, then mark it busy. Otherwise, set the
614 * thread for sleeping on the callback RPC wait queue.
615 */
616static int nfsd41_cb_setup_sequence(struct nfs4_client *clp,
617 struct rpc_task *task)
618{
90c8145b 619 u32 *ptr = (u32 *)clp->cl_cb_session->se_sessionid.data;
2a1d1b59
RL
620 int status = 0;
621
622 dprintk("%s: %u:%u:%u:%u\n", __func__,
623 ptr[0], ptr[1], ptr[2], ptr[3]);
624
625 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
626 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
627 dprintk("%s slot is busy\n", __func__);
628 status = -EAGAIN;
629 goto out;
630 }
2a1d1b59
RL
631out:
632 dprintk("%s status=%d\n", __func__, status);
633 return status;
634}
635
636/*
637 * TODO: cb_sequence should support referring call lists, cachethis, multiple
638 * slots, and mark callback channel down on communication errors.
639 */
640static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
641{
5878453d
BF
642 struct nfsd4_callback *cb = calldata;
643 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
2a1d1b59 644 struct nfs4_client *clp = dp->dl_client;
8323c3b2 645 u32 minorversion = clp->cl_minorversion;
2a1d1b59
RL
646 int status = 0;
647
fb003923 648 cb->cb_minorversion = minorversion;
2a1d1b59
RL
649 if (minorversion) {
650 status = nfsd41_cb_setup_sequence(clp, task);
651 if (status) {
652 if (status != -EAGAIN) {
653 /* terminate rpc task */
654 task->tk_status = status;
655 task->tk_action = NULL;
656 }
657 return;
658 }
659 }
660 rpc_call_start(task);
661}
662
0421b5c5
RL
663static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
664{
5878453d
BF
665 struct nfsd4_callback *cb = calldata;
666 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
0421b5c5
RL
667 struct nfs4_client *clp = dp->dl_client;
668
669 dprintk("%s: minorversion=%d\n", __func__,
8323c3b2 670 clp->cl_minorversion);
0421b5c5 671
8323c3b2 672 if (clp->cl_minorversion) {
0421b5c5 673 /* No need for lock, access serialized in nfsd4_cb_prepare */
ac7c46f2 674 ++clp->cl_cb_session->se_cb_seq_nr;
0421b5c5
RL
675 clear_bit(0, &clp->cl_cb_slot_busy);
676 rpc_wake_up_next(&clp->cl_cb_waitq);
677 dprintk("%s: freed slot, new seqid=%d\n", __func__,
ac7c46f2 678 clp->cl_cb_session->se_cb_seq_nr);
0421b5c5
RL
679
680 /* We're done looking into the sequence information */
681 task->tk_msg.rpc_resp = NULL;
682 }
683}
684
4b21d0de 685
63e4863f
BF
686static void nfsd4_cb_recall_done(struct rpc_task *task, void *calldata)
687{
5878453d
BF
688 struct nfsd4_callback *cb = calldata;
689 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
63e4863f 690 struct nfs4_client *clp = dp->dl_client;
4b21d0de 691 struct rpc_clnt *current_rpc_client = clp->cl_cb_client;
63e4863f 692
0421b5c5
RL
693 nfsd4_cb_done(task, calldata);
694
4b21d0de
BF
695 if (current_rpc_client == NULL) {
696 /* We're shutting down; give up. */
697 /* XXX: err, or is it ok just to fall through
698 * and rpc_restart_call? */
699 return;
700 }
701
63e4863f 702 switch (task->tk_status) {
172c85dd
BF
703 case 0:
704 return;
705 case -EBADHANDLE:
706 case -NFS4ERR_BAD_STATEID:
707 /* Race: client probably got cb_recall
708 * before open reply granting delegation */
709 break;
710 default:
63e4863f 711 /* Network partition? */
77a3569d 712 nfsd4_mark_cb_down(clp, task->tk_status);
4b21d0de
BF
713 if (current_rpc_client != task->tk_client) {
714 /* queue a callback on the new connection: */
cba9ba4b 715 atomic_inc(&dp->dl_count);
4b21d0de
BF
716 nfsd4_cb_recall(dp);
717 return;
718 }
63e4863f
BF
719 }
720 if (dp->dl_retries--) {
721 rpc_delay(task, 2*HZ);
722 task->tk_status = 0;
c18c821f 723 rpc_restart_call_prepare(task);
0421b5c5 724 return;
77a3569d
BF
725 } else
726 nfsd4_mark_cb_down(clp, task->tk_status);
63e4863f
BF
727}
728
729static void nfsd4_cb_recall_release(void *calldata)
730{
5878453d
BF
731 struct nfsd4_callback *cb = calldata;
732 struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall);
63e4863f
BF
733
734 nfs4_put_delegation(dp);
63e4863f
BF
735}
736
737static const struct rpc_call_ops nfsd4_cb_recall_ops = {
2a1d1b59 738 .rpc_call_prepare = nfsd4_cb_prepare,
63e4863f
BF
739 .rpc_call_done = nfsd4_cb_recall_done,
740 .rpc_release = nfsd4_cb_recall_release,
741};
742
b5a1a81e
BF
743int nfsd4_create_callback_queue(void)
744{
745 callback_wq = create_singlethread_workqueue("nfsd4_callbacks");
746 if (!callback_wq)
747 return -ENOMEM;
748 return 0;
749}
750
751void nfsd4_destroy_callback_queue(void)
752{
753 destroy_workqueue(callback_wq);
754}
755
ab707e15 756/* must be called under the state lock */
6ff8da08 757void nfsd4_shutdown_callback(struct nfs4_client *clp)
b5a1a81e 758{
6ff8da08 759 set_bit(NFSD4_CLIENT_KILL, &clp->cl_cb_flags);
b5a1a81e 760 /*
6ff8da08
BF
761 * Note this won't actually result in a null callback;
762 * instead, nfsd4_do_callback_rpc() will detect the killed
763 * client, destroy the rpc client, and stop:
b5a1a81e 764 */
6ff8da08 765 do_probe_callback(clp);
b5a1a81e 766 flush_workqueue(callback_wq);
b5a1a81e
BF
767}
768
65e4c894 769static void nfsd4_release_cb(struct nfsd4_callback *cb)
1da177e4 770{
5878453d
BF
771 if (cb->cb_ops->rpc_release)
772 cb->cb_ops->rpc_release(cb);
773}
774
dcbeaa68
BF
775/* requires cl_lock: */
776static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp)
777{
778 struct nfsd4_session *s;
779 struct nfsd4_conn *c;
780
781 list_for_each_entry(s, &clp->cl_sessions, se_perclnt) {
782 list_for_each_entry(c, &s->se_conns, cn_persession) {
783 if (c->cn_flags & NFS4_CDFC4_BACK)
784 return c;
785 }
786 }
787 return NULL;
788}
789
65e4c894 790static void nfsd4_process_cb_update(struct nfsd4_callback *cb)
6ff8da08
BF
791{
792 struct nfs4_cb_conn conn;
793 struct nfs4_client *clp = cb->cb_clp;
dcbeaa68
BF
794 struct nfsd4_session *ses = NULL;
795 struct nfsd4_conn *c;
6ff8da08
BF
796 int err;
797
798 /*
799 * This is either an update, or the client dying; in either case,
800 * kill the old client:
801 */
802 if (clp->cl_cb_client) {
803 rpc_shutdown_client(clp->cl_cb_client);
804 clp->cl_cb_client = NULL;
805 }
dcbeaa68
BF
806 if (clp->cl_cb_conn.cb_xprt) {
807 svc_xprt_put(clp->cl_cb_conn.cb_xprt);
808 clp->cl_cb_conn.cb_xprt = NULL;
809 }
6ff8da08
BF
810 if (test_bit(NFSD4_CLIENT_KILL, &clp->cl_cb_flags))
811 return;
812 spin_lock(&clp->cl_lock);
813 /*
814 * Only serialized callback code is allowed to clear these
815 * flags; main nfsd code can only set them:
816 */
817 BUG_ON(!clp->cl_cb_flags);
818 clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_cb_flags);
819 memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn));
dcbeaa68
BF
820 c = __nfsd4_find_backchannel(clp);
821 if (c) {
822 svc_xprt_get(c->cn_xprt);
823 conn.cb_xprt = c->cn_xprt;
824 ses = c->cn_session;
825 }
6ff8da08
BF
826 spin_unlock(&clp->cl_lock);
827
dcbeaa68 828 err = setup_callback_client(clp, &conn, ses);
6ff8da08
BF
829 if (err)
830 warn_no_callback_path(clp, err);
831}
832
5878453d
BF
833void nfsd4_do_callback_rpc(struct work_struct *w)
834{
835 struct nfsd4_callback *cb = container_of(w, struct nfsd4_callback, cb_work);
fb003923 836 struct nfs4_client *clp = cb->cb_clp;
6ff8da08 837 struct rpc_clnt *clnt;
1da177e4 838
6ff8da08
BF
839 if (clp->cl_cb_flags)
840 nfsd4_process_cb_update(cb);
841
842 clnt = clp->cl_cb_client;
843 if (!clnt) {
844 /* Callback channel broken, or client killed; give up: */
5878453d 845 nfsd4_release_cb(cb);
6ff8da08 846 return;
ac94bf58 847 }
cee277d9
BF
848 rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
849 cb->cb_ops, cb);
1da177e4 850}
b5a1a81e 851
5878453d 852void nfsd4_cb_recall(struct nfs4_delegation *dp)
b5a1a81e 853{
5878453d 854 struct nfsd4_callback *cb = &dp->dl_recall;
b5a1a81e 855
5878453d 856 dp->dl_retries = 1;
fb003923
BF
857 cb->cb_op = dp;
858 cb->cb_clp = dp->dl_client;
5878453d 859 cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL];
fb003923
BF
860 cb->cb_msg.rpc_argp = cb;
861 cb->cb_msg.rpc_resp = cb;
5878453d
BF
862 cb->cb_msg.rpc_cred = callback_cred;
863
864 cb->cb_ops = &nfsd4_cb_recall_ops;
865 dp->dl_retries = 1;
b5a1a81e 866
229b2a08 867 run_nfsd4_cb(&dp->dl_recall);
b5a1a81e 868}