PostgreSQL Source Code  git master
pg_controldata.c
Go to the documentation of this file.
1 /*
2  * pg_controldata
3  *
4  * reads the data from $PGDATA/global/pg_control
5  *
6  * copyright (c) Oliver Elphick <olly@lfix.co.uk>, 2001;
7  * license: BSD
8  *
9  * src/bin/pg_controldata/pg_controldata.c
10  */
11 
12 /*
13  * We have to use postgres.h not postgres_fe.h here, because there's so much
14  * backend-only stuff in the XLOG include files we need. But we need a
15  * frontend-ish environment otherwise. Hence this ugly hack.
16  */
17 #define FRONTEND 1
18 
19 #include "postgres.h"
20 
21 #include <time.h>
22 
23 #include "access/transam.h"
24 #include "access/xlog.h"
25 #include "access/xlog_internal.h"
26 #include "catalog/pg_control.h"
28 #include "common/logging.h"
29 #include "getopt_long.h"
30 #include "pg_getopt.h"
31 
32 static void
33 usage(const char *progname)
34 {
35  printf(_("%s displays control information of a PostgreSQL database cluster.\n\n"), progname);
36  printf(_("Usage:\n"));
37  printf(_(" %s [OPTION] [DATADIR]\n"), progname);
38  printf(_("\nOptions:\n"));
39  printf(_(" [-D, --pgdata=]DATADIR data directory\n"));
40  printf(_(" -V, --version output version information, then exit\n"));
41  printf(_(" -?, --help show this help, then exit\n"));
42  printf(_("\nIf no data directory (DATADIR) is specified, "
43  "the environment variable PGDATA\nis used.\n\n"));
44  printf(_("Report bugs to <pgsql-bugs@lists.postgresql.org>.\n"));
45 }
46 
47 
48 static const char *
50 {
51  switch (state)
52  {
53  case DB_STARTUP:
54  return _("starting up");
55  case DB_SHUTDOWNED:
56  return _("shut down");
58  return _("shut down in recovery");
59  case DB_SHUTDOWNING:
60  return _("shutting down");
62  return _("in crash recovery");
64  return _("in archive recovery");
65  case DB_IN_PRODUCTION:
66  return _("in production");
67  }
68  return _("unrecognized status code");
69 }
70 
71 static const char *
73 {
74  switch (wal_level)
75  {
76  case WAL_LEVEL_MINIMAL:
77  return "minimal";
78  case WAL_LEVEL_REPLICA:
79  return "replica";
80  case WAL_LEVEL_LOGICAL:
81  return "logical";
82  }
83  return _("unrecognized wal_level");
84 }
85 
86 
87 int
88 main(int argc, char *argv[])
89 {
90  static struct option long_options[] = {
91  {"pgdata", required_argument, NULL, 'D'},
92  {NULL, 0, NULL, 0}
93  };
94 
96  bool crc_ok;
97  char *DataDir = NULL;
98  time_t time_tmp;
99  char pgctime_str[128];
100  char ckpttime_str[128];
101  char mock_auth_nonce_str[MOCK_AUTH_NONCE_LEN * 2 + 1];
102  const char *strftime_fmt = "%c";
103  const char *progname;
104  char xlogfilename[MAXFNAMELEN];
105  int c;
106  int i;
107  int WalSegSz;
108 
109  pg_logging_init(argv[0]);
110  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_controldata"));
111  progname = get_progname(argv[0]);
112 
113  if (argc > 1)
114  {
115  if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
116  {
117  usage(progname);
118  exit(0);
119  }
120  if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
121  {
122  puts("pg_controldata (PostgreSQL) " PG_VERSION);
123  exit(0);
124  }
125  }
126 
127  while ((c = getopt_long(argc, argv, "D:", long_options, NULL)) != -1)
128  {
129  switch (c)
130  {
131  case 'D':
132  DataDir = optarg;
133  break;
134 
135  default:
136  fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
137  exit(1);
138  }
139  }
140 
141  if (DataDir == NULL)
142  {
143  if (optind < argc)
144  DataDir = argv[optind++];
145  else
146  DataDir = getenv("PGDATA");
147  }
148 
149  /* Complain if any arguments remain */
150  if (optind < argc)
151  {
152  pg_log_error("too many command-line arguments (first is \"%s\")",
153  argv[optind]);
154  fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
155  progname);
156  exit(1);
157  }
158 
159  if (DataDir == NULL)
160  {
161  pg_log_error("no data directory specified");
162  fprintf(stderr, _("Try \"%s --help\" for more information.\n"), progname);
163  exit(1);
164  }
165 
166  /* get a copy of the control file */
167  ControlFile = get_controlfile(DataDir, &crc_ok);
168  if (!crc_ok)
169  printf(_("WARNING: Calculated CRC checksum does not match value stored in file.\n"
170  "Either the file is corrupt, or it has a different layout than this program\n"
171  "is expecting. The results below are untrustworthy.\n\n"));
172 
173  /* set wal segment size */
174  WalSegSz = ControlFile->xlog_seg_size;
175 
176  if (!IsValidWalSegSize(WalSegSz))
177  {
178  printf(_("WARNING: invalid WAL segment size\n"));
179  printf(ngettext("The WAL segment size stored in the file, %d byte, is not a power of two\n"
180  "between 1 MB and 1 GB. The file is corrupt and the results below are\n"
181  "untrustworthy.\n\n",
182  "The WAL segment size stored in the file, %d bytes, is not a power of two\n"
183  "between 1 MB and 1 GB. The file is corrupt and the results below are\n"
184  "untrustworthy.\n\n",
185  WalSegSz),
186  WalSegSz);
187  }
188 
189  /*
190  * This slightly-chintzy coding will work as long as the control file
191  * timestamps are within the range of time_t; that should be the case in
192  * all foreseeable circumstances, so we don't bother importing the
193  * backend's timezone library into pg_controldata.
194  *
195  * Use variable for format to suppress overly-anal-retentive gcc warning
196  * about %c
197  */
198  time_tmp = (time_t) ControlFile->time;
199  strftime(pgctime_str, sizeof(pgctime_str), strftime_fmt,
200  localtime(&time_tmp));
201  time_tmp = (time_t) ControlFile->checkPointCopy.time;
202  strftime(ckpttime_str, sizeof(ckpttime_str), strftime_fmt,
203  localtime(&time_tmp));
204 
205  /*
206  * Calculate name of the WAL file containing the latest checkpoint's REDO
207  * start point.
208  *
209  * A corrupted control file could report a WAL segment size of 0, and to
210  * guard against division by zero, we need to treat that specially.
211  */
212  if (WalSegSz != 0)
213  {
214  XLogSegNo segno;
215 
216  XLByteToSeg(ControlFile->checkPointCopy.redo, segno, WalSegSz);
217  XLogFileName(xlogfilename, ControlFile->checkPointCopy.ThisTimeLineID,
218  segno, WalSegSz);
219  }
220  else
221  strcpy(xlogfilename, _("???"));
222 
223  for (i = 0; i < MOCK_AUTH_NONCE_LEN; i++)
224  snprintf(&mock_auth_nonce_str[i * 2], 3, "%02x",
225  (unsigned char) ControlFile->mock_authentication_nonce[i]);
226 
227  printf(_("pg_control version number: %u\n"),
228  ControlFile->pg_control_version);
229  printf(_("Catalog version number: %u\n"),
230  ControlFile->catalog_version_no);
231  printf(_("Database system identifier: %llu\n"),
232  (unsigned long long) ControlFile->system_identifier);
233  printf(_("Database cluster state: %s\n"),
234  dbState(ControlFile->state));
235  printf(_("pg_control last modified: %s\n"),
236  pgctime_str);
237  printf(_("Latest checkpoint location: %X/%X\n"),
238  (uint32) (ControlFile->checkPoint >> 32),
239  (uint32) ControlFile->checkPoint);
240  printf(_("Latest checkpoint's REDO location: %X/%X\n"),
241  (uint32) (ControlFile->checkPointCopy.redo >> 32),
242  (uint32) ControlFile->checkPointCopy.redo);
243  printf(_("Latest checkpoint's REDO WAL file: %s\n"),
244  xlogfilename);
245  printf(_("Latest checkpoint's TimeLineID: %u\n"),
246  ControlFile->checkPointCopy.ThisTimeLineID);
247  printf(_("Latest checkpoint's PrevTimeLineID: %u\n"),
248  ControlFile->checkPointCopy.PrevTimeLineID);
249  printf(_("Latest checkpoint's full_page_writes: %s\n"),
250  ControlFile->checkPointCopy.fullPageWrites ? _("on") : _("off"));
251  printf(_("Latest checkpoint's NextXID: %u:%u\n"),
254  printf(_("Latest checkpoint's NextOID: %u\n"),
255  ControlFile->checkPointCopy.nextOid);
256  printf(_("Latest checkpoint's NextMultiXactId: %u\n"),
257  ControlFile->checkPointCopy.nextMulti);
258  printf(_("Latest checkpoint's NextMultiOffset: %u\n"),
259  ControlFile->checkPointCopy.nextMultiOffset);
260  printf(_("Latest checkpoint's oldestXID: %u\n"),
261  ControlFile->checkPointCopy.oldestXid);
262  printf(_("Latest checkpoint's oldestXID's DB: %u\n"),
263  ControlFile->checkPointCopy.oldestXidDB);
264  printf(_("Latest checkpoint's oldestActiveXID: %u\n"),
265  ControlFile->checkPointCopy.oldestActiveXid);
266  printf(_("Latest checkpoint's oldestMultiXid: %u\n"),
267  ControlFile->checkPointCopy.oldestMulti);
268  printf(_("Latest checkpoint's oldestMulti's DB: %u\n"),
269  ControlFile->checkPointCopy.oldestMultiDB);
270  printf(_("Latest checkpoint's oldestCommitTsXid:%u\n"),
271  ControlFile->checkPointCopy.oldestCommitTsXid);
272  printf(_("Latest checkpoint's newestCommitTsXid:%u\n"),
273  ControlFile->checkPointCopy.newestCommitTsXid);
274  printf(_("Time of latest checkpoint: %s\n"),
275  ckpttime_str);
276  printf(_("Fake LSN counter for unlogged rels: %X/%X\n"),
277  (uint32) (ControlFile->unloggedLSN >> 32),
278  (uint32) ControlFile->unloggedLSN);
279  printf(_("Minimum recovery ending location: %X/%X\n"),
280  (uint32) (ControlFile->minRecoveryPoint >> 32),
281  (uint32) ControlFile->minRecoveryPoint);
282  printf(_("Min recovery ending loc's timeline: %u\n"),
283  ControlFile->minRecoveryPointTLI);
284  printf(_("Backup start location: %X/%X\n"),
285  (uint32) (ControlFile->backupStartPoint >> 32),
286  (uint32) ControlFile->backupStartPoint);
287  printf(_("Backup end location: %X/%X\n"),
288  (uint32) (ControlFile->backupEndPoint >> 32),
289  (uint32) ControlFile->backupEndPoint);
290  printf(_("End-of-backup record required: %s\n"),
291  ControlFile->backupEndRequired ? _("yes") : _("no"));
292  printf(_("wal_level setting: %s\n"),
293  wal_level_str(ControlFile->wal_level));
294  printf(_("wal_log_hints setting: %s\n"),
295  ControlFile->wal_log_hints ? _("on") : _("off"));
296  printf(_("max_connections setting: %d\n"),
297  ControlFile->MaxConnections);
298  printf(_("max_worker_processes setting: %d\n"),
299  ControlFile->max_worker_processes);
300  printf(_("max_wal_senders setting: %d\n"),
301  ControlFile->max_wal_senders);
302  printf(_("max_prepared_xacts setting: %d\n"),
303  ControlFile->max_prepared_xacts);
304  printf(_("max_locks_per_xact setting: %d\n"),
305  ControlFile->max_locks_per_xact);
306  printf(_("track_commit_timestamp setting: %s\n"),
307  ControlFile->track_commit_timestamp ? _("on") : _("off"));
308  printf(_("Maximum data alignment: %u\n"),
309  ControlFile->maxAlign);
310  /* we don't print floatFormat since can't say much useful about it */
311  printf(_("Database block size: %u\n"),
312  ControlFile->blcksz);
313  printf(_("Blocks per segment of large relation: %u\n"),
314  ControlFile->relseg_size);
315  printf(_("WAL block size: %u\n"),
316  ControlFile->xlog_blcksz);
317  printf(_("Bytes per WAL segment: %u\n"),
318  ControlFile->xlog_seg_size);
319  printf(_("Maximum length of identifiers: %u\n"),
320  ControlFile->nameDataLen);
321  printf(_("Maximum columns in an index: %u\n"),
322  ControlFile->indexMaxKeys);
323  printf(_("Maximum size of a TOAST chunk: %u\n"),
324  ControlFile->toast_max_chunk_size);
325  printf(_("Size of a large-object chunk: %u\n"),
326  ControlFile->loblksize);
327  /* This is no longer configurable, but users may still expect to see it: */
328  printf(_("Date/time type storage: %s\n"),
329  _("64-bit integers"));
330  printf(_("Float8 argument passing: %s\n"),
331  (ControlFile->float8ByVal ? _("by value") : _("by reference")));
332  printf(_("Data page checksum version: %u\n"),
333  ControlFile->data_checksum_version);
334  printf(_("Mock authentication nonce: %s\n"),
335  mock_auth_nonce_str);
336  return 0;
337 }
#define IsValidWalSegSize(size)
Definition: xlog_internal.h:97
int max_locks_per_xact
Definition: pg_control.h:182
static const char * wal_level_str(WalLevel wal_level)
int max_prepared_xacts
Definition: pg_control.h:181
pg_time_t time
Definition: pg_control.h:128
TimeLineID minRecoveryPointTLI
Definition: pg_control.h:167
const char * get_progname(const char *argv0)
Definition: path.c:453
int max_worker_processes
Definition: pg_control.h:179
#define pg_log_error(...)
Definition: logging.h:79
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:57
TransactionId oldestActiveXid
Definition: pg_control.h:63
int wal_level
Definition: xlog.c:103
void pg_logging_init(const char *argv0)
Definition: logging.c:39
static void usage(const char *progname)
uint32 nameDataLen
Definition: pg_control.h:211
MultiXactId oldestMulti
Definition: pg_control.h:49
TimeLineID PrevTimeLineID
Definition: pg_control.h:40
uint32 pg_control_version
Definition: pg_control.h:121
#define printf(...)
Definition: port.h:198
int main(int argc, char *argv[])
CheckPoint checkPointCopy
Definition: pg_control.h:131
uint32 xlog_blcksz
Definition: pg_control.h:208
TransactionId oldestXid
Definition: pg_control.h:47
const char * progname
Definition: pg_standby.c:36
#define fprintf
Definition: port.h:196
pg_time_t time
Definition: pg_control.h:51
#define XidFromFullTransactionId(x)
Definition: transam.h:48
#define MOCK_AUTH_NONCE_LEN
Definition: pg_control.h:28
bool backupEndRequired
Definition: pg_control.h:170
MultiXactOffset nextMultiOffset
Definition: pg_control.h:46
#define required_argument
Definition: getopt_long.h:25
TransactionId oldestCommitTsXid
Definition: pg_control.h:52
uint32 xlog_seg_size
Definition: pg_control.h:209
int optind
Definition: getopt.c:50
uint64 system_identifier
Definition: pg_control.h:106
uint32 data_checksum_version
Definition: pg_control.h:220
char * c
XLogRecPtr unloggedLSN
Definition: pg_control.h:133
uint64 XLogSegNo
Definition: xlogdefs.h:41
unsigned int uint32
Definition: c.h:359
uint32 loblksize
Definition: pg_control.h:215
uint32 indexMaxKeys
Definition: pg_control.h:212
DBState
Definition: pg_control.h:85
#define MAXFNAMELEN
#define ngettext(s, p, n)
Definition: c.h:1134
TransactionId newestCommitTsXid
Definition: pg_control.h:54
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1166
char mock_authentication_nonce[MOCK_AUTH_NONCE_LEN]
Definition: pg_control.h:227
Oid oldestMultiDB
Definition: pg_control.h:50
uint32 toast_max_chunk_size
Definition: pg_control.h:214
#define EpochFromFullTransactionId(x)
Definition: transam.h:47
static ControlFileData * ControlFile
Definition: xlog.c:721
Oid nextOid
Definition: pg_control.h:44
XLogRecPtr backupEndPoint
Definition: pg_control.h:169
bool fullPageWrites
Definition: pg_control.h:42
bool track_commit_timestamp
Definition: pg_control.h:183
Definition: regguts.h:298
FullTransactionId nextFullXid
Definition: pg_control.h:43
Oid oldestXidDB
Definition: pg_control.h:48
ControlFileData * get_controlfile(const char *DataDir, bool *crc_ok_p)
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
MultiXactId nextMulti
Definition: pg_control.h:45
uint32 catalog_version_no
Definition: pg_control.h:122
int WalSegSz
Definition: pg_standby.c:38
TimeLineID ThisTimeLineID
Definition: pg_control.h:39
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:565
char * optarg
Definition: getopt.c:52
int i
char * DataDir
Definition: globals.c:62
#define snprintf
Definition: port.h:192
#define _(x)
Definition: elog.c:87
static const char * dbState(DBState state)
XLogRecPtr backupStartPoint
Definition: pg_control.h:168
uint32 relseg_size
Definition: pg_control.h:206
XLogRecPtr checkPoint
Definition: pg_control.h:129
XLogRecPtr redo
Definition: pg_control.h:37
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:166
WalLevel
Definition: xlog.h:160
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)