placeholder.h File Reference

#include "nodes/relation.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, bool create_new_ph)
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)
void	add_placeholders_to_child_joinrel (PlannerInfo *root, RelOptInfo *childrel, RelOptInfo *parentrel)

Function Documentation

add_placeholders_to_base_rels()

void add_placeholders_to_base_rels

(

PlannerInfo *

root

)

Definition at line 380 of file placeholder.c.

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().

{
    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 */
        }
    }
}

add_placeholders_to_child_joinrel()

void add_placeholders_to_child_joinrel	(	PlannerInfo *	root,
		RelOptInfo *	childrel,
		RelOptInfo *	parentrel
	)

Definition at line 474 of file placeholder.c.

References adjust_appendrel_attrs(), Assert, bms_overlap(), PathTarget::cost, PathTarget::exprs, find_appinfos_by_relids(), IS_JOIN_REL, IS_OTHER_REL, IsA, lappend(), lfirst, NIL, QualCost::per_tuple, pfree(), PlaceHolderVar::phrels, PlannerInfo::placeholder_list, RelOptInfo::relids, RELOPT_OTHER_JOINREL, RelOptInfo::reloptkind, RelOptInfo::reltarget, QualCost::startup, and PathTarget::width.

Referenced by build_child_join_rel().

{
    ListCell   *lc;
    AppendRelInfo **appinfos;
    int         nappinfos;

    Assert(IS_JOIN_REL(childrel) && IS_JOIN_REL(parentrel));
    Assert(IS_OTHER_REL(childrel));

    /* Nothing to do if no PHVs. */
    if (root->placeholder_list == NIL)
        return;

    appinfos = find_appinfos_by_relids(root, childrel->relids, &nappinfos);
    foreach(lc, parentrel->reltarget->exprs)
    {
        PlaceHolderVar *phv = lfirst(lc);

        if (IsA(phv, PlaceHolderVar))
        {
            /*
             * In case the placeholder Var refers to any of the parent
             * relations, translate it to refer to the corresponding child.
             */
            if (bms_overlap(phv->phrels, parentrel->relids) &&
                childrel->reloptkind == RELOPT_OTHER_JOINREL)
            {
                phv = (PlaceHolderVar *) adjust_appendrel_attrs(root,
                                                                (Node *) phv,
                                                                nappinfos,
                                                                appinfos);
            }

            childrel->reltarget->exprs = lappend(childrel->reltarget->exprs,
                                                 phv);
        }
    }

    /* Adjust the cost and width of child targetlist. */
    childrel->reltarget->cost.startup = parentrel->reltarget->cost.startup;
    childrel->reltarget->cost.per_tuple = parentrel->reltarget->cost.per_tuple;
    childrel->reltarget->width = parentrel->reltarget->width;

    pfree(appinfos);
}

add_placeholders_to_joinrel()

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

Definition at line 412 of file placeholder.c.

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

Referenced by build_join_rel().

{
    Relids      relids = joinrel->relids;
    ListCell   *lc;

    /* This function is called only on the parent relations. */
    Assert(!IS_OTHER_REL(joinrel) && !IS_OTHER_REL(outer_rel) &&
           !IS_OTHER_REL(inner_rel));

    foreach(lc, root->placeholder_list)
    {
        PlaceHolderInfo *phinfo = (PlaceHolderInfo *) lfirst(lc);

        /* Is it still needed above this joinrel? */
        if (bms_nonempty_difference(phinfo->ph_needed, relids))
        {
            /* Is it computable here? */
            if (bms_is_subset(phinfo->ph_eval_at, relids))
            {
                /* Yup, add it to the output */
                joinrel->reltarget->exprs = lappend(joinrel->reltarget->exprs,
                                                    phinfo->ph_var);
                joinrel->reltarget->width += phinfo->ph_width;

                /*
                 * 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))
                {
                    QualCost    cost;

                    cost_qual_eval_node(&cost, (Node *) phinfo->ph_var->phexpr,
                                        root);
                    joinrel->reltarget->cost.startup += cost.startup;
                    joinrel->reltarget->cost.per_tuple += cost.per_tuple;
                }

                /* Adjust joinrel's direct_lateral_relids as needed */
                joinrel->direct_lateral_relids =
                    bms_add_members(joinrel->direct_lateral_relids,
                                    phinfo->ph_lateral);
            }
        }
    }
}

find_placeholder_info()

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

Definition at line 70 of file placeholder.c.

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

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

{
    PlaceHolderInfo *phinfo;
    Relids      rels_used;
    ListCell   *lc;

    /* if this ever isn't true, we'd need to be able to look in parent lists */
    Assert(phv->phlevelsup == 0);

    foreach(lc, root->placeholder_list)
    {
        phinfo = (PlaceHolderInfo *) lfirst(lc);
        if (phinfo->phid == phv->phid)
            return phinfo;
    }

    /* Not found, so create it */
    if (!create_new_ph)
        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((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));

    root->placeholder_list = lappend(root->placeholder_list, 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;
}

find_placeholders_in_jointree()

void find_placeholders_in_jointree

(

PlannerInfo *

root

)

Definition at line 145 of file placeholder.c.

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

Referenced by query_planner().

{
    /* 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);
    }
}

fix_placeholder_input_needed_levels()

void fix_placeholder_input_needed_levels

(

PlannerInfo *

root

)

Definition at line 351 of file placeholder.c.

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

Referenced by query_planner().

{
    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, false);
        list_free(vars);
    }
}

make_placeholder_expr()

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

Definition at line 40 of file placeholder.c.

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

Referenced by pullup_replace_vars_callback().

{
    PlaceHolderVar *phv = makeNode(PlaceHolderVar);

    phv->phexpr = expr;
    phv->phrels = phrels;
    phv->phid = ++(root->glob->lastPHId);
    phv->phlevelsup = 0;

    return phv;
}

update_placeholder_eval_levels()

void update_placeholder_eval_levels	(	PlannerInfo *	root,
		SpecialJoinInfo *	new_sjinfo
	)

Definition at line 266 of file placeholder.c.

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, PlaceHolderVar::phrels, PlannerInfo::placeholder_list, SpecialJoinInfo::syn_lefthand, and SpecialJoinInfo::syn_righthand.

Referenced by deconstruct_recurse().

{
    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;
    }
}