]> granicus.if.org Git - postgresql/blob - src/backend/replication/walsender.c
Fix missing static declaration for XLogRead().
[postgresql] / src / backend / replication / walsender.c
1 /*-------------------------------------------------------------------------
2  *
3  * walsender.c
4  *
5  * The WAL sender process (walsender) is new as of Postgres 9.0. It takes
6  * charge of XLOG streaming sender in the primary server. At first, it is
7  * started by the postmaster when the walreceiver in the standby server
8  * connects to the primary server and requests XLOG streaming replication,
9  * i.e., unlike any auxiliary process, it is not an always-running process.
10  * It attempts to keep reading XLOG records from the disk and sending them
11  * to the standby server, as long as the connection is alive (i.e., like
12  * any backend, there is an one to one relationship between a connection
13  * and a walsender process).
14  *
15  * Normal termination is by SIGTERM, which instructs the walsender to
16  * close the connection and exit(0) at next convenient moment. Emergency
17  * termination is by SIGQUIT; like any backend, the walsender will simply
18  * abort and exit on SIGQUIT. A close of the connection and a FATAL error
19  * are treated as not a crash but approximately normal termination;
20  * the walsender will exit quickly without sending any more XLOG records.
21  *
22  * If the server is shut down, postmaster sends us SIGUSR2 after all
23  * regular backends have exited and the shutdown checkpoint has been written.
24  * This instruct walsender to send any outstanding WAL, including the
25  * shutdown checkpoint record, and then exit.
26  *
27  * Note that there can be more than one walsender process concurrently.
28  *
29  * Portions Copyright (c) 2010-2010, PostgreSQL Global Development Group
30  *
31  *
32  * IDENTIFICATION
33  *        $PostgreSQL: pgsql/src/backend/replication/walsender.c,v 1.20 2010/05/09 18:11:55 tgl Exp $
34  *
35  *-------------------------------------------------------------------------
36  */
37 #include "postgres.h"
38
39 #include <unistd.h>
40
41 #include "access/xlog_internal.h"
42 #include "catalog/pg_type.h"
43 #include "libpq/libpq.h"
44 #include "libpq/pqformat.h"
45 #include "libpq/pqsignal.h"
46 #include "miscadmin.h"
47 #include "replication/walsender.h"
48 #include "storage/fd.h"
49 #include "storage/ipc.h"
50 #include "storage/pmsignal.h"
51 #include "tcop/tcopprot.h"
52 #include "utils/guc.h"
53 #include "utils/memutils.h"
54 #include "utils/ps_status.h"
55
56
57 /* Array of WalSnds in shared memory */
58 WalSndCtlData *WalSndCtl = NULL;
59
60 /* My slot in the shared memory array */
61 static WalSnd *MyWalSnd = NULL;
62
63 /* Global state */
64 bool            am_walsender = false;           /* Am I a walsender process ? */
65
66 /* User-settable parameters for walsender */
67 int                     max_wal_senders = 0;    /* the maximum number of concurrent walsenders */
68 int                     WalSndDelay = 200;      /* max sleep time between some actions */
69
70 #define NAPTIME_PER_CYCLE 100000L       /* max sleep time between cycles (100ms) */
71
72 /*
73  * These variables are used similarly to openLogFile/Id/Seg/Off,
74  * but for walsender to read the XLOG.
75  */
76 static int      sendFile = -1;
77 static uint32 sendId = 0;
78 static uint32 sendSeg = 0;
79 static uint32 sendOff = 0;
80
81 /*
82  * How far have we sent WAL already? This is also advertised in
83  * MyWalSnd->sentPtr.
84  */
85 static XLogRecPtr sentPtr = {0, 0};
86
87 /* Flags set by signal handlers for later service in main loop */
88 static volatile sig_atomic_t got_SIGHUP = false;
89 static volatile sig_atomic_t shutdown_requested = false;
90 static volatile sig_atomic_t ready_to_stop = false;
91
92 /* Signal handlers */
93 static void WalSndSigHupHandler(SIGNAL_ARGS);
94 static void WalSndShutdownHandler(SIGNAL_ARGS);
95 static void WalSndQuickDieHandler(SIGNAL_ARGS);
96
97 /* Prototypes for private functions */
98 static int      WalSndLoop(void);
99 static void InitWalSnd(void);
100 static void WalSndHandshake(void);
101 static void WalSndKill(int code, Datum arg);
102 static void XLogRead(char *buf, XLogRecPtr recptr, Size nbytes);
103 static bool XLogSend(StringInfo outMsg);
104 static void CheckClosedConnection(void);
105
106 /*
107  * How much WAL to send in one message? Must be >= XLOG_BLCKSZ.
108  */
109 #define MAX_SEND_SIZE (XLOG_SEG_SIZE / 2)
110
111 /* Main entry point for walsender process */
112 int
113 WalSenderMain(void)
114 {
115         MemoryContext walsnd_context;
116
117         if (RecoveryInProgress())
118                 ereport(FATAL,
119                                 (errcode(ERRCODE_CANNOT_CONNECT_NOW),
120                                  errmsg("recovery is still in progress, can't accept WAL streaming connections")));
121
122         /* Create a per-walsender data structure in shared memory */
123         InitWalSnd();
124
125         /*
126          * Create a memory context that we will do all our work in.  We do this so
127          * that we can reset the context during error recovery and thereby avoid
128          * possible memory leaks.  Formerly this code just ran in
129          * TopMemoryContext, but resetting that would be a really bad idea.
130          *
131          * XXX: we don't actually attempt error recovery in walsender, we just
132          * close the connection and exit.
133          */
134         walsnd_context = AllocSetContextCreate(TopMemoryContext,
135                                                                                    "Wal Sender",
136                                                                                    ALLOCSET_DEFAULT_MINSIZE,
137                                                                                    ALLOCSET_DEFAULT_INITSIZE,
138                                                                                    ALLOCSET_DEFAULT_MAXSIZE);
139         MemoryContextSwitchTo(walsnd_context);
140
141         /* Unblock signals (they were blocked when the postmaster forked us) */
142         PG_SETMASK(&UnBlockSig);
143
144         /* Tell the standby that walsender is ready for receiving commands */
145         ReadyForQuery(DestRemote);
146
147         /* Handle handshake messages before streaming */
148         WalSndHandshake();
149
150         /* Main loop of walsender */
151         return WalSndLoop();
152 }
153
154 static void
155 WalSndHandshake(void)
156 {
157         StringInfoData input_message;
158         bool            replication_started = false;
159
160         initStringInfo(&input_message);
161
162         while (!replication_started)
163         {
164                 int                     firstchar;
165
166                 /* Wait for a command to arrive */
167                 firstchar = pq_getbyte();
168
169                 /*
170                  * Check for any other interesting events that happened while we
171                  * slept.
172                  */
173                 if (got_SIGHUP)
174                 {
175                         got_SIGHUP = false;
176                         ProcessConfigFile(PGC_SIGHUP);
177                 }
178
179                 if (firstchar != EOF)
180                 {
181                         /*
182                          * Read the message contents. This is expected to be done without
183                          * blocking because we've been able to get message type code.
184                          */
185                         if (pq_getmessage(&input_message, 0))
186                                 firstchar = EOF;        /* suitable message already logged */
187                 }
188
189                 /* Handle the very limited subset of commands expected in this phase */
190                 switch (firstchar)
191                 {
192                         case 'Q':                       /* Query message */
193                                 {
194                                         const char *query_string;
195                                         XLogRecPtr      recptr;
196
197                                         query_string = pq_getmsgstring(&input_message);
198                                         pq_getmsgend(&input_message);
199
200                                         if (strcmp(query_string, "IDENTIFY_SYSTEM") == 0)
201                                         {
202                                                 StringInfoData buf;
203                                                 char            sysid[32];
204                                                 char            tli[11];
205
206                                                 /*
207                                                  * Reply with a result set with one row, two columns.
208                                                  * First col is system ID, and second if timeline ID
209                                                  */
210
211                                                 snprintf(sysid, sizeof(sysid), UINT64_FORMAT,
212                                                                  GetSystemIdentifier());
213                                                 snprintf(tli, sizeof(tli), "%u", ThisTimeLineID);
214
215                                                 /* Send a RowDescription message */
216                                                 pq_beginmessage(&buf, 'T');
217                                                 pq_sendint(&buf, 2, 2); /* 2 fields */
218
219                                                 /* first field */
220                                                 pq_sendstring(&buf, "systemid");                /* col name */
221                                                 pq_sendint(&buf, 0, 4); /* table oid */
222                                                 pq_sendint(&buf, 0, 2); /* attnum */
223                                                 pq_sendint(&buf, TEXTOID, 4);   /* type oid */
224                                                 pq_sendint(&buf, -1, 2);                /* typlen */
225                                                 pq_sendint(&buf, 0, 4); /* typmod */
226                                                 pq_sendint(&buf, 0, 2); /* format code */
227
228                                                 /* second field */
229                                                 pq_sendstring(&buf, "timeline");                /* col name */
230                                                 pq_sendint(&buf, 0, 4); /* table oid */
231                                                 pq_sendint(&buf, 0, 2); /* attnum */
232                                                 pq_sendint(&buf, INT4OID, 4);   /* type oid */
233                                                 pq_sendint(&buf, 4, 2); /* typlen */
234                                                 pq_sendint(&buf, 0, 4); /* typmod */
235                                                 pq_sendint(&buf, 0, 2); /* format code */
236                                                 pq_endmessage(&buf);
237
238                                                 /* Send a DataRow message */
239                                                 pq_beginmessage(&buf, 'D');
240                                                 pq_sendint(&buf, 2, 2); /* # of columns */
241                                                 pq_sendint(&buf, strlen(sysid), 4);             /* col1 len */
242                                                 pq_sendbytes(&buf, (char *) &sysid, strlen(sysid));
243                                                 pq_sendint(&buf, strlen(tli), 4);               /* col2 len */
244                                                 pq_sendbytes(&buf, (char *) tli, strlen(tli));
245                                                 pq_endmessage(&buf);
246
247                                                 /* Send CommandComplete and ReadyForQuery messages */
248                                                 EndCommand("SELECT", DestRemote);
249                                                 ReadyForQuery(DestRemote);
250                                         }
251                                         else if (sscanf(query_string, "START_REPLICATION %X/%X",
252                                                                         &recptr.xlogid, &recptr.xrecoff) == 2)
253                                         {
254                                                 StringInfoData buf;
255
256                                                 /*
257                                                  * Check that we're logging enough information in the
258                                                  * WAL for log-shipping.
259                                                  *
260                                                  * NOTE: This only checks the current value of
261                                                  * wal_level. Even if the current setting is not
262                                                  * 'minimal', there can be old WAL in the pg_xlog
263                                                  * directory that was created with 'minimal'.
264                                                  * So this is not bulletproof, the purpose is
265                                                  * just to give a user-friendly error message that
266                                                  * hints how to configure the system correctly.
267                                                  */
268                                                 if (wal_level == WAL_LEVEL_MINIMAL)
269                                                         ereport(FATAL,
270                                                                         (errcode(ERRCODE_CANNOT_CONNECT_NOW),
271                                                                          errmsg("standby connections not allowed because wal_level=\"minimal\"")));
272
273                                                 /* Send a CopyOutResponse message, and start streaming */
274                                                 pq_beginmessage(&buf, 'H');
275                                                 pq_sendbyte(&buf, 0);
276                                                 pq_sendint(&buf, 0, 2);
277                                                 pq_endmessage(&buf);
278                                                 pq_flush();
279
280                                                 /*
281                                                  * Initialize position to the received one, then the
282                                                  * xlog records begin to be shipped from that position
283                                                  */
284                                                 sentPtr = recptr;
285
286                                                 /* break out of the loop */
287                                                 replication_started = true;
288                                         }
289                                         else
290                                         {
291                                                 ereport(FATAL,
292                                                                 (errcode(ERRCODE_PROTOCOL_VIOLATION),
293                                                                  errmsg("invalid standby query string: %s", query_string)));
294                                         }
295                                         break;
296                                 }
297
298                         case 'X':
299                                 /* standby is closing the connection */
300                                 proc_exit(0);
301
302                         case EOF:
303                                 /* standby disconnected unexpectedly */
304                                 ereport(COMMERROR,
305                                                 (errcode(ERRCODE_PROTOCOL_VIOLATION),
306                                                  errmsg("unexpected EOF on standby connection")));
307                                 proc_exit(0);
308
309                         default:
310                                 ereport(FATAL,
311                                                 (errcode(ERRCODE_PROTOCOL_VIOLATION),
312                                                  errmsg("invalid standby handshake message type %d", firstchar)));
313                 }
314         }
315 }
316
317 /*
318  * Check if the remote end has closed the connection.
319  */
320 static void
321 CheckClosedConnection(void)
322 {
323         unsigned char firstchar;
324         int                     r;
325
326         r = pq_getbyte_if_available(&firstchar);
327         if (r < 0)
328         {
329                 /* unexpected error or EOF */
330                 ereport(COMMERROR,
331                                 (errcode(ERRCODE_PROTOCOL_VIOLATION),
332                                  errmsg("unexpected EOF on standby connection")));
333                 proc_exit(0);
334         }
335         if (r == 0)
336         {
337                 /* no data available without blocking */
338                 return;
339         }
340
341         /* Handle the very limited subset of commands expected in this phase */
342         switch (firstchar)
343         {
344                         /*
345                          * 'X' means that the standby is closing down the socket.
346                          */
347                 case 'X':
348                         proc_exit(0);
349
350                 default:
351                         ereport(FATAL,
352                                         (errcode(ERRCODE_PROTOCOL_VIOLATION),
353                                          errmsg("invalid standby closing message type %d",
354                                                         firstchar)));
355         }
356 }
357
358 /* Main loop of walsender process */
359 static int
360 WalSndLoop(void)
361 {
362         StringInfoData output_message;
363
364         initStringInfo(&output_message);
365
366         /* Loop forever */
367         for (;;)
368         {
369                 long    remain;         /* remaining time (us) */
370
371                 /*
372                  * Emergency bailout if postmaster has died.  This is to avoid the
373                  * necessity for manual cleanup of all postmaster children.
374                  */
375                 if (!PostmasterIsAlive(true))
376                         exit(1);
377                 /* Process any requests or signals received recently */
378                 if (got_SIGHUP)
379                 {
380                         got_SIGHUP = false;
381                         ProcessConfigFile(PGC_SIGHUP);
382                 }
383
384                 /*
385                  * When SIGUSR2 arrives, we send all outstanding logs up to the
386                  * shutdown checkpoint record (i.e., the latest record) and exit.
387                  */
388                 if (ready_to_stop)
389                 {
390                         XLogSend(&output_message);
391                         shutdown_requested = true;
392                 }
393
394                 /* Normal exit from the walsender is here */
395                 if (shutdown_requested)
396                 {
397                         /* Inform the standby that XLOG streaming was done */
398                         pq_puttextmessage('C', "COPY 0");
399                         pq_flush();
400
401                         proc_exit(0);
402                 }
403
404                 /*
405                  * Nap for the configured time or until a message arrives.
406                  *
407                  * On some platforms, signals won't interrupt the sleep.  To ensure we
408                  * respond reasonably promptly when someone signals us, break down the
409                  * sleep into NAPTIME_PER_CYCLE increments, and check for
410                  * interrupts after each nap.
411                  */
412                 remain = WalSndDelay * 1000L;
413                 while (remain > 0)
414                 {
415                         if (got_SIGHUP || shutdown_requested || ready_to_stop)
416                                 break;
417
418                         /*
419                          * Check to see whether a message from the standby or an interrupt
420                          * from other processes has arrived.
421                          */
422                         pg_usleep(remain > NAPTIME_PER_CYCLE ? NAPTIME_PER_CYCLE : remain);
423                         CheckClosedConnection();
424
425                         remain -= NAPTIME_PER_CYCLE;
426                 }
427
428                 /* Attempt to send the log once every loop */
429                 if (!XLogSend(&output_message))
430                         goto eof;
431         }
432
433         /* can't get here because the above loop never exits */
434         return 1;
435
436 eof:
437
438         /*
439          * Reset whereToSendOutput to prevent ereport from attempting to send any
440          * more messages to the standby.
441          */
442         if (whereToSendOutput == DestRemote)
443                 whereToSendOutput = DestNone;
444
445         proc_exit(0);
446         return 1;                                       /* keep the compiler quiet */
447 }
448
449 /* Initialize a per-walsender data structure for this walsender process */
450 static void
451 InitWalSnd(void)
452 {
453         /* use volatile pointer to prevent code rearrangement */
454         int                     i;
455
456         /*
457          * WalSndCtl should be set up already (we inherit this by fork() or
458          * EXEC_BACKEND mechanism from the postmaster).
459          */
460         Assert(WalSndCtl != NULL);
461         Assert(MyWalSnd == NULL);
462
463         /*
464          * Find a free walsender slot and reserve it. If this fails, we must be
465          * out of WalSnd structures.
466          */
467         for (i = 0; i < max_wal_senders; i++)
468         {
469                 volatile WalSnd *walsnd = &WalSndCtl->walsnds[i];
470
471                 SpinLockAcquire(&walsnd->mutex);
472
473                 if (walsnd->pid != 0)
474                 {
475                         SpinLockRelease(&walsnd->mutex);
476                         continue;
477                 }
478                 else
479                 {
480                         /* found */
481                         MyWalSnd = (WalSnd *) walsnd;
482                         walsnd->pid = MyProcPid;
483                         MemSet(&MyWalSnd->sentPtr, 0, sizeof(XLogRecPtr));
484                         SpinLockRelease(&walsnd->mutex);
485                         break;
486                 }
487         }
488         if (MyWalSnd == NULL)
489                 ereport(FATAL,
490                                 (errcode(ERRCODE_TOO_MANY_CONNECTIONS),
491                                  errmsg("number of requested standby connections "
492                                         "exceeds max_wal_senders (currently %d)",
493                                         max_wal_senders)));
494
495         /* Arrange to clean up at walsender exit */
496         on_shmem_exit(WalSndKill, 0);
497 }
498
499 /* Destroy the per-walsender data structure for this walsender process */
500 static void
501 WalSndKill(int code, Datum arg)
502 {
503         Assert(MyWalSnd != NULL);
504
505         /*
506          * Mark WalSnd struct no longer in use. Assume that no lock is required
507          * for this.
508          */
509         MyWalSnd->pid = 0;
510
511         /* WalSnd struct isn't mine anymore */
512         MyWalSnd = NULL;
513 }
514
515 /*
516  * Read 'nbytes' bytes from WAL into 'buf', starting at location 'recptr'
517  */
518 static void
519 XLogRead(char *buf, XLogRecPtr recptr, Size nbytes)
520 {
521         XLogRecPtr      startRecPtr = recptr;
522         char            path[MAXPGPATH];
523         uint32          lastRemovedLog;
524         uint32          lastRemovedSeg;
525         uint32          log;
526         uint32          seg;
527
528         while (nbytes > 0)
529         {
530                 uint32          startoff;
531                 int                     segbytes;
532                 int                     readbytes;
533
534                 startoff = recptr.xrecoff % XLogSegSize;
535
536                 if (sendFile < 0 || !XLByteInSeg(recptr, sendId, sendSeg))
537                 {
538                         /* Switch to another logfile segment */
539                         if (sendFile >= 0)
540                                 close(sendFile);
541
542                         XLByteToSeg(recptr, sendId, sendSeg);
543                         XLogFilePath(path, ThisTimeLineID, sendId, sendSeg);
544
545                         sendFile = BasicOpenFile(path, O_RDONLY | PG_BINARY, 0);
546                         if (sendFile < 0)
547                         {
548                                 /*
549                                  * If the file is not found, assume it's because the
550                                  * standby asked for a too old WAL segment that has already
551                                  * been removed or recycled.
552                                  */
553                                 if (errno == ENOENT)
554                                 {
555                                         char filename[MAXFNAMELEN];
556                                         XLogFileName(filename, ThisTimeLineID, sendId, sendSeg);
557                                         ereport(ERROR,
558                                                         (errcode_for_file_access(),
559                                                          errmsg("requested WAL segment %s has already been removed",
560                                                                         filename)));
561                                 }
562                                 else
563                                         ereport(ERROR,
564                                                         (errcode_for_file_access(),
565                                                          errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
566                                                                         path, sendId, sendSeg)));
567                         }
568                         sendOff = 0;
569                 }
570
571                 /* Need to seek in the file? */
572                 if (sendOff != startoff)
573                 {
574                         if (lseek(sendFile, (off_t) startoff, SEEK_SET) < 0)
575                                 ereport(ERROR,
576                                                 (errcode_for_file_access(),
577                                                  errmsg("could not seek in log file %u, segment %u to offset %u: %m",
578                                                                 sendId, sendSeg, startoff)));
579                         sendOff = startoff;
580                 }
581
582                 /* How many bytes are within this segment? */
583                 if (nbytes > (XLogSegSize - startoff))
584                         segbytes = XLogSegSize - startoff;
585                 else
586                         segbytes = nbytes;
587
588                 readbytes = read(sendFile, buf, segbytes);
589                 if (readbytes <= 0)
590                         ereport(ERROR,
591                                         (errcode_for_file_access(),
592                         errmsg("could not read from log file %u, segment %u, offset %u, "
593                                    "length %lu: %m",
594                                    sendId, sendSeg, sendOff, (unsigned long) segbytes)));
595
596                 /* Update state for read */
597                 XLByteAdvance(recptr, readbytes);
598
599                 sendOff += readbytes;
600                 nbytes -= readbytes;
601                 buf += readbytes;
602         }
603
604         /*
605          * After reading into the buffer, check that what we read was valid.
606          * We do this after reading, because even though the segment was present
607          * when we opened it, it might get recycled or removed while we read it.
608          * The read() succeeds in that case, but the data we tried to read might
609          * already have been overwritten with new WAL records.
610          */
611         XLogGetLastRemoved(&lastRemovedLog, &lastRemovedSeg);
612         XLByteToSeg(startRecPtr, log, seg);
613         if (log < lastRemovedLog ||
614                 (log == lastRemovedLog && seg <= lastRemovedSeg))
615         {
616                 char filename[MAXFNAMELEN];
617                 XLogFileName(filename, ThisTimeLineID, log, seg);
618                 ereport(ERROR,
619                                 (errcode_for_file_access(),
620                                  errmsg("requested WAL segment %s has already been removed",
621                                                 filename)));
622         }
623 }
624
625 /*
626  * Read all WAL that's been written (and flushed) since last cycle, and send
627  * it to client.
628  *
629  * Returns true if OK, false if trouble.
630  */
631 static bool
632 XLogSend(StringInfo outMsg)
633 {
634         XLogRecPtr      SendRqstPtr;
635         char            activitymsg[50];
636
637         /* use volatile pointer to prevent code rearrangement */
638         volatile WalSnd *walsnd = MyWalSnd;
639
640         /* Attempt to send all records flushed to the disk already */
641         SendRqstPtr = GetWriteRecPtr();
642
643         /* Quick exit if nothing to do */
644         if (!XLByteLT(sentPtr, SendRqstPtr))
645                 return true;
646
647         /*
648          * We gather multiple records together by issuing just one XLogRead() of a
649          * suitable size, and send them as one CopyData message. Repeat until
650          * we've sent everything we can.
651          */
652         while (XLByteLT(sentPtr, SendRqstPtr))
653         {
654                 XLogRecPtr      startptr;
655                 XLogRecPtr      endptr;
656                 Size            nbytes;
657
658                 /*
659                  * Figure out how much to send in one message. If there's less than
660                  * MAX_SEND_SIZE bytes to send, send everything. Otherwise send
661                  * MAX_SEND_SIZE bytes, but round to page boundary.
662                  *
663                  * The rounding is not only for performance reasons. Walreceiver
664                  * relies on the fact that we never split a WAL record across two
665                  * messages. Since a long WAL record is split at page boundary into
666                  * continuation records, page boundary is always a safe cut-off point.
667                  * We also assume that SendRqstPtr never points in the middle of a WAL
668                  * record.
669                  */
670                 startptr = sentPtr;
671                 if (startptr.xrecoff >= XLogFileSize)
672                 {
673                         /*
674                          * crossing a logid boundary, skip the non-existent last log
675                          * segment in previous logical log file.
676                          */
677                         startptr.xlogid += 1;
678                         startptr.xrecoff = 0;
679                 }
680
681                 endptr = startptr;
682                 XLByteAdvance(endptr, MAX_SEND_SIZE);
683                 /* round down to page boundary. */
684                 endptr.xrecoff -= (endptr.xrecoff % XLOG_BLCKSZ);
685                 /* if we went beyond SendRqstPtr, back off */
686                 if (XLByteLT(SendRqstPtr, endptr))
687                         endptr = SendRqstPtr;
688
689                 /*
690                  * OK to read and send the slice.
691                  *
692                  * We don't need to convert the xlogid/xrecoff from host byte order to
693                  * network byte order because the both server can be expected to have
694                  * the same byte order. If they have different byte order, we don't
695                  * reach here.
696                  */
697                 pq_sendbyte(outMsg, 'w');
698                 pq_sendbytes(outMsg, (char *) &startptr, sizeof(startptr));
699
700                 if (endptr.xlogid != startptr.xlogid)
701                 {
702                         Assert(endptr.xlogid == startptr.xlogid + 1);
703                         nbytes = endptr.xrecoff + XLogFileSize - startptr.xrecoff;
704                 }
705                 else
706                         nbytes = endptr.xrecoff - startptr.xrecoff;
707
708                 sentPtr = endptr;
709
710                 /*
711                  * Read the log directly into the output buffer to prevent extra
712                  * memcpy calls.
713                  */
714                 enlargeStringInfo(outMsg, nbytes);
715
716                 XLogRead(&outMsg->data[outMsg->len], startptr, nbytes);
717                 outMsg->len += nbytes;
718                 outMsg->data[outMsg->len] = '\0';
719
720                 pq_putmessage('d', outMsg->data, outMsg->len);
721                 resetStringInfo(outMsg);
722         }
723
724         /* Update shared memory status */
725         SpinLockAcquire(&walsnd->mutex);
726         walsnd->sentPtr = sentPtr;
727         SpinLockRelease(&walsnd->mutex);
728
729         /* Flush pending output */
730         if (pq_flush())
731                 return false;
732
733         /* Report progress of XLOG streaming in PS display */
734         snprintf(activitymsg, sizeof(activitymsg), "streaming %X/%X",
735                          sentPtr.xlogid, sentPtr.xrecoff);
736         set_ps_display(activitymsg, false);
737
738         return true;
739 }
740
741 /* SIGHUP: set flag to re-read config file at next convenient time */
742 static void
743 WalSndSigHupHandler(SIGNAL_ARGS)
744 {
745         got_SIGHUP = true;
746 }
747
748 /* SIGTERM: set flag to shut down */
749 static void
750 WalSndShutdownHandler(SIGNAL_ARGS)
751 {
752         shutdown_requested = true;
753 }
754
755 /*
756  * WalSndQuickDieHandler() occurs when signalled SIGQUIT by the postmaster.
757  *
758  * Some backend has bought the farm,
759  * so we need to stop what we're doing and exit.
760  */
761 static void
762 WalSndQuickDieHandler(SIGNAL_ARGS)
763 {
764         PG_SETMASK(&BlockSig);
765
766         /*
767          * We DO NOT want to run proc_exit() callbacks -- we're here because
768          * shared memory may be corrupted, so we don't want to try to clean up our
769          * transaction.  Just nail the windows shut and get out of town.  Now that
770          * there's an atexit callback to prevent third-party code from breaking
771          * things by calling exit() directly, we have to reset the callbacks
772          * explicitly to make this work as intended.
773          */
774         on_exit_reset();
775
776         /*
777          * Note we do exit(2) not exit(0).      This is to force the postmaster into a
778          * system reset cycle if some idiot DBA sends a manual SIGQUIT to a random
779          * backend.  This is necessary precisely because we don't clean up our
780          * shared memory state.  (The "dead man switch" mechanism in pmsignal.c
781          * should ensure the postmaster sees this as a crash, too, but no harm in
782          * being doubly sure.)
783          */
784         exit(2);
785 }
786
787 /* SIGUSR2: set flag to do a last cycle and shut down afterwards */
788 static void
789 WalSndLastCycleHandler(SIGNAL_ARGS)
790 {
791         ready_to_stop = true;
792 }
793
794 /* Set up signal handlers */
795 void
796 WalSndSignals(void)
797 {
798         /* Set up signal handlers */
799         pqsignal(SIGHUP, WalSndSigHupHandler);          /* set flag to read config
800                                                                                                  * file */
801         pqsignal(SIGINT, SIG_IGN);      /* not used */
802         pqsignal(SIGTERM, WalSndShutdownHandler);       /* request shutdown */
803         pqsignal(SIGQUIT, WalSndQuickDieHandler);       /* hard crash time */
804         pqsignal(SIGALRM, SIG_IGN);
805         pqsignal(SIGPIPE, SIG_IGN);
806         pqsignal(SIGUSR1, SIG_IGN); /* not used */
807         pqsignal(SIGUSR2, WalSndLastCycleHandler);      /* request a last cycle and
808                                                                                                  * shutdown */
809
810         /* Reset some signals that are accepted by postmaster but not here */
811         pqsignal(SIGCHLD, SIG_DFL);
812         pqsignal(SIGTTIN, SIG_DFL);
813         pqsignal(SIGTTOU, SIG_DFL);
814         pqsignal(SIGCONT, SIG_DFL);
815         pqsignal(SIGWINCH, SIG_DFL);
816 }
817
818 /* Report shared-memory space needed by WalSndShmemInit */
819 Size
820 WalSndShmemSize(void)
821 {
822         Size            size = 0;
823
824         size = offsetof(WalSndCtlData, walsnds);
825         size = add_size(size, mul_size(max_wal_senders, sizeof(WalSnd)));
826
827         return size;
828 }
829
830 /* Allocate and initialize walsender-related shared memory */
831 void
832 WalSndShmemInit(void)
833 {
834         bool            found;
835         int                     i;
836
837         WalSndCtl = (WalSndCtlData *)
838                 ShmemInitStruct("Wal Sender Ctl", WalSndShmemSize(), &found);
839
840         if (!found)
841         {
842                 /* First time through, so initialize */
843                 MemSet(WalSndCtl, 0, WalSndShmemSize());
844
845                 for (i = 0; i < max_wal_senders; i++)
846                 {
847                         WalSnd     *walsnd = &WalSndCtl->walsnds[i];
848
849                         SpinLockInit(&walsnd->mutex);
850                 }
851         }
852 }
853
854 /*
855  * This isn't currently used for anything. Monitoring tools might be
856  * interested in the future, and we'll need something like this in the
857  * future for synchronous replication.
858  */
859 #ifdef NOT_USED
860 /*
861  * Returns the oldest Send position among walsenders. Or InvalidXLogRecPtr
862  * if none.
863  */
864 XLogRecPtr
865 GetOldestWALSendPointer(void)
866 {
867         XLogRecPtr      oldest = {0, 0};
868         int                     i;
869         bool            found = false;
870
871         for (i = 0; i < max_wal_senders; i++)
872         {
873                 /* use volatile pointer to prevent code rearrangement */
874                 volatile WalSnd *walsnd = &WalSndCtl->walsnds[i];
875                 XLogRecPtr      recptr;
876
877                 if (walsnd->pid == 0)
878                         continue;
879
880                 SpinLockAcquire(&walsnd->mutex);
881                 recptr = walsnd->sentPtr;
882                 SpinLockRelease(&walsnd->mutex);
883
884                 if (recptr.xlogid == 0 && recptr.xrecoff == 0)
885                         continue;
886
887                 if (!found || XLByteLT(recptr, oldest))
888                         oldest = recptr;
889                 found = true;
890         }
891         return oldest;
892 }
893 #endif