Initial IBM OpenAFS 1.0 tree
[openafs.git] / src / WINNT / afsd / cm_buf.h
1 /* 
2  * Copyright (C) 1998, 1989 Transarc Corporation - All rights reserved
3  *
4  * (C) COPYRIGHT IBM CORPORATION 1987, 1988
5  * LICENSED MATERIALS - PROPERTY OF IBM
6  *
7  *
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
17 /* default # of buffers if not changed */
18 #define CM_BUF_BUFFERS  100
19 extern long buf_nbuffers;
20
21 /* orig # of buffers */
22 extern long buf_nOrigBuffers;
23
24 /* default buffer size */
25 #define CM_BUF_SIZE             4096
26 extern long buf_bufferSize;
27
28 /* default hash size */
29 #define CM_BUF_HASHSIZE 1024
30 extern long buf_hashSize;
31
32 /* force it to be signed so that mod comes out positive or 0 */
33 #define BUF_HASH(fidp,offsetp) ((((fidp)->vnode+((fidp)->unique << 5)   \
34                                 +(fidp)->volume+(fidp)->cell            \
35                                 +((offsetp)->LowPart / buf_bufferSize)) \
36                                   & 0x7fffffff)                         \
37                                    % buf_hashSize)
38
39 /* another hash fn */
40 #define BUF_FILEHASH(fidp) ((((fidp)->vnode+((fidp)->unique << 5)       \
41                                 +(fidp)->volume+(fidp)->cell)           \
42                                   & 0x7fffffff)                         \
43                                    % buf_hashSize)
44
45 /* backup over pointer to the buffer */
46 #define BUF_OVERTOBUF(op) ((cm_buf_t *)(((char *)op) - ((long)(&((cm_buf_t *)0)->over))))
47
48 /* pretend we have logs, too */
49 typedef char cm_log_t;
50
51 /* represents a single buffer */
52 typedef struct cm_buf {
53         osi_queue_t q;          /* queue of all zero-refcount buffers */
54         struct cm_buf *hashp;   /* hash bucket pointer */
55         struct cm_buf *fileHashp; /* file hash bucket pointer */
56         struct cm_buf *fileHashBackp;   /* file hash bucket back pointer */
57                                 /*
58                                  * The file hash chain is doubly linked, since
59                                  * these chains can get rather long.  The
60                                  * regular hash chain is only singly linked,
61                                  * since the chains should be short if the
62                                  * hash function is good and if there are
63                                  * enough buckets for the size of the cache.
64                                  */
65         struct cm_buf *allp;    /* next in all list */
66         osi_mutex_t mx;         /* mutex protecting structure except refcount */
67         int refCount;           /* reference count */
68         long idCounter;         /* counter for softrefs; bumped at each recycle */
69         long dirtyCounter;      /* bumped at each dirty->clean transition */
70 #ifdef notdef
71         struct cm_log *logp;    /* log for this buffer, if any */
72         osi_hyper_t lsn;        /* lsn to force to (last LSN changing this buffer) */
73 #endif /* notdef */
74         osi_hyper_t offset;     /* offset */
75         cm_fid_t fid;           /* file ID */
76         long flags;             /* flags we're using */
77         long size;              /* size in bytes of this buffer */
78         char *datap;            /* data in this buffer */
79         unsigned long error;    /* last error code, if CM_BUF_ERROR is set */
80         struct cm_user *userp;  /* user who wrote to the buffer last */
81         OVERLAPPED over;        /* overlapped structure for I/O */
82         
83         /* fields added for the CM; locked by scp->mx */
84         long dataVersion;       /* data version of this page */
85         long cmFlags;           /* flags for cm */
86 } cm_buf_t;
87
88 /* values for cmFlags */
89 #define CM_BUF_CMFETCHING       1       /* fetching this buffer */
90 #define CM_BUF_CMSTORING        2       /* storing this buffer */
91 #define CM_BUF_CMFULLYFETCHED   4       /* read-while-fetching optimization */
92 /* waiting is done based on scp->flags */
93
94 /* represents soft reference which is OK to lose on a recycle */
95 typedef struct cm_softRef {
96         cm_buf_t *bufp; /* buffer (may get reused) */
97         long counter;           /* counter of changes to identity */
98 } cm_softRef_t;
99
100 #define CM_BUF_READING  1       /* now reading buffer to the disk */
101 #define CM_BUF_WRITING  2       /* now writing buffer to the disk */
102 #define CM_BUF_INHASH   4       /* in the hash table */
103 #define CM_BUF_DIRTY            8       /* buffer is dirty */
104 #define CM_BUF_INLRU            0x10    /* in lru queue */
105 #define CM_BUF_ERROR            0x20    /* something went wrong on delayed write */
106 #define CM_BUF_WAITING  0x40    /* someone's waiting for a flag to change */
107 #define CM_BUF_EVWAIT   0x80    /* someone's waiting for the buffer event */
108 #define CM_BUF_EOF              0x100   /* read 0 bytes; used for detecting EOF */
109
110 typedef struct cm_buf_ops {
111         long (*Writep)(void *, osi_hyper_t *, long, long, struct cm_user *,
112                         struct cm_req *);
113         long (*Readp)(cm_buf_t *, long, long *, struct cm_user *);
114         long (*Stabilizep)(void *, struct cm_user *, struct cm_req *);
115         long (*Unstabilizep)(void *, struct cm_user *);
116 } cm_buf_ops_t;
117
118 /* global locks */
119 extern osi_rwlock_t buf_globalLock;
120
121 /* buffer free list */
122 extern cm_buf_t *buf_freeListp;
123
124 /* pointer to hash table */
125 extern cm_buf_t **buf_hashTablepp;
126
127 /* another hash table */
128 extern cm_buf_t **buf_fileHashTablepp;
129
130 extern long buf_Init(cm_buf_ops_t *);
131
132 extern long buf_CountFreeList(void);
133
134 extern void buf_Release(cm_buf_t *);
135
136 extern void buf_Hold(cm_buf_t *);
137
138 extern void buf_WaitIO(cm_buf_t *);
139
140 extern void buf_LockedRelease(cm_buf_t *);
141
142 extern cm_buf_t *buf_LockedFind(struct cm_scache *, osi_hyper_t *);
143
144 extern cm_buf_t *buf_Find(struct cm_scache *, osi_hyper_t *);
145
146 extern HANDLE buf_GetFileHandle(long);
147
148 extern void buf_LockedCleanAsync(cm_buf_t *, cm_req_t *);
149
150 extern long buf_GetNewLocked(struct cm_scache *, osi_hyper_t *, cm_buf_t **);
151
152 extern long buf_Get(struct cm_scache *, osi_hyper_t *, cm_buf_t **);
153
154 extern long buf_GetNew(struct cm_scache *, osi_hyper_t *, cm_buf_t **);
155
156 extern void buf_CleanAsync(cm_buf_t *, cm_req_t *);
157
158 extern void buf_CleanWait(cm_buf_t *);
159
160 extern void buf_SetDirty(cm_buf_t *);
161
162 extern long buf_CleanAndReset(void);
163
164 extern void buf_ReserveBuffers(long);
165
166 extern int buf_TryReserveBuffers(long);
167
168 extern void buf_UnreserveBuffers(long);
169
170 extern osi_log_t *buf_logp;
171
172 extern long buf_Truncate(struct cm_scache *scp, cm_user_t *userp,
173         cm_req_t *reqp, osi_hyper_t *sizep);
174
175 extern long buf_CleanVnode(struct cm_scache *scp, cm_user_t *userp,
176         cm_req_t *reqp);
177
178 extern long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp,
179         cm_req_t *reqp);
180
181 extern long buf_SetNBuffers(long nbuffers);
182
183 /* error codes */
184 #define CM_BUF_EXISTS   1       /* buffer exists, and shouldn't */
185 #define CM_ERROR_BASEBUF        0x33333333
186 #define CM_ERROR_TOOFEWBUFS     (CM_ERROR_BASEBUF+0)
187 #define CM_ERROR_TOOMANYBUFS    (CM_ERROR_BASEBUF+1)
188 #endif /*  _BUF_H__ENV_ */