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"
14 #include "afs/sysincludes.h" /* Standard vendor system headers */
15 #ifndef AFS_LINUX22_ENV
16 #include "rpc/types.h"
24 #endif /* AFS_OSF_ENV */
25 #include "afsincludes.h" /* Afs-based standard headers */
26 #include "afs/afs_stats.h" /* statistics */
28 /* memory cache routines */
29 static struct memCacheEntry *memCache;
30 static int memCacheBlkSize = 8192;
31 static int memMaxBlkNumber = 0;
32 static int memAllocMaySleep = 0;
34 extern int cacheDiskType;
37 afs_InitMemCache(int blkCount, int blkSize, int flags)
41 AFS_STATCNT(afs_InitMemCache);
43 memCacheBlkSize = blkSize;
45 memMaxBlkNumber = blkCount;
46 memCache = (struct memCacheEntry *)
47 afs_osi_Alloc(memMaxBlkNumber * sizeof(struct memCacheEntry));
48 if (flags & AFSCALL_INIT_MEMCACHE_SLEEP) {
52 for (index = 0; index < memMaxBlkNumber; index++) {
54 (memCache + index)->size = 0;
55 (memCache + index)->dataSize = memCacheBlkSize;
56 LOCK_INIT(&((memCache + index)->afs_memLock), "afs_memLock");
57 if (memAllocMaySleep) {
58 blk = afs_osi_Alloc(memCacheBlkSize);
60 blk = afs_osi_Alloc_NoSleep(memCacheBlkSize);
64 (memCache + index)->data = blk;
65 memset((memCache + index)->data, 0, memCacheBlkSize);
67 #if defined(AFS_SGI62_ENV) || defined(AFS_HAVE_VXFS)
68 afs_InitDualFSCacheOps((struct vnode *)0);
74 printf("afsd: memCache allocation failure at %d KB.\n",
75 (index * memCacheBlkSize) / 1024);
76 while (--index >= 0) {
77 afs_osi_Free((memCache + index)->data, memCacheBlkSize);
78 (memCache + index)->data = NULL;
85 afs_MemCacheClose(struct osi_file *file)
91 afs_MemCacheOpen(afs_dcache_id_t *ainode)
93 struct memCacheEntry *mep;
95 if (ainode->mem < 0 || ainode->mem > memMaxBlkNumber) {
96 osi_Panic("afs_MemCacheOpen: invalid block #");
98 mep = (memCache + ainode->mem);
99 afs_Trace3(afs_iclSetp, CM_TRACE_MEMOPEN, ICL_TYPE_INT32, ainode->mem,
100 ICL_TYPE_POINTER, mep, ICL_TYPE_POINTER, mep ? mep->data : 0);
105 * this routine simulates a read in the Memory Cache
108 afs_MemReadBlk(register struct osi_file *fP, int offset, void *dest,
111 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
114 MObtainReadLock(&mceP->afs_memLock);
115 AFS_STATCNT(afs_MemReadBlk);
117 MReleaseReadLock(&mceP->afs_memLock);
120 /* use min of bytes in buffer or requested size */
121 bytesRead = (size < mceP->size - offset) ? size : mceP->size - offset;
125 memcpy(dest, mceP->data + offset, bytesRead);
130 MReleaseReadLock(&mceP->afs_memLock);
135 * this routine simulates a readv in the Memory Cache
138 afs_MemReadvBlk(register struct memCacheEntry *mceP, int offset,
139 struct iovec *iov, int nio, int size)
145 MObtainReadLock(&mceP->afs_memLock);
146 AFS_STATCNT(afs_MemReadBlk);
148 MReleaseReadLock(&mceP->afs_memLock);
151 /* use min of bytes in buffer or requested size */
152 bytesRead = (size < mceP->size - offset) ? size : mceP->size - offset;
155 for (i = 0, size = bytesRead; i < nio && size > 0; i++) {
156 bytesToRead = (size < iov[i].iov_len) ? size : iov[i].iov_len;
158 memcpy(iov[i].iov_base, mceP->data + offset, bytesToRead);
160 offset += bytesToRead;
167 MReleaseReadLock(&mceP->afs_memLock);
172 afs_MemReadUIO(afs_dcache_id_t *ainode, struct uio *uioP)
174 register struct memCacheEntry *mceP =
175 (struct memCacheEntry *)afs_MemCacheOpen(ainode);
176 int length = mceP->size - AFS_UIO_OFFSET(uioP);
179 AFS_STATCNT(afs_MemReadUIO);
180 MObtainReadLock(&mceP->afs_memLock);
181 length = (length < AFS_UIO_RESID(uioP)) ? length : AFS_UIO_RESID(uioP);
182 AFS_UIOMOVE(mceP->data + AFS_UIO_OFFSET(uioP), length, UIO_READ, uioP, code);
183 MReleaseReadLock(&mceP->afs_memLock);
187 /*XXX: this extends a block arbitrarily to support big directories */
189 afs_MemWriteBlk(register struct osi_file *fP, int offset, void *src,
192 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
193 AFS_STATCNT(afs_MemWriteBlk);
194 MObtainWriteLock(&mceP->afs_memLock, 560);
195 if (size + offset > mceP->dataSize) {
196 char *oldData = mceP->data;
198 if (memAllocMaySleep) {
199 mceP->data = afs_osi_Alloc(size + offset);
201 mceP->data = afs_osi_Alloc_NoSleep(size + offset);
203 if (mceP->data == NULL) { /* no available memory */
204 mceP->data = oldData; /* revert back change that was made */
205 MReleaseWriteLock(&mceP->afs_memLock);
206 afs_warn("afs: afs_MemWriteBlk mem alloc failure (%d bytes)\n",
211 /* may overlap, but this is OK */
213 memcpy(mceP->data, oldData, mceP->size);
215 afs_osi_Free(oldData, mceP->dataSize);
216 mceP->dataSize = size + offset;
219 if (mceP->size < offset)
220 memset(mceP->data + mceP->size, 0, offset - mceP->size);
221 memcpy(mceP->data + offset, src, size);
223 mceP->size = (size + offset < mceP->size) ? mceP->size : size + offset;
225 MReleaseWriteLock(&mceP->afs_memLock);
229 /*XXX: this extends a block arbitrarily to support big directories */
231 afs_MemWritevBlk(register struct memCacheEntry *mceP, int offset,
232 struct iovec *iov, int nio, int size)
237 AFS_STATCNT(afs_MemWriteBlk);
238 MObtainWriteLock(&mceP->afs_memLock, 561);
239 if (offset + size > mceP->dataSize) {
240 char *oldData = mceP->data;
242 mceP->data = afs_osi_Alloc(size + offset);
243 if (mceP->data == NULL) { /* no available memory */
244 mceP->data = oldData; /* revert back change that was made */
245 MReleaseWriteLock(&mceP->afs_memLock);
246 afs_warn("afs: afs_MemWriteBlk mem alloc failure (%d bytes)\n",
251 /* may overlap, but this is OK */
253 memcpy(mceP->data, oldData, mceP->size);
255 afs_osi_Free(oldData, mceP->dataSize);
256 mceP->dataSize = size + offset;
259 if (mceP->size < offset)
260 memset(mceP->data + mceP->size, 0, offset - mceP->size);
261 for (bytesWritten = 0, i = 0; i < nio && size > 0; i++) {
262 bytesToWrite = (size < iov[i].iov_len) ? size : iov[i].iov_len;
263 memcpy(mceP->data + offset, iov[i].iov_base, bytesToWrite);
264 offset += bytesToWrite;
265 bytesWritten += bytesToWrite;
266 size -= bytesToWrite;
268 mceP->size = (offset < mceP->size) ? mceP->size : offset;
271 MReleaseWriteLock(&mceP->afs_memLock);
276 afs_MemWriteUIO(afs_dcache_id_t *ainode, struct uio *uioP)
278 register struct memCacheEntry *mceP =
279 (struct memCacheEntry *)afs_MemCacheOpen(ainode);
282 AFS_STATCNT(afs_MemWriteUIO);
283 MObtainWriteLock(&mceP->afs_memLock, 312);
284 if (AFS_UIO_RESID(uioP) + AFS_UIO_OFFSET(uioP) > mceP->dataSize) {
285 char *oldData = mceP->data;
287 mceP->data = afs_osi_Alloc(AFS_UIO_RESID(uioP) + AFS_UIO_OFFSET(uioP));
288 if (mceP->data == NULL) { /* no available memory */
289 mceP->data = oldData; /* revert back change that was made */
290 MReleaseWriteLock(&mceP->afs_memLock);
291 afs_warn("afs: afs_MemWriteBlk mem alloc failure (%d bytes)\n",
292 AFS_UIO_RESID(uioP) + AFS_UIO_OFFSET(uioP));
297 memcpy(mceP->data, oldData, mceP->size);
300 afs_osi_Free(oldData, mceP->dataSize);
301 mceP->dataSize = AFS_UIO_RESID(uioP) + AFS_UIO_OFFSET(uioP);
303 if (mceP->size < AFS_UIO_OFFSET(uioP))
304 memset(mceP->data + mceP->size, 0,
305 (int)(AFS_UIO_OFFSET(uioP) - mceP->size));
306 AFS_UIOMOVE(mceP->data + AFS_UIO_OFFSET(uioP), AFS_UIO_RESID(uioP), UIO_WRITE,
308 if (AFS_UIO_OFFSET(uioP) > mceP->size)
309 mceP->size = AFS_UIO_OFFSET(uioP);
311 MReleaseWriteLock(&mceP->afs_memLock);
316 afs_MemCacheTruncate(register struct osi_file *fP, int size)
318 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
319 AFS_STATCNT(afs_MemCacheTruncate);
321 MObtainWriteLock(&mceP->afs_memLock, 313);
322 /* old directory entry; g.c. */
323 if (size == 0 && mceP->dataSize > memCacheBlkSize) {
324 char *oldData = mceP->data;
325 mceP->data = afs_osi_Alloc(memCacheBlkSize);
326 if (mceP->data == NULL) { /* no available memory */
327 mceP->data = oldData;
328 MReleaseWriteLock(&mceP->afs_memLock);
329 afs_warn("afs: afs_MemWriteBlk mem alloc failure (%d bytes)\n",
332 afs_osi_Free(oldData, mceP->dataSize);
333 mceP->dataSize = memCacheBlkSize;
337 if (size < mceP->size)
340 MReleaseWriteLock(&mceP->afs_memLock);
345 afs_MemCacheStoreProc(register struct rx_call *acall,
346 register struct osi_file *fP,
347 register afs_int32 alen, struct vcache *avc,
348 int *shouldWake, afs_size_t * abytesToXferP,
349 afs_size_t * abytesXferredP)
351 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
353 register afs_int32 code;
356 struct iovec *tiov; /* no data copying with iovec */
357 int tnio; /* temp for iovec size */
359 AFS_STATCNT(afs_MemCacheStoreProc);
362 * In this case, alen is *always* the amount of data we'll be trying
365 *(abytesToXferP) = alen;
366 *(abytesXferredP) = 0;
367 #endif /* AFS_NOSTATS */
370 * We need to alloc the iovecs on the heap so that they are "pinned" rather than
371 * declare them on the stack - defect 11272
374 (struct iovec *)osi_AllocSmallSpace(sizeof(struct iovec) *
378 ("afs_MemCacheStoreProc: osi_AllocSmallSpace for iovecs returned NULL\n");
381 /* do this at a higher level now -- it's a parameter */
382 /* for now, only do 'continue from close' code if file fits in one
383 * chunk. Could clearly do better: if only one modified chunk
384 * then can still do this. can do this on *last* modified chunk */
385 tlen = avc->f.m.Length - 1; /* byte position of last byte we'll store */
387 if (AFS_CHUNK(tlen) != 0)
395 tlen = (alen > AFS_LRALLOCSIZ ? AFS_LRALLOCSIZ : alen);
397 code = rx_WritevAlloc(acall, tiov, &tnio, RX_MAXIOVECS, tlen);
400 code = rx_Error(acall);
401 osi_FreeSmallSpace(tiov);
402 return code ? code : -33;
405 code = afs_MemReadvBlk(mceP, offset, tiov, tnio, tlen);
407 osi_FreeSmallSpace(tiov);
411 code = rx_Writev(acall, tiov, tnio, tlen);
414 (*abytesXferredP) += code;
415 #endif /* AFS_NOSTATS */
417 code = rx_Error(acall);
418 osi_FreeSmallSpace(tiov);
419 return code ? code : -33;
423 /* if file has been locked on server, can allow store to continue */
424 if (shouldWake && *shouldWake && (rx_GetRemoteStatus(acall) & 1)) {
425 *shouldWake = 0; /* only do this once */
429 osi_FreeSmallSpace(tiov);
434 afs_MemCacheFetchProc(register struct rx_call *acall,
435 register struct osi_file *fP, afs_size_t abase,
436 struct dcache *adc, struct vcache *avc,
437 afs_size_t * abytesToXferP, afs_size_t * abytesXferredP,
438 afs_int32 lengthFound)
440 register struct memCacheEntry *mceP = (struct memCacheEntry *)fP;
441 register afs_int32 code;
444 struct iovec *tiov; /* no data copying with iovec */
445 register int tlen, offset = 0;
446 int tnio; /* temp for iovec size */
448 AFS_STATCNT(afs_MemCacheFetchProc);
449 length = lengthFound;
450 afs_Trace4(afs_iclSetp, CM_TRACE_MEMFETCH, ICL_TYPE_POINTER, avc,
451 ICL_TYPE_POINTER, mceP, ICL_TYPE_OFFSET,
452 ICL_HANDLE_OFFSET(abase), ICL_TYPE_INT32, length);
454 (*abytesToXferP) = 0;
455 (*abytesXferredP) = 0;
456 #endif /* AFS_NOSTATS */
458 * We need to alloc the iovecs on the heap so that they are "pinned" rather than
459 * declare them on the stack - defect 11272
462 (struct iovec *)osi_AllocSmallSpace(sizeof(struct iovec) *
466 ("afs_MemCacheFetchProc: osi_AllocSmallSpace for iovecs returned NULL\n");
468 adc->validPos = abase;
472 code = rx_Read(acall, (char *)&length, sizeof(afs_int32));
473 length = ntohl(length);
475 if (code != sizeof(afs_int32)) {
476 code = rx_Error(acall);
477 osi_FreeSmallSpace(tiov);
478 return (code ? code : -1); /* try to return code, not -1 */
482 * The fetch protocol is extended for the AFS/DFS translator
483 * to allow multiple blocks of data, each with its own length,
484 * to be returned. As long as the top bit is set, there are more
487 * We do not do this for AFS file servers because they sometimes
488 * return large negative numbers as the transfer size.
490 if (avc->f.states & CForeign) {
491 moredata = length & 0x80000000;
492 length &= ~0x80000000;
497 (*abytesToXferP) += length;
498 #endif /* AFS_NOSTATS */
500 tlen = (length > AFS_LRALLOCSIZ ? AFS_LRALLOCSIZ : length);
502 code = rx_Readv(acall, tiov, &tnio, RX_MAXIOVECS, tlen);
505 (*abytesXferredP) += code;
506 #endif /* AFS_NOSTATS */
508 afs_Trace3(afs_iclSetp, CM_TRACE_FETCH64READ,
509 ICL_TYPE_POINTER, avc, ICL_TYPE_INT32, code,
510 ICL_TYPE_INT32, length);
511 osi_FreeSmallSpace(tiov);
515 afs_MemWritevBlk(mceP, offset, tiov, tnio, tlen);
519 adc->validPos = abase;
520 if (afs_osi_Wakeup(&adc->validPos) == 0)
521 afs_Trace4(afs_iclSetp, CM_TRACE_DCACHEWAKE, ICL_TYPE_STRING,
522 __FILE__, ICL_TYPE_INT32, __LINE__,
523 ICL_TYPE_POINTER, adc, ICL_TYPE_INT32,
527 /* max of two sizes */
528 osi_FreeSmallSpace(tiov);
534 shutdown_memcache(void)
538 if (cacheDiskType != AFS_FCACHE_TYPE_MEM)
540 memCacheBlkSize = 8192;
541 for (index = 0; index < memMaxBlkNumber; index++) {
542 LOCK_INIT(&((memCache + index)->afs_memLock), "afs_memLock");
543 afs_osi_Free((memCache + index)->data, (memCache + index)->dataSize);
545 afs_osi_Free((char *)memCache,
546 memMaxBlkNumber * sizeof(struct memCacheEntry));