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-2019, 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 <sys/stat.h>
19#include <sys/wait.h>
20#include <signal.h>
21#include <time.h>
22#ifdef HAVE_SYS_SELECT_H
23#include <sys/select.h>
24#endif
25#ifdef HAVE_LIBZ
26#include <zlib.h>
27#endif
28
29#include "access/xlog_internal.h"
30#include "common/file_perm.h"
31#include "common/file_utils.h"
32#include "common/logging.h"
33#include "common/string.h"
34#include "fe_utils/string_utils.h"
35#include "getopt_long.h"
36#include "libpq-fe.h"
37#include "pqexpbuffer.h"
38#include "pgtar.h"
39#include "pgtime.h"
40#include "receivelog.h"
41#include "replication/basebackup.h"
42#include "streamutil.h"
43
44#define ERRCODE_DATA_CORRUPTED "XX001"
45
46typedef struct TablespaceListCell
47{
48 struct TablespaceListCell *next;
49 char old_dir[MAXPGPATH];
50 char new_dir[MAXPGPATH];
51} TablespaceListCell;
52
53typedef struct TablespaceList
54{
55 TablespaceListCell *head;
56 TablespaceListCell *tail;
57} TablespaceList;
58
59/*
60 * pg_xlog has been renamed to pg_wal in version 10. This version number
61 * should be compared with PQserverVersion().
62 */
63#define MINIMUM_VERSION_FOR_PG_WAL 100000
64
65/*
66 * Temporary replication slots are supported from version 10.
67 */
68#define MINIMUM_VERSION_FOR_TEMP_SLOTS 100000
69
70/*
71 * recovery.conf is integrated into postgresql.conf from version 12.
72 */
73#define MINIMUM_VERSION_FOR_RECOVERY_GUC 120000
74
75/*
76 * Different ways to include WAL
77 */
78typedef enum
79{
80 NO_WAL,
81 FETCH_WAL,
82 STREAM_WAL
83} IncludeWal;
84
85/* Global options */
86static char *basedir = NULL;
87static TablespaceList tablespace_dirs = {NULL, NULL};
88static char *xlog_dir = NULL;
89static char format = 'p'; /* p(lain)/t(ar) */
90static char *label = "pg_basebackup base backup";
91static bool noclean = false;
92static bool checksum_failure = false;
93static bool showprogress = false;
94static int verbose = 0;
95static int compresslevel = 0;
96static IncludeWal includewal = STREAM_WAL;
97static bool fastcheckpoint = false;
98static bool writerecoveryconf = false;
99static bool do_sync = true;
100static int standby_message_timeout = 10 * 1000; /* 10 sec = default */
101static pg_time_t last_progress_report = 0;
102static int32 maxrate = 0; /* no limit by default */
103static char *replication_slot = NULL;
104static bool temp_replication_slot = true;
105static bool create_slot = false;
106static bool no_slot = false;
107static bool verify_checksums = true;
108
109static bool success = false;
110static bool made_new_pgdata = false;
111static bool found_existing_pgdata = false;
112static bool made_new_xlogdir = false;
113static bool found_existing_xlogdir = false;
114static bool made_tablespace_dirs = false;
115static bool found_tablespace_dirs = false;
116
117/* Progress counters */
118static uint64 totalsize;
119static uint64 totaldone;
120static int tablespacecount;
121
122/* Pipe to communicate with background wal receiver process */
123#ifndef WIN32
124static int bgpipe[2] = {-1, -1};
125#endif
126
127/* Handle to child process */
128static pid_t bgchild = -1;
129static bool in_log_streamer = false;
130
131/* End position for xlog streaming, empty string if unknown yet */
132static XLogRecPtr xlogendptr;
133
134#ifndef WIN32
135static int has_xlogendptr = 0;
136#else
137static volatile LONG has_xlogendptr = 0;
138#endif
139
140/* Contents of configuration file to be generated */
141static PQExpBuffer recoveryconfcontents = NULL;
142
143/* Function headers */
144static void usage(void);
145static void verify_dir_is_empty_or_create(char *dirname, bool *created, bool *found);
146static void progress_report(int tablespacenum, const char *filename, bool force);
147
148static void ReceiveTarFile(PGconn *conn, PGresult *res, int rownum);
149static void ReceiveAndUnpackTarFile(PGconn *conn, PGresult *res, int rownum);
150static void GenerateRecoveryConf(PGconn *conn);
151static void WriteRecoveryConf(void);
152static void BaseBackup(void);
153
154static bool reached_end_position(XLogRecPtr segendpos, uint32 timeline,
155 bool segment_finished);
156
157static const char *get_tablespace_mapping(const char *dir);
158static void tablespace_list_append(const char *arg);
159
160
161static void
162cleanup_directories_atexit(void)
163{
164 if (success || in_log_streamer)
165 return;
166
167 if (!noclean && !checksum_failure)
168 {
169 if (made_new_pgdata)
170 {
171 pg_log_info("removing data directory \"%s\"", basedir);
172 if (!rmtree(basedir, true))
173 pg_log_error("failed to remove data directory");
174 }
175 else if (found_existing_pgdata)
176 {
177 pg_log_info("removing contents of data directory \"%s\"", basedir);
178 if (!rmtree(basedir, false))
179 pg_log_error("failed to remove contents of data directory");
180 }
181
182 if (made_new_xlogdir)
183 {
184 pg_log_info("removing WAL directory \"%s\"", xlog_dir);
185 if (!rmtree(xlog_dir, true))
186 pg_log_error("failed to remove WAL directory");
187 }
188 else if (found_existing_xlogdir)
189 {
190 pg_log_info("removing contents of WAL directory \"%s\"", xlog_dir);
191 if (!rmtree(xlog_dir, false))
192 pg_log_error("failed to remove contents of WAL directory");
193 }
194 }
195 else
196 {
197 if ((made_new_pgdata || found_existing_pgdata) && !checksum_failure)
198 pg_log_info("data directory \"%s\" not removed at user's request", basedir);
199
200 if (made_new_xlogdir || found_existing_xlogdir)
201 pg_log_info("WAL directory \"%s\" not removed at user's request", xlog_dir);
202 }
203
204 if ((made_tablespace_dirs || found_tablespace_dirs) && !checksum_failure)
205 pg_log_info("changes to tablespace directories will not be undone");
206}
207
208static void
209disconnect_atexit(void)
210{
211 if (conn != NULL)
212 PQfinish(conn);
213}
214
215#ifndef WIN32
216/*
217 * On windows, our background thread dies along with the process. But on
218 * Unix, if we have started a subprocess, we want to kill it off so it
219 * doesn't remain running trying to stream data.
220 */
221static void
222kill_bgchild_atexit(void)
223{
224 if (bgchild > 0)
225 kill(bgchild, SIGTERM);
226}
227#endif
228
229/*
230 * Split argument into old_dir and new_dir and append to tablespace mapping
231 * list.
232 */
233static void
234tablespace_list_append(const char *arg)
235{
236 TablespaceListCell *cell = (TablespaceListCell *) pg_malloc0(sizeof(TablespaceListCell));
237 char *dst;
238 char *dst_ptr;
239 const char *arg_ptr;
240
241 dst_ptr = dst = cell->old_dir;
242 for (arg_ptr = arg; *arg_ptr; arg_ptr++)
243 {
244 if (dst_ptr - dst >= MAXPGPATH)
245 {
246 pg_log_error("directory name too long");
247 exit(1);
248 }
249
250 if (*arg_ptr == '\\' && *(arg_ptr + 1) == '=')
251 ; /* skip backslash escaping = */
252 else if (*arg_ptr == '=' && (arg_ptr == arg || *(arg_ptr - 1) != '\\'))
253 {
254 if (*cell->new_dir)
255 {
256 pg_log_error("multiple \"=\" signs in tablespace mapping");
257 exit(1);
258 }
259 else
260 dst = dst_ptr = cell->new_dir;
261 }
262 else
263 *dst_ptr++ = *arg_ptr;
264 }
265
266 if (!*cell->old_dir || !*cell->new_dir)
267 {
268 pg_log_error("invalid tablespace mapping format \"%s\", must be \"OLDDIR=NEWDIR\"", arg);
269 exit(1);
270 }
271
272 /*
273 * This check isn't absolutely necessary. But all tablespaces are created
274 * with absolute directories, so specifying a non-absolute path here would
275 * just never match, possibly confusing users. It's also good to be
276 * consistent with the new_dir check.
277 */
278 if (!is_absolute_path(cell->old_dir))
279 {
280 pg_log_error("old directory is not an absolute path in tablespace mapping: %s",
281 cell->old_dir);
282 exit(1);
283 }
284
285 if (!is_absolute_path(cell->new_dir))
286 {
287 pg_log_error("new directory is not an absolute path in tablespace mapping: %s",
288 cell->new_dir);
289 exit(1);
290 }
291
292 /*
293 * Comparisons done with these values should involve similarly
294 * canonicalized path values. This is particularly sensitive on Windows
295 * where path values may not necessarily use Unix slashes.
296 */
297 canonicalize_path(cell->old_dir);
298 canonicalize_path(cell->new_dir);
299
300 if (tablespace_dirs.tail)
301 tablespace_dirs.tail->next = cell;
302 else
303 tablespace_dirs.head = cell;
304 tablespace_dirs.tail = cell;
305}
306
307
308#ifdef HAVE_LIBZ
309static const char *
310get_gz_error(gzFile gzf)
311{
312 int errnum;
313 const char *errmsg;
314
315 errmsg = gzerror(gzf, &errnum);
316 if (errnum == Z_ERRNO)
317 return strerror(errno);
318 else
319 return errmsg;
320}
321#endif
322
323static void
324usage(void)
325{
326 printf(_("%s takes a base backup of a running PostgreSQL server.\n\n"),
327 progname);
328 printf(_("Usage:\n"));
329 printf(_(" %s [OPTION]...\n"), progname);
330 printf(_("\nOptions controlling the output:\n"));
331 printf(_(" -D, --pgdata=DIRECTORY receive base backup into directory\n"));
332 printf(_(" -F, --format=p|t output format (plain (default), tar)\n"));
333 printf(_(" -r, --max-rate=RATE maximum transfer rate to transfer data directory\n"
334 " (in kB/s, or use suffix \"k\" or \"M\")\n"));
335 printf(_(" -R, --write-recovery-conf\n"
336 " write configuration for replication\n"));
337 printf(_(" -T, --tablespace-mapping=OLDDIR=NEWDIR\n"
338 " relocate tablespace in OLDDIR to NEWDIR\n"));
339 printf(_(" --waldir=WALDIR location for the write-ahead log directory\n"));
340 printf(_(" -X, --wal-method=none|fetch|stream\n"
341 " include required WAL files with specified method\n"));
342 printf(_(" -z, --gzip compress tar output\n"));
343 printf(_(" -Z, --compress=0-9 compress tar output with given compression level\n"));
344 printf(_("\nGeneral options:\n"));
345 printf(_(" -c, --checkpoint=fast|spread\n"
346 " set fast or spread checkpointing\n"));
347 printf(_(" -C, --create-slot create replication slot\n"));
348 printf(_(" -l, --label=LABEL set backup label\n"));
349 printf(_(" -n, --no-clean do not clean up after errors\n"));
350 printf(_(" -N, --no-sync do not wait for changes to be written safely to disk\n"));
351 printf(_(" -P, --progress show progress information\n"));
352 printf(_(" -S, --slot=SLOTNAME replication slot to use\n"));
353 printf(_(" -v, --verbose output verbose messages\n"));
354 printf(_(" -V, --version output version information, then exit\n"));
355 printf(_(" --no-slot prevent creation of temporary replication slot\n"));
356 printf(_(" --no-verify-checksums\n"
357 " do not verify checksums\n"));
358 printf(_(" -?, --help show this help, then exit\n"));
359 printf(_("\nConnection options:\n"));
360 printf(_(" -d, --dbname=CONNSTR connection string\n"));
361 printf(_(" -h, --host=HOSTNAME database server host or socket directory\n"));
362 printf(_(" -p, --port=PORT database server port number\n"));
363 printf(_(" -s, --status-interval=INTERVAL\n"
364 " time between status packets sent to server (in seconds)\n"));
365 printf(_(" -U, --username=NAME connect as specified database user\n"));
366 printf(_(" -w, --no-password never prompt for password\n"));
367 printf(_(" -W, --password force password prompt (should happen automatically)\n"));
368 printf(_("\nReport bugs to <pgsql-bugs@lists.postgresql.org>.\n"));
369}
370
371
372/*
373 * Called in the background process every time data is received.
374 * On Unix, we check to see if there is any data on our pipe
375 * (which would mean we have a stop position), and if it is, check if
376 * it is time to stop.
377 * On Windows, we are in a single process, so we can just check if it's
378 * time to stop.
379 */
380static bool
381reached_end_position(XLogRecPtr segendpos, uint32 timeline,
382 bool segment_finished)
383{
384 if (!has_xlogendptr)
385 {
386#ifndef WIN32
387 fd_set fds;
388 struct timeval tv;
389 int r;
390
391 /*
392 * Don't have the end pointer yet - check our pipe to see if it has
393 * been sent yet.
394 */
395 FD_ZERO(&fds);
396 FD_SET(bgpipe[0], &fds);
397
398 MemSet(&tv, 0, sizeof(tv));
399
400 r = select(bgpipe[0] + 1, &fds, NULL, NULL, &tv);
401 if (r == 1)
402 {
403 char xlogend[64];
404 uint32 hi,
405 lo;
406
407 MemSet(xlogend, 0, sizeof(xlogend));
408 r = read(bgpipe[0], xlogend, sizeof(xlogend) - 1);
409 if (r < 0)
410 {
411 pg_log_error("could not read from ready pipe: %m");
412 exit(1);
413 }
414
415 if (sscanf(xlogend, "%X/%X", &hi, &lo) != 2)
416 {
417 pg_log_error("could not parse write-ahead log location \"%s\"",
418 xlogend);
419 exit(1);
420 }
421 xlogendptr = ((uint64) hi) << 32 | lo;
422 has_xlogendptr = 1;
423
424 /*
425 * Fall through to check if we've reached the point further
426 * already.
427 */
428 }
429 else
430 {
431 /*
432 * No data received on the pipe means we don't know the end
433 * position yet - so just say it's not time to stop yet.
434 */
435 return false;
436 }
437#else
438
439 /*
440 * On win32, has_xlogendptr is set by the main thread, so if it's not
441 * set here, we just go back and wait until it shows up.
442 */
443 return false;
444#endif
445 }
446
447 /*
448 * At this point we have an end pointer, so compare it to the current
449 * position to figure out if it's time to stop.
450 */
451 if (segendpos >= xlogendptr)
452 return true;
453
454 /*
455 * Have end pointer, but haven't reached it yet - so tell the caller to
456 * keep streaming.
457 */
458 return false;
459}
460
461typedef struct
462{
463 PGconn *bgconn;
464 XLogRecPtr startptr;
465 char xlog[MAXPGPATH]; /* directory or tarfile depending on mode */
466 char *sysidentifier;
467 int timeline;
468} logstreamer_param;
469
470static int
471LogStreamerMain(logstreamer_param *param)
472{
473 StreamCtl stream;
474
475 in_log_streamer = true;
476
477 MemSet(&stream, 0, sizeof(stream));
478 stream.startpos = param->startptr;
479 stream.timeline = param->timeline;
480 stream.sysidentifier = param->sysidentifier;
481 stream.stream_stop = reached_end_position;
482#ifndef WIN32
483 stream.stop_socket = bgpipe[0];
484#else
485 stream.stop_socket = PGINVALID_SOCKET;
486#endif
487 stream.standby_message_timeout = standby_message_timeout;
488 stream.synchronous = false;
489 /* fsync happens at the end of pg_basebackup for all data */
490 stream.do_sync = false;
491 stream.mark_done = true;
492 stream.partial_suffix = NULL;
493 stream.replication_slot = replication_slot;
494
495 if (format == 'p')
496 stream.walmethod = CreateWalDirectoryMethod(param->xlog, 0,
497 stream.do_sync);
498 else
499 stream.walmethod = CreateWalTarMethod(param->xlog, compresslevel,
500 stream.do_sync);
501
502 if (!ReceiveXlogStream(param->bgconn, &stream))
503
504 /*
505 * Any errors will already have been reported in the function process,
506 * but we need to tell the parent that we didn't shutdown in a nice
507 * way.
508 */
509 return 1;
510
511 if (!stream.walmethod->finish())
512 {
513 pg_log_error("could not finish writing WAL files: %m");
514 return 1;
515 }
516
517 PQfinish(param->bgconn);
518
519 if (format == 'p')
520 FreeWalDirectoryMethod();
521 else
522 FreeWalTarMethod();
523 pg_free(stream.walmethod);
524
525 return 0;
526}
527
528/*
529 * Initiate background process for receiving xlog during the backup.
530 * The background stream will use its own database connection so we can
531 * stream the logfile in parallel with the backups.
532 */
533static void
534StartLogStreamer(char *startpos, uint32 timeline, char *sysidentifier)
535{
536 logstreamer_param *param;
537 uint32 hi,
538 lo;
539 char statusdir[MAXPGPATH];
540
541 param = pg_malloc0(sizeof(logstreamer_param));
542 param->timeline = timeline;
543 param->sysidentifier = sysidentifier;
544
545 /* Convert the starting position */
546 if (sscanf(startpos, "%X/%X", &hi, &lo) != 2)
547 {
548 pg_log_error("could not parse write-ahead log location \"%s\"",
549 startpos);
550 exit(1);
551 }
552 param->startptr = ((uint64) hi) << 32 | lo;
553 /* Round off to even segment position */
554 param->startptr -= XLogSegmentOffset(param->startptr, WalSegSz);
555
556#ifndef WIN32
557 /* Create our background pipe */
558 if (pipe(bgpipe) < 0)
559 {
560 pg_log_error("could not create pipe for background process: %m");
561 exit(1);
562 }
563#endif
564
565 /* Get a second connection */
566 param->bgconn = GetConnection();
567 if (!param->bgconn)
568 /* Error message already written in GetConnection() */
569 exit(1);
570
571 /* In post-10 cluster, pg_xlog has been renamed to pg_wal */
572 snprintf(param->xlog, sizeof(param->xlog), "%s/%s",
573 basedir,
574 PQserverVersion(conn) < MINIMUM_VERSION_FOR_PG_WAL ?
575 "pg_xlog" : "pg_wal");
576
577 /* Temporary replication slots are only supported in 10 and newer */
578 if (PQserverVersion(conn) < MINIMUM_VERSION_FOR_TEMP_SLOTS)
579 temp_replication_slot = false;
580
581 /*
582 * Create replication slot if requested
583 */
584 if (temp_replication_slot && !replication_slot)
585 replication_slot = psprintf("pg_basebackup_%d", (int) PQbackendPID(param->bgconn));
586 if (temp_replication_slot || create_slot)
587 {
588 if (!CreateReplicationSlot(param->bgconn, replication_slot, NULL,
589 temp_replication_slot, true, true, false))
590 exit(1);
591
592 if (verbose)
593 {
594 if (temp_replication_slot)
595 pg_log_info("created temporary replication slot \"%s\"",
596 replication_slot);
597 else
598 pg_log_info("created replication slot \"%s\"",
599 replication_slot);
600 }
601 }
602
603 if (format == 'p')
604 {
605 /*
606 * Create pg_wal/archive_status or pg_xlog/archive_status (and thus
607 * pg_wal or pg_xlog) depending on the target server so we can write
608 * to basedir/pg_wal or basedir/pg_xlog as the directory entry in the
609 * tar file may arrive later.
610 */
611 snprintf(statusdir, sizeof(statusdir), "%s/%s/archive_status",
612 basedir,
613 PQserverVersion(conn) < MINIMUM_VERSION_FOR_PG_WAL ?
614 "pg_xlog" : "pg_wal");
615
616 if (pg_mkdir_p(statusdir, pg_dir_create_mode) != 0 && errno != EEXIST)
617 {
618 pg_log_error("could not create directory \"%s\": %m", statusdir);
619 exit(1);
620 }
621 }
622
623 /*
624 * Start a child process and tell it to start streaming. On Unix, this is
625 * a fork(). On Windows, we create a thread.
626 */
627#ifndef WIN32
628 bgchild = fork();
629 if (bgchild == 0)
630 {
631 /* in child process */
632 exit(LogStreamerMain(param));
633 }
634 else if (bgchild < 0)
635 {
636 pg_log_error("could not create background process: %m");
637 exit(1);
638 }
639
640 /*
641 * Else we are in the parent process and all is well.
642 */
643 atexit(kill_bgchild_atexit);
644#else /* WIN32 */
645 bgchild = _beginthreadex(NULL, 0, (void *) LogStreamerMain, param, 0, NULL);
646 if (bgchild == 0)
647 {
648 pg_log_error("could not create background thread: %m");
649 exit(1);
650 }
651#endif
652}
653
654/*
655 * Verify that the given directory exists and is empty. If it does not
656 * exist, it is created. If it exists but is not empty, an error will
657 * be given and the process ended.
658 */
659static void
660verify_dir_is_empty_or_create(char *dirname, bool *created, bool *found)
661{
662 switch (pg_check_dir(dirname))
663 {
664 case 0:
665
666 /*
667 * Does not exist, so create
668 */
669 if (pg_mkdir_p(dirname, pg_dir_create_mode) == -1)
670 {
671 pg_log_error("could not create directory \"%s\": %m", dirname);
672 exit(1);
673 }
674 if (created)
675 *created = true;
676 return;
677 case 1:
678
679 /*
680 * Exists, empty
681 */
682 if (found)
683 *found = true;
684 return;
685 case 2:
686 case 3:
687 case 4:
688
689 /*
690 * Exists, not empty
691 */
692 pg_log_error("directory \"%s\" exists but is not empty", dirname);
693 exit(1);
694 case -1:
695
696 /*
697 * Access problem
698 */
699 pg_log_error("could not access directory \"%s\": %m", dirname);
700 exit(1);
701 }
702}
703
704
705/*
706 * Print a progress report based on the global variables. If verbose output
707 * is enabled, also print the current file name.
708 *
709 * Progress report is written at maximum once per second, unless the
710 * force parameter is set to true.
711 */
712static void
713progress_report(int tablespacenum, const char *filename, bool force)
714{
715 int percent;
716 char totaldone_str[32];
717 char totalsize_str[32];
718 pg_time_t now;
719
720 if (!showprogress)
721 return;
722
723 now = time(NULL);
724 if (now == last_progress_report && !force)
725 return; /* Max once per second */
726
727 last_progress_report = now;
728 percent = totalsize ? (int) ((totaldone / 1024) * 100 / totalsize) : 0;
729
730 /*
731 * Avoid overflowing past 100% or the full size. This may make the total
732 * size number change as we approach the end of the backup (the estimate
733 * will always be wrong if WAL is included), but that's better than having
734 * the done column be bigger than the total.
735 */
736 if (percent > 100)
737 percent = 100;
738 if (totaldone / 1024 > totalsize)
739 totalsize = totaldone / 1024;
740
741 /*
742 * Separate step to keep platform-dependent format code out of
743 * translatable strings. And we only test for INT64_FORMAT availability
744 * in snprintf, not fprintf.
745 */
746 snprintf(totaldone_str, sizeof(totaldone_str), INT64_FORMAT,
747 totaldone / 1024);
748 snprintf(totalsize_str, sizeof(totalsize_str), INT64_FORMAT, totalsize);
749
750#define VERBOSE_FILENAME_LENGTH 35
751 if (verbose)
752 {
753 if (!filename)
754
755 /*
756 * No filename given, so clear the status line (used for last
757 * call)
758 */
759 fprintf(stderr,
760 ngettext("%*s/%s kB (100%%), %d/%d tablespace %*s",
761 "%*s/%s kB (100%%), %d/%d tablespaces %*s",
762 tablespacecount),
763 (int) strlen(totalsize_str),
764 totaldone_str, totalsize_str,
765 tablespacenum, tablespacecount,
766 VERBOSE_FILENAME_LENGTH + 5, "");
767 else
768 {
769 bool truncate = (strlen(filename) > VERBOSE_FILENAME_LENGTH);
770
771 fprintf(stderr,
772 ngettext("%*s/%s kB (%d%%), %d/%d tablespace (%s%-*.*s)",
773 "%*s/%s kB (%d%%), %d/%d tablespaces (%s%-*.*s)",
774 tablespacecount),
775 (int) strlen(totalsize_str),
776 totaldone_str, totalsize_str, percent,
777 tablespacenum, tablespacecount,
778 /* Prefix with "..." if we do leading truncation */
779 truncate ? "..." : "",
780 truncate ? VERBOSE_FILENAME_LENGTH - 3 : VERBOSE_FILENAME_LENGTH,
781 truncate ? VERBOSE_FILENAME_LENGTH - 3 : VERBOSE_FILENAME_LENGTH,
782 /* Truncate filename at beginning if it's too long */
783 truncate ? filename + strlen(filename) - VERBOSE_FILENAME_LENGTH + 3 : filename);
784 }
785 }
786 else
787 fprintf(stderr,
788 ngettext("%*s/%s kB (%d%%), %d/%d tablespace",
789 "%*s/%s kB (%d%%), %d/%d tablespaces",
790 tablespacecount),
791 (int) strlen(totalsize_str),
792 totaldone_str, totalsize_str, percent,
793 tablespacenum, tablespacecount);
794
795 if (isatty(fileno(stderr)))
796 fprintf(stderr, "\r");
797 else
798 fprintf(stderr, "\n");
799}
800
801static int32
802parse_max_rate(char *src)
803{
804 double result;
805 char *after_num;
806 char *suffix = NULL;
807
808 errno = 0;
809 result = strtod(src, &after_num);
810 if (src == after_num)
811 {
812 pg_log_error("transfer rate \"%s\" is not a valid value", src);
813 exit(1);
814 }
815 if (errno != 0)
816 {
817 pg_log_error("invalid transfer rate \"%s\": %m", src);
818 exit(1);
819 }
820
821 if (result <= 0)
822 {
823 /*
824 * Reject obviously wrong values here.
825 */
826 pg_log_error("transfer rate must be greater than zero");
827 exit(1);
828 }
829
830 /*
831 * Evaluate suffix, after skipping over possible whitespace. Lack of
832 * suffix means kilobytes.
833 */
834 while (*after_num != '\0' && isspace((unsigned char) *after_num))
835 after_num++;
836
837 if (*after_num != '\0')
838 {
839 suffix = after_num;
840 if (*after_num == 'k')
841 {
842 /* kilobyte is the expected unit. */
843 after_num++;
844 }
845 else if (*after_num == 'M')
846 {
847 after_num++;
848 result *= 1024.0;
849 }
850 }
851
852 /* The rest can only consist of white space. */
853 while (*after_num != '\0' && isspace((unsigned char) *after_num))
854 after_num++;
855
856 if (*after_num != '\0')
857 {
858 pg_log_error("invalid --max-rate unit: \"%s\"", suffix);
859 exit(1);
860 }
861
862 /* Valid integer? */
863 if ((uint64) result != (uint64) ((uint32) result))
864 {
865 pg_log_error("transfer rate \"%s\" exceeds integer range", src);
866 exit(1);
867 }
868
869 /*
870 * The range is checked on the server side too, but avoid the server
871 * connection if a nonsensical value was passed.
872 */
873 if (result < MAX_RATE_LOWER || result > MAX_RATE_UPPER)
874 {
875 pg_log_error("transfer rate \"%s\" is out of range", src);
876 exit(1);
877 }
878
879 return (int32) result;
880}
881
882/*
883 * Write a piece of tar data
884 */
885static void
886writeTarData(
887#ifdef HAVE_LIBZ
888 gzFile ztarfile,
889#endif
890 FILE *tarfile, char *buf, int r, char *current_file)
891{
892#ifdef HAVE_LIBZ
893 if (ztarfile != NULL)
894 {
895 if (gzwrite(ztarfile, buf, r) != r)
896 {
897 pg_log_error("could not write to compressed file \"%s\": %s",
898 current_file, get_gz_error(ztarfile));
899 exit(1);
900 }
901 }
902 else
903#endif
904 {
905 if (fwrite(buf, r, 1, tarfile) != 1)
906 {
907 pg_log_error("could not write to file \"%s\": %m", current_file);
908 exit(1);
909 }
910 }
911}
912
913#ifdef HAVE_LIBZ
914#define WRITE_TAR_DATA(buf, sz) writeTarData(ztarfile, tarfile, buf, sz, filename)
915#else
916#define WRITE_TAR_DATA(buf, sz) writeTarData(tarfile, buf, sz, filename)
917#endif
918
919/*
920 * Receive a tar format file from the connection to the server, and write
921 * the data from this file directly into a tar file. If compression is
922 * enabled, the data will be compressed while written to the file.
923 *
924 * The file will be named base.tar[.gz] if it's for the main data directory
925 * or <tablespaceoid>.tar[.gz] if it's for another tablespace.
926 *
927 * No attempt to inspect or validate the contents of the file is done.
928 */
929static void
930ReceiveTarFile(PGconn *conn, PGresult *res, int rownum)
931{
932 char filename[MAXPGPATH];
933 char *copybuf = NULL;
934 FILE *tarfile = NULL;
935 char tarhdr[512];
936 bool basetablespace = PQgetisnull(res, rownum, 0);
937 bool in_tarhdr = true;
938 bool skip_file = false;
939 bool is_recovery_guc_supported = true;
940 bool is_postgresql_auto_conf = false;
941 bool found_postgresql_auto_conf = false;
942 int file_padding_len = 0;
943 size_t tarhdrsz = 0;
944 pgoff_t filesz = 0;
945
946#ifdef HAVE_LIBZ
947 gzFile ztarfile = NULL;
948#endif
949
950 /* recovery.conf is integrated into postgresql.conf in 12 and newer */
951 if (PQserverVersion(conn) < MINIMUM_VERSION_FOR_RECOVERY_GUC)
952 is_recovery_guc_supported = false;
953
954 if (basetablespace)
955 {
956 /*
957 * Base tablespaces
958 */
959 if (strcmp(basedir, "-") == 0)
960 {
961#ifdef WIN32
962 _setmode(fileno(stdout), _O_BINARY);
963#endif
964
965#ifdef HAVE_LIBZ
966 if (compresslevel != 0)
967 {
968 ztarfile = gzdopen(dup(fileno(stdout)), "wb");
969 if (gzsetparams(ztarfile, compresslevel,
970 Z_DEFAULT_STRATEGY) != Z_OK)
971 {
972 pg_log_error("could not set compression level %d: %s",
973 compresslevel, get_gz_error(ztarfile));
974 exit(1);
975 }
976 }
977 else
978#endif
979 tarfile = stdout;
980 strcpy(filename, "-");
981 }
982 else
983 {
984#ifdef HAVE_LIBZ
985 if (compresslevel != 0)
986 {
987 snprintf(filename, sizeof(filename), "%s/base.tar.gz", basedir);
988 ztarfile = gzopen(filename, "wb");
989 if (gzsetparams(ztarfile, compresslevel,
990 Z_DEFAULT_STRATEGY) != Z_OK)
991 {
992 pg_log_error("could not set compression level %d: %s",
993 compresslevel, get_gz_error(ztarfile));
994 exit(1);
995 }
996 }
997 else
998#endif
999 {
1000 snprintf(filename, sizeof(filename), "%s/base.tar", basedir);
1001 tarfile = fopen(filename, "wb");
1002 }
1003 }
1004 }
1005 else
1006 {
1007 /*
1008 * Specific tablespace
1009 */
1010#ifdef HAVE_LIBZ
1011 if (compresslevel != 0)
1012 {
1013 snprintf(filename, sizeof(filename), "%s/%s.tar.gz", basedir,
1014 PQgetvalue(res, rownum, 0));
1015 ztarfile = gzopen(filename, "wb");
1016 if (gzsetparams(ztarfile, compresslevel,
1017 Z_DEFAULT_STRATEGY) != Z_OK)
1018 {
1019 pg_log_error("could not set compression level %d: %s",
1020 compresslevel, get_gz_error(ztarfile));
1021 exit(1);
1022 }
1023 }
1024 else
1025#endif
1026 {
1027 snprintf(filename, sizeof(filename), "%s/%s.tar", basedir,
1028 PQgetvalue(res, rownum, 0));
1029 tarfile = fopen(filename, "wb");
1030 }
1031 }
1032
1033#ifdef HAVE_LIBZ
1034 if (compresslevel != 0)
1035 {
1036 if (!ztarfile)
1037 {
1038 /* Compression is in use */
1039 pg_log_error("could not create compressed file \"%s\": %s",
1040 filename, get_gz_error(ztarfile));
1041 exit(1);
1042 }
1043 }
1044 else
1045#endif
1046 {
1047 /* Either no zlib support, or zlib support but compresslevel = 0 */
1048 if (!tarfile)
1049 {
1050 pg_log_error("could not create file \"%s\": %m", filename);
1051 exit(1);
1052 }
1053 }
1054
1055 /*
1056 * Get the COPY data stream
1057 */
1058 res = PQgetResult(conn);
1059 if (PQresultStatus(res) != PGRES_COPY_OUT)
1060 {
1061 pg_log_error("could not get COPY data stream: %s",
1062 PQerrorMessage(conn));
1063 exit(1);
1064 }
1065
1066 while (1)
1067 {
1068 int r;
1069
1070 if (copybuf != NULL)
1071 {
1072 PQfreemem(copybuf);
1073 copybuf = NULL;
1074 }
1075
1076 r = PQgetCopyData(conn, &copybuf, 0);
1077 if (r == -1)
1078 {
1079 /*
1080 * End of chunk. If requested, and this is the base tablespace,
1081 * write configuration file into the tarfile. When done, close the
1082 * file (but not stdout).
1083 *
1084 * Also, write two completely empty blocks at the end of the tar
1085 * file, as required by some tar programs.
1086 */
1087 char zerobuf[1024];
1088
1089 MemSet(zerobuf, 0, sizeof(zerobuf));
1090
1091 if (basetablespace && writerecoveryconf)
1092 {
1093 char header[512];
1094
1095 /*
1096 * If postgresql.auto.conf has not been found in the streamed
1097 * data, add recovery configuration to postgresql.auto.conf if
1098 * recovery parameters are GUCs. If the instance connected to
1099 * is older than 12, create recovery.conf with this data
1100 * otherwise.
1101 */
1102 if (!found_postgresql_auto_conf || !is_recovery_guc_supported)
1103 {
1104 int padding;
1105
1106 tarCreateHeader(header,
1107 is_recovery_guc_supported ? "postgresql.auto.conf" : "recovery.conf",
1108 NULL,
1109 recoveryconfcontents->len,
1110 pg_file_create_mode, 04000, 02000,
1111 time(NULL));
1112
1113 padding = ((recoveryconfcontents->len + 511) & ~511) - recoveryconfcontents->len;
1114
1115 WRITE_TAR_DATA(header, sizeof(header));
1116 WRITE_TAR_DATA(recoveryconfcontents->data,
1117 recoveryconfcontents->len);
1118 if (padding)
1119 WRITE_TAR_DATA(zerobuf, padding);
1120 }
1121
1122 /*
1123 * standby.signal is supported only if recovery parameters are
1124 * GUCs.
1125 */
1126 if (is_recovery_guc_supported)
1127 {
1128 tarCreateHeader(header, "standby.signal", NULL,
1129 0, /* zero-length file */
1130 pg_file_create_mode, 04000, 02000,
1131 time(NULL));
1132
1133 WRITE_TAR_DATA(header, sizeof(header));
1134 WRITE_TAR_DATA(zerobuf, 511);
1135 }
1136 }
1137
1138 /* 2 * 512 bytes empty data at end of file */
1139 WRITE_TAR_DATA(zerobuf, sizeof(zerobuf));
1140
1141#ifdef HAVE_LIBZ
1142 if (ztarfile != NULL)
1143 {
1144 if (gzclose(ztarfile) != 0)
1145 {
1146 pg_log_error("could not close compressed file \"%s\": %s",
1147 filename, get_gz_error(ztarfile));
1148 exit(1);
1149 }
1150 }
1151 else
1152#endif
1153 {
1154 if (strcmp(basedir, "-") != 0)
1155 {
1156 if (fclose(tarfile) != 0)
1157 {
1158 pg_log_error("could not close file \"%s\": %m",
1159 filename);
1160 exit(1);
1161 }
1162 }
1163 }
1164
1165 break;
1166 }
1167 else if (r == -2)
1168 {
1169 pg_log_error("could not read COPY data: %s",
1170 PQerrorMessage(conn));
1171 exit(1);
1172 }
1173
1174 if (!writerecoveryconf || !basetablespace)
1175 {
1176 /*
1177 * When not writing config file, or when not working on the base
1178 * tablespace, we never have to look for an existing configuration
1179 * file in the stream.
1180 */
1181 WRITE_TAR_DATA(copybuf, r);
1182 }
1183 else
1184 {
1185 /*
1186 * Look for a config file in the existing tar stream. If it's
1187 * there, we must skip it so we can later overwrite it with our
1188 * own version of the file.
1189 *
1190 * To do this, we have to process the individual files inside the
1191 * TAR stream. The stream consists of a header and zero or more
1192 * chunks, all 512 bytes long. The stream from the server is
1193 * broken up into smaller pieces, so we have to track the size of
1194 * the files to find the next header structure.
1195 */
1196 int rr = r;
1197 int pos = 0;
1198
1199 while (rr > 0)
1200 {
1201 if (in_tarhdr)
1202 {
1203 /*
1204 * We're currently reading a header structure inside the
1205 * TAR stream, i.e. the file metadata.
1206 */
1207 if (tarhdrsz < 512)
1208 {
1209 /*
1210 * Copy the header structure into tarhdr in case the
1211 * header is not aligned to 512 bytes or it's not
1212 * returned in whole by the last PQgetCopyData call.
1213 */
1214 int hdrleft;
1215 int bytes2copy;
1216
1217 hdrleft = 512 - tarhdrsz;
1218 bytes2copy = (rr > hdrleft ? hdrleft : rr);
1219
1220 memcpy(&tarhdr[tarhdrsz], copybuf + pos, bytes2copy);
1221
1222 rr -= bytes2copy;
1223 pos += bytes2copy;
1224 tarhdrsz += bytes2copy;
1225 }
1226 else
1227 {
1228 /*
1229 * We have the complete header structure in tarhdr,
1230 * look at the file metadata: we may want append
1231 * recovery info into postgresql.auto.conf and skip
1232 * standby.signal file if recovery parameters are
1233 * integrated as GUCs, and recovery.conf otherwise. In
1234 * both cases we must calculate tar padding.
1235 */
1236 if (is_recovery_guc_supported)
1237 {
1238 skip_file = (strcmp(&tarhdr[0], "standby.signal") == 0);
1239 is_postgresql_auto_conf = (strcmp(&tarhdr[0], "postgresql.auto.conf") == 0);
1240 }
1241 else
1242 skip_file = (strcmp(&tarhdr[0], "recovery.conf") == 0);
1243
1244 filesz = read_tar_number(&tarhdr[124], 12);
1245 file_padding_len = ((filesz + 511) & ~511) - filesz;
1246
1247 if (is_recovery_guc_supported &&
1248 is_postgresql_auto_conf &&
1249 writerecoveryconf)
1250 {
1251 /* replace tar header */
1252 char header[512];
1253
1254 tarCreateHeader(header, "postgresql.auto.conf", NULL,
1255 filesz + recoveryconfcontents->len,
1256 pg_file_create_mode, 04000, 02000,
1257 time(NULL));
1258
1259 WRITE_TAR_DATA(header, sizeof(header));
1260 }
1261 else
1262 {
1263 /* copy stream with padding */
1264 filesz += file_padding_len;
1265
1266 if (!skip_file)
1267 {
1268 /*
1269 * If we're not skipping the file, write the
1270 * tar header unmodified.
1271 */
1272 WRITE_TAR_DATA(tarhdr, 512);
1273 }
1274 }
1275
1276 /* Next part is the file, not the header */
1277 in_tarhdr = false;
1278 }
1279 }
1280 else
1281 {
1282 /*
1283 * We're processing a file's contents.
1284 */
1285 if (filesz > 0)
1286 {
1287 /*
1288 * We still have data to read (and possibly write).
1289 */
1290 int bytes2write;
1291
1292 bytes2write = (filesz > rr ? rr : filesz);
1293
1294 if (!skip_file)
1295 WRITE_TAR_DATA(copybuf + pos, bytes2write);
1296
1297 rr -= bytes2write;
1298 pos += bytes2write;
1299 filesz -= bytes2write;
1300 }
1301 else if (is_recovery_guc_supported &&
1302 is_postgresql_auto_conf &&
1303 writerecoveryconf)
1304 {
1305 /* append recovery config to postgresql.auto.conf */
1306 int padding;
1307 int tailsize;
1308
1309 tailsize = (512 - file_padding_len) + recoveryconfcontents->len;
1310 padding = ((tailsize + 511) & ~511) - tailsize;
1311
1312 WRITE_TAR_DATA(recoveryconfcontents->data, recoveryconfcontents->len);
1313
1314 if (padding)
1315 {
1316 char zerobuf[512];
1317
1318 MemSet(zerobuf, 0, sizeof(zerobuf));
1319 WRITE_TAR_DATA(zerobuf, padding);
1320 }
1321
1322 /* skip original file padding */
1323 is_postgresql_auto_conf = false;
1324 skip_file = true;
1325 filesz += file_padding_len;
1326
1327 found_postgresql_auto_conf = true;
1328 }
1329 else
1330 {
1331 /*
1332 * No more data in the current file, the next piece of
1333 * data (if any) will be a new file header structure.
1334 */
1335 in_tarhdr = true;
1336 skip_file = false;
1337 is_postgresql_auto_conf = false;
1338 tarhdrsz = 0;
1339 filesz = 0;
1340 }
1341 }
1342 }
1343 }
1344 totaldone += r;
1345 progress_report(rownum, filename, false);
1346 } /* while (1) */
1347 progress_report(rownum, filename, true);
1348
1349 if (copybuf != NULL)
1350 PQfreemem(copybuf);
1351
1352 /*
1353 * Do not sync the resulting tar file yet, all files are synced once at
1354 * the end.
1355 */
1356}
1357
1358
1359/*
1360 * Retrieve tablespace path, either relocated or original depending on whether
1361 * -T was passed or not.
1362 */
1363static const char *
1364get_tablespace_mapping(const char *dir)
1365{
1366 TablespaceListCell *cell;
1367 char canon_dir[MAXPGPATH];
1368
1369 /* Canonicalize path for comparison consistency */
1370 strlcpy(canon_dir, dir, sizeof(canon_dir));
1371 canonicalize_path(canon_dir);
1372
1373 for (cell = tablespace_dirs.head; cell; cell = cell->next)
1374 if (strcmp(canon_dir, cell->old_dir) == 0)
1375 return cell->new_dir;
1376
1377 return dir;
1378}
1379
1380
1381/*
1382 * Receive a tar format stream from the connection to the server, and unpack
1383 * the contents of it into a directory. Only files, directories and
1384 * symlinks are supported, no other kinds of special files.
1385 *
1386 * If the data is for the main data directory, it will be restored in the
1387 * specified directory. If it's for another tablespace, it will be restored
1388 * in the original or mapped directory.
1389 */
1390static void
1391ReceiveAndUnpackTarFile(PGconn *conn, PGresult *res, int rownum)
1392{
1393 char current_path[MAXPGPATH];
1394 char filename[MAXPGPATH];
1395 const char *mapped_tblspc_path;
1396 pgoff_t current_len_left = 0;
1397 int current_padding = 0;
1398 bool basetablespace;
1399 char *copybuf = NULL;
1400 FILE *file = NULL;
1401
1402 basetablespace = PQgetisnull(res, rownum, 0);
1403 if (basetablespace)
1404 strlcpy(current_path, basedir, sizeof(current_path));
1405 else
1406 strlcpy(current_path,
1407 get_tablespace_mapping(PQgetvalue(res, rownum, 1)),
1408 sizeof(current_path));
1409
1410 /*
1411 * Get the COPY data
1412 */
1413 res = PQgetResult(conn);
1414 if (PQresultStatus(res) != PGRES_COPY_OUT)
1415 {
1416 pg_log_error("could not get COPY data stream: %s",
1417 PQerrorMessage(conn));
1418 exit(1);
1419 }
1420
1421 while (1)
1422 {
1423 int r;
1424
1425 if (copybuf != NULL)
1426 {
1427 PQfreemem(copybuf);
1428 copybuf = NULL;
1429 }
1430
1431 r = PQgetCopyData(conn, &copybuf, 0);
1432
1433 if (r == -1)
1434 {
1435 /*
1436 * End of chunk
1437 */
1438 if (file)
1439 fclose(file);
1440
1441 break;
1442 }
1443 else if (r == -2)
1444 {
1445 pg_log_error("could not read COPY data: %s",
1446 PQerrorMessage(conn));
1447 exit(1);
1448 }
1449
1450 if (file == NULL)
1451 {
1452 int filemode;
1453
1454 /*
1455 * No current file, so this must be the header for a new file
1456 */
1457 if (r != 512)
1458 {
1459 pg_log_error("invalid tar block header size: %d", r);
1460 exit(1);
1461 }
1462 totaldone += 512;
1463
1464 current_len_left = read_tar_number(&copybuf[124], 12);
1465
1466 /* Set permissions on the file */
1467 filemode = read_tar_number(&copybuf[100], 8);
1468
1469 /*
1470 * All files are padded up to 512 bytes
1471 */
1472 current_padding =
1473 ((current_len_left + 511) & ~511) - current_len_left;
1474
1475 /*
1476 * First part of header is zero terminated filename
1477 */
1478 snprintf(filename, sizeof(filename), "%s/%s", current_path,
1479 copybuf);
1480 if (filename[strlen(filename) - 1] == '/')
1481 {
1482 /*
1483 * Ends in a slash means directory or symlink to directory
1484 */
1485 if (copybuf[156] == '5')
1486 {
1487 /*
1488 * Directory
1489 */
1490 filename[strlen(filename) - 1] = '\0'; /* Remove trailing slash */
1491 if (mkdir(filename, pg_dir_create_mode) != 0)
1492 {
1493 /*
1494 * When streaming WAL, pg_wal (or pg_xlog for pre-9.6
1495 * clusters) will have been created by the wal
1496 * receiver process. Also, when the WAL directory
1497 * location was specified, pg_wal (or pg_xlog) has
1498 * already been created as a symbolic link before
1499 * starting the actual backup. So just ignore creation
1500 * failures on related directories.
1501 */
1502 if (!((pg_str_endswith(filename, "/pg_wal") ||
1503 pg_str_endswith(filename, "/pg_xlog") ||
1504 pg_str_endswith(filename, "/archive_status")) &&
1505 errno == EEXIST))
1506 {
1507 pg_log_error("could not create directory \"%s\": %m",
1508 filename);
1509 exit(1);
1510 }
1511 }
1512#ifndef WIN32
1513 if (chmod(filename, (mode_t) filemode))
1514 pg_log_error("could not set permissions on directory \"%s\": %m",
1515 filename);
1516#endif
1517 }
1518 else if (copybuf[156] == '2')
1519 {
1520 /*
1521 * Symbolic link
1522 *
1523 * It's most likely a link in pg_tblspc directory, to the
1524 * location of a tablespace. Apply any tablespace mapping
1525 * given on the command line (--tablespace-mapping). (We
1526 * blindly apply the mapping without checking that the
1527 * link really is inside pg_tblspc. We don't expect there
1528 * to be other symlinks in a data directory, but if there
1529 * are, you can call it an undocumented feature that you
1530 * can map them too.)
1531 */
1532 filename[strlen(filename) - 1] = '\0'; /* Remove trailing slash */
1533
1534 mapped_tblspc_path = get_tablespace_mapping(&copybuf[157]);
1535 if (symlink(mapped_tblspc_path, filename) != 0)
1536 {
1537 pg_log_error("could not create symbolic link from \"%s\" to \"%s\": %m",
1538 filename, mapped_tblspc_path);
1539 exit(1);
1540 }
1541 }
1542 else
1543 {
1544 pg_log_error("unrecognized link indicator \"%c\"",
1545 copybuf[156]);
1546 exit(1);
1547 }
1548 continue; /* directory or link handled */
1549 }
1550
1551 /*
1552 * regular file
1553 */
1554 file = fopen(filename, "wb");
1555 if (!file)
1556 {
1557 pg_log_error("could not create file \"%s\": %m", filename);
1558 exit(1);
1559 }
1560
1561#ifndef WIN32
1562 if (chmod(filename, (mode_t) filemode))
1563 pg_log_error("could not set permissions on file \"%s\": %m",
1564 filename);
1565#endif
1566
1567 if (current_len_left == 0)
1568 {
1569 /*
1570 * Done with this file, next one will be a new tar header
1571 */
1572 fclose(file);
1573 file = NULL;
1574 continue;
1575 }
1576 } /* new file */
1577 else
1578 {
1579 /*
1580 * Continuing blocks in existing file
1581 */
1582 if (current_len_left == 0 && r == current_padding)
1583 {
1584 /*
1585 * Received the padding block for this file, ignore it and
1586 * close the file, then move on to the next tar header.
1587 */
1588 fclose(file);
1589 file = NULL;
1590 totaldone += r;
1591 continue;
1592 }
1593
1594 if (fwrite(copybuf, r, 1, file) != 1)
1595 {
1596 pg_log_error("could not write to file \"%s\": %m", filename);
1597 exit(1);
1598 }
1599 totaldone += r;
1600 progress_report(rownum, filename, false);
1601
1602 current_len_left -= r;
1603 if (current_len_left == 0 && current_padding == 0)
1604 {
1605 /*
1606 * Received the last block, and there is no padding to be
1607 * expected. Close the file and move on to the next tar
1608 * header.
1609 */
1610 fclose(file);
1611 file = NULL;
1612 continue;
1613 }
1614 } /* continuing data in existing file */
1615 } /* loop over all data blocks */
1616 progress_report(rownum, filename, true);
1617
1618 if (file != NULL)
1619 {
1620 pg_log_error("COPY stream ended before last file was finished");
1621 exit(1);
1622 }
1623
1624 if (copybuf != NULL)
1625 PQfreemem(copybuf);
1626
1627 if (basetablespace && writerecoveryconf)
1628 WriteRecoveryConf();
1629
1630 /*
1631 * No data is synced here, everything is done for all tablespaces at the
1632 * end.
1633 */
1634}
1635
1636/*
1637 * Escape a string so that it can be used as a value in a key-value pair
1638 * a configuration file.
1639 */
1640static char *
1641escape_quotes(const char *src)
1642{
1643 char *result = escape_single_quotes_ascii(src);
1644
1645 if (!result)
1646 {
1647 pg_log_error("out of memory");
1648 exit(1);
1649 }
1650 return result;
1651}
1652
1653/*
1654 * Create a configuration file in memory using a PQExpBuffer
1655 */
1656static void
1657GenerateRecoveryConf(PGconn *conn)
1658{
1659 PQconninfoOption *connOptions;
1660 PQconninfoOption *option;
1661 PQExpBufferData conninfo_buf;
1662 char *escaped;
1663
1664 recoveryconfcontents = createPQExpBuffer();
1665 if (!recoveryconfcontents)
1666 {
1667 pg_log_error("out of memory");
1668 exit(1);
1669 }
1670
1671 /*
1672 * In PostgreSQL 12 and newer versions, standby_mode is gone, replaced by
1673 * standby.signal to trigger a standby state at recovery.
1674 */
1675 if (PQserverVersion(conn) < MINIMUM_VERSION_FOR_RECOVERY_GUC)
1676 appendPQExpBufferStr(recoveryconfcontents, "standby_mode = 'on'\n");
1677
1678 connOptions = PQconninfo(conn);
1679 if (connOptions == NULL)
1680 {
1681 pg_log_error("out of memory");
1682 exit(1);
1683 }
1684
1685 initPQExpBuffer(&conninfo_buf);
1686 for (option = connOptions; option && option->keyword; option++)
1687 {
1688 /* Omit empty settings and those libpqwalreceiver overrides. */
1689 if (strcmp(option->keyword, "replication") == 0 ||
1690 strcmp(option->keyword, "dbname") == 0 ||
1691 strcmp(option->keyword, "fallback_application_name") == 0 ||
1692 (option->val == NULL) ||
1693 (option->val != NULL && option->val[0] == '\0'))
1694 continue;
1695
1696 /* Separate key-value pairs with spaces */
1697 if (conninfo_buf.len != 0)
1698 appendPQExpBufferChar(&conninfo_buf, ' ');
1699
1700 /*
1701 * Write "keyword=value" pieces, the value string is escaped and/or
1702 * quoted if necessary.
1703 */
1704 appendPQExpBuffer(&conninfo_buf, "%s=", option->keyword);
1705 appendConnStrVal(&conninfo_buf, option->val);
1706 }
1707
1708 /*
1709 * Escape the connection string, so that it can be put in the config file.
1710 * Note that this is different from the escaping of individual connection
1711 * options above!
1712 */
1713 escaped = escape_quotes(conninfo_buf.data);
1714 appendPQExpBuffer(recoveryconfcontents, "primary_conninfo = '%s'\n", escaped);
1715 free(escaped);
1716
1717 if (replication_slot)
1718 {
1719 /* unescaped: ReplicationSlotValidateName allows [a-z0-9_] only */
1720 appendPQExpBuffer(recoveryconfcontents, "primary_slot_name = '%s'\n",
1721 replication_slot);
1722 }
1723
1724 if (PQExpBufferBroken(recoveryconfcontents) ||
1725 PQExpBufferDataBroken(conninfo_buf))
1726 {
1727 pg_log_error("out of memory");
1728 exit(1);
1729 }
1730
1731 termPQExpBuffer(&conninfo_buf);
1732
1733 PQconninfoFree(connOptions);
1734}
1735
1736
1737/*
1738 * Write the configuration file into the directory specified in basedir,
1739 * with the contents already collected in memory appended. Then write
1740 * the signal file into the basedir. If the server does not support
1741 * recovery parameters as GUCs, the signal file is not necessary, and
1742 * configuration is written to recovery.conf.
1743 */
1744static void
1745WriteRecoveryConf(void)
1746{
1747 char filename[MAXPGPATH];
1748 FILE *cf;
1749 bool is_recovery_guc_supported = true;
1750
1751 if (PQserverVersion(conn) < MINIMUM_VERSION_FOR_RECOVERY_GUC)
1752 is_recovery_guc_supported = false;
1753
1754 snprintf(filename, MAXPGPATH, "%s/%s", basedir,
1755 is_recovery_guc_supported ? "postgresql.auto.conf" : "recovery.conf");
1756
1757 cf = fopen(filename, is_recovery_guc_supported ? "a" : "w");
1758 if (cf == NULL)
1759 {
1760 pg_log_error("could not open file \"%s\": %m", filename);
1761 exit(1);
1762 }
1763
1764 if (fwrite(recoveryconfcontents->data, recoveryconfcontents->len, 1, cf) != 1)
1765 {
1766 pg_log_error("could not write to file \"%s\": %m", filename);
1767 exit(1);
1768 }
1769
1770 fclose(cf);
1771
1772 if (is_recovery_guc_supported)
1773 {
1774 snprintf(filename, MAXPGPATH, "%s/%s", basedir, "standby.signal");
1775 cf = fopen(filename, "w");
1776 if (cf == NULL)
1777 {
1778 pg_log_error("could not create file \"%s\": %m", filename);
1779 exit(1);
1780 }
1781
1782 fclose(cf);
1783 }
1784}
1785
1786
1787static void
1788BaseBackup(void)
1789{
1790 PGresult *res;
1791 char *sysidentifier;
1792 TimeLineID latesttli;
1793 TimeLineID starttli;
1794 char *basebkp;
1795 char escaped_label[MAXPGPATH];
1796 char *maxrate_clause = NULL;
1797 int i;
1798 char xlogstart[64];
1799 char xlogend[64];
1800 int minServerMajor,
1801 maxServerMajor;
1802 int serverVersion,
1803 serverMajor;
1804
1805 Assert(conn != NULL);
1806
1807 /*
1808 * Check server version. BASE_BACKUP command was introduced in 9.1, so we
1809 * can't work with servers older than 9.1.
1810 */
1811 minServerMajor = 901;
1812 maxServerMajor = PG_VERSION_NUM / 100;
1813 serverVersion = PQserverVersion(conn);
1814 serverMajor = serverVersion / 100;
1815 if (serverMajor < minServerMajor || serverMajor > maxServerMajor)
1816 {
1817 const char *serverver = PQparameterStatus(conn, "server_version");
1818
1819 pg_log_error("incompatible server version %s",
1820 serverver ? serverver : "'unknown'");
1821 exit(1);
1822 }
1823
1824 /*
1825 * If WAL streaming was requested, also check that the server is new
1826 * enough for that.
1827 */
1828 if (includewal == STREAM_WAL && !CheckServerVersionForStreaming(conn))
1829 {
1830 /*
1831 * Error message already written in CheckServerVersionForStreaming(),
1832 * but add a hint about using -X none.
1833 */
1834 pg_log_info("HINT: use -X none or -X fetch to disable log streaming");
1835 exit(1);
1836 }
1837
1838 /*
1839 * Build contents of configuration file if requested
1840 */
1841 if (writerecoveryconf)
1842 GenerateRecoveryConf(conn);
1843
1844 /*
1845 * Run IDENTIFY_SYSTEM so we can get the timeline
1846 */
1847 if (!RunIdentifySystem(conn, &sysidentifier, &latesttli, NULL, NULL))
1848 exit(1);
1849
1850 /*
1851 * Start the actual backup
1852 */
1853 PQescapeStringConn(conn, escaped_label, label, sizeof(escaped_label), &i);
1854
1855 if (maxrate > 0)
1856 maxrate_clause = psprintf("MAX_RATE %u", maxrate);
1857
1858 if (verbose)
1859 pg_log_info("initiating base backup, waiting for checkpoint to complete");
1860
1861 if (showprogress && !verbose)
1862 {
1863 fprintf(stderr, "waiting for checkpoint");
1864 if (isatty(fileno(stderr)))
1865 fprintf(stderr, "\r");
1866 else
1867 fprintf(stderr, "\n");
1868 }
1869
1870 basebkp =
1871 psprintf("BASE_BACKUP LABEL '%s' %s %s %s %s %s %s %s",
1872 escaped_label,
1873 showprogress ? "PROGRESS" : "",
1874 includewal == FETCH_WAL ? "WAL" : "",
1875 fastcheckpoint ? "FAST" : "",
1876 includewal == NO_WAL ? "" : "NOWAIT",
1877 maxrate_clause ? maxrate_clause : "",
1878 format == 't' ? "TABLESPACE_MAP" : "",
1879 verify_checksums ? "" : "NOVERIFY_CHECKSUMS");
1880
1881 if (PQsendQuery(conn, basebkp) == 0)
1882 {
1883 pg_log_error("could not send replication command \"%s\": %s",
1884 "BASE_BACKUP", PQerrorMessage(conn));
1885 exit(1);
1886 }
1887
1888 /*
1889 * Get the starting WAL location
1890 */
1891 res = PQgetResult(conn);
1892 if (PQresultStatus(res) != PGRES_TUPLES_OK)
1893 {
1894 pg_log_error("could not initiate base backup: %s",
1895 PQerrorMessage(conn));
1896 exit(1);
1897 }
1898 if (PQntuples(res) != 1)
1899 {
1900 pg_log_error("server returned unexpected response to BASE_BACKUP command; got %d rows and %d fields, expected %d rows and %d fields",
1901 PQntuples(res), PQnfields(res), 1, 2);
1902 exit(1);
1903 }
1904
1905 strlcpy(xlogstart, PQgetvalue(res, 0, 0), sizeof(xlogstart));
1906
1907 if (verbose)
1908 pg_log_info("checkpoint completed");
1909
1910 /*
1911 * 9.3 and later sends the TLI of the starting point. With older servers,
1912 * assume it's the same as the latest timeline reported by
1913 * IDENTIFY_SYSTEM.
1914 */
1915 if (PQnfields(res) >= 2)
1916 starttli = atoi(PQgetvalue(res, 0, 1));
1917 else
1918 starttli = latesttli;
1919 PQclear(res);
1920 MemSet(xlogend, 0, sizeof(xlogend));
1921
1922 if (verbose && includewal != NO_WAL)
1923 pg_log_info("write-ahead log start point: %s on timeline %u",
1924 xlogstart, starttli);
1925
1926 /*
1927 * Get the header
1928 */
1929 res = PQgetResult(conn);
1930 if (PQresultStatus(res) != PGRES_TUPLES_OK)
1931 {
1932 pg_log_error("could not get backup header: %s",
1933 PQerrorMessage(conn));
1934 exit(1);
1935 }
1936 if (PQntuples(res) < 1)
1937 {
1938 pg_log_error("no data returned from server");
1939 exit(1);
1940 }
1941
1942 /*
1943 * Sum up the total size, for progress reporting
1944 */
1945 totalsize = totaldone = 0;
1946 tablespacecount = PQntuples(res);
1947 for (i = 0; i < PQntuples(res); i++)
1948 {
1949 totalsize += atol(PQgetvalue(res, i, 2));
1950
1951 /*
1952 * Verify tablespace directories are empty. Don't bother with the
1953 * first once since it can be relocated, and it will be checked before
1954 * we do anything anyway.
1955 */
1956 if (format == 'p' && !PQgetisnull(res, i, 1))
1957 {
1958 char *path = unconstify(char *, get_tablespace_mapping(PQgetvalue(res, i, 1)));
1959
1960 verify_dir_is_empty_or_create(path, &made_tablespace_dirs, &found_tablespace_dirs);
1961 }
1962 }
1963
1964 /*
1965 * When writing to stdout, require a single tablespace
1966 */
1967 if (format == 't' && strcmp(basedir, "-") == 0 && PQntuples(res) > 1)
1968 {
1969 pg_log_error("can only write single tablespace to stdout, database has %d",
1970 PQntuples(res));
1971 exit(1);
1972 }
1973
1974 /*
1975 * If we're streaming WAL, start the streaming session before we start
1976 * receiving the actual data chunks.
1977 */
1978 if (includewal == STREAM_WAL)
1979 {
1980 if (verbose)
1981 pg_log_info("starting background WAL receiver");
1982 StartLogStreamer(xlogstart, starttli, sysidentifier);
1983 }
1984
1985 /*
1986 * Start receiving chunks
1987 */
1988 for (i = 0; i < PQntuples(res); i++)
1989 {
1990 if (format == 't')
1991 ReceiveTarFile(conn, res, i);
1992 else
1993 ReceiveAndUnpackTarFile(conn, res, i);
1994 } /* Loop over all tablespaces */
1995
1996 if (showprogress)
1997 {
1998 progress_report(PQntuples(res), NULL, true);
1999 if (isatty(fileno(stderr)))
2000 fprintf(stderr, "\n"); /* Need to move to next line */
2001 }
2002
2003 PQclear(res);
2004
2005 /*
2006 * Get the stop position
2007 */
2008 res = PQgetResult(conn);
2009 if (PQresultStatus(res) != PGRES_TUPLES_OK)
2010 {
2011 pg_log_error("could not get write-ahead log end position from server: %s",
2012 PQerrorMessage(conn));
2013 exit(1);
2014 }
2015 if (PQntuples(res) != 1)
2016 {
2017 pg_log_error("no write-ahead log end position returned from server");
2018 exit(1);
2019 }
2020 strlcpy(xlogend, PQgetvalue(res, 0, 0), sizeof(xlogend));
2021 if (verbose && includewal != NO_WAL)
2022 pg_log_info("write-ahead log end point: %s", xlogend);
2023 PQclear(res);
2024
2025 res = PQgetResult(conn);
2026 if (PQresultStatus(res) != PGRES_COMMAND_OK)
2027 {
2028 const char *sqlstate = PQresultErrorField(res, PG_DIAG_SQLSTATE);
2029
2030 if (sqlstate &&
2031 strcmp(sqlstate, ERRCODE_DATA_CORRUPTED) == 0)
2032 {
2033 pg_log_error("checksum error occurred");
2034 checksum_failure = true;
2035 }
2036 else
2037 {
2038 pg_log_error("final receive failed: %s",
2039 PQerrorMessage(conn));
2040 }
2041 exit(1);
2042 }
2043
2044 if (bgchild > 0)
2045 {
2046#ifndef WIN32
2047 int status;
2048 pid_t r;
2049#else
2050 DWORD status;
2051
2052 /*
2053 * get a pointer sized version of bgchild to avoid warnings about
2054 * casting to a different size on WIN64.
2055 */
2056 intptr_t bgchild_handle = bgchild;
2057 uint32 hi,
2058 lo;
2059#endif
2060
2061 if (verbose)
2062 pg_log_info("waiting for background process to finish streaming ...");
2063
2064#ifndef WIN32
2065 if (write(bgpipe[1], xlogend, strlen(xlogend)) != strlen(xlogend))
2066 {
2067 pg_log_info("could not send command to background pipe: %m");
2068 exit(1);
2069 }
2070
2071 /* Just wait for the background process to exit */
2072 r = waitpid(bgchild, &status, 0);
2073 if (r == (pid_t) -1)
2074 {
2075 pg_log_error("could not wait for child process: %m");
2076 exit(1);
2077 }
2078 if (r != bgchild)
2079 {
2080 pg_log_error("child %d died, expected %d", (int) r, (int) bgchild);
2081 exit(1);
2082 }
2083 if (status != 0)
2084 {
2085 pg_log_error("%s", wait_result_to_str(status));
2086 exit(1);
2087 }
2088 /* Exited normally, we're happy! */
2089#else /* WIN32 */
2090
2091 /*
2092 * On Windows, since we are in the same process, we can just store the
2093 * value directly in the variable, and then set the flag that says
2094 * it's there.
2095 */
2096 if (sscanf(xlogend, "%X/%X", &hi, &lo) != 2)
2097 {
2098 pg_log_error("could not parse write-ahead log location \"%s\"",
2099 xlogend);
2100 exit(1);
2101 }
2102 xlogendptr = ((uint64) hi) << 32 | lo;
2103 InterlockedIncrement(&has_xlogendptr);
2104
2105 /* First wait for the thread to exit */
2106 if (WaitForSingleObjectEx((HANDLE) bgchild_handle, INFINITE, FALSE) !=
2107 WAIT_OBJECT_0)
2108 {
2109 _dosmaperr(GetLastError());
2110 pg_log_error("could not wait for child thread: %m");
2111 exit(1);
2112 }
2113 if (GetExitCodeThread((HANDLE) bgchild_handle, &status) == 0)
2114 {
2115 _dosmaperr(GetLastError());
2116 pg_log_error("could not get child thread exit status: %m");
2117 exit(1);
2118 }
2119 if (status != 0)
2120 {
2121 pg_log_error("child thread exited with error %u",
2122 (unsigned int) status);
2123 exit(1);
2124 }
2125 /* Exited normally, we're happy */
2126#endif
2127 }
2128
2129 /* Free the configuration file contents */
2130 destroyPQExpBuffer(recoveryconfcontents);
2131
2132 /*
2133 * End of copy data. Final result is already checked inside the loop.
2134 */
2135 PQclear(res);
2136 PQfinish(conn);
2137 conn = NULL;
2138
2139 /*
2140 * Make data persistent on disk once backup is completed. For tar format
2141 * sync the parent directory and all its contents as each tar file was not
2142 * synced after being completed. In plain format, all the data of the
2143 * base directory is synced, taking into account all the tablespaces.
2144 * Errors are not considered fatal.
2145 */
2146 if (do_sync)
2147 {
2148 if (verbose)
2149 pg_log_info("syncing data to disk ...");
2150 if (format == 't')
2151 {
2152 if (strcmp(basedir, "-") != 0)
2153 (void) fsync_dir_recurse(basedir);
2154 }
2155 else
2156 {
2157 (void) fsync_pgdata(basedir, serverVersion);
2158 }
2159 }
2160
2161 if (verbose)
2162 pg_log_info("base backup completed");
2163}
2164
2165
2166int
2167main(int argc, char **argv)
2168{
2169 static struct option long_options[] = {
2170 {"help", no_argument, NULL, '?'},
2171 {"version", no_argument, NULL, 'V'},
2172 {"pgdata", required_argument, NULL, 'D'},
2173 {"format", required_argument, NULL, 'F'},
2174 {"checkpoint", required_argument, NULL, 'c'},
2175 {"create-slot", no_argument, NULL, 'C'},
2176 {"max-rate", required_argument, NULL, 'r'},
2177 {"write-recovery-conf", no_argument, NULL, 'R'},
2178 {"slot", required_argument, NULL, 'S'},
2179 {"tablespace-mapping", required_argument, NULL, 'T'},
2180 {"wal-method", required_argument, NULL, 'X'},
2181 {"gzip", no_argument, NULL, 'z'},
2182 {"compress", required_argument, NULL, 'Z'},
2183 {"label", required_argument, NULL, 'l'},
2184 {"no-clean", no_argument, NULL, 'n'},
2185 {"no-sync", no_argument, NULL, 'N'},
2186 {"dbname", required_argument, NULL, 'd'},
2187 {"host", required_argument, NULL, 'h'},
2188 {"port", required_argument, NULL, 'p'},
2189 {"username", required_argument, NULL, 'U'},
2190 {"no-password", no_argument, NULL, 'w'},
2191 {"password", no_argument, NULL, 'W'},
2192 {"status-interval", required_argument, NULL, 's'},
2193 {"verbose", no_argument, NULL, 'v'},
2194 {"progress", no_argument, NULL, 'P'},
2195 {"waldir", required_argument, NULL, 1},
2196 {"no-slot", no_argument, NULL, 2},
2197 {"no-verify-checksums", no_argument, NULL, 3},
2198 {NULL, 0, NULL, 0}
2199 };
2200 int c;
2201
2202 int option_index;
2203
2204 pg_logging_init(argv[0]);
2205 progname = get_progname(argv[0]);
2206 set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_basebackup"));
2207
2208 if (argc > 1)
2209 {
2210 if (strcmp(argv[1], "--help") == 0 || strcmp(argv[1], "-?") == 0)
2211 {
2212 usage();
2213 exit(0);
2214 }
2215 else if (strcmp(argv[1], "-V") == 0
2216 || strcmp(argv[1], "--version") == 0)
2217 {
2218 puts("pg_basebackup (PostgreSQL) " PG_VERSION);
2219 exit(0);
2220 }
2221 }
2222
2223 atexit(cleanup_directories_atexit);
2224
2225 while ((c = getopt_long(argc, argv, "CD:F:r:RS:T:X:l:nNzZ:d:c:h:p:U:s:wWkvP",
2226 long_options, &option_index)) != -1)
2227 {
2228 switch (c)
2229 {
2230 case 'C':
2231 create_slot = true;
2232 break;
2233 case 'D':
2234 basedir = pg_strdup(optarg);
2235 break;
2236 case 'F':
2237 if (strcmp(optarg, "p") == 0 || strcmp(optarg, "plain") == 0)
2238 format = 'p';
2239 else if (strcmp(optarg, "t") == 0 || strcmp(optarg, "tar") == 0)
2240 format = 't';
2241 else
2242 {
2243 pg_log_error("invalid output format \"%s\", must be \"plain\" or \"tar\"",
2244 optarg);
2245 exit(1);
2246 }
2247 break;
2248 case 'r':
2249 maxrate = parse_max_rate(optarg);
2250 break;
2251 case 'R':
2252 writerecoveryconf = true;
2253 break;
2254 case 'S':
2255
2256 /*
2257 * When specifying replication slot name, use a permanent
2258 * slot.
2259 */
2260 replication_slot = pg_strdup(optarg);
2261 temp_replication_slot = false;
2262 break;
2263 case 2:
2264 no_slot = true;
2265 break;
2266 case 'T':
2267 tablespace_list_append(optarg);
2268 break;
2269 case 'X':
2270 if (strcmp(optarg, "n") == 0 ||
2271 strcmp(optarg, "none") == 0)
2272 {
2273 includewal = NO_WAL;
2274 }
2275 else if (strcmp(optarg, "f") == 0 ||
2276 strcmp(optarg, "fetch") == 0)
2277 {
2278 includewal = FETCH_WAL;
2279 }
2280 else if (strcmp(optarg, "s") == 0 ||
2281 strcmp(optarg, "stream") == 0)
2282 {
2283 includewal = STREAM_WAL;
2284 }
2285 else
2286 {
2287 pg_log_error("invalid wal-method option \"%s\", must be \"fetch\", \"stream\", or \"none\"",
2288 optarg);
2289 exit(1);
2290 }
2291 break;
2292 case 1:
2293 xlog_dir = pg_strdup(optarg);
2294 break;
2295 case 'l':
2296 label = pg_strdup(optarg);
2297 break;
2298 case 'n':
2299 noclean = true;
2300 break;
2301 case 'N':
2302 do_sync = false;
2303 break;
2304 case 'z':
2305#ifdef HAVE_LIBZ
2306 compresslevel = Z_DEFAULT_COMPRESSION;
2307#else
2308 compresslevel = 1; /* will be rejected below */
2309#endif
2310 break;
2311 case 'Z':
2312 compresslevel = atoi(optarg);
2313 if (compresslevel < 0 || compresslevel > 9)
2314 {
2315 pg_log_error("invalid compression level \"%s\"", optarg);
2316 exit(1);
2317 }
2318 break;
2319 case 'c':
2320 if (pg_strcasecmp(optarg, "fast") == 0)
2321 fastcheckpoint = true;
2322 else if (pg_strcasecmp(optarg, "spread") == 0)
2323 fastcheckpoint = false;
2324 else
2325 {
2326 pg_log_error("invalid checkpoint argument \"%s\", must be \"fast\" or \"spread\"",
2327 optarg);
2328 exit(1);
2329 }
2330 break;
2331 case 'd':
2332 connection_string = pg_strdup(optarg);
2333 break;
2334 case 'h':
2335 dbhost = pg_strdup(optarg);
2336 break;
2337 case 'p':
2338 dbport = pg_strdup(optarg);
2339 break;
2340 case 'U':
2341 dbuser = pg_strdup(optarg);
2342 break;
2343 case 'w':
2344 dbgetpassword = -1;
2345 break;
2346 case 'W':
2347 dbgetpassword = 1;
2348 break;
2349 case 's':
2350 standby_message_timeout = atoi(optarg) * 1000;
2351 if (standby_message_timeout < 0)
2352 {
2353 pg_log_error("invalid status interval \"%s\"", optarg);
2354 exit(1);
2355 }
2356 break;
2357 case 'v':
2358 verbose++;
2359 break;
2360 case 'P':
2361 showprogress = true;
2362 break;
2363 case 3:
2364 verify_checksums = false;
2365 break;
2366 default:
2367
2368 /*
2369 * getopt_long already emitted a complaint
2370 */
2371 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2372 progname);
2373 exit(1);
2374 }
2375 }
2376
2377 /*
2378 * Any non-option arguments?
2379 */
2380 if (optind < argc)
2381 {
2382 pg_log_error("too many command-line arguments (first is \"%s\")",
2383 argv[optind]);
2384 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2385 progname);
2386 exit(1);
2387 }
2388
2389 /*
2390 * Required arguments
2391 */
2392 if (basedir == NULL)
2393 {
2394 pg_log_error("no target directory specified");
2395 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2396 progname);
2397 exit(1);
2398 }
2399
2400 /*
2401 * Mutually exclusive arguments
2402 */
2403 if (format == 'p' && compresslevel != 0)
2404 {
2405 pg_log_error("only tar mode backups can be compressed");
2406 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2407 progname);
2408 exit(1);
2409 }
2410
2411 if (format == 't' && includewal == STREAM_WAL && strcmp(basedir, "-") == 0)
2412 {
2413 pg_log_error("cannot stream write-ahead logs in tar mode to stdout");
2414 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2415 progname);
2416 exit(1);
2417 }
2418
2419 if (replication_slot && includewal != STREAM_WAL)
2420 {
2421 pg_log_error("replication slots can only be used with WAL streaming");
2422 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2423 progname);
2424 exit(1);
2425 }
2426
2427 if (no_slot)
2428 {
2429 if (replication_slot)
2430 {
2431 pg_log_error("--no-slot cannot be used with slot name");
2432 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2433 progname);
2434 exit(1);
2435 }
2436 temp_replication_slot = false;
2437 }
2438
2439 if (create_slot)
2440 {
2441 if (!replication_slot)
2442 {
2443 pg_log_error("%s needs a slot to be specified using --slot",
2444 "--create-slot");
2445 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2446 progname);
2447 exit(1);
2448 }
2449
2450 if (no_slot)
2451 {
2452 pg_log_error("--create-slot and --no-slot are incompatible options");
2453 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2454 progname);
2455 exit(1);
2456 }
2457 }
2458
2459 if (xlog_dir)
2460 {
2461 if (format != 'p')
2462 {
2463 pg_log_error("WAL directory location can only be specified in plain mode");
2464 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2465 progname);
2466 exit(1);
2467 }
2468
2469 /* clean up xlog directory name, check it's absolute */
2470 canonicalize_path(xlog_dir);
2471 if (!is_absolute_path(xlog_dir))
2472 {
2473 pg_log_error("WAL directory location must be an absolute path");
2474 fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
2475 progname);
2476 exit(1);
2477 }
2478 }
2479
2480#ifndef HAVE_LIBZ
2481 if (compresslevel != 0)
2482 {
2483 pg_log_error("this build does not support compression");
2484 exit(1);
2485 }
2486#endif
2487
2488 /* connection in replication mode to server */
2489 conn = GetConnection();
2490 if (!conn)
2491 {
2492 /* Error message already written in GetConnection() */
2493 exit(1);
2494 }
2495 atexit(disconnect_atexit);
2496
2497 /*
2498 * Set umask so that directories/files are created with the same
2499 * permissions as directories/files in the source data directory.
2500 *
2501 * pg_mode_mask is set to owner-only by default and then updated in
2502 * GetConnection() where we get the mode from the server-side with
2503 * RetrieveDataDirCreatePerm() and then call SetDataDirectoryCreatePerm().
2504 */
2505 umask(pg_mode_mask);
2506
2507 /*
2508 * Verify that the target directory exists, or create it. For plaintext
2509 * backups, always require the directory. For tar backups, require it
2510 * unless we are writing to stdout.
2511 */
2512 if (format == 'p' || strcmp(basedir, "-") != 0)
2513 verify_dir_is_empty_or_create(basedir, &made_new_pgdata, &found_existing_pgdata);
2514
2515 /* determine remote server's xlog segment size */
2516 if (!RetrieveWalSegSize(conn))
2517 exit(1);
2518
2519 /* Create pg_wal symlink, if required */
2520 if (xlog_dir)
2521 {
2522 char *linkloc;
2523
2524 verify_dir_is_empty_or_create(xlog_dir, &made_new_xlogdir, &found_existing_xlogdir);
2525
2526 /*
2527 * Form name of the place where the symlink must go. pg_xlog has been
2528 * renamed to pg_wal in post-10 clusters.
2529 */
2530 linkloc = psprintf("%s/%s", basedir,
2531 PQserverVersion(conn) < MINIMUM_VERSION_FOR_PG_WAL ?
2532 "pg_xlog" : "pg_wal");
2533
2534#ifdef HAVE_SYMLINK
2535 if (symlink(xlog_dir, linkloc) != 0)
2536 {
2537 pg_log_error("could not create symbolic link \"%s\": %m", linkloc);
2538 exit(1);
2539 }
2540#else
2541 pg_log_error("symlinks are not supported on this platform");
2542 exit(1);
2543#endif
2544 free(linkloc);
2545 }
2546
2547 BaseBackup();
2548
2549 success = true;
2550 return 0;
2551}
2552