src/afs/afs_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 "afs/sysincludes.h"
  15 #include "afsincludes.h"
  16 #if !defined(UKERNEL)
  17 #include "h/param.h"
  18 #include "h/types.h"
  19 #include "h/time.h"
  20 #if     defined(AFS_AIX31_ENV)
  21 #include "h/limits.h"
  22 #endif
  23 #if     !defined(AFS_AIX_ENV) && !defined(AFS_SUN5_ENV) && !defined(AFS_SGI_ENV) && !defined(AFS_LINUX20_ENV)
  24 #include "h/kernel.h"           /* Doesn't needed, so it should go */
  25 #endif
  26 #endif /* !defined(UKERNEL) */
  27
  28 #include "afs/afs_osi.h"
  29 #include "afsint.h"
  30 #include "afs/lock.h"
  31
  32 #if !defined(UKERNEL) && !defined(AFS_LINUX20_ENV)
  33 #include "h/buf.h"
  34 #endif /* !defined(UKERNEL) */
  35
  36 #include "afs/stds.h"
  37 #include "afs/volerrors.h"
  38 #include "afs/exporter.h"
  39 #include "afs/prs_fs.h"
  40 #include "afs/afs_chunkops.h"
  41 #include "afs/dir.h"
  42
  43 #include "afs/afs_stats.h"
  44 #include "afs/afs.h"
  45
  46 #ifndef BUF_TIME_MAX
  47 #define BUF_TIME_MAX    0x7fffffff
  48 #endif
  49 #define NPB 8                   /* must be a pwer of 2 */
  50 static int afs_max_buffers;     /* should be an integral multiple of NPB */
  51
  52 /* page size */
  53 #define AFS_BUFFER_PAGESIZE 2048
  54 /* log page size */
  55 #define LOGPS 11
  56 /* If you change any of this PH stuff, make sure you don't break DZap() */
  57 /* use last two bits for page */
  58 #define PHPAGEMASK 3
  59 /* use next five bits for fid */
  60 #define PHFIDMASK 124
  61 /* page hash table size - this is pretty intertwined with pHash */
  62 #define PHSIZE (PHPAGEMASK + PHFIDMASK + 1)
  63 /* the pHash macro */
  64 #define pHash(fid,page) ((((afs_int32)(fid)) & PHFIDMASK) \
  65                          | (page & PHPAGEMASK))
  66
  67 #ifdef  dirty
  68 #undef dirty                    /* XXX */
  69 #endif
  70
  71 static struct buffer *Buffers = 0;
  72 static char *BufferData;
  73
  74 #ifdef  AFS_AIX_ENV
  75 extern struct buf *geteblk();
  76 #endif
  77 #ifdef AFS_FBSD_ENV
  78 #define timecounter afs_timecounter
  79 #endif
  80
  81 /* A note on locking in 'struct buffer'
  82  *
  83  * afs_bufferLock protects the hash chain, and the 'lockers' field where that
  84  * has a zero value. It must be held whenever lockers is incremented from zero.
  85  *
  86  * The individual buffer lock protects the contents of the structure, including
  87  * the lockers field.
  88  *
  89  * For safety: afs_bufferLock and the individual buffer lock must be held
  90  * when obtaining a reference on a structure. Only the individual buffer lock
  91  * need be held when releasing a reference.
  92  *
  93  * The locking hierarchy is afs_bufferLock-> buffer.lock
  94  *
  95  */
  96
  97 static afs_lock_t afs_bufferLock;
  98 static struct buffer *phTable[PHSIZE];  /* page hash table */
  99 static int nbuffers;
 100 static afs_int32 timecounter;
 101
 102 /* Prototypes for static routines */
 103 static struct buffer *afs_newslot(struct dcache *adc, afs_int32 apage,
 104                                   struct buffer *lp);
 105
 106 static int dinit_flag = 0;
 107 void
 108 DInit(int abuffers)
 109 {
 110     /* Initialize the venus buffer system. */
 111     int i;
 112     struct buffer *tb;
 113
 114     AFS_STATCNT(DInit);
 115     if (dinit_flag)
 116         return;
 117     dinit_flag = 1;
 118     /* round up to next multiple of NPB, since we allocate multiple pages per chunk */
 119     abuffers = ((abuffers - 1) | (NPB - 1)) + 1;
 120     afs_max_buffers = abuffers << 2;            /* possibly grow up to 4 times as big */
 121     LOCK_INIT(&afs_bufferLock, "afs_bufferLock");
 122     Buffers = afs_osi_Alloc(afs_max_buffers * sizeof(struct buffer));
 123     osi_Assert(Buffers != NULL);
 124     timecounter = 1;
 125     afs_stats_cmperf.bufAlloced = nbuffers = abuffers;
 126     for (i = 0; i < PHSIZE; i++)
 127         phTable[i] = 0;
 128     for (i = 0; i < abuffers; i++) {
 129         if ((i & (NPB - 1)) == 0) {
 130             /* time to allocate a fresh buffer */
 131             BufferData = afs_osi_Alloc(AFS_BUFFER_PAGESIZE * NPB);
 132             osi_Assert(BufferData != NULL);
 133         }
 134         /* Fill in each buffer with an empty indication. */
 135         tb = &Buffers[i];
 136         tb->fid = NULLIDX;
 137         afs_reset_inode(&tb->inode);
 138         tb->accesstime = 0;
 139         tb->lockers = 0;
 140         tb->data = &BufferData[AFS_BUFFER_PAGESIZE * (i & (NPB - 1))];
 141         tb->hashIndex = 0;
 142         tb->dirty = 0;
 143         AFS_RWLOCK_INIT(&tb->lock, "buffer lock");
 144     }
 145     return;
 146 }
 147
 148 int
 149 DRead(struct dcache *adc, int page, struct DirBuffer *entry)
 150 {
 151     /* Read a page from the disk. */
 152     struct buffer *tb, *tb2;
 153     struct osi_file *tfile;
 154     int code;
 155
 156     AFS_STATCNT(DRead);
 157
 158     memset(entry, 0, sizeof(struct DirBuffer));
 159
 160     ObtainWriteLock(&afs_bufferLock, 256);
 161
 162 #define bufmatch(tb) (tb->page == page && tb->fid == adc->index)
 163 #define buf_Front(head,parent,p) {(parent)->hashNext = (p)->hashNext; (p)->hashNext= *(head);*(head)=(p);}
 164
 165     /* this apparently-complicated-looking code is simply an example of
 166      * a little bit of loop unrolling, and is a standard linked-list
 167      * traversal trick. It saves a few assignments at the the expense
 168      * of larger code size.  This could be simplified by better use of
 169      * macros.
 170      */
 171     if ((tb = phTable[pHash(adc->index, page)])) {
 172         if (bufmatch(tb)) {
 173             ObtainWriteLock(&tb->lock, 257);
 174             tb->lockers++;
 175             ReleaseWriteLock(&afs_bufferLock);
 176             tb->accesstime = timecounter++;
 177             AFS_STATS(afs_stats_cmperf.bufHits++);
 178             ReleaseWriteLock(&tb->lock);
 179             entry->buffer = tb;
 180             entry->data = tb->data;
 181             return 0;
 182         } else {
 183             struct buffer **bufhead;
 184             bufhead = &(phTable[pHash(adc->index, page)]);
 185             while ((tb2 = tb->hashNext)) {
 186                 if (bufmatch(tb2)) {
 187                     buf_Front(bufhead, tb, tb2);
 188                     ObtainWriteLock(&tb2->lock, 258);
 189                     tb2->lockers++;
 190                     ReleaseWriteLock(&afs_bufferLock);
 191                     tb2->accesstime = timecounter++;
 192                     AFS_STATS(afs_stats_cmperf.bufHits++);
 193                     ReleaseWriteLock(&tb2->lock);
 194                     entry->buffer = tb2;
 195                     entry->data = tb2->data;
 196                     return 0;
 197                 }
 198                 if ((tb = tb2->hashNext)) {
 199                     if (bufmatch(tb)) {
 200                         buf_Front(bufhead, tb2, tb);
 201                         ObtainWriteLock(&tb->lock, 259);
 202                         tb->lockers++;
 203                         ReleaseWriteLock(&afs_bufferLock);
 204                         tb->accesstime = timecounter++;
 205                         AFS_STATS(afs_stats_cmperf.bufHits++);
 206                         ReleaseWriteLock(&tb->lock);
 207                         entry->buffer = tb;
 208                         entry->data = tb->data;
 209                     }
 210                 } else
 211                     break;
 212             }
 213         }
 214     } else
 215         tb2 = NULL;
 216
 217     AFS_STATS(afs_stats_cmperf.bufMisses++);
 218     /* can't find it */
 219     /* The last thing we looked at was either tb or tb2 (or nothing). That
 220      * is at least the oldest buffer on one particular hash chain, so it's
 221      * a pretty good place to start looking for the truly oldest buffer.
 222      */
 223     tb = afs_newslot(adc, page, (tb ? tb : tb2));
 224     if (!tb) {
 225         ReleaseWriteLock(&afs_bufferLock);
 226         return EIO;
 227     }
 228     ObtainWriteLock(&tb->lock, 260);
 229     tb->lockers++;
 230     ReleaseWriteLock(&afs_bufferLock);
 231     if (page * AFS_BUFFER_PAGESIZE >= adc->f.chunkBytes) {
 232         tb->fid = NULLIDX;
 233         afs_reset_inode(&tb->inode);
 234         tb->lockers--;
 235         ReleaseWriteLock(&tb->lock);
 236         return EIO;
 237     }
 238     tfile = afs_CFileOpen(&adc->f.inode);
 239     code =
 240         afs_CFileRead(tfile, tb->page * AFS_BUFFER_PAGESIZE, tb->data,
 241                       AFS_BUFFER_PAGESIZE);
 242     afs_CFileClose(tfile);
 243     if (code < AFS_BUFFER_PAGESIZE) {
 244         tb->fid = NULLIDX;
 245         afs_reset_inode(&tb->inode);
 246         tb->lockers--;
 247         ReleaseWriteLock(&tb->lock);
 248         return EIO;
 249     }
 250     /* Note that findslot sets the page field in the buffer equal to
 251      * what it is searching for. */
 252     ReleaseWriteLock(&tb->lock);
 253     entry->buffer = tb;
 254     entry->data = tb->data;
 255     return 0;
 256 }
 257
 258 static void
 259 FixupBucket(struct buffer *ap)
 260 {
 261     struct buffer **lp, *tp;
 262     int i;
 263     /* first try to get it out of its current hash bucket, in which it
 264      * might not be */
 265     AFS_STATCNT(FixupBucket);
 266     i = ap->hashIndex;
 267     lp = &phTable[i];
 268     for (tp = *lp; tp; tp = tp->hashNext) {
 269         if (tp == ap) {
 270             *lp = tp->hashNext;
 271             break;
 272         }
 273         lp = &tp->hashNext;
 274     }
 275     /* now figure the new hash bucket */
 276     i = pHash(ap->fid, ap->page);
 277     ap->hashIndex = i;          /* remember where we are for deletion */
 278     ap->hashNext = phTable[i];  /* add us to the list */
 279     phTable[i] = ap;            /* at the front, since it's LRU */
 280 }
 281
 282 /* lp is pointer to a fairly-old buffer */
 283 static struct buffer *
 284 afs_newslot(struct dcache *adc, afs_int32 apage, struct buffer *lp)
 285 {
 286     /* Find a usable buffer slot */
 287     afs_int32 i;
 288     afs_int32 lt = 0;
 289     struct buffer *tp;
 290     struct osi_file *tfile;
 291
 292     AFS_STATCNT(afs_newslot);
 293     /* we take a pointer here to a buffer which was at the end of an
 294      * LRU hash chain.  Odds are, it's one of the older buffers, not
 295      * one of the newer.  Having an older buffer to start with may
 296      * permit us to avoid a few of the assignments in the "typical
 297      * case" for loop below.
 298      */
 299     if (lp && (lp->lockers == 0)) {
 300         lt = lp->accesstime;
 301     } else {
 302         lp = NULL;
 303     }
 304
 305     /* timecounter might have wrapped, if machine is very very busy
 306      * and stays up for a long time.  Timecounter mustn't wrap twice
 307      * (positive->negative->positive) before calling newslot, but that
 308      * would require 2 billion consecutive cache hits... Anyway, the
 309      * penalty is only that the cache replacement policy will be
 310      * almost MRU for the next ~2 billion DReads...  newslot doesn't
 311      * get called nearly as often as DRead, so in order to avoid the
 312      * performance penalty of using the hypers, it's worth doing the
 313      * extra check here every time.  It's probably cheaper than doing
 314      * hcmp, anyway.  There is a little performance hit resulting from
 315      * resetting all the access times to 0, but it only happens once
 316      * every month or so, and the access times will rapidly sort
 317      * themselves back out after just a few more DReads.
 318      */
 319     if (timecounter < 0) {
 320         timecounter = 1;
 321         tp = Buffers;
 322         for (i = 0; i < nbuffers; i++, tp++) {
 323             tp->accesstime = 0;
 324             if (!lp && !tp->lockers)    /* one is as good as the rest, I guess */
 325                 lp = tp;
 326         }
 327     } else {
 328         /* this is the typical case */
 329         tp = Buffers;
 330         for (i = 0; i < nbuffers; i++, tp++) {
 331             if (tp->lockers == 0) {
 332                 if (!lp || tp->accesstime < lt) {
 333                     lp = tp;
 334                     lt = tp->accesstime;
 335                 }
 336             }
 337         }
 338     }
 339
 340     if (lp == 0) {
 341         /* No unlocked buffers. If still possible, allocate a new increment */
 342         if (nbuffers + NPB > afs_max_buffers) {
 343             /* There are no unlocked buffers -- this used to panic, but that
 344              * seems extreme.  To the best of my knowledge, all the callers
 345              * of DRead are prepared to handle a zero return.  Some of them
 346              * just panic directly, but not all of them. */
 347             afs_warn("afs: all buffers locked\n");
 348             return 0;
 349         }
 350
 351         BufferData = afs_osi_Alloc(AFS_BUFFER_PAGESIZE * NPB);
 352         osi_Assert(BufferData != NULL);
 353         for (i = 0; i< NPB; i++) {
 354             /* Fill in each buffer with an empty indication. */
 355             tp = &Buffers[i + nbuffers];
 356             tp->fid = NULLIDX;
 357             afs_reset_inode(&tp->inode);
 358             tp->accesstime = 0;
 359             tp->lockers = 0;
 360             tp->data = &BufferData[AFS_BUFFER_PAGESIZE * i];
 361             tp->hashIndex = 0;
 362             tp->dirty = 0;
 363             AFS_RWLOCK_INIT(&tp->lock, "buffer lock");
 364         }
 365         lp = &Buffers[nbuffers];
 366         nbuffers += NPB;
 367     }
 368
 369     if (lp->dirty) {
 370         /* see DFlush for rationale for not getting and locking the dcache */
 371         tfile = afs_CFileOpen(&lp->inode);
 372         afs_CFileWrite(tfile, lp->page * AFS_BUFFER_PAGESIZE, lp->data,
 373                        AFS_BUFFER_PAGESIZE);
 374         lp->dirty = 0;
 375         afs_CFileClose(tfile);
 376         AFS_STATS(afs_stats_cmperf.bufFlushDirty++);
 377     }
 378
 379     /* Now fill in the header. */
 380     lp->fid = adc->index;
 381     afs_copy_inode(&lp->inode, &adc->f.inode);
 382     lp->page = apage;
 383     lp->accesstime = timecounter++;
 384     FixupBucket(lp);            /* move to the right hash bucket */
 385
 386     return lp;
 387 }
 388
 389 void
 390 DRelease(struct DirBuffer *entry, int flag)
 391 {
 392     struct buffer *tp;
 393
 394     AFS_STATCNT(DRelease);
 395
 396     tp = entry->buffer;
 397     if (tp == NULL)
 398         return;
 399
 400     tp = entry->buffer;
 401     ObtainWriteLock(&tp->lock, 261);
 402     tp->lockers--;
 403     if (flag)
 404         tp->dirty = 1;
 405     ReleaseWriteLock(&tp->lock);
 406 }
 407
 408 int
 409 DVOffset(struct DirBuffer *entry)
 410 {
 411     struct buffer *bp;
 412
 413     AFS_STATCNT(DVOffset);
 414
 415     bp = entry->buffer;
 416     return AFS_BUFFER_PAGESIZE * bp->page
 417             + (char *)entry->data - (char *)bp->data;
 418 }
 419
 420 /*!
 421  * Zap one dcache entry: destroy one FID's buffers.
 422  *
 423  * 1/1/91 - I've modified the hash function to take the page as well
 424  * as the *fid, so that lookup will be a bit faster.  That presents some
 425  * difficulties for Zap, which now has to have some knowledge of the nature
 426  * of the hash function.  Oh well.  This should use the list traversal
 427  * method of DRead...
 428  *
 429  * \param adc The dcache entry to be zapped.
 430  */
 431 void
 432 DZap(struct dcache *adc)
 433 {
 434     int i;
 435     /* Destroy all buffers pertaining to a particular fid. */
 436     struct buffer *tb;
 437
 438     AFS_STATCNT(DZap);
 439     ObtainReadLock(&afs_bufferLock);
 440
 441     for (i = 0; i <= PHPAGEMASK; i++)
 442         for (tb = phTable[pHash(adc->index, i)]; tb; tb = tb->hashNext)
 443             if (tb->fid == adc->index) {
 444                 ObtainWriteLock(&tb->lock, 262);
 445                 tb->fid = NULLIDX;
 446                 afs_reset_inode(&tb->inode);
 447                 tb->dirty = 0;
 448                 ReleaseWriteLock(&tb->lock);
 449             }
 450     ReleaseReadLock(&afs_bufferLock);
 451 }
 452
 453 static void
 454 DFlushBuffer(struct buffer *ab)
 455 {
 456     struct osi_file *tfile;
 457
 458     tfile = afs_CFileOpen(&ab->inode);
 459     afs_CFileWrite(tfile, ab->page * AFS_BUFFER_PAGESIZE,
 460                    ab->data, AFS_BUFFER_PAGESIZE);
 461     ab->dirty = 0;      /* Clear the dirty flag */
 462     afs_CFileClose(tfile);
 463 }
 464
 465 void
 466 DFlushDCache(struct dcache *adc)
 467 {
 468     int i;
 469     struct buffer *tb;
 470
 471     ObtainReadLock(&afs_bufferLock);
 472
 473     for (i = 0; i <= PHPAGEMASK; i++)
 474         for (tb = phTable[pHash(adc->index, i)]; tb; tb = tb->hashNext)
 475             if (tb->fid == adc->index) {
 476                 ObtainWriteLock(&tb->lock, 701);
 477                 tb->lockers++;
 478                 ReleaseReadLock(&afs_bufferLock);
 479                 if (tb->dirty) {
 480                     DFlushBuffer(tb);
 481                 }
 482                 tb->lockers--;
 483                 ReleaseWriteLock(&tb->lock);
 484                 ObtainReadLock(&afs_bufferLock);
 485             }
 486
 487     ReleaseReadLock(&afs_bufferLock);
 488 }
 489
 490 void
 491 DFlush(void)
 492 {
 493     /* Flush all the modified buffers. */
 494     int i;
 495     struct buffer *tb;
 496
 497     AFS_STATCNT(DFlush);
 498     tb = Buffers;
 499     ObtainReadLock(&afs_bufferLock);
 500     for (i = 0; i < nbuffers; i++, tb++) {
 501         if (tb->dirty) {
 502             ObtainWriteLock(&tb->lock, 263);
 503             tb->lockers++;
 504             ReleaseReadLock(&afs_bufferLock);
 505             if (tb->dirty) {
 506                 /* it seems safe to do this I/O without having the dcache
 507                  * locked, since the only things that will update the data in
 508                  * a directory are the buffer package, which holds the relevant
 509                  * tb->lock while doing the write, or afs_GetDCache, which
 510                  * DZap's the directory while holding the dcache lock.
 511                  * It is not possible to lock the dcache or even call
 512                  * afs_GetDSlot to map the index to the dcache since the dir
 513                  * package's caller has some dcache object locked already (so
 514                  * we cannot lock afs_xdcache). In addition, we cannot obtain
 515                  * a dcache lock while holding the tb->lock of the same file
 516                  * since that can deadlock with DRead/DNew */
 517                 DFlushBuffer(tb);
 518             }
 519             tb->lockers--;
 520             ReleaseWriteLock(&tb->lock);
 521             ObtainReadLock(&afs_bufferLock);
 522         }
 523     }
 524     ReleaseReadLock(&afs_bufferLock);
 525 }
 526
 527 int
 528 DNew(struct dcache *adc, int page, struct DirBuffer *entry)
 529 {
 530     /* Same as read, only do *not* even try to read the page, since it
 531      * probably doesn't exist. */
 532     struct buffer *tb;
 533     AFS_STATCNT(DNew);
 534
 535     ObtainWriteLock(&afs_bufferLock, 264);
 536     if ((tb = afs_newslot(adc, page, NULL)) == 0) {
 537         ReleaseWriteLock(&afs_bufferLock);
 538         return EIO;
 539     }
 540     /* extend the chunk, if needed */
 541     /* Do it now, not in DFlush or afs_newslot when the data is written out,
 542      * since now our caller has adc->lock writelocked, and we can't acquire
 543      * that lock (or even map from a fid to a dcache) in afs_newslot or
 544      * DFlush due to lock hierarchy issues */
 545     if ((page + 1) * AFS_BUFFER_PAGESIZE > adc->f.chunkBytes) {
 546         afs_AdjustSize(adc, (page + 1) * AFS_BUFFER_PAGESIZE);
 547         afs_WriteDCache(adc, 1);
 548     }
 549     ObtainWriteLock(&tb->lock, 265);
 550     tb->lockers++;
 551     ReleaseWriteLock(&afs_bufferLock);
 552     ReleaseWriteLock(&tb->lock);
 553     entry->buffer = tb;
 554     entry->data = tb->data;
 555
 556     return 0;
 557 }
 558
 559 void
 560 shutdown_bufferpackage(void)
 561 {
 562     struct buffer *tp;
 563     int i;
 564
 565     AFS_STATCNT(shutdown_bufferpackage);
 566     /* Free all allocated Buffers and associated buffer pages */
 567     DFlush();
 568     if (afs_cold_shutdown) {
 569         dinit_flag = 0;
 570         tp = Buffers;
 571         for (i = 0; i < nbuffers; i += NPB, tp += NPB) {
 572             afs_osi_Free(tp->data, NPB * AFS_BUFFER_PAGESIZE);
 573         }
 574         afs_osi_Free(Buffers, nbuffers * sizeof(struct buffer));
 575         nbuffers = 0;
 576         timecounter = 1;
 577         for (i = 0; i < PHSIZE; i++)
 578             phTable[i] = 0;
 579         memset(&afs_bufferLock, 0, sizeof(afs_lock_t));
 580     }
 581 }