PostgreSQL Source Code  git master
pg_control.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pg_control.h
4  * The system control file "pg_control" is not a heap relation.
5  * However, we define it here so that the format is documented.
6  *
7  *
8  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
9  * Portions Copyright (c) 1994, Regents of the University of California
10  *
11  * src/include/catalog/pg_control.h
12  *
13  *-------------------------------------------------------------------------
14  */
15 #ifndef PG_CONTROL_H
16 #define PG_CONTROL_H
17 
18 #include "access/transam.h"
19 #include "access/xlogdefs.h"
20 #include "pgtime.h" /* for pg_time_t */
21 #include "port/pg_crc32c.h"
22 
23 
24 /* Version identifier for this pg_control format */
25 #define PG_CONTROL_VERSION 1300
26 
27 /* Nonce key length, see below */
28 #define MOCK_AUTH_NONCE_LEN 32
29 
30 /*
31  * Body of CheckPoint XLOG records. This is declared here because we keep
32  * a copy of the latest one in pg_control for possible disaster recovery.
33  * Changing this struct requires a PG_CONTROL_VERSION bump.
34  */
35 typedef struct CheckPoint
36 {
37  XLogRecPtr redo; /* next RecPtr available when we began to
38  * create CheckPoint (i.e. REDO start point) */
39  TimeLineID ThisTimeLineID; /* current TLI */
40  TimeLineID PrevTimeLineID; /* previous TLI, if this record begins a new
41  * timeline (equals ThisTimeLineID otherwise) */
42  bool fullPageWrites; /* current full_page_writes */
43  FullTransactionId nextXid; /* next free transaction ID */
44  Oid nextOid; /* next free OID */
45  MultiXactId nextMulti; /* next free MultiXactId */
46  MultiXactOffset nextMultiOffset; /* next free MultiXact offset */
47  TransactionId oldestXid; /* cluster-wide minimum datfrozenxid */
48  Oid oldestXidDB; /* database with minimum datfrozenxid */
49  MultiXactId oldestMulti; /* cluster-wide minimum datminmxid */
50  Oid oldestMultiDB; /* database with minimum datminmxid */
51  pg_time_t time; /* time stamp of checkpoint */
52  TransactionId oldestCommitTsXid; /* oldest Xid with valid commit
53  * timestamp */
54  TransactionId newestCommitTsXid; /* newest Xid with valid commit
55  * timestamp */
56 
57  /*
58  * Oldest XID still running. This is only needed to initialize hot standby
59  * mode from an online checkpoint, so we only bother calculating this for
60  * online checkpoints and only when wal_level is replica. Otherwise it's
61  * set to InvalidTransactionId.
62  */
65 
66 /* XLOG info values for XLOG rmgr */
67 #define XLOG_CHECKPOINT_SHUTDOWN 0x00
68 #define XLOG_CHECKPOINT_ONLINE 0x10
69 #define XLOG_NOOP 0x20
70 #define XLOG_NEXTOID 0x30
71 #define XLOG_SWITCH 0x40
72 #define XLOG_BACKUP_END 0x50
73 #define XLOG_PARAMETER_CHANGE 0x60
74 #define XLOG_RESTORE_POINT 0x70
75 #define XLOG_FPW_CHANGE 0x80
76 #define XLOG_END_OF_RECOVERY 0x90
77 #define XLOG_FPI_FOR_HINT 0xA0
78 #define XLOG_FPI 0xB0
79 /* 0xC0 is used in Postgres 9.5-11 */
80 #define XLOG_OVERWRITE_CONTRECORD 0xD0
81 #define XLOG_CHECKPOINT_REDO 0xE0
82 
83 
84 /*
85  * System status indicator. Note this is stored in pg_control; if you change
86  * it, you must bump PG_CONTROL_VERSION
87  */
88 typedef enum DBState
89 {
98 
99 /*
100  * Contents of pg_control.
101  */
102 
103 typedef struct ControlFileData
104 {
105  /*
106  * Unique system identifier --- to ensure we match up xlog files with the
107  * installation that produced them.
108  */
110 
111  /*
112  * Version identifier information. Keep these fields at the same offset,
113  * especially pg_control_version; they won't be real useful if they move
114  * around. (For historical reasons they must be 8 bytes into the file
115  * rather than immediately at the front.)
116  *
117  * pg_control_version identifies the format of pg_control itself.
118  * catalog_version_no identifies the format of the system catalogs.
119  *
120  * There are additional version identifiers in individual files; for
121  * example, WAL logs contain per-page magic numbers that can serve as
122  * version cues for the WAL log.
123  */
124  uint32 pg_control_version; /* PG_CONTROL_VERSION */
125  uint32 catalog_version_no; /* see catversion.h */
126 
127  /*
128  * System status data
129  */
130  DBState state; /* see enum above */
131  pg_time_t time; /* time stamp of last pg_control update */
132  XLogRecPtr checkPoint; /* last check point record ptr */
133 
134  CheckPoint checkPointCopy; /* copy of last check point record */
135 
136  XLogRecPtr unloggedLSN; /* current fake LSN value, for unlogged rels */
137 
138  /*
139  * These two values determine the minimum point we must recover up to
140  * before starting up:
141  *
142  * minRecoveryPoint is updated to the latest replayed LSN whenever we
143  * flush a data change during archive recovery. That guards against
144  * starting archive recovery, aborting it, and restarting with an earlier
145  * stop location. If we've already flushed data changes from WAL record X
146  * to disk, we mustn't start up until we reach X again. Zero when not
147  * doing archive recovery.
148  *
149  * backupStartPoint is the redo pointer of the backup start checkpoint, if
150  * we are recovering from an online backup and haven't reached the end of
151  * backup yet. It is reset to zero when the end of backup is reached, and
152  * we mustn't start up before that. A boolean would suffice otherwise, but
153  * we use the redo pointer as a cross-check when we see an end-of-backup
154  * record, to make sure the end-of-backup record corresponds the base
155  * backup we're recovering from.
156  *
157  * backupEndPoint is the backup end location, if we are recovering from an
158  * online backup which was taken from the standby and haven't reached the
159  * end of backup yet. It is initialized to the minimum recovery point in
160  * pg_control which was backed up last. It is reset to zero when the end
161  * of backup is reached, and we mustn't start up before that.
162  *
163  * If backupEndRequired is true, we know for sure that we're restoring
164  * from a backup, and must see a backup-end record before we can safely
165  * start up.
166  */
172 
173  /*
174  * Parameter settings that determine if the WAL can be used for archival
175  * or hot standby.
176  */
185 
186  /*
187  * This data is used to check for hardware-architecture compatibility of
188  * the database and the backend executable. We need not check endianness
189  * explicitly, since the pg_control version will surely look wrong to a
190  * machine of different endianness, but we do need to worry about MAXALIGN
191  * and floating-point format. (Note: storage layout nominally also
192  * depends on SHORTALIGN and INTALIGN, but in practice these are the same
193  * on all architectures of interest.)
194  *
195  * Testing just one double value is not a very bulletproof test for
196  * floating-point compatibility, but it will catch most cases.
197  */
198  uint32 maxAlign; /* alignment requirement for tuples */
199  double floatFormat; /* constant 1234567.0 */
200 #define FLOATFORMAT_VALUE 1234567.0
201 
202  /*
203  * This data is used to make sure that configuration of this database is
204  * compatible with the backend executable.
205  */
206  uint32 blcksz; /* data block size for this DB */
207  uint32 relseg_size; /* blocks per segment of large relation */
208 
209  uint32 xlog_blcksz; /* block size within WAL files */
210  uint32 xlog_seg_size; /* size of each WAL segment */
211 
212  uint32 nameDataLen; /* catalog name field width */
213  uint32 indexMaxKeys; /* max number of columns in an index */
214 
215  uint32 toast_max_chunk_size; /* chunk size in TOAST tables */
216  uint32 loblksize; /* chunk size in pg_largeobject */
217 
218  bool float8ByVal; /* float8, int8, etc pass-by-value? */
219 
220  /* Are data pages protected by checksums? Zero if no checksum version */
222 
223  /*
224  * Random nonce, used in authentication requests that need to proceed
225  * based on values that are cluster-unique, like a SASL exchange that
226  * failed at an early stage.
227  */
229 
230  /* CRC of all above ... MUST BE LAST! */
233 
234 /*
235  * Maximum safe value of sizeof(ControlFileData). For reliability's sake,
236  * it's critical that pg_control updates be atomic writes. That generally
237  * means the active data can't be more than one disk sector, which is 512
238  * bytes on common hardware. Be very careful about raising this limit.
239  */
240 #define PG_CONTROL_MAX_SAFE_SIZE 512
241 
242 /*
243  * Physical size of the pg_control file. Note that this is considerably
244  * bigger than the actually used size (ie, sizeof(ControlFileData)).
245  * The idea is to keep the physical size constant independent of format
246  * changes, so that ReadControlFile will deliver a suitable wrong-version
247  * message instead of a read error if it's looking at an incompatible file.
248  */
249 #define PG_CONTROL_FILE_SIZE 8192
250 
251 /*
252  * Ensure that the size of the pg_control data structure is sane.
253  */
255  "pg_control is too large for atomic disk writes");
257  "sizeof(ControlFileData) exceeds PG_CONTROL_FILE_SIZE");
258 
259 #endif /* PG_CONTROL_H */
unsigned int uint32
Definition: c.h:495
uint32 MultiXactOffset
Definition: c.h:653
TransactionId MultiXactId
Definition: c.h:651
uint32 TransactionId
Definition: c.h:641
struct ControlFileData ControlFileData
StaticAssertDecl(sizeof(ControlFileData)<=PG_CONTROL_MAX_SAFE_SIZE, "pg_control is too large for atomic disk writes")
#define PG_CONTROL_MAX_SAFE_SIZE
Definition: pg_control.h:240
struct CheckPoint CheckPoint
#define MOCK_AUTH_NONCE_LEN
Definition: pg_control.h:28
DBState
Definition: pg_control.h:89
@ DB_IN_PRODUCTION
Definition: pg_control.h:96
@ DB_STARTUP
Definition: pg_control.h:90
@ DB_SHUTDOWNING
Definition: pg_control.h:93
@ DB_IN_ARCHIVE_RECOVERY
Definition: pg_control.h:95
@ DB_SHUTDOWNED_IN_RECOVERY
Definition: pg_control.h:92
@ DB_SHUTDOWNED
Definition: pg_control.h:91
@ DB_IN_CRASH_RECOVERY
Definition: pg_control.h:94
#define PG_CONTROL_FILE_SIZE
Definition: pg_control.h:249
uint32 pg_crc32c
Definition: pg_crc32c.h:38
int64 pg_time_t
Definition: pgtime.h:23
unsigned int Oid
Definition: postgres_ext.h:31
Oid oldestMultiDB
Definition: pg_control.h:50
MultiXactId oldestMulti
Definition: pg_control.h:49
MultiXactOffset nextMultiOffset
Definition: pg_control.h:46
TransactionId newestCommitTsXid
Definition: pg_control.h:54
TransactionId oldestXid
Definition: pg_control.h:47
TimeLineID PrevTimeLineID
Definition: pg_control.h:40
TimeLineID ThisTimeLineID
Definition: pg_control.h:39
Oid nextOid
Definition: pg_control.h:44
TransactionId oldestActiveXid
Definition: pg_control.h:63
bool fullPageWrites
Definition: pg_control.h:42
MultiXactId nextMulti
Definition: pg_control.h:45
FullTransactionId nextXid
Definition: pg_control.h:43
TransactionId oldestCommitTsXid
Definition: pg_control.h:52
pg_time_t time
Definition: pg_control.h:51
XLogRecPtr redo
Definition: pg_control.h:37
Oid oldestXidDB
Definition: pg_control.h:48
char mock_authentication_nonce[MOCK_AUTH_NONCE_LEN]
Definition: pg_control.h:228
int max_worker_processes
Definition: pg_control.h:180
uint32 pg_control_version
Definition: pg_control.h:124
uint32 xlog_seg_size
Definition: pg_control.h:210
XLogRecPtr backupStartPoint
Definition: pg_control.h:169
bool track_commit_timestamp
Definition: pg_control.h:184
bool backupEndRequired
Definition: pg_control.h:171
int max_locks_per_xact
Definition: pg_control.h:183
uint32 nameDataLen
Definition: pg_control.h:212
CheckPoint checkPointCopy
Definition: pg_control.h:134
XLogRecPtr backupEndPoint
Definition: pg_control.h:170
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:167
uint32 data_checksum_version
Definition: pg_control.h:221
XLogRecPtr unloggedLSN
Definition: pg_control.h:136
uint32 indexMaxKeys
Definition: pg_control.h:213
uint32 relseg_size
Definition: pg_control.h:207
pg_time_t time
Definition: pg_control.h:131
XLogRecPtr checkPoint
Definition: pg_control.h:132
uint64 system_identifier
Definition: pg_control.h:109
uint32 catalog_version_no
Definition: pg_control.h:125
double floatFormat
Definition: pg_control.h:199
int max_prepared_xacts
Definition: pg_control.h:182
uint32 xlog_blcksz
Definition: pg_control.h:209
TimeLineID minRecoveryPointTLI
Definition: pg_control.h:168
uint32 loblksize
Definition: pg_control.h:216
pg_crc32c crc
Definition: pg_control.h:231
uint32 toast_max_chunk_size
Definition: pg_control.h:215
uint64 XLogRecPtr
Definition: xlogdefs.h:21
uint32 TimeLineID
Definition: xlogdefs.h:59