* planmain.c
* Routines to plan a single query
*
- * Copyright (c) 1994, Regents of the University of California
+ * What's in a name, anyway? The top-level entry point of the planner/
+ * optimizer is over in planner.c, not here as you might think from the
+ * file name. But this is the main code for planning a basic join operation,
+ * shorn of features like subselects, inheritance, aggregates, grouping,
+ * and so on. (Those are the things planner.c deals with.)
+ *
+ * Portions Copyright (c) 1996-2002, PostgreSQL Global Development Group
+ * Portions Copyright (c) 1994, Regents of the University of California
*
*
* IDENTIFICATION
- * $Header: /cvsroot/pgsql/src/backend/optimizer/plan/planmain.c,v 1.37 1999/06/12 19:38:30 tgl Exp $
+ * $Header: /cvsroot/pgsql/src/backend/optimizer/plan/planmain.c,v 1.75 2003/03/10 03:53:50 tgl Exp $
*
*-------------------------------------------------------------------------
*/
-#include <sys/types.h>
-
#include "postgres.h"
-#include "nodes/pg_list.h"
-#include "nodes/plannodes.h"
-#include "nodes/parsenodes.h"
-#include "nodes/print.h"
-#include "nodes/relation.h"
-#include "nodes/makefuncs.h"
-
-#include "optimizer/planmain.h"
-#include "optimizer/subselect.h"
-#include "optimizer/internal.h"
-#include "optimizer/prep.h"
-#include "optimizer/paths.h"
#include "optimizer/clauses.h"
-#include "optimizer/keys.h"
-#include "optimizer/tlist.h"
-#include "optimizer/var.h"
-#include "optimizer/xfunc.h"
#include "optimizer/cost.h"
+#include "optimizer/pathnode.h"
+#include "optimizer/paths.h"
+#include "optimizer/planmain.h"
-#include "tcop/dest.h"
-#include "utils/elog.h"
-#include "utils/palloc.h"
-#include "nodes/memnodes.h"
-#include "utils/mcxt.h"
-#include "utils/lsyscache.h"
-
-static Plan *subplanner(Query *root, List *flat_tlist, List *qual);
-static Result *make_result(List *tlist, Node *resconstantqual, Plan *subplan);
-/*
+/*--------------------
* query_planner
- * Routine to create a query plan. It does so by first creating a
- * subplan for the topmost level of attributes in the query. Then,
- * it modifies all target list and qualifications to consider the next
- * level of nesting and creates a plan for this modified query by
- * recursively calling itself. The two pieces are then merged together
- * by creating a result node that indicates which attributes should
- * be placed where and any relation level qualifications to be
- * satisfied.
+ * Generate a path (that is, a simplified plan) for a basic query,
+ * which may involve joins but not any fancier features.
*
- * command-type is the query command, e.g., select, delete, etc.
- * tlist is the target list of the query
- * qual is the qualification of the query
+ * Since query_planner does not handle the toplevel processing (grouping,
+ * sorting, etc) it cannot select the best path by itself. It selects
+ * two paths: the cheapest path that produces all the required tuples,
+ * independent of any ordering considerations, and the cheapest path that
+ * produces the expected fraction of the required tuples in the required
+ * ordering, if there is a path that is cheaper for this than just sorting
+ * the output of the cheapest overall path. The caller (grouping_planner)
+ * will make the final decision about which to use.
*
- * Returns a query plan.
+ * Input parameters:
+ * root is the query to plan
+ * tlist is the target list the query should produce (NOT root->targetList!)
+ * tuple_fraction is the fraction of tuples we expect will be retrieved
+ *
+ * Output parameters:
+ * *cheapest_path receives the overall-cheapest path for the query
+ * *sorted_path receives the cheapest presorted path for the query,
+ * if any (NULL if there is no useful presorted path)
+ *
+ * Note: the Query node also includes a query_pathkeys field, which is both
+ * an input and an output of query_planner(). The input value signals
+ * query_planner that the indicated sort order is wanted in the final output
+ * plan. But this value has not yet been "canonicalized", since the needed
+ * info does not get computed until we scan the qual clauses. We canonicalize
+ * it as soon as that task is done. (The main reason query_pathkeys is a
+ * Query field and not a passed parameter is that the low-level routines in
+ * indxpath.c need to see it.)
+ *
+ * tuple_fraction is interpreted as follows:
+ * 0: expect all tuples to be retrieved (normal case)
+ * 0 < tuple_fraction < 1: expect the given fraction of tuples available
+ * from the plan to be retrieved
+ * tuple_fraction >= 1: tuple_fraction is the absolute number of tuples
+ * expected to be retrieved (ie, a LIMIT specification)
+ *--------------------
*/
-Plan *
-query_planner(Query *root,
- int command_type,
- List *tlist,
- List *qual)
+void
+query_planner(Query *root, List *tlist, double tuple_fraction,
+ Path **cheapest_path, Path **sorted_path)
{
- List *constant_qual = NIL;
- List *var_only_tlist;
- List *level_tlist;
- Plan *subplan;
+ List *constant_quals;
+ RelOptInfo *final_rel;
+ Path *cheapestpath;
+ Path *sortedpath;
- if (PlannerQueryLevel > 1)
+ /*
+ * If the query has an empty join tree, then it's something easy like
+ * "SELECT 2+2;" or "INSERT ... VALUES()". Fall through quickly.
+ */
+ if (root->jointree->fromlist == NIL)
{
- /* should copy be made ? */
- tlist = (List *) SS_replace_correlation_vars((Node *) tlist);
- qual = (List *) SS_replace_correlation_vars((Node *) qual);
+ *cheapest_path = (Path *) create_result_path(NULL, NULL,
+ (List *) root->jointree->quals);
+ *sorted_path = NULL;
+ return;
}
- if (root->hasSubLinks)
- qual = (List *) SS_process_sublinks((Node *) qual);
-
- qual = cnfify((Expr *) qual, true);
-#ifdef OPTIMIZER_DEBUG
- printf("After cnfify()\n");
- pprint(qual);
-#endif
/*
- * Pull out any non-variable qualifications so these can be put in the
- * topmost result node.
+ * Pull out any non-variable WHERE clauses so these can be put in a
+ * toplevel "Result" node, where they will gate execution of the whole
+ * plan (the Result will not invoke its descendant plan unless the
+ * quals are true). Note that any *really* non-variable quals will
+ * have been optimized away by eval_const_expressions(). What we're
+ * mostly interested in here is quals that depend only on outer-level
+ * vars, although if the qual reduces to "WHERE FALSE" this path will
+ * also be taken.
*/
- qual = pull_constant_clauses(qual, &constant_qual);
+ root->jointree->quals = (Node *)
+ pull_constant_clauses((List *) root->jointree->quals,
+ &constant_quals);
+
/*
- * The opids for the variable qualifications will be fixed later, but
- * someone seems to think that the constant quals need to be fixed here.
+ * init planner lists to empty
+ *
+ * NOTE: in_info_list was set up by subquery_planner, do not touch here
*/
- fix_opids(constant_qual);
+ root->base_rel_list = NIL;
+ root->other_rel_list = NIL;
+ root->join_rel_list = NIL;
+ root->equi_key_list = NIL;
/*
- * Create a target list that consists solely of (resdom var) target
- * list entries, i.e., contains no arbitrary expressions.
+ * Construct RelOptInfo nodes for all base relations in query.
*/
- var_only_tlist = flatten_tlist(tlist);
- if (var_only_tlist)
- level_tlist = var_only_tlist;
- else
- /* from old code. the logic is beyond me. - ay 2/95 */
- level_tlist = tlist;
+ add_base_rels_to_query(root, (Node *) root->jointree);
/*
- * A query may have a non-variable target list and a non-variable
- * qualification only under certain conditions: - the query creates
- * all-new tuples, or - the query is a replace (a scan must still be
- * done in this case).
+ * Examine the targetlist and qualifications, adding entries to
+ * baserel targetlists for all referenced Vars. Restrict and join
+ * clauses are added to appropriate lists belonging to the mentioned
+ * relations. We also build lists of equijoined keys for pathkey
+ * construction.
+ *
+ * Note: all subplan nodes will have "flat" (var-only) tlists.
+ * This implies that all expression evaluations are done at the root of
+ * the plan tree. Once upon a time there was code to try to push
+ * expensive function calls down to lower plan nodes, but that's dead
+ * code and has been for a long time...
*/
- if (var_only_tlist == NULL && qual == NULL)
- {
- switch (command_type)
- {
- case CMD_SELECT:
- case CMD_INSERT:
- return ((Plan *) make_result(tlist,
- (Node *) constant_qual,
- (Plan *) NULL));
- break;
- case CMD_DELETE:
- case CMD_UPDATE:
- {
- SeqScan *scan = make_seqscan(tlist,
- NIL,
- root->resultRelation,
- (Plan *) NULL);
+ build_base_rel_tlists(root, tlist);
- if (constant_qual != NULL)
- return ((Plan *) make_result(tlist,
- (Node *) constant_qual,
- (Plan *) scan));
- else
- return (Plan *) scan;
- }
- break;
- default:
- return (Plan *) NULL;
- }
- }
+ (void) distribute_quals_to_rels(root, (Node *) root->jointree);
/*
- * Find the subplan (access path) and destructively modify the target
- * list of the newly created subplan to contain the appropriate join
- * references.
+ * Use the completed lists of equijoined keys to deduce any implied
+ * but unstated equalities (for example, A=B and B=C imply A=C).
*/
- subplan = subplanner(root, level_tlist, qual);
-
- set_tlist_references(subplan);
+ generate_implied_equalities(root);
/*
- * Build a result node linking the plan if we have constant quals
+ * We should now have all the pathkey equivalence sets built, so it's
+ * now possible to convert the requested query_pathkeys to canonical
+ * form.
*/
- if (constant_qual)
- {
- subplan = (Plan *) make_result(tlist,
- (Node *) constant_qual,
- subplan);
-
- /*
- * Fix all varno's of the Result's node target list.
- */
- set_tlist_references(subplan);
-
- return subplan;
- }
+ root->query_pathkeys = canonicalize_pathkeys(root, root->query_pathkeys);
/*
- * fix up the flattened target list of the plan root node so that
- * expressions are evaluated. this forces expression evaluations that
- * may involve expensive function calls to be delayed to the very last
- * stage of query execution. this could be bad. but it is joey's
- * responsibility to optimally push these expressions down the plan
- * tree. -- Wei
- *
- * Note: formerly there was a test here to skip the flatten call if we
- * expected union_planner to insert a Group or Agg node above our
- * result. However, now union_planner tells us exactly what it wants
- * returned, and we just do it. Much cleaner.
+ * Ready to do the primary planning.
*/
- else
- {
- subplan->targetlist = flatten_tlist_vars(tlist,
- subplan->targetlist);
- return subplan;
- }
+ final_rel = make_one_rel(root);
-#ifdef NOT_USED
+ if (!final_rel || !final_rel->cheapest_total_path)
+ elog(ERROR, "query_planner: failed to construct a relation");
/*
- * Destructively modify the query plan's targetlist to add fjoin lists
- * to flatten functions that return sets of base types
+ * Now that we have an estimate of the final rel's size, we can
+ * convert a tuple_fraction specified as an absolute count (ie, a
+ * LIMIT option) into a fraction of the total tuples.
*/
- subplan->targetlist = generate_fjoin(subplan->targetlist);
-#endif
-
-}
-
-/*
- * subplanner
- *
- * Subplanner creates an entire plan consisting of joins and scans
- * for processing a single level of attributes.
- *
- * flat_tlist is the flattened target list
- * qual is the qualification to be satisfied
- *
- * Returns a subplan.
- *
- */
-static Plan *
-subplanner(Query *root,
- List *flat_tlist,
- List *qual)
-{
- RelOptInfo *final_rel;
+ if (tuple_fraction >= 1.0)
+ tuple_fraction /= final_rel->rows;
/*
- * Initialize the targetlist and qualification, adding entries to
- * base_rel_list as relation references are found (e.g., in the
- * qualification, the targetlist, etc.)
+ * Pick out the cheapest-total path and the cheapest presorted path
+ * for the requested pathkeys (if there is one). We should take the
+ * tuple fraction into account when selecting the cheapest presorted
+ * path, but not when selecting the cheapest-total path, since if we
+ * have to sort then we'll have to fetch all the tuples. (But there's
+ * a special case: if query_pathkeys is NIL, meaning order doesn't
+ * matter, then the "cheapest presorted" path will be the cheapest
+ * overall for the tuple fraction.)
+ *
+ * The cheapest-total path is also the one to use if grouping_planner
+ * decides to use hashed aggregation, so we return it separately even
+ * if this routine thinks the presorted path is the winner.
*/
- root->base_rel_list = NIL;
- root->join_rel_list = NIL;
+ cheapestpath = final_rel->cheapest_total_path;
- make_var_only_tlist(root, flat_tlist);
- add_restrict_and_join_to_rels(root, qual);
- add_missing_vars_to_tlist(root, flat_tlist);
+ sortedpath =
+ get_cheapest_fractional_path_for_pathkeys(final_rel->pathlist,
+ root->query_pathkeys,
+ tuple_fraction);
- set_joininfo_mergeable_hashable(root->base_rel_list);
-
- final_rel = make_one_rel(root, root->base_rel_list);
-
-#ifdef NOT_USED /* fix xfunc */
+ /* Don't return same path in both guises; just wastes effort */
+ if (sortedpath == cheapestpath)
+ sortedpath = NULL;
/*
- * Perform Predicate Migration on each path, to optimize and correctly
- * assess the cost of each before choosing the cheapest one. -- JMH,
- * 11/16/92
- *
- * Needn't do so if the top rel is pruneable: that means there's no
- * expensive functions left to pull up. -- JMH, 11/22/92
+ * Forget about the presorted path if it would be cheaper to sort the
+ * cheapest-total path. Here we need consider only the behavior at
+ * the tuple fraction point.
*/
- if (XfuncMode != XFUNC_OFF && XfuncMode != XFUNC_NOPM &&
- XfuncMode != XFUNC_NOPULL && !final_rel->pruneable)
+ if (sortedpath)
{
- List *pathnode;
+ Path sort_path; /* dummy for result of cost_sort */
+
+ if (root->query_pathkeys == NIL ||
+ pathkeys_contained_in(root->query_pathkeys,
+ cheapestpath->pathkeys))
+ {
+ /* No sort needed for cheapest path */
+ sort_path.startup_cost = cheapestpath->startup_cost;
+ sort_path.total_cost = cheapestpath->total_cost;
+ }
+ else
+ {
+ /* Figure cost for sorting */
+ cost_sort(&sort_path, root, root->query_pathkeys,
+ cheapestpath->total_cost,
+ final_rel->rows, final_rel->width);
+ }
- foreach(pathnode, final_rel->pathlist)
+ if (compare_fractional_path_costs(sortedpath, &sort_path,
+ tuple_fraction) > 0)
{
- if (xfunc_do_predmig((Path *) lfirst(pathnode)))
- set_cheapest(final_rel, final_rel->pathlist);
+ /* Presorted path is a loser */
+ sortedpath = NULL;
}
}
-#endif
/*
- * Determine the cheapest path and create a subplan corresponding to
- * it.
+ * If we have constant quals, add a toplevel Result step to process them.
*/
- if (final_rel)
- return create_plan((Path *) final_rel->cheapestpath);
- else
+ if (constant_quals)
{
- elog(NOTICE, "final relation is null");
- return create_plan((Path *) NULL);
+ cheapestpath = (Path *) create_result_path(final_rel,
+ cheapestpath,
+ constant_quals);
+ if (sortedpath)
+ sortedpath = (Path *) create_result_path(final_rel,
+ sortedpath,
+ constant_quals);
}
-}
-
-/*****************************************************************************
- *
- *****************************************************************************/
-
-static Result *
-make_result(List *tlist,
- Node *resconstantqual,
- Plan *subplan)
-{
- Result *node = makeNode(Result);
- Plan *plan = &node->plan;
-
-#ifdef NOT_USED
- tlist = generate_fjoin(tlist);
-#endif
- plan->cost = (subplan ? subplan->cost : 0);
- plan->state = (EState *) NULL;
- plan->targetlist = tlist;
- plan->lefttree = subplan;
- plan->righttree = NULL;
- node->resconstantqual = resconstantqual;
- node->resstate = NULL;
-
- return node;
+ *cheapest_path = cheapestpath;
+ *sorted_path = sortedpath;
}
projects / postgresql / blobdiff