src/WINNT/afsd/cm_buf.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 /* Copyright (C) 1994 Cazamar Systems, Inc. */
  11
  12 #ifndef OPENAFS_WINNT_AFSD_BUF_H
  13 #define OPENAFS_WINNT_AFSD_BUF_H 1
  14
  15 #include <osi.h>
  16 #include <opr/jhash.h>
  17
  18 #ifdef DISKCACHE95
  19 #include "cm_diskcache.h"
  20 #endif /* DISKCACHE95 */
  21
  22 /* default # of buffers if not changed */
  23 #define CM_BUF_BUFFERS  100
  24
  25 /* default buffer size */
  26 #define CM_BUF_BLOCKSIZE CM_CONFIGDEFAULT_BLOCKSIZE
  27
  28 /* cache type */
  29 #define CM_BUF_CACHETYPE_FILE 1
  30 #define CM_BUF_CACHETYPE_VIRTUAL 2
  31 extern int buf_cacheType;
  32
  33 #define BUF_HASH(fidp, offsetp) \
  34     (opr_jhash((uint32_t *)(offsetp), 2, (fidp)->hash) & (cm_data.buf_hashSize - 1))
  35
  36 #define BUF_FILEHASH(fidp) ((fidp)->hash & (cm_data.buf_hashSize - 1))
  37
  38 #define CM_BUF_MAGIC    ('B' | 'U' <<8 | 'F'<<16 | 'F'<<24)
  39
  40 #define CM_BUF_VERSION_BAD 0xFFFFFFFFFFFFFFFF
  41
  42 /* represents a single buffer */
  43 typedef struct cm_buf {
  44     osi_queue_t    q;           /* queue: buf_freeList and buf_redirList */
  45     afs_uint32     qFlags;      /* queue/hash state flags - buf_globalLock */
  46     afs_uint32     magic;
  47     struct cm_buf *allp;        /* next in all list */
  48     struct cm_buf *hashp;       /* hash bucket pointer */
  49     struct cm_buf *fileHashp;   /* file hash bucket pointer */
  50     struct cm_buf *fileHashBackp;       /* file hash bucket back pointer */
  51                                 /*
  52                                  * The file hash chain is doubly linked, since
  53                                  * these chains can get rather long.  The
  54                                  * regular hash chain is only singly linked,
  55                                  * since the chains should be short if the
  56                                  * hash function is good and if there are
  57                                  * enough buckets for the size of the cache.
  58                                  */
  59     struct cm_buf *dirtyp;      /* next in the dirty list */
  60     osi_mutex_t mx;             /* mutex protecting structure except refcount */
  61     afs_int32 refCount;         /* reference count (buf_globalLock) */
  62     afs_uint32 dirtyCounter;    /* bumped at each dirty->clean transition */
  63     osi_hyper_t offset;         /* offset */
  64     cm_fid_t fid;               /* file ID */
  65     char *datap;                /* data in this buffer */
  66     afs_uint32 flags;           /* flags we're using - mx */
  67     afs_uint32 error;           /* last error code, if CM_BUF_ERROR is set */
  68     cm_user_t *userp;           /* user who wrote to the buffer last */
  69
  70     /* fields added for the CM; locked by scp->mx */
  71     afs_uint64 dataVersion;     /* data version of this page */
  72     afs_uint32 cmFlags;         /* flags for cm */
  73
  74     /* syncop state */
  75     afs_uint32 waitCount;       /* number of threads waiting */
  76     afs_uint32 waitRequests;    /* num of thread wait requests */
  77
  78     afs_uint32 dirty_offset;    /* offset from beginning of buffer containing dirty bytes */
  79     afs_uint32 dirty_length;    /* number of dirty bytes within the buffer */
  80
  81 #ifdef DISKCACHE95
  82     cm_diskcache_t *dcp;        /* diskcache structure */
  83 #endif /* DISKCACHE95 */
  84 #ifdef DEBUG
  85     cm_scache_t *scp;           /* for debugging, the scache object belonging to */
  86                                 /* the fid at the time of fid assignment. */
  87 #else
  88     void * dummy;
  89 #endif
  90
  91     /* redirector state - protected by buf_globalLock */
  92     osi_queue_t redirq;         /* queue: cm_scache_t redirList */
  93     time_t      redirLastAccess;/* last time redir accessed the buffer */
  94     time_t      redirReleaseRequested;
  95
  96     unsigned char md5cksum[16]; /* md5 checksum of the block pointed to by datap */
  97 } cm_buf_t;
  98
  99 #define redirq_to_cm_buf_t(q) ((q) ? (cm_buf_t *)((char *) (q) - offsetof(cm_buf_t, redirq)) : NULL)
 100
 101 /* values for cmFlags */
 102 #define CM_BUF_CMFETCHING       1       /* fetching this buffer */
 103 #define CM_BUF_CMSTORING        2       /* storing this buffer */
 104 #define CM_BUF_CMFULLYFETCHED   4       /* read-while-fetching optimization */
 105 #define CM_BUF_CMWRITING        8       /* writing to this buffer */
 106 /* waiting is done based on scp->flags.  Removing bits from cmFlags
 107    should be followed by waking the scp. */
 108
 109 /* values for qFlags */
 110 #define CM_BUF_QINHASH  1       /* in the hash table */
 111 #define CM_BUF_QINLRU   2       /* in lru queue (aka free list) */
 112 #define CM_BUF_QINDL    4       /* in the dirty list */
 113 #define CM_BUF_QREDIR   8       /* buffer held by the redirector */
 114
 115 /* values for flags */
 116 #define CM_BUF_READING  1       /* now reading buffer from the disk */
 117 #define CM_BUF_WRITING  2       /* now writing buffer to the disk */
 118 #define CM_BUF_DIRTY    8       /* buffer is dirty */
 119 #define CM_BUF_ERROR    0x20    /* something went wrong on delayed write */
 120 #define CM_BUF_WAITING  0x40    /* someone's waiting for a flag to change */
 121 #define CM_BUF_EOF      0x80    /* read 0 bytes; used for detecting EOF */
 122
 123 typedef struct cm_buf_ops {
 124     long (*Writep)(void *vscp, osi_hyper_t *offsetp,
 125                    long length, long flags,
 126                    struct cm_user *userp,
 127                    struct cm_req *reqp);
 128     long (*Readp)(cm_buf_t *bufp, long length,
 129                   long *bytesReadp, struct cm_user *userp);
 130     long (*Stabilizep)(void *vscp, struct cm_user *userp, struct cm_req *reqp);
 131     long (*Unstabilizep)(void *vscp, struct cm_user *userp);
 132 } cm_buf_ops_t;
 133
 134 #define CM_BUF_WRITE_SCP_LOCKED 0x1
 135
 136 /* global locks */
 137 extern osi_rwlock_t buf_globalLock;
 138
 139 extern long buf_Init(int newFile, cm_buf_ops_t *, afs_uint64 nbuffers);
 140
 141 extern void buf_Shutdown(void);
 142
 143 #ifdef DEBUG_REFCOUNT
 144 extern void buf_ReleaseDbg(cm_buf_t *, char *, long);
 145
 146 extern void buf_HoldDbg(cm_buf_t *, char *, long);
 147
 148 extern void buf_ReleaseLockedDbg(cm_buf_t *, afs_uint32, char *, long);
 149
 150 extern void buf_HoldLockedDbg(cm_buf_t *, char *, long);
 151
 152 #define buf_Release(bufp) buf_ReleaseDbg(bufp, __FILE__, __LINE__)
 153 #define buf_Hold(bufp)    buf_HoldDbg(bufp, __FILE__, __LINE__)
 154 #define buf_ReleaseLocked(bufp, lock) buf_ReleaseLockedDbg(bufp, lock, __FILE__, __LINE__)
 155 #define buf_HoldLocked(bufp) buf_HoldLockedDbg(bufp, __FILE__, __LINE__)
 156 #else
 157 extern void buf_Release(cm_buf_t *);
 158
 159 extern void buf_Hold(cm_buf_t *);
 160
 161 extern void buf_ReleaseLocked(cm_buf_t *, afs_uint32);
 162
 163 extern void buf_HoldLocked(cm_buf_t *);
 164 #endif
 165
 166 extern void buf_WaitIO(cm_scache_t *, cm_buf_t *);
 167
 168 extern cm_buf_t *buf_FindLocked(struct cm_fid *, osi_hyper_t *);
 169
 170 extern cm_buf_t *buf_Find(struct cm_fid *, osi_hyper_t *);
 171
 172 extern cm_buf_t *buf_FindAllLocked(struct cm_fid *, osi_hyper_t *, afs_uint32 flags);
 173
 174 extern cm_buf_t *buf_FindAll(struct cm_fid *, osi_hyper_t *, afs_uint32 flags);
 175
 176 extern long buf_GetNewLocked(struct cm_scache *, osi_hyper_t *, cm_req_t *, cm_buf_t **);
 177
 178 extern long buf_Get(struct cm_scache *, osi_hyper_t *, cm_req_t *, cm_buf_t **);
 179
 180 extern afs_uint32 buf_CleanLocked(cm_scache_t *, cm_buf_t *, cm_req_t *, afs_uint32 flags, afs_uint32 *);
 181
 182 extern afs_uint32 buf_Clean(cm_scache_t *, cm_buf_t *, cm_req_t *, afs_uint32 flags, afs_uint32 *);
 183
 184 extern void buf_CleanWait(cm_scache_t *, cm_buf_t *, afs_uint32 locked);
 185
 186 extern void buf_SetDirty(cm_buf_t *, cm_req_t *, afs_uint32 offset, afs_uint32 length, cm_user_t *);
 187
 188 extern long buf_CleanAndReset(void);
 189
 190 extern void buf_ReserveBuffers(afs_uint64);
 191
 192 extern int buf_TryReserveBuffers(afs_uint64);
 193
 194 extern void buf_UnreserveBuffers(afs_uint64);
 195
 196 #ifdef TESTING
 197 extern void buf_ValidateBufQueues(void);
 198 #endif /* TESTING */
 199
 200 extern osi_log_t *buf_logp;
 201
 202 extern long buf_Truncate(struct cm_scache *scp, cm_user_t *userp,
 203         cm_req_t *reqp, osi_hyper_t *sizep);
 204
 205 extern long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp,
 206         cm_req_t *reqp);
 207
 208 extern long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp,
 209         cm_req_t *reqp);
 210
 211 extern long buf_SetNBuffers(afs_uint64 nbuffers);
 212
 213 extern long buf_ValidateBuffers(void);
 214
 215 extern void buf_ForceTrace(BOOL flush);
 216
 217 extern long buf_DirtyBuffersExist(cm_fid_t * fidp);
 218
 219 extern long buf_CleanDirtyBuffers(cm_scache_t *scp);
 220
 221 extern long buf_InvalidateBuffers(cm_scache_t * scp);
 222
 223 extern long buf_RDRBuffersExist(cm_fid_t *fidp);
 224
 225 extern long buf_ClearRDRFlag(cm_scache_t *scp, char * reason);
 226
 227 extern long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion);
 228
 229 extern int cm_DumpBufHashTable(FILE *outputFile, char *cookie, int lock);
 230
 231 extern void buf_ComputeCheckSum(cm_buf_t *bp);
 232
 233 extern int  buf_ValidateCheckSum(cm_buf_t *bp);
 234
 235 extern const char *buf_HexCheckSum(cm_buf_t * bp);
 236
 237 extern afs_uint32
 238 buf_RDRShakeSomeExtentsFree(cm_req_t *reqp, afs_uint32 oneFid, afs_uint32 minage);
 239
 240 extern afs_uint32
 241 buf_RDRShakeAnExtentFree(cm_buf_t *bufp, cm_req_t *reqp);
 242
 243 extern afs_uint32
 244 buf_RDRShakeFileExtentsFree(cm_scache_t *scp, cm_req_t *reqp);
 245
 246 extern void
 247 buf_InsertToRedirQueue(cm_scache_t *scp, cm_buf_t *bufp);
 248
 249 extern void
 250 buf_RemoveFromRedirQueue(cm_scache_t *scp, cm_buf_t *bufp);
 251
 252 extern void
 253 buf_MoveToHeadOfRedirQueue(cm_scache_t *scp, cm_buf_t *bufp);
 254
 255 #ifdef _M_IX86
 256 #define buf_IncrementRedirCount()  InterlockedIncrement(&cm_data.buf_redirCount)
 257 #define buf_DecrementRedirCount()  InterlockedDecrement(&cm_data.buf_redirCount)
 258 #define buf_IncrementFreeCount()   InterlockedIncrement(&cm_data.buf_freeCount)
 259 #define buf_DecrementFreeCount()   InterlockedDecrement(&cm_data.buf_freeCount)
 260 #else
 261 #define buf_IncrementRedirCount()  InterlockedIncrement64(&cm_data.buf_redirCount)
 262 #define buf_DecrementRedirCount()  InterlockedDecrement64(&cm_data.buf_redirCount)
 263 #define buf_IncrementFreeCount()   InterlockedIncrement64(&cm_data.buf_freeCount)
 264 #define buf_DecrementFreeCount()   InterlockedDecrement64(&cm_data.buf_freeCount)
 265 #endif
 266
 267 /* error codes */
 268 #define CM_BUF_EXISTS   1       /* buffer exists, and shouldn't */
 269
 270 #endif /* OPENAFS_WINNT_AFSD_BUF_H */