Skip to content

Commit 0f7c49e

Browse files
peterepetere
committed
Update portal-related memory context names and API
Rename PortalMemory to TopPortalContext, to avoid confusion with PortalContext and align naming with similar top-level memory contexts. Rename PortalData's "heap" field to portalContext. The "heap" naming seems quite antiquated and confusing. Also get rid of the PortalGetHeapMemory() macro and access the field directly, which we do for other portal fields, so this abstraction doesn't buy anything. Reviewed-by: Andrew Dunstan <andrew.dunstan@2ndquadrant.com> Reviewed-by: Alvaro Herrera <alvherre@alvh.no-ip.org>
1 parent 3cb1b2a commit 0f7c49e

File tree

7 files changed

+35
-36
lines changed

7 files changed

+35
-36
lines changed

‎src/backend/commands/portalcmds.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ PerformCursorOpen(DeclareCursorStmt *cstmt, ParamListInfo params,
9696
*/
9797
portal = CreatePortal(cstmt->portalname, false, false);
9898

99-
oldContext = MemoryContextSwitchTo(PortalGetHeapMemory(portal));
99+
oldContext = MemoryContextSwitchTo(portal->portalContext);
100100

101101
plan = copyObject(plan);
102102

@@ -363,7 +363,7 @@ PersistHoldablePortal(Portal portal)
363363
ActivePortal = portal;
364364
if (portal->resowner)
365365
CurrentResourceOwner = portal->resowner;
366-
PortalContext = PortalGetHeapMemory(portal);
366+
PortalContext = portal->portalContext;
367367

368368
MemoryContextSwitchTo(PortalContext);
369369

@@ -450,10 +450,10 @@ PersistHoldablePortal(Portal portal)
450450
PopActiveSnapshot();
451451

452452
/*
453-
* We can now release any subsidiary memory of the portal's heap context;
453+
* We can now release any subsidiary memory of the portal's context;
454454
* we'll never use it again. The executor already dropped its context,
455-
* but this will clean up anything that glommed onto the portal's heap via
455+
* but this will clean up anything that glommed onto the portal's context via
456456
* PortalContext.
457457
*/
458-
MemoryContextDeleteChildren(PortalGetHeapMemory(portal));
458+
MemoryContextDeleteChildren(portal->portalContext);
459459
}

‎src/backend/commands/prepare.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ ExecuteQuery(ExecuteStmt *stmt, IntoClause *intoClause,
239239
portal->visible = false;
240240

241241
/* Copy the plan's saved query string into the portal's memory */
242-
query_string = MemoryContextStrdup(PortalGetHeapMemory(portal),
242+
query_string = MemoryContextStrdup(portal->portalContext,
243243
entry->plansource->query_string);
244244

245245
/* Replan if needed, and increment plan refcount for portal */

‎src/backend/executor/spi.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,7 +1183,7 @@ SPI_cursor_open_internal(const char *name, SPIPlanPtr plan,
11831183
}
11841184

11851185
/* Copy the plan's query string into the portal */
1186-
query_string = MemoryContextStrdup(PortalGetHeapMemory(portal),
1186+
query_string = MemoryContextStrdup(portal->portalContext,
11871187
plansource->query_string);
11881188

11891189
/*
@@ -1213,7 +1213,7 @@ SPI_cursor_open_internal(const char *name, SPIPlanPtr plan,
12131213
* will result in leaking our refcount on the plan, but it doesn't
12141214
* matter because the plan is unsaved and hence transient anyway.
12151215
*/
1216-
oldcontext = MemoryContextSwitchTo(PortalGetHeapMemory(portal));
1216+
oldcontext = MemoryContextSwitchTo(portal->portalContext);
12171217
stmt_list = copyObject(stmt_list);
12181218
MemoryContextSwitchTo(oldcontext);
12191219
ReleaseCachedPlan(cplan, false);
@@ -1311,7 +1311,7 @@ SPI_cursor_open_internal(const char *name, SPIPlanPtr plan,
13111311
*/
13121312
if (paramLI)
13131313
{
1314-
oldcontext = MemoryContextSwitchTo(PortalGetHeapMemory(portal));
1314+
oldcontext = MemoryContextSwitchTo(portal->portalContext);
13151315
paramLI = copyParamList(paramLI);
13161316
MemoryContextSwitchTo(oldcontext);
13171317
}

‎src/backend/tcop/postgres.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1608,7 +1608,7 @@ exec_bind_message(StringInfo input_message)
16081608
* don't want a failure to occur between GetCachedPlan and
16091609
* PortalDefineQuery; that would result in leaking our plancache refcount.
16101610
*/
1611-
oldContext = MemoryContextSwitchTo(PortalGetHeapMemory(portal));
1611+
oldContext = MemoryContextSwitchTo(portal->portalContext);
16121612

16131613
/* Copy the plan's query string into the portal */
16141614
query_string = pstrdup(psrc->query_string);

‎src/backend/tcop/pquery.c

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -466,9 +466,9 @@ PortalStart(Portal portal, ParamListInfo params,
466466
ActivePortal = portal;
467467
if (portal->resowner)
468468
CurrentResourceOwner = portal->resowner;
469-
PortalContext = PortalGetHeapMemory(portal);
469+
PortalContext = portal->portalContext;
470470

471-
oldContext = MemoryContextSwitchTo(PortalGetHeapMemory(portal));
471+
oldContext = MemoryContextSwitchTo(PortalContext);
472472

473473
/* Must remember portal param list, if any */
474474
portal->portalParams = params;
@@ -634,7 +634,7 @@ PortalSetResultFormat(Portal portal, int nFormats, int16 *formats)
634634
return;
635635
natts = portal->tupDesc->natts;
636636
portal->formats = (int16 *)
637-
MemoryContextAlloc(PortalGetHeapMemory(portal),
637+
MemoryContextAlloc(portal->portalContext,
638638
natts * sizeof(int16));
639639
if (nFormats > 1)
640640
{
@@ -748,7 +748,7 @@ PortalRun(Portal portal, long count, bool isTopLevel, bool run_once,
748748
ActivePortal = portal;
749749
if (portal->resowner)
750750
CurrentResourceOwner = portal->resowner;
751-
PortalContext = PortalGetHeapMemory(portal);
751+
PortalContext = portal->portalContext;
752752

753753
MemoryContextSwitchTo(PortalContext);
754754

@@ -1184,7 +1184,7 @@ PortalRunUtility(Portal portal, PlannedStmt *pstmt,
11841184
completionTag);
11851185

11861186
/* Some utility statements may change context on us */
1187-
MemoryContextSwitchTo(PortalGetHeapMemory(portal));
1187+
MemoryContextSwitchTo(portal->portalContext);
11881188

11891189
/*
11901190
* Some utility commands may pop the ActiveSnapshot stack from under us,
@@ -1343,9 +1343,9 @@ PortalRunMulti(Portal portal,
13431343
/*
13441344
* Clear subsidiary contexts to recover temporary memory.
13451345
*/
1346-
Assert(PortalGetHeapMemory(portal) == CurrentMemoryContext);
1346+
Assert(portal->portalContext == CurrentMemoryContext);
13471347

1348-
MemoryContextDeleteChildren(PortalGetHeapMemory(portal));
1348+
MemoryContextDeleteChildren(portal->portalContext);
13491349
}
13501350

13511351
/* Pop the snapshot if we pushed one. */
@@ -1424,7 +1424,7 @@ PortalRunFetch(Portal portal,
14241424
ActivePortal = portal;
14251425
if (portal->resowner)
14261426
CurrentResourceOwner = portal->resowner;
1427-
PortalContext = PortalGetHeapMemory(portal);
1427+
PortalContext = portal->portalContext;
14281428

14291429
oldContext = MemoryContextSwitchTo(PortalContext);
14301430

‎src/backend/utils/mmgr/portalmem.c

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ do { \
8787
elog(WARNING, "trying to delete portal name that does not exist"); \
8888
} while(0)
8989

90-
static MemoryContext PortalMemory = NULL;
90+
static MemoryContext TopPortalContext = NULL;
9191

9292

9393
/* ----------------------------------------------------------------
@@ -104,10 +104,10 @@ EnablePortalManager(void)
104104
{
105105
HASHCTL ctl;
106106

107-
Assert(PortalMemory == NULL);
107+
Assert(TopPortalContext == NULL);
108108

109-
PortalMemory = AllocSetContextCreate(TopMemoryContext,
110-
"PortalMemory",
109+
TopPortalContext = AllocSetContextCreate(TopMemoryContext,
110+
"TopPortalContext",
111111
ALLOCSET_DEFAULT_SIZES);
112112

113113
ctl.keysize = MAX_PORTALNAME_LEN;
@@ -193,12 +193,12 @@ CreatePortal(const char *name, bool allowDup, bool dupSilent)
193193
}
194194

195195
/* make new portal structure */
196-
portal = (Portal) MemoryContextAllocZero(PortalMemory, sizeof *portal);
196+
portal = (Portal) MemoryContextAllocZero(TopPortalContext, sizeof *portal);
197197

198-
/* initialize portal heap context; typically it won't store much */
199-
portal->heap = AllocSetContextCreate(PortalMemory,
200-
"PortalHeapMemory",
201-
ALLOCSET_SMALL_SIZES);
198+
/* initialize portal context; typically it won't store much */
199+
portal->portalContext = AllocSetContextCreate(TopPortalContext,
200+
"PortalContext",
201+
ALLOCSET_SMALL_SIZES);
202202

203203
/* create a resource owner for the portal */
204204
portal->resowner = ResourceOwnerCreate(CurTransactionResourceOwner,
@@ -263,7 +263,7 @@ CreateNewPortal(void)
263263
*
264264
* If cplan is NULL, then it is the caller's responsibility to ensure that
265265
* the passed plan trees have adequate lifetime. Typically this is done by
266-
* copying them into the portal's heap context.
266+
* copying them into the portal's context.
267267
*
268268
* The caller is also responsible for ensuring that the passed prepStmtName
269269
* (if not NULL) and sourceText have adequate lifetime.
@@ -331,10 +331,10 @@ PortalCreateHoldStore(Portal portal)
331331

332332
/*
333333
* Create the memory context that is used for storage of the tuple set.
334-
* Note this is NOT a child of the portal's heap memory.
334+
* Note this is NOT a child of the portal's portalContext.
335335
*/
336336
portal->holdContext =
337-
AllocSetContextCreate(PortalMemory,
337+
AllocSetContextCreate(TopPortalContext,
338338
"PortalHoldContext",
339339
ALLOCSET_DEFAULT_SIZES);
340340

@@ -576,9 +576,9 @@ PortalDrop(Portal portal, bool isTopCommit)
576576
MemoryContextDelete(portal->holdContext);
577577

578578
/* release subsidiary storage */
579-
MemoryContextDelete(PortalGetHeapMemory(portal));
579+
MemoryContextDelete(portal->portalContext);
580580

581-
/* release portal struct (it's in PortalMemory) */
581+
/* release portal struct (it's in TopPortalContext) */
582582
pfree(portal);
583583
}
584584

@@ -806,7 +806,7 @@ AtAbort_Portals(void)
806806
* The cleanup hook was the last thing that might have needed data
807807
* there.
808808
*/
809-
MemoryContextDeleteChildren(PortalGetHeapMemory(portal));
809+
MemoryContextDeleteChildren(portal->portalContext);
810810
}
811811
}
812812

@@ -1000,7 +1000,7 @@ AtSubAbort_Portals(SubTransactionId mySubid,
10001000
* The cleanup hook was the last thing that might have needed data
10011001
* there.
10021002
*/
1003-
MemoryContextDeleteChildren(PortalGetHeapMemory(portal));
1003+
MemoryContextDeleteChildren(portal->portalContext);
10041004
}
10051005
}
10061006

‎src/include/utils/portal.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ typedef struct PortalData
116116
/* Bookkeeping data */
117117
const char *name; /* portal's name */
118118
const char *prepStmtName; /* source prepared statement (NULL if none) */
119-
MemoryContext heap; /* subsidiary memory for portal */
119+
MemoryContext portalContext;/* subsidiary memory for portal */
120120
ResourceOwner resowner; /* resources owned by portal */
121121
void (*cleanup) (Portal portal); /* cleanup hook */
122122

@@ -202,7 +202,6 @@ typedef struct PortalData
202202
* Access macros for Portal ... use these in preference to field access.
203203
*/
204204
#define PortalGetQueryDesc(portal) ((portal)->queryDesc)
205-
#define PortalGetHeapMemory(portal) ((portal)->heap)
206205

207206

208207
/* Prototypes for functions in utils/mmgr/portalmem.c */

0 commit comments

Comments
 (0)