1996-08-28 03:59:28 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
1999-02-14 00:22:53 +01:00
|
|
|
* buf_internals.h
|
1997-09-07 07:04:48 +02:00
|
|
|
* Internal definitions.
|
1996-08-28 03:59:28 +02:00
|
|
|
*
|
|
|
|
*
|
|
|
|
* Copyright (c) 1994, Regents of the University of California
|
|
|
|
*
|
1999-07-16 19:07:40 +02:00
|
|
|
* $Id: buf_internals.h,v 1.31 1999/07/16 17:07:37 momjian Exp $
|
1996-08-28 03:59:28 +02:00
|
|
|
*
|
|
|
|
* NOTE
|
1997-09-07 07:04:48 +02:00
|
|
|
* If BUFFERPAGE0 is defined, then 0 will be used as a
|
|
|
|
* valid buffer page number.
|
1996-08-28 03:59:28 +02:00
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
1997-09-07 07:04:48 +02:00
|
|
|
#ifndef BUFMGR_INTERNALS_H
|
1996-08-28 03:59:28 +02:00
|
|
|
#define BUFMGR_INTERNALS_H
|
|
|
|
|
1999-07-16 01:04:24 +02:00
|
|
|
#include "storage/buf.h"
|
1999-07-16 19:07:40 +02:00
|
|
|
#include "storage/lmgr.h"
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
/* Buf Mgr constants */
|
|
|
|
/* in bufmgr.c */
|
1997-09-08 04:41:22 +02:00
|
|
|
extern int NBuffers;
|
|
|
|
extern int Data_Descriptors;
|
|
|
|
extern int Free_List_Descriptor;
|
|
|
|
extern int Lookup_List_Descriptor;
|
|
|
|
extern int Num_Descriptors;
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Flags for buffer descriptors
|
|
|
|
*/
|
1997-09-07 07:04:48 +02:00
|
|
|
#define BM_DIRTY (1 << 0)
|
|
|
|
#define BM_PRIVATE (1 << 1)
|
|
|
|
#define BM_VALID (1 << 2)
|
|
|
|
#define BM_DELETED (1 << 3)
|
|
|
|
#define BM_FREE (1 << 4)
|
|
|
|
#define BM_IO_IN_PROGRESS (1 << 5)
|
|
|
|
#define BM_IO_ERROR (1 << 6)
|
|
|
|
#define BM_JUST_DIRTIED (1 << 7)
|
1996-08-28 03:59:28 +02:00
|
|
|
|
1997-09-08 04:41:22 +02:00
|
|
|
typedef bits16 BufFlags;
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
typedef struct sbufdesc BufferDesc;
|
|
|
|
typedef struct sbufdesc BufferHdr;
|
|
|
|
typedef struct buftag BufferTag;
|
1997-09-07 07:04:48 +02:00
|
|
|
|
1996-08-28 03:59:28 +02:00
|
|
|
/* long * so alignment will be correct */
|
1997-09-08 04:41:22 +02:00
|
|
|
typedef long **BufferBlock;
|
1996-08-28 03:59:28 +02:00
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
struct buftag
|
|
|
|
{
|
1998-09-01 06:40:42 +02:00
|
|
|
LockRelId relId;
|
1997-09-08 04:41:22 +02:00
|
|
|
BlockNumber blockNum; /* blknum relative to begin of reln */
|
1996-08-28 03:59:28 +02:00
|
|
|
};
|
|
|
|
|
1998-06-15 20:40:05 +02:00
|
|
|
#define CLEAR_BUFFERTAG(a) \
|
|
|
|
( \
|
|
|
|
(a)->relId.dbId = InvalidOid, \
|
|
|
|
(a)->relId.relId = InvalidOid, \
|
|
|
|
(a)->blockNum = InvalidBlockNumber \
|
|
|
|
)
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
#define INIT_BUFFERTAG(a,xx_reln,xx_blockNum) \
|
1998-06-15 20:40:05 +02:00
|
|
|
( \
|
|
|
|
(a)->blockNum = xx_blockNum, \
|
1998-08-01 17:26:38 +02:00
|
|
|
(a)->relId = ((LockInfo)(xx_reln->lockInfo))->lockRelId \
|
1998-06-15 20:40:05 +02:00
|
|
|
)
|
|
|
|
|
1996-08-28 03:59:28 +02:00
|
|
|
#define BAD_BUFFER_ID(bid) ((bid<1) || (bid>(NBuffers)))
|
|
|
|
#define INVALID_DESCRIPTOR (-3)
|
|
|
|
|
|
|
|
/*
|
1997-09-07 07:04:48 +02:00
|
|
|
* struct sbufdesc -- shared buffer cache metadata for a single
|
|
|
|
* shared buffer descriptor.
|
1996-08-28 03:59:28 +02:00
|
|
|
*
|
1997-09-07 07:04:48 +02:00
|
|
|
* We keep the name of the database and relation in which this
|
|
|
|
* buffer appears in order to avoid a catalog lookup on cache
|
|
|
|
* flush if we don't have the reldesc in the cache. It is also
|
|
|
|
* possible that the relation to which this buffer belongs is
|
|
|
|
* not visible to all backends at the time that it gets flushed.
|
|
|
|
* Dbname, relname, dbid, and relid are enough to determine where
|
|
|
|
* to put the buffer, for all storage managers.
|
1996-08-28 03:59:28 +02:00
|
|
|
*/
|
1997-09-07 07:04:48 +02:00
|
|
|
struct sbufdesc
|
|
|
|
{
|
1997-09-08 04:41:22 +02:00
|
|
|
Buffer freeNext; /* link for freelist chain */
|
|
|
|
Buffer freePrev;
|
|
|
|
SHMEM_OFFSET data; /* pointer to data in buf pool */
|
1996-08-28 03:59:28 +02:00
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
/* tag and id must be together for table lookup to work */
|
1997-09-08 04:41:22 +02:00
|
|
|
BufferTag tag; /* file/block identifier */
|
|
|
|
int buf_id; /* maps global desc to local desc */
|
1996-08-28 03:59:28 +02:00
|
|
|
|
1997-09-08 04:41:22 +02:00
|
|
|
BufFlags flags; /* described below */
|
|
|
|
unsigned refcount; /* # of times buffer is pinned */
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
#ifdef HAS_TEST_AND_SET
|
1997-09-07 07:04:48 +02:00
|
|
|
/* can afford a dedicated lock if test-and-set locks are available */
|
1997-09-08 04:41:22 +02:00
|
|
|
slock_t io_in_progress_lock;
|
1998-12-15 13:47:01 +01:00
|
|
|
slock_t cntx_lock; /* to lock access to page context */
|
1998-09-01 06:40:42 +02:00
|
|
|
#endif /* HAS_TEST_AND_SET */
|
1998-12-15 13:47:01 +01:00
|
|
|
unsigned r_locks; /* # of shared locks */
|
|
|
|
bool ri_lock; /* read-intent lock */
|
|
|
|
bool w_lock; /* context exclusively locked */
|
1997-09-07 07:04:48 +02:00
|
|
|
|
1997-09-08 04:41:22 +02:00
|
|
|
char sb_dbname[NAMEDATALEN]; /* name of db in which buf belongs */
|
1999-05-25 18:15:34 +02:00
|
|
|
char sb_relname[NAMEDATALEN]; /* name of reln */
|
1996-08-28 03:59:28 +02:00
|
|
|
};
|
|
|
|
|
1998-12-15 13:47:01 +01:00
|
|
|
/*
|
|
|
|
* Buffer lock infos in BufferLocks below.
|
|
|
|
* We have to free these locks in elog(ERROR)...
|
|
|
|
*/
|
1999-05-25 18:15:34 +02:00
|
|
|
#define BL_IO_IN_PROGRESS (1 << 0) /* unimplemented */
|
|
|
|
#define BL_R_LOCK (1 << 1)
|
|
|
|
#define BL_RI_LOCK (1 << 2)
|
|
|
|
#define BL_W_LOCK (1 << 3)
|
1998-12-15 13:47:01 +01:00
|
|
|
|
1996-08-28 03:59:28 +02:00
|
|
|
/*
|
1997-09-07 07:04:48 +02:00
|
|
|
* mao tracing buffer allocation
|
1996-08-28 03:59:28 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
/*#define BMTRACE*/
|
|
|
|
#ifdef BMTRACE
|
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
typedef struct _bmtrace
|
|
|
|
{
|
1997-09-08 04:41:22 +02:00
|
|
|
int bmt_pid;
|
|
|
|
long bmt_buf;
|
|
|
|
long bmt_dbid;
|
|
|
|
long bmt_relid;
|
|
|
|
int bmt_blkno;
|
|
|
|
int bmt_op;
|
1996-08-28 03:59:28 +02:00
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
#define BMT_NOTUSED 0
|
1996-08-28 03:59:28 +02:00
|
|
|
#define BMT_ALLOCFND 1
|
1997-09-07 07:04:48 +02:00
|
|
|
#define BMT_ALLOCNOTFND 2
|
|
|
|
#define BMT_DEALLOC 3
|
1996-08-28 03:59:28 +02:00
|
|
|
|
1997-09-08 04:41:22 +02:00
|
|
|
} bmtrace;
|
1996-08-28 03:59:28 +02:00
|
|
|
|
1998-09-01 06:40:42 +02:00
|
|
|
#endif /* BMTRACE */
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
|
1997-09-07 07:04:48 +02:00
|
|
|
/*
|
1996-08-28 03:59:28 +02:00
|
|
|
* Bufmgr Interface:
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* Internal routines: only called by buf.c */
|
|
|
|
|
|
|
|
/*freelist.c*/
|
1997-09-08 22:59:27 +02:00
|
|
|
extern void AddBufferToFreelist(BufferDesc *bf);
|
|
|
|
extern void PinBuffer(BufferDesc *buf);
|
|
|
|
extern void PinBuffer_Debug(char *file, int line, BufferDesc *buf);
|
|
|
|
extern void UnpinBuffer(BufferDesc *buf);
|
1996-08-28 03:59:28 +02:00
|
|
|
extern BufferDesc *GetFreeBuffer(void);
|
1997-09-08 04:41:22 +02:00
|
|
|
extern void InitFreeList(bool init);
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
/* buf_table.c */
|
1997-09-08 04:41:22 +02:00
|
|
|
extern void InitBufTable(void);
|
1997-09-08 23:56:23 +02:00
|
|
|
extern BufferDesc *BufTableLookup(BufferTag *tagPtr);
|
1997-09-08 22:59:27 +02:00
|
|
|
extern bool BufTableDelete(BufferDesc *buf);
|
|
|
|
extern bool BufTableInsert(BufferDesc *buf);
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
/* bufmgr.c */
|
1997-09-07 07:04:48 +02:00
|
|
|
extern BufferDesc *BufferDescriptors;
|
|
|
|
extern BufferBlock BufferBlocks;
|
1997-09-08 04:41:22 +02:00
|
|
|
extern long *PrivateRefCount;
|
|
|
|
extern long *LastRefCount;
|
1998-12-15 13:47:01 +01:00
|
|
|
extern bits8 *BufferLocks;
|
1997-09-08 04:41:22 +02:00
|
|
|
extern long *CommitInfoNeedsSave;
|
1997-09-07 07:04:48 +02:00
|
|
|
extern SPINLOCK BufMgrLock;
|
1996-08-28 03:59:28 +02:00
|
|
|
|
|
|
|
/* localbuf.c */
|
1997-09-08 04:41:22 +02:00
|
|
|
extern long *LocalRefCount;
|
1996-08-28 03:59:28 +02:00
|
|
|
extern BufferDesc *LocalBufferDescriptors;
|
1997-09-08 04:41:22 +02:00
|
|
|
extern int NLocBuffer;
|
1997-09-07 07:04:48 +02:00
|
|
|
|
1998-09-01 06:40:42 +02:00
|
|
|
extern BufferDesc *LocalBufferAlloc(Relation reln, BlockNumber blockNum,
|
1997-09-08 23:56:23 +02:00
|
|
|
bool *foundPtr);
|
1997-09-08 04:41:22 +02:00
|
|
|
extern int WriteLocalBuffer(Buffer buffer, bool release);
|
|
|
|
extern int FlushLocalBuffer(Buffer buffer, bool release);
|
|
|
|
extern void InitLocalBuffer(void);
|
|
|
|
extern void LocalBufferSync(void);
|
|
|
|
extern void ResetLocalBufferPool(void);
|
1997-09-07 07:04:48 +02:00
|
|
|
|
1998-09-01 06:40:42 +02:00
|
|
|
#endif /* BUFMGR_INTERNALS_H */
|