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
10 #ifndef __CM_SCACHE_H_ENV__
11 #define __CM_SCACHE_H_ENV__ 1
13 #define MOUNTPOINTLEN 1024 /* max path length for symlink; same as AFSPATHMAX */
15 typedef struct cm_fid {
24 /* Key used for byte range locking. Each unique key identifies a
25 unique client per cm_scache_t for the purpose of locking. */
26 typedef struct cm_key {
27 afs_offs_t process_id; /* process IDs can be 64bit on 64bit environments */
28 afs_uint16 session_id;
32 typedef struct cm_range {
39 typedef struct cm_scache cm_scache_t;
41 typedef struct cm_file_lock {
42 osi_queue_t q; /* list of all locks [protected by
44 osi_queue_t fileq; /* per-file list of locks [protected
47 cm_user_t *userp; /* The user to which this lock belongs
48 to [immutable; held] */
49 cm_scache_t *scp; /* The scache to which this lock
50 applies to [immutable; held] */
55 cm_range_t range; /* Range for the lock [immutable] */
56 cm_key_t key; /* Key for the lock [immutable] */
57 unsigned char lockType; /* LockRead or LockWrite [immutable] */
58 unsigned char flags; /* combination of CM_FILELOCK_FLAG__*
59 * [protected by cm_scacheLock] */
60 time_t lastUpdate; /* time of last assertion with
61 * server. [protected by
65 #define CM_FILELOCK_FLAG_DELETED 0x01
66 #define CM_FILELOCK_FLAG_LOST 0x02
68 /* the following are mutually exclusive */
69 #define CM_FILELOCK_FLAG_WAITLOCK 0x04
70 #define CM_FILELOCK_FLAG_WAITUNLOCK 0x0C
72 /* the following is used to indicate that there are no server side
73 locks associated with this lock. This is true for locks obtained
74 against files in RO volumes as well as files residing on servers
75 that disable client side byte range locking. */
76 #define CM_FILELOCK_FLAG_CLIENTONLY 0x10
78 #define CM_FLSHARE_OFFSET_HIGH 0x01000000
79 #define CM_FLSHARE_OFFSET_LOW 0x00000000
80 #define CM_FLSHARE_LENGTH_HIGH 0x00000000
81 #define CM_FLSHARE_LENGTH_LOW 0x00000001
83 typedef struct cm_prefetch { /* last region scanned for prefetching */
84 osi_hyper_t base; /* start of region */
85 osi_hyper_t end; /* first char past region */
88 #define CM_SCACHE_MAGIC ('S' | 'C'<<8 | 'A'<<16 | 'C'<<24)
90 typedef struct cm_scache {
91 osi_queue_t q; /* lru queue; cm_scacheLock */
93 struct cm_scache *nextp; /* next in hash; cm_scacheLock */
94 struct cm_scache *allNextp; /* next in all scache list; cm_scacheLock */
96 afs_uint32 flags; /* flags; locked by rw */
98 /* synchronization stuff */
99 osi_rwlock_t rw; /* rwlock for this structure */
100 osi_rwlock_t bufCreateLock; /* read-locked during buffer creation;
101 * write-locked to prevent buffers from
102 * being created during a truncate op, etc.
104 afs_int32 refCount; /* reference count; cm_scacheLock */
105 osi_queueData_t *bufReadsp; /* queue of buffers being read */
106 osi_queueData_t *bufWritesp; /* queue of buffers being written */
108 /* parent info for ACLs */
109 afs_uint32 parentVnode; /* parent vnode for ACL callbacks */
110 afs_uint32 parentUnique; /* for ACL callbacks */
112 /* local modification stat */
113 afs_uint32 mask; /* for clientModTime, length and
117 afs_uint32 fileType; /* file type */
118 time_t clientModTime; /* mtime */
119 time_t serverModTime; /* at server, for concurrent call
121 osi_hyper_t length; /* file length */
122 cm_prefetch_t prefetch; /* prefetch info structure */
123 afs_uint32 unixModeBits; /* unix protection mode bits */
124 afs_uint32 linkCount; /* link count */
125 afs_uint64 dataVersion; /* data version */
126 afs_uint64 bufDataVersionLow; /* range of valid cm_buf_t dataVersions */
127 afs_uint32 owner; /* file owner */
128 afs_uint32 group; /* file owning group */
129 cm_user_t *creator; /* user, if new file */
131 /* pseudo file status */
132 osi_hyper_t serverLength; /* length known to server */
134 /* aux file status */
135 osi_hyper_t truncPos; /* file size to truncate to before
138 /* symlink and mount point info */
139 char mountPointStringp[MOUNTPOINTLEN]; /* the string stored in a mount point;
140 * first char is type, then vol name.
141 * If this is a normal symlink, we store
142 * the link contents here.
144 cm_fid_t mountRootFid; /* mounted on root */
145 time_t mountRootGen; /* time to update mountRootFidp? */
146 cm_fid_t dotdotFid; /* parent of volume root */
149 struct cm_server *cbServerp; /* server granting callback */
150 time_t cbExpires; /* time callback expires */
153 long anyAccess; /* anonymous user's access */
154 struct cm_aclent *randomACLp; /* access cache entries */
157 afs_int32 serverLock; /* current lock we have acquired on
158 * this file. One of (-1), LockRead
159 * or LockWrite. [protected by
160 * scp->rw]. In the future, this
161 * should be replaced by a queue of
162 * cm_server_lock_t objects which keep
163 * track of lock type, the user for
164 * whom the lock was obtained, the
165 * dataVersion at the time the lock
166 * was asserted last, lastRefreshCycle
167 * and lateUpdateTime.
169 unsigned long lastRefreshCycle; /* protected with cm_scacheLock
170 * for all scaches. */
171 afs_uint64 lockDataVersion; /* dataVersion of the scp at the time
172 the server lock for the scp was
173 asserted for this lock the last
175 osi_queue_t *fileLocksH; /* queue of locks (head) */
176 osi_queue_t *fileLocksT; /* queue of locks (tail) */
178 afs_uint32 sharedLocks; /* number of shared locks on
179 * ::fileLocks. This count does not
180 * include locks which have
181 * CM_FILELOCK_FLAG_CLIENTONLY set. */
183 afs_uint32 exclusiveLocks; /* number of exclusive locks on
184 * ::fileLocks. This count does not
185 * include locks which have
186 * CM_FILELOCK_FLAG_CLIENTONLY set.
189 afs_uint32 clientLocks; /* number of locks on ::fileLocks that
190 have CM_FILELOCK_FLAG_CLIENTONLY
193 /* bulk stat progress */
194 osi_hyper_t bulkStatProgress; /* track bulk stats of large dirs */
197 /* directory B+ tree */ /* only allocated if is directory */
198 osi_rwlock_t dirlock; /* controls access to dirBplus */
199 afs_uint64 dirDataVersion; /* data version represented by dirBplus */
200 struct tree *dirBplus; /* dirBplus */
204 afs_uint16 openReads; /* open for reading */
205 afs_uint16 openWrites; /* open for writing */
206 afs_uint16 openShares; /* open for read excl */
207 afs_uint16 openExcls; /* open for exclusives */
210 afs_uint32 waitCount; /* number of threads waiting */
211 afs_uint32 waitRequests; /* num of thread wait requests */
212 osi_queue_t * waitQueueH; /* Queue of waiting threads.
215 objects. Protected by
217 osi_queue_t * waitQueueT; /* locked by cm_scacheLock */
220 /* mask field - tell what has been modified */
221 #define CM_SCACHEMASK_CLIENTMODTIME 1 /* client mod time */
222 #define CM_SCACHEMASK_LENGTH 2 /* length */
223 #define CM_SCACHEMASK_TRUNCPOS 4 /* truncation position */
225 /* fileType values */
226 #define CM_SCACHETYPE_FILE 1 /* a file */
227 #define CM_SCACHETYPE_DIRECTORY 2 /* a dir */
228 #define CM_SCACHETYPE_SYMLINK 3 /* a symbolic link */
229 #define CM_SCACHETYPE_MOUNTPOINT 4 /* a mount point */
230 #define CM_SCACHETYPE_DFSLINK 5 /* a Microsoft Dfs link */
231 #define CM_SCACHETYPE_INVALID 99 /* an invalid link */
234 #define CM_SCACHEFLAG_STATD 0x01 /* status info is valid */
235 #define CM_SCACHEFLAG_DELETED 0x02 /* file has been deleted */
236 #define CM_SCACHEFLAG_CALLBACK 0x04 /* have a valid callback */
237 #define CM_SCACHEFLAG_STORING 0x08 /* status being stored back */
238 #define CM_SCACHEFLAG_FETCHING 0x10 /* status being fetched */
239 #define CM_SCACHEFLAG_SIZESTORING 0x20 /* status being stored that
240 * changes the data; typically,
241 * this is a truncate op. */
242 #define CM_SCACHEFLAG_INHASH 0x40 /* in the hash table */
243 #define CM_SCACHEFLAG_BULKSTATTING 0x80 /* doing a bulk stat */
244 #define CM_SCACHEFLAG_WAITING 0x200 /* waiting for fetch/store
246 #define CM_SCACHEFLAG_PURERO 0x400 /* read-only (not even backup);
247 * for mount point eval */
248 #define CM_SCACHEFLAG_RO 0x800 /* read-only
249 * (can't do write ops) */
250 #define CM_SCACHEFLAG_GETCALLBACK 0x1000 /* we're getting a callback */
251 #define CM_SCACHEFLAG_DATASTORING 0x2000 /* data being stored */
252 #define CM_SCACHEFLAG_PREFETCHING 0x4000 /* somebody is prefetching */
253 #define CM_SCACHEFLAG_OVERQUOTA 0x8000 /* over quota */
254 #define CM_SCACHEFLAG_OUTOFSPACE 0x10000 /* out of space */
255 #define CM_SCACHEFLAG_ASYNCSTORING 0x20000 /* scheduled to store back */
256 #define CM_SCACHEFLAG_LOCKING 0x40000 /* setting/clearing file lock */
257 #define CM_SCACHEFLAG_WATCHED 0x80000 /* directory being watched */
258 #define CM_SCACHEFLAG_WATCHEDSUBTREE 0x100000 /* dir subtree being watched */
259 #define CM_SCACHEFLAG_ANYWATCH \
260 (CM_SCACHEFLAG_WATCHED | CM_SCACHEFLAG_WATCHEDSUBTREE)
262 #define CM_SCACHEFLAG_EACCESS 0x200000 /* Bulk Stat returned EACCES */
263 #define CM_SCACHEFLAG_SMB_FID 0x400000
264 #define CM_SCACHEFLAG_LOCAL 0x800000 /* Locally modified */
266 /* sync flags for calls to the server. The CM_SCACHEFLAG_FETCHING,
267 * CM_SCACHEFLAG_STORING and CM_SCACHEFLAG_SIZESTORING flags correspond to the
268 * below, except for FETCHDATA and STOREDATA, which correspond to non-null
269 * buffers in bufReadsp and bufWritesp.
270 * These flags correspond to individual RPCs that we may be making, and at most
271 * one can be set in any one call to SyncOp.
273 #define CM_SCACHESYNC_FETCHSTATUS 0x01 /* fetching status info */
274 #define CM_SCACHESYNC_STORESTATUS 0x02 /* storing status info */
275 #define CM_SCACHESYNC_FETCHDATA 0x04 /* fetch data */
276 #define CM_SCACHESYNC_STOREDATA 0x08 /* store data */
277 #define CM_SCACHESYNC_STORESIZE 0x10 /* store new file size */
278 #define CM_SCACHESYNC_GETCALLBACK 0x20 /* fetching a callback */
279 #define CM_SCACHESYNC_STOREDATA_EXCL 0x40 /* store data */
280 #define CM_SCACHESYNC_ASYNCSTORE 0x80 /* schedule data store */
281 #define CM_SCACHESYNC_LOCK 0x100 /* set/clear file lock */
283 /* sync flags for calls within the client; there are no corresponding flags
284 * in the scache entry, because we hold the scache entry locked during the
287 #define CM_SCACHESYNC_GETSTATUS 0x1000 /* read the status */
288 #define CM_SCACHESYNC_SETSTATUS 0x2000 /* e.g. utimes */
289 #define CM_SCACHESYNC_READ 0x4000 /* read data from a chunk */
290 #define CM_SCACHESYNC_WRITE 0x8000 /* write data to a chunk */
291 #define CM_SCACHESYNC_SETSIZE 0x10000 /* shrink the size of a file,
293 #define CM_SCACHESYNC_NEEDCALLBACK 0x20000 /* need a callback on the file */
294 #define CM_SCACHESYNC_CHECKRIGHTS 0x40000 /* check that user has desired
296 #define CM_SCACHESYNC_BUFLOCKED 0x80000 /* the buffer is locked */
297 #define CM_SCACHESYNC_NOWAIT 0x100000/* don't wait for the state,
299 #define CM_SCACHESYNC_FORCECB 0x200000/* when calling cm_GetCallback()
300 * set the force flag */
302 /* flags for cm_RecycleSCache */
303 #define CM_SCACHE_RECYCLEFLAG_DESTROY_BUFFERS 0x1
305 /* flags for cm_MergeStatus */
306 #define CM_MERGEFLAG_FORCE 1 /* check mtime before merging;
307 * used to see if we're merging
310 #define CM_MERGEFLAG_STOREDATA 2 /* Merge due to storedata op */
311 #define CM_MERGEFLAG_DIROP 4 /* Merge due to directory op */
313 /* hash define. Must not include the cell, since the callback revocation code
314 * doesn't necessarily know the cell in the case of a multihomed server
315 * contacting us from a mystery address.
317 #define CM_SCACHE_HASH(fidp) (((unsigned long) \
321 % cm_data.scacheHashTableSize)
326 typedef struct cm_scache_waiter {
333 } cm_scache_waiter_t;
335 extern void cm_InitSCache(int, long);
337 #ifdef DEBUG_REFCOUNT
338 extern long cm_GetSCacheDbg(cm_fid_t *, cm_scache_t **, struct cm_user *,
339 struct cm_req *, char *, long);
341 #define cm_GetSCache(a,b,c,d) cm_GetSCacheDbg(a,b,c,d,__FILE__,__LINE__)
343 extern long cm_GetSCache(cm_fid_t *, cm_scache_t **, struct cm_user *,
347 extern cm_scache_t *cm_GetNewSCache(void);
349 extern __inline int cm_FidCmp(cm_fid_t *, cm_fid_t *);
351 extern void cm_SetFid(cm_fid_t *, afs_uint32 cell, afs_uint32 volume, afs_uint32 vnode, afs_uint32 unique);
353 extern long cm_SyncOp(cm_scache_t *, struct cm_buf *, struct cm_user *,
354 struct cm_req *, afs_uint32, afs_uint32);
356 extern void cm_SyncOpDone(cm_scache_t *, struct cm_buf *, afs_uint32);
358 extern void cm_MergeStatus(cm_scache_t * dscp, cm_scache_t * scp,
359 struct AFSFetchStatus * statusp,
360 struct AFSVolSync * volsyncp,
361 struct cm_user *userp,
364 extern void cm_AFSFidFromFid(struct AFSFid *, cm_fid_t *);
366 #ifdef DEBUG_REFCOUNT
367 extern void cm_HoldSCacheNoLockDbg(cm_scache_t *, char *, long);
369 extern void cm_HoldSCacheDbg(cm_scache_t *, char *, long);
371 extern void cm_ReleaseSCacheNoLockDbg(cm_scache_t *, char *, long);
373 extern void cm_ReleaseSCacheDbg(cm_scache_t *, char *, long);
375 #define cm_HoldSCacheNoLock(scp) cm_HoldSCacheNoLockDbg(scp, __FILE__, __LINE__)
376 #define cm_HoldSCache(scp) cm_HoldSCacheDbg(scp, __FILE__, __LINE__)
377 #define cm_ReleaseSCacheNoLock(scp) cm_ReleaseSCacheNoLockDbg(scp, __FILE__, __LINE__)
378 #define cm_ReleaseSCache(scp) cm_ReleaseSCacheDbg(scp, __FILE__, __LINE__)
380 extern void cm_HoldSCacheNoLock(cm_scache_t *);
382 extern void cm_HoldSCache(cm_scache_t *);
384 extern void cm_ReleaseSCacheNoLock(cm_scache_t *);
386 extern void cm_ReleaseSCache(cm_scache_t *);
388 extern cm_scache_t *cm_FindSCache(cm_fid_t *fidp);
390 extern cm_scache_t *cm_FindSCacheParent(cm_scache_t *);
392 extern osi_rwlock_t cm_scacheLock;
394 extern osi_queue_t *cm_allFileLocks;
396 extern osi_queue_t *cm_freeFileLocks;
398 extern unsigned long cm_lockRefreshCycle;
400 extern void cm_DiscardSCache(cm_scache_t *scp);
402 extern int cm_FindFileType(cm_fid_t *fidp);
404 extern long cm_ValidateSCache(void);
406 extern long cm_ShutdownSCache(void);
408 extern void cm_SuspendSCache(void);
410 extern long cm_RecycleSCache(cm_scache_t *scp, afs_int32 flags);
412 extern void cm_RemoveSCacheFromHashTable(cm_scache_t *scp);
414 extern void cm_AdjustScacheLRU(cm_scache_t *scp);
416 extern int cm_DumpSCache(FILE *outputFile, char *cookie, int lock);
418 extern void cm_ResetSCacheDirectory(cm_scache_t *scp);
419 #endif /* __CM_SCACHE_H_ENV__ */