Make DRelease take an anonymous pointer
[openafs.git] / src / dir / buffer.c
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 #include <afsconfig.h>
11 #include <afs/param.h>
12
13
14 #include <stdlib.h>
15 #include <lock.h>
16
17 #ifdef AFS_64BIT_IOPS_ENV
18 #define BUFFER_FID_SIZE (9 + 2*sizeof(char*)/sizeof(int))
19 #else
20 #define BUFFER_FID_SIZE (6 + 2*sizeof(char*)/sizeof(int))
21 #endif
22
23 struct buffer {
24     /* fid is used for Unique cache key + i/o addressing.
25      * fid size is based on 4 + size of inode and size of pointer
26      */
27     afs_int32 fid[BUFFER_FID_SIZE];
28     afs_int32 page;
29     afs_int32 accesstime;
30     struct buffer *hashNext;
31     void *data;
32     char lockers;
33     char dirty;
34     char hashIndex;
35     struct Lock lock;
36 };
37
38 #include "dir.h"
39
40 struct Lock afs_bufferLock;
41
42 /* page size */
43 #define BUFFER_PAGE_SIZE 2048
44 /* log page size */
45 #define LOGPS 11
46 /* page hash table size */
47 #define PHSIZE 32
48 /* The hash table should be somewhat efficient even if there are only
49  * a few partitions (less than 32). So the hash for the fileserver is now
50  * based on the volume id. This means this macro is dependent upon the
51  * layout of DirHandle in viced/viced.h, vol/salvage.h and volser/salvage.h.
52  */
53 #define pHash(fid) ((fid)[0] & (PHSIZE-1))
54 #define vHash(vid) (vid & (PHSIZE-1))
55
56 /* admittedly system dependent, this is the maximum signed 32-bit value */
57 #define BUFFER_LONG_MAX   2147483647
58 #ifndef NULL
59 #define NULL 0
60 #endif
61
62 static struct buffer **Buffers;
63
64 char *BufferData;
65
66 static struct buffer *phTable[PHSIZE];  /* page hash table */
67 static struct buffer *LastBuffer;
68 int nbuffers;
69 int timecounter;
70 static int calls = 0, ios = 0;
71
72 struct buffer *newslot(afs_int32 *afid, afs_int32 apage, 
73                        struct buffer *lp);
74
75 /* XXX - This sucks. The correct prototypes for these functions are ...
76  *
77  * extern void FidZero(DirHandle *);
78  * extern int  FidEq(DirHandle *a, DirHandle *b);
79  * extern int  ReallyRead(DirHandle *a, int block, char *data);
80  */
81
82 extern void FidZero(afs_int32 *file);
83 extern int FidEq(afs_int32 *a, afs_int32 *b);
84 extern int ReallyRead(afs_int32 *file, int block, char *data);
85 extern int ReallyWrite(afs_int32 *file, int block, char *data);
86 extern void FidZap(afs_int32 *file);
87 extern int  FidVolEq(afs_int32 *file, afs_int32 vid);
88 extern void FidCpy(afs_int32 *tofile, afs_int32 *fromfile);
89 extern void Die(char *msg);
90
91 int
92 DStat(int *abuffers, int *acalls, int *aios)
93 {
94     *abuffers = nbuffers;
95     *acalls = calls;
96     *aios = ios;
97     return 0;
98 }
99
100 int
101 DInit(int abuffers)
102 {
103     /* Initialize the venus buffer system. */
104     register int i, tsize;
105     register struct buffer *tb;
106     register char *tp;
107
108     Lock_Init(&afs_bufferLock);
109     /* Align each element of Buffers on a doubleword boundary */
110     tsize = (sizeof(struct buffer) + 7) & ~7;
111     tp = (char *)malloc(abuffers * tsize);
112     Buffers = (struct buffer **)malloc(abuffers * sizeof(struct buffer *));
113     BufferData = (char *)malloc(abuffers * BUFFER_PAGE_SIZE);
114     timecounter = 0;
115     LastBuffer = (struct buffer *)tp;
116     nbuffers = abuffers;
117     for (i = 0; i < PHSIZE; i++)
118         phTable[i] = 0;
119     for (i = 0; i < abuffers; i++) {
120         /* Fill in each buffer with an empty indication. */
121         tb = (struct buffer *)tp;
122         Buffers[i] = tb;
123         tp += tsize;
124         FidZero(tb->fid);
125         tb->accesstime = tb->lockers = 0;
126         tb->data = &BufferData[BUFFER_PAGE_SIZE * i];
127         tb->hashIndex = 0;
128         tb->dirty = 0;
129         Lock_Init(&tb->lock);
130     }
131     return 0;
132 }
133
134 void *
135 DRead(register afs_int32 *fid, register int page)
136 {
137     /* Read a page from the disk. */
138     register struct buffer *tb, *tb2, **bufhead;
139
140     ObtainWriteLock(&afs_bufferLock);
141     calls++;
142
143 #define bufmatch(tb) (tb->page == page && FidEq(tb->fid, fid))
144 #define buf_Front(head,parent,p) {(parent)->hashNext = (p)->hashNext; (p)->hashNext= *(head);*(head)=(p);}
145
146     /* this apparently-complicated-looking code is simply an example of
147      * a little bit of loop unrolling, and is a standard linked-list
148      * traversal trick. It saves a few assignments at the the expense
149      * of larger code size.  This could be simplified by better use of
150      * macros.  With the use of these LRU queues, the old one-cache is
151      * probably obsolete.
152      */
153     if ((tb = phTable[pHash(fid)])) {   /* ASSMT HERE */
154         if (bufmatch(tb)) {
155             ObtainWriteLock(&tb->lock);
156             tb->lockers++;
157             ReleaseWriteLock(&afs_bufferLock);
158             tb->accesstime = ++timecounter;
159             ReleaseWriteLock(&tb->lock);
160             return tb->data;
161         } else {
162             bufhead = &(phTable[pHash(fid)]);
163             while ((tb2 = tb->hashNext)) {
164                 if (bufmatch(tb2)) {
165                     buf_Front(bufhead, tb, tb2);
166                     ObtainWriteLock(&tb2->lock);
167                     tb2->lockers++;
168                     ReleaseWriteLock(&afs_bufferLock);
169                     tb2->accesstime = ++timecounter;
170                     ReleaseWriteLock(&tb2->lock);
171                     return tb2->data;
172                 }
173                 if ((tb = tb2->hashNext)) {     /* ASSIGNMENT HERE! */
174                     if (bufmatch(tb)) {
175                         buf_Front(bufhead, tb2, tb);
176                         ObtainWriteLock(&tb->lock);
177                         tb->lockers++;
178                         ReleaseWriteLock(&afs_bufferLock);
179                         tb->accesstime = ++timecounter;
180                         ReleaseWriteLock(&tb->lock);
181                         return tb->data;
182                     }
183                 } else
184                     break;
185             }
186         }
187     } else
188         tb2 = NULL;
189
190     /* can't find it */
191     /* The last thing we looked at was either tb or tb2 (or nothing). That
192      * is at least the oldest buffer on one particular hash chain, so it's
193      * a pretty good place to start looking for the truly oldest buffer.
194      */
195     tb = newslot(fid, page, (tb ? tb : tb2));
196     ios++;
197     ObtainWriteLock(&tb->lock);
198     tb->lockers++;
199     ReleaseWriteLock(&afs_bufferLock);
200     if (ReallyRead(tb->fid, tb->page, tb->data)) {
201         tb->lockers--;
202         FidZap(tb->fid);        /* disaster */
203         ReleaseWriteLock(&tb->lock);
204         return 0;
205     }
206     /* Note that findslot sets the page field in the buffer equal to
207      * what it is searching for.
208      */
209     ReleaseWriteLock(&tb->lock);
210     return tb->data;
211 }
212
213 static int
214 FixupBucket(register struct buffer *ap)
215 {
216     register struct buffer **lp, *tp;
217     register int i;
218
219     /* first try to get it out of its current hash bucket, in which it might not be */
220     i = ap->hashIndex;
221     lp = &phTable[i];
222     for (tp = *lp; tp; tp = tp->hashNext) {
223         if (tp == ap) {
224             *lp = tp->hashNext;
225             break;
226         }
227         lp = &tp->hashNext;
228     }
229     /* now figure the new hash bucket */
230     i = pHash(ap->fid);
231     ap->hashIndex = i;          /* remember where we are for deletion */
232     ap->hashNext = phTable[i];  /* add us to the list */
233     phTable[i] = ap;            /* at the front, since it's LRU */
234     return 0;
235 }
236
237 struct buffer *
238 newslot(afs_int32 *afid, afs_int32 apage, register struct buffer *lp)
239 {
240     /* Find a usable buffer slot */
241     register afs_int32 i;
242     afs_int32 lt;
243     register struct buffer **tbp;
244
245     if (lp && (lp->lockers == 0)) {
246         lt = lp->accesstime;
247     } else {
248         lp = 0;
249         lt = BUFFER_LONG_MAX;
250     }
251
252     tbp = Buffers;
253     for (i = 0; i < nbuffers; i++, tbp++) {
254         if ((*tbp)->lockers == 0) {
255             if ((*tbp)->accesstime < lt) {
256                 lp = (*tbp);
257                 lt = (*tbp)->accesstime;
258             }
259         }
260     }
261
262     /* There are no unlocked buffers */
263     if (lp == 0) {
264         if (lt < 0)
265             Die("accesstime counter wrapped");
266         else
267             Die("all buffers locked");
268     }
269
270     /* We do not need to lock the buffer here because it has no lockers
271      * and the afs_bufferLock prevents other threads from zapping this
272      * buffer while we are writing it out */
273     if (lp->dirty) {
274         if (ReallyWrite(lp->fid, lp->page, lp->data))
275             Die("writing bogus buffer");
276         lp->dirty = 0;
277     }
278
279     /* Now fill in the header. */
280     FidZap(lp->fid);
281     FidCpy(lp->fid, afid);      /* set this */
282     lp->page = apage;
283     lp->accesstime = ++timecounter;
284
285     FixupBucket(lp);            /* move to the right hash bucket */
286
287     return lp;
288 }
289
290 /* Release a buffer, specifying whether or not the buffer has been modified
291  * by the locker. */
292 void
293 DRelease(void *loc, int flag)
294 {
295     struct buffer *bp = (struct buffer *)loc;
296     register int index;
297
298     if (!bp)
299         return;
300     index = ((char *)bp - BufferData) >> LOGPS;
301     bp = Buffers[index];
302     ObtainWriteLock(&bp->lock);
303     bp->lockers--;
304     if (flag)
305         bp->dirty = 1;
306     ReleaseWriteLock(&bp->lock);
307 }
308
309 int
310 DVOffset(register void *ap)
311 {
312     /* Return the byte within a file represented by a buffer pointer. */
313     register struct buffer *bp = ap;
314     register int index;
315
316     index = ((char *)bp - BufferData) >> LOGPS;
317     if (index < 0 || index >= nbuffers)
318         return -1;
319     bp = Buffers[index];
320     return BUFFER_PAGE_SIZE * bp->page + (char *)ap - (char *)bp->data;
321 }
322
323 void
324 DZap(register afs_int32 *fid)
325 {
326     /* Destroy all buffers pertaining to a particular fid. */
327     register struct buffer *tb;
328     ObtainReadLock(&afs_bufferLock);
329     for (tb = phTable[pHash(fid)]; tb; tb = tb->hashNext)
330         if (FidEq(tb->fid, fid)) {
331             ObtainWriteLock(&tb->lock);
332             FidZap(tb->fid);
333             tb->dirty = 0;
334             ReleaseWriteLock(&tb->lock);
335         }
336     ReleaseReadLock(&afs_bufferLock);
337 }
338
339 int
340 DFlushVolume(register afs_int32 vid)
341 {
342     /* Flush all data and release all inode handles for a particular volume */
343     register struct buffer *tb;
344     register int code, rcode = 0;
345     ObtainReadLock(&afs_bufferLock);
346     for (tb = phTable[vHash(vid)]; tb; tb = tb->hashNext)
347         if (FidVolEq(tb->fid, vid)) {
348             ObtainWriteLock(&tb->lock);
349             if (tb->dirty) {
350                 code = ReallyWrite(tb->fid, tb->page, tb->data);
351                 if (code && !rcode)
352                     rcode = code;
353                 tb->dirty = 0;
354             }
355             FidZap(tb->fid);
356             ReleaseWriteLock(&tb->lock);
357         }
358     ReleaseReadLock(&afs_bufferLock);
359     return rcode;
360 }
361
362 int
363 DFlushEntry(register afs_int32 *fid)
364 {
365     /* Flush pages modified by one entry. */
366     register struct buffer *tb;
367     int code;
368
369     ObtainReadLock(&afs_bufferLock);
370     for (tb = phTable[pHash(fid)]; tb; tb = tb->hashNext)
371         if (FidEq(tb->fid, fid) && tb->dirty) {
372             ObtainWriteLock(&tb->lock);
373             if (tb->dirty) {
374                 code = ReallyWrite(tb->fid, tb->page, tb->data);
375                 if (code) {
376                     ReleaseWriteLock(&tb->lock);
377                     ReleaseReadLock(&afs_bufferLock);
378                     return code;
379                 }
380                 tb->dirty = 0;
381             }
382             ReleaseWriteLock(&tb->lock);
383         }
384     ReleaseReadLock(&afs_bufferLock);
385     return 0;
386 }
387
388 int
389 DFlush(void)
390 {
391     /* Flush all the modified buffers. */
392     register int i;
393     register struct buffer **tbp;
394     afs_int32 code, rcode;
395
396     rcode = 0;
397     tbp = Buffers;
398     ObtainReadLock(&afs_bufferLock);
399     for (i = 0; i < nbuffers; i++, tbp++) {
400         if ((*tbp)->dirty) {
401             ObtainWriteLock(&(*tbp)->lock);
402             (*tbp)->lockers++;
403             ReleaseReadLock(&afs_bufferLock);
404             if ((*tbp)->dirty) {
405                 code = ReallyWrite((*tbp)->fid, (*tbp)->page, (*tbp)->data);
406                 if (!code)
407                     (*tbp)->dirty = 0;  /* Clear the dirty flag */
408                 if (code && !rcode) {
409                     rcode = code;
410                 }
411             }
412             (*tbp)->lockers--;
413             ReleaseWriteLock(&(*tbp)->lock);
414             ObtainReadLock(&afs_bufferLock);
415         }
416     }
417     ReleaseReadLock(&afs_bufferLock);
418     return rcode;
419 }
420
421 void *
422 DNew(register afs_int32 *fid, register int page)
423 {
424     /* Same as read, only do *not* even try to read the page,
425      * since it probably doesn't exist.
426      */
427     register struct buffer *tb;
428     ObtainWriteLock(&afs_bufferLock);
429     if ((tb = newslot(fid, page, 0)) == 0) {
430         ReleaseWriteLock(&afs_bufferLock);
431         return 0;
432     }
433     ObtainWriteLock(&tb->lock);
434     tb->lockers++;
435     ReleaseWriteLock(&afs_bufferLock);
436     ReleaseWriteLock(&tb->lock);
437     return tb->data;
438 }