PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
pg_verifybackup.c File Reference
#include "postgres_fe.h"
#include <dirent.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <time.h>
#include "common/logging.h"
#include "common/parse_manifest.h"
#include "fe_utils/simple_list.h"
#include "getopt_long.h"
#include "limits.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 void report_manifest_error (JsonManifestParseContext *context, const char *fmt,...) pg_attribute_printf(2
 
static void pg_attribute_noreturn ()
 
static void verify_tar_backup (verifier_context *context, DIR *dir)
 
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)
 
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_directory)
 
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 char * progname
 
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 41 of file pg_verifybackup.c.

◆ READ_CHUNK_SIZE

#define READ_CHUNK_SIZE   (128 * 1024)

Definition at line 46 of file pg_verifybackup.c.

Typedef Documentation

◆ tar_file

typedef struct tar_file 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 1291 of file pg_verifybackup.c.

1293{
1294 astreamer *streamer = NULL;
1295
1296 /* Should be here only for tar backup */
1297 Assert(context->format == 't');
1298
1299 /* Last step is the actual verification. */
1300 streamer = astreamer_verify_content_new(streamer, context, archive_name,
1301 tblspc_oid);
1302
1303 /* Before that we must parse the tar file. */
1304 streamer = astreamer_tar_parser_new(streamer);
1305
1306 /* Before that we must decompress, if archive is compressed. */
1307 if (compress_algo == PG_COMPRESSION_GZIP)
1308 streamer = astreamer_gzip_decompressor_new(streamer);
1309 else if (compress_algo == PG_COMPRESSION_LZ4)
1310 streamer = astreamer_lz4_decompressor_new(streamer);
1311 else if (compress_algo == PG_COMPRESSION_ZSTD)
1312 streamer = astreamer_zstd_decompressor_new(streamer);
1313
1314 return streamer;
1315}
astreamer * astreamer_gzip_decompressor_new(astreamer *next)
astreamer * astreamer_lz4_decompressor_new(astreamer *next)
astreamer * astreamer_tar_parser_new(astreamer *next)
Definition: astreamer_tar.c:93
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:812
@ PG_COMPRESSION_GZIP
Definition: compression.h:24
@ PG_COMPRESSION_LZ4
Definition: compression.h:25
@ PG_COMPRESSION_ZSTD
Definition: compression.h:26

References Assert, astreamer_gzip_decompressor_new(), astreamer_lz4_decompressor_new(), astreamer_tar_parser_new(), astreamer_verify_content_new(), astreamer_zstd_decompressor_new(), 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 117 of file pg_verifybackup.c.

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

References _, arg, canonicalize_path(), exit(), 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 391 of file pg_verifybackup.c.

392{
393 int fd;
394 struct stat statbuf;
395 off_t estimate;
396 uint32 initial_size;
397 manifest_files_hash *ht;
398 char *buffer;
399 int rc;
401 manifest_data *result;
402
403 int chunk_size = READ_CHUNK_SIZE;
404
405 /* Open the manifest file. */
406 if ((fd = open(manifest_path, O_RDONLY | PG_BINARY, 0)) < 0)
407 report_fatal_error("could not open file \"%s\": %m", manifest_path);
408
409 /* Figure out how big the manifest is. */
410 if (fstat(fd, &statbuf) != 0)
411 report_fatal_error("could not stat file \"%s\": %m", manifest_path);
412
413 /* Guess how large to make the hash table based on the manifest size. */
414 estimate = statbuf.st_size / ESTIMATED_BYTES_PER_MANIFEST_LINE;
415 initial_size = Min(PG_UINT32_MAX, Max(estimate, 256));
416
417 /* Create the hash table. */
418 ht = manifest_files_create(initial_size, NULL);
419
420 result = pg_malloc0(sizeof(manifest_data));
421 result->files = ht;
422 context.private_data = result;
428
429 /*
430 * Parse the file, in chunks if necessary.
431 */
432 if (statbuf.st_size <= chunk_size)
433 {
434 buffer = pg_malloc(statbuf.st_size);
435 rc = read(fd, buffer, statbuf.st_size);
436 if (rc != statbuf.st_size)
437 {
438 if (rc < 0)
439 pg_fatal("could not read file \"%s\": %m", manifest_path);
440 else
441 pg_fatal("could not read file \"%s\": read %d of %lld",
442 manifest_path, rc, (long long int) statbuf.st_size);
443 }
444
445 /* Close the manifest file. */
446 close(fd);
447
448 /* Parse the manifest. */
449 json_parse_manifest(&context, buffer, statbuf.st_size);
450 }
451 else
452 {
453 int bytes_left = statbuf.st_size;
455
456 inc_state = json_parse_manifest_incremental_init(&context);
457
458 buffer = pg_malloc(chunk_size + 1);
459
460 while (bytes_left > 0)
461 {
462 int bytes_to_read = chunk_size;
463
464 /*
465 * Make sure that the last chunk is sufficiently large. (i.e. at
466 * least half the chunk size) so that it will contain fully the
467 * piece at the end with the checksum.
468 */
469 if (bytes_left < chunk_size)
470 bytes_to_read = bytes_left;
471 else if (bytes_left < 2 * chunk_size)
472 bytes_to_read = bytes_left / 2;
473 rc = read(fd, buffer, bytes_to_read);
474 if (rc != bytes_to_read)
475 {
476 if (rc < 0)
477 pg_fatal("could not read file \"%s\": %m", manifest_path);
478 else
479 pg_fatal("could not read file \"%s\": read %lld of %lld",
480 manifest_path,
481 (long long int) (statbuf.st_size + rc - bytes_left),
482 (long long int) statbuf.st_size);
483 }
484 bytes_left -= rc;
485 json_parse_manifest_incremental_chunk(inc_state, buffer, rc,
486 bytes_left == 0);
487 }
488
489 /* Release the incremental state memory */
491
492 close(fd);
493 }
494
495 /* Done with the buffer. */
496 pfree(buffer);
497
498 return result;
499}
#define Min(x, y)
Definition: c.h:958
#define PG_UINT32_MAX
Definition: c.h:544
#define Max(x, y)
Definition: c.h:952
#define PG_BINARY
Definition: c.h:1227
uint32_t uint32
Definition: c.h:485
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
#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)
#define ESTIMATED_BYTES_PER_MANIFEST_LINE
#define READ_CHUNK_SIZE
static 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)
Definition: preproc-init.c:105
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
manifest_files_hash * files
Definition: load_manifest.h:59
#define fstat
Definition: win32_port.h:283

References close, JsonManifestParseContext::error_cb, ESTIMATED_BYTES_PER_MANIFEST_LINE, fd(), manifest_data::files, 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, pfree(), PG_BINARY, pg_fatal, pg_malloc(), pg_malloc0(), PG_UINT32_MAX, JsonManifestParseContext::private_data, read, READ_CHUNK_SIZE, report_fatal_error(), report_manifest_error(), stat::st_size, JsonManifestParseContext::system_identifier_cb, 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_directory 
)
static

Definition at line 1200 of file pg_verifybackup.c.

1202{
1203 manifest_data *manifest = context->manifest;
1204 manifest_wal_range *this_wal_range = manifest->first_wal_range;
1205
1206 while (this_wal_range != NULL)
1207 {
1208 char *pg_waldump_cmd;
1209
1210 pg_waldump_cmd = psprintf("\"%s\" --quiet --path=\"%s\" --timeline=%u --start=%X/%X --end=%X/%X\n",
1211 pg_waldump_path, wal_directory, this_wal_range->tli,
1212 LSN_FORMAT_ARGS(this_wal_range->start_lsn),
1213 LSN_FORMAT_ARGS(this_wal_range->end_lsn));
1214 fflush(NULL);
1215 if (system(pg_waldump_cmd) != 0)
1216 report_backup_error(context,
1217 "WAL parsing failed for timeline %u",
1218 this_wal_range->tli);
1219
1220 this_wal_range = this_wal_range->next;
1221 }
1222}
static void const char fflush(stdout)
static bool manifest
void report_backup_error(verifier_context *context, const char *pg_restrict fmt,...)
XLogRecPtr end_lsn
Definition: load_manifest.h:48
struct manifest_wal_range * next
Definition: load_manifest.h:49
XLogRecPtr start_lsn
Definition: load_manifest.h:47
#define LSN_FORMAT_ARGS(lsn)
Definition: xlogdefs.h:43

References manifest_wal_range::end_lsn, fflush(), LSN_FORMAT_ARGS, manifest, verifier_context::manifest, 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 ( )

◆ precheck_tar_backup_file()

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

Definition at line 880 of file pg_verifybackup.c.

882{
883 struct stat sb;
884 Oid tblspc_oid = InvalidOid;
885 pg_compress_algorithm compress_algorithm;
886 tar_file *tar;
887 char *suffix = NULL;
888
889 /* Should be tar format backup */
890 Assert(context->format == 't');
891
892 /* Get file information */
893 if (stat(fullpath, &sb) != 0)
894 {
895 report_backup_error(context,
896 "could not stat file or directory \"%s\": %m",
897 relpath);
898 return;
899 }
900
901 /* In a tar format backup, we expect only plain files. */
902 if (!S_ISREG(sb.st_mode))
903 {
904 report_backup_error(context,
905 "\"%s\" is not a plain file",
906 relpath);
907 return;
908 }
909
910 /*
911 * We expect tar files for backing up the main directory, tablespace, and
912 * pg_wal directory.
913 *
914 * pg_basebackup writes the main data directory to an archive file named
915 * base.tar, the pg_wal directory to pg_wal.tar, and the tablespace
916 * directory to <tablespaceoid>.tar, each followed by a compression type
917 * extension such as .gz, .lz4, or .zst.
918 */
919 if (strncmp("base", relpath, 4) == 0)
920 suffix = relpath + 4;
921 else if (strncmp("pg_wal", relpath, 6) == 0)
922 suffix = relpath + 6;
923 else
924 {
925 /* Expected a <tablespaceoid>.tar file here. */
926 uint64 num = strtoul(relpath, &suffix, 10);
927
928 /*
929 * Report an error if we didn't consume at least one character, if the
930 * result is 0, or if the value is too large to be a valid OID.
931 */
932 if (suffix == NULL || num <= 0 || num > OID_MAX)
933 {
934 report_backup_error(context,
935 "file \"%s\" is not expected in a tar format backup",
936 relpath);
937 return;
938 }
939 tblspc_oid = (Oid) num;
940 }
941
942 /* Now, check the compression type of the tar */
943 if (strcmp(suffix, ".tar") == 0)
944 compress_algorithm = PG_COMPRESSION_NONE;
945 else if (strcmp(suffix, ".tgz") == 0)
946 compress_algorithm = PG_COMPRESSION_GZIP;
947 else if (strcmp(suffix, ".tar.gz") == 0)
948 compress_algorithm = PG_COMPRESSION_GZIP;
949 else if (strcmp(suffix, ".tar.lz4") == 0)
950 compress_algorithm = PG_COMPRESSION_LZ4;
951 else if (strcmp(suffix, ".tar.zst") == 0)
952 compress_algorithm = PG_COMPRESSION_ZSTD;
953 else
954 {
955 report_backup_error(context,
956 "file \"%s\" is not expected in a tar format backup",
957 relpath);
958 return;
959 }
960
961 /*
962 * Ignore WALs, as reading and verification will be handled through
963 * pg_waldump.
964 */
965 if (strncmp("pg_wal", relpath, 6) == 0)
966 return;
967
968 /*
969 * Append the information to the list for complete verification at a later
970 * stage.
971 */
972 tar = pg_malloc(sizeof(tar_file));
973 tar->relpath = pstrdup(relpath);
974 tar->tblspc_oid = tblspc_oid;
975 tar->compress_algorithm = compress_algorithm;
976
977 simple_ptr_list_append(tarfiles, tar);
978
979 /* Update statistics for progress report, if necessary */
980 if (show_progress)
981 total_size += sb.st_size;
982}
uint64_t uint64
Definition: c.h:486
pg_compress_algorithm
Definition: compression.h:22
@ PG_COMPRESSION_NONE
Definition: compression.h:23
static uint64 total_size
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
#define OID_MAX
Definition: postgres_ext.h:39
#define relpath(rlocator, forknum)
Definition: relpath.h:102
void simple_ptr_list_append(SimplePtrList *list, void *ptr)
Definition: simple_list.c:162
char * relpath
pg_compress_algorithm compress_algorithm
#define S_ISREG(m)
Definition: win32_port.h:328

References Assert, tar_file::compress_algorithm, verifier_context::format, InvalidOid, OID_MAX, PG_COMPRESSION_GZIP, PG_COMPRESSION_LZ4, PG_COMPRESSION_NONE, PG_COMPRESSION_ZSTD, pg_malloc(), pstrdup(), tar_file::relpath, relpath, report_backup_error(), S_ISREG, show_progress, simple_ptr_list_append(), stat::st_mode, stat::st_size, stat, tar_file::tblspc_oid, and total_size.

Referenced by verify_tar_backup().

◆ progress_report()

static void progress_report ( bool  finished)
static

Definition at line 1327 of file pg_verifybackup.c.

1328{
1330 pg_time_t now;
1331 int percent_size = 0;
1332 char totalsize_str[32];
1333 char donesize_str[32];
1334
1335 if (!show_progress)
1336 return;
1337
1338 now = time(NULL);
1339 if (now == last_progress_report && !finished)
1340 return; /* Max once per second */
1341
1343 percent_size = total_size ? (int) ((done_size * 100 / total_size)) : 0;
1344
1345 snprintf(totalsize_str, sizeof(totalsize_str), UINT64_FORMAT,
1346 total_size / 1024);
1347 snprintf(donesize_str, sizeof(donesize_str), UINT64_FORMAT,
1348 done_size / 1024);
1349
1350 fprintf(stderr,
1351 _("%*s/%s kB (%d%%) verified"),
1352 (int) strlen(totalsize_str),
1353 donesize_str, totalsize_str, percent_size);
1354
1355 /*
1356 * Stay on the same line if reporting to a terminal and we're not done
1357 * yet.
1358 */
1359 fputc((!finished && isatty(fileno(stderr))) ? '\r' : '\n', stderr);
1360}
Datum now(PG_FUNCTION_ARGS)
Definition: timestamp.c:1608
#define UINT64_FORMAT
Definition: c.h:504
#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:238

References _, done_size, 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 1231 of file pg_verifybackup.c.

1232{
1233 va_list ap;
1234
1235 va_start(ap, fmt);
1237 va_end(ap);
1238
1239 context->saw_any_error = true;
1240 if (context->exit_on_error)
1241 exit(1);
1242}
#define gettext(x)
Definition: c.h:1133
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:219
@ 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 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 1038 of file pg_verifybackup.c.

1039{
1040 manifest_data *manifest = context->manifest;
1041 manifest_files_iterator it;
1042 manifest_file *m;
1043
1044 manifest_files_start_iterate(manifest->files, &it);
1045 while ((m = manifest_files_iterate(manifest->files, &it)) != NULL)
1046 if (!m->matched && !should_ignore_relpath(context, m->pathname))
1047 report_backup_error(context,
1048 "\"%s\" is present in the manifest but not on disk",
1049 m->pathname);
1050}
bool should_ignore_relpath(verifier_context *context, const char *relpath)
const char * pathname
Definition: load_manifest.h:25

References 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 508 of file pg_verifybackup.c.

509{
510 va_list ap;
511
512 va_start(ap, fmt);
514 va_end(ap);
515
516 exit(1);
517}

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()

bool should_ignore_relpath ( verifier_context context,
const char *  relpath 
)

Definition at line 1267 of file pg_verifybackup.c.

1268{
1270
1271 for (cell = context->ignore_list.head; cell != NULL; cell = cell->next)
1272 {
1273 const char *r = relpath;
1274 char *v = cell->val;
1275
1276 while (*v != '\0' && *r == *v)
1277 ++r, ++v;
1278
1279 if (*v == '\0' && (*r == '\0' || *r == '/'))
1280 return true;
1281 }
1282
1283 return false;
1284}
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 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 1366 of file pg_verifybackup.c.

1367{
1368 printf(_("%s verifies a backup against the backup manifest.\n\n"), progname);
1369 printf(_("Usage:\n %s [OPTION]... BACKUPDIR\n\n"), progname);
1370 printf(_("Options:\n"));
1371 printf(_(" -e, --exit-on-error exit immediately on error\n"));
1372 printf(_(" -F, --format=p|t backup format (plain, tar)\n"));
1373 printf(_(" -i, --ignore=RELATIVE_PATH ignore indicated path\n"));
1374 printf(_(" -m, --manifest-path=PATH use specified path for manifest\n"));
1375 printf(_(" -n, --no-parse-wal do not try to parse WAL files\n"));
1376 printf(_(" -P, --progress show progress information\n"));
1377 printf(_(" -q, --quiet do not print any output, except for errors\n"));
1378 printf(_(" -s, --skip-checksums skip checksum verification\n"));
1379 printf(_(" -w, --wal-directory=PATH use specified path for WAL files\n"));
1380 printf(_(" -V, --version output version information, then exit\n"));
1381 printf(_(" -?, --help show this help, then exit\n"));
1382 printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
1383 printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
1384}

References _, printf, and progname.

Referenced by main().

◆ verify_backup_checksums()

static void verify_backup_checksums ( verifier_context context)
static

Definition at line 1058 of file pg_verifybackup.c.

1059{
1060 manifest_data *manifest = context->manifest;
1061 manifest_files_iterator it;
1062 manifest_file *m;
1063 uint8 *buffer;
1064
1065 progress_report(false);
1066
1067 buffer = pg_malloc(READ_CHUNK_SIZE * sizeof(uint8));
1068
1069 manifest_files_start_iterate(manifest->files, &it);
1070 while ((m = manifest_files_iterate(manifest->files, &it)) != NULL)
1071 {
1072 if (should_verify_checksum(m) &&
1073 !should_ignore_relpath(context, m->pathname))
1074 {
1075 char *fullpath;
1076
1077 /* Compute the full pathname to the target file. */
1078 fullpath = psprintf("%s/%s", context->backup_directory,
1079 m->pathname);
1080
1081 /* Do the actual checksum verification. */
1082 verify_file_checksum(context, m, fullpath, buffer);
1083
1084 /* Avoid leaking memory. */
1085 pfree(fullpath);
1086 }
1087 }
1088
1089 pfree(buffer);
1090
1091 progress_report(true);
1092}
uint8_t uint8
Definition: c.h:483
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, manifest, verifier_context::manifest, manifest_file::pathname, pfree(), pg_malloc(), 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 754 of file pg_verifybackup.c.

755{
756 ControlFileData *control_file;
757 bool crc_ok;
758
759 pg_log_debug("reading \"%s\"", controlpath);
760 control_file = get_controlfile_by_exact_path(controlpath, &crc_ok);
761
762 /* Control file contents not meaningful if CRC is bad. */
763 if (!crc_ok)
764 report_fatal_error("%s: CRC is incorrect", controlpath);
765
766 /* Can't interpret control file if not current version. */
767 if (control_file->pg_control_version != PG_CONTROL_VERSION)
768 report_fatal_error("%s: unexpected control file version",
769 controlpath);
770
771 /* System identifiers should match. */
772 if (manifest_system_identifier != control_file->system_identifier)
773 report_fatal_error("%s: manifest system identifier is %llu, but control file has %llu",
774 controlpath,
775 (unsigned long long) manifest_system_identifier,
776 (unsigned long long) control_file->system_identifier);
777
778 /* Release memory. */
779 pfree(control_file);
780}
ControlFileData * get_controlfile_by_exact_path(const char *ControlFilePath, bool *crc_ok_p)
#define pg_log_debug(...)
Definition: logging.h:133
#define PG_CONTROL_VERSION
Definition: pg_control.h:25
uint32 pg_control_version
Definition: pg_control.h:125
uint64 system_identifier
Definition: pg_control.h:110

References 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 1098 of file pg_verifybackup.c.

1100{
1101 pg_checksum_context checksum_ctx;
1102 const char *relpath = m->pathname;
1103 int fd;
1104 int rc;
1105 uint64 bytes_read = 0;
1106 uint8 checksumbuf[PG_CHECKSUM_MAX_LENGTH];
1107 int checksumlen;
1108
1109 /* Open the target file. */
1110 if ((fd = open(fullpath, O_RDONLY | PG_BINARY, 0)) < 0)
1111 {
1112 report_backup_error(context, "could not open file \"%s\": %m",
1113 relpath);
1114 return;
1115 }
1116
1117 /* Initialize checksum context. */
1118 if (pg_checksum_init(&checksum_ctx, m->checksum_type) < 0)
1119 {
1120 report_backup_error(context, "could not initialize checksum of file \"%s\"",
1121 relpath);
1122 close(fd);
1123 return;
1124 }
1125
1126 /* Read the file chunk by chunk, updating the checksum as we go. */
1127 while ((rc = read(fd, buffer, READ_CHUNK_SIZE)) > 0)
1128 {
1129 bytes_read += rc;
1130 if (pg_checksum_update(&checksum_ctx, buffer, rc) < 0)
1131 {
1132 report_backup_error(context, "could not update checksum of file \"%s\"",
1133 relpath);
1134 close(fd);
1135 return;
1136 }
1137
1138 /* Report progress */
1139 done_size += rc;
1140 progress_report(false);
1141 }
1142 if (rc < 0)
1143 report_backup_error(context, "could not read file \"%s\": %m",
1144 relpath);
1145
1146 /* Close the file. */
1147 if (close(fd) != 0)
1148 {
1149 report_backup_error(context, "could not close file \"%s\": %m",
1150 relpath);
1151 return;
1152 }
1153
1154 /* If we didn't manage to read the whole file, bail out now. */
1155 if (rc < 0)
1156 return;
1157
1158 /*
1159 * Double-check that we read the expected number of bytes from the file.
1160 * Normally, mismatches would be caught in verify_plain_backup_file and
1161 * this check would never be reached, but this provides additional safety
1162 * and clarity in the event of concurrent modifications or filesystem
1163 * misbehavior.
1164 */
1165 if (bytes_read != m->size)
1166 {
1167 report_backup_error(context,
1168 "file \"%s\" should contain %llu bytes, but read %llu bytes",
1169 relpath, (unsigned long long) m->size,
1170 (unsigned long long) bytes_read);
1171 return;
1172 }
1173
1174 /* Get the final checksum. */
1175 checksumlen = pg_checksum_final(&checksum_ctx, checksumbuf);
1176 if (checksumlen < 0)
1177 {
1178 report_backup_error(context,
1179 "could not finalize checksum of file \"%s\"",
1180 relpath);
1181 return;
1182 }
1183
1184 /* And check it against the manifest. */
1185 if (checksumlen != m->checksum_length)
1186 report_backup_error(context,
1187 "file \"%s\" has checksum of length %d, but expected %d",
1188 relpath, m->checksum_length, checksumlen);
1189 else if (memcmp(checksumbuf, m->checksum_payload, checksumlen) != 0)
1190 report_backup_error(context,
1191 "checksum mismatch for file \"%s\"",
1192 relpath);
1193}
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
Definition: load_manifest.h:29
pg_checksum_type checksum_type
Definition: load_manifest.h:27

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().

◆ verify_plain_backup_directory()

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

Definition at line 615 of file pg_verifybackup.c.

617{
618 struct dirent *dirent;
619
620 /* Open the directory unless the caller did it. */
621 if (dir == NULL && ((dir = opendir(fullpath)) == NULL))
622 {
623 report_backup_error(context,
624 "could not open directory \"%s\": %m", fullpath);
626
627 return;
628 }
629
630 while (errno = 0, (dirent = readdir(dir)) != NULL)
631 {
632 char *filename = dirent->d_name;
633 char *newfullpath = psprintf("%s/%s", fullpath, filename);
634 char *newrelpath;
635
636 /* Skip "." and ".." */
637 if (filename[0] == '.' && (filename[1] == '\0'
638 || strcmp(filename, "..") == 0))
639 continue;
640
641 if (relpath == NULL)
642 newrelpath = pstrdup(filename);
643 else
644 newrelpath = psprintf("%s/%s", relpath, filename);
645
646 if (!should_ignore_relpath(context, newrelpath))
647 verify_plain_backup_file(context, newrelpath, newfullpath);
648
649 pfree(newfullpath);
650 pfree(newrelpath);
651 }
652
653 if (closedir(dir))
654 {
655 report_backup_error(context,
656 "could not close directory \"%s\": %m", fullpath);
657 return;
658 }
659}
int closedir(DIR *)
Definition: dirent.c:127
struct dirent * readdir(DIR *)
Definition: dirent.c:78
static char * filename
Definition: pg_dumpall.c:119
static void verify_plain_backup_file(verifier_context *context, char *relpath, char *fullpath)
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(), 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 668 of file pg_verifybackup.c.

670{
671 struct stat sb;
672 manifest_file *m;
673
674 if (stat(fullpath, &sb) != 0)
675 {
676 report_backup_error(context,
677 "could not stat file or directory \"%s\": %m",
678 relpath);
679
680 /*
681 * Suppress further errors related to this path name and, if it's a
682 * directory, anything underneath it.
683 */
685
686 return;
687 }
688
689 /* If it's a directory, just recurse. */
690 if (S_ISDIR(sb.st_mode))
691 {
692 verify_plain_backup_directory(context, relpath, fullpath, NULL);
693 return;
694 }
695
696 /* If it's not a directory, it should be a plain file. */
697 if (!S_ISREG(sb.st_mode))
698 {
699 report_backup_error(context,
700 "\"%s\" is not a file or directory",
701 relpath);
702 return;
703 }
704
705 /* Check whether there's an entry in the manifest hash. */
706 m = manifest_files_lookup(context->manifest->files, relpath);
707 if (m == NULL)
708 {
709 report_backup_error(context,
710 "\"%s\" is present on disk but not in the manifest",
711 relpath);
712 return;
713 }
714
715 /* Flag this entry as having been encountered in the filesystem. */
716 m->matched = true;
717
718 /* Check that the size matches. */
719 if (m->size != sb.st_size)
720 {
721 report_backup_error(context,
722 "\"%s\" has size %llu on disk but size %llu in the manifest",
723 relpath, (unsigned long long) sb.st_size,
724 (unsigned long long) m->size);
725 m->bad = true;
726 }
727
728 /*
729 * Validate the manifest system identifier, not available in manifest
730 * version 1.
731 */
732 if (context->manifest->version != 1 &&
733 strcmp(relpath, "global/pg_control") == 0)
735
736 /* Update statistics for progress report, if necessary */
737 if (show_progress && !context->skip_checksums &&
739 total_size += m->size;
740
741 /*
742 * We don't verify checksums at this stage. We first finish verifying that
743 * we have the expected set of files with the expected sizes, and only
744 * afterwards verify the checksums. That's because computing checksums may
745 * take a while, and we'd like to report more obvious problems quickly.
746 */
747}
static void verify_control_file(const char *controlpath, uint64 manifest_system_identifier)
uint64 system_identifier
Definition: load_manifest.h:58
#define S_ISDIR(m)
Definition: win32_port.h:325

References 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::st_mode, stat::st_size, stat, manifest_data::system_identifier, total_size, verify_control_file(), verify_plain_backup_directory(), and manifest_data::version.

Referenced by verify_plain_backup_directory().

◆ verify_tar_backup()

static void verify_tar_backup ( verifier_context context,
DIR dir 
)
static

Definition at line 789 of file pg_verifybackup.c.

790{
791 struct dirent *dirent;
792 SimplePtrList tarfiles = {NULL, NULL};
793 SimplePtrListCell *cell;
794
795 Assert(context->format != 'p');
796
797 progress_report(false);
798
799 /* First pass: scan the directory for tar files. */
800 while (errno = 0, (dirent = readdir(dir)) != NULL)
801 {
802 char *filename = dirent->d_name;
803
804 /* Skip "." and ".." */
805 if (filename[0] == '.' && (filename[1] == '\0'
806 || strcmp(filename, "..") == 0))
807 continue;
808
809 /*
810 * Unless it's something we should ignore, perform prechecks and add
811 * it to the list.
812 */
813 if (!should_ignore_relpath(context, filename))
814 {
815 char *fullpath;
816
817 fullpath = psprintf("%s/%s", context->backup_directory, filename);
818 precheck_tar_backup_file(context, filename, fullpath, &tarfiles);
819 pfree(fullpath);
820 }
821 }
822
823 if (closedir(dir))
824 {
825 report_backup_error(context,
826 "could not close directory \"%s\": %m",
827 context->backup_directory);
828 return;
829 }
830
831 /* Second pass: Perform the final verification of the tar contents. */
832 for (cell = tarfiles.head; cell != NULL; cell = cell->next)
833 {
834 tar_file *tar = (tar_file *) cell->ptr;
835 astreamer *streamer;
836 char *fullpath;
837
838 /*
839 * Prepares the archive streamer stack according to the tar
840 * compression format.
841 */
842 streamer = create_archive_verifier(context,
843 tar->relpath,
844 tar->tblspc_oid,
845 tar->compress_algorithm);
846
847 /* Compute the full pathname to the target file. */
848 fullpath = psprintf("%s/%s", context->backup_directory,
849 tar->relpath);
850
851 /* Invoke the streamer for reading, decompressing, and verifying. */
852 verify_tar_file(context, tar->relpath, fullpath, streamer);
853
854 /* Cleanup. */
855 pfree(tar->relpath);
856 pfree(tar);
857 pfree(fullpath);
858
859 astreamer_finalize(streamer);
860 astreamer_free(streamer);
861 }
862 simple_ptr_list_destroy(&tarfiles);
863
864 progress_report(true);
865}
static void astreamer_free(astreamer *streamer)
Definition: astreamer.h:153
static void astreamer_finalize(astreamer *streamer)
Definition: astreamer.h:145
static void verify_tar_file(verifier_context *context, char *relpath, char *fullpath, astreamer *streamer)
static astreamer * create_archive_verifier(verifier_context *context, char *archive_name, Oid tblspc_oid, pg_compress_algorithm compress_algo)
static void precheck_tar_backup_file(verifier_context *context, char *relpath, char *fullpath, SimplePtrList *tarfiles)
void simple_ptr_list_destroy(SimplePtrList *list)
Definition: simple_list.c:181
struct SimplePtrListCell * next
Definition: simple_list.h:48
SimplePtrListCell * head
Definition: simple_list.h:54

References Assert, astreamer_finalize(), astreamer_free(), verifier_context::backup_directory, closedir(), tar_file::compress_algorithm, create_archive_verifier(), dirent::d_name, filename, verifier_context::format, SimplePtrList::head, SimplePtrListCell::next, pfree(), precheck_tar_backup_file(), progress_report(), psprintf(), SimplePtrListCell::ptr, readdir(), tar_file::relpath, report_backup_error(), should_ignore_relpath(), simple_ptr_list_destroy(), tar_file::tblspc_oid, 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 992 of file pg_verifybackup.c.

994{
995 int fd;
996 int rc;
997 char *buffer;
998
999 pg_log_debug("reading \"%s\"", fullpath);
1000
1001 /* Open the target file. */
1002 if ((fd = open(fullpath, O_RDONLY | PG_BINARY, 0)) < 0)
1003 {
1004 report_backup_error(context, "could not open file \"%s\": %m",
1005 relpath);
1006 return;
1007 }
1008
1009 buffer = pg_malloc(READ_CHUNK_SIZE * sizeof(uint8));
1010
1011 /* Perform the reads */
1012 while ((rc = read(fd, buffer, READ_CHUNK_SIZE)) > 0)
1013 {
1014 astreamer_content(streamer, NULL, buffer, rc, ASTREAMER_UNKNOWN);
1015
1016 /* Report progress */
1017 done_size += rc;
1018 progress_report(false);
1019 }
1020
1021 pg_free(buffer);
1022
1023 if (rc < 0)
1024 report_backup_error(context, "could not read file \"%s\": %m",
1025 relpath);
1026
1027 /* Close the file. */
1028 if (close(fd) != 0)
1029 report_backup_error(context, "could not close file \"%s\": %m",
1030 relpath);
1031}
static void astreamer_content(astreamer *streamer, astreamer_member *member, const char *data, int len, astreamer_archive_context context)
Definition: astreamer.h:135
@ ASTREAMER_UNKNOWN
Definition: astreamer.h:64
void pg_free(void *ptr)
Definition: fe_memutils.c:105

References astreamer_content(), ASTREAMER_UNKNOWN, close, done_size, 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 549 of file pg_verifybackup.c.

553{
555 manifest_files_hash *ht = manifest->files;
556 manifest_file *m;
557 bool found;
558
559 /* Make a new entry in the hash table for this file. */
560 m = manifest_files_insert(ht, pathname, &found);
561 if (found)
562 report_fatal_error("duplicate path name in backup manifest: \"%s\"",
563 pathname);
564
565 /* Initialize the entry. */
566 m->size = size;
567 m->checksum_type = checksum_type;
568 m->checksum_length = checksum_length;
569 m->checksum_payload = checksum_payload;
570 m->matched = false;
571 m->bad = false;
572}
static pg_noinline void Size size
Definition: slab.c:607

References manifest_file::bad, manifest_file::checksum_length, manifest_file::checksum_payload, manifest_file::checksum_type, manifest, manifest_file::matched, JsonManifestParseContext::private_data, report_fatal_error(), size, 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 578 of file pg_verifybackup.c.

581{
584
585 /* Allocate and initialize a struct describing this WAL range. */
587 range->tli = tli;
588 range->start_lsn = start_lsn;
589 range->end_lsn = end_lsn;
590 range->prev = manifest->last_wal_range;
591 range->next = NULL;
592
593 /* Add it to the end of the list. */
594 if (manifest->first_wal_range == NULL)
595 manifest->first_wal_range = range;
596 else
597 manifest->last_wal_range->next = range;
598 manifest->last_wal_range = range;
599}
void * palloc(Size size)
Definition: mcxt.c:1317
static struct cvec * range(struct vars *v, chr a, chr b, int cases)
Definition: regc_locale.c:412

References manifest, palloc(), 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 536 of file pg_verifybackup.c.

538{
540
541 /* Validation will be at the later stage */
542 manifest->system_identifier = manifest_system_identifier;
543}

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 523 of file pg_verifybackup.c.

525{
527
528 /* Validation will be at the later stage */
529 manifest->version = manifest_version;
530}

References manifest, and JsonManifestParseContext::private_data.

Referenced by parse_manifest_file().

Variable Documentation

◆ done_size

uint64 done_size = 0
static

Definition at line 111 of file pg_verifybackup.c.

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

◆ progname

const char* progname
static

Definition at line 104 of file pg_verifybackup.c.

Referenced by main(), and usage().

◆ show_progress

bool show_progress = false
static

◆ total_size

uint64 total_size = 0
static