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