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 55 of file snapbuild.h.

Enumeration Type Documentation

◆ SnapBuildState

Enumerator
SNAPBUILD_START 
SNAPBUILD_BUILDING_SNAPSHOT 
SNAPBUILD_FULL_SNAPSHOT 
SNAPBUILD_CONSISTENT 

Definition at line 22 of file snapbuild.h.

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

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 185 of file snapbuild.c.

191{
192 MemoryContext context;
193 MemoryContext oldcontext;
194 SnapBuild *builder;
195
196 /* allocate memory in own context, to have better accountability */
198 "snapshot builder context",
200 oldcontext = MemoryContextSwitchTo(context);
201
202 builder = palloc0(sizeof(SnapBuild));
203
204 builder->state = SNAPBUILD_START;
205 builder->context = context;
206 builder->reorder = reorder;
207 /* Other struct members initialized by zeroing via palloc0 above */
208
209 builder->committed.xcnt = 0;
210 builder->committed.xcnt_space = 128; /* arbitrary number */
211 builder->committed.xip =
212 palloc0(builder->committed.xcnt_space * sizeof(TransactionId));
213 builder->committed.includes_all_transactions = true;
214
215 builder->catchange.xcnt = 0;
216 builder->catchange.xip = NULL;
217
218 builder->initial_xmin_horizon = xmin_horizon;
219 builder->start_decoding_at = start_lsn;
220 builder->in_slot_creation = in_slot_creation;
221 builder->building_full_snapshot = need_full_snapshot;
222 builder->two_phase_at = two_phase_at;
223
224 MemoryContextSwitchTo(oldcontext);
225
226 return builder;
227}
uint32 TransactionId
Definition: c.h:609
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
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:124
XLogRecPtr start_decoding_at
SnapBuildState state
TransactionId initial_xmin_horizon
struct SnapBuild::@117 committed
TransactionId * xip
XLogRecPtr two_phase_at
bool building_full_snapshot
bool includes_all_transactions
MemoryContext context
ReorderBuffer * reorder
struct SnapBuild::@118 catchange

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, SnapBuild::building_full_snapshot, SnapBuild::catchange, SnapBuild::committed, SnapBuild::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 1922 of file snapbuild.c.

1923{
1924 XLogRecPtr cutoff;
1925 XLogRecPtr redo;
1926 DIR *snap_dir;
1927 struct dirent *snap_de;
1928 char path[MAXPGPATH + sizeof(PG_LOGICAL_SNAPSHOTS_DIR)];
1929
1930 /*
1931 * We start off with a minimum of the last redo pointer. No new
1932 * replication slot will start before that, so that's a safe upper bound
1933 * for removal.
1934 */
1935 redo = GetRedoRecPtr();
1936
1937 /* now check for the restart ptrs from existing slots */
1939
1940 /* don't start earlier than the restart lsn */
1941 if (redo < cutoff)
1942 cutoff = redo;
1943
1945 while ((snap_de = ReadDir(snap_dir, PG_LOGICAL_SNAPSHOTS_DIR)) != NULL)
1946 {
1947 uint32 hi;
1948 uint32 lo;
1949 XLogRecPtr lsn;
1950 PGFileType de_type;
1951
1952 if (strcmp(snap_de->d_name, ".") == 0 ||
1953 strcmp(snap_de->d_name, "..") == 0)
1954 continue;
1955
1956 snprintf(path, sizeof(path), "%s/%s", PG_LOGICAL_SNAPSHOTS_DIR, snap_de->d_name);
1957 de_type = get_dirent_type(path, snap_de, false, DEBUG1);
1958
1959 if (de_type != PGFILETYPE_ERROR && de_type != PGFILETYPE_REG)
1960 {
1961 elog(DEBUG1, "only regular files expected: %s", path);
1962 continue;
1963 }
1964
1965 /*
1966 * temporary filenames from SnapBuildSerialize() include the LSN and
1967 * everything but are postfixed by .$pid.tmp. We can just remove them
1968 * the same as other files because there can be none that are
1969 * currently being written that are older than cutoff.
1970 *
1971 * We just log a message if a file doesn't fit the pattern, it's
1972 * probably some editors lock/state file or similar...
1973 */
1974 if (sscanf(snap_de->d_name, "%X-%X.snap", &hi, &lo) != 2)
1975 {
1976 ereport(LOG,
1977 (errmsg("could not parse file name \"%s\"", path)));
1978 continue;
1979 }
1980
1981 lsn = ((uint64) hi) << 32 | lo;
1982
1983 /* check whether we still need it */
1984 if (lsn < cutoff || cutoff == InvalidXLogRecPtr)
1985 {
1986 elog(DEBUG1, "removing snapbuild snapshot %s", path);
1987
1988 /*
1989 * It's not particularly harmful, though strange, if we can't
1990 * remove the file here. Don't prevent the checkpoint from
1991 * completing, that'd be a cure worse than the disease.
1992 */
1993 if (unlink(path) < 0)
1994 {
1995 ereport(LOG,
1997 errmsg("could not remove file \"%s\": %m",
1998 path)));
1999 continue;
2000 }
2001 }
2002 }
2003 FreeDir(snap_dir);
2004}
uint64_t uint64
Definition: c.h:489
uint32_t uint32
Definition: c.h:488
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
int FreeDir(DIR *dir)
Definition: fd.c:2983
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2865
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition: fd.c:2931
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:6437
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 233 of file snapbuild.c.

234{
235 MemoryContext context = builder->context;
236
237 /* free snapshot explicitly, that contains some error checking */
238 if (builder->snapshot != NULL)
239 {
241 builder->snapshot = NULL;
242 }
243
244 /* other resources are deallocated via memory context reset */
245 MemoryContextDelete(context);
246}
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:454
void SnapBuildSnapDecRefcount(Snapshot snap)
Definition: snapbuild.c:328
Snapshot snapshot

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

Referenced by FreeDecodingContext().

◆ SnapBuildClearExportedSnapshot()

void SnapBuildClearExportedSnapshot ( void  )

Definition at line 600 of file snapbuild.c.

601{
602 ResourceOwner tmpResOwner;
603
604 /* nothing exported, that is the usual case */
605 if (!ExportInProgress)
606 return;
607
608 if (!IsTransactionState())
609 elog(ERROR, "clearing exported snapshot in wrong transaction state");
610
611 /*
612 * AbortCurrentTransaction() takes care of resetting the snapshot state,
613 * so remember SavedResourceOwnerDuringExport.
614 */
615 tmpResOwner = SavedResourceOwnerDuringExport;
616
617 /* make sure nothing could have ever happened */
619
620 CurrentResourceOwner = tmpResOwner;
621}
#define ERROR
Definition: elog.h:39
ResourceOwner CurrentResourceOwner
Definition: resowner.c:165
static ResourceOwner SavedResourceOwnerDuringExport
Definition: snapbuild.c:151
static bool ExportInProgress
Definition: snapbuild.c:152
bool IsTransactionState(void)
Definition: xact.c:386
void AbortCurrentTransaction(void)
Definition: xact.c:3443

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 895 of file snapbuild.c.

897{
898 int nxact;
899
900 bool needs_snapshot = false;
901 bool needs_timetravel = false;
902 bool sub_needs_timetravel = false;
903
904 TransactionId xmax = xid;
905
906 /*
907 * Transactions preceding BUILDING_SNAPSHOT will neither be decoded, nor
908 * will they be part of a snapshot. So we don't need to record anything.
909 */
910 if (builder->state == SNAPBUILD_START ||
911 (builder->state == SNAPBUILD_BUILDING_SNAPSHOT &&
912 TransactionIdPrecedes(xid, builder->next_phase_at)))
913 {
914 /* ensure that only commits after this are getting replayed */
915 if (builder->start_decoding_at <= lsn)
916 builder->start_decoding_at = lsn + 1;
917 return;
918 }
919
920 if (builder->state < SNAPBUILD_CONSISTENT)
921 {
922 /* ensure that only commits after this are getting replayed */
923 if (builder->start_decoding_at <= lsn)
924 builder->start_decoding_at = lsn + 1;
925
926 /*
927 * If building an exportable snapshot, force xid to be tracked, even
928 * if the transaction didn't modify the catalog.
929 */
930 if (builder->building_full_snapshot)
931 {
932 needs_timetravel = true;
933 }
934 }
935
936 for (nxact = 0; nxact < nsubxacts; nxact++)
937 {
938 TransactionId subxid = subxacts[nxact];
939
940 /*
941 * Add subtransaction to base snapshot if catalog modifying, we don't
942 * distinguish to toplevel transactions there.
943 */
944 if (SnapBuildXidHasCatalogChanges(builder, subxid, xinfo))
945 {
946 sub_needs_timetravel = true;
947 needs_snapshot = true;
948
949 elog(DEBUG1, "found subtransaction %u:%u with catalog changes",
950 xid, subxid);
951
952 SnapBuildAddCommittedTxn(builder, subxid);
953
954 if (NormalTransactionIdFollows(subxid, xmax))
955 xmax = subxid;
956 }
957
958 /*
959 * If we're forcing timetravel we also need visibility information
960 * about subtransaction, so keep track of subtransaction's state, even
961 * if not catalog modifying. Don't need to distribute a snapshot in
962 * that case.
963 */
964 else if (needs_timetravel)
965 {
966 SnapBuildAddCommittedTxn(builder, subxid);
967 if (NormalTransactionIdFollows(subxid, xmax))
968 xmax = subxid;
969 }
970 }
971
972 /* if top-level modified catalog, it'll need a snapshot */
973 if (SnapBuildXidHasCatalogChanges(builder, xid, xinfo))
974 {
975 elog(DEBUG2, "found top level transaction %u, with catalog changes",
976 xid);
977 needs_snapshot = true;
978 needs_timetravel = true;
979 SnapBuildAddCommittedTxn(builder, xid);
980 }
981 else if (sub_needs_timetravel)
982 {
983 /* track toplevel txn as well, subxact alone isn't meaningful */
984 elog(DEBUG2, "forced transaction %u to do timetravel due to one of its subtransactions",
985 xid);
986 needs_timetravel = true;
987 SnapBuildAddCommittedTxn(builder, xid);
988 }
989 else if (needs_timetravel)
990 {
991 elog(DEBUG2, "forced transaction %u to do timetravel", xid);
992
993 SnapBuildAddCommittedTxn(builder, xid);
994 }
995
996 if (!needs_timetravel)
997 {
998 /* record that we cannot export a general snapshot anymore */
999 builder->committed.includes_all_transactions = false;
1000 }
1001
1002 Assert(!needs_snapshot || needs_timetravel);
1003
1004 /*
1005 * Adjust xmax of the snapshot builder, we only do that for committed,
1006 * catalog modifying, transactions, everything else isn't interesting for
1007 * us since we'll never look at the respective rows.
1008 */
1009 if (needs_timetravel &&
1010 (!TransactionIdIsValid(builder->xmax) ||
1011 TransactionIdFollowsOrEquals(xmax, builder->xmax)))
1012 {
1013 builder->xmax = xmax;
1014 TransactionIdAdvance(builder->xmax);
1015 }
1016
1017 /* if there's any reason to build a historic snapshot, do so now */
1018 if (needs_snapshot)
1019 {
1020 /*
1021 * If we haven't built a complete snapshot yet there's no need to hand
1022 * it out, it wouldn't (and couldn't) be used anyway.
1023 */
1024 if (builder->state < SNAPBUILD_FULL_SNAPSHOT)
1025 return;
1026
1027 /*
1028 * Decrease the snapshot builder's refcount of the old snapshot, note
1029 * that it still will be used if it has been handed out to the
1030 * reorderbuffer earlier.
1031 */
1032 if (builder->snapshot)
1034
1035 builder->snapshot = SnapBuildBuildSnapshot(builder);
1036
1037 /* we might need to execute invalidations, add snapshot */
1038 if (!ReorderBufferXidHasBaseSnapshot(builder->reorder, xid))
1039 {
1041 ReorderBufferSetBaseSnapshot(builder->reorder, xid, lsn,
1042 builder->snapshot);
1043 }
1044
1045 /* refcount of the snapshot builder for the new snapshot */
1047
1048 /* add a new catalog snapshot to all currently running transactions */
1050 }
1051}
#define Assert(condition)
Definition: c.h:815
#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:316
static void SnapBuildAddCommittedTxn(SnapBuild *builder, TransactionId xid)
Definition: snapbuild.c:784
static bool SnapBuildXidHasCatalogChanges(SnapBuild *builder, TransactionId xid, uint32 xinfo)
Definition: snapbuild.c:1058
static Snapshot SnapBuildBuildSnapshot(SnapBuild *builder)
Definition: snapbuild.c:360
static void SnapBuildDistributeNewCatalogSnapshot(SnapBuild *builder, XLogRecPtr lsn)
Definition: snapbuild.c:731
TransactionId xmax
TransactionId next_phase_at
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)

◆ SnapBuildExportSnapshot()

const char * SnapBuildExportSnapshot ( SnapBuild builder)

Definition at line 539 of file snapbuild.c.

540{
541 Snapshot snap;
542 char *snapname;
543
545 elog(ERROR, "cannot export a snapshot from within a transaction");
546
548 elog(ERROR, "can only export one snapshot at a time");
549
551 ExportInProgress = true;
552
554
555 /* There doesn't seem to a nice API to set these */
557 XactReadOnly = true;
558
559 snap = SnapBuildInitialSnapshot(builder);
560
561 /*
562 * now that we've built a plain snapshot, make it active and use the
563 * normal mechanisms for exporting it
564 */
565 snapname = ExportSnapshot(snap);
566
567 ereport(LOG,
568 (errmsg_plural("exported logical decoding snapshot: \"%s\" with %u transaction ID",
569 "exported logical decoding snapshot: \"%s\" with %u transaction IDs",
570 snap->xcnt,
571 snapname, snap->xcnt)));
572 return snapname;
573}
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:440
char * ExportSnapshot(Snapshot snapshot)
Definition: snapmgr.c:1043
uint32 xcnt
Definition: snapshot.h:165
bool IsTransactionOrTransactionBlock(void)
Definition: xact.c:4981
bool XactReadOnly
Definition: xact.c:81
void StartTransactionCommand(void)
Definition: xact.c:3051
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 579 of file snapbuild.c.

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

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

Referenced by logicalmsg_decode().

◆ SnapBuildGetTwoPhaseAt()

XLogRecPtr SnapBuildGetTwoPhaseAt ( SnapBuild builder)

Definition at line 286 of file snapbuild.c.

287{
288 return builder->two_phase_at;
289}

References SnapBuild::two_phase_at.

Referenced by DecodeCommit().

◆ SnapBuildInitialSnapshot()

Snapshot SnapBuildInitialSnapshot ( SnapBuild builder)

Definition at line 440 of file snapbuild.c.

441{
442 Snapshot snap;
443 TransactionId xid;
444 TransactionId safeXid;
445 TransactionId *newxip;
446 int newxcnt = 0;
447
450
451 /* don't allow older snapshots */
452 InvalidateCatalogSnapshot(); /* about to overwrite MyProc->xmin */
454 elog(ERROR, "cannot build an initial slot snapshot when snapshots exist");
456
457 if (builder->state != SNAPBUILD_CONSISTENT)
458 elog(ERROR, "cannot build an initial slot snapshot before reaching a consistent state");
459
461 elog(ERROR, "cannot build an initial slot snapshot, not all transactions are monitored anymore");
462
463 /* so we don't overwrite the existing value */
465 elog(ERROR, "cannot build an initial slot snapshot when MyProc->xmin already is valid");
466
467 snap = SnapBuildBuildSnapshot(builder);
468
469 /*
470 * We know that snap->xmin is alive, enforced by the logical xmin
471 * mechanism. Due to that we can do this without locks, we're only
472 * changing our own value.
473 *
474 * Building an initial snapshot is expensive and an unenforced xmin
475 * horizon would have bad consequences, therefore always double-check that
476 * the horizon is enforced.
477 */
478 LWLockAcquire(ProcArrayLock, LW_SHARED);
479 safeXid = GetOldestSafeDecodingTransactionId(false);
480 LWLockRelease(ProcArrayLock);
481
482 if (TransactionIdFollows(safeXid, snap->xmin))
483 elog(ERROR, "cannot build an initial slot snapshot as oldest safe xid %u follows snapshot's xmin %u",
484 safeXid, snap->xmin);
485
486 MyProc->xmin = snap->xmin;
487
488 /* allocate in transaction context */
489 newxip = (TransactionId *)
491
492 /*
493 * snapbuild.c builds transactions in an "inverted" manner, which means it
494 * stores committed transactions in ->xip, not ones in progress. Build a
495 * classical snapshot by marking all non-committed transactions as
496 * in-progress. This can be expensive.
497 */
498 for (xid = snap->xmin; NormalTransactionIdPrecedes(xid, snap->xmax);)
499 {
500 void *test;
501
502 /*
503 * Check whether transaction committed using the decoding snapshot
504 * meaning of ->xip.
505 */
506 test = bsearch(&xid, snap->xip, snap->xcnt,
508
509 if (test == NULL)
510 {
511 if (newxcnt >= GetMaxSnapshotXidCount())
514 errmsg("initial slot snapshot too large")));
515
516 newxip[newxcnt++] = xid;
517 }
518
520 }
521
522 /* adjust remaining snapshot fields as needed */
524 snap->xcnt = newxcnt;
525 snap->xip = newxip;
526
527 return snap;
528}
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:2945
int GetMaxSnapshotXidCount(void)
Definition: procarray.c:2069
bool HistoricSnapshotActive(void)
Definition: snapmgr.c:1620
bool HaveRegisteredOrActiveSnapshot(void)
Definition: snapmgr.c:1572
void InvalidateCatalogSnapshot(void)
Definition: snapmgr.c:384
@ SNAPSHOT_MVCC
Definition: snapshot.h:46
PGPROC * MyProc
Definition: proc.c:66
TransactionId xmin
Definition: proc.h:177
TransactionId xmin
Definition: snapshot.h:153
TransactionId xmax
Definition: snapshot.h:154
SnapshotType snapshot_type
Definition: snapshot.h:140
TransactionId * xip
Definition: snapshot.h:164
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 639 of file snapbuild.c.

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

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 689 of file snapbuild.c.

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

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 1088 of file snapbuild.c.

1089{
1090 ReorderBufferTXN *txn;
1091 TransactionId xmin;
1092
1093 /*
1094 * If we're not consistent yet, inspect the record to see whether it
1095 * allows to get closer to being consistent. If we are consistent, dump
1096 * our snapshot so others or we, after a restart, can use it.
1097 */
1098 if (builder->state < SNAPBUILD_CONSISTENT)
1099 {
1100 /* returns false if there's no point in performing cleanup just yet */
1101 if (!SnapBuildFindSnapshot(builder, lsn, running))
1102 return;
1103 }
1104 else
1105 SnapBuildSerialize(builder, lsn);
1106
1107 /*
1108 * Update range of interesting xids based on the running xacts
1109 * information. We don't increase ->xmax using it, because once we are in
1110 * a consistent state we can do that ourselves and much more efficiently
1111 * so, because we only need to do it for catalog transactions since we
1112 * only ever look at those.
1113 *
1114 * NB: We only increase xmax when a catalog modifying transaction commits
1115 * (see SnapBuildCommitTxn). Because of this, xmax can be lower than
1116 * xmin, which looks odd but is correct and actually more efficient, since
1117 * we hit fast paths in heapam_visibility.c.
1118 */
1119 builder->xmin = running->oldestRunningXid;
1120
1121 /* Remove transactions we don't need to keep track off anymore */
1122 SnapBuildPurgeOlderTxn(builder);
1123
1124 /*
1125 * Advance the xmin limit for the current replication slot, to allow
1126 * vacuum to clean up the tuples this slot has been protecting.
1127 *
1128 * The reorderbuffer might have an xmin among the currently running
1129 * snapshots; use it if so. If not, we need only consider the snapshots
1130 * we'll produce later, which can't be less than the oldest running xid in
1131 * the record we're reading now.
1132 */
1133 xmin = ReorderBufferGetOldestXmin(builder->reorder);
1134 if (xmin == InvalidTransactionId)
1135 xmin = running->oldestRunningXid;
1136 elog(DEBUG3, "xmin: %u, xmax: %u, oldest running: %u, oldest xmin: %u",
1137 builder->xmin, builder->xmax, running->oldestRunningXid, xmin);
1138 LogicalIncreaseXminForSlot(lsn, xmin);
1139
1140 /*
1141 * Also tell the slot where we can restart decoding from. We don't want to
1142 * do that after every commit because changing that implies an fsync of
1143 * the logical slot's state file, so we only do it every time we see a
1144 * running xacts record.
1145 *
1146 * Do so by looking for the oldest in progress transaction (determined by
1147 * the first LSN of any of its relevant records). Every transaction
1148 * remembers the last location we stored the snapshot to disk before its
1149 * beginning. That point is where we can restart from.
1150 */
1151
1152 /*
1153 * Can't know about a serialized snapshot's location if we're not
1154 * consistent.
1155 */
1156 if (builder->state < SNAPBUILD_CONSISTENT)
1157 return;
1158
1159 txn = ReorderBufferGetOldestTXN(builder->reorder);
1160
1161 /*
1162 * oldest ongoing txn might have started when we didn't yet serialize
1163 * anything because we hadn't reached a consistent state yet.
1164 */
1165 if (txn != NULL && txn->restart_decoding_lsn != InvalidXLogRecPtr)
1167
1168 /*
1169 * No in-progress transaction, can reuse the last serialized snapshot if
1170 * we have one.
1171 */
1172 else if (txn == NULL &&
1176 builder->last_serialized_snapshot);
1177}
#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:1449
static bool SnapBuildFindSnapshot(SnapBuild *builder, XLogRecPtr lsn, xl_running_xacts *running)
Definition: snapbuild.c:1190
static void SnapBuildPurgeOlderTxn(SnapBuild *builder)
Definition: snapbuild.c:818
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, 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 627 of file snapbuild.c.

628{
630 ExportInProgress = false;
631}

References ExportInProgress, and SavedResourceOwnerDuringExport.

Referenced by AbortTransaction().

◆ SnapBuildSerializationPoint()

void SnapBuildSerializationPoint ( SnapBuild builder,
XLogRecPtr  lsn 
)

Definition at line 1436 of file snapbuild.c.

1437{
1438 if (builder->state < SNAPBUILD_CONSISTENT)
1439 SnapBuildRestore(builder, lsn);
1440 else
1441 SnapBuildSerialize(builder, lsn);
1442}
static bool SnapBuildRestore(SnapBuild *builder, XLogRecPtr lsn)
Definition: snapbuild.c:1788

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

Referenced by xlog_decode().

◆ SnapBuildSetTwoPhaseAt()

void SnapBuildSetTwoPhaseAt ( SnapBuild builder,
XLogRecPtr  ptr 
)

Definition at line 295 of file snapbuild.c.

296{
297 builder->two_phase_at = ptr;
298}

References SnapBuild::two_phase_at.

Referenced by CreateDecodingContext().

◆ SnapBuildSnapDecRefcount()

void SnapBuildSnapDecRefcount ( Snapshot  snap)

Definition at line 328 of file snapbuild.c.

329{
330 /* make sure we don't get passed an external snapshot */
332
333 /* make sure nobody modified our snapshot */
334 Assert(snap->curcid == FirstCommandId);
335 Assert(!snap->suboverflowed);
337
338 Assert(snap->regd_count == 0);
339
340 Assert(snap->active_count > 0);
341
342 /* slightly more likely, so it's checked even without casserts */
343 if (snap->copied)
344 elog(ERROR, "cannot free a copied snapshot");
345
346 snap->active_count--;
347 if (snap->active_count == 0)
349}
#define FirstCommandId
Definition: c.h:625
static void SnapBuildFreeSnapshot(Snapshot snap)
Definition: snapbuild.c:252
@ SNAPSHOT_HISTORIC_MVCC
Definition: snapshot.h:105
bool copied
Definition: snapshot.h:181
uint32 regd_count
Definition: snapshot.h:201
uint32 active_count
Definition: snapshot.h:200
CommandId curcid
Definition: snapshot.h:183
bool suboverflowed
Definition: snapshot.h:178
bool takenDuringRecovery
Definition: snapshot.h:180

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 2010 of file snapbuild.c.

2011{
2012 char path[MAXPGPATH];
2013 int ret;
2014 struct stat stat_buf;
2015
2016 sprintf(path, "%s/%X-%X.snap",
2018 LSN_FORMAT_ARGS(lsn));
2019
2020 ret = stat(path, &stat_buf);
2021
2022 if (ret != 0 && errno != ENOENT)
2023 ereport(ERROR,
2025 errmsg("could not stat file \"%s\": %m", path)));
2026
2027 return ret == 0;
2028}
#define sprintf
Definition: port.h:240
#define stat
Definition: win32_port.h:274
#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 304 of file snapbuild.c.

305{
306 return ptr < builder->start_decoding_at;
307}

References SnapBuild::start_decoding_at.

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