1 /*-------------------------------------------------------------------------
2  *
3  * pg_controldata.c
4  *
5  * Routines to expose the contents of the control data file via
6  * a set of SQL functions.
7  *
8  * Portions Copyright (c) 1996-2021, PostgreSQL Global Development Group
9  * Portions Copyright (c) 1994, Regents of the University of California
10  *
11  * IDENTIFICATION
12  *	  src/backend/utils/misc/pg_controldata.c
13  *-------------------------------------------------------------------------
14  */
15 
16 #include "postgres.h"
17 
18 #include "access/htup_details.h"
19 #include "access/transam.h"
20 #include "access/xlog.h"
21 #include "access/xlog_internal.h"
22 #include "catalog/pg_control.h"
23 #include "catalog/pg_type.h"
24 #include "common/controldata_utils.h"
25 #include "funcapi.h"
26 #include "miscadmin.h"
27 #include "utils/builtins.h"
28 #include "utils/pg_lsn.h"
29 #include "utils/timestamp.h"
30 
31 Datum
32 pg_control_system(PG_FUNCTION_ARGS)
33 {
34 	Datum		values[4];
35 	bool		nulls[4];
36 	TupleDesc	tupdesc;
37 	HeapTuple	htup;
38 	ControlFileData *ControlFile;
39 	bool		crc_ok;
40 
41 	/*
42 	 * Construct a tuple descriptor for the result row.  This must match this
43 	 * function's pg_proc entry!
44 	 */
45 	tupdesc = CreateTemplateTupleDesc(4);
helper_thread_destroy(void)46 	TupleDescInitEntry(tupdesc, (AttrNumber) 1, "pg_control_version",
47 					   INT4OID, -1, 0);
48 	TupleDescInitEntry(tupdesc, (AttrNumber) 2, "catalog_version_no",
49 					   INT4OID, -1, 0);
50 	TupleDescInitEntry(tupdesc, (AttrNumber) 3, "system_identifier",
51 					   INT8OID, -1, 0);
52 	TupleDescInitEntry(tupdesc, (AttrNumber) 4, "pg_control_last_modified",
53 					   TIMESTAMPTZOID, -1, 0);
54 	tupdesc = BlessTupleDesc(tupdesc);
55 
56 	/* read the control file */
sock_init(void)57 	ControlFile = get_controlfile(DataDir, &crc_ok);
58 	if (!crc_ok)
59 		ereport(ERROR,
60 				(errmsg("calculated CRC checksum does not match value stored in file")));
61 
62 	values[0] = Int32GetDatum(ControlFile->pg_control_version);
63 	nulls[0] = false;
64 
65 	values[1] = Int32GetDatum(ControlFile->catalog_version_no);
66 	nulls[1] = false;
make_nonblocking(int fd)67 
68 	values[2] = Int64GetDatum(ControlFile->system_identifier);
69 	nulls[2] = false;
70 
71 	values[3] = TimestampTzGetDatum(time_t_to_timestamptz(ControlFile->time));
72 	nulls[3] = false;
73 
write_to_pipe(int fd,const void * buf,size_t len)74 	htup = heap_form_tuple(tupdesc, values, nulls);
75 
76 	PG_RETURN_DATUM(HeapTupleGetDatum(htup));
77 }
78 
read_from_pipe(int fd,void * buf,size_t len)79 Datum
80 pg_control_checkpoint(PG_FUNCTION_ARGS)
81 {
82 	Datum		values[19];
83 	bool		nulls[19];
84 	TupleDesc	tupdesc;
85 	HeapTuple	htup;
86 	ControlFileData *ControlFile;
87 	XLogSegNo	segno;
88 	char		xlogfilename[MAXFNAMELEN];
89 	bool		crc_ok;
90 
91 	/*
92 	 * Construct a tuple descriptor for the result row.  This must match this
93 	 * function's pg_proc entry!
94 	 */
95 	tupdesc = CreateTemplateTupleDesc(18);
96 	TupleDescInitEntry(tupdesc, (AttrNumber) 1, "checkpoint_lsn",
97 					   PG_LSNOID, -1, 0);
98 	TupleDescInitEntry(tupdesc, (AttrNumber) 2, "redo_lsn",
99 					   PG_LSNOID, -1, 0);
100 	TupleDescInitEntry(tupdesc, (AttrNumber) 3, "redo_wal_file",
101 					   TEXTOID, -1, 0);
102 	TupleDescInitEntry(tupdesc, (AttrNumber) 4, "timeline_id",
103 					   INT4OID, -1, 0);
104 	TupleDescInitEntry(tupdesc, (AttrNumber) 5, "prev_timeline_id",
105 					   INT4OID, -1, 0);
106 	TupleDescInitEntry(tupdesc, (AttrNumber) 6, "full_page_writes",
107 					   BOOLOID, -1, 0);
108 	TupleDescInitEntry(tupdesc, (AttrNumber) 7, "next_xid",
109 					   TEXTOID, -1, 0);
110 	TupleDescInitEntry(tupdesc, (AttrNumber) 8, "next_oid",
111 					   OIDOID, -1, 0);
112 	TupleDescInitEntry(tupdesc, (AttrNumber) 9, "next_multixact_id",
113 					   XIDOID, -1, 0);
114 	TupleDescInitEntry(tupdesc, (AttrNumber) 10, "next_multi_offset",
115 					   XIDOID, -1, 0);
116 	TupleDescInitEntry(tupdesc, (AttrNumber) 11, "oldest_xid",
117 					   XIDOID, -1, 0);
118 	TupleDescInitEntry(tupdesc, (AttrNumber) 12, "oldest_xid_dbid",
119 					   OIDOID, -1, 0);
120 	TupleDescInitEntry(tupdesc, (AttrNumber) 13, "oldest_active_xid",
121 					   XIDOID, -1, 0);
122 	TupleDescInitEntry(tupdesc, (AttrNumber) 14, "oldest_multi_xid",
123 					   XIDOID, -1, 0);
124 	TupleDescInitEntry(tupdesc, (AttrNumber) 15, "oldest_multi_dbid",
125 					   OIDOID, -1, 0);
126 	TupleDescInitEntry(tupdesc, (AttrNumber) 16, "oldest_commit_ts_xid",
127 					   XIDOID, -1, 0);
128 	TupleDescInitEntry(tupdesc, (AttrNumber) 17, "newest_commit_ts_xid",
129 					   XIDOID, -1, 0);
130 	TupleDescInitEntry(tupdesc, (AttrNumber) 18, "checkpoint_time",
131 					   TIMESTAMPTZOID, -1, 0);
132 	tupdesc = BlessTupleDesc(tupdesc);
133 
134 	/* Read the control file. */
135 	ControlFile = get_controlfile(DataDir, &crc_ok);
136 	if (!crc_ok)
137 		ereport(ERROR,
138 				(errmsg("calculated CRC checksum does not match value stored in file")));
139 
140 	/*
141 	 * Calculate name of the WAL file containing the latest checkpoint's REDO
142 	 * start point.
143 	 */
144 	XLByteToSeg(ControlFile->checkPointCopy.redo, segno, wal_segment_size);
145 	XLogFileName(xlogfilename, ControlFile->checkPointCopy.ThisTimeLineID,
146 				 segno, wal_segment_size);
147 
148 	/* Populate the values and null arrays */
149 	values[0] = LSNGetDatum(ControlFile->checkPoint);
150 	nulls[0] = false;
151 
152 	values[1] = LSNGetDatum(ControlFile->checkPointCopy.redo);
153 	nulls[1] = false;
154 
155 	values[2] = CStringGetTextDatum(xlogfilename);
156 	nulls[2] = false;
157 
158 	values[3] = Int32GetDatum(ControlFile->checkPointCopy.ThisTimeLineID);
159 	nulls[3] = false;
160 
161 	values[4] = Int32GetDatum(ControlFile->checkPointCopy.PrevTimeLineID);
162 	nulls[4] = false;
163 
164 	values[5] = BoolGetDatum(ControlFile->checkPointCopy.fullPageWrites);
165 	nulls[5] = false;
166 
167 	values[6] = CStringGetTextDatum(psprintf("%u:%u",
168 											 EpochFromFullTransactionId(ControlFile->checkPointCopy.nextXid),
169 											 XidFromFullTransactionId(ControlFile->checkPointCopy.nextXid)));
170 	nulls[6] = false;
171 
172 	values[7] = ObjectIdGetDatum(ControlFile->checkPointCopy.nextOid);
173 	nulls[7] = false;
174 
175 	values[8] = TransactionIdGetDatum(ControlFile->checkPointCopy.nextMulti);
176 	nulls[8] = false;
177 
178 	values[9] = TransactionIdGetDatum(ControlFile->checkPointCopy.nextMultiOffset);
179 	nulls[9] = false;
180 
181 	values[10] = TransactionIdGetDatum(ControlFile->checkPointCopy.oldestXid);
182 	nulls[10] = false;
183 
184 	values[11] = ObjectIdGetDatum(ControlFile->checkPointCopy.oldestXidDB);
185 	nulls[11] = false;
186 
187 	values[12] = TransactionIdGetDatum(ControlFile->checkPointCopy.oldestActiveXid);
188 	nulls[12] = false;
189 
190 	values[13] = TransactionIdGetDatum(ControlFile->checkPointCopy.oldestMulti);
191 	nulls[13] = false;
192 
193 	values[14] = ObjectIdGetDatum(ControlFile->checkPointCopy.oldestMultiDB);
194 	nulls[14] = false;
195 
196 	values[15] = TransactionIdGetDatum(ControlFile->checkPointCopy.oldestCommitTsXid);
197 	nulls[15] = false;
198 
199 	values[16] = TransactionIdGetDatum(ControlFile->checkPointCopy.newestCommitTsXid);
200 	nulls[16] = false;
201 
202 	values[17] = TimestampTzGetDatum(time_t_to_timestamptz(ControlFile->checkPointCopy.time));
203 	nulls[17] = false;
204 
205 	htup = heap_form_tuple(tupdesc, values, nulls);
206 
207 	PG_RETURN_DATUM(HeapTupleGetDatum(htup));
208 }
209 
210 Datum
211 pg_control_recovery(PG_FUNCTION_ARGS)
212 {
213 	Datum		values[5];
214 	bool		nulls[5];
215 	TupleDesc	tupdesc;
216 	HeapTuple	htup;
217 	ControlFileData *ControlFile;
218 	bool		crc_ok;
219 
220 	/*
221 	 * Construct a tuple descriptor for the result row.  This must match this
222 	 * function's pg_proc entry!
223 	 */
224 	tupdesc = CreateTemplateTupleDesc(5);
225 	TupleDescInitEntry(tupdesc, (AttrNumber) 1, "min_recovery_end_lsn",
226 					   PG_LSNOID, -1, 0);
227 	TupleDescInitEntry(tupdesc, (AttrNumber) 2, "min_recovery_end_timeline",
228 					   INT4OID, -1, 0);
229 	TupleDescInitEntry(tupdesc, (AttrNumber) 3, "backup_start_lsn",
230 					   PG_LSNOID, -1, 0);
231 	TupleDescInitEntry(tupdesc, (AttrNumber) 4, "backup_end_lsn",
232 					   PG_LSNOID, -1, 0);
233 	TupleDescInitEntry(tupdesc, (AttrNumber) 5, "end_of_backup_record_required",
234 					   BOOLOID, -1, 0);
235 	tupdesc = BlessTupleDesc(tupdesc);
236 
237 	/* read the control file */
eval_timer(struct interval_timer * it,const struct timespec * now,unsigned int * msec_to_next_event)238 	ControlFile = get_controlfile(DataDir, &crc_ok);
239 	if (!crc_ok)
240 		ereport(ERROR,
241 				(errmsg("calculated CRC checksum does not match value stored in file")));
242 
243 	values[0] = LSNGetDatum(ControlFile->minRecoveryPoint);
244 	nulls[0] = false;
245 
246 	values[1] = Int32GetDatum(ControlFile->minRecoveryPointTLI);
247 	nulls[1] = false;
248 
249 	values[2] = LSNGetDatum(ControlFile->backupStartPoint);
250 	nulls[2] = false;
251 
252 	values[3] = LSNGetDatum(ControlFile->backupEndPoint);
253 	nulls[3] = false;
254 
255 	values[4] = BoolGetDatum(ControlFile->backupEndRequired);
256 	nulls[4] = false;
257 
258 	htup = heap_form_tuple(tupdesc, values, nulls);
259 
260 	PG_RETURN_DATUM(HeapTupleGetDatum(htup));
261 }
262 
263 Datum
264 pg_control_init(PG_FUNCTION_ARGS)
265 {
266 	Datum		values[11];
helper_thread_main(void * data)267 	bool		nulls[11];
268 	TupleDesc	tupdesc;
269 	HeapTuple	htup;
270 	ControlFileData *ControlFile;
271 	bool		crc_ok;
272 
273 	/*
274 	 * Construct a tuple descriptor for the result row.  This must match this
275 	 * function's pg_proc entry!
276 	 */
277 	tupdesc = CreateTemplateTupleDesc(11);
278 	TupleDescInitEntry(tupdesc, (AttrNumber) 1, "max_data_alignment",
279 					   INT4OID, -1, 0);
280 	TupleDescInitEntry(tupdesc, (AttrNumber) 2, "database_block_size",
281 					   INT4OID, -1, 0);
282 	TupleDescInitEntry(tupdesc, (AttrNumber) 3, "blocks_per_segment",
283 					   INT4OID, -1, 0);
284 	TupleDescInitEntry(tupdesc, (AttrNumber) 4, "wal_block_size",
285 					   INT4OID, -1, 0);
286 	TupleDescInitEntry(tupdesc, (AttrNumber) 5, "bytes_per_wal_segment",
287 					   INT4OID, -1, 0);
288 	TupleDescInitEntry(tupdesc, (AttrNumber) 6, "max_identifier_length",
289 					   INT4OID, -1, 0);
290 	TupleDescInitEntry(tupdesc, (AttrNumber) 7, "max_index_columns",
291 					   INT4OID, -1, 0);
292 	TupleDescInitEntry(tupdesc, (AttrNumber) 8, "max_toast_chunk_size",
293 					   INT4OID, -1, 0);
294 	TupleDescInitEntry(tupdesc, (AttrNumber) 9, "large_object_chunk_size",
295 					   INT4OID, -1, 0);
296 	TupleDescInitEntry(tupdesc, (AttrNumber) 10, "float8_pass_by_value",
297 					   BOOLOID, -1, 0);
298 	TupleDescInitEntry(tupdesc, (AttrNumber) 11, "data_page_checksum_version",
299 					   INT4OID, -1, 0);
300 	tupdesc = BlessTupleDesc(tupdesc);
301 
302 	/* read the control file */
303 	ControlFile = get_controlfile(DataDir, &crc_ok);
304 	if (!crc_ok)
305 		ereport(ERROR,
306 				(errmsg("calculated CRC checksum does not match value stored in file")));
307 
308 	values[0] = Int32GetDatum(ControlFile->maxAlign);
309 	nulls[0] = false;
310 
311 	values[1] = Int32GetDatum(ControlFile->blcksz);
312 	nulls[1] = false;
313 
314 	values[2] = Int32GetDatum(ControlFile->relseg_size);
315 	nulls[2] = false;
316 
317 	values[3] = Int32GetDatum(ControlFile->xlog_blcksz);
318 	nulls[3] = false;
319 
320 	values[4] = Int32GetDatum(ControlFile->xlog_seg_size);
321 	nulls[4] = false;
322 
323 	values[5] = Int32GetDatum(ControlFile->nameDataLen);
324 	nulls[5] = false;
325 
326 	values[6] = Int32GetDatum(ControlFile->indexMaxKeys);
327 	nulls[6] = false;
328 
329 	values[7] = Int32GetDatum(ControlFile->toast_max_chunk_size);
330 	nulls[7] = false;
331 
332 	values[8] = Int32GetDatum(ControlFile->loblksize);
333 	nulls[8] = false;
334 
335 	values[9] = BoolGetDatum(ControlFile->float8ByVal);
336 	nulls[9] = false;
337 
338 	values[10] = Int32GetDatum(ControlFile->data_checksum_version);
339 	nulls[10] = false;
340 
341 	htup = heap_form_tuple(tupdesc, values, nulls);
342 
343 	PG_RETURN_DATUM(HeapTupleGetDatum(htup));
344 }
345