postgresql/src/backend/replication
Robert Haas e997a0c642 Remove all use of ThisTimeLineID global variable outside of xlog.c
All such code deals with this global variable in one of three ways.
Sometimes the same functions use it in more than one of these ways
at the same time.

First, sometimes it's an implicit argument to one or more functions
being called in xlog.c or elsewhere, and must be set to the
appropriate value before calling those functions lest they
misbehave. In those cases, it is now passed as an explicit argument
instead.

Second, sometimes it's used to obtain the current timeline after
the end of recovery, i.e. the timeline to which WAL is being
written and flushed. Such code now calls GetWALInsertionTimeLine()
or relies on the new out parameter added to GetFlushRecPtr().

Third, sometimes it's used during recovery to store the current
replay timeline. That can change, so such code must generally
update the value before each use. It can still do that, but must
now use a local variable instead.

The net effect of these changes is to reduce by a fair amount the
amount of code that is directly accessing this global variable.
That's good, because history has shown that we don't always think
clearly about which timeline ID it's supposed to contain at any
given point in time, or indeed, whether it has been or needs to
be initialized at any given point in the code.

Patch by me, reviewed and tested by Michael Paquier, Amul Sul, and
Álvaro Herrera.

Discussion: https://postgr.es/m/CA+TgmobfAAqhfWa1kaFBBFvX+5CjM=7TE=n4r4Q1o2bjbGYBpA@mail.gmail.com
2021-11-05 12:50:01 -04:00
..
libpqwalreceiver Ensure consistent logical replication of datetime and float8 values. 2021-11-02 14:28:50 -04:00
logical Remove all use of ThisTimeLineID global variable outside of xlog.c 2021-11-05 12:50:01 -04:00
pgoutput Allow publishing the tables of schema. 2021-10-27 07:44:52 +05:30
.gitignore
backup_manifest.c Introduce 'bbsink' abstraction to modularize base backup code. 2021-11-05 10:08:30 -04:00
basebackup_copy.c Introduce 'bbsink' abstraction to modularize base backup code. 2021-11-05 10:08:30 -04:00
basebackup_progress.c Introduce 'bbsink' abstraction to modularize base backup code. 2021-11-05 10:08:30 -04:00
basebackup_sink.c Introduce 'bbsink' abstraction to modularize base backup code. 2021-11-05 10:08:30 -04:00
basebackup_throttle.c Introduce 'bbsink' abstraction to modularize base backup code. 2021-11-05 10:08:30 -04:00
basebackup.c Introduce 'bbsink' abstraction to modularize base backup code. 2021-11-05 10:08:30 -04:00
Makefile Introduce 'bbsink' abstraction to modularize base backup code. 2021-11-05 10:08:30 -04:00
README code: replace 'master' with 'primary' where appropriate. 2020-07-08 12:57:23 -07:00
repl_gram.y Add replication command READ_REPLICATION_SLOT 2021-10-25 07:40:42 +09:00
repl_scanner.l Add replication command READ_REPLICATION_SLOT 2021-10-25 07:40:42 +09:00
slot.c Remove code duplication for permission checks with replication slots 2021-09-14 10:15:49 +09:00
slotfuncs.c Remove all use of ThisTimeLineID global variable outside of xlog.c 2021-11-05 12:50:01 -04:00
syncrep_gram.y Update copyright for 2021 2021-01-02 13:06:25 -05:00
syncrep_scanner.l Update copyright for 2021 2021-01-02 13:06:25 -05:00
syncrep.c Initial pgindent and pgperltidy run for v14. 2021-05-12 13:14:10 -04:00
walreceiver.c Remove all use of ThisTimeLineID global variable outside of xlog.c 2021-11-05 12:50:01 -04:00
walreceiverfuncs.c Rename wait event WalrcvExit to WalReceiverExit. 2021-03-24 10:37:54 +09:00
walsender.c Remove all use of ThisTimeLineID global variable outside of xlog.c 2021-11-05 12:50:01 -04:00

src/backend/replication/README

Walreceiver - libpqwalreceiver API
----------------------------------

The transport-specific part of walreceiver, responsible for connecting to
the primary server, receiving WAL files and sending messages, is loaded
dynamically to avoid having to link the main server binary with libpq.
The dynamically loaded module is in libpqwalreceiver subdirectory.

The dynamically loaded module implements a set of functions with details
about each one of them provided in src/include/replication/walreceiver.h.

This API should be considered internal at the moment, but we could open it
up for 3rd party replacements of libpqwalreceiver in the future, allowing
pluggable methods for receiving WAL.

Walreceiver IPC
---------------

When the WAL replay in startup process has reached the end of archived WAL,
restorable using restore_command, it starts up the walreceiver process
to fetch more WAL (if streaming replication is configured).

Walreceiver is a postmaster subprocess, so the startup process can't fork it
directly. Instead, it sends a signal to postmaster, asking postmaster to launch
it. Before that, however, startup process fills in WalRcvData->conninfo
and WalRcvData->slotname, and initializes the starting point in
WalRcvData->receiveStart.

As walreceiver receives WAL from the primary server, and writes and flushes
it to disk (in pg_wal), it updates WalRcvData->flushedUpto and signals
the startup process to know how far WAL replay can advance.

Walreceiver sends information about replication progress to the primary server
whenever it either writes or flushes new WAL, or the specified interval elapses.
This is used for reporting purpose.

Walsender IPC
-------------

At shutdown, postmaster handles walsender processes differently from regular
backends. It waits for regular backends to die before writing the
shutdown checkpoint and terminating pgarch and other auxiliary processes, but
that's not desirable for walsenders, because we want the standby servers to
receive all the WAL, including the shutdown checkpoint, before the primary
is shut down. Therefore postmaster treats walsenders like the pgarch process,
and instructs them to terminate at PM_SHUTDOWN_2 phase, after all regular
backends have died and checkpointer has issued the shutdown checkpoint.

When postmaster accepts a connection, it immediately forks a new process
to handle the handshake and authentication, and the process initializes to
become a backend. Postmaster doesn't know if the process becomes a regular
backend or a walsender process at that time - that's indicated in the
connection handshake - so we need some extra signaling to let postmaster
identify walsender processes.

When walsender process starts up, it marks itself as a walsender process in
the PMSignal array. That way postmaster can tell it apart from regular
backends.

Note that no big harm is done if postmaster thinks that a walsender is a
regular backend; it will just terminate the walsender earlier in the shutdown
phase. A walsender will look like a regular backend until it's done with the
initialization and has marked itself in PMSignal array, and at process
termination, after unmarking the PMSignal slot.

Each walsender allocates an entry from the WalSndCtl array, and tracks
information about replication progress. User can monitor them via
statistics views.


Walsender - walreceiver protocol
--------------------------------

See manual.