fs/xfs/xfs_iget.c

   1 /*
   2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it would be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write the Free Software Foundation,
  16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18 #include "xfs.h"
  19 #include "xfs_fs.h"
  20 #include "xfs_types.h"
  21 #include "xfs_bit.h"
  22 #include "xfs_log.h"
  23 #include "xfs_inum.h"
  24 #include "xfs_trans.h"
  25 #include "xfs_sb.h"
  26 #include "xfs_ag.h"
  27 #include "xfs_dir.h"
  28 #include "xfs_dir2.h"
  29 #include "xfs_dmapi.h"
  30 #include "xfs_mount.h"
  31 #include "xfs_bmap_btree.h"
  32 #include "xfs_alloc_btree.h"
  33 #include "xfs_ialloc_btree.h"
  34 #include "xfs_dir_sf.h"
  35 #include "xfs_dir2_sf.h"
  36 #include "xfs_attr_sf.h"
  37 #include "xfs_dinode.h"
  38 #include "xfs_inode.h"
  39 #include "xfs_btree.h"
  40 #include "xfs_ialloc.h"
  41 #include "xfs_quota.h"
  42 #include "xfs_utils.h"
  43
  44 /*
  45  * Initialize the inode hash table for the newly mounted file system.
  46  * Choose an initial table size based on user specified value, else
  47  * use a simple algorithm using the maximum number of inodes as an
  48  * indicator for table size, and clamp it between one and some large
  49  * number of pages.
  50  */
  51 void
  52 xfs_ihash_init(xfs_mount_t *mp)
  53 {
  54         __uint64_t      icount;
  55         uint            i, flags = KM_SLEEP | KM_MAYFAIL;
  56
  57         if (!mp->m_ihsize) {
  58                 icount = mp->m_maxicount ? mp->m_maxicount :
  59                          (mp->m_sb.sb_dblocks << mp->m_sb.sb_inopblog);
  60                 mp->m_ihsize = 1 << max_t(uint, 8,
  61                                         (xfs_highbit64(icount) + 1) / 2);
  62                 mp->m_ihsize = min_t(uint, mp->m_ihsize,
  63                                         (64 * NBPP) / sizeof(xfs_ihash_t));
  64         }
  65
  66         while (!(mp->m_ihash = (xfs_ihash_t *)kmem_zalloc(mp->m_ihsize *
  67                                                 sizeof(xfs_ihash_t), flags))) {
  68                 if ((mp->m_ihsize >>= 1) <= NBPP)
  69                         flags = KM_SLEEP;
  70         }
  71         for (i = 0; i < mp->m_ihsize; i++) {
  72                 rwlock_init(&(mp->m_ihash[i].ih_lock));
  73         }
  74 }
  75
  76 /*
  77  * Free up structures allocated by xfs_ihash_init, at unmount time.
  78  */
  79 void
  80 xfs_ihash_free(xfs_mount_t *mp)
  81 {
  82         kmem_free(mp->m_ihash, mp->m_ihsize*sizeof(xfs_ihash_t));
  83         mp->m_ihash = NULL;
  84 }
  85
  86 /*
  87  * Initialize the inode cluster hash table for the newly mounted file system.
  88  * Its size is derived from the ihash table size.
  89  */
  90 void
  91 xfs_chash_init(xfs_mount_t *mp)
  92 {
  93         uint    i;
  94
  95         mp->m_chsize = max_t(uint, 1, mp->m_ihsize /
  96                          (XFS_INODE_CLUSTER_SIZE(mp) >> mp->m_sb.sb_inodelog));
  97         mp->m_chsize = min_t(uint, mp->m_chsize, mp->m_ihsize);
  98         mp->m_chash = (xfs_chash_t *)kmem_zalloc(mp->m_chsize
  99                                                  * sizeof(xfs_chash_t),
 100                                                  KM_SLEEP);
 101         for (i = 0; i < mp->m_chsize; i++) {
 102                 spinlock_init(&mp->m_chash[i].ch_lock,"xfshash");
 103         }
 104 }
 105
 106 /*
 107  * Free up structures allocated by xfs_chash_init, at unmount time.
 108  */
 109 void
 110 xfs_chash_free(xfs_mount_t *mp)
 111 {
 112         int     i;
 113
 114         for (i = 0; i < mp->m_chsize; i++) {
 115                 spinlock_destroy(&mp->m_chash[i].ch_lock);
 116         }
 117
 118         kmem_free(mp->m_chash, mp->m_chsize*sizeof(xfs_chash_t));
 119         mp->m_chash = NULL;
 120 }
 121
 122 /*
 123  * Try to move an inode to the front of its hash list if possible
 124  * (and if its not there already).  Called right after obtaining
 125  * the list version number and then dropping the read_lock on the
 126  * hash list in question (which is done right after looking up the
 127  * inode in question...).
 128  */
 129 STATIC void
 130 xfs_ihash_promote(
 131         xfs_ihash_t     *ih,
 132         xfs_inode_t     *ip,
 133         ulong           version)
 134 {
 135         xfs_inode_t     *iq;
 136
 137         if ((ip->i_prevp != &ih->ih_next) && write_trylock(&ih->ih_lock)) {
 138                 if (likely(version == ih->ih_version)) {
 139                         /* remove from list */
 140                         if ((iq = ip->i_next)) {
 141                                 iq->i_prevp = ip->i_prevp;
 142                         }
 143                         *ip->i_prevp = iq;
 144
 145                         /* insert at list head */
 146                         iq = ih->ih_next;
 147                         iq->i_prevp = &ip->i_next;
 148                         ip->i_next = iq;
 149                         ip->i_prevp = &ih->ih_next;
 150                         ih->ih_next = ip;
 151                 }
 152                 write_unlock(&ih->ih_lock);
 153         }
 154 }
 155
 156 /*
 157  * Look up an inode by number in the given file system.
 158  * The inode is looked up in the hash table for the file system
 159  * represented by the mount point parameter mp.  Each bucket of
 160  * the hash table is guarded by an individual semaphore.
 161  *
 162  * If the inode is found in the hash table, its corresponding vnode
 163  * is obtained with a call to vn_get().  This call takes care of
 164  * coordination with the reclamation of the inode and vnode.  Note
 165  * that the vmap structure is filled in while holding the hash lock.
 166  * This gives us the state of the inode/vnode when we found it and
 167  * is used for coordination in vn_get().
 168  *
 169  * If it is not in core, read it in from the file system's device and
 170  * add the inode into the hash table.
 171  *
 172  * The inode is locked according to the value of the lock_flags parameter.
 173  * This flag parameter indicates how and if the inode's IO lock and inode lock
 174  * should be taken.
 175  *
 176  * mp -- the mount point structure for the current file system.  It points
 177  *       to the inode hash table.
 178  * tp -- a pointer to the current transaction if there is one.  This is
 179  *       simply passed through to the xfs_iread() call.
 180  * ino -- the number of the inode desired.  This is the unique identifier
 181  *        within the file system for the inode being requested.
 182  * lock_flags -- flags indicating how to lock the inode.  See the comment
 183  *               for xfs_ilock() for a list of valid values.
 184  * bno -- the block number starting the buffer containing the inode,
 185  *        if known (as by bulkstat), else 0.
 186  */
 187 STATIC int
 188 xfs_iget_core(
 189         vnode_t         *vp,
 190         xfs_mount_t     *mp,
 191         xfs_trans_t     *tp,
 192         xfs_ino_t       ino,
 193         uint            flags,
 194         uint            lock_flags,
 195         xfs_inode_t     **ipp,
 196         xfs_daddr_t     bno)
 197 {
 198         xfs_ihash_t     *ih;
 199         xfs_inode_t     *ip;
 200         xfs_inode_t     *iq;
 201         vnode_t         *inode_vp;
 202         ulong           version;
 203         int             error;
 204         /* REFERENCED */
 205         xfs_chash_t     *ch;
 206         xfs_chashlist_t *chl, *chlnew;
 207         SPLDECL(s);
 208
 209
 210         ih = XFS_IHASH(mp, ino);
 211
 212 again:
 213         read_lock(&ih->ih_lock);
 214
 215         for (ip = ih->ih_next; ip != NULL; ip = ip->i_next) {
 216                 if (ip->i_ino == ino) {
 217                         /*
 218                          * If INEW is set this inode is being set up
 219                          * we need to pause and try again.
 220                          */
 221                         if (ip->i_flags & XFS_INEW) {
 222                                 read_unlock(&ih->ih_lock);
 223                                 delay(1);
 224                                 XFS_STATS_INC(xs_ig_frecycle);
 225
 226                                 goto again;
 227                         }
 228
 229                         inode_vp = XFS_ITOV_NULL(ip);
 230                         if (inode_vp == NULL) {
 231                                 /*
 232                                  * If IRECLAIM is set this inode is
 233                                  * on its way out of the system,
 234                                  * we need to pause and try again.
 235                                  */
 236                                 if (ip->i_flags & XFS_IRECLAIM) {
 237                                         read_unlock(&ih->ih_lock);
 238                                         delay(1);
 239                                         XFS_STATS_INC(xs_ig_frecycle);
 240
 241                                         goto again;
 242                                 }
 243
 244                                 vn_trace_exit(vp, "xfs_iget.alloc",
 245                                         (inst_t *)__return_address);
 246
 247                                 XFS_STATS_INC(xs_ig_found);
 248
 249                                 ip->i_flags &= ~XFS_IRECLAIMABLE;
 250                                 version = ih->ih_version;
 251                                 read_unlock(&ih->ih_lock);
 252                                 xfs_ihash_promote(ih, ip, version);
 253
 254                                 XFS_MOUNT_ILOCK(mp);
 255                                 list_del_init(&ip->i_reclaim);
 256                                 XFS_MOUNT_IUNLOCK(mp);
 257
 258                                 goto finish_inode;
 259
 260                         } else if (vp != inode_vp) {
 261                                 struct inode *inode = vn_to_inode(inode_vp);
 262
 263                                 /* The inode is being torn down, pause and
 264                                  * try again.
 265                                  */
 266                                 if (inode->i_state & (I_FREEING | I_CLEAR)) {
 267                                         read_unlock(&ih->ih_lock);
 268                                         delay(1);
 269                                         XFS_STATS_INC(xs_ig_frecycle);
 270
 271                                         goto again;
 272                                 }
 273 /* Chances are the other vnode (the one in the inode) is being torn
 274  * down right now, and we landed on top of it. Question is, what do
 275  * we do? Unhook the old inode and hook up the new one?
 276  */
 277                                 cmn_err(CE_PANIC,
 278                         "xfs_iget_core: ambiguous vns: vp/0x%p, invp/0x%p",
 279                                                 inode_vp, vp);
 280                         }
 281
 282                         /*
 283                          * Inode cache hit: if ip is not at the front of
 284                          * its hash chain, move it there now.
 285                          * Do this with the lock held for update, but
 286                          * do statistics after releasing the lock.
 287                          */
 288                         version = ih->ih_version;
 289                         read_unlock(&ih->ih_lock);
 290                         xfs_ihash_promote(ih, ip, version);
 291                         XFS_STATS_INC(xs_ig_found);
 292
 293 finish_inode:
 294                         if (ip->i_d.di_mode == 0) {
 295                                 if (!(flags & IGET_CREATE))
 296                                         return ENOENT;
 297                                 xfs_iocore_inode_reinit(ip);
 298                         }
 299
 300                         if (lock_flags != 0)
 301                                 xfs_ilock(ip, lock_flags);
 302
 303                         ip->i_flags &= ~XFS_ISTALE;
 304
 305                         vn_trace_exit(vp, "xfs_iget.found",
 306                                                 (inst_t *)__return_address);
 307                         goto return_ip;
 308                 }
 309         }
 310
 311         /*
 312          * Inode cache miss: save the hash chain version stamp and unlock
 313          * the chain, so we don't deadlock in vn_alloc.
 314          */
 315         XFS_STATS_INC(xs_ig_missed);
 316
 317         version = ih->ih_version;
 318
 319         read_unlock(&ih->ih_lock);
 320
 321         /*
 322          * Read the disk inode attributes into a new inode structure and get
 323          * a new vnode for it. This should also initialize i_ino and i_mount.
 324          */
 325         error = xfs_iread(mp, tp, ino, &ip, bno);
 326         if (error) {
 327                 return error;
 328         }
 329
 330         vn_trace_exit(vp, "xfs_iget.alloc", (inst_t *)__return_address);
 331
 332         xfs_inode_lock_init(ip, vp);
 333         xfs_iocore_inode_init(ip);
 334
 335         if (lock_flags != 0) {
 336                 xfs_ilock(ip, lock_flags);
 337         }
 338
 339         if ((ip->i_d.di_mode == 0) && !(flags & IGET_CREATE)) {
 340                 xfs_idestroy(ip);
 341                 return ENOENT;
 342         }
 343
 344         /*
 345          * Put ip on its hash chain, unless someone else hashed a duplicate
 346          * after we released the hash lock.
 347          */
 348         write_lock(&ih->ih_lock);
 349
 350         if (ih->ih_version != version) {
 351                 for (iq = ih->ih_next; iq != NULL; iq = iq->i_next) {
 352                         if (iq->i_ino == ino) {
 353                                 write_unlock(&ih->ih_lock);
 354                                 xfs_idestroy(ip);
 355
 356                                 XFS_STATS_INC(xs_ig_dup);
 357                                 goto again;
 358                         }
 359                 }
 360         }
 361
 362         /*
 363          * These values _must_ be set before releasing ihlock!
 364          */
 365         ip->i_hash = ih;
 366         if ((iq = ih->ih_next)) {
 367                 iq->i_prevp = &ip->i_next;
 368         }
 369         ip->i_next = iq;
 370         ip->i_prevp = &ih->ih_next;
 371         ih->ih_next = ip;
 372         ip->i_udquot = ip->i_gdquot = NULL;
 373         ih->ih_version++;
 374         ip->i_flags |= XFS_INEW;
 375
 376         write_unlock(&ih->ih_lock);
 377
 378         /*
 379          * put ip on its cluster's hash chain
 380          */
 381         ASSERT(ip->i_chash == NULL && ip->i_cprev == NULL &&
 382                ip->i_cnext == NULL);
 383
 384         chlnew = NULL;
 385         ch = XFS_CHASH(mp, ip->i_blkno);
 386  chlredo:
 387         s = mutex_spinlock(&ch->ch_lock);
 388         for (chl = ch->ch_list; chl != NULL; chl = chl->chl_next) {
 389                 if (chl->chl_blkno == ip->i_blkno) {
 390
 391                         /* insert this inode into the doubly-linked list
 392                          * where chl points */
 393                         if ((iq = chl->chl_ip)) {
 394                                 ip->i_cprev = iq->i_cprev;
 395                                 iq->i_cprev->i_cnext = ip;
 396                                 iq->i_cprev = ip;
 397                                 ip->i_cnext = iq;
 398                         } else {
 399                                 ip->i_cnext = ip;
 400                                 ip->i_cprev = ip;
 401                         }
 402                         chl->chl_ip = ip;
 403                         ip->i_chash = chl;
 404                         break;
 405                 }
 406         }
 407
 408         /* no hash list found for this block; add a new hash list */
 409         if (chl == NULL)  {
 410                 if (chlnew == NULL) {
 411                         mutex_spinunlock(&ch->ch_lock, s);
 412                         ASSERT(xfs_chashlist_zone != NULL);
 413                         chlnew = (xfs_chashlist_t *)
 414                                         kmem_zone_alloc(xfs_chashlist_zone,
 415                                                 KM_SLEEP);
 416                         ASSERT(chlnew != NULL);
 417                         goto chlredo;
 418                 } else {
 419                         ip->i_cnext = ip;
 420                         ip->i_cprev = ip;
 421                         ip->i_chash = chlnew;
 422                         chlnew->chl_ip = ip;
 423                         chlnew->chl_blkno = ip->i_blkno;
 424                         if (ch->ch_list)
 425                                 ch->ch_list->chl_prev = chlnew;
 426                         chlnew->chl_next = ch->ch_list;
 427                         chlnew->chl_prev = NULL;
 428                         ch->ch_list = chlnew;
 429                         chlnew = NULL;
 430                 }
 431         } else {
 432                 if (chlnew != NULL) {
 433                         kmem_zone_free(xfs_chashlist_zone, chlnew);
 434                 }
 435         }
 436
 437         mutex_spinunlock(&ch->ch_lock, s);
 438
 439
 440         /*
 441          * Link ip to its mount and thread it on the mount's inode list.
 442          */
 443         XFS_MOUNT_ILOCK(mp);
 444         if ((iq = mp->m_inodes)) {
 445                 ASSERT(iq->i_mprev->i_mnext == iq);
 446                 ip->i_mprev = iq->i_mprev;
 447                 iq->i_mprev->i_mnext = ip;
 448                 iq->i_mprev = ip;
 449                 ip->i_mnext = iq;
 450         } else {
 451                 ip->i_mnext = ip;
 452                 ip->i_mprev = ip;
 453         }
 454         mp->m_inodes = ip;
 455
 456         XFS_MOUNT_IUNLOCK(mp);
 457
 458  return_ip:
 459         ASSERT(ip->i_df.if_ext_max ==
 460                XFS_IFORK_DSIZE(ip) / sizeof(xfs_bmbt_rec_t));
 461
 462         ASSERT(((ip->i_d.di_flags & XFS_DIFLAG_REALTIME) != 0) ==
 463                ((ip->i_iocore.io_flags & XFS_IOCORE_RT) != 0));
 464
 465         *ipp = ip;
 466
 467         /*
 468          * If we have a real type for an on-disk inode, we can set ops(&unlock)
 469          * now.  If it's a new inode being created, xfs_ialloc will handle it.
 470          */
 471         VFS_INIT_VNODE(XFS_MTOVFS(mp), vp, XFS_ITOBHV(ip), 1);
 472
 473         return 0;
 474 }
 475
 476
 477 /*
 478  * The 'normal' internal xfs_iget, if needed it will
 479  * 'allocate', or 'get', the vnode.
 480  */
 481 int
 482 xfs_iget(
 483         xfs_mount_t     *mp,
 484         xfs_trans_t     *tp,
 485         xfs_ino_t       ino,
 486         uint            flags,
 487         uint            lock_flags,
 488         xfs_inode_t     **ipp,
 489         xfs_daddr_t     bno)
 490 {
 491         struct inode    *inode;
 492         vnode_t         *vp = NULL;
 493         int             error;
 494
 495         XFS_STATS_INC(xs_ig_attempts);
 496
 497 retry:
 498         if ((inode = iget_locked(XFS_MTOVFS(mp)->vfs_super, ino))) {
 499                 xfs_inode_t     *ip;
 500
 501                 vp = vn_from_inode(inode);
 502                 if (inode->i_state & I_NEW) {
 503                         vn_initialize(inode);
 504                         error = xfs_iget_core(vp, mp, tp, ino, flags,
 505                                         lock_flags, ipp, bno);
 506                         if (error) {
 507                                 vn_mark_bad(vp);
 508                                 if (inode->i_state & I_NEW)
 509                                         unlock_new_inode(inode);
 510                                 iput(inode);
 511                         }
 512                 } else {
 513                         /*
 514                          * If the inode is not fully constructed due to
 515                          * filehandle mismatches wait for the inode to go
 516                          * away and try again.
 517                          *
 518                          * iget_locked will call __wait_on_freeing_inode
 519                          * to wait for the inode to go away.
 520                          */
 521                         if (is_bad_inode(inode) ||
 522                             ((ip = xfs_vtoi(vp)) == NULL)) {
 523                                 iput(inode);
 524                                 delay(1);
 525                                 goto retry;
 526                         }
 527
 528                         if (lock_flags != 0)
 529                                 xfs_ilock(ip, lock_flags);
 530                         XFS_STATS_INC(xs_ig_found);
 531                         *ipp = ip;
 532                         error = 0;
 533                 }
 534         } else
 535                 error = ENOMEM; /* If we got no inode we are out of memory */
 536
 537         return error;
 538 }
 539
 540 /*
 541  * Do the setup for the various locks within the incore inode.
 542  */
 543 void
 544 xfs_inode_lock_init(
 545         xfs_inode_t     *ip,
 546         vnode_t         *vp)
 547 {
 548         mrlock_init(&ip->i_lock, MRLOCK_ALLOW_EQUAL_PRI|MRLOCK_BARRIER,
 549                      "xfsino", (long)vp->v_number);
 550         mrlock_init(&ip->i_iolock, MRLOCK_BARRIER, "xfsio", vp->v_number);
 551         init_waitqueue_head(&ip->i_ipin_wait);
 552         atomic_set(&ip->i_pincount, 0);
 553         init_sema(&ip->i_flock, 1, "xfsfino", vp->v_number);
 554 }
 555
 556 /*
 557  * Look for the inode corresponding to the given ino in the hash table.
 558  * If it is there and its i_transp pointer matches tp, return it.
 559  * Otherwise, return NULL.
 560  */
 561 xfs_inode_t *
 562 xfs_inode_incore(xfs_mount_t    *mp,
 563                  xfs_ino_t      ino,
 564                  xfs_trans_t    *tp)
 565 {
 566         xfs_ihash_t     *ih;
 567         xfs_inode_t     *ip;
 568         ulong           version;
 569
 570         ih = XFS_IHASH(mp, ino);
 571         read_lock(&ih->ih_lock);
 572         for (ip = ih->ih_next; ip != NULL; ip = ip->i_next) {
 573                 if (ip->i_ino == ino) {
 574                         /*
 575                          * If we find it and tp matches, return it.
 576                          * Also move it to the front of the hash list
 577                          * if we find it and it is not already there.
 578                          * Otherwise break from the loop and return
 579                          * NULL.
 580                          */
 581                         if (ip->i_transp == tp) {
 582                                 version = ih->ih_version;
 583                                 read_unlock(&ih->ih_lock);
 584                                 xfs_ihash_promote(ih, ip, version);
 585                                 return (ip);
 586                         }
 587                         break;
 588                 }
 589         }
 590         read_unlock(&ih->ih_lock);
 591         return (NULL);
 592 }
 593
 594 /*
 595  * Decrement reference count of an inode structure and unlock it.
 596  *
 597  * ip -- the inode being released
 598  * lock_flags -- this parameter indicates the inode's locks to be
 599  *       to be released.  See the comment on xfs_iunlock() for a list
 600  *       of valid values.
 601  */
 602 void
 603 xfs_iput(xfs_inode_t    *ip,
 604          uint           lock_flags)
 605 {
 606         vnode_t *vp = XFS_ITOV(ip);
 607
 608         vn_trace_entry(vp, "xfs_iput", (inst_t *)__return_address);
 609
 610         xfs_iunlock(ip, lock_flags);
 611
 612         VN_RELE(vp);
 613 }
 614
 615 /*
 616  * Special iput for brand-new inodes that are still locked
 617  */
 618 void
 619 xfs_iput_new(xfs_inode_t        *ip,
 620              uint               lock_flags)
 621 {
 622         vnode_t         *vp = XFS_ITOV(ip);
 623         struct inode    *inode = vn_to_inode(vp);
 624
 625         vn_trace_entry(vp, "xfs_iput_new", (inst_t *)__return_address);
 626
 627         if ((ip->i_d.di_mode == 0)) {
 628                 ASSERT(!(ip->i_flags & XFS_IRECLAIMABLE));
 629                 vn_mark_bad(vp);
 630         }
 631         if (inode->i_state & I_NEW)
 632                 unlock_new_inode(inode);
 633         if (lock_flags)
 634                 xfs_iunlock(ip, lock_flags);
 635         VN_RELE(vp);
 636 }
 637
 638
 639 /*
 640  * This routine embodies the part of the reclaim code that pulls
 641  * the inode from the inode hash table and the mount structure's
 642  * inode list.
 643  * This should only be called from xfs_reclaim().
 644  */
 645 void
 646 xfs_ireclaim(xfs_inode_t *ip)
 647 {
 648         vnode_t         *vp;
 649
 650         /*
 651          * Remove from old hash list and mount list.
 652          */
 653         XFS_STATS_INC(xs_ig_reclaims);
 654
 655         xfs_iextract(ip);
 656
 657         /*
 658          * Here we do a spurious inode lock in order to coordinate with
 659          * xfs_sync().  This is because xfs_sync() references the inodes
 660          * in the mount list without taking references on the corresponding
 661          * vnodes.  We make that OK here by ensuring that we wait until
 662          * the inode is unlocked in xfs_sync() before we go ahead and
 663          * free it.  We get both the regular lock and the io lock because
 664          * the xfs_sync() code may need to drop the regular one but will
 665          * still hold the io lock.
 666          */
 667         xfs_ilock(ip, XFS_ILOCK_EXCL | XFS_IOLOCK_EXCL);
 668
 669         /*
 670          * Release dquots (and their references) if any. An inode may escape
 671          * xfs_inactive and get here via vn_alloc->vn_reclaim path.
 672          */
 673         XFS_QM_DQDETACH(ip->i_mount, ip);
 674
 675         /*
 676          * Pull our behavior descriptor from the vnode chain.
 677          */
 678         vp = XFS_ITOV_NULL(ip);
 679         if (vp) {
 680                 vn_bhv_remove(VN_BHV_HEAD(vp), XFS_ITOBHV(ip));
 681         }
 682
 683         /*
 684          * Free all memory associated with the inode.
 685          */
 686         xfs_idestroy(ip);
 687 }
 688
 689 /*
 690  * This routine removes an about-to-be-destroyed inode from
 691  * all of the lists in which it is located with the exception
 692  * of the behavior chain.
 693  */
 694 void
 695 xfs_iextract(
 696         xfs_inode_t     *ip)
 697 {
 698         xfs_ihash_t     *ih;
 699         xfs_inode_t     *iq;
 700         xfs_mount_t     *mp;
 701         xfs_chash_t     *ch;
 702         xfs_chashlist_t *chl, *chm;
 703         SPLDECL(s);
 704
 705         ih = ip->i_hash;
 706         write_lock(&ih->ih_lock);
 707         if ((iq = ip->i_next)) {
 708                 iq->i_prevp = ip->i_prevp;
 709         }
 710         *ip->i_prevp = iq;
 711         ih->ih_version++;
 712         write_unlock(&ih->ih_lock);
 713
 714         /*
 715          * Remove from cluster hash list
 716          *   1) delete the chashlist if this is the last inode on the chashlist
 717          *   2) unchain from list of inodes
 718          *   3) point chashlist->chl_ip to 'chl_next' if to this inode.
 719          */
 720         mp = ip->i_mount;
 721         ch = XFS_CHASH(mp, ip->i_blkno);
 722         s = mutex_spinlock(&ch->ch_lock);
 723
 724         if (ip->i_cnext == ip) {
 725                 /* Last inode on chashlist */
 726                 ASSERT(ip->i_cnext == ip && ip->i_cprev == ip);
 727                 ASSERT(ip->i_chash != NULL);
 728                 chm=NULL;
 729                 chl = ip->i_chash;
 730                 if (chl->chl_prev)
 731                         chl->chl_prev->chl_next = chl->chl_next;
 732                 else
 733                         ch->ch_list = chl->chl_next;
 734                 if (chl->chl_next)
 735                         chl->chl_next->chl_prev = chl->chl_prev;
 736                 kmem_zone_free(xfs_chashlist_zone, chl);
 737         } else {
 738                 /* delete one inode from a non-empty list */
 739                 iq = ip->i_cnext;
 740                 iq->i_cprev = ip->i_cprev;
 741                 ip->i_cprev->i_cnext = iq;
 742                 if (ip->i_chash->chl_ip == ip) {
 743                         ip->i_chash->chl_ip = iq;
 744                 }
 745                 ip->i_chash = __return_address;
 746                 ip->i_cprev = __return_address;
 747                 ip->i_cnext = __return_address;
 748         }
 749         mutex_spinunlock(&ch->ch_lock, s);
 750
 751         /*
 752          * Remove from mount's inode list.
 753          */
 754         XFS_MOUNT_ILOCK(mp);
 755         ASSERT((ip->i_mnext != NULL) && (ip->i_mprev != NULL));
 756         iq = ip->i_mnext;
 757         iq->i_mprev = ip->i_mprev;
 758         ip->i_mprev->i_mnext = iq;
 759
 760         /*
 761          * Fix up the head pointer if it points to the inode being deleted.
 762          */
 763         if (mp->m_inodes == ip) {
 764                 if (ip == iq) {
 765                         mp->m_inodes = NULL;
 766                 } else {
 767                         mp->m_inodes = iq;
 768                 }
 769         }
 770
 771         /* Deal with the deleted inodes list */
 772         list_del_init(&ip->i_reclaim);
 773
 774         mp->m_ireclaims++;
 775         XFS_MOUNT_IUNLOCK(mp);
 776 }
 777
 778 /*
 779  * This is a wrapper routine around the xfs_ilock() routine
 780  * used to centralize some grungy code.  It is used in places
 781  * that wish to lock the inode solely for reading the extents.
 782  * The reason these places can't just call xfs_ilock(SHARED)
 783  * is that the inode lock also guards to bringing in of the
 784  * extents from disk for a file in b-tree format.  If the inode
 785  * is in b-tree format, then we need to lock the inode exclusively
 786  * until the extents are read in.  Locking it exclusively all
 787  * the time would limit our parallelism unnecessarily, though.
 788  * What we do instead is check to see if the extents have been
 789  * read in yet, and only lock the inode exclusively if they
 790  * have not.
 791  *
 792  * The function returns a value which should be given to the
 793  * corresponding xfs_iunlock_map_shared().  This value is
 794  * the mode in which the lock was actually taken.
 795  */
 796 uint
 797 xfs_ilock_map_shared(
 798         xfs_inode_t     *ip)
 799 {
 800         uint    lock_mode;
 801
 802         if ((ip->i_d.di_format == XFS_DINODE_FMT_BTREE) &&
 803             ((ip->i_df.if_flags & XFS_IFEXTENTS) == 0)) {
 804                 lock_mode = XFS_ILOCK_EXCL;
 805         } else {
 806                 lock_mode = XFS_ILOCK_SHARED;
 807         }
 808
 809         xfs_ilock(ip, lock_mode);
 810
 811         return lock_mode;
 812 }
 813
 814 /*
 815  * This is simply the unlock routine to go with xfs_ilock_map_shared().
 816  * All it does is call xfs_iunlock() with the given lock_mode.
 817  */
 818 void
 819 xfs_iunlock_map_shared(
 820         xfs_inode_t     *ip,
 821         unsigned int    lock_mode)
 822 {
 823         xfs_iunlock(ip, lock_mode);
 824 }
 825
 826 /*
 827  * The xfs inode contains 2 locks: a multi-reader lock called the
 828  * i_iolock and a multi-reader lock called the i_lock.  This routine
 829  * allows either or both of the locks to be obtained.
 830  *
 831  * The 2 locks should always be ordered so that the IO lock is
 832  * obtained first in order to prevent deadlock.
 833  *
 834  * ip -- the inode being locked
 835  * lock_flags -- this parameter indicates the inode's locks
 836  *       to be locked.  It can be:
 837  *              XFS_IOLOCK_SHARED,
 838  *              XFS_IOLOCK_EXCL,
 839  *              XFS_ILOCK_SHARED,
 840  *              XFS_ILOCK_EXCL,
 841  *              XFS_IOLOCK_SHARED | XFS_ILOCK_SHARED,
 842  *              XFS_IOLOCK_SHARED | XFS_ILOCK_EXCL,
 843  *              XFS_IOLOCK_EXCL | XFS_ILOCK_SHARED,
 844  *              XFS_IOLOCK_EXCL | XFS_ILOCK_EXCL
 845  */
 846 void
 847 xfs_ilock(xfs_inode_t   *ip,
 848           uint          lock_flags)
 849 {
 850         /*
 851          * You can't set both SHARED and EXCL for the same lock,
 852          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 853          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 854          */
 855         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 856                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 857         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 858                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 859         ASSERT((lock_flags & ~XFS_LOCK_MASK) == 0);
 860
 861         if (lock_flags & XFS_IOLOCK_EXCL) {
 862                 mrupdate(&ip->i_iolock);
 863         } else if (lock_flags & XFS_IOLOCK_SHARED) {
 864                 mraccess(&ip->i_iolock);
 865         }
 866         if (lock_flags & XFS_ILOCK_EXCL) {
 867                 mrupdate(&ip->i_lock);
 868         } else if (lock_flags & XFS_ILOCK_SHARED) {
 869                 mraccess(&ip->i_lock);
 870         }
 871         xfs_ilock_trace(ip, 1, lock_flags, (inst_t *)__return_address);
 872 }
 873
 874 /*
 875  * This is just like xfs_ilock(), except that the caller
 876  * is guaranteed not to sleep.  It returns 1 if it gets
 877  * the requested locks and 0 otherwise.  If the IO lock is
 878  * obtained but the inode lock cannot be, then the IO lock
 879  * is dropped before returning.
 880  *
 881  * ip -- the inode being locked
 882  * lock_flags -- this parameter indicates the inode's locks to be
 883  *       to be locked.  See the comment for xfs_ilock() for a list
 884  *       of valid values.
 885  *
 886  */
 887 int
 888 xfs_ilock_nowait(xfs_inode_t    *ip,
 889                  uint           lock_flags)
 890 {
 891         int     iolocked;
 892         int     ilocked;
 893
 894         /*
 895          * You can't set both SHARED and EXCL for the same lock,
 896          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 897          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 898          */
 899         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 900                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 901         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 902                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 903         ASSERT((lock_flags & ~XFS_LOCK_MASK) == 0);
 904
 905         iolocked = 0;
 906         if (lock_flags & XFS_IOLOCK_EXCL) {
 907                 iolocked = mrtryupdate(&ip->i_iolock);
 908                 if (!iolocked) {
 909                         return 0;
 910                 }
 911         } else if (lock_flags & XFS_IOLOCK_SHARED) {
 912                 iolocked = mrtryaccess(&ip->i_iolock);
 913                 if (!iolocked) {
 914                         return 0;
 915                 }
 916         }
 917         if (lock_flags & XFS_ILOCK_EXCL) {
 918                 ilocked = mrtryupdate(&ip->i_lock);
 919                 if (!ilocked) {
 920                         if (iolocked) {
 921                                 mrunlock(&ip->i_iolock);
 922                         }
 923                         return 0;
 924                 }
 925         } else if (lock_flags & XFS_ILOCK_SHARED) {
 926                 ilocked = mrtryaccess(&ip->i_lock);
 927                 if (!ilocked) {
 928                         if (iolocked) {
 929                                 mrunlock(&ip->i_iolock);
 930                         }
 931                         return 0;
 932                 }
 933         }
 934         xfs_ilock_trace(ip, 2, lock_flags, (inst_t *)__return_address);
 935         return 1;
 936 }
 937
 938 /*
 939  * xfs_iunlock() is used to drop the inode locks acquired with
 940  * xfs_ilock() and xfs_ilock_nowait().  The caller must pass
 941  * in the flags given to xfs_ilock() or xfs_ilock_nowait() so
 942  * that we know which locks to drop.
 943  *
 944  * ip -- the inode being unlocked
 945  * lock_flags -- this parameter indicates the inode's locks to be
 946  *       to be unlocked.  See the comment for xfs_ilock() for a list
 947  *       of valid values for this parameter.
 948  *
 949  */
 950 void
 951 xfs_iunlock(xfs_inode_t *ip,
 952             uint        lock_flags)
 953 {
 954         /*
 955          * You can't set both SHARED and EXCL for the same lock,
 956          * and only XFS_IOLOCK_SHARED, XFS_IOLOCK_EXCL, XFS_ILOCK_SHARED,
 957          * and XFS_ILOCK_EXCL are valid values to set in lock_flags.
 958          */
 959         ASSERT((lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) !=
 960                (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL));
 961         ASSERT((lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) !=
 962                (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL));
 963         ASSERT((lock_flags & ~(XFS_LOCK_MASK | XFS_IUNLOCK_NONOTIFY)) == 0);
 964         ASSERT(lock_flags != 0);
 965
 966         if (lock_flags & (XFS_IOLOCK_SHARED | XFS_IOLOCK_EXCL)) {
 967                 ASSERT(!(lock_flags & XFS_IOLOCK_SHARED) ||
 968                        (ismrlocked(&ip->i_iolock, MR_ACCESS)));
 969                 ASSERT(!(lock_flags & XFS_IOLOCK_EXCL) ||
 970                        (ismrlocked(&ip->i_iolock, MR_UPDATE)));
 971                 mrunlock(&ip->i_iolock);
 972         }
 973
 974         if (lock_flags & (XFS_ILOCK_SHARED | XFS_ILOCK_EXCL)) {
 975                 ASSERT(!(lock_flags & XFS_ILOCK_SHARED) ||
 976                        (ismrlocked(&ip->i_lock, MR_ACCESS)));
 977                 ASSERT(!(lock_flags & XFS_ILOCK_EXCL) ||
 978                        (ismrlocked(&ip->i_lock, MR_UPDATE)));
 979                 mrunlock(&ip->i_lock);
 980
 981                 /*
 982                  * Let the AIL know that this item has been unlocked in case
 983                  * it is in the AIL and anyone is waiting on it.  Don't do
 984                  * this if the caller has asked us not to.
 985                  */
 986                 if (!(lock_flags & XFS_IUNLOCK_NONOTIFY) &&
 987                      ip->i_itemp != NULL) {
 988                         xfs_trans_unlocked_item(ip->i_mount,
 989                                                 (xfs_log_item_t*)(ip->i_itemp));
 990                 }
 991         }
 992         xfs_ilock_trace(ip, 3, lock_flags, (inst_t *)__return_address);
 993 }
 994
 995 /*
 996  * give up write locks.  the i/o lock cannot be held nested
 997  * if it is being demoted.
 998  */
 999 void
1000 xfs_ilock_demote(xfs_inode_t    *ip,
1001                  uint           lock_flags)
1002 {
1003         ASSERT(lock_flags & (XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL));
1004         ASSERT((lock_flags & ~(XFS_IOLOCK_EXCL|XFS_ILOCK_EXCL)) == 0);
1005
1006         if (lock_flags & XFS_ILOCK_EXCL) {
1007                 ASSERT(ismrlocked(&ip->i_lock, MR_UPDATE));
1008                 mrdemote(&ip->i_lock);
1009         }
1010         if (lock_flags & XFS_IOLOCK_EXCL) {
1011                 ASSERT(ismrlocked(&ip->i_iolock, MR_UPDATE));
1012                 mrdemote(&ip->i_iolock);
1013         }
1014 }
1015
1016 /*
1017  * The following three routines simply manage the i_flock
1018  * semaphore embedded in the inode.  This semaphore synchronizes
1019  * processes attempting to flush the in-core inode back to disk.
1020  */
1021 void
1022 xfs_iflock(xfs_inode_t *ip)
1023 {
1024         psema(&(ip->i_flock), PINOD|PLTWAIT);
1025 }
1026
1027 int
1028 xfs_iflock_nowait(xfs_inode_t *ip)
1029 {
1030         return (cpsema(&(ip->i_flock)));
1031 }
1032
1033 void
1034 xfs_ifunlock(xfs_inode_t *ip)
1035 {
1036         ASSERT(valusema(&(ip->i_flock)) <= 0);
1037         vsema(&(ip->i_flock));
1038 }