src/include/storage/predicate.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * predicate.h
   4  *        POSTGRES public predicate locking definitions.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * src/include/storage/predicate.h
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef PREDICATE_H
  15 #define PREDICATE_H
  16
  17 #include "storage/lock.h"
  18 #include "utils/relcache.h"
  19 #include "utils/snapshot.h"
  20
  21
  22 /*
  23  * GUC variables
  24  */
  25 extern PGDLLIMPORT int max_predicate_locks_per_xact;
  26 extern PGDLLIMPORT int max_predicate_locks_per_relation;
  27 extern PGDLLIMPORT int max_predicate_locks_per_page;
  28
  29 /*
  30  * A handle used for sharing SERIALIZABLEXACT objects between the participants
  31  * in a parallel query.
  32  */
  33 typedef void *SerializableXactHandle;
  34
  35 /*
  36  * function prototypes
  37  */
  38
  39 /* housekeeping for shared memory predicate lock structures */
  40 extern void InitPredicateLocks(void);
  41 extern Size PredicateLockShmemSize(void);
  42
  43 extern void CheckPointPredicate(void);
  44
  45 /* predicate lock reporting */
  46 extern bool PageIsPredicateLocked(Relation relation, BlockNumber blkno);
  47
  48 /* predicate lock maintenance */
  49 extern Snapshot GetSerializableTransactionSnapshot(Snapshot snapshot);
  50 extern void SetSerializableTransactionSnapshot(Snapshot snapshot,
  51                                                                                            VirtualTransactionId *sourcevxid,
  52                                                                                            int sourcepid);
  53 extern void RegisterPredicateLockingXid(TransactionId xid);
  54 extern void PredicateLockRelation(Relation relation, Snapshot snapshot);
  55 extern void PredicateLockPage(Relation relation, BlockNumber blkno, Snapshot snapshot);
  56 extern void PredicateLockTID(Relation relation, ItemPointer tid, Snapshot snapshot,
  57                                                          TransactionId tuple_xid);
  58 extern void PredicateLockPageSplit(Relation relation, BlockNumber oldblkno, BlockNumber newblkno);
  59 extern void PredicateLockPageCombine(Relation relation, BlockNumber oldblkno, BlockNumber newblkno);
  60 extern void TransferPredicateLocksToHeapRelation(Relation relation);
  61 extern void ReleasePredicateLocks(bool isCommit, bool isReadOnlySafe);
  62
  63 /* conflict detection (may also trigger rollback) */
  64 extern bool CheckForSerializableConflictOutNeeded(Relation relation, Snapshot snapshot);
  65 extern void CheckForSerializableConflictOut(Relation relation, TransactionId xid, Snapshot snapshot);
  66 extern void CheckForSerializableConflictIn(Relation relation, ItemPointer tid, BlockNumber blkno);
  67 extern void CheckTableForSerializableConflictIn(Relation relation);
  68
  69 /* final rollback checking */
  70 extern void PreCommit_CheckForSerializationFailure(void);
  71
  72 /* two-phase commit support */
  73 extern void AtPrepare_PredicateLocks(void);
  74 extern void PostPrepare_PredicateLocks(TransactionId xid);
  75 extern void PredicateLockTwoPhaseFinish(TransactionId xid, bool isCommit);
  76 extern void predicatelock_twophase_recover(TransactionId xid, uint16 info,
  77                                                                                    void *recdata, uint32 len);
  78
  79 /* parallel query support */
  80 extern SerializableXactHandle ShareSerializableXact(void);
  81 extern void AttachSerializableXact(SerializableXactHandle handle);
  82
  83 #endif                                                  /* PREDICATE_H */