1 /*-------------------------------------------------------------------------
4 * do instructions or hints to the planner using C-style block comments
7 * Copyright (c) 2012, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
9 *-------------------------------------------------------------------------
12 #include "commands/prepare.h"
13 #include "mb/pg_wchar.h"
14 #include "miscadmin.h"
15 #include "nodes/nodeFuncs.h"
16 #include "optimizer/clauses.h"
17 #include "optimizer/cost.h"
18 #include "optimizer/geqo.h"
19 #include "optimizer/joininfo.h"
20 #include "optimizer/pathnode.h"
21 #include "optimizer/paths.h"
22 #include "optimizer/plancat.h"
23 #include "optimizer/planner.h"
24 #include "optimizer/prep.h"
25 #include "optimizer/restrictinfo.h"
26 #include "parser/scansup.h"
27 #include "tcop/utility.h"
28 #include "utils/lsyscache.h"
29 #include "utils/memutils.h"
31 #ifdef PG_MODULE_MAGIC
35 #if PG_VERSION_NUM < 90100
36 #error unsupported PostgreSQL version
39 #define BLOCK_COMMENT_START "/*"
40 #define BLOCK_COMMENT_END "*/"
41 #define HINT_COMMENT_KEYWORD "+"
42 #define HINT_START BLOCK_COMMENT_START HINT_COMMENT_KEYWORD
43 #define HINT_END BLOCK_COMMENT_END
46 #define HINT_SEQSCAN "SeqScan"
47 #define HINT_INDEXSCAN "IndexScan"
48 #define HINT_BITMAPSCAN "BitmapScan"
49 #define HINT_TIDSCAN "TidScan"
50 #define HINT_NOSEQSCAN "NoSeqScan"
51 #define HINT_NOINDEXSCAN "NoIndexScan"
52 #define HINT_NOBITMAPSCAN "NoBitmapScan"
53 #define HINT_NOTIDSCAN "NoTidScan"
54 #define HINT_NESTLOOP "NestLoop"
55 #define HINT_MERGEJOIN "MergeJoin"
56 #define HINT_HASHJOIN "HashJoin"
57 #define HINT_NONESTLOOP "NoNestLoop"
58 #define HINT_NOMERGEJOIN "NoMergeJoin"
59 #define HINT_NOHASHJOIN "NoHashJoin"
60 #define HINT_LEADING "Leading"
61 #define HINT_SET "Set"
64 #define HINT_ARRAY_DEFAULT_INITSIZE 8
66 #define parse_ereport(str, detail) \
67 ereport(pg_hint_plan_parse_messages, \
68 (errmsg("hint syntax error at or near \"%s\"", (str)), \
71 #define skip_space(str) \
72 while (isspace(*str)) \
77 ENABLE_SEQSCAN = 0x01,
78 ENABLE_INDEXSCAN = 0x02,
79 ENABLE_BITMAPSCAN = 0x04,
80 ENABLE_TIDSCAN = 0x08,
85 ENABLE_NESTLOOP = 0x01,
86 ENABLE_MERGEJOIN = 0x02,
87 ENABLE_HASHJOIN = 0x04
90 #define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | ENABLE_BITMAPSCAN \
92 #define ENABLE_ALL_JOIN (ENABLE_NESTLOOP | ENABLE_MERGEJOIN | ENABLE_HASHJOIN)
93 #define DISABLE_ALL_SCAN 0
94 #define DISABLE_ALL_JOIN 0
96 typedef struct Hint Hint;
97 typedef struct PlanHint PlanHint;
99 typedef Hint *(*HintCreateFunction) (const char *hint_str,
100 const char *keyword);
101 typedef void (*HintDeleteFunction) (Hint *hint);
102 typedef void (*HintDumpFunction) (Hint *hint, StringInfo buf);
103 typedef int (*HintCmpFunction) (const Hint *a, const Hint *b);
104 typedef const char *(*HintParseFunction) (Hint *hint, PlanHint *plan,
105 Query *parse, const char *str);
108 #define NUM_HINT_TYPE 4
109 typedef enum HintType
111 HINT_TYPE_SCAN_METHOD,
112 HINT_TYPE_JOIN_METHOD,
118 typedef enum HintStatus
120 HINT_STATE_NOTUSED = 0, /* specified relation not used in query */
121 HINT_STATE_USED, /* hint is used */
122 HINT_STATE_DUPLICATION, /* specified hint duplication */
123 HINT_STATE_ERROR /* execute error (parse error does not include
127 #define hint_state_enabled(hint) ((hint)->base.state == HINT_STATE_NOTUSED || \
128 (hint)->base.state == HINT_STATE_USED)
130 /* common data for all hints. */
133 const char *hint_str; /* must not do pfree */
134 const char *keyword; /* must not do pfree */
137 HintDeleteFunction delete_func;
138 HintDumpFunction dump_func;
139 HintCmpFunction cmp_func;
140 HintParseFunction parser_func;
143 /* scan method hints */
144 typedef struct ScanMethodHint
149 unsigned char enforce_mask;
152 /* join method hints */
153 typedef struct JoinMethodHint
158 unsigned char enforce_mask;
162 /* join order hints */
163 typedef struct LeadingHint
166 List *relations; /* relation names specified in Leading hint */
169 /* change a run-time parameter hints */
170 typedef struct SetHint
173 char *name; /* name of variable */
178 * Describes a context of hint processing.
182 char *hint_str; /* original hint string */
185 int nall_hints; /* # of valid all hints */
186 int max_all_hints; /* # of slots for all hints */
187 Hint **all_hints; /* parsed all hints */
189 /* # of each hints */
190 int num_hints[NUM_HINT_TYPE];
192 /* for scan method hints */
193 ScanMethodHint **scan_hints; /* parsed scan hints */
194 int init_scan_mask; /* initial value scan parameter */
195 Index parent_relid; /* inherit parent table relid */
196 ScanMethodHint *parent_hint; /* inherit parent table scan hint */
198 /* for join method hints */
199 JoinMethodHint **join_hints; /* parsed join hints */
200 int init_join_mask; /* initial value join parameter */
201 List **join_hint_level;
203 /* for Leading hint */
204 LeadingHint *leading_hint; /* parsed last specified Leading hint */
207 SetHint **set_hints; /* parsed Set hints */
208 GucContext context; /* which GUC parameters can we set? */
212 * Describes a hint parser module which is bound with particular hint keyword.
214 typedef struct HintParser
217 HintCreateFunction create_func;
220 /* Module callbacks */
224 static void push_stack(PlanHint *plan);
225 static void pop_stack(void);
227 static void pg_hint_plan_ProcessUtility(Node *parsetree,
228 const char *queryString,
229 ParamListInfo params, bool isTopLevel,
231 char *completionTag);
232 static PlannedStmt *pg_hint_plan_planner(Query *parse, int cursorOptions,
233 ParamListInfo boundParams);
234 static void pg_hint_plan_get_relation_info(PlannerInfo *root,
235 Oid relationObjectId,
236 bool inhparent, RelOptInfo *rel);
237 static RelOptInfo *pg_hint_plan_join_search(PlannerInfo *root,
241 static Hint *ScanMethodHintCreate(const char *hint_str, const char *keyword);
242 static void ScanMethodHintDelete(ScanMethodHint *hint);
243 static void ScanMethodHintDump(ScanMethodHint *hint, StringInfo buf);
244 static int ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b);
245 static const char *ScanMethodHintParse(ScanMethodHint *hint, PlanHint *plan,
246 Query *parse, const char *str);
247 static Hint *JoinMethodHintCreate(const char *hint_str, const char *keyword);
248 static void JoinMethodHintDelete(JoinMethodHint *hint);
249 static void JoinMethodHintDump(JoinMethodHint *hint, StringInfo buf);
250 static int JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b);
251 static const char *JoinMethodHintParse(JoinMethodHint *hint, PlanHint *plan,
252 Query *parse, const char *str);
253 static Hint *LeadingHintCreate(const char *hint_str, const char *keyword);
254 static void LeadingHintDelete(LeadingHint *hint);
255 static void LeadingHintDump(LeadingHint *hint, StringInfo buf);
256 static int LeadingHintCmp(const LeadingHint *a, const LeadingHint *b);
257 static const char *LeadingHintParse(LeadingHint *hint, PlanHint *plan,
258 Query *parse, const char *str);
259 static Hint *SetHintCreate(const char *hint_str, const char *keyword);
260 static void SetHintDelete(SetHint *hint);
261 static void SetHintDump(SetHint *hint, StringInfo buf);
262 static int SetHintCmp(const SetHint *a, const SetHint *b);
263 static const char *SetHintParse(SetHint *hint, PlanHint *plan, Query *parse,
266 RelOptInfo *pg_hint_plan_standard_join_search(PlannerInfo *root,
269 void pg_hint_plan_join_search_one_level(PlannerInfo *root, int level);
270 static void make_rels_by_clause_joins(PlannerInfo *root, RelOptInfo *old_rel,
271 ListCell *other_rels);
272 static void make_rels_by_clauseless_joins(PlannerInfo *root,
274 ListCell *other_rels);
275 static bool has_join_restriction(PlannerInfo *root, RelOptInfo *rel);
276 static void set_append_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
277 Index rti, RangeTblEntry *rte);
278 static List *accumulate_append_subpath(List *subpaths, Path *path);
279 static void set_dummy_rel_pathlist(RelOptInfo *rel);
280 RelOptInfo *pg_hint_plan_make_join_rel(PlannerInfo *root, RelOptInfo *rel1,
285 static bool pg_hint_plan_enable = true;
286 static bool pg_hint_plan_debug_print = false;
287 static int pg_hint_plan_parse_messages = INFO;
289 static const struct config_enum_entry parse_messages_level_options[] = {
290 {"debug", DEBUG2, true},
291 {"debug5", DEBUG5, false},
292 {"debug4", DEBUG4, false},
293 {"debug3", DEBUG3, false},
294 {"debug2", DEBUG2, false},
295 {"debug1", DEBUG1, false},
297 {"info", INFO, false},
298 {"notice", NOTICE, false},
299 {"warning", WARNING, false},
300 {"error", ERROR, false},
302 * {"fatal", FATAL, true},
303 * {"panic", PANIC, true},
308 /* Saved hook values in case of unload */
309 static ProcessUtility_hook_type prev_ProcessUtility = NULL;
310 static planner_hook_type prev_planner = NULL;
311 static get_relation_info_hook_type prev_get_relation_info = NULL;
312 static join_search_hook_type prev_join_search = NULL;
314 /* フック関数をまたがって使用する情報を管理する */
315 static PlanHint *current_hint = NULL;
317 /* 有効なヒントをスタック構造で管理する */
318 static List *PlanHintStack = NIL;
321 * EXECUTEコマンド実行時に、ステートメント名を格納する。
322 * その他のコマンドの場合は、NULLに設定する。
324 static char *stmt_name = NULL;
326 static const HintParser parsers[] = {
327 {HINT_SEQSCAN, ScanMethodHintCreate},
328 {HINT_INDEXSCAN, ScanMethodHintCreate},
329 {HINT_BITMAPSCAN, ScanMethodHintCreate},
330 {HINT_TIDSCAN, ScanMethodHintCreate},
331 {HINT_NOSEQSCAN, ScanMethodHintCreate},
332 {HINT_NOINDEXSCAN, ScanMethodHintCreate},
333 {HINT_NOBITMAPSCAN, ScanMethodHintCreate},
334 {HINT_NOTIDSCAN, ScanMethodHintCreate},
335 {HINT_NESTLOOP, JoinMethodHintCreate},
336 {HINT_MERGEJOIN, JoinMethodHintCreate},
337 {HINT_HASHJOIN, JoinMethodHintCreate},
338 {HINT_NONESTLOOP, JoinMethodHintCreate},
339 {HINT_NOMERGEJOIN, JoinMethodHintCreate},
340 {HINT_NOHASHJOIN, JoinMethodHintCreate},
341 {HINT_LEADING, LeadingHintCreate},
342 {HINT_SET, SetHintCreate},
347 * Module load callbacks
352 /* Define custom GUC variables. */
353 DefineCustomBoolVariable("pg_hint_plan.enable",
354 "Force planner to use plans specified in the hint comment preceding to the query.",
356 &pg_hint_plan_enable,
364 DefineCustomBoolVariable("pg_hint_plan.debug_print",
365 "Logs results of hint parsing.",
367 &pg_hint_plan_debug_print,
375 DefineCustomEnumVariable("pg_hint_plan.parse_messages",
376 "Messege level of parse errors.",
378 &pg_hint_plan_parse_messages,
380 parse_messages_level_options,
388 prev_ProcessUtility = ProcessUtility_hook;
389 ProcessUtility_hook = pg_hint_plan_ProcessUtility;
390 prev_planner = planner_hook;
391 planner_hook = pg_hint_plan_planner;
392 prev_get_relation_info = get_relation_info_hook;
393 get_relation_info_hook = pg_hint_plan_get_relation_info;
394 prev_join_search = join_search_hook;
395 join_search_hook = pg_hint_plan_join_search;
399 * Module unload callback
405 /* Uninstall hooks. */
406 ProcessUtility_hook = prev_ProcessUtility;
407 planner_hook = prev_planner;
408 get_relation_info_hook = prev_get_relation_info;
409 join_search_hook = prev_join_search;
413 * create and delete functions the hint object
417 ScanMethodHintCreate(const char *hint_str, const char *keyword)
419 ScanMethodHint *hint;
421 hint = palloc(sizeof(ScanMethodHint));
422 hint->base.hint_str = hint_str;
423 hint->base.keyword = keyword;
424 hint->base.type = HINT_TYPE_SCAN_METHOD;
425 hint->base.state = HINT_STATE_NOTUSED;
426 hint->base.delete_func = (HintDeleteFunction) ScanMethodHintDelete;
427 hint->base.dump_func = (HintDumpFunction) ScanMethodHintDump;
428 hint->base.cmp_func = (HintCmpFunction) ScanMethodHintCmp;
429 hint->base.parser_func = (HintParseFunction) ScanMethodHintParse;
430 hint->relname = NULL;
431 hint->indexnames = NIL;
432 hint->enforce_mask = 0;
434 return (Hint *) hint;
438 ScanMethodHintDelete(ScanMethodHint *hint)
444 pfree(hint->relname);
445 list_free_deep(hint->indexnames);
450 JoinMethodHintCreate(const char *hint_str, const char *keyword)
452 JoinMethodHint *hint;
454 hint = palloc(sizeof(JoinMethodHint));
455 hint->base.hint_str = hint_str;
456 hint->base.keyword = keyword;
457 hint->base.type = HINT_TYPE_JOIN_METHOD;
458 hint->base.state = HINT_STATE_NOTUSED;
459 hint->base.delete_func = (HintDeleteFunction) JoinMethodHintDelete;
460 hint->base.dump_func = (HintDumpFunction) JoinMethodHintDump;
461 hint->base.cmp_func = (HintCmpFunction) JoinMethodHintCmp;
462 hint->base.parser_func = (HintParseFunction) JoinMethodHintParse;
464 hint->relnames = NULL;
465 hint->enforce_mask = 0;
466 hint->joinrelids = NULL;
468 return (Hint *) hint;
472 JoinMethodHintDelete(JoinMethodHint *hint)
481 for (i = 0; i < hint->nrels; i++)
482 pfree(hint->relnames[i]);
483 pfree(hint->relnames);
485 bms_free(hint->joinrelids);
490 LeadingHintCreate(const char *hint_str, const char *keyword)
494 hint = palloc(sizeof(LeadingHint));
495 hint->base.hint_str = hint_str;
496 hint->base.keyword = keyword;
497 hint->base.type = HINT_TYPE_LEADING;
498 hint->base.state = HINT_STATE_NOTUSED;
499 hint->base.delete_func = (HintDeleteFunction)LeadingHintDelete;
500 hint->base.dump_func = (HintDumpFunction) LeadingHintDump;
501 hint->base.cmp_func = (HintCmpFunction) LeadingHintCmp;
502 hint->base.parser_func = (HintParseFunction) LeadingHintParse;
503 hint->relations = NIL;
505 return (Hint *) hint;
509 LeadingHintDelete(LeadingHint *hint)
514 list_free_deep(hint->relations);
519 SetHintCreate(const char *hint_str, const char *keyword)
523 hint = palloc(sizeof(SetHint));
524 hint->base.hint_str = hint_str;
525 hint->base.keyword = keyword;
526 hint->base.type = HINT_TYPE_SET;
527 hint->base.state = HINT_STATE_NOTUSED;
528 hint->base.delete_func = (HintDeleteFunction) SetHintDelete;
529 hint->base.dump_func = (HintDumpFunction) SetHintDump;
530 hint->base.cmp_func = (HintCmpFunction) SetHintCmp;
531 hint->base.parser_func = (HintParseFunction) SetHintParse;
535 return (Hint *) hint;
539 SetHintDelete(SetHint *hint)
556 hint = palloc(sizeof(PlanHint));
557 hint->hint_str = NULL;
558 hint->nall_hints = 0;
559 hint->max_all_hints = 0;
560 hint->all_hints = NULL;
561 memset(hint->num_hints, 0, sizeof(hint->num_hints));
562 hint->scan_hints = NULL;
563 hint->init_scan_mask = 0;
564 hint->parent_relid = 0;
565 hint->parent_hint = NULL;
566 hint->join_hints = NULL;
567 hint->init_join_mask = 0;
568 hint->join_hint_level = NULL;
569 hint->leading_hint = NULL;
570 hint->context = superuser() ? PGC_SUSET : PGC_USERSET;
571 hint->set_hints = NULL;
577 PlanHintDelete(PlanHint *hint)
585 pfree(hint->hint_str);
587 for (i = 0; i < hint->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
588 hint->all_hints[i]->delete_func(hint->all_hints[i]);
590 pfree(hint->all_hints);
598 dump_quote_value(StringInfo buf, const char *value)
600 bool need_quote = false;
603 for (str = value; *str != '\0'; str++)
605 if (isspace(*str) || *str == ')' || *str == '"')
608 appendStringInfoCharMacro(buf, '"');
613 for (str = value; *str != '\0'; str++)
616 appendStringInfoCharMacro(buf, '"');
618 appendStringInfoCharMacro(buf, *str);
622 appendStringInfoCharMacro(buf, '"');
626 ScanMethodHintDump(ScanMethodHint *hint, StringInfo buf)
630 appendStringInfo(buf, "%s(", hint->base.keyword);
631 dump_quote_value(buf, hint->relname);
632 foreach(l, hint->indexnames)
634 appendStringInfoCharMacro(buf, ' ');
635 dump_quote_value(buf, (char *) lfirst(l));
637 appendStringInfoString(buf, ")\n");
641 JoinMethodHintDump(JoinMethodHint *hint, StringInfo buf)
645 appendStringInfo(buf, "%s(", hint->base.keyword);
646 dump_quote_value(buf, hint->relnames[0]);
647 for (i = 1; i < hint->nrels; i++)
649 appendStringInfoCharMacro(buf, ' ');
650 dump_quote_value(buf, hint->relnames[i]);
652 appendStringInfoString(buf, ")\n");
657 LeadingHintDump(LeadingHint *hint, StringInfo buf)
662 appendStringInfo(buf, "%s(", HINT_LEADING);
664 foreach(l, hint->relations)
669 appendStringInfoCharMacro(buf, ' ');
671 dump_quote_value(buf, (char *) lfirst(l));
674 appendStringInfoString(buf, ")\n");
678 SetHintDump(SetHint *hint, StringInfo buf)
680 appendStringInfo(buf, "%s(", HINT_SET);
681 dump_quote_value(buf, hint->name);
682 appendStringInfoCharMacro(buf, ' ');
683 dump_quote_value(buf, hint->value);
684 appendStringInfo(buf, ")\n");
688 all_hint_dump(PlanHint *hint, StringInfo buf, const char *title,
693 appendStringInfo(buf, "%s:\n", title);
694 for (i = 0; i < hint->nall_hints; i++)
696 if (hint->all_hints[i]->state != state)
699 hint->all_hints[i]->dump_func(hint->all_hints[i], buf);
704 PlanHintDump(PlanHint *hint)
710 elog(LOG, "pg_hint_plan:\nno hint");
714 initStringInfo(&buf);
716 appendStringInfoString(&buf, "pg_hint_plan:\n");
717 all_hint_dump(hint, &buf, "used hint", HINT_STATE_USED);
718 all_hint_dump(hint, &buf, "not used hint", HINT_STATE_NOTUSED);
719 all_hint_dump(hint, &buf, "duplication hint", HINT_STATE_DUPLICATION);
720 all_hint_dump(hint, &buf, "error hint", HINT_STATE_ERROR);
722 elog(LOG, "%s", buf.data);
732 RelnameCmp(const void *a, const void *b)
734 const char *relnamea = *((const char **) a);
735 const char *relnameb = *((const char **) b);
737 return strcmp(relnamea, relnameb);
741 ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b)
743 return RelnameCmp(&a->relname, &b->relname);
747 JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b)
751 if (a->nrels != b->nrels)
752 return a->nrels - b->nrels;
754 for (i = 0; i < a->nrels; i++)
757 if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0)
765 LeadingHintCmp(const LeadingHint *a, const LeadingHint *b)
771 SetHintCmp(const SetHint *a, const SetHint *b)
773 return strcmp(a->name, b->name);
777 AllHintCmp(const void *a, const void *b, bool order)
779 const Hint *hinta = *((const Hint **) a);
780 const Hint *hintb = *((const Hint **) b);
783 if (hinta->type != hintb->type)
784 return hinta->type - hintb->type;
786 if ((result = hinta->cmp_func(hinta, hintb)) != 0 || !order)
790 return hinta->hint_str - hintb->hint_str;
794 AllHintCmpIsOrder(const void *a, const void *b)
796 return AllHintCmp(a, b, true);
804 parse_keyword(const char *str, StringInfo buf)
808 while (!isspace(*str) && *str != '(' && *str != '\0')
809 appendStringInfoCharMacro(buf, *str++);
815 skip_opened_parenthesis(const char *str)
821 parse_ereport(str, ("Opening parenthesis is necessary."));
831 skip_closed_parenthesis(const char *str)
837 parse_ereport(str, ("Closing parenthesis is necessary."));
847 * 二重引用符で囲まれているかもしれないトークンを読み取り word 引数に palloc
848 * で確保したバッファに格納してそのポインタを返す。
850 * 正常にパースできた場合は残りの文字列の先頭位置を、異常があった場合は NULL を
852 * truncateがtrueの場合は、NAMEDATALENに切り詰める。
855 parse_quote_value(const char *str, char **word, char *value_type, bool truncate)
863 initStringInfo(&buf);
876 /* 二重引用符が閉じられていない場合はパース中断 */
880 parse_ereport(str, ("Unterminated quoted %s.", value_type));
885 * エスケープ対象のダブルクウォートをスキップする。
886 * もしブロックコメントの開始文字列や終了文字列もオブジェクト名とし
887 * て使用したい場合は、/ と * もエスケープ対象とすることで使用できる
888 * が、処理対象としていない。もしテーブル名にこれらの文字が含まれる
889 * 場合は、エイリアスを指定する必要がある。
898 else if (isspace(*str) || *str == ')' || *str == '"' || *str == '\0')
901 appendStringInfoCharMacro(&buf, *str++);
908 type = pstrdup(value_type);
909 type[0] = toupper(type[0]);
910 parse_ereport(str, ("%s is necessary.", type));
918 /* Truncate name if it's overlength */
920 truncate_identifier(buf.data, strlen(buf.data), true);
928 parse_hints(PlanHint *plan, Query *parse, const char *str)
933 initStringInfo(&buf);
936 const HintParser *parser;
938 /* in error message, we output the comment including the keyword. */
941 /* parse only the keyword of the hint. */
942 resetStringInfo(&buf);
943 str = parse_keyword(str, &buf);
945 for (parser = parsers; parser->keyword != NULL; parser++)
947 char *keyword = parser->keyword;
950 if (strcasecmp(buf.data, keyword) != 0)
953 hint = parser->create_func(head, keyword);
955 /* parser of each hint does parse in a parenthesis. */
956 if ((str = skip_opened_parenthesis(str)) == NULL ||
957 (str = hint->parser_func(hint, plan, parse, str)) == NULL ||
958 (str = skip_closed_parenthesis(str)) == NULL)
960 hint->delete_func(hint);
966 * 出来上がったヒント情報を追加。スロットが足りない場合は二倍に拡張する。
968 if (plan->nall_hints == 0)
970 plan->max_all_hints = HINT_ARRAY_DEFAULT_INITSIZE;
971 plan->all_hints = palloc(sizeof(Hint *) * plan->max_all_hints);
973 else if (plan->nall_hints == plan->max_all_hints)
975 plan->max_all_hints *= 2;
976 plan->all_hints = repalloc(plan->all_hints,
977 sizeof(Hint *) * plan->max_all_hints);
980 plan->all_hints[plan->nall_hints] = hint;
988 if (parser->keyword == NULL)
990 parse_ereport(head, ("Unrecognized hint keyword \"%s\".", buf.data));
1000 * Do basic parsing of the query head comment.
1003 parse_head_comment(Query *parse)
1012 /* get client-supplied query string. */
1015 PreparedStatement *entry;
1017 entry = FetchPreparedStatement(stmt_name, true);
1018 p = entry->plansource->query_string;
1021 p = debug_query_string;
1026 /* extract query head comment. */
1027 len = strlen(HINT_START);
1029 if (strncmp(p, HINT_START, len))
1036 /* find hint end keyword. */
1037 if ((tail = strstr(p, HINT_END)) == NULL)
1039 parse_ereport(head, ("Unterminated block comment."));
1043 /* 入れ子にしたブロックコメントはサポートしない */
1044 if ((head = strstr(p, BLOCK_COMMENT_START)) != NULL && head < tail)
1046 parse_ereport(head, ("Nested block comments are not supported."));
1052 head = palloc(len + 1);
1053 memcpy(head, p, len);
1057 plan = PlanHintCreate();
1058 plan->hint_str = head;
1060 /* parse each hint. */
1061 parse_hints(plan, parse, p);
1063 /* When nothing specified a hint, we free PlanHint and returns NULL. */
1064 if (plan->nall_hints == 0)
1066 PlanHintDelete(plan);
1070 /* パースしたヒントを並び替える */
1071 qsort(plan->all_hints, plan->nall_hints, sizeof(Hint *), AllHintCmpIsOrder);
1074 for (i = 0; i < plan->nall_hints; i++)
1076 Hint *hint = plan->all_hints[i];
1078 plan->num_hints[hint->type]++;
1080 if (i + 1 >= plan->nall_hints)
1083 if (AllHintCmp(plan->all_hints + i, plan->all_hints + i + 1, false) ==
1086 const char *HintTypeName[] = {"scan method", "join method",
1089 parse_ereport(plan->all_hints[i]->hint_str,
1090 ("Conflict %s hint.", HintTypeName[hint->type]));
1091 plan->all_hints[i]->state = HINT_STATE_DUPLICATION;
1095 plan->scan_hints = (ScanMethodHint **) plan->all_hints;
1096 plan->join_hints = (JoinMethodHint **) plan->all_hints +
1097 plan->num_hints[HINT_TYPE_SCAN_METHOD];
1098 plan->leading_hint = (LeadingHint *) plan->all_hints[
1099 plan->num_hints[HINT_TYPE_SCAN_METHOD] +
1100 plan->num_hints[HINT_TYPE_JOIN_METHOD] +
1101 plan->num_hints[HINT_TYPE_LEADING] - 1];
1102 plan->set_hints = (SetHint **) plan->all_hints +
1103 plan->num_hints[HINT_TYPE_SCAN_METHOD] +
1104 plan->num_hints[HINT_TYPE_JOIN_METHOD] +
1105 plan->num_hints[HINT_TYPE_LEADING];
1111 * スキャン方式ヒントのカッコ内をパースする
1114 ScanMethodHintParse(ScanMethodHint *hint, PlanHint *plan, Query *parse,
1117 const char *keyword = hint->base.keyword;
1120 * スキャン方式のヒントでリレーション名が読み取れない場合はヒント無効
1122 if ((str = parse_quote_value(str, &hint->relname, "relation name", true))
1129 * インデックスリストを受け付けるヒントであれば、インデックス参照をパース
1132 if (strcmp(keyword, HINT_INDEXSCAN) == 0 ||
1133 strcmp(keyword, HINT_BITMAPSCAN) == 0)
1135 while (*str != ')' && *str != '\0')
1139 str = parse_quote_value(str, &indexname, "index name", true);
1143 hint->indexnames = lappend(hint->indexnames, indexname);
1149 * ヒントごとに決まっている許容スキャン方式をビットマスクとして設定
1151 if (strcasecmp(keyword, HINT_SEQSCAN) == 0)
1152 hint->enforce_mask = ENABLE_SEQSCAN;
1153 else if (strcasecmp(keyword, HINT_INDEXSCAN) == 0)
1154 hint->enforce_mask = ENABLE_INDEXSCAN;
1155 else if (strcasecmp(keyword, HINT_BITMAPSCAN) == 0)
1156 hint->enforce_mask = ENABLE_BITMAPSCAN;
1157 else if (strcasecmp(keyword, HINT_TIDSCAN) == 0)
1158 hint->enforce_mask = ENABLE_TIDSCAN;
1159 else if (strcasecmp(keyword, HINT_NOSEQSCAN) == 0)
1160 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_SEQSCAN;
1161 else if (strcasecmp(keyword, HINT_NOINDEXSCAN) == 0)
1162 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXSCAN;
1163 else if (strcasecmp(keyword, HINT_NOBITMAPSCAN) == 0)
1164 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_BITMAPSCAN;
1165 else if (strcasecmp(keyword, HINT_NOTIDSCAN) == 0)
1166 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_TIDSCAN;
1169 parse_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
1177 JoinMethodHintParse(JoinMethodHint *hint, PlanHint *plan, Query *parse,
1181 const char *keyword = hint->base.keyword;
1185 hint->relnames = palloc(sizeof(char *));
1187 while ((str = parse_quote_value(str, &relname, "relation name", true))
1191 hint->relnames = repalloc(hint->relnames, sizeof(char *) * hint->nrels);
1192 hint->relnames[hint->nrels - 1] = relname;
1202 /* Join 対象のテーブルは最低でも2つ指定する必要がある */
1203 if (hint->nrels < 2)
1206 ("%s hint requires at least two relations.",
1207 hint->base.keyword));
1208 hint->base.state = HINT_STATE_ERROR;
1212 qsort(hint->relnames, hint->nrels, sizeof(char *), RelnameCmp);
1214 if (strcasecmp(keyword, HINT_NESTLOOP) == 0)
1215 hint->enforce_mask = ENABLE_NESTLOOP;
1216 else if (strcasecmp(keyword, HINT_MERGEJOIN) == 0)
1217 hint->enforce_mask = ENABLE_MERGEJOIN;
1218 else if (strcasecmp(keyword, HINT_HASHJOIN) == 0)
1219 hint->enforce_mask = ENABLE_HASHJOIN;
1220 else if (strcasecmp(keyword, HINT_NONESTLOOP) == 0)
1221 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_NESTLOOP;
1222 else if (strcasecmp(keyword, HINT_NOMERGEJOIN) == 0)
1223 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_MERGEJOIN;
1224 else if (strcasecmp(keyword, HINT_NOHASHJOIN) == 0)
1225 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_HASHJOIN;
1228 parse_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
1236 LeadingHintParse(LeadingHint *hint, PlanHint *plan, Query *parse,
1245 if ((str = parse_quote_value(str, &relname, "relation name", true))
1249 hint->relations = lappend(hint->relations, relname);
1254 /* テーブル指定が2つ未満の場合は、Leading ヒントはエラーとする */
1255 if (list_length(hint->relations) < 2)
1257 parse_ereport(hint->base.hint_str,
1258 ("%s hint requires at least two relations.",
1260 hint->base.state = HINT_STATE_ERROR;
1267 SetHintParse(SetHint *hint, PlanHint *plan, Query *parse, const char *str)
1269 if ((str = parse_quote_value(str, &hint->name, "parameter name", true))
1271 (str = parse_quote_value(str, &hint->value, "parameter value", false))
1279 * set GUC parameter functions
1283 set_config_option_wrapper(const char *name, const char *value,
1284 GucContext context, GucSource source,
1285 GucAction action, bool changeVal, int elevel)
1288 MemoryContext ccxt = CurrentMemoryContext;
1292 result = set_config_option(name, value, context, source,
1299 /* Save error info */
1300 MemoryContextSwitchTo(ccxt);
1301 errdata = CopyErrorData();
1304 ereport(elevel, (errcode(errdata->sqlerrcode),
1305 errmsg("%s", errdata->message),
1306 errdata->detail ? errdetail("%s", errdata->detail) : 0,
1307 errdata->hint ? errhint("%s", errdata->hint) : 0));
1308 FreeErrorData(errdata);
1316 set_config_options(SetHint **options, int noptions, GucContext context)
1321 save_nestlevel = NewGUCNestLevel();
1323 for (i = 0; i < noptions; i++)
1325 SetHint *hint = options[i];
1328 if (!hint_state_enabled(hint))
1331 result = set_config_option_wrapper(hint->name, hint->value, context,
1332 PGC_S_SESSION, GUC_ACTION_SAVE, true,
1333 pg_hint_plan_parse_messages);
1335 hint->base.state = HINT_STATE_USED;
1337 hint->base.state = HINT_STATE_ERROR;
1340 return save_nestlevel;
1343 #define SET_CONFIG_OPTION(name, type_bits) \
1344 set_config_option_wrapper((name), \
1345 (mask & (type_bits)) ? "true" : "false", \
1346 context, PGC_S_SESSION, GUC_ACTION_SAVE, true, ERROR)
1349 set_scan_config_options(unsigned char enforce_mask, GucContext context)
1353 if (enforce_mask == ENABLE_SEQSCAN || enforce_mask == ENABLE_INDEXSCAN ||
1354 enforce_mask == ENABLE_BITMAPSCAN || enforce_mask == ENABLE_TIDSCAN
1356 mask = enforce_mask;
1358 mask = enforce_mask & current_hint->init_scan_mask;
1360 SET_CONFIG_OPTION("enable_seqscan", ENABLE_SEQSCAN);
1361 SET_CONFIG_OPTION("enable_indexscan", ENABLE_INDEXSCAN);
1362 SET_CONFIG_OPTION("enable_bitmapscan", ENABLE_BITMAPSCAN);
1363 SET_CONFIG_OPTION("enable_tidscan", ENABLE_TIDSCAN);
1367 set_join_config_options(unsigned char enforce_mask, GucContext context)
1371 if (enforce_mask == ENABLE_NESTLOOP || enforce_mask == ENABLE_MERGEJOIN ||
1372 enforce_mask == ENABLE_HASHJOIN)
1373 mask = enforce_mask;
1375 mask = enforce_mask & current_hint->init_join_mask;
1377 SET_CONFIG_OPTION("enable_nestloop", ENABLE_NESTLOOP);
1378 SET_CONFIG_OPTION("enable_mergejoin", ENABLE_MERGEJOIN);
1379 SET_CONFIG_OPTION("enable_hashjoin", ENABLE_HASHJOIN);
1383 * pg_hint_plan hook functions
1387 pg_hint_plan_ProcessUtility(Node *parsetree, const char *queryString,
1388 ParamListInfo params, bool isTopLevel,
1389 DestReceiver *dest, char *completionTag)
1393 if (!pg_hint_plan_enable)
1395 if (prev_ProcessUtility)
1396 (*prev_ProcessUtility) (parsetree, queryString, params,
1397 isTopLevel, dest, completionTag);
1399 standard_ProcessUtility(parsetree, queryString, params,
1400 isTopLevel, dest, completionTag);
1406 if (IsA(node, ExplainStmt))
1409 * EXPLAIN対象のクエリのパースツリーを取得する
1414 stmt = (ExplainStmt *) node;
1416 Assert(IsA(stmt->query, Query));
1417 query = (Query *) stmt->query;
1419 if (query->commandType == CMD_UTILITY && query->utilityStmt != NULL)
1420 node = query->utilityStmt;
1424 * EXECUTEコマンドならば、PREPARE時に指定されたクエリ文字列を取得し、ヒント
1427 if (IsA(node, ExecuteStmt))
1431 stmt = (ExecuteStmt *) node;
1432 stmt_name = stmt->name;
1439 if (prev_ProcessUtility)
1440 (*prev_ProcessUtility) (parsetree, queryString, params,
1441 isTopLevel, dest, completionTag);
1443 standard_ProcessUtility(parsetree, queryString, params,
1444 isTopLevel, dest, completionTag);
1458 if (prev_ProcessUtility)
1459 (*prev_ProcessUtility) (parsetree, queryString, params,
1460 isTopLevel, dest, completionTag);
1462 standard_ProcessUtility(parsetree, queryString, params,
1463 isTopLevel, dest, completionTag);
1468 push_stack(PlanHint *plan)
1470 /* 新しいヒントをスタックに積む。 */
1471 PlanHintStack = lcons(plan, PlanHintStack);
1473 /* 先ほどスタックに積んだヒントを現在のヒントとしてcurrent_hintに格納する。 */
1474 current_hint = (PlanHint *) lfirst(list_head(PlanHintStack));
1480 /* ヒントのスタックが空の場合はエラーを返す */
1481 if(PlanHintStack == NIL)
1482 elog(ERROR, "hint stack is empty");
1485 * ヒントのスタックから一番上のものを取り出して解放する。 current_hint
1486 * 常に最上段ヒントを指すが、スタックが空の場合はNULLにする。
1488 PlanHintStack = list_delete_first(PlanHintStack);
1489 PlanHintDelete(current_hint);
1490 if(PlanHintStack == NIL)
1491 current_hint = NULL;
1493 current_hint = (PlanHint *) lfirst(list_head(PlanHintStack));
1496 static PlannedStmt *
1497 pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams)
1500 PlannedStmt *result;
1505 * pg_hint_planが無効である場合は通常のparser処理をおこなう。
1506 * 他のフック関数で実行されるhint処理をスキップするために、current_hint 変数
1509 if (!pg_hint_plan_enable)
1511 current_hint = NULL;
1514 return (*prev_planner) (parse, cursorOptions, boundParams);
1516 return standard_planner(parse, cursorOptions, boundParams);
1520 plan = parse_head_comment(parse);
1523 * hintが指定されない、または空のhintを指定された場合は通常のparser処理をお
1525 * 他のフック関数で実行されるhint処理をスキップするために、current_hint 変数
1530 current_hint = NULL;
1533 return (*prev_planner) (parse, cursorOptions, boundParams);
1535 return standard_planner(parse, cursorOptions, boundParams);
1538 /* 現在のヒントをスタックに積む。 */
1541 /* Set hint で指定されたGUCパラメータを設定する */
1542 save_nestlevel = set_config_options(current_hint->set_hints,
1543 current_hint->num_hints[HINT_TYPE_SET],
1544 current_hint->context);
1547 current_hint->init_scan_mask |= ENABLE_SEQSCAN;
1548 if (enable_indexscan)
1549 current_hint->init_scan_mask |= ENABLE_INDEXSCAN;
1550 if (enable_bitmapscan)
1551 current_hint->init_scan_mask |= ENABLE_BITMAPSCAN;
1553 current_hint->init_scan_mask |= ENABLE_TIDSCAN;
1554 if (enable_nestloop)
1555 current_hint->init_join_mask |= ENABLE_NESTLOOP;
1556 if (enable_mergejoin)
1557 current_hint->init_join_mask |= ENABLE_MERGEJOIN;
1558 if (enable_hashjoin)
1559 current_hint->init_join_mask |= ENABLE_HASHJOIN;
1562 * ヒントの引数で指定したaliasnameでエラーとなった場合、GUCパラメータと
1563 * current_hintをpg_hint_plan_planner関数の実行前の状態に戻す。
1568 result = (*prev_planner) (parse, cursorOptions, boundParams);
1570 result = standard_planner(parse, cursorOptions, boundParams);
1574 AtEOXact_GUC(true, save_nestlevel);
1581 * Restore the GUC variables we set above.
1583 AtEOXact_GUC(true, save_nestlevel);
1586 * Print hint if debugging.
1588 if (pg_hint_plan_debug_print)
1589 PlanHintDump(current_hint);
1592 * 現在のヒントで使用中のメモリを開放し、スタックから取り除く。
1593 * その後、現在のヒントの値をスタックに積む前のものに戻す。
1601 * aliasnameと一致するSCANヒントを探す
1603 static ScanMethodHint *
1604 find_scan_hint(PlannerInfo *root, RelOptInfo *rel)
1610 * RELOPT_BASEREL でなければ、scan method ヒントが適用しない。
1611 * 子テーブルの場合はRELOPT_OTHER_MEMBER_RELとなるが、サポート対象外とする。
1612 * また、通常のリレーション以外は、スキャン方式を選択できない。
1614 if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
1617 rte = root->simple_rte_array[rel->relid];
1619 /* 外部表はスキャン方式が選択できない。 */
1620 if (rte->relkind == RELKIND_FOREIGN_TABLE)
1624 * スキャン方式のヒントのリストから、検索対象のリレーションと名称が一致する
1627 for (i = 0; i < current_hint->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
1629 ScanMethodHint *hint = current_hint->scan_hints[i];
1631 /* すでに無効となっているヒントは検索対象にしない。 */
1632 if (!hint_state_enabled(hint))
1635 if (RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0)
1643 delete_indexes(ScanMethodHint *hint, RelOptInfo *rel)
1650 * We delete all the IndexOptInfo list and prevent you from being usable by
1653 if (hint->enforce_mask == ENABLE_SEQSCAN ||
1654 hint->enforce_mask == ENABLE_TIDSCAN)
1656 list_free_deep(rel->indexlist);
1657 rel->indexlist = NIL;
1658 hint->base.state = HINT_STATE_USED;
1664 * When a list of indexes is not specified, we just use all indexes.
1666 if (hint->indexnames == NIL)
1670 * Leaving only an specified index, we delete it from a IndexOptInfo list
1674 for (cell = list_head(rel->indexlist); cell; cell = next)
1676 IndexOptInfo *info = (IndexOptInfo *) lfirst(cell);
1677 char *indexname = get_rel_name(info->indexoid);
1679 bool use_index = false;
1683 foreach(l, hint->indexnames)
1685 if (RelnameCmp(&indexname, &lfirst(l)) == 0)
1693 rel->indexlist = list_delete_cell(rel->indexlist, cell, prev);
1702 pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
1703 bool inhparent, RelOptInfo *rel)
1705 ScanMethodHint *hint;
1707 if (prev_get_relation_info)
1708 (*prev_get_relation_info) (root, relationObjectId, inhparent, rel);
1710 /* 有効なヒントが指定されなかった場合は処理をスキップする。 */
1716 /* store does relids of parent table. */
1717 current_hint->parent_relid = rel->relid;
1719 else if (current_hint->parent_relid != 0)
1722 * We use the same GUC parameter if this table is the child table of a
1723 * table called pg_hint_plan_get_relation_info just before that.
1727 /* append_rel_list contains all append rels; ignore others */
1728 foreach(l, root->append_rel_list)
1730 AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l);
1732 /* This rel is child table. */
1733 if (appinfo->parent_relid == current_hint->parent_relid &&
1734 appinfo->child_relid == rel->relid)
1736 if (current_hint->parent_hint)
1737 delete_indexes(current_hint->parent_hint, rel);
1743 /* This rel is not inherit table. */
1744 current_hint->parent_relid = 0;
1745 current_hint->parent_hint = NULL;
1748 /* scan hint が指定されない場合は、GUCパラメータをリセットする。 */
1749 if ((hint = find_scan_hint(root, rel)) == NULL)
1751 set_scan_config_options(current_hint->init_scan_mask, current_hint->context);
1754 set_scan_config_options(hint->enforce_mask, current_hint->context);
1755 hint->base.state = HINT_STATE_USED;
1757 current_hint->parent_hint = hint;
1759 delete_indexes(hint, rel);
1763 * aliasnameがクエリ中に指定した別名と一致する場合は、そのインデックスを返し、一致
1765 * aliasnameがクエリ中に複数回指定された場合は、-1を返す。
1768 find_relid_aliasname(PlannerInfo *root, char *aliasname, List *initial_rels,
1774 for (i = 1; i < root->simple_rel_array_size; i++)
1778 if (root->simple_rel_array[i] == NULL)
1781 Assert(i == root->simple_rel_array[i]->relid);
1783 if (RelnameCmp(&aliasname, &root->simple_rte_array[i]->eref->aliasname)
1787 foreach(l, initial_rels)
1789 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
1791 if (rel->reloptkind == RELOPT_BASEREL)
1793 if (rel->relid != i)
1798 Assert(rel->reloptkind == RELOPT_JOINREL);
1800 if (!bms_is_member(i, rel->relids))
1807 ("Relation name \"%s\" is ambiguous.",
1822 * relidビットマスクと一致するヒントを探す
1824 static JoinMethodHint *
1825 find_join_hint(Relids joinrelids)
1830 join_hint = current_hint->join_hint_level[bms_num_members(joinrelids)];
1832 foreach(l, join_hint)
1834 JoinMethodHint *hint = (JoinMethodHint *) lfirst(l);
1836 if (bms_equal(joinrelids, hint->joinrelids))
1844 * 結合方式のヒントを使用しやすい構造に変換する。
1847 transform_join_hints(PlanHint *plan, PlannerInfo *root, int nbaserel,
1848 List *initial_rels, JoinMethodHint **join_method_hints)
1857 for (i = 0; i < plan->num_hints[HINT_TYPE_JOIN_METHOD]; i++)
1859 JoinMethodHint *hint = plan->join_hints[i];
1862 if (!hint_state_enabled(hint) || hint->nrels > nbaserel)
1865 bms_free(hint->joinrelids);
1866 hint->joinrelids = NULL;
1868 for (j = 0; j < hint->nrels; j++)
1870 char *relname = hint->relnames[j];
1872 relid = find_relid_aliasname(root, relname, initial_rels,
1873 hint->base.hint_str);
1876 hint->base.state = HINT_STATE_ERROR;
1881 if (bms_is_member(relid, hint->joinrelids))
1883 parse_ereport(hint->base.hint_str,
1884 ("Relation name \"%s\" is duplicated.", relname));
1885 hint->base.state = HINT_STATE_ERROR;
1889 hint->joinrelids = bms_add_member(hint->joinrelids, relid);
1892 if (relid <= 0 || hint->base.state == HINT_STATE_ERROR)
1895 plan->join_hint_level[hint->nrels] =
1896 lappend(plan->join_hint_level[hint->nrels], hint);
1900 * 有効なLeading ヒントが指定されている場合は、結合順にあわせてjoin method hint
1903 if (plan->num_hints[HINT_TYPE_LEADING] == 0)
1906 lhint = plan->leading_hint;
1907 if (!hint_state_enabled(lhint))
1910 /* Leading hint は、全ての join 方式が有効な hint として登録する */
1913 foreach(l, lhint->relations)
1915 char *relname = (char *)lfirst(l);
1916 JoinMethodHint *hint;
1919 find_relid_aliasname(root, relname, initial_rels, plan->hint_str);
1923 bms_free(joinrelids);
1930 if (bms_is_member(relid, joinrelids))
1932 parse_ereport(lhint->base.hint_str,
1933 ("Relation name \"%s\" is duplicated.", relname));
1934 lhint->base.state = HINT_STATE_ERROR;
1935 bms_free(joinrelids);
1939 joinrelids = bms_add_member(joinrelids, relid);
1945 hint = find_join_hint(joinrelids);
1949 * Here relnames is not set, since Relids bitmap is sufficient to
1950 * control paths of this query afterwards.
1952 hint = (JoinMethodHint *) JoinMethodHintCreate(lhint->base.hint_str,
1954 hint->base.state = HINT_STATE_USED;
1955 hint->nrels = njoinrels;
1956 hint->enforce_mask = ENABLE_ALL_JOIN;
1957 hint->joinrelids = bms_copy(joinrelids);
1960 join_method_hints[njoinrels] = hint;
1962 if (njoinrels >= nbaserel)
1966 bms_free(joinrelids);
1971 for (i = 2; i <= njoinrels; i++)
1973 /* Leading で指定した組み合わせ以外の join hint を削除する */
1974 list_free(plan->join_hint_level[i]);
1976 plan->join_hint_level[i] = lappend(NIL, join_method_hints[i]);
1979 if (hint_state_enabled(lhint))
1980 set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
1982 lhint->base.state = HINT_STATE_USED;
1987 * set_plain_rel_pathlist
1988 * Build access paths for a plain relation (no subquery, no inheritance)
1990 * This function was copied and edited from set_plain_rel_pathlist() in
1991 * src/backend/optimizer/path/allpaths.c
1994 set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
1996 /* Consider sequential scan */
1997 add_path(rel, create_seqscan_path(root, rel));
1999 /* Consider index scans */
2000 create_index_paths(root, rel);
2002 /* Consider TID scans */
2003 create_tidscan_paths(root, rel);
2005 /* Now find the cheapest of the paths for this rel */
2010 rebuild_scan_path(PlanHint *plan, PlannerInfo *root, int level,
2015 foreach(l, initial_rels)
2017 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
2019 ScanMethodHint *hint;
2022 * スキャン方式が選択できるリレーションのみ、スキャンパスを再生成
2025 if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
2028 rte = root->simple_rte_array[rel->relid];
2030 /* 外部表はスキャン方式が選択できない。 */
2031 if (rte->relkind == RELKIND_FOREIGN_TABLE)
2035 * scan method hint が指定されていなければ、初期値のGUCパラメータでscan
2038 if ((hint = find_scan_hint(root, rel)) == NULL)
2039 set_scan_config_options(plan->init_scan_mask, plan->context);
2042 set_scan_config_options(hint->enforce_mask, plan->context);
2043 hint->base.state = HINT_STATE_USED;
2046 list_free_deep(rel->pathlist);
2047 rel->pathlist = NIL;
2050 /* It's an "append relation", process accordingly */
2051 set_append_rel_pathlist(root, rel, rel->relid, rte);
2055 set_plain_rel_pathlist(root, rel, rte);
2060 * Restore the GUC variables we set above.
2062 set_scan_config_options(plan->init_scan_mask, plan->context);
2066 * make_join_rel() をラップする関数
2068 * ヒントにしたがって、enabele_* パラメータを変更した上で、make_join_rel()を
2072 make_join_rel_wrapper(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
2075 JoinMethodHint *hint;
2079 joinrelids = bms_union(rel1->relids, rel2->relids);
2080 hint = find_join_hint(joinrelids);
2081 bms_free(joinrelids);
2084 return pg_hint_plan_make_join_rel(root, rel1, rel2);
2086 save_nestlevel = NewGUCNestLevel();
2088 set_join_config_options(hint->enforce_mask, current_hint->context);
2090 rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
2091 hint->base.state = HINT_STATE_USED;
2094 * Restore the GUC variables we set above.
2096 AtEOXact_GUC(true, save_nestlevel);
2102 get_num_baserels(List *initial_rels)
2107 foreach(l, initial_rels)
2109 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
2111 if (rel->reloptkind == RELOPT_BASEREL)
2113 else if (rel->reloptkind ==RELOPT_JOINREL)
2114 nbaserel+= bms_num_members(rel->relids);
2117 /* other values not expected here */
2118 elog(ERROR, "Unrecognized reloptkind type: %d", rel->reloptkind);
2126 pg_hint_plan_join_search(PlannerInfo *root, int levels_needed,
2129 JoinMethodHint **join_method_hints;
2135 * pg_hint_planが無効、または有効なヒントが1つも指定されなかった場合は、標準
2140 if (prev_join_search)
2141 return (*prev_join_search) (root, levels_needed, initial_rels);
2142 else if (enable_geqo && levels_needed >= geqo_threshold)
2143 return geqo(root, levels_needed, initial_rels);
2145 return standard_join_search(root, levels_needed, initial_rels);
2148 /* We apply scan method hint rebuild scan path. */
2149 rebuild_scan_path(current_hint, root, levels_needed, initial_rels);
2152 * GEQOを使用する条件を満たした場合は、GEQOを用いた結合方式の検索を行う。
2153 * このとき、スキャン方式のヒントとSetヒントのみが有効になり、結合方式や結合
2154 * 順序はヒント句は無効になりGEQOのアルゴリズムで決定される。
2156 if (enable_geqo && levels_needed >= geqo_threshold)
2157 return geqo(root, levels_needed, initial_rels);
2159 nbaserel = get_num_baserels(initial_rels);
2160 current_hint->join_hint_level = palloc0(sizeof(List *) * (nbaserel + 1));
2161 join_method_hints = palloc0(sizeof(JoinMethodHint *) * (nbaserel + 1));
2163 transform_join_hints(current_hint, root, nbaserel, initial_rels,
2166 rel = pg_hint_plan_standard_join_search(root, levels_needed, initial_rels);
2168 for (i = 2; i <= nbaserel; i++)
2170 list_free(current_hint->join_hint_level[i]);
2172 /* free Leading hint only */
2173 if (join_method_hints[i] != NULL &&
2174 join_method_hints[i]->enforce_mask == ENABLE_ALL_JOIN)
2175 JoinMethodHintDelete(join_method_hints[i]);
2177 pfree(current_hint->join_hint_level);
2178 pfree(join_method_hints);
2180 if (current_hint->num_hints[HINT_TYPE_LEADING] > 0 &&
2181 hint_state_enabled(current_hint->leading_hint))
2182 set_join_config_options(current_hint->init_join_mask, current_hint->context);
2189 * Build access paths for a base relation
2191 * This function was copied and edited from set_rel_pathlist() in
2192 * src/backend/optimizer/path/allpaths.c
2195 set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
2196 Index rti, RangeTblEntry *rte)
2200 /* It's an "append relation", process accordingly */
2201 set_append_rel_pathlist(root, rel, rti, rte);
2205 if (rel->rtekind == RTE_RELATION)
2207 if (rte->relkind == RELKIND_RELATION)
2209 /* Plain relation */
2210 set_plain_rel_pathlist(root, rel, rte);
2213 elog(ERROR, "Unexpected relkind: %c", rte->relkind);
2216 elog(ERROR, "Unexpected rtekind: %d", (int) rel->rtekind);
2220 #define standard_join_search pg_hint_plan_standard_join_search
2221 #define join_search_one_level pg_hint_plan_join_search_one_level
2222 #define make_join_rel make_join_rel_wrapper
2225 #undef make_join_rel
2226 #define make_join_rel pg_hint_plan_make_join_rel
2227 #define add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype, sjinfo, restrictlist) \
2229 ScanMethodHint *hint = NULL; \
2230 if ((hint = find_scan_hint((root), (innerrel))) != NULL) \
2232 set_scan_config_options(hint->enforce_mask, current_hint->context); \
2233 hint->base.state = HINT_STATE_USED; \
2235 add_paths_to_joinrel((root), (joinrel), (outerrel), (innerrel), (jointype), (sjinfo), (restrictlist)); \
2237 set_scan_config_options(current_hint->init_scan_mask, current_hint->context); \
2239 #include "make_join_rel.c"