2 * Copyright 2000, International Business Machines Corporation and others.
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
9 * Portions Copyright (c) 2005-2008 Sine Nomine Associates
15 Institution: The Information Technology Center, Carnegie-Mellon University
18 #include <afsconfig.h>
19 #include <afs/param.h>
20 #define MAXINT (~(1<<((sizeof(int)*8)-1)))
27 #ifdef AFS_PTHREAD_ENV
29 #else /* AFS_PTHREAD_ENV */
30 #include <afs/assert.h>
31 #endif /* AFS_PTHREAD_ENV */
34 #include "rx/rx_queue.h"
35 #include <afs/afsint.h>
37 #include <afs/errors.h>
40 #include <afs/afssyscalls.h>
44 #include "volume_inline.h"
45 #include "vnode_inline.h"
46 #include "partition.h"
48 #if defined(AFS_SGI_ENV)
49 #include "sys/types.h"
61 #include <sys/fcntl.h>
64 #endif /* AFS_NT40_ENV */
67 /*@printflike@*/ extern void Log(const char *format, ...);
69 /*@printflike@*/ extern void Abort(const char *format, ...);
72 struct VnodeClassInfo VnodeClassInfo[nVNODECLASSES];
74 void VNLog(afs_int32 aop, afs_int32 anparms, ... );
81 #define BAD_IGET -1000
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.
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.
105 /* logging stuff for finding bugs */
106 #define THELOGSIZE 5120
107 static afs_int32 theLog[THELOGSIZE];
108 static afs_int32 vnLogPtr = 0;
110 VNLog(afs_int32 aop, afs_int32 anparms, ... )
112 register afs_int32 temp;
115 va_start(ap, anparms);
118 anparms = 4; /* do bounds checking */
120 temp = (aop << 16) | anparms;
121 theLog[vnLogPtr++] = temp;
122 if (vnLogPtr >= THELOGSIZE)
124 for (temp = 0; temp < anparms; temp++) {
125 theLog[vnLogPtr++] = va_arg(ap, afs_int32);
126 if (vnLogPtr >= THELOGSIZE)
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.
142 VolumeHashOffset_r(void)
144 static int nextVolumeHashOffset = 0;
145 /* hashindex Must be power of two in size */
147 # define hashMask ((1<<hashShift)-1)
148 static byte hashindex[1 << hashShift] =
149 { 0, 128, 64, 192, 32, 160, 96, 224 };
151 offset = hashindex[nextVolumeHashOffset & hashMask]
152 + (nextVolumeHashOffset >> hashShift);
153 nextVolumeHashOffset++;
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))
165 * add a vnode to the volume's vnode list.
167 * @param[in] vp volume object pointer
168 * @param[in] vnp vnode object pointer
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
177 * @internal volume package internal use only
180 AddToVVnList(Volume * vp, Vnode * vnp)
182 if (queue_IsOnQueue(vnp))
186 Vn_cacheCheck(vnp) = vp->cacheCheck;
187 queue_Append(&vp->vnode_list, vnp);
188 Vn_stateFlags(vnp) |= VN_ON_VVN;
192 * delete a vnode from the volume's vnode list.
196 * @internal volume package internal use only
199 DeleteFromVVnList(register Vnode * vnp)
201 Vn_volume(vnp) = NULL;
203 if (!queue_IsOnQueue(vnp))
207 Vn_stateFlags(vnp) &= ~(VN_ON_VVN);
211 * add a vnode to the end of the lru.
213 * @param[in] vcp vnode class info object pointer
214 * @param[in] vnp vnode object pointer
216 * @internal vnode package internal use only
219 AddToVnLRU(struct VnodeClassInfo * vcp, Vnode * vnp)
221 if (Vn_stateFlags(vnp) & VN_ON_LRU) {
225 /* Add it to the circular LRU list */
226 if (vcp->lruHead == NULL)
227 Abort("VPutVnode: vcp->lruHead==NULL");
229 vnp->lruNext = vcp->lruHead;
230 vnp->lruPrev = vcp->lruHead->lruPrev;
231 vcp->lruHead->lruPrev = vnp;
232 vnp->lruPrev->lruNext = vnp;
236 /* If the vnode was just deleted, put it at the end of the chain so it
237 * will be reused immediately */
239 vcp->lruHead = vnp->lruNext;
241 Vn_stateFlags(vnp) |= VN_ON_LRU;
245 * delete a vnode from the lru.
247 * @param[in] vcp vnode class info object pointer
248 * @param[in] vnp vnode object pointer
250 * @internal vnode package internal use only
253 DeleteFromVnLRU(struct VnodeClassInfo * vcp, Vnode * vnp)
255 if (!(Vn_stateFlags(vnp) & VN_ON_LRU)) {
259 if (vnp == vcp->lruHead)
260 vcp->lruHead = vcp->lruHead->lruNext;
262 if ((vnp == vcp->lruHead) ||
263 (vcp->lruHead == NULL))
264 Abort("DeleteFromVnLRU: lru chain addled!\n");
266 vnp->lruPrev->lruNext = vnp->lruNext;
267 vnp->lruNext->lruPrev = vnp->lruPrev;
269 Vn_stateFlags(vnp) &= ~(VN_ON_LRU);
273 * add a vnode to the vnode hash table.
275 * @param[in] vnp vnode object pointer
279 * @post vnode on hash
281 * @internal vnode package internal use only
284 AddToVnHash(Vnode * vnp)
286 unsigned int newHash;
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;
294 Vn_stateFlags(vnp) |= VN_ON_HASH;
299 * delete a vnode from the vnode hash table.
306 * @post vnode removed from hash
308 * @internal vnode package internal use only
311 DeleteFromVnHash(Vnode * vnp)
315 if (Vn_stateFlags(vnp) & VN_ON_HASH) {
316 tvnp = VnodeHashTable[vnp->hashIndex];
318 VnodeHashTable[vnp->hashIndex] = vnp->hashNext;
320 while (tvnp && tvnp->hashNext != vnp)
321 tvnp = tvnp->hashNext;
323 tvnp->hashNext = vnp->hashNext;
326 vnp->hashNext = NULL;
328 Vn_stateFlags(vnp) &= ~(VN_ON_HASH);
334 * invalidate a vnode cache entry.
336 * @param[in] avnode vnode object pointer
340 * @post vnode metadata invalidated.
341 * vnode removed from hash table.
342 * DAFS: vnode state set to VN_STATE_INVALID.
344 * @internal vnode package internal use only
347 VInvalidateVnode_r(register struct Vnode *avnode)
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);
361 * initialize vnode cache for a given vnode class.
363 * @param[in] class vnode class
364 * @param[in] nVnodes size of cache
366 * @post vnode cache allocated and initialized
368 * @internal volume package internal use only
370 * @note generally called by VInitVolumePackage_r
372 * @see VInitVolumePackage_r
375 VInitVnodes(VnodeClass class, int nVnodes)
378 register struct VnodeClassInfo *vcp = &VnodeClassInfo[class];
380 vcp->allocs = vcp->gets = vcp->reads = vcp->writes = 0;
381 vcp->cacheSize = nVnodes;
384 assert(CHECKSIZE_SMALLVNODE);
386 vcp->residentSize = SIZEOF_SMALLVNODE;
387 vcp->diskSize = SIZEOF_SMALLDISKVNODE;
388 vcp->magic = SMALLVNODEMAGIC;
392 vcp->residentSize = SIZEOF_LARGEVNODE;
393 vcp->diskSize = SIZEOF_LARGEDISKVNODE;
394 vcp->magic = LARGEVNODEMAGIC;
398 int s = vcp->diskSize - 1;
408 va = (byte *) calloc(nVnodes, vcp->residentSize);
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;
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 */
434 if (vcp->lruHead == NULL)
435 vcp->lruHead = vnp->lruNext = vnp->lruPrev = vnp;
437 vnp->lruNext = vcp->lruHead;
438 vnp->lruPrev = vcp->lruHead->lruPrev;
439 vcp->lruHead->lruPrev = vnp;
440 vnp->lruPrev->lruNext = vnp;
443 va += vcp->residentSize;
450 * allocate an unused vnode from the lru chain.
452 * @param[in] vcp vnode class info object pointer
454 * @pre VOL_LOCK is held
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.
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
466 * @warning DAFS: VOL_LOCK is dropped while doing inode handle release
468 * @return vnode object pointer
471 VGetFreeVnode_r(struct VnodeClassInfo * vcp)
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");
481 if (Vn_refcount(vnp) != 0 || CheckLock(&vnp->lock))
482 Abort("VGetFreeVnode_r: locked vnode in lruq");
484 VNLog(1, 2, Vn_id(vnp), (afs_int32) vnp, 0, 0);
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
492 DeleteFromVnLRU(vcp, vnp);
493 DeleteFromVnHash(vnp);
494 if (Vn_volume(vnp)) {
495 DeleteFromVVnList(vnp);
498 /* drop the file descriptor */
500 #ifdef AFS_DEMAND_ATTACH_FS
501 VnChangeState_r(vnp, VN_STATE_RELEASING);
504 /* release is, potentially, a highly latent operation due to a couple
506 * - ihandle package lock contention
507 * - closing file descriptor(s) associated with ih
509 * Hance, we perform outside of the volume package lock in order to
510 * reduce the probability of contention.
512 IH_RELEASE(vnp->handle);
513 #ifdef AFS_DEMAND_ATTACH_FS
518 #ifdef AFS_DEMAND_ATTACH_FS
519 VnChangeState_r(vnp, VN_STATE_INVALID);
527 * lookup a vnode in the vnode cache hash table.
529 * @param[in] vp pointer to volume object
530 * @param[in] vnodeId vnode id
534 * @post matching vnode object or NULL is returned
536 * @return vnode object pointer
537 * @retval NULL no matching vnode object was found in the cache
539 * @internal vnode package internal use only
541 * @note this symbol is exported strictly for fssync debug protocol use
544 VLookupVnode(Volume * vp, VnodeId vnodeId)
547 unsigned int newHash;
549 newHash = VNODE_HASH(vp, vnodeId);
550 for (vnp = VnodeHashTable[newHash];
552 ((Vn_id(vnp) != vnodeId) ||
553 (Vn_volume(vnp) != vp) ||
554 (vp->cacheCheck != Vn_cacheCheck(vnp))));
555 vnp = vnp->hashNext);
562 VAllocVnode(Error * ec, Volume * vp, VnodeType type)
566 retVal = VAllocVnode_r(ec, vp, type);
572 * allocate a new vnode.
574 * @param[out] ec error code return
575 * @param[in] vp volume object pointer
576 * @param[in] type desired vnode type
578 * @return vnode object pointer
580 * @pre VOL_LOCK held;
581 * heavyweight ref held on vp
583 * @post vnode allocated and returned
586 VAllocVnode_r(Error * ec, Volume * vp, VnodeType type)
591 register struct VnodeClassInfo *vcp;
594 #ifdef AFS_DEMAND_ATTACH_FS
595 VolState vol_state_save;
600 #ifdef AFS_DEMAND_ATTACH_FS
602 * once a volume has entered an error state, don't permit
603 * further operations to proceed
604 * -- tkeiser 11/21/2007
606 VWaitExclusiveState_r(vp);
607 if (VIsErrorState(V_attachState(vp))) {
608 /* XXX is VSALVAGING acceptable here? */
614 if (programType == fileServer && !V_inUse(vp)) {
615 if (vp->specialStatus) {
616 *ec = vp->specialStatus;
622 class = vnodeTypeToClass(type);
623 vcp = &VnodeClassInfo[class];
625 if (!VolumeWriteable(vp)) {
626 *ec = (bit32) VREADONLY;
630 unique = vp->nextVnodeUnique++;
632 unique = vp->nextVnodeUnique++;
634 if (vp->nextVnodeUnique > V_uniquifier(vp)) {
635 VUpdateVolume_r(ec, vp, 0);
640 if (programType == fileServer) {
641 VAddToVolumeUpdateList_r(ec, vp);
646 /* Find a slot in the bit map */
647 bitNumber = VAllocBitmapEntry_r(ec, vp, &vp->vnodeIndex[class],
648 VOL_ALLOC_BITMAP_WAIT);
651 vnodeNumber = bitNumberToVnodeNumber(bitNumber, class);
655 * at this point we should be assured that V_attachState(vp) is non-exclusive
659 VNLog(2, 1, vnodeNumber, 0, 0, 0);
660 /* Prepare to move it to the new hash chain */
661 vnp = VLookupVnode(vp, vnodeNumber);
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);
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);
673 /* other users present; follow locking hierarchy */
674 VnLock(vnp, WRITE_LOCK, VOL_LOCK_HELD, MIGHT_DEADLOCK);
676 #ifdef AFS_DEMAND_ATTACH_FS
679 * vnode was cached, wait for any existing exclusive ops to finish.
680 * once we have reacquired the lock, re-verify volume state.
682 * note: any vnode error state is related to the old vnode; disregard.
684 VnWaitQuiescent_r(vnp);
685 if (VIsErrorState(V_attachState(vp))) {
686 VnUnlock(vnp, WRITE_LOCK);
687 VnCancelReservation_r(vnp);
694 * verify state of the world hasn't changed
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)
700 if (Vn_volume(vnp)->cacheCheck != Vn_cacheCheck(vnp)) {
701 VnUnlock(vnp, WRITE_LOCK);
702 VnCancelReservation_r(vnp);
708 /* no such vnode in the cache */
710 vnp = VGetFreeVnode_r(vcp);
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
721 /* This will never block (guaranteed by check in VGetFreeVnode_r() */
722 VnLock(vnp, WRITE_LOCK, VOL_LOCK_HELD, WILL_NOT_DEADLOCK);
724 #ifdef AFS_DEMAND_ATTACH_FS
725 VnChangeState_r(vnp, VN_STATE_ALLOC);
728 /* Sanity check: is this vnode really not in use? */
731 IHandle_t *ihP = vp->vnodeIndex[class].handle;
733 off_t off = vnodeIndexOffset(vcp, vnodeNumber);
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
740 #ifdef AFS_DEMAND_ATTACH_FS
742 * this race has been eliminated for the DAFS case
743 * using exclusive state VOL_STATE_VNODE_ALLOC
745 * if this becomes a bottleneck, there are ways to
746 * improve parallelism for this code path
747 * -- tkeiser 11/28/2007
749 VCreateReservation_r(vp);
750 VWaitExclusiveState_r(vp);
751 vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_ALLOC);
757 Log("VAllocVnode: can't open index file!\n");
758 goto error_encountered;
760 if ((size = FDH_SIZE(fdP)) < 0) {
761 Log("VAllocVnode: can't stat index file!\n");
762 goto error_encountered;
764 if (FDH_SEEK(fdP, off, SEEK_SET) < 0) {
765 Log("VAllocVnode: can't seek on index file!\n");
766 goto error_encountered;
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;
773 if (vnp->disk.type != vNull) {
774 Log("VAllocVnode: addled bitmap or index!\n");
775 goto error_encountered;
778 /* growing file - grow in a reasonable increment */
779 char *buf = (char *)malloc(16 * 1024);
781 Abort("VAllocVnode: malloc failed\n");
782 memset(buf, 0, 16 * 1024);
783 (void)FDH_WRITE(fdP, buf, 16 * 1024);
789 #ifdef AFS_DEMAND_ATTACH_FS
790 VChangeState_r(vp, vol_state_save);
791 VCancelReservation_r(vp);
797 #ifdef AFS_DEMAND_ATTACH_FS
799 * close the file handle
801 * invalidate the vnode
802 * free up the bitmap entry (although salvager should take care of it)
804 * drop vnode lock and refs
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);
822 VNLog(4, 2, vnodeNumber, (afs_int32) vnp, 0, 0);
823 #ifndef AFS_DEMAND_ATTACH_FS
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. */
833 vnp->disk.vnodeMagic = vcp->magic;
834 vnp->disk.type = type;
835 vnp->disk.uniquifier = unique;
838 vp->header->diskstuff.filecount++;
839 #ifdef AFS_DEMAND_ATTACH_FS
840 VnChangeState_r(vnp, VN_STATE_EXCLUSIVE);
846 * load a vnode from disk.
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
854 * @pre vnode is registered in appropriate data structures;
855 * caller holds a ref on vnode; VOL_LOCK is held
857 * @post vnode data is loaded from disk.
858 * vnode state is set to VN_STATE_ONLINE.
859 * on failure, vnode is invalidated.
861 * @internal vnode package internal use only
864 VnLoad(Error * ec, Volume * vp, Vnode * vnp,
865 struct VnodeClassInfo * vcp, VnodeClass class)
867 /* vnode not cached */
870 IHandle_t *ihP = vp->vnodeIndex[class].handle;
876 #ifdef AFS_DEMAND_ATTACH_FS
877 VnChangeState_r(vnp, VN_STATE_LOAD);
880 /* This will never block */
881 VnLock(vnp, WRITE_LOCK, VOL_LOCK_HELD, WILL_NOT_DEADLOCK);
886 Log("VnLoad: can't open index dev=%u, i=%s\n", vp->device,
887 PrintInode(NULL, vp->vnodeIndex[class].handle->ih_ino));
889 goto error_encountered_nolock;
890 } else if (FDH_SEEK(fdP, vnodeIndexOffset(vcp, Vn_id(vnp)), SEEK_SET)
892 Log("VnLoad: can't seek on index file vn=%u\n", Vn_id(vnp));
894 goto error_encountered_nolock;
895 } else if ((n = FDH_READ(fdP, (char *)&vnp->disk, vcp->diskSize))
897 /* Don't take volume off line if the inumber is out of range
898 * or the inode table is full. */
900 Log("VnLoad: bad inumber %s\n",
901 PrintInode(NULL, vp->vnodeIndex[class].handle->ih_ino));
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));
908 /* vnode is not allocated */
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);
915 goto error_encountered_nolock;
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) {
926 struct vnodeIndex *index = &vp->vnodeIndex[class];
927 unsigned int bitNumber = vnodeIdToBitNumber(Vn_id(vnp));
928 unsigned int offset = bitNumber >> 3;
930 /* Test to see if vnode number is valid. */
931 if ((offset >= index->bitmapSize)
932 || ((*(index->bitmap + offset) & (1 << (bitNumber & 0x7)))
934 Log("VnLoad: Request for unallocated vnode %u, volume %u (%s) denied.\n", Vn_id(vnp), V_id(vp), V_name(vp));
938 Log("VnLoad: Bad magic number, vnode %u, volume %u (%s); volume needs salvage\n", Vn_id(vnp), V_id(vp), V_name(vp));
941 goto error_encountered;
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);
952 error_encountered_nolock:
954 FDH_REALLYCLOSE(fdP);
960 #ifdef AFS_DEMAND_ATTACH_FS
961 VRequestSalvage_r(&error, vp, SALVSYNC_ERROR, 0);
963 VForceOffline_r(vp, 0);
970 VInvalidateVnode_r(vnp);
971 VnUnlock(vnp, WRITE_LOCK);
975 * store a vnode to disk.
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
983 * @pre VOL_LOCK held.
984 * caller holds refs to volume and vnode.
985 * DAFS: caller is responsible for performing state sanity checks.
987 * @post vnode state is stored to disk.
989 * @internal vnode package internal use only
992 VnStore(Error * ec, Volume * vp, Vnode * vnp,
993 struct VnodeClassInfo * vcp, VnodeClass class)
996 IHandle_t *ihP = vp->vnodeIndex[class].handle;
998 #ifdef AFS_DEMAND_ATTACH_FS
999 VnState vn_state_save;
1004 #ifdef AFS_DEMAND_ATTACH_FS
1005 vn_state_save = VnChangeState_r(vnp, VN_STATE_STORE);
1008 offset = vnodeIndexOffset(vcp, Vn_id(vnp));
1012 Log("VnStore: can't open index file!\n");
1013 goto error_encountered;
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;
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.
1026 FDH_REALLYCLOSE(fdP);
1027 if (code == BAD_IGET) {
1028 Log("VnStore: bad inumber %s\n",
1030 vp->vnodeIndex[class].handle->ih_ino));
1033 #ifdef AFS_DEMAND_ATTACH_FS
1034 VnChangeState_r(vnp, VN_STATE_ERROR);
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;
1042 VForceOffline_r(vp, 0);
1052 #ifdef AFS_DEMAND_ATTACH_FS
1053 VnChangeState_r(vnp, vn_state_save);
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 */
1064 VnChangeState_r(vnp, VN_STATE_ERROR);
1065 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1072 * get a handle to a vnode object.
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
1079 * @return vnode object pointer
1084 VGetVnode(Error * ec, Volume * vp, VnodeId vnodeNumber, int locktype)
1085 { /* READ_LOCK or WRITE_LOCK, as defined in lock.h */
1088 retVal = VGetVnode_r(ec, vp, vnodeNumber, locktype);
1094 * get a handle to a vnode object.
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
1101 * @return vnode object pointer
1103 * @internal vnode package internal use only
1105 * @pre VOL_LOCK held.
1106 * heavyweight ref held on volume object.
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;
1113 struct VnodeClassInfo *vcp;
1117 if (vnodeNumber == 0) {
1122 VNLog(100, 1, vnodeNumber, 0, 0, 0);
1124 #ifdef AFS_DEMAND_ATTACH_FS
1126 * once a volume has entered an error state, don't permit
1127 * further operations to proceed
1128 * -- tkeiser 11/21/2007
1130 VWaitExclusiveState_r(vp);
1131 if (VIsErrorState(V_attachState(vp))) {
1132 /* XXX is VSALVAGING acceptable here? */
1138 if (programType == fileServer && !V_inUse(vp)) {
1139 *ec = (vp->specialStatus ? vp->specialStatus : VOFFLINE);
1141 /* If the volume is VBUSY (being cloned or dumped) and this is
1142 * a READ operation, then don't fail.
1144 if ((*ec != VBUSY) || (locktype != READ_LOCK)) {
1149 class = vnodeIdToClass(vnodeNumber);
1150 vcp = &VnodeClassInfo[class];
1151 if (locktype == WRITE_LOCK && !VolumeWriteable(vp)) {
1152 *ec = (bit32) VREADONLY;
1156 if (locktype == WRITE_LOCK && programType == fileServer) {
1157 VAddToVolumeUpdateList_r(ec, vp);
1165 /* See whether the vnode is in the cache. */
1166 vnp = VLookupVnode(vp, vnodeNumber);
1168 /* vnode is in cache */
1170 VNLog(101, 2, vnodeNumber, (afs_int32) vnp, 0, 0);
1171 VnCreateReservation_r(vnp);
1173 #ifdef AFS_DEMAND_ATTACH_FS
1175 * this is the one DAFS case where we may run into contention.
1176 * here's the basic control flow:
1178 * if locktype is READ_LOCK:
1179 * wait until vnode is not exclusive
1180 * set to VN_STATE_READ
1181 * increment read count
1184 * wait until vnode is quiescent
1185 * set to VN_STATE_EXCLUSIVE
1188 if (locktype == READ_LOCK) {
1189 VnWaitExclusiveState_r(vnp);
1191 VnWaitQuiescent_r(vnp);
1194 if (VnIsErrorState(Vn_state(vnp))) {
1195 VnCancelReservation_r(vnp);
1199 #endif /* AFS_DEMAND_ATTACH_FS */
1201 /* vnode not cached */
1203 /* Not in cache; tentatively grab most distantly used one from the LRU
1206 vnp = VGetFreeVnode_r(vcp);
1209 vnp->changed_newTime = vnp->changed_oldTime = 0;
1211 Vn_id(vnp) = vnodeNumber;
1212 VnCreateReservation_r(vnp);
1213 AddToVVnList(vp, vnp);
1214 #ifdef AFS_DEMAND_ATTACH_FS
1219 * XXX for non-DAFS, there is a serious
1220 * race condition here:
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.
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.
1233 VnLoad(ec, vp, vnp, vcp, class);
1235 VnCancelReservation_r(vnp);
1238 #ifndef AFS_DEMAND_ATTACH_FS
1243 * there is no possibility for contention. we "own" this vnode.
1249 * it is imperative that nothing drop vol lock between here
1250 * and the VnBeginRead/VnChangeState stanza below
1253 VnLock(vnp, locktype, VOL_LOCK_HELD, MIGHT_DEADLOCK);
1255 /* Check that the vnode hasn't been removed while we were obtaining
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);
1262 /* vnode is labelled correctly by now, so we don't have to invalidate it */
1266 #ifdef AFS_DEMAND_ATTACH_FS
1267 if (locktype == READ_LOCK) {
1270 VnChangeState_r(vnp, VN_STATE_EXCLUSIVE);
1274 if (programType == fileServer)
1275 VBumpVolumeUsage_r(Vn_volume(vnp)); /* Hack; don't know where it should be
1276 * called from. Maybe VGetVolume */
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!! */
1285 VPutVnode(Error * ec, register Vnode * vnp)
1288 VPutVnode_r(ec, vnp);
1293 * put back a handle to a vnode object.
1295 * @param[out] ec client error code
1296 * @param[in] vnp vnode object pointer
1298 * @pre VOL_LOCK held.
1299 * ref held on vnode.
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).
1305 * @internal volume package internal use only
1308 VPutVnode_r(Error * ec, register Vnode * vnp)
1312 struct VnodeClassInfo *vcp;
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);
1321 #ifdef AFS_DEMAND_ATTACH_FS
1322 writeLocked = (Vn_state(vnp) == VN_STATE_EXCLUSIVE);
1324 writeLocked = WriteLocked(&vnp->lock);
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->
1339 if (thisProcess != vnp->writer)
1340 Abort("VPutVnode: Vnode at 0x%x locked by another process!\n",
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);
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;
1357 if (vnp->changed_newTime)
1359 V_updateDate(vp) = vp->updateTime = now;
1360 if(V_volUpCounter(vp)<MAXINT)
1361 V_volUpCounter(vp)++;
1364 /* The vnode has been changed. Write it out to disk */
1366 #ifdef AFS_DEMAND_ATTACH_FS
1367 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1369 assert(V_needsSalvaged(vp));
1373 VnStore(ec, vp, vnp, vcp, class);
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).
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)));
1388 vnp->changed_newTime = vnp->changed_oldTime = 0;
1390 #ifdef AFS_DEMAND_ATTACH_FS
1391 VnChangeState_r(vnp, VN_STATE_ONLINE);
1393 } else { /* Not write locked */
1394 if (vnp->changed_newTime || vnp->changed_oldTime || vnp->delete)
1396 ("VPutVnode: Change or delete flag for vnode 0x%x is set but vnode is not write locked!\n",
1398 #ifdef AFS_DEMAND_ATTACH_FS
1403 /* Do not look at disk portion of vnode after this point; it may
1404 * have been deleted above */
1406 VnUnlock(vnp, ((writeLocked) ? WRITE_LOCK : READ_LOCK));
1407 VnCancelReservation_r(vnp);
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
1416 VVnodeWriteToRead(Error * ec, register Vnode * vnp)
1420 retVal = VVnodeWriteToRead_r(ec, vnp);
1426 * convert vnode handle from mutually exclusive to shared access.
1428 * @param[out] ec client error code
1429 * @param[in] vnp vnode object pointer
1431 * @return unspecified use (see out argument 'ec' for error code return)
1433 * @pre VOL_LOCK held.
1434 * ref held on vnode.
1435 * write lock held on vnode.
1437 * @post read lock held on vnode.
1438 * if vnode was modified, it has been written to disk.
1440 * @internal volume package internal use only
1443 VVnodeWriteToRead_r(Error * ec, register Vnode * vnp)
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 */
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);
1461 #ifdef AFS_DEMAND_ATTACH_FS
1462 writeLocked = (Vn_state(vnp) == VN_STATE_EXCLUSIVE);
1464 writeLocked = WriteLocked(&vnp->lock);
1471 VNLog(301, 2, (afs_int32) vnp,
1472 ((vnp->changed_newTime) << 1) | ((vnp->
1473 changed_oldTime) << 1) | vnp->
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",
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;
1498 /* The inode has been changed. Write it out to disk */
1500 #ifdef AFS_DEMAND_ATTACH_FS
1501 VRequestSalvage_r(ec, vp, SALVSYNC_ERROR, 0);
1503 assert(V_needsSalvaged(vp));
1507 VnStore(ec, vp, vnp, vcp, class);
1510 vnp->changed_newTime = vnp->changed_oldTime = 0;
1514 #ifdef AFS_DEMAND_ATTACH_FS
1515 VnChangeState_r(vnp, VN_STATE_ONLINE);
1518 ConvertWriteToReadLock(&vnp->lock);
1524 * initial size of ihandle pointer vector.
1526 * @see VInvalidateVnodesByVolume_r
1528 #define IH_VEC_BASE_SIZE 256
1531 * increment amount for growing ihandle pointer vector.
1533 * @see VInvalidateVnodesByVolume_r
1535 #define IH_VEC_INCREMENT 256
1538 * Compile list of ihandles to be released/reallyclosed at a later time.
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
1544 * @pre - VOL_LOCK is held
1545 * - volume is in appropriate exclusive state (e.g. VOL_STATE_VNODE_CLOSE,
1546 * VOL_STATE_VNODE_RELEASE)
1548 * @post - all vnodes on VVn list are invalidated
1549 * - ih_vec is populated with all valid ihandles
1551 * @return operation status
1553 * @retval ENOMEM out of memory
1555 * @todo we should handle out of memory conditions more gracefully.
1557 * @internal vnode package internal use only
1560 VInvalidateVnodesByVolume_r(Volume * vp,
1561 IHandle_t *** vec_out,
1562 size_t * vec_len_out)
1566 size_t i = 0, vec_len;
1567 IHandle_t **ih_vec, **ih_vec_new;
1569 #ifdef AFS_DEMAND_ATTACH_FS
1571 #endif /* AFS_DEMAND_ATTACH_FS */
1573 vec_len = IH_VEC_BASE_SIZE;
1574 ih_vec = malloc(sizeof(IHandle_t *) * vec_len);
1575 #ifdef AFS_DEMAND_ATTACH_FS
1582 * Traverse the volume's vnode list. Pull all the ihandles out into a
1583 * thread-private array for later asynchronous processing.
1586 for (queue_Scan(&vp->vnode_list, vnp, nvnp, Vnode)) {
1587 if (vnp->handle != NULL) {
1589 #ifdef AFS_DEMAND_ATTACH_FS
1592 vec_len += IH_VEC_INCREMENT;
1593 ih_vec_new = realloc(ih_vec, sizeof(IHandle_t *) * vec_len);
1594 #ifdef AFS_DEMAND_ATTACH_FS
1597 if (ih_vec_new == NULL) {
1601 ih_vec = ih_vec_new;
1602 #ifdef AFS_DEMAND_ATTACH_FS
1604 * Theoretically, the volume's VVn list should not change
1605 * because the volume is in an exclusive state. For the
1606 * sake of safety, we will restart the traversal from the
1607 * the beginning (which is not expensive because we're
1608 * deleting the items from the list as we go).
1610 goto restart_traversal;
1613 ih_vec[i++] = vnp->handle;
1616 DeleteFromVVnList(vnp);
1617 VInvalidateVnode_r(vnp);
1627 /* VCloseVnodeFiles - called when a volume is going off line. All open
1628 * files for vnodes in that volume are closed. This might be excessive,
1629 * since we may only be taking one volume of a volume group offline.
1632 VCloseVnodeFiles_r(Volume * vp)
1634 #ifdef AFS_DEMAND_ATTACH_FS
1635 VolState vol_state_save;
1637 IHandle_t ** ih_vec;
1640 #ifdef AFS_DEMAND_ATTACH_FS
1641 vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_CLOSE);
1642 #endif /* AFS_DEMAND_ATTACH_FS */
1644 /* XXX need better error handling here */
1645 assert(VInvalidateVnodesByVolume_r(vp,
1651 * now we drop VOL_LOCK while we perform some potentially very
1652 * expensive operations in the background
1654 #ifdef AFS_DEMAND_ATTACH_FS
1658 for (i = 0; i < vec_len; i++) {
1659 IH_REALLYCLOSE(ih_vec[i]);
1664 #ifdef AFS_DEMAND_ATTACH_FS
1666 VChangeState_r(vp, vol_state_save);
1667 #endif /* AFS_DEMAND_ATTACH_FS */
1672 * shut down all vnode cache state for a given volume.
1674 * @param[in] vp volume object pointer
1676 * @pre VOL_LOCK is held
1678 * @post all file descriptors closed.
1679 * all inode handles released.
1680 * all vnode cache objects disassociated from volume.
1682 * @note for DAFS, these operations are performed outside the vol glock under
1683 * volume exclusive state VOL_STATE_VNODE_RELEASE. Please further note
1684 * that it would be a bug to acquire and release a volume reservation
1685 * during this exclusive operation. This is due to the fact that we are
1686 * generally called during the refcount 1->0 transition.
1688 * @todo we should handle failures in VInvalidateVnodesByVolume_r more
1691 * @see VInvalidateVnodesByVolume_r
1693 * @internal this routine is internal to the volume package
1696 VReleaseVnodeFiles_r(Volume * vp)
1698 #ifdef AFS_DEMAND_ATTACH_FS
1699 VolState vol_state_save;
1701 IHandle_t ** ih_vec;
1704 #ifdef AFS_DEMAND_ATTACH_FS
1705 vol_state_save = VChangeState_r(vp, VOL_STATE_VNODE_RELEASE);
1706 #endif /* AFS_DEMAND_ATTACH_FS */
1708 /* XXX need better error handling here */
1709 assert(VInvalidateVnodesByVolume_r(vp,
1715 * now we drop VOL_LOCK while we perform some potentially very
1716 * expensive operations in the background
1718 #ifdef AFS_DEMAND_ATTACH_FS
1722 for (i = 0; i < vec_len; i++) {
1723 IH_RELEASE(ih_vec[i]);
1728 #ifdef AFS_DEMAND_ATTACH_FS
1730 VChangeState_r(vp, vol_state_save);
1731 #endif /* AFS_DEMAND_ATTACH_FS */