PostgreSQL Source Code git master
Loading...
Searching...
No Matches
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 ReorderBuffer ReorderBuffer
 
typedef struct SnapBuild SnapBuild
 
typedef struct xl_heap_new_cid xl_heap_new_cid
 
typedef struct xl_running_xacts xl_running_xacts
 

Enumerations

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

Functions

void CheckPointSnapBuild (void)
 
SnapBuildAllocateSnapshotBuilder (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 charSnapBuildExportSnapshot (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, xl_heap_new_cid *xlrec)
 
void SnapBuildProcessRunningXacts (SnapBuild *builder, XLogRecPtr lsn, xl_running_xacts *running)
 
void SnapBuildSerializationPoint (SnapBuild *builder, XLogRecPtr lsn)
 
bool SnapBuildSnapshotExists (XLogRecPtr lsn)
 

Typedef Documentation

◆ ReorderBuffer

Definition at line 21 of file snapbuild.h.

◆ SnapBuild

Definition at line 22 of file snapbuild.h.

◆ xl_heap_new_cid

Definition at line 23 of file snapbuild.h.

◆ xl_running_xacts

Definition at line 24 of file snapbuild.h.

Enumeration Type Documentation

◆ SnapBuildState

Enumerator
SNAPBUILD_START 
SNAPBUILD_BUILDING_SNAPSHOT 
SNAPBUILD_FULL_SNAPSHOT 
SNAPBUILD_CONSISTENT 

Definition at line 30 of file snapbuild.h.

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

Function Documentation

◆ AllocateSnapshotBuilder()

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

Definition at line 189 of file snapbuild.c.

195{
196 MemoryContext context;
197 MemoryContext oldcontext;
198 SnapBuild *builder;
199
200 /* allocate memory in own context, to have better accountability */
202 "snapshot builder context",
204 oldcontext = MemoryContextSwitchTo(context);
205
206 builder = palloc0_object(SnapBuild);
207
208 builder->state = SNAPBUILD_START;
209 builder->context = context;
210 builder->reorder = reorder;
211 /* Other struct members initialized by zeroing via palloc0 above */
212
213 builder->committed.xcnt = 0;
214 builder->committed.xcnt_space = 128; /* arbitrary number */
215 builder->committed.xip =
217 builder->committed.includes_all_transactions = true;
218
219 builder->catchange.xcnt = 0;
220 builder->catchange.xip = NULL;
221
223 builder->start_decoding_at = start_lsn;
224 builder->in_slot_creation = in_slot_creation;
226 builder->two_phase_at = two_phase_at;
227
228 MemoryContextSwitchTo(oldcontext);
229
230 return builder;
231}
uint32 TransactionId
Definition c.h:736
#define palloc0_array(type, count)
Definition fe_memutils.h:92
#define palloc0_object(type)
Definition fe_memutils.h:90
MemoryContext CurrentMemoryContext
Definition mcxt.c:161
#define AllocSetContextCreate
Definition memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition memutils.h:160
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition palloc.h:138
static int fb(int x)
XLogRecPtr start_decoding_at
SnapBuildState state
struct SnapBuild::@119 catchange
TransactionId initial_xmin_horizon
struct SnapBuild::@118 committed
TransactionId * xip
XLogRecPtr two_phase_at
bool building_full_snapshot
bool includes_all_transactions
MemoryContext context
ReorderBuffer * reorder

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, SnapBuild::building_full_snapshot, SnapBuild::catchange, SnapBuild::committed, SnapBuild::context, CurrentMemoryContext, fb(), SnapBuild::in_slot_creation, SnapBuild::includes_all_transactions, SnapBuild::initial_xmin_horizon, MemoryContextSwitchTo(), palloc0_array, palloc0_object, 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  )
extern

Definition at line 1974 of file snapbuild.c.

1975{
1976 XLogRecPtr cutoff;
1977 XLogRecPtr redo;
1978 DIR *snap_dir;
1979 struct dirent *snap_de;
1980 char path[MAXPGPATH + sizeof(PG_LOGICAL_SNAPSHOTS_DIR)];
1981
1982 /*
1983 * We start off with a minimum of the last redo pointer. No new
1984 * replication slot will start before that, so that's a safe upper bound
1985 * for removal.
1986 */
1987 redo = GetRedoRecPtr();
1988
1989 /* now check for the restart ptrs from existing slots */
1991
1992 /* don't start earlier than the restart lsn */
1993 if (redo < cutoff)
1994 cutoff = redo;
1995
1998 {
1999 uint32 hi;
2000 uint32 lo;
2001 XLogRecPtr lsn;
2003
2004 if (strcmp(snap_de->d_name, ".") == 0 ||
2005 strcmp(snap_de->d_name, "..") == 0)
2006 continue;
2007
2008 snprintf(path, sizeof(path), "%s/%s", PG_LOGICAL_SNAPSHOTS_DIR, snap_de->d_name);
2009 de_type = get_dirent_type(path, snap_de, false, DEBUG1);
2010
2012 {
2013 elog(DEBUG1, "only regular files expected: %s", path);
2014 continue;
2015 }
2016
2017 /*
2018 * temporary filenames from SnapBuildSerialize() include the LSN and
2019 * everything but are postfixed by .$pid.tmp. We can just remove them
2020 * the same as other files because there can be none that are
2021 * currently being written that are older than cutoff.
2022 *
2023 * We just log a message if a file doesn't fit the pattern, it's
2024 * probably some editors lock/state file or similar...
2025 */
2026 if (sscanf(snap_de->d_name, "%X-%X.snap", &hi, &lo) != 2)
2027 {
2028 ereport(LOG,
2029 (errmsg("could not parse file name \"%s\"", path)));
2030 continue;
2031 }
2032
2033 lsn = ((uint64) hi) << 32 | lo;
2034
2035 /* check whether we still need it */
2036 if (lsn < cutoff || !XLogRecPtrIsValid(cutoff))
2037 {
2038 elog(DEBUG1, "removing snapbuild snapshot %s", path);
2039
2040 /*
2041 * It's not particularly harmful, though strange, if we can't
2042 * remove the file here. Don't prevent the checkpoint from
2043 * completing, that'd be a cure worse than the disease.
2044 */
2045 if (unlink(path) < 0)
2046 {
2047 ereport(LOG,
2049 errmsg("could not remove file \"%s\": %m",
2050 path)));
2051 continue;
2052 }
2053 }
2054 }
2056}
uint64_t uint64
Definition c.h:625
uint32_t uint32
Definition c.h:624
int errcode_for_file_access(void)
Definition elog.c:898
#define LOG
Definition elog.h:32
#define DEBUG1
Definition elog.h:31
#define elog(elevel,...)
Definition elog.h:228
#define ereport(elevel,...)
Definition elog.h:152
int FreeDir(DIR *dir)
Definition fd.c:3009
DIR * AllocateDir(const char *dirname)
Definition fd.c:2891
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition fd.c:2957
PGFileType get_dirent_type(const char *path, const struct dirent *de, bool look_through_symlinks, int elevel)
Definition file_utils.c:547
PGFileType
Definition file_utils.h:19
@ PGFILETYPE_REG
Definition file_utils.h:22
@ PGFILETYPE_ERROR
Definition file_utils.h:20
static char * errmsg
#define MAXPGPATH
#define snprintf
Definition port.h:261
#define PG_LOGICAL_SNAPSHOTS_DIR
XLogRecPtr ReplicationSlotsComputeLogicalRestartLSN(void)
Definition slot.c:1374
Definition dirent.c:26
XLogRecPtr GetRedoRecPtr(void)
Definition xlog.c:6937
#define XLogRecPtrIsValid(r)
Definition xlogdefs.h:29
uint64 XLogRecPtr
Definition xlogdefs.h:21

References AllocateDir(), DEBUG1, elog, ereport, errcode_for_file_access(), errmsg, fb(), FreeDir(), get_dirent_type(), GetRedoRecPtr(), LOG, MAXPGPATH, PG_LOGICAL_SNAPSHOTS_DIR, PGFILETYPE_ERROR, PGFILETYPE_REG, ReadDir(), ReplicationSlotsComputeLogicalRestartLSN(), snprintf, and XLogRecPtrIsValid.

Referenced by CheckPointGuts().

◆ FreeSnapshotBuilder()

void FreeSnapshotBuilder ( SnapBuild builder)
extern

Definition at line 237 of file snapbuild.c.

238{
239 MemoryContext context = builder->context;
240
241 /* free snapshot explicitly, that contains some error checking */
242 if (builder->snapshot != NULL)
243 {
245 builder->snapshot = NULL;
246 }
247
248 /* other resources are deallocated via memory context reset */
249 MemoryContextDelete(context);
250}
void MemoryContextDelete(MemoryContext context)
Definition mcxt.c:475
void SnapBuildSnapDecRefcount(Snapshot snap)
Definition snapbuild.c:332
Snapshot snapshot

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

Referenced by FreeDecodingContext().

◆ SnapBuildClearExportedSnapshot()

void SnapBuildClearExportedSnapshot ( void  )
extern

Definition at line 603 of file snapbuild.c.

604{
606
607 /* nothing exported, that is the usual case */
608 if (!ExportInProgress)
609 return;
610
611 if (!IsTransactionState())
612 elog(ERROR, "clearing exported snapshot in wrong transaction state");
613
614 /*
615 * AbortCurrentTransaction() takes care of resetting the snapshot state,
616 * so remember SavedResourceOwnerDuringExport.
617 */
619
620 /* make sure nothing could have ever happened */
622
624}
#define ERROR
Definition elog.h:40
ResourceOwner CurrentResourceOwner
Definition resowner.c:173
static ResourceOwner SavedResourceOwnerDuringExport
Definition snapbuild.c:154
static bool ExportInProgress
Definition snapbuild.c:155
bool IsTransactionState(void)
Definition xact.c:389
void AbortCurrentTransaction(void)
Definition xact.c:3501

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

Referenced by exec_replication_command().

◆ SnapBuildCommitTxn()

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

Definition at line 944 of file snapbuild.c.

946{
947 int nxact;
948
949 bool needs_snapshot = false;
950 bool needs_timetravel = false;
951 bool sub_needs_timetravel = false;
952
953 TransactionId xmax = xid;
954
955 /*
956 * Transactions preceding BUILDING_SNAPSHOT will neither be decoded, nor
957 * will they be part of a snapshot. So we don't need to record anything.
958 */
959 if (builder->state == SNAPBUILD_START ||
960 (builder->state == SNAPBUILD_BUILDING_SNAPSHOT &&
961 TransactionIdPrecedes(xid, builder->next_phase_at)))
962 {
963 /* ensure that only commits after this are getting replayed */
964 if (builder->start_decoding_at <= lsn)
965 builder->start_decoding_at = lsn + 1;
966 return;
967 }
968
969 if (builder->state < SNAPBUILD_CONSISTENT)
970 {
971 /* ensure that only commits after this are getting replayed */
972 if (builder->start_decoding_at <= lsn)
973 builder->start_decoding_at = lsn + 1;
974
975 /*
976 * If building an exportable snapshot, force xid to be tracked, even
977 * if the transaction didn't modify the catalog.
978 */
979 if (builder->building_full_snapshot)
980 {
981 needs_timetravel = true;
982 }
983 }
984
985 for (nxact = 0; nxact < nsubxacts; nxact++)
986 {
987 TransactionId subxid = subxacts[nxact];
988
989 /*
990 * Add subtransaction to base snapshot if catalog modifying, we don't
991 * distinguish to toplevel transactions there.
992 */
993 if (SnapBuildXidHasCatalogChanges(builder, subxid, xinfo))
994 {
996 needs_snapshot = true;
997
998 elog(DEBUG1, "found subtransaction %u:%u with catalog changes",
999 xid, subxid);
1000
1001 SnapBuildAddCommittedTxn(builder, subxid);
1002
1003 if (NormalTransactionIdFollows(subxid, xmax))
1004 xmax = subxid;
1005 }
1006
1007 /*
1008 * If we're forcing timetravel we also need visibility information
1009 * about subtransaction, so keep track of subtransaction's state, even
1010 * if not catalog modifying. Don't need to distribute a snapshot in
1011 * that case.
1012 */
1013 else if (needs_timetravel)
1014 {
1015 SnapBuildAddCommittedTxn(builder, subxid);
1016 if (NormalTransactionIdFollows(subxid, xmax))
1017 xmax = subxid;
1018 }
1019 }
1020
1021 /* if top-level modified catalog, it'll need a snapshot */
1022 if (SnapBuildXidHasCatalogChanges(builder, xid, xinfo))
1023 {
1024 elog(DEBUG2, "found top level transaction %u, with catalog changes",
1025 xid);
1026 needs_snapshot = true;
1027 needs_timetravel = true;
1028 SnapBuildAddCommittedTxn(builder, xid);
1029 }
1030 else if (sub_needs_timetravel)
1031 {
1032 /* track toplevel txn as well, subxact alone isn't meaningful */
1033 elog(DEBUG2, "forced transaction %u to do timetravel due to one of its subtransactions",
1034 xid);
1035 needs_timetravel = true;
1036 SnapBuildAddCommittedTxn(builder, xid);
1037 }
1038 else if (needs_timetravel)
1039 {
1040 elog(DEBUG2, "forced transaction %u to do timetravel", xid);
1041
1042 SnapBuildAddCommittedTxn(builder, xid);
1043 }
1044
1045 if (!needs_timetravel)
1046 {
1047 /* record that we cannot export a general snapshot anymore */
1048 builder->committed.includes_all_transactions = false;
1049 }
1050
1052
1053 /*
1054 * Adjust xmax of the snapshot builder, we only do that for committed,
1055 * catalog modifying, transactions, everything else isn't interesting for
1056 * us since we'll never look at the respective rows.
1057 */
1058 if (needs_timetravel &&
1059 (!TransactionIdIsValid(builder->xmax) ||
1060 TransactionIdFollowsOrEquals(xmax, builder->xmax)))
1061 {
1062 builder->xmax = xmax;
1063 TransactionIdAdvance(builder->xmax);
1064 }
1065
1066 /* if there's any reason to build a historic snapshot, do so now */
1067 if (needs_snapshot)
1068 {
1069 /*
1070 * If we haven't built a complete snapshot yet there's no need to hand
1071 * it out, it wouldn't (and couldn't) be used anyway.
1072 */
1073 if (builder->state < SNAPBUILD_FULL_SNAPSHOT)
1074 return;
1075
1076 /*
1077 * Decrease the snapshot builder's refcount of the old snapshot, note
1078 * that it still will be used if it has been handed out to the
1079 * reorderbuffer earlier.
1080 */
1081 if (builder->snapshot)
1083
1084 builder->snapshot = SnapBuildBuildSnapshot(builder);
1085
1086 /* we might need to execute invalidations, add snapshot */
1087 if (!ReorderBufferXidHasBaseSnapshot(builder->reorder, xid))
1088 {
1090 ReorderBufferSetBaseSnapshot(builder->reorder, xid, lsn,
1091 builder->snapshot);
1092 }
1093
1094 /* refcount of the snapshot builder for the new snapshot */
1096
1097 /*
1098 * Add a new catalog snapshot and invalidations messages to all
1099 * currently running transactions.
1100 */
1101 SnapBuildDistributeSnapshotAndInval(builder, lsn, xid);
1102 }
1103}
#define Assert(condition)
Definition c.h:943
#define DEBUG2
Definition elog.h:30
void ReorderBufferSetBaseSnapshot(ReorderBuffer *rb, TransactionId xid, XLogRecPtr lsn, Snapshot snap)
bool ReorderBufferXidHasBaseSnapshot(ReorderBuffer *rb, TransactionId xid)
static void SnapBuildSnapIncRefcount(Snapshot snap)
Definition snapbuild.c:320
static void SnapBuildAddCommittedTxn(SnapBuild *builder, TransactionId xid)
Definition snapbuild.c:832
static bool SnapBuildXidHasCatalogChanges(SnapBuild *builder, TransactionId xid, uint32 xinfo)
Definition snapbuild.c:1110
static Snapshot SnapBuildBuildSnapshot(SnapBuild *builder)
Definition snapbuild.c:364
static void SnapBuildDistributeSnapshotAndInval(SnapBuild *builder, XLogRecPtr lsn, TransactionId xid)
Definition snapbuild.c:734
TransactionId xmax
TransactionId next_phase_at
static bool TransactionIdFollowsOrEquals(TransactionId id1, TransactionId id2)
Definition transam.h:312
#define NormalTransactionIdFollows(id1, id2)
Definition transam.h:152
#define TransactionIdIsValid(xid)
Definition transam.h:41
#define TransactionIdAdvance(dest)
Definition transam.h:91
static bool TransactionIdPrecedes(TransactionId id1, TransactionId id2)
Definition transam.h:263

References Assert, SnapBuild::building_full_snapshot, SnapBuild::committed, DEBUG1, DEBUG2, elog, fb(), 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(), SnapBuildDistributeSnapshotAndInval(), 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)
extern

◆ SnapBuildExportSnapshot()

const char * SnapBuildExportSnapshot ( SnapBuild builder)
extern

Definition at line 542 of file snapbuild.c.

543{
545 char *snapname;
546
548 elog(ERROR, "cannot export a snapshot from within a transaction");
549
551 elog(ERROR, "can only export one snapshot at a time");
552
554 ExportInProgress = true;
555
557
558 /* There doesn't seem to a nice API to set these */
560 XactReadOnly = true;
561
563
564 /*
565 * now that we've built a plain snapshot, make it active and use the
566 * normal mechanisms for exporting it
567 */
569
570 ereport(LOG,
571 (errmsg_plural("exported logical decoding snapshot: \"%s\" with %u transaction ID",
572 "exported logical decoding snapshot: \"%s\" with %u transaction IDs",
573 snap->xcnt,
574 snapname, snap->xcnt)));
575 return snapname;
576}
int int int errmsg_plural(const char *fmt_singular, const char *fmt_plural, unsigned long n,...) pg_attribute_printf(1
Snapshot SnapBuildInitialSnapshot(SnapBuild *builder)
Definition snapbuild.c:444
char * ExportSnapshot(Snapshot snapshot)
Definition snapmgr.c:1115
bool IsTransactionOrTransactionBlock(void)
Definition xact.c:5040
bool XactReadOnly
Definition xact.c:84
void StartTransactionCommand(void)
Definition xact.c:3109
int XactIsoLevel
Definition xact.c:81
#define XACT_REPEATABLE_READ
Definition xact.h:38

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

Referenced by CreateReplicationSlot().

◆ SnapBuildGetOrBuildSnapshot()

Snapshot SnapBuildGetOrBuildSnapshot ( SnapBuild builder)
extern

Definition at line 582 of file snapbuild.c.

583{
584 Assert(builder->state == SNAPBUILD_CONSISTENT);
585
586 /* only build a new snapshot if we don't have a prebuilt one */
587 if (builder->snapshot == NULL)
588 {
589 builder->snapshot = SnapBuildBuildSnapshot(builder);
590 /* increase refcount for the snapshot builder */
592 }
593
594 return builder->snapshot;
595}

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

Referenced by logicalmsg_decode().

◆ SnapBuildGetTwoPhaseAt()

XLogRecPtr SnapBuildGetTwoPhaseAt ( SnapBuild builder)
extern

Definition at line 290 of file snapbuild.c.

291{
292 return builder->two_phase_at;
293}

References SnapBuild::two_phase_at.

Referenced by DecodeCommit().

◆ SnapBuildInitialSnapshot()

Snapshot SnapBuildInitialSnapshot ( SnapBuild builder)
extern

Definition at line 444 of file snapbuild.c.

445{
447 TransactionId xid;
450 int newxcnt = 0;
451
454
455 /* don't allow older snapshots */
456 InvalidateCatalogSnapshot(); /* about to overwrite MyProc->xmin */
458 elog(ERROR, "cannot build an initial slot snapshot when snapshots exist");
460
461 if (builder->state != SNAPBUILD_CONSISTENT)
462 elog(ERROR, "cannot build an initial slot snapshot before reaching a consistent state");
463
465 elog(ERROR, "cannot build an initial slot snapshot, not all transactions are monitored anymore");
466
467 /* so we don't overwrite the existing value */
469 elog(ERROR, "cannot build an initial slot snapshot when MyProc->xmin already is valid");
470
471 snap = SnapBuildBuildSnapshot(builder);
472
473 /*
474 * We know that snap->xmin is alive, enforced by the logical xmin
475 * mechanism. Due to that we can do this without locks, we're only
476 * changing our own value.
477 *
478 * Building an initial snapshot is expensive and an unenforced xmin
479 * horizon would have bad consequences, therefore always double-check that
480 * the horizon is enforced.
481 */
485
487 elog(ERROR, "cannot build an initial slot snapshot as oldest safe xid %u follows snapshot's xmin %u",
488 safeXid, snap->xmin);
489
490 MyProc->xmin = snap->xmin;
491
492 /* allocate in transaction context */
494
495 /*
496 * snapbuild.c builds transactions in an "inverted" manner, which means it
497 * stores committed transactions in ->xip, not ones in progress. Build a
498 * classical snapshot by marking all non-committed transactions as
499 * in-progress. This can be expensive.
500 */
501 for (xid = snap->xmin; NormalTransactionIdPrecedes(xid, snap->xmax);)
502 {
503 void *test;
504
505 /*
506 * Check whether transaction committed using the decoding snapshot
507 * meaning of ->xip.
508 */
509 test = bsearch(&xid, snap->xip, snap->xcnt,
511
512 if (test == NULL)
513 {
517 errmsg("initial slot snapshot too large")));
518
519 newxip[newxcnt++] = xid;
520 }
521
523 }
524
525 /* adjust remaining snapshot fields as needed */
526 snap->snapshot_type = SNAPSHOT_MVCC;
527 snap->xcnt = newxcnt;
528 snap->xip = newxip;
529
530 return snap;
531}
int errcode(int sqlerrcode)
Definition elog.c:875
#define palloc_array(type, count)
Definition fe_memutils.h:91
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition lwlock.c:1150
void LWLockRelease(LWLock *lock)
Definition lwlock.c:1767
@ LW_SHARED
Definition lwlock.h:105
#define ERRCODE_T_R_SERIALIZATION_FAILURE
Definition pgbench.c:77
static void test(void)
TransactionId GetOldestSafeDecodingTransactionId(bool catalogOnly)
Definition procarray.c:2898
int GetMaxSnapshotXidCount(void)
Definition procarray.c:2008
bool HistoricSnapshotActive(void)
Definition snapmgr.c:1692
bool HaveRegisteredOrActiveSnapshot(void)
Definition snapmgr.c:1644
void InvalidateCatalogSnapshot(void)
Definition snapmgr.c:455
@ SNAPSHOT_MVCC
Definition snapshot.h:46
PGPROC * MyProc
Definition proc.c:71
TransactionId xmin
Definition proc.h:242
static bool TransactionIdFollows(TransactionId id1, TransactionId id2)
Definition transam.h:297
#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, fb(), GetMaxSnapshotXidCount(), GetOldestSafeDecodingTransactionId(), HaveRegisteredOrActiveSnapshot(), HistoricSnapshotActive(), SnapBuild::includes_all_transactions, InvalidateCatalogSnapshot(), LW_SHARED, LWLockAcquire(), LWLockRelease(), MyProc, NormalTransactionIdPrecedes, palloc_array, SNAPBUILD_CONSISTENT, SnapBuildBuildSnapshot(), SNAPSHOT_MVCC, SnapBuild::state, test(), TransactionIdAdvance, TransactionIdFollows(), TransactionIdIsValid, XACT_REPEATABLE_READ, XactIsoLevel, xidComparator(), and PGPROC::xmin.

Referenced by CreateReplicationSlot(), RepackWorkerMain(), and SnapBuildExportSnapshot().

◆ SnapBuildProcessChange()

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

Definition at line 642 of file snapbuild.c.

643{
644 /*
645 * We can't handle data in transactions if we haven't built a snapshot
646 * yet, so don't store them.
647 */
648 if (builder->state < SNAPBUILD_FULL_SNAPSHOT)
649 return false;
650
651 /*
652 * No point in keeping track of changes in transactions that we don't have
653 * enough information about to decode. This means that they started before
654 * we got into the SNAPBUILD_FULL_SNAPSHOT state.
655 */
656 if (builder->state < SNAPBUILD_CONSISTENT &&
658 return false;
659
660 /*
661 * If the reorderbuffer doesn't yet have a snapshot, add one now, it will
662 * be needed to decode the change we're currently processing.
663 */
664 if (!ReorderBufferXidHasBaseSnapshot(builder->reorder, xid))
665 {
666 /* only build a new snapshot if we don't have a prebuilt one */
667 if (builder->snapshot == NULL)
668 {
669 builder->snapshot = SnapBuildBuildSnapshot(builder);
670 /* increase refcount for the snapshot builder */
672 }
673
674 /*
675 * Increase refcount for the transaction we're handing the snapshot
676 * out to.
677 */
679 ReorderBufferSetBaseSnapshot(builder->reorder, xid, lsn,
680 builder->snapshot);
681 }
682
683 return true;
684}

References fb(), 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,
xl_heap_new_cid xlrec 
)
extern

Definition at line 692 of file snapbuild.c.

694{
696
697 /*
698 * we only log new_cid's if a catalog tuple was modified, so mark the
699 * transaction as containing catalog modifications
700 */
701 ReorderBufferXidSetCatalogChanges(builder->reorder, xid, lsn);
702
703 ReorderBufferAddNewTupleCids(builder->reorder, xlrec->top_xid, lsn,
704 xlrec->target_locator, xlrec->target_tid,
705 xlrec->cmin, xlrec->cmax,
706 xlrec->combocid);
707
708 /* figure out new command id */
709 if (xlrec->cmin != InvalidCommandId &&
710 xlrec->cmax != InvalidCommandId)
711 cid = Max(xlrec->cmin, xlrec->cmax);
712 else if (xlrec->cmax != InvalidCommandId)
713 cid = xlrec->cmax;
714 else if (xlrec->cmin != InvalidCommandId)
715 cid = xlrec->cmin;
716 else
717 {
718 cid = InvalidCommandId; /* silence compiler */
719 elog(ERROR, "xl_heap_new_cid record without a valid CommandId");
720 }
721
722 ReorderBufferAddNewCommandId(builder->reorder, xid, lsn, cid + 1);
723}
#define InvalidCommandId
Definition c.h:753
#define Max(x, y)
Definition c.h:1085
uint32 CommandId
Definition c.h:750
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)

References elog, ERROR, fb(), InvalidCommandId, Max, SnapBuild::reorder, ReorderBufferAddNewCommandId(), ReorderBufferAddNewTupleCids(), and ReorderBufferXidSetCatalogChanges().

Referenced by heap2_decode().

◆ SnapBuildProcessRunningXacts()

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

Definition at line 1140 of file snapbuild.c.

1141{
1142 ReorderBufferTXN *txn;
1143 TransactionId xmin;
1144
1145 /*
1146 * If we're not consistent yet, inspect the record to see whether it
1147 * allows to get closer to being consistent. If we are consistent, dump
1148 * our snapshot so others or we, after a restart, can use it.
1149 */
1150 if (builder->state < SNAPBUILD_CONSISTENT)
1151 {
1152 /* returns false if there's no point in performing cleanup just yet */
1153 if (!SnapBuildFindSnapshot(builder, lsn, running))
1154 return;
1155 }
1156 else
1157 SnapBuildSerialize(builder, lsn);
1158
1159 /*
1160 * Update range of interesting xids based on the running xacts
1161 * information. We don't increase ->xmax using it, because once we are in
1162 * a consistent state we can do that ourselves and much more efficiently
1163 * so, because we only need to do it for catalog transactions since we
1164 * only ever look at those.
1165 *
1166 * NB: We only increase xmax when a catalog modifying transaction commits
1167 * (see SnapBuildCommitTxn). Because of this, xmax can be lower than
1168 * xmin, which looks odd but is correct and actually more efficient, since
1169 * we hit fast paths in heapam_visibility.c.
1170 */
1171 builder->xmin = running->oldestRunningXid;
1172
1173 /* Remove transactions we don't need to keep track off anymore */
1174 SnapBuildPurgeOlderTxn(builder);
1175
1176 /*
1177 * Advance the xmin limit for the current replication slot, to allow
1178 * vacuum to clean up the tuples this slot has been protecting.
1179 *
1180 * The reorderbuffer might have an xmin among the currently running
1181 * snapshots; use it if so. If not, we need only consider the snapshots
1182 * we'll produce later, which can't be less than the oldest running xid in
1183 * the record we're reading now.
1184 */
1185 xmin = ReorderBufferGetOldestXmin(builder->reorder);
1186 if (xmin == InvalidTransactionId)
1187 xmin = running->oldestRunningXid;
1188 elog(DEBUG3, "xmin: %u, xmax: %u, oldest running: %u, oldest xmin: %u",
1189 builder->xmin, builder->xmax, running->oldestRunningXid, xmin);
1190 LogicalIncreaseXminForSlot(lsn, xmin);
1191
1192 /*
1193 * Also tell the slot where we can restart decoding from. We don't want to
1194 * do that after every commit because changing that implies an fsync of
1195 * the logical slot's state file, so we only do it every time we see a
1196 * running xacts record.
1197 *
1198 * Do so by looking for the oldest in progress transaction (determined by
1199 * the first LSN of any of its relevant records). Every transaction
1200 * remembers the last location we stored the snapshot to disk before its
1201 * beginning. That point is where we can restart from.
1202 */
1203
1204 /*
1205 * Can't know about a serialized snapshot's location if we're not
1206 * consistent.
1207 */
1208 if (builder->state < SNAPBUILD_CONSISTENT)
1209 return;
1210
1211 txn = ReorderBufferGetOldestTXN(builder->reorder);
1212
1213 /*
1214 * oldest ongoing txn might have started when we didn't yet serialize
1215 * anything because we hadn't reached a consistent state yet.
1216 */
1217 if (txn != NULL && XLogRecPtrIsValid(txn->restart_decoding_lsn))
1219
1220 /*
1221 * No in-progress transaction, can reuse the last serialized snapshot if
1222 * we have one.
1223 */
1224 else if (txn == NULL &&
1228 builder->last_serialized_snapshot);
1229}
#define DEBUG3
Definition elog.h:29
void LogicalIncreaseRestartDecodingForSlot(XLogRecPtr current_lsn, XLogRecPtr restart_lsn)
Definition logical.c:1737
void LogicalIncreaseXminForSlot(XLogRecPtr current_lsn, TransactionId xmin)
Definition logical.c:1669
TransactionId ReorderBufferGetOldestXmin(ReorderBuffer *rb)
ReorderBufferTXN * ReorderBufferGetOldestTXN(ReorderBuffer *rb)
static void SnapBuildSerialize(SnapBuild *builder, XLogRecPtr lsn)
Definition snapbuild.c:1501
static bool SnapBuildFindSnapshot(SnapBuild *builder, XLogRecPtr lsn, xl_running_xacts *running)
Definition snapbuild.c:1242
static void SnapBuildPurgeOlderTxn(SnapBuild *builder)
Definition snapbuild.c:867
XLogRecPtr restart_decoding_lsn
XLogRecPtr current_restart_decoding_lsn
TransactionId xmin
XLogRecPtr last_serialized_snapshot
TransactionId oldestRunningXid
Definition standbydefs.h:53
#define InvalidTransactionId
Definition transam.h:31

References ReorderBuffer::current_restart_decoding_lsn, DEBUG3, elog, fb(), InvalidTransactionId, 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, XLogRecPtrIsValid, SnapBuild::xmax, and SnapBuild::xmin.

Referenced by standby_decode().

◆ SnapBuildResetExportedSnapshotState()

void SnapBuildResetExportedSnapshotState ( void  )
extern

Definition at line 630 of file snapbuild.c.

631{
633 ExportInProgress = false;
634}

References ExportInProgress, fb(), and SavedResourceOwnerDuringExport.

Referenced by AbortTransaction().

◆ SnapBuildSerializationPoint()

void SnapBuildSerializationPoint ( SnapBuild builder,
XLogRecPtr  lsn 
)
extern

Definition at line 1488 of file snapbuild.c.

1489{
1490 if (builder->state < SNAPBUILD_CONSISTENT)
1491 SnapBuildRestore(builder, lsn);
1492 else
1493 SnapBuildSerialize(builder, lsn);
1494}
static bool SnapBuildRestore(SnapBuild *builder, XLogRecPtr lsn)
Definition snapbuild.c:1845

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

Referenced by xlog_decode().

◆ SnapBuildSetTwoPhaseAt()

void SnapBuildSetTwoPhaseAt ( SnapBuild builder,
XLogRecPtr  ptr 
)
extern

Definition at line 299 of file snapbuild.c.

300{
301 builder->two_phase_at = ptr;
302}

References SnapBuild::two_phase_at.

Referenced by CreateDecodingContext().

◆ SnapBuildSnapDecRefcount()

void SnapBuildSnapDecRefcount ( Snapshot  snap)
extern

Definition at line 332 of file snapbuild.c.

333{
334 /* make sure we don't get passed an external snapshot */
335 Assert(snap->snapshot_type == SNAPSHOT_HISTORIC_MVCC);
336
337 /* make sure nobody modified our snapshot */
338 Assert(snap->curcid == FirstCommandId);
339 Assert(!snap->suboverflowed);
340 Assert(!snap->takenDuringRecovery);
341
342 Assert(snap->regd_count == 0);
343
344 Assert(snap->active_count > 0);
345
346 /* slightly more likely, so it's checked even without casserts */
347 if (snap->copied)
348 elog(ERROR, "cannot free a copied snapshot");
349
350 snap->active_count--;
351 if (snap->active_count == 0)
353}
#define FirstCommandId
Definition c.h:752
static void SnapBuildFreeSnapshot(Snapshot snap)
Definition snapbuild.c:256
@ SNAPSHOT_HISTORIC_MVCC
Definition snapshot.h:105

References Assert, elog, ERROR, fb(), FirstCommandId, SnapBuildFreeSnapshot(), and SNAPSHOT_HISTORIC_MVCC.

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

◆ SnapBuildSnapshotExists()

bool SnapBuildSnapshotExists ( XLogRecPtr  lsn)
extern

Definition at line 2062 of file snapbuild.c.

2063{
2064 char path[MAXPGPATH];
2065 int ret;
2066 struct stat stat_buf;
2067
2068 sprintf(path, "%s/%X-%X.snap",
2070 LSN_FORMAT_ARGS(lsn));
2071
2072 ret = stat(path, &stat_buf);
2073
2074 if (ret != 0 && errno != ENOENT)
2075 ereport(ERROR,
2077 errmsg("could not stat file \"%s\": %m", path)));
2078
2079 return ret == 0;
2080}
#define sprintf
Definition port.h:263
#define stat
Definition win32_port.h:74
#define LSN_FORMAT_ARGS(lsn)
Definition xlogdefs.h:47

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

Referenced by update_local_synced_slot().

◆ SnapBuildXactNeedsSkip()

bool SnapBuildXactNeedsSkip ( SnapBuild builder,
XLogRecPtr  ptr 
)
extern

Definition at line 308 of file snapbuild.c.

309{
310 return ptr < builder->start_decoding_at;
311}

References SnapBuild::start_decoding_at.

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