diff options
Diffstat (limited to 'src/backend/access/transam')
| -rw-r--r-- | src/backend/access/transam/Makefile | 1 | ||||
| -rw-r--r-- | src/backend/access/transam/meson.build | 1 | ||||
| -rw-r--r-- | src/backend/access/transam/shell_restore.c | 171 | ||||
| -rw-r--r-- | src/backend/access/transam/xlog.c | 37 | ||||
| -rw-r--r-- | src/backend/access/transam/xlogarchive.c | 121 |
5 files changed, 126 insertions, 205 deletions
diff --git a/src/backend/access/transam/Makefile b/src/backend/access/transam/Makefile index 099c315d032..661c55a9db7 100644 --- a/src/backend/access/transam/Makefile +++ b/src/backend/access/transam/Makefile @@ -19,7 +19,6 @@ OBJS = \ multixact.o \ parallel.o \ rmgr.o \ - shell_restore.o \ slru.o \ subtrans.o \ timeline.o \ diff --git a/src/backend/access/transam/meson.build b/src/backend/access/transam/meson.build index 3031c2f6cfb..8920c1bfce2 100644 --- a/src/backend/access/transam/meson.build +++ b/src/backend/access/transam/meson.build @@ -7,7 +7,6 @@ backend_sources += files( 'multixact.c', 'parallel.c', 'rmgr.c', - 'shell_restore.c', 'slru.c', 'subtrans.c', 'timeline.c', diff --git a/src/backend/access/transam/shell_restore.c b/src/backend/access/transam/shell_restore.c deleted file mode 100644 index 8458209f490..00000000000 --- a/src/backend/access/transam/shell_restore.c +++ /dev/null @@ -1,171 +0,0 @@ -/*------------------------------------------------------------------------- - * - * shell_restore.c - * Recovery functions for a user-specified shell command. - * - * These recovery functions use a user-specified shell command (e.g. based - * on the GUC restore_command). - * - * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group - * Portions Copyright (c) 1994, Regents of the University of California - * - * src/backend/access/transam/shell_restore.c - * - *------------------------------------------------------------------------- - */ - -#include "postgres.h" - -#include <signal.h> - -#include "access/xlogarchive.h" -#include "access/xlogrecovery.h" -#include "common/percentrepl.h" -#include "storage/ipc.h" -#include "utils/wait_event.h" - -static bool ExecuteRecoveryCommand(const char *command, - const char *commandName, - bool failOnSignal, - bool exitOnSigterm, - uint32 wait_event_info, - int fail_elevel); - -/* - * Attempt to execute a shell-based restore command. - * - * Returns true if the command has succeeded, false otherwise. - */ -bool -shell_restore(const char *file, const char *path, - const char *lastRestartPointFileName) -{ - char *nativePath = pstrdup(path); - char *cmd; - bool ret; - - /* Build the restore command to execute */ - make_native_path(nativePath); - cmd = replace_percent_placeholders(recoveryRestoreCommand, - "restore_command", "frp", file, - lastRestartPointFileName, - nativePath); - pfree(nativePath); - - /* - * Remember, we rollforward UNTIL the restore fails so failure here is - * just part of the process... that makes it difficult to determine - * whether the restore failed because there isn't an archive to restore, - * or because the administrator has specified the restore program - * incorrectly. We have to assume the former. - * - * However, if the failure was due to any sort of signal, it's best to - * punt and abort recovery. (If we "return false" here, upper levels will - * assume that recovery is complete and start up the database!) It's - * essential to abort on child SIGINT and SIGQUIT, because per spec - * system() ignores SIGINT and SIGQUIT while waiting; if we see one of - * those it's a good bet we should have gotten it too. - * - * On SIGTERM, assume we have received a fast shutdown request, and exit - * cleanly. It's pure chance whether we receive the SIGTERM first, or the - * child process. If we receive it first, the signal handler will call - * proc_exit, otherwise we do it here. If we or the child process received - * SIGTERM for any other reason than a fast shutdown request, postmaster - * will perform an immediate shutdown when it sees us exiting - * unexpectedly. - * - * We treat hard shell errors such as "command not found" as fatal, too. - */ - ret = ExecuteRecoveryCommand(cmd, "restore_command", - true, /* failOnSignal */ - true, /* exitOnSigterm */ - WAIT_EVENT_RESTORE_COMMAND, DEBUG2); - pfree(cmd); - - return ret; -} - -/* - * Attempt to execute a shell-based archive cleanup command. - */ -void -shell_archive_cleanup(const char *lastRestartPointFileName) -{ - char *cmd; - - cmd = replace_percent_placeholders(archiveCleanupCommand, - "archive_cleanup_command", - "r", lastRestartPointFileName); - (void) ExecuteRecoveryCommand(cmd, "archive_cleanup_command", false, false, - WAIT_EVENT_ARCHIVE_CLEANUP_COMMAND, WARNING); - pfree(cmd); -} - -/* - * Attempt to execute a shell-based end-of-recovery command. - */ -void -shell_recovery_end(const char *lastRestartPointFileName) -{ - char *cmd; - - cmd = replace_percent_placeholders(recoveryEndCommand, - "recovery_end_command", - "r", lastRestartPointFileName); - (void) ExecuteRecoveryCommand(cmd, "recovery_end_command", true, false, - WAIT_EVENT_RECOVERY_END_COMMAND, WARNING); - pfree(cmd); -} - -/* - * Attempt to execute an external shell command during recovery. - * - * 'command' is the shell command to be executed, 'commandName' is a - * human-readable name describing the command emitted in the logs. If - * 'failOnSignal' is true and the command is killed by a signal, a FATAL - * error is thrown. Otherwise, 'fail_elevel' is used for the log message. - * If 'exitOnSigterm' is true and the command is killed by SIGTERM, we exit - * immediately. - * - * Returns whether the command succeeded. - */ -static bool -ExecuteRecoveryCommand(const char *command, const char *commandName, - bool failOnSignal, bool exitOnSigterm, - uint32 wait_event_info, int fail_elevel) -{ - int rc; - - Assert(command && commandName); - - ereport(DEBUG3, - (errmsg_internal("executing %s \"%s\"", commandName, command))); - - /* - * execute the constructed command - */ - fflush(NULL); - pgstat_report_wait_start(wait_event_info); - rc = system(command); - pgstat_report_wait_end(); - - if (rc != 0) - { - if (exitOnSigterm && wait_result_is_signal(rc, SIGTERM)) - proc_exit(1); - - /* - * If the failure was due to any sort of signal, it's best to punt and - * abort recovery. See comments in shell_restore(). - */ - ereport((failOnSignal && wait_result_is_any_signal(rc, true)) ? FATAL : fail_elevel, - /*------ - translator: First %s represents a postgresql.conf parameter name like - "recovery_end_command", the 2nd is the value of that parameter, the - third an already translated error message. */ - (errmsg("%s \"%s\": %s", commandName, - command, wait_result_to_str(rc)))); - } - - return (rc == 0); -} diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index fb4c860bdea..f9f0f6db8d1 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -692,7 +692,6 @@ static char *GetXLogBuffer(XLogRecPtr ptr, TimeLineID tli); static XLogRecPtr XLogBytePosToRecPtr(uint64 bytepos); static XLogRecPtr XLogBytePosToEndRecPtr(uint64 bytepos); static uint64 XLogRecPtrToBytePos(XLogRecPtr ptr); -static void GetOldestRestartPointFileName(char *fname); static void WALInsertLockAcquire(void); static void WALInsertLockAcquireExclusive(void); @@ -4890,12 +4889,10 @@ CleanupAfterArchiveRecovery(TimeLineID EndOfLogTLI, XLogRecPtr EndOfLog, * Execute the recovery_end_command, if any. */ if (recoveryEndCommand && strcmp(recoveryEndCommand, "") != 0) - { - char lastRestartPointFname[MAXFNAMELEN]; - - GetOldestRestartPointFileName(lastRestartPointFname); - shell_recovery_end(lastRestartPointFname); - } + ExecuteRecoveryCommand(recoveryEndCommand, + "recovery_end_command", + true, + WAIT_EVENT_RECOVERY_END_COMMAND); /* * We switched to a new timeline. Clean up segments on the old timeline. @@ -7312,12 +7309,10 @@ CreateRestartPoint(int flags) * Finally, execute archive_cleanup_command, if any. */ if (archiveCleanupCommand && strcmp(archiveCleanupCommand, "") != 0) - { - char lastRestartPointFname[MAXFNAMELEN]; - - GetOldestRestartPointFileName(lastRestartPointFname); - shell_archive_cleanup(lastRestartPointFname); - } + ExecuteRecoveryCommand(archiveCleanupCommand, + "archive_cleanup_command", + false, + WAIT_EVENT_ARCHIVE_CLEANUP_COMMAND); return true; } @@ -8894,22 +8889,6 @@ GetOldestRestartPoint(XLogRecPtr *oldrecptr, TimeLineID *oldtli) LWLockRelease(ControlFileLock); } -/* - * Returns the WAL file name for the last checkpoint or restartpoint. This is - * the oldest WAL file that we still need if we have to restart recovery. - */ -static void -GetOldestRestartPointFileName(char *fname) -{ - XLogRecPtr restartRedoPtr; - TimeLineID restartTli; - XLogSegNo restartSegNo; - - GetOldestRestartPoint(&restartRedoPtr, &restartTli); - XLByteToSeg(restartRedoPtr, restartSegNo, wal_segment_size); - XLogFileName(fname, restartTli, restartSegNo, wal_segment_size); -} - /* Thin wrapper around ShutdownWalRcv(). */ void XLogShutdownWalRcv(void) diff --git a/src/backend/access/transam/xlogarchive.c b/src/backend/access/transam/xlogarchive.c index 4b89addf976..fcc87ff44fd 100644 --- a/src/backend/access/transam/xlogarchive.c +++ b/src/backend/access/transam/xlogarchive.c @@ -22,6 +22,8 @@ #include "access/xlog.h" #include "access/xlog_internal.h" #include "access/xlogarchive.h" +#include "common/archive.h" +#include "common/percentrepl.h" #include "miscadmin.h" #include "pgstat.h" #include "postmaster/startup.h" @@ -55,8 +57,9 @@ RestoreArchivedFile(char *path, const char *xlogfname, bool cleanupEnabled) { char xlogpath[MAXPGPATH]; + char *xlogRestoreCmd; char lastRestartPointFname[MAXPGPATH]; - bool ret; + int rc; struct stat stat_buf; XLogSegNo restartSegNo; XLogRecPtr restartRedoPtr; @@ -147,6 +150,15 @@ RestoreArchivedFile(char *path, const char *xlogfname, else XLogFileName(lastRestartPointFname, 0, 0L, wal_segment_size); + /* Build the restore command to execute */ + xlogRestoreCmd = BuildRestoreCommand(recoveryRestoreCommand, + xlogpath, xlogfname, + lastRestartPointFname); + + ereport(DEBUG3, + (errmsg_internal("executing restore command \"%s\"", + xlogRestoreCmd))); + /* * Check signals before restore command and reset afterwards. */ @@ -155,11 +167,15 @@ RestoreArchivedFile(char *path, const char *xlogfname, /* * Copy xlog from archival storage to XLOGDIR */ - ret = shell_restore(xlogfname, xlogpath, lastRestartPointFname); + fflush(NULL); + pgstat_report_wait_start(WAIT_EVENT_RESTORE_COMMAND); + rc = system(xlogRestoreCmd); + pgstat_report_wait_end(); PostRestoreCommand(); + pfree(xlogRestoreCmd); - if (ret) + if (rc == 0) { /* * command apparently succeeded, but let's make sure the file is @@ -215,6 +231,37 @@ RestoreArchivedFile(char *path, const char *xlogfname, } } + /* + * Remember, we rollforward UNTIL the restore fails so failure here is + * just part of the process... that makes it difficult to determine + * whether the restore failed because there isn't an archive to restore, + * or because the administrator has specified the restore program + * incorrectly. We have to assume the former. + * + * However, if the failure was due to any sort of signal, it's best to + * punt and abort recovery. (If we "return false" here, upper levels will + * assume that recovery is complete and start up the database!) It's + * essential to abort on child SIGINT and SIGQUIT, because per spec + * system() ignores SIGINT and SIGQUIT while waiting; if we see one of + * those it's a good bet we should have gotten it too. + * + * On SIGTERM, assume we have received a fast shutdown request, and exit + * cleanly. It's pure chance whether we receive the SIGTERM first, or the + * child process. If we receive it first, the signal handler will call + * proc_exit, otherwise we do it here. If we or the child process received + * SIGTERM for any other reason than a fast shutdown request, postmaster + * will perform an immediate shutdown when it sees us exiting + * unexpectedly. + * + * We treat hard shell errors such as "command not found" as fatal, too. + */ + if (wait_result_is_signal(rc, SIGTERM)) + proc_exit(1); + + ereport(wait_result_is_any_signal(rc, true) ? FATAL : DEBUG2, + (errmsg("could not restore file \"%s\" from archive: %s", + xlogfname, wait_result_to_str(rc)))); + not_available: /* @@ -229,6 +276,74 @@ not_available: } /* + * Attempt to execute an external shell command during recovery. + * + * 'command' is the shell command to be executed, 'commandName' is a + * human-readable name describing the command emitted in the logs. If + * 'failOnSignal' is true and the command is killed by a signal, a FATAL + * error is thrown. Otherwise a WARNING is emitted. + * + * This is currently used for recovery_end_command and archive_cleanup_command. + */ +void +ExecuteRecoveryCommand(const char *command, const char *commandName, + bool failOnSignal, uint32 wait_event_info) +{ + char *xlogRecoveryCmd; + char lastRestartPointFname[MAXPGPATH]; + int rc; + XLogSegNo restartSegNo; + XLogRecPtr restartRedoPtr; + TimeLineID restartTli; + + Assert(command && commandName); + + /* + * Calculate the archive file cutoff point for use during log shipping + * replication. All files earlier than this point can be deleted from the + * archive, though there is no requirement to do so. + */ + GetOldestRestartPoint(&restartRedoPtr, &restartTli); + XLByteToSeg(restartRedoPtr, restartSegNo, wal_segment_size); + XLogFileName(lastRestartPointFname, restartTli, restartSegNo, + wal_segment_size); + + /* + * construct the command to be executed + */ + xlogRecoveryCmd = replace_percent_placeholders(command, commandName, "r", lastRestartPointFname); + + ereport(DEBUG3, + (errmsg_internal("executing %s \"%s\"", commandName, command))); + + /* + * execute the constructed command + */ + fflush(NULL); + pgstat_report_wait_start(wait_event_info); + rc = system(xlogRecoveryCmd); + pgstat_report_wait_end(); + + pfree(xlogRecoveryCmd); + + if (rc != 0) + { + /* + * If the failure was due to any sort of signal, it's best to punt and + * abort recovery. See comments in RestoreArchivedFile(). + */ + ereport((failOnSignal && wait_result_is_any_signal(rc, true)) ? FATAL : WARNING, + /*------ + translator: First %s represents a postgresql.conf parameter name like + "recovery_end_command", the 2nd is the value of that parameter, the + third an already translated error message. */ + (errmsg("%s \"%s\": %s", commandName, + command, wait_result_to_str(rc)))); + } +} + + +/* * A file was restored from the archive under a temporary filename (path), * and now we want to keep it. Rename it under the permanent filename in * pg_wal (xlogfname), replacing any existing file with the same name. |