2 * Copyright 2000, International Business Machines Corporation and others.
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
10 #include <afsconfig.h>
11 #include "afs/param.h"
16 #include "afs/sysincludes.h" /* Standard vendor system headers */
17 #ifndef AFS_LINUX22_ENV
18 #include "rpc/types.h"
26 #endif /* AFS_ALPHA_ENV */
27 #include "afsincludes.h" /* Afs-based standard headers */
28 #include "afs/afs_stats.h" /* statistics */
30 /* memory cache routines */
31 static struct memCacheEntry *memCache;
32 static int memCacheBlkSize = 8192;
33 static int memMaxBlkNumber = 0;
34 static int memAllocMaySleep = 0;
36 extern int cacheDiskType;
39 afs_InitMemCache(int blkCount, int blkSize, int flags)
43 AFS_STATCNT(afs_InitMemCache);
45 memCacheBlkSize = blkSize;
47 memMaxBlkNumber = blkCount;
48 memCache = (struct memCacheEntry *)
49 afs_osi_Alloc(memMaxBlkNumber * sizeof(struct memCacheEntry));
50 if (flags & AFSCALL_INIT_MEMCACHE_SLEEP) {
54 for (index = 0; index < memMaxBlkNumber; index++) {
56 (memCache + index)->size = 0;
57 (memCache + index)->dataSize = memCacheBlkSize;
58 LOCK_INIT(&((memCache + index)->afs_memLock), "afs_memLock");
59 if (memAllocMaySleep) {
60 blk = afs_osi_Alloc(memCacheBlkSize);
62 blk = afs_osi_Alloc_NoSleep(memCacheBlkSize);
66 (memCache + index)->data = blk;
67 memset((memCache + index)->data, 0, memCacheBlkSize);
69 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS)
70 afs_InitDualFSCacheOps((struct vnode *)0);
76 printf("afsd: memCache allocation failure at %d KB.\n",
77 (index * memCacheBlkSize) / 1024);
78 while (--index >= 0) {
79 afs_osi_Free((memCache + index)->data, memCacheBlkSize);
80 (memCache + index)->data = NULL;
87 afs_MemCacheClose(struct osi_file *file)
92 #if defined(AFS_SUN57_64BIT_ENV) || defined(AFS_SGI62_ENV)
94 afs_MemCacheOpen(ino_t blkno)
97 afs_MemCacheOpen(afs_int32 blkno)
100 struct memCacheEntry *mep;
102 if (blkno < 0 || blkno > memMaxBlkNumber) {
103 osi_Panic("afs_MemCacheOpen: invalid block #");
105 mep = (memCache + blkno);
106 afs_Trace4(afs_iclSetp, CM_TRACE_MEMOPEN, ICL_TYPE_INT32, blkno,
107 ICL_TYPE_POINTER, mep, ICL_TYPE_POINTER, mep->data,
108 ICL_TYPE_STRING, mep->data);
113 * this routine simulates a read in the Memory Cache
116 afs_MemReadBlk(register struct osi_file *fP, int offset, void *dest,
119 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
122 MObtainReadLock(&mceP->afs_memLock);
123 AFS_STATCNT(afs_MemReadBlk);
125 MReleaseReadLock(&mceP->afs_memLock);
128 /* use min of bytes in buffer or requested size */
129 bytesRead = (size < mceP->size - offset) ? size : mceP->size - offset;
133 memcpy(dest, mceP->data + offset, bytesRead);
138 MReleaseReadLock(&mceP->afs_memLock);
143 * this routine simulates a readv in the Memory Cache
146 afs_MemReadvBlk(register struct memCacheEntry *mceP, int offset,
147 struct iovec *iov, int nio, int size)
153 MObtainReadLock(&mceP->afs_memLock);
154 AFS_STATCNT(afs_MemReadBlk);
156 MReleaseReadLock(&mceP->afs_memLock);
159 /* use min of bytes in buffer or requested size */
160 bytesRead = (size < mceP->size - offset) ? size : mceP->size - offset;
163 for (i = 0, size = bytesRead; i < nio && size > 0; i++) {
164 bytesToRead = (size < iov[i].iov_len) ? size : iov[i].iov_len;
166 memcpy(iov[i].iov_base, mceP->data + offset, bytesToRead);
168 offset += bytesToRead;
175 MReleaseReadLock(&mceP->afs_memLock);
180 afs_MemReadUIO(ino_t blkno, struct uio *uioP)
182 register struct memCacheEntry *mceP =
183 (struct memCacheEntry *)afs_MemCacheOpen(blkno);
184 int length = mceP->size - uioP->uio_offset;
187 AFS_STATCNT(afs_MemReadUIO);
188 MObtainReadLock(&mceP->afs_memLock);
189 length = (length < uioP->uio_resid) ? length : uioP->uio_resid;
190 AFS_UIOMOVE(mceP->data + uioP->uio_offset, length, UIO_READ, uioP, code);
191 MReleaseReadLock(&mceP->afs_memLock);
195 /*XXX: this extends a block arbitrarily to support big directories */
197 afs_MemWriteBlk(register struct osi_file *fP, int offset, void *src,
200 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
201 AFS_STATCNT(afs_MemWriteBlk);
202 MObtainWriteLock(&mceP->afs_memLock, 560);
203 if (size + offset > mceP->dataSize) {
204 char *oldData = mceP->data;
206 if (memAllocMaySleep) {
207 mceP->data = afs_osi_Alloc(size + offset);
209 mceP->data = afs_osi_Alloc_NoSleep(size + offset);
211 if (mceP->data == NULL) { /* no available memory */
212 mceP->data = oldData; /* revert back change that was made */
213 MReleaseWriteLock(&mceP->afs_memLock);
214 afs_warn("afs: afs_MemWriteBlk mem alloc failure (%d bytes)\n",
219 /* may overlap, but this is OK */
221 memcpy(mceP->data, oldData, mceP->size);
223 afs_osi_Free(oldData, mceP->dataSize);
224 mceP->dataSize = size + offset;
227 if (mceP->size < offset)
228 memset(mceP->data + mceP->size, 0, offset - mceP->size);
229 memcpy(mceP->data + offset, src, size);
231 mceP->size = (size + offset < mceP->size) ? mceP->size : size + offset;
233 MReleaseWriteLock(&mceP->afs_memLock);
237 /*XXX: this extends a block arbitrarily to support big directories */
239 afs_MemWritevBlk(register struct memCacheEntry *mceP, int offset,
240 struct iovec *iov, int nio, int size)
245 AFS_STATCNT(afs_MemWriteBlk);
246 MObtainWriteLock(&mceP->afs_memLock, 561);
247 if (offset + size > mceP->dataSize) {
248 char *oldData = mceP->data;
250 mceP->data = afs_osi_Alloc(size + offset);
252 /* may overlap, but this is OK */
254 memcpy(mceP->data, oldData, mceP->size);
256 afs_osi_Free(oldData, mceP->dataSize);
257 mceP->dataSize = size + offset;
260 if (mceP->size < offset)
261 memset(mceP->data + mceP->size, 0, offset - mceP->size);
262 for (bytesWritten = 0, i = 0; i < nio && size > 0; i++) {
263 bytesToWrite = (size < iov[i].iov_len) ? size : iov[i].iov_len;
264 memcpy(mceP->data + offset, iov[i].iov_base, bytesToWrite);
265 offset += bytesToWrite;
266 bytesWritten += bytesToWrite;
267 size -= bytesToWrite;
269 mceP->size = (offset < mceP->size) ? mceP->size : offset;
272 MReleaseWriteLock(&mceP->afs_memLock);
277 afs_MemWriteUIO(ino_t blkno, struct uio *uioP)
279 register struct memCacheEntry *mceP =
280 (struct memCacheEntry *)afs_MemCacheOpen(blkno);
283 AFS_STATCNT(afs_MemWriteUIO);
284 MObtainWriteLock(&mceP->afs_memLock, 312);
285 if (uioP->uio_resid + uioP->uio_offset > mceP->dataSize) {
286 char *oldData = mceP->data;
288 mceP->data = afs_osi_Alloc(uioP->uio_resid + uioP->uio_offset);
291 memcpy(mceP->data, oldData, mceP->size);
294 afs_osi_Free(oldData, mceP->dataSize);
295 mceP->dataSize = uioP->uio_resid + uioP->uio_offset;
297 if (mceP->size < uioP->uio_offset)
298 memset(mceP->data + mceP->size, 0,
299 (int)(uioP->uio_offset - mceP->size));
300 AFS_UIOMOVE(mceP->data + uioP->uio_offset, uioP->uio_resid, UIO_WRITE,
302 if (uioP->uio_offset > mceP->size)
303 mceP->size = uioP->uio_offset;
305 MReleaseWriteLock(&mceP->afs_memLock);
310 afs_MemCacheTruncate(register struct osi_file *fP, int size)
312 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
313 AFS_STATCNT(afs_MemCacheTruncate);
315 MObtainWriteLock(&mceP->afs_memLock, 313);
316 /* old directory entry; g.c. */
317 if (size == 0 && mceP->dataSize > memCacheBlkSize) {
318 afs_osi_Free(mceP->data, mceP->dataSize);
319 mceP->data = afs_osi_Alloc(memCacheBlkSize);
320 mceP->dataSize = memCacheBlkSize;
323 if (size < mceP->size)
326 MReleaseWriteLock(&mceP->afs_memLock);
331 afs_MemCacheStoreProc(register struct rx_call *acall,
332 register struct osi_file *fP,
333 register afs_int32 alen, struct vcache *avc,
334 int *shouldWake, afs_size_t * abytesToXferP,
335 afs_size_t * abytesXferredP)
337 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
339 register afs_int32 code;
342 struct iovec *tiov; /* no data copying with iovec */
343 int tnio; /* temp for iovec size */
345 AFS_STATCNT(afs_MemCacheStoreProc);
348 * In this case, alen is *always* the amount of data we'll be trying
351 *(abytesToXferP) = alen;
352 *(abytesXferredP) = 0;
353 #endif /* AFS_NOSTATS */
356 * We need to alloc the iovecs on the heap so that they are "pinned" rather than
357 * declare them on the stack - defect 11272
360 (struct iovec *)osi_AllocSmallSpace(sizeof(struct iovec) *
364 ("afs_MemCacheStoreProc: osi_AllocSmallSpace for iovecs returned NULL\n");
367 /* do this at a higher level now -- it's a parameter */
368 /* for now, only do 'continue from close' code if file fits in one
369 * chunk. Could clearly do better: if only one modified chunk
370 * then can still do this. can do this on *last* modified chunk */
371 tlen = avc->m.Length - 1; /* byte position of last byte we'll store */
373 if (AFS_CHUNK(tlen) != 0)
381 tlen = (alen > AFS_LRALLOCSIZ ? AFS_LRALLOCSIZ : alen);
383 code = rx_WritevAlloc(acall, tiov, &tnio, RX_MAXIOVECS, tlen);
386 osi_FreeSmallSpace(tiov);
390 code = afs_MemReadvBlk(mceP, offset, tiov, tnio, tlen);
392 osi_FreeSmallSpace(tiov);
396 code = rx_Writev(acall, tiov, tnio, tlen);
399 (*abytesXferredP) += code;
400 #endif /* AFS_NOSTATS */
402 osi_FreeSmallSpace(tiov);
407 /* if file has been locked on server, can allow store to continue */
408 if (shouldWake && *shouldWake && (rx_GetRemoteStatus(acall) & 1)) {
409 *shouldWake = 0; /* only do this once */
413 osi_FreeSmallSpace(tiov);
418 afs_MemCacheFetchProc(register struct rx_call *acall,
419 register struct osi_file *fP, afs_size_t abase,
420 struct dcache *adc, struct vcache *avc,
421 afs_size_t * abytesToXferP, afs_size_t * abytesXferredP,
422 afs_int32 lengthFound)
424 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
425 register afs_int32 code;
428 struct iovec *tiov; /* no data copying with iovec */
429 register int tlen, offset = 0;
430 int tnio; /* temp for iovec size */
432 AFS_STATCNT(afs_MemCacheFetchProc);
433 length = lengthFound;
434 afs_Trace4(afs_iclSetp, CM_TRACE_MEMFETCH, ICL_TYPE_POINTER, avc,
435 ICL_TYPE_POINTER, mceP, ICL_TYPE_OFFSET,
436 ICL_HANDLE_OFFSET(abase), ICL_TYPE_INT32, length);
438 (*abytesToXferP) = 0;
439 (*abytesXferredP) = 0;
440 #endif /* AFS_NOSTATS */
442 * We need to alloc the iovecs on the heap so that they are "pinned" rather than
443 * declare them on the stack - defect 11272
446 (struct iovec *)osi_AllocSmallSpace(sizeof(struct iovec) *
450 ("afs_MemCacheFetchProc: osi_AllocSmallSpace for iovecs returned NULL\n");
452 adc->validPos = abase;
456 code = rx_Read(acall, (char *)&length, sizeof(afs_int32));
457 length = ntohl(length);
459 if (code != sizeof(afs_int32)) {
460 code = rx_Error(acall);
461 osi_FreeSmallSpace(tiov);
462 return (code ? code : -1); /* try to return code, not -1 */
466 * The fetch protocol is extended for the AFS/DFS translator
467 * to allow multiple blocks of data, each with its own length,
468 * to be returned. As long as the top bit is set, there are more
471 * We do not do this for AFS file servers because they sometimes
472 * return large negative numbers as the transfer size.
474 if (avc->states & CForeign) {
475 moredata = length & 0x80000000;
476 length &= ~0x80000000;
481 (*abytesToXferP) += length;
482 #endif /* AFS_NOSTATS */
484 tlen = (length > AFS_LRALLOCSIZ ? AFS_LRALLOCSIZ : length);
486 code = rx_Readv(acall, tiov, &tnio, RX_MAXIOVECS, tlen);
489 (*abytesXferredP) += code;
490 #endif /* AFS_NOSTATS */
492 afs_Trace3(afs_iclSetp, CM_TRACE_FETCH64READ,
493 ICL_TYPE_POINTER, avc, ICL_TYPE_INT32, code,
494 ICL_TYPE_INT32, length);
495 osi_FreeSmallSpace(tiov);
499 afs_MemWritevBlk(mceP, offset, tiov, tnio, tlen);
503 adc->validPos = abase;
504 if (afs_osi_Wakeup(&adc->validPos) == 0)
505 afs_Trace4(afs_iclSetp, CM_TRACE_DCACHEWAKE, ICL_TYPE_STRING,
506 __FILE__, ICL_TYPE_INT32, __LINE__,
507 ICL_TYPE_POINTER, adc, ICL_TYPE_INT32,
511 /* max of two sizes */
512 osi_FreeSmallSpace(tiov);
518 shutdown_memcache(void)
522 if (cacheDiskType != AFS_FCACHE_TYPE_MEM)
524 memCacheBlkSize = 8192;
525 for (index = 0; index < memMaxBlkNumber; index++) {
526 LOCK_INIT(&((memCache + index)->afs_memLock), "afs_memLock");
527 afs_osi_Free((memCache + index)->data, (memCache + index)->dataSize);
529 afs_osi_Free((char *)memCache,
530 memMaxBlkNumber * sizeof(struct memCacheEntry));