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
13 Institution: The Information Technology Center, Carnegie-Mellon University
17 #define Date afs_uint32
19 struct Volume; /* Potentially forward definition. */
21 typedef struct ViceLock {
26 #define ViceLockCheckLocked(vptr) ((vptr)->lockTime == 0)
27 #define ViceLockClear(vptr) ((vptr)->lockCount = (vptr)->lockTime = 0)
31 /*typedef enum {vNull=0, vFile=1, vDirectory=2, vSymlink=3} VnodeType;*/
32 typedef unsigned int VnodeType;
38 /*typedef enum {vLarge=0,vSmall=1} VnodeClass;*/
41 typedef int VnodeClass;
42 #define VNODECLASSWIDTH 1
43 #define VNODECLASSMASK ((1<<VNODECLASSWIDTH)-1)
44 #define nVNODECLASSES (VNODECLASSMASK+1)
46 struct VnodeClassInfo {
47 struct Vnode *lruHead; /* Head of list of vnodes of this class */
48 int diskSize; /* size of vnode disk object, power of 2 */
49 int logSize; /* log 2 diskSize */
50 int residentSize; /* resident size of vnode */
51 int cacheSize; /* Vnode cache size */
52 bit32 magic; /* Magic number for this type of vnode,
53 * for as long as we're using vnode magic
55 int allocs; /* Total number of successful allocation
56 * requests; this is the same as the number
57 * of sanity checks on the vnode index */
58 int gets, reads; /* Number of VGetVnodes and corresponding
60 int writes; /* Number of vnode writes */
63 extern struct VnodeClassInfo VnodeClassInfo[nVNODECLASSES];
65 #define vnodeTypeToClass(type) ((type) == vDirectory? vLarge: vSmall)
66 #define vnodeIdToClass(vnodeId) ((vnodeId-1)&VNODECLASSMASK)
67 #define vnodeIdToBitNumber(v) (((v)-1)>>VNODECLASSWIDTH)
68 /* The following calculation allows for a header record at the beginning
69 of the index. The header record is the same size as a vnode */
70 #define vnodeIndexOffset(vcp,vnodeNumber) \
71 ((vnodeIdToBitNumber(vnodeNumber)+1)<<(vcp)->logSize)
72 #define bitNumberToVnodeNumber(b,class) ((VnodeId)(((b)<<VNODECLASSWIDTH)+(class)+1))
73 #define vnodeIsDirectory(vnodeNumber) (vnodeIdToClass(vnodeNumber) == vLarge)
75 typedef struct VnodeDiskObject {
76 unsigned int type:3; /* Vnode is file, directory, symbolic link
78 unsigned int cloned:1; /* This vnode was cloned--therefore the inode
79 * is copy-on-write; only set for directories */
80 unsigned int modeBits:12; /* Unix mode bits */
81 signed int linkCount:16; /* Number of directory references to vnode
82 * (from single directory only!) */
83 bit32 length; /* Number of bytes in this file */
84 Unique uniquifier; /* Uniquifier for the vnode; assigned
85 * from the volume uniquifier (actually
86 * from nextVnodeUnique in the Volume
88 FileVersion dataVersion; /* version number of the data */
89 afs_int32 vn_ino_lo; /* inode number of the data attached to
90 * this vnode - entire ino for standard */
91 Date unixModifyTime; /* set by user */
92 UserId author; /* Userid of the last user storing the file */
93 UserId owner; /* Userid of the user who created the file */
94 VnodeId parent; /* Parent directory vnode */
95 bit32 vnodeMagic; /* Magic number--mainly for file server
97 # define SMALLVNODEMAGIC 0xda8c041F
98 # define LARGEVNODEMAGIC 0xad8765fe
99 /* Vnode magic can be removed, someday, if we run need the room. Simply
100 * have to be sure that the thing we replace can be VNODEMAGIC, rather
101 * than 0 (in an old file system). Or go through and zero the fields,
102 * when we notice a version change (the index version number) */
103 ViceLock lock; /* Advisory lock */
104 Date serverModifyTime; /* Used only by the server; for incremental
106 afs_int32 group; /* unix group */
107 afs_int32 vn_ino_hi; /* high part of 64 bit inode. */
110 * archiving/migration
115 #define SIZEOF_SMALLDISKVNODE 64
116 #define CHECKSIZE_SMALLVNODE\
117 (sizeof(VnodeDiskObject) == SIZEOF_SMALLDISKVNODE)
118 #define SIZEOF_LARGEDISKVNODE 256
120 typedef struct Vnode {
121 struct Vnode *hashNext; /* Next vnode on hash conflict chain */
122 struct Vnode *lruNext; /* Less recently used vnode than this one */
123 struct Vnode *lruPrev; /* More recently used vnode than this one */
124 /* The lruNext, lruPrev fields are not
125 * meaningful if the vnode is in use */
126 bit16 hashIndex; /* Hash table index */
128 unsigned changed_newTime:1; /* 1 if vnode changed, write time */
129 unsigned changed_oldTime:1; /* 1 changed, don't update time. */
130 unsigned delete:1; /* 1 if the vnode should be deleted; in
131 * this case, changed must also be 1 */
133 byte changed_newTime:1; /* 1 if vnode changed, write time */
134 byte changed_oldTime:1; /* 1 changed, don't update time. */
135 byte delete:1; /* 1 if the vnode should be deleted; in
136 * this case, changed must also be 1 */
140 *volumePtr; /* Pointer to the volume containing this file */
141 byte nUsers; /* Number of lwp's who have done a VGetVnode */
142 bit32 cacheCheck; /* Must equal the value in the volume Header
143 * for the cache entry to be valid */
144 struct Lock lock; /* Internal lock */
145 #ifdef AFS_PTHREAD_ENV
146 pthread_t writer; /* thread holding write lock */
147 #else /* AFS_PTHREAD_ENV */
148 PROCESS writer; /* Process id having write lock */
149 #endif /* AFS_PTHREAD_ENV */
151 VnodeDiskObject disk; /* The actual disk data for the vnode */
154 #define SIZEOF_LARGEVNODE \
155 (sizeof(struct Vnode) - sizeof(VnodeDiskObject) + SIZEOF_LARGEDISKVNODE)
156 #define SIZEOF_SMALLVNODE (sizeof (struct Vnode))
158 #ifdef AFS_LARGEFILE_ENV
159 #define VN_GET_LEN(N, V) FillInt64(N, (V)->disk.reserved6, (V)->disk.length)
160 #define VNDISK_GET_LEN(N, V) FillInt64(N, (V)->reserved6, (V)->length)
161 #define VN_SET_LEN(V, N) SplitInt64(N, (V)->disk.reserved6, (V)->disk.length)
162 #define VNDISK_SET_LEN(V, N) SplitInt64(N, (V)->reserved6, (V)->length)
163 #else /* !AFS_LARGEFILE_ENV */
164 #define VN_GET_LEN(N, V) (N) = (V)->disk.length;
165 #define VNDISK_GET_LEN(N, V) (N) = (V)->length;
166 #define VN_SET_LEN(V, N) (V)->disk.length = (N);
167 #define VNDISK_SET_LEN(V, N) (V)->length = (N);
168 #endif /* !AFS_LARGEFILE_ENV */
170 #ifdef AFS_64BIT_IOPS_ENV
171 #define VN_GET_INO(V) ((Inode)((V)->disk.vn_ino_lo | \
172 ((V)->disk.vn_ino_hi ? \
173 (((Inode)(V)->disk.vn_ino_hi)<<32) : 0)))
175 #define VN_SET_INO(V, I) ((V)->disk.vn_ino_lo = (int)((I)&0xffffffff), \
176 ((V)->disk.vn_ino_hi = (I) ? \
177 (int)(((I)>>32)&0xffffffff) : 0))
179 #define VNDISK_GET_INO(V) ((Inode)((V)->vn_ino_lo | \
181 (((Inode)(V)->vn_ino_hi)<<32) : 0)))
183 #define VNDISK_SET_INO(V, I) ((V)->vn_ino_lo = (int)(I&0xffffffff), \
184 ((V)->vn_ino_hi = (I) ? \
185 (int)(((I)>>32)&0xffffffff) : 0))
187 #define VN_GET_INO(V) ((V)->disk.vn_ino_lo)
188 #define VN_SET_INO(V, I) ((V)->disk.vn_ino_lo = (I))
189 #define VNDISK_GET_INO(V) ((V)->vn_ino_lo)
190 #define VNDISK_SET_INO(V, I) ((V)->vn_ino_lo = (I))
193 #define VVnodeDiskACL(v) /* Only call this with large (dir) vnode!! */ \
194 ((AL_AccessList *) (((byte *)(v))+SIZEOF_SMALLDISKVNODE))
195 #define VVnodeACL(vnp) (VVnodeDiskACL(&(vnp)->disk))
196 /* VAclSize is defined this way to allow information in the vnode header
197 to grow, in a POSSIBLY upward compatible manner. SIZEOF_SMALLDISKVNODE
198 is the maximum size of the basic vnode. The vnode header of either type
199 can actually grow to this size without conflicting with the ACL on larger
201 #define VAclSize(vnp) (SIZEOF_LARGEDISKVNODE - SIZEOF_SMALLDISKVNODE)
202 #define VAclDiskSize(v) (SIZEOF_LARGEDISKVNODE - SIZEOF_SMALLDISKVNODE)
203 /*extern int VolumeHashOffset(); */
204 extern int VolumeHashOffset_r(void);
205 extern VInitVnodes(VnodeClass class, int nVnodes);
206 /*extern VInitVnodes_r();*/
207 extern Vnode *VGetVnode(Error * ec, struct Volume *vp, VnodeId vnodeNumber,
209 extern Vnode *VGetVnode_r(Error * ec, struct Volume *vp, VnodeId vnodeNumber,
211 extern void VPutVnode(Error * ec, register Vnode * vnp);
212 extern void VPutVnode_r(Error * ec, register Vnode * vnp);
213 extern VVnodeWriteToRead(Error * ec, register Vnode * vnp);
214 extern VVnodeWriteToRead_r(Error * ec, register Vnode * vnp);
215 extern Vnode *VAllocVnode(Error * ec, struct Volume *vp, VnodeType type);
216 extern Vnode *VAllocVnode_r(Error * ec, struct Volume *vp, VnodeType type);
217 /*extern VFreeVnode();*/
218 extern Vnode *VGetFreeVnode_r(struct VnodeClassInfo *vcp);