From 9e3a7f50e45315355a2a04fcf4cd7dc01f0a6840 Mon Sep 17 00:00:00 2001 From: Heikki Linnakangas Date: Mon, 5 Jul 2010 09:27:36 +0000 Subject: [PATCH] The previous fix in CVS HEAD and 8.4 for handling the case where a cursor being used in a PL/pgSQL FOR loop is closed was inadequate, as Tom Lane pointed out. The bug affects FOR statement variants too, because you can close an implicitly created cursor too by guessing the "" name created for it. To fix that, "pin" the portal to prevent it from being dropped while it's being used in a PL/pgSQL FOR loop. Backpatch all the way to 7.4 which is the oldest supported version. --- src/backend/utils/mmgr/portalmem.c | 54 +++++++++++++++++++++++++++--- src/include/utils/portal.h | 5 ++- src/pl/plpgsql/src/pl_exec.c | 16 +++++++-- 3 files changed, 67 insertions(+), 8 deletions(-) diff --git a/src/backend/utils/mmgr/portalmem.c b/src/backend/utils/mmgr/portalmem.c index 57ff508a91..be9cb3a52a 100644 --- a/src/backend/utils/mmgr/portalmem.c +++ b/src/backend/utils/mmgr/portalmem.c @@ -12,7 +12,7 @@ * Portions Copyright (c) 1994, Regents of the University of California * * IDENTIFICATION - * $PostgreSQL: pgsql/src/backend/utils/mmgr/portalmem.c,v 1.97.2.2 2009/12/29 17:41:25 heikki Exp $ + * $PostgreSQL: pgsql/src/backend/utils/mmgr/portalmem.c,v 1.97.2.3 2010/07/05 09:27:36 heikki Exp $ * *------------------------------------------------------------------------- */ @@ -319,6 +319,28 @@ PortalCreateHoldStore(Portal portal) MemoryContextSwitchTo(oldcxt); } +/* + * PinPortal + * Protect a portal from dropping. + */ +void +PinPortal(Portal portal) +{ + if (portal->portalPinned) + elog(ERROR, "portal already pinned"); + + portal->portalPinned = true; +} + +void +UnpinPortal(Portal portal) +{ + if (!portal->portalPinned) + elog(ERROR, "portal not pinned"); + + portal->portalPinned = false; +} + /* * PortalDrop * Destroy the portal. @@ -328,9 +350,16 @@ PortalDrop(Portal portal, bool isTopCommit) { AssertArg(PortalIsValid(portal)); - /* Not sure if this case can validly happen or not... */ - if (portal->status == PORTAL_ACTIVE) - elog(ERROR, "cannot drop active portal"); + /* + * Don't allow dropping a pinned portal, it's still needed by whoever + * pinned it. Not sure if the PORTAL_ACTIVE case can validly happen or + * not... + */ + if (portal->portalPinned || + portal->status == PORTAL_ACTIVE) + ereport(ERROR, + (errcode(ERRCODE_INVALID_CURSOR_STATE), + errmsg("cannot drop active portal \"%s\"", portal->name))); /* * Remove portal from hash table. Because we do this first, we will not @@ -566,6 +595,13 @@ AtCommit_Portals(void) continue; } + /* + * There should be no pinned portals anymore. Complain if someone + * leaked one. + */ + if (portal->portalPinned) + elog(ERROR, "cannot commit while a portal is pinned"); + /* * Do nothing to cursors held over from a previous transaction * (including holdable ones just frozen by CommitHoldablePortals). @@ -661,7 +697,15 @@ AtCleanup_Portals(void) continue; } - /* Else zap it. */ + /* + * If a portal is still pinned, forcibly unpin it. PortalDrop will + * not let us drop the portal otherwise. Whoever pinned the portal + * was interrupted by the abort too and won't try to use it anymore. + */ + if (portal->portalPinned) + portal->portalPinned = false; + + /* Zap it. */ PortalDrop(portal, false); } } diff --git a/src/include/utils/portal.h b/src/include/utils/portal.h index 3a4e9f4e47..30d4382972 100644 --- a/src/include/utils/portal.h +++ b/src/include/utils/portal.h @@ -39,7 +39,7 @@ * Portions Copyright (c) 1996-2006, PostgreSQL Global Development Group * Portions Copyright (c) 1994, Regents of the University of California * - * $PostgreSQL: pgsql/src/include/utils/portal.h,v 1.71 2006/10/04 00:30:10 momjian Exp $ + * $PostgreSQL: pgsql/src/include/utils/portal.h,v 1.71.2.1 2010/07/05 09:27:36 heikki Exp $ * *------------------------------------------------------------------------- */ @@ -144,6 +144,7 @@ typedef struct PortalData /* Status data */ PortalStatus status; /* see above */ + bool portalPinned; /* a pinned portal can't be dropped */ /* If not NULL, Executor is active; call ExecutorEnd eventually: */ QueryDesc *queryDesc; /* info needed for executor invocation */ @@ -210,6 +211,8 @@ extern void AtSubAbort_Portals(SubTransactionId mySubid, extern void AtSubCleanup_Portals(SubTransactionId mySubid); extern Portal CreatePortal(const char *name, bool allowDup, bool dupSilent); extern Portal CreateNewPortal(void); +extern void PinPortal(Portal portal); +extern void UnpinPortal(Portal portal); extern void PortalDrop(Portal portal, bool isTopCommit); extern void DropDependentPortals(MemoryContext queryContext); extern Portal GetPortalByName(const char *name); diff --git a/src/pl/plpgsql/src/pl_exec.c b/src/pl/plpgsql/src/pl_exec.c index 560639a87d..2c732e3295 100644 --- a/src/pl/plpgsql/src/pl_exec.c +++ b/src/pl/plpgsql/src/pl_exec.c @@ -8,7 +8,7 @@ * * * IDENTIFICATION - * $PostgreSQL: pgsql/src/pl/plpgsql/src/pl_exec.c,v 1.180.2.12 2010/02/12 19:38:00 tgl Exp $ + * $PostgreSQL: pgsql/src/pl/plpgsql/src/pl_exec.c,v 1.180.2.13 2010/07/05 09:27:36 heikki Exp $ * *------------------------------------------------------------------------- */ @@ -1661,9 +1661,11 @@ exec_stmt_fors(PLpgSQL_execstate *estate, PLpgSQL_stmt_fors *stmt) /* * Open the implicit cursor for the statement and fetch the initial 10 - * rows. + * rows. Pin the portal to make sure it doesn't get closed by the user + * statements we execute. */ exec_run_select(estate, stmt->query, 0, &portal); + PinPortal(portal); SPI_cursor_fetch(portal, true, 10); tuptab = SPI_tuptable; @@ -1745,6 +1747,7 @@ exec_stmt_fors(PLpgSQL_execstate *estate, PLpgSQL_stmt_fors *stmt) * code should match the code after the loop.) */ SPI_freetuptable(tuptab); + UnpinPortal(portal); SPI_cursor_close(portal); exec_set_found(estate, found); @@ -1770,6 +1773,7 @@ exec_stmt_fors(PLpgSQL_execstate *estate, PLpgSQL_stmt_fors *stmt) /* * Close the implicit cursor */ + UnpinPortal(portal); SPI_cursor_close(portal); /* @@ -2777,6 +2781,12 @@ exec_stmt_dynfors(PLpgSQL_execstate *estate, PLpgSQL_stmt_dynfors *stmt) pfree(querystr); SPI_freeplan(plan); + /* + * Make sure the portal doesn't get closed by the user statements + * we execute. + */ + PinPortal(portal); + /* * Fetch the initial 10 tuples */ @@ -2860,6 +2870,7 @@ exec_stmt_dynfors(PLpgSQL_execstate *estate, PLpgSQL_stmt_dynfors *stmt) * code should match the code after the loop.) */ SPI_freetuptable(tuptab); + UnpinPortal(portal); SPI_cursor_close(portal); exec_set_found(estate, found); @@ -2885,6 +2896,7 @@ exec_stmt_dynfors(PLpgSQL_execstate *estate, PLpgSQL_stmt_dynfors *stmt) /* * Close the implicit cursor */ + UnpinPortal(portal); SPI_cursor_close(portal); /*