pg_backup_utils.h File Reference

#include "common/logging.h"

Include dependency graph for pg_backup_utils.h:

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

Go to the source code of this file.

Macros
#define	DUMP_PRE_DATA   0x01
#define	DUMP_DATA   0x02
#define	DUMP_POST_DATA   0x04
#define	DUMP_UNSECTIONED   0xff
#define	is_cancel_in_progress()   false
#define	pg_fatal(...)

Typedefs
typedef void(*	on_exit_nicely_callback) (int code, void *arg)

Functions
void	set_dump_section (const char *arg, int *dumpSections)
void	on_exit_nicely (on_exit_nicely_callback function, void *arg)
pg_noreturn void	exit_nicely (int code)

Variables
const char *	progname

Macro Definition Documentation

DUMP_DATA

#define DUMP_DATA   0x02

Definition at line 22 of file pg_backup_utils.h.

DUMP_POST_DATA

#define DUMP_POST_DATA   0x04

Definition at line 23 of file pg_backup_utils.h.

DUMP_PRE_DATA

#define DUMP_PRE_DATA   0x01

Definition at line 21 of file pg_backup_utils.h.

DUMP_UNSECTIONED

#define DUMP_UNSECTIONED   0xff

Definition at line 24 of file pg_backup_utils.h.

is_cancel_in_progress

#define is_cancel_in_progress

(

)

false

Definition at line 52 of file pg_backup_utils.h.

pg_fatal

#define pg_fatal

(

...

)

Value:

        do { \
		pg_log_generic(PG_LOG_ERROR, PG_LOG_PRIMARY, __VA_ARGS__); \
		exit_nicely(1); \
    } while(0)

Definition at line 57 of file pg_backup_utils.h.

                         { \
		pg_log_generic(PG_LOG_ERROR, PG_LOG_PRIMARY, __VA_ARGS__); \
		exit_nicely(1); \
    } while(0)

Typedef Documentation

on_exit_nicely_callback

typedef void(* on_exit_nicely_callback) (int code, void *arg)

Definition at line 26 of file pg_backup_utils.h.

Function Documentation

exit_nicely()

pg_noreturn void exit_nicely ( int  code )

extern

Definition at line 130 of file pg_backup_utils.c.

{
    int         i;
 
    for (i = on_exit_nicely_index - 1; i >= 0; i--)
        on_exit_nicely_list[i].function(code,
                                        on_exit_nicely_list[i].arg);
 
#ifdef WIN32
    if (parallel_init_done && GetCurrentThreadId() != mainThreadId)
        _endthreadex(code);
#endif
 
    exit(code);
}

References arg, fb(), function, i, on_exit_nicely_index, and on_exit_nicely_list.

Referenced by ConnectDatabase(), die_on_query_failure(), dumpRoleGUCPrivs(), dumpRoleMembership(), dumpTableData_copy(), dumpTablespaces(), EndDBCopyMode(), executeCommand(), executeQuery(), ExecuteSqlCommandBuf(), expand_dbname_patterns(), getTableAttrs(), main(), main(), read_dump_filters(), read_dumpall_filters(), read_restore_filters(), set_dump_section(), and warn_or_exit_horribly().

on_exit_nicely()

void on_exit_nicely ( on_exit_nicely_callback  function, void *  arg  )

extern

Definition at line 103 of file pg_backup_utils.c.

{
    if (on_exit_nicely_index >= MAX_ON_EXIT_NICELY)
        pg_fatal("out of on_exit_nicely slots");
    on_exit_nicely_list[on_exit_nicely_index].function = function;
    on_exit_nicely_list[on_exit_nicely_index].arg = arg;
    on_exit_nicely_index++;
}

References arg, function, MAX_ON_EXIT_NICELY, on_exit_nicely_index, on_exit_nicely_list, and pg_fatal.

Referenced by on_exit_close_archive().

set_dump_section()

void set_dump_section ( const char *  arg, int *  dumpSections  )

extern

Definition at line 80 of file pg_backup_utils.c.

{
    /* if this is the first call, clear all the bits */
    if (*dumpSections == DUMP_UNSECTIONED)
        *dumpSections = 0;
 
    if (strcmp(arg, "pre-data") == 0)
        *dumpSections |= DUMP_PRE_DATA;
    else if (strcmp(arg, "data") == 0)
        *dumpSections |= DUMP_DATA;
    else if (strcmp(arg, "post-data") == 0)
        *dumpSections |= DUMP_POST_DATA;
    else
    {
        pg_log_error("unrecognized section name: \"%s\"", arg);
        pg_log_error_hint("Try \"%s --help\" for more information.", progname);
        exit_nicely(1);
    }
}

References arg, DUMP_DATA, DUMP_POST_DATA, DUMP_PRE_DATA, DUMP_UNSECTIONED, exit_nicely(), fb(), pg_log_error, pg_log_error_hint, and progname.

Referenced by main().

Variable Documentation

progname

const char* progname

extern

Definition at line 44 of file main.c.