Fix access-to-already-freed-memory issue in pgoutput.

While pgoutput caches relation synchronization information in
RelationSyncCache that resides in CacheMemoryContext, each entry's
information (such as row filter expressions and column lists) is
stored in the entry's private memory context (entry_cxt in
RelationSyncEntry), which is a descendant memory context of the
decoding context. If a logical decoding invoked via SQL functions like
pg_logical_slot_get_binary_changes fails with an error, subsequent
logical decoding executions could access already-freed memory of the
entry's cache, resulting in a crash.

With this change, it's ensured that RelationSyncCache is cleaned up
even in error cases by using a memory context reset callback function.

Backpatch to 15, where entry_cxt was introduced for column filtering
and row filtering.

While the backbranches v13 and v14 have a similar issue where
RelationSyncCache persists even after an error when pgoutput is used
via SQL API, we decided not to backport this fix. This decision was
made because v13 is approaching its final minor release, and we won't
have an chance to fix any new issues that might arise. Additionally,
since using pgoutput via SQL API is not a common use case, the risk
outwights the benefit. If we receive bug reports, we can consider
backporting the fixes then.

Author: vignesh C <vignesh21@gmail.com>
Co-authored-by: Masahiko Sawada <sawada.mshk@gmail.com>
Reviewed-by: Zhijie Hou <houzj.fnst@fujitsu.com>
Reviewed-by: Euler Taveira <euler@eulerto.com>
Discussion: https://postgr.es/m/CALDaNm0x-aCehgt8Bevs2cm=uhmwS28MvbYq1=s2Ekf0aDPkOA@mail.gmail.com
Backpatch-through: 15

diff --git a/src/backend/replication/pgoutput/pgoutput.c b/src/backend/replication/pgoutput/pgoutput.c
index 92eb17049c3ce7203713d17b8c9f30041c1c5cb5..847806b0a2e919fc68fd797647a8f370b547871c 100644 (file)
--- a/src/backend/replication/pgoutput/pgoutput.c
+++ b/src/backend/replication/pgoutput/pgoutput.c
@@ -235,6 +235,7 @@ static bool get_schema_sent_in_streamed_txn(RelationSyncEntry *entry,
                                            TransactionId xid);
 static void init_tuple_slot(PGOutputData *data, Relation relation,
                            RelationSyncEntry *entry);
+static void pgoutput_memory_context_reset(void *arg);
 
 /* row filter routines */
 static EState *create_estate_for_relation(Relation rel);
@@ -426,6 +427,19 @@ parse_output_parameters(List *options, PGOutputData *data)
                errmsg("option \"%s\" missing", "publication_names"));
 }
 
+/*
+ * Memory context reset callback of PGOutputData->context.
+ */
+static void
+pgoutput_memory_context_reset(void *arg)
+{
+   if (RelationSyncCache)
+   {
+       hash_destroy(RelationSyncCache);
+       RelationSyncCache = NULL;
+   }
+}
+
 /*
  * Initialize this plugin
  */
@@ -435,6 +449,7 @@ pgoutput_startup(LogicalDecodingContext *ctx, OutputPluginOptions *opt,
 {
    PGOutputData *data = palloc0(sizeof(PGOutputData));
    static bool publication_callback_registered = false;
+   MemoryContextCallback *mcallback;
 
    /* Create our memory context for private allocations. */
    data->context = AllocSetContextCreate(ctx->context,
@@ -449,6 +464,14 @@ pgoutput_startup(LogicalDecodingContext *ctx, OutputPluginOptions *opt,
                                         "logical replication publication list context",
                                         ALLOCSET_SMALL_SIZES);
 
+   /*
+    * Ensure to cleanup RelationSyncCache even when logical decoding invoked
+    * via SQL interface ends up with an error.
+    */
+   mcallback = palloc0(sizeof(MemoryContextCallback));
+   mcallback->func = pgoutput_memory_context_reset;
+   MemoryContextRegisterResetCallback(ctx->context, mcallback);
+
    ctx->output_plugin_private = data;
 
    /* This plugin uses binary protocol. */
@@ -1760,11 +1783,7 @@ pgoutput_origin_filter(LogicalDecodingContext *ctx,
 static void
 pgoutput_shutdown(LogicalDecodingContext *ctx)
 {
-   if (RelationSyncCache)
-   {
-       hash_destroy(RelationSyncCache);
-       RelationSyncCache = NULL;
-   }
+   pgoutput_memory_context_reset(NULL);
 }
 
 /*