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