Commit | Line | Data |
---|---|---|
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 | ||
47 | enum { | |
4be36ca0 | 48 | NFSPROC4_CLNT_CB_NULL = 0, |
1da177e4 | 49 | NFSPROC4_CLNT_CB_RECALL, |
38524ab3 | 50 | NFSPROC4_CLNT_CB_SEQUENCE, |
1da177e4 LT |
51 | }; |
52 | ||
53 | enum 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 |
85 | static inline __be32 * |
86 | xdr_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; \ | |
111 | out: \ | |
112 | return status; \ | |
113 | xdr_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 | ||
137 | struct 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 | ||
147 | static struct { | |
148 | int stat; | |
149 | int 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 | ||
184 | static int | |
185 | nfs_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 |
204 | static void |
205 | encode_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 | 214 | static void |
1da177e4 LT |
215 | encode_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 |
227 | static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr) |
228 | { | |
229 | *hdr->nops_p = htonl(hdr->nops); | |
230 | } | |
231 | ||
232 | static void | |
233 | encode_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 | 249 | static void |
fb003923 | 250 | encode_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); |
fb003923 | 263 | WRITE32(cb->cb_clp->cl_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 | 271 | static int |
f00f328f | 272 | nfs4_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 | ||
281 | static int | |
0421b5c5 | 282 | nfs4_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 | ||
301 | static int | |
302 | decode_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 | ||
316 | static int | |
317 | decode_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 | */ | |
341 | static int | |
fb003923 | 342 | decode_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); | |
fb003923 | 372 | if (dummy != cb->cb_clp->cl_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; | |
383 | out: | |
384 | return status; | |
385 | } | |
386 | ||
387 | ||
1da177e4 | 388 | static int |
f00f328f | 389 | nfs4_xdr_dec_cb_null(struct rpc_rqst *req, __be32 *p) |
1da177e4 LT |
390 | { |
391 | return 0; | |
392 | } | |
393 | ||
394 | static int | |
0421b5c5 | 395 | nfs4_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); |
412 | out: | |
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 | 430 | static 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 | 435 | static 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 | ||
448 | static struct rpc_version * nfs_cb_version[] = { | |
1da177e4 LT |
449 | &nfs_cb_version4, |
450 | }; | |
451 | ||
ff7d9756 OK |
452 | static struct rpc_program cb_program; |
453 | ||
454 | static struct rpc_stat cb_stats = { | |
455 | .program = &cb_program | |
456 | }; | |
457 | ||
458 | #define NFS4_CALLBACK 0x40000000 | |
459 | static 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 |
468 | static int max_cb_time(void) |
469 | { | |
cf07d2ea | 470 | return max(nfsd4_lease/10, (time_t)1) * HZ; |
595947ac BF |
471 | } |
472 | ||
2b47eece | 473 | /* Reference counting, callback cleanup, etc., all look racy as heck. |
2bf23875 | 474 | * And why is cl_cb_set an atomic? */ |
2b47eece | 475 | |
07263f1e | 476 | int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn) |
2b47eece | 477 | { |
ae5c7947 | 478 | struct rpc_timeout timeparms = { |
595947ac BF |
479 | .to_initval = max_cb_time(), |
480 | .to_retries = 0, | |
ae5c7947 | 481 | }; |
ae5c7947 | 482 | struct rpc_create_args args = { |
c653ce3f | 483 | .net = &init_net, |
3ddc8bf5 | 484 | .protocol = XPRT_TRANSPORT_TCP, |
07263f1e BF |
485 | .address = (struct sockaddr *) &conn->cb_addr, |
486 | .addrsize = conn->cb_addrlen, | |
ae5c7947 | 487 | .timeout = &timeparms, |
ff7d9756 | 488 | .program = &cb_program, |
07263f1e | 489 | .prognumber = conn->cb_prog, |
b7299f44 | 490 | .version = 0, |
61054b14 | 491 | .authflavor = clp->cl_flavor, |
b6b6152c | 492 | .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET), |
608207e8 | 493 | .client_name = clp->cl_principal, |
ae5c7947 | 494 | }; |
63c86716 | 495 | struct rpc_clnt *client; |
1da177e4 | 496 | |
418cd20a | 497 | if (!clp->cl_principal && (clp->cl_flavor >= RPC_AUTH_GSS_KRB5)) |
e1cab5a5 | 498 | return -EINVAL; |
07263f1e BF |
499 | if (conn->cb_minorversion) { |
500 | args.bc_xprt = conn->cb_xprt; | |
3ddc8bf5 AB |
501 | args.protocol = XPRT_TRANSPORT_BC_TCP; |
502 | } | |
ae5c7947 | 503 | /* Create RPC client */ |
63c86716 | 504 | client = rpc_create(&args); |
e1cab5a5 | 505 | if (IS_ERR(client)) { |
a601caed BF |
506 | dprintk("NFSD: couldn't create callback client: %ld\n", |
507 | PTR_ERR(client)); | |
e1cab5a5 BF |
508 | return PTR_ERR(client); |
509 | } | |
6ff8da08 BF |
510 | clp->cl_cb_ident = conn->cb_ident; |
511 | clp->cl_cb_client = client; | |
e1cab5a5 | 512 | return 0; |
a601caed BF |
513 | |
514 | } | |
515 | ||
ecdd03b7 BF |
516 | static void warn_no_callback_path(struct nfs4_client *clp, int reason) |
517 | { | |
518 | dprintk("NFSD: warning: no callback path to client %.*s: error %d\n", | |
519 | (int)clp->cl_name.len, clp->cl_name.data, reason); | |
520 | } | |
521 | ||
e300a63c BF |
522 | static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata) |
523 | { | |
cee277d9 | 524 | struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null); |
e300a63c BF |
525 | |
526 | if (task->tk_status) | |
527 | warn_no_callback_path(clp, task->tk_status); | |
528 | else | |
2bf23875 | 529 | atomic_set(&clp->cl_cb_set, 1); |
e300a63c BF |
530 | } |
531 | ||
532 | static const struct rpc_call_ops nfsd4_cb_probe_ops = { | |
cee277d9 BF |
533 | /* XXX: release method to ensure we set the cb channel down if |
534 | * necessary on early failure? */ | |
e300a63c BF |
535 | .rpc_call_done = nfsd4_cb_probe_done, |
536 | }; | |
537 | ||
80fc015b BF |
538 | static struct rpc_cred *callback_cred; |
539 | ||
540 | int set_callback_cred(void) | |
3cef9ab2 | 541 | { |
8d75da8a BF |
542 | if (callback_cred) |
543 | return 0; | |
80fc015b BF |
544 | callback_cred = rpc_lookup_machine_cred(); |
545 | if (!callback_cred) | |
546 | return -ENOMEM; | |
547 | return 0; | |
3cef9ab2 BF |
548 | } |
549 | ||
cee277d9 | 550 | static struct workqueue_struct *callback_wq; |
80fc015b | 551 | |
e300a63c | 552 | void do_probe_callback(struct nfs4_client *clp) |
a601caed | 553 | { |
cee277d9 | 554 | struct nfsd4_callback *cb = &clp->cl_cb_null; |
a601caed | 555 | |
fb003923 BF |
556 | cb->cb_op = NULL; |
557 | cb->cb_clp = clp; | |
cee277d9 BF |
558 | |
559 | cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_NULL]; | |
560 | cb->cb_msg.rpc_argp = NULL; | |
561 | cb->cb_msg.rpc_resp = NULL; | |
562 | cb->cb_msg.rpc_cred = callback_cred; | |
563 | ||
564 | cb->cb_ops = &nfsd4_cb_probe_ops; | |
565 | ||
566 | queue_work(callback_wq, &cb->cb_work); | |
63c86716 BF |
567 | } |
568 | ||
569 | /* | |
570 | * Set up the callback client and put a NFSPROC4_CB_NULL on the wire... | |
571 | */ | |
07263f1e | 572 | void nfsd4_probe_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn) |
63c86716 | 573 | { |
2bf23875 | 574 | BUG_ON(atomic_read(&clp->cl_cb_set)); |
63c86716 | 575 | |
6ff8da08 BF |
576 | spin_lock(&clp->cl_lock); |
577 | memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn)); | |
578 | set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_cb_flags); | |
579 | spin_unlock(&clp->cl_lock); | |
e300a63c | 580 | do_probe_callback(clp); |
1da177e4 LT |
581 | } |
582 | ||
2a1d1b59 RL |
583 | /* |
584 | * There's currently a single callback channel slot. | |
585 | * If the slot is available, then mark it busy. Otherwise, set the | |
586 | * thread for sleeping on the callback RPC wait queue. | |
587 | */ | |
588 | static int nfsd41_cb_setup_sequence(struct nfs4_client *clp, | |
589 | struct rpc_task *task) | |
590 | { | |
90c8145b | 591 | u32 *ptr = (u32 *)clp->cl_cb_session->se_sessionid.data; |
2a1d1b59 RL |
592 | int status = 0; |
593 | ||
594 | dprintk("%s: %u:%u:%u:%u\n", __func__, | |
595 | ptr[0], ptr[1], ptr[2], ptr[3]); | |
596 | ||
597 | if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) { | |
598 | rpc_sleep_on(&clp->cl_cb_waitq, task, NULL); | |
599 | dprintk("%s slot is busy\n", __func__); | |
600 | status = -EAGAIN; | |
601 | goto out; | |
602 | } | |
2a1d1b59 RL |
603 | out: |
604 | dprintk("%s status=%d\n", __func__, status); | |
605 | return status; | |
606 | } | |
607 | ||
608 | /* | |
609 | * TODO: cb_sequence should support referring call lists, cachethis, multiple | |
610 | * slots, and mark callback channel down on communication errors. | |
611 | */ | |
612 | static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata) | |
613 | { | |
5878453d BF |
614 | struct nfsd4_callback *cb = calldata; |
615 | struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall); | |
2a1d1b59 | 616 | struct nfs4_client *clp = dp->dl_client; |
2a1d1b59 RL |
617 | u32 minorversion = clp->cl_cb_conn.cb_minorversion; |
618 | int status = 0; | |
619 | ||
fb003923 | 620 | cb->cb_minorversion = minorversion; |
2a1d1b59 RL |
621 | if (minorversion) { |
622 | status = nfsd41_cb_setup_sequence(clp, task); | |
623 | if (status) { | |
624 | if (status != -EAGAIN) { | |
625 | /* terminate rpc task */ | |
626 | task->tk_status = status; | |
627 | task->tk_action = NULL; | |
628 | } | |
629 | return; | |
630 | } | |
631 | } | |
632 | rpc_call_start(task); | |
633 | } | |
634 | ||
0421b5c5 RL |
635 | static void nfsd4_cb_done(struct rpc_task *task, void *calldata) |
636 | { | |
5878453d BF |
637 | struct nfsd4_callback *cb = calldata; |
638 | struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall); | |
0421b5c5 RL |
639 | struct nfs4_client *clp = dp->dl_client; |
640 | ||
641 | dprintk("%s: minorversion=%d\n", __func__, | |
642 | clp->cl_cb_conn.cb_minorversion); | |
643 | ||
644 | if (clp->cl_cb_conn.cb_minorversion) { | |
645 | /* No need for lock, access serialized in nfsd4_cb_prepare */ | |
646 | ++clp->cl_cb_seq_nr; | |
647 | clear_bit(0, &clp->cl_cb_slot_busy); | |
648 | rpc_wake_up_next(&clp->cl_cb_waitq); | |
649 | dprintk("%s: freed slot, new seqid=%d\n", __func__, | |
650 | clp->cl_cb_seq_nr); | |
651 | ||
652 | /* We're done looking into the sequence information */ | |
653 | task->tk_msg.rpc_resp = NULL; | |
654 | } | |
655 | } | |
656 | ||
4b21d0de | 657 | |
63e4863f BF |
658 | static void nfsd4_cb_recall_done(struct rpc_task *task, void *calldata) |
659 | { | |
5878453d BF |
660 | struct nfsd4_callback *cb = calldata; |
661 | struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall); | |
63e4863f | 662 | struct nfs4_client *clp = dp->dl_client; |
4b21d0de | 663 | struct rpc_clnt *current_rpc_client = clp->cl_cb_client; |
63e4863f | 664 | |
0421b5c5 RL |
665 | nfsd4_cb_done(task, calldata); |
666 | ||
4b21d0de BF |
667 | if (current_rpc_client == NULL) { |
668 | /* We're shutting down; give up. */ | |
669 | /* XXX: err, or is it ok just to fall through | |
670 | * and rpc_restart_call? */ | |
671 | return; | |
672 | } | |
673 | ||
63e4863f | 674 | switch (task->tk_status) { |
172c85dd BF |
675 | case 0: |
676 | return; | |
677 | case -EBADHANDLE: | |
678 | case -NFS4ERR_BAD_STATEID: | |
679 | /* Race: client probably got cb_recall | |
680 | * before open reply granting delegation */ | |
681 | break; | |
682 | default: | |
63e4863f | 683 | /* Network partition? */ |
2bf23875 | 684 | atomic_set(&clp->cl_cb_set, 0); |
63e4863f | 685 | warn_no_callback_path(clp, task->tk_status); |
4b21d0de BF |
686 | if (current_rpc_client != task->tk_client) { |
687 | /* queue a callback on the new connection: */ | |
cba9ba4b | 688 | atomic_inc(&dp->dl_count); |
4b21d0de BF |
689 | nfsd4_cb_recall(dp); |
690 | return; | |
691 | } | |
63e4863f BF |
692 | } |
693 | if (dp->dl_retries--) { | |
694 | rpc_delay(task, 2*HZ); | |
695 | task->tk_status = 0; | |
c18c821f | 696 | rpc_restart_call_prepare(task); |
0421b5c5 | 697 | return; |
63e4863f | 698 | } else { |
2bf23875 | 699 | atomic_set(&clp->cl_cb_set, 0); |
63e4863f BF |
700 | warn_no_callback_path(clp, task->tk_status); |
701 | } | |
702 | } | |
703 | ||
704 | static void nfsd4_cb_recall_release(void *calldata) | |
705 | { | |
5878453d BF |
706 | struct nfsd4_callback *cb = calldata; |
707 | struct nfs4_delegation *dp = container_of(cb, struct nfs4_delegation, dl_recall); | |
63e4863f BF |
708 | |
709 | nfs4_put_delegation(dp); | |
63e4863f BF |
710 | } |
711 | ||
712 | static const struct rpc_call_ops nfsd4_cb_recall_ops = { | |
2a1d1b59 | 713 | .rpc_call_prepare = nfsd4_cb_prepare, |
63e4863f BF |
714 | .rpc_call_done = nfsd4_cb_recall_done, |
715 | .rpc_release = nfsd4_cb_recall_release, | |
716 | }; | |
717 | ||
b5a1a81e BF |
718 | int nfsd4_create_callback_queue(void) |
719 | { | |
720 | callback_wq = create_singlethread_workqueue("nfsd4_callbacks"); | |
721 | if (!callback_wq) | |
722 | return -ENOMEM; | |
723 | return 0; | |
724 | } | |
725 | ||
726 | void nfsd4_destroy_callback_queue(void) | |
727 | { | |
728 | destroy_workqueue(callback_wq); | |
729 | } | |
730 | ||
ab707e15 | 731 | /* must be called under the state lock */ |
6ff8da08 | 732 | void nfsd4_shutdown_callback(struct nfs4_client *clp) |
b5a1a81e | 733 | { |
6ff8da08 | 734 | set_bit(NFSD4_CLIENT_KILL, &clp->cl_cb_flags); |
b5a1a81e | 735 | /* |
6ff8da08 BF |
736 | * Note this won't actually result in a null callback; |
737 | * instead, nfsd4_do_callback_rpc() will detect the killed | |
738 | * client, destroy the rpc client, and stop: | |
b5a1a81e | 739 | */ |
6ff8da08 | 740 | do_probe_callback(clp); |
b5a1a81e | 741 | flush_workqueue(callback_wq); |
b5a1a81e BF |
742 | } |
743 | ||
5878453d | 744 | void nfsd4_release_cb(struct nfsd4_callback *cb) |
1da177e4 | 745 | { |
5878453d BF |
746 | if (cb->cb_ops->rpc_release) |
747 | cb->cb_ops->rpc_release(cb); | |
748 | } | |
749 | ||
6ff8da08 BF |
750 | void nfsd4_process_cb_update(struct nfsd4_callback *cb) |
751 | { | |
752 | struct nfs4_cb_conn conn; | |
753 | struct nfs4_client *clp = cb->cb_clp; | |
754 | int err; | |
755 | ||
756 | /* | |
757 | * This is either an update, or the client dying; in either case, | |
758 | * kill the old client: | |
759 | */ | |
760 | if (clp->cl_cb_client) { | |
761 | rpc_shutdown_client(clp->cl_cb_client); | |
762 | clp->cl_cb_client = NULL; | |
763 | } | |
764 | if (test_bit(NFSD4_CLIENT_KILL, &clp->cl_cb_flags)) | |
765 | return; | |
766 | spin_lock(&clp->cl_lock); | |
767 | /* | |
768 | * Only serialized callback code is allowed to clear these | |
769 | * flags; main nfsd code can only set them: | |
770 | */ | |
771 | BUG_ON(!clp->cl_cb_flags); | |
772 | clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_cb_flags); | |
773 | memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn)); | |
774 | spin_unlock(&clp->cl_lock); | |
775 | ||
776 | err = setup_callback_client(clp, &conn); | |
777 | if (err) | |
778 | warn_no_callback_path(clp, err); | |
779 | } | |
780 | ||
5878453d BF |
781 | void nfsd4_do_callback_rpc(struct work_struct *w) |
782 | { | |
783 | struct nfsd4_callback *cb = container_of(w, struct nfsd4_callback, cb_work); | |
fb003923 | 784 | struct nfs4_client *clp = cb->cb_clp; |
6ff8da08 | 785 | struct rpc_clnt *clnt; |
1da177e4 | 786 | |
6ff8da08 BF |
787 | if (clp->cl_cb_flags) |
788 | nfsd4_process_cb_update(cb); | |
789 | ||
790 | clnt = clp->cl_cb_client; | |
791 | if (!clnt) { | |
792 | /* Callback channel broken, or client killed; give up: */ | |
5878453d | 793 | nfsd4_release_cb(cb); |
6ff8da08 | 794 | return; |
ac94bf58 | 795 | } |
cee277d9 BF |
796 | rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN, |
797 | cb->cb_ops, cb); | |
1da177e4 | 798 | } |
b5a1a81e | 799 | |
5878453d | 800 | void nfsd4_cb_recall(struct nfs4_delegation *dp) |
b5a1a81e | 801 | { |
5878453d | 802 | struct nfsd4_callback *cb = &dp->dl_recall; |
b5a1a81e | 803 | |
5878453d | 804 | dp->dl_retries = 1; |
fb003923 BF |
805 | cb->cb_op = dp; |
806 | cb->cb_clp = dp->dl_client; | |
5878453d | 807 | cb->cb_msg.rpc_proc = &nfs4_cb_procedures[NFSPROC4_CLNT_CB_RECALL]; |
fb003923 BF |
808 | cb->cb_msg.rpc_argp = cb; |
809 | cb->cb_msg.rpc_resp = cb; | |
5878453d BF |
810 | cb->cb_msg.rpc_cred = callback_cred; |
811 | ||
812 | cb->cb_ops = &nfsd4_cb_recall_ops; | |
813 | dp->dl_retries = 1; | |
b5a1a81e | 814 | |
b5a1a81e BF |
815 | queue_work(callback_wq, &dp->dl_recall.cb_work); |
816 | } |