PostgreSQL Source Code  git master
walreceiver.h File Reference
#include "access/xlog.h"
#include "access/xlogdefs.h"
#include "getaddrinfo.h"
#include "pgtime.h"
#include "port/atomics.h"
#include "replication/logicalproto.h"
#include "replication/walsender.h"
#include "storage/condition_variable.h"
#include "storage/latch.h"
#include "storage/spin.h"
#include "utils/tuplestore.h"
Include dependency graph for walreceiver.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  WalRcvData
 
struct  WalRcvStreamOptions
 
struct  WalRcvExecResult
 
struct  WalReceiverFunctionsType
 

Macros

#define MAXCONNINFO   1024
 
#define AllowCascadeReplication()   (EnableHotStandby && max_wal_senders > 0)
 
#define walrcv_connect(conninfo, logical, appname, err)    WalReceiverFunctions->walrcv_connect(conninfo, logical, appname, err)
 
#define walrcv_check_conninfo(conninfo)    WalReceiverFunctions->walrcv_check_conninfo(conninfo)
 
#define walrcv_get_conninfo(conn)    WalReceiverFunctions->walrcv_get_conninfo(conn)
 
#define walrcv_get_senderinfo(conn, sender_host, sender_port)    WalReceiverFunctions->walrcv_get_senderinfo(conn, sender_host, sender_port)
 
#define walrcv_identify_system(conn, primary_tli)    WalReceiverFunctions->walrcv_identify_system(conn, primary_tli)
 
#define walrcv_server_version(conn)    WalReceiverFunctions->walrcv_server_version(conn)
 
#define walrcv_readtimelinehistoryfile(conn, tli, filename, content, size)    WalReceiverFunctions->walrcv_readtimelinehistoryfile(conn, tli, filename, content, size)
 
#define walrcv_startstreaming(conn, options)    WalReceiverFunctions->walrcv_startstreaming(conn, options)
 
#define walrcv_endstreaming(conn, next_tli)    WalReceiverFunctions->walrcv_endstreaming(conn, next_tli)
 
#define walrcv_receive(conn, buffer, wait_fd)    WalReceiverFunctions->walrcv_receive(conn, buffer, wait_fd)
 
#define walrcv_send(conn, buffer, nbytes)    WalReceiverFunctions->walrcv_send(conn, buffer, nbytes)
 
#define walrcv_create_slot(conn, slotname, temporary, two_phase, snapshot_action, lsn)    WalReceiverFunctions->walrcv_create_slot(conn, slotname, temporary, two_phase, snapshot_action, lsn)
 
#define walrcv_get_backend_pid(conn)    WalReceiverFunctions->walrcv_get_backend_pid(conn)
 
#define walrcv_exec(conn, exec, nRetTypes, retTypes)    WalReceiverFunctions->walrcv_exec(conn, exec, nRetTypes, retTypes)
 
#define walrcv_disconnect(conn)    WalReceiverFunctions->walrcv_disconnect(conn)
 

Typedefs

typedef struct WalReceiverConn WalReceiverConn
 
typedef struct WalRcvExecResult WalRcvExecResult
 
typedef WalReceiverConn *(* walrcv_connect_fn) (const char *conninfo, bool logical, const char *appname, char **err)
 
typedef void(* walrcv_check_conninfo_fn) (const char *conninfo)
 
typedef char *(* walrcv_get_conninfo_fn) (WalReceiverConn *conn)
 
typedef void(* walrcv_get_senderinfo_fn) (WalReceiverConn *conn, char **sender_host, int *sender_port)
 
typedef char *(* walrcv_identify_system_fn) (WalReceiverConn *conn, TimeLineID *primary_tli)
 
typedef int(* walrcv_server_version_fn) (WalReceiverConn *conn)
 
typedef void(* walrcv_readtimelinehistoryfile_fn) (WalReceiverConn *conn, TimeLineID tli, char **filename, char **content, int *size)
 
typedef bool(* walrcv_startstreaming_fn) (WalReceiverConn *conn, const WalRcvStreamOptions *options)
 
typedef void(* walrcv_endstreaming_fn) (WalReceiverConn *conn, TimeLineID *next_tli)
 
typedef int(* walrcv_receive_fn) (WalReceiverConn *conn, char **buffer, pgsocket *wait_fd)
 
typedef void(* walrcv_send_fn) (WalReceiverConn *conn, const char *buffer, int nbytes)
 
typedef char *(* walrcv_create_slot_fn) (WalReceiverConn *conn, const char *slotname, bool temporary, bool two_phase, CRSSnapshotAction snapshot_action, XLogRecPtr *lsn)
 
typedef pid_t(* walrcv_get_backend_pid_fn) (WalReceiverConn *conn)
 
typedef WalRcvExecResult *(* walrcv_exec_fn) (WalReceiverConn *conn, const char *query, const int nRetTypes, const Oid *retTypes)
 
typedef void(* walrcv_disconnect_fn) (WalReceiverConn *conn)
 
typedef struct WalReceiverFunctionsType WalReceiverFunctionsType
 

Enumerations

enum  WalRcvState {
  WALRCV_STOPPED , WALRCV_STARTING , WALRCV_STREAMING , WALRCV_WAITING ,
  WALRCV_RESTARTING , WALRCV_STOPPING
}
 
enum  WalRcvExecStatus {
  WALRCV_ERROR , WALRCV_OK_COMMAND , WALRCV_OK_TUPLES , WALRCV_OK_COPY_IN ,
  WALRCV_OK_COPY_OUT , WALRCV_OK_COPY_BOTH
}
 

Functions

static void walrcv_clear_result (WalRcvExecResult *walres)
 
void WalReceiverMain (void) pg_attribute_noreturn()
 
void ProcessWalRcvInterrupts (void)
 
Size WalRcvShmemSize (void)
 
void WalRcvShmemInit (void)
 
void ShutdownWalRcv (void)
 
bool WalRcvStreaming (void)
 
bool WalRcvRunning (void)
 
void RequestXLogStreaming (TimeLineID tli, XLogRecPtr recptr, const char *conninfo, const char *slotname, bool create_temp_slot)
 
XLogRecPtr GetWalRcvFlushRecPtr (XLogRecPtr *latestChunkStart, TimeLineID *receiveTLI)
 
XLogRecPtr GetWalRcvWriteRecPtr (void)
 
int GetReplicationApplyDelay (void)
 
int GetReplicationTransferLatency (void)
 
void WalRcvForceReply (void)
 

Variables

PGDLLIMPORT int wal_receiver_status_interval
 
PGDLLIMPORT int wal_receiver_timeout
 
PGDLLIMPORT bool hot_standby_feedback
 
PGDLLIMPORT WalRcvDataWalRcv
 
PGDLLIMPORT WalReceiverFunctionsTypeWalReceiverFunctions
 

Macro Definition Documentation

◆ AllowCascadeReplication

#define AllowCascadeReplication ( )    (EnableHotStandby && max_wal_senders > 0)

Definition at line 40 of file walreceiver.h.

◆ MAXCONNINFO

#define MAXCONNINFO   1024

Definition at line 37 of file walreceiver.h.

◆ walrcv_check_conninfo

#define walrcv_check_conninfo (   conninfo)     WalReceiverFunctions->walrcv_check_conninfo(conninfo)

Definition at line 406 of file walreceiver.h.

◆ walrcv_connect

#define walrcv_connect (   conninfo,
  logical,
  appname,
  err 
)     WalReceiverFunctions->walrcv_connect(conninfo, logical, appname, err)

Definition at line 404 of file walreceiver.h.

◆ walrcv_create_slot

#define walrcv_create_slot (   conn,
  slotname,
  temporary,
  two_phase,
  snapshot_action,
  lsn 
)     WalReceiverFunctions->walrcv_create_slot(conn, slotname, temporary, two_phase, snapshot_action, lsn)

Definition at line 426 of file walreceiver.h.

◆ walrcv_disconnect

#define walrcv_disconnect (   conn)     WalReceiverFunctions->walrcv_disconnect(conn)

Definition at line 432 of file walreceiver.h.

◆ walrcv_endstreaming

#define walrcv_endstreaming (   conn,
  next_tli 
)     WalReceiverFunctions->walrcv_endstreaming(conn, next_tli)

Definition at line 420 of file walreceiver.h.

◆ walrcv_exec

#define walrcv_exec (   conn,
  exec,
  nRetTypes,
  retTypes 
)     WalReceiverFunctions->walrcv_exec(conn, exec, nRetTypes, retTypes)

Definition at line 430 of file walreceiver.h.

◆ walrcv_get_backend_pid

#define walrcv_get_backend_pid (   conn)     WalReceiverFunctions->walrcv_get_backend_pid(conn)

Definition at line 428 of file walreceiver.h.

◆ walrcv_get_conninfo

#define walrcv_get_conninfo (   conn)     WalReceiverFunctions->walrcv_get_conninfo(conn)

Definition at line 408 of file walreceiver.h.

◆ walrcv_get_senderinfo

#define walrcv_get_senderinfo (   conn,
  sender_host,
  sender_port 
)     WalReceiverFunctions->walrcv_get_senderinfo(conn, sender_host, sender_port)

Definition at line 410 of file walreceiver.h.

◆ walrcv_identify_system

#define walrcv_identify_system (   conn,
  primary_tli 
)     WalReceiverFunctions->walrcv_identify_system(conn, primary_tli)

Definition at line 412 of file walreceiver.h.

◆ walrcv_readtimelinehistoryfile

#define walrcv_readtimelinehistoryfile (   conn,
  tli,
  filename,
  content,
  size 
)     WalReceiverFunctions->walrcv_readtimelinehistoryfile(conn, tli, filename, content, size)

Definition at line 416 of file walreceiver.h.

◆ walrcv_receive

#define walrcv_receive (   conn,
  buffer,
  wait_fd 
)     WalReceiverFunctions->walrcv_receive(conn, buffer, wait_fd)

Definition at line 422 of file walreceiver.h.

◆ walrcv_send

#define walrcv_send (   conn,
  buffer,
  nbytes 
)     WalReceiverFunctions->walrcv_send(conn, buffer, nbytes)

Definition at line 424 of file walreceiver.h.

◆ walrcv_server_version

#define walrcv_server_version (   conn)     WalReceiverFunctions->walrcv_server_version(conn)

Definition at line 414 of file walreceiver.h.

◆ walrcv_startstreaming

#define walrcv_startstreaming (   conn,
  options 
)     WalReceiverFunctions->walrcv_startstreaming(conn, options)

Definition at line 418 of file walreceiver.h.

Typedef Documentation

◆ walrcv_check_conninfo_fn

typedef void(* walrcv_check_conninfo_fn) (const char *conninfo)

Definition at line 246 of file walreceiver.h.

◆ walrcv_connect_fn

typedef WalReceiverConn*(* walrcv_connect_fn) (const char *conninfo, bool logical, const char *appname, char **err)

Definition at line 236 of file walreceiver.h.

◆ walrcv_create_slot_fn

typedef char*(* walrcv_create_slot_fn) (WalReceiverConn *conn, const char *slotname, bool temporary, bool two_phase, CRSSnapshotAction snapshot_action, XLogRecPtr *lsn)

Definition at line 349 of file walreceiver.h.

◆ walrcv_disconnect_fn

typedef void(* walrcv_disconnect_fn) (WalReceiverConn *conn)

Definition at line 381 of file walreceiver.h.

◆ walrcv_endstreaming_fn

typedef void(* walrcv_endstreaming_fn) (WalReceiverConn *conn, TimeLineID *next_tli)

Definition at line 314 of file walreceiver.h.

◆ walrcv_exec_fn

typedef WalRcvExecResult*(* walrcv_exec_fn) (WalReceiverConn *conn, const char *query, const int nRetTypes, const Oid *retTypes)

Definition at line 371 of file walreceiver.h.

◆ walrcv_get_backend_pid_fn

typedef pid_t(* walrcv_get_backend_pid_fn) (WalReceiverConn *conn)

Definition at line 361 of file walreceiver.h.

◆ walrcv_get_conninfo_fn

typedef char*(* walrcv_get_conninfo_fn) (WalReceiverConn *conn)

Definition at line 254 of file walreceiver.h.

◆ walrcv_get_senderinfo_fn

typedef void(* walrcv_get_senderinfo_fn) (WalReceiverConn *conn, char **sender_host, int *sender_port)

Definition at line 263 of file walreceiver.h.

◆ walrcv_identify_system_fn

typedef char*(* walrcv_identify_system_fn) (WalReceiverConn *conn, TimeLineID *primary_tli)

Definition at line 274 of file walreceiver.h.

◆ walrcv_readtimelinehistoryfile_fn

typedef void(* walrcv_readtimelinehistoryfile_fn) (WalReceiverConn *conn, TimeLineID tli, char **filename, char **content, int *size)

Definition at line 291 of file walreceiver.h.

◆ walrcv_receive_fn

typedef int(* walrcv_receive_fn) (WalReceiverConn *conn, char **buffer, pgsocket *wait_fd)

Definition at line 325 of file walreceiver.h.

◆ walrcv_send_fn

typedef void(* walrcv_send_fn) (WalReceiverConn *conn, const char *buffer, int nbytes)

Definition at line 335 of file walreceiver.h.

◆ walrcv_server_version_fn

typedef int(* walrcv_server_version_fn) (WalReceiverConn *conn)

Definition at line 282 of file walreceiver.h.

◆ walrcv_startstreaming_fn

typedef bool(* walrcv_startstreaming_fn) (WalReceiverConn *conn, const WalRcvStreamOptions *options)

Definition at line 305 of file walreceiver.h.

◆ WalRcvExecResult

◆ WalReceiverConn

Definition at line 163 of file walreceiver.h.

◆ WalReceiverFunctionsType

Enumeration Type Documentation

◆ WalRcvExecStatus

Enumerator
WALRCV_ERROR 
WALRCV_OK_COMMAND 
WALRCV_OK_TUPLES 
WALRCV_OK_COPY_IN 
WALRCV_OK_COPY_OUT 
WALRCV_OK_COPY_BOTH 

Definition at line 198 of file walreceiver.h.

199 {
200  WALRCV_ERROR, /* There was error when executing the query. */
201  WALRCV_OK_COMMAND, /* Query executed utility or replication
202  * command. */
203  WALRCV_OK_TUPLES, /* Query returned tuples. */
204  WALRCV_OK_COPY_IN, /* Query started COPY FROM. */
205  WALRCV_OK_COPY_OUT, /* Query started COPY TO. */
206  WALRCV_OK_COPY_BOTH /* Query started COPY BOTH replication
207  * protocol. */
WalRcvExecStatus
Definition: walreceiver.h:199
@ WALRCV_OK_COPY_IN
Definition: walreceiver.h:204
@ WALRCV_OK_COMMAND
Definition: walreceiver.h:201
@ WALRCV_ERROR
Definition: walreceiver.h:200
@ WALRCV_OK_TUPLES
Definition: walreceiver.h:203
@ WALRCV_OK_COPY_OUT
Definition: walreceiver.h:205
@ WALRCV_OK_COPY_BOTH
Definition: walreceiver.h:206

◆ WalRcvState

Enumerator
WALRCV_STOPPED 
WALRCV_STARTING 
WALRCV_STREAMING 
WALRCV_WAITING 
WALRCV_RESTARTING 
WALRCV_STOPPING 

Definition at line 45 of file walreceiver.h.

46 {
47  WALRCV_STOPPED, /* stopped and mustn't start up again */
48  WALRCV_STARTING, /* launched, but the process hasn't
49  * initialized yet */
50  WALRCV_STREAMING, /* walreceiver is streaming */
51  WALRCV_WAITING, /* stopped streaming, waiting for orders */
52  WALRCV_RESTARTING, /* asked to restart streaming */
53  WALRCV_STOPPING /* requested to stop, but still running */
54 } WalRcvState;
WalRcvState
Definition: walreceiver.h:46
@ WALRCV_STARTING
Definition: walreceiver.h:48
@ WALRCV_STOPPED
Definition: walreceiver.h:47
@ WALRCV_RESTARTING
Definition: walreceiver.h:52
@ WALRCV_STREAMING
Definition: walreceiver.h:50
@ WALRCV_WAITING
Definition: walreceiver.h:51
@ WALRCV_STOPPING
Definition: walreceiver.h:53

Function Documentation

◆ GetReplicationApplyDelay()

int GetReplicationApplyDelay ( void  )

Definition at line 365 of file walreceiverfuncs.c.

366 {
367  WalRcvData *walrcv = WalRcv;
368  XLogRecPtr receivePtr;
369  XLogRecPtr replayPtr;
370  TimestampTz chunkReplayStartTime;
371 
372  SpinLockAcquire(&walrcv->mutex);
373  receivePtr = walrcv->flushedUpto;
374  SpinLockRelease(&walrcv->mutex);
375 
376  replayPtr = GetXLogReplayRecPtr(NULL);
377 
378  if (receivePtr == replayPtr)
379  return 0;
380 
381  chunkReplayStartTime = GetCurrentChunkReplayStartTime();
382 
383  if (chunkReplayStartTime == 0)
384  return -1;
385 
386  return TimestampDifferenceMilliseconds(chunkReplayStartTime,
388 }
long TimestampDifferenceMilliseconds(TimestampTz start_time, TimestampTz stop_time)
Definition: timestamp.c:1687
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1574
int64 TimestampTz
Definition: timestamp.h:39
#define SpinLockRelease(lock)
Definition: spin.h:64
#define SpinLockAcquire(lock)
Definition: spin.h:62
XLogRecPtr flushedUpto
Definition: walreceiver.h:85
slock_t mutex
Definition: walreceiver.h:145
WalRcvData * WalRcv
uint64 XLogRecPtr
Definition: xlogdefs.h:21
TimestampTz GetCurrentChunkReplayStartTime(void)
XLogRecPtr GetXLogReplayRecPtr(TimeLineID *replayTLI)

References WalRcvData::flushedUpto, GetCurrentChunkReplayStartTime(), GetCurrentTimestamp(), GetXLogReplayRecPtr(), WalRcvData::mutex, SpinLockAcquire, SpinLockRelease, TimestampDifferenceMilliseconds(), and WalRcv.

Referenced by ProcessWalSndrMessage().

◆ GetReplicationTransferLatency()

int GetReplicationTransferLatency ( void  )

Definition at line 395 of file walreceiverfuncs.c.

396 {
397  WalRcvData *walrcv = WalRcv;
398  TimestampTz lastMsgSendTime;
399  TimestampTz lastMsgReceiptTime;
400 
401  SpinLockAcquire(&walrcv->mutex);
402  lastMsgSendTime = walrcv->lastMsgSendTime;
403  lastMsgReceiptTime = walrcv->lastMsgReceiptTime;
404  SpinLockRelease(&walrcv->mutex);
405 
406  return TimestampDifferenceMilliseconds(lastMsgSendTime,
407  lastMsgReceiptTime);
408 }
TimestampTz lastMsgReceiptTime
Definition: walreceiver.h:100
TimestampTz lastMsgSendTime
Definition: walreceiver.h:99

References WalRcvData::lastMsgReceiptTime, WalRcvData::lastMsgSendTime, WalRcvData::mutex, SpinLockAcquire, SpinLockRelease, TimestampDifferenceMilliseconds(), and WalRcv.

Referenced by ProcessWalSndrMessage().

◆ GetWalRcvFlushRecPtr()

XLogRecPtr GetWalRcvFlushRecPtr ( XLogRecPtr latestChunkStart,
TimeLineID receiveTLI 
)

Definition at line 332 of file walreceiverfuncs.c.

333 {
334  WalRcvData *walrcv = WalRcv;
335  XLogRecPtr recptr;
336 
337  SpinLockAcquire(&walrcv->mutex);
338  recptr = walrcv->flushedUpto;
339  if (latestChunkStart)
340  *latestChunkStart = walrcv->latestChunkStart;
341  if (receiveTLI)
342  *receiveTLI = walrcv->receivedTLI;
343  SpinLockRelease(&walrcv->mutex);
344 
345  return recptr;
346 }
TimeLineID receivedTLI
Definition: walreceiver.h:86
XLogRecPtr latestChunkStart
Definition: walreceiver.h:94
static TimeLineID receiveTLI
Definition: xlogrecovery.c:260

References WalRcvData::flushedUpto, WalRcvData::latestChunkStart, WalRcvData::mutex, WalRcvData::receivedTLI, receiveTLI, SpinLockAcquire, SpinLockRelease, and WalRcv.

Referenced by CreateRestartPoint(), GetStandbyFlushRecPtr(), pg_last_wal_receive_lsn(), and WaitForWALToBecomeAvailable().

◆ GetWalRcvWriteRecPtr()

XLogRecPtr GetWalRcvWriteRecPtr ( void  )

Definition at line 353 of file walreceiverfuncs.c.

354 {
355  WalRcvData *walrcv = WalRcv;
356 
357  return pg_atomic_read_u64(&walrcv->writtenUpto);
358 }
static uint64 pg_atomic_read_u64(volatile pg_atomic_uint64 *ptr)
Definition: atomics.h:429
pg_atomic_uint64 writtenUpto
Definition: walreceiver.h:153

References pg_atomic_read_u64(), WalRcv, and WalRcvData::writtenUpto.

◆ ProcessWalRcvInterrupts()

void ProcessWalRcvInterrupts ( void  )

Definition at line 150 of file walreceiver.c.

151 {
152  /*
153  * Although walreceiver interrupt handling doesn't use the same scheme as
154  * regular backends, call CHECK_FOR_INTERRUPTS() to make sure we receive
155  * any incoming signals on Win32, and also to make sure we process any
156  * barrier events.
157  */
159 
161  {
162  ereport(FATAL,
163  (errcode(ERRCODE_ADMIN_SHUTDOWN),
164  errmsg("terminating walreceiver process due to administrator command")));
165  }
166 }
int errcode(int sqlerrcode)
Definition: elog.c:693
int errmsg(const char *fmt,...)
Definition: elog.c:904
#define FATAL
Definition: elog.h:35
#define ereport(elevel,...)
Definition: elog.h:143
volatile sig_atomic_t ShutdownRequestPending
Definition: interrupt.c:28
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:121

References CHECK_FOR_INTERRUPTS, ereport, errcode(), errmsg(), FATAL, and ShutdownRequestPending.

Referenced by libpqrcv_connect(), libpqrcv_PQgetResult(), libpqrcv_processTuples(), WalRcvWaitForStartPosition(), and WalReceiverMain().

◆ RequestXLogStreaming()

void RequestXLogStreaming ( TimeLineID  tli,
XLogRecPtr  recptr,
const char *  conninfo,
const char *  slotname,
bool  create_temp_slot 
)

Definition at line 246 of file walreceiverfuncs.c.

248 {
249  WalRcvData *walrcv = WalRcv;
250  bool launch = false;
251  pg_time_t now = (pg_time_t) time(NULL);
252  Latch *latch;
253 
254  /*
255  * We always start at the beginning of the segment. That prevents a broken
256  * segment (i.e., with no records in the first half of a segment) from
257  * being created by XLOG streaming, which might cause trouble later on if
258  * the segment is e.g archived.
259  */
260  if (XLogSegmentOffset(recptr, wal_segment_size) != 0)
261  recptr -= XLogSegmentOffset(recptr, wal_segment_size);
262 
263  SpinLockAcquire(&walrcv->mutex);
264 
265  /* It better be stopped if we try to restart it */
266  Assert(walrcv->walRcvState == WALRCV_STOPPED ||
267  walrcv->walRcvState == WALRCV_WAITING);
268 
269  if (conninfo != NULL)
270  strlcpy((char *) walrcv->conninfo, conninfo, MAXCONNINFO);
271  else
272  walrcv->conninfo[0] = '\0';
273 
274  /*
275  * Use configured replication slot if present, and ignore the value of
276  * create_temp_slot as the slot name should be persistent. Otherwise, use
277  * create_temp_slot to determine whether this WAL receiver should create a
278  * temporary slot by itself and use it, or not.
279  */
280  if (slotname != NULL && slotname[0] != '\0')
281  {
282  strlcpy((char *) walrcv->slotname, slotname, NAMEDATALEN);
283  walrcv->is_temp_slot = false;
284  }
285  else
286  {
287  walrcv->slotname[0] = '\0';
288  walrcv->is_temp_slot = create_temp_slot;
289  }
290 
291  if (walrcv->walRcvState == WALRCV_STOPPED)
292  {
293  launch = true;
294  walrcv->walRcvState = WALRCV_STARTING;
295  }
296  else
297  walrcv->walRcvState = WALRCV_RESTARTING;
298  walrcv->startTime = now;
299 
300  /*
301  * If this is the first startup of walreceiver (on this timeline),
302  * initialize flushedUpto and latestChunkStart to the starting point.
303  */
304  if (walrcv->receiveStart == 0 || walrcv->receivedTLI != tli)
305  {
306  walrcv->flushedUpto = recptr;
307  walrcv->receivedTLI = tli;
308  walrcv->latestChunkStart = recptr;
309  }
310  walrcv->receiveStart = recptr;
311  walrcv->receiveStartTLI = tli;
312 
313  latch = walrcv->latch;
314 
315  SpinLockRelease(&walrcv->mutex);
316 
317  if (launch)
319  else if (latch)
320  SetLatch(latch);
321 }
Datum now(PG_FUNCTION_ARGS)
Definition: timestamp.c:1538
void SetLatch(Latch *latch)
Definition: latch.c:566
Assert(fmt[strlen(fmt) - 1] !='\n')
#define NAMEDATALEN
int64 pg_time_t
Definition: pgtime.h:23
void SendPostmasterSignal(PMSignalReason reason)
Definition: pmsignal.c:153
@ PMSIGNAL_START_WALRECEIVER
Definition: pmsignal.h:41
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
Definition: latch.h:111
TimeLineID receiveStartTLI
Definition: walreceiver.h:76
char slotname[NAMEDATALEN]
Definition: walreceiver.h:125
Latch * latch
Definition: walreceiver.h:143
XLogRecPtr receiveStart
Definition: walreceiver.h:75
bool is_temp_slot
Definition: walreceiver.h:131
pg_time_t startTime
Definition: walreceiver.h:67
WalRcvState walRcvState
Definition: walreceiver.h:65
char conninfo[MAXCONNINFO]
Definition: walreceiver.h:112
#define MAXCONNINFO
Definition: walreceiver.h:37
int wal_segment_size
Definition: xlog.c:144
#define XLogSegmentOffset(xlogptr, wal_segsz_bytes)

References Assert(), WalRcvData::conninfo, WalRcvData::flushedUpto, WalRcvData::is_temp_slot, WalRcvData::latch, WalRcvData::latestChunkStart, MAXCONNINFO, WalRcvData::mutex, NAMEDATALEN, now(), PMSIGNAL_START_WALRECEIVER, WalRcvData::receivedTLI, WalRcvData::receiveStart, WalRcvData::receiveStartTLI, SendPostmasterSignal(), SetLatch(), WalRcvData::slotname, SpinLockAcquire, SpinLockRelease, WalRcvData::startTime, strlcpy(), wal_segment_size, WalRcv, WALRCV_RESTARTING, WALRCV_STARTING, WALRCV_STOPPED, WALRCV_WAITING, WalRcvData::walRcvState, and XLogSegmentOffset.

Referenced by WaitForWALToBecomeAvailable().

◆ ShutdownWalRcv()

void ShutdownWalRcv ( void  )

Definition at line 179 of file walreceiverfuncs.c.

180 {
181  WalRcvData *walrcv = WalRcv;
182  pid_t walrcvpid = 0;
183  bool stopped = false;
184 
185  /*
186  * Request walreceiver to stop. Walreceiver will switch to WALRCV_STOPPED
187  * mode once it's finished, and will also request postmaster to not
188  * restart itself.
189  */
190  SpinLockAcquire(&walrcv->mutex);
191  switch (walrcv->walRcvState)
192  {
193  case WALRCV_STOPPED:
194  break;
195  case WALRCV_STARTING:
196  walrcv->walRcvState = WALRCV_STOPPED;
197  stopped = true;
198  break;
199 
200  case WALRCV_STREAMING:
201  case WALRCV_WAITING:
202  case WALRCV_RESTARTING:
203  walrcv->walRcvState = WALRCV_STOPPING;
204  /* fall through */
205  case WALRCV_STOPPING:
206  walrcvpid = walrcv->pid;
207  break;
208  }
209  SpinLockRelease(&walrcv->mutex);
210 
211  /* Unnecessary but consistent. */
212  if (stopped)
214 
215  /*
216  * Signal walreceiver process if it was still running.
217  */
218  if (walrcvpid != 0)
219  kill(walrcvpid, SIGTERM);
220 
221  /*
222  * Wait for walreceiver to acknowledge its death by setting state to
223  * WALRCV_STOPPED.
224  */
226  while (WalRcvRunning())
230 }
void ConditionVariableBroadcast(ConditionVariable *cv)
void ConditionVariablePrepareToSleep(ConditionVariable *cv)
void ConditionVariableSleep(ConditionVariable *cv, uint32 wait_event_info)
void ConditionVariableCancelSleep(void)
pid_t pid
Definition: walreceiver.h:64
ConditionVariable walRcvStoppedCV
Definition: walreceiver.h:66
@ WAIT_EVENT_WAL_RECEIVER_EXIT
Definition: wait_event.h:129
bool WalRcvRunning(void)
#define kill(pid, sig)
Definition: win32_port.h:464

References ConditionVariableBroadcast(), ConditionVariableCancelSleep(), ConditionVariablePrepareToSleep(), ConditionVariableSleep(), kill, WalRcvData::mutex, WalRcvData::pid, SpinLockAcquire, SpinLockRelease, WAIT_EVENT_WAL_RECEIVER_EXIT, WalRcv, WALRCV_RESTARTING, WALRCV_STARTING, WALRCV_STOPPED, WALRCV_STOPPING, WALRCV_STREAMING, WALRCV_WAITING, WalRcvRunning(), WalRcvData::walRcvState, and WalRcvData::walRcvStoppedCV.

Referenced by XLogShutdownWalRcv().

◆ walrcv_clear_result()

static void walrcv_clear_result ( WalRcvExecResult walres)
inlinestatic

Definition at line 436 of file walreceiver.h.

437 {
438  if (!walres)
439  return;
440 
441  if (walres->err)
442  pfree(walres->err);
443 
444  if (walres->tuplestore)
445  tuplestore_end(walres->tuplestore);
446 
447  if (walres->tupledesc)
448  FreeTupleDesc(walres->tupledesc);
449 
450  pfree(walres);
451 }
void pfree(void *pointer)
Definition: mcxt.c:1175
Tuplestorestate * tuplestore
Definition: walreceiver.h:219
TupleDesc tupledesc
Definition: walreceiver.h:220
void FreeTupleDesc(TupleDesc tupdesc)
Definition: tupdesc.c:309
void tuplestore_end(Tuplestorestate *state)
Definition: tuplestore.c:453

References WalRcvExecResult::err, FreeTupleDesc(), pfree(), WalRcvExecResult::tupledesc, WalRcvExecResult::tuplestore, and tuplestore_end().

Referenced by check_publications(), copy_table(), fetch_remote_table_info(), fetch_table_list(), LogicalRepSyncTableStart(), and ReplicationSlotDropAtPubNode().

◆ WalRcvForceReply()

void WalRcvForceReply ( void  )

Definition at line 1297 of file walreceiver.c.

1298 {
1299  Latch *latch;
1300 
1301  WalRcv->force_reply = true;
1302  /* fetching the latch pointer might not be atomic, so use spinlock */
1304  latch = WalRcv->latch;
1306  if (latch)
1307  SetLatch(latch);
1308 }
sig_atomic_t force_reply
Definition: walreceiver.h:160

References WalRcvData::force_reply, WalRcvData::latch, WalRcvData::mutex, SetLatch(), SpinLockAcquire, SpinLockRelease, and WalRcv.

Referenced by ApplyWalRecord(), and WaitForWALToBecomeAvailable().

◆ WalRcvRunning()

bool WalRcvRunning ( void  )

Definition at line 76 of file walreceiverfuncs.c.

77 {
78  WalRcvData *walrcv = WalRcv;
80  pg_time_t startTime;
81 
82  SpinLockAcquire(&walrcv->mutex);
83 
84  state = walrcv->walRcvState;
85  startTime = walrcv->startTime;
86 
87  SpinLockRelease(&walrcv->mutex);
88 
89  /*
90  * If it has taken too long for walreceiver to start up, give up. Setting
91  * the state to STOPPED ensures that if walreceiver later does start up
92  * after all, it will see that it's not supposed to be running and die
93  * without doing anything.
94  */
95  if (state == WALRCV_STARTING)
96  {
97  pg_time_t now = (pg_time_t) time(NULL);
98 
99  if ((now - startTime) > WALRCV_STARTUP_TIMEOUT)
100  {
101  bool stopped = false;
102 
103  SpinLockAcquire(&walrcv->mutex);
104  if (walrcv->walRcvState == WALRCV_STARTING)
105  {
106  state = walrcv->walRcvState = WALRCV_STOPPED;
107  stopped = true;
108  }
109  SpinLockRelease(&walrcv->mutex);
110 
111  if (stopped)
113  }
114  }
115 
116  if (state != WALRCV_STOPPED)
117  return true;
118  else
119  return false;
120 }
Definition: regguts.h:318
#define WALRCV_STARTUP_TIMEOUT

References ConditionVariableBroadcast(), WalRcvData::mutex, now(), SpinLockAcquire, SpinLockRelease, WalRcvData::startTime, WalRcv, WALRCV_STARTING, WALRCV_STARTUP_TIMEOUT, WALRCV_STOPPED, WalRcvData::walRcvState, and WalRcvData::walRcvStoppedCV.

Referenced by ShutdownWalRcv(), and StartupRequestWalReceiverRestart().

◆ WalRcvShmemInit()

void WalRcvShmemInit ( void  )

Definition at line 55 of file walreceiverfuncs.c.

56 {
57  bool found;
58 
59  WalRcv = (WalRcvData *)
60  ShmemInitStruct("Wal Receiver Ctl", WalRcvShmemSize(), &found);
61 
62  if (!found)
63  {
64  /* First time through, so initialize */
70  WalRcv->latch = NULL;
71  }
72 }
static void pg_atomic_init_u64(volatile pg_atomic_uint64 *ptr, uint64 val)
Definition: atomics.h:415
#define MemSet(start, val, len)
Definition: c.h:1008
void ConditionVariableInit(ConditionVariable *cv)
void * ShmemInitStruct(const char *name, Size size, bool *foundPtr)
Definition: shmem.c:396
#define SpinLockInit(lock)
Definition: spin.h:60
Size WalRcvShmemSize(void)

References ConditionVariableInit(), WalRcvData::latch, MemSet, WalRcvData::mutex, pg_atomic_init_u64(), ShmemInitStruct(), SpinLockInit, WalRcv, WALRCV_STOPPED, WalRcvShmemSize(), WalRcvData::walRcvState, WalRcvData::walRcvStoppedCV, and WalRcvData::writtenUpto.

Referenced by CreateSharedMemoryAndSemaphores().

◆ WalRcvShmemSize()

Size WalRcvShmemSize ( void  )

Definition at line 44 of file walreceiverfuncs.c.

45 {
46  Size size = 0;
47 
48  size = add_size(size, sizeof(WalRcvData));
49 
50  return size;
51 }
size_t Size
Definition: c.h:540
Size add_size(Size s1, Size s2)
Definition: shmem.c:502

References add_size().

Referenced by CalculateShmemSize(), and WalRcvShmemInit().

◆ WalRcvStreaming()

bool WalRcvStreaming ( void  )

Definition at line 127 of file walreceiverfuncs.c.

128 {
129  WalRcvData *walrcv = WalRcv;
131  pg_time_t startTime;
132 
133  SpinLockAcquire(&walrcv->mutex);
134 
135  state = walrcv->walRcvState;
136  startTime = walrcv->startTime;
137 
138  SpinLockRelease(&walrcv->mutex);
139 
140  /*
141  * If it has taken too long for walreceiver to start up, give up. Setting
142  * the state to STOPPED ensures that if walreceiver later does start up
143  * after all, it will see that it's not supposed to be running and die
144  * without doing anything.
145  */
146  if (state == WALRCV_STARTING)
147  {
148  pg_time_t now = (pg_time_t) time(NULL);
149 
150  if ((now - startTime) > WALRCV_STARTUP_TIMEOUT)
151  {
152  bool stopped = false;
153 
154  SpinLockAcquire(&walrcv->mutex);
155  if (walrcv->walRcvState == WALRCV_STARTING)
156  {
157  state = walrcv->walRcvState = WALRCV_STOPPED;
158  stopped = true;
159  }
160  SpinLockRelease(&walrcv->mutex);
161 
162  if (stopped)
164  }
165  }
166 
169  return true;
170  else
171  return false;
172 }

References ConditionVariableBroadcast(), WalRcvData::mutex, now(), SpinLockAcquire, SpinLockRelease, WalRcvData::startTime, WalRcv, WALRCV_RESTARTING, WALRCV_STARTING, WALRCV_STARTUP_TIMEOUT, WALRCV_STOPPED, WALRCV_STREAMING, WalRcvData::walRcvState, and WalRcvData::walRcvStoppedCV.

Referenced by FinishWalRecovery(), and WaitForWALToBecomeAvailable().

◆ WalReceiverMain()

void WalReceiverMain ( void  )

Definition at line 171 of file walreceiver.c.

172 {
173  char conninfo[MAXCONNINFO];
174  char *tmp_conninfo;
175  char slotname[NAMEDATALEN];
176  bool is_temp_slot;
177  XLogRecPtr startpoint;
178  TimeLineID startpointTLI;
179  TimeLineID primaryTLI;
180  bool first_stream;
181  WalRcvData *walrcv = WalRcv;
182  TimestampTz last_recv_timestamp;
184  bool ping_sent;
185  char *err;
186  char *sender_host = NULL;
187  int sender_port = 0;
188 
189  /*
190  * WalRcv should be set up already (if we are a backend, we inherit this
191  * by fork() or EXEC_BACKEND mechanism from the postmaster).
192  */
193  Assert(walrcv != NULL);
194 
196 
197  /*
198  * Mark walreceiver as running in shared memory.
199  *
200  * Do this as early as possible, so that if we fail later on, we'll set
201  * state to STOPPED. If we die before this, the startup process will keep
202  * waiting for us to start up, until it times out.
203  */
204  SpinLockAcquire(&walrcv->mutex);
205  Assert(walrcv->pid == 0);
206  switch (walrcv->walRcvState)
207  {
208  case WALRCV_STOPPING:
209  /* If we've already been requested to stop, don't start up. */
210  walrcv->walRcvState = WALRCV_STOPPED;
211  /* fall through */
212 
213  case WALRCV_STOPPED:
214  SpinLockRelease(&walrcv->mutex);
216  proc_exit(1);
217  break;
218 
219  case WALRCV_STARTING:
220  /* The usual case */
221  break;
222 
223  case WALRCV_WAITING:
224  case WALRCV_STREAMING:
225  case WALRCV_RESTARTING:
226  default:
227  /* Shouldn't happen */
228  SpinLockRelease(&walrcv->mutex);
229  elog(PANIC, "walreceiver still running according to shared memory state");
230  }
231  /* Advertise our PID so that the startup process can kill us */
232  walrcv->pid = MyProcPid;
233  walrcv->walRcvState = WALRCV_STREAMING;
234 
235  /* Fetch information required to start streaming */
236  walrcv->ready_to_display = false;
237  strlcpy(conninfo, (char *) walrcv->conninfo, MAXCONNINFO);
238  strlcpy(slotname, (char *) walrcv->slotname, NAMEDATALEN);
239  is_temp_slot = walrcv->is_temp_slot;
240  startpoint = walrcv->receiveStart;
241  startpointTLI = walrcv->receiveStartTLI;
242 
243  /*
244  * At most one of is_temp_slot and slotname can be set; otherwise,
245  * RequestXLogStreaming messed up.
246  */
247  Assert(!is_temp_slot || (slotname[0] == '\0'));
248 
249  /* Initialise to a sanish value */
250  walrcv->lastMsgSendTime =
251  walrcv->lastMsgReceiptTime = walrcv->latestWalEndTime = now;
252 
253  /* Report the latch to use to awaken this process */
254  walrcv->latch = &MyProc->procLatch;
255 
256  SpinLockRelease(&walrcv->mutex);
257 
259 
260  /* Arrange to clean up at walreceiver exit */
261  on_shmem_exit(WalRcvDie, PointerGetDatum(&startpointTLI));
262 
263  /* Properly accept or ignore signals the postmaster might send us */
264  pqsignal(SIGHUP, SignalHandlerForConfigReload); /* set flag to read config
265  * file */
266  pqsignal(SIGINT, SIG_IGN);
267  pqsignal(SIGTERM, SignalHandlerForShutdownRequest); /* request shutdown */
268  /* SIGQUIT handler was already set up by InitPostmasterChild */
273 
274  /* Reset some signals that are accepted by postmaster but not here */
276 
277  /* Load the libpq-specific functions */
278  load_file("libpqwalreceiver", false);
279  if (WalReceiverFunctions == NULL)
280  elog(ERROR, "libpqwalreceiver didn't initialize correctly");
281 
282  /* Unblock signals (they were blocked when the postmaster forked us) */
284 
285  /* Establish the connection to the primary for XLOG streaming */
286  wrconn = walrcv_connect(conninfo, false,
287  cluster_name[0] ? cluster_name : "walreceiver",
288  &err);
289  if (!wrconn)
290  ereport(ERROR,
291  (errcode(ERRCODE_CONNECTION_FAILURE),
292  errmsg("could not connect to the primary server: %s", err)));
293 
294  /*
295  * Save user-visible connection string. This clobbers the original
296  * conninfo, for security. Also save host and port of the sender server
297  * this walreceiver is connected to.
298  */
299  tmp_conninfo = walrcv_get_conninfo(wrconn);
300  walrcv_get_senderinfo(wrconn, &sender_host, &sender_port);
301  SpinLockAcquire(&walrcv->mutex);
302  memset(walrcv->conninfo, 0, MAXCONNINFO);
303  if (tmp_conninfo)
304  strlcpy((char *) walrcv->conninfo, tmp_conninfo, MAXCONNINFO);
305 
306  memset(walrcv->sender_host, 0, NI_MAXHOST);
307  if (sender_host)
308  strlcpy((char *) walrcv->sender_host, sender_host, NI_MAXHOST);
309 
310  walrcv->sender_port = sender_port;
311  walrcv->ready_to_display = true;
312  SpinLockRelease(&walrcv->mutex);
313 
314  if (tmp_conninfo)
315  pfree(tmp_conninfo);
316 
317  if (sender_host)
318  pfree(sender_host);
319 
320  first_stream = true;
321  for (;;)
322  {
323  char *primary_sysid;
324  char standby_sysid[32];
326 
327  /*
328  * Check that we're connected to a valid server using the
329  * IDENTIFY_SYSTEM replication command.
330  */
331  primary_sysid = walrcv_identify_system(wrconn, &primaryTLI);
332 
333  snprintf(standby_sysid, sizeof(standby_sysid), UINT64_FORMAT,
335  if (strcmp(primary_sysid, standby_sysid) != 0)
336  {
337  ereport(ERROR,
338  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
339  errmsg("database system identifier differs between the primary and standby"),
340  errdetail("The primary's identifier is %s, the standby's identifier is %s.",
341  primary_sysid, standby_sysid)));
342  }
343 
344  /*
345  * Confirm that the current timeline of the primary is the same or
346  * ahead of ours.
347  */
348  if (primaryTLI < startpointTLI)
349  ereport(ERROR,
350  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
351  errmsg("highest timeline %u of the primary is behind recovery timeline %u",
352  primaryTLI, startpointTLI)));
353 
354  /*
355  * Get any missing history files. We do this always, even when we're
356  * not interested in that timeline, so that if we're promoted to
357  * become the primary later on, we don't select the same timeline that
358  * was already used in the current primary. This isn't bullet-proof -
359  * you'll need some external software to manage your cluster if you
360  * need to ensure that a unique timeline id is chosen in every case,
361  * but let's avoid the confusion of timeline id collisions where we
362  * can.
363  */
364  WalRcvFetchTimeLineHistoryFiles(startpointTLI, primaryTLI);
365 
366  /*
367  * Create temporary replication slot if requested, and update slot
368  * name in shared memory. (Note the slot name cannot already be set
369  * in this case.)
370  */
371  if (is_temp_slot)
372  {
373  snprintf(slotname, sizeof(slotname),
374  "pg_walreceiver_%lld",
375  (long long int) walrcv_get_backend_pid(wrconn));
376 
377  walrcv_create_slot(wrconn, slotname, true, false, 0, NULL);
378 
379  SpinLockAcquire(&walrcv->mutex);
380  strlcpy(walrcv->slotname, slotname, NAMEDATALEN);
381  SpinLockRelease(&walrcv->mutex);
382  }
383 
384  /*
385  * Start streaming.
386  *
387  * We'll try to start at the requested starting point and timeline,
388  * even if it's different from the server's latest timeline. In case
389  * we've already reached the end of the old timeline, the server will
390  * finish the streaming immediately, and we will go back to await
391  * orders from the startup process. If recovery_target_timeline is
392  * 'latest', the startup process will scan pg_wal and find the new
393  * history file, bump recovery target timeline, and ask us to restart
394  * on the new timeline.
395  */
396  options.logical = false;
397  options.startpoint = startpoint;
398  options.slotname = slotname[0] != '\0' ? slotname : NULL;
399  options.proto.physical.startpointTLI = startpointTLI;
401  {
402  if (first_stream)
403  ereport(LOG,
404  (errmsg("started streaming WAL from primary at %X/%X on timeline %u",
405  LSN_FORMAT_ARGS(startpoint), startpointTLI)));
406  else
407  ereport(LOG,
408  (errmsg("restarted WAL streaming at %X/%X on timeline %u",
409  LSN_FORMAT_ARGS(startpoint), startpointTLI)));
410  first_stream = false;
411 
412  /* Initialize LogstreamResult and buffers for processing messages */
416 
417  /* Initialize the last recv timestamp */
418  last_recv_timestamp = GetCurrentTimestamp();
419  ping_sent = false;
420 
421  /* Loop until end-of-streaming or error */
422  for (;;)
423  {
424  char *buf;
425  int len;
426  bool endofwal = false;
427  pgsocket wait_fd = PGINVALID_SOCKET;
428  int rc;
429 
430  /*
431  * Exit walreceiver if we're not in recovery. This should not
432  * happen, but cross-check the status here.
433  */
434  if (!RecoveryInProgress())
435  ereport(FATAL,
436  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
437  errmsg("cannot continue WAL streaming, recovery has already ended")));
438 
439  /* Process any requests or signals received recently */
441 
443  {
444  ConfigReloadPending = false;
447  }
448 
449  /* See if we can read data immediately */
450  len = walrcv_receive(wrconn, &buf, &wait_fd);
451  if (len != 0)
452  {
453  /*
454  * Process the received data, and any subsequent data we
455  * can read without blocking.
456  */
457  for (;;)
458  {
459  if (len > 0)
460  {
461  /*
462  * Something was received from primary, so reset
463  * timeout
464  */
465  last_recv_timestamp = GetCurrentTimestamp();
466  ping_sent = false;
467  XLogWalRcvProcessMsg(buf[0], &buf[1], len - 1,
468  startpointTLI);
469  }
470  else if (len == 0)
471  break;
472  else if (len < 0)
473  {
474  ereport(LOG,
475  (errmsg("replication terminated by primary server"),
476  errdetail("End of WAL reached on timeline %u at %X/%X.",
477  startpointTLI,
479  endofwal = true;
480  break;
481  }
482  len = walrcv_receive(wrconn, &buf, &wait_fd);
483  }
484 
485  /* Let the primary know that we received some data. */
486  XLogWalRcvSendReply(false, false);
487 
488  /*
489  * If we've written some records, flush them to disk and
490  * let the startup process and primary server know about
491  * them.
492  */
493  XLogWalRcvFlush(false, startpointTLI);
494  }
495 
496  /* Check if we need to exit the streaming loop. */
497  if (endofwal)
498  break;
499 
500  /*
501  * Ideally we would reuse a WaitEventSet object repeatedly
502  * here to avoid the overheads of WaitLatchOrSocket on epoll
503  * systems, but we can't be sure that libpq (or any other
504  * walreceiver implementation) has the same socket (even if
505  * the fd is the same number, it may have been closed and
506  * reopened since the last time). In future, if there is a
507  * function for removing sockets from WaitEventSet, then we
508  * could add and remove just the socket each time, potentially
509  * avoiding some system calls.
510  */
511  Assert(wait_fd != PGINVALID_SOCKET);
515  wait_fd,
518  if (rc & WL_LATCH_SET)
519  {
522 
523  if (walrcv->force_reply)
524  {
525  /*
526  * The recovery process has asked us to send apply
527  * feedback now. Make sure the flag is really set to
528  * false in shared memory before sending the reply, so
529  * we don't miss a new request for a reply.
530  */
531  walrcv->force_reply = false;
533  XLogWalRcvSendReply(true, false);
534  }
535  }
536  if (rc & WL_TIMEOUT)
537  {
538  /*
539  * We didn't receive anything new. If we haven't heard
540  * anything from the server for more than
541  * wal_receiver_timeout / 2, ping the server. Also, if
542  * it's been longer than wal_receiver_status_interval
543  * since the last update we sent, send a status update to
544  * the primary anyway, to report any progress in applying
545  * WAL.
546  */
547  bool requestReply = false;
548 
549  /*
550  * Check if time since last receive from primary has
551  * reached the configured limit.
552  */
553  if (wal_receiver_timeout > 0)
554  {
556  TimestampTz timeout;
557 
558  timeout =
559  TimestampTzPlusMilliseconds(last_recv_timestamp,
561 
562  if (now >= timeout)
563  ereport(ERROR,
564  (errcode(ERRCODE_CONNECTION_FAILURE),
565  errmsg("terminating walreceiver due to timeout")));
566 
567  /*
568  * We didn't receive anything new, for half of
569  * receiver replication timeout. Ping the server.
570  */
571  if (!ping_sent)
572  {
573  timeout = TimestampTzPlusMilliseconds(last_recv_timestamp,
574  (wal_receiver_timeout / 2));
575  if (now >= timeout)
576  {
577  requestReply = true;
578  ping_sent = true;
579  }
580  }
581  }
582 
583  XLogWalRcvSendReply(requestReply, requestReply);
585  }
586  }
587 
588  /*
589  * The backend finished streaming. Exit streaming COPY-mode from
590  * our side, too.
591  */
592  walrcv_endstreaming(wrconn, &primaryTLI);
593 
594  /*
595  * If the server had switched to a new timeline that we didn't
596  * know about when we began streaming, fetch its timeline history
597  * file now.
598  */
599  WalRcvFetchTimeLineHistoryFiles(startpointTLI, primaryTLI);
600  }
601  else
602  ereport(LOG,
603  (errmsg("primary server contains no more WAL on requested timeline %u",
604  startpointTLI)));
605 
606  /*
607  * End of WAL reached on the requested timeline. Close the last
608  * segment, and await for new orders from the startup process.
609  */
610  if (recvFile >= 0)
611  {
612  char xlogfname[MAXFNAMELEN];
613 
614  XLogWalRcvFlush(false, startpointTLI);
616  if (close(recvFile) != 0)
617  ereport(PANIC,
619  errmsg("could not close log segment %s: %m",
620  xlogfname)));
621 
622  /*
623  * Create .done file forcibly to prevent the streamed segment from
624  * being archived later.
625  */
627  XLogArchiveForceDone(xlogfname);
628  else
629  XLogArchiveNotify(xlogfname);
630  }
631  recvFile = -1;
632 
633  elog(DEBUG1, "walreceiver ended streaming and awaits new instructions");
634  WalRcvWaitForStartPosition(&startpoint, &startpointTLI);
635  }
636  /* not reached */
637 }
static void pg_atomic_write_u64(volatile pg_atomic_uint64 *ptr, uint64 val)
Definition: atomics.h:438
#define pg_memory_barrier()
Definition: atomics.h:145
sigset_t UnBlockSig
Definition: pqsignal.c:22
#define UINT64_FORMAT
Definition: c.h:484
void load_file(const char *filename, bool restricted)
Definition: dfmgr.c:144
int errcode_for_file_access(void)
Definition: elog.c:716
int errdetail(const char *fmt,...)
Definition: elog.c:1037
#define LOG
Definition: elog.h:25
#define PANIC
Definition: elog.h:36
#define DEBUG1
Definition: elog.h:24
#define ERROR
Definition: elog.h:33
#define elog(elevel,...)
Definition: elog.h:218
#define NI_MAXHOST
Definition: getaddrinfo.h:88
int MyProcPid
Definition: globals.c:44
struct Latch * MyLatch
Definition: globals.c:58
char * cluster_name
Definition: guc.c:653
@ PGC_SIGHUP
Definition: guc.h:72
void ProcessConfigFile(GucContext context)
#define close(a)
Definition: win32.h:12
void SignalHandlerForShutdownRequest(SIGNAL_ARGS)
Definition: interrupt.c:108
volatile sig_atomic_t ConfigReloadPending
Definition: interrupt.c:27
void SignalHandlerForConfigReload(SIGNAL_ARGS)
Definition: interrupt.c:61
void on_shmem_exit(pg_on_exit_callback function, Datum arg)
Definition: ipc.c:361
void proc_exit(int code)
Definition: ipc.c:104
int WaitLatchOrSocket(Latch *latch, int wakeEvents, pgsocket sock, long timeout, uint32 wait_event_info)
Definition: latch.c:499
void ResetLatch(Latch *latch)
Definition: latch.c:658
#define WL_SOCKET_READABLE
Definition: latch.h:126
#define WL_TIMEOUT
Definition: latch.h:128
#define WL_EXIT_ON_PM_DEATH
Definition: latch.h:130
#define WL_LATCH_SET
Definition: latch.h:125
const void size_t len
static char ** options
static char * buf
Definition: pg_test_fsync.c:67
int pgsocket
Definition: port.h:29
#define snprintf
Definition: port.h:225
#define PGINVALID_SOCKET
Definition: port.h:31
#define PointerGetDatum(X)
Definition: postgres.h:600
#define PG_SETMASK(mask)
Definition: pqsignal.h:19
void procsignal_sigusr1_handler(SIGNAL_ARGS)
Definition: procsignal.c:638
pqsigfunc pqsignal(int signum, pqsigfunc handler)
Definition: signal.c:180
PGPROC * MyProc
Definition: proc.c:68
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
Latch procLatch
Definition: proc.h:168
char sender_host[NI_MAXHOST]
Definition: walreceiver.h:118
TimestampTz latestWalEndTime
Definition: walreceiver.h:106
bool ready_to_display
Definition: walreceiver.h:134
int sender_port
Definition: walreceiver.h:119
#define TimestampTzPlusMilliseconds(tz, ms)
Definition: timestamp.h:56
@ WAIT_EVENT_WAL_RECEIVER_MAIN
Definition: wait_event.h:47
void ProcessWalRcvInterrupts(void)
Definition: walreceiver.c:150
static WalReceiverConn * wrconn
Definition: walreceiver.c:95
static struct @17 LogstreamResult
static StringInfoData reply_message
Definition: walreceiver.c:119
static int recvFile
Definition: walreceiver.c:105
#define NAPTIME_PER_CYCLE
Definition: walreceiver.c:98
static void WalRcvFetchTimeLineHistoryFiles(TimeLineID first, TimeLineID last)
Definition: walreceiver.c:723
static StringInfoData incoming_message
Definition: walreceiver.c:120
static void XLogWalRcvFlush(bool dying, TimeLineID tli)
Definition: walreceiver.c:967
static TimeLineID recvFileTLI
Definition: walreceiver.c:106
WalReceiverFunctionsType * WalReceiverFunctions
Definition: walreceiver.c:96
int wal_receiver_timeout
Definition: walreceiver.c:91
static XLogSegNo recvSegNo
Definition: walreceiver.c:107
static void XLogWalRcvSendHSFeedback(bool immed)
Definition: walreceiver.c:1143
static void WalRcvWaitForStartPosition(XLogRecPtr *startpoint, TimeLineID *startpointTLI)
Definition: walreceiver.c:643
static void XLogWalRcvProcessMsg(unsigned char type, char *buf, Size len, TimeLineID tli)
Definition: walreceiver.c:817
static void WalRcvDie(int code, Datum arg)
Definition: walreceiver.c:779
static void XLogWalRcvSendReply(bool force, bool requestReply)
Definition: walreceiver.c:1074
#define walrcv_create_slot(conn, slotname, temporary, two_phase, snapshot_action, lsn)
Definition: walreceiver.h:426
#define walrcv_startstreaming(conn, options)
Definition: walreceiver.h:418
#define walrcv_connect(conninfo, logical, appname, err)
Definition: walreceiver.h:404
#define walrcv_get_senderinfo(conn, sender_host, sender_port)
Definition: walreceiver.h:410
#define walrcv_get_conninfo(conn)
Definition: walreceiver.h:408
#define walrcv_endstreaming(conn, next_tli)
Definition: walreceiver.h:420
#define walrcv_identify_system(conn, primary_tli)
Definition: walreceiver.h:412
#define walrcv_get_backend_pid(conn)
Definition: walreceiver.h:428
#define walrcv_receive(conn, buffer, wait_fd)
Definition: walreceiver.h:422
#define SIGCHLD
Definition: win32_port.h:177
#define SIGHUP
Definition: win32_port.h:167
#define SIG_DFL
Definition: win32_port.h:162
#define SIGPIPE
Definition: win32_port.h:172
#define SIGUSR1
Definition: win32_port.h:179
#define SIGALRM
Definition: win32_port.h:173
#define SIGUSR2
Definition: win32_port.h:180
#define SIG_IGN
Definition: win32_port.h:164
uint64 GetSystemIdentifier(void)
Definition: xlog.c:4206
bool RecoveryInProgress(void)
Definition: xlog.c:5753
int XLogArchiveMode
Definition: xlog.c:120
@ ARCHIVE_MODE_ALWAYS
Definition: xlog.h:62
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
#define MAXFNAMELEN
void XLogArchiveForceDone(const char *xlog)
Definition: xlogarchive.c:540
void XLogArchiveNotify(const char *xlog)
Definition: xlogarchive.c:474
#define LSN_FORMAT_ARGS(lsn)
Definition: xlogdefs.h:43
uint32 TimeLineID
Definition: xlogdefs.h:59

References ARCHIVE_MODE_ALWAYS, Assert(), buf, close, cluster_name, ConditionVariableBroadcast(), ConfigReloadPending, WalRcvData::conninfo, DEBUG1, elog, ereport, errcode(), errcode_for_file_access(), errdetail(), errmsg(), ERROR, FATAL, WalRcvData::force_reply, GetCurrentTimestamp(), GetSystemIdentifier(), GetXLogReplayRecPtr(), incoming_message, initStringInfo(), WalRcvData::is_temp_slot, WalRcvData::lastMsgReceiptTime, WalRcvData::lastMsgSendTime, WalRcvData::latch, WalRcvData::latestWalEndTime, len, load_file(), LOG, LogstreamResult, LSN_FORMAT_ARGS, MAXCONNINFO, MAXFNAMELEN, WalRcvData::mutex, MyLatch, MyProc, MyProcPid, NAMEDATALEN, NAPTIME_PER_CYCLE, NI_MAXHOST, now(), on_shmem_exit(), options, PANIC, pfree(), pg_atomic_write_u64(), pg_memory_barrier, PG_SETMASK, PGC_SIGHUP, PGINVALID_SOCKET, WalRcvData::pid, PointerGetDatum, pqsignal(), proc_exit(), ProcessConfigFile(), ProcessWalRcvInterrupts(), PGPROC::procLatch, procsignal_sigusr1_handler(), WalRcvData::ready_to_display, WalRcvData::receiveStart, WalRcvData::receiveStartTLI, RecoveryInProgress(), recvFile, recvFileTLI, recvSegNo, reply_message, ResetLatch(), WalRcvData::sender_host, WalRcvData::sender_port, SIG_DFL, SIG_IGN, SIGALRM, SIGCHLD, SIGHUP, SignalHandlerForConfigReload(), SignalHandlerForShutdownRequest(), SIGPIPE, SIGUSR1, SIGUSR2, WalRcvData::slotname, snprintf, SpinLockAcquire, SpinLockRelease, strlcpy(), TimestampTzPlusMilliseconds, UINT64_FORMAT, UnBlockSig, WAIT_EVENT_WAL_RECEIVER_MAIN, WaitLatchOrSocket(), wal_receiver_timeout, wal_segment_size, WalRcv, walrcv_connect, walrcv_create_slot, walrcv_endstreaming, walrcv_get_backend_pid, walrcv_get_conninfo, walrcv_get_senderinfo, walrcv_identify_system, walrcv_receive, WALRCV_RESTARTING, WALRCV_STARTING, walrcv_startstreaming, WALRCV_STOPPED, WALRCV_STOPPING, WALRCV_STREAMING, WALRCV_WAITING, WalRcvDie(), WalRcvFetchTimeLineHistoryFiles(), WalRcvData::walRcvState, WalRcvData::walRcvStoppedCV, WalRcvWaitForStartPosition(), WalReceiverFunctions, WL_EXIT_ON_PM_DEATH, WL_LATCH_SET, WL_SOCKET_READABLE, WL_TIMEOUT, wrconn, WalRcvData::writtenUpto, XLogArchiveForceDone(), XLogArchiveMode, XLogArchiveNotify(), XLogFileName, XLogWalRcvFlush(), XLogWalRcvProcessMsg(), XLogWalRcvSendHSFeedback(), and XLogWalRcvSendReply().

Referenced by AuxiliaryProcessMain().

Variable Documentation

◆ hot_standby_feedback

PGDLLIMPORT bool hot_standby_feedback
extern

Definition at line 92 of file walreceiver.c.

Referenced by XLogWalRcvSendHSFeedback().

◆ wal_receiver_status_interval

PGDLLIMPORT int wal_receiver_status_interval
extern

Definition at line 90 of file walreceiver.c.

Referenced by send_feedback(), XLogWalRcvSendHSFeedback(), and XLogWalRcvSendReply().

◆ wal_receiver_timeout

PGDLLIMPORT int wal_receiver_timeout
extern

Definition at line 91 of file walreceiver.c.

Referenced by logicalrep_worker_launch(), LogicalRepApplyLoop(), and WalReceiverMain().

◆ WalRcv

◆ WalReceiverFunctions

PGDLLIMPORT WalReceiverFunctionsType* WalReceiverFunctions
extern

Definition at line 96 of file walreceiver.c.

Referenced by _PG_init(), and WalReceiverMain().