src/vol/vnode.c

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  *
   9  * Portions Copyright (c) 2005-2008 Sine Nomine Associates
  10  */
  11
  12 /*
  13         System:         VICE-TWO
  14         Module:         vnode.c
  15         Institution:    The Information Technology Center, Carnegie-Mellon University
  16
  17  */
  18 #include <afsconfig.h>
  19 #include <afs/param.h>
  20 #define MAXINT     (~(1<<((sizeof(int)*8)-1)))
  21
  22
  23 #include <errno.h>
  24 #include <stdio.h>
  25 #include <string.h>
  26 #include <stdarg.h>
  27 #ifdef AFS_PTHREAD_ENV
  28 #include <assert.h>
  29 #else /* AFS_PTHREAD_ENV */
  30 #include <afs/assert.h>
  31 #endif /* AFS_PTHREAD_ENV */
  32
  33 #include <rx/xdr.h>
  34 #include "rx/rx_queue.h"
  35 #include <afs/afsint.h>
  36 #include "nfs.h"
  37 #include <afs/errors.h>
  38 #include "lock.h"
  39 #include "lwp.h"
  40 #include <afs/afssyscalls.h>
  41 #include "ihandle.h"
  42 #include "vnode.h"
  43 #include "volume.h"
  44 #include "volume_inline.h"
  45 #include "vnode_inline.h"
  46 #include "partition.h"
  47 #include "salvsync.h"
  48 #include "common.h"
  49 #if defined(AFS_SGI_ENV)
  50 #include "sys/types.h"
  51 #include "fcntl.h"
  52 #undef min
  53 #undef max
  54 #include "stdlib.h"
  55 #endif
  56 #ifdef AFS_NT40_ENV
  57 #include <fcntl.h>
  58 #include "ntops.h"
  59 #else
  60 #include <sys/file.h>
  61 #ifdef  AFS_SUN5_ENV
  62 #include <sys/fcntl.h>
  63 #endif
  64 #include <unistd.h>
  65 #endif /* AFS_NT40_ENV */
  66 #include <sys/stat.h>
  67
  68 #ifdef HAVE_STDINT_H
  69 # include <stdint.h>
  70 #endif
  71
  72 struct VnodeClassInfo VnodeClassInfo[nVNODECLASSES];
  73
  74 void VNLog(afs_int32 aop, afs_int32 anparms, ... );
  75
  76 extern int LogLevel;
  77
  78
  79
  80
  81 #define BAD_IGET        -1000
  82
  83 /* There are two separate vnode queue types defined here:
  84  * Each hash conflict chain -- is singly linked, with a single head
  85  * pointer. New entries are added at the beginning. Old
  86  * entries are removed by linear search, which generally
  87  * only occurs after a disk read).
  88  * LRU chain -- is doubly linked, single head pointer.
  89  * Entries are added at the head, reclaimed from the tail,
  90  * or removed from anywhere in the queue.
  91  */
  92
  93
  94 /* Vnode hash table.  Find hash chain by taking lower bits of
  95  * (volume_hash_offset + vnode).
  96  * This distributes the root inodes of the volumes over the
  97  * hash table entries and also distributes the vnodes of
  98  * volumes reasonably fairly.  The volume_hash_offset field
  99  * for each volume is established as the volume comes on line
 100  * by using the VOLUME_HASH_OFFSET macro.  This distributes the
 101  * volumes fairly among the cache entries, both when servicing
 102  * a small number of volumes and when servicing a large number.
 103  */
 104
 105 /* logging stuff for finding bugs */
 106 #define THELOGSIZE      5120
 107 static afs_int32 theLog[THELOGSIZE];
 108 static afs_int32 vnLogPtr = 0;
 109 void
 110 VNLog(afs_int32 aop, afs_int32 anparms, ... )
 111 {
 112     afs_int32 temp;
 113     va_list ap;
 114
 115     va_start(ap, anparms);
 116
 117     if (anparms > 4)
 118         anparms = 4;            /* do bounds checking */
 119
 120     temp = (aop << 16) | anparms;
 121     theLog[vnLogPtr++] = temp;
 122     if (vnLogPtr >= THELOGSIZE)
 123         vnLogPtr = 0;
 124     for (temp = 0; temp < anparms; temp++) {
 125         theLog[vnLogPtr++] = va_arg(ap, afs_int32);
 126         if (vnLogPtr >= THELOGSIZE)
 127             vnLogPtr = 0;
 128     }
 129     va_end(ap);
 130 }
 131
 132 /* VolumeHashOffset -- returns a new value to be stored in the
 133  * volumeHashOffset of a Volume structure.  Called when a
 134  * volume is initialized.  Sets the volumeHashOffset so that
 135  * vnode cache entries are distributed reasonably between
 136  * volumes (the root vnodes of the volumes will hash to
 137  * different values, and spacing is maintained between volumes
 138  * when there are not many volumes represented), and spread
 139  * equally amongst vnodes within a single volume.
 140  */
 141 int
 142 VolumeHashOffset_r(void)
 143 {
 144     static int nextVolumeHashOffset = 0;
 145     /* hashindex Must be power of two in size */
 146 #   define hashShift 3
 147 #   define hashMask ((1<<hashShift)-1)
 148     static byte hashindex[1 << hashShift] =
 149         { 0, 128, 64, 192, 32, 160, 96, 224 };
 150     int offset;
 151     offset = hashindex[nextVolumeHashOffset & hashMask]
 152         + (nextVolumeHashOffset >> hashShift);
 153     nextVolumeHashOffset++;
 154     return offset;
 155 }
 156
 157 /* Change hashindex (above) if you change this constant */
 158 #define VNODE_HASH_TABLE_SIZE 256
 159 private Vnode *VnodeHashTable[VNODE_HASH_TABLE_SIZE];
 160 #define VNODE_HASH(volumeptr,vnodenumber)\
 161     ((volumeptr->vnodeHashOffset + vnodenumber)&(VNODE_HASH_TABLE_SIZE-1))
 162
 163
 164 /**
 165  * add a vnode to the volume's vnode list.
 166  *
 167  * @param[in] vp   volume object pointer
 168  * @param[in] vnp  vnode object pointer
 169  *
 170  * @note for DAFS, it may seem like we should be acquiring a lightweight ref
 171  *       on vp, but this would actually break things.  Right now, this is ok
 172  *       because we destroy all vnode cache contents during during volume
 173  *       detach.
 174  *
 175  * @pre VOL_LOCK held
 176  *
 177  * @internal volume package internal use only
 178  */
 179 void
 180 AddToVVnList(Volume * vp, Vnode * vnp)
 181 {
 182     if (queue_IsOnQueue(vnp))
 183         return;
 184
 185     Vn_volume(vnp) = vp;
 186     Vn_cacheCheck(vnp) = vp->cacheCheck;
 187     queue_Append(&vp->vnode_list, vnp);
 188     Vn_stateFlags(vnp) |= VN_ON_VVN;
 189 }
 190
 191 /**
 192  * delete a vnode from the volume's vnode list.
 193  *
 194  * @pre VOL_LOCK held
 195  *
 196  * @internal volume package internal use only
 197  */
 198 void
 199 DeleteFromVVnList(Vnode * vnp)
 200 {
 201     Vn_volume(vnp) = NULL;
 202
 203     if (!queue_IsOnQueue(vnp))
 204         return;
 205
 206     queue_Remove(vnp);
 207     Vn_stateFlags(vnp) &= ~(VN_ON_VVN);
 208 }
 209
 210 /**
 211  * add a vnode to the end of the lru.
 212  *
 213  * @param[in] vcp  vnode class info object pointer
 214  * @param[in] vnp  vnode object pointer
 215  *
 216  * @internal vnode package internal use only
 217  */
 218 void
 219 AddToVnLRU(struct VnodeClassInfo * vcp, Vnode * vnp)
 220 {
 221     if (Vn_stateFlags(vnp) & VN_ON_LRU) {
 222         return;
 223     }
 224
 225     /* Add it to the circular LRU list */
 226     if (vcp->lruHead == NULL)
 227         Abort("VPutVnode: vcp->lruHead==NULL");
 228     else {
 229         vnp->lruNext = vcp->lruHead;
 230         vnp->lruPrev = vcp->lruHead->lruPrev;
 231         vcp->lruHead->lruPrev = vnp;
 232         vnp->lruPrev->lruNext = vnp;
 233         vcp->lruHead = vnp;
 234     }
 235
 236     /* If the vnode was just deleted, put it at the end of the chain so it
 237      * will be reused immediately */
 238     if (vnp->delete)
 239         vcp->lruHead = vnp->lruNext;
 240
 241     Vn_stateFlags(vnp) |= VN_ON_LRU;
 242 }
 243
 244 /**
 245  * delete a vnode from the lru.
 246  *
 247  * @param[in] vcp  vnode class info object pointer
 248  * @param[in] vnp  vnode object pointer
 249  *
 250  * @internal vnode package internal use only
 251  */
 252 void
 253 DeleteFromVnLRU(struct VnodeClassInfo * vcp, Vnode * vnp)
 254 {
 255     if (!(Vn_stateFlags(vnp) & VN_ON_LRU)) {
 256         return;
 257     }
 258
 259     if (vnp == vcp->lruHead)
 260         vcp->lruHead = vcp->lruHead->lruNext;
 261
 262     if ((vnp == vcp->lruHead) ||
 263         (vcp->lruHead == NULL))
 264         Abort("DeleteFromVnLRU: lru chain addled!\n");
 265
 266     vnp->lruPrev->lruNext = vnp->lruNext;
 267     vnp->lruNext->lruPrev = vnp->lruPrev;
 268
 269     Vn_stateFlags(vnp) &= ~(VN_ON_LRU);
 270 }
 271
 272 /**
 273  * add a vnode to the vnode hash table.
 274  *
 275  * @param[in] vnp  vnode object pointer
 276  *
 277  * @pre VOL_LOCK held
 278  *
 279  * @post vnode on hash
 280  *
 281  * @internal vnode package internal use only
 282  */
 283 void
 284 AddToVnHash(Vnode * vnp)
 285 {
 286     unsigned int newHash;
 287
 288     if (!(Vn_stateFlags(vnp) & VN_ON_HASH)) {
 289         newHash = VNODE_HASH(Vn_volume(vnp), Vn_id(vnp));
 290         vnp->hashNext = VnodeHashTable[newHash];
 291         VnodeHashTable[newHash] = vnp;
 292         vnp->hashIndex = newHash;
 293
 294         Vn_stateFlags(vnp) |= VN_ON_HASH;
 295     }
 296 }
 297
 298 /**
 299  * delete a vnode from the vnode hash table.
 300  *
 301  * @param[in] vnp
 302  * @param[in] hash
 303  *
 304  * @pre VOL_LOCK held
 305  *
 306  * @post vnode removed from hash
 307  *
 308  * @internal vnode package internal use only
 309  */
 310 void
 311 DeleteFromVnHash(Vnode * vnp)
 312 {
 313     Vnode * tvnp;
 314
 315     if (Vn_stateFlags(vnp) & VN_ON_HASH) {
 316         tvnp = VnodeHashTable[vnp->hashIndex];
 317         if (tvnp == vnp)
 318             VnodeHashTable[vnp->hashIndex] = vnp->hashNext;
 319         else {
 320             while (tvnp && tvnp->hashNext != vnp)
 321                 tvnp = tvnp->hashNext;
 322             if (tvnp)
 323                 tvnp->hashNext = vnp->hashNext;
 324         }
 325
 326         vnp->hashNext = NULL;
 327         vnp->hashIndex = 0;
 328         Vn_stateFlags(vnp) &= ~(VN_ON_HASH);
 329     }
 330 }
 331
 332
 333 /**
 334  * invalidate a vnode cache entry.
 335  *
 336  * @param[in] avnode   vnode object pointer
 337  *
 338  * @pre VOL_LOCK held
 339  *
 340  * @post vnode metadata invalidated.
 341  *       vnode removed from hash table.
 342  *       DAFS: vnode state set to VN_STATE_INVALID.
 343  *
 344  * @internal vnode package internal use only
 345  */
 346 void
 347 VInvalidateVnode_r(struct Vnode *avnode)
 348 {
 349     avnode->changed_newTime = 0;        /* don't let it get flushed out again */
 350     avnode->changed_oldTime = 0;
 351     avnode->delete = 0;         /* it isn't deleted, really */
 352     avnode->cacheCheck = 0;     /* invalid: prevents future vnode searches from working */
 353     DeleteFromVnHash(avnode);
 354 #ifdef AFS_DEMAND_ATTACH_FS
 355     VnChangeState_r(avnode, VN_STATE_INVALID);
 356 #endif
 357 }
 358
 359
 360 /**
 361  * initialize vnode cache for a given vnode class.
 362  *
 363  * @param[in] class    vnode class
 364  * @param[in] nVnodes  size of cache
 365  *
 366  * @post vnode cache allocated and initialized
 367  *
 368  * @internal volume package internal use only
 369  *
 370  * @note generally called by VInitVolumePackage_r
 371  *
 372  * @see VInitVolumePackage_r
 373  */
 374 int
 375 VInitVnodes(VnodeClass class, int nVnodes)
 376 {
 377     byte *va;
 378     struct VnodeClassInfo *vcp = &VnodeClassInfo[class];
 379
 380     vcp->allocs = vcp->gets = vcp->reads = vcp->writes = 0;
 381     vcp->cacheSize = nVnodes;
 382     switch (class) {
 383     case vSmall:
 384         assert(CHECKSIZE_SMALLVNODE);
 385         vcp->lruHead = NULL;
 386         vcp->residentSize = SIZEOF_SMALLVNODE;
 387         vcp->diskSize = SIZEOF_SMALLDISKVNODE;
 388         vcp->magic = SMALLVNODEMAGIC;
 389         break;
 390     case vLarge:
 391         vcp->lruHead = NULL;
 392         vcp->residentSize = SIZEOF_LARGEVNODE;
 393         vcp->diskSize = SIZEOF_LARGEDISKVNODE;
 394         vcp->magic = LARGEVNODEMAGIC;
 395         break;
 396     }
 397     {
 398         int s = vcp->diskSize - 1;
 399         int n = 0;
 400         while (s)
 401             s >>= 1, n++;
 402         vcp->logSize = n;
 403     }
 404
 405     if (nVnodes == 0)
 406         return 0;
 407
 408     va = (byte *) calloc(nVnodes, vcp->residentSize);
 409     assert(va != NULL);
 410     while (nVnodes--) {
 411         Vnode *vnp = (Vnode *) va;
 412         Vn_refcount(vnp) = 0;   /* no context switches */
 413         Vn_stateFlags(vnp) |= VN_ON_LRU;
 414 #ifdef AFS_DEMAND_ATTACH_FS
 415         assert(pthread_cond_init(&Vn_stateCV(vnp), NULL) == 0);
 416         Vn_state(vnp) = VN_STATE_INVALID;
 417         Vn_readers(vnp) = 0;
 418 #else /* !AFS_DEMAND_ATTACH_FS */
 419         Lock_Init(&vnp->lock);
 420 #endif /* !AFS_DEMAND_ATTACH_FS */
 421         vnp->changed_oldTime = 0;
 422         vnp->changed_newTime = 0;
 423         Vn_volume(vnp) = NULL;
 424         Vn_cacheCheck(vnp) = 0;
 425         vnp->delete = Vn_id(vnp) = 0;
 426 #ifdef AFS_PTHREAD_ENV
 427         vnp->writer = (pthread_t) 0;
 428 #else /* AFS_PTHREAD_ENV */
 429         vnp->writer = (PROCESS) 0;
 430 #endif /* AFS_PTHREAD_ENV */
 431         vnp->hashIndex = 0;
 432         vnp->handle = NULL;
 433         Vn_class(vnp) = vcp;
 434         if (vcp->lruHead == NULL)
 435             vcp->lruHead = vnp->lruNext = vnp->lruPrev = vnp;
 436         else {
 437             vnp->lruNext = vcp->lruHead;
 438             vnp->lruPrev = vcp->lruHead->lruPrev;
 439             vcp->lruHead->lruPrev = vnp;
 440             vnp->lruPrev->lruNext = vnp;
 441             vcp->lruHead = vnp;
 442         }
 443         va += vcp->residentSize;
 444     }
 445     return 0;
 446 }
 447
 448
 449 /**
 450  * allocate an unused vnode from the lru chain.
 451  *
 452  * @param[in] vcp  vnode class info object pointer
 453  *
 454  * @pre VOL_LOCK is held
 455  *
 456  * @post vnode object is removed from lru, and vnode hash table.
 457  *       vnode is disassociated from volume object.
 458  *       state is set to VN_STATE_INVALID.
 459  *       inode handle is released.
 460  *
 461  * @note we traverse backwards along the lru circlist.  It shouldn't
 462  *       be necessary to specify that nUsers == 0 since if it is in the list,
 463  *       nUsers should be 0.  Things shouldn't be in lruq unless no one is
 464  *       using them.
 465  *
 466  * @warning DAFS: VOL_LOCK is dropped while doing inode handle release
 467  *
 468  * @return vnode object pointer
 469  */
 470 Vnode *
 471 VGetFreeVnode_r(struct VnodeClassInfo * vcp)
 472 {
 473     Vnode *vnp;
 474
 475     vnp = vcp->lruHead->lruPrev;
 476 #ifdef AFS_DEMAND_ATTACH_FS
 477     if (Vn_refcount(vnp) != 0 || VnIsExclusiveState(Vn_state(vnp)) ||
 478         Vn_readers(vnp) != 0)
 479         Abort("VGetFreeVnode_r: in-use vnode in lruq");
 480 #else
 481     if (Vn_refcount(vnp) != 0 || CheckLock(&vnp->lock))
 482         Abort("VGetFreeVnode_r: locked vnode in lruq");
 483 #endif
 484     VNLog(1, 2, Vn_id(vnp), (intptr_t)vnp, 0, 0);
 485
 486     /*
 487      * it's going to be overwritten soon enough.
 488      * remove from LRU, delete hash entry, and
 489      * disassociate from old parent volume before
 490      * we have a chance to drop the vol glock
 491      */
 492     DeleteFromVnLRU(vcp, vnp);
 493     DeleteFromVnHash(vnp);
 494     if (Vn_volume(vnp)) {
 495         DeleteFromVVnList(vnp);
 496     }
 497
 498     /* drop the file descriptor */
 499     if (vnp->handle) {
 500 #ifdef AFS_DEMAND_ATTACH_FS
 501         VnChangeState_r(vnp, VN_STATE_RELEASING);
 502         VOL_UNLOCK;
 503 #endif
 504         /* release is, potentially, a highly latent operation due to a couple
 505          * factors:
 506          *   - ihandle package lock contention
 507          *   - closing file descriptor(s) associated with ih
 508          *
 509          * Hance, we perform outside of the volume package lock in order to
 510          * reduce the probability of contention.
 511          */
 512         IH_RELEASE(vnp->handle);
 513 #ifdef AFS_DEMAND_ATTACH_FS
 514         VOL_LOCK;
 515 #endif
 516     }
 517
 518 #ifdef AFS_DEMAND_ATTACH_FS
 519     VnChangeState_r(vnp, VN_STATE_INVALID);
 520 #endif
 521
 522     return vnp;
 523 }
 524
 525
 526 /**
 527  * lookup a vnode in the vnode cache hash table.
 528  *
 529  * @param[in] vp       pointer to volume object
 530  * @param[in] vnodeId  vnode id
 531  *
 532  * @pre VOL_LOCK held
 533  *
 534  * @post matching vnode object or NULL is returned
 535  *
 536  * @return vnode object pointer
 537  *   @retval NULL   no matching vnode object was found in the cache
 538  *
 539  * @internal vnode package internal use only
 540  *
 541  * @note this symbol is exported strictly for fssync debug protocol use
 542  */
 543 Vnode *
 544 VLookupVnode(Volume * vp, VnodeId vnodeId)
 545 {
 546     Vnode * vnp;
 547     unsigned int newHash;
 548
 549     newHash = VNODE_HASH(vp, vnodeId);
 550     for (vnp = VnodeHashTable[newHash];
 551          (vnp &&
 552           ((Vn_id(vnp) != vnodeId) ||
 553            (Vn_volume(vnp) != vp) ||
 554            (vp->cacheCheck != Vn_cacheCheck(vnp))));
 555          vnp = vnp->hashNext);
 556
 557     return vnp;
 558 }
 559
 560
 561 Vnode *
 562 VAllocVnode(Error * ec, Volume * vp, VnodeType type)
 563 {
 564     Vnode *retVal;
 565     VOL_LOCK;
 566     retVal = VAllocVnode_r(ec, vp, type);
 567     VOL_UNLOCK;
 568     return retVal;
 569 }
 570
 571 /**
 572  * allocate a new vnode.
 573  *
 574  * @param[out] ec    error code return
 575  * @param[in]  vp    volume object pointer
 576  * @param[in]  type  desired vnode type
 577  *
 578  * @return vnode object pointer
 579  *
 580  * @pre VOL_LOCK held;
 581  *      heavyweight ref held on vp
 582  *
 583  * @post vnode allocated and returned
 584  */
 585 Vnode *
 586 VAllocVnode_r(Error * ec, Volume * vp, VnodeType type)
 587 {
 588     Vnode *vnp;
 589     VnodeId vnodeNumber;
 590     int bitNumber;
 591     struct VnodeClassInfo *vcp;
 592     VnodeClass class;
 593     Unique unique;
 594 #ifdef AFS_DEMAND_ATTACH_FS
 595     VolState vol_state_save;
 596 #endif
 597
 598     *ec = 0;
 599
 600 #ifdef AFS_DEMAND_ATTACH_FS
 601     /*
 602      * once a volume has entered an error state, don't permit
 603      * further operations to proceed
 604      *  -- tkeiser 11/21/2007
 605      */
 606     VWaitExclusiveState_r(vp);
 607     if (VIsErrorState(V_attachState(vp))) {
 608         /* XXX is VSALVAGING acceptable here? */
 609         *ec = DAFS_VSALVAGE;
 610         return NULL;
 611     }
 612 #endif
 613
 614     if (programType == fileServer && !V_inUse(vp)) {
 615         if (vp->specialStatus) {
 616             *ec = vp->specialStatus;
 617         } else {
 618             *ec = VOFFLINE;
 619         }
 620         return NULL;
 621     }
 622     class = vnodeTypeToClass(type);
 623     vcp = &VnodeClassInfo[class];
 624
 625     if (!VolumeWriteable(vp)) {
 626         *ec = (bit32) VREADONLY;
 627         return NULL;
 628     }
 629
 630     unique = vp->nextVnodeUnique++;
 631     if (!unique)
 632         unique = vp->nextVnodeUnique++;
 633
 634     if (vp->nextVnodeUnique > V_uniquifier(vp)) {
 635         VUpdateVolume_r(ec, vp, 0);
 636         if (*ec)
 637             return NULL;
 638     }
 639
 640     if (programType == fileServer) {
 641         VAddToVolumeUpdateList_r(ec, vp);
 642         if (*ec)
 643             return NULL;
 644     }
 645
 646     /* Find a slot in the bit map */
 647     bitNumber = VAllocBitmapEntry_r(ec, vp, &vp->vnodeIndex[class],
 648                                     VOL_ALLOC_BITMAP_WAIT);
 649     if (*ec)
 650         return NULL;
 651     vnodeNumber = bitNumberToVnodeNumber(bitNumber, class);
 652
 653     /*
 654      * DAFS:
 655      * at this point we should be assured that V_attachState(vp) is non-exclusive
 656      */
 657
 658  vnrehash:
 659     VNLog(2, 1, vnodeNumber, 0, 0, 0);
 660     /* Prepare to move it to the new hash chain */
 661     vnp = VLookupVnode(vp, vnodeNumber);
 662     if (vnp) {
 663         /* slot already exists.  May even not be in lruq (consider store file locking a file being deleted)
 664          * so we may have to wait for it below */
 665         VNLog(3, 2, vnodeNumber, (intptr_t)vnp, 0, 0);
 666
 667         VnCreateReservation_r(vnp);
 668         if (Vn_refcount(vnp) == 1) {
 669             /* we're the only user */
 670             /* This won't block */
 671             VnLock(vnp, WRITE_LOCK, VOL_LOCK_HELD, WILL_NOT_DEADLOCK);
 672         } else {
 673             /* other users present; follow locking hierarchy */
 674             VnLock(vnp, WRITE_LOCK, VOL_LOCK_HELD, MIGHT_DEADLOCK);
 675
 676 #ifdef AFS_DEMAND_ATTACH_FS
 677             /*
 678              * DAFS:
 679              * vnode was cached, wait for any existing exclusive ops to finish.
 680              * once we have reacquired the lock, re-verify volume state.
 681              *
 682              * note: any vnode error state is related to the old vnode; disregard.
 683              */
 684             VnWaitQuiescent_r(vnp);
 685             if (VIsErrorState(V_attachState(vp))) {
 686                 VnUnlock(vnp, WRITE_LOCK);
 687                 VnCancelReservation_r(vnp);
 688                 *ec = DAFS_VSALVAGE;
 689                 return NULL;
 690             }
 691 #endif
 692
 693             /*
 694              * verify state of the world hasn't changed
 695              *
 696              * (technically, this should never happen because cachecheck
 697              *  is only updated during a volume attach, which should not
 698              *  happen when refs are held)
 699              */
 700             if (Vn_volume(vnp)->cacheCheck != Vn_cacheCheck(vnp)) {
 701                 VnUnlock(vnp, WRITE_LOCK);
 702                 VnCancelReservation_r(vnp);
 703                 goto vnrehash;
 704             }
 705         }
 706
 707     } else {
 708         /* no such vnode in the cache */
 709
 710         vnp = VGetFreeVnode_r(vcp);
 711
 712         /* Initialize the header fields so noone allocates another
 713          * vnode with the same number */
 714         Vn_id(vnp) = vnodeNumber;
 715         VnCreateReservation_r(vnp);
 716         AddToVVnList(vp, vnp);
 717 #ifdef AFS_DEMAND_ATTACH_FS
 718         AddToVnHash(vnp);
 719 #endif
 720
 721         /* This will never block (guaranteed by check in VGetFreeVnode_r() */
 722         VnLock(vnp, WRITE_LOCK, VOL_LOCK_HELD, WILL_NOT_DEADLOCK);
 723
 724 #ifdef AFS_DEMAND_ATTACH_FS
 725         VnChangeState_r(vnp, VN_STATE_ALLOC);
 726 #endif
 727
 728         /* Sanity check:  is this vnode really not in use? */
 729         {
 730             afs_sfsize_t size;
 731             IHandle_t *ihP = vp->vnodeIndex[class].handle;
 732             FdHandle_t *fdP;
 733             afs_foff_t off = vnodeIndexOffset(vcp, vnodeNumber);
 734             Error tmp;
 735
 736             /* XXX we have a potential race here if two threads
 737              * allocate new vnodes at the same time, and they
 738              * both decide it's time to extend the index
 739              * file size...
 740              */
 741 #ifdef AFS_DEMAND_ATTACH_FS
 742             /*
 743              * this race has been eliminated for the DAFS case
 744              * using exclusive state VOL_STATE_VNODE_ALLOC
 745              *
 746              * if this becomes a bottleneck, there are ways to
 747              * improve parallelism for this code path
 748              *   -- tkeiser 11/28/2007
 749              */
 750             VCreateReservation_r(vp);
 751             VWaitExclusiveState_r(vp);
 752             vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_ALLOC);
 753 #endif
 754
 755             VOL_UNLOCK;
 756             fdP = IH_OPEN(ihP);
 757             if (fdP == NULL) {
 758                 Log("VAllocVnode: can't open index file!\n");
 759                 *ec = ENOENT;
 760                 goto error_encountered;
 761             }
 762             if ((size = FDH_SIZE(fdP)) < 0) {
 763                 Log("VAllocVnode: can't stat index file!\n");
 764                 *ec = EIO;
 765                 goto error_encountered;
 766             }
 767             if (off + vcp->diskSize <= size) {
 768               if (FDH_PREAD(fdP, &vnp->disk, vcp->diskSize, off) != vcp->diskSize) {
 769                     Log("VAllocVnode: can't read index file!\n");
 770                     *ec = EIO;
 771                     goto error_encountered;
 772                 }
 773                 if (vnp->disk.type != vNull) {
 774                     Log("VAllocVnode:  addled bitmap or index!\n");
 775                     *ec = EIO;
 776                     goto error_encountered;
 777                 }
 778             } else {
 779                 /* growing file - grow in a reasonable increment */
 780                 char *buf = (char *)malloc(16 * 1024);
 781                 if (!buf) {
 782                     Log("VAllocVnode: can't grow vnode index: out of memory\n");
 783                     *ec = ENOMEM;
 784                     goto error_encountered;
 785                 }
 786                 memset(buf, 0, 16 * 1024);
 787                 if ((FDH_PWRITE(fdP, buf, 16 * 1024, off)) != 16 * 1024) {
 788                     Log("VAllocVnode: can't grow vnode index: write failed\n");
 789                     *ec = EIO;
 790                     free(buf);
 791                     goto error_encountered;
 792                 }
 793                 free(buf);
 794             }
 795             FDH_CLOSE(fdP);
 796             VOL_LOCK;
 797
 798 #ifdef AFS_DEMAND_ATTACH_FS
 799             VChangeState_r(vp, vol_state_save);
 800             VCancelReservation_r(vp);
 801 #endif
 802             goto sane;
 803
 804
 805         error_encountered:
 806             /*
 807              * close the file handle
 808              * acquire VOL_LOCK
 809              * invalidate the vnode
 810              * free up the bitmap entry (although salvager should take care of it)
 811              * salvage the volume
 812              * drop vnode lock and refs
 813              */
 814             if (fdP)
 815                 FDH_CLOSE(fdP);
 816             VOL_LOCK;
 817             VFreeBitMapEntry_r(&tmp, &vp->vnodeIndex[class], bitNumber);
 818             VInvalidateVnode_r(vnp);
 819             VnUnlock(vnp, WRITE_LOCK);
 820             VnCancelReservation_r(vnp);
 821 #ifdef AFS_DEMAND_ATTACH_FS
 822             VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
 823             VCancelReservation_r(vp);
 824 #else
 825             VForceOffline_r(vp, 0);
 826 #endif
 827             return NULL;
 828         }
 829     sane:
 830         VNLog(4, 2, vnodeNumber, (intptr_t)vnp, 0, 0);
 831 #ifndef AFS_DEMAND_ATTACH_FS
 832         AddToVnHash(vnp);
 833 #endif
 834     }
 835
 836     VNLog(5, 1, (intptr_t)vnp, 0, 0, 0);
 837     memset(&vnp->disk, 0, sizeof(vnp->disk));
 838     vnp->changed_newTime = 0;   /* set this bit when vnode is updated */
 839     vnp->changed_oldTime = 0;   /* set this on CopyOnWrite. */
 840     vnp->delete = 0;
 841     vnp->disk.vnodeMagic = vcp->magic;
 842     vnp->disk.type = type;
 843     vnp->disk.uniquifier = unique;
 844     vnp->handle = NULL;
 845     vcp->allocs++;
 846     vp->header->diskstuff.filecount++;
 847 #ifdef AFS_DEMAND_ATTACH_FS
 848     VnChangeState_r(vnp, VN_STATE_EXCLUSIVE);
 849 #endif
 850     return vnp;
 851 }
 852
 853 /**
 854  * load a vnode from disk.
 855  *
 856  * @param[out] ec     client error code return
 857  * @param[in]  vp     volume object pointer
 858  * @param[in]  vnp    vnode object pointer
 859  * @param[in]  vcp    vnode class info object pointer
 860  * @param[in]  class  vnode class enumeration
 861  *
 862  * @pre vnode is registered in appropriate data structures;
 863  *      caller holds a ref on vnode; VOL_LOCK is held
 864  *
 865  * @post vnode data is loaded from disk.
 866  *       vnode state is set to VN_STATE_ONLINE.
 867  *       on failure, vnode is invalidated.
 868  *
 869  * @internal vnode package internal use only
 870  */
 871 static void
 872 VnLoad(Error * ec, Volume * vp, Vnode * vnp,
 873        struct VnodeClassInfo * vcp, VnodeClass class)
 874 {
 875     /* vnode not cached */
 876     Error error;
 877     int dosalv = 1;
 878     ssize_t nBytes;
 879     IHandle_t *ihP = vp->vnodeIndex[class].handle;
 880     FdHandle_t *fdP;
 881     afs_ino_str_t stmp;
 882
 883     *ec = 0;
 884     vcp->reads++;
 885
 886 #ifdef AFS_DEMAND_ATTACH_FS
 887     VnChangeState_r(vnp, VN_STATE_LOAD);
 888 #endif
 889
 890     /* This will never block */
 891     VnLock(vnp, WRITE_LOCK, VOL_LOCK_HELD, WILL_NOT_DEADLOCK);
 892
 893     VOL_UNLOCK;
 894     fdP = IH_OPEN(ihP);
 895     if (fdP == NULL) {
 896         Log("VnLoad: can't open index dev=%u, i=%s\n", vp->device,
 897             PrintInode(stmp, vp->vnodeIndex[class].handle->ih_ino));
 898         *ec = VIO;
 899         goto error_encountered_nolock;
 900     } else if ((nBytes = FDH_PREAD(fdP, (char *)&vnp->disk, vcp->diskSize, vnodeIndexOffset(vcp, Vn_id(vnp))))
 901                != vcp->diskSize) {
 902         /* Don't take volume off line if the inumber is out of range
 903          * or the inode table is full. */
 904         if (nBytes == BAD_IGET) {
 905             Log("VnLoad: bad inumber %s\n",
 906                 PrintInode(stmp, vp->vnodeIndex[class].handle->ih_ino));
 907             *ec = VIO;
 908             dosalv = 0;
 909         } else if (nBytes == -1 && errno == EIO) {
 910             /* disk error; salvage */
 911             Log("VnLoad: Couldn't read vnode %u, volume %u (%s); volume needs salvage\n", Vn_id(vnp), V_id(vp), V_name(vp));
 912         } else {
 913             /* vnode is not allocated */
 914             if (LogLevel >= 5)
 915                 Log("VnLoad: Couldn't read vnode %u, volume %u (%s); read %d bytes, errno %d\n",
 916                     Vn_id(vnp), V_id(vp), V_name(vp), (int)nBytes, errno);
 917             *ec = VIO;
 918             dosalv = 0;
 919         }
 920         goto error_encountered_nolock;
 921     }
 922     FDH_CLOSE(fdP);
 923     VOL_LOCK;
 924
 925     /* Quick check to see that the data is reasonable */
 926     if (vnp->disk.vnodeMagic != vcp->magic || vnp->disk.type == vNull) {
 927         if (vnp->disk.type == vNull) {
 928             *ec = VNOVNODE;
 929             dosalv = 0;
 930         } else {
 931             struct vnodeIndex *index = &vp->vnodeIndex[class];
 932             unsigned int bitNumber = vnodeIdToBitNumber(Vn_id(vnp));
 933             unsigned int offset = bitNumber >> 3;
 934
 935             /* Test to see if vnode number is valid. */
 936             if ((offset >= index->bitmapSize)
 937                 || ((*(index->bitmap + offset) & (1 << (bitNumber & 0x7)))
 938                     == 0)) {
 939                 Log("VnLoad: Request for unallocated vnode %u, volume %u (%s) denied.\n", Vn_id(vnp), V_id(vp), V_name(vp));
 940                 *ec = VNOVNODE;
 941                 dosalv = 0;
 942             } else {
 943                 Log("VnLoad: Bad magic number, vnode %u, volume %u (%s); volume needs salvage\n", Vn_id(vnp), V_id(vp), V_name(vp));
 944             }
 945         }
 946         goto error_encountered;
 947     }
 948
 949     IH_INIT(vnp->handle, V_device(vp), V_parentId(vp), VN_GET_INO(vnp));
 950     VnUnlock(vnp, WRITE_LOCK);
 951 #ifdef AFS_DEMAND_ATTACH_FS
 952     VnChangeState_r(vnp, VN_STATE_ONLINE);
 953 #endif
 954     return;
 955
 956
 957  error_encountered_nolock:
 958     if (fdP) {
 959         FDH_REALLYCLOSE(fdP);
 960     }
 961     VOL_LOCK;
 962
 963  error_encountered:
 964     if (dosalv) {
 965 #ifdef AFS_DEMAND_ATTACH_FS
 966         VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, 0);
 967 #else
 968         VForceOffline_r(vp, 0);
 969         error = VSALVAGE;
 970 #endif
 971         if (!*ec)
 972             *ec = error;
 973     }
 974
 975     VInvalidateVnode_r(vnp);
 976     VnUnlock(vnp, WRITE_LOCK);
 977 }
 978
 979 /**
 980  * store a vnode to disk.
 981  *
 982  * @param[out] ec     error code output
 983  * @param[in]  vp     volume object pointer
 984  * @param[in]  vnp    vnode object pointer
 985  * @param[in]  vcp    vnode class info object pointer
 986  * @param[in]  class  vnode class enumeration
 987  *
 988  * @pre VOL_LOCK held.
 989  *      caller holds refs to volume and vnode.
 990  *      DAFS: caller is responsible for performing state sanity checks.
 991  *
 992  * @post vnode state is stored to disk.
 993  *
 994  * @internal vnode package internal use only
 995  */
 996 static void
 997 VnStore(Error * ec, Volume * vp, Vnode * vnp,
 998         struct VnodeClassInfo * vcp, VnodeClass class)
 999 {
1000     ssize_t nBytes;
1001     afs_foff_t offset;
1002     IHandle_t *ihP = vp->vnodeIndex[class].handle;
1003     FdHandle_t *fdP;
1004     afs_ino_str_t stmp;
1005 #ifdef AFS_DEMAND_ATTACH_FS
1006     VnState vn_state_save;
1007 #endif
1008
1009     *ec = 0;
1010
1011 #ifdef AFS_DEMAND_ATTACH_FS
1012     vn_state_save = VnChangeState_r(vnp, VN_STATE_STORE);
1013 #endif
1014
1015     offset = vnodeIndexOffset(vcp, Vn_id(vnp));
1016     VOL_UNLOCK;
1017     fdP = IH_OPEN(ihP);
1018     if (fdP == NULL) {
1019         Log("VnStore: can't open index file!\n");
1020         goto error_encountered;
1021     }
1022     nBytes = FDH_PWRITE(fdP, &vnp->disk, vcp->diskSize, offset);
1023     if (nBytes != vcp->diskSize) {
1024         /* Don't force volume offline if the inumber is out of
1025          * range or the inode table is full.
1026          */
1027         FDH_REALLYCLOSE(fdP);
1028         if (nBytes == BAD_IGET) {
1029             Log("VnStore: bad inumber %s\n",
1030                 PrintInode(stmp,
1031                            vp->vnodeIndex[class].handle->ih_ino));
1032             *ec = VIO;
1033             VOL_LOCK;
1034 #ifdef AFS_DEMAND_ATTACH_FS
1035             VnChangeState_r(vnp, VN_STATE_ERROR);
1036 #endif
1037         } else {
1038             Log("VnStore: Couldn't write vnode %u, volume %u (%s) (error %d)\n", Vn_id(vnp), V_id(Vn_volume(vnp)), V_name(Vn_volume(vnp)), (int)nBytes);
1039 #ifdef AFS_DEMAND_ATTACH_FS
1040             goto error_encountered;
1041 #else
1042             VOL_LOCK;
1043             VForceOffline_r(vp, 0);
1044             *ec = VSALVAGE;
1045 #endif
1046         }
1047         return;
1048     } else {
1049         FDH_CLOSE(fdP);
1050     }
1051
1052     VOL_LOCK;
1053 #ifdef AFS_DEMAND_ATTACH_FS
1054     VnChangeState_r(vnp, vn_state_save);
1055 #endif
1056     return;
1057
1058  error_encountered:
1059 #ifdef AFS_DEMAND_ATTACH_FS
1060     /* XXX instead of dumping core, let's try to request a salvage
1061      * and just fail the putvnode */
1062     if (fdP)
1063         FDH_CLOSE(fdP);
1064     VOL_LOCK;
1065     VnChangeState_r(vnp, VN_STATE_ERROR);
1066     VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1067 #else
1068     assert(1 == 2);
1069 #endif
1070 }
1071
1072 /**
1073  * get a handle to a vnode object.
1074  *
1075  * @param[out] ec           error code
1076  * @param[in]  vp           volume object
1077  * @param[in]  vnodeNumber  vnode id
1078  * @param[in]  locktype     type of lock to acquire
1079  *
1080  * @return vnode object pointer
1081  *
1082  * @see VGetVnode_r
1083  */
1084 Vnode *
1085 VGetVnode(Error * ec, Volume * vp, VnodeId vnodeNumber, int locktype)
1086 {                               /* READ_LOCK or WRITE_LOCK, as defined in lock.h */
1087     Vnode *retVal;
1088     VOL_LOCK;
1089     retVal = VGetVnode_r(ec, vp, vnodeNumber, locktype);
1090     VOL_UNLOCK;
1091     return retVal;
1092 }
1093
1094 /**
1095  * get a handle to a vnode object.
1096  *
1097  * @param[out] ec           error code
1098  * @param[in]  vp           volume object
1099  * @param[in]  vnodeNumber  vnode id
1100  * @param[in]  locktype     type of lock to acquire
1101  *
1102  * @return vnode object pointer
1103  *
1104  * @internal vnode package internal use only
1105  *
1106  * @pre VOL_LOCK held.
1107  *      heavyweight ref held on volume object.
1108  */
1109 Vnode *
1110 VGetVnode_r(Error * ec, Volume * vp, VnodeId vnodeNumber, int locktype)
1111 {                               /* READ_LOCK or WRITE_LOCK, as defined in lock.h */
1112     Vnode *vnp;
1113     VnodeClass class;
1114     struct VnodeClassInfo *vcp;
1115
1116     *ec = 0;
1117
1118     if (vnodeNumber == 0) {
1119         *ec = VNOVNODE;
1120         return NULL;
1121     }
1122
1123     VNLog(100, 1, vnodeNumber, 0, 0, 0);
1124
1125 #ifdef AFS_DEMAND_ATTACH_FS
1126     /*
1127      * once a volume has entered an error state, don't permit
1128      * further operations to proceed
1129      *  -- tkeiser 11/21/2007
1130      */
1131     VWaitExclusiveState_r(vp);
1132     if (VIsErrorState(V_attachState(vp))) {
1133         /* XXX is VSALVAGING acceptable here? */
1134         *ec = VSALVAGING;
1135         return NULL;
1136     }
1137 #endif
1138
1139     if (programType == fileServer && !V_inUse(vp)) {
1140         *ec = (vp->specialStatus ? vp->specialStatus : VOFFLINE);
1141
1142         /* If the volume is VBUSY (being cloned or dumped) and this is
1143          * a READ operation, then don't fail.
1144          */
1145         if ((*ec != VBUSY) || (locktype != READ_LOCK)) {
1146             return NULL;
1147         }
1148         *ec = 0;
1149     }
1150     class = vnodeIdToClass(vnodeNumber);
1151     vcp = &VnodeClassInfo[class];
1152     if (locktype == WRITE_LOCK && !VolumeWriteable(vp)) {
1153         *ec = (bit32) VREADONLY;
1154         return NULL;
1155     }
1156
1157     if (locktype == WRITE_LOCK && programType == fileServer) {
1158         VAddToVolumeUpdateList_r(ec, vp);
1159         if (*ec) {
1160             return NULL;
1161         }
1162     }
1163
1164     vcp->gets++;
1165
1166     /* See whether the vnode is in the cache. */
1167     vnp = VLookupVnode(vp, vnodeNumber);
1168     if (vnp) {
1169         /* vnode is in cache */
1170
1171         VNLog(101, 2, vnodeNumber, (intptr_t)vnp, 0, 0);
1172         VnCreateReservation_r(vnp);
1173
1174 #ifdef AFS_DEMAND_ATTACH_FS
1175         /*
1176          * this is the one DAFS case where we may run into contention.
1177          * here's the basic control flow:
1178          *
1179          * if locktype is READ_LOCK:
1180          *   wait until vnode is not exclusive
1181          *   set to VN_STATE_READ
1182          *   increment read count
1183          *   done
1184          * else
1185          *   wait until vnode is quiescent
1186          *   set to VN_STATE_EXCLUSIVE
1187          *   done
1188          */
1189         if (locktype == READ_LOCK) {
1190             VnWaitExclusiveState_r(vnp);
1191         } else {
1192             VnWaitQuiescent_r(vnp);
1193         }
1194
1195         if (VnIsErrorState(Vn_state(vnp))) {
1196             VnCancelReservation_r(vnp);
1197             *ec = VSALVAGE;
1198             return NULL;
1199         }
1200 #endif /* AFS_DEMAND_ATTACH_FS */
1201     } else {
1202         /* vnode not cached */
1203
1204         /* Not in cache; tentatively grab most distantly used one from the LRU
1205          * chain */
1206         vcp->reads++;
1207         vnp = VGetFreeVnode_r(vcp);
1208
1209         /* Initialize */
1210         vnp->changed_newTime = vnp->changed_oldTime = 0;
1211         vnp->delete = 0;
1212         Vn_id(vnp) = vnodeNumber;
1213         VnCreateReservation_r(vnp);
1214         AddToVVnList(vp, vnp);
1215 #ifdef AFS_DEMAND_ATTACH_FS
1216         AddToVnHash(vnp);
1217 #endif
1218
1219         /*
1220          * XXX for non-DAFS, there is a serious
1221          * race condition here:
1222          *
1223          * two threads can race to load a vnode.  the net
1224          * result is two struct Vnodes can be allocated
1225          * and hashed, which point to the same underlying
1226          * disk data store.  conflicting vnode locks can
1227          * thus be held concurrently.
1228          *
1229          * for non-DAFS to be safe, VOL_LOCK really shouldn't
1230          * be dropped in VnLoad.  Of course, this would likely
1231          * lead to an unacceptable slow-down.
1232          */
1233
1234         VnLoad(ec, vp, vnp, vcp, class);
1235         if (*ec) {
1236             VnCancelReservation_r(vnp);
1237             return NULL;
1238         }
1239 #ifndef AFS_DEMAND_ATTACH_FS
1240         AddToVnHash(vnp);
1241 #endif
1242         /*
1243          * DAFS:
1244          * there is no possibility for contention. we "own" this vnode.
1245          */
1246     }
1247
1248     /*
1249      * DAFS:
1250      * it is imperative that nothing drop vol lock between here
1251      * and the VnBeginRead/VnChangeState stanza below
1252      */
1253
1254     VnLock(vnp, locktype, VOL_LOCK_HELD, MIGHT_DEADLOCK);
1255
1256     /* Check that the vnode hasn't been removed while we were obtaining
1257      * the lock */
1258     VNLog(102, 2, vnodeNumber, (intptr_t) vnp, 0, 0);
1259     if ((vnp->disk.type == vNull) || (Vn_cacheCheck(vnp) == 0)) {
1260         VnUnlock(vnp, locktype);
1261         VnCancelReservation_r(vnp);
1262         *ec = VNOVNODE;
1263         /* vnode is labelled correctly by now, so we don't have to invalidate it */
1264         return NULL;
1265     }
1266
1267 #ifdef AFS_DEMAND_ATTACH_FS
1268     if (locktype == READ_LOCK) {
1269         VnBeginRead_r(vnp);
1270     } else {
1271         VnChangeState_r(vnp, VN_STATE_EXCLUSIVE);
1272     }
1273 #endif
1274
1275     if (programType == fileServer)
1276         VBumpVolumeUsage_r(Vn_volume(vnp));     /* Hack; don't know where it should be
1277                                                  * called from.  Maybe VGetVolume */
1278     return vnp;
1279 }
1280
1281
1282 int TrustVnodeCacheEntry = 1;
1283 /* This variable is bogus--when it's set to 0, the hash chains fill
1284    up with multiple versions of the same vnode.  Should fix this!! */
1285 void
1286 VPutVnode(Error * ec, Vnode * vnp)
1287 {
1288     VOL_LOCK;
1289     VPutVnode_r(ec, vnp);
1290     VOL_UNLOCK;
1291 }
1292
1293 /**
1294  * put back a handle to a vnode object.
1295  *
1296  * @param[out] ec   client error code
1297  * @param[in]  vnp  vnode object pointer
1298  *
1299  * @pre VOL_LOCK held.
1300  *      ref held on vnode.
1301  *
1302  * @post ref dropped on vnode.
1303  *       if vnode was modified or deleted, it is written out to disk
1304  *       (assuming a write lock was held).
1305  *
1306  * @internal volume package internal use only
1307  */
1308 void
1309 VPutVnode_r(Error * ec, Vnode * vnp)
1310 {
1311     int writeLocked;
1312     VnodeClass class;
1313     struct VnodeClassInfo *vcp;
1314
1315     *ec = 0;
1316     assert(Vn_refcount(vnp) != 0);
1317     class = vnodeIdToClass(Vn_id(vnp));
1318     vcp = &VnodeClassInfo[class];
1319     assert(vnp->disk.vnodeMagic == vcp->magic);
1320     VNLog(200, 2, Vn_id(vnp), (intptr_t) vnp, 0, 0);
1321
1322 #ifdef AFS_DEMAND_ATTACH_FS
1323     writeLocked = (Vn_state(vnp) == VN_STATE_EXCLUSIVE);
1324 #else
1325     writeLocked = WriteLocked(&vnp->lock);
1326 #endif
1327
1328     if (writeLocked) {
1329         /* sanity checks */
1330 #ifdef AFS_PTHREAD_ENV
1331         pthread_t thisProcess = pthread_self();
1332 #else /* AFS_PTHREAD_ENV */
1333         PROCESS thisProcess;
1334         LWP_CurrentProcess(&thisProcess);
1335 #endif /* AFS_PTHREAD_ENV */
1336         VNLog(201, 2, (intptr_t) vnp,
1337               ((vnp->changed_newTime) << 1) | ((vnp->
1338                                                 changed_oldTime) << 1) | vnp->
1339               delete, 0, 0);
1340         if (thisProcess != vnp->writer)
1341             Abort("VPutVnode: Vnode at %"AFS_PTR_FMT" locked by another process!\n",
1342                   vnp);
1343
1344
1345         if (vnp->changed_oldTime || vnp->changed_newTime || vnp->delete) {
1346             Volume *vp = Vn_volume(vnp);
1347             afs_uint32 now = FT_ApproxTime();
1348             assert(Vn_cacheCheck(vnp) == vp->cacheCheck);
1349
1350             if (vnp->delete) {
1351                 /* No longer any directory entries for this vnode. Free the Vnode */
1352                 memset(&vnp->disk, 0, sizeof(vnp->disk));
1353                 /* delete flag turned off further down */
1354                 VNLog(202, 2, Vn_id(vnp), (intptr_t) vnp, 0, 0);
1355             } else if (vnp->changed_newTime) {
1356                 vnp->disk.serverModifyTime = now;
1357             }
1358             if (vnp->changed_newTime)
1359             {
1360                 V_updateDate(vp) = vp->updateTime = now;
1361                 if(V_volUpCounter(vp)<MAXINT)
1362                         V_volUpCounter(vp)++;
1363             }
1364
1365             /* The vnode has been changed. Write it out to disk */
1366             if (!V_inUse(vp)) {
1367 #ifdef AFS_DEMAND_ATTACH_FS
1368                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1369 #else
1370                 assert(V_needsSalvaged(vp));
1371                 *ec = VSALVAGE;
1372 #endif
1373             } else {
1374                 VnStore(ec, vp, vnp, vcp, class);
1375
1376                 /* If the vnode is to be deleted, and we wrote the vnode out,
1377                  * free its bitmap entry. Do after the vnode is written so we
1378                  * don't allocate from bitmap before the vnode is written
1379                  * (doing so could cause a "addled bitmap" message).
1380                  */
1381                 if (vnp->delete && !*ec) {
1382                     if (Vn_volume(vnp)->header->diskstuff.filecount-- < 1)
1383                         Vn_volume(vnp)->header->diskstuff.filecount = 0;
1384                     VFreeBitMapEntry_r(ec, &vp->vnodeIndex[class],
1385                                        vnodeIdToBitNumber(Vn_id(vnp)));
1386                 }
1387             }
1388             vcp->writes++;
1389             vnp->changed_newTime = vnp->changed_oldTime = 0;
1390         }
1391 #ifdef AFS_DEMAND_ATTACH_FS
1392         VnChangeState_r(vnp, VN_STATE_ONLINE);
1393 #endif
1394     } else {                    /* Not write locked */
1395         if (vnp->changed_newTime || vnp->changed_oldTime || vnp->delete)
1396             Abort
1397                 ("VPutVnode: Change or delete flag for vnode "
1398                  "%"AFS_PTR_FMT" is set but vnode is not write locked!\n",
1399                  vnp);
1400 #ifdef AFS_DEMAND_ATTACH_FS
1401         VnEndRead_r(vnp);
1402 #endif
1403     }
1404
1405     /* Do not look at disk portion of vnode after this point; it may
1406      * have been deleted above */
1407     vnp->delete = 0;
1408     VnUnlock(vnp, ((writeLocked) ? WRITE_LOCK : READ_LOCK));
1409     VnCancelReservation_r(vnp);
1410 }
1411
1412 /*
1413  * Make an attempt to convert a vnode lock from write to read.
1414  * Do nothing if the vnode isn't write locked or the vnode has
1415  * been deleted.
1416  */
1417 int
1418 VVnodeWriteToRead(Error * ec, Vnode * vnp)
1419 {
1420     int retVal;
1421     VOL_LOCK;
1422     retVal = VVnodeWriteToRead_r(ec, vnp);
1423     VOL_UNLOCK;
1424     return retVal;
1425 }
1426
1427 /**
1428  * convert vnode handle from mutually exclusive to shared access.
1429  *
1430  * @param[out] ec   client error code
1431  * @param[in]  vnp  vnode object pointer
1432  *
1433  * @return unspecified use (see out argument 'ec' for error code return)
1434  *
1435  * @pre VOL_LOCK held.
1436  *      ref held on vnode.
1437  *      write lock held on vnode.
1438  *
1439  * @post read lock held on vnode.
1440  *       if vnode was modified, it has been written to disk.
1441  *
1442  * @internal volume package internal use only
1443  */
1444 int
1445 VVnodeWriteToRead_r(Error * ec, Vnode * vnp)
1446 {
1447     int writeLocked;
1448     VnodeClass class;
1449     struct VnodeClassInfo *vcp;
1450 #ifdef AFS_PTHREAD_ENV
1451     pthread_t thisProcess;
1452 #else /* AFS_PTHREAD_ENV */
1453     PROCESS thisProcess;
1454 #endif /* AFS_PTHREAD_ENV */
1455
1456     *ec = 0;
1457     assert(Vn_refcount(vnp) != 0);
1458     class = vnodeIdToClass(Vn_id(vnp));
1459     vcp = &VnodeClassInfo[class];
1460     assert(vnp->disk.vnodeMagic == vcp->magic);
1461     VNLog(300, 2, Vn_id(vnp), (intptr_t) vnp, 0, 0);
1462
1463 #ifdef AFS_DEMAND_ATTACH_FS
1464     writeLocked = (Vn_state(vnp) == VN_STATE_EXCLUSIVE);
1465 #else
1466     writeLocked = WriteLocked(&vnp->lock);
1467 #endif
1468     if (!writeLocked) {
1469         return 0;
1470     }
1471
1472
1473     VNLog(301, 2, (intptr_t) vnp,
1474           ((vnp->changed_newTime) << 1) | ((vnp->
1475                                             changed_oldTime) << 1) | vnp->
1476           delete, 0, 0);
1477
1478     /* sanity checks */
1479 #ifdef AFS_PTHREAD_ENV
1480     thisProcess = pthread_self();
1481 #else /* AFS_PTHREAD_ENV */
1482     LWP_CurrentProcess(&thisProcess);
1483 #endif /* AFS_PTHREAD_ENV */
1484     if (thisProcess != vnp->writer)
1485         Abort("VPutVnode: Vnode at %"AFS_PTR_FMT
1486               " locked by another process!\n", vnp);
1487
1488     if (vnp->delete) {
1489         return 0;
1490     }
1491     if (vnp->changed_oldTime || vnp->changed_newTime) {
1492         Volume *vp = Vn_volume(vnp);
1493         afs_uint32 now = FT_ApproxTime();
1494         assert(Vn_cacheCheck(vnp) == vp->cacheCheck);
1495         if (vnp->changed_newTime)
1496             vnp->disk.serverModifyTime = now;
1497         if (vnp->changed_newTime)
1498             V_updateDate(vp) = vp->updateTime = now;
1499
1500         /* The inode has been changed.  Write it out to disk */
1501         if (!V_inUse(vp)) {
1502 #ifdef AFS_DEMAND_ATTACH_FS
1503             VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1504 #else
1505             assert(V_needsSalvaged(vp));
1506             *ec = VSALVAGE;
1507 #endif
1508         } else {
1509             VnStore(ec, vp, vnp, vcp, class);
1510         }
1511         vcp->writes++;
1512         vnp->changed_newTime = vnp->changed_oldTime = 0;
1513     }
1514
1515     vnp->writer = 0;
1516 #ifdef AFS_DEMAND_ATTACH_FS
1517     VnChangeState_r(vnp, VN_STATE_ONLINE);
1518     VnBeginRead_r(vnp);
1519 #else
1520     ConvertWriteToReadLock(&vnp->lock);
1521 #endif
1522     return 0;
1523 }
1524
1525 /**
1526  * initial size of ihandle pointer vector.
1527  *
1528  * @see VInvalidateVnodesByVolume_r
1529  */
1530 #define IH_VEC_BASE_SIZE 256
1531
1532 /**
1533  * increment amount for growing ihandle pointer vector.
1534  *
1535  * @see VInvalidateVnodesByVolume_r
1536  */
1537 #define IH_VEC_INCREMENT 256
1538
1539 /**
1540  * Compile list of ihandles to be released/reallyclosed at a later time.
1541  *
1542  * @param[in]   vp            volume object pointer
1543  * @param[out]  vec_out       vector of ihandle pointers to be released/reallyclosed
1544  * @param[out]  vec_len_out   number of valid elements in ihandle vector
1545  *
1546  * @pre - VOL_LOCK is held
1547  *      - volume is in appropriate exclusive state (e.g. VOL_STATE_VNODE_CLOSE,
1548  *        VOL_STATE_VNODE_RELEASE)
1549  *
1550  * @post - all vnodes on VVn list are invalidated
1551  *       - ih_vec is populated with all valid ihandles
1552  *
1553  * @return operation status
1554  *    @retval 0         success
1555  *    @retval ENOMEM    out of memory
1556  *
1557  * @todo we should handle out of memory conditions more gracefully.
1558  *
1559  * @internal vnode package internal use only
1560  */
1561 static int
1562 VInvalidateVnodesByVolume_r(Volume * vp,
1563                             IHandle_t *** vec_out,
1564                             size_t * vec_len_out)
1565 {
1566     int ret = 0;
1567     Vnode *vnp, *nvnp;
1568     size_t i = 0, vec_len;
1569     IHandle_t **ih_vec, **ih_vec_new;
1570
1571 #ifdef AFS_DEMAND_ATTACH_FS
1572     VOL_UNLOCK;
1573 #endif /* AFS_DEMAND_ATTACH_FS */
1574
1575     vec_len = IH_VEC_BASE_SIZE;
1576     ih_vec = malloc(sizeof(IHandle_t *) * vec_len);
1577 #ifdef AFS_DEMAND_ATTACH_FS
1578     VOL_LOCK;
1579 #endif
1580     if (ih_vec == NULL)
1581         return ENOMEM;
1582
1583     /*
1584      * Traverse the volume's vnode list.  Pull all the ihandles out into a
1585      * thread-private array for later asynchronous processing.
1586      */
1587 #ifdef AFS_DEMAND_ATTACH_FS
1588 restart_traversal:
1589 #endif
1590     for (queue_Scan(&vp->vnode_list, vnp, nvnp, Vnode)) {
1591         if (vnp->handle != NULL) {
1592             if (i == vec_len) {
1593 #ifdef AFS_DEMAND_ATTACH_FS
1594                 VOL_UNLOCK;
1595 #endif
1596                 vec_len += IH_VEC_INCREMENT;
1597                 ih_vec_new = realloc(ih_vec, sizeof(IHandle_t *) * vec_len);
1598 #ifdef AFS_DEMAND_ATTACH_FS
1599                 VOL_LOCK;
1600 #endif
1601                 if (ih_vec_new == NULL) {
1602                     ret = ENOMEM;
1603                     goto done;
1604                 }
1605                 ih_vec = ih_vec_new;
1606 #ifdef AFS_DEMAND_ATTACH_FS
1607                 /*
1608                  * Theoretically, the volume's VVn list should not change
1609                  * because the volume is in an exclusive state.  For the
1610                  * sake of safety, we will restart the traversal from the
1611                  * the beginning (which is not expensive because we're
1612                  * deleting the items from the list as we go).
1613                  */
1614                 goto restart_traversal;
1615 #endif
1616             }
1617             ih_vec[i++] = vnp->handle;
1618             vnp->handle = NULL;
1619         }
1620         DeleteFromVVnList(vnp);
1621         VInvalidateVnode_r(vnp);
1622     }
1623
1624  done:
1625     *vec_out = ih_vec;
1626     *vec_len_out = i;
1627
1628     return ret;
1629 }
1630
1631 /* VCloseVnodeFiles - called when a volume is going off line. All open
1632  * files for vnodes in that volume are closed. This might be excessive,
1633  * since we may only be taking one volume of a volume group offline.
1634  */
1635 void
1636 VCloseVnodeFiles_r(Volume * vp)
1637 {
1638 #ifdef AFS_DEMAND_ATTACH_FS
1639     VolState vol_state_save;
1640 #endif
1641     IHandle_t ** ih_vec;
1642     size_t i, vec_len;
1643
1644 #ifdef AFS_DEMAND_ATTACH_FS
1645     vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_CLOSE);
1646 #endif /* AFS_DEMAND_ATTACH_FS */
1647
1648     /* XXX need better error handling here */
1649     assert(VInvalidateVnodesByVolume_r(vp,
1650                                        &ih_vec,
1651                                        &vec_len) == 0);
1652
1653     /*
1654      * DAFS:
1655      * now we drop VOL_LOCK while we perform some potentially very
1656      * expensive operations in the background
1657      */
1658 #ifdef AFS_DEMAND_ATTACH_FS
1659     VOL_UNLOCK;
1660 #endif
1661
1662     for (i = 0; i < vec_len; i++) {
1663         IH_REALLYCLOSE(ih_vec[i]);
1664     }
1665
1666     free(ih_vec);
1667
1668 #ifdef AFS_DEMAND_ATTACH_FS
1669     VOL_LOCK;
1670     VChangeState_r(vp, vol_state_save);
1671 #endif /* AFS_DEMAND_ATTACH_FS */
1672 }
1673
1674
1675 /**
1676  * shut down all vnode cache state for a given volume.
1677  *
1678  * @param[in] vp  volume object pointer
1679  *
1680  * @pre VOL_LOCK is held
1681  *
1682  * @post all file descriptors closed.
1683  *       all inode handles released.
1684  *       all vnode cache objects disassociated from volume.
1685  *
1686  * @note for DAFS, these operations are performed outside the vol glock under
1687  *       volume exclusive state VOL_STATE_VNODE_RELEASE.  Please further note
1688  *       that it would be a bug to acquire and release a volume reservation
1689  *       during this exclusive operation.  This is due to the fact that we are
1690  *       generally called during the refcount 1->0 transition.
1691  *
1692  * @todo we should handle failures in VInvalidateVnodesByVolume_r more
1693  *       gracefully.
1694  *
1695  * @see VInvalidateVnodesByVolume_r
1696  *
1697  * @internal this routine is internal to the volume package
1698  */
1699 void
1700 VReleaseVnodeFiles_r(Volume * vp)
1701 {
1702 #ifdef AFS_DEMAND_ATTACH_FS
1703     VolState vol_state_save;
1704 #endif
1705     IHandle_t ** ih_vec;
1706     size_t i, vec_len;
1707
1708 #ifdef AFS_DEMAND_ATTACH_FS
1709     vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_RELEASE);
1710 #endif /* AFS_DEMAND_ATTACH_FS */
1711
1712     /* XXX need better error handling here */
1713     assert(VInvalidateVnodesByVolume_r(vp,
1714                                        &ih_vec,
1715                                        &vec_len) == 0);
1716
1717     /*
1718      * DAFS:
1719      * now we drop VOL_LOCK while we perform some potentially very
1720      * expensive operations in the background
1721      */
1722 #ifdef AFS_DEMAND_ATTACH_FS
1723     VOL_UNLOCK;
1724 #endif
1725
1726     for (i = 0; i < vec_len; i++) {
1727         IH_RELEASE(ih_vec[i]);
1728     }
1729
1730     free(ih_vec);
1731
1732 #ifdef AFS_DEMAND_ATTACH_FS
1733     VOL_LOCK;
1734     VChangeState_r(vp, vol_state_save);
1735 #endif /* AFS_DEMAND_ATTACH_FS */
1736 }