blob: ea77aa63754a5f3c5909c6a9811234f3d2540060 [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>
Boaz Harrosh9a74af22009-12-03 20:30:56 +020036#include "nfsd.h"
37#include "state.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39#define NFSDDBG_FACILITY NFSDDBG_PROC
40
41#define NFSPROC4_CB_NULL 0
42#define NFSPROC4_CB_COMPOUND 1
Andy Adamson38524ab2009-09-10 12:25:59 +030043#define NFS4_STATEID_SIZE 16
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
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
53enum nfs_cb_opnum4 {
54 OP_CB_RECALL = 4,
Andy Adamson38524ab2009-09-10 12:25:59 +030055 OP_CB_SEQUENCE = 11,
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
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))
Andy Adamson38524ab2009-09-10 12:25:59 +030064#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
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#define op_enc_sz 1
70#define op_dec_sz 2
71#define enc_nfs4_fh_sz (1 + (NFS4_FHSIZE >> 2))
Benny Halevy0ac68d12007-07-17 04:04:37 -070072#define enc_stateid_sz (NFS4_STATEID_SIZE >> 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#define NFS4_enc_cb_recall_sz (cb_compound_enc_hdr_sz + \
Andy Adamson38524ab2009-09-10 12:25:59 +030074 cb_sequence_enc_sz + \
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 1 + enc_stateid_sz + \
76 enc_nfs4_fh_sz)
77
78#define NFS4_dec_cb_recall_sz (cb_compound_dec_hdr_sz + \
Andy Adamson38524ab2009-09-10 12:25:59 +030079 cb_sequence_dec_sz + \
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 op_dec_sz)
81
82/*
83* Generic encode routines from fs/nfs/nfs4xdr.c
84*/
Al Virof00f3282006-10-19 23:29:01 -070085static inline __be32 *
86xdr_writemem(__be32 *p, const void *ptr, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087{
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); \
Harvey Harrison8e24eea2008-04-30 00:55:09 -0700102 if (!p) dprintk("NFSD: RESERVE_SPACE(%d) failed in function %s\n", (int) (nbytes), __func__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 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) { \
Greg Banks3e3b4802006-10-02 02:17:41 -0700131 dprintk("NFSD: %s: reply buffer overflowed in line %d.\n", \
Harvey Harrison8e24eea2008-04-30 00:55:09 -0700132 __func__, __LINE__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 return -EIO; \
134 } \
135} while (0)
136
137struct nfs4_cb_compound_hdr {
Andy Adamson38524ab2009-09-10 12:25:59 +0300138 /* args */
139 u32 ident; /* minorversion 0 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 u32 nops;
Andy Adamsonef52bff2009-06-16 04:20:50 +0300141 __be32 *nops_p;
Andy Adamsonab52ae62009-06-16 04:20:53 +0300142 u32 minorversion;
Andy Adamson38524ab2009-09-10 12:25:59 +0300143 /* res */
144 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 u32 taglen;
Andy Adamsonef52bff2009-06-16 04:20:50 +0300146 char *tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147};
148
149static struct {
150int stat;
151int errno;
152} nfs_cb_errtbl[] = {
153 { NFS4_OK, 0 },
154 { NFS4ERR_PERM, EPERM },
155 { NFS4ERR_NOENT, ENOENT },
156 { NFS4ERR_IO, EIO },
157 { NFS4ERR_NXIO, ENXIO },
158 { NFS4ERR_ACCESS, EACCES },
159 { NFS4ERR_EXIST, EEXIST },
160 { NFS4ERR_XDEV, EXDEV },
161 { NFS4ERR_NOTDIR, ENOTDIR },
162 { NFS4ERR_ISDIR, EISDIR },
163 { NFS4ERR_INVAL, EINVAL },
164 { NFS4ERR_FBIG, EFBIG },
165 { NFS4ERR_NOSPC, ENOSPC },
166 { NFS4ERR_ROFS, EROFS },
167 { NFS4ERR_MLINK, EMLINK },
168 { NFS4ERR_NAMETOOLONG, ENAMETOOLONG },
169 { NFS4ERR_NOTEMPTY, ENOTEMPTY },
170 { NFS4ERR_DQUOT, EDQUOT },
171 { NFS4ERR_STALE, ESTALE },
172 { NFS4ERR_BADHANDLE, EBADHANDLE },
173 { NFS4ERR_BAD_COOKIE, EBADCOOKIE },
174 { NFS4ERR_NOTSUPP, ENOTSUPP },
175 { NFS4ERR_TOOSMALL, ETOOSMALL },
176 { NFS4ERR_SERVERFAULT, ESERVERFAULT },
177 { NFS4ERR_BADTYPE, EBADTYPE },
178 { NFS4ERR_LOCKED, EAGAIN },
179 { NFS4ERR_RESOURCE, EREMOTEIO },
180 { NFS4ERR_SYMLINK, ELOOP },
181 { NFS4ERR_OP_ILLEGAL, EOPNOTSUPP },
182 { NFS4ERR_DEADLOCK, EDEADLK },
183 { -1, EIO }
184};
185
186static int
187nfs_cb_stat_to_errno(int stat)
188{
189 int i;
190 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
191 if (nfs_cb_errtbl[i].stat == stat)
192 return nfs_cb_errtbl[i].errno;
193 }
194 /* If we cannot translate the error, the recovery routines should
195 * handle it.
196 * Note: remaining NFSv4 error codes have values > 10000, so should
197 * not conflict with native Linux error codes.
198 */
199 return stat;
200}
201
202/*
203 * XDR encode
204 */
205
Andy Adamsonef52bff2009-06-16 04:20:50 +0300206static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207encode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr)
208{
Al Virof00f3282006-10-19 23:29:01 -0700209 __be32 * p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
211 RESERVE_SPACE(16);
212 WRITE32(0); /* tag length is always 0 */
Andy Adamsonab52ae62009-06-16 04:20:53 +0300213 WRITE32(hdr->minorversion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 WRITE32(hdr->ident);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300215 hdr->nops_p = p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 WRITE32(hdr->nops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217}
218
Andy Adamsonef52bff2009-06-16 04:20:50 +0300219static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
220{
221 *hdr->nops_p = htonl(hdr->nops);
222}
223
224static void
225encode_cb_recall(struct xdr_stream *xdr, struct nfs4_delegation *dp,
226 struct nfs4_cb_compound_hdr *hdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
Al Virof00f3282006-10-19 23:29:01 -0700228 __be32 *p;
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400229 int len = dp->dl_fh.fh_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400231 RESERVE_SPACE(12+sizeof(dp->dl_stateid) + len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 WRITE32(OP_CB_RECALL);
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400233 WRITE32(dp->dl_stateid.si_generation);
234 WRITEMEM(&dp->dl_stateid.si_opaque, sizeof(stateid_opaque_t));
J. Bruce Fields6707bd32009-05-01 19:57:46 -0400235 WRITE32(0); /* truncate optimization not implemented */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 WRITE32(len);
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400237 WRITEMEM(&dp->dl_fh.fh_base, len);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300238 hdr->nops++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239}
240
Benny Halevy2af73582009-09-10 12:26:51 +0300241static void
242encode_cb_sequence(struct xdr_stream *xdr, struct nfsd4_cb_sequence *args,
243 struct nfs4_cb_compound_hdr *hdr)
244{
245 __be32 *p;
246
247 if (hdr->minorversion == 0)
248 return;
249
250 RESERVE_SPACE(1 + NFS4_MAX_SESSIONID_LEN + 20);
251
252 WRITE32(OP_CB_SEQUENCE);
253 WRITEMEM(args->cbs_clp->cl_sessionid.data, NFS4_MAX_SESSIONID_LEN);
254 WRITE32(args->cbs_clp->cl_cb_seq_nr);
255 WRITE32(0); /* slotid, always 0 */
256 WRITE32(0); /* highest slotid always 0 */
257 WRITE32(0); /* cachethis always 0 */
258 WRITE32(0); /* FIXME: support referring_call_lists */
259 hdr->nops++;
260}
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262static int
Al Virof00f3282006-10-19 23:29:01 -0700263nfs4_xdr_enc_cb_null(struct rpc_rqst *req, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264{
265 struct xdr_stream xdrs, *xdr = &xdrs;
266
267 xdr_init_encode(&xdrs, &req->rq_snd_buf, p);
268 RESERVE_SPACE(0);
269 return 0;
270}
271
272static int
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300273nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, __be32 *p,
274 struct nfs4_rpc_args *rpc_args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275{
276 struct xdr_stream xdr;
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300277 struct nfs4_delegation *args = rpc_args->args_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 struct nfs4_cb_compound_hdr hdr = {
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400279 .ident = args->dl_ident,
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300280 .minorversion = rpc_args->args_seq.cbs_minorversion,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 };
282
283 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
284 encode_cb_compound_hdr(&xdr, &hdr);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300285 encode_cb_sequence(&xdr, &rpc_args->args_seq, &hdr);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300286 encode_cb_recall(&xdr, args, &hdr);
287 encode_cb_nops(&hdr);
288 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289}
290
291
292static int
293decode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr){
Al Virof00f3282006-10-19 23:29:01 -0700294 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
296 READ_BUF(8);
297 READ32(hdr->status);
298 READ32(hdr->taglen);
299 READ_BUF(hdr->taglen + 4);
300 hdr->tag = (char *)p;
301 p += XDR_QUADLEN(hdr->taglen);
302 READ32(hdr->nops);
303 return 0;
304}
305
306static int
307decode_cb_op_hdr(struct xdr_stream *xdr, enum nfs_opnum4 expected)
308{
Al Virof00f3282006-10-19 23:29:01 -0700309 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 u32 op;
311 int32_t nfserr;
312
313 READ_BUF(8);
314 READ32(op);
315 if (op != expected) {
316 dprintk("NFSD: decode_cb_op_hdr: Callback server returned "
317 " operation %d but we issued a request for %d\n",
318 op, expected);
319 return -EIO;
320 }
321 READ32(nfserr);
322 if (nfserr != NFS_OK)
323 return -nfs_cb_stat_to_errno(nfserr);
324 return 0;
325}
326
Benny Halevy2af73582009-09-10 12:26:51 +0300327/*
328 * Our current back channel implmentation supports a single backchannel
329 * with a single slot.
330 */
331static int
332decode_cb_sequence(struct xdr_stream *xdr, struct nfsd4_cb_sequence *res,
333 struct rpc_rqst *rqstp)
334{
335 struct nfs4_sessionid id;
336 int status;
337 u32 dummy;
338 __be32 *p;
339
340 if (res->cbs_minorversion == 0)
341 return 0;
342
343 status = decode_cb_op_hdr(xdr, OP_CB_SEQUENCE);
344 if (status)
345 return status;
346
347 /*
348 * If the server returns different values for sessionID, slotID or
349 * sequence number, the server is looney tunes.
350 */
351 status = -ESERVERFAULT;
352
353 READ_BUF(NFS4_MAX_SESSIONID_LEN + 16);
354 memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
355 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
356 if (memcmp(id.data, res->cbs_clp->cl_sessionid.data,
357 NFS4_MAX_SESSIONID_LEN)) {
358 dprintk("%s Invalid session id\n", __func__);
359 goto out;
360 }
361 READ32(dummy);
362 if (dummy != res->cbs_clp->cl_cb_seq_nr) {
363 dprintk("%s Invalid sequence number\n", __func__);
364 goto out;
365 }
366 READ32(dummy); /* slotid must be 0 */
367 if (dummy != 0) {
368 dprintk("%s Invalid slotid\n", __func__);
369 goto out;
370 }
371 /* FIXME: process highest slotid and target highest slotid */
372 status = 0;
373out:
374 return status;
375}
376
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378static int
Al Virof00f3282006-10-19 23:29:01 -0700379nfs4_xdr_dec_cb_null(struct rpc_rqst *req, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380{
381 return 0;
382}
383
384static int
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300385nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp, __be32 *p,
386 struct nfsd4_cb_sequence *seq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387{
388 struct xdr_stream xdr;
389 struct nfs4_cb_compound_hdr hdr;
390 int status;
391
392 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
393 status = decode_cb_compound_hdr(&xdr, &hdr);
394 if (status)
395 goto out;
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300396 if (seq) {
397 status = decode_cb_sequence(&xdr, seq, rqstp);
398 if (status)
399 goto out;
400 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 status = decode_cb_op_hdr(&xdr, OP_CB_RECALL);
402out:
403 return status;
404}
405
406/*
407 * RPC procedure tables
408 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409#define PROC(proc, call, argtype, restype) \
410[NFSPROC4_CLNT_##proc] = { \
411 .p_proc = NFSPROC4_CB_##call, \
412 .p_encode = (kxdrproc_t) nfs4_xdr_##argtype, \
413 .p_decode = (kxdrproc_t) nfs4_xdr_##restype, \
Chuck Lever2bea90d2007-03-29 16:47:53 -0400414 .p_arglen = NFS4_##argtype##_sz, \
415 .p_replen = NFS4_##restype##_sz, \
Chuck Levercc0175c2006-03-20 13:44:22 -0500416 .p_statidx = NFSPROC4_CB_##call, \
417 .p_name = #proc, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418}
419
NeilBrownfd39ca92005-06-23 22:04:03 -0700420static struct rpc_procinfo nfs4_cb_procedures[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 PROC(CB_NULL, NULL, enc_cb_null, dec_cb_null),
422 PROC(CB_RECALL, COMPOUND, enc_cb_recall, dec_cb_recall),
423};
424
NeilBrownfd39ca92005-06-23 22:04:03 -0700425static struct rpc_version nfs_cb_version4 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 .number = 1,
Tobias Klausere8c96f82006-03-24 03:15:34 -0800427 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 .procs = nfs4_cb_procedures
429};
430
431static struct rpc_version * nfs_cb_version[] = {
432 NULL,
433 &nfs_cb_version4,
434};
435
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400436static struct rpc_program cb_program;
437
438static struct rpc_stat cb_stats = {
439 .program = &cb_program
440};
441
442#define NFS4_CALLBACK 0x40000000
443static struct rpc_program cb_program = {
444 .name = "nfs4_cb",
445 .number = NFS4_CALLBACK,
446 .nrvers = ARRAY_SIZE(nfs_cb_version),
447 .version = nfs_cb_version,
448 .stats = &cb_stats,
Olga Kornievskaia61054b12008-12-23 16:19:00 -0500449 .pipe_dir_name = "/nfsd4_cb",
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400450};
451
J. Bruce Fields595947a2009-03-05 17:18:10 -0500452static int max_cb_time(void)
453{
J. Bruce Fieldscf07d2e2010-02-28 23:20:19 -0500454 return max(nfsd4_lease/10, (time_t)1) * HZ;
J. Bruce Fields595947a2009-03-05 17:18:10 -0500455}
456
J. Bruce Fields2b47eec2007-07-27 18:06:50 -0400457/* Reference counting, callback cleanup, etc., all look racy as heck.
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500458 * And why is cl_cb_set an atomic? */
J. Bruce Fields2b47eec2007-07-27 18:06:50 -0400459
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500460int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *cb)
J. Bruce Fields2b47eec2007-07-27 18:06:50 -0400461{
Chuck Leverae5c7942006-08-22 20:06:21 -0400462 struct rpc_timeout timeparms = {
J. Bruce Fields595947a2009-03-05 17:18:10 -0500463 .to_initval = max_cb_time(),
464 .to_retries = 0,
Chuck Leverae5c7942006-08-22 20:06:21 -0400465 };
Chuck Leverae5c7942006-08-22 20:06:21 -0400466 struct rpc_create_args args = {
Alexandros Batsakis3ddc8bf2009-09-10 12:27:21 +0300467 .protocol = XPRT_TRANSPORT_TCP,
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400468 .address = (struct sockaddr *) &cb->cb_addr,
469 .addrsize = cb->cb_addrlen,
Chuck Leverae5c7942006-08-22 20:06:21 -0400470 .timeout = &timeparms,
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400471 .program = &cb_program,
Benny Halevyd5b337b2008-09-28 09:21:26 +0300472 .prognumber = cb->cb_prog,
Chuck Leverae5c7942006-08-22 20:06:21 -0400473 .version = nfs_cb_version[1]->number,
Olga Kornievskaia61054b12008-12-23 16:19:00 -0500474 .authflavor = clp->cl_flavor,
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400475 .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET),
Olga Kornievskaia608207e2008-12-23 16:17:40 -0500476 .client_name = clp->cl_principal,
Chuck Leverae5c7942006-08-22 20:06:21 -0400477 };
J. Bruce Fields63c86712007-10-25 19:00:26 -0400478 struct rpc_clnt *client;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
J. Bruce Fields418cd202009-02-22 15:52:13 -0800480 if (!clp->cl_principal && (clp->cl_flavor >= RPC_AUTH_GSS_KRB5))
J. Bruce Fieldse1cab5a2009-02-23 10:45:27 -0800481 return -EINVAL;
Alexandros Batsakis3ddc8bf2009-09-10 12:27:21 +0300482 if (cb->cb_minorversion) {
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500483 args.bc_xprt = cb->cb_xprt;
Alexandros Batsakis3ddc8bf2009-09-10 12:27:21 +0300484 args.protocol = XPRT_TRANSPORT_BC_TCP;
485 }
Chuck Leverae5c7942006-08-22 20:06:21 -0400486 /* Create RPC client */
J. Bruce Fields63c86712007-10-25 19:00:26 -0400487 client = rpc_create(&args);
J. Bruce Fieldse1cab5a2009-02-23 10:45:27 -0800488 if (IS_ERR(client)) {
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800489 dprintk("NFSD: couldn't create callback client: %ld\n",
490 PTR_ERR(client));
J. Bruce Fieldse1cab5a2009-02-23 10:45:27 -0800491 return PTR_ERR(client);
492 }
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500493 nfsd4_set_callback_client(clp, client);
J. Bruce Fieldse1cab5a2009-02-23 10:45:27 -0800494 return 0;
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800495
496}
497
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800498static void warn_no_callback_path(struct nfs4_client *clp, int reason)
499{
500 dprintk("NFSD: warning: no callback path to client %.*s: error %d\n",
501 (int)clp->cl_name.len, clp->cl_name.data, reason);
502}
503
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500504static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata)
505{
506 struct nfs4_client *clp = calldata;
507
508 if (task->tk_status)
509 warn_no_callback_path(clp, task->tk_status);
510 else
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500511 atomic_set(&clp->cl_cb_set, 1);
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500512}
513
514static const struct rpc_call_ops nfsd4_cb_probe_ops = {
515 .rpc_call_done = nfsd4_cb_probe_done,
516};
517
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400518static struct rpc_cred *callback_cred;
J. Bruce Fields3cef9ab2009-02-23 21:42:10 -0800519
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400520int set_callback_cred(void)
521{
J. Bruce Fields8d75da82010-03-03 16:13:29 -0500522 if (callback_cred)
523 return 0;
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400524 callback_cred = rpc_lookup_machine_cred();
525 if (!callback_cred)
526 return -ENOMEM;
527 return 0;
J. Bruce Fields3cef9ab2009-02-23 21:42:10 -0800528}
529
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400530
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500531void do_probe_callback(struct nfs4_client *clp)
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800532{
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800533 struct rpc_message msg = {
534 .rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL],
535 .rpc_argp = clp,
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400536 .rpc_cred = callback_cred
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800537 };
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800538 int status;
539
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500540 status = rpc_call_async(clp->cl_cb_client, &msg,
Chuck Lever58255a42010-02-24 13:48:06 -0800541 RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500542 &nfsd4_cb_probe_ops, (void *)clp);
J. Bruce Fields9045b4b2010-02-21 17:53:04 -0800543 if (status)
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800544 warn_no_callback_path(clp, status);
J. Bruce Fields63c86712007-10-25 19:00:26 -0400545}
546
547/*
548 * Set up the callback client and put a NFSPROC4_CB_NULL on the wire...
549 */
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500550void nfsd4_probe_callback(struct nfs4_client *clp, struct nfs4_cb_conn *cb)
J. Bruce Fields63c86712007-10-25 19:00:26 -0400551{
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800552 int status;
J. Bruce Fields63c86712007-10-25 19:00:26 -0400553
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500554 BUG_ON(atomic_read(&clp->cl_cb_set));
J. Bruce Fields63c86712007-10-25 19:00:26 -0400555
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500556 status = setup_callback_client(clp, cb);
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800557 if (status) {
558 warn_no_callback_path(clp, status);
559 return;
560 }
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500561 do_probe_callback(clp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562}
563
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300564/*
565 * There's currently a single callback channel slot.
566 * If the slot is available, then mark it busy. Otherwise, set the
567 * thread for sleeping on the callback RPC wait queue.
568 */
569static int nfsd41_cb_setup_sequence(struct nfs4_client *clp,
570 struct rpc_task *task)
571{
572 struct nfs4_rpc_args *args = task->tk_msg.rpc_argp;
573 u32 *ptr = (u32 *)clp->cl_sessionid.data;
574 int status = 0;
575
576 dprintk("%s: %u:%u:%u:%u\n", __func__,
577 ptr[0], ptr[1], ptr[2], ptr[3]);
578
579 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
580 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
581 dprintk("%s slot is busy\n", __func__);
582 status = -EAGAIN;
583 goto out;
584 }
585
586 /*
587 * We'll need the clp during XDR encoding and decoding,
588 * and the sequence during decoding to verify the reply
589 */
590 args->args_seq.cbs_clp = clp;
591 task->tk_msg.rpc_resp = &args->args_seq;
592
593out:
594 dprintk("%s status=%d\n", __func__, status);
595 return status;
596}
597
598/*
599 * TODO: cb_sequence should support referring call lists, cachethis, multiple
600 * slots, and mark callback channel down on communication errors.
601 */
602static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
603{
604 struct nfs4_delegation *dp = calldata;
605 struct nfs4_client *clp = dp->dl_client;
606 struct nfs4_rpc_args *args = task->tk_msg.rpc_argp;
607 u32 minorversion = clp->cl_cb_conn.cb_minorversion;
608 int status = 0;
609
610 args->args_seq.cbs_minorversion = minorversion;
611 if (minorversion) {
612 status = nfsd41_cb_setup_sequence(clp, task);
613 if (status) {
614 if (status != -EAGAIN) {
615 /* terminate rpc task */
616 task->tk_status = status;
617 task->tk_action = NULL;
618 }
619 return;
620 }
621 }
622 rpc_call_start(task);
623}
624
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300625static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
626{
627 struct nfs4_delegation *dp = calldata;
628 struct nfs4_client *clp = dp->dl_client;
629
630 dprintk("%s: minorversion=%d\n", __func__,
631 clp->cl_cb_conn.cb_minorversion);
632
633 if (clp->cl_cb_conn.cb_minorversion) {
634 /* No need for lock, access serialized in nfsd4_cb_prepare */
635 ++clp->cl_cb_seq_nr;
636 clear_bit(0, &clp->cl_cb_slot_busy);
637 rpc_wake_up_next(&clp->cl_cb_waitq);
638 dprintk("%s: freed slot, new seqid=%d\n", __func__,
639 clp->cl_cb_seq_nr);
640
641 /* We're done looking into the sequence information */
642 task->tk_msg.rpc_resp = NULL;
643 }
644}
645
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500646
J. Bruce Fields63e48632009-05-01 22:36:55 -0400647static void nfsd4_cb_recall_done(struct rpc_task *task, void *calldata)
648{
649 struct nfs4_delegation *dp = calldata;
650 struct nfs4_client *clp = dp->dl_client;
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500651 struct rpc_clnt *current_rpc_client = clp->cl_cb_client;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400652
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300653 nfsd4_cb_done(task, calldata);
654
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500655 if (current_rpc_client == NULL) {
656 /* We're shutting down; give up. */
657 /* XXX: err, or is it ok just to fall through
658 * and rpc_restart_call? */
659 return;
660 }
661
J. Bruce Fields63e48632009-05-01 22:36:55 -0400662 switch (task->tk_status) {
663 case -EIO:
664 /* Network partition? */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500665 atomic_set(&clp->cl_cb_set, 0);
J. Bruce Fields63e48632009-05-01 22:36:55 -0400666 warn_no_callback_path(clp, task->tk_status);
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500667 if (current_rpc_client != task->tk_client) {
668 /* queue a callback on the new connection: */
669 nfsd4_cb_recall(dp);
670 return;
671 }
J. Bruce Fields63e48632009-05-01 22:36:55 -0400672 case -EBADHANDLE:
673 case -NFS4ERR_BAD_STATEID:
674 /* Race: client probably got cb_recall
675 * before open reply granting delegation */
676 break;
677 default:
678 /* success, or error we can't handle */
J. Bruce Fields227f98d2010-02-18 08:27:24 -0800679 return;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400680 }
681 if (dp->dl_retries--) {
682 rpc_delay(task, 2*HZ);
683 task->tk_status = 0;
684 rpc_restart_call(task);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300685 return;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400686 } else {
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500687 atomic_set(&clp->cl_cb_set, 0);
J. Bruce Fields63e48632009-05-01 22:36:55 -0400688 warn_no_callback_path(clp, task->tk_status);
689 }
690}
691
692static void nfsd4_cb_recall_release(void *calldata)
693{
694 struct nfs4_delegation *dp = calldata;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400695
696 nfs4_put_delegation(dp);
J. Bruce Fields63e48632009-05-01 22:36:55 -0400697}
698
699static const struct rpc_call_ops nfsd4_cb_recall_ops = {
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300700 .rpc_call_prepare = nfsd4_cb_prepare,
J. Bruce Fields63e48632009-05-01 22:36:55 -0400701 .rpc_call_done = nfsd4_cb_recall_done,
702 .rpc_release = nfsd4_cb_recall_release,
703};
704
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500705static struct workqueue_struct *callback_wq;
706
707int nfsd4_create_callback_queue(void)
708{
709 callback_wq = create_singlethread_workqueue("nfsd4_callbacks");
710 if (!callback_wq)
711 return -ENOMEM;
712 return 0;
713}
714
715void nfsd4_destroy_callback_queue(void)
716{
717 destroy_workqueue(callback_wq);
718}
719
J. Bruce Fields4b21d0d2010-03-07 23:39:01 -0500720void nfsd4_set_callback_client(struct nfs4_client *clp, struct rpc_clnt *new)
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500721{
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500722 struct rpc_clnt *old = clp->cl_cb_client;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500723
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500724 clp->cl_cb_client = new;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500725 /*
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500726 * After this, any work that saw the old value of cl_cb_client will
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500727 * be gone:
728 */
729 flush_workqueue(callback_wq);
730 /* So we can safely shut it down: */
731 if (old)
732 rpc_shutdown_client(old);
733}
734
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735/*
736 * called with dp->dl_count inc'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 */
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500738static void _nfsd4_cb_recall(struct nfs4_delegation *dp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739{
740 struct nfs4_client *clp = dp->dl_client;
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500741 struct rpc_clnt *clnt = clp->cl_cb_client;
J. Bruce Fields227f98d2010-02-18 08:27:24 -0800742 struct nfs4_rpc_args *args = &dp->dl_recall.cb_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 struct rpc_message msg = {
744 .rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL],
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400745 .rpc_cred = callback_cred
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 };
J. Bruce Fields227f98d2010-02-18 08:27:24 -0800747 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500749 if (clnt == NULL)
750 return; /* Client is shutting down; give up. */
751
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300752 args->args_op = dp;
753 msg.rpc_argp = args;
J. Bruce Fields3aea09d2009-05-01 20:11:12 -0400754 dp->dl_retries = 1;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400755 status = rpc_call_async(clnt, &msg, RPC_TASK_SOFT,
756 &nfsd4_cb_recall_ops, dp);
J. Bruce Fieldsb12a05c2010-03-04 11:32:59 -0500757 if (status)
J. Bruce Fields63e48632009-05-01 22:36:55 -0400758 nfs4_put_delegation(dp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759}
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500760
761void nfsd4_do_callback_rpc(struct work_struct *w)
762{
763 /* XXX: for now, just send off delegation recall. */
764 /* In future, generalize to handle any sort of callback. */
765 struct nfsd4_callback *c = container_of(w, struct nfsd4_callback, cb_work);
766 struct nfs4_delegation *dp = container_of(c, struct nfs4_delegation, dl_recall);
767
768 _nfsd4_cb_recall(dp);
769}
770
771
772void nfsd4_cb_recall(struct nfs4_delegation *dp)
773{
774 queue_work(callback_wq, &dp->dl_recall.cb_work);
775}