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 __CM_SCACHE_H_ENV__
  11 #define __CM_SCACHE_H_ENV__ 1
  12
  13 #define MOUNTPOINTLEN   1024    /* max path length for symlink; same as AFSPATHMAX */
  14
  15 typedef struct cm_fid {
  16         unsigned long cell;
  17         unsigned long volume;
  18         unsigned long vnode;
  19         unsigned long unique;
  20 } cm_fid_t;
  21
  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;
  25
  26 typedef struct cm_range {
  27     afs_int64 offset;
  28     afs_int64 length;
  29 } cm_range_t;
  30
  31 /* forward dcls */
  32 struct cm_scache;
  33 typedef struct cm_scache cm_scache_t;
  34
  35 typedef struct cm_file_lock {
  36     osi_queue_t q;              /* list of all locks [protected by
  37                                    cm_scacheLock] */
  38     osi_queue_t fileq;          /* per-file list of locks [protected
  39                                    by scp->mx]*/
  40
  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] */
  45 #ifdef DEBUG
  46     cm_fid_t   fid;
  47 #endif
  48
  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
  56                                  * cm_scacheLock] */
  57 } cm_file_lock_t;
  58
  59 #define CM_FILELOCK_FLAG_DELETED         0x01
  60 #define CM_FILELOCK_FLAG_LOST            0x02
  61
  62 /* the following are mutually exclusive */
  63 #define CM_FILELOCK_FLAG_WAITLOCK        0x04
  64 #define CM_FILELOCK_FLAG_WAITUNLOCK      0x0C
  65
  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
  71
  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
  76
  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 */
  80 } cm_prefetch_t;
  81
  82 #define CM_SCACHE_MAGIC ('S' | 'C'<<8 | 'A'<<16 | 'C'<<24)
  83
  84 typedef struct cm_scache {
  85     osi_queue_t q;                      /* lru queue; cm_scacheLock */
  86     afs_uint32      magic;
  87     struct cm_scache *nextp;            /* next in hash; cm_scacheLock */
  88     struct cm_scache *allNextp;         /* next in all scache list; cm_scacheLock */
  89     cm_fid_t fid;
  90     afs_uint32 flags;                   /* flags; locked by mx */
  91
  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.
  97                                          */
  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 */
 101
 102     /* parent info for ACLs */
 103     afs_uint32 parentVnode;             /* parent vnode for ACL callbacks */
 104     afs_uint32 parentUnique;            /* for ACL callbacks */
 105
 106     /* local modification stat */
 107     afs_uint32 mask;                    /* for clientModTime, length and
 108                                          * truncPos */
 109
 110     /* file status */
 111     afs_uint32 fileType;                /* file type */
 112     time_t clientModTime;               /* mtime */
 113     time_t serverModTime;               /* at server, for concurrent call
 114                                          * comparisons */
 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 */
 123
 124     /* pseudo file status */
 125     osi_hyper_t serverLength;           /* length known to server */
 126
 127     /* aux file status */
 128     osi_hyper_t truncPos;               /* file size to truncate to before
 129                                          * storing data */
 130
 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.
 136                                          */
 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 */
 140
 141     /* callback info */
 142     struct cm_server *cbServerp;        /* server granting callback */
 143     time_t cbExpires;                   /* time callback expires */
 144
 145     /* access cache */
 146     long anyAccess;                     /* anonymous user's access */
 147     struct cm_aclent *randomACLp;       /* access cache entries */
 148
 149     /* file locks */
 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.
 161                                  */
 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
 167                                    time. */
 168     osi_queue_t *fileLocksH;    /* queue of locks (head) */
 169     osi_queue_t *fileLocksT;    /* queue of locks (tail) */
 170
 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. */
 175
 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.
 180                                   */
 181
 182     afs_uint32   clientLocks;   /* number of locks on ::fileLocks that
 183                                    have CM_FILELOCK_FLAG_CLIENTONLY
 184                                    set. */
 185
 186     /* volume info */
 187     struct cm_volume *volp;             /* volume info; held reference */
 188
 189     /* bulk stat progress */
 190     osi_hyper_t bulkStatProgress;       /* track bulk stats of large dirs */
 191
 192 #ifdef USE_BPLUS
 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 */
 197 #endif
 198
 199     /* open state */
 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 */
 204
 205     /* syncop state */
 206     afs_uint32 waitCount;           /* number of threads waiting */
 207     afs_uint32 waitRequests;        /* num of thread wait requests */
 208 } cm_scache_t;
 209
 210 /* mask field - tell what has been modified */
 211 #define CM_SCACHEMASK_CLIENTMODTIME     1       /* client mod time */
 212 #define CM_SCACHEMASK_LENGTH            2       /* length */
 213 #define CM_SCACHEMASK_TRUNCPOS          4       /* truncation position */
 214
 215 /* fileType values */
 216 #define CM_SCACHETYPE_FILE              1       /* a file */
 217 #define CM_SCACHETYPE_DIRECTORY         2       /* a dir */
 218 #define CM_SCACHETYPE_SYMLINK           3       /* a symbolic link */
 219 #define CM_SCACHETYPE_MOUNTPOINT        4       /* a mount point */
 220 #define CM_SCACHETYPE_DFSLINK           5       /* a Microsoft Dfs link */
 221 #define CM_SCACHETYPE_INVALID           99      /* an invalid link */
 222
 223 /* flag bits */
 224 #define CM_SCACHEFLAG_STATD             0x01    /* status info is valid */
 225 #define CM_SCACHEFLAG_DELETED           0x02    /* file has been deleted */
 226 #define CM_SCACHEFLAG_CALLBACK          0x04    /* have a valid callback */
 227 #define CM_SCACHEFLAG_STORING           0x08    /* status being stored back */
 228 #define CM_SCACHEFLAG_FETCHING          0x10    /* status being fetched */
 229 #define CM_SCACHEFLAG_SIZESTORING       0x20    /* status being stored that
 230                                                  * changes the data; typically,
 231                                                  * this is a truncate op. */
 232 #define CM_SCACHEFLAG_INHASH            0x40    /* in the hash table */
 233 #define CM_SCACHEFLAG_BULKSTATTING      0x80    /* doing a bulk stat */
 234 #define CM_SCACHEFLAG_WAITING           0x200   /* waiting for fetch/store
 235                                                  * state to change */
 236 #define CM_SCACHEFLAG_PURERO            0x400   /* read-only (not even backup);
 237                                                  * for mount point eval */
 238 #define CM_SCACHEFLAG_RO                0x800   /* read-only
 239                                                  * (can't do write ops) */
 240 #define CM_SCACHEFLAG_GETCALLBACK       0x1000  /* we're getting a callback */
 241 #define CM_SCACHEFLAG_DATASTORING       0x2000  /* data being stored */
 242 #define CM_SCACHEFLAG_PREFETCHING       0x4000  /* somebody is prefetching */
 243 #define CM_SCACHEFLAG_OVERQUOTA         0x8000  /* over quota */
 244 #define CM_SCACHEFLAG_OUTOFSPACE        0x10000 /* out of space */
 245 #define CM_SCACHEFLAG_ASYNCSTORING      0x20000 /* scheduled to store back */
 246 #define CM_SCACHEFLAG_LOCKING           0x40000 /* setting/clearing file lock */
 247 #define CM_SCACHEFLAG_WATCHED           0x80000 /* directory being watched */
 248 #define CM_SCACHEFLAG_WATCHEDSUBTREE    0x100000 /* dir subtree being watched */
 249 #define CM_SCACHEFLAG_ANYWATCH \
 250                         (CM_SCACHEFLAG_WATCHED | CM_SCACHEFLAG_WATCHEDSUBTREE)
 251
 252 #define CM_SCACHEFLAG_EACCESS           0x200000 /* Bulk Stat returned EACCES */
 253 #define CM_SCACHEFLAG_SMB_FID           0x400000
 254
 255 /* sync flags for calls to the server.  The CM_SCACHEFLAG_FETCHING,
 256  * CM_SCACHEFLAG_STORING and CM_SCACHEFLAG_SIZESTORING flags correspond to the
 257  * below, except for FETCHDATA and STOREDATA, which correspond to non-null
 258  * buffers in bufReadsp and bufWritesp.
 259  * These flags correspond to individual RPCs that we may be making, and at most
 260  * one can be set in any one call to SyncOp.
 261  */
 262 #define CM_SCACHESYNC_FETCHSTATUS           0x01        /* fetching status info */
 263 #define CM_SCACHESYNC_STORESTATUS           0x02        /* storing status info */
 264 #define CM_SCACHESYNC_FETCHDATA             0x04        /* fetch data */
 265 #define CM_SCACHESYNC_STOREDATA             0x08        /* store data */
 266 #define CM_SCACHESYNC_STORESIZE         0x10    /* store new file size */
 267 #define CM_SCACHESYNC_GETCALLBACK       0x20    /* fetching a callback */
 268 #define CM_SCACHESYNC_STOREDATA_EXCL    0x40    /* store data */
 269 #define CM_SCACHESYNC_ASYNCSTORE        0x80    /* schedule data store */
 270 #define CM_SCACHESYNC_LOCK              0x100   /* set/clear file lock */
 271
 272 /* sync flags for calls within the client; there are no corresponding flags
 273  * in the scache entry, because we hold the scache entry locked during the
 274  * operations below.
 275  */
 276 #define CM_SCACHESYNC_GETSTATUS         0x1000  /* read the status */
 277 #define CM_SCACHESYNC_SETSTATUS         0x2000  /* e.g. utimes */
 278 #define CM_SCACHESYNC_READ              0x4000  /* read data from a chunk */
 279 #define CM_SCACHESYNC_WRITE             0x8000  /* write data to a chunk */
 280 #define CM_SCACHESYNC_SETSIZE           0x10000 /* shrink the size of a file,
 281                                                  * e.g. truncate */
 282 #define CM_SCACHESYNC_NEEDCALLBACK      0x20000 /* need a callback on the file */
 283 #define CM_SCACHESYNC_CHECKRIGHTS       0x40000 /* check that user has desired
 284                                                  * access rights */
 285 #define CM_SCACHESYNC_BUFLOCKED         0x80000 /* the buffer is locked */
 286 #define CM_SCACHESYNC_NOWAIT            0x100000/* don't wait for the state,
 287                                                  * just fail */
 288 #define CM_SCACHESYNC_FORCECB           0x200000/* when calling cm_GetCallback()
 289                                                  * set the force flag */
 290
 291 /* flags for cm_RecycleSCache   */
 292 #define CM_SCACHE_RECYCLEFLAG_DESTROY_BUFFERS   0x1
 293
 294 /* flags for cm_MergeStatus */
 295 #define CM_MERGEFLAG_FORCE              1       /* check mtime before merging;
 296                                                  * used to see if we're merging
 297                                                  * in old info.
 298                                                  */
 299 #define CM_MERGEFLAG_STOREDATA          2       /* Merge due to storedata op */
 300
 301 /* hash define.  Must not include the cell, since the callback revocation code
 302  * doesn't necessarily know the cell in the case of a multihomed server
 303  * contacting us from a mystery address.
 304  */
 305 #define CM_SCACHE_HASH(fidp)    (((unsigned long)       \
 306                                    ((fidp)->volume +    \
 307                                     (fidp)->vnode +     \
 308                                     (fidp)->unique))    \
 309                                         % cm_data.scacheHashTableSize)
 310
 311 #include "cm_conn.h"
 312 #include "cm_buf.h"
 313
 314 extern void cm_InitSCache(int, long);
 315
 316 #ifdef DEBUG_REFCOUNT
 317 extern long cm_GetSCacheDbg(cm_fid_t *, cm_scache_t **, struct cm_user *,
 318         struct cm_req *, char *, long);
 319
 320 #define cm_GetSCache(a,b,c,d)  cm_GetSCacheDbg(a,b,c,d,__FILE__,__LINE__)
 321 #else
 322 extern long cm_GetSCache(cm_fid_t *, cm_scache_t **, struct cm_user *,
 323         struct cm_req *);
 324 #endif
 325
 326 extern cm_scache_t *cm_GetNewSCache(void);
 327
 328 extern int cm_FidCmp(cm_fid_t *, cm_fid_t *);
 329
 330 extern long cm_SyncOp(cm_scache_t *, struct cm_buf *, struct cm_user *,
 331         struct cm_req *, afs_uint32, afs_uint32);
 332
 333 extern void cm_SyncOpDone(cm_scache_t *, struct cm_buf *, afs_uint32);
 334
 335 extern void cm_MergeStatus(cm_scache_t * dscp, cm_scache_t * scp,
 336                            struct AFSFetchStatus * statusp,
 337                            struct AFSVolSync * volsyncp,
 338                            struct cm_user *userp,
 339                            afs_uint32 flags);
 340
 341 extern void cm_AFSFidFromFid(struct AFSFid *, cm_fid_t *);
 342
 343 #ifdef DEBUG_REFCOUNT
 344 extern void cm_HoldSCacheNoLockDbg(cm_scache_t *, char *, long);
 345
 346 extern void cm_HoldSCacheDbg(cm_scache_t *, char *, long);
 347
 348 extern void cm_ReleaseSCacheNoLockDbg(cm_scache_t *, char *, long);
 349
 350 extern void cm_ReleaseSCacheDbg(cm_scache_t *, char *, long);
 351
 352 #define cm_HoldSCacheNoLock(scp)    cm_HoldSCacheNoLockDbg(scp, __FILE__, __LINE__)
 353 #define cm_HoldSCache(scp)          cm_HoldSCacheDbg(scp, __FILE__, __LINE__)
 354 #define cm_ReleaseSCacheNoLock(scp) cm_ReleaseSCacheNoLockDbg(scp, __FILE__, __LINE__)
 355 #define cm_ReleaseSCache(scp)       cm_ReleaseSCacheDbg(scp, __FILE__, __LINE__)
 356 #else
 357 extern void cm_HoldSCacheNoLock(cm_scache_t *);
 358
 359 extern void cm_HoldSCache(cm_scache_t *);
 360
 361 extern void cm_ReleaseSCacheNoLock(cm_scache_t *);
 362
 363 extern void cm_ReleaseSCache(cm_scache_t *);
 364 #endif
 365 extern cm_scache_t *cm_FindSCache(cm_fid_t *fidp);
 366
 367 extern cm_scache_t *cm_FindSCacheParent(cm_scache_t *);
 368
 369 extern osi_rwlock_t cm_scacheLock;
 370
 371 extern osi_queue_t *cm_allFileLocks;
 372
 373 extern osi_queue_t *cm_freeFileLocks;
 374
 375 extern unsigned long cm_lockRefreshCycle;
 376
 377 extern void cm_DiscardSCache(cm_scache_t *scp);
 378
 379 extern int cm_FindFileType(cm_fid_t *fidp);
 380
 381 extern long cm_ValidateSCache(void);
 382
 383 extern long cm_ShutdownSCache(void);
 384
 385 extern void cm_SuspendSCache(void);
 386
 387 extern long cm_RecycleSCache(cm_scache_t *scp, afs_int32 flags);
 388
 389 extern void cm_RemoveSCacheFromHashTable(cm_scache_t *scp);
 390 #endif /*  __CM_SCACHE_H_ENV__ */