PostgreSQL Source Code git master
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Macros | Functions
pg_logicalinspect.c File Reference
#include "postgres.h"
#include "funcapi.h"
#include "replication/snapbuild_internal.h"
#include "utils/array.h"
#include "utils/builtins.h"
#include "utils/pg_lsn.h"
Include dependency graph for pg_logicalinspect.c:

Go to the source code of this file.

Macros

#define PG_GET_LOGICAL_SNAPSHOT_META_COLS   3
 
#define PG_GET_LOGICAL_SNAPSHOT_INFO_COLS   14
 

Functions

 PG_MODULE_MAGIC_EXT (.name="pg_logicalinspect",.version=PG_VERSION)
 
 PG_FUNCTION_INFO_V1 (pg_get_logical_snapshot_meta)
 
 PG_FUNCTION_INFO_V1 (pg_get_logical_snapshot_info)
 
static const char * get_snapbuild_state_desc (SnapBuildState state)
 
static XLogRecPtr parse_snapshot_filename (const char *filename)
 
Datum pg_get_logical_snapshot_meta (PG_FUNCTION_ARGS)
 
Datum pg_get_logical_snapshot_info (PG_FUNCTION_ARGS)
 

Macro Definition Documentation

◆ PG_GET_LOGICAL_SNAPSHOT_INFO_COLS

#define PG_GET_LOGICAL_SNAPSHOT_INFO_COLS   14

◆ PG_GET_LOGICAL_SNAPSHOT_META_COLS

#define PG_GET_LOGICAL_SNAPSHOT_META_COLS   3

Function Documentation

◆ get_snapbuild_state_desc()

static const char * get_snapbuild_state_desc ( SnapBuildState  state)
static

Definition at line 31 of file pg_logicalinspect.c.

32{
33 const char *stateDesc = "unknown state";
34
35 switch (state)
36 {
37 case SNAPBUILD_START:
38 stateDesc = "start";
39 break;
40 case SNAPBUILD_BUILDING_SNAPSHOT:
41 stateDesc = "building";
42 break;
43 case SNAPBUILD_FULL_SNAPSHOT:
44 stateDesc = "full";
45 break;
46 case SNAPBUILD_CONSISTENT:
47 stateDesc = "consistent";
48 break;
49 }
50
51 return stateDesc;
52}
SNAPBUILD_START
@ SNAPBUILD_START
Definition: snapbuild.h:27
SNAPBUILD_BUILDING_SNAPSHOT
@ SNAPBUILD_BUILDING_SNAPSHOT
Definition: snapbuild.h:33
SNAPBUILD_FULL_SNAPSHOT
@ SNAPBUILD_FULL_SNAPSHOT
Definition: snapbuild.h:43
SNAPBUILD_CONSISTENT
@ SNAPBUILD_CONSISTENT
Definition: snapbuild.h:50
state
Definition: regguts.h:323

References SNAPBUILD_BUILDING_SNAPSHOT, SNAPBUILD_CONSISTENT, SNAPBUILD_FULL_SNAPSHOT, and SNAPBUILD_START.

Referenced by pg_get_logical_snapshot_info().

◆ parse_snapshot_filename()

static XLogRecPtr parse_snapshot_filename ( const char *  filename)
static

Definition at line 58 of file pg_logicalinspect.c.

59{
60 uint32 hi;
61 uint32 lo;
62 XLogRecPtr lsn;
63 char tmpfname[MAXPGPATH];
64
65 /*
66 * Extract the values to build the LSN.
67 *
68 * Note: Including ".snap" doesn't mean that sscanf() also does the format
69 * check including the suffix. The subsequent check validates if the given
70 * filename has the expected suffix.
71 */
72 if (sscanf(filename, "%X-%X.snap", &hi, &lo) != 2)
73 goto parse_error;
74
75 /*
76 * Bring back the extracted LSN to the snapshot file format and compare it
77 * to the given filename. This check strictly checks if the given filename
78 * follows the format of the snapshot filename.
79 */
80 sprintf(tmpfname, "%X-%X.snap", hi, lo);
81 if (strcmp(tmpfname, filename) != 0)
82 goto parse_error;
83
84 lsn = ((uint64) hi) << 32 | lo;
85
86 return lsn;
87
88parse_error:
89 ereport(ERROR,
90 errmsg("invalid snapshot file name \"%s\"", filename));
91
92 return InvalidXLogRecPtr; /* keep compiler quiet */
93}
uint64
uint64_t uint64
Definition: c.h:503
uint32
uint32_t uint32
Definition: c.h:502
errmsg
int errmsg(const char *fmt,...)
Definition: elog.c:1070
ERROR
#define ERROR
Definition: elog.h:39
ereport
#define ereport(elevel,...)
Definition: elog.h:149
MAXPGPATH
#define MAXPGPATH
Definition: pg_config_manual.h:100
filename
static char * filename
Definition: pg_dumpall.c:127
sprintf
#define sprintf
Definition: port.h:241
XLogRecPtr
uint64 XLogRecPtr
Definition: xlogdefs.h:21
InvalidXLogRecPtr
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28

References ereport, errmsg(), ERROR, filename, InvalidXLogRecPtr, MAXPGPATH, and sprintf.

Referenced by pg_get_logical_snapshot_info(), and pg_get_logical_snapshot_meta().

◆ PG_FUNCTION_INFO_V1() [1/2]

PG_FUNCTION_INFO_V1 ( pg_get_logical_snapshot_info  )

◆ PG_FUNCTION_INFO_V1() [2/2]

PG_FUNCTION_INFO_V1 ( pg_get_logical_snapshot_meta  )

◆ pg_get_logical_snapshot_info()

Datum pg_get_logical_snapshot_info ( PG_FUNCTION_ARGS  )

Definition at line 134 of file pg_logicalinspect.c.

135{
136#define PG_GET_LOGICAL_SNAPSHOT_INFO_COLS 14
137 SnapBuildOnDisk ondisk;
138 HeapTuple tuple;
139 Datum values[PG_GET_LOGICAL_SNAPSHOT_INFO_COLS] = {0};
140 bool nulls[PG_GET_LOGICAL_SNAPSHOT_INFO_COLS] = {0};
141 TupleDesc tupdesc;
142 XLogRecPtr lsn;
143 int i = 0;
144 text *filename_t = PG_GETARG_TEXT_PP(0);
145
146 /* Build a tuple descriptor for our result type */
147 if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
148 elog(ERROR, "return type must be a row type");
149
150 lsn = parse_snapshot_filename(text_to_cstring(filename_t));
151
152 /* Validate and restore the snapshot to 'ondisk' */
153 SnapBuildRestoreSnapshot(&ondisk, lsn, CurrentMemoryContext, false);
154
155 values[i++] = CStringGetTextDatum(get_snapbuild_state_desc(ondisk.builder.state));
156 values[i++] = TransactionIdGetDatum(ondisk.builder.xmin);
157 values[i++] = TransactionIdGetDatum(ondisk.builder.xmax);
158 values[i++] = LSNGetDatum(ondisk.builder.start_decoding_at);
159 values[i++] = LSNGetDatum(ondisk.builder.two_phase_at);
160 values[i++] = TransactionIdGetDatum(ondisk.builder.initial_xmin_horizon);
161 values[i++] = BoolGetDatum(ondisk.builder.building_full_snapshot);
162 values[i++] = BoolGetDatum(ondisk.builder.in_slot_creation);
163 values[i++] = LSNGetDatum(ondisk.builder.last_serialized_snapshot);
164 values[i++] = TransactionIdGetDatum(ondisk.builder.next_phase_at);
165
166 values[i++] = UInt32GetDatum(ondisk.builder.committed.xcnt);
167 if (ondisk.builder.committed.xcnt > 0)
168 {
169 Datum *arrayelems;
170
171 arrayelems = (Datum *) palloc(ondisk.builder.committed.xcnt * sizeof(Datum));
172
173 for (int j = 0; j < ondisk.builder.committed.xcnt; j++)
174 arrayelems[j] = TransactionIdGetDatum(ondisk.builder.committed.xip[j]);
175
176 values[i++] = PointerGetDatum(construct_array_builtin(arrayelems,
177 ondisk.builder.committed.xcnt,
178 XIDOID));
179 }
180 else
181 nulls[i++] = true;
182
183 values[i++] = UInt32GetDatum(ondisk.builder.catchange.xcnt);
184 if (ondisk.builder.catchange.xcnt > 0)
185 {
186 Datum *arrayelems;
187
188 arrayelems = (Datum *) palloc(ondisk.builder.catchange.xcnt * sizeof(Datum));
189
190 for (int j = 0; j < ondisk.builder.catchange.xcnt; j++)
191 arrayelems[j] = TransactionIdGetDatum(ondisk.builder.catchange.xip[j]);
192
193 values[i++] = PointerGetDatum(construct_array_builtin(arrayelems,
194 ondisk.builder.catchange.xcnt,
195 XIDOID));
196 }
197 else
198 nulls[i++] = true;
199
200 Assert(i == PG_GET_LOGICAL_SNAPSHOT_INFO_COLS);
201
202 tuple = heap_form_tuple(tupdesc, values, nulls);
203
204 PG_RETURN_DATUM(HeapTupleGetDatum(tuple));
205
206#undef PG_GET_LOGICAL_SNAPSHOT_INFO_COLS
207}
construct_array_builtin
ArrayType * construct_array_builtin(Datum *elems, int nelems, Oid elmtype)
Definition: arrayfuncs.c:3381
values
static Datum values[MAXATTR]
Definition: bootstrap.c:151
CStringGetTextDatum
#define CStringGetTextDatum(s)
Definition: builtins.h:97
elog
#define elog(elevel,...)
Definition: elog.h:225
PG_GETARG_TEXT_PP
#define PG_GETARG_TEXT_PP(n)
Definition: fmgr.h:309
PG_RETURN_DATUM
#define PG_RETURN_DATUM(x)
Definition: fmgr.h:353
get_call_result_type
TypeFuncClass get_call_result_type(FunctionCallInfo fcinfo, Oid *resultTypeId, TupleDesc *resultTupleDesc)
Definition: funcapi.c:276
TYPEFUNC_COMPOSITE
@ TYPEFUNC_COMPOSITE
Definition: funcapi.h:149
HeapTupleGetDatum
static Datum HeapTupleGetDatum(const HeapTupleData *tuple)
Definition: funcapi.h:230
Assert
Assert(PointerIsAligned(start, uint64))
heap_form_tuple
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1117
j
int j
Definition: isn.c:78
i
int i
Definition: isn.c:77
palloc
void * palloc(Size size)
Definition: mcxt.c:1317
CurrentMemoryContext
MemoryContext CurrentMemoryContext
Definition: mcxt.c:143
get_snapbuild_state_desc
static const char * get_snapbuild_state_desc(SnapBuildState state)
Definition: pg_logicalinspect.c:31
PG_GET_LOGICAL_SNAPSHOT_INFO_COLS
#define PG_GET_LOGICAL_SNAPSHOT_INFO_COLS
parse_snapshot_filename
static XLogRecPtr parse_snapshot_filename(const char *filename)
Definition: pg_logicalinspect.c:58
LSNGetDatum
static Datum LSNGetDatum(XLogRecPtr X)
Definition: pg_lsn.h:28
PointerGetDatum
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:327
TransactionIdGetDatum
static Datum TransactionIdGetDatum(TransactionId X)
Definition: postgres.h:277
Datum
uintptr_t Datum
Definition: postgres.h:69
BoolGetDatum
static Datum BoolGetDatum(bool X)
Definition: postgres.h:107
UInt32GetDatum
static Datum UInt32GetDatum(uint32 X)
Definition: postgres.h:237
SnapBuildRestoreSnapshot
bool SnapBuildRestoreSnapshot(SnapBuildOnDisk *ondisk, XLogRecPtr lsn, MemoryContext context, bool missing_ok)
Definition: snapbuild.c:1694
SnapBuild::start_decoding_at
XLogRecPtr start_decoding_at
Definition: snapbuild_internal.h:44
SnapBuild::state
SnapBuildState state
Definition: snapbuild_internal.h:29
SnapBuild::xmin
TransactionId xmin
Definition: snapbuild_internal.h:35
SnapBuild::initial_xmin_horizon
TransactionId initial_xmin_horizon
Definition: snapbuild_internal.h:61
SnapBuild::committed
struct SnapBuild::@117 committed
SnapBuild::xmax
TransactionId xmax
Definition: snapbuild_internal.h:38
SnapBuild::xip
TransactionId * xip
Definition: snapbuild_internal.h:129
SnapBuild::two_phase_at
XLogRecPtr two_phase_at
Definition: snapbuild_internal.h:55
SnapBuild::building_full_snapshot
bool building_full_snapshot
Definition: snapbuild_internal.h:64
SnapBuild::next_phase_at
TransactionId next_phase_at
Definition: snapbuild_internal.h:94
SnapBuild::last_serialized_snapshot
XLogRecPtr last_serialized_snapshot
Definition: snapbuild_internal.h:82
SnapBuild::catchange
struct SnapBuild::@118 catchange
varlena
Definition: c.h:658
text_to_cstring
char * text_to_cstring(const text *t)
Definition: varlena.c:225

References Assert(), BoolGetDatum(), SnapBuildOnDisk::builder, SnapBuild::building_full_snapshot, SnapBuild::catchange, SnapBuild::committed, construct_array_builtin(), CStringGetTextDatum, CurrentMemoryContext, elog, ERROR, get_call_result_type(), get_snapbuild_state_desc(), heap_form_tuple(), HeapTupleGetDatum(), i, SnapBuild::in_slot_creation, SnapBuild::initial_xmin_horizon, j, SnapBuild::last_serialized_snapshot, LSNGetDatum(), SnapBuild::next_phase_at, palloc(), parse_snapshot_filename(), PG_GET_LOGICAL_SNAPSHOT_INFO_COLS, PG_GETARG_TEXT_PP, PG_RETURN_DATUM, PointerGetDatum(), SnapBuildRestoreSnapshot(), SnapBuild::start_decoding_at, SnapBuild::state, text_to_cstring(), TransactionIdGetDatum(), SnapBuild::two_phase_at, TYPEFUNC_COMPOSITE, UInt32GetDatum(), values, SnapBuild::xcnt, SnapBuild::xip, SnapBuild::xmax, and SnapBuild::xmin.

◆ pg_get_logical_snapshot_meta()

Datum pg_get_logical_snapshot_meta ( PG_FUNCTION_ARGS  )

Definition at line 99 of file pg_logicalinspect.c.

100{
101#define PG_GET_LOGICAL_SNAPSHOT_META_COLS 3
102 SnapBuildOnDisk ondisk;
103 HeapTuple tuple;
104 Datum values[PG_GET_LOGICAL_SNAPSHOT_META_COLS] = {0};
105 bool nulls[PG_GET_LOGICAL_SNAPSHOT_META_COLS] = {0};
106 TupleDesc tupdesc;
107 XLogRecPtr lsn;
108 int i = 0;
109 text *filename_t = PG_GETARG_TEXT_PP(0);
110
111 /* Build a tuple descriptor for our result type */
112 if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
113 elog(ERROR, "return type must be a row type");
114
115 lsn = parse_snapshot_filename(text_to_cstring(filename_t));
116
117 /* Validate and restore the snapshot to 'ondisk' */
118 SnapBuildRestoreSnapshot(&ondisk, lsn, CurrentMemoryContext, false);
119
120 values[i++] = UInt32GetDatum(ondisk.magic);
121 values[i++] = Int64GetDatum((int64) ondisk.checksum);
122 values[i++] = UInt32GetDatum(ondisk.version);
123
124 Assert(i == PG_GET_LOGICAL_SNAPSHOT_META_COLS);
125
126 tuple = heap_form_tuple(tupdesc, values, nulls);
127
128 PG_RETURN_DATUM(HeapTupleGetDatum(tuple));
129
130#undef PG_GET_LOGICAL_SNAPSHOT_META_COLS
131}
int64
int64_t int64
Definition: c.h:499
Int64GetDatum
Datum Int64GetDatum(int64 X)
Definition: fmgr.c:1807
PG_GET_LOGICAL_SNAPSHOT_META_COLS
#define PG_GET_LOGICAL_SNAPSHOT_META_COLS

References Assert(), SnapBuildOnDisk::checksum, CurrentMemoryContext, elog, ERROR, get_call_result_type(), heap_form_tuple(), HeapTupleGetDatum(), i, Int64GetDatum(), SnapBuildOnDisk::magic, parse_snapshot_filename(), PG_GET_LOGICAL_SNAPSHOT_META_COLS, PG_GETARG_TEXT_PP, PG_RETURN_DATUM, SnapBuildRestoreSnapshot(), text_to_cstring(), TYPEFUNC_COMPOSITE, UInt32GetDatum(), values, and SnapBuildOnDisk::version.

◆ PG_MODULE_MAGIC_EXT()

PG_MODULE_MAGIC_EXT ( .  name = "pg_logicalinspect",
.  version = PG_VERSION 
)