PostgreSQL Source Code  git master
streamutil.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * streamutil.c - utility functions for pg_basebackup, pg_receivewal and
4  * pg_recvlogical
5  *
6  * Author: Magnus Hagander <magnus@hagander.net>
7  *
8  * Portions Copyright (c) 1996-2024, PostgreSQL Global Development Group
9  *
10  * IDENTIFICATION
11  * src/bin/pg_basebackup/streamutil.c
12  *-------------------------------------------------------------------------
13  */
14 
15 #include "postgres_fe.h"
16 
17 #include <sys/time.h>
18 #include <unistd.h>
19 
20 #include "access/xlog_internal.h"
21 #include "common/connect.h"
22 #include "common/fe_memutils.h"
23 #include "common/file_perm.h"
24 #include "common/logging.h"
25 #include "common/string.h"
26 #include "datatype/timestamp.h"
27 #include "port/pg_bswap.h"
28 #include "pqexpbuffer.h"
29 #include "receivelog.h"
30 #include "streamutil.h"
31 
32 #define ERRCODE_DUPLICATE_OBJECT "42710"
33 
35 
37 static char *FindDbnameInConnParams(PQconninfoOption *conn_opts);
38 
39 /* SHOW command for replication connection was introduced in version 10 */
40 #define MINIMUM_VERSION_FOR_SHOW_CMD 100000
41 
42 /*
43  * Group access is supported from version 11.
44  */
45 #define MINIMUM_VERSION_FOR_GROUP_ACCESS 110000
46 
47 const char *progname;
48 char *connection_string = NULL;
49 char *dbhost = NULL;
50 char *dbuser = NULL;
51 char *dbport = NULL;
52 char *dbname = NULL;
53 int dbgetpassword = 0; /* 0=auto, -1=never, 1=always */
54 static char *password = NULL;
55 PGconn *conn = NULL;
56 
57 /*
58  * Connect to the server. Returns a valid PGconn pointer if connected,
59  * or NULL on non-permanent error. On permanent error, the function will
60  * call exit(1) directly.
61  */
62 PGconn *
64 {
65  PGconn *tmpconn;
66  int argcount = 7; /* dbname, replication, fallback_app_name,
67  * host, user, port, password */
68  int i;
69  const char **keywords;
70  const char **values;
71  const char *tmpparam;
72  bool need_password;
73  PQconninfoOption *conn_opts = NULL;
74  PQconninfoOption *conn_opt;
75  char *err_msg = NULL;
76 
77  /* pg_recvlogical uses dbname only; others use connection_string only. */
78  Assert(dbname == NULL || connection_string == NULL);
79 
80  /*
81  * Merge the connection info inputs given in form of connection string,
82  * options and default values (dbname=replication, replication=true, etc.)
83  */
84  i = 0;
86  {
87  conn_opts = PQconninfoParse(connection_string, &err_msg);
88  if (conn_opts == NULL)
89  pg_fatal("%s", err_msg);
90 
91  for (conn_opt = conn_opts; conn_opt->keyword != NULL; conn_opt++)
92  {
93  if (conn_opt->val != NULL && conn_opt->val[0] != '\0')
94  argcount++;
95  }
96 
97  keywords = pg_malloc0((argcount + 1) * sizeof(*keywords));
98  values = pg_malloc0((argcount + 1) * sizeof(*values));
99 
100  /*
101  * Set dbname here already, so it can be overridden by a dbname in the
102  * connection string.
103  */
104  keywords[i] = "dbname";
105  values[i] = "replication";
106  i++;
107 
108  for (conn_opt = conn_opts; conn_opt->keyword != NULL; conn_opt++)
109  {
110  if (conn_opt->val != NULL && conn_opt->val[0] != '\0')
111  {
112  keywords[i] = conn_opt->keyword;
113  values[i] = conn_opt->val;
114  i++;
115  }
116  }
117  }
118  else
119  {
120  keywords = pg_malloc0((argcount + 1) * sizeof(*keywords));
121  values = pg_malloc0((argcount + 1) * sizeof(*values));
122  keywords[i] = "dbname";
123  values[i] = dbname;
124  i++;
125  }
126 
127  keywords[i] = "replication";
128  values[i] = dbname == NULL ? "true" : "database";
129  i++;
130  keywords[i] = "fallback_application_name";
131  values[i] = progname;
132  i++;
133 
134  if (dbhost)
135  {
136  keywords[i] = "host";
137  values[i] = dbhost;
138  i++;
139  }
140  if (dbuser)
141  {
142  keywords[i] = "user";
143  values[i] = dbuser;
144  i++;
145  }
146  if (dbport)
147  {
148  keywords[i] = "port";
149  values[i] = dbport;
150  i++;
151  }
152 
153  /* If -W was given, force prompt for password, but only the first time */
154  need_password = (dbgetpassword == 1 && !password);
155 
156  do
157  {
158  /* Get a new password if appropriate */
159  if (need_password)
160  {
161  free(password);
162  password = simple_prompt("Password: ", false);
163  need_password = false;
164  }
165 
166  /* Use (or reuse, on a subsequent connection) password if we have it */
167  if (password)
168  {
169  keywords[i] = "password";
170  values[i] = password;
171  }
172  else
173  {
174  keywords[i] = NULL;
175  values[i] = NULL;
176  }
177 
178  /*
179  * Only expand dbname when we did not already parse the argument as a
180  * connection string ourselves.
181  */
182  tmpconn = PQconnectdbParams(keywords, values, !connection_string);
183 
184  /*
185  * If there is too little memory even to allocate the PGconn object
186  * and PQconnectdbParams returns NULL, we call exit(1) directly.
187  */
188  if (!tmpconn)
189  pg_fatal("could not connect to server");
190 
191  /* If we need a password and -w wasn't given, loop back and get one */
192  if (PQstatus(tmpconn) == CONNECTION_BAD &&
193  PQconnectionNeedsPassword(tmpconn) &&
194  dbgetpassword != -1)
195  {
196  PQfinish(tmpconn);
197  need_password = true;
198  }
199  }
200  while (need_password);
201 
202  if (PQstatus(tmpconn) != CONNECTION_OK)
203  {
204  pg_log_error("%s", PQerrorMessage(tmpconn));
205  PQfinish(tmpconn);
206  free(values);
207  free(keywords);
208  PQconninfoFree(conn_opts);
209  return NULL;
210  }
211 
212  /* Connection ok! */
213  free(values);
214  free(keywords);
215  PQconninfoFree(conn_opts);
216 
217  /*
218  * Set always-secure search path, so malicious users can't get control.
219  * The capacity to run normal SQL queries was added in PostgreSQL 10, so
220  * the search path cannot be changed (by us or attackers) on earlier
221  * versions.
222  */
223  if (dbname != NULL && PQserverVersion(tmpconn) >= 100000)
224  {
225  PGresult *res;
226 
229  {
230  pg_log_error("could not clear \"search_path\": %s",
231  PQerrorMessage(tmpconn));
232  PQclear(res);
233  PQfinish(tmpconn);
234  exit(1);
235  }
236  PQclear(res);
237  }
238 
239  /*
240  * Ensure we have the same value of integer_datetimes (now always "on") as
241  * the server we are connecting to.
242  */
243  tmpparam = PQparameterStatus(tmpconn, "integer_datetimes");
244  if (!tmpparam)
245  {
246  pg_log_error("could not determine server setting for \"integer_datetimes\"");
247  PQfinish(tmpconn);
248  exit(1);
249  }
250 
251  if (strcmp(tmpparam, "on") != 0)
252  {
253  pg_log_error("\"integer_datetimes\" compile flag does not match server");
254  PQfinish(tmpconn);
255  exit(1);
256  }
257 
258  /*
259  * Retrieve the source data directory mode and use it to construct a umask
260  * for creating directories and files.
261  */
262  if (!RetrieveDataDirCreatePerm(tmpconn))
263  {
264  PQfinish(tmpconn);
265  exit(1);
266  }
267 
268  return tmpconn;
269 }
270 
271 /*
272  * FindDbnameInConnParams
273  *
274  * This is a helper function for GetDbnameFromConnectionOptions(). Extract
275  * the value of dbname from PQconninfoOption parameters, if it's present.
276  * Returns a strdup'd result or NULL.
277  */
278 static char *
280 {
281  PQconninfoOption *conn_opt;
282 
283  for (conn_opt = conn_opts; conn_opt->keyword != NULL; conn_opt++)
284  {
285  if (strcmp(conn_opt->keyword, "dbname") == 0 &&
286  conn_opt->val != NULL && conn_opt->val[0] != '\0')
287  return pg_strdup(conn_opt->val);
288  }
289  return NULL;
290 }
291 
292 /*
293  * GetDbnameFromConnectionOptions
294  *
295  * This is a special purpose function to retrieve the dbname from either the
296  * connection_string specified by the user or from the environment variables.
297  *
298  * We follow GetConnection() to fetch the dbname from various connection
299  * options.
300  *
301  * Returns NULL, if dbname is not specified by the user in the above
302  * mentioned connection options.
303  */
304 char *
306 {
307  PQconninfoOption *conn_opts;
308  char *err_msg = NULL;
309  char *dbname;
310 
311  /* First try to get the dbname from connection string. */
312  if (connection_string)
313  {
314  conn_opts = PQconninfoParse(connection_string, &err_msg);
315  if (conn_opts == NULL)
316  pg_fatal("%s", err_msg);
317 
318  dbname = FindDbnameInConnParams(conn_opts);
319 
320  PQconninfoFree(conn_opts);
321  if (dbname)
322  return dbname;
323  }
324 
325  /*
326  * Next try to get the dbname from default values that are available from
327  * the environment.
328  */
329  conn_opts = PQconndefaults();
330  if (conn_opts == NULL)
331  pg_fatal("out of memory");
332 
333  dbname = FindDbnameInConnParams(conn_opts);
334 
335  PQconninfoFree(conn_opts);
336  return dbname;
337 }
338 
339 /*
340  * From version 10, explicitly set wal segment size using SHOW wal_segment_size
341  * since ControlFile is not accessible here.
342  */
343 bool
345 {
346  PGresult *res;
347  char xlog_unit[3];
348  int xlog_val,
349  multiplier = 1;
350 
351  /* check connection existence */
352  Assert(conn != NULL);
353 
354  /* for previous versions set the default xlog seg size */
356  {
358  return true;
359  }
360 
361  res = PQexec(conn, "SHOW wal_segment_size");
363  {
364  pg_log_error("could not send replication command \"%s\": %s",
365  "SHOW wal_segment_size", PQerrorMessage(conn));
366 
367  PQclear(res);
368  return false;
369  }
370  if (PQntuples(res) != 1 || PQnfields(res) < 1)
371  {
372  pg_log_error("could not fetch WAL segment size: got %d rows and %d fields, expected %d rows and %d or more fields",
373  PQntuples(res), PQnfields(res), 1, 1);
374 
375  PQclear(res);
376  return false;
377  }
378 
379  /* fetch xlog value and unit from the result */
380  if (sscanf(PQgetvalue(res, 0, 0), "%d%2s", &xlog_val, xlog_unit) != 2)
381  {
382  pg_log_error("WAL segment size could not be parsed");
383  PQclear(res);
384  return false;
385  }
386 
387  PQclear(res);
388 
389  /* set the multiplier based on unit to convert xlog_val to bytes */
390  if (strcmp(xlog_unit, "MB") == 0)
391  multiplier = 1024 * 1024;
392  else if (strcmp(xlog_unit, "GB") == 0)
393  multiplier = 1024 * 1024 * 1024;
394 
395  /* convert and set WalSegSz */
396  WalSegSz = xlog_val * multiplier;
397 
399  {
400  pg_log_error(ngettext("remote server reported invalid WAL segment size (%d byte)",
401  "remote server reported invalid WAL segment size (%d bytes)",
402  WalSegSz),
403  WalSegSz);
404  pg_log_error_detail("The WAL segment size must be a power of two between 1 MB and 1 GB.");
405  return false;
406  }
407 
408  return true;
409 }
410 
411 /*
412  * RetrieveDataDirCreatePerm
413  *
414  * This function is used to determine the privileges on the server's PG data
415  * directory and, based on that, set what the permissions will be for
416  * directories and files we create.
417  *
418  * PG11 added support for (optionally) group read/execute rights to be set on
419  * the data directory. Prior to PG11, only the owner was allowed to have rights
420  * on the data directory.
421  */
422 static bool
424 {
425  PGresult *res;
427 
428  /* check connection existence */
429  Assert(conn != NULL);
430 
431  /* for previous versions leave the default group access */
433  return true;
434 
435  res = PQexec(conn, "SHOW data_directory_mode");
437  {
438  pg_log_error("could not send replication command \"%s\": %s",
439  "SHOW data_directory_mode", PQerrorMessage(conn));
440 
441  PQclear(res);
442  return false;
443  }
444  if (PQntuples(res) != 1 || PQnfields(res) < 1)
445  {
446  pg_log_error("could not fetch group access flag: got %d rows and %d fields, expected %d rows and %d or more fields",
447  PQntuples(res), PQnfields(res), 1, 1);
448 
449  PQclear(res);
450  return false;
451  }
452 
453  if (sscanf(PQgetvalue(res, 0, 0), "%o", &data_directory_mode) != 1)
454  {
455  pg_log_error("group access flag could not be parsed: %s",
456  PQgetvalue(res, 0, 0));
457 
458  PQclear(res);
459  return false;
460  }
461 
463 
464  PQclear(res);
465  return true;
466 }
467 
468 /*
469  * Run IDENTIFY_SYSTEM through a given connection and give back to caller
470  * some result information if requested:
471  * - System identifier
472  * - Current timeline ID
473  * - Start LSN position
474  * - Database name (NULL in servers prior to 9.4)
475  */
476 bool
477 RunIdentifySystem(PGconn *conn, char **sysid, TimeLineID *starttli,
478  XLogRecPtr *startpos, char **db_name)
479 {
480  PGresult *res;
481  uint32 hi,
482  lo;
483 
484  /* Check connection existence */
485  Assert(conn != NULL);
486 
487  res = PQexec(conn, "IDENTIFY_SYSTEM");
489  {
490  pg_log_error("could not send replication command \"%s\": %s",
491  "IDENTIFY_SYSTEM", PQerrorMessage(conn));
492 
493  PQclear(res);
494  return false;
495  }
496  if (PQntuples(res) != 1 || PQnfields(res) < 3)
497  {
498  pg_log_error("could not identify system: got %d rows and %d fields, expected %d rows and %d or more fields",
499  PQntuples(res), PQnfields(res), 1, 3);
500 
501  PQclear(res);
502  return false;
503  }
504 
505  /* Get system identifier */
506  if (sysid != NULL)
507  *sysid = pg_strdup(PQgetvalue(res, 0, 0));
508 
509  /* Get timeline ID to start streaming from */
510  if (starttli != NULL)
511  *starttli = atoi(PQgetvalue(res, 0, 1));
512 
513  /* Get LSN start position if necessary */
514  if (startpos != NULL)
515  {
516  if (sscanf(PQgetvalue(res, 0, 2), "%X/%X", &hi, &lo) != 2)
517  {
518  pg_log_error("could not parse write-ahead log location \"%s\"",
519  PQgetvalue(res, 0, 2));
520 
521  PQclear(res);
522  return false;
523  }
524  *startpos = ((uint64) hi) << 32 | lo;
525  }
526 
527  /* Get database name, only available in 9.4 and newer versions */
528  if (db_name != NULL)
529  {
530  *db_name = NULL;
531  if (PQserverVersion(conn) >= 90400)
532  {
533  if (PQnfields(res) < 4)
534  {
535  pg_log_error("could not identify system: got %d rows and %d fields, expected %d rows and %d or more fields",
536  PQntuples(res), PQnfields(res), 1, 4);
537 
538  PQclear(res);
539  return false;
540  }
541  if (!PQgetisnull(res, 0, 3))
542  *db_name = pg_strdup(PQgetvalue(res, 0, 3));
543  }
544  }
545 
546  PQclear(res);
547  return true;
548 }
549 
550 /*
551  * Run READ_REPLICATION_SLOT through a given connection and give back to
552  * caller some result information if requested for this slot:
553  * - Start LSN position, InvalidXLogRecPtr if unknown.
554  * - Current timeline ID, 0 if unknown.
555  * Returns false on failure, and true otherwise.
556  */
557 bool
558 GetSlotInformation(PGconn *conn, const char *slot_name,
559  XLogRecPtr *restart_lsn, TimeLineID *restart_tli)
560 {
561  PGresult *res;
562  PQExpBuffer query;
563  XLogRecPtr lsn_loc = InvalidXLogRecPtr;
564  TimeLineID tli_loc = 0;
565 
566  if (restart_lsn)
567  *restart_lsn = lsn_loc;
568  if (restart_tli)
569  *restart_tli = tli_loc;
570 
571  query = createPQExpBuffer();
572  appendPQExpBuffer(query, "READ_REPLICATION_SLOT %s", slot_name);
573  res = PQexec(conn, query->data);
574  destroyPQExpBuffer(query);
575 
577  {
578  pg_log_error("could not send replication command \"%s\": %s",
579  "READ_REPLICATION_SLOT", PQerrorMessage(conn));
580  PQclear(res);
581  return false;
582  }
583 
584  /* The command should always return precisely one tuple and three fields */
585  if (PQntuples(res) != 1 || PQnfields(res) != 3)
586  {
587  pg_log_error("could not read replication slot \"%s\": got %d rows and %d fields, expected %d rows and %d fields",
588  slot_name, PQntuples(res), PQnfields(res), 1, 3);
589  PQclear(res);
590  return false;
591  }
592 
593  /*
594  * When the slot doesn't exist, the command returns a tuple with NULL
595  * values. This checks only the slot type field.
596  */
597  if (PQgetisnull(res, 0, 0))
598  {
599  pg_log_error("replication slot \"%s\" does not exist", slot_name);
600  PQclear(res);
601  return false;
602  }
603 
604  /*
605  * Note that this cannot happen as READ_REPLICATION_SLOT supports only
606  * physical slots, but play it safe.
607  */
608  if (strcmp(PQgetvalue(res, 0, 0), "physical") != 0)
609  {
610  pg_log_error("expected a physical replication slot, got type \"%s\" instead",
611  PQgetvalue(res, 0, 0));
612  PQclear(res);
613  return false;
614  }
615 
616  /* restart LSN */
617  if (!PQgetisnull(res, 0, 1))
618  {
619  uint32 hi,
620  lo;
621 
622  if (sscanf(PQgetvalue(res, 0, 1), "%X/%X", &hi, &lo) != 2)
623  {
624  pg_log_error("could not parse restart_lsn \"%s\" for replication slot \"%s\"",
625  PQgetvalue(res, 0, 1), slot_name);
626  PQclear(res);
627  return false;
628  }
629  lsn_loc = ((uint64) hi) << 32 | lo;
630  }
631 
632  /* current TLI */
633  if (!PQgetisnull(res, 0, 2))
634  tli_loc = (TimeLineID) atol(PQgetvalue(res, 0, 2));
635 
636  PQclear(res);
637 
638  /* Assign results if requested */
639  if (restart_lsn)
640  *restart_lsn = lsn_loc;
641  if (restart_tli)
642  *restart_tli = tli_loc;
643 
644  return true;
645 }
646 
647 /*
648  * Create a replication slot for the given connection. This function
649  * returns true in case of success.
650  */
651 bool
652 CreateReplicationSlot(PGconn *conn, const char *slot_name, const char *plugin,
653  bool is_temporary, bool is_physical, bool reserve_wal,
654  bool slot_exists_ok, bool two_phase)
655 {
656  PQExpBuffer query;
657  PGresult *res;
658  bool use_new_option_syntax = (PQserverVersion(conn) >= 150000);
659 
660  query = createPQExpBuffer();
661 
662  Assert((is_physical && plugin == NULL) ||
663  (!is_physical && plugin != NULL));
664  Assert(!(two_phase && is_physical));
665  Assert(slot_name != NULL);
666 
667  /* Build base portion of query */
668  appendPQExpBuffer(query, "CREATE_REPLICATION_SLOT \"%s\"", slot_name);
669  if (is_temporary)
670  appendPQExpBufferStr(query, " TEMPORARY");
671  if (is_physical)
672  appendPQExpBufferStr(query, " PHYSICAL");
673  else
674  appendPQExpBuffer(query, " LOGICAL \"%s\"", plugin);
675 
676  /* Add any requested options */
677  if (use_new_option_syntax)
678  appendPQExpBufferStr(query, " (");
679  if (is_physical)
680  {
681  if (reserve_wal)
682  AppendPlainCommandOption(query, use_new_option_syntax,
683  "RESERVE_WAL");
684  }
685  else
686  {
687  if (two_phase && PQserverVersion(conn) >= 150000)
688  AppendPlainCommandOption(query, use_new_option_syntax,
689  "TWO_PHASE");
690 
691  if (PQserverVersion(conn) >= 100000)
692  {
693  /* pg_recvlogical doesn't use an exported snapshot, so suppress */
694  if (use_new_option_syntax)
695  AppendStringCommandOption(query, use_new_option_syntax,
696  "SNAPSHOT", "nothing");
697  else
698  AppendPlainCommandOption(query, use_new_option_syntax,
699  "NOEXPORT_SNAPSHOT");
700  }
701  }
702  if (use_new_option_syntax)
703  {
704  /* Suppress option list if it would be empty, otherwise terminate */
705  if (query->data[query->len - 1] == '(')
706  {
707  query->len -= 2;
708  query->data[query->len] = '\0';
709  }
710  else
711  appendPQExpBufferChar(query, ')');
712  }
713 
714  /* Now run the query */
715  res = PQexec(conn, query->data);
717  {
718  const char *sqlstate = PQresultErrorField(res, PG_DIAG_SQLSTATE);
719 
720  if (slot_exists_ok &&
721  sqlstate &&
722  strcmp(sqlstate, ERRCODE_DUPLICATE_OBJECT) == 0)
723  {
724  destroyPQExpBuffer(query);
725  PQclear(res);
726  return true;
727  }
728  else
729  {
730  pg_log_error("could not send replication command \"%s\": %s",
731  query->data, PQerrorMessage(conn));
732 
733  destroyPQExpBuffer(query);
734  PQclear(res);
735  return false;
736  }
737  }
738 
739  if (PQntuples(res) != 1 || PQnfields(res) != 4)
740  {
741  pg_log_error("could not create replication slot \"%s\": got %d rows and %d fields, expected %d rows and %d fields",
742  slot_name,
743  PQntuples(res), PQnfields(res), 1, 4);
744 
745  destroyPQExpBuffer(query);
746  PQclear(res);
747  return false;
748  }
749 
750  destroyPQExpBuffer(query);
751  PQclear(res);
752  return true;
753 }
754 
755 /*
756  * Drop a replication slot for the given connection. This function
757  * returns true in case of success.
758  */
759 bool
760 DropReplicationSlot(PGconn *conn, const char *slot_name)
761 {
762  PQExpBuffer query;
763  PGresult *res;
764 
765  Assert(slot_name != NULL);
766 
767  query = createPQExpBuffer();
768 
769  /* Build query */
770  appendPQExpBuffer(query, "DROP_REPLICATION_SLOT \"%s\"",
771  slot_name);
772  res = PQexec(conn, query->data);
774  {
775  pg_log_error("could not send replication command \"%s\": %s",
776  query->data, PQerrorMessage(conn));
777 
778  destroyPQExpBuffer(query);
779  PQclear(res);
780  return false;
781  }
782 
783  if (PQntuples(res) != 0 || PQnfields(res) != 0)
784  {
785  pg_log_error("could not drop replication slot \"%s\": got %d rows and %d fields, expected %d rows and %d fields",
786  slot_name,
787  PQntuples(res), PQnfields(res), 0, 0);
788 
789  destroyPQExpBuffer(query);
790  PQclear(res);
791  return false;
792  }
793 
794  destroyPQExpBuffer(query);
795  PQclear(res);
796  return true;
797 }
798 
799 /*
800  * Append a "plain" option - one with no value - to a server command that
801  * is being constructed.
802  *
803  * In the old syntax, all options were parser keywords, so you could just
804  * write things like SOME_COMMAND OPTION1 OPTION2 'opt2value' OPTION3 42. The
805  * new syntax uses a comma-separated list surrounded by parentheses, so the
806  * equivalent is SOME_COMMAND (OPTION1, OPTION2 'optvalue', OPTION3 42).
807  */
808 void
809 AppendPlainCommandOption(PQExpBuffer buf, bool use_new_option_syntax,
810  char *option_name)
811 {
812  if (buf->len > 0 && buf->data[buf->len - 1] != '(')
813  {
814  if (use_new_option_syntax)
815  appendPQExpBufferStr(buf, ", ");
816  else
818  }
819 
820  appendPQExpBuffer(buf, " %s", option_name);
821 }
822 
823 /*
824  * Append an option with an associated string value to a server command that
825  * is being constructed.
826  *
827  * See comments for AppendPlainCommandOption, above.
828  */
829 void
830 AppendStringCommandOption(PQExpBuffer buf, bool use_new_option_syntax,
831  char *option_name, char *option_value)
832 {
833  AppendPlainCommandOption(buf, use_new_option_syntax, option_name);
834 
835  if (option_value != NULL)
836  {
837  size_t length = strlen(option_value);
838  char *escaped_value = palloc(1 + 2 * length);
839 
840  PQescapeStringConn(conn, escaped_value, option_value, length, NULL);
841  appendPQExpBuffer(buf, " '%s'", escaped_value);
842  pfree(escaped_value);
843  }
844 }
845 
846 /*
847  * Append an option with an associated integer value to a server command
848  * is being constructed.
849  *
850  * See comments for AppendPlainCommandOption, above.
851  */
852 void
853 AppendIntegerCommandOption(PQExpBuffer buf, bool use_new_option_syntax,
854  char *option_name, int32 option_value)
855 {
856  AppendPlainCommandOption(buf, use_new_option_syntax, option_name);
857 
858  appendPQExpBuffer(buf, " %d", option_value);
859 }
860 
861 /*
862  * Frontend version of GetCurrentTimestamp(), since we are not linked with
863  * backend code.
864  */
867 {
868  TimestampTz result;
869  struct timeval tp;
870 
871  gettimeofday(&tp, NULL);
872 
873  result = (TimestampTz) tp.tv_sec -
875  result = (result * USECS_PER_SEC) + tp.tv_usec;
876 
877  return result;
878 }
879 
880 /*
881  * Frontend version of TimestampDifference(), since we are not linked with
882  * backend code.
883  */
884 void
886  long *secs, int *microsecs)
887 {
888  TimestampTz diff = stop_time - start_time;
889 
890  if (diff <= 0)
891  {
892  *secs = 0;
893  *microsecs = 0;
894  }
895  else
896  {
897  *secs = (long) (diff / USECS_PER_SEC);
898  *microsecs = (int) (diff % USECS_PER_SEC);
899  }
900 }
901 
902 /*
903  * Frontend version of TimestampDifferenceExceeds(), since we are not
904  * linked with backend code.
905  */
906 bool
908  TimestampTz stop_time,
909  int msec)
910 {
911  TimestampTz diff = stop_time - start_time;
912 
913  return (diff >= msec * INT64CONST(1000));
914 }
915 
916 /*
917  * Converts an int64 to network byte order.
918  */
919 void
920 fe_sendint64(int64 i, char *buf)
921 {
922  uint64 n64 = pg_hton64(i);
923 
924  memcpy(buf, &n64, sizeof(n64));
925 }
926 
927 /*
928  * Converts an int64 from network byte order to native format.
929  */
930 int64
932 {
933  uint64 n64;
934 
935  memcpy(&n64, buf, sizeof(n64));
936 
937  return pg_ntoh64(n64);
938 }
static Datum values[MAXATTR]
Definition: bootstrap.c:152
unsigned int uint32
Definition: c.h:506
signed int int32
Definition: c.h:494
#define ngettext(s, p, n)
Definition: c.h:1181
#define Assert(condition)
Definition: c.h:858
#define ALWAYS_SECURE_SEARCH_PATH_SQL
Definition: connect.h:25
int64 TimestampTz
Definition: timestamp.h:39
#define USECS_PER_SEC
Definition: timestamp.h:134
#define UNIX_EPOCH_JDATE
Definition: timestamp.h:234
#define SECS_PER_DAY
Definition: timestamp.h:126
#define POSTGRES_EPOCH_JDATE
Definition: timestamp.h:235
const char * PQparameterStatus(const PGconn *conn, const char *paramName)
Definition: fe-connect.c:7119
int PQserverVersion(const PGconn *conn)
Definition: fe-connect.c:7144
PQconninfoOption * PQconninfoParse(const char *conninfo, char **errmsg)
Definition: fe-connect.c:5735
PGconn * PQconnectdbParams(const char *const *keywords, const char *const *values, int expand_dbname)
Definition: fe-connect.c:689
PQconninfoOption * PQconndefaults(void)
Definition: fe-connect.c:1881
void PQconninfoFree(PQconninfoOption *connOptions)
Definition: fe-connect.c:6987
int PQconnectionNeedsPassword(const PGconn *conn)
Definition: fe-connect.c:7205
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:7154
ConnStatusType PQstatus(const PGconn *conn)
Definition: fe-connect.c:7101
void PQfinish(PGconn *conn)
Definition: fe-connect.c:4875
size_t PQescapeStringConn(PGconn *conn, char *to, const char *from, size_t length, int *error)
Definition: fe-exec.c:4145
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:3411
int PQntuples(const PGresult *res)
Definition: fe-exec.c:3481
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:2262
char * PQgetvalue(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3876
int PQgetisnull(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3901
char * PQresultErrorField(const PGresult *res, int fieldcode)
Definition: fe-exec.c:3466
int PQnfields(const PGresult *res)
Definition: fe-exec.c:3489
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
void SetDataDirectoryCreatePerm(int dataDirMode)
Definition: file_perm.c:34
int data_directory_mode
Definition: globals.c:74
#define free(a)
Definition: header.h:65
int i
Definition: isn.c:73
@ CONNECTION_BAD
Definition: libpq-fe.h:61
@ CONNECTION_OK
Definition: libpq-fe.h:60
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:99
@ PGRES_TUPLES_OK
Definition: libpq-fe.h:102
exit(1)
#define pg_log_error(...)
Definition: logging.h:106
#define pg_log_error_detail(...)
Definition: logging.h:109
void pfree(void *pointer)
Definition: mcxt.c:1520
void * palloc(Size size)
Definition: mcxt.c:1316
#define pg_fatal(...)
#define pg_hton64(x)
Definition: pg_bswap.h:122
#define pg_ntoh64(x)
Definition: pg_bswap.h:126
#define DEFAULT_XLOG_SEG_SIZE
static time_t start_time
Definition: pg_ctl.c:94
static bool slot_exists_ok
Definition: pg_receivewal.c:50
static bool two_phase
static const char * plugin
static XLogRecPtr startpos
static char * buf
Definition: pg_test_fsync.c:73
#define PG_DIAG_SQLSTATE
Definition: postgres_ext.h:56
PQExpBuffer createPQExpBuffer(void)
Definition: pqexpbuffer.c:72
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:265
void destroyPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:114
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:378
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:367
char * simple_prompt(const char *prompt, bool echo)
Definition: sprompt.c:38
void AppendIntegerCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name, int32 option_value)
Definition: streamutil.c:853
int dbgetpassword
Definition: streamutil.c:53
bool RetrieveWalSegSize(PGconn *conn)
Definition: streamutil.c:344
#define ERRCODE_DUPLICATE_OBJECT
Definition: streamutil.c:32
int WalSegSz
Definition: streamutil.c:34
#define MINIMUM_VERSION_FOR_SHOW_CMD
Definition: streamutil.c:40
char * dbhost
Definition: streamutil.c:49
int64 fe_recvint64(char *buf)
Definition: streamutil.c:931
char * GetDbnameFromConnectionOptions(void)
Definition: streamutil.c:305
bool CreateReplicationSlot(PGconn *conn, const char *slot_name, const char *plugin, bool is_temporary, bool is_physical, bool reserve_wal, bool slot_exists_ok, bool two_phase)
Definition: streamutil.c:652
static char * password
Definition: streamutil.c:54
TimestampTz feGetCurrentTimestamp(void)
Definition: streamutil.c:866
char * dbport
Definition: streamutil.c:51
#define MINIMUM_VERSION_FOR_GROUP_ACCESS
Definition: streamutil.c:45
void feTimestampDifference(TimestampTz start_time, TimestampTz stop_time, long *secs, int *microsecs)
Definition: streamutil.c:885
void AppendPlainCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name)
Definition: streamutil.c:809
void AppendStringCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name, char *option_value)
Definition: streamutil.c:830
void fe_sendint64(int64 i, char *buf)
Definition: streamutil.c:920
char * connection_string
Definition: streamutil.c:48
static char * FindDbnameInConnParams(PQconninfoOption *conn_opts)
Definition: streamutil.c:279
PGconn * GetConnection(void)
Definition: streamutil.c:63
bool feTimestampDifferenceExceeds(TimestampTz start_time, TimestampTz stop_time, int msec)
Definition: streamutil.c:907
bool GetSlotInformation(PGconn *conn, const char *slot_name, XLogRecPtr *restart_lsn, TimeLineID *restart_tli)
Definition: streamutil.c:558
const char * progname
Definition: streamutil.c:47
static bool RetrieveDataDirCreatePerm(PGconn *conn)
Definition: streamutil.c:423
bool DropReplicationSlot(PGconn *conn, const char *slot_name)
Definition: streamutil.c:760
char * dbname
Definition: streamutil.c:52
PGconn * conn
Definition: streamutil.c:55
bool RunIdentifySystem(PGconn *conn, char **sysid, TimeLineID *starttli, XLogRecPtr *startpos, char **db_name)
Definition: streamutil.c:477
char * dbuser
Definition: streamutil.c:50
int gettimeofday(struct timeval *tp, void *tzp)
#define IsValidWalSegSize(size)
Definition: xlog_internal.h:96
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
uint32 TimeLineID
Definition: xlogdefs.h:59