PostgreSQL Source Code  git master
fetch.h File Reference
#include "access/xlogdefs.h"
#include "filemap.h"
Include dependency graph for fetch.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef void(* process_file_callback_t) (const char *path, file_type_t type, size_t size, const char *link_target)
 

Functions

void fetchSourceFileList (void)
 
char * fetchFile (const char *filename, size_t *filesize)
 
void executeFileMap (void)
 
void libpqProcessFileList (void)
 
char * libpqGetFile (const char *filename, size_t *filesize)
 
void libpq_executeFileMap (filemap_t *map)
 
void libpqConnect (const char *connstr)
 
XLogRecPtr libpqGetCurrentXlogInsertLocation (void)
 
void copy_executeFileMap (filemap_t *map)
 
void traverse_datadir (const char *datadir, process_file_callback_t callback)
 

Typedef Documentation

◆ process_file_callback_t

typedef void(* process_file_callback_t) (const char *path, file_type_t type, size_t size, const char *link_target)

Definition at line 41 of file fetch.h.

Function Documentation

◆ copy_executeFileMap()

void copy_executeFileMap ( filemap_t map)

Definition at line 205 of file copy_fetch.c.

References file_entry_t::action, filemap_t::array, close_target_file(), create_target(), execute_pagemap(), FILE_ACTION_COPY, FILE_ACTION_COPY_TAIL, FILE_ACTION_CREATE, FILE_ACTION_NONE, FILE_ACTION_REMOVE, FILE_ACTION_TRUNCATE, i, filemap_t::narray, file_entry_t::newsize, file_entry_t::oldsize, file_entry_t::pagemap, file_entry_t::path, remove_target(), rewind_copy_file_range(), and truncate_target_file().

Referenced by executeFileMap().

206 {
207  file_entry_t *entry;
208  int i;
209 
210  for (i = 0; i < map->narray; i++)
211  {
212  entry = map->array[i];
213  execute_pagemap(&entry->pagemap, entry->path);
214 
215  switch (entry->action)
216  {
217  case FILE_ACTION_NONE:
218  /* ok, do nothing.. */
219  break;
220 
221  case FILE_ACTION_COPY:
222  rewind_copy_file_range(entry->path, 0, entry->newsize, true);
223  break;
224 
226  truncate_target_file(entry->path, entry->newsize);
227  break;
228 
230  rewind_copy_file_range(entry->path, entry->oldsize,
231  entry->newsize, false);
232  break;
233 
234  case FILE_ACTION_CREATE:
235  create_target(entry);
236  break;
237 
238  case FILE_ACTION_REMOVE:
239  remove_target(entry);
240  break;
241  }
242  }
243 
245 }
static void rewind_copy_file_range(const char *path, off_t begin, off_t end, bool trunc)
Definition: copy_fetch.c:156
file_entry_t ** array
Definition: filemap.h:79
size_t newsize
Definition: filemap.h:51
datapagemap_t pagemap
Definition: filemap.h:54
int narray
Definition: filemap.h:80
void truncate_target_file(const char *path, off_t newsize)
Definition: file_ops.c:191
static void execute_pagemap(datapagemap_t *pagemap, const char *path)
Definition: copy_fetch.c:248
file_action_t action
Definition: filemap.h:47
size_t oldsize
Definition: filemap.h:50
void remove_target(file_entry_t *entry)
Definition: file_ops.c:125
char * path
Definition: filemap.h:44
void close_target_file(void)
Definition: file_ops.c:70
int i
Definition: filemap.h:42
void create_target(file_entry_t *entry)
Definition: file_ops.c:146

◆ executeFileMap()

void executeFileMap ( void  )

Definition at line 40 of file fetch.c.

References copy_executeFileMap(), datadir_source, filemap, and libpq_executeFileMap().

Referenced by main().

41 {
42  if (datadir_source)
44  else
46 }
filemap_t * filemap
Definition: filemap.c:24
void copy_executeFileMap(filemap_t *map)
Definition: copy_fetch.c:205
char * datadir_source
Definition: pg_rewind.c:55
void libpq_executeFileMap(filemap_t *map)
Definition: libpq_fetch.c:437

◆ fetchFile()

char* fetchFile ( const char *  filename,
size_t *  filesize 
)

Definition at line 54 of file fetch.c.

References datadir_source, libpqGetFile(), and slurpFile().

Referenced by getTimelineHistory(), and main().

55 {
56  if (datadir_source)
57  return slurpFile(datadir_source, filename, filesize);
58  else
59  return libpqGetFile(filename, filesize);
60 }
char * datadir_source
Definition: pg_rewind.c:55
char * libpqGetFile(const char *filename, size_t *filesize)
Definition: libpq_fetch.c:365
static char * filename
Definition: pg_dumpall.c:91
char * slurpFile(const char *datadir, const char *path, size_t *filesize)
Definition: file_ops.c:284

◆ fetchSourceFileList()

void fetchSourceFileList ( void  )

Definition at line 28 of file fetch.c.

References datadir_source, libpqProcessFileList(), process_source_file(), and traverse_datadir().

Referenced by main().

29 {
30  if (datadir_source)
32  else
34 }
void traverse_datadir(const char *datadir, process_file_callback_t callback)
Definition: copy_fetch.c:33
char * datadir_source
Definition: pg_rewind.c:55
void libpqProcessFileList(void)
Definition: libpq_fetch.c:171
void process_source_file(const char *path, file_type_t type, size_t newsize, const char *link_target)
Definition: filemap.c:136

◆ libpq_executeFileMap()

void libpq_executeFileMap ( filemap_t map)

Definition at line 437 of file libpq_fetch.c.

References file_entry_t::action, filemap_t::array, create_target(), execute_pagemap(), fetch_file_range(), FILE_ACTION_COPY, FILE_ACTION_COPY_TAIL, FILE_ACTION_CREATE, FILE_ACTION_NONE, FILE_ACTION_REMOVE, FILE_ACTION_TRUNCATE, i, filemap_t::narray, file_entry_t::newsize, file_entry_t::oldsize, open_target_file(), file_entry_t::pagemap, file_entry_t::path, pg_fatal, PGRES_COMMAND_OK, PGRES_COPY_IN, PQclear(), PQerrorMessage(), PQexec(), PQgetResult(), PQputCopyEnd(), PQresultErrorMessage(), PQresultStatus(), receiveFileChunks(), remove_target(), run_simple_command(), and truncate_target_file().

Referenced by executeFileMap().

438 {
439  file_entry_t *entry;
440  const char *sql;
441  PGresult *res;
442  int i;
443 
444  /*
445  * First create a temporary table, and load it with the blocks that we
446  * need to fetch.
447  */
448  sql = "CREATE TEMPORARY TABLE fetchchunks(path text, begin int8, len int4);";
449  run_simple_command(sql);
450 
451  sql = "COPY fetchchunks FROM STDIN";
452  res = PQexec(conn, sql);
453 
454  if (PQresultStatus(res) != PGRES_COPY_IN)
455  pg_fatal("could not send file list: %s",
456  PQresultErrorMessage(res));
457  PQclear(res);
458 
459  for (i = 0; i < map->narray; i++)
460  {
461  entry = map->array[i];
462 
463  /* If this is a relation file, copy the modified blocks */
464  execute_pagemap(&entry->pagemap, entry->path);
465 
466  switch (entry->action)
467  {
468  case FILE_ACTION_NONE:
469  /* nothing else to do */
470  break;
471 
472  case FILE_ACTION_COPY:
473  /* Truncate the old file out of the way, if any */
474  open_target_file(entry->path, true);
475  fetch_file_range(entry->path, 0, entry->newsize);
476  break;
477 
479  truncate_target_file(entry->path, entry->newsize);
480  break;
481 
483  fetch_file_range(entry->path, entry->oldsize, entry->newsize);
484  break;
485 
486  case FILE_ACTION_REMOVE:
487  remove_target(entry);
488  break;
489 
490  case FILE_ACTION_CREATE:
491  create_target(entry);
492  break;
493  }
494  }
495 
496  if (PQputCopyEnd(conn, NULL) != 1)
497  pg_fatal("could not send end-of-COPY: %s",
499 
500  while ((res = PQgetResult(conn)) != NULL)
501  {
502  if (PQresultStatus(res) != PGRES_COMMAND_OK)
503  pg_fatal("unexpected result while sending file list: %s",
504  PQresultErrorMessage(res));
505  PQclear(res);
506  }
507 
508  /*
509  * We've now copied the list of file ranges that we need to fetch to the
510  * temporary table. Now, actually fetch all of those ranges.
511  */
512  sql =
513  "SELECT path, begin,\n"
514  " pg_read_binary_file(path, begin, len, true) AS chunk\n"
515  "FROM fetchchunks\n";
516 
517  receiveFileChunks(sql);
518 }
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:6619
void open_target_file(const char *path, bool trunc)
Definition: file_ops.c:42
file_entry_t ** array
Definition: filemap.h:79
size_t newsize
Definition: filemap.h:51
#define pg_fatal(...)
Definition: pg_rewind.h:43
static void execute_pagemap(datapagemap_t *pagemap, const char *path)
Definition: libpq_fetch.c:521
int PQputCopyEnd(PGconn *conn, const char *errormsg)
Definition: fe-exec.c:2385
datapagemap_t pagemap
Definition: filemap.h:54
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:2693
int narray
Definition: filemap.h:80
void truncate_target_file(const char *path, off_t newsize)
Definition: file_ops.c:191
file_action_t action
Definition: filemap.h:47
static void receiveFileChunks(const char *sql)
Definition: libpq_fetch.c:256
size_t oldsize
Definition: filemap.h:50
PGconn * conn
Definition: libpq_fetch.c:27
static void run_simple_command(const char *sql)
Definition: libpq_fetch.c:131
void PQclear(PGresult *res)
Definition: fe-exec.c:695
void remove_target(file_entry_t *entry)
Definition: file_ops.c:125
char * path
Definition: filemap.h:44
char * PQresultErrorMessage(const PGresult *res)
Definition: fe-exec.c:2709
static void fetch_file_range(const char *path, uint64 begin, uint64 end)
Definition: libpq_fetch.c:408
int i
Definition: filemap.h:42
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:1940
void create_target(file_entry_t *entry)
Definition: file_ops.c:146
PGresult * PQgetResult(PGconn *conn)
Definition: fe-exec.c:1779

◆ libpqConnect()

void libpqConnect ( const char *  connstr)

Definition at line 44 of file libpq_fetch.c.

References ALWAYS_SECURE_SEARCH_PATH_SQL, CONNECTION_BAD, pg_fatal, pg_free(), pg_log_info, PGRES_TUPLES_OK, PQclear(), PQconnectdb(), PQerrorMessage(), PQexec(), PQresultErrorMessage(), PQresultStatus(), PQstatus(), run_simple_command(), run_simple_query(), showprogress, and generate_unaccent_rules::str.

Referenced by main().

45 {
46  char *str;
47  PGresult *res;
48 
51  pg_fatal("could not connect to server: %s",
53 
54  if (showprogress)
55  pg_log_info("connected to server");
56 
57  /* disable all types of timeouts */
58  run_simple_command("SET statement_timeout = 0");
59  run_simple_command("SET lock_timeout = 0");
60  run_simple_command("SET idle_in_transaction_session_timeout = 0");
61 
63  if (PQresultStatus(res) != PGRES_TUPLES_OK)
64  pg_fatal("could not clear search_path: %s",
66  PQclear(res);
67 
68  /*
69  * Check that the server is not in hot standby mode. There is no
70  * fundamental reason that couldn't be made to work, but it doesn't
71  * currently because we use a temporary table. Better to check for it
72  * explicitly than error out, for a better error message.
73  */
74  str = run_simple_query("SELECT pg_is_in_recovery()");
75  if (strcmp(str, "f") != 0)
76  pg_fatal("source server must not be in recovery mode");
77  pg_free(str);
78 
79  /*
80  * Also check that full_page_writes is enabled. We can get torn pages if
81  * a page is modified while we read it with pg_read_binary_file(), and we
82  * rely on full page images to fix them.
83  */
84  str = run_simple_query("SHOW full_page_writes");
85  if (strcmp(str, "on") != 0)
86  pg_fatal("full_page_writes must be enabled in the source server");
87  pg_free(str);
88 
89  /*
90  * Although we don't do any "real" updates, we do work with a temporary
91  * table. We don't care about synchronous commit for that. It doesn't
92  * otherwise matter much, but if the server is using synchronous
93  * replication, and replication isn't working for some reason, we don't
94  * want to get stuck, waiting for it to start working again.
95  */
96  run_simple_command("SET synchronous_commit = off");
97 }
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:6619
#define pg_fatal(...)
Definition: pg_rewind.h:43
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:2693
static char * run_simple_query(const char *sql)
Definition: libpq_fetch.c:104
PGconn * conn
Definition: libpq_fetch.c:27
static bool showprogress
Definition: pg_basebackup.c:89
static void run_simple_command(const char *sql)
Definition: libpq_fetch.c:131
void PQclear(PGresult *res)
Definition: fe-exec.c:695
void pg_free(void *ptr)
Definition: fe_memutils.c:105
#define ALWAYS_SECURE_SEARCH_PATH_SQL
Definition: connect.h:25
char * PQresultErrorMessage(const PGresult *res)
Definition: fe-exec.c:2709
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:1940
ConnStatusType PQstatus(const PGconn *conn)
Definition: fe-connect.c:6566
#define pg_log_info(...)
Definition: logging.h:87
PGconn * PQconnectdb(const char *conninfo)
Definition: fe-connect.c:678
static char * connstr
Definition: pg_dumpall.c:62

◆ libpqGetCurrentXlogInsertLocation()

XLogRecPtr libpqGetCurrentXlogInsertLocation ( void  )

Definition at line 148 of file libpq_fetch.c.

References pg_fatal, pg_free(), run_simple_query(), and val.

Referenced by main().

149 {
150  XLogRecPtr result;
151  uint32 hi;
152  uint32 lo;
153  char *val;
154 
155  val = run_simple_query("SELECT pg_current_wal_insert_lsn()");
156 
157  if (sscanf(val, "%X/%X", &hi, &lo) != 2)
158  pg_fatal("unrecognized result \"%s\" for current WAL insert location", val);
159 
160  result = ((uint64) hi) << 32 | lo;
161 
162  pg_free(val);
163 
164  return result;
165 }
#define pg_fatal(...)
Definition: pg_rewind.h:43
static char * run_simple_query(const char *sql)
Definition: libpq_fetch.c:104
unsigned int uint32
Definition: c.h:358
uint64 XLogRecPtr
Definition: xlogdefs.h:21
void pg_free(void *ptr)
Definition: fe_memutils.c:105
long val
Definition: informix.c:684

◆ libpqGetFile()

char* libpqGetFile ( const char *  filename,
size_t *  filesize 
)

Definition at line 365 of file libpq_fetch.c.

References filename, pg_fatal, pg_log_debug, pg_malloc(), PGRES_TUPLES_OK, PQclear(), PQexecParams(), PQgetisnull(), PQgetlength(), PQgetvalue(), PQntuples(), PQresultErrorMessage(), and PQresultStatus().

Referenced by fetchFile().

366 {
367  PGresult *res;
368  char *result;
369  int len;
370  const char *paramValues[1];
371 
372  paramValues[0] = filename;
373  res = PQexecParams(conn, "SELECT pg_read_binary_file($1)",
374  1, NULL, paramValues, NULL, NULL, 1);
375 
376  if (PQresultStatus(res) != PGRES_TUPLES_OK)
377  pg_fatal("could not fetch remote file \"%s\": %s",
379 
380  /* sanity check the result set */
381  if (PQntuples(res) != 1 || PQgetisnull(res, 0, 0))
382  pg_fatal("unexpected result set while fetching remote file \"%s\"",
383  filename);
384 
385  /* Read result to local variables */
386  len = PQgetlength(res, 0, 0);
387  result = pg_malloc(len + 1);
388  memcpy(result, PQgetvalue(res, 0, 0), len);
389  result[len] = '\0';
390 
391  PQclear(res);
392 
393  pg_log_debug("fetched file \"%s\", length %d", filename, len);
394 
395  if (filesize)
396  *filesize = len;
397  return result;
398 }
int PQgetlength(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3175
char * PQgetvalue(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3164
void * pg_malloc(size_t size)
Definition: fe_memutils.c:47
#define pg_fatal(...)
Definition: pg_rewind.h:43
int PQntuples(const PGresult *res)
Definition: fe-exec.c:2770
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:2693
#define pg_log_debug(...)
Definition: logging.h:91
PGconn * conn
Definition: libpq_fetch.c:27
void PQclear(PGresult *res)
Definition: fe-exec.c:695
static char * filename
Definition: pg_dumpall.c:91
char * PQresultErrorMessage(const PGresult *res)
Definition: fe-exec.c:2709
PGresult * PQexecParams(PGconn *conn, const char *command, int nParams, const Oid *paramTypes, const char *const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat)
Definition: fe-exec.c:1954
int PQgetisnull(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3189

◆ libpqProcessFileList()

void libpqProcessFileList ( void  )

Definition at line 171 of file libpq_fetch.c.

References FILE_TYPE_DIRECTORY, FILE_TYPE_REGULAR, FILE_TYPE_SYMLINK, i, pg_fatal, PGRES_TUPLES_OK, PQclear(), PQexec(), PQgetisnull(), PQgetvalue(), PQnfields(), PQntuples(), PQresultErrorMessage(), PQresultStatus(), process_source_file(), and generate_unaccent_rules::type.

Referenced by fetchSourceFileList().

172 {
173  PGresult *res;
174  const char *sql;
175  int i;
176 
177  /*
178  * Create a recursive directory listing of the whole data directory.
179  *
180  * The WITH RECURSIVE part does most of the work. The second part gets the
181  * targets of the symlinks in pg_tblspc directory.
182  *
183  * XXX: There is no backend function to get a symbolic link's target in
184  * general, so if the admin has put any custom symbolic links in the data
185  * directory, they won't be copied correctly.
186  */
187  sql =
188  "WITH RECURSIVE files (path, filename, size, isdir) AS (\n"
189  " SELECT '' AS path, filename, size, isdir FROM\n"
190  " (SELECT pg_ls_dir('.', true, false) AS filename) AS fn,\n"
191  " pg_stat_file(fn.filename, true) AS this\n"
192  " UNION ALL\n"
193  " SELECT parent.path || parent.filename || '/' AS path,\n"
194  " fn, this.size, this.isdir\n"
195  " FROM files AS parent,\n"
196  " pg_ls_dir(parent.path || parent.filename, true, false) AS fn,\n"
197  " pg_stat_file(parent.path || parent.filename || '/' || fn, true) AS this\n"
198  " WHERE parent.isdir = 't'\n"
199  ")\n"
200  "SELECT path || filename, size, isdir,\n"
201  " pg_tablespace_location(pg_tablespace.oid) AS link_target\n"
202  "FROM files\n"
203  "LEFT OUTER JOIN pg_tablespace ON files.path = 'pg_tblspc/'\n"
204  " AND oid::text = files.filename\n";
205  res = PQexec(conn, sql);
206 
207  if (PQresultStatus(res) != PGRES_TUPLES_OK)
208  pg_fatal("could not fetch file list: %s",
209  PQresultErrorMessage(res));
210 
211  /* sanity check the result set */
212  if (PQnfields(res) != 4)
213  pg_fatal("unexpected result set while fetching file list");
214 
215  /* Read result to local variables */
216  for (i = 0; i < PQntuples(res); i++)
217  {
218  char *path = PQgetvalue(res, i, 0);
219  int64 filesize = atol(PQgetvalue(res, i, 1));
220  bool isdir = (strcmp(PQgetvalue(res, i, 2), "t") == 0);
221  char *link_target = PQgetvalue(res, i, 3);
223 
224  if (PQgetisnull(res, 0, 1))
225  {
226  /*
227  * The file was removed from the server while the query was
228  * running. Ignore it.
229  */
230  continue;
231  }
232 
233  if (link_target[0])
234  type = FILE_TYPE_SYMLINK;
235  else if (isdir)
236  type = FILE_TYPE_DIRECTORY;
237  else
238  type = FILE_TYPE_REGULAR;
239 
240  process_source_file(path, type, filesize, link_target);
241  }
242  PQclear(res);
243 }
int PQnfields(const PGresult *res)
Definition: fe-exec.c:2778
char * PQgetvalue(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3164
#define pg_fatal(...)
Definition: pg_rewind.h:43
int PQntuples(const PGresult *res)
Definition: fe-exec.c:2770
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:2693
PGconn * conn
Definition: libpq_fetch.c:27
void PQclear(PGresult *res)
Definition: fe-exec.c:695
void process_source_file(const char *path, file_type_t type, size_t newsize, const char *link_target)
Definition: filemap.c:136
char * PQresultErrorMessage(const PGresult *res)
Definition: fe-exec.c:2709
int i
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:1940
file_type_t
Definition: filemap.h:35
int PQgetisnull(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3189

◆ traverse_datadir()

void traverse_datadir ( const char *  datadir,
process_file_callback_t  callback 
)

Definition at line 33 of file copy_fetch.c.

References recurse_dir().

Referenced by fetchSourceFileList(), and main().

34 {
36 }
static void recurse_dir(const char *datadir, const char *path, process_file_callback_t callback)
Definition: copy_fetch.c:45
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:48
char * datadir