PostgreSQL Source Code  git master
pg_verifybackup.c File Reference
#include "postgres_fe.h"
#include <dirent.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <time.h>
#include "common/hashfn.h"
#include "common/logging.h"
#include "fe_utils/simple_list.h"
#include "getopt_long.h"
#include "parse_manifest.h"
#include "pgtime.h"
#include "lib/simplehash.h"
Include dependency graph for pg_verifybackup.c:

Go to the source code of this file.

Data Structures

struct  manifest_file
 
struct  manifest_wal_range
 
struct  parser_context
 
struct  verifier_context
 

Macros

#define ESTIMATED_BYTES_PER_MANIFEST_LINE   100
 
#define READ_CHUNK_SIZE   4096
 
#define should_verify_checksum(m)    (((m)->matched) && !((m)->bad) && (((m)->checksum_type) != CHECKSUM_TYPE_NONE))
 
#define SH_PREFIX   manifest_files
 
#define SH_ELEMENT_TYPE   manifest_file
 
#define SH_KEY_TYPE   char *
 
#define SH_KEY   pathname
 
#define SH_HASH_KEY(tb, key)   hash_string_pointer(key)
 
#define SH_EQUAL(tb, a, b)   (strcmp(a, b) == 0)
 
#define SH_SCOPE   static inline
 
#define SH_RAW_ALLOCATOR   pg_malloc0
 
#define SH_DECLARE
 
#define SH_DEFINE
 

Typedefs

typedef struct manifest_file manifest_file
 
typedef struct manifest_wal_range manifest_wal_range
 
typedef struct parser_context parser_context
 
typedef struct verifier_context verifier_context
 

Functions

static uint32 hash_string_pointer (char *s)
 
static void parse_manifest_file (char *manifest_path, manifest_files_hash **ht_p, manifest_wal_range **first_wal_range_p)
 
static void record_manifest_details_for_file (JsonManifestParseContext *context, char *pathname, size_t size, pg_checksum_type checksum_type, int checksum_length, uint8 *checksum_payload)
 
static void record_manifest_details_for_wal_range (JsonManifestParseContext *context, TimeLineID tli, XLogRecPtr start_lsn, XLogRecPtr end_lsn)
 
static void report_manifest_error (JsonManifestParseContext *context, const char *fmt,...) pg_attribute_printf(2
 
static void pg_attribute_noreturn ()
 
static void verify_backup_directory (verifier_context *context, char *relpath, char *fullpath)
 
static void verify_backup_file (verifier_context *context, char *relpath, char *fullpath)
 
static void report_extra_backup_files (verifier_context *context)
 
static void verify_backup_checksums (verifier_context *context)
 
static void verify_file_checksum (verifier_context *context, manifest_file *m, char *fullpath)
 
static void parse_required_wal (verifier_context *context, char *pg_waldump_path, char *wal_directory, manifest_wal_range *first_wal_range)
 
static void report_backup_error (verifier_context *context, const char *pg_restrict fmt,...) pg_attribute_printf(2
 
static void static void report_fatal_error (const char *pg_restrict fmt,...) pg_attribute_printf(1
 
static bool should_ignore_relpath (verifier_context *context, char *relpath)
 
static void progress_report (bool finished)
 
static void usage (void)
 
int main (int argc, char **argv)
 

Variables

static const char * progname
 
static bool show_progress = false
 
static bool skip_checksums = false
 
static uint64 total_size = 0
 
static uint64 done_size = 0
 

Macro Definition Documentation

◆ ESTIMATED_BYTES_PER_MANIFEST_LINE

#define ESTIMATED_BYTES_PER_MANIFEST_LINE   100

Definition at line 40 of file pg_verifybackup.c.

◆ READ_CHUNK_SIZE

#define READ_CHUNK_SIZE   4096

Definition at line 45 of file pg_verifybackup.c.

◆ SH_DECLARE

#define SH_DECLARE

Definition at line 79 of file pg_verifybackup.c.

◆ SH_DEFINE

#define SH_DEFINE

Definition at line 80 of file pg_verifybackup.c.

◆ SH_ELEMENT_TYPE

#define SH_ELEMENT_TYPE   manifest_file

Definition at line 72 of file pg_verifybackup.c.

◆ SH_EQUAL

#define SH_EQUAL (   tb,
  a,
  b 
)    (strcmp(a, b) == 0)

Definition at line 76 of file pg_verifybackup.c.

◆ SH_HASH_KEY

#define SH_HASH_KEY (   tb,
  key 
)    hash_string_pointer(key)

Definition at line 75 of file pg_verifybackup.c.

◆ SH_KEY

#define SH_KEY   pathname

Definition at line 74 of file pg_verifybackup.c.

◆ SH_KEY_TYPE

#define SH_KEY_TYPE   char *

Definition at line 73 of file pg_verifybackup.c.

◆ SH_PREFIX

#define SH_PREFIX   manifest_files

Definition at line 71 of file pg_verifybackup.c.

◆ SH_RAW_ALLOCATOR

#define SH_RAW_ALLOCATOR   pg_malloc0

Definition at line 78 of file pg_verifybackup.c.

◆ SH_SCOPE

#define SH_SCOPE   static inline

Definition at line 77 of file pg_verifybackup.c.

◆ should_verify_checksum

#define should_verify_checksum (   m)     (((m)->matched) && !((m)->bad) && (((m)->checksum_type) != CHECKSUM_TYPE_NONE))

Definition at line 63 of file pg_verifybackup.c.

Typedef Documentation

◆ manifest_file

typedef struct manifest_file manifest_file

◆ manifest_wal_range

◆ parser_context

◆ verifier_context

Function Documentation

◆ hash_string_pointer()

static uint32 hash_string_pointer ( char *  s)
static

Definition at line 924 of file pg_verifybackup.c.

925 {
926  unsigned char *ss = (unsigned char *) s;
927 
928  return hash_bytes(ss, strlen(s));
929 }
uint32 hash_bytes(const unsigned char *k, int keylen)
Definition: hashfn.c:146

References hash_bytes().

◆ main()

int main ( int  argc,
char **  argv 
)

Definition at line 172 of file pg_verifybackup.c.

173 {
174  static struct option long_options[] = {
175  {"exit-on-error", no_argument, NULL, 'e'},
176  {"ignore", required_argument, NULL, 'i'},
177  {"manifest-path", required_argument, NULL, 'm'},
178  {"no-parse-wal", no_argument, NULL, 'n'},
179  {"progress", no_argument, NULL, 'P'},
180  {"quiet", no_argument, NULL, 'q'},
181  {"skip-checksums", no_argument, NULL, 's'},
182  {"wal-directory", required_argument, NULL, 'w'},
183  {NULL, 0, NULL, 0}
184  };
185 
186  int c;
187  verifier_context context;
188  manifest_wal_range *first_wal_range;
189  char *manifest_path = NULL;
190  bool no_parse_wal = false;
191  bool quiet = false;
192  char *wal_directory = NULL;
193  char *pg_waldump_path = NULL;
194 
195  pg_logging_init(argv[0]);
196  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_verifybackup"));
197  progname = get_progname(argv[0]);
198 
199  memset(&context, 0, sizeof(context));
200 
201  if (argc > 1)
202  {
203  if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
204  {
205  usage();
206  exit(0);
207  }
208  if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
209  {
210  puts("pg_verifybackup (PostgreSQL) " PG_VERSION);
211  exit(0);
212  }
213  }
214 
215  /*
216  * Skip certain files in the toplevel directory.
217  *
218  * Ignore the backup_manifest file, because it's not included in the
219  * backup manifest.
220  *
221  * Ignore the pg_wal directory, because those files are not included in
222  * the backup manifest either, since they are fetched separately from the
223  * backup itself, and verified via a separate mechanism.
224  *
225  * Ignore postgresql.auto.conf, recovery.signal, and standby.signal,
226  * because we expect that those files may sometimes be created or changed
227  * as part of the backup process. For example, pg_basebackup -R will
228  * modify postgresql.auto.conf and create standby.signal.
229  */
230  simple_string_list_append(&context.ignore_list, "backup_manifest");
231  simple_string_list_append(&context.ignore_list, "pg_wal");
232  simple_string_list_append(&context.ignore_list, "postgresql.auto.conf");
233  simple_string_list_append(&context.ignore_list, "recovery.signal");
234  simple_string_list_append(&context.ignore_list, "standby.signal");
235 
236  while ((c = getopt_long(argc, argv, "ei:m:nPqsw:", long_options, NULL)) != -1)
237  {
238  switch (c)
239  {
240  case 'e':
241  context.exit_on_error = true;
242  break;
243  case 'i':
244  {
245  char *arg = pstrdup(optarg);
246 
249  break;
250  }
251  case 'm':
252  manifest_path = pstrdup(optarg);
253  canonicalize_path(manifest_path);
254  break;
255  case 'n':
256  no_parse_wal = true;
257  break;
258  case 'P':
259  show_progress = true;
260  break;
261  case 'q':
262  quiet = true;
263  break;
264  case 's':
265  skip_checksums = true;
266  break;
267  case 'w':
268  wal_directory = pstrdup(optarg);
269  canonicalize_path(wal_directory);
270  break;
271  default:
272  /* getopt_long already emitted a complaint */
273  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
274  exit(1);
275  }
276  }
277 
278  /* Get backup directory name */
279  if (optind >= argc)
280  {
281  pg_log_error("no backup directory specified");
282  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
283  exit(1);
284  }
285  context.backup_directory = pstrdup(argv[optind++]);
287 
288  /* Complain if any arguments remain */
289  if (optind < argc)
290  {
291  pg_log_error("too many command-line arguments (first is \"%s\")",
292  argv[optind]);
293  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
294  exit(1);
295  }
296 
297  /* Complain if the specified arguments conflict */
298  if (show_progress && quiet)
299  pg_fatal("cannot specify both %s and %s",
300  "-P/--progress", "-q/--quiet");
301 
302  /* Unless --no-parse-wal was specified, we will need pg_waldump. */
303  if (!no_parse_wal)
304  {
305  int ret;
306 
307  pg_waldump_path = pg_malloc(MAXPGPATH);
308  ret = find_other_exec(argv[0], "pg_waldump",
309  "pg_waldump (PostgreSQL) " PG_VERSION "\n",
310  pg_waldump_path);
311  if (ret < 0)
312  {
313  char full_path[MAXPGPATH];
314 
315  if (find_my_exec(argv[0], full_path) < 0)
316  strlcpy(full_path, progname, sizeof(full_path));
317 
318  if (ret == -1)
319  pg_fatal("program \"%s\" is needed by %s but was not found in the same directory as \"%s\"",
320  "pg_waldump", "pg_verifybackup", full_path);
321  else
322  pg_fatal("program \"%s\" was found by \"%s\" but was not the same version as %s",
323  "pg_waldump", full_path, "pg_verifybackup");
324  }
325  }
326 
327  /* By default, look for the manifest in the backup directory. */
328  if (manifest_path == NULL)
329  manifest_path = psprintf("%s/backup_manifest",
330  context.backup_directory);
331 
332  /* By default, look for the WAL in the backup directory, too. */
333  if (wal_directory == NULL)
334  wal_directory = psprintf("%s/pg_wal", context.backup_directory);
335 
336  /*
337  * Try to read the manifest. We treat any errors encountered while parsing
338  * the manifest as fatal; there doesn't seem to be much point in trying to
339  * verify the backup directory against a corrupted manifest.
340  */
341  parse_manifest_file(manifest_path, &context.ht, &first_wal_range);
342 
343  /*
344  * Now scan the files in the backup directory. At this stage, we verify
345  * that every file on disk is present in the manifest and that the sizes
346  * match. We also set the "matched" flag on every manifest entry that
347  * corresponds to a file on disk.
348  */
349  verify_backup_directory(&context, NULL, context.backup_directory);
350 
351  /*
352  * The "matched" flag should now be set on every entry in the hash table.
353  * Any entries for which the bit is not set are files mentioned in the
354  * manifest that don't exist on disk.
355  */
356  report_extra_backup_files(&context);
357 
358  /*
359  * Now do the expensive work of verifying file checksums, unless we were
360  * told to skip it.
361  */
362  if (!skip_checksums)
363  verify_backup_checksums(&context);
364 
365  /*
366  * Try to parse the required ranges of WAL records, unless we were told
367  * not to do so.
368  */
369  if (!no_parse_wal)
370  parse_required_wal(&context, pg_waldump_path,
371  wal_directory, first_wal_range);
372 
373  /*
374  * If everything looks OK, tell the user this, unless we were asked to
375  * work quietly.
376  */
377  if (!context.saw_any_error && !quiet)
378  printf(_("backup successfully verified\n"));
379 
380  return context.saw_any_error ? 1 : 0;
381 }
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1204
int find_my_exec(const char *argv0, char *retpath)
Definition: exec.c:152
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:460
int find_other_exec(const char *argv0, const char *target, const char *versionstr, char *retpath)
Definition: exec.c:351
#define _(x)
Definition: elog.c:91
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:57
#define no_argument
Definition: getopt_long.h:24
#define required_argument
Definition: getopt_long.h:25
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
char * pstrdup(const char *in)
Definition: mcxt.c:1624
void * arg
#define pg_fatal(...)
#define MAXPGPATH
PGDLLIMPORT int optind
Definition: getopt.c:50
PGDLLIMPORT char * optarg
Definition: getopt.c:52
static void verify_backup_checksums(verifier_context *context)
static void parse_manifest_file(char *manifest_path, manifest_files_hash **ht_p, manifest_wal_range **first_wal_range_p)
static void parse_required_wal(verifier_context *context, char *pg_waldump_path, char *wal_directory, manifest_wal_range *first_wal_range)
static void report_extra_backup_files(verifier_context *context)
static bool skip_checksums
static bool show_progress
static const char * progname
static void verify_backup_directory(verifier_context *context, char *relpath, char *fullpath)
static void usage(void)
void canonicalize_path(char *path)
Definition: path.c:264
const char * get_progname(const char *argv0)
Definition: path.c:574
#define printf(...)
Definition: port.h:244
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
char * c
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
void simple_string_list_append(SimpleStringList *list, const char *val)
Definition: simple_list.c:63
SimpleStringList ignore_list
manifest_files_hash * ht

References _, arg, canonicalize_path(), exit(), find_my_exec(), find_other_exec(), get_progname(), getopt_long(), MAXPGPATH, no_argument, optarg, optind, parse_manifest_file(), parse_required_wal(), pg_fatal, pg_log_error, pg_log_error_hint, pg_logging_init(), pg_malloc(), PG_TEXTDOMAIN, printf, progname, psprintf(), pstrdup(), report_extra_backup_files(), required_argument, set_pglocale_pgservice(), show_progress, simple_string_list_append(), skip_checksums, strlcpy(), usage(), verify_backup_checksums(), and verify_backup_directory().

◆ parse_manifest_file()

static void parse_manifest_file ( char *  manifest_path,
manifest_files_hash **  ht_p,
manifest_wal_range **  first_wal_range_p 
)
static

Definition at line 389 of file pg_verifybackup.c.

391 {
392  int fd;
393  struct stat statbuf;
394  off_t estimate;
395  uint32 initial_size;
396  manifest_files_hash *ht;
397  char *buffer;
398  int rc;
399  parser_context private_context;
400  JsonManifestParseContext context;
401 
402  /* Open the manifest file. */
403  if ((fd = open(manifest_path, O_RDONLY | PG_BINARY, 0)) < 0)
404  report_fatal_error("could not open file \"%s\": %m", manifest_path);
405 
406  /* Figure out how big the manifest is. */
407  if (fstat(fd, &statbuf) != 0)
408  report_fatal_error("could not stat file \"%s\": %m", manifest_path);
409 
410  /* Guess how large to make the hash table based on the manifest size. */
411  estimate = statbuf.st_size / ESTIMATED_BYTES_PER_MANIFEST_LINE;
412  initial_size = Min(PG_UINT32_MAX, Max(estimate, 256));
413 
414  /* Create the hash table. */
415  ht = manifest_files_create(initial_size, NULL);
416 
417  /*
418  * Slurp in the whole file.
419  *
420  * This is not ideal, but there's currently no easy way to get
421  * pg_parse_json() to perform incremental parsing.
422  */
423  buffer = pg_malloc(statbuf.st_size);
424  rc = read(fd, buffer, statbuf.st_size);
425  if (rc != statbuf.st_size)
426  {
427  if (rc < 0)
428  report_fatal_error("could not read file \"%s\": %m",
429  manifest_path);
430  else
431  report_fatal_error("could not read file \"%s\": read %d of %lld",
432  manifest_path, rc, (long long int) statbuf.st_size);
433  }
434 
435  /* Close the manifest file. */
436  close(fd);
437 
438  /* Parse the manifest. */
439  private_context.ht = ht;
440  private_context.first_wal_range = NULL;
441  private_context.last_wal_range = NULL;
442  context.private_data = &private_context;
446  json_parse_manifest(&context, buffer, statbuf.st_size);
447 
448  /* Done with the buffer. */
449  pfree(buffer);
450 
451  /* Return the file hash table and WAL range list we constructed. */
452  *ht_p = ht;
453  *first_wal_range_p = private_context.first_wal_range;
454 }
unsigned int uint32
Definition: c.h:490
#define Min(x, y)
Definition: c.h:988
#define PG_UINT32_MAX
Definition: c.h:574
#define Max(x, y)
Definition: c.h:982
#define PG_BINARY
Definition: c.h:1260
#define close(a)
Definition: win32.h:12
#define read(a, b, c)
Definition: win32.h:13
void pfree(void *pointer)
Definition: mcxt.c:1436
void json_parse_manifest(JsonManifestParseContext *context, char *buffer, size_t size)
static void record_manifest_details_for_file(JsonManifestParseContext *context, char *pathname, size_t size, pg_checksum_type checksum_type, int checksum_length, uint8 *checksum_payload)
#define ESTIMATED_BYTES_PER_MANIFEST_LINE
static void record_manifest_details_for_wal_range(JsonManifestParseContext *context, TimeLineID tli, XLogRecPtr start_lsn, XLogRecPtr end_lsn)
static void report_manifest_error(JsonManifestParseContext *context, const char *fmt,...) pg_attribute_printf(2
static void static void report_fatal_error(const char *pg_restrict fmt,...) pg_attribute_printf(1
static int fd(const char *x, int i)
Definition: preproc-init.c:105
json_manifest_perwalrange_callback perwalrange_cb
json_manifest_perfile_callback perfile_cb
json_manifest_error_callback error_cb
manifest_files_hash * ht
manifest_wal_range * last_wal_range
manifest_wal_range * first_wal_range
#define fstat
Definition: win32_port.h:285

References close, JsonManifestParseContext::error_cb, ESTIMATED_BYTES_PER_MANIFEST_LINE, fd(), parser_context::first_wal_range, fstat, parser_context::ht, json_parse_manifest(), parser_context::last_wal_range, Max, Min, JsonManifestParseContext::perfile_cb, JsonManifestParseContext::perwalrange_cb, pfree(), PG_BINARY, pg_malloc(), PG_UINT32_MAX, JsonManifestParseContext::private_data, read, record_manifest_details_for_file(), record_manifest_details_for_wal_range(), report_fatal_error(), report_manifest_error(), and stat::st_size.

Referenced by main().

◆ parse_required_wal()

static void parse_required_wal ( verifier_context context,
char *  pg_waldump_path,
char *  wal_directory,
manifest_wal_range first_wal_range 
)
static

Definition at line 835 of file pg_verifybackup.c.

837 {
838  manifest_wal_range *this_wal_range = first_wal_range;
839 
840  while (this_wal_range != NULL)
841  {
842  char *pg_waldump_cmd;
843 
844  pg_waldump_cmd = psprintf("\"%s\" --quiet --path=\"%s\" --timeline=%u --start=%X/%X --end=%X/%X\n",
845  pg_waldump_path, wal_directory, this_wal_range->tli,
846  LSN_FORMAT_ARGS(this_wal_range->start_lsn),
847  LSN_FORMAT_ARGS(this_wal_range->end_lsn));
848  fflush(NULL);
849  if (system(pg_waldump_cmd) != 0)
850  report_backup_error(context,
851  "WAL parsing failed for timeline %u",
852  this_wal_range->tli);
853 
854  this_wal_range = this_wal_range->next;
855  }
856 }
static void const char fflush(stdout)
static void report_backup_error(verifier_context *context, const char *pg_restrict fmt,...) pg_attribute_printf(2
struct manifest_wal_range * next
#define LSN_FORMAT_ARGS(lsn)
Definition: xlogdefs.h:43

References manifest_wal_range::end_lsn, fflush(), LSN_FORMAT_ARGS, manifest_wal_range::next, psprintf(), report_backup_error(), manifest_wal_range::start_lsn, and manifest_wal_range::tli.

Referenced by main().

◆ pg_attribute_noreturn()

static void pg_attribute_noreturn ( )

◆ progress_report()

static void progress_report ( bool  finished)
static

Definition at line 941 of file pg_verifybackup.c.

942 {
943  static pg_time_t last_progress_report = 0;
944  pg_time_t now;
945  int percent_size = 0;
946  char totalsize_str[32];
947  char donesize_str[32];
948 
949  if (!show_progress)
950  return;
951 
952  now = time(NULL);
953  if (now == last_progress_report && !finished)
954  return; /* Max once per second */
955 
957  percent_size = total_size ? (int) ((done_size * 100 / total_size)) : 0;
958 
959  snprintf(totalsize_str, sizeof(totalsize_str), UINT64_FORMAT,
960  total_size / 1024);
961  snprintf(donesize_str, sizeof(donesize_str), UINT64_FORMAT,
962  done_size / 1024);
963 
964  fprintf(stderr,
965  _("%*s/%s kB (%d%%) verified"),
966  (int) strlen(totalsize_str),
967  donesize_str, totalsize_str, percent_size);
968 
969  /*
970  * Stay on the same line if reporting to a terminal and we're not done
971  * yet.
972  */
973  fputc((!finished && isatty(fileno(stderr))) ? '\r' : '\n', stderr);
974 }
Datum now(PG_FUNCTION_ARGS)
Definition: timestamp.c:1549
#define UINT64_FORMAT
Definition: c.h:533
static pg_time_t last_progress_report
Definition: pg_amcheck.c:144
static uint64 done_size
static uint64 total_size
int64 pg_time_t
Definition: pgtime.h:23
#define snprintf
Definition: port.h:238
#define fprintf
Definition: port.h:242

References _, done_size, fprintf, last_progress_report, now(), show_progress, snprintf, total_size, and UINT64_FORMAT.

Referenced by verify_backup_checksums(), and verify_file_checksum().

◆ record_manifest_details_for_file()

static void record_manifest_details_for_file ( JsonManifestParseContext context,
char *  pathname,
size_t  size,
pg_checksum_type  checksum_type,
int  checksum_length,
uint8 checksum_payload 
)
static

Definition at line 478 of file pg_verifybackup.c.

482 {
483  parser_context *pcxt = context->private_data;
484  manifest_files_hash *ht = pcxt->ht;
485  manifest_file *m;
486  bool found;
487 
488  /* Make a new entry in the hash table for this file. */
489  m = manifest_files_insert(ht, pathname, &found);
490  if (found)
491  report_fatal_error("duplicate path name in backup manifest: \"%s\"",
492  pathname);
493 
494  /* Initialize the entry. */
495  m->size = size;
496  m->checksum_type = checksum_type;
497  m->checksum_length = checksum_length;
498  m->checksum_payload = checksum_payload;
499  m->matched = false;
500  m->bad = false;
501 }
uint8 * checksum_payload
pg_checksum_type checksum_type

References manifest_file::bad, manifest_file::checksum_length, manifest_file::checksum_payload, manifest_file::checksum_type, parser_context::ht, manifest_file::matched, JsonManifestParseContext::private_data, report_fatal_error(), and manifest_file::size.

Referenced by parse_manifest_file().

◆ record_manifest_details_for_wal_range()

static void record_manifest_details_for_wal_range ( JsonManifestParseContext context,
TimeLineID  tli,
XLogRecPtr  start_lsn,
XLogRecPtr  end_lsn 
)
static

Definition at line 507 of file pg_verifybackup.c.

510 {
511  parser_context *pcxt = context->private_data;
513 
514  /* Allocate and initialize a struct describing this WAL range. */
515  range = palloc(sizeof(manifest_wal_range));
516  range->tli = tli;
517  range->start_lsn = start_lsn;
518  range->end_lsn = end_lsn;
519  range->prev = pcxt->last_wal_range;
520  range->next = NULL;
521 
522  /* Add it to the end of the list. */
523  if (pcxt->first_wal_range == NULL)
524  pcxt->first_wal_range = range;
525  else
526  pcxt->last_wal_range->next = range;
527  pcxt->last_wal_range = range;
528 }
void * palloc(Size size)
Definition: mcxt.c:1210
static struct cvec * range(struct vars *v, chr a, chr b, int cases)
Definition: regc_locale.c:412

References parser_context::first_wal_range, parser_context::last_wal_range, manifest_wal_range::next, palloc(), JsonManifestParseContext::private_data, and range().

Referenced by parse_manifest_file().

◆ report_backup_error()

static void report_backup_error ( verifier_context context,
const char *pg_restrict  fmt,
  ... 
)
static

Definition at line 865 of file pg_verifybackup.c.

866 {
867  va_list ap;
868 
869  va_start(ap, fmt);
871  va_end(ap);
872 
873  context->saw_any_error = true;
874  if (context->exit_on_error)
875  exit(1);
876 }
#define gettext(x)
Definition: c.h:1169
static void const char * fmt
va_end(args)
va_start(args, fmt)
void pg_log_generic_v(enum pg_log_level level, enum pg_log_part part, const char *pg_restrict fmt, va_list ap)
Definition: logging.c:216
@ PG_LOG_PRIMARY
Definition: logging.h:67
@ PG_LOG_ERROR
Definition: logging.h:43

References exit(), verifier_context::exit_on_error, fmt, gettext, PG_LOG_ERROR, pg_log_generic_v(), PG_LOG_PRIMARY, verifier_context::saw_any_error, va_end(), and va_start().

Referenced by parse_required_wal(), report_extra_backup_files(), verify_backup_directory(), verify_backup_file(), and verify_file_checksum().

◆ report_extra_backup_files()

static void report_extra_backup_files ( verifier_context context)
static

Definition at line 680 of file pg_verifybackup.c.

681 {
682  manifest_files_iterator it;
683  manifest_file *m;
684 
685  manifest_files_start_iterate(context->ht, &it);
686  while ((m = manifest_files_iterate(context->ht, &it)) != NULL)
687  if (!m->matched && !should_ignore_relpath(context, m->pathname))
688  report_backup_error(context,
689  "\"%s\" is present in the manifest but not on disk",
690  m->pathname);
691 }
static bool should_ignore_relpath(verifier_context *context, char *relpath)

References verifier_context::ht, manifest_file::matched, manifest_file::pathname, report_backup_error(), and should_ignore_relpath().

Referenced by main().

◆ report_fatal_error()

static void report_fatal_error ( const char *pg_restrict  fmt,
  ... 
)
static

Definition at line 882 of file pg_verifybackup.c.

883 {
884  va_list ap;
885 
886  va_start(ap, fmt);
888  va_end(ap);
889 
890  exit(1);
891 }

References exit(), fmt, gettext, PG_LOG_ERROR, pg_log_generic_v(), PG_LOG_PRIMARY, va_end(), and va_start().

Referenced by parse_manifest_file(), record_manifest_details_for_file(), and verify_backup_directory().

◆ report_manifest_error()

static void report_manifest_error ( JsonManifestParseContext context,
const char *  fmt,
  ... 
)
static

Definition at line 463 of file pg_verifybackup.c.

464 {
465  va_list ap;
466 
467  va_start(ap, fmt);
469  va_end(ap);
470 
471  exit(1);
472 }

References exit(), fmt, gettext, PG_LOG_ERROR, pg_log_generic_v(), PG_LOG_PRIMARY, va_end(), and va_start().

Referenced by parse_manifest_file().

◆ should_ignore_relpath()

static bool should_ignore_relpath ( verifier_context context,
char *  relpath 
)
static

Definition at line 901 of file pg_verifybackup.c.

902 {
903  SimpleStringListCell *cell;
904 
905  for (cell = context->ignore_list.head; cell != NULL; cell = cell->next)
906  {
907  char *r = relpath;
908  char *v = cell->val;
909 
910  while (*v != '\0' && *r == *v)
911  ++r, ++v;
912 
913  if (*v == '\0' && (*r == '\0' || *r == '/'))
914  return true;
915  }
916 
917  return false;
918 }
#define relpath(rlocator, forknum)
Definition: relpath.h:94
char val[FLEXIBLE_ARRAY_MEMBER]
Definition: simple_list.h:37
struct SimpleStringListCell * next
Definition: simple_list.h:34
SimpleStringListCell * head
Definition: simple_list.h:42

References SimpleStringList::head, verifier_context::ignore_list, SimpleStringListCell::next, relpath, and SimpleStringListCell::val.

Referenced by report_extra_backup_files(), verify_backup_checksums(), and verify_backup_directory().

◆ usage()

static void usage ( void  )
static

Definition at line 980 of file pg_verifybackup.c.

981 {
982  printf(_("%s verifies a backup against the backup manifest.\n\n"), progname);
983  printf(_("Usage:\n %s [OPTION]... BACKUPDIR\n\n"), progname);
984  printf(_("Options:\n"));
985  printf(_(" -e, --exit-on-error exit immediately on error\n"));
986  printf(_(" -i, --ignore=RELATIVE_PATH ignore indicated path\n"));
987  printf(_(" -m, --manifest-path=PATH use specified path for manifest\n"));
988  printf(_(" -n, --no-parse-wal do not try to parse WAL files\n"));
989  printf(_(" -P, --progress show progress information\n"));
990  printf(_(" -q, --quiet do not print any output, except for errors\n"));
991  printf(_(" -s, --skip-checksums skip checksum verification\n"));
992  printf(_(" -w, --wal-directory=PATH use specified path for WAL files\n"));
993  printf(_(" -V, --version output version information, then exit\n"));
994  printf(_(" -?, --help show this help, then exit\n"));
995  printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
996  printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
997 }

References _, printf, and progname.

Referenced by main().

◆ verify_backup_checksums()

static void verify_backup_checksums ( verifier_context context)
static

Definition at line 699 of file pg_verifybackup.c.

700 {
701  manifest_files_iterator it;
702  manifest_file *m;
703 
704  progress_report(false);
705 
706  manifest_files_start_iterate(context->ht, &it);
707  while ((m = manifest_files_iterate(context->ht, &it)) != NULL)
708  {
709  if (should_verify_checksum(m) &&
710  !should_ignore_relpath(context, m->pathname))
711  {
712  char *fullpath;
713 
714  /* Compute the full pathname to the target file. */
715  fullpath = psprintf("%s/%s", context->backup_directory,
716  m->pathname);
717 
718  /* Do the actual checksum verification. */
719  verify_file_checksum(context, m, fullpath);
720 
721  /* Avoid leaking memory. */
722  pfree(fullpath);
723  }
724  }
725 
726  progress_report(true);
727 }
static void progress_report(bool finished)
#define should_verify_checksum(m)
static void verify_file_checksum(verifier_context *context, manifest_file *m, char *fullpath)

References verifier_context::backup_directory, verifier_context::ht, manifest_file::pathname, pfree(), progress_report(), psprintf(), should_ignore_relpath(), should_verify_checksum, and verify_file_checksum().

Referenced by main().

◆ verify_backup_directory()

static void verify_backup_directory ( verifier_context context,
char *  relpath,
char *  fullpath 
)
static

Definition at line 540 of file pg_verifybackup.c.

542 {
543  DIR *dir;
544  struct dirent *dirent;
545 
546  dir = opendir(fullpath);
547  if (dir == NULL)
548  {
549  /*
550  * If even the toplevel backup directory cannot be found, treat this
551  * as a fatal error.
552  */
553  if (relpath == NULL)
554  report_fatal_error("could not open directory \"%s\": %m", fullpath);
555 
556  /*
557  * Otherwise, treat this as a non-fatal error, but ignore any further
558  * errors related to this path and anything beneath it.
559  */
560  report_backup_error(context,
561  "could not open directory \"%s\": %m", fullpath);
563 
564  return;
565  }
566 
567  while (errno = 0, (dirent = readdir(dir)) != NULL)
568  {
569  char *filename = dirent->d_name;
570  char *newfullpath = psprintf("%s/%s", fullpath, filename);
571  char *newrelpath;
572 
573  /* Skip "." and ".." */
574  if (filename[0] == '.' && (filename[1] == '\0'
575  || strcmp(filename, "..") == 0))
576  continue;
577 
578  if (relpath == NULL)
579  newrelpath = pstrdup(filename);
580  else
581  newrelpath = psprintf("%s/%s", relpath, filename);
582 
583  if (!should_ignore_relpath(context, newrelpath))
584  verify_backup_file(context, newrelpath, newfullpath);
585 
586  pfree(newfullpath);
587  pfree(newrelpath);
588  }
589 
590  if (closedir(dir))
591  {
592  report_backup_error(context,
593  "could not close directory \"%s\": %m", fullpath);
594  return;
595  }
596 }
int closedir(DIR *)
Definition: dirent.c:127
struct dirent * readdir(DIR *)
Definition: dirent.c:78
DIR * opendir(const char *)
Definition: dirent.c:33
static char * filename
Definition: pg_dumpall.c:119
static void verify_backup_file(verifier_context *context, char *relpath, char *fullpath)
Definition: dirent.c:26
Definition: dirent.h:10
char d_name[MAX_PATH]
Definition: dirent.h:15

References closedir(), dirent::d_name, filename, verifier_context::ignore_list, opendir(), pfree(), psprintf(), pstrdup(), readdir(), relpath, report_backup_error(), report_fatal_error(), should_ignore_relpath(), simple_string_list_append(), and verify_backup_file().

Referenced by main(), and verify_backup_file().

◆ verify_backup_file()

static void verify_backup_file ( verifier_context context,
char *  relpath,
char *  fullpath 
)
static

Definition at line 605 of file pg_verifybackup.c.

606 {
607  struct stat sb;
608  manifest_file *m;
609 
610  if (stat(fullpath, &sb) != 0)
611  {
612  report_backup_error(context,
613  "could not stat file or directory \"%s\": %m",
614  relpath);
615 
616  /*
617  * Suppress further errors related to this path name and, if it's a
618  * directory, anything underneath it.
619  */
621 
622  return;
623  }
624 
625  /* If it's a directory, just recurse. */
626  if (S_ISDIR(sb.st_mode))
627  {
628  verify_backup_directory(context, relpath, fullpath);
629  return;
630  }
631 
632  /* If it's not a directory, it should be a plain file. */
633  if (!S_ISREG(sb.st_mode))
634  {
635  report_backup_error(context,
636  "\"%s\" is not a file or directory",
637  relpath);
638  return;
639  }
640 
641  /* Check whether there's an entry in the manifest hash. */
642  m = manifest_files_lookup(context->ht, relpath);
643  if (m == NULL)
644  {
645  report_backup_error(context,
646  "\"%s\" is present on disk but not in the manifest",
647  relpath);
648  return;
649  }
650 
651  /* Flag this entry as having been encountered in the filesystem. */
652  m->matched = true;
653 
654  /* Check that the size matches. */
655  if (m->size != sb.st_size)
656  {
657  report_backup_error(context,
658  "\"%s\" has size %lld on disk but size %zu in the manifest",
659  relpath, (long long int) sb.st_size, m->size);
660  m->bad = true;
661  }
662 
663  /* Update statistics for progress report, if necessary */
665  total_size += m->size;
666 
667  /*
668  * We don't verify checksums at this stage. We first finish verifying that
669  * we have the expected set of files with the expected sizes, and only
670  * afterwards verify the checksums. That's because computing checksums may
671  * take a while, and we'd like to report more obvious problems quickly.
672  */
673 }
#define stat
Definition: win32_port.h:286
#define S_ISDIR(m)
Definition: win32_port.h:327
#define S_ISREG(m)
Definition: win32_port.h:330

References verifier_context::ht, verifier_context::ignore_list, relpath, report_backup_error(), S_ISDIR, S_ISREG, should_verify_checksum, show_progress, simple_string_list_append(), skip_checksums, stat::st_mode, stat::st_size, stat, total_size, and verify_backup_directory().

Referenced by verify_backup_directory().

◆ verify_file_checksum()

static void verify_file_checksum ( verifier_context context,
manifest_file m,
char *  fullpath 
)
static

Definition at line 733 of file pg_verifybackup.c.

735 {
736  pg_checksum_context checksum_ctx;
737  char *relpath = m->pathname;
738  int fd;
739  int rc;
740  size_t bytes_read = 0;
741  uint8 buffer[READ_CHUNK_SIZE];
742  uint8 checksumbuf[PG_CHECKSUM_MAX_LENGTH];
743  int checksumlen;
744 
745  /* Open the target file. */
746  if ((fd = open(fullpath, O_RDONLY | PG_BINARY, 0)) < 0)
747  {
748  report_backup_error(context, "could not open file \"%s\": %m",
749  relpath);
750  return;
751  }
752 
753  /* Initialize checksum context. */
754  if (pg_checksum_init(&checksum_ctx, m->checksum_type) < 0)
755  {
756  report_backup_error(context, "could not initialize checksum of file \"%s\"",
757  relpath);
758  close(fd);
759  return;
760  }
761 
762  /* Read the file chunk by chunk, updating the checksum as we go. */
763  while ((rc = read(fd, buffer, READ_CHUNK_SIZE)) > 0)
764  {
765  bytes_read += rc;
766  if (pg_checksum_update(&checksum_ctx, buffer, rc) < 0)
767  {
768  report_backup_error(context, "could not update checksum of file \"%s\"",
769  relpath);
770  close(fd);
771  return;
772  }
773 
774  /* Report progress */
775  done_size += rc;
776  progress_report(false);
777  }
778  if (rc < 0)
779  report_backup_error(context, "could not read file \"%s\": %m",
780  relpath);
781 
782  /* Close the file. */
783  if (close(fd) != 0)
784  {
785  report_backup_error(context, "could not close file \"%s\": %m",
786  relpath);
787  return;
788  }
789 
790  /* If we didn't manage to read the whole file, bail out now. */
791  if (rc < 0)
792  return;
793 
794  /*
795  * Double-check that we read the expected number of bytes from the file.
796  * Normally, a file size mismatch would be caught in verify_backup_file
797  * and this check would never be reached, but this provides additional
798  * safety and clarity in the event of concurrent modifications or
799  * filesystem misbehavior.
800  */
801  if (bytes_read != m->size)
802  {
803  report_backup_error(context,
804  "file \"%s\" should contain %zu bytes, but read %zu bytes",
805  relpath, m->size, bytes_read);
806  return;
807  }
808 
809  /* Get the final checksum. */
810  checksumlen = pg_checksum_final(&checksum_ctx, checksumbuf);
811  if (checksumlen < 0)
812  {
813  report_backup_error(context,
814  "could not finalize checksum of file \"%s\"",
815  relpath);
816  return;
817  }
818 
819  /* And check it against the manifest. */
820  if (checksumlen != m->checksum_length)
821  report_backup_error(context,
822  "file \"%s\" has checksum of length %d, but expected %d",
823  relpath, m->checksum_length, checksumlen);
824  else if (memcmp(checksumbuf, m->checksum_payload, checksumlen) != 0)
825  report_backup_error(context,
826  "checksum mismatch for file \"%s\"",
827  relpath);
828 }
unsigned char uint8
Definition: c.h:488
int pg_checksum_final(pg_checksum_context *context, uint8 *output)
int pg_checksum_update(pg_checksum_context *context, const uint8 *input, size_t len)
int pg_checksum_init(pg_checksum_context *context, pg_checksum_type type)
#define PG_CHECKSUM_MAX_LENGTH
#define READ_CHUNK_SIZE

References manifest_file::checksum_length, manifest_file::checksum_payload, manifest_file::checksum_type, close, done_size, fd(), manifest_file::pathname, PG_BINARY, pg_checksum_final(), pg_checksum_init(), PG_CHECKSUM_MAX_LENGTH, pg_checksum_update(), progress_report(), read, READ_CHUNK_SIZE, relpath, report_backup_error(), and manifest_file::size.

Referenced by verify_backup_checksums().

Variable Documentation

◆ done_size

uint64 done_size = 0
static

Definition at line 166 of file pg_verifybackup.c.

Referenced by progress_report(), and verify_file_checksum().

◆ progname

const char* progname
static

Definition at line 158 of file pg_verifybackup.c.

Referenced by main(), and usage().

◆ show_progress

bool show_progress = false
static

Definition at line 161 of file pg_verifybackup.c.

Referenced by main(), progress_report(), and verify_backup_file().

◆ skip_checksums

bool skip_checksums = false
static

Definition at line 162 of file pg_verifybackup.c.

Referenced by main(), and verify_backup_file().

◆ total_size

uint64 total_size = 0
static

Definition at line 165 of file pg_verifybackup.c.

Referenced by progress_report(), and verify_backup_file().