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