PostgreSQL Source Code  git master
Macros | Functions | Variables
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_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)
 
Datum pg_get_logical_snapshot_meta (PG_FUNCTION_ARGS)
 
Datum pg_get_logical_snapshot_info (PG_FUNCTION_ARGS)
 

Variables

 PG_MODULE_MAGIC
 

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 28 of file pg_logicalinspect.c.

29 {
30  const char *stateDesc = "unknown state";
31 
32  switch (state)
33  {
34  case SNAPBUILD_START:
35  stateDesc = "start";
36  break;
37  case SNAPBUILD_BUILDING_SNAPSHOT:
38  stateDesc = "building";
39  break;
40  case SNAPBUILD_FULL_SNAPSHOT:
41  stateDesc = "full";
42  break;
43  case SNAPBUILD_CONSISTENT:
44  stateDesc = "consistent";
45  break;
46  }
47 
48  return stateDesc;
49 }
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().

◆ 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 92 of file pg_logicalinspect.c.

93 {
94 #define PG_GET_LOGICAL_SNAPSHOT_INFO_COLS 14
95  SnapBuildOnDisk ondisk;
96  HeapTuple tuple;
97  Datum values[PG_GET_LOGICAL_SNAPSHOT_INFO_COLS] = {0};
98  bool nulls[PG_GET_LOGICAL_SNAPSHOT_INFO_COLS] = {0};
99  TupleDesc tupdesc;
100  char path[MAXPGPATH];
101  int i = 0;
102  text *filename_t = PG_GETARG_TEXT_PP(0);
103 
104  /* Build a tuple descriptor for our result type */
105  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
106  elog(ERROR, "return type must be a row type");
107 
108  sprintf(path, "%s/%s",
109  PG_LOGICAL_SNAPSHOTS_DIR,
110  text_to_cstring(filename_t));
111 
112  /* Validate and restore the snapshot to 'ondisk' */
113  SnapBuildRestoreSnapshot(&ondisk, path, CurrentMemoryContext, false);
114 
115  values[i++] = CStringGetTextDatum(get_snapbuild_state_desc(ondisk.builder.state));
116  values[i++] = TransactionIdGetDatum(ondisk.builder.xmin);
117  values[i++] = TransactionIdGetDatum(ondisk.builder.xmax);
118  values[i++] = LSNGetDatum(ondisk.builder.start_decoding_at);
119  values[i++] = LSNGetDatum(ondisk.builder.two_phase_at);
120  values[i++] = TransactionIdGetDatum(ondisk.builder.initial_xmin_horizon);
121  values[i++] = BoolGetDatum(ondisk.builder.building_full_snapshot);
122  values[i++] = BoolGetDatum(ondisk.builder.in_slot_creation);
123  values[i++] = LSNGetDatum(ondisk.builder.last_serialized_snapshot);
124  values[i++] = TransactionIdGetDatum(ondisk.builder.next_phase_at);
125 
126  values[i++] = UInt32GetDatum(ondisk.builder.committed.xcnt);
127  if (ondisk.builder.committed.xcnt > 0)
128  {
129  Datum *arrayelems;
130 
131  arrayelems = (Datum *) palloc(ondisk.builder.committed.xcnt * sizeof(Datum));
132 
133  for (int j = 0; j < ondisk.builder.committed.xcnt; j++)
134  arrayelems[j] = TransactionIdGetDatum(ondisk.builder.committed.xip[j]);
135 
136  values[i++] = PointerGetDatum(construct_array_builtin(arrayelems,
137  ondisk.builder.committed.xcnt,
138  XIDOID));
139  }
140  else
141  nulls[i++] = true;
142 
143  values[i++] = UInt32GetDatum(ondisk.builder.catchange.xcnt);
144  if (ondisk.builder.catchange.xcnt > 0)
145  {
146  Datum *arrayelems;
147 
148  arrayelems = (Datum *) palloc(ondisk.builder.catchange.xcnt * sizeof(Datum));
149 
150  for (int j = 0; j < ondisk.builder.catchange.xcnt; j++)
151  arrayelems[j] = TransactionIdGetDatum(ondisk.builder.catchange.xip[j]);
152 
153  values[i++] = PointerGetDatum(construct_array_builtin(arrayelems,
154  ondisk.builder.catchange.xcnt,
155  XIDOID));
156  }
157  else
158  nulls[i++] = true;
159 
160  Assert(i == PG_GET_LOGICAL_SNAPSHOT_INFO_COLS);
161 
162  tuple = heap_form_tuple(tupdesc, values, nulls);
163 
164  PG_RETURN_DATUM(HeapTupleGetDatum(tuple));
165 
166 #undef PG_GET_LOGICAL_SNAPSHOT_INFO_COLS
167 }
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:150
CStringGetTextDatum
#define CStringGetTextDatum(s)
Definition: builtins.h:97
Assert
#define Assert(condition)
Definition: c.h:849
ERROR
#define ERROR
Definition: elog.h:39
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
heap_form_tuple
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1116
j
int j
Definition: isn.c:74
i
int i
Definition: isn.c:73
CurrentMemoryContext
MemoryContext CurrentMemoryContext
Definition: mcxt.c:143
palloc
void * palloc(Size size)
Definition: mcxt.c:1317
MAXPGPATH
#define MAXPGPATH
Definition: pg_config_manual.h:100
PG_GET_LOGICAL_SNAPSHOT_INFO_COLS
#define PG_GET_LOGICAL_SNAPSHOT_INFO_COLS
get_snapbuild_state_desc
static const char * get_snapbuild_state_desc(SnapBuildState state)
Definition: pg_logicalinspect.c:28
LSNGetDatum
static Datum LSNGetDatum(XLogRecPtr X)
Definition: pg_lsn.h:28
sprintf
#define sprintf
Definition: port.h:240
PointerGetDatum
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:322
TransactionIdGetDatum
static Datum TransactionIdGetDatum(TransactionId X)
Definition: postgres.h:272
Datum
uintptr_t Datum
Definition: postgres.h:64
BoolGetDatum
static Datum BoolGetDatum(bool X)
Definition: postgres.h:102
UInt32GetDatum
static Datum UInt32GetDatum(uint32 X)
Definition: postgres.h:232
PG_LOGICAL_SNAPSHOTS_DIR
#define PG_LOGICAL_SNAPSHOTS_DIR
Definition: reorderbuffer.h:24
SnapBuildRestoreSnapshot
bool SnapBuildRestoreSnapshot(SnapBuildOnDisk *ondisk, const char *path, 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::@112 committed
SnapBuild::xmax
TransactionId xmax
Definition: snapbuild_internal.h:38
SnapBuild::catchange
struct SnapBuild::@113 catchange
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
varlena
Definition: c.h:678
text_to_cstring
char * text_to_cstring(const text *t)
Definition: varlena.c:217

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(), MAXPGPATH, SnapBuild::next_phase_at, palloc(), PG_GET_LOGICAL_SNAPSHOT_INFO_COLS, PG_GETARG_TEXT_PP, PG_LOGICAL_SNAPSHOTS_DIR, PG_RETURN_DATUM, PointerGetDatum(), SnapBuildRestoreSnapshot(), sprintf, 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 55 of file pg_logicalinspect.c.

56 {
57 #define PG_GET_LOGICAL_SNAPSHOT_META_COLS 3
58  SnapBuildOnDisk ondisk;
59  HeapTuple tuple;
60  Datum values[PG_GET_LOGICAL_SNAPSHOT_META_COLS] = {0};
61  bool nulls[PG_GET_LOGICAL_SNAPSHOT_META_COLS] = {0};
62  TupleDesc tupdesc;
63  char path[MAXPGPATH];
64  int i = 0;
65  text *filename_t = PG_GETARG_TEXT_PP(0);
66 
67  /* Build a tuple descriptor for our result type */
68  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
69  elog(ERROR, "return type must be a row type");
70 
71  sprintf(path, "%s/%s",
72  PG_LOGICAL_SNAPSHOTS_DIR,
73  text_to_cstring(filename_t));
74 
75  /* Validate and restore the snapshot to 'ondisk' */
76  SnapBuildRestoreSnapshot(&ondisk, path, CurrentMemoryContext, false);
77 
78  values[i++] = UInt32GetDatum(ondisk.magic);
79  values[i++] = Int64GetDatum((int64) ondisk.checksum);
80  values[i++] = UInt32GetDatum(ondisk.version);
81 
82  Assert(i == PG_GET_LOGICAL_SNAPSHOT_META_COLS);
83 
84  tuple = heap_form_tuple(tupdesc, values, nulls);
85 
86  PG_RETURN_DATUM(HeapTupleGetDatum(tuple));
87 
88 #undef PG_GET_LOGICAL_SNAPSHOT_META_COLS
89 }
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, MAXPGPATH, PG_GET_LOGICAL_SNAPSHOT_META_COLS, PG_GETARG_TEXT_PP, PG_LOGICAL_SNAPSHOTS_DIR, PG_RETURN_DATUM, SnapBuildRestoreSnapshot(), sprintf, text_to_cstring(), TYPEFUNC_COMPOSITE, UInt32GetDatum(), values, and SnapBuildOnDisk::version.

Variable Documentation

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 21 of file pg_logicalinspect.c.