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 inode *inode;
30
31 res->status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
32 if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
33 goto out;
34
35 res->bitmap[0] = res->bitmap[1] = 0;
36 res->status = htonl(NFS4ERR_BADHANDLE);
37
38 dprintk_rcu("NFS: GETATTR callback request from %s\n",
39 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
40
41 inode = nfs_delegation_find_inode(cps->clp, &args->fh);
42 if (IS_ERR(inode)) {
43 if (inode == ERR_PTR(-EAGAIN))
44 res->status = htonl(NFS4ERR_DELAY);
45 trace_nfs4_cb_getattr(cps->clp, &args->fh, NULL,
46 -ntohl(res->status));
47 goto out;
48 }
49 rcu_read_lock();
50 delegation = nfs4_get_valid_delegation(inode);
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 nfs_iput_and_deactive(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 (IS_ERR(inode)) {
90 if (inode == ERR_PTR(-EAGAIN))
91 res = htonl(NFS4ERR_DELAY);
92 trace_nfs4_cb_recall(cps->clp, &args->fh, NULL,
93 &args->stateid, -ntohl(res));
94 goto out;
95 }
96 /* Set up a helper thread to actually return the delegation */
97 switch (nfs_async_inode_return_delegation(inode, &args->stateid)) {
98 case 0:
99 res = 0;
100 break;
101 case -ENOENT:
102 res = htonl(NFS4ERR_BAD_STATEID);
103 break;
104 default:
105 res = htonl(NFS4ERR_RESOURCE);
106 }
107 trace_nfs4_cb_recall(cps->clp, &args->fh, inode,
108 &args->stateid, -ntohl(res));
109 nfs_iput_and_deactive(inode);
110out:
111 dprintk("%s: exit with status = %d\n", __func__, ntohl(res));
112 return res;
113}
114
115#if defined(CONFIG_NFS_V4_1)
116
117/*
118 * Lookup a layout inode by stateid
119 *
120 * Note: returns a refcount on the inode and superblock
121 */
122static struct inode *nfs_layout_find_inode_by_stateid(struct nfs_client *clp,
123 const nfs4_stateid *stateid)
124 __must_hold(RCU)
125{
126 struct nfs_server *server;
127 struct inode *inode;
128 struct pnfs_layout_hdr *lo;
129
130 rcu_read_lock();
131 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
132 list_for_each_entry_rcu(lo, &server->layouts, plh_layouts) {
133 if (!pnfs_layout_is_valid(lo))
134 continue;
135 if (stateid != NULL &&
136 !nfs4_stateid_match_other(stateid, &lo->plh_stateid))
137 continue;
138 if (!nfs_sb_active(server->super))
139 continue;
140 inode = igrab(lo->plh_inode);
141 rcu_read_unlock();
142 if (inode)
143 return inode;
144 nfs_sb_deactive(server->super);
145 return ERR_PTR(-EAGAIN);
146 }
147 }
148 rcu_read_unlock();
149 return ERR_PTR(-ENOENT);
150}
151
152/*
153 * Lookup a layout inode by filehandle.
154 *
155 * Note: returns a refcount on the inode and superblock
156 *
157 */
158static struct inode *nfs_layout_find_inode_by_fh(struct nfs_client *clp,
159 const struct nfs_fh *fh)
160{
161 struct nfs_server *server;
162 struct nfs_inode *nfsi;
163 struct inode *inode;
164 struct pnfs_layout_hdr *lo;
165
166 rcu_read_lock();
167 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
168 list_for_each_entry_rcu(lo, &server->layouts, plh_layouts) {
169 nfsi = NFS_I(lo->plh_inode);
170 if (nfs_compare_fh(fh, &nfsi->fh))
171 continue;
172 if (nfsi->layout != lo)
173 continue;
174 if (!nfs_sb_active(server->super))
175 continue;
176 inode = igrab(lo->plh_inode);
177 rcu_read_unlock();
178 if (inode)
179 return inode;
180 nfs_sb_deactive(server->super);
181 return ERR_PTR(-EAGAIN);
182 }
183 }
184 rcu_read_unlock();
185 return ERR_PTR(-ENOENT);
186}
187
188static struct inode *nfs_layout_find_inode(struct nfs_client *clp,
189 const struct nfs_fh *fh,
190 const nfs4_stateid *stateid)
191{
192 struct inode *inode;
193
194 inode = nfs_layout_find_inode_by_stateid(clp, stateid);
195 if (inode == ERR_PTR(-ENOENT))
196 inode = nfs_layout_find_inode_by_fh(clp, fh);
197 return inode;
198}
199
200/*
201 * Enforce RFC5661 section 12.5.5.2.1. (Layout Recall and Return Sequencing)
202 */
203static u32 pnfs_check_callback_stateid(struct pnfs_layout_hdr *lo,
204 const nfs4_stateid *new)
205{
206 u32 oldseq, newseq;
207
208 /* Is the stateid not initialised? */
209 if (!pnfs_layout_is_valid(lo))
210 return NFS4ERR_NOMATCHING_LAYOUT;
211
212 /* Mismatched stateid? */
213 if (!nfs4_stateid_match_other(&lo->plh_stateid, new))
214 return NFS4ERR_BAD_STATEID;
215
216 newseq = be32_to_cpu(new->seqid);
217 /* Are we already in a layout recall situation? */
218 if (test_bit(NFS_LAYOUT_RETURN_REQUESTED, &lo->plh_flags) &&
219 lo->plh_return_seq != 0) {
220 if (newseq < lo->plh_return_seq)
221 return NFS4ERR_OLD_STATEID;
222 if (newseq > lo->plh_return_seq)
223 return NFS4ERR_DELAY;
224 goto out;
225 }
226
227 /* Check that the stateid matches what we think it should be. */
228 oldseq = be32_to_cpu(lo->plh_stateid.seqid);
229 if (newseq > oldseq + 1)
230 return NFS4ERR_DELAY;
231 /* Crazy server! */
232 if (newseq <= oldseq)
233 return NFS4ERR_OLD_STATEID;
234out:
235 return NFS_OK;
236}
237
238static u32 initiate_file_draining(struct nfs_client *clp,
239 struct cb_layoutrecallargs *args)
240{
241 struct inode *ino;
242 struct pnfs_layout_hdr *lo;
243 u32 rv = NFS4ERR_NOMATCHING_LAYOUT;
244 LIST_HEAD(free_me_list);
245
246 ino = nfs_layout_find_inode(clp, &args->cbl_fh, &args->cbl_stateid);
247 if (IS_ERR(ino)) {
248 if (ino == ERR_PTR(-EAGAIN))
249 rv = NFS4ERR_DELAY;
250 goto out_noput;
251 }
252
253 pnfs_layoutcommit_inode(ino, false);
254
255
256 spin_lock(&ino->i_lock);
257 lo = NFS_I(ino)->layout;
258 if (!lo) {
259 spin_unlock(&ino->i_lock);
260 goto out;
261 }
262 pnfs_get_layout_hdr(lo);
263 rv = pnfs_check_callback_stateid(lo, &args->cbl_stateid);
264 if (rv != NFS_OK)
265 goto unlock;
266
267 /*
268 * Enforce RFC5661 Section 12.5.5.2.1.5 (Bulk Recall and Return)
269 */
270 if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
271 rv = NFS4ERR_DELAY;
272 goto unlock;
273 }
274
275 pnfs_set_layout_stateid(lo, &args->cbl_stateid, NULL, true);
276 switch (pnfs_mark_matching_lsegs_return(lo, &free_me_list,
277 &args->cbl_range,
278 be32_to_cpu(args->cbl_stateid.seqid))) {
279 case 0:
280 case -EBUSY:
281 /* There are layout segments that need to be returned */
282 rv = NFS4_OK;
283 break;
284 case -ENOENT:
285 /* Embrace your forgetfulness! */
286 rv = NFS4ERR_NOMATCHING_LAYOUT;
287
288 if (NFS_SERVER(ino)->pnfs_curr_ld->return_range) {
289 NFS_SERVER(ino)->pnfs_curr_ld->return_range(lo,
290 &args->cbl_range);
291 }
292 }
293unlock:
294 spin_unlock(&ino->i_lock);
295 pnfs_free_lseg_list(&free_me_list);
296 /* Free all lsegs that are attached to commit buckets */
297 nfs_commit_inode(ino, 0);
298 pnfs_put_layout_hdr(lo);
299out:
300 nfs_iput_and_deactive(ino);
301out_noput:
302 trace_nfs4_cb_layoutrecall_file(clp, &args->cbl_fh, ino,
303 &args->cbl_stateid, -rv);
304 return rv;
305}
306
307static u32 initiate_bulk_draining(struct nfs_client *clp,
308 struct cb_layoutrecallargs *args)
309{
310 int stat;
311
312 if (args->cbl_recall_type == RETURN_FSID)
313 stat = pnfs_destroy_layouts_byfsid(clp, &args->cbl_fsid, true);
314 else
315 stat = pnfs_destroy_layouts_byclid(clp, true);
316 if (stat != 0)
317 return NFS4ERR_DELAY;
318 return NFS4ERR_NOMATCHING_LAYOUT;
319}
320
321static u32 do_callback_layoutrecall(struct nfs_client *clp,
322 struct cb_layoutrecallargs *args)
323{
324 if (args->cbl_recall_type == RETURN_FILE)
325 return initiate_file_draining(clp, args);
326 return initiate_bulk_draining(clp, args);
327}
328
329__be32 nfs4_callback_layoutrecall(void *argp, void *resp,
330 struct cb_process_state *cps)
331{
332 struct cb_layoutrecallargs *args = argp;
333 u32 res = NFS4ERR_OP_NOT_IN_SESSION;
334
335 if (cps->clp)
336 res = do_callback_layoutrecall(cps->clp, args);
337 return cpu_to_be32(res);
338}
339
340static void pnfs_recall_all_layouts(struct nfs_client *clp)
341{
342 struct cb_layoutrecallargs args;
343
344 /* Pretend we got a CB_LAYOUTRECALL(ALL) */
345 memset(&args, 0, sizeof(args));
346 args.cbl_recall_type = RETURN_ALL;
347 /* FIXME we ignore errors, what should we do? */
348 do_callback_layoutrecall(clp, &args);
349}
350
351__be32 nfs4_callback_devicenotify(void *argp, void *resp,
352 struct cb_process_state *cps)
353{
354 struct cb_devicenotifyargs *args = argp;
355 int i;
356 __be32 res = 0;
357 struct nfs_client *clp = cps->clp;
358 struct nfs_server *server = NULL;
359
360 if (!clp) {
361 res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
362 goto out;
363 }
364
365 for (i = 0; i < args->ndevs; i++) {
366 struct cb_devicenotifyitem *dev = &args->devs[i];
367
368 if (!server ||
369 server->pnfs_curr_ld->id != dev->cbd_layout_type) {
370 rcu_read_lock();
371 list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
372 if (server->pnfs_curr_ld &&
373 server->pnfs_curr_ld->id == dev->cbd_layout_type) {
374 rcu_read_unlock();
375 goto found;
376 }
377 rcu_read_unlock();
378 continue;
379 }
380
381 found:
382 nfs4_delete_deviceid(server->pnfs_curr_ld, clp, &dev->cbd_dev_id);
383 }
384
385out:
386 kfree(args->devs);
387 return res;
388}
389
390/*
391 * Validate the sequenceID sent by the server.
392 * Return success if the sequenceID is one more than what we last saw on
393 * this slot, accounting for wraparound. Increments the slot's sequence.
394 *
395 * We don't yet implement a duplicate request cache, instead we set the
396 * back channel ca_maxresponsesize_cached to zero. This is OK for now
397 * since we only currently implement idempotent callbacks anyway.
398 *
399 * We have a single slot backchannel at this time, so we don't bother
400 * checking the used_slots bit array on the table. The lower layer guarantees
401 * a single outstanding callback request at a time.
402 */
403static __be32
404validate_seqid(const struct nfs4_slot_table *tbl, const struct nfs4_slot *slot,
405 const struct cb_sequenceargs * args)
406{
407 __be32 ret;
408
409 ret = cpu_to_be32(NFS4ERR_BADSLOT);
410 if (args->csa_slotid > tbl->server_highest_slotid)
411 goto out_err;
412
413 /* Replay */
414 if (args->csa_sequenceid == slot->seq_nr) {
415 ret = cpu_to_be32(NFS4ERR_DELAY);
416 if (nfs4_test_locked_slot(tbl, slot->slot_nr))
417 goto out_err;
418
419 /* Signal process_op to set this error on next op */
420 ret = cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP);
421 if (args->csa_cachethis == 0)
422 goto out_err;
423
424 /* Liar! We never allowed you to set csa_cachethis != 0 */
425 ret = cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY);
426 goto out_err;
427 }
428
429 /* Note: wraparound relies on seq_nr being of type u32 */
430 /* Misordered request */
431 ret = cpu_to_be32(NFS4ERR_SEQ_MISORDERED);
432 if (args->csa_sequenceid != slot->seq_nr + 1)
433 goto out_err;
434
435 return cpu_to_be32(NFS4_OK);
436
437out_err:
438 trace_nfs4_cb_seqid_err(args, ret);
439 return ret;
440}
441
442/*
443 * For each referring call triple, check the session's slot table for
444 * a match. If the slot is in use and the sequence numbers match, the
445 * client is still waiting for a response to the original request.
446 */
447static int referring_call_exists(struct nfs_client *clp,
448 uint32_t nrclists,
449 struct referring_call_list *rclists,
450 spinlock_t *lock)
451 __releases(lock)
452 __acquires(lock)
453{
454 int status = 0;
455 int i, j;
456 struct nfs4_session *session;
457 struct nfs4_slot_table *tbl;
458 struct referring_call_list *rclist;
459 struct referring_call *ref;
460
461 /*
462 * XXX When client trunking is implemented, this becomes
463 * a session lookup from within the loop
464 */
465 session = clp->cl_session;
466 tbl = &session->fc_slot_table;
467
468 for (i = 0; i < nrclists; i++) {
469 rclist = &rclists[i];
470 if (memcmp(session->sess_id.data,
471 rclist->rcl_sessionid.data,
472 NFS4_MAX_SESSIONID_LEN) != 0)
473 continue;
474
475 for (j = 0; j < rclist->rcl_nrefcalls; j++) {
476 ref = &rclist->rcl_refcalls[j];
477 spin_unlock(lock);
478 status = nfs4_slot_wait_on_seqid(tbl, ref->rc_slotid,
479 ref->rc_sequenceid, HZ >> 1) < 0;
480 spin_lock(lock);
481 if (status)
482 goto out;
483 }
484 }
485
486out:
487 return status;
488}
489
490__be32 nfs4_callback_sequence(void *argp, void *resp,
491 struct cb_process_state *cps)
492{
493 struct cb_sequenceargs *args = argp;
494 struct cb_sequenceres *res = resp;
495 struct nfs4_slot_table *tbl;
496 struct nfs4_slot *slot;
497 struct nfs_client *clp;
498 int i;
499 __be32 status = htonl(NFS4ERR_BADSESSION);
500
501 clp = nfs4_find_client_sessionid(cps->net, args->csa_addr,
502 &args->csa_sessionid, cps->minorversion);
503 if (clp == NULL)
504 goto out;
505
506 if (!(clp->cl_session->flags & SESSION4_BACK_CHAN))
507 goto out;
508
509 tbl = &clp->cl_session->bc_slot_table;
510
511 /* Set up res before grabbing the spinlock */
512 memcpy(&res->csr_sessionid, &args->csa_sessionid,
513 sizeof(res->csr_sessionid));
514 res->csr_sequenceid = args->csa_sequenceid;
515 res->csr_slotid = args->csa_slotid;
516
517 spin_lock(&tbl->slot_tbl_lock);
518 /* state manager is resetting the session */
519 if (test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state)) {
520 status = htonl(NFS4ERR_DELAY);
521 /* Return NFS4ERR_BADSESSION if we're draining the session
522 * in order to reset it.
523 */
524 if (test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
525 status = htonl(NFS4ERR_BADSESSION);
526 goto out_unlock;
527 }
528
529 status = htonl(NFS4ERR_BADSLOT);
530 slot = nfs4_lookup_slot(tbl, args->csa_slotid);
531 if (IS_ERR(slot))
532 goto out_unlock;
533
534 res->csr_highestslotid = tbl->server_highest_slotid;
535 res->csr_target_highestslotid = tbl->target_highest_slotid;
536
537 status = validate_seqid(tbl, slot, args);
538 if (status)
539 goto out_unlock;
540 if (!nfs4_try_to_lock_slot(tbl, slot)) {
541 status = htonl(NFS4ERR_DELAY);
542 goto out_unlock;
543 }
544 cps->slot = slot;
545
546 /* The ca_maxresponsesize_cached is 0 with no DRC */
547 if (args->csa_cachethis != 0) {
548 status = htonl(NFS4ERR_REP_TOO_BIG_TO_CACHE);
549 goto out_unlock;
550 }
551
552 /*
553 * Check for pending referring calls. If a match is found, a
554 * related callback was received before the response to the original
555 * call.
556 */
557 if (referring_call_exists(clp, args->csa_nrclists, args->csa_rclists,
558 &tbl->slot_tbl_lock) < 0) {
559 status = htonl(NFS4ERR_DELAY);
560 goto out_unlock;
561 }
562
563 /*
564 * RFC5661 20.9.3
565 * If CB_SEQUENCE returns an error, then the state of the slot
566 * (sequence ID, cached reply) MUST NOT change.
567 */
568 slot->seq_nr = args->csa_sequenceid;
569out_unlock:
570 spin_unlock(&tbl->slot_tbl_lock);
571
572out:
573 cps->clp = clp; /* put in nfs4_callback_compound */
574 for (i = 0; i < args->csa_nrclists; i++)
575 kfree(args->csa_rclists[i].rcl_refcalls);
576 kfree(args->csa_rclists);
577
578 if (status == htonl(NFS4ERR_RETRY_UNCACHED_REP)) {
579 cps->drc_status = status;
580 status = 0;
581 } else
582 res->csr_status = status;
583
584 trace_nfs4_cb_sequence(args, res, status);
585 return status;
586}
587
588static bool
589validate_bitmap_values(unsigned int mask)
590{
591 return (mask & ~RCA4_TYPE_MASK_ALL) == 0;
592}
593
594__be32 nfs4_callback_recallany(void *argp, void *resp,
595 struct cb_process_state *cps)
596{
597 struct cb_recallanyargs *args = argp;
598 __be32 status;
599 fmode_t flags = 0;
600 bool schedule_manager = false;
601
602 status = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
603 if (!cps->clp) /* set in cb_sequence */
604 goto out;
605
606 dprintk_rcu("NFS: RECALL_ANY callback request from %s\n",
607 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
608
609 status = cpu_to_be32(NFS4ERR_INVAL);
610 if (!validate_bitmap_values(args->craa_type_mask))
611 goto out;
612
613 status = cpu_to_be32(NFS4_OK);
614 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_RDATA_DLG))
615 flags = FMODE_READ;
616 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_WDATA_DLG))
617 flags |= FMODE_WRITE;
618 if (flags)
619 nfs_expire_unused_delegation_types(cps->clp, flags);
620
621 if (args->craa_type_mask & BIT(RCA4_TYPE_MASK_FILE_LAYOUT))
622 pnfs_recall_all_layouts(cps->clp);
623
624 if (args->craa_type_mask & BIT(PNFS_FF_RCA4_TYPE_MASK_READ)) {
625 set_bit(NFS4CLNT_RECALL_ANY_LAYOUT_READ, &cps->clp->cl_state);
626 schedule_manager = true;
627 }
628 if (args->craa_type_mask & BIT(PNFS_FF_RCA4_TYPE_MASK_RW)) {
629 set_bit(NFS4CLNT_RECALL_ANY_LAYOUT_RW, &cps->clp->cl_state);
630 schedule_manager = true;
631 }
632 if (schedule_manager)
633 nfs4_schedule_state_manager(cps->clp);
634
635out:
636 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
637 return status;
638}
639
640/* Reduce the fore channel's max_slots to the target value */
641__be32 nfs4_callback_recallslot(void *argp, void *resp,
642 struct cb_process_state *cps)
643{
644 struct cb_recallslotargs *args = argp;
645 struct nfs4_slot_table *fc_tbl;
646 __be32 status;
647
648 status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
649 if (!cps->clp) /* set in cb_sequence */
650 goto out;
651
652 dprintk_rcu("NFS: CB_RECALL_SLOT request from %s target highest slotid %u\n",
653 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR),
654 args->crsa_target_highest_slotid);
655
656 fc_tbl = &cps->clp->cl_session->fc_slot_table;
657
658 status = htonl(NFS4_OK);
659
660 nfs41_set_target_slotid(fc_tbl, args->crsa_target_highest_slotid);
661 nfs41_notify_server(cps->clp);
662out:
663 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
664 return status;
665}
666
667__be32 nfs4_callback_notify_lock(void *argp, void *resp,
668 struct cb_process_state *cps)
669{
670 struct cb_notify_lock_args *args = argp;
671
672 if (!cps->clp) /* set in cb_sequence */
673 return htonl(NFS4ERR_OP_NOT_IN_SESSION);
674
675 dprintk_rcu("NFS: CB_NOTIFY_LOCK request from %s\n",
676 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
677
678 /* Don't wake anybody if the string looked bogus */
679 if (args->cbnl_valid)
680 __wake_up(&cps->clp->cl_lock_waitq, TASK_NORMAL, 0, args);
681
682 return htonl(NFS4_OK);
683}
684#endif /* CONFIG_NFS_V4_1 */
685#ifdef CONFIG_NFS_V4_2
686static void nfs4_copy_cb_args(struct nfs4_copy_state *cp_state,
687 struct cb_offloadargs *args)
688{
689 cp_state->count = args->wr_count;
690 cp_state->error = args->error;
691 if (!args->error) {
692 cp_state->verf.committed = args->wr_writeverf.committed;
693 memcpy(&cp_state->verf.verifier.data[0],
694 &args->wr_writeverf.verifier.data[0],
695 NFS4_VERIFIER_SIZE);
696 }
697}
698
699__be32 nfs4_callback_offload(void *data, void *dummy,
700 struct cb_process_state *cps)
701{
702 struct cb_offloadargs *args = data;
703 struct nfs_server *server;
704 struct nfs4_copy_state *copy, *tmp_copy;
705 bool found = false;
706
707 copy = kzalloc(sizeof(struct nfs4_copy_state), GFP_NOFS);
708 if (!copy)
709 return htonl(NFS4ERR_SERVERFAULT);
710
711 spin_lock(&cps->clp->cl_lock);
712 rcu_read_lock();
713 list_for_each_entry_rcu(server, &cps->clp->cl_superblocks,
714 client_link) {
715 list_for_each_entry(tmp_copy, &server->ss_copies, copies) {
716 if (memcmp(args->coa_stateid.other,
717 tmp_copy->stateid.other,
718 sizeof(args->coa_stateid.other)))
719 continue;
720 nfs4_copy_cb_args(tmp_copy, args);
721 complete(&tmp_copy->completion);
722 found = true;
723 goto out;
724 }
725 }
726out:
727 rcu_read_unlock();
728 if (!found) {
729 memcpy(©->stateid, &args->coa_stateid, NFS4_STATEID_SIZE);
730 nfs4_copy_cb_args(copy, args);
731 list_add_tail(©->copies, &cps->clp->pending_cb_stateids);
732 } else
733 kfree(copy);
734 spin_unlock(&cps->clp->cl_lock);
735
736 return 0;
737}
738#endif /* CONFIG_NFS_V4_2 */
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 */