postgresql/src/backend/replication
Alvaro Herrera 07082b08cc
Fix bogus completion tag usage in walsender
Since commit fd5942c18f (2012, 9.3-era), walsender has been sending
completion tags for certain replication commands twice -- and they're
not even consistent.  Apparently neither libpq nor JDBC have a problem
with it, but it's not kosher.  Fix by remove the EndCommand() call in
the common code path for them all, and inserting specific calls to
EndReplicationCommand() specifically in those places where it's needed.

EndReplicationCommand() is a new simple function to send the completion
tag for replication commands.  Do this instead of sending a generic
SELECT completion tag for them all, which was also pretty bogus (if
innocuous).  While at it, change StartReplication() to use
EndReplicationCommand() instead of pg_puttextmessage().

In commit 2f9661311b, I failed to realize that replication commands
are not close-enough kin of regular SQL commands, so the
DROP_REPLICATION_SLOT tag I added is undeserved and a type pun.  Take it
out.

Backpatch to 13, where the latter commit appeared.  The duplicate tag
has been sent since 9.3, but since nothing is broken, it doesn't seem
worth fixing.

Per complaints from Tom Lane.

Discussion: https://postgr.es/m/1347966.1600195735@sss.pgh.pa.us
2020-09-16 21:16:25 -03:00
..
libpqwalreceiver Add support for streaming to built-in logical replication. 2020-09-03 07:54:07 +05:30
logical Don't fetch partition check expression during InitResultRelInfo. 2020-09-16 14:28:18 -04:00
pgoutput Fix initialization of RelationSyncEntry for streaming transactions. 2020-09-16 07:45:44 +05:30
.gitignore Support multiple synchronous standby servers. 2016-04-06 17:18:25 +09:00
backup_manifest.c Minor fixes in docs and error messages. 2020-09-09 11:53:39 -04:00
basebackup.c Message fixes and style improvements 2020-09-14 06:42:30 +02:00
Makefile Move the server's backup manifest code to a separate file. 2020-04-20 14:38:15 -04:00
README code: replace 'master' with 'primary' where appropriate. 2020-07-08 12:57:23 -07:00
repl_gram.y Generate backup manifests for base backups, and validate them. 2020-04-03 15:05:59 -04:00
repl_scanner.l Generate backup manifests for base backups, and validate them. 2020-04-03 15:05:59 -04:00
slot.c snapshot scalability: Move PGXACT->vacuumFlags to ProcGlobal->vacuumFlags. 2020-08-14 15:33:35 -07:00
slotfuncs.c Remove still more useless assignments. 2020-09-04 20:33:36 -04:00
syncrep.c Avoid unnecessary acquisition of SyncRepLock in transaction commit time. 2020-09-02 10:55:55 +09:00
syncrep_gram.y Update copyrights for 2020 2020-01-01 12:21:45 -05:00
syncrep_scanner.l Update copyrights for 2020 2020-01-01 12:21:45 -05:00
walreceiver.c Centralize setup of SIGQUIT handling for postmaster child processes. 2020-09-16 16:04:36 -04:00
walreceiverfuncs.c Initial pgindent and pgperltidy run for v13. 2020-05-14 13:06:50 -04:00
walsender.c Fix bogus completion tag usage in walsender 2020-09-16 21:16:25 -03: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.