Preserve CurrentMemoryContext across notify and sinval interrupts.

tglsfdc · tglsfdc · commit 1608902fc3a7 · 2024-07-01T12:21:07.000-04:00
ProcessIncomingNotify is called from the main processing loop that normally runs in MessageContext. That outer-loop code assumes that whatever it allocates will be cleaned up when we're done processing the current client message --- but if we service a notify interrupt, then whatever gets allocated before the next switch into MessageContext will be permanently leaked in TopMemoryContext, because CommitTransactionCommand sets CurrentMemoryContext to TopMemoryContext. There are observable leaks associated with (at least) encoding conversion of incoming queries and parameters attached to Bind messages. sinval catchup interrupts have a similar problem. There might be others, but I've not identified any other clear cases. To fix, take care to save and restore CurrentMemoryContext across the Start/CommitTransactionCommand calls in these functions. Per bug #18512 from wizardbrony. Commit to back branches only; in HEAD, this was dealt with by the riskier but more thoroughgoing approach in commit 1afe31f. Discussion: https://postgr.es/m/3478884.1718656625@sss.pgh.pa.us
diff --git a/src/backend/commands/async.c b/src/backend/commands/async.c
@@ -2250,6 +2250,8 @@ asyncQueueAdvanceTail(void)
 static void
 ProcessIncomingNotify(bool flush)
 {
+	MemoryContext oldcontext;
+
 	/* We *must* reset the flag */
 	notifyInterruptPending = false;
 
@@ -2264,14 +2266,21 @@ ProcessIncomingNotify(bool flush)
 
 	/*
 	 * We must run asyncQueueReadAllNotifications inside a transaction, else
-	 * bad things happen if it gets an error.
+	 * bad things happen if it gets an error.  However, we need to preserve
+	 * the caller's memory context (typically MessageContext).
 	 */
+	oldcontext = CurrentMemoryContext;
+
 	StartTransactionCommand();
 
 	asyncQueueReadAllNotifications();
 
 	CommitTransactionCommand();
 
+	/* Caller's context had better not have been transaction-local */
+	Assert(MemoryContextIsValid(oldcontext));
+	MemoryContextSwitchTo(oldcontext);
+
 	/*
 	 * If this isn't an end-of-command case, we must flush the notify messages
 	 * to ensure frontend gets them promptly.
diff --git a/src/backend/storage/ipc/sinval.c b/src/backend/storage/ipc/sinval.c
@@ -17,6 +17,7 @@
 #include "access/xact.h"
 #include "commands/async.h"
 #include "miscadmin.h"
+#include "nodes/memnodes.h"
 #include "storage/ipc.h"
 #include "storage/proc.h"
 #include "storage/sinvaladt.h"
@@ -184,6 +185,7 @@ ProcessCatchupInterrupt(void)
 		 * can just call AcceptInvalidationMessages() to do this.  If we
 		 * aren't, we start and immediately end a transaction; the call to
 		 * AcceptInvalidationMessages() happens down inside transaction start.
+		 * Be sure to preserve caller's memory context when we do that.
 		 *
 		 * It is awfully tempting to just call AcceptInvalidationMessages()
 		 * without the rest of the xact start/stop overhead, and I think that
@@ -197,9 +199,14 @@ ProcessCatchupInterrupt(void)
 		}
 		else
 		{
+			MemoryContext oldcontext = CurrentMemoryContext;
+
 			elog(DEBUG4, "ProcessCatchupEvent outside transaction");
 			StartTransactionCommand();
 			CommitTransactionCommand();
+			/* Caller's context had better not have been transaction-local */
+			Assert(MemoryContextIsValid(oldcontext));
+			MemoryContextSwitchTo(oldcontext);
 		}
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`#include "access/xact.h"`
`18`	`18`	`#include "commands/async.h"`
`19`	`19`	`#include "miscadmin.h"`
	`20`	`+#include "nodes/memnodes.h"`
`20`	`21`	`#include "storage/ipc.h"`
`21`	`22`	`#include "storage/proc.h"`
`22`	`23`	`#include "storage/sinvaladt.h"`
`@@ -184,6 +185,7 @@ ProcessCatchupInterrupt(void)`
`184`	`185`	`* can just call AcceptInvalidationMessages() to do this. If we`
`185`	`186`	`* aren't, we start and immediately end a transaction; the call to`
`186`	`187`	`* AcceptInvalidationMessages() happens down inside transaction start.`
	`188`	`+ * Be sure to preserve caller's memory context when we do that.`
`187`	`189`	`*`
`188`	`190`	`* It is awfully tempting to just call AcceptInvalidationMessages()`
`189`	`191`	`* without the rest of the xact start/stop overhead, and I think that`
`@@ -197,9 +199,14 @@ ProcessCatchupInterrupt(void)`
`197`	`199`	`}`
`198`	`200`	`else`
`199`	`201`	`{`
	`202`	`+ MemoryContext oldcontext = CurrentMemoryContext;`
	`203`	`+`
`200`	`204`	`elog(DEBUG4, "ProcessCatchupEvent outside transaction");`
`201`	`205`	`StartTransactionCommand();`
`202`	`206`	`CommitTransactionCommand();`
	`207`	`+ /* Caller's context had better not have been transaction-local */`
	`208`	`+ Assert(MemoryContextIsValid(oldcontext));`
	`209`	`+ MemoryContextSwitchTo(oldcontext);`
`203`	`210`	`}`
`204`	`211`	`}`
`205`	`212`	`}`