Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * linux/fs/nfs/callback_proc.c
4 *
5 * Copyright (C) 2004 Trond Myklebust
6 *
7 * NFSv4 callback procedures
8 */
9#include <linux/nfs4.h>
10#include <linux/nfs_fs.h>
11#include <linux/slab.h>
12#include <linux/rcupdate.h>
13#include "nfs4_fs.h"
14#include "callback.h"
15#include "delegation.h"
16#include "internal.h"
17#include "pnfs.h"
18#include "nfs4session.h"
19#include "nfs4trace.h"
20
21#define NFSDBG_FACILITY NFSDBG_CALLBACK
22
23__be32 nfs4_callback_getattr(void *argp, void *resp,
24 struct cb_process_state *cps)
25{
26 struct cb_getattrargs *args = argp;
27 struct cb_getattrres *res = resp;
28 struct nfs_delegation *delegation;
29 struct nfs_inode *nfsi;
30 struct inode *inode;
31
32 res->status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
33 if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
34 goto out;
35
36 res->bitmap[0] = res->bitmap[1] = 0;
37 res->status = htonl(NFS4ERR_BADHANDLE);
38
39 dprintk_rcu("NFS: GETATTR callback request from %s\n",
40 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
41
42 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
43 if (inode == NULL) {
44 trace_nfs4_cb_getattr(cps->clp, &args->fh, NULL,
45 -ntohl(res->status));
46 goto out;
47 }
48 nfsi = NFS_I(inode);
49 rcu_read_lock();
50 delegation = rcu_dereference(nfsi->delegation);
51 if (delegation == NULL || (delegation->type & FMODE_WRITE) == 0)
52 goto out_iput;
53 res->size = i_size_read(inode);
54 res->change_attr = delegation->change_attr;
55 if (nfs_have_writebacks(inode))
56 res->change_attr++;
57 res->ctime = inode->i_ctime;
58 res->mtime = inode->i_mtime;
59 res->bitmap[0] = (FATTR4_WORD0_CHANGE|FATTR4_WORD0_SIZE) &
60 args->bitmap[0];
61 res->bitmap[1] = (FATTR4_WORD1_TIME_METADATA|FATTR4_WORD1_TIME_MODIFY) &
62 args->bitmap[1];
63 res->status = 0;
64out_iput:
65 rcu_read_unlock();
66 trace_nfs4_cb_getattr(cps->clp, &args->fh, inode, -ntohl(res->status));
67 iput(inode);
68out:
69 dprintk("%s: exit with status = %d\n", __func__, ntohl(res->status));
70 return res->status;
71}
72
73__be32 nfs4_callback_recall(void *argp, void *resp,
74 struct cb_process_state *cps)
75{
76 struct cb_recallargs *args = argp;
77 struct inode *inode;
78 __be32 res;
79
80 res = htonl(NFS4ERR_OP_NOT_IN_SESSION);
81 if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
82 goto out;
83
84 dprintk_rcu("NFS: RECALL callback request from %s\n",
85 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
86
87 res = htonl(NFS4ERR_BADHANDLE);
88 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
89 if (inode == NULL) {
90 trace_nfs4_cb_recall(cps->clp, &args->fh, NULL,
91 &args->stateid, -ntohl(res));
92 goto out;
93 }
94 /* Set up a helper thread to actually return the delegation */
95 switch (nfs_async_inode_return_delegation(inode, &args->stateid)) {
96 case 0:
97 res = 0;
98 break;
99 case -ENOENT:
100 res = htonl(NFS4ERR_BAD_STATEID);
101 break;
102 default:
103 res = htonl(NFS4ERR_RESOURCE);
104 }
105 trace_nfs4_cb_recall(cps->clp, &args->fh, inode,
106 &args->stateid, -ntohl(res));
107 iput(inode);
108out:
109 dprintk("%s: exit with status = %d\n", __func__, ntohl(res));
110 return res;
111}
112
113#if defined(CONFIG_NFS_V4_1)
114
115/*
116 * Lookup a layout inode by stateid
117 *
118 * Note: returns a refcount on the inode and superblock
119 */
120static struct inode *nfs_layout_find_inode_by_stateid(struct nfs_client *clp,
121 const nfs4_stateid *stateid)
122{
123 struct nfs_server *server;
124 struct inode *inode;
125 struct pnfs_layout_hdr *lo;
126
127restart:
128 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
129 list_for_each_entry(lo, &server->layouts, plh_layouts) {
130 if (stateid != NULL &&
131 !nfs4_stateid_match_other(stateid, &lo->plh_stateid))
132 continue;
133 inode = igrab(lo->plh_inode);
134 if (!inode)
135 continue;
136 if (!nfs_sb_active(inode->i_sb)) {
137 rcu_read_unlock();
138 spin_unlock(&clp->cl_lock);
139 iput(inode);
140 spin_lock(&clp->cl_lock);
141 rcu_read_lock();
142 goto restart;
143 }
144 return inode;
145 }
146 }
147
148 return NULL;
149}
150
151/*
152 * Lookup a layout inode by filehandle.
153 *
154 * Note: returns a refcount on the inode and superblock
155 *
156 */
157static struct inode *nfs_layout_find_inode_by_fh(struct nfs_client *clp,
158 const struct nfs_fh *fh)
159{
160 struct nfs_server *server;
161 struct nfs_inode *nfsi;
162 struct inode *inode;
163 struct pnfs_layout_hdr *lo;
164
165restart:
166 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
167 list_for_each_entry(lo, &server->layouts, plh_layouts) {
168 nfsi = NFS_I(lo->plh_inode);
169 if (nfs_compare_fh(fh, &nfsi->fh))
170 continue;
171 if (nfsi->layout != lo)
172 continue;
173 inode = igrab(lo->plh_inode);
174 if (!inode)
175 continue;
176 if (!nfs_sb_active(inode->i_sb)) {
177 rcu_read_unlock();
178 spin_unlock(&clp->cl_lock);
179 iput(inode);
180 spin_lock(&clp->cl_lock);
181 rcu_read_lock();
182 goto restart;
183 }
184 return inode;
185 }
186 }
187
188 return NULL;
189}
190
191static struct inode *nfs_layout_find_inode(struct nfs_client *clp,
192 const struct nfs_fh *fh,
193 const nfs4_stateid *stateid)
194{
195 struct inode *inode;
196
197 spin_lock(&clp->cl_lock);
198 rcu_read_lock();
199 inode = nfs_layout_find_inode_by_stateid(clp, stateid);
200 if (!inode)
201 inode = nfs_layout_find_inode_by_fh(clp, fh);
202 rcu_read_unlock();
203 spin_unlock(&clp->cl_lock);
204
205 return inode;
206}
207
208/*
209 * Enforce RFC5661 section 12.5.5.2.1. (Layout Recall and Return Sequencing)
210 */
211static u32 pnfs_check_callback_stateid(struct pnfs_layout_hdr *lo,
212 const nfs4_stateid *new)
213{
214 u32 oldseq, newseq;
215
216 /* Is the stateid still not initialised? */
217 if (!pnfs_layout_is_valid(lo))
218 return NFS4ERR_DELAY;
219
220 /* Mismatched stateid? */
221 if (!nfs4_stateid_match_other(&lo->plh_stateid, new))
222 return NFS4ERR_BAD_STATEID;
223
224 newseq = be32_to_cpu(new->seqid);
225 /* Are we already in a layout recall situation? */
226 if (test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags) &&
227 lo->plh_return_seq != 0) {
228 if (newseq < lo->plh_return_seq)
229 return NFS4ERR_OLD_STATEID;
230 if (newseq > lo->plh_return_seq)
231 return NFS4ERR_DELAY;
232 goto out;
233 }
234
235 /* Check that the stateid matches what we think it should be. */
236 oldseq = be32_to_cpu(lo->plh_stateid.seqid);
237 if (newseq > oldseq + 1)
238 return NFS4ERR_DELAY;
239 /* Crazy server! */
240 if (newseq <= oldseq)
241 return NFS4ERR_OLD_STATEID;
242out:
243 return NFS_OK;
244}
245
246static u32 initiate_file_draining(struct nfs_client *clp,
247 struct cb_layoutrecallargs *args)
248{
249 struct inode *ino;
250 struct pnfs_layout_hdr *lo;
251 u32 rv = NFS4ERR_NOMATCHING_LAYOUT;
252 LIST_HEAD(free_me_list);
253
254 ino = nfs_layout_find_inode(clp, &args->cbl_fh, &args->cbl_stateid);
255 if (!ino)
256 goto out;
257
258 pnfs_layoutcommit_inode(ino, false);
259
260
261 spin_lock(&ino->i_lock);
262 lo = NFS_I(ino)->layout;
263 if (!lo) {
264 spin_unlock(&ino->i_lock);
265 goto out;
266 }
267 pnfs_get_layout_hdr(lo);
268 rv = pnfs_check_callback_stateid(lo, &args->cbl_stateid);
269 if (rv != NFS_OK)
270 goto unlock;
271 pnfs_set_layout_stateid(lo, &args->cbl_stateid, true);
272
273 /*
274 * Enforce RFC5661 Section 12.5.5.2.1.5 (Bulk Recall and Return)
275 */
276 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
277 rv = NFS4ERR_DELAY;
278 goto unlock;
279 }
280
281 if (pnfs_mark_matching_lsegs_return(lo, &free_me_list,
282 &args->cbl_range,
283 be32_to_cpu(args->cbl_stateid.seqid))) {
284 rv = NFS4_OK;
285 goto unlock;
286 }
287
288 /* Embrace your forgetfulness! */
289 rv = NFS4ERR_NOMATCHING_LAYOUT;
290
291 if (NFS_SERVER(ino)->pnfs_curr_ld->return_range) {
292 NFS_SERVER(ino)->pnfs_curr_ld->return_range(lo,
293 &args->cbl_range);
294 }
295unlock:
296 spin_unlock(&ino->i_lock);
297 pnfs_free_lseg_list(&free_me_list);
298 /* Free all lsegs that are attached to commit buckets */
299 nfs_commit_inode(ino, 0);
300 pnfs_put_layout_hdr(lo);
301out:
302 trace_nfs4_cb_layoutrecall_file(clp, &args->cbl_fh, ino,
303 &args->cbl_stateid, -rv);
304 nfs_iput_and_deactive(ino);
305 return rv;
306}
307
308static u32 initiate_bulk_draining(struct nfs_client *clp,
309 struct cb_layoutrecallargs *args)
310{
311 int stat;
312
313 if (args->cbl_recall_type == RETURN_FSID)
314 stat = pnfs_destroy_layouts_byfsid(clp, &args->cbl_fsid, true);
315 else
316 stat = pnfs_destroy_layouts_byclid(clp, true);
317 if (stat != 0)
318 return NFS4ERR_DELAY;
319 return NFS4ERR_NOMATCHING_LAYOUT;
320}
321
322static u32 do_callback_layoutrecall(struct nfs_client *clp,
323 struct cb_layoutrecallargs *args)
324{
325 if (args->cbl_recall_type == RETURN_FILE)
326 return initiate_file_draining(clp, args);
327 return initiate_bulk_draining(clp, args);
328}
329
330__be32 nfs4_callback_layoutrecall(void *argp, void *resp,
331 struct cb_process_state *cps)
332{
333 struct cb_layoutrecallargs *args = argp;
334 u32 res = NFS4ERR_OP_NOT_IN_SESSION;
335
336 if (cps->clp)
337 res = do_callback_layoutrecall(cps->clp, args);
338 return cpu_to_be32(res);
339}
340
341static void pnfs_recall_all_layouts(struct nfs_client *clp)
342{
343 struct cb_layoutrecallargs args;
344
345 /* Pretend we got a CB_LAYOUTRECALL(ALL) */
346 memset(&args, 0, sizeof(args));
347 args.cbl_recall_type = RETURN_ALL;
348 /* FIXME we ignore errors, what should we do? */
349 do_callback_layoutrecall(clp, &args);
350}
351
352__be32 nfs4_callback_devicenotify(void *argp, void *resp,
353 struct cb_process_state *cps)
354{
355 struct cb_devicenotifyargs *args = argp;
356 int i;
357 __be32 res = 0;
358 struct nfs_client *clp = cps->clp;
359 struct nfs_server *server = NULL;
360
361 if (!clp) {
362 res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
363 goto out;
364 }
365
366 for (i = 0; i < args->ndevs; i++) {
367 struct cb_devicenotifyitem *dev = &args->devs[i];
368
369 if (!server ||
370 server->pnfs_curr_ld->id != dev->cbd_layout_type) {
371 rcu_read_lock();
372 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
373 if (server->pnfs_curr_ld &&
374 server->pnfs_curr_ld->id == dev->cbd_layout_type) {
375 rcu_read_unlock();
376 goto found;
377 }
378 rcu_read_unlock();
379 continue;
380 }
381
382 found:
383 nfs4_delete_deviceid(server->pnfs_curr_ld, clp, &dev->cbd_dev_id);
384 }
385
386out:
387 kfree(args->devs);
388 return res;
389}
390
391/*
392 * Validate the sequenceID sent by the server.
393 * Return success if the sequenceID is one more than what we last saw on
394 * this slot, accounting for wraparound. Increments the slot's sequence.
395 *
396 * We don't yet implement a duplicate request cache, instead we set the
397 * back channel ca_maxresponsesize_cached to zero. This is OK for now
398 * since we only currently implement idempotent callbacks anyway.
399 *
400 * We have a single slot backchannel at this time, so we don't bother
401 * checking the used_slots bit array on the table. The lower layer guarantees
402 * a single outstanding callback request at a time.
403 */
404static __be32
405validate_seqid(const struct nfs4_slot_table *tbl, const struct nfs4_slot *slot,
406 const struct cb_sequenceargs * args)
407{
408 if (args->csa_slotid > tbl->server_highest_slotid)
409 return htonl(NFS4ERR_BADSLOT);
410
411 /* Replay */
412 if (args->csa_sequenceid == slot->seq_nr) {
413 if (nfs4_test_locked_slot(tbl, slot->slot_nr))
414 return htonl(NFS4ERR_DELAY);
415 /* Signal process_op to set this error on next op */
416 if (args->csa_cachethis == 0)
417 return htonl(NFS4ERR_RETRY_UNCACHED_REP);
418
419 /* Liar! We never allowed you to set csa_cachethis != 0 */
420 return htonl(NFS4ERR_SEQ_FALSE_RETRY);
421 }
422
423 /* Wraparound */
424 if (unlikely(slot->seq_nr == 0xFFFFFFFFU)) {
425 if (args->csa_sequenceid == 1)
426 return htonl(NFS4_OK);
427 } else if (likely(args->csa_sequenceid == slot->seq_nr + 1))
428 return htonl(NFS4_OK);
429
430 /* Misordered request */
431 return htonl(NFS4ERR_SEQ_MISORDERED);
432}
433
434/*
435 * For each referring call triple, check the session's slot table for
436 * a match. If the slot is in use and the sequence numbers match, the
437 * client is still waiting for a response to the original request.
438 */
439static bool referring_call_exists(struct nfs_client *clp,
440 uint32_t nrclists,
441 struct referring_call_list *rclists)
442{
443 bool status = false;
444 int i, j;
445 struct nfs4_session *session;
446 struct nfs4_slot_table *tbl;
447 struct referring_call_list *rclist;
448 struct referring_call *ref;
449
450 /*
451 * XXX When client trunking is implemented, this becomes
452 * a session lookup from within the loop
453 */
454 session = clp->cl_session;
455 tbl = &session->fc_slot_table;
456
457 for (i = 0; i < nrclists; i++) {
458 rclist = &rclists[i];
459 if (memcmp(session->sess_id.data,
460 rclist->rcl_sessionid.data,
461 NFS4_MAX_SESSIONID_LEN) != 0)
462 continue;
463
464 for (j = 0; j < rclist->rcl_nrefcalls; j++) {
465 ref = &rclist->rcl_refcalls[j];
466 status = nfs4_slot_wait_on_seqid(tbl, ref->rc_slotid,
467 ref->rc_sequenceid, HZ >> 1) < 0;
468 if (status)
469 goto out;
470 }
471 }
472
473out:
474 return status;
475}
476
477__be32 nfs4_callback_sequence(void *argp, void *resp,
478 struct cb_process_state *cps)
479{
480 struct cb_sequenceargs *args = argp;
481 struct cb_sequenceres *res = resp;
482 struct nfs4_slot_table *tbl;
483 struct nfs4_slot *slot;
484 struct nfs_client *clp;
485 int i;
486 __be32 status = htonl(NFS4ERR_BADSESSION);
487
488 clp = nfs4_find_client_sessionid(cps->net, args->csa_addr,
489 &args->csa_sessionid, cps->minorversion);
490 if (clp == NULL)
491 goto out;
492
493 if (!(clp->cl_session->flags & SESSION4_BACK_CHAN))
494 goto out;
495
496 tbl = &clp->cl_session->bc_slot_table;
497
498 /* Set up res before grabbing the spinlock */
499 memcpy(&res->csr_sessionid, &args->csa_sessionid,
500 sizeof(res->csr_sessionid));
501 res->csr_sequenceid = args->csa_sequenceid;
502 res->csr_slotid = args->csa_slotid;
503
504 spin_lock(&tbl->slot_tbl_lock);
505 /* state manager is resetting the session */
506 if (test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state)) {
507 status = htonl(NFS4ERR_DELAY);
508 /* Return NFS4ERR_BADSESSION if we're draining the session
509 * in order to reset it.
510 */
511 if (test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
512 status = htonl(NFS4ERR_BADSESSION);
513 goto out_unlock;
514 }
515
516 status = htonl(NFS4ERR_BADSLOT);
517 slot = nfs4_lookup_slot(tbl, args->csa_slotid);
518 if (IS_ERR(slot))
519 goto out_unlock;
520
521 res->csr_highestslotid = tbl->server_highest_slotid;
522 res->csr_target_highestslotid = tbl->target_highest_slotid;
523
524 status = validate_seqid(tbl, slot, args);
525 if (status)
526 goto out_unlock;
527 if (!nfs4_try_to_lock_slot(tbl, slot)) {
528 status = htonl(NFS4ERR_DELAY);
529 goto out_unlock;
530 }
531 cps->slot = slot;
532
533 /* The ca_maxresponsesize_cached is 0 with no DRC */
534 if (args->csa_cachethis != 0) {
535 status = htonl(NFS4ERR_REP_TOO_BIG_TO_CACHE);
536 goto out_unlock;
537 }
538
539 /*
540 * Check for pending referring calls. If a match is found, a
541 * related callback was received before the response to the original
542 * call.
543 */
544 if (referring_call_exists(clp, args->csa_nrclists, args->csa_rclists)) {
545 status = htonl(NFS4ERR_DELAY);
546 goto out_unlock;
547 }
548
549 /*
550 * RFC5661 20.9.3
551 * If CB_SEQUENCE returns an error, then the state of the slot
552 * (sequence ID, cached reply) MUST NOT change.
553 */
554 slot->seq_nr = args->csa_sequenceid;
555out_unlock:
556 spin_unlock(&tbl->slot_tbl_lock);
557
558out:
559 cps->clp = clp; /* put in nfs4_callback_compound */
560 for (i = 0; i < args->csa_nrclists; i++)
561 kfree(args->csa_rclists[i].rcl_refcalls);
562 kfree(args->csa_rclists);
563
564 if (status == htonl(NFS4ERR_RETRY_UNCACHED_REP)) {
565 cps->drc_status = status;
566 status = 0;
567 } else
568 res->csr_status = status;
569
570 trace_nfs4_cb_sequence(args, res, status);
571 return status;
572}
573
574static bool
575validate_bitmap_values(unsigned int mask)
576{
577 return (mask & ~RCA4_TYPE_MASK_ALL) == 0;
578}
579
580__be32 nfs4_callback_recallany(void *argp, void *resp,
581 struct cb_process_state *cps)
582{
583 struct cb_recallanyargs *args = argp;
584 __be32 status;
585 fmode_t flags = 0;
586
587 status = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
588 if (!cps->clp) /* set in cb_sequence */
589 goto out;
590
591 dprintk_rcu("NFS: RECALL_ANY callback request from %s\n",
592 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
593
594 status = cpu_to_be32(NFS4ERR_INVAL);
595 if (!validate_bitmap_values(args->craa_type_mask))
596 goto out;
597
598 status = cpu_to_be32(NFS4_OK);
599 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_RDATA_DLG))
600 flags = FMODE_READ;
601 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_WDATA_DLG))
602 flags |= FMODE_WRITE;
603 if (flags)
604 nfs_expire_unused_delegation_types(cps->clp, flags);
605
606 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_FILE_LAYOUT))
607 pnfs_recall_all_layouts(cps->clp);
608out:
609 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
610 return status;
611}
612
613/* Reduce the fore channel's max_slots to the target value */
614__be32 nfs4_callback_recallslot(void *argp, void *resp,
615 struct cb_process_state *cps)
616{
617 struct cb_recallslotargs *args = argp;
618 struct nfs4_slot_table *fc_tbl;
619 __be32 status;
620
621 status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
622 if (!cps->clp) /* set in cb_sequence */
623 goto out;
624
625 dprintk_rcu("NFS: CB_RECALL_SLOT request from %s target highest slotid %u\n",
626 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR),
627 args->crsa_target_highest_slotid);
628
629 fc_tbl = &cps->clp->cl_session->fc_slot_table;
630
631 status = htonl(NFS4_OK);
632
633 nfs41_set_target_slotid(fc_tbl, args->crsa_target_highest_slotid);
634 nfs41_notify_server(cps->clp);
635out:
636 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
637 return status;
638}
639
640__be32 nfs4_callback_notify_lock(void *argp, void *resp,
641 struct cb_process_state *cps)
642{
643 struct cb_notify_lock_args *args = argp;
644
645 if (!cps->clp) /* set in cb_sequence */
646 return htonl(NFS4ERR_OP_NOT_IN_SESSION);
647
648 dprintk_rcu("NFS: CB_NOTIFY_LOCK request from %s\n",
649 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
650
651 /* Don't wake anybody if the string looked bogus */
652 if (args->cbnl_valid)
653 __wake_up(&cps->clp->cl_lock_waitq, TASK_NORMAL, 0, args);
654
655 return htonl(NFS4_OK);
656}
657#endif /* CONFIG_NFS_V4_1 */
1/*
2 * linux/fs/nfs/callback_proc.c
3 *
4 * Copyright (C) 2004 Trond Myklebust
5 *
6 * NFSv4 callback procedures
7 */
8#include <linux/nfs4.h>
9#include <linux/nfs_fs.h>
10#include <linux/slab.h>
11#include <linux/rcupdate.h>
12#include "nfs4_fs.h"
13#include "callback.h"
14#include "delegation.h"
15#include "internal.h"
16#include "pnfs.h"
17#include "nfs4session.h"
18#include "nfs4trace.h"
19
20#ifdef NFS_DEBUG
21#define NFSDBG_FACILITY NFSDBG_CALLBACK
22#endif
23
24__be32 nfs4_callback_getattr(struct cb_getattrargs *args,
25 struct cb_getattrres *res,
26 struct cb_process_state *cps)
27{
28 struct nfs_delegation *delegation;
29 struct nfs_inode *nfsi;
30 struct inode *inode;
31
32 res->status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
33 if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
34 goto out;
35
36 res->bitmap[0] = res->bitmap[1] = 0;
37 res->status = htonl(NFS4ERR_BADHANDLE);
38
39 dprintk_rcu("NFS: GETATTR callback request from %s\n",
40 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
41
42 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
43 if (inode == NULL)
44 goto out;
45 nfsi = NFS_I(inode);
46 rcu_read_lock();
47 delegation = rcu_dereference(nfsi->delegation);
48 if (delegation == NULL || (delegation->type & FMODE_WRITE) == 0)
49 goto out_iput;
50 res->size = i_size_read(inode);
51 res->change_attr = delegation->change_attr;
52 if (nfsi->npages != 0)
53 res->change_attr++;
54 res->ctime = inode->i_ctime;
55 res->mtime = inode->i_mtime;
56 res->bitmap[0] = (FATTR4_WORD0_CHANGE|FATTR4_WORD0_SIZE) &
57 args->bitmap[0];
58 res->bitmap[1] = (FATTR4_WORD1_TIME_METADATA|FATTR4_WORD1_TIME_MODIFY) &
59 args->bitmap[1];
60 res->status = 0;
61out_iput:
62 rcu_read_unlock();
63 iput(inode);
64out:
65 dprintk("%s: exit with status = %d\n", __func__, ntohl(res->status));
66 return res->status;
67}
68
69__be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
70 struct cb_process_state *cps)
71{
72 struct inode *inode;
73 __be32 res;
74
75 res = htonl(NFS4ERR_OP_NOT_IN_SESSION);
76 if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
77 goto out;
78
79 dprintk_rcu("NFS: RECALL callback request from %s\n",
80 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
81
82 res = htonl(NFS4ERR_BADHANDLE);
83 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
84 if (inode == NULL)
85 goto out;
86 /* Set up a helper thread to actually return the delegation */
87 switch (nfs_async_inode_return_delegation(inode, &args->stateid)) {
88 case 0:
89 res = 0;
90 break;
91 case -ENOENT:
92 res = htonl(NFS4ERR_BAD_STATEID);
93 break;
94 default:
95 res = htonl(NFS4ERR_RESOURCE);
96 }
97 trace_nfs4_recall_delegation(inode, -ntohl(res));
98 iput(inode);
99out:
100 dprintk("%s: exit with status = %d\n", __func__, ntohl(res));
101 return res;
102}
103
104#if defined(CONFIG_NFS_V4_1)
105
106/*
107 * Lookup a layout by filehandle.
108 *
109 * Note: gets a refcount on the layout hdr and on its respective inode.
110 * Caller must put the layout hdr and the inode.
111 *
112 * TODO: keep track of all layouts (and delegations) in a hash table
113 * hashed by filehandle.
114 */
115static struct pnfs_layout_hdr * get_layout_by_fh_locked(struct nfs_client *clp,
116 struct nfs_fh *fh, nfs4_stateid *stateid)
117{
118 struct nfs_server *server;
119 struct inode *ino;
120 struct pnfs_layout_hdr *lo;
121
122 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
123 list_for_each_entry(lo, &server->layouts, plh_layouts) {
124 if (!nfs4_stateid_match_other(&lo->plh_stateid, stateid))
125 continue;
126 if (nfs_compare_fh(fh, &NFS_I(lo->plh_inode)->fh))
127 continue;
128 ino = igrab(lo->plh_inode);
129 if (!ino)
130 break;
131 spin_lock(&ino->i_lock);
132 /* Is this layout in the process of being freed? */
133 if (NFS_I(ino)->layout != lo) {
134 spin_unlock(&ino->i_lock);
135 iput(ino);
136 break;
137 }
138 pnfs_get_layout_hdr(lo);
139 spin_unlock(&ino->i_lock);
140 return lo;
141 }
142 }
143
144 return NULL;
145}
146
147static struct pnfs_layout_hdr * get_layout_by_fh(struct nfs_client *clp,
148 struct nfs_fh *fh, nfs4_stateid *stateid)
149{
150 struct pnfs_layout_hdr *lo;
151
152 spin_lock(&clp->cl_lock);
153 rcu_read_lock();
154 lo = get_layout_by_fh_locked(clp, fh, stateid);
155 rcu_read_unlock();
156 spin_unlock(&clp->cl_lock);
157
158 return lo;
159}
160
161static u32 initiate_file_draining(struct nfs_client *clp,
162 struct cb_layoutrecallargs *args)
163{
164 struct inode *ino;
165 struct pnfs_layout_hdr *lo;
166 u32 rv = NFS4ERR_NOMATCHING_LAYOUT;
167 LIST_HEAD(free_me_list);
168
169 lo = get_layout_by_fh(clp, &args->cbl_fh, &args->cbl_stateid);
170 if (!lo)
171 goto out;
172
173 ino = lo->plh_inode;
174 spin_lock(&ino->i_lock);
175 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags) ||
176 pnfs_mark_matching_lsegs_invalid(lo, &free_me_list,
177 &args->cbl_range))
178 rv = NFS4ERR_DELAY;
179 else
180 rv = NFS4ERR_NOMATCHING_LAYOUT;
181 pnfs_set_layout_stateid(lo, &args->cbl_stateid, true);
182 spin_unlock(&ino->i_lock);
183 pnfs_free_lseg_list(&free_me_list);
184 pnfs_put_layout_hdr(lo);
185 iput(ino);
186out:
187 return rv;
188}
189
190static u32 initiate_bulk_draining(struct nfs_client *clp,
191 struct cb_layoutrecallargs *args)
192{
193 int stat;
194
195 if (args->cbl_recall_type == RETURN_FSID)
196 stat = pnfs_destroy_layouts_byfsid(clp, &args->cbl_fsid, true);
197 else
198 stat = pnfs_destroy_layouts_byclid(clp, true);
199 if (stat != 0)
200 return NFS4ERR_DELAY;
201 return NFS4ERR_NOMATCHING_LAYOUT;
202}
203
204static u32 do_callback_layoutrecall(struct nfs_client *clp,
205 struct cb_layoutrecallargs *args)
206{
207 u32 res;
208
209 dprintk("%s enter, type=%i\n", __func__, args->cbl_recall_type);
210 if (args->cbl_recall_type == RETURN_FILE)
211 res = initiate_file_draining(clp, args);
212 else
213 res = initiate_bulk_draining(clp, args);
214 dprintk("%s returning %i\n", __func__, res);
215 return res;
216
217}
218
219__be32 nfs4_callback_layoutrecall(struct cb_layoutrecallargs *args,
220 void *dummy, struct cb_process_state *cps)
221{
222 u32 res;
223
224 dprintk("%s: -->\n", __func__);
225
226 if (cps->clp)
227 res = do_callback_layoutrecall(cps->clp, args);
228 else
229 res = NFS4ERR_OP_NOT_IN_SESSION;
230
231 dprintk("%s: exit with status = %d\n", __func__, res);
232 return cpu_to_be32(res);
233}
234
235static void pnfs_recall_all_layouts(struct nfs_client *clp)
236{
237 struct cb_layoutrecallargs args;
238
239 /* Pretend we got a CB_LAYOUTRECALL(ALL) */
240 memset(&args, 0, sizeof(args));
241 args.cbl_recall_type = RETURN_ALL;
242 /* FIXME we ignore errors, what should we do? */
243 do_callback_layoutrecall(clp, &args);
244}
245
246__be32 nfs4_callback_devicenotify(struct cb_devicenotifyargs *args,
247 void *dummy, struct cb_process_state *cps)
248{
249 int i;
250 __be32 res = 0;
251 struct nfs_client *clp = cps->clp;
252 struct nfs_server *server = NULL;
253
254 dprintk("%s: -->\n", __func__);
255
256 if (!clp) {
257 res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
258 goto out;
259 }
260
261 for (i = 0; i < args->ndevs; i++) {
262 struct cb_devicenotifyitem *dev = &args->devs[i];
263
264 if (!server ||
265 server->pnfs_curr_ld->id != dev->cbd_layout_type) {
266 rcu_read_lock();
267 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
268 if (server->pnfs_curr_ld &&
269 server->pnfs_curr_ld->id == dev->cbd_layout_type) {
270 rcu_read_unlock();
271 goto found;
272 }
273 rcu_read_unlock();
274 dprintk("%s: layout type %u not found\n",
275 __func__, dev->cbd_layout_type);
276 continue;
277 }
278
279 found:
280 if (dev->cbd_notify_type == NOTIFY_DEVICEID4_CHANGE)
281 dprintk("%s: NOTIFY_DEVICEID4_CHANGE not supported, "
282 "deleting instead\n", __func__);
283 nfs4_delete_deviceid(server->pnfs_curr_ld, clp, &dev->cbd_dev_id);
284 }
285
286out:
287 kfree(args->devs);
288 dprintk("%s: exit with status = %u\n",
289 __func__, be32_to_cpu(res));
290 return res;
291}
292
293/*
294 * Validate the sequenceID sent by the server.
295 * Return success if the sequenceID is one more than what we last saw on
296 * this slot, accounting for wraparound. Increments the slot's sequence.
297 *
298 * We don't yet implement a duplicate request cache, instead we set the
299 * back channel ca_maxresponsesize_cached to zero. This is OK for now
300 * since we only currently implement idempotent callbacks anyway.
301 *
302 * We have a single slot backchannel at this time, so we don't bother
303 * checking the used_slots bit array on the table. The lower layer guarantees
304 * a single outstanding callback request at a time.
305 */
306static __be32
307validate_seqid(struct nfs4_slot_table *tbl, struct cb_sequenceargs * args)
308{
309 struct nfs4_slot *slot;
310
311 dprintk("%s enter. slotid %u seqid %u\n",
312 __func__, args->csa_slotid, args->csa_sequenceid);
313
314 if (args->csa_slotid >= NFS41_BC_MAX_CALLBACKS)
315 return htonl(NFS4ERR_BADSLOT);
316
317 slot = tbl->slots + args->csa_slotid;
318 dprintk("%s slot table seqid: %u\n", __func__, slot->seq_nr);
319
320 /* Normal */
321 if (likely(args->csa_sequenceid == slot->seq_nr + 1)) {
322 slot->seq_nr++;
323 goto out_ok;
324 }
325
326 /* Replay */
327 if (args->csa_sequenceid == slot->seq_nr) {
328 dprintk("%s seqid %u is a replay\n",
329 __func__, args->csa_sequenceid);
330 /* Signal process_op to set this error on next op */
331 if (args->csa_cachethis == 0)
332 return htonl(NFS4ERR_RETRY_UNCACHED_REP);
333
334 /* The ca_maxresponsesize_cached is 0 with no DRC */
335 else if (args->csa_cachethis == 1)
336 return htonl(NFS4ERR_REP_TOO_BIG_TO_CACHE);
337 }
338
339 /* Wraparound */
340 if (args->csa_sequenceid == 1 && (slot->seq_nr + 1) == 0) {
341 slot->seq_nr = 1;
342 goto out_ok;
343 }
344
345 /* Misordered request */
346 return htonl(NFS4ERR_SEQ_MISORDERED);
347out_ok:
348 tbl->highest_used_slotid = args->csa_slotid;
349 return htonl(NFS4_OK);
350}
351
352/*
353 * For each referring call triple, check the session's slot table for
354 * a match. If the slot is in use and the sequence numbers match, the
355 * client is still waiting for a response to the original request.
356 */
357static bool referring_call_exists(struct nfs_client *clp,
358 uint32_t nrclists,
359 struct referring_call_list *rclists)
360{
361 bool status = 0;
362 int i, j;
363 struct nfs4_session *session;
364 struct nfs4_slot_table *tbl;
365 struct referring_call_list *rclist;
366 struct referring_call *ref;
367
368 /*
369 * XXX When client trunking is implemented, this becomes
370 * a session lookup from within the loop
371 */
372 session = clp->cl_session;
373 tbl = &session->fc_slot_table;
374
375 for (i = 0; i < nrclists; i++) {
376 rclist = &rclists[i];
377 if (memcmp(session->sess_id.data,
378 rclist->rcl_sessionid.data,
379 NFS4_MAX_SESSIONID_LEN) != 0)
380 continue;
381
382 for (j = 0; j < rclist->rcl_nrefcalls; j++) {
383 ref = &rclist->rcl_refcalls[j];
384
385 dprintk("%s: sessionid %x:%x:%x:%x sequenceid %u "
386 "slotid %u\n", __func__,
387 ((u32 *)&rclist->rcl_sessionid.data)[0],
388 ((u32 *)&rclist->rcl_sessionid.data)[1],
389 ((u32 *)&rclist->rcl_sessionid.data)[2],
390 ((u32 *)&rclist->rcl_sessionid.data)[3],
391 ref->rc_sequenceid, ref->rc_slotid);
392
393 spin_lock(&tbl->slot_tbl_lock);
394 status = (test_bit(ref->rc_slotid, tbl->used_slots) &&
395 tbl->slots[ref->rc_slotid].seq_nr ==
396 ref->rc_sequenceid);
397 spin_unlock(&tbl->slot_tbl_lock);
398 if (status)
399 goto out;
400 }
401 }
402
403out:
404 return status;
405}
406
407__be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
408 struct cb_sequenceres *res,
409 struct cb_process_state *cps)
410{
411 struct nfs4_slot_table *tbl;
412 struct nfs_client *clp;
413 int i;
414 __be32 status = htonl(NFS4ERR_BADSESSION);
415
416 clp = nfs4_find_client_sessionid(cps->net, args->csa_addr,
417 &args->csa_sessionid, cps->minorversion);
418 if (clp == NULL)
419 goto out;
420
421 tbl = &clp->cl_session->bc_slot_table;
422
423 spin_lock(&tbl->slot_tbl_lock);
424 /* state manager is resetting the session */
425 if (test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state)) {
426 spin_unlock(&tbl->slot_tbl_lock);
427 status = htonl(NFS4ERR_DELAY);
428 /* Return NFS4ERR_BADSESSION if we're draining the session
429 * in order to reset it.
430 */
431 if (test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
432 status = htonl(NFS4ERR_BADSESSION);
433 goto out;
434 }
435
436 status = validate_seqid(&clp->cl_session->bc_slot_table, args);
437 spin_unlock(&tbl->slot_tbl_lock);
438 if (status)
439 goto out;
440
441 cps->slotid = args->csa_slotid;
442
443 /*
444 * Check for pending referring calls. If a match is found, a
445 * related callback was received before the response to the original
446 * call.
447 */
448 if (referring_call_exists(clp, args->csa_nrclists, args->csa_rclists)) {
449 status = htonl(NFS4ERR_DELAY);
450 goto out;
451 }
452
453 memcpy(&res->csr_sessionid, &args->csa_sessionid,
454 sizeof(res->csr_sessionid));
455 res->csr_sequenceid = args->csa_sequenceid;
456 res->csr_slotid = args->csa_slotid;
457 res->csr_highestslotid = NFS41_BC_MAX_CALLBACKS - 1;
458 res->csr_target_highestslotid = NFS41_BC_MAX_CALLBACKS - 1;
459
460out:
461 cps->clp = clp; /* put in nfs4_callback_compound */
462 for (i = 0; i < args->csa_nrclists; i++)
463 kfree(args->csa_rclists[i].rcl_refcalls);
464 kfree(args->csa_rclists);
465
466 if (status == htonl(NFS4ERR_RETRY_UNCACHED_REP)) {
467 cps->drc_status = status;
468 status = 0;
469 } else
470 res->csr_status = status;
471
472 trace_nfs4_cb_sequence(args, res, status);
473 dprintk("%s: exit with status = %d res->csr_status %d\n", __func__,
474 ntohl(status), ntohl(res->csr_status));
475 return status;
476}
477
478static bool
479validate_bitmap_values(unsigned long mask)
480{
481 return (mask & ~RCA4_TYPE_MASK_ALL) == 0;
482}
483
484__be32 nfs4_callback_recallany(struct cb_recallanyargs *args, void *dummy,
485 struct cb_process_state *cps)
486{
487 __be32 status;
488 fmode_t flags = 0;
489
490 status = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
491 if (!cps->clp) /* set in cb_sequence */
492 goto out;
493
494 dprintk_rcu("NFS: RECALL_ANY callback request from %s\n",
495 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
496
497 status = cpu_to_be32(NFS4ERR_INVAL);
498 if (!validate_bitmap_values(args->craa_type_mask))
499 goto out;
500
501 status = cpu_to_be32(NFS4_OK);
502 if (test_bit(RCA4_TYPE_MASK_RDATA_DLG, (const unsigned long *)
503 &args->craa_type_mask))
504 flags = FMODE_READ;
505 if (test_bit(RCA4_TYPE_MASK_WDATA_DLG, (const unsigned long *)
506 &args->craa_type_mask))
507 flags |= FMODE_WRITE;
508 if (test_bit(RCA4_TYPE_MASK_FILE_LAYOUT, (const unsigned long *)
509 &args->craa_type_mask))
510 pnfs_recall_all_layouts(cps->clp);
511 if (flags)
512 nfs_expire_unused_delegation_types(cps->clp, flags);
513out:
514 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
515 return status;
516}
517
518/* Reduce the fore channel's max_slots to the target value */
519__be32 nfs4_callback_recallslot(struct cb_recallslotargs *args, void *dummy,
520 struct cb_process_state *cps)
521{
522 struct nfs4_slot_table *fc_tbl;
523 __be32 status;
524
525 status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
526 if (!cps->clp) /* set in cb_sequence */
527 goto out;
528
529 dprintk_rcu("NFS: CB_RECALL_SLOT request from %s target highest slotid %u\n",
530 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR),
531 args->crsa_target_highest_slotid);
532
533 fc_tbl = &cps->clp->cl_session->fc_slot_table;
534
535 status = htonl(NFS4_OK);
536
537 nfs41_set_target_slotid(fc_tbl, args->crsa_target_highest_slotid);
538 nfs41_server_notify_target_slotid_update(cps->clp);
539out:
540 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
541 return status;
542}
543#endif /* CONFIG_NFS_V4_1 */