*
* pg_hint_plan.c
* do instructions or hints to the planner using C-style block comments
- * of the SQL.
+ * of the SQL.
*
- * Copyright (c) 2012, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
+ * Copyright (c) 2012-2013, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
*
*-------------------------------------------------------------------------
*/
#include "postgres.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 "tcop/tcopprot.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;
#error unsupported PostgreSQL version
#endif
-#define HINT_START "/*"
-#define HINT_END "*/"
+#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_NOINDEXONLYSCAN "NoIndexonlyScan"
+#define HINT_INDEXONLYSCAN "IndexOnlyScan"
+#define HINT_INDEXONLYSCANREGEXP "IndexOnlyScanRegexp"
+#define HINT_NOINDEXONLYSCAN "NoIndexOnlyScan"
#endif
#define HINT_NESTLOOP "NestLoop"
#define HINT_MERGEJOIN "MergeJoin"
#define HINT_LEADING "Leading"
#define HINT_SET "Set"
-
#define HINT_ARRAY_DEFAULT_INITSIZE 8
-#define parse_ereport(str, detail) \
+#define hint_ereport(str, detail) \
ereport(pg_hint_plan_parse_messages, \
(errmsg("hint syntax error at or near \"%s\"", (str)), \
errdetail detail))
enum
{
- ENABLE_SEQSCAN = 0x01,
- ENABLE_INDEXSCAN = 0x02,
- ENABLE_BITMAPSCAN = 0x04,
- ENABLE_TIDSCAN = 0x08,
- ENABLE_NESTLOOP = 0x10,
- ENABLE_MERGEJOIN = 0x20,
- ENABLE_HASHJOIN = 0x40
-} TYPE_BITS;
-
-#define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | ENABLE_BITMAPSCAN \
- | ENABLE_TIDSCAN)
+ ENABLE_SEQSCAN = 0x01,
+ ENABLE_INDEXSCAN = 0x02,
+ ENABLE_BITMAPSCAN = 0x04,
+ ENABLE_TIDSCAN = 0x08,
+#if PG_VERSION_NUM >= 90200
+ ENABLE_INDEXONLYSCAN = 0x10
+#endif
+} SCAN_TYPE_BITS;
+
+enum
+{
+ 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
+
+/* hint keyword of enum type*/
+typedef enum HintKeyword
+{
+ 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
+ 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 ScanHint
+typedef struct ScanMethodHint
{
- const char *opt_str; /* must not do pfree */
+ Hint base;
char *relname;
List *indexnames;
+ bool regexp;
unsigned char enforce_mask;
-} ScanHint;
+} 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 JoinHint
+typedef struct JoinMethodHint
{
- const char *opt_str; /* must not do pfree */
+ Hint base;
int nrels;
+ int inner_nrels;
char **relnames;
unsigned char enforce_mask;
Relids joinrelids;
-} JoinHint;
+ 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.
*/
-typedef struct PlanHint
+struct HintState
{
- char *hint_str; /* original hint string */
+ 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 */
- int nscan_hints; /* # of valid scan hints */
- int max_scan_hints; /* # of slots for scan hints */
- ScanHint **scan_hints; /* parsed scan 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 */
- int njoin_hints; /* # of valid join hints */
- int max_join_hints; /* # of slots for join hints */
- JoinHint **join_hints; /* parsed join hints */
+ JoinMethodHint **join_hints; /* parsed join hints */
+ int init_join_mask; /* initial value join parameter */
+ List **join_hint_level;
- int nlevel; /* # of relations to be joined */
- List **join_hint_level;
-
- /* for Leading hints */
- List *leading; /* relation names specified in Leading hint */
+ /* for Leading hint */
+ LeadingHint **leading_hint; /* parsed Leading hints */
/* for Set hints */
- GucContext context; /* which GUC parameters can we set? */
- List *set_hints; /* parsed Set hints */
-} PlanHint;
-
-typedef const char *(*HintParserFunction) (PlanHint *plan, Query *parse, char *keyword, const char *str);
+ 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;
- bool have_paren;
- HintParserFunction hint_parser;
+ char *keyword;
+ HintCreateFunction create_func;
+ HintKeyword hint_keyword;
} HintParser;
/* Module callbacks */
void _PG_init(void);
void _PG_fini(void);
-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 const char *ParseScanMethod(PlanHint *plan, Query *parse, char *keyword, const char *str);
-static const char *ParseJoinMethod(PlanHint *plan, Query *parse, char *keyword, const char *str);
-static const char *ParseLeading(PlanHint *plan, Query *parse, char *keyword, const char *str);
-static const char *ParseSet(PlanHint *plan, Query *parse, char *keyword, const char *str);
-#ifdef NOT_USED
-static const char *Ordered(PlanHint *plan, Query *parse, char *keyword, const char *str);
-#endif
+static void push_hint(HintState *hstate);
+static void pop_hint(void);
-RelOptInfo *standard_join_search_org(PlannerInfo *root, int levels_needed, List *initial_rels);
+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 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_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte);
+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 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 = true;
-static bool pg_hint_plan_debug_print = false;
-static int pg_hint_plan_parse_messages = INFO;
+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},
{"warning", WARNING, false},
{"error", ERROR, false},
/*
- {"fatal", FATAL, true},
- {"panic", PANIC, true},
+ * {"fatal", FATAL, true},
+ * {"panic", PANIC, true},
*/
{NULL, 0, false}
};
/* Saved hook values in case of unload */
-static planner_hook_type prev_planner_hook = NULL;
+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 PlanHint *global = NULL;
+/* Hold reference to currently active hint */
+static HintState *current_hint = NULL;
+
+/*
+ * 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, true, ParseScanMethod},
- {HINT_INDEXSCAN, true, ParseScanMethod},
- {HINT_BITMAPSCAN, true, ParseScanMethod},
- {HINT_TIDSCAN, true, ParseScanMethod},
- {HINT_NOSEQSCAN, true, ParseScanMethod},
- {HINT_NOINDEXSCAN, true, ParseScanMethod},
- {HINT_NOBITMAPSCAN, true, ParseScanMethod},
- {HINT_NOTIDSCAN, true, ParseScanMethod},
+ {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, true, ParseScanMethod},
- {HINT_NOINDEXONLYSCAN, true, ParseScanMethod},
+ {HINT_INDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXONLYSCAN},
+ {HINT_INDEXONLYSCANREGEXP, ScanMethodHintCreate,
+ HINT_KEYWORD_INDEXONLYSCANREGEXP},
+ {HINT_NOINDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXONLYSCAN},
#endif
- {HINT_NESTLOOP, true, ParseJoinMethod},
- {HINT_MERGEJOIN, true, ParseJoinMethod},
- {HINT_HASHJOIN, true, ParseJoinMethod},
- {HINT_NONESTLOOP, true, ParseJoinMethod},
- {HINT_NOMERGEJOIN, true, ParseJoinMethod},
- {HINT_NOHASHJOIN, true, ParseJoinMethod},
- {HINT_LEADING, true, ParseLeading},
- {HINT_SET, true, ParseSet},
- {NULL, false, NULL},
+ {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
*/
_PG_init(void)
{
/* Define custom GUC variables. */
- DefineCustomBoolVariable("pg_hint_plan.enable",
- "Instructions or hints to the planner using block comments.",
+ 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,
+ &pg_hint_plan_enable_hint,
true,
PGC_USERSET,
0,
NULL);
DefineCustomBoolVariable("pg_hint_plan.debug_print",
- "Logs each query's parse results of the hint.",
+ "Logs results of hint parsing.",
NULL,
&pg_hint_plan_debug_print,
false,
NULL);
DefineCustomEnumVariable("pg_hint_plan.parse_messages",
- "Messege level of the parse error.",
+ "Message level of parse errors.",
NULL,
&pg_hint_plan_parse_messages,
INFO,
NULL);
/* Install hooks. */
- prev_planner_hook = planner_hook;
+ 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;
}
/*
_PG_fini(void)
{
/* Uninstall hooks. */
- planner_hook = prev_planner_hook;
+ ProcessUtility_hook = prev_ProcessUtility;
+ planner_hook = prev_planner;
get_relation_info_hook = prev_get_relation_info;
join_search_hook = prev_join_search;
}
-static ScanHint *
-ScanHintCreate(void)
-{
- ScanHint *hint;
+/*
+ * create and delete functions the hint object
+ */
- hint = palloc(sizeof(ScanHint));
- hint->opt_str = NULL;
+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;
+ return (Hint *) hint;
}
static void
-ScanHintDelete(ScanHint *hint)
+ScanMethodHintDelete(ScanMethodHint *hint)
{
if (!hint)
return;
pfree(hint);
}
-static JoinHint *
-JoinHintCreate(void)
+static Hint *
+JoinMethodHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword)
{
- JoinHint *hint;
-
- hint = palloc(sizeof(JoinHint));
- hint->opt_str = NULL;
+ 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;
+ return (Hint *) hint;
}
static void
-JoinHintDelete(JoinHint *hint)
+JoinMethodHintDelete(JoinMethodHint *hint)
{
if (!hint)
return;
pfree(hint->relnames[i]);
pfree(hint->relnames);
}
+
bms_free(hint->joinrelids);
+ bms_free(hint->inner_joinrelids);
+ pfree(hint);
+}
+
+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;
+}
+
+static void
+LeadingHintDelete(LeadingHint *hint)
+{
+ if (!hint)
+ return;
+
+ list_free_deep(hint->relations);
+ if (hint->outer_inner)
+ pfree(hint->outer_inner);
pfree(hint);
}
-static SetHint *
-SetHintCreate(void)
+static Hint *
+SetHintCreate(const char *hint_str, const char *keyword,
+ HintKeyword hint_keyword)
{
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;
+ return (Hint *) hint;
}
static void
pfree(hint->name);
if (hint->value)
pfree(hint->value);
+ if (hint->words)
+ list_free(hint->words);
pfree(hint);
}
-static PlanHint *
-PlanHintCreate(void)
+static HintState *
+HintStateCreate(void)
{
- PlanHint *hint;
-
- hint = palloc(sizeof(PlanHint));
- hint->hint_str = NULL;
- hint->nscan_hints = 0;
- hint->max_scan_hints = 0;
- hint->scan_hints = NULL;
- hint->njoin_hints = 0;
- hint->max_join_hints = 0;
- hint->join_hints = NULL;
- hint->nlevel = 0;
- hint->join_hint_level = NULL;
- hint->leading = NIL;
- hint->context = superuser() ? PGC_SUSET : PGC_USERSET;
- hint->set_hints = NIL;
-
- return hint;
+ 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;
}
static void
-PlanHintDelete(PlanHint *hint)
+HintStateDelete(HintState *hstate)
{
- ListCell *l;
int i;
- if (!hint)
+ if (!hstate)
return;
- if (hint->hint_str)
- pfree(hint->hint_str);
+ if (hstate->hint_str)
+ pfree(hstate->hint_str);
- for (i = 0; i < hint->nscan_hints; i++)
- ScanHintDelete(hint->scan_hints[i]);
- if (hint->scan_hints)
- pfree(hint->scan_hints);
+ 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);
+}
- for (i = 0; i < hint->njoin_hints; i++)
- JoinHintDelete(hint->join_hints[i]);
- if (hint->join_hints)
- pfree(hint->join_hints);
+/*
+ * Copy given value into buf, with quoting with '"' if necessary.
+ */
+static void
+quote_value(StringInfo buf, const char *value)
+{
+ bool need_quote = false;
+ const char *str;
- for (i = 2; i <= hint->nlevel; i++)
- list_free(hint->join_hint_level[i]);
- if (hint->join_hint_level)
- pfree(hint->join_hint_level);
+ for (str = value; *str != '\0'; str++)
+ {
+ if (isspace(*str) || *str == '(' || *str == ')' || *str == '"')
+ {
+ need_quote = true;
+ appendStringInfoCharMacro(buf, '"');
+ break;
+ }
+ }
- list_free_deep(hint->leading);
+ for (str = value; *str != '\0'; str++)
+ {
+ if (*str == '"')
+ appendStringInfoCharMacro(buf, '"');
- foreach(l, hint->set_hints)
- SetHintDelete((SetHint *) lfirst(l));
- list_free(hint->set_hints);
+ appendStringInfoCharMacro(buf, *str);
+ }
- pfree(hint);
+ if (need_quote)
+ appendStringInfoCharMacro(buf, '"');
}
-static bool
-PlanHintIsempty(PlanHint *hint)
+static void
+ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf)
{
- if (hint->nscan_hints == 0 &&
- hint->njoin_hints == 0 &&
- hint->leading == NIL &&
- hint->set_hints == NIL)
- return true;
+ ListCell *l;
- return false;
+ appendStringInfo(buf, "%s(", hint->base.keyword);
+ if (hint->relname != NULL)
+ {
+ quote_value(buf, hint->relname);
+ foreach(l, hint->indexnames)
+ {
+ appendStringInfoCharMacro(buf, ' ');
+ quote_value(buf, (char *) lfirst(l));
+ }
+ }
+ appendStringInfoString(buf, ")\n");
}
-/* TODO オブジェクト名のクォート処理を追加 */
static void
-PlanHintDump(PlanHint *hint)
+JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf)
{
- StringInfoData buf;
- ListCell *l;
- int i;
- bool is_first = true;
+ int i;
- if (!hint)
+ appendStringInfo(buf, "%s(", hint->base.keyword);
+ if (hint->relnames != NULL)
{
- elog(LOG, "no hint");
- return;
+ quote_value(buf, hint->relnames[0]);
+ for (i = 1; i < hint->nrels; i++)
+ {
+ appendStringInfoCharMacro(buf, ' ');
+ quote_value(buf, hint->relnames[i]);
+ }
}
+ appendStringInfoString(buf, ")\n");
- initStringInfo(&buf);
- appendStringInfo(&buf, "/*\n");
- for (i = 0; i < hint->nscan_hints; i++)
+}
+
+static void
+OuterInnerDesc(OuterInnerRels *outer_inner, StringInfo buf)
+{
+ if (outer_inner->relation == NULL)
{
- ScanHint *h = hint->scan_hints[i];
- ListCell *n;
- switch(h->enforce_mask)
+ bool is_first;
+ ListCell *l;
+
+ is_first = true;
+
+ appendStringInfoCharMacro(buf, '(');
+ foreach(l, outer_inner->outer_inner_pair)
{
- case(ENABLE_SEQSCAN):
- appendStringInfo(&buf, "%s(", HINT_SEQSCAN);
- break;
- case(ENABLE_INDEXSCAN):
- appendStringInfo(&buf, "%s(", HINT_INDEXSCAN);
- break;
- case(ENABLE_BITMAPSCAN):
- appendStringInfo(&buf, "%s(", HINT_BITMAPSCAN);
- break;
- case(ENABLE_TIDSCAN):
- appendStringInfo(&buf, "%s(", HINT_TIDSCAN);
- break;
- case(ENABLE_INDEXSCAN | ENABLE_BITMAPSCAN | ENABLE_TIDSCAN):
- appendStringInfo(&buf, "%s(", HINT_NOSEQSCAN);
- break;
- case(ENABLE_SEQSCAN | ENABLE_BITMAPSCAN | ENABLE_TIDSCAN):
- appendStringInfo(&buf, "%s(", HINT_NOINDEXSCAN);
- break;
- case(ENABLE_SEQSCAN | ENABLE_INDEXSCAN | ENABLE_TIDSCAN):
- appendStringInfo(&buf, "%s(", HINT_NOBITMAPSCAN);
- break;
- case(ENABLE_SEQSCAN | ENABLE_INDEXSCAN | ENABLE_BITMAPSCAN):
- appendStringInfo(&buf, "%s(", HINT_NOTIDSCAN);
- break;
- default:
- appendStringInfoString(&buf, "\?\?\?(");
- break;
+ if (is_first)
+ is_first = false;
+ else
+ appendStringInfoCharMacro(buf, ' ');
+
+ OuterInnerDesc(lfirst(l), buf);
}
- appendStringInfo(&buf, "%s", h->relname);
- foreach(n, h->indexnames)
- appendStringInfo(&buf, " %s", (char *) lfirst(n));
- appendStringInfoString(&buf, ")\n");
+
+ appendStringInfoCharMacro(buf, ')');
}
+ else
+ quote_value(buf, outer_inner->relation);
+}
- for (i = 0; i < hint->njoin_hints; i++)
+static void
+LeadingHintDesc(LeadingHint *hint, StringInfo buf)
+{
+ appendStringInfo(buf, "%s(", HINT_LEADING);
+ if (hint->outer_inner == NULL)
{
- JoinHint *h = hint->join_hints[i];
- int i;
- switch(h->enforce_mask)
+ ListCell *l;
+ bool is_first;
+
+ is_first = true;
+
+ foreach(l, hint->relations)
{
- case(ENABLE_NESTLOOP):
- appendStringInfo(&buf, "%s(", HINT_NESTLOOP);
- break;
- case(ENABLE_MERGEJOIN):
- appendStringInfo(&buf, "%s(", HINT_MERGEJOIN);
- break;
- case(ENABLE_HASHJOIN):
- appendStringInfo(&buf, "%s(", HINT_HASHJOIN);
- break;
- case(ENABLE_ALL_JOIN ^ ENABLE_NESTLOOP):
- appendStringInfo(&buf, "%s(", HINT_NONESTLOOP);
- break;
- case(ENABLE_ALL_JOIN ^ ENABLE_MERGEJOIN):
- appendStringInfo(&buf, "%s(", HINT_NOMERGEJOIN);
- break;
- case(ENABLE_ALL_JOIN ^ ENABLE_HASHJOIN):
- appendStringInfo(&buf, "%s(", HINT_NOHASHJOIN);
- break;
- case(ENABLE_ALL_JOIN):
- continue;
- default:
- appendStringInfoString(&buf, "\?\?\?(");
- break;
+ if (is_first)
+ is_first = false;
+ else
+ appendStringInfoCharMacro(buf, ' ');
+
+ quote_value(buf, (char *) lfirst(l));
}
- appendStringInfo(&buf, "%s", h->relnames[0]);
- for (i = 1; i < h->nrels; i++)
- appendStringInfo(&buf, " %s", h->relnames[i]);
- appendStringInfoString(&buf, ")\n");
}
+ else
+ OuterInnerDesc(hint->outer_inner, buf);
- foreach(l, hint->set_hints)
- {
- SetHint *h = (SetHint *) lfirst(l);
- appendStringInfo(&buf, "%s(%s %s)\n", HINT_SET, h->name, h->value);
- }
+ appendStringInfoString(buf, ")\n");
+}
+
+static void
+SetHintDesc(SetHint *hint, StringInfo buf)
+{
+ bool is_first = true;
+ ListCell *l;
- foreach(l, hint->leading)
+ appendStringInfo(buf, "%s(", HINT_SET);
+ foreach(l, hint->words)
{
if (is_first)
- {
- appendStringInfo(&buf, "%s(%s", HINT_LEADING, (char *)lfirst(l));
is_first = false;
- }
else
- appendStringInfo(&buf, " %s", (char *)lfirst(l));
+ appendStringInfoCharMacro(buf, ' ');
+
+ quote_value(buf, (char *) lfirst(l));
+ }
+ appendStringInfo(buf, ")\n");
+}
+
+/*
+ * 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)
+{
+ int i;
+
+ appendStringInfo(buf, "%s:\n", title);
+ for (i = 0; i < hstate->nall_hints; i++)
+ {
+ if (hstate->all_hints[i]->state != state)
+ continue;
+
+ hstate->all_hints[i]->desc_func(hstate->all_hints[i], buf);
+ }
+}
+
+/*
+ * Dump contents of given hstate to server log with log level LOG.
+ */
+static void
+HintStateDump(HintState *hstate)
+{
+ StringInfoData buf;
+
+ if (!hstate)
+ {
+ elog(LOG, "pg_hint_plan:\nno hint");
+ return;
}
- if (!is_first)
- appendStringInfoString(&buf, ")\n");
- appendStringInfoString(&buf, "*/");
+ initStringInfo(&buf);
+
+ 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);
elog(LOG, "%s", buf.data);
pfree(buf.data);
}
+/*
+ * compare functions
+ */
+
static int
RelnameCmp(const void *a, const void *b)
{
}
static int
-ScanHintCmp(const void *a, const void *b, bool order)
+ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b)
{
- const ScanHint *hinta = *((const ScanHint **) a);
- const ScanHint *hintb = *((const ScanHint **) b);
- int result;
-
- if ((result = RelnameCmp(&hinta->relname, &hintb->relname)) != 0)
- return result;
-
- /* ヒント句で指定した順を返す */
- if (order)
- return hinta->opt_str - hintb->opt_str;
- else
- return 0;
+ return RelnameCmp(&a->relname, &b->relname);
}
static int
-ScanHintCmpIsOrder(const void *a, const void *b)
+JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b)
{
- return ScanHintCmp(a, b, true);
-}
+ int i;
-static int
-JoinHintCmp(const void *a, const void *b, bool order)
-{
- const JoinHint *hinta = *((const JoinHint **) a);
- const JoinHint *hintb = *((const JoinHint **) b);
+ if (a->nrels != b->nrels)
+ return a->nrels - b->nrels;
- if (hinta->nrels == hintb->nrels)
+ for (i = 0; i < a->nrels; i++)
{
- int i;
- for (i = 0; i < hinta->nrels; i++)
- {
- int result;
- if ((result = RelnameCmp(&hinta->relnames[i], &hintb->relnames[i])) != 0)
- return result;
- }
-
- /* ヒント句で指定した順を返す */
- if (order)
- return hinta->opt_str - hintb->opt_str;
- else
- return 0;
+ int result;
+ if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0)
+ return result;
}
- return hinta->nrels - hintb->nrels;
+ return 0;
}
static int
-JoinHintCmpIsOrder(const void *a, const void *b)
+LeadingHintCmp(const LeadingHint *a, const LeadingHint *b)
{
- return JoinHintCmp(a, b, true);
+ return 0;
}
-#if PG_VERSION_NUM < 90200
static int
-set_config_option_wrapper(const char *name, const char *value,
- GucContext context, GucSource source,
- GucAction action, bool changeVal, int elevel)
+SetHintCmp(const SetHint *a, const SetHint *b)
{
- int result = 0;
- MemoryContext ccxt = CurrentMemoryContext;
-
- PG_TRY();
- {
- result = set_config_option(name, value, context, source,
- action, changeVal);
- }
- PG_CATCH();
- {
- ErrorData *errdata;
- MemoryContext ecxt;
-
- if (elevel >= ERROR)
- PG_RE_THROW();
-
- ecxt = MemoryContextSwitchTo(ccxt);
- errdata = CopyErrorData();
- 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);
-
- MemoryContextSwitchTo(ecxt);
- }
- PG_END_TRY();
-
- return result;
+ return strcmp(a->name, b->name);
}
-#define set_config_option(name, value, context, source, \
- action, changeVal, elevel) \
- set_config_option_wrapper(name, value, context, source, \
- action, changeVal, elevel)
-#endif
-
static int
-set_config_options(List *options, GucContext context)
+HintCmp(const void *a, const void *b)
{
- ListCell *l;
- int save_nestlevel;
- int result = 1;
-
- save_nestlevel = NewGUCNestLevel();
-
- foreach(l, options)
- {
- SetHint *hint = (SetHint *) lfirst(l);
-
- if (result > 0)
- result = set_config_option(hint->name, hint->value, context,
- PGC_S_SESSION, GUC_ACTION_SAVE, true,
- pg_hint_plan_parse_messages);
- }
-
- return save_nestlevel;
+ 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);
}
-#define SET_CONFIG_OPTION(name, enforce_mask, type_bits) \
- set_config_option((name), \
- ((enforce_mask) & (type_bits)) ? "true" : "false", \
- context, PGC_S_SESSION, GUC_ACTION_SAVE, true, ERROR)
-
-static void
-set_join_config_options(unsigned char enforce_mask, GucContext context)
+/*
+ * Returns byte offset of hint b from hint a. If hint a was specified before
+ * b, positive value is returned.
+ */
+static int
+HintCmpWithPos(const void *a, const void *b)
{
- SET_CONFIG_OPTION("enable_nestloop", enforce_mask, ENABLE_NESTLOOP);
- SET_CONFIG_OPTION("enable_mergejoin", enforce_mask, ENABLE_MERGEJOIN);
- SET_CONFIG_OPTION("enable_hashjoin", enforce_mask, ENABLE_HASHJOIN);
-}
+ const Hint *hinta = *((const Hint **) a);
+ const Hint *hintb = *((const Hint **) b);
+ int result;
-static void
-set_scan_config_options(unsigned char enforce_mask, GucContext context)
-{
- SET_CONFIG_OPTION("enable_seqscan", enforce_mask, ENABLE_SEQSCAN);
- SET_CONFIG_OPTION("enable_indexscan", enforce_mask, ENABLE_INDEXSCAN);
- SET_CONFIG_OPTION("enable_bitmapscan", enforce_mask, ENABLE_BITMAPSCAN);
- SET_CONFIG_OPTION("enable_tidscan", enforce_mask, ENABLE_TIDSCAN);
-#if PG_VERSION_NUM >= 90200
- SET_CONFIG_OPTION("enable_indexonlyscan", enforce_mask, ENABLE_INDEXSCAN);
-#endif
+ result = HintCmp(a, b);
+ if (result == 0)
+ result = hinta->hint_str - hintb->hint_str;
+
+ return result;
}
/*
* parse functions
*/
-
static const char *
parse_keyword(const char *str, StringInfo buf)
{
skip_space(str);
while (!isspace(*str) && *str != '(' && *str != '\0')
- appendStringInfoChar(buf, *str++);
+ appendStringInfoCharMacro(buf, *str++);
return str;
}
static const char *
-skip_opened_parenthesis(const char *str)
+skip_parenthesis(const char *str, char parenthesis)
{
skip_space(str);
- if (*str != '(')
+ if (*str != parenthesis)
{
- parse_ereport(str, ("Opened parenthesis is necessary."));
- return NULL;
- }
-
- str++;
-
- return str;
-}
+ if (parenthesis == '(')
+ hint_ereport(str, ("Opening parenthesis is necessary."));
+ else if (parenthesis == ')')
+ hint_ereport(str, ("Closing parenthesis is necessary."));
-static const char *
-skip_closed_parenthesis(const char *str)
-{
- skip_space(str);
-
- if (*str != ')')
- {
- parse_ereport(str, ("Closed parenthesis is necessary."));
return NULL;
}
}
/*
- * 二重引用符で囲まれているかもしれないトークンを読み取り word 引数に palloc
- * で確保したバッファに格納してそのポインタを返す。
+ * 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.
*
- * 正常にパースできた場合は残りの文字列の先頭位置を、異常があった場合は NULL を
- * 返す。
+ * Parsed token is truncated within NAMEDATALEN-1 bytes, when truncate is true.
*/
static const char *
-parse_quote_value(const char *str, char **word, char *value_type)
+parse_quoted_value(const char *str, char **word, bool truncate)
{
StringInfoData buf;
bool in_quote;
- /* 先頭のスペースは読み飛ばす。 */
+ /* Skip leading spaces. */
skip_space(str);
initStringInfo(&buf);
{
if (in_quote)
{
- /* 二重引用符が閉じられていない場合はパース中断 */
+ /* Double quotation must be closed. */
if (*str == '\0')
{
pfree(buf.data);
- parse_ereport(str, ("Unterminated quoted %s.", value_type));
+ hint_ereport(str, ("Unterminated quoted string."));
return NULL;
}
/*
- * エスケープ対象のダブルクウォートをスキップする。
- * もしブロックコメントの開始文字列や終了文字列もオブジェクト名とし
- * て使用したい場合は、/ と * もエスケープ対象とすることで使用できる
- * が、処理対象としていない。もしテーブル名にこれらの文字が含まれる
- * 場合は、エイリアスを指定する必要がある。
+ * Skip escaped double quotation.
+ *
+ * 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.
*/
- if(*str == '"')
+ if (*str == '"')
{
str++;
if (*str != '"')
break;
}
}
- else
- if (isspace(*str) || *str == ')' || *str == '\0')
- break;
+ else if (isspace(*str) || *str == '(' || *str == ')' || *str == '"' ||
+ *str == '\0')
+ break;
appendStringInfoCharMacro(&buf, *str++);
}
if (buf.len == 0)
{
+ hint_ereport(str, ("Zero-length delimited string."));
+
pfree(buf.data);
- parse_ereport(str, ("%s is necessary.", value_type));
+
return NULL;
}
+ /* 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 *
-skip_option_delimiter(const char *str)
+parse_parentheses_Leading_in(const char *str, OuterInnerRels **outer_inner)
{
- const char *p = str;
+ List *outer_inner_pair = NIL;
+
+ if ((str = skip_parenthesis(str, '(')) == NULL)
+ return NULL;
skip_space(str);
- if (str == p)
+ /* 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)
{
- parse_ereport(str, ("Must be specified space."));
+ list_free(outer_inner_pair);
return NULL;
}
+ *outer_inner = OuterInnerRelsCreate(NULL, outer_inner_pair);
+
return str;
}
-static bool
-parse_hints(PlanHint *plan, Query *parse, const char *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;
for (parser = parsers; parser->keyword != NULL; parser++)
{
char *keyword = parser->keyword;
+ Hint *hint;
if (strcasecmp(buf.data, keyword) != 0)
continue;
- if (parser->have_paren)
+ 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)
{
- /* parser of each hint does parse in a parenthesis. */
- if ((str = skip_opened_parenthesis(str)) == NULL ||
- (str = parser->hint_parser(plan, parse, keyword, str)) == NULL ||
- (str = skip_closed_parenthesis(str)) == NULL)
- {
- pfree(buf.data);
- return false;
- }
+ hint->delete_func(hint);
+ pfree(buf.data);
+ return;
}
- else
- {
- if ((str = parser->hint_parser(plan, parse, keyword, str)) == NULL)
- {
- pfree(buf.data);
- return false;
- }
- /*
- * 直前のヒントに括弧の指定がなければ次のヒントの間に空白が必要
- */
- if (!isspace(*str) && *str == '\0')
- parse_ereport(str, ("Delimiter of the hint is necessary."));
+ /*
+ * 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)
{
- parse_ereport(head, ("Keyword \"%s\" does not exist.", buf.data));
+ hint_ereport(head,
+ ("Unrecognized hint keyword \"%s\".", buf.data));
pfree(buf.data);
- return false;
+ return;
}
}
pfree(buf.data);
-
- return true;
}
/*
* Do basic parsing of the query head comment.
*/
-static PlanHint *
+static HintState *
parse_head_comment(Query *parse)
{
- const char *p;
- char *head;
- char *tail;
- int len;
- int i;
- PlanHint *plan;
+ const char *p;
+ const char *hint_head;
+ char *head;
+ char *tail;
+ int len;
+ int i;
+ HintState *hstate;
/* get client-supplied query string. */
- p = debug_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. */
- len = strlen(HINT_START);
- skip_space(p);
- if (strncmp(p, HINT_START, len))
+ 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)
{
- parse_ereport(debug_query_string, ("unterminated /* comment"));
+ hint_ereport(head, ("Unterminated block comment."));
return NULL;
}
- /* 入れ子にしたブロックコメントはサポートしない */
- if ((head = strstr(p, HINT_START)) != NULL && head < tail)
- parse_ereport(head, ("block comments nest doesn't supported"));
+ /* 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;
- plan = PlanHintCreate();
- plan->hint_str = head;
+ hstate = HintStateCreate();
+ hstate->hint_str = head;
/* parse each hint. */
- if (!parse_hints(plan, parse, p))
- return plan;
+ parse_hints(hstate, parse, p);
- /* 重複したScan条件をを除外する */
- qsort(plan->scan_hints, plan->nscan_hints, sizeof(ScanHint *), ScanHintCmpIsOrder);
- for (i = 0; i < plan->nscan_hints - 1;)
+ /* When nothing specified a hint, we free HintState and returns NULL. */
+ if (hstate->nall_hints == 0)
{
- int result = ScanHintCmp(plan->scan_hints + i,
- plan->scan_hints + i + 1, false);
- if (result != 0)
- i++;
- else
- {
- /* 後で指定したヒントを有効にする */
- plan->nscan_hints--;
- memmove(plan->scan_hints + i, plan->scan_hints + i + 1,
- sizeof(ScanHint *) * (plan->nscan_hints - i));
- }
+ HintStateDelete(hstate);
+ return NULL;
}
- /* 重複したJoin条件をを除外する */
- qsort(plan->join_hints, plan->njoin_hints, sizeof(JoinHint *), JoinHintCmpIsOrder);
- for (i = 0; i < plan->njoin_hints - 1;)
+ /* 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++)
{
- int result = JoinHintCmp(plan->join_hints + i,
- plan->join_hints + i + 1, false);
- if (result != 0)
- i++;
- else
+ 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)
{
- /* 後で指定したヒントを有効にする */
- plan->njoin_hints--;
- memmove(plan->join_hints + i, plan->join_hints + i + 1,
- sizeof(JoinHint *) * (plan->njoin_hints - i));
+ hint_ereport(cur_hint->hint_str,
+ ("Conflict %s hint.", HintTypeName[cur_hint->type]));
+ cur_hint->state = HINT_STATE_DUPLICATION;
}
}
- return plan;
+ /*
+ * 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 *
-ParseScanMethod(PlanHint *plan, Query *parse, char *keyword, const char *str)
+ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse,
+ const char *str)
{
- ScanHint *hint;
+ const char *keyword = hint->base.keyword;
+ HintKeyword hint_keyword = hint->base.hint_keyword;
+ List *name_list = NIL;
+ int length;
- hint = ScanHintCreate();
- hint->opt_str = str;
+ if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
+ return NULL;
- /*
- * スキャン方式のヒントでリレーション名が読み取れない場合はヒント無効
- */
- if ((str = parse_quote_value(str, &hint->relname, "ralation name")) == NULL)
+ /* Parse relation name and index name(s) if given hint accepts. */
+ length = list_length(name_list);
+ if (length > 0)
{
- ScanHintDelete(hint);
- return NULL;
- }
- skip_space(str);
+ hint->relname = linitial(name_list);
+ hint->indexnames = list_delete_first(name_list);
- /*
- * インデックスリストを受け付けるヒントであれば、インデックス参照をパース
- * する。
- */
- if (strcmp(keyword, HINT_INDEXSCAN) == 0 ||
+ /* 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
- strcmp(keyword, HINT_INDEXONLYSCAN) == 0 ||
+ hint_keyword != HINT_KEYWORD_INDEXONLYSCAN &&
+ hint_keyword != HINT_KEYWORD_INDEXONLYSCANREGEXP &&
#endif
- strcmp(keyword, HINT_BITMAPSCAN) == 0)
- {
- while (*str != ')' && *str != '\0')
+ hint_keyword != HINT_KEYWORD_BITMAPSCAN &&
+ hint_keyword != HINT_KEYWORD_BITMAPSCANREGEXP)
{
- char *indexname;
-
- str = parse_quote_value(str, &indexname, "index name");
- if (str == NULL)
- {
- ScanHintDelete(hint);
- return NULL;
- }
-
- hint->indexnames = lappend(hint->indexnames, indexname);
- skip_space(str);
+ hint_ereport(str,
+ ("%s hint accepts only one relation.",
+ hint->base.keyword));
+ hint->base.state = HINT_STATE_ERROR;
+ return str;
}
}
-
- /* カッコが閉じていなければヒント無効。 */
- skip_space(str); /* just in case */
- if (*str != ')')
- {
- parse_ereport(str, ("Closed parenthesis is necessary."));
- ScanHintDelete(hint);
- return NULL;
- }
-
- /*
- * ヒントごとに決まっている許容スキャン方式をビットマスクとして設定
- */
- if (strcasecmp(keyword, HINT_SEQSCAN) == 0)
- hint->enforce_mask = ENABLE_SEQSCAN;
- else if (strcasecmp(keyword, HINT_INDEXSCAN) == 0)
- hint->enforce_mask = ENABLE_INDEXSCAN;
- else if (strcasecmp(keyword, HINT_BITMAPSCAN) == 0)
- hint->enforce_mask = ENABLE_BITMAPSCAN;
- else if (strcasecmp(keyword, HINT_TIDSCAN) == 0)
- hint->enforce_mask = ENABLE_TIDSCAN;
- else if (strcasecmp(keyword, HINT_NOSEQSCAN) == 0)
- hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_SEQSCAN;
- else if (strcasecmp(keyword, HINT_NOINDEXSCAN) == 0)
- hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXSCAN;
- else if (strcasecmp(keyword, HINT_NOBITMAPSCAN) == 0)
- hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_BITMAPSCAN;
- else if (strcasecmp(keyword, HINT_NOTIDSCAN) == 0)
- hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_TIDSCAN;
else
{
- ScanHintDelete(hint);
- parse_ereport(str, ("unrecognized hint keyword \"%s\"", keyword));
- return NULL;
+ hint_ereport(str,
+ ("%s hint requires a relation.",
+ hint->base.keyword));
+ hint->base.state = HINT_STATE_ERROR;
+ return str;
}
- /*
- * 出来上がったヒント情報を追加。スロットが足りない場合は二倍に拡張する。
- */
- if (plan->nscan_hints == 0)
- {
- plan->max_scan_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->scan_hints = palloc(sizeof(ScanHint *) * plan->max_scan_hints);
- }
- else if (plan->nscan_hints == plan->max_scan_hints)
+ /* Set a bit for specified hint. */
+ switch (hint_keyword)
{
- plan->max_scan_hints *= 2;
- plan->scan_hints = repalloc(plan->scan_hints,
- sizeof(ScanHint *) * plan->max_scan_hints);
+ 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;
}
- plan->scan_hints[plan->nscan_hints] = hint;
- plan->nscan_hints++;
return str;
}
static const char *
-ParseJoinMethod(PlanHint *plan, Query *parse, char *keyword, const char *str)
+JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate, Query *parse,
+ const char *str)
{
- char *relname;
- JoinHint *hint;
+ const char *keyword = hint->base.keyword;
+ HintKeyword hint_keyword = hint->base.hint_keyword;
+ List *name_list = NIL;
- skip_space(str);
+ if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
+ return NULL;
- hint = JoinHintCreate();
- hint->opt_str = str;
- hint->relnames = palloc(sizeof(char *));
+ hint->nrels = list_length(name_list);
- while ((str = parse_quote_value(str, &relname, "table name")) != NULL)
+ if (hint->nrels > 0)
{
- hint->nrels++;
- hint->relnames = repalloc(hint->relnames, sizeof(char *) * hint->nrels);
- hint->relnames[hint->nrels - 1] = relname;
-
- skip_space(str);
- if (*str == ')')
- break;
+ 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++;
+ }
}
- if (str == NULL)
- {
- JoinHintDelete(hint);
- return NULL;
- }
+ list_free(name_list);
- /* Join 対象のテーブルは最低でも2つ指定する必要がある */
+ /* A join hint requires at least two relations */
if (hint->nrels < 2)
{
- JoinHintDelete(hint);
- parse_ereport(str, ("Specified relation more than two."));
- return NULL;
+ 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);
- if (strcasecmp(keyword, HINT_NESTLOOP) == 0)
- hint->enforce_mask = ENABLE_NESTLOOP;
- else if (strcasecmp(keyword, HINT_MERGEJOIN) == 0)
- hint->enforce_mask = ENABLE_MERGEJOIN;
- else if (strcasecmp(keyword, HINT_HASHJOIN) == 0)
- hint->enforce_mask = ENABLE_HASHJOIN;
- else if (strcasecmp(keyword, HINT_NONESTLOOP) == 0)
- hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_NESTLOOP;
- else if (strcasecmp(keyword, HINT_NOMERGEJOIN) == 0)
- hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_MERGEJOIN;
- else if (strcasecmp(keyword, HINT_NOHASHJOIN) == 0)
- hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_HASHJOIN;
- else
+ switch (hint_keyword)
{
- JoinHintDelete(hint);
- parse_ereport(str, ("unrecognized hint keyword \"%s\"", keyword));
- return NULL;
+ 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;
}
- if (plan->njoin_hints == 0)
+ return str;
+}
+
+static bool
+OuterInnerPairCheck(OuterInnerRels *outer_inner)
+{
+ ListCell *l;
+ if (outer_inner->outer_inner_pair == NIL)
{
- plan->max_join_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->join_hints = palloc(sizeof(JoinHint *) * plan->max_join_hints);
+ if (outer_inner->relation)
+ return true;
+ else
+ return false;
}
- else if (plan->njoin_hints == plan->max_join_hints)
+
+ if (list_length(outer_inner->outer_inner_pair) == 2)
{
- plan->max_join_hints *= 2;
- plan->join_hints = repalloc(plan->join_hints,
- sizeof(JoinHint *) * plan->max_join_hints);
+ foreach(l, outer_inner->outer_inner_pair)
+ {
+ if (!OuterInnerPairCheck(lfirst(l)))
+ return false;
+ }
}
+ else
+ return false;
+
+ return true;
+}
- plan->join_hints[plan->njoin_hints] = hint;
- plan->njoin_hints++;
+static List *
+OuterInnerList(OuterInnerRels *outer_inner)
+{
+ List *outer_inner_list = NIL;
+ ListCell *l;
+ OuterInnerRels *outer_inner_rels;
- return str;
+ 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 *
-ParseLeading(PlanHint *plan, Query *parse, char *keyword, const char *str)
+LeadingHintParse(LeadingHint *hint, HintState *hstate, Query *parse,
+ const char *str)
{
- char *relname;
+ List *name_list = NIL;
+ OuterInnerRels *outer_inner = NULL;
- /*
- * すでに指定済みの場合は、後で指定したヒントが有効にするため、登録済みの
- * 情報を削除する
- */
- list_free_deep(plan->leading);
- plan->leading = NIL;
-
- while ((str = parse_quote_value(str, &relname, "relation name")) != NULL)
- {
- const char *p;
+ if ((str = parse_parentheses_Leading(str, &name_list, &outer_inner)) ==
+ NULL)
+ return NULL;
- plan->leading = lappend(plan->leading, relname);
+ if (outer_inner != NULL)
+ name_list = OuterInnerList(outer_inner);
- p = str;
- skip_space(str);
- if (*str == ')')
- break;
+ hint->relations = name_list;
+ hint->outer_inner = outer_inner;
- if (p == str)
- {
- parse_ereport(str, ("Must be specified space."));
- break;
- }
+ /* 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;
}
-
- /* テーブル指定が1つのみの場合は、ヒントを無効にし、パースを続ける */
- if (list_length(plan->leading) == 1)
+ else if (hint->outer_inner != NULL &&
+ !OuterInnerPairCheck(hint->outer_inner))
{
- parse_ereport(str, ("In %s hint, specified relation name 2 or more.", HINT_LEADING));
- list_free_deep(plan->leading);
- plan->leading = NIL;
+ 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 *
-ParseSet(PlanHint *plan, Query *parse, char *keyword, const char *str)
+SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str)
{
- SetHint *hint;
+ List *name_list = NIL;
+
+ if ((str = parse_parentheses(str, &name_list, hint->base.hint_keyword))
+ == NULL)
+ return NULL;
- hint = SetHintCreate();
+ hint->words = name_list;
- if ((str = parse_quote_value(str, &hint->name, "parameter name")) == NULL ||
- (str = skip_option_delimiter(str)) == NULL ||
- (str = parse_quote_value(str, &hint->value, "parameter value")) == NULL)
+ /* We need both name and value to set GUC parameter. */
+ if (list_length(name_list) == 2)
{
- SetHintDelete(hint);
- return NULL;
+ hint->name = linitial(name_list);
+ hint->value = lsecond(name_list);
}
-
- skip_space(str);
- if (*str != ')')
+ else
{
- parse_ereport(str, ("Closed parenthesis is necessary."));
- SetHintDelete(hint);
- return NULL;
+ hint_ereport(hint->base.hint_str,
+ ("%s hint requires name and value of GUC parameter.",
+ HINT_SET));
+ hint->base.state = HINT_STATE_ERROR;
}
- plan->set_hints = lappend(plan->set_hints, hint);
return str;
}
-#ifdef NOT_USED
/*
- * Oracle の ORDERD ヒントの実装
+ * set GUC parameter functions
*/
-static const char *
-Ordered(PlanHint *plan, Query *parse, char *keyword, const char *str)
-{
- SetHint *hint;
-
- hint = SetHintCreate();
- hint->name = pstrdup("join_collapse_limit");
- hint->value = pstrdup("1");
- plan->set_hints = lappend(plan->set_hints, hint);
- return str;
-}
-#endif
-
-static PlannedStmt *
-pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams)
+static int
+set_config_option_wrapper(const char *name, const char *value,
+ GucContext context, GucSource source,
+ GucAction action, bool changeVal, int elevel)
{
- int save_nestlevel;
- PlannedStmt *result;
+ int result = 0;
+ MemoryContext ccxt = CurrentMemoryContext;
- /*
- * hintが指定されない、または空のhintを指定された場合は通常のparser処理をお
- * こなう。
- * 他のフック関数で実行されるhint処理をスキップするために、global 変数をNULL
- * に設定しておく。
- */
- if (!pg_hint_plan_enable ||
- (global = parse_head_comment(parse)) == NULL ||
- PlanHintIsempty(global))
+ PG_TRY();
{
- PlanHintDelete(global);
- global = NULL;
-
- if (prev_planner_hook)
- return (*prev_planner_hook) (parse, cursorOptions, boundParams);
+#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
- return standard_planner(parse, cursorOptions, boundParams);
+ hint->base.state = HINT_STATE_ERROR;
}
- /* Set hint で指定されたGUCパラメータを設定する */
- save_nestlevel = set_config_options(global->set_hints, global->context);
+ return save_nestlevel;
+}
- if (global->leading != NIL)
- set_join_config_options(0, global->context);
+#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;
+ }
/*
- * TODO ビュー定義で指定したテーブル数が1つの場合にもこのタイミングでGUCを変更する必
- * 要がある。
+ * 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 (list_length(parse->rtable) == 1 &&
- ((RangeTblEntry *) linitial(parse->rtable))->rtekind == RTE_RELATION)
+ if (IsA(node, ExecuteStmt))
{
- int i;
- RangeTblEntry *rte = linitial(parse->rtable);
-
- for (i = 0; i < global->nscan_hints; i++)
- {
- ScanHint *hint = global->scan_hints[i];
+ 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;
- if (RelnameCmp(&rte->eref->aliasname, &hint->relname) != 0)
- parse_ereport(hint->opt_str, ("Relation \"%s\" does not exist.", hint->relname));
+ stmt = (CreateTableAsStmt *) node;
+ Assert(IsA(stmt->query, Query));
+ query = (Query *) stmt->query;
- set_scan_config_options(hint->enforce_mask, global->context);
+ 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_planner_hook)
- result = (*prev_planner_hook) (parse, cursorOptions, boundParams);
+ if (prev_ProcessUtility)
+ (*prev_ProcessUtility) (parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
else
- result = standard_planner(parse, cursorOptions, boundParams);
+ 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");
/*
- * Restore the GUC variables we set above.
+ * 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).
*/
- AtEOXact_GUC(true, save_nestlevel);
+ HintStateStack = list_delete_first(HintStateStack);
+ HintStateDelete(current_hint);
+ if(HintStateStack == NIL)
+ current_hint = NULL;
+ else
+ current_hint = (HintState *) lfirst(list_head(HintStateStack));
+}
- if (pg_hint_plan_debug_print)
+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)
{
- PlanHintDump(global);
-#ifdef NOT_USED
- elog_node_display(INFO, "rtable", parse->rtable, true);
+ 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();
- PlanHintDelete(global);
- global = NULL;
+ /* 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;
}
/*
- * aliasnameと一致するSCANヒントを探す
+ * Return scan method hint which matches given aliasname.
*/
-static ScanHint *
-find_scan_hint(RangeTblEntry *rte)
+static ScanMethodHint *
+find_scan_hint(PlannerInfo *root, RelOptInfo *rel)
{
- int i;
+ 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;
- for (i = 0; i < global->nscan_hints; i++)
+ /* Find scan method hint, which matches given names, from the list. */
+ for (i = 0; i < current_hint->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
{
- ScanHint *hint = global->scan_hints[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;
}
-static void
-pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
- bool inhparent, RelOptInfo *rel)
+/*
+ * 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)
{
- ScanHint *hint;
- ListCell *cell;
- ListCell *prev;
- ListCell *next;
-
- if (prev_get_relation_info)
- (*prev_get_relation_info) (root, relationObjectId, inhparent, rel);
-
- /* 有効なヒントが指定されなかった場合は処理をスキップする。 */
- if (!global)
- return;
-
- if (rel->reloptkind != RELOPT_BASEREL)
- return;
+ 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);
+}
- if ((hint = find_scan_hint(root->simple_rte_array[rel->relid])) == NULL)
- return;
+static void
+delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId)
+{
+ ListCell *cell;
+ ListCell *prev;
+ ListCell *next;
+ StringInfoData buf;
- /* インデックスを全て削除し、スキャンに使えなくする */
- if (hint->enforce_mask == ENABLE_SEQSCAN)
+ /*
+ * 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;
}
- /* 後でパスを作り直すため、ここではなにもしない */
- if (hint->indexnames == NULL)
+ /*
+ * 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);
foreach(l, hint->indexnames)
{
- if (RelnameCmp(&indexname, &lfirst(l)) == 0)
+ 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;
}
}
else
prev = cell;
- pfree(indexname);
+ 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;
+
+ 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);
}
-static Index
-scan_relid_aliasname(PlannerInfo *root, char *aliasname, bool check_ambiguous, const char *str)
+/*
+ * 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)
{
- /* TODO refnameRangeTblEntry を参考 */
int i;
- Index find = 0;
+ 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)
+ if (RelnameCmp(&aliasname,
+ &root->simple_rte_array[i]->eref->aliasname) != 0)
continue;
- if (!check_ambiguous)
- return i;
+ 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;
+ }
- if (find)
- parse_ereport(str, ("relation name \"%s\" is ambiguous", aliasname));
+ found = i;
+ break;
+ }
- find = i;
}
- return find;
+ return found;
}
/*
- * relidビットマスクと一致するヒントを探す
+ * Return join hint which matches given joinrelids.
*/
-static JoinHint *
-scan_join_hint(Relids joinrelids)
+static JoinMethodHint *
+find_join_hint(Relids joinrelids)
{
List *join_hint;
ListCell *l;
- join_hint = global->join_hint_level[bms_num_members(joinrelids)];
+ join_hint = current_hint->join_hint_level[bms_num_members(joinrelids)];
+
foreach(l, join_hint)
{
- JoinHint *hint = (JoinHint *) lfirst(l);
+ 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 void
-rebuild_join_hints(PlanHint *plan, PlannerInfo *root, int level, List *initial_rels)
+static bool
+transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel,
+ List *initial_rels, JoinMethodHint **join_method_hints)
{
- int i;
- ListCell *l;
- Relids joinrelids;
- int njoinrels;
+ int i;
+ int relid;
+ Relids joinrelids;
+ int njoinrels;
+ ListCell *l;
+ char *relname;
+ LeadingHint *lhint = NULL;
- plan->nlevel = root->simple_rel_array_size - 1;
- plan->join_hint_level = palloc0(sizeof(List *) * (root->simple_rel_array_size));
- for (i = 0; i < plan->njoin_hints; i++)
+ /*
+ * 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++)
{
- JoinHint *hint = plan->join_hints[i];
- int j;
- Index relid = 0;
+ 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++)
{
- char *relname = hint->relnames[j];
+ relname = hint->relnames[j];
+
+ relid = find_relid_aliasname(root, relname, initial_rels,
+ hint->base.hint_str);
- relid = scan_relid_aliasname(root, relname, true, hint->opt_str);
- if (relid == 0)
+ if (relid == -1)
+ hint->base.state = HINT_STATE_ERROR;
+
+ if (relid <= 0)
+ break;
+
+ if (bms_is_member(relid, hint->joinrelids))
{
- parse_ereport(hint->opt_str, ("Relation \"%s\" does not exist.", relname));
+ hint_ereport(hint->base.hint_str,
+ ("Relation name \"%s\" is duplicated.", relname));
+ hint->base.state = HINT_STATE_ERROR;
break;
}
hint->joinrelids = bms_add_member(hint->joinrelids, relid);
}
- if (relid == 0)
+ if (relid <= 0 || hint->base.state == HINT_STATE_ERROR)
continue;
- plan->join_hint_level[hint->nrels] =
- lappend(plan->join_hint_level[hint->nrels], hint);
+ hstate->join_hint_level[hint->nrels] =
+ lappend(hstate->join_hint_level[hint->nrels], hint);
}
- /* Leading hint は、全ての join 方式が有効な hint として登録する */
- joinrelids = NULL;
- njoinrels = 0;
- foreach(l, plan->leading)
+ /* 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++)
{
- char *relname = (char *)lfirst(l);
- JoinHint *hint;
+ LeadingHint *leading_hint = (LeadingHint *)hstate->leading_hint[i];
+ Relids relids;
+
+ if (leading_hint->base.state == HINT_STATE_ERROR)
+ continue;
+
+ relid = 0;
+ relids = NULL;
- i = scan_relid_aliasname(root, relname, true, plan->hint_str);
- if (i == 0)
+ foreach(l, leading_hint->relations)
{
- parse_ereport(plan->hint_str, ("Relation \"%s\" does not exist.", relname));
- list_free_deep(plan->leading);
- plan->leading = NIL;
- break;
- }
+ relname = (char *)lfirst(l);;
- joinrelids = bms_add_member(joinrelids, i);
- njoinrels++;
+ relid = find_relid_aliasname(root, relname, initial_rels,
+ leading_hint->base.hint_str);
+ if (relid == -1)
+ leading_hint->base.state = HINT_STATE_ERROR;
- if (njoinrels < 2)
+ 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 (njoinrels > plan->nlevel)
+ if (lhint != NULL)
{
- parse_ereport(plan->hint_str, ("In %s hint, specified relation name %d or less.", HINT_LEADING, plan->nlevel));
- break;
+ 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;
+ }
- /* Leading で指定した組み合わせ以外の join hint を削除する */
- hint = scan_join_hint(joinrelids);
- list_free(plan->join_hint_level[njoinrels]);
- if (hint)
- plan->join_hint_level[njoinrels] = lappend(NIL, hint);
- else
+ /* check to exist Leading hint marked with 'used'. */
+ if (lhint == NULL)
+ return false;
+
+ /*
+ * 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)
+ *
+ * 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.
+ */
+ joinrelids = NULL;
+ njoinrels = 0;
+ if (lhint->outer_inner == NULL)
+ {
+ foreach(l, lhint->relations)
{
+ JoinMethodHint *hint;
+
+ relname = (char *)lfirst(l);
+
/*
- * Here relnames is not set, since Relids bitmap is sufficient to
- * control paths of this query afterwards.
+ * 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.
*/
- hint = JoinHintCreate();
- hint->nrels = njoinrels;
- hint->enforce_mask = ENABLE_ALL_JOIN;
- hint->joinrelids = bms_copy(joinrelids);
- plan->join_hint_level[njoinrels] = lappend(NIL, hint);
+ relid = find_relid_aliasname(root, relname, initial_rels,
+ hstate->hint_str);
- if (plan->njoin_hints == 0)
+ /* 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)
{
- plan->max_join_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->join_hints = palloc(sizeof(JoinHint *) * plan->max_join_hints);
+ /*
+ * 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);
}
- else if (plan->njoin_hints == plan->max_join_hints)
+
+ 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);
+
+ /*
+ * Delete all join hints which have different combination from Leading
+ * hint.
+ */
+ for (i = 2;i <= njoinrels; i++)
+ {
+ if (hstate->join_hint_level[i] != NIL)
{
- plan->max_join_hints *= 2;
- plan->join_hints = repalloc(plan->join_hints,
- sizeof(JoinHint *) * plan->max_join_hints);
- }
+ ListCell *prev = NULL;
+ ListCell *next = NULL;
+ for(l = list_head(hstate->join_hint_level[i]); l; l = next)
+ {
- plan->join_hints[plan->njoin_hints] = hint;
- plan->njoin_hints++;
+ JoinMethodHint *hint = (JoinMethodHint *)lfirst(l);
+
+ 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;
+ }
+ }
}
+
+ bms_free(joinrelids);
}
- bms_free(joinrelids);
+ if (hint_state_enabled(lhint))
+ {
+ set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
+ return true;
+ }
+ return false;
}
+/*
+ * set_plain_rel_pathlist
+ * Build access paths for a plain relation (no subquery, no inheritance)
+ *
+ * This function was copied and edited from set_plain_rel_pathlist() in
+ * src/backend/optimizer/path/allpaths.c
+ */
static void
-rebuild_scan_path(PlanHint *plan, PlannerInfo *root, int level, List *initial_rels)
+set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
{
- int i;
- int save_nestlevel = 0;
+ /* 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);
- for (i = 0; i < plan->nscan_hints; i++)
+ /* 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;
+
+ foreach(l, initial_rels)
{
- ScanHint *hint = plan->scan_hints[i];
- ListCell *l;
+ RelOptInfo *rel = (RelOptInfo *) lfirst(l);
+ RangeTblEntry *rte;
+ ScanMethodHint *hint;
- if (hint->enforce_mask == ENABLE_SEQSCAN)
+ /* Skip relations which we can't choose scan method. */
+ if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
continue;
- foreach(l, initial_rels)
- {
- RelOptInfo *rel = (RelOptInfo *) lfirst(l);
- RangeTblEntry *rte = root->simple_rte_array[rel->relid];
-
- /*
- * スキャン方式が選択できるリレーションのみ、スキャンパスを再生成
- * する。
- */
- if (rel->reloptkind != RELOPT_BASEREL ||
- rte->rtekind == RTE_VALUES ||
- RelnameCmp(&hint->relname, &rte->eref->aliasname) != 0)
- continue;
+ rte = root->simple_rte_array[rel->relid];
- /*
- * 複数のスキャンヒントが指定されていた場合でも、1つのネストレベルで
- * スキャン関連のGUCパラメータを変更する。
- */
- if (save_nestlevel == 0)
- save_nestlevel = NewGUCNestLevel();
+ /* We can't force scan method of foreign tables */
+ if (rte->relkind == RELKIND_FOREIGN_TABLE)
+ continue;
- /*
- * TODO ヒントで指定されたScan方式が最安価でない場合のみ、Pathを生成
- * しなおす
- */
- set_scan_config_options(hint->enforce_mask, plan->context);
+ /*
+ * 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;
+ }
- rel->pathlist = NIL; /* TODO 解放 */
+ 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
+ {
set_plain_rel_pathlist(root, rel, rte);
-
- break;
}
}
/*
* Restore the GUC variables we set above.
*/
- if (save_nestlevel != 0)
- AtEOXact_GUC(true, save_nestlevel);
+ set_scan_config_options(hstate->init_scan_mask, hstate->context);
}
/*
- * src/backend/optimizer/path/joinrels.c
- * export make_join_rel() をラップする関数
- *
- * ヒントにしたがって、enabele_* パラメータを変更した上で、make_join_rel()を
- * 呼び出す。
+ * wrapper of make_join_rel()
+ *
+ * call make_join_rel() after changing enable_* parameters according to given
+ * hints.
*/
static RelOptInfo *
-pg_hint_plan_make_join_rel(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
+make_join_rel_wrapper(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
{
Relids joinrelids;
- JoinHint *hint;
+ JoinMethodHint *hint;
RelOptInfo *rel;
int save_nestlevel;
joinrelids = bms_union(rel1->relids, rel2->relids);
- hint = scan_join_hint(joinrelids);
+ hint = find_join_hint(joinrelids);
bms_free(joinrelids);
if (!hint)
- return make_join_rel(root, rel1, rel2);
+ return pg_hint_plan_make_join_rel(root, rel1, rel2);
- save_nestlevel = NewGUCNestLevel();
+ if (hint->inner_nrels == 0)
+ {
+ save_nestlevel = NewGUCNestLevel();
- set_join_config_options(hint->enforce_mask, global->context);
+ set_join_config_options(hint->enforce_mask, current_hint->context);
- rel = make_join_rel(root, rel1, rel2);
+ 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);
+ /*
+ * 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;
}
+/*
+ * TODO : comment
+ */
+static void
+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;
+
+ foreach(l, initial_rels)
+ {
+ RelOptInfo *rel = (RelOptInfo *) lfirst(l);
+
+ if (rel->reloptkind == RELOPT_BASEREL)
+ nbaserel++;
+ else if (rel->reloptkind ==RELOPT_JOINREL)
+ nbaserel+= bms_num_members(rel->relids);
+ else
+ {
+ /* 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)
+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;
+
/*
- * pg_hint_planが無効、または有効なヒントが1つも指定されなかった場合は、標準
- * の処理を行う。
+ * Use standard planner (or geqo planner) if pg_hint_plan is disabled or no
+ * valid hint is supplied.
*/
- if (!global)
+ if (!current_hint)
{
if (prev_join_search)
return (*prev_join_search) (root, levels_needed, initial_rels);
return standard_join_search(root, levels_needed, initial_rels);
}
- rebuild_join_hints(global, root, levels_needed, initial_rels);
- rebuild_scan_path(global, root, levels_needed, initial_rels);
+ /* We apply scan method hint rebuild scan path. */
+ rebuild_scan_path(current_hint, root, levels_needed, initial_rels);
/*
- * GEQOを使用する条件を満たした場合は、GEQOを用いた結合方式の検索を行う。
- * このとき、スキャン方式のヒントとSetヒントのみが有効になり、結合方式や結合
- * 順序はヒント句は無効になりGEQOのアルゴリズムで決定される。
+ * 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);
- return standard_join_search_org(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;
+}
+
+/*
+ * set_rel_pathlist
+ * Build access paths for a base relation
+ *
+ * This function was copied and edited from set_rel_pathlist() in
+ * src/backend/optimizer/path/allpaths.c
+ */
+static void
+set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
+ Index rti, RangeTblEntry *rte)
+{
+#if PG_VERSION_NUM >= 90200
+ if (IS_DUMMY_REL(rel))
+ {
+ /* 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);
+ }
+}
+
+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;
+}
+
+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;
+ }
+}
+
+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 standard_join_search_org
+#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 pg_hint_plan_make_join_rel
+#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
