2005-04-20 00:35:18 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
|
|
|
* nodeBitmapIndexscan.c
|
|
|
|
* Routines to support bitmapped index scans of relations
|
|
|
|
*
|
2017-01-03 19:48:53 +01:00
|
|
|
* Portions Copyright (c) 1996-2017, PostgreSQL Global Development Group
|
2005-04-20 00:35:18 +02:00
|
|
|
* Portions Copyright (c) 1994, Regents of the University of California
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* IDENTIFICATION
|
2010-09-20 22:08:53 +02:00
|
|
|
* src/backend/executor/nodeBitmapIndexscan.c
|
2005-04-20 00:35:18 +02:00
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
/*
|
|
|
|
* INTERFACE ROUTINES
|
|
|
|
* MultiExecBitmapIndexScan scans a relation using index.
|
|
|
|
* ExecInitBitmapIndexScan creates and initializes state info.
|
2010-07-12 19:01:06 +02:00
|
|
|
* ExecReScanBitmapIndexScan prepares to rescan the plan.
|
2005-04-20 00:35:18 +02:00
|
|
|
* ExecEndBitmapIndexScan releases all storage.
|
|
|
|
*/
|
|
|
|
#include "postgres.h"
|
|
|
|
|
|
|
|
#include "executor/execdebug.h"
|
|
|
|
#include "executor/nodeBitmapIndexscan.h"
|
2005-04-25 03:30:14 +02:00
|
|
|
#include "executor/nodeIndexscan.h"
|
2005-04-20 00:35:18 +02:00
|
|
|
#include "miscadmin.h"
|
2005-05-06 19:24:55 +02:00
|
|
|
#include "utils/memutils.h"
|
2005-04-20 00:35:18 +02:00
|
|
|
|
|
|
|
|
|
|
|
/* ----------------------------------------------------------------
|
|
|
|
* MultiExecBitmapIndexScan(node)
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
Node *
|
|
|
|
MultiExecBitmapIndexScan(BitmapIndexScanState *node)
|
|
|
|
{
|
|
|
|
TIDBitmap *tbm;
|
|
|
|
IndexScanDesc scandesc;
|
|
|
|
double nTuples = 0;
|
2005-11-25 20:47:50 +01:00
|
|
|
bool doscan;
|
2005-04-20 00:35:18 +02:00
|
|
|
|
|
|
|
/* must provide our own instrumentation support */
|
|
|
|
if (node->ss.ps.instrument)
|
|
|
|
InstrStartNode(node->ss.ps.instrument);
|
|
|
|
|
2005-05-05 05:37:23 +02:00
|
|
|
/*
|
|
|
|
* extract necessary information from index scan node
|
|
|
|
*/
|
|
|
|
scandesc = node->biss_ScanDesc;
|
|
|
|
|
2005-04-20 00:35:18 +02:00
|
|
|
/*
|
2005-10-15 04:49:52 +02:00
|
|
|
* If we have runtime keys and they've not already been set up, do it now.
|
2005-11-25 20:47:50 +01:00
|
|
|
* Array keys are also treated as runtime keys; note that if ExecReScan
|
2006-10-04 02:30:14 +02:00
|
|
|
* returns with biss_RuntimeKeysReady still false, then there is an empty
|
|
|
|
* array key so we should do nothing.
|
2005-04-20 00:35:18 +02:00
|
|
|
*/
|
2005-11-25 20:47:50 +01:00
|
|
|
if (!node->biss_RuntimeKeysReady &&
|
|
|
|
(node->biss_NumRuntimeKeys != 0 || node->biss_NumArrayKeys != 0))
|
|
|
|
{
|
2010-07-12 19:01:06 +02:00
|
|
|
ExecReScan((PlanState *) node);
|
2005-11-25 20:47:50 +01:00
|
|
|
doscan = node->biss_RuntimeKeysReady;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
doscan = true;
|
2005-04-20 00:35:18 +02:00
|
|
|
|
|
|
|
/*
|
2005-04-20 17:48:36 +02:00
|
|
|
* Prepare the result bitmap. Normally we just create a new one to pass
|
2005-10-15 04:49:52 +02:00
|
|
|
* back; however, our parent node is allowed to store a pre-made one into
|
|
|
|
* node->biss_result, in which case we just OR our tuple IDs into the
|
|
|
|
* existing bitmap. (This saves needing explicit UNION steps.)
|
2005-04-20 00:35:18 +02:00
|
|
|
*/
|
2005-04-20 17:48:36 +02:00
|
|
|
if (node->biss_result)
|
|
|
|
{
|
|
|
|
tbm = node->biss_result;
|
Phase 2 of pgindent updates.
Change pg_bsd_indent to follow upstream rules for placement of comments
to the right of code, and remove pgindent hack that caused comments
following #endif to not obey the general rule.
Commit e3860ffa4dd0dad0dd9eea4be9cc1412373a8c89 wasn't actually using
the published version of pg_bsd_indent, but a hacked-up version that
tried to minimize the amount of movement of comments to the right of
code. The situation of interest is where such a comment has to be
moved to the right of its default placement at column 33 because there's
code there. BSD indent has always moved right in units of tab stops
in such cases --- but in the previous incarnation, indent was working
in 8-space tab stops, while now it knows we use 4-space tabs. So the
net result is that in about half the cases, such comments are placed
one tab stop left of before. This is better all around: it leaves
more room on the line for comment text, and it means that in such
cases the comment uniformly starts at the next 4-space tab stop after
the code, rather than sometimes one and sometimes two tabs after.
Also, ensure that comments following #endif are indented the same
as comments following other preprocessor commands such as #else.
That inconsistency turns out to have been self-inflicted damage
from a poorly-thought-through post-indent "fixup" in pgindent.
This patch is much less interesting than the first round of indent
changes, but also bulkier, so I thought it best to separate the effects.
Discussion: https://postgr.es/m/E1dAmxK-0006EE-1r@gemulon.postgresql.org
Discussion: https://postgr.es/m/30527.1495162840@sss.pgh.pa.us
2017-06-21 21:18:54 +02:00
|
|
|
node->biss_result = NULL; /* reset for next time */
|
2005-04-20 17:48:36 +02:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* XXX should we use less than work_mem for this? */
|
Support parallel bitmap heap scans.
The index is scanned by a single process, but then all cooperating
processes can iterate jointly over the resulting set of heap blocks.
In the future, we might also want to support using a parallel bitmap
index scan to set up for a parallel bitmap heap scan, but that's a
job for another day.
Dilip Kumar, with some corrections and cosmetic changes by me. The
larger patch set of which this is a part has been reviewed and tested
by (at least) Andres Freund, Amit Khandekar, Tushar Ahuja, Rafia
Sabih, Haribabu Kommi, Thomas Munro, and me.
Discussion: http://postgr.es/m/CAFiTN-uc4=0WxRGfCzs-xfkMYcSEWUC-Fon6thkJGjkh9i=13A@mail.gmail.com
2017-03-08 18:05:43 +01:00
|
|
|
tbm = tbm_create(work_mem * 1024L,
|
|
|
|
((BitmapIndexScan *) node->ss.ps.plan)->isshared ?
|
|
|
|
node->ss.ps.state->es_query_dsa : NULL);
|
2005-04-20 17:48:36 +02:00
|
|
|
}
|
2005-04-20 00:35:18 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Get TIDs from index and insert into bitmap
|
|
|
|
*/
|
2005-11-25 20:47:50 +01:00
|
|
|
while (doscan)
|
2005-04-20 00:35:18 +02:00
|
|
|
{
|
2008-04-11 00:25:26 +02:00
|
|
|
nTuples += (double) index_getbitmap(scandesc, tbm);
|
2005-04-20 00:35:18 +02:00
|
|
|
|
|
|
|
CHECK_FOR_INTERRUPTS();
|
2005-11-25 20:47:50 +01:00
|
|
|
|
2008-04-11 00:25:26 +02:00
|
|
|
doscan = ExecIndexAdvanceArrayKeys(node->biss_ArrayKeys,
|
|
|
|
node->biss_NumArrayKeys);
|
2009-06-11 16:49:15 +02:00
|
|
|
if (doscan) /* reset index scan */
|
2010-12-03 02:50:48 +01:00
|
|
|
index_rescan(node->biss_ScanDesc,
|
|
|
|
node->biss_ScanKeys, node->biss_NumScanKeys,
|
|
|
|
NULL, 0);
|
2005-04-20 00:35:18 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/* must provide our own instrumentation support */
|
|
|
|
if (node->ss.ps.instrument)
|
2006-05-30 16:01:58 +02:00
|
|
|
InstrStopNode(node->ss.ps.instrument, nTuples);
|
2005-04-20 00:35:18 +02:00
|
|
|
|
|
|
|
return (Node *) tbm;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* ----------------------------------------------------------------
|
2010-07-12 19:01:06 +02:00
|
|
|
* ExecReScanBitmapIndexScan(node)
|
2005-04-20 00:35:18 +02:00
|
|
|
*
|
2010-07-12 19:01:06 +02:00
|
|
|
* Recalculates the values of any scan keys whose value depends on
|
|
|
|
* information known at runtime, then rescans the indexed relation.
|
2005-04-20 00:35:18 +02:00
|
|
|
* ----------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
void
|
2010-07-12 19:01:06 +02:00
|
|
|
ExecReScanBitmapIndexScan(BitmapIndexScanState *node)
|
2005-04-20 00:35:18 +02:00
|
|
|
{
|
2010-07-12 19:01:06 +02:00
|
|
|
ExprContext *econtext = node->biss_RuntimeContext;
|
2005-04-20 00:35:18 +02:00
|
|
|
|
2010-07-12 19:01:06 +02:00
|
|
|
/*
|
|
|
|
* Reset the runtime-key context so we don't leak memory as each outer
|
|
|
|
* tuple is scanned. Note this assumes that we will recalculate *all*
|
|
|
|
* runtime keys on each call.
|
|
|
|
*/
|
2005-04-20 00:35:18 +02:00
|
|
|
if (econtext)
|
|
|
|
ResetExprContext(econtext);
|
|
|
|
|
|
|
|
/*
|
2010-07-12 19:01:06 +02:00
|
|
|
* If we are doing runtime key calculations (ie, any of the index key
|
|
|
|
* values weren't simple Consts), compute the new key values.
|
2005-11-25 20:47:50 +01:00
|
|
|
*
|
2006-10-04 02:30:14 +02:00
|
|
|
* Array keys are also treated as runtime keys; note that if we return
|
|
|
|
* with biss_RuntimeKeysReady still false, then there is an empty array
|
|
|
|
* key so no index scan is needed.
|
2005-04-20 00:35:18 +02:00
|
|
|
*/
|
2005-11-25 20:47:50 +01:00
|
|
|
if (node->biss_NumRuntimeKeys != 0)
|
2005-04-25 03:30:14 +02:00
|
|
|
ExecIndexEvalRuntimeKeys(econtext,
|
2005-11-25 20:47:50 +01:00
|
|
|
node->biss_RuntimeKeys,
|
|
|
|
node->biss_NumRuntimeKeys);
|
|
|
|
if (node->biss_NumArrayKeys != 0)
|
|
|
|
node->biss_RuntimeKeysReady =
|
|
|
|
ExecIndexEvalArrayKeys(econtext,
|
|
|
|
node->biss_ArrayKeys,
|
|
|
|
node->biss_NumArrayKeys);
|
|
|
|
else
|
2005-04-20 00:35:18 +02:00
|
|
|
node->biss_RuntimeKeysReady = true;
|
2005-05-05 05:37:23 +02:00
|
|
|
|
|
|
|
/* reset index scan */
|
2005-11-25 20:47:50 +01:00
|
|
|
if (node->biss_RuntimeKeysReady)
|
2010-12-03 02:50:48 +01:00
|
|
|
index_rescan(node->biss_ScanDesc,
|
|
|
|
node->biss_ScanKeys, node->biss_NumScanKeys,
|
|
|
|
NULL, 0);
|
2005-04-20 00:35:18 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/* ----------------------------------------------------------------
|
|
|
|
* ExecEndBitmapIndexScan
|
|
|
|
* ----------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
void
|
|
|
|
ExecEndBitmapIndexScan(BitmapIndexScanState *node)
|
|
|
|
{
|
2005-05-05 05:37:23 +02:00
|
|
|
Relation indexRelationDesc;
|
|
|
|
IndexScanDesc indexScanDesc;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* extract information from the node
|
|
|
|
*/
|
|
|
|
indexRelationDesc = node->biss_RelationDesc;
|
|
|
|
indexScanDesc = node->biss_ScanDesc;
|
|
|
|
|
2005-04-20 00:35:18 +02:00
|
|
|
/*
|
2005-04-24 19:32:46 +02:00
|
|
|
* Free the exprcontext ... now dead code, see ExecFreeExprContext
|
2005-04-20 00:35:18 +02:00
|
|
|
*/
|
2005-04-23 23:32:34 +02:00
|
|
|
#ifdef NOT_USED
|
2005-04-20 00:35:18 +02:00
|
|
|
if (node->biss_RuntimeContext)
|
2009-07-18 21:15:42 +02:00
|
|
|
FreeExprContext(node->biss_RuntimeContext, true);
|
2005-04-23 23:32:34 +02:00
|
|
|
#endif
|
2005-05-05 05:37:23 +02:00
|
|
|
|
|
|
|
/*
|
2007-05-25 19:54:25 +02:00
|
|
|
* close the index relation (no-op if we didn't open it)
|
2005-05-05 05:37:23 +02:00
|
|
|
*/
|
2007-05-25 19:54:25 +02:00
|
|
|
if (indexScanDesc)
|
|
|
|
index_endscan(indexScanDesc);
|
|
|
|
if (indexRelationDesc)
|
|
|
|
index_close(indexRelationDesc, NoLock);
|
2005-04-20 00:35:18 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/* ----------------------------------------------------------------
|
|
|
|
* ExecInitBitmapIndexScan
|
|
|
|
*
|
2005-04-24 20:16:38 +02:00
|
|
|
* Initializes the index scan's state information.
|
2005-04-20 00:35:18 +02:00
|
|
|
* ----------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
BitmapIndexScanState *
|
2006-02-28 05:10:28 +01:00
|
|
|
ExecInitBitmapIndexScan(BitmapIndexScan *node, EState *estate, int eflags)
|
2005-04-20 00:35:18 +02:00
|
|
|
{
|
|
|
|
BitmapIndexScanState *indexstate;
|
2005-12-03 06:51:03 +01:00
|
|
|
bool relistarget;
|
2005-04-20 00:35:18 +02:00
|
|
|
|
2006-02-28 05:10:28 +01:00
|
|
|
/* check for unsupported flags */
|
|
|
|
Assert(!(eflags & (EXEC_FLAG_BACKWARD | EXEC_FLAG_MARK)));
|
|
|
|
|
2005-04-20 00:35:18 +02:00
|
|
|
/*
|
|
|
|
* create state structure
|
|
|
|
*/
|
|
|
|
indexstate = makeNode(BitmapIndexScanState);
|
|
|
|
indexstate->ss.ps.plan = (Plan *) node;
|
|
|
|
indexstate->ss.ps.state = estate;
|
|
|
|
|
2005-04-20 17:48:36 +02:00
|
|
|
/* normally we don't make the result bitmap till runtime */
|
|
|
|
indexstate->biss_result = NULL;
|
|
|
|
|
2005-04-20 00:35:18 +02:00
|
|
|
/*
|
|
|
|
* Miscellaneous initialization
|
|
|
|
*
|
2005-11-22 19:17:34 +01:00
|
|
|
* We do not need a standard exprcontext for this node, though we may
|
|
|
|
* decide below to create a runtime-key exprcontext
|
2005-04-20 00:35:18 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* initialize child expressions
|
|
|
|
*
|
|
|
|
* We don't need to initialize targetlist or qual since neither are used.
|
|
|
|
*
|
2005-04-25 03:30:14 +02:00
|
|
|
* Note: we don't initialize all of the indexqual expression, only the
|
2005-04-20 00:35:18 +02:00
|
|
|
* sub-parts corresponding to runtime keys (see below).
|
|
|
|
*/
|
|
|
|
|
2006-01-25 21:29:24 +01:00
|
|
|
/*
|
|
|
|
* We do not open or lock the base relation here. We assume that an
|
2006-10-04 02:30:14 +02:00
|
|
|
* ancestor BitmapHeapScan node is holding AccessShareLock (or better) on
|
|
|
|
* the heap relation throughout the execution of the plan tree.
|
2006-01-25 21:29:24 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
indexstate->ss.ss_currentRelation = NULL;
|
|
|
|
indexstate->ss.ss_currentScanDesc = NULL;
|
|
|
|
|
2007-05-25 19:54:25 +02:00
|
|
|
/*
|
2007-11-15 22:14:46 +01:00
|
|
|
* If we are just doing EXPLAIN (ie, aren't going to run the plan), stop
|
|
|
|
* here. This allows an index-advisor plugin to EXPLAIN a plan containing
|
|
|
|
* references to nonexistent indexes.
|
2007-05-25 19:54:25 +02:00
|
|
|
*/
|
|
|
|
if (eflags & EXEC_FLAG_EXPLAIN_ONLY)
|
|
|
|
return indexstate;
|
|
|
|
|
2006-01-25 21:29:24 +01:00
|
|
|
/*
|
|
|
|
* Open the index relation.
|
2006-07-31 22:09:10 +02:00
|
|
|
*
|
|
|
|
* If the parent table is one of the target relations of the query, then
|
|
|
|
* InitPlan already opened and write-locked the index, so we can avoid
|
|
|
|
* taking another lock here. Otherwise we need a normal reader's lock.
|
2006-01-25 21:29:24 +01:00
|
|
|
*/
|
2006-07-31 22:09:10 +02:00
|
|
|
relistarget = ExecRelationIsTargetRelation(estate, node->scan.scanrelid);
|
|
|
|
indexstate->biss_RelationDesc = index_open(node->indexid,
|
Phase 3 of pgindent updates.
Don't move parenthesized lines to the left, even if that means they
flow past the right margin.
By default, BSD indent lines up statement continuation lines that are
within parentheses so that they start just to the right of the preceding
left parenthesis. However, traditionally, if that resulted in the
continuation line extending to the right of the desired right margin,
then indent would push it left just far enough to not overrun the margin,
if it could do so without making the continuation line start to the left of
the current statement indent. That makes for a weird mix of indentations
unless one has been completely rigid about never violating the 80-column
limit.
This behavior has been pretty universally panned by Postgres developers.
Hence, disable it with indent's new -lpl switch, so that parenthesized
lines are always lined up with the preceding left paren.
This patch is much less interesting than the first round of indent
changes, but also bulkier, so I thought it best to separate the effects.
Discussion: https://postgr.es/m/E1dAmxK-0006EE-1r@gemulon.postgresql.org
Discussion: https://postgr.es/m/30527.1495162840@sss.pgh.pa.us
2017-06-21 21:35:54 +02:00
|
|
|
relistarget ? NoLock : AccessShareLock);
|
2006-01-25 21:29:24 +01:00
|
|
|
|
2005-04-20 00:35:18 +02:00
|
|
|
/*
|
|
|
|
* Initialize index-specific scan state
|
|
|
|
*/
|
|
|
|
indexstate->biss_RuntimeKeysReady = false;
|
2010-12-03 02:50:48 +01:00
|
|
|
indexstate->biss_RuntimeKeys = NULL;
|
|
|
|
indexstate->biss_NumRuntimeKeys = 0;
|
2005-04-20 00:35:18 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* build the index scan keys from the index qualification
|
|
|
|
*/
|
2005-11-25 20:47:50 +01:00
|
|
|
ExecIndexBuildScanKeys((PlanState *) indexstate,
|
2006-01-25 21:29:24 +01:00
|
|
|
indexstate->biss_RelationDesc,
|
2005-11-25 20:47:50 +01:00
|
|
|
node->indexqual,
|
2010-12-03 02:50:48 +01:00
|
|
|
false,
|
2005-11-25 20:47:50 +01:00
|
|
|
&indexstate->biss_ScanKeys,
|
|
|
|
&indexstate->biss_NumScanKeys,
|
|
|
|
&indexstate->biss_RuntimeKeys,
|
|
|
|
&indexstate->biss_NumRuntimeKeys,
|
|
|
|
&indexstate->biss_ArrayKeys,
|
|
|
|
&indexstate->biss_NumArrayKeys);
|
2005-04-20 00:35:18 +02:00
|
|
|
|
|
|
|
/*
|
2005-11-25 20:47:50 +01:00
|
|
|
* If we have runtime keys or array keys, we need an ExprContext to
|
|
|
|
* evaluate them. We could just create a "standard" plan node exprcontext,
|
|
|
|
* but to keep the code looking similar to nodeIndexscan.c, it seems
|
|
|
|
* better to stick with the approach of using a separate ExprContext.
|
2005-04-20 00:35:18 +02:00
|
|
|
*/
|
2005-11-25 20:47:50 +01:00
|
|
|
if (indexstate->biss_NumRuntimeKeys != 0 ||
|
|
|
|
indexstate->biss_NumArrayKeys != 0)
|
2005-04-20 00:35:18 +02:00
|
|
|
{
|
|
|
|
ExprContext *stdecontext = indexstate->ss.ps.ps_ExprContext;
|
|
|
|
|
|
|
|
ExecAssignExprContext(estate, &indexstate->ss.ps);
|
|
|
|
indexstate->biss_RuntimeContext = indexstate->ss.ps.ps_ExprContext;
|
|
|
|
indexstate->ss.ps.ps_ExprContext = stdecontext;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
indexstate->biss_RuntimeContext = NULL;
|
|
|
|
}
|
|
|
|
|
2005-05-05 05:37:23 +02:00
|
|
|
/*
|
2006-01-25 21:29:24 +01:00
|
|
|
* Initialize scan descriptor.
|
2005-05-05 05:37:23 +02:00
|
|
|
*/
|
|
|
|
indexstate->biss_ScanDesc =
|
2008-04-11 00:25:26 +02:00
|
|
|
index_beginscan_bitmap(indexstate->biss_RelationDesc,
|
|
|
|
estate->es_snapshot,
|
2010-12-03 02:50:48 +01:00
|
|
|
indexstate->biss_NumScanKeys);
|
|
|
|
|
|
|
|
/*
|
2011-04-10 17:42:00 +02:00
|
|
|
* If no run-time keys to calculate, go ahead and pass the scankeys to the
|
|
|
|
* index AM.
|
2010-12-03 02:50:48 +01:00
|
|
|
*/
|
|
|
|
if (indexstate->biss_NumRuntimeKeys == 0 &&
|
|
|
|
indexstate->biss_NumArrayKeys == 0)
|
|
|
|
index_rescan(indexstate->biss_ScanDesc,
|
|
|
|
indexstate->biss_ScanKeys, indexstate->biss_NumScanKeys,
|
|
|
|
NULL, 0);
|
2005-05-05 05:37:23 +02:00
|
|
|
|
2005-04-20 00:35:18 +02:00
|
|
|
/*
|
|
|
|
* all done.
|
|
|
|
*/
|
|
|
|
return indexstate;
|
|
|
|
}
|