*
* 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
*
*-------------------------------------------------------------------------
*/
#include "postgres.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/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/lsyscache.h"
+#include "utils/memutils.h"
+#if PG_VERSION_NUM >= 90200
+#include "catalog/pg_class.h"
+#endif
#ifdef PG_MODULE_MAGIC
PG_MODULE_MAGIC;
#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
+#define HINT_START BLOCK_COMMENT_START HINT_COMMENT_KEYWORD
+#define HINT_END BLOCK_COMMENT_END
/* hint keywords */
#define HINT_SEQSCAN "SeqScan"
#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_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) \
enum
{
- ENABLE_SEQSCAN = 0x01,
- ENABLE_INDEXSCAN = 0x02,
- ENABLE_BITMAPSCAN = 0x04,
- ENABLE_TIDSCAN = 0x08,
+ ENABLE_SEQSCAN = 0x01,
+ ENABLE_INDEXSCAN = 0x02,
+ ENABLE_BITMAPSCAN = 0x04,
+ ENABLE_TIDSCAN = 0x08,
#if PG_VERSION_NUM >= 90200
- ENABLE_INDEXONLYSCAN = 0x10,
+ ENABLE_INDEXONLYSCAN = 0x10
#endif
- ENABLE_NESTLOOP = 0x20,
- ENABLE_MERGEJOIN = 0x40,
- ENABLE_HASHJOIN = 0x80
-} TYPE_BITS;
+} SCAN_TYPE_BITS;
+
+enum
+{
+ ENABLE_NESTLOOP = 0x01,
+ ENABLE_MERGEJOIN = 0x02,
+ ENABLE_HASHJOIN = 0x04
+} JOIN_TYPE_BITS;
-#define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | ENABLE_BITMAPSCAN \
- | ENABLE_TIDSCAN)
#if PG_VERSION_NUM >= 90200
-#define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | ENABLE_BITMAPSCAN \
- | ENABLE_TIDSCAN | ENABLE_INDEXONLYSCAN)
+#define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
+ ENABLE_BITMAPSCAN | ENABLE_TIDSCAN | \
+ ENABLE_INDEXONLYSCAN)
+#else
+#define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
+ ENABLE_BITMAPSCAN | ENABLE_TIDSCAN)
#endif
#define ENABLE_ALL_JOIN (ENABLE_NESTLOOP | ENABLE_MERGEJOIN | ENABLE_HASHJOIN)
#define DISABLE_ALL_SCAN 0
#define DISABLE_ALL_JOIN 0
typedef struct Hint Hint;
-typedef struct PlanHint PlanHint;
+typedef struct HintState HintState;
-typedef Hint *(*HintCreateFunction) (char *hint_str, char *keyword);
+typedef Hint *(*HintCreateFunction) (const char *hint_str,
+ const char *keyword);
typedef void (*HintDeleteFunction) (Hint *hint);
-typedef const char *(*HintParseFunction) (Hint *hint, PlanHint *plan, Query *parse, const char *str);
+typedef void (*HintDumpFunction) (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 */
- /* execute error (parse error does not include it) */
- HINT_STATE_ERROR
+ 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 || \
{
const char *hint_str; /* must not do pfree */
const char *keyword; /* must not do pfree */
+ HintType type;
HintStatus state;
HintDeleteFunction delete_func;
+ HintDumpFunction dump_func;
+ HintCmpFunction cmp_func;
HintParseFunction parser_func;
};
Hint base;
char *name; /* name of variable */
char *value;
+ List *words;
} SetHint;
/*
* Describes a context of hint processing.
*/
-struct PlanHint
+struct HintState
{
char *hint_str; /* original hint string */
+ /* all hint */
+ int nall_hints; /* # of valid all hints */
+ int max_all_hints; /* # of slots for all hints */
+ Hint **all_hints; /* parsed all hints */
+
+ /* # of each hints */
+ int num_hints[NUM_HINT_TYPE];
+
/* for scan method hints */
- int nscan_hints; /* # of valid scan hints */
- int max_scan_hints; /* # of slots for scan hints */
ScanMethodHint **scan_hints; /* parsed scan hints */
int init_scan_mask; /* initial value scan parameter */
+ Index parent_relid; /* inherit parent table relid */
+ ScanMethodHint *parent_hint; /* inherit parent table scan hint */
/* for join method hints */
- int njoin_hints; /* # of valid join hints */
- int max_join_hints; /* # of slots for join hints */
JoinMethodHint **join_hints; /* parsed join hints */
-
- int nlevel; /* # of relations to be joined */
+ int init_join_mask; /* initial value join parameter */
List **join_hint_level;
- /* for Leading hints */
- int nleading_hints; /* # of valid leading hints */
- int max_leading_hints; /* # of slots for leading hints */
- LeadingHint **leading_hints; /* parsed Leading hints */
+ /* for Leading hint */
+ LeadingHint *leading_hint; /* parsed last specified Leading hint */
/* for Set hints */
- GucContext context; /* which GUC parameters can we set? */
- int nset_hints; /* # of valid set hints */
- int max_set_hints; /* # of slots for set hints */
SetHint **set_hints; /* parsed Set hints */
+ GucContext context; /* which GUC parameters can we set? */
};
/*
*/
typedef struct HintParser
{
- char *keyword;
- bool have_paren;
+ char *keyword;
HintCreateFunction create_func;
} HintParser;
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 void push_hint(HintState *hstate);
+static void pop_hint(void);
-static Hint *ScanMethodHintCreate(char *hint_str, char *keyword);
+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);
static void ScanMethodHintDelete(ScanMethodHint *hint);
-static const char *ScanMethodHintParse(ScanMethodHint *hint, PlanHint *plan, Query *parse, const char *str);
-static Hint *JoinMethodHintCreate(char *hint_str, char *keyword);
+static void ScanMethodHintDump(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);
static void JoinMethodHintDelete(JoinMethodHint *hint);
-static const char *JoinMethodHintParse(JoinMethodHint *hint, PlanHint *plan, Query *parse, const char *str);
-static Hint *LeadingHintCreate(char *hint_str, char *keyword);
+static void JoinMethodHintDump(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);
static void LeadingHintDelete(LeadingHint *hint);
-static const char *LeadingHintParse(LeadingHint *hint, PlanHint *plan, Query *parse, const char *str);
-static Hint *SetHintCreate(char *hint_str, char *keyword);
+static void LeadingHintDump(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);
static void SetHintDelete(SetHint *hint);
-static const char *SetHintParse(SetHint *hint, PlanHint *plan, Query *parse, const char *str);
-
-RelOptInfo *standard_join_search_org(PlannerInfo *root, int levels_needed, List *initial_rels);
+static void SetHintDump(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);
+
+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);
/* 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, ScanMethodHintCreate},
- {HINT_INDEXSCAN, true, ScanMethodHintCreate},
- {HINT_BITMAPSCAN, true, ScanMethodHintCreate},
- {HINT_TIDSCAN, true, ScanMethodHintCreate},
- {HINT_NOSEQSCAN, true, ScanMethodHintCreate},
- {HINT_NOINDEXSCAN, true, ScanMethodHintCreate},
- {HINT_NOBITMAPSCAN, true, ScanMethodHintCreate},
- {HINT_NOTIDSCAN, true, ScanMethodHintCreate},
+ {HINT_SEQSCAN, ScanMethodHintCreate},
+ {HINT_INDEXSCAN, ScanMethodHintCreate},
+ {HINT_BITMAPSCAN, ScanMethodHintCreate},
+ {HINT_TIDSCAN, ScanMethodHintCreate},
+ {HINT_NOSEQSCAN, ScanMethodHintCreate},
+ {HINT_NOINDEXSCAN, ScanMethodHintCreate},
+ {HINT_NOBITMAPSCAN, ScanMethodHintCreate},
+ {HINT_NOTIDSCAN, ScanMethodHintCreate},
#if PG_VERSION_NUM >= 90200
- {HINT_INDEXONLYSCAN, true, ScanMethodHintCreate},
- {HINT_NOINDEXONLYSCAN, true, ScanMethodHintCreate},
+ {HINT_INDEXONLYSCAN, ScanMethodHintCreate},
+ {HINT_NOINDEXONLYSCAN, ScanMethodHintCreate},
#endif
- {HINT_NESTLOOP, true, JoinMethodHintCreate},
- {HINT_MERGEJOIN, true, JoinMethodHintCreate},
- {HINT_HASHJOIN, true, JoinMethodHintCreate},
- {HINT_NONESTLOOP, true, JoinMethodHintCreate},
- {HINT_NOMERGEJOIN, true, JoinMethodHintCreate},
- {HINT_NOHASHJOIN, true, JoinMethodHintCreate},
- {HINT_LEADING, true, LeadingHintCreate},
- {HINT_SET, true, SetHintCreate},
- {NULL, false, NULL},
+ {HINT_NESTLOOP, JoinMethodHintCreate},
+ {HINT_MERGEJOIN, JoinMethodHintCreate},
+ {HINT_HASHJOIN, JoinMethodHintCreate},
+ {HINT_NONESTLOOP, JoinMethodHintCreate},
+ {HINT_NOMERGEJOIN, JoinMethodHintCreate},
+ {HINT_NOHASHJOIN, JoinMethodHintCreate},
+ {HINT_LEADING, LeadingHintCreate},
+ {HINT_SET, SetHintCreate},
+ {NULL, NULL}
};
/*
_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;
_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;
}
+/*
+ * create and delete functions the hint object
+ */
+
static Hint *
-ScanMethodHintCreate(char *hint_str, char *keyword)
+ScanMethodHintCreate(const char *hint_str, const char *keyword)
{
ScanMethodHint *hint;
hint = palloc(sizeof(ScanMethodHint));
hint->base.hint_str = hint_str;
hint->base.keyword = keyword;
+ hint->base.type = HINT_TYPE_SCAN_METHOD;
hint->base.state = HINT_STATE_NOTUSED;
hint->base.delete_func = (HintDeleteFunction) ScanMethodHintDelete;
+ hint->base.dump_func = (HintDumpFunction) ScanMethodHintDump;
+ hint->base.cmp_func = (HintCmpFunction) ScanMethodHintCmp;
hint->base.parser_func = (HintParseFunction) ScanMethodHintParse;
hint->relname = NULL;
hint->indexnames = NIL;
}
static Hint *
-JoinMethodHintCreate(char *hint_str, char *keyword)
+JoinMethodHintCreate(const char *hint_str, const char *keyword)
{
JoinMethodHint *hint;
hint = palloc(sizeof(JoinMethodHint));
hint->base.hint_str = hint_str;
hint->base.keyword = keyword;
+ hint->base.type = HINT_TYPE_JOIN_METHOD;
hint->base.state = HINT_STATE_NOTUSED;
hint->base.delete_func = (HintDeleteFunction) JoinMethodHintDelete;
+ hint->base.dump_func = (HintDumpFunction) JoinMethodHintDump;
+ hint->base.cmp_func = (HintCmpFunction) JoinMethodHintCmp;
hint->base.parser_func = (HintParseFunction) JoinMethodHintParse;
hint->nrels = 0;
hint->relnames = NULL;
}
static Hint *
-LeadingHintCreate(char *hint_str, char *keyword)
+LeadingHintCreate(const char *hint_str, const char *keyword)
{
LeadingHint *hint;
hint = palloc(sizeof(LeadingHint));
hint->base.hint_str = hint_str;
hint->base.keyword = keyword;
+ hint->base.type = HINT_TYPE_LEADING;
hint->base.state = HINT_STATE_NOTUSED;
hint->base.delete_func = (HintDeleteFunction)LeadingHintDelete;
+ hint->base.dump_func = (HintDumpFunction) LeadingHintDump;
+ hint->base.cmp_func = (HintCmpFunction) LeadingHintCmp;
hint->base.parser_func = (HintParseFunction) LeadingHintParse;
hint->relations = NIL;
}
static Hint *
-SetHintCreate(char *hint_str, char *keyword)
+SetHintCreate(const char *hint_str, const char *keyword)
{
SetHint *hint;
hint = palloc(sizeof(SetHint));
hint->base.hint_str = hint_str;
hint->base.keyword = keyword;
+ hint->base.type = HINT_TYPE_SET;
hint->base.state = HINT_STATE_NOTUSED;
hint->base.delete_func = (HintDeleteFunction) SetHintDelete;
+ hint->base.dump_func = (HintDumpFunction) SetHintDump;
+ hint->base.cmp_func = (HintCmpFunction) SetHintCmp;
hint->base.parser_func = (HintParseFunction) SetHintParse;
hint->name = NULL;
hint->value = NULL;
+ hint->words = NIL;
return (Hint *) hint;
}
pfree(hint->name);
if (hint->value)
pfree(hint->value);
+ if (hint->words)
+ list_free(hint->words);
pfree(hint);
}
-static PlanHint *
-PlanHintCreate(void)
-{
- PlanHint *hint;
-
- hint = palloc(sizeof(PlanHint));
- hint->hint_str = NULL;
- hint->init_scan_mask = 0;
- 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->nleading_hints = 0;
- hint->max_leading_hints = 0;
- hint->leading_hints = NULL;
- hint->context = superuser() ? PGC_SUSET : PGC_USERSET;
- hint->nset_hints = 0;
- hint->max_set_hints = 0;
- hint->set_hints = NULL;
-
- return hint;
+static HintState *
+HintStateCreate(void)
+{
+ HintState *hstate;
+
+ hstate = palloc(sizeof(HintState));
+ hstate->hint_str = NULL;
+ hstate->nall_hints = 0;
+ hstate->max_all_hints = 0;
+ hstate->all_hints = NULL;
+ memset(hstate->num_hints, 0, sizeof(hstate->num_hints));
+ hstate->scan_hints = NULL;
+ hstate->init_scan_mask = 0;
+ hstate->parent_relid = 0;
+ hstate->parent_hint = NULL;
+ 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)
{
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++)
- ScanMethodHintDelete(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);
+}
+
+/*
+ * dump functions
+ */
- for (i = 0; i < hint->njoin_hints; i++)
- JoinMethodHintDelete(hint->join_hints[i]);
- if (hint->join_hints)
- pfree(hint->join_hints);
+static void
+dump_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 == '"')
+ {
+ need_quote = true;
+ appendStringInfoCharMacro(buf, '"');
+ break;
+ }
+ }
- for (i = 0; i < hint->nleading_hints; i++)
- LeadingHintDelete(hint->leading_hints[i]);
- if (hint->leading_hints)
- pfree(hint->leading_hints);
+ for (str = value; *str != '\0'; str++)
+ {
+ if (*str == '"')
+ appendStringInfoCharMacro(buf, '"');
- for (i = 0; i < hint->nset_hints; i++)
- SetHintDelete(hint->set_hints[i]);
- if (hint->set_hints)
- pfree(hint->set_hints);
+ appendStringInfoCharMacro(buf, *str);
+ }
- pfree(hint);
+ if (need_quote)
+ appendStringInfoCharMacro(buf, '"');
}
-static bool
-PlanHintIsEmpty(PlanHint *hint)
+static void
+ScanMethodHintDump(ScanMethodHint *hint, StringInfo buf)
{
- if (hint->nscan_hints == 0 &&
- hint->njoin_hints == 0 &&
- hint->nleading_hints == 0 &&
- hint->nset_hints == 0)
- return true;
+ ListCell *l;
- return false;
+ appendStringInfo(buf, "%s(", hint->base.keyword);
+ if (hint->relname != NULL)
+ {
+ dump_quote_value(buf, hint->relname);
+ foreach(l, hint->indexnames)
+ {
+ appendStringInfoCharMacro(buf, ' ');
+ dump_quote_value(buf, (char *) lfirst(l));
+ }
+ }
+ appendStringInfoString(buf, ")\n");
}
-/* TODO オブジェクト名のクォート処理を追加 */
static void
-all_hint_dump(PlanHint *hint, StringInfo buf, const char *title, HintStatus state)
+JoinMethodHintDump(JoinMethodHint *hint, StringInfo buf)
{
- int i;
- ListCell *l;
+ int i;
- appendStringInfo(buf, "%s:\n", title);
- for (i = 0; i < hint->nscan_hints; i++)
+ appendStringInfo(buf, "%s(", hint->base.keyword);
+ if (hint->relnames != NULL)
{
- ScanMethodHint *h = hint->scan_hints[i];
+ dump_quote_value(buf, hint->relnames[0]);
+ for (i = 1; i < hint->nrels; i++)
+ {
+ appendStringInfoCharMacro(buf, ' ');
+ dump_quote_value(buf, hint->relnames[i]);
+ }
+ }
+ appendStringInfoString(buf, ")\n");
- if (h->base.state != state)
- continue;
+}
- appendStringInfo(buf, "%s(%s", h->base.keyword, h->relname);
- foreach(l, h->indexnames)
- appendStringInfo(buf, " %s", (char *) lfirst(l));
- appendStringInfoString(buf, ")\n");
- }
+static void
+LeadingHintDump(LeadingHint *hint, StringInfo buf)
+{
+ bool is_first;
+ ListCell *l;
- for (i = 0; i < hint->njoin_hints; i++)
+ appendStringInfo(buf, "%s(", HINT_LEADING);
+ is_first = true;
+ foreach(l, hint->relations)
{
- JoinMethodHint *h = hint->join_hints[i];
- int j;
+ if (is_first)
+ is_first = false;
+ else
+ appendStringInfoCharMacro(buf, ' ');
- if (h->base.state != state)
- continue;
+ dump_quote_value(buf, (char *) lfirst(l));
+ }
- /* Leading hint */
- if (h->enforce_mask == ENABLE_ALL_JOIN)
- continue;
+ appendStringInfoString(buf, ")\n");
+}
- appendStringInfo(buf, "%s(%s", h->base.keyword, h->relnames[0]);
- for (j = 1; j < h->nrels; j++)
- appendStringInfo(buf, " %s", h->relnames[j]);
- appendStringInfoString(buf, ")\n");
- }
+static void
+SetHintDump(SetHint *hint, StringInfo buf)
+{
+ bool is_first = true;
+ ListCell *l;
- for (i = 0; i < hint->nset_hints; i++)
+ appendStringInfo(buf, "%s(", HINT_SET);
+ foreach(l, hint->words)
{
- SetHint *h = hint->set_hints[i];
-
- if (h->base.state != state)
- continue;
+ if (is_first)
+ is_first = false;
+ else
+ appendStringInfoCharMacro(buf, ' ');
- appendStringInfo(buf, "%s(%s %s)\n", HINT_SET, h->name, h->value);
+ dump_quote_value(buf, (char *) lfirst(l));
}
+ appendStringInfo(buf, ")\n");
+}
- for (i = 0; i < hint->nleading_hints; i++)
- {
- LeadingHint *h = hint->leading_hints[i];
- bool is_first;
+static void
+all_hint_dump(HintState *hstate, StringInfo buf, const char *title,
+ HintStatus state)
+{
+ int i;
- if (h->base.state != state)
+ appendStringInfo(buf, "%s:\n", title);
+ for (i = 0; i < hstate->nall_hints; i++)
+ {
+ if (hstate->all_hints[i]->state != state)
continue;
- is_first = true;
- foreach(l, h->relations)
- {
- if (is_first)
- {
- appendStringInfo(buf, "%s(%s", HINT_LEADING, (char *)lfirst(l));
- is_first = false;
- }
- else
- appendStringInfo(buf, " %s", (char *)lfirst(l));
- }
- if (!is_first)
- appendStringInfoString(buf, ")\n");
+ hstate->all_hints[i]->dump_func(hstate->all_hints[i], buf);
}
}
static void
-PlanHintDump(PlanHint *hint)
+HintStateDump(HintState *hstate)
{
StringInfoData buf;
- if (!hint)
+ if (!hstate)
{
elog(LOG, "pg_hint_plan:\nno hint");
return;
initStringInfo(&buf);
appendStringInfoString(&buf, "pg_hint_plan:\n");
- all_hint_dump(hint, &buf, "used hint", HINT_STATE_USED);
- all_hint_dump(hint, &buf, "not used hint", HINT_STATE_NOTUSED);
- all_hint_dump(hint, &buf, "duplication hint", HINT_STATE_DUPLICATION);
- all_hint_dump(hint, &buf, "error hint", HINT_STATE_ERROR);
+ all_hint_dump(hstate, &buf, "used hint", HINT_STATE_USED);
+ all_hint_dump(hstate, &buf, "not used hint", HINT_STATE_NOTUSED);
+ all_hint_dump(hstate, &buf, "duplication hint", HINT_STATE_DUPLICATION);
+ all_hint_dump(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
-ScanMethodHintCmp(const void *a, const void *b, bool order)
-{
- const ScanMethodHint *hinta = *((const ScanMethodHint **) a);
- const ScanMethodHint *hintb = *((const ScanMethodHint **) b);
- int result;
-
- if ((result = RelnameCmp(&hinta->relname, &hintb->relname)) != 0)
- return result;
-
- /* ヒント句で指定した順を返す */
- if (order)
- return hinta->base.hint_str - hintb->base.hint_str;
- else
- return 0;
-}
-
-static int
-ScanMethodHintCmpIsOrder(const void *a, const void *b)
+ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b)
{
- return ScanMethodHintCmp(a, b, true);
+ return RelnameCmp(&a->relname, &b->relname);
}
static int
-JoinMethodHintCmp(const void *a, const void *b, bool order)
+JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b)
{
- const JoinMethodHint *hinta = *((const JoinMethodHint **) a);
- const JoinMethodHint *hintb = *((const JoinMethodHint **) b);
- int i;
+ int i;
- if (hinta->nrels != hintb->nrels)
- return hinta->nrels - hintb->nrels;
+ if (a->nrels != b->nrels)
+ return a->nrels - b->nrels;
- for (i = 0; i < hinta->nrels; i++)
+ for (i = 0; i < a->nrels; i++)
{
int result;
- if ((result = RelnameCmp(&hinta->relnames[i], &hintb->relnames[i])) != 0)
+ if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0)
return result;
}
- /* ヒント句で指定した順を返す */
- if (order)
- return hinta->base.hint_str - hintb->base.hint_str;
- else
- return 0;
-}
-
-static int
-JoinMethodHintCmpIsOrder(const void *a, const void *b)
-{
- return JoinMethodHintCmp(a, b, true);
-}
-
-static int
-LeadingHintCmp(const void *a, const void *b, bool order)
-{
- const LeadingHint *hinta = *((const LeadingHint **) a);
- const LeadingHint *hintb = *((const LeadingHint **) b);
-
- /* ヒント句で指定した順を返す */
- if (order)
- return hinta->base.hint_str - hintb->base.hint_str;
- else
- return 0;
+ return 0;
}
-#ifdef NOT_USED
static int
-LeadingHintCmpIsOrder(const void *a, const void *b)
+LeadingHintCmp(const LeadingHint *a, const LeadingHint *b)
{
- return LeadingHintCmp(a, b, true);
+ return 0;
}
-#endif
static int
-SetHintCmp(const void *a, const void *b, bool order)
+SetHintCmp(const SetHint *a, const SetHint *b)
{
- const SetHint *hinta = *((const SetHint **) a);
- const SetHint *hintb = *((const SetHint **) b);
- int result;
-
- if ((result = strcmp(hinta->name, hintb->name)) != 0)
- return result;
-
- /* ヒント句で指定した順を返す */
- if (order)
- return hinta->base.hint_str - hintb->base.hint_str;
- else
- return 0;
+ return strcmp(a->name, b->name);
}
static int
-SetHintCmpIsOrder(const void *a, const void *b)
+HintCmp(const void *a, const void *b)
{
- return SetHintCmp(a, b, true);
+ 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);
}
-#if PG_VERSION_NUM < 90200
+/*
+ * Returns byte offset of hint b from hint a. If hint a was specified before
+ * b, positive value is returned.
+ */
static int
-set_config_option_wrapper(const char *name, const char *value,
- GucContext context, GucSource source,
- GucAction action, bool changeVal, int elevel)
+HintCmpWithPos(const void *a, const void *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);
+ const Hint *hinta = *((const Hint **) a);
+ const Hint *hintb = *((const Hint **) b);
+ int result;
- MemoryContextSwitchTo(ecxt);
- }
- PG_END_TRY();
+ result = HintCmp(a, b);
+ if (result == 0)
+ result = hinta->hint_str - hintb->hint_str;
return result;
}
-#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(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(hint->name, hint->value, context,
- PGC_S_SESSION, GUC_ACTION_SAVE, true,
- pg_hint_plan_parse_messages);
- if (result != 0)
- hint->base.state = HINT_STATE_USED;
- else
- hint->base.state = HINT_STATE_ERROR;
- }
-
- return save_nestlevel;
-}
-
-#define SET_CONFIG_OPTION(name, type_bits) \
- set_config_option((name), \
- (enforce_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)
-{
- 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_INDEXSCAN);
-#endif
-}
-
-static void
-set_join_config_options(unsigned char enforce_mask, GucContext context)
-{
- SET_CONFIG_OPTION("enable_nestloop", ENABLE_NESTLOOP);
- SET_CONFIG_OPTION("enable_mergejoin", ENABLE_MERGEJOIN);
- SET_CONFIG_OPTION("enable_hashjoin", ENABLE_HASHJOIN);
-}
-
/*
* parse functions
*/
-
static const char *
parse_keyword(const char *str, StringInfo buf)
{
if (*str != '(')
{
- parse_ereport(str, ("Opened parenthesis is necessary."));
+ parse_ereport(str, ("Opening parenthesis is necessary."));
return NULL;
}
if (*str != ')')
{
- parse_ereport(str, ("Closed parenthesis is necessary."));
+ parse_ereport(str, ("Closing 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_quote_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));
+ parse_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 == '\0')
+ break;
appendStringInfoCharMacro(&buf, *str++);
}
if (buf.len == 0)
{
+ parse_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 const char *
-skip_option_delimiter(const char *str)
+parse_parentheses(const char *str, List **name_list, HintType type)
{
- const char *p = str;
+ char *name;
+ bool truncate = true;
+
+ if ((str = skip_opened_parenthesis(str)) == NULL)
+ return NULL;
skip_space(str);
- if (str == p)
+ /* Store words in a parenthesis in a list. */
+ while(*str != ')' && *str != '\0')
{
- parse_ereport(str, ("Must be specified space."));
- return NULL;
+ if ((str = parse_quote_value(str, &name, truncate)) == NULL)
+ {
+ list_free(*name_list);
+ return NULL;
+ }
+
+ *name_list = lappend(*name_list, name);
+ skip_space(str);
+
+ if (type == HINT_TYPE_SET)
+ {
+ truncate = false;
+ }
}
+ if ((str = skip_closed_parenthesis(str)) == NULL)
+ return NULL;
return str;
}
static void
-parse_hints(PlanHint *plan, Query *parse, const char *str)
+parse_hints(HintState *hstate, Query *parse, const char *str)
{
StringInfoData buf;
char *head;
hint = parser->create_func(head, keyword);
- if (parser->have_paren)
+ /* parser of each hint does parse in a parenthesis. */
+ if ((str = hint->parser_func(hint, hstate, parse, str)) == NULL)
{
- /* parser of each hint does parse in a parenthesis. */
- if ((str = skip_opened_parenthesis(str)) == NULL ||
- (str = hint->parser_func(hint, plan, parse, str)) == NULL ||
- (str = skip_closed_parenthesis(str)) == NULL)
- {
- hint->delete_func(hint);
- pfree(buf.data);
- return;
- }
+ hint->delete_func(hint);
+ pfree(buf.data);
+ return;
}
- else
+
+ /*
+ * Add hint information into all_hints array. If we don't have
+ * enough space, double the array.
+ */
+ if (hstate->nall_hints == 0)
{
- if ((str = hint->parser_func(hint, plan, parse, str)) == NULL)
- {
- hint->delete_func(hint);
- pfree(buf.data);
- return;
- }
-
- /*
- * 直前のヒントに括弧の指定がなければ次のヒントの間に空白が必要
- */
- if (!isspace(*str) && *str == '\0')
- parse_ereport(str, ("Delimiter of the hint is necessary."));
+ 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));
+ parse_ereport(head,
+ ("Unrecognized hint keyword \"%s\".", buf.data));
pfree(buf.data);
return;
}
/*
* 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;
+ 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
+ p = debug_query_string;
+
if (p == NULL)
return NULL;
/* find hint end keyword. */
if ((tail = strstr(p, HINT_END)) == NULL)
{
- parse_ereport(head, ("unterminated block comment"));
+ parse_ereport(head, ("Unterminated block comment."));
return NULL;
}
- /* 入れ子にしたブロックコメントはサポートしない */
+ /* We don't support nested block comments. */
if ((head = strstr(p, BLOCK_COMMENT_START)) != NULL && head < tail)
- parse_ereport(head, ("block comments nest doesn't supported"));
+ {
+ parse_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. */
- parse_hints(plan, parse, p);
+ parse_hints(hstate, parse, p);
- /* When nothing specified a hint, we free PlanHint and returns NULL. */
- if (PlanHintIsEmpty(plan))
+ /* When nothing specified a hint, we free HintState and returns NULL. */
+ if (hstate->nall_hints == 0)
{
- PlanHintDelete(plan);
+ HintStateDelete(hstate);
return NULL;
}
- /* 重複したscan method hintを検索する */
- qsort(plan->scan_hints, plan->nscan_hints, sizeof(ScanMethodHint *), ScanMethodHintCmpIsOrder);
- for (i = 0; i < plan->nscan_hints - 1; i++)
- {
- if (ScanMethodHintCmp(plan->scan_hints + i,
- plan->scan_hints + i + 1, false) == 0)
- plan->scan_hints[i]->base.state = HINT_STATE_DUPLICATION;
- }
+ /* Sort hints in order of original position. */
+ qsort(hstate->all_hints, hstate->nall_hints, sizeof(Hint *),
+ HintCmpWithPos);
- /* 重複したjoin method hintを検索する */
- qsort(plan->join_hints, plan->njoin_hints, sizeof(JoinMethodHint *), JoinMethodHintCmpIsOrder);
- for (i = 0; i < plan->njoin_hints - 1; i++)
+ /* Count up hints per hint-type. */
+ for (i = 0; i < hstate->nall_hints; i++)
{
- if (JoinMethodHintCmp(plan->join_hints + i,
- plan->join_hints + i + 1, false) == 0)
- plan->join_hints[i]->base.state = HINT_STATE_DUPLICATION;
+ Hint *cur_hint = hstate->all_hints[i];
+ hstate->num_hints[cur_hint->type]++;
}
- /* 重複したSet hintを検索する */
- qsort(plan->set_hints, plan->nset_hints, sizeof(SetHint *), SetHintCmpIsOrder);
- for (i = 0; i < plan->nset_hints - 1; i++)
+ /*
+ * If we have hints which are specified for an object, mark preceding one
+ * as 'duplicated' to ignore it in planner phase.
+ * We need to pass address of hint pointers, because HintCmp has
+ * been designed to be used with qsort.
+ */
+ for (i = 0; i < hstate->nall_hints - 1; i++)
{
- if (SetHintCmp(plan->set_hints + i,
- plan->set_hints + i + 1, false) == 0)
- plan->set_hints[i]->base.state = HINT_STATE_DUPLICATION;
- }
+ Hint *cur_hint = hstate->all_hints[i];
+ Hint *next_hint = hstate->all_hints[i + 1];
- /* 重複したLeading hintを検索する */
- for (i = 0; i < plan->nleading_hints - 1; i++)
- {
- if (LeadingHintCmp(plan->leading_hints + i,
- plan->leading_hints + i + 1, false) == 0)
- plan->leading_hints[i]->base.state = HINT_STATE_DUPLICATION;
+ if (HintCmp(&cur_hint, &next_hint) == 0)
+ {
+ parse_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->all_hints +
+ hstate->num_hints[HINT_TYPE_SCAN_METHOD];
+ hstate->leading_hint = (LeadingHint *) hstate->all_hints[
+ hstate->num_hints[HINT_TYPE_SCAN_METHOD] +
+ hstate->num_hints[HINT_TYPE_JOIN_METHOD] +
+ hstate->num_hints[HINT_TYPE_LEADING] - 1];
+ hstate->set_hints = (SetHint **) hstate->all_hints +
+ hstate->num_hints[HINT_TYPE_SCAN_METHOD] +
+ hstate->num_hints[HINT_TYPE_JOIN_METHOD] +
+ hstate->num_hints[HINT_TYPE_LEADING];
+
+ return hstate;
}
/*
- * スキャン方式ヒントのカッコ内をパースする
+ * Parse inside of parentheses of scan-method hints.
*/
static const char *
-ScanMethodHintParse(ScanMethodHint *hint, PlanHint *plan, Query *parse, const char *str)
+ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse,
+ const char *str)
{
- const char *keyword = hint->base.keyword;
+ const char *keyword = hint->base.keyword;
+ List *name_list = NIL;
+ int length;
- /*
- * スキャン方式のヒントでリレーション名が読み取れない場合はヒント無効
- */
- if ((str = parse_quote_value(str, &hint->relname, "ralation name")) == NULL)
+ if ((str = parse_parentheses(str, &name_list, hint->base.type)) == NULL)
return NULL;
- skip_space(str);
+ /* Parse relation name and index name(s) if given hint accepts. */
+ length = list_length(name_list);
+ if (length > 0)
+ {
+ hint->relname = linitial(name_list);
+ hint->indexnames = list_delete_first(name_list);
- /*
- * インデックスリストを受け付けるヒントであれば、インデックス参照をパース
- * する。
- */
- if (strcmp(keyword, HINT_INDEXSCAN) == 0 ||
+ /* check the kerword to need the only relation. */
+ if (strcmp(keyword, HINT_INDEXSCAN) != 0 &&
#if PG_VERSION_NUM >= 90200
- strcmp(keyword, HINT_INDEXONLYSCAN) == 0 ||
+ strcmp(keyword, HINT_INDEXONLYSCAN) != 0 &&
#endif
- strcmp(keyword, HINT_BITMAPSCAN) == 0)
- {
- while (*str != ')' && *str != '\0')
+ strcmp(keyword, HINT_BITMAPSCAN) != 0 &&
+ length != 1)
{
- char *indexname;
-
- str = parse_quote_value(str, &indexname, "index name");
- if (str == NULL)
- return NULL;
-
- hint->indexnames = lappend(hint->indexnames, indexname);
- skip_space(str);
+ parse_ereport(str,
+ ("%s hint requires only one relation.",
+ hint->base.keyword));
+ hint->base.state = HINT_STATE_ERROR;
+ return str;
}
}
-
- /* カッコが閉じていなければヒント無効。 */
- skip_space(str); /* just in case */
- if (*str != ')')
+ else
{
- parse_ereport(str, ("Closed parenthesis is necessary."));
- return NULL;
+ parse_ereport(str,
+ ("%s hint requires a relation.",
+ hint->base.keyword));
+ hint->base.state = HINT_STATE_ERROR;
+ return str;
}
- /*
- * ヒントごとに決まっている許容スキャン方式をビットマスクとして設定
- */
+ /* Set a bit for specified hint. */
if (strcasecmp(keyword, HINT_SEQSCAN) == 0)
hint->enforce_mask = ENABLE_SEQSCAN;
else if (strcasecmp(keyword, HINT_INDEXSCAN) == 0)
hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_BITMAPSCAN;
else if (strcasecmp(keyword, HINT_NOTIDSCAN) == 0)
hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_TIDSCAN;
+#if PG_VERSION_NUM >= 90200
+ else if (strcasecmp(keyword, HINT_INDEXONLYSCAN) == 0)
+ hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
+ else if (strcasecmp(keyword, HINT_NOINDEXONLYSCAN) == 0)
+ hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXONLYSCAN;
+#endif
else
{
- parse_ereport(str, ("unrecognized hint keyword \"%s\"", keyword));
+ parse_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
return NULL;
}
- /*
- * 出来上がったヒント情報を追加。スロットが足りない場合は二倍に拡張する。
- */
- if (plan->nscan_hints == 0)
- {
- plan->max_scan_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->scan_hints = palloc(sizeof(ScanMethodHint *) * plan->max_scan_hints);
- }
- else if (plan->nscan_hints == plan->max_scan_hints)
- {
- plan->max_scan_hints *= 2;
- plan->scan_hints = repalloc(plan->scan_hints,
- sizeof(ScanMethodHint *) * plan->max_scan_hints);
- }
-
- plan->scan_hints[plan->nscan_hints] = hint;
- plan->nscan_hints++;
-
return str;
}
static const char *
-JoinMethodHintParse(JoinMethodHint *hint, PlanHint *plan, Query *parse, const char *str)
+JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate, Query *parse,
+ const char *str)
{
- char *relname;
- const char *keyword = hint->base.keyword;
+ const char *keyword = hint->base.keyword;
+ List *name_list = NIL;
- skip_space(str);
+ if ((str = parse_parentheses(str, &name_list, hint->base.type)) == NULL)
+ return NULL;
- 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;
+ ListCell *l;
+ int i = 0;
- skip_space(str);
- if (*str == ')')
- break;
+ /* save the data on the list in array of join hint struct. */
+ hint->relnames = palloc(sizeof(char *) * hint->nrels);
+ foreach (l, name_list)
+ {
+ hint->relnames[i] = lfirst(l);
+ i++;
+ }
}
- if (str == NULL)
- return NULL;
+ list_free(name_list);
- /* Join 対象のテーブルは最低でも2つ指定する必要がある */
+ /* A join hint requires at least two relations to be specified. */
if (hint->nrels < 2)
{
- parse_ereport(str, ("Specified relation more than two."));
- return NULL;
+ parse_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_ALL_JOIN ^ ENABLE_HASHJOIN;
else
{
- parse_ereport(str, ("unrecognized hint keyword \"%s\"", keyword));
+ parse_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
return NULL;
}
- if (plan->njoin_hints == 0)
- {
- plan->max_join_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->join_hints = palloc(sizeof(JoinMethodHint *) * plan->max_join_hints);
- }
- else if (plan->njoin_hints == plan->max_join_hints)
+ return str;
+}
+
+static const char *
+LeadingHintParse(LeadingHint *hint, HintState *hstate, Query *parse,
+ const char *str)
+{
+ List *name_list = NIL;
+
+ if ((str = parse_parentheses(str, &name_list, hint->base.type)) == NULL)
+ return NULL;
+
+ hint->relations = name_list;
+
+ /* A Leading hint requires at least two relations to be specified. */
+ if (list_length(hint->relations) < 2)
{
- plan->max_join_hints *= 2;
- plan->join_hints = repalloc(plan->join_hints,
- sizeof(JoinMethodHint *) * plan->max_join_hints);
+ parse_ereport(hint->base.hint_str,
+ ("%s hint requires at least two relations.",
+ HINT_LEADING));
+ hint->base.state = HINT_STATE_ERROR;
}
- plan->join_hints[plan->njoin_hints] = hint;
- plan->njoin_hints++;
-
return str;
}
static const char *
-LeadingHintParse(LeadingHint *hint, PlanHint *plan, Query *parse, const char *str)
+SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str)
{
- while (true)
- {
- char *relname;
- const char *p;
+ List *name_list = NIL;
- if ((str = parse_quote_value(str, &relname, "relation name")) == NULL)
- return NULL;
-
- hint->relations = lappend(hint->relations, relname);
+ if ((str = parse_parentheses(str, &name_list, hint->base.type)) == NULL)
+ return NULL;
- p = str;
- skip_space(str);
- if (*str == ')')
- break;
+ hint->words = name_list;
- if (p == str)
- {
- parse_ereport(str, ("Must be specified space."));
- break;
- }
+ /* need only parameter's name and parameter's value to set GUC parameter. */
+ if (list_length(name_list) == 2)
+ {
+ hint->name = linitial(name_list);
+ hint->value = lsecond(name_list);
}
-
- /* テーブル指定が1つのみの場合は、ヒントはエラーとする */
- if (list_length(hint->relations) == 1)
+ else
{
parse_ereport(hint->base.hint_str,
- ("In %s hint, specified relation name 2 or more.", HINT_LEADING));
+ ("%s hint requires two relations.",
+ HINT_SET));
hint->base.state = HINT_STATE_ERROR;
}
- if (plan->nleading_hints == 0)
+ return str;
+}
+
+/*
+ * set GUC parameter functions
+ */
+
+static int
+set_config_option_wrapper(const char *name, const char *value,
+ GucContext context, GucSource source,
+ GucAction action, bool changeVal, int elevel)
+{
+ int result = 0;
+ MemoryContext ccxt = CurrentMemoryContext;
+
+ PG_TRY();
{
- plan->max_leading_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->leading_hints = palloc(sizeof(LeadingHint *) * plan->max_leading_hints);
+#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
}
- else if (plan->nleading_hints == plan->max_leading_hints)
+ PG_CATCH();
{
- plan->max_leading_hints *= 2;
- plan->leading_hints = repalloc(plan->leading_hints,
- sizeof(LeadingHint *) * plan->max_leading_hints);
+ 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();
- plan->leading_hints[plan->nleading_hints] = hint;
- plan->nleading_hints++;
+ return result;
+}
- return str;
+static int
+set_config_options(SetHint **options, int noptions, GucContext context)
+{
+ int i;
+ int save_nestlevel;
+
+ save_nestlevel = NewGUCNestLevel();
+
+ for (i = 0; i < noptions; i++)
+ {
+ SetHint *hint = options[i];
+ int result;
+
+ if (!hint_state_enabled(hint))
+ continue;
+
+ result = set_config_option_wrapper(hint->name, hint->value, context,
+ PGC_S_SESSION, GUC_ACTION_SAVE, true,
+ pg_hint_plan_parse_messages);
+ if (result != 0)
+ hint->base.state = HINT_STATE_USED;
+ else
+ hint->base.state = HINT_STATE_ERROR;
+ }
+
+ return save_nestlevel;
}
-static const char *
-SetHintParse(SetHint *hint, PlanHint *plan, Query *parse, const char *str)
+#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)
{
- 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)
- return NULL;
+ unsigned char mask;
- skip_space(str);
- if (*str != ')')
+ 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)
{
- parse_ereport(str, ("Closed parenthesis is necessary."));
- return NULL;
+ if (prev_ProcessUtility)
+ (*prev_ProcessUtility) (parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ else
+ standard_ProcessUtility(parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+
+ return;
}
- if (plan->nset_hints == 0)
+ node = parsetree;
+ if (IsA(node, ExplainStmt))
{
- plan->max_set_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->set_hints = palloc(sizeof(SetHint *) * plan->max_set_hints);
+ /*
+ * 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;
}
- else if (plan->nset_hints == plan->max_set_hints)
+
+ /*
+ * If the query was a EXECUTE or CREATE TABLE AS EXECUTE, get query string
+ * specified to preceding PREPARE command to use it as source of hints.
+ */
+ if (IsA(node, ExecuteStmt))
{
- plan->max_set_hints *= 2;
- plan->set_hints = repalloc(plan->set_hints,
- sizeof(SetHint *) * plan->max_set_hints);
+ 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;
- plan->set_hints[plan->nset_hints] = hint;
- plan->nset_hints++;
+ stmt = (CreateTableAsStmt *) node;
+ Assert(IsA(stmt->query, Query));
+ query = (Query *) stmt->query;
- return str;
+ if (query->commandType == CMD_UTILITY &&
+ IsA(query->utilityStmt, ExecuteStmt))
+ {
+ ExecuteStmt *estmt = (ExecuteStmt *) query->utilityStmt;
+ stmt_name = estmt->name;
+ }
+ }
+#endif
+ if (stmt_name)
+ {
+ PG_TRY();
+ {
+ if (prev_ProcessUtility)
+ (*prev_ProcessUtility) (parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ else
+ standard_ProcessUtility(parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ }
+ PG_CATCH();
+ {
+ stmt_name = NULL;
+ PG_RE_THROW();
+ }
+ PG_END_TRY();
+
+ stmt_name = NULL;
+
+ return;
+ }
+
+ if (prev_ProcessUtility)
+ (*prev_ProcessUtility) (parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ else
+ standard_ProcessUtility(parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+}
+
+/*
+ * Push a hint into hint stack which is implemented with List struct. Head of
+ * list is top of stack.
+ */
+static void
+push_hint(HintState *hstate)
+{
+ /* Prepend new hint to the list means pushing to stack. */
+ HintStateStack = lcons(hstate, HintStateStack);
+
+ /* Pushed hint is the one which should be used hereafter. */
+ current_hint = hstate;
+}
+
+/* Pop a hint from hint stack. Popped hint is automatically discarded. */
+static void
+pop_hint(void)
+{
+ /* Hint stack must not be empty. */
+ if(HintStateStack == NIL)
+ elog(ERROR, "hint stack is empty");
+
+ /*
+ * Take a hint at the head from the list, and free it. Switch current_hint
+ * to point new head (NULL if the list is empty).
+ */
+ HintStateStack = list_delete_first(HintStateStack);
+ HintStateDelete(current_hint);
+ if(HintStateStack == NIL)
+ current_hint = NULL;
+ else
+ current_hint = (HintState *) lfirst(list_head(HintStateStack));
}
static PlannedStmt *
{
int save_nestlevel;
PlannedStmt *result;
+ HintState *hstate;
/*
- * hintが指定されない、または空のhintを指定された場合は通常のparser処理をお
- * こなう。
- * 他のフック関数で実行されるhint処理をスキップするために、global 変数をNULL
- * に設定しておく。
+ * 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 || (global = parse_head_comment(parse)) == NULL)
+ if (!pg_hint_plan_enable_hint)
{
- global = NULL;
+ current_hint = NULL;
- if (prev_planner_hook)
- return (*prev_planner_hook) (parse, cursorOptions, boundParams);
+ if (prev_planner)
+ return (*prev_planner) (parse, cursorOptions, boundParams);
else
return standard_planner(parse, cursorOptions, boundParams);
}
- /* Set hint で指定されたGUCパラメータを設定する */
- save_nestlevel = set_config_options(global->set_hints, global->nset_hints,
- global->context);
+ /* Create hint struct from parse tree. */
+ hstate = parse_head_comment(parse);
+
+ /*
+ * Use standard planner if the statement has not valid hint. Other hook
+ * functions try to change plan with current_hint if any, so set it to
+ * NULL.
+ */
+ if (!hstate)
+ {
+ current_hint = NULL;
+
+ if (prev_planner)
+ return (*prev_planner) (parse, cursorOptions, boundParams);
+ else
+ return standard_planner(parse, cursorOptions, boundParams);
+ }
+
+ /*
+ * Push new hint struct to the hint stack to disable previous hint context.
+ */
+ push_hint(hstate);
+
+ /* Set GUC parameters which are specified with Set hint. */
+ save_nestlevel = set_config_options(current_hint->set_hints,
+ current_hint->num_hints[HINT_TYPE_SET],
+ current_hint->context);
if (enable_seqscan)
- global->init_scan_mask |= ENABLE_SEQSCAN;
+ current_hint->init_scan_mask |= ENABLE_SEQSCAN;
if (enable_indexscan)
- global->init_scan_mask |= ENABLE_INDEXSCAN;
+ current_hint->init_scan_mask |= ENABLE_INDEXSCAN;
if (enable_bitmapscan)
- global->init_scan_mask |= ENABLE_BITMAPSCAN;
+ current_hint->init_scan_mask |= ENABLE_BITMAPSCAN;
if (enable_tidscan)
- global->init_scan_mask |= ENABLE_TIDSCAN;
+ current_hint->init_scan_mask |= ENABLE_TIDSCAN;
#if PG_VERSION_NUM >= 90200
if (enable_indexonlyscan)
- global->init_scan_mask |= 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;
/*
- * TODO ビュー定義で指定したテーブル数が1つの場合にもこのタイミングでGUCを変更する必
- * 要がある。
+ * Use PG_TRY mechanism to recover GUC parameters and current_hint to the
+ * state when this planner started when error occurred in planner.
*/
- if (list_length(parse->rtable) == 1 &&
- ((RangeTblEntry *) linitial(parse->rtable))->rtekind == RTE_RELATION)
+ PG_TRY();
{
- int i;
- RangeTblEntry *rte = linitial(parse->rtable);
-
- for (i = 0; i < global->nscan_hints; i++)
- {
- ScanMethodHint *hint = global->scan_hints[i];
-
- if (!hint_state_enabled(hint))
- continue;
-
- if (RelnameCmp(&rte->eref->aliasname, &hint->relname) != 0)
- parse_ereport(hint->base.hint_str, ("Relation \"%s\" does not exist.", hint->relname));
-
- set_scan_config_options(hint->enforce_mask, global->context);
- }
+ 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();
- if (prev_planner_hook)
- result = (*prev_planner_hook) (parse, cursorOptions, boundParams);
- else
- result = standard_planner(parse, cursorOptions, boundParams);
+ /* Print hint in debug mode. */
+ if (pg_hint_plan_debug_print)
+ HintStateDump(current_hint);
/*
- * Restore the GUC variables we set above.
+ * Rollback changes of GUC parameters, and pop current hint context from
+ * hint stack to rewind the state.
*/
AtEOXact_GUC(true, save_nestlevel);
-
- /*
- * Print hint if debugging.
- */
- if (pg_hint_plan_debug_print)
- {
- PlanHintDump(global);
-#ifdef NOT_USED
- elog_node_display(INFO, "rtable", parse->rtable, true);
-#endif
- }
-
- PlanHintDelete(global);
- global = NULL;
+ pop_hint();
return result;
}
/*
- * aliasnameと一致するSCANヒントを探す
+ * Return scan method hint which matches given aliasname.
*/
static ScanMethodHint *
-find_scan_hint(RangeTblEntry *rte)
+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++)
{
- ScanMethodHint *hint = global->scan_hints[i];
+ ScanMethodHint *hint = current_hint->scan_hints[i];
+ /* We ignore disabled hints. */
if (!hint_state_enabled(hint))
continue;
}
static void
-pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
- bool inhparent, RelOptInfo *rel)
+delete_indexes(ScanMethodHint *hint, RelOptInfo *rel)
{
- ScanMethodHint *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;
-
- /* scan hint が指定されない場合は、GUCパラメータをリセットする。 */
- if ((hint = find_scan_hint(root->simple_rte_array[rel->relid])) == NULL)
- {
- /* TODO
- set_scan_config_options(global->init_scan_mask, global->context);
- */
- return;
- }
-
- /* インデックスを全て削除し、スキャンに使えなくする */
+ /*
+ * 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)
{
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;
for (cell = list_head(rel->indexlist); cell; cell = next)
{
pfree(indexname);
}
+}
+
+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;
+ }
+ 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);
+ return;
+ }
+ }
+
+ /* This rel is not inherit table. */
+ current_hint->parent_relid = 0;
+ 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)
+ current_hint->parent_hint = hint;
+
+ delete_indexes(hint, rel);
}
-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)
+ {
+ parse_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 JoinMethodHint *
-scan_join_hint(Relids joinrelids)
+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)
{
JoinMethodHint *hint = (JoinMethodHint *) lfirst(l);
+
if (bms_equal(joinrelids, hint->joinrelids))
return hint;
}
}
/*
- * 結合方式のヒントを使用しやすい構造に変換する。
+ * 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
-transform_join_hints(PlanHint *plan, PlannerInfo *root, int level, List *initial_rels)
+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;
+ LeadingHint *lhint;
+ Relids joinrelids;
+ int njoinrels;
+ ListCell *l;
- 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++)
{
- JoinMethodHint *hint = plan->join_hints[i];
- int j;
- Index relid = 0;
+ JoinMethodHint *hint = hstate->join_hints[i];
+ int j;
- if (!hint_state_enabled(hint))
+ 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];
- relid = scan_relid_aliasname(root, relname, true, hint->base.hint_str);
- if (relid == 0)
+ relid = find_relid_aliasname(root, relname, initial_rels,
+ hint->base.hint_str);
+
+ if (relid == -1)
+ hint->base.state = HINT_STATE_ERROR;
+
+ if (relid <= 0)
+ break;
+
+ if (bms_is_member(relid, hint->joinrelids))
{
- parse_ereport(hint->base.hint_str, ("Relation \"%s\" does not exist.", relname));
+ parse_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);
}
- if (plan->nleading_hints == 0)
+ /* Do nothing if no Leading hint was supplied. */
+ if (hstate->num_hints[HINT_TYPE_LEADING] == 0)
return;
- // TODO エラーヒントならばスキップ
- /* Leading hint は、全ての join 方式が有効な hint として登録する */
+ /* Do nothing if Leading hint is invalid. */
+ lhint = hstate->leading_hint;
+ if (!hint_state_enabled(lhint))
+ return;
+
+ /*
+ * 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;
- foreach(l, plan->leading_hints[plan->nleading_hints - 1]->relations)
+ foreach(l, lhint->relations)
{
- char *relname = (char *)lfirst(l);
+ char *relname = (char *)lfirst(l);
JoinMethodHint *hint;
- i = scan_relid_aliasname(root, relname, true, plan->hint_str);
- if (i == 0)
+ /*
+ * Find relid of the relation which has given name. If we have the
+ * name given in Leading hint multiple times in the join, nothing to
+ * do.
+ */
+ relid = find_relid_aliasname(root, relname, initial_rels,
+ hstate->hint_str);
+ if (relid == -1)
{
- parse_ereport(plan->hint_str, ("Relation \"%s\" does not exist.", relname));
- plan->leading_hints[plan->nleading_hints - 1]->base.state =
- HINT_STATE_ERROR;
- break;
+ bms_free(joinrelids);
+ return;
}
+ if (relid == 0)
+ continue;
- joinrelids = bms_add_member(joinrelids, i);
+ /* Found relid must not be in joinrelids. */
+ if (bms_is_member(relid, joinrelids))
+ {
+ parse_ereport(lhint->base.hint_str,
+ ("Relation name \"%s\" is duplicated.", relname));
+ lhint->base.state = HINT_STATE_ERROR;
+ bms_free(joinrelids);
+ return;
+ }
+
+ /* 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 (njoinrels > plan->nlevel)
- {
- parse_ereport(plan->hint_str, ("In %s hint, specified relation name %d or less.", HINT_LEADING, plan->nlevel));
- plan->leading_hints[plan->nleading_hints - 1]->base.state =
- HINT_STATE_ERROR;
- break;
- }
-
- /* 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
+ /*
+ * If we don't have join method hint, create new one for the
+ * join combination with all join methods are enabled.
+ */
+ hint = find_join_hint(joinrelids);
+ if (hint == NULL)
{
/*
* Here relnames is not set, since Relids bitmap is sufficient to
- * control paths of this query afterwards.
+ * control paths of this query afterward.
*/
- // TODO plan->hint_strをLeadingHint構造に変更後修正
- hint = (JoinMethodHint *) JoinMethodHintCreate(plan->hint_str, HINT_LEADING);
+ hint = (JoinMethodHint *) JoinMethodHintCreate(lhint->base.hint_str,
+ HINT_LEADING);
+ hint->base.state = HINT_STATE_USED;
hint->nrels = njoinrels;
hint->enforce_mask = ENABLE_ALL_JOIN;
hint->joinrelids = bms_copy(joinrelids);
- plan->join_hint_level[njoinrels] = lappend(NIL, hint);
+ }
- if (plan->njoin_hints == 0)
- {
- plan->max_join_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->join_hints = palloc(sizeof(JoinMethodHint *) * plan->max_join_hints);
- }
- else if (plan->njoin_hints == plan->max_join_hints)
- {
- plan->max_join_hints *= 2;
- plan->join_hints = repalloc(plan->join_hints,
- sizeof(JoinMethodHint *) * plan->max_join_hints);
- }
+ join_method_hints[njoinrels] = hint;
- plan->join_hints[plan->njoin_hints] = hint;
- plan->njoin_hints++;
- }
+ if (njoinrels >= nbaserel)
+ break;
+ }
+
+ bms_free(joinrelids);
- plan->leading_hints[plan->nleading_hints - 1]->base.state =
- HINT_STATE_USED;
+ if (njoinrels < 2)
+ return;
+
+ /*
+ * 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]);
}
- // TODO ここでいい?
- if (global->nleading_hints > 0 &&
- hint_state_enabled(global->leading_hints[global->nleading_hints - 1]))
- set_join_config_options(DISABLE_ALL_JOIN, global->context);
+ if (hint_state_enabled(lhint))
+ set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
+
+ lhint->base.state = HINT_STATE_USED;
- bms_free(joinrelids);
}
+/*
+ * 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
- for (i = 0; i < plan->nscan_hints; i++)
- {
- ScanMethodHint *hint = plan->scan_hints[i];
- ListCell *l;
+ /* Consider index scans */
+ create_index_paths(root, rel);
- if (hint->enforce_mask == ENABLE_SEQSCAN)
- continue;
+ /* Consider TID scans */
+ create_tidscan_paths(root, rel);
- if (!hint_state_enabled(hint))
- continue;
+ /* Now find the cheapest of the paths for this rel */
+ set_cheapest(rel);
+}
- foreach(l, initial_rels)
- {
- RelOptInfo *rel = (RelOptInfo *) lfirst(l);
- RangeTblEntry *rte = root->simple_rte_array[rel->relid];
+static void
+rebuild_scan_path(HintState *hstate, PlannerInfo *root, int level,
+ List *initial_rels)
+{
+ ListCell *l;
- /*
- * スキャン方式が選択できるリレーションのみ、スキャンパスを再生成
- * する。
- */
- if (rel->reloptkind != RELOPT_BASEREL ||
- rte->rtekind == RTE_VALUES ||
- RelnameCmp(&hint->relname, &rte->eref->aliasname) != 0)
- continue;
+ foreach(l, initial_rels)
+ {
+ RelOptInfo *rel = (RelOptInfo *) lfirst(l);
+ RangeTblEntry *rte;
+ ScanMethodHint *hint;
- /*
- * 複数のスキャンヒントが指定されていた場合でも、1つのネストレベルで
- * スキャン関連のGUCパラメータを変更する。
- */
- if (save_nestlevel == 0)
- save_nestlevel = NewGUCNestLevel();
+ /* Skip relations which we can't choose scan method. */
+ if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
+ continue;
- /*
- * TODO ヒントで指定されたScan方式が最安価でない場合のみ、Pathを生成
- * しなおす
- */
- set_scan_config_options(hint->enforce_mask, plan->context);
+ rte = root->simple_rte_array[rel->relid];
- rel->pathlist = NIL; /* TODO 解放 */
- set_plain_rel_pathlist(root, rel, rte);
+ /* We can't force scan method of foreign tables */
+ if (rte->relkind == RELKIND_FOREIGN_TABLE)
+ continue;
+
+ /*
+ * Create scan paths with GUC parameters which are at the beginning of
+ * planner if scan method hint is not specified, otherwise use
+ * specified hints and mark the hint as used.
+ */
+ if ((hint = find_scan_hint(root, rel)) == NULL)
+ set_scan_config_options(hstate->init_scan_mask,
+ hstate->context);
+ else
+ {
+ set_scan_config_options(hint->enforce_mask, hstate->context);
hint->base.state = HINT_STATE_USED;
+ }
- break;
+ 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);
}
}
/*
* 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;
JoinMethodHint *hint;
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();
- 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;
/*
return rel;
}
+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;
+
/*
- * 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);
}
- transform_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));
+
+ 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 (current_hint->num_hints[HINT_TYPE_LEADING] > 0 &&
+ hint_state_enabled(current_hint->leading_hint))
+ set_join_config_options(current_hint->init_join_mask,
+ current_hint->context);
+
+ return rel;
}
-#define standard_join_search standard_join_search_org
+/*
+ * 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);
+ }
+}
+
+#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(root, joinrel, outerrel, innerrel, jointype, sjinfo, restrictlist) \
+do { \
+ ScanMethodHint *hint = NULL; \
+ if ((hint = find_scan_hint((root), (innerrel))) != NULL) \
+ { \
+ set_scan_config_options(hint->enforce_mask, current_hint->context); \
+ hint->base.state = HINT_STATE_USED; \
+ } \
+ add_paths_to_joinrel((root), (joinrel), (outerrel), (innerrel), (jointype), (sjinfo), (restrictlist)); \
+ if (hint != NULL) \
+ set_scan_config_options(current_hint->init_scan_mask, current_hint->context); \
+} while(0)
+#include "make_join_rel.c"