blob: b99c3f0f1d3596fed8d8f5e961bd11621a172c3d [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>
Boaz Harrosh9a74af22009-12-03 20:30:56 +020035#include "nfsd.h"
36#include "state.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38#define NFSDDBG_FACILITY NFSDDBG_PROC
39
40#define NFSPROC4_CB_NULL 0
41#define NFSPROC4_CB_COMPOUND 1
Andy Adamson38524ab2009-09-10 12:25:59 +030042#define NFS4_STATEID_SIZE 16
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044/* Index of predefined Linux callback client operations */
45
46enum {
Benny Halevy4be36ca2009-09-10 12:25:46 +030047 NFSPROC4_CLNT_CB_NULL = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 NFSPROC4_CLNT_CB_RECALL,
Andy Adamson38524ab2009-09-10 12:25:59 +030049 NFSPROC4_CLNT_CB_SEQUENCE,
Linus Torvalds1da177e2005-04-16 15:20:36 -070050};
51
52enum nfs_cb_opnum4 {
53 OP_CB_RECALL = 4,
Andy Adamson38524ab2009-09-10 12:25:59 +030054 OP_CB_SEQUENCE = 11,
Linus Torvalds1da177e2005-04-16 15:20:36 -070055};
56
57#define NFS4_MAXTAGLEN 20
58
59#define NFS4_enc_cb_null_sz 0
60#define NFS4_dec_cb_null_sz 0
61#define cb_compound_enc_hdr_sz 4
62#define cb_compound_dec_hdr_sz (3 + (NFS4_MAXTAGLEN >> 2))
Andy Adamson38524ab2009-09-10 12:25:59 +030063#define sessionid_sz (NFS4_MAX_SESSIONID_LEN >> 2)
64#define cb_sequence_enc_sz (sessionid_sz + 4 + \
65 1 /* no referring calls list yet */)
66#define cb_sequence_dec_sz (op_dec_sz + sessionid_sz + 4)
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#define op_enc_sz 1
69#define op_dec_sz 2
70#define enc_nfs4_fh_sz (1 + (NFS4_FHSIZE >> 2))
Benny Halevy0ac68d12007-07-17 04:04:37 -070071#define enc_stateid_sz (NFS4_STATEID_SIZE >> 2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#define NFS4_enc_cb_recall_sz (cb_compound_enc_hdr_sz + \
Andy Adamson38524ab2009-09-10 12:25:59 +030073 cb_sequence_enc_sz + \
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 1 + enc_stateid_sz + \
75 enc_nfs4_fh_sz)
76
77#define NFS4_dec_cb_recall_sz (cb_compound_dec_hdr_sz + \
Andy Adamson38524ab2009-09-10 12:25:59 +030078 cb_sequence_dec_sz + \
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 op_dec_sz)
80
81/*
82* Generic encode routines from fs/nfs/nfs4xdr.c
83*/
Al Virof00f3282006-10-19 23:29:01 -070084static inline __be32 *
85xdr_writemem(__be32 *p, const void *ptr, int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086{
87 int tmp = XDR_QUADLEN(nbytes);
88 if (!tmp)
89 return p;
90 p[tmp-1] = 0;
91 memcpy(p, ptr, nbytes);
92 return p + tmp;
93}
94
95#define WRITE32(n) *p++ = htonl(n)
96#define WRITEMEM(ptr,nbytes) do { \
97 p = xdr_writemem(p, ptr, nbytes); \
98} while (0)
99#define RESERVE_SPACE(nbytes) do { \
100 p = xdr_reserve_space(xdr, nbytes); \
Harvey Harrison8e24eea2008-04-30 00:55:09 -0700101 if (!p) dprintk("NFSD: RESERVE_SPACE(%d) failed in function %s\n", (int) (nbytes), __func__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 BUG_ON(!p); \
103} while (0)
104
105/*
106 * Generic decode routines from fs/nfs/nfs4xdr.c
107 */
108#define DECODE_TAIL \
109 status = 0; \
110out: \
111 return status; \
112xdr_error: \
113 dprintk("NFSD: xdr error! (%s:%d)\n", __FILE__, __LINE__); \
114 status = -EIO; \
115 goto out
116
117#define READ32(x) (x) = ntohl(*p++)
118#define READ64(x) do { \
119 (x) = (u64)ntohl(*p++) << 32; \
120 (x) |= ntohl(*p++); \
121} while (0)
122#define READTIME(x) do { \
123 p++; \
124 (x.tv_sec) = ntohl(*p++); \
125 (x.tv_nsec) = ntohl(*p++); \
126} while (0)
127#define READ_BUF(nbytes) do { \
128 p = xdr_inline_decode(xdr, nbytes); \
129 if (!p) { \
Greg Banks3e3b4802006-10-02 02:17:41 -0700130 dprintk("NFSD: %s: reply buffer overflowed in line %d.\n", \
Harvey Harrison8e24eea2008-04-30 00:55:09 -0700131 __func__, __LINE__); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 return -EIO; \
133 } \
134} while (0)
135
136struct nfs4_cb_compound_hdr {
Andy Adamson38524ab2009-09-10 12:25:59 +0300137 /* args */
138 u32 ident; /* minorversion 0 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 u32 nops;
Andy Adamsonef52bff2009-06-16 04:20:50 +0300140 __be32 *nops_p;
Andy Adamsonab52ae62009-06-16 04:20:53 +0300141 u32 minorversion;
Andy Adamson38524ab2009-09-10 12:25:59 +0300142 /* res */
143 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 u32 taglen;
Andy Adamsonef52bff2009-06-16 04:20:50 +0300145 char *tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146};
147
148static struct {
149int stat;
150int errno;
151} nfs_cb_errtbl[] = {
152 { NFS4_OK, 0 },
153 { NFS4ERR_PERM, EPERM },
154 { NFS4ERR_NOENT, ENOENT },
155 { NFS4ERR_IO, EIO },
156 { NFS4ERR_NXIO, ENXIO },
157 { NFS4ERR_ACCESS, EACCES },
158 { NFS4ERR_EXIST, EEXIST },
159 { NFS4ERR_XDEV, EXDEV },
160 { NFS4ERR_NOTDIR, ENOTDIR },
161 { NFS4ERR_ISDIR, EISDIR },
162 { NFS4ERR_INVAL, EINVAL },
163 { NFS4ERR_FBIG, EFBIG },
164 { NFS4ERR_NOSPC, ENOSPC },
165 { NFS4ERR_ROFS, EROFS },
166 { NFS4ERR_MLINK, EMLINK },
167 { NFS4ERR_NAMETOOLONG, ENAMETOOLONG },
168 { NFS4ERR_NOTEMPTY, ENOTEMPTY },
169 { NFS4ERR_DQUOT, EDQUOT },
170 { NFS4ERR_STALE, ESTALE },
171 { NFS4ERR_BADHANDLE, EBADHANDLE },
172 { NFS4ERR_BAD_COOKIE, EBADCOOKIE },
173 { NFS4ERR_NOTSUPP, ENOTSUPP },
174 { NFS4ERR_TOOSMALL, ETOOSMALL },
175 { NFS4ERR_SERVERFAULT, ESERVERFAULT },
176 { NFS4ERR_BADTYPE, EBADTYPE },
177 { NFS4ERR_LOCKED, EAGAIN },
178 { NFS4ERR_RESOURCE, EREMOTEIO },
179 { NFS4ERR_SYMLINK, ELOOP },
180 { NFS4ERR_OP_ILLEGAL, EOPNOTSUPP },
181 { NFS4ERR_DEADLOCK, EDEADLK },
182 { -1, EIO }
183};
184
185static int
186nfs_cb_stat_to_errno(int stat)
187{
188 int i;
189 for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) {
190 if (nfs_cb_errtbl[i].stat == stat)
191 return nfs_cb_errtbl[i].errno;
192 }
193 /* If we cannot translate the error, the recovery routines should
194 * handle it.
195 * Note: remaining NFSv4 error codes have values > 10000, so should
196 * not conflict with native Linux error codes.
197 */
198 return stat;
199}
200
201/*
202 * XDR encode
203 */
204
Andy Adamsonef52bff2009-06-16 04:20:50 +0300205static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206encode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr)
207{
Al Virof00f3282006-10-19 23:29:01 -0700208 __be32 * p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210 RESERVE_SPACE(16);
211 WRITE32(0); /* tag length is always 0 */
Andy Adamsonab52ae62009-06-16 04:20:53 +0300212 WRITE32(hdr->minorversion);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 WRITE32(hdr->ident);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300214 hdr->nops_p = p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 WRITE32(hdr->nops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216}
217
Andy Adamsonef52bff2009-06-16 04:20:50 +0300218static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr)
219{
220 *hdr->nops_p = htonl(hdr->nops);
221}
222
223static void
224encode_cb_recall(struct xdr_stream *xdr, struct nfs4_delegation *dp,
225 struct nfs4_cb_compound_hdr *hdr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
Al Virof00f3282006-10-19 23:29:01 -0700227 __be32 *p;
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400228 int len = dp->dl_fh.fh_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400230 RESERVE_SPACE(12+sizeof(dp->dl_stateid) + len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 WRITE32(OP_CB_RECALL);
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400232 WRITE32(dp->dl_stateid.si_generation);
233 WRITEMEM(&dp->dl_stateid.si_opaque, sizeof(stateid_opaque_t));
J. Bruce Fields6707bd32009-05-01 19:57:46 -0400234 WRITE32(0); /* truncate optimization not implemented */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 WRITE32(len);
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400236 WRITEMEM(&dp->dl_fh.fh_base, len);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300237 hdr->nops++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238}
239
Benny Halevy2af73582009-09-10 12:26:51 +0300240static void
241encode_cb_sequence(struct xdr_stream *xdr, struct nfsd4_cb_sequence *args,
242 struct nfs4_cb_compound_hdr *hdr)
243{
244 __be32 *p;
245
246 if (hdr->minorversion == 0)
247 return;
248
249 RESERVE_SPACE(1 + NFS4_MAX_SESSIONID_LEN + 20);
250
251 WRITE32(OP_CB_SEQUENCE);
252 WRITEMEM(args->cbs_clp->cl_sessionid.data, NFS4_MAX_SESSIONID_LEN);
253 WRITE32(args->cbs_clp->cl_cb_seq_nr);
254 WRITE32(0); /* slotid, always 0 */
255 WRITE32(0); /* highest slotid always 0 */
256 WRITE32(0); /* cachethis always 0 */
257 WRITE32(0); /* FIXME: support referring_call_lists */
258 hdr->nops++;
259}
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261static int
Al Virof00f3282006-10-19 23:29:01 -0700262nfs4_xdr_enc_cb_null(struct rpc_rqst *req, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263{
264 struct xdr_stream xdrs, *xdr = &xdrs;
265
266 xdr_init_encode(&xdrs, &req->rq_snd_buf, p);
267 RESERVE_SPACE(0);
268 return 0;
269}
270
271static int
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300272nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, __be32 *p,
273 struct nfs4_rpc_args *rpc_args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274{
275 struct xdr_stream xdr;
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300276 struct nfs4_delegation *args = rpc_args->args_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 struct nfs4_cb_compound_hdr hdr = {
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400278 .ident = args->dl_ident,
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300279 .minorversion = rpc_args->args_seq.cbs_minorversion,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 };
281
282 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
283 encode_cb_compound_hdr(&xdr, &hdr);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300284 encode_cb_sequence(&xdr, &rpc_args->args_seq, &hdr);
Andy Adamsonef52bff2009-06-16 04:20:50 +0300285 encode_cb_recall(&xdr, args, &hdr);
286 encode_cb_nops(&hdr);
287 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288}
289
290
291static int
292decode_cb_compound_hdr(struct xdr_stream *xdr, struct nfs4_cb_compound_hdr *hdr){
Al Virof00f3282006-10-19 23:29:01 -0700293 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
295 READ_BUF(8);
296 READ32(hdr->status);
297 READ32(hdr->taglen);
298 READ_BUF(hdr->taglen + 4);
299 hdr->tag = (char *)p;
300 p += XDR_QUADLEN(hdr->taglen);
301 READ32(hdr->nops);
302 return 0;
303}
304
305static int
306decode_cb_op_hdr(struct xdr_stream *xdr, enum nfs_opnum4 expected)
307{
Al Virof00f3282006-10-19 23:29:01 -0700308 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 u32 op;
310 int32_t nfserr;
311
312 READ_BUF(8);
313 READ32(op);
314 if (op != expected) {
315 dprintk("NFSD: decode_cb_op_hdr: Callback server returned "
316 " operation %d but we issued a request for %d\n",
317 op, expected);
318 return -EIO;
319 }
320 READ32(nfserr);
321 if (nfserr != NFS_OK)
322 return -nfs_cb_stat_to_errno(nfserr);
323 return 0;
324}
325
Benny Halevy2af73582009-09-10 12:26:51 +0300326/*
327 * Our current back channel implmentation supports a single backchannel
328 * with a single slot.
329 */
330static int
331decode_cb_sequence(struct xdr_stream *xdr, struct nfsd4_cb_sequence *res,
332 struct rpc_rqst *rqstp)
333{
334 struct nfs4_sessionid id;
335 int status;
336 u32 dummy;
337 __be32 *p;
338
339 if (res->cbs_minorversion == 0)
340 return 0;
341
342 status = decode_cb_op_hdr(xdr, OP_CB_SEQUENCE);
343 if (status)
344 return status;
345
346 /*
347 * If the server returns different values for sessionID, slotID or
348 * sequence number, the server is looney tunes.
349 */
350 status = -ESERVERFAULT;
351
352 READ_BUF(NFS4_MAX_SESSIONID_LEN + 16);
353 memcpy(id.data, p, NFS4_MAX_SESSIONID_LEN);
354 p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN);
355 if (memcmp(id.data, res->cbs_clp->cl_sessionid.data,
356 NFS4_MAX_SESSIONID_LEN)) {
357 dprintk("%s Invalid session id\n", __func__);
358 goto out;
359 }
360 READ32(dummy);
361 if (dummy != res->cbs_clp->cl_cb_seq_nr) {
362 dprintk("%s Invalid sequence number\n", __func__);
363 goto out;
364 }
365 READ32(dummy); /* slotid must be 0 */
366 if (dummy != 0) {
367 dprintk("%s Invalid slotid\n", __func__);
368 goto out;
369 }
370 /* FIXME: process highest slotid and target highest slotid */
371 status = 0;
372out:
373 return status;
374}
375
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377static int
Al Virof00f3282006-10-19 23:29:01 -0700378nfs4_xdr_dec_cb_null(struct rpc_rqst *req, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379{
380 return 0;
381}
382
383static int
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300384nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp, __be32 *p,
385 struct nfsd4_cb_sequence *seq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386{
387 struct xdr_stream xdr;
388 struct nfs4_cb_compound_hdr hdr;
389 int status;
390
391 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
392 status = decode_cb_compound_hdr(&xdr, &hdr);
393 if (status)
394 goto out;
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300395 if (seq) {
396 status = decode_cb_sequence(&xdr, seq, rqstp);
397 if (status)
398 goto out;
399 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 status = decode_cb_op_hdr(&xdr, OP_CB_RECALL);
401out:
402 return status;
403}
404
405/*
406 * RPC procedure tables
407 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408#define PROC(proc, call, argtype, restype) \
409[NFSPROC4_CLNT_##proc] = { \
410 .p_proc = NFSPROC4_CB_##call, \
411 .p_encode = (kxdrproc_t) nfs4_xdr_##argtype, \
412 .p_decode = (kxdrproc_t) nfs4_xdr_##restype, \
Chuck Lever2bea90d2007-03-29 16:47:53 -0400413 .p_arglen = NFS4_##argtype##_sz, \
414 .p_replen = NFS4_##restype##_sz, \
Chuck Levercc0175c2006-03-20 13:44:22 -0500415 .p_statidx = NFSPROC4_CB_##call, \
416 .p_name = #proc, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417}
418
NeilBrownfd39ca92005-06-23 22:04:03 -0700419static struct rpc_procinfo nfs4_cb_procedures[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 PROC(CB_NULL, NULL, enc_cb_null, dec_cb_null),
421 PROC(CB_RECALL, COMPOUND, enc_cb_recall, dec_cb_recall),
422};
423
NeilBrownfd39ca92005-06-23 22:04:03 -0700424static struct rpc_version nfs_cb_version4 = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 .number = 1,
Tobias Klausere8c96f82006-03-24 03:15:34 -0800426 .nrprocs = ARRAY_SIZE(nfs4_cb_procedures),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 .procs = nfs4_cb_procedures
428};
429
430static struct rpc_version * nfs_cb_version[] = {
431 NULL,
432 &nfs_cb_version4,
433};
434
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400435static struct rpc_program cb_program;
436
437static struct rpc_stat cb_stats = {
438 .program = &cb_program
439};
440
441#define NFS4_CALLBACK 0x40000000
442static struct rpc_program cb_program = {
443 .name = "nfs4_cb",
444 .number = NFS4_CALLBACK,
445 .nrvers = ARRAY_SIZE(nfs_cb_version),
446 .version = nfs_cb_version,
447 .stats = &cb_stats,
Olga Kornievskaia61054b12008-12-23 16:19:00 -0500448 .pipe_dir_name = "/nfsd4_cb",
Olga Kornievskaiaff7d9752008-03-28 16:04:56 -0400449};
450
J. Bruce Fields595947a2009-03-05 17:18:10 -0500451static int max_cb_time(void)
452{
J. Bruce Fieldscf07d2e2010-02-28 23:20:19 -0500453 return max(nfsd4_lease/10, (time_t)1) * HZ;
J. Bruce Fields595947a2009-03-05 17:18:10 -0500454}
455
J. Bruce Fields2b47eec2007-07-27 18:06:50 -0400456/* Reference counting, callback cleanup, etc., all look racy as heck.
457 * And why is cb_set an atomic? */
458
J. Bruce Fieldse1cab5a52009-02-23 10:45:27 -0800459int setup_callback_client(struct nfs4_client *clp)
J. Bruce Fields2b47eec2007-07-27 18:06:50 -0400460{
J. Bruce Fieldsc237dc02009-04-29 19:09:19 -0400461 struct nfs4_cb_conn *cb = &clp->cl_cb_conn;
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 Fieldse1cab5a52009-02-23 10:45:27 -0800481 return -EINVAL;
Alexandros Batsakis3ddc8bf2009-09-10 12:27:21 +0300482 if (cb->cb_minorversion) {
483 args.bc_xprt = clp->cl_cb_xprt;
484 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 Fieldse1cab5a52009-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 Fieldse1cab5a52009-02-23 10:45:27 -0800491 return PTR_ERR(client);
492 }
493 cb->cb_client = client;
494 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 Fieldsc237dc02009-04-29 19:09:19 -0400511 atomic_set(&clp->cl_cb_conn.cb_set, 1);
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500512 put_nfs4_client(clp);
513}
514
515static const struct rpc_call_ops nfsd4_cb_probe_ops = {
516 .rpc_call_done = nfsd4_cb_probe_done,
517};
518
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400519static struct rpc_cred *callback_cred;
J. Bruce Fields3cef9ab2009-02-23 21:42:10 -0800520
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400521int set_callback_cred(void)
522{
J. Bruce Fields8d75da8a2010-03-03 16:13:29 -0500523 if (callback_cred)
524 return 0;
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400525 callback_cred = rpc_lookup_machine_cred();
526 if (!callback_cred)
527 return -ENOMEM;
528 return 0;
J. Bruce Fields3cef9ab2009-02-23 21:42:10 -0800529}
530
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400531
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500532void do_probe_callback(struct nfs4_client *clp)
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800533{
J. Bruce Fieldsc237dc02009-04-29 19:09:19 -0400534 struct nfs4_cb_conn *cb = &clp->cl_cb_conn;
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800535 struct rpc_message msg = {
536 .rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL],
537 .rpc_argp = clp,
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400538 .rpc_cred = callback_cred
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800539 };
J. Bruce Fieldsa601cae2009-02-22 16:43:45 -0800540 int status;
541
Chuck Lever58255a42010-02-24 13:48:06 -0800542 status = rpc_call_async(cb->cb_client, &msg,
543 RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500544 &nfsd4_cb_probe_ops, (void *)clp);
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500545 if (status) {
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800546 warn_no_callback_path(clp, status);
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500547 put_nfs4_client(clp);
548 }
J. Bruce Fields63c86712007-10-25 19:00:26 -0400549}
550
551/*
552 * Set up the callback client and put a NFSPROC4_CB_NULL on the wire...
553 */
554void
555nfsd4_probe_callback(struct nfs4_client *clp)
556{
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800557 int status;
J. Bruce Fields63c86712007-10-25 19:00:26 -0400558
J. Bruce Fieldsc237dc02009-04-29 19:09:19 -0400559 BUG_ON(atomic_read(&clp->cl_cb_conn.cb_set));
J. Bruce Fields63c86712007-10-25 19:00:26 -0400560
J. Bruce Fieldsecdd03b2009-02-23 19:35:22 -0800561 status = setup_callback_client(clp);
562 if (status) {
563 warn_no_callback_path(clp, status);
564 return;
565 }
566
NeilBrown541e0e02006-04-10 22:55:38 -0700567 /* the task holds a reference to the nfs4_client struct */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 atomic_inc(&clp->cl_count);
569
J. Bruce Fieldse300a632009-03-05 15:01:11 -0500570 do_probe_callback(clp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
572
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300573/*
574 * There's currently a single callback channel slot.
575 * If the slot is available, then mark it busy. Otherwise, set the
576 * thread for sleeping on the callback RPC wait queue.
577 */
578static int nfsd41_cb_setup_sequence(struct nfs4_client *clp,
579 struct rpc_task *task)
580{
581 struct nfs4_rpc_args *args = task->tk_msg.rpc_argp;
582 u32 *ptr = (u32 *)clp->cl_sessionid.data;
583 int status = 0;
584
585 dprintk("%s: %u:%u:%u:%u\n", __func__,
586 ptr[0], ptr[1], ptr[2], ptr[3]);
587
588 if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) {
589 rpc_sleep_on(&clp->cl_cb_waitq, task, NULL);
590 dprintk("%s slot is busy\n", __func__);
591 status = -EAGAIN;
592 goto out;
593 }
594
595 /*
596 * We'll need the clp during XDR encoding and decoding,
597 * and the sequence during decoding to verify the reply
598 */
599 args->args_seq.cbs_clp = clp;
600 task->tk_msg.rpc_resp = &args->args_seq;
601
602out:
603 dprintk("%s status=%d\n", __func__, status);
604 return status;
605}
606
607/*
608 * TODO: cb_sequence should support referring call lists, cachethis, multiple
609 * slots, and mark callback channel down on communication errors.
610 */
611static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata)
612{
613 struct nfs4_delegation *dp = calldata;
614 struct nfs4_client *clp = dp->dl_client;
615 struct nfs4_rpc_args *args = task->tk_msg.rpc_argp;
616 u32 minorversion = clp->cl_cb_conn.cb_minorversion;
617 int status = 0;
618
619 args->args_seq.cbs_minorversion = minorversion;
620 if (minorversion) {
621 status = nfsd41_cb_setup_sequence(clp, task);
622 if (status) {
623 if (status != -EAGAIN) {
624 /* terminate rpc task */
625 task->tk_status = status;
626 task->tk_action = NULL;
627 }
628 return;
629 }
630 }
631 rpc_call_start(task);
632}
633
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300634static void nfsd4_cb_done(struct rpc_task *task, void *calldata)
635{
636 struct nfs4_delegation *dp = calldata;
637 struct nfs4_client *clp = dp->dl_client;
638
639 dprintk("%s: minorversion=%d\n", __func__,
640 clp->cl_cb_conn.cb_minorversion);
641
642 if (clp->cl_cb_conn.cb_minorversion) {
643 /* No need for lock, access serialized in nfsd4_cb_prepare */
644 ++clp->cl_cb_seq_nr;
645 clear_bit(0, &clp->cl_cb_slot_busy);
646 rpc_wake_up_next(&clp->cl_cb_waitq);
647 dprintk("%s: freed slot, new seqid=%d\n", __func__,
648 clp->cl_cb_seq_nr);
649
650 /* We're done looking into the sequence information */
651 task->tk_msg.rpc_resp = NULL;
652 }
653}
654
J. Bruce Fields63e48632009-05-01 22:36:55 -0400655static void nfsd4_cb_recall_done(struct rpc_task *task, void *calldata)
656{
657 struct nfs4_delegation *dp = calldata;
658 struct nfs4_client *clp = dp->dl_client;
659
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300660 nfsd4_cb_done(task, calldata);
661
J. Bruce Fields63e48632009-05-01 22:36:55 -0400662 switch (task->tk_status) {
663 case -EIO:
664 /* Network partition? */
665 atomic_set(&clp->cl_cb_conn.cb_set, 0);
666 warn_no_callback_path(clp, task->tk_status);
667 case -EBADHANDLE:
668 case -NFS4ERR_BAD_STATEID:
669 /* Race: client probably got cb_recall
670 * before open reply granting delegation */
671 break;
672 default:
673 /* success, or error we can't handle */
J. Bruce Fields227f98d92010-02-18 08:27:24 -0800674 return;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400675 }
676 if (dp->dl_retries--) {
677 rpc_delay(task, 2*HZ);
678 task->tk_status = 0;
679 rpc_restart_call(task);
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300680 return;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400681 } else {
682 atomic_set(&clp->cl_cb_conn.cb_set, 0);
683 warn_no_callback_path(clp, task->tk_status);
684 }
685}
686
687static void nfsd4_cb_recall_release(void *calldata)
688{
689 struct nfs4_delegation *dp = calldata;
690 struct nfs4_client *clp = dp->dl_client;
691
692 nfs4_put_delegation(dp);
693 put_nfs4_client(clp);
694}
695
696static const struct rpc_call_ops nfsd4_cb_recall_ops = {
Ricardo Labiaga2a1d1b52009-09-10 12:26:38 +0300697 .rpc_call_prepare = nfsd4_cb_prepare,
J. Bruce Fields63e48632009-05-01 22:36:55 -0400698 .rpc_call_done = nfsd4_cb_recall_done,
699 .rpc_release = nfsd4_cb_recall_release,
700};
701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702/*
703 * called with dp->dl_count inc'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 */
705void
706nfsd4_cb_recall(struct nfs4_delegation *dp)
707{
708 struct nfs4_client *clp = dp->dl_client;
J. Bruce Fieldsc237dc02009-04-29 19:09:19 -0400709 struct rpc_clnt *clnt = clp->cl_cb_conn.cb_client;
J. Bruce Fields227f98d92010-02-18 08:27:24 -0800710 struct nfs4_rpc_args *args = &dp->dl_recall.cb_args;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 struct rpc_message msg = {
712 .rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL],
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400713 .rpc_cred = callback_cred
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 };
J. Bruce Fields227f98d92010-02-18 08:27:24 -0800715 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Ricardo Labiaga0421b5c2009-09-10 12:27:04 +0300717 args->args_op = dp;
718 msg.rpc_argp = args;
J. Bruce Fields3aea09d2009-05-01 20:11:12 -0400719 dp->dl_retries = 1;
J. Bruce Fields63e48632009-05-01 22:36:55 -0400720 status = rpc_call_async(clnt, &msg, RPC_TASK_SOFT,
721 &nfsd4_cb_recall_ops, dp);
722 if (status) {
723 put_nfs4_client(clp);
724 nfs4_put_delegation(dp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726}