OSDN Git Service

Prepare for release 1.0.2.
[pghintplan/pg_hint_plan.git] / pg_hint_plan.c
index fa06b2d..87cf0d8 100644 (file)
@@ -32,6 +32,7 @@
 #include "utils/memutils.h"
 #include "utils/rel.h"
 #include "utils/syscache.h"
+#include "utils/resowner.h"
 #if PG_VERSION_NUM >= 90200
 #include "catalog/pg_class.h"
 #endif
@@ -409,13 +410,17 @@ static void pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate,
                                                                                  PLpgSQL_stmt *stmt);
 static void pg_hint_plan_plpgsql_stmt_end(PLpgSQL_execstate *estate,
                                                                                  PLpgSQL_stmt *stmt);
+static void plpgsql_query_erase_callback(ResourceReleasePhase phase,
+                                                                                bool isCommit,
+                                                                                bool isTopLevel,
+                                                                                void *arg);
 
 /* GUC variables */
 static bool    pg_hint_plan_enable_hint = true;
 static bool    pg_hint_plan_debug_print = false;
 static int     pg_hint_plan_parse_messages = INFO;
 /* Default is off, to keep backward compatibility. */
-static bool    pg_hint_plan_lookup_hint_in_table = false;
+static bool    pg_hint_plan_enable_hint_table = false;
 
 static const struct config_enum_entry parse_messages_level_options[] = {
        {"debug", DEBUG2, true},
@@ -490,7 +495,9 @@ static const HintParser parsers[] = {
  * PL/pgSQL plugin for retrieving string representation of each query during
  * function execution.
  */
-const char *plpgsql_query_string = NULL;
+static const char *plpgsql_query_string = NULL;
+static enum PLpgSQL_stmt_types plpgsql_query_string_src;
+
 PLpgSQL_plugin  plugin_funcs = {
        NULL,
        NULL,
@@ -547,10 +554,10 @@ _PG_init(void)
                                                         NULL,
                                                         NULL);
 
-       DefineCustomBoolVariable("pg_hint_plan.lookup_hint_in_table",
+       DefineCustomBoolVariable("pg_hint_plan.enable_hint_table",
                                         "Force planner to not get hint by using table lookups.",
                                                         NULL,
-                                                        &pg_hint_plan_lookup_hint_in_table,
+                                                        &pg_hint_plan_enable_hint_table,
                                                         false,
                                                         PGC_USERSET,
                                                         0,
@@ -571,6 +578,8 @@ _PG_init(void)
        /* setup PL/pgSQL plugin hook */
        var_ptr = (PLpgSQL_plugin **) find_rendezvous_variable("PLpgSQL_plugin");
        *var_ptr = &plugin_funcs;
+
+       RegisterResourceReleaseCallback(plpgsql_query_erase_callback, NULL);
 }
 
 /*
@@ -2216,13 +2225,13 @@ pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams)
         * Create hintstate from hint specified for the query, if any.
         *
         * First we lookup hint in pg_hint.hints table by normalized query string,
-        * unless pg_hint_plan.lookup_hint_in_table is OFF.
+        * unless pg_hint_plan.enable_hint_table is OFF.
         * This parameter provides option to avoid overhead of table lookup during
         * planning.
         *
         * If no hint was found, then we try to get hint from special query comment.
         */
-       if (pg_hint_plan_lookup_hint_in_table)
+       if (pg_hint_plan_enable_hint_table)
        {
                /*
                 * Search hint information which is stored for the query and the
@@ -2345,7 +2354,7 @@ standard_planner_proc:
  * Return scan method hint which matches given aliasname.
  */
 static ScanMethodHint *
-find_scan_hint(PlannerInfo *root, RelOptInfo *rel)
+find_scan_hint(PlannerInfo *root, Index relid, RelOptInfo *rel)
 {
        RangeTblEntry  *rte;
        int                             i;
@@ -2355,10 +2364,10 @@ find_scan_hint(PlannerInfo *root, RelOptInfo *rel)
         *   - not a base relation
         *   - not an ordinary relation (such as join and subquery)
         */
-       if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
+       if (rel && (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION))
                return NULL;
 
-       rte = root->simple_rte_array[rel->relid];
+       rte = root->simple_rte_array[relid];
 
        /* We can't force scan method of foreign tables */
        if (rte->relkind == RELKIND_FOREIGN_TABLE)
@@ -2748,7 +2757,7 @@ static void
 pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
                                                           bool inhparent, RelOptInfo *rel)
 {
-       ScanMethodHint *hint;
+       ScanMethodHint *hint = NULL;
 
        if (prev_get_relation_info)
                (*prev_get_relation_info) (root, relationObjectId, inhparent, rel);
@@ -2764,17 +2773,114 @@ pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
        {
                /* store does relids of parent table. */
                current_hint->parent_relid = rel->relid;
-               current_hint->parent_rel_oid = relationObjectId;
+               
        }
-       else if (current_hint->parent_relid != 0)
+       else
        {
                /*
-                * We use the same GUC parameter if this table is the child table of a
-                * table called pg_hint_plan_get_relation_info just before that.
+                * Inheritance planner doesn't request information for the parent
+                * relation so we should check if this relation has a parent. We can
+                * ignore nested inheritace case because inheritance planner doesn't
+                * meet it.
+                */
+               ListCell *l;
+               foreach (l, root->append_rel_list)
+               {
+                       AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l);
+
+                       if (appinfo->child_relid == rel->relid)
+                       {
+                               if (current_hint->parent_relid != appinfo->parent_relid)
+                               {
+                                       inhparent = true;
+                                       current_hint->parent_relid = appinfo->parent_relid;
+                               }
+                               break;
+                       }
+               }
+
+       }
+
+       if (inhparent)
+       {
+               Relation    parent_rel;
+               List       *indexoidlist;
+               ListCell   *l;
+               Oid                     parentrel_oid;
+
+               /*
+                * Get and apply the hint for theparent_rel if the new parent has been
+                * found. This relation should be an ordinary relation so calling
+                * find_scan_hint with rel == NULL is safe.
+                */
+               if ((hint = find_scan_hint(root, current_hint->parent_relid,
+                                                                  NULL)) == NULL)
+               {
+                       set_scan_config_options(current_hint->init_scan_mask,
+                                                                       current_hint->context);
+               }
+               else
+               {
+                       set_scan_config_options(hint->enforce_mask,     current_hint->context);
+                       hint->base.state = HINT_STATE_USED;
+               }
+
+               current_hint->parent_hint = hint;
+
+               /* Resolve index name mask (if any) using this parent. */
+               if (hint && hint->indexnames)
+               {
+                       parentrel_oid =
+                               root->simple_rte_array[current_hint->parent_relid]->relid;
+                       parent_rel = heap_open(parentrel_oid, NoLock);
+
+                       /*
+                        * Search for indexes match the hint for this parent
+                        */
+                       indexoidlist = RelationGetIndexList(parent_rel);
+
+                       foreach(l, indexoidlist)
+                       {
+                               Oid         indexoid = lfirst_oid(l);
+                               char       *indexname = get_rel_name(indexoid);
+                               bool        use_index = false;
+                               ListCell   *lc;
+                               ParentIndexInfo *parent_index_info;
+
+                               foreach(lc, hint->indexnames)
+                               {
+                                       if (RelnameCmp(&indexname, &lfirst(lc)) == 0)
+                                       {
+                                               use_index = true;
+                                               break;
+                                       }
+                               }
+                               if (!use_index)
+                                       continue;
+
+                               parent_index_info = get_parent_index_info(indexoid,
+                                                                                                                 parentrel_oid);
+                               current_hint->parent_index_infos =
+                                       lappend(current_hint->parent_index_infos, parent_index_info);
+                       }
+                       heap_close(parent_rel, NoLock);
+               }
+
+               if (current_hint->parent_relid == rel->relid)
+               {
+                       /* This rel is a inheritance parent, which won't be scanned. */
+                       return;
+               }
+       }
+
+       if (current_hint->parent_hint != 0)
+       {
+               /*
+                * If inheritance parent is registered, check if it is really my
+                * parent.
                 */
                ListCell   *l;
 
-               /* append_rel_list contains all append rels; ignore others */
                foreach(l, root->append_rel_list)
                {
                        AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l);
@@ -2787,21 +2893,19 @@ pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
                                        delete_indexes(current_hint->parent_hint, rel,
                                                                   relationObjectId);
 
+                               /* Scan fixation status is the same to the parent. */
                                return;
                        }
                }
 
-               /* This rel is not inherit table. */
+               /* This rel is not a child of the current parent. */
                current_hint->parent_relid = 0;
                current_hint->parent_rel_oid = InvalidOid;
                current_hint->parent_hint = NULL;
        }
 
-       /*
-        * If scan method hint was given, reset GUC parameters which control
-        * planner behavior about choosing scan methods.
-        */
-       if ((hint = find_scan_hint(root, rel)) == NULL)
+       /* This table doesn't have a parent. Apply its own hints */
+       if ((hint = find_scan_hint(root, rel->relid, rel)) == NULL)
        {
                set_scan_config_options(current_hint->init_scan_mask,
                                                                current_hint->context);
@@ -2810,45 +2914,7 @@ pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
        set_scan_config_options(hint->enforce_mask, current_hint->context);
        hint->base.state = HINT_STATE_USED;
 
-       if (inhparent)
-       {
-               Relation    relation;
-               List       *indexoidlist;
-               ListCell   *l;
-
-               current_hint->parent_hint = hint;
-
-               relation = heap_open(relationObjectId, NoLock);
-               indexoidlist = RelationGetIndexList(relation);
-
-               foreach(l, indexoidlist)
-               {
-                       Oid         indexoid = lfirst_oid(l);
-                       char       *indexname = get_rel_name(indexoid);
-                       bool        use_index = false;
-                       ListCell   *lc;
-                       ParentIndexInfo *parent_index_info;
-
-                       foreach(lc, hint->indexnames)
-                       {
-                               if (RelnameCmp(&indexname, &lfirst(lc)) == 0)
-                               {
-                                       use_index = true;
-                                       break;
-                               }
-                       }
-                       if (!use_index)
-                               continue;
-
-                       parent_index_info = get_parent_index_info(indexoid,
-                                                                                                         relationObjectId);
-                       current_hint->parent_index_infos =
-                               lappend(current_hint->parent_index_infos, parent_index_info);
-               }
-               heap_close(relation, NoLock);
-       }
-       else
-               delete_indexes(hint, rel, InvalidOid);
+       delete_indexes(hint, rel, InvalidOid);
 }
 
 /*
@@ -3317,7 +3383,7 @@ rebuild_scan_path(HintState *hstate, PlannerInfo *root, int level,
                 * planner if scan method hint is not specified, otherwise use
                 * specified hints and mark the hint as used.
                 */
-               if ((hint = find_scan_hint(root, rel)) == NULL)
+               if ((hint = find_scan_hint(root, rel->relid, rel)) == NULL)
                        set_scan_config_options(hstate->init_scan_mask,
                                                                        hstate->context);
                else
@@ -3403,7 +3469,7 @@ add_paths_to_joinrel_wrapper(PlannerInfo *root,
        JoinMethodHint *join_hint;
        int                             save_nestlevel;
 
-       if ((scan_hint = find_scan_hint(root, innerrel)) != NULL)
+       if ((scan_hint = find_scan_hint(root, innerrel->relid, innerrel)) != NULL)
        {
                set_scan_config_options(scan_hint->enforce_mask, current_hint->context);
                scan_hint->base.state = HINT_STATE_USED;
@@ -3587,10 +3653,47 @@ set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
 static void
 pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt)
 {
-       if ((enum PLpgSQL_stmt_types) stmt->cmd_type == PLPGSQL_STMT_EXECSQL)
+       PLpgSQL_expr *expr = NULL;
+
+       switch ((enum PLpgSQL_stmt_types) stmt->cmd_type)
+       {
+               case PLPGSQL_STMT_FORS:
+                       expr = ((PLpgSQL_stmt_fors *) stmt)->query;
+                       break;
+               case PLPGSQL_STMT_FORC:
+                               expr = ((PLpgSQL_var *) (estate->datums[((PLpgSQL_stmt_forc *)stmt)->curvar]))->cursor_explicit_expr;
+                       break;
+               case PLPGSQL_STMT_RETURN_QUERY:
+                       if (((PLpgSQL_stmt_return_query *) stmt)->query != NULL)
+                               expr = ((PLpgSQL_stmt_return_query *) stmt)->query;
+                       else
+                               expr = ((PLpgSQL_stmt_return_query *) stmt)->dynquery;
+                       break;
+               case PLPGSQL_STMT_EXECSQL:
+                       expr = ((PLpgSQL_stmt_execsql *) stmt)->sqlstmt;
+                       break;
+               case PLPGSQL_STMT_DYNEXECUTE:
+                       expr = ((PLpgSQL_stmt_dynexecute *) stmt)->query;
+                       break;
+               case PLPGSQL_STMT_DYNFORS:
+                       expr = ((PLpgSQL_stmt_dynfors *) stmt)->query;
+                       break;
+               case PLPGSQL_STMT_OPEN:
+                       if (((PLpgSQL_stmt_open *) stmt)->query != NULL)
+                               expr = ((PLpgSQL_stmt_open *) stmt)->query;
+                       else if (((PLpgSQL_stmt_open *) stmt)->dynquery != NULL)
+                               expr = ((PLpgSQL_stmt_open *) stmt)->dynquery;
+                       else
+                               expr = ((PLpgSQL_var *) (estate->datums[((PLpgSQL_stmt_open *)stmt)->curvar]))->cursor_explicit_expr;
+                       break;
+               default:
+                       break;
+       }
+
+       if (expr)
        {
-               PLpgSQL_expr *expr = ((PLpgSQL_stmt_execsql *) stmt)->sqlstmt;
                plpgsql_query_string = expr->query;
+               plpgsql_query_string_src = (enum PLpgSQL_stmt_types) stmt->cmd_type;
        }
 }
 
@@ -3602,10 +3705,22 @@ pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt)
 static void
 pg_hint_plan_plpgsql_stmt_end(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt)
 {
-       if ((enum PLpgSQL_stmt_types) stmt->cmd_type == PLPGSQL_STMT_EXECSQL)
+       if (plpgsql_query_string &&
+               plpgsql_query_string_src == stmt->cmd_type)
                plpgsql_query_string = NULL;
 }
 
+void plpgsql_query_erase_callback(ResourceReleasePhase phase,
+                                                                 bool isCommit,
+                                                                 bool isTopLevel,
+                                                                 void *arg)
+{
+       if (phase != RESOURCE_RELEASE_AFTER_LOCKS)
+               return;
+       /* Force erase stored plpgsql query string */
+       plpgsql_query_string = NULL;
+}
+
 #define standard_join_search pg_hint_plan_standard_join_search
 #define join_search_one_level pg_hint_plan_join_search_one_level
 #define make_join_rel make_join_rel_wrapper