2 * linux/fs/nfs/callback_proc.c
4 * Copyright (C) 2004 Trond Myklebust
6 * NFSv4 callback procedures
8 #include <linux/nfs4.h>
9 #include <linux/nfs_fs.h>
10 #include <linux/slab.h>
11 #include <linux/rcupdate.h>
14 #include "delegation.h"
17 #include "nfs4session.h"
18 #include "nfs4trace.h"
21 #define NFSDBG_FACILITY NFSDBG_CALLBACK
24 __be32 nfs4_callback_getattr(struct cb_getattrargs *args,
25 struct cb_getattrres *res,
26 struct cb_process_state *cps)
28 struct nfs_delegation *delegation;
29 struct nfs_inode *nfsi;
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 */
36 res->bitmap[0] = res->bitmap[1] = 0;
37 res->status = htonl(NFS4ERR_BADHANDLE);
39 dprintk_rcu("NFS: GETATTR callback request from %s\n",
40 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
42 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
47 delegation = rcu_dereference(nfsi->delegation);
48 if (delegation == NULL || (delegation->type & FMODE_WRITE) == 0)
50 res->size = i_size_read(inode);
51 res->change_attr = delegation->change_attr;
52 if (nfsi->nrequests != 0)
54 res->ctime = inode->i_ctime;
55 res->mtime = inode->i_mtime;
56 res->bitmap[0] = (FATTR4_WORD0_CHANGE|FATTR4_WORD0_SIZE) &
58 res->bitmap[1] = (FATTR4_WORD1_TIME_METADATA|FATTR4_WORD1_TIME_MODIFY) &
65 dprintk("%s: exit with status = %d\n", __func__, ntohl(res->status));
69 __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
70 struct cb_process_state *cps)
75 res = htonl(NFS4ERR_OP_NOT_IN_SESSION);
76 if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
79 dprintk_rcu("NFS: RECALL callback request from %s\n",
80 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
82 res = htonl(NFS4ERR_BADHANDLE);
83 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
86 /* Set up a helper thread to actually return the delegation */
87 switch (nfs_async_inode_return_delegation(inode, &args->stateid)) {
92 res = htonl(NFS4ERR_BAD_STATEID);
95 res = htonl(NFS4ERR_RESOURCE);
97 trace_nfs4_recall_delegation(inode, -ntohl(res));
100 dprintk("%s: exit with status = %d\n", __func__, ntohl(res));
104 #if defined(CONFIG_NFS_V4_1)
107 * Lookup a layout by filehandle.
109 * Note: gets a refcount on the layout hdr and on its respective inode.
110 * Caller must put the layout hdr and the inode.
112 * TODO: keep track of all layouts (and delegations) in a hash table
113 * hashed by filehandle.
115 static struct pnfs_layout_hdr * get_layout_by_fh_locked(struct nfs_client *clp,
116 struct nfs_fh *fh, nfs4_stateid *stateid)
118 struct nfs_server *server;
120 struct pnfs_layout_hdr *lo;
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))
126 if (nfs_compare_fh(fh, &NFS_I(lo->plh_inode)->fh))
128 ino = igrab(lo->plh_inode);
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);
138 pnfs_get_layout_hdr(lo);
139 spin_unlock(&ino->i_lock);
147 static struct pnfs_layout_hdr * get_layout_by_fh(struct nfs_client *clp,
148 struct nfs_fh *fh, nfs4_stateid *stateid)
150 struct pnfs_layout_hdr *lo;
152 spin_lock(&clp->cl_lock);
154 lo = get_layout_by_fh_locked(clp, fh, stateid);
156 spin_unlock(&clp->cl_lock);
161 static u32 initiate_file_draining(struct nfs_client *clp,
162 struct cb_layoutrecallargs *args)
165 struct pnfs_layout_hdr *lo;
166 u32 rv = NFS4ERR_NOMATCHING_LAYOUT;
167 LIST_HEAD(free_me_list);
169 lo = get_layout_by_fh(clp, &args->cbl_fh, &args->cbl_stateid);
175 spin_lock(&ino->i_lock);
176 pnfs_set_layout_stateid(lo, &args->cbl_stateid, true);
177 spin_unlock(&ino->i_lock);
179 pnfs_layoutcommit_inode(ino, false);
181 spin_lock(&ino->i_lock);
182 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags) ||
183 pnfs_mark_matching_lsegs_invalid(lo, &free_me_list,
189 if (NFS_SERVER(ino)->pnfs_curr_ld->return_range) {
190 NFS_SERVER(ino)->pnfs_curr_ld->return_range(lo,
194 spin_unlock(&ino->i_lock);
195 pnfs_free_lseg_list(&free_me_list);
196 pnfs_put_layout_hdr(lo);
202 static u32 initiate_bulk_draining(struct nfs_client *clp,
203 struct cb_layoutrecallargs *args)
207 if (args->cbl_recall_type == RETURN_FSID)
208 stat = pnfs_destroy_layouts_byfsid(clp, &args->cbl_fsid, true);
210 stat = pnfs_destroy_layouts_byclid(clp, true);
212 return NFS4ERR_DELAY;
213 return NFS4ERR_NOMATCHING_LAYOUT;
216 static u32 do_callback_layoutrecall(struct nfs_client *clp,
217 struct cb_layoutrecallargs *args)
221 dprintk("%s enter, type=%i\n", __func__, args->cbl_recall_type);
222 if (args->cbl_recall_type == RETURN_FILE)
223 res = initiate_file_draining(clp, args);
225 res = initiate_bulk_draining(clp, args);
226 dprintk("%s returning %i\n", __func__, res);
231 __be32 nfs4_callback_layoutrecall(struct cb_layoutrecallargs *args,
232 void *dummy, struct cb_process_state *cps)
236 dprintk("%s: -->\n", __func__);
239 res = do_callback_layoutrecall(cps->clp, args);
241 res = NFS4ERR_OP_NOT_IN_SESSION;
243 dprintk("%s: exit with status = %d\n", __func__, res);
244 return cpu_to_be32(res);
247 static void pnfs_recall_all_layouts(struct nfs_client *clp)
249 struct cb_layoutrecallargs args;
251 /* Pretend we got a CB_LAYOUTRECALL(ALL) */
252 memset(&args, 0, sizeof(args));
253 args.cbl_recall_type = RETURN_ALL;
254 /* FIXME we ignore errors, what should we do? */
255 do_callback_layoutrecall(clp, &args);
258 __be32 nfs4_callback_devicenotify(struct cb_devicenotifyargs *args,
259 void *dummy, struct cb_process_state *cps)
263 struct nfs_client *clp = cps->clp;
264 struct nfs_server *server = NULL;
266 dprintk("%s: -->\n", __func__);
269 res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
273 for (i = 0; i < args->ndevs; i++) {
274 struct cb_devicenotifyitem *dev = &args->devs[i];
277 server->pnfs_curr_ld->id != dev->cbd_layout_type) {
279 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
280 if (server->pnfs_curr_ld &&
281 server->pnfs_curr_ld->id == dev->cbd_layout_type) {
286 dprintk("%s: layout type %u not found\n",
287 __func__, dev->cbd_layout_type);
292 nfs4_delete_deviceid(server->pnfs_curr_ld, clp, &dev->cbd_dev_id);
297 dprintk("%s: exit with status = %u\n",
298 __func__, be32_to_cpu(res));
303 * Validate the sequenceID sent by the server.
304 * Return success if the sequenceID is one more than what we last saw on
305 * this slot, accounting for wraparound. Increments the slot's sequence.
307 * We don't yet implement a duplicate request cache, instead we set the
308 * back channel ca_maxresponsesize_cached to zero. This is OK for now
309 * since we only currently implement idempotent callbacks anyway.
311 * We have a single slot backchannel at this time, so we don't bother
312 * checking the used_slots bit array on the table. The lower layer guarantees
313 * a single outstanding callback request at a time.
316 validate_seqid(struct nfs4_slot_table *tbl, struct cb_sequenceargs * args)
318 struct nfs4_slot *slot;
320 dprintk("%s enter. slotid %u seqid %u\n",
321 __func__, args->csa_slotid, args->csa_sequenceid);
323 if (args->csa_slotid >= NFS41_BC_MAX_CALLBACKS)
324 return htonl(NFS4ERR_BADSLOT);
326 slot = tbl->slots + args->csa_slotid;
327 dprintk("%s slot table seqid: %u\n", __func__, slot->seq_nr);
330 if (likely(args->csa_sequenceid == slot->seq_nr + 1)) {
336 if (args->csa_sequenceid == slot->seq_nr) {
337 dprintk("%s seqid %u is a replay\n",
338 __func__, args->csa_sequenceid);
339 /* Signal process_op to set this error on next op */
340 if (args->csa_cachethis == 0)
341 return htonl(NFS4ERR_RETRY_UNCACHED_REP);
343 /* The ca_maxresponsesize_cached is 0 with no DRC */
344 else if (args->csa_cachethis == 1)
345 return htonl(NFS4ERR_REP_TOO_BIG_TO_CACHE);
349 if (args->csa_sequenceid == 1 && (slot->seq_nr + 1) == 0) {
354 /* Misordered request */
355 return htonl(NFS4ERR_SEQ_MISORDERED);
357 tbl->highest_used_slotid = args->csa_slotid;
358 return htonl(NFS4_OK);
362 * For each referring call triple, check the session's slot table for
363 * a match. If the slot is in use and the sequence numbers match, the
364 * client is still waiting for a response to the original request.
366 static bool referring_call_exists(struct nfs_client *clp,
368 struct referring_call_list *rclists)
372 struct nfs4_session *session;
373 struct nfs4_slot_table *tbl;
374 struct referring_call_list *rclist;
375 struct referring_call *ref;
378 * XXX When client trunking is implemented, this becomes
379 * a session lookup from within the loop
381 session = clp->cl_session;
382 tbl = &session->fc_slot_table;
384 for (i = 0; i < nrclists; i++) {
385 rclist = &rclists[i];
386 if (memcmp(session->sess_id.data,
387 rclist->rcl_sessionid.data,
388 NFS4_MAX_SESSIONID_LEN) != 0)
391 for (j = 0; j < rclist->rcl_nrefcalls; j++) {
392 ref = &rclist->rcl_refcalls[j];
394 dprintk("%s: sessionid %x:%x:%x:%x sequenceid %u "
395 "slotid %u\n", __func__,
396 ((u32 *)&rclist->rcl_sessionid.data)[0],
397 ((u32 *)&rclist->rcl_sessionid.data)[1],
398 ((u32 *)&rclist->rcl_sessionid.data)[2],
399 ((u32 *)&rclist->rcl_sessionid.data)[3],
400 ref->rc_sequenceid, ref->rc_slotid);
402 spin_lock(&tbl->slot_tbl_lock);
403 status = (test_bit(ref->rc_slotid, tbl->used_slots) &&
404 tbl->slots[ref->rc_slotid].seq_nr ==
406 spin_unlock(&tbl->slot_tbl_lock);
416 __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
417 struct cb_sequenceres *res,
418 struct cb_process_state *cps)
420 struct nfs4_slot_table *tbl;
421 struct nfs_client *clp;
423 __be32 status = htonl(NFS4ERR_BADSESSION);
425 clp = nfs4_find_client_sessionid(cps->net, args->csa_addr,
426 &args->csa_sessionid, cps->minorversion);
430 tbl = &clp->cl_session->bc_slot_table;
432 spin_lock(&tbl->slot_tbl_lock);
433 /* state manager is resetting the session */
434 if (test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state)) {
435 spin_unlock(&tbl->slot_tbl_lock);
436 status = htonl(NFS4ERR_DELAY);
437 /* Return NFS4ERR_BADSESSION if we're draining the session
438 * in order to reset it.
440 if (test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
441 status = htonl(NFS4ERR_BADSESSION);
445 status = validate_seqid(&clp->cl_session->bc_slot_table, args);
446 spin_unlock(&tbl->slot_tbl_lock);
450 cps->slotid = args->csa_slotid;
453 * Check for pending referring calls. If a match is found, a
454 * related callback was received before the response to the original
457 if (referring_call_exists(clp, args->csa_nrclists, args->csa_rclists)) {
458 status = htonl(NFS4ERR_DELAY);
462 memcpy(&res->csr_sessionid, &args->csa_sessionid,
463 sizeof(res->csr_sessionid));
464 res->csr_sequenceid = args->csa_sequenceid;
465 res->csr_slotid = args->csa_slotid;
466 res->csr_highestslotid = NFS41_BC_MAX_CALLBACKS - 1;
467 res->csr_target_highestslotid = NFS41_BC_MAX_CALLBACKS - 1;
470 cps->clp = clp; /* put in nfs4_callback_compound */
471 for (i = 0; i < args->csa_nrclists; i++)
472 kfree(args->csa_rclists[i].rcl_refcalls);
473 kfree(args->csa_rclists);
475 if (status == htonl(NFS4ERR_RETRY_UNCACHED_REP)) {
476 cps->drc_status = status;
479 res->csr_status = status;
481 trace_nfs4_cb_sequence(args, res, status);
482 dprintk("%s: exit with status = %d res->csr_status %d\n", __func__,
483 ntohl(status), ntohl(res->csr_status));
488 validate_bitmap_values(unsigned long mask)
490 return (mask & ~RCA4_TYPE_MASK_ALL) == 0;
493 __be32 nfs4_callback_recallany(struct cb_recallanyargs *args, void *dummy,
494 struct cb_process_state *cps)
499 status = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
500 if (!cps->clp) /* set in cb_sequence */
503 dprintk_rcu("NFS: RECALL_ANY callback request from %s\n",
504 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
506 status = cpu_to_be32(NFS4ERR_INVAL);
507 if (!validate_bitmap_values(args->craa_type_mask))
510 status = cpu_to_be32(NFS4_OK);
511 if (test_bit(RCA4_TYPE_MASK_RDATA_DLG, (const unsigned long *)
512 &args->craa_type_mask))
514 if (test_bit(RCA4_TYPE_MASK_WDATA_DLG, (const unsigned long *)
515 &args->craa_type_mask))
516 flags |= FMODE_WRITE;
517 if (test_bit(RCA4_TYPE_MASK_FILE_LAYOUT, (const unsigned long *)
518 &args->craa_type_mask))
519 pnfs_recall_all_layouts(cps->clp);
521 nfs_expire_unused_delegation_types(cps->clp, flags);
523 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
527 /* Reduce the fore channel's max_slots to the target value */
528 __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args, void *dummy,
529 struct cb_process_state *cps)
531 struct nfs4_slot_table *fc_tbl;
534 status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
535 if (!cps->clp) /* set in cb_sequence */
538 dprintk_rcu("NFS: CB_RECALL_SLOT request from %s target highest slotid %u\n",
539 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR),
540 args->crsa_target_highest_slotid);
542 fc_tbl = &cps->clp->cl_session->fc_slot_table;
544 status = htonl(NFS4_OK);
546 nfs41_set_target_slotid(fc_tbl, args->crsa_target_highest_slotid);
547 nfs41_server_notify_target_slotid_update(cps->clp);
549 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
552 #endif /* CONFIG_NFS_V4_1 */