PostgreSQL Source Code  git master
pg_controldata.c File Reference
#include "postgres.h"
#include <time.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 "common/logging.h"
#include "getopt_long.h"
#include "pg_getopt.h"
Include dependency graph for pg_controldata.c:

Go to the source code of this file.

Macros

#define FRONTEND   1
 

Functions

static void usage (const char *progname)
 
static const char * dbState (DBState state)
 
static const char * wal_level_str (WalLevel wal_level)
 
int main (int argc, char *argv[])
 

Macro Definition Documentation

◆ FRONTEND

#define FRONTEND   1

Definition at line 17 of file pg_controldata.c.

Function Documentation

◆ dbState()

static const char* dbState ( DBState  state)
static

Definition at line 50 of file pg_controldata.c.

51 {
52  switch (state)
53  {
54  case DB_STARTUP:
55  return _("starting up");
56  case DB_SHUTDOWNED:
57  return _("shut down");
59  return _("shut down in recovery");
60  case DB_SHUTDOWNING:
61  return _("shutting down");
63  return _("in crash recovery");
65  return _("in archive recovery");
66  case DB_IN_PRODUCTION:
67  return _("in production");
68  }
69  return _("unrecognized status code");
70 }
#define _(x)
Definition: elog.c:90
@ 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
Definition: regguts.h:323

References _, DB_IN_ARCHIVE_RECOVERY, DB_IN_CRASH_RECOVERY, DB_IN_PRODUCTION, DB_SHUTDOWNED, DB_SHUTDOWNED_IN_RECOVERY, DB_SHUTDOWNING, and DB_STARTUP.

Referenced by main().

◆ main()

int main ( int  argc,
char *  argv[] 
)

Definition at line 89 of file pg_controldata.c.

90 {
91  static struct option long_options[] = {
92  {"pgdata", required_argument, NULL, 'D'},
93  {NULL, 0, NULL, 0}
94  };
95 
97  bool crc_ok;
98  char *DataDir = NULL;
99  time_t time_tmp;
100  char pgctime_str[128];
101  char ckpttime_str[128];
102  char mock_auth_nonce_str[MOCK_AUTH_NONCE_LEN * 2 + 1];
103  const char *strftime_fmt = "%c";
104  const char *progname;
105  char xlogfilename[MAXFNAMELEN];
106  int c;
107  int i;
108  int WalSegSz;
109 
110  pg_logging_init(argv[0]);
111  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_controldata"));
112  progname = get_progname(argv[0]);
113 
114  if (argc > 1)
115  {
116  if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
117  {
118  usage(progname);
119  exit(0);
120  }
121  if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
122  {
123  puts("pg_controldata (PostgreSQL) " PG_VERSION);
124  exit(0);
125  }
126  }
127 
128  while ((c = getopt_long(argc, argv, "D:", long_options, NULL)) != -1)
129  {
130  switch (c)
131  {
132  case 'D':
133  DataDir = optarg;
134  break;
135 
136  default:
137  /* getopt_long already emitted a complaint */
138  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
139  exit(1);
140  }
141  }
142 
143  if (DataDir == NULL)
144  {
145  if (optind < argc)
146  DataDir = argv[optind++];
147  else
148  DataDir = getenv("PGDATA");
149  }
150 
151  /* Complain if any arguments remain */
152  if (optind < argc)
153  {
154  pg_log_error("too many command-line arguments (first is \"%s\")",
155  argv[optind]);
156  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
157  exit(1);
158  }
159 
160  if (DataDir == NULL)
161  {
162  pg_log_error("no data directory specified");
163  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
164  exit(1);
165  }
166 
167  /* get a copy of the control file */
168  ControlFile = get_controlfile(DataDir, &crc_ok);
169  if (!crc_ok)
170  {
171  pg_log_warning("calculated CRC checksum does not match value stored in control file");
172  pg_log_warning_detail("Either the control file is corrupt, or it has a different layout than this program "
173  "is expecting. The results below are untrustworthy.");
174  }
175 
176  /* set wal segment size */
178 
180  {
181  pg_log_warning(ngettext("invalid WAL segment size in control file (%d byte)",
182  "invalid WAL segment size in control file (%d bytes)",
183  WalSegSz),
184  WalSegSz);
185  pg_log_warning_detail("The WAL segment size must be a power of two between 1 MB and 1 GB.");
186  pg_log_warning_detail("The file is corrupt and the results below are untrustworthy.");
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 
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"),
229  printf(_("Catalog version number: %u\n"),
231  printf(_("Database system identifier: %llu\n"),
232  (unsigned long long) ControlFile->system_identifier);
233  printf(_("Database cluster state: %s\n"),
235  printf(_("pg_control last modified: %s\n"),
236  pgctime_str);
237  printf(_("Latest checkpoint location: %X/%X\n"),
239  printf(_("Latest checkpoint's REDO location: %X/%X\n"),
241  printf(_("Latest checkpoint's REDO WAL file: %s\n"),
242  xlogfilename);
243  printf(_("Latest checkpoint's TimeLineID: %u\n"),
245  printf(_("Latest checkpoint's PrevTimeLineID: %u\n"),
247  printf(_("Latest checkpoint's full_page_writes: %s\n"),
248  ControlFile->checkPointCopy.fullPageWrites ? _("on") : _("off"));
249  printf(_("Latest checkpoint's NextXID: %u:%u\n"),
252  printf(_("Latest checkpoint's NextOID: %u\n"),
254  printf(_("Latest checkpoint's NextMultiXactId: %u\n"),
256  printf(_("Latest checkpoint's NextMultiOffset: %u\n"),
258  printf(_("Latest checkpoint's oldestXID: %u\n"),
260  printf(_("Latest checkpoint's oldestXID's DB: %u\n"),
262  printf(_("Latest checkpoint's oldestActiveXID: %u\n"),
264  printf(_("Latest checkpoint's oldestMultiXid: %u\n"),
266  printf(_("Latest checkpoint's oldestMulti's DB: %u\n"),
268  printf(_("Latest checkpoint's oldestCommitTsXid:%u\n"),
270  printf(_("Latest checkpoint's newestCommitTsXid:%u\n"),
272  printf(_("Time of latest checkpoint: %s\n"),
273  ckpttime_str);
274  printf(_("Fake LSN counter for unlogged rels: %X/%X\n"),
276  printf(_("Minimum recovery ending location: %X/%X\n"),
278  printf(_("Min recovery ending loc's timeline: %u\n"),
280  printf(_("Backup start location: %X/%X\n"),
282  printf(_("Backup end location: %X/%X\n"),
284  printf(_("End-of-backup record required: %s\n"),
285  ControlFile->backupEndRequired ? _("yes") : _("no"));
286  printf(_("wal_level setting: %s\n"),
288  printf(_("wal_log_hints setting: %s\n"),
289  ControlFile->wal_log_hints ? _("on") : _("off"));
290  printf(_("max_connections setting: %d\n"),
292  printf(_("max_worker_processes setting: %d\n"),
294  printf(_("max_wal_senders setting: %d\n"),
296  printf(_("max_prepared_xacts setting: %d\n"),
298  printf(_("max_locks_per_xact setting: %d\n"),
300  printf(_("track_commit_timestamp setting: %s\n"),
301  ControlFile->track_commit_timestamp ? _("on") : _("off"));
302  printf(_("Maximum data alignment: %u\n"),
304  /* we don't print floatFormat since can't say much useful about it */
305  printf(_("Database block size: %u\n"),
307  printf(_("Blocks per segment of large relation: %u\n"),
309  printf(_("WAL block size: %u\n"),
311  printf(_("Bytes per WAL segment: %u\n"),
313  printf(_("Maximum length of identifiers: %u\n"),
315  printf(_("Maximum columns in an index: %u\n"),
317  printf(_("Maximum size of a TOAST chunk: %u\n"),
319  printf(_("Size of a large-object chunk: %u\n"),
321  /* This is no longer configurable, but users may still expect to see it: */
322  printf(_("Date/time type storage: %s\n"),
323  _("64-bit integers"));
324  printf(_("Float8 argument passing: %s\n"),
325  (ControlFile->float8ByVal ? _("by value") : _("by reference")));
326  printf(_("Data page checksum version: %u\n"),
328  printf(_("Mock authentication nonce: %s\n"),
329  mock_auth_nonce_str);
330  return 0;
331 }
static void usage(const char *progname)
static const char * dbState(DBState state)
static const char * wal_level_str(WalLevel wal_level)
#define ngettext(s, p, n)
Definition: c.h:1181
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1214
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:448
ControlFileData * get_controlfile(const char *DataDir, bool *crc_ok_p)
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:60
#define required_argument
Definition: getopt_long.h:25
char * DataDir
Definition: globals.c:68
int i
Definition: isn.c:73
exit(1)
void pg_logging_init(const char *argv0)
Definition: logging.c:83
#define pg_log_error(...)
Definition: logging.h:106
#define pg_log_error_hint(...)
Definition: logging.h:112
#define pg_log_warning_detail(...)
Definition: logging.h:118
const char * progname
Definition: main.c:44
#define MOCK_AUTH_NONCE_LEN
Definition: pg_control.h:28
PGDLLIMPORT int optind
Definition: getopt.c:50
PGDLLIMPORT char * optarg
Definition: getopt.c:52
#define pg_log_warning(...)
Definition: pgfnames.c:24
const char * get_progname(const char *argv0)
Definition: path.c:574
#define snprintf
Definition: port.h:238
#define printf(...)
Definition: port.h:244
char * c
int WalSegSz
Definition: streamutil.c:34
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
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
uint32 toast_max_chunk_size
Definition: pg_control.h:215
#define EpochFromFullTransactionId(x)
Definition: transam.h:47
#define XidFromFullTransactionId(x)
Definition: transam.h:48
static ControlFileData * ControlFile
Definition: xlog.c:569
#define IsValidWalSegSize(size)
Definition: xlog_internal.h:96
#define MAXFNAMELEN
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)
static void XLogFileName(char *fname, TimeLineID tli, XLogSegNo logSegNo, int wal_segsz_bytes)
#define LSN_FORMAT_ARGS(lsn)
Definition: xlogdefs.h:43
uint64 XLogSegNo
Definition: xlogdefs.h:48

References _, ControlFileData::backupEndPoint, ControlFileData::backupEndRequired, ControlFileData::backupStartPoint, ControlFileData::blcksz, ControlFileData::catalog_version_no, ControlFileData::checkPoint, ControlFileData::checkPointCopy, ControlFile, ControlFileData::data_checksum_version, DataDir, dbState(), EpochFromFullTransactionId, exit(), ControlFileData::float8ByVal, CheckPoint::fullPageWrites, get_controlfile(), get_progname(), getopt_long(), i, ControlFileData::indexMaxKeys, IsValidWalSegSize, ControlFileData::loblksize, LSN_FORMAT_ARGS, ControlFileData::max_locks_per_xact, ControlFileData::max_prepared_xacts, ControlFileData::max_wal_senders, ControlFileData::max_worker_processes, ControlFileData::maxAlign, ControlFileData::MaxConnections, MAXFNAMELEN, ControlFileData::minRecoveryPoint, ControlFileData::minRecoveryPointTLI, MOCK_AUTH_NONCE_LEN, ControlFileData::mock_authentication_nonce, ControlFileData::nameDataLen, CheckPoint::newestCommitTsXid, CheckPoint::nextMulti, CheckPoint::nextMultiOffset, CheckPoint::nextOid, CheckPoint::nextXid, ngettext, CheckPoint::oldestActiveXid, CheckPoint::oldestCommitTsXid, CheckPoint::oldestMulti, CheckPoint::oldestMultiDB, CheckPoint::oldestXid, CheckPoint::oldestXidDB, optarg, optind, ControlFileData::pg_control_version, pg_log_error, pg_log_error_hint, pg_log_warning, pg_log_warning_detail, pg_logging_init(), PG_TEXTDOMAIN, CheckPoint::PrevTimeLineID, printf, progname, CheckPoint::redo, ControlFileData::relseg_size, required_argument, set_pglocale_pgservice(), snprintf, ControlFileData::state, ControlFileData::system_identifier, CheckPoint::ThisTimeLineID, CheckPoint::time, ControlFileData::time, ControlFileData::toast_max_chunk_size, ControlFileData::track_commit_timestamp, ControlFileData::unloggedLSN, usage(), ControlFileData::wal_level, wal_level_str(), ControlFileData::wal_log_hints, WalSegSz, XidFromFullTransactionId, XLByteToSeg, ControlFileData::xlog_blcksz, ControlFileData::xlog_seg_size, and XLogFileName().

◆ usage()

static void usage ( const char *  progname)
static

Definition at line 33 of file pg_controldata.c.

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 <%s>.\n"), PACKAGE_BUGREPORT);
45  printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
46 }

References _, printf, and progname.

Referenced by main().

◆ wal_level_str()

static const char* wal_level_str ( WalLevel  wal_level)
static

Definition at line 73 of file pg_controldata.c.

74 {
75  switch (wal_level)
76  {
77  case WAL_LEVEL_MINIMAL:
78  return "minimal";
79  case WAL_LEVEL_REPLICA:
80  return "replica";
81  case WAL_LEVEL_LOGICAL:
82  return "logical";
83  }
84  return _("unrecognized \"wal_level\"");
85 }
int wal_level
Definition: xlog.c:131
@ WAL_LEVEL_REPLICA
Definition: xlog.h:73
@ WAL_LEVEL_LOGICAL
Definition: xlog.h:74
@ WAL_LEVEL_MINIMAL
Definition: xlog.h:72

References _, wal_level, WAL_LEVEL_LOGICAL, WAL_LEVEL_MINIMAL, and WAL_LEVEL_REPLICA.

Referenced by main(), and xlog_desc().