postgresql/src/backend/replication
Andres Freund 37c87e63f9 Change relpath() et al to return path by value
For AIO, and also some other recent patches, we need the ability to call
relpath() in a critical section. Until now that was not feasible, as it
allocated memory.

The fact that relpath() allocated memory also made it awkward to use in log
messages because we had to take care to free the memory afterwards. Which we
e.g. didn't do for when zeroing out an invalid buffer.

We discussed other solutions, e.g. filling a pre-allocated buffer that's
passed to relpath(), but they all came with plenty downsides or were larger
projects. The easiest fix seems to be to make relpath() return the path by
value.

To be able to return the path by value we need to determine the maximum length
of a relation path. This patch adds a long #define that computes the exact
maximum, which is verified to be correct in a regression test.

As this change the signature of relpath(), extensions using it will need to
adapt their code. We discussed leaving a backward-compat shim in place, but
decided it's not worth it given the use of relpath() doesn't seem widespread.

Discussion: https://postgr.es/m/xeri5mla4b5syjd5a25nok5iez2kr3bm26j2qn4u7okzof2bmf@kwdh2vf7npra
2025-02-25 09:02:07 -05:00
..
libpqwalreceiver Update copyright for 2025 2025-01-01 11:21:55 -05:00
logical Change relpath() et al to return path by value 2025-02-25 09:02:07 -05:00
pgoutput Virtual generated columns 2025-02-07 09:46:59 +01:00
.gitignore Build all Flex files standalone 2022-09-04 12:09:01 +07:00
Makefile Remove distprep 2023-11-06 15:18:04 +01:00
meson.build Update copyright for 2025 2025-01-01 11:21:55 -05:00
README postmaster: Rename some shutdown related PMState phase names 2025-01-10 11:43:00 -05:00
repl_gram.y Return yyparse() result not via global variable 2025-01-24 06:55:39 +01:00
repl_scanner.l Return yyparse() result not via global variable 2025-01-24 06:55:39 +01:00
slot.c Fix assertion when decoding XLOG_PARAMETER_CHANGE on promoted primary. 2025-02-24 14:03:04 -08:00
slotfuncs.c Doc: Fix pg_copy_logical_replication_slot description. 2025-02-25 09:42:07 +05:30
syncrep.c Return yyparse() result not via global variable 2025-01-24 06:55:39 +01:00
syncrep_gram.y Return yyparse() result not via global variable 2025-01-24 06:55:39 +01:00
syncrep_scanner.l Return yyparse() result not via global variable 2025-01-24 06:55:39 +01:00
walreceiver.c backend launchers void * arguments for binary data 2025-02-21 08:03:33 +01:00
walreceiverfuncs.c Remove unnecessary (char *) casts [string] 2025-02-12 08:49:18 +01:00
walsender.c Raise an error while trying to acquire an invalid slot. 2025-01-31 10:27:35 +05:30

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 the PM_WAIT_XLOG_ARCHIVAL 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.