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)    make_restrictinfo(root, clause, true, false, 0, NULL, NULL)

Functions
RestrictInfo *	make_restrictinfo (PlannerInfo *root, Expr *clause, bool is_pushed_down, bool pseudoconstant, Index security_level, Relids required_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	clause_is_computable_at (PlannerInfo *root, Relids clause_relids, Relids eval_relids)
bool	join_clause_is_movable_to (RestrictInfo *rinfo, RelOptInfo *baserel)
bool	join_clause_is_movable_into (RestrictInfo *rinfo, Relids currentrelids, Relids current_and_outer)

Macro Definition Documentation

make_simple_restrictinfo

#define make_simple_restrictinfo	(		root,
			clause
	)		make_restrictinfo(root, clause, true, false, 0, NULL, NULL)

Definition at line 21 of file restrictinfo.h.

Function Documentation

clause_is_computable_at()

bool clause_is_computable_at	(	PlannerInfo *	root,
		Relids	clause_relids,
		Relids	eval_relids
	)

Definition at line 543 of file restrictinfo.c.

{
    ListCell   *lc;
 
    /* Nothing to do if no outer joins have been performed yet. */
    if (!bms_overlap(eval_relids, root->outer_join_rels))
        return true;
 
    foreach(lc, root->join_info_list)
    {
        SpecialJoinInfo *sjinfo = (SpecialJoinInfo *) lfirst(lc);
 
        /* Ignore outer joins that are not yet performed. */
        if (!bms_is_member(sjinfo->ojrelid, eval_relids))
            continue;
 
        /* OK if clause lists it (we assume all Vars in it agree). */
        if (bms_is_member(sjinfo->ojrelid, clause_relids))
            continue;
 
        /* Else, trouble if clause mentions any nullable Vars. */
        if (bms_overlap(clause_relids, sjinfo->min_righthand) ||
            (sjinfo->jointype == JOIN_FULL &&
             bms_overlap(clause_relids, sjinfo->min_lefthand)))
            return false;       /* doesn't work */
    }
 
    return true;                /* OK */
}

References bms_is_member(), bms_overlap(), JOIN_FULL, PlannerInfo::join_info_list, SpecialJoinInfo::jointype, lfirst, SpecialJoinInfo::min_lefthand, SpecialJoinInfo::min_righthand, SpecialJoinInfo::ojrelid, and PlannerInfo::outer_join_rels.

Referenced by subbuild_joinrel_restrictlist().

commute_restrictinfo()

RestrictInfo* commute_restrictinfo	(	RestrictInfo *	rinfo,
		Oid	comm_op
	)

Definition at line 329 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 464 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 492 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);
            Assert(!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 439 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 693 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 607 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_restrictinfo()

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

Definition at line 61 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,
                                                       pseudoconstant,
                                                       security_level,
                                                       required_relids,
                                                       outer_relids);
 
    /* Shouldn't be an AND clause, else AND/OR flattening messed up */
    Assert(!is_andclause(clause));
 
    return make_restrictinfo_internal(root,
                                      clause,
                                      NULL,
                                      is_pushed_down,
                                      pseudoconstant,
                                      security_level,
                                      required_relids,
                                      outer_relids);
}

References Assert(), is_andclause(), is_orclause(), make_restrictinfo_internal(), and make_sub_restrictinfos().

Referenced by 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 386 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_join_clauses_to_index(), remove_rel_from_restrictinfo(), and TidQualFromRestrictInfoList().

restriction_is_securely_promotable()

bool restriction_is_securely_promotable	(	RestrictInfo *	restrictinfo,
		RelOptInfo *	rel
	)

Definition at line 401 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 TidQualFromRestrictInfo().