PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
walreceiver.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * walreceiver.h
4  * Exports from replication/walreceiverfuncs.c.
5  *
6  * Portions Copyright (c) 2010-2017, PostgreSQL Global Development Group
7  *
8  * src/include/replication/walreceiver.h
9  *
10  *-------------------------------------------------------------------------
11  */
12 #ifndef _WALRECEIVER_H
13 #define _WALRECEIVER_H
14 
15 #include "access/xlog.h"
16 #include "access/xlogdefs.h"
17 #include "fmgr.h"
19 #include "replication/walsender.h"
20 #include "storage/latch.h"
21 #include "storage/spin.h"
22 #include "pgtime.h"
23 #include "utils/tuplestore.h"
24 
25 /* user-settable parameters */
27 extern int wal_receiver_timeout;
28 extern bool hot_standby_feedback;
29 
30 /*
31  * MAXCONNINFO: maximum size of a connection string.
32  *
33  * XXX: Should this move to pg_config_manual.h?
34  */
35 #define MAXCONNINFO 1024
36 
37 /* Can we allow the standby to accept replication connection from another standby? */
38 #define AllowCascadeReplication() (EnableHotStandby && max_wal_senders > 0)
39 
40 /*
41  * Values for WalRcv->walRcvState.
42  */
43 typedef enum
44 {
45  WALRCV_STOPPED, /* stopped and mustn't start up again */
46  WALRCV_STARTING, /* launched, but the process hasn't
47  * initialized yet */
48  WALRCV_STREAMING, /* walreceiver is streaming */
49  WALRCV_WAITING, /* stopped streaming, waiting for orders */
50  WALRCV_RESTARTING, /* asked to restart streaming */
51  WALRCV_STOPPING /* requested to stop, but still running */
52 } WalRcvState;
53 
54 /* Shared memory area for management of walreceiver process */
55 typedef struct
56 {
57  /*
58  * PID of currently active walreceiver process, its current state and
59  * start time (actually, the time at which it was requested to be
60  * started).
61  */
62  pid_t pid;
65 
66  /*
67  * receiveStart and receiveStartTLI indicate the first byte position and
68  * timeline that will be received. When startup process starts the
69  * walreceiver, it sets these to the point where it wants the streaming to
70  * begin.
71  */
74 
75  /*
76  * receivedUpto-1 is the last byte position that has already been
77  * received, and receivedTLI is the timeline it came from. At the first
78  * startup of walreceiver, these are set to receiveStart and
79  * receiveStartTLI. After that, walreceiver updates these whenever it
80  * flushes the received WAL to disk.
81  */
84 
85  /*
86  * latestChunkStart is the starting byte position of the current "batch"
87  * of received WAL. It's actually the same as the previous value of
88  * receivedUpto before the last flush to disk. Startup process can use
89  * this to detect whether it's keeping up or not.
90  */
92 
93  /*
94  * Time of send and receive of any message received.
95  */
98 
99  /*
100  * Latest reported end of WAL on the sender
101  */
104 
105  /*
106  * connection string; initially set to connect to the primary, and later
107  * clobbered to hide security-sensitive fields.
108  */
109  char conninfo[MAXCONNINFO];
110 
111  /*
112  * replication slot name; is also used for walreceiver to connect with the
113  * primary
114  */
115  char slotname[NAMEDATALEN];
116 
117  /* set true once conninfo is ready to display (obfuscated pwds etc) */
119 
120  slock_t mutex; /* locks shared variables shown above */
121 
122  /*
123  * force walreceiver reply? This doesn't need to be locked; memory
124  * barriers for ordering are sufficient.
125  */
127 
128  /*
129  * Latch used by startup process to wake up walreceiver after telling it
130  * where to start streaming (after setting receiveStart and
131  * receiveStartTLI), and also to tell it to send apply feedback to the
132  * primary whenever specially marked commit records are applied. This is
133  * normally mapped to procLatch when walreceiver is running.
134  */
136 } WalRcvData;
137 
138 extern WalRcvData *WalRcv;
139 
140 typedef struct
141 {
142  bool logical; /* True if this is logical replication stream,
143  * false if physical stream. */
144  char *slotname; /* Name of the replication slot or NULL. */
145  XLogRecPtr startpoint; /* LSN of starting point. */
146 
147  union
148  {
149  struct
150  {
151  TimeLineID startpointTLI; /* Starting timeline */
152  } physical;
153  struct
154  {
155  uint32 proto_version; /* Logical protocol version */
156  List *publication_names; /* String list of publications */
157  } logical;
158  } proto;
160 
161 struct WalReceiverConn;
163 
164 /*
165  * Status of walreceiver query execution.
166  *
167  * We only define statuses that are currently used.
168  */
169 typedef enum
170 {
171  WALRCV_ERROR, /* There was error when executing the query. */
172  WALRCV_OK_COMMAND, /* Query executed utility or replication
173  * command. */
174  WALRCV_OK_TUPLES, /* Query returned tuples. */
175  WALRCV_OK_COPY_IN, /* Query started COPY FROM. */
176  WALRCV_OK_COPY_OUT, /* Query started COPY TO. */
177  WALRCV_OK_COPY_BOTH /* Query started COPY BOTH replication
178  * protocol. */
180 
181 /*
182  * Return value for walrcv_query, returns the status of the execution and
183  * tuples if any.
184  */
185 typedef struct WalRcvExecResult
186 {
188  char *err;
192 
193 /* libpqwalreceiver hooks */
194 typedef WalReceiverConn *(*walrcv_connect_fn) (const char *conninfo, bool logical,
195  const char *appname,
196  char **err);
197 typedef void (*walrcv_check_conninfo_fn) (const char *conninfo);
198 typedef char *(*walrcv_get_conninfo_fn) (WalReceiverConn *conn);
199 typedef char *(*walrcv_identify_system_fn) (WalReceiverConn *conn,
200  TimeLineID *primary_tli,
201  int *server_version);
203  TimeLineID tli,
204  char **filename,
205  char **content, int *size);
209  TimeLineID *next_tli);
210 typedef int (*walrcv_receive_fn) (WalReceiverConn *conn, char **buffer,
211  pgsocket *wait_fd);
212 typedef void (*walrcv_send_fn) (WalReceiverConn *conn, const char *buffer,
213  int nbytes);
214 typedef char *(*walrcv_create_slot_fn) (WalReceiverConn *conn,
215  const char *slotname, bool temporary,
216  CRSSnapshotAction snapshot_action,
217  XLogRecPtr *lsn);
218 typedef WalRcvExecResult *(*walrcv_exec_fn) (WalReceiverConn *conn,
219  const char *query,
220  const int nRetTypes,
221  const Oid *retTypes);
223 
225 {
239 
241 
242 #define walrcv_connect(conninfo, logical, appname, err) \
243  WalReceiverFunctions->walrcv_connect(conninfo, logical, appname, err)
244 #define walrcv_check_conninfo(conninfo) \
245  WalReceiverFunctions->walrcv_check_conninfo(conninfo)
246 #define walrcv_get_conninfo(conn) \
247  WalReceiverFunctions->walrcv_get_conninfo(conn)
248 #define walrcv_identify_system(conn, primary_tli, server_version) \
249  WalReceiverFunctions->walrcv_identify_system(conn, primary_tli, server_version)
250 #define walrcv_readtimelinehistoryfile(conn, tli, filename, content, size) \
251  WalReceiverFunctions->walrcv_readtimelinehistoryfile(conn, tli, filename, content, size)
252 #define walrcv_startstreaming(conn, options) \
253  WalReceiverFunctions->walrcv_startstreaming(conn, options)
254 #define walrcv_endstreaming(conn, next_tli) \
255  WalReceiverFunctions->walrcv_endstreaming(conn, next_tli)
256 #define walrcv_receive(conn, buffer, wait_fd) \
257  WalReceiverFunctions->walrcv_receive(conn, buffer, wait_fd)
258 #define walrcv_send(conn, buffer, nbytes) \
259  WalReceiverFunctions->walrcv_send(conn, buffer, nbytes)
260 #define walrcv_create_slot(conn, slotname, temporary, snapshot_action, lsn) \
261  WalReceiverFunctions->walrcv_create_slot(conn, slotname, temporary, snapshot_action, lsn)
262 #define walrcv_exec(conn, exec, nRetTypes, retTypes) \
263  WalReceiverFunctions->walrcv_exec(conn, exec, nRetTypes, retTypes)
264 #define walrcv_disconnect(conn) \
265  WalReceiverFunctions->walrcv_disconnect(conn)
266 
267 static inline void
269 {
270  if (!walres)
271  return;
272 
273  if (walres->err)
274  pfree(walres->err);
275 
276  if (walres->tuplestore)
277  tuplestore_end(walres->tuplestore);
278 
279  if (walres->tupledesc)
280  FreeTupleDesc(walres->tupledesc);
281 
282  pfree(walres);
283 }
284 
285 /* prototypes for functions in walreceiver.c */
286 extern void WalReceiverMain(void) pg_attribute_noreturn();
287 
288 /* prototypes for functions in walreceiverfuncs.c */
289 extern Size WalRcvShmemSize(void);
290 extern void WalRcvShmemInit(void);
291 extern void ShutdownWalRcv(void);
292 extern bool WalRcvStreaming(void);
293 extern bool WalRcvRunning(void);
294 extern void RequestXLogStreaming(TimeLineID tli, XLogRecPtr recptr,
295  const char *conninfo, const char *slotname);
297 extern int GetReplicationApplyDelay(void);
298 extern int GetReplicationTransferLatency(void);
299 extern void WalRcvForceReply(void);
300 
301 #endif /* _WALRECEIVER_H */
walrcv_identify_system_fn walrcv_identify_system
Definition: walreceiver.h:229
int slock_t
Definition: s_lock.h:888
WalRcvExecResult *(* walrcv_exec_fn)(WalReceiverConn *conn, const char *query, const int nRetTypes, const Oid *retTypes)
Definition: walreceiver.h:218
XLogRecPtr GetWalRcvWriteRecPtr(XLogRecPtr *latestChunkStart, TimeLineID *receiveTLI)
bool hot_standby_feedback
Definition: walreceiver.c:76
bool WalRcvStreaming(void)
uint32 TimeLineID
Definition: xlogdefs.h:45
int64 pg_time_t
Definition: pgtime.h:23
void ShutdownWalRcv(void)
slock_t mutex
Definition: walreceiver.h:120
walrcv_startstreaming_fn walrcv_startstreaming
Definition: walreceiver.h:231
PGDLLIMPORT WalReceiverFunctionsType * WalReceiverFunctions
Definition: walreceiver.c:80
int64 TimestampTz
Definition: timestamp.h:39
WalRcvState walRcvState
Definition: walreceiver.h:63
WalReceiverConn *(* walrcv_connect_fn)(const char *conninfo, bool logical, const char *appname, char **err)
Definition: walreceiver.h:194
WalRcvExecStatus
Definition: walreceiver.h:169
TimeLineID receivedTLI
Definition: walreceiver.h:83
void(* walrcv_check_conninfo_fn)(const char *conninfo)
Definition: walreceiver.h:197
unsigned int Oid
Definition: postgres_ext.h:31
char *(* walrcv_identify_system_fn)(WalReceiverConn *conn, TimeLineID *primary_tli, int *server_version)
Definition: walreceiver.h:199
TimestampTz lastMsgReceiptTime
Definition: walreceiver.h:97
TimestampTz lastMsgSendTime
Definition: walreceiver.h:96
pg_time_t startTime
Definition: walreceiver.h:64
char *(* walrcv_get_conninfo_fn)(WalReceiverConn *conn)
Definition: walreceiver.h:198
int GetReplicationApplyDelay(void)
#define PGDLLIMPORT
Definition: c.h:1052
char bool
Definition: c.h:202
void WalRcvShmemInit(void)
WalRcvState
Definition: walreceiver.h:43
walrcv_receive_fn walrcv_receive
Definition: walreceiver.h:233
#define NAMEDATALEN
WalRcvData * WalRcv
static void walrcv_clear_result(WalRcvExecResult *walres)
Definition: walreceiver.h:268
void pfree(void *pointer)
Definition: mcxt.c:949
struct WalRcvExecResult WalRcvExecResult
TupleDesc tupledesc
Definition: walreceiver.h:190
void(* walrcv_send_fn)(WalReceiverConn *conn, const char *buffer, int nbytes)
Definition: walreceiver.h:212
void(* walrcv_disconnect_fn)(WalReceiverConn *conn)
Definition: walreceiver.h:222
void WalRcvForceReply(void)
Definition: walreceiver.c:1340
PGconn * conn
Definition: streamutil.c:49
pid_t pid
Definition: walreceiver.h:62
#define MAXCONNINFO
Definition: walreceiver.h:35
XLogRecPtr latestChunkStart
Definition: walreceiver.h:91
int wal_receiver_timeout
Definition: walreceiver.c:75
int GetReplicationTransferLatency(void)
void(* walrcv_endstreaming_fn)(WalReceiverConn *conn, TimeLineID *next_tli)
Definition: walreceiver.h:208
Definition: latch.h:110
walrcv_send_fn walrcv_send
Definition: walreceiver.h:234
void(* walrcv_readtimelinehistoryfile_fn)(WalReceiverConn *conn, TimeLineID tli, char **filename, char **content, int *size)
Definition: walreceiver.h:202
XLogRecPtr startpoint
Definition: walreceiver.h:145
unsigned int uint32
Definition: c.h:258
int pgsocket
Definition: port.h:22
XLogRecPtr receivedUpto
Definition: walreceiver.h:82
TimeLineID receiveStartTLI
Definition: walreceiver.h:73
Latch * latch
Definition: walreceiver.h:135
static char ** options
bool force_reply
Definition: walreceiver.h:126
char *(* walrcv_create_slot_fn)(WalReceiverConn *conn, const char *slotname, bool temporary, CRSSnapshotAction snapshot_action, XLogRecPtr *lsn)
Definition: walreceiver.h:214
static TimeLineID receiveTLI
Definition: xlog.c:203
bool ready_to_display
Definition: walreceiver.h:118
walrcv_get_conninfo_fn walrcv_get_conninfo
Definition: walreceiver.h:228
walrcv_disconnect_fn walrcv_disconnect
Definition: walreceiver.h:237
TimestampTz latestWalEndTime
Definition: walreceiver.h:103
bool(* walrcv_startstreaming_fn)(WalReceiverConn *conn, const WalRcvStreamOptions *options)
Definition: walreceiver.h:206
walrcv_endstreaming_fn walrcv_endstreaming
Definition: walreceiver.h:232
int wal_receiver_status_interval
Definition: walreceiver.c:74
XLogRecPtr latestWalEnd
Definition: walreceiver.h:102
void RequestXLogStreaming(TimeLineID tli, XLogRecPtr recptr, const char *conninfo, const char *slotname)
Tuplestorestate * tuplestore
Definition: walreceiver.h:189
walrcv_readtimelinehistoryfile_fn walrcv_readtimelinehistoryfile
Definition: walreceiver.h:230
uint64 XLogRecPtr
Definition: xlogdefs.h:21
WalRcvExecStatus status
Definition: walreceiver.h:187
void WalReceiverMain(void) pg_attribute_noreturn()
Definition: walreceiver.c:188
WalTimeSample buffer[LAG_TRACKER_BUFFER_SIZE]
Definition: walsender.c:214
static int server_version
Definition: pg_dumpall.c:82
size_t Size
Definition: c.h:350
Size WalRcvShmemSize(void)
void tuplestore_end(Tuplestorestate *state)
Definition: tuplestore.c:453
walrcv_exec_fn walrcv_exec
Definition: walreceiver.h:236
struct WalReceiverFunctionsType WalReceiverFunctionsType
int(* walrcv_receive_fn)(WalReceiverConn *conn, char **buffer, pgsocket *wait_fd)
Definition: walreceiver.h:210
void FreeTupleDesc(TupleDesc tupdesc)
Definition: tupdesc.c:251
#define pg_attribute_noreturn()
Definition: c.h:642
static char * filename
Definition: pg_dumpall.c:90
walrcv_create_slot_fn walrcv_create_slot
Definition: walreceiver.h:235
bool WalRcvRunning(void)
CRSSnapshotAction
Definition: walsender.h:22
TimeLineID startpointTLI
Definition: walreceiver.h:151
walrcv_check_conninfo_fn walrcv_check_conninfo
Definition: walreceiver.h:227
XLogRecPtr receiveStart
Definition: walreceiver.h:72
walrcv_connect_fn walrcv_connect
Definition: walreceiver.h:226
Definition: pg_list.h:45