PostgreSQL Source Code git master
Loading...
Searching...
No Matches
joinpath.c
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * joinpath.c
4 * Routines to find all possible paths for processing a set of joins
5 *
6 * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
8 *
9 *
10 * IDENTIFICATION
11 * src/backend/optimizer/path/joinpath.c
12 *
13 *-------------------------------------------------------------------------
14 */
15#include "postgres.h"
16
17#include "executor/executor.h"
18#include "foreign/fdwapi.h"
19#include "nodes/nodeFuncs.h"
20#include "optimizer/cost.h"
21#include "optimizer/optimizer.h"
22#include "optimizer/pathnode.h"
23#include "optimizer/paths.h"
25#include "optimizer/planmain.h"
27#include "utils/lsyscache.h"
28#include "utils/typcache.h"
29
30/* Hooks for plugins to get control in add_paths_to_joinrel() */
33
34/*
35 * Paths parameterized by a parent rel can be considered to be parameterized
36 * by any of its children, when we are performing partitionwise joins. These
37 * macros simplify checking for such cases. Beware multiple eval of args.
38 */
39#define PATH_PARAM_BY_PARENT(path, rel) \
40 ((path)->param_info && bms_overlap(PATH_REQ_OUTER(path), \
41 (rel)->top_parent_relids))
42#define PATH_PARAM_BY_REL_SELF(path, rel) \
43 ((path)->param_info && bms_overlap(PATH_REQ_OUTER(path), (rel)->relids))
44
45#define PATH_PARAM_BY_REL(path, rel) \
46 (PATH_PARAM_BY_REL_SELF(path, rel) || PATH_PARAM_BY_PARENT(path, rel))
47
49 RelOptInfo *joinrel,
52 List *pathkeys,
53 List *mergeclauses,
54 List *outersortkeys,
55 List *innersortkeys,
56 JoinType jointype,
57 JoinPathExtraData *extra);
58static void sort_inner_and_outer(PlannerInfo *root, RelOptInfo *joinrel,
59 RelOptInfo *outerrel, RelOptInfo *innerrel,
60 JoinType jointype, JoinPathExtraData *extra);
61static void match_unsorted_outer(PlannerInfo *root, RelOptInfo *joinrel,
62 RelOptInfo *outerrel, RelOptInfo *innerrel,
63 JoinType jointype, JoinPathExtraData *extra);
65 RelOptInfo *joinrel,
66 RelOptInfo *outerrel,
67 RelOptInfo *innerrel,
68 JoinType jointype,
69 JoinPathExtraData *extra);
71 RelOptInfo *joinrel,
72 RelOptInfo *outerrel,
73 RelOptInfo *innerrel,
74 JoinType jointype,
75 JoinPathExtraData *extra,
77static void hash_inner_and_outer(PlannerInfo *root, RelOptInfo *joinrel,
78 RelOptInfo *outerrel, RelOptInfo *innerrel,
79 JoinType jointype, JoinPathExtraData *extra);
81 RelOptInfo *joinrel,
82 RelOptInfo *outerrel,
83 RelOptInfo *innerrel,
84 List *restrictlist,
85 JoinType jointype,
86 bool *mergejoin_allowed);
88 RelOptInfo *joinrel,
89 RelOptInfo *innerrel,
91 JoinType jointype,
92 JoinPathExtraData *extra,
93 bool useallclauses,
96 bool is_partial);
97
98
99/*
100 * add_paths_to_joinrel
101 * Given a join relation and two component rels from which it can be made,
102 * consider all possible paths that use the two component rels as outer
103 * and inner rel respectively. Add these paths to the join rel's pathlist
104 * if they survive comparison with other paths (and remove any existing
105 * paths that are dominated by these paths).
106 *
107 * Modifies the pathlist field of the joinrel node to contain the best
108 * paths found so far.
109 *
110 * jointype is not necessarily the same as sjinfo->jointype; it might be
111 * "flipped around" if we are considering joining the rels in the opposite
112 * direction from what's indicated in sjinfo.
113 *
114 * Also, this routine accepts the special JoinTypes JOIN_UNIQUE_OUTER and
115 * JOIN_UNIQUE_INNER to indicate that the outer or inner relation has been
116 * unique-ified and a regular inner join should then be applied. These values
117 * are not allowed to propagate outside this routine, however. Path cost
118 * estimation code, as well as match_unsorted_outer, may need to recognize that
119 * it's dealing with such a case --- the combination of nominal jointype INNER
120 * with sjinfo->jointype == JOIN_SEMI indicates that.
121 */
122void
124 RelOptInfo *joinrel,
125 RelOptInfo *outerrel,
126 RelOptInfo *innerrel,
127 JoinType jointype,
128 SpecialJoinInfo *sjinfo,
129 List *restrictlist)
130{
131 JoinType save_jointype = jointype;
132 JoinPathExtraData extra;
133 bool mergejoin_allowed = true;
134 ListCell *lc;
136
137 /*
138 * PlannerInfo doesn't contain the SpecialJoinInfos created for joins
139 * between child relations, even if there is a SpecialJoinInfo node for
140 * the join between the topmost parents. So, while calculating Relids set
141 * representing the restriction, consider relids of topmost parent of
142 * partitions.
143 */
144 if (joinrel->reloptkind == RELOPT_OTHER_JOINREL)
145 joinrelids = joinrel->top_parent_relids;
146 else
147 joinrelids = joinrel->relids;
148
149 extra.restrictlist = restrictlist;
150 extra.mergeclause_list = NIL;
151 extra.sjinfo = sjinfo;
152 extra.param_source_rels = NULL;
153 extra.pgs_mask = joinrel->pgs_mask;
154
155 /*
156 * Give extensions a chance to take control. In particular, an extension
157 * might want to modify extra.pgs_mask. It's possible to override pgs_mask
158 * on a query-wide basis using join_search_hook, or for a particular
159 * relation using joinrel_setup_hook, but extensions that want to provide
160 * different advice for the same joinrel based on the choice of innerrel
161 * and outerrel will need to use this hook.
162 *
163 * A very simple way for an extension to use this hook is to set
164 * extra.pgs_mask &= ~PGS_JOIN_ANY, if it simply doesn't want any of the
165 * paths generated by this call to add_paths_to_joinrel() to be selected.
166 * An extension could use this technique to constrain the join order,
167 * since it could thereby arrange to reject all paths from join orders
168 * that it does not like. An extension can also selectively clear bits
169 * from extra.pgs_mask to rule out specific techniques for specific joins,
170 * or could even set additional bits to re-allow methods disabled at some
171 * higher level.
172 *
173 * NB: Below this point, this function should be careful to reference
174 * extra.pgs_mask rather than rel->pgs_mask to avoid disregarding any
175 * changes made by the hook we're about to call.
176 */
178 join_path_setup_hook(root, joinrel, outerrel, innerrel,
179 jointype, &extra);
180
181 /*
182 * See if the inner relation is provably unique for this outer rel.
183 *
184 * We have some special cases: for JOIN_SEMI, it doesn't matter since the
185 * executor can make the equivalent optimization anyway. It also doesn't
186 * help enable use of Memoize, since a semijoin with a provably unique
187 * inner side should have been reduced to an inner join in that case.
188 * Therefore, we need not expend planner cycles on proofs. (For
189 * JOIN_ANTI, although it doesn't help the executor for the same reason,
190 * it can benefit Memoize paths.) For JOIN_UNIQUE_INNER, we must be
191 * considering a semijoin whose inner side is not provably unique (else
192 * reduce_unique_semijoins would've simplified it), so there's no point in
193 * calling innerrel_is_unique. However, if the LHS covers all of the
194 * semijoin's min_lefthand, then it's appropriate to set inner_unique
195 * because the unique relation produced by create_unique_paths will be
196 * unique relative to the LHS. (If we have an LHS that's only part of the
197 * min_lefthand, that is *not* true.) For JOIN_UNIQUE_OUTER, pass
198 * JOIN_INNER to avoid letting that value escape this module.
199 */
200 switch (jointype)
201 {
202 case JOIN_SEMI:
203 extra.inner_unique = false; /* well, unproven */
204 break;
207 outerrel->relids);
208 break;
211 joinrel->relids,
212 outerrel->relids,
213 innerrel,
215 restrictlist,
216 false);
217 break;
218 default:
220 joinrel->relids,
221 outerrel->relids,
222 innerrel,
223 jointype,
224 restrictlist,
225 false);
226 break;
227 }
228
229 /*
230 * If the outer or inner relation has been unique-ified, handle as a plain
231 * inner join.
232 */
233 if (jointype == JOIN_UNIQUE_OUTER || jointype == JOIN_UNIQUE_INNER)
234 jointype = JOIN_INNER;
235
236 /*
237 * Find potential mergejoin clauses. We can skip this if we are not
238 * interested in doing a mergejoin. However, mergejoin may be our only
239 * way of implementing a full outer join, so in that case we don't care
240 * whether mergejoins are disabled.
241 */
242 if ((extra.pgs_mask & PGS_MERGEJOIN_ANY) != 0 || jointype == JOIN_FULL)
244 joinrel,
245 outerrel,
246 innerrel,
247 restrictlist,
248 jointype,
250
251 /*
252 * If it's SEMI, ANTI, or inner_unique join, compute correction factors
253 * for cost estimation. These will be the same for all paths.
254 */
255 if (jointype == JOIN_SEMI || jointype == JOIN_ANTI || extra.inner_unique)
256 compute_semi_anti_join_factors(root, joinrel, outerrel, innerrel,
257 jointype, sjinfo, restrictlist,
258 &extra.semifactors);
259
260 /*
261 * Decide whether it's sensible to generate parameterized paths for this
262 * joinrel, and if so, which relations such paths should require. There
263 * is usually no need to create a parameterized result path unless there
264 * is a join order restriction that prevents joining one of our input rels
265 * directly to the parameter source rel instead of joining to the other
266 * input rel. (But see allow_star_schema_join().) This restriction
267 * reduces the number of parameterized paths we have to deal with at
268 * higher join levels, without compromising the quality of the resulting
269 * plan. We express the restriction as a Relids set that must overlap the
270 * parameterization of any proposed join path. Note: param_source_rels
271 * should contain only baserels, not OJ relids, so starting from
272 * all_baserels not all_query_rels is correct.
273 */
274 foreach(lc, root->join_info_list)
275 {
277
278 /*
279 * SJ is relevant to this join if we have some part of its RHS
280 * (possibly not all of it), and haven't yet joined to its LHS. (This
281 * test is pretty simplistic, but should be sufficient considering the
282 * join has already been proven legal.) If the SJ is relevant, it
283 * presents constraints for joining to anything not in its RHS.
284 */
285 if (bms_overlap(joinrelids, sjinfo2->min_righthand) &&
286 !bms_overlap(joinrelids, sjinfo2->min_lefthand))
288 bms_difference(root->all_baserels,
289 sjinfo2->min_righthand));
290
291 /* full joins constrain both sides symmetrically */
292 if (sjinfo2->jointype == JOIN_FULL &&
293 bms_overlap(joinrelids, sjinfo2->min_lefthand) &&
294 !bms_overlap(joinrelids, sjinfo2->min_righthand))
296 bms_difference(root->all_baserels,
297 sjinfo2->min_lefthand));
298 }
299
300 /*
301 * However, when a LATERAL subquery is involved, there will simply not be
302 * any paths for the joinrel that aren't parameterized by whatever the
303 * subquery is parameterized by, unless its parameterization is resolved
304 * within the joinrel. So we might as well allow additional dependencies
305 * on whatever residual lateral dependencies the joinrel will have.
306 */
308 joinrel->lateral_relids);
309
310 /*
311 * 1. Consider mergejoin paths where both relations must be explicitly
312 * sorted. Skip this if we can't mergejoin.
313 */
315 sort_inner_and_outer(root, joinrel, outerrel, innerrel,
316 jointype, &extra);
317
318 /*
319 * 2. Consider paths where the outer relation need not be explicitly
320 * sorted. This includes both nestloops and mergejoins where the outer
321 * path is already ordered. Again, skip this if we can't mergejoin.
322 * (That's okay because we know that nestloop can't handle
323 * right/right-anti/right-semi/full joins at all, so it wouldn't work in
324 * the prohibited cases either.)
325 */
327 match_unsorted_outer(root, joinrel, outerrel, innerrel,
328 jointype, &extra);
329
330#ifdef NOT_USED
331
332 /*
333 * 3. Consider paths where the inner relation need not be explicitly
334 * sorted. This includes mergejoins only (nestloops were already built in
335 * match_unsorted_outer).
336 *
337 * Diked out as redundant 2/13/2000 -- tgl. There isn't any really
338 * significant difference between the inner and outer side of a mergejoin,
339 * so match_unsorted_inner creates no paths that aren't equivalent to
340 * those made by match_unsorted_outer when add_paths_to_joinrel() is
341 * invoked with the two rels given in the other order.
342 */
344 match_unsorted_inner(root, joinrel, outerrel, innerrel,
345 jointype, &extra);
346#endif
347
348 /*
349 * 4. Consider paths where both outer and inner relations must be hashed
350 * before being joined. As above, when it's a full join, we must try this
351 * even when the path type is disabled, because it may be our only option.
352 */
353 if ((extra.pgs_mask & PGS_HASHJOIN) != 0 || jointype == JOIN_FULL)
354 hash_inner_and_outer(root, joinrel, outerrel, innerrel,
355 jointype, &extra);
356
357 /*
358 * 5. If inner and outer relations are foreign tables (or joins) belonging
359 * to the same server and assigned to the same user to check access
360 * permissions as, give the FDW a chance to push down joins.
361 */
362 if ((extra.pgs_mask & PGS_FOREIGNJOIN) != 0 && joinrel->fdwroutine &&
363 joinrel->fdwroutine->GetForeignJoinPaths)
364 joinrel->fdwroutine->GetForeignJoinPaths(root, joinrel,
365 outerrel, innerrel,
366 save_jointype, &extra);
367
368 /*
369 * 6. Finally, give extensions a chance to manipulate the path list. They
370 * could add new paths (such as CustomPaths) by calling add_path(), or
371 * add_partial_path() if parallel aware.
372 *
373 * In theory, extensions could also use this hook to delete or modify
374 * paths added by the core code, but in practice this is difficult to make
375 * work, since it's too late to get back any paths that have already been
376 * discarded by add_path() or add_partial_path(). If you're trying to
377 * suppress paths, consider using join_path_setup_hook instead.
378 */
380 set_join_pathlist_hook(root, joinrel, outerrel, innerrel,
381 save_jointype, &extra);
382}
383
384/*
385 * We override the param_source_rels heuristic to accept nestloop paths in
386 * which the outer rel satisfies some but not all of the inner path's
387 * parameterization. This is necessary to get good plans for star-schema
388 * scenarios, in which a parameterized path for a large table may require
389 * parameters from multiple small tables that will not get joined directly to
390 * each other. We can handle that by stacking nestloops that have the small
391 * tables on the outside; but this breaks the rule the param_source_rels
392 * heuristic is based on, namely that parameters should not be passed down
393 * across joins unless there's a join-order-constraint-based reason to do so.
394 * So we ignore the param_source_rels restriction when this case applies.
395 *
396 * allow_star_schema_join() returns true if the param_source_rels restriction
397 * should be overridden, ie, it's okay to perform this join.
398 */
399static inline bool
401 Relids outerrelids,
403{
404 /*
405 * It's a star-schema case if the outer rel provides some but not all of
406 * the inner rel's parameterization.
407 */
408 return (bms_overlap(inner_paramrels, outerrelids) &&
410}
411
412/*
413 * If the parameterization is only partly satisfied by the outer rel,
414 * the unsatisfied part can't include any outer-join relids that could
415 * null rels of the satisfied part. That would imply that we're trying
416 * to use a clause involving a Var with nonempty varnullingrels at
417 * a join level where that value isn't yet computable.
418 *
419 * In practice, this test never finds a problem because earlier join order
420 * restrictions prevent us from attempting a join that would cause a problem.
421 * (That's unsurprising, because the code worked before we ever added
422 * outer-join relids to expression relids.) It still seems worth checking
423 * as a backstop, but we only do so in assert-enabled builds.
424 */
425#ifdef USE_ASSERT_CHECKING
426static inline bool
428 Relids outerrelids,
430{
431 bool result = false;
434
435 if (bms_overlap(unsatisfied, root->outer_join_rels))
436 {
437 ListCell *lc;
438
439 foreach(lc, root->join_info_list)
440 {
442
443 if (!bms_is_member(sjinfo->ojrelid, unsatisfied))
444 continue; /* not relevant */
445 if (bms_overlap(satisfied, sjinfo->min_righthand) ||
446 (sjinfo->jointype == JOIN_FULL &&
448 {
449 result = true; /* doesn't work */
450 break;
451 }
452 }
453 }
454
455 /* Waste no memory when we reject a path here */
458
459 return result;
460}
461#endif /* USE_ASSERT_CHECKING */
462
463/*
464 * paraminfo_get_equal_hashops
465 * Determine if the clauses in param_info and innerrel's lateral vars
466 * can be hashed.
467 * Returns true if hashing is possible, otherwise false.
468 *
469 * Additionally, on success we collect the outer expressions and the
470 * appropriate equality operators for each hashable parameter to innerrel.
471 * These are returned in parallel lists in *param_exprs and *operators.
472 * We also set *binary_mode to indicate whether strict binary matching is
473 * required.
474 */
475static bool
477 RelOptInfo *outerrel, RelOptInfo *innerrel,
478 List *ph_lateral_vars, List **param_exprs,
479 List **operators, bool *binary_mode)
480
481{
482 List *lateral_vars;
483 ListCell *lc;
484
485 *param_exprs = NIL;
486 *operators = NIL;
487 *binary_mode = false;
488
489 /* Add join clauses from param_info to the hash key */
490 if (param_info != NULL)
491 {
492 List *clauses = param_info->ppi_clauses;
493
494 foreach(lc, clauses)
495 {
496 RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
497 OpExpr *opexpr;
498 Node *expr;
500
501 opexpr = (OpExpr *) rinfo->clause;
502
503 /*
504 * Bail if the rinfo is not compatible. We need a join OpExpr
505 * with 2 args.
506 */
507 if (!IsA(opexpr, OpExpr) || list_length(opexpr->args) != 2 ||
508 !clause_sides_match_join(rinfo, outerrel->relids,
509 innerrel->relids))
510 {
511 list_free(*operators);
512 list_free(*param_exprs);
513 return false;
514 }
515
516 if (rinfo->outer_is_left)
517 {
518 expr = (Node *) linitial(opexpr->args);
519 hasheqoperator = rinfo->left_hasheqoperator;
520 }
521 else
522 {
523 expr = (Node *) lsecond(opexpr->args);
524 hasheqoperator = rinfo->right_hasheqoperator;
525 }
526
527 /* can't do memoize if we can't hash the outer type */
529 {
530 list_free(*operators);
531 list_free(*param_exprs);
532 return false;
533 }
534
535 /*
536 * 'expr' may already exist as a parameter from a previous item in
537 * ppi_clauses. No need to include it again, however we'd better
538 * ensure we do switch into binary mode if required. See below.
539 */
540 if (!list_member(*param_exprs, expr))
541 {
542 *operators = lappend_oid(*operators, hasheqoperator);
543 *param_exprs = lappend(*param_exprs, expr);
544 }
545
546 /*
547 * When the join operator is not hashable then it's possible that
548 * the operator will be able to distinguish something that the
549 * hash equality operator could not. For example with floating
550 * point types -0.0 and +0.0 are classed as equal by the hash
551 * function and equality function, but some other operator may be
552 * able to tell those values apart. This means that we must put
553 * memoize into binary comparison mode so that it does bit-by-bit
554 * comparisons rather than a "logical" comparison as it would
555 * using the hash equality operator.
556 */
557 if (!OidIsValid(rinfo->hashjoinoperator))
558 *binary_mode = true;
559 }
560 }
561
562 /* Now add any lateral vars to the cache key too */
563 lateral_vars = list_concat(ph_lateral_vars, innerrel->lateral_vars);
564 foreach(lc, lateral_vars)
565 {
566 Node *expr = (Node *) lfirst(lc);
567 TypeCacheEntry *typentry;
568
569 /* Reject if there are any volatile functions in lateral vars */
571 {
572 list_free(*operators);
573 list_free(*param_exprs);
574 return false;
575 }
576
577 typentry = lookup_type_cache(exprType(expr),
579
580 /* can't use memoize without a valid hash proc and equals operator */
581 if (!OidIsValid(typentry->hash_proc) || !OidIsValid(typentry->eq_opr))
582 {
583 list_free(*operators);
584 list_free(*param_exprs);
585 return false;
586 }
587
588 /*
589 * 'expr' may already exist as a parameter from the ppi_clauses. No
590 * need to include it again, however we'd better ensure we do switch
591 * into binary mode.
592 */
593 if (!list_member(*param_exprs, expr))
594 {
595 *operators = lappend_oid(*operators, typentry->eq_opr);
596 *param_exprs = lappend(*param_exprs, expr);
597 }
598
599 /*
600 * We must go into binary mode as we don't have too much of an idea of
601 * how these lateral Vars are being used. See comment above when we
602 * set *binary_mode for the non-lateral Var case. This could be
603 * relaxed a bit if we had the RestrictInfos and knew the operators
604 * being used, however for cases like Vars that are arguments to
605 * functions we must operate in binary mode as we don't have
606 * visibility into what the function is doing with the Vars.
607 */
608 *binary_mode = true;
609 }
610
611 /* We're okay to use memoize */
612 return true;
613}
614
615/*
616 * extract_lateral_vars_from_PHVs
617 * Extract lateral references within PlaceHolderVars that are due to be
618 * evaluated at 'innerrelids'.
619 */
620static List *
622{
624 ListCell *lc;
625
626 /* Nothing would be found if the query contains no LATERAL RTEs */
627 if (!root->hasLateralRTEs)
628 return NIL;
629
630 /*
631 * No need to consider PHVs that are due to be evaluated at joinrels,
632 * since we do not add Memoize nodes on top of joinrel paths.
633 */
635 return NIL;
636
637 foreach(lc, root->placeholder_list)
638 {
640 List *vars;
641 ListCell *cell;
642
643 /* PHV is uninteresting if no lateral refs */
644 if (phinfo->ph_lateral == NULL)
645 continue;
646
647 /* PHV is uninteresting if not due to be evaluated at innerrelids */
648 if (!bms_equal(phinfo->ph_eval_at, innerrelids))
649 continue;
650
651 /*
652 * If the PHV does not reference any rels in innerrelids, use its
653 * contained expression as a cache key rather than extracting the
654 * Vars/PHVs from it and using those. This can be beneficial in cases
655 * where the expression results in fewer distinct values to cache
656 * tuples for.
657 */
658 if (!bms_overlap(pull_varnos(root, (Node *) phinfo->ph_var->phexpr),
660 {
661 ph_lateral_vars = lappend(ph_lateral_vars, phinfo->ph_var->phexpr);
662 continue;
663 }
664
665 /* Fetch Vars and PHVs of lateral references within PlaceHolderVars */
666 vars = pull_vars_of_level((Node *) phinfo->ph_var->phexpr, 0);
667 foreach(cell, vars)
668 {
669 Node *node = (Node *) lfirst(cell);
670
671 if (IsA(node, Var))
672 {
673 Var *var = (Var *) node;
674
675 Assert(var->varlevelsup == 0);
676
677 if (bms_is_member(var->varno, phinfo->ph_lateral))
679 }
680 else if (IsA(node, PlaceHolderVar))
681 {
683
684 Assert(phv->phlevelsup == 0);
685
689 }
690 else
691 Assert(false);
692 }
693
695 }
696
697 return ph_lateral_vars;
698}
699
700/*
701 * get_memoize_path
702 * If possible, make and return a Memoize path atop of 'inner_path'.
703 * Otherwise return NULL.
704 *
705 * Note that currently we do not add Memoize nodes on top of join relation
706 * paths. This is because the ParamPathInfos for join relation paths do not
707 * maintain ppi_clauses, as the set of relevant clauses varies depending on how
708 * the join is formed. In addition, joinrels do not maintain lateral_vars. So
709 * we do not have a way to extract cache keys from joinrels.
710 */
711static Path *
713 RelOptInfo *outerrel, Path *inner_path,
714 Path *outer_path, JoinType jointype,
715 JoinPathExtraData *extra)
716{
717 List *param_exprs;
718 List *hash_operators;
719 ListCell *lc;
720 bool binary_mode;
722
723 /* Obviously not if it's disabled */
724 if ((extra->pgs_mask & PGS_NESTLOOP_MEMOIZE) == 0)
725 return NULL;
726
727 /*
728 * We can safely not bother with all this unless we expect to perform more
729 * than one inner scan. The first scan is always going to be a cache
730 * miss. This would likely fail later anyway based on costs, so this is
731 * really just to save some wasted effort.
732 */
733 if (outer_path->parent->rows < 2)
734 return NULL;
735
736 /*
737 * Extract lateral Vars/PHVs within PlaceHolderVars that are due to be
738 * evaluated at innerrel. These lateral Vars/PHVs could be used as
739 * memoize cache keys.
740 */
742
743 /*
744 * We can only have a memoize node when there's some kind of cache key,
745 * either parameterized path clauses or lateral Vars. No cache key sounds
746 * more like something a Materialize node might be more useful for.
747 */
748 if ((inner_path->param_info == NULL ||
749 inner_path->param_info->ppi_clauses == NIL) &&
750 innerrel->lateral_vars == NIL &&
752 return NULL;
753
754 /*
755 * Currently we don't do this for SEMI and ANTI joins, because nested loop
756 * SEMI/ANTI joins don't scan the inner node to completion, which means
757 * memoize cannot mark the cache entry as complete. Nor can we mark the
758 * cache entry as complete after fetching the first inner tuple, because
759 * if that tuple and the current outer tuple don't satisfy the join
760 * clauses, a second inner tuple that satisfies the parameters would find
761 * the cache entry already marked as complete. The only exception is when
762 * the inner relation is provably unique, as in that case, there won't be
763 * a second matching tuple and we can safely mark the cache entry as
764 * complete after fetching the first inner tuple. Note that in such
765 * cases, the SEMI join should have been reduced to an inner join by
766 * reduce_unique_semijoins.
767 */
768 if ((jointype == JOIN_SEMI || jointype == JOIN_ANTI) &&
769 !extra->inner_unique)
770 return NULL;
771
772 /*
773 * Memoize normally marks cache entries as complete when it runs out of
774 * tuples to read from its subplan. However, with unique joins, Nested
775 * Loop will skip to the next outer tuple after finding the first matching
776 * inner tuple. This means that we may not read the inner side of the
777 * join to completion which leaves no opportunity to mark the cache entry
778 * as complete. To work around that, when the join is unique we
779 * automatically mark cache entries as complete after fetching the first
780 * tuple. This works when the entire join condition is parameterized.
781 * Otherwise, when the parameterization is only a subset of the join
782 * condition, we can't be sure which part of it causes the join to be
783 * unique. This means there are no guarantees that only 1 tuple will be
784 * read. We cannot mark the cache entry as complete after reading the
785 * first tuple without that guarantee. This means the scope of Memoize
786 * node's usefulness is limited to only outer rows that have no join
787 * partner as this is the only case where Nested Loop would exhaust the
788 * inner scan of a unique join. Since the scope is limited to that, we
789 * just don't bother making a memoize path in this case.
790 *
791 * Lateral vars needn't be considered here as they're not considered when
792 * determining if the join is unique.
793 */
794 if (extra->inner_unique)
795 {
796 Bitmapset *ppi_serials;
797
798 if (inner_path->param_info == NULL)
799 return NULL;
800
801 ppi_serials = inner_path->param_info->ppi_serials;
802
804 {
805 if (!bms_is_member(rinfo->rinfo_serial, ppi_serials))
806 return NULL;
807 }
808 }
809
810 /*
811 * We can't use a memoize node if there are volatile functions in the
812 * inner rel's target list or restrict list. A cache hit could reduce the
813 * number of calls to these functions.
814 */
815 if (contain_volatile_functions((Node *) innerrel->reltarget))
816 return NULL;
817
818 foreach(lc, innerrel->baserestrictinfo)
819 {
820 RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
821
822 if (contain_volatile_functions((Node *) rinfo))
823 return NULL;
824 }
825
826 /*
827 * Also check the parameterized path restrictinfos for volatile functions.
828 * Indexed functions must be immutable so shouldn't have any volatile
829 * functions, however, with a lateral join the inner scan may not be an
830 * index scan.
831 */
832 if (inner_path->param_info != NULL)
833 {
834 foreach(lc, inner_path->param_info->ppi_clauses)
835 {
836 RestrictInfo *rinfo = (RestrictInfo *) lfirst(lc);
837
838 if (contain_volatile_functions((Node *) rinfo))
839 return NULL;
840 }
841 }
842
843 /* Check if we have hash ops for each parameter to the path */
845 inner_path->param_info,
846 outerrel->top_parent ?
847 outerrel->top_parent : outerrel,
848 innerrel,
850 &param_exprs,
851 &hash_operators,
852 &binary_mode))
853 {
854 return (Path *) create_memoize_path(root,
855 innerrel,
857 param_exprs,
858 hash_operators,
859 extra->inner_unique,
860 binary_mode,
861 outer_path->rows);
862 }
863
864 return NULL;
865}
866
867/*
868 * try_nestloop_path
869 * Consider a nestloop join path; if it appears useful, push it into
870 * the joinrel's pathlist via add_path().
871 */
872static void
874 RelOptInfo *joinrel,
877 List *pathkeys,
878 JoinType jointype,
880 JoinPathExtraData *extra)
881{
883 JoinCostWorkspace workspace;
884 RelOptInfo *innerrel = inner_path->parent;
885 RelOptInfo *outerrel = outer_path->parent;
887 Relids outerrelids;
890
891 /*
892 * If we are forming an outer join at this join, it's nonsensical to use
893 * an input path that uses the outer join as part of its parameterization.
894 * (This can happen despite our join order restrictions, since those apply
895 * to what is in an input relation not what its parameters are.)
896 */
897 if (extra->sjinfo->ojrelid != 0 &&
900 return;
901
902 /*
903 * Any parameterization of the input paths refers to topmost parents of
904 * the relevant relations, because reparameterize_path_by_child() hasn't
905 * been called yet. So we must consider topmost parents of the relations
906 * being joined, too, while determining parameterization of the result and
907 * checking for disallowed parameterization cases.
908 */
909 if (innerrel->top_parent_relids)
910 innerrelids = innerrel->top_parent_relids;
911 else
912 innerrelids = innerrel->relids;
913
914 if (outerrel->top_parent_relids)
915 outerrelids = outerrel->top_parent_relids;
916 else
917 outerrelids = outerrel->relids;
918
919 /*
920 * Check to see if proposed path is still parameterized, and reject if the
921 * parameterization wouldn't be sensible --- unless allow_star_schema_join
922 * says to allow it anyway.
923 */
926 if (required_outer &&
929 {
930 /* Waste no memory when we reject a path here */
932 return;
933 }
934
935 /* If we got past that, we shouldn't have any unsafe outer-join refs */
937
938 /*
939 * If the inner path is parameterized, it is parameterized by the topmost
940 * parent of the outer rel, not the outer rel itself. We will need to
941 * translate the parameterization, if this path is chosen, during
942 * create_plan(). Here we just check whether we will be able to perform
943 * the translation, and if not avoid creating a nestloop path.
944 */
947 {
949 return;
950 }
951
952 /*
953 * Do a precheck to quickly eliminate obviously-inferior paths. We
954 * calculate a cheap lower bound on the path's cost and then use
955 * add_path_precheck() to see if the path is clearly going to be dominated
956 * by some existing path for the joinrel. If not, do the full pushup with
957 * creating a fully valid path structure and submitting it to add_path().
958 * The latter two steps are expensive enough to make this two-phase
959 * methodology worthwhile.
960 */
961 initial_cost_nestloop(root, &workspace, jointype,
963 outer_path, inner_path, extra);
964
965 if (add_path_precheck(joinrel, workspace.disabled_nodes,
966 workspace.startup_cost, workspace.total_cost,
967 pathkeys, required_outer))
968 {
969 add_path(joinrel, (Path *)
971 joinrel,
972 jointype,
973 &workspace,
974 extra,
977 extra->restrictlist,
978 pathkeys,
980 }
981 else
982 {
983 /* Waste no memory when we reject a path here */
985 }
986}
987
988/*
989 * try_partial_nestloop_path
990 * Consider a partial nestloop join path; if it appears useful, push it into
991 * the joinrel's partial_pathlist via add_partial_path().
992 */
993static void
995 RelOptInfo *joinrel,
998 List *pathkeys,
999 JoinType jointype,
1001 JoinPathExtraData *extra)
1002{
1003 JoinCostWorkspace workspace;
1004
1005 /*
1006 * If the inner path is parameterized, the parameterization must be fully
1007 * satisfied by the proposed outer path. Parameterized partial paths are
1008 * not supported. The caller should already have verified that no lateral
1009 * rels are required here.
1010 */
1013 if (inner_path->param_info != NULL)
1014 {
1015 Relids inner_paramrels = inner_path->param_info->ppi_req_outer;
1016 RelOptInfo *outerrel = outer_path->parent;
1017 Relids outerrelids;
1018
1019 /*
1020 * The inner and outer paths are parameterized, if at all, by the top
1021 * level parents, not the child relations, so we must use those relids
1022 * for our parameterization tests.
1023 */
1024 if (outerrel->top_parent_relids)
1025 outerrelids = outerrel->top_parent_relids;
1026 else
1027 outerrelids = outerrel->relids;
1028
1029 if (!bms_is_subset(inner_paramrels, outerrelids))
1030 return;
1031 }
1032
1033 /*
1034 * If the inner path is parameterized, it is parameterized by the topmost
1035 * parent of the outer rel, not the outer rel itself. We will need to
1036 * translate the parameterization, if this path is chosen, during
1037 * create_plan(). Here we just check whether we will be able to perform
1038 * the translation, and if not avoid creating a nestloop path.
1039 */
1042 return;
1043
1044 /*
1045 * Before creating a path, get a quick lower bound on what it is likely to
1046 * cost. Bail out right away if it looks terrible.
1047 */
1048 initial_cost_nestloop(root, &workspace, jointype, nestloop_subtype,
1049 outer_path, inner_path, extra);
1050 if (!add_partial_path_precheck(joinrel, workspace.disabled_nodes,
1051 workspace.startup_cost,
1052 workspace.total_cost, pathkeys))
1053 return;
1054
1055 /* Might be good enough to be worth trying, so let's try it. */
1056 add_partial_path(joinrel, (Path *)
1058 joinrel,
1059 jointype,
1060 &workspace,
1061 extra,
1062 outer_path,
1063 inner_path,
1064 extra->restrictlist,
1065 pathkeys,
1066 NULL));
1067}
1068
1069/*
1070 * try_mergejoin_path
1071 * Consider a merge join path; if it appears useful, push it into
1072 * the joinrel's pathlist via add_path().
1073 */
1074static void
1076 RelOptInfo *joinrel,
1079 List *pathkeys,
1080 List *mergeclauses,
1081 List *outersortkeys,
1082 List *innersortkeys,
1083 JoinType jointype,
1084 JoinPathExtraData *extra,
1085 bool is_partial)
1086{
1088 int outer_presorted_keys = 0;
1089 JoinCostWorkspace workspace;
1090
1091 if (is_partial)
1092 {
1094 joinrel,
1095 outer_path,
1096 inner_path,
1097 pathkeys,
1098 mergeclauses,
1099 outersortkeys,
1100 innersortkeys,
1101 jointype,
1102 extra);
1103 return;
1104 }
1105
1106 /*
1107 * If we are forming an outer join at this join, it's nonsensical to use
1108 * an input path that uses the outer join as part of its parameterization.
1109 * (This can happen despite our join order restrictions, since those apply
1110 * to what is in an input relation not what its parameters are.)
1111 */
1112 if (extra->sjinfo->ojrelid != 0 &&
1115 return;
1116
1117 /*
1118 * Check to see if proposed path is still parameterized, and reject if the
1119 * parameterization wouldn't be sensible.
1120 */
1122 inner_path);
1123 if (required_outer &&
1125 {
1126 /* Waste no memory when we reject a path here */
1128 return;
1129 }
1130
1131 /*
1132 * If the given paths are already well enough ordered, we can skip doing
1133 * an explicit sort.
1134 *
1135 * We need to determine the number of presorted keys of the outer path to
1136 * decide whether explicit incremental sort can be applied when
1137 * outersortkeys is not NIL. We do not need to do the same for the inner
1138 * path though, as incremental sort currently does not support
1139 * mark/restore.
1140 */
1141 if (outersortkeys &&
1142 pathkeys_count_contained_in(outersortkeys, outer_path->pathkeys,
1143 &outer_presorted_keys))
1144 outersortkeys = NIL;
1145 if (innersortkeys &&
1146 pathkeys_contained_in(innersortkeys, inner_path->pathkeys))
1147 innersortkeys = NIL;
1148
1149 /*
1150 * See comments in try_nestloop_path().
1151 */
1152 initial_cost_mergejoin(root, &workspace, jointype, mergeclauses,
1154 outersortkeys, innersortkeys,
1155 outer_presorted_keys,
1156 extra);
1157
1158 if (add_path_precheck(joinrel, workspace.disabled_nodes,
1159 workspace.startup_cost, workspace.total_cost,
1160 pathkeys, required_outer))
1161 {
1162 add_path(joinrel, (Path *)
1164 joinrel,
1165 jointype,
1166 &workspace,
1167 extra,
1168 outer_path,
1169 inner_path,
1170 extra->restrictlist,
1171 pathkeys,
1173 mergeclauses,
1174 outersortkeys,
1175 innersortkeys,
1176 outer_presorted_keys));
1177 }
1178 else
1179 {
1180 /* Waste no memory when we reject a path here */
1182 }
1183}
1184
1185/*
1186 * try_partial_mergejoin_path
1187 * Consider a partial merge join path; if it appears useful, push it into
1188 * the joinrel's pathlist via add_partial_path().
1189 */
1190static void
1192 RelOptInfo *joinrel,
1195 List *pathkeys,
1196 List *mergeclauses,
1197 List *outersortkeys,
1198 List *innersortkeys,
1199 JoinType jointype,
1200 JoinPathExtraData *extra)
1201{
1202 int outer_presorted_keys = 0;
1203 JoinCostWorkspace workspace;
1204
1205 /*
1206 * See comments in try_partial_hashjoin_path().
1207 */
1211 return;
1212
1213 /*
1214 * If the given paths are already well enough ordered, we can skip doing
1215 * an explicit sort.
1216 *
1217 * We need to determine the number of presorted keys of the outer path to
1218 * decide whether explicit incremental sort can be applied when
1219 * outersortkeys is not NIL. We do not need to do the same for the inner
1220 * path though, as incremental sort currently does not support
1221 * mark/restore.
1222 */
1223 if (outersortkeys &&
1224 pathkeys_count_contained_in(outersortkeys, outer_path->pathkeys,
1225 &outer_presorted_keys))
1226 outersortkeys = NIL;
1227 if (innersortkeys &&
1228 pathkeys_contained_in(innersortkeys, inner_path->pathkeys))
1229 innersortkeys = NIL;
1230
1231 /*
1232 * See comments in try_partial_nestloop_path().
1233 */
1234 initial_cost_mergejoin(root, &workspace, jointype, mergeclauses,
1236 outersortkeys, innersortkeys,
1237 outer_presorted_keys,
1238 extra);
1239
1240 if (!add_partial_path_precheck(joinrel, workspace.disabled_nodes,
1241 workspace.startup_cost,
1242 workspace.total_cost, pathkeys))
1243 return;
1244
1245 /* Might be good enough to be worth trying, so let's try it. */
1246 add_partial_path(joinrel, (Path *)
1248 joinrel,
1249 jointype,
1250 &workspace,
1251 extra,
1252 outer_path,
1253 inner_path,
1254 extra->restrictlist,
1255 pathkeys,
1256 NULL,
1257 mergeclauses,
1258 outersortkeys,
1259 innersortkeys,
1260 outer_presorted_keys));
1261}
1262
1263/*
1264 * try_hashjoin_path
1265 * Consider a hash join path; if it appears useful, push it into
1266 * the joinrel's pathlist via add_path().
1267 */
1268static void
1270 RelOptInfo *joinrel,
1273 List *hashclauses,
1274 JoinType jointype,
1275 JoinPathExtraData *extra)
1276{
1278 JoinCostWorkspace workspace;
1279
1280 /*
1281 * If we are forming an outer join at this join, it's nonsensical to use
1282 * an input path that uses the outer join as part of its parameterization.
1283 * (This can happen despite our join order restrictions, since those apply
1284 * to what is in an input relation not what its parameters are.)
1285 */
1286 if (extra->sjinfo->ojrelid != 0 &&
1289 return;
1290
1291 /*
1292 * Check to see if proposed path is still parameterized, and reject if the
1293 * parameterization wouldn't be sensible.
1294 */
1296 inner_path);
1297 if (required_outer &&
1299 {
1300 /* Waste no memory when we reject a path here */
1302 return;
1303 }
1304
1305 /*
1306 * See comments in try_nestloop_path(). Also note that hashjoin paths
1307 * never have any output pathkeys, per comments in create_hashjoin_path.
1308 */
1309 initial_cost_hashjoin(root, &workspace, jointype, hashclauses,
1310 outer_path, inner_path, extra, false);
1311
1312 if (add_path_precheck(joinrel, workspace.disabled_nodes,
1313 workspace.startup_cost, workspace.total_cost,
1315 {
1316 add_path(joinrel, (Path *)
1318 joinrel,
1319 jointype,
1320 &workspace,
1321 extra,
1322 outer_path,
1323 inner_path,
1324 false, /* parallel_hash */
1325 extra->restrictlist,
1327 hashclauses));
1328 }
1329 else
1330 {
1331 /* Waste no memory when we reject a path here */
1333 }
1334}
1335
1336/*
1337 * try_partial_hashjoin_path
1338 * Consider a partial hashjoin join path; if it appears useful, push it into
1339 * the joinrel's partial_pathlist via add_partial_path().
1340 * The outer side is partial. If parallel_hash is true, then the inner path
1341 * must be partial and will be run in parallel to create one or more shared
1342 * hash tables; otherwise the inner path must be complete and a copy of it
1343 * is run in every process to create separate identical private hash tables.
1344 */
1345static void
1347 RelOptInfo *joinrel,
1350 List *hashclauses,
1351 JoinType jointype,
1352 JoinPathExtraData *extra,
1353 bool parallel_hash)
1354{
1355 JoinCostWorkspace workspace;
1356
1357 /*
1358 * If the inner path is parameterized, we can't use a partial hashjoin.
1359 * Parameterized partial paths are not supported. The caller should
1360 * already have verified that no lateral rels are required here.
1361 */
1365 return;
1366
1367 /*
1368 * Before creating a path, get a quick lower bound on what it is likely to
1369 * cost. Bail out right away if it looks terrible.
1370 */
1371 initial_cost_hashjoin(root, &workspace, jointype, hashclauses,
1373 if (!add_partial_path_precheck(joinrel, workspace.disabled_nodes,
1374 workspace.startup_cost,
1375 workspace.total_cost, NIL))
1376 return;
1377
1378 /* Might be good enough to be worth trying, so let's try it. */
1379 add_partial_path(joinrel, (Path *)
1381 joinrel,
1382 jointype,
1383 &workspace,
1384 extra,
1385 outer_path,
1386 inner_path,
1388 extra->restrictlist,
1389 NULL,
1390 hashclauses));
1391}
1392
1393/*
1394 * sort_inner_and_outer
1395 * Create mergejoin join paths by explicitly sorting both the outer and
1396 * inner join relations on each available merge ordering.
1397 *
1398 * 'joinrel' is the join relation
1399 * 'outerrel' is the outer join relation
1400 * 'innerrel' is the inner join relation
1401 * 'jointype' is the type of join to do
1402 * 'extra' contains additional input values
1403 */
1404static void
1406 RelOptInfo *joinrel,
1407 RelOptInfo *outerrel,
1408 RelOptInfo *innerrel,
1409 JoinType jointype,
1410 JoinPathExtraData *extra)
1411{
1417 ListCell *l;
1418
1419 /* Nothing to do if there are no available mergejoin clauses */
1420 if (extra->mergeclause_list == NIL)
1421 return;
1422
1423 /*
1424 * We only consider the cheapest-total-cost input paths, since we are
1425 * assuming here that a sort is required. We will consider
1426 * cheapest-startup-cost input paths later, and only if they don't need a
1427 * sort.
1428 *
1429 * This function intentionally does not consider parameterized input
1430 * paths, except when the cheapest-total is parameterized. If we did so,
1431 * we'd have a combinatorial explosion of mergejoin paths of dubious
1432 * value. This interacts with decisions elsewhere that also discriminate
1433 * against mergejoins with parameterized inputs; see comments in
1434 * src/backend/optimizer/README.
1435 */
1436 outer_path = outerrel->cheapest_total_path;
1437 inner_path = innerrel->cheapest_total_path;
1438
1439 /*
1440 * If either cheapest-total path is parameterized by the other rel, we
1441 * can't use a mergejoin. (There's no use looking for alternative input
1442 * paths, since these should already be the least-parameterized available
1443 * paths.)
1444 */
1445 if (PATH_PARAM_BY_REL(outer_path, innerrel) ||
1446 PATH_PARAM_BY_REL(inner_path, outerrel))
1447 return;
1448
1449 /*
1450 * If the joinrel is parallel-safe, we may be able to consider a partial
1451 * merge join. However, we can't handle JOIN_FULL, JOIN_RIGHT and
1452 * JOIN_RIGHT_ANTI, because they can produce false null extended rows.
1453 * Also, the resulting path must not be parameterized.
1454 */
1455 if (joinrel->consider_parallel &&
1456 jointype != JOIN_FULL &&
1457 jointype != JOIN_RIGHT &&
1458 jointype != JOIN_RIGHT_ANTI &&
1459 outerrel->partial_pathlist != NIL &&
1460 bms_is_empty(joinrel->lateral_relids))
1461 {
1463
1464 if (inner_path->parallel_safe)
1466 else
1469 }
1470
1471 /*
1472 * Each possible ordering of the available mergejoin clauses will generate
1473 * a differently-sorted result path at essentially the same cost. We have
1474 * no basis for choosing one over another at this level of joining, but
1475 * some sort orders may be more useful than others for higher-level
1476 * mergejoins, so it's worth considering multiple orderings.
1477 *
1478 * Actually, it's not quite true that every mergeclause ordering will
1479 * generate a different path order, because some of the clauses may be
1480 * partially redundant (refer to the same EquivalenceClasses). Therefore,
1481 * what we do is convert the mergeclause list to a list of canonical
1482 * pathkeys, and then consider different orderings of the pathkeys.
1483 *
1484 * Generating a path for *every* permutation of the pathkeys doesn't seem
1485 * like a winning strategy; the cost in planning time is too high. For
1486 * now, we generate one path for each pathkey, listing that pathkey first
1487 * and the rest in random order. This should allow at least a one-clause
1488 * mergejoin without re-sorting against any other possible mergejoin
1489 * partner path. But if we've not guessed the right ordering of secondary
1490 * keys, we may end up evaluating clauses as qpquals when they could have
1491 * been done as mergeclauses. (In practice, it's rare that there's more
1492 * than two or three mergeclauses, so expending a huge amount of thought
1493 * on that is probably not worth it.)
1494 *
1495 * The pathkey order returned by select_outer_pathkeys_for_merge() has
1496 * some heuristics behind it (see that function), so be sure to try it
1497 * exactly as-is as well as making variants.
1498 */
1500 extra->mergeclause_list,
1501 joinrel);
1502
1503 foreach(l, all_pathkeys)
1504 {
1507 List *outerkeys;
1508 List *innerkeys;
1510
1511 /* Make a pathkey list with this guy first */
1512 if (l != list_head(all_pathkeys))
1516 else
1517 outerkeys = all_pathkeys; /* no work at first one... */
1518
1519 /* Sort the mergeclauses into the corresponding ordering */
1522 outerkeys,
1523 extra->mergeclause_list);
1524
1525 /* Should have used them all... */
1527
1528 /* Build sort pathkeys for the inner side */
1531 outerkeys);
1532
1533 /* Build pathkeys representing output sort order */
1534 merge_pathkeys = build_join_pathkeys(root, joinrel, jointype,
1535 outerkeys);
1536
1537 /*
1538 * And now we can make the path.
1539 *
1540 * Note: it's possible that the cheapest paths will already be sorted
1541 * properly. try_mergejoin_path will detect that case and suppress an
1542 * explicit sort step, so we needn't do so here.
1543 */
1545 joinrel,
1546 outer_path,
1547 inner_path,
1550 outerkeys,
1551 innerkeys,
1552 jointype,
1553 extra,
1554 false);
1555
1556 /*
1557 * If we have partial outer and parallel safe inner path then try
1558 * partial mergejoin path.
1559 */
1562 joinrel,
1567 outerkeys,
1568 innerkeys,
1569 jointype,
1570 extra);
1571 }
1572}
1573
1574/*
1575 * generate_mergejoin_paths
1576 * Creates possible mergejoin paths for input outerpath.
1577 *
1578 * We generate mergejoins if mergejoin clauses are available. We have
1579 * two ways to generate the inner path for a mergejoin: sort the cheapest
1580 * inner path, or use an inner path that is already suitably ordered for the
1581 * merge. If we have several mergeclauses, it could be that there is no inner
1582 * path (or only a very expensive one) for the full list of mergeclauses, but
1583 * better paths exist if we truncate the mergeclause list (thereby discarding
1584 * some sort key requirements). So, we consider truncations of the
1585 * mergeclause list as well as the full list. (Ideally we'd consider all
1586 * subsets of the mergeclause list, but that seems way too expensive.)
1587 */
1588static void
1590 RelOptInfo *joinrel,
1591 RelOptInfo *innerrel,
1592 Path *outerpath,
1593 JoinType jointype,
1594 JoinPathExtraData *extra,
1595 bool useallclauses,
1598 bool is_partial)
1599{
1600 List *mergeclauses;
1601 List *innersortkeys;
1605 int num_sortkeys;
1606 int sortkeycnt;
1607
1608 /* Look for useful mergeclauses (if any) */
1609 mergeclauses =
1611 outerpath->pathkeys,
1612 extra->mergeclause_list);
1613
1614 /*
1615 * Done with this outer path if no chance for a mergejoin.
1616 *
1617 * Special corner case: for "x FULL JOIN y ON true", there will be no join
1618 * clauses at all. Ordinarily we'd generate a clauseless nestloop path,
1619 * but since mergejoin is our only join type that supports FULL JOIN
1620 * without any join clauses, it's necessary to generate a clauseless
1621 * mergejoin path instead.
1622 */
1623 if (mergeclauses == NIL)
1624 {
1625 if (jointype == JOIN_FULL)
1626 /* okay to try for mergejoin */ ;
1627 else
1628 return;
1629 }
1630 if (useallclauses &&
1631 list_length(mergeclauses) != list_length(extra->mergeclause_list))
1632 return;
1633
1634 /* Compute the required ordering of the inner path */
1635 innersortkeys = make_inner_pathkeys_for_merge(root,
1636 mergeclauses,
1637 outerpath->pathkeys);
1638
1639 /*
1640 * Generate a mergejoin on the basis of sorting the cheapest inner. Since
1641 * a sort will be needed, only cheapest total cost matters. (But
1642 * try_mergejoin_path will do the right thing if inner_cheapest_total is
1643 * already correctly sorted.)
1644 */
1646 joinrel,
1647 outerpath,
1650 mergeclauses,
1651 NIL,
1652 innersortkeys,
1653 jointype,
1654 extra,
1655 is_partial);
1656
1657 /*
1658 * Look for presorted inner paths that satisfy the innersortkey list ---
1659 * or any truncation thereof, if we are allowed to build a mergejoin using
1660 * a subset of the merge clauses. Here, we consider both cheap startup
1661 * cost and cheap total cost.
1662 *
1663 * Currently we do not consider parameterized inner paths here. This
1664 * interacts with decisions elsewhere that also discriminate against
1665 * mergejoins with parameterized inputs; see comments in
1666 * src/backend/optimizer/README.
1667 *
1668 * As we shorten the sortkey list, we should consider only paths that are
1669 * strictly cheaper than (in particular, not the same as) any path found
1670 * in an earlier iteration. Otherwise we'd be intentionally using fewer
1671 * merge keys than a given path allows (treating the rest as plain
1672 * joinquals), which is unlikely to be a good idea. Also, eliminating
1673 * paths here on the basis of compare_path_costs is a lot cheaper than
1674 * building the mergejoin path only to throw it away.
1675 *
1676 * If inner_cheapest_total is well enough sorted to have not required a
1677 * sort in the path made above, we shouldn't make a duplicate path with
1678 * it, either. We handle that case with the same logic that handles the
1679 * previous consideration, by initializing the variables that track
1680 * cheapest-so-far properly. Note that we do NOT reject
1681 * inner_cheapest_total if we find it matches some shorter set of
1682 * pathkeys. That case corresponds to using fewer mergekeys to avoid
1683 * sorting inner_cheapest_total, whereas we did sort it above, so the
1684 * plans being considered are different.
1685 */
1686 if (pathkeys_contained_in(innersortkeys,
1687 inner_cheapest_total->pathkeys))
1688 {
1689 /* inner_cheapest_total didn't require a sort */
1692 }
1693 else
1694 {
1695 /* it did require a sort, at least for the full set of keys */
1698 }
1699 num_sortkeys = list_length(innersortkeys);
1700 if (num_sortkeys > 1 && !useallclauses)
1701 trialsortkeys = list_copy(innersortkeys); /* need modifiable copy */
1702 else
1703 trialsortkeys = innersortkeys; /* won't really truncate */
1704
1706 {
1707 Path *innerpath;
1708 List *newclauses = NIL;
1709
1710 /*
1711 * Look for an inner path ordered well enough for the first
1712 * 'sortkeycnt' innersortkeys. NB: trialsortkeys list is modified
1713 * destructively, which is why we made a copy...
1714 */
1718 NULL,
1719 TOTAL_COST,
1720 is_partial);
1721 if (innerpath != NULL &&
1724 TOTAL_COST) < 0))
1725 {
1726 /* Found a cheap (or even-cheaper) sorted path */
1727 /* Select the right mergeclauses, if we didn't already */
1729 {
1730 newclauses =
1732 mergeclauses,
1734 Assert(newclauses != NIL);
1735 }
1736 else
1737 newclauses = mergeclauses;
1739 joinrel,
1740 outerpath,
1741 innerpath,
1743 newclauses,
1744 NIL,
1745 NIL,
1746 jointype,
1747 extra,
1748 is_partial);
1750 }
1751 /* Same on the basis of cheapest startup cost ... */
1754 NULL,
1756 is_partial);
1757 if (innerpath != NULL &&
1760 STARTUP_COST) < 0))
1761 {
1762 /* Found a cheap (or even-cheaper) sorted path */
1764 {
1765 /*
1766 * Avoid rebuilding clause list if we already made one; saves
1767 * memory in big join trees...
1768 */
1769 if (newclauses == NIL)
1770 {
1772 {
1773 newclauses =
1775 mergeclauses,
1777 Assert(newclauses != NIL);
1778 }
1779 else
1780 newclauses = mergeclauses;
1781 }
1783 joinrel,
1784 outerpath,
1785 innerpath,
1787 newclauses,
1788 NIL,
1789 NIL,
1790 jointype,
1791 extra,
1792 is_partial);
1793 }
1795 }
1796
1797 /*
1798 * Don't consider truncated sortkeys if we need all clauses.
1799 */
1800 if (useallclauses)
1801 break;
1802 }
1803}
1804
1805/*
1806 * match_unsorted_outer
1807 * Creates possible join paths for processing a single join relation
1808 * 'joinrel' by employing either iterative substitution or
1809 * mergejoining on each of its possible outer paths (considering
1810 * only outer paths that are already ordered well enough for merging).
1811 *
1812 * We always generate a nestloop path for each available outer path.
1813 * In fact we may generate as many as five: one on the cheapest-total-cost
1814 * inner path, one on the same with materialization, one on the
1815 * cheapest-startup-cost inner path (if different), one on the
1816 * cheapest-total inner-indexscan path (if any), and one on the
1817 * cheapest-startup inner-indexscan path (if different).
1818 *
1819 * We also consider mergejoins if mergejoin clauses are available. See
1820 * detailed comments in generate_mergejoin_paths.
1821 *
1822 * 'joinrel' is the join relation
1823 * 'outerrel' is the outer join relation
1824 * 'innerrel' is the inner join relation
1825 * 'jointype' is the type of join to do
1826 * 'extra' contains additional input values
1827 */
1828static void
1830 RelOptInfo *joinrel,
1831 RelOptInfo *outerrel,
1832 RelOptInfo *innerrel,
1833 JoinType jointype,
1834 JoinPathExtraData *extra)
1835{
1836 bool nestjoinOK;
1837 bool useallclauses;
1839 Path *matpath = NULL;
1840 ListCell *lc1;
1841
1842 /*
1843 * For now we do not support RIGHT_SEMI join in mergejoin or nestloop
1844 * join.
1845 */
1846 if (jointype == JOIN_RIGHT_SEMI)
1847 return;
1848
1849 /*
1850 * Nestloop only supports inner, left, semi, and anti joins. Also, if we
1851 * are doing a right, right-anti or full mergejoin, we must use *all* the
1852 * mergeclauses as join clauses, else we will not have a valid plan.
1853 * (Although these two flags are currently inverses, keep them separate
1854 * for clarity and possible future changes.)
1855 */
1856 switch (jointype)
1857 {
1858 case JOIN_INNER:
1859 case JOIN_LEFT:
1860 case JOIN_SEMI:
1861 case JOIN_ANTI:
1862 nestjoinOK = true;
1863 useallclauses = false;
1864 break;
1865 case JOIN_RIGHT:
1866 case JOIN_RIGHT_ANTI:
1867 case JOIN_FULL:
1868 nestjoinOK = false;
1869 useallclauses = true;
1870 break;
1871 default:
1872 elog(ERROR, "unrecognized join type: %d",
1873 (int) jointype);
1874 nestjoinOK = false; /* keep compiler quiet */
1875 useallclauses = false;
1876 break;
1877 }
1878
1879 /*
1880 * If inner_cheapest_total is parameterized by the outer rel, ignore it;
1881 * we will consider it below as a member of cheapest_parameterized_paths,
1882 * but the other possibilities considered in this routine aren't usable.
1883 *
1884 * Furthermore, if the inner side is a unique-ified relation, we cannot
1885 * generate any valid paths here, because the inner rel's dependency on
1886 * the outer rel makes unique-ification meaningless.
1887 */
1889 {
1891
1892 if (RELATION_WAS_MADE_UNIQUE(innerrel, extra->sjinfo, jointype))
1893 return;
1894 }
1895
1896 if (nestjoinOK)
1897 {
1898 /*
1899 * Consider materializing the cheapest inner path, unless that is
1900 * disabled or the path in question materializes its output anyway.
1901 *
1902 * At present, we only consider materialization for non-partial outer
1903 * paths, so it's correct to test PGS_CONSIDER_NONPARTIAL here. If we
1904 * ever want to consider materialization for partial paths, we'll need
1905 * to create matpath whenever PGS_NESTLOOP_MATERIALIZE is set, use it
1906 * for partial paths either way, and use it for non-partial paths only
1907 * when PGS_CONSIDER_NONPARTIAL is also set.
1908 */
1909 if ((extra->pgs_mask &
1914 matpath = (Path *)
1916 }
1917
1918 foreach(lc1, outerrel->pathlist)
1919 {
1920 Path *outerpath = (Path *) lfirst(lc1);
1922
1923 /*
1924 * We cannot use an outer path that is parameterized by the inner rel.
1925 */
1926 if (PATH_PARAM_BY_REL(outerpath, innerrel))
1927 continue;
1928
1929 /*
1930 * The result will have this sort order (even if it is implemented as
1931 * a nestloop, and even if some of the mergeclauses are implemented by
1932 * qpquals rather than as true mergeclauses):
1933 */
1934 merge_pathkeys = build_join_pathkeys(root, joinrel, jointype,
1935 outerpath->pathkeys);
1936
1937 if (nestjoinOK)
1938 {
1939 /*
1940 * Consider nestloop joins using this outer path and various
1941 * available paths for the inner relation. We consider the
1942 * cheapest-total paths for each available parameterization of the
1943 * inner relation, including the unparameterized case.
1944 */
1945 ListCell *lc2;
1946
1947 foreach(lc2, innerrel->cheapest_parameterized_paths)
1948 {
1949 Path *innerpath = (Path *) lfirst(lc2);
1950 Path *mpath;
1951
1953 joinrel,
1954 outerpath,
1955 innerpath,
1957 jointype,
1959 extra);
1960
1961 /*
1962 * Try generating a memoize path and see if that makes the
1963 * nested loop any cheaper.
1964 */
1965 mpath = get_memoize_path(root, innerrel, outerrel,
1966 innerpath, outerpath, jointype,
1967 extra);
1968 if (mpath != NULL)
1970 joinrel,
1971 outerpath,
1972 mpath,
1974 jointype,
1976 extra);
1977 }
1978
1979 /* Also consider materialized form of the cheapest inner path */
1980 if (matpath != NULL)
1982 joinrel,
1983 outerpath,
1984 matpath,
1986 jointype,
1988 extra);
1989 }
1990
1991 /* Can't do anything else if inner rel is parameterized by outer */
1993 continue;
1994
1995 /* Generate merge join paths */
1996 generate_mergejoin_paths(root, joinrel, innerrel, outerpath,
1997 jointype, extra, useallclauses,
1999 false);
2000 }
2001
2002 /*
2003 * Consider partial nestloop and mergejoin plan if outerrel has any
2004 * partial path and the joinrel is parallel-safe. However, we can't
2005 * handle joins needing lateral rels, since partial paths must not be
2006 * parameterized. Similarly, we can't handle JOIN_FULL, JOIN_RIGHT and
2007 * JOIN_RIGHT_ANTI, because they can produce false null extended rows.
2008 */
2009 if (joinrel->consider_parallel &&
2010 jointype != JOIN_FULL &&
2011 jointype != JOIN_RIGHT &&
2012 jointype != JOIN_RIGHT_ANTI &&
2013 outerrel->partial_pathlist != NIL &&
2014 bms_is_empty(joinrel->lateral_relids))
2015 {
2016 if (nestjoinOK)
2017 consider_parallel_nestloop(root, joinrel, outerrel, innerrel,
2018 jointype, extra);
2019
2020 /*
2021 * If inner_cheapest_total is NULL or non parallel-safe then find the
2022 * cheapest total parallel safe path.
2023 */
2024 if (inner_cheapest_total == NULL ||
2025 !inner_cheapest_total->parallel_safe)
2026 {
2029 }
2030
2032 consider_parallel_mergejoin(root, joinrel, outerrel, innerrel,
2033 jointype, extra,
2035 }
2036}
2037
2038/*
2039 * consider_parallel_mergejoin
2040 * Try to build partial paths for a joinrel by joining a partial path
2041 * for the outer relation to a complete path for the inner relation.
2042 *
2043 * 'joinrel' is the join relation
2044 * 'outerrel' is the outer join relation
2045 * 'innerrel' is the inner join relation
2046 * 'jointype' is the type of join to do
2047 * 'extra' contains additional input values
2048 * 'inner_cheapest_total' cheapest total path for innerrel
2049 */
2050static void
2052 RelOptInfo *joinrel,
2053 RelOptInfo *outerrel,
2054 RelOptInfo *innerrel,
2055 JoinType jointype,
2056 JoinPathExtraData *extra,
2058{
2059 ListCell *lc1;
2060
2061 /* generate merge join path for each partial outer path */
2062 foreach(lc1, outerrel->partial_pathlist)
2063 {
2064 Path *outerpath = (Path *) lfirst(lc1);
2066
2067 /*
2068 * Figure out what useful ordering any paths we create will have.
2069 */
2070 merge_pathkeys = build_join_pathkeys(root, joinrel, jointype,
2071 outerpath->pathkeys);
2072
2073 generate_mergejoin_paths(root, joinrel, innerrel, outerpath, jointype,
2074 extra, false, inner_cheapest_total,
2075 merge_pathkeys, true);
2076 }
2077}
2078
2079/*
2080 * consider_parallel_nestloop
2081 * Try to build partial paths for a joinrel by joining a partial path for the
2082 * outer relation to a complete path for the inner relation.
2083 *
2084 * 'joinrel' is the join relation
2085 * 'outerrel' is the outer join relation
2086 * 'innerrel' is the inner join relation
2087 * 'jointype' is the type of join to do
2088 * 'extra' contains additional input values
2089 */
2090static void
2092 RelOptInfo *joinrel,
2093 RelOptInfo *outerrel,
2094 RelOptInfo *innerrel,
2095 JoinType jointype,
2096 JoinPathExtraData *extra)
2097{
2099 Path *matpath = NULL;
2100 ListCell *lc1;
2101
2102 /*
2103 * Consider materializing the cheapest inner path, unless: 1)
2104 * materialization is disabled here, 2) the cheapest inner path is not
2105 * parallel-safe, 3) the cheapest inner path is parameterized by the outer
2106 * rel, or 4) the cheapest inner path materializes its output anyway.
2107 */
2108 if ((extra->pgs_mask & PGS_NESTLOOP_MATERIALIZE) != 0 &&
2109 inner_cheapest_total->parallel_safe &&
2112 {
2113 matpath = (Path *)
2115 Assert(matpath->parallel_safe);
2116 }
2117
2118 foreach(lc1, outerrel->partial_pathlist)
2119 {
2120 Path *outerpath = (Path *) lfirst(lc1);
2121 List *pathkeys;
2122 ListCell *lc2;
2123
2124 /* Figure out what useful ordering any paths we create will have. */
2125 pathkeys = build_join_pathkeys(root, joinrel, jointype,
2126 outerpath->pathkeys);
2127
2128 /*
2129 * Try the cheapest parameterized paths; only those which will produce
2130 * an unparameterized path when joined to this outerrel will survive
2131 * try_partial_nestloop_path. The cheapest unparameterized path is
2132 * also in this list.
2133 */
2134 foreach(lc2, innerrel->cheapest_parameterized_paths)
2135 {
2136 Path *innerpath = (Path *) lfirst(lc2);
2137 Path *mpath;
2138
2139 /* Can't join to an inner path that is not parallel-safe */
2140 if (!innerpath->parallel_safe)
2141 continue;
2142
2144 pathkeys, jointype,
2145 PGS_NESTLOOP_PLAIN, extra);
2146
2147 /*
2148 * Try generating a memoize path and see if that makes the nested
2149 * loop any cheaper.
2150 */
2151 mpath = get_memoize_path(root, innerrel, outerrel,
2152 innerpath, outerpath, jointype,
2153 extra);
2154 if (mpath != NULL)
2156 pathkeys, jointype,
2157 PGS_NESTLOOP_MEMOIZE, extra);
2158 }
2159
2160 /* Also consider materialized form of the cheapest inner path */
2161 if (matpath != NULL)
2163 pathkeys, jointype,
2165 }
2166}
2167
2168/*
2169 * hash_inner_and_outer
2170 * Create hashjoin join paths by explicitly hashing both the outer and
2171 * inner keys of each available hash clause.
2172 *
2173 * 'joinrel' is the join relation
2174 * 'outerrel' is the outer join relation
2175 * 'innerrel' is the inner join relation
2176 * 'jointype' is the type of join to do
2177 * 'extra' contains additional input values
2178 */
2179static void
2181 RelOptInfo *joinrel,
2182 RelOptInfo *outerrel,
2183 RelOptInfo *innerrel,
2184 JoinType jointype,
2185 JoinPathExtraData *extra)
2186{
2187 bool isouterjoin = IS_OUTER_JOIN(jointype);
2188 List *hashclauses;
2189 ListCell *l;
2190
2191 /*
2192 * We need to build only one hashclauses list for any given pair of outer
2193 * and inner relations; all of the hashable clauses will be used as keys.
2194 *
2195 * Scan the join's restrictinfo list to find hashjoinable clauses that are
2196 * usable with this pair of sub-relations.
2197 */
2198 hashclauses = NIL;
2199 foreach(l, extra->restrictlist)
2200 {
2202
2203 /*
2204 * If processing an outer join, only use its own join clauses for
2205 * hashing. For inner joins we need not be so picky.
2206 */
2208 continue;
2209
2210 if (!restrictinfo->can_join ||
2211 restrictinfo->hashjoinoperator == InvalidOid)
2212 continue; /* not hashjoinable */
2213
2214 /*
2215 * Check if clause has the form "outer op inner" or "inner op outer".
2216 */
2218 innerrel->relids))
2219 continue; /* no good for these input relations */
2220
2221 /*
2222 * If clause has the form "inner op outer", check if its operator has
2223 * valid commutator. This is necessary because hashclauses in this
2224 * form will get commuted in createplan.c to put the outer var on the
2225 * left (see get_switched_clauses). This probably shouldn't ever
2226 * fail, since hashable operators ought to have commutators, but be
2227 * paranoid.
2228 *
2229 * The clause being hashjoinable indicates that it's an OpExpr.
2230 */
2231 if (!restrictinfo->outer_is_left &&
2233 continue;
2234
2235 hashclauses = lappend(hashclauses, restrictinfo);
2236 }
2237
2238 /* If we found any usable hashclauses, make paths */
2239 if (hashclauses)
2240 {
2241 /*
2242 * We consider both the cheapest-total-cost and cheapest-startup-cost
2243 * outer paths. There's no need to consider any but the
2244 * cheapest-total-cost inner path, however.
2245 */
2249 ListCell *lc1;
2250 ListCell *lc2;
2251
2252 /*
2253 * If either cheapest-total path is parameterized by the other rel, we
2254 * can't use a hashjoin. (There's no use looking for alternative
2255 * input paths, since these should already be the least-parameterized
2256 * available paths.)
2257 */
2258 if (PATH_PARAM_BY_REL(cheapest_total_outer, innerrel) ||
2260 return;
2261
2262 /*
2263 * Consider the cheapest startup outer together with the cheapest
2264 * total inner, and then consider pairings of cheapest-total paths
2265 * including parameterized ones. There is no use in generating
2266 * parameterized paths on the basis of possibly cheap startup cost, so
2267 * this is sufficient.
2268 */
2271 joinrel,
2274 hashclauses,
2275 jointype,
2276 extra);
2277
2278 foreach(lc1, outerrel->cheapest_parameterized_paths)
2279 {
2280 Path *outerpath = (Path *) lfirst(lc1);
2281
2282 /*
2283 * We cannot use an outer path that is parameterized by the inner
2284 * rel.
2285 */
2286 if (PATH_PARAM_BY_REL(outerpath, innerrel))
2287 continue;
2288
2289 foreach(lc2, innerrel->cheapest_parameterized_paths)
2290 {
2291 Path *innerpath = (Path *) lfirst(lc2);
2292
2293 /*
2294 * We cannot use an inner path that is parameterized by the
2295 * outer rel, either.
2296 */
2297 if (PATH_PARAM_BY_REL(innerpath, outerrel))
2298 continue;
2299
2302 continue; /* already tried it */
2303
2305 joinrel,
2306 outerpath,
2307 innerpath,
2308 hashclauses,
2309 jointype,
2310 extra);
2311 }
2312 }
2313
2314 /*
2315 * If the joinrel is parallel-safe, we may be able to consider a
2316 * partial hash join.
2317 *
2318 * However, we can't handle JOIN_RIGHT_SEMI, because the hash table is
2319 * either a shared hash table or a private hash table per backend. In
2320 * the shared case, there is no concurrency protection for the match
2321 * flags, so multiple workers could inspect and set the flags
2322 * concurrently, potentially producing incorrect results. In the
2323 * private case, each worker has its own copy of the hash table, so no
2324 * single process has all the match flags.
2325 *
2326 * Also, the resulting path must not be parameterized.
2327 */
2328 if (joinrel->consider_parallel &&
2329 jointype != JOIN_RIGHT_SEMI &&
2330 outerrel->partial_pathlist != NIL &&
2331 bms_is_empty(joinrel->lateral_relids))
2332 {
2336
2338 (Path *) linitial(outerrel->partial_pathlist);
2339
2340 /*
2341 * Can we use a partial inner plan too, so that we can build a
2342 * shared hash table in parallel?
2343 */
2344 if (innerrel->partial_pathlist != NIL &&
2346 {
2348 (Path *) linitial(innerrel->partial_pathlist);
2352 hashclauses, jointype, extra,
2353 true /* parallel_hash */ );
2354 }
2355
2356 /*
2357 * Normally, given that the joinrel is parallel-safe, the cheapest
2358 * total inner path will also be parallel-safe, but if not, we'll
2359 * have to search for the cheapest safe, unparameterized inner
2360 * path. If full, right, or right-anti join, we can't use
2361 * parallelism (building the hash table in each backend) because
2362 * no one process has all the match bits.
2363 */
2364 if (jointype == JOIN_FULL ||
2365 jointype == JOIN_RIGHT ||
2366 jointype == JOIN_RIGHT_ANTI)
2368 else if (cheapest_total_inner->parallel_safe)
2370 else
2373
2378 hashclauses, jointype, extra,
2379 false /* parallel_hash */ );
2380 }
2381 }
2382}
2383
2384/*
2385 * select_mergejoin_clauses
2386 * Select mergejoin clauses that are usable for a particular join.
2387 * Returns a list of RestrictInfo nodes for those clauses.
2388 *
2389 * *mergejoin_allowed is normally set to true, but it is set to false if
2390 * this is a right-semi join, or this is a right/right-anti/full join and
2391 * there are nonmergejoinable join clauses. The executor's mergejoin
2392 * machinery cannot handle such cases, so we have to avoid generating a
2393 * mergejoin plan. (Note that this flag does NOT consider whether there are
2394 * actually any mergejoinable clauses. This is correct because in some
2395 * cases we need to build a clauseless mergejoin. Simply returning NIL is
2396 * therefore not enough to distinguish safe from unsafe cases.)
2397 *
2398 * We also mark each selected RestrictInfo to show which side is currently
2399 * being considered as outer. These are transient markings that are only
2400 * good for the duration of the current add_paths_to_joinrel() call!
2401 *
2402 * We examine each restrictinfo clause known for the join to see
2403 * if it is mergejoinable and involves vars from the two sub-relations
2404 * currently of interest.
2405 */
2406static List *
2408 RelOptInfo *joinrel,
2409 RelOptInfo *outerrel,
2410 RelOptInfo *innerrel,
2411 List *restrictlist,
2412 JoinType jointype,
2413 bool *mergejoin_allowed)
2414{
2415 List *result_list = NIL;
2416 bool isouterjoin = IS_OUTER_JOIN(jointype);
2417 bool have_nonmergeable_joinclause = false;
2418 ListCell *l;
2419
2420 /*
2421 * For now we do not support RIGHT_SEMI join in mergejoin: the benefit of
2422 * swapping inputs tends to be small here.
2423 */
2424 if (jointype == JOIN_RIGHT_SEMI)
2425 {
2426 *mergejoin_allowed = false;
2427 return NIL;
2428 }
2429
2430 foreach(l, restrictlist)
2431 {
2433
2434 /*
2435 * If processing an outer join, only use its own join clauses in the
2436 * merge. For inner joins we can use pushed-down clauses too. (Note:
2437 * we don't set have_nonmergeable_joinclause here because pushed-down
2438 * clauses will become otherquals not joinquals.)
2439 */
2441 continue;
2442
2443 /* Check that clause is a mergeable operator clause */
2444 if (!restrictinfo->can_join ||
2445 restrictinfo->mergeopfamilies == NIL)
2446 {
2447 /*
2448 * The executor can handle extra joinquals that are constants, but
2449 * not anything else, when doing right/right-anti/full merge join.
2450 * (The reason to support constants is so we can do FULL JOIN ON
2451 * FALSE.)
2452 */
2453 if (!restrictinfo->clause || !IsA(restrictinfo->clause, Const))
2455 continue; /* not mergejoinable */
2456 }
2457
2458 /*
2459 * Check if clause has the form "outer op inner" or "inner op outer".
2460 */
2462 innerrel->relids))
2463 {
2465 continue; /* no good for these input relations */
2466 }
2467
2468 /*
2469 * If clause has the form "inner op outer", check if its operator has
2470 * valid commutator. This is necessary because mergejoin clauses in
2471 * this form will get commuted in createplan.c to put the outer var on
2472 * the left (see get_switched_clauses). This probably shouldn't ever
2473 * fail, since mergejoinable operators ought to have commutators, but
2474 * be paranoid.
2475 *
2476 * The clause being mergejoinable indicates that it's an OpExpr.
2477 */
2478 if (!restrictinfo->outer_is_left &&
2480 {
2482 continue;
2483 }
2484
2485 /*
2486 * Insist that each side have a non-redundant eclass. This
2487 * restriction is needed because various bits of the planner expect
2488 * that each clause in a merge be associable with some pathkey in a
2489 * canonical pathkey list, but redundant eclasses can't appear in
2490 * canonical sort orderings. (XXX it might be worth relaxing this,
2491 * but not enough time to address it for 8.3.)
2492 */
2494
2495 if (EC_MUST_BE_REDUNDANT(restrictinfo->left_ec) ||
2497 {
2499 continue; /* can't handle redundant eclasses */
2500 }
2501
2503 }
2504
2505 /*
2506 * Report whether mergejoin is allowed (see comment at top of function).
2507 */
2508 switch (jointype)
2509 {
2510 case JOIN_RIGHT:
2511 case JOIN_RIGHT_ANTI:
2512 case JOIN_FULL:
2514 break;
2515 default:
2516 *mergejoin_allowed = true;
2517 break;
2518 }
2519
2520 return result_list;
2521}
bool innerrel_is_unique(PlannerInfo *root, Relids joinrelids, Relids outerrelids, RelOptInfo *innerrel, JoinType jointype, List *restrictlist, bool force_cache)
Bitmapset * bms_difference(const Bitmapset *a, const Bitmapset *b)
Definition bitmapset.c:346
Bitmapset * bms_intersect(const Bitmapset *a, const Bitmapset *b)
Definition bitmapset.c:292
bool bms_equal(const Bitmapset *a, const Bitmapset *b)
Definition bitmapset.c:142
bool bms_is_subset(const Bitmapset *a, const Bitmapset *b)
Definition bitmapset.c:412
void bms_free(Bitmapset *a)
Definition bitmapset.c:239
bool bms_is_member(int x, const Bitmapset *a)
Definition bitmapset.c:510
Bitmapset * bms_add_members(Bitmapset *a, const Bitmapset *b)
Definition bitmapset.c:901
BMS_Membership bms_membership(const Bitmapset *a)
Definition bitmapset.c:765
bool bms_overlap(const Bitmapset *a, const Bitmapset *b)
Definition bitmapset.c:575
Bitmapset * bms_join(Bitmapset *a, Bitmapset *b)
Definition bitmapset.c:1214
bool bms_nonempty_difference(const Bitmapset *a, const Bitmapset *b)
Definition bitmapset.c:634
#define bms_is_empty(a)
Definition bitmapset.h:118
@ BMS_MULTIPLE
Definition bitmapset.h:73
#define Assert(condition)
Definition c.h:945
uint64_t uint64
Definition c.h:619
#define OidIsValid(objectId)
Definition c.h:860
bool contain_volatile_functions(Node *clause)
Definition clauses.c:549
void compute_semi_anti_join_factors(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, SpecialJoinInfo *sjinfo, List *restrictlist, SemiAntiJoinFactors *semifactors)
Definition costsize.c:5257
void initial_cost_nestloop(PlannerInfo *root, JoinCostWorkspace *workspace, JoinType jointype, uint64 enable_mask, Path *outer_path, Path *inner_path, JoinPathExtraData *extra)
Definition costsize.c:3373
void initial_cost_hashjoin(PlannerInfo *root, JoinCostWorkspace *workspace, JoinType jointype, List *hashclauses, Path *outer_path, Path *inner_path, JoinPathExtraData *extra, bool parallel_hash)
Definition costsize.c:4297
void initial_cost_mergejoin(PlannerInfo *root, JoinCostWorkspace *workspace, JoinType jointype, List *mergeclauses, Path *outer_path, Path *inner_path, List *outersortkeys, List *innersortkeys, int outer_presorted_keys, JoinPathExtraData *extra)
Definition costsize.c:3658
bool enable_parallel_hash
Definition costsize.c:163
#define ERROR
Definition elog.h:39
#define elog(elevel,...)
Definition elog.h:226
bool ExecMaterializesOutput(NodeTag plantype)
Definition execAmi.c:636
static void try_hashjoin_path(PlannerInfo *root, RelOptInfo *joinrel, Path *outer_path, Path *inner_path, List *hashclauses, JoinType jointype, JoinPathExtraData *extra)
Definition joinpath.c:1269
static List * select_mergejoin_clauses(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, List *restrictlist, JoinType jointype, bool *mergejoin_allowed)
Definition joinpath.c:2407
static void sort_inner_and_outer(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition joinpath.c:1405
static List * extract_lateral_vars_from_PHVs(PlannerInfo *root, Relids innerrelids)
Definition joinpath.c:621
void add_paths_to_joinrel(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, SpecialJoinInfo *sjinfo, List *restrictlist)
Definition joinpath.c:123
static bool paraminfo_get_equal_hashops(PlannerInfo *root, ParamPathInfo *param_info, RelOptInfo *outerrel, RelOptInfo *innerrel, List *ph_lateral_vars, List **param_exprs, List **operators, bool *binary_mode)
Definition joinpath.c:476
static Path * get_memoize_path(PlannerInfo *root, RelOptInfo *innerrel, RelOptInfo *outerrel, Path *inner_path, Path *outer_path, JoinType jointype, JoinPathExtraData *extra)
Definition joinpath.c:712
static void consider_parallel_nestloop(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition joinpath.c:2091
join_path_setup_hook_type join_path_setup_hook
Definition joinpath.c:32
#define PATH_PARAM_BY_PARENT(path, rel)
Definition joinpath.c:39
set_join_pathlist_hook_type set_join_pathlist_hook
Definition joinpath.c:31
static void try_nestloop_path(PlannerInfo *root, RelOptInfo *joinrel, Path *outer_path, Path *inner_path, List *pathkeys, JoinType jointype, uint64 nestloop_subtype, JoinPathExtraData *extra)
Definition joinpath.c:873
static void try_mergejoin_path(PlannerInfo *root, RelOptInfo *joinrel, Path *outer_path, Path *inner_path, List *pathkeys, List *mergeclauses, List *outersortkeys, List *innersortkeys, JoinType jointype, JoinPathExtraData *extra, bool is_partial)
Definition joinpath.c:1075
static void consider_parallel_mergejoin(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra, Path *inner_cheapest_total)
Definition joinpath.c:2051
static void generate_mergejoin_paths(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *innerrel, Path *outerpath, JoinType jointype, JoinPathExtraData *extra, bool useallclauses, Path *inner_cheapest_total, List *merge_pathkeys, bool is_partial)
Definition joinpath.c:1589
static void try_partial_nestloop_path(PlannerInfo *root, RelOptInfo *joinrel, Path *outer_path, Path *inner_path, List *pathkeys, JoinType jointype, uint64 nestloop_subtype, JoinPathExtraData *extra)
Definition joinpath.c:994
static void hash_inner_and_outer(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition joinpath.c:2180
static void try_partial_mergejoin_path(PlannerInfo *root, RelOptInfo *joinrel, Path *outer_path, Path *inner_path, List *pathkeys, List *mergeclauses, List *outersortkeys, List *innersortkeys, JoinType jointype, JoinPathExtraData *extra)
Definition joinpath.c:1191
#define PATH_PARAM_BY_REL(path, rel)
Definition joinpath.c:45
static bool allow_star_schema_join(PlannerInfo *root, Relids outerrelids, Relids inner_paramrels)
Definition joinpath.c:400
static void try_partial_hashjoin_path(PlannerInfo *root, RelOptInfo *joinrel, Path *outer_path, Path *inner_path, List *hashclauses, JoinType jointype, JoinPathExtraData *extra, bool parallel_hash)
Definition joinpath.c:1346
static void match_unsorted_outer(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition joinpath.c:1829
List * lappend(List *list, void *datum)
Definition list.c:339
List * list_delete_nth_cell(List *list, int n)
Definition list.c:767
List * list_concat(List *list1, const List *list2)
Definition list.c:561
List * list_copy(const List *oldlist)
Definition list.c:1573
List * lappend_oid(List *list, Oid datum)
Definition list.c:375
List * lcons(void *datum, List *list)
Definition list.c:495
void list_free(List *list)
Definition list.c:1546
List * list_truncate(List *list, int new_size)
Definition list.c:631
bool list_member(const List *list, const void *datum)
Definition list.c:661
Oid get_commutator(Oid opno)
Definition lsyscache.c:1729
Oid exprType(const Node *expr)
Definition nodeFuncs.c:42
#define IsA(nodeptr, _type_)
Definition nodes.h:164
#define IS_OUTER_JOIN(jointype)
Definition nodes.h:348
#define castNode(_type_, nodeptr)
Definition nodes.h:182
JoinType
Definition nodes.h:298
@ JOIN_SEMI
Definition nodes.h:317
@ JOIN_FULL
Definition nodes.h:305
@ JOIN_INNER
Definition nodes.h:303
@ JOIN_RIGHT
Definition nodes.h:306
@ JOIN_RIGHT_SEMI
Definition nodes.h:319
@ JOIN_LEFT
Definition nodes.h:304
@ JOIN_UNIQUE_OUTER
Definition nodes.h:326
@ JOIN_RIGHT_ANTI
Definition nodes.h:320
@ JOIN_UNIQUE_INNER
Definition nodes.h:327
@ JOIN_ANTI
Definition nodes.h:318
Path * get_cheapest_path_for_pathkeys(List *paths, List *pathkeys, Relids required_outer, CostSelector cost_criterion, bool require_parallel_safe)
Definition pathkeys.c:620
bool pathkeys_count_contained_in(List *keys1, List *keys2, int *n_common)
Definition pathkeys.c:558
List * make_inner_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, List *outer_pathkeys)
Definition pathkeys.c:1858
List * find_mergeclauses_for_outer_pathkeys(PlannerInfo *root, List *pathkeys, List *restrictinfos)
Definition pathkeys.c:1544
void update_mergeclause_eclasses(PlannerInfo *root, RestrictInfo *restrictinfo)
Definition pathkeys.c:1510
List * trim_mergeclauses_for_inner_pathkeys(PlannerInfo *root, List *mergeclauses, List *pathkeys)
Definition pathkeys.c:1961
List * select_outer_pathkeys_for_merge(PlannerInfo *root, List *mergeclauses, RelOptInfo *joinrel)
Definition pathkeys.c:1659
bool pathkeys_contained_in(List *keys1, List *keys2)
Definition pathkeys.c:343
List * build_join_pathkeys(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, List *outer_pathkeys)
Definition pathkeys.c:1295
Path * get_cheapest_parallel_safe_total_inner(List *paths)
Definition pathkeys.c:699
Relids calc_non_nestloop_required_outer(Path *outer_path, Path *inner_path)
Definition pathnode.c:2304
bool path_is_reparameterizable_by_child(Path *path, RelOptInfo *child_rel)
Definition pathnode.c:4382
MemoizePath * create_memoize_path(PlannerInfo *root, RelOptInfo *rel, Path *subpath, List *param_exprs, List *hash_operators, bool singlerow, bool binary_mode, Cardinality est_calls)
Definition pathnode.c:1746
MaterialPath * create_material_path(RelOptInfo *rel, Path *subpath, bool enabled)
Definition pathnode.c:1712
bool add_partial_path_precheck(RelOptInfo *parent_rel, int disabled_nodes, Cost startup_cost, Cost total_cost, List *pathkeys)
Definition pathnode.c:912
Relids calc_nestloop_required_outer(Relids outerrelids, Relids outer_paramrels, Relids innerrelids, Relids inner_paramrels)
Definition pathnode.c:2277
HashPath * create_hashjoin_path(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, JoinCostWorkspace *workspace, JoinPathExtraData *extra, Path *outer_path, Path *inner_path, bool parallel_hash, List *restrict_clauses, Relids required_outer, List *hashclauses)
Definition pathnode.c:2521
void add_partial_path(RelOptInfo *parent_rel, Path *new_path)
Definition pathnode.c:793
void add_path(RelOptInfo *parent_rel, Path *new_path)
Definition pathnode.c:459
int compare_path_costs(Path *path1, Path *path2, CostSelector criterion)
Definition pathnode.c:68
bool add_path_precheck(RelOptInfo *parent_rel, int disabled_nodes, Cost startup_cost, Cost total_cost, List *pathkeys, Relids required_outer)
Definition pathnode.c:686
MergePath * create_mergejoin_path(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, JoinCostWorkspace *workspace, JoinPathExtraData *extra, Path *outer_path, Path *inner_path, List *restrict_clauses, List *pathkeys, Relids required_outer, List *mergeclauses, List *outersortkeys, List *innersortkeys, int outer_presorted_keys)
Definition pathnode.c:2453
NestPath * create_nestloop_path(PlannerInfo *root, RelOptInfo *joinrel, JoinType jointype, JoinCostWorkspace *workspace, JoinPathExtraData *extra, Path *outer_path, Path *inner_path, List *restrict_clauses, List *pathkeys, Relids required_outer)
Definition pathnode.c:2356
#define PGS_NESTLOOP_MEMOIZE
Definition pathnodes.h:76
#define EC_MUST_BE_REDUNDANT(eclass)
Definition pathnodes.h:1672
#define PGS_FOREIGNJOIN
Definition pathnodes.h:71
#define RINFO_IS_PUSHED_DOWN(rinfo, joinrelids)
Definition pathnodes.h:3045
#define PGS_NESTLOOP_MATERIALIZE
Definition pathnodes.h:75
#define PGS_HASHJOIN
Definition pathnodes.h:77
@ TOTAL_COST
Definition pathnodes.h:111
@ STARTUP_COST
Definition pathnodes.h:111
#define PGS_CONSIDER_NONPARTIAL
Definition pathnodes.h:84
#define PATH_REQ_OUTER(path)
Definition pathnodes.h:2003
#define PGS_MERGEJOIN_ANY
Definition pathnodes.h:92
#define RELATION_WAS_MADE_UNIQUE(rel, sjinfo, nominal_jointype)
Definition pathnodes.h:1238
@ RELOPT_OTHER_JOINREL
Definition pathnodes.h:968
#define PGS_NESTLOOP_PLAIN
Definition pathnodes.h:74
void(* join_path_setup_hook_type)(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition paths.h:32
void(* set_join_pathlist_hook_type)(PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outerrel, RelOptInfo *innerrel, JoinType jointype, JoinPathExtraData *extra)
Definition paths.h:46
#define lfirst(lc)
Definition pg_list.h:172
static int list_length(const List *l)
Definition pg_list.h:152
#define NIL
Definition pg_list.h:68
#define foreach_current_index(var_or_cell)
Definition pg_list.h:403
#define linitial(l)
Definition pg_list.h:178
#define lsecond(l)
Definition pg_list.h:183
#define foreach_node(type, var, lst)
Definition pg_list.h:496
static ListCell * list_head(const List *l)
Definition pg_list.h:128
PlaceHolderInfo * find_placeholder_info(PlannerInfo *root, PlaceHolderVar *phv)
Definition placeholder.c:83
#define InvalidOid
unsigned int Oid
static int fb(int x)
tree ctl root
Definition radixtree.h:1857
static bool clause_sides_match_join(RestrictInfo *rinfo, Relids outerrelids, Relids innerrelids)
List * mergeclause_list
Definition pathnodes.h:3594
Relids param_source_rels
Definition pathnodes.h:3598
SemiAntiJoinFactors semifactors
Definition pathnodes.h:3597
SpecialJoinInfo * sjinfo
Definition pathnodes.h:3596
Definition pg_list.h:54
Definition nodes.h:135
List * args
Definition primnodes.h:869
List * baserestrictinfo
Definition pathnodes.h:1130
Relids relids
Definition pathnodes.h:1009
struct PathTarget * reltarget
Definition pathnodes.h:1033
List * lateral_vars
Definition pathnodes.h:1075
uint64 pgs_mask
Definition pathnodes.h:1027
bool consider_parallel
Definition pathnodes.h:1025
Relids top_parent_relids
Definition pathnodes.h:1162
Relids lateral_relids
Definition pathnodes.h:1052
List * cheapest_parameterized_paths
Definition pathnodes.h:1043
List * pathlist
Definition pathnodes.h:1038
RelOptKind reloptkind
Definition pathnodes.h:1003
struct Path * cheapest_startup_path
Definition pathnodes.h:1041
struct Path * cheapest_total_path
Definition pathnodes.h:1042
List * partial_pathlist
Definition pathnodes.h:1040
Expr * clause
Definition pathnodes.h:2888
Relids min_righthand
Definition pathnodes.h:3214
JoinType jointype
Definition pathnodes.h:3217
Relids min_lefthand
Definition pathnodes.h:3213
int varno
Definition primnodes.h:270
Index varlevelsup
Definition primnodes.h:295
TypeCacheEntry * lookup_type_cache(Oid type_id, int flags)
Definition typcache.c:389
#define TYPECACHE_EQ_OPR
Definition typcache.h:138
#define TYPECACHE_HASH_PROC
Definition typcache.h:142
Relids pull_varnos(PlannerInfo *root, Node *node)
Definition var.c:114
List * pull_vars_of_level(Node *node, int levelsup)
Definition var.c:339