-/*
- * Copyright (C) 1998, 1989 Transarc Corporation - All rights reserved
- *
- * (C) COPYRIGHT IBM CORPORATION 1987, 1988
- * LICENSED MATERIALS - PROPERTY OF IBM
- *
- *
+/*
+ * Copyright 2000, International Business Machines Corporation and others.
+ * All Rights Reserved.
+ *
+ * This software has been released under the terms of the IBM Public
+ * License. For details, see the LICENSE file in the top-level source
+ * directory or online at http://www.openafs.org/dl/license10.html
*/
/* Copyright (C) 1994 Cazamar Systems, Inc. */
#define _BUF_H__ENV_ 1
#include <osi.h>
+#ifdef DISKCACHE95
+#include "cm_diskcache.h"
+#endif /* DISKCACHE95 */
/* default # of buffers if not changed */
#define CM_BUF_BUFFERS 100
-extern long buf_nbuffers;
-
-/* orig # of buffers */
-extern long buf_nOrigBuffers;
/* default buffer size */
-#define CM_BUF_SIZE 4096
-extern long buf_bufferSize;
+#define CM_BUF_BLOCKSIZE CM_CONFIGDEFAULT_BLOCKSIZE
/* default hash size */
#define CM_BUF_HASHSIZE 1024
-extern long buf_hashSize;
+
+/* cache type */
+#define CM_BUF_CACHETYPE_FILE 1
+#define CM_BUF_CACHETYPE_VIRTUAL 2
+extern int buf_cacheType;
/* force it to be signed so that mod comes out positive or 0 */
#define BUF_HASH(fidp,offsetp) ((((fidp)->vnode+((fidp)->unique << 5) \
+(fidp)->volume+(fidp)->cell \
- +((offsetp)->LowPart / buf_bufferSize)) \
+ +((offsetp)->LowPart / cm_data.buf_blockSize)) \
& 0x7fffffff) \
- % buf_hashSize)
+ % cm_data.buf_hashSize)
/* another hash fn */
#define BUF_FILEHASH(fidp) ((((fidp)->vnode+((fidp)->unique << 5) \
+(fidp)->volume+(fidp)->cell) \
& 0x7fffffff) \
- % buf_hashSize)
+ % cm_data.buf_hashSize)
/* backup over pointer to the buffer */
#define BUF_OVERTOBUF(op) ((cm_buf_t *)(((char *)op) - ((long)(&((cm_buf_t *)0)->over))))
-/* pretend we have logs, too */
-typedef char cm_log_t;
+#define CM_BUF_MAGIC ('B' | 'U' <<8 | 'F'<<16 | 'F'<<24)
/* represents a single buffer */
typedef struct cm_buf {
- osi_queue_t q; /* queue of all zero-refcount buffers */
- struct cm_buf *hashp; /* hash bucket pointer */
- struct cm_buf *fileHashp; /* file hash bucket pointer */
- struct cm_buf *fileHashBackp; /* file hash bucket back pointer */
+ osi_queue_t q; /* queue of all zero-refcount buffers */
+ afs_uint32 magic;
+ struct cm_buf *allp; /* next in all list */
+ struct cm_buf *hashp; /* hash bucket pointer */
+ struct cm_buf *fileHashp; /* file hash bucket pointer */
+ struct cm_buf *fileHashBackp; /* file hash bucket back pointer */
/*
* The file hash chain is doubly linked, since
* these chains can get rather long. The
* hash function is good and if there are
* enough buckets for the size of the cache.
*/
- struct cm_buf *allp; /* next in all list */
- osi_mutex_t mx; /* mutex protecting structure except refcount */
- int refCount; /* reference count */
- long idCounter; /* counter for softrefs; bumped at each recycle */
- long dirtyCounter; /* bumped at each dirty->clean transition */
-#ifdef notdef
- struct cm_log *logp; /* log for this buffer, if any */
- osi_hyper_t lsn; /* lsn to force to (last LSN changing this buffer) */
-#endif /* notdef */
- osi_hyper_t offset; /* offset */
- cm_fid_t fid; /* file ID */
- long flags; /* flags we're using */
- long size; /* size in bytes of this buffer */
- char *datap; /* data in this buffer */
- unsigned long error; /* last error code, if CM_BUF_ERROR is set */
- struct cm_user *userp; /* user who wrote to the buffer last */
- OVERLAPPED over; /* overlapped structure for I/O */
+ struct cm_buf *dirtyp; /* next in the dirty list */
+ osi_mutex_t mx; /* mutex protecting structure except refcount */
+ unsigned long refCount; /* reference count (buf_globalLock) */
+ long idCounter; /* counter for softrefs; bumped at each recycle */
+ long dirtyCounter; /* bumped at each dirty->clean transition */
+ osi_hyper_t offset; /* offset */
+ cm_fid_t fid; /* file ID */
+ long flags; /* flags we're using */
+ char *datap; /* data in this buffer */
+ unsigned long error; /* last error code, if CM_BUF_ERROR is set */
+ cm_user_t *userp; /* user who wrote to the buffer last */
- /* fields added for the CM; locked by scp->mx */
- long dataVersion; /* data version of this page */
- long cmFlags; /* flags for cm */
+ /* fields added for the CM; locked by scp->mx */
+ afs_uint64 dataVersion; /* data version of this page */
+ afs_uint32 cmFlags; /* flags for cm */
+
+ /* syncop state */
+ afs_uint32 waitCount; /* number of threads waiting */
+ afs_uint32 waitRequests; /* num of thread wait requests */
+
+ afs_uint32 dirty_offset; /* offset from beginning of buffer containing dirty bytes */
+ afs_uint32 dirty_length; /* number of dirty bytes within the buffer */
+
+#ifdef DISKCACHE95
+ cm_diskcache_t *dcp; /* diskcache structure */
+#endif /* DISKCACHE95 */
+#ifdef DEBUG
+ cm_scache_t *scp; /* for debugging, the scache object belonging to */
+ /* the fid at the time of fid assignment. */
+#else
+ void * dummy;
+#endif
} cm_buf_t;
/* values for cmFlags */
#define CM_BUF_CMFETCHING 1 /* fetching this buffer */
#define CM_BUF_CMSTORING 2 /* storing this buffer */
#define CM_BUF_CMFULLYFETCHED 4 /* read-while-fetching optimization */
-/* waiting is done based on scp->flags */
+#define CM_BUF_CMWRITING 8 /* writing to this buffer */
+/* waiting is done based on scp->flags. Removing bits from cmFlags
+ should be followed by waking the scp. */
/* represents soft reference which is OK to lose on a recycle */
typedef struct cm_softRef {
- cm_buf_t *bufp; /* buffer (may get reused) */
- long counter; /* counter of changes to identity */
+ cm_buf_t *bufp; /* buffer (may get reused) */
+ long counter; /* counter of changes to identity */
} cm_softRef_t;
-#define CM_BUF_READING 1 /* now reading buffer to the disk */
+#define CM_BUF_READING 1 /* now reading buffer from the disk */
#define CM_BUF_WRITING 2 /* now writing buffer to the disk */
#define CM_BUF_INHASH 4 /* in the hash table */
#define CM_BUF_DIRTY 8 /* buffer is dirty */
#define CM_BUF_EOF 0x100 /* read 0 bytes; used for detecting EOF */
typedef struct cm_buf_ops {
- long (*Writep)(void *, osi_hyper_t *, long, long, struct cm_user *,
+ long (*Writep)(void *, osi_hyper_t *, long, long, struct cm_user *,
struct cm_req *);
- long (*Readp)(cm_buf_t *, long, long *, struct cm_user *);
- long (*Stabilizep)(void *, struct cm_user *, struct cm_req *);
- long (*Unstabilizep)(void *, struct cm_user *);
+ long (*Readp)(cm_buf_t *, long, long *, struct cm_user *);
+ long (*Stabilizep)(void *, struct cm_user *, struct cm_req *);
+ long (*Unstabilizep)(void *, struct cm_user *);
} cm_buf_ops_t;
/* global locks */
extern osi_rwlock_t buf_globalLock;
-/* buffer free list */
-extern cm_buf_t *buf_freeListp;
-
-/* pointer to hash table */
-extern cm_buf_t **buf_hashTablepp;
-
-/* another hash table */
-extern cm_buf_t **buf_fileHashTablepp;
+extern long buf_Init(int newFile, cm_buf_ops_t *, afs_uint64 nbuffers);
-extern long buf_Init(cm_buf_ops_t *);
+extern void buf_Shutdown(void);
extern long buf_CountFreeList(void);
extern void buf_Hold(cm_buf_t *);
-extern void buf_WaitIO(cm_buf_t *);
+extern void buf_WaitIO(cm_scache_t *, cm_buf_t *);
-extern void buf_LockedRelease(cm_buf_t *);
+extern void buf_ReleaseLocked(cm_buf_t *);
-extern cm_buf_t *buf_LockedFind(struct cm_scache *, osi_hyper_t *);
+extern void buf_HoldLocked(cm_buf_t *);
-extern cm_buf_t *buf_Find(struct cm_scache *, osi_hyper_t *);
-
-extern HANDLE buf_GetFileHandle(long);
+extern cm_buf_t *buf_FindLocked(struct cm_scache *, osi_hyper_t *);
-extern void buf_LockedCleanAsync(cm_buf_t *, cm_req_t *);
+extern cm_buf_t *buf_Find(struct cm_scache *, osi_hyper_t *);
extern long buf_GetNewLocked(struct cm_scache *, osi_hyper_t *, cm_buf_t **);
extern long buf_GetNew(struct cm_scache *, osi_hyper_t *, cm_buf_t **);
-extern void buf_CleanAsync(cm_buf_t *, cm_req_t *);
+extern long buf_CleanAsyncLocked(cm_buf_t *, cm_req_t *);
-extern void buf_CleanWait(cm_buf_t *);
+extern long buf_CleanAsync(cm_buf_t *, cm_req_t *);
-extern void buf_SetDirty(cm_buf_t *);
+extern void buf_CleanWait(cm_scache_t *, cm_buf_t *);
+
+extern void buf_SetDirty(cm_buf_t *, afs_uint32 offset, afs_uint32 length);
extern long buf_CleanAndReset(void);
-extern void buf_ReserveBuffers(long);
+extern void buf_ReserveBuffers(afs_uint64);
+
+extern int buf_TryReserveBuffers(afs_uint64);
-extern int buf_TryReserveBuffers(long);
+extern void buf_UnreserveBuffers(afs_uint64);
-extern void buf_UnreserveBuffers(long);
+#ifdef TESTING
+extern void buf_ValidateBufQueues(void);
+#endif /* TESTING */
extern osi_log_t *buf_logp;
extern long buf_FlushCleanPages(cm_scache_t *scp, cm_user_t *userp,
cm_req_t *reqp);
-extern long buf_SetNBuffers(long nbuffers);
+extern long buf_SetNBuffers(afs_uint64 nbuffers);
+
+extern long buf_ValidateBuffers(void);
+
+extern void buf_ForceTrace(BOOL flush);
+
+extern long buf_DirtyBuffersExist(cm_fid_t * fidp);
+
+extern long buf_CleanDirtyBuffers(cm_scache_t *scp);
+
+extern long buf_ForceDataVersion(cm_scache_t * scp, afs_uint64 fromVersion, afs_uint64 toVersion);
/* error codes */
#define CM_BUF_EXISTS 1 /* buffer exists, and shouldn't */
-#define CM_ERROR_BASEBUF 0x33333333
-#define CM_ERROR_TOOFEWBUFS (CM_ERROR_BASEBUF+0)
-#define CM_ERROR_TOOMANYBUFS (CM_ERROR_BASEBUF+1)
#endif /* _BUF_H__ENV_ */