placeholder.h File Reference

#include "nodes/pathnodes.h"

Include dependency graph for placeholder.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PlaceHolderVar *	make_placeholder_expr (PlannerInfo *root, Expr *expr, Relids phrels)
PlaceHolderInfo *	find_placeholder_info (PlannerInfo *root, PlaceHolderVar *phv)
void	find_placeholders_in_jointree (PlannerInfo *root)
void	update_placeholder_eval_levels (PlannerInfo *root, SpecialJoinInfo *new_sjinfo)
void	fix_placeholder_input_needed_levels (PlannerInfo *root)
void	add_placeholders_to_base_rels (PlannerInfo *root)
void	add_placeholders_to_joinrel (PlannerInfo *root, RelOptInfo *joinrel, RelOptInfo *outer_rel, RelOptInfo *inner_rel)

Function Documentation

add_placeholders_to_base_rels()

void add_placeholders_to_base_rels

(

PlannerInfo *

root

)

Definition at line 401 of file placeholder.c.

{
    ListCell   *lc;
 
    foreach(lc, root->placeholder_list)
    {
        PlaceHolderInfo *phinfo = (PlaceHolderInfo *) lfirst(lc);
        Relids      eval_at = phinfo->ph_eval_at;
        int         varno;
 
        if (bms_get_singleton_member(eval_at, &varno) &&
            bms_nonempty_difference(phinfo->ph_needed, eval_at))
        {
            RelOptInfo *rel = find_base_rel(root, varno);
 
            rel->reltarget->exprs = lappend(rel->reltarget->exprs,
                                            copyObject(phinfo->ph_var));
            /* reltarget's cost and width fields will be updated later */
        }
    }
}

References bms_get_singleton_member(), bms_nonempty_difference(), copyObject, PathTarget::exprs, find_base_rel(), lappend(), lfirst, PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_needed, PlaceHolderInfo::ph_var, PlannerInfo::placeholder_list, and RelOptInfo::reltarget.

Referenced by query_planner().

add_placeholders_to_joinrel()

void add_placeholders_to_joinrel	(	PlannerInfo *	root,
		RelOptInfo *	joinrel,
		RelOptInfo *	outer_rel,
		RelOptInfo *	inner_rel
	)

Definition at line 437 of file placeholder.c.

{
    Relids      relids = joinrel->relids;
    ListCell   *lc;
 
    foreach(lc, root->placeholder_list)
    {
        PlaceHolderInfo *phinfo = (PlaceHolderInfo *) lfirst(lc);
 
        /* Is it computable here? */
        if (bms_is_subset(phinfo->ph_eval_at, relids))
        {
            /* Is it still needed above this joinrel? */
            if (bms_nonempty_difference(phinfo->ph_needed, relids))
            {
                /*
                 * Yes, but only add to tlist if it wasn't computed in either
                 * input; otherwise it should be there already.  Also, we
                 * charge the cost of evaluating the contained expression if
                 * the PHV can be computed here but not in either input.  This
                 * is a bit bogus because we make the decision based on the
                 * first pair of possible input relations considered for the
                 * joinrel.  With other pairs, it might be possible to compute
                 * the PHV in one input or the other, and then we'd be double
                 * charging the PHV's cost for some join paths.  For now, live
                 * with that; but we might want to improve it later by
                 * refiguring the reltarget costs for each pair of inputs.
                 */
                if (!bms_is_subset(phinfo->ph_eval_at, outer_rel->relids) &&
                    !bms_is_subset(phinfo->ph_eval_at, inner_rel->relids))
                {
                    PlaceHolderVar *phv = phinfo->ph_var;
                    QualCost    cost;
 
                    joinrel->reltarget->exprs = lappend(joinrel->reltarget->exprs,
                                                        phv);
                    cost_qual_eval_node(&cost, (Node *) phv->phexpr, root);
                    joinrel->reltarget->cost.startup += cost.startup;
                    joinrel->reltarget->cost.per_tuple += cost.per_tuple;
                    joinrel->reltarget->width += phinfo->ph_width;
                }
            }
 
            /*
             * Also adjust joinrel's direct_lateral_relids to include the
             * PHV's source rel(s).  We must do this even if we're not
             * actually going to emit the PHV, otherwise join_is_legal() will
             * reject valid join orderings.  (In principle maybe we could
             * instead remove the joinrel's lateral_relids dependency; but
             * that's complicated to get right, and cases where we're not
             * going to emit the PHV are too rare to justify the work.)
             *
             * In principle we should only do this if the join doesn't yet
             * include the PHV's source rel(s).  But our caller
             * build_join_rel() will clean things up by removing the join's
             * own relids from its direct_lateral_relids, so we needn't
             * account for that here.
             */
            joinrel->direct_lateral_relids =
                bms_add_members(joinrel->direct_lateral_relids,
                                phinfo->ph_lateral);
        }
    }
}

References bms_add_members(), bms_is_subset(), bms_nonempty_difference(), PathTarget::cost, cost_qual_eval_node(), RelOptInfo::direct_lateral_relids, PathTarget::exprs, lappend(), lfirst, QualCost::per_tuple, PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_lateral, PlaceHolderInfo::ph_needed, PlaceHolderInfo::ph_var, PlaceHolderInfo::ph_width, PlannerInfo::placeholder_list, RelOptInfo::relids, RelOptInfo::reltarget, QualCost::startup, and PathTarget::width.

Referenced by build_join_rel().

find_placeholder_info()

PlaceHolderInfo* find_placeholder_info	(	PlannerInfo *	root,
		PlaceHolderVar *	phv
	)

Definition at line 67 of file placeholder.c.

{
    PlaceHolderInfo *phinfo;
    Relids      rels_used;
 
    /* if this ever isn't true, we'd need to be able to look in parent lists */
    Assert(phv->phlevelsup == 0);
 
    /* Use placeholder_array to look up existing PlaceHolderInfo quickly */
    if (phv->phid < root->placeholder_array_size)
        phinfo = root->placeholder_array[phv->phid];
    else
        phinfo = NULL;
    if (phinfo != NULL)
    {
        Assert(phinfo->phid == phv->phid);
        return phinfo;
    }
 
    /* Not found, so create it */
    if (root->placeholdersFrozen)
        elog(ERROR, "too late to create a new PlaceHolderInfo");
 
    phinfo = makeNode(PlaceHolderInfo);
 
    phinfo->phid = phv->phid;
    phinfo->ph_var = copyObject(phv);
 
    /*
     * Any referenced rels that are outside the PHV's syntactic scope are
     * LATERAL references, which should be included in ph_lateral but not in
     * ph_eval_at.  If no referenced rels are within the syntactic scope,
     * force evaluation at the syntactic location.
     */
    rels_used = pull_varnos(root, (Node *) phv->phexpr);
    phinfo->ph_lateral = bms_difference(rels_used, phv->phrels);
    if (bms_is_empty(phinfo->ph_lateral))
        phinfo->ph_lateral = NULL;  /* make it exactly NULL if empty */
    phinfo->ph_eval_at = bms_int_members(rels_used, phv->phrels);
    /* If no contained vars, force evaluation at syntactic location */
    if (bms_is_empty(phinfo->ph_eval_at))
    {
        phinfo->ph_eval_at = bms_copy(phv->phrels);
        Assert(!bms_is_empty(phinfo->ph_eval_at));
    }
    /* ph_eval_at may change later, see update_placeholder_eval_levels */
    phinfo->ph_needed = NULL;   /* initially it's unused */
    /* for the moment, estimate width using just the datatype info */
    phinfo->ph_width = get_typavgwidth(exprType((Node *) phv->phexpr),
                                       exprTypmod((Node *) phv->phexpr));
 
    /*
     * Add to both placeholder_list and placeholder_array.  Note: because we
     * store pointers to the PlaceHolderInfos in two data structures, it'd be
     * unsafe to pass the whole placeholder_list structure through
     * expression_tree_mutator or the like --- or at least, you'd have to
     * rebuild the placeholder_array afterwards.
     */
    root->placeholder_list = lappend(root->placeholder_list, phinfo);
 
    if (phinfo->phid >= root->placeholder_array_size)
    {
        /* Must allocate or enlarge placeholder_array */
        int         new_size;
 
        new_size = root->placeholder_array_size ? root->placeholder_array_size * 2 : 8;
        while (phinfo->phid >= new_size)
            new_size *= 2;
        if (root->placeholder_array)
            root->placeholder_array =
                repalloc0_array(root->placeholder_array, PlaceHolderInfo *, root->placeholder_array_size, new_size);
        else
            root->placeholder_array =
                palloc0_array(PlaceHolderInfo *, new_size);
        root->placeholder_array_size = new_size;
    }
    root->placeholder_array[phinfo->phid] = phinfo;
 
    /*
     * The PHV's contained expression may contain other, lower-level PHVs.  We
     * now know we need to get those into the PlaceHolderInfo list, too, so we
     * may as well do that immediately.
     */
    find_placeholders_in_expr(root, (Node *) phinfo->ph_var->phexpr);
 
    return phinfo;
}

References Assert(), bms_copy(), bms_difference(), bms_int_members(), bms_is_empty(), copyObject, elog(), ERROR, exprType(), exprTypmod(), find_placeholders_in_expr(), get_typavgwidth(), lappend(), makeNode, palloc0_array, PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_lateral, PlaceHolderInfo::ph_needed, PlaceHolderInfo::ph_var, PlaceHolderInfo::ph_width, PlaceHolderVar::phid, PlaceHolderInfo::phid, PlaceHolderVar::phlevelsup, PlannerInfo::placeholder_list, PlannerInfo::placeholdersFrozen, pull_varnos(), and repalloc0_array.

Referenced by add_vars_to_targetlist(), build_joinrel_tlist(), create_lateral_join_info(), find_placeholders_in_expr(), identify_current_nestloop_params(), process_subquery_nestloop_params(), replace_nestloop_params_mutator(), and set_rel_width().

find_placeholders_in_jointree()

void find_placeholders_in_jointree

(

PlannerInfo *

root

)

Definition at line 163 of file placeholder.c.

{
    /* This must be done before freezing the set of PHIs */
    Assert(!root->placeholdersFrozen);
 
    /* We need do nothing if the query contains no PlaceHolderVars */
    if (root->glob->lastPHId != 0)
    {
        /* Start recursion at top of jointree */
        Assert(root->parse->jointree != NULL &&
               IsA(root->parse->jointree, FromExpr));
        find_placeholders_recurse(root, (Node *) root->parse->jointree);
    }
}

References Assert(), find_placeholders_recurse(), PlannerInfo::glob, IsA, Query::jointree, PlannerGlobal::lastPHId, PlannerInfo::parse, and PlannerInfo::placeholdersFrozen.

Referenced by query_planner().

fix_placeholder_input_needed_levels()

void fix_placeholder_input_needed_levels

(

PlannerInfo *

root

)

Definition at line 372 of file placeholder.c.

{
    ListCell   *lc;
 
    foreach(lc, root->placeholder_list)
    {
        PlaceHolderInfo *phinfo = (PlaceHolderInfo *) lfirst(lc);
        List       *vars = pull_var_clause((Node *) phinfo->ph_var->phexpr,
                                           PVC_RECURSE_AGGREGATES |
                                           PVC_RECURSE_WINDOWFUNCS |
                                           PVC_INCLUDE_PLACEHOLDERS);
 
        add_vars_to_targetlist(root, vars, phinfo->ph_eval_at);
        list_free(vars);
    }
}

References add_vars_to_targetlist(), lfirst, list_free(), PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_var, PlannerInfo::placeholder_list, pull_var_clause(), PVC_INCLUDE_PLACEHOLDERS, PVC_RECURSE_AGGREGATES, and PVC_RECURSE_WINDOWFUNCS.

Referenced by query_planner().

make_placeholder_expr()

PlaceHolderVar* make_placeholder_expr	(	PlannerInfo *	root,
		Expr *	expr,
		Relids	phrels
	)

Definition at line 39 of file placeholder.c.

{
    PlaceHolderVar *phv = makeNode(PlaceHolderVar);
 
    phv->phexpr = expr;
    phv->phrels = phrels;
    phv->phid = ++(root->glob->lastPHId);
    phv->phlevelsup = 0;
 
    return phv;
}

References PlannerInfo::glob, PlannerGlobal::lastPHId, makeNode, PlaceHolderVar::phid, and PlaceHolderVar::phlevelsup.

Referenced by pullup_replace_vars_callback().

update_placeholder_eval_levels()

void update_placeholder_eval_levels	(	PlannerInfo *	root,
		SpecialJoinInfo *	new_sjinfo
	)

Definition at line 287 of file placeholder.c.

{
    ListCell   *lc1;
 
    foreach(lc1, root->placeholder_list)
    {
        PlaceHolderInfo *phinfo = (PlaceHolderInfo *) lfirst(lc1);
        Relids      syn_level = phinfo->ph_var->phrels;
        Relids      eval_at;
        bool        found_some;
        ListCell   *lc2;
 
        /*
         * We don't need to do any work on this placeholder unless the
         * newly-added outer join is syntactically beneath its location.
         */
        if (!bms_is_subset(new_sjinfo->syn_lefthand, syn_level) ||
            !bms_is_subset(new_sjinfo->syn_righthand, syn_level))
            continue;
 
        /*
         * Check for delays due to lower outer joins.  This is the same logic
         * as in check_outerjoin_delay in initsplan.c, except that we don't
         * have anything to do with the delay_upper_joins flags; delay of
         * upper outer joins will be handled later, based on the eval_at
         * values we compute now.
         */
        eval_at = phinfo->ph_eval_at;
 
        do
        {
            found_some = false;
            foreach(lc2, root->join_info_list)
            {
                SpecialJoinInfo *sjinfo = (SpecialJoinInfo *) lfirst(lc2);
 
                /* disregard joins not within the PHV's sub-select */
                if (!bms_is_subset(sjinfo->syn_lefthand, syn_level) ||
                    !bms_is_subset(sjinfo->syn_righthand, syn_level))
                    continue;
 
                /* do we reference any nullable rels of this OJ? */
                if (bms_overlap(eval_at, sjinfo->min_righthand) ||
                    (sjinfo->jointype == JOIN_FULL &&
                     bms_overlap(eval_at, sjinfo->min_lefthand)))
                {
                    /* yes; have we included all its rels in eval_at? */
                    if (!bms_is_subset(sjinfo->min_lefthand, eval_at) ||
                        !bms_is_subset(sjinfo->min_righthand, eval_at))
                    {
                        /* no, so add them in */
                        eval_at = bms_add_members(eval_at,
                                                  sjinfo->min_lefthand);
                        eval_at = bms_add_members(eval_at,
                                                  sjinfo->min_righthand);
                        /* we'll need another iteration */
                        found_some = true;
                    }
                }
            }
        } while (found_some);
 
        /* Can't move the PHV's eval_at level to above its syntactic level */
        Assert(bms_is_subset(eval_at, syn_level));
 
        phinfo->ph_eval_at = eval_at;
    }
}

References Assert(), bms_add_members(), bms_is_subset(), bms_overlap(), JOIN_FULL, PlannerInfo::join_info_list, SpecialJoinInfo::jointype, lfirst, SpecialJoinInfo::min_lefthand, SpecialJoinInfo::min_righthand, PlaceHolderInfo::ph_eval_at, PlaceHolderInfo::ph_var, PlannerInfo::placeholder_list, SpecialJoinInfo::syn_lefthand, and SpecialJoinInfo::syn_righthand.

Referenced by deconstruct_recurse().