]>
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> |
d531c008 | 35 | #include <linux/sunrpc/xprt.h> |
b5a1a81e | 36 | #include <linux/sunrpc/svc_xprt.h> |
5a0e3ad6 | 37 | #include <linux/slab.h> |
9a74af21 BH |
38 | #include "nfsd.h" |
39 | #include "state.h" | |
3d733711 | 40 | #include "netns.h" |
1eace0d1 | 41 | #include "trace.h" |
06b332a5 | 42 | #include "xdr4cb.h" |
9eb190fc | 43 | #include "xdr4.h" |
1da177e4 LT |
44 | |
45 | #define NFSDDBG_FACILITY NFSDDBG_PROC | |
46 | ||
5423732a BH |
47 | static void nfsd4_mark_cb_fault(struct nfs4_client *, int reason); |
48 | ||
1da177e4 LT |
49 | #define NFSPROC4_CB_NULL 0 |
50 | #define NFSPROC4_CB_COMPOUND 1 | |
51 | ||
1da177e4 LT |
52 | /* Index of predefined Linux callback client operations */ |
53 | ||
1da177e4 | 54 | struct nfs4_cb_compound_hdr { |
38524ab3 AA |
55 | /* args */ |
56 | u32 ident; /* minorversion 0 only */ | |
1da177e4 | 57 | u32 nops; |
ef52bff8 | 58 | __be32 *nops_p; |
ab52ae6d | 59 | u32 minorversion; |
38524ab3 AA |
60 | /* res */ |
61 | int status; | |
1da177e4 LT |
62 | }; |
63 | ||
a033db48 CL |
64 | static __be32 *xdr_encode_empty_array(__be32 *p) |
65 | { | |
66 | *p++ = xdr_zero; | |
67 | return p; | |
68 | } | |
69 | ||
70 | /* | |
71 | * Encode/decode NFSv4 CB basic data types | |
72 | * | |
73 | * Basic NFSv4 callback data types are defined in section 15 of RFC | |
74 | * 3530: "Network File System (NFS) version 4 Protocol" and section | |
75 | * 20 of RFC 5661: "Network File System (NFS) Version 4 Minor Version | |
76 | * 1 Protocol" | |
77 | */ | |
78 | ||
79 | /* | |
80 | * nfs_cb_opnum4 | |
81 | * | |
82 | * enum nfs_cb_opnum4 { | |
83 | * OP_CB_GETATTR = 3, | |
84 | * ... | |
85 | * }; | |
86 | */ | |
87 | enum nfs_cb_opnum4 { | |
88 | OP_CB_GETATTR = 3, | |
89 | OP_CB_RECALL = 4, | |
90 | OP_CB_LAYOUTRECALL = 5, | |
91 | OP_CB_NOTIFY = 6, | |
92 | OP_CB_PUSH_DELEG = 7, | |
93 | OP_CB_RECALL_ANY = 8, | |
94 | OP_CB_RECALLABLE_OBJ_AVAIL = 9, | |
95 | OP_CB_RECALL_SLOT = 10, | |
96 | OP_CB_SEQUENCE = 11, | |
97 | OP_CB_WANTS_CANCELLED = 12, | |
98 | OP_CB_NOTIFY_LOCK = 13, | |
99 | OP_CB_NOTIFY_DEVICEID = 14, | |
9eb190fc | 100 | OP_CB_OFFLOAD = 15, |
a033db48 CL |
101 | OP_CB_ILLEGAL = 10044 |
102 | }; | |
103 | ||
104 | static void encode_nfs_cb_opnum4(struct xdr_stream *xdr, enum nfs_cb_opnum4 op) | |
105 | { | |
106 | __be32 *p; | |
107 | ||
108 | p = xdr_reserve_space(xdr, 4); | |
109 | *p = cpu_to_be32(op); | |
110 | } | |
111 | ||
112 | /* | |
113 | * nfs_fh4 | |
114 | * | |
115 | * typedef opaque nfs_fh4<NFS4_FHSIZE>; | |
116 | */ | |
117 | static void encode_nfs_fh4(struct xdr_stream *xdr, const struct knfsd_fh *fh) | |
118 | { | |
119 | u32 length = fh->fh_size; | |
120 | __be32 *p; | |
121 | ||
122 | BUG_ON(length > NFS4_FHSIZE); | |
123 | p = xdr_reserve_space(xdr, 4 + length); | |
124 | xdr_encode_opaque(p, &fh->fh_base, length); | |
125 | } | |
126 | ||
1da177e4 | 127 | /* |
a033db48 CL |
128 | * stateid4 |
129 | * | |
130 | * struct stateid4 { | |
131 | * uint32_t seqid; | |
132 | * opaque other[12]; | |
133 | * }; | |
1da177e4 | 134 | */ |
a033db48 CL |
135 | static void encode_stateid4(struct xdr_stream *xdr, const stateid_t *sid) |
136 | { | |
137 | __be32 *p; | |
1da177e4 | 138 | |
a033db48 CL |
139 | p = xdr_reserve_space(xdr, NFS4_STATEID_SIZE); |
140 | *p++ = cpu_to_be32(sid->si_generation); | |
141 | xdr_encode_opaque_fixed(p, &sid->si_opaque, NFS4_STATEID_OTHER_SIZE); | |
142 | } | |
143 | ||
144 | /* | |
145 | * sessionid4 | |
146 | * | |
147 | * typedef opaque sessionid4[NFS4_SESSIONID_SIZE]; | |
148 | */ | |
149 | static void encode_sessionid4(struct xdr_stream *xdr, | |
150 | const struct nfsd4_session *session) | |
9303bbd3 BH |
151 | { |
152 | __be32 *p; | |
153 | ||
a033db48 CL |
154 | p = xdr_reserve_space(xdr, NFS4_MAX_SESSIONID_LEN); |
155 | xdr_encode_opaque_fixed(p, session->se_sessionid.data, | |
156 | NFS4_MAX_SESSIONID_LEN); | |
9303bbd3 BH |
157 | } |
158 | ||
85a56480 CL |
159 | /* |
160 | * nfsstat4 | |
161 | */ | |
162 | static const struct { | |
163 | int stat; | |
164 | int errno; | |
165 | } nfs_cb_errtbl[] = { | |
166 | { NFS4_OK, 0 }, | |
167 | { NFS4ERR_PERM, -EPERM }, | |
168 | { NFS4ERR_NOENT, -ENOENT }, | |
169 | { NFS4ERR_IO, -EIO }, | |
170 | { NFS4ERR_NXIO, -ENXIO }, | |
171 | { NFS4ERR_ACCESS, -EACCES }, | |
172 | { NFS4ERR_EXIST, -EEXIST }, | |
173 | { NFS4ERR_XDEV, -EXDEV }, | |
174 | { NFS4ERR_NOTDIR, -ENOTDIR }, | |
175 | { NFS4ERR_ISDIR, -EISDIR }, | |
176 | { NFS4ERR_INVAL, -EINVAL }, | |
177 | { NFS4ERR_FBIG, -EFBIG }, | |
178 | { NFS4ERR_NOSPC, -ENOSPC }, | |
179 | { NFS4ERR_ROFS, -EROFS }, | |
180 | { NFS4ERR_MLINK, -EMLINK }, | |
181 | { NFS4ERR_NAMETOOLONG, -ENAMETOOLONG }, | |
182 | { NFS4ERR_NOTEMPTY, -ENOTEMPTY }, | |
183 | { NFS4ERR_DQUOT, -EDQUOT }, | |
184 | { NFS4ERR_STALE, -ESTALE }, | |
185 | { NFS4ERR_BADHANDLE, -EBADHANDLE }, | |
186 | { NFS4ERR_BAD_COOKIE, -EBADCOOKIE }, | |
187 | { NFS4ERR_NOTSUPP, -ENOTSUPP }, | |
188 | { NFS4ERR_TOOSMALL, -ETOOSMALL }, | |
189 | { NFS4ERR_SERVERFAULT, -ESERVERFAULT }, | |
190 | { NFS4ERR_BADTYPE, -EBADTYPE }, | |
191 | { NFS4ERR_LOCKED, -EAGAIN }, | |
192 | { NFS4ERR_RESOURCE, -EREMOTEIO }, | |
193 | { NFS4ERR_SYMLINK, -ELOOP }, | |
194 | { NFS4ERR_OP_ILLEGAL, -EOPNOTSUPP }, | |
195 | { NFS4ERR_DEADLOCK, -EDEADLK }, | |
196 | { -1, -EIO } | |
197 | }; | |
198 | ||
199 | /* | |
200 | * If we cannot translate the error, the recovery routines should | |
201 | * handle it. | |
202 | * | |
203 | * Note: remaining NFSv4 error codes have values > 10000, so should | |
204 | * not conflict with native Linux error codes. | |
205 | */ | |
206 | static int nfs_cb_stat_to_errno(int status) | |
207 | { | |
208 | int i; | |
209 | ||
210 | for (i = 0; nfs_cb_errtbl[i].stat != -1; i++) { | |
211 | if (nfs_cb_errtbl[i].stat == status) | |
212 | return nfs_cb_errtbl[i].errno; | |
213 | } | |
214 | ||
215 | dprintk("NFSD: Unrecognized NFS CB status value: %u\n", status); | |
216 | return -status; | |
217 | } | |
218 | ||
47299f79 SA |
219 | static int decode_cb_op_status(struct xdr_stream *xdr, |
220 | enum nfs_cb_opnum4 expected, int *status) | |
85a56480 CL |
221 | { |
222 | __be32 *p; | |
223 | u32 op; | |
224 | ||
225 | p = xdr_inline_decode(xdr, 4 + 4); | |
226 | if (unlikely(p == NULL)) | |
227 | goto out_overflow; | |
228 | op = be32_to_cpup(p++); | |
229 | if (unlikely(op != expected)) | |
230 | goto out_unexpected; | |
ef2a1b3e | 231 | *status = nfs_cb_stat_to_errno(be32_to_cpup(p)); |
85a56480 CL |
232 | return 0; |
233 | out_overflow: | |
85a56480 CL |
234 | return -EIO; |
235 | out_unexpected: | |
236 | dprintk("NFSD: Callback server returned operation %d but " | |
237 | "we issued a request for %d\n", op, expected); | |
238 | return -EIO; | |
239 | } | |
240 | ||
a033db48 CL |
241 | /* |
242 | * CB_COMPOUND4args | |
243 | * | |
244 | * struct CB_COMPOUND4args { | |
245 | * utf8str_cs tag; | |
246 | * uint32_t minorversion; | |
247 | * uint32_t callback_ident; | |
248 | * nfs_cb_argop4 argarray<>; | |
249 | * }; | |
250 | */ | |
251 | static void encode_cb_compound4args(struct xdr_stream *xdr, | |
252 | struct nfs4_cb_compound_hdr *hdr) | |
1da177e4 | 253 | { |
f00f328f | 254 | __be32 * p; |
1da177e4 | 255 | |
a033db48 CL |
256 | p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4); |
257 | p = xdr_encode_empty_array(p); /* empty tag */ | |
258 | *p++ = cpu_to_be32(hdr->minorversion); | |
259 | *p++ = cpu_to_be32(hdr->ident); | |
260 | ||
ef52bff8 | 261 | hdr->nops_p = p; |
a033db48 | 262 | *p = cpu_to_be32(hdr->nops); /* argarray element count */ |
1da177e4 LT |
263 | } |
264 | ||
a033db48 CL |
265 | /* |
266 | * Update argarray element count | |
267 | */ | |
ef52bff8 AA |
268 | static void encode_cb_nops(struct nfs4_cb_compound_hdr *hdr) |
269 | { | |
a033db48 CL |
270 | BUG_ON(hdr->nops > NFS4_MAX_BACK_CHANNEL_OPS); |
271 | *hdr->nops_p = cpu_to_be32(hdr->nops); | |
ef52bff8 AA |
272 | } |
273 | ||
85a56480 CL |
274 | /* |
275 | * CB_COMPOUND4res | |
276 | * | |
277 | * struct CB_COMPOUND4res { | |
278 | * nfsstat4 status; | |
279 | * utf8str_cs tag; | |
280 | * nfs_cb_resop4 resarray<>; | |
281 | * }; | |
282 | */ | |
283 | static int decode_cb_compound4res(struct xdr_stream *xdr, | |
284 | struct nfs4_cb_compound_hdr *hdr) | |
285 | { | |
286 | u32 length; | |
287 | __be32 *p; | |
288 | ||
289 | p = xdr_inline_decode(xdr, 4 + 4); | |
290 | if (unlikely(p == NULL)) | |
291 | goto out_overflow; | |
292 | hdr->status = be32_to_cpup(p++); | |
293 | /* Ignore the tag */ | |
294 | length = be32_to_cpup(p++); | |
295 | p = xdr_inline_decode(xdr, length + 4); | |
296 | if (unlikely(p == NULL)) | |
297 | goto out_overflow; | |
e86a40bc | 298 | p += XDR_QUADLEN(length); |
85a56480 CL |
299 | hdr->nops = be32_to_cpup(p); |
300 | return 0; | |
301 | out_overflow: | |
85a56480 CL |
302 | return -EIO; |
303 | } | |
304 | ||
a033db48 CL |
305 | /* |
306 | * CB_RECALL4args | |
307 | * | |
308 | * struct CB_RECALL4args { | |
309 | * stateid4 stateid; | |
310 | * bool truncate; | |
311 | * nfs_fh4 fh; | |
312 | * }; | |
313 | */ | |
314 | static void encode_cb_recall4args(struct xdr_stream *xdr, | |
315 | const struct nfs4_delegation *dp, | |
316 | struct nfs4_cb_compound_hdr *hdr) | |
1da177e4 | 317 | { |
f00f328f | 318 | __be32 *p; |
a033db48 CL |
319 | |
320 | encode_nfs_cb_opnum4(xdr, OP_CB_RECALL); | |
d5477a8d | 321 | encode_stateid4(xdr, &dp->dl_stid.sc_stateid); |
a033db48 CL |
322 | |
323 | p = xdr_reserve_space(xdr, 4); | |
324 | *p++ = xdr_zero; /* truncate */ | |
325 | ||
11b9164a | 326 | encode_nfs_fh4(xdr, &dp->dl_stid.sc_file->fi_fhandle); |
a033db48 | 327 | |
ef52bff8 | 328 | hdr->nops++; |
1da177e4 LT |
329 | } |
330 | ||
a033db48 CL |
331 | /* |
332 | * CB_SEQUENCE4args | |
333 | * | |
334 | * struct CB_SEQUENCE4args { | |
335 | * sessionid4 csa_sessionid; | |
336 | * sequenceid4 csa_sequenceid; | |
337 | * slotid4 csa_slotid; | |
338 | * slotid4 csa_highest_slotid; | |
339 | * bool csa_cachethis; | |
340 | * referring_call_list4 csa_referring_call_lists<>; | |
341 | * }; | |
342 | */ | |
343 | static void encode_cb_sequence4args(struct xdr_stream *xdr, | |
344 | const struct nfsd4_callback *cb, | |
345 | struct nfs4_cb_compound_hdr *hdr) | |
2af73580 | 346 | { |
a033db48 | 347 | struct nfsd4_session *session = cb->cb_clp->cl_cb_session; |
2af73580 BH |
348 | __be32 *p; |
349 | ||
350 | if (hdr->minorversion == 0) | |
351 | return; | |
352 | ||
a033db48 CL |
353 | encode_nfs_cb_opnum4(xdr, OP_CB_SEQUENCE); |
354 | encode_sessionid4(xdr, session); | |
355 | ||
356 | p = xdr_reserve_space(xdr, 4 + 4 + 4 + 4 + 4); | |
357 | *p++ = cpu_to_be32(session->se_cb_seq_nr); /* csa_sequenceid */ | |
358 | *p++ = xdr_zero; /* csa_slotid */ | |
359 | *p++ = xdr_zero; /* csa_highest_slotid */ | |
360 | *p++ = xdr_zero; /* csa_cachethis */ | |
361 | xdr_encode_empty_array(p); /* csa_referring_call_lists */ | |
2af73580 | 362 | |
2af73580 BH |
363 | hdr->nops++; |
364 | } | |
365 | ||
85a56480 CL |
366 | /* |
367 | * CB_SEQUENCE4resok | |
368 | * | |
369 | * struct CB_SEQUENCE4resok { | |
370 | * sessionid4 csr_sessionid; | |
371 | * sequenceid4 csr_sequenceid; | |
372 | * slotid4 csr_slotid; | |
373 | * slotid4 csr_highest_slotid; | |
374 | * slotid4 csr_target_highest_slotid; | |
375 | * }; | |
376 | * | |
377 | * union CB_SEQUENCE4res switch (nfsstat4 csr_status) { | |
378 | * case NFS4_OK: | |
379 | * CB_SEQUENCE4resok csr_resok4; | |
380 | * default: | |
381 | * void; | |
382 | * }; | |
383 | * | |
384 | * Our current back channel implmentation supports a single backchannel | |
385 | * with a single slot. | |
386 | */ | |
387 | static int decode_cb_sequence4resok(struct xdr_stream *xdr, | |
388 | struct nfsd4_callback *cb) | |
389 | { | |
390 | struct nfsd4_session *session = cb->cb_clp->cl_cb_session; | |
82743380 | 391 | int status = -ESERVERFAULT; |
85a56480 CL |
392 | __be32 *p; |
393 | u32 dummy; | |
394 | ||
85a56480 CL |
395 | /* |
396 | * If the server returns different values for sessionID, slotID or | |
397 | * sequence number, the server is looney tunes. | |
398 | */ | |
2c9c8f36 | 399 | p = xdr_inline_decode(xdr, NFS4_MAX_SESSIONID_LEN + 4 + 4 + 4 + 4); |
85a56480 CL |
400 | if (unlikely(p == NULL)) |
401 | goto out_overflow; | |
82743380 KM |
402 | |
403 | if (memcmp(p, session->se_sessionid.data, NFS4_MAX_SESSIONID_LEN)) { | |
85a56480 CL |
404 | dprintk("NFS: %s Invalid session id\n", __func__); |
405 | goto out; | |
406 | } | |
407 | p += XDR_QUADLEN(NFS4_MAX_SESSIONID_LEN); | |
408 | ||
409 | dummy = be32_to_cpup(p++); | |
410 | if (dummy != session->se_cb_seq_nr) { | |
411 | dprintk("NFS: %s Invalid sequence number\n", __func__); | |
412 | goto out; | |
413 | } | |
414 | ||
415 | dummy = be32_to_cpup(p++); | |
416 | if (dummy != 0) { | |
417 | dprintk("NFS: %s Invalid slotid\n", __func__); | |
418 | goto out; | |
419 | } | |
420 | ||
421 | /* | |
422 | * FIXME: process highest slotid and target highest slotid | |
423 | */ | |
424 | status = 0; | |
425 | out: | |
7ba6cad6 | 426 | cb->cb_seq_status = status; |
85a56480 CL |
427 | return status; |
428 | out_overflow: | |
7ba6cad6 KM |
429 | status = -EIO; |
430 | goto out; | |
85a56480 CL |
431 | } |
432 | ||
433 | static int decode_cb_sequence4res(struct xdr_stream *xdr, | |
434 | struct nfsd4_callback *cb) | |
435 | { | |
85a56480 CL |
436 | int status; |
437 | ||
89dfdc96 | 438 | if (cb->cb_clp->cl_minorversion == 0) |
85a56480 CL |
439 | return 0; |
440 | ||
7ba6cad6 KM |
441 | status = decode_cb_op_status(xdr, OP_CB_SEQUENCE, &cb->cb_seq_status); |
442 | if (unlikely(status || cb->cb_seq_status)) | |
ef2a1b3e CH |
443 | return status; |
444 | ||
445 | return decode_cb_sequence4resok(xdr, cb); | |
85a56480 CL |
446 | } |
447 | ||
a033db48 CL |
448 | /* |
449 | * NFSv4.0 and NFSv4.1 XDR encode functions | |
450 | * | |
451 | * NFSv4.0 callback argument types are defined in section 15 of RFC | |
452 | * 3530: "Network File System (NFS) version 4 Protocol" and section 20 | |
453 | * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1 | |
454 | * Protocol". | |
455 | */ | |
456 | ||
457 | /* | |
458 | * NB: Without this zero space reservation, callbacks over krb5p fail | |
459 | */ | |
9f06c719 | 460 | static void nfs4_xdr_enc_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr, |
1502c81b | 461 | const void *__unused) |
1da177e4 | 462 | { |
a033db48 | 463 | xdr_reserve_space(xdr, 0); |
1da177e4 LT |
464 | } |
465 | ||
a033db48 CL |
466 | /* |
467 | * 20.2. Operation 4: CB_RECALL - Recall a Delegation | |
468 | */ | |
9f06c719 | 469 | static void nfs4_xdr_enc_cb_recall(struct rpc_rqst *req, struct xdr_stream *xdr, |
1502c81b | 470 | const void *data) |
1da177e4 | 471 | { |
1502c81b | 472 | const struct nfsd4_callback *cb = data; |
34549ab0 | 473 | const struct nfs4_delegation *dp = cb_to_delegation(cb); |
1da177e4 | 474 | struct nfs4_cb_compound_hdr hdr = { |
6ff8da08 | 475 | .ident = cb->cb_clp->cl_cb_ident, |
89dfdc96 | 476 | .minorversion = cb->cb_clp->cl_minorversion, |
1da177e4 LT |
477 | }; |
478 | ||
9f06c719 CL |
479 | encode_cb_compound4args(xdr, &hdr); |
480 | encode_cb_sequence4args(xdr, cb, &hdr); | |
2faf3b43 | 481 | encode_cb_recall4args(xdr, dp, &hdr); |
ef52bff8 | 482 | encode_cb_nops(&hdr); |
1da177e4 LT |
483 | } |
484 | ||
485 | ||
2af73580 | 486 | /* |
85a56480 CL |
487 | * NFSv4.0 and NFSv4.1 XDR decode functions |
488 | * | |
489 | * NFSv4.0 callback result types are defined in section 15 of RFC | |
490 | * 3530: "Network File System (NFS) version 4 Protocol" and section 20 | |
491 | * of RFC 5661: "Network File System (NFS) Version 4 Minor Version 1 | |
492 | * Protocol". | |
2af73580 | 493 | */ |
2af73580 | 494 | |
bf269551 CL |
495 | static int nfs4_xdr_dec_cb_null(struct rpc_rqst *req, struct xdr_stream *xdr, |
496 | void *__unused) | |
1da177e4 LT |
497 | { |
498 | return 0; | |
499 | } | |
500 | ||
85a56480 CL |
501 | /* |
502 | * 20.2. Operation 4: CB_RECALL - Recall a Delegation | |
503 | */ | |
bf269551 CL |
504 | static int nfs4_xdr_dec_cb_recall(struct rpc_rqst *rqstp, |
505 | struct xdr_stream *xdr, | |
d39916c4 | 506 | void *data) |
1da177e4 | 507 | { |
d39916c4 | 508 | struct nfsd4_callback *cb = data; |
1da177e4 LT |
509 | struct nfs4_cb_compound_hdr hdr; |
510 | int status; | |
511 | ||
bf269551 | 512 | status = decode_cb_compound4res(xdr, &hdr); |
85a56480 | 513 | if (unlikely(status)) |
ef2a1b3e | 514 | return status; |
85a56480 | 515 | |
10fa8acf BF |
516 | status = decode_cb_sequence4res(xdr, cb); |
517 | if (unlikely(status || cb->cb_seq_status)) | |
518 | return status; | |
85a56480 | 519 | |
ef2a1b3e | 520 | return decode_cb_op_status(xdr, OP_CB_RECALL, &cb->cb_status); |
1da177e4 LT |
521 | } |
522 | ||
c5c707f9 CH |
523 | #ifdef CONFIG_NFSD_PNFS |
524 | /* | |
525 | * CB_LAYOUTRECALL4args | |
526 | * | |
527 | * struct layoutrecall_file4 { | |
528 | * nfs_fh4 lor_fh; | |
529 | * offset4 lor_offset; | |
530 | * length4 lor_length; | |
531 | * stateid4 lor_stateid; | |
532 | * }; | |
533 | * | |
534 | * union layoutrecall4 switch(layoutrecall_type4 lor_recalltype) { | |
535 | * case LAYOUTRECALL4_FILE: | |
536 | * layoutrecall_file4 lor_layout; | |
537 | * case LAYOUTRECALL4_FSID: | |
538 | * fsid4 lor_fsid; | |
539 | * case LAYOUTRECALL4_ALL: | |
540 | * void; | |
541 | * }; | |
542 | * | |
543 | * struct CB_LAYOUTRECALL4args { | |
544 | * layouttype4 clora_type; | |
545 | * layoutiomode4 clora_iomode; | |
546 | * bool clora_changed; | |
547 | * layoutrecall4 clora_recall; | |
548 | * }; | |
549 | */ | |
550 | static void encode_cb_layout4args(struct xdr_stream *xdr, | |
551 | const struct nfs4_layout_stateid *ls, | |
552 | struct nfs4_cb_compound_hdr *hdr) | |
553 | { | |
554 | __be32 *p; | |
555 | ||
556 | BUG_ON(hdr->minorversion == 0); | |
557 | ||
558 | p = xdr_reserve_space(xdr, 5 * 4); | |
559 | *p++ = cpu_to_be32(OP_CB_LAYOUTRECALL); | |
560 | *p++ = cpu_to_be32(ls->ls_layout_type); | |
561 | *p++ = cpu_to_be32(IOMODE_ANY); | |
562 | *p++ = cpu_to_be32(1); | |
563 | *p = cpu_to_be32(RETURN_FILE); | |
564 | ||
565 | encode_nfs_fh4(xdr, &ls->ls_stid.sc_file->fi_fhandle); | |
566 | ||
567 | p = xdr_reserve_space(xdr, 2 * 8); | |
568 | p = xdr_encode_hyper(p, 0); | |
569 | xdr_encode_hyper(p, NFS4_MAX_UINT64); | |
570 | ||
571 | encode_stateid4(xdr, &ls->ls_recall_sid); | |
572 | ||
573 | hdr->nops++; | |
574 | } | |
575 | ||
576 | static void nfs4_xdr_enc_cb_layout(struct rpc_rqst *req, | |
577 | struct xdr_stream *xdr, | |
1502c81b | 578 | const void *data) |
c5c707f9 | 579 | { |
1502c81b | 580 | const struct nfsd4_callback *cb = data; |
c5c707f9 CH |
581 | const struct nfs4_layout_stateid *ls = |
582 | container_of(cb, struct nfs4_layout_stateid, ls_recall); | |
583 | struct nfs4_cb_compound_hdr hdr = { | |
584 | .ident = 0, | |
89dfdc96 | 585 | .minorversion = cb->cb_clp->cl_minorversion, |
c5c707f9 CH |
586 | }; |
587 | ||
588 | encode_cb_compound4args(xdr, &hdr); | |
589 | encode_cb_sequence4args(xdr, cb, &hdr); | |
590 | encode_cb_layout4args(xdr, ls, &hdr); | |
591 | encode_cb_nops(&hdr); | |
592 | } | |
593 | ||
594 | static int nfs4_xdr_dec_cb_layout(struct rpc_rqst *rqstp, | |
595 | struct xdr_stream *xdr, | |
d39916c4 | 596 | void *data) |
c5c707f9 | 597 | { |
d39916c4 | 598 | struct nfsd4_callback *cb = data; |
c5c707f9 | 599 | struct nfs4_cb_compound_hdr hdr; |
c5c707f9 CH |
600 | int status; |
601 | ||
602 | status = decode_cb_compound4res(xdr, &hdr); | |
603 | if (unlikely(status)) | |
ef2a1b3e CH |
604 | return status; |
605 | ||
10fa8acf BF |
606 | status = decode_cb_sequence4res(xdr, cb); |
607 | if (unlikely(status || cb->cb_seq_status)) | |
608 | return status; | |
609 | ||
ef2a1b3e | 610 | return decode_cb_op_status(xdr, OP_CB_LAYOUTRECALL, &cb->cb_status); |
c5c707f9 CH |
611 | } |
612 | #endif /* CONFIG_NFSD_PNFS */ | |
613 | ||
a188620e JL |
614 | static void encode_stateowner(struct xdr_stream *xdr, struct nfs4_stateowner *so) |
615 | { | |
616 | __be32 *p; | |
617 | ||
618 | p = xdr_reserve_space(xdr, 8 + 4 + so->so_owner.len); | |
619 | p = xdr_encode_opaque_fixed(p, &so->so_client->cl_clientid, 8); | |
620 | xdr_encode_opaque(p, so->so_owner.data, so->so_owner.len); | |
621 | } | |
622 | ||
623 | static void nfs4_xdr_enc_cb_notify_lock(struct rpc_rqst *req, | |
624 | struct xdr_stream *xdr, | |
1502c81b | 625 | const void *data) |
a188620e | 626 | { |
1502c81b | 627 | const struct nfsd4_callback *cb = data; |
a188620e JL |
628 | const struct nfsd4_blocked_lock *nbl = |
629 | container_of(cb, struct nfsd4_blocked_lock, nbl_cb); | |
630 | struct nfs4_lockowner *lo = (struct nfs4_lockowner *)nbl->nbl_lock.fl_owner; | |
631 | struct nfs4_cb_compound_hdr hdr = { | |
632 | .ident = 0, | |
633 | .minorversion = cb->cb_clp->cl_minorversion, | |
634 | }; | |
635 | ||
636 | __be32 *p; | |
637 | ||
638 | BUG_ON(hdr.minorversion == 0); | |
639 | ||
640 | encode_cb_compound4args(xdr, &hdr); | |
641 | encode_cb_sequence4args(xdr, cb, &hdr); | |
642 | ||
643 | p = xdr_reserve_space(xdr, 4); | |
644 | *p = cpu_to_be32(OP_CB_NOTIFY_LOCK); | |
645 | encode_nfs_fh4(xdr, &nbl->nbl_fh); | |
646 | encode_stateowner(xdr, &lo->lo_owner); | |
647 | hdr.nops++; | |
648 | ||
649 | encode_cb_nops(&hdr); | |
650 | } | |
651 | ||
652 | static int nfs4_xdr_dec_cb_notify_lock(struct rpc_rqst *rqstp, | |
653 | struct xdr_stream *xdr, | |
d39916c4 | 654 | void *data) |
a188620e | 655 | { |
d39916c4 | 656 | struct nfsd4_callback *cb = data; |
a188620e JL |
657 | struct nfs4_cb_compound_hdr hdr; |
658 | int status; | |
659 | ||
660 | status = decode_cb_compound4res(xdr, &hdr); | |
661 | if (unlikely(status)) | |
662 | return status; | |
663 | ||
10fa8acf BF |
664 | status = decode_cb_sequence4res(xdr, cb); |
665 | if (unlikely(status || cb->cb_seq_status)) | |
666 | return status; | |
667 | ||
a188620e JL |
668 | return decode_cb_op_status(xdr, OP_CB_NOTIFY_LOCK, &cb->cb_status); |
669 | } | |
670 | ||
9eb190fc OK |
671 | /* |
672 | * struct write_response4 { | |
673 | * stateid4 wr_callback_id<1>; | |
674 | * length4 wr_count; | |
675 | * stable_how4 wr_committed; | |
676 | * verifier4 wr_writeverf; | |
677 | * }; | |
678 | * union offload_info4 switch (nfsstat4 coa_status) { | |
679 | * case NFS4_OK: | |
680 | * write_response4 coa_resok4; | |
681 | * default: | |
682 | * length4 coa_bytes_copied; | |
683 | * }; | |
684 | * struct CB_OFFLOAD4args { | |
685 | * nfs_fh4 coa_fh; | |
686 | * stateid4 coa_stateid; | |
687 | * offload_info4 coa_offload_info; | |
688 | * }; | |
689 | */ | |
690 | static void encode_offload_info4(struct xdr_stream *xdr, | |
691 | __be32 nfserr, | |
692 | const struct nfsd4_copy *cp) | |
693 | { | |
694 | __be32 *p; | |
695 | ||
696 | p = xdr_reserve_space(xdr, 4); | |
697 | *p++ = nfserr; | |
698 | if (!nfserr) { | |
699 | p = xdr_reserve_space(xdr, 4 + 8 + 4 + NFS4_VERIFIER_SIZE); | |
700 | p = xdr_encode_empty_array(p); | |
701 | p = xdr_encode_hyper(p, cp->cp_res.wr_bytes_written); | |
702 | *p++ = cpu_to_be32(cp->cp_res.wr_stable_how); | |
703 | p = xdr_encode_opaque_fixed(p, cp->cp_res.wr_verifier.data, | |
704 | NFS4_VERIFIER_SIZE); | |
705 | } else { | |
706 | p = xdr_reserve_space(xdr, 8); | |
707 | /* We always return success if bytes were written */ | |
708 | p = xdr_encode_hyper(p, 0); | |
709 | } | |
710 | } | |
711 | ||
712 | static void encode_cb_offload4args(struct xdr_stream *xdr, | |
713 | __be32 nfserr, | |
714 | const struct knfsd_fh *fh, | |
715 | const struct nfsd4_copy *cp, | |
716 | struct nfs4_cb_compound_hdr *hdr) | |
717 | { | |
718 | __be32 *p; | |
719 | ||
720 | p = xdr_reserve_space(xdr, 4); | |
721 | *p++ = cpu_to_be32(OP_CB_OFFLOAD); | |
722 | encode_nfs_fh4(xdr, fh); | |
723 | encode_stateid4(xdr, &cp->cp_res.cb_stateid); | |
724 | encode_offload_info4(xdr, nfserr, cp); | |
725 | ||
726 | hdr->nops++; | |
727 | } | |
728 | ||
729 | static void nfs4_xdr_enc_cb_offload(struct rpc_rqst *req, | |
730 | struct xdr_stream *xdr, | |
731 | const void *data) | |
732 | { | |
733 | const struct nfsd4_callback *cb = data; | |
734 | const struct nfsd4_copy *cp = | |
735 | container_of(cb, struct nfsd4_copy, cp_cb); | |
736 | struct nfs4_cb_compound_hdr hdr = { | |
737 | .ident = 0, | |
738 | .minorversion = cb->cb_clp->cl_minorversion, | |
739 | }; | |
740 | ||
741 | encode_cb_compound4args(xdr, &hdr); | |
742 | encode_cb_sequence4args(xdr, cb, &hdr); | |
743 | encode_cb_offload4args(xdr, cp->nfserr, &cp->fh, cp, &hdr); | |
744 | encode_cb_nops(&hdr); | |
745 | } | |
746 | ||
747 | static int nfs4_xdr_dec_cb_offload(struct rpc_rqst *rqstp, | |
748 | struct xdr_stream *xdr, | |
749 | void *data) | |
750 | { | |
751 | struct nfsd4_callback *cb = data; | |
752 | struct nfs4_cb_compound_hdr hdr; | |
753 | int status; | |
754 | ||
755 | status = decode_cb_compound4res(xdr, &hdr); | |
756 | if (unlikely(status)) | |
757 | return status; | |
758 | ||
10fa8acf BF |
759 | status = decode_cb_sequence4res(xdr, cb); |
760 | if (unlikely(status || cb->cb_seq_status)) | |
761 | return status; | |
762 | ||
9eb190fc OK |
763 | return decode_cb_op_status(xdr, OP_CB_OFFLOAD, &cb->cb_status); |
764 | } | |
1da177e4 LT |
765 | /* |
766 | * RPC procedure tables | |
767 | */ | |
7d93bd71 CL |
768 | #define PROC(proc, call, argtype, restype) \ |
769 | [NFSPROC4_CLNT_##proc] = { \ | |
770 | .p_proc = NFSPROC4_CB_##call, \ | |
1502c81b | 771 | .p_encode = nfs4_xdr_enc_##argtype, \ |
d39916c4 | 772 | .p_decode = nfs4_xdr_dec_##restype, \ |
7d93bd71 CL |
773 | .p_arglen = NFS4_enc_##argtype##_sz, \ |
774 | .p_replen = NFS4_dec_##restype##_sz, \ | |
775 | .p_statidx = NFSPROC4_CB_##call, \ | |
776 | .p_name = #proc, \ | |
1da177e4 LT |
777 | } |
778 | ||
499b4988 | 779 | static const struct rpc_procinfo nfs4_cb_procedures[] = { |
7d93bd71 CL |
780 | PROC(CB_NULL, NULL, cb_null, cb_null), |
781 | PROC(CB_RECALL, COMPOUND, cb_recall, cb_recall), | |
c5c707f9 CH |
782 | #ifdef CONFIG_NFSD_PNFS |
783 | PROC(CB_LAYOUT, COMPOUND, cb_layout, cb_layout), | |
784 | #endif | |
a188620e | 785 | PROC(CB_NOTIFY_LOCK, COMPOUND, cb_notify_lock, cb_notify_lock), |
9eb190fc | 786 | PROC(CB_OFFLOAD, COMPOUND, cb_offload, cb_offload), |
1da177e4 LT |
787 | }; |
788 | ||
1c5876dd | 789 | static unsigned int nfs4_cb_counts[ARRAY_SIZE(nfs4_cb_procedures)]; |
02be49f6 | 790 | static const struct rpc_version nfs_cb_version4 = { |
b7299f44 BF |
791 | /* |
792 | * Note on the callback rpc program version number: despite language in rfc | |
793 | * 5661 section 18.36.3 requiring servers to use 4 in this field, the | |
794 | * official xdr descriptions for both 4.0 and 4.1 specify version 1, and | |
795 | * in practice that appears to be what implementations use. The section | |
796 | * 18.36.3 language is expected to be fixed in an erratum. | |
797 | */ | |
7d93bd71 CL |
798 | .number = 1, |
799 | .nrprocs = ARRAY_SIZE(nfs4_cb_procedures), | |
1c5876dd CH |
800 | .procs = nfs4_cb_procedures, |
801 | .counts = nfs4_cb_counts, | |
1da177e4 LT |
802 | }; |
803 | ||
eff79368 TM |
804 | static const struct rpc_version *nfs_cb_version[2] = { |
805 | [1] = &nfs_cb_version4, | |
1da177e4 LT |
806 | }; |
807 | ||
a613fa16 | 808 | static const struct rpc_program cb_program; |
ff7d9756 OK |
809 | |
810 | static struct rpc_stat cb_stats = { | |
7d93bd71 | 811 | .program = &cb_program |
ff7d9756 OK |
812 | }; |
813 | ||
814 | #define NFS4_CALLBACK 0x40000000 | |
a613fa16 | 815 | static const struct rpc_program cb_program = { |
7d93bd71 CL |
816 | .name = "nfs4_cb", |
817 | .number = NFS4_CALLBACK, | |
818 | .nrvers = ARRAY_SIZE(nfs_cb_version), | |
819 | .version = nfs_cb_version, | |
820 | .stats = &cb_stats, | |
0157d021 | 821 | .pipe_dir_name = "nfsd4_cb", |
ff7d9756 OK |
822 | }; |
823 | ||
3d733711 | 824 | static int max_cb_time(struct net *net) |
595947ac | 825 | { |
3d733711 | 826 | struct nfsd_net *nn = net_generic(net, nfsd_net_id); |
20b7d86f AB |
827 | |
828 | /* | |
829 | * nfsd4_lease is set to at most one hour in __nfsd4_write_time, | |
830 | * so we can use 32-bit math on it. Warn if that assumption | |
831 | * ever stops being true. | |
832 | */ | |
833 | if (WARN_ON_ONCE(nn->nfsd4_lease > 3600)) | |
834 | return 360 * HZ; | |
835 | ||
836 | return max(((u32)nn->nfsd4_lease)/10, 1u) * HZ; | |
595947ac BF |
837 | } |
838 | ||
2bbfed98 TM |
839 | static struct workqueue_struct *callback_wq; |
840 | ||
841 | static bool nfsd4_queue_cb(struct nfsd4_callback *cb) | |
842 | { | |
843 | return queue_work(callback_wq, &cb->cb_work); | |
844 | } | |
845 | ||
846 | static void nfsd41_cb_inflight_begin(struct nfs4_client *clp) | |
847 | { | |
848 | atomic_inc(&clp->cl_cb_inflight); | |
849 | } | |
850 | ||
851 | static void nfsd41_cb_inflight_end(struct nfs4_client *clp) | |
852 | { | |
853 | ||
854 | if (atomic_dec_and_test(&clp->cl_cb_inflight)) | |
855 | wake_up_var(&clp->cl_cb_inflight); | |
856 | } | |
857 | ||
858 | static void nfsd41_cb_inflight_wait_complete(struct nfs4_client *clp) | |
859 | { | |
860 | wait_var_event(&clp->cl_cb_inflight, | |
861 | !atomic_read(&clp->cl_cb_inflight)); | |
862 | } | |
863 | ||
a52458b4 | 864 | static const struct cred *get_backchannel_cred(struct nfs4_client *clp, struct rpc_clnt *client, struct nfsd4_session *ses) |
c6bb3ca2 BF |
865 | { |
866 | if (clp->cl_minorversion == 0) { | |
5e16923b N |
867 | client->cl_principal = clp->cl_cred.cr_targ_princ ? |
868 | clp->cl_cred.cr_targ_princ : "nfs"; | |
869 | ||
a52458b4 | 870 | return get_cred(rpc_machine_cred()); |
c6bb3ca2 | 871 | } else { |
97f68c6b | 872 | struct cred *kcred; |
97f68c6b N |
873 | |
874 | kcred = prepare_kernel_cred(NULL); | |
875 | if (!kcred) | |
876 | return NULL; | |
c6bb3ca2 | 877 | |
8276c902 N |
878 | kcred->uid = ses->se_cb_sec.uid; |
879 | kcred->gid = ses->se_cb_sec.gid; | |
a52458b4 | 880 | return kcred; |
c6bb3ca2 BF |
881 | } |
882 | } | |
2b47eece | 883 | |
dcbeaa68 | 884 | static int setup_callback_client(struct nfs4_client *clp, struct nfs4_cb_conn *conn, struct nfsd4_session *ses) |
2b47eece | 885 | { |
3758cf7e | 886 | int maxtime = max_cb_time(clp->net); |
ae5c7947 | 887 | struct rpc_timeout timeparms = { |
3758cf7e | 888 | .to_initval = maxtime, |
595947ac | 889 | .to_retries = 0, |
3758cf7e | 890 | .to_maxval = maxtime, |
ae5c7947 | 891 | }; |
ae5c7947 | 892 | struct rpc_create_args args = { |
c212cecf | 893 | .net = clp->net, |
07263f1e BF |
894 | .address = (struct sockaddr *) &conn->cb_addr, |
895 | .addrsize = conn->cb_addrlen, | |
6f3d772f | 896 | .saddress = (struct sockaddr *) &conn->cb_saddr, |
ae5c7947 | 897 | .timeout = &timeparms, |
ff7d9756 | 898 | .program = &cb_program, |
eff79368 | 899 | .version = 1, |
b6b6152c | 900 | .flags = (RPC_CLNT_CREATE_NOPING | RPC_CLNT_CREATE_QUIET), |
79caa5fa | 901 | .cred = current_cred(), |
ae5c7947 | 902 | }; |
63c86716 | 903 | struct rpc_clnt *client; |
a52458b4 | 904 | const struct cred *cred; |
1da177e4 | 905 | |
5d18c1c2 | 906 | if (clp->cl_minorversion == 0) { |
03a4e1f6 | 907 | if (!clp->cl_cred.cr_principal && |
1eace0d1 CL |
908 | (clp->cl_cred.cr_flavor >= RPC_AUTH_GSS_KRB5)) { |
909 | trace_nfsd_cb_setup_err(clp, -EINVAL); | |
5d18c1c2 | 910 | return -EINVAL; |
1eace0d1 | 911 | } |
03a4e1f6 | 912 | args.client_name = clp->cl_cred.cr_principal; |
fc8e5a64 | 913 | args.prognumber = conn->cb_prog; |
5d18c1c2 | 914 | args.protocol = XPRT_TRANSPORT_TCP; |
39307655 | 915 | args.authflavor = clp->cl_cred.cr_flavor; |
5d18c1c2 BF |
916 | clp->cl_cb_ident = conn->cb_ident; |
917 | } else { | |
1eace0d1 CL |
918 | if (!conn->cb_xprt) { |
919 | trace_nfsd_cb_setup_err(clp, -EINVAL); | |
dcbeaa68 | 920 | return -EINVAL; |
1eace0d1 | 921 | } |
dcbeaa68 BF |
922 | clp->cl_cb_conn.cb_xprt = conn->cb_xprt; |
923 | clp->cl_cb_session = ses; | |
07263f1e | 924 | args.bc_xprt = conn->cb_xprt; |
8b5ce5cd | 925 | args.prognumber = clp->cl_cb_session->se_cb_prog; |
3c45ddf8 CL |
926 | args.protocol = conn->cb_xprt->xpt_class->xcl_ident | |
927 | XPRT_TRANSPORT_BC; | |
12fc3e92 | 928 | args.authflavor = ses->se_cb_sec.flavor; |
3ddc8bf5 | 929 | } |
ae5c7947 | 930 | /* Create RPC client */ |
d50039ea | 931 | client = rpc_create(&args); |
e1cab5a5 | 932 | if (IS_ERR(client)) { |
1eace0d1 | 933 | trace_nfsd_cb_setup_err(clp, PTR_ERR(client)); |
e1cab5a5 BF |
934 | return PTR_ERR(client); |
935 | } | |
c6bb3ca2 | 936 | cred = get_backchannel_cred(clp, client, ses); |
1c3da445 | 937 | if (!cred) { |
1eace0d1 | 938 | trace_nfsd_cb_setup_err(clp, -ENOMEM); |
c6bb3ca2 | 939 | rpc_shutdown_client(client); |
1c3da445 | 940 | return -ENOMEM; |
c6bb3ca2 | 941 | } |
6ff8da08 | 942 | clp->cl_cb_client = client; |
c6bb3ca2 | 943 | clp->cl_cb_cred = cred; |
1eace0d1 | 944 | trace_nfsd_cb_setup(clp); |
e1cab5a5 | 945 | return 0; |
a601caed BF |
946 | } |
947 | ||
77a3569d BF |
948 | static void nfsd4_mark_cb_down(struct nfs4_client *clp, int reason) |
949 | { | |
d4f72cb7 BF |
950 | if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags)) |
951 | return; | |
77a3569d | 952 | clp->cl_cb_state = NFSD4_CB_DOWN; |
1eace0d1 | 953 | trace_nfsd_cb_state(clp); |
77a3569d BF |
954 | } |
955 | ||
5423732a BH |
956 | static void nfsd4_mark_cb_fault(struct nfs4_client *clp, int reason) |
957 | { | |
d4f72cb7 BF |
958 | if (test_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags)) |
959 | return; | |
5423732a | 960 | clp->cl_cb_state = NFSD4_CB_FAULT; |
1eace0d1 | 961 | trace_nfsd_cb_state(clp); |
5423732a BH |
962 | } |
963 | ||
e300a63c BF |
964 | static void nfsd4_cb_probe_done(struct rpc_task *task, void *calldata) |
965 | { | |
cee277d9 | 966 | struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null); |
e300a63c | 967 | |
1eace0d1 | 968 | trace_nfsd_cb_done(clp, task->tk_status); |
e300a63c | 969 | if (task->tk_status) |
77a3569d | 970 | nfsd4_mark_cb_down(clp, task->tk_status); |
1eace0d1 | 971 | else { |
77a3569d | 972 | clp->cl_cb_state = NFSD4_CB_UP; |
1eace0d1 CL |
973 | trace_nfsd_cb_state(clp); |
974 | } | |
e300a63c BF |
975 | } |
976 | ||
2bbfed98 TM |
977 | static void nfsd4_cb_probe_release(void *calldata) |
978 | { | |
979 | struct nfs4_client *clp = container_of(calldata, struct nfs4_client, cl_cb_null); | |
980 | ||
981 | nfsd41_cb_inflight_end(clp); | |
982 | ||
983 | } | |
984 | ||
e300a63c | 985 | static const struct rpc_call_ops nfsd4_cb_probe_ops = { |
cee277d9 BF |
986 | /* XXX: release method to ensure we set the cb channel down if |
987 | * necessary on early failure? */ | |
e300a63c | 988 | .rpc_call_done = nfsd4_cb_probe_done, |
2bbfed98 | 989 | .rpc_release = nfsd4_cb_probe_release, |
e300a63c BF |
990 | }; |
991 | ||
63c86716 | 992 | /* |
5a3c9d71 BF |
993 | * Poke the callback thread to process any updates to the callback |
994 | * parameters, and send a null probe. | |
63c86716 | 995 | */ |
5a3c9d71 BF |
996 | void nfsd4_probe_callback(struct nfs4_client *clp) |
997 | { | |
77a3569d | 998 | clp->cl_cb_state = NFSD4_CB_UNKNOWN; |
1eace0d1 | 999 | trace_nfsd_cb_state(clp); |
a52d726b | 1000 | set_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags); |
f0b5de1b | 1001 | nfsd4_run_cb(&clp->cl_cb_null); |
5a3c9d71 BF |
1002 | } |
1003 | ||
84f5f7cc | 1004 | void nfsd4_probe_callback_sync(struct nfs4_client *clp) |
63c86716 | 1005 | { |
84f5f7cc BF |
1006 | nfsd4_probe_callback(clp); |
1007 | flush_workqueue(callback_wq); | |
1008 | } | |
63c86716 | 1009 | |
5a3c9d71 | 1010 | void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *conn) |
63c86716 | 1011 | { |
77a3569d | 1012 | clp->cl_cb_state = NFSD4_CB_UNKNOWN; |
6ff8da08 BF |
1013 | spin_lock(&clp->cl_lock); |
1014 | memcpy(&clp->cl_cb_conn, conn, sizeof(struct nfs4_cb_conn)); | |
6ff8da08 | 1015 | spin_unlock(&clp->cl_lock); |
1eace0d1 | 1016 | trace_nfsd_cb_state(clp); |
1da177e4 LT |
1017 | } |
1018 | ||
2a1d1b59 RL |
1019 | /* |
1020 | * There's currently a single callback channel slot. | |
1021 | * If the slot is available, then mark it busy. Otherwise, set the | |
1022 | * thread for sleeping on the callback RPC wait queue. | |
1023 | */ | |
12357f1b | 1024 | static bool nfsd41_cb_get_slot(struct nfsd4_callback *cb, struct rpc_task *task) |
2a1d1b59 | 1025 | { |
12357f1b TM |
1026 | struct nfs4_client *clp = cb->cb_clp; |
1027 | ||
1028 | if (!cb->cb_holds_slot && | |
1029 | test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) { | |
2a1d1b59 | 1030 | rpc_sleep_on(&clp->cl_cb_waitq, task, NULL); |
c6c15e1e TM |
1031 | /* Race breaker */ |
1032 | if (test_and_set_bit(0, &clp->cl_cb_slot_busy) != 0) { | |
1033 | dprintk("%s slot is busy\n", __func__); | |
1034 | return false; | |
1035 | } | |
1036 | rpc_wake_up_queued_task(&clp->cl_cb_waitq, task); | |
2a1d1b59 | 1037 | } |
12357f1b | 1038 | cb->cb_holds_slot = true; |
3ff3600e | 1039 | return true; |
2a1d1b59 RL |
1040 | } |
1041 | ||
12357f1b TM |
1042 | static void nfsd41_cb_release_slot(struct nfsd4_callback *cb) |
1043 | { | |
1044 | struct nfs4_client *clp = cb->cb_clp; | |
1045 | ||
1046 | if (cb->cb_holds_slot) { | |
1047 | cb->cb_holds_slot = false; | |
1048 | clear_bit(0, &clp->cl_cb_slot_busy); | |
1049 | rpc_wake_up_next(&clp->cl_cb_waitq); | |
1050 | } | |
1051 | } | |
1052 | ||
2bbfed98 TM |
1053 | static void nfsd41_destroy_cb(struct nfsd4_callback *cb) |
1054 | { | |
1055 | struct nfs4_client *clp = cb->cb_clp; | |
1056 | ||
1057 | nfsd41_cb_release_slot(cb); | |
1058 | if (cb->cb_ops && cb->cb_ops->release) | |
1059 | cb->cb_ops->release(cb); | |
1060 | nfsd41_cb_inflight_end(clp); | |
1061 | } | |
1062 | ||
2a1d1b59 RL |
1063 | /* |
1064 | * TODO: cb_sequence should support referring call lists, cachethis, multiple | |
1065 | * slots, and mark callback channel down on communication errors. | |
1066 | */ | |
1067 | static void nfsd4_cb_prepare(struct rpc_task *task, void *calldata) | |
1068 | { | |
5878453d | 1069 | struct nfsd4_callback *cb = calldata; |
8be2d234 | 1070 | struct nfs4_client *clp = cb->cb_clp; |
8323c3b2 | 1071 | u32 minorversion = clp->cl_minorversion; |
2a1d1b59 | 1072 | |
7ba6cad6 KM |
1073 | /* |
1074 | * cb_seq_status is only set in decode_cb_sequence4res, | |
1075 | * and so will remain 1 if an rpc level failure occurs. | |
1076 | */ | |
1077 | cb->cb_seq_status = 1; | |
4399396e | 1078 | cb->cb_status = 0; |
12357f1b TM |
1079 | if (minorversion && !nfsd41_cb_get_slot(cb, task)) |
1080 | return; | |
2a1d1b59 RL |
1081 | rpc_call_start(task); |
1082 | } | |
1083 | ||
7ba6cad6 | 1084 | static bool nfsd4_cb_sequence_done(struct rpc_task *task, struct nfsd4_callback *cb) |
0421b5c5 | 1085 | { |
8be2d234 | 1086 | struct nfs4_client *clp = cb->cb_clp; |
7ba6cad6 KM |
1087 | struct nfsd4_session *session = clp->cl_cb_session; |
1088 | bool ret = true; | |
0421b5c5 | 1089 | |
7ba6cad6 KM |
1090 | if (!clp->cl_minorversion) { |
1091 | /* | |
1092 | * If the backchannel connection was shut down while this | |
1093 | * task was queued, we need to resubmit it after setting up | |
1094 | * a new backchannel connection. | |
1095 | * | |
1096 | * Note that if we lost our callback connection permanently | |
1097 | * the submission code will error out, so we don't need to | |
1098 | * handle that case here. | |
1099 | */ | |
ae67bd38 | 1100 | if (RPC_SIGNALLED(task)) |
7ba6cad6 KM |
1101 | goto need_restart; |
1102 | ||
1103 | return true; | |
1104 | } | |
0421b5c5 | 1105 | |
e6abc8ca TM |
1106 | if (!cb->cb_holds_slot) |
1107 | goto need_restart; | |
1108 | ||
7ba6cad6 KM |
1109 | switch (cb->cb_seq_status) { |
1110 | case 0: | |
276f03e3 KM |
1111 | /* |
1112 | * No need for lock, access serialized in nfsd4_cb_prepare | |
1113 | * | |
1114 | * RFC5661 20.9.3 | |
1115 | * If CB_SEQUENCE returns an error, then the state of the slot | |
1116 | * (sequence ID, cached reply) MUST NOT change. | |
1117 | */ | |
7ba6cad6 KM |
1118 | ++session->se_cb_seq_nr; |
1119 | break; | |
1120 | case -ESERVERFAULT: | |
1121 | ++session->se_cb_seq_nr; | |
df561f66 | 1122 | fallthrough; |
7ba6cad6 KM |
1123 | case 1: |
1124 | case -NFS4ERR_BADSESSION: | |
1125 | nfsd4_mark_cb_fault(cb->cb_clp, cb->cb_seq_status); | |
1126 | ret = false; | |
1127 | break; | |
1128 | case -NFS4ERR_DELAY: | |
1129 | if (!rpc_restart_call(task)) | |
1130 | goto out; | |
1131 | ||
1132 | rpc_delay(task, 2 * HZ); | |
1133 | return false; | |
1134 | case -NFS4ERR_BADSLOT: | |
1135 | goto retry_nowait; | |
1136 | case -NFS4ERR_SEQ_MISORDERED: | |
1137 | if (session->se_cb_seq_nr != 1) { | |
1138 | session->se_cb_seq_nr = 1; | |
1139 | goto retry_nowait; | |
1140 | } | |
1141 | break; | |
1142 | default: | |
20428a80 | 1143 | nfsd4_mark_cb_fault(cb->cb_clp, cb->cb_seq_status); |
7ba6cad6 KM |
1144 | dprintk("%s: unprocessed error %d\n", __func__, |
1145 | cb->cb_seq_status); | |
0421b5c5 | 1146 | } |
0421b5c5 | 1147 | |
12357f1b | 1148 | nfsd41_cb_release_slot(cb); |
7ba6cad6 KM |
1149 | dprintk("%s: freed slot, new seqid=%d\n", __func__, |
1150 | clp->cl_cb_session->se_cb_seq_nr); | |
1151 | ||
ae67bd38 | 1152 | if (RPC_SIGNALLED(task)) |
7ba6cad6 KM |
1153 | goto need_restart; |
1154 | out: | |
1155 | return ret; | |
1156 | retry_nowait: | |
1157 | if (rpc_restart_call_prepare(task)) | |
1158 | ret = false; | |
1159 | goto out; | |
1160 | need_restart: | |
2bbfed98 TM |
1161 | if (!test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags)) { |
1162 | task->tk_status = 0; | |
1163 | cb->cb_need_restart = true; | |
1164 | } | |
7ba6cad6 KM |
1165 | return false; |
1166 | } | |
1167 | ||
1168 | static void nfsd4_cb_done(struct rpc_task *task, void *calldata) | |
1169 | { | |
1170 | struct nfsd4_callback *cb = calldata; | |
1171 | struct nfs4_client *clp = cb->cb_clp; | |
1172 | ||
1eace0d1 | 1173 | trace_nfsd_cb_done(clp, task->tk_status); |
7ba6cad6 KM |
1174 | |
1175 | if (!nfsd4_cb_sequence_done(task, cb)) | |
4b21d0de | 1176 | return; |
4b21d0de | 1177 | |
ef2a1b3e CH |
1178 | if (cb->cb_status) { |
1179 | WARN_ON_ONCE(task->tk_status); | |
1180 | task->tk_status = cb->cb_status; | |
1181 | } | |
1182 | ||
0162ac2b | 1183 | switch (cb->cb_ops->done(cb, task)) { |
172c85dd | 1184 | case 0: |
0162ac2b CH |
1185 | task->tk_status = 0; |
1186 | rpc_restart_call_prepare(task); | |
1187 | return; | |
1188 | case 1: | |
1c73b9d2 SM |
1189 | switch (task->tk_status) { |
1190 | case -EIO: | |
1191 | case -ETIMEDOUT: | |
b4250dd8 | 1192 | case -EACCES: |
1c73b9d2 SM |
1193 | nfsd4_mark_cb_down(clp, task->tk_status); |
1194 | } | |
0162ac2b CH |
1195 | break; |
1196 | default: | |
1197 | BUG(); | |
63e4863f | 1198 | } |
63e4863f BF |
1199 | } |
1200 | ||
0162ac2b | 1201 | static void nfsd4_cb_release(void *calldata) |
63e4863f | 1202 | { |
5878453d | 1203 | struct nfsd4_callback *cb = calldata; |
0162ac2b | 1204 | |
cba5f62b | 1205 | if (cb->cb_need_restart) |
2bbfed98 | 1206 | nfsd4_queue_cb(cb); |
cba5f62b | 1207 | else |
2bbfed98 | 1208 | nfsd41_destroy_cb(cb); |
cba5f62b | 1209 | |
63e4863f BF |
1210 | } |
1211 | ||
0162ac2b | 1212 | static const struct rpc_call_ops nfsd4_cb_ops = { |
2a1d1b59 | 1213 | .rpc_call_prepare = nfsd4_cb_prepare, |
0162ac2b CH |
1214 | .rpc_call_done = nfsd4_cb_done, |
1215 | .rpc_release = nfsd4_cb_release, | |
63e4863f BF |
1216 | }; |
1217 | ||
b5a1a81e BF |
1218 | int nfsd4_create_callback_queue(void) |
1219 | { | |
88382036 | 1220 | callback_wq = alloc_ordered_workqueue("nfsd4_callbacks", 0); |
b5a1a81e BF |
1221 | if (!callback_wq) |
1222 | return -ENOMEM; | |
1223 | return 0; | |
1224 | } | |
1225 | ||
1226 | void nfsd4_destroy_callback_queue(void) | |
1227 | { | |
1228 | destroy_workqueue(callback_wq); | |
1229 | } | |
1230 | ||
ab707e15 | 1231 | /* must be called under the state lock */ |
6ff8da08 | 1232 | void nfsd4_shutdown_callback(struct nfs4_client *clp) |
b5a1a81e | 1233 | { |
a52d726b | 1234 | set_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags); |
b5a1a81e | 1235 | /* |
6ff8da08 | 1236 | * Note this won't actually result in a null callback; |
02e1215f | 1237 | * instead, nfsd4_run_cb_null() will detect the killed |
6ff8da08 | 1238 | * client, destroy the rpc client, and stop: |
b5a1a81e | 1239 | */ |
f0b5de1b | 1240 | nfsd4_run_cb(&clp->cl_cb_null); |
b5a1a81e | 1241 | flush_workqueue(callback_wq); |
2bbfed98 | 1242 | nfsd41_cb_inflight_wait_complete(clp); |
b5a1a81e BF |
1243 | } |
1244 | ||
dcbeaa68 BF |
1245 | /* requires cl_lock: */ |
1246 | static struct nfsd4_conn * __nfsd4_find_backchannel(struct nfs4_client *clp) | |
1247 | { | |
1248 | struct nfsd4_session *s; | |
1249 | struct nfsd4_conn *c; | |
1250 | ||
1251 | list_for_each_entry(s, &clp->cl_sessions, se_perclnt) { | |
1252 | list_for_each_entry(c, &s->se_conns, cn_persession) { | |
1253 | if (c->cn_flags & NFS4_CDFC4_BACK) | |
1254 | return c; | |
1255 | } | |
1256 | } | |
1257 | return NULL; | |
1258 | } | |
1259 | ||
cc1ce2f1 BF |
1260 | /* |
1261 | * Note there isn't a lot of locking in this code; instead we depend on | |
1262 | * the fact that it is run from the callback_wq, which won't run two | |
1263 | * work items at once. So, for example, callback_wq handles all access | |
1264 | * of cl_cb_client and all calls to rpc_create or rpc_shutdown_client. | |
1265 | */ | |
65e4c894 | 1266 | static void nfsd4_process_cb_update(struct nfsd4_callback *cb) |
6ff8da08 BF |
1267 | { |
1268 | struct nfs4_cb_conn conn; | |
1269 | struct nfs4_client *clp = cb->cb_clp; | |
dcbeaa68 BF |
1270 | struct nfsd4_session *ses = NULL; |
1271 | struct nfsd4_conn *c; | |
6ff8da08 BF |
1272 | int err; |
1273 | ||
1274 | /* | |
1275 | * This is either an update, or the client dying; in either case, | |
1276 | * kill the old client: | |
1277 | */ | |
1278 | if (clp->cl_cb_client) { | |
1eace0d1 | 1279 | trace_nfsd_cb_shutdown(clp); |
6ff8da08 BF |
1280 | rpc_shutdown_client(clp->cl_cb_client); |
1281 | clp->cl_cb_client = NULL; | |
a52458b4 | 1282 | put_cred(clp->cl_cb_cred); |
c6bb3ca2 | 1283 | clp->cl_cb_cred = NULL; |
6ff8da08 | 1284 | } |
dcbeaa68 BF |
1285 | if (clp->cl_cb_conn.cb_xprt) { |
1286 | svc_xprt_put(clp->cl_cb_conn.cb_xprt); | |
1287 | clp->cl_cb_conn.cb_xprt = NULL; | |
1288 | } | |
a52d726b | 1289 | if (test_bit(NFSD4_CLIENT_CB_KILL, &clp->cl_flags)) |
6ff8da08 BF |
1290 | return; |
1291 | spin_lock(&clp->cl_lock); | |
1292 | /* | |
1293 | * Only serialized callback code is allowed to clear these | |
1294 | * flags; main nfsd code can only set them: | |
1295 | */ | |
a52d726b JL |
1296 | BUG_ON(!(clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK)); |
1297 | clear_bit(NFSD4_CLIENT_CB_UPDATE, &clp->cl_flags); | |
6ff8da08 | 1298 | memcpy(&conn, &cb->cb_clp->cl_cb_conn, sizeof(struct nfs4_cb_conn)); |
dcbeaa68 BF |
1299 | c = __nfsd4_find_backchannel(clp); |
1300 | if (c) { | |
1301 | svc_xprt_get(c->cn_xprt); | |
1302 | conn.cb_xprt = c->cn_xprt; | |
1303 | ses = c->cn_session; | |
1304 | } | |
6ff8da08 BF |
1305 | spin_unlock(&clp->cl_lock); |
1306 | ||
dcbeaa68 | 1307 | err = setup_callback_client(clp, &conn, ses); |
5ce8ba25 | 1308 | if (err) { |
8546ee51 | 1309 | nfsd4_mark_cb_down(clp, err); |
a4abc6b1 XY |
1310 | if (c) |
1311 | svc_xprt_put(c->cn_xprt); | |
5ce8ba25 BF |
1312 | return; |
1313 | } | |
6ff8da08 BF |
1314 | } |
1315 | ||
02e1215f | 1316 | static void |
0162ac2b | 1317 | nfsd4_run_cb_work(struct work_struct *work) |
5878453d | 1318 | { |
0162ac2b CH |
1319 | struct nfsd4_callback *cb = |
1320 | container_of(work, struct nfsd4_callback, cb_work); | |
fb003923 | 1321 | struct nfs4_client *clp = cb->cb_clp; |
6ff8da08 | 1322 | struct rpc_clnt *clnt; |
6221f1d9 | 1323 | int flags; |
1da177e4 | 1324 | |
1eace0d1 CL |
1325 | trace_nfsd_cb_work(clp, cb->cb_msg.rpc_proc->p_name); |
1326 | ||
cba5f62b CH |
1327 | if (cb->cb_need_restart) { |
1328 | cb->cb_need_restart = false; | |
1329 | } else { | |
1330 | if (cb->cb_ops && cb->cb_ops->prepare) | |
1331 | cb->cb_ops->prepare(cb); | |
1332 | } | |
0162ac2b | 1333 | |
a52d726b | 1334 | if (clp->cl_flags & NFSD4_CLIENT_CB_FLAG_MASK) |
6ff8da08 BF |
1335 | nfsd4_process_cb_update(cb); |
1336 | ||
1337 | clnt = clp->cl_cb_client; | |
1338 | if (!clnt) { | |
1339 | /* Callback channel broken, or client killed; give up: */ | |
2bbfed98 | 1340 | nfsd41_destroy_cb(cb); |
6ff8da08 | 1341 | return; |
ac94bf58 | 1342 | } |
4bd9e9b7 CH |
1343 | |
1344 | /* | |
1345 | * Don't send probe messages for 4.1 or later. | |
1346 | */ | |
1347 | if (!cb->cb_ops && clp->cl_minorversion) { | |
1348 | clp->cl_cb_state = NFSD4_CB_UP; | |
2bbfed98 | 1349 | nfsd41_destroy_cb(cb); |
4bd9e9b7 CH |
1350 | return; |
1351 | } | |
1352 | ||
c6bb3ca2 | 1353 | cb->cb_msg.rpc_cred = clp->cl_cb_cred; |
6221f1d9 CL |
1354 | flags = clp->cl_minorversion ? RPC_TASK_NOCONNECT : RPC_TASK_SOFTCONN; |
1355 | rpc_call_async(clnt, &cb->cb_msg, RPC_TASK_SOFT | flags, | |
0162ac2b | 1356 | cb->cb_ops ? &nfsd4_cb_ops : &nfsd4_cb_probe_ops, cb); |
02e1215f JL |
1357 | } |
1358 | ||
f0b5de1b | 1359 | void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp, |
c4cb8974 | 1360 | const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op) |
b5a1a81e | 1361 | { |
5ce8ba25 | 1362 | cb->cb_clp = clp; |
326129d0 | 1363 | cb->cb_msg.rpc_proc = &nfs4_cb_procedures[op]; |
fb003923 BF |
1364 | cb->cb_msg.rpc_argp = cb; |
1365 | cb->cb_msg.rpc_resp = cb; | |
0162ac2b CH |
1366 | cb->cb_ops = ops; |
1367 | INIT_WORK(&cb->cb_work, nfsd4_run_cb_work); | |
7ba6cad6 | 1368 | cb->cb_seq_status = 1; |
ef2a1b3e | 1369 | cb->cb_status = 0; |
cba5f62b | 1370 | cb->cb_need_restart = false; |
e6abc8ca | 1371 | cb->cb_holds_slot = false; |
f0b5de1b | 1372 | } |
5ce8ba25 | 1373 | |
f0b5de1b CH |
1374 | void nfsd4_run_cb(struct nfsd4_callback *cb) |
1375 | { | |
2bbfed98 TM |
1376 | struct nfs4_client *clp = cb->cb_clp; |
1377 | ||
1378 | nfsd41_cb_inflight_begin(clp); | |
1379 | if (!nfsd4_queue_cb(cb)) | |
1380 | nfsd41_cb_inflight_end(clp); | |
b5a1a81e | 1381 | } |