PostgreSQL Source Code  git master
pg_backup_archiver.h File Reference
#include <time.h>
#include "pg_backup.h"
#include "libpq-fe.h"
#include "pqexpbuffer.h"
Include dependency graph for pg_backup_archiver.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _z_stream
 
struct  sqlparseInfo
 
struct  _archiveHandle
 
struct  _tocEntry
 

Macros

#define LOBBUFSIZE   16384
 
#define GZCLOSE(fh)   fclose(fh)
 
#define GZWRITE(p, s, n, fh)   (fwrite(p, s, n, fh) * (s))
 
#define GZREAD(p, s, n, fh)   fread(p, s, n, fh)
 
#define GZEOF(fh)   feof(fh)
 
#define Z_DEFAULT_COMPRESSION   (-1)
 
#define BLK_DATA   1
 
#define BLK_BLOBS   3
 
#define MAKE_ARCHIVE_VERSION(major, minor, rev)   (((major) * 256 + (minor)) * 256 + (rev))
 
#define ARCHIVE_MAJOR(version)   (((version) >> 16) & 255)
 
#define ARCHIVE_MINOR(version)   (((version) >> 8) & 255)
 
#define ARCHIVE_REV(version)   (((version) ) & 255)
 
#define K_VERS_1_0   MAKE_ARCHIVE_VERSION(1, 0, 0)
 
#define K_VERS_1_2   MAKE_ARCHIVE_VERSION(1, 2, 0) /* Allow No ZLIB */
 
#define K_VERS_1_3   MAKE_ARCHIVE_VERSION(1, 3, 0) /* BLOBs */
 
#define K_VERS_1_4   MAKE_ARCHIVE_VERSION(1, 4, 0) /* Date & name in header */
 
#define K_VERS_1_5   MAKE_ARCHIVE_VERSION(1, 5, 0) /* Handle dependencies */
 
#define K_VERS_1_6   MAKE_ARCHIVE_VERSION(1, 6, 0) /* Schema field in TOCs */
 
#define K_VERS_1_7
 
#define K_VERS_1_8
 
#define K_VERS_1_9
 
#define K_VERS_1_10   MAKE_ARCHIVE_VERSION(1, 10, 0) /* add tablespace */
 
#define K_VERS_1_11
 
#define K_VERS_1_12
 
#define K_VERS_MAJOR   1
 
#define K_VERS_MINOR   12
 
#define K_VERS_REV   0
 
#define K_VERS_SELF   MAKE_ARCHIVE_VERSION(K_VERS_MAJOR, K_VERS_MINOR, K_VERS_REV);
 
#define K_VERS_MAX   MAKE_ARCHIVE_VERSION(K_VERS_MAJOR, K_VERS_MINOR, 255)
 
#define K_OFFSET_POS_NOT_SET   1
 
#define K_OFFSET_POS_SET   2
 
#define K_OFFSET_NO_DATA   3
 
#define WORKER_OK   0
 
#define WORKER_CREATE_DONE   10
 
#define WORKER_INHIBIT_DATA   11
 
#define WORKER_IGNORED_ERRORS   12
 
#define READ_ERROR_EXIT(fd)
 
#define WRITE_ERROR_EXIT
 
#define RESTORE_PASS_LAST   RESTORE_PASS_REFRESH
 
#define appendStringLiteralAHX(buf, str, AH)   appendStringLiteral(buf, str, (AH)->public.encoding, (AH)->public.std_strings)
 
#define appendByteaLiteralAHX(buf, str, len, AH)   appendByteaLiteral(buf, str, len, (AH)->public.std_strings)
 

Typedefs

typedef struct _z_stream z_stream
 
typedef z_streamz_streamp
 
typedef struct _archiveHandle ArchiveHandle
 
typedef struct _tocEntry TocEntry
 
typedef enum T_Action T_Action
 
typedef void(* ClosePtrType) (ArchiveHandle *AH)
 
typedef void(* ReopenPtrType) (ArchiveHandle *AH)
 
typedef void(* ArchiveEntryPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef void(* StartDataPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef void(* WriteDataPtrType) (ArchiveHandle *AH, const void *data, size_t dLen)
 
typedef void(* EndDataPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef void(* StartBlobsPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef void(* StartBlobPtrType) (ArchiveHandle *AH, TocEntry *te, Oid oid)
 
typedef void(* EndBlobPtrType) (ArchiveHandle *AH, TocEntry *te, Oid oid)
 
typedef void(* EndBlobsPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef int(* WriteBytePtrType) (ArchiveHandle *AH, const int i)
 
typedef int(* ReadBytePtrType) (ArchiveHandle *AH)
 
typedef void(* WriteBufPtrType) (ArchiveHandle *AH, const void *c, size_t len)
 
typedef void(* ReadBufPtrType) (ArchiveHandle *AH, void *buf, size_t len)
 
typedef void(* SaveArchivePtrType) (ArchiveHandle *AH)
 
typedef void(* WriteExtraTocPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef void(* ReadExtraTocPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef void(* PrintExtraTocPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef void(* PrintTocDataPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef void(* ClonePtrType) (ArchiveHandle *AH)
 
typedef void(* DeClonePtrType) (ArchiveHandle *AH)
 
typedef int(* WorkerJobDumpPtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef int(* WorkerJobRestorePtrType) (ArchiveHandle *AH, TocEntry *te)
 
typedef size_t(* CustomOutPtrType) (ArchiveHandle *AH, const void *buf, size_t len)
 

Enumerations

enum  T_Action { ACT_DUMP, ACT_RESTORE }
 
enum  sqlparseState { SQL_SCAN = 0, SQL_IN_SINGLE_QUOTE, SQL_IN_DOUBLE_QUOTE }
 
enum  ArchiverStage { STAGE_NONE = 0, STAGE_INITIALIZING, STAGE_PROCESSING, STAGE_FINALIZING }
 
enum  ArchiverOutput { OUTPUT_SQLCMDS = 0, OUTPUT_COPYDATA, OUTPUT_OTHERDATA }
 
enum  RestorePass { RESTORE_PASS_MAIN = 0, RESTORE_PASS_ACL }
 
enum  teReqs { REQ_SCHEMA = 0x01, REQ_DATA = 0x02, REQ_SPECIAL = 0x04 }
 

Functions

int parallel_restore (ArchiveHandle *AH, TocEntry *te)
 
void on_exit_close_archive (Archive *AHX)
 
void warn_or_exit_horribly (ArchiveHandle *AH, const char *modulename, const char *fmt,...) pg_attribute_printf(3
 
void void WriteTOC (ArchiveHandle *AH)
 
void ReadTOC (ArchiveHandle *AH)
 
void WriteHead (ArchiveHandle *AH)
 
void ReadHead (ArchiveHandle *AH)
 
void WriteToc (ArchiveHandle *AH)
 
void ReadToc (ArchiveHandle *AH)
 
void WriteDataChunks (ArchiveHandle *AH, struct ParallelState *pstate)
 
void WriteDataChunksForTocEntry (ArchiveHandle *AH, TocEntry *te)
 
ArchiveHandleCloneArchive (ArchiveHandle *AH)
 
void DeCloneArchive (ArchiveHandle *AH)
 
teReqs TocIDRequired (ArchiveHandle *AH, DumpId id)
 
TocEntrygetTocEntryByDumpId (ArchiveHandle *AH, DumpId id)
 
bool checkSeek (FILE *fp)
 
size_t WriteInt (ArchiveHandle *AH, int i)
 
int ReadInt (ArchiveHandle *AH)
 
char * ReadStr (ArchiveHandle *AH)
 
size_t WriteStr (ArchiveHandle *AH, const char *s)
 
int ReadOffset (ArchiveHandle *, pgoff_t *)
 
size_t WriteOffset (ArchiveHandle *, pgoff_t, int)
 
void StartRestoreBlobs (ArchiveHandle *AH)
 
void StartRestoreBlob (ArchiveHandle *AH, Oid oid, bool drop)
 
void EndRestoreBlob (ArchiveHandle *AH, Oid oid)
 
void EndRestoreBlobs (ArchiveHandle *AH)
 
void InitArchiveFmt_Custom (ArchiveHandle *AH)
 
void InitArchiveFmt_Null (ArchiveHandle *AH)
 
void InitArchiveFmt_Directory (ArchiveHandle *AH)
 
void InitArchiveFmt_Tar (ArchiveHandle *AH)
 
bool isValidTarHeader (char *header)
 
void ReconnectToServer (ArchiveHandle *AH, const char *dbname, const char *newUser)
 
void DropBlobIfExists (ArchiveHandle *AH, Oid oid)
 
void ahwrite (const void *ptr, size_t size, size_t nmemb, ArchiveHandle *AH)
 
int ahprintf (ArchiveHandle *AH, const char *fmt,...) pg_attribute_printf(2
 
int void ahlog (ArchiveHandle *AH, int level, const char *fmt,...) pg_attribute_printf(3
 

Macro Definition Documentation

◆ appendByteaLiteralAHX

#define appendByteaLiteralAHX (   buf,
  str,
  len,
  AH 
)    appendByteaLiteral(buf, str, len, (AH)->public.std_strings)

Definition at line 424 of file pg_backup_archiver.h.

Referenced by _WriteBlobData(), and dump_lo_buf().

◆ appendStringLiteralAHX

#define appendStringLiteralAHX (   buf,
  str,
  AH 
)    appendStringLiteral(buf, str, (AH)->public.encoding, (AH)->public.std_strings)

Definition at line 421 of file pg_backup_archiver.h.

Referenced by _doSetSessionAuth().

◆ ARCHIVE_MAJOR

#define ARCHIVE_MAJOR (   version)    (((version) >> 16) & 255)

Definition at line 72 of file pg_backup_archiver.h.

Referenced by PrintTOCSummary(), and WriteHead().

◆ ARCHIVE_MINOR

#define ARCHIVE_MINOR (   version)    (((version) >> 8) & 255)

Definition at line 73 of file pg_backup_archiver.h.

Referenced by PrintTOCSummary(), and WriteHead().

◆ ARCHIVE_REV

#define ARCHIVE_REV (   version)    (((version) ) & 255)

Definition at line 74 of file pg_backup_archiver.h.

Referenced by PrintTOCSummary(), and WriteHead().

◆ BLK_BLOBS

#define BLK_BLOBS   3

Definition at line 67 of file pg_backup_archiver.h.

Referenced by _PrintTocData(), and _StartBlobs().

◆ BLK_DATA

#define BLK_DATA   1

Definition at line 66 of file pg_backup_archiver.h.

Referenced by _PrintTocData(), _readBlockHeader(), and _StartData().

◆ GZCLOSE

#define GZCLOSE (   fh)    fclose(fh)

Definition at line 48 of file pg_backup_archiver.h.

Referenced by CloseArchive(), RestoreOutput(), and tarClose().

◆ GZEOF

#define GZEOF (   fh)    feof(fh)

Definition at line 51 of file pg_backup_archiver.h.

Referenced by _tarReadRaw().

◆ GZREAD

#define GZREAD (   p,
  s,
  n,
  fh 
)    fread(p, s, n, fh)

Definition at line 50 of file pg_backup_archiver.h.

Referenced by _tarReadRaw().

◆ GZWRITE

#define GZWRITE (   p,
  s,
  n,
  fh 
)    (fwrite(p, s, n, fh) * (s))

Definition at line 49 of file pg_backup_archiver.h.

Referenced by ahwrite(), and tarWrite().

◆ K_OFFSET_NO_DATA

#define K_OFFSET_NO_DATA   3

Definition at line 109 of file pg_backup_archiver.h.

Referenced by _ArchiveEntry(), _PrintTocData(), and ReadOffset().

◆ K_OFFSET_POS_NOT_SET

#define K_OFFSET_POS_NOT_SET   1

Definition at line 107 of file pg_backup_archiver.h.

Referenced by _ArchiveEntry(), _PrintTocData(), and ReadOffset().

◆ K_OFFSET_POS_SET

#define K_OFFSET_POS_SET   2

Definition at line 108 of file pg_backup_archiver.h.

Referenced by _StartBlobs(), _StartData(), and ReadOffset().

◆ K_VERS_1_0

#define K_VERS_1_0   MAKE_ARCHIVE_VERSION(1, 0, 0)

Definition at line 77 of file pg_backup_archiver.h.

Referenced by ReadHead(), and ReadInt().

◆ K_VERS_1_10

#define K_VERS_1_10   MAKE_ARCHIVE_VERSION(1, 10, 0) /* add tablespace */

Definition at line 90 of file pg_backup_archiver.h.

Referenced by ReadHead(), and ReadToc().

◆ K_VERS_1_11

#define K_VERS_1_11
Value:
MAKE_ARCHIVE_VERSION(1, 11, 0) /* add toc section
* indicator */
#define MAKE_ARCHIVE_VERSION(major, minor, rev)

Definition at line 91 of file pg_backup_archiver.h.

Referenced by fix_dependencies(), and ReadToc().

◆ K_VERS_1_12

#define K_VERS_1_12
Value:
MAKE_ARCHIVE_VERSION(1, 12, 0) /* add separate BLOB
* entries */
#define MAKE_ARCHIVE_VERSION(major, minor, rev)

Definition at line 93 of file pg_backup_archiver.h.

Referenced by _StartBlob(), and StartRestoreBlob().

◆ K_VERS_1_2

#define K_VERS_1_2   MAKE_ARCHIVE_VERSION(1, 2, 0) /* Allow No ZLIB */

Definition at line 78 of file pg_backup_archiver.h.

Referenced by ReadHead().

◆ K_VERS_1_3

#define K_VERS_1_3   MAKE_ARCHIVE_VERSION(1, 3, 0) /* BLOBs */

Definition at line 79 of file pg_backup_archiver.h.

Referenced by _readBlockHeader(), ReadToc(), and RestoreArchive().

◆ K_VERS_1_4

#define K_VERS_1_4   MAKE_ARCHIVE_VERSION(1, 4, 0) /* Date & name in header */

Definition at line 80 of file pg_backup_archiver.h.

Referenced by ReadHead().

◆ K_VERS_1_5

#define K_VERS_1_5   MAKE_ARCHIVE_VERSION(1, 5, 0) /* Handle dependencies */

Definition at line 81 of file pg_backup_archiver.h.

Referenced by ReadToc().

◆ K_VERS_1_6

#define K_VERS_1_6   MAKE_ARCHIVE_VERSION(1, 6, 0) /* Schema field in TOCs */

Definition at line 82 of file pg_backup_archiver.h.

Referenced by ReadToc().

◆ K_VERS_1_7

#define K_VERS_1_7
Value:
MAKE_ARCHIVE_VERSION(1, 7, 0) /* File Offset size in
* header */
#define MAKE_ARCHIVE_VERSION(major, minor, rev)

Definition at line 83 of file pg_backup_archiver.h.

Referenced by _discoverArchiveFormat(), _ReadExtraToc(), ReadHead(), and ReadOffset().

◆ K_VERS_1_8

#define K_VERS_1_8
Value:
MAKE_ARCHIVE_VERSION(1, 8, 0) /* change interpretation
* of ID numbers and
* dependencies */
#define MAKE_ARCHIVE_VERSION(major, minor, rev)

Definition at line 85 of file pg_backup_archiver.h.

Referenced by ReadToc(), and RestoreArchive().

◆ K_VERS_1_9

#define K_VERS_1_9
Value:
MAKE_ARCHIVE_VERSION(1, 9, 0) /* add default_with_oids
* tracking */
#define MAKE_ARCHIVE_VERSION(major, minor, rev)

Definition at line 88 of file pg_backup_archiver.h.

Referenced by ReadToc().

◆ K_VERS_MAJOR

#define K_VERS_MAJOR   1

Definition at line 97 of file pg_backup_archiver.h.

◆ K_VERS_MAX

#define K_VERS_MAX   MAKE_ARCHIVE_VERSION(K_VERS_MAJOR, K_VERS_MINOR, 255)

Definition at line 103 of file pg_backup_archiver.h.

Referenced by ReadHead().

◆ K_VERS_MINOR

#define K_VERS_MINOR   12

Definition at line 98 of file pg_backup_archiver.h.

◆ K_VERS_REV

#define K_VERS_REV   0

Definition at line 99 of file pg_backup_archiver.h.

◆ K_VERS_SELF

Definition at line 100 of file pg_backup_archiver.h.

Referenced by _allocAH().

◆ LOBBUFSIZE

#define LOBBUFSIZE   16384

◆ MAKE_ARCHIVE_VERSION

#define MAKE_ARCHIVE_VERSION (   major,
  minor,
  rev 
)    (((major) * 256 + (minor)) * 256 + (rev))

Definition at line 70 of file pg_backup_archiver.h.

Referenced by _discoverArchiveFormat(), and ReadHead().

◆ READ_ERROR_EXIT

#define READ_ERROR_EXIT (   fd)
Value:
do { \
if (feof(fd)) \
exit_horribly(modulename, \
"could not read from input file: end of file\n"); \
"could not read from input file: %s\n", strerror(errno)); \
} while (0)
static const char * modulename
Definition: compress_io.c:78
static int fd(const char *x, int i)
Definition: preproc-init.c:105
void exit_horribly(const char *modulename, const char *fmt,...)
const char * strerror(int errnum)
Definition: strerror.c:19

Definition at line 124 of file pg_backup_archiver.h.

Referenced by _discoverArchiveFormat(), _ReadBuf(), _ReadByte(), _tarAddFile(), _tarReadRaw(), cfgetc(), and cfread().

◆ RESTORE_PASS_LAST

#define RESTORE_PASS_LAST   RESTORE_PASS_REFRESH

Definition at line 227 of file pg_backup_archiver.h.

Referenced by restore_toc_entries_parallel().

◆ WORKER_CREATE_DONE

#define WORKER_CREATE_DONE   10

Definition at line 116 of file pg_backup_archiver.h.

Referenced by mark_restore_job_done(), and restore_toc_entry().

◆ WORKER_IGNORED_ERRORS

#define WORKER_IGNORED_ERRORS   12

◆ WORKER_INHIBIT_DATA

#define WORKER_INHIBIT_DATA   11

Definition at line 117 of file pg_backup_archiver.h.

Referenced by mark_restore_job_done(), and restore_toc_entry().

◆ WORKER_OK

#define WORKER_OK   0

Definition at line 115 of file pg_backup_archiver.h.

Referenced by restore_toc_entry().

◆ WRITE_ERROR_EXIT

#define WRITE_ERROR_EXIT
Value:
do { \
exit_horribly(modulename, "could not write to output file: %s\n", \
strerror(errno)); \
} while (0)
static const char * modulename
Definition: compress_io.c:78
const char * strerror(int errnum)
Definition: strerror.c:19

Definition at line 134 of file pg_backup_archiver.h.

Referenced by _CloseArchive(), _tarAddFile(), _tarWriteHeader(), _WriteBuf(), _WriteByte(), _WriteData(), and ahwrite().

◆ Z_DEFAULT_COMPRESSION

#define Z_DEFAULT_COMPRESSION   (-1)

Definition at line 53 of file pg_backup_archiver.h.

Referenced by cfopen(), main(), ParseCompressionOption(), and ReadHead().

Typedef Documentation

◆ ArchiveEntryPtrType

typedef void(* ArchiveEntryPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 148 of file pg_backup_archiver.h.

◆ ArchiveHandle

Definition at line 120 of file pg_backup_archiver.h.

◆ ClonePtrType

typedef void(* ClonePtrType) (ArchiveHandle *AH)

Definition at line 169 of file pg_backup_archiver.h.

◆ ClosePtrType

typedef void(* ClosePtrType) (ArchiveHandle *AH)

Definition at line 146 of file pg_backup_archiver.h.

◆ CustomOutPtrType

typedef size_t(* CustomOutPtrType) (ArchiveHandle *AH, const void *buf, size_t len)

Definition at line 175 of file pg_backup_archiver.h.

◆ DeClonePtrType

typedef void(* DeClonePtrType) (ArchiveHandle *AH)

Definition at line 170 of file pg_backup_archiver.h.

◆ EndBlobPtrType

typedef void(* EndBlobPtrType) (ArchiveHandle *AH, TocEntry *te, Oid oid)

Definition at line 156 of file pg_backup_archiver.h.

◆ EndBlobsPtrType

typedef void(* EndBlobsPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 157 of file pg_backup_archiver.h.

◆ EndDataPtrType

typedef void(* EndDataPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 152 of file pg_backup_archiver.h.

◆ PrintExtraTocPtrType

typedef void(* PrintExtraTocPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 166 of file pg_backup_archiver.h.

◆ PrintTocDataPtrType

typedef void(* PrintTocDataPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 167 of file pg_backup_archiver.h.

◆ ReadBufPtrType

typedef void(* ReadBufPtrType) (ArchiveHandle *AH, void *buf, size_t len)

Definition at line 162 of file pg_backup_archiver.h.

◆ ReadBytePtrType

typedef int(* ReadBytePtrType) (ArchiveHandle *AH)

Definition at line 160 of file pg_backup_archiver.h.

◆ ReadExtraTocPtrType

typedef void(* ReadExtraTocPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 165 of file pg_backup_archiver.h.

◆ ReopenPtrType

typedef void(* ReopenPtrType) (ArchiveHandle *AH)

Definition at line 147 of file pg_backup_archiver.h.

◆ SaveArchivePtrType

typedef void(* SaveArchivePtrType) (ArchiveHandle *AH)

Definition at line 163 of file pg_backup_archiver.h.

◆ StartBlobPtrType

typedef void(* StartBlobPtrType) (ArchiveHandle *AH, TocEntry *te, Oid oid)

Definition at line 155 of file pg_backup_archiver.h.

◆ StartBlobsPtrType

typedef void(* StartBlobsPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 154 of file pg_backup_archiver.h.

◆ StartDataPtrType

typedef void(* StartDataPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 150 of file pg_backup_archiver.h.

◆ T_Action

◆ TocEntry

Definition at line 121 of file pg_backup_archiver.h.

◆ WorkerJobDumpPtrType

typedef int(* WorkerJobDumpPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 172 of file pg_backup_archiver.h.

◆ WorkerJobRestorePtrType

typedef int(* WorkerJobRestorePtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 173 of file pg_backup_archiver.h.

◆ WriteBufPtrType

typedef void(* WriteBufPtrType) (ArchiveHandle *AH, const void *c, size_t len)

Definition at line 161 of file pg_backup_archiver.h.

◆ WriteBytePtrType

typedef int(* WriteBytePtrType) (ArchiveHandle *AH, const int i)

Definition at line 159 of file pg_backup_archiver.h.

◆ WriteDataPtrType

typedef void(* WriteDataPtrType) (ArchiveHandle *AH, const void *data, size_t dLen)

Definition at line 151 of file pg_backup_archiver.h.

◆ WriteExtraTocPtrType

typedef void(* WriteExtraTocPtrType) (ArchiveHandle *AH, TocEntry *te)

Definition at line 164 of file pg_backup_archiver.h.

◆ z_stream

◆ z_streamp

Definition at line 62 of file pg_backup_archiver.h.

Enumeration Type Documentation

◆ ArchiverOutput

Enumerator
OUTPUT_SQLCMDS 
OUTPUT_COPYDATA 
OUTPUT_OTHERDATA 

Definition at line 199 of file pg_backup_archiver.h.

200 {
201  OUTPUT_SQLCMDS = 0, /* emitting general SQL commands */
202  OUTPUT_COPYDATA, /* writing COPY data */
203  OUTPUT_OTHERDATA /* writing data as INSERT commands */
ArchiverOutput

◆ ArchiverStage

Enumerator
STAGE_NONE 
STAGE_INITIALIZING 
STAGE_PROCESSING 
STAGE_FINALIZING 

Definition at line 191 of file pg_backup_archiver.h.

◆ RestorePass

Enumerator
RESTORE_PASS_MAIN 
RESTORE_PASS_ACL 

Definition at line 221 of file pg_backup_archiver.h.

222 {
223  RESTORE_PASS_MAIN = 0, /* Main pass (most TOC item types) */
224  RESTORE_PASS_ACL, /* ACL item types */
225  RESTORE_PASS_REFRESH /* Matview REFRESH items */
226 
227 #define RESTORE_PASS_LAST RESTORE_PASS_REFRESH
228 } RestorePass;

◆ sqlparseState

Enumerator
SQL_SCAN 
SQL_IN_SINGLE_QUOTE 
SQL_IN_DOUBLE_QUOTE 

Definition at line 177 of file pg_backup_archiver.h.

178 {
179  SQL_SCAN = 0, /* normal */
180  SQL_IN_SINGLE_QUOTE, /* '...' literal */
181  SQL_IN_DOUBLE_QUOTE /* "..." identifier */
182 } sqlparseState;
sqlparseState

◆ T_Action

enum T_Action
Enumerator
ACT_DUMP 
ACT_RESTORE 

Definition at line 140 of file pg_backup_archiver.h.

◆ teReqs

enum teReqs
Enumerator
REQ_SCHEMA 
REQ_DATA 
REQ_SPECIAL 

Definition at line 230 of file pg_backup_archiver.h.

231 {
232  REQ_SCHEMA = 0x01, /* want schema */
233  REQ_DATA = 0x02, /* want data */
234  REQ_SPECIAL = 0x04 /* for special TOC entries */
235 } teReqs;

Function Documentation

◆ ahlog()

int void ahlog ( ArchiveHandle AH,
int  level,
const char *  fmt,
  ... 
)

◆ ahprintf()

int ahprintf ( ArchiveHandle AH,
const char *  fmt,
  ... 
)

◆ ahwrite()

void ahwrite ( const void *  ptr,
size_t  size,
size_t  nmemb,
ArchiveHandle AH 
)

Definition at line 1710 of file pg_backup_archiver.c.

References _archiveHandle::CustomOutPtr, dump_lo_buf(), ExecuteSqlCommandBuf(), _archiveHandle::gzOut, GZWRITE, _archiveHandle::lo_buf, _archiveHandle::lo_buf_size, _archiveHandle::lo_buf_used, _archiveHandle::OF, _archiveHandle::public, remaining, RestoringToDB(), WRITE_ERROR_EXIT, and _archiveHandle::writingBlob.

Referenced by _LoadBlobs(), _PrintFileData(), _PrintTocData(), _WriteData(), ahprintf(), EndCompressor(), and ReadDataFromArchiveNone().

1711 {
1712  int bytes_written = 0;
1713 
1714  if (AH->writingBlob)
1715  {
1716  size_t remaining = size * nmemb;
1717 
1718  while (AH->lo_buf_used + remaining > AH->lo_buf_size)
1719  {
1720  size_t avail = AH->lo_buf_size - AH->lo_buf_used;
1721 
1722  memcpy((char *) AH->lo_buf + AH->lo_buf_used, ptr, avail);
1723  ptr = (const void *) ((const char *) ptr + avail);
1724  remaining -= avail;
1725  AH->lo_buf_used += avail;
1726  dump_lo_buf(AH);
1727  }
1728 
1729  memcpy((char *) AH->lo_buf + AH->lo_buf_used, ptr, remaining);
1730  AH->lo_buf_used += remaining;
1731 
1732  bytes_written = size * nmemb;
1733  }
1734  else if (AH->gzOut)
1735  bytes_written = GZWRITE(ptr, size, nmemb, AH->OF);
1736  else if (AH->CustomOutPtr)
1737  bytes_written = AH->CustomOutPtr(AH, ptr, size * nmemb);
1738 
1739  else
1740  {
1741  /*
1742  * If we're doing a restore, and it's direct to DB, and we're
1743  * connected then send it to the DB.
1744  */
1745  if (RestoringToDB(AH))
1746  bytes_written = ExecuteSqlCommandBuf(&AH->public, (const char *) ptr, size * nmemb);
1747  else
1748  bytes_written = fwrite(ptr, size, nmemb, AH->OF) * size;
1749  }
1750 
1751  if (bytes_written != size * nmemb)
1753 
1754  return;
1755 }
int remaining
Definition: informix.c:692
static int RestoringToDB(ArchiveHandle *AH)
int ExecuteSqlCommandBuf(Archive *AHX, const char *buf, size_t bufLen)
Definition: pg_backup_db.c:552
static void dump_lo_buf(ArchiveHandle *AH)
#define GZWRITE(p, s, n, fh)
CustomOutPtrType CustomOutPtr
#define WRITE_ERROR_EXIT

◆ checkSeek()

bool checkSeek ( FILE *  fp)

Definition at line 3841 of file pg_backup_archiver.c.

References fseeko, ftello, and pgoff_t.

Referenced by InitArchiveFmt_Custom(), and InitArchiveFmt_Tar().

3842 {
3843  pgoff_t tpos;
3844 
3845  /*
3846  * If pgoff_t is wider than long, we must have "real" fseeko and not an
3847  * emulation using fseek. Otherwise report no seek capability.
3848  */
3849 #ifndef HAVE_FSEEKO
3850  if (sizeof(pgoff_t) > sizeof(long))
3851  return false;
3852 #endif
3853 
3854  /* Check that ftello works on this file */
3855  tpos = ftello(fp);
3856  if (tpos < 0)
3857  return false;
3858 
3859  /*
3860  * Check that fseeko(SEEK_SET) works, too. NB: we used to try to test
3861  * this with fseeko(fp, 0, SEEK_CUR). But some platforms treat that as a
3862  * successful no-op even on files that are otherwise unseekable.
3863  */
3864  if (fseeko(fp, tpos, SEEK_SET) != 0)
3865  return false;
3866 
3867  return true;
3868 }
#define pgoff_t
Definition: win32_port.h:206
#define ftello(stream)
Definition: win32_port.h:215
#define fseeko(stream, offset, origin)
Definition: win32_port.h:212

◆ CloneArchive()

ArchiveHandle* CloneArchive ( ArchiveHandle AH)

Definition at line 4691 of file pg_backup_archiver.c.

References _doSetFixedOutputState(), appendConnStrVal(), appendPQExpBuffer(), archModeRead, Assert, _archiveHandle::ClonePtr, _archiveHandle::connCancel, ConnectDatabase(), _archiveHandle::connection, connstr, _archiveHandle::currSchema, _archiveHandle::currTablespace, _archiveHandle::currUser, _archiveHandle::currWithOids, PQExpBufferData::data, _restoreOptions::dbname, initPQExpBuffer(), _archiveHandle::mode, Archive::n_errors, pg_malloc(), pg_strdup(), _restoreOptions::pghost, pghost, _restoreOptions::pgport, pgport, PQdb(), PQhost(), PQport(), PQuser(), _restoreOptions::promptPassword, _archiveHandle::public, Archive::ropt, _archiveHandle::savedPassword, _archiveHandle::sqlparse, termPQExpBuffer(), TRI_NO, _restoreOptions::username, and username.

Referenced by RunWorker().

4692 {
4693  ArchiveHandle *clone;
4694 
4695  /* Make a "flat" copy */
4696  clone = (ArchiveHandle *) pg_malloc(sizeof(ArchiveHandle));
4697  memcpy(clone, AH, sizeof(ArchiveHandle));
4698 
4699  /* Handle format-independent fields */
4700  memset(&(clone->sqlparse), 0, sizeof(clone->sqlparse));
4701 
4702  /* The clone will have its own connection, so disregard connection state */
4703  clone->connection = NULL;
4704  clone->connCancel = NULL;
4705  clone->currUser = NULL;
4706  clone->currSchema = NULL;
4707  clone->currTablespace = NULL;
4708  clone->currWithOids = -1;
4709 
4710  /* savedPassword must be local in case we change it while connecting */
4711  if (clone->savedPassword)
4712  clone->savedPassword = pg_strdup(clone->savedPassword);
4713 
4714  /* clone has its own error count, too */
4715  clone->public.n_errors = 0;
4716 
4717  /*
4718  * Connect our new clone object to the database: In parallel restore the
4719  * parent is already disconnected, because we can connect the worker
4720  * processes independently to the database (no snapshot sync required). In
4721  * parallel backup we clone the parent's existing connection.
4722  */
4723  if (AH->mode == archModeRead)
4724  {
4725  RestoreOptions *ropt = AH->public.ropt;
4726 
4727  Assert(AH->connection == NULL);
4728 
4729  /* this also sets clone->connection */
4730  ConnectDatabase((Archive *) clone, ropt->dbname,
4731  ropt->pghost, ropt->pgport, ropt->username,
4732  ropt->promptPassword);
4733 
4734  /* re-establish fixed state */
4735  _doSetFixedOutputState(clone);
4736  }
4737  else
4738  {
4740  char *pghost;
4741  char *pgport;
4742  char *username;
4743 
4744  Assert(AH->connection != NULL);
4745 
4746  /*
4747  * Even though we are technically accessing the parent's database
4748  * object here, these functions are fine to be called like that
4749  * because all just return a pointer and do not actually send/receive
4750  * any data to/from the database.
4751  */
4752  initPQExpBuffer(&connstr);
4753  appendPQExpBuffer(&connstr, "dbname=");
4754  appendConnStrVal(&connstr, PQdb(AH->connection));
4755  pghost = PQhost(AH->connection);
4756  pgport = PQport(AH->connection);
4757  username = PQuser(AH->connection);
4758 
4759  /* this also sets clone->connection */
4760  ConnectDatabase((Archive *) clone, connstr.data,
4761  pghost, pgport, username, TRI_NO);
4762 
4763  termPQExpBuffer(&connstr);
4764  /* setupDumpWorker will fix up connection state */
4765  }
4766 
4767  /* Let the format-specific code have a chance too */
4768  clone->ClonePtr(clone);
4769 
4770  Assert(clone->connection != NULL);
4771  return clone;
4772 }
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
RestoreOptions * ropt
Definition: pg_backup.h:184
void termPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:128
char * username
Definition: pg_backup.h:113
void appendConnStrVal(PQExpBuffer buf, const char *str)
Definition: string_utils.c:551
char * PQport(const PGconn *conn)
Definition: fe-connect.c:6036
int n_errors
Definition: pg_backup.h:204
PGcancel *volatile connCancel
char * PQuser(const PGconn *conn)
Definition: fe-connect.c:5991
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:262
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
static void _doSetFixedOutputState(ArchiveHandle *AH)
sqlparseInfo sqlparse
char * pghost
Definition: pgbench.c:180
static char * username
Definition: initdb.c:132
char * PQhost(const PGconn *conn)
Definition: fe-connect.c:6016
char * PQdb(const PGconn *conn)
Definition: fe-connect.c:5983
#define Assert(condition)
Definition: c.h:688
ClonePtrType ClonePtr
char * pgport
Definition: pgbench.c:181
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:89
void ConnectDatabase(Archive *AH, const char *dbname, const char *pghost, const char *pgport, const char *username, trivalue prompt_password)
Definition: pg_backup_db.c:235
static char * connstr
Definition: pg_dumpall.c:57
trivalue promptPassword
Definition: pg_backup.h:115

◆ DeCloneArchive()

void DeCloneArchive ( ArchiveHandle AH)

Definition at line 4780 of file pg_backup_archiver.c.

References Assert, _archiveHandle::connection, sqlparseInfo::curCmd, _archiveHandle::currSchema, _archiveHandle::currTablespace, _archiveHandle::currUser, _archiveHandle::DeClonePtr, destroyPQExpBuffer(), free, _archiveHandle::savedPassword, and _archiveHandle::sqlparse.

Referenced by RunWorker().

4781 {
4782  /* Should not have an open database connection */
4783  Assert(AH->connection == NULL);
4784 
4785  /* Clear format-specific state */
4786  AH->DeClonePtr(AH);
4787 
4788  /* Clear state allocated by CloneArchive */
4789  if (AH->sqlparse.curCmd)
4791 
4792  /* Clear any connection-local state */
4793  if (AH->currUser)
4794  free(AH->currUser);
4795  if (AH->currSchema)
4796  free(AH->currSchema);
4797  if (AH->currTablespace)
4798  free(AH->currTablespace);
4799  if (AH->savedPassword)
4800  free(AH->savedPassword);
4801 
4802  free(AH);
4803 }
PQExpBuffer curCmd
DeClonePtrType DeClonePtr
void destroyPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:113
sqlparseInfo sqlparse
#define free(a)
Definition: header.h:65
#define Assert(condition)
Definition: c.h:688

◆ DropBlobIfExists()

void DropBlobIfExists ( ArchiveHandle AH,
Oid  oid 
)

Definition at line 652 of file pg_backup_db.c.

References ahprintf(), _archiveHandle::connection, and PQserverVersion().

Referenced by _StartBlob(), RestoreArchive(), and StartRestoreBlob().

653 {
654  /*
655  * If we are not restoring to a direct database connection, we have to
656  * guess about how to detect whether the blob exists. Assume new-style.
657  */
658  if (AH->connection == NULL ||
659  PQserverVersion(AH->connection) >= 90000)
660  {
661  ahprintf(AH,
662  "SELECT pg_catalog.lo_unlink(oid) "
663  "FROM pg_catalog.pg_largeobject_metadata "
664  "WHERE oid = '%u';\n",
665  oid);
666  }
667  else
668  {
669  /* Restoring to pre-9.0 server, so do it the old way */
670  ahprintf(AH,
671  "SELECT CASE WHEN EXISTS("
672  "SELECT 1 FROM pg_catalog.pg_largeobject WHERE loid = '%u'"
673  ") THEN pg_catalog.lo_unlink('%u') END;\n",
674  oid, oid);
675  }
676 }
int PQserverVersion(const PGconn *conn)
Definition: fe-connect.c:6105
int ahprintf(ArchiveHandle *AH, const char *fmt,...)

◆ EndRestoreBlob()

void EndRestoreBlob ( ArchiveHandle AH,
Oid  oid 
)

Definition at line 1346 of file pg_backup_archiver.c.

References ahprintf(), _archiveHandle::connection, dump_lo_buf(), _archiveHandle::lo_buf_used, lo_close(), _archiveHandle::loFd, and _archiveHandle::writingBlob.

Referenced by _LoadBlobs().

1347 {
1348  if (AH->lo_buf_used > 0)
1349  {
1350  /* Write remaining bytes from the LO buffer */
1351  dump_lo_buf(AH);
1352  }
1353 
1354  AH->writingBlob = 0;
1355 
1356  if (AH->connection)
1357  {
1358  lo_close(AH->connection, AH->loFd);
1359  AH->loFd = -1;
1360  }
1361  else
1362  {
1363  ahprintf(AH, "SELECT pg_catalog.lo_close(0);\n\n");
1364  }
1365 }
int lo_close(PGconn *conn, int fd)
Definition: fe-lobj.c:99
static void dump_lo_buf(ArchiveHandle *AH)
int ahprintf(ArchiveHandle *AH, const char *fmt,...)

◆ EndRestoreBlobs()

void EndRestoreBlobs ( ArchiveHandle AH)

Definition at line 1279 of file pg_backup_archiver.c.

References ahlog(), ahprintf(), _archiveHandle::blobCount, CommitTransaction(), _archiveHandle::connection, ngettext, _archiveHandle::public, Archive::ropt, and _restoreOptions::single_txn.

Referenced by _LoadBlobs().

1280 {
1281  RestoreOptions *ropt = AH->public.ropt;
1282 
1283  if (!ropt->single_txn)
1284  {
1285  if (AH->connection)
1286  CommitTransaction(&AH->public);
1287  else
1288  ahprintf(AH, "COMMIT;\n\n");
1289  }
1290 
1291  ahlog(AH, 1, ngettext("restored %d large object\n",
1292  "restored %d large objects\n",
1293  AH->blobCount),
1294  AH->blobCount);
1295 }
RestoreOptions * ropt
Definition: pg_backup.h:184
int ahprintf(ArchiveHandle *AH, const char *fmt,...)
#define ngettext(s, p, n)
Definition: c.h:1011
void ahlog(ArchiveHandle *AH, int level, const char *fmt,...)
static void CommitTransaction(void)
Definition: xact.c:1934

◆ getTocEntryByDumpId()

TocEntry* getTocEntryByDumpId ( ArchiveHandle AH,
DumpId  id 
)

Definition at line 1890 of file pg_backup_archiver.c.

References buildTocEntryArrays(), and _archiveHandle::tocsByDumpId.

Referenced by parseWorkerCommand(), SortTocFromFile(), and TocIDRequired().

1891 {
1892  /* build index arrays if we didn't already */
1893  if (AH->tocsByDumpId == NULL)
1894  buildTocEntryArrays(AH);
1895 
1896  if (id > 0 && id <= AH->maxDumpId)
1897  return AH->tocsByDumpId[id];
1898 
1899  return NULL;
1900 }
static void buildTocEntryArrays(ArchiveHandle *AH)
struct _tocEntry ** tocsByDumpId

◆ InitArchiveFmt_Custom()

void InitArchiveFmt_Custom ( ArchiveHandle AH)

Definition at line 108 of file pg_backup_custom.c.

References _ArchiveEntry(), _Clone(), _CloseArchive(), _DeClone(), _EndBlob(), _EndBlobs(), _EndData(), _getFilePos(), _PrintExtraToc(), _PrintTocData(), _ReadBuf(), _ReadByte(), _ReadExtraToc(), _ReopenArchive(), _StartBlob(), _StartBlobs(), _StartData(), _WorkerJobRestoreCustom(), _WriteBuf(), _WriteByte(), _WriteData(), _WriteExtraToc(), _archiveHandle::ArchiveEntryPtr, archModeWrite, checkSeek(), _archiveHandle::ClonePtr, _archiveHandle::ClosePtr, lclContext::dataStart, _archiveHandle::DeClonePtr, _archiveHandle::EndBlobPtr, _archiveHandle::EndBlobsPtr, _archiveHandle::EndDataPtr, exit_horribly(), _archiveHandle::FH, lclContext::filePos, _archiveHandle::formatData, _archiveHandle::fSpec, lclContext::hasSeek, _archiveHandle::lo_buf, _archiveHandle::lo_buf_size, LOBBUFSIZE, _archiveHandle::mode, modulename, PG_BINARY_R, PG_BINARY_W, pg_malloc(), pg_malloc0(), _archiveHandle::PrintExtraTocPtr, _archiveHandle::PrintTocDataPtr, _archiveHandle::ReadBufPtr, _archiveHandle::ReadBytePtr, _archiveHandle::ReadExtraTocPtr, ReadHead(), ReadToc(), _archiveHandle::ReopenPtr, _archiveHandle::StartBlobPtr, _archiveHandle::StartBlobsPtr, _archiveHandle::StartDataPtr, strerror(), _archiveHandle::WorkerJobDumpPtr, _archiveHandle::WorkerJobRestorePtr, _archiveHandle::WriteBufPtr, _archiveHandle::WriteBytePtr, _archiveHandle::WriteDataPtr, and _archiveHandle::WriteExtraTocPtr.

Referenced by _allocAH().

109 {
110  lclContext *ctx;
111 
112  /* Assuming static functions, this can be copied for each format. */
114  AH->StartDataPtr = _StartData;
115  AH->WriteDataPtr = _WriteData;
116  AH->EndDataPtr = _EndData;
117  AH->WriteBytePtr = _WriteByte;
118  AH->ReadBytePtr = _ReadByte;
119  AH->WriteBufPtr = _WriteBuf;
120  AH->ReadBufPtr = _ReadBuf;
121  AH->ClosePtr = _CloseArchive;
127 
129  AH->StartBlobPtr = _StartBlob;
130  AH->EndBlobPtr = _EndBlob;
131  AH->EndBlobsPtr = _EndBlobs;
132  AH->ClonePtr = _Clone;
133  AH->DeClonePtr = _DeClone;
134 
135  /* no parallel dump in the custom archive, only parallel restore */
136  AH->WorkerJobDumpPtr = NULL;
138 
139  /* Set up a private area. */
140  ctx = (lclContext *) pg_malloc0(sizeof(lclContext));
141  AH->formatData = (void *) ctx;
142 
143  /* Initialize LO buffering */
144  AH->lo_buf_size = LOBBUFSIZE;
145  AH->lo_buf = (void *) pg_malloc(LOBBUFSIZE);
146 
147  ctx->filePos = 0;
148 
149  /*
150  * Now open the file
151  */
152  if (AH->mode == archModeWrite)
153  {
154  if (AH->fSpec && strcmp(AH->fSpec, "") != 0)
155  {
156  AH->FH = fopen(AH->fSpec, PG_BINARY_W);
157  if (!AH->FH)
158  exit_horribly(modulename, "could not open output file \"%s\": %s\n",
159  AH->fSpec, strerror(errno));
160  }
161  else
162  {
163  AH->FH = stdout;
164  if (!AH->FH)
165  exit_horribly(modulename, "could not open output file: %s\n",
166  strerror(errno));
167  }
168 
169  ctx->hasSeek = checkSeek(AH->FH);
170  }
171  else
172  {
173  if (AH->fSpec && strcmp(AH->fSpec, "") != 0)
174  {
175  AH->FH = fopen(AH->fSpec, PG_BINARY_R);
176  if (!AH->FH)
177  exit_horribly(modulename, "could not open input file \"%s\": %s\n",
178  AH->fSpec, strerror(errno));
179  }
180  else
181  {
182  AH->FH = stdin;
183  if (!AH->FH)
184  exit_horribly(modulename, "could not open input file: %s\n",
185  strerror(errno));
186  }
187 
188  ctx->hasSeek = checkSeek(AH->FH);
189 
190  ReadHead(AH);
191  ReadToc(AH);
192  ctx->dataStart = _getFilePos(AH, ctx);
193  }
194 
195 }
static void _ReopenArchive(ArchiveHandle *AH)
ReopenPtrType ReopenPtr
ReadBufPtrType ReadBufPtr
void ReadToc(ArchiveHandle *AH)
void ReadHead(ArchiveHandle *AH)
DeClonePtrType DeClonePtr
static void _Clone(ArchiveHandle *AH)
static void _StartData(ArchiveHandle *AH, TocEntry *te)
static void _WriteBuf(ArchiveHandle *AH, const void *buf, size_t len)
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
WriteBufPtrType WriteBufPtr
static void _ReadBuf(ArchiveHandle *AH, void *buf, size_t len)
static void _PrintExtraToc(ArchiveHandle *AH, TocEntry *te)
static void _EndBlob(ArchiveHandle *AH, TocEntry *te, Oid oid)
StartBlobPtrType StartBlobPtr
static int _WorkerJobRestoreCustom(ArchiveHandle *AH, TocEntry *te)
EndDataPtrType EndDataPtr
#define PG_BINARY_W
Definition: c.h:1072
static void _PrintTocData(ArchiveHandle *AH, TocEntry *te)
static void _CloseArchive(ArchiveHandle *AH)
StartBlobsPtrType StartBlobsPtr
#define PG_BINARY_R
Definition: c.h:1071
ReadBytePtrType ReadBytePtr
EndBlobPtrType EndBlobPtr
static void _WriteData(ArchiveHandle *AH, const void *data, size_t dLen)
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
static void _StartBlobs(ArchiveHandle *AH, TocEntry *te)
StartDataPtrType StartDataPtr
WriteBytePtrType WriteBytePtr
static void _EndData(ArchiveHandle *AH, TocEntry *te)
static void _ReadExtraToc(ArchiveHandle *AH, TocEntry *te)
static int _ReadByte(ArchiveHandle *)
PrintTocDataPtrType PrintTocDataPtr
static const char * modulename
WriteDataPtrType WriteDataPtr
static pgoff_t _getFilePos(ArchiveHandle *AH, lclContext *ctx)
static void _ArchiveEntry(ArchiveHandle *AH, TocEntry *te)
static void _EndBlobs(ArchiveHandle *AH, TocEntry *te)
EndBlobsPtrType EndBlobsPtr
ArchiveEntryPtrType ArchiveEntryPtr
void exit_horribly(const char *modulename, const char *fmt,...)
pgoff_t dataStart
ClonePtrType ClonePtr
const char * strerror(int errnum)
Definition: strerror.c:19
WorkerJobRestorePtrType WorkerJobRestorePtr
static void _DeClone(ArchiveHandle *AH)
bool checkSeek(FILE *fp)
ClosePtrType ClosePtr
PrintExtraTocPtrType PrintExtraTocPtr
pgoff_t filePos
static int _WriteByte(ArchiveHandle *AH, const int i)
WriteExtraTocPtrType WriteExtraTocPtr
#define LOBBUFSIZE
ReadExtraTocPtrType ReadExtraTocPtr
static void _WriteExtraToc(ArchiveHandle *AH, TocEntry *te)
static void _StartBlob(ArchiveHandle *AH, TocEntry *te, Oid oid)
WorkerJobDumpPtrType WorkerJobDumpPtr

◆ InitArchiveFmt_Directory()

void InitArchiveFmt_Directory ( ArchiveHandle AH)

Definition at line 110 of file pg_backup_directory.c.

References _ArchiveEntry(), _Clone(), _CloseArchive(), _DeClone(), _EndBlob(), _EndBlobs(), _EndData(), _PrintExtraToc(), _PrintTocData(), _ReadBuf(), _ReadByte(), _ReadExtraToc(), _ReopenArchive(), _StartBlob(), _StartBlobs(), _StartData(), _WorkerJobDumpDirectory(), _WorkerJobRestoreDirectory(), _WriteBuf(), _WriteByte(), _WriteData(), _WriteExtraToc(), archDirectory, _archiveHandle::ArchiveEntryPtr, archModeWrite, archTar, lclContext::blobsTocFH, cfclose(), cfopen_read(), _archiveHandle::ClonePtr, closedir(), _archiveHandle::ClosePtr, dirent::d_name, lclContext::dataFH, _archiveHandle::DeClonePtr, lclContext::directory, _archiveHandle::EndBlobPtr, _archiveHandle::EndBlobsPtr, _archiveHandle::EndDataPtr, exit_horribly(), _archiveHandle::format, _archiveHandle::formatData, _archiveHandle::fSpec, _archiveHandle::lo_buf, _archiveHandle::lo_buf_size, LOBBUFSIZE, MAXPGPATH, mkdir, _archiveHandle::mode, modulename, opendir(), PG_BINARY_R, pg_malloc(), pg_malloc0(), _archiveHandle::PrintExtraTocPtr, _archiveHandle::PrintTocDataPtr, _archiveHandle::ReadBufPtr, _archiveHandle::ReadBytePtr, readdir(), _archiveHandle::ReadExtraTocPtr, ReadHead(), ReadToc(), _archiveHandle::ReopenPtr, S_ISDIR, setFilePath(), _archiveHandle::StartBlobPtr, _archiveHandle::StartBlobsPtr, _archiveHandle::StartDataPtr, stat, strerror(), _archiveHandle::WorkerJobDumpPtr, _archiveHandle::WorkerJobRestorePtr, _archiveHandle::WriteBufPtr, _archiveHandle::WriteBytePtr, _archiveHandle::WriteDataPtr, and _archiveHandle::WriteExtraTocPtr.

Referenced by _allocAH().

111 {
112  lclContext *ctx;
113 
114  /* Assuming static functions, this can be copied for each format. */
116  AH->StartDataPtr = _StartData;
117  AH->WriteDataPtr = _WriteData;
118  AH->EndDataPtr = _EndData;
119  AH->WriteBytePtr = _WriteByte;
120  AH->ReadBytePtr = _ReadByte;
121  AH->WriteBufPtr = _WriteBuf;
122  AH->ReadBufPtr = _ReadBuf;
123  AH->ClosePtr = _CloseArchive;
129 
131  AH->StartBlobPtr = _StartBlob;
132  AH->EndBlobPtr = _EndBlob;
133  AH->EndBlobsPtr = _EndBlobs;
134 
135  AH->ClonePtr = _Clone;
136  AH->DeClonePtr = _DeClone;
137 
140 
141  /* Set up our private context */
142  ctx = (lclContext *) pg_malloc0(sizeof(lclContext));
143  AH->formatData = (void *) ctx;
144 
145  ctx->dataFH = NULL;
146  ctx->blobsTocFH = NULL;
147 
148  /* Initialize LO buffering */
149  AH->lo_buf_size = LOBBUFSIZE;
150  AH->lo_buf = (void *) pg_malloc(LOBBUFSIZE);
151 
152  /*
153  * Now open the TOC file
154  */
155 
156  if (!AH->fSpec || strcmp(AH->fSpec, "") == 0)
157  exit_horribly(modulename, "no output directory specified\n");
158 
159  ctx->directory = AH->fSpec;
160 
161  if (AH->mode == archModeWrite)
162  {
163  struct stat st;
164  bool is_empty = false;
165 
166  /* we accept an empty existing directory */
167  if (stat(ctx->directory, &st) == 0 && S_ISDIR(st.st_mode))
168  {
169  DIR *dir = opendir(ctx->directory);
170 
171  if (dir)
172  {
173  struct dirent *d;
174 
175  is_empty = true;
176  while (errno = 0, (d = readdir(dir)))
177  {
178  if (strcmp(d->d_name, ".") != 0 && strcmp(d->d_name, "..") != 0)
179  {
180  is_empty = false;
181  break;
182  }
183  }
184 
185  if (errno)
186  exit_horribly(modulename, "could not read directory \"%s\": %s\n",
187  ctx->directory, strerror(errno));
188 
189  if (closedir(dir))
190  exit_horribly(modulename, "could not close directory \"%s\": %s\n",
191  ctx->directory, strerror(errno));
192  }
193  }
194 
195  if (!is_empty && mkdir(ctx->directory, 0700) < 0)
196  exit_horribly(modulename, "could not create directory \"%s\": %s\n",
197  ctx->directory, strerror(errno));
198  }
199  else
200  { /* Read Mode */
201  char fname[MAXPGPATH];
202  cfp *tocFH;
203 
204  setFilePath(AH, fname, "toc.dat");
205 
206  tocFH = cfopen_read(fname, PG_BINARY_R);
207  if (tocFH == NULL)
209  "could not open input file \"%s\": %s\n",
210  fname, strerror(errno));
211 
212  ctx->dataFH = tocFH;
213 
214  /*
215  * The TOC of a directory format dump shares the format code of the
216  * tar format.
217  */
218  AH->format = archTar;
219  ReadHead(AH);
220  AH->format = archDirectory;
221  ReadToc(AH);
222 
223  /* Nothing else in the file, so close it again... */
224  if (cfclose(tocFH) != 0)
225  exit_horribly(modulename, "could not close TOC file: %s\n",
226  strerror(errno));
227  ctx->dataFH = NULL;
228  }
229 }
ReopenPtrType ReopenPtr
static void _StartData(ArchiveHandle *AH, TocEntry *te)
ReadBufPtrType ReadBufPtr
void ReadToc(ArchiveHandle *AH)
void ReadHead(ArchiveHandle *AH)
DeClonePtrType DeClonePtr
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
WriteBufPtrType WriteBufPtr
static void _WriteData(ArchiveHandle *AH, const void *data, size_t dLen)
static int _WorkerJobRestoreDirectory(ArchiveHandle *AH, TocEntry *te)
static void _WriteBuf(ArchiveHandle *AH, const void *buf, size_t len)
static int _WriteByte(ArchiveHandle *AH, const int i)
static void _ArchiveEntry(ArchiveHandle *AH, TocEntry *te)
static void _PrintTocData(ArchiveHandle *AH, TocEntry *te)
static void setFilePath(ArchiveHandle *AH, char *buf, const char *relativeFilename)
StartBlobPtrType StartBlobPtr
EndDataPtrType EndDataPtr
int closedir(DIR *)
Definition: dirent.c:111
static void _EndData(ArchiveHandle *AH, TocEntry *te)
static void _StartBlob(ArchiveHandle *AH, TocEntry *te, Oid oid)
static const char * modulename
StartBlobsPtrType StartBlobsPtr
int cfclose(cfp *fp)
Definition: compress_io.c:667
Definition: dirent.h:9
#define PG_BINARY_R
Definition: c.h:1071
static void _EndBlob(ArchiveHandle *AH, TocEntry *te, Oid oid)
ReadBytePtrType ReadBytePtr
static void _ReadExtraToc(ArchiveHandle *AH, TocEntry *te)
EndBlobPtrType EndBlobPtr
static void _PrintExtraToc(ArchiveHandle *AH, TocEntry *te)
Definition: dirent.c:25
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
#define MAXPGPATH
DIR * opendir(const char *)
Definition: dirent.c:33
static void _Clone(ArchiveHandle *AH)
StartDataPtrType StartDataPtr
WriteBytePtrType WriteBytePtr
#define stat(a, b)
Definition: win32_port.h:266
ArchiveFormat format
static void _ReadBuf(ArchiveHandle *AH, void *buf, size_t len)
PrintTocDataPtrType PrintTocDataPtr
WriteDataPtrType WriteDataPtr
static void _DeClone(ArchiveHandle *AH)
static int _ReadByte(ArchiveHandle *)
EndBlobsPtrType EndBlobsPtr
static void _StartBlobs(ArchiveHandle *AH, TocEntry *te)
ArchiveEntryPtrType ArchiveEntryPtr
struct dirent * readdir(DIR *)
Definition: dirent.c:77
#define S_ISDIR(m)
Definition: win32_port.h:307
void exit_horribly(const char *modulename, const char *fmt,...)
static void _CloseArchive(ArchiveHandle *AH)
ClonePtrType ClonePtr
cfp * cfopen_read(const char *path, const char *mode)
Definition: compress_io.c:467
const char * strerror(int errnum)
Definition: strerror.c:19
WorkerJobRestorePtrType WorkerJobRestorePtr
static int _WorkerJobDumpDirectory(ArchiveHandle *AH, TocEntry *te)
static void _ReopenArchive(ArchiveHandle *AH)
ClosePtrType ClosePtr
char d_name[MAX_PATH]
Definition: dirent.h:14
PrintExtraTocPtrType PrintExtraTocPtr
#define mkdir(a, b)
Definition: win32_port.h:58
static void _WriteExtraToc(ArchiveHandle *AH, TocEntry *te)
WriteExtraTocPtrType WriteExtraTocPtr
static void _EndBlobs(ArchiveHandle *AH, TocEntry *te)
#define LOBBUFSIZE
ReadExtraTocPtrType ReadExtraTocPtr
WorkerJobDumpPtrType WorkerJobDumpPtr

◆ InitArchiveFmt_Null()

void InitArchiveFmt_Null ( ArchiveHandle AH)

Definition at line 49 of file pg_backup_null.c.

References _CloseArchive(), _EndBlob(), _EndBlobs(), _EndData(), _PrintTocData(), _StartBlob(), _StartBlobs(), _WriteBuf(), _WriteByte(), _WriteData(), archModeRead, _archiveHandle::ClonePtr, _archiveHandle::ClosePtr, _archiveHandle::DeClonePtr, _archiveHandle::EndBlobPtr, _archiveHandle::EndBlobsPtr, _archiveHandle::EndDataPtr, exit_horribly(), _archiveHandle::lo_buf, _archiveHandle::lo_buf_size, LOBBUFSIZE, _archiveHandle::mode, pg_malloc(), _archiveHandle::PrintTocDataPtr, _archiveHandle::ReopenPtr, _archiveHandle::StartBlobPtr, _archiveHandle::StartBlobsPtr, _archiveHandle::WriteBufPtr, _archiveHandle::WriteBytePtr, and _archiveHandle::WriteDataPtr.

Referenced by _allocAH().

50 {
51  /* Assuming static functions, this can be copied for each format. */
53  AH->EndDataPtr = _EndData;
55  AH->WriteBufPtr = _WriteBuf;
56  AH->ClosePtr = _CloseArchive;
57  AH->ReopenPtr = NULL;
59 
62  AH->EndBlobPtr = _EndBlob;
63  AH->EndBlobsPtr = _EndBlobs;
64  AH->ClonePtr = NULL;
65  AH->DeClonePtr = NULL;
66 
67  /* Initialize LO buffering */
68  AH->lo_buf_size = LOBBUFSIZE;
69  AH->lo_buf = (void *) pg_malloc(LOBBUFSIZE);
70 
71  /*
72  * Now prevent reading...
73  */
74  if (AH->mode == archModeRead)
75  exit_horribly(NULL, "this format cannot be read\n");
76 }
ReopenPtrType ReopenPtr
DeClonePtrType DeClonePtr
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
WriteBufPtrType WriteBufPtr
StartBlobPtrType StartBlobPtr
EndDataPtrType EndDataPtr
StartBlobsPtrType StartBlobsPtr
EndBlobPtrType EndBlobPtr
static void _CloseArchive(ArchiveHandle *AH)
static void _EndBlobs(ArchiveHandle *AH, TocEntry *te)
WriteBytePtrType WriteBytePtr
static void _EndBlob(ArchiveHandle *AH, TocEntry *te, Oid oid)
static void _PrintTocData(ArchiveHandle *AH, TocEntry *te)
static void _StartBlobs(ArchiveHandle *AH, TocEntry *te)
PrintTocDataPtrType PrintTocDataPtr
WriteDataPtrType WriteDataPtr
static void _EndData(ArchiveHandle *AH, TocEntry *te)
EndBlobsPtrType EndBlobsPtr
static int _WriteByte(ArchiveHandle *AH, const int i)
static void _WriteData(ArchiveHandle *AH, const void *data, size_t dLen)
void exit_horribly(const char *modulename, const char *fmt,...)
ClonePtrType ClonePtr
ClosePtrType ClosePtr
static void _WriteBuf(ArchiveHandle *AH, const void *buf, size_t len)
#define LOBBUFSIZE
static void _StartBlob(ArchiveHandle *AH, TocEntry *te, Oid oid)

◆ InitArchiveFmt_Tar()

void InitArchiveFmt_Tar ( ArchiveHandle AH)

Definition at line 129 of file pg_backup_tar.c.

References _ArchiveEntry(), _CloseArchive(), _EndBlob(), _EndBlobs(), _EndData(), _PrintExtraToc(), _PrintTocData(), _ReadBuf(), _ReadByte(), _ReadExtraToc(), _StartBlob(), _StartBlobs(), _StartData(), _WriteBuf(), _WriteByte(), _WriteData(), _WriteExtraToc(), archModeWrite, checkSeek(), exit_horribly(), lclContext::FH, lclContext::filePos, lclContext::hasSeek, lclContext::isSpecialScript, LOBBUFSIZE, modulename, PG_BINARY_R, PG_BINARY_W, pg_malloc(), pg_malloc0(), ReadHead(), ReadToc(), strerror(), tarClose(), lclContext::tarFH, lclContext::tarFHpos, and tarOpen().

Referenced by _allocAH().

130 {
131  lclContext *ctx;
132 
133  /* Assuming static functions, this can be copied for each format. */
135  AH->StartDataPtr = _StartData;
136  AH->WriteDataPtr = _WriteData;
137  AH->EndDataPtr = _EndData;
138  AH->WriteBytePtr = _WriteByte;
139  AH->ReadBytePtr = _ReadByte;
140  AH->WriteBufPtr = _WriteBuf;
141  AH->ReadBufPtr = _ReadBuf;
142  AH->ClosePtr = _CloseArchive;
143  AH->ReopenPtr = NULL;
148 
150  AH->StartBlobPtr = _StartBlob;
151  AH->EndBlobPtr = _EndBlob;
152  AH->EndBlobsPtr = _EndBlobs;
153  AH->ClonePtr = NULL;
154  AH->DeClonePtr = NULL;
155 
156  AH->WorkerJobDumpPtr = NULL;
157  AH->WorkerJobRestorePtr = NULL;
158 
159  /*
160  * Set up some special context used in compressing data.
161  */
162  ctx = (lclContext *) pg_malloc0(sizeof(lclContext));
163  AH->formatData = (void *) ctx;
164  ctx->filePos = 0;
165  ctx->isSpecialScript = 0;
166 
167  /* Initialize LO buffering */
168  AH->lo_buf_size = LOBBUFSIZE;
169  AH->lo_buf = (void *) pg_malloc(LOBBUFSIZE);
170 
171  /*
172  * Now open the tar file, and load the TOC if we're in read mode.
173  */
174  if (AH->mode == archModeWrite)
175  {
176  if (AH->fSpec && strcmp(AH->fSpec, "") != 0)
177  {
178  ctx->tarFH = fopen(AH->fSpec, PG_BINARY_W);
179  if (ctx->tarFH == NULL)
181  "could not open TOC file \"%s\" for output: %s\n",
182  AH->fSpec, strerror(errno));
183  }
184  else
185  {
186  ctx->tarFH = stdout;
187  if (ctx->tarFH == NULL)
189  "could not open TOC file for output: %s\n",
190  strerror(errno));
191  }
192 
193  ctx->tarFHpos = 0;
194 
195  /*
196  * Make unbuffered since we will dup() it, and the buffers screw each
197  * other
198  */
199  /* setvbuf(ctx->tarFH, NULL, _IONBF, 0); */
200 
201  ctx->hasSeek = checkSeek(ctx->tarFH);
202 
203  /*
204  * We don't support compression because reading the files back is not
205  * possible since gzdopen uses buffered IO which totally screws file
206  * positioning.
207  */
208  if (AH->compression != 0)
210  "compression is not supported by tar archive format\n");
211  }
212  else
213  { /* Read Mode */
214  if (AH->fSpec && strcmp(AH->fSpec, "") != 0)
215  {
216  ctx->tarFH = fopen(AH->fSpec, PG_BINARY_R);
217  if (ctx->tarFH == NULL)
218  exit_horribly(modulename, "could not open TOC file \"%s\" for input: %s\n",
219  AH->fSpec, strerror(errno));
220  }
221  else
222  {
223  ctx->tarFH = stdin;
224  if (ctx->tarFH == NULL)
225  exit_horribly(modulename, "could not open TOC file for input: %s\n",
226  strerror(errno));
227  }
228 
229  /*
230  * Make unbuffered since we will dup() it, and the buffers screw each
231  * other
232  */
233  /* setvbuf(ctx->tarFH, NULL, _IONBF, 0); */
234 
235  ctx->tarFHpos = 0;
236 
237  ctx->hasSeek = checkSeek(ctx->tarFH);
238 
239  /*
240  * Forcibly unmark the header as read since we use the lookahead
241  * buffer
242  */
243  AH->readHeader = 0;
244 
245  ctx->FH = (void *) tarOpen(AH, "toc.dat", 'r');
246  ReadHead(AH);
247  ReadToc(AH);
248  tarClose(AH, ctx->FH); /* Nothing else in the file... */
249  }
250 }
TAR_MEMBER * FH
Definition: pg_backup_tar.c:91
ReopenPtrType ReopenPtr
ReadBufPtrType ReadBufPtr
void ReadToc(ArchiveHandle *AH)
static void _StartData(ArchiveHandle *AH, TocEntry *te)
void ReadHead(ArchiveHandle *AH)
DeClonePtrType DeClonePtr
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
WriteBufPtrType WriteBufPtr
static TAR_MEMBER * tarOpen(ArchiveHandle *AH, const char *filename, char mode)
pgoff_t tarFHpos
Definition: pg_backup_tar.c:89
StartBlobPtrType StartBlobPtr
EndDataPtrType EndDataPtr
#define PG_BINARY_W
Definition: c.h:1072
static void _EndBlob(ArchiveHandle *AH, TocEntry *te, Oid oid)
StartBlobsPtrType StartBlobsPtr
#define PG_BINARY_R
Definition: c.h:1071
ReadBytePtrType ReadBytePtr
EndBlobPtrType EndBlobPtr
int isSpecialScript
Definition: pg_backup_tar.c:92
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
FILE * tarFH
Definition: pg_backup_tar.c:88
static void _StartBlobs(ArchiveHandle *AH, TocEntry *te)
static void _WriteBuf(ArchiveHandle *AH, const void *buf, size_t len)
StartDataPtrType StartDataPtr
static void tarClose(ArchiveHandle *AH, TAR_MEMBER *TH)
WriteBytePtrType WriteBytePtr
static void _PrintExtraToc(ArchiveHandle *AH, TocEntry *te)
static void _EndBlobs(ArchiveHandle *AH, TocEntry *te)
static const char * modulename
PrintTocDataPtrType PrintTocDataPtr
WriteDataPtrType WriteDataPtr
static void _EndData(ArchiveHandle *AH, TocEntry *te)
EndBlobsPtrType EndBlobsPtr
static void _PrintTocData(ArchiveHandle *AH, TocEntry *te)
static void _ArchiveEntry(ArchiveHandle *AH, TocEntry *te)
ArchiveEntryPtrType ArchiveEntryPtr
static void _StartBlob(ArchiveHandle *AH, TocEntry *te, Oid oid)
void exit_horribly(const char *modulename, const char *fmt,...)
ClonePtrType ClonePtr
static void _CloseArchive(ArchiveHandle *AH)
static void _WriteData(ArchiveHandle *AH, const void *data, size_t dLen)
const char * strerror(int errnum)
Definition: strerror.c:19
WorkerJobRestorePtrType WorkerJobRestorePtr
bool checkSeek(FILE *fp)
ClosePtrType ClosePtr
PrintExtraTocPtrType PrintExtraTocPtr
static void _ReadBuf(ArchiveHandle *AH, void *buf, size_t len)
static void _WriteExtraToc(ArchiveHandle *AH, TocEntry *te)
pgoff_t filePos
static int _ReadByte(ArchiveHandle *)
WriteExtraTocPtrType WriteExtraTocPtr
#define LOBBUFSIZE
static int _WriteByte(ArchiveHandle *AH, const int i)
ReadExtraTocPtrType ReadExtraTocPtr
static void _ReadExtraToc(ArchiveHandle *AH, TocEntry *te)
WorkerJobDumpPtrType WorkerJobDumpPtr

◆ isValidTarHeader()

bool isValidTarHeader ( char *  header)

Definition at line 1059 of file pg_backup_tar.c.

References read_tar_number(), and tarChecksum().

Referenced by _discoverArchiveFormat().

1060 {
1061  int sum;
1062  int chk = tarChecksum(header);
1063 
1064  sum = read_tar_number(&header[148], 8);
1065 
1066  if (sum != chk)
1067  return false;
1068 
1069  /* POSIX tar format */
1070  if (memcmp(&header[257], "ustar\0", 6) == 0 &&
1071  memcmp(&header[263], "00", 2) == 0)
1072  return true;
1073  /* GNU tar format */
1074  if (memcmp(&header[257], "ustar \0", 8) == 0)
1075  return true;
1076  /* not-quite-POSIX format written by pre-9.3 pg_dump */
1077  if (memcmp(&header[257], "ustar00\0", 8) == 0)
1078  return true;
1079 
1080  return false;
1081 }
uint64 read_tar_number(const char *s, int len)
Definition: tar.c:56
int tarChecksum(char *header)
Definition: tar.c:88
static void header(const char *fmt,...) pg_attribute_printf(1
Definition: pg_regress.c:208

◆ on_exit_close_archive()

void on_exit_close_archive ( Archive AHX)

Definition at line 347 of file parallel.c.

References ShutdownInformation::AHX, archive_close_connection(), and on_exit_nicely().

Referenced by main().

348 {
349  shutdown_info.AHX = AHX;
351 }
void on_exit_nicely(on_exit_nicely_callback function, void *arg)
static ShutdownInformation shutdown_info
Definition: parallel.c:150
static void archive_close_connection(int code, void *arg)
Definition: parallel.c:358

◆ parallel_restore()

int parallel_restore ( ArchiveHandle AH,
TocEntry te 
)

Definition at line 4343 of file pg_backup_archiver.c.

References Assert, _archiveHandle::connection, Archive::n_errors, _archiveHandle::public, restore_toc_entry(), and status().

Referenced by _WorkerJobRestoreCustom(), and _WorkerJobRestoreDirectory().

4344 {
4345  int status;
4346 
4347  Assert(AH->connection != NULL);
4348 
4349  /* Count only errors associated with this TOC entry */
4350  AH->public.n_errors = 0;
4351 
4352  /* Restore the TOC item */
4353  status = restore_toc_entry(AH, te, true);
4354 
4355  return status;
4356 }
int n_errors
Definition: pg_backup.h:204
static int restore_toc_entry(ArchiveHandle *AH, TocEntry *te, bool is_parallel)
#define Assert(condition)
Definition: c.h:688
static void static void status(const char *fmt,...) pg_attribute_printf(1
Definition: pg_regress.c:225

◆ ReadHead()

void ReadHead ( ArchiveHandle AH)

Definition at line 3738 of file pg_backup_archiver.c.

References _archiveHandle::archdbname, _archiveHandle::archiveDumpVersion, _archiveHandle::archiveRemoteVersion, _archiveHandle::compression, _archiveHandle::createDate, exit_horribly(), _archiveHandle::format, _archiveHandle::intSize, K_VERS_1_0, K_VERS_1_10, K_VERS_1_2, K_VERS_1_4, K_VERS_1_7, K_VERS_MAX, MAKE_ARCHIVE_VERSION, modulename, _archiveHandle::offSize, _archiveHandle::ReadBufPtr, _archiveHandle::ReadBytePtr, _archiveHandle::readHeader, ReadInt(), ReadStr(), tm, _archiveHandle::version, write_msg(), and Z_DEFAULT_COMPRESSION.

Referenced by InitArchiveFmt_Custom(), InitArchiveFmt_Directory(), and InitArchiveFmt_Tar().

3739 {
3740  char tmpMag[7];
3741  int fmt;
3742  struct tm crtm;
3743 
3744  /*
3745  * If we haven't already read the header, do so.
3746  *
3747  * NB: this code must agree with _discoverArchiveFormat(). Maybe find a
3748  * way to unify the cases?
3749  */
3750  if (!AH->readHeader)
3751  {
3752  char vmaj,
3753  vmin,
3754  vrev;
3755 
3756  AH->ReadBufPtr(AH, tmpMag, 5);
3757 
3758  if (strncmp(tmpMag, "PGDMP", 5) != 0)
3759  exit_horribly(modulename, "did not find magic string in file header\n");
3760 
3761  vmaj = AH->ReadBytePtr(AH);
3762  vmin = AH->ReadBytePtr(AH);
3763 
3764  if (vmaj > 1 || (vmaj == 1 && vmin > 0)) /* Version > 1.0 */
3765  vrev = AH->ReadBytePtr(AH);
3766  else
3767  vrev = 0;
3768 
3769  AH->version = MAKE_ARCHIVE_VERSION(vmaj, vmin, vrev);
3770 
3771  if (AH->version < K_VERS_1_0 || AH->version > K_VERS_MAX)
3772  exit_horribly(modulename, "unsupported version (%d.%d) in file header\n",
3773  vmaj, vmin);
3774 
3775  AH->intSize = AH->ReadBytePtr(AH);
3776  if (AH->intSize > 32)
3777  exit_horribly(modulename, "sanity check on integer size (%lu) failed\n",
3778  (unsigned long) AH->intSize);
3779 
3780  if (AH->intSize > sizeof(int))
3781  write_msg(modulename, "WARNING: archive was made on a machine with larger integers, some operations might fail\n");
3782 
3783  if (AH->version >= K_VERS_1_7)
3784  AH->offSize = AH->ReadBytePtr(AH);
3785  else
3786  AH->offSize = AH->intSize;
3787 
3788  fmt = AH->ReadBytePtr(AH);
3789 
3790  if (AH->format != fmt)
3791  exit_horribly(modulename, "expected format (%d) differs from format found in file (%d)\n",
3792  AH->format, fmt);
3793  }
3794 
3795  if (AH->version >= K_VERS_1_2)
3796  {
3797  if (AH->version < K_VERS_1_4)
3798  AH->compression = AH->ReadBytePtr(AH);
3799  else
3800  AH->compression = ReadInt(AH);
3801  }
3802  else
3804 
3805 #ifndef HAVE_LIBZ
3806  if (AH->compression != 0)
3807  write_msg(modulename, "WARNING: archive is compressed, but this installation does not support compression -- no data will be available\n");
3808 #endif
3809 
3810  if (AH->version >= K_VERS_1_4)
3811  {
3812  crtm.tm_sec = ReadInt(AH);
3813  crtm.tm_min = ReadInt(AH);
3814  crtm.tm_hour = ReadInt(AH);
3815  crtm.tm_mday = ReadInt(AH);
3816  crtm.tm_mon = ReadInt(AH);
3817  crtm.tm_year = ReadInt(AH);
3818  crtm.tm_isdst = ReadInt(AH);
3819 
3820  AH->archdbname = ReadStr(AH);
3821 
3822  AH->createDate = mktime(&crtm);
3823 
3824  if (AH->createDate == (time_t) -1)
3825  write_msg(modulename, "WARNING: invalid creation date in header\n");
3826  }
3827 
3828  if (AH->version >= K_VERS_1_10)
3829  {
3830  AH->archiveRemoteVersion = ReadStr(AH);
3831  AH->archiveDumpVersion = ReadStr(AH);
3832  }
3833 }
ReadBufPtrType ReadBufPtr
#define Z_DEFAULT_COMPRESSION
#define K_VERS_1_0
int ReadInt(ArchiveHandle *AH)
#define K_VERS_1_4
ReadBytePtrType ReadBytePtr
static struct pg_tm tm
Definition: localtime.c:107
#define K_VERS_1_7
#define MAKE_ARCHIVE_VERSION(major, minor, rev)
#define K_VERS_1_2
#define K_VERS_1_10
ArchiveFormat format
#define K_VERS_MAX
void write_msg(const char *modulename, const char *fmt,...)
char * ReadStr(ArchiveHandle *AH)
void exit_horribly(const char *modulename, const char *fmt,...)
static const char * modulename

◆ ReadInt()

int ReadInt ( ArchiveHandle AH)

Definition at line 2026 of file pg_backup_archiver.c.

References _archiveHandle::intSize, K_VERS_1_0, _archiveHandle::ReadBytePtr, sign, and _archiveHandle::version.

Referenced by _CustomReadFunc(), _LoadBlobs(), _readBlockHeader(), _ReadExtraToc(), _skipBlobs(), _skipData(), ReadHead(), ReadOffset(), ReadStr(), and ReadToc().

2027 {
2028  int res = 0;
2029  int bv,
2030  b;
2031  int sign = 0; /* Default positive */
2032  int bitShift = 0;
2033 
2034  if (AH->version > K_VERS_1_0)
2035  /* Read a sign byte */
2036  sign = AH->ReadBytePtr(AH);
2037 
2038  for (b = 0; b < AH->intSize; b++)
2039  {
2040  bv = AH->ReadBytePtr(AH) & 0xFF;
2041  if (bv != 0)
2042  res = res + (bv << bitShift);
2043  bitShift += 8;
2044  }
2045 
2046  if (sign)
2047  res = -res;
2048 
2049  return res;
2050 }
#define K_VERS_1_0
ReadBytePtrType ReadBytePtr
char sign
Definition: informix.c:693

◆ ReadOffset()

int ReadOffset ( ArchiveHandle ,
pgoff_t  
)

Definition at line 1931 of file pg_backup_archiver.c.

References exit_horribly(), i, K_OFFSET_NO_DATA, K_OFFSET_POS_NOT_SET, K_OFFSET_POS_SET, K_VERS_1_7, modulename, _archiveHandle::offSize, pgoff_t, _archiveHandle::ReadBytePtr, ReadInt(), and _archiveHandle::version.

Referenced by _ReadExtraToc().

1932 {
1933  int i;
1934  int off;
1935  int offsetFlg;
1936 
1937  /* Initialize to zero */
1938  *o = 0;
1939 
1940  /* Check for old version */
1941  if (AH->version < K_VERS_1_7)
1942  {
1943  /* Prior versions wrote offsets using WriteInt */
1944  i = ReadInt(AH);
1945  /* -1 means not set */
1946  if (i < 0)
1947  return K_OFFSET_POS_NOT_SET;
1948  else if (i == 0)
1949  return K_OFFSET_NO_DATA;
1950 
1951  /* Cast to pgoff_t because it was written as an int. */
1952  *o = (pgoff_t) i;
1953  return K_OFFSET_POS_SET;
1954  }
1955 
1956  /*
1957  * Read the flag indicating the state of the data pointer. Check if valid
1958  * and die if not.
1959  *
1960  * This used to be handled by a negative or zero pointer, now we use an
1961  * extra byte specifically for the state.
1962  */
1963  offsetFlg = AH->ReadBytePtr(AH) & 0xFF;
1964 
1965  switch (offsetFlg)
1966  {
1967  case K_OFFSET_POS_NOT_SET:
1968  case K_OFFSET_NO_DATA:
1969  case K_OFFSET_POS_SET:
1970 
1971  break;
1972 
1973  default:
1974  exit_horribly(modulename, "unexpected data offset flag %d\n", offsetFlg);
1975  }
1976 
1977  /*
1978  * Read the bytes
1979  */
1980  for (off = 0; off < AH->offSize; off++)
1981  {
1982  if (off < sizeof(pgoff_t))
1983  *o |= ((pgoff_t) (AH->ReadBytePtr(AH))) << (off * 8);
1984  else
1985  {
1986  if (AH->ReadBytePtr(AH) != 0)
1987  exit_horribly(modulename, "file offset in dump file is too large\n");
1988  }
1989  }
1990 
1991  return offsetFlg;
1992 }
int ReadInt(ArchiveHandle *AH)
#define K_VERS_1_7
#define pgoff_t
Definition: win32_port.h:206
#define K_OFFSET_NO_DATA
void exit_horribly(const char *modulename, const char *fmt,...)
#define K_OFFSET_POS_SET
int i
static const char * modulename
#define K_OFFSET_POS_NOT_SET

◆ ReadStr()

char* ReadStr ( ArchiveHandle AH)

Definition at line 2072 of file pg_backup_archiver.c.

References buf, pg_malloc(), _archiveHandle::ReadBufPtr, and ReadInt().

Referenced by _ReadExtraToc(), ReadHead(), and ReadToc().

2073 {
2074  char *buf;
2075  int l;
2076 
2077  l = ReadInt(AH);
2078  if (l < 0)
2079  buf = NULL;
2080  else
2081  {
2082  buf = (char *) pg_malloc(l + 1);
2083  AH->ReadBufPtr(AH, (void *) buf, l);
2084 
2085  buf[l] = '\0';
2086  }
2087 
2088  return buf;
2089 }
ReadBufPtrType ReadBufPtr
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
int ReadInt(ArchiveHandle *AH)
static char * buf
Definition: pg_test_fsync.c:67

◆ ReadTOC()

void ReadTOC ( ArchiveHandle AH)

◆ ReadToc()

void ReadToc ( ArchiveHandle AH)

Definition at line 2561 of file pg_backup_archiver.c.

References ahlog(), _tocEntry::catalogId, _tocEntry::copyStmt, _tocEntry::defn, _tocEntry::dependencies, _tocEntry::desc, _tocEntry::dropStmt, _tocEntry::dumpId, exit_horribly(), free, _tocEntry::hadDumper, i, InvalidOid, K_VERS_1_10, K_VERS_1_11, K_VERS_1_3, K_VERS_1_5, K_VERS_1_6, K_VERS_1_8, K_VERS_1_9, _archiveHandle::maxDumpId, modulename, _tocEntry::nDeps, _tocEntry::next, CatalogId::oid, _tocEntry::owner, pg_malloc(), pg_malloc0(), pg_realloc(), _tocEntry::prev, processEncodingEntry(), processStdStringsEntry(), _archiveHandle::ReadExtraTocPtr, ReadInt(), ReadStr(), _tocEntry::section, SECTION_DATA, SECTION_NONE, SECTION_POST_DATA, SECTION_PRE_DATA, CatalogId::tableoid, _tocEntry::tablespace, _tocEntry::tag, _archiveHandle::toc, _archiveHandle::tocCount, _archiveHandle::version, and _tocEntry::withOids.

Referenced by InitArchiveFmt_Custom(), InitArchiveFmt_Directory(), and InitArchiveFmt_Tar().

2562 {
2563  int i;
2564  char *tmp;
2565  DumpId *deps;
2566  int depIdx;
2567  int depSize;
2568  TocEntry *te;
2569 
2570  AH->tocCount = ReadInt(AH);
2571  AH->maxDumpId = 0;
2572 
2573  for (i = 0; i < AH->tocCount; i++)
2574  {
2575  te = (TocEntry *) pg_malloc0(sizeof(TocEntry));
2576  te->dumpId = ReadInt(AH);
2577 
2578  if (te->dumpId > AH->maxDumpId)
2579  AH->maxDumpId = te->dumpId;
2580 
2581  /* Sanity check */
2582  if (te->dumpId <= 0)
2584  "entry ID %d out of range -- perhaps a corrupt TOC\n",
2585  te->dumpId);
2586 
2587  te->hadDumper = ReadInt(AH);
2588 
2589  if (AH->version >= K_VERS_1_8)
2590  {
2591  tmp = ReadStr(AH);
2592  sscanf(tmp, "%u", &te->catalogId.tableoid);
2593  free(tmp);
2594  }
2595  else
2597  tmp = ReadStr(AH);
2598  sscanf(tmp, "%u", &te->catalogId.oid);
2599  free(tmp);
2600 
2601  te->tag = ReadStr(AH);
2602  te->desc = ReadStr(AH);
2603 
2604  if (AH->version >= K_VERS_1_11)
2605  {
2606  te->section = ReadInt(AH);
2607  }
2608  else
2609  {
2610  /*
2611  * Rules for pre-8.4 archives wherein pg_dump hasn't classified
2612  * the entries into sections. This list need not cover entry
2613  * types added later than 8.4.
2614  */
2615  if (strcmp(te->desc, "COMMENT") == 0 ||
2616  strcmp(te->desc, "ACL") == 0 ||
2617  strcmp(te->desc, "ACL LANGUAGE") == 0)
2618  te->section = SECTION_NONE;
2619  else if (strcmp(te->desc, "TABLE DATA") == 0 ||
2620  strcmp(te->desc, "BLOBS") == 0 ||
2621  strcmp(te->desc, "BLOB COMMENTS") == 0)
2622  te->section = SECTION_DATA;
2623  else if (strcmp(te->desc, "CONSTRAINT") == 0 ||
2624  strcmp(te->desc, "CHECK CONSTRAINT") == 0 ||
2625  strcmp(te->desc, "FK CONSTRAINT") == 0 ||
2626  strcmp(te->desc, "INDEX") == 0 ||
2627  strcmp(te->desc, "RULE") == 0 ||
2628  strcmp(te->desc, "TRIGGER") == 0)
2629  te->section = SECTION_POST_DATA;
2630  else
2631  te->section = SECTION_PRE_DATA;
2632  }
2633 
2634  te->defn = ReadStr(AH);
2635  te->dropStmt = ReadStr(AH);
2636 
2637  if (AH->version >= K_VERS_1_3)
2638  te->copyStmt = ReadStr(AH);
2639 
2640  if (AH->version >= K_VERS_1_6)
2641  te->namespace = ReadStr(AH);
2642 
2643  if (AH->version >= K_VERS_1_10)
2644  te->tablespace = ReadStr(AH);
2645 
2646  te->owner = ReadStr(AH);
2647  if (AH->version >= K_VERS_1_9)
2648  {
2649  if (strcmp(ReadStr(AH), "true") == 0)
2650  te->withOids = true;
2651  else
2652  te->withOids = false;
2653  }
2654  else
2655  te->withOids = true;
2656 
2657  /* Read TOC entry dependencies */
2658  if (AH->version >= K_VERS_1_5)
2659  {
2660  depSize = 100;
2661  deps = (DumpId *) pg_malloc(sizeof(DumpId) * depSize);
2662  depIdx = 0;
2663  for (;;)
2664  {
2665  tmp = ReadStr(AH);
2666  if (!tmp)
2667  break; /* end of list */
2668  if (depIdx >= depSize)
2669  {
2670  depSize *= 2;
2671  deps = (DumpId *) pg_realloc(deps, sizeof(DumpId) * depSize);
2672  }
2673  sscanf(tmp, "%d", &deps[depIdx]);
2674  free(tmp);
2675  depIdx++;
2676  }
2677 
2678  if (depIdx > 0) /* We have a non-null entry */
2679  {
2680  deps = (DumpId *) pg_realloc(deps, sizeof(DumpId) * depIdx);
2681  te->dependencies = deps;
2682  te->nDeps = depIdx;
2683  }
2684  else
2685  {
2686  free(deps);
2687  te->dependencies = NULL;
2688  te->nDeps = 0;
2689  }
2690  }
2691  else
2692  {
2693  te->dependencies = NULL;
2694  te->nDeps = 0;
2695  }
2696 
2697  if (AH->ReadExtraTocPtr)
2698  AH->ReadExtraTocPtr(AH, te);
2699 
2700  ahlog(AH, 3, "read TOC entry %d (ID %d) for %s %s\n",
2701  i, te->dumpId, te->desc, te->tag);
2702 
2703  /* link completed entry into TOC circular list */
2704  te->prev = AH->toc->prev;
2705  AH->toc->prev->next = te;
2706  AH->toc->prev = te;
2707  te->next = AH->toc;
2708 
2709  /* special processing immediately upon read for some items */
2710  if (strcmp(te->desc, "ENCODING") == 0)
2711  processEncodingEntry(AH, te);
2712  else if (strcmp(te->desc, "STDSTRINGS") == 0)
2713  processStdStringsEntry(AH, te);
2714  }
2715 }
struct _tocEntry * next
static void processEncodingEntry(ArchiveHandle *AH, TocEntry *te)
int DumpId
Definition: pg_backup.h:232
Oid tableoid
Definition: pg_backup.h:228
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
CatalogId catalogId
#define K_VERS_1_9
int ReadInt(ArchiveHandle *AH)
static void processStdStringsEntry(ArchiveHandle *AH, TocEntry *te)
teSection section
#define K_VERS_1_5
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
struct _tocEntry * toc
DumpId * dependencies
#define K_VERS_1_8
#define K_VERS_1_10
void * pg_realloc(void *ptr, size_t size)
Definition: fe_memutils.c:65
#define K_VERS_1_3
struct _tocEntry * prev
#define InvalidOid
Definition: postgres_ext.h:36
#define free(a)
Definition: header.h:65
char * ReadStr(ArchiveHandle *AH)
void exit_horribly(const char *modulename, const char *fmt,...)
#define K_VERS_1_6
void ahlog(ArchiveHandle *AH, int level, const char *fmt,...)
int i
#define K_VERS_1_11
static const char * modulename
ReadExtraTocPtrType ReadExtraTocPtr

◆ ReconnectToServer()

void ReconnectToServer ( ArchiveHandle AH,
const char *  dbname,
const char *  newUser 
)

Definition at line 82 of file pg_backup_db.c.

References _connectDB(), _archiveHandle::connection, dbname, PQdb(), PQfinish(), PQuser(), set_archive_cancel_info(), and username.

Referenced by _reconnectToDB().

83 {
84  PGconn *newConn;
85  const char *newdbname;
86  const char *newusername;
87 
88  if (!dbname)
89  newdbname = PQdb(AH->connection);
90  else
91  newdbname = dbname;
92 
93  if (!username)
94  newusername = PQuser(AH->connection);
95  else
96  newusername = username;
97 
98  newConn = _connectDB(AH, newdbname, newusername);
99 
100  /* Update ArchiveHandle's connCancel before closing old connection */
101  set_archive_cancel_info(AH, newConn);
102 
103  PQfinish(AH->connection);
104  AH->connection = newConn;
105 }
static PGconn * _connectDB(ArchiveHandle *AH, const char *newdbname, const char *newUser)
Definition: pg_backup_db.c:117
void PQfinish(PGconn *conn)
Definition: fe-connect.c:3638
char * PQuser(const PGconn *conn)
Definition: fe-connect.c:5991
static char * username
Definition: initdb.c:132
char * PQdb(const PGconn *conn)
Definition: fe-connect.c:5983
char * dbname
Definition: streamutil.c:42
void set_archive_cancel_info(ArchiveHandle *AH, PGconn *conn)
Definition: parallel.c:744

◆ StartRestoreBlob()

void StartRestoreBlob ( ArchiveHandle AH,
Oid  oid,
bool  drop 
)

Definition at line 1302 of file pg_backup_archiver.c.

References ahlog(), ahprintf(), _archiveHandle::blobCount, _archiveHandle::connection, DropBlobIfExists(), exit_horribly(), INV_WRITE, K_VERS_1_12, _archiveHandle::lo_buf_used, lo_create(), lo_open(), _archiveHandle::loFd, modulename, PQerrorMessage(), _archiveHandle::version, and _archiveHandle::writingBlob.

Referenced by _LoadBlobs().

1303 {
1304  bool old_blob_style = (AH->version < K_VERS_1_12);
1305  Oid loOid;
1306 
1307  AH->blobCount++;
1308 
1309  /* Initialize the LO Buffer */
1310  AH->lo_buf_used = 0;
1311 
1312  ahlog(AH, 1, "restoring large object with OID %u\n", oid);
1313 
1314  /* With an old archive we must do drop and create logic here */
1315  if (old_blob_style && drop)
1316  DropBlobIfExists(AH, oid);
1317 
1318  if (AH->connection)
1319  {
1320  if (old_blob_style)
1321  {
1322  loOid = lo_create(AH->connection, oid);
1323  if (loOid == 0 || loOid != oid)
1324  exit_horribly(modulename, "could not create large object %u: %s",
1325  oid, PQerrorMessage(AH->connection));
1326  }
1327  AH->loFd = lo_open(AH->connection, oid, INV_WRITE);
1328  if (AH->loFd == -1)
1329  exit_horribly(modulename, "could not open large object %u: %s",
1330  oid, PQerrorMessage(AH->connection));
1331  }
1332  else
1333  {
1334  if (old_blob_style)
1335  ahprintf(AH, "SELECT pg_catalog.lo_open(pg_catalog.lo_create('%u'), %d);\n",
1336  oid, INV_WRITE);
1337  else
1338  ahprintf(AH, "SELECT pg_catalog.lo_open('%u', %d);\n",
1339  oid, INV_WRITE);
1340  }
1341 
1342  AH->writingBlob = 1;
1343 }
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:6115
void DropBlobIfExists(ArchiveHandle *AH, Oid oid)
Definition: pg_backup_db.c:652
unsigned int Oid
Definition: postgres_ext.h:31
#define K_VERS_1_12
int lo_open(PGconn *conn, Oid lobjId, int mode)
Definition: fe-lobj.c:57
int ahprintf(ArchiveHandle *AH, const char *fmt,...)
Oid lo_create(PGconn *conn, Oid lobjId)
Definition: fe-lobj.c:504
#define INV_WRITE
Definition: libpq-fs.h:21
void exit_horribly(const char *modulename, const char *fmt,...)
void ahlog(ArchiveHandle *AH, int level, const char *fmt,...)
static const char * modulename

◆ StartRestoreBlobs()

void StartRestoreBlobs ( ArchiveHandle AH)

Definition at line 1260 of file pg_backup_archiver.c.

References ahprintf(), _archiveHandle::blobCount, _archiveHandle::connection, _archiveHandle::public, Archive::ropt, _restoreOptions::single_txn, and StartTransaction().

Referenced by _LoadBlobs().

1261 {
1262  RestoreOptions *ropt = AH->public.ropt;
1263 
1264  if (!ropt->single_txn)
1265  {
1266  if (AH->connection)
1267  StartTransaction(&AH->public);
1268  else
1269  ahprintf(AH, "BEGIN;\n\n");
1270  }
1271 
1272  AH->blobCount = 0;
1273 }
RestoreOptions * ropt
Definition: pg_backup.h:184
int ahprintf(ArchiveHandle *AH, const char *fmt,...)
static void StartTransaction(void)
Definition: xact.c:1796

◆ TocIDRequired()

teReqs TocIDRequired ( ArchiveHandle AH,
DumpId  id 
)

Definition at line 1903 of file pg_backup_archiver.c.

References getTocEntryByDumpId(), and _tocEntry::reqs.

Referenced by _tarPositionTo(), _tocEntryRequired(), and findDumpableDependencies().

1904 {
1905  TocEntry *te = getTocEntryByDumpId(AH, id);
1906 
1907  if (!te)
1908  return 0;
1909 
1910  return te->reqs;
1911 }
TocEntry * getTocEntryByDumpId(ArchiveHandle *AH, DumpId id)

◆ warn_or_exit_horribly()

void warn_or_exit_horribly ( ArchiveHandle AH,
const char *  modulename,
const char *  fmt,
  ... 
)

◆ WriteDataChunks()

void WriteDataChunks ( ArchiveHandle AH,
struct ParallelState pstate 
)

Definition at line 2415 of file pg_backup_archiver.c.

References ACT_DUMP, _tocEntry::dataDumper, DispatchJobForTocEntry(), mark_dump_job_done(), _tocEntry::next, ParallelState::numWorkers, REQ_DATA, _tocEntry::reqs, _archiveHandle::toc, WaitForWorkers(), WFW_ALL_IDLE, and WriteDataChunksForTocEntry().

Referenced by _CloseArchive().

2416 {
2417  TocEntry *te;
2418 
2419  for (te = AH->toc->next; te != AH->toc; te = te->next)
2420  {
2421  if (!te->dataDumper)
2422  continue;
2423 
2424  if ((te->reqs & REQ_DATA) == 0)
2425  continue;
2426 
2427  if (pstate && pstate->numWorkers > 1)
2428  {
2429  /*
2430  * If we are in a parallel backup, then we are always the master
2431  * process. Dispatch each data-transfer job to a worker.
2432  */
2433  DispatchJobForTocEntry(AH, pstate, te, ACT_DUMP,
2434  mark_dump_job_done, NULL);
2435  }
2436  else
2438  }
2439 
2440  /*
2441  * If parallel, wait for workers to finish.
2442  */
2443  if (pstate && pstate->numWorkers > 1)
2444  WaitForWorkers(AH, pstate, WFW_ALL_IDLE);
2445 }
struct _tocEntry * next
void DispatchJobForTocEntry(ArchiveHandle *AH, ParallelState *pstate, TocEntry *te, T_Action act, ParallelCompletionPtr callback, void *callback_data)
Definition: parallel.c:1229
DataDumperPtr dataDumper
struct _tocEntry * toc
void WaitForWorkers(ArchiveHandle *AH, ParallelState *pstate, WFW_WaitOption mode)
Definition: parallel.c:1477
void WriteDataChunksForTocEntry(ArchiveHandle *AH, TocEntry *te)
static void mark_dump_job_done(ArchiveHandle *AH, TocEntry *te, int status, void *callback_data)
int numWorkers
Definition: parallel.h:42

◆ WriteDataChunksForTocEntry()

void WriteDataChunksForTocEntry ( ArchiveHandle AH,
TocEntry te 
)

Definition at line 2470 of file pg_backup_archiver.c.

References _archiveHandle::currToc, _tocEntry::dataDumper, _tocEntry::dataDumperArg, _tocEntry::desc, _archiveHandle::EndBlobsPtr, _archiveHandle::EndDataPtr, _archiveHandle::StartBlobsPtr, and _archiveHandle::StartDataPtr.

Referenced by _WorkerJobDumpDirectory(), and WriteDataChunks().

2471 {
2472  StartDataPtrType startPtr;
2473  EndDataPtrType endPtr;
2474 
2475  AH->currToc = te;
2476 
2477  if (strcmp(te->desc, "BLOBS") == 0)
2478  {
2479  startPtr = AH->StartBlobsPtr;
2480  endPtr = AH->EndBlobsPtr;
2481  }
2482  else
2483  {
2484  startPtr = AH->StartDataPtr;
2485  endPtr = AH->EndDataPtr;
2486  }
2487 
2488  if (startPtr != NULL)
2489  (*startPtr) (AH, te);
2490 
2491  /*
2492  * The user-provided DataDumper routine needs to call AH->WriteData
2493  */
2494  te->dataDumper((Archive *) AH, te->dataDumperArg);
2495 
2496  if (endPtr != NULL)
2497  (*endPtr) (AH, te);
2498 
2499  AH->currToc = NULL;
2500 }
void * dataDumperArg
EndDataPtrType EndDataPtr
DataDumperPtr dataDumper
StartBlobsPtrType StartBlobsPtr
struct _tocEntry * currToc
StartDataPtrType StartDataPtr
void(* StartDataPtrType)(ArchiveHandle *AH, TocEntry *te)
void(* EndDataPtrType)(ArchiveHandle *AH, TocEntry *te)
EndBlobsPtrType EndBlobsPtr

◆ WriteHead()

void WriteHead ( ArchiveHandle AH)

Definition at line 3712 of file pg_backup_archiver.c.

References ARCHIVE_MAJOR, ARCHIVE_MINOR, ARCHIVE_REV, _archiveHandle::compression, _archiveHandle::connection, _archiveHandle::createDate, _archiveHandle::format, _archiveHandle::intSize, _archiveHandle::offSize, PQdb(), _archiveHandle::public, Archive::remoteVersionStr, tm, _archiveHandle::version, _archiveHandle::WriteBufPtr, _archiveHandle::WriteBytePtr, WriteInt(), and WriteStr().

Referenced by _CloseArchive().

3713 {
3714  struct tm crtm;
3715 
3716  AH->WriteBufPtr(AH, "PGDMP", 5); /* Magic code */
3717  AH->WriteBytePtr(AH, ARCHIVE_MAJOR(AH->version));
3718  AH->WriteBytePtr(AH, ARCHIVE_MINOR(AH->version));
3719  AH->WriteBytePtr(AH, ARCHIVE_REV(AH->version));
3720  AH->WriteBytePtr(AH, AH->intSize);
3721  AH->WriteBytePtr(AH, AH->offSize);
3722  AH->WriteBytePtr(AH, AH->format);
3723  WriteInt(AH, AH->compression);
3724  crtm = *localtime(&AH->createDate);
3725  WriteInt(AH, crtm.tm_sec);
3726  WriteInt(AH, crtm.tm_min);
3727  WriteInt(AH, crtm.tm_hour);
3728  WriteInt(AH, crtm.tm_mday);
3729  WriteInt(AH, crtm.tm_mon);
3730  WriteInt(AH, crtm.tm_year);
3731  WriteInt(AH, crtm.tm_isdst);
3732  WriteStr(AH, PQdb(AH->connection));
3733  WriteStr(AH, AH->public.remoteVersionStr);
3734  WriteStr(AH, PG_VERSION);
3735 }
WriteBufPtrType WriteBufPtr
static struct pg_tm tm
Definition: localtime.c:107
#define ARCHIVE_REV(version)
WriteBytePtrType WriteBytePtr
#define ARCHIVE_MINOR(version)
ArchiveFormat format
#define ARCHIVE_MAJOR(version)
char * PQdb(const PGconn *conn)
Definition: fe-connect.c:5983
size_t WriteInt(ArchiveHandle *AH, int i)
char * remoteVersionStr
Definition: pg_backup.h:187
size_t WriteStr(ArchiveHandle *AH, const char *c)

◆ WriteInt()

size_t WriteInt ( ArchiveHandle AH,
int  i 
)

Definition at line 1995 of file pg_backup_archiver.c.

References i, _archiveHandle::intSize, and _archiveHandle::WriteBytePtr.

Referenced by _CustomWriteFunc(), _EndBlob(), _EndBlobs(), _EndData(), _StartBlob(), _StartBlobs(), _StartData(), WriteHead(), WriteStr(), and WriteToc().

1996 {
1997  int b;
1998 
1999  /*
2000  * This is a bit yucky, but I don't want to make the binary format very
2001  * dependent on representation, and not knowing much about it, I write out
2002  * a sign byte. If you change this, don't forget to change the file
2003  * version #, and modify readInt to read the new format AS WELL AS the old
2004  * formats.
2005  */
2006 
2007  /* SIGN byte */
2008  if (i < 0)
2009  {
2010  AH->WriteBytePtr(AH, 1);
2011  i = -i;
2012  }
2013  else
2014  AH->WriteBytePtr(AH, 0);
2015 
2016  for (b = 0; b < AH->intSize; b++)
2017  {
2018  AH->WriteBytePtr(AH, i & 0xFF);
2019  i >>= 8;
2020  }
2021 
2022  return AH->intSize + 1;
2023 }
WriteBytePtrType WriteBytePtr
int i

◆ WriteOffset()

size_t WriteOffset ( ArchiveHandle ,
pgoff_t  ,
int   
)

Definition at line 1914 of file pg_backup_archiver.c.

References pgoff_t, and _archiveHandle::WriteBytePtr.

Referenced by _WriteExtraToc().

1915 {
1916  int off;
1917 
1918  /* Save the flag */
1919  AH->WriteBytePtr(AH, wasSet);
1920 
1921  /* Write out pgoff_t smallest byte first, prevents endian mismatch */
1922  for (off = 0; off < sizeof(pgoff_t); off++)
1923  {
1924  AH->WriteBytePtr(AH, o & 0xFF);
1925  o >>= 8;
1926  }
1927  return sizeof(pgoff_t) + 1;
1928 }
#define pgoff_t
Definition: win32_port.h:206

◆ WriteStr()

size_t WriteStr ( ArchiveHandle AH,
const char *  s 
)

Definition at line 2053 of file pg_backup_archiver.c.

References _archiveHandle::WriteBufPtr, and WriteInt().

Referenced by _WriteExtraToc(), WriteHead(), and WriteToc().

2054 {
2055  size_t res;
2056 
2057  if (c)
2058  {
2059  int len = strlen(c);
2060 
2061  res = WriteInt(AH, len);
2062  AH->WriteBufPtr(AH, c, len);
2063  res += len;
2064  }
2065  else
2066  res = WriteInt(AH, -1);
2067 
2068  return res;
2069 }
WriteBufPtrType WriteBufPtr
char * c
size_t WriteInt(ArchiveHandle *AH, int i)

◆ WriteTOC()

void void WriteTOC ( ArchiveHandle AH)

◆ WriteToc()

void WriteToc ( ArchiveHandle AH)

Definition at line 2503 of file pg_backup_archiver.c.

References _tocEntry::catalogId, _tocEntry::copyStmt, _tocEntry::dataDumper, _tocEntry::defn, _tocEntry::dependencies, _tocEntry::desc, _tocEntry::dropStmt, _tocEntry::dumpId, i, _tocEntry::nDeps, _tocEntry::next, CatalogId::oid, _tocEntry::owner, REQ_DATA, REQ_SCHEMA, REQ_SPECIAL, _tocEntry::reqs, _tocEntry::section, CatalogId::tableoid, _tocEntry::tablespace, _tocEntry::tag, _archiveHandle::toc, _tocEntry::withOids, _archiveHandle::WriteExtraTocPtr, WriteInt(), and WriteStr().

Referenced by _CloseArchive().

2504 {
2505  TocEntry *te;
2506  char workbuf[32];
2507  int tocCount;
2508  int i;
2509 
2510  /* count entries that will actually be dumped */
2511  tocCount = 0;
2512  for (te = AH->toc->next; te != AH->toc; te = te->next)
2513  {
2514  if ((te->reqs & (REQ_SCHEMA | REQ_DATA | REQ_SPECIAL)) != 0)
2515  tocCount++;
2516  }
2517 
2518  /* printf("%d TOC Entries to save\n", tocCount); */
2519 
2520  WriteInt(AH, tocCount);
2521 
2522  for (te = AH->toc->next; te != AH->toc; te = te->next)
2523  {
2524  if ((te->reqs & (REQ_SCHEMA | REQ_DATA | REQ_SPECIAL)) == 0)
2525  continue;
2526 
2527  WriteInt(AH, te->dumpId);
2528  WriteInt(AH, te->dataDumper ? 1 : 0);
2529 
2530  /* OID is recorded as a string for historical reasons */
2531  sprintf(workbuf, "%u", te->catalogId.tableoid);
2532  WriteStr(AH, workbuf);
2533  sprintf(workbuf, "%u", te->catalogId.oid);
2534  WriteStr(AH, workbuf);
2535 
2536  WriteStr(AH, te->tag);
2537  WriteStr(AH, te->desc);
2538  WriteInt(AH, te->section);
2539  WriteStr(AH, te->defn);
2540  WriteStr(AH, te->dropStmt);
2541  WriteStr(AH, te->copyStmt);
2542  WriteStr(AH, te->namespace);
2543  WriteStr(AH, te->tablespace);
2544  WriteStr(AH, te->owner);
2545  WriteStr(AH, te->withOids ? "true" : "false");
2546 
2547  /* Dump list of dependencies */
2548  for (i = 0; i < te->nDeps; i++)
2549  {
2550  sprintf(workbuf, "%d", te->dependencies[i]);
2551  WriteStr(AH, workbuf);
2552  }
2553  WriteStr(AH, NULL); /* Terminate List */
2554 
2555  if (AH->WriteExtraTocPtr)
2556  AH->WriteExtraTocPtr(AH, te);
2557  }
2558 }
struct _tocEntry * next
Oid tableoid
Definition: pg_backup.h:228
CatalogId catalogId
DataDumperPtr dataDumper
teSection section
struct _tocEntry * toc
DumpId * dependencies
size_t WriteInt(ArchiveHandle *AH, int i)
int i
size_t WriteStr(ArchiveHandle *AH, const char *c)
WriteExtraTocPtrType WriteExtraTocPtr