PostgreSQL Source Code  git master
snapbuild.h File Reference
#include "access/xlogdefs.h"
#include "utils/snapmgr.h"
Include dependency graph for snapbuild.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef struct SnapBuild SnapBuild
 

Enumerations

enum  SnapBuildState { SNAPBUILD_START = -1 , SNAPBUILD_BUILDING_SNAPSHOT = 0 , SNAPBUILD_FULL_SNAPSHOT = 1 , SNAPBUILD_CONSISTENT = 2 }
 

Functions

void CheckPointSnapBuild (void)
 
SnapBuildAllocateSnapshotBuilder (struct ReorderBuffer *reorder, TransactionId xmin_horizon, XLogRecPtr start_lsn, bool need_full_snapshot, bool in_slot_creation, XLogRecPtr two_phase_at)
 
void FreeSnapshotBuilder (SnapBuild *builder)
 
void SnapBuildSnapDecRefcount (Snapshot snap)
 
Snapshot SnapBuildInitialSnapshot (SnapBuild *builder)
 
const char * SnapBuildExportSnapshot (SnapBuild *builder)
 
void SnapBuildClearExportedSnapshot (void)
 
void SnapBuildResetExportedSnapshotState (void)
 
SnapBuildState SnapBuildCurrentState (SnapBuild *builder)
 
Snapshot SnapBuildGetOrBuildSnapshot (SnapBuild *builder)
 
bool SnapBuildXactNeedsSkip (SnapBuild *builder, XLogRecPtr ptr)
 
XLogRecPtr SnapBuildGetTwoPhaseAt (SnapBuild *builder)
 
void SnapBuildSetTwoPhaseAt (SnapBuild *builder, XLogRecPtr ptr)
 
void SnapBuildCommitTxn (SnapBuild *builder, XLogRecPtr lsn, TransactionId xid, int nsubxacts, TransactionId *subxacts, uint32 xinfo)
 
bool SnapBuildProcessChange (SnapBuild *builder, TransactionId xid, XLogRecPtr lsn)
 
void SnapBuildProcessNewCid (SnapBuild *builder, TransactionId xid, XLogRecPtr lsn, struct xl_heap_new_cid *xlrec)
 
void SnapBuildProcessRunningXacts (SnapBuild *builder, XLogRecPtr lsn, struct xl_running_xacts *running)
 
void SnapBuildSerializationPoint (SnapBuild *builder, XLogRecPtr lsn)
 
bool SnapBuildSnapshotExists (XLogRecPtr lsn)
 

Typedef Documentation

◆ SnapBuild

typedef struct SnapBuild SnapBuild

Definition at line 1 of file snapbuild.h.

Enumeration Type Documentation

◆ SnapBuildState

Enumerator
SNAPBUILD_START 
SNAPBUILD_BUILDING_SNAPSHOT 
SNAPBUILD_FULL_SNAPSHOT 
SNAPBUILD_CONSISTENT 

Definition at line 18 of file snapbuild.h.

19 {
20  /*
21  * Initial state, we can't do much yet.
22  */
23  SNAPBUILD_START = -1,
24 
25  /*
26  * Collecting committed transactions, to build the initial catalog
27  * snapshot.
28  */
30 
31  /*
32  * We have collected enough information to decode tuples in transactions
33  * that started after this.
34  *
35  * Once we reached this we start to collect changes. We cannot apply them
36  * yet, because they might be based on transactions that were still
37  * running when FULL_SNAPSHOT was reached.
38  */
40 
41  /*
42  * Found a point after SNAPBUILD_FULL_SNAPSHOT where all transactions that
43  * were running at that point finished. Till we reach that we hold off
44  * calling any commit callbacks.
45  */
SnapBuildState
Definition: snapbuild.h:19
@ SNAPBUILD_START
Definition: snapbuild.h:23
@ SNAPBUILD_BUILDING_SNAPSHOT
Definition: snapbuild.h:29
@ SNAPBUILD_FULL_SNAPSHOT
Definition: snapbuild.h:39
@ SNAPBUILD_CONSISTENT
Definition: snapbuild.h:46

Function Documentation

◆ AllocateSnapshotBuilder()

SnapBuild* AllocateSnapshotBuilder ( struct ReorderBuffer reorder,
TransactionId  xmin_horizon,
XLogRecPtr  start_lsn,
bool  need_full_snapshot,
bool  in_slot_creation,
XLogRecPtr  two_phase_at 
)

Definition at line 324 of file snapbuild.c.

330 {
332  MemoryContext oldcontext;
333  SnapBuild *builder;
334 
335  /* allocate memory in own context, to have better accountability */
337  "snapshot builder context",
339  oldcontext = MemoryContextSwitchTo(context);
340 
341  builder = palloc0(sizeof(SnapBuild));
342 
343  builder->state = SNAPBUILD_START;
344  builder->context = context;
345  builder->reorder = reorder;
346  /* Other struct members initialized by zeroing via palloc0 above */
347 
348  builder->committed.xcnt = 0;
349  builder->committed.xcnt_space = 128; /* arbitrary number */
350  builder->committed.xip =
351  palloc0(builder->committed.xcnt_space * sizeof(TransactionId));
352  builder->committed.includes_all_transactions = true;
353 
354  builder->catchange.xcnt = 0;
355  builder->catchange.xip = NULL;
356 
357  builder->initial_xmin_horizon = xmin_horizon;
358  builder->start_decoding_at = start_lsn;
359  builder->in_slot_creation = in_slot_creation;
360  builder->building_full_snapshot = need_full_snapshot;
361  builder->two_phase_at = two_phase_at;
362 
363  MemoryContextSwitchTo(oldcontext);
364 
365  return builder;
366 }
uint32 TransactionId
Definition: c.h:655
void * palloc0(Size size)
Definition: mcxt.c:1347
MemoryContext CurrentMemoryContext
Definition: mcxt.c:143
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:160
tree context
Definition: radixtree.h:1835
MemoryContextSwitchTo(old_ctx)
struct SnapBuild::@20 catchange
XLogRecPtr start_decoding_at
Definition: snapbuild.c:170
SnapBuildState state
Definition: snapbuild.c:155
TransactionId initial_xmin_horizon
Definition: snapbuild.c:187
TransactionId * xip
Definition: snapbuild.c:255
XLogRecPtr two_phase_at
Definition: snapbuild.c:181
bool building_full_snapshot
Definition: snapbuild.c:190
size_t xcnt
Definition: snapbuild.c:229
bool in_slot_creation
Definition: snapbuild.c:198
size_t xcnt_space
Definition: snapbuild.c:232
bool includes_all_transactions
Definition: snapbuild.c:239
MemoryContext context
Definition: snapbuild.c:158
ReorderBuffer * reorder
Definition: snapbuild.c:213
struct SnapBuild::@19 committed

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, SnapBuild::building_full_snapshot, SnapBuild::catchange, SnapBuild::committed, SnapBuild::context, context, CurrentMemoryContext, SnapBuild::in_slot_creation, SnapBuild::includes_all_transactions, SnapBuild::initial_xmin_horizon, MemoryContextSwitchTo(), palloc0(), SnapBuild::reorder, SNAPBUILD_START, SnapBuild::start_decoding_at, SnapBuild::state, SnapBuild::two_phase_at, SnapBuild::xcnt, SnapBuild::xcnt_space, and SnapBuild::xip.

Referenced by StartupDecodingContext().

◆ CheckPointSnapBuild()

void CheckPointSnapBuild ( void  )

Definition at line 2074 of file snapbuild.c.

2075 {
2076  XLogRecPtr cutoff;
2077  XLogRecPtr redo;
2078  DIR *snap_dir;
2079  struct dirent *snap_de;
2080  char path[MAXPGPATH + sizeof(PG_LOGICAL_SNAPSHOTS_DIR)];
2081 
2082  /*
2083  * We start off with a minimum of the last redo pointer. No new
2084  * replication slot will start before that, so that's a safe upper bound
2085  * for removal.
2086  */
2087  redo = GetRedoRecPtr();
2088 
2089  /* now check for the restart ptrs from existing slots */
2091 
2092  /* don't start earlier than the restart lsn */
2093  if (redo < cutoff)
2094  cutoff = redo;
2095 
2097  while ((snap_de = ReadDir(snap_dir, PG_LOGICAL_SNAPSHOTS_DIR)) != NULL)
2098  {
2099  uint32 hi;
2100  uint32 lo;
2101  XLogRecPtr lsn;
2102  PGFileType de_type;
2103 
2104  if (strcmp(snap_de->d_name, ".") == 0 ||
2105  strcmp(snap_de->d_name, "..") == 0)
2106  continue;
2107 
2108  snprintf(path, sizeof(path), "%s/%s", PG_LOGICAL_SNAPSHOTS_DIR, snap_de->d_name);
2109  de_type = get_dirent_type(path, snap_de, false, DEBUG1);
2110 
2111  if (de_type != PGFILETYPE_ERROR && de_type != PGFILETYPE_REG)
2112  {
2113  elog(DEBUG1, "only regular files expected: %s", path);
2114  continue;
2115  }
2116 
2117  /*
2118  * temporary filenames from SnapBuildSerialize() include the LSN and
2119  * everything but are postfixed by .$pid.tmp. We can just remove them
2120  * the same as other files because there can be none that are
2121  * currently being written that are older than cutoff.
2122  *
2123  * We just log a message if a file doesn't fit the pattern, it's
2124  * probably some editors lock/state file or similar...
2125  */
2126  if (sscanf(snap_de->d_name, "%X-%X.snap", &hi, &lo) != 2)
2127  {
2128  ereport(LOG,
2129  (errmsg("could not parse file name \"%s\"", path)));
2130  continue;
2131  }
2132 
2133  lsn = ((uint64) hi) << 32 | lo;
2134 
2135  /* check whether we still need it */
2136  if (lsn < cutoff || cutoff == InvalidXLogRecPtr)
2137  {
2138  elog(DEBUG1, "removing snapbuild snapshot %s", path);
2139 
2140  /*
2141  * It's not particularly harmful, though strange, if we can't
2142  * remove the file here. Don't prevent the checkpoint from
2143  * completing, that'd be a cure worse than the disease.
2144  */
2145  if (unlink(path) < 0)
2146  {
2147  ereport(LOG,
2149  errmsg("could not remove file \"%s\": %m",
2150  path)));
2151  continue;
2152  }
2153  }
2154  }
2155  FreeDir(snap_dir);
2156 }
unsigned int uint32
Definition: c.h:509
int errcode_for_file_access(void)
Definition: elog.c:876
int errmsg(const char *fmt,...)
Definition: elog.c:1070
#define LOG
Definition: elog.h:31
#define DEBUG1
Definition: elog.h:30
#define elog(elevel,...)
Definition: elog.h:225
#define ereport(elevel,...)
Definition: elog.h:149
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition: fd.c:2932
int FreeDir(DIR *dir)
Definition: fd.c:2984
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2866
PGFileType get_dirent_type(const char *path, const struct dirent *de, bool look_through_symlinks, int elevel)
Definition: file_utils.c:526
PGFileType
Definition: file_utils.h:19
@ PGFILETYPE_REG
Definition: file_utils.h:22
@ PGFILETYPE_ERROR
Definition: file_utils.h:20
#define MAXPGPATH
#define snprintf
Definition: port.h:238
#define PG_LOGICAL_SNAPSHOTS_DIR
Definition: reorderbuffer.h:24
XLogRecPtr ReplicationSlotsComputeLogicalRestartLSN(void)
Definition: slot.c:1182
Definition: dirent.c:26
Definition: dirent.h:10
char d_name[MAX_PATH]
Definition: dirent.h:15
XLogRecPtr GetRedoRecPtr(void)
Definition: xlog.c:6436
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28

References AllocateDir(), dirent::d_name, DEBUG1, elog, ereport, errcode_for_file_access(), errmsg(), FreeDir(), get_dirent_type(), GetRedoRecPtr(), InvalidXLogRecPtr, LOG, MAXPGPATH, PG_LOGICAL_SNAPSHOTS_DIR, PGFILETYPE_ERROR, PGFILETYPE_REG, ReadDir(), ReplicationSlotsComputeLogicalRestartLSN(), and snprintf.

Referenced by CheckPointGuts().

◆ FreeSnapshotBuilder()

void FreeSnapshotBuilder ( SnapBuild builder)

Definition at line 372 of file snapbuild.c.

373 {
374  MemoryContext context = builder->context;
375 
376  /* free snapshot explicitly, that contains some error checking */
377  if (builder->snapshot != NULL)
378  {
380  builder->snapshot = NULL;
381  }
382 
383  /* other resources are deallocated via memory context reset */
385 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:454
void SnapBuildSnapDecRefcount(Snapshot snap)
Definition: snapbuild.c:467
Snapshot snapshot
Definition: snapbuild.c:203

References SnapBuild::context, context, MemoryContextDelete(), SnapBuildSnapDecRefcount(), and SnapBuild::snapshot.

Referenced by FreeDecodingContext().

◆ SnapBuildClearExportedSnapshot()

void SnapBuildClearExportedSnapshot ( void  )

Definition at line 739 of file snapbuild.c.

740 {
741  ResourceOwner tmpResOwner;
742 
743  /* nothing exported, that is the usual case */
744  if (!ExportInProgress)
745  return;
746 
747  if (!IsTransactionState())
748  elog(ERROR, "clearing exported snapshot in wrong transaction state");
749 
750  /*
751  * AbortCurrentTransaction() takes care of resetting the snapshot state,
752  * so remember SavedResourceOwnerDuringExport.
753  */
754  tmpResOwner = SavedResourceOwnerDuringExport;
755 
756  /* make sure nothing could have ever happened */
758 
759  CurrentResourceOwner = tmpResOwner;
760 }
#define ERROR
Definition: elog.h:39
ResourceOwner CurrentResourceOwner
Definition: resowner.c:165
static ResourceOwner SavedResourceOwnerDuringExport
Definition: snapbuild.c:290
static bool ExportInProgress
Definition: snapbuild.c:291
bool IsTransactionState(void)
Definition: xact.c:386
void AbortCurrentTransaction(void)
Definition: xact.c:3431

References AbortCurrentTransaction(), CurrentResourceOwner, elog, ERROR, ExportInProgress, IsTransactionState(), and SavedResourceOwnerDuringExport.

Referenced by exec_replication_command().

◆ SnapBuildCommitTxn()

void SnapBuildCommitTxn ( SnapBuild builder,
XLogRecPtr  lsn,
TransactionId  xid,
int  nsubxacts,
TransactionId subxacts,
uint32  xinfo 
)

Definition at line 1034 of file snapbuild.c.

1036 {
1037  int nxact;
1038 
1039  bool needs_snapshot = false;
1040  bool needs_timetravel = false;
1041  bool sub_needs_timetravel = false;
1042 
1043  TransactionId xmax = xid;
1044 
1045  /*
1046  * Transactions preceding BUILDING_SNAPSHOT will neither be decoded, nor
1047  * will they be part of a snapshot. So we don't need to record anything.
1048  */
1049  if (builder->state == SNAPBUILD_START ||
1050  (builder->state == SNAPBUILD_BUILDING_SNAPSHOT &&
1051  TransactionIdPrecedes(xid, builder->next_phase_at)))
1052  {
1053  /* ensure that only commits after this are getting replayed */
1054  if (builder->start_decoding_at <= lsn)
1055  builder->start_decoding_at = lsn + 1;
1056  return;
1057  }
1058 
1059  if (builder->state < SNAPBUILD_CONSISTENT)
1060  {
1061  /* ensure that only commits after this are getting replayed */
1062  if (builder->start_decoding_at <= lsn)
1063  builder->start_decoding_at = lsn + 1;
1064 
1065  /*
1066  * If building an exportable snapshot, force xid to be tracked, even
1067  * if the transaction didn't modify the catalog.
1068  */
1069  if (builder->building_full_snapshot)
1070  {
1071  needs_timetravel = true;
1072  }
1073  }
1074 
1075  for (nxact = 0; nxact < nsubxacts; nxact++)
1076  {
1077  TransactionId subxid = subxacts[nxact];
1078 
1079  /*
1080  * Add subtransaction to base snapshot if catalog modifying, we don't
1081  * distinguish to toplevel transactions there.
1082  */
1083  if (SnapBuildXidHasCatalogChanges(builder, subxid, xinfo))
1084  {
1085  sub_needs_timetravel = true;
1086  needs_snapshot = true;
1087 
1088  elog(DEBUG1, "found subtransaction %u:%u with catalog changes",
1089  xid, subxid);
1090 
1091  SnapBuildAddCommittedTxn(builder, subxid);
1092 
1093  if (NormalTransactionIdFollows(subxid, xmax))
1094  xmax = subxid;
1095  }
1096 
1097  /*
1098  * If we're forcing timetravel we also need visibility information
1099  * about subtransaction, so keep track of subtransaction's state, even
1100  * if not catalog modifying. Don't need to distribute a snapshot in
1101  * that case.
1102  */
1103  else if (needs_timetravel)
1104  {
1105  SnapBuildAddCommittedTxn(builder, subxid);
1106  if (NormalTransactionIdFollows(subxid, xmax))
1107  xmax = subxid;
1108  }
1109  }
1110 
1111  /* if top-level modified catalog, it'll need a snapshot */
1112  if (SnapBuildXidHasCatalogChanges(builder, xid, xinfo))
1113  {
1114  elog(DEBUG2, "found top level transaction %u, with catalog changes",
1115  xid);
1116  needs_snapshot = true;
1117  needs_timetravel = true;
1118  SnapBuildAddCommittedTxn(builder, xid);
1119  }
1120  else if (sub_needs_timetravel)
1121  {
1122  /* track toplevel txn as well, subxact alone isn't meaningful */
1123  elog(DEBUG2, "forced transaction %u to do timetravel due to one of its subtransactions",
1124  xid);
1125  needs_timetravel = true;
1126  SnapBuildAddCommittedTxn(builder, xid);
1127  }
1128  else if (needs_timetravel)
1129  {
1130  elog(DEBUG2, "forced transaction %u to do timetravel", xid);
1131 
1132  SnapBuildAddCommittedTxn(builder, xid);
1133  }
1134 
1135  if (!needs_timetravel)
1136  {
1137  /* record that we cannot export a general snapshot anymore */
1138  builder->committed.includes_all_transactions = false;
1139  }
1140 
1141  Assert(!needs_snapshot || needs_timetravel);
1142 
1143  /*
1144  * Adjust xmax of the snapshot builder, we only do that for committed,
1145  * catalog modifying, transactions, everything else isn't interesting for
1146  * us since we'll never look at the respective rows.
1147  */
1148  if (needs_timetravel &&
1149  (!TransactionIdIsValid(builder->xmax) ||
1150  TransactionIdFollowsOrEquals(xmax, builder->xmax)))
1151  {
1152  builder->xmax = xmax;
1153  TransactionIdAdvance(builder->xmax);
1154  }
1155 
1156  /* if there's any reason to build a historic snapshot, do so now */
1157  if (needs_snapshot)
1158  {
1159  /*
1160  * If we haven't built a complete snapshot yet there's no need to hand
1161  * it out, it wouldn't (and couldn't) be used anyway.
1162  */
1163  if (builder->state < SNAPBUILD_FULL_SNAPSHOT)
1164  return;
1165 
1166  /*
1167  * Decrease the snapshot builder's refcount of the old snapshot, note
1168  * that it still will be used if it has been handed out to the
1169  * reorderbuffer earlier.
1170  */
1171  if (builder->snapshot)
1173 
1174  builder->snapshot = SnapBuildBuildSnapshot(builder);
1175 
1176  /* we might need to execute invalidations, add snapshot */
1177  if (!ReorderBufferXidHasBaseSnapshot(builder->reorder, xid))
1178  {
1180  ReorderBufferSetBaseSnapshot(builder->reorder, xid, lsn,
1181  builder->snapshot);
1182  }
1183 
1184  /* refcount of the snapshot builder for the new snapshot */
1186 
1187  /* add a new catalog snapshot to all currently running transactions */
1189  }
1190 }
#define Assert(condition)
Definition: c.h:861
#define DEBUG2
Definition: elog.h:29
void ReorderBufferSetBaseSnapshot(ReorderBuffer *rb, TransactionId xid, XLogRecPtr lsn, Snapshot snap)
bool ReorderBufferXidHasBaseSnapshot(ReorderBuffer *rb, TransactionId xid)
static void SnapBuildSnapIncRefcount(Snapshot snap)
Definition: snapbuild.c:455
static void SnapBuildAddCommittedTxn(SnapBuild *builder, TransactionId xid)
Definition: snapbuild.c:923
static bool SnapBuildXidHasCatalogChanges(SnapBuild *builder, TransactionId xid, uint32 xinfo)
Definition: snapbuild.c:1197
static Snapshot SnapBuildBuildSnapshot(SnapBuild *builder)
Definition: snapbuild.c:499
static void SnapBuildDistributeNewCatalogSnapshot(SnapBuild *builder, XLogRecPtr lsn)
Definition: snapbuild.c:870
TransactionId xmax
Definition: snapbuild.c:164
TransactionId next_phase_at
Definition: snapbuild.c:220
bool TransactionIdPrecedes(TransactionId id1, TransactionId id2)
Definition: transam.c:280
bool TransactionIdFollowsOrEquals(TransactionId id1, TransactionId id2)
Definition: transam.c:329
#define NormalTransactionIdFollows(id1, id2)
Definition: transam.h:152
#define TransactionIdIsValid(xid)
Definition: transam.h:41
#define TransactionIdAdvance(dest)
Definition: transam.h:91

References Assert, SnapBuild::building_full_snapshot, SnapBuild::committed, DEBUG1, DEBUG2, elog, SnapBuild::includes_all_transactions, SnapBuild::next_phase_at, NormalTransactionIdFollows, SnapBuild::reorder, ReorderBufferSetBaseSnapshot(), ReorderBufferXidHasBaseSnapshot(), SNAPBUILD_BUILDING_SNAPSHOT, SNAPBUILD_CONSISTENT, SNAPBUILD_FULL_SNAPSHOT, SNAPBUILD_START, SnapBuildAddCommittedTxn(), SnapBuildBuildSnapshot(), SnapBuildDistributeNewCatalogSnapshot(), SnapBuildSnapDecRefcount(), SnapBuildSnapIncRefcount(), SnapBuildXidHasCatalogChanges(), SnapBuild::snapshot, SnapBuild::start_decoding_at, SnapBuild::state, TransactionIdAdvance, TransactionIdFollowsOrEquals(), TransactionIdIsValid, TransactionIdPrecedes(), and SnapBuild::xmax.

Referenced by DecodeCommit().

◆ SnapBuildCurrentState()

SnapBuildState SnapBuildCurrentState ( SnapBuild builder)

Definition at line 416 of file snapbuild.c.

417 {
418  return builder->state;
419 }

References SnapBuild::state.

Referenced by DecodePrepare(), DecodingContextReady(), heap2_decode(), heap_decode(), logicalmsg_decode(), ReorderBufferCanStartStreaming(), and xact_decode().

◆ SnapBuildExportSnapshot()

const char* SnapBuildExportSnapshot ( SnapBuild builder)

Definition at line 678 of file snapbuild.c.

679 {
680  Snapshot snap;
681  char *snapname;
682 
684  elog(ERROR, "cannot export a snapshot from within a transaction");
685 
687  elog(ERROR, "can only export one snapshot at a time");
688 
690  ExportInProgress = true;
691 
693 
694  /* There doesn't seem to a nice API to set these */
696  XactReadOnly = true;
697 
698  snap = SnapBuildInitialSnapshot(builder);
699 
700  /*
701  * now that we've built a plain snapshot, make it active and use the
702  * normal mechanisms for exporting it
703  */
704  snapname = ExportSnapshot(snap);
705 
706  ereport(LOG,
707  (errmsg_plural("exported logical decoding snapshot: \"%s\" with %u transaction ID",
708  "exported logical decoding snapshot: \"%s\" with %u transaction IDs",
709  snap->xcnt,
710  snapname, snap->xcnt)));
711  return snapname;
712 }
int errmsg_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...)
Definition: elog.c:1180
Snapshot SnapBuildInitialSnapshot(SnapBuild *builder)
Definition: snapbuild.c:579
char * ExportSnapshot(Snapshot snapshot)
Definition: snapmgr.c:1095
uint32 xcnt
Definition: snapshot.h:169
bool IsTransactionOrTransactionBlock(void)
Definition: xact.c:4982
bool XactReadOnly
Definition: xact.c:81
void StartTransactionCommand(void)
Definition: xact.c:3039
int XactIsoLevel
Definition: xact.c:78
#define XACT_REPEATABLE_READ
Definition: xact.h:38

References CurrentResourceOwner, elog, ereport, errmsg_plural(), ERROR, ExportInProgress, ExportSnapshot(), IsTransactionOrTransactionBlock(), LOG, SavedResourceOwnerDuringExport, SnapBuildInitialSnapshot(), StartTransactionCommand(), XACT_REPEATABLE_READ, XactIsoLevel, XactReadOnly, and SnapshotData::xcnt.

Referenced by CreateReplicationSlot().

◆ SnapBuildGetOrBuildSnapshot()

Snapshot SnapBuildGetOrBuildSnapshot ( SnapBuild builder)

Definition at line 718 of file snapbuild.c.

719 {
720  Assert(builder->state == SNAPBUILD_CONSISTENT);
721 
722  /* only build a new snapshot if we don't have a prebuilt one */
723  if (builder->snapshot == NULL)
724  {
725  builder->snapshot = SnapBuildBuildSnapshot(builder);
726  /* increase refcount for the snapshot builder */
728  }
729 
730  return builder->snapshot;
731 }

References Assert, SNAPBUILD_CONSISTENT, SnapBuildBuildSnapshot(), SnapBuildSnapIncRefcount(), SnapBuild::snapshot, and SnapBuild::state.

Referenced by logicalmsg_decode().

◆ SnapBuildGetTwoPhaseAt()

XLogRecPtr SnapBuildGetTwoPhaseAt ( SnapBuild builder)

Definition at line 425 of file snapbuild.c.

426 {
427  return builder->two_phase_at;
428 }

References SnapBuild::two_phase_at.

Referenced by DecodeCommit().

◆ SnapBuildInitialSnapshot()

Snapshot SnapBuildInitialSnapshot ( SnapBuild builder)

Definition at line 579 of file snapbuild.c.

580 {
581  Snapshot snap;
582  TransactionId xid;
583  TransactionId safeXid;
584  TransactionId *newxip;
585  int newxcnt = 0;
586 
588  Assert(builder->building_full_snapshot);
589 
590  /* don't allow older snapshots */
591  InvalidateCatalogSnapshot(); /* about to overwrite MyProc->xmin */
593  elog(ERROR, "cannot build an initial slot snapshot when snapshots exist");
595 
596  if (builder->state != SNAPBUILD_CONSISTENT)
597  elog(ERROR, "cannot build an initial slot snapshot before reaching a consistent state");
598 
599  if (!builder->committed.includes_all_transactions)
600  elog(ERROR, "cannot build an initial slot snapshot, not all transactions are monitored anymore");
601 
602  /* so we don't overwrite the existing value */
604  elog(ERROR, "cannot build an initial slot snapshot when MyProc->xmin already is valid");
605 
606  snap = SnapBuildBuildSnapshot(builder);
607 
608  /*
609  * We know that snap->xmin is alive, enforced by the logical xmin
610  * mechanism. Due to that we can do this without locks, we're only
611  * changing our own value.
612  *
613  * Building an initial snapshot is expensive and an unenforced xmin
614  * horizon would have bad consequences, therefore always double-check that
615  * the horizon is enforced.
616  */
617  LWLockAcquire(ProcArrayLock, LW_SHARED);
618  safeXid = GetOldestSafeDecodingTransactionId(false);
619  LWLockRelease(ProcArrayLock);
620 
621  if (TransactionIdFollows(safeXid, snap->xmin))
622  elog(ERROR, "cannot build an initial slot snapshot as oldest safe xid %u follows snapshot's xmin %u",
623  safeXid, snap->xmin);
624 
625  MyProc->xmin = snap->xmin;
626 
627  /* allocate in transaction context */
628  newxip = (TransactionId *)
630 
631  /*
632  * snapbuild.c builds transactions in an "inverted" manner, which means it
633  * stores committed transactions in ->xip, not ones in progress. Build a
634  * classical snapshot by marking all non-committed transactions as
635  * in-progress. This can be expensive.
636  */
637  for (xid = snap->xmin; NormalTransactionIdPrecedes(xid, snap->xmax);)
638  {
639  void *test;
640 
641  /*
642  * Check whether transaction committed using the decoding snapshot
643  * meaning of ->xip.
644  */
645  test = bsearch(&xid, snap->xip, snap->xcnt,
646  sizeof(TransactionId), xidComparator);
647 
648  if (test == NULL)
649  {
650  if (newxcnt >= GetMaxSnapshotXidCount())
651  ereport(ERROR,
653  errmsg("initial slot snapshot too large")));
654 
655  newxip[newxcnt++] = xid;
656  }
657 
659  }
660 
661  /* adjust remaining snapshot fields as needed */
663  snap->xcnt = newxcnt;
664  snap->xip = newxip;
665 
666  return snap;
667 }
int errcode(int sqlerrcode)
Definition: elog.c:853
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1168
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1781
@ LW_SHARED
Definition: lwlock.h:115
void * palloc(Size size)
Definition: mcxt.c:1317
#define ERRCODE_T_R_SERIALIZATION_FAILURE
Definition: pgbench.c:76
static void test(void)
TransactionId GetOldestSafeDecodingTransactionId(bool catalogOnly)
Definition: procarray.c:2949
int GetMaxSnapshotXidCount(void)
Definition: procarray.c:2069
bool HistoricSnapshotActive(void)
Definition: snapmgr.c:1672
bool HaveRegisteredOrActiveSnapshot(void)
Definition: snapmgr.c:1624
void InvalidateCatalogSnapshot(void)
Definition: snapmgr.c:422
@ SNAPSHOT_MVCC
Definition: snapshot.h:50
PGPROC * MyProc
Definition: proc.c:67
TransactionId xmin
Definition: proc.h:177
TransactionId xmin
Definition: snapshot.h:157
TransactionId xmax
Definition: snapshot.h:158
SnapshotType snapshot_type
Definition: snapshot.h:144
TransactionId * xip
Definition: snapshot.h:168
bool TransactionIdFollows(TransactionId id1, TransactionId id2)
Definition: transam.c:314
#define NormalTransactionIdPrecedes(id1, id2)
Definition: transam.h:147
int xidComparator(const void *arg1, const void *arg2)
Definition: xid.c:152

References Assert, SnapBuild::building_full_snapshot, SnapBuild::committed, elog, ereport, errcode(), ERRCODE_T_R_SERIALIZATION_FAILURE, errmsg(), ERROR, GetMaxSnapshotXidCount(), GetOldestSafeDecodingTransactionId(), HaveRegisteredOrActiveSnapshot(), HistoricSnapshotActive(), SnapBuild::includes_all_transactions, InvalidateCatalogSnapshot(), LW_SHARED, LWLockAcquire(), LWLockRelease(), MyProc, NormalTransactionIdPrecedes, palloc(), SNAPBUILD_CONSISTENT, SnapBuildBuildSnapshot(), SNAPSHOT_MVCC, SnapshotData::snapshot_type, SnapBuild::state, test(), TransactionIdAdvance, TransactionIdFollows(), TransactionIdIsValid, XACT_REPEATABLE_READ, XactIsoLevel, SnapshotData::xcnt, xidComparator(), SnapshotData::xip, SnapshotData::xmax, PGPROC::xmin, and SnapshotData::xmin.

Referenced by CreateReplicationSlot(), and SnapBuildExportSnapshot().

◆ SnapBuildProcessChange()

bool SnapBuildProcessChange ( SnapBuild builder,
TransactionId  xid,
XLogRecPtr  lsn 
)

Definition at line 778 of file snapbuild.c.

779 {
780  /*
781  * We can't handle data in transactions if we haven't built a snapshot
782  * yet, so don't store them.
783  */
784  if (builder->state < SNAPBUILD_FULL_SNAPSHOT)
785  return false;
786 
787  /*
788  * No point in keeping track of changes in transactions that we don't have
789  * enough information about to decode. This means that they started before
790  * we got into the SNAPBUILD_FULL_SNAPSHOT state.
791  */
792  if (builder->state < SNAPBUILD_CONSISTENT &&
793  TransactionIdPrecedes(xid, builder->next_phase_at))
794  return false;
795 
796  /*
797  * If the reorderbuffer doesn't yet have a snapshot, add one now, it will
798  * be needed to decode the change we're currently processing.
799  */
800  if (!ReorderBufferXidHasBaseSnapshot(builder->reorder, xid))
801  {
802  /* only build a new snapshot if we don't have a prebuilt one */
803  if (builder->snapshot == NULL)
804  {
805  builder->snapshot = SnapBuildBuildSnapshot(builder);
806  /* increase refcount for the snapshot builder */
808  }
809 
810  /*
811  * Increase refcount for the transaction we're handing the snapshot
812  * out to.
813  */
815  ReorderBufferSetBaseSnapshot(builder->reorder, xid, lsn,
816  builder->snapshot);
817  }
818 
819  return true;
820 }

References SnapBuild::next_phase_at, SnapBuild::reorder, ReorderBufferSetBaseSnapshot(), ReorderBufferXidHasBaseSnapshot(), SNAPBUILD_CONSISTENT, SNAPBUILD_FULL_SNAPSHOT, SnapBuildBuildSnapshot(), SnapBuildSnapIncRefcount(), SnapBuild::snapshot, SnapBuild::state, and TransactionIdPrecedes().

Referenced by heap2_decode(), heap_decode(), and logicalmsg_decode().

◆ SnapBuildProcessNewCid()

void SnapBuildProcessNewCid ( SnapBuild builder,
TransactionId  xid,
XLogRecPtr  lsn,
struct xl_heap_new_cid xlrec 
)

Definition at line 828 of file snapbuild.c.

830 {
831  CommandId cid;
832 
833  /*
834  * we only log new_cid's if a catalog tuple was modified, so mark the
835  * transaction as containing catalog modifications
836  */
837  ReorderBufferXidSetCatalogChanges(builder->reorder, xid, lsn);
838 
839  ReorderBufferAddNewTupleCids(builder->reorder, xlrec->top_xid, lsn,
840  xlrec->target_locator, xlrec->target_tid,
841  xlrec->cmin, xlrec->cmax,
842  xlrec->combocid);
843 
844  /* figure out new command id */
845  if (xlrec->cmin != InvalidCommandId &&
846  xlrec->cmax != InvalidCommandId)
847  cid = Max(xlrec->cmin, xlrec->cmax);
848  else if (xlrec->cmax != InvalidCommandId)
849  cid = xlrec->cmax;
850  else if (xlrec->cmin != InvalidCommandId)
851  cid = xlrec->cmin;
852  else
853  {
854  cid = InvalidCommandId; /* silence compiler */
855  elog(ERROR, "xl_heap_new_cid record without a valid CommandId");
856  }
857 
858  ReorderBufferAddNewCommandId(builder->reorder, xid, lsn, cid + 1);
859 }
#define InvalidCommandId
Definition: c.h:672
#define Max(x, y)
Definition: c.h:1001
uint32 CommandId
Definition: c.h:669
void ReorderBufferXidSetCatalogChanges(ReorderBuffer *rb, TransactionId xid, XLogRecPtr lsn)
void ReorderBufferAddNewCommandId(ReorderBuffer *rb, TransactionId xid, XLogRecPtr lsn, CommandId cid)
void ReorderBufferAddNewTupleCids(ReorderBuffer *rb, TransactionId xid, XLogRecPtr lsn, RelFileLocator locator, ItemPointerData tid, CommandId cmin, CommandId cmax, CommandId combocid)
CommandId cmin
Definition: heapam_xlog.h:453
CommandId combocid
Definition: heapam_xlog.h:455
ItemPointerData target_tid
Definition: heapam_xlog.h:461
TransactionId top_xid
Definition: heapam_xlog.h:452
CommandId cmax
Definition: heapam_xlog.h:454
RelFileLocator target_locator
Definition: heapam_xlog.h:460

References xl_heap_new_cid::cmax, xl_heap_new_cid::cmin, xl_heap_new_cid::combocid, elog, ERROR, InvalidCommandId, Max, SnapBuild::reorder, ReorderBufferAddNewCommandId(), ReorderBufferAddNewTupleCids(), ReorderBufferXidSetCatalogChanges(), xl_heap_new_cid::target_locator, xl_heap_new_cid::target_tid, and xl_heap_new_cid::top_xid.

Referenced by heap2_decode().

◆ SnapBuildProcessRunningXacts()

void SnapBuildProcessRunningXacts ( SnapBuild builder,
XLogRecPtr  lsn,
struct xl_running_xacts running 
)

Definition at line 1227 of file snapbuild.c.

1228 {
1229  ReorderBufferTXN *txn;
1230  TransactionId xmin;
1231 
1232  /*
1233  * If we're not consistent yet, inspect the record to see whether it
1234  * allows to get closer to being consistent. If we are consistent, dump
1235  * our snapshot so others or we, after a restart, can use it.
1236  */
1237  if (builder->state < SNAPBUILD_CONSISTENT)
1238  {
1239  /* returns false if there's no point in performing cleanup just yet */
1240  if (!SnapBuildFindSnapshot(builder, lsn, running))
1241  return;
1242  }
1243  else
1244  SnapBuildSerialize(builder, lsn);
1245 
1246  /*
1247  * Update range of interesting xids based on the running xacts
1248  * information. We don't increase ->xmax using it, because once we are in
1249  * a consistent state we can do that ourselves and much more efficiently
1250  * so, because we only need to do it for catalog transactions since we
1251  * only ever look at those.
1252  *
1253  * NB: We only increase xmax when a catalog modifying transaction commits
1254  * (see SnapBuildCommitTxn). Because of this, xmax can be lower than
1255  * xmin, which looks odd but is correct and actually more efficient, since
1256  * we hit fast paths in heapam_visibility.c.
1257  */
1258  builder->xmin = running->oldestRunningXid;
1259 
1260  /* Remove transactions we don't need to keep track off anymore */
1261  SnapBuildPurgeOlderTxn(builder);
1262 
1263  /*
1264  * Advance the xmin limit for the current replication slot, to allow
1265  * vacuum to clean up the tuples this slot has been protecting.
1266  *
1267  * The reorderbuffer might have an xmin among the currently running
1268  * snapshots; use it if so. If not, we need only consider the snapshots
1269  * we'll produce later, which can't be less than the oldest running xid in
1270  * the record we're reading now.
1271  */
1272  xmin = ReorderBufferGetOldestXmin(builder->reorder);
1273  if (xmin == InvalidTransactionId)
1274  xmin = running->oldestRunningXid;
1275  elog(DEBUG3, "xmin: %u, xmax: %u, oldest running: %u, oldest xmin: %u",
1276  builder->xmin, builder->xmax, running->oldestRunningXid, xmin);
1277  LogicalIncreaseXminForSlot(lsn, xmin);
1278 
1279  /*
1280  * Also tell the slot where we can restart decoding from. We don't want to
1281  * do that after every commit because changing that implies an fsync of
1282  * the logical slot's state file, so we only do it every time we see a
1283  * running xacts record.
1284  *
1285  * Do so by looking for the oldest in progress transaction (determined by
1286  * the first LSN of any of its relevant records). Every transaction
1287  * remembers the last location we stored the snapshot to disk before its
1288  * beginning. That point is where we can restart from.
1289  */
1290 
1291  /*
1292  * Can't know about a serialized snapshot's location if we're not
1293  * consistent.
1294  */
1295  if (builder->state < SNAPBUILD_CONSISTENT)
1296  return;
1297 
1298  txn = ReorderBufferGetOldestTXN(builder->reorder);
1299 
1300  /*
1301  * oldest ongoing txn might have started when we didn't yet serialize
1302  * anything because we hadn't reached a consistent state yet.
1303  */
1304  if (txn != NULL && txn->restart_decoding_lsn != InvalidXLogRecPtr)
1306 
1307  /*
1308  * No in-progress transaction, can reuse the last serialized snapshot if
1309  * we have one.
1310  */
1311  else if (txn == NULL &&
1315  builder->last_serialized_snapshot);
1316 }
#define DEBUG3
Definition: elog.h:28
void LogicalIncreaseRestartDecodingForSlot(XLogRecPtr current_lsn, XLogRecPtr restart_lsn)
Definition: logical.c:1761
void LogicalIncreaseXminForSlot(XLogRecPtr current_lsn, TransactionId xmin)
Definition: logical.c:1693
TransactionId ReorderBufferGetOldestXmin(ReorderBuffer *rb)
ReorderBufferTXN * ReorderBufferGetOldestTXN(ReorderBuffer *rb)
static void SnapBuildSerialize(SnapBuild *builder, XLogRecPtr lsn)
Definition: snapbuild.c:1622
static bool SnapBuildFindSnapshot(SnapBuild *builder, XLogRecPtr lsn, xl_running_xacts *running)
Definition: snapbuild.c:1329
static void SnapBuildPurgeOlderTxn(SnapBuild *builder)
Definition: snapbuild.c:957
XLogRecPtr restart_decoding_lsn
XLogRecPtr current_restart_decoding_lsn
TransactionId xmin
Definition: snapbuild.c:161
XLogRecPtr last_serialized_snapshot
Definition: snapbuild.c:208
TransactionId oldestRunningXid
Definition: standbydefs.h:53
#define InvalidTransactionId
Definition: transam.h:31

References ReorderBuffer::current_restart_decoding_lsn, DEBUG3, elog, InvalidTransactionId, InvalidXLogRecPtr, SnapBuild::last_serialized_snapshot, LogicalIncreaseRestartDecodingForSlot(), LogicalIncreaseXminForSlot(), xl_running_xacts::oldestRunningXid, SnapBuild::reorder, ReorderBufferGetOldestTXN(), ReorderBufferGetOldestXmin(), ReorderBufferTXN::restart_decoding_lsn, SNAPBUILD_CONSISTENT, SnapBuildFindSnapshot(), SnapBuildPurgeOlderTxn(), SnapBuildSerialize(), SnapBuild::state, SnapBuild::xmax, and SnapBuild::xmin.

Referenced by standby_decode().

◆ SnapBuildResetExportedSnapshotState()

void SnapBuildResetExportedSnapshotState ( void  )

Definition at line 766 of file snapbuild.c.

767 {
769  ExportInProgress = false;
770 }

References ExportInProgress, and SavedResourceOwnerDuringExport.

Referenced by AbortTransaction().

◆ SnapBuildSerializationPoint()

void SnapBuildSerializationPoint ( SnapBuild builder,
XLogRecPtr  lsn 
)

Definition at line 1609 of file snapbuild.c.

1610 {
1611  if (builder->state < SNAPBUILD_CONSISTENT)
1612  SnapBuildRestore(builder, lsn);
1613  else
1614  SnapBuildSerialize(builder, lsn);
1615 }
static bool SnapBuildRestore(SnapBuild *builder, XLogRecPtr lsn)
Definition: snapbuild.c:1864

References SNAPBUILD_CONSISTENT, SnapBuildRestore(), SnapBuildSerialize(), and SnapBuild::state.

Referenced by xlog_decode().

◆ SnapBuildSetTwoPhaseAt()

void SnapBuildSetTwoPhaseAt ( SnapBuild builder,
XLogRecPtr  ptr 
)

Definition at line 434 of file snapbuild.c.

435 {
436  builder->two_phase_at = ptr;
437 }

References SnapBuild::two_phase_at.

Referenced by CreateDecodingContext().

◆ SnapBuildSnapDecRefcount()

void SnapBuildSnapDecRefcount ( Snapshot  snap)

Definition at line 467 of file snapbuild.c.

468 {
469  /* make sure we don't get passed an external snapshot */
471 
472  /* make sure nobody modified our snapshot */
473  Assert(snap->curcid == FirstCommandId);
474  Assert(!snap->suboverflowed);
475  Assert(!snap->takenDuringRecovery);
476 
477  Assert(snap->regd_count == 0);
478 
479  Assert(snap->active_count > 0);
480 
481  /* slightly more likely, so it's checked even without casserts */
482  if (snap->copied)
483  elog(ERROR, "cannot free a copied snapshot");
484 
485  snap->active_count--;
486  if (snap->active_count == 0)
487  SnapBuildFreeSnapshot(snap);
488 }
#define FirstCommandId
Definition: c.h:671
static void SnapBuildFreeSnapshot(Snapshot snap)
Definition: snapbuild.c:391
@ SNAPSHOT_HISTORIC_MVCC
Definition: snapshot.h:109
bool copied
Definition: snapshot.h:185
uint32 regd_count
Definition: snapshot.h:205
uint32 active_count
Definition: snapshot.h:204
CommandId curcid
Definition: snapshot.h:187
bool suboverflowed
Definition: snapshot.h:182
bool takenDuringRecovery
Definition: snapshot.h:184

References SnapshotData::active_count, Assert, SnapshotData::copied, SnapshotData::curcid, elog, ERROR, FirstCommandId, SnapshotData::regd_count, SnapBuildFreeSnapshot(), SNAPSHOT_HISTORIC_MVCC, SnapshotData::snapshot_type, SnapshotData::suboverflowed, and SnapshotData::takenDuringRecovery.

Referenced by FreeSnapshotBuilder(), ReorderBufferCleanupTXN(), ReorderBufferFreeSnap(), ReorderBufferTransferSnapToParent(), SnapBuildCommitTxn(), and SnapBuildRestore().

◆ SnapBuildSnapshotExists()

bool SnapBuildSnapshotExists ( XLogRecPtr  lsn)

Definition at line 2162 of file snapbuild.c.

2163 {
2164  char path[MAXPGPATH];
2165  int ret;
2166  struct stat stat_buf;
2167 
2168  sprintf(path, "%s/%X-%X.snap",
2170  LSN_FORMAT_ARGS(lsn));
2171 
2172  ret = stat(path, &stat_buf);
2173 
2174  if (ret != 0 && errno != ENOENT)
2175  ereport(ERROR,
2177  errmsg("could not stat file \"%s\": %m", path)));
2178 
2179  return ret == 0;
2180 }
#define sprintf
Definition: port.h:240
#define stat
Definition: win32_port.h:284
#define LSN_FORMAT_ARGS(lsn)
Definition: xlogdefs.h:43

References ereport, errcode_for_file_access(), errmsg(), ERROR, LSN_FORMAT_ARGS, MAXPGPATH, PG_LOGICAL_SNAPSHOTS_DIR, sprintf, and stat.

Referenced by update_local_synced_slot().

◆ SnapBuildXactNeedsSkip()

bool SnapBuildXactNeedsSkip ( SnapBuild builder,
XLogRecPtr  ptr 
)

Definition at line 443 of file snapbuild.c.

444 {
445  return ptr < builder->start_decoding_at;
446 }

References SnapBuild::start_decoding_at.

Referenced by AssertTXNLsnOrder(), DecodeTXNNeedSkip(), logicalmsg_decode(), and ReorderBufferCanStartStreaming().