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