Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pPpbl-0007yX-Pn for pgsql-hackers@arkaria.postgresql.org; Wed, 08 Feb 2023 18:55:54 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.92) (envelope-from ) id 1pPpbk-0004lI-D0 for pgsql-hackers@arkaria.postgresql.org; Wed, 08 Feb 2023 18:55:52 +0000 Received: from makus.postgresql.org ([2001:4800:3e1:1::229]) by malur.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pPpbj-0004l9-P6 for pgsql-hackers@lists.postgresql.org; Wed, 08 Feb 2023 18:55:52 +0000 Received: from mail-pl1-x62d.google.com ([2607:f8b0:4864:20::62d]) by makus.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.92) (envelope-from ) id 1pPpbg-0000qk-GQ for pgsql-hackers@postgresql.org; Wed, 08 Feb 2023 18:55:50 +0000 Received: by mail-pl1-x62d.google.com with SMTP id m2so20413225plg.4 for ; Wed, 08 Feb 2023 10:55:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=0DpdXOV1ktXnjKm7GHVX2uHqbOKmzTGTevb+aGjN/Hg=; b=DB7GLPGnQ2Q7hq4LjbLjDpqhM+YnagYCv/HVANCvi1KemvPNjeJlgLC0NbatfjV8Lo 8VsotvkueRlThpSpVIqfw945BGy6fOtMdKWgDoGztCwDz/raBHGJl1NQ/Ykt6QFAx/oF j+5DlGiTS2P9hoUmO39tmAEYGyk91uDcDc/bd+d96P1mDLhBiEO/XuZ3WSl8mlpSdeKJ E3jMjGgUn2Y+g5wcJkjAkcnYn928XQaAT1Xi12ajNCdJtk/7XYAh9KdVcwIM18ZAn8Dq 2w6k4lW8S4d1ZJEUGMRV6WtHtwia3mVNrrcYnF8pRiv5HxaVQ/CRKSCcETxqH0UF4r5d J9Pg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=0DpdXOV1ktXnjKm7GHVX2uHqbOKmzTGTevb+aGjN/Hg=; b=gfCaNl/3Q3ZhJfvrXcRPlRc1EKtCZEin30zxYbFVdgYcW21GDWr2+kjGAJB9s2y0tm ujy8Wkr6ENc+A5EvMIl2Ot8zmNNl7MnmWsHanF9M0z0vBVqLFtH9BzsFqGO72a+EjDej eK7eWfB63vPcgokVXrQAHs9wnS2GLKNCz9ltVHiSSVQQjlDkN0NQr30hCzHSkIS7KXzC MV0o610EgpG8/w9L6YEEUkkZkYw2Jivb63ZkIJSkYRVRCQqlZMAeTjZfy4VSADeYXiL1 U3D/j0er4QmmFwEqWjFhfTeicCec/ZjLd+s2nuGDa+2YYwqHQxEqY5QUTtTSpXe8Nf9k oPgw== X-Gm-Message-State: AO0yUKXS/P/wIc4J/aYD1AH8YZEPQoaElPibX/w/Ls+XOkypO8eeiUz/ zzIu3lHWVsTbbDbTmxOpsWU= X-Google-Smtp-Source: AK7set+smTSYucXPbsggrPmY+t0sVVv3myeLjbN9IuvmEa1/fcuPn5IiNBKe2GgJPjFPTScWwWs6zQ== X-Received: by 2002:a17:903:18f:b0:199:494b:4237 with SMTP id z15-20020a170903018f00b00199494b4237mr2324349plg.25.1675882547387; Wed, 08 Feb 2023 10:55:47 -0800 (PST) Received: from nathanxps13 ([50.47.162.83]) by smtp.gmail.com with ESMTPSA id jf14-20020a170903268e00b001991cff52a8sm6052617plb.28.2023.02.08.10.55.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 08 Feb 2023 10:55:46 -0800 (PST) Date: Wed, 8 Feb 2023 10:55:44 -0800 From: Nathan Bossart To: Andres Freund Cc: Michael Paquier , pgsql-hackers@postgresql.org Subject: Re: recovery modules Message-ID: <20230208185544.GA512253@nathanxps13> References: <20230202193700.GA3887858@nathanxps13> <20230204181436.GA267131@nathanxps13> <20230208162713.zavyhxywheh4kuns@awork3.anarazel.de> <20230208172705.GA451849@nathanxps13> <20230208173344.ku22sogm6jgr27cl@awork3.anarazel.de> <20230208175756.GA496266@nathanxps13> <20230208182418.27g5ggqpha5ocngx@awork3.anarazel.de> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="4Ckj6UjgE2iN1+kY" Content-Disposition: inline In-Reply-To: <20230208182418.27g5ggqpha5ocngx@awork3.anarazel.de> List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Archived-At: Precedence: bulk --4Ckj6UjgE2iN1+kY Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Wed, Feb 08, 2023 at 10:24:18AM -0800, Andres Freund wrote: > If you'd reorder it so that 0004 applies independently from the other changes, > I'd just push that now. done -- Nathan Bossart Amazon Web Services: https://aws.amazon.com --4Ckj6UjgE2iN1+kY Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v8-0001-remove-unnecessary-assertions-for-functions-with-.patch" From 688566e23519f173a805696e4f00345f30d5d8e6 Mon Sep 17 00:00:00 2001 From: Nathan Bossart Date: Wed, 8 Feb 2023 09:51:46 -0800 Subject: [PATCH v8 1/4] remove unnecessary assertions for functions with central declarations --- contrib/basic_archive/basic_archive.c | 2 -- contrib/test_decoding/test_decoding.c | 2 -- src/backend/postmaster/shell_archive.c | 2 -- src/backend/replication/pgoutput/pgoutput.c | 2 -- 4 files changed, 8 deletions(-) diff --git a/contrib/basic_archive/basic_archive.c b/contrib/basic_archive/basic_archive.c index 3d29711a31..36b7a4814a 100644 --- a/contrib/basic_archive/basic_archive.c +++ b/contrib/basic_archive/basic_archive.c @@ -81,8 +81,6 @@ _PG_init(void) void _PG_archive_module_init(ArchiveModuleCallbacks *cb) { - AssertVariableIsOfType(&_PG_archive_module_init, ArchiveModuleInit); - cb->check_configured_cb = basic_archive_configured; cb->archive_file_cb = basic_archive_file; } diff --git a/contrib/test_decoding/test_decoding.c b/contrib/test_decoding/test_decoding.c index e523d22eba..b7e6048647 100644 --- a/contrib/test_decoding/test_decoding.c +++ b/contrib/test_decoding/test_decoding.c @@ -127,8 +127,6 @@ _PG_init(void) void _PG_output_plugin_init(OutputPluginCallbacks *cb) { - AssertVariableIsOfType(&_PG_output_plugin_init, LogicalOutputPluginInit); - cb->startup_cb = pg_decode_startup; cb->begin_cb = pg_decode_begin_txn; cb->change_cb = pg_decode_change; diff --git a/src/backend/postmaster/shell_archive.c b/src/backend/postmaster/shell_archive.c index 806b81c3f2..7771b951b7 100644 --- a/src/backend/postmaster/shell_archive.c +++ b/src/backend/postmaster/shell_archive.c @@ -29,8 +29,6 @@ static void shell_archive_shutdown(void); void shell_archive_init(ArchiveModuleCallbacks *cb) { - AssertVariableIsOfType(&shell_archive_init, ArchiveModuleInit); - cb->check_configured_cb = shell_archive_configured; cb->archive_file_cb = shell_archive_file; cb->shutdown_cb = shell_archive_shutdown; diff --git a/src/backend/replication/pgoutput/pgoutput.c b/src/backend/replication/pgoutput/pgoutput.c index 73b080060d..98377c094b 100644 --- a/src/backend/replication/pgoutput/pgoutput.c +++ b/src/backend/replication/pgoutput/pgoutput.c @@ -248,8 +248,6 @@ static void pgoutput_column_list_init(PGOutputData *data, void _PG_output_plugin_init(OutputPluginCallbacks *cb) { - AssertVariableIsOfType(&_PG_output_plugin_init, LogicalOutputPluginInit); - cb->startup_cb = pgoutput_startup; cb->begin_cb = pgoutput_begin_txn; cb->change_cb = pgoutput_change; -- 2.25.1 --4Ckj6UjgE2iN1+kY Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v8-0002-s-ArchiveContext-ArchiveCallbacks.patch" From c09374708bdde1eab98fdcad320d5689c6764bc2 Mon Sep 17 00:00:00 2001 From: Nathan Bossart Date: Fri, 27 Jan 2023 21:01:22 -0800 Subject: [PATCH v8 2/4] s/ArchiveContext/ArchiveCallbacks --- src/backend/postmaster/pgarch.c | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/backend/postmaster/pgarch.c b/src/backend/postmaster/pgarch.c index e551af2905..065d7d1313 100644 --- a/src/backend/postmaster/pgarch.c +++ b/src/backend/postmaster/pgarch.c @@ -97,7 +97,7 @@ char *XLogArchiveLibrary = ""; */ static time_t last_sigterm_time = 0; static PgArchData *PgArch = NULL; -static ArchiveModuleCallbacks ArchiveContext; +static ArchiveModuleCallbacks ArchiveCallbacks; /* @@ -406,8 +406,8 @@ pgarch_ArchiverCopyLoop(void) HandlePgArchInterrupts(); /* can't do anything if not configured ... */ - if (ArchiveContext.check_configured_cb != NULL && - !ArchiveContext.check_configured_cb()) + if (ArchiveCallbacks.check_configured_cb != NULL && + !ArchiveCallbacks.check_configured_cb()) { ereport(WARNING, (errmsg("archive_mode enabled, yet archiving is not configured"))); @@ -508,7 +508,7 @@ pgarch_archiveXlog(char *xlog) snprintf(activitymsg, sizeof(activitymsg), "archiving %s", xlog); set_ps_display(activitymsg); - ret = ArchiveContext.archive_file_cb(xlog, pathname); + ret = ArchiveCallbacks.archive_file_cb(xlog, pathname); if (ret) snprintf(activitymsg, sizeof(activitymsg), "last was %s", xlog); else @@ -814,7 +814,7 @@ HandlePgArchInterrupts(void) /* * LoadArchiveLibrary * - * Loads the archiving callbacks into our local ArchiveContext. + * Loads the archiving callbacks into our local ArchiveCallbacks. */ static void LoadArchiveLibrary(void) @@ -827,7 +827,7 @@ LoadArchiveLibrary(void) errmsg("both archive_command and archive_library set"), errdetail("Only one of archive_command, archive_library may be set."))); - memset(&ArchiveContext, 0, sizeof(ArchiveModuleCallbacks)); + memset(&ArchiveCallbacks, 0, sizeof(ArchiveModuleCallbacks)); /* * If shell archiving is enabled, use our special initialization function. @@ -844,9 +844,9 @@ LoadArchiveLibrary(void) ereport(ERROR, (errmsg("archive modules have to define the symbol %s", "_PG_archive_module_init"))); - (*archive_init) (&ArchiveContext); + (*archive_init) (&ArchiveCallbacks); - if (ArchiveContext.archive_file_cb == NULL) + if (ArchiveCallbacks.archive_file_cb == NULL) ereport(ERROR, (errmsg("archive modules must register an archive callback"))); @@ -859,6 +859,6 @@ LoadArchiveLibrary(void) static void pgarch_call_module_shutdown_cb(int code, Datum arg) { - if (ArchiveContext.shutdown_cb != NULL) - ArchiveContext.shutdown_cb(); + if (ArchiveCallbacks.shutdown_cb != NULL) + ArchiveCallbacks.shutdown_cb(); } -- 2.25.1 --4Ckj6UjgE2iN1+kY Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v8-0003-move-archive-module-exports-to-dedicated-headers.patch" From bf2b5007a4ad105d683f58e35d75d0e86666d293 Mon Sep 17 00:00:00 2001 From: Nathan Bossart Date: Fri, 27 Jan 2023 21:16:34 -0800 Subject: [PATCH v8 3/4] move archive module exports to dedicated headers --- contrib/basic_archive/basic_archive.c | 2 +- src/backend/postmaster/pgarch.c | 2 ++ src/backend/postmaster/shell_archive.c | 3 +- src/backend/utils/misc/guc_tables.c | 1 + src/include/postmaster/archive_module.h | 47 +++++++++++++++++++++++++ src/include/postmaster/pgarch.h | 39 -------------------- src/include/postmaster/shell_archive.h | 24 +++++++++++++ 7 files changed, 77 insertions(+), 41 deletions(-) create mode 100644 src/include/postmaster/archive_module.h create mode 100644 src/include/postmaster/shell_archive.h diff --git a/contrib/basic_archive/basic_archive.c b/contrib/basic_archive/basic_archive.c index 36b7a4814a..384336884d 100644 --- a/contrib/basic_archive/basic_archive.c +++ b/contrib/basic_archive/basic_archive.c @@ -32,7 +32,7 @@ #include "common/int.h" #include "miscadmin.h" -#include "postmaster/pgarch.h" +#include "postmaster/archive_module.h" #include "storage/copydir.h" #include "storage/fd.h" #include "utils/guc.h" diff --git a/src/backend/postmaster/pgarch.c b/src/backend/postmaster/pgarch.c index 065d7d1313..281d9fd8b7 100644 --- a/src/backend/postmaster/pgarch.c +++ b/src/backend/postmaster/pgarch.c @@ -34,8 +34,10 @@ #include "lib/binaryheap.h" #include "libpq/pqsignal.h" #include "pgstat.h" +#include "postmaster/archive_module.h" #include "postmaster/interrupt.h" #include "postmaster/pgarch.h" +#include "postmaster/shell_archive.h" #include "storage/fd.h" #include "storage/ipc.h" #include "storage/latch.h" diff --git a/src/backend/postmaster/shell_archive.c b/src/backend/postmaster/shell_archive.c index 7771b951b7..0f0558e155 100644 --- a/src/backend/postmaster/shell_archive.c +++ b/src/backend/postmaster/shell_archive.c @@ -20,7 +20,8 @@ #include "access/xlog.h" #include "common/percentrepl.h" #include "pgstat.h" -#include "postmaster/pgarch.h" +#include "postmaster/archive_module.h" +#include "postmaster/shell_archive.h" static bool shell_archive_configured(void); static bool shell_archive_file(const char *file, const char *path); diff --git a/src/backend/utils/misc/guc_tables.c b/src/backend/utils/misc/guc_tables.c index b46e3b8c55..c3ee83b691 100644 --- a/src/backend/utils/misc/guc_tables.c +++ b/src/backend/utils/misc/guc_tables.c @@ -52,6 +52,7 @@ #include "parser/parse_expr.h" #include "parser/parser.h" #include "pgstat.h" +#include "postmaster/archive_module.h" #include "postmaster/autovacuum.h" #include "postmaster/bgworker_internals.h" #include "postmaster/bgwriter.h" diff --git a/src/include/postmaster/archive_module.h b/src/include/postmaster/archive_module.h new file mode 100644 index 0000000000..f5015ff95d --- /dev/null +++ b/src/include/postmaster/archive_module.h @@ -0,0 +1,47 @@ +/*------------------------------------------------------------------------- + * + * archive_module.h + * Exports for archive modules. + * + * Copyright (c) 2022-2023, PostgreSQL Global Development Group + * + * src/include/postmaster/archive_module.h + * + *------------------------------------------------------------------------- + */ +#ifndef _ARCHIVE_MODULE_H +#define _ARCHIVE_MODULE_H + +/* + * The value of the archive_library GUC. + */ +extern PGDLLIMPORT char *XLogArchiveLibrary; + +/* + * Archive module callbacks + * + * These callback functions should be defined by archive libraries and returned + * via _PG_archive_module_init(). ArchiveFileCB is the only required callback. + * For more information about the purpose of each callback, refer to the + * archive modules documentation. + */ +typedef bool (*ArchiveCheckConfiguredCB) (void); +typedef bool (*ArchiveFileCB) (const char *file, const char *path); +typedef void (*ArchiveShutdownCB) (void); + +typedef struct ArchiveModuleCallbacks +{ + ArchiveCheckConfiguredCB check_configured_cb; + ArchiveFileCB archive_file_cb; + ArchiveShutdownCB shutdown_cb; +} ArchiveModuleCallbacks; + +/* + * Type of the shared library symbol _PG_archive_module_init that is looked + * up when loading an archive library. + */ +typedef void (*ArchiveModuleInit) (ArchiveModuleCallbacks *cb); + +extern PGDLLEXPORT void _PG_archive_module_init(ArchiveModuleCallbacks *cb); + +#endif /* _ARCHIVE_MODULE_H */ diff --git a/src/include/postmaster/pgarch.h b/src/include/postmaster/pgarch.h index bcd51dfad6..3bd4fac71e 100644 --- a/src/include/postmaster/pgarch.h +++ b/src/include/postmaster/pgarch.h @@ -33,43 +33,4 @@ extern void PgArchiverMain(void) pg_attribute_noreturn(); extern void PgArchWakeup(void); extern void PgArchForceDirScan(void); -/* - * The value of the archive_library GUC. - */ -extern PGDLLIMPORT char *XLogArchiveLibrary; - -/* - * Archive module callbacks - * - * These callback functions should be defined by archive libraries and returned - * via _PG_archive_module_init(). ArchiveFileCB is the only required callback. - * For more information about the purpose of each callback, refer to the - * archive modules documentation. - */ -typedef bool (*ArchiveCheckConfiguredCB) (void); -typedef bool (*ArchiveFileCB) (const char *file, const char *path); -typedef void (*ArchiveShutdownCB) (void); - -typedef struct ArchiveModuleCallbacks -{ - ArchiveCheckConfiguredCB check_configured_cb; - ArchiveFileCB archive_file_cb; - ArchiveShutdownCB shutdown_cb; -} ArchiveModuleCallbacks; - -/* - * Type of the shared library symbol _PG_archive_module_init that is looked - * up when loading an archive library. - */ -typedef void (*ArchiveModuleInit) (ArchiveModuleCallbacks *cb); - -extern PGDLLEXPORT void _PG_archive_module_init(ArchiveModuleCallbacks *cb); - -/* - * Since the logic for archiving via a shell command is in the core server - * and does not need to be loaded via a shared library, it has a special - * initialization function. - */ -extern void shell_archive_init(ArchiveModuleCallbacks *cb); - #endif /* _PGARCH_H */ diff --git a/src/include/postmaster/shell_archive.h b/src/include/postmaster/shell_archive.h new file mode 100644 index 0000000000..3cf737ce8e --- /dev/null +++ b/src/include/postmaster/shell_archive.h @@ -0,0 +1,24 @@ +/*------------------------------------------------------------------------- + * + * shell_archive.h + * Exports for archiving via shell. + * + * Copyright (c) 2022-2023, PostgreSQL Global Development Group + * + * src/include/postmaster/shell_archive.h + * + *------------------------------------------------------------------------- + */ +#ifndef _SHELL_ARCHIVE_H +#define _SHELL_ARCHIVE_H + +#include "postmaster/archive_module.h" + +/* + * Since the logic for archiving via a shell command is in the core server + * and does not need to be loaded via a shared library, it has a special + * initialization function. + */ +extern void shell_archive_init(ArchiveModuleCallbacks *cb); + +#endif /* _SHELL_ARCHIVE_H */ -- 2.25.1 --4Ckj6UjgE2iN1+kY Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v8-0004-restructure-archive-modules-API.patch" From 6a143527ee2ad7f1a3aebc3564da20cab21a0d5e Mon Sep 17 00:00:00 2001 From: Nathan Bossart Date: Tue, 31 Jan 2023 14:58:40 -0800 Subject: [PATCH v8 4/4] restructure archive modules API --- contrib/basic_archive/basic_archive.c | 51 +++++++++++++++++++------ doc/src/sgml/archive-modules.sgml | 35 +++++++++++++---- src/backend/postmaster/pgarch.c | 23 ++++++----- src/backend/postmaster/shell_archive.c | 29 ++++++++------ src/include/postmaster/archive_module.h | 21 +++++++--- src/include/postmaster/shell_archive.h | 2 +- 6 files changed, 114 insertions(+), 47 deletions(-) diff --git a/contrib/basic_archive/basic_archive.c b/contrib/basic_archive/basic_archive.c index 384336884d..9afa03c5e2 100644 --- a/contrib/basic_archive/basic_archive.c +++ b/contrib/basic_archive/basic_archive.c @@ -40,15 +40,27 @@ PG_MODULE_MAGIC; +typedef struct BasicArchiveData +{ + MemoryContext context; +} BasicArchiveData; + static char *archive_directory = NULL; -static MemoryContext basic_archive_context; -static bool basic_archive_configured(void); -static bool basic_archive_file(const char *file, const char *path); +static void basic_archive_startup(ArchiveModuleState *state); +static bool basic_archive_configured(ArchiveModuleState *state); +static bool basic_archive_file(ArchiveModuleState *state, const char *file, const char *path); static void basic_archive_file_internal(const char *file, const char *path); static bool check_archive_directory(char **newval, void **extra, GucSource source); static bool compare_files(const char *file1, const char *file2); +static const ArchiveModuleCallbacks basic_archive_callbacks = { + .startup_cb = basic_archive_startup, + .check_configured_cb = basic_archive_configured, + .archive_file_cb = basic_archive_file, + .shutdown_cb = NULL +}; + /* * _PG_init * @@ -67,10 +79,6 @@ _PG_init(void) check_archive_directory, NULL, NULL); MarkGUCPrefixReserved("basic_archive"); - - basic_archive_context = AllocSetContextCreate(TopMemoryContext, - "basic_archive", - ALLOCSET_DEFAULT_SIZES); } /* @@ -78,11 +86,28 @@ _PG_init(void) * * Returns the module's archiving callbacks. */ +const ArchiveModuleCallbacks * +_PG_archive_module_init(void) +{ + return &basic_archive_callbacks; +} + +/* + * basic_archive_startup + * + * Creates the module's memory context. + */ void -_PG_archive_module_init(ArchiveModuleCallbacks *cb) +basic_archive_startup(ArchiveModuleState *state) { - cb->check_configured_cb = basic_archive_configured; - cb->archive_file_cb = basic_archive_file; + BasicArchiveData *data; + + data = (BasicArchiveData *) MemoryContextAllocZero(TopMemoryContext, + sizeof(BasicArchiveData)); + data->context = AllocSetContextCreate(TopMemoryContext, + "basic_archive", + ALLOCSET_DEFAULT_SIZES); + state->private_data = (void *) data; } /* @@ -133,7 +158,7 @@ check_archive_directory(char **newval, void **extra, GucSource source) * Checks that archive_directory is not blank. */ static bool -basic_archive_configured(void) +basic_archive_configured(ArchiveModuleState *state) { return archive_directory != NULL && archive_directory[0] != '\0'; } @@ -144,10 +169,12 @@ basic_archive_configured(void) * Archives one file. */ static bool -basic_archive_file(const char *file, const char *path) +basic_archive_file(ArchiveModuleState *state, const char *file, const char *path) { sigjmp_buf local_sigjmp_buf; MemoryContext oldcontext; + BasicArchiveData *data = (BasicArchiveData *) (state->private_data); + MemoryContext basic_archive_context = data->context; /* * We run basic_archive_file_internal() in our own memory context so that diff --git a/doc/src/sgml/archive-modules.sgml b/doc/src/sgml/archive-modules.sgml index ef02051f7f..2db1b19216 100644 --- a/doc/src/sgml/archive-modules.sgml +++ b/doc/src/sgml/archive-modules.sgml @@ -47,23 +47,30 @@ normal library search path is used to locate the library. To provide the required archive module callbacks and to indicate that the library is actually an archive module, it needs to provide a function named - _PG_archive_module_init. This function is passed a - struct that needs to be filled with the callback function pointers for - individual actions. + _PG_archive_module_init. This function must return an + ArchiveModuleCallbacks struct filled with the + callback function pointers for individual actions. typedef struct ArchiveModuleCallbacks { + ArchiveStartupCB startup_cb; ArchiveCheckConfiguredCB check_configured_cb; ArchiveFileCB archive_file_cb; ArchiveShutdownCB shutdown_cb; } ArchiveModuleCallbacks; -typedef void (*ArchiveModuleInit) (struct ArchiveModuleCallbacks *cb); +typedef const ArchiveModuleCallbacks *(*ArchiveModuleInit) (void); Only the archive_file_cb callback is required. The others are optional. + + + + archive_library is only loaded in the archiver process. + + @@ -73,6 +80,20 @@ typedef void (*ArchiveModuleInit) (struct ArchiveModuleCallbacks *cb); The server will call them as required to process each individual WAL file. + + Startup Callback + + The startup_cb callback is called shortly after the + module is loaded. This callback can be used to perform any additional + initialization required. If the archive module needs to have a state, it + can use state->private_data to store it. + + +typedef void (*ArchiveStartupCB) (ArchiveModuleState *state); + + + + Check Callback @@ -83,7 +104,7 @@ typedef void (*ArchiveModuleInit) (struct ArchiveModuleCallbacks *cb); assumes the module is configured. -typedef bool (*ArchiveCheckConfiguredCB) (void); +typedef bool (*ArchiveCheckConfiguredCB) (ArchiveModuleState *state); If true is returned, the server will proceed with @@ -105,7 +126,7 @@ WARNING: archive_mode enabled, yet archiving is not configured single WAL file. -typedef bool (*ArchiveFileCB) (const char *file, const char *path); +typedef bool (*ArchiveFileCB) (ArchiveModuleState *state, const char *file, const char *path); If true is returned, the server proceeds as if the file @@ -128,7 +149,7 @@ typedef bool (*ArchiveFileCB) (const char *file, const char *path); these situations. -typedef void (*ArchiveShutdownCB) (void); +typedef void (*ArchiveShutdownCB) (ArchiveModuleState *state); diff --git a/src/backend/postmaster/pgarch.c b/src/backend/postmaster/pgarch.c index 281d9fd8b7..99a07996f7 100644 --- a/src/backend/postmaster/pgarch.c +++ b/src/backend/postmaster/pgarch.c @@ -99,7 +99,8 @@ char *XLogArchiveLibrary = ""; */ static time_t last_sigterm_time = 0; static PgArchData *PgArch = NULL; -static ArchiveModuleCallbacks ArchiveCallbacks; +static const ArchiveModuleCallbacks *ArchiveCallbacks; +static ArchiveModuleState *archive_module_state; /* @@ -408,8 +409,8 @@ pgarch_ArchiverCopyLoop(void) HandlePgArchInterrupts(); /* can't do anything if not configured ... */ - if (ArchiveCallbacks.check_configured_cb != NULL && - !ArchiveCallbacks.check_configured_cb()) + if (ArchiveCallbacks->check_configured_cb != NULL && + !ArchiveCallbacks->check_configured_cb(archive_module_state)) { ereport(WARNING, (errmsg("archive_mode enabled, yet archiving is not configured"))); @@ -510,7 +511,7 @@ pgarch_archiveXlog(char *xlog) snprintf(activitymsg, sizeof(activitymsg), "archiving %s", xlog); set_ps_display(activitymsg); - ret = ArchiveCallbacks.archive_file_cb(xlog, pathname); + ret = ArchiveCallbacks->archive_file_cb(archive_module_state, xlog, pathname); if (ret) snprintf(activitymsg, sizeof(activitymsg), "last was %s", xlog); else @@ -829,8 +830,6 @@ LoadArchiveLibrary(void) errmsg("both archive_command and archive_library set"), errdetail("Only one of archive_command, archive_library may be set."))); - memset(&ArchiveCallbacks, 0, sizeof(ArchiveModuleCallbacks)); - /* * If shell archiving is enabled, use our special initialization function. * Otherwise, load the library and call its _PG_archive_module_init(). @@ -846,12 +845,16 @@ LoadArchiveLibrary(void) ereport(ERROR, (errmsg("archive modules have to define the symbol %s", "_PG_archive_module_init"))); - (*archive_init) (&ArchiveCallbacks); + ArchiveCallbacks = (*archive_init) (); - if (ArchiveCallbacks.archive_file_cb == NULL) + if (ArchiveCallbacks->archive_file_cb == NULL) ereport(ERROR, (errmsg("archive modules must register an archive callback"))); + archive_module_state = (ArchiveModuleState *) palloc0(sizeof(ArchiveModuleState)); + if (ArchiveCallbacks->startup_cb != NULL) + ArchiveCallbacks->startup_cb(archive_module_state); + before_shmem_exit(pgarch_call_module_shutdown_cb, 0); } @@ -861,6 +864,6 @@ LoadArchiveLibrary(void) static void pgarch_call_module_shutdown_cb(int code, Datum arg) { - if (ArchiveCallbacks.shutdown_cb != NULL) - ArchiveCallbacks.shutdown_cb(); + if (ArchiveCallbacks->shutdown_cb != NULL) + ArchiveCallbacks->shutdown_cb(archive_module_state); } diff --git a/src/backend/postmaster/shell_archive.c b/src/backend/postmaster/shell_archive.c index 0f0558e155..54b02ca152 100644 --- a/src/backend/postmaster/shell_archive.c +++ b/src/backend/postmaster/shell_archive.c @@ -23,26 +23,31 @@ #include "postmaster/archive_module.h" #include "postmaster/shell_archive.h" -static bool shell_archive_configured(void); -static bool shell_archive_file(const char *file, const char *path); -static void shell_archive_shutdown(void); - -void -shell_archive_init(ArchiveModuleCallbacks *cb) +static bool shell_archive_configured(ArchiveModuleState *state); +static bool shell_archive_file(ArchiveModuleState *state, const char *file, const char *path); +static void shell_archive_shutdown(ArchiveModuleState *state); + +static const ArchiveModuleCallbacks shell_archive_callbacks = { + .startup_cb = NULL, + .check_configured_cb = shell_archive_configured, + .archive_file_cb = shell_archive_file, + .shutdown_cb = shell_archive_shutdown +}; + +const ArchiveModuleCallbacks * +shell_archive_init(void) { - cb->check_configured_cb = shell_archive_configured; - cb->archive_file_cb = shell_archive_file; - cb->shutdown_cb = shell_archive_shutdown; + return &shell_archive_callbacks; } static bool -shell_archive_configured(void) +shell_archive_configured(ArchiveModuleState *state) { return XLogArchiveCommand[0] != '\0'; } static bool -shell_archive_file(const char *file, const char *path) +shell_archive_file(ArchiveModuleState *state, const char *file, const char *path) { char *xlogarchcmd; char *nativePath = NULL; @@ -124,7 +129,7 @@ shell_archive_file(const char *file, const char *path) } static void -shell_archive_shutdown(void) +shell_archive_shutdown(ArchiveModuleState *state) { elog(DEBUG1, "archiver process shutting down"); } diff --git a/src/include/postmaster/archive_module.h b/src/include/postmaster/archive_module.h index f5015ff95d..79e9d53534 100644 --- a/src/include/postmaster/archive_module.h +++ b/src/include/postmaster/archive_module.h @@ -17,6 +17,15 @@ */ extern PGDLLIMPORT char *XLogArchiveLibrary; +typedef struct ArchiveModuleState +{ + /* + * Private data pointer for use by an archive module. This can be used to + * store state for the module that will be passed to each of its callbacks. + */ + void *private_data; +} ArchiveModuleState; + /* * Archive module callbacks * @@ -25,12 +34,14 @@ extern PGDLLIMPORT char *XLogArchiveLibrary; * For more information about the purpose of each callback, refer to the * archive modules documentation. */ -typedef bool (*ArchiveCheckConfiguredCB) (void); -typedef bool (*ArchiveFileCB) (const char *file, const char *path); -typedef void (*ArchiveShutdownCB) (void); +typedef void (*ArchiveStartupCB) (ArchiveModuleState *state); +typedef bool (*ArchiveCheckConfiguredCB) (ArchiveModuleState *state); +typedef bool (*ArchiveFileCB) (ArchiveModuleState *state, const char *file, const char *path); +typedef void (*ArchiveShutdownCB) (ArchiveModuleState *state); typedef struct ArchiveModuleCallbacks { + ArchiveStartupCB startup_cb; ArchiveCheckConfiguredCB check_configured_cb; ArchiveFileCB archive_file_cb; ArchiveShutdownCB shutdown_cb; @@ -40,8 +51,8 @@ typedef struct ArchiveModuleCallbacks * Type of the shared library symbol _PG_archive_module_init that is looked * up when loading an archive library. */ -typedef void (*ArchiveModuleInit) (ArchiveModuleCallbacks *cb); +typedef const ArchiveModuleCallbacks *(*ArchiveModuleInit) (void); -extern PGDLLEXPORT void _PG_archive_module_init(ArchiveModuleCallbacks *cb); +extern PGDLLEXPORT const ArchiveModuleCallbacks *_PG_archive_module_init(void); #endif /* _ARCHIVE_MODULE_H */ diff --git a/src/include/postmaster/shell_archive.h b/src/include/postmaster/shell_archive.h index 3cf737ce8e..be83c7715a 100644 --- a/src/include/postmaster/shell_archive.h +++ b/src/include/postmaster/shell_archive.h @@ -19,6 +19,6 @@ * and does not need to be loaded via a shared library, it has a special * initialization function. */ -extern void shell_archive_init(ArchiveModuleCallbacks *cb); +extern const ArchiveModuleCallbacks *shell_archive_init(void); #endif /* _SHELL_ARCHIVE_H */ -- 2.25.1 --4Ckj6UjgE2iN1+kY--