restrictinfo.h File Reference

#include "nodes/pathnodes.h"

Include dependency graph for restrictinfo.h:

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

Go to the source code of this file.

Macros
#define	make_simple_restrictinfo(root, clause)

Functions
RestrictInfo *	make_plain_restrictinfo (PlannerInfo *root, Expr *clause, Expr *orclause, bool is_pushed_down, bool has_clone, bool is_clone, bool pseudoconstant, Index security_level, Relids required_relids, Relids incompatible_relids, Relids outer_relids)
RestrictInfo *	make_restrictinfo (PlannerInfo *root, Expr *clause, bool is_pushed_down, bool has_clone, bool is_clone, bool pseudoconstant, Index security_level, Relids required_relids, Relids incompatible_relids, Relids outer_relids)
RestrictInfo *	commute_restrictinfo (RestrictInfo *rinfo, Oid comm_op)
bool	restriction_is_or_clause (RestrictInfo *restrictinfo)
bool	restriction_is_securely_promotable (RestrictInfo *restrictinfo, RelOptInfo *rel)
List *	get_actual_clauses (List *restrictinfo_list)
List *	extract_actual_clauses (List *restrictinfo_list, bool pseudoconstant)
void	extract_actual_join_clauses (List *restrictinfo_list, Relids joinrelids, List **joinquals, List **otherquals)
bool	join_clause_is_movable_to (RestrictInfo *rinfo, RelOptInfo *baserel)
bool	join_clause_is_movable_into (RestrictInfo *rinfo, Relids currentrelids, Relids current_and_outer)
static bool	clause_sides_match_join (RestrictInfo *rinfo, Relids outerrelids, Relids innerrelids)

Macro Definition Documentation

make_simple_restrictinfo

#define make_simple_restrictinfo	(		root,
			clause
	)

Value:

    make_restrictinfo(root, clause, true, false, false, false, 0, \
        NULL, NULL, NULL)

Definition at line 21 of file restrictinfo.h.

Function Documentation

clause_sides_match_join()

static bool clause_sides_match_join ( RestrictInfo *  rinfo, Relids  outerrelids, Relids  innerrelids  )

inlinestatic

Definition at line 73 of file restrictinfo.h.

{
    if (bms_is_subset(rinfo->left_relids, outerrelids) &&
        bms_is_subset(rinfo->right_relids, innerrelids))
    {
        /* lefthand side is outer */
        rinfo->outer_is_left = true;
        return true;
    }
    else if (bms_is_subset(rinfo->left_relids, innerrelids) &&
             bms_is_subset(rinfo->right_relids, outerrelids))
    {
        /* righthand side is outer */
        rinfo->outer_is_left = false;
        return true;
    }
    return false;               /* no good for these input relations */
}

References bms_is_subset().

Referenced by hash_inner_and_outer(), is_innerrel_unique_for(), join_is_removable(), paraminfo_get_equal_hashops(), and select_mergejoin_clauses().

commute_restrictinfo()

RestrictInfo * commute_restrictinfo	(	RestrictInfo *	rinfo,
		Oid	comm_op
	)

Definition at line 350 of file restrictinfo.c.

{
    RestrictInfo *result;
    OpExpr     *newclause;
    OpExpr     *clause = castNode(OpExpr, rinfo->clause);
 
    Assert(list_length(clause->args) == 2);
 
    /* flat-copy all the fields of clause ... */
    newclause = makeNode(OpExpr);
    memcpy(newclause, clause, sizeof(OpExpr));
 
    /* ... and adjust those we need to change to commute it */
    newclause->opno = comm_op;
    newclause->opfuncid = InvalidOid;
    newclause->args = list_make2(lsecond(clause->args),
                                 linitial(clause->args));
 
    /* likewise, flat-copy all the fields of rinfo ... */
    result = makeNode(RestrictInfo);
    memcpy(result, rinfo, sizeof(RestrictInfo));
 
    /*
     * ... and adjust those we need to change.  Note in particular that we can
     * preserve any cached selectivity or cost estimates, since those ought to
     * be the same for the new clause.  Likewise we can keep the source's
     * parent_ec.  It's also important that we keep the same rinfo_serial.
     */
    result->clause = (Expr *) newclause;
    result->left_relids = rinfo->right_relids;
    result->right_relids = rinfo->left_relids;
    Assert(result->orclause == NULL);
    result->left_ec = rinfo->right_ec;
    result->right_ec = rinfo->left_ec;
    result->left_em = rinfo->right_em;
    result->right_em = rinfo->left_em;
    result->scansel_cache = NIL;    /* not worth updating this */
    if (rinfo->hashjoinoperator == clause->opno)
        result->hashjoinoperator = comm_op;
    else
        result->hashjoinoperator = InvalidOid;
    result->left_bucketsize = rinfo->right_bucketsize;
    result->right_bucketsize = rinfo->left_bucketsize;
    result->left_mcvfreq = rinfo->right_mcvfreq;
    result->right_mcvfreq = rinfo->left_mcvfreq;
    result->left_hasheqoperator = InvalidOid;
    result->right_hasheqoperator = InvalidOid;
 
    return result;
}

References OpExpr::args, Assert(), castNode, RestrictInfo::clause, InvalidOid, linitial, list_length(), list_make2, lsecond, makeNode, NIL, and OpExpr::opno.

Referenced by match_opclause_to_indexcol().

extract_actual_clauses()

List * extract_actual_clauses	(	List *	restrictinfo_list,
		bool	pseudoconstant
	)

Definition at line 485 of file restrictinfo.c.

{
    List       *result = NIL;
    ListCell   *l;
 
    foreach(l, restrictinfo_list)
    {
        RestrictInfo *rinfo = lfirst_node(RestrictInfo, l);
 
        if (rinfo->pseudoconstant == pseudoconstant &&
            !rinfo_is_constant_true(rinfo))
            result = lappend(result, rinfo->clause);
    }
    return result;
}

References RestrictInfo::clause, lappend(), lfirst_node, NIL, and rinfo_is_constant_true().

Referenced by create_append_plan(), create_bitmap_scan_plan(), create_ctescan_plan(), create_functionscan_plan(), create_hashjoin_plan(), create_indexscan_plan(), create_merge_append_plan(), create_mergejoin_plan(), create_namedtuplestorescan_plan(), create_nestloop_plan(), create_resultscan_plan(), create_samplescan_plan(), create_seqscan_plan(), create_subqueryscan_plan(), create_tablefuncscan_plan(), create_tidrangescan_plan(), create_tidscan_plan(), create_valuesscan_plan(), create_worktablescan_plan(), fileGetForeignPlan(), get_gating_quals(), and postgresGetForeignPlan().

extract_actual_join_clauses()

void extract_actual_join_clauses	(	List *	restrictinfo_list,
		Relids	joinrelids,
		List **	joinquals,
		List **	otherquals
	)

Definition at line 513 of file restrictinfo.c.

{
    ListCell   *l;
 
    *joinquals = NIL;
    *otherquals = NIL;
 
    foreach(l, restrictinfo_list)
    {
        RestrictInfo *rinfo = lfirst_node(RestrictInfo, l);
 
        if (RINFO_IS_PUSHED_DOWN(rinfo, joinrelids))
        {
            if (!rinfo->pseudoconstant &&
                !rinfo_is_constant_true(rinfo))
                *otherquals = lappend(*otherquals, rinfo->clause);
        }
        else
        {
            /* joinquals shouldn't have been marked pseudoconstant */
            Assert(!rinfo->pseudoconstant);
            if (!rinfo_is_constant_true(rinfo))
                *joinquals = lappend(*joinquals, rinfo->clause);
        }
    }
}

References Assert(), RestrictInfo::clause, lappend(), lfirst_node, NIL, rinfo_is_constant_true(), and RINFO_IS_PUSHED_DOWN.

Referenced by create_hashjoin_plan(), create_mergejoin_plan(), and create_nestloop_plan().

get_actual_clauses()

List * get_actual_clauses

(

List *

restrictinfo_list

)

Definition at line 460 of file restrictinfo.c.

{
    List       *result = NIL;
    ListCell   *l;
 
    foreach(l, restrictinfo_list)
    {
        RestrictInfo *rinfo = lfirst_node(RestrictInfo, l);
 
        Assert(!rinfo->pseudoconstant);
        Assert(!rinfo_is_constant_true(rinfo));
 
        result = lappend(result, rinfo->clause);
    }
    return result;
}

References Assert(), RestrictInfo::clause, lappend(), lfirst_node, NIL, and rinfo_is_constant_true().

Referenced by create_bitmap_subplan(), create_hashjoin_plan(), create_join_plan(), and create_mergejoin_plan().

join_clause_is_movable_into()

bool join_clause_is_movable_into	(	RestrictInfo *	rinfo,
		Relids	currentrelids,
		Relids	current_and_outer
	)

Definition at line 661 of file restrictinfo.c.

{
    /* Clause must be evaluable given available context */
    if (!bms_is_subset(rinfo->clause_relids, current_and_outer))
        return false;
 
    /* Clause must physically reference at least one target rel */
    if (!bms_overlap(currentrelids, rinfo->clause_relids))
        return false;
 
    /* Cannot move an outer-join clause into the join's outer side */
    if (bms_overlap(currentrelids, rinfo->outer_relids))
        return false;
 
    return true;
}

References bms_is_subset(), bms_overlap(), and RestrictInfo::outer_relids.

Referenced by get_baserel_parampathinfo(), get_joinrel_parampathinfo(), and has_indexed_join_quals().

join_clause_is_movable_to()

bool join_clause_is_movable_to	(	RestrictInfo *	rinfo,
		RelOptInfo *	baserel
	)

Definition at line 575 of file restrictinfo.c.

{
    /* Clause must physically reference target rel */
    if (!bms_is_member(baserel->relid, rinfo->clause_relids))
        return false;
 
    /* Cannot move an outer-join clause into the join's outer side */
    if (bms_is_member(baserel->relid, rinfo->outer_relids))
        return false;
 
    /*
     * Target rel's Vars must not be nulled by any outer join.  We can check
     * this without groveling through the individual Vars by seeing whether
     * clause_relids (which includes all such Vars' varnullingrels) includes
     * any outer join that can null the target rel.  You might object that
     * this could reject the clause on the basis of an OJ relid that came from
     * some other rel's Var.  However, that would still mean that the clause
     * came from above that outer join and shouldn't be pushed down; so there
     * should be no false positives.
     */
    if (bms_overlap(rinfo->clause_relids, baserel->nulling_relids))
        return false;
 
    /* Clause must not use any rels with LATERAL references to this rel */
    if (bms_overlap(baserel->lateral_referencers, rinfo->clause_relids))
        return false;
 
    /* Ignore clones, too */
    if (rinfo->is_clone)
        return false;
 
    return true;
}

References bms_is_member(), bms_overlap(), RestrictInfo::is_clone, RelOptInfo::lateral_referencers, RelOptInfo::nulling_relids, RestrictInfo::outer_relids, and RelOptInfo::relid.

Referenced by BuildParameterizedTidPaths(), check_index_predicates(), extract_restriction_or_clauses(), match_join_clauses_to_index(), and postgresGetForeignPaths().

make_plain_restrictinfo()

RestrictInfo * make_plain_restrictinfo	(	PlannerInfo *	root,
		Expr *	clause,
		Expr *	orclause,
		bool	is_pushed_down,
		bool	has_clone,
		bool	is_clone,
		bool	pseudoconstant,
		Index	security_level,
		Relids	required_relids,
		Relids	incompatible_relids,
		Relids	outer_relids
	)

Definition at line 103 of file restrictinfo.c.

{
    RestrictInfo *restrictinfo = makeNode(RestrictInfo);
    Relids      baserels;
 
    restrictinfo->clause = clause;
    restrictinfo->orclause = orclause;
    restrictinfo->is_pushed_down = is_pushed_down;
    restrictinfo->pseudoconstant = pseudoconstant;
    restrictinfo->has_clone = has_clone;
    restrictinfo->is_clone = is_clone;
    restrictinfo->can_join = false; /* may get set below */
    restrictinfo->security_level = security_level;
    restrictinfo->incompatible_relids = incompatible_relids;
    restrictinfo->outer_relids = outer_relids;
 
    /*
     * If it's potentially delayable by lower-level security quals, figure out
     * whether it's leakproof.  We can skip testing this for level-zero quals,
     * since they would never get delayed on security grounds anyway.
     */
    if (security_level > 0)
        restrictinfo->leakproof = !contain_leaked_vars((Node *) clause);
    else
        restrictinfo->leakproof = false;    /* really, "don't know" */
 
    /*
     * Mark volatility as unknown.  The contain_volatile_functions function
     * will determine if there are any volatile functions when called for the
     * first time with this RestrictInfo.
     */
    restrictinfo->has_volatile = VOLATILITY_UNKNOWN;
 
    /*
     * If it's a binary opclause, set up left/right relids info. In any case
     * set up the total clause relids info.
     */
    if (is_opclause(clause) && list_length(((OpExpr *) clause)->args) == 2)
    {
        restrictinfo->left_relids = pull_varnos(root, get_leftop(clause));
        restrictinfo->right_relids = pull_varnos(root, get_rightop(clause));
 
        restrictinfo->clause_relids = bms_union(restrictinfo->left_relids,
                                                restrictinfo->right_relids);
 
        /*
         * Does it look like a normal join clause, i.e., a binary operator
         * relating expressions that come from distinct relations? If so we
         * might be able to use it in a join algorithm.  Note that this is a
         * purely syntactic test that is made regardless of context.
         */
        if (!bms_is_empty(restrictinfo->left_relids) &&
            !bms_is_empty(restrictinfo->right_relids) &&
            !bms_overlap(restrictinfo->left_relids,
                         restrictinfo->right_relids))
        {
            restrictinfo->can_join = true;
            /* pseudoconstant should certainly not be true */
            Assert(!restrictinfo->pseudoconstant);
        }
    }
    else
    {
        /* Not a binary opclause, so mark left/right relid sets as empty */
        restrictinfo->left_relids = NULL;
        restrictinfo->right_relids = NULL;
        /* and get the total relid set the hard way */
        restrictinfo->clause_relids = pull_varnos(root, (Node *) clause);
    }
 
    /* required_relids defaults to clause_relids */
    if (required_relids != NULL)
        restrictinfo->required_relids = required_relids;
    else
        restrictinfo->required_relids = restrictinfo->clause_relids;
 
    /*
     * Count the number of base rels appearing in clause_relids.  To do this,
     * we just delete rels mentioned in root->outer_join_rels and count the
     * survivors.  Because we are called during deconstruct_jointree which is
     * the same tree walk that populates outer_join_rels, this is a little bit
     * unsafe-looking; but it should be fine because the recursion in
     * deconstruct_jointree should already have visited any outer join that
     * could be mentioned in this clause.
     */
    baserels = bms_difference(restrictinfo->clause_relids,
                              root->outer_join_rels);
    restrictinfo->num_base_rels = bms_num_members(baserels);
    bms_free(baserels);
 
    /*
     * Label this RestrictInfo with a fresh serial number.
     */
    restrictinfo->rinfo_serial = ++(root->last_rinfo_serial);
 
    /*
     * Fill in all the cacheable fields with "not yet set" markers. None of
     * these will be computed until/unless needed.  Note in particular that we
     * don't mark a binary opclause as mergejoinable or hashjoinable here;
     * that happens only if it appears in the right context (top level of a
     * joinclause list).
     */
    restrictinfo->parent_ec = NULL;
 
    restrictinfo->eval_cost.startup = -1;
    restrictinfo->norm_selec = -1;
    restrictinfo->outer_selec = -1;
 
    restrictinfo->mergeopfamilies = NIL;
 
    restrictinfo->left_ec = NULL;
    restrictinfo->right_ec = NULL;
    restrictinfo->left_em = NULL;
    restrictinfo->right_em = NULL;
    restrictinfo->scansel_cache = NIL;
 
    restrictinfo->outer_is_left = false;
 
    restrictinfo->hashjoinoperator = InvalidOid;
 
    restrictinfo->left_bucketsize = -1;
    restrictinfo->right_bucketsize = -1;
    restrictinfo->left_mcvfreq = -1;
    restrictinfo->right_mcvfreq = -1;
 
    restrictinfo->left_hasheqoperator = InvalidOid;
    restrictinfo->right_hasheqoperator = InvalidOid;
 
    return restrictinfo;
}

References generate_unaccent_rules::args, Assert(), bms_difference(), bms_free(), bms_is_empty, bms_num_members(), bms_overlap(), bms_union(), RestrictInfo::clause, contain_leaked_vars(), get_leftop(), get_rightop(), RestrictInfo::has_clone, RestrictInfo::incompatible_relids, InvalidOid, RestrictInfo::is_clone, is_opclause(), RestrictInfo::is_pushed_down, list_length(), makeNode, NIL, RestrictInfo::outer_relids, pull_varnos(), RestrictInfo::required_relids, RestrictInfo::rinfo_serial, root, RestrictInfo::security_level, and VOLATILITY_UNKNOWN.

Referenced by group_similar_or_args(), make_restrictinfo(), and make_sub_restrictinfos().

make_restrictinfo()

RestrictInfo * make_restrictinfo	(	PlannerInfo *	root,
		Expr *	clause,
		bool	is_pushed_down,
		bool	has_clone,
		bool	is_clone,
		bool	pseudoconstant,
		Index	security_level,
		Relids	required_relids,
		Relids	incompatible_relids,
		Relids	outer_relids
	)

Definition at line 52 of file restrictinfo.c.

{
    /*
     * If it's an OR clause, build a modified copy with RestrictInfos inserted
     * above each subclause of the top-level AND/OR structure.
     */
    if (is_orclause(clause))
        return (RestrictInfo *) make_sub_restrictinfos(root,
                                                       clause,
                                                       is_pushed_down,
                                                       has_clone,
                                                       is_clone,
                                                       pseudoconstant,
                                                       security_level,
                                                       required_relids,
                                                       incompatible_relids,
                                                       outer_relids);
 
    /* Shouldn't be an AND clause, else AND/OR flattening messed up */
    Assert(!is_andclause(clause));
 
    return make_plain_restrictinfo(root,
                                   clause,
                                   NULL,
                                   is_pushed_down,
                                   has_clone,
                                   is_clone,
                                   pseudoconstant,
                                   security_level,
                                   required_relids,
                                   incompatible_relids,
                                   outer_relids);
}

References Assert(), is_andclause(), is_orclause(), make_plain_restrictinfo(), make_sub_restrictinfos(), and root.

Referenced by add_base_clause_to_rel(), add_join_clause_to_rels(), apply_child_basequals(), build_implied_join_equality(), consider_new_or_clause(), distribute_qual_to_rels(), foreign_grouping_ok(), process_equivalence(), process_implied_equality(), and reconsider_outer_join_clauses().

restriction_is_or_clause()

bool restriction_is_or_clause

(

RestrictInfo *

restrictinfo

)

Definition at line 407 of file restrictinfo.c.

{
    if (restrictinfo->orclause != NULL)
        return true;
    else
        return false;
}

Referenced by extract_or_clause(), extract_restriction_or_clauses(), generate_bitmap_or_paths(), match_clause_to_indexcol(), match_join_clauses_to_index(), remove_rel_from_restrictinfo(), restriction_is_always_false(), restriction_is_always_true(), and TidQualFromRestrictInfoList().

restriction_is_securely_promotable()

bool restriction_is_securely_promotable	(	RestrictInfo *	restrictinfo,
		RelOptInfo *	rel
	)

Definition at line 422 of file restrictinfo.c.

{
    /*
     * It's okay if there are no baserestrictinfo clauses for the rel that
     * would need to go before this one, *or* if this one is leakproof.
     */
    if (restrictinfo->security_level <= rel->baserestrict_min_security ||
        restrictinfo->leakproof)
        return true;
    else
        return false;
}

References RelOptInfo::baserestrict_min_security, and RestrictInfo::security_level.

Referenced by BuildParameterizedTidPaths(), match_clause_to_index(), and RestrictInfoIsTidQual().