pg_verifybackup.h File Reference

#include "common/controldata_utils.h"
#include "common/hashfn_unstable.h"
#include "common/logging.h"
#include "common/parse_manifest.h"
#include "fe_utils/astreamer.h"
#include "fe_utils/simple_list.h"
#include "lib/simplehash.h"

Include dependency graph for pg_verifybackup.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	manifest_file
struct	manifest_wal_range
struct	manifest_data
struct	verifier_context

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

Typedefs
typedef struct manifest_file	manifest_file
typedef struct manifest_wal_range	manifest_wal_range
typedef struct manifest_data	manifest_data
typedef struct verifier_context	verifier_context

Functions
void	report_backup_error (verifier_context *context, const char *pg_restrict fmt,...) pg_attribute_printf(2
void pg_noreturn void	report_fatal_error (const char *pg_restrict fmt,...) pg_attribute_printf(1
void pg_noreturn void bool	should_ignore_relpath (verifier_context *context, const char *relpath)
astreamer *	astreamer_verify_content_new (astreamer *next, verifier_context *context, char *archive_name, Oid tblspc_oid)

Macro Definition Documentation

SH_DECLARE

#define SH_DECLARE

Definition at line 55 of file pg_verifybackup.h.

SH_DEFINE

#define SH_DEFINE

Definition at line 56 of file pg_verifybackup.h.

SH_ELEMENT_TYPE

#define SH_ELEMENT_TYPE   manifest_file

Definition at line 48 of file pg_verifybackup.h.

SH_EQUAL

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

Definition at line 52 of file pg_verifybackup.h.

SH_HASH_KEY

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

Definition at line 51 of file pg_verifybackup.h.

SH_KEY

#define SH_KEY   pathname

Definition at line 50 of file pg_verifybackup.h.

SH_KEY_TYPE

#define SH_KEY_TYPE   const char *

Definition at line 49 of file pg_verifybackup.h.

SH_PREFIX

#define SH_PREFIX   manifest_files

Definition at line 47 of file pg_verifybackup.h.

SH_RAW_ALLOCATOR

#define SH_RAW_ALLOCATOR   pg_malloc0

Definition at line 54 of file pg_verifybackup.h.

SH_SCOPE

#define SH_SCOPE   static inline

Definition at line 53 of file pg_verifybackup.h.

should_verify_checksum

#define should_verify_checksum

(

m

)

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

Definition at line 40 of file pg_verifybackup.h.

{
    TimeLineID  tli;
    XLogRecPtr  start_lsn;
    XLogRecPtr  end_lsn;
    struct manifest_wal_range *next;
    struct manifest_wal_range *prev;
} manifest_wal_range;
 
/*
 * All the data parsed from a backup_manifest file.
 */
typedef struct manifest_data
{
    int         version;
    uint64      system_identifier;
    manifest_files_hash *files;
    manifest_wal_range *first_wal_range;
    manifest_wal_range *last_wal_range;
} manifest_data;
 
/*
 * All of the context information we need while checking a backup manifest.
 */
typedef struct verifier_context
{
    manifest_data *manifest;
    char       *backup_directory;
    SimpleStringList ignore_list;
    char        format;         /* backup format:  p(lain)/t(ar) */
    bool        skip_checksums;
    bool        exit_on_error;
    bool        saw_any_error;
} verifier_context;
 
extern void report_backup_error(verifier_context *context,
                                const char *pg_restrict fmt,...)
            pg_attribute_printf(2, 3);
pg_noreturn extern void report_fatal_error(const char *pg_restrict fmt,...)
            pg_attribute_printf(1, 2);
extern bool should_ignore_relpath(verifier_context *context,
                                  const char *relpath);
 
extern astreamer *astreamer_verify_content_new(astreamer *next,
                                               verifier_context *context,
                                               char *archive_name,
                                               Oid tblspc_oid);
 
#endif                          /* PG_VERIFYBACKUP_H */

Typedef Documentation

manifest_data

typedef struct manifest_data manifest_data

manifest_file

typedef struct manifest_file manifest_file

manifest_wal_range

typedef struct manifest_wal_range manifest_wal_range

verifier_context

typedef struct verifier_context verifier_context

Function Documentation

astreamer_verify_content_new()

astreamer * astreamer_verify_content_new ( astreamer *  next, verifier_context *  context, char *  archive_name, Oid  tblspc_oid  )

extern

Definition at line 67 of file astreamer_verify.c.

{
    astreamer_verify *streamer;
 
    streamer = palloc0_object(astreamer_verify);
    *((const astreamer_ops **) &streamer->base.bbs_ops) =
        &astreamer_verify_ops;
 
    streamer->base.bbs_next = next;
    streamer->context = context;
    streamer->archive_name = archive_name;
    streamer->tblspc_oid = tblspc_oid;
 
    if (!context->skip_checksums)
        streamer->checksum_ctx = pg_malloc(sizeof(pg_checksum_context));
 
    return &streamer->base;
}

References astreamer_verify::archive_name, astreamer_verify_ops, astreamer_verify::base, astreamer::bbs_next, astreamer::bbs_ops, astreamer_verify::checksum_ctx, astreamer_verify::context, next, palloc0_object, pg_malloc(), verifier_context::skip_checksums, and astreamer_verify::tblspc_oid.

Referenced by create_archive_verifier().

report_backup_error()

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

extern

report_fatal_error()

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

extern

should_ignore_relpath()

void pg_noreturn void bool should_ignore_relpath ( verifier_context *  context, const char *  relpath  )

extern

Definition at line 1267 of file pg_verifybackup.c.

{
    SimpleStringListCell *cell;
 
    for (cell = context->ignore_list.head; cell != NULL; cell = cell->next)
    {
        const char *r = relpath;
        char       *v = cell->val;
 
        while (*v != '\0' && *r == *v)
            ++r, ++v;
 
        if (*v == '\0' && (*r == '\0' || *r == '/'))
            return true;
    }
 
    return false;
}

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