f0ab19a53422bd3d6de99b8c7c2b94195a6c76da
[openafs.git] / src / WINNT / afsd / cm_scache.h
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
10 #ifndef OPENAFS_WINNT_AFSD_CM_SCACHE_H
11 #define OPENAFS_WINNT_AFSD_CM_SCACHE_H 1
12
13 #define MOUNTPOINTLEN   1024    /* max path length for symlink; same as AFSPATHMAX */
14
15 typedef struct cm_fid {
16     afs_uint32 cell;
17     afs_uint32 volume;
18     afs_uint32 vnode;
19     afs_uint32 unique;
20     afs_uint32 hash;
21 } cm_fid_t;
22
23
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;
29     afs_uint16 file_id;
30 } cm_key_t;
31
32 typedef struct cm_range {
33     afs_int64 offset;
34     afs_int64 length;
35 } cm_range_t;
36
37 /* forward dcls */
38 struct cm_scache;
39 typedef struct cm_scache cm_scache_t;
40
41 typedef struct cm_file_lock {
42     osi_queue_t q;              /* list of all locks [protected by
43                                    cm_scacheLock] */
44     osi_queue_t fileq;          /* per-file list of locks [protected
45                                    by scp->rw]*/
46
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] */
51 #ifdef DEBUG
52     cm_fid_t   fid;
53 #endif
54
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
62                                  * cm_scacheLock] */
63 } cm_file_lock_t;
64
65 #define fileq_to_cm_file_lock_t(q) ((cm_file_lock_t *)((char *) (q) - offsetof(cm_file_lock_t, fileq)))
66
67 #define CM_FILELOCK_FLAG_DELETED         0x01
68 #define CM_FILELOCK_FLAG_LOST            0x02
69
70 /* the following are mutually exclusive */
71 #define CM_FILELOCK_FLAG_WAITLOCK        0x04
72 #define CM_FILELOCK_FLAG_WAITUNLOCK      0x0C
73
74 /* the following is used to indicate that there are no server side
75    locks associated with this lock.  This is true for locks obtained
76    against files in RO volumes as well as files residing on servers
77    that disable client side byte range locking. */
78 #define CM_FILELOCK_FLAG_CLIENTONLY      0x10
79
80 #define CM_FLSHARE_OFFSET_HIGH           0x01000000
81 #define CM_FLSHARE_OFFSET_LOW            0x00000000
82 #define CM_FLSHARE_LENGTH_HIGH           0x00000000
83 #define CM_FLSHARE_LENGTH_LOW            0x00000001
84
85 typedef struct cm_prefetch {            /* last region scanned for prefetching */
86         osi_hyper_t base;               /* start of region */
87         osi_hyper_t end;                /* first char past region */
88 } cm_prefetch_t;
89
90 #define CM_SCACHE_MAGIC ('S' | 'C'<<8 | 'A'<<16 | 'C'<<24)
91
92 typedef struct cm_scache {
93     osi_queue_t q;                      /* lru queue; cm_scacheLock */
94     afs_uint32      magic;
95     struct cm_scache *nextp;            /* next in hash; cm_scacheLock */
96     struct cm_scache *allNextp;         /* next in all scache list; cm_scacheLock */
97     cm_fid_t fid;
98     afs_uint32 flags;                   /* flags; locked by rw */
99
100     /* synchronization stuff */
101     osi_rwlock_t rw;                    /* rwlock for this structure */
102     osi_rwlock_t bufCreateLock;         /* read-locked during buffer creation;
103                                          * write-locked to prevent buffers from
104                                          * being created during a truncate op, etc.
105                                          */
106     afs_int32 refCount;                 /* reference count; cm_scacheLock */
107     osi_queueData_t *bufReadsp;         /* queue of buffers being read */
108     osi_queueData_t *bufWritesp;        /* queue of buffers being written */
109
110     /* parent info for ACLs */
111     afs_uint32 parentVnode;             /* parent vnode for ACL callbacks */
112     afs_uint32 parentUnique;            /* for ACL callbacks */
113
114     /* local modification stat */
115     afs_uint32 mask;                    /* for clientModTime, length and
116                                          * truncPos */
117
118     /* file status */
119     afs_uint32 fileType;                /* file type */
120     time_t clientModTime;               /* mtime */
121     time_t serverModTime;               /* at server, for concurrent call
122                                          * comparisons */
123     osi_hyper_t length;                 /* file length */
124     cm_prefetch_t prefetch;             /* prefetch info structure */
125     afs_uint32 unixModeBits;            /* unix protection mode bits */
126     afs_uint32 linkCount;               /* link count */
127     afs_uint64 dataVersion;             /* data version */
128     afs_uint64 bufDataVersionLow;       /* range of valid cm_buf_t dataVersions */
129     afs_uint32 owner;                   /* file owner */
130     afs_uint32 group;                   /* file owning group */
131     cm_user_t *creator;                 /* user, if new file */
132
133     /* volume status */
134     time_t volumeCreationDate;          /* volume creation date from AFSVolSync */
135
136     /* pseudo file status */
137     osi_hyper_t serverLength;           /* length known to server */
138
139     /* aux file status */
140     osi_hyper_t truncPos;               /* file size to truncate to before
141                                          * storing data */
142
143     /* symlink and mount point info */
144     char mountPointStringp[MOUNTPOINTLEN];      /* the string stored in a mount point;
145                                                  * first char is type, then vol name.
146                                          * If this is a normal symlink, we store
147                                          * the link contents here.
148                                          */
149     cm_fid_t  mountRootFid;             /* mounted on root */
150     time_t    mountRootGen;             /* time to update mountRootFid? */
151     cm_fid_t  dotdotFid;                /* parent of volume root */
152
153     /* callback info */
154     struct cm_server *cbServerp;        /* server granting callback */
155     time_t cbExpires;                   /* time callback expires */
156
157     /* access cache */
158     long anyAccess;                     /* anonymous user's access */
159     struct cm_aclent *randomACLp;       /* access cache entries */
160
161     /* file locks */
162     afs_int32    serverLock;    /* current lock we have acquired on
163                                  * this file.  One of (-1), LockRead
164                                  * or LockWrite. [protected by
165                                  * scp->rw].  In the future, this
166                                  * should be replaced by a queue of
167                                  * cm_server_lock_t objects which keep
168                                  * track of lock type, the user for
169                                  * whom the lock was obtained, the
170                                  * dataVersion at the time the lock
171                                  * was asserted last, lastRefreshCycle
172                                  * and lateUpdateTime.
173                                  */
174     unsigned long lastRefreshCycle; /* protected with cm_scacheLock
175                                      * for all scaches. */
176     afs_uint64  lockDataVersion; /* dataVersion of the scp at the time
177                                    the server lock for the scp was
178                                    asserted for this lock the last
179                                    time. */
180     osi_queue_t *fileLocksH;    /* queue of locks (head) */
181     osi_queue_t *fileLocksT;    /* queue of locks (tail) */
182
183     afs_uint32   sharedLocks;   /* number of shared locks on
184                                  * ::fileLocks.  This count does not
185                                  * include locks which have
186                                  * CM_FILELOCK_FLAG_CLIENTONLY set. */
187
188     afs_uint32   exclusiveLocks; /* number of exclusive locks on
189                                   * ::fileLocks.  This count does not
190                                   * include locks which have
191                                   * CM_FILELOCK_FLAG_CLIENTONLY set.
192                                   */
193
194     afs_uint32   clientLocks;   /* number of locks on ::fileLocks that
195                                    have CM_FILELOCK_FLAG_CLIENTONLY
196                                    set. */
197
198     afs_int32    fsLockCount;   /* number of locks held as reported
199                                  * by the file server in the most
200                                  * recent fetch status.  Updated by
201                                  * the locks known to have been acquired
202                                  * or released by this client.
203                                  */
204
205     /* bulk stat progress */
206     osi_hyper_t bulkStatProgress;       /* track bulk stats of large dirs */
207
208 #ifdef USE_BPLUS
209     /* directory B+ tree */             /* only allocated if is directory */
210     osi_rwlock_t dirlock;               /* controls access to dirBplus */
211     afs_uint64   dirDataVersion;        /* data version represented by dirBplus */
212     struct tree *dirBplus;              /* dirBplus */
213 #endif
214
215     /* open state */
216     afs_uint16 openReads;               /* open for reading */
217     afs_uint16 openWrites;              /* open for writing */
218     afs_uint16 openShares;              /* open for read excl */
219     afs_uint16 openExcls;               /* open for exclusives */
220
221     /* syncop state */
222     afs_uint32 waitCount;           /* number of threads waiting */
223     afs_uint32 waitRequests;        /* num of thread wait requests */
224     osi_queue_t * waitQueueH;       /* Queue of waiting threads.
225                                        Holds queue of
226                                        cm_scache_waiter_t
227                                        objects. Protected by
228                                        cm_scacheLock. */
229     osi_queue_t * waitQueueT;       /* locked by cm_scacheLock */
230
231     /* redirector state - protected by scp->rw */
232     osi_queue_t * redirQueueH;      /* LRU queue of buffers for this
233                                        file that are assigned to the
234                                        afsredir kernel module. */
235     osi_queue_t * redirQueueT;
236     afs_uint32    redirBufCount;    /* Number of buffers held by the redirector */
237     time_t        redirLastAccess;  /* last time redir accessed the vnode */
238 } cm_scache_t;
239
240 /* dataVersion */
241 #define CM_SCACHE_VERSION_BAD           0xFFFFFFFFFFFFFFFF
242
243 /* mask field - tell what has been modified */
244 #define CM_SCACHEMASK_CLIENTMODTIME     1       /* client mod time */
245 #define CM_SCACHEMASK_LENGTH            2       /* length */
246 #define CM_SCACHEMASK_TRUNCPOS          4       /* truncation position */
247
248 /* fileType values */
249 #define CM_SCACHETYPE_UNKNOWN           0       /* unknown */
250 #define CM_SCACHETYPE_FILE              1       /* a file */
251 #define CM_SCACHETYPE_DIRECTORY         2       /* a dir */
252 #define CM_SCACHETYPE_SYMLINK           3       /* a symbolic link */
253 #define CM_SCACHETYPE_MOUNTPOINT        4       /* a mount point */
254 #define CM_SCACHETYPE_DFSLINK           5       /* a Microsoft Dfs link */
255 #define CM_SCACHETYPE_INVALID           99      /* an invalid link */
256
257 /* flag bits */
258 #define CM_SCACHEFLAG_STATD             0x01    /* status info is valid */
259 #define CM_SCACHEFLAG_DELETED           0x02    /* file has been deleted */
260 #define CM_SCACHEFLAG_CALLBACK          0x04    /* have a valid callback */
261 #define CM_SCACHEFLAG_STORING           0x08    /* status being stored back */
262 #define CM_SCACHEFLAG_FETCHING          0x10    /* status being fetched */
263 #define CM_SCACHEFLAG_SIZESTORING       0x20    /* status being stored that
264                                                  * changes the data; typically,
265                                                  * this is a truncate op. */
266 #define CM_SCACHEFLAG_INHASH            0x40    /* in the hash table */
267 #define CM_SCACHEFLAG_BULKSTATTING      0x80    /* doing a bulk stat */
268 #define CM_SCACHEFLAG_SIZESETTING       0x100   /* Stabilized; Truncate */
269 #define CM_SCACHEFLAG_WAITING           0x200   /* waiting for fetch/store
270                                                  * state to change */
271 #define CM_SCACHEFLAG_PURERO            0x400   /* read-only (not even backup);
272                                                  * for mount point eval */
273 #define CM_SCACHEFLAG_RO                0x800   /* read-only
274                                                  * (can't do write ops) */
275 #define CM_SCACHEFLAG_GETCALLBACK       0x1000  /* we're getting a callback */
276 #define CM_SCACHEFLAG_DATASTORING       0x2000  /* data being stored */
277 #define CM_SCACHEFLAG_PREFETCHING       0x4000  /* somebody is prefetching */
278 #define CM_SCACHEFLAG_OVERQUOTA         0x8000  /* over quota */
279 #define CM_SCACHEFLAG_OUTOFSPACE        0x10000 /* out of space */
280 #define CM_SCACHEFLAG_ASYNCSTORING      0x20000 /* scheduled to store back */
281 #define CM_SCACHEFLAG_LOCKING           0x40000 /* setting/clearing file lock */
282 #define CM_SCACHEFLAG_WATCHED           0x80000 /* directory being watched */
283 #define CM_SCACHEFLAG_WATCHEDSUBTREE    0x100000 /* dir subtree being watched */
284 #define CM_SCACHEFLAG_ANYWATCH \
285                         (CM_SCACHEFLAG_WATCHED | CM_SCACHEFLAG_WATCHEDSUBTREE)
286
287 #define CM_SCACHEFLAG_EACCESS           0x200000 /* Bulk Stat returned EACCES */
288 #define CM_SCACHEFLAG_SMB_FID           0x400000
289 #define CM_SCACHEFLAG_LOCAL             0x800000 /* Locally modified */
290 #define CM_SCACHEFLAG_BULKREADING       0x1000000/* Bulk read in progress */
291 #define CM_SCACHEFLAG_RDR_IN_USE        0x2000000/* in use by Redirector; advisory */
292
293 /* sync flags for calls to the server.  The CM_SCACHEFLAG_FETCHING,
294  * CM_SCACHEFLAG_STORING and CM_SCACHEFLAG_SIZESTORING flags correspond to the
295  * below, except for FETCHDATA and STOREDATA, which correspond to non-null
296  * buffers in bufReadsp and bufWritesp.
297  * These flags correspond to individual RPCs that we may be making, and at most
298  * one can be set in any one call to SyncOp.
299  */
300 #define CM_SCACHESYNC_FETCHSTATUS           0x01        /* fetching status info */
301 #define CM_SCACHESYNC_STORESTATUS           0x02        /* storing status info */
302 #define CM_SCACHESYNC_FETCHDATA             0x04        /* fetch data */
303 #define CM_SCACHESYNC_STOREDATA             0x08        /* store data */
304 #define CM_SCACHESYNC_STORESIZE         0x10    /* store new file size */
305 #define CM_SCACHESYNC_GETCALLBACK       0x20    /* fetching a callback */
306 #define CM_SCACHESYNC_STOREDATA_EXCL    0x40    /* store data */
307 #define CM_SCACHESYNC_ASYNCSTORE        0x80    /* schedule data store */
308 #define CM_SCACHESYNC_LOCK              0x100   /* set/clear file lock */
309
310 /* sync flags for calls within the client; there are no corresponding flags
311  * in the scache entry, because we hold the scache entry locked during the
312  * operations below.
313  */
314 #define CM_SCACHESYNC_GETSTATUS         0x1000  /* read the status */
315 #define CM_SCACHESYNC_SETSTATUS         0x2000  /* e.g. utimes */
316 #define CM_SCACHESYNC_READ              0x4000  /* read data from a chunk */
317 #define CM_SCACHESYNC_WRITE             0x8000  /* write data to a chunk */
318 #define CM_SCACHESYNC_SETSIZE           0x10000 /* shrink the size of a file,
319                                                  * e.g. truncate */
320 #define CM_SCACHESYNC_NEEDCALLBACK      0x20000 /* need a callback on the file */
321 #define CM_SCACHESYNC_CHECKRIGHTS       0x40000 /* check that user has desired
322                                                  * access rights */
323 #define CM_SCACHESYNC_BUFLOCKED         0x80000 /* the buffer is locked */
324 #define CM_SCACHESYNC_NOWAIT            0x100000/* don't wait for the state,
325                                                  * just fail */
326 #define CM_SCACHESYNC_FORCECB           0x200000/* when calling cm_GetCallback()
327                                                  * set the force flag */
328
329 #define CM_SCACHESYNC_BULKREAD          0x400000/* reading many buffers */
330
331 /* flags for cm_RecycleSCache   */
332 #define CM_SCACHE_RECYCLEFLAG_DESTROY_BUFFERS   0x1
333
334 /* flags for cm_MergeStatus */
335 #define CM_MERGEFLAG_FORCE              1       /* check mtime before merging;
336                                                  * used to see if we're merging
337                                                  * in old info.
338                                                  */
339 #define CM_MERGEFLAG_STOREDATA          2       /* Merge due to storedata op */
340 #define CM_MERGEFLAG_DIROP              4       /* Merge due to directory op */
341 #define CM_MERGEFLAG_FETCHDATA          8       /* Merge due to fetchdata op */
342
343 /* hash define.  Must not include the cell, since the callback revocation code
344  * doesn't necessarily know the cell in the case of a multihomed server
345  * contacting us from a mystery address.
346  */
347 #define CM_SCACHE_HASH(fidp)    (((unsigned long)       \
348                                    ((fidp)->volume +    \
349                                     (fidp)->vnode +     \
350                                     (fidp)->unique))    \
351                                         % cm_data.scacheHashTableSize)
352
353 #include "cm_conn.h"
354 #include "cm_buf.h"
355
356 typedef struct cm_scache_waiter {
357     osi_queue_t q;
358     afs_int32   threadId;
359
360     cm_scache_t *scp;
361     afs_int32   flags;
362     cm_buf_t    *bufp;
363 } cm_scache_waiter_t;
364
365 extern void cm_InitSCache(int, long);
366
367 #ifdef DEBUG_REFCOUNT
368 extern long cm_GetSCacheDbg(cm_fid_t *, cm_scache_t **, struct cm_user *,
369         struct cm_req *, char *, long);
370
371 #define cm_GetSCache(a,b,c,d)  cm_GetSCacheDbg(a,b,c,d,__FILE__,__LINE__)
372 #else
373 extern long cm_GetSCache(cm_fid_t *, cm_scache_t **, struct cm_user *,
374         struct cm_req *);
375 #endif
376
377 extern cm_scache_t *cm_GetNewSCache(void);
378
379 extern __inline int cm_FidCmp(cm_fid_t *, cm_fid_t *);
380
381 extern void cm_SetFid(cm_fid_t *, afs_uint32 cell, afs_uint32 volume, afs_uint32 vnode, afs_uint32 unique);
382
383 extern long cm_SyncOp(cm_scache_t *, struct cm_buf *, struct cm_user *,
384         struct cm_req *, afs_uint32, afs_uint32);
385
386 extern void cm_SyncOpDone(cm_scache_t *, struct cm_buf *, afs_uint32);
387
388 extern void cm_MergeStatus(cm_scache_t * dscp, cm_scache_t * scp,
389                            struct AFSFetchStatus * statusp,
390                            struct AFSVolSync * volsyncp,
391                            struct cm_user *userp,
392                            cm_req_t *reqp,
393                            afs_uint32 flags);
394
395 extern void cm_AFSFidFromFid(struct AFSFid *, cm_fid_t *);
396
397 #ifdef DEBUG_REFCOUNT
398 extern void cm_HoldSCacheNoLockDbg(cm_scache_t *, char *, long);
399
400 extern void cm_HoldSCacheDbg(cm_scache_t *, char *, long);
401
402 extern void cm_ReleaseSCacheNoLockDbg(cm_scache_t *, char *, long);
403
404 extern void cm_ReleaseSCacheDbg(cm_scache_t *, char *, long);
405
406 #define cm_HoldSCacheNoLock(scp)    cm_HoldSCacheNoLockDbg(scp, __FILE__, __LINE__)
407 #define cm_HoldSCache(scp)          cm_HoldSCacheDbg(scp, __FILE__, __LINE__)
408 #define cm_ReleaseSCacheNoLock(scp) cm_ReleaseSCacheNoLockDbg(scp, __FILE__, __LINE__)
409 #define cm_ReleaseSCache(scp)       cm_ReleaseSCacheDbg(scp, __FILE__, __LINE__)
410 #else
411 extern void cm_HoldSCacheNoLock(cm_scache_t *);
412
413 extern void cm_HoldSCache(cm_scache_t *);
414
415 extern void cm_ReleaseSCacheNoLock(cm_scache_t *);
416
417 extern void cm_ReleaseSCache(cm_scache_t *);
418 #endif
419 extern cm_scache_t *cm_FindSCache(cm_fid_t *fidp);
420
421 extern cm_scache_t *cm_FindSCacheParent(cm_scache_t *);
422
423 extern osi_rwlock_t cm_scacheLock;
424
425 extern osi_queue_t *cm_allFileLocks;
426
427 extern osi_queue_t *cm_freeFileLocks;
428
429 extern unsigned long cm_lockRefreshCycle;
430
431 extern void cm_DiscardSCache(cm_scache_t *scp);
432
433 extern int cm_FindFileType(cm_fid_t *fidp);
434
435 extern long cm_ValidateSCache(void);
436
437 extern long cm_ShutdownSCache(void);
438
439 extern void cm_SuspendSCache(void);
440
441 extern long cm_RecycleSCache(cm_scache_t *scp, afs_int32 flags);
442
443 extern void cm_RemoveSCacheFromHashTable(cm_scache_t *scp);
444
445 extern void cm_AdjustScacheLRU(cm_scache_t *scp);
446
447 extern int cm_DumpSCache(FILE *outputFile, char *cookie, int lock);
448
449 extern void cm_ResetSCacheDirectory(cm_scache_t *scp, afs_int32 locked);
450
451 extern cm_scache_t * cm_RootSCachep(cm_user_t *userp, cm_req_t *reqp);
452 #endif /*  OPENAFS_WINNT_AFSD_CM_SCACHE_H */