fs/nfs/callback_proc.c

   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                 trace_nfs4_cb_getattr(cps->clp, &args->fh, inode,
  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 (nfsi->nrequests != 0)
  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;
  64 out_iput:
  65         rcu_read_unlock();
  66         trace_nfs4_cb_getattr(cps->clp, &args->fh, inode, -ntohl(res->status));
  67         iput(inode);
  68 out:
  69         dprintk("%s: exit with status = %d\n", __func__, ntohl(res->status));
  70         return res->status;
  71 }
  72
  73 __be32 nfs4_callback_recall(struct cb_recallargs *args, void *dummy,
  74                             struct cb_process_state *cps)
  75 {
  76         struct inode *inode;
  77         __be32 res;
  78
  79         res = htonl(NFS4ERR_OP_NOT_IN_SESSION);
  80         if (!cps->clp) /* Always set for v4.0. Set in cb_sequence for v4.1 */
  81                 goto out;
  82
  83         dprintk_rcu("NFS: RECALL callback request from %s\n",
  84                 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
  85
  86         res = htonl(NFS4ERR_BADHANDLE);
  87         inode = nfs_delegation_find_inode(cps->clp, &args->fh);
  88         if (inode == NULL)
  89                 goto out;
  90         /* Set up a helper thread to actually return the delegation */
  91         switch (nfs_async_inode_return_delegation(inode, &args->stateid)) {
  92         case 0:
  93                 res = 0;
  94                 break;
  95         case -ENOENT:
  96                 res = htonl(NFS4ERR_BAD_STATEID);
  97                 break;
  98         default:
  99                 res = htonl(NFS4ERR_RESOURCE);
 100         }
 101         trace_nfs4_recall_delegation(inode, -ntohl(res));
 102         iput(inode);
 103 out:
 104         dprintk("%s: exit with status = %d\n", __func__, ntohl(res));
 105         return res;
 106 }
 107
 108 #if defined(CONFIG_NFS_V4_1)
 109
 110 /*
 111  * Lookup a layout by filehandle.
 112  *
 113  * Note: gets a refcount on the layout hdr and on its respective inode.
 114  * Caller must put the layout hdr and the inode.
 115  *
 116  * TODO: keep track of all layouts (and delegations) in a hash table
 117  * hashed by filehandle.
 118  */
 119 static struct pnfs_layout_hdr * get_layout_by_fh_locked(struct nfs_client *clp,
 120                 struct nfs_fh *fh, nfs4_stateid *stateid)
 121 {
 122         struct nfs_server *server;
 123         struct inode *ino;
 124         struct pnfs_layout_hdr *lo;
 125
 126         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
 127                 list_for_each_entry(lo, &server->layouts, plh_layouts) {
 128                         if (!nfs4_stateid_match_other(&lo->plh_stateid, stateid))
 129                                 continue;
 130                         if (nfs_compare_fh(fh, &NFS_I(lo->plh_inode)->fh))
 131                                 continue;
 132                         ino = igrab(lo->plh_inode);
 133                         if (!ino)
 134                                 break;
 135                         spin_lock(&ino->i_lock);
 136                         /* Is this layout in the process of being freed? */
 137                         if (NFS_I(ino)->layout != lo) {
 138                                 spin_unlock(&ino->i_lock);
 139                                 iput(ino);
 140                                 break;
 141                         }
 142                         pnfs_get_layout_hdr(lo);
 143                         spin_unlock(&ino->i_lock);
 144                         return lo;
 145                 }
 146         }
 147
 148         return NULL;
 149 }
 150
 151 static struct pnfs_layout_hdr * get_layout_by_fh(struct nfs_client *clp,
 152                 struct nfs_fh *fh, nfs4_stateid *stateid)
 153 {
 154         struct pnfs_layout_hdr *lo;
 155
 156         spin_lock(&clp->cl_lock);
 157         rcu_read_lock();
 158         lo = get_layout_by_fh_locked(clp, fh, stateid);
 159         rcu_read_unlock();
 160         spin_unlock(&clp->cl_lock);
 161
 162         return lo;
 163 }
 164
 165 static u32 initiate_file_draining(struct nfs_client *clp,
 166                                   struct cb_layoutrecallargs *args)
 167 {
 168         struct inode *ino;
 169         struct pnfs_layout_hdr *lo;
 170         u32 rv = NFS4ERR_NOMATCHING_LAYOUT;
 171         LIST_HEAD(free_me_list);
 172
 173         lo = get_layout_by_fh(clp, &args->cbl_fh, &args->cbl_stateid);
 174         if (!lo)
 175                 goto out;
 176
 177         ino = lo->plh_inode;
 178
 179         spin_lock(&ino->i_lock);
 180         pnfs_set_layout_stateid(lo, &args->cbl_stateid, true);
 181         spin_unlock(&ino->i_lock);
 182
 183         pnfs_layoutcommit_inode(ino, false);
 184
 185         spin_lock(&ino->i_lock);
 186         if (test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags) ||
 187             pnfs_mark_matching_lsegs_invalid(lo, &free_me_list,
 188                                         &args->cbl_range)) {
 189                 rv = NFS4ERR_DELAY;
 190                 goto unlock;
 191         }
 192
 193         if (NFS_SERVER(ino)->pnfs_curr_ld->return_range) {
 194                 NFS_SERVER(ino)->pnfs_curr_ld->return_range(lo,
 195                         &args->cbl_range);
 196         }
 197 unlock:
 198         spin_unlock(&ino->i_lock);
 199         pnfs_free_lseg_list(&free_me_list);
 200         pnfs_put_layout_hdr(lo);
 201         iput(ino);
 202 out:
 203         return rv;
 204 }
 205
 206 static u32 initiate_bulk_draining(struct nfs_client *clp,
 207                                   struct cb_layoutrecallargs *args)
 208 {
 209         int stat;
 210
 211         if (args->cbl_recall_type == RETURN_FSID)
 212                 stat = pnfs_destroy_layouts_byfsid(clp, &args->cbl_fsid, true);
 213         else
 214                 stat = pnfs_destroy_layouts_byclid(clp, true);
 215         if (stat != 0)
 216                 return NFS4ERR_DELAY;
 217         return NFS4ERR_NOMATCHING_LAYOUT;
 218 }
 219
 220 static u32 do_callback_layoutrecall(struct nfs_client *clp,
 221                                     struct cb_layoutrecallargs *args)
 222 {
 223         u32 res;
 224
 225         dprintk("%s enter, type=%i\n", __func__, args->cbl_recall_type);
 226         if (args->cbl_recall_type == RETURN_FILE)
 227                 res = initiate_file_draining(clp, args);
 228         else
 229                 res = initiate_bulk_draining(clp, args);
 230         dprintk("%s returning %i\n", __func__, res);
 231         return res;
 232
 233 }
 234
 235 __be32 nfs4_callback_layoutrecall(struct cb_layoutrecallargs *args,
 236                                   void *dummy, struct cb_process_state *cps)
 237 {
 238         u32 res;
 239
 240         dprintk("%s: -->\n", __func__);
 241
 242         if (cps->clp)
 243                 res = do_callback_layoutrecall(cps->clp, args);
 244         else
 245                 res = NFS4ERR_OP_NOT_IN_SESSION;
 246
 247         dprintk("%s: exit with status = %d\n", __func__, res);
 248         return cpu_to_be32(res);
 249 }
 250
 251 static void pnfs_recall_all_layouts(struct nfs_client *clp)
 252 {
 253         struct cb_layoutrecallargs args;
 254
 255         /* Pretend we got a CB_LAYOUTRECALL(ALL) */
 256         memset(&args, 0, sizeof(args));
 257         args.cbl_recall_type = RETURN_ALL;
 258         /* FIXME we ignore errors, what should we do? */
 259         do_callback_layoutrecall(clp, &args);
 260 }
 261
 262 __be32 nfs4_callback_devicenotify(struct cb_devicenotifyargs *args,
 263                                   void *dummy, struct cb_process_state *cps)
 264 {
 265         int i;
 266         __be32 res = 0;
 267         struct nfs_client *clp = cps->clp;
 268         struct nfs_server *server = NULL;
 269
 270         dprintk("%s: -->\n", __func__);
 271
 272         if (!clp) {
 273                 res = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
 274                 goto out;
 275         }
 276
 277         for (i = 0; i < args->ndevs; i++) {
 278                 struct cb_devicenotifyitem *dev = &args->devs[i];
 279
 280                 if (!server ||
 281                     server->pnfs_curr_ld->id != dev->cbd_layout_type) {
 282                         rcu_read_lock();
 283                         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
 284                                 if (server->pnfs_curr_ld &&
 285                                     server->pnfs_curr_ld->id == dev->cbd_layout_type) {
 286                                         rcu_read_unlock();
 287                                         goto found;
 288                                 }
 289                         rcu_read_unlock();
 290                         dprintk("%s: layout type %u not found\n",
 291                                 __func__, dev->cbd_layout_type);
 292                         continue;
 293                 }
 294
 295         found:
 296                 nfs4_delete_deviceid(server->pnfs_curr_ld, clp, &dev->cbd_dev_id);
 297         }
 298
 299 out:
 300         kfree(args->devs);
 301         dprintk("%s: exit with status = %u\n",
 302                 __func__, be32_to_cpu(res));
 303         return res;
 304 }
 305
 306 /*
 307  * Validate the sequenceID sent by the server.
 308  * Return success if the sequenceID is one more than what we last saw on
 309  * this slot, accounting for wraparound.  Increments the slot's sequence.
 310  *
 311  * We don't yet implement a duplicate request cache, instead we set the
 312  * back channel ca_maxresponsesize_cached to zero. This is OK for now
 313  * since we only currently implement idempotent callbacks anyway.
 314  *
 315  * We have a single slot backchannel at this time, so we don't bother
 316  * checking the used_slots bit array on the table.  The lower layer guarantees
 317  * a single outstanding callback request at a time.
 318  */
 319 static __be32
 320 validate_seqid(struct nfs4_slot_table *tbl, struct cb_sequenceargs * args)
 321 {
 322         struct nfs4_slot *slot;
 323
 324         dprintk("%s enter. slotid %u seqid %u\n",
 325                 __func__, args->csa_slotid, args->csa_sequenceid);
 326
 327         if (args->csa_slotid >= NFS41_BC_MAX_CALLBACKS)
 328                 return htonl(NFS4ERR_BADSLOT);
 329
 330         slot = tbl->slots + args->csa_slotid;
 331         dprintk("%s slot table seqid: %u\n", __func__, slot->seq_nr);
 332
 333         /* Normal */
 334         if (likely(args->csa_sequenceid == slot->seq_nr + 1))
 335                 goto out_ok;
 336
 337         /* Replay */
 338         if (args->csa_sequenceid == slot->seq_nr) {
 339                 dprintk("%s seqid %u is a replay\n",
 340                         __func__, args->csa_sequenceid);
 341                 /* Signal process_op to set this error on next op */
 342                 if (args->csa_cachethis == 0)
 343                         return htonl(NFS4ERR_RETRY_UNCACHED_REP);
 344
 345                 /* The ca_maxresponsesize_cached is 0 with no DRC */
 346                 else if (args->csa_cachethis == 1)
 347                         return htonl(NFS4ERR_REP_TOO_BIG_TO_CACHE);
 348         }
 349
 350         /* Wraparound */
 351         if (args->csa_sequenceid == 1 && (slot->seq_nr + 1) == 0) {
 352                 slot->seq_nr = 1;
 353                 goto out_ok;
 354         }
 355
 356         /* Misordered request */
 357         return htonl(NFS4ERR_SEQ_MISORDERED);
 358 out_ok:
 359         tbl->highest_used_slotid = args->csa_slotid;
 360         return htonl(NFS4_OK);
 361 }
 362
 363 /*
 364  * For each referring call triple, check the session's slot table for
 365  * a match.  If the slot is in use and the sequence numbers match, the
 366  * client is still waiting for a response to the original request.
 367  */
 368 static bool referring_call_exists(struct nfs_client *clp,
 369                                   uint32_t nrclists,
 370                                   struct referring_call_list *rclists)
 371 {
 372         bool status = 0;
 373         int i, j;
 374         struct nfs4_session *session;
 375         struct nfs4_slot_table *tbl;
 376         struct referring_call_list *rclist;
 377         struct referring_call *ref;
 378
 379         /*
 380          * XXX When client trunking is implemented, this becomes
 381          * a session lookup from within the loop
 382          */
 383         session = clp->cl_session;
 384         tbl = &session->fc_slot_table;
 385
 386         for (i = 0; i < nrclists; i++) {
 387                 rclist = &rclists[i];
 388                 if (memcmp(session->sess_id.data,
 389                            rclist->rcl_sessionid.data,
 390                            NFS4_MAX_SESSIONID_LEN) != 0)
 391                         continue;
 392
 393                 for (j = 0; j < rclist->rcl_nrefcalls; j++) {
 394                         ref = &rclist->rcl_refcalls[j];
 395
 396                         dprintk("%s: sessionid %x:%x:%x:%x sequenceid %u "
 397                                 "slotid %u\n", __func__,
 398                                 ((u32 *)&rclist->rcl_sessionid.data)[0],
 399                                 ((u32 *)&rclist->rcl_sessionid.data)[1],
 400                                 ((u32 *)&rclist->rcl_sessionid.data)[2],
 401                                 ((u32 *)&rclist->rcl_sessionid.data)[3],
 402                                 ref->rc_sequenceid, ref->rc_slotid);
 403
 404                         spin_lock(&tbl->slot_tbl_lock);
 405                         status = (test_bit(ref->rc_slotid, tbl->used_slots) &&
 406                                   tbl->slots[ref->rc_slotid].seq_nr ==
 407                                         ref->rc_sequenceid);
 408                         spin_unlock(&tbl->slot_tbl_lock);
 409                         if (status)
 410                                 goto out;
 411                 }
 412         }
 413
 414 out:
 415         return status;
 416 }
 417
 418 __be32 nfs4_callback_sequence(struct cb_sequenceargs *args,
 419                               struct cb_sequenceres *res,
 420                               struct cb_process_state *cps)
 421 {
 422         struct nfs4_slot_table *tbl;
 423         struct nfs4_slot *slot;
 424         struct nfs_client *clp;
 425         int i;
 426         __be32 status = htonl(NFS4ERR_BADSESSION);
 427
 428         clp = nfs4_find_client_sessionid(cps->net, args->csa_addr,
 429                                          &args->csa_sessionid, cps->minorversion);
 430         if (clp == NULL)
 431                 goto out;
 432
 433         if (!(clp->cl_session->flags & SESSION4_BACK_CHAN))
 434                 goto out;
 435
 436         tbl = &clp->cl_session->bc_slot_table;
 437         slot = tbl->slots + args->csa_slotid;
 438
 439         spin_lock(&tbl->slot_tbl_lock);
 440         /* state manager is resetting the session */
 441         if (test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state)) {
 442                 status = htonl(NFS4ERR_DELAY);
 443                 /* Return NFS4ERR_BADSESSION if we're draining the session
 444                  * in order to reset it.
 445                  */
 446                 if (test_bit(NFS4CLNT_SESSION_RESET, &clp->cl_state))
 447                         status = htonl(NFS4ERR_BADSESSION);
 448                 goto out_unlock;
 449         }
 450
 451         memcpy(&res->csr_sessionid, &args->csa_sessionid,
 452                sizeof(res->csr_sessionid));
 453         res->csr_sequenceid = args->csa_sequenceid;
 454         res->csr_slotid = args->csa_slotid;
 455         res->csr_highestslotid = NFS41_BC_MAX_CALLBACKS - 1;
 456         res->csr_target_highestslotid = NFS41_BC_MAX_CALLBACKS - 1;
 457
 458         status = validate_seqid(tbl, args);
 459         if (status)
 460                 goto out_unlock;
 461
 462         cps->slotid = args->csa_slotid;
 463
 464         /*
 465          * Check for pending referring calls.  If a match is found, a
 466          * related callback was received before the response to the original
 467          * call.
 468          */
 469         if (referring_call_exists(clp, args->csa_nrclists, args->csa_rclists)) {
 470                 status = htonl(NFS4ERR_DELAY);
 471                 goto out_unlock;
 472         }
 473
 474         /*
 475          * RFC5661 20.9.3
 476          * If CB_SEQUENCE returns an error, then the state of the slot
 477          * (sequence ID, cached reply) MUST NOT change.
 478          */
 479         slot->seq_nr++;
 480 out_unlock:
 481         spin_unlock(&tbl->slot_tbl_lock);
 482
 483 out:
 484         cps->clp = clp; /* put in nfs4_callback_compound */
 485         for (i = 0; i < args->csa_nrclists; i++)
 486                 kfree(args->csa_rclists[i].rcl_refcalls);
 487         kfree(args->csa_rclists);
 488
 489         if (status == htonl(NFS4ERR_RETRY_UNCACHED_REP)) {
 490                 cps->drc_status = status;
 491                 status = 0;
 492         } else
 493                 res->csr_status = status;
 494
 495         trace_nfs4_cb_sequence(args, res, status);
 496         dprintk("%s: exit with status = %d res->csr_status %d\n", __func__,
 497                 ntohl(status), ntohl(res->csr_status));
 498         return status;
 499 }
 500
 501 static bool
 502 validate_bitmap_values(unsigned long mask)
 503 {
 504         return (mask & ~RCA4_TYPE_MASK_ALL) == 0;
 505 }
 506
 507 __be32 nfs4_callback_recallany(struct cb_recallanyargs *args, void *dummy,
 508                                struct cb_process_state *cps)
 509 {
 510         __be32 status;
 511         fmode_t flags = 0;
 512
 513         status = cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION);
 514         if (!cps->clp) /* set in cb_sequence */
 515                 goto out;
 516
 517         dprintk_rcu("NFS: RECALL_ANY callback request from %s\n",
 518                 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR));
 519
 520         status = cpu_to_be32(NFS4ERR_INVAL);
 521         if (!validate_bitmap_values(args->craa_type_mask))
 522                 goto out;
 523
 524         status = cpu_to_be32(NFS4_OK);
 525         if (test_bit(RCA4_TYPE_MASK_RDATA_DLG, (const unsigned long *)
 526                      &args->craa_type_mask))
 527                 flags = FMODE_READ;
 528         if (test_bit(RCA4_TYPE_MASK_WDATA_DLG, (const unsigned long *)
 529                      &args->craa_type_mask))
 530                 flags |= FMODE_WRITE;
 531         if (test_bit(RCA4_TYPE_MASK_FILE_LAYOUT, (const unsigned long *)
 532                      &args->craa_type_mask))
 533                 pnfs_recall_all_layouts(cps->clp);
 534         if (flags)
 535                 nfs_expire_unused_delegation_types(cps->clp, flags);
 536 out:
 537         dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
 538         return status;
 539 }
 540
 541 /* Reduce the fore channel's max_slots to the target value */
 542 __be32 nfs4_callback_recallslot(struct cb_recallslotargs *args, void *dummy,
 543                                 struct cb_process_state *cps)
 544 {
 545         struct nfs4_slot_table *fc_tbl;
 546         __be32 status;
 547
 548         status = htonl(NFS4ERR_OP_NOT_IN_SESSION);
 549         if (!cps->clp) /* set in cb_sequence */
 550                 goto out;
 551
 552         dprintk_rcu("NFS: CB_RECALL_SLOT request from %s target highest slotid %u\n",
 553                 rpc_peeraddr2str(cps->clp->cl_rpcclient, RPC_DISPLAY_ADDR),
 554                 args->crsa_target_highest_slotid);
 555
 556         fc_tbl = &cps->clp->cl_session->fc_slot_table;
 557
 558         status = htonl(NFS4_OK);
 559
 560         nfs41_set_target_slotid(fc_tbl, args->crsa_target_highest_slotid);
 561         nfs41_notify_server(cps->clp);
 562 out:
 563         dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
 564         return status;
 565 }
 566 #endif /* CONFIG_NFS_V4_1 */