lwlock.h 1.92 KB
Newer Older
1 2 3 4 5 6
/*-------------------------------------------------------------------------
 *
 * lwlock.h
 *	  Lightweight lock manager
 *
 *
7
 * Portions Copyright (c) 1996-2005, PostgreSQL Global Development Group
8 9
 * Portions Copyright (c) 1994, Regents of the University of California
 *
10
 * $PostgreSQL: pgsql/src/include/storage/lwlock.h,v 1.17 2005/03/04 20:21:07 tgl Exp $
11 12 13 14 15 16 17 18 19 20
 *
 *-------------------------------------------------------------------------
 */
#ifndef LWLOCK_H
#define LWLOCK_H

/*
 * We have a number of predefined LWLocks, plus a bunch of LWLocks that are
 * dynamically assigned (for shared buffers).  The LWLock structures live
 * in shared memory (since they contain shared data) and are identified by
21
 * values of this enumerated type.	We abuse the notion of an enum somewhat
22 23 24 25 26 27
 * by allowing values not listed in the enum declaration to be assigned.
 * The extra value MaxDynamicLWLock is there to keep the compiler from
 * deciding that the enum can be represented as char or short ...
 */
typedef enum LWLockId
{
28 29
	BufMappingLock,
	BufFreelistLock,
30 31 32 33 34 35 36 37 38 39
	LockMgrLock,
	OidGenLock,
	XidGenLock,
	SInvalLock,
	FreeSpaceLock,
	MMCacheLock,
	WALInsertLock,
	WALWriteLock,
	ControlFileLock,
	CheckpointLock,
40
	CheckpointStartLock,
41 42
	CLogControlLock,
	SubtransControlLock,
43
	RelCacheInitLock,
44
	BgWriterCommLock,
45

46
	NumFixedLWLocks,			/* must be last except for
47
								 * MaxDynamicLWLock */
48

49
	MaxDynamicLWLock = 1000000000
50 51 52 53 54
} LWLockId;


typedef enum LWLockMode
{
55 56
	LW_EXCLUSIVE,
	LW_SHARED
57 58 59 60 61 62 63 64 65 66 67 68
} LWLockMode;


#ifdef LOCK_DEBUG
extern bool Trace_lwlocks;
#endif

extern LWLockId LWLockAssign(void);
extern void LWLockAcquire(LWLockId lockid, LWLockMode mode);
extern bool LWLockConditionalAcquire(LWLockId lockid, LWLockMode mode);
extern void LWLockRelease(LWLockId lockid);
extern void LWLockReleaseAll(void);
69
extern bool LWLockHeldByMe(LWLockId lockid);
70 71 72 73

extern int	NumLWLocks(void);
extern int	LWLockShmemSize(void);
extern void CreateLWLocks(void);
74

75
#endif   /* LWLOCK_H */