locktag.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	LOCKTAG

Macros
#define	DEFAULT_LOCKMETHOD   1
#define	USER_LOCKMETHOD   2
#define	LOCKTAG_LAST_TYPE   LOCKTAG_APPLY_TRANSACTION
#define	SET_LOCKTAG_RELATION(locktag, dboid, reloid)
#define	SET_LOCKTAG_RELATION_EXTEND(locktag, dboid, reloid)
#define	SET_LOCKTAG_DATABASE_FROZEN_IDS(locktag, dboid)
#define	SET_LOCKTAG_PAGE(locktag, dboid, reloid, blocknum)
#define	SET_LOCKTAG_TUPLE(locktag, dboid, reloid, blocknum, offnum)
#define	SET_LOCKTAG_TRANSACTION(locktag, xid)
#define	SET_LOCKTAG_VIRTUALTRANSACTION(locktag, vxid)
#define	SET_LOCKTAG_SPECULATIVE_INSERTION(locktag, xid, token)
#define	SET_LOCKTAG_OBJECT(locktag, dboid, classoid, objoid, objsubid)
#define	SET_LOCKTAG_ADVISORY(locktag, id1, id2, id3, id4)
#define	SET_LOCKTAG_APPLY_TRANSACTION(locktag, dboid, suboid, xid, objid)

Typedefs
typedef uint16	LOCKMETHODID
typedef enum LockTagType	LockTagType
typedef struct LOCKTAG	LOCKTAG

Enumerations
enum	LockTagType {   LOCKTAG_RELATION , LOCKTAG_RELATION_EXTEND , LOCKTAG_DATABASE_FROZEN_IDS , LOCKTAG_PAGE ,   LOCKTAG_TUPLE , LOCKTAG_TRANSACTION , LOCKTAG_VIRTUALTRANSACTION , LOCKTAG_SPECULATIVE_TOKEN ,   LOCKTAG_OBJECT , LOCKTAG_USERLOCK , LOCKTAG_ADVISORY , LOCKTAG_APPLY_TRANSACTION }

Variables
PGDLLIMPORT const char *const	LockTagTypeNames []

Macro Definition Documentation

DEFAULT_LOCKMETHOD

#define DEFAULT_LOCKMETHOD   1

Definition at line 25 of file locktag.h.

LOCKTAG_LAST_TYPE

#define LOCKTAG_LAST_TYPE   LOCKTAG_APPLY_TRANSACTION

Definition at line 52 of file locktag.h.

SET_LOCKTAG_ADVISORY

#define SET_LOCKTAG_ADVISORY	(		locktag,
			id1,
			id2,
			id3,
			id4
	)

Value:

    ((locktag).locktag_field1 = (id1), \
     (locktag).locktag_field2 = (id2), \
     (locktag).locktag_field3 = (id3), \
     (locktag).locktag_field4 = (id4), \
     (locktag).locktag_type = LOCKTAG_ADVISORY, \
     (locktag).locktag_lockmethodid = USER_LOCKMETHOD)

Definition at line 170 of file locktag.h.

SET_LOCKTAG_APPLY_TRANSACTION

#define SET_LOCKTAG_APPLY_TRANSACTION	(		locktag,
			dboid,
			suboid,
			xid,
			objid
	)

Value:

    ((locktag).locktag_field1 = (dboid), \
     (locktag).locktag_field2 = (suboid), \
     (locktag).locktag_field3 = (xid), \
     (locktag).locktag_field4 = (objid), \
     (locktag).locktag_type = LOCKTAG_APPLY_TRANSACTION, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 182 of file locktag.h.

SET_LOCKTAG_DATABASE_FROZEN_IDS

#define SET_LOCKTAG_DATABASE_FROZEN_IDS	(		locktag,
			dboid
	)

Value:

    ((locktag).locktag_field1 = (dboid), \
     (locktag).locktag_field2 = 0, \
     (locktag).locktag_field3 = 0, \
     (locktag).locktag_field4 = 0, \
     (locktag).locktag_type = LOCKTAG_DATABASE_FROZEN_IDS, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 99 of file locktag.h.

SET_LOCKTAG_OBJECT

#define SET_LOCKTAG_OBJECT	(		locktag,
			dboid,
			classoid,
			objoid,
			objsubid
	)

Value:

    ((locktag).locktag_field1 = (dboid), \
     (locktag).locktag_field2 = (classoid), \
     (locktag).locktag_field3 = (objoid), \
     (locktag).locktag_field4 = (objsubid), \
     (locktag).locktag_type = LOCKTAG_OBJECT, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 162 of file locktag.h.

SET_LOCKTAG_PAGE

#define SET_LOCKTAG_PAGE	(		locktag,
			dboid,
			reloid,
			blocknum
	)

Value:

    ((locktag).locktag_field1 = (dboid), \
     (locktag).locktag_field2 = (reloid), \
     (locktag).locktag_field3 = (blocknum), \
     (locktag).locktag_field4 = 0, \
     (locktag).locktag_type = LOCKTAG_PAGE, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 108 of file locktag.h.

SET_LOCKTAG_RELATION

#define SET_LOCKTAG_RELATION	(		locktag,
			dboid,
			reloid
	)

Value:

    ((locktag).locktag_field1 = (dboid), \
     (locktag).locktag_field2 = (reloid), \
     (locktag).locktag_field3 = 0, \
     (locktag).locktag_field4 = 0, \
     (locktag).locktag_type = LOCKTAG_RELATION, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 81 of file locktag.h.

SET_LOCKTAG_RELATION_EXTEND

#define SET_LOCKTAG_RELATION_EXTEND	(		locktag,
			dboid,
			reloid
	)

Value:

    ((locktag).locktag_field1 = (dboid), \
     (locktag).locktag_field2 = (reloid), \
     (locktag).locktag_field3 = 0, \
     (locktag).locktag_field4 = 0, \
     (locktag).locktag_type = LOCKTAG_RELATION_EXTEND, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 90 of file locktag.h.

SET_LOCKTAG_SPECULATIVE_INSERTION

#define SET_LOCKTAG_SPECULATIVE_INSERTION	(		locktag,
			xid,
			token
	)

Value:

    ((locktag).locktag_field1 = (xid), \
     (locktag).locktag_field2 = (token),        \
     (locktag).locktag_field3 = 0, \
     (locktag).locktag_field4 = 0, \
     (locktag).locktag_type = LOCKTAG_SPECULATIVE_TOKEN, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 147 of file locktag.h.

SET_LOCKTAG_TRANSACTION

#define SET_LOCKTAG_TRANSACTION	(		locktag,
			xid
	)

Value:

    ((locktag).locktag_field1 = (xid), \
     (locktag).locktag_field2 = 0, \
     (locktag).locktag_field3 = 0, \
     (locktag).locktag_field4 = 0, \
     (locktag).locktag_type = LOCKTAG_TRANSACTION, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 126 of file locktag.h.

SET_LOCKTAG_TUPLE

#define SET_LOCKTAG_TUPLE	(		locktag,
			dboid,
			reloid,
			blocknum,
			offnum
	)

Value:

    ((locktag).locktag_field1 = (dboid), \
     (locktag).locktag_field2 = (reloid), \
     (locktag).locktag_field3 = (blocknum), \
     (locktag).locktag_field4 = (offnum), \
     (locktag).locktag_type = LOCKTAG_TUPLE, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 117 of file locktag.h.

SET_LOCKTAG_VIRTUALTRANSACTION

#define SET_LOCKTAG_VIRTUALTRANSACTION	(		locktag,
			vxid
	)

Value:

    ((locktag).locktag_field1 = (vxid).procNumber, \
     (locktag).locktag_field2 = (vxid).localTransactionId, \
     (locktag).locktag_field3 = 0, \
     (locktag).locktag_field4 = 0, \
     (locktag).locktag_type = LOCKTAG_VIRTUALTRANSACTION, \
     (locktag).locktag_lockmethodid = DEFAULT_LOCKMETHOD)

Definition at line 135 of file locktag.h.

USER_LOCKMETHOD

#define USER_LOCKMETHOD   2

Definition at line 26 of file locktag.h.

Typedef Documentation

LOCKMETHODID

typedef uint16 LOCKMETHODID

Definition at line 22 of file locktag.h.

LOCKTAG

typedef struct LOCKTAG LOCKTAG

LockTagType

typedef enum LockTagType LockTagType

Enumeration Type Documentation

LockTagType

enum LockTagType

Enumerator
LOCKTAG_RELATION
LOCKTAG_RELATION_EXTEND
LOCKTAG_DATABASE_FROZEN_IDS
LOCKTAG_PAGE
LOCKTAG_TUPLE
LOCKTAG_TRANSACTION
LOCKTAG_VIRTUALTRANSACTION
LOCKTAG_SPECULATIVE_TOKEN
LOCKTAG_OBJECT
LOCKTAG_USERLOCK
LOCKTAG_ADVISORY
LOCKTAG_APPLY_TRANSACTION

Definition at line 35 of file locktag.h.

{
    LOCKTAG_RELATION,           /* whole relation */
    LOCKTAG_RELATION_EXTEND,    /* the right to extend a relation */
    LOCKTAG_DATABASE_FROZEN_IDS,    /* pg_database.datfrozenxid */
    LOCKTAG_PAGE,               /* one page of a relation */
    LOCKTAG_TUPLE,              /* one physical tuple */
    LOCKTAG_TRANSACTION,        /* transaction (for waiting for xact done) */
    LOCKTAG_VIRTUALTRANSACTION, /* virtual transaction (ditto) */
    LOCKTAG_SPECULATIVE_TOKEN,  /* speculative insertion Xid and token */
    LOCKTAG_OBJECT,             /* non-relation database object */
    LOCKTAG_USERLOCK,           /* reserved for old contrib/userlock code */
    LOCKTAG_ADVISORY,           /* advisory user locks */
    LOCKTAG_APPLY_TRANSACTION,  /* transaction being applied on a logical
                                 * replication subscriber */
} LockTagType;

Variable Documentation

LockTagTypeNames

PGDLLIMPORT const char* const LockTagTypeNames[]

extern

Definition at line 28 of file lockfuncs.c.

                                       {
    "relation",
    "extend",
    "frozenid",
    "page",
    "tuple",
    "transactionid",
    "virtualxid",
    "spectoken",
    "object",
    "userlock",
    "advisory",
    "applytransaction"
};

Referenced by GetLockNameFromTagType(), and pg_lock_status().