clauses.h File Reference

#include "access/htup.h"
#include "nodes/relation.h"

Include dependency graph for clauses.h:

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

Go to the source code of this file.

Data Structures
struct	WindowFuncLists

Macros
#define	is_opclause(clause)   ((clause) != NULL && IsA(clause, OpExpr))
#define	is_funcclause(clause)   ((clause) != NULL && IsA(clause, FuncExpr))

Functions
Expr *	make_opclause (Oid opno, Oid opresulttype, bool opretset, Expr *leftop, Expr *rightop, Oid opcollid, Oid inputcollid)
Node *	get_leftop (const Expr *clause)
Node *	get_rightop (const Expr *clause)
bool	not_clause (Node *clause)
Expr *	make_notclause (Expr *notclause)
Expr *	get_notclausearg (Expr *notclause)
bool	or_clause (Node *clause)
Expr *	make_orclause (List *orclauses)
bool	and_clause (Node *clause)
Expr *	make_andclause (List *andclauses)
Node *	make_and_qual (Node *qual1, Node *qual2)
Expr *	make_ands_explicit (List *andclauses)
List *	make_ands_implicit (Expr *clause)
bool	contain_agg_clause (Node *clause)
void	get_agg_clause_costs (PlannerInfo *root, Node *clause, AggSplit aggsplit, AggClauseCosts *costs)
bool	contain_window_function (Node *clause)
WindowFuncLists *	find_window_functions (Node *clause, Index maxWinRef)
double	expression_returns_set_rows (Node *clause)
bool	contain_subplans (Node *clause)
bool	contain_mutable_functions (Node *clause)
bool	contain_volatile_functions (Node *clause)
bool	contain_volatile_functions_not_nextval (Node *clause)
char	max_parallel_hazard (Query *parse)
bool	is_parallel_safe (PlannerInfo *root, Node *node)
bool	contain_nonstrict_functions (Node *clause)
bool	contain_leaked_vars (Node *clause)
Relids	find_nonnullable_rels (Node *clause)
List *	find_nonnullable_vars (Node *clause)
List *	find_forced_null_vars (Node *clause)
Var *	find_forced_null_var (Node *clause)
bool	is_pseudo_constant_clause (Node *clause)
bool	is_pseudo_constant_clause_relids (Node *clause, Relids relids)
int	NumRelids (Node *clause)
void	CommuteOpExpr (OpExpr *clause)
void	CommuteRowCompareExpr (RowCompareExpr *clause)
Node *	eval_const_expressions (PlannerInfo *root, Node *node)
Node *	estimate_expression_value (PlannerInfo *root, Node *node)
Query *	inline_set_returning_function (PlannerInfo *root, RangeTblEntry *rte)
List *	expand_function_arguments (List *args, Oid result_type, HeapTuple func_tuple)

Macro Definition Documentation

is_funcclause

#define is_funcclause

(

clause

)

((clause) != NULL && IsA(clause, FuncExpr))

Definition at line 21 of file clauses.h.

Referenced by boolvarsel(), and clause_is_strict_for().

is_opclause

#define is_opclause

(

clause

)

((clause) != NULL && IsA(clause, OpExpr))

Definition at line 20 of file clauses.h.

Referenced by check_hashjoinable(), check_mergejoinable(), clause_is_strict_for(), clause_selectivity(), clauselist_selectivity(), CommuteOpExpr(), create_hashjoin_plan(), dependency_is_compatible_clause(), expand_indexqual_conditions(), get_switched_clauses(), have_partkey_equi_join(), make_restrictinfo_internal(), match_clause_to_indexcol(), match_clause_to_ordering_op(), mergejoinscansel(), operator_predicate_proof(), process_equivalence(), reconsider_full_join_clause(), reconsider_outer_join_clause(), TidExprListCreate(), and TidQualFromExpr().

Function Documentation

and_clause()

bool and_clause

(

Node *

clause

)

Definition at line 315 of file clauses.c.

References AND_EXPR, boolop(), and IsA.

Referenced by clause_selectivity(), ExecInitSubPlan(), extract_or_clause(), find_duplicate_ors(), gen_partprune_steps_internal(), generate_bitmap_or_paths(), make_ands_implicit(), make_restrictinfo(), make_sub_restrictinfos(), predicate_classify(), process_duplicate_ors(), process_sublinks_mutator(), pull_ands(), pull_up_sublinks_qual_recurse(), simplify_and_arguments(), testexpr_is_hashable(), and TidQualFromExpr().

{
    return (clause != NULL &&
            IsA(clause, BoolExpr) &&
            ((BoolExpr *) clause)->boolop == AND_EXPR);
}

CommuteOpExpr()

void CommuteOpExpr

(

OpExpr *

clause

)

Definition at line 2288 of file clauses.c.

References OpExpr::args, elog, ERROR, get_commutator(), InvalidOid, is_opclause, linitial, list_length(), lsecond, OidIsValid, OpExpr::opfuncid, and OpExpr::opno.

Referenced by fix_indexqual_references(), and get_switched_clauses().

{
    Oid         opoid;
    Node       *temp;

    /* Sanity checks: caller is at fault if these fail */
    if (!is_opclause(clause) ||
        list_length(clause->args) != 2)
        elog(ERROR, "cannot commute non-binary-operator clause");

    opoid = get_commutator(clause->opno);

    if (!OidIsValid(opoid))
        elog(ERROR, "could not find commutator for operator %u",
             clause->opno);

    /*
     * modify the clause in-place!
     */
    clause->opno = opoid;
    clause->opfuncid = InvalidOid;
    /* opresulttype, opretset, opcollid, inputcollid need not change */

    temp = linitial(clause->args);
    linitial(clause->args) = lsecond(clause->args);
    lsecond(clause->args) = temp;
}

CommuteRowCompareExpr()

void CommuteRowCompareExpr

(

RowCompareExpr *

clause

)

Definition at line 2322 of file clauses.c.

References elog, ERROR, get_commutator(), IsA, lappend_oid(), RowCompareExpr::largs, lfirst_oid, NIL, OidIsValid, RowCompareExpr::opnos, RowCompareExpr::rargs, RowCompareExpr::rctype, ROWCOMPARE_GE, ROWCOMPARE_GT, ROWCOMPARE_LE, and ROWCOMPARE_LT.

Referenced by fix_indexqual_references().

{
    List       *newops;
    List       *temp;
    ListCell   *l;

    /* Sanity checks: caller is at fault if these fail */
    if (!IsA(clause, RowCompareExpr))
        elog(ERROR, "expected a RowCompareExpr");

    /* Build list of commuted operators */
    newops = NIL;
    foreach(l, clause->opnos)
    {
        Oid         opoid = lfirst_oid(l);

        opoid = get_commutator(opoid);
        if (!OidIsValid(opoid))
            elog(ERROR, "could not find commutator for operator %u",
                 lfirst_oid(l));
        newops = lappend_oid(newops, opoid);
    }

    /*
     * modify the clause in-place!
     */
    switch (clause->rctype)
    {
        case ROWCOMPARE_LT:
            clause->rctype = ROWCOMPARE_GT;
            break;
        case ROWCOMPARE_LE:
            clause->rctype = ROWCOMPARE_GE;
            break;
        case ROWCOMPARE_GE:
            clause->rctype = ROWCOMPARE_LE;
            break;
        case ROWCOMPARE_GT:
            clause->rctype = ROWCOMPARE_LT;
            break;
        default:
            elog(ERROR, "unexpected RowCompare type: %d",
                 (int) clause->rctype);
            break;
    }

    clause->opnos = newops;

    /*
     * Note: we need not change the opfamilies list; we assume any btree
     * opfamily containing an operator will also contain its commutator.
     * Collations don't change either.
     */

    temp = clause->largs;
    clause->largs = clause->rargs;
    clause->rargs = temp;
}

contain_agg_clause()

bool contain_agg_clause

(

Node *

clause

)

Definition at line 418 of file clauses.c.

References contain_agg_clause_walker().

Referenced by get_eclass_for_sort_expr(), and subquery_planner().

{
    return contain_agg_clause_walker(clause, NULL);
}

contain_leaked_vars()

bool contain_leaked_vars

(

Node *

clause

)

Definition at line 1516 of file clauses.c.

References contain_leaked_vars_walker().

Referenced by make_restrictinfo_internal(), and qual_is_pushdown_safe().

{
    return contain_leaked_vars_walker(clause, NULL);
}

contain_mutable_functions()

bool contain_mutable_functions

(

Node *

clause

)

Definition at line 879 of file clauses.c.

References contain_mutable_functions_walker().

Referenced by check_index_predicates(), CheckMutability(), ComputePartitionAttrs(), create_bitmap_scan_plan(), create_indexscan_plan(), eval_const_expressions_mutator(), find_minmax_aggs_walker(), inline_function(), is_foreign_expr(), and relation_excluded_by_constraints().

{
    return contain_mutable_functions_walker(clause, NULL);
}

contain_nonstrict_functions()

bool contain_nonstrict_functions

(

Node *

clause

)

Definition at line 1315 of file clauses.c.

References contain_nonstrict_functions_walker().

Referenced by inline_function(), process_equivalence(), and pullup_replace_vars_callback().

{
    return contain_nonstrict_functions_walker(clause, NULL);
}

contain_subplans()

bool contain_subplans

(

Node *

clause

)

Definition at line 844 of file clauses.c.

References contain_subplans_walker().

Referenced by convert_EXISTS_to_ANY(), inline_function(), inline_set_returning_function(), qual_is_pushdown_safe(), and subquery_planner().

{
    return contain_subplans_walker(clause, NULL);
}

contain_volatile_functions()

bool contain_volatile_functions

(

Node *

clause

)

Definition at line 958 of file clauses.c.

References contain_volatile_functions_walker().

Referenced by AddRelationNewConstraints(), adjust_rowcompare_for_index(), check_hashjoinable(), check_mergejoinable(), check_output_expressions(), compute_semijoin_info(), convert_ANY_sublink_to_join(), convert_EXISTS_sublink_to_join(), convert_EXISTS_to_ANY(), distribute_qual_to_rels(), estimate_num_groups(), ExecInitWindowAgg(), find_compatible_peragg(), get_eclass_for_sort_expr(), initialize_peragg(), inline_function(), inline_set_returning_function(), is_pseudo_constant_clause(), is_pseudo_constant_clause_relids(), is_safe_restriction_clause_for(), is_simple_subquery(), is_simple_values(), make_sort_input_target(), match_clause_to_indexcol(), match_clause_to_ordering_op(), match_clause_to_partition_key(), match_rowcompare_to_indexcol(), qual_is_pushdown_safe(), remove_unused_subquery_outputs(), set_append_rel_size(), and subquery_planner().

{
    return contain_volatile_functions_walker(clause, NULL);
}

contain_volatile_functions_not_nextval()

bool contain_volatile_functions_not_nextval

(

Node *

clause

)

Definition at line 1008 of file clauses.c.

References contain_volatile_functions_not_nextval_walker().

Referenced by BeginCopyFrom().

{
    return contain_volatile_functions_not_nextval_walker(clause, NULL);
}

contain_window_function()

bool contain_window_function

(

Node *

clause

)

Definition at line 728 of file clauses.c.

References contain_windowfuncs().

Referenced by get_eclass_for_sort_expr(), and qual_is_pushdown_safe().

{
    return contain_windowfuncs(clause);
}

estimate_expression_value()

Node* estimate_expression_value	(	PlannerInfo *	root,
		Node *	node
	)

Definition at line 2493 of file clauses.c.

References eval_const_expressions_context::active_fns, eval_const_expressions_context::boundParams, PlannerGlobal::boundParams, eval_const_expressions_context::case_val, eval_const_expressions_context::estimate, eval_const_expressions_mutator(), PlannerInfo::glob, NIL, and eval_const_expressions_context::root.

Referenced by bernoulli_samplescangetsamplesize(), clause_selectivity(), get_restriction_variable(), gincost_opexpr(), gincost_scalararrayopexpr(), preprocess_limit(), scalararraysel(), system_rows_samplescangetsamplesize(), system_samplescangetsamplesize(), and system_time_samplescangetsamplesize().

{
    eval_const_expressions_context context;

    context.boundParams = root->glob->boundParams;  /* bound Params */
    /* we do not need to mark the plan as depending on inlined functions */
    context.root = NULL;
    context.active_fns = NIL;   /* nothing being recursively simplified */
    context.case_val = NULL;    /* no CASE being examined */
    context.estimate = true;    /* unsafe transformations OK */
    return eval_const_expressions_mutator(node, &context);
}

eval_const_expressions()

Node* eval_const_expressions	(	PlannerInfo *	root,
		Node *	node
	)

Definition at line 2460 of file clauses.c.

References eval_const_expressions_context::active_fns, eval_const_expressions_context::boundParams, PlannerGlobal::boundParams, eval_const_expressions_context::case_val, eval_const_expressions_context::estimate, eval_const_expressions_mutator(), PlannerInfo::glob, NIL, and eval_const_expressions_context::root.

Referenced by ATExecAttachPartition(), convert_EXISTS_to_ANY(), expression_planner(), get_proposed_default_constraint(), get_relation_constraints(), inline_set_returning_function(), PartConstraintImpliedByRelConstraint(), preprocess_expression(), process_implied_equality(), RelationBuildPartitionKey(), RelationGetIndexExpressions(), RelationGetIndexPredicate(), set_append_rel_size(), and simplify_EXISTS_query().

{
    eval_const_expressions_context context;

    if (root)
        context.boundParams = root->glob->boundParams;  /* bound Params */
    else
        context.boundParams = NULL;
    context.root = root;        /* for inlined-function dependencies */
    context.active_fns = NIL;   /* nothing being recursively simplified */
    context.case_val = NULL;    /* no CASE being examined */
    context.estimate = false;   /* safe transformations only */
    return eval_const_expressions_mutator(node, &context);
}

expand_function_arguments()

List* expand_function_arguments	(	List *	args,
		Oid	result_type,
		HeapTuple	func_tuple
	)

Definition at line 4114 of file clauses.c.

References add_function_defaults(), arg, generate_unaccent_rules::args, GETSTRUCT, IsA, lfirst, list_length(), recheck_cast_function_args(), and reorder_function_arguments().

Referenced by eval_const_expressions_mutator(), ExecuteCallStmt(), and simplify_function().

{
    Form_pg_proc funcform = (Form_pg_proc) GETSTRUCT(func_tuple);
    bool        has_named_args = false;
    ListCell   *lc;

    /* Do we have any named arguments? */
    foreach(lc, args)
    {
        Node       *arg = (Node *) lfirst(lc);

        if (IsA(arg, NamedArgExpr))
        {
            has_named_args = true;
            break;
        }
    }

    /* If so, we must apply reorder_function_arguments */
    if (has_named_args)
    {
        args = reorder_function_arguments(args, func_tuple);
        /* Recheck argument types and add casts if needed */
        recheck_cast_function_args(args, result_type, func_tuple);
    }
    else if (list_length(args) < funcform->pronargs)
    {
        /* No named args, but we seem to be short some defaults */
        args = add_function_defaults(args, func_tuple);
        /* Recheck argument types and add casts if needed */
        recheck_cast_function_args(args, result_type, func_tuple);
    }

    return args;
}

expression_returns_set_rows()

double expression_returns_set_rows

(

Node *

clause

)

Definition at line 803 of file clauses.c.

References clamp_row_est(), FuncExpr::funcid, FuncExpr::funcretset, get_func_rows(), IsA, OpExpr::opfuncid, OpExpr::opretset, and set_opfuncid().

Referenced by create_set_projection_path(), estimate_num_groups(), and set_function_size_estimates().

{
    if (clause == NULL)
        return 1.0;
    if (IsA(clause, FuncExpr))
    {
        FuncExpr   *expr = (FuncExpr *) clause;

        if (expr->funcretset)
            return clamp_row_est(get_func_rows(expr->funcid));
    }
    if (IsA(clause, OpExpr))
    {
        OpExpr     *expr = (OpExpr *) clause;

        if (expr->opretset)
        {
            set_opfuncid(expr);
            return clamp_row_est(get_func_rows(expr->opfuncid));
        }
    }
    return 1.0;
}

find_forced_null_var()

Var* find_forced_null_var

(

Node *

clause

)

Definition at line 2121 of file clauses.c.

References NullTest::arg, BooleanTest::arg, NullTest::argisrow, BooleanTest::booltesttype, IS_NULL, IS_UNKNOWN, IsA, NullTest::nulltesttype, and Var::varlevelsup.

Referenced by check_redundant_nullability_qual(), and find_forced_null_vars().

{
    if (node == NULL)
        return NULL;
    if (IsA(node, NullTest))
    {
        /* check for var IS NULL */
        NullTest   *expr = (NullTest *) node;

        if (expr->nulltesttype == IS_NULL && !expr->argisrow)
        {
            Var        *var = (Var *) expr->arg;

            if (var && IsA(var, Var) &&
                var->varlevelsup == 0)
                return var;
        }
    }
    else if (IsA(node, BooleanTest))
    {
        /* var IS UNKNOWN is equivalent to var IS NULL */
        BooleanTest *expr = (BooleanTest *) node;

        if (expr->booltesttype == IS_UNKNOWN)
        {
            Var        *var = (Var *) expr->arg;

            if (var && IsA(var, Var) &&
                var->varlevelsup == 0)
                return var;
        }
    }
    return NULL;
}

find_forced_null_vars()

List* find_forced_null_vars

(

Node *

clause

)

Definition at line 2062 of file clauses.c.

References AND_EXPR, BoolExpr::args, BoolExpr::boolop, find_forced_null_var(), find_forced_null_vars(), IsA, lfirst, list_concat(), list_make1, and NIL.

Referenced by find_forced_null_vars(), and reduce_outer_joins_pass2().

{
    List       *result = NIL;
    Var        *var;
    ListCell   *l;

    if (node == NULL)
        return NIL;
    /* Check single-clause cases using subroutine */
    var = find_forced_null_var(node);
    if (var)
    {
        result = list_make1(var);
    }
    /* Otherwise, handle AND-conditions */
    else if (IsA(node, List))
    {
        /*
         * At top level, we are examining an implicit-AND list: if any of the
         * arms produces FALSE-or-NULL then the result is FALSE-or-NULL.
         */
        foreach(l, (List *) node)
        {
            result = list_concat(result,
                                 find_forced_null_vars(lfirst(l)));
        }
    }
    else if (IsA(node, BoolExpr))
    {
        BoolExpr   *expr = (BoolExpr *) node;

        /*
         * We don't bother considering the OR case, because it's fairly
         * unlikely anyone would write "v1 IS NULL OR v1 IS NULL". Likewise,
         * the NOT case isn't worth expending code on.
         */
        if (expr->boolop == AND_EXPR)
        {
            /* At top level we can just recurse (to the List case) */
            result = find_forced_null_vars((Node *) expr->args);
        }
    }
    return result;
}

find_nonnullable_rels()

Relids find_nonnullable_rels

(

Node *

clause

)

Definition at line 1661 of file clauses.c.

References find_nonnullable_rels_walker().

Referenced by make_outerjoininfo(), and reduce_outer_joins_pass2().

{
    return find_nonnullable_rels_walker(clause, true);
}

find_nonnullable_vars()

List* find_nonnullable_vars

(

Node *

clause

)

Definition at line 1869 of file clauses.c.

References find_nonnullable_vars_walker().

Referenced by reduce_outer_joins_pass2().

{
    return find_nonnullable_vars_walker(clause, true);
}

find_window_functions()

WindowFuncLists* find_window_functions	(	Node *	clause,
		Index	maxWinRef
	)

Definition at line 741 of file clauses.c.

References find_window_functions_walker(), WindowFuncLists::maxWinRef, WindowFuncLists::numWindowFuncs, palloc(), palloc0(), and WindowFuncLists::windowFuncs.

Referenced by grouping_planner().

{
    WindowFuncLists *lists = palloc(sizeof(WindowFuncLists));

    lists->numWindowFuncs = 0;
    lists->maxWinRef = maxWinRef;
    lists->windowFuncs = (List **) palloc0((maxWinRef + 1) * sizeof(List *));
    (void) find_window_functions_walker(clause, lists);
    return lists;
}

get_agg_clause_costs()

void get_agg_clause_costs	(	PlannerInfo *	root,
		Node *	clause,
		AggSplit	aggsplit,
		AggClauseCosts *	costs
	)

Definition at line 468 of file clauses.c.

References get_agg_clause_costs_context::aggsplit, get_agg_clause_costs_context::costs, get_agg_clause_costs_walker(), and get_agg_clause_costs_context::root.

Referenced by create_partial_grouping_paths(), estimate_path_cost_size(), and grouping_planner().

{
    get_agg_clause_costs_context context;

    context.root = root;
    context.aggsplit = aggsplit;
    context.costs = costs;
    (void) get_agg_clause_costs_walker(clause, &context);
}

get_leftop()

Node* get_leftop

(

const Expr *

clause

)

Definition at line 200 of file clauses.c.

References OpExpr::args, linitial, and NIL.

Referenced by addRangeClause(), deconstruct_indexquals(), ExecIndexBuildScanKeys(), expand_indexqual_opclause(), final_cost_hashjoin(), initialize_mergeclause_eclasses(), make_restrictinfo_internal(), match_clause_to_indexcol(), match_clause_to_ordering_op(), match_clause_to_partition_key(), match_foreign_keys_to_quals(), mergejoinscansel(), print_expr(), process_equivalence(), reconsider_full_join_clause(), reconsider_outer_join_clause(), rel_is_distinct_for(), relation_has_unique_index_for(), and TidExprListCreate().

{
    const OpExpr *expr = (const OpExpr *) clause;

    if (expr->args != NIL)
        return linitial(expr->args);
    else
        return NULL;
}

get_notclausearg()

Expr* get_notclausearg

(

Expr *

notclause

)

Definition at line 266 of file clauses.c.

References generate_unaccent_rules::args, and linitial.

Referenced by clause_selectivity(), dependency_is_compatible_clause(), expand_boolean_index_clause(), match_boolean_index_clause(), match_boolean_partition_clause(), and pull_up_sublinks_qual_recurse().

{
    return linitial(((BoolExpr *) notclause)->args);
}

get_rightop()

Node* get_rightop

(

const Expr *

clause

)

Definition at line 217 of file clauses.c.

References OpExpr::args, list_length(), and lsecond.

Referenced by addRangeClause(), deconstruct_indexquals(), ExecIndexBuildScanKeys(), expand_indexqual_opclause(), final_cost_hashjoin(), initialize_mergeclause_eclasses(), make_restrictinfo_internal(), match_clause_to_indexcol(), match_clause_to_ordering_op(), match_clause_to_partition_key(), match_foreign_keys_to_quals(), match_special_index_operator(), mergejoinscansel(), orderby_operands_eval_cost(), print_expr(), process_equivalence(), reconsider_full_join_clause(), reconsider_outer_join_clause(), rel_is_distinct_for(), relation_has_unique_index_for(), and TidExprListCreate().

{
    const OpExpr *expr = (const OpExpr *) clause;

    if (list_length(expr->args) >= 2)
        return lsecond(expr->args);
    else
        return NULL;
}

inline_set_returning_function()

Query* inline_set_returning_function	(	PlannerInfo *	root,
		RangeTblEntry *	rte
	)

Definition at line 4932 of file clauses.c.

References ACL_EXECUTE, ACLCHECK_OK, ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, ErrorContextCallback::arg, FuncExpr::args, Assert, ErrorContextCallback::callback, check_sql_fn_retval(), check_stack_depth(), CMD_SELECT, Query::commandType, contain_subplans(), contain_volatile_functions(), copyObject, CurrentMemoryContext, elog, ERROR, error_context_stack, eval_const_expressions(), FmgrHookIsNeeded, RangeTblFunction::funccoltypes, RangeTblFunction::funcexpr, FuncExpr::funcid, RangeTblEntry::funcordinality, FuncExpr::funcretset, RangeTblEntry::functions, get_func_result_type(), get_typtype(), GETSTRUCT, GetUserId(), PlannerInfo::glob, heap_attisnull(), HeapTupleIsValid, PlannerGlobal::invalItems, IsA, linitial, list_concat(), list_length(), MemoryContextDelete(), MemoryContextSwitchTo(), NameStr, NIL, ObjectIdGetDatum, pg_analyze_and_rewrite_params(), pg_parse_query(), pg_proc_aclcheck(), prepare_sql_fn_parse_info(), ErrorContextCallback::previous, PROCOID, inline_error_callback_arg::proname, inline_error_callback_arg::prosrc, querytree(), record_plan_function_dependency(), ReleaseSysCache(), RTE_FUNCTION, RangeTblEntry::rtekind, SearchSysCache1(), sql_fn_parser_setup(), sql_inline_error_callback(), substitute_actual_srf_parameters(), SysCacheGetAttr(), Query::targetList, TextDatumGetCString, tlist_matches_coltypelist(), and TYPEFUNC_RECORD.

Referenced by inline_set_returning_functions().

{
    RangeTblFunction *rtfunc;
    FuncExpr   *fexpr;
    Oid         func_oid;
    HeapTuple   func_tuple;
    Form_pg_proc funcform;
    char       *src;
    Datum       tmp;
    bool        isNull;
    bool        modifyTargetList;
    MemoryContext oldcxt;
    MemoryContext mycxt;
    List       *saveInvalItems;
    inline_error_callback_arg callback_arg;
    ErrorContextCallback sqlerrcontext;
    SQLFunctionParseInfoPtr pinfo;
    List       *raw_parsetree_list;
    List       *querytree_list;
    Query      *querytree;

    Assert(rte->rtekind == RTE_FUNCTION);

    /*
     * It doesn't make a lot of sense for a SQL SRF to refer to itself in its
     * own FROM clause, since that must cause infinite recursion at runtime.
     * It will cause this code to recurse too, so check for stack overflow.
     * (There's no need to do more.)
     */
    check_stack_depth();

    /* Fail if the RTE has ORDINALITY - we don't implement that here. */
    if (rte->funcordinality)
        return NULL;

    /* Fail if RTE isn't a single, simple FuncExpr */
    if (list_length(rte->functions) != 1)
        return NULL;
    rtfunc = (RangeTblFunction *) linitial(rte->functions);

    if (!IsA(rtfunc->funcexpr, FuncExpr))
        return NULL;
    fexpr = (FuncExpr *) rtfunc->funcexpr;

    func_oid = fexpr->funcid;

    /*
     * The function must be declared to return a set, else inlining would
     * change the results if the contained SELECT didn't return exactly one
     * row.
     */
    if (!fexpr->funcretset)
        return NULL;

    /*
     * Refuse to inline if the arguments contain any volatile functions or
     * sub-selects.  Volatile functions are rejected because inlining may
     * result in the arguments being evaluated multiple times, risking a
     * change in behavior.  Sub-selects are rejected partly for implementation
     * reasons (pushing them down another level might change their behavior)
     * and partly because they're likely to be expensive and so multiple
     * evaluation would be bad.
     */
    if (contain_volatile_functions((Node *) fexpr->args) ||
        contain_subplans((Node *) fexpr->args))
        return NULL;

    /* Check permission to call function (fail later, if not) */
    if (pg_proc_aclcheck(func_oid, GetUserId(), ACL_EXECUTE) != ACLCHECK_OK)
        return NULL;

    /* Check whether a plugin wants to hook function entry/exit */
    if (FmgrHookIsNeeded(func_oid))
        return NULL;

    /*
     * OK, let's take a look at the function's pg_proc entry.
     */
    func_tuple = SearchSysCache1(PROCOID, ObjectIdGetDatum(func_oid));
    if (!HeapTupleIsValid(func_tuple))
        elog(ERROR, "cache lookup failed for function %u", func_oid);
    funcform = (Form_pg_proc) GETSTRUCT(func_tuple);

    /*
     * Forget it if the function is not SQL-language or has other showstopper
     * properties.  In particular it mustn't be declared STRICT, since we
     * couldn't enforce that.  It also mustn't be VOLATILE, because that is
     * supposed to cause it to be executed with its own snapshot, rather than
     * sharing the snapshot of the calling query.  We also disallow returning
     * SETOF VOID, because inlining would result in exposing the actual result
     * of the function's last SELECT, which should not happen in that case.
     * (Rechecking prokind and proretset is just paranoia.)
     */
    if (funcform->prolang != SQLlanguageId ||
        funcform->prokind != PROKIND_FUNCTION ||
        funcform->proisstrict ||
        funcform->provolatile == PROVOLATILE_VOLATILE ||
        funcform->prorettype == VOIDOID ||
        funcform->prosecdef ||
        !funcform->proretset ||
        !heap_attisnull(func_tuple, Anum_pg_proc_proconfig, NULL))
    {
        ReleaseSysCache(func_tuple);
        return NULL;
    }

    /*
     * Make a temporary memory context, so that we don't leak all the stuff
     * that parsing might create.
     */
    mycxt = AllocSetContextCreate(CurrentMemoryContext,
                                  "inline_set_returning_function",
                                  ALLOCSET_DEFAULT_SIZES);
    oldcxt = MemoryContextSwitchTo(mycxt);

    /*
     * When we call eval_const_expressions below, it might try to add items to
     * root->glob->invalItems.  Since it is running in the temp context, those
     * items will be in that context, and will need to be copied out if we're
     * successful.  Temporarily reset the list so that we can keep those items
     * separate from the pre-existing list contents.
     */
    saveInvalItems = root->glob->invalItems;
    root->glob->invalItems = NIL;

    /* Fetch the function body */
    tmp = SysCacheGetAttr(PROCOID,
                          func_tuple,
                          Anum_pg_proc_prosrc,
                          &isNull);
    if (isNull)
        elog(ERROR, "null prosrc for function %u", func_oid);
    src = TextDatumGetCString(tmp);

    /*
     * Setup error traceback support for ereport().  This is so that we can
     * finger the function that bad information came from.
     */
    callback_arg.proname = NameStr(funcform->proname);
    callback_arg.prosrc = src;

    sqlerrcontext.callback = sql_inline_error_callback;
    sqlerrcontext.arg = (void *) &callback_arg;
    sqlerrcontext.previous = error_context_stack;
    error_context_stack = &sqlerrcontext;

    /*
     * Run eval_const_expressions on the function call.  This is necessary to
     * ensure that named-argument notation is converted to positional notation
     * and any default arguments are inserted.  It's a bit of overkill for the
     * arguments, since they'll get processed again later, but no harm will be
     * done.
     */
    fexpr = (FuncExpr *) eval_const_expressions(root, (Node *) fexpr);

    /* It should still be a call of the same function, but let's check */
    if (!IsA(fexpr, FuncExpr) ||
        fexpr->funcid != func_oid)
        goto fail;

    /* Arg list length should now match the function */
    if (list_length(fexpr->args) != funcform->pronargs)
        goto fail;

    /*
     * Set up to handle parameters while parsing the function body.  We can
     * use the FuncExpr just created as the input for
     * prepare_sql_fn_parse_info.
     */
    pinfo = prepare_sql_fn_parse_info(func_tuple,
                                      (Node *) fexpr,
                                      fexpr->inputcollid);

    /*
     * Parse, analyze, and rewrite (unlike inline_function(), we can't skip
     * rewriting here).  We can fail as soon as we find more than one query,
     * though.
     */
    raw_parsetree_list = pg_parse_query(src);
    if (list_length(raw_parsetree_list) != 1)
        goto fail;

    querytree_list = pg_analyze_and_rewrite_params(linitial(raw_parsetree_list),
                                                   src,
                                                   (ParserSetupHook) sql_fn_parser_setup,
                                                   pinfo, NULL);
    if (list_length(querytree_list) != 1)
        goto fail;
    querytree = linitial(querytree_list);

    /*
     * The single command must be a plain SELECT.
     */
    if (!IsA(querytree, Query) ||
        querytree->commandType != CMD_SELECT)
        goto fail;

    /*
     * Make sure the function (still) returns what it's declared to.  This
     * will raise an error if wrong, but that's okay since the function would
     * fail at runtime anyway.  Note that check_sql_fn_retval will also insert
     * RelabelType(s) and/or NULL columns if needed to make the tlist
     * expression(s) match the declared type of the function.
     *
     * If the function returns a composite type, don't inline unless the check
     * shows it's returning a whole tuple result; otherwise what it's
     * returning is a single composite column which is not what we need. (Like
     * check_sql_fn_retval, we deliberately exclude domains over composite
     * here.)
     */
    if (!check_sql_fn_retval(func_oid, fexpr->funcresulttype,
                             querytree_list,
                             &modifyTargetList, NULL) &&
        (get_typtype(fexpr->funcresulttype) == TYPTYPE_COMPOSITE ||
         fexpr->funcresulttype == RECORDOID))
        goto fail;              /* reject not-whole-tuple-result cases */

    /*
     * If we had to modify the tlist to make it match, and the statement is
     * one in which changing the tlist contents could change semantics, we
     * have to punt and not inline.
     */
    if (modifyTargetList)
        goto fail;

    /*
     * If it returns RECORD, we have to check against the column type list
     * provided in the RTE; check_sql_fn_retval can't do that.  (If no match,
     * we just fail to inline, rather than complaining; see notes for
     * tlist_matches_coltypelist.)  We don't have to do this for functions
     * with declared OUT parameters, even though their funcresulttype is
     * RECORDOID, so check get_func_result_type too.
     */
    if (fexpr->funcresulttype == RECORDOID &&
        get_func_result_type(func_oid, NULL, NULL) == TYPEFUNC_RECORD &&
        !tlist_matches_coltypelist(querytree->targetList,
                                   rtfunc->funccoltypes))
        goto fail;

    /*
     * Looks good --- substitute parameters into the query.
     */
    querytree = substitute_actual_srf_parameters(querytree,
                                                 funcform->pronargs,
                                                 fexpr->args);

    /*
     * Copy the modified query out of the temporary memory context, and clean
     * up.
     */
    MemoryContextSwitchTo(oldcxt);

    querytree = copyObject(querytree);

    /* copy up any new invalItems, too */
    root->glob->invalItems = list_concat(saveInvalItems,
                                         copyObject(root->glob->invalItems));

    MemoryContextDelete(mycxt);
    error_context_stack = sqlerrcontext.previous;
    ReleaseSysCache(func_tuple);

    /*
     * We don't have to fix collations here because the upper query is already
     * parsed, ie, the collations in the RTE are what count.
     */

    /*
     * Since there is now no trace of the function in the plan tree, we must
     * explicitly record the plan's dependency on the function.
     */
    record_plan_function_dependency(root, func_oid);

    return querytree;

    /* Here if func is not inlinable: release temp memory and return NULL */
fail:
    MemoryContextSwitchTo(oldcxt);
    root->glob->invalItems = saveInvalItems;
    MemoryContextDelete(mycxt);
    error_context_stack = sqlerrcontext.previous;
    ReleaseSysCache(func_tuple);

    return NULL;
}

is_parallel_safe()

bool is_parallel_safe	(	PlannerInfo *	root,
		Node *	node
	)

Definition at line 1088 of file clauses.c.

References PlannerInfo::glob, PlannerInfo::init_plans, lcons_int(), lfirst, lfirst_int, max_parallel_hazard_context::max_hazard, max_parallel_hazard_context::max_interesting, max_parallel_hazard_walker(), PlannerGlobal::maxParallelHazard, NIL, PlannerGlobal::paramExecTypes, PlannerInfo::parent_root, max_parallel_hazard_context::safe_param_ids, and SubPlan::setParam.

Referenced by apply_projection_to_path(), build_join_rel(), create_projection_path(), create_set_projection_path(), create_window_paths(), grouping_planner(), make_grouping_rel(), plan_create_index_workers(), query_planner(), and set_rel_consider_parallel().

{
    max_parallel_hazard_context context;
    PlannerInfo *proot;
    ListCell   *l;

    /*
     * Even if the original querytree contained nothing unsafe, we need to
     * search the expression if we have generated any PARAM_EXEC Params while
     * planning, because those are parallel-restricted and there might be one
     * in this expression.  But otherwise we don't need to look.
     */
    if (root->glob->maxParallelHazard == PROPARALLEL_SAFE &&
        root->glob->paramExecTypes == NIL)
        return true;
    /* Else use max_parallel_hazard's search logic, but stop on RESTRICTED */
    context.max_hazard = PROPARALLEL_SAFE;
    context.max_interesting = PROPARALLEL_RESTRICTED;
    context.safe_param_ids = NIL;

    /*
     * The params that refer to the same or parent query level are considered
     * parallel-safe.  The idea is that we compute such params at Gather or
     * Gather Merge node and pass their value to workers.
     */
    for (proot = root; proot != NULL; proot = proot->parent_root)
    {
        foreach(l, proot->init_plans)
        {
            SubPlan    *initsubplan = (SubPlan *) lfirst(l);
            ListCell   *l2;

            foreach(l2, initsubplan->setParam)
                context.safe_param_ids = lcons_int(lfirst_int(l2),
                                                   context.safe_param_ids);
        }
    }

    return !max_parallel_hazard_walker(node, &context);
}

is_pseudo_constant_clause()

bool is_pseudo_constant_clause

(

Node *

clause

)

Definition at line 2231 of file clauses.c.

References contain_var_clause(), and contain_volatile_functions().

Referenced by clauselist_selectivity(), dependency_is_compatible_clause(), IsTidEqualAnyClause(), and IsTidEqualClause().

{
    /*
     * We could implement this check in one recursive scan.  But since the
     * check for volatile functions is both moderately expensive and unlikely
     * to fail, it seems better to look for Vars first and only check for
     * volatile functions if we find no Vars.
     */
    if (!contain_var_clause(clause) &&
        !contain_volatile_functions(clause))
        return true;
    return false;
}

is_pseudo_constant_clause_relids()

bool is_pseudo_constant_clause_relids	(	Node *	clause,
		Relids	relids
	)

Definition at line 2251 of file clauses.c.

References bms_is_empty(), and contain_volatile_functions().

Referenced by clauselist_selectivity().

{
    if (bms_is_empty(relids) &&
        !contain_volatile_functions(clause))
        return true;
    return false;
}

make_and_qual()

Node* make_and_qual	(	Node *	qual1,
		Node *	qual2
	)

Definition at line 349 of file clauses.c.

References list_make2, and make_andclause().

Referenced by AddQual(), and subquery_push_qual().

{
    if (qual1 == NULL)
        return qual2;
    if (qual2 == NULL)
        return qual1;
    return (Node *) make_andclause(list_make2(qual1, qual2));
}

make_andclause()

Expr* make_andclause

(

List *

andclauses

)

Definition at line 328 of file clauses.c.

References AND_EXPR, BoolExpr::args, BoolExpr::boolop, BoolExpr::location, and makeNode.

Referenced by eval_const_expressions_mutator(), find_duplicate_ors(), make_and_qual(), make_ands_explicit(), make_sub_restrictinfos(), negate_clause(), process_duplicate_ors(), process_sublinks_mutator(), and pull_up_sublinks_qual_recurse().

{
    BoolExpr   *expr = makeNode(BoolExpr);

    expr->boolop = AND_EXPR;
    expr->args = andclauses;
    expr->location = -1;
    return (Expr *) expr;
}

make_ands_explicit()

Expr* make_ands_explicit

(

List *

andclauses

)

Definition at line 368 of file clauses.c.

References linitial, list_length(), make_andclause(), makeBoolConst(), and NIL.

Referenced by ATExecAttachPartition(), convert_EXISTS_to_ANY(), create_bitmap_subplan(), ExecInitCheck(), extract_or_clause(), get_proposed_default_constraint(), get_qual_for_list(), show_qual(), and UpdateIndexRelation().

{
    if (andclauses == NIL)
        return (Expr *) makeBoolConst(true, false);
    else if (list_length(andclauses) == 1)
        return (Expr *) linitial(andclauses);
    else
        return make_andclause(andclauses);
}

make_ands_implicit()

List* make_ands_implicit

(

Expr *

clause

)

Definition at line 379 of file clauses.c.

References and_clause(), DatumGetBool, IsA, list_make1, and NIL.

Referenced by convert_EXISTS_to_ANY(), cost_subplan(), DefineIndex(), get_proposed_default_constraint(), get_relation_constraints(), PartConstraintImpliedByRelConstraint(), preprocess_expression(), RelationGetIndexPredicate(), set_append_rel_size(), test_predtest(), and TriggerEnabled().

{
    /*
     * NB: because the parser sets the qual field to NULL in a query that has
     * no WHERE clause, we must consider a NULL input clause as TRUE, even
     * though one might more reasonably think it FALSE.  Grumble. If this
     * causes trouble, consider changing the parser's behavior.
     */
    if (clause == NULL)
        return NIL;             /* NULL -> NIL list == TRUE */
    else if (and_clause((Node *) clause))
        return ((BoolExpr *) clause)->args;
    else if (IsA(clause, Const) &&
             !((Const *) clause)->constisnull &&
             DatumGetBool(((Const *) clause)->constvalue))
        return NIL;             /* constant TRUE input -> NIL list */
    else
        return list_make1(clause);
}

make_notclause()

Expr* make_notclause

(

Expr *

notclause

)

Definition at line 250 of file clauses.c.

References BoolExpr::args, BoolExpr::boolop, list_make1, BoolExpr::location, makeNode, and NOT_EXPR.

Referenced by negate_clause().

{
    BoolExpr   *expr = makeNode(BoolExpr);

    expr->boolop = NOT_EXPR;
    expr->args = list_make1(notclause);
    expr->location = -1;
    return (Expr *) expr;
}

make_opclause()

Expr* make_opclause	(	Oid	opno,
		Oid	opresulttype,
		bool	opretset,
		Expr *	leftop,
		Expr *	rightop,
		Oid	opcollid,
		Oid	inputcollid
	)

Definition at line 173 of file clauses.c.

References OpExpr::args, OpExpr::inputcollid, InvalidOid, list_make1, list_make2, OpExpr::location, makeNode, OpExpr::opcollid, OpExpr::opfuncid, OpExpr::opno, OpExpr::opresulttype, and OpExpr::opretset.

Referenced by adjust_rowcompare_for_index(), build_implied_join_equality(), convert_EXISTS_to_ANY(), expand_boolean_index_clause(), make_partition_op_expr(), match_clause_to_partition_key(), network_prefix_quals(), operator_predicate_proof(), prefix_quals(), and process_implied_equality().

{
    OpExpr     *expr = makeNode(OpExpr);

    expr->opno = opno;
    expr->opfuncid = InvalidOid;
    expr->opresulttype = opresulttype;
    expr->opretset = opretset;
    expr->opcollid = opcollid;
    expr->inputcollid = inputcollid;
    if (rightop)
        expr->args = list_make2(leftop, rightop);
    else
        expr->args = list_make1(leftop);
    expr->location = -1;
    return (Expr *) expr;
}

make_orclause()

Expr* make_orclause

(

List *

orclauses

)

Definition at line 294 of file clauses.c.

References BoolExpr::args, BoolExpr::boolop, BoolExpr::location, makeNode, and OR_EXPR.

Referenced by create_bitmap_subplan(), create_tidscan_plan(), eval_const_expressions_mutator(), ExplainNode(), extract_or_clause(), make_sub_restrictinfos(), negate_clause(), process_duplicate_ors(), and process_sublinks_mutator().

{
    BoolExpr   *expr = makeNode(BoolExpr);

    expr->boolop = OR_EXPR;
    expr->args = orclauses;
    expr->location = -1;
    return (Expr *) expr;
}

max_parallel_hazard()

char max_parallel_hazard

(

Query *

parse

)

Definition at line 1069 of file clauses.c.

References max_parallel_hazard_context::max_hazard, max_parallel_hazard_context::max_interesting, max_parallel_hazard_walker(), NIL, parse(), and max_parallel_hazard_context::safe_param_ids.

Referenced by standard_planner().

{
    max_parallel_hazard_context context;

    context.max_hazard = PROPARALLEL_SAFE;
    context.max_interesting = PROPARALLEL_UNSAFE;
    context.safe_param_ids = NIL;
    (void) max_parallel_hazard_walker((Node *) parse, &context);
    return context.max_hazard;
}

not_clause()

bool not_clause

(

Node *

clause

)

Definition at line 237 of file clauses.c.

References boolop(), IsA, and NOT_EXPR.

Referenced by clause_selectivity(), dependency_is_compatible_clause(), expand_boolean_index_clause(), match_boolean_index_clause(), match_boolean_partition_clause(), and pull_up_sublinks_qual_recurse().

{
    return (clause != NULL &&
            IsA(clause, BoolExpr) &&
            ((BoolExpr *) clause)->boolop == NOT_EXPR);
}

NumRelids()

int NumRelids

(

Node *

clause

)

Definition at line 2273 of file clauses.c.

References bms_free(), bms_num_members(), and pull_varnos().

Referenced by clauselist_selectivity(), rowcomparesel(), and treat_as_join_clause().

{
    Relids      varnos = pull_varnos(clause);
    int         result = bms_num_members(varnos);

    bms_free(varnos);
    return result;
}

or_clause()

bool or_clause

(

Node *

clause

)

Definition at line 281 of file clauses.c.

References boolop(), IsA, and OR_EXPR.

Referenced by clause_selectivity(), extract_or_clause(), find_duplicate_ors(), gen_partprune_steps_internal(), make_restrictinfo(), make_sub_restrictinfos(), predicate_classify(), process_sublinks_mutator(), pull_ors(), simplify_or_arguments(), and TidQualFromExpr().

{
    return (clause != NULL &&
            IsA(clause, BoolExpr) &&
            ((BoolExpr *) clause)->boolop == OR_EXPR);
}