PostgreSQL Source Code  git master
Functions
pg_controldata.c File Reference
#include "postgres.h"
#include "access/htup_details.h"
#include "access/transam.h"
#include "access/xlog.h"
#include "access/xlog_internal.h"
#include "catalog/pg_control.h"
#include "common/controldata_utils.h"
#include "funcapi.h"
#include "miscadmin.h"
#include "storage/lwlock.h"
#include "utils/builtins.h"
#include "utils/pg_lsn.h"
#include "utils/timestamp.h"
Include dependency graph for pg_controldata.c:

Go to the source code of this file.

Functions

Datum pg_control_system (PG_FUNCTION_ARGS)
 
Datum pg_control_checkpoint (PG_FUNCTION_ARGS)
 
Datum pg_control_recovery (PG_FUNCTION_ARGS)
 
Datum pg_control_init (PG_FUNCTION_ARGS)
 

Function Documentation

◆ pg_control_checkpoint()

Datum pg_control_checkpoint ( PG_FUNCTION_ARGS  )

Definition at line 70 of file pg_controldata.c.

71 {
72  Datum values[18];
73  bool nulls[18];
74  TupleDesc tupdesc;
75  HeapTuple htup;
76  ControlFileData *ControlFile;
77  XLogSegNo segno;
78  char xlogfilename[MAXFNAMELEN];
79  bool crc_ok;
80 
81  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
82  elog(ERROR, "return type must be a row type");
83 
84  /* Read the control file. */
85  LWLockAcquire(ControlFileLock, LW_SHARED);
86  ControlFile = get_controlfile(DataDir, &crc_ok);
87  LWLockRelease(ControlFileLock);
88  if (!crc_ok)
89  ereport(ERROR,
90  (errmsg("calculated CRC checksum does not match value stored in file")));
91 
92  /*
93  * Calculate name of the WAL file containing the latest checkpoint's REDO
94  * start point.
95  */
96  XLByteToSeg(ControlFile->checkPointCopy.redo, segno, wal_segment_size);
97  XLogFileName(xlogfilename, ControlFile->checkPointCopy.ThisTimeLineID,
98  segno, wal_segment_size);
99 
100  /* Populate the values and null arrays */
101  values[0] = LSNGetDatum(ControlFile->checkPoint);
102  nulls[0] = false;
103 
104  values[1] = LSNGetDatum(ControlFile->checkPointCopy.redo);
105  nulls[1] = false;
106 
107  values[2] = CStringGetTextDatum(xlogfilename);
108  nulls[2] = false;
109 
110  values[3] = Int32GetDatum(ControlFile->checkPointCopy.ThisTimeLineID);
111  nulls[3] = false;
112 
113  values[4] = Int32GetDatum(ControlFile->checkPointCopy.PrevTimeLineID);
114  nulls[4] = false;
115 
116  values[5] = BoolGetDatum(ControlFile->checkPointCopy.fullPageWrites);
117  nulls[5] = false;
118 
119  values[6] = CStringGetTextDatum(psprintf("%u:%u",
120  EpochFromFullTransactionId(ControlFile->checkPointCopy.nextXid),
121  XidFromFullTransactionId(ControlFile->checkPointCopy.nextXid)));
122  nulls[6] = false;
123 
124  values[7] = ObjectIdGetDatum(ControlFile->checkPointCopy.nextOid);
125  nulls[7] = false;
126 
127  values[8] = TransactionIdGetDatum(ControlFile->checkPointCopy.nextMulti);
128  nulls[8] = false;
129 
130  values[9] = TransactionIdGetDatum(ControlFile->checkPointCopy.nextMultiOffset);
131  nulls[9] = false;
132 
133  values[10] = TransactionIdGetDatum(ControlFile->checkPointCopy.oldestXid);
134  nulls[10] = false;
135 
136  values[11] = ObjectIdGetDatum(ControlFile->checkPointCopy.oldestXidDB);
137  nulls[11] = false;
138 
139  values[12] = TransactionIdGetDatum(ControlFile->checkPointCopy.oldestActiveXid);
140  nulls[12] = false;
141 
142  values[13] = TransactionIdGetDatum(ControlFile->checkPointCopy.oldestMulti);
143  nulls[13] = false;
144 
145  values[14] = ObjectIdGetDatum(ControlFile->checkPointCopy.oldestMultiDB);
146  nulls[14] = false;
147 
148  values[15] = TransactionIdGetDatum(ControlFile->checkPointCopy.oldestCommitTsXid);
149  nulls[15] = false;
150 
151  values[16] = TransactionIdGetDatum(ControlFile->checkPointCopy.newestCommitTsXid);
152  nulls[16] = false;
153 
154  values[17] = TimestampTzGetDatum(time_t_to_timestamptz(ControlFile->checkPointCopy.time));
155  nulls[17] = false;
156 
157  htup = heap_form_tuple(tupdesc, values, nulls);
158 
159  PG_RETURN_DATUM(HeapTupleGetDatum(htup));
160 }
time_t_to_timestamptz
TimestampTz time_t_to_timestamptz(pg_time_t tm)
Definition: timestamp.c:1811
values
static Datum values[MAXATTR]
Definition: bootstrap.c:152
CStringGetTextDatum
#define CStringGetTextDatum(s)
Definition: builtins.h:97
get_controlfile
ControlFileData * get_controlfile(const char *DataDir, bool *crc_ok_p)
Definition: controldata_utils.c:52
errmsg
int errmsg(const char *fmt,...)
Definition: elog.c:1072
ERROR
#define ERROR
Definition: elog.h:39
elog
#define elog(elevel,...)
Definition: elog.h:224
ereport
#define ereport(elevel,...)
Definition: elog.h:149
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
DataDir
char * DataDir
Definition: globals.c:68
heap_form_tuple
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, const Datum *values, const bool *isnull)
Definition: heaptuple.c:1116
LWLockAcquire
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1170
LWLockRelease
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1783
LW_SHARED
@ LW_SHARED
Definition: lwlock.h:115
LSNGetDatum
static Datum LSNGetDatum(XLogRecPtr X)
Definition: pg_lsn.h:28
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
ObjectIdGetDatum
static Datum ObjectIdGetDatum(Oid X)
Definition: postgres.h:252
Int32GetDatum
static Datum Int32GetDatum(int32 X)
Definition: postgres.h:212
psprintf
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
CheckPoint::oldestMultiDB
Oid oldestMultiDB
Definition: pg_control.h:50
CheckPoint::oldestMulti
MultiXactId oldestMulti
Definition: pg_control.h:49
CheckPoint::nextMultiOffset
MultiXactOffset nextMultiOffset
Definition: pg_control.h:46
CheckPoint::newestCommitTsXid
TransactionId newestCommitTsXid
Definition: pg_control.h:54
CheckPoint::oldestXid
TransactionId oldestXid
Definition: pg_control.h:47
CheckPoint::PrevTimeLineID
TimeLineID PrevTimeLineID
Definition: pg_control.h:40
CheckPoint::ThisTimeLineID
TimeLineID ThisTimeLineID
Definition: pg_control.h:39
CheckPoint::nextOid
Oid nextOid
Definition: pg_control.h:44
CheckPoint::oldestActiveXid
TransactionId oldestActiveXid
Definition: pg_control.h:63
CheckPoint::fullPageWrites
bool fullPageWrites
Definition: pg_control.h:42
CheckPoint::nextMulti
MultiXactId nextMulti
Definition: pg_control.h:45
CheckPoint::nextXid
FullTransactionId nextXid
Definition: pg_control.h:43
CheckPoint::oldestCommitTsXid
TransactionId oldestCommitTsXid
Definition: pg_control.h:52
CheckPoint::time
pg_time_t time
Definition: pg_control.h:51
CheckPoint::redo
XLogRecPtr redo
Definition: pg_control.h:37
CheckPoint::oldestXidDB
Oid oldestXidDB
Definition: pg_control.h:48
ControlFileData::checkPointCopy
CheckPoint checkPointCopy
Definition: pg_control.h:134
ControlFileData::checkPoint
XLogRecPtr checkPoint
Definition: pg_control.h:132
EpochFromFullTransactionId
#define EpochFromFullTransactionId(x)
Definition: transam.h:47
XidFromFullTransactionId
#define XidFromFullTransactionId(x)
Definition: transam.h:48
TimestampTzGetDatum
static Datum TimestampTzGetDatum(TimestampTz X)
Definition: timestamp.h:52
wal_segment_size
int wal_segment_size
Definition: xlog.c:143
ControlFile
static ControlFileData * ControlFile
Definition: xlog.c:569
MAXFNAMELEN
#define MAXFNAMELEN
Definition: xlog_internal.h:156
XLByteToSeg
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)
Definition: xlog_internal.h:117
XLogFileName
static void XLogFileName(char *fname, TimeLineID tli, XLogSegNo logSegNo, int wal_segsz_bytes)
Definition: xlog_internal.h:166
XLogSegNo
uint64 XLogSegNo
Definition: xlogdefs.h:48

References BoolGetDatum(), ControlFileData::checkPoint, ControlFileData::checkPointCopy, ControlFile, CStringGetTextDatum, DataDir, elog, EpochFromFullTransactionId, ereport, errmsg(), ERROR, CheckPoint::fullPageWrites, get_call_result_type(), get_controlfile(), heap_form_tuple(), HeapTupleGetDatum(), Int32GetDatum(), LSNGetDatum(), LW_SHARED, LWLockAcquire(), LWLockRelease(), MAXFNAMELEN, CheckPoint::newestCommitTsXid, CheckPoint::nextMulti, CheckPoint::nextMultiOffset, CheckPoint::nextOid, CheckPoint::nextXid, ObjectIdGetDatum(), CheckPoint::oldestActiveXid, CheckPoint::oldestCommitTsXid, CheckPoint::oldestMulti, CheckPoint::oldestMultiDB, CheckPoint::oldestXid, CheckPoint::oldestXidDB, PG_RETURN_DATUM, CheckPoint::PrevTimeLineID, psprintf(), CheckPoint::redo, CheckPoint::ThisTimeLineID, CheckPoint::time, time_t_to_timestamptz(), TimestampTzGetDatum(), TransactionIdGetDatum(), TYPEFUNC_COMPOSITE, values, wal_segment_size, XidFromFullTransactionId, XLByteToSeg, and XLogFileName().

◆ pg_control_init()

Datum pg_control_init ( PG_FUNCTION_ARGS  )

Definition at line 204 of file pg_controldata.c.

205 {
206  Datum values[11];
207  bool nulls[11];
208  TupleDesc tupdesc;
209  HeapTuple htup;
210  ControlFileData *ControlFile;
211  bool crc_ok;
212 
213  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
214  elog(ERROR, "return type must be a row type");
215 
216  /* read the control file */
217  LWLockAcquire(ControlFileLock, LW_SHARED);
218  ControlFile = get_controlfile(DataDir, &crc_ok);
219  LWLockRelease(ControlFileLock);
220  if (!crc_ok)
221  ereport(ERROR,
222  (errmsg("calculated CRC checksum does not match value stored in file")));
223 
224  values[0] = Int32GetDatum(ControlFile->maxAlign);
225  nulls[0] = false;
226 
227  values[1] = Int32GetDatum(ControlFile->blcksz);
228  nulls[1] = false;
229 
230  values[2] = Int32GetDatum(ControlFile->relseg_size);
231  nulls[2] = false;
232 
233  values[3] = Int32GetDatum(ControlFile->xlog_blcksz);
234  nulls[3] = false;
235 
236  values[4] = Int32GetDatum(ControlFile->xlog_seg_size);
237  nulls[4] = false;
238 
239  values[5] = Int32GetDatum(ControlFile->nameDataLen);
240  nulls[5] = false;
241 
242  values[6] = Int32GetDatum(ControlFile->indexMaxKeys);
243  nulls[6] = false;
244 
245  values[7] = Int32GetDatum(ControlFile->toast_max_chunk_size);
246  nulls[7] = false;
247 
248  values[8] = Int32GetDatum(ControlFile->loblksize);
249  nulls[8] = false;
250 
251  values[9] = BoolGetDatum(ControlFile->float8ByVal);
252  nulls[9] = false;
253 
254  values[10] = Int32GetDatum(ControlFile->data_checksum_version);
255  nulls[10] = false;
256 
257  htup = heap_form_tuple(tupdesc, values, nulls);
258 
259  PG_RETURN_DATUM(HeapTupleGetDatum(htup));
260 }
ControlFileData::xlog_seg_size
uint32 xlog_seg_size
Definition: pg_control.h:210
ControlFileData::nameDataLen
uint32 nameDataLen
Definition: pg_control.h:212
ControlFileData::data_checksum_version
uint32 data_checksum_version
Definition: pg_control.h:221
ControlFileData::indexMaxKeys
uint32 indexMaxKeys
Definition: pg_control.h:213
ControlFileData::relseg_size
uint32 relseg_size
Definition: pg_control.h:207
ControlFileData::xlog_blcksz
uint32 xlog_blcksz
Definition: pg_control.h:209
ControlFileData::loblksize
uint32 loblksize
Definition: pg_control.h:216
ControlFileData::toast_max_chunk_size
uint32 toast_max_chunk_size
Definition: pg_control.h:215

References ControlFileData::blcksz, BoolGetDatum(), ControlFile, ControlFileData::data_checksum_version, DataDir, elog, ereport, errmsg(), ERROR, ControlFileData::float8ByVal, get_call_result_type(), get_controlfile(), heap_form_tuple(), HeapTupleGetDatum(), ControlFileData::indexMaxKeys, Int32GetDatum(), ControlFileData::loblksize, LW_SHARED, LWLockAcquire(), LWLockRelease(), ControlFileData::maxAlign, ControlFileData::nameDataLen, PG_RETURN_DATUM, ControlFileData::relseg_size, ControlFileData::toast_max_chunk_size, TYPEFUNC_COMPOSITE, values, ControlFileData::xlog_blcksz, and ControlFileData::xlog_seg_size.

◆ pg_control_recovery()

Datum pg_control_recovery ( PG_FUNCTION_ARGS  )

Definition at line 163 of file pg_controldata.c.

164 {
165  Datum values[5];
166  bool nulls[5];
167  TupleDesc tupdesc;
168  HeapTuple htup;
169  ControlFileData *ControlFile;
170  bool crc_ok;
171 
172  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
173  elog(ERROR, "return type must be a row type");
174 
175  /* read the control file */
176  LWLockAcquire(ControlFileLock, LW_SHARED);
177  ControlFile = get_controlfile(DataDir, &crc_ok);
178  LWLockRelease(ControlFileLock);
179  if (!crc_ok)
180  ereport(ERROR,
181  (errmsg("calculated CRC checksum does not match value stored in file")));
182 
183  values[0] = LSNGetDatum(ControlFile->minRecoveryPoint);
184  nulls[0] = false;
185 
186  values[1] = Int32GetDatum(ControlFile->minRecoveryPointTLI);
187  nulls[1] = false;
188 
189  values[2] = LSNGetDatum(ControlFile->backupStartPoint);
190  nulls[2] = false;
191 
192  values[3] = LSNGetDatum(ControlFile->backupEndPoint);
193  nulls[3] = false;
194 
195  values[4] = BoolGetDatum(ControlFile->backupEndRequired);
196  nulls[4] = false;
197 
198  htup = heap_form_tuple(tupdesc, values, nulls);
199 
200  PG_RETURN_DATUM(HeapTupleGetDatum(htup));
201 }
ControlFileData::backupStartPoint
XLogRecPtr backupStartPoint
Definition: pg_control.h:169
ControlFileData::backupEndRequired
bool backupEndRequired
Definition: pg_control.h:171
ControlFileData::backupEndPoint
XLogRecPtr backupEndPoint
Definition: pg_control.h:170
ControlFileData::minRecoveryPoint
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:167
ControlFileData::minRecoveryPointTLI
TimeLineID minRecoveryPointTLI
Definition: pg_control.h:168

References ControlFileData::backupEndPoint, ControlFileData::backupEndRequired, ControlFileData::backupStartPoint, BoolGetDatum(), ControlFile, DataDir, elog, ereport, errmsg(), ERROR, get_call_result_type(), get_controlfile(), heap_form_tuple(), HeapTupleGetDatum(), Int32GetDatum(), LSNGetDatum(), LW_SHARED, LWLockAcquire(), LWLockRelease(), ControlFileData::minRecoveryPoint, ControlFileData::minRecoveryPointTLI, PG_RETURN_DATUM, TYPEFUNC_COMPOSITE, and values.

◆ pg_control_system()

Datum pg_control_system ( PG_FUNCTION_ARGS  )

Definition at line 32 of file pg_controldata.c.

33 {
34  Datum values[4];
35  bool nulls[4];
36  TupleDesc tupdesc;
37  HeapTuple htup;
38  ControlFileData *ControlFile;
39  bool crc_ok;
40 
41  if (get_call_result_type(fcinfo, NULL, &tupdesc) != TYPEFUNC_COMPOSITE)
42  elog(ERROR, "return type must be a row type");
43 
44  /* read the control file */
45  LWLockAcquire(ControlFileLock, LW_SHARED);
46  ControlFile = get_controlfile(DataDir, &crc_ok);
47  LWLockRelease(ControlFileLock);
48  if (!crc_ok)
49  ereport(ERROR,
50  (errmsg("calculated CRC checksum does not match value stored in file")));
51 
52  values[0] = Int32GetDatum(ControlFile->pg_control_version);
53  nulls[0] = false;
54 
55  values[1] = Int32GetDatum(ControlFile->catalog_version_no);
56  nulls[1] = false;
57 
58  values[2] = Int64GetDatum(ControlFile->system_identifier);
59  nulls[2] = false;
60 
61  values[3] = TimestampTzGetDatum(time_t_to_timestamptz(ControlFile->time));
62  nulls[3] = false;
63 
64  htup = heap_form_tuple(tupdesc, values, nulls);
65 
66  PG_RETURN_DATUM(HeapTupleGetDatum(htup));
67 }
Int64GetDatum
Datum Int64GetDatum(int64 X)
Definition: fmgr.c:1807
ControlFileData::pg_control_version
uint32 pg_control_version
Definition: pg_control.h:124
ControlFileData::time
pg_time_t time
Definition: pg_control.h:131
ControlFileData::system_identifier
uint64 system_identifier
Definition: pg_control.h:109
ControlFileData::catalog_version_no
uint32 catalog_version_no
Definition: pg_control.h:125

References ControlFileData::catalog_version_no, ControlFile, DataDir, elog, ereport, errmsg(), ERROR, get_call_result_type(), get_controlfile(), heap_form_tuple(), HeapTupleGetDatum(), Int32GetDatum(), Int64GetDatum(), LW_SHARED, LWLockAcquire(), LWLockRelease(), ControlFileData::pg_control_version, PG_RETURN_DATUM, ControlFileData::system_identifier, ControlFileData::time, time_t_to_timestamptz(), TimestampTzGetDatum(), TYPEFUNC_COMPOSITE, and values.