/*-------------------------------------------------------------------------
*
* pg_hint_plan.c
- * Track statement execution in current/last transaction.
+ * do instructions or hints to the planner using C-style block comments
+ * of the SQL.
*
- * Copyright (c) 2011, PostgreSQL Global Development Group
- *
- * IDENTIFICATION
- * contrib/pg_hint_plan/pg_hint_plan.c
+ * Copyright (c) 2012-2013, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
*
*-------------------------------------------------------------------------
*/
#include "postgres.h"
-#include "fmgr.h"
-#include "utils/elog.h"
-#include "utils/builtins.h"
-#include "utils/memutils.h"
+#include "catalog/pg_collation.h"
+#include "catalog/pg_index.h"
+#include "commands/prepare.h"
+#include "mb/pg_wchar.h"
+#include "miscadmin.h"
+#include "nodes/nodeFuncs.h"
+#include "optimizer/clauses.h"
#include "optimizer/cost.h"
+#include "optimizer/geqo.h"
#include "optimizer/joininfo.h"
#include "optimizer/pathnode.h"
#include "optimizer/paths.h"
+#include "optimizer/plancat.h"
+#include "optimizer/planner.h"
+#include "optimizer/prep.h"
+#include "optimizer/restrictinfo.h"
+#include "parser/scansup.h"
+#include "tcop/utility.h"
+#include "utils/builtins.h"
+#include "utils/lsyscache.h"
+#include "utils/memutils.h"
+#include "utils/rel.h"
+#include "utils/syscache.h"
+#if PG_VERSION_NUM >= 90200
+#include "catalog/pg_class.h"
+#endif
+
+#include "plpgsql.h"
#ifdef PG_MODULE_MAGIC
PG_MODULE_MAGIC;
#endif
-#define HASH_ENTRIES 201
+#if PG_VERSION_NUM < 90100
+#error unsupported PostgreSQL version
+#endif
+
+#define BLOCK_COMMENT_START "/*"
+#define BLOCK_COMMENT_END "*/"
+#define HINT_COMMENT_KEYWORD "+"
+#define HINT_START BLOCK_COMMENT_START HINT_COMMENT_KEYWORD
+#define HINT_END BLOCK_COMMENT_END
+
+/* hint keywords */
+#define HINT_SEQSCAN "SeqScan"
+#define HINT_INDEXSCAN "IndexScan"
+#define HINT_INDEXSCANREGEXP "IndexScanRegexp"
+#define HINT_BITMAPSCAN "BitmapScan"
+#define HINT_BITMAPSCANREGEXP "BitmapScanRegexp"
+#define HINT_TIDSCAN "TidScan"
+#define HINT_NOSEQSCAN "NoSeqScan"
+#define HINT_NOINDEXSCAN "NoIndexScan"
+#define HINT_NOBITMAPSCAN "NoBitmapScan"
+#define HINT_NOTIDSCAN "NoTidScan"
+#if PG_VERSION_NUM >= 90200
+#define HINT_INDEXONLYSCAN "IndexOnlyScan"
+#define HINT_INDEXONLYSCANREGEXP "IndexOnlyScanRegexp"
+#define HINT_NOINDEXONLYSCAN "NoIndexOnlyScan"
+#endif
+#define HINT_NESTLOOP "NestLoop"
+#define HINT_MERGEJOIN "MergeJoin"
+#define HINT_HASHJOIN "HashJoin"
+#define HINT_NONESTLOOP "NoNestLoop"
+#define HINT_NOMERGEJOIN "NoMergeJoin"
+#define HINT_NOHASHJOIN "NoHashJoin"
+#define HINT_LEADING "Leading"
+#define HINT_SET "Set"
+
+#define HINT_ARRAY_DEFAULT_INITSIZE 8
+
+#define hint_ereport(str, detail) \
+ ereport(pg_hint_plan_parse_messages, \
+ (errmsg("hint syntax error at or near \"%s\"", (str)), \
+ errdetail detail))
+
+#define skip_space(str) \
+ while (isspace(*str)) \
+ str++;
enum
{
- ENABLE_SEQSCAN = 0x01,
- ENABLE_INDEXSCAN = 0x02,
- ENABLE_BITMAPSCAN = 0x04,
- ENABLE_TIDSCAN = 0x08,
- ENABLE_NESTLOOP = 0x10,
- ENABLE_MERGEJOIN = 0x20,
- ENABLE_HASHJOIN = 0x40
-} TYPE_BITS;
+ ENABLE_SEQSCAN = 0x01,
+ ENABLE_INDEXSCAN = 0x02,
+ ENABLE_BITMAPSCAN = 0x04,
+ ENABLE_TIDSCAN = 0x08,
+#if PG_VERSION_NUM >= 90200
+ ENABLE_INDEXONLYSCAN = 0x10
+#endif
+} SCAN_TYPE_BITS;
-typedef struct tidlist
+enum
{
- int nrels;
- Oid *oids;
-} TidList;
+ ENABLE_NESTLOOP = 0x01,
+ ENABLE_MERGEJOIN = 0x02,
+ ENABLE_HASHJOIN = 0x04
+} JOIN_TYPE_BITS;
+
+#if PG_VERSION_NUM >= 90200
+#define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
+ ENABLE_BITMAPSCAN | ENABLE_TIDSCAN | \
+ ENABLE_INDEXONLYSCAN)
+#else
+#define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
+ ENABLE_BITMAPSCAN | ENABLE_TIDSCAN)
+#endif
+#define ENABLE_ALL_JOIN (ENABLE_NESTLOOP | ENABLE_MERGEJOIN | ENABLE_HASHJOIN)
+#define DISABLE_ALL_SCAN 0
+#define DISABLE_ALL_JOIN 0
-typedef struct hash_entry
+/* hint keyword of enum type*/
+typedef enum HintKeyword
{
- TidList tidlist;
- unsigned char enforce_mask;
- struct hash_entry *next;
-} HashEntry;
-
-static HashEntry *hashent[HASH_ENTRIES];
-#ifdef NOT_USED
-static bool (*org_cost_hook)(CostHookType type, PlannerInfo *root, Path *path1, Path *path2);
+ HINT_KEYWORD_SEQSCAN,
+ HINT_KEYWORD_INDEXSCAN,
+ HINT_KEYWORD_INDEXSCANREGEXP,
+ HINT_KEYWORD_BITMAPSCAN,
+ HINT_KEYWORD_BITMAPSCANREGEXP,
+ HINT_KEYWORD_TIDSCAN,
+ HINT_KEYWORD_NOSEQSCAN,
+ HINT_KEYWORD_NOINDEXSCAN,
+ HINT_KEYWORD_NOBITMAPSCAN,
+ HINT_KEYWORD_NOTIDSCAN,
+#if PG_VERSION_NUM >= 90200
+ HINT_KEYWORD_INDEXONLYSCAN,
+ HINT_KEYWORD_INDEXONLYSCANREGEXP,
+ HINT_KEYWORD_NOINDEXONLYSCAN,
#endif
-static bool print_log = false;
-static bool tweak_enabled = true;
+ HINT_KEYWORD_NESTLOOP,
+ HINT_KEYWORD_MERGEJOIN,
+ HINT_KEYWORD_HASHJOIN,
+ HINT_KEYWORD_NONESTLOOP,
+ HINT_KEYWORD_NOMERGEJOIN,
+ HINT_KEYWORD_NOHASHJOIN,
+ HINT_KEYWORD_LEADING,
+ HINT_KEYWORD_SET,
+ HINT_KEYWORD_UNRECOGNIZED
+} HintKeyword;
+
+typedef struct Hint Hint;
+typedef struct HintState HintState;
+
+typedef Hint *(*HintCreateFunction) (const char *hint_str,
+ const char *keyword,
+ HintKeyword hint_keyword);
+typedef void (*HintDeleteFunction) (Hint *hint);
+typedef void (*HintDescFunction) (Hint *hint, StringInfo buf);
+typedef int (*HintCmpFunction) (const Hint *a, const Hint *b);
+typedef const char *(*HintParseFunction) (Hint *hint, HintState *hstate,
+ Query *parse, const char *str);
+
+/* hint types */
+#define NUM_HINT_TYPE 4
+typedef enum HintType
+{
+ HINT_TYPE_SCAN_METHOD,
+ HINT_TYPE_JOIN_METHOD,
+ HINT_TYPE_LEADING,
+ HINT_TYPE_SET
+} HintType;
+
+static const char *HintTypeName[] = {
+ "scan method",
+ "join method",
+ "leading",
+ "set"
+};
+
+/* hint status */
+typedef enum HintStatus
+{
+ HINT_STATE_NOTUSED = 0, /* specified relation not used in query */
+ HINT_STATE_USED, /* hint is used */
+ HINT_STATE_DUPLICATION, /* specified hint duplication */
+ HINT_STATE_ERROR /* execute error (parse error does not include
+ * it) */
+} HintStatus;
+
+#define hint_state_enabled(hint) ((hint)->base.state == HINT_STATE_NOTUSED || \
+ (hint)->base.state == HINT_STATE_USED)
+
+/* common data for all hints. */
+struct Hint
+{
+ const char *hint_str; /* must not do pfree */
+ const char *keyword; /* must not do pfree */
+ HintKeyword hint_keyword;
+ HintType type;
+ HintStatus state;
+ HintDeleteFunction delete_func;
+ HintDescFunction desc_func;
+ HintCmpFunction cmp_func;
+ HintParseFunction parse_func;
+};
+
+/* scan method hints */
+typedef struct ScanMethodHint
+{
+ Hint base;
+ char *relname;
+ List *indexnames;
+ bool regexp;
+ unsigned char enforce_mask;
+} ScanMethodHint;
+
+typedef struct ParentIndexInfo
+{
+ bool indisunique;
+ Oid method;
+ List *column_names;
+ char *expression_str;
+ Oid *indcollation;
+ Oid *opclass;
+ int16 *indoption;
+ char *indpred_str;
+} ParentIndexInfo;
+
+/* join method hints */
+typedef struct JoinMethodHint
+{
+ Hint base;
+ int nrels;
+ int inner_nrels;
+ char **relnames;
+ unsigned char enforce_mask;
+ Relids joinrelids;
+ Relids inner_joinrelids;
+} JoinMethodHint;
+
+/* join order hints */
+typedef struct OuterInnerRels
+{
+ char *relation;
+ List *outer_inner_pair;
+} OuterInnerRels;
+
+typedef struct LeadingHint
+{
+ Hint base;
+ List *relations; /* relation names specified in Leading hint */
+ OuterInnerRels *outer_inner;
+} LeadingHint;
+
+/* change a run-time parameter hints */
+typedef struct SetHint
+{
+ Hint base;
+ char *name; /* name of variable */
+ char *value;
+ List *words;
+} SetHint;
+
+/*
+ * Describes a context of hint processing.
+ */
+struct HintState
+{
+ char *hint_str; /* original hint string */
+
+ /* all hint */
+ int nall_hints; /* # of valid all hints */
+ int max_all_hints; /* # of slots for all hints */
+ Hint **all_hints; /* parsed all hints */
+
+ /* # of each hints */
+ int num_hints[NUM_HINT_TYPE];
+
+ /* for scan method hints */
+ ScanMethodHint **scan_hints; /* parsed scan hints */
+ int init_scan_mask; /* initial value scan parameter */
+ Index parent_relid; /* inherit parent table relid */
+ Oid parent_rel_oid; /* inherit parent table relid */
+ ScanMethodHint *parent_hint; /* inherit parent table scan hint */
+ List *parent_index_infos; /* infomation of inherit parent table's
+ * index */
+
+ /* for join method hints */
+ JoinMethodHint **join_hints; /* parsed join hints */
+ int init_join_mask; /* initial value join parameter */
+ List **join_hint_level;
+
+ /* for Leading hint */
+ LeadingHint **leading_hint; /* parsed Leading hints */
+
+ /* for Set hints */
+ SetHint **set_hints; /* parsed Set hints */
+ GucContext context; /* which GUC parameters can we set? */
+};
+
+/*
+ * Describes a hint parser module which is bound with particular hint keyword.
+ */
+typedef struct HintParser
+{
+ char *keyword;
+ HintCreateFunction create_func;
+ HintKeyword hint_keyword;
+} HintParser;
/* Module callbacks */
void _PG_init(void);
void _PG_fini(void);
-Datum pg_add_hint(PG_FUNCTION_ARGS);
-Datum pg_clear_hint(PG_FUNCTION_ARGS);
-Datum pg_dump_hint(PG_FUNCTION_ARGS);
-Datum pg_enable_hint(bool arg, bool *isnull);
-Datum pg_enable_log(bool arg, bool *isnull);
-
-#ifdef NOT_USED
-static char *rels_str(PlannerInfo *root, Path *path);
-static void dump_rels(char *label, PlannerInfo *root, Path *path, bool found, bool enabled);
-static void dump_joinrels(char *label, PlannerInfo *root, Path *inpath, Path *outpath, bool found, bool enabled);
-static bool my_cost_hook(CostHookType type, PlannerInfo *root, Path *path1, Path *path2);
+
+static void push_hint(HintState *hstate);
+static void pop_hint(void);
+
+static void pg_hint_plan_ProcessUtility(Node *parsetree,
+ const char *queryString,
+ ParamListInfo params, bool isTopLevel,
+ DestReceiver *dest,
+ char *completionTag);
+static PlannedStmt *pg_hint_plan_planner(Query *parse, int cursorOptions,
+ ParamListInfo boundParams);
+static void pg_hint_plan_get_relation_info(PlannerInfo *root,
+ Oid relationObjectId,
+ bool inhparent, RelOptInfo *rel);
+static RelOptInfo *pg_hint_plan_join_search(PlannerInfo *root,
+ int levels_needed,
+ List *initial_rels);
+
+static Hint *ScanMethodHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword);
+static void ScanMethodHintDelete(ScanMethodHint *hint);
+static void ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf);
+static int ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b);
+static const char *ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate,
+ Query *parse, const char *str);
+static Hint *JoinMethodHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword);
+static void JoinMethodHintDelete(JoinMethodHint *hint);
+static void JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf);
+static int JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b);
+static const char *JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate,
+ Query *parse, const char *str);
+static Hint *LeadingHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword);
+static void LeadingHintDelete(LeadingHint *hint);
+static void LeadingHintDesc(LeadingHint *hint, StringInfo buf);
+static int LeadingHintCmp(const LeadingHint *a, const LeadingHint *b);
+static const char *LeadingHintParse(LeadingHint *hint, HintState *hstate,
+ Query *parse, const char *str);
+static Hint *SetHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword);
+static void SetHintDelete(SetHint *hint);
+static void SetHintDesc(SetHint *hint, StringInfo buf);
+static int SetHintCmp(const SetHint *a, const SetHint *b);
+static const char *SetHintParse(SetHint *hint, HintState *hstate, Query *parse,
+ const char *str);
+
+static void quote_value(StringInfo buf, const char *value);
+
+static const char *parse_quoted_value(const char *str, char **word,
+ bool truncate);
+
+RelOptInfo *pg_hint_plan_standard_join_search(PlannerInfo *root,
+ int levels_needed,
+ List *initial_rels);
+void pg_hint_plan_join_search_one_level(PlannerInfo *root, int level);
+static void make_rels_by_clause_joins(PlannerInfo *root, RelOptInfo *old_rel,
+ ListCell *other_rels);
+static void make_rels_by_clauseless_joins(PlannerInfo *root,
+ RelOptInfo *old_rel,
+ ListCell *other_rels);
+static bool has_join_restriction(PlannerInfo *root, RelOptInfo *rel);
+static void set_append_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
+ Index rti, RangeTblEntry *rte);
+#if PG_VERSION_NUM >= 90200
+static void generate_mergeappend_paths(PlannerInfo *root, RelOptInfo *rel,
+ List *live_childrels,
+ List *all_child_pathkeys);
#endif
-static void free_hashent(HashEntry *head);
-static unsigned int calc_hash(TidList *tidlist);
-#ifdef NOT_USED
-static HashEntry *search_ent(TidList *tidlist);
+static List *accumulate_append_subpath(List *subpaths, Path *path);
+#if PG_VERSION_NUM < 90200
+static void set_dummy_rel_pathlist(RelOptInfo *rel);
#endif
+RelOptInfo *pg_hint_plan_make_join_rel(PlannerInfo *root, RelOptInfo *rel1,
+ RelOptInfo *rel2);
+
+static void pg_hint_plan_plpgsql_func_setup(PLpgSQL_execstate *estate,
+ PLpgSQL_stmt *stmt);
+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);
+
+/* 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;
+
+static const struct config_enum_entry parse_messages_level_options[] = {
+ {"debug", DEBUG2, true},
+ {"debug5", DEBUG5, false},
+ {"debug4", DEBUG4, false},
+ {"debug3", DEBUG3, false},
+ {"debug2", DEBUG2, false},
+ {"debug1", DEBUG1, false},
+ {"log", LOG, false},
+ {"info", INFO, false},
+ {"notice", NOTICE, false},
+ {"warning", WARNING, false},
+ {"error", ERROR, false},
+ /*
+ * {"fatal", FATAL, true},
+ * {"panic", PANIC, true},
+ */
+ {NULL, 0, false}
+};
-static join_search_hook_type org_join_search = NULL;
+/* Saved hook values in case of unload */
+static ProcessUtility_hook_type prev_ProcessUtility = NULL;
+static planner_hook_type prev_planner = NULL;
+static get_relation_info_hook_type prev_get_relation_info = NULL;
+static join_search_hook_type prev_join_search = NULL;
-static void build_join_hints(PlannerInfo *root, int level, List *initial_rels);
-static RelOptInfo *my_make_join_rel(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2);
-static RelOptInfo *my_join_search(PlannerInfo *root, int levels_needed,
- List *initial_rels);
-static void my_join_search_one_level(PlannerInfo *root, int level);
-static void make_rels_by_clause_joins(PlannerInfo *root, RelOptInfo *old_rel, ListCell *other_rels);
-static void make_rels_by_clauseless_joins(PlannerInfo *root, RelOptInfo *old_rel, ListCell *other_rels);
-static bool has_join_restriction(PlannerInfo *root, RelOptInfo *rel);
+/* Hold reference to currently active hint */
+static HintState *current_hint = NULL;
-PG_FUNCTION_INFO_V1(pg_add_hint);
-PG_FUNCTION_INFO_V1(pg_clear_hint);
+/*
+ * List of hint contexts. We treat the head of the list as the Top of the
+ * context stack, so current_hint always points the first element of this list.
+ */
+static List *HintStateStack = NIL;
/*
+ * Holds statement name during executing EXECUTE command. NULL for other
+ * statements.
+ */
+static char *stmt_name = NULL;
+
+static const HintParser parsers[] = {
+ {HINT_SEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_SEQSCAN},
+ {HINT_INDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCAN},
+ {HINT_INDEXSCANREGEXP, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCANREGEXP},
+ {HINT_BITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_BITMAPSCAN},
+ {HINT_BITMAPSCANREGEXP, ScanMethodHintCreate,
+ HINT_KEYWORD_BITMAPSCANREGEXP},
+ {HINT_TIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_TIDSCAN},
+ {HINT_NOSEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOSEQSCAN},
+ {HINT_NOINDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXSCAN},
+ {HINT_NOBITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOBITMAPSCAN},
+ {HINT_NOTIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOTIDSCAN},
+#if PG_VERSION_NUM >= 90200
+ {HINT_INDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXONLYSCAN},
+ {HINT_INDEXONLYSCANREGEXP, ScanMethodHintCreate,
+ HINT_KEYWORD_INDEXONLYSCANREGEXP},
+ {HINT_NOINDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXONLYSCAN},
+#endif
+ {HINT_NESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NESTLOOP},
+ {HINT_MERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_MERGEJOIN},
+ {HINT_HASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_HASHJOIN},
+ {HINT_NONESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NONESTLOOP},
+ {HINT_NOMERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOMERGEJOIN},
+ {HINT_NOHASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOHASHJOIN},
+ {HINT_LEADING, LeadingHintCreate, HINT_KEYWORD_LEADING},
+ {HINT_SET, SetHintCreate, HINT_KEYWORD_SET},
+ {NULL, NULL, HINT_KEYWORD_UNRECOGNIZED}
+};
+
+const char *hint_query_string = NULL;
+PLpgSQL_plugin plugin_funcs = { };
+/*
* Module load callbacks
*/
void
_PG_init(void)
{
- int i;
-
-#ifdef NOT_USED
- org_cost_hook = cost_hook;
- cost_hook = my_cost_hook;
-#endif
- org_join_search = join_search_hook;
- join_search_hook = my_join_search;
-
- for (i = 0 ; i < HASH_ENTRIES ; i++)
- hashent[i] = NULL;
+ /* Define custom GUC variables. */
+ DefineCustomBoolVariable("pg_hint_plan.enable_hint",
+ "Force planner to use plans specified in the hint comment preceding to the query.",
+ NULL,
+ &pg_hint_plan_enable_hint,
+ true,
+ PGC_USERSET,
+ 0,
+ NULL,
+ NULL,
+ NULL);
+
+ DefineCustomBoolVariable("pg_hint_plan.debug_print",
+ "Logs results of hint parsing.",
+ NULL,
+ &pg_hint_plan_debug_print,
+ false,
+ PGC_USERSET,
+ 0,
+ NULL,
+ NULL,
+ NULL);
+
+ DefineCustomEnumVariable("pg_hint_plan.parse_messages",
+ "Message level of parse errors.",
+ NULL,
+ &pg_hint_plan_parse_messages,
+ INFO,
+ parse_messages_level_options,
+ PGC_USERSET,
+ 0,
+ NULL,
+ NULL,
+ NULL);
+
+ /* Install hooks. */
+ prev_ProcessUtility = ProcessUtility_hook;
+ ProcessUtility_hook = pg_hint_plan_ProcessUtility;
+ prev_planner = planner_hook;
+ planner_hook = pg_hint_plan_planner;
+ prev_get_relation_info = get_relation_info_hook;
+ get_relation_info_hook = pg_hint_plan_get_relation_info;
+ prev_join_search = join_search_hook;
+ join_search_hook = pg_hint_plan_join_search;
+
+ /* PL/pgSQL plugin hook */
+ PLpgSQL_plugin **var_ptr = (PLpgSQL_plugin **) find_rendezvous_variable("PLpgSQL_plugin");
+ *var_ptr = &plugin_funcs;
+ (&plugin_funcs)->func_setup = (void *)pg_hint_plan_plpgsql_func_setup;
}
/*
* Module unload callback
+ * XXX never called
*/
void
_PG_fini(void)
{
- int i;
-
-#ifdef NOT_USED
- cost_hook = org_cost_hook;
-#endif
- join_search_hook = org_join_search;
+ /* Uninstall hooks. */
+ ProcessUtility_hook = prev_ProcessUtility;
+ planner_hook = prev_planner;
+ get_relation_info_hook = prev_get_relation_info;
+ join_search_hook = prev_join_search;
+}
- for (i = 0 ; i < HASH_ENTRIES ; i++)
- {
- free_hashent(hashent[i]);
- hashent[i] = NULL;
+/*
+ * create and delete functions the hint object
+ */
- }
+static Hint *
+ScanMethodHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword)
+{
+ ScanMethodHint *hint;
+
+ hint = palloc(sizeof(ScanMethodHint));
+ hint->base.hint_str = hint_str;
+ hint->base.keyword = keyword;
+ hint->base.hint_keyword = hint_keyword;
+ hint->base.type = HINT_TYPE_SCAN_METHOD;
+ hint->base.state = HINT_STATE_NOTUSED;
+ hint->base.delete_func = (HintDeleteFunction) ScanMethodHintDelete;
+ hint->base.desc_func = (HintDescFunction) ScanMethodHintDesc;
+ hint->base.cmp_func = (HintCmpFunction) ScanMethodHintCmp;
+ hint->base.parse_func = (HintParseFunction) ScanMethodHintParse;
+ hint->relname = NULL;
+ hint->indexnames = NIL;
+ hint->regexp = false;
+ hint->enforce_mask = 0;
+
+ return (Hint *) hint;
}
-#ifdef NOT_USED
-char *rels_str(PlannerInfo *root, Path *path)
+static void
+ScanMethodHintDelete(ScanMethodHint *hint)
{
- char buf[4096];
- int relid;
- int first = 1;
- Bitmapset *tmpbms;
-
- if (path->pathtype == T_Invalid) return strdup("");
-
- tmpbms = bms_copy(path->parent->relids);
+ if (!hint)
+ return;
- buf[0] = 0;
- while ((relid = bms_first_member(tmpbms)) >= 0)
- {
- char idbuf[8];
- snprintf(idbuf, sizeof(idbuf), first ? "%d" : ", %d",
- root->simple_rte_array[relid]->relid);
- if (strlen(buf) + strlen(idbuf) < sizeof(buf))
- strcat(buf, idbuf);
- first = 0;
- }
-
- return strdup(buf);
+ if (hint->relname)
+ pfree(hint->relname);
+ list_free_deep(hint->indexnames);
+ pfree(hint);
}
-#endif
-static int oidsortcmp(const void *a, const void *b)
+static Hint *
+JoinMethodHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword)
{
- const Oid oida = *((const Oid *)a);
- const Oid oidb = *((const Oid *)b);
-
- return oida - oidb;
+ JoinMethodHint *hint;
+
+ hint = palloc(sizeof(JoinMethodHint));
+ hint->base.hint_str = hint_str;
+ hint->base.keyword = keyword;
+ hint->base.hint_keyword = hint_keyword;
+ hint->base.type = HINT_TYPE_JOIN_METHOD;
+ hint->base.state = HINT_STATE_NOTUSED;
+ hint->base.delete_func = (HintDeleteFunction) JoinMethodHintDelete;
+ hint->base.desc_func = (HintDescFunction) JoinMethodHintDesc;
+ hint->base.cmp_func = (HintCmpFunction) JoinMethodHintCmp;
+ hint->base.parse_func = (HintParseFunction) JoinMethodHintParse;
+ hint->nrels = 0;
+ hint->inner_nrels = 0;
+ hint->relnames = NULL;
+ hint->enforce_mask = 0;
+ hint->joinrelids = NULL;
+ hint->inner_joinrelids = NULL;
+
+ return (Hint *) hint;
}
-#ifdef NOT_USED
-static TidList *maketidlist(PlannerInfo *root, Path *path1, Path *path2)
+static void
+JoinMethodHintDelete(JoinMethodHint *hint)
{
- int relid;
- Path *paths[2] = {path1, path2};
- int i;
- int j = 0;
- int nrels = 0;
- TidList *ret = (TidList *)malloc(sizeof(TidList));
-
- for (i = 0 ; i < 2 ; i++)
- {
- if (paths[i] != NULL)
- nrels += bms_num_members(paths[i]->parent->relids);
- }
-
- ret->nrels = nrels;
- ret->oids = (Oid *)malloc(nrels * sizeof(Oid));
+ if (!hint)
+ return;
- for (i = 0 ; i < 2 ; i++)
+ if (hint->relnames)
{
- Bitmapset *tmpbms;
+ int i;
- if (paths[i] == NULL) continue;
+ for (i = 0; i < hint->nrels; i++)
+ pfree(hint->relnames[i]);
+ pfree(hint->relnames);
+ }
- tmpbms= bms_copy(paths[i]->parent->relids);
+ bms_free(hint->joinrelids);
+ bms_free(hint->inner_joinrelids);
+ pfree(hint);
+}
- while ((relid = bms_first_member(tmpbms)) >= 0)
- ret->oids[j++] = root->simple_rte_array[relid]->relid;
- }
+static Hint *
+LeadingHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword)
+{
+ LeadingHint *hint;
+
+ hint = palloc(sizeof(LeadingHint));
+ hint->base.hint_str = hint_str;
+ hint->base.keyword = keyword;
+ hint->base.hint_keyword = hint_keyword;
+ hint->base.type = HINT_TYPE_LEADING;
+ hint->base.state = HINT_STATE_NOTUSED;
+ hint->base.delete_func = (HintDeleteFunction)LeadingHintDelete;
+ hint->base.desc_func = (HintDescFunction) LeadingHintDesc;
+ hint->base.cmp_func = (HintCmpFunction) LeadingHintCmp;
+ hint->base.parse_func = (HintParseFunction) LeadingHintParse;
+ hint->relations = NIL;
+ hint->outer_inner = NULL;
+
+ return (Hint *) hint;
+}
- if (nrels > 1)
- qsort(ret->oids, nrels, sizeof(Oid), oidsortcmp);
+static void
+LeadingHintDelete(LeadingHint *hint)
+{
+ if (!hint)
+ return;
- return ret;
+ list_free_deep(hint->relations);
+ if (hint->outer_inner)
+ pfree(hint->outer_inner);
+ pfree(hint);
}
-static void free_tidlist(TidList *tidlist)
+static Hint *
+SetHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword)
{
- if (tidlist)
- {
- if (tidlist->oids)
- free(tidlist->oids);
- free(tidlist);
- }
+ SetHint *hint;
+
+ hint = palloc(sizeof(SetHint));
+ hint->base.hint_str = hint_str;
+ hint->base.keyword = keyword;
+ hint->base.hint_keyword = hint_keyword;
+ hint->base.type = HINT_TYPE_SET;
+ hint->base.state = HINT_STATE_NOTUSED;
+ hint->base.delete_func = (HintDeleteFunction) SetHintDelete;
+ hint->base.desc_func = (HintDescFunction) SetHintDesc;
+ hint->base.cmp_func = (HintCmpFunction) SetHintCmp;
+ hint->base.parse_func = (HintParseFunction) SetHintParse;
+ hint->name = NULL;
+ hint->value = NULL;
+ hint->words = NIL;
+
+ return (Hint *) hint;
}
-int n = 0;
-static void dump_rels(char *label, PlannerInfo *root, Path *path, bool found, bool enabled)
+static void
+SetHintDelete(SetHint *hint)
{
- char *relsstr;
+ if (!hint)
+ return;
+
+ if (hint->name)
+ pfree(hint->name);
+ if (hint->value)
+ pfree(hint->value);
+ if (hint->words)
+ list_free(hint->words);
+ pfree(hint);
+}
- if (!print_log) return;
- relsstr = rels_str(root, path);
- ereport(LOG, (errmsg_internal("%04d: %s for relation %s (%s, %s)\n",
- n++, label, relsstr,
- found ? "found" : "not found",
- enabled ? "enabled" : "disabled")));
- free(relsstr);
+static HintState *
+HintStateCreate(void)
+{
+ HintState *hstate;
+
+ hstate = palloc(sizeof(HintState));
+ hstate->hint_str = NULL;
+ hstate->nall_hints = 0;
+ hstate->max_all_hints = 0;
+ hstate->all_hints = NULL;
+ memset(hstate->num_hints, 0, sizeof(hstate->num_hints));
+ hstate->scan_hints = NULL;
+ hstate->init_scan_mask = 0;
+ hstate->parent_relid = 0;
+ hstate->parent_rel_oid = InvalidOid;
+ hstate->parent_hint = NULL;
+ hstate->parent_index_infos = NIL;
+ hstate->join_hints = NULL;
+ hstate->init_join_mask = 0;
+ hstate->join_hint_level = NULL;
+ hstate->leading_hint = NULL;
+ hstate->context = superuser() ? PGC_SUSET : PGC_USERSET;
+ hstate->set_hints = NULL;
+
+ return hstate;
}
-void dump_joinrels(char *label, PlannerInfo *root, Path *inpath, Path *outpath,
- bool found, bool enabled)
+static void
+HintStateDelete(HintState *hstate)
{
- char *irelstr, *orelstr;
+ int i;
- if (!print_log) return;
- irelstr = rels_str(root, inpath);
- orelstr = rels_str(root, outpath);
+ if (!hstate)
+ return;
- ereport(LOG, (errmsg_internal("%04d: %s for relation ((%s),(%s)) (%s, %s)\n",
- n++, label, irelstr, orelstr,
- found ? "found" : "not found",
- enabled ? "enabled" : "disabled")));
- free(irelstr);
- free(orelstr);
-}
+ if (hstate->hint_str)
+ pfree(hstate->hint_str);
+ for (i = 0; i < hstate->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
+ hstate->all_hints[i]->delete_func(hstate->all_hints[i]);
+ if (hstate->all_hints)
+ pfree(hstate->all_hints);
+ if (hstate->parent_index_infos)
+ list_free(hstate->parent_index_infos);
+}
-bool my_cost_hook(CostHookType type, PlannerInfo *root, Path *path1, Path *path2)
+/*
+ * Copy given value into buf, with quoting with '"' if necessary.
+ */
+static void
+quote_value(StringInfo buf, const char *value)
{
- TidList *tidlist;
- HashEntry *ent;
- bool ret = false;
+ bool need_quote = false;
+ const char *str;
- if (!tweak_enabled)
+ for (str = value; *str != '\0'; str++)
{
- switch (type)
+ if (isspace(*str) || *str == '(' || *str == ')' || *str == '"')
{
- case COSTHOOK_seqscan:
- return enable_seqscan;
- case COSTHOOK_indexscan:
- return enable_indexscan;
- case COSTHOOK_bitmapscan:
- return enable_bitmapscan;
- case COSTHOOK_tidscan:
- return enable_tidscan;
- case COSTHOOK_nestloop:
- return enable_nestloop;
- case COSTHOOK_mergejoin:
- return enable_mergejoin;
- case COSTHOOK_hashjoin:
- return enable_hashjoin;
- default:
- ereport(LOG, (errmsg_internal("Unknown cost type")));
- break;
+ need_quote = true;
+ appendStringInfoCharMacro(buf, '"');
+ break;
}
}
- switch (type)
- {
- case COSTHOOK_seqscan:
- tidlist = maketidlist(root, path1, path2);
- ent = search_ent(tidlist);
- free_tidlist(tidlist);
- ret = (ent ? (ent->enforce_mask & ENABLE_SEQSCAN) :
- enable_seqscan);
- dump_rels("cost_seqscan", root, path1, ent != NULL, ret);
- return ret;
- case COSTHOOK_indexscan:
- tidlist = maketidlist(root, path1, path2);
- ent = search_ent(tidlist);
- free_tidlist(tidlist);
- ret = (ent ? (ent->enforce_mask & ENABLE_INDEXSCAN) :
- enable_indexscan);
- dump_rels("cost_indexscan", root, path1, ent != NULL, ret);
- return ret;
- case COSTHOOK_bitmapscan:
- if (path1->pathtype != T_BitmapHeapScan)
- {
- ent = NULL;
- ret = enable_bitmapscan;
- }
- else
- {
- tidlist = maketidlist(root, path1, path2);
- ent = search_ent(tidlist);
- free_tidlist(tidlist);
- ret = (ent ? (ent->enforce_mask & ENABLE_BITMAPSCAN) :
- enable_bitmapscan);
- }
- dump_rels("cost_bitmapscan", root, path1, ent != NULL, ret);
-
- return ret;
- case COSTHOOK_tidscan:
- tidlist = maketidlist(root, path1, path2);
- ent = search_ent(tidlist);
- free_tidlist(tidlist);
- ret = (ent ? (ent->enforce_mask & ENABLE_TIDSCAN) :
- enable_tidscan);
- dump_rels("cost_tidscan", root, path1, ent != NULL, ret);
- return ret;
- case COSTHOOK_nestloop:
- tidlist = maketidlist(root, path1, path2);
- ent = search_ent(tidlist);
- free_tidlist(tidlist);
- ret = (ent ? (ent->enforce_mask & ENABLE_NESTLOOP) :
- enable_nestloop);
- dump_joinrels("cost_nestloop", root, path1, path2,
- ent != NULL, ret);
- return ret;
- case COSTHOOK_mergejoin:
- tidlist = maketidlist(root, path1, path2);
- ent = search_ent(tidlist);
- free_tidlist(tidlist);
- ret = (ent ? (ent->enforce_mask & ENABLE_MERGEJOIN) :
- enable_mergejoin);
- dump_joinrels("cost_mergejoin", root, path1, path2,
- ent != NULL, ret);
- return ret;
- case COSTHOOK_hashjoin:
- tidlist = maketidlist(root, path1, path2);
- ent = search_ent(tidlist);
- free_tidlist(tidlist);
- ret = (ent ? (ent->enforce_mask & ENABLE_HASHJOIN) :
- enable_hashjoin);
- dump_joinrels("cost_hashjoin", root, path1, path2,
- ent != NULL, ret);
- return ret;
- default:
- ereport(LOG, (errmsg_internal("Unknown cost type")));
- break;
+
+ for (str = value; *str != '\0'; str++)
+ {
+ if (*str == '"')
+ appendStringInfoCharMacro(buf, '"');
+
+ appendStringInfoCharMacro(buf, *str);
}
-
- return true;
+
+ if (need_quote)
+ appendStringInfoCharMacro(buf, '"');
}
-#endif
-static void free_hashent(HashEntry *head)
+static void
+ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf)
{
- HashEntry *next = head;
+ ListCell *l;
- while (next)
+ appendStringInfo(buf, "%s(", hint->base.keyword);
+ if (hint->relname != NULL)
{
- HashEntry *last = next;
- if (next->tidlist.oids != NULL) free(next->tidlist.oids);
- next = next->next;
- free(last);
+ quote_value(buf, hint->relname);
+ foreach(l, hint->indexnames)
+ {
+ appendStringInfoCharMacro(buf, ' ');
+ quote_value(buf, (char *) lfirst(l));
+ }
}
+ appendStringInfoString(buf, ")\n");
}
-static HashEntry *parse_tidlist(char **str)
+static void
+JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf)
{
- char tidstr[8];
- char *p0;
- Oid tid[20]; /* ^^; */
- int ntids = 0;
- int i, len;
- HashEntry *ret;
+ int i;
- while (isdigit(**str) && ntids < 20)
+ appendStringInfo(buf, "%s(", hint->base.keyword);
+ if (hint->relnames != NULL)
{
- p0 = *str;
- while (isdigit(**str)) (*str)++;
- len = *str - p0;
- if (len >= 8) return NULL;
- strncpy(tidstr, p0, len);
- tidstr[len] = 0;
-
- /* Tis 0 is valid? I don't know :-p */
- if ((tid[ntids++] = atoi(tidstr)) == 0) return NULL;
-
- if (**str == ',') (*str)++;
+ quote_value(buf, hint->relnames[0]);
+ for (i = 1; i < hint->nrels; i++)
+ {
+ appendStringInfoCharMacro(buf, ' ');
+ quote_value(buf, hint->relnames[i]);
+ }
}
+ appendStringInfoString(buf, ")\n");
- if (ntids > 1)
- qsort(tid, ntids, sizeof(Oid), oidsortcmp);
- ret = (HashEntry*)malloc(sizeof(HashEntry));
- ret->next = NULL;
- ret->enforce_mask = 0;
- ret->tidlist.nrels = ntids;
- ret->tidlist.oids = (Oid *)malloc(ntids * sizeof(Oid));
- for (i = 0 ; i < ntids ; i++)
- ret->tidlist.oids[i] = tid[i];
- return ret;
}
-static int parse_phrase(HashEntry **head, char **str)
+static void
+OuterInnerDesc(OuterInnerRels *outer_inner, StringInfo buf)
{
- char *cmds[] = {"seq", "index", "nest", "merge", "hash", NULL};
- unsigned char masks[] = {ENABLE_SEQSCAN, ENABLE_INDEXSCAN|ENABLE_BITMAPSCAN,
- ENABLE_NESTLOOP, ENABLE_MERGEJOIN, ENABLE_HASHJOIN};
- char req[12];
- int cmd;
- HashEntry *ent = NULL;
- char *p0;
- int len;
-
- p0 = *str;
- while (isalpha(**str)) (*str)++;
- len = *str - p0;
- if (**str != '(' || len >= 12) return 0;
- strncpy(req, p0, len);
- req[len] = 0;
- for (cmd = 0 ; cmds[cmd] && strcmp(cmds[cmd], req) ; cmd++);
- if (cmds[cmd] == NULL) return 0;
- (*str)++;
- if ((ent = parse_tidlist(str)) == NULL) return 0;
- if (*(*str)++ != ')') return 0;
- if (**str != 0 && **str != ';') return 0;
- if (**str == ';') (*str)++;
- ent->enforce_mask = masks[cmd];
- ent->next = NULL;
- *head = ent;
+ if (outer_inner->relation == NULL)
+ {
+ bool is_first;
+ ListCell *l;
- return 1;
-}
+ is_first = true;
+ appendStringInfoCharMacro(buf, '(');
+ foreach(l, outer_inner->outer_inner_pair)
+ {
+ if (is_first)
+ is_first = false;
+ else
+ appendStringInfoCharMacro(buf, ' ');
-static HashEntry* parse_top(char* str)
-{
- HashEntry *head = NULL;
- HashEntry *ent = NULL;
+ OuterInnerDesc(lfirst(l), buf);
+ }
- if (!parse_phrase(&head, &str))
- {
- free_hashent(head);
- return NULL;
+ appendStringInfoCharMacro(buf, ')');
}
- ent = head;
+ else
+ quote_value(buf, outer_inner->relation);
+}
- while (*str)
+static void
+LeadingHintDesc(LeadingHint *hint, StringInfo buf)
+{
+ appendStringInfo(buf, "%s(", HINT_LEADING);
+ if (hint->outer_inner == NULL)
{
- if (!parse_phrase(&ent->next, &str))
+ ListCell *l;
+ bool is_first;
+
+ is_first = true;
+
+ foreach(l, hint->relations)
{
- free_hashent(head);
- return NULL;
+ if (is_first)
+ is_first = false;
+ else
+ appendStringInfoCharMacro(buf, ' ');
+
+ quote_value(buf, (char *) lfirst(l));
}
- ent = ent->next;
}
+ else
+ OuterInnerDesc(hint->outer_inner, buf);
- return head;
+ appendStringInfoString(buf, ")\n");
}
-static bool ent_matches(TidList *key, HashEntry *ent2)
+static void
+SetHintDesc(SetHint *hint, StringInfo buf)
{
- int i;
-
- if (key->nrels != ent2->tidlist.nrels)
- return 0;
-
- for (i = 0 ; i < key->nrels ; i++)
- if (key->oids[i] != ent2->tidlist.oids[i])
- return 0;
-
- return 1;
-}
+ bool is_first = true;
+ ListCell *l;
-static unsigned int calc_hash(TidList *tidlist)
-{
- unsigned int hash = 0;
- int i = 0;
-
- for (i = 0 ; i < tidlist->nrels ; i++)
+ appendStringInfo(buf, "%s(", HINT_SET);
+ foreach(l, hint->words)
{
- int j = 0;
- for (j = 0 ; j < sizeof(Oid) ; j++)
- hash = hash * 2 + ((tidlist->oids[i] >> (j * 8)) & 0xff);
- }
+ if (is_first)
+ is_first = false;
+ else
+ appendStringInfoCharMacro(buf, ' ');
- return hash % HASH_ENTRIES;
-;
+ quote_value(buf, (char *) lfirst(l));
+ }
+ appendStringInfo(buf, ")\n");
}
-#ifdef NOT_USED
-static HashEntry *search_ent(TidList *tidlist)
+/*
+ * Append string which repserents all hints in a given state to buf, with
+ * preceding title with them.
+ */
+static void
+desc_hint_in_state(HintState *hstate, StringInfo buf, const char *title,
+ HintStatus state)
{
- HashEntry *ent;
- if (tidlist == NULL) return NULL;
+ int i;
- ent = hashent[calc_hash(tidlist)];
- while(ent)
+ appendStringInfo(buf, "%s:\n", title);
+ for (i = 0; i < hstate->nall_hints; i++)
{
- if (ent_matches(tidlist, ent))
- return ent;
- ent = ent->next;
- }
+ if (hstate->all_hints[i]->state != state)
+ continue;
- return NULL;
+ hstate->all_hints[i]->desc_func(hstate->all_hints[i], buf);
+ }
}
-#endif
-Datum
-pg_add_hint(PG_FUNCTION_ARGS)
+/*
+ * Dump contents of given hstate to server log with log level LOG.
+ */
+static void
+HintStateDump(HintState *hstate)
{
- HashEntry *ret = NULL;
- char *str = NULL;
- int i = 0;
-
- if (PG_NARGS() < 1)
- ereport(ERROR, (errmsg_internal("No argument")));
-
- str = text_to_cstring(PG_GETARG_TEXT_PP(0));
+ StringInfoData buf;
- ret = parse_top(str);
+ if (!hstate)
+ {
+ elog(LOG, "pg_hint_plan:\nno hint");
+ return;
+ }
- if (ret == NULL)
- ereport(ERROR, (errmsg_internal("Parse Error")));
+ initStringInfo(&buf);
- while (ret)
- {
- HashEntry *etmp = NULL;
- HashEntry *next = NULL;
- int hash = calc_hash(&ret->tidlist);
- while (hashent[hash] && ent_matches(&ret->tidlist, hashent[hash]))
- {
- etmp = hashent[hash]->next;
- hashent[hash]->next = NULL;
- free_hashent(hashent[hash]);
- hashent[hash] = etmp;
+ appendStringInfoString(&buf, "pg_hint_plan:\n");
+ desc_hint_in_state(hstate, &buf, "used hint", HINT_STATE_USED);
+ desc_hint_in_state(hstate, &buf, "not used hint", HINT_STATE_NOTUSED);
+ desc_hint_in_state(hstate, &buf, "duplication hint", HINT_STATE_DUPLICATION);
+ desc_hint_in_state(hstate, &buf, "error hint", HINT_STATE_ERROR);
- }
- etmp = hashent[hash];
- while (etmp && etmp->next)
- {
- if (ent_matches(&ret->tidlist, etmp->next))
- {
- HashEntry *etmp2 = etmp->next->next;
- etmp->next->next = NULL;
- free_hashent(etmp->next);
- etmp->next = etmp2;
- } else
- etmp = etmp->next;
- }
+ elog(LOG, "%s", buf.data);
- i++;
- next = ret->next;
- ret->next = hashent[hash];
- hashent[hash] = ret;
- ret = next;
- }
- PG_RETURN_INT32(i);
+ pfree(buf.data);
}
-Datum
-pg_clear_hint(PG_FUNCTION_ARGS)
-{
- int i;
- int n = 0;
+/*
+ * compare functions
+ */
- for (i = 0 ; i < HASH_ENTRIES ; i++)
- {
- free_hashent(hashent[i]);
- hashent[i] = NULL;
- n++;
+static int
+RelnameCmp(const void *a, const void *b)
+{
+ const char *relnamea = *((const char **) a);
+ const char *relnameb = *((const char **) b);
- }
- PG_RETURN_INT32(n);
+ return strcmp(relnamea, relnameb);
}
-Datum
-pg_enable_hint(bool arg, bool *isnull)
+static int
+ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b)
{
- tweak_enabled = arg;
- PG_RETURN_INT32(0);
+ return RelnameCmp(&a->relname, &b->relname);
}
-Datum
-pg_enable_log(bool arg, bool *isnull)
+static int
+JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b)
{
- print_log = arg;
- PG_RETURN_INT32(0);
-}
+ int i;
-static int putsbuf(char **p, char *bottom, char *str)
-{
- while (*p < bottom && *str)
+ if (a->nrels != b->nrels)
+ return a->nrels - b->nrels;
+
+ for (i = 0; i < a->nrels; i++)
{
- *(*p)++ = *str++;
+ int result;
+ if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0)
+ return result;
}
- return (*str == 0);
+ return 0;
}
-static void dump_ent(HashEntry *ent, char **p, char *bottom)
+static int
+LeadingHintCmp(const LeadingHint *a, const LeadingHint *b)
{
- static char typesigs[] = "SIBTNMH";
- char sigs[sizeof(typesigs)];
- int i;
-
- if (!putsbuf(p, bottom, "[(")) return;
- for (i = 0 ; i < ent->tidlist.nrels ; i++)
- {
- if (i && !putsbuf(p, bottom, ", ")) return;
- if (*p >= bottom) return;
- *p += snprintf(*p, bottom - *p, "%d", ent->tidlist.oids[i]);
- }
- if (!putsbuf(p, bottom, "), ")) return;
- strcpy(sigs, typesigs);
- for (i = 0 ; i < 7 ; i++) /* Magic number here! */
- {
- if(((1<<i) & ent->enforce_mask) == 0)
- sigs[i] += 'a' - 'A';
- }
- if (!putsbuf(p, bottom, sigs)) return;
- if (!putsbuf(p, bottom, "]")) return;
+ return 0;
}
-Datum
-pg_dump_hint(PG_FUNCTION_ARGS)
+static int
+SetHintCmp(const SetHint *a, const SetHint *b)
{
- char buf[16384]; /* ^^; */
- char *bottom = buf + sizeof(buf);
- char *p = buf;
- int i;
- int first = 1;
-
- memset(buf, 0, sizeof(buf));
- for (i = 0 ; i < HASH_ENTRIES ; i++)
- {
- if (hashent[i])
- {
- HashEntry *ent = hashent[i];
- while (ent)
- {
- if (first)
- first = 0;
- else
- putsbuf(&p, bottom, ", ");
-
- dump_ent(ent, &p, bottom);
- ent = ent->next;
- }
- }
- }
- if (p >= bottom) p--;
- *p = 0;
-
- PG_RETURN_CSTRING(cstring_to_text(buf));
+ return strcmp(a->name, b->name);
}
-/*
- * pg_add_hint()で登録したヒントから、今回のクエリで使用するもののみ抽出し、
- * 使用しやすい構造に変換する。
- */
-static void
-build_join_hints(PlannerInfo *root, int level, List *initial_rels)
+static int
+HintCmp(const void *a, const void *b)
{
+ const Hint *hinta = *((const Hint **) a);
+ const Hint *hintb = *((const Hint **) b);
+
+ if (hinta->type != hintb->type)
+ return hinta->type - hintb->type;
+ if (hinta->state == HINT_STATE_ERROR)
+ return -1;
+ if (hintb->state == HINT_STATE_ERROR)
+ return 1;
+ return hinta->cmp_func(hinta, hintb);
}
/*
- * src/backend/optimizer/path/joinrels.c
- * export make_join_rel() をラップする関数
- *
- * ヒントにしたがって、enabele_* パラメータを変更した上で、make_join_rel()を
- * 呼び出す。
+ * Returns byte offset of hint b from hint a. If hint a was specified before
+ * b, positive value is returned.
*/
-static RelOptInfo *
-my_make_join_rel(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
+static int
+HintCmpWithPos(const void *a, const void *b)
{
- return make_join_rel(root, rel1, rel2);
-}
+ const Hint *hinta = *((const Hint **) a);
+ const Hint *hintb = *((const Hint **) b);
+ int result;
-/*
- * PostgreSQL 本体から流用した関数
- */
+ result = HintCmp(a, b);
+ if (result == 0)
+ result = hinta->hint_str - hintb->hint_str;
+
+ return result;
+}
/*
- * src/backend/optimizer/path/allpaths.c
- * export standard_join_search() を流用
- *
- * 変更箇所
- * build_join_hints() の呼び出しを追加
- */
-/*
- * standard_join_search
- * Find possible joinpaths for a query by successively finding ways
- * to join component relations into join relations.
- *
- * 'levels_needed' is the number of iterations needed, ie, the number of
- * independent jointree items in the query. This is > 1.
- *
- * 'initial_rels' is a list of RelOptInfo nodes for each independent
- * jointree item. These are the components to be joined together.
- * Note that levels_needed == list_length(initial_rels).
- *
- * Returns the final level of join relations, i.e., the relation that is
- * the result of joining all the original relations together.
- * At least one implementation path must be provided for this relation and
- * all required sub-relations.
- *
- * To support loadable plugins that modify planner behavior by changing the
- * join searching algorithm, we provide a hook variable that lets a plugin
- * replace or supplement this function. Any such hook must return the same
- * final join relation as the standard code would, but it might have a
- * different set of implementation paths attached, and only the sub-joinrels
- * needed for these paths need have been instantiated.
- *
- * Note to plugin authors: the functions invoked during standard_join_search()
- * modify root->join_rel_list and root->join_rel_hash. If you want to do more
- * than one join-order search, you'll probably need to save and restore the
- * original states of those data structures. See geqo_eval() for an example.
+ * parse functions
*/
-static RelOptInfo *
-my_join_search(PlannerInfo *root, int levels_needed, List *initial_rels)
+static const char *
+parse_keyword(const char *str, StringInfo buf)
{
- int lev;
- RelOptInfo *rel;
+ skip_space(str);
- /*
- * This function cannot be invoked recursively within any one planning
- * problem, so join_rel_level[] can't be in use already.
- */
- Assert(root->join_rel_level == NULL);
-
- /*
- * We employ a simple "dynamic programming" algorithm: we first find all
- * ways to build joins of two jointree items, then all ways to build joins
- * of three items (from two-item joins and single items), then four-item
- * joins, and so on until we have considered all ways to join all the
- * items into one rel.
- *
- * root->join_rel_level[j] is a list of all the j-item rels. Initially we
- * set root->join_rel_level[1] to represent all the single-jointree-item
- * relations.
- */
- root->join_rel_level = (List **) palloc0((levels_needed + 1) * sizeof(List *));
+ while (!isspace(*str) && *str != '(' && *str != '\0')
+ appendStringInfoCharMacro(buf, *str++);
- root->join_rel_level[1] = initial_rels;
+ return str;
+}
- build_join_hints(root, levels_needed, initial_rels);
+static const char *
+skip_parenthesis(const char *str, char parenthesis)
+{
+ skip_space(str);
- for (lev = 2; lev <= levels_needed; lev++)
+ if (*str != parenthesis)
{
- ListCell *lc;
-
- /*
- * Determine all possible pairs of relations to be joined at this
- * level, and build paths for making each one from every available
- * pair of lower-level relations.
- */
- my_join_search_one_level(root, lev);
-
- /*
- * Do cleanup work on each just-processed rel.
- */
- foreach(lc, root->join_rel_level[lev])
- {
- rel = (RelOptInfo *) lfirst(lc);
-
- /* Find and save the cheapest paths for this rel */
- set_cheapest(rel);
+ if (parenthesis == '(')
+ hint_ereport(str, ("Opening parenthesis is necessary."));
+ else if (parenthesis == ')')
+ hint_ereport(str, ("Closing parenthesis is necessary."));
-#ifdef OPTIMIZER_DEBUG
- debug_print_rel(root, rel);
-#endif
- }
+ return NULL;
}
- /*
- * We should have a single rel at the final level.
- */
- if (root->join_rel_level[levels_needed] == NIL)
- elog(ERROR, "failed to build any %d-way joins", levels_needed);
- Assert(list_length(root->join_rel_level[levels_needed]) == 1);
-
- rel = (RelOptInfo *) linitial(root->join_rel_level[levels_needed]);
+ str++;
- root->join_rel_level = NULL;
-
- return rel;
+ return str;
}
/*
- * src/backend/optimizer/path/joinrels.c
- * static join_search_one_level() を流用
- *
- * 変更箇所
- * make_join_rel() の呼び出しをラップする、my_make_join_rel()の呼び出しに変更
- */
-/*
- * join_search_one_level
- * Consider ways to produce join relations containing exactly 'level'
- * jointree items. (This is one step of the dynamic-programming method
- * embodied in standard_join_search.) Join rel nodes for each feasible
- * combination of lower-level rels are created and returned in a list.
- * Implementation paths are created for each such joinrel, too.
+ * Parse a token from str, and store malloc'd copy into word. A token can be
+ * quoted with '"'. Return value is pointer to unparsed portion of original
+ * string, or NULL if an error occurred.
*
- * level: level of rels we want to make this time
- * root->join_rel_level[j], 1 <= j < level, is a list of rels containing j items
- *
- * The result is returned in root->join_rel_level[level].
+ * Parsed token is truncated within NAMEDATALEN-1 bytes, when truncate is true.
*/
-static void
-my_join_search_one_level(PlannerInfo *root, int level)
+static const char *
+parse_quoted_value(const char *str, char **word, bool truncate)
{
- List **joinrels = root->join_rel_level;
- ListCell *r;
- int k;
+ StringInfoData buf;
+ bool in_quote;
- Assert(joinrels[level] == NIL);
+ /* Skip leading spaces. */
+ skip_space(str);
- /* Set join_cur_level so that new joinrels are added to proper list */
- root->join_cur_level = level;
-
- /*
- * First, consider left-sided and right-sided plans, in which rels of
- * exactly level-1 member relations are joined against initial relations.
- * We prefer to join using join clauses, but if we find a rel of level-1
- * members that has no join clauses, we will generate Cartesian-product
- * joins against all initial rels not already contained in it.
- *
- * In the first pass (level == 2), we try to join each initial rel to each
- * initial rel that appears later in joinrels[1]. (The mirror-image joins
- * are handled automatically by make_join_rel.) In later passes, we try
- * to join rels of size level-1 from joinrels[level-1] to each initial rel
- * in joinrels[1].
- */
- foreach(r, joinrels[level - 1])
+ initStringInfo(&buf);
+ if (*str == '"')
{
- RelOptInfo *old_rel = (RelOptInfo *) lfirst(r);
- ListCell *other_rels;
-
- if (level == 2)
- other_rels = lnext(r); /* only consider remaining initial
- * rels */
- else
- other_rels = list_head(joinrels[1]); /* consider all initial
- * rels */
+ str++;
+ in_quote = true;
+ }
+ else
+ in_quote = false;
- if (old_rel->joininfo != NIL || old_rel->has_eclass_joins ||
- has_join_restriction(root, old_rel))
+ while (true)
+ {
+ if (in_quote)
{
+ /* Double quotation must be closed. */
+ if (*str == '\0')
+ {
+ pfree(buf.data);
+ hint_ereport(str, ("Unterminated quoted string."));
+ return NULL;
+ }
+
/*
- * Note that if all available join clauses for this rel require
- * more than one other rel, we will fail to make any joins against
- * it here. In most cases that's OK; it'll be considered by
- * "bushy plan" join code in a higher-level pass where we have
- * those other rels collected into a join rel.
+ * Skip escaped double quotation.
*
- * See also the last-ditch case below.
- */
- make_rels_by_clause_joins(root,
- old_rel,
- other_rels);
- }
- else
- {
- /*
- * Oops, we have a relation that is not joined to any other
- * relation, either directly or by join-order restrictions.
- * Cartesian product time.
+ * We don't allow slash-asterisk and asterisk-slash (delimiters of
+ * block comments) to be an object name, so users must specify
+ * alias for such object names.
+ *
+ * Those special names can be allowed if we care escaped slashes
+ * and asterisks, but we don't.
*/
- make_rels_by_clauseless_joins(root,
- old_rel,
- other_rels);
+ if (*str == '"')
+ {
+ str++;
+ if (*str != '"')
+ break;
+ }
}
+ else if (isspace(*str) || *str == '(' || *str == ')' || *str == '"' ||
+ *str == '\0')
+ break;
+
+ appendStringInfoCharMacro(&buf, *str++);
}
- /*
- * Now, consider "bushy plans" in which relations of k initial rels are
- * joined to relations of level-k initial rels, for 2 <= k <= level-2.
- *
- * We only consider bushy-plan joins for pairs of rels where there is a
- * suitable join clause (or join order restriction), in order to avoid
- * unreasonable growth of planning time.
- */
- for (k = 2;; k++)
+ if (buf.len == 0)
{
- int other_level = level - k;
+ hint_ereport(str, ("Zero-length delimited string."));
- /*
- * Since make_join_rel(x, y) handles both x,y and y,x cases, we only
- * need to go as far as the halfway point.
- */
- if (k > other_level)
- break;
+ pfree(buf.data);
- foreach(r, joinrels[k])
- {
- RelOptInfo *old_rel = (RelOptInfo *) lfirst(r);
- ListCell *other_rels;
- ListCell *r2;
+ return NULL;
+ }
- /*
- * We can ignore clauseless joins here, *except* when they
- * participate in join-order restrictions --- then we might have
- * to force a bushy join plan.
- */
- if (old_rel->joininfo == NIL && !old_rel->has_eclass_joins &&
- !has_join_restriction(root, old_rel))
+ /* Truncate name if it's too long */
+ if (truncate)
+ truncate_identifier(buf.data, strlen(buf.data), true);
+
+ *word = buf.data;
+
+ return str;
+}
+
+static OuterInnerRels *
+OuterInnerRelsCreate(char *name, List *outer_inner_list)
+{
+ OuterInnerRels *outer_inner;
+
+ outer_inner = palloc(sizeof(OuterInnerRels));
+ outer_inner->relation = name;
+ outer_inner->outer_inner_pair = outer_inner_list;
+
+ return outer_inner;
+}
+
+static const char *
+parse_parentheses_Leading_in(const char *str, OuterInnerRels **outer_inner)
+{
+ List *outer_inner_pair = NIL;
+
+ if ((str = skip_parenthesis(str, '(')) == NULL)
+ return NULL;
+
+ skip_space(str);
+
+ /* Store words in parentheses into outer_inner_list. */
+ while(*str != ')' && *str != '\0')
+ {
+ OuterInnerRels *outer_inner_rels;
+
+ if (*str == '(')
+ {
+ str = parse_parentheses_Leading_in(str, &outer_inner_rels);
+ if (str == NULL)
+ break;
+ }
+ else
+ {
+ char *name;
+
+ if ((str = parse_quoted_value(str, &name, true)) == NULL)
+ break;
+ else
+ outer_inner_rels = OuterInnerRelsCreate(name, NIL);
+ }
+
+ outer_inner_pair = lappend(outer_inner_pair, outer_inner_rels);
+ skip_space(str);
+ }
+
+ if (str == NULL ||
+ (str = skip_parenthesis(str, ')')) == NULL)
+ {
+ list_free(outer_inner_pair);
+ return NULL;
+ }
+
+ *outer_inner = OuterInnerRelsCreate(NULL, outer_inner_pair);
+
+ return str;
+}
+
+static const char *
+parse_parentheses_Leading(const char *str, List **name_list,
+ OuterInnerRels **outer_inner)
+{
+ char *name;
+ bool truncate = true;
+
+ if ((str = skip_parenthesis(str, '(')) == NULL)
+ return NULL;
+
+ skip_space(str);
+ if (*str =='(')
+ {
+ if ((str = parse_parentheses_Leading_in(str, outer_inner)) == NULL)
+ return NULL;
+ }
+ else
+ {
+ /* Store words in parentheses into name_list. */
+ while(*str != ')' && *str != '\0')
+ {
+ if ((str = parse_quoted_value(str, &name, truncate)) == NULL)
+ {
+ list_free(*name_list);
+ return NULL;
+ }
+
+ *name_list = lappend(*name_list, name);
+ skip_space(str);
+ }
+ }
+
+ if ((str = skip_parenthesis(str, ')')) == NULL)
+ return NULL;
+ return str;
+}
+
+static const char *
+parse_parentheses(const char *str, List **name_list, HintKeyword keyword)
+{
+ char *name;
+ bool truncate = true;
+
+ if ((str = skip_parenthesis(str, '(')) == NULL)
+ return NULL;
+
+ skip_space(str);
+
+ /* Store words in parentheses into name_list. */
+ while(*str != ')' && *str != '\0')
+ {
+ if ((str = parse_quoted_value(str, &name, truncate)) == NULL)
+ {
+ list_free(*name_list);
+ return NULL;
+ }
+
+ *name_list = lappend(*name_list, name);
+ skip_space(str);
+
+ if (keyword == HINT_KEYWORD_INDEXSCANREGEXP ||
+#if PG_VERSION_NUM >= 90200
+ keyword == HINT_KEYWORD_INDEXONLYSCANREGEXP ||
+#endif
+ keyword == HINT_KEYWORD_BITMAPSCANREGEXP ||
+ keyword == HINT_KEYWORD_SET)
+ {
+ truncate = false;
+ }
+ }
+
+ if ((str = skip_parenthesis(str, ')')) == NULL)
+ return NULL;
+ return str;
+}
+
+static void
+parse_hints(HintState *hstate, Query *parse, const char *str)
+{
+ StringInfoData buf;
+ char *head;
+
+ initStringInfo(&buf);
+ while (*str != '\0')
+ {
+ const HintParser *parser;
+
+ /* in error message, we output the comment including the keyword. */
+ head = (char *) str;
+
+ /* parse only the keyword of the hint. */
+ resetStringInfo(&buf);
+ str = parse_keyword(str, &buf);
+
+ for (parser = parsers; parser->keyword != NULL; parser++)
+ {
+ char *keyword = parser->keyword;
+ Hint *hint;
+
+ if (strcasecmp(buf.data, keyword) != 0)
+ continue;
+
+ hint = parser->create_func(head, keyword, parser->hint_keyword);
+
+ /* parser of each hint does parse in a parenthesis. */
+ if ((str = hint->parse_func(hint, hstate, parse, str)) == NULL)
+ {
+ hint->delete_func(hint);
+ pfree(buf.data);
+ return;
+ }
+
+ /*
+ * Add hint information into all_hints array. If we don't have
+ * enough space, double the array.
+ */
+ if (hstate->nall_hints == 0)
+ {
+ hstate->max_all_hints = HINT_ARRAY_DEFAULT_INITSIZE;
+ hstate->all_hints = (Hint **)
+ palloc(sizeof(Hint *) * hstate->max_all_hints);
+ }
+ else if (hstate->nall_hints == hstate->max_all_hints)
+ {
+ hstate->max_all_hints *= 2;
+ hstate->all_hints = (Hint **)
+ repalloc(hstate->all_hints,
+ sizeof(Hint *) * hstate->max_all_hints);
+ }
+
+ hstate->all_hints[hstate->nall_hints] = hint;
+ hstate->nall_hints++;
+
+ skip_space(str);
+
+ break;
+ }
+
+ if (parser->keyword == NULL)
+ {
+ hint_ereport(head,
+ ("Unrecognized hint keyword \"%s\".", buf.data));
+ pfree(buf.data);
+ return;
+ }
+ }
+
+ pfree(buf.data);
+}
+
+/*
+ * Do basic parsing of the query head comment.
+ */
+static HintState *
+parse_head_comment(Query *parse)
+{
+ const char *p;
+ const char *hint_head;
+ char *head;
+ char *tail;
+ int len;
+ int i;
+ HintState *hstate;
+
+ /* get client-supplied query string. */
+ if (stmt_name)
+ {
+ PreparedStatement *entry;
+
+ entry = FetchPreparedStatement(stmt_name, true);
+ p = entry->plansource->query_string;
+ }
+ else if (hint_query_string)
+ p = hint_query_string;
+ else
+ p = debug_query_string;
+
+ if (p == NULL)
+ return NULL;
+
+ /* extract query head comment. */
+ hint_head = strstr(p, HINT_START);
+ if (hint_head == NULL)
+ return NULL;
+ for (;p < hint_head; p++)
+ {
+ /*
+ * Allow these characters precedes hint comment:
+ * - digits
+ * - alphabets which are in ASCII range
+ * - space, tabs and new-lines
+ * - underscores, for identifier
+ * - commas, for SELECT clause, EXPLAIN and PREPARE
+ * - parentheses, for EXPLAIN and PREPARE
+ *
+ * Note that we don't use isalpha() nor isalnum() in ctype.h here to
+ * avoid behavior which depends on locale setting.
+ */
+ if (!(*p >= '0' && *p <= '9') &&
+ !(*p >= 'A' && *p <= 'Z') &&
+ !(*p >= 'a' && *p <= 'z') &&
+ !isspace(*p) &&
+ *p != '_' &&
+ *p != ',' &&
+ *p != '(' && *p != ')')
+ return NULL;
+ }
+
+ len = strlen(HINT_START);
+ head = (char *) p;
+ p += len;
+ skip_space(p);
+
+ /* find hint end keyword. */
+ if ((tail = strstr(p, HINT_END)) == NULL)
+ {
+ hint_ereport(head, ("Unterminated block comment."));
+ return NULL;
+ }
+
+ /* We don't support nested block comments. */
+ if ((head = strstr(p, BLOCK_COMMENT_START)) != NULL && head < tail)
+ {
+ hint_ereport(head, ("Nested block comments are not supported."));
+ return NULL;
+ }
+
+ /* Make a copy of hint. */
+ len = tail - p;
+ head = palloc(len + 1);
+ memcpy(head, p, len);
+ head[len] = '\0';
+ p = head;
+
+ hstate = HintStateCreate();
+ hstate->hint_str = head;
+
+ /* parse each hint. */
+ parse_hints(hstate, parse, p);
+
+ /* When nothing specified a hint, we free HintState and returns NULL. */
+ if (hstate->nall_hints == 0)
+ {
+ HintStateDelete(hstate);
+ return NULL;
+ }
+
+ /* Sort hints in order of original position. */
+ qsort(hstate->all_hints, hstate->nall_hints, sizeof(Hint *),
+ HintCmpWithPos);
+
+ /* Count number of hints per hint-type. */
+ for (i = 0; i < hstate->nall_hints; i++)
+ {
+ Hint *cur_hint = hstate->all_hints[i];
+ hstate->num_hints[cur_hint->type]++;
+ }
+
+ /*
+ * If an object (or a set of objects) has multiple hints of same hint-type,
+ * only the last hint is valid and others are igonred in planning.
+ * Hints except the last are marked as 'duplicated' to remember the order.
+ */
+ for (i = 0; i < hstate->nall_hints - 1; i++)
+ {
+ Hint *cur_hint = hstate->all_hints[i];
+ Hint *next_hint = hstate->all_hints[i + 1];
+
+ /*
+ * Leading hint is marked as 'duplicated' in transform_join_hints.
+ */
+ if (cur_hint->type == HINT_TYPE_LEADING &&
+ next_hint->type == HINT_TYPE_LEADING)
+ continue;
+
+ /*
+ * Note that we need to pass addresses of hint pointers, because
+ * HintCmp is designed to sort array of Hint* by qsort.
+ */
+ if (HintCmp(&cur_hint, &next_hint) == 0)
+ {
+ hint_ereport(cur_hint->hint_str,
+ ("Conflict %s hint.", HintTypeName[cur_hint->type]));
+ cur_hint->state = HINT_STATE_DUPLICATION;
+ }
+ }
+
+ /*
+ * Make sure that per-type array pointers point proper position in the
+ * array which consists of all hints.
+ */
+ hstate->scan_hints = (ScanMethodHint **) hstate->all_hints;
+ hstate->join_hints = (JoinMethodHint **) (hstate->scan_hints +
+ hstate->num_hints[HINT_TYPE_SCAN_METHOD]);
+ hstate->leading_hint = (LeadingHint **) (hstate->join_hints +
+ hstate->num_hints[HINT_TYPE_JOIN_METHOD]);
+ hstate->set_hints = (SetHint **) (hstate->leading_hint +
+ hstate->num_hints[HINT_TYPE_LEADING]);
+
+ return hstate;
+}
+
+/*
+ * Parse inside of parentheses of scan-method hints.
+ */
+static const char *
+ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse,
+ const char *str)
+{
+ const char *keyword = hint->base.keyword;
+ HintKeyword hint_keyword = hint->base.hint_keyword;
+ List *name_list = NIL;
+ int length;
+
+ if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
+ return NULL;
+
+ /* Parse relation name and index name(s) if given hint accepts. */
+ length = list_length(name_list);
+ if (length > 0)
+ {
+ hint->relname = linitial(name_list);
+ hint->indexnames = list_delete_first(name_list);
+
+ /* check whether the hint accepts index name(s). */
+ if (length != 1 &&
+ hint_keyword != HINT_KEYWORD_INDEXSCAN &&
+ hint_keyword != HINT_KEYWORD_INDEXSCANREGEXP &&
+#if PG_VERSION_NUM >= 90200
+ hint_keyword != HINT_KEYWORD_INDEXONLYSCAN &&
+ hint_keyword != HINT_KEYWORD_INDEXONLYSCANREGEXP &&
+#endif
+ hint_keyword != HINT_KEYWORD_BITMAPSCAN &&
+ hint_keyword != HINT_KEYWORD_BITMAPSCANREGEXP)
+ {
+ hint_ereport(str,
+ ("%s hint accepts only one relation.",
+ hint->base.keyword));
+ hint->base.state = HINT_STATE_ERROR;
+ return str;
+ }
+ }
+ else
+ {
+ hint_ereport(str,
+ ("%s hint requires a relation.",
+ hint->base.keyword));
+ hint->base.state = HINT_STATE_ERROR;
+ return str;
+ }
+
+ /* Set a bit for specified hint. */
+ switch (hint_keyword)
+ {
+ case HINT_KEYWORD_SEQSCAN:
+ hint->enforce_mask = ENABLE_SEQSCAN;
+ break;
+ case HINT_KEYWORD_INDEXSCAN:
+ hint->enforce_mask = ENABLE_INDEXSCAN;
+ break;
+ case HINT_KEYWORD_INDEXSCANREGEXP:
+ hint->enforce_mask = ENABLE_INDEXSCAN;
+ hint->regexp = true;
+ break;
+ case HINT_KEYWORD_BITMAPSCAN:
+ hint->enforce_mask = ENABLE_BITMAPSCAN;
+ break;
+ case HINT_KEYWORD_BITMAPSCANREGEXP:
+ hint->enforce_mask = ENABLE_BITMAPSCAN;
+ hint->regexp = true;
+ break;
+ case HINT_KEYWORD_TIDSCAN:
+ hint->enforce_mask = ENABLE_TIDSCAN;
+ break;
+ case HINT_KEYWORD_NOSEQSCAN:
+ hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_SEQSCAN;
+ break;
+ case HINT_KEYWORD_NOINDEXSCAN:
+ hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXSCAN;
+ break;
+ case HINT_KEYWORD_NOBITMAPSCAN:
+ hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_BITMAPSCAN;
+ break;
+ case HINT_KEYWORD_NOTIDSCAN:
+ hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_TIDSCAN;
+ break;
+#if PG_VERSION_NUM >= 90200
+ case HINT_KEYWORD_INDEXONLYSCAN:
+ hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
+ break;
+ case HINT_KEYWORD_INDEXONLYSCANREGEXP:
+ hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
+ hint->regexp = true;
+ break;
+ case HINT_KEYWORD_NOINDEXONLYSCAN:
+ hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXONLYSCAN;
+ break;
+#endif
+ default:
+ hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
+ return NULL;
+ break;
+ }
+
+ return str;
+}
+
+static const char *
+JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate, Query *parse,
+ const char *str)
+{
+ const char *keyword = hint->base.keyword;
+ HintKeyword hint_keyword = hint->base.hint_keyword;
+ List *name_list = NIL;
+
+ if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
+ return NULL;
+
+ hint->nrels = list_length(name_list);
+
+ if (hint->nrels > 0)
+ {
+ ListCell *l;
+ int i = 0;
+
+ /*
+ * Transform relation names from list to array to sort them with qsort
+ * after.
+ */
+ hint->relnames = palloc(sizeof(char *) * hint->nrels);
+ foreach (l, name_list)
+ {
+ hint->relnames[i] = lfirst(l);
+ i++;
+ }
+ }
+
+ list_free(name_list);
+
+ /* A join hint requires at least two relations */
+ if (hint->nrels < 2)
+ {
+ hint_ereport(str,
+ ("%s hint requires at least two relations.",
+ hint->base.keyword));
+ hint->base.state = HINT_STATE_ERROR;
+ return str;
+ }
+
+ /* Sort hints in alphabetical order of relation names. */
+ qsort(hint->relnames, hint->nrels, sizeof(char *), RelnameCmp);
+
+ switch (hint_keyword)
+ {
+ case HINT_KEYWORD_NESTLOOP:
+ hint->enforce_mask = ENABLE_NESTLOOP;
+ break;
+ case HINT_KEYWORD_MERGEJOIN:
+ hint->enforce_mask = ENABLE_MERGEJOIN;
+ break;
+ case HINT_KEYWORD_HASHJOIN:
+ hint->enforce_mask = ENABLE_HASHJOIN;
+ break;
+ case HINT_KEYWORD_NONESTLOOP:
+ hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_NESTLOOP;
+ break;
+ case HINT_KEYWORD_NOMERGEJOIN:
+ hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_MERGEJOIN;
+ break;
+ case HINT_KEYWORD_NOHASHJOIN:
+ hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_HASHJOIN;
+ break;
+ default:
+ hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
+ return NULL;
+ break;
+ }
+
+ return str;
+}
+
+static bool
+OuterInnerPairCheck(OuterInnerRels *outer_inner)
+{
+ ListCell *l;
+ if (outer_inner->outer_inner_pair == NIL)
+ {
+ if (outer_inner->relation)
+ return true;
+ else
+ return false;
+ }
+
+ if (list_length(outer_inner->outer_inner_pair) == 2)
+ {
+ foreach(l, outer_inner->outer_inner_pair)
+ {
+ if (!OuterInnerPairCheck(lfirst(l)))
+ return false;
+ }
+ }
+ else
+ return false;
+
+ return true;
+}
+
+static List *
+OuterInnerList(OuterInnerRels *outer_inner)
+{
+ List *outer_inner_list = NIL;
+ ListCell *l;
+ OuterInnerRels *outer_inner_rels;
+
+ foreach(l, outer_inner->outer_inner_pair)
+ {
+ outer_inner_rels = (OuterInnerRels *)(lfirst(l));
+
+ if (outer_inner_rels->relation != NULL)
+ outer_inner_list = lappend(outer_inner_list,
+ outer_inner_rels->relation);
+ else
+ outer_inner_list = list_concat(outer_inner_list,
+ OuterInnerList(outer_inner_rels));
+ }
+ return outer_inner_list;
+}
+
+static const char *
+LeadingHintParse(LeadingHint *hint, HintState *hstate, Query *parse,
+ const char *str)
+{
+ List *name_list = NIL;
+ OuterInnerRels *outer_inner = NULL;
+
+ if ((str = parse_parentheses_Leading(str, &name_list, &outer_inner)) ==
+ NULL)
+ return NULL;
+
+ if (outer_inner != NULL)
+ name_list = OuterInnerList(outer_inner);
+
+ hint->relations = name_list;
+ hint->outer_inner = outer_inner;
+
+ /* A Leading hint requires at least two relations */
+ if ( hint->outer_inner == NULL && list_length(hint->relations) < 2)
+ {
+ hint_ereport(hint->base.hint_str,
+ ("%s hint requires at least two relations.",
+ HINT_LEADING));
+ hint->base.state = HINT_STATE_ERROR;
+ }
+ else if (hint->outer_inner != NULL &&
+ !OuterInnerPairCheck(hint->outer_inner))
+ {
+ hint_ereport(hint->base.hint_str,
+ ("%s hint requires two sets of relations when parentheses nests.",
+ HINT_LEADING));
+ hint->base.state = HINT_STATE_ERROR;
+ }
+
+ return str;
+}
+
+static const char *
+SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str)
+{
+ List *name_list = NIL;
+
+ if ((str = parse_parentheses(str, &name_list, hint->base.hint_keyword))
+ == NULL)
+ return NULL;
+
+ hint->words = name_list;
+
+ /* We need both name and value to set GUC parameter. */
+ if (list_length(name_list) == 2)
+ {
+ hint->name = linitial(name_list);
+ hint->value = lsecond(name_list);
+ }
+ else
+ {
+ hint_ereport(hint->base.hint_str,
+ ("%s hint requires name and value of GUC parameter.",
+ HINT_SET));
+ hint->base.state = HINT_STATE_ERROR;
+ }
+
+ return str;
+}
+
+/*
+ * set GUC parameter functions
+ */
+
+static int
+set_config_option_wrapper(const char *name, const char *value,
+ GucContext context, GucSource source,
+ GucAction action, bool changeVal, int elevel)
+{
+ int result = 0;
+ MemoryContext ccxt = CurrentMemoryContext;
+
+ PG_TRY();
+ {
+#if PG_VERSION_NUM >= 90200
+ result = set_config_option(name, value, context, source,
+ action, changeVal, 0);
+#else
+ result = set_config_option(name, value, context, source,
+ action, changeVal);
+#endif
+ }
+ PG_CATCH();
+ {
+ ErrorData *errdata;
+
+ /* Save error info */
+ MemoryContextSwitchTo(ccxt);
+ errdata = CopyErrorData();
+ FlushErrorState();
+
+ ereport(elevel, (errcode(errdata->sqlerrcode),
+ errmsg("%s", errdata->message),
+ errdata->detail ? errdetail("%s", errdata->detail) : 0,
+ errdata->hint ? errhint("%s", errdata->hint) : 0));
+ FreeErrorData(errdata);
+ }
+ PG_END_TRY();
+
+ return result;
+}
+
+static int
+set_config_options(SetHint **options, int noptions, GucContext context)
+{
+ int i;
+ int save_nestlevel;
+
+ save_nestlevel = NewGUCNestLevel();
+
+ for (i = 0; i < noptions; i++)
+ {
+ SetHint *hint = options[i];
+ int result;
+
+ if (!hint_state_enabled(hint))
+ continue;
+
+ result = set_config_option_wrapper(hint->name, hint->value, context,
+ PGC_S_SESSION, GUC_ACTION_SAVE, true,
+ pg_hint_plan_parse_messages);
+ if (result != 0)
+ hint->base.state = HINT_STATE_USED;
+ else
+ hint->base.state = HINT_STATE_ERROR;
+ }
+
+ return save_nestlevel;
+}
+
+#define SET_CONFIG_OPTION(name, type_bits) \
+ set_config_option_wrapper((name), \
+ (mask & (type_bits)) ? "true" : "false", \
+ context, PGC_S_SESSION, GUC_ACTION_SAVE, true, ERROR)
+
+static void
+set_scan_config_options(unsigned char enforce_mask, GucContext context)
+{
+ unsigned char mask;
+
+ if (enforce_mask == ENABLE_SEQSCAN || enforce_mask == ENABLE_INDEXSCAN ||
+ enforce_mask == ENABLE_BITMAPSCAN || enforce_mask == ENABLE_TIDSCAN
+#if PG_VERSION_NUM >= 90200
+ || enforce_mask == (ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN)
+#endif
+ )
+ mask = enforce_mask;
+ else
+ mask = enforce_mask & current_hint->init_scan_mask;
+
+ SET_CONFIG_OPTION("enable_seqscan", ENABLE_SEQSCAN);
+ SET_CONFIG_OPTION("enable_indexscan", ENABLE_INDEXSCAN);
+ SET_CONFIG_OPTION("enable_bitmapscan", ENABLE_BITMAPSCAN);
+ SET_CONFIG_OPTION("enable_tidscan", ENABLE_TIDSCAN);
+#if PG_VERSION_NUM >= 90200
+ SET_CONFIG_OPTION("enable_indexonlyscan", ENABLE_INDEXONLYSCAN);
+#endif
+}
+
+static void
+set_join_config_options(unsigned char enforce_mask, GucContext context)
+{
+ unsigned char mask;
+
+ if (enforce_mask == ENABLE_NESTLOOP || enforce_mask == ENABLE_MERGEJOIN ||
+ enforce_mask == ENABLE_HASHJOIN)
+ mask = enforce_mask;
+ else
+ mask = enforce_mask & current_hint->init_join_mask;
+
+ SET_CONFIG_OPTION("enable_nestloop", ENABLE_NESTLOOP);
+ SET_CONFIG_OPTION("enable_mergejoin", ENABLE_MERGEJOIN);
+ SET_CONFIG_OPTION("enable_hashjoin", ENABLE_HASHJOIN);
+}
+
+/*
+ * pg_hint_plan hook functions
+ */
+
+static void
+pg_hint_plan_ProcessUtility(Node *parsetree, const char *queryString,
+ ParamListInfo params, bool isTopLevel,
+ DestReceiver *dest, char *completionTag)
+{
+ Node *node;
+
+ if (!pg_hint_plan_enable_hint)
+ {
+ if (prev_ProcessUtility)
+ (*prev_ProcessUtility) (parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ else
+ standard_ProcessUtility(parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+
+ return;
+ }
+
+ node = parsetree;
+ if (IsA(node, ExplainStmt))
+ {
+ /*
+ * Draw out parse tree of actual query from Query struct of EXPLAIN
+ * statement.
+ */
+ ExplainStmt *stmt;
+ Query *query;
+
+ stmt = (ExplainStmt *) node;
+
+ Assert(IsA(stmt->query, Query));
+ query = (Query *) stmt->query;
+
+ if (query->commandType == CMD_UTILITY && query->utilityStmt != NULL)
+ node = query->utilityStmt;
+ }
+
+ /*
+ * If the query was a EXECUTE or CREATE TABLE AS EXECUTE, get query string
+ * specified to preceding PREPARE command to use it as source of hints.
+ */
+ if (IsA(node, ExecuteStmt))
+ {
+ ExecuteStmt *stmt;
+
+ stmt = (ExecuteStmt *) node;
+ stmt_name = stmt->name;
+ }
+#if PG_VERSION_NUM >= 90200
+ /*
+ * CREATE AS EXECUTE behavior has changed since 9.2, so we must handle it
+ * specially here.
+ */
+ if (IsA(node, CreateTableAsStmt))
+ {
+ CreateTableAsStmt *stmt;
+ Query *query;
+
+ stmt = (CreateTableAsStmt *) node;
+ Assert(IsA(stmt->query, Query));
+ query = (Query *) stmt->query;
+
+ if (query->commandType == CMD_UTILITY &&
+ IsA(query->utilityStmt, ExecuteStmt))
+ {
+ ExecuteStmt *estmt = (ExecuteStmt *) query->utilityStmt;
+ stmt_name = estmt->name;
+ }
+ }
+#endif
+ if (stmt_name)
+ {
+ PG_TRY();
+ {
+ if (prev_ProcessUtility)
+ (*prev_ProcessUtility) (parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ else
+ standard_ProcessUtility(parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ }
+ PG_CATCH();
+ {
+ stmt_name = NULL;
+ PG_RE_THROW();
+ }
+ PG_END_TRY();
+
+ stmt_name = NULL;
+
+ return;
+ }
+
+ if (prev_ProcessUtility)
+ (*prev_ProcessUtility) (parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ else
+ standard_ProcessUtility(parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+}
+
+/*
+ * Push a hint into hint stack which is implemented with List struct. Head of
+ * list is top of stack.
+ */
+static void
+push_hint(HintState *hstate)
+{
+ /* Prepend new hint to the list means pushing to stack. */
+ HintStateStack = lcons(hstate, HintStateStack);
+
+ /* Pushed hint is the one which should be used hereafter. */
+ current_hint = hstate;
+}
+
+/* Pop a hint from hint stack. Popped hint is automatically discarded. */
+static void
+pop_hint(void)
+{
+ /* Hint stack must not be empty. */
+ if(HintStateStack == NIL)
+ elog(ERROR, "hint stack is empty");
+
+ /*
+ * Take a hint at the head from the list, and free it. Switch current_hint
+ * to point new head (NULL if the list is empty).
+ */
+ HintStateStack = list_delete_first(HintStateStack);
+ HintStateDelete(current_hint);
+ if(HintStateStack == NIL)
+ current_hint = NULL;
+ else
+ current_hint = (HintState *) lfirst(list_head(HintStateStack));
+}
+
+static PlannedStmt *
+pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams)
+{
+ int save_nestlevel;
+ PlannedStmt *result;
+ HintState *hstate;
+
+ /*
+ * Use standard planner if pg_hint_plan is disabled. Other hook functions
+ * try to change plan with current_hint if any, so set it to NULL.
+ */
+ if (!pg_hint_plan_enable_hint)
+ {
+ current_hint = NULL;
+
+ if (prev_planner)
+ return (*prev_planner) (parse, cursorOptions, boundParams);
+ else
+ return standard_planner(parse, cursorOptions, boundParams);
+ }
+
+ /* Create hint struct from parse tree. */
+ hstate = parse_head_comment(parse);
+
+ /*
+ * Use standard planner if the statement has not valid hint. Other hook
+ * functions try to change plan with current_hint if any, so set it to
+ * NULL.
+ */
+ if (!hstate)
+ {
+ current_hint = NULL;
+
+ if (prev_planner)
+ return (*prev_planner) (parse, cursorOptions, boundParams);
+ else
+ return standard_planner(parse, cursorOptions, boundParams);
+ }
+
+ /*
+ * Push new hint struct to the hint stack to disable previous hint context.
+ */
+ push_hint(hstate);
+
+ /* Set GUC parameters which are specified with Set hint. */
+ save_nestlevel = set_config_options(current_hint->set_hints,
+ current_hint->num_hints[HINT_TYPE_SET],
+ current_hint->context);
+
+ if (enable_seqscan)
+ current_hint->init_scan_mask |= ENABLE_SEQSCAN;
+ if (enable_indexscan)
+ current_hint->init_scan_mask |= ENABLE_INDEXSCAN;
+ if (enable_bitmapscan)
+ current_hint->init_scan_mask |= ENABLE_BITMAPSCAN;
+ if (enable_tidscan)
+ current_hint->init_scan_mask |= ENABLE_TIDSCAN;
+#if PG_VERSION_NUM >= 90200
+ if (enable_indexonlyscan)
+ current_hint->init_scan_mask |= ENABLE_INDEXONLYSCAN;
+#endif
+ if (enable_nestloop)
+ current_hint->init_join_mask |= ENABLE_NESTLOOP;
+ if (enable_mergejoin)
+ current_hint->init_join_mask |= ENABLE_MERGEJOIN;
+ if (enable_hashjoin)
+ current_hint->init_join_mask |= ENABLE_HASHJOIN;
+
+ /*
+ * Use PG_TRY mechanism to recover GUC parameters and current_hint to the
+ * state when this planner started when error occurred in planner.
+ */
+ PG_TRY();
+ {
+ if (prev_planner)
+ result = (*prev_planner) (parse, cursorOptions, boundParams);
+ else
+ result = standard_planner(parse, cursorOptions, boundParams);
+ }
+ PG_CATCH();
+ {
+ /*
+ * Rollback changes of GUC parameters, and pop current hint context
+ * from hint stack to rewind the state.
+ */
+ AtEOXact_GUC(true, save_nestlevel);
+ pop_hint();
+ PG_RE_THROW();
+ }
+ PG_END_TRY();
+
+ /* Print hint in debug mode. */
+ if (pg_hint_plan_debug_print)
+ HintStateDump(current_hint);
+
+ /*
+ * Rollback changes of GUC parameters, and pop current hint context from
+ * hint stack to rewind the state.
+ */
+ AtEOXact_GUC(true, save_nestlevel);
+ pop_hint();
+
+ return result;
+}
+
+/*
+ * Return scan method hint which matches given aliasname.
+ */
+static ScanMethodHint *
+find_scan_hint(PlannerInfo *root, RelOptInfo *rel)
+{
+ RangeTblEntry *rte;
+ int i;
+
+ /*
+ * We can't apply scan method hint if the relation is:
+ * - not a base relation
+ * - not an ordinary relation (such as join and subquery)
+ */
+ if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
+ return NULL;
+
+ rte = root->simple_rte_array[rel->relid];
+
+ /* We can't force scan method of foreign tables */
+ if (rte->relkind == RELKIND_FOREIGN_TABLE)
+ return NULL;
+
+ /* Find scan method hint, which matches given names, from the list. */
+ for (i = 0; i < current_hint->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
+ {
+ ScanMethodHint *hint = current_hint->scan_hints[i];
+
+ /* We ignore disabled hints. */
+ if (!hint_state_enabled(hint))
+ continue;
+
+ if (RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0)
+ return hint;
+ }
+
+ return NULL;
+}
+
+/*
+ * regexeq
+ *
+ * Returns TRUE on match, FALSE on no match.
+ *
+ * s1 --- the data to match against
+ * s2 --- the pattern
+ *
+ * Because we copy s1 to NameData, make the size of s1 less than NAMEDATALEN.
+ */
+static bool
+regexpeq(const char *s1, const char *s2)
+{
+ NameData name;
+ text *regexp;
+ Datum result;
+
+ strcpy(name.data, s1);
+ regexp = cstring_to_text(s2);
+
+ result = DirectFunctionCall2Coll(nameregexeq,
+ DEFAULT_COLLATION_OID,
+ NameGetDatum(&name),
+ PointerGetDatum(regexp));
+ return DatumGetBool(result);
+}
+
+static void
+delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId)
+{
+ ListCell *cell;
+ ListCell *prev;
+ ListCell *next;
+ StringInfoData buf;
+
+ /*
+ * We delete all the IndexOptInfo list and prevent you from being usable by
+ * a scan.
+ */
+ if (hint->enforce_mask == ENABLE_SEQSCAN ||
+ hint->enforce_mask == ENABLE_TIDSCAN)
+ {
+ list_free_deep(rel->indexlist);
+ rel->indexlist = NIL;
+ hint->base.state = HINT_STATE_USED;
+
+ return;
+ }
+
+ /*
+ * When a list of indexes is not specified, we just use all indexes.
+ */
+ if (hint->indexnames == NIL)
+ return;
+
+ /*
+ * Leaving only an specified index, we delete it from a IndexOptInfo list
+ * other than it.
+ */
+ prev = NULL;
+ if (pg_hint_plan_debug_print)
+ initStringInfo(&buf);
+
+ for (cell = list_head(rel->indexlist); cell; cell = next)
+ {
+ IndexOptInfo *info = (IndexOptInfo *) lfirst(cell);
+ char *indexname = get_rel_name(info->indexoid);
+ ListCell *l;
+ bool use_index = false;
+
+ next = lnext(cell);
+
+ foreach(l, hint->indexnames)
+ {
+ char *hintname = (char *) lfirst(l);
+ bool result;
+
+ if (hint->regexp)
+ result = regexpeq(indexname, hintname);
+ else
+ result = RelnameCmp(&indexname, &hintname) == 0;
+
+ if (result)
+ {
+ use_index = true;
+ if (pg_hint_plan_debug_print)
+ {
+ appendStringInfoCharMacro(&buf, ' ');
+ quote_value(&buf, indexname);
+ }
+
+ break;
+ }
+ }
+
+ /*
+ * to make the index a candidate when definition of this index is
+ * matched with the index's definition of current_hint.
+ */
+ if (OidIsValid(relationObjectId) && !use_index)
+ {
+ foreach(l, current_hint->parent_index_infos)
+ {
+ int i;
+ HeapTuple ht_idx;
+ ParentIndexInfo *p_info = (ParentIndexInfo *)lfirst(l);
+
+ /* check to match the parameter of unique */
+ if (p_info->indisunique != info->unique)
+ continue;
+
+ /* check to match the parameter of index's method */
+ if (p_info->method != info->relam)
+ continue;
+
+ /* to check to match the indexkey's configuration */
+ if ((list_length(p_info->column_names)) !=
+ info->ncolumns)
+ continue;
+
+ /* check to match the indexkey's configuration */
+ for (i = 0; i < info->ncolumns; i++)
+ {
+ char *c_attname = NULL;
+ char *p_attname = NULL;
+
+ p_attname =
+ list_nth(p_info->column_names, i);
+
+ /* both are expressions */
+ if (info->indexkeys[i] == 0 && !p_attname)
+ continue;
+
+ /* one's column is expression, the other is not */
+ if (info->indexkeys[i] == 0 || !p_attname)
+ break;
+
+ c_attname = get_attname(relationObjectId,
+ info->indexkeys[i]);
+
+ if (strcmp(p_attname, c_attname) != 0)
+ break;
+
+ if (p_info->indcollation[i] != info->indexcollations[i])
+ break;
+
+ if (p_info->opclass[i] != info->opcintype[i])
+ break;
+
+ if (((p_info->indoption[i] & INDOPTION_DESC) != 0) !=
+ info->reverse_sort[i])
+ break;
+
+ if (((p_info->indoption[i] & INDOPTION_NULLS_FIRST) != 0) !=
+ info->nulls_first[i])
+ break;
+
+ }
+
+ if (i != info->ncolumns)
+ continue;
+
+ if ((p_info->expression_str && (info->indexprs != NIL)) ||
+ (p_info->indpred_str && (info->indpred != NIL)))
+ {
+ /*
+ * Fetch the pg_index tuple by the Oid of the index
+ */
+ ht_idx = SearchSysCache1(INDEXRELID,
+ ObjectIdGetDatum(info->indexoid));
+
+ /* check to match the expression's parameter of index */
+ if (p_info->expression_str &&
+ !heap_attisnull(ht_idx, Anum_pg_index_indexprs))
+ {
+ Datum exprsDatum;
+ bool isnull;
+ Datum result;
+
+ /*
+ * to change the expression's parameter of child's
+ * index to strings
+ */
+ exprsDatum = SysCacheGetAttr(INDEXRELID, ht_idx,
+ Anum_pg_index_indexprs,
+ &isnull);
+
+ result = DirectFunctionCall2(pg_get_expr,
+ exprsDatum,
+ ObjectIdGetDatum(
+ relationObjectId));
+
+ if (strcmp(p_info->expression_str,
+ text_to_cstring(DatumGetTextP(result))) != 0)
+ {
+ /* Clean up */
+ ReleaseSysCache(ht_idx);
+
+ continue;
+ }
+ }
+
+ /* Check to match the predicate's paraameter of index */
+ if (p_info->indpred_str &&
+ !heap_attisnull(ht_idx, Anum_pg_index_indpred))
+ {
+ Datum predDatum;
+ bool isnull;
+ Datum result;
+
+ /*
+ * to change the predicate's parabeter of child's
+ * index to strings
+ */
+ predDatum = SysCacheGetAttr(INDEXRELID, ht_idx,
+ Anum_pg_index_indpred,
+ &isnull);
+
+ result = DirectFunctionCall2(pg_get_expr,
+ predDatum,
+ ObjectIdGetDatum(
+ relationObjectId));
+
+ if (strcmp(p_info->indpred_str,
+ text_to_cstring(DatumGetTextP(result))) != 0)
+ {
+ /* Clean up */
+ ReleaseSysCache(ht_idx);
+
+ continue;
+ }
+ }
+
+ /* Clean up */
+ ReleaseSysCache(ht_idx);
+ }
+ else if (p_info->expression_str || (info->indexprs != NIL))
+ continue;
+ else if (p_info->indpred_str || (info->indpred != NIL))
+ continue;
+
+ use_index = true;
+
+ /* to log the candidate of index */
+ if (pg_hint_plan_debug_print)
+ {
+ appendStringInfoCharMacro(&buf, ' ');
+ quote_value(&buf, indexname);
+ }
+
+ break;
+ }
+ }
+
+ if (!use_index)
+ rel->indexlist = list_delete_cell(rel->indexlist, cell, prev);
+ else
+ prev = cell;
+
+ pfree(indexname);
+ }
+
+ if (pg_hint_plan_debug_print)
+ {
+ char *relname;
+ StringInfoData rel_buf;
+
+ if (OidIsValid(relationObjectId))
+ relname = get_rel_name(relationObjectId);
+ else
+ relname = hint->relname;
+
+ initStringInfo(&rel_buf);
+ quote_value(&rel_buf, relname);
+
+ ereport(LOG,
+ (errmsg("available indexes for %s(%s):%s",
+ hint->base.keyword,
+ rel_buf.data,
+ buf.data)));
+ pfree(buf.data);
+ pfree(rel_buf.data);
+ }
+}
+
+/*
+ * Return information of index definition.
+ */
+static ParentIndexInfo *
+get_parent_index_info(Oid indexoid, Oid relid)
+{
+ ParentIndexInfo *p_info = palloc(sizeof(ParentIndexInfo));
+ Relation indexRelation;
+ Form_pg_index index;
+ char *attname;
+ int i;
+
+ indexRelation = index_open(indexoid, RowExclusiveLock);
+
+ index = indexRelation->rd_index;
+
+ p_info->indisunique = index->indisunique;
+ p_info->method = indexRelation->rd_rel->relam;
+
+ p_info->column_names = NIL;
+ p_info->indcollation = (Oid *) palloc(sizeof(Oid) * index->indnatts);
+ p_info->opclass = (Oid *) palloc(sizeof(Oid) * index->indnatts);
+ p_info->indoption = (int16 *) palloc(sizeof(Oid) * index->indnatts);
+
+ for (i = 0; i < index->indnatts; i++)
+ {
+ attname = get_attname(relid, index->indkey.values[i]);
+ p_info->column_names = lappend(p_info->column_names, attname);
+
+ p_info->indcollation[i] = indexRelation->rd_indcollation[i];
+ p_info->opclass[i] = indexRelation->rd_opcintype[i];
+ p_info->indoption[i] = indexRelation->rd_indoption[i];
+ }
+
+ /*
+ * to check to match the expression's paraameter of index with child indexes
+ */
+ p_info->expression_str = NULL;
+ if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indexprs))
+ {
+ Datum exprsDatum;
+ bool isnull;
+ Datum result;
+
+ exprsDatum = SysCacheGetAttr(INDEXRELID, indexRelation->rd_indextuple,
+ Anum_pg_index_indexprs, &isnull);
+
+ result = DirectFunctionCall2(pg_get_expr,
+ exprsDatum,
+ ObjectIdGetDatum(relid));
+
+ p_info->expression_str = text_to_cstring(DatumGetTextP(result));
+ }
+
+ /*
+ * to check to match the predicate's paraameter of index with child indexes
+ */
+ p_info->indpred_str = NULL;
+ if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indpred))
+ {
+ Datum predDatum;
+ bool isnull;
+ Datum result;
+
+ predDatum = SysCacheGetAttr(INDEXRELID, indexRelation->rd_indextuple,
+ Anum_pg_index_indpred, &isnull);
+
+ result = DirectFunctionCall2(pg_get_expr,
+ predDatum,
+ ObjectIdGetDatum(relid));
+
+ p_info->indpred_str = text_to_cstring(DatumGetTextP(result));
+ }
+
+ index_close(indexRelation, NoLock);
+
+ return p_info;
+}
+
+static void
+pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
+ bool inhparent, RelOptInfo *rel)
+{
+ ScanMethodHint *hint;
+
+ if (prev_get_relation_info)
+ (*prev_get_relation_info) (root, relationObjectId, inhparent, rel);
+
+ /* Do nothing if we don't have valid hint in this context. */
+ if (!current_hint)
+ return;
+
+ if (inhparent)
+ {
+ /* 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)
+ {
+ /*
+ * 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.
+ */
+ ListCell *l;
+
+ /* append_rel_list contains all append rels; ignore others */
+ foreach(l, root->append_rel_list)
+ {
+ AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l);
+
+ /* This rel is child table. */
+ if (appinfo->parent_relid == current_hint->parent_relid &&
+ appinfo->child_relid == rel->relid)
+ {
+ if (current_hint->parent_hint)
+ delete_indexes(current_hint->parent_hint, rel,
+ relationObjectId);
+
+ return;
+ }
+ }
+
+ /* This rel is not inherit table. */
+ 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)
+ {
+ set_scan_config_options(current_hint->init_scan_mask,
+ current_hint->context);
+ return;
+ }
+ 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;
- if (k == other_level)
- other_rels = lnext(r); /* only consider remaining rels */
- else
- other_rels = list_head(joinrels[other_level]);
+ 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);
+}
+
+/*
+ * Return index of relation which matches given aliasname, or 0 if not found.
+ * If same aliasname was used multiple times in a query, return -1.
+ */
+static int
+find_relid_aliasname(PlannerInfo *root, char *aliasname, List *initial_rels,
+ const char *str)
+{
+ int i;
+ Index found = 0;
+
+ for (i = 1; i < root->simple_rel_array_size; i++)
+ {
+ ListCell *l;
+
+ if (root->simple_rel_array[i] == NULL)
+ continue;
+
+ Assert(i == root->simple_rel_array[i]->relid);
+
+ if (RelnameCmp(&aliasname,
+ &root->simple_rte_array[i]->eref->aliasname) != 0)
+ continue;
+
+ foreach(l, initial_rels)
+ {
+ RelOptInfo *rel = (RelOptInfo *) lfirst(l);
+
+ if (rel->reloptkind == RELOPT_BASEREL)
+ {
+ if (rel->relid != i)
+ continue;
+ }
+ else
+ {
+ Assert(rel->reloptkind == RELOPT_JOINREL);
+
+ if (!bms_is_member(i, rel->relids))
+ continue;
+ }
+
+ if (found != 0)
+ {
+ hint_ereport(str,
+ ("Relation name \"%s\" is ambiguous.",
+ aliasname));
+ return -1;
+ }
+
+ found = i;
+ break;
+ }
+
+ }
+
+ return found;
+}
+
+/*
+ * Return join hint which matches given joinrelids.
+ */
+static JoinMethodHint *
+find_join_hint(Relids joinrelids)
+{
+ List *join_hint;
+ ListCell *l;
+
+ join_hint = current_hint->join_hint_level[bms_num_members(joinrelids)];
+
+ foreach(l, join_hint)
+ {
+ JoinMethodHint *hint = (JoinMethodHint *) lfirst(l);
+
+ if (bms_equal(joinrelids, hint->joinrelids))
+ return hint;
+ }
+
+ return NULL;
+}
+
+static Relids
+OuterInnerJoinCreate(OuterInnerRels *outer_inner, LeadingHint *leading_hint,
+ PlannerInfo *root, List *initial_rels, HintState *hstate, int nbaserel)
+{
+ OuterInnerRels *outer_rels;
+ OuterInnerRels *inner_rels;
+ Relids outer_relids;
+ Relids inner_relids;
+ Relids join_relids;
+ JoinMethodHint *hint;
+
+ if (outer_inner->relation != NULL)
+ {
+ return bms_make_singleton(
+ find_relid_aliasname(root, outer_inner->relation,
+ initial_rels,
+ leading_hint->base.hint_str));
+ }
+
+ outer_rels = lfirst(outer_inner->outer_inner_pair->head);
+ inner_rels = lfirst(outer_inner->outer_inner_pair->tail);
+
+ outer_relids = OuterInnerJoinCreate(outer_rels,
+ leading_hint,
+ root,
+ initial_rels,
+ hstate,
+ nbaserel);
+ inner_relids = OuterInnerJoinCreate(inner_rels,
+ leading_hint,
+ root,
+ initial_rels,
+ hstate,
+ nbaserel);
+
+ join_relids = bms_add_members(outer_relids, inner_relids);
+
+ if (bms_num_members(join_relids) > nbaserel)
+ return join_relids;
+
+ /*
+ * If we don't have join method hint, create new one for the
+ * join combination with all join methods are enabled.
+ */
+ hint = find_join_hint(join_relids);
+ if (hint == NULL)
+ {
+ /*
+ * Here relnames is not set, since Relids bitmap is sufficient to
+ * control paths of this query afterward.
+ */
+ hint = (JoinMethodHint *) JoinMethodHintCreate(
+ leading_hint->base.hint_str,
+ HINT_LEADING,
+ HINT_KEYWORD_LEADING);
+ hint->base.state = HINT_STATE_USED;
+ hint->nrels = bms_num_members(join_relids);
+ hint->enforce_mask = ENABLE_ALL_JOIN;
+ hint->joinrelids = bms_copy(join_relids);
+ hint->inner_nrels = bms_num_members(inner_relids);
+ hint->inner_joinrelids = bms_copy(inner_relids);
+
+ hstate->join_hint_level[hint->nrels] =
+ lappend(hstate->join_hint_level[hint->nrels], hint);
+ }
+ else
+ {
+ hint->inner_nrels = bms_num_members(inner_relids);
+ hint->inner_joinrelids = bms_copy(inner_relids);
+ }
+
+ return join_relids;
+}
+
+/*
+ * Transform join method hint into handy form.
+ *
+ * - create bitmap of relids from alias names, to make it easier to check
+ * whether a join path matches a join method hint.
+ * - add join method hints which are necessary to enforce join order
+ * specified by Leading hint
+ */
+static bool
+transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel,
+ List *initial_rels, JoinMethodHint **join_method_hints)
+{
+ int i;
+ int relid;
+ Relids joinrelids;
+ int njoinrels;
+ ListCell *l;
+ char *relname;
+ LeadingHint *lhint = NULL;
+
+ /*
+ * Create bitmap of relids from alias names for each join method hint.
+ * Bitmaps are more handy than strings in join searching.
+ */
+ for (i = 0; i < hstate->num_hints[HINT_TYPE_JOIN_METHOD]; i++)
+ {
+ JoinMethodHint *hint = hstate->join_hints[i];
+ int j;
+
+ if (!hint_state_enabled(hint) || hint->nrels > nbaserel)
+ continue;
+
+ bms_free(hint->joinrelids);
+ hint->joinrelids = NULL;
+ relid = 0;
+ for (j = 0; j < hint->nrels; j++)
+ {
+ relname = hint->relnames[j];
+
+ relid = find_relid_aliasname(root, relname, initial_rels,
+ hint->base.hint_str);
- for_each_cell(r2, other_rels)
+ if (relid == -1)
+ hint->base.state = HINT_STATE_ERROR;
+
+ if (relid <= 0)
+ break;
+
+ if (bms_is_member(relid, hint->joinrelids))
{
- RelOptInfo *new_rel = (RelOptInfo *) lfirst(r2);
+ hint_ereport(hint->base.hint_str,
+ ("Relation name \"%s\" is duplicated.", relname));
+ hint->base.state = HINT_STATE_ERROR;
+ break;
+ }
- if (!bms_overlap(old_rel->relids, new_rel->relids))
- {
- /*
- * OK, we can build a rel of the right level from this
- * pair of rels. Do so if there is at least one usable
- * join clause or a relevant join restriction.
- */
- if (have_relevant_joinclause(root, old_rel, new_rel) ||
- have_join_order_restriction(root, old_rel, new_rel))
- {
- (void) my_make_join_rel(root, old_rel, new_rel);
- }
- }
+ hint->joinrelids = bms_add_member(hint->joinrelids, relid);
+ }
+
+ if (relid <= 0 || hint->base.state == HINT_STATE_ERROR)
+ continue;
+
+ hstate->join_hint_level[hint->nrels] =
+ lappend(hstate->join_hint_level[hint->nrels], hint);
+ }
+
+ /* Do nothing if no Leading hint was supplied. */
+ if (hstate->num_hints[HINT_TYPE_LEADING] == 0)
+ return false;
+
+ /*
+ * Decide to use Leading hint。
+ */
+ for (i = 0; i < hstate->num_hints[HINT_TYPE_LEADING]; i++)
+ {
+ LeadingHint *leading_hint = (LeadingHint *)hstate->leading_hint[i];
+ Relids relids;
+
+ if (leading_hint->base.state == HINT_STATE_ERROR)
+ continue;
+
+ relid = 0;
+ relids = NULL;
+
+ foreach(l, leading_hint->relations)
+ {
+ relname = (char *)lfirst(l);;
+
+ relid = find_relid_aliasname(root, relname, initial_rels,
+ leading_hint->base.hint_str);
+ if (relid == -1)
+ leading_hint->base.state = HINT_STATE_ERROR;
+
+ if (relid <= 0)
+ break;
+
+ if (bms_is_member(relid, relids))
+ {
+ hint_ereport(leading_hint->base.hint_str,
+ ("Relation name \"%s\" is duplicated.", relname));
+ leading_hint->base.state = HINT_STATE_ERROR;
+ break;
}
+
+ relids = bms_add_member(relids, relid);
}
+
+ if (relid <= 0 || leading_hint->base.state == HINT_STATE_ERROR)
+ continue;
+
+ if (lhint != NULL)
+ {
+ hint_ereport(lhint->base.hint_str,
+ ("Conflict %s hint.", HintTypeName[lhint->base.type]));
+ lhint->base.state = HINT_STATE_DUPLICATION;
+ }
+ leading_hint->base.state = HINT_STATE_USED;
+ lhint = leading_hint;
}
+ /* check to exist Leading hint marked with 'used'. */
+ if (lhint == NULL)
+ return false;
+
/*
- * Last-ditch effort: if we failed to find any usable joins so far, force
- * a set of cartesian-product joins to be generated. This handles the
- * special case where all the available rels have join clauses but we
- * cannot use any of those clauses yet. An example is
+ * We need join method hints which fit specified join order in every join
+ * level. For example, Leading(A B C) virtually requires following join
+ * method hints, if no join method hint supplied:
+ * - level 1: none
+ * - level 2: NestLoop(A B), MergeJoin(A B), HashJoin(A B)
+ * - level 3: NestLoop(A B C), MergeJoin(A B C), HashJoin(A B C)
*
- * SELECT * FROM a,b,c WHERE (a.f1 + b.f2 + c.f3) = 0;
- *
- * The join clause will be usable at level 3, but at level 2 we have no
- * choice but to make cartesian joins. We consider only left-sided and
- * right-sided cartesian joins in this case (no bushy).
+ * If we already have join method hint which fits specified join order in
+ * that join level, we leave it as-is and don't add new hints.
*/
- if (joinrels[level] == NIL)
+ joinrelids = NULL;
+ njoinrels = 0;
+ if (lhint->outer_inner == NULL)
+ {
+ foreach(l, lhint->relations)
+ {
+ JoinMethodHint *hint;
+
+ relname = (char *)lfirst(l);
+
+ /*
+ * Find relid of the relation which has given name. If we have the
+ * name given in Leading hint multiple times in the join, nothing to
+ * do.
+ */
+ relid = find_relid_aliasname(root, relname, initial_rels,
+ hstate->hint_str);
+
+ /* Create bitmap of relids for current join level. */
+ joinrelids = bms_add_member(joinrelids, relid);
+ njoinrels++;
+
+ /* We never have join method hint for single relation. */
+ if (njoinrels < 2)
+ continue;
+
+ /*
+ * If we don't have join method hint, create new one for the
+ * join combination with all join methods are enabled.
+ */
+ hint = find_join_hint(joinrelids);
+ if (hint == NULL)
+ {
+ /*
+ * Here relnames is not set, since Relids bitmap is sufficient
+ * to control paths of this query afterward.
+ */
+ hint = (JoinMethodHint *) JoinMethodHintCreate(
+ lhint->base.hint_str,
+ HINT_LEADING,
+ HINT_KEYWORD_LEADING);
+ hint->base.state = HINT_STATE_USED;
+ hint->nrels = njoinrels;
+ hint->enforce_mask = ENABLE_ALL_JOIN;
+ hint->joinrelids = bms_copy(joinrelids);
+ }
+
+ join_method_hints[njoinrels] = hint;
+
+ if (njoinrels >= nbaserel)
+ break;
+ }
+ bms_free(joinrelids);
+
+ if (njoinrels < 2)
+ return false;
+
+ /*
+ * Delete all join hints which have different combination from Leading
+ * hint.
+ */
+ for (i = 2; i <= njoinrels; i++)
+ {
+ list_free(hstate->join_hint_level[i]);
+
+ hstate->join_hint_level[i] = lappend(NIL, join_method_hints[i]);
+ }
+ }
+ else
{
+ joinrelids = OuterInnerJoinCreate(lhint->outer_inner,
+ lhint,
+ root,
+ initial_rels,
+ hstate,
+ nbaserel);
+
+ njoinrels = bms_num_members(joinrelids);
+ Assert(njoinrels >= 2);
+
/*
- * This loop is just like the first one, except we always call
- * make_rels_by_clauseless_joins().
+ * Delete all join hints which have different combination from Leading
+ * hint.
*/
- foreach(r, joinrels[level - 1])
+ for (i = 2;i <= njoinrels; i++)
{
- RelOptInfo *old_rel = (RelOptInfo *) lfirst(r);
- ListCell *other_rels;
+ if (hstate->join_hint_level[i] != NIL)
+ {
+ ListCell *prev = NULL;
+ ListCell *next = NULL;
+ for(l = list_head(hstate->join_hint_level[i]); l; l = next)
+ {
- if (level == 2)
- other_rels = lnext(r); /* only consider remaining initial
- * rels */
- else
- other_rels = list_head(joinrels[1]); /* consider all initial
- * rels */
+ JoinMethodHint *hint = (JoinMethodHint *)lfirst(l);
- make_rels_by_clauseless_joins(root,
- old_rel,
- other_rels);
+ next = lnext(l);
+
+ if (hint->inner_nrels == 0 &&
+ !(bms_intersect(hint->joinrelids, joinrelids) == NULL ||
+ bms_equal(bms_union(hint->joinrelids, joinrelids),
+ hint->joinrelids)))
+ {
+ hstate->join_hint_level[i] =
+ list_delete_cell(hstate->join_hint_level[i], l,
+ prev);
+ }
+ else
+ prev = l;
+ }
+ }
}
- /*----------
- * When special joins are involved, there may be no legal way
- * to make an N-way join for some values of N. For example consider
- *
- * SELECT ... FROM t1 WHERE
- * x IN (SELECT ... FROM t2,t3 WHERE ...) AND
- * y IN (SELECT ... FROM t4,t5 WHERE ...)
- *
- * We will flatten this query to a 5-way join problem, but there are
- * no 4-way joins that join_is_legal() will consider legal. We have
- * to accept failure at level 4 and go on to discover a workable
- * bushy plan at level 5.
- *
- * However, if there are no special joins then join_is_legal() should
- * never fail, and so the following sanity check is useful.
- *----------
- */
- if (joinrels[level] == NIL && root->join_info_list == NIL)
- elog(ERROR, "failed to build any %d-way joins", level);
+ bms_free(joinrelids);
+ }
+
+ if (hint_state_enabled(lhint))
+ {
+ set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
+ return true;
}
+ return false;
}
/*
- * src/backend/optimizer/path/joinrels.c
- * static make_rels_by_clause_joins() を流用
- *
- * 変更箇所
- * make_join_rel() の呼び出しをラップする、my_make_join_rel()の呼び出しに変更
- */
-/*
- * make_rels_by_clause_joins
- * Build joins between the given relation 'old_rel' and other relations
- * that participate in join clauses that 'old_rel' also participates in
- * (or participate in join-order restrictions with it).
- * The join rels are returned in root->join_rel_level[join_cur_level].
- *
- * Note: at levels above 2 we will generate the same joined relation in
- * multiple ways --- for example (a join b) join c is the same RelOptInfo as
- * (b join c) join a, though the second case will add a different set of Paths
- * to it. This is the reason for using the join_rel_level mechanism, which
- * automatically ensures that each new joinrel is only added to the list once.
+ * set_plain_rel_pathlist
+ * Build access paths for a plain relation (no subquery, no inheritance)
*
- * 'old_rel' is the relation entry for the relation to be joined
- * 'other_rels': the first cell in a linked list containing the other
- * rels to be considered for joining
- *
- * Currently, this is only used with initial rels in other_rels, but it
- * will work for joining to joinrels too.
+ * This function was copied and edited from set_plain_rel_pathlist() in
+ * src/backend/optimizer/path/allpaths.c
*/
static void
-make_rels_by_clause_joins(PlannerInfo *root,
- RelOptInfo *old_rel,
- ListCell *other_rels)
+set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
+{
+ /* Consider sequential scan */
+#if PG_VERSION_NUM >= 90200
+ add_path(rel, create_seqscan_path(root, rel, NULL));
+#else
+ add_path(rel, create_seqscan_path(root, rel));
+#endif
+
+ /* Consider index scans */
+ create_index_paths(root, rel);
+
+ /* Consider TID scans */
+ create_tidscan_paths(root, rel);
+
+ /* Now find the cheapest of the paths for this rel */
+ set_cheapest(rel);
+}
+
+static void
+rebuild_scan_path(HintState *hstate, PlannerInfo *root, int level,
+ List *initial_rels)
{
ListCell *l;
- for_each_cell(l, other_rels)
+ foreach(l, initial_rels)
{
- RelOptInfo *other_rel = (RelOptInfo *) lfirst(l);
+ RelOptInfo *rel = (RelOptInfo *) lfirst(l);
+ RangeTblEntry *rte;
+ ScanMethodHint *hint;
+
+ /* Skip relations which we can't choose scan method. */
+ if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
+ continue;
+
+ rte = root->simple_rte_array[rel->relid];
+
+ /* We can't force scan method of foreign tables */
+ if (rte->relkind == RELKIND_FOREIGN_TABLE)
+ continue;
+
+ /*
+ * Create scan paths with GUC parameters which are at the beginning of
+ * 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)
+ set_scan_config_options(hstate->init_scan_mask,
+ hstate->context);
+ else
+ {
+ set_scan_config_options(hint->enforce_mask, hstate->context);
+ hint->base.state = HINT_STATE_USED;
+ }
- if (!bms_overlap(old_rel->relids, other_rel->relids) &&
- (have_relevant_joinclause(root, old_rel, other_rel) ||
- have_join_order_restriction(root, old_rel, other_rel)))
+ list_free_deep(rel->pathlist);
+ rel->pathlist = NIL;
+ if (rte->inh)
+ {
+ /* It's an "append relation", process accordingly */
+ set_append_rel_pathlist(root, rel, rel->relid, rte);
+ }
+ else
{
- (void) my_make_join_rel(root, old_rel, other_rel);
+ set_plain_rel_pathlist(root, rel, rte);
}
}
+
+ /*
+ * Restore the GUC variables we set above.
+ */
+ set_scan_config_options(hstate->init_scan_mask, hstate->context);
}
/*
- * src/backend/optimizer/path/joinrels.c
- * static make_rels_by_clauseless_joins() を流用
- *
- * 変更箇所
- * make_join_rel() の呼び出しをラップする、my_make_join_rel()の呼び出しに変更
+ * wrapper of make_join_rel()
+ *
+ * call make_join_rel() after changing enable_* parameters according to given
+ * hints.
*/
+static RelOptInfo *
+make_join_rel_wrapper(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
+{
+ Relids joinrelids;
+ JoinMethodHint *hint;
+ RelOptInfo *rel;
+ int save_nestlevel;
+
+ joinrelids = bms_union(rel1->relids, rel2->relids);
+ hint = find_join_hint(joinrelids);
+ bms_free(joinrelids);
+
+ if (!hint)
+ return pg_hint_plan_make_join_rel(root, rel1, rel2);
+
+ if (hint->inner_nrels == 0)
+ {
+ save_nestlevel = NewGUCNestLevel();
+
+ set_join_config_options(hint->enforce_mask, current_hint->context);
+
+ rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
+ hint->base.state = HINT_STATE_USED;
+
+ /*
+ * Restore the GUC variables we set above.
+ */
+ AtEOXact_GUC(true, save_nestlevel);
+ }
+ else
+ rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
+
+ return rel;
+}
+
/*
- * make_rels_by_clauseless_joins
- * Given a relation 'old_rel' and a list of other relations
- * 'other_rels', create a join relation between 'old_rel' and each
- * member of 'other_rels' that isn't already included in 'old_rel'.
- * The join rels are returned in root->join_rel_level[join_cur_level].
- *
- * 'old_rel' is the relation entry for the relation to be joined
- * 'other_rels': the first cell of a linked list containing the
- * other rels to be considered for joining
- *
- * Currently, this is only used with initial rels in other_rels, but it would
- * work for joining to joinrels too.
+ * TODO : comment
*/
static void
-make_rels_by_clauseless_joins(PlannerInfo *root,
- RelOptInfo *old_rel,
- ListCell *other_rels)
+add_paths_to_joinrel_wrapper(PlannerInfo *root,
+ RelOptInfo *joinrel,
+ RelOptInfo *outerrel,
+ RelOptInfo *innerrel,
+ JoinType jointype,
+ SpecialJoinInfo *sjinfo,
+ List *restrictlist)
+{
+ ScanMethodHint *scan_hint = NULL;
+ Relids joinrelids;
+ JoinMethodHint *join_hint;
+ int save_nestlevel;
+
+ if ((scan_hint = find_scan_hint(root, innerrel)) != NULL)
+ {
+ set_scan_config_options(scan_hint->enforce_mask, current_hint->context);
+ scan_hint->base.state = HINT_STATE_USED;
+ }
+
+ joinrelids = bms_union(outerrel->relids, innerrel->relids);
+ join_hint = find_join_hint(joinrelids);
+ bms_free(joinrelids);
+
+ if (join_hint && join_hint->inner_nrels != 0)
+ {
+ save_nestlevel = NewGUCNestLevel();
+
+ if (bms_equal(join_hint->inner_joinrelids, innerrel->relids))
+ {
+
+ set_join_config_options(join_hint->enforce_mask,
+ current_hint->context);
+
+ add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
+ sjinfo, restrictlist);
+ join_hint->base.state = HINT_STATE_USED;
+ }
+ else
+ {
+ set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
+ add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
+ sjinfo, restrictlist);
+ }
+
+ /*
+ * Restore the GUC variables we set above.
+ */
+ AtEOXact_GUC(true, save_nestlevel);
+ }
+ else
+ add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
+ sjinfo, restrictlist);
+
+ if (scan_hint != NULL)
+ set_scan_config_options(current_hint->init_scan_mask,
+ current_hint->context);
+}
+
+static int
+get_num_baserels(List *initial_rels)
{
+ int nbaserel = 0;
ListCell *l;
- for_each_cell(l, other_rels)
+ foreach(l, initial_rels)
{
- RelOptInfo *other_rel = (RelOptInfo *) lfirst(l);
+ RelOptInfo *rel = (RelOptInfo *) lfirst(l);
- if (!bms_overlap(other_rel->relids, old_rel->relids))
+ if (rel->reloptkind == RELOPT_BASEREL)
+ nbaserel++;
+ else if (rel->reloptkind ==RELOPT_JOINREL)
+ nbaserel+= bms_num_members(rel->relids);
+ else
{
- (void) my_make_join_rel(root, old_rel, other_rel);
+ /* other values not expected here */
+ elog(ERROR, "unrecognized reloptkind type: %d", rel->reloptkind);
}
}
+
+ return nbaserel;
+}
+
+static RelOptInfo *
+pg_hint_plan_join_search(PlannerInfo *root, int levels_needed,
+ List *initial_rels)
+{
+ JoinMethodHint **join_method_hints;
+ int nbaserel;
+ RelOptInfo *rel;
+ int i;
+ bool leading_hint_enable;
+
+ /*
+ * Use standard planner (or geqo planner) if pg_hint_plan is disabled or no
+ * valid hint is supplied.
+ */
+ if (!current_hint)
+ {
+ if (prev_join_search)
+ return (*prev_join_search) (root, levels_needed, initial_rels);
+ else if (enable_geqo && levels_needed >= geqo_threshold)
+ return geqo(root, levels_needed, initial_rels);
+ else
+ return standard_join_search(root, levels_needed, initial_rels);
+ }
+
+ /* We apply scan method hint rebuild scan path. */
+ rebuild_scan_path(current_hint, root, levels_needed, initial_rels);
+
+ /*
+ * In the case using GEQO, only scan method hints and Set hints have
+ * effect. Join method and join order is not controllable by hints.
+ */
+ if (enable_geqo && levels_needed >= geqo_threshold)
+ return geqo(root, levels_needed, initial_rels);
+
+ nbaserel = get_num_baserels(initial_rels);
+ current_hint->join_hint_level = palloc0(sizeof(List *) * (nbaserel + 1));
+ join_method_hints = palloc0(sizeof(JoinMethodHint *) * (nbaserel + 1));
+
+ leading_hint_enable = transform_join_hints(current_hint, root, nbaserel,
+ initial_rels, join_method_hints);
+
+ rel = pg_hint_plan_standard_join_search(root, levels_needed, initial_rels);
+
+ for (i = 2; i <= nbaserel; i++)
+ {
+ list_free(current_hint->join_hint_level[i]);
+
+ /* free Leading hint only */
+ if (join_method_hints[i] != NULL &&
+ join_method_hints[i]->enforce_mask == ENABLE_ALL_JOIN)
+ JoinMethodHintDelete(join_method_hints[i]);
+ }
+ pfree(current_hint->join_hint_level);
+ pfree(join_method_hints);
+
+ if (leading_hint_enable)
+ set_join_config_options(current_hint->init_join_mask,
+ current_hint->context);
+
+ return rel;
}
/*
- * src/backend/optimizer/path/joinrels.c
- * static has_join_restriction() を流用
- *
- * 変更箇所
- * なし
- */
-/*
- * has_join_restriction
- * Detect whether the specified relation has join-order restrictions
- * due to being inside an outer join or an IN (sub-SELECT).
+ * set_rel_pathlist
+ * Build access paths for a base relation
*
- * Essentially, this tests whether have_join_order_restriction() could
- * succeed with this rel and some other one. It's OK if we sometimes
- * say "true" incorrectly. (Therefore, we don't bother with the relatively
- * expensive has_legal_joinclause test.)
+ * This function was copied and edited from set_rel_pathlist() in
+ * src/backend/optimizer/path/allpaths.c
*/
-static bool
-has_join_restriction(PlannerInfo *root, RelOptInfo *rel)
+static void
+set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
+ Index rti, RangeTblEntry *rte)
{
- ListCell *l;
-
- foreach(l, root->join_info_list)
+#if PG_VERSION_NUM >= 90200
+ if (IS_DUMMY_REL(rel))
{
- SpecialJoinInfo *sjinfo = (SpecialJoinInfo *) lfirst(l);
-
- /* ignore full joins --- other mechanisms preserve their ordering */
- if (sjinfo->jointype == JOIN_FULL)
- continue;
+ /* We already proved the relation empty, so nothing more to do */
+ }
+ else if (rte->inh)
+#else
+ if (rte->inh)
+#endif
+ {
+ /* It's an "append relation", process accordingly */
+ set_append_rel_pathlist(root, rel, rti, rte);
+ }
+ else
+ {
+ if (rel->rtekind == RTE_RELATION)
+ {
+ if (rte->relkind == RELKIND_RELATION)
+ {
+ /* Plain relation */
+ set_plain_rel_pathlist(root, rel, rte);
+ }
+ else
+ elog(ERROR, "unexpected relkind: %c", rte->relkind);
+ }
+ else
+ elog(ERROR, "unexpected rtekind: %d", (int) rel->rtekind);
+ }
+}
- /* ignore if SJ is already contained in rel */
- if (bms_is_subset(sjinfo->min_lefthand, rel->relids) &&
- bms_is_subset(sjinfo->min_righthand, rel->relids))
- continue;
+static void
+pg_hint_plan_plpgsql_func_setup(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt)
+{
+ (&plugin_funcs)->stmt_beg = pg_hint_plan_plpgsql_stmt_beg;
+ (&plugin_funcs)->stmt_end = pg_hint_plan_plpgsql_stmt_end;
+}
- /* restricted if it overlaps LHS or RHS, but doesn't contain SJ */
- if (bms_overlap(sjinfo->min_lefthand, rel->relids) ||
- bms_overlap(sjinfo->min_righthand, rel->relids))
- return true;
+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 = ((PLpgSQL_stmt_execsql *) stmt)->sqlstmt;
+ hint_query_string = expr->query;
}
+}
- return false;
+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)
+ hint_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
+#include "core.c"
+
+#undef make_join_rel
+#define make_join_rel pg_hint_plan_make_join_rel
+#define add_paths_to_joinrel add_paths_to_joinrel_wrapper
+#include "make_join_rel.c"
OSDN Git Service
