]> granicus.if.org Git - postgresql/blob - src/backend/executor/nodeSubplan.c
Unbreak Finalize HashAggregate over Partial HashAggregate.
[postgresql] / src / backend / executor / nodeSubplan.c
1 /*-------------------------------------------------------------------------
2  *
3  * nodeSubplan.c
4  *        routines to support sub-selects appearing in expressions
5  *
6  * This module is concerned with executing SubPlan expression nodes, which
7  * should not be confused with sub-SELECTs appearing in FROM.  SubPlans are
8  * divided into "initplans", which are those that need only one evaluation per
9  * query (among other restrictions, this requires that they don't use any
10  * direct correlation variables from the parent plan level), and "regular"
11  * subplans, which are re-evaluated every time their result is required.
12  *
13  *
14  * Portions Copyright (c) 1996-2016, PostgreSQL Global Development Group
15  * Portions Copyright (c) 1994, Regents of the University of California
16  *
17  * IDENTIFICATION
18  *        src/backend/executor/nodeSubplan.c
19  *
20  *-------------------------------------------------------------------------
21  */
22 /*
23  *       INTERFACE ROUTINES
24  *              ExecSubPlan  - process a subselect
25  *              ExecInitSubPlan - initialize a subselect
26  */
27 #include "postgres.h"
28
29 #include <limits.h>
30 #include <math.h>
31
32 #include "access/htup_details.h"
33 #include "executor/executor.h"
34 #include "executor/nodeSubplan.h"
35 #include "nodes/makefuncs.h"
36 #include "optimizer/clauses.h"
37 #include "utils/array.h"
38 #include "utils/lsyscache.h"
39 #include "utils/memutils.h"
40
41
42 static Datum ExecSubPlan(SubPlanState *node,
43                         ExprContext *econtext,
44                         bool *isNull,
45                         ExprDoneCond *isDone);
46 static Datum ExecAlternativeSubPlan(AlternativeSubPlanState *node,
47                                            ExprContext *econtext,
48                                            bool *isNull,
49                                            ExprDoneCond *isDone);
50 static Datum ExecHashSubPlan(SubPlanState *node,
51                                 ExprContext *econtext,
52                                 bool *isNull);
53 static Datum ExecScanSubPlan(SubPlanState *node,
54                                 ExprContext *econtext,
55                                 bool *isNull);
56 static void buildSubPlanHash(SubPlanState *node, ExprContext *econtext);
57 static bool findPartialMatch(TupleHashTable hashtable, TupleTableSlot *slot,
58                                  FmgrInfo *eqfunctions);
59 static bool slotAllNulls(TupleTableSlot *slot);
60 static bool slotNoNulls(TupleTableSlot *slot);
61
62
63 /* ----------------------------------------------------------------
64  *              ExecSubPlan
65  *
66  * This is the main entry point for execution of a regular SubPlan.
67  * ----------------------------------------------------------------
68  */
69 static Datum
70 ExecSubPlan(SubPlanState *node,
71                         ExprContext *econtext,
72                         bool *isNull,
73                         ExprDoneCond *isDone)
74 {
75         SubPlan    *subplan = (SubPlan *) node->xprstate.expr;
76
77         /* Set default values for result flags: non-null, not a set result */
78         *isNull = false;
79         if (isDone)
80                 *isDone = ExprSingleResult;
81
82         /* Sanity checks */
83         if (subplan->subLinkType == CTE_SUBLINK)
84                 elog(ERROR, "CTE subplans should not be executed via ExecSubPlan");
85         if (subplan->setParam != NIL && subplan->subLinkType != MULTIEXPR_SUBLINK)
86                 elog(ERROR, "cannot set parent params from subquery");
87
88         /* Select appropriate evaluation strategy */
89         if (subplan->useHashTable)
90                 return ExecHashSubPlan(node, econtext, isNull);
91         else
92                 return ExecScanSubPlan(node, econtext, isNull);
93 }
94
95 /*
96  * ExecHashSubPlan: store subselect result in an in-memory hash table
97  */
98 static Datum
99 ExecHashSubPlan(SubPlanState *node,
100                                 ExprContext *econtext,
101                                 bool *isNull)
102 {
103         SubPlan    *subplan = (SubPlan *) node->xprstate.expr;
104         PlanState  *planstate = node->planstate;
105         TupleTableSlot *slot;
106
107         /* Shouldn't have any direct correlation Vars */
108         if (subplan->parParam != NIL || node->args != NIL)
109                 elog(ERROR, "hashed subplan with direct correlation not supported");
110
111         /*
112          * If first time through or we need to rescan the subplan, build the hash
113          * table.
114          */
115         if (node->hashtable == NULL || planstate->chgParam != NULL)
116                 buildSubPlanHash(node, econtext);
117
118         /*
119          * The result for an empty subplan is always FALSE; no need to evaluate
120          * lefthand side.
121          */
122         *isNull = false;
123         if (!node->havehashrows && !node->havenullrows)
124                 return BoolGetDatum(false);
125
126         /*
127          * Evaluate lefthand expressions and form a projection tuple. First we
128          * have to set the econtext to use (hack alert!).
129          */
130         node->projLeft->pi_exprContext = econtext;
131         slot = ExecProject(node->projLeft, NULL);
132
133         /*
134          * Note: because we are typically called in a per-tuple context, we have
135          * to explicitly clear the projected tuple before returning. Otherwise,
136          * we'll have a double-free situation: the per-tuple context will probably
137          * be reset before we're called again, and then the tuple slot will think
138          * it still needs to free the tuple.
139          */
140
141         /*
142          * If the LHS is all non-null, probe for an exact match in the main hash
143          * table.  If we find one, the result is TRUE. Otherwise, scan the
144          * partly-null table to see if there are any rows that aren't provably
145          * unequal to the LHS; if so, the result is UNKNOWN.  (We skip that part
146          * if we don't care about UNKNOWN.) Otherwise, the result is FALSE.
147          *
148          * Note: the reason we can avoid a full scan of the main hash table is
149          * that the combining operators are assumed never to yield NULL when both
150          * inputs are non-null.  If they were to do so, we might need to produce
151          * UNKNOWN instead of FALSE because of an UNKNOWN result in comparing the
152          * LHS to some main-table entry --- which is a comparison we will not even
153          * make, unless there's a chance match of hash keys.
154          */
155         if (slotNoNulls(slot))
156         {
157                 if (node->havehashrows &&
158                         FindTupleHashEntry(node->hashtable,
159                                                            slot,
160                                                            node->cur_eq_funcs,
161                                                            node->lhs_hash_funcs) != NULL)
162                 {
163                         ExecClearTuple(slot);
164                         return BoolGetDatum(true);
165                 }
166                 if (node->havenullrows &&
167                         findPartialMatch(node->hashnulls, slot, node->cur_eq_funcs))
168                 {
169                         ExecClearTuple(slot);
170                         *isNull = true;
171                         return BoolGetDatum(false);
172                 }
173                 ExecClearTuple(slot);
174                 return BoolGetDatum(false);
175         }
176
177         /*
178          * When the LHS is partly or wholly NULL, we can never return TRUE. If we
179          * don't care about UNKNOWN, just return FALSE.  Otherwise, if the LHS is
180          * wholly NULL, immediately return UNKNOWN.  (Since the combining
181          * operators are strict, the result could only be FALSE if the sub-select
182          * were empty, but we already handled that case.) Otherwise, we must scan
183          * both the main and partly-null tables to see if there are any rows that
184          * aren't provably unequal to the LHS; if so, the result is UNKNOWN.
185          * Otherwise, the result is FALSE.
186          */
187         if (node->hashnulls == NULL)
188         {
189                 ExecClearTuple(slot);
190                 return BoolGetDatum(false);
191         }
192         if (slotAllNulls(slot))
193         {
194                 ExecClearTuple(slot);
195                 *isNull = true;
196                 return BoolGetDatum(false);
197         }
198         /* Scan partly-null table first, since more likely to get a match */
199         if (node->havenullrows &&
200                 findPartialMatch(node->hashnulls, slot, node->cur_eq_funcs))
201         {
202                 ExecClearTuple(slot);
203                 *isNull = true;
204                 return BoolGetDatum(false);
205         }
206         if (node->havehashrows &&
207                 findPartialMatch(node->hashtable, slot, node->cur_eq_funcs))
208         {
209                 ExecClearTuple(slot);
210                 *isNull = true;
211                 return BoolGetDatum(false);
212         }
213         ExecClearTuple(slot);
214         return BoolGetDatum(false);
215 }
216
217 /*
218  * ExecScanSubPlan: default case where we have to rescan subplan each time
219  */
220 static Datum
221 ExecScanSubPlan(SubPlanState *node,
222                                 ExprContext *econtext,
223                                 bool *isNull)
224 {
225         SubPlan    *subplan = (SubPlan *) node->xprstate.expr;
226         PlanState  *planstate = node->planstate;
227         SubLinkType subLinkType = subplan->subLinkType;
228         MemoryContext oldcontext;
229         TupleTableSlot *slot;
230         Datum           result;
231         bool            found = false;  /* TRUE if got at least one subplan tuple */
232         ListCell   *pvar;
233         ListCell   *l;
234         ArrayBuildStateAny *astate = NULL;
235
236         /*
237          * MULTIEXPR subplans, when "executed", just return NULL; but first we
238          * mark the subplan's output parameters as needing recalculation.  (This
239          * is a bit of a hack: it relies on the subplan appearing later in its
240          * targetlist than any of the referencing Params, so that all the Params
241          * have been evaluated before we re-mark them for the next evaluation
242          * cycle.  But in general resjunk tlist items appear after non-resjunk
243          * ones, so this should be safe.)  Unlike ExecReScanSetParamPlan, we do
244          * *not* set bits in the parent plan node's chgParam, because we don't
245          * want to cause a rescan of the parent.
246          */
247         if (subLinkType == MULTIEXPR_SUBLINK)
248         {
249                 EState     *estate = node->parent->state;
250
251                 foreach(l, subplan->setParam)
252                 {
253                         int                     paramid = lfirst_int(l);
254                         ParamExecData *prm = &(estate->es_param_exec_vals[paramid]);
255
256                         prm->execPlan = node;
257                 }
258                 *isNull = true;
259                 return (Datum) 0;
260         }
261
262         /* Initialize ArrayBuildStateAny in caller's context, if needed */
263         if (subLinkType == ARRAY_SUBLINK)
264                 astate = initArrayResultAny(subplan->firstColType,
265                                                                         CurrentMemoryContext, true);
266
267         /*
268          * We are probably in a short-lived expression-evaluation context. Switch
269          * to the per-query context for manipulating the child plan's chgParam,
270          * calling ExecProcNode on it, etc.
271          */
272         oldcontext = MemoryContextSwitchTo(econtext->ecxt_per_query_memory);
273
274         /*
275          * Set Params of this plan from parent plan correlation values. (Any
276          * calculation we have to do is done in the parent econtext, since the
277          * Param values don't need to have per-query lifetime.)
278          */
279         Assert(list_length(subplan->parParam) == list_length(node->args));
280
281         forboth(l, subplan->parParam, pvar, node->args)
282         {
283                 int                     paramid = lfirst_int(l);
284                 ParamExecData *prm = &(econtext->ecxt_param_exec_vals[paramid]);
285
286                 prm->value = ExecEvalExprSwitchContext((ExprState *) lfirst(pvar),
287                                                                                            econtext,
288                                                                                            &(prm->isnull),
289                                                                                            NULL);
290                 planstate->chgParam = bms_add_member(planstate->chgParam, paramid);
291         }
292
293         /*
294          * Now that we've set up its parameters, we can reset the subplan.
295          */
296         ExecReScan(planstate);
297
298         /*
299          * For all sublink types except EXPR_SUBLINK and ARRAY_SUBLINK, the result
300          * is boolean as are the results of the combining operators. We combine
301          * results across tuples (if the subplan produces more than one) using OR
302          * semantics for ANY_SUBLINK or AND semantics for ALL_SUBLINK.
303          * (ROWCOMPARE_SUBLINK doesn't allow multiple tuples from the subplan.)
304          * NULL results from the combining operators are handled according to the
305          * usual SQL semantics for OR and AND.  The result for no input tuples is
306          * FALSE for ANY_SUBLINK, TRUE for ALL_SUBLINK, NULL for
307          * ROWCOMPARE_SUBLINK.
308          *
309          * For EXPR_SUBLINK we require the subplan to produce no more than one
310          * tuple, else an error is raised.  If zero tuples are produced, we return
311          * NULL.  Assuming we get a tuple, we just use its first column (there can
312          * be only one non-junk column in this case).
313          *
314          * For ARRAY_SUBLINK we allow the subplan to produce any number of tuples,
315          * and form an array of the first column's values.  Note in particular
316          * that we produce a zero-element array if no tuples are produced (this is
317          * a change from pre-8.3 behavior of returning NULL).
318          */
319         result = BoolGetDatum(subLinkType == ALL_SUBLINK);
320         *isNull = false;
321
322         for (slot = ExecProcNode(planstate);
323                  !TupIsNull(slot);
324                  slot = ExecProcNode(planstate))
325         {
326                 TupleDesc       tdesc = slot->tts_tupleDescriptor;
327                 Datum           rowresult;
328                 bool            rownull;
329                 int                     col;
330                 ListCell   *plst;
331
332                 if (subLinkType == EXISTS_SUBLINK)
333                 {
334                         found = true;
335                         result = BoolGetDatum(true);
336                         break;
337                 }
338
339                 if (subLinkType == EXPR_SUBLINK)
340                 {
341                         /* cannot allow multiple input tuples for EXPR sublink */
342                         if (found)
343                                 ereport(ERROR,
344                                                 (errcode(ERRCODE_CARDINALITY_VIOLATION),
345                                                  errmsg("more than one row returned by a subquery used as an expression")));
346                         found = true;
347
348                         /*
349                          * We need to copy the subplan's tuple in case the result is of
350                          * pass-by-ref type --- our return value will point into this
351                          * copied tuple!  Can't use the subplan's instance of the tuple
352                          * since it won't still be valid after next ExecProcNode() call.
353                          * node->curTuple keeps track of the copied tuple for eventual
354                          * freeing.
355                          */
356                         if (node->curTuple)
357                                 heap_freetuple(node->curTuple);
358                         node->curTuple = ExecCopySlotTuple(slot);
359
360                         result = heap_getattr(node->curTuple, 1, tdesc, isNull);
361                         /* keep scanning subplan to make sure there's only one tuple */
362                         continue;
363                 }
364
365                 if (subLinkType == ARRAY_SUBLINK)
366                 {
367                         Datum           dvalue;
368                         bool            disnull;
369
370                         found = true;
371                         /* stash away current value */
372                         Assert(subplan->firstColType == tdesc->attrs[0]->atttypid);
373                         dvalue = slot_getattr(slot, 1, &disnull);
374                         astate = accumArrayResultAny(astate, dvalue, disnull,
375                                                                                  subplan->firstColType, oldcontext);
376                         /* keep scanning subplan to collect all values */
377                         continue;
378                 }
379
380                 /* cannot allow multiple input tuples for ROWCOMPARE sublink either */
381                 if (subLinkType == ROWCOMPARE_SUBLINK && found)
382                         ereport(ERROR,
383                                         (errcode(ERRCODE_CARDINALITY_VIOLATION),
384                                          errmsg("more than one row returned by a subquery used as an expression")));
385
386                 found = true;
387
388                 /*
389                  * For ALL, ANY, and ROWCOMPARE sublinks, load up the Params
390                  * representing the columns of the sub-select, and then evaluate the
391                  * combining expression.
392                  */
393                 col = 1;
394                 foreach(plst, subplan->paramIds)
395                 {
396                         int                     paramid = lfirst_int(plst);
397                         ParamExecData *prmdata;
398
399                         prmdata = &(econtext->ecxt_param_exec_vals[paramid]);
400                         Assert(prmdata->execPlan == NULL);
401                         prmdata->value = slot_getattr(slot, col, &(prmdata->isnull));
402                         col++;
403                 }
404
405                 rowresult = ExecEvalExprSwitchContext(node->testexpr, econtext,
406                                                                                           &rownull, NULL);
407
408                 if (subLinkType == ANY_SUBLINK)
409                 {
410                         /* combine across rows per OR semantics */
411                         if (rownull)
412                                 *isNull = true;
413                         else if (DatumGetBool(rowresult))
414                         {
415                                 result = BoolGetDatum(true);
416                                 *isNull = false;
417                                 break;                  /* needn't look at any more rows */
418                         }
419                 }
420                 else if (subLinkType == ALL_SUBLINK)
421                 {
422                         /* combine across rows per AND semantics */
423                         if (rownull)
424                                 *isNull = true;
425                         else if (!DatumGetBool(rowresult))
426                         {
427                                 result = BoolGetDatum(false);
428                                 *isNull = false;
429                                 break;                  /* needn't look at any more rows */
430                         }
431                 }
432                 else
433                 {
434                         /* must be ROWCOMPARE_SUBLINK */
435                         result = rowresult;
436                         *isNull = rownull;
437                 }
438         }
439
440         MemoryContextSwitchTo(oldcontext);
441
442         if (subLinkType == ARRAY_SUBLINK)
443         {
444                 /* We return the result in the caller's context */
445                 result = makeArrayResultAny(astate, oldcontext, true);
446         }
447         else if (!found)
448         {
449                 /*
450                  * deal with empty subplan result.  result/isNull were previously
451                  * initialized correctly for all sublink types except EXPR and
452                  * ROWCOMPARE; for those, return NULL.
453                  */
454                 if (subLinkType == EXPR_SUBLINK ||
455                         subLinkType == ROWCOMPARE_SUBLINK)
456                 {
457                         result = (Datum) 0;
458                         *isNull = true;
459                 }
460         }
461
462         return result;
463 }
464
465 /*
466  * buildSubPlanHash: load hash table by scanning subplan output.
467  */
468 static void
469 buildSubPlanHash(SubPlanState *node, ExprContext *econtext)
470 {
471         SubPlan    *subplan = (SubPlan *) node->xprstate.expr;
472         PlanState  *planstate = node->planstate;
473         int                     ncols = list_length(subplan->paramIds);
474         ExprContext *innerecontext = node->innerecontext;
475         MemoryContext oldcontext;
476         long            nbuckets;
477         TupleTableSlot *slot;
478
479         Assert(subplan->subLinkType == ANY_SUBLINK);
480
481         /*
482          * If we already had any hash tables, destroy 'em; then create empty hash
483          * table(s).
484          *
485          * If we need to distinguish accurately between FALSE and UNKNOWN (i.e.,
486          * NULL) results of the IN operation, then we have to store subplan output
487          * rows that are partly or wholly NULL.  We store such rows in a separate
488          * hash table that we expect will be much smaller than the main table. (We
489          * can use hashing to eliminate partly-null rows that are not distinct. We
490          * keep them separate to minimize the cost of the inevitable full-table
491          * searches; see findPartialMatch.)
492          *
493          * If it's not necessary to distinguish FALSE and UNKNOWN, then we don't
494          * need to store subplan output rows that contain NULL.
495          */
496         MemoryContextReset(node->hashtablecxt);
497         node->hashtable = NULL;
498         node->hashnulls = NULL;
499         node->havehashrows = false;
500         node->havenullrows = false;
501
502         nbuckets = (long) Min(planstate->plan->plan_rows, (double) LONG_MAX);
503         if (nbuckets < 1)
504                 nbuckets = 1;
505
506         node->hashtable = BuildTupleHashTable(ncols,
507                                                                                   node->keyColIdx,
508                                                                                   node->tab_eq_funcs,
509                                                                                   node->tab_hash_funcs,
510                                                                                   nbuckets,
511                                                                                   0,
512                                                                                   node->hashtablecxt,
513                                                                                   node->hashtempcxt,
514                                                                                   false);
515
516         if (!subplan->unknownEqFalse)
517         {
518                 if (ncols == 1)
519                         nbuckets = 1;           /* there can only be one entry */
520                 else
521                 {
522                         nbuckets /= 16;
523                         if (nbuckets < 1)
524                                 nbuckets = 1;
525                 }
526                 node->hashnulls = BuildTupleHashTable(ncols,
527                                                                                           node->keyColIdx,
528                                                                                           node->tab_eq_funcs,
529                                                                                           node->tab_hash_funcs,
530                                                                                           nbuckets,
531                                                                                           0,
532                                                                                           node->hashtablecxt,
533                                                                                           node->hashtempcxt,
534                                                                                           false);
535         }
536
537         /*
538          * We are probably in a short-lived expression-evaluation context. Switch
539          * to the per-query context for manipulating the child plan.
540          */
541         oldcontext = MemoryContextSwitchTo(econtext->ecxt_per_query_memory);
542
543         /*
544          * Reset subplan to start.
545          */
546         ExecReScan(planstate);
547
548         /*
549          * Scan the subplan and load the hash table(s).  Note that when there are
550          * duplicate rows coming out of the sub-select, only one copy is stored.
551          */
552         for (slot = ExecProcNode(planstate);
553                  !TupIsNull(slot);
554                  slot = ExecProcNode(planstate))
555         {
556                 int                     col = 1;
557                 ListCell   *plst;
558                 bool            isnew;
559
560                 /*
561                  * Load up the Params representing the raw sub-select outputs, then
562                  * form the projection tuple to store in the hashtable.
563                  */
564                 foreach(plst, subplan->paramIds)
565                 {
566                         int                     paramid = lfirst_int(plst);
567                         ParamExecData *prmdata;
568
569                         prmdata = &(innerecontext->ecxt_param_exec_vals[paramid]);
570                         Assert(prmdata->execPlan == NULL);
571                         prmdata->value = slot_getattr(slot, col,
572                                                                                   &(prmdata->isnull));
573                         col++;
574                 }
575                 slot = ExecProject(node->projRight, NULL);
576
577                 /*
578                  * If result contains any nulls, store separately or not at all.
579                  */
580                 if (slotNoNulls(slot))
581                 {
582                         (void) LookupTupleHashEntry(node->hashtable, slot, &isnew);
583                         node->havehashrows = true;
584                 }
585                 else if (node->hashnulls)
586                 {
587                         (void) LookupTupleHashEntry(node->hashnulls, slot, &isnew);
588                         node->havenullrows = true;
589                 }
590
591                 /*
592                  * Reset innerecontext after each inner tuple to free any memory used
593                  * during ExecProject.
594                  */
595                 ResetExprContext(innerecontext);
596         }
597
598         /*
599          * Since the projected tuples are in the sub-query's context and not the
600          * main context, we'd better clear the tuple slot before there's any
601          * chance of a reset of the sub-query's context.  Else we will have the
602          * potential for a double free attempt.  (XXX possibly no longer needed,
603          * but can't hurt.)
604          */
605         ExecClearTuple(node->projRight->pi_slot);
606
607         MemoryContextSwitchTo(oldcontext);
608 }
609
610 /*
611  * findPartialMatch: does the hashtable contain an entry that is not
612  * provably distinct from the tuple?
613  *
614  * We have to scan the whole hashtable; we can't usefully use hashkeys
615  * to guide probing, since we might get partial matches on tuples with
616  * hashkeys quite unrelated to what we'd get from the given tuple.
617  *
618  * Caller must provide the equality functions to use, since in cross-type
619  * cases these are different from the hashtable's internal functions.
620  */
621 static bool
622 findPartialMatch(TupleHashTable hashtable, TupleTableSlot *slot,
623                                  FmgrInfo *eqfunctions)
624 {
625         int                     numCols = hashtable->numCols;
626         AttrNumber *keyColIdx = hashtable->keyColIdx;
627         TupleHashIterator hashiter;
628         TupleHashEntry entry;
629
630         InitTupleHashIterator(hashtable, &hashiter);
631         while ((entry = ScanTupleHashTable(hashtable, &hashiter)) != NULL)
632         {
633                 ExecStoreMinimalTuple(entry->firstTuple, hashtable->tableslot, false);
634                 if (!execTuplesUnequal(slot, hashtable->tableslot,
635                                                            numCols, keyColIdx,
636                                                            eqfunctions,
637                                                            hashtable->tempcxt))
638                 {
639                         TermTupleHashIterator(&hashiter);
640                         return true;
641                 }
642         }
643         /* No TermTupleHashIterator call needed here */
644         return false;
645 }
646
647 /*
648  * slotAllNulls: is the slot completely NULL?
649  *
650  * This does not test for dropped columns, which is OK because we only
651  * use it on projected tuples.
652  */
653 static bool
654 slotAllNulls(TupleTableSlot *slot)
655 {
656         int                     ncols = slot->tts_tupleDescriptor->natts;
657         int                     i;
658
659         for (i = 1; i <= ncols; i++)
660         {
661                 if (!slot_attisnull(slot, i))
662                         return false;
663         }
664         return true;
665 }
666
667 /*
668  * slotNoNulls: is the slot entirely not NULL?
669  *
670  * This does not test for dropped columns, which is OK because we only
671  * use it on projected tuples.
672  */
673 static bool
674 slotNoNulls(TupleTableSlot *slot)
675 {
676         int                     ncols = slot->tts_tupleDescriptor->natts;
677         int                     i;
678
679         for (i = 1; i <= ncols; i++)
680         {
681                 if (slot_attisnull(slot, i))
682                         return false;
683         }
684         return true;
685 }
686
687 /* ----------------------------------------------------------------
688  *              ExecInitSubPlan
689  *
690  * Create a SubPlanState for a SubPlan; this is the SubPlan-specific part
691  * of ExecInitExpr().  We split it out so that it can be used for InitPlans
692  * as well as regular SubPlans.  Note that we don't link the SubPlan into
693  * the parent's subPlan list, because that shouldn't happen for InitPlans.
694  * Instead, ExecInitExpr() does that one part.
695  * ----------------------------------------------------------------
696  */
697 SubPlanState *
698 ExecInitSubPlan(SubPlan *subplan, PlanState *parent)
699 {
700         SubPlanState *sstate = makeNode(SubPlanState);
701         EState     *estate = parent->state;
702
703         sstate->xprstate.evalfunc = (ExprStateEvalFunc) ExecSubPlan;
704         sstate->xprstate.expr = (Expr *) subplan;
705
706         /* Link the SubPlanState to already-initialized subplan */
707         sstate->planstate = (PlanState *) list_nth(estate->es_subplanstates,
708                                                                                            subplan->plan_id - 1);
709
710         /* ... and to its parent's state */
711         sstate->parent = parent;
712
713         /* Initialize subexpressions */
714         sstate->testexpr = ExecInitExpr((Expr *) subplan->testexpr, parent);
715         sstate->args = (List *) ExecInitExpr((Expr *) subplan->args, parent);
716
717         /*
718          * initialize my state
719          */
720         sstate->curTuple = NULL;
721         sstate->curArray = PointerGetDatum(NULL);
722         sstate->projLeft = NULL;
723         sstate->projRight = NULL;
724         sstate->hashtable = NULL;
725         sstate->hashnulls = NULL;
726         sstate->hashtablecxt = NULL;
727         sstate->hashtempcxt = NULL;
728         sstate->innerecontext = NULL;
729         sstate->keyColIdx = NULL;
730         sstate->tab_hash_funcs = NULL;
731         sstate->tab_eq_funcs = NULL;
732         sstate->lhs_hash_funcs = NULL;
733         sstate->cur_eq_funcs = NULL;
734
735         /*
736          * If this is an initplan or MULTIEXPR subplan, it has output parameters
737          * that the parent plan will use, so mark those parameters as needing
738          * evaluation.  We don't actually run the subplan until we first need one
739          * of its outputs.
740          *
741          * A CTE subplan's output parameter is never to be evaluated in the normal
742          * way, so skip this in that case.
743          *
744          * Note that we don't set parent->chgParam here: the parent plan hasn't
745          * been run yet, so no need to force it to re-run.
746          */
747         if (subplan->setParam != NIL && subplan->subLinkType != CTE_SUBLINK)
748         {
749                 ListCell   *lst;
750
751                 foreach(lst, subplan->setParam)
752                 {
753                         int                     paramid = lfirst_int(lst);
754                         ParamExecData *prm = &(estate->es_param_exec_vals[paramid]);
755
756                         prm->execPlan = sstate;
757                 }
758         }
759
760         /*
761          * If we are going to hash the subquery output, initialize relevant stuff.
762          * (We don't create the hashtable until needed, though.)
763          */
764         if (subplan->useHashTable)
765         {
766                 int                     ncols,
767                                         i;
768                 TupleDesc       tupDesc;
769                 TupleTableSlot *slot;
770                 List       *oplist,
771                                    *lefttlist,
772                                    *righttlist,
773                                    *leftptlist,
774                                    *rightptlist;
775                 ListCell   *l;
776
777                 /* We need a memory context to hold the hash table(s) */
778                 sstate->hashtablecxt =
779                         AllocSetContextCreate(CurrentMemoryContext,
780                                                                   "Subplan HashTable Context",
781                                                                   ALLOCSET_DEFAULT_SIZES);
782                 /* and a small one for the hash tables to use as temp storage */
783                 sstate->hashtempcxt =
784                         AllocSetContextCreate(CurrentMemoryContext,
785                                                                   "Subplan HashTable Temp Context",
786                                                                   ALLOCSET_SMALL_SIZES);
787                 /* and a short-lived exprcontext for function evaluation */
788                 sstate->innerecontext = CreateExprContext(estate);
789                 /* Silly little array of column numbers 1..n */
790                 ncols = list_length(subplan->paramIds);
791                 sstate->keyColIdx = (AttrNumber *) palloc(ncols * sizeof(AttrNumber));
792                 for (i = 0; i < ncols; i++)
793                         sstate->keyColIdx[i] = i + 1;
794
795                 /*
796                  * We use ExecProject to evaluate the lefthand and righthand
797                  * expression lists and form tuples.  (You might think that we could
798                  * use the sub-select's output tuples directly, but that is not the
799                  * case if we had to insert any run-time coercions of the sub-select's
800                  * output datatypes; anyway this avoids storing any resjunk columns
801                  * that might be in the sub-select's output.) Run through the
802                  * combining expressions to build tlists for the lefthand and
803                  * righthand sides.  We need both the ExprState list (for ExecProject)
804                  * and the underlying parse Exprs (for ExecTypeFromTL).
805                  *
806                  * We also extract the combining operators themselves to initialize
807                  * the equality and hashing functions for the hash tables.
808                  */
809                 if (IsA(sstate->testexpr->expr, OpExpr))
810                 {
811                         /* single combining operator */
812                         oplist = list_make1(sstate->testexpr);
813                 }
814                 else if (and_clause((Node *) sstate->testexpr->expr))
815                 {
816                         /* multiple combining operators */
817                         Assert(IsA(sstate->testexpr, BoolExprState));
818                         oplist = ((BoolExprState *) sstate->testexpr)->args;
819                 }
820                 else
821                 {
822                         /* shouldn't see anything else in a hashable subplan */
823                         elog(ERROR, "unrecognized testexpr type: %d",
824                                  (int) nodeTag(sstate->testexpr->expr));
825                         oplist = NIL;           /* keep compiler quiet */
826                 }
827                 Assert(list_length(oplist) == ncols);
828
829                 lefttlist = righttlist = NIL;
830                 leftptlist = rightptlist = NIL;
831                 sstate->tab_hash_funcs = (FmgrInfo *) palloc(ncols * sizeof(FmgrInfo));
832                 sstate->tab_eq_funcs = (FmgrInfo *) palloc(ncols * sizeof(FmgrInfo));
833                 sstate->lhs_hash_funcs = (FmgrInfo *) palloc(ncols * sizeof(FmgrInfo));
834                 sstate->cur_eq_funcs = (FmgrInfo *) palloc(ncols * sizeof(FmgrInfo));
835                 i = 1;
836                 foreach(l, oplist)
837                 {
838                         FuncExprState *fstate = (FuncExprState *) lfirst(l);
839                         OpExpr     *opexpr = (OpExpr *) fstate->xprstate.expr;
840                         ExprState  *exstate;
841                         Expr       *expr;
842                         TargetEntry *tle;
843                         GenericExprState *tlestate;
844                         Oid                     rhs_eq_oper;
845                         Oid                     left_hashfn;
846                         Oid                     right_hashfn;
847
848                         Assert(IsA(fstate, FuncExprState));
849                         Assert(IsA(opexpr, OpExpr));
850                         Assert(list_length(fstate->args) == 2);
851
852                         /* Process lefthand argument */
853                         exstate = (ExprState *) linitial(fstate->args);
854                         expr = exstate->expr;
855                         tle = makeTargetEntry(expr,
856                                                                   i,
857                                                                   NULL,
858                                                                   false);
859                         tlestate = makeNode(GenericExprState);
860                         tlestate->xprstate.expr = (Expr *) tle;
861                         tlestate->xprstate.evalfunc = NULL;
862                         tlestate->arg = exstate;
863                         lefttlist = lappend(lefttlist, tlestate);
864                         leftptlist = lappend(leftptlist, tle);
865
866                         /* Process righthand argument */
867                         exstate = (ExprState *) lsecond(fstate->args);
868                         expr = exstate->expr;
869                         tle = makeTargetEntry(expr,
870                                                                   i,
871                                                                   NULL,
872                                                                   false);
873                         tlestate = makeNode(GenericExprState);
874                         tlestate->xprstate.expr = (Expr *) tle;
875                         tlestate->xprstate.evalfunc = NULL;
876                         tlestate->arg = exstate;
877                         righttlist = lappend(righttlist, tlestate);
878                         rightptlist = lappend(rightptlist, tle);
879
880                         /* Lookup the equality function (potentially cross-type) */
881                         fmgr_info(opexpr->opfuncid, &sstate->cur_eq_funcs[i - 1]);
882                         fmgr_info_set_expr((Node *) opexpr, &sstate->cur_eq_funcs[i - 1]);
883
884                         /* Look up the equality function for the RHS type */
885                         if (!get_compatible_hash_operators(opexpr->opno,
886                                                                                            NULL, &rhs_eq_oper))
887                                 elog(ERROR, "could not find compatible hash operator for operator %u",
888                                          opexpr->opno);
889                         fmgr_info(get_opcode(rhs_eq_oper), &sstate->tab_eq_funcs[i - 1]);
890
891                         /* Lookup the associated hash functions */
892                         if (!get_op_hash_functions(opexpr->opno,
893                                                                            &left_hashfn, &right_hashfn))
894                                 elog(ERROR, "could not find hash function for hash operator %u",
895                                          opexpr->opno);
896                         fmgr_info(left_hashfn, &sstate->lhs_hash_funcs[i - 1]);
897                         fmgr_info(right_hashfn, &sstate->tab_hash_funcs[i - 1]);
898
899                         i++;
900                 }
901
902                 /*
903                  * Construct tupdescs, slots and projection nodes for left and right
904                  * sides.  The lefthand expressions will be evaluated in the parent
905                  * plan node's exprcontext, which we don't have access to here.
906                  * Fortunately we can just pass NULL for now and fill it in later
907                  * (hack alert!).  The righthand expressions will be evaluated in our
908                  * own innerecontext.
909                  */
910                 tupDesc = ExecTypeFromTL(leftptlist, false);
911                 slot = ExecInitExtraTupleSlot(estate);
912                 ExecSetSlotDescriptor(slot, tupDesc);
913                 sstate->projLeft = ExecBuildProjectionInfo(lefttlist,
914                                                                                                    NULL,
915                                                                                                    slot,
916                                                                                                    NULL);
917
918                 tupDesc = ExecTypeFromTL(rightptlist, false);
919                 slot = ExecInitExtraTupleSlot(estate);
920                 ExecSetSlotDescriptor(slot, tupDesc);
921                 sstate->projRight = ExecBuildProjectionInfo(righttlist,
922                                                                                                         sstate->innerecontext,
923                                                                                                         slot,
924                                                                                                         NULL);
925         }
926
927         return sstate;
928 }
929
930 /* ----------------------------------------------------------------
931  *              ExecSetParamPlan
932  *
933  *              Executes a subplan and sets its output parameters.
934  *
935  * This is called from ExecEvalParamExec() when the value of a PARAM_EXEC
936  * parameter is requested and the param's execPlan field is set (indicating
937  * that the param has not yet been evaluated).  This allows lazy evaluation
938  * of initplans: we don't run the subplan until/unless we need its output.
939  * Note that this routine MUST clear the execPlan fields of the plan's
940  * output parameters after evaluating them!
941  * ----------------------------------------------------------------
942  */
943 void
944 ExecSetParamPlan(SubPlanState *node, ExprContext *econtext)
945 {
946         SubPlan    *subplan = (SubPlan *) node->xprstate.expr;
947         PlanState  *planstate = node->planstate;
948         SubLinkType subLinkType = subplan->subLinkType;
949         MemoryContext oldcontext;
950         TupleTableSlot *slot;
951         ListCell   *pvar;
952         ListCell   *l;
953         bool            found = false;
954         ArrayBuildStateAny *astate = NULL;
955
956         if (subLinkType == ANY_SUBLINK ||
957                 subLinkType == ALL_SUBLINK)
958                 elog(ERROR, "ANY/ALL subselect unsupported as initplan");
959         if (subLinkType == CTE_SUBLINK)
960                 elog(ERROR, "CTE subplans should not be executed via ExecSetParamPlan");
961
962         /* Initialize ArrayBuildStateAny in caller's context, if needed */
963         if (subLinkType == ARRAY_SUBLINK)
964                 astate = initArrayResultAny(subplan->firstColType,
965                                                                         CurrentMemoryContext, true);
966
967         /*
968          * Must switch to per-query memory context.
969          */
970         oldcontext = MemoryContextSwitchTo(econtext->ecxt_per_query_memory);
971
972         /*
973          * Set Params of this plan from parent plan correlation values. (Any
974          * calculation we have to do is done in the parent econtext, since the
975          * Param values don't need to have per-query lifetime.)  Currently, we
976          * expect only MULTIEXPR_SUBLINK plans to have any correlation values.
977          */
978         Assert(subplan->parParam == NIL || subLinkType == MULTIEXPR_SUBLINK);
979         Assert(list_length(subplan->parParam) == list_length(node->args));
980
981         forboth(l, subplan->parParam, pvar, node->args)
982         {
983                 int                     paramid = lfirst_int(l);
984                 ParamExecData *prm = &(econtext->ecxt_param_exec_vals[paramid]);
985
986                 prm->value = ExecEvalExprSwitchContext((ExprState *) lfirst(pvar),
987                                                                                            econtext,
988                                                                                            &(prm->isnull),
989                                                                                            NULL);
990                 planstate->chgParam = bms_add_member(planstate->chgParam, paramid);
991         }
992
993         /*
994          * Run the plan.  (If it needs to be rescanned, the first ExecProcNode
995          * call will take care of that.)
996          */
997         for (slot = ExecProcNode(planstate);
998                  !TupIsNull(slot);
999                  slot = ExecProcNode(planstate))
1000         {
1001                 TupleDesc       tdesc = slot->tts_tupleDescriptor;
1002                 int                     i = 1;
1003
1004                 if (subLinkType == EXISTS_SUBLINK)
1005                 {
1006                         /* There can be only one setParam... */
1007                         int                     paramid = linitial_int(subplan->setParam);
1008                         ParamExecData *prm = &(econtext->ecxt_param_exec_vals[paramid]);
1009
1010                         prm->execPlan = NULL;
1011                         prm->value = BoolGetDatum(true);
1012                         prm->isnull = false;
1013                         found = true;
1014                         break;
1015                 }
1016
1017                 if (subLinkType == ARRAY_SUBLINK)
1018                 {
1019                         Datum           dvalue;
1020                         bool            disnull;
1021
1022                         found = true;
1023                         /* stash away current value */
1024                         Assert(subplan->firstColType == tdesc->attrs[0]->atttypid);
1025                         dvalue = slot_getattr(slot, 1, &disnull);
1026                         astate = accumArrayResultAny(astate, dvalue, disnull,
1027                                                                                  subplan->firstColType, oldcontext);
1028                         /* keep scanning subplan to collect all values */
1029                         continue;
1030                 }
1031
1032                 if (found &&
1033                         (subLinkType == EXPR_SUBLINK ||
1034                          subLinkType == MULTIEXPR_SUBLINK ||
1035                          subLinkType == ROWCOMPARE_SUBLINK))
1036                         ereport(ERROR,
1037                                         (errcode(ERRCODE_CARDINALITY_VIOLATION),
1038                                          errmsg("more than one row returned by a subquery used as an expression")));
1039
1040                 found = true;
1041
1042                 /*
1043                  * We need to copy the subplan's tuple into our own context, in case
1044                  * any of the params are pass-by-ref type --- the pointers stored in
1045                  * the param structs will point at this copied tuple! node->curTuple
1046                  * keeps track of the copied tuple for eventual freeing.
1047                  */
1048                 if (node->curTuple)
1049                         heap_freetuple(node->curTuple);
1050                 node->curTuple = ExecCopySlotTuple(slot);
1051
1052                 /*
1053                  * Now set all the setParam params from the columns of the tuple
1054                  */
1055                 foreach(l, subplan->setParam)
1056                 {
1057                         int                     paramid = lfirst_int(l);
1058                         ParamExecData *prm = &(econtext->ecxt_param_exec_vals[paramid]);
1059
1060                         prm->execPlan = NULL;
1061                         prm->value = heap_getattr(node->curTuple, i, tdesc,
1062                                                                           &(prm->isnull));
1063                         i++;
1064                 }
1065         }
1066
1067         if (subLinkType == ARRAY_SUBLINK)
1068         {
1069                 /* There can be only one setParam... */
1070                 int                     paramid = linitial_int(subplan->setParam);
1071                 ParamExecData *prm = &(econtext->ecxt_param_exec_vals[paramid]);
1072
1073                 /*
1074                  * We build the result array in query context so it won't disappear;
1075                  * to avoid leaking memory across repeated calls, we have to remember
1076                  * the latest value, much as for curTuple above.
1077                  */
1078                 if (node->curArray != PointerGetDatum(NULL))
1079                         pfree(DatumGetPointer(node->curArray));
1080                 node->curArray = makeArrayResultAny(astate,
1081                                                                                         econtext->ecxt_per_query_memory,
1082                                                                                         true);
1083                 prm->execPlan = NULL;
1084                 prm->value = node->curArray;
1085                 prm->isnull = false;
1086         }
1087         else if (!found)
1088         {
1089                 if (subLinkType == EXISTS_SUBLINK)
1090                 {
1091                         /* There can be only one setParam... */
1092                         int                     paramid = linitial_int(subplan->setParam);
1093                         ParamExecData *prm = &(econtext->ecxt_param_exec_vals[paramid]);
1094
1095                         prm->execPlan = NULL;
1096                         prm->value = BoolGetDatum(false);
1097                         prm->isnull = false;
1098                 }
1099                 else
1100                 {
1101                         /* For other sublink types, set all the output params to NULL */
1102                         foreach(l, subplan->setParam)
1103                         {
1104                                 int                     paramid = lfirst_int(l);
1105                                 ParamExecData *prm = &(econtext->ecxt_param_exec_vals[paramid]);
1106
1107                                 prm->execPlan = NULL;
1108                                 prm->value = (Datum) 0;
1109                                 prm->isnull = true;
1110                         }
1111                 }
1112         }
1113
1114         MemoryContextSwitchTo(oldcontext);
1115 }
1116
1117 /*
1118  * Mark an initplan as needing recalculation
1119  */
1120 void
1121 ExecReScanSetParamPlan(SubPlanState *node, PlanState *parent)
1122 {
1123         PlanState  *planstate = node->planstate;
1124         SubPlan    *subplan = (SubPlan *) node->xprstate.expr;
1125         EState     *estate = parent->state;
1126         ListCell   *l;
1127
1128         /* sanity checks */
1129         if (subplan->parParam != NIL)
1130                 elog(ERROR, "direct correlated subquery unsupported as initplan");
1131         if (subplan->setParam == NIL)
1132                 elog(ERROR, "setParam list of initplan is empty");
1133         if (bms_is_empty(planstate->plan->extParam))
1134                 elog(ERROR, "extParam set of initplan is empty");
1135
1136         /*
1137          * Don't actually re-scan: it'll happen inside ExecSetParamPlan if needed.
1138          */
1139
1140         /*
1141          * Mark this subplan's output parameters as needing recalculation.
1142          *
1143          * CTE subplans are never executed via parameter recalculation; instead
1144          * they get run when called by nodeCtescan.c.  So don't mark the output
1145          * parameter of a CTE subplan as dirty, but do set the chgParam bit for it
1146          * so that dependent plan nodes will get told to rescan.
1147          */
1148         foreach(l, subplan->setParam)
1149         {
1150                 int                     paramid = lfirst_int(l);
1151                 ParamExecData *prm = &(estate->es_param_exec_vals[paramid]);
1152
1153                 if (subplan->subLinkType != CTE_SUBLINK)
1154                         prm->execPlan = node;
1155
1156                 parent->chgParam = bms_add_member(parent->chgParam, paramid);
1157         }
1158 }
1159
1160
1161 /*
1162  * ExecInitAlternativeSubPlan
1163  *
1164  * Initialize for execution of one of a set of alternative subplans.
1165  */
1166 AlternativeSubPlanState *
1167 ExecInitAlternativeSubPlan(AlternativeSubPlan *asplan, PlanState *parent)
1168 {
1169         AlternativeSubPlanState *asstate = makeNode(AlternativeSubPlanState);
1170         double          num_calls;
1171         SubPlan    *subplan1;
1172         SubPlan    *subplan2;
1173         Cost            cost1;
1174         Cost            cost2;
1175
1176         asstate->xprstate.evalfunc = (ExprStateEvalFunc) ExecAlternativeSubPlan;
1177         asstate->xprstate.expr = (Expr *) asplan;
1178
1179         /*
1180          * Initialize subplans.  (Can we get away with only initializing the one
1181          * we're going to use?)
1182          */
1183         asstate->subplans = (List *) ExecInitExpr((Expr *) asplan->subplans,
1184                                                                                           parent);
1185
1186         /*
1187          * Select the one to be used.  For this, we need an estimate of the number
1188          * of executions of the subplan.  We use the number of output rows
1189          * expected from the parent plan node.  This is a good estimate if we are
1190          * in the parent's targetlist, and an underestimate (but probably not by
1191          * more than a factor of 2) if we are in the qual.
1192          */
1193         num_calls = parent->plan->plan_rows;
1194
1195         /*
1196          * The planner saved enough info so that we don't have to work very hard
1197          * to estimate the total cost, given the number-of-calls estimate.
1198          */
1199         Assert(list_length(asplan->subplans) == 2);
1200         subplan1 = (SubPlan *) linitial(asplan->subplans);
1201         subplan2 = (SubPlan *) lsecond(asplan->subplans);
1202
1203         cost1 = subplan1->startup_cost + num_calls * subplan1->per_call_cost;
1204         cost2 = subplan2->startup_cost + num_calls * subplan2->per_call_cost;
1205
1206         if (cost1 < cost2)
1207                 asstate->active = 0;
1208         else
1209                 asstate->active = 1;
1210
1211         return asstate;
1212 }
1213
1214 /*
1215  * ExecAlternativeSubPlan
1216  *
1217  * Execute one of a set of alternative subplans.
1218  *
1219  * Note: in future we might consider changing to different subplans on the
1220  * fly, in case the original rowcount estimate turns out to be way off.
1221  */
1222 static Datum
1223 ExecAlternativeSubPlan(AlternativeSubPlanState *node,
1224                                            ExprContext *econtext,
1225                                            bool *isNull,
1226                                            ExprDoneCond *isDone)
1227 {
1228         /* Just pass control to the active subplan */
1229         SubPlanState *activesp = (SubPlanState *) list_nth(node->subplans,
1230                                                                                                            node->active);
1231
1232         Assert(IsA(activesp, SubPlanState));
1233
1234         return ExecSubPlan(activesp,
1235                                            econtext,
1236                                            isNull,
1237                                            isDone);
1238 }