fs/nfs/pnfs.c

   1 /*
   2  *  pNFS functions to call and manage layout drivers.
   3  *
   4  *  Copyright (c) 2002 [year of first publication]
   5  *  The Regents of the University of Michigan
   6  *  All Rights Reserved
   7  *
   8  *  Dean Hildebrand <dhildebz@umich.edu>
   9  *
  10  *  Permission is granted to use, copy, create derivative works, and
  11  *  redistribute this software and such derivative works for any purpose,
  12  *  so long as the name of the University of Michigan is not used in
  13  *  any advertising or publicity pertaining to the use or distribution
  14  *  of this software without specific, written prior authorization. If
  15  *  the above copyright notice or any other identification of the
  16  *  University of Michigan is included in any copy of any portion of
  17  *  this software, then the disclaimer below must also be included.
  18  *
  19  *  This software is provided as is, without representation or warranty
  20  *  of any kind either express or implied, including without limitation
  21  *  the implied warranties of merchantability, fitness for a particular
  22  *  purpose, or noninfringement.  The Regents of the University of
  23  *  Michigan shall not be liable for any damages, including special,
  24  *  indirect, incidental, or consequential damages, with respect to any
  25  *  claim arising out of or in connection with the use of the software,
  26  *  even if it has been or is hereafter advised of the possibility of
  27  *  such damages.
  28  */
  29
  30 #include <linux/nfs_fs.h>
  31 #include "internal.h"
  32 #include "pnfs.h"
  33
  34 #define NFSDBG_FACILITY         NFSDBG_PNFS
  35
  36 /* Locking:
  37  *
  38  * pnfs_spinlock:
  39  *      protects pnfs_modules_tbl.
  40  */
  41 static DEFINE_SPINLOCK(pnfs_spinlock);
  42
  43 /*
  44  * pnfs_modules_tbl holds all pnfs modules
  45  */
  46 static LIST_HEAD(pnfs_modules_tbl);
  47
  48 /* Return the registered pnfs layout driver module matching given id */
  49 static struct pnfs_layoutdriver_type *
  50 find_pnfs_driver_locked(u32 id)
  51 {
  52         struct pnfs_layoutdriver_type *local;
  53
  54         list_for_each_entry(local, &pnfs_modules_tbl, pnfs_tblid)
  55                 if (local->id == id)
  56                         goto out;
  57         local = NULL;
  58 out:
  59         dprintk("%s: Searching for id %u, found %p\n", __func__, id, local);
  60         return local;
  61 }
  62
  63 static struct pnfs_layoutdriver_type *
  64 find_pnfs_driver(u32 id)
  65 {
  66         struct pnfs_layoutdriver_type *local;
  67
  68         spin_lock(&pnfs_spinlock);
  69         local = find_pnfs_driver_locked(id);
  70         spin_unlock(&pnfs_spinlock);
  71         return local;
  72 }
  73
  74 void
  75 unset_pnfs_layoutdriver(struct nfs_server *nfss)
  76 {
  77         if (nfss->pnfs_curr_ld) {
  78                 nfss->pnfs_curr_ld->clear_layoutdriver(nfss);
  79                 module_put(nfss->pnfs_curr_ld->owner);
  80         }
  81         nfss->pnfs_curr_ld = NULL;
  82 }
  83
  84 /*
  85  * Try to set the server's pnfs module to the pnfs layout type specified by id.
  86  * Currently only one pNFS layout driver per filesystem is supported.
  87  *
  88  * @id layout type. Zero (illegal layout type) indicates pNFS not in use.
  89  */
  90 void
  91 set_pnfs_layoutdriver(struct nfs_server *server, u32 id)
  92 {
  93         struct pnfs_layoutdriver_type *ld_type = NULL;
  94
  95         if (id == 0)
  96                 goto out_no_driver;
  97         if (!(server->nfs_client->cl_exchange_flags &
  98                  (EXCHGID4_FLAG_USE_NON_PNFS | EXCHGID4_FLAG_USE_PNFS_MDS))) {
  99                 printk(KERN_ERR "%s: id %u cl_exchange_flags 0x%x\n", __func__,
 100                        id, server->nfs_client->cl_exchange_flags);
 101                 goto out_no_driver;
 102         }
 103         ld_type = find_pnfs_driver(id);
 104         if (!ld_type) {
 105                 request_module("%s-%u", LAYOUT_NFSV4_1_MODULE_PREFIX, id);
 106                 ld_type = find_pnfs_driver(id);
 107                 if (!ld_type) {
 108                         dprintk("%s: No pNFS module found for %u.\n",
 109                                 __func__, id);
 110                         goto out_no_driver;
 111                 }
 112         }
 113         if (!try_module_get(ld_type->owner)) {
 114                 dprintk("%s: Could not grab reference on module\n", __func__);
 115                 goto out_no_driver;
 116         }
 117         server->pnfs_curr_ld = ld_type;
 118         if (ld_type->set_layoutdriver(server)) {
 119                 printk(KERN_ERR
 120                        "%s: Error initializing mount point for layout driver %u.\n",
 121                        __func__, id);
 122                 module_put(ld_type->owner);
 123                 goto out_no_driver;
 124         }
 125         dprintk("%s: pNFS module for %u set\n", __func__, id);
 126         return;
 127
 128 out_no_driver:
 129         dprintk("%s: Using NFSv4 I/O\n", __func__);
 130         server->pnfs_curr_ld = NULL;
 131 }
 132
 133 int
 134 pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
 135 {
 136         int status = -EINVAL;
 137         struct pnfs_layoutdriver_type *tmp;
 138
 139         if (ld_type->id == 0) {
 140                 printk(KERN_ERR "%s id 0 is reserved\n", __func__);
 141                 return status;
 142         }
 143         if (!ld_type->alloc_lseg || !ld_type->free_lseg) {
 144                 printk(KERN_ERR "%s Layout driver must provide "
 145                        "alloc_lseg and free_lseg.\n", __func__);
 146                 return status;
 147         }
 148
 149         spin_lock(&pnfs_spinlock);
 150         tmp = find_pnfs_driver_locked(ld_type->id);
 151         if (!tmp) {
 152                 list_add(&ld_type->pnfs_tblid, &pnfs_modules_tbl);
 153                 status = 0;
 154                 dprintk("%s Registering id:%u name:%s\n", __func__, ld_type->id,
 155                         ld_type->name);
 156         } else {
 157                 printk(KERN_ERR "%s Module with id %d already loaded!\n",
 158                         __func__, ld_type->id);
 159         }
 160         spin_unlock(&pnfs_spinlock);
 161
 162         return status;
 163 }
 164 EXPORT_SYMBOL_GPL(pnfs_register_layoutdriver);
 165
 166 void
 167 pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *ld_type)
 168 {
 169         dprintk("%s Deregistering id:%u\n", __func__, ld_type->id);
 170         spin_lock(&pnfs_spinlock);
 171         list_del(&ld_type->pnfs_tblid);
 172         spin_unlock(&pnfs_spinlock);
 173 }
 174 EXPORT_SYMBOL_GPL(pnfs_unregister_layoutdriver);
 175
 176 /*
 177  * pNFS client layout cache
 178  */
 179
 180 /* Need to hold i_lock if caller does not already hold reference */
 181 void
 182 get_layout_hdr(struct pnfs_layout_hdr *lo)
 183 {
 184         atomic_inc(&lo->plh_refcount);
 185 }
 186
 187 static void
 188 destroy_layout_hdr(struct pnfs_layout_hdr *lo)
 189 {
 190         dprintk("%s: freeing layout cache %p\n", __func__, lo);
 191         BUG_ON(!list_empty(&lo->plh_layouts));
 192         NFS_I(lo->plh_inode)->layout = NULL;
 193         kfree(lo);
 194 }
 195
 196 static void
 197 put_layout_hdr_locked(struct pnfs_layout_hdr *lo)
 198 {
 199         if (atomic_dec_and_test(&lo->plh_refcount))
 200                 destroy_layout_hdr(lo);
 201 }
 202
 203 void
 204 put_layout_hdr(struct pnfs_layout_hdr *lo)
 205 {
 206         struct inode *inode = lo->plh_inode;
 207
 208         if (atomic_dec_and_lock(&lo->plh_refcount, &inode->i_lock)) {
 209                 destroy_layout_hdr(lo);
 210                 spin_unlock(&inode->i_lock);
 211         }
 212 }
 213
 214 static void
 215 init_lseg(struct pnfs_layout_hdr *lo, struct pnfs_layout_segment *lseg)
 216 {
 217         INIT_LIST_HEAD(&lseg->pls_list);
 218         atomic_set(&lseg->pls_refcount, 1);
 219         smp_mb();
 220         set_bit(NFS_LSEG_VALID, &lseg->pls_flags);
 221         lseg->pls_layout = lo;
 222 }
 223
 224 static void free_lseg(struct pnfs_layout_segment *lseg)
 225 {
 226         struct inode *ino = lseg->pls_layout->plh_inode;
 227
 228         NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
 229         /* Matched by get_layout_hdr in pnfs_insert_layout */
 230         put_layout_hdr(NFS_I(ino)->layout);
 231 }
 232
 233 /* The use of tmp_list is necessary because pnfs_curr_ld->free_lseg
 234  * could sleep, so must be called outside of the lock.
 235  * Returns 1 if object was removed, otherwise return 0.
 236  */
 237 static int
 238 put_lseg_locked(struct pnfs_layout_segment *lseg,
 239                 struct list_head *tmp_list)
 240 {
 241         dprintk("%s: lseg %p ref %d valid %d\n", __func__, lseg,
 242                 atomic_read(&lseg->pls_refcount),
 243                 test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
 244         if (atomic_dec_and_test(&lseg->pls_refcount)) {
 245                 struct inode *ino = lseg->pls_layout->plh_inode;
 246
 247                 BUG_ON(test_bit(NFS_LSEG_VALID, &lseg->pls_flags));
 248                 list_del(&lseg->pls_list);
 249                 if (list_empty(&lseg->pls_layout->plh_segs)) {
 250                         struct nfs_client *clp;
 251
 252                         clp = NFS_SERVER(ino)->nfs_client;
 253                         spin_lock(&clp->cl_lock);
 254                         /* List does not take a reference, so no need for put here */
 255                         list_del_init(&lseg->pls_layout->plh_layouts);
 256                         spin_unlock(&clp->cl_lock);
 257                         clear_bit(NFS_LAYOUT_BULK_RECALL, &lseg->pls_layout->plh_flags);
 258                 }
 259                 list_add(&lseg->pls_list, tmp_list);
 260                 return 1;
 261         }
 262         return 0;
 263 }
 264
 265 static bool
 266 should_free_lseg(u32 lseg_iomode, u32 recall_iomode)
 267 {
 268         return (recall_iomode == IOMODE_ANY ||
 269                 lseg_iomode == recall_iomode);
 270 }
 271
 272 /* Returns 1 if lseg is removed from list, 0 otherwise */
 273 static int mark_lseg_invalid(struct pnfs_layout_segment *lseg,
 274                              struct list_head *tmp_list)
 275 {
 276         int rv = 0;
 277
 278         if (test_and_clear_bit(NFS_LSEG_VALID, &lseg->pls_flags)) {
 279                 /* Remove the reference keeping the lseg in the
 280                  * list.  It will now be removed when all
 281                  * outstanding io is finished.
 282                  */
 283                 rv = put_lseg_locked(lseg, tmp_list);
 284         }
 285         return rv;
 286 }
 287
 288 /* Returns count of number of matching invalid lsegs remaining in list
 289  * after call.
 290  */
 291 int
 292 mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
 293                             struct list_head *tmp_list,
 294                             u32 iomode)
 295 {
 296         struct pnfs_layout_segment *lseg, *next;
 297         int invalid = 0, removed = 0;
 298
 299         dprintk("%s:Begin lo %p\n", __func__, lo);
 300
 301         list_for_each_entry_safe(lseg, next, &lo->plh_segs, pls_list)
 302                 if (should_free_lseg(lseg->pls_range.iomode, iomode)) {
 303                         dprintk("%s: freeing lseg %p iomode %d "
 304                                 "offset %llu length %llu\n", __func__,
 305                                 lseg, lseg->pls_range.iomode, lseg->pls_range.offset,
 306                                 lseg->pls_range.length);
 307                         invalid++;
 308                         removed += mark_lseg_invalid(lseg, tmp_list);
 309                 }
 310         dprintk("%s:Return %i\n", __func__, invalid - removed);
 311         return invalid - removed;
 312 }
 313
 314 void
 315 pnfs_free_lseg_list(struct list_head *free_me)
 316 {
 317         struct pnfs_layout_segment *lseg, *tmp;
 318
 319         list_for_each_entry_safe(lseg, tmp, free_me, pls_list) {
 320                 list_del(&lseg->pls_list);
 321                 free_lseg(lseg);
 322         }
 323 }
 324
 325 void
 326 pnfs_destroy_layout(struct nfs_inode *nfsi)
 327 {
 328         struct pnfs_layout_hdr *lo;
 329         LIST_HEAD(tmp_list);
 330
 331         spin_lock(&nfsi->vfs_inode.i_lock);
 332         lo = nfsi->layout;
 333         if (lo) {
 334                 set_bit(NFS_LAYOUT_DESTROYED, &nfsi->layout->plh_flags);
 335                 mark_matching_lsegs_invalid(lo, &tmp_list, IOMODE_ANY);
 336                 /* Matched by refcount set to 1 in alloc_init_layout_hdr */
 337                 put_layout_hdr_locked(lo);
 338         }
 339         spin_unlock(&nfsi->vfs_inode.i_lock);
 340         pnfs_free_lseg_list(&tmp_list);
 341 }
 342
 343 /*
 344  * Called by the state manger to remove all layouts established under an
 345  * expired lease.
 346  */
 347 void
 348 pnfs_destroy_all_layouts(struct nfs_client *clp)
 349 {
 350         struct pnfs_layout_hdr *lo;
 351         LIST_HEAD(tmp_list);
 352
 353         spin_lock(&clp->cl_lock);
 354         list_splice_init(&clp->cl_layouts, &tmp_list);
 355         spin_unlock(&clp->cl_lock);
 356
 357         while (!list_empty(&tmp_list)) {
 358                 lo = list_entry(tmp_list.next, struct pnfs_layout_hdr,
 359                                 plh_layouts);
 360                 dprintk("%s freeing layout for inode %lu\n", __func__,
 361                         lo->plh_inode->i_ino);
 362                 pnfs_destroy_layout(NFS_I(lo->plh_inode));
 363         }
 364 }
 365
 366 /* update lo->plh_stateid with new if is more recent */
 367 void
 368 pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, const nfs4_stateid *new,
 369                         bool update_barrier)
 370 {
 371         u32 oldseq, newseq;
 372
 373         oldseq = be32_to_cpu(lo->plh_stateid.stateid.seqid);
 374         newseq = be32_to_cpu(new->stateid.seqid);
 375         if ((int)(newseq - oldseq) > 0) {
 376                 memcpy(&lo->plh_stateid, &new->stateid, sizeof(new->stateid));
 377                 if (update_barrier) {
 378                         u32 new_barrier = be32_to_cpu(new->stateid.seqid);
 379
 380                         if ((int)(new_barrier - lo->plh_barrier))
 381                                 lo->plh_barrier = new_barrier;
 382                 } else {
 383                         /* Because of wraparound, we want to keep the barrier
 384                          * "close" to the current seqids.  It needs to be
 385                          * within 2**31 to count as "behind", so if it
 386                          * gets too near that limit, give us a litle leeway
 387                          * and bring it to within 2**30.
 388                          * NOTE - and yes, this is all unsigned arithmetic.
 389                          */
 390                         if (unlikely((newseq - lo->plh_barrier) > (3 << 29)))
 391                                 lo->plh_barrier = newseq - (1 << 30);
 392                 }
 393         }
 394 }
 395
 396 /* lget is set to 1 if called from inside send_layoutget call chain */
 397 static bool
 398 pnfs_layoutgets_blocked(struct pnfs_layout_hdr *lo, nfs4_stateid *stateid,
 399                         int lget)
 400 {
 401         if ((stateid) &&
 402             (int)(lo->plh_barrier - be32_to_cpu(stateid->stateid.seqid)) >= 0)
 403                 return true;
 404         return test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags) ||
 405                 (list_empty(&lo->plh_segs) &&
 406                  (atomic_read(&lo->plh_outstanding) > lget));
 407 }
 408
 409 int
 410 pnfs_choose_layoutget_stateid(nfs4_stateid *dst, struct pnfs_layout_hdr *lo,
 411                               struct nfs4_state *open_state)
 412 {
 413         int status = 0;
 414
 415         dprintk("--> %s\n", __func__);
 416         spin_lock(&lo->plh_inode->i_lock);
 417         if (pnfs_layoutgets_blocked(lo, NULL, 1)) {
 418                 status = -EAGAIN;
 419         } else if (list_empty(&lo->plh_segs)) {
 420                 int seq;
 421
 422                 do {
 423                         seq = read_seqbegin(&open_state->seqlock);
 424                         memcpy(dst->data, open_state->stateid.data,
 425                                sizeof(open_state->stateid.data));
 426                 } while (read_seqretry(&open_state->seqlock, seq));
 427         } else
 428                 memcpy(dst->data, lo->plh_stateid.data, sizeof(lo->plh_stateid.data));
 429         spin_unlock(&lo->plh_inode->i_lock);
 430         dprintk("<-- %s\n", __func__);
 431         return status;
 432 }
 433
 434 /*
 435 * Get layout from server.
 436 *    for now, assume that whole file layouts are requested.
 437 *    arg->offset: 0
 438 *    arg->length: all ones
 439 */
 440 static struct pnfs_layout_segment *
 441 send_layoutget(struct pnfs_layout_hdr *lo,
 442            struct nfs_open_context *ctx,
 443            u32 iomode)
 444 {
 445         struct inode *ino = lo->plh_inode;
 446         struct nfs_server *server = NFS_SERVER(ino);
 447         struct nfs4_layoutget *lgp;
 448         struct pnfs_layout_segment *lseg = NULL;
 449
 450         dprintk("--> %s\n", __func__);
 451
 452         BUG_ON(ctx == NULL);
 453         lgp = kzalloc(sizeof(*lgp), GFP_KERNEL);
 454         if (lgp == NULL)
 455                 return NULL;
 456         lgp->args.minlength = NFS4_MAX_UINT64;
 457         lgp->args.maxcount = PNFS_LAYOUT_MAXSIZE;
 458         lgp->args.range.iomode = iomode;
 459         lgp->args.range.offset = 0;
 460         lgp->args.range.length = NFS4_MAX_UINT64;
 461         lgp->args.type = server->pnfs_curr_ld->id;
 462         lgp->args.inode = ino;
 463         lgp->args.ctx = get_nfs_open_context(ctx);
 464         lgp->lsegpp = &lseg;
 465
 466         /* Synchronously retrieve layout information from server and
 467          * store in lseg.
 468          */
 469         nfs4_proc_layoutget(lgp);
 470         if (!lseg) {
 471                 /* remember that LAYOUTGET failed and suspend trying */
 472                 set_bit(lo_fail_bit(iomode), &lo->plh_flags);
 473         }
 474         return lseg;
 475 }
 476
 477 /*
 478  * Compare two layout segments for sorting into layout cache.
 479  * We want to preferentially return RW over RO layouts, so ensure those
 480  * are seen first.
 481  */
 482 static s64
 483 cmp_layout(u32 iomode1, u32 iomode2)
 484 {
 485         /* read > read/write */
 486         return (int)(iomode2 == IOMODE_READ) - (int)(iomode1 == IOMODE_READ);
 487 }
 488
 489 static void
 490 pnfs_insert_layout(struct pnfs_layout_hdr *lo,
 491                    struct pnfs_layout_segment *lseg)
 492 {
 493         struct pnfs_layout_segment *lp;
 494         int found = 0;
 495
 496         dprintk("%s:Begin\n", __func__);
 497
 498         assert_spin_locked(&lo->plh_inode->i_lock);
 499         list_for_each_entry(lp, &lo->plh_segs, pls_list) {
 500                 if (cmp_layout(lp->pls_range.iomode, lseg->pls_range.iomode) > 0)
 501                         continue;
 502                 list_add_tail(&lseg->pls_list, &lp->pls_list);
 503                 dprintk("%s: inserted lseg %p "
 504                         "iomode %d offset %llu length %llu before "
 505                         "lp %p iomode %d offset %llu length %llu\n",
 506                         __func__, lseg, lseg->pls_range.iomode,
 507                         lseg->pls_range.offset, lseg->pls_range.length,
 508                         lp, lp->pls_range.iomode, lp->pls_range.offset,
 509                         lp->pls_range.length);
 510                 found = 1;
 511                 break;
 512         }
 513         if (!found) {
 514                 list_add_tail(&lseg->pls_list, &lo->plh_segs);
 515                 dprintk("%s: inserted lseg %p "
 516                         "iomode %d offset %llu length %llu at tail\n",
 517                         __func__, lseg, lseg->pls_range.iomode,
 518                         lseg->pls_range.offset, lseg->pls_range.length);
 519         }
 520         get_layout_hdr(lo);
 521
 522         dprintk("%s:Return\n", __func__);
 523 }
 524
 525 static struct pnfs_layout_hdr *
 526 alloc_init_layout_hdr(struct inode *ino)
 527 {
 528         struct pnfs_layout_hdr *lo;
 529
 530         lo = kzalloc(sizeof(struct pnfs_layout_hdr), GFP_KERNEL);
 531         if (!lo)
 532                 return NULL;
 533         atomic_set(&lo->plh_refcount, 1);
 534         INIT_LIST_HEAD(&lo->plh_layouts);
 535         INIT_LIST_HEAD(&lo->plh_segs);
 536         INIT_LIST_HEAD(&lo->plh_bulk_recall);
 537         lo->plh_inode = ino;
 538         return lo;
 539 }
 540
 541 static struct pnfs_layout_hdr *
 542 pnfs_find_alloc_layout(struct inode *ino)
 543 {
 544         struct nfs_inode *nfsi = NFS_I(ino);
 545         struct pnfs_layout_hdr *new = NULL;
 546
 547         dprintk("%s Begin ino=%p layout=%p\n", __func__, ino, nfsi->layout);
 548
 549         assert_spin_locked(&ino->i_lock);
 550         if (nfsi->layout) {
 551                 if (test_bit(NFS_LAYOUT_DESTROYED, &nfsi->layout->plh_flags))
 552                         return NULL;
 553                 else
 554                         return nfsi->layout;
 555         }
 556         spin_unlock(&ino->i_lock);
 557         new = alloc_init_layout_hdr(ino);
 558         spin_lock(&ino->i_lock);
 559
 560         if (likely(nfsi->layout == NULL))       /* Won the race? */
 561                 nfsi->layout = new;
 562         else
 563                 kfree(new);
 564         return nfsi->layout;
 565 }
 566
 567 /*
 568  * iomode matching rules:
 569  * iomode       lseg    match
 570  * -----        -----   -----
 571  * ANY          READ    true
 572  * ANY          RW      true
 573  * RW           READ    false
 574  * RW           RW      true
 575  * READ         READ    true
 576  * READ         RW      true
 577  */
 578 static int
 579 is_matching_lseg(struct pnfs_layout_segment *lseg, u32 iomode)
 580 {
 581         return (iomode != IOMODE_RW || lseg->pls_range.iomode == IOMODE_RW);
 582 }
 583
 584 /*
 585  * lookup range in layout
 586  */
 587 static struct pnfs_layout_segment *
 588 pnfs_find_lseg(struct pnfs_layout_hdr *lo, u32 iomode)
 589 {
 590         struct pnfs_layout_segment *lseg, *ret = NULL;
 591
 592         dprintk("%s:Begin\n", __func__);
 593
 594         assert_spin_locked(&lo->plh_inode->i_lock);
 595         list_for_each_entry(lseg, &lo->plh_segs, pls_list) {
 596                 if (test_bit(NFS_LSEG_VALID, &lseg->pls_flags) &&
 597                     is_matching_lseg(lseg, iomode)) {
 598                         ret = lseg;
 599                         break;
 600                 }
 601                 if (cmp_layout(iomode, lseg->pls_range.iomode) > 0)
 602                         break;
 603         }
 604
 605         dprintk("%s:Return lseg %p ref %d\n",
 606                 __func__, ret, ret ? atomic_read(&ret->pls_refcount) : 0);
 607         return ret;
 608 }
 609
 610 /*
 611  * Layout segment is retreived from the server if not cached.
 612  * The appropriate layout segment is referenced and returned to the caller.
 613  */
 614 struct pnfs_layout_segment *
 615 pnfs_update_layout(struct inode *ino,
 616                    struct nfs_open_context *ctx,
 617                    enum pnfs_iomode iomode)
 618 {
 619         struct nfs_inode *nfsi = NFS_I(ino);
 620         struct nfs_client *clp = NFS_SERVER(ino)->nfs_client;
 621         struct pnfs_layout_hdr *lo;
 622         struct pnfs_layout_segment *lseg = NULL;
 623
 624         if (!pnfs_enabled_sb(NFS_SERVER(ino)))
 625                 return NULL;
 626         spin_lock(&ino->i_lock);
 627         lo = pnfs_find_alloc_layout(ino);
 628         if (lo == NULL) {
 629                 dprintk("%s ERROR: can't get pnfs_layout_hdr\n", __func__);
 630                 goto out_unlock;
 631         }
 632
 633         /* Do we even need to bother with this? */
 634         if (test_bit(NFS4CLNT_LAYOUTRECALL, &clp->cl_state) ||
 635             test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
 636                 dprintk("%s matches recall, use MDS\n", __func__);
 637                 goto out_unlock;
 638         }
 639         /* Check to see if the layout for the given range already exists */
 640         lseg = pnfs_find_lseg(lo, iomode);
 641         if (lseg)
 642                 goto out_unlock;
 643
 644         /* if LAYOUTGET already failed once we don't try again */
 645         if (test_bit(lo_fail_bit(iomode), &nfsi->layout->plh_flags))
 646                 goto out_unlock;
 647
 648         if (pnfs_layoutgets_blocked(lo, NULL, 0))
 649                 goto out_unlock;
 650         atomic_inc(&lo->plh_outstanding);
 651
 652         get_layout_hdr(lo);
 653         if (list_empty(&lo->plh_segs)) {
 654                 /* The lo must be on the clp list if there is any
 655                  * chance of a CB_LAYOUTRECALL(FILE) coming in.
 656                  */
 657                 spin_lock(&clp->cl_lock);
 658                 BUG_ON(!list_empty(&lo->plh_layouts));
 659                 list_add_tail(&lo->plh_layouts, &clp->cl_layouts);
 660                 spin_unlock(&clp->cl_lock);
 661         }
 662         spin_unlock(&ino->i_lock);
 663
 664         lseg = send_layoutget(lo, ctx, iomode);
 665         if (!lseg) {
 666                 spin_lock(&ino->i_lock);
 667                 if (list_empty(&lo->plh_segs)) {
 668                         spin_lock(&clp->cl_lock);
 669                         list_del_init(&lo->plh_layouts);
 670                         spin_unlock(&clp->cl_lock);
 671                         clear_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags);
 672                 }
 673                 spin_unlock(&ino->i_lock);
 674         }
 675         atomic_dec(&lo->plh_outstanding);
 676         put_layout_hdr(lo);
 677 out:
 678         dprintk("%s end, state 0x%lx lseg %p\n", __func__,
 679                 nfsi->layout->plh_flags, lseg);
 680         return lseg;
 681 out_unlock:
 682         spin_unlock(&ino->i_lock);
 683         goto out;
 684 }
 685
 686 int
 687 pnfs_layout_process(struct nfs4_layoutget *lgp)
 688 {
 689         struct pnfs_layout_hdr *lo = NFS_I(lgp->args.inode)->layout;
 690         struct nfs4_layoutget_res *res = &lgp->res;
 691         struct pnfs_layout_segment *lseg;
 692         struct inode *ino = lo->plh_inode;
 693         struct nfs_client *clp = NFS_SERVER(ino)->nfs_client;
 694         int status = 0;
 695
 696         /* Verify we got what we asked for.
 697          * Note that because the xdr parsing only accepts a single
 698          * element array, this can fail even if the server is behaving
 699          * correctly.
 700          */
 701         if (lgp->args.range.iomode > res->range.iomode ||
 702             res->range.offset != 0 ||
 703             res->range.length != NFS4_MAX_UINT64) {
 704                 status = -EINVAL;
 705                 goto out;
 706         }
 707         /* Inject layout blob into I/O device driver */
 708         lseg = NFS_SERVER(ino)->pnfs_curr_ld->alloc_lseg(lo, res);
 709         if (!lseg || IS_ERR(lseg)) {
 710                 if (!lseg)
 711                         status = -ENOMEM;
 712                 else
 713                         status = PTR_ERR(lseg);
 714                 dprintk("%s: Could not allocate layout: error %d\n",
 715                        __func__, status);
 716                 goto out;
 717         }
 718
 719         spin_lock(&ino->i_lock);
 720         if (test_bit(NFS4CLNT_LAYOUTRECALL, &clp->cl_state) ||
 721             test_bit(NFS_LAYOUT_BULK_RECALL, &lo->plh_flags)) {
 722                 dprintk("%s forget reply due to recall\n", __func__);
 723                 goto out_forget_reply;
 724         }
 725
 726         if (pnfs_layoutgets_blocked(lo, &res->stateid, 1)) {
 727                 dprintk("%s forget reply due to state\n", __func__);
 728                 goto out_forget_reply;
 729         }
 730         init_lseg(lo, lseg);
 731         lseg->pls_range = res->range;
 732         *lgp->lsegpp = lseg;
 733         pnfs_insert_layout(lo, lseg);
 734
 735         /* Done processing layoutget. Set the layout stateid */
 736         pnfs_set_layout_stateid(lo, &res->stateid, false);
 737         spin_unlock(&ino->i_lock);
 738 out:
 739         return status;
 740
 741 out_forget_reply:
 742         spin_unlock(&ino->i_lock);
 743         lseg->pls_layout = lo;
 744         NFS_SERVER(ino)->pnfs_curr_ld->free_lseg(lseg);
 745         goto out;
 746 }
 747
 748 /*
 749  * Device ID cache. Currently supports one layout type per struct nfs_client.
 750  * Add layout type to the lookup key to expand to support multiple types.
 751  */
 752 int
 753 pnfs_alloc_init_deviceid_cache(struct nfs_client *clp,
 754                          void (*free_callback)(struct pnfs_deviceid_node *))
 755 {
 756         struct pnfs_deviceid_cache *c;
 757
 758         c = kzalloc(sizeof(struct pnfs_deviceid_cache), GFP_KERNEL);
 759         if (!c)
 760                 return -ENOMEM;
 761         spin_lock(&clp->cl_lock);
 762         if (clp->cl_devid_cache != NULL) {
 763                 atomic_inc(&clp->cl_devid_cache->dc_ref);
 764                 dprintk("%s [kref [%d]]\n", __func__,
 765                         atomic_read(&clp->cl_devid_cache->dc_ref));
 766                 kfree(c);
 767         } else {
 768                 /* kzalloc initializes hlists */
 769                 spin_lock_init(&c->dc_lock);
 770                 atomic_set(&c->dc_ref, 1);
 771                 c->dc_free_callback = free_callback;
 772                 clp->cl_devid_cache = c;
 773                 dprintk("%s [new]\n", __func__);
 774         }
 775         spin_unlock(&clp->cl_lock);
 776         return 0;
 777 }
 778 EXPORT_SYMBOL_GPL(pnfs_alloc_init_deviceid_cache);
 779
 780 /*
 781  * Called from pnfs_layoutdriver_type->free_lseg
 782  * last layout segment reference frees deviceid
 783  */
 784 void
 785 pnfs_put_deviceid(struct pnfs_deviceid_cache *c,
 786                   struct pnfs_deviceid_node *devid)
 787 {
 788         struct nfs4_deviceid *id = &devid->de_id;
 789         struct pnfs_deviceid_node *d;
 790         struct hlist_node *n;
 791         long h = nfs4_deviceid_hash(id);
 792
 793         dprintk("%s [%d]\n", __func__, atomic_read(&devid->de_ref));
 794         if (!atomic_dec_and_lock(&devid->de_ref, &c->dc_lock))
 795                 return;
 796
 797         hlist_for_each_entry_rcu(d, n, &c->dc_deviceids[h], de_node)
 798                 if (!memcmp(&d->de_id, id, sizeof(*id))) {
 799                         hlist_del_rcu(&d->de_node);
 800                         spin_unlock(&c->dc_lock);
 801                         synchronize_rcu();
 802                         c->dc_free_callback(devid);
 803                         return;
 804                 }
 805         spin_unlock(&c->dc_lock);
 806         /* Why wasn't it found in  the list? */
 807         BUG();
 808 }
 809 EXPORT_SYMBOL_GPL(pnfs_put_deviceid);
 810
 811 /* Find and reference a deviceid */
 812 struct pnfs_deviceid_node *
 813 pnfs_find_get_deviceid(struct pnfs_deviceid_cache *c, struct nfs4_deviceid *id)
 814 {
 815         struct pnfs_deviceid_node *d;
 816         struct hlist_node *n;
 817         long hash = nfs4_deviceid_hash(id);
 818
 819         dprintk("--> %s hash %ld\n", __func__, hash);
 820         rcu_read_lock();
 821         hlist_for_each_entry_rcu(d, n, &c->dc_deviceids[hash], de_node) {
 822                 if (!memcmp(&d->de_id, id, sizeof(*id))) {
 823                         if (!atomic_inc_not_zero(&d->de_ref)) {
 824                                 goto fail;
 825                         } else {
 826                                 rcu_read_unlock();
 827                                 return d;
 828                         }
 829                 }
 830         }
 831 fail:
 832         rcu_read_unlock();
 833         return NULL;
 834 }
 835 EXPORT_SYMBOL_GPL(pnfs_find_get_deviceid);
 836
 837 /*
 838  * Add a deviceid to the cache.
 839  * GETDEVICEINFOs for same deviceid can race. If deviceid is found, discard new
 840  */
 841 struct pnfs_deviceid_node *
 842 pnfs_add_deviceid(struct pnfs_deviceid_cache *c, struct pnfs_deviceid_node *new)
 843 {
 844         struct pnfs_deviceid_node *d;
 845         long hash = nfs4_deviceid_hash(&new->de_id);
 846
 847         dprintk("--> %s hash %ld\n", __func__, hash);
 848         spin_lock(&c->dc_lock);
 849         d = pnfs_find_get_deviceid(c, &new->de_id);
 850         if (d) {
 851                 spin_unlock(&c->dc_lock);
 852                 dprintk("%s [discard]\n", __func__);
 853                 c->dc_free_callback(new);
 854                 return d;
 855         }
 856         INIT_HLIST_NODE(&new->de_node);
 857         atomic_set(&new->de_ref, 1);
 858         hlist_add_head_rcu(&new->de_node, &c->dc_deviceids[hash]);
 859         spin_unlock(&c->dc_lock);
 860         dprintk("%s [new]\n", __func__);
 861         return new;
 862 }
 863 EXPORT_SYMBOL_GPL(pnfs_add_deviceid);
 864
 865 void
 866 pnfs_put_deviceid_cache(struct nfs_client *clp)
 867 {
 868         struct pnfs_deviceid_cache *local = clp->cl_devid_cache;
 869
 870         dprintk("--> %s cl_devid_cache %p\n", __func__, clp->cl_devid_cache);
 871         if (atomic_dec_and_lock(&local->dc_ref, &clp->cl_lock)) {
 872                 int i;
 873                 /* Verify cache is empty */
 874                 for (i = 0; i < NFS4_DEVICE_ID_HASH_SIZE; i++)
 875                         BUG_ON(!hlist_empty(&local->dc_deviceids[i]));
 876                 clp->cl_devid_cache = NULL;
 877                 spin_unlock(&clp->cl_lock);
 878                 kfree(local);
 879         }
 880 }
 881 EXPORT_SYMBOL_GPL(pnfs_put_deviceid_cache);