Branch data Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * walreceiverfuncs.c
4 : : *
5 : : * This file contains functions used by the startup process to communicate
6 : : * with the walreceiver process. Functions implementing walreceiver itself
7 : : * are in walreceiver.c.
8 : : *
9 : : * Portions Copyright (c) 2010-2026, PostgreSQL Global Development Group
10 : : *
11 : : *
12 : : * IDENTIFICATION
13 : : * src/backend/replication/walreceiverfuncs.c
14 : : *
15 : : *-------------------------------------------------------------------------
16 : : */
17 : : #include "postgres.h"
18 : :
19 : : #include <sys/stat.h>
20 : : #include <sys/time.h>
21 : : #include <time.h>
22 : : #include <unistd.h>
23 : : #include <signal.h>
24 : :
25 : : #include "access/xlog_internal.h"
26 : : #include "access/xlogrecovery.h"
27 : : #include "pgstat.h"
28 : : #include "replication/walreceiver.h"
29 : : #include "storage/pmsignal.h"
30 : : #include "storage/proc.h"
31 : : #include "storage/shmem.h"
32 : : #include "utils/timestamp.h"
33 : :
34 : : WalRcvData *WalRcv = NULL;
35 : :
36 : : /*
37 : : * How long to wait for walreceiver to start up after requesting
38 : : * postmaster to launch it. In seconds.
39 : : */
40 : : #define WALRCV_STARTUP_TIMEOUT 10
41 : :
42 : : /* Report shared memory space needed by WalRcvShmemInit */
43 : : Size
44 : 0 : WalRcvShmemSize(void)
45 : : {
46 : 0 : Size size = 0;
47 : :
48 : 0 : size = add_size(size, sizeof(WalRcvData));
49 : :
50 : 0 : return size;
51 : 0 : }
52 : :
53 : : /* Allocate and initialize walreceiver-related shared memory */
54 : : void
55 : 0 : WalRcvShmemInit(void)
56 : : {
57 : 0 : bool found;
58 : :
59 : 0 : WalRcv = (WalRcvData *)
60 : 0 : ShmemInitStruct("Wal Receiver Ctl", WalRcvShmemSize(), &found);
61 : :
62 [ # # ]: 0 : if (!found)
63 : : {
64 : : /* First time through, so initialize */
65 [ # # # # : 0 : MemSet(WalRcv, 0, WalRcvShmemSize());
# # # # #
# ]
66 : 0 : WalRcv->walRcvState = WALRCV_STOPPED;
67 : 0 : ConditionVariableInit(&WalRcv->walRcvStoppedCV);
68 : 0 : SpinLockInit(&WalRcv->mutex);
69 : 0 : pg_atomic_init_u64(&WalRcv->writtenUpto, 0);
70 : 0 : WalRcv->procno = INVALID_PROC_NUMBER;
71 : 0 : }
72 : 0 : }
73 : :
74 : : /* Is walreceiver running (or starting up)? */
75 : : bool
76 : 0 : WalRcvRunning(void)
77 : : {
78 : 0 : WalRcvData *walrcv = WalRcv;
79 : 0 : WalRcvState state;
80 : 0 : pg_time_t startTime;
81 : :
82 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
83 : :
84 : 0 : state = walrcv->walRcvState;
85 : 0 : startTime = walrcv->startTime;
86 : :
87 : 0 : 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 [ # # ]: 0 : if (state == WALRCV_STARTING)
96 : : {
97 : 0 : pg_time_t now = (pg_time_t) time(NULL);
98 : :
99 [ # # ]: 0 : if ((now - startTime) > WALRCV_STARTUP_TIMEOUT)
100 : : {
101 : 0 : bool stopped = false;
102 : :
103 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
104 [ # # ]: 0 : if (walrcv->walRcvState == WALRCV_STARTING)
105 : : {
106 : 0 : state = walrcv->walRcvState = WALRCV_STOPPED;
107 : 0 : stopped = true;
108 : 0 : }
109 : 0 : SpinLockRelease(&walrcv->mutex);
110 : :
111 [ # # ]: 0 : if (stopped)
112 : 0 : ConditionVariableBroadcast(&walrcv->walRcvStoppedCV);
113 : 0 : }
114 : 0 : }
115 : :
116 [ # # ]: 0 : if (state != WALRCV_STOPPED)
117 : 0 : return true;
118 : : else
119 : 0 : return false;
120 : 0 : }
121 : :
122 : : /* Return the state of the walreceiver. */
123 : : WalRcvState
124 : 0 : WalRcvGetState(void)
125 : : {
126 : 0 : WalRcvData *walrcv = WalRcv;
127 : 0 : WalRcvState state;
128 : :
129 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
130 : 0 : state = walrcv->walRcvState;
131 : 0 : SpinLockRelease(&walrcv->mutex);
132 : :
133 : 0 : return state;
134 : 0 : }
135 : :
136 : : /*
137 : : * Is walreceiver running and streaming (or at least attempting to connect,
138 : : * or starting up)?
139 : : */
140 : : bool
141 : 0 : WalRcvStreaming(void)
142 : : {
143 : 0 : WalRcvData *walrcv = WalRcv;
144 : 0 : WalRcvState state;
145 : 0 : pg_time_t startTime;
146 : :
147 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
148 : :
149 : 0 : state = walrcv->walRcvState;
150 : 0 : startTime = walrcv->startTime;
151 : :
152 : 0 : SpinLockRelease(&walrcv->mutex);
153 : :
154 : : /*
155 : : * If it has taken too long for walreceiver to start up, give up. Setting
156 : : * the state to STOPPED ensures that if walreceiver later does start up
157 : : * after all, it will see that it's not supposed to be running and die
158 : : * without doing anything.
159 : : */
160 [ # # ]: 0 : if (state == WALRCV_STARTING)
161 : : {
162 : 0 : pg_time_t now = (pg_time_t) time(NULL);
163 : :
164 [ # # ]: 0 : if ((now - startTime) > WALRCV_STARTUP_TIMEOUT)
165 : : {
166 : 0 : bool stopped = false;
167 : :
168 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
169 [ # # ]: 0 : if (walrcv->walRcvState == WALRCV_STARTING)
170 : : {
171 : 0 : state = walrcv->walRcvState = WALRCV_STOPPED;
172 : 0 : stopped = true;
173 : 0 : }
174 : 0 : SpinLockRelease(&walrcv->mutex);
175 : :
176 [ # # ]: 0 : if (stopped)
177 : 0 : ConditionVariableBroadcast(&walrcv->walRcvStoppedCV);
178 : 0 : }
179 : 0 : }
180 : :
181 [ # # # # ]: 0 : if (state == WALRCV_STREAMING || state == WALRCV_STARTING ||
182 [ # # # # ]: 0 : state == WALRCV_CONNECTING || state == WALRCV_RESTARTING)
183 : 0 : return true;
184 : : else
185 : 0 : return false;
186 : 0 : }
187 : :
188 : : /*
189 : : * Stop walreceiver (if running) and wait for it to die.
190 : : * Executed by the Startup process.
191 : : */
192 : : void
193 : 0 : ShutdownWalRcv(void)
194 : : {
195 : 0 : WalRcvData *walrcv = WalRcv;
196 : 0 : pid_t walrcvpid = 0;
197 : 0 : bool stopped = false;
198 : :
199 : : /*
200 : : * Request walreceiver to stop. Walreceiver will switch to WALRCV_STOPPED
201 : : * mode once it's finished, and will also request postmaster to not
202 : : * restart itself.
203 : : */
204 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
205 [ # # # # ]: 0 : switch (walrcv->walRcvState)
206 : : {
207 : : case WALRCV_STOPPED:
208 : : break;
209 : : case WALRCV_STARTING:
210 : 0 : walrcv->walRcvState = WALRCV_STOPPED;
211 : 0 : stopped = true;
212 : 0 : break;
213 : :
214 : : case WALRCV_CONNECTING:
215 : : case WALRCV_STREAMING:
216 : : case WALRCV_WAITING:
217 : : case WALRCV_RESTARTING:
218 : 0 : walrcv->walRcvState = WALRCV_STOPPING;
219 : : /* fall through */
220 : : case WALRCV_STOPPING:
221 : 0 : walrcvpid = walrcv->pid;
222 : 0 : break;
223 : : }
224 : 0 : SpinLockRelease(&walrcv->mutex);
225 : :
226 : : /* Unnecessary but consistent. */
227 [ # # ]: 0 : if (stopped)
228 : 0 : ConditionVariableBroadcast(&walrcv->walRcvStoppedCV);
229 : :
230 : : /*
231 : : * Signal walreceiver process if it was still running.
232 : : */
233 [ # # ]: 0 : if (walrcvpid != 0)
234 : 0 : kill(walrcvpid, SIGTERM);
235 : :
236 : : /*
237 : : * Wait for walreceiver to acknowledge its death by setting state to
238 : : * WALRCV_STOPPED.
239 : : */
240 : 0 : ConditionVariablePrepareToSleep(&walrcv->walRcvStoppedCV);
241 [ # # ]: 0 : while (WalRcvRunning())
242 : 0 : ConditionVariableSleep(&walrcv->walRcvStoppedCV,
243 : : WAIT_EVENT_WAL_RECEIVER_EXIT);
244 : 0 : ConditionVariableCancelSleep();
245 : 0 : }
246 : :
247 : : /*
248 : : * Request postmaster to start walreceiver.
249 : : *
250 : : * "recptr" indicates the position where streaming should begin. "conninfo"
251 : : * is a libpq connection string to use. "slotname" is, optionally, the name
252 : : * of a replication slot to acquire. "create_temp_slot" indicates to create
253 : : * a temporary slot when no "slotname" is given.
254 : : *
255 : : * WAL receivers do not directly load GUC parameters used for the connection
256 : : * to the primary, and rely on the values passed down by the caller of this
257 : : * routine instead. Hence, the addition of any new parameters should happen
258 : : * through this code path.
259 : : */
260 : : void
261 : 0 : RequestXLogStreaming(TimeLineID tli, XLogRecPtr recptr, const char *conninfo,
262 : : const char *slotname, bool create_temp_slot)
263 : : {
264 : 0 : WalRcvData *walrcv = WalRcv;
265 : 0 : bool launch = false;
266 : 0 : pg_time_t now = (pg_time_t) time(NULL);
267 : 0 : ProcNumber walrcv_proc;
268 : :
269 : : /*
270 : : * We always start at the beginning of the segment. That prevents a broken
271 : : * segment (i.e., with no records in the first half of a segment) from
272 : : * being created by XLOG streaming, which might cause trouble later on if
273 : : * the segment is e.g archived.
274 : : */
275 [ # # ]: 0 : if (XLogSegmentOffset(recptr, wal_segment_size) != 0)
276 : 0 : recptr -= XLogSegmentOffset(recptr, wal_segment_size);
277 : :
278 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
279 : :
280 : : /* It better be stopped if we try to restart it */
281 [ # # # # ]: 0 : Assert(walrcv->walRcvState == WALRCV_STOPPED ||
282 : : walrcv->walRcvState == WALRCV_WAITING);
283 : :
284 [ # # ]: 0 : if (conninfo != NULL)
285 : 0 : strlcpy(walrcv->conninfo, conninfo, MAXCONNINFO);
286 : : else
287 : 0 : walrcv->conninfo[0] = '\0';
288 : :
289 : : /*
290 : : * Use configured replication slot if present, and ignore the value of
291 : : * create_temp_slot as the slot name should be persistent. Otherwise, use
292 : : * create_temp_slot to determine whether this WAL receiver should create a
293 : : * temporary slot by itself and use it, or not.
294 : : */
295 [ # # # # ]: 0 : if (slotname != NULL && slotname[0] != '\0')
296 : : {
297 : 0 : strlcpy(walrcv->slotname, slotname, NAMEDATALEN);
298 : 0 : walrcv->is_temp_slot = false;
299 : 0 : }
300 : : else
301 : : {
302 : 0 : walrcv->slotname[0] = '\0';
303 : 0 : walrcv->is_temp_slot = create_temp_slot;
304 : : }
305 : :
306 [ # # ]: 0 : if (walrcv->walRcvState == WALRCV_STOPPED)
307 : : {
308 : 0 : launch = true;
309 : 0 : walrcv->walRcvState = WALRCV_STARTING;
310 : 0 : }
311 : : else
312 : 0 : walrcv->walRcvState = WALRCV_RESTARTING;
313 : 0 : walrcv->startTime = now;
314 : :
315 : : /*
316 : : * If this is the first startup of walreceiver (on this timeline),
317 : : * initialize flushedUpto and latestChunkStart to the starting point.
318 : : */
319 [ # # # # ]: 0 : if (!XLogRecPtrIsValid(walrcv->receiveStart) || walrcv->receivedTLI != tli)
320 : : {
321 : 0 : walrcv->flushedUpto = recptr;
322 : 0 : walrcv->receivedTLI = tli;
323 : 0 : walrcv->latestChunkStart = recptr;
324 : 0 : }
325 : 0 : walrcv->receiveStart = recptr;
326 : 0 : walrcv->receiveStartTLI = tli;
327 : :
328 : 0 : walrcv_proc = walrcv->procno;
329 : :
330 : 0 : SpinLockRelease(&walrcv->mutex);
331 : :
332 [ # # ]: 0 : if (launch)
333 : 0 : SendPostmasterSignal(PMSIGNAL_START_WALRECEIVER);
334 [ # # ]: 0 : else if (walrcv_proc != INVALID_PROC_NUMBER)
335 : 0 : SetLatch(&GetPGProcByNumber(walrcv_proc)->procLatch);
336 : 0 : }
337 : :
338 : : /*
339 : : * Returns the last+1 byte position that walreceiver has flushed.
340 : : *
341 : : * Optionally, returns the previous chunk start, that is the first byte
342 : : * written in the most recent walreceiver flush cycle. Callers not
343 : : * interested in that value may pass NULL for latestChunkStart. Same for
344 : : * receiveTLI.
345 : : */
346 : : XLogRecPtr
347 : 0 : GetWalRcvFlushRecPtr(XLogRecPtr *latestChunkStart, TimeLineID *receiveTLI)
348 : : {
349 : 0 : WalRcvData *walrcv = WalRcv;
350 : 0 : XLogRecPtr recptr;
351 : :
352 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
353 : 0 : recptr = walrcv->flushedUpto;
354 [ # # ]: 0 : if (latestChunkStart)
355 : 0 : *latestChunkStart = walrcv->latestChunkStart;
356 [ # # ]: 0 : if (receiveTLI)
357 : 0 : *receiveTLI = walrcv->receivedTLI;
358 : 0 : SpinLockRelease(&walrcv->mutex);
359 : :
360 : 0 : return recptr;
361 : 0 : }
362 : :
363 : : /*
364 : : * Returns the last+1 byte position that walreceiver has written.
365 : : * This returns a recently written value without taking a lock.
366 : : */
367 : : XLogRecPtr
368 : 0 : GetWalRcvWriteRecPtr(void)
369 : : {
370 : 0 : WalRcvData *walrcv = WalRcv;
371 : :
372 : 0 : return pg_atomic_read_u64(&walrcv->writtenUpto);
373 : 0 : }
374 : :
375 : : /*
376 : : * Returns the replication apply delay in ms or -1
377 : : * if the apply delay info is not available
378 : : */
379 : : int
380 : 0 : GetReplicationApplyDelay(void)
381 : : {
382 : 0 : WalRcvData *walrcv = WalRcv;
383 : 0 : XLogRecPtr receivePtr;
384 : 0 : XLogRecPtr replayPtr;
385 : 0 : TimestampTz chunkReplayStartTime;
386 : :
387 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
388 : 0 : receivePtr = walrcv->flushedUpto;
389 : 0 : SpinLockRelease(&walrcv->mutex);
390 : :
391 : 0 : replayPtr = GetXLogReplayRecPtr(NULL);
392 : :
393 [ # # ]: 0 : if (receivePtr == replayPtr)
394 : 0 : return 0;
395 : :
396 : 0 : chunkReplayStartTime = GetCurrentChunkReplayStartTime();
397 : :
398 [ # # ]: 0 : if (chunkReplayStartTime == 0)
399 : 0 : return -1;
400 : :
401 : 0 : return TimestampDifferenceMilliseconds(chunkReplayStartTime,
402 : 0 : GetCurrentTimestamp());
403 : 0 : }
404 : :
405 : : /*
406 : : * Returns the network latency in ms, note that this includes any
407 : : * difference in clock settings between the servers, as well as timezone.
408 : : */
409 : : int
410 : 0 : GetReplicationTransferLatency(void)
411 : : {
412 : 0 : WalRcvData *walrcv = WalRcv;
413 : 0 : TimestampTz lastMsgSendTime;
414 : 0 : TimestampTz lastMsgReceiptTime;
415 : :
416 [ # # ]: 0 : SpinLockAcquire(&walrcv->mutex);
417 : 0 : lastMsgSendTime = walrcv->lastMsgSendTime;
418 : 0 : lastMsgReceiptTime = walrcv->lastMsgReceiptTime;
419 : 0 : SpinLockRelease(&walrcv->mutex);
420 : :
421 : 0 : return TimestampDifferenceMilliseconds(lastMsgSendTime,
422 : 0 : lastMsgReceiptTime);
423 : 0 : }
|
