PostgreSQL Source Code  git master
pg_basebackup.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pg_basebackup.c - receive a base backup using streaming replication protocol
4  *
5  * Author: Magnus Hagander <magnus@hagander.net>
6  *
7  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
8  *
9  * IDENTIFICATION
10  * src/bin/pg_basebackup/pg_basebackup.c
11  *-------------------------------------------------------------------------
12  */
13 
14 #include "postgres_fe.h"
15 
16 #include <unistd.h>
17 #include <dirent.h>
18 #include <limits.h>
19 #include <sys/select.h>
20 #include <sys/stat.h>
21 #include <sys/wait.h>
22 #include <signal.h>
23 #include <time.h>
24 #ifdef HAVE_LIBZ
25 #include <zlib.h>
26 #endif
27 
28 #include "access/xlog_internal.h"
29 #include "backup/basebackup.h"
30 #include "bbstreamer.h"
31 #include "common/compression.h"
32 #include "common/file_perm.h"
33 #include "common/file_utils.h"
34 #include "common/logging.h"
35 #include "fe_utils/option_utils.h"
36 #include "fe_utils/recovery_gen.h"
37 #include "getopt_long.h"
38 #include "receivelog.h"
39 #include "streamutil.h"
40 
41 #define ERRCODE_DATA_CORRUPTED "XX001"
42 
43 typedef struct TablespaceListCell
44 {
49 
50 typedef struct TablespaceList
51 {
55 
56 typedef struct ArchiveStreamState
57 {
66 
67 typedef struct WriteTarState
68 {
72 
73 typedef struct WriteManifestState
74 {
76  FILE *file;
78 
79 typedef void (*WriteDataCallback) (size_t nbytes, char *buf,
80  void *callback_data);
81 
82 /*
83  * pg_xlog has been renamed to pg_wal in version 10. This version number
84  * should be compared with PQserverVersion().
85  */
86 #define MINIMUM_VERSION_FOR_PG_WAL 100000
87 
88 /*
89  * Temporary replication slots are supported from version 10.
90  */
91 #define MINIMUM_VERSION_FOR_TEMP_SLOTS 100000
92 
93 /*
94  * Backup manifests are supported from version 13.
95  */
96 #define MINIMUM_VERSION_FOR_MANIFESTS 130000
97 
98 /*
99  * Before v15, tar files received from the server will be improperly
100  * terminated.
101  */
102 #define MINIMUM_VERSION_FOR_TERMINATED_TARFILE 150000
103 
104 /*
105  * pg_wal/summaries exists beginning with version 17.
106  */
107 #define MINIMUM_VERSION_FOR_WAL_SUMMARIES 170000
108 
109 /*
110  * Different ways to include WAL
111  */
112 typedef enum
113 {
117 } IncludeWal;
118 
119 /*
120  * Different places to perform compression
121  */
122 typedef enum
123 {
128 
129 /* Global options */
130 static char *basedir = NULL;
131 static TablespaceList tablespace_dirs = {NULL, NULL};
132 static char *xlog_dir = NULL;
133 static char format = '\0'; /* p(lain)/t(ar) */
134 static char *label = "pg_basebackup base backup";
135 static bool noclean = false;
136 static bool checksum_failure = false;
137 static bool showprogress = false;
138 static bool estimatesize = true;
139 static int verbose = 0;
141 static bool fastcheckpoint = false;
142 static bool writerecoveryconf = false;
143 static bool do_sync = true;
144 static int standby_message_timeout = 10 * 1000; /* 10 sec = default */
146 static int32 maxrate = 0; /* no limit by default */
147 static char *replication_slot = NULL;
148 static bool temp_replication_slot = true;
149 static char *backup_target = NULL;
150 static bool create_slot = false;
151 static bool no_slot = false;
152 static bool verify_checksums = true;
153 static bool manifest = true;
154 static bool manifest_force_encode = false;
155 static char *manifest_checksums = NULL;
157 
158 static bool success = false;
159 static bool made_new_pgdata = false;
160 static bool found_existing_pgdata = false;
161 static bool made_new_xlogdir = false;
162 static bool found_existing_xlogdir = false;
163 static bool made_tablespace_dirs = false;
164 static bool found_tablespace_dirs = false;
165 
166 /* Progress indicators */
167 static uint64 totalsize_kb;
168 static uint64 totaldone;
169 static int tablespacecount;
170 static char *progress_filename = NULL;
171 
172 /* Pipe to communicate with background wal receiver process */
173 #ifndef WIN32
174 static int bgpipe[2] = {-1, -1};
175 #endif
176 
177 /* Handle to child process */
178 static pid_t bgchild = -1;
179 static bool in_log_streamer = false;
180 
181 /* Flag to indicate if child process exited unexpectedly */
182 static volatile sig_atomic_t bgchild_exited = false;
183 
184 /* End position for xlog streaming, empty string if unknown yet */
186 
187 #ifndef WIN32
188 static int has_xlogendptr = 0;
189 #else
190 static volatile LONG has_xlogendptr = 0;
191 #endif
192 
193 /* Contents of configuration file to be generated */
195 
196 /* Function headers */
197 static void usage(void);
198 static void verify_dir_is_empty_or_create(char *dirname, bool *created, bool *found);
199 static void progress_update_filename(const char *filename);
200 static void progress_report(int tablespacenum, bool force, bool finished);
201 
202 static bbstreamer *CreateBackupStreamer(char *archive_name, char *spclocation,
203  bbstreamer **manifest_inject_streamer_p,
204  bool is_recovery_guc_supported,
205  bool expect_unterminated_tarfile,
206  pg_compress_specification *compress);
207 static void ReceiveArchiveStreamChunk(size_t r, char *copybuf,
208  void *callback_data);
209 static char GetCopyDataByte(size_t r, char *copybuf, size_t *cursor);
210 static char *GetCopyDataString(size_t r, char *copybuf, size_t *cursor);
211 static uint64 GetCopyDataUInt64(size_t r, char *copybuf, size_t *cursor);
212 static void GetCopyDataEnd(size_t r, char *copybuf, size_t cursor);
213 static void ReportCopyDataParseError(size_t r, char *copybuf);
214 static void ReceiveTarFile(PGconn *conn, char *archive_name, char *spclocation,
215  bool tablespacenum, pg_compress_specification *compress);
216 static void ReceiveTarCopyChunk(size_t r, char *copybuf, void *callback_data);
217 static void ReceiveBackupManifest(PGconn *conn);
218 static void ReceiveBackupManifestChunk(size_t r, char *copybuf,
219  void *callback_data);
221 static void ReceiveBackupManifestInMemoryChunk(size_t r, char *copybuf,
222  void *callback_data);
223 static void BaseBackup(char *compression_algorithm, char *compression_detail,
224  CompressionLocation compressloc,
225  pg_compress_specification *client_compress,
226  char *incremental_manifest);
227 
228 static bool reached_end_position(XLogRecPtr segendpos, uint32 timeline,
229  bool segment_finished);
230 
231 static const char *get_tablespace_mapping(const char *dir);
232 static void tablespace_list_append(const char *arg);
233 
234 
235 static void
237 {
238  if (success || in_log_streamer)
239  return;
240 
241  if (!noclean && !checksum_failure)
242  {
243  if (made_new_pgdata)
244  {
245  pg_log_info("removing data directory \"%s\"", basedir);
246  if (!rmtree(basedir, true))
247  pg_log_error("failed to remove data directory");
248  }
249  else if (found_existing_pgdata)
250  {
251  pg_log_info("removing contents of data directory \"%s\"", basedir);
252  if (!rmtree(basedir, false))
253  pg_log_error("failed to remove contents of data directory");
254  }
255 
256  if (made_new_xlogdir)
257  {
258  pg_log_info("removing WAL directory \"%s\"", xlog_dir);
259  if (!rmtree(xlog_dir, true))
260  pg_log_error("failed to remove WAL directory");
261  }
262  else if (found_existing_xlogdir)
263  {
264  pg_log_info("removing contents of WAL directory \"%s\"", xlog_dir);
265  if (!rmtree(xlog_dir, false))
266  pg_log_error("failed to remove contents of WAL directory");
267  }
268  }
269  else
270  {
272  pg_log_info("data directory \"%s\" not removed at user's request", basedir);
273 
275  pg_log_info("WAL directory \"%s\" not removed at user's request", xlog_dir);
276  }
277 
279  pg_log_info("changes to tablespace directories will not be undone");
280 }
281 
282 static void
284 {
285  if (conn != NULL)
286  PQfinish(conn);
287 }
288 
289 #ifndef WIN32
290 /*
291  * If the bgchild exits prematurely and raises a SIGCHLD signal, we can abort
292  * processing rather than wait until the backup has finished and error out at
293  * that time. On Windows, we use a background thread which can communicate
294  * without the need for a signal handler.
295  */
296 static void
298 {
299  bgchild_exited = true;
300 }
301 
302 /*
303  * On windows, our background thread dies along with the process. But on
304  * Unix, if we have started a subprocess, we want to kill it off so it
305  * doesn't remain running trying to stream data.
306  */
307 static void
309 {
310  if (bgchild > 0 && !bgchild_exited)
311  kill(bgchild, SIGTERM);
312 }
313 #endif
314 
315 /*
316  * Split argument into old_dir and new_dir and append to tablespace mapping
317  * list.
318  */
319 static void
321 {
323  char *dst;
324  char *dst_ptr;
325  const char *arg_ptr;
326 
327  dst_ptr = dst = cell->old_dir;
328  for (arg_ptr = arg; *arg_ptr; arg_ptr++)
329  {
330  if (dst_ptr - dst >= MAXPGPATH)
331  pg_fatal("directory name too long");
332 
333  if (*arg_ptr == '\\' && *(arg_ptr + 1) == '=')
334  ; /* skip backslash escaping = */
335  else if (*arg_ptr == '=' && (arg_ptr == arg || *(arg_ptr - 1) != '\\'))
336  {
337  if (*cell->new_dir)
338  pg_fatal("multiple \"=\" signs in tablespace mapping");
339  else
340  dst = dst_ptr = cell->new_dir;
341  }
342  else
343  *dst_ptr++ = *arg_ptr;
344  }
345 
346  if (!*cell->old_dir || !*cell->new_dir)
347  pg_fatal("invalid tablespace mapping format \"%s\", must be \"OLDDIR=NEWDIR\"", arg);
348 
349  /*
350  * All tablespaces are created with absolute directories, so specifying a
351  * non-absolute path here would just never match, possibly confusing
352  * users. Since we don't know whether the remote side is Windows or not,
353  * and it might be different than the local side, permit any path that
354  * could be absolute under either set of rules.
355  *
356  * (There is little practical risk of confusion here, because someone
357  * running entirely on Linux isn't likely to have a relative path that
358  * begins with a backslash or something that looks like a drive
359  * specification. If they do, and they also incorrectly believe that a
360  * relative path is acceptable here, we'll silently fail to warn them of
361  * their mistake, and the -T option will just not get applied, same as if
362  * they'd specified -T for a nonexistent tablespace.)
363  */
364  if (!is_nonwindows_absolute_path(cell->old_dir) &&
366  pg_fatal("old directory is not an absolute path in tablespace mapping: %s",
367  cell->old_dir);
368 
369  if (!is_absolute_path(cell->new_dir))
370  pg_fatal("new directory is not an absolute path in tablespace mapping: %s",
371  cell->new_dir);
372 
373  /*
374  * Comparisons done with these values should involve similarly
375  * canonicalized path values. This is particularly sensitive on Windows
376  * where path values may not necessarily use Unix slashes.
377  */
378  canonicalize_path(cell->old_dir);
379  canonicalize_path(cell->new_dir);
380 
381  if (tablespace_dirs.tail)
382  tablespace_dirs.tail->next = cell;
383  else
384  tablespace_dirs.head = cell;
385  tablespace_dirs.tail = cell;
386 }
387 
388 
389 static void
390 usage(void)
391 {
392  printf(_("%s takes a base backup of a running PostgreSQL server.\n\n"),
393  progname);
394  printf(_("Usage:\n"));
395  printf(_(" %s [OPTION]...\n"), progname);
396  printf(_("\nOptions controlling the output:\n"));
397  printf(_(" -D, --pgdata=DIRECTORY receive base backup into directory\n"));
398  printf(_(" -F, --format=p|t output format (plain (default), tar)\n"));
399  printf(_(" -i, --incremental=OLDMANIFEST\n"
400  " take incremental backup\n"));
401  printf(_(" -r, --max-rate=RATE maximum transfer rate to transfer data directory\n"
402  " (in kB/s, or use suffix \"k\" or \"M\")\n"));
403  printf(_(" -R, --write-recovery-conf\n"
404  " write configuration for replication\n"));
405  printf(_(" -t, --target=TARGET[:DETAIL]\n"
406  " backup target (if other than client)\n"));
407  printf(_(" -T, --tablespace-mapping=OLDDIR=NEWDIR\n"
408  " relocate tablespace in OLDDIR to NEWDIR\n"));
409  printf(_(" --waldir=WALDIR location for the write-ahead log directory\n"));
410  printf(_(" -X, --wal-method=none|fetch|stream\n"
411  " include required WAL files with specified method\n"));
412  printf(_(" -z, --gzip compress tar output\n"));
413  printf(_(" -Z, --compress=[{client|server}-]METHOD[:DETAIL]\n"
414  " compress on client or server as specified\n"));
415  printf(_(" -Z, --compress=none do not compress tar output\n"));
416  printf(_("\nGeneral options:\n"));
417  printf(_(" -c, --checkpoint=fast|spread\n"
418  " set fast or spread (default) checkpointing\n"));
419  printf(_(" -C, --create-slot create replication slot\n"));
420  printf(_(" -l, --label=LABEL set backup label\n"));
421  printf(_(" -n, --no-clean do not clean up after errors\n"));
422  printf(_(" -N, --no-sync do not wait for changes to be written safely to disk\n"));
423  printf(_(" -P, --progress show progress information\n"));
424  printf(_(" -S, --slot=SLOTNAME replication slot to use\n"));
425  printf(_(" -v, --verbose output verbose messages\n"));
426  printf(_(" -V, --version output version information, then exit\n"));
427  printf(_(" --manifest-checksums=SHA{224,256,384,512}|CRC32C|NONE\n"
428  " use algorithm for manifest checksums\n"));
429  printf(_(" --manifest-force-encode\n"
430  " hex encode all file names in manifest\n"));
431  printf(_(" --no-estimate-size do not estimate backup size in server side\n"));
432  printf(_(" --no-manifest suppress generation of backup manifest\n"));
433  printf(_(" --no-slot prevent creation of temporary replication slot\n"));
434  printf(_(" --no-verify-checksums\n"
435  " do not verify checksums\n"));
436  printf(_(" --sync-method=METHOD\n"
437  " set method for syncing files to disk\n"));
438  printf(_(" -?, --help show this help, then exit\n"));
439  printf(_("\nConnection options:\n"));
440  printf(_(" -d, --dbname=CONNSTR connection string\n"));
441  printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
442  printf(_(" -p, --port=PORT database server port number\n"));
443  printf(_(" -s, --status-interval=INTERVAL\n"
444  " time between status packets sent to server (in seconds)\n"));
445  printf(_(" -U, --username=NAME connect as specified database user\n"));
446  printf(_(" -w, --no-password never prompt for password\n"));
447  printf(_(" -W, --password force password prompt (should happen automatically)\n"));
448  printf(_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
449  printf(_("%s home page: <%s>\n"), PACKAGE_NAME, PACKAGE_URL);
450 }
451 
452 
453 /*
454  * Called in the background process every time data is received.
455  * On Unix, we check to see if there is any data on our pipe
456  * (which would mean we have a stop position), and if it is, check if
457  * it is time to stop.
458  * On Windows, we are in a single process, so we can just check if it's
459  * time to stop.
460  */
461 static bool
463  bool segment_finished)
464 {
465  if (!has_xlogendptr)
466  {
467 #ifndef WIN32
468  fd_set fds;
469  struct timeval tv = {0};
470  int r;
471 
472  /*
473  * Don't have the end pointer yet - check our pipe to see if it has
474  * been sent yet.
475  */
476  FD_ZERO(&fds);
477  FD_SET(bgpipe[0], &fds);
478 
479  r = select(bgpipe[0] + 1, &fds, NULL, NULL, &tv);
480  if (r == 1)
481  {
482  char xlogend[64] = {0};
483  uint32 hi,
484  lo;
485 
486  r = read(bgpipe[0], xlogend, sizeof(xlogend) - 1);
487  if (r < 0)
488  pg_fatal("could not read from ready pipe: %m");
489 
490  if (sscanf(xlogend, "%X/%X", &hi, &lo) != 2)
491  pg_fatal("could not parse write-ahead log location \"%s\"",
492  xlogend);
493  xlogendptr = ((uint64) hi) << 32 | lo;
494  has_xlogendptr = 1;
495 
496  /*
497  * Fall through to check if we've reached the point further
498  * already.
499  */
500  }
501  else
502  {
503  /*
504  * No data received on the pipe means we don't know the end
505  * position yet - so just say it's not time to stop yet.
506  */
507  return false;
508  }
509 #else
510 
511  /*
512  * On win32, has_xlogendptr is set by the main thread, so if it's not
513  * set here, we just go back and wait until it shows up.
514  */
515  return false;
516 #endif
517  }
518 
519  /*
520  * At this point we have an end pointer, so compare it to the current
521  * position to figure out if it's time to stop.
522  */
523  if (segendpos >= xlogendptr)
524  return true;
525 
526  /*
527  * Have end pointer, but haven't reached it yet - so tell the caller to
528  * keep streaming.
529  */
530  return false;
531 }
532 
533 typedef struct
534 {
537  char xlog[MAXPGPATH]; /* directory or tarfile depending on mode */
539  int timeline;
543 
544 static int
546 {
547  StreamCtl stream = {0};
548 
549  in_log_streamer = true;
550 
551  stream.startpos = param->startptr;
552  stream.timeline = param->timeline;
553  stream.sysidentifier = param->sysidentifier;
555 #ifndef WIN32
556  stream.stop_socket = bgpipe[0];
557 #else
558  stream.stop_socket = PGINVALID_SOCKET;
559 #endif
561  stream.synchronous = false;
562  /* fsync happens at the end of pg_basebackup for all data */
563  stream.do_sync = false;
564  stream.mark_done = true;
565  stream.partial_suffix = NULL;
567  if (format == 'p')
568  stream.walmethod = CreateWalDirectoryMethod(param->xlog,
570  stream.do_sync);
571  else
572  stream.walmethod = CreateWalTarMethod(param->xlog,
573  param->wal_compress_algorithm,
574  param->wal_compress_level,
575  stream.do_sync);
576 
577  if (!ReceiveXlogStream(param->bgconn, &stream))
578  {
579  /*
580  * Any errors will already have been reported in the function process,
581  * but we need to tell the parent that we didn't shutdown in a nice
582  * way.
583  */
584 #ifdef WIN32
585  /*
586  * In order to signal the main thread of an ungraceful exit we set the
587  * same flag that we use on Unix to signal SIGCHLD.
588  */
589  bgchild_exited = true;
590 #endif
591  return 1;
592  }
593 
594  if (!stream.walmethod->ops->finish(stream.walmethod))
595  {
596  pg_log_error("could not finish writing WAL files: %m");
597 #ifdef WIN32
598  bgchild_exited = true;
599 #endif
600  return 1;
601  }
602 
603  PQfinish(param->bgconn);
604 
605  stream.walmethod->ops->free(stream.walmethod);
606 
607  return 0;
608 }
609 
610 /*
611  * Initiate background process for receiving xlog during the backup.
612  * The background stream will use its own database connection so we can
613  * stream the logfile in parallel with the backups.
614  */
615 static void
616 StartLogStreamer(char *startpos, uint32 timeline, char *sysidentifier,
617  pg_compress_algorithm wal_compress_algorithm,
618  int wal_compress_level)
619 {
620  logstreamer_param *param;
621  uint32 hi,
622  lo;
623  char statusdir[MAXPGPATH];
624 
625  param = pg_malloc0(sizeof(logstreamer_param));
626  param->timeline = timeline;
627  param->sysidentifier = sysidentifier;
628  param->wal_compress_algorithm = wal_compress_algorithm;
629  param->wal_compress_level = wal_compress_level;
630 
631  /* Convert the starting position */
632  if (sscanf(startpos, "%X/%X", &hi, &lo) != 2)
633  pg_fatal("could not parse write-ahead log location \"%s\"",
634  startpos);
635  param->startptr = ((uint64) hi) << 32 | lo;
636  /* Round off to even segment position */
637  param->startptr -= XLogSegmentOffset(param->startptr, WalSegSz);
638 
639 #ifndef WIN32
640  /* Create our background pipe */
641  if (pipe(bgpipe) < 0)
642  pg_fatal("could not create pipe for background process: %m");
643 #endif
644 
645  /* Get a second connection */
646  param->bgconn = GetConnection();
647  if (!param->bgconn)
648  /* Error message already written in GetConnection() */
649  exit(1);
650 
651  /* In post-10 cluster, pg_xlog has been renamed to pg_wal */
652  snprintf(param->xlog, sizeof(param->xlog), "%s/%s",
653  basedir,
655  "pg_xlog" : "pg_wal");
656 
657  /* Temporary replication slots are only supported in 10 and newer */
659  temp_replication_slot = false;
660 
661  /*
662  * Create replication slot if requested
663  */
665  replication_slot = psprintf("pg_basebackup_%u",
666  (unsigned int) PQbackendPID(param->bgconn));
668  {
669  if (!CreateReplicationSlot(param->bgconn, replication_slot, NULL,
670  temp_replication_slot, true, true, false, false))
671  exit(1);
672 
673  if (verbose)
674  {
676  pg_log_info("created temporary replication slot \"%s\"",
678  else
679  pg_log_info("created replication slot \"%s\"",
681  }
682  }
683 
684  if (format == 'p')
685  {
686  /*
687  * Create pg_wal/archive_status or pg_xlog/archive_status (and thus
688  * pg_wal or pg_xlog) depending on the target server so we can write
689  * to basedir/pg_wal or basedir/pg_xlog as the directory entry in the
690  * tar file may arrive later.
691  */
692  snprintf(statusdir, sizeof(statusdir), "%s/%s/archive_status",
693  basedir,
695  "pg_xlog" : "pg_wal");
696 
697  if (pg_mkdir_p(statusdir, pg_dir_create_mode) != 0 && errno != EEXIST)
698  pg_fatal("could not create directory \"%s\": %m", statusdir);
699 
700  /*
701  * For newer server versions, likewise create pg_wal/summaries
702  */
704  {
705  char summarydir[MAXPGPATH];
706 
707  snprintf(summarydir, sizeof(summarydir), "%s/%s/summaries",
708  basedir, "pg_wal");
709 
710  if (pg_mkdir_p(summarydir, pg_dir_create_mode) != 0 &&
711  errno != EEXIST)
712  pg_fatal("could not create directory \"%s\": %m", summarydir);
713  }
714  }
715 
716  /*
717  * Start a child process and tell it to start streaming. On Unix, this is
718  * a fork(). On Windows, we create a thread.
719  */
720 #ifndef WIN32
721  bgchild = fork();
722  if (bgchild == 0)
723  {
724  /* in child process */
725  exit(LogStreamerMain(param));
726  }
727  else if (bgchild < 0)
728  pg_fatal("could not create background process: %m");
729 
730  /*
731  * Else we are in the parent process and all is well.
732  */
733  atexit(kill_bgchild_atexit);
734 #else /* WIN32 */
735  bgchild = _beginthreadex(NULL, 0, (void *) LogStreamerMain, param, 0, NULL);
736  if (bgchild == 0)
737  pg_fatal("could not create background thread: %m");
738 #endif
739 }
740 
741 /*
742  * Verify that the given directory exists and is empty. If it does not
743  * exist, it is created. If it exists but is not empty, an error will
744  * be given and the process ended.
745  */
746 static void
747 verify_dir_is_empty_or_create(char *dirname, bool *created, bool *found)
748 {
749  switch (pg_check_dir(dirname))
750  {
751  case 0:
752 
753  /*
754  * Does not exist, so create
755  */
756  if (pg_mkdir_p(dirname, pg_dir_create_mode) == -1)
757  pg_fatal("could not create directory \"%s\": %m", dirname);
758  if (created)
759  *created = true;
760  return;
761  case 1:
762 
763  /*
764  * Exists, empty
765  */
766  if (found)
767  *found = true;
768  return;
769  case 2:
770  case 3:
771  case 4:
772 
773  /*
774  * Exists, not empty
775  */
776  pg_fatal("directory \"%s\" exists but is not empty", dirname);
777  case -1:
778 
779  /*
780  * Access problem
781  */
782  pg_fatal("could not access directory \"%s\": %m", dirname);
783  }
784 }
785 
786 /*
787  * Callback to update our notion of the current filename.
788  *
789  * No other code should modify progress_filename!
790  */
791 static void
793 {
794  /* We needn't maintain this variable if not doing verbose reports. */
795  if (showprogress && verbose)
796  {
798  if (filename)
800  else
801  progress_filename = NULL;
802  }
803 }
804 
805 /*
806  * Print a progress report based on the global variables. If verbose output
807  * is enabled, also print the current file name.
808  *
809  * Progress report is written at maximum once per second, unless the force
810  * parameter is set to true.
811  *
812  * If finished is set to true, this is the last progress report. The cursor
813  * is moved to the next line.
814  */
815 static void
816 progress_report(int tablespacenum, bool force, bool finished)
817 {
818  int percent;
819  char totaldone_str[32];
820  char totalsize_str[32];
821  pg_time_t now;
822 
823  if (!showprogress)
824  return;
825 
826  now = time(NULL);
827  if (now == last_progress_report && !force && !finished)
828  return; /* Max once per second */
829 
831  percent = totalsize_kb ? (int) ((totaldone / 1024) * 100 / totalsize_kb) : 0;
832 
833  /*
834  * Avoid overflowing past 100% or the full size. This may make the total
835  * size number change as we approach the end of the backup (the estimate
836  * will always be wrong if WAL is included), but that's better than having
837  * the done column be bigger than the total.
838  */
839  if (percent > 100)
840  percent = 100;
841  if (totaldone / 1024 > totalsize_kb)
842  totalsize_kb = totaldone / 1024;
843 
844  snprintf(totaldone_str, sizeof(totaldone_str), UINT64_FORMAT,
845  totaldone / 1024);
846  snprintf(totalsize_str, sizeof(totalsize_str), UINT64_FORMAT, totalsize_kb);
847 
848 #define VERBOSE_FILENAME_LENGTH 35
849  if (verbose)
850  {
851  if (!progress_filename)
852 
853  /*
854  * No filename given, so clear the status line (used for last
855  * call)
856  */
857  fprintf(stderr,
858  ngettext("%*s/%s kB (100%%), %d/%d tablespace %*s",
859  "%*s/%s kB (100%%), %d/%d tablespaces %*s",
861  (int) strlen(totalsize_str),
862  totaldone_str, totalsize_str,
863  tablespacenum, tablespacecount,
864  VERBOSE_FILENAME_LENGTH + 5, "");
865  else
866  {
867  bool truncate = (strlen(progress_filename) > VERBOSE_FILENAME_LENGTH);
868 
869  fprintf(stderr,
870  ngettext("%*s/%s kB (%d%%), %d/%d tablespace (%s%-*.*s)",
871  "%*s/%s kB (%d%%), %d/%d tablespaces (%s%-*.*s)",
873  (int) strlen(totalsize_str),
874  totaldone_str, totalsize_str, percent,
875  tablespacenum, tablespacecount,
876  /* Prefix with "..." if we do leading truncation */
877  truncate ? "..." : "",
880  /* Truncate filename at beginning if it's too long */
882  }
883  }
884  else
885  fprintf(stderr,
886  ngettext("%*s/%s kB (%d%%), %d/%d tablespace",
887  "%*s/%s kB (%d%%), %d/%d tablespaces",
889  (int) strlen(totalsize_str),
890  totaldone_str, totalsize_str, percent,
891  tablespacenum, tablespacecount);
892 
893  /*
894  * Stay on the same line if reporting to a terminal and we're not done
895  * yet.
896  */
897  fputc((!finished && isatty(fileno(stderr))) ? '\r' : '\n', stderr);
898 }
899 
900 static int32
901 parse_max_rate(char *src)
902 {
903  double result;
904  char *after_num;
905  char *suffix = NULL;
906 
907  errno = 0;
908  result = strtod(src, &after_num);
909  if (src == after_num)
910  pg_fatal("transfer rate \"%s\" is not a valid value", src);
911  if (errno != 0)
912  pg_fatal("invalid transfer rate \"%s\": %m", src);
913 
914  if (result <= 0)
915  {
916  /*
917  * Reject obviously wrong values here.
918  */
919  pg_fatal("transfer rate must be greater than zero");
920  }
921 
922  /*
923  * Evaluate suffix, after skipping over possible whitespace. Lack of
924  * suffix means kilobytes.
925  */
926  while (*after_num != '\0' && isspace((unsigned char) *after_num))
927  after_num++;
928 
929  if (*after_num != '\0')
930  {
931  suffix = after_num;
932  if (*after_num == 'k')
933  {
934  /* kilobyte is the expected unit. */
935  after_num++;
936  }
937  else if (*after_num == 'M')
938  {
939  after_num++;
940  result *= 1024.0;
941  }
942  }
943 
944  /* The rest can only consist of white space. */
945  while (*after_num != '\0' && isspace((unsigned char) *after_num))
946  after_num++;
947 
948  if (*after_num != '\0')
949  pg_fatal("invalid --max-rate unit: \"%s\"", suffix);
950 
951  /* Valid integer? */
952  if ((uint64) result != (uint64) ((uint32) result))
953  pg_fatal("transfer rate \"%s\" exceeds integer range", src);
954 
955  /*
956  * The range is checked on the server side too, but avoid the server
957  * connection if a nonsensical value was passed.
958  */
959  if (result < MAX_RATE_LOWER || result > MAX_RATE_UPPER)
960  pg_fatal("transfer rate \"%s\" is out of range", src);
961 
962  return (int32) result;
963 }
964 
965 /*
966  * Basic parsing of a value specified for -Z/--compress.
967  *
968  * We're not concerned here with understanding exactly what behavior the
969  * user wants, but we do need to know whether the user is requesting client
970  * or server side compression or leaving it unspecified, and we need to
971  * separate the name of the compression algorithm from the detail string.
972  *
973  * For instance, if the user writes --compress client-lz4:6, we want to
974  * separate that into (a) client-side compression, (b) algorithm "lz4",
975  * and (c) detail "6". Note, however, that all the client/server prefix is
976  * optional, and so is the detail. The algorithm name is required, unless
977  * the whole string is an integer, in which case we assume "gzip" as the
978  * algorithm and use the integer as the detail.
979  *
980  * We're not concerned with validation at this stage, so if the user writes
981  * --compress client-turkey:sandwich, the requested algorithm is "turkey"
982  * and the detail string is "sandwich". We'll sort out whether that's legal
983  * at a later stage.
984  */
985 static void
986 backup_parse_compress_options(char *option, char **algorithm, char **detail,
987  CompressionLocation *locationres)
988 {
989  /*
990  * Strip off any "client-" or "server-" prefix, calculating the location.
991  */
992  if (strncmp(option, "server-", 7) == 0)
993  {
994  *locationres = COMPRESS_LOCATION_SERVER;
995  option += 7;
996  }
997  else if (strncmp(option, "client-", 7) == 0)
998  {
999  *locationres = COMPRESS_LOCATION_CLIENT;
1000  option += 7;
1001  }
1002  else
1003  *locationres = COMPRESS_LOCATION_UNSPECIFIED;
1004 
1005  /* fallback to the common parsing for the algorithm and detail */
1006  parse_compress_options(option, algorithm, detail);
1007 }
1008 
1009 /*
1010  * Read a stream of COPY data and invoke the provided callback for each
1011  * chunk.
1012  */
1013 static void
1015  void *callback_data)
1016 {
1017  PGresult *res;
1018 
1019  /* Get the COPY data stream. */
1020  res = PQgetResult(conn);
1022  pg_fatal("could not get COPY data stream: %s",
1023  PQerrorMessage(conn));
1024  PQclear(res);
1025 
1026  /* Loop over chunks until done. */
1027  while (1)
1028  {
1029  int r;
1030  char *copybuf;
1031 
1032  r = PQgetCopyData(conn, &copybuf, 0);
1033  if (r == -1)
1034  {
1035  /* End of chunk. */
1036  break;
1037  }
1038  else if (r == -2)
1039  pg_fatal("could not read COPY data: %s",
1040  PQerrorMessage(conn));
1041 
1042  if (bgchild_exited)
1043  pg_fatal("background process terminated unexpectedly");
1044 
1045  (*callback) (r, copybuf, callback_data);
1046 
1047  PQfreemem(copybuf);
1048  }
1049 }
1050 
1051 /*
1052  * Figure out what to do with an archive received from the server based on
1053  * the options selected by the user. We may just write the results directly
1054  * to a file, or we might compress first, or we might extract the tar file
1055  * and write each member separately. This function doesn't do any of that
1056  * directly, but it works out what kind of bbstreamer we need to create so
1057  * that the right stuff happens when, down the road, we actually receive
1058  * the data.
1059  */
1060 static bbstreamer *
1061 CreateBackupStreamer(char *archive_name, char *spclocation,
1062  bbstreamer **manifest_inject_streamer_p,
1063  bool is_recovery_guc_supported,
1064  bool expect_unterminated_tarfile,
1065  pg_compress_specification *compress)
1066 {
1067  bbstreamer *streamer = NULL;
1068  bbstreamer *manifest_inject_streamer = NULL;
1069  bool inject_manifest;
1070  bool is_tar,
1071  is_tar_gz,
1072  is_tar_lz4,
1073  is_tar_zstd,
1074  is_compressed_tar;
1075  bool must_parse_archive;
1076  int archive_name_len = strlen(archive_name);
1077 
1078  /*
1079  * Normally, we emit the backup manifest as a separate file, but when
1080  * we're writing a tarfile to stdout, we don't have that option, so
1081  * include it in the one tarfile we've got.
1082  */
1083  inject_manifest = (format == 't' && strcmp(basedir, "-") == 0 && manifest);
1084 
1085  /* Is this a tar archive? */
1086  is_tar = (archive_name_len > 4 &&
1087  strcmp(archive_name + archive_name_len - 4, ".tar") == 0);
1088 
1089  /* Is this a .tar.gz archive? */
1090  is_tar_gz = (archive_name_len > 7 &&
1091  strcmp(archive_name + archive_name_len - 7, ".tar.gz") == 0);
1092 
1093  /* Is this a .tar.lz4 archive? */
1094  is_tar_lz4 = (archive_name_len > 8 &&
1095  strcmp(archive_name + archive_name_len - 8, ".tar.lz4") == 0);
1096 
1097  /* Is this a .tar.zst archive? */
1098  is_tar_zstd = (archive_name_len > 8 &&
1099  strcmp(archive_name + archive_name_len - 8, ".tar.zst") == 0);
1100 
1101  /* Is this any kind of compressed tar? */
1102  is_compressed_tar = is_tar_gz || is_tar_lz4 || is_tar_zstd;
1103 
1104  /*
1105  * Injecting the manifest into a compressed tar file would be possible if
1106  * we decompressed it, parsed the tarfile, generated a new tarfile, and
1107  * recompressed it, but compressing and decompressing multiple times just
1108  * to inject the manifest seems inefficient enough that it's probably not
1109  * what the user wants. So, instead, reject the request and tell the user
1110  * to specify something more reasonable.
1111  */
1112  if (inject_manifest && is_compressed_tar)
1113  {
1114  pg_log_error("cannot inject manifest into a compressed tar file");
1115  pg_log_error_hint("Use client-side compression, send the output to a directory rather than standard output, or use %s.",
1116  "--no-manifest");
1117  exit(1);
1118  }
1119 
1120  /*
1121  * We have to parse the archive if (1) we're suppose to extract it, or if
1122  * (2) we need to inject backup_manifest or recovery configuration into
1123  * it. However, we only know how to parse tar archives.
1124  */
1125  must_parse_archive = (format == 'p' || inject_manifest ||
1126  (spclocation == NULL && writerecoveryconf));
1127 
1128  /* At present, we only know how to parse tar archives. */
1129  if (must_parse_archive && !is_tar && !is_compressed_tar)
1130  {
1131  pg_log_error("cannot parse archive \"%s\"", archive_name);
1132  pg_log_error_detail("Only tar archives can be parsed.");
1133  if (format == 'p')
1134  pg_log_error_detail("Plain format requires pg_basebackup to parse the archive.");
1135  if (inject_manifest)
1136  pg_log_error_detail("Using - as the output directory requires pg_basebackup to parse the archive.");
1137  if (writerecoveryconf)
1138  pg_log_error_detail("The -R option requires pg_basebackup to parse the archive.");
1139  exit(1);
1140  }
1141 
1142  if (format == 'p')
1143  {
1144  const char *directory;
1145 
1146  /*
1147  * In plain format, we must extract the archive. The data for the main
1148  * tablespace will be written to the base directory, and the data for
1149  * other tablespaces will be written to the directory where they're
1150  * located on the server, after applying any user-specified tablespace
1151  * mappings.
1152  *
1153  * In the case of an in-place tablespace, spclocation will be a
1154  * relative path. We just convert it to an absolute path by prepending
1155  * basedir.
1156  */
1157  if (spclocation == NULL)
1158  directory = basedir;
1159  else if (!is_absolute_path(spclocation))
1160  directory = psprintf("%s/%s", basedir, spclocation);
1161  else
1162  directory = get_tablespace_mapping(spclocation);
1166  }
1167  else
1168  {
1169  FILE *archive_file;
1170  char archive_filename[MAXPGPATH];
1171 
1172  /*
1173  * In tar format, we just write the archive without extracting it.
1174  * Normally, we write it to the archive name provided by the caller,
1175  * but when the base directory is "-" that means we need to write to
1176  * standard output.
1177  */
1178  if (strcmp(basedir, "-") == 0)
1179  {
1180  snprintf(archive_filename, sizeof(archive_filename), "-");
1181  archive_file = stdout;
1182  }
1183  else
1184  {
1185  snprintf(archive_filename, sizeof(archive_filename),
1186  "%s/%s", basedir, archive_name);
1187  archive_file = NULL;
1188  }
1189 
1190  if (compress->algorithm == PG_COMPRESSION_NONE)
1191  streamer = bbstreamer_plain_writer_new(archive_filename,
1192  archive_file);
1193  else if (compress->algorithm == PG_COMPRESSION_GZIP)
1194  {
1195  strlcat(archive_filename, ".gz", sizeof(archive_filename));
1196  streamer = bbstreamer_gzip_writer_new(archive_filename,
1197  archive_file, compress);
1198  }
1199  else if (compress->algorithm == PG_COMPRESSION_LZ4)
1200  {
1201  strlcat(archive_filename, ".lz4", sizeof(archive_filename));
1202  streamer = bbstreamer_plain_writer_new(archive_filename,
1203  archive_file);
1204  streamer = bbstreamer_lz4_compressor_new(streamer, compress);
1205  }
1206  else if (compress->algorithm == PG_COMPRESSION_ZSTD)
1207  {
1208  strlcat(archive_filename, ".zst", sizeof(archive_filename));
1209  streamer = bbstreamer_plain_writer_new(archive_filename,
1210  archive_file);
1211  streamer = bbstreamer_zstd_compressor_new(streamer, compress);
1212  }
1213  else
1214  {
1215  Assert(false); /* not reachable */
1216  }
1217 
1218  /*
1219  * If we need to parse the archive for whatever reason, then we'll
1220  * also need to re-archive, because, if the output format is tar, the
1221  * only point of parsing the archive is to be able to inject stuff
1222  * into it.
1223  */
1224  if (must_parse_archive)
1225  streamer = bbstreamer_tar_archiver_new(streamer);
1226  progress_update_filename(archive_filename);
1227  }
1228 
1229  /*
1230  * If we're supposed to inject the backup manifest into the results, it
1231  * should be done here, so that the file content can be injected directly,
1232  * without worrying about the details of the tar format.
1233  */
1234  if (inject_manifest)
1235  manifest_inject_streamer = streamer;
1236 
1237  /*
1238  * If this is the main tablespace and we're supposed to write recovery
1239  * information, arrange to do that.
1240  */
1241  if (spclocation == NULL && writerecoveryconf)
1242  {
1243  Assert(must_parse_archive);
1244  streamer = bbstreamer_recovery_injector_new(streamer,
1245  is_recovery_guc_supported,
1247  }
1248 
1249  /*
1250  * If we're doing anything that involves understanding the contents of the
1251  * archive, we'll need to parse it. If not, we can skip parsing it, but
1252  * old versions of the server send improperly terminated tarfiles, so if
1253  * we're talking to such a server we'll need to add the terminator here.
1254  */
1255  if (must_parse_archive)
1256  streamer = bbstreamer_tar_parser_new(streamer);
1257  else if (expect_unterminated_tarfile)
1258  streamer = bbstreamer_tar_terminator_new(streamer);
1259 
1260  /*
1261  * If the user has requested a server compressed archive along with
1262  * archive extraction at client then we need to decompress it.
1263  */
1264  if (format == 'p')
1265  {
1266  if (is_tar_gz)
1267  streamer = bbstreamer_gzip_decompressor_new(streamer);
1268  else if (is_tar_lz4)
1269  streamer = bbstreamer_lz4_decompressor_new(streamer);
1270  else if (is_tar_zstd)
1271  streamer = bbstreamer_zstd_decompressor_new(streamer);
1272  }
1273 
1274  /* Return the results. */
1275  *manifest_inject_streamer_p = manifest_inject_streamer;
1276  return streamer;
1277 }
1278 
1279 /*
1280  * Receive all of the archives the server wants to send - and the backup
1281  * manifest if present - as a single COPY stream.
1282  */
1283 static void
1285 {
1287 
1288  /* Set up initial state. */
1289  memset(&state, 0, sizeof(state));
1290  state.tablespacenum = -1;
1291  state.compress = compress;
1292 
1293  /* All the real work happens in ReceiveArchiveStreamChunk. */
1295 
1296  /* If we wrote the backup manifest to a file, close the file. */
1297  if (state.manifest_file !=NULL)
1298  {
1299  fclose(state.manifest_file);
1300  state.manifest_file = NULL;
1301  }
1302 
1303  /*
1304  * If we buffered the backup manifest in order to inject it into the
1305  * output tarfile, do that now.
1306  */
1307  if (state.manifest_inject_streamer != NULL &&
1308  state.manifest_buffer != NULL)
1309  {
1310  bbstreamer_inject_file(state.manifest_inject_streamer,
1311  "backup_manifest",
1312  state.manifest_buffer->data,
1313  state.manifest_buffer->len);
1314  destroyPQExpBuffer(state.manifest_buffer);
1315  state.manifest_buffer = NULL;
1316  }
1317 
1318  /* If there's still an archive in progress, end processing. */
1319  if (state.streamer != NULL)
1320  {
1321  bbstreamer_finalize(state.streamer);
1322  bbstreamer_free(state.streamer);
1323  state.streamer = NULL;
1324  }
1325 }
1326 
1327 /*
1328  * Receive one chunk of data sent by the server as part of a single COPY
1329  * stream that includes all archives and the manifest.
1330  */
1331 static void
1332 ReceiveArchiveStreamChunk(size_t r, char *copybuf, void *callback_data)
1333 {
1334  ArchiveStreamState *state = callback_data;
1335  size_t cursor = 0;
1336 
1337  /* Each CopyData message begins with a type byte. */
1338  switch (GetCopyDataByte(r, copybuf, &cursor))
1339  {
1340  case 'n':
1341  {
1342  /* New archive. */
1343  char *archive_name;
1344  char *spclocation;
1345 
1346  /*
1347  * We force a progress report at the end of each tablespace. A
1348  * new tablespace starts when the previous one ends, except in
1349  * the case of the very first one.
1350  */
1351  if (++state->tablespacenum > 0)
1352  progress_report(state->tablespacenum, true, false);
1353 
1354  /* Sanity check. */
1355  if (state->manifest_buffer != NULL ||
1356  state->manifest_file !=NULL)
1357  pg_fatal("archives must precede manifest");
1358 
1359  /* Parse the rest of the CopyData message. */
1360  archive_name = GetCopyDataString(r, copybuf, &cursor);
1361  spclocation = GetCopyDataString(r, copybuf, &cursor);
1363 
1364  /*
1365  * Basic sanity checks on the archive name: it shouldn't be
1366  * empty, it shouldn't start with a dot, and it shouldn't
1367  * contain a path separator.
1368  */
1369  if (archive_name[0] == '\0' || archive_name[0] == '.' ||
1370  strchr(archive_name, '/') != NULL ||
1371  strchr(archive_name, '\\') != NULL)
1372  pg_fatal("invalid archive name: \"%s\"",
1373  archive_name);
1374 
1375  /*
1376  * An empty spclocation is treated as NULL. We expect this
1377  * case to occur for the data directory itself, but not for
1378  * any archives that correspond to tablespaces.
1379  */
1380  if (spclocation[0] == '\0')
1381  spclocation = NULL;
1382 
1383  /* End processing of any prior archive. */
1384  if (state->streamer != NULL)
1385  {
1386  bbstreamer_finalize(state->streamer);
1387  bbstreamer_free(state->streamer);
1388  state->streamer = NULL;
1389  }
1390 
1391  /*
1392  * Create an appropriate backup streamer, unless a backup
1393  * target was specified. In that case, it's up to the server
1394  * to put the backup wherever it needs to go.
1395  */
1396  if (backup_target == NULL)
1397  {
1398  /*
1399  * We know that recovery GUCs are supported, because this
1400  * protocol can only be used on v15+.
1401  */
1402  state->streamer =
1403  CreateBackupStreamer(archive_name,
1404  spclocation,
1405  &state->manifest_inject_streamer,
1406  true, false,
1407  state->compress);
1408  }
1409  break;
1410  }
1411 
1412  case 'd':
1413  {
1414  /* Archive or manifest data. */
1415  if (state->manifest_buffer != NULL)
1416  {
1417  /* Manifest data, buffer in memory. */
1418  appendPQExpBuffer(state->manifest_buffer, copybuf + 1,
1419  r - 1);
1420  }
1421  else if (state->manifest_file !=NULL)
1422  {
1423  /* Manifest data, write to disk. */
1424  if (fwrite(copybuf + 1, r - 1, 1,
1425  state->manifest_file) != 1)
1426  {
1427  /*
1428  * If fwrite() didn't set errno, assume that the
1429  * problem is that we're out of disk space.
1430  */
1431  if (errno == 0)
1432  errno = ENOSPC;
1433  pg_fatal("could not write to file \"%s\": %m",
1434  state->manifest_filename);
1435  }
1436  }
1437  else if (state->streamer != NULL)
1438  {
1439  /* Archive data. */
1440  bbstreamer_content(state->streamer, NULL, copybuf + 1,
1441  r - 1, BBSTREAMER_UNKNOWN);
1442  }
1443  else
1444  pg_fatal("unexpected payload data");
1445  break;
1446  }
1447 
1448  case 'p':
1449  {
1450  /*
1451  * Progress report.
1452  *
1453  * The remainder of the message is expected to be an 8-byte
1454  * count of bytes completed.
1455  */
1458 
1459  /*
1460  * The server shouldn't send progress report messages too
1461  * often, so we force an update each time we receive one.
1462  */
1463  progress_report(state->tablespacenum, true, false);
1464  break;
1465  }
1466 
1467  case 'm':
1468  {
1469  /*
1470  * Manifest data will be sent next. This message is not
1471  * expected to have any further payload data.
1472  */
1474 
1475  /*
1476  * If a backup target was specified, figuring out where to put
1477  * the manifest is the server's problem. Otherwise, we need to
1478  * deal with it.
1479  */
1480  if (backup_target == NULL)
1481  {
1482  /*
1483  * If we're supposed inject the manifest into the archive,
1484  * we prepare to buffer it in memory; otherwise, we
1485  * prepare to write it to a temporary file.
1486  */
1487  if (state->manifest_inject_streamer != NULL)
1488  state->manifest_buffer = createPQExpBuffer();
1489  else
1490  {
1491  snprintf(state->manifest_filename,
1492  sizeof(state->manifest_filename),
1493  "%s/backup_manifest.tmp", basedir);
1494  state->manifest_file =
1495  fopen(state->manifest_filename, "wb");
1496  if (state->manifest_file == NULL)
1497  pg_fatal("could not create file \"%s\": %m",
1498  state->manifest_filename);
1499  }
1500  }
1501  break;
1502  }
1503 
1504  default:
1506  break;
1507  }
1508 }
1509 
1510 /*
1511  * Get a single byte from a CopyData message.
1512  *
1513  * Bail out if none remain.
1514  */
1515 static char
1516 GetCopyDataByte(size_t r, char *copybuf, size_t *cursor)
1517 {
1518  if (*cursor >= r)
1520 
1521  return copybuf[(*cursor)++];
1522 }
1523 
1524 /*
1525  * Get a NUL-terminated string from a CopyData message.
1526  *
1527  * Bail out if the terminating NUL cannot be found.
1528  */
1529 static char *
1530 GetCopyDataString(size_t r, char *copybuf, size_t *cursor)
1531 {
1532  size_t startpos = *cursor;
1533  size_t endpos = startpos;
1534 
1535  while (1)
1536  {
1537  if (endpos >= r)
1539  if (copybuf[endpos] == '\0')
1540  break;
1541  ++endpos;
1542  }
1543 
1544  *cursor = endpos + 1;
1545  return &copybuf[startpos];
1546 }
1547 
1548 /*
1549  * Get an unsigned 64-bit integer from a CopyData message.
1550  *
1551  * Bail out if there are not at least 8 bytes remaining.
1552  */
1553 static uint64
1554 GetCopyDataUInt64(size_t r, char *copybuf, size_t *cursor)
1555 {
1556  uint64 result;
1557 
1558  if (*cursor + sizeof(uint64) > r)
1560  memcpy(&result, &copybuf[*cursor], sizeof(uint64));
1561  *cursor += sizeof(uint64);
1562  return pg_ntoh64(result);
1563 }
1564 
1565 /*
1566  * Bail out if we didn't parse the whole message.
1567  */
1568 static void
1569 GetCopyDataEnd(size_t r, char *copybuf, size_t cursor)
1570 {
1571  if (r != cursor)
1573 }
1574 
1575 /*
1576  * Report failure to parse a CopyData message from the server. Then exit.
1577  *
1578  * As a debugging aid, we try to give some hint about what kind of message
1579  * provoked the failure. Perhaps this is not detailed enough, but it's not
1580  * clear that it's worth expending any more code on what should be a
1581  * can't-happen case.
1582  */
1583 static void
1585 {
1586  if (r == 0)
1587  pg_fatal("empty COPY message");
1588  else
1589  pg_fatal("malformed COPY message of type %d, length %zu",
1590  copybuf[0], r);
1591 }
1592 
1593 /*
1594  * Receive raw tar data from the server, and stream it to the appropriate
1595  * location. If we're writing a single tarfile to standard output, also
1596  * receive the backup manifest and inject it into that tarfile.
1597  */
1598 static void
1599 ReceiveTarFile(PGconn *conn, char *archive_name, char *spclocation,
1600  bool tablespacenum, pg_compress_specification *compress)
1601 {
1603  bbstreamer *manifest_inject_streamer;
1604  bool is_recovery_guc_supported;
1605  bool expect_unterminated_tarfile;
1606 
1607  /* Pass all COPY data through to the backup streamer. */
1608  memset(&state, 0, sizeof(state));
1609  is_recovery_guc_supported =
1611  expect_unterminated_tarfile =
1613  state.streamer = CreateBackupStreamer(archive_name, spclocation,
1614  &manifest_inject_streamer,
1615  is_recovery_guc_supported,
1616  expect_unterminated_tarfile,
1617  compress);
1618  state.tablespacenum = tablespacenum;
1621 
1622  /*
1623  * The decision as to whether we need to inject the backup manifest into
1624  * the output at this stage is made by CreateBackupStreamer; if that is
1625  * needed, manifest_inject_streamer will be non-NULL; otherwise, it will
1626  * be NULL.
1627  */
1628  if (manifest_inject_streamer != NULL)
1629  {
1631 
1632  /* Slurp the entire backup manifest into a buffer. */
1633  initPQExpBuffer(&buf);
1636  pg_fatal("out of memory");
1637 
1638  /* Inject it into the output tarfile. */
1639  bbstreamer_inject_file(manifest_inject_streamer, "backup_manifest",
1640  buf.data, buf.len);
1641 
1642  /* Free memory. */
1643  termPQExpBuffer(&buf);
1644  }
1645 
1646  /* Cleanup. */
1647  bbstreamer_finalize(state.streamer);
1648  bbstreamer_free(state.streamer);
1649 
1650  progress_report(tablespacenum, true, false);
1651 
1652  /*
1653  * Do not sync the resulting tar file yet, all files are synced once at
1654  * the end.
1655  */
1656 }
1657 
1658 /*
1659  * Receive one chunk of tar-format data from the server.
1660  */
1661 static void
1662 ReceiveTarCopyChunk(size_t r, char *copybuf, void *callback_data)
1663 {
1664  WriteTarState *state = callback_data;
1665 
1666  bbstreamer_content(state->streamer, NULL, copybuf, r, BBSTREAMER_UNKNOWN);
1667 
1668  totaldone += r;
1669  progress_report(state->tablespacenum, false, false);
1670 }
1671 
1672 
1673 /*
1674  * Retrieve tablespace path, either relocated or original depending on whether
1675  * -T was passed or not.
1676  */
1677 static const char *
1678 get_tablespace_mapping(const char *dir)
1679 {
1680  TablespaceListCell *cell;
1681  char canon_dir[MAXPGPATH];
1682 
1683  /* Canonicalize path for comparison consistency */
1684  strlcpy(canon_dir, dir, sizeof(canon_dir));
1685  canonicalize_path(canon_dir);
1686 
1687  for (cell = tablespace_dirs.head; cell; cell = cell->next)
1688  if (strcmp(canon_dir, cell->old_dir) == 0)
1689  return cell->new_dir;
1690 
1691  return dir;
1692 }
1693 
1694 /*
1695  * Receive the backup manifest file and write it out to a file.
1696  */
1697 static void
1699 {
1701 
1702  snprintf(state.filename, sizeof(state.filename),
1703  "%s/backup_manifest.tmp", basedir);
1704  state.file = fopen(state.filename, "wb");
1705  if (state.file == NULL)
1706  pg_fatal("could not create file \"%s\": %m", state.filename);
1707 
1709 
1710  fclose(state.file);
1711 }
1712 
1713 /*
1714  * Receive one chunk of the backup manifest file and write it out to a file.
1715  */
1716 static void
1717 ReceiveBackupManifestChunk(size_t r, char *copybuf, void *callback_data)
1718 {
1719  WriteManifestState *state = callback_data;
1720 
1721  errno = 0;
1722  if (fwrite(copybuf, r, 1, state->file) != 1)
1723  {
1724  /* if write didn't set errno, assume problem is no disk space */
1725  if (errno == 0)
1726  errno = ENOSPC;
1727  pg_fatal("could not write to file \"%s\": %m", state->filename);
1728  }
1729 }
1730 
1731 /*
1732  * Receive the backup manifest file and write it out to a file.
1733  */
1734 static void
1736 {
1738 }
1739 
1740 /*
1741  * Receive one chunk of the backup manifest file and write it out to a file.
1742  */
1743 static void
1745  void *callback_data)
1746 {
1747  PQExpBuffer buf = callback_data;
1748 
1750 }
1751 
1752 static void
1753 BaseBackup(char *compression_algorithm, char *compression_detail,
1754  CompressionLocation compressloc,
1755  pg_compress_specification *client_compress,
1756  char *incremental_manifest)
1757 {
1758  PGresult *res;
1759  char *sysidentifier;
1760  TimeLineID latesttli;
1761  TimeLineID starttli;
1762  char *basebkp;
1763  int i;
1764  char xlogstart[64];
1765  char xlogend[64] = {0};
1766  int minServerMajor,
1767  maxServerMajor;
1768  int serverVersion,
1769  serverMajor;
1770  int writing_to_stdout;
1771  bool use_new_option_syntax = false;
1773 
1774  Assert(conn != NULL);
1775  initPQExpBuffer(&buf);
1776 
1777  /*
1778  * Check server version. BASE_BACKUP command was introduced in 9.1, so we
1779  * can't work with servers older than 9.1.
1780  */
1781  minServerMajor = 901;
1782  maxServerMajor = PG_VERSION_NUM / 100;
1783  serverVersion = PQserverVersion(conn);
1784  serverMajor = serverVersion / 100;
1785  if (serverMajor < minServerMajor || serverMajor > maxServerMajor)
1786  {
1787  const char *serverver = PQparameterStatus(conn, "server_version");
1788 
1789  pg_fatal("incompatible server version %s",
1790  serverver ? serverver : "'unknown'");
1791  }
1792  if (serverMajor >= 1500)
1793  use_new_option_syntax = true;
1794 
1795  /*
1796  * If WAL streaming was requested, also check that the server is new
1797  * enough for that.
1798  */
1800  {
1801  /*
1802  * Error message already written in CheckServerVersionForStreaming(),
1803  * but add a hint about using -X none.
1804  */
1805  pg_log_error_hint("Use -X none or -X fetch to disable log streaming.");
1806  exit(1);
1807  }
1808 
1809  /*
1810  * Build contents of configuration file if requested.
1811  *
1812  * Note that we don't use the dbname from key-value pair in conn as that
1813  * would have been filled by the default dbname (dbname=replication) in
1814  * case the user didn't specify the one. The dbname written in the config
1815  * file as part of primary_conninfo would be used by slotsync worker which
1816  * doesn't use a replication connection so the default won't work for it.
1817  */
1818  if (writerecoveryconf)
1822 
1823  /*
1824  * Run IDENTIFY_SYSTEM so we can get the timeline
1825  */
1826  if (!RunIdentifySystem(conn, &sysidentifier, &latesttli, NULL, NULL))
1827  exit(1);
1828 
1829  /*
1830  * If the user wants an incremental backup, we must upload the manifest
1831  * for the previous backup upon which it is to be based.
1832  */
1833  if (incremental_manifest != NULL)
1834  {
1835  int fd;
1836  char mbuf[65536];
1837  int nbytes;
1838 
1839  /* Reject if server is too old. */
1840  if (serverVersion < MINIMUM_VERSION_FOR_WAL_SUMMARIES)
1841  pg_fatal("server does not support incremental backup");
1842 
1843  /* Open the file. */
1844  fd = open(incremental_manifest, O_RDONLY | PG_BINARY, 0);
1845  if (fd < 0)
1846  pg_fatal("could not open file \"%s\": %m", incremental_manifest);
1847 
1848  /* Tell the server what we want to do. */
1849  if (PQsendQuery(conn, "UPLOAD_MANIFEST") == 0)
1850  pg_fatal("could not send replication command \"%s\": %s",
1851  "UPLOAD_MANIFEST", PQerrorMessage(conn));
1852  res = PQgetResult(conn);
1854  {
1856  pg_fatal("could not upload manifest: %s",
1857  PQerrorMessage(conn));
1858  else
1859  pg_fatal("could not upload manifest: unexpected status %s",
1861  }
1862 
1863  /* Loop, reading from the file and sending the data to the server. */
1864  while ((nbytes = read(fd, mbuf, sizeof mbuf)) > 0)
1865  {
1866  if (PQputCopyData(conn, mbuf, nbytes) < 0)
1867  pg_fatal("could not send COPY data: %s",
1868  PQerrorMessage(conn));
1869  }
1870 
1871  /* Bail out if we exited the loop due to an error. */
1872  if (nbytes < 0)
1873  pg_fatal("could not read file \"%s\": %m", incremental_manifest);
1874 
1875  /* End the COPY operation. */
1876  if (PQputCopyEnd(conn, NULL) < 0)
1877  pg_fatal("could not send end-of-COPY: %s",
1878  PQerrorMessage(conn));
1879 
1880  /* See whether the server is happy with what we sent. */
1881  res = PQgetResult(conn);
1883  pg_fatal("could not upload manifest: %s",
1884  PQerrorMessage(conn));
1885  else if (PQresultStatus(res) != PGRES_COMMAND_OK)
1886  pg_fatal("could not upload manifest: unexpected status %s",
1888 
1889  /* Consume ReadyForQuery message from server. */
1890  res = PQgetResult(conn);
1891  if (res != NULL)
1892  pg_fatal("unexpected extra result while sending manifest");
1893 
1894  /* Add INCREMENTAL option to BASE_BACKUP command. */
1895  AppendPlainCommandOption(&buf, use_new_option_syntax, "INCREMENTAL");
1896  }
1897 
1898  /*
1899  * Continue building up the options list for the BASE_BACKUP command.
1900  */
1901  AppendStringCommandOption(&buf, use_new_option_syntax, "LABEL", label);
1902  if (estimatesize)
1903  AppendPlainCommandOption(&buf, use_new_option_syntax, "PROGRESS");
1904  if (includewal == FETCH_WAL)
1905  AppendPlainCommandOption(&buf, use_new_option_syntax, "WAL");
1906  if (fastcheckpoint)
1907  {
1908  if (use_new_option_syntax)
1909  AppendStringCommandOption(&buf, use_new_option_syntax,
1910  "CHECKPOINT", "fast");
1911  else
1912  AppendPlainCommandOption(&buf, use_new_option_syntax, "FAST");
1913  }
1914  if (includewal != NO_WAL)
1915  {
1916  if (use_new_option_syntax)
1917  AppendIntegerCommandOption(&buf, use_new_option_syntax, "WAIT", 0);
1918  else
1919  AppendPlainCommandOption(&buf, use_new_option_syntax, "NOWAIT");
1920  }
1921  if (maxrate > 0)
1922  AppendIntegerCommandOption(&buf, use_new_option_syntax, "MAX_RATE",
1923  maxrate);
1924  if (format == 't')
1925  AppendPlainCommandOption(&buf, use_new_option_syntax, "TABLESPACE_MAP");
1926  if (!verify_checksums)
1927  {
1928  if (use_new_option_syntax)
1929  AppendIntegerCommandOption(&buf, use_new_option_syntax,
1930  "VERIFY_CHECKSUMS", 0);
1931  else
1932  AppendPlainCommandOption(&buf, use_new_option_syntax,
1933  "NOVERIFY_CHECKSUMS");
1934  }
1935 
1936  if (manifest)
1937  {
1938  AppendStringCommandOption(&buf, use_new_option_syntax, "MANIFEST",
1939  manifest_force_encode ? "force-encode" : "yes");
1940  if (manifest_checksums != NULL)
1941  AppendStringCommandOption(&buf, use_new_option_syntax,
1942  "MANIFEST_CHECKSUMS", manifest_checksums);
1943  }
1944 
1945  if (backup_target != NULL)
1946  {
1947  char *colon;
1948 
1949  if (serverMajor < 1500)
1950  pg_fatal("backup targets are not supported by this server version");
1951 
1952  if (writerecoveryconf)
1953  pg_fatal("recovery configuration cannot be written when a backup target is used");
1954 
1955  AppendPlainCommandOption(&buf, use_new_option_syntax, "TABLESPACE_MAP");
1956 
1957  if ((colon = strchr(backup_target, ':')) == NULL)
1958  {
1959  AppendStringCommandOption(&buf, use_new_option_syntax,
1960  "TARGET", backup_target);
1961  }
1962  else
1963  {
1964  char *target;
1965 
1967  AppendStringCommandOption(&buf, use_new_option_syntax,
1968  "TARGET", target);
1969  AppendStringCommandOption(&buf, use_new_option_syntax,
1970  "TARGET_DETAIL", colon + 1);
1971  }
1972  }
1973  else if (serverMajor >= 1500)
1974  AppendStringCommandOption(&buf, use_new_option_syntax,
1975  "TARGET", "client");
1976 
1977  if (compressloc == COMPRESS_LOCATION_SERVER)
1978  {
1979  if (!use_new_option_syntax)
1980  pg_fatal("server does not support server-side compression");
1981  AppendStringCommandOption(&buf, use_new_option_syntax,
1982  "COMPRESSION", compression_algorithm);
1983  if (compression_detail != NULL)
1984  AppendStringCommandOption(&buf, use_new_option_syntax,
1985  "COMPRESSION_DETAIL",
1986  compression_detail);
1987  }
1988 
1989  if (verbose)
1990  pg_log_info("initiating base backup, waiting for checkpoint to complete");
1991 
1992  if (showprogress && !verbose)
1993  {
1994  fprintf(stderr, _("waiting for checkpoint"));
1995  if (isatty(fileno(stderr)))
1996  fprintf(stderr, "\r");
1997  else
1998  fprintf(stderr, "\n");
1999  }
2000 
2001  if (use_new_option_syntax && buf.len > 0)
2002  basebkp = psprintf("BASE_BACKUP (%s)", buf.data);
2003  else
2004  basebkp = psprintf("BASE_BACKUP %s", buf.data);
2005 
2006  /* OK, try to start the backup. */
2007  if (PQsendQuery(conn, basebkp) == 0)
2008  pg_fatal("could not send replication command \"%s\": %s",
2009  "BASE_BACKUP", PQerrorMessage(conn));
2010 
2011  /*
2012  * Get the starting WAL location
2013  */
2014  res = PQgetResult(conn);
2016  pg_fatal("could not initiate base backup: %s",
2017  PQerrorMessage(conn));
2018  if (PQntuples(res) != 1)
2019  pg_fatal("server returned unexpected response to BASE_BACKUP command; got %d rows and %d fields, expected %d rows and %d fields",
2020  PQntuples(res), PQnfields(res), 1, 2);
2021 
2022  strlcpy(xlogstart, PQgetvalue(res, 0, 0), sizeof(xlogstart));
2023 
2024  if (verbose)
2025  pg_log_info("checkpoint completed");
2026 
2027  /*
2028  * 9.3 and later sends the TLI of the starting point. With older servers,
2029  * assume it's the same as the latest timeline reported by
2030  * IDENTIFY_SYSTEM.
2031  */
2032  if (PQnfields(res) >= 2)
2033  starttli = atoi(PQgetvalue(res, 0, 1));
2034  else
2035  starttli = latesttli;
2036  PQclear(res);
2037 
2038  if (verbose && includewal != NO_WAL)
2039  pg_log_info("write-ahead log start point: %s on timeline %u",
2040  xlogstart, starttli);
2041 
2042  /*
2043  * Get the header
2044  */
2045  res = PQgetResult(conn);
2047  pg_fatal("could not get backup header: %s",
2048  PQerrorMessage(conn));
2049  if (PQntuples(res) < 1)
2050  pg_fatal("no data returned from server");
2051 
2052  /*
2053  * Sum up the total size, for progress reporting
2054  */
2055  totalsize_kb = totaldone = 0;
2057  for (i = 0; i < PQntuples(res); i++)
2058  {
2059  totalsize_kb += atol(PQgetvalue(res, i, 2));
2060 
2061  /*
2062  * Verify tablespace directories are empty. Don't bother with the
2063  * first once since it can be relocated, and it will be checked before
2064  * we do anything anyway.
2065  *
2066  * Note that this is skipped for tar format backups and backups that
2067  * the server is storing to a target location, since in that case we
2068  * won't be storing anything into these directories and thus should
2069  * not create them.
2070  */
2071  if (backup_target == NULL && format == 'p' && !PQgetisnull(res, i, 1))
2072  {
2073  char *path = PQgetvalue(res, i, 1);
2074 
2075  if (is_absolute_path(path))
2076  path = unconstify(char *, get_tablespace_mapping(path));
2077  else
2078  {
2079  /* This is an in-place tablespace, so prepend basedir. */
2080  path = psprintf("%s/%s", basedir, path);
2081  }
2082 
2084  }
2085  }
2086 
2087  /*
2088  * When writing to stdout, require a single tablespace
2089  */
2090  writing_to_stdout = format == 't' && basedir != NULL &&
2091  strcmp(basedir, "-") == 0;
2092  if (writing_to_stdout && PQntuples(res) > 1)
2093  pg_fatal("can only write single tablespace to stdout, database has %d",
2094  PQntuples(res));
2095 
2096  /*
2097  * If we're streaming WAL, start the streaming session before we start
2098  * receiving the actual data chunks.
2099  */
2100  if (includewal == STREAM_WAL)
2101  {
2102  pg_compress_algorithm wal_compress_algorithm;
2103  int wal_compress_level;
2104 
2105  if (verbose)
2106  pg_log_info("starting background WAL receiver");
2107 
2108  if (client_compress->algorithm == PG_COMPRESSION_GZIP)
2109  {
2110  wal_compress_algorithm = PG_COMPRESSION_GZIP;
2111  wal_compress_level = client_compress->level;
2112  }
2113  else
2114  {
2115  wal_compress_algorithm = PG_COMPRESSION_NONE;
2116  wal_compress_level = 0;
2117  }
2118 
2119  StartLogStreamer(xlogstart, starttli, sysidentifier,
2120  wal_compress_algorithm,
2121  wal_compress_level);
2122  }
2123 
2124  if (serverMajor >= 1500)
2125  {
2126  /* Receive a single tar stream with everything. */
2127  ReceiveArchiveStream(conn, client_compress);
2128  }
2129  else
2130  {
2131  /* Receive a tar file for each tablespace in turn */
2132  for (i = 0; i < PQntuples(res); i++)
2133  {
2134  char archive_name[MAXPGPATH];
2135  char *spclocation;
2136 
2137  /*
2138  * If we write the data out to a tar file, it will be named
2139  * base.tar if it's the main data directory or <tablespaceoid>.tar
2140  * if it's for another tablespace. CreateBackupStreamer() will
2141  * arrange to add an extension to the archive name if
2142  * pg_basebackup is performing compression, depending on the
2143  * compression type.
2144  */
2145  if (PQgetisnull(res, i, 0))
2146  {
2147  strlcpy(archive_name, "base.tar", sizeof(archive_name));
2148  spclocation = NULL;
2149  }
2150  else
2151  {
2152  snprintf(archive_name, sizeof(archive_name),
2153  "%s.tar", PQgetvalue(res, i, 0));
2154  spclocation = PQgetvalue(res, i, 1);
2155  }
2156 
2157  ReceiveTarFile(conn, archive_name, spclocation, i,
2158  client_compress);
2159  }
2160 
2161  /*
2162  * Now receive backup manifest, if appropriate.
2163  *
2164  * If we're writing a tarfile to stdout, ReceiveTarFile will have
2165  * already processed the backup manifest and included it in the output
2166  * tarfile. Such a configuration doesn't allow for writing multiple
2167  * files.
2168  *
2169  * If we're talking to an older server, it won't send a backup
2170  * manifest, so don't try to receive one.
2171  */
2172  if (!writing_to_stdout && manifest)
2174  }
2175 
2176  if (showprogress)
2177  {
2179  progress_report(PQntuples(res), true, true);
2180  }
2181 
2182  PQclear(res);
2183 
2184  /*
2185  * Get the stop position
2186  */
2187  res = PQgetResult(conn);
2189  pg_fatal("backup failed: %s",
2190  PQerrorMessage(conn));
2191  if (PQntuples(res) != 1)
2192  pg_fatal("no write-ahead log end position returned from server");
2193  strlcpy(xlogend, PQgetvalue(res, 0, 0), sizeof(xlogend));
2194  if (verbose && includewal != NO_WAL)
2195  pg_log_info("write-ahead log end point: %s", xlogend);
2196  PQclear(res);
2197 
2198  res = PQgetResult(conn);
2200  {
2201  const char *sqlstate = PQresultErrorField(res, PG_DIAG_SQLSTATE);
2202 
2203  if (sqlstate &&
2204  strcmp(sqlstate, ERRCODE_DATA_CORRUPTED) == 0)
2205  {
2206  pg_log_error("checksum error occurred");
2207  checksum_failure = true;
2208  }
2209  else
2210  {
2211  pg_log_error("final receive failed: %s",
2212  PQerrorMessage(conn));
2213  }
2214  exit(1);
2215  }
2216 
2217  if (bgchild > 0)
2218  {
2219 #ifndef WIN32
2220  int status;
2221  pid_t r;
2222 #else
2223  DWORD status;
2224 
2225  /*
2226  * get a pointer sized version of bgchild to avoid warnings about
2227  * casting to a different size on WIN64.
2228  */
2229  intptr_t bgchild_handle = bgchild;
2230  uint32 hi,
2231  lo;
2232 #endif
2233 
2234  if (verbose)
2235  pg_log_info("waiting for background process to finish streaming ...");
2236 
2237 #ifndef WIN32
2238  if (write(bgpipe[1], xlogend, strlen(xlogend)) != strlen(xlogend))
2239  pg_fatal("could not send command to background pipe: %m");
2240 
2241  /* Just wait for the background process to exit */
2242  r = waitpid(bgchild, &status, 0);
2243  if (r == (pid_t) -1)
2244  pg_fatal("could not wait for child process: %m");
2245  if (r != bgchild)
2246  pg_fatal("child %d died, expected %d", (int) r, (int) bgchild);
2247  if (status != 0)
2248  pg_fatal("%s", wait_result_to_str(status));
2249  /* Exited normally, we're happy! */
2250 #else /* WIN32 */
2251 
2252  /*
2253  * On Windows, since we are in the same process, we can just store the
2254  * value directly in the variable, and then set the flag that says
2255  * it's there.
2256  */
2257  if (sscanf(xlogend, "%X/%X", &hi, &lo) != 2)
2258  pg_fatal("could not parse write-ahead log location \"%s\"",
2259  xlogend);
2260  xlogendptr = ((uint64) hi) << 32 | lo;
2261  InterlockedIncrement(&has_xlogendptr);
2262 
2263  /* First wait for the thread to exit */
2264  if (WaitForSingleObjectEx((HANDLE) bgchild_handle, INFINITE, FALSE) !=
2265  WAIT_OBJECT_0)
2266  {
2267  _dosmaperr(GetLastError());
2268  pg_fatal("could not wait for child thread: %m");
2269  }
2270  if (GetExitCodeThread((HANDLE) bgchild_handle, &status) == 0)
2271  {
2272  _dosmaperr(GetLastError());
2273  pg_fatal("could not get child thread exit status: %m");
2274  }
2275  if (status != 0)
2276  pg_fatal("child thread exited with error %u",
2277  (unsigned int) status);
2278  /* Exited normally, we're happy */
2279 #endif
2280  }
2281 
2282  /* Free the configuration file contents */
2284 
2285  /*
2286  * End of copy data. Final result is already checked inside the loop.
2287  */
2288  PQclear(res);
2289  PQfinish(conn);
2290  conn = NULL;
2291 
2292  /*
2293  * Make data persistent on disk once backup is completed. For tar format
2294  * sync the parent directory and all its contents as each tar file was not
2295  * synced after being completed. In plain format, all the data of the
2296  * base directory is synced, taking into account all the tablespaces.
2297  * Errors are not considered fatal.
2298  *
2299  * If, however, there's a backup target, we're not writing anything
2300  * locally, so in that case we skip this step.
2301  */
2302  if (do_sync && backup_target == NULL)
2303  {
2304  if (verbose)
2305  pg_log_info("syncing data to disk ...");
2306  if (format == 't')
2307  {
2308  if (strcmp(basedir, "-") != 0)
2309  (void) sync_dir_recurse(basedir, sync_method);
2310  }
2311  else
2312  {
2313  (void) sync_pgdata(basedir, serverVersion, sync_method);
2314  }
2315  }
2316 
2317  /*
2318  * After synchronizing data to disk, perform a durable rename of
2319  * backup_manifest.tmp to backup_manifest, if we wrote such a file. This
2320  * way, a failure or system crash before we reach this point will leave us
2321  * without a backup_manifest file, decreasing the chances that a directory
2322  * we leave behind will be mistaken for a valid backup.
2323  */
2324  if (!writing_to_stdout && manifest && backup_target == NULL)
2325  {
2326  char tmp_filename[MAXPGPATH];
2327  char filename[MAXPGPATH];
2328 
2329  if (verbose)
2330  pg_log_info("renaming backup_manifest.tmp to backup_manifest");
2331 
2332  snprintf(tmp_filename, MAXPGPATH, "%s/backup_manifest.tmp", basedir);
2333  snprintf(filename, MAXPGPATH, "%s/backup_manifest", basedir);
2334 
2335  if (do_sync)
2336  {
2337  /* durable_rename emits its own log message in case of failure */
2338  if (durable_rename(tmp_filename, filename) != 0)
2339  exit(1);
2340  }
2341  else
2342  {
2343  if (rename(tmp_filename, filename) != 0)
2344  pg_fatal("could not rename file \"%s\" to \"%s\": %m",
2345  tmp_filename, filename);
2346  }
2347  }
2348 
2349  if (verbose)
2350  pg_log_info("base backup completed");
2351 }
2352 
2353 
2354 int
2355 main(int argc, char **argv)
2356 {
2357  static struct option long_options[] = {
2358  {"help", no_argument, NULL, '?'},
2359  {"version", no_argument, NULL, 'V'},
2360  {"pgdata", required_argument, NULL, 'D'},
2361  {"format", required_argument, NULL, 'F'},
2362  {"incremental", required_argument, NULL, 'i'},
2363  {"checkpoint", required_argument, NULL, 'c'},
2364  {"create-slot", no_argument, NULL, 'C'},
2365  {"max-rate", required_argument, NULL, 'r'},
2366  {"write-recovery-conf", no_argument, NULL, 'R'},
2367  {"slot", required_argument, NULL, 'S'},
2368  {"target", required_argument, NULL, 't'},
2369  {"tablespace-mapping", required_argument, NULL, 'T'},
2370  {"wal-method", required_argument, NULL, 'X'},
2371  {"gzip", no_argument, NULL, 'z'},
2372  {"compress", required_argument, NULL, 'Z'},
2373  {"label", required_argument, NULL, 'l'},
2374  {"no-clean", no_argument, NULL, 'n'},
2375  {"no-sync", no_argument, NULL, 'N'},
2376  {"dbname", required_argument, NULL, 'd'},
2377  {"host", required_argument, NULL, 'h'},
2378  {"port", required_argument, NULL, 'p'},
2379  {"username", required_argument, NULL, 'U'},
2380  {"no-password", no_argument, NULL, 'w'},
2381  {"password", no_argument, NULL, 'W'},
2382  {"status-interval", required_argument, NULL, 's'},
2383  {"verbose", no_argument, NULL, 'v'},
2384  {"progress", no_argument, NULL, 'P'},
2385  {"waldir", required_argument, NULL, 1},
2386  {"no-slot", no_argument, NULL, 2},
2387  {"no-verify-checksums", no_argument, NULL, 3},
2388  {"no-estimate-size", no_argument, NULL, 4},
2389  {"no-manifest", no_argument, NULL, 5},
2390  {"manifest-force-encode", no_argument, NULL, 6},
2391  {"manifest-checksums", required_argument, NULL, 7},
2392  {"sync-method", required_argument, NULL, 8},
2393  {NULL, 0, NULL, 0}
2394  };
2395  int c;
2396 
2397  int option_index;
2398  char *compression_algorithm = "none";
2399  char *compression_detail = NULL;
2400  char *incremental_manifest = NULL;
2402  pg_compress_specification client_compress;
2403 
2404  pg_logging_init(argv[0]);
2405  progname = get_progname(argv[0]);
2406  set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_basebackup"));
2407 
2408  if (argc > 1)
2409  {
2410  if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
2411  {
2412  usage();
2413  exit(0);
2414  }
2415  else if (strcmp(argv[1], "-V") == 0
2416  || strcmp(argv[1], "--version") == 0)
2417  {
2418  puts("pg_basebackup (PostgreSQL) " PG_VERSION);
2419  exit(0);
2420  }
2421  }
2422 
2424 
2425  while ((c = getopt_long(argc, argv, "c:Cd:D:F:h:i:l:nNp:Pr:Rs:S:t:T:U:vwWX:zZ:",
2426  long_options, &option_index)) != -1)
2427  {
2428  switch (c)
2429  {
2430  case 'c':
2431  if (pg_strcasecmp(optarg, "fast") == 0)
2432  fastcheckpoint = true;
2433  else if (pg_strcasecmp(optarg, "spread") == 0)
2434  fastcheckpoint = false;
2435  else
2436  pg_fatal("invalid checkpoint argument \"%s\", must be \"fast\" or \"spread\"",
2437  optarg);
2438  break;
2439  case 'C':
2440  create_slot = true;
2441  break;
2442  case 'd':
2444  break;
2445  case 'D':
2447  break;
2448  case 'F':
2449  if (strcmp(optarg, "p") == 0 || strcmp(optarg, "plain") == 0)
2450  format = 'p';
2451  else if (strcmp(optarg, "t") == 0 || strcmp(optarg, "tar") == 0)
2452  format = 't';
2453  else
2454  pg_fatal("invalid output format \"%s\", must be \"plain\" or \"tar\"",
2455  optarg);
2456  break;
2457  case 'h':
2458  dbhost = pg_strdup(optarg);
2459  break;
2460  case 'i':
2461  incremental_manifest = pg_strdup(optarg);
2462  break;
2463  case 'l':
2464  label = pg_strdup(optarg);
2465  break;
2466  case 'n':
2467  noclean = true;
2468  break;
2469  case 'N':
2470  do_sync = false;
2471  break;
2472  case 'p':
2473  dbport = pg_strdup(optarg);
2474  break;
2475  case 'P':
2476  showprogress = true;
2477  break;
2478  case 'r':
2480  break;
2481  case 'R':
2482  writerecoveryconf = true;
2483  break;
2484  case 's':
2485  if (!option_parse_int(optarg, "-s/--status-interval", 0,
2486  INT_MAX / 1000,
2488  exit(1);
2489  standby_message_timeout *= 1000;
2490  break;
2491  case 'S':
2492 
2493  /*
2494  * When specifying replication slot name, use a permanent
2495  * slot.
2496  */
2498  temp_replication_slot = false;
2499  break;
2500  case 't':
2502  break;
2503  case 'T':
2505  break;
2506  case 'U':
2507  dbuser = pg_strdup(optarg);
2508  break;
2509  case 'v':
2510  verbose++;
2511  break;
2512  case 'w':
2513  dbgetpassword = -1;
2514  break;
2515  case 'W':
2516  dbgetpassword = 1;
2517  break;
2518  case 'X':
2519  if (strcmp(optarg, "n") == 0 ||
2520  strcmp(optarg, "none") == 0)
2521  {
2522  includewal = NO_WAL;
2523  }
2524  else if (strcmp(optarg, "f") == 0 ||
2525  strcmp(optarg, "fetch") == 0)
2526  {
2528  }
2529  else if (strcmp(optarg, "s") == 0 ||
2530  strcmp(optarg, "stream") == 0)
2531  {
2533  }
2534  else
2535  pg_fatal("invalid wal-method option \"%s\", must be \"fetch\", \"stream\", or \"none\"",
2536  optarg);
2537  break;
2538  case 'z':
2539  compression_algorithm = "gzip";
2540  compression_detail = NULL;
2541  compressloc = COMPRESS_LOCATION_UNSPECIFIED;
2542  break;
2543  case 'Z':
2545  &compression_detail, &compressloc);
2546  break;
2547  case 1:
2549  break;
2550  case 2:
2551  no_slot = true;
2552  break;
2553  case 3:
2554  verify_checksums = false;
2555  break;
2556  case 4:
2557  estimatesize = false;
2558  break;
2559  case 5:
2560  manifest = false;
2561  break;
2562  case 6:
2563  manifest_force_encode = true;
2564  break;
2565  case 7:
2567  break;
2568  case 8:
2570  exit(1);
2571  break;
2572  default:
2573  /* getopt_long already emitted a complaint */
2574  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2575  exit(1);
2576  }
2577  }
2578 
2579  /*
2580  * Any non-option arguments?
2581  */
2582  if (optind < argc)
2583  {
2584  pg_log_error("too many command-line arguments (first is \"%s\")",
2585  argv[optind]);
2586  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2587  exit(1);
2588  }
2589 
2590  /*
2591  * Setting the backup target to 'client' is equivalent to leaving out the
2592  * option. This logic allows us to assume elsewhere that the backup is
2593  * being stored locally if and only if backup_target == NULL.
2594  */
2595  if (backup_target != NULL && strcmp(backup_target, "client") == 0)
2596  {
2598  backup_target = NULL;
2599  }
2600 
2601  /*
2602  * Can't use --format with --target. Without --target, default format is
2603  * tar.
2604  */
2605  if (backup_target != NULL && format != '\0')
2606  {
2607  pg_log_error("cannot specify both format and backup target");
2608  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2609  exit(1);
2610  }
2611  if (format == '\0')
2612  format = 'p';
2613 
2614  /*
2615  * Either directory or backup target should be specified, but not both
2616  */
2617  if (basedir == NULL && backup_target == NULL)
2618  {
2619  pg_log_error("must specify output directory or backup target");
2620  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2621  exit(1);
2622  }
2623  if (basedir != NULL && backup_target != NULL)
2624  {
2625  pg_log_error("cannot specify both output directory and backup target");
2626  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2627  exit(1);
2628  }
2629 
2630  /*
2631  * If the user has not specified where to perform backup compression,
2632  * default to the client, unless the user specified --target, in which
2633  * case the server is the only choice.
2634  */
2635  if (compressloc == COMPRESS_LOCATION_UNSPECIFIED)
2636  {
2637  if (backup_target == NULL)
2638  compressloc = COMPRESS_LOCATION_CLIENT;
2639  else
2640  compressloc = COMPRESS_LOCATION_SERVER;
2641  }
2642 
2643  /*
2644  * If any compression that we're doing is happening on the client side, we
2645  * must try to parse the compression algorithm and detail, but if it's all
2646  * on the server side, then we're just going to pass through whatever was
2647  * requested and let the server decide what to do.
2648  */
2649  if (compressloc == COMPRESS_LOCATION_CLIENT)
2650  {
2652  char *error_detail;
2653 
2655  pg_fatal("unrecognized compression algorithm: \"%s\"",
2657 
2658  parse_compress_specification(alg, compression_detail, &client_compress);
2659  error_detail = validate_compress_specification(&client_compress);
2660  if (error_detail != NULL)
2661  pg_fatal("invalid compression specification: %s",
2662  error_detail);
2663  }
2664  else
2665  {
2666  Assert(compressloc == COMPRESS_LOCATION_SERVER);
2667  client_compress.algorithm = PG_COMPRESSION_NONE;
2668  client_compress.options = 0;
2669  }
2670 
2671  /*
2672  * Can't perform client-side compression if the backup is not being sent
2673  * to the client.
2674  */
2675  if (backup_target != NULL && compressloc == COMPRESS_LOCATION_CLIENT)
2676  {
2677  pg_log_error("client-side compression is not possible when a backup target is specified");
2678  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2679  exit(1);
2680  }
2681 
2682  /*
2683  * Client-side compression doesn't make sense unless tar format is in use.
2684  */
2685  if (format == 'p' && compressloc == COMPRESS_LOCATION_CLIENT &&
2686  client_compress.algorithm != PG_COMPRESSION_NONE)
2687  {
2688  pg_log_error("only tar mode backups can be compressed");
2689  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2690  exit(1);
2691  }
2692 
2693  /*
2694  * Sanity checks for WAL method.
2695  */
2696  if (backup_target != NULL && includewal == STREAM_WAL)
2697  {
2698  pg_log_error("WAL cannot be streamed when a backup target is specified");
2699  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2700  exit(1);
2701  }
2702  if (format == 't' && includewal == STREAM_WAL && strcmp(basedir, "-") == 0)
2703  {
2704  pg_log_error("cannot stream write-ahead logs in tar mode to stdout");
2705  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2706  exit(1);
2707  }
2708 
2710  {
2711  pg_log_error("replication slots can only be used with WAL streaming");
2712  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2713  exit(1);
2714  }
2715 
2716  /*
2717  * Sanity checks for replication slot options.
2718  */
2719  if (no_slot)
2720  {
2721  if (replication_slot)
2722  {
2723  pg_log_error("--no-slot cannot be used with slot name");
2724  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2725  exit(1);
2726  }
2727  temp_replication_slot = false;
2728  }
2729 
2730  if (create_slot)
2731  {
2732  if (!replication_slot)
2733  {
2734  pg_log_error("%s needs a slot to be specified using --slot",
2735  "--create-slot");
2736  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2737  exit(1);
2738  }
2739 
2740  if (no_slot)
2741  {
2742  pg_log_error("%s and %s are incompatible options",
2743  "--create-slot", "--no-slot");
2744  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2745  exit(1);
2746  }
2747  }
2748 
2749  /*
2750  * Sanity checks on WAL directory.
2751  */
2752  if (xlog_dir)
2753  {
2754  if (backup_target != NULL)
2755  {
2756  pg_log_error("WAL directory location cannot be specified along with a backup target");
2757  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2758  exit(1);
2759  }
2760  if (format != 'p')
2761  {
2762  pg_log_error("WAL directory location can only be specified in plain mode");
2763  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2764  exit(1);
2765  }
2766 
2767  /* clean up xlog directory name, check it's absolute */
2769  if (!is_absolute_path(xlog_dir))
2770  {
2771  pg_log_error("WAL directory location must be an absolute path");
2772  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2773  exit(1);
2774  }
2775  }
2776 
2777  /*
2778  * Sanity checks for progress reporting options.
2779  */
2780  if (showprogress && !estimatesize)
2781  {
2782  pg_log_error("%s and %s are incompatible options",
2783  "--progress", "--no-estimate-size");
2784  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2785  exit(1);
2786  }
2787 
2788  /*
2789  * Sanity checks for backup manifest options.
2790  */
2791  if (!manifest && manifest_checksums != NULL)
2792  {
2793  pg_log_error("%s and %s are incompatible options",
2794  "--no-manifest", "--manifest-checksums");
2795  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2796  exit(1);
2797  }
2798 
2800  {
2801  pg_log_error("%s and %s are incompatible options",
2802  "--no-manifest", "--manifest-force-encode");
2803  pg_log_error_hint("Try \"%s --help\" for more information.", progname);
2804  exit(1);
2805  }
2806 
2807  /* connection in replication mode to server */
2808  conn = GetConnection();
2809  if (!conn)
2810  {
2811  /* Error message already written in GetConnection() */
2812  exit(1);
2813  }
2814  atexit(disconnect_atexit);
2815 
2816 #ifndef WIN32
2817 
2818  /*
2819  * Trap SIGCHLD to be able to handle the WAL stream process exiting. There
2820  * is no SIGCHLD on Windows, there we rely on the background thread
2821  * setting the signal variable on unexpected but graceful exit. If the WAL
2822  * stream thread crashes on Windows it will bring down the entire process
2823  * as it's a thread, so there is nothing to catch should that happen. A
2824  * crash on UNIX will be caught by the signal handler.
2825  */
2827 #endif
2828 
2829  /*
2830  * Set umask so that directories/files are created with the same
2831  * permissions as directories/files in the source data directory.
2832  *
2833  * pg_mode_mask is set to owner-only by default and then updated in
2834  * GetConnection() where we get the mode from the server-side with
2835  * RetrieveDataDirCreatePerm() and then call SetDataDirectoryCreatePerm().
2836  */
2837  umask(pg_mode_mask);
2838 
2839  /* Backup manifests are supported in 13 and newer versions */
2841  manifest = false;
2842 
2843  /*
2844  * If an output directory was specified, verify that it exists, or create
2845  * it. Note that for a tar backup, an output directory of "-" means we are
2846  * writing to stdout, so do nothing in that case.
2847  */
2848  if (basedir != NULL && (format == 'p' || strcmp(basedir, "-") != 0))
2850 
2851  /* determine remote server's xlog segment size */
2852  if (!RetrieveWalSegSize(conn))
2853  exit(1);
2854 
2855  /* Create pg_wal symlink, if required */
2856  if (xlog_dir)
2857  {
2858  char *linkloc;
2859 
2861 
2862  /*
2863  * Form name of the place where the symlink must go. pg_xlog has been
2864  * renamed to pg_wal in post-10 clusters.
2865  */
2866  linkloc = psprintf("%s/%s", basedir,
2868  "pg_xlog" : "pg_wal");
2869 
2870  if (symlink(xlog_dir, linkloc) != 0)
2871  pg_fatal("could not create symbolic link \"%s\": %m", linkloc);
2872  free(linkloc);
2873  }
2874 
2875  BaseBackup(compression_algorithm, compression_detail, compressloc,
2876  &client_compress, incremental_manifest);
2877 
2878  success = true;
2879  return 0;
2880 }
Datum now(PG_FUNCTION_ARGS)
Definition: timestamp.c:1618
#define MAX_RATE_UPPER
Definition: basebackup.h:21
bbstreamer * bbstreamer_gzip_writer_new(char *pathname, FILE *file, pg_compress_specification *compress)
bbstreamer * bbstreamer_zstd_compressor_new(bbstreamer *next, pg_compress_specification *compress)
static void bbstreamer_content(bbstreamer *streamer, bbstreamer_member *member, const char *data, int len, bbstreamer_archive_context context)
Definition: bbstreamer.h:126
static void bbstreamer_finalize(bbstreamer *streamer)
Definition: bbstreamer.h:136
bbstreamer * bbstreamer_tar_terminator_new(bbstreamer *next)
bbstreamer * bbstreamer_lz4_compressor_new(bbstreamer *next, pg_compress_specification *compress)
bbstreamer * bbstreamer_tar_parser_new(bbstreamer *next)
bbstreamer * bbstreamer_lz4_decompressor_new(bbstreamer *next)
@ BBSTREAMER_UNKNOWN
Definition: bbstreamer.h:55
static void bbstreamer_free(bbstreamer *streamer)
Definition: bbstreamer.h:144
bbstreamer * bbstreamer_recovery_injector_new(bbstreamer *next, bool is_recovery_guc_supported, PQExpBuffer recoveryconfcontents)
bbstreamer * bbstreamer_tar_archiver_new(bbstreamer *next)
bbstreamer * bbstreamer_zstd_decompressor_new(bbstreamer *next)
bbstreamer * bbstreamer_plain_writer_new(char *pathname, FILE *file)
bbstreamer * bbstreamer_extractor_new(const char *basepath, const char *(*link_map)(const char *), void(*report_output_file)(const char *))
bbstreamer * bbstreamer_gzip_decompressor_new(bbstreamer *next)
void bbstreamer_inject_file(bbstreamer *streamer, char *pathname, char *data, int len)
#define unconstify(underlying_type, expr)
Definition: c.h:1245
unsigned int uint32
Definition: c.h:506
signed int int32
Definition: c.h:494
#define ngettext(s, p, n)
Definition: c.h:1181
#define SIGNAL_ARGS
Definition: c.h:1345
#define Assert(condition)
Definition: c.h:858
#define PG_TEXTDOMAIN(domain)
Definition: c.h:1214
#define PG_BINARY
Definition: c.h:1273
#define UINT64_FORMAT
Definition: c.h:549
void set_pglocale_pgservice(const char *argv0, const char *app)
Definition: exec.c:448
bool parse_compress_algorithm(char *name, pg_compress_algorithm *algorithm)
Definition: compression.c:49
void parse_compress_specification(pg_compress_algorithm algorithm, char *specification, pg_compress_specification *result)
Definition: compression.c:107
char * validate_compress_specification(pg_compress_specification *spec)
Definition: compression.c:344
pg_compress_algorithm
Definition: compression.h:22
@ PG_COMPRESSION_GZIP
Definition: compression.h:24
@ PG_COMPRESSION_LZ4
Definition: compression.h:25
@ PG_COMPRESSION_NONE
Definition: compression.h:23
@ PG_COMPRESSION_ZSTD
Definition: compression.h:26
void parse_compress_options(const char *option, char **algorithm, char **detail)
PGconn * GetConnection(UserMapping *user, bool will_prep_stmt, PgFdwConnState **state)
Definition: connection.c:177
#define _(x)
Definition: elog.c:90
int durable_rename(const char *oldfile, const char *newfile, int elevel)
Definition: fd.c:782
const char * PQparameterStatus(const PGconn *conn, const char *paramName)
Definition: fe-connect.c:7106
int PQserverVersion(const PGconn *conn)
Definition: fe-connect.c:7131
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:7141
void PQfinish(PGconn *conn)
Definition: fe-connect.c:4862
int PQbackendPID(const PGconn *conn)
Definition: fe-connect.c:7175
void PQfreemem(void *ptr)
Definition: fe-exec.c:4032
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:3411
int PQputCopyEnd(PGconn *conn, const char *errormsg)
Definition: fe-exec.c:2749
int PQntuples(const PGresult *res)
Definition: fe-exec.c:3481
int PQputCopyData(PGconn *conn, const char *buffer, int nbytes)
Definition: fe-exec.c:2695
char * PQgetvalue(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3876
int PQgetisnull(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3901
int PQsendQuery(PGconn *conn, const char *query)
Definition: fe-exec.c:1416
char * PQresStatus(ExecStatusType status)
Definition: fe-exec.c:3419
char * PQresultErrorField(const PGresult *res, int fieldcode)
Definition: fe-exec.c:3466
int PQnfields(const PGresult *res)
Definition: fe-exec.c:3489
PGresult * PQgetResult(PGconn *conn)
Definition: fe-exec.c:2062
int PQgetCopyData(PGconn *conn, char **buffer, int async)
Definition: fe-exec.c:2816
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
void pg_free(void *ptr)
Definition: fe_memutils.c:105
int pg_mode_mask
Definition: file_perm.c:25
int pg_dir_create_mode
Definition: file_perm.c:18
DataDirSyncMethod
Definition: file_utils.h:28
@ DATA_DIR_SYNC_METHOD_FSYNC
Definition: file_utils.h:29
int getopt_long(int argc, char *const argv[], const char *optstring, const struct option *longopts, int *longindex)
Definition: getopt_long.c:60
#define no_argument
Definition: getopt_long.h:24
#define required_argument
Definition: getopt_long.h:25
#define free(a)
Definition: header.h:65
#define colon
Definition: indent_codes.h:43
#define write(a, b, c)
Definition: win32.h:14
#define read(a, b, c)
Definition: win32.h:13
int i
Definition: isn.c:73
@ PGRES_COPY_IN
Definition: libpq-fe.h:107
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:100
@ PGRES_FATAL_ERROR
Definition: libpq-fe.h:111
@ PGRES_COPY_OUT
Definition: libpq-fe.h:106
@ PGRES_TUPLES_OK
Definition: libpq-fe.h:103
exit(1)
void pg_logging_init(const char *argv0)
Definition: logging.c:83
#define pg_log_error(...)
Definition: logging.h:106
#define pg_log_error_hint(...)
Definition: logging.h:112
#define pg_log_info(...)
Definition: logging.h:124
#define pg_log_error_detail(...)
Definition: logging.h:109
const char * progname
Definition: main.c:44
char * pnstrdup(const char *in, Size len)
Definition: mcxt.c:1706
bool option_parse_int(const char *optarg, const char *optname, int min_range, int max_range, int *result)
Definition: option_utils.c:50
bool parse_sync_method(const char *optarg, DataDirSyncMethod *sync_method)
Definition: option_utils.c:90
void * arg
#define pg_fatal(...)
static void BaseBackup(char *compression_algorithm, char *compression_detail, CompressionLocation compressloc, pg_compress_specification *client_compress, char *incremental_manifest)
static void ReceiveArchiveStreamChunk(size_t r, char *copybuf, void *callback_data)
static int verbose
static bool checksum_failure
void(* WriteDataCallback)(size_t nbytes, char *buf, void *callback_data)
Definition: pg_basebackup.c:79
static bool noclean
static bool estimatesize
static bool found_existing_pgdata
static bool manifest
static bool found_existing_xlogdir
#define MINIMUM_VERSION_FOR_TEMP_SLOTS
Definition: pg_basebackup.c:91
static int32 maxrate
static void ReceiveTarFile(PGconn *conn, char *archive_name, char *spclocation, bool tablespacenum, pg_compress_specification *compress)
static char * backup_target
static char format
static char * xlog_dir
static void ReceiveCopyData(PGconn *conn, WriteDataCallback callback, void *callback_data)
static void StartLogStreamer(char *startpos, uint32 timeline, char *sysidentifier, pg_compress_algorithm wal_compress_algorithm, int wal_compress_level)
static void ReceiveBackupManifestChunk(size_t r, char *copybuf, void *callback_data)
int main(int argc, char **argv)
static char * GetCopyDataString(size_t r, char *copybuf, size_t *cursor)
static int32 parse_max_rate(char *src)
IncludeWal
@ STREAM_WAL
@ FETCH_WAL
@ NO_WAL
static volatile sig_atomic_t bgchild_exited
static int bgpipe[2]
static bool create_slot
static void ReceiveTarCopyChunk(size_t r, char *copybuf, void *callback_data)
static int LogStreamerMain(logstreamer_param *param)
static void ReceiveArchiveStream(PGconn *conn, pg_compress_specification *compress)
static void backup_parse_compress_options(char *option, char **algorithm, char **detail, CompressionLocation *locationres)
static PQExpBuffer recoveryconfcontents
static int tablespacecount
static void progress_update_filename(const char *filename)
static pid_t bgchild
CompressionLocation
@ COMPRESS_LOCATION_UNSPECIFIED
@ COMPRESS_LOCATION_CLIENT
@ COMPRESS_LOCATION_SERVER
static bool reached_end_position(XLogRecPtr segendpos, uint32 timeline, bool segment_finished)
static int has_xlogendptr
static void verify_dir_is_empty_or_create(char *dirname, bool *created, bool *found)
static char * progress_filename
static uint64 totalsize_kb
struct WriteTarState WriteTarState
static pg_time_t last_progress_report
static bool verify_checksums
static char * replication_slot
static void GetCopyDataEnd(size_t r, char *copybuf, size_t cursor)
static bool success
static void ReceiveBackupManifest(PGconn *conn)
static uint64 totaldone
static void progress_report(int tablespacenum, bool force, bool finished)
static bool manifest_force_encode
static char * manifest_checksums
#define MINIMUM_VERSION_FOR_TERMINATED_TARFILE
static TablespaceList tablespace_dirs
static bool found_tablespace_dirs
static bool in_log_streamer
static bool made_new_xlogdir
struct TablespaceList TablespaceList
static IncludeWal includewal
static void ReportCopyDataParseError(size_t r, char *copybuf)
struct ArchiveStreamState ArchiveStreamState
static bool do_sync
static bool writerecoveryconf
static bbstreamer * CreateBackupStreamer(char *archive_name, char *spclocation, bbstreamer **manifest_inject_streamer_p, bool is_recovery_guc_supported, bool expect_unterminated_tarfile, pg_compress_specification *compress)
static void cleanup_directories_atexit(void)
static bool temp_replication_slot
#define MINIMUM_VERSION_FOR_MANIFESTS
Definition: pg_basebackup.c:96
static bool no_slot
static bool made_tablespace_dirs
static char GetCopyDataByte(size_t r, char *copybuf, size_t *cursor)
#define VERBOSE_FILENAME_LENGTH
static uint64 GetCopyDataUInt64(size_t r, char *copybuf, size_t *cursor)
static bool fastcheckpoint
struct WriteManifestState WriteManifestState
static bool made_new_pgdata
static void kill_bgchild_atexit(void)
static DataDirSyncMethod sync_method
struct TablespaceListCell TablespaceListCell
#define ERRCODE_DATA_CORRUPTED
Definition: pg_basebackup.c:41
static char * label
static void ReceiveBackupManifestInMemoryChunk(size_t r, char *copybuf, void *callback_data)
static bool showprogress
static void usage(void)
static void tablespace_list_append(const char *arg)
static const char * get_tablespace_mapping(const char *dir)
static char * basedir
static void disconnect_atexit(void)
static void ReceiveBackupManifestInMemory(PGconn *conn, PQExpBuffer buf)
static XLogRecPtr xlogendptr
#define MINIMUM_VERSION_FOR_PG_WAL
Definition: pg_basebackup.c:86
static int standby_message_timeout
#define MINIMUM_VERSION_FOR_WAL_SUMMARIES
static void sigchld_handler(SIGNAL_ARGS)
#define pg_ntoh64(x)
Definition: pg_bswap.h:126
#define MAXPGPATH
static char * filename
Definition: pg_dumpall.c:119
PGDLLIMPORT int optind
Definition: getopt.c:50
PGDLLIMPORT char * optarg
Definition: getopt.c:52
static pg_compress_algorithm compression_algorithm
Definition: pg_receivewal.c:55
static XLogRecPtr endpos
Definition: pg_receivewal.c:56
static XLogRecPtr startpos
static char * buf
Definition: pg_test_fsync.c:73
int64 pg_time_t
Definition: pgtime.h:23
int pg_mkdir_p(char *path, int omode)
Definition: pgmkdirp.c:57
#define is_absolute_path(filename)
Definition: port.h:103
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
void canonicalize_path(char *path)
Definition: path.c:264
int pg_check_dir(const char *dir)
Definition: pgcheckdir.c:33
const char * get_progname(const char *argv0)
Definition: path.c:574
pqsigfunc pqsignal(int signo, pqsigfunc func)
#define snprintf
Definition: port.h:238
#define fprintf
Definition: port.h:242
#define PGINVALID_SOCKET
Definition: port.h:31
#define is_windows_absolute_path(filename)
Definition: port.h:89
#define printf(...)
Definition: port.h:244
size_t strlcat(char *dst, const char *src, size_t siz)
Definition: strlcat.c:33
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
#define is_nonwindows_absolute_path(filename)
Definition: port.h:82
#define PG_DIAG_SQLSTATE
Definition: postgres_ext.h:56
PQExpBuffer createPQExpBuffer(void)
Definition: pqexpbuffer.c:72
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:90
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:265
void destroyPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:114
void termPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:129
#define PQExpBufferDataBroken(buf)
Definition: pqexpbuffer.h:67
char * c
static int fd(const char *x, int i)
Definition: preproc-init.c:105
char * psprintf(const char *fmt,...)
Definition: psprintf.c:46
bool ReceiveXlogStream(PGconn *conn, StreamCtl *stream)
Definition: receivelog.c:453
bool CheckServerVersionForStreaming(PGconn *conn)
Definition: receivelog.c:375
PQExpBuffer GenerateRecoveryConfig(PGconn *pgconn, const char *replication_slot, char *dbname)
Definition: recovery_gen.c:27
#define MINIMUM_VERSION_FOR_RECOVERY_GUC
Definition: recovery_gen.h:21
bool rmtree(const char *path, bool rmtopdir)
Definition: rmtree.c:50
void AppendIntegerCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name, int32 option_value)
Definition: streamutil.c:853
int dbgetpassword
Definition: streamutil.c:53
bool RetrieveWalSegSize(PGconn *conn)
Definition: streamutil.c:344
int WalSegSz
Definition: streamutil.c:34
char * dbhost
Definition: streamutil.c:49
char * GetDbnameFromConnectionOptions(void)
Definition: streamutil.c:305
char * dbport
Definition: streamutil.c:51
void AppendPlainCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name)
Definition: streamutil.c:809
void AppendStringCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name, char *option_value)
Definition: streamutil.c:830
char * connection_string
Definition: streamutil.c:48
PGconn * conn
Definition: streamutil.c:55
bool RunIdentifySystem(PGconn *conn, char **sysid, TimeLineID *starttli, XLogRecPtr *startpos, char **db_name)
Definition: streamutil.c:477
char * dbuser
Definition: streamutil.c:50
char manifest_filename[MAXPGPATH]
Definition: pg_basebackup.c:63
pg_compress_specification * compress
Definition: pg_basebackup.c:59
bbstreamer * manifest_inject_streamer
Definition: pg_basebackup.c:61
bbstreamer * streamer
Definition: pg_basebackup.c:60
PQExpBuffer manifest_buffer
Definition: pg_basebackup.c:62
char * sysidentifier
Definition: receivelog.h:33
TimeLineID timeline
Definition: receivelog.h:32
stream_stop_callback stream_stop
Definition: receivelog.h:41
char * replication_slot
Definition: receivelog.h:48
XLogRecPtr startpos
Definition: receivelog.h:31
bool do_sync
Definition: receivelog.h:38
pgsocket stop_socket
Definition: receivelog.h:43
int standby_message_timeout
Definition: receivelog.h:35
WalWriteMethod * walmethod
Definition: receivelog.h:46
bool mark_done
Definition: receivelog.h:37
char * partial_suffix
Definition: receivelog.h:47
bool synchronous
Definition: receivelog.h:36
struct TablespaceListCell * next
Definition: pg_basebackup.c:45
char old_dir[MAXPGPATH]
Definition: pg_basebackup.c:46
char new_dir[MAXPGPATH]
Definition: pg_basebackup.c:47
TablespaceListCell * tail
Definition: pg_basebackup.c:53
TablespaceListCell * head
Definition: pg_basebackup.c:52
void(* free)(WalWriteMethod *wwmethod)
Definition: walmethods.h:92
bool(* finish)(WalWriteMethod *wwmethod)
Definition: walmethods.h:86
const WalWriteMethodOps * ops
Definition: walmethods.h:105
char filename[MAXPGPATH]
Definition: pg_basebackup.c:75
bbstreamer * streamer
Definition: pg_basebackup.c:70
Definition: type.h:137
XLogRecPtr startptr
pg_compress_algorithm wal_compress_algorithm
char xlog[MAXPGPATH]
pg_compress_algorithm algorithm
Definition: compression.h:34
Definition: regguts.h:323
static StringInfo copybuf
Definition: tablesync.c:130
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:46
char * wait_result_to_str(int exitstatus)
Definition: wait_error.c:33
WalWriteMethod * CreateWalDirectoryMethod(const char *basedir, pg_compress_algorithm compression_algorithm, int compression_level, bool sync)
Definition: walmethods.c:640
WalWriteMethod * CreateWalTarMethod(const char *tarbase, pg_compress_algorithm compression_algorithm, int compression_level, bool sync)
Definition: walmethods.c:1355
static void CreateReplicationSlot(CreateReplicationSlotCmd *cmd)
Definition: walsender.c:1200
#define SIGCHLD
Definition: win32_port.h:178
void _dosmaperr(unsigned long)
Definition: win32error.c:177
#define kill(pid, sig)
Definition: win32_port.h:485
#define symlink(oldpath, newpath)
Definition: win32_port.h:235
#define select(n, r, w, e, timeout)
Definition: win32_port.h:495
#define XLogSegmentOffset(xlogptr, wal_segsz_bytes)
uint64 XLogRecPtr
Definition: xlogdefs.h:21
uint32 TimeLineID
Definition: xlogdefs.h:59
static const char * directory
Definition: zic.c:634