/
pg_probackup.c
1216 lines (1067 loc) · 40.3 KB
/
pg_probackup.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*-------------------------------------------------------------------------
*
* pg_probackup.c: Backup/Recovery manager for PostgreSQL.
*
* This is an entry point for the program.
* Parse command name and it's options, verify them and call a
* do_***() function that implements the command.
*
* Avoid using global variables in the code.
* Pass all needed information as funciton arguments:
*
*
* TODO (see pg_probackup_state.h):
*
* Functions that work with a backup catalog accept catalogState,
* which currently only contains pathes to backup catalog subdirectories
* + function specific options.
*
* Functions that work with an instance accept instanceState argument, which
* includes catalogState, instance_name,
* info about pgdata associated with the instance (see pgState),
* various instance config options, and list of backups belonging to the instance.
* + function specific options.
*
* Functions that work with multiple backups in the catalog
* accept instanceState and info needed to determine the range of backups to handle.
* + function specific options.
*
* Functions that work with a single backup accept backupState argument,
* which includes link to the instanceState, backup_id and backup-specific info.
* + function specific options.
*
* Functions that work with a postgreSQL instance (i.e. checkdb) accept pgState,
* which includes info about pgdata directory and connection.
*
* Portions Copyright (c) 2009-2013, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
* Portions Copyright (c) 2015-2021, Postgres Professional
*
*-------------------------------------------------------------------------
*/
#include "pg_probackup.h"
#include "pg_probackup_state.h"
#include "pg_getopt.h"
#include "streamutil.h"
#include "utils/file.h"
#include <sys/stat.h>
#include "utils/configuration.h"
#include "utils/thread.h"
#include <time.h>
const char *PROGRAM_NAME = NULL; /* PROGRAM_NAME_FULL without .exe suffix
* if any */
const char *PROGRAM_NAME_FULL = NULL;
const char *PROGRAM_FULL_PATH = NULL;
const char *PROGRAM_URL = "https://github.com/postgrespro/pg_probackup";
const char *PROGRAM_EMAIL = "https://github.com/postgrespro/pg_probackup/issues";
/* ================ catalogState =========== */
/* directory options */
/* TODO make it local variable, pass as an argument to all commands that need it. */
static char *backup_path = NULL;
static CatalogState *catalogState = NULL;
/* ================ catalogState (END) =========== */
/* common options */
int num_threads = 1;
bool stream_wal = false;
bool no_color = false;
bool show_color = true;
bool is_archive_cmd = false;
pid_t my_pid = 0;
__thread int my_thread_num = 1;
bool progress = false;
bool no_sync = false;
time_t start_time = INVALID_BACKUP_ID;
#if PG_VERSION_NUM >= 100000
char *replication_slot = NULL;
bool temp_slot = false;
#endif
bool perm_slot = false;
/* backup options */
bool backup_logs = false;
bool smooth_checkpoint;
bool remote_agent = false;
static char *backup_note = NULL;
/* catchup options */
static char *catchup_source_pgdata = NULL;
static char *catchup_destination_pgdata = NULL;
/* restore options */
static char *target_time = NULL;
static char *target_xid = NULL;
static char *target_lsn = NULL;
static char *target_inclusive = NULL;
static char *target_tli_string; /* timeline number, "current" or "latest"*/
static char *target_stop;
static bool target_immediate;
static char *target_name = NULL;
static char *target_action = NULL;
static char *primary_conninfo = NULL;
static pgRecoveryTarget *recovery_target_options = NULL;
static pgRestoreParams *restore_params = NULL;
time_t current_time = 0;
static bool restore_as_replica = false;
bool no_validate = false;
IncrRestoreMode incremental_mode = INCR_NONE;
bool skip_block_validation = false;
bool skip_external_dirs = false;
/* array for datnames, provided via db-include and db-exclude */
static parray *datname_exclude_list = NULL;
static parray *datname_include_list = NULL;
/* arrays for --exclude-path's */
static parray *exclude_absolute_paths_list = NULL;
static parray *exclude_relative_paths_list = NULL;
static char* gl_waldir_path = NULL;
static bool allow_partial_incremental = false;
/* checkdb options */
bool need_amcheck = false;
bool heapallindexed = false;
bool checkunique = false;
bool amcheck_parent = false;
/* delete options */
bool delete_wal = false;
bool delete_expired = false;
bool merge_expired = false;
bool force = false;
bool dry_run = false;
static char *delete_status = NULL;
/* compression options */
static bool compress_shortcut = false;
/* ================ instanceState =========== */
static char *instance_name;
static InstanceState *instanceState = NULL;
/* ================ instanceState (END) =========== */
/* archive push options */
int batch_size = 1;
static char *wal_file_path;
static char *wal_file_name;
static bool file_overwrite = false;
static bool no_ready_rename = false;
static char archive_push_xlog_dir[MAXPGPATH] = "";
/* archive get options */
static char *prefetch_dir;
bool no_validate_wal = false;
/* show options */
ShowFormat show_format = SHOW_PLAIN;
bool show_archive = false;
static bool show_base_units = false;
/* set-backup options */
int64 ttl = -1;
static char *expire_time_string = NULL;
static pgSetBackupParams *set_backup_params = NULL;
/* ================ backupState =========== */
static char *backup_id_string = NULL;
pgBackup current;
/* ================ backupState (END) =========== */
static bool help_opt = false;
static void opt_incr_restore_mode(ConfigOption *opt, const char *arg);
static void opt_backup_mode(ConfigOption *opt, const char *arg);
static void opt_show_format(ConfigOption *opt, const char *arg);
static void compress_init(ProbackupSubcmd const subcmd);
static void opt_datname_exclude_list(ConfigOption *opt, const char *arg);
static void opt_datname_include_list(ConfigOption *opt, const char *arg);
static void opt_exclude_path(ConfigOption *opt, const char *arg);
/*
* Short name should be non-printable ASCII character.
* Use values between 128 and 255.
*/
static ConfigOption cmd_options[] =
{
/* directory options */
{ 'b', 130, "help", &help_opt, SOURCE_CMD_STRICT },
{ 's', 'B', "backup-path", &backup_path, SOURCE_CMD_STRICT },
/* common options */
{ 'u', 'j', "threads", &num_threads, SOURCE_CMD_STRICT },
{ 'b', 131, "stream", &stream_wal, SOURCE_CMD_STRICT },
{ 'b', 132, "progress", &progress, SOURCE_CMD_STRICT },
{ 's', 'i', "backup-id", &backup_id_string, SOURCE_CMD_STRICT },
{ 'b', 133, "no-sync", &no_sync, SOURCE_CMD_STRICT },
{ 'b', 134, "no-color", &no_color, SOURCE_CMD_STRICT },
/* backup options */
{ 'b', 180, "backup-pg-log", &backup_logs, SOURCE_CMD_STRICT },
{ 'f', 'b', "backup-mode", opt_backup_mode, SOURCE_CMD_STRICT },
{ 'b', 'C', "smooth-checkpoint", &smooth_checkpoint, SOURCE_CMD_STRICT },
{ 's', 'S', "slot", &replication_slot, SOURCE_CMD_STRICT },
#if PG_VERSION_NUM >= 100000
{ 'b', 181, "temp-slot", &temp_slot, SOURCE_CMD_STRICT },
#endif
{ 'b', 'P', "perm-slot", &perm_slot, SOURCE_CMD_STRICT },
{ 'b', 182, "delete-wal", &delete_wal, SOURCE_CMD_STRICT },
{ 'b', 183, "delete-expired", &delete_expired, SOURCE_CMD_STRICT },
{ 'b', 184, "merge-expired", &merge_expired, SOURCE_CMD_STRICT },
{ 'b', 185, "dry-run", &dry_run, SOURCE_CMD_STRICT },
{ 's', 238, "note", &backup_note, SOURCE_CMD_STRICT },
{ 'U', 241, "start-time", &start_time, SOURCE_CMD_STRICT },
/* catchup options */
{ 's', 239, "source-pgdata", &catchup_source_pgdata, SOURCE_CMD_STRICT },
{ 's', 240, "destination-pgdata", &catchup_destination_pgdata, SOURCE_CMD_STRICT },
{ 'f', 'x', "exclude-path", opt_exclude_path, SOURCE_CMD_STRICT },
/* restore options */
{ 's', 136, "recovery-target-time", &target_time, SOURCE_CMD_STRICT },
{ 's', 137, "recovery-target-xid", &target_xid, SOURCE_CMD_STRICT },
{ 's', 144, "recovery-target-lsn", &target_lsn, SOURCE_CMD_STRICT },
{ 's', 138, "recovery-target-inclusive", &target_inclusive, SOURCE_CMD_STRICT },
{ 's', 139, "recovery-target-timeline", &target_tli_string, SOURCE_CMD_STRICT },
{ 's', 157, "recovery-target", &target_stop, SOURCE_CMD_STRICT },
{ 'f', 'T', "tablespace-mapping", opt_tablespace_map, SOURCE_CMD_STRICT },
{ 'f', 155, "external-mapping", opt_externaldir_map, SOURCE_CMD_STRICT },
{ 's', 141, "recovery-target-name", &target_name, SOURCE_CMD_STRICT },
{ 's', 142, "recovery-target-action", &target_action, SOURCE_CMD_STRICT },
{ 'b', 143, "no-validate", &no_validate, SOURCE_CMD_STRICT },
{ 'b', 154, "skip-block-validation", &skip_block_validation, SOURCE_CMD_STRICT },
{ 'b', 156, "skip-external-dirs", &skip_external_dirs, SOURCE_CMD_STRICT },
{ 'f', 158, "db-include", opt_datname_include_list, SOURCE_CMD_STRICT },
{ 'f', 159, "db-exclude", opt_datname_exclude_list, SOURCE_CMD_STRICT },
{ 'b', 'R', "restore-as-replica", &restore_as_replica, SOURCE_CMD_STRICT },
{ 's', 160, "primary-conninfo", &primary_conninfo, SOURCE_CMD_STRICT },
{ 's', 'S', "primary-slot-name",&replication_slot, SOURCE_CMD_STRICT },
{ 'f', 'I', "incremental-mode", opt_incr_restore_mode, SOURCE_CMD_STRICT },
{ 's', 'X', "waldir", &gl_waldir_path, SOURCE_CMD_STRICT },
{ 'b', 242, "destroy-all-other-dbs", &allow_partial_incremental, SOURCE_CMD_STRICT },
/* checkdb options */
{ 'b', 195, "amcheck", &need_amcheck, SOURCE_CMD_STRICT },
{ 'b', 196, "heapallindexed", &heapallindexed, SOURCE_CMD_STRICT },
{ 'b', 198, "checkunique", &checkunique, SOURCE_CMD_STRICT },
{ 'b', 197, "parent", &amcheck_parent, SOURCE_CMD_STRICT },
/* delete options */
{ 'b', 145, "wal", &delete_wal, SOURCE_CMD_STRICT },
{ 'b', 146, "expired", &delete_expired, SOURCE_CMD_STRICT },
{ 's', 172, "status", &delete_status, SOURCE_CMD_STRICT },
/* TODO not implemented yet */
{ 'b', 147, "force", &force, SOURCE_CMD_STRICT },
/* compression options */
{ 'b', 148, "compress", &compress_shortcut, SOURCE_CMD_STRICT },
/* connection options */
{ 'B', 'w', "no-password", &prompt_password, SOURCE_CMD_STRICT },
{ 'b', 'W', "password", &force_password, SOURCE_CMD_STRICT },
/* other options */
{ 's', 149, "instance", &instance_name, SOURCE_CMD_STRICT },
/* archive-push options */
{ 's', 150, "wal-file-path", &wal_file_path, SOURCE_CMD_STRICT },
{ 's', 151, "wal-file-name", &wal_file_name, SOURCE_CMD_STRICT },
{ 'b', 152, "overwrite", &file_overwrite, SOURCE_CMD_STRICT },
{ 'b', 153, "no-ready-rename", &no_ready_rename, SOURCE_CMD_STRICT },
{ 'i', 162, "batch-size", &batch_size, SOURCE_CMD_STRICT },
/* archive-get options */
{ 's', 163, "prefetch-dir", &prefetch_dir, SOURCE_CMD_STRICT },
{ 'b', 164, "no-validate-wal", &no_validate_wal, SOURCE_CMD_STRICT },
/* show options */
{ 'f', 165, "format", opt_show_format, SOURCE_CMD_STRICT },
{ 'b', 166, "archive", &show_archive, SOURCE_CMD_STRICT },
/* show-config options */
{ 'b', 167, "no-scale-units", &show_base_units,SOURCE_CMD_STRICT },
/* set-backup options */
{ 'I', 170, "ttl", &ttl, SOURCE_CMD_STRICT, SOURCE_DEFAULT, 0, OPTION_UNIT_S, option_get_value},
{ 's', 171, "expire-time", &expire_time_string, SOURCE_CMD_STRICT },
/* options for backward compatibility
* TODO: remove in 3.0.0
*/
{ 's', 136, "time", &target_time, SOURCE_CMD_STRICT },
{ 's', 137, "xid", &target_xid, SOURCE_CMD_STRICT },
{ 's', 138, "inclusive", &target_inclusive, SOURCE_CMD_STRICT },
{ 's', 139, "timeline", &target_tli_string, SOURCE_CMD_STRICT },
{ 's', 144, "lsn", &target_lsn, SOURCE_CMD_STRICT },
{ 'b', 140, "immediate", &target_immediate, SOURCE_CMD_STRICT },
{ 0 }
};
/*
* Entry point of pg_probackup command.
*/
int
main(int argc, char *argv[])
{
char *command = NULL;
ProbackupSubcmd backup_subcmd = NO_CMD;
PROGRAM_NAME_FULL = argv[0];
/* Check terminal presense and initialize ANSI escape codes for Windows */
init_console();
/* Initialize current backup */
pgBackupInit(¤t);
/* Initialize current instance configuration */
//TODO get git of this global variable craziness
init_config(&instance_config, instance_name);
PROGRAM_NAME = get_progname(argv[0]);
set_pglocale_pgservice(argv[0], PG_TEXTDOMAIN("pg_probackup"));
PROGRAM_FULL_PATH = palloc0(MAXPGPATH);
// Setting C locale for numeric values in order to impose dot-based floating-point representation
memorize_environment_locale();
setlocale(LC_NUMERIC, "C");
/* Get current time */
current_time = time(NULL);
my_pid = getpid();
//set_pglocale_pgservice(argv[0], "pgscripts");
#if PG_VERSION_NUM >= 110000
/*
* Reset WAL segment size, we will retreive it using RetrieveWalSegSize()
* later.
*/
WalSegSz = 0;
#endif
/*
* Save main thread's tid. It is used call exit() in case of errors.
*/
main_tid = pthread_self();
/* Parse subcommands and non-subcommand options */
if (argc > 1)
{
backup_subcmd = parse_subcmd(argv[1]);
switch(backup_subcmd)
{
case SSH_CMD:
#ifdef WIN32
launch_ssh(argv);
break;
#else
elog(ERROR, "\"ssh\" command implemented only for Windows");
break;
#endif
case AGENT_CMD:
/* 'No forward compatibility' sanity:
* /old/binary -> ssh execute -> /newer/binary agent version_num
* If we are executed as an agent for older binary, then exit with error
*/
if (argc > 2)
elog(ERROR, "Version mismatch, pg_probackup binary with version '%s' "
"is launched as an agent for pg_probackup binary with version '%s'",
PROGRAM_VERSION, argv[2]);
remote_agent = true;
fio_communicate(STDIN_FILENO, STDOUT_FILENO);
return 0;
case HELP_CMD:
if (argc > 2)
{
/* 'pg_probackup help command' style */
help_command(parse_subcmd(argv[2]));
exit(0);
}
else
{
help_pg_probackup();
exit(0);
}
break;
case VERSION_CMD:
help_print_version();
exit(0);
case NO_CMD:
elog(ERROR, "Unknown subcommand \"%s\"", argv[1]);
default:
/* Silence compiler warnings */
break;
}
}
else
elog(ERROR, "No subcommand specified. Please run with \"help\" argument to see possible subcommands.");
/*
* Make command string before getopt_long() will call. It permutes the
* content of argv.
*/
/* TODO why do we do that only for some commands? */
if (backup_subcmd == BACKUP_CMD ||
backup_subcmd == RESTORE_CMD ||
backup_subcmd == VALIDATE_CMD ||
backup_subcmd == DELETE_CMD ||
backup_subcmd == MERGE_CMD ||
backup_subcmd == SET_CONFIG_CMD ||
backup_subcmd == SET_BACKUP_CMD)
{
int i,
len = 0,
allocated = 0;
allocated = sizeof(char) * MAXPGPATH;
command = (char *) palloc(allocated);
for (i = 0; i < argc; i++)
{
int arglen = strlen(argv[i]);
if (arglen + len > allocated)
{
allocated *= 2;
command = repalloc(command, allocated);
}
strncpy(command + len, argv[i], arglen);
len += arglen;
command[len++] = ' ';
}
command[len] = '\0';
}
optind += 1;
/* Parse command line only arguments */
config_get_opt(argc, argv, cmd_options, instance_options);
if (backup_subcmd == SET_CONFIG_CMD)
{
int i;
for (i = 0; i < argc; i++)
{
if (strncmp("--log-format-console", argv[i], strlen("--log-format-console")) == 0)
{
elog(ERROR, "Option 'log-format-console' set only from terminal\n");
}
}
}
pgut_init();
if (no_color)
show_color = false;
if (help_opt)
{
/* 'pg_probackup command --help' style */
help_command(backup_subcmd);
exit(0);
}
/* set location based on cmdline options only */
setMyLocation(backup_subcmd);
/* ===== catalogState ======*/
if (backup_path == NULL)
{
/*
* If command line argument is not set, try to read BACKUP_PATH
* from environment variable
*/
backup_path = getenv("BACKUP_PATH");
}
if (backup_path != NULL)
{
canonicalize_path(backup_path);
/* Ensure that backup_path is an absolute path */
if (!is_absolute_path(backup_path))
elog(ERROR, "-B, --backup-path must be an absolute path");
catalogState = pgut_new(CatalogState);
strncpy(catalogState->catalog_path, backup_path, MAXPGPATH);
join_path_components(catalogState->backup_subdir_path,
catalogState->catalog_path, BACKUPS_DIR);
join_path_components(catalogState->wal_subdir_path,
catalogState->catalog_path, WAL_SUBDIR);
}
/* backup_path is required for all pg_probackup commands except help, version, checkdb and catchup */
if (backup_path == NULL &&
backup_subcmd != CHECKDB_CMD &&
backup_subcmd != HELP_CMD &&
backup_subcmd != VERSION_CMD &&
backup_subcmd != CATCHUP_CMD)
elog(ERROR,
"No backup catalog path specified.\n"
"Please specify it either using environment variable BACKUP_PATH or\n"
"command line option --backup-path (-B)");
/* ===== catalogState (END) ======*/
/* ===== instanceState ======*/
/*
* Option --instance is required for all commands except
* init, show, checkdb, validate and catchup
*/
if (instance_name == NULL)
{
if (backup_subcmd != INIT_CMD && backup_subcmd != SHOW_CMD &&
backup_subcmd != VALIDATE_CMD && backup_subcmd != CHECKDB_CMD && backup_subcmd != CATCHUP_CMD)
elog(ERROR, "Required parameter not specified: --instance");
}
else
{
instanceState = pgut_new(InstanceState);
instanceState->catalog_state = catalogState;
strncpy(instanceState->instance_name, instance_name, MAXPGPATH);
join_path_components(instanceState->instance_backup_subdir_path,
catalogState->backup_subdir_path, instanceState->instance_name);
join_path_components(instanceState->instance_wal_subdir_path,
catalogState->wal_subdir_path, instanceState->instance_name);
join_path_components(instanceState->instance_config_path,
instanceState->instance_backup_subdir_path, BACKUP_CATALOG_CONF_FILE);
}
/* ===== instanceState (END) ======*/
/*
* If --instance option was passed, construct paths for backup data and
* xlog files of this backup instance.
*/
if ((backup_path != NULL) && instance_name)
{
/*
* Ensure that requested backup instance exists.
* for all commands except init, which doesn't take this parameter,
* add-instance, which creates new instance,
* and archive-get, which just do not require it at this point
*/
if (backup_subcmd != INIT_CMD && backup_subcmd != ADD_INSTANCE_CMD &&
backup_subcmd != ARCHIVE_GET_CMD)
{
struct stat st;
if (fio_stat(instanceState->instance_backup_subdir_path,
&st, true, FIO_BACKUP_HOST) != 0)
{
elog(WARNING, "Failed to access directory \"%s\": %s",
instanceState->instance_backup_subdir_path, strerror(errno));
// TODO: redundant message, should we get rid of it?
elog(ERROR, "Instance '%s' does not exist in this backup catalog",
instance_name);
}
else
{
/* Ensure that backup_path is a path to a directory */
if (!S_ISDIR(st.st_mode))
elog(ERROR, "-B, --backup-path must be a path to directory");
}
}
}
/*
* We read options from command line, now we need to read them from
* configuration file since we got backup path and instance name.
* For some commands an instance option isn't required, see above.
*/
if (instance_name)
{
/* Read environment variables */
config_get_opt_env(instance_options);
/* Read options from configuration file */
if (backup_subcmd != ADD_INSTANCE_CMD &&
backup_subcmd != ARCHIVE_GET_CMD)
{
if (backup_subcmd == CHECKDB_CMD)
config_read_opt(instanceState->instance_config_path, instance_options, ERROR, true, true);
else
config_read_opt(instanceState->instance_config_path, instance_options, ERROR, true, false);
/*
* We can determine our location only after reading the configuration file,
* unless we are running arcive-push/archive-get - they are allowed to trust
* cmdline only.
*/
setMyLocation(backup_subcmd);
}
}
else if (backup_subcmd == CATCHUP_CMD)
{
config_get_opt_env(instance_options);
}
/*
* Disable logging into file for archive-push and archive-get.
* Note, that we should NOT use fio_is_remote() here,
* because it will launch ssh connection and we do not
* want it, because it will kill archive-get prefetch
* performance.
*
* TODO: make logging into file possible via ssh
*/
if (fio_is_remote_simple(FIO_BACKUP_HOST) &&
(backup_subcmd == ARCHIVE_GET_CMD ||
backup_subcmd == ARCHIVE_PUSH_CMD))
{
instance_config.logger.log_level_file = LOG_OFF;
is_archive_cmd = true;
}
/* Just read environment variables */
if (backup_path == NULL && backup_subcmd == CHECKDB_CMD)
config_get_opt_env(instance_options);
/* Sanity for checkdb, if backup_dir is provided but pgdata and instance are not */
if (backup_subcmd == CHECKDB_CMD &&
backup_path != NULL &&
instance_name == NULL &&
instance_config.pgdata == NULL)
elog(ERROR, "Required parameter not specified: --instance");
/* Check checkdb command options consistency */
if (backup_subcmd == CHECKDB_CMD &&
!need_amcheck)
{
if (heapallindexed)
elog(ERROR, "--heapallindexed can only be used with --amcheck option");
if (checkunique)
elog(ERROR, "--checkunique can only be used with --amcheck option");
}
/* Usually checkdb for file logging requires log_directory
* to be specified explicitly, but if backup_dir and instance name are provided,
* checkdb can use the usual default values or values from config
*/
if (backup_subcmd == CHECKDB_CMD &&
(instance_config.logger.log_level_file != LOG_OFF &&
instance_config.logger.log_directory == NULL) &&
(!instance_config.pgdata || !instance_name))
elog(ERROR, "Cannot save checkdb logs to a file. "
"You must specify --log-directory option when running checkdb with "
"--log-level-file option enabled.");
if (backup_subcmd == CATCHUP_CMD &&
instance_config.logger.log_level_file != LOG_OFF &&
instance_config.logger.log_directory == NULL)
elog(ERROR, "Cannot save catchup logs to a file. "
"You must specify --log-directory option when running catchup with "
"--log-level-file option enabled.");
/* Initialize logger */
init_logger(backup_path, &instance_config.logger);
/* command was initialized for a few commands */
if (command)
{
elog_file(INFO, "command: %s", command);
pfree(command);
command = NULL;
}
/* For archive-push and archive-get skip full path lookup */
if ((backup_subcmd != ARCHIVE_GET_CMD &&
backup_subcmd != ARCHIVE_PUSH_CMD) &&
(find_my_exec(argv[0],(char *) PROGRAM_FULL_PATH) < 0))
{
PROGRAM_FULL_PATH = NULL;
elog(WARNING, "%s: could not find a full path to executable", PROGRAM_NAME);
}
/*
* We have read pgdata path from command line or from configuration file.
* Ensure that pgdata is an absolute path.
*/
if (instance_config.pgdata != NULL)
canonicalize_path(instance_config.pgdata);
if (instance_config.pgdata != NULL &&
(backup_subcmd != ARCHIVE_GET_CMD && backup_subcmd != CATCHUP_CMD) &&
!is_absolute_path(instance_config.pgdata))
elog(ERROR, "-D, --pgdata must be an absolute path");
#if PG_VERSION_NUM >= 110000
/* Check xlog-seg-size option */
if (instance_name &&
backup_subcmd != INIT_CMD &&
backup_subcmd != ADD_INSTANCE_CMD && backup_subcmd != SET_CONFIG_CMD &&
!IsValidWalSegSize(instance_config.xlog_seg_size))
{
/* If we are working with instance of PG<11 using PG11 binary,
* then xlog_seg_size is equal to zero. Manually set it to 16MB.
*/
if (instance_config.xlog_seg_size == 0)
instance_config.xlog_seg_size = DEFAULT_XLOG_SEG_SIZE;
else
elog(ERROR, "Invalid WAL segment size %u", instance_config.xlog_seg_size);
}
#endif
/* Sanity check of --backup-id option */
if (backup_id_string != NULL)
{
if (backup_subcmd != RESTORE_CMD &&
backup_subcmd != VALIDATE_CMD &&
backup_subcmd != DELETE_CMD &&
backup_subcmd != MERGE_CMD &&
backup_subcmd != SET_BACKUP_CMD &&
backup_subcmd != SHOW_CMD)
elog(ERROR, "Cannot use -i (--backup-id) option together with the \"%s\" command",
get_subcmd_name(backup_subcmd));
current.backup_id = base36dec(backup_id_string);
if (current.backup_id == 0)
elog(ERROR, "Invalid backup-id \"%s\"", backup_id_string);
}
if (!instance_config.conn_opt.pghost && instance_config.remote.host)
instance_config.conn_opt.pghost = instance_config.remote.host;
/* Setup stream options. They are used in streamutil.c. */
if (instance_config.conn_opt.pghost != NULL)
dbhost = pstrdup(instance_config.conn_opt.pghost);
if (instance_config.conn_opt.pgport != NULL)
dbport = pstrdup(instance_config.conn_opt.pgport);
if (instance_config.conn_opt.pguser != NULL)
dbuser = pstrdup(instance_config.conn_opt.pguser);
if (backup_subcmd == VALIDATE_CMD || backup_subcmd == RESTORE_CMD)
{
/*
* Parse all recovery target options into recovery_target_options
* structure.
*/
recovery_target_options =
parseRecoveryTargetOptions(target_time, target_xid,
target_inclusive, target_tli_string, target_lsn,
(target_stop != NULL) ? target_stop :
(target_immediate) ? "immediate" : NULL,
target_name, target_action);
if (force && backup_subcmd != RESTORE_CMD)
elog(ERROR, "You cannot specify \"--force\" flag with the \"%s\" command",
get_subcmd_name(backup_subcmd));
if (force)
no_validate = true;
/* keep all params in one structure */
restore_params = pgut_new(pgRestoreParams);
restore_params->is_restore = (backup_subcmd == RESTORE_CMD);
restore_params->force = force;
restore_params->no_validate = no_validate;
restore_params->restore_as_replica = restore_as_replica;
restore_params->recovery_settings_mode = DEFAULT;
restore_params->primary_slot_name = replication_slot;
restore_params->skip_block_validation = skip_block_validation;
restore_params->skip_external_dirs = skip_external_dirs;
restore_params->partial_db_list = NULL;
restore_params->partial_restore_type = NONE;
restore_params->primary_conninfo = primary_conninfo;
restore_params->incremental_mode = incremental_mode;
restore_params->allow_partial_incremental = allow_partial_incremental;
/* handle partial restore parameters */
if (datname_exclude_list && datname_include_list)
elog(ERROR, "You cannot specify '--db-include' and '--db-exclude' together");
if (datname_exclude_list)
{
restore_params->partial_restore_type = EXCLUDE;
restore_params->partial_db_list = datname_exclude_list;
}
else if (datname_include_list)
{
restore_params->partial_restore_type = INCLUDE;
restore_params->partial_db_list = datname_include_list;
}
if (gl_waldir_path)
{
/* clean up xlog directory name, check it's absolute */
canonicalize_path(gl_waldir_path);
if (!is_absolute_path(gl_waldir_path))
{
elog(ERROR, "WAL directory location must be an absolute path");
}
if (strlen(gl_waldir_path) > MAXPGPATH)
elog(ERROR, "Value specified to --waldir is too long");
}
restore_params->waldir = gl_waldir_path;
}
/*
* Parse set-backup options into set_backup_params structure.
*/
if (backup_subcmd == SET_BACKUP_CMD || backup_subcmd == BACKUP_CMD)
{
time_t expire_time = 0;
if (expire_time_string && ttl >= 0)
elog(ERROR, "You cannot specify '--expire-time' and '--ttl' options together");
/* Parse string to seconds */
if (expire_time_string)
{
if (!parse_time(expire_time_string, &expire_time, false))
elog(ERROR, "Invalid value for '--expire-time' option: '%s'",
expire_time_string);
}
if (expire_time > 0 || ttl >= 0 || backup_note)
{
set_backup_params = pgut_new(pgSetBackupParams);
set_backup_params->ttl = ttl;
set_backup_params->expire_time = expire_time;
set_backup_params->note = backup_note;
if (backup_note && strlen(backup_note) > MAX_NOTE_SIZE)
elog(ERROR, "Backup note cannot exceed %u bytes", MAX_NOTE_SIZE);
}
}
/* checking required options */
if (backup_subcmd == CATCHUP_CMD)
{
if (catchup_source_pgdata == NULL)
elog(ERROR, "You must specify \"--source-pgdata\" option with the \"%s\" command", get_subcmd_name(backup_subcmd));
if (catchup_destination_pgdata == NULL)
elog(ERROR, "You must specify \"--destination-pgdata\" option with the \"%s\" command", get_subcmd_name(backup_subcmd));
if (current.backup_mode == BACKUP_MODE_INVALID)
elog(ERROR, "No backup mode specified.\n"
"Please specify it either using environment variable BACKUP_MODE or\n"
"command line option --backup-mode (-b)");
if (current.backup_mode != BACKUP_MODE_FULL && current.backup_mode != BACKUP_MODE_DIFF_PTRACK && current.backup_mode != BACKUP_MODE_DIFF_DELTA)
elog(ERROR, "Only \"FULL\", \"PTRACK\" and \"DELTA\" modes are supported with the \"%s\" command", get_subcmd_name(backup_subcmd));
if (!stream_wal)
elog(INFO, "--stream is required, forcing stream mode");
current.stream = stream_wal = true;
if (instance_config.external_dir_str)
elog(ERROR, "External directories not supported fom \"%s\" command", get_subcmd_name(backup_subcmd));
// TODO check instance_config.conn_opt
}
/* sanity */
if (backup_subcmd == VALIDATE_CMD && restore_params->no_validate)
elog(ERROR, "You cannot specify \"--no-validate\" option with the \"%s\" command",
get_subcmd_name(backup_subcmd));
if (backup_subcmd == ARCHIVE_PUSH_CMD)
{
/* Check archive-push parameters and construct archive_push_xlog_dir
*
* There are 4 cases:
* 1. no --wal-file-path specified -- use cwd, ./PG_XLOG_DIR for wal files
* (and ./PG_XLOG_DIR/archive_status for .done files inside do_archive_push())
* in this case we can use batches and threads
* 2. --wal-file-path is specified and it is the same dir as stored in pg_probackup.conf (instance_config.pgdata)
* in this case we can use this path, as well as batches and thread
* 3. --wal-file-path is specified and it isn't same dir as stored in pg_probackup.conf but control file present with correct system_id
* in this case we can use this path, as well as batches and thread
* (replica for example, see test_archive_push_sanity)
* 4. --wal-file-path is specified and it is different from instance_config.pgdata and no control file found
* disable optimizations and work with user specified path
*/
bool check_system_id = true;
uint64 system_id;
char current_dir[MAXPGPATH];
if (wal_file_name == NULL)
elog(ERROR, "Required parameter is not specified: --wal-file-name %%f");
if (instance_config.pgdata == NULL)
elog(ERROR, "Cannot read pg_probackup.conf for this instance");
/* TODO may be remove in preference of checking inside compress_init()? */
if (instance_config.compress_alg == PGLZ_COMPRESS)
elog(ERROR, "Cannot use pglz for WAL compression");
if (!getcwd(current_dir, sizeof(current_dir)))
elog(ERROR, "getcwd() error");
if (wal_file_path == NULL)
{
/* 1st case */
system_id = get_system_identifier(current_dir, FIO_DB_HOST, false);
join_path_components(archive_push_xlog_dir, current_dir, XLOGDIR);
}
else
{
/*
* Usually we get something like
* wal_file_path = "pg_wal/0000000100000000000000A1"
* wal_file_name = "0000000100000000000000A1"
* instance_config.pgdata = "/pgdata/.../node/data"
* We need to strip wal_file_name from wal_file_path, add XLOGDIR to instance_config.pgdata
* and compare this directories.
* Note, that pg_wal can be symlink (see test_waldir_outside_pgdata_archiving)
*/
char *stripped_wal_file_path = pgut_str_strip_trailing_filename(wal_file_path, wal_file_name);
join_path_components(archive_push_xlog_dir, instance_config.pgdata, XLOGDIR);
if (fio_is_same_file(stripped_wal_file_path, archive_push_xlog_dir, true, FIO_DB_HOST))
{
/* 2nd case */
system_id = get_system_identifier(instance_config.pgdata, FIO_DB_HOST, false);
/* archive_push_xlog_dir already have right value */
}
else
{
if (strlen(stripped_wal_file_path) < MAXPGPATH)
strncpy(archive_push_xlog_dir, stripped_wal_file_path, MAXPGPATH);
else
elog(ERROR, "Value specified to --wal_file_path is too long");
system_id = get_system_identifier(current_dir, FIO_DB_HOST, true);
/* 3rd case if control file present -- i.e. system_id != 0 */
if (system_id == 0)
{
/* 4th case */
check_system_id = false;
if (batch_size > 1 || num_threads > 1 || !no_ready_rename)
{
elog(WARNING, "Supplied --wal_file_path is outside pgdata, force safe values for options: --batch-size=1 -j 1 --no-ready-rename");
batch_size = 1;
num_threads = 1;
no_ready_rename = true;
}
}
}
pfree(stripped_wal_file_path);
}
if (check_system_id && system_id != instance_config.system_identifier)
elog(ERROR, "Refuse to push WAL segment %s into archive. Instance parameters mismatch."
"Instance '%s' should have SYSTEM_ID = " UINT64_FORMAT " instead of " UINT64_FORMAT,
wal_file_name, instanceState->instance_name, instance_config.system_identifier, system_id);
}
#if PG_VERSION_NUM >= 100000
if (temp_slot && perm_slot)
elog(ERROR, "You cannot specify \"--perm-slot\" option with the \"--temp-slot\" option");
/* if slot name was not provided for temp slot, use default slot name */
if (!replication_slot && temp_slot)
replication_slot = DEFAULT_TEMP_SLOT_NAME;
#endif
if (!replication_slot && perm_slot)
replication_slot = DEFAULT_PERMANENT_SLOT_NAME;
if (num_threads < 1)
num_threads = 1;
if (batch_size < 1)
batch_size = 1;
compress_init(backup_subcmd);
/* do actual operation */
switch (backup_subcmd)
{
case ARCHIVE_PUSH_CMD:
do_archive_push(instanceState, &instance_config, archive_push_xlog_dir, wal_file_name,
batch_size, file_overwrite, no_sync, no_ready_rename);
break;
case ARCHIVE_GET_CMD:
do_archive_get(instanceState, &instance_config, prefetch_dir,
wal_file_path, wal_file_name, batch_size, !no_validate_wal);
break;
case ADD_INSTANCE_CMD:
return do_add_instance(instanceState, &instance_config);
case DELETE_INSTANCE_CMD:
return do_delete_instance(instanceState);
case INIT_CMD:
return do_init(catalogState);
case BACKUP_CMD:
{
current.stream = stream_wal;
if (start_time != INVALID_BACKUP_ID)
elog(WARNING, "Please do not use the --start-time option to start backup. "
"This is a service option required to work with other extensions. "
"We do not guarantee future support for this flag.");
/* sanity */
if (current.backup_mode == BACKUP_MODE_INVALID)
elog(ERROR, "No backup mode specified.\n"
"Please specify it either using environment variable BACKUP_MODE or\n"