PostgreSQL Source Code  git master
streamutil.h File Reference
#include "access/xlogdefs.h"
#include "datatype/timestamp.h"
#include "libpq-fe.h"
#include "pqexpbuffer.h"
Include dependency graph for streamutil.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

PGconnGetConnection (void)
 
char * GetDbnameFromConnectionOptions (void)
 
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)
 
bool DropReplicationSlot (PGconn *conn, const char *slot_name)
 
bool RunIdentifySystem (PGconn *conn, char **sysid, TimeLineID *starttli, XLogRecPtr *startpos, char **db_name)
 
void AppendPlainCommandOption (PQExpBuffer buf, bool use_new_option_syntax, char *option_name)
 
void AppendStringCommandOption (PQExpBuffer buf, bool use_new_option_syntax, char *option_name, char *option_value)
 
void AppendIntegerCommandOption (PQExpBuffer buf, bool use_new_option_syntax, char *option_name, int32 option_value)
 
bool GetSlotInformation (PGconn *conn, const char *slot_name, XLogRecPtr *restart_lsn, TimeLineID *restart_tli)
 
bool RetrieveWalSegSize (PGconn *conn)
 
TimestampTz feGetCurrentTimestamp (void)
 
void feTimestampDifference (TimestampTz start_time, TimestampTz stop_time, long *secs, int *microsecs)
 
bool feTimestampDifferenceExceeds (TimestampTz start_time, TimestampTz stop_time, int msec)
 
void fe_sendint64 (int64 i, char *buf)
 
int64 fe_recvint64 (char *buf)
 

Variables

const char * progname
 
char * connection_string
 
char * dbhost
 
char * dbuser
 
char * dbport
 
char * dbname
 
int dbgetpassword
 
int WalSegSz
 
PGconnconn
 

Function Documentation

◆ AppendIntegerCommandOption()

void AppendIntegerCommandOption ( PQExpBuffer  buf,
bool  use_new_option_syntax,
char *  option_name,
int32  option_value 
)

Definition at line 853 of file streamutil.c.

855 {
856  AppendPlainCommandOption(buf, use_new_option_syntax, option_name);
857 
858  appendPQExpBuffer(buf, " %d", option_value);
859 }
static char * buf
Definition: pg_test_fsync.c:73
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:265
void AppendPlainCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name)
Definition: streamutil.c:809

References AppendPlainCommandOption(), appendPQExpBuffer(), and buf.

Referenced by BaseBackup().

◆ AppendPlainCommandOption()

void AppendPlainCommandOption ( PQExpBuffer  buf,
bool  use_new_option_syntax,
char *  option_name 
)

Definition at line 809 of file streamutil.c.

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 }
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:378
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:367

References appendPQExpBuffer(), appendPQExpBufferChar(), appendPQExpBufferStr(), and buf.

Referenced by AppendIntegerCommandOption(), AppendStringCommandOption(), BaseBackup(), and CreateReplicationSlot().

◆ AppendStringCommandOption()

void AppendStringCommandOption ( PQExpBuffer  buf,
bool  use_new_option_syntax,
char *  option_name,
char *  option_value 
)

Definition at line 830 of file streamutil.c.

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 }
size_t PQescapeStringConn(PGconn *conn, char *to, const char *from, size_t length, int *error)
Definition: fe-exec.c:4145
void pfree(void *pointer)
Definition: mcxt.c:1521
void * palloc(Size size)
Definition: mcxt.c:1317
PGconn * conn
Definition: streamutil.c:55

References AppendPlainCommandOption(), appendPQExpBuffer(), buf, conn, palloc(), pfree(), and PQescapeStringConn().

Referenced by BaseBackup(), and CreateReplicationSlot().

◆ CreateReplicationSlot()

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 at line 652 of file streamutil.c.

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 }
#define Assert(condition)
Definition: c.h:858
int PQserverVersion(const PGconn *conn)
Definition: fe-connect.c:7144
char * PQerrorMessage(const PGconn *conn)
Definition: fe-connect.c:7154
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 * PQresultErrorField(const PGresult *res, int fieldcode)
Definition: fe-exec.c:3466
int PQnfields(const PGresult *res)
Definition: fe-exec.c:3489
@ PGRES_TUPLES_OK
Definition: libpq-fe.h:102
#define pg_log_error(...)
Definition: logging.h:106
static bool slot_exists_ok
Definition: pg_receivewal.c:50
static bool two_phase
static const char * plugin
#define PG_DIAG_SQLSTATE
Definition: postgres_ext.h:56
PQExpBuffer createPQExpBuffer(void)
Definition: pqexpbuffer.c:72
void destroyPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:114
#define ERRCODE_DUPLICATE_OBJECT
Definition: streamutil.c:32
void AppendStringCommandOption(PQExpBuffer buf, bool use_new_option_syntax, char *option_name, char *option_value)
Definition: streamutil.c:830

References AppendPlainCommandOption(), appendPQExpBuffer(), appendPQExpBufferChar(), appendPQExpBufferStr(), AppendStringCommandOption(), Assert, conn, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), ERRCODE_DUPLICATE_OBJECT, PQExpBufferData::len, PG_DIAG_SQLSTATE, pg_log_error, PGRES_TUPLES_OK, plugin, PQclear(), PQerrorMessage(), PQexec(), PQnfields(), PQntuples(), PQresultErrorField(), PQresultStatus(), PQserverVersion(), res, slot_exists_ok, and two_phase.

◆ DropReplicationSlot()

bool DropReplicationSlot ( PGconn conn,
const char *  slot_name 
)

Definition at line 760 of file streamutil.c.

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 }
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:99

References appendPQExpBuffer(), Assert, conn, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), pg_log_error, PGRES_COMMAND_OK, PQclear(), PQerrorMessage(), PQexec(), PQnfields(), PQntuples(), PQresultStatus(), and res.

◆ fe_recvint64()

int64 fe_recvint64 ( char *  buf)

Definition at line 931 of file streamutil.c.

932 {
933  uint64 n64;
934 
935  memcpy(&n64, buf, sizeof(n64));
936 
937  return pg_ntoh64(n64);
938 }
#define pg_ntoh64(x)
Definition: pg_bswap.h:126

References buf, and pg_ntoh64.

Referenced by ProcessXLogDataMsg(), and StreamLogicalLog().

◆ fe_sendint64()

void fe_sendint64 ( int64  i,
char *  buf 
)

Definition at line 920 of file streamutil.c.

921 {
922  uint64 n64 = pg_hton64(i);
923 
924  memcpy(buf, &n64, sizeof(n64));
925 }
int i
Definition: isn.c:73
#define pg_hton64(x)
Definition: pg_bswap.h:122

References buf, i, and pg_hton64.

Referenced by sendFeedback().

◆ feGetCurrentTimestamp()

TimestampTz feGetCurrentTimestamp ( void  )

Definition at line 866 of file streamutil.c.

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 }
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
int gettimeofday(struct timeval *tp, void *tzp)

References gettimeofday(), POSTGRES_EPOCH_JDATE, SECS_PER_DAY, UNIX_EPOCH_JDATE, and USECS_PER_SEC.

Referenced by flushAndSendFeedback(), HandleCopyStream(), ProcessKeepaliveMsg(), and StreamLogicalLog().

◆ feTimestampDifference()

void feTimestampDifference ( TimestampTz  start_time,
TimestampTz  stop_time,
long *  secs,
int *  microsecs 
)

Definition at line 885 of file streamutil.c.

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 }
static time_t start_time
Definition: pg_ctl.c:94

References start_time, and USECS_PER_SEC.

Referenced by CalculateCopyStreamSleeptime(), and StreamLogicalLog().

◆ feTimestampDifferenceExceeds()

bool feTimestampDifferenceExceeds ( TimestampTz  start_time,
TimestampTz  stop_time,
int  msec 
)

Definition at line 907 of file streamutil.c.

910 {
911  TimestampTz diff = stop_time - start_time;
912 
913  return (diff >= msec * INT64CONST(1000));
914 }

References start_time.

Referenced by HandleCopyStream(), and StreamLogicalLog().

◆ GetConnection()

PGconn* GetConnection ( void  )

Definition at line 63 of file streamutil.c.

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 }
static Datum values[MAXATTR]
Definition: bootstrap.c:152
#define ALWAYS_SECURE_SEARCH_PATH_SQL
Definition: connect.h:25
const char * PQparameterStatus(const PGconn *conn, const char *paramName)
Definition: fe-connect.c:7119
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
void PQconninfoFree(PQconninfoOption *connOptions)
Definition: fe-connect.c:6987
int PQconnectionNeedsPassword(const PGconn *conn)
Definition: fe-connect.c:7205
ConnStatusType PQstatus(const PGconn *conn)
Definition: fe-connect.c:7101
void PQfinish(PGconn *conn)
Definition: fe-connect.c:4875
void * pg_malloc0(size_t size)
Definition: fe_memutils.c:53
#define free(a)
Definition: header.h:65
@ CONNECTION_BAD
Definition: libpq-fe.h:61
@ CONNECTION_OK
Definition: libpq-fe.h:60
exit(1)
#define pg_fatal(...)
char * simple_prompt(const char *prompt, bool echo)
Definition: sprompt.c:38
int dbgetpassword
Definition: streamutil.c:53
char * dbhost
Definition: streamutil.c:49
static char * password
Definition: streamutil.c:54
char * dbport
Definition: streamutil.c:51
char * connection_string
Definition: streamutil.c:48
const char * progname
Definition: streamutil.c:47
static bool RetrieveDataDirCreatePerm(PGconn *conn)
Definition: streamutil.c:423
char * dbname
Definition: streamutil.c:52
char * dbuser
Definition: streamutil.c:50

References ALWAYS_SECURE_SEARCH_PATH_SQL, Assert, CONNECTION_BAD, CONNECTION_OK, connection_string, dbgetpassword, dbhost, dbname, dbport, dbuser, exit(), free, i, _PQconninfoOption::keyword, password, pg_fatal, pg_log_error, pg_malloc0(), PGRES_TUPLES_OK, PQclear(), PQconnectdbParams(), PQconnectionNeedsPassword(), PQconninfoFree(), PQconninfoParse(), PQerrorMessage(), PQexec(), PQfinish(), PQparameterStatus(), PQresultStatus(), PQserverVersion(), PQstatus(), progname, res, RetrieveDataDirCreatePerm(), simple_prompt(), _PQconninfoOption::val, and values.

◆ GetDbnameFromConnectionOptions()

char* GetDbnameFromConnectionOptions ( void  )

Definition at line 305 of file streamutil.c.

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 }
PQconninfoOption * PQconndefaults(void)
Definition: fe-connect.c:1881
static char * FindDbnameInConnParams(PQconninfoOption *conn_opts)
Definition: streamutil.c:279

References connection_string, dbname, FindDbnameInConnParams(), pg_fatal, PQconndefaults(), PQconninfoFree(), and PQconninfoParse().

Referenced by BaseBackup().

◆ GetSlotInformation()

bool GetSlotInformation ( PGconn conn,
const char *  slot_name,
XLogRecPtr restart_lsn,
TimeLineID restart_tli 
)

Definition at line 558 of file streamutil.c.

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 }
unsigned int uint32
Definition: c.h:506
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
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
uint32 TimeLineID
Definition: xlogdefs.h:59

References appendPQExpBuffer(), conn, createPQExpBuffer(), PQExpBufferData::data, destroyPQExpBuffer(), InvalidXLogRecPtr, pg_log_error, PGRES_TUPLES_OK, PQclear(), PQerrorMessage(), PQexec(), PQgetisnull(), PQgetvalue(), PQnfields(), PQntuples(), PQresultStatus(), and res.

Referenced by StreamLog().

◆ RetrieveWalSegSize()

bool RetrieveWalSegSize ( PGconn conn)

Definition at line 344 of file streamutil.c.

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 }
#define ngettext(s, p, n)
Definition: c.h:1181
#define pg_log_error_detail(...)
Definition: logging.h:109
#define DEFAULT_XLOG_SEG_SIZE
int WalSegSz
Definition: streamutil.c:34
#define MINIMUM_VERSION_FOR_SHOW_CMD
Definition: streamutil.c:40
#define IsValidWalSegSize(size)
Definition: xlog_internal.h:96

References Assert, conn, DEFAULT_XLOG_SEG_SIZE, IsValidWalSegSize, MINIMUM_VERSION_FOR_SHOW_CMD, ngettext, pg_log_error, pg_log_error_detail, PGRES_TUPLES_OK, PQclear(), PQerrorMessage(), PQexec(), PQgetvalue(), PQnfields(), PQntuples(), PQresultStatus(), PQserverVersion(), res, and WalSegSz.

Referenced by main().

◆ RunIdentifySystem()

bool RunIdentifySystem ( PGconn conn,
char **  sysid,
TimeLineID starttli,
XLogRecPtr startpos,
char **  db_name 
)

Definition at line 477 of file streamutil.c.

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 }
char * pg_strdup(const char *in)
Definition: fe_memutils.c:85
static XLogRecPtr startpos

References Assert, conn, pg_log_error, pg_strdup(), PGRES_TUPLES_OK, PQclear(), PQerrorMessage(), PQexec(), PQgetisnull(), PQgetvalue(), PQnfields(), PQntuples(), PQresultStatus(), PQserverVersion(), res, and startpos.

Referenced by BaseBackup(), main(), ReceiveXlogStream(), and StreamLog().

Variable Documentation

◆ conn

PGconn* conn
extern

Definition at line 55 of file streamutil.c.

Referenced by append_db_pattern_cte(), append_rel_pattern_filtered_cte(), append_rel_pattern_raw_cte(), appendQualifiedRelation(), AppendStringCommandOption(), appendStringLiteralConn(), applyRemoteGucs(), BaseBackup(), build_client_final_message(), build_client_first_message(), build_startup_packet(), buildShSecLabels(), canChangeResultMode(), check_and_drop_existing_subscriptions(), check_expected_areq(), check_for_data_types_usage(), check_for_incompatible_polymorphics(), check_for_isn_and_int8_passing_mismatch(), check_for_pg_role_prefix(), check_for_prepared_transactions(), check_for_tables_with_oids(), check_for_user_defined_encoding_conversions(), check_for_user_defined_postfix_ops(), check_is_install_user(), check_loadable_libraries(), check_new_cluster_logical_replication_slots(), check_new_cluster_subscription_configuration(), check_old_cluster_subscription_state(), check_prepare_conn(), check_publisher(), check_subscriber(), CheckCopyStreamStop(), CheckServerVersionForStreaming(), cleanup_objects_atexit(), close_cursor(), cluster_all_databases(), cluster_one_database(), compile_database_list(), compile_relation_list_one_db(), configure_remote_session(), confirm_query_canceled_impl(), connect_database(), connect_pg_server(), connectDatabase(), connectFailureMessage(), connection_failed(), connectMaintenanceDatabase(), connectNoDelay(), connectOptions1(), connectToServer(), copy_connection(), CopyStreamPoll(), CopyStreamReceive(), create_cursor(), create_logical_replication_slot(), create_logical_replication_slots(), create_publication(), create_subscription(), CreateReplicationSlot(), dblink_cancel_query(), dblink_close(), dblink_connect(), dblink_disconnect(), dblink_error_message(), dblink_exec(), dblink_fetch(), dblink_get_conn(), dblink_get_notify(), dblink_is_busy(), dblink_open(), dblink_record_internal(), dblink_res_error(), dblink_security_check(), dblink_send_query(), disconnect_atexit(), disconnect_database(), disconnectDatabase(), do_sql_command(), do_sql_command_begin(), do_sql_command_end(), doConnect(), drop_existing_subscriptions(), drop_failover_replication_slots(), drop_primary_replication_slot(), drop_publication(), drop_replication_slot(), dropDBs(), DropReplicationSlot(), dropRoles(), dropTablespaces(), dumpDatabase(), dumpDatabaseConfig(), dumpDatabases(), dumpLOs(), dumpRoleGUCPrivs(), dumpRoleMembership(), dumpRoles(), dumpTableData_copy(), dumpTablespaces(), dumpUserConfig(), ecpg_raise_backend(), emitHostIdentityInfo(), emitShSecLabels(), enable_subscription(), estimate_path_cost_size(), executeCommand(), executeMaintenanceCommand(), executeQuery(), executeQueryOrDie(), ExecuteSqlCommand(), exit_nicely(), expand_dbname_patterns(), exportFile(), fetch_more_data(), fillPGconn(), flushAndSendFeedback(), freePGconn(), generate_object_name(), get_db_conn(), get_db_infos(), get_db_subscription_count(), get_loadable_libraries(), get_old_cluster_logical_slot_infos(), get_parallel_object_list(), get_primary_sysid(), get_rel_infos(), get_remote_estimate(), get_tablespace_paths(), get_template0_info(), getAnotherTuple(), getCopyDataMessage(), getCopyResult(), getCopyStart(), getHostaddr(), getNotify(), getParamDescriptions(), getParameterStatus(), getReadyForQuery(), getRowDescriptions(), GetSlotInformation(), gss_read(), handleCopyIn(), handleCopyOut(), HandleCopyStream(), HandleEndOfCopyStream(), handleSyncLoss(), importFile(), init_allowed_encryption_methods(), init_libpq_conn(), init_libpq_source(), initialize_SSL(), internal_ping(), libpq_append_conn_error(), libpq_fetch_file(), libpq_get_current_wal_insert_lsn(), libpq_prng_init(), libpq_traverse_files(), libpqrcv_alter_slot(), libpqrcv_connect(), libpqrcv_create_slot(), libpqrcv_disconnect(), libpqrcv_endstreaming(), libpqrcv_exec(), libpqrcv_get_backend_pid(), libpqrcv_get_conninfo(), libpqrcv_get_senderinfo(), libpqrcv_identify_system(), libpqrcv_readtimelinehistoryfile(), libpqrcv_receive(), libpqrcv_send(), libpqrcv_server_version(), libpqrcv_startstreaming(), libpqsrv_cancel(), libpqsrv_connect(), libpqsrv_connect_internal(), libpqsrv_connect_params(), libpqsrv_disconnect(), libpqsrv_exec(), libpqsrv_exec_params(), libpqsrv_get_result(), libpqsrv_get_result_last(), lo_close(), lo_creat(), lo_create(), lo_export(), lo_import(), lo_import_internal(), lo_import_with_oid(), lo_initialize(), lo_lseek(), lo_lseek64(), lo_open(), lo_read(), lo_tell(), lo_tell64(), lo_truncate(), lo_truncate64(), lo_unlink(), lo_write(), main(), makeAlterConfigCommand(), materializeResult(), my_sock_read(), my_SSL_set_fd(), my_truncate(), old_9_6_invalidate_hash_indexes(), open_client_SSL(), openssl_verify_peer_name_matches_certificate_ip(), openssl_verify_peer_name_matches_certificate_name(), overwrite(), ParallelSlotsAdoptConn(), ParallelSlotsTerminate(), parseInput(), pg_fe_sendauth(), pg_GSS_error(), pg_GSS_load_servicename(), pg_GSS_read(), pg_GSS_write(), pg_password_sendauth(), pg_SASL_continue(), pg_SASL_init(), pgfdw_cancel_query(), pgfdw_cancel_query_begin(), pgfdw_cancel_query_end(), pgfdw_exec_cleanup_query(), pgfdw_exec_cleanup_query_begin(), pgfdw_exec_cleanup_query_end(), pgfdw_exec_query(), pgfdw_get_cleanup_result(), pgfdw_get_result(), pgfdw_report_error(), pgfdw_security_check(), pgpassfileWarning(), pgtls_close(), pgtls_get_peer_certificate_hash(), pgtls_init(), pgtls_open_client(), pgtls_read(), pgtls_read_pending(), pgtls_verify_peer_name_matches_certificate_guts(), pgtls_write(), pickout(), postgresAcquireSampleRowsFunc(), postgresAnalyzeForeignTable(), postgresExecForeignTruncate(), postgresGetAnalyzeInfoForForeignTable(), postgresImportForeignSchema(), pq_verify_peer_name_matches_certificate(), pq_verify_peer_name_matches_certificate_ip(), pq_verify_peer_name_matches_certificate_name(), pqAllocCmdQueueEntry(), pqAppendCmdQueueEntry(), PQbackendPID(), pqBuildStartupPacket3(), PQcancelCreate(), PQcancelPoll(), PQchangePassword(), pqCheckInBufferSpace(), pqCheckOutBufferSpace(), pqClearAsyncResult(), PQclientEncoding(), pqClosePGconn(), PQclosePortal(), PQclosePrepared(), pqCommandQueueAdvance(), PQconnectdb(), pqConnectDBComplete(), PQconnectdbParams(), pqConnectDBStart(), PQconnectionNeedsPassword(), PQconnectionUsedGSSAPI(), PQconnectionUsedPassword(), pqConnectOptions2(), PQconnectPoll(), PQconnectStart(), PQconnectStartParams(), PQconninfo(), PQconsumeInput(), PQdb(), PQdefaultSSLKeyPassHook_OpenSSL(), PQdescribePortal(), PQdescribePrepared(), pqDropConnection(), pqDropServerData(), PQencryptPasswordConn(), PQendcopy(), pqEndcopy3(), PQenterPipelineMode(), PQerrorMessage(), PQescapeByteaConn(), PQescapeByteaInternal(), PQescapeIdentifier(), PQescapeInternal(), PQescapeLiteral(), PQescapeStringConn(), PQescapeStringInternal(), PQexec(), PQexecFinish(), PQexecParams(), PQexecPrepared(), PQexecStart(), PQexitPipelineMode(), PQfinish(), PQfireResultCreateEvents(), PQflush(), pqFlush(), PQfn(), pqFunctionCall3(), pqGetc(), PQgetCancel(), PQgetCopyData(), pqGetCopyData3(), pqGetErrorNotice3(), PQgetgssctx(), pqGetInt(), PQgetline(), pqGetline3(), PQgetlineAsync(), pqGetlineAsync3(), pqGetnchar(), pqGetNegotiateProtocolVersion3(), PQgetResult(), pqGets(), pqGets_append(), pqGets_internal(), PQgetssl(), PQgssEncInUse(), PQhost(), PQhostaddr(), PQinstanceData(), PQisBusy(), PQisnonblocking(), pqMakeEmptyPGconn(), PQmakeEmptyPGresult(), PQnotifies(), PQoptions(), pqPacketSend(), PQparameterStatus(), pqParseInput3(), pqParseIntParam(), PQpass(), PQping(), PQpingParams(), pqPipelineFlush(), pqPipelineProcessQueue(), PQpipelineStatus(), PQpipelineSync(), pqPipelineSyncInternal(), PQport(), PQprepare(), pqPrepareAsyncResult(), PQprotocolVersion(), pqPutc(), PQputCopyData(), PQputCopyEnd(), pqPutInt(), PQputline(), pqPutMsgBytes(), pqPutMsgEnd(), pqPutMsgStart(), PQputnbytes(), pqPutnchar(), pqPuts(), pqReadData(), pqReadReady(), pqRecycleCmdQueueEntry(), PQregisterEventProc(), pqReleaseConnHosts(), PQrequestCancel(), PQreset(), PQresetPoll(), PQresetStart(), pqRowProcessor(), pqSaveErrorResult(), pqSaveParameterStatus(), pqSaveWriteError(), pqsecure_close(), pqsecure_initialize(), pqsecure_open_client(), pqsecure_open_gss(), pqsecure_raw_read(), pqsecure_raw_write(), pqsecure_read(), pqsecure_write(), PQsendClosePortal(), PQsendClosePrepared(), PQsendDescribePortal(), PQsendDescribePrepared(), PQsendFlushRequest(), PQsendPipelineSync(), PQsendPrepare(), PQsendQuery(), PQsendQueryContinue(), PQsendQueryGuts(), PQsendQueryInternal(), PQsendQueryParams(), PQsendQueryPrepared(), PQsendQueryStart(), pqSendSome(), PQsendTypedCommand(), PQserverVersion(), PQsetChunkedRowsMode(), PQsetClientEncoding(), PQsetdbLogin(), PQsetErrorContextVisibility(), PQsetErrorVerbosity(), PQsetInstanceData(), PQsetnonblocking(), PQsetNoticeProcessor(), PQsetNoticeReceiver(), PQsetSingleRowMode(), PQsetTraceFlags(), pqSkipnchar(), PQsocket(), pqSocketCheck(), PQssl_passwd_cb(), PQsslAttribute(), PQsslAttributeNames(), PQsslInUse(), PQsslStruct(), PQstatus(), PQtrace(), pqTraceOutputMessage(), pqTraceOutputNoTypeByteMessage(), PQtransactionStatus(), PQtty(), PQuntrace(), PQuser(), pqWait(), pqWaitTimed(), pqWriteReady(), prepareToTerminate(), process_result(), ProcessKeepaliveMsg(), processSQLNamePattern(), ProcessXLogDataMsg(), prohibit_crossdb_refs(), read_server_final_message(), read_server_first_message(), ReceiveArchiveStream(), ReceiveBackupManifest(), ReceiveBackupManifestInMemory(), ReceiveCopyData(), ReceiveTarFile(), ReceiveXlogStream(), reindex_all_databases(), reindex_one_database(), release_conn_addrinfo(), report_extension_updates(), RetrieveDataDirCreatePerm(), RetrieveWalSegSize(), run_permutation(), run_reindex_command(), run_simple_command(), run_simple_query(), run_vacuum_command(), RunIdentifySystem(), scram_exchange(), scram_init(), select_next_encryption_method(), send_cancellable_query_impl(), sendFeedback(), sendTerminateConn(), server_is_in_recovery(), set_archive_cancel_info(), set_frozenxids(), set_replication_progress(), SetCancelConn(), setKeepalivesCount(), setKeepalivesIdle(), setKeepalivesInterval(), setTCPUserTimeout(), setup_connection(), setup_publisher(), setup_recovery(), setup_subscriber(), sql_conn(), sql_exec(), sql_exec_dumpalldbs(), sql_exec_dumpalltables(), sql_exec_dumpalltbspc(), sql_exec_searchtables(), start_postmaster(), StartLogStreamer(), store_conn_addrinfo(), storeQueryResult(), StreamLog(), StreamLogicalLog(), stringlist_to_identifierstr(), TableCommandResultHandler(), test_cancel(), test_disallowed_in_pipeline(), test_multi_pipelines(), test_nosync(), test_pipeline_abort(), test_pipeline_idle(), test_pipelined_insert(), test_prepared(), test_simple_pipeline(), test_singlerowmode(), test_transaction(), test_uniqviol(), try_complete_step(), useKeepalives(), vacuum_all_databases(), vacuum_one_database(), vacuumlo(), verify_btree_slot_handler(), verify_heap_slot_handler(), wait_for_end_recovery(), and wait_until_connected().

◆ connection_string

char* connection_string
extern

Definition at line 48 of file streamutil.c.

Referenced by connectDatabase(), GetConnection(), GetDbnameFromConnectionOptions(), and main().

◆ dbgetpassword

int dbgetpassword
extern

Definition at line 53 of file streamutil.c.

Referenced by GetConnection(), and main().

◆ dbhost

char* dbhost
extern

Definition at line 49 of file streamutil.c.

Referenced by GetConnection(), and main().

◆ dbname

◆ dbport

char* dbport
extern

Definition at line 51 of file streamutil.c.

Referenced by GetConnection(), and main().

◆ dbuser

char* dbuser
extern

Definition at line 50 of file streamutil.c.

Referenced by GetConnection(), and main().

◆ progname

const char* progname
extern

Definition at line 44 of file main.c.

◆ WalSegSz

int WalSegSz
extern

Definition at line 34 of file streamutil.c.