PostgreSQL Source Code git master
Loading...
Searching...
No Matches
pg_verifybackup.c File Reference
#include "postgres_fe.h"
#include <dirent.h>
#include <fcntl.h>
#include <limits.h>
#include <sys/stat.h>
#include <time.h>
#include "access/xlog_internal.h"
#include "common/logging.h"
#include "common/parse_manifest.h"
#include "fe_utils/simple_list.h"
#include "getopt_long.h"
#include "pg_verifybackup.h"
#include "pgtime.h"
Include dependency graph for pg_verifybackup.c:

Go to the source code of this file.

Data Structures

struct  tar_file
 

Macros

#define ESTIMATED_BYTES_PER_MANIFEST_LINE   100
 
#define READ_CHUNK_SIZE   (128 * 1024)
 

Typedefs

typedef struct tar_file tar_file
 

Functions

static manifest_dataparse_manifest_file (char *manifest_path)
 
static void verifybackup_version_cb (JsonManifestParseContext *context, int manifest_version)
 
static void verifybackup_system_identifier (JsonManifestParseContext *context, uint64 manifest_system_identifier)
 
static void verifybackup_per_file_cb (JsonManifestParseContext *context, const char *pathname, uint64 size, pg_checksum_type checksum_type, int checksum_length, uint8 *checksum_payload)
 
static void verifybackup_per_wal_range_cb (JsonManifestParseContext *context, TimeLineID tli, XLogRecPtr start_lsn, XLogRecPtr end_lsn)
 
static pg_noreturn void report_manifest_error (JsonManifestParseContext *context, const char *fmt,...) pg_attribute_printf(2
 
static pg_noreturn void static void verify_tar_backup (verifier_context *context, DIR *dir, char **base_archive_path, char **wal_archive_path)
 
static void verify_plain_backup_directory (verifier_context *context, char *relpath, char *fullpath, DIR *dir)
 
static void verify_plain_backup_file (verifier_context *context, char *relpath, char *fullpath)
 
static void verify_control_file (const char *controlpath, uint64 manifest_system_identifier)
 
static void precheck_tar_backup_file (verifier_context *context, char *relpath, char *fullpath, SimplePtrList *tarfiles, char **base_archive_path, char **wal_archive_path)
 
static void verify_tar_file (verifier_context *context, char *relpath, char *fullpath, astreamer *streamer)
 
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, uint8 *buffer)
 
static void parse_required_wal (verifier_context *context, char *pg_waldump_path, char *wal_path)
 
static astreamercreate_archive_verifier (verifier_context *context, char *archive_name, Oid tblspc_oid, pg_compress_algorithm compress_algo)
 
static void progress_report (bool finished)
 
static void usage (void)
 
int main (int argc, char **argv)
 
void report_backup_error (verifier_context *context, const char *pg_restrict fmt,...)
 
void report_fatal_error (const char *pg_restrict fmt,...)
 
bool should_ignore_relpath (verifier_context *context, const char *relpath)
 

Variables

static const charprogname
 
static bool show_progress = 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 42 of file pg_verifybackup.c.

◆ READ_CHUNK_SIZE

#define READ_CHUNK_SIZE   (128 * 1024)

Definition at line 47 of file pg_verifybackup.c.

Typedef Documentation

◆ tar_file

Function Documentation

◆ create_archive_verifier()

static astreamer * create_archive_verifier ( verifier_context context,
char archive_name,
Oid  tblspc_oid,
pg_compress_algorithm  compress_algo 
)
static

Definition at line 1317 of file pg_verifybackup.c.

1319{
1320 astreamer *streamer = NULL;
1321
1322 /* Should be here only for tar backup */
1323 Assert(context->format == 't');
1324
1325 /* Last step is the actual verification. */
1326 streamer = astreamer_verify_content_new(streamer, context, archive_name,
1327 tblspc_oid);
1328
1329 /* Before that we must parse the tar file. */
1330 streamer = astreamer_tar_parser_new(streamer);
1331
1332 /* Before that we must decompress, if archive is compressed. */
1333 if (compress_algo == PG_COMPRESSION_GZIP)
1334 streamer = astreamer_gzip_decompressor_new(streamer);
1335 else if (compress_algo == PG_COMPRESSION_LZ4)
1336 streamer = astreamer_lz4_decompressor_new(streamer);
1337 else if (compress_algo == PG_COMPRESSION_ZSTD)
1338 streamer = astreamer_zstd_decompressor_new(streamer);
1339
1340 return streamer;
1341}
astreamer * astreamer_gzip_decompressor_new(astreamer *next)
astreamer * astreamer_lz4_decompressor_new(astreamer *next)
astreamer * astreamer_tar_parser_new(astreamer *next)
astreamer * astreamer_verify_content_new(astreamer *next, verifier_context *context, char *archive_name, Oid tblspc_oid)
astreamer * astreamer_zstd_decompressor_new(astreamer *next)
#define Assert(condition)
Definition c.h:1002
@ PG_COMPRESSION_GZIP
Definition compression.h:24
@ PG_COMPRESSION_LZ4
Definition compression.h:25
@ PG_COMPRESSION_ZSTD
Definition compression.h:26
static int fb(int x)

References Assert, astreamer_gzip_decompressor_new(), astreamer_lz4_decompressor_new(), astreamer_tar_parser_new(), astreamer_verify_content_new(), astreamer_zstd_decompressor_new(), fb(), verifier_context::format, PG_COMPRESSION_GZIP, PG_COMPRESSION_LZ4, and PG_COMPRESSION_ZSTD.

Referenced by verify_tar_backup().

◆ main()

int main ( int  argc,
char **  argv 
)

Definition at line 122 of file pg_verifybackup.c.

123{
124 static struct option long_options[] = {
125 {"exit-on-error", no_argument, NULL, 'e'},
126 {"ignore", required_argument, NULL, 'i'},
127 {"manifest-path", required_argument, NULL, 'm'},
128 {"format", required_argument, NULL, 'F'},
129 {"no-parse-wal", no_argument, NULL, 'n'},
130 {"progress", no_argument, NULL, 'P'},
131 {"quiet", no_argument, NULL, 'q'},
132 {"skip-checksums", no_argument, NULL, 's'},
133 {"wal-path", required_argument, NULL, 'w'},
134 {"wal-directory", required_argument, NULL, 'w'}, /* deprecated */
135 {NULL, 0, NULL, 0}
136 };
137
138 int c;
139 verifier_context context;
140 char *manifest_path = NULL;
141 bool no_parse_wal = false;
142 bool quiet = false;
143 char *wal_path = NULL;
144 char *base_archive_path = NULL;
145 char *wal_archive_path = NULL;
146 char *pg_waldump_path = NULL;
147 DIR *dir;
148
149 pg_logging_init(argv[0]);
150 set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_verifybackup"));
151 progname = get_progname(argv[0]);
152
153 memset(&context, 0, sizeof(context));
154
155 if (argc > 1)
156 {
157 if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
158 {
159 usage();
160 exit(0);
161 }
162 if (strcmp(argv[1], "--version") == 0 || strcmp(argv[1], "-V") == 0)
163 {
164 puts("pg_verifybackup (PostgreSQL) " PG_VERSION);
165 exit(0);
166 }
167 }
168
169 /*
170 * Skip certain files in the toplevel directory.
171 *
172 * Ignore the backup_manifest file, because it's not included in the
173 * backup manifest.
174 *
175 * Ignore the pg_wal directory, because those files are not included in
176 * the backup manifest either, since they are fetched separately from the
177 * backup itself, and verified via a separate mechanism.
178 *
179 * Ignore postgresql.auto.conf, recovery.signal, and standby.signal,
180 * because we expect that those files may sometimes be created or changed
181 * as part of the backup process. For example, pg_basebackup -R will
182 * modify postgresql.auto.conf and create standby.signal.
183 */
184 simple_string_list_append(&context.ignore_list, "backup_manifest");
185 simple_string_list_append(&context.ignore_list, "pg_wal");
186 simple_string_list_append(&context.ignore_list, "postgresql.auto.conf");
187 simple_string_list_append(&context.ignore_list, "recovery.signal");
188 simple_string_list_append(&context.ignore_list, "standby.signal");
189
190 while ((c = getopt_long(argc, argv, "eF:i:m:nPqsw:", long_options, NULL)) != -1)
191 {
192 switch (c)
193 {
194 case 'e':
195 context.exit_on_error = true;
196 break;
197 case 'i':
198 {
199 char *arg = pstrdup(optarg);
200
203 break;
204 }
205 case 'm':
208 break;
209 case 'F':
210 if (strcmp(optarg, "p") == 0 || strcmp(optarg, "plain") == 0)
211 context.format = 'p';
212 else if (strcmp(optarg, "t") == 0 || strcmp(optarg, "tar") == 0)
213 context.format = 't';
214 else
215 pg_fatal("invalid backup format \"%s\", must be \"plain\" or \"tar\"",
216 optarg);
217 break;
218 case 'n':
219 no_parse_wal = true;
220 break;
221 case 'P':
222 show_progress = true;
223 break;
224 case 'q':
225 quiet = true;
226 break;
227 case 's':
228 context.skip_checksums = true;
229 break;
230 case 'w':
233 break;
234 default:
235 /* getopt_long already emitted a complaint */
236 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
237 exit(1);
238 }
239 }
240
241 /* Get backup directory name */
242 if (optind >= argc)
243 {
244 pg_log_error("no backup directory specified");
245 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
246 exit(1);
247 }
248 context.backup_directory = pstrdup(argv[optind++]);
250
251 /* Complain if any arguments remain */
252 if (optind < argc)
253 {
254 pg_log_error("too many command-line arguments (first is \"%s\")",
255 argv[optind]);
256 pg_log_error_hint("Try \"%s --help\" for more information.", progname);
257 exit(1);
258 }
259
260 /* Complain if the specified arguments conflict */
261 if (show_progress && quiet)
262 pg_fatal("cannot specify both %s and %s",
263 "-P/--progress", "-q/--quiet");
264
265 /* Unless --no-parse-wal was specified, we will need pg_waldump. */
266 if (!no_parse_wal)
267 {
268 int ret;
269
271 ret = find_other_exec(argv[0], "pg_waldump",
272 "pg_waldump (PostgreSQL) " PG_VERSION "\n",
274 if (ret < 0)
275 {
276 char full_path[MAXPGPATH];
277
278 if (find_my_exec(argv[0], full_path) < 0)
280
281 if (ret == -1)
282 pg_fatal("program \"%s\" is needed by %s but was not found in the same directory as \"%s\"",
283 "pg_waldump", "pg_verifybackup", full_path);
284 else
285 pg_fatal("program \"%s\" was found by \"%s\" but was not the same version as %s",
286 "pg_waldump", full_path, "pg_verifybackup");
287 }
288 }
289
290 /* By default, look for the manifest in the backup directory. */
291 if (manifest_path == NULL)
292 manifest_path = psprintf("%s/backup_manifest",
293 context.backup_directory);
294
295 /*
296 * Try to read the manifest. We treat any errors encountered while parsing
297 * the manifest as fatal; there doesn't seem to be much point in trying to
298 * verify the backup directory against a corrupted manifest.
299 */
301
302 /*
303 * If the backup directory cannot be found, treat this as a fatal error.
304 */
305 dir = opendir(context.backup_directory);
306 if (dir == NULL)
307 report_fatal_error("could not open directory \"%s\": %m",
308 context.backup_directory);
309
310 /*
311 * At this point, we know that the backup directory exists, so it's now
312 * reasonable to check for files immediately inside it. Thus, before going
313 * further, if the user did not specify the backup format, check for
314 * PG_VERSION to distinguish between tar and plain format.
315 */
316 if (context.format == '\0')
317 {
318 struct stat sb;
319 char *path;
320
321 path = psprintf("%s/%s", context.backup_directory, "PG_VERSION");
322 if (stat(path, &sb) == 0)
323 context.format = 'p';
324 else if (errno != ENOENT)
325 {
326 pg_log_error("could not stat file \"%s\": %m", path);
327 exit(1);
328 }
329 else
330 {
331 /* No PG_VERSION, so assume tar format. */
332 context.format = 't';
333 }
334 pfree(path);
335 }
336
337 /*
338 * Perform the appropriate type of verification appropriate based on the
339 * backup format. This will close 'dir'.
340 */
341 if (context.format == 'p')
343 dir);
344 else
346
347 /*
348 * The "matched" flag should now be set on every entry in the hash table.
349 * Any entries for which the bit is not set are files mentioned in the
350 * manifest that don't exist on disk (or in the relevant tar files).
351 */
353
354 /*
355 * If this is a tar-format backup, checksums were already verified above;
356 * but if it's a plain-format backup, we postpone it until this point,
357 * since the earlier checks can be performed just by knowing which files
358 * are present, without needing to read all of them.
359 */
360 if (context.format == 'p' && !context.skip_checksums)
361 verify_backup_checksums(&context);
362
363 /*
364 * By default, WAL files are expected to be found in the backup directory
365 * for plain-format backups. In the case of tar-format backups, if a
366 * separate WAL archive is not found, the WAL files are most likely
367 * included within the main data directory archive.
368 */
369 if (wal_path == NULL)
370 {
371 if (context.format == 'p')
372 wal_path = psprintf("%s/pg_wal", context.backup_directory);
373 else if (wal_archive_path)
375 else if (base_archive_path)
377 else
378 {
379 pg_log_error("WAL archive not found");
380 pg_log_error_hint("Specify the correct path using the option -w/--wal-path. "
381 "Or you must use -n/--no-parse-wal when verifying a tar-format backup.");
382 exit(1);
383 }
384 }
385
386 /*
387 * Try to parse the required ranges of WAL records, unless we were told
388 * not to do so.
389 */
390 if (!no_parse_wal)
392
393 /*
394 * If everything looks OK, tell the user this, unless we were asked to
395 * work quietly.
396 */
397 if (!context.saw_any_error && !quiet)
398 printf(_("backup successfully verified\n"));
399
400 return context.saw_any_error ? 1 : 0;
401}
#define PG_TEXTDOMAIN(domain)
Definition c.h:1343
int find_my_exec(const char *argv0, char *retpath)
Definition exec.c:161
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition exec.c:430
int find_other_exec(const char *argv0, const char *target, const char *versionstr, char *retpath)
Definition exec.c:311
DIR * opendir(const char *)
Definition dirent.c:33
Datum arg
Definition elog.c:1323
#define _(x)
Definition elog.c:96
void * pg_malloc(size_t size)
Definition fe_memutils.c:53
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition getopt_long.c:60
#define no_argument
Definition getopt_long.h:25
#define required_argument
Definition getopt_long.h:26
void pg_logging_init(const char *argv0)
Definition logging.c:85
#define pg_log_error(...)
Definition logging.h:108
#define pg_log_error_hint(...)
Definition logging.h:114
char * pstrdup(const char *in)
Definition mcxt.c:1910
void pfree(void *pointer)
Definition mcxt.c:1619
#define pg_fatal(...)
#define MAXPGPATH
PGDLLIMPORT int optind
Definition getopt.c:47
PGDLLIMPORT char * optarg
Definition getopt.c:49
static void verify_backup_checksums(verifier_context *context)
static manifest_data * parse_manifest_file(char *manifest_path)
void report_fatal_error(const char *pg_restrict fmt,...)
static void verify_plain_backup_directory(verifier_context *context, char *relpath, char *fullpath, DIR *dir)
static void report_extra_backup_files(verifier_context *context)
static void parse_required_wal(verifier_context *context, char *pg_waldump_path, char *wal_path)
static bool show_progress
static pg_noreturn void static void verify_tar_backup(verifier_context *context, DIR *dir, char **base_archive_path, char **wal_archive_path)
static const char * progname
static void usage(void)
void canonicalize_path(char *path)
Definition path.c:337
const char * get_progname(const char *argv0)
Definition path.c:669
#define printf(...)
Definition port.h:267
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:43
void simple_string_list_append(SimpleStringList *list, const char *val)
Definition simple_list.c:63
Definition dirent.c:26
SimpleStringList ignore_list
manifest_data * manifest
#define stat
Definition win32_port.h:74

References _, arg, canonicalize_path(), fb(), find_my_exec(), find_other_exec(), get_progname(), getopt_long(), MAXPGPATH, no_argument, opendir(), optarg, optind, parse_manifest_file(), parse_required_wal(), pfree(), pg_fatal, pg_log_error, pg_log_error_hint, pg_logging_init(), pg_malloc(), PG_TEXTDOMAIN, printf, progname, psprintf(), pstrdup(), report_extra_backup_files(), report_fatal_error(), required_argument, set_pglocale_pgservice(), show_progress, simple_string_list_append(), stat, strlcpy(), usage(), verify_backup_checksums(), verify_plain_backup_directory(), and verify_tar_backup().

◆ parse_manifest_file()

static manifest_data * parse_manifest_file ( char manifest_path)
static

Definition at line 407 of file pg_verifybackup.c.

408{
409 int fd;
410 struct stat statbuf;
411 off_t estimate;
414 char *buffer;
417 size_t total_size;
418 const size_t chunk_size = READ_CHUNK_SIZE;
419
420 /* Open the manifest file. */
421 if ((fd = open(manifest_path, O_RDONLY | PG_BINARY, 0)) < 0)
422 report_fatal_error("could not open file \"%s\": %m", manifest_path);
423
424 /* Figure out how big the manifest is. */
425 if (fstat(fd, &statbuf) != 0)
426 report_fatal_error("could not stat file \"%s\": %m", manifest_path);
427
428 /* Guess how large to make the hash table based on the manifest size. */
429 estimate = statbuf.st_size / ESTIMATED_BYTES_PER_MANIFEST_LINE;
430 initial_size = Min(PG_UINT32_MAX, Max(estimate, 256));
431
432 /* Create the hash table. */
434
436 result->files = ht;
437 context.private_data = result;
443
444 total_size = statbuf.st_size;
445
446 /*
447 * Parse the file, in chunks if necessary.
448 */
449 if (total_size <= chunk_size)
450 {
451 ssize_t rc;
452
453 buffer = pg_malloc(total_size);
454 rc = read(fd, buffer, total_size);
455 if (rc != total_size)
456 {
457 if (rc < 0)
458 pg_fatal("could not read file \"%s\": %m", manifest_path);
459 else
460 pg_fatal("could not read file \"%s\": read %zd of %zu",
462 }
463
464 /* Close the manifest file. */
465 close(fd);
466
467 /* Parse the manifest. */
468 json_parse_manifest(&context, buffer, total_size);
469 }
470 else
471 {
472 size_t bytes_left = total_size;
474
475 inc_state = json_parse_manifest_incremental_init(&context);
476
477 buffer = pg_malloc(chunk_size + 1);
478
479 while (bytes_left > 0)
480 {
481 ssize_t rc;
482 size_t bytes_to_read = chunk_size;
483
484 /*
485 * Make sure that the last chunk is sufficiently large. (i.e. at
486 * least half the chunk size) so that it will contain fully the
487 * piece at the end with the checksum.
488 */
489 if (bytes_left < chunk_size)
491 else if (bytes_left < 2 * chunk_size)
493 rc = read(fd, buffer, bytes_to_read);
494 if (rc != bytes_to_read)
495 {
496 if (rc < 0)
497 pg_fatal("could not read file \"%s\": %m", manifest_path);
498 else
499 pg_fatal("could not read file \"%s\": read %zu of %zu",
501 total_size + rc - bytes_left,
502 total_size);
503 }
504 bytes_left -= rc;
505 json_parse_manifest_incremental_chunk(inc_state, buffer, rc,
506 bytes_left == 0);
507 }
508
509 /* Release the incremental state memory */
511
512 close(fd);
513 }
514
515 /* Done with the buffer. */
516 pg_free(buffer);
517
518 return result;
519}
#define Min(x, y)
Definition c.h:1131
#define PG_UINT32_MAX
Definition c.h:733
#define Max(x, y)
Definition c.h:1125
#define PG_BINARY
Definition c.h:1431
uint32_t uint32
Definition c.h:683
uint32 result
void pg_free(void *ptr)
#define pg_malloc0_object(type)
Definition fe_memutils.h:61
#define close(a)
Definition win32.h:12
#define read(a, b, c)
Definition win32.h:13
void json_parse_manifest(JsonManifestParseContext *context, const char *buffer, size_t size)
JsonManifestParseIncrementalState * json_parse_manifest_incremental_init(JsonManifestParseContext *context)
void json_parse_manifest_incremental_shutdown(JsonManifestParseIncrementalState *incstate)
void json_parse_manifest_incremental_chunk(JsonManifestParseIncrementalState *incstate, const char *chunk, size_t size, bool is_last)
static void verifybackup_version_cb(JsonManifestParseContext *context, int manifest_version)
static void verifybackup_system_identifier(JsonManifestParseContext *context, uint64 manifest_system_identifier)
static void verifybackup_per_wal_range_cb(JsonManifestParseContext *context, TimeLineID tli, XLogRecPtr start_lsn, XLogRecPtr end_lsn)
static uint64 total_size
#define ESTIMATED_BYTES_PER_MANIFEST_LINE
#define READ_CHUNK_SIZE
static pg_noreturn void report_manifest_error(JsonManifestParseContext *context, const char *fmt,...) pg_attribute_printf(2
static void verifybackup_per_file_cb(JsonManifestParseContext *context, const char *pathname, uint64 size, pg_checksum_type checksum_type, int checksum_length, uint8 *checksum_payload)
static int fd(const char *x, int i)
json_manifest_per_wal_range_callback per_wal_range_cb
json_manifest_system_identifier_callback system_identifier_cb
json_manifest_error_callback error_cb
json_manifest_per_file_callback per_file_cb
json_manifest_version_callback version_cb
#define fstat
Definition win32_port.h:73

References close, JsonManifestParseContext::error_cb, ESTIMATED_BYTES_PER_MANIFEST_LINE, fb(), fd(), fstat, json_parse_manifest(), json_parse_manifest_incremental_chunk(), json_parse_manifest_incremental_init(), json_parse_manifest_incremental_shutdown(), Max, Min, JsonManifestParseContext::per_file_cb, JsonManifestParseContext::per_wal_range_cb, PG_BINARY, pg_fatal, pg_free(), pg_malloc(), pg_malloc0_object, PG_UINT32_MAX, JsonManifestParseContext::private_data, read, READ_CHUNK_SIZE, report_fatal_error(), report_manifest_error(), result, JsonManifestParseContext::system_identifier_cb, total_size, verifybackup_per_file_cb(), verifybackup_per_wal_range_cb(), verifybackup_system_identifier(), verifybackup_version_cb(), and JsonManifestParseContext::version_cb.

Referenced by main().

◆ parse_required_wal()

static void parse_required_wal ( verifier_context context,
char pg_waldump_path,
char wal_path 
)
static

Definition at line 1226 of file pg_verifybackup.c.

1228{
1229 manifest_data *manifest = context->manifest;
1230 manifest_wal_range *this_wal_range = manifest->first_wal_range;
1231
1232 while (this_wal_range != NULL)
1233 {
1234 char *pg_waldump_cmd;
1235
1236 pg_waldump_cmd = psprintf("\"%s\" --quiet --path=\"%s\" --timeline=%u --start=%X/%08X --end=%X/%08X\n",
1238 LSN_FORMAT_ARGS(this_wal_range->start_lsn),
1240 fflush(NULL);
1241 if (system(pg_waldump_cmd) != 0)
1242 report_backup_error(context,
1243 "WAL parsing failed for timeline %u",
1244 this_wal_range->tli);
1245
1247 }
1248}
static bool manifest
void report_backup_error(verifier_context *context, const char *pg_restrict fmt,...)
#define LSN_FORMAT_ARGS(lsn)
Definition xlogdefs.h:47

References fb(), LSN_FORMAT_ARGS, manifest, verifier_context::manifest, psprintf(), and report_backup_error().

Referenced by main().

◆ precheck_tar_backup_file()

static void precheck_tar_backup_file ( verifier_context context,
char relpath,
char fullpath,
SimplePtrList tarfiles,
char **  base_archive_path,
char **  wal_archive_path 
)
static

Definition at line 903 of file pg_verifybackup.c.

906{
907 struct stat sb;
908 Oid tblspc_oid = InvalidOid;
909 pg_compress_algorithm compress_algorithm;
910 tar_file *tar;
911 char *suffix = NULL;
912 bool is_base_archive = false;
913 bool is_wal_archive = false;
914
915 /* Should be tar format backup */
916 Assert(context->format == 't');
917
918 /* Get file information */
919 if (stat(fullpath, &sb) != 0)
920 {
921 report_backup_error(context,
922 "could not stat file or directory \"%s\": %m",
923 relpath);
924 return;
925 }
926
927 /* In a tar format backup, we expect only regular files. */
928 if (!S_ISREG(sb.st_mode))
929 {
930 report_backup_error(context,
931 "file \"%s\" is not a regular file",
932 relpath);
933 return;
934 }
935
936 /*
937 * We expect tar files for backing up the main directory, tablespace, and
938 * pg_wal directory.
939 *
940 * pg_basebackup writes the main data directory to an archive file named
941 * base.tar, the pg_wal directory to pg_wal.tar, and the tablespace
942 * directory to <tablespaceoid>.tar, each followed by a compression type
943 * extension such as .gz, .lz4, or .zst.
944 */
945 if (strncmp("base", relpath, 4) == 0)
946 {
947 suffix = relpath + 4;
948 is_base_archive = true;
949 }
950 else if (strncmp("pg_wal", relpath, 6) == 0)
951 {
952 suffix = relpath + 6;
953 is_wal_archive = true;
954 }
955 else
956 {
957 /* Expected a <tablespaceoid>.tar file here. */
958 uint64 num = strtoul(relpath, &suffix, 10);
959
960 /*
961 * Report an error if we didn't consume at least one character, if the
962 * result is 0, or if the value is too large to be a valid OID.
963 */
964 if (suffix == NULL || num <= 0 || num > OID_MAX)
965 {
966 report_backup_error(context,
967 "file \"%s\" is not expected in a tar format backup",
968 relpath);
969 return;
970 }
971 tblspc_oid = (Oid) num;
972 }
973
974 /* Now, check the compression type of the tar */
975 if (!parse_tar_compress_algorithm(suffix, &compress_algorithm))
976 {
977 report_backup_error(context,
978 "file \"%s\" is not expected in a tar format backup",
979 relpath);
980 return;
981 }
982
983 /*
984 * Ignore WALs, as reading and verification will be handled through
985 * pg_waldump.
986 */
987 if (is_wal_archive)
988 {
989 *wal_archive_path = pstrdup(fullpath);
990 return;
991 }
992 else if (is_base_archive)
993 *base_archive_path = pstrdup(fullpath);
994
995 /*
996 * Append the information to the list for complete verification at a later
997 * stage.
998 */
1000 tar->relpath = pstrdup(relpath);
1001 tar->tblspc_oid = tblspc_oid;
1002 tar->compress_algorithm = compress_algorithm;
1003
1005
1006 /* Update statistics for progress report, if necessary */
1007 if (show_progress)
1008 total_size += sb.st_size;
1009}
uint64_t uint64
Definition c.h:684
bool parse_tar_compress_algorithm(const char *fname, pg_compress_algorithm *algorithm)
Definition compression.c:49
pg_compress_algorithm
Definition compression.h:22
#define pg_malloc_object(type)
Definition fe_memutils.h:60
#define InvalidOid
unsigned int Oid
#define OID_MAX
#define relpath(rlocator, forknum)
Definition relpath.h:150
void simple_ptr_list_append(SimplePtrList *list, void *ptr)
#define S_ISREG(m)
Definition win32_port.h:335

References Assert, fb(), verifier_context::format, InvalidOid, OID_MAX, parse_tar_compress_algorithm(), pg_malloc_object, pstrdup(), relpath, report_backup_error(), S_ISREG, show_progress, simple_ptr_list_append(), stat, and total_size.

Referenced by verify_tar_backup().

◆ progress_report()

static void progress_report ( bool  finished)
static

Definition at line 1353 of file pg_verifybackup.c.

1354{
1356 pg_time_t now;
1357 int percent_size = 0;
1358 char totalsize_str[32];
1359 char donesize_str[32];
1360
1361 if (!show_progress)
1362 return;
1363
1364 now = time(NULL);
1365 if (now == last_progress_report && !finished)
1366 return; /* Max once per second */
1367
1369 percent_size = total_size ? (int) ((done_size * 100 / total_size)) : 0;
1370
1372 total_size / 1024);
1374 done_size / 1024);
1375
1377 _("%*s/%s kB (%d%%) verified"),
1378 (int) strlen(totalsize_str),
1380
1381 /*
1382 * Stay on the same line if reporting to a terminal and we're not done
1383 * yet.
1384 */
1385 fputc((!finished && isatty(fileno(stderr))) ? '\r' : '\n', stderr);
1386}
Datum now(PG_FUNCTION_ARGS)
Definition timestamp.c:1613
#define UINT64_FORMAT
Definition c.h:694
#define fprintf(file, fmt, msg)
Definition cubescan.l:21
static pg_time_t last_progress_report
Definition pg_amcheck.c:147
static uint64 done_size
int64 pg_time_t
Definition pgtime.h:23
#define snprintf
Definition port.h:261

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

Referenced by verify_backup_checksums(), verify_file_checksum(), verify_tar_backup(), and verify_tar_file().

◆ report_backup_error()

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

Definition at line 1257 of file pg_verifybackup.c.

1258{
1259 va_list ap;
1260
1261 va_start(ap, fmt);
1263 va_end(ap);
1264
1265 context->saw_any_error = true;
1266 if (context->exit_on_error)
1267 exit(1);
1268}
#define gettext(x)
Definition c.h:1308
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:233
@ PG_LOG_PRIMARY
Definition logging.h:67
@ PG_LOG_ERROR
Definition logging.h:43

References verifier_context::exit_on_error, fb(), gettext, PG_LOG_ERROR, pg_log_generic_v(), PG_LOG_PRIMARY, and verifier_context::saw_any_error.

Referenced by member_compute_checksum(), member_verify_checksum(), member_verify_header(), parse_required_wal(), precheck_tar_backup_file(), report_extra_backup_files(), verify_file_checksum(), verify_plain_backup_directory(), verify_plain_backup_file(), verify_tar_backup(), and verify_tar_file().

◆ report_extra_backup_files()

static void report_extra_backup_files ( verifier_context context)
static

Definition at line 1065 of file pg_verifybackup.c.

1066{
1067 manifest_data *manifest = context->manifest;
1069 manifest_file *m;
1070
1072 while ((m = manifest_files_iterate(manifest->files, &it)) != NULL)
1073 if (!m->matched && !should_ignore_relpath(context, m->pathname))
1074 report_backup_error(context,
1075 "\"%s\" is present in the manifest but not on disk",
1076 m->pathname);
1077}
bool should_ignore_relpath(verifier_context *context, const char *relpath)
const char * pathname

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

Referenced by main().

◆ report_fatal_error()

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

◆ report_manifest_error()

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

Definition at line 528 of file pg_verifybackup.c.

529{
530 va_list ap;
531
532 va_start(ap, fmt);
534 va_end(ap);
535
536 exit(1);
537}

References fb(), gettext, PG_LOG_ERROR, pg_log_generic_v(), and PG_LOG_PRIMARY.

Referenced by parse_manifest_file().

◆ should_ignore_relpath()

bool should_ignore_relpath ( verifier_context context,
const char relpath 
)

Definition at line 1293 of file pg_verifybackup.c.

1294{
1296
1297 for (cell = context->ignore_list.head; cell != NULL; cell = cell->next)
1298 {
1299 const char *r = relpath;
1300 char *v = cell->val;
1301
1302 while (*v != '\0' && *r == *v)
1303 ++r, ++v;
1304
1305 if (*v == '\0' && (*r == '\0' || *r == '/'))
1306 return true;
1307 }
1308
1309 return false;
1310}
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 fb(), SimpleStringList::head, verifier_context::ignore_list, SimpleStringListCell::next, relpath, and SimpleStringListCell::val.

Referenced by member_verify_header(), report_extra_backup_files(), verify_backup_checksums(), verify_plain_backup_directory(), and verify_tar_backup().

◆ usage()

static void usage ( void  )
static

Definition at line 1392 of file pg_verifybackup.c.

1393{
1394 printf(_("%s verifies a backup against the backup manifest.\n\n"), progname);
1395 printf(_("Usage:\n %s [OPTION]... BACKUPDIR\n\n"), progname);
1396 printf(_("Options:\n"));
1397 printf(_(" -e, --exit-on-error exit immediately on error\n"));
1398 printf(_(" -F, --format=p|t backup format (plain, tar)\n"));
1399 printf(_(" -i, --ignore=RELATIVE_PATH ignore indicated path\n"));
1400 printf(_(" -m, --manifest-path=PATH use specified path for manifest\n"));
1401 printf(_(" -n, --no-parse-wal do not try to parse WAL files\n"));
1402 printf(_(" -P, --progress show progress information\n"));
1403 printf(_(" -q, --quiet do not print any output, except for errors\n"));
1404 printf(_(" -s, --skip-checksums skip checksum verification\n"));
1405 printf(_(" -w, --wal-path=PATH use specified path for WAL files\n"));
1406 printf(_(" --wal-directory=PATH (same as --wal-path, deprecated)\n"));
1407 printf(_(" -V, --version output version information, then exit\n"));
1408 printf(_(" -?, --help show this help, then exit\n"));
1409 printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
1410 printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
1411}

References _, fb(), printf, and progname.

Referenced by main().

◆ verify_backup_checksums()

static void verify_backup_checksums ( verifier_context context)
static

Definition at line 1085 of file pg_verifybackup.c.

1086{
1087 manifest_data *manifest = context->manifest;
1089 manifest_file *m;
1090 uint8 *buffer;
1091
1092 progress_report(false);
1093
1095
1097 while ((m = manifest_files_iterate(manifest->files, &it)) != NULL)
1098 {
1099 if (should_verify_checksum(m) &&
1100 !should_ignore_relpath(context, m->pathname))
1101 {
1102 char *fullpath;
1103
1104 /* Compute the full pathname to the target file. */
1105 fullpath = psprintf("%s/%s", context->backup_directory,
1106 m->pathname);
1107
1108 /* Do the actual checksum verification. */
1109 verify_file_checksum(context, m, fullpath, buffer);
1110
1111 /* Avoid leaking memory. */
1112 pfree(fullpath);
1113 }
1114 }
1115
1116 pg_free(buffer);
1117
1118 progress_report(true);
1119}
uint8_t uint8
Definition c.h:681
#define pg_malloc_array(type, count)
Definition fe_memutils.h:66
static void progress_report(bool finished)
static void verify_file_checksum(verifier_context *context, manifest_file *m, char *fullpath, uint8 *buffer)
#define should_verify_checksum(m)

References verifier_context::backup_directory, fb(), manifest, verifier_context::manifest, manifest_file::pathname, pfree(), pg_free(), pg_malloc_array, progress_report(), psprintf(), READ_CHUNK_SIZE, should_ignore_relpath(), should_verify_checksum, and verify_file_checksum().

Referenced by main().

◆ verify_control_file()

static void verify_control_file ( const char controlpath,
uint64  manifest_system_identifier 
)
static

Definition at line 774 of file pg_verifybackup.c.

775{
776 ControlFileData *control_file;
777 bool crc_ok;
778
779 pg_log_debug("reading \"%s\"", controlpath);
781
782 /* Control file contents not meaningful if CRC is bad. */
783 if (!crc_ok)
784 report_fatal_error("%s: CRC is incorrect", controlpath);
785
786 /* Can't interpret control file if not current version. */
787 if (control_file->pg_control_version != PG_CONTROL_VERSION)
788 report_fatal_error("%s: unexpected control file version",
790
791 /* System identifiers should match. */
792 if (manifest_system_identifier != control_file->system_identifier)
793 report_fatal_error("%s: manifest system identifier is %" PRIu64 ", but control file has %" PRIu64,
795 manifest_system_identifier,
796 control_file->system_identifier);
797
798 /* Release memory. */
799 pfree(control_file);
800}
ControlFileData * get_controlfile_by_exact_path(const char *ControlFilePath, bool *crc_ok_p)
#define pg_log_debug(...)
Definition logging.h:135
#define PG_CONTROL_VERSION
Definition pg_control.h:25
uint32 pg_control_version
Definition pg_control.h:133
uint64 system_identifier
Definition pg_control.h:118

References fb(), get_controlfile_by_exact_path(), pfree(), PG_CONTROL_VERSION, ControlFileData::pg_control_version, pg_log_debug, report_fatal_error(), and ControlFileData::system_identifier.

Referenced by verify_plain_backup_file().

◆ verify_file_checksum()

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

Definition at line 1125 of file pg_verifybackup.c.

1127{
1128 pg_checksum_context checksum_ctx;
1129 const char *relpath = m->pathname;
1130 int fd;
1131 ssize_t rc;
1132 uint64 bytes_read = 0;
1134 int checksumlen;
1135
1136 /* Open the target file. */
1137 if ((fd = open(fullpath, O_RDONLY | PG_BINARY, 0)) < 0)
1138 {
1139 report_backup_error(context, "could not open file \"%s\": %m",
1140 relpath);
1141 return;
1142 }
1143
1144 /* Initialize checksum context. */
1145 if (pg_checksum_init(&checksum_ctx, m->checksum_type) < 0)
1146 {
1147 report_backup_error(context, "could not initialize checksum of file \"%s\"",
1148 relpath);
1149 close(fd);
1150 return;
1151 }
1152
1153 /* Read the file chunk by chunk, updating the checksum as we go. */
1154 while ((rc = read(fd, buffer, READ_CHUNK_SIZE)) > 0)
1155 {
1156 bytes_read += rc;
1157 if (pg_checksum_update(&checksum_ctx, buffer, rc) < 0)
1158 {
1159 report_backup_error(context, "could not update checksum of file \"%s\"",
1160 relpath);
1161 close(fd);
1162 return;
1163 }
1164
1165 /* Report progress */
1166 done_size += rc;
1167 progress_report(false);
1168 }
1169 if (rc < 0)
1170 report_backup_error(context, "could not read file \"%s\": %m",
1171 relpath);
1172
1173 /* Close the file. */
1174 if (close(fd) != 0)
1175 {
1176 report_backup_error(context, "could not close file \"%s\": %m",
1177 relpath);
1178 return;
1179 }
1180
1181 /* If we didn't manage to read the whole file, bail out now. */
1182 if (rc < 0)
1183 return;
1184
1185 /*
1186 * Double-check that we read the expected number of bytes from the file.
1187 * Normally, mismatches would be caught in verify_plain_backup_file and
1188 * this check would never be reached, but this provides additional safety
1189 * and clarity in the event of concurrent modifications or filesystem
1190 * misbehavior.
1191 */
1192 if (bytes_read != m->size)
1193 {
1194 report_backup_error(context,
1195 "file \"%s\" should contain %" PRIu64 " bytes, but read %" PRIu64,
1196 relpath, m->size, bytes_read);
1197 return;
1198 }
1199
1200 /* Get the final checksum. */
1201 checksumlen = pg_checksum_final(&checksum_ctx, checksumbuf);
1202 if (checksumlen < 0)
1203 {
1204 report_backup_error(context,
1205 "could not finalize checksum of file \"%s\"",
1206 relpath);
1207 return;
1208 }
1209
1210 /* And check it against the manifest. */
1211 if (checksumlen != m->checksum_length)
1212 report_backup_error(context,
1213 "file \"%s\" has checksum of length %d, but expected %d",
1215 else if (memcmp(checksumbuf, m->checksum_payload, checksumlen) != 0)
1216 report_backup_error(context,
1217 "checksum mismatch for file \"%s\"",
1218 relpath);
1219}
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
uint8 * checksum_payload
pg_checksum_type checksum_type

References manifest_file::checksum_length, manifest_file::checksum_payload, manifest_file::checksum_type, close, done_size, fb(), 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().

◆ verify_plain_backup_directory()

static void verify_plain_backup_directory ( verifier_context context,
char relpath,
char fullpath,
DIR dir 
)
static

Definition at line 635 of file pg_verifybackup.c.

637{
638 struct dirent *dirent;
639
640 /* Open the directory unless the caller did it. */
641 if (dir == NULL && ((dir = opendir(fullpath)) == NULL))
642 {
643 report_backup_error(context,
644 "could not open directory \"%s\": %m", fullpath);
646
647 return;
648 }
649
650 while (errno = 0, (dirent = readdir(dir)) != NULL)
651 {
652 char *filename = dirent->d_name;
653 char *newfullpath = psprintf("%s/%s", fullpath, filename);
654 char *newrelpath;
655
656 /* Skip "." and ".." */
657 if (filename[0] == '.' && (filename[1] == '\0'
658 || strcmp(filename, "..") == 0))
659 continue;
660
661 if (relpath == NULL)
663 else
664 newrelpath = psprintf("%s/%s", relpath, filename);
665
666 if (!should_ignore_relpath(context, newrelpath))
668
671 }
672
673 if (closedir(dir))
674 {
675 report_backup_error(context,
676 "could not close directory \"%s\": %m", fullpath);
677 return;
678 }
679}
int closedir(DIR *)
Definition dirent.c:127
struct dirent * readdir(DIR *)
Definition dirent.c:78
static char * filename
Definition pg_dumpall.c:120
static void verify_plain_backup_file(verifier_context *context, char *relpath, char *fullpath)
char d_name[MAX_PATH]
Definition dirent.h:15

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

Referenced by main(), and verify_plain_backup_file().

◆ verify_plain_backup_file()

static void verify_plain_backup_file ( verifier_context context,
char relpath,
char fullpath 
)
static

Definition at line 688 of file pg_verifybackup.c.

690{
691 struct stat sb;
692 manifest_file *m;
693
694 if (stat(fullpath, &sb) != 0)
695 {
696 report_backup_error(context,
697 "could not stat file or directory \"%s\": %m",
698 relpath);
699
700 /*
701 * Suppress further errors related to this path name and, if it's a
702 * directory, anything underneath it.
703 */
705
706 return;
707 }
708
709 /* If it's a directory, just recurse. */
710 if (S_ISDIR(sb.st_mode))
711 {
712 verify_plain_backup_directory(context, relpath, fullpath, NULL);
713 return;
714 }
715
716 /* If it's not a directory, it should be a regular file. */
717 if (!S_ISREG(sb.st_mode))
718 {
719 report_backup_error(context,
720 "\"%s\" is not a regular file or directory",
721 relpath);
722 return;
723 }
724
725 /* Check whether there's an entry in the manifest hash. */
727 if (m == NULL)
728 {
729 report_backup_error(context,
730 "\"%s\" is present on disk but not in the manifest",
731 relpath);
732 return;
733 }
734
735 /* Flag this entry as having been encountered in the filesystem. */
736 m->matched = true;
737
738 /* Check that the size matches. */
739 if (m->size != sb.st_size)
740 {
741 report_backup_error(context,
742 "\"%s\" has size %lld on disk but size %" PRIu64 " in the manifest",
743 relpath, (long long) sb.st_size,
744 m->size);
745 m->bad = true;
746 }
747
748 /*
749 * Validate the manifest system identifier, not available in manifest
750 * version 1.
751 */
752 if (context->manifest->version != 1 &&
755
756 /* Update statistics for progress report, if necessary */
757 if (show_progress && !context->skip_checksums &&
759 total_size += m->size;
760
761 /*
762 * We don't verify checksums at this stage. We first finish verifying that
763 * we have the expected set of files with the expected sizes, and only
764 * afterwards verify the checksums. That's because computing checksums may
765 * take a while, and we'd like to report more obvious problems quickly.
766 */
767}
static void verify_control_file(const char *controlpath, uint64 manifest_system_identifier)
uint64 system_identifier
manifest_files_hash * files
#define S_ISDIR(m)
Definition win32_port.h:332
#define XLOG_CONTROL_FILE

References fb(), manifest_data::files, verifier_context::ignore_list, verifier_context::manifest, relpath, report_backup_error(), S_ISDIR, S_ISREG, should_verify_checksum, show_progress, simple_string_list_append(), verifier_context::skip_checksums, stat, manifest_data::system_identifier, total_size, verify_control_file(), verify_plain_backup_directory(), manifest_data::version, and XLOG_CONTROL_FILE.

Referenced by verify_plain_backup_directory().

◆ verify_tar_backup()

static void verify_tar_backup ( verifier_context context,
DIR dir,
char **  base_archive_path,
char **  wal_archive_path 
)
static

Definition at line 809 of file pg_verifybackup.c.

811{
812 struct dirent *dirent;
814 SimplePtrListCell *cell;
815
816 Assert(context->format != 'p');
817
818 progress_report(false);
819
820 /* First pass: scan the directory for tar files. */
821 while (errno = 0, (dirent = readdir(dir)) != NULL)
822 {
823 char *filename = dirent->d_name;
824
825 /* Skip "." and ".." */
826 if (filename[0] == '.' && (filename[1] == '\0'
827 || strcmp(filename, "..") == 0))
828 continue;
829
830 /*
831 * Unless it's something we should ignore, perform prechecks and add
832 * it to the list.
833 */
834 if (!should_ignore_relpath(context, filename))
835 {
836 char *fullpath;
837
838 fullpath = psprintf("%s/%s", context->backup_directory, filename);
839 precheck_tar_backup_file(context, filename, fullpath, &tarfiles,
841 pfree(fullpath);
842 }
843 }
844
845 if (closedir(dir))
846 {
847 report_backup_error(context,
848 "could not close directory \"%s\": %m",
849 context->backup_directory);
850 return;
851 }
852
853 /* Second pass: Perform the final verification of the tar contents. */
854 for (cell = tarfiles.head; cell != NULL; cell = cell->next)
855 {
856 tar_file *tar = (tar_file *) cell->ptr;
857 astreamer *streamer;
858 char *fullpath;
859
860 /*
861 * Prepares the archive streamer stack according to the tar
862 * compression format.
863 */
864 streamer = create_archive_verifier(context,
865 tar->relpath,
866 tar->tblspc_oid,
867 tar->compress_algorithm);
868
869 /* Compute the full pathname to the target file. */
870 fullpath = psprintf("%s/%s", context->backup_directory,
871 tar->relpath);
872
873 /* Invoke the streamer for reading, decompressing, and verifying. */
874 verify_tar_file(context, tar->relpath, fullpath, streamer);
875
876 /* Cleanup. */
877 pfree(tar->relpath);
878 pfree(tar);
879 pfree(fullpath);
880
881 astreamer_finalize(streamer);
882 astreamer_free(streamer);
883 }
885
886 progress_report(true);
887}
static void astreamer_free(astreamer *streamer)
Definition astreamer.h:155
static void astreamer_finalize(astreamer *streamer)
Definition astreamer.h:147
static void verify_tar_file(verifier_context *context, char *relpath, char *fullpath, astreamer *streamer)
static void precheck_tar_backup_file(verifier_context *context, char *relpath, char *fullpath, SimplePtrList *tarfiles, char **base_archive_path, char **wal_archive_path)
static astreamer * create_archive_verifier(verifier_context *context, char *archive_name, Oid tblspc_oid, pg_compress_algorithm compress_algo)
void simple_ptr_list_destroy(SimplePtrList *list)
struct SimplePtrListCell * next
Definition simple_list.h:48

References Assert, astreamer_finalize(), astreamer_free(), verifier_context::backup_directory, closedir(), create_archive_verifier(), dirent::d_name, fb(), filename, verifier_context::format, SimplePtrListCell::next, pfree(), precheck_tar_backup_file(), progress_report(), psprintf(), SimplePtrListCell::ptr, readdir(), report_backup_error(), should_ignore_relpath(), simple_ptr_list_destroy(), and verify_tar_file().

Referenced by main().

◆ verify_tar_file()

static void verify_tar_file ( verifier_context context,
char relpath,
char fullpath,
astreamer streamer 
)
static

Definition at line 1019 of file pg_verifybackup.c.

1021{
1022 int fd;
1023 ssize_t rc;
1024 char *buffer;
1025
1026 pg_log_debug("reading \"%s\"", fullpath);
1027
1028 /* Open the target file. */
1029 if ((fd = open(fullpath, O_RDONLY | PG_BINARY, 0)) < 0)
1030 {
1031 report_backup_error(context, "could not open file \"%s\": %m",
1032 relpath);
1033 return;
1034 }
1035
1036 buffer = pg_malloc(READ_CHUNK_SIZE * sizeof(uint8));
1037
1038 /* Perform the reads */
1039 while ((rc = read(fd, buffer, READ_CHUNK_SIZE)) > 0)
1040 {
1041 astreamer_content(streamer, NULL, buffer, rc, ASTREAMER_UNKNOWN);
1042
1043 /* Report progress */
1044 done_size += rc;
1045 progress_report(false);
1046 }
1047
1048 pg_free(buffer);
1049
1050 if (rc < 0)
1051 report_backup_error(context, "could not read file \"%s\": %m",
1052 relpath);
1053
1054 /* Close the file. */
1055 if (close(fd) != 0)
1056 report_backup_error(context, "could not close file \"%s\": %m",
1057 relpath);
1058}
static void astreamer_content(astreamer *streamer, astreamer_member *member, const char *data, int len, astreamer_archive_context context)
Definition astreamer.h:137
@ ASTREAMER_UNKNOWN
Definition astreamer.h:64

References astreamer_content(), ASTREAMER_UNKNOWN, close, done_size, fb(), fd(), PG_BINARY, pg_free(), pg_log_debug, pg_malloc(), progress_report(), read, READ_CHUNK_SIZE, relpath, and report_backup_error().

Referenced by verify_tar_backup().

◆ verifybackup_per_file_cb()

static void verifybackup_per_file_cb ( JsonManifestParseContext context,
const char pathname,
uint64  size,
pg_checksum_type  checksum_type,
int  checksum_length,
uint8 checksum_payload 
)
static

Definition at line 569 of file pg_verifybackup.c.

573{
576 manifest_file *m;
577 bool found;
578
579 /* Make a new entry in the hash table for this file. */
580 m = manifest_files_insert(ht, pathname, &found);
581 if (found)
582 report_fatal_error("duplicate path name in backup manifest: \"%s\"",
583 pathname);
584
585 /* Initialize the entry. */
586 m->size = size;
587 m->checksum_type = checksum_type;
588 m->checksum_length = checksum_length;
589 m->checksum_payload = checksum_payload;
590 m->matched = false;
591 m->bad = false;
592}

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

Referenced by parse_manifest_file().

◆ verifybackup_per_wal_range_cb()

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

Definition at line 598 of file pg_verifybackup.c.

601{
604
605 /* Allocate and initialize a struct describing this WAL range. */
607 range->tli = tli;
608 range->start_lsn = start_lsn;
609 range->end_lsn = end_lsn;
610 range->prev = manifest->last_wal_range;
611 range->next = NULL;
612
613 /* Add it to the end of the list. */
614 if (manifest->first_wal_range == NULL)
615 manifest->first_wal_range = range;
616 else
617 manifest->last_wal_range->next = range;
618 manifest->last_wal_range = range;
619}
#define palloc_object(type)
Definition fe_memutils.h:89
static struct cvec * range(struct vars *v, chr a, chr b, int cases)

References fb(), manifest, palloc_object, JsonManifestParseContext::private_data, and range().

Referenced by parse_manifest_file().

◆ verifybackup_system_identifier()

static void verifybackup_system_identifier ( JsonManifestParseContext context,
uint64  manifest_system_identifier 
)
static

Definition at line 556 of file pg_verifybackup.c.

558{
560
561 /* Validation will be at the later stage */
562 manifest->system_identifier = manifest_system_identifier;
563}

References manifest, and JsonManifestParseContext::private_data.

Referenced by parse_manifest_file().

◆ verifybackup_version_cb()

static void verifybackup_version_cb ( JsonManifestParseContext context,
int  manifest_version 
)
static

Definition at line 543 of file pg_verifybackup.c.

545{
547
548 /* Validation will be at the later stage */
549 manifest->version = manifest_version;
550}

References manifest, and JsonManifestParseContext::private_data.

Referenced by parse_manifest_file().

Variable Documentation

◆ done_size

uint64 done_size = 0
static

Definition at line 116 of file pg_verifybackup.c.

Referenced by progress_report(), verify_file_checksum(), and verify_tar_file().

◆ progname

const char* progname
static

Definition at line 109 of file pg_verifybackup.c.

Referenced by main(), and usage().

◆ show_progress

bool show_progress = false
static

◆ total_size

uint64 total_size = 0
static