e35bb9eed24ae33bdbe0658f2137029a5464936d
[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 _BUF_H__ENV_
13 #define _BUF_H__ENV_ 1
14
15 #include <osi.h>
16 #ifdef DISKCACHE95
17 #include "cm_diskcache.h"
18 #endif /* DISKCACHE95 */
19
20 /* default # of buffers if not changed */
21 #define CM_BUF_BUFFERS  100
22
23 /* default buffer size */
24 #define CM_BUF_BLOCKSIZE CM_CONFIGDEFAULT_BLOCKSIZE
25
26 /* default hash size */
27 #define CM_BUF_HASHSIZE 1024
28
29 /* cache type */
30 #define CM_BUF_CACHETYPE_FILE 1
31 #define CM_BUF_CACHETYPE_VIRTUAL 2
32 extern int buf_cacheType;
33
34 /* force it to be signed so that mod comes out positive or 0 */
35 #define BUF_HASH(fidp,offsetp) ((((fidp)->hash \
36                                 +(offsetp)->LowPart) / cm_data.buf_blockSize)   \
37                                    % cm_data.buf_hashSize)
38
39 /* another hash fn */
40 #define BUF_FILEHASH(fidp) ((fidp)->hash % cm_data.buf_hashSize)
41
42 /* backup over pointer to the buffer */
43 #define BUF_OVERTOBUF(op) ((cm_buf_t *)(((char *)op) - ((long)(&((cm_buf_t *)0)->over))))
44
45 #define CM_BUF_MAGIC    ('B' | 'U' <<8 | 'F'<<16 | 'F'<<24)
46
47 /* represents a single buffer */
48 typedef struct cm_buf {
49     osi_queue_t q;              /* queue of all zero-refcount buffers */
50     afs_uint32     magic;
51     struct cm_buf *allp;        /* next in all list */
52     struct cm_buf *hashp;       /* hash bucket pointer */
53     struct cm_buf *fileHashp;   /* file hash bucket pointer */
54     struct cm_buf *fileHashBackp;       /* file hash bucket back pointer */
55                                 /*
56                                  * The file hash chain is doubly linked, since
57                                  * these chains can get rather long.  The
58                                  * regular hash chain is only singly linked,
59                                  * since the chains should be short if the
60                                  * hash function is good and if there are
61                                  * enough buckets for the size of the cache.
62                                  */
63     struct cm_buf *dirtyp;      /* next in the dirty list */
64     osi_mutex_t mx;             /* mutex protecting structure except refcount */
65     afs_int32 refCount;         /* reference count (buf_globalLock) */
66     long idCounter;             /* counter for softrefs; bumped at each recycle */
67     long dirtyCounter;          /* bumped at each dirty->clean transition */
68     osi_hyper_t offset;         /* offset */
69     cm_fid_t fid;               /* file ID */
70     afs_uint32 flags;           /* flags we're using */
71     char *datap;                /* data in this buffer */
72     unsigned long error;        /* last error code, if CM_BUF_ERROR is set */
73     cm_user_t *userp;           /* user who wrote to the buffer last */
74         
75     /* fields added for the CM; locked by scp->mx */
76     afs_uint64 dataVersion;     /* data version of this page */
77     afs_uint32 cmFlags;         /* flags for cm */
78
79     /* syncop state */
80     afs_uint32 waitCount;       /* number of threads waiting */
81     afs_uint32 waitRequests;    /* num of thread wait requests */
82
83     afs_uint32 dirty_offset;    /* offset from beginning of buffer containing dirty bytes */
84     afs_uint32 dirty_length;      /* number of dirty bytes within the buffer */
85
86 #ifdef DISKCACHE95
87     cm_diskcache_t *dcp;        /* diskcache structure */
88 #endif /* DISKCACHE95 */
89 #ifdef DEBUG
90     cm_scache_t *scp;           /* for debugging, the scache object belonging to */
91                                 /* the fid at the time of fid assignment. */
92 #else
93     void * dummy;
94 #endif
95 } cm_buf_t;
96
97 /* values for cmFlags */
98 #define CM_BUF_CMFETCHING       1       /* fetching this buffer */
99 #define CM_BUF_CMSTORING        2       /* storing this buffer */
100 #define CM_BUF_CMFULLYFETCHED   4       /* read-while-fetching optimization */
101 #define CM_BUF_CMWRITING        8       /* writing to this buffer */
102 /* waiting is done based on scp->flags.  Removing bits from cmFlags
103    should be followed by waking the scp. */
104
105 /* represents soft reference which is OK to lose on a recycle */
106 typedef struct cm_softRef {
107     cm_buf_t *bufp;     /* buffer (may get reused) */
108     long counter;               /* counter of changes to identity */
109 } cm_softRef_t;
110
111 #define CM_BUF_READING  1       /* now reading buffer from the disk */
112 #define CM_BUF_WRITING  2       /* now writing buffer to the disk */
113 #define CM_BUF_INHASH   4       /* in the hash table */
114 #define CM_BUF_DIRTY            8       /* buffer is dirty */
115 #define CM_BUF_INLRU            0x10    /* in lru queue */
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_EVWAIT   0x80    /* someone's waiting for the buffer event */
119 #define CM_BUF_EOF              0x100   /* read 0 bytes; used for detecting EOF */
120
121 typedef struct cm_buf_ops {
122     long (*Writep)(void *, osi_hyper_t *, long, long, struct cm_user *,
123                         struct cm_req *);
124     long (*Readp)(cm_buf_t *, long, long *, struct cm_user *);
125     long (*Stabilizep)(void *, struct cm_user *, struct cm_req *);
126     long (*Unstabilizep)(void *, struct cm_user *);
127 } cm_buf_ops_t;
128
129 /* global locks */
130 extern osi_rwlock_t buf_globalLock;
131
132 extern long buf_Init(int newFile, cm_buf_ops_t *, afs_uint64 nbuffers);
133
134 extern void buf_Shutdown(void);
135
136 extern long buf_CountFreeList(void);
137
138 extern void buf_Release(cm_buf_t *);
139
140 extern void buf_Hold(cm_buf_t *);
141
142 extern void buf_WaitIO(cm_scache_t *, cm_buf_t *);
143
144 extern void buf_ReleaseLocked(cm_buf_t *, afs_uint32);
145
146 extern void buf_HoldLocked(cm_buf_t *);
147
148 extern cm_buf_t *buf_FindLocked(struct cm_scache *, osi_hyper_t *);
149
150 extern cm_buf_t *buf_Find(struct cm_scache *, osi_hyper_t *);
151
152 extern long buf_GetNewLocked(struct cm_scache *, osi_hyper_t *, cm_buf_t **);
153
154 extern long buf_Get(struct cm_scache *, osi_hyper_t *, cm_buf_t **);
155
156 extern long buf_GetNew(struct cm_scache *, osi_hyper_t *, cm_buf_t **);
157
158 extern long buf_CleanAsyncLocked(cm_buf_t *, cm_req_t *);
159
160 extern long buf_CleanAsync(cm_buf_t *, cm_req_t *);
161
162 extern void buf_CleanWait(cm_scache_t *, cm_buf_t *);
163
164 extern void buf_SetDirty(cm_buf_t *, afs_uint32 offset, afs_uint32 length);
165
166 extern long buf_CleanAndReset(void);
167
168 extern void buf_ReserveBuffers(afs_uint64);
169
170 extern int buf_TryReserveBuffers(afs_uint64);
171
172 extern void buf_UnreserveBuffers(afs_uint64);
173
174 #ifdef TESTING
175 extern void buf_ValidateBufQueues(void);
176 #endif /* TESTING */
177
178 extern osi_log_t *buf_logp;
179
180 extern long buf_Truncate(struct cm_scache *scp, cm_user_t *userp,
181         cm_req_t *reqp, osi_hyper_t *sizep);
182
183 extern long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp,
184         cm_req_t *reqp);
185
186 extern long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp,
187         cm_req_t *reqp);
188
189 extern long buf_SetNBuffers(afs_uint64 nbuffers);
190
191 extern long buf_ValidateBuffers(void);
192
193 extern void buf_ForceTrace(BOOL flush);
194
195 extern long buf_DirtyBuffersExist(cm_fid_t * fidp);
196
197 extern long buf_CleanDirtyBuffers(cm_scache_t *scp);
198
199 extern long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion);
200
201 /* error codes */
202 #define CM_BUF_EXISTS   1       /* buffer exists, and shouldn't */
203 #endif /*  _BUF_H__ENV_ */