*/
#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/planner.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 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) \
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) (const char *hint_str,
const char *keyword);
typedef void (*HintDeleteFunction) (Hint *hint);
typedef void (*HintDumpFunction) (Hint *hint, StringInfo buf);
typedef int (*HintCmpFunction) (const Hint *a, const Hint *b);
-typedef const char *(*HintParseFunction) (Hint *hint, PlanHint *plan,
+typedef const char *(*HintParseFunction) (Hint *hint, HintState *hstate,
Query *parse, const char *str);
/* hint types */
HINT_TYPE_SET
} HintType;
+static const char *HintTypeName[] = {
+ "scan method",
+ "join method",
+ "leading",
+ "set"
+};
+
/* hint status */
typedef enum HintStatus
{
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 */
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 */
JoinMethodHint **join_hints; /* parsed join hints */
void _PG_init(void);
void _PG_fini(void);
+static void push_hint(HintState *hstate);
+static void pop_hint(void);
+
static void pg_hint_plan_ProcessUtility(Node *parsetree,
const char *queryString,
ParamListInfo params, bool isTopLevel,
static void ScanMethodHintDelete(ScanMethodHint *hint);
static void ScanMethodHintDump(ScanMethodHint *hint, StringInfo buf);
static int ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b);
-static const char *ScanMethodHintParse(ScanMethodHint *hint, PlanHint *plan,
+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 void JoinMethodHintDump(JoinMethodHint *hint, StringInfo buf);
static int JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b);
-static const char *JoinMethodHintParse(JoinMethodHint *hint, PlanHint *plan,
+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 void LeadingHintDump(LeadingHint *hint, StringInfo buf);
static int LeadingHintCmp(const LeadingHint *a, const LeadingHint *b);
-static const char *LeadingHintParse(LeadingHint *hint, PlanHint *plan,
+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 void SetHintDump(SetHint *hint, StringInfo buf);
static int SetHintCmp(const SetHint *a, const SetHint *b);
-static const char *SetHintParse(SetHint *hint, PlanHint *plan, Query *parse,
+static const char *SetHintParse(SetHint *hint, HintState *hstate, Query *parse,
const char *str);
RelOptInfo *pg_hint_plan_standard_join_search(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_enable_hint = true;
static bool pg_hint_plan_debug_print = false;
static int pg_hint_plan_parse_messages = INFO;
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;
/*
- * EXECUTEコマンド実行時に、ステートメント名を格納する。
- * その他のコマンドの場合は、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;
_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,
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->nall_hints = 0;
- hint->max_all_hints = 0;
- hint->all_hints = NULL;
- memset(hint->num_hints, 0, sizeof(hint->num_hints));
- hint->scan_hints = NULL;
- hint->init_scan_mask = 0;
- hint->parent_relid = 0;
- hint->join_hints = NULL;
- hint->init_join_mask = 0;
- hint->join_hint_level = NULL;
- hint->leading_hint = NULL;
- hint->context = superuser() ? PGC_SUSET : PGC_USERSET;
- 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->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
- hint->all_hints[i]->delete_func(hint->all_hints[i]);
- if (hint->all_hints)
- pfree(hint->all_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);
}
/*
ListCell *l;
appendStringInfo(buf, "%s(", hint->base.keyword);
- dump_quote_value(buf, hint->relname);
- foreach(l, hint->indexnames)
+ if (hint->relname != NULL)
{
- appendStringInfoCharMacro(buf, ' ');
- dump_quote_value(buf, (char *) lfirst(l));
+ dump_quote_value(buf, hint->relname);
+ foreach(l, hint->indexnames)
+ {
+ appendStringInfoCharMacro(buf, ' ');
+ dump_quote_value(buf, (char *) lfirst(l));
+ }
}
appendStringInfoString(buf, ")\n");
}
int i;
appendStringInfo(buf, "%s(", hint->base.keyword);
- dump_quote_value(buf, hint->relnames[0]);
- for (i = 1; i < hint->nrels; i++)
+ if (hint->relnames != NULL)
{
- appendStringInfoCharMacro(buf, ' ');
- dump_quote_value(buf, hint->relnames[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");
static void
SetHintDump(SetHint *hint, StringInfo buf)
{
+ bool is_first = true;
+ ListCell *l;
+
appendStringInfo(buf, "%s(", HINT_SET);
- dump_quote_value(buf, hint->name);
- appendStringInfoCharMacro(buf, ' ');
- dump_quote_value(buf, hint->value);
+ foreach(l, hint->words)
+ {
+ if (is_first)
+ is_first = false;
+ else
+ appendStringInfoCharMacro(buf, ' ');
+
+ dump_quote_value(buf, (char *) lfirst(l));
+ }
appendStringInfo(buf, ")\n");
}
static void
-all_hint_dump(PlanHint *hint, StringInfo buf, const char *title,
+all_hint_dump(HintState *hstate, StringInfo buf, const char *title,
HintStatus state)
{
int i;
appendStringInfo(buf, "%s:\n", title);
- for (i = 0; i < hint->nall_hints; i++)
+ for (i = 0; i < hstate->nall_hints; i++)
{
- if (hint->all_hints[i]->state != state)
+ if (hstate->all_hints[i]->state != state)
continue;
- hint->all_hints[i]->dump_func(hint->all_hints[i], buf);
+ 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);
}
static int
-AllHintCmp(const void *a, const void *b, bool order)
+HintCmp(const void *a, const void *b)
{
const Hint *hinta = *((const Hint **) a);
const Hint *hintb = *((const Hint **) b);
- int result = 0;
if (hinta->type != hintb->type)
return hinta->type - hintb->type;
-
- if ((result = hinta->cmp_func(hinta, hintb)) != 0 || !order)
- return result;
-
- /* ヒント句で指定した順を返す */
- return hinta->hint_str - hintb->hint_str;
+ if (hinta->state == HINT_STATE_ERROR)
+ return -1;
+ if (hintb->state == HINT_STATE_ERROR)
+ return 1;
+ return hinta->cmp_func(hinta, hintb);
}
+/*
+ * Returns byte offset of hint b from hint a. If hint a was specified before
+ * b, positive value is returned.
+ */
static int
-AllHintCmpIsOrder(const void *a, const void *b)
+HintCmpWithPos(const void *a, const void *b)
{
- return AllHintCmp(a, b, true);
+ const Hint *hinta = *((const Hint **) a);
+ const Hint *hintb = *((const Hint **) b);
+ int result;
+
+ 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)
{
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 (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 *
+parse_parentheses(const char *str, List **name_list, HintType type)
+{
+ char *name;
+ bool truncate = true;
+
+ if ((str = skip_opened_parenthesis(str)) == NULL)
+ return NULL;
+
+ skip_space(str);
+
+ /* Store words in a parenthesis in a list. */
+ while(*str != ')' && *str != '\0')
+ {
+ 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);
/* 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)
+ if ((str = hint->parser_func(hint, hstate, parse, str)) == NULL)
{
hint->delete_func(hint);
pfree(buf.data);
}
/*
- * 出来上がったヒント情報を追加。スロットが足りない場合は二倍に拡張する。
+ * Add hint information into all_hints array. If we don't have
+ * enough space, double the array.
*/
- if (plan->nall_hints == 0)
+ if (hstate->nall_hints == 0)
{
- plan->max_all_hints = HINT_ARRAY_DEFAULT_INITSIZE;
- plan->all_hints = palloc(sizeof(Hint *) * plan->max_all_hints);
+ hstate->max_all_hints = HINT_ARRAY_DEFAULT_INITSIZE;
+ hstate->all_hints = (Hint **)
+ palloc(sizeof(Hint *) * hstate->max_all_hints);
}
- else if (plan->nall_hints == plan->max_all_hints)
+ else if (hstate->nall_hints == hstate->max_all_hints)
{
- plan->max_all_hints *= 2;
- plan->all_hints = repalloc(plan->all_hints,
- sizeof(Hint *) * plan->max_all_hints);
+ hstate->max_all_hints *= 2;
+ hstate->all_hints = (Hint **)
+ repalloc(hstate->all_hints,
+ sizeof(Hint *) * hstate->max_all_hints);
}
- plan->all_hints[plan->nall_hints] = hint;
- plan->nall_hints++;
+ hstate->all_hints[hstate->nall_hints] = hint;
+ hstate->nall_hints++;
skip_space(str);
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 *tail;
int len;
int i;
- PlanHint *plan;
+ HintState *hstate;
/* get client-supplied query string. */
if (stmt_name)
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 (plan->nall_hints == 0)
+ /* When nothing specified a hint, we free HintState and returns NULL. */
+ if (hstate->nall_hints == 0)
{
- PlanHintDelete(plan);
+ HintStateDelete(hstate);
return NULL;
}
- /* パースしたヒントを並び替える */
- qsort(plan->all_hints, plan->nall_hints, sizeof(Hint *), AllHintCmpIsOrder);
+ /* Sort hints in order of original position. */
+ qsort(hstate->all_hints, hstate->nall_hints, sizeof(Hint *),
+ HintCmpWithPos);
- /* 重複したヒントを検索する */
- for (i = 0; i < plan->nall_hints; i++)
+ /* Count up hints per hint-type. */
+ for (i = 0; i < hstate->nall_hints; i++)
{
- Hint *hint = plan->all_hints[i];
-
- plan->num_hints[hint->type]++;
+ Hint *cur_hint = hstate->all_hints[i];
+ hstate->num_hints[cur_hint->type]++;
+ }
- if (i + 1 >= plan->nall_hints)
- break;
+ /*
+ * 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++)
+ {
+ Hint *cur_hint = hstate->all_hints[i];
+ Hint *next_hint = hstate->all_hints[i + 1];
- if (AllHintCmp(plan->all_hints + i, plan->all_hints + i + 1, false) ==
- 0)
+ if (HintCmp(&cur_hint, &next_hint) == 0)
{
- const char *HintTypeName[] = {"scan method", "join method",
- "leading", "set"};
-
- parse_ereport(plan->all_hints[i]->hint_str,
- ("Conflict %s hint.", HintTypeName[hint->type]));
- plan->all_hints[i]->state = HINT_STATE_DUPLICATION;
+ parse_ereport(cur_hint->hint_str,
+ ("Conflict %s hint.", HintTypeName[cur_hint->type]));
+ cur_hint->state = HINT_STATE_DUPLICATION;
}
}
- plan->scan_hints = (ScanMethodHint **) plan->all_hints;
- plan->join_hints = (JoinMethodHint **) plan->all_hints +
- plan->num_hints[HINT_TYPE_SCAN_METHOD];
- plan->leading_hint = (LeadingHint *) plan->all_hints[
- plan->num_hints[HINT_TYPE_SCAN_METHOD] +
- plan->num_hints[HINT_TYPE_JOIN_METHOD] +
- plan->num_hints[HINT_TYPE_LEADING] - 1];
- plan->set_hints = (SetHint **) plan->all_hints +
- plan->num_hints[HINT_TYPE_SCAN_METHOD] +
- plan->num_hints[HINT_TYPE_JOIN_METHOD] +
- plan->num_hints[HINT_TYPE_LEADING];
-
- 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,
+ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse,
const char *str)
{
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;
}
}
+ else
+ {
+ 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_BITMAPSCAN;
else if (strcasecmp(keyword, HINT_TIDSCAN) == 0)
hint->enforce_mask = ENABLE_TIDSCAN;
-#if PG_VERSION_NUM >= 90200
- else if (strcasecmp(keyword, HINT_INDEXONLYSCAN) == 0)
- hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
-#endif
else if (strcasecmp(keyword, HINT_NOSEQSCAN) == 0)
hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_SEQSCAN;
else if (strcasecmp(keyword, HINT_NOINDEXSCAN) == 0)
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
}
static const char *
-JoinMethodHintParse(JoinMethodHint *hint, PlanHint *plan, Query *parse,
+JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate, Query *parse,
const char *str)
{
- char *relname;
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."));
+ 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)
}
static const char *
-LeadingHintParse(LeadingHint *hint, PlanHint *plan, Query *parse,
+LeadingHintParse(LeadingHint *hint, HintState *hstate, Query *parse,
const char *str)
{
- skip_space(str);
+ List *name_list = NIL;
- while (*str != ')')
- {
- char *relname;
-
- 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;
- skip_space(str);
- }
+ hint->relations = name_list;
- /* テーブル指定が2つ未満の場合は、Leading ヒントはエラーとする */
+ /* A Leading hint requires at least two relations to be specified. */
if (list_length(hint->relations) < 2)
{
parse_ereport(hint->base.hint_str,
- ("In %s hint, specified relation name 2 or more.",
+ ("%s hint requires at least two relations.",
HINT_LEADING));
hint->base.state = HINT_STATE_ERROR;
}
}
static const char *
-SetHintParse(SetHint *hint, PlanHint *plan, Query *parse, const char *str)
+SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str)
{
- if ((str = parse_quote_value(str, &hint->name, "parameter name")) == NULL ||
- (str = parse_quote_value(str, &hint->value, "parameter value")) == NULL)
+ List *name_list = NIL;
+
+ if ((str = parse_parentheses(str, &name_list, hint->base.type)) == NULL)
return NULL;
+ hint->words = name_list;
+
+ /* 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);
+ }
+ else
+ {
+ parse_ereport(hint->base.hint_str,
+ ("%s hint requires two relations.",
+ HINT_SET));
+ hint->base.state = HINT_STATE_ERROR;
+ }
+
return str;
}
* set GUC parameter functions
*/
-#if PG_VERSION_NUM < 90200
static int
set_config_option_wrapper(const char *name, const char *value,
GucContext context, GucSource source,
PG_TRY();
{
+#if PG_VERSION_NUM >= 90200
+ result = set_config_option(name, value, context, source,
+ action, changeVal, 0);
+#else
result = set_config_option(name, value, context, source,
action, changeVal);
+#endif
}
PG_CATCH();
{
ErrorData *errdata;
- MemoryContext ecxt;
-
- if (elevel >= ERROR)
- PG_RE_THROW();
- ecxt = MemoryContextSwitchTo(ccxt);
+ /* 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);
-
- MemoryContextSwitchTo(ecxt);
}
PG_END_TRY();
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)
{
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);
+ 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
}
#define SET_CONFIG_OPTION(name, type_bits) \
- set_config_option((name), \
- (enforce_mask & (type_bits)) ? "true" : "false", \
+ 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);
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);
{
Node *node;
- if (!pg_hint_plan_enable)
+ if (!pg_hint_plan_enable_hint)
{
if (prev_ProcessUtility)
(*prev_ProcessUtility) (parsetree, queryString, params,
if (IsA(node, ExplainStmt))
{
/*
- * EXPLAIN対象のクエリのパースツリーを取得する
+ * Draw out parse tree of actual query from Query struct of EXPLAIN
+ * statement.
*/
ExplainStmt *stmt;
Query *query;
}
/*
- * EXECUTEコマンドならば、PREPARE時に指定されたクエリ文字列を取得し、ヒント
- * 句の候補として設定する
+ * 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))
{
stmt = (ExecuteStmt *) node;
stmt_name = stmt->name;
}
+#if PG_VERSION_NUM >= 90200
+ /*
+ * CREATE AS EXECUTE behavior has changed since 9.2, so we must handle it
+ * specially here.
+ */
+ if (IsA(node, CreateTableAsStmt))
+ {
+ CreateTableAsStmt *stmt;
+ Query *query;
+
+ stmt = (CreateTableAsStmt *) node;
+ Assert(IsA(stmt->query, Query));
+ query = (Query *) stmt->query;
+
+ if (query->commandType == CMD_UTILITY &&
+ IsA(query->utilityStmt, ExecuteStmt))
+ {
+ ExecuteStmt *estmt = (ExecuteStmt *) query->utilityStmt;
+ stmt_name = estmt->name;
+ }
+ }
+#endif
+ if (stmt_name)
+ {
+ PG_TRY();
+ {
+ if (prev_ProcessUtility)
+ (*prev_ProcessUtility) (parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ else
+ standard_ProcessUtility(parsetree, queryString, params,
+ isTopLevel, dest, completionTag);
+ }
+ PG_CATCH();
+ {
+ stmt_name = NULL;
+ PG_RE_THROW();
+ }
+ PG_END_TRY();
+
+ stmt_name = NULL;
+
+ return;
+ }
if (prev_ProcessUtility)
(*prev_ProcessUtility) (parsetree, queryString, params,
else
standard_ProcessUtility(parsetree, queryString, params,
isTopLevel, dest, completionTag);
+}
- if (stmt_name)
- {
- stmt_name = NULL;
- }
+/*
+ * 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;
+
+ /*
+ * 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);
/*
- * hintが指定されない、または空のhintを指定された場合は通常のparser処理をお
- * こなう。
- * 他のフック関数で実行されるhint処理をスキップするために、global 変数をNULL
- * に設定しておく。
+ * 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 (!pg_hint_plan_enable || (global = parse_head_comment(parse)) == NULL)
+ if (!hstate)
{
- global = NULL;
+ current_hint = NULL;
if (prev_planner)
return (*prev_planner) (parse, cursorOptions, boundParams);
return standard_planner(parse, cursorOptions, boundParams);
}
- /* Set hint で指定されたGUCパラメータを設定する */
- save_nestlevel = set_config_options(global->set_hints,
- global->num_hints[HINT_TYPE_SET],
- global->context);
+ /*
+ * 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)
- global->init_join_mask |= ENABLE_NESTLOOP;
+ current_hint->init_join_mask |= ENABLE_NESTLOOP;
if (enable_mergejoin)
- global->init_join_mask |= ENABLE_MERGEJOIN;
+ current_hint->init_join_mask |= ENABLE_MERGEJOIN;
if (enable_hashjoin)
- global->init_join_mask |= ENABLE_HASHJOIN;
-
- if (prev_planner)
- result = (*prev_planner) (parse, cursorOptions, boundParams);
- else
- result = standard_planner(parse, cursorOptions, boundParams);
+ current_hint->init_join_mask |= ENABLE_HASHJOIN;
/*
- * Restore the GUC variables we set above.
+ * Use PG_TRY mechanism to recover GUC parameters and current_hint to the
+ * state when this planner started when error occurred in planner.
*/
- AtEOXact_GUC(true, save_nestlevel);
+ PG_TRY();
+ {
+ if (prev_planner)
+ result = (*prev_planner) (parse, cursorOptions, boundParams);
+ else
+ result = standard_planner(parse, cursorOptions, boundParams);
+ }
+ PG_CATCH();
+ {
+ /*
+ * Rollback changes of GUC parameters, and pop current hint context
+ * from hint stack to rewind the state.
+ */
+ AtEOXact_GUC(true, save_nestlevel);
+ pop_hint();
+ PG_RE_THROW();
+ }
+ PG_END_TRY();
- /*
- * Print hint if debugging.
- */
+ /* Print hint in debug mode. */
if (pg_hint_plan_debug_print)
- PlanHintDump(global);
+ HintStateDump(current_hint);
- PlanHintDelete(global);
- global = NULL;
+ /*
+ * 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 ScanMethodHint *
find_scan_hint(PlannerInfo *root, RelOptInfo *rel)
int i;
/*
- * RELOPT_BASEREL でなければ、scan method ヒントが適用しない。
- * 子テーブルの場合はRELOPT_OTHER_MEMBER_RELとなるが、サポート対象外とする。
- * また、通常のリレーション以外は、スキャン方式を選択できない。
+ * 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->num_hints[HINT_TYPE_SCAN_METHOD]; 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 (inhparent)
- {
- /* store does relids of parent table. */
- global->parent_relid = rel->relid;
- }
- else if (global->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 == global->parent_relid)
- return;
- }
-
- /* This rel is not inherit table. */
- global->parent_relid = 0;
- }
-
- /* scan hint が指定されない場合は、GUCパラメータをリセットする。 */
- if ((hint = find_scan_hint(root, rel)) == NULL)
- {
- set_scan_config_options(global->init_scan_mask, global->context);
- return;
- }
- set_scan_config_options(hint->enforce_mask, global->context);
- hint->base.state = HINT_STATE_USED;
-
/*
* We delete all the IndexOptInfo list and prevent you from being usable by
* a scan.
}
}
+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);
+}
+
/*
- * aliasnameがクエリ中に指定した別名と一致する場合は、そのインデックスを返し、一致
- * する別名がなければ0を返す。
- * aliasnameがクエリ中に複数回指定された場合は、-1を返す。
+ * Return index of relation which matches given aliasname, or 0 if not found.
+ * If same aliasname was used multiple times in a query, return -1.
*/
static int
find_relid_aliasname(PlannerInfo *root, char *aliasname, List *initial_rels,
const char *str)
{
- int i;
- int found = 0;
+ int i;
+ Index found = 0;
for (i = 1; i < root->simple_rel_array_size; i++)
{
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;
foreach(l, initial_rels)
}
/*
- * relidビットマスクと一致するヒントを探す
+ * Return join hint which matches given 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)
{
}
/*
- * 結合方式のヒントを使用しやすい構造に変換する。
+ * 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 nbaserel,
+transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel,
List *initial_rels, JoinMethodHint **join_method_hints)
{
int i;
int njoinrels;
ListCell *l;
- for (i = 0; i < plan->num_hints[HINT_TYPE_JOIN_METHOD]; 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];
+ JoinMethodHint *hint = hstate->join_hints[i];
int j;
if (!hint_state_enabled(hint) || hint->nrels > nbaserel)
if (bms_is_member(relid, hint->joinrelids))
{
parse_ereport(hint->base.hint_str,
- ("Relation name \"%s\" is duplicate.", relname));
+ ("Relation name \"%s\" is duplicated.", relname));
hint->base.state = HINT_STATE_ERROR;
break;
}
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 ヒントが指定されている場合は、結合順にあわせてjoin method hint
- * のフォーマットに変換する。
- */
- if (plan->num_hints[HINT_TYPE_LEADING] == 0)
+ /* Do nothing if no Leading hint was supplied. */
+ if (hstate->num_hints[HINT_TYPE_LEADING] == 0)
return;
- lhint = plan->leading_hint;
+ /* Do nothing if Leading hint is invalid. */
+ lhint = hstate->leading_hint;
if (!hint_state_enabled(lhint))
return;
- /* Leading hint は、全ての join 方式が有効な hint として登録する */
+ /*
+ * 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, lhint->relations)
char *relname = (char *)lfirst(l);
JoinMethodHint *hint;
- relid =
- find_relid_aliasname(root, relname, initial_rels, plan->hint_str);
-
+ /*
+ * 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)
{
bms_free(joinrelids);
return;
}
-
if (relid == 0)
continue;
+ /* Found relid must not be in joinrelids. */
if (bms_is_member(relid, joinrelids))
{
parse_ereport(lhint->base.hint_str,
- ("Relation name \"%s\" is duplicate.", relname));
+ ("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 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.
*/
hint = (JoinMethodHint *) JoinMethodHintCreate(lhint->base.hint_str,
HINT_LEADING);
if (njoinrels < 2)
return;
+ /*
+ * Delete all join hints which have different combination from Leading
+ * hint.
+ */
for (i = 2; i <= njoinrels; i++)
{
- /* Leading で指定した組み合わせ以外の join hint を削除する */
- list_free(plan->join_hint_level[i]);
+ list_free(hstate->join_hint_level[i]);
- plan->join_hint_level[i] = lappend(NIL, join_method_hints[i]);
+ hstate->join_hint_level[i] = lappend(NIL, join_method_hints[i]);
}
if (hint_state_enabled(lhint))
- set_join_config_options(DISABLE_ALL_JOIN, global->context);
+ set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
lhint->base.state = HINT_STATE_USED;
}
+/*
+ * 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,
+set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
+{
+ /* Consider sequential scan */
+#if PG_VERSION_NUM >= 90200
+ add_path(rel, create_seqscan_path(root, rel, NULL));
+#else
+ add_path(rel, create_seqscan_path(root, rel));
+#endif
+
+ /* Consider index scans */
+ create_index_paths(root, rel);
+
+ /* Consider TID scans */
+ create_tidscan_paths(root, rel);
+
+ /* Now find the cheapest of the paths for this rel */
+ set_cheapest(rel);
+}
+
+static void
+rebuild_scan_path(HintState *hstate, PlannerInfo *root, int level,
List *initial_rels)
{
ListCell *l;
RangeTblEntry *rte;
ScanMethodHint *hint;
- /*
- * スキャン方式が選択できるリレーションのみ、スキャンパスを再生成
- * する。
- */
+ /* Skip relations which we can't choose scan method. */
if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
continue;
rte = root->simple_rte_array[rel->relid];
- /* 外部表はスキャン方式が選択できない。 */
+ /* We can't force scan method of foreign tables */
if (rte->relkind == RELKIND_FOREIGN_TABLE)
continue;
/*
- * scan method hint が指定されていなければ、初期値のGUCパラメータでscan
- * path を再生成する。
+ * 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(plan->init_scan_mask, plan->context);
+ set_scan_config_options(hstate->init_scan_mask,
+ hstate->context);
else
{
- set_scan_config_options(hint->enforce_mask, plan->context);
+ set_scan_config_options(hint->enforce_mask, hstate->context);
hint->base.state = HINT_STATE_USED;
}
/*
* Restore the GUC variables we set above.
*/
- set_scan_config_options(plan->init_scan_mask, plan->context);
+ set_scan_config_options(hstate->init_scan_mask, hstate->context);
}
/*
- * make_join_rel() をラップする関数
+ * wrapper of make_join_rel()
*
- * ヒントにしたがって、enabele_* パラメータを変更した上で、make_join_rel()を
- * 呼び出す。
+ * call make_join_rel() after changing enable_* parameters according to given
+ * hints.
*/
static RelOptInfo *
make_join_rel_wrapper(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
save_nestlevel = NewGUCNestLevel();
- set_join_config_options(hint->enforce_mask, global->context);
+ set_join_config_options(hint->enforce_mask, current_hint->context);
rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
hint->base.state = HINT_STATE_USED;
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);
}
/* We apply scan method hint rebuild scan path. */
- rebuild_scan_path(global, root, levels_needed, initial_rels);
+ 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);
nbaserel = get_num_baserels(initial_rels);
- global->join_hint_level = palloc0(sizeof(List *) * (nbaserel + 1));
+ current_hint->join_hint_level = palloc0(sizeof(List *) * (nbaserel + 1));
join_method_hints = palloc0(sizeof(JoinMethodHint *) * (nbaserel + 1));
- transform_join_hints(global, root, nbaserel, initial_rels,
+ 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(global->join_hint_level[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(global->join_hint_level);
+ pfree(current_hint->join_hint_level);
pfree(join_method_hints);
- if (global->num_hints[HINT_TYPE_LEADING] > 0 &&
- hint_state_enabled(global->leading_hint))
- set_join_config_options(global->init_join_mask, global->context);
+ 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;
}
/*
* 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);
ScanMethodHint *hint = NULL; \
if ((hint = find_scan_hint((root), (innerrel))) != NULL) \
{ \
- set_scan_config_options(hint->enforce_mask, global->context); \
+ 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(global->init_scan_mask, global->context); \
+ set_scan_config_options(current_hint->init_scan_mask, current_hint->context); \
} while(0)
#include "make_join_rel.c"
OSDN Git Service
