PostgreSQL Source Code  git master
pg_backup_archiver.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * pg_backup_archiver.c
4  *
5  * Private implementation of the archiver routines.
6  *
7  * See the headers to pg_restore for more details.
8  *
9  * Copyright (c) 2000, Philip Warner
10  * Rights are granted to use this software in any way so long
11  * as this notice is not removed.
12  *
13  * The author is not responsible for loss or damages that may
14  * result from its use.
15  *
16  *
17  * IDENTIFICATION
18  * src/bin/pg_dump/pg_backup_archiver.c
19  *
20  *-------------------------------------------------------------------------
21  */
22 #include "postgres_fe.h"
23 
24 #include <ctype.h>
25 #include <fcntl.h>
26 #include <unistd.h>
27 #include <sys/stat.h>
28 #include <sys/wait.h>
29 #ifdef WIN32
30 #include <io.h>
31 #endif
32 
33 #include "common/string.h"
34 #include "dumputils.h"
35 #include "fe_utils/string_utils.h"
36 #include "lib/stringinfo.h"
37 #include "libpq/libpq-fs.h"
38 #include "parallel.h"
39 #include "pg_backup_archiver.h"
40 #include "pg_backup_db.h"
41 #include "pg_backup_utils.h"
42 
43 #define TEXT_DUMP_HEADER "--\n-- PostgreSQL database dump\n--\n\n"
44 #define TEXT_DUMPALL_HEADER "--\n-- PostgreSQL database cluster dump\n--\n\n"
45 
46 /* state needed to save/restore an archive's output target */
47 typedef struct _outputContext
48 {
49  void *OF;
50  int gzOut;
52 
53 /*
54  * State for tracking TocEntrys that are ready to process during a parallel
55  * restore. (This used to be a list, and we still call it that, though now
56  * it's really an array so that we can apply qsort to it.)
57  *
58  * tes[] is sized large enough that we can't overrun it.
59  * The valid entries are indexed first_te .. last_te inclusive.
60  * We periodically sort the array to bring larger-by-dataLength entries to
61  * the front; "sorted" is true if the valid entries are known sorted.
62  */
63 typedef struct _parallelReadyList
64 {
65  TocEntry **tes; /* Ready-to-dump TocEntrys */
66  int first_te; /* index of first valid entry in tes[] */
67  int last_te; /* index of last valid entry in tes[] */
68  bool sorted; /* are valid entries currently sorted? */
70 
71 
72 static ArchiveHandle *_allocAH(const char *FileSpec, const ArchiveFormat fmt,
73  const int compression, bool dosync, ArchiveMode mode,
74  SetupWorkerPtrType setupWorkerPtr);
76 static void _printTocEntry(ArchiveHandle *AH, TocEntry *te, bool isData);
77 static char *sanitize_line(const char *str, bool want_hyphen);
78 static void _doSetFixedOutputState(ArchiveHandle *AH);
79 static void _doSetSessionAuth(ArchiveHandle *AH, const char *user);
80 static void _reconnectToDB(ArchiveHandle *AH, const char *dbname);
81 static void _becomeUser(ArchiveHandle *AH, const char *user);
82 static void _becomeOwner(ArchiveHandle *AH, TocEntry *te);
83 static void _selectOutputSchema(ArchiveHandle *AH, const char *schemaName);
84 static void _selectTablespace(ArchiveHandle *AH, const char *tablespace);
85 static void _selectTableAccessMethod(ArchiveHandle *AH, const char *tableam);
86 static void processEncodingEntry(ArchiveHandle *AH, TocEntry *te);
87 static void processStdStringsEntry(ArchiveHandle *AH, TocEntry *te);
88 static void processSearchPathEntry(ArchiveHandle *AH, TocEntry *te);
89 static teReqs _tocEntryRequired(TocEntry *te, teSection curSection, ArchiveHandle *AH);
91 static bool _tocEntryIsACL(TocEntry *te);
94 static void buildTocEntryArrays(ArchiveHandle *AH);
95 static void _moveBefore(TocEntry *pos, TocEntry *te);
97 
98 static int RestoringToDB(ArchiveHandle *AH);
99 static void dump_lo_buf(ArchiveHandle *AH);
100 static void dumpTimestamp(ArchiveHandle *AH, const char *msg, time_t tim);
101 static void SetOutput(ArchiveHandle *AH, const char *filename, int compression);
103 static void RestoreOutput(ArchiveHandle *AH, OutputContext savedContext);
104 
105 static int restore_toc_entry(ArchiveHandle *AH, TocEntry *te, bool is_parallel);
107  TocEntry *pending_list);
109  ParallelState *pstate,
110  TocEntry *pending_list);
112  TocEntry *pending_list);
113 static void pending_list_header_init(TocEntry *l);
114 static void pending_list_append(TocEntry *l, TocEntry *te);
115 static void pending_list_remove(TocEntry *te);
116 static void ready_list_init(ParallelReadyList *ready_list, int tocCount);
117 static void ready_list_free(ParallelReadyList *ready_list);
118 static void ready_list_insert(ParallelReadyList *ready_list, TocEntry *te);
119 static void ready_list_remove(ParallelReadyList *ready_list, int i);
120 static void ready_list_sort(ParallelReadyList *ready_list);
121 static int TocEntrySizeCompare(const void *p1, const void *p2);
122 static void move_to_ready_list(TocEntry *pending_list,
123  ParallelReadyList *ready_list,
124  RestorePass pass);
125 static TocEntry *pop_next_work_item(ParallelReadyList *ready_list,
126  ParallelState *pstate);
127 static void mark_dump_job_done(ArchiveHandle *AH,
128  TocEntry *te,
129  int status,
130  void *callback_data);
131 static void mark_restore_job_done(ArchiveHandle *AH,
132  TocEntry *te,
133  int status,
134  void *callback_data);
135 static void fix_dependencies(ArchiveHandle *AH);
136 static bool has_lock_conflicts(TocEntry *te1, TocEntry *te2);
139 static void reduce_dependencies(ArchiveHandle *AH, TocEntry *te,
140  ParallelReadyList *ready_list);
141 static void mark_create_done(ArchiveHandle *AH, TocEntry *te);
143 
144 static void StrictNamesCheck(RestoreOptions *ropt);
145 
146 
147 /*
148  * Allocate a new DumpOptions block containing all default values.
149  */
150 DumpOptions *
152 {
153  DumpOptions *opts = (DumpOptions *) pg_malloc(sizeof(DumpOptions));
154 
155  InitDumpOptions(opts);
156  return opts;
157 }
158 
159 /*
160  * Initialize a DumpOptions struct to all default values
161  */
162 void
164 {
165  memset(opts, 0, sizeof(DumpOptions));
166  /* set any fields that shouldn't default to zeroes */
167  opts->include_everything = true;
170 }
171 
172 /*
173  * Create a freshly allocated DumpOptions with options equivalent to those
174  * found in the given RestoreOptions.
175  */
176 DumpOptions *
178 {
179  DumpOptions *dopt = NewDumpOptions();
180 
181  /* this is the inverse of what's at the end of pg_dump.c's main() */
182  dopt->cparams.dbname = ropt->cparams.dbname ? pg_strdup(ropt->cparams.dbname) : NULL;
183  dopt->cparams.pgport = ropt->cparams.pgport ? pg_strdup(ropt->cparams.pgport) : NULL;
184  dopt->cparams.pghost = ropt->cparams.pghost ? pg_strdup(ropt->cparams.pghost) : NULL;
185  dopt->cparams.username = ropt->cparams.username ? pg_strdup(ropt->cparams.username) : NULL;
187  dopt->outputClean = ropt->dropSchema;
188  dopt->dataOnly = ropt->dataOnly;
189  dopt->schemaOnly = ropt->schemaOnly;
190  dopt->if_exists = ropt->if_exists;
191  dopt->column_inserts = ropt->column_inserts;
192  dopt->dumpSections = ropt->dumpSections;
193  dopt->aclsSkip = ropt->aclsSkip;
194  dopt->outputSuperuser = ropt->superuser;
195  dopt->outputCreateDB = ropt->createDB;
196  dopt->outputNoOwner = ropt->noOwner;
197  dopt->outputNoTablespaces = ropt->noTablespace;
198  dopt->disable_triggers = ropt->disable_triggers;
199  dopt->use_setsessauth = ropt->use_setsessauth;
201  dopt->dump_inserts = ropt->dump_inserts;
202  dopt->no_comments = ropt->no_comments;
203  dopt->no_publications = ropt->no_publications;
205  dopt->no_subscriptions = ropt->no_subscriptions;
206  dopt->lockWaitTimeout = ropt->lockWaitTimeout;
209  dopt->sequence_data = ropt->sequence_data;
210 
211  return dopt;
212 }
213 
214 
215 /*
216  * Wrapper functions.
217  *
218  * The objective is to make writing new formats and dumpers as simple
219  * as possible, if necessary at the expense of extra function calls etc.
220  *
221  */
222 
223 /*
224  * The dump worker setup needs lots of knowledge of the internals of pg_dump,
225  * so it's defined in pg_dump.c and passed into OpenArchive. The restore worker
226  * setup doesn't need to know anything much, so it's defined here.
227  */
228 static void
230 {
231  ArchiveHandle *AH = (ArchiveHandle *) AHX;
232 
233  AH->ReopenPtr(AH);
234 }
235 
236 
237 /* Create a new archive */
238 /* Public */
239 Archive *
240 CreateArchive(const char *FileSpec, const ArchiveFormat fmt,
241  const int compression, bool dosync, ArchiveMode mode,
243 
244 {
245  ArchiveHandle *AH = _allocAH(FileSpec, fmt, compression, dosync,
246  mode, setupDumpWorker);
247 
248  return (Archive *) AH;
249 }
250 
251 /* Open an existing archive */
252 /* Public */
253 Archive *
254 OpenArchive(const char *FileSpec, const ArchiveFormat fmt)
255 {
256  ArchiveHandle *AH = _allocAH(FileSpec, fmt, 0, true, archModeRead, setupRestoreWorker);
257 
258  return (Archive *) AH;
259 }
260 
261 /* Public */
262 void
264 {
265  int res = 0;
266  ArchiveHandle *AH = (ArchiveHandle *) AHX;
267 
268  AH->ClosePtr(AH);
269 
270  /* Close the output */
271  if (AH->gzOut)
272  res = GZCLOSE(AH->OF);
273  else if (AH->OF != stdout)
274  res = fclose(AH->OF);
275 
276  if (res != 0)
277  fatal("could not close output file: %m");
278 }
279 
280 /* Public */
281 void
283 {
284  /* Caller can omit dump options, in which case we synthesize them */
285  if (dopt == NULL && ropt != NULL)
286  dopt = dumpOptionsFromRestoreOptions(ropt);
287 
288  /* Save options for later access */
289  AH->dopt = dopt;
290  AH->ropt = ropt;
291 }
292 
293 /* Public */
294 void
296 {
297  ArchiveHandle *AH = (ArchiveHandle *) AHX;
298  RestoreOptions *ropt = AH->public.ropt;
299  TocEntry *te;
300  teSection curSection;
301 
302  /* Decide which TOC entries will be dumped/restored, and mark them */
303  curSection = SECTION_PRE_DATA;
304  for (te = AH->toc->next; te != AH->toc; te = te->next)
305  {
306  /*
307  * When writing an archive, we also take this opportunity to check
308  * that we have generated the entries in a sane order that respects
309  * the section divisions. When reading, don't complain, since buggy
310  * old versions of pg_dump might generate out-of-order archives.
311  */
312  if (AH->mode != archModeRead)
313  {
314  switch (te->section)
315  {
316  case SECTION_NONE:
317  /* ok to be anywhere */
318  break;
319  case SECTION_PRE_DATA:
320  if (curSection != SECTION_PRE_DATA)
321  pg_log_warning("archive items not in correct section order");
322  break;
323  case SECTION_DATA:
324  if (curSection == SECTION_POST_DATA)
325  pg_log_warning("archive items not in correct section order");
326  break;
327  case SECTION_POST_DATA:
328  /* ok no matter which section we were in */
329  break;
330  default:
331  fatal("unexpected section code %d",
332  (int) te->section);
333  break;
334  }
335  }
336 
337  if (te->section != SECTION_NONE)
338  curSection = te->section;
339 
340  te->reqs = _tocEntryRequired(te, curSection, AH);
341  }
342 
343  /* Enforce strict names checking */
344  if (ropt->strict_names)
345  StrictNamesCheck(ropt);
346 }
347 
348 /* Public */
349 void
351 {
352  ArchiveHandle *AH = (ArchiveHandle *) AHX;
353  RestoreOptions *ropt = AH->public.ropt;
354  bool parallel_mode;
355  TocEntry *te;
356  OutputContext sav;
357 
359 
360  /*
361  * If we're going to do parallel restore, there are some restrictions.
362  */
363  parallel_mode = (AH->public.numWorkers > 1 && ropt->useDB);
364  if (parallel_mode)
365  {
366  /* We haven't got round to making this work for all archive formats */
367  if (AH->ClonePtr == NULL || AH->ReopenPtr == NULL)
368  fatal("parallel restore is not supported with this archive file format");
369 
370  /* Doesn't work if the archive represents dependencies as OIDs */
371  if (AH->version < K_VERS_1_8)
372  fatal("parallel restore is not supported with archives made by pre-8.0 pg_dump");
373 
374  /*
375  * It's also not gonna work if we can't reopen the input file, so
376  * let's try that immediately.
377  */
378  AH->ReopenPtr(AH);
379  }
380 
381  /*
382  * Make sure we won't need (de)compression we haven't got
383  */
384 #ifndef HAVE_LIBZ
385  if (AH->compression != 0 && AH->PrintTocDataPtr != NULL)
386  {
387  for (te = AH->toc->next; te != AH->toc; te = te->next)
388  {
389  if (te->hadDumper && (te->reqs & REQ_DATA) != 0)
390  fatal("cannot restore from compressed archive (compression not supported in this installation)");
391  }
392  }
393 #endif
394 
395  /*
396  * Prepare index arrays, so we can assume we have them throughout restore.
397  * It's possible we already did this, though.
398  */
399  if (AH->tocsByDumpId == NULL)
401 
402  /*
403  * If we're using a DB connection, then connect it.
404  */
405  if (ropt->useDB)
406  {
407  pg_log_info("connecting to database for restore");
408  if (AH->version < K_VERS_1_3)
409  fatal("direct database connections are not supported in pre-1.3 archives");
410 
411  /*
412  * We don't want to guess at whether the dump will successfully
413  * restore; allow the attempt regardless of the version of the restore
414  * target.
415  */
416  AHX->minRemoteVersion = 0;
417  AHX->maxRemoteVersion = 9999999;
418 
419  ConnectDatabase(AHX, &ropt->cparams, false);
420 
421  /*
422  * If we're talking to the DB directly, don't send comments since they
423  * obscure SQL when displaying errors
424  */
425  AH->noTocComments = 1;
426  }
427 
428  /*
429  * Work out if we have an implied data-only restore. This can happen if
430  * the dump was data only or if the user has used a toc list to exclude
431  * all of the schema data. All we do is look for schema entries - if none
432  * are found then we set the dataOnly flag.
433  *
434  * We could scan for wanted TABLE entries, but that is not the same as
435  * dataOnly. At this stage, it seems unnecessary (6-Mar-2001).
436  */
437  if (!ropt->dataOnly)
438  {
439  int impliedDataOnly = 1;
440 
441  for (te = AH->toc->next; te != AH->toc; te = te->next)
442  {
443  if ((te->reqs & REQ_SCHEMA) != 0)
444  { /* It's schema, and it's wanted */
445  impliedDataOnly = 0;
446  break;
447  }
448  }
449  if (impliedDataOnly)
450  {
451  ropt->dataOnly = impliedDataOnly;
452  pg_log_info("implied data-only restore");
453  }
454  }
455 
456  /*
457  * Setup the output file if necessary.
458  */
459  sav = SaveOutput(AH);
460  if (ropt->filename || ropt->compression)
461  SetOutput(AH, ropt->filename, ropt->compression);
462 
463  ahprintf(AH, "--\n-- PostgreSQL database dump\n--\n\n");
464 
465  if (AH->archiveRemoteVersion)
466  ahprintf(AH, "-- Dumped from database version %s\n",
468  if (AH->archiveDumpVersion)
469  ahprintf(AH, "-- Dumped by pg_dump version %s\n",
470  AH->archiveDumpVersion);
471 
472  ahprintf(AH, "\n");
473 
474  if (AH->public.verbose)
475  dumpTimestamp(AH, "Started on", AH->createDate);
476 
477  if (ropt->single_txn)
478  {
479  if (AH->connection)
480  StartTransaction(AHX);
481  else
482  ahprintf(AH, "BEGIN;\n\n");
483  }
484 
485  /*
486  * Establish important parameter values right away.
487  */
489 
490  AH->stage = STAGE_PROCESSING;
491 
492  /*
493  * Drop the items at the start, in reverse order
494  */
495  if (ropt->dropSchema)
496  {
497  for (te = AH->toc->prev; te != AH->toc; te = te->prev)
498  {
499  AH->currentTE = te;
500 
501  /*
502  * In createDB mode, issue a DROP *only* for the database as a
503  * whole. Issuing drops against anything else would be wrong,
504  * because at this point we're connected to the wrong database.
505  * (The DATABASE PROPERTIES entry, if any, should be treated like
506  * the DATABASE entry.)
507  */
508  if (ropt->createDB)
509  {
510  if (strcmp(te->desc, "DATABASE") != 0 &&
511  strcmp(te->desc, "DATABASE PROPERTIES") != 0)
512  continue;
513  }
514 
515  /* Otherwise, drop anything that's selected and has a dropStmt */
516  if (((te->reqs & (REQ_SCHEMA | REQ_DATA)) != 0) && te->dropStmt)
517  {
518  pg_log_info("dropping %s %s", te->desc, te->tag);
519  /* Select owner and schema as necessary */
520  _becomeOwner(AH, te);
521  _selectOutputSchema(AH, te->namespace);
522 
523  /*
524  * Now emit the DROP command, if the object has one. Note we
525  * don't necessarily emit it verbatim; at this point we add an
526  * appropriate IF EXISTS clause, if the user requested it.
527  */
528  if (*te->dropStmt != '\0')
529  {
530  if (!ropt->if_exists)
531  {
532  /* No --if-exists? Then just use the original */
533  ahprintf(AH, "%s", te->dropStmt);
534  }
535  else
536  {
537  /*
538  * Inject an appropriate spelling of "if exists". For
539  * large objects, we have a separate routine that
540  * knows how to do it, without depending on
541  * te->dropStmt; use that. For other objects we need
542  * to parse the command.
543  */
544  if (strncmp(te->desc, "BLOB", 4) == 0)
545  {
546  DropBlobIfExists(AH, te->catalogId.oid);
547  }
548  else
549  {
550  char *dropStmt = pg_strdup(te->dropStmt);
551  char *dropStmtOrig = dropStmt;
552  PQExpBuffer ftStmt = createPQExpBuffer();
553 
554  /*
555  * Need to inject IF EXISTS clause after ALTER
556  * TABLE part in ALTER TABLE .. DROP statement
557  */
558  if (strncmp(dropStmt, "ALTER TABLE", 11) == 0)
559  {
560  appendPQExpBufferStr(ftStmt,
561  "ALTER TABLE IF EXISTS");
562  dropStmt = dropStmt + 11;
563  }
564 
565  /*
566  * ALTER TABLE..ALTER COLUMN..DROP DEFAULT does
567  * not support the IF EXISTS clause, and therefore
568  * we simply emit the original command for DEFAULT
569  * objects (modulo the adjustment made above).
570  *
571  * Likewise, don't mess with DATABASE PROPERTIES.
572  *
573  * If we used CREATE OR REPLACE VIEW as a means of
574  * quasi-dropping an ON SELECT rule, that should
575  * be emitted unchanged as well.
576  *
577  * For other object types, we need to extract the
578  * first part of the DROP which includes the
579  * object type. Most of the time this matches
580  * te->desc, so search for that; however for the
581  * different kinds of CONSTRAINTs, we know to
582  * search for hardcoded "DROP CONSTRAINT" instead.
583  */
584  if (strcmp(te->desc, "DEFAULT") == 0 ||
585  strcmp(te->desc, "DATABASE PROPERTIES") == 0 ||
586  strncmp(dropStmt, "CREATE OR REPLACE VIEW", 22) == 0)
587  appendPQExpBufferStr(ftStmt, dropStmt);
588  else
589  {
590  char buffer[40];
591  char *mark;
592 
593  if (strcmp(te->desc, "CONSTRAINT") == 0 ||
594  strcmp(te->desc, "CHECK CONSTRAINT") == 0 ||
595  strcmp(te->desc, "FK CONSTRAINT") == 0)
596  strcpy(buffer, "DROP CONSTRAINT");
597  else
598  snprintf(buffer, sizeof(buffer), "DROP %s",
599  te->desc);
600 
601  mark = strstr(dropStmt, buffer);
602 
603  if (mark)
604  {
605  *mark = '\0';
606  appendPQExpBuffer(ftStmt, "%s%s IF EXISTS%s",
607  dropStmt, buffer,
608  mark + strlen(buffer));
609  }
610  else
611  {
612  /* complain and emit unmodified command */
613  pg_log_warning("could not find where to insert IF EXISTS in statement \"%s\"",
614  dropStmtOrig);
615  appendPQExpBufferStr(ftStmt, dropStmt);
616  }
617  }
618 
619  ahprintf(AH, "%s", ftStmt->data);
620 
621  destroyPQExpBuffer(ftStmt);
622  pg_free(dropStmtOrig);
623  }
624  }
625  }
626  }
627  }
628 
629  /*
630  * _selectOutputSchema may have set currSchema to reflect the effect
631  * of a "SET search_path" command it emitted. However, by now we may
632  * have dropped that schema; or it might not have existed in the first
633  * place. In either case the effective value of search_path will not
634  * be what we think. Forcibly reset currSchema so that we will
635  * re-establish the search_path setting when needed (after creating
636  * the schema).
637  *
638  * If we treated users as pg_dump'able objects then we'd need to reset
639  * currUser here too.
640  */
641  if (AH->currSchema)
642  free(AH->currSchema);
643  AH->currSchema = NULL;
644  }
645 
646  if (parallel_mode)
647  {
648  /*
649  * In parallel mode, turn control over to the parallel-restore logic.
650  */
651  ParallelState *pstate;
652  TocEntry pending_list;
653 
654  /* The archive format module may need some setup for this */
655  if (AH->PrepParallelRestorePtr)
656  AH->PrepParallelRestorePtr(AH);
657 
658  pending_list_header_init(&pending_list);
659 
660  /* This runs PRE_DATA items and then disconnects from the database */
661  restore_toc_entries_prefork(AH, &pending_list);
662  Assert(AH->connection == NULL);
663 
664  /* ParallelBackupStart() will actually fork the processes */
665  pstate = ParallelBackupStart(AH);
666  restore_toc_entries_parallel(AH, pstate, &pending_list);
667  ParallelBackupEnd(AH, pstate);
668 
669  /* reconnect the leader and see if we missed something */
670  restore_toc_entries_postfork(AH, &pending_list);
671  Assert(AH->connection != NULL);
672  }
673  else
674  {
675  /*
676  * In serial mode, process everything in three phases: normal items,
677  * then ACLs, then post-ACL items. We might be able to skip one or
678  * both extra phases in some cases, eg data-only restores.
679  */
680  bool haveACL = false;
681  bool havePostACL = false;
682 
683  for (te = AH->toc->next; te != AH->toc; te = te->next)
684  {
685  if ((te->reqs & (REQ_SCHEMA | REQ_DATA)) == 0)
686  continue; /* ignore if not to be dumped at all */
687 
688  switch (_tocEntryRestorePass(te))
689  {
690  case RESTORE_PASS_MAIN:
691  (void) restore_toc_entry(AH, te, false);
692  break;
693  case RESTORE_PASS_ACL:
694  haveACL = true;
695  break;
696  case RESTORE_PASS_POST_ACL:
697  havePostACL = true;
698  break;
699  }
700  }
701 
702  if (haveACL)
703  {
704  for (te = AH->toc->next; te != AH->toc; te = te->next)
705  {
706  if ((te->reqs & (REQ_SCHEMA | REQ_DATA)) != 0 &&
708  (void) restore_toc_entry(AH, te, false);
709  }
710  }
711 
712  if (havePostACL)
713  {
714  for (te = AH->toc->next; te != AH->toc; te = te->next)
715  {
716  if ((te->reqs & (REQ_SCHEMA | REQ_DATA)) != 0 &&
717  _tocEntryRestorePass(te) == RESTORE_PASS_POST_ACL)
718  (void) restore_toc_entry(AH, te, false);
719  }
720  }
721  }
722 
723  if (ropt->single_txn)
724  {
725  if (AH->connection)
726  CommitTransaction(AHX);
727  else
728  ahprintf(AH, "COMMIT;\n\n");
729  }
730 
731  if (AH->public.verbose)
732  dumpTimestamp(AH, "Completed on", time(NULL));
733 
734  ahprintf(AH, "--\n-- PostgreSQL database dump complete\n--\n\n");
735 
736  /*
737  * Clean up & we're done.
738  */
739  AH->stage = STAGE_FINALIZING;
740 
741  if (ropt->filename || ropt->compression)
742  RestoreOutput(AH, sav);
743 
744  if (ropt->useDB)
746 }
747 
748 /*
749  * Restore a single TOC item. Used in both parallel and non-parallel restore;
750  * is_parallel is true if we are in a worker child process.
751  *
752  * Returns 0 normally, but WORKER_CREATE_DONE or WORKER_INHIBIT_DATA if
753  * the parallel parent has to make the corresponding status update.
754  */
755 static int
756 restore_toc_entry(ArchiveHandle *AH, TocEntry *te, bool is_parallel)
757 {
758  RestoreOptions *ropt = AH->public.ropt;
759  int status = WORKER_OK;
760  teReqs reqs;
761  bool defnDumped;
762 
763  AH->currentTE = te;
764 
765  /* Dump any relevant dump warnings to stderr */
766  if (!ropt->suppressDumpWarnings && strcmp(te->desc, "WARNING") == 0)
767  {
768  if (!ropt->dataOnly && te->defn != NULL && strlen(te->defn) != 0)
769  pg_log_warning("warning from original dump file: %s", te->defn);
770  else if (te->copyStmt != NULL && strlen(te->copyStmt) != 0)
771  pg_log_warning("warning from original dump file: %s", te->copyStmt);
772  }
773 
774  /* Work out what, if anything, we want from this entry */
775  reqs = te->reqs;
776 
777  defnDumped = false;
778 
779  /*
780  * If it has a schema component that we want, then process that
781  */
782  if ((reqs & REQ_SCHEMA) != 0)
783  {
784  /* Show namespace in log message if available */
785  if (te->namespace)
786  pg_log_info("creating %s \"%s.%s\"",
787  te->desc, te->namespace, te->tag);
788  else
789  pg_log_info("creating %s \"%s\"",
790  te->desc, te->tag);
791 
792  _printTocEntry(AH, te, false);
793  defnDumped = true;
794 
795  if (strcmp(te->desc, "TABLE") == 0)
796  {
797  if (AH->lastErrorTE == te)
798  {
799  /*
800  * We failed to create the table. If
801  * --no-data-for-failed-tables was given, mark the
802  * corresponding TABLE DATA to be ignored.
803  *
804  * In the parallel case this must be done in the parent, so we
805  * just set the return value.
806  */
807  if (ropt->noDataForFailedTables)
808  {
809  if (is_parallel)
810  status = WORKER_INHIBIT_DATA;
811  else
813  }
814  }
815  else
816  {
817  /*
818  * We created the table successfully. Mark the corresponding
819  * TABLE DATA for possible truncation.
820  *
821  * In the parallel case this must be done in the parent, so we
822  * just set the return value.
823  */
824  if (is_parallel)
825  status = WORKER_CREATE_DONE;
826  else
827  mark_create_done(AH, te);
828  }
829  }
830 
831  /*
832  * If we created a DB, connect to it. Also, if we changed DB
833  * properties, reconnect to ensure that relevant GUC settings are
834  * applied to our session.
835  */
836  if (strcmp(te->desc, "DATABASE") == 0 ||
837  strcmp(te->desc, "DATABASE PROPERTIES") == 0)
838  {
839  pg_log_info("connecting to new database \"%s\"", te->tag);
840  _reconnectToDB(AH, te->tag);
841  }
842  }
843 
844  /*
845  * If it has a data component that we want, then process that
846  */
847  if ((reqs & REQ_DATA) != 0)
848  {
849  /*
850  * hadDumper will be set if there is genuine data component for this
851  * node. Otherwise, we need to check the defn field for statements
852  * that need to be executed in data-only restores.
853  */
854  if (te->hadDumper)
855  {
856  /*
857  * If we can output the data, then restore it.
858  */
859  if (AH->PrintTocDataPtr != NULL)
860  {
861  _printTocEntry(AH, te, true);
862 
863  if (strcmp(te->desc, "BLOBS") == 0 ||
864  strcmp(te->desc, "BLOB COMMENTS") == 0)
865  {
866  pg_log_info("processing %s", te->desc);
867 
868  _selectOutputSchema(AH, "pg_catalog");
869 
870  /* Send BLOB COMMENTS data to ExecuteSimpleCommands() */
871  if (strcmp(te->desc, "BLOB COMMENTS") == 0)
873 
874  AH->PrintTocDataPtr(AH, te);
875 
877  }
878  else
879  {
881 
882  /* Select owner and schema as necessary */
883  _becomeOwner(AH, te);
884  _selectOutputSchema(AH, te->namespace);
885 
886  pg_log_info("processing data for table \"%s.%s\"",
887  te->namespace, te->tag);
888 
889  /*
890  * In parallel restore, if we created the table earlier in
891  * the run then we wrap the COPY in a transaction and
892  * precede it with a TRUNCATE. If archiving is not on
893  * this prevents WAL-logging the COPY. This obtains a
894  * speedup similar to that from using single_txn mode in
895  * non-parallel restores.
896  */
897  if (is_parallel && te->created)
898  {
899  /*
900  * Parallel restore is always talking directly to a
901  * server, so no need to see if we should issue BEGIN.
902  */
903  StartTransaction(&AH->public);
904 
905  /*
906  * If the server version is >= 8.4, make sure we issue
907  * TRUNCATE with ONLY so that child tables are not
908  * wiped.
909  */
910  ahprintf(AH, "TRUNCATE TABLE %s%s;\n\n",
911  (PQserverVersion(AH->connection) >= 80400 ?
912  "ONLY " : ""),
913  fmtQualifiedId(te->namespace, te->tag));
914  }
915 
916  /*
917  * If we have a copy statement, use it.
918  */
919  if (te->copyStmt && strlen(te->copyStmt) > 0)
920  {
921  ahprintf(AH, "%s", te->copyStmt);
923  }
924  else
926 
927  AH->PrintTocDataPtr(AH, te);
928 
929  /*
930  * Terminate COPY if needed.
931  */
932  if (AH->outputKind == OUTPUT_COPYDATA &&
933  RestoringToDB(AH))
934  EndDBCopyMode(&AH->public, te->tag);
936 
937  /* close out the transaction started above */
938  if (is_parallel && te->created)
940 
942  }
943  }
944  }
945  else if (!defnDumped)
946  {
947  /* If we haven't already dumped the defn part, do so now */
948  pg_log_info("executing %s %s", te->desc, te->tag);
949  _printTocEntry(AH, te, false);
950  }
951  }
952 
953  if (AH->public.n_errors > 0 && status == WORKER_OK)
954  status = WORKER_IGNORED_ERRORS;
955 
956  return status;
957 }
958 
959 /*
960  * Allocate a new RestoreOptions block.
961  * This is mainly so we can initialize it, but also for future expansion,
962  */
965 {
966  RestoreOptions *opts;
967 
968  opts = (RestoreOptions *) pg_malloc0(sizeof(RestoreOptions));
969 
970  /* set any fields that shouldn't default to zeroes */
971  opts->format = archUnknown;
974 
975  return opts;
976 }
977 
978 static void
980 {
981  RestoreOptions *ropt = AH->public.ropt;
982 
983  /* This hack is only needed in a data-only restore */
984  if (!ropt->dataOnly || !ropt->disable_triggers)
985  return;
986 
987  pg_log_info("disabling triggers for %s", te->tag);
988 
989  /*
990  * Become superuser if possible, since they are the only ones who can
991  * disable constraint triggers. If -S was not given, assume the initial
992  * user identity is a superuser. (XXX would it be better to become the
993  * table owner?)
994  */
995  _becomeUser(AH, ropt->superuser);
996 
997  /*
998  * Disable them.
999  */
1000  ahprintf(AH, "ALTER TABLE %s DISABLE TRIGGER ALL;\n\n",
1001  fmtQualifiedId(te->namespace, te->tag));
1002 }
1003 
1004 static void
1006 {
1007  RestoreOptions *ropt = AH->public.ropt;
1008 
1009  /* This hack is only needed in a data-only restore */
1010  if (!ropt->dataOnly || !ropt->disable_triggers)
1011  return;
1012 
1013  pg_log_info("enabling triggers for %s", te->tag);
1014 
1015  /*
1016  * Become superuser if possible, since they are the only ones who can
1017  * disable constraint triggers. If -S was not given, assume the initial
1018  * user identity is a superuser. (XXX would it be better to become the
1019  * table owner?)
1020  */
1021  _becomeUser(AH, ropt->superuser);
1022 
1023  /*
1024  * Enable them.
1025  */
1026  ahprintf(AH, "ALTER TABLE %s ENABLE TRIGGER ALL;\n\n",
1027  fmtQualifiedId(te->namespace, te->tag));
1028 }
1029 
1030 /*
1031  * This is a routine that is part of the dumper interface, hence the 'Archive*' parameter.
1032  */
1033 
1034 /* Public */
1035 void
1036 WriteData(Archive *AHX, const void *data, size_t dLen)
1037 {
1038  ArchiveHandle *AH = (ArchiveHandle *) AHX;
1039 
1040  if (!AH->currToc)
1041  fatal("internal error -- WriteData cannot be called outside the context of a DataDumper routine");
1042 
1043  AH->WriteDataPtr(AH, data, dLen);
1044 }
1045 
1046 /*
1047  * Create a new TOC entry. The TOC was designed as a TOC, but is now the
1048  * repository for all metadata. But the name has stuck.
1049  *
1050  * The new entry is added to the Archive's TOC list. Most callers can ignore
1051  * the result value because nothing else need be done, but a few want to
1052  * manipulate the TOC entry further.
1053  */
1054 
1055 /* Public */
1056 TocEntry *
1057 ArchiveEntry(Archive *AHX, CatalogId catalogId, DumpId dumpId,
1058  ArchiveOpts *opts)
1059 {
1060  ArchiveHandle *AH = (ArchiveHandle *) AHX;
1061  TocEntry *newToc;
1062 
1063  newToc = (TocEntry *) pg_malloc0(sizeof(TocEntry));
1064 
1065  AH->tocCount++;
1066  if (dumpId > AH->maxDumpId)
1067  AH->maxDumpId = dumpId;
1068 
1069  newToc->prev = AH->toc->prev;
1070  newToc->next = AH->toc;
1071  AH->toc->prev->next = newToc;
1072  AH->toc->prev = newToc;
1073 
1074  newToc->catalogId = catalogId;
1075  newToc->dumpId = dumpId;
1076  newToc->section = opts->section;
1077 
1078  newToc->tag = pg_strdup(opts->tag);
1079  newToc->namespace = opts->namespace ? pg_strdup(opts->namespace) : NULL;
1080  newToc->tablespace = opts->tablespace ? pg_strdup(opts->tablespace) : NULL;
1081  newToc->tableam = opts->tableam ? pg_strdup(opts->tableam) : NULL;
1082  newToc->owner = opts->owner ? pg_strdup(opts->owner) : NULL;
1083  newToc->desc = pg_strdup(opts->description);
1084  newToc->defn = opts->createStmt ? pg_strdup(opts->createStmt) : NULL;
1085  newToc->dropStmt = opts->dropStmt ? pg_strdup(opts->dropStmt) : NULL;
1086  newToc->copyStmt = opts->copyStmt ? pg_strdup(opts->copyStmt) : NULL;
1087 
1088  if (opts->nDeps > 0)
1089  {
1090  newToc->dependencies = (DumpId *) pg_malloc(opts->nDeps * sizeof(DumpId));
1091  memcpy(newToc->dependencies, opts->deps, opts->nDeps * sizeof(DumpId));
1092  newToc->nDeps = opts->nDeps;
1093  }
1094  else
1095  {
1096  newToc->dependencies = NULL;
1097  newToc->nDeps = 0;
1098  }
1099 
1100  newToc->dataDumper = opts->dumpFn;
1101  newToc->dataDumperArg = opts->dumpArg;
1102  newToc->hadDumper = opts->dumpFn ? true : false;
1103 
1104  newToc->formatData = NULL;
1105  newToc->dataLength = 0;
1106 
1107  if (AH->ArchiveEntryPtr != NULL)
1108  AH->ArchiveEntryPtr(AH, newToc);
1109 
1110  return newToc;
1111 }
1112 
1113 /* Public */
1114 void
1116 {
1117  ArchiveHandle *AH = (ArchiveHandle *) AHX;
1118  RestoreOptions *ropt = AH->public.ropt;
1119  TocEntry *te;
1120  teSection curSection;
1121  OutputContext sav;
1122  const char *fmtName;
1123  char stamp_str[64];
1124 
1125  sav = SaveOutput(AH);
1126  if (ropt->filename)
1127  SetOutput(AH, ropt->filename, 0 /* no compression */ );
1128 
1129  if (strftime(stamp_str, sizeof(stamp_str), PGDUMP_STRFTIME_FMT,
1130  localtime(&AH->createDate)) == 0)
1131  strcpy(stamp_str, "[unknown]");
1132 
1133  ahprintf(AH, ";\n; Archive created at %s\n", stamp_str);
1134  ahprintf(AH, "; dbname: %s\n; TOC Entries: %d\n; Compression: %d\n",
1135  sanitize_line(AH->archdbname, false),
1136  AH->tocCount, AH->compression);
1137 
1138  switch (AH->format)
1139  {
1140  case archCustom:
1141  fmtName = "CUSTOM";
1142  break;
1143  case archDirectory:
1144  fmtName = "DIRECTORY";
1145  break;
1146  case archTar:
1147  fmtName = "TAR";
1148  break;
1149  default:
1150  fmtName = "UNKNOWN";
1151  }
1152 
1153  ahprintf(AH, "; Dump Version: %d.%d-%d\n",
1155  ahprintf(AH, "; Format: %s\n", fmtName);
1156  ahprintf(AH, "; Integer: %d bytes\n", (int) AH->intSize);
1157  ahprintf(AH, "; Offset: %d bytes\n", (int) AH->offSize);
1158  if (AH->archiveRemoteVersion)
1159  ahprintf(AH, "; Dumped from database version: %s\n",
1160  AH->archiveRemoteVersion);
1161  if (AH->archiveDumpVersion)
1162  ahprintf(AH, "; Dumped by pg_dump version: %s\n",
1163  AH->archiveDumpVersion);
1164 
1165  ahprintf(AH, ";\n;\n; Selected TOC Entries:\n;\n");
1166 
1167  curSection = SECTION_PRE_DATA;
1168  for (te = AH->toc->next; te != AH->toc; te = te->next)
1169  {
1170  if (te->section != SECTION_NONE)
1171  curSection = te->section;
1172  if (ropt->verbose ||
1173  (_tocEntryRequired(te, curSection, AH) & (REQ_SCHEMA | REQ_DATA)) != 0)
1174  {
1175  char *sanitized_name;
1176  char *sanitized_schema;
1177  char *sanitized_owner;
1178 
1179  /*
1180  */
1181  sanitized_name = sanitize_line(te->tag, false);
1182  sanitized_schema = sanitize_line(te->namespace, true);
1183  sanitized_owner = sanitize_line(te->owner, false);
1184 
1185  ahprintf(AH, "%d; %u %u %s %s %s %s\n", te->dumpId,
1186  te->catalogId.tableoid, te->catalogId.oid,
1187  te->desc, sanitized_schema, sanitized_name,
1188  sanitized_owner);
1189 
1190  free(sanitized_name);
1191  free(sanitized_schema);
1192  free(sanitized_owner);
1193  }
1194  if (ropt->verbose && te->nDeps > 0)
1195  {
1196  int i;
1197 
1198  ahprintf(AH, ";\tdepends on:");
1199  for (i = 0; i < te->nDeps; i++)
1200  ahprintf(AH, " %d", te->dependencies[i]);
1201  ahprintf(AH, "\n");
1202  }
1203  }
1204 
1205  /* Enforce strict names checking */
1206  if (ropt->strict_names)
1207  StrictNamesCheck(ropt);
1208 
1209  if (ropt->filename)
1210  RestoreOutput(AH, sav);
1211 }
1212 
1213 /***********
1214  * BLOB Archival
1215  ***********/
1216 
1217 /* Called by a dumper to signal start of a BLOB */
1218 int
1220 {
1221  ArchiveHandle *AH = (ArchiveHandle *) AHX;
1222 
1223  if (!AH->StartBlobPtr)
1224  fatal("large-object output not supported in chosen format");
1225 
1226  AH->StartBlobPtr(AH, AH->currToc, oid);
1227 
1228  return 1;
1229 }
1230 
1231 /* Called by a dumper to signal end of a BLOB */
1232 int
1233 EndBlob(Archive *AHX, Oid oid)
1234 {
1235  ArchiveHandle *AH = (ArchiveHandle *) AHX;
1236 
1237  if (AH->EndBlobPtr)
1238  AH->EndBlobPtr(AH, AH->currToc, oid);
1239 
1240  return 1;
1241 }
1242 
1243 /**********
1244  * BLOB Restoration
1245  **********/
1246 
1247 /*
1248  * Called by a format handler before any blobs are restored
1249  */
1250 void
1252 {
1253  RestoreOptions *ropt = AH->public.ropt;
1254 
1255  if (!ropt->single_txn)
1256  {
1257  if (AH->connection)
1258  StartTransaction(&AH->public);
1259  else
1260  ahprintf(AH, "BEGIN;\n\n");
1261  }
1262 
1263  AH->blobCount = 0;
1264 }
1265 
1266 /*
1267  * Called by a format handler after all blobs are restored
1268  */
1269 void
1271 {
1272  RestoreOptions *ropt = AH->public.ropt;
1273 
1274  if (!ropt->single_txn)
1275  {
1276  if (AH->connection)
1277  CommitTransaction(&AH->public);
1278  else
1279  ahprintf(AH, "COMMIT;\n\n");
1280  }
1281 
1282  pg_log_info(ngettext("restored %d large object",
1283  "restored %d large objects",
1284  AH->blobCount),
1285  AH->blobCount);
1286 }
1287 
1288 
1289 /*
1290  * Called by a format handler to initiate restoration of a blob
1291  */
1292 void
1293 StartRestoreBlob(ArchiveHandle *AH, Oid oid, bool drop)
1294 {
1295  bool old_blob_style = (AH->version < K_VERS_1_12);
1296  Oid loOid;
1297 
1298  AH->blobCount++;
1299 
1300  /* Initialize the LO Buffer */
1301  AH->lo_buf_used = 0;
1302 
1303  pg_log_info("restoring large object with OID %u", oid);
1304 
1305  /* With an old archive we must do drop and create logic here */
1306  if (old_blob_style && drop)
1307  DropBlobIfExists(AH, oid);
1308 
1309  if (AH->connection)
1310  {
1311  if (old_blob_style)
1312  {
1313  loOid = lo_create(AH->connection, oid);
1314  if (loOid == 0 || loOid != oid)
1315  fatal("could not create large object %u: %s",
1316  oid, PQerrorMessage(AH->connection));
1317  }
1318  AH->loFd = lo_open(AH->connection, oid, INV_WRITE);
1319  if (AH->loFd == -1)
1320  fatal("could not open large object %u: %s",
1321  oid, PQerrorMessage(AH->connection));
1322  }
1323  else
1324  {
1325  if (old_blob_style)
1326  ahprintf(AH, "SELECT pg_catalog.lo_open(pg_catalog.lo_create('%u'), %d);\n",
1327  oid, INV_WRITE);
1328  else
1329  ahprintf(AH, "SELECT pg_catalog.lo_open('%u', %d);\n",
1330  oid, INV_WRITE);
1331  }
1332 
1333  AH->writingBlob = 1;
1334 }
1335 
1336 void
1338 {
1339  if (AH->lo_buf_used > 0)
1340  {
1341  /* Write remaining bytes from the LO buffer */
1342  dump_lo_buf(AH);
1343  }
1344 
1345  AH->writingBlob = 0;
1346 
1347  if (AH->connection)
1348  {
1349  lo_close(AH->connection, AH->loFd);
1350  AH->loFd = -1;
1351  }
1352  else
1353  {
1354  ahprintf(AH, "SELECT pg_catalog.lo_close(0);\n\n");
1355  }
1356 }
1357 
1358 /***********
1359  * Sorting and Reordering
1360  ***********/
1361 
1362 void
1364 {
1365  ArchiveHandle *AH = (ArchiveHandle *) AHX;
1366  RestoreOptions *ropt = AH->public.ropt;
1367  FILE *fh;
1368  StringInfoData linebuf;
1369 
1370  /* Allocate space for the 'wanted' array, and init it */
1371  ropt->idWanted = (bool *) pg_malloc0(sizeof(bool) * AH->maxDumpId);
1372 
1373  /* Setup the file */
1374  fh = fopen(ropt->tocFile, PG_BINARY_R);
1375  if (!fh)
1376  fatal("could not open TOC file \"%s\": %m", ropt->tocFile);
1377 
1378  initStringInfo(&linebuf);
1379 
1380  while (pg_get_line_buf(fh, &linebuf))
1381  {
1382  char *cmnt;
1383  char *endptr;
1384  DumpId id;
1385  TocEntry *te;
1386 
1387  /* Truncate line at comment, if any */
1388  cmnt = strchr(linebuf.data, ';');
1389  if (cmnt != NULL)
1390  {
1391  cmnt[0] = '\0';
1392  linebuf.len = cmnt - linebuf.data;
1393  }
1394 
1395  /* Ignore if all blank */
1396  if (strspn(linebuf.data, " \t\r\n") == linebuf.len)
1397  continue;
1398 
1399  /* Get an ID, check it's valid and not already seen */
1400  id = strtol(linebuf.data, &endptr, 10);
1401  if (endptr == linebuf.data || id <= 0 || id > AH->maxDumpId ||
1402  ropt->idWanted[id - 1])
1403  {
1404  pg_log_warning("line ignored: %s", linebuf.data);
1405  continue;
1406  }
1407 
1408  /* Find TOC entry */
1409  te = getTocEntryByDumpId(AH, id);
1410  if (!te)
1411  fatal("could not find entry for ID %d",
1412  id);
1413 
1414  /* Mark it wanted */
1415  ropt->idWanted[id - 1] = true;
1416 
1417  /*
1418  * Move each item to the end of the list as it is selected, so that
1419  * they are placed in the desired order. Any unwanted items will end
1420  * up at the front of the list, which may seem unintuitive but it's
1421  * what we need. In an ordinary serial restore that makes no
1422  * difference, but in a parallel restore we need to mark unrestored
1423  * items' dependencies as satisfied before we start examining
1424  * restorable items. Otherwise they could have surprising
1425  * side-effects on the order in which restorable items actually get
1426  * restored.
1427  */
1428  _moveBefore(AH->toc, te);
1429  }
1430 
1431  pg_free(linebuf.data);
1432 
1433  if (fclose(fh) != 0)
1434  fatal("could not close TOC file: %m");
1435 }
1436 
1437 /**********************
1438  * Convenience functions that look like standard IO functions
1439  * for writing data when in dump mode.
1440  **********************/
1441 
1442 /* Public */
1443 void
1444 archputs(const char *s, Archive *AH)
1445 {
1446  WriteData(AH, s, strlen(s));
1447 }
1448 
1449 /* Public */
1450 int
1451 archprintf(Archive *AH, const char *fmt,...)
1452 {
1453  int save_errno = errno;
1454  char *p;
1455  size_t len = 128; /* initial assumption about buffer size */
1456  size_t cnt;
1457 
1458  for (;;)
1459  {
1460  va_list args;
1461 
1462  /* Allocate work buffer. */
1463  p = (char *) pg_malloc(len);
1464 
1465  /* Try to format the data. */
1466  errno = save_errno;
1467  va_start(args, fmt);
1468  cnt = pvsnprintf(p, len, fmt, args);
1469  va_end(args);
1470 
1471  if (cnt < len)
1472  break; /* success */
1473 
1474  /* Release buffer and loop around to try again with larger len. */
1475  free(p);
1476  len = cnt;
1477  }
1478 
1479  WriteData(AH, p, cnt);
1480  free(p);
1481  return (int) cnt;
1482 }
1483 
1484 
1485 /*******************************
1486  * Stuff below here should be 'private' to the archiver routines
1487  *******************************/
1488 
1489 static void
1490 SetOutput(ArchiveHandle *AH, const char *filename, int compression)
1491 {
1492  int fn;
1493 
1494  if (filename)
1495  {
1496  if (strcmp(filename, "-") == 0)
1497  fn = fileno(stdout);
1498  else
1499  fn = -1;
1500  }
1501  else if (AH->FH)
1502  fn = fileno(AH->FH);
1503  else if (AH->fSpec)
1504  {
1505  fn = -1;
1506  filename = AH->fSpec;
1507  }
1508  else
1509  fn = fileno(stdout);
1510 
1511  /* If compression explicitly requested, use gzopen */
1512 #ifdef HAVE_LIBZ
1513  if (compression != 0)
1514  {
1515  char fmode[14];
1516 
1517  /* Don't use PG_BINARY_x since this is zlib */
1518  sprintf(fmode, "wb%d", compression);
1519  if (fn >= 0)
1520  AH->OF = gzdopen(dup(fn), fmode);
1521  else
1522  AH->OF = gzopen(filename, fmode);
1523  AH->gzOut = 1;
1524  }
1525  else
1526 #endif
1527  { /* Use fopen */
1528  if (AH->mode == archModeAppend)
1529  {
1530  if (fn >= 0)
1531  AH->OF = fdopen(dup(fn), PG_BINARY_A);
1532  else
1533  AH->OF = fopen(filename, PG_BINARY_A);
1534  }
1535  else
1536  {
1537  if (fn >= 0)
1538  AH->OF = fdopen(dup(fn), PG_BINARY_W);
1539  else
1540  AH->OF = fopen(filename, PG_BINARY_W);
1541  }
1542  AH->gzOut = 0;
1543  }
1544 
1545  if (!AH->OF)
1546  {
1547  if (filename)
1548  fatal("could not open output file \"%s\": %m", filename);
1549  else
1550  fatal("could not open output file: %m");
1551  }
1552 }
1553 
1554 static OutputContext
1556 {
1557  OutputContext sav;
1558 
1559  sav.OF = AH->OF;
1560  sav.gzOut = AH->gzOut;
1561 
1562  return sav;
1563 }
1564 
1565 static void
1567 {
1568  int res;
1569 
1570  if (AH->gzOut)
1571  res = GZCLOSE(AH->OF);
1572  else
1573  res = fclose(AH->OF);
1574 
1575  if (res != 0)
1576  fatal("could not close output file: %m");
1577 
1578  AH->gzOut = savedContext.gzOut;
1579  AH->OF = savedContext.OF;
1580 }
1581 
1582 
1583 
1584 /*
1585  * Print formatted text to the output file (usually stdout).
1586  */
1587 int
1588 ahprintf(ArchiveHandle *AH, const char *fmt,...)
1589 {
1590  int save_errno = errno;
1591  char *p;
1592  size_t len = 128; /* initial assumption about buffer size */
1593  size_t cnt;
1594 
1595  for (;;)
1596  {
1597  va_list args;
1598 
1599  /* Allocate work buffer. */
1600  p = (char *) pg_malloc(len);
1601 
1602  /* Try to format the data. */
1603  errno = save_errno;
1604  va_start(args, fmt);
1605  cnt = pvsnprintf(p, len, fmt, args);
1606  va_end(args);
1607 
1608  if (cnt < len)
1609  break; /* success */
1610 
1611  /* Release buffer and loop around to try again with larger len. */
1612  free(p);
1613  len = cnt;
1614  }
1615 
1616  ahwrite(p, 1, cnt, AH);
1617  free(p);
1618  return (int) cnt;
1619 }
1620 
1621 /*
1622  * Single place for logic which says 'We are restoring to a direct DB connection'.
1623  */
1624 static int
1626 {
1627  RestoreOptions *ropt = AH->public.ropt;
1628 
1629  return (ropt && ropt->useDB && AH->connection);
1630 }
1631 
1632 /*
1633  * Dump the current contents of the LO data buffer while writing a BLOB
1634  */
1635 static void
1637 {
1638  if (AH->connection)
1639  {
1640  size_t res;
1641 
1642  res = lo_write(AH->connection, AH->loFd, AH->lo_buf, AH->lo_buf_used);
1643  pg_log_debug(ngettext("wrote %lu byte of large object data (result = %lu)",
1644  "wrote %lu bytes of large object data (result = %lu)",
1645  AH->lo_buf_used),
1646  (unsigned long) AH->lo_buf_used, (unsigned long) res);
1647  if (res != AH->lo_buf_used)
1648  fatal("could not write to large object (result: %lu, expected: %lu)",
1649  (unsigned long) res, (unsigned long) AH->lo_buf_used);
1650  }
1651  else
1652  {
1654 
1656  (const unsigned char *) AH->lo_buf,
1657  AH->lo_buf_used,
1658  AH);
1659 
1660  /* Hack: turn off writingBlob so ahwrite doesn't recurse to here */
1661  AH->writingBlob = 0;
1662  ahprintf(AH, "SELECT pg_catalog.lowrite(0, %s);\n", buf->data);
1663  AH->writingBlob = 1;
1664 
1665  destroyPQExpBuffer(buf);
1666  }
1667  AH->lo_buf_used = 0;
1668 }
1669 
1670 
1671 /*
1672  * Write buffer to the output file (usually stdout). This is used for
1673  * outputting 'restore' scripts etc. It is even possible for an archive
1674  * format to create a custom output routine to 'fake' a restore if it
1675  * wants to generate a script (see TAR output).
1676  */
1677 void
1678 ahwrite(const void *ptr, size_t size, size_t nmemb, ArchiveHandle *AH)
1679 {
1680  int bytes_written = 0;
1681 
1682  if (AH->writingBlob)
1683  {
1684  size_t remaining = size * nmemb;
1685 
1686  while (AH->lo_buf_used + remaining > AH->lo_buf_size)
1687  {
1688  size_t avail = AH->lo_buf_size - AH->lo_buf_used;
1689 
1690  memcpy((char *) AH->lo_buf + AH->lo_buf_used, ptr, avail);
1691  ptr = (const void *) ((const char *) ptr + avail);
1692  remaining -= avail;
1693  AH->lo_buf_used += avail;
1694  dump_lo_buf(AH);
1695  }
1696 
1697  memcpy((char *) AH->lo_buf + AH->lo_buf_used, ptr, remaining);
1698  AH->lo_buf_used += remaining;
1699 
1700  bytes_written = size * nmemb;
1701  }
1702  else if (AH->gzOut)
1703  bytes_written = GZWRITE(ptr, size, nmemb, AH->OF);
1704  else if (AH->CustomOutPtr)
1705  bytes_written = AH->CustomOutPtr(AH, ptr, size * nmemb);
1706 
1707  else
1708  {
1709  /*
1710  * If we're doing a restore, and it's direct to DB, and we're
1711  * connected then send it to the DB.
1712  */
1713  if (RestoringToDB(AH))
1714  bytes_written = ExecuteSqlCommandBuf(&AH->public, (const char *) ptr, size * nmemb);
1715  else
1716  bytes_written = fwrite(ptr, size, nmemb, AH->OF) * size;
1717  }
1718 
1719  if (bytes_written != size * nmemb)
1721 }
1722 
1723 /* on some error, we may decide to go on... */
1724 void
1725 warn_or_exit_horribly(ArchiveHandle *AH, const char *fmt,...)
1726 {
1727  va_list ap;
1728 
1729  switch (AH->stage)
1730  {
1731 
1732  case STAGE_NONE:
1733  /* Do nothing special */
1734  break;
1735 
1736  case STAGE_INITIALIZING:
1737  if (AH->stage != AH->lastErrorStage)
1738  pg_log_generic(PG_LOG_INFO, "while INITIALIZING:");
1739  break;
1740 
1741  case STAGE_PROCESSING:
1742  if (AH->stage != AH->lastErrorStage)
1743  pg_log_generic(PG_LOG_INFO, "while PROCESSING TOC:");
1744  break;
1745 
1746  case STAGE_FINALIZING:
1747  if (AH->stage != AH->lastErrorStage)
1748  pg_log_generic(PG_LOG_INFO, "while FINALIZING:");
1749  break;
1750  }
1751  if (AH->currentTE != NULL && AH->currentTE != AH->lastErrorTE)
1752  {
1753  pg_log_generic(PG_LOG_INFO, "from TOC entry %d; %u %u %s %s %s",
1754  AH->currentTE->dumpId,
1756  AH->currentTE->catalogId.oid,
1757  AH->currentTE->desc ? AH->currentTE->desc : "(no desc)",
1758  AH->currentTE->tag ? AH->currentTE->tag : "(no tag)",
1759  AH->currentTE->owner ? AH->currentTE->owner : "(no owner)");
1760  }
1761  AH->lastErrorStage = AH->stage;
1762  AH->lastErrorTE = AH->currentTE;
1763 
1764  va_start(ap, fmt);
1765  pg_log_generic_v(PG_LOG_ERROR, fmt, ap);
1766  va_end(ap);
1767 
1768  if (AH->public.exit_on_error)
1769  exit_nicely(1);
1770  else
1771  AH->public.n_errors++;
1772 }
1773 
1774 #ifdef NOT_USED
1775 
1776 static void
1777 _moveAfter(ArchiveHandle *AH, TocEntry *pos, TocEntry *te)
1778 {
1779  /* Unlink te from list */
1780  te->prev->next = te->next;
1781  te->next->prev = te->prev;
1782 
1783  /* and insert it after "pos" */
1784  te->prev = pos;
1785  te->next = pos->next;
1786  pos->next->prev = te;
1787  pos->next = te;
1788 }
1789 #endif
1790 
1791 static void
1793 {
1794  /* Unlink te from list */
1795  te->prev->next = te->next;
1796  te->next->prev = te->prev;
1797 
1798  /* and insert it before "pos" */
1799  te->prev = pos->prev;
1800  te->next = pos;
1801  pos->prev->next = te;
1802  pos->prev = te;
1803 }
1804 
1805 /*
1806  * Build index arrays for the TOC list
1807  *
1808  * This should be invoked only after we have created or read in all the TOC
1809  * items.
1810  *
1811  * The arrays are indexed by dump ID (so entry zero is unused). Note that the
1812  * array entries run only up to maxDumpId. We might see dependency dump IDs
1813  * beyond that (if the dump was partial); so always check the array bound
1814  * before trying to touch an array entry.
1815  */
1816 static void
1818 {
1819  DumpId maxDumpId = AH->maxDumpId;
1820  TocEntry *te;
1821 
1822  AH->tocsByDumpId = (TocEntry **) pg_malloc0((maxDumpId + 1) * sizeof(TocEntry *));
1823  AH->tableDataId = (DumpId *) pg_malloc0((maxDumpId + 1) * sizeof(DumpId));
1824 
1825  for (te = AH->toc->next; te != AH->toc; te = te->next)
1826  {
1827  /* this check is purely paranoia, maxDumpId should be correct */
1828  if (te->dumpId <= 0 || te->dumpId > maxDumpId)
1829  fatal("bad dumpId");
1830 
1831  /* tocsByDumpId indexes all TOCs by their dump ID */
1832  AH->tocsByDumpId[te->dumpId] = te;
1833 
1834  /*
1835  * tableDataId provides the TABLE DATA item's dump ID for each TABLE
1836  * TOC entry that has a DATA item. We compute this by reversing the
1837  * TABLE DATA item's dependency, knowing that a TABLE DATA item has
1838  * just one dependency and it is the TABLE item.
1839  */
1840  if (strcmp(te->desc, "TABLE DATA") == 0 && te->nDeps > 0)
1841  {
1842  DumpId tableId = te->dependencies[0];
1843 
1844  /*
1845  * The TABLE item might not have been in the archive, if this was
1846  * a data-only dump; but its dump ID should be less than its data
1847  * item's dump ID, so there should be a place for it in the array.
1848  */
1849  if (tableId <= 0 || tableId > maxDumpId)
1850  fatal("bad table dumpId for TABLE DATA item");
1851 
1852  AH->tableDataId[tableId] = te->dumpId;
1853  }
1854  }
1855 }
1856 
1857 TocEntry *
1859 {
1860  /* build index arrays if we didn't already */
1861  if (AH->tocsByDumpId == NULL)
1862  buildTocEntryArrays(AH);
1863 
1864  if (id > 0 && id <= AH->maxDumpId)
1865  return AH->tocsByDumpId[id];
1866 
1867  return NULL;
1868 }
1869 
1870 teReqs
1872 {
1873  TocEntry *te = getTocEntryByDumpId(AH, id);
1874 
1875  if (!te)
1876  return 0;
1877 
1878  return te->reqs;
1879 }
1880 
1881 size_t
1882 WriteOffset(ArchiveHandle *AH, pgoff_t o, int wasSet)
1883 {
1884  int off;
1885 
1886  /* Save the flag */
1887  AH->WriteBytePtr(AH, wasSet);
1888 
1889  /* Write out pgoff_t smallest byte first, prevents endian mismatch */
1890  for (off = 0; off < sizeof(pgoff_t); off++)
1891  {
1892  AH->WriteBytePtr(AH, o & 0xFF);
1893  o >>= 8;
1894  }
1895  return sizeof(pgoff_t) + 1;
1896 }
1897 
1898 int
1900 {
1901  int i;
1902  int off;
1903  int offsetFlg;
1904 
1905  /* Initialize to zero */
1906  *o = 0;
1907 
1908  /* Check for old version */
1909  if (AH->version < K_VERS_1_7)
1910  {
1911  /* Prior versions wrote offsets using WriteInt */
1912  i = ReadInt(AH);
1913  /* -1 means not set */
1914  if (i < 0)
1915  return K_OFFSET_POS_NOT_SET;
1916  else if (i == 0)
1917  return K_OFFSET_NO_DATA;
1918 
1919  /* Cast to pgoff_t because it was written as an int. */
1920  *o = (pgoff_t) i;
1921  return K_OFFSET_POS_SET;
1922  }
1923 
1924  /*
1925  * Read the flag indicating the state of the data pointer. Check if valid
1926  * and die if not.
1927  *
1928  * This used to be handled by a negative or zero pointer, now we use an
1929  * extra byte specifically for the state.
1930  */
1931  offsetFlg = AH->ReadBytePtr(AH) & 0xFF;
1932 
1933  switch (offsetFlg)
1934  {
1935  case K_OFFSET_POS_NOT_SET:
1936  case K_OFFSET_NO_DATA:
1937  case K_OFFSET_POS_SET:
1938 
1939  break;
1940 
1941  default:
1942  fatal("unexpected data offset flag %d", offsetFlg);
1943  }
1944 
1945  /*
1946  * Read the bytes
1947  */
1948  for (off = 0; off < AH->offSize; off++)
1949  {
1950  if (off < sizeof(pgoff_t))
1951  *o |= ((pgoff_t) (AH->ReadBytePtr(AH))) << (off * 8);
1952  else
1953  {
1954  if (AH->ReadBytePtr(AH) != 0)
1955  fatal("file offset in dump file is too large");
1956  }
1957  }
1958 
1959  return offsetFlg;
1960 }
1961 
1962 size_t
1964 {
1965  int b;
1966 
1967  /*
1968  * This is a bit yucky, but I don't want to make the binary format very
1969  * dependent on representation, and not knowing much about it, I write out
1970  * a sign byte. If you change this, don't forget to change the file
1971  * version #, and modify ReadInt to read the new format AS WELL AS the old
1972  * formats.
1973  */
1974 
1975  /* SIGN byte */
1976  if (i < 0)
1977  {
1978  AH->WriteBytePtr(AH, 1);
1979  i = -i;
1980  }
1981  else
1982  AH->WriteBytePtr(AH, 0);
1983 
1984  for (b = 0; b < AH->intSize; b++)
1985  {
1986  AH->WriteBytePtr(AH, i & 0xFF);
1987  i >>= 8;
1988  }
1989 
1990  return AH->intSize + 1;
1991 }
1992 
1993 int
1995 {
1996  int res = 0;
1997  int bv,
1998  b;
1999  int sign = 0; /* Default positive */
2000  int bitShift = 0;
2001 
2002  if (AH->version > K_VERS_1_0)
2003  /* Read a sign byte */
2004  sign = AH->ReadBytePtr(AH);
2005 
2006  for (b = 0; b < AH->intSize; b++)
2007  {
2008  bv = AH->ReadBytePtr(AH) & 0xFF;
2009  if (bv != 0)
2010  res = res + (bv << bitShift);
2011  bitShift += 8;
2012  }
2013 
2014  if (sign)
2015  res = -res;
2016 
2017  return res;
2018 }
2019 
2020 size_t
2021 WriteStr(ArchiveHandle *AH, const char *c)
2022 {
2023  size_t res;
2024 
2025  if (c)
2026  {
2027  int len = strlen(c);
2028 
2029  res = WriteInt(AH, len);
2030  AH->WriteBufPtr(AH, c, len);
2031  res += len;
2032  }
2033  else
2034  res = WriteInt(AH, -1);
2035 
2036  return res;
2037 }
2038 
2039 char *
2041 {
2042  char *buf;
2043  int l;
2044 
2045  l = ReadInt(AH);
2046  if (l < 0)
2047  buf = NULL;
2048  else
2049  {
2050  buf = (char *) pg_malloc(l + 1);
2051  AH->ReadBufPtr(AH, (void *) buf, l);
2052 
2053  buf[l] = '\0';
2054  }
2055 
2056  return buf;
2057 }
2058 
2059 static int
2061 {
2062  FILE *fh;
2063  char sig[6]; /* More than enough */
2064  size_t cnt;
2065  int wantClose = 0;
2066 
2067  pg_log_debug("attempting to ascertain archive format");
2068 
2069  if (AH->lookahead)
2070  free(AH->lookahead);
2071 
2072  AH->lookaheadSize = 512;
2073  AH->lookahead = pg_malloc0(512);
2074  AH->lookaheadLen = 0;
2075  AH->lookaheadPos = 0;
2076 
2077  if (AH->fSpec)
2078  {
2079  struct stat st;
2080 
2081  wantClose = 1;
2082 
2083  /*
2084  * Check if the specified archive is a directory. If so, check if
2085  * there's a "toc.dat" (or "toc.dat.gz") file in it.
2086  */
2087  if (stat(AH->fSpec, &st) == 0 && S_ISDIR(st.st_mode))
2088  {
2089  char buf[MAXPGPATH];
2090 
2091  if (snprintf(buf, MAXPGPATH, "%s/toc.dat", AH->fSpec) >= MAXPGPATH)
2092  fatal("directory name too long: \"%s\"",
2093  AH->fSpec);
2094  if (stat(buf, &st) == 0 && S_ISREG(st.st_mode))
2095  {
2096  AH->format = archDirectory;
2097  return AH->format;
2098  }
2099 
2100 #ifdef HAVE_LIBZ
2101  if (snprintf(buf, MAXPGPATH, "%s/toc.dat.gz", AH->fSpec) >= MAXPGPATH)
2102  fatal("directory name too long: \"%s\"",
2103  AH->fSpec);
2104  if (stat(buf, &st) == 0 && S_ISREG(st.st_mode))
2105  {
2106  AH->format = archDirectory;
2107  return AH->format;
2108  }
2109 #endif
2110  fatal("directory \"%s\" does not appear to be a valid archive (\"toc.dat\" does not exist)",
2111  AH->fSpec);
2112  fh = NULL; /* keep compiler quiet */
2113  }
2114  else
2115  {
2116  fh = fopen(AH->fSpec, PG_BINARY_R);
2117  if (!fh)
2118  fatal("could not open input file \"%s\": %m", AH->fSpec);
2119  }
2120  }
2121  else
2122  {
2123  fh = stdin;
2124  if (!fh)
2125  fatal("could not open input file: %m");
2126  }
2127 
2128  if ((cnt = fread(sig, 1, 5, fh)) != 5)
2129  {
2130  if (ferror(fh))
2131  fatal("could not read input file: %m");
2132  else
2133  fatal("input file is too short (read %lu, expected 5)",
2134  (unsigned long) cnt);
2135  }
2136 
2137  /* Save it, just in case we need it later */
2138  memcpy(&AH->lookahead[0], sig, 5);
2139  AH->lookaheadLen = 5;
2140 
2141  if (strncmp(sig, "PGDMP", 5) == 0)
2142  {
2143  int byteread;
2144  char vmaj,
2145  vmin,
2146  vrev;
2147 
2148  /*
2149  * Finish reading (most of) a custom-format header.
2150  *
2151  * NB: this code must agree with ReadHead().
2152  */
2153  if ((byteread = fgetc(fh)) == EOF)
2154  READ_ERROR_EXIT(fh);
2155 
2156  vmaj = byteread;
2157 
2158  if ((byteread = fgetc(fh)) == EOF)
2159  READ_ERROR_EXIT(fh);
2160 
2161  vmin = byteread;
2162 
2163  /* Save these too... */
2164  AH->lookahead[AH->lookaheadLen++] = vmaj;
2165  AH->lookahead[AH->lookaheadLen++] = vmin;
2166 
2167  /* Check header version; varies from V1.0 */
2168  if (vmaj > 1 || (vmaj == 1 && vmin > 0)) /* Version > 1.0 */
2169  {
2170  if ((byteread = fgetc(fh)) == EOF)
2171  READ_ERROR_EXIT(fh);
2172 
2173  vrev = byteread;
2174  AH->lookahead[AH->lookaheadLen++] = vrev;
2175  }
2176  else
2177  vrev = 0;
2178 
2179  AH->version = MAKE_ARCHIVE_VERSION(vmaj, vmin, vrev);
2180 
2181  if ((AH->intSize = fgetc(fh)) == EOF)
2182  READ_ERROR_EXIT(fh);
2183  AH->lookahead[AH->lookaheadLen++] = AH->intSize;
2184 
2185  if (AH->version >= K_VERS_1_7)
2186  {
2187  if ((AH->offSize = fgetc(fh)) == EOF)
2188  READ_ERROR_EXIT(fh);
2189  AH->lookahead[AH->lookaheadLen++] = AH->offSize;
2190  }
2191  else
2192  AH->offSize = AH->intSize;
2193 
2194  if ((byteread = fgetc(fh)) == EOF)
2195  READ_ERROR_EXIT(fh);
2196 
2197  AH->format = byteread;
2198  AH->lookahead[AH->lookaheadLen++] = AH->format;
2199  }
2200  else
2201  {
2202  /*
2203  * *Maybe* we have a tar archive format file or a text dump ... So,
2204  * read first 512 byte header...
2205  */
2206  cnt = fread(&AH->lookahead[AH->lookaheadLen], 1, 512 - AH->lookaheadLen, fh);
2207  /* read failure is checked below */
2208  AH->lookaheadLen += cnt;
2209 
2210  if (AH->lookaheadLen >= strlen(TEXT_DUMPALL_HEADER) &&
2211  (strncmp(AH->lookahead, TEXT_DUMP_HEADER, strlen(TEXT_DUMP_HEADER)) == 0 ||
2212  strncmp(AH->lookahead, TEXT_DUMPALL_HEADER, strlen(TEXT_DUMPALL_HEADER)) == 0))
2213  {
2214  /*
2215  * looks like it's probably a text format dump. so suggest they
2216  * try psql
2217  */
2218  fatal("input file appears to be a text format dump. Please use psql.");
2219  }
2220 
2221  if (AH->lookaheadLen != 512)
2222  {
2223  if (feof(fh))
2224  fatal("input file does not appear to be a valid archive (too short?)");
2225  else
2226  READ_ERROR_EXIT(fh);
2227  }
2228 
2229  if (!isValidTarHeader(AH->lookahead))
2230  fatal("input file does not appear to be a valid archive");
2231 
2232  AH->format = archTar;
2233  }
2234 
2235  /* If we can't seek, then mark the header as read */
2236  if (fseeko(fh, 0, SEEK_SET) != 0)
2237  {
2238  /*
2239  * NOTE: Formats that use the lookahead buffer can unset this in their
2240  * Init routine.
2241  */
2242  AH->readHeader = 1;
2243  }
2244  else
2245  AH->lookaheadLen = 0; /* Don't bother since we've reset the file */
2246 
2247  /* Close the file */
2248  if (wantClose)
2249  if (fclose(fh) != 0)
2250  fatal("could not close input file: %m");
2251 
2252  return AH->format;
2253 }
2254 
2255 
2256 /*
2257  * Allocate an archive handle
2258  */
2259 static ArchiveHandle *
2260 _allocAH(const char *FileSpec, const ArchiveFormat fmt,
2261  const int compression, bool dosync, ArchiveMode mode,
2262  SetupWorkerPtrType setupWorkerPtr)
2263 {
2264  ArchiveHandle *AH;
2265 
2266  pg_log_debug("allocating AH for %s, format %d",
2267  FileSpec ? FileSpec : "(stdio)", fmt);
2268 
2269  AH = (ArchiveHandle *) pg_malloc0(sizeof(ArchiveHandle));
2270 
2271  AH->version = K_VERS_SELF;
2272 
2273  /* initialize for backwards compatible string processing */
2274  AH->public.encoding = 0; /* PG_SQL_ASCII */
2275  AH->public.std_strings = false;
2276 
2277  /* sql error handling */
2278  AH->public.exit_on_error = true;
2279  AH->public.n_errors = 0;
2280 
2281  AH->archiveDumpVersion = PG_VERSION;
2282 
2283  AH->createDate = time(NULL);
2284 
2285  AH->intSize = sizeof(int);
2286  AH->offSize = sizeof(pgoff_t);
2287  if (FileSpec)
2288  {
2289  AH->fSpec = pg_strdup(FileSpec);
2290 
2291  /*
2292  * Not used; maybe later....
2293  *
2294  * AH->workDir = pg_strdup(FileSpec); for(i=strlen(FileSpec) ; i > 0 ;
2295  * i--) if (AH->workDir[i-1] == '/')
2296  */
2297  }
2298  else
2299  AH->fSpec = NULL;
2300 
2301  AH->currUser = NULL; /* unknown */
2302  AH->currSchema = NULL; /* ditto */
2303  AH->currTablespace = NULL; /* ditto */
2304  AH->currTableAm = NULL; /* ditto */
2305 
2306  AH->toc = (TocEntry *) pg_malloc0(sizeof(TocEntry));
2307 
2308  AH->toc->next = AH->toc;
2309  AH->toc->prev = AH->toc;
2310 
2311  AH->mode = mode;
2312  AH->compression = compression;
2313  AH->dosync = dosync;
2314 
2315  memset(&(AH->sqlparse), 0, sizeof(AH->sqlparse));
2316 
2317  /* Open stdout with no compression for AH output handle */
2318  AH->gzOut = 0;
2319  AH->OF = stdout;
2320 
2321  /*
2322  * On Windows, we need to use binary mode to read/write non-text files,
2323  * which include all archive formats as well as compressed plain text.
2324  * Force stdin/stdout into binary mode if that is what we are using.
2325  */
2326 #ifdef WIN32
2327  if ((fmt != archNull || compression != 0) &&
2328  (AH->fSpec == NULL || strcmp(AH->fSpec, "") == 0))
2329  {
2330  if (mode == archModeWrite)
2331  _setmode(fileno(stdout), O_BINARY);
2332  else
2333  _setmode(fileno(stdin), O_BINARY);
2334  }
2335 #endif
2336 
2337  AH->SetupWorkerPtr = setupWorkerPtr;
2338 
2339  if (fmt == archUnknown)
2340  AH->format = _discoverArchiveFormat(AH);
2341  else
2342  AH->format = fmt;
2343 
2344  switch (AH->format)
2345  {
2346  case archCustom:
2348  break;
2349 
2350  case archNull:
2351  InitArchiveFmt_Null(AH);
2352  break;
2353 
2354  case archDirectory:
2356  break;
2357 
2358  case archTar:
2359  InitArchiveFmt_Tar(AH);
2360  break;
2361 
2362  default:
2363  fatal("unrecognized file format \"%d\"", fmt);
2364  }
2365 
2366  return AH;
2367 }
2368 
2369 /*
2370  * Write out all data (tables & blobs)
2371  */
2372 void
2374 {
2375  TocEntry *te;
2376 
2377  if (pstate && pstate->numWorkers > 1)
2378  {
2379  /*
2380  * In parallel mode, this code runs in the leader process. We
2381  * construct an array of candidate TEs, then sort it into decreasing
2382  * size order, then dispatch each TE to a data-transfer worker. By
2383  * dumping larger tables first, we avoid getting into a situation
2384  * where we're down to one job and it's big, losing parallelism.
2385  */
2386  TocEntry **tes;
2387  int ntes;
2388 
2389  tes = (TocEntry **) pg_malloc(AH->tocCount * sizeof(TocEntry *));
2390  ntes = 0;
2391  for (te = AH->toc->next; te != AH->toc; te = te->next)
2392  {
2393  /* Consider only TEs with dataDumper functions ... */
2394  if (!te->dataDumper)
2395  continue;
2396  /* ... and ignore ones not enabled for dump */
2397  if ((te->reqs & REQ_DATA) == 0)
2398  continue;
2399 
2400  tes[ntes++] = te;
2401  }
2402 
2403  if (ntes > 1)
2404  qsort((void *) tes, ntes, sizeof(TocEntry *),
2406 
2407  for (int i = 0; i < ntes; i++)
2408  DispatchJobForTocEntry(AH, pstate, tes[i], ACT_DUMP,
2409  mark_dump_job_done, NULL);
2410 
2411  pg_free(tes);
2412 
2413  /* Now wait for workers to finish. */
2414  WaitForWorkers(AH, pstate, WFW_ALL_IDLE);
2415  }
2416  else
2417  {
2418  /* Non-parallel mode: just dump all candidate TEs sequentially. */
2419  for (te = AH->toc->next; te != AH->toc; te = te->next)
2420  {
2421  /* Must have same filter conditions as above */
2422  if (!te->dataDumper)
2423  continue;
2424  if ((te->reqs & REQ_DATA) == 0)
2425  continue;
2426 
2428  }
2429  }
2430 }
2431 
2432 
2433 /*
2434  * Callback function that's invoked in the leader process after a step has
2435  * been parallel dumped.
2436  *
2437  * We don't need to do anything except check for worker failure.
2438  */
2439 static void
2441  TocEntry *te,
2442  int status,
2443  void *callback_data)
2444 {
2445  pg_log_info("finished item %d %s %s",
2446  te->dumpId, te->desc, te->tag);
2447 
2448  if (status != 0)
2449  fatal("worker process failed: exit code %d",
2450  status);
2451 }
2452 
2453 
2454 void
2456 {
2457  StartDataPtrType startPtr;
2458  EndDataPtrType endPtr;
2459 
2460  AH->currToc = te;
2461 
2462  if (strcmp(te->desc, "BLOBS") == 0)
2463  {
2464  startPtr = AH->StartBlobsPtr;
2465  endPtr = AH->EndBlobsPtr;
2466  }
2467  else
2468  {
2469  startPtr = AH->StartDataPtr;
2470  endPtr = AH->EndDataPtr;
2471  }
2472 
2473  if (startPtr != NULL)
2474  (*startPtr) (AH, te);
2475 
2476  /*
2477  * The user-provided DataDumper routine needs to call AH->WriteData
2478  */
2479  te->dataDumper((Archive *) AH, te->dataDumperArg);
2480 
2481  if (endPtr != NULL)
2482  (*endPtr) (AH, te);
2483 
2484  AH->currToc = NULL;
2485 }
2486 
2487 void
2489 {
2490  TocEntry *te;
2491  char workbuf[32];
2492  int tocCount;
2493  int i;
2494 
2495  /* count entries that will actually be dumped */
2496  tocCount = 0;
2497  for (te = AH->toc->next; te != AH->toc; te = te->next)
2498  {
2499  if ((te->reqs & (REQ_SCHEMA | REQ_DATA | REQ_SPECIAL)) != 0)
2500  tocCount++;
2501  }
2502 
2503  /* printf("%d TOC Entries to save\n", tocCount); */
2504 
2505  WriteInt(AH, tocCount);
2506 
2507  for (te = AH->toc->next; te != AH->toc; te = te->next)
2508  {
2509  if ((te->reqs & (REQ_SCHEMA | REQ_DATA | REQ_SPECIAL)) == 0)
2510  continue;
2511 
2512  WriteInt(AH, te->dumpId);
2513  WriteInt(AH, te->dataDumper ? 1 : 0);
2514 
2515  /* OID is recorded as a string for historical reasons */
2516  sprintf(workbuf, "%u", te->catalogId.tableoid);
2517  WriteStr(AH, workbuf);
2518  sprintf(workbuf, "%u", te->catalogId.oid);
2519  WriteStr(AH, workbuf);
2520 
2521  WriteStr(AH, te->tag);
2522  WriteStr(AH, te->desc);
2523  WriteInt(AH, te->section);
2524  WriteStr(AH, te->defn);
2525  WriteStr(AH, te->dropStmt);
2526  WriteStr(AH, te->copyStmt);
2527  WriteStr(AH, te->namespace);
2528  WriteStr(AH, te->tablespace);
2529  WriteStr(AH, te->tableam);
2530  WriteStr(AH, te->owner);
2531  WriteStr(AH, "false");
2532 
2533  /* Dump list of dependencies */
2534  for (i = 0; i < te->nDeps; i++)
2535  {
2536  sprintf(workbuf, "%d", te->dependencies[i]);
2537  WriteStr(AH, workbuf);
2538  }
2539  WriteStr(AH, NULL); /* Terminate List */
2540 
2541  if (AH->WriteExtraTocPtr)
2542  AH->WriteExtraTocPtr(AH, te);
2543  }
2544 }
2545 
2546 void
2548 {
2549  int i;
2550  char *tmp;
2551  DumpId *deps;
2552  int depIdx;
2553  int depSize;
2554  TocEntry *te;
2555 
2556  AH->tocCount = ReadInt(AH);
2557  AH->maxDumpId = 0;
2558 
2559  for (i = 0; i < AH->tocCount; i++)
2560  {
2561  te = (TocEntry *) pg_malloc0(sizeof(TocEntry));
2562  te->dumpId = ReadInt(AH);
2563 
2564  if (te->dumpId > AH->maxDumpId)
2565  AH->maxDumpId = te->dumpId;
2566 
2567  /* Sanity check */
2568  if (te->dumpId <= 0)
2569  fatal("entry ID %d out of range -- perhaps a corrupt TOC",
2570  te->dumpId);
2571 
2572  te->hadDumper = ReadInt(AH);
2573 
2574  if (AH->version >= K_VERS_1_8)
2575  {
2576  tmp = ReadStr(AH);
2577  sscanf(tmp, "%u", &te->catalogId.tableoid);
2578  free(tmp);
2579  }
2580  else
2582  tmp = ReadStr(AH);
2583  sscanf(tmp, "%u", &te->catalogId.oid);
2584  free(tmp);
2585 
2586  te->tag = ReadStr(AH);
2587  te->desc = ReadStr(AH);
2588 
2589  if (AH->version >= K_VERS_1_11)
2590  {
2591  te->section = ReadInt(AH);
2592  }
2593  else
2594  {
2595  /*
2596  * Rules for pre-8.4 archives wherein pg_dump hasn't classified
2597  * the entries into sections. This list need not cover entry
2598  * types added later than 8.4.
2599  */
2600  if (strcmp(te->desc, "COMMENT") == 0 ||
2601  strcmp(te->desc, "ACL") == 0 ||
2602  strcmp(te->desc, "ACL LANGUAGE") == 0)
2603  te->section = SECTION_NONE;
2604  else if (strcmp(te->desc, "TABLE DATA") == 0 ||
2605  strcmp(te->desc, "BLOBS") == 0 ||
2606  strcmp(te->desc, "BLOB COMMENTS") == 0)
2607  te->section = SECTION_DATA;
2608  else if (strcmp(te->desc, "CONSTRAINT") == 0 ||
2609  strcmp(te->desc, "CHECK CONSTRAINT") == 0 ||
2610  strcmp(te->desc, "FK CONSTRAINT") == 0 ||
2611  strcmp(te->desc, "INDEX") == 0 ||
2612  strcmp(te->desc, "RULE") == 0 ||
2613  strcmp(te->desc, "TRIGGER") == 0)
2614  te->section = SECTION_POST_DATA;
2615  else
2616  te->section = SECTION_PRE_DATA;
2617  }
2618 
2619  te->defn = ReadStr(AH);
2620  te->dropStmt = ReadStr(AH);
2621 
2622  if (AH->version >= K_VERS_1_3)
2623  te->copyStmt = ReadStr(AH);
2624 
2625  if (AH->version >= K_VERS_1_6)
2626  te->namespace = ReadStr(AH);
2627 
2628  if (AH->version >= K_VERS_1_10)
2629  te->tablespace = ReadStr(AH);
2630 
2631  if (AH->version >= K_VERS_1_14)
2632  te->tableam = ReadStr(AH);
2633 
2634  te->owner = ReadStr(AH);
2635  if (AH->version < K_VERS_1_9 || strcmp(ReadStr(AH), "true") == 0)
2636  pg_log_warning("restoring tables WITH OIDS is not supported anymore");
2637 
2638  /* Read TOC entry dependencies */
2639  if (AH->version >= K_VERS_1_5)
2640  {
2641  depSize = 100;
2642  deps = (DumpId *) pg_malloc(sizeof(DumpId) * depSize);
2643  depIdx = 0;
2644  for (;;)
2645  {
2646  tmp = ReadStr(AH);
2647  if (!tmp)
2648  break; /* end of list */
2649  if (depIdx >= depSize)
2650  {
2651  depSize *= 2;
2652  deps = (DumpId *) pg_realloc(deps, sizeof(DumpId) * depSize);
2653  }
2654  sscanf(tmp, "%d", &deps[depIdx]);
2655  free(tmp);
2656  depIdx++;
2657  }
2658 
2659  if (depIdx > 0) /* We have a non-null entry */
2660  {
2661  deps = (DumpId *) pg_realloc(deps, sizeof(DumpId) * depIdx);
2662  te->dependencies = deps;
2663  te->nDeps = depIdx;
2664  }
2665  else
2666  {
2667  free(deps);
2668  te->dependencies = NULL;
2669  te->nDeps = 0;
2670  }
2671  }
2672  else
2673  {
2674  te->dependencies = NULL;
2675  te->nDeps = 0;
2676  }
2677  te->dataLength = 0;
2678 
2679  if (AH->ReadExtraTocPtr)
2680  AH->ReadExtraTocPtr(AH, te);
2681 
2682  pg_log_debug("read TOC entry %d (ID %d) for %s %s",
2683  i, te->dumpId, te->desc, te->tag);
2684 
2685  /* link completed entry into TOC circular list */
2686  te->prev = AH->toc->prev;
2687  AH->toc->prev->next = te;
2688  AH->toc->prev = te;
2689  te->next = AH->toc;
2690 
2691  /* special processing immediately upon read for some items */
2692  if (strcmp(te->desc, "ENCODING") == 0)
2693  processEncodingEntry(AH, te);
2694  else if (strcmp(te->desc, "STDSTRINGS") == 0)
2695  processStdStringsEntry(AH, te);
2696  else if (strcmp(te->desc, "SEARCHPATH") == 0)
2697  processSearchPathEntry(AH, te);
2698  }
2699 }
2700 
2701 static void
2703 {
2704  /* te->defn should have the form SET client_encoding = 'foo'; */
2705  char *defn = pg_strdup(te->defn);
2706  char *ptr1;
2707  char *ptr2 = NULL;
2708  int encoding;
2709 
2710  ptr1 = strchr(defn, '\'');
2711  if (ptr1)
2712  ptr2 = strchr(++ptr1, '\'');
2713  if (ptr2)
2714  {
2715  *ptr2 = '\0';
2716  encoding = pg_char_to_encoding(ptr1);
2717  if (encoding < 0)
2718  fatal("unrecognized encoding \"%s\"",
2719  ptr1);
2720  AH->public.encoding = encoding;
2721  }
2722  else
2723  fatal("invalid ENCODING item: %s",
2724  te->defn);
2725 
2726  free(defn);
2727 }
2728 
2729 static void
2731 {
2732  /* te->defn should have the form SET standard_conforming_strings = 'x'; */
2733  char *ptr1;
2734 
2735  ptr1 = strchr(te->defn, '\'');
2736  if (ptr1 && strncmp(ptr1, "'on'", 4) == 0)
2737  AH->public.std_strings = true;
2738  else if (ptr1 && strncmp(ptr1, "'off'", 5) == 0)
2739  AH->public.std_strings = false;
2740  else
2741  fatal("invalid STDSTRINGS item: %s",
2742  te->defn);
2743 }
2744 
2745 static void
2747 {
2748  /*
2749  * te->defn should contain a command to set search_path. We just copy it
2750  * verbatim for use later.
2751  */
2752  AH->public.searchpath = pg_strdup(te->defn);
2753 }
2754 
2755 static void
2757 {
2758  const char *missing_name;
2759 
2760  Assert(ropt->strict_names);
2761 
2762  if (ropt->schemaNames.head != NULL)
2763  {
2764  missing_name = simple_string_list_not_touched(&ropt->schemaNames);
2765  if (missing_name != NULL)
2766  fatal("schema \"%s\" not found", missing_name);
2767  }
2768 
2769  if (ropt->tableNames.head != NULL)
2770  {
2771  missing_name = simple_string_list_not_touched(&ropt->tableNames);
2772  if (missing_name != NULL)
2773  fatal("table \"%s\" not found", missing_name);
2774  }
2775 
2776  if (ropt->indexNames.head != NULL)
2777  {
2778  missing_name = simple_string_list_not_touched(&ropt->indexNames);
2779  if (missing_name != NULL)
2780  fatal("index \"%s\" not found", missing_name);
2781  }
2782 
2783  if (ropt->functionNames.head != NULL)
2784  {
2785  missing_name = simple_string_list_not_touched(&ropt->functionNames);
2786  if (missing_name != NULL)
2787  fatal("function \"%s\" not found", missing_name);
2788  }
2789 
2790  if (ropt->triggerNames.head != NULL)
2791  {
2792  missing_name = simple_string_list_not_touched(&ropt->triggerNames);
2793  if (missing_name != NULL)
2794  fatal("trigger \"%s\" not found", missing_name);
2795  }
2796 }
2797 
2798 /*
2799  * Determine whether we want to restore this TOC entry.
2800  *
2801  * Returns 0 if entry should be skipped, or some combination of the
2802  * REQ_SCHEMA and REQ_DATA bits if we want to restore schema and/or data
2803  * portions of this TOC entry, or REQ_SPECIAL if it's a special entry.
2804  */
2805 static teReqs
2807 {
2808  teReqs res = REQ_SCHEMA | REQ_DATA;
2809  RestoreOptions *ropt = AH->public.ropt;
2810 
2811  /* These items are treated specially */
2812  if (strcmp(te->desc, "ENCODING") == 0 ||
2813  strcmp(te->desc, "STDSTRINGS") == 0 ||
2814  strcmp(te->desc, "SEARCHPATH") == 0)
2815  return REQ_SPECIAL;
2816 
2817  /*
2818  * DATABASE and DATABASE PROPERTIES also have a special rule: they are
2819  * restored in createDB mode, and not restored otherwise, independently of
2820  * all else.
2821  */
2822  if (strcmp(te->desc, "DATABASE") == 0 ||
2823  strcmp(te->desc, "DATABASE PROPERTIES") == 0)
2824  {
2825  if (ropt->createDB)
2826  return REQ_SCHEMA;
2827  else
2828  return 0;
2829  }
2830 
2831  /*
2832  * Process exclusions that affect certain classes of TOC entries.
2833  */
2834 
2835  /* If it's an ACL, maybe ignore it */
2836  if (ropt->aclsSkip && _tocEntryIsACL(te))
2837  return 0;
2838 
2839  /* If it's a comment, maybe ignore it */
2840  if (ropt->no_comments && strcmp(te->desc, "COMMENT") == 0)
2841  return 0;
2842 
2843  /*
2844  * If it's a publication or a table part of a publication, maybe ignore
2845  * it.
2846  */
2847  if (ropt->no_publications &&
2848  (strcmp(te->desc, "PUBLICATION") == 0 ||
2849  strcmp(te->desc, "PUBLICATION TABLE") == 0))
2850  return 0;
2851 
2852  /* If it's a security label, maybe ignore it */
2853  if (ropt->no_security_labels && strcmp(te->desc, "SECURITY LABEL") == 0)
2854  return 0;
2855 
2856  /* If it's a subscription, maybe ignore it */
2857  if (ropt->no_subscriptions && strcmp(te->desc, "SUBSCRIPTION") == 0)
2858  return 0;
2859 
2860  /* Ignore it if section is not to be dumped/restored */
2861  switch (curSection)
2862  {
2863  case SECTION_PRE_DATA:
2864  if (!(ropt->dumpSections & DUMP_PRE_DATA))
2865  return 0;
2866  break;
2867  case SECTION_DATA:
2868  if (!(ropt->dumpSections & DUMP_DATA))
2869  return 0;
2870  break;
2871  case SECTION_POST_DATA:
2872  if (!(ropt->dumpSections & DUMP_POST_DATA))
2873  return 0;
2874  break;
2875  default:
2876  /* shouldn't get here, really, but ignore it */
2877  return 0;
2878  }
2879 
2880  /* Ignore it if rejected by idWanted[] (cf. SortTocFromFile) */
2881  if (ropt->idWanted && !ropt->idWanted[te->dumpId - 1])
2882  return 0;
2883 
2884  /*
2885  * Check options for selective dump/restore.
2886  */
2887  if (strcmp(te->desc, "ACL") == 0 ||
2888  strcmp(te->desc, "COMMENT") == 0 ||
2889  strcmp(te->desc, "SECURITY LABEL") == 0)
2890  {
2891  /* Database properties react to createDB, not selectivity options. */
2892  if (strncmp(te->tag, "DATABASE ", 9) == 0)
2893  {
2894  if (!ropt->createDB)
2895  return 0;
2896  }
2897  else if (ropt->schemaNames.head != NULL ||
2898  ropt->schemaExcludeNames.head != NULL ||
2899  ropt->selTypes)
2900  {
2901  /*
2902  * In a selective dump/restore, we want to restore these dependent
2903  * TOC entry types only if their parent object is being restored.
2904  * Without selectivity options, we let through everything in the
2905  * archive. Note there may be such entries with no parent, eg
2906  * non-default ACLs for built-in objects.
2907  *
2908  * This code depends on the parent having been marked already,
2909  * which should be the case; if it isn't, perhaps due to
2910  * SortTocFromFile rearrangement, skipping the dependent entry
2911  * seems prudent anyway.
2912  *
2913  * Ideally we'd handle, eg, table CHECK constraints this way too.
2914  * But it's hard to tell which of their dependencies is the one to
2915  * consult.
2916  */
2917  if (te->nDeps != 1 ||
2918  TocIDRequired(AH, te->dependencies[0]) == 0)
2919  return 0;
2920  }
2921  }
2922  else
2923  {
2924  /* Apply selective-restore rules for standalone TOC entries. */
2925  if (ropt->schemaNames.head != NULL)
2926  {
2927  /* If no namespace is specified, it means all. */
2928  if (!te->namespace)
2929  return 0;
2930  if (!simple_string_list_member(&ropt->schemaNames, te->namespace))
2931  return 0;
2932  }
2933 
2934  if (ropt->schemaExcludeNames.head != NULL &&
2935  te->namespace &&
2936  simple_string_list_member(&ropt->schemaExcludeNames, te->namespace))
2937  return 0;
2938 
2939  if (ropt->selTypes)
2940  {
2941  if (strcmp(te->desc, "TABLE") == 0 ||
2942  strcmp(te->desc, "TABLE DATA") == 0 ||
2943  strcmp(te->desc, "VIEW") == 0 ||
2944  strcmp(te->desc, "FOREIGN TABLE") == 0 ||
2945  strcmp(te->desc, "MATERIALIZED VIEW") == 0 ||
2946  strcmp(te->desc, "MATERIALIZED VIEW DATA") == 0 ||
2947  strcmp(te->desc, "SEQUENCE") == 0 ||
2948  strcmp(te->desc, "SEQUENCE SET") == 0)
2949  {
2950  if (!ropt->selTable)
2951  return 0;
2952  if (ropt->tableNames.head != NULL &&
2954  return 0;
2955  }
2956  else if (strcmp(te->desc, "INDEX") == 0)
2957  {
2958  if (!ropt->selIndex)
2959  return 0;
2960  if (ropt->indexNames.head != NULL &&
2962  return 0;
2963  }
2964  else if (strcmp(te->desc, "FUNCTION") == 0 ||
2965  strcmp(te->desc, "AGGREGATE") == 0 ||
2966  strcmp(te->desc, "PROCEDURE") == 0)
2967  {
2968  if (!ropt->selFunction)
2969  return 0;
2970  if (ropt->functionNames.head != NULL &&
2972  return 0;
2973  }
2974  else if (strcmp(te->desc, "TRIGGER") == 0)
2975  {
2976  if (!ropt->selTrigger)
2977  return 0;
2978  if (ropt->triggerNames.head != NULL &&
2980  return 0;
2981  }
2982  else
2983  return 0;
2984  }
2985  }
2986 
2987  /*
2988  * Determine whether the TOC entry contains schema and/or data components,
2989  * and mask off inapplicable REQ bits. If it had a dataDumper, assume
2990  * it's both schema and data. Otherwise it's probably schema-only, but
2991  * there are exceptions.
2992  */
2993  if (!te->hadDumper)
2994  {
2995  /*
2996  * Special Case: If 'SEQUENCE SET' or anything to do with BLOBs, then
2997  * it is considered a data entry. We don't need to check for the
2998  * BLOBS entry or old-style BLOB COMMENTS, because they will have
2999  * hadDumper = true ... but we do need to check new-style BLOB ACLs,
3000  * comments, etc.
3001  */
3002  if (strcmp(te->desc, "SEQUENCE SET") == 0 ||
3003  strcmp(te->desc, "BLOB") == 0 ||
3004  (strcmp(te->desc, "ACL") == 0 &&
3005  strncmp(te->tag, "LARGE OBJECT ", 13) == 0) ||
3006  (strcmp(te->desc, "COMMENT") == 0 &&
3007  strncmp(te->tag, "LARGE OBJECT ", 13) == 0) ||
3008  (strcmp(te->desc, "SECURITY LABEL") == 0 &&
3009  strncmp(te->tag, "LARGE OBJECT ", 13) == 0))
3010  res = res & REQ_DATA;
3011  else
3012  res = res & ~REQ_DATA;
3013  }
3014 
3015  /* If there's no definition command, there's no schema component */
3016  if (!te->defn || !te->defn[0])
3017  res = res & ~REQ_SCHEMA;
3018 
3019  /*
3020  * Special case: <Init> type with <Max OID> tag; this is obsolete and we
3021  * always ignore it.
3022  */
3023  if ((strcmp(te->desc, "<Init>") == 0) && (strcmp(te->tag, "Max OID") == 0))
3024  return 0;
3025 
3026  /* Mask it if we only want schema */
3027  if (ropt->schemaOnly)
3028  {
3029  /*
3030  * The sequence_data option overrides schemaOnly for SEQUENCE SET.
3031  *
3032  * In binary-upgrade mode, even with schemaOnly set, we do not mask
3033  * out large objects. (Only large object definitions, comments and
3034  * other metadata should be generated in binary-upgrade mode, not the
3035  * actual data, but that need not concern us here.)
3036  */
3037  if (!(ropt->sequence_data && strcmp(te->desc, "SEQUENCE SET") == 0) &&
3038  !(ropt->binary_upgrade &&
3039  (strcmp(te->desc, "BLOB") == 0 ||
3040  (strcmp(te->desc, "ACL") == 0 &&
3041  strncmp(te->tag, "LARGE OBJECT ", 13) == 0) ||
3042  (strcmp(te->desc, "COMMENT") == 0 &&
3043  strncmp(te->tag, "LARGE OBJECT ", 13) == 0) ||
3044  (strcmp(te->desc, "SECURITY LABEL") == 0 &&
3045  strncmp(te->tag, "LARGE OBJECT ", 13) == 0))))
3046  res = res & REQ_SCHEMA;
3047  }
3048 
3049  /* Mask it if we only want data */
3050  if (ropt->dataOnly)
3051  res = res & REQ_DATA;
3052 
3053  return res;
3054 }
3055 
3056 /*
3057  * Identify which pass we should restore this TOC entry in.
3058  *
3059  * See notes with the RestorePass typedef in pg_backup_archiver.h.
3060  */
3061 static RestorePass
3063 {
3064  /* "ACL LANGUAGE" was a crock emitted only in PG 7.4 */
3065  if (strcmp(te->desc, "ACL") == 0 ||
3066  strcmp(te->desc, "ACL LANGUAGE") == 0 ||
3067  strcmp(te->desc, "DEFAULT ACL") == 0)
3068  return RESTORE_PASS_ACL;
3069  if (strcmp(te->desc, "EVENT TRIGGER") == 0 ||
3070  strcmp(te->desc, "MATERIALIZED VIEW DATA") == 0)
3071  return RESTORE_PASS_POST_ACL;
3072 
3073  /*
3074  * Comments need to be emitted in the same pass as their parent objects.
3075  * ACLs haven't got comments, and neither do matview data objects, but
3076  * event triggers do. (Fortunately, event triggers haven't got ACLs, or
3077  * we'd need yet another weird special case.)
3078  */
3079  if (strcmp(te->desc, "COMMENT") == 0 &&
3080  strncmp(te->tag, "EVENT TRIGGER ", 14) == 0)
3081  return RESTORE_PASS_POST_ACL;
3082 
3083  /* All else can be handled in the main pass. */
3084  return RESTORE_PASS_MAIN;
3085 }
3086 
3087 /*
3088  * Identify TOC entries that are ACLs.
3089  *
3090  * Note: it seems worth duplicating some code here to avoid a hard-wired
3091  * assumption that these are exactly the same entries that we restore during
3092  * the RESTORE_PASS_ACL phase.
3093  */
3094 static bool
3096 {
3097  /* "ACL LANGUAGE" was a crock emitted only in PG 7.4 */
3098  if (strcmp(te->desc, "ACL") == 0 ||
3099  strcmp(te->desc, "ACL LANGUAGE") == 0 ||
3100  strcmp(te->desc, "DEFAULT ACL") == 0)
3101  return true;
3102  return false;
3103 }
3104 
3105 /*
3106  * Issue SET commands for parameters that we want to have set the same way
3107  * at all times during execution of a restore script.
3108  */
3109 static void
3111 {
3112  RestoreOptions *ropt = AH->public.ropt;
3113 
3114  /*
3115  * Disable timeouts to allow for slow commands, idle parallel workers, etc
3116  */
3117  ahprintf(AH, "SET statement_timeout = 0;\n");
3118  ahprintf(AH, "SET lock_timeout = 0;\n");
3119  ahprintf(AH, "SET idle_in_transaction_session_timeout = 0;\n");
3120 
3121  /* Select the correct character set encoding */
3122  ahprintf(AH, "SET client_encoding = '%s';\n",
3124 
3125  /* Select the correct string literal syntax */
3126  ahprintf(AH, "SET standard_conforming_strings = %s;\n",
3127  AH->public.std_strings ? "on" : "off");
3128 
3129  /* Select the role to be used during restore */
3130  if (ropt && ropt->use_role)
3131  ahprintf(AH, "SET ROLE %s;\n", fmtId(ropt->use_role));
3132 
3133  /* Select the dump-time search_path */
3134  if (AH->public.searchpath)
3135  ahprintf(AH, "%s", AH->public.searchpath);
3136 
3137  /* Make sure function checking is disabled */
3138  ahprintf(AH, "SET check_function_bodies = false;\n");
3139 
3140  /* Ensure that all valid XML data will be accepted */
3141  ahprintf(AH, "SET xmloption = content;\n");
3142 
3143  /* Avoid annoying notices etc */
3144  ahprintf(AH, "SET client_min_messages = warning;\n");
3145  if (!AH->public.std_strings)
3146  ahprintf(AH, "SET escape_string_warning = off;\n");
3147 
3148  /* Adjust row-security state */
3149  if (ropt && ropt->enable_row_security)
3150  ahprintf(AH, "SET row_security = on;\n");
3151  else
3152  ahprintf(AH, "SET row_security = off;\n");
3153 
3154  ahprintf(AH, "\n");
3155 }
3156 
3157 /*
3158  * Issue a SET SESSION AUTHORIZATION command. Caller is responsible
3159  * for updating state if appropriate. If user is NULL or an empty string,
3160  * the specification DEFAULT will be used.
3161  */
3162 static void
3164 {
3166 
3167  appendPQExpBufferStr(cmd, "SET SESSION AUTHORIZATION ");
3168 
3169  /*
3170  * SQL requires a string literal here. Might as well be correct.
3171  */
3172  if (user && *user)
3173  appendStringLiteralAHX(cmd, user, AH);
3174  else
3175  appendPQExpBufferStr(cmd, "DEFAULT");
3176  appendPQExpBufferChar(cmd, ';');
3177 
3178  if (RestoringToDB(AH))
3179  {
3180  PGresult *res;
3181 
3182  res = PQexec(AH->connection, cmd->data);
3183 
3184  if (!res || PQresultStatus(res) != PGRES_COMMAND_OK)
3185  /* NOT warn_or_exit_horribly... use -O instead to skip this. */
3186  fatal("could not set session user to \"%s\": %s",
3187  user, PQerrorMessage(AH->connection));
3188 
3189  PQclear(res);
3190  }
3191  else
3192  ahprintf(AH, "%s\n\n", cmd->data);
3193 
3194  destroyPQExpBuffer(cmd);
3195 }
3196 
3197 
3198 /*
3199  * Issue the commands to connect to the specified database.
3200  *
3201  * If we're currently restoring right into a database, this will
3202  * actually establish a connection. Otherwise it puts a \connect into
3203  * the script output.
3204  */
3205 static void
3207 {
3208  if (RestoringToDB(AH))
3209  ReconnectToServer(AH, dbname);
3210  else
3211  {
3212  PQExpBufferData connectbuf;
3213 
3214  initPQExpBuffer(&connectbuf);
3215  appendPsqlMetaConnect(&connectbuf, dbname);
3216  ahprintf(AH, "%s\n", connectbuf.data);
3217  termPQExpBuffer(&connectbuf);
3218  }
3219 
3220  /*
3221  * NOTE: currUser keeps track of what the imaginary session user in our
3222  * script is. It's now effectively reset to the original userID.
3223  */
3224  if (AH->currUser)
3225  free(AH->currUser);
3226  AH->currUser = NULL;
3227 
3228  /* don't assume we still know the output schema, tablespace, etc either */
3229  if (AH->currSchema)
3230  free(AH->currSchema);
3231  AH->currSchema = NULL;
3232  if (AH->currTablespace)
3233  free(AH->currTablespace);
3234  AH->currTablespace = NULL;
3235 
3236  /* re-establish fixed state */
3238 }
3239 
3240 /*
3241  * Become the specified user, and update state to avoid redundant commands
3242  *
3243  * NULL or empty argument is taken to mean restoring the session default
3244  */
3245 static void
3246 _becomeUser(ArchiveHandle *AH, const char *user)
3247 {
3248  if (!user)
3249  user = ""; /* avoid null pointers */
3250 
3251  if (AH->currUser && strcmp(AH->currUser, user) == 0)
3252  return; /* no need to do anything */
3253 
3254  _doSetSessionAuth(AH, user);
3255 
3256  /*
3257  * NOTE: currUser keeps track of what the imaginary session user in our
3258  * script is
3259  */
3260  if (AH->currUser)
3261  free(AH->currUser);
3262  AH->currUser = pg_strdup(user);
3263 }
3264 
3265 /*
3266  * Become the owner of the given TOC entry object. If
3267  * changes in ownership are not allowed, this doesn't do anything.
3268  */
3269 static void
3271 {
3272  RestoreOptions *ropt = AH->public.ropt;
3273 
3274  if (ropt && (ropt->noOwner || !ropt->use_setsessauth))
3275  return;
3276 
3277  _becomeUser(AH, te->owner);
3278 }
3279 
3280 
3281 /*
3282  * Issue the commands to select the specified schema as the current schema
3283  * in the target database.
3284  */
3285 static void
3286 _selectOutputSchema(ArchiveHandle *AH, const char *schemaName)
3287 {
3288  PQExpBuffer qry;
3289 
3290  /*
3291  * If there was a SEARCHPATH TOC entry, we're supposed to just stay with
3292  * that search_path rather than switching to entry-specific paths.
3293  * Otherwise, it's an old archive that will not restore correctly unless
3294  * we set the search_path as it's expecting.
3295  */
3296  if (AH->public.searchpath)
3297  return;
3298 
3299  if (!schemaName || *schemaName == '\0' ||
3300  (AH->currSchema && strcmp(AH->currSchema, schemaName) == 0))
3301  return; /* no need to do anything */
3302 
3303  qry = createPQExpBuffer();
3304 
3305  appendPQExpBuffer(qry, "SET search_path = %s",
3306  fmtId(schemaName));
3307  if (strcmp(schemaName, "pg_catalog") != 0)
3308  appendPQExpBufferStr(qry, ", pg_catalog");
3309 
3310  if (RestoringToDB(AH))
3311  {
3312  PGresult *res;
3313 
3314  res = PQexec(AH->connection, qry->data);
3315 
3316  if (!res || PQresultStatus(res) != PGRES_COMMAND_OK)
3318  "could not set search_path to \"%s\": %s",
3319  schemaName, PQerrorMessage(AH->connection));
3320 
3321  PQclear(res);
3322  }
3323  else
3324  ahprintf(AH, "%s;\n\n", qry->data);
3325 
3326  if (AH->currSchema)
3327  free(AH->currSchema);
3328  AH->currSchema = pg_strdup(schemaName);
3329 
3330  destroyPQExpBuffer(qry);
3331 }
3332 
3333 /*
3334  * Issue the commands to select the specified tablespace as the current one
3335  * in the target database.
3336  */
3337 static void
3339 {
3340  RestoreOptions *ropt = AH->public.ropt;
3341  PQExpBuffer qry;
3342  const char *want,
3343  *have;
3344 
3345  /* do nothing in --no-tablespaces mode */
3346  if (ropt->noTablespace)
3347  return;
3348 
3349  have = AH->currTablespace;
3350  want = tablespace;
3351 
3352  /* no need to do anything for non-tablespace object */
3353  if (!want)
3354  return;
3355 
3356  if (have && strcmp(want, have) == 0)
3357  return; /* no need to do anything */
3358 
3359  qry = createPQExpBuffer();
3360 
3361  if (strcmp(want, "") == 0)
3362  {
3363  /* We want the tablespace to be the database's default */
3364  appendPQExpBufferStr(qry, "SET default_tablespace = ''");
3365  }
3366  else
3367  {
3368  /* We want an explicit tablespace */
3369  appendPQExpBuffer(qry, "SET default_tablespace = %s", fmtId(want));
3370  }
3371 
3372  if (RestoringToDB(AH))
3373  {
3374  PGresult *res;
3375 
3376  res = PQexec(AH->connection, qry->data);
3377 
3378  if (!res || PQresultStatus(res) != PGRES_COMMAND_OK)
3380  "could not set default_tablespace to %s: %s",
3381  fmtId(want), PQerrorMessage(AH->connection));
3382 
3383  PQclear(res);
3384  }
3385  else
3386  ahprintf(AH, "%s;\n\n", qry->data);
3387 
3388  if (AH->currTablespace)
3389  free(AH->currTablespace);
3390  AH->currTablespace = pg_strdup(want);
3391 
3392  destroyPQExpBuffer(qry);
3393 }
3394 
3395 /*
3396  * Set the proper default_table_access_method value for the table.
3397  */
3398 static void
3399 _selectTableAccessMethod(ArchiveHandle *AH, const char *tableam)
3400 {
3401  PQExpBuffer cmd;
3402  const char *want,
3403  *have;
3404 
3405  have = AH->currTableAm;
3406  want = tableam;
3407 
3408  if (!want)
3409  return;
3410 
3411  if (have && strcmp(want, have) == 0)
3412  return;
3413 
3414  cmd = createPQExpBuffer();
3415  appendPQExpBuffer(cmd, "SET default_table_access_method = %s;", fmtId(want));
3416 
3417  if (RestoringToDB(AH))
3418  {
3419  PGresult *res;
3420 
3421  res = PQexec(AH->connection, cmd->data);
3422 
3423  if (!res || PQresultStatus(res) != PGRES_COMMAND_OK)
3425  "could not set default_table_access_method: %s",
3426  PQerrorMessage(AH->connection));
3427 
3428  PQclear(res);
3429  }
3430  else
3431  ahprintf(AH, "%s\n\n", cmd->data);
3432 
3433  destroyPQExpBuffer(cmd);
3434 
3435  AH->currTableAm = pg_strdup(want);
3436 }
3437 
3438 /*
3439  * Extract an object description for a TOC entry, and append it to buf.
3440  *
3441  * This is used for ALTER ... OWNER TO.
3442  */
3443 static void
3445 {
3446  const char *type = te->desc;
3447 
3448  /* Use ALTER TABLE for views and sequences */
3449  if (strcmp(type, "VIEW") == 0 || strcmp(type, "SEQUENCE") == 0 ||
3450  strcmp(type, "MATERIALIZED VIEW") == 0)
3451  type = "TABLE";
3452 
3453  /* objects that don't require special decoration */
3454  if (strcmp(type, "COLLATION") == 0 ||
3455  strcmp(type, "CONVERSION") == 0 ||
3456  strcmp(type, "DOMAIN") == 0 ||
3457  strcmp(type, "TABLE") == 0 ||
3458  strcmp(type, "TYPE") == 0 ||
3459  strcmp(type, "FOREIGN TABLE") == 0 ||
3460  strcmp(type, "TEXT SEARCH DICTIONARY") == 0 ||
3461  strcmp(type, "TEXT SEARCH CONFIGURATION") == 0 ||
3462  strcmp(type, "STATISTICS") == 0 ||
3463  /* non-schema-specified objects */
3464  strcmp(type, "DATABASE") == 0 ||
3465  strcmp(type, "PROCEDURAL LANGUAGE") == 0 ||
3466  strcmp(type, "SCHEMA") == 0 ||
3467  strcmp(type, "EVENT TRIGGER") == 0 ||
3468  strcmp(type, "FOREIGN DATA WRAPPER") == 0 ||
3469  strcmp(type, "SERVER") == 0 ||
3470  strcmp(type, "PUBLICATION") == 0 ||
3471  strcmp(type, "SUBSCRIPTION") == 0 ||
3472  strcmp(type, "USER MAPPING") == 0)
3473  {
3474  appendPQExpBuffer(buf, "%s ", type);
3475  if (te->namespace && *te->namespace)
3476  appendPQExpBuffer(buf, "%s.", fmtId(te->namespace));
3477  appendPQExpBufferStr(buf, fmtId(te->tag));
3478  return;
3479  }
3480 
3481  /* BLOBs just have a name, but it's numeric so must not use fmtId */
3482  if (strcmp(type, "BLOB") == 0)
3483  {
3484  appendPQExpBuffer(buf, "LARGE OBJECT %s", te->tag);
3485  return;
3486  }
3487 
3488  /*
3489  * These object types require additional decoration. Fortunately, the
3490  * information needed is exactly what's in the DROP command.
3491  */
3492  if (strcmp(type, "AGGREGATE") == 0 ||
3493  strcmp(type, "FUNCTION") == 0 ||
3494  strcmp(type, "OPERATOR") == 0 ||
3495  strcmp(type, "OPERATOR CLASS") == 0 ||
3496  strcmp(type, "OPERATOR FAMILY") == 0 ||
3497  strcmp(type, "PROCEDURE") == 0)
3498  {
3499  /* Chop "DROP " off the front and make a modifiable copy */
3500  char *first = pg_strdup(te->dropStmt + 5);
3501  char *last;
3502 
3503  /* point to last character in string */
3504  last = first + strlen(first) - 1;
3505 
3506  /* Strip off any ';' or '\n' at the end */
3507  while (last >= first && (*last == '\n' || *last == ';'))
3508  last--;
3509  *(last + 1) = '\0';
3510 
3511  appendPQExpBufferStr(buf, first);
3512 
3513  free(first);
3514  return;
3515  }
3516 
3517  pg_log_warning("don't know how to set owner for object type \"%s\"",
3518  type);
3519 }
3520 
3521 /*
3522  * Emit the SQL commands to create the object represented by a TOC entry
3523  *
3524  * This now also includes issuing an ALTER OWNER command to restore the
3525  * object's ownership, if wanted. But note that the object's permissions
3526  * will remain at default, until the matching ACL TOC entry is restored.
3527  */
3528 static void
3529 _printTocEntry(ArchiveHandle *AH, TocEntry *te, bool isData)
3530 {
3531  RestoreOptions *ropt = AH->public.ropt;
3532 
3533  /* Select owner, schema, tablespace and default AM as necessary */
3534  _becomeOwner(AH, te);
3535  _selectOutputSchema(AH, te->namespace);
3536  _selectTablespace(AH, te->tablespace);
3538 
3539  /* Emit header comment for item */
3540  if (!AH->noTocComments)
3541  {
3542  const char *pfx;
3543  char *sanitized_name;
3544  char *sanitized_schema;
3545  char *sanitized_owner;
3546 
3547  if (isData)
3548  pfx = "Data for ";
3549  else
3550  pfx = "";
3551 
3552  ahprintf(AH, "--\n");
3553  if (AH->public.verbose)
3554  {
3555  ahprintf(AH, "-- TOC entry %d (class %u OID %u)\n",
3556  te->dumpId, te->catalogId.tableoid, te->catalogId.oid);
3557  if (te->nDeps > 0)
3558  {
3559  int i;
3560 
3561  ahprintf(AH, "-- Dependencies:");
3562  for (i = 0; i < te->nDeps; i++)
3563  ahprintf(AH, " %d", te->dependencies[i]);
3564  ahprintf(AH, "\n");
3565  }
3566  }
3567 
3568  sanitized_name = sanitize_line(te->tag, false);
3569  sanitized_schema = sanitize_line(te->namespace, true);
3570  sanitized_owner = sanitize_line(ropt->noOwner ? NULL : te->owner, true);
3571 
3572  ahprintf(AH, "-- %sName: %s; Type: %s; Schema: %s; Owner: %s",
3573  pfx, sanitized_name, te->desc, sanitized_schema,
3574  sanitized_owner);
3575 
3576  free(sanitized_name);
3577  free(sanitized_schema);
3578  free(sanitized_owner);
3579 
3580  if (te->tablespace && strlen(te->tablespace) > 0 && !ropt->noTablespace)
3581  {
3582  char *sanitized_tablespace;
3583 
3584  sanitized_tablespace = sanitize_line(te->tablespace, false);
3585  ahprintf(AH, "; Tablespace: %s", sanitized_tablespace);
3586  free(sanitized_tablespace);
3587  }
3588  ahprintf(AH, "\n");
3589 
3590  if (AH->PrintExtraTocPtr != NULL)
3591  AH->PrintExtraTocPtr(AH, te);
3592  ahprintf(AH, "--\n\n");
3593  }
3594 
3595  /*
3596  * Actually print the definition.
3597  *
3598  * Really crude hack for suppressing AUTHORIZATION clause that old pg_dump
3599  * versions put into CREATE SCHEMA. We have to do this when --no-owner
3600  * mode is selected. This is ugly, but I see no other good way ...
3601  */
3602  if (ropt->noOwner && strcmp(te->desc, "SCHEMA") == 0)
3603  {
3604  ahprintf(AH, "CREATE SCHEMA %s;\n\n\n", fmtId(te->tag));
3605  }
3606  else
3607  {
3608  if (te->defn && strlen(te->defn) > 0)
3609  ahprintf(AH, "%s\n\n", te->defn);
3610  }
3611 
3612  /*
3613  * If we aren't using SET SESSION AUTH to determine ownership, we must
3614  * instead issue an ALTER OWNER command. We assume that anything without
3615  * a DROP command is not a separately ownable object. All the categories
3616  * with DROP commands must appear in one list or the other.
3617  */
3618  if (!ropt->noOwner && !ropt->use_setsessauth &&
3619  te->owner && strlen(te->owner) > 0 &&
3620  te->dropStmt && strlen(te->dropStmt) > 0)
3621  {
3622  if (strcmp(te->desc, "AGGREGATE") == 0 ||
3623  strcmp(te->desc, "BLOB") == 0 ||
3624  strcmp(te->desc, "COLLATION") == 0 ||
3625  strcmp(te->desc, "CONVERSION") == 0 ||
3626  strcmp(te->desc, "DATABASE") == 0 ||
3627  strcmp(te->desc, "DOMAIN") == 0 ||
3628  strcmp(te->desc, "FUNCTION") == 0 ||
3629  strcmp(te->desc, "OPERATOR") == 0 ||
3630  strcmp(te->desc, "OPERATOR CLASS") == 0 ||
3631  strcmp(te->desc, "OPERATOR FAMILY") == 0 ||
3632  strcmp(te->desc, "PROCEDURE") == 0 ||
3633  strcmp(te->desc, "PROCEDURAL LANGUAGE") == 0 ||
3634  strcmp(te->desc, "SCHEMA") == 0 ||
3635  strcmp(te->desc, "EVENT TRIGGER") == 0 ||
3636  strcmp(te->desc, "TABLE") == 0 ||
3637  strcmp(te->desc, "TYPE") == 0 ||
3638  strcmp(te->desc, "VIEW") == 0 ||
3639  strcmp(te->desc, "MATERIALIZED VIEW") == 0 ||
3640  strcmp(te->desc, "SEQUENCE") == 0 ||
3641  strcmp(te->desc, "FOREIGN TABLE") == 0 ||
3642  strcmp(te->desc, "TEXT SEARCH DICTIONARY") == 0 ||
3643  strcmp(te->desc, "TEXT SEARCH CONFIGURATION") == 0 ||
3644  strcmp(te->desc, "FOREIGN DATA WRAPPER") == 0 ||
3645  strcmp(te->desc, "SERVER") == 0 ||
3646  strcmp(te->desc, "STATISTICS") == 0 ||
3647  strcmp(te->desc, "PUBLICATION") == 0 ||
3648  strcmp(te->desc, "SUBSCRIPTION") == 0)
3649  {
3650  PQExpBuffer temp = createPQExpBuffer();
3651 
3652  appendPQExpBufferStr(temp, "ALTER ");
3653  _getObjectDescription(temp, te);
3654  appendPQExpBuffer(temp, " OWNER TO %s;", fmtId(te->owner));
3655  ahprintf(AH, "%s\n\n", temp->data);
3656  destroyPQExpBuffer(temp);
3657  }
3658  else if (strcmp(te->desc, "CAST") == 0 ||
3659  strcmp(te->desc, "CHECK CONSTRAINT") == 0 ||
3660  strcmp(te->desc, "CONSTRAINT") == 0 ||
3661  strcmp(te->desc, "DATABASE PROPERTIES") == 0 ||
3662  strcmp(te->desc, "DEFAULT") == 0 ||
3663  strcmp(te->desc, "FK CONSTRAINT") == 0 ||
3664  strcmp(te->desc, "INDEX") == 0 ||
3665  strcmp(te->desc, "RULE") == 0 ||
3666  strcmp(te->desc, "TRIGGER") == 0 ||
3667  strcmp(te->desc, "ROW SECURITY") == 0 ||
3668  strcmp(te->desc, "POLICY") == 0 ||
3669  strcmp(te->desc, "USER MAPPING") == 0)
3670  {
3671  /* these object types don't have separate owners */
3672  }
3673  else
3674  {
3675  pg_log_warning("don't know how to set owner for object type \"%s\"",
3676  te->desc);
3677  }
3678  }
3679 
3680  /*
3681  * If it's an ACL entry, it might contain SET SESSION AUTHORIZATION
3682  * commands, so we can no longer assume we know the current auth setting.
3683  */
3684  if (_tocEntryIsACL(te))
3685  {
3686  if (AH->currUser)
3687  free(AH->currUser);
3688  AH->currUser = NULL;
3689  }
3690 }
3691 
3692 /*
3693  * Sanitize a string to be included in an SQL comment or TOC listing, by
3694  * replacing any newlines with spaces. This ensures each logical output line
3695  * is in fact one physical output line, to prevent corruption of the dump
3696  * (which could, in the worst case, present an SQL injection vulnerability
3697  * if someone were to incautiously load a dump containing objects with
3698  * maliciously crafted names).
3699  *
3700  * The result is a freshly malloc'd string. If the input string is NULL,
3701  * return a malloc'ed empty string, unless want_hyphen, in which case return a
3702  * malloc'ed hyphen.
3703  *
3704  * Note that we currently don't bother to quote names, meaning that the name
3705  * fields aren't automatically parseable. "pg_restore -L" doesn't care because
3706  * it only examines the dumpId field, but someday we might want to try harder.
3707  */
3708 static char *
3709 sanitize_line(const char *str, bool want_hyphen)
3710 {
3711  char *result;
3712  char *s;
3713 
3714  if (!str)
3715  return pg_strdup(want_hyphen ? "-" : "");
3716 
3717  result = pg_strdup(str);
3718 
3719  for (s = result; *s != '\0'; s++)
3720  {
3721  if (*s == '\n' || *s == '\r')
3722  *s = ' ';
3723  }
3724 
3725  return result;
3726 }
3727 
3728 /*
3729  * Write the file header for a custom-format archive
3730  */
3731 void
3733 {
3734  struct tm crtm;
3735 
3736  AH->WriteBufPtr(AH, "PGDMP", 5); /* Magic code */
3737  AH->WriteBytePtr(AH, ARCHIVE_MAJOR(AH->version));
3738  AH->WriteBytePtr(AH, ARCHIVE_MINOR(AH->version));
3739  AH->WriteBytePtr(AH, ARCHIVE_REV(AH->version));
3740  AH->WriteBytePtr(AH, AH->intSize);
3741  AH->WriteBytePtr(AH, AH->offSize);
3742  AH->WriteBytePtr(AH, AH->format);
3743  WriteInt(AH, AH->compression);
3744  crtm = *localtime(&AH->createDate);
3745  WriteInt(AH, crtm.tm_sec);
3746  WriteInt(AH, crtm.tm_min);
3747  WriteInt(AH, crtm.tm_hour);
3748  WriteInt(AH, crtm.tm_mday);
3749  WriteInt(AH, crtm.tm_mon);
3750  WriteInt(AH, crtm.tm_year);
3751  WriteInt(AH, crtm.tm_isdst);
3752  WriteStr(AH, PQdb(AH->connection));
3753  WriteStr(AH, AH->public.remoteVersionStr);
3754  WriteStr(AH, PG_VERSION);
3755 }
3756 
3757 void
3759 {
3760  char tmpMag[7];
3761  int fmt;
3762  struct tm crtm;
3763 
3764  /*
3765  * If we haven't already read the header, do so.
3766  *
3767  * NB: this code must agree with _discoverArchiveFormat(). Maybe find a
3768  * way to unify the cases?
3769  */
3770  if (!AH->readHeader)
3771  {
3772  char vmaj,
3773  vmin,
3774  vrev;
3775 
3776  AH->ReadBufPtr(AH, tmpMag, 5);
3777 
3778  if (strncmp(tmpMag, "PGDMP", 5) != 0)
3779  fatal("did not find magic string in file header");
3780 
3781  vmaj = AH->ReadBytePtr(AH);
3782  vmin = AH->ReadBytePtr(AH);
3783 
3784  if (vmaj > 1 || (vmaj == 1 && vmin > 0)) /* Version > 1.0 */
3785  vrev = AH->ReadBytePtr(AH);
3786  else
3787  vrev = 0;
3788 
3789  AH->version = MAKE_ARCHIVE_VERSION(vmaj, vmin, vrev);
3790 
3791  if (AH->version < K_VERS_1_0 || AH->version > K_VERS_MAX)
3792  fatal("unsupported version (%d.%d) in file header",
3793  vmaj, vmin);
3794 
3795  AH->intSize = AH->ReadBytePtr(AH);
3796  if (AH->intSize > 32)
3797  fatal("sanity check on integer size (%lu) failed",
3798  (unsigned long) AH->intSize);
3799 
3800  if (AH->intSize > sizeof(int))
3801  pg_log_warning("archive was made on a machine with larger integers, some operations might fail");
3802 
3803  if (AH->version >= K_VERS_1_7)
3804  AH->offSize = AH->ReadBytePtr(AH);
3805  else
3806  AH->offSize = AH->intSize;
3807 
3808  fmt = AH->ReadBytePtr(AH);
3809 
3810  if (AH->format != fmt)
3811  fatal("expected format (%d) differs from format found in file (%d)",
3812  AH->format, fmt);
3813  }
3814 
3815  if (AH->version >= K_VERS_1_2)
3816  {
3817  if (AH->version < K_VERS_1_4)
3818  AH->compression = AH->ReadBytePtr(AH);
3819  else
3820  AH->compression = ReadInt(AH);
3821  }
3822  else
3824 
3825 #ifndef HAVE_LIBZ
3826  if (AH->compression != 0)
3827  pg_log_warning("archive is compressed, but this installation does not support compression -- no data will be available");
3828 #endif
3829 
3830  if (AH->version >= K_VERS_1_4)
3831  {
3832  crtm.tm_sec = ReadInt(AH);
3833  crtm.tm_min = ReadInt(AH);
3834  crtm.tm_hour = ReadInt(AH);
3835  crtm.tm_mday = ReadInt(AH);
3836  crtm.tm_mon = ReadInt(AH);
3837  crtm.tm_year = ReadInt(AH);
3838  crtm.tm_isdst = ReadInt(AH);
3839 
3840  AH->archdbname = ReadStr(AH);
3841 
3842  AH->createDate = mktime(&crtm);
3843 
3844  if (AH->createDate == (time_t) -1)
3845  pg_log_warning("invalid creation date in header");
3846  }
3847 
3848  if (AH->version >= K_VERS_1_10)
3849  {
3850  AH->archiveRemoteVersion = ReadStr(AH);
3851  AH->archiveDumpVersion = ReadStr(AH);
3852  }
3853 }
3854 
3855 
3856 /*
3857  * checkSeek
3858  * check to see if ftell/fseek can be performed.
3859  */
3860 bool
3861 checkSeek(FILE *fp)
3862 {
3863  pgoff_t tpos;
3864 
3865  /* Check that ftello works on this file */
3866  tpos = ftello(fp);
3867  if (tpos < 0)
3868  return false;
3869 
3870  /*
3871  * Check that fseeko(SEEK_SET) works, too. NB: we used to try to test
3872  * this with fseeko(fp, 0, SEEK_CUR). But some platforms treat that as a
3873  * successful no-op even on files that are otherwise unseekable.
3874  */
3875  if (fseeko(fp, tpos, SEEK_SET) != 0)
3876  return false;
3877 
3878  return true;
3879 }
3880 
3881 
3882 /*
3883  * dumpTimestamp
3884  */
3885 static void
3886 dumpTimestamp(ArchiveHandle *AH, const char *msg, time_t tim)
3887 {
3888  char buf[64];
3889 
3890  if (strftime(buf, sizeof(buf), PGDUMP_STRFTIME_FMT, localtime(&tim)) != 0)
3891  ahprintf(AH, "-- %s %s\n\n", msg, buf);
3892 }
3893 
3894 /*
3895  * Main engine for parallel restore.
3896  *
3897  * Parallel restore is done in three phases. In this first phase,
3898  * we'll process all SECTION_PRE_DATA TOC entries that are allowed to be
3899  * processed in the RESTORE_PASS_MAIN pass. (In practice, that's all
3900  * PRE_DATA items other than ACLs.) Entries we can't process now are
3901  * added to the pending_list for later phases to deal with.
3902  */
3903 static void
3905 {
3906  bool skipped_some;
3907  TocEntry *next_work_item;
3908 
3909  pg_log_debug("entering restore_toc_entries_prefork");
3910 
3911  /* Adjust dependency information */
3912  fix_dependencies(AH);
3913 
3914  /*
3915  * Do all the early stuff in a single connection in the parent. There's no
3916  * great point in running it in parallel, in fact it will actually run
3917  * faster in a single connection because we avoid all the connection and
3918  * setup overhead. Also, pre-9.2 pg_dump versions were not very good
3919  * about showing all the dependencies of SECTION_PRE_DATA items, so we do
3920  * not risk trying to process them out-of-order.
3921  *
3922  * Stuff that we can't do immediately gets added to the pending_list.
3923  * Note: we don't yet filter out entries that aren't going to be restored.
3924  * They might participate in dependency chains connecting entries that
3925  * should be restored, so we treat them as live until we actually process
3926  * them.
3927  *
3928  * Note: as of 9.2, it should be guaranteed that all PRE_DATA items appear
3929  * before DATA items, and all DATA items before POST_DATA items. That is
3930  * not certain to be true in older archives, though, and in any case use
3931  * of a list file would destroy that ordering (cf. SortTocFromFile). So
3932  * this loop cannot assume that it holds.
3933  */
3935  skipped_some = false;
3936  for (next_work_item = AH->toc->next; next_work_item != AH->toc; next_work_item = next_work_item->next)
3937  {
3938  bool do_now = true;
3939 
3940  if (next_work_item->section != SECTION_PRE_DATA)
3941  {
3942  /* DATA and POST_DATA items are just ignored for now */
3943  if (next_work_item->section == SECTION_DATA ||
3944  next_work_item->section == SECTION_POST_DATA)
3945  {
3946  do_now = false;
3947  skipped_some = true;
3948  }
3949  else
3950  {
3951  /*
3952  * SECTION_NONE items, such as comments, can be processed now
3953  * if we are still in the PRE_DATA part of the archive. Once
3954  * we've skipped any items, we have to consider whether the
3955  * comment's dependencies are satisfied, so skip it for now.
3956  */
3957  if (skipped_some)
3958  do_now = false;
3959  }
3960  }
3961 
3962  /*
3963  * Also skip items that need to be forced into later passes. We need
3964  * not set skipped_some in this case, since by assumption no main-pass
3965  * items could depend on these.
3966  */
3967  if (_tocEntryRestorePass(next_work_item) != RESTORE_PASS_MAIN)
3968  do_now = false;
3969 
3970  if (do_now)
3971  {
3972  /* OK, restore the item and update its dependencies */
3973  pg_log_info("processing item %d %s %s",
3974  next_work_item->dumpId,
3975  next_work_item->desc, next_work_item->tag);
3976 
3977  (void) restore_toc_entry(AH, next_work_item, false);
3978 
3979  /* Reduce dependencies, but don't move anything to ready_list */
3980  reduce_dependencies(AH, next_work_item, NULL);
3981  }
3982  else
3983  {
3984  /* Nope, so add it to pending_list */
3985  pending_list_append(pending_list, next_work_item);
3986  }
3987  }
3988 
3989  /*
3990  * Now close parent connection in prep for parallel steps. We do this
3991  * mainly to ensure that we don't exceed the specified number of parallel
3992  * connections.
3993  */
3994  DisconnectDatabase(&AH->public);
3995 
3996  /* blow away any transient state from the old connection */
3997  if (AH->currUser)
3998  free(AH->currUser);
3999  AH->currUser = NULL;
4000  if (AH->currSchema)
4001  free(AH->currSchema);
4002  AH->currSchema = NULL;
4003  if (AH->currTablespace)
4004  free(AH->currTablespace);
4005  AH->currTablespace = NULL;
4006  if (AH->currTableAm)
4007  free(AH->currTableAm);
4008  AH->currTableAm = NULL;
4009 }
4010 
4011 /*
4012  * Main engine for parallel restore.
4013  *
4014  * Parallel restore is done in three phases. In this second phase,
4015  * we process entries by dispatching them to parallel worker children
4016  * (processes on Unix, threads on Windows), each of which connects
4017  * separately to the database. Inter-entry dependencies are respected,
4018  * and so is the RestorePass multi-pass structure. When we can no longer
4019  * make any entries ready to process, we exit. Normally, there will be
4020  * nothing left to do; but if there is, the third phase will mop up.
4021  */
4022 static void
4024  TocEntry *pending_list)
4025 {
4026  ParallelReadyList ready_list;
4027  TocEntry *next_work_item;
4028 
4029  pg_log_debug("entering restore_toc_entries_parallel");
4030 
4031  /* Set up ready_list with enough room for all known TocEntrys */
4032  ready_list_init(&ready_list, AH->tocCount);
4033 
4034  /*
4035  * The pending_list contains all items that we need to restore. Move all
4036  * items that are available to process immediately into the ready_list.
4037  * After this setup, the pending list is everything that needs to be done
4038  * but is blocked by one or more dependencies, while the ready list
4039  * contains items that have no remaining dependencies and are OK to
4040  * process in the current restore pass.
4041  */
4043  move_to_ready_list(pending_list, &ready_list, AH->restorePass);
4044 
4045  /*
4046  * main parent loop
4047  *
4048  * Keep going until there is no worker still running AND there is no work
4049  * left to be done. Note invariant: at top of loop, there should always
4050  * be at least one worker available to dispatch a job to.
4051  */
4052  pg_log_info("entering main parallel loop");
4053 
4054  for (;;)
4055  {
4056  /* Look for an item ready to be dispatched to a worker */
4057  next_work_item = pop_next_work_item(&ready_list, pstate);
4058  if (next_work_item != NULL)
4059  {
4060  /* If not to be restored, don't waste time launching a worker */
4061  if ((next_work_item->reqs & (REQ_SCHEMA | REQ_DATA)) == 0)
4062  {
4063  pg_log_info("skipping item %d %s %s",
4064  next_work_item->dumpId,
4065  next_work_item->desc, next_work_item->tag);
4066  /* Update its dependencies as though we'd completed it */
4067  reduce_dependencies(AH, next_work_item, &ready_list);
4068  /* Loop around to see if anything else can be dispatched */
4069  continue;
4070  }
4071 
4072  pg_log_info("launching item %d %s %s",
4073  next_work_item->dumpId,
4074  next_work_item->desc, next_work_item->tag);
4075 
4076  /* Dispatch to some worker */
4077  DispatchJobForTocEntry(AH, pstate, next_work_item, ACT_RESTORE,
4078  mark_restore_job_done, &ready_list);
4079  }
4080  else if (IsEveryWorkerIdle(pstate))
4081  {
4082  /*
4083  * Nothing is ready and no worker is running, so we're done with
4084  * the current pass or maybe with the whole process.
4085  */
4086  if (AH->restorePass == RESTORE_PASS_LAST)
4087  break; /* No more parallel processing is possible */
4088 
4089  /* Advance to next restore pass */
4090  AH->restorePass++;
4091  /* That probably allows some stuff to be made ready */
4092  move_to_ready_list(pending_list, &ready_list, AH->restorePass);
4093  /* Loop around to see if anything's now ready */
4094  continue;
4095  }
4096  else
4097  {
4098  /*
4099  * We have nothing ready, but at least one child is working, so
4100  * wait for some subjob to finish.
4101  */
4102  }
4103 
4104  /*
4105  * Before dispatching another job, check to see if anything has
4106  * finished. We should check every time through the loop so as to
4107  * reduce dependencies as soon as possible. If we were unable to
4108  * dispatch any job this time through, wait until some worker finishes
4109  * (and, hopefully, unblocks some pending item). If we did dispatch
4110  * something, continue as soon as there's at least one idle worker.
4111  * Note that in either case, there's guaranteed to be at least one
4112  * idle worker when we return to the top of the loop. This ensures we
4113  * won't block inside DispatchJobForTocEntry, which would be
4114  * undesirable: we'd rather postpone dispatching until we see what's
4115  * been unblocked by finished jobs.
4116  */
4117  WaitForWorkers(AH, pstate,
4118  next_work_item ? WFW_ONE_IDLE : WFW_GOT_STATUS);
4119  }
4120 
4121  /* There should now be nothing in ready_list. */
4122  Assert(ready_list.first_te > ready_list.last_te);
4123 
4124  ready_list_free(&ready_list);
4125 
4126  pg_log_info("finished main parallel loop");
4127 }
4128 
4129 /*
4130  * Main engine for parallel restore.
4131  *
4132  * Parallel restore is done in three phases. In this third phase,
4133  * we mop up any remaining TOC entries by processing them serially.
4134  * This phase normally should have nothing to do, but if we've somehow
4135  * gotten stuck due to circular dependencies or some such, this provides
4136  * at least some chance of completing the restore successfully.
4137  */
4138 static void
4140 {
4141  RestoreOptions *ropt = AH->public.ropt;
4142  TocEntry *te;
4143 
4144  pg_log_debug("entering restore_toc_entries_postfork");
4145 
4146  /*
4147  * Now reconnect the single parent connection.
4148  */
4149  ConnectDatabase((Archive *) AH, &ropt->cparams, true);
4150 
4151  /* re-establish fixed state */
4153 
4154  /*
4155  * Make sure there is no work left due to, say, circular dependencies, or
4156  * some other pathological condition. If so, do it in the single parent
4157  * connection. We don't sweat about RestorePass ordering; it's likely we
4158  * already violated that.
4159  */
4160  for (te = pending_list->pending_next; te != pending_list; te = te->pending_next)
4161  {
4162  pg_log_info("processing missed item %d %s %s",
4163  te->dumpId, te->desc, te->tag);
4164  (void) restore_toc_entry(AH, te, false);
4165  }
4166 }
4167 
4168 /*
4169  * Check if te1 has an exclusive lock requirement for an item that te2 also
4170  * requires, whether or not te2's requirement is for an exclusive lock.
4171  */
4172 static bool
4174 {
4175  int j,
4176  k;
4177 
4178  for (j = 0; j < te1->nLockDeps; j++)
4179  {
4180  for (k = 0; k < te2->nDeps; k++)
4181  {
4182  if (te1->lockDeps[j] == te2->dependencies[k])
4183  return true;
4184  }
4185  }
4186  return false;
4187 }
4188 
4189 
4190 /*
4191  * Initialize the header of the pending-items list.
4192  *
4193  * This is a circular list with a dummy TocEntry as header, just like the
4194  * main TOC list; but we use separate list links so that an entry can be in
4195  * the main TOC list as well as in the pending list.
4196  */
4197 static void
4199 {
4200  l->pending_prev = l->pending_next = l;
4201 }
4202 
4203 /* Append te to the end of the pending-list headed by l */
4204 static void
4206 {
4207  te->pending_prev = l->pending_prev;
4208  l->pending_prev->pending_next = te;
4209  l->pending_prev = te;
4210  te->pending_next = l;
4211 }
4212 
4213 /* Remove te from the pending-list */
4214 static void
4216 {
4219  te->pending_prev = NULL;
4220  te->pending_next = NULL;
4221 }
4222 
4223 
4224 /*
4225  * Initialize the ready_list with enough room for up to tocCount entries.
4226  */
4227 static void
4228 ready_list_init(ParallelReadyList *ready_list, int tocCount)
4229 {
4230  ready_list->tes = (TocEntry **)
4231  pg_malloc(tocCount * sizeof(TocEntry *));
4232  ready_list->first_te = 0;
4233  ready_list->last_te = -1;
4234  ready_list->sorted = false;
4235 }
4236 
4237 /*
4238  * Free storage for a ready_list.
4239  */
4240 static void
4242 {
4243  pg_free(ready_list->tes);
4244 }
4245 
4246 /* Add te to the ready_list */
4247 static void
4249 {
4250  ready_list->tes[++ready_list->last_te] = te;
4251  /* List is (probably) not sorted anymore. */
4252  ready_list->sorted = false;
4253 }
4254 
4255 /* Remove the i'th entry in the ready_list */
4256 static void
4258 {
4259  int f = ready_list->first_te;
4260 
4261  Assert(i >= f && i <= ready_list->last_te);
4262 
4263  /*
4264  * In the typical case where the item to be removed is the first ready
4265  * entry, we need only increment first_te to remove it. Otherwise, move
4266  * the entries before it to compact the list. (This preserves sortedness,
4267  * if any.) We could alternatively move the entries after i, but there
4268  * are typically many more of those.
4269  */
4270  if (i > f)
4271  {
4272  TocEntry **first_te_ptr = &ready_list->tes[f];
4273 
4274  memmove(first_te_ptr + 1, first_te_ptr, (i - f) * sizeof(TocEntry *));
4275  }
4276  ready_list->first_te++;
4277 }
4278 
4279 /* Sort the ready_list into the desired order */
4280 static void
4282 {
4283  if (!ready_list->sorted)
4284  {
4285  int n = ready_list->last_te - ready_list->first_te + 1;
4286 
4287  if (n > 1)
4288  qsort(ready_list->tes + ready_list->first_te, n,
4289  sizeof(TocEntry *),
4291  ready_list->sorted = true;
4292  }
4293 }
4294 
4295 /* qsort comparator for sorting TocEntries by dataLength */
4296 static int
4297 TocEntrySizeCompare(const void *p1, const void *p2)
4298 {
4299  const TocEntry *te1 = *(const TocEntry *const *) p1;
4300  const TocEntry *te2 = *(const TocEntry *const *) p2;
4301 
4302  /* Sort by decreasing dataLength */
4303  if (te1->dataLength > te2->dataLength)
4304  return -1;
4305  if (te1->dataLength < te2->dataLength)
4306  return 1;
4307 
4308  /* For equal dataLengths, sort by dumpId, just to be stable */
4309  if (te1->dumpId < te2->dumpId)
4310  return -1;
4311  if (te1->dumpId > te2->dumpId)
4312  return 1;
4313 
4314  return 0;
4315 }
4316 
4317 
4318 /*
4319  * Move all immediately-ready items from pending_list to ready_list.
4320  *
4321  * Items are considered ready if they have no remaining dependencies and
4322  * they belong in the current restore pass. (See also reduce_dependencies,
4323  * which applies the same logic one-at-a-time.)
4324  */
4325 static void
4327  ParallelReadyList *ready_list,
4328  RestorePass pass)
4329 {
4330  TocEntry *te;
4331  TocEntry *next_te;
4332 
4333  for (te = pending_list->pending_next; te != pending_list; te = next_te)
4334  {
4335  /* must save list link before possibly removing te from list */
4336  next_te = te->pending_next;
4337 
4338  if (te->depCount == 0 &&
4339  _tocEntryRestorePass(te) == pass)
4340  {
4341  /* Remove it from pending_list ... */
4342  pending_list_remove(te);
4343  /* ... and add to ready_list */
4344  ready_list_insert(ready_list, te);
4345  }
4346  }
4347 }
4348 
4349 /*
4350  * Find the next work item (if any) that is capable of being run now,
4351  * and remove it from the ready_list.
4352  *
4353  * Returns the item, or NULL if nothing is runnable.
4354  *
4355  * To qualify, the item must have no remaining dependencies
4356  * and no requirements for locks that are incompatible with
4357  * items currently running. Items in the ready_list are known to have
4358  * no remaining dependencies, but we have to check for lock conflicts.
4359  */
4360 static TocEntry *
4362  ParallelState *pstate)
4363 {
4364  /*
4365  * Sort the ready_list so that we'll tackle larger jobs first.
4366  */
4367  ready_list_sort(ready_list);
4368 
4369  /*
4370  * Search the ready_list until we find a suitable item.
4371  */
4372  for (int i = ready_list->first_te; i <= ready_list->last_te; i++)
4373  {
4374  TocEntry *te = ready_list->tes[i];
4375  bool conflicts = false;
4376 
4377  /*
4378  * Check to see if the item would need exclusive lock on something
4379  * that a currently running item also needs lock on, or vice versa. If
4380  * so, we don't want to schedule them together.
4381  */
4382  for (int k = 0; k < pstate->numWorkers; k++)
4383  {
4384  TocEntry *running_te = pstate->te[k];
4385 
4386  if (running_te == NULL)
4387  continue;
4388  if (has_lock_conflicts(te, running_te) ||
4389  has_lock_conflicts(running_te, te))
4390  {
4391  conflicts = true;
4392  break;
4393  }
4394  }
4395 
4396  if (conflicts)
4397  continue;
4398 
4399  /* passed all tests, so this item can run */
4400  ready_list_remove(ready_list, i);
4401  return te;
4402  }
4403 
4404  pg_log_debug("no item ready");
4405  return NULL;
4406 }
4407 
4408 
4409 /*
4410  * Restore a single TOC item in parallel with others
4411  *
4412  * this is run in the worker, i.e. in a thread (Windows) or a separate process
4413  * (everything else). A worker process executes several such work items during
4414  * a parallel backup or restore. Once we terminate here and report back that
4415  * our work is finished, the leader process will assign us a new work item.
4416  */
4417 int
4419 {
4420  int status;
4421 
4422  Assert(AH->connection != NULL);
4423 
4424  /* Count only errors associated with this TOC entry */
4425  AH->public.n_errors = 0;
4426 
4427  /* Restore the TOC item */
4428  status = restore_toc_entry(AH, te, true);
4429 
4430  return status;
4431 }
4432 
4433 
4434 /*
4435  * Callback function that's invoked in the leader process after a step has
4436  * been parallel restored.
4437  *
4438  * Update status and reduce the dependency count of any dependent items.
4439  */
4440 static void
4442  TocEntry *te,
4443  int status,
4444  void *callback_data)
4445 {
4446  ParallelReadyList *ready_list = (ParallelReadyList *) callback_data;
4447 
4448  pg_log_info("finished item %d %s %s",
4449  te->dumpId, te->desc, te->tag);
4450 
4451  if (status == WORKER_CREATE_DONE)
4452  mark_create_done(AH, te);
4453  else if (status == WORKER_INHIBIT_DATA)
4454  {
4456  AH->public.n_errors++;
4457  }
4458  else if (status == WORKER_IGNORED_ERRORS)
4459  AH->public.n_errors++;
4460  else if (status != 0)
4461  fatal("worker process failed: exit code %d",
4462  status);
4463 
4464  reduce_dependencies(AH, te, ready_list);
4465 }
4466 
4467 
4468 /*
4469  * Process the dependency information into a form useful for parallel restore.
4470  *
4471  * This function takes care of fixing up some missing or badly designed
4472  * dependencies, and then prepares subsidiary data structures that will be
4473  * used in the main parallel-restore logic, including:
4474  * 1. We build the revDeps[] arrays of incoming dependency dumpIds.
4475  * 2. We set up depCount fields that are the number of as-yet-unprocessed
4476  * dependencies for each TOC entry.
4477  *
4478  * We also identify locking dependencies so that we can avoid trying to
4479  * schedule conflicting items at the same time.
4480  */
4481 static void
4483 {
4484  TocEntry *te;
4485  int i;
4486 
4487  /*
4488  * Initialize the depCount/revDeps/nRevDeps fields, and make sure the TOC
4489  * items are marked as not being in any parallel-processing list.
4490  */
4491  for (te = AH->toc->next; te != AH->toc; te = te->next)
4492  {
4493  te->depCount = te->nDeps;
4494  te->revDeps = NULL;
4495  te->nRevDeps = 0;
4496  te->pending_prev = NULL;
4497  te->pending_next = NULL;
4498  }
4499 
4500  /*
4501  * POST_DATA items that are shown as depending on a table need to be
4502  * re-pointed to depend on that table's data, instead. This ensures they
4503  * won't get scheduled until the data has been loaded.
4504  */
4506 
4507  /*
4508  * Pre-8.4 versions of pg_dump neglected to set up a dependency from BLOB
4509  * COMMENTS to BLOBS. Cope. (We assume there's only one BLOBS and only
4510  * one BLOB COMMENTS in such files.)
4511  */
4512  if (AH->version < K_VERS_1_11)
4513  {
4514  for (te = AH->toc->next; te != AH->toc; te = te->next)
4515  {
4516  if (strcmp(te->desc, "BLOB COMMENTS") == 0 && te->nDeps == 0)
4517  {
4518  TocEntry *te2;
4519 
4520  for (te2 = AH->toc->next; te2 != AH->toc; te2 = te2->next)
4521  {
4522  if (strcmp(te2->desc, "BLOBS") == 0)
4523  {
4524  te->dependencies = (DumpId *) pg_malloc(sizeof(DumpId));
4525  te->dependencies[0] = te2->dumpId;
4526  te->nDeps++;
4527  te->depCount++;
4528  break;
4529  }
4530  }
4531  break;
4532  }
4533  }
4534  }
4535 
4536  /*
4537  * At this point we start to build the revDeps reverse-dependency arrays,
4538  * so all changes of dependencies must be complete.
4539  */
4540 
4541  /*
4542  * Count the incoming dependencies for each item. Also, it is possible
4543  * that the dependencies list items that are not in the archive at all
4544  * (that should not happen in 9.2 and later, but is highly likely in older
4545  * archives). Subtract such items from the depCounts.
4546  */
4547  for (te = AH->toc->next; te != AH->toc; te = te->next)
4548  {
4549  for (i = 0; i < te->nDeps; i++)
4550  {
4551  DumpId depid = te->dependencies[i];
4552 
4553  if (depid <= AH->maxDumpId && AH->tocsByDumpId[depid] != NULL)
4554  AH->tocsByDumpId[depid]->nRevDeps++;
4555  else
4556  te->depCount--;
4557  }
4558  }
4559 
4560  /*
4561  * Allocate space for revDeps[] arrays, and reset nRevDeps so we can use
4562  * it as a counter below.
4563  */
4564  for (te = AH->toc->next; te != AH->toc; te = te->next)
4565  {
4566  if (te->nRevDeps > 0)
4567  te->revDeps = (DumpId *) pg_malloc(te->nRevDeps * sizeof(DumpId));
4568  te->nRevDeps = 0;
4569  }
4570 
4571  /*
4572  * Build the revDeps[] arrays of incoming-dependency dumpIds. This had
4573  * better agree with the loops above.
4574  */
4575  for (te = AH->toc->next; te != AH->toc; te = te->next)
4576  {
4577  for (i = 0; i < te->nDeps; i++)
4578  {
4579  DumpId depid = te->dependencies[i];
4580 
4581  if (depid <= AH->maxDumpId && AH->tocsByDumpId[depid] != NULL)
4582  {
4583  TocEntry *otherte = AH->tocsByDumpId[depid];
4584 
4585  otherte->revDeps[otherte->nRevDeps++] = te->dumpId;
4586  }
4587  }
4588  }
4589 
4590  /*
4591  * Lastly, work out the locking dependencies.
4592  */
4593  for (te = AH->toc->next; te != AH->toc; te = te->next)
4594  {
4595  te->lockDeps = NULL;
4596  te->nLockDeps = 0;
4598  }
4599 }
4600 
4601 /*
4602  * Change dependencies on table items to depend on table data items instead,
4603  * but only in POST_DATA items.
4604  *
4605  * Also, for any item having such dependency(s), set its dataLength to the
4606  * largest dataLength of the table data items it depends on. This ensures
4607  * that parallel restore will prioritize larger jobs (index builds, FK
4608  * constraint checks, etc) over smaller ones, avoiding situations where we
4609  * end a restore with only one active job working on a large table.
4610  */
4611 static void
4613 {
4614  TocEntry *te;
4615  int i;
4616  DumpId olddep;
4617 
4618  for (te = AH->toc->next; te != AH->toc; te = te->next)
4619  {
4620  if (te->section != SECTION_POST_DATA)
4621  continue;
4622  for (i = 0; i < te->nDeps; i++)
4623  {
4624  olddep = te->dependencies[i];
4625  if (olddep <= AH->maxDumpId &&
4626  AH->tableDataId[olddep] != 0)
4627  {
4628  DumpId tabledataid = AH->tableDataId[olddep];
4629  TocEntry *tabledatate = AH->tocsByDumpId[tabledataid];
4630 
4631  te->dependencies[i] = tabledataid;
4632  te->dataLength = Max(te->dataLength, tabledatate->dataLength);
4633  pg_log_debug("transferring dependency %d -> %d to %d",
4634  te->dumpId, olddep, tabledataid);
4635  }
4636  }
4637  }
4638 }
4639 
4640 /*
4641  * Identify which objects we'll need exclusive lock on in order to restore
4642  * the given TOC entry (*other* than the one identified by the TOC entry
4643  * itself). Record their dump IDs in the entry's lockDeps[] array.
4644  */
4645 static void
4647 {
4648  DumpId *lockids;
4649  int nlockids;
4650  int i;
4651 
4652  /*
4653  * We only care about this for POST_DATA items. PRE_DATA items are not
4654  * run in parallel, and DATA items are all independent by assumption.
4655  */
4656  if (te->section != SECTION_POST_DATA)
4657  return;
4658 
4659  /* Quick exit if no dependencies at all */
4660  if (te->nDeps == 0)
4661  return;
4662 
4663  /*
4664  * Most POST_DATA items are ALTER TABLEs or some moral equivalent of that,
4665  * and hence require exclusive lock. However, we know that CREATE INDEX
4666  * does not. (Maybe someday index-creating CONSTRAINTs will fall in that
4667  * category too ... but today is not that day.)
4668  */
4669  if (strcmp(te->desc, "INDEX") == 0)
4670  return;
4671 
4672  /*
4673  * We assume the entry requires exclusive lock on each TABLE or TABLE DATA
4674  * item listed among its dependencies. Originally all of these would have
4675  * been TABLE items, but repoint_table_dependencies would have repointed
4676  * them to the TABLE DATA items if those are present (which they might not
4677  * be, eg in a schema-only dump). Note that all of the entries we are
4678  * processing here are POST_DATA; otherwise there might be a significant
4679  * difference between a dependency on a table and a dependency on its
4680  * data, so that closer analysis would be needed here.
4681  */
4682  lockids = (DumpId *) pg_malloc(te->nDeps * sizeof(DumpId));
4683  nlockids = 0;
4684  for (i = 0; i < te->nDeps; i++)
4685  {
4686  DumpId depid = te->dependencies[i];
4687 
4688  if (depid <= AH->maxDumpId && AH->tocsByDumpId[depid] != NULL &&
4689  ((strcmp(AH->tocsByDumpId[depid]->desc, "TABLE DATA") == 0) ||
4690  strcmp(AH->tocsByDumpId[depid]->desc, "TABLE") == 0))
4691  lockids[nlockids++] = depid;
4692  }
4693 
4694  if (nlockids == 0)
4695  {
4696  free(lockids);
4697  return;
4698  }
4699 
4700  te->lockDeps = pg_realloc(lockids, nlockids * sizeof(DumpId));
4701  te->nLockDeps = nlockids;
4702 }
4703 
4704 /*
4705  * Remove the specified TOC entry from the depCounts of items that depend on
4706  * it, thereby possibly making them ready-to-run. Any pending item that
4707  * becomes ready should be moved to the ready_list, if that's provided.
4708  */
4709 static void
4711  ParallelReadyList *ready_list)
4712 {
4713  int i;
4714 
4715  pg_log_debug("reducing dependencies for %d", te->dumpId);
4716 
4717  for (i = 0; i < te->nRevDeps; i++)
4718  {
4719  TocEntry *otherte = AH->tocsByDumpId[te->revDeps[i]];
4720 
4721  Assert(otherte->depCount > 0);
4722  otherte->depCount--;
4723 
4724  /*
4725  * It's ready if it has no remaining dependencies, and it belongs in
4726  * the current restore pass, and it is currently a member of the
4727  * pending list (that check is needed to prevent double restore in
4728  * some cases where a list-file forces out-of-order restoring).
4729  * However, if ready_list == NULL then caller doesn't want any list
4730  * memberships changed.
4731  */
4732  if (otherte->depCount == 0 &&
4733  _tocEntryRestorePass(otherte) == AH->restorePass &&
4734  otherte->pending_prev != NULL &&
4735  ready_list != NULL)
4736  {
4737  /* Remove it from pending list ... */
4738  pending_list_remove(otherte);
4739  /* ... and add to ready_list */
4740  ready_list_insert(ready_list, otherte);
4741  }
4742  }
4743 }
4744 
4745 /*
4746  * Set the created flag on the DATA member corresponding to the given
4747  * TABLE member
4748  */
4749 static void
4751 {
4752  if (AH->tableDataId[te->dumpId] != 0)
4753  {
4754  TocEntry *ted = AH->tocsByDumpId[AH->tableDataId[te->dumpId]];
4755 
4756  ted->created = true;
4757  }
4758 }
4759 
4760 /*
4761  * Mark the DATA member corresponding to the given TABLE member
4762  * as not wanted
4763  */
4764 static void
4766 {
4767  pg_log_info("table \"%s\" could not be created, will not restore its data",
4768  te->tag);
4769 
4770  if (AH->tableDataId[te->dumpId] != 0)
4771  {
4772  TocEntry *ted = AH->tocsByDumpId[AH->tableDataId[te->dumpId]];
4773 
4774  ted->reqs = 0;
4775  }
4776 }
4777 
4778 /*
4779  * Clone and de-clone routines used in parallel restoration.
4780  *
4781  * Enough of the structure is cloned to ensure that there is no
4782  * conflict between different threads each with their own clone.
4783  */
4784 ArchiveHandle *
4786 {
4787  ArchiveHandle *clone;
4788 
4789  /* Make a "flat" copy */
4790  clone = (ArchiveHandle *) pg_malloc(sizeof(ArchiveHandle));
4791  memcpy(clone, AH, sizeof(ArchiveHandle));
4792 
4793  /* Handle format-independent fields */
4794  memset(&(clone->sqlparse), 0, sizeof(clone->sqlparse));
4795 
4796  /* The clone will have its own connection, so disregard connection state */
4797  clone->connection = NULL;
4798  clone->connCancel = NULL;
4799  clone->currUser = NULL;
4800  clone->currSchema = NULL;
4801  clone->currTablespace = NULL;
4802 
4803  /* savedPassword must be local in case we change it while connecting */
4804  if (clone->savedPassword)
4805  clone->savedPassword = pg_strdup(clone->savedPassword);
4806 
4807  /* clone has its own error count, too */
4808  clone->public.n_errors = 0;
4809 
4810  /*
4811  * Connect our new clone object to the database, using the same connection
4812  * parameters used for the original connection.
4813  */
4814  ConnectDatabase((Archive *) clone, &clone->public.ropt->cparams, true);
4815 
4816  /* re-establish fixed state */
4817  if (AH->mode == archModeRead)
4818  _doSetFixedOutputState(clone);
4819  /* in write case, setupDumpWorker will fix up connection state */
4820 
4821  /* Let the format-specific code have a chance too */
4822  clone->ClonePtr(clone);
4823 
4824  Assert(clone->connection != NULL);
4825  return clone;
4826 }
4827 
4828 /*
4829  * Release clone-local storage.
4830  *
4831  * Note: we assume any clone-local connection was already closed.
4832  */
4833 void
4835 {
4836  /* Should not have an open database connection */
4837  Assert(AH->connection == NULL);
4838 
4839  /* Clear format-specific state */
4840  AH->DeClonePtr(AH);
4841 
4842  /* Clear state allocated by CloneArchive */
4843  if (AH->sqlparse.curCmd)
4845 
4846  /* Clear any connection-local state */
4847  if (AH->currUser)
4848  free(AH->currUser);
4849  if (AH->currSchema)
4850  free(AH->currSchema);
4851  if (AH->currTablespace)
4852  free(AH->currTablespace);
4853  if (AH->currTableAm)
4854  free(AH->currTableAm);
4855  if (AH->savedPassword)
4856  free(AH->savedPassword);
4857 
4858  free(AH);
4859 }
int remaining
Definition: informix.c:667
struct _tocEntry * next
static int TocEntrySizeCompare(const void *p1, const void *p2)
ReopenPtrType ReopenPtr
static void processEncodingEntry(ArchiveHandle *AH, TocEntry *te)
bool pg_get_line_buf(FILE *stream, StringInfo buf)
Definition: pg_get_line.c:88
ReadBufPtrType ReadBufPtr
static int RestoringToDB(ArchiveHandle *AH)
void ReadToc(ArchiveHandle *AH)
int column_inserts
Definition: pg_backup.h:155
PQExpBuffer curCmd
#define appendByteaLiteralAHX(buf, str, len, AH)
static PgChecksumMode mode
Definition: pg_checksums.c:61
int disable_triggers
Definition: pg_backup.h:164
int DumpId
Definition: pg_backup.h:242
int parallel_restore(ArchiveHandle *AH, TocEntry *te)
void EndDBCopyMode(Archive *AHX, const char *tocEntryTag)
Definition: pg_backup_db.c:506
void ConnectDatabase(Archive *AHX, const ConnParams *cparams, bool isReconnect)
Definition: pg_backup_db.c:114
void ReadHead(ArchiveHandle *AH)
#define K_VERS_SELF
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:6666
int noDataForFailedTables
Definition: pg_backup.h:126
#define Z_DEFAULT_COMPRESSION
static void _printTocEntry(ArchiveHandle *AH, TocEntry *te, bool isData)
DeClonePtrType DeClonePtr
struct _tocEntry * currentTE
static void dumpTimestamp(ArchiveHandle *AH, const char *msg, time_t tim)
#define K_VERS_1_0
static void mark_restore_job_done(ArchiveHandle *AH, TocEntry *te, int status, void *callback_data)
int pg_char_to_encoding(const char *name)
Definition: encnames.c:550
void DispatchJobForTocEntry(ArchiveHandle *AH, ParallelState *pstate, TocEntry *te, T_Action act, ParallelCompletionPtr callback, void *callback_data)
Definition: parallel.c:1224
int disable_dollar_quoting
Definition: pg_backup.h:87
bool simple_string_list_member(SimpleStringList *list, const char *val)
Definition: simple_list.c:87
int archprintf(Archive *AH, const char *fmt,...)
int ExecuteSqlCommandBuf(Archive *AHX, const char *buf, size_t bufLen)
Definition: pg_backup_db.c:451
Oid tableoid
Definition: pg_backup.h:238
int EndBlob(Archive *AHX, Oid oid)
char * pgport
Definition: pg_backup.h:66
SimpleStringList triggerNames
Definition: pg_backup.h:120
void DropBlobIfExists(ArchiveHandle *AH, Oid oid)
Definition: pg_backup_db.c:551
static ArchiveHandle * _allocAH(const char *FileSpec, const ArchiveFormat fmt, const int compression, bool dosync, ArchiveMode mode, SetupWorkerPtrType setupWorkerPtr)
static void _getObjectDescription(PQExpBuffer buf, TocEntry *te)
void PrintTOCSummary(Archive *AHX)
bool IsEveryWorkerIdle(ParallelState *pstate)
Definition: parallel.c:1287
static void setupRestoreWorker(Archive *AHX)
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
RestoreOptions * ropt
Definition: pg_backup.h:191
WriteBufPtrType WriteBufPtr
static void _becomeUser(ArchiveHandle *AH, const char *user)
const char * fmtId(const char *rawid)
Definition: string_utils.c:64
bool schemaOnly
Definition: pg_backup.h:146
static void restore_toc_entries_postfork(ArchiveHandle *AH, TocEntry *pending_list)
void termPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:131
CatalogId catalogId
const char * simple_string_list_not_touched(SimpleStringList *list)
Definition: simple_list.c:144
int no_subscriptions
Definition: pg_backup.h:160
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:369
int no_publications
Definition: pg_backup.h:159
void * dataDumperArg
static TocEntry * pop_next_work_item(ParallelReadyList *ready_list, ParallelState *pstate)
static void SetOutput(ArchiveHandle *AH, const char *filename, int compression)
void WriteDataChunks(ArchiveHandle *AH, ParallelState *pstate)
void ProcessArchiveRestoreOptions(Archive *AHX)
void warn_or_exit_horribly(ArchiveHandle *AH, const char *fmt,...)
StartBlobPtrType StartBlobPtr
static void ready_list_init(ParallelReadyList *ready_list, int tocCount)
static void ready_list_remove(ParallelReadyList *ready_list, int i)
struct _tocEntry * pending_prev
#define TEXT_DUMP_HEADER
static void restore_toc_entries_parallel(ArchiveHandle *AH, ParallelState *pstate, TocEntry *pending_list)
EndDataPtrType EndDataPtr
#define K_VERS_1_9
static bool dosync
Definition: pg_dump.c:91
#define PG_BINARY_W
Definition: c.h:1214
#define WORKER_CREATE_DONE
void WriteToc(ArchiveHandle *AH)
void InitArchiveFmt_Tar(ArchiveHandle *AH)
DumpOptions * NewDumpOptions(void)
DataDumperPtr dataDumper
int ReadInt(ArchiveHandle *AH)
char * use_role
Definition: pg_backup.h:85
SimpleStringList schemaNames
Definition: pg_backup.h:118
StartBlobsPtrType StartBlobsPtr
int n_errors
Definition: pg_backup.h:214
PGcancel *volatile connCancel
int sequence_data
Definition: pg_backup.h:180
unsigned int Oid
Definition: postgres_ext.h:31
int PQserverVersion(const PGconn *conn)
Definition: fe-connect.c:6656
bool isValidTarHeader(char *header)
static void processStdStringsEntry(ArchiveHandle *AH, TocEntry *te)
#define PG_BINARY_R
Definition: c.h:1213
DumpId * lockDeps
int encoding
Definition: pg_backup.h:205
#define K_VERS_1_4
SetupWorkerPtrType SetupWorkerPtr
struct _parallelReadyList ParallelReadyList
void CloseArchive(Archive *AHX)
void StartRestoreBlobs(ArchiveHandle *AH)
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:2692
struct _tocEntry * currToc
ReadBytePtrType ReadBytePtr
RestorePass restorePass
int maxRemoteVersion
Definition: pg_backup.h:199
#define WORKER_IGNORED_ERRORS
static bool _tocEntryIsACL(TocEntry *te)
teSection section
static struct pg_tm tm
Definition: localtime.c:102
trivalue promptPassword
Definition: pg_backup.h:69
void appendPsqlMetaConnect(PQExpBuffer buf, const char *dbname)
Definition: string_utils.c:590
#define K_VERS_1_12
#define K_VERS_1_7
struct _tocEntry * pending_next
char * dbname
Definition: pg_backup.h:65
void DeCloneArchive(ArchiveHandle *AH)
#define K_VERS_1_5
#define pgoff_t
Definition: win32_port.h:194
const char * lockWaitTimeout
Definition: pg_backup.h:103
#define ftello(stream)
Definition: win32_port.h:204
EndBlobPtrType EndBlobPtr
static void ready_list_sort(ParallelReadyList *ready_list)
#define sprintf
Definition: port.h:195
int use_setsessauth
Definition: pg_backup.h:166
static void _moveBefore(TocEntry *pos, TocEntry *te)
#define true
Definition: c.h:328
const char * filename
Definition: pg_backup.h:97
void destroyPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:116
int lo_close(PGconn *conn, int fd)
Definition: fe-lobj.c:99
int disable_dollar_quoting
Definition: pg_backup.h:154
void struct _archiveOpts ArchiveOpts
size_t pvsnprintf(char *buf, size_t len, const char *fmt, va_list args)
Definition: psprintf.c:106
bool * idWanted
Definition: pg_backup.h:133
static int restore_toc_entry(ArchiveHandle *AH, TocEntry *te, bool is_parallel)
RestoreOptions * NewRestoreOptions(void)
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
DumpOptions * dopt
Definition: pg_backup.h:190
#define pg_log_debug(...)
Definition: logging.h:92
#define MAXPGPATH
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:267
int column_inserts
Definition: pg_backup.h:89
#define MAKE_ARCHIVE_VERSION(major, minor, rev)
void StartRestoreBlob(ArchiveHandle *AH, Oid oid, bool drop)
static void move_to_ready_list(TocEntry *pending_list, ParallelReadyList *ready_list, RestorePass pass)
const char * lockWaitTimeout
Definition: pg_backup.h:150
#define K_VERS_1_2
TocEntry * ArchiveEntry(Archive *AHX, CatalogId catalogId, DumpId dumpId, ArchiveOpts *opts)
char sign
Definition: informix.c:668
bool dataOnly
Definition: pg_backup.h:147
static void reduce_dependencies(ArchiveHandle *AH, TocEntry *te, ParallelReadyList *ready_list)
bool include_everything
Definition: pg_backup.h:171
SimpleStringList tableNames
Definition: pg_backup.h:121
char * c
struct _tocEntry * toc
static char * buf
Definition: pg_test_fsync.c:68
TocEntry * getTocEntryByDumpId(ArchiveHandle *AH, DumpId id)
DumpId * dependencies
static void _selectTableAccessMethod(ArchiveHandle *AH, const char *tableam)
#define K_VERS_1_8
StartDataPtrType StartDataPtr
static void processSearchPathEntry(ArchiveHandle *AH, TocEntry *te)
ArchiveHandle * CloneArchive(ArchiveHandle *AH)
#define K_VERS_1_10
char * tablespace
Definition: pgbench.c:189
char * outputSuperuser
Definition: pg_backup.h:178
static RestorePass _tocEntryRestorePass(TocEntry *te)
static void dump_lo_buf(ArchiveHandle *AH)
SimpleStringList functionNames
Definition: pg_backup.h:117
ConnParams cparams
Definition: pg_backup.h:141
#define ARCHIVE_REV(version)
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
void ReconnectToServer(ArchiveHandle *AH, const char *dbname)
Definition: pg_backup_db.c:78
static void _doSetFixedOutputState(ArchiveHandle *AH)
void SetArchiveOptions(Archive *AH, DumpOptions *dopt, RestoreOptions *ropt)
Archive * CreateArchive(const char *FileSpec, const ArchiveFormat fmt, const int compression, bool dosync, ArchiveMode mode, SetupWorkerPtrType setupDumpWorker)
int StartBlob(Archive *AHX, Oid oid)
pgoff_t dataLength
int include_everything
Definition: pg_backup.h:104
DumpOptions * dumpOptionsFromRestoreOptions(RestoreOptions *ropt)
Archive * OpenArchive(const char *FileSpec, const ArchiveFormat fmt)
int no_security_labels
Definition: pg_backup.h:93
static void buildTocEntryArrays(ArchiveHandle *AH)
#define K_OFFSET_NO_DATA
void * pg_realloc(void *ptr, size_t size)
Definition: fe_memutils.c:65
static void _becomeOwner(ArchiveHandle *AH, TocEntry *te)
int dumpSections
Definition: pg_backup.h:148
sqlparseInfo sqlparse
int enable_row_security
Definition: pg_backup.h:134
WriteBytePtrType WriteBytePtr
int dump_inserts
Definition: pg_backup.h:151
void WriteData(Archive *AHX, const void *data, size_t dLen)
int outputNoOwner
Definition: pg_backup.h:177
#define K_VERS_1_3
static void inhibit_data_for_failed_table(ArchiveHandle *AH, TocEntry *te)
int lo_open(PGconn *conn, Oid lobjId, int mode)
Definition: fe-lobj.c:57
void archputs(const char *s, Archive *AH)
ConnParams cparams
Definition: pg_backup.h:124
int lo_write(int fd, const char *buf, int len)
Definition: be-fsstubs.c:170
void DisconnectDatabase(Archive *AHX)
Definition: pg_backup_db.c:232
static void pending_list_header_init(TocEntry *l)
int no_security_labels
Definition: pg_backup.h:158
int ahprintf(ArchiveHandle *AH, const char *fmt,...)
ParallelState * ParallelBackupStart(ArchiveHandle *AH)
Definition: parallel.c:916
#define S_ISREG(m)
Definition: win32_port.h:299
size_t WriteOffset(ArchiveHandle *AH, pgoff_t o, int wasSet)
char * pghost
Definition: pg_backup.h:67
#define WORKER_INHIBIT_DATA
char * username
Definition: pg_backup.h:68
#define ARCHIVE_MINOR(version)
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
void SortTocFromFile(Archive *AHX)
static void mark_create_done(ArchiveHandle *AH, TocEntry *te)
int no_subscriptions
Definition: pg_backup.h:94
#define stat(a, b)
Definition: win32_port.h:255
#define GZWRITE(p, s, n, fh)
void ParallelBackupEnd(ArchiveHandle *AH, ParallelState *pstate)
Definition: parallel.c:1078
void EndRestoreBlobs(ArchiveHandle *AH)
char * superuser
Definition: pg_backup.h:84
static void _reconnectToDB(ArchiveHandle *AH, const char *dbname)
struct _tocEntry * prev
#define ngettext(s, p, n)
Definition: c.h:1123
void(* StartDataPtrType)(ArchiveHandle *AH, TocEntry *te)
#define exit_nicely(code)
Definition: pg_dumpall.c:96
ArchiveFormat format
ArchiverStage stage
int ReadOffset(ArchiveHandle *AH, pgoff_t *o)
#define TEXT_DUMPALL_HEADER
static void fix_dependencies(ArchiveHandle *AH)
bool aclsSkip
Definition: pg_backup.h:149
PQExpBuffer createPQExpBuffer(void)
Definition: pqexpbuffer.c:74
int use_setsessauth
Definition: pg_backup.h:82
int verbose
Definition: pg_backup.h:193
static void StrictNamesCheck(RestoreOptions *ropt)
static void _doSetSessionAuth(ArchiveHandle *AH, const char *user)
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:380
static int _discoverArchiveFormat(ArchiveHandle *AH)
#define ARCHIVE_MAJOR(version)
char * searchpath
Definition: pg_backup.h:209
PrintTocDataPtrType PrintTocDataPtr
static int sig
Definition: pg_ctl.c:84
static OutputContext SaveOutput(ArchiveHandle *AH)
void WaitForWorkers(ArchiveHandle *AH, ParallelState *pstate, WFW_WaitOption mode)
Definition: parallel.c:1470
#define fseeko(stream, offset, origin)
Definition: win32_port.h:201
int enable_row_security
Definition: pg_backup.h:167
WriteDataPtrType WriteDataPtr
#define InvalidOid
Definition: postgres_ext.h:36
void InitArchiveFmt_Directory(ArchiveHandle *AH)
enum _archiveFormat ArchiveFormat
#define K_VERS_MAX
void PQclear(PGresult *res)
Definition: fe-exec.c:694
void pg_log_generic(enum pg_log_level level, const char *pg_restrict fmt,...)
Definition: logging.c:197
void InitArchiveFmt_Null(ArchiveHandle *AH)
static void * fn(void *arg)
static void StartTransaction(void)
Definition: xact.c:1914
#define free(a)
Definition: header.h:65
const char * pg_encoding_to_char(int encoding)
Definition: encnames.c:588
enum _teSection teSection
Oid lo_create(PGconn *conn, Oid lobjId)
Definition: fe-lobj.c:504
char * PQdb(const PGconn *conn)
Definition: fe-connect.c:6516
#define Max(x, y)
Definition: c.h:921
void InitArchiveFmt_Custom(ArchiveHandle *AH)
CustomOutPtrType CustomOutPtr
#define Assert(condition)
Definition: c.h:745
char * ReadStr(ArchiveHandle *AH)
TocEntry ** te
Definition: parallel.h:44
teReqs TocIDRequired(ArchiveHandle *AH, DumpId id)
#define PG_BINARY_A
Definition: c.h:1212
void(* EndDataPtrType)(ArchiveHandle *AH, TocEntry *te)
PrepParallelRestorePtrType PrepParallelRestorePtr
EndBlobsPtrType EndBlobsPtr
SimpleStringListCell * head
Definition: simple_list.h:42
int outputCreateDB
Definition: pg_backup.h:174