src/afs/afs_memcache.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"    /* Standard vendor system headers */
  15 #ifndef AFS_LINUX22_ENV
  16 #include "rpc/types.h"
  17 #endif
  18 #include "afsincludes.h"        /* Afs-based standard headers */
  19 #include "afs/afs_stats.h"      /* statistics */
  20
  21 /* memory cache routines */
  22 static struct memCacheEntry *memCache;
  23 static int memCacheBlkSize = 8192;
  24 static int memMaxBlkNumber = 0;
  25
  26 extern int cacheDiskType;
  27
  28 int
  29 afs_InitMemCache(int blkCount, int blkSize, int flags)
  30 {
  31     int index;
  32
  33     AFS_STATCNT(afs_InitMemCache);
  34     if (blkSize)
  35         memCacheBlkSize = blkSize;
  36
  37     memMaxBlkNumber = blkCount;
  38     memCache =
  39         afs_osi_Alloc(memMaxBlkNumber * sizeof(struct memCacheEntry));
  40     osi_Assert(memCache != NULL);
  41
  42     for (index = 0; index < memMaxBlkNumber; index++) {
  43         char *blk;
  44         (memCache + index)->size = 0;
  45         (memCache + index)->dataSize = memCacheBlkSize;
  46         LOCK_INIT(&((memCache + index)->afs_memLock), "afs_memLock");
  47         blk = afs_osi_Alloc(memCacheBlkSize);
  48         if (blk == NULL)
  49             goto nomem;
  50         (memCache + index)->data = blk;
  51         memset((memCache + index)->data, 0, memCacheBlkSize);
  52     }
  53 #if defined(AFS_HAVE_VXFS)
  54     afs_InitDualFSCacheOps((struct vnode *)0);
  55 #endif
  56     for (index = 0; index < blkCount; index++)
  57         afs_InitCacheFile(NULL, 0);
  58     return 0;
  59
  60   nomem:
  61     afs_warn("afsd:  memCache allocation failure at %d KB.\n",
  62              (index * memCacheBlkSize) / 1024);
  63     while (--index >= 0) {
  64         afs_osi_Free((memCache + index)->data, memCacheBlkSize);
  65         (memCache + index)->data = NULL;
  66     }
  67     return ENOMEM;
  68
  69 }
  70
  71 int
  72 afs_MemCacheClose(struct osi_file *file)
  73 {
  74     return 0;
  75 }
  76
  77 void *
  78 afs_MemCacheOpen(afs_dcache_id_t *ainode)
  79 {
  80     struct memCacheEntry *mep;
  81
  82     if (ainode->mem < 0 || ainode->mem > memMaxBlkNumber) {
  83         osi_Panic("afs_MemCacheOpen: invalid block #");
  84     }
  85     mep = (memCache + ainode->mem);
  86     afs_Trace3(afs_iclSetp, CM_TRACE_MEMOPEN, ICL_TYPE_INT32, ainode->mem,
  87                ICL_TYPE_POINTER, mep, ICL_TYPE_POINTER, mep ? mep->data : 0);
  88     return (void *)mep;
  89 }
  90
  91 /*
  92  * this routine simulates a read in the Memory Cache
  93  */
  94 int
  95 afs_MemReadBlk(struct osi_file *fP, int offset, void *dest,
  96                int size)
  97 {
  98     struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
  99     int bytesRead;
 100
 101     ObtainReadLock(&mceP->afs_memLock);
 102     AFS_STATCNT(afs_MemReadBlk);
 103     if (offset < 0) {
 104         ReleaseReadLock(&mceP->afs_memLock);
 105         return 0;
 106     }
 107     /* use min of bytes in buffer or requested size */
 108     bytesRead = (size < mceP->size - offset) ? size : mceP->size - offset;
 109
 110     if (bytesRead > 0) {
 111         AFS_GUNLOCK();
 112         memcpy(dest, mceP->data + offset, bytesRead);
 113         AFS_GLOCK();
 114     } else
 115         bytesRead = 0;
 116
 117     ReleaseReadLock(&mceP->afs_memLock);
 118     return bytesRead;
 119 }
 120
 121 /*
 122  * this routine simulates a readv in the Memory Cache
 123  */
 124 int
 125 afs_MemReadvBlk(struct memCacheEntry *mceP, int offset,
 126                 struct iovec *iov, int nio, int size)
 127 {
 128     int i;
 129     int bytesRead;
 130     int bytesToRead;
 131
 132     ObtainReadLock(&mceP->afs_memLock);
 133     AFS_STATCNT(afs_MemReadBlk);
 134     if (offset < 0) {
 135         ReleaseReadLock(&mceP->afs_memLock);
 136         return 0;
 137     }
 138     /* use min of bytes in buffer or requested size */
 139     bytesRead = (size < mceP->size - offset) ? size : mceP->size - offset;
 140
 141     if (bytesRead > 0) {
 142         for (i = 0, size = bytesRead; i < nio && size > 0; i++) {
 143             bytesToRead = (size < iov[i].iov_len) ? size : iov[i].iov_len;
 144             AFS_GUNLOCK();
 145             memcpy(iov[i].iov_base, mceP->data + offset, bytesToRead);
 146             AFS_GLOCK();
 147             offset += bytesToRead;
 148             size -= bytesToRead;
 149         }
 150         bytesRead -= size;
 151     } else
 152         bytesRead = 0;
 153
 154     ReleaseReadLock(&mceP->afs_memLock);
 155     return bytesRead;
 156 }
 157
 158 int
 159 afs_MemReadUIO(afs_dcache_id_t *ainode, struct uio *uioP)
 160 {
 161     struct memCacheEntry *mceP =
 162         (struct memCacheEntry *)afs_MemCacheOpen(ainode);
 163     int length = mceP->size - AFS_UIO_OFFSET(uioP);
 164     afs_int32 code;
 165
 166     AFS_STATCNT(afs_MemReadUIO);
 167     ObtainReadLock(&mceP->afs_memLock);
 168     length = (length < AFS_UIO_RESID(uioP)) ? length : AFS_UIO_RESID(uioP);
 169     AFS_UIOMOVE(mceP->data + AFS_UIO_OFFSET(uioP), length, UIO_READ, uioP, code);
 170     ReleaseReadLock(&mceP->afs_memLock);
 171     return code;
 172 }
 173
 174 int
 175 afs_MemWriteBlk(struct osi_file *fP, int offset, void *src,
 176                 int size)
 177 {
 178     struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
 179     struct iovec tiov;
 180
 181     tiov.iov_base = src;
 182     tiov.iov_len = size;
 183     return afs_MemWritevBlk(mceP, offset, &tiov, 1, size);
 184 }
 185
 186 /*XXX: this extends a block arbitrarily to support big directories */
 187 int
 188 afs_MemWritevBlk(struct memCacheEntry *mceP, int offset,
 189                  struct iovec *iov, int nio, int size)
 190 {
 191     int i;
 192     int bytesWritten;
 193     int bytesToWrite;
 194     AFS_STATCNT(afs_MemWriteBlk);
 195     ObtainWriteLock(&mceP->afs_memLock, 561);
 196     if (offset + size > mceP->dataSize) {
 197         char *oldData = mceP->data;
 198
 199         mceP->data = afs_osi_Alloc(size + offset);
 200         if (mceP->data == NULL) {       /* no available memory */
 201             mceP->data = oldData;       /* revert back change that was made */
 202             ReleaseWriteLock(&mceP->afs_memLock);
 203             afs_warn("afs: afs_MemWriteBlk mem alloc failure (%d bytes)\n",
 204                      size + offset);
 205             return -ENOMEM;
 206         }
 207
 208         /* may overlap, but this is OK */
 209         AFS_GUNLOCK();
 210         memcpy(mceP->data, oldData, mceP->size);
 211         AFS_GLOCK();
 212         afs_osi_Free(oldData, mceP->dataSize);
 213         mceP->dataSize = size + offset;
 214     }
 215     AFS_GUNLOCK();
 216     if (mceP->size < offset)
 217         memset(mceP->data + mceP->size, 0, offset - mceP->size);
 218     for (bytesWritten = 0, i = 0; i < nio && size > 0; i++) {
 219         bytesToWrite = (size < iov[i].iov_len) ? size : iov[i].iov_len;
 220         memcpy(mceP->data + offset, iov[i].iov_base, bytesToWrite);
 221         offset += bytesToWrite;
 222         bytesWritten += bytesToWrite;
 223         size -= bytesToWrite;
 224     }
 225     mceP->size = (offset < mceP->size) ? mceP->size : offset;
 226     AFS_GLOCK();
 227
 228     ReleaseWriteLock(&mceP->afs_memLock);
 229     return bytesWritten;
 230 }
 231
 232 int
 233 afs_MemWriteUIO(struct vcache *avc, afs_dcache_id_t *ainode, struct uio *uioP)
 234 {
 235     struct memCacheEntry *mceP =
 236         (struct memCacheEntry *)afs_MemCacheOpen(ainode);
 237     afs_int32 code;
 238
 239     AFS_STATCNT(afs_MemWriteUIO);
 240     ObtainWriteLock(&mceP->afs_memLock, 312);
 241     if (AFS_UIO_RESID(uioP) + AFS_UIO_OFFSET(uioP) > mceP->dataSize) {
 242         char *oldData = mceP->data;
 243
 244         mceP->data = afs_osi_Alloc(AFS_UIO_RESID(uioP) + AFS_UIO_OFFSET(uioP));
 245         if (mceP->data == NULL) {       /* no available memory */
 246             mceP->data = oldData;       /* revert back change that was made */
 247             ReleaseWriteLock(&mceP->afs_memLock);
 248             afs_warn("afs: afs_MemWriteBlk mem alloc failure (%ld bytes)\n",
 249                      (long)(AFS_UIO_RESID(uioP) + AFS_UIO_OFFSET(uioP)));
 250             return -ENOMEM;
 251         }
 252
 253         AFS_GUNLOCK();
 254         memcpy(mceP->data, oldData, mceP->size);
 255         AFS_GLOCK();
 256
 257         afs_osi_Free(oldData, mceP->dataSize);
 258         mceP->dataSize = AFS_UIO_RESID(uioP) + AFS_UIO_OFFSET(uioP);
 259     }
 260     if (mceP->size < AFS_UIO_OFFSET(uioP))
 261         memset(mceP->data + mceP->size, 0,
 262                (int)(AFS_UIO_OFFSET(uioP) - mceP->size));
 263     AFS_UIOMOVE(mceP->data + AFS_UIO_OFFSET(uioP), AFS_UIO_RESID(uioP), UIO_WRITE,
 264                 uioP, code);
 265     if (AFS_UIO_OFFSET(uioP) > mceP->size)
 266         mceP->size = AFS_UIO_OFFSET(uioP);
 267
 268     ReleaseWriteLock(&mceP->afs_memLock);
 269     return code;
 270 }
 271
 272 int
 273 afs_MemCacheTruncate(struct osi_file *fP, int size)
 274 {
 275     struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
 276     AFS_STATCNT(afs_MemCacheTruncate);
 277
 278     ObtainWriteLock(&mceP->afs_memLock, 313);
 279     /* old directory entry; g.c. */
 280     if (size == 0 && mceP->dataSize > memCacheBlkSize) {
 281         char *oldData = mceP->data;
 282         mceP->data = afs_osi_Alloc(memCacheBlkSize);
 283         if (mceP->data == NULL) {       /* no available memory */
 284             mceP->data = oldData;
 285             ReleaseWriteLock(&mceP->afs_memLock);
 286             afs_warn("afs: afs_MemWriteBlk mem alloc failure (%d bytes)\n",
 287                      memCacheBlkSize);
 288         } else {
 289             afs_osi_Free(oldData, mceP->dataSize);
 290             mceP->dataSize = memCacheBlkSize;
 291         }
 292     }
 293
 294     if (size < mceP->size)
 295         mceP->size = size;
 296
 297     ReleaseWriteLock(&mceP->afs_memLock);
 298     return 0;
 299 }
 300
 301
 302 void
 303 shutdown_memcache(void)
 304 {
 305     int index;
 306
 307     if (cacheDiskType != AFS_FCACHE_TYPE_MEM)
 308         return;
 309     memCacheBlkSize = 8192;
 310     for (index = 0; index < memMaxBlkNumber; index++) {
 311         LOCK_INIT(&((memCache + index)->afs_memLock), "afs_memLock");
 312         afs_osi_Free((memCache + index)->data, (memCache + index)->dataSize);
 313     }
 314     afs_osi_Free((char *)memCache,
 315                  memMaxBlkNumber * sizeof(struct memCacheEntry));
 316     memMaxBlkNumber = 0;
 317 }