1 // SPDX-License-Identifier: GPL-2.0
3 * linux/fs/nfs/callback_proc.c
5 * Copyright (C) 2004 Trond Myklebust
7 * NFSv4 callback procedures
10 #include <linux/errno.h>
11 #include <linux/math.h>
12 #include <linux/nfs4.h>
13 #include <linux/nfs_fs.h>
14 #include <linux/slab.h>
15 #include <linux/rcupdate.h>
16 #include <linux/types.h>
20 #include "delegation.h"
23 #include "nfs4session.h"
24 #include "nfs4trace.h"
26 #define NFSDBG_FACILITY NFSDBG_CALLBACK
28 __be32 nfs4_callback_getattr(void *argp, void *resp,
29 struct cb_process_state *cps)
31 struct cb_getattrargs *args = argp;
32 struct cb_getattrres *res = resp;
33 struct nfs_delegation *delegation;
36 res->status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
37 if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
40 res->bitmap[0] = res->bitmap[1] = 0;
41 res->status = htonl(NFS4ERR_BADHANDLE);
43 dprintk_rcu("NFS: GETATTR callback request from %s\n",
44 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
46 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
48 if (inode == ERR_PTR(-EAGAIN))
49 res->status = htonl(NFS4ERR_DELAY);
50 trace_nfs4_cb_getattr(cps->clp, &args->fh, NULL,
55 delegation = nfs4_get_valid_delegation(inode);
56 if (delegation == NULL || (delegation->type & FMODE_WRITE) == 0)
58 res->size = i_size_read(inode);
59 res->change_attr = delegation->change_attr;
60 if (nfs_have_writebacks(inode))
62 res->ctime = inode->i_ctime;
63 res->mtime = inode->i_mtime;
64 res->bitmap[0] = (FATTR4_WORD0_CHANGE|FATTR4_WORD0_SIZE) &
66 res->bitmap[1] = (FATTR4_WORD1_TIME_METADATA|FATTR4_WORD1_TIME_MODIFY) &
71 trace_nfs4_cb_getattr(cps->clp, &args->fh, inode, -ntohl(res->status));
72 nfs_iput_and_deactive(inode);
74 dprintk("%s: exit with status = %d\n", __func__, ntohl(res->status));
78 __be32 nfs4_callback_recall(void *argp, void *resp,
79 struct cb_process_state *cps)
81 struct cb_recallargs *args = argp;
85 res = htonl(NFS4ERR_OP_NOT_IN_SESSION);
86 if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
89 dprintk_rcu("NFS: RECALL callback request from %s\n",
90 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
92 res = htonl(NFS4ERR_BADHANDLE);
93 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
95 if (inode == ERR_PTR(-EAGAIN))
96 res = htonl(NFS4ERR_DELAY);
97 trace_nfs4_cb_recall(cps->clp, &args->fh, NULL,
98 &args->stateid, -ntohl(res));
101 /* Set up a helper thread to actually return the delegation */
102 switch (nfs_async_inode_return_delegation(inode, &args->stateid)) {
107 res = htonl(NFS4ERR_BAD_STATEID);
110 res = htonl(NFS4ERR_RESOURCE);
112 trace_nfs4_cb_recall(cps->clp, &args->fh, inode,
113 &args->stateid, -ntohl(res));
114 nfs_iput_and_deactive(inode);
116 dprintk("%s: exit with status = %d\n", __func__, ntohl(res));
120 #if defined(CONFIG_NFS_V4_1)
123 * Lookup a layout inode by stateid
125 * Note: returns a refcount on the inode and superblock
127 static struct inode *nfs_layout_find_inode_by_stateid(struct nfs_client *clp,
128 const nfs4_stateid *stateid)
131 struct nfs_server *server;
133 struct pnfs_layout_hdr *lo;
136 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
137 list_for_each_entry_rcu(lo, &server->layouts, plh_layouts) {
138 if (!pnfs_layout_is_valid(lo))
140 if (stateid != NULL &&
141 !nfs4_stateid_match_other(stateid, &lo->plh_stateid))
143 if (!nfs_sb_active(server->super))
145 inode = igrab(lo->plh_inode);
149 nfs_sb_deactive(server->super);
150 return ERR_PTR(-EAGAIN);
154 return ERR_PTR(-ENOENT);
158 * Lookup a layout inode by filehandle.
160 * Note: returns a refcount on the inode and superblock
163 static struct inode *nfs_layout_find_inode_by_fh(struct nfs_client *clp,
164 const struct nfs_fh *fh)
166 struct nfs_server *server;
167 struct nfs_inode *nfsi;
169 struct pnfs_layout_hdr *lo;
172 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
173 list_for_each_entry_rcu(lo, &server->layouts, plh_layouts) {
174 nfsi = NFS_I(lo->plh_inode);
175 if (nfs_compare_fh(fh, &nfsi->fh))
177 if (nfsi->layout != lo)
179 if (!nfs_sb_active(server->super))
181 inode = igrab(lo->plh_inode);
185 nfs_sb_deactive(server->super);
186 return ERR_PTR(-EAGAIN);
190 return ERR_PTR(-ENOENT);
193 static struct inode *nfs_layout_find_inode(struct nfs_client *clp,
194 const struct nfs_fh *fh,
195 const nfs4_stateid *stateid)
199 inode = nfs_layout_find_inode_by_stateid(clp, stateid);
200 if (inode == ERR_PTR(-ENOENT))
201 inode = nfs_layout_find_inode_by_fh(clp, fh);
206 * Enforce RFC5661 section 12.5.5.2.1. (Layout Recall and Return Sequencing)
208 static u32 pnfs_check_callback_stateid(struct pnfs_layout_hdr *lo,
209 const nfs4_stateid *new)
213 /* Is the stateid not initialised? */
214 if (!pnfs_layout_is_valid(lo))
215 return NFS4ERR_NOMATCHING_LAYOUT;
217 /* Mismatched stateid? */
218 if (!nfs4_stateid_match_other(&lo->plh_stateid, new))
219 return NFS4ERR_BAD_STATEID;
221 newseq = be32_to_cpu(new->seqid);
222 /* Are we already in a layout recall situation? */
223 if (test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags) &&
224 lo->plh_return_seq != 0) {
225 if (newseq < lo->plh_return_seq)
226 return NFS4ERR_OLD_STATEID;
227 if (newseq > lo->plh_return_seq)
228 return NFS4ERR_DELAY;
232 /* Check that the stateid matches what we think it should be. */
233 oldseq = be32_to_cpu(lo->plh_stateid.seqid);
234 if (newseq > oldseq + 1)
235 return NFS4ERR_DELAY;
237 if (newseq <= oldseq)
238 return NFS4ERR_OLD_STATEID;
243 static u32 initiate_file_draining(struct nfs_client *clp,
244 struct cb_layoutrecallargs *args)
247 struct pnfs_layout_hdr *lo;
248 u32 rv = NFS4ERR_NOMATCHING_LAYOUT;
249 LIST_HEAD(free_me_list);
251 ino = nfs_layout_find_inode(clp, &args->cbl_fh, &args->cbl_stateid);
253 if (ino == ERR_PTR(-EAGAIN))
258 pnfs_layoutcommit_inode(ino, false);
261 spin_lock(&ino->i_lock);
262 lo = NFS_I(ino)->layout;
264 spin_unlock(&ino->i_lock);
267 pnfs_get_layout_hdr(lo);
268 rv = pnfs_check_callback_stateid(lo, &args->cbl_stateid);
273 * Enforce RFC5661 Section 12.5.5.2.1.5 (Bulk Recall and Return)
275 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
280 pnfs_set_layout_stateid(lo, &args->cbl_stateid, NULL, true);
281 switch (pnfs_mark_matching_lsegs_return(lo, &free_me_list,
283 be32_to_cpu(args->cbl_stateid.seqid))) {
286 /* There are layout segments that need to be returned */
290 /* Embrace your forgetfulness! */
291 rv = NFS4ERR_NOMATCHING_LAYOUT;
293 if (NFS_SERVER(ino)->pnfs_curr_ld->return_range) {
294 NFS_SERVER(ino)->pnfs_curr_ld->return_range(lo,
299 spin_unlock(&ino->i_lock);
300 pnfs_free_lseg_list(&free_me_list);
301 /* Free all lsegs that are attached to commit buckets */
302 nfs_commit_inode(ino, 0);
303 pnfs_put_layout_hdr(lo);
305 nfs_iput_and_deactive(ino);
307 trace_nfs4_cb_layoutrecall_file(clp, &args->cbl_fh, ino,
308 &args->cbl_stateid, -rv);
312 static u32 initiate_bulk_draining(struct nfs_client *clp,
313 struct cb_layoutrecallargs *args)
317 if (args->cbl_recall_type == RETURN_FSID)
318 stat = pnfs_destroy_layouts_byfsid(clp, &args->cbl_fsid, true);
320 stat = pnfs_destroy_layouts_byclid(clp, true);
322 return NFS4ERR_DELAY;
323 return NFS4ERR_NOMATCHING_LAYOUT;
326 static u32 do_callback_layoutrecall(struct nfs_client *clp,
327 struct cb_layoutrecallargs *args)
329 if (args->cbl_recall_type == RETURN_FILE)
330 return initiate_file_draining(clp, args);
331 return initiate_bulk_draining(clp, args);
334 __be32 nfs4_callback_layoutrecall(void *argp, void *resp,
335 struct cb_process_state *cps)
337 struct cb_layoutrecallargs *args = argp;
338 u32 res = NFS4ERR_OP_NOT_IN_SESSION;
341 res = do_callback_layoutrecall(cps->clp, args);
342 return cpu_to_be32(res);
345 static void pnfs_recall_all_layouts(struct nfs_client *clp)
347 struct cb_layoutrecallargs args;
349 /* Pretend we got a CB_LAYOUTRECALL(ALL) */
350 memset(&args, 0, sizeof(args));
351 args.cbl_recall_type = RETURN_ALL;
352 /* FIXME we ignore errors, what should we do? */
353 do_callback_layoutrecall(clp, &args);
356 __be32 nfs4_callback_devicenotify(void *argp, void *resp,
357 struct cb_process_state *cps)
359 struct cb_devicenotifyargs *args = argp;
362 struct nfs_client *clp = cps->clp;
363 struct nfs_server *server = NULL;
366 res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
370 for (i = 0; i < args->ndevs; i++) {
371 struct cb_devicenotifyitem *dev = &args->devs[i];
374 server->pnfs_curr_ld->id != dev->cbd_layout_type) {
376 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
377 if (server->pnfs_curr_ld &&
378 server->pnfs_curr_ld->id == dev->cbd_layout_type) {
387 nfs4_delete_deviceid(server->pnfs_curr_ld, clp, &dev->cbd_dev_id);
396 * Validate the sequenceID sent by the server.
397 * Return success if the sequenceID is one more than what we last saw on
398 * this slot, accounting for wraparound. Increments the slot's sequence.
400 * We don't yet implement a duplicate request cache, instead we set the
401 * back channel ca_maxresponsesize_cached to zero. This is OK for now
402 * since we only currently implement idempotent callbacks anyway.
404 * We have a single slot backchannel at this time, so we don't bother
405 * checking the used_slots bit array on the table. The lower layer guarantees
406 * a single outstanding callback request at a time.
409 validate_seqid(const struct nfs4_slot_table *tbl, const struct nfs4_slot *slot,
410 const struct cb_sequenceargs * args)
414 ret = cpu_to_be32(NFS4ERR_BADSLOT);
415 if (args->csa_slotid > tbl->server_highest_slotid)
419 if (args->csa_sequenceid == slot->seq_nr) {
420 ret = cpu_to_be32(NFS4ERR_DELAY);
421 if (nfs4_test_locked_slot(tbl, slot->slot_nr))
424 /* Signal process_op to set this error on next op */
425 ret = cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP);
426 if (args->csa_cachethis == 0)
429 /* Liar! We never allowed you to set csa_cachethis != 0 */
430 ret = cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY);
434 /* Note: wraparound relies on seq_nr being of type u32 */
435 /* Misordered request */
436 ret = cpu_to_be32(NFS4ERR_SEQ_MISORDERED);
437 if (args->csa_sequenceid != slot->seq_nr + 1)
440 return cpu_to_be32(NFS4_OK);
443 trace_nfs4_cb_seqid_err(args, ret);
448 * For each referring call triple, check the session's slot table for
449 * a match. If the slot is in use and the sequence numbers match, the
450 * client is still waiting for a response to the original request.
452 static int referring_call_exists(struct nfs_client *clp,
454 struct referring_call_list *rclists,
461 struct nfs4_session *session;
462 struct nfs4_slot_table *tbl;
463 struct referring_call_list *rclist;
464 struct referring_call *ref;
467 * XXX When client trunking is implemented, this becomes
468 * a session lookup from within the loop
470 session = clp->cl_session;
471 tbl = &session->fc_slot_table;
473 for (i = 0; i < nrclists; i++) {
474 rclist = &rclists[i];
475 if (memcmp(session->sess_id.data,
476 rclist->rcl_sessionid.data,
477 NFS4_MAX_SESSIONID_LEN) != 0)
480 for (j = 0; j < rclist->rcl_nrefcalls; j++) {
481 ref = &rclist->rcl_refcalls[j];
483 status = nfs4_slot_wait_on_seqid(tbl, ref->rc_slotid,
484 ref->rc_sequenceid, HZ >> 1) < 0;
495 __be32 nfs4_callback_sequence(void *argp, void *resp,
496 struct cb_process_state *cps)
498 struct cb_sequenceargs *args = argp;
499 struct cb_sequenceres *res = resp;
500 struct nfs4_slot_table *tbl;
501 struct nfs4_slot *slot;
502 struct nfs_client *clp;
504 __be32 status = htonl(NFS4ERR_BADSESSION);
506 clp = nfs4_find_client_sessionid(cps->net, args->csa_addr,
507 &args->csa_sessionid, cps->minorversion);
511 if (!(clp->cl_session->flags & SESSION4_BACK_CHAN))
514 tbl = &clp->cl_session->bc_slot_table;
516 /* Set up res before grabbing the spinlock */
517 memcpy(&res->csr_sessionid, &args->csa_sessionid,
518 sizeof(res->csr_sessionid));
519 res->csr_sequenceid = args->csa_sequenceid;
520 res->csr_slotid = args->csa_slotid;
522 spin_lock(&tbl->slot_tbl_lock);
523 /* state manager is resetting the session */
524 if (test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state)) {
525 status = htonl(NFS4ERR_DELAY);
526 /* Return NFS4ERR_BADSESSION if we're draining the session
527 * in order to reset it.
529 if (test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
530 status = htonl(NFS4ERR_BADSESSION);
534 status = htonl(NFS4ERR_BADSLOT);
535 slot = nfs4_lookup_slot(tbl, args->csa_slotid);
539 res->csr_highestslotid = tbl->server_highest_slotid;
540 res->csr_target_highestslotid = tbl->target_highest_slotid;
542 status = validate_seqid(tbl, slot, args);
545 if (!nfs4_try_to_lock_slot(tbl, slot)) {
546 status = htonl(NFS4ERR_DELAY);
551 /* The ca_maxresponsesize_cached is 0 with no DRC */
552 if (args->csa_cachethis != 0) {
553 status = htonl(NFS4ERR_REP_TOO_BIG_TO_CACHE);
558 * Check for pending referring calls. If a match is found, a
559 * related callback was received before the response to the original
562 if (referring_call_exists(clp, args->csa_nrclists, args->csa_rclists,
563 &tbl->slot_tbl_lock) < 0) {
564 status = htonl(NFS4ERR_DELAY);
570 * If CB_SEQUENCE returns an error, then the state of the slot
571 * (sequence ID, cached reply) MUST NOT change.
573 slot->seq_nr = args->csa_sequenceid;
575 spin_unlock(&tbl->slot_tbl_lock);
578 cps->clp = clp; /* put in nfs4_callback_compound */
579 for (i = 0; i < args->csa_nrclists; i++)
580 kfree(args->csa_rclists[i].rcl_refcalls);
581 kfree(args->csa_rclists);
583 if (status == htonl(NFS4ERR_RETRY_UNCACHED_REP)) {
584 cps->drc_status = status;
587 res->csr_status = status;
589 trace_nfs4_cb_sequence(args, res, status);
594 validate_bitmap_values(unsigned int mask)
596 return (mask & ~RCA4_TYPE_MASK_ALL) == 0;
599 __be32 nfs4_callback_recallany(void *argp, void *resp,
600 struct cb_process_state *cps)
602 struct cb_recallanyargs *args = argp;
605 bool schedule_manager = false;
607 status = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
608 if (!cps->clp) /* set in cb_sequence */
611 dprintk_rcu("NFS: RECALL_ANY callback request from %s\n",
612 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
614 status = cpu_to_be32(NFS4ERR_INVAL);
615 if (!validate_bitmap_values(args->craa_type_mask))
618 status = cpu_to_be32(NFS4_OK);
619 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_RDATA_DLG))
621 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_WDATA_DLG))
622 flags |= FMODE_WRITE;
624 nfs_expire_unused_delegation_types(cps->clp, flags);
626 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_FILE_LAYOUT))
627 pnfs_recall_all_layouts(cps->clp);
629 if (args->craa_type_mask & BIT(PNFS_FF_RCA4_TYPE_MASK_READ)) {
630 set_bit(NFS4CLNT_RECALL_ANY_LAYOUT_READ, &cps->clp->cl_state);
631 schedule_manager = true;
633 if (args->craa_type_mask & BIT(PNFS_FF_RCA4_TYPE_MASK_RW)) {
634 set_bit(NFS4CLNT_RECALL_ANY_LAYOUT_RW, &cps->clp->cl_state);
635 schedule_manager = true;
637 if (schedule_manager)
638 nfs4_schedule_state_manager(cps->clp);
641 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
645 /* Reduce the fore channel's max_slots to the target value */
646 __be32 nfs4_callback_recallslot(void *argp, void *resp,
647 struct cb_process_state *cps)
649 struct cb_recallslotargs *args = argp;
650 struct nfs4_slot_table *fc_tbl;
653 status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
654 if (!cps->clp) /* set in cb_sequence */
657 dprintk_rcu("NFS: CB_RECALL_SLOT request from %s target highest slotid %u\n",
658 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR),
659 args->crsa_target_highest_slotid);
661 fc_tbl = &cps->clp->cl_session->fc_slot_table;
663 status = htonl(NFS4_OK);
665 nfs41_set_target_slotid(fc_tbl, args->crsa_target_highest_slotid);
666 nfs41_notify_server(cps->clp);
668 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
672 __be32 nfs4_callback_notify_lock(void *argp, void *resp,
673 struct cb_process_state *cps)
675 struct cb_notify_lock_args *args = argp;
677 if (!cps->clp) /* set in cb_sequence */
678 return htonl(NFS4ERR_OP_NOT_IN_SESSION);
680 dprintk_rcu("NFS: CB_NOTIFY_LOCK request from %s\n",
681 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
683 /* Don't wake anybody if the string looked bogus */
684 if (args->cbnl_valid)
685 __wake_up(&cps->clp->cl_lock_waitq, TASK_NORMAL, 0, args);
687 return htonl(NFS4_OK);
689 #endif /* CONFIG_NFS_V4_1 */
690 #ifdef CONFIG_NFS_V4_2
691 static void nfs4_copy_cb_args(struct nfs4_copy_state *cp_state,
692 struct cb_offloadargs *args)
694 cp_state->count = args->wr_count;
695 cp_state->error = args->error;
697 cp_state->verf.committed = args->wr_writeverf.committed;
698 memcpy(&cp_state->verf.verifier.data[0],
699 &args->wr_writeverf.verifier.data[0],
704 __be32 nfs4_callback_offload(void *data, void *dummy,
705 struct cb_process_state *cps)
707 struct cb_offloadargs *args = data;
708 struct nfs_server *server;
709 struct nfs4_copy_state *copy, *tmp_copy;
712 copy = kzalloc(sizeof(struct nfs4_copy_state), GFP_NOFS);
714 return htonl(NFS4ERR_SERVERFAULT);
716 spin_lock(&cps->clp->cl_lock);
718 list_for_each_entry_rcu(server, &cps->clp->cl_superblocks,
720 list_for_each_entry(tmp_copy, &server->ss_copies, copies) {
721 if (memcmp(args->coa_stateid.other,
722 tmp_copy->stateid.other,
723 sizeof(args->coa_stateid.other)))
725 nfs4_copy_cb_args(tmp_copy, args);
726 complete(&tmp_copy->completion);
734 memcpy(©->stateid, &args->coa_stateid, NFS4_STATEID_SIZE);
735 nfs4_copy_cb_args(copy, args);
736 list_add_tail(©->copies, &cps->clp->pending_cb_stateids);
739 spin_unlock(&cps->clp->cl_lock);
743 #endif /* CONFIG_NFS_V4_2 */