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 #if defined(AFS_SGI_ENV)
  49 #include "sys/types.h"
  50 #include "fcntl.h"
  51 #undef min
  52 #undef max
  53 #include "stdlib.h"
  54 #endif
  55 #ifdef AFS_NT40_ENV
  56 #include <fcntl.h>
  57 #include "ntops.h"
  58 #else
  59 #include <sys/file.h>
  60 #ifdef  AFS_SUN5_ENV
  61 #include <sys/fcntl.h>
  62 #endif
  63 #include <unistd.h>
  64 #endif /* AFS_NT40_ENV */
  65 #include <sys/stat.h>
  66
  67 /*@printflike@*/ extern void Log(const char *format, ...);
  68
  69 /*@printflike@*/ extern void Abort(const char *format, ...);
  70
  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     register 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(register 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(register 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     register 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     register 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), (afs_int32) 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     register Vnode *vnp;
 589     VnodeId vnodeNumber;
 590     int bitNumber;
 591     register 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, (afs_int32) 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             int size;
 731             IHandle_t *ihP = vp->vnodeIndex[class].handle;
 732             FdHandle_t *fdP;
 733             off_t off = vnodeIndexOffset(vcp, vnodeNumber);
 734
 735             /* XXX we have a potential race here if two threads
 736              * allocate new vnodes at the same time, and they
 737              * both decide it's time to extend the index
 738              * file size...
 739              */
 740 #ifdef AFS_DEMAND_ATTACH_FS
 741             /*
 742              * this race has been eliminated for the DAFS case
 743              * using exclusive state VOL_STATE_VNODE_ALLOC
 744              *
 745              * if this becomes a bottleneck, there are ways to
 746              * improve parallelism for this code path
 747              *   -- tkeiser 11/28/2007
 748              */
 749             VCreateReservation_r(vp);
 750             VWaitExclusiveState_r(vp);
 751             vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_ALLOC);
 752 #endif
 753
 754             VOL_UNLOCK;
 755             fdP = IH_OPEN(ihP);
 756             if (fdP == NULL) {
 757                 Log("VAllocVnode: can't open index file!\n");
 758                 goto error_encountered;
 759             }
 760             if ((size = FDH_SIZE(fdP)) < 0) {
 761                 Log("VAllocVnode: can't stat index file!\n");
 762                 goto error_encountered;
 763             }
 764             if (FDH_SEEK(fdP, off, SEEK_SET) < 0) {
 765                 Log("VAllocVnode: can't seek on index file!\n");
 766                 goto error_encountered;
 767             }
 768             if (off + vcp->diskSize <= size) {
 769                 if (FDH_READ(fdP, &vnp->disk, vcp->diskSize) != vcp->diskSize) {
 770                     Log("VAllocVnode: can't read index file!\n");
 771                     goto error_encountered;
 772                 }
 773                 if (vnp->disk.type != vNull) {
 774                     Log("VAllocVnode:  addled bitmap or index!\n");
 775                     goto error_encountered;
 776                 }
 777             } else {
 778                 /* growing file - grow in a reasonable increment */
 779                 char *buf = (char *)malloc(16 * 1024);
 780                 if (!buf)
 781                     Abort("VAllocVnode: malloc failed\n");
 782                 memset(buf, 0, 16 * 1024);
 783                 (void)FDH_WRITE(fdP, buf, 16 * 1024);
 784                 free(buf);
 785             }
 786             FDH_CLOSE(fdP);
 787             VOL_LOCK;
 788
 789 #ifdef AFS_DEMAND_ATTACH_FS
 790             VChangeState_r(vp, vol_state_save);
 791             VCancelReservation_r(vp);
 792 #endif
 793             goto sane;
 794
 795
 796         error_encountered:
 797 #ifdef AFS_DEMAND_ATTACH_FS
 798             /*
 799              * close the file handle
 800              * acquire VOL_LOCK
 801              * invalidate the vnode
 802              * free up the bitmap entry (although salvager should take care of it)
 803              * salvage the volume
 804              * drop vnode lock and refs
 805              */
 806             if (fdP)
 807                 FDH_CLOSE(fdP);
 808             VOL_LOCK;
 809             VFreeBitMapEntry_r(ec, &vp->vnodeIndex[class], bitNumber);
 810             VInvalidateVnode_r(vnp);
 811             VnUnlock(vnp, WRITE_LOCK);
 812             VnCancelReservation_r(vnp);
 813             VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
 814             VCancelReservation_r(vp);
 815             return NULL;
 816 #else
 817             assert(1 == 2);
 818 #endif
 819
 820         }
 821     sane:
 822         VNLog(4, 2, vnodeNumber, (afs_int32) vnp, 0, 0);
 823 #ifndef AFS_DEMAND_ATTACH_FS
 824         AddToVnHash(vnp);
 825 #endif
 826     }
 827
 828     VNLog(5, 1, (afs_int32) vnp, 0, 0, 0);
 829     memset(&vnp->disk, 0, sizeof(vnp->disk));
 830     vnp->changed_newTime = 0;   /* set this bit when vnode is updated */
 831     vnp->changed_oldTime = 0;   /* set this on CopyOnWrite. */
 832     vnp->delete = 0;
 833     vnp->disk.vnodeMagic = vcp->magic;
 834     vnp->disk.type = type;
 835     vnp->disk.uniquifier = unique;
 836     vnp->handle = NULL;
 837     vcp->allocs++;
 838     vp->header->diskstuff.filecount++;
 839 #ifdef AFS_DEMAND_ATTACH_FS
 840     VnChangeState_r(vnp, VN_STATE_EXCLUSIVE);
 841 #endif
 842     return vnp;
 843 }
 844
 845 /**
 846  * load a vnode from disk.
 847  *
 848  * @param[out] ec     client error code return
 849  * @param[in]  vp     volume object pointer
 850  * @param[in]  vnp    vnode object pointer
 851  * @param[in]  vcp    vnode class info object pointer
 852  * @param[in]  class  vnode class enumeration
 853  *
 854  * @pre vnode is registered in appropriate data structures;
 855  *      caller holds a ref on vnode; VOL_LOCK is held
 856  *
 857  * @post vnode data is loaded from disk.
 858  *       vnode state is set to VN_STATE_ONLINE.
 859  *       on failure, vnode is invalidated.
 860  *
 861  * @internal vnode package internal use only
 862  */
 863 static void
 864 VnLoad(Error * ec, Volume * vp, Vnode * vnp,
 865        struct VnodeClassInfo * vcp, VnodeClass class)
 866 {
 867     /* vnode not cached */
 868     Error error;
 869     int n, dosalv = 1;
 870     IHandle_t *ihP = vp->vnodeIndex[class].handle;
 871     FdHandle_t *fdP;
 872
 873     *ec = 0;
 874     vcp->reads++;
 875
 876 #ifdef AFS_DEMAND_ATTACH_FS
 877     VnChangeState_r(vnp, VN_STATE_LOAD);
 878 #endif
 879
 880     /* This will never block */
 881     VnLock(vnp, WRITE_LOCK, VOL_LOCK_HELD, WILL_NOT_DEADLOCK);
 882
 883     VOL_UNLOCK;
 884     fdP = IH_OPEN(ihP);
 885     if (fdP == NULL) {
 886         Log("VnLoad: can't open index dev=%u, i=%s\n", vp->device,
 887             PrintInode(NULL, vp->vnodeIndex[class].handle->ih_ino));
 888         *ec = VIO;
 889         goto error_encountered_nolock;
 890     } else if (FDH_SEEK(fdP, vnodeIndexOffset(vcp, Vn_id(vnp)), SEEK_SET)
 891                < 0) {
 892         Log("VnLoad: can't seek on index file vn=%u\n", Vn_id(vnp));
 893         *ec = VIO;
 894         goto error_encountered_nolock;
 895     } else if ((n = FDH_READ(fdP, (char *)&vnp->disk, vcp->diskSize))
 896                != vcp->diskSize) {
 897         /* Don't take volume off line if the inumber is out of range
 898          * or the inode table is full. */
 899         if (n == BAD_IGET) {
 900             Log("VnLoad: bad inumber %s\n",
 901                 PrintInode(NULL, vp->vnodeIndex[class].handle->ih_ino));
 902             *ec = VIO;
 903             dosalv = 0;
 904         } else if (n == -1 && errno == EIO) {
 905             /* disk error; salvage */
 906             Log("VnLoad: Couldn't read vnode %u, volume %u (%s); volume needs salvage\n", Vn_id(vnp), V_id(vp), V_name(vp));
 907         } else {
 908             /* vnode is not allocated */
 909             if (LogLevel >= 5)
 910                 Log("VnLoad: Couldn't read vnode %u, volume %u (%s); read %d bytes, errno %d\n",
 911                     Vn_id(vnp), V_id(vp), V_name(vp), n, errno);
 912             *ec = VIO;
 913             dosalv = 0;
 914         }
 915         goto error_encountered_nolock;
 916     }
 917     FDH_CLOSE(fdP);
 918     VOL_LOCK;
 919
 920     /* Quick check to see that the data is reasonable */
 921     if (vnp->disk.vnodeMagic != vcp->magic || vnp->disk.type == vNull) {
 922         if (vnp->disk.type == vNull) {
 923             *ec = VNOVNODE;
 924             dosalv = 0;
 925         } else {
 926             struct vnodeIndex *index = &vp->vnodeIndex[class];
 927             unsigned int bitNumber = vnodeIdToBitNumber(Vn_id(vnp));
 928             unsigned int offset = bitNumber >> 3;
 929
 930             /* Test to see if vnode number is valid. */
 931             if ((offset >= index->bitmapSize)
 932                 || ((*(index->bitmap + offset) & (1 << (bitNumber & 0x7)))
 933                     == 0)) {
 934                 Log("VnLoad: Request for unallocated vnode %u, volume %u (%s) denied.\n", Vn_id(vnp), V_id(vp), V_name(vp));
 935                 *ec = VNOVNODE;
 936                 dosalv = 0;
 937             } else {
 938                 Log("VnLoad: Bad magic number, vnode %u, volume %u (%s); volume needs salvage\n", Vn_id(vnp), V_id(vp), V_name(vp));
 939             }
 940         }
 941         goto error_encountered;
 942     }
 943
 944     IH_INIT(vnp->handle, V_device(vp), V_parentId(vp), VN_GET_INO(vnp));
 945     VnUnlock(vnp, WRITE_LOCK);
 946 #ifdef AFS_DEMAND_ATTACH_FS
 947     VnChangeState_r(vnp, VN_STATE_ONLINE);
 948 #endif
 949     return;
 950
 951
 952  error_encountered_nolock:
 953     if (fdP) {
 954         FDH_REALLYCLOSE(fdP);
 955     }
 956     VOL_LOCK;
 957
 958  error_encountered:
 959     if (dosalv) {
 960 #ifdef AFS_DEMAND_ATTACH_FS
 961         VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, 0);
 962 #else
 963         VForceOffline_r(vp, 0);
 964         error = VSALVAGE;
 965 #endif
 966         if (!*ec)
 967             *ec = error;
 968     }
 969
 970     VInvalidateVnode_r(vnp);
 971     VnUnlock(vnp, WRITE_LOCK);
 972 }
 973
 974 /**
 975  * store a vnode to disk.
 976  *
 977  * @param[out] ec     error code output
 978  * @param[in]  vp     volume object pointer
 979  * @param[in]  vnp    vnode object pointer
 980  * @param[in]  vcp    vnode class info object pointer
 981  * @param[in]  class  vnode class enumeration
 982  *
 983  * @pre VOL_LOCK held.
 984  *      caller holds refs to volume and vnode.
 985  *      DAFS: caller is responsible for performing state sanity checks.
 986  *
 987  * @post vnode state is stored to disk.
 988  *
 989  * @internal vnode package internal use only
 990  */
 991 static void
 992 VnStore(Error * ec, Volume * vp, Vnode * vnp,
 993         struct VnodeClassInfo * vcp, VnodeClass class)
 994 {
 995     int offset, code;
 996     IHandle_t *ihP = vp->vnodeIndex[class].handle;
 997     FdHandle_t *fdP;
 998 #ifdef AFS_DEMAND_ATTACH_FS
 999     VnState vn_state_save;
1000 #endif
1001
1002     *ec = 0;
1003
1004 #ifdef AFS_DEMAND_ATTACH_FS
1005     vn_state_save = VnChangeState_r(vnp, VN_STATE_STORE);
1006 #endif
1007
1008     offset = vnodeIndexOffset(vcp, Vn_id(vnp));
1009     VOL_UNLOCK;
1010     fdP = IH_OPEN(ihP);
1011     if (fdP == NULL) {
1012         Log("VnStore: can't open index file!\n");
1013         goto error_encountered;
1014     }
1015     if (FDH_SEEK(fdP, offset, SEEK_SET) < 0) {
1016         Log("VnStore: can't seek on index file! fdp=0x%x offset=%d, errno=%d\n",
1017             fdP, offset, errno);
1018         goto error_encountered;
1019     }
1020
1021     code = FDH_WRITE(fdP, &vnp->disk, vcp->diskSize);
1022     if (code != vcp->diskSize) {
1023         /* Don't force volume offline if the inumber is out of
1024          * range or the inode table is full.
1025          */
1026         FDH_REALLYCLOSE(fdP);
1027         if (code == BAD_IGET) {
1028             Log("VnStore: bad inumber %s\n",
1029                 PrintInode(NULL,
1030                            vp->vnodeIndex[class].handle->ih_ino));
1031             *ec = VIO;
1032             VOL_LOCK;
1033 #ifdef AFS_DEMAND_ATTACH_FS
1034             VnChangeState_r(vnp, VN_STATE_ERROR);
1035 #endif
1036         } else {
1037             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)), code);
1038 #ifdef AFS_DEMAND_ATTACH_FS
1039             goto error_encountered;
1040 #else
1041             VOL_LOCK;
1042             VForceOffline_r(vp, 0);
1043             *ec = VSALVAGE;
1044 #endif
1045         }
1046         return;
1047     } else {
1048         FDH_CLOSE(fdP);
1049     }
1050
1051     VOL_LOCK;
1052 #ifdef AFS_DEMAND_ATTACH_FS
1053     VnChangeState_r(vnp, vn_state_save);
1054 #endif
1055     return;
1056
1057  error_encountered:
1058 #ifdef AFS_DEMAND_ATTACH_FS
1059     /* XXX instead of dumping core, let's try to request a salvage
1060      * and just fail the putvnode */
1061     if (fdP)
1062         FDH_CLOSE(fdP);
1063     VOL_LOCK;
1064     VnChangeState_r(vnp, VN_STATE_ERROR);
1065     VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1066 #else
1067     assert(1 == 2);
1068 #endif
1069 }
1070
1071 /**
1072  * get a handle to a vnode object.
1073  *
1074  * @param[out] ec           error code
1075  * @param[in]  vp           volume object
1076  * @param[in]  vnodeNumber  vnode id
1077  * @param[in]  locktype     type of lock to acquire
1078  *
1079  * @return vnode object pointer
1080  *
1081  * @see VGetVnode_r
1082  */
1083 Vnode *
1084 VGetVnode(Error * ec, Volume * vp, VnodeId vnodeNumber, int locktype)
1085 {                               /* READ_LOCK or WRITE_LOCK, as defined in lock.h */
1086     Vnode *retVal;
1087     VOL_LOCK;
1088     retVal = VGetVnode_r(ec, vp, vnodeNumber, locktype);
1089     VOL_UNLOCK;
1090     return retVal;
1091 }
1092
1093 /**
1094  * get a handle to a vnode object.
1095  *
1096  * @param[out] ec           error code
1097  * @param[in]  vp           volume object
1098  * @param[in]  vnodeNumber  vnode id
1099  * @param[in]  locktype     type of lock to acquire
1100  *
1101  * @return vnode object pointer
1102  *
1103  * @internal vnode package internal use only
1104  *
1105  * @pre VOL_LOCK held.
1106  *      heavyweight ref held on volume object.
1107  */
1108 Vnode *
1109 VGetVnode_r(Error * ec, Volume * vp, VnodeId vnodeNumber, int locktype)
1110 {                               /* READ_LOCK or WRITE_LOCK, as defined in lock.h */
1111     register Vnode *vnp;
1112     VnodeClass class;
1113     struct VnodeClassInfo *vcp;
1114
1115     *ec = 0;
1116
1117     if (vnodeNumber == 0) {
1118         *ec = VNOVNODE;
1119         return NULL;
1120     }
1121
1122     VNLog(100, 1, vnodeNumber, 0, 0, 0);
1123
1124 #ifdef AFS_DEMAND_ATTACH_FS
1125     /*
1126      * once a volume has entered an error state, don't permit
1127      * further operations to proceed
1128      *  -- tkeiser 11/21/2007
1129      */
1130     VWaitExclusiveState_r(vp);
1131     if (VIsErrorState(V_attachState(vp))) {
1132         /* XXX is VSALVAGING acceptable here? */
1133         *ec = VSALVAGING;
1134         return NULL;
1135     }
1136 #endif
1137
1138     if (programType == fileServer && !V_inUse(vp)) {
1139         *ec = (vp->specialStatus ? vp->specialStatus : VOFFLINE);
1140
1141         /* If the volume is VBUSY (being cloned or dumped) and this is
1142          * a READ operation, then don't fail.
1143          */
1144         if ((*ec != VBUSY) || (locktype != READ_LOCK)) {
1145             return NULL;
1146         }
1147         *ec = 0;
1148     }
1149     class = vnodeIdToClass(vnodeNumber);
1150     vcp = &VnodeClassInfo[class];
1151     if (locktype == WRITE_LOCK && !VolumeWriteable(vp)) {
1152         *ec = (bit32) VREADONLY;
1153         return NULL;
1154     }
1155
1156     if (locktype == WRITE_LOCK && programType == fileServer) {
1157         VAddToVolumeUpdateList_r(ec, vp);
1158         if (*ec) {
1159             return NULL;
1160         }
1161     }
1162
1163     vcp->gets++;
1164
1165     /* See whether the vnode is in the cache. */
1166     vnp = VLookupVnode(vp, vnodeNumber);
1167     if (vnp) {
1168         /* vnode is in cache */
1169
1170         VNLog(101, 2, vnodeNumber, (afs_int32) vnp, 0, 0);
1171         VnCreateReservation_r(vnp);
1172
1173 #ifdef AFS_DEMAND_ATTACH_FS
1174         /*
1175          * this is the one DAFS case where we may run into contention.
1176          * here's the basic control flow:
1177          *
1178          * if locktype is READ_LOCK:
1179          *   wait until vnode is not exclusive
1180          *   set to VN_STATE_READ
1181          *   increment read count
1182          *   done
1183          * else
1184          *   wait until vnode is quiescent
1185          *   set to VN_STATE_EXCLUSIVE
1186          *   done
1187          */
1188         if (locktype == READ_LOCK) {
1189             VnWaitExclusiveState_r(vnp);
1190         } else {
1191             VnWaitQuiescent_r(vnp);
1192         }
1193
1194         if (VnIsErrorState(Vn_state(vnp))) {
1195             VnCancelReservation_r(vnp);
1196             *ec = VSALVAGE;
1197             return NULL;
1198         }
1199 #endif /* AFS_DEMAND_ATTACH_FS */
1200     } else {
1201         /* vnode not cached */
1202
1203         /* Not in cache; tentatively grab most distantly used one from the LRU
1204          * chain */
1205         vcp->reads++;
1206         vnp = VGetFreeVnode_r(vcp);
1207
1208         /* Initialize */
1209         vnp->changed_newTime = vnp->changed_oldTime = 0;
1210         vnp->delete = 0;
1211         Vn_id(vnp) = vnodeNumber;
1212         VnCreateReservation_r(vnp);
1213         AddToVVnList(vp, vnp);
1214 #ifdef AFS_DEMAND_ATTACH_FS
1215         AddToVnHash(vnp);
1216 #endif
1217
1218         /*
1219          * XXX for non-DAFS, there is a serious
1220          * race condition here:
1221          *
1222          * two threads can race to load a vnode.  the net
1223          * result is two struct Vnodes can be allocated
1224          * and hashed, which point to the same underlying
1225          * disk data store.  conflicting vnode locks can
1226          * thus be held concurrently.
1227          *
1228          * for non-DAFS to be safe, VOL_LOCK really shouldn't
1229          * be dropped in VnLoad.  Of course, this would likely
1230          * lead to an unacceptable slow-down.
1231          */
1232
1233         VnLoad(ec, vp, vnp, vcp, class);
1234         if (*ec) {
1235             VnCancelReservation_r(vnp);
1236             return NULL;
1237         }
1238 #ifndef AFS_DEMAND_ATTACH_FS
1239         AddToVnHash(vnp);
1240 #endif
1241         /*
1242          * DAFS:
1243          * there is no possibility for contention. we "own" this vnode.
1244          */
1245     }
1246
1247     /*
1248      * DAFS:
1249      * it is imperative that nothing drop vol lock between here
1250      * and the VnBeginRead/VnChangeState stanza below
1251      */
1252
1253     VnLock(vnp, locktype, VOL_LOCK_HELD, MIGHT_DEADLOCK);
1254
1255     /* Check that the vnode hasn't been removed while we were obtaining
1256      * the lock */
1257     VNLog(102, 2, vnodeNumber, (afs_int32) vnp, 0, 0);
1258     if ((vnp->disk.type == vNull) || (Vn_cacheCheck(vnp) == 0)) {
1259         VnUnlock(vnp, locktype);
1260         VnCancelReservation_r(vnp);
1261         *ec = VNOVNODE;
1262         /* vnode is labelled correctly by now, so we don't have to invalidate it */
1263         return NULL;
1264     }
1265
1266 #ifdef AFS_DEMAND_ATTACH_FS
1267     if (locktype == READ_LOCK) {
1268         VnBeginRead_r(vnp);
1269     } else {
1270         VnChangeState_r(vnp, VN_STATE_EXCLUSIVE);
1271     }
1272 #endif
1273
1274     if (programType == fileServer)
1275         VBumpVolumeUsage_r(Vn_volume(vnp));     /* Hack; don't know where it should be
1276                                                  * called from.  Maybe VGetVolume */
1277     return vnp;
1278 }
1279
1280
1281 int TrustVnodeCacheEntry = 1;
1282 /* This variable is bogus--when it's set to 0, the hash chains fill
1283    up with multiple versions of the same vnode.  Should fix this!! */
1284 void
1285 VPutVnode(Error * ec, register Vnode * vnp)
1286 {
1287     VOL_LOCK;
1288     VPutVnode_r(ec, vnp);
1289     VOL_UNLOCK;
1290 }
1291
1292 /**
1293  * put back a handle to a vnode object.
1294  *
1295  * @param[out] ec   client error code
1296  * @param[in]  vnp  vnode object pointer
1297  *
1298  * @pre VOL_LOCK held.
1299  *      ref held on vnode.
1300  *
1301  * @post ref dropped on vnode.
1302  *       if vnode was modified or deleted, it is written out to disk
1303  *       (assuming a write lock was held).
1304  *
1305  * @internal volume package internal use only
1306  */
1307 void
1308 VPutVnode_r(Error * ec, register Vnode * vnp)
1309 {
1310     int writeLocked;
1311     VnodeClass class;
1312     struct VnodeClassInfo *vcp;
1313
1314     *ec = 0;
1315     assert(Vn_refcount(vnp) != 0);
1316     class = vnodeIdToClass(Vn_id(vnp));
1317     vcp = &VnodeClassInfo[class];
1318     assert(vnp->disk.vnodeMagic == vcp->magic);
1319     VNLog(200, 2, Vn_id(vnp), (afs_int32) vnp, 0, 0);
1320
1321 #ifdef AFS_DEMAND_ATTACH_FS
1322     writeLocked = (Vn_state(vnp) == VN_STATE_EXCLUSIVE);
1323 #else
1324     writeLocked = WriteLocked(&vnp->lock);
1325 #endif
1326
1327     if (writeLocked) {
1328         /* sanity checks */
1329 #ifdef AFS_PTHREAD_ENV
1330         pthread_t thisProcess = pthread_self();
1331 #else /* AFS_PTHREAD_ENV */
1332         PROCESS thisProcess;
1333         LWP_CurrentProcess(&thisProcess);
1334 #endif /* AFS_PTHREAD_ENV */
1335         VNLog(201, 2, (afs_int32) vnp,
1336               ((vnp->changed_newTime) << 1) | ((vnp->
1337                                                 changed_oldTime) << 1) | vnp->
1338               delete, 0, 0);
1339         if (thisProcess != vnp->writer)
1340             Abort("VPutVnode: Vnode at 0x%x locked by another process!\n",
1341                   vnp);
1342
1343
1344         if (vnp->changed_oldTime || vnp->changed_newTime || vnp->delete) {
1345             Volume *vp = Vn_volume(vnp);
1346             afs_uint32 now = FT_ApproxTime();
1347             assert(Vn_cacheCheck(vnp) == vp->cacheCheck);
1348
1349             if (vnp->delete) {
1350                 /* No longer any directory entries for this vnode. Free the Vnode */
1351                 memset(&vnp->disk, 0, sizeof(vnp->disk));
1352                 /* delete flag turned off further down */
1353                 VNLog(202, 2, Vn_id(vnp), (afs_int32) vnp, 0, 0);
1354             } else if (vnp->changed_newTime) {
1355                 vnp->disk.serverModifyTime = now;
1356             }
1357             if (vnp->changed_newTime)
1358             {
1359                 V_updateDate(vp) = vp->updateTime = now;
1360                 if(V_volUpCounter(vp)<MAXINT)
1361                         V_volUpCounter(vp)++;
1362             }
1363
1364             /* The vnode has been changed. Write it out to disk */
1365             if (!V_inUse(vp)) {
1366 #ifdef AFS_DEMAND_ATTACH_FS
1367                 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1368 #else
1369                 assert(V_needsSalvaged(vp));
1370                 *ec = VSALVAGE;
1371 #endif
1372             } else {
1373                 VnStore(ec, vp, vnp, vcp, class);
1374
1375                 /* If the vnode is to be deleted, and we wrote the vnode out,
1376                  * free its bitmap entry. Do after the vnode is written so we
1377                  * don't allocate from bitmap before the vnode is written
1378                  * (doing so could cause a "addled bitmap" message).
1379                  */
1380                 if (vnp->delete && !*ec) {
1381                     if (Vn_volume(vnp)->header->diskstuff.filecount-- < 1)
1382                         Vn_volume(vnp)->header->diskstuff.filecount = 0;
1383                     VFreeBitMapEntry_r(ec, &vp->vnodeIndex[class],
1384                                        vnodeIdToBitNumber(Vn_id(vnp)));
1385                 }
1386             }
1387             vcp->writes++;
1388             vnp->changed_newTime = vnp->changed_oldTime = 0;
1389         }
1390 #ifdef AFS_DEMAND_ATTACH_FS
1391         VnChangeState_r(vnp, VN_STATE_ONLINE);
1392 #endif
1393     } else {                    /* Not write locked */
1394         if (vnp->changed_newTime || vnp->changed_oldTime || vnp->delete)
1395             Abort
1396                 ("VPutVnode: Change or delete flag for vnode 0x%x is set but vnode is not write locked!\n",
1397                  vnp);
1398 #ifdef AFS_DEMAND_ATTACH_FS
1399         VnEndRead_r(vnp);
1400 #endif
1401     }
1402
1403     /* Do not look at disk portion of vnode after this point; it may
1404      * have been deleted above */
1405     vnp->delete = 0;
1406     VnUnlock(vnp, ((writeLocked) ? WRITE_LOCK : READ_LOCK));
1407     VnCancelReservation_r(vnp);
1408 }
1409
1410 /*
1411  * Make an attempt to convert a vnode lock from write to read.
1412  * Do nothing if the vnode isn't write locked or the vnode has
1413  * been deleted.
1414  */
1415 int
1416 VVnodeWriteToRead(Error * ec, register Vnode * vnp)
1417 {
1418     int retVal;
1419     VOL_LOCK;
1420     retVal = VVnodeWriteToRead_r(ec, vnp);
1421     VOL_UNLOCK;
1422     return retVal;
1423 }
1424
1425 /**
1426  * convert vnode handle from mutually exclusive to shared access.
1427  *
1428  * @param[out] ec   client error code
1429  * @param[in]  vnp  vnode object pointer
1430  *
1431  * @return unspecified use (see out argument 'ec' for error code return)
1432  *
1433  * @pre VOL_LOCK held.
1434  *      ref held on vnode.
1435  *      write lock held on vnode.
1436  *
1437  * @post read lock held on vnode.
1438  *       if vnode was modified, it has been written to disk.
1439  *
1440  * @internal volume package internal use only
1441  */
1442 int
1443 VVnodeWriteToRead_r(Error * ec, register Vnode * vnp)
1444 {
1445     int writeLocked;
1446     VnodeClass class;
1447     struct VnodeClassInfo *vcp;
1448 #ifdef AFS_PTHREAD_ENV
1449     pthread_t thisProcess;
1450 #else /* AFS_PTHREAD_ENV */
1451     PROCESS thisProcess;
1452 #endif /* AFS_PTHREAD_ENV */
1453
1454     *ec = 0;
1455     assert(Vn_refcount(vnp) != 0);
1456     class = vnodeIdToClass(Vn_id(vnp));
1457     vcp = &VnodeClassInfo[class];
1458     assert(vnp->disk.vnodeMagic == vcp->magic);
1459     VNLog(300, 2, Vn_id(vnp), (afs_int32) vnp, 0, 0);
1460
1461 #ifdef AFS_DEMAND_ATTACH_FS
1462     writeLocked = (Vn_state(vnp) == VN_STATE_EXCLUSIVE);
1463 #else
1464     writeLocked = WriteLocked(&vnp->lock);
1465 #endif
1466     if (!writeLocked) {
1467         return 0;
1468     }
1469
1470
1471     VNLog(301, 2, (afs_int32) vnp,
1472           ((vnp->changed_newTime) << 1) | ((vnp->
1473                                             changed_oldTime) << 1) | vnp->
1474           delete, 0, 0);
1475
1476     /* sanity checks */
1477 #ifdef AFS_PTHREAD_ENV
1478     thisProcess = pthread_self();
1479 #else /* AFS_PTHREAD_ENV */
1480     LWP_CurrentProcess(&thisProcess);
1481 #endif /* AFS_PTHREAD_ENV */
1482     if (thisProcess != vnp->writer)
1483         Abort("VPutVnode: Vnode at 0x%x locked by another process!\n",
1484               (int)vnp);
1485
1486     if (vnp->delete) {
1487         return 0;
1488     }
1489     if (vnp->changed_oldTime || vnp->changed_newTime) {
1490         Volume *vp = Vn_volume(vnp);
1491         afs_uint32 now = FT_ApproxTime();
1492         assert(Vn_cacheCheck(vnp) == vp->cacheCheck);
1493         if (vnp->changed_newTime)
1494             vnp->disk.serverModifyTime = now;
1495         if (vnp->changed_newTime)
1496             V_updateDate(vp) = vp->updateTime = now;
1497
1498         /* The inode has been changed.  Write it out to disk */
1499         if (!V_inUse(vp)) {
1500 #ifdef AFS_DEMAND_ATTACH_FS
1501             VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1502 #else
1503             assert(V_needsSalvaged(vp));
1504             *ec = VSALVAGE;
1505 #endif
1506         } else {
1507             VnStore(ec, vp, vnp, vcp, class);
1508         }
1509         vcp->writes++;
1510         vnp->changed_newTime = vnp->changed_oldTime = 0;
1511     }
1512
1513     vnp->writer = 0;
1514 #ifdef AFS_DEMAND_ATTACH_FS
1515     VnChangeState_r(vnp, VN_STATE_ONLINE);
1516     VnBeginRead_r(vnp);
1517 #else
1518     ConvertWriteToReadLock(&vnp->lock);
1519 #endif
1520     return 0;
1521 }
1522
1523 /**
1524  * initial size of ihandle pointer vector.
1525  *
1526  * @see VInvalidateVnodesByVolume_r
1527  */
1528 #define IH_VEC_BASE_SIZE 256
1529
1530 /**
1531  * increment amount for growing ihandle pointer vector.
1532  *
1533  * @see VInvalidateVnodesByVolume_r
1534  */
1535 #define IH_VEC_INCREMENT 256
1536
1537 /**
1538  * Compile list of ihandles to be released/reallyclosed at a later time.
1539  *
1540  * @param[in]   vp            volume object pointer
1541  * @param[out]  vec_out       vector of ihandle pointers to be released/reallyclosed
1542  * @param[out]  vec_len_out   number of valid elements in ihandle vector
1543  *
1544  * @pre - VOL_LOCK is held
1545  *      - volume is in appropriate exclusive state (e.g. VOL_STATE_VNODE_CLOSE,
1546  *        VOL_STATE_VNODE_RELEASE)
1547  *
1548  * @post - all vnodes on VVn list are invalidated
1549  *       - ih_vec is populated with all valid ihandles
1550  *
1551  * @return operation status
1552  *    @retval 0         success
1553  *    @retval ENOMEM    out of memory
1554  *
1555  * @todo we should handle out of memory conditions more gracefully.
1556  *
1557  * @internal vnode package internal use only
1558  */
1559 static int
1560 VInvalidateVnodesByVolume_r(Volume * vp,
1561                             IHandle_t *** vec_out,
1562                             size_t * vec_len_out)
1563 {
1564     int ret = 0;
1565     Vnode *vnp, *nvnp;
1566     size_t i = 0, vec_len;
1567     IHandle_t **ih_vec, **ih_vec_new;
1568
1569 #ifdef AFS_DEMAND_ATTACH_FS
1570     VOL_UNLOCK;
1571 #endif /* AFS_DEMAND_ATTACH_FS */
1572
1573     vec_len = IH_VEC_BASE_SIZE;
1574     ih_vec = malloc(sizeof(IHandle_t *) * vec_len);
1575 #ifdef AFS_DEMAND_ATTACH_FS
1576     VOL_LOCK;
1577 #endif
1578     if (ih_vec == NULL)
1579         return ENOMEM;
1580
1581     /*
1582      * Traverse the volume's vnode list.  Pull all the ihandles out into a
1583      * thread-private array for later asynchronous processing.
1584      */
1585 #ifdef AFS_DEMAND_ATTACH_FS
1586 restart_traversal:
1587 #endif
1588     for (queue_Scan(&vp->vnode_list, vnp, nvnp, Vnode)) {
1589         if (vnp->handle != NULL) {
1590             if (i == vec_len) {
1591 #ifdef AFS_DEMAND_ATTACH_FS
1592                 VOL_UNLOCK;
1593 #endif
1594                 vec_len += IH_VEC_INCREMENT;
1595                 ih_vec_new = realloc(ih_vec, sizeof(IHandle_t *) * vec_len);
1596 #ifdef AFS_DEMAND_ATTACH_FS
1597                 VOL_LOCK;
1598 #endif
1599                 if (ih_vec_new == NULL) {
1600                     ret = ENOMEM;
1601                     goto done;
1602                 }
1603                 ih_vec = ih_vec_new;
1604 #ifdef AFS_DEMAND_ATTACH_FS
1605                 /*
1606                  * Theoretically, the volume's VVn list should not change
1607                  * because the volume is in an exclusive state.  For the
1608                  * sake of safety, we will restart the traversal from the
1609                  * the beginning (which is not expensive because we're
1610                  * deleting the items from the list as we go).
1611                  */
1612                 goto restart_traversal;
1613 #endif
1614             }
1615             ih_vec[i++] = vnp->handle;
1616             vnp->handle = NULL;
1617         }
1618         DeleteFromVVnList(vnp);
1619         VInvalidateVnode_r(vnp);
1620     }
1621
1622  done:
1623     *vec_out = ih_vec;
1624     *vec_len_out = i;
1625
1626     return ret;
1627 }
1628
1629 /* VCloseVnodeFiles - called when a volume is going off line. All open
1630  * files for vnodes in that volume are closed. This might be excessive,
1631  * since we may only be taking one volume of a volume group offline.
1632  */
1633 void
1634 VCloseVnodeFiles_r(Volume * vp)
1635 {
1636 #ifdef AFS_DEMAND_ATTACH_FS
1637     VolState vol_state_save;
1638 #endif
1639     IHandle_t ** ih_vec;
1640     size_t i, vec_len;
1641
1642 #ifdef AFS_DEMAND_ATTACH_FS
1643     vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_CLOSE);
1644 #endif /* AFS_DEMAND_ATTACH_FS */
1645
1646     /* XXX need better error handling here */
1647     assert(VInvalidateVnodesByVolume_r(vp,
1648                                        &ih_vec,
1649                                        &vec_len) == 0);
1650
1651     /*
1652      * DAFS:
1653      * now we drop VOL_LOCK while we perform some potentially very
1654      * expensive operations in the background
1655      */
1656 #ifdef AFS_DEMAND_ATTACH_FS
1657     VOL_UNLOCK;
1658 #endif
1659
1660     for (i = 0; i < vec_len; i++) {
1661         IH_REALLYCLOSE(ih_vec[i]);
1662     }
1663
1664     free(ih_vec);
1665
1666 #ifdef AFS_DEMAND_ATTACH_FS
1667     VOL_LOCK;
1668     VChangeState_r(vp, vol_state_save);
1669 #endif /* AFS_DEMAND_ATTACH_FS */
1670 }
1671
1672
1673 /**
1674  * shut down all vnode cache state for a given volume.
1675  *
1676  * @param[in] vp  volume object pointer
1677  *
1678  * @pre VOL_LOCK is held
1679  *
1680  * @post all file descriptors closed.
1681  *       all inode handles released.
1682  *       all vnode cache objects disassociated from volume.
1683  *
1684  * @note for DAFS, these operations are performed outside the vol glock under
1685  *       volume exclusive state VOL_STATE_VNODE_RELEASE.  Please further note
1686  *       that it would be a bug to acquire and release a volume reservation
1687  *       during this exclusive operation.  This is due to the fact that we are
1688  *       generally called during the refcount 1->0 transition.
1689  *
1690  * @todo we should handle failures in VInvalidateVnodesByVolume_r more
1691  *       gracefully.
1692  *
1693  * @see VInvalidateVnodesByVolume_r
1694  *
1695  * @internal this routine is internal to the volume package
1696  */
1697 void
1698 VReleaseVnodeFiles_r(Volume * vp)
1699 {
1700 #ifdef AFS_DEMAND_ATTACH_FS
1701     VolState vol_state_save;
1702 #endif
1703     IHandle_t ** ih_vec;
1704     size_t i, vec_len;
1705
1706 #ifdef AFS_DEMAND_ATTACH_FS
1707     vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_RELEASE);
1708 #endif /* AFS_DEMAND_ATTACH_FS */
1709
1710     /* XXX need better error handling here */
1711     assert(VInvalidateVnodesByVolume_r(vp,
1712                                        &ih_vec,
1713                                        &vec_len) == 0);
1714
1715     /*
1716      * DAFS:
1717      * now we drop VOL_LOCK while we perform some potentially very
1718      * expensive operations in the background
1719      */
1720 #ifdef AFS_DEMAND_ATTACH_FS
1721     VOL_UNLOCK;
1722 #endif
1723
1724     for (i = 0; i < vec_len; i++) {
1725         IH_RELEASE(ih_vec[i]);
1726     }
1727
1728     free(ih_vec);
1729
1730 #ifdef AFS_DEMAND_ATTACH_FS
1731     VOL_LOCK;
1732     VChangeState_r(vp, vol_state_save);
1733 #endif /* AFS_DEMAND_ATTACH_FS */
1734 }