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 {
22 /* Key used for byte range locking. Each unique key identifies a
23 unique client per cm_scache_t for the purpose of locking. */
24 typedef afs_uint64 cm_key_t;
26 typedef struct cm_range {
33 typedef struct cm_scache cm_scache_t;
35 typedef struct cm_file_lock {
36 osi_queue_t q; /* list of all locks [protected by
38 osi_queue_t fileq; /* per-file list of locks [protected
41 cm_user_t *userp; /* The user to which this lock belongs
42 to [immutable; held] */
43 cm_scache_t *scp; /* The scache to which this lock
44 applies to [immutable; held] */
49 cm_range_t range; /* Range for the lock [immutable] */
50 cm_key_t key; /* Key for the lock [immutable] */
51 unsigned char lockType; /* LockRead or LockWrite [immutable] */
52 unsigned char flags; /* combination of CM_FILELOCK_FLAG__*
53 * [protected by cm_scacheLock] */
54 time_t lastUpdate; /* time of last assertion with
55 * server. [protected by
59 #define CM_FILELOCK_FLAG_DELETED 0x01
60 #define CM_FILELOCK_FLAG_LOST 0x02
62 /* the following are mutually exclusive */
63 #define CM_FILELOCK_FLAG_WAITLOCK 0x04
64 #define CM_FILELOCK_FLAG_WAITUNLOCK 0x0C
66 /* the following is used to indicate that there are no server side
67 locks associated with this lock. This is true for locks obtained
68 against files in RO volumes as well as files residing on servers
69 that disable client side byte range locking. */
70 #define CM_FILELOCK_FLAG_CLIENTONLY 0x10
72 #define CM_FLSHARE_OFFSET_HIGH 0x01000000
73 #define CM_FLSHARE_OFFSET_LOW 0x00000000
74 #define CM_FLSHARE_LENGTH_HIGH 0x00000000
75 #define CM_FLSHARE_LENGTH_LOW 0x00000001
77 typedef struct cm_prefetch { /* last region scanned for prefetching */
78 osi_hyper_t base; /* start of region */
79 osi_hyper_t end; /* first char past region */
82 #define CM_SCACHE_MAGIC ('S' | 'C'<<8 | 'A'<<16 | 'C'<<24)
84 typedef struct cm_scache {
85 osi_queue_t q; /* lru queue; cm_scacheLock */
87 struct cm_scache *nextp; /* next in hash; cm_scacheLock */
88 struct cm_scache *allNextp; /* next in all scache list; cm_scacheLock */
90 afs_uint32 flags; /* flags; locked by mx */
92 /* synchronization stuff */
93 osi_mutex_t mx; /* mutex for this structure */
94 osi_rwlock_t bufCreateLock; /* read-locked during buffer creation;
95 * write-locked to prevent buffers from
96 * being created during a truncate op, etc.
98 afs_uint32 refCount; /* reference count; cm_scacheLock */
99 osi_queueData_t *bufReadsp; /* queue of buffers being read */
100 osi_queueData_t *bufWritesp; /* queue of buffers being written */
102 /* parent info for ACLs */
103 afs_uint32 parentVnode; /* parent vnode for ACL callbacks */
104 afs_uint32 parentUnique; /* for ACL callbacks */
106 /* local modification stat */
107 afs_uint32 mask; /* for clientModTime, length and
111 afs_uint32 fileType; /* file type */
112 time_t clientModTime; /* mtime */
113 time_t serverModTime; /* at server, for concurrent call
115 osi_hyper_t length; /* file length */
116 cm_prefetch_t prefetch; /* prefetch info structure */
117 afs_uint32 unixModeBits; /* unix protection mode bits */
118 afs_uint32 linkCount; /* link count */
119 afs_uint32 dataVersion; /* data version */
120 afs_uint32 owner; /* file owner */
121 afs_uint32 group; /* file owning group */
122 cm_user_t *creator; /* user, if new file */
124 /* pseudo file status */
125 osi_hyper_t serverLength; /* length known to server */
127 /* aux file status */
128 osi_hyper_t truncPos; /* file size to truncate to before
131 /* symlink and mount point info */
132 char mountPointStringp[MOUNTPOINTLEN]; /* the string stored in a mount point;
133 * first char is type, then vol name.
134 * If this is a normal symlink, we store
135 * the link contents here.
137 cm_fid_t mountRootFid; /* mounted on root */
138 time_t mountRootGen; /* time to update mountRootFidp? */
139 cm_fid_t dotdotFid; /* parent of volume root */
142 struct cm_server *cbServerp; /* server granting callback */
143 time_t cbExpires; /* time callback expires */
146 long anyAccess; /* anonymous user's access */
147 struct cm_aclent *randomACLp; /* access cache entries */
150 afs_int32 serverLock; /* current lock we have acquired on
151 * this file. One of (-1), LockRead
152 * or LockWrite. [protected by
153 * scp->mx]. In the future, this
154 * should be replaced by a queue of
155 * cm_server_lock_t objects which keep
156 * track of lock type, the user for
157 * whom the lock was obtained, the
158 * dataVersion at the time the lock
159 * was asserted last, lastRefreshCycle
160 * and lateUpdateTime.
162 unsigned long lastRefreshCycle; /* protected with cm_scacheLock
163 * for all scaches. */
164 afs_uint32 lockDataVersion; /* dataVersion of the scp at the time
165 the server lock for the scp was
166 asserted for this lock the last
168 osi_queue_t *fileLocksH; /* queue of locks (head) */
169 osi_queue_t *fileLocksT; /* queue of locks (tail) */
171 afs_uint32 sharedLocks; /* number of shared locks on
172 * ::fileLocks. This count does not
173 * include locks which have
174 * CM_FILELOCK_FLAG_CLIENTONLY set. */
176 afs_uint32 exclusiveLocks; /* number of exclusive locks on
177 * ::fileLocks. This count does not
178 * include locks which have
179 * CM_FILELOCK_FLAG_CLIENTONLY set.
182 afs_uint32 clientLocks; /* number of locks on ::fileLocks that
183 have CM_FILELOCK_FLAG_CLIENTONLY
187 struct cm_volume *volp; /* volume info; held reference */
189 /* bulk stat progress */
190 osi_hyper_t bulkStatProgress; /* track bulk stats of large dirs */
193 /* directory B+ tree */ /* only allocated if is directory */
194 osi_rwlock_t dirlock; /* controls access to dirBplus */
195 afs_uint32 dirDataVersion; /* data version represented by dirBplus */
196 struct tree *dirBplus; /* dirBplus */
200 afs_uint16 openReads; /* open for reading */
201 afs_uint16 openWrites; /* open for writing */
202 afs_uint16 openShares; /* open for read excl */
203 afs_uint16 openExcls; /* open for exclusives */
206 afs_uint32 waitCount; /* number of threads waiting */
207 afs_uint32 waitRequests; /* num of thread wait requests */
208 osi_queue_t * waitQueueH; /* Queue of waiting threads.
211 objects. Protected by
213 osi_queue_t * waitQueueT; /* locked by cm_scacheLock */
216 /* mask field - tell what has been modified */
217 #define CM_SCACHEMASK_CLIENTMODTIME 1 /* client mod time */
218 #define CM_SCACHEMASK_LENGTH 2 /* length */
219 #define CM_SCACHEMASK_TRUNCPOS 4 /* truncation position */
221 /* fileType values */
222 #define CM_SCACHETYPE_FILE 1 /* a file */
223 #define CM_SCACHETYPE_DIRECTORY 2 /* a dir */
224 #define CM_SCACHETYPE_SYMLINK 3 /* a symbolic link */
225 #define CM_SCACHETYPE_MOUNTPOINT 4 /* a mount point */
226 #define CM_SCACHETYPE_DFSLINK 5 /* a Microsoft Dfs link */
227 #define CM_SCACHETYPE_INVALID 99 /* an invalid link */
230 #define CM_SCACHEFLAG_STATD 0x01 /* status info is valid */
231 #define CM_SCACHEFLAG_DELETED 0x02 /* file has been deleted */
232 #define CM_SCACHEFLAG_CALLBACK 0x04 /* have a valid callback */
233 #define CM_SCACHEFLAG_STORING 0x08 /* status being stored back */
234 #define CM_SCACHEFLAG_FETCHING 0x10 /* status being fetched */
235 #define CM_SCACHEFLAG_SIZESTORING 0x20 /* status being stored that
236 * changes the data; typically,
237 * this is a truncate op. */
238 #define CM_SCACHEFLAG_INHASH 0x40 /* in the hash table */
239 #define CM_SCACHEFLAG_BULKSTATTING 0x80 /* doing a bulk stat */
240 #define CM_SCACHEFLAG_WAITING 0x200 /* waiting for fetch/store
242 #define CM_SCACHEFLAG_PURERO 0x400 /* read-only (not even backup);
243 * for mount point eval */
244 #define CM_SCACHEFLAG_RO 0x800 /* read-only
245 * (can't do write ops) */
246 #define CM_SCACHEFLAG_GETCALLBACK 0x1000 /* we're getting a callback */
247 #define CM_SCACHEFLAG_DATASTORING 0x2000 /* data being stored */
248 #define CM_SCACHEFLAG_PREFETCHING 0x4000 /* somebody is prefetching */
249 #define CM_SCACHEFLAG_OVERQUOTA 0x8000 /* over quota */
250 #define CM_SCACHEFLAG_OUTOFSPACE 0x10000 /* out of space */
251 #define CM_SCACHEFLAG_ASYNCSTORING 0x20000 /* scheduled to store back */
252 #define CM_SCACHEFLAG_LOCKING 0x40000 /* setting/clearing file lock */
253 #define CM_SCACHEFLAG_WATCHED 0x80000 /* directory being watched */
254 #define CM_SCACHEFLAG_WATCHEDSUBTREE 0x100000 /* dir subtree being watched */
255 #define CM_SCACHEFLAG_ANYWATCH \
256 (CM_SCACHEFLAG_WATCHED | CM_SCACHEFLAG_WATCHEDSUBTREE)
258 #define CM_SCACHEFLAG_EACCESS 0x200000 /* Bulk Stat returned EACCES */
259 #define CM_SCACHEFLAG_SMB_FID 0x400000
261 /* sync flags for calls to the server. The CM_SCACHEFLAG_FETCHING,
262 * CM_SCACHEFLAG_STORING and CM_SCACHEFLAG_SIZESTORING flags correspond to the
263 * below, except for FETCHDATA and STOREDATA, which correspond to non-null
264 * buffers in bufReadsp and bufWritesp.
265 * These flags correspond to individual RPCs that we may be making, and at most
266 * one can be set in any one call to SyncOp.
268 #define CM_SCACHESYNC_FETCHSTATUS 0x01 /* fetching status info */
269 #define CM_SCACHESYNC_STORESTATUS 0x02 /* storing status info */
270 #define CM_SCACHESYNC_FETCHDATA 0x04 /* fetch data */
271 #define CM_SCACHESYNC_STOREDATA 0x08 /* store data */
272 #define CM_SCACHESYNC_STORESIZE 0x10 /* store new file size */
273 #define CM_SCACHESYNC_GETCALLBACK 0x20 /* fetching a callback */
274 #define CM_SCACHESYNC_STOREDATA_EXCL 0x40 /* store data */
275 #define CM_SCACHESYNC_ASYNCSTORE 0x80 /* schedule data store */
276 #define CM_SCACHESYNC_LOCK 0x100 /* set/clear file lock */
278 /* sync flags for calls within the client; there are no corresponding flags
279 * in the scache entry, because we hold the scache entry locked during the
282 #define CM_SCACHESYNC_GETSTATUS 0x1000 /* read the status */
283 #define CM_SCACHESYNC_SETSTATUS 0x2000 /* e.g. utimes */
284 #define CM_SCACHESYNC_READ 0x4000 /* read data from a chunk */
285 #define CM_SCACHESYNC_WRITE 0x8000 /* write data to a chunk */
286 #define CM_SCACHESYNC_SETSIZE 0x10000 /* shrink the size of a file,
288 #define CM_SCACHESYNC_NEEDCALLBACK 0x20000 /* need a callback on the file */
289 #define CM_SCACHESYNC_CHECKRIGHTS 0x40000 /* check that user has desired
291 #define CM_SCACHESYNC_BUFLOCKED 0x80000 /* the buffer is locked */
292 #define CM_SCACHESYNC_NOWAIT 0x100000/* don't wait for the state,
294 #define CM_SCACHESYNC_FORCECB 0x200000/* when calling cm_GetCallback()
295 * set the force flag */
297 /* flags for cm_RecycleSCache */
298 #define CM_SCACHE_RECYCLEFLAG_DESTROY_BUFFERS 0x1
300 /* flags for cm_MergeStatus */
301 #define CM_MERGEFLAG_FORCE 1 /* check mtime before merging;
302 * used to see if we're merging
305 #define CM_MERGEFLAG_STOREDATA 2 /* Merge due to storedata op */
307 /* hash define. Must not include the cell, since the callback revocation code
308 * doesn't necessarily know the cell in the case of a multihomed server
309 * contacting us from a mystery address.
311 #define CM_SCACHE_HASH(fidp) (((unsigned long) \
315 % cm_data.scacheHashTableSize)
317 typedef struct cm_scache_waiter {
324 } cm_scache_waiter_t;
329 extern void cm_InitSCache(int, long);
331 #ifdef DEBUG_REFCOUNT
332 extern long cm_GetSCacheDbg(cm_fid_t *, cm_scache_t **, struct cm_user *,
333 struct cm_req *, char *, long);
335 #define cm_GetSCache(a,b,c,d) cm_GetSCacheDbg(a,b,c,d,__FILE__,__LINE__)
337 extern long cm_GetSCache(cm_fid_t *, cm_scache_t **, struct cm_user *,
341 extern cm_scache_t *cm_GetNewSCache(void);
343 extern int cm_FidCmp(cm_fid_t *, cm_fid_t *);
345 extern long cm_SyncOp(cm_scache_t *, struct cm_buf *, struct cm_user *,
346 struct cm_req *, afs_uint32, afs_uint32);
348 extern void cm_SyncOpDone(cm_scache_t *, struct cm_buf *, afs_uint32);
350 extern void cm_MergeStatus(cm_scache_t * dscp, cm_scache_t * scp,
351 struct AFSFetchStatus * statusp,
352 struct AFSVolSync * volsyncp,
353 struct cm_user *userp,
356 extern void cm_AFSFidFromFid(struct AFSFid *, cm_fid_t *);
358 #ifdef DEBUG_REFCOUNT
359 extern void cm_HoldSCacheNoLockDbg(cm_scache_t *, char *, long);
361 extern void cm_HoldSCacheDbg(cm_scache_t *, char *, long);
363 extern void cm_ReleaseSCacheNoLockDbg(cm_scache_t *, char *, long);
365 extern void cm_ReleaseSCacheDbg(cm_scache_t *, char *, long);
367 #define cm_HoldSCacheNoLock(scp) cm_HoldSCacheNoLockDbg(scp, __FILE__, __LINE__)
368 #define cm_HoldSCache(scp) cm_HoldSCacheDbg(scp, __FILE__, __LINE__)
369 #define cm_ReleaseSCacheNoLock(scp) cm_ReleaseSCacheNoLockDbg(scp, __FILE__, __LINE__)
370 #define cm_ReleaseSCache(scp) cm_ReleaseSCacheDbg(scp, __FILE__, __LINE__)
372 extern void cm_HoldSCacheNoLock(cm_scache_t *);
374 extern void cm_HoldSCache(cm_scache_t *);
376 extern void cm_ReleaseSCacheNoLock(cm_scache_t *);
378 extern void cm_ReleaseSCache(cm_scache_t *);
380 extern cm_scache_t *cm_FindSCache(cm_fid_t *fidp);
382 extern cm_scache_t *cm_FindSCacheParent(cm_scache_t *);
384 extern osi_rwlock_t cm_scacheLock;
386 extern osi_queue_t *cm_allFileLocks;
388 extern osi_queue_t *cm_freeFileLocks;
390 extern unsigned long cm_lockRefreshCycle;
392 extern void cm_DiscardSCache(cm_scache_t *scp);
394 extern int cm_FindFileType(cm_fid_t *fidp);
396 extern long cm_ValidateSCache(void);
398 extern long cm_ShutdownSCache(void);
400 extern void cm_SuspendSCache(void);
402 extern long cm_RecycleSCache(cm_scache_t *scp, afs_int32 flags);
404 extern void cm_RemoveSCacheFromHashTable(cm_scache_t *scp);
405 #endif /* __CM_SCACHE_H_ENV__ */