1 /*-------------------------------------------------------------------------
4 * do instructions or hints to the planner using C-style block comments
7 * Copyright (c) 2012-2013, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
9 *-------------------------------------------------------------------------
12 #include "catalog/pg_collation.h"
13 #include "catalog/pg_index.h"
14 #include "commands/prepare.h"
15 #include "mb/pg_wchar.h"
16 #include "miscadmin.h"
17 #include "nodes/nodeFuncs.h"
18 #include "optimizer/clauses.h"
19 #include "optimizer/cost.h"
20 #include "optimizer/geqo.h"
21 #include "optimizer/joininfo.h"
22 #include "optimizer/pathnode.h"
23 #include "optimizer/paths.h"
24 #include "optimizer/plancat.h"
25 #include "optimizer/planner.h"
26 #include "optimizer/prep.h"
27 #include "optimizer/restrictinfo.h"
28 #include "parser/scansup.h"
29 #include "tcop/utility.h"
30 #include "utils/builtins.h"
31 #include "utils/lsyscache.h"
32 #include "utils/memutils.h"
33 #include "utils/rel.h"
34 #include "utils/syscache.h"
35 #if PG_VERSION_NUM >= 90200
36 #include "catalog/pg_class.h"
39 #include "executor/spi.h"
40 #include "catalog/pg_type.h"
42 * We have our own header file "plpgsql-9.1", which is necessary to support
43 * hints for queries in PL/pgSQL blocks, in pg_hint_plan source package,
44 * because PostgreSQL 9.1 doesn't provide the header file as a part of
45 * installation. This header file is a copy of src/pl/plpgsql/src/plpgsql.h in
46 * PostgreSQL 9.1.9 source tree,
48 * On the other hand, 9.2 installation provides that header file for external
49 * modules, so we include the header in ordinary place.
51 #if PG_VERSION_NUM >= 90200
54 #include "plpgsql-9.1.h"
57 /* partially copied from pg_stat_statements */
58 #include "normalize_query.h"
60 #ifdef PG_MODULE_MAGIC
64 #if PG_VERSION_NUM < 90100
65 #error unsupported PostgreSQL version
68 #define BLOCK_COMMENT_START "/*"
69 #define BLOCK_COMMENT_END "*/"
70 #define HINT_COMMENT_KEYWORD "+"
71 #define HINT_START BLOCK_COMMENT_START HINT_COMMENT_KEYWORD
72 #define HINT_END BLOCK_COMMENT_END
75 #define HINT_SEQSCAN "SeqScan"
76 #define HINT_INDEXSCAN "IndexScan"
77 #define HINT_INDEXSCANREGEXP "IndexScanRegexp"
78 #define HINT_BITMAPSCAN "BitmapScan"
79 #define HINT_BITMAPSCANREGEXP "BitmapScanRegexp"
80 #define HINT_TIDSCAN "TidScan"
81 #define HINT_NOSEQSCAN "NoSeqScan"
82 #define HINT_NOINDEXSCAN "NoIndexScan"
83 #define HINT_NOBITMAPSCAN "NoBitmapScan"
84 #define HINT_NOTIDSCAN "NoTidScan"
85 #if PG_VERSION_NUM >= 90200
86 #define HINT_INDEXONLYSCAN "IndexOnlyScan"
87 #define HINT_INDEXONLYSCANREGEXP "IndexOnlyScanRegexp"
88 #define HINT_NOINDEXONLYSCAN "NoIndexOnlyScan"
90 #define HINT_NESTLOOP "NestLoop"
91 #define HINT_MERGEJOIN "MergeJoin"
92 #define HINT_HASHJOIN "HashJoin"
93 #define HINT_NONESTLOOP "NoNestLoop"
94 #define HINT_NOMERGEJOIN "NoMergeJoin"
95 #define HINT_NOHASHJOIN "NoHashJoin"
96 #define HINT_LEADING "Leading"
97 #define HINT_SET "Set"
99 #define HINT_ARRAY_DEFAULT_INITSIZE 8
101 #define hint_ereport(str, detail) \
102 ereport(pg_hint_plan_parse_messages, \
103 (errmsg("hint syntax error at or near \"%s\"", (str)), \
106 #define skip_space(str) \
107 while (isspace(*str)) \
112 ENABLE_SEQSCAN = 0x01,
113 ENABLE_INDEXSCAN = 0x02,
114 ENABLE_BITMAPSCAN = 0x04,
115 ENABLE_TIDSCAN = 0x08,
116 #if PG_VERSION_NUM >= 90200
117 ENABLE_INDEXONLYSCAN = 0x10
123 ENABLE_NESTLOOP = 0x01,
124 ENABLE_MERGEJOIN = 0x02,
125 ENABLE_HASHJOIN = 0x04
128 #if PG_VERSION_NUM >= 90200
129 #define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
130 ENABLE_BITMAPSCAN | ENABLE_TIDSCAN | \
131 ENABLE_INDEXONLYSCAN)
133 #define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
134 ENABLE_BITMAPSCAN | ENABLE_TIDSCAN)
136 #define ENABLE_ALL_JOIN (ENABLE_NESTLOOP | ENABLE_MERGEJOIN | ENABLE_HASHJOIN)
137 #define DISABLE_ALL_SCAN 0
138 #define DISABLE_ALL_JOIN 0
140 /* hint keyword of enum type*/
141 typedef enum HintKeyword
143 HINT_KEYWORD_SEQSCAN,
144 HINT_KEYWORD_INDEXSCAN,
145 HINT_KEYWORD_INDEXSCANREGEXP,
146 HINT_KEYWORD_BITMAPSCAN,
147 HINT_KEYWORD_BITMAPSCANREGEXP,
148 HINT_KEYWORD_TIDSCAN,
149 HINT_KEYWORD_NOSEQSCAN,
150 HINT_KEYWORD_NOINDEXSCAN,
151 HINT_KEYWORD_NOBITMAPSCAN,
152 HINT_KEYWORD_NOTIDSCAN,
153 #if PG_VERSION_NUM >= 90200
154 HINT_KEYWORD_INDEXONLYSCAN,
155 HINT_KEYWORD_INDEXONLYSCANREGEXP,
156 HINT_KEYWORD_NOINDEXONLYSCAN,
158 HINT_KEYWORD_NESTLOOP,
159 HINT_KEYWORD_MERGEJOIN,
160 HINT_KEYWORD_HASHJOIN,
161 HINT_KEYWORD_NONESTLOOP,
162 HINT_KEYWORD_NOMERGEJOIN,
163 HINT_KEYWORD_NOHASHJOIN,
164 HINT_KEYWORD_LEADING,
166 HINT_KEYWORD_UNRECOGNIZED
169 typedef struct Hint Hint;
170 typedef struct HintState HintState;
172 typedef Hint *(*HintCreateFunction) (const char *hint_str,
174 HintKeyword hint_keyword);
175 typedef void (*HintDeleteFunction) (Hint *hint);
176 typedef void (*HintDescFunction) (Hint *hint, StringInfo buf);
177 typedef int (*HintCmpFunction) (const Hint *a, const Hint *b);
178 typedef const char *(*HintParseFunction) (Hint *hint, HintState *hstate,
179 Query *parse, const char *str);
182 #define NUM_HINT_TYPE 4
183 typedef enum HintType
185 HINT_TYPE_SCAN_METHOD,
186 HINT_TYPE_JOIN_METHOD,
191 static const char *HintTypeName[] = {
199 typedef enum HintStatus
201 HINT_STATE_NOTUSED = 0, /* specified relation not used in query */
202 HINT_STATE_USED, /* hint is used */
203 HINT_STATE_DUPLICATION, /* specified hint duplication */
204 HINT_STATE_ERROR /* execute error (parse error does not include
208 #define hint_state_enabled(hint) ((hint)->base.state == HINT_STATE_NOTUSED || \
209 (hint)->base.state == HINT_STATE_USED)
211 /* common data for all hints. */
214 const char *hint_str; /* must not do pfree */
215 const char *keyword; /* must not do pfree */
216 HintKeyword hint_keyword;
219 HintDeleteFunction delete_func;
220 HintDescFunction desc_func;
221 HintCmpFunction cmp_func;
222 HintParseFunction parse_func;
225 /* scan method hints */
226 typedef struct ScanMethodHint
232 unsigned char enforce_mask;
235 typedef struct ParentIndexInfo
240 char *expression_str;
247 /* join method hints */
248 typedef struct JoinMethodHint
254 unsigned char enforce_mask;
256 Relids inner_joinrelids;
259 /* join order hints */
260 typedef struct OuterInnerRels
263 List *outer_inner_pair;
266 typedef struct LeadingHint
269 List *relations; /* relation names specified in Leading hint */
270 OuterInnerRels *outer_inner;
273 /* change a run-time parameter hints */
274 typedef struct SetHint
277 char *name; /* name of variable */
283 * Describes a context of hint processing.
287 char *hint_str; /* original hint string */
290 int nall_hints; /* # of valid all hints */
291 int max_all_hints; /* # of slots for all hints */
292 Hint **all_hints; /* parsed all hints */
294 /* # of each hints */
295 int num_hints[NUM_HINT_TYPE];
297 /* for scan method hints */
298 ScanMethodHint **scan_hints; /* parsed scan hints */
299 int init_scan_mask; /* initial value scan parameter */
300 Index parent_relid; /* inherit parent table relid */
301 Oid parent_rel_oid; /* inherit parent table relid */
302 ScanMethodHint *parent_hint; /* inherit parent table scan hint */
303 List *parent_index_infos; /* infomation of inherit parent table's
306 /* for join method hints */
307 JoinMethodHint **join_hints; /* parsed join hints */
308 int init_join_mask; /* initial value join parameter */
309 List **join_hint_level;
311 /* for Leading hint */
312 LeadingHint **leading_hint; /* parsed Leading hints */
315 SetHint **set_hints; /* parsed Set hints */
316 GucContext context; /* which GUC parameters can we set? */
320 * Describes a hint parser module which is bound with particular hint keyword.
322 typedef struct HintParser
325 HintCreateFunction create_func;
326 HintKeyword hint_keyword;
329 /* Module callbacks */
333 static void push_hint(HintState *hstate);
334 static void pop_hint(void);
336 static void pg_hint_plan_ProcessUtility(Node *parsetree,
337 const char *queryString,
338 ParamListInfo params, bool isTopLevel,
340 char *completionTag);
341 static PlannedStmt *pg_hint_plan_planner(Query *parse, int cursorOptions,
342 ParamListInfo boundParams);
343 static void pg_hint_plan_get_relation_info(PlannerInfo *root,
344 Oid relationObjectId,
345 bool inhparent, RelOptInfo *rel);
346 static RelOptInfo *pg_hint_plan_join_search(PlannerInfo *root,
350 static Hint *ScanMethodHintCreate(const char *hint_str, const char *keyword,
351 HintKeyword hint_keyword);
352 static void ScanMethodHintDelete(ScanMethodHint *hint);
353 static void ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf);
354 static int ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b);
355 static const char *ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate,
356 Query *parse, const char *str);
357 static Hint *JoinMethodHintCreate(const char *hint_str, const char *keyword,
358 HintKeyword hint_keyword);
359 static void JoinMethodHintDelete(JoinMethodHint *hint);
360 static void JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf);
361 static int JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b);
362 static const char *JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate,
363 Query *parse, const char *str);
364 static Hint *LeadingHintCreate(const char *hint_str, const char *keyword,
365 HintKeyword hint_keyword);
366 static void LeadingHintDelete(LeadingHint *hint);
367 static void LeadingHintDesc(LeadingHint *hint, StringInfo buf);
368 static int LeadingHintCmp(const LeadingHint *a, const LeadingHint *b);
369 static const char *LeadingHintParse(LeadingHint *hint, HintState *hstate,
370 Query *parse, const char *str);
371 static Hint *SetHintCreate(const char *hint_str, const char *keyword,
372 HintKeyword hint_keyword);
373 static void SetHintDelete(SetHint *hint);
374 static void SetHintDesc(SetHint *hint, StringInfo buf);
375 static int SetHintCmp(const SetHint *a, const SetHint *b);
376 static const char *SetHintParse(SetHint *hint, HintState *hstate, Query *parse,
379 static void quote_value(StringInfo buf, const char *value);
381 static const char *parse_quoted_value(const char *str, char **word,
384 RelOptInfo *pg_hint_plan_standard_join_search(PlannerInfo *root,
387 void pg_hint_plan_join_search_one_level(PlannerInfo *root, int level);
388 static void make_rels_by_clause_joins(PlannerInfo *root, RelOptInfo *old_rel,
389 ListCell *other_rels);
390 static void make_rels_by_clauseless_joins(PlannerInfo *root,
392 ListCell *other_rels);
393 static bool has_join_restriction(PlannerInfo *root, RelOptInfo *rel);
394 static void set_append_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
395 Index rti, RangeTblEntry *rte);
396 #if PG_VERSION_NUM >= 90200
397 static void generate_mergeappend_paths(PlannerInfo *root, RelOptInfo *rel,
398 List *live_childrels,
399 List *all_child_pathkeys);
401 static List *accumulate_append_subpath(List *subpaths, Path *path);
402 #if PG_VERSION_NUM < 90200
403 static void set_dummy_rel_pathlist(RelOptInfo *rel);
405 RelOptInfo *pg_hint_plan_make_join_rel(PlannerInfo *root, RelOptInfo *rel1,
408 static void pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate,
410 static void pg_hint_plan_plpgsql_stmt_end(PLpgSQL_execstate *estate,
414 static bool pg_hint_plan_enable_hint = true;
415 static bool pg_hint_plan_debug_print = false;
416 static int pg_hint_plan_parse_messages = INFO;
417 static bool pg_hint_plan_lookup_hint_in_table = false;
419 static const struct config_enum_entry parse_messages_level_options[] = {
420 {"debug", DEBUG2, true},
421 {"debug5", DEBUG5, false},
422 {"debug4", DEBUG4, false},
423 {"debug3", DEBUG3, false},
424 {"debug2", DEBUG2, false},
425 {"debug1", DEBUG1, false},
427 {"info", INFO, false},
428 {"notice", NOTICE, false},
429 {"warning", WARNING, false},
430 {"error", ERROR, false},
432 * {"fatal", FATAL, true},
433 * {"panic", PANIC, true},
438 /* Saved hook values in case of unload */
439 static ProcessUtility_hook_type prev_ProcessUtility = NULL;
440 static planner_hook_type prev_planner = NULL;
441 static get_relation_info_hook_type prev_get_relation_info = NULL;
442 static join_search_hook_type prev_join_search = NULL;
444 /* Hold reference to currently active hint */
445 static HintState *current_hint = NULL;
448 * List of hint contexts. We treat the head of the list as the Top of the
449 * context stack, so current_hint always points the first element of this list.
451 static List *HintStateStack = NIL;
454 * Holds statement name during executing EXECUTE command. NULL for other
457 static char *stmt_name = NULL;
459 static const HintParser parsers[] = {
460 {HINT_SEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_SEQSCAN},
461 {HINT_INDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCAN},
462 {HINT_INDEXSCANREGEXP, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCANREGEXP},
463 {HINT_BITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_BITMAPSCAN},
464 {HINT_BITMAPSCANREGEXP, ScanMethodHintCreate,
465 HINT_KEYWORD_BITMAPSCANREGEXP},
466 {HINT_TIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_TIDSCAN},
467 {HINT_NOSEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOSEQSCAN},
468 {HINT_NOINDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXSCAN},
469 {HINT_NOBITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOBITMAPSCAN},
470 {HINT_NOTIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOTIDSCAN},
471 #if PG_VERSION_NUM >= 90200
472 {HINT_INDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXONLYSCAN},
473 {HINT_INDEXONLYSCANREGEXP, ScanMethodHintCreate,
474 HINT_KEYWORD_INDEXONLYSCANREGEXP},
475 {HINT_NOINDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXONLYSCAN},
477 {HINT_NESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NESTLOOP},
478 {HINT_MERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_MERGEJOIN},
479 {HINT_HASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_HASHJOIN},
480 {HINT_NONESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NONESTLOOP},
481 {HINT_NOMERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOMERGEJOIN},
482 {HINT_NOHASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOHASHJOIN},
483 {HINT_LEADING, LeadingHintCreate, HINT_KEYWORD_LEADING},
484 {HINT_SET, SetHintCreate, HINT_KEYWORD_SET},
485 {NULL, NULL, HINT_KEYWORD_UNRECOGNIZED}
489 * PL/pgSQL plugin for retrieving string representation of each query during
490 * function execution.
492 const char *plpgsql_query_string = NULL;
493 PLpgSQL_plugin plugin_funcs = {
497 pg_hint_plan_plpgsql_stmt_beg,
498 pg_hint_plan_plpgsql_stmt_end,
503 /* Current nesting depth of SPI calls, used to prevent recursive calls */
504 static int nested_level = 0;
507 * Module load callbacks
512 PLpgSQL_plugin **var_ptr;
514 /* Define custom GUC variables. */
515 DefineCustomBoolVariable("pg_hint_plan.enable_hint",
516 "Force planner to use plans specified in the hint comment preceding to the query.",
518 &pg_hint_plan_enable_hint,
526 DefineCustomBoolVariable("pg_hint_plan.debug_print",
527 "Logs results of hint parsing.",
529 &pg_hint_plan_debug_print,
537 DefineCustomEnumVariable("pg_hint_plan.parse_messages",
538 "Message level of parse errors.",
540 &pg_hint_plan_parse_messages,
542 parse_messages_level_options,
549 DefineCustomBoolVariable("pg_hint_plan.lookup_hint_in_table",
550 "Force planner to not get hint by using table lookups.",
552 &pg_hint_plan_lookup_hint_in_table,
561 prev_ProcessUtility = ProcessUtility_hook;
562 ProcessUtility_hook = pg_hint_plan_ProcessUtility;
563 prev_planner = planner_hook;
564 planner_hook = pg_hint_plan_planner;
565 prev_get_relation_info = get_relation_info_hook;
566 get_relation_info_hook = pg_hint_plan_get_relation_info;
567 prev_join_search = join_search_hook;
568 join_search_hook = pg_hint_plan_join_search;
570 /* setup PL/pgSQL plugin hook */
571 var_ptr = (PLpgSQL_plugin **) find_rendezvous_variable("PLpgSQL_plugin");
572 *var_ptr = &plugin_funcs;
576 * Module unload callback
582 PLpgSQL_plugin **var_ptr;
584 /* Uninstall hooks. */
585 ProcessUtility_hook = prev_ProcessUtility;
586 planner_hook = prev_planner;
587 get_relation_info_hook = prev_get_relation_info;
588 join_search_hook = prev_join_search;
590 /* uninstall PL/pgSQL plugin hook */
591 var_ptr = (PLpgSQL_plugin **) find_rendezvous_variable("PLpgSQL_plugin");
596 * create and delete functions the hint object
600 ScanMethodHintCreate(const char *hint_str, const char *keyword,
601 HintKeyword hint_keyword)
603 ScanMethodHint *hint;
605 hint = palloc(sizeof(ScanMethodHint));
606 hint->base.hint_str = hint_str;
607 hint->base.keyword = keyword;
608 hint->base.hint_keyword = hint_keyword;
609 hint->base.type = HINT_TYPE_SCAN_METHOD;
610 hint->base.state = HINT_STATE_NOTUSED;
611 hint->base.delete_func = (HintDeleteFunction) ScanMethodHintDelete;
612 hint->base.desc_func = (HintDescFunction) ScanMethodHintDesc;
613 hint->base.cmp_func = (HintCmpFunction) ScanMethodHintCmp;
614 hint->base.parse_func = (HintParseFunction) ScanMethodHintParse;
615 hint->relname = NULL;
616 hint->indexnames = NIL;
617 hint->regexp = false;
618 hint->enforce_mask = 0;
620 return (Hint *) hint;
624 ScanMethodHintDelete(ScanMethodHint *hint)
630 pfree(hint->relname);
631 list_free_deep(hint->indexnames);
636 JoinMethodHintCreate(const char *hint_str, const char *keyword,
637 HintKeyword hint_keyword)
639 JoinMethodHint *hint;
641 hint = palloc(sizeof(JoinMethodHint));
642 hint->base.hint_str = hint_str;
643 hint->base.keyword = keyword;
644 hint->base.hint_keyword = hint_keyword;
645 hint->base.type = HINT_TYPE_JOIN_METHOD;
646 hint->base.state = HINT_STATE_NOTUSED;
647 hint->base.delete_func = (HintDeleteFunction) JoinMethodHintDelete;
648 hint->base.desc_func = (HintDescFunction) JoinMethodHintDesc;
649 hint->base.cmp_func = (HintCmpFunction) JoinMethodHintCmp;
650 hint->base.parse_func = (HintParseFunction) JoinMethodHintParse;
652 hint->inner_nrels = 0;
653 hint->relnames = NULL;
654 hint->enforce_mask = 0;
655 hint->joinrelids = NULL;
656 hint->inner_joinrelids = NULL;
658 return (Hint *) hint;
662 JoinMethodHintDelete(JoinMethodHint *hint)
671 for (i = 0; i < hint->nrels; i++)
672 pfree(hint->relnames[i]);
673 pfree(hint->relnames);
676 bms_free(hint->joinrelids);
677 bms_free(hint->inner_joinrelids);
682 LeadingHintCreate(const char *hint_str, const char *keyword,
683 HintKeyword hint_keyword)
687 hint = palloc(sizeof(LeadingHint));
688 hint->base.hint_str = hint_str;
689 hint->base.keyword = keyword;
690 hint->base.hint_keyword = hint_keyword;
691 hint->base.type = HINT_TYPE_LEADING;
692 hint->base.state = HINT_STATE_NOTUSED;
693 hint->base.delete_func = (HintDeleteFunction)LeadingHintDelete;
694 hint->base.desc_func = (HintDescFunction) LeadingHintDesc;
695 hint->base.cmp_func = (HintCmpFunction) LeadingHintCmp;
696 hint->base.parse_func = (HintParseFunction) LeadingHintParse;
697 hint->relations = NIL;
698 hint->outer_inner = NULL;
700 return (Hint *) hint;
704 LeadingHintDelete(LeadingHint *hint)
709 list_free_deep(hint->relations);
710 if (hint->outer_inner)
711 pfree(hint->outer_inner);
716 SetHintCreate(const char *hint_str, const char *keyword,
717 HintKeyword hint_keyword)
721 hint = palloc(sizeof(SetHint));
722 hint->base.hint_str = hint_str;
723 hint->base.keyword = keyword;
724 hint->base.hint_keyword = hint_keyword;
725 hint->base.type = HINT_TYPE_SET;
726 hint->base.state = HINT_STATE_NOTUSED;
727 hint->base.delete_func = (HintDeleteFunction) SetHintDelete;
728 hint->base.desc_func = (HintDescFunction) SetHintDesc;
729 hint->base.cmp_func = (HintCmpFunction) SetHintCmp;
730 hint->base.parse_func = (HintParseFunction) SetHintParse;
735 return (Hint *) hint;
739 SetHintDelete(SetHint *hint)
749 list_free(hint->words);
754 HintStateCreate(void)
758 hstate = palloc(sizeof(HintState));
759 hstate->hint_str = NULL;
760 hstate->nall_hints = 0;
761 hstate->max_all_hints = 0;
762 hstate->all_hints = NULL;
763 memset(hstate->num_hints, 0, sizeof(hstate->num_hints));
764 hstate->scan_hints = NULL;
765 hstate->init_scan_mask = 0;
766 hstate->parent_relid = 0;
767 hstate->parent_rel_oid = InvalidOid;
768 hstate->parent_hint = NULL;
769 hstate->parent_index_infos = NIL;
770 hstate->join_hints = NULL;
771 hstate->init_join_mask = 0;
772 hstate->join_hint_level = NULL;
773 hstate->leading_hint = NULL;
774 hstate->context = superuser() ? PGC_SUSET : PGC_USERSET;
775 hstate->set_hints = NULL;
781 HintStateDelete(HintState *hstate)
788 if (hstate->hint_str)
789 pfree(hstate->hint_str);
791 for (i = 0; i < hstate->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
792 hstate->all_hints[i]->delete_func(hstate->all_hints[i]);
793 if (hstate->all_hints)
794 pfree(hstate->all_hints);
795 if (hstate->parent_index_infos)
796 list_free(hstate->parent_index_infos);
800 * Copy given value into buf, with quoting with '"' if necessary.
803 quote_value(StringInfo buf, const char *value)
805 bool need_quote = false;
808 for (str = value; *str != '\0'; str++)
810 if (isspace(*str) || *str == '(' || *str == ')' || *str == '"')
813 appendStringInfoCharMacro(buf, '"');
818 for (str = value; *str != '\0'; str++)
821 appendStringInfoCharMacro(buf, '"');
823 appendStringInfoCharMacro(buf, *str);
827 appendStringInfoCharMacro(buf, '"');
831 ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf)
835 appendStringInfo(buf, "%s(", hint->base.keyword);
836 if (hint->relname != NULL)
838 quote_value(buf, hint->relname);
839 foreach(l, hint->indexnames)
841 appendStringInfoCharMacro(buf, ' ');
842 quote_value(buf, (char *) lfirst(l));
845 appendStringInfoString(buf, ")\n");
849 JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf)
853 appendStringInfo(buf, "%s(", hint->base.keyword);
854 if (hint->relnames != NULL)
856 quote_value(buf, hint->relnames[0]);
857 for (i = 1; i < hint->nrels; i++)
859 appendStringInfoCharMacro(buf, ' ');
860 quote_value(buf, hint->relnames[i]);
863 appendStringInfoString(buf, ")\n");
868 OuterInnerDesc(OuterInnerRels *outer_inner, StringInfo buf)
870 if (outer_inner->relation == NULL)
877 appendStringInfoCharMacro(buf, '(');
878 foreach(l, outer_inner->outer_inner_pair)
883 appendStringInfoCharMacro(buf, ' ');
885 OuterInnerDesc(lfirst(l), buf);
888 appendStringInfoCharMacro(buf, ')');
891 quote_value(buf, outer_inner->relation);
895 LeadingHintDesc(LeadingHint *hint, StringInfo buf)
897 appendStringInfo(buf, "%s(", HINT_LEADING);
898 if (hint->outer_inner == NULL)
905 foreach(l, hint->relations)
910 appendStringInfoCharMacro(buf, ' ');
912 quote_value(buf, (char *) lfirst(l));
916 OuterInnerDesc(hint->outer_inner, buf);
918 appendStringInfoString(buf, ")\n");
922 SetHintDesc(SetHint *hint, StringInfo buf)
924 bool is_first = true;
927 appendStringInfo(buf, "%s(", HINT_SET);
928 foreach(l, hint->words)
933 appendStringInfoCharMacro(buf, ' ');
935 quote_value(buf, (char *) lfirst(l));
937 appendStringInfo(buf, ")\n");
941 * Append string which repserents all hints in a given state to buf, with
942 * preceding title with them.
945 desc_hint_in_state(HintState *hstate, StringInfo buf, const char *title,
950 appendStringInfo(buf, "%s:\n", title);
951 for (i = 0; i < hstate->nall_hints; i++)
953 if (hstate->all_hints[i]->state != state)
956 hstate->all_hints[i]->desc_func(hstate->all_hints[i], buf);
961 * Dump contents of given hstate to server log with log level LOG.
964 HintStateDump(HintState *hstate)
970 elog(LOG, "pg_hint_plan:\nno hint");
974 initStringInfo(&buf);
976 appendStringInfoString(&buf, "pg_hint_plan:\n");
977 desc_hint_in_state(hstate, &buf, "used hint", HINT_STATE_USED);
978 desc_hint_in_state(hstate, &buf, "not used hint", HINT_STATE_NOTUSED);
979 desc_hint_in_state(hstate, &buf, "duplication hint", HINT_STATE_DUPLICATION);
980 desc_hint_in_state(hstate, &buf, "error hint", HINT_STATE_ERROR);
982 elog(LOG, "%s", buf.data);
992 RelnameCmp(const void *a, const void *b)
994 const char *relnamea = *((const char **) a);
995 const char *relnameb = *((const char **) b);
997 return strcmp(relnamea, relnameb);
1001 ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b)
1003 return RelnameCmp(&a->relname, &b->relname);
1007 JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b)
1011 if (a->nrels != b->nrels)
1012 return a->nrels - b->nrels;
1014 for (i = 0; i < a->nrels; i++)
1017 if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0)
1025 LeadingHintCmp(const LeadingHint *a, const LeadingHint *b)
1031 SetHintCmp(const SetHint *a, const SetHint *b)
1033 return strcmp(a->name, b->name);
1037 HintCmp(const void *a, const void *b)
1039 const Hint *hinta = *((const Hint **) a);
1040 const Hint *hintb = *((const Hint **) b);
1042 if (hinta->type != hintb->type)
1043 return hinta->type - hintb->type;
1044 if (hinta->state == HINT_STATE_ERROR)
1046 if (hintb->state == HINT_STATE_ERROR)
1048 return hinta->cmp_func(hinta, hintb);
1052 * Returns byte offset of hint b from hint a. If hint a was specified before
1053 * b, positive value is returned.
1056 HintCmpWithPos(const void *a, const void *b)
1058 const Hint *hinta = *((const Hint **) a);
1059 const Hint *hintb = *((const Hint **) b);
1062 result = HintCmp(a, b);
1064 result = hinta->hint_str - hintb->hint_str;
1073 parse_keyword(const char *str, StringInfo buf)
1077 while (!isspace(*str) && *str != '(' && *str != '\0')
1078 appendStringInfoCharMacro(buf, *str++);
1084 skip_parenthesis(const char *str, char parenthesis)
1088 if (*str != parenthesis)
1090 if (parenthesis == '(')
1091 hint_ereport(str, ("Opening parenthesis is necessary."));
1092 else if (parenthesis == ')')
1093 hint_ereport(str, ("Closing parenthesis is necessary."));
1104 * Parse a token from str, and store malloc'd copy into word. A token can be
1105 * quoted with '"'. Return value is pointer to unparsed portion of original
1106 * string, or NULL if an error occurred.
1108 * Parsed token is truncated within NAMEDATALEN-1 bytes, when truncate is true.
1111 parse_quoted_value(const char *str, char **word, bool truncate)
1116 /* Skip leading spaces. */
1119 initStringInfo(&buf);
1132 /* Double quotation must be closed. */
1136 hint_ereport(str, ("Unterminated quoted string."));
1141 * Skip escaped double quotation.
1143 * We don't allow slash-asterisk and asterisk-slash (delimiters of
1144 * block comments) to be an object name, so users must specify
1145 * alias for such object names.
1147 * Those special names can be allowed if we care escaped slashes
1148 * and asterisks, but we don't.
1157 else if (isspace(*str) || *str == '(' || *str == ')' || *str == '"' ||
1161 appendStringInfoCharMacro(&buf, *str++);
1166 hint_ereport(str, ("Zero-length delimited string."));
1173 /* Truncate name if it's too long */
1175 truncate_identifier(buf.data, strlen(buf.data), true);
1182 static OuterInnerRels *
1183 OuterInnerRelsCreate(char *name, List *outer_inner_list)
1185 OuterInnerRels *outer_inner;
1187 outer_inner = palloc(sizeof(OuterInnerRels));
1188 outer_inner->relation = name;
1189 outer_inner->outer_inner_pair = outer_inner_list;
1195 parse_parentheses_Leading_in(const char *str, OuterInnerRels **outer_inner)
1197 List *outer_inner_pair = NIL;
1199 if ((str = skip_parenthesis(str, '(')) == NULL)
1204 /* Store words in parentheses into outer_inner_list. */
1205 while(*str != ')' && *str != '\0')
1207 OuterInnerRels *outer_inner_rels;
1211 str = parse_parentheses_Leading_in(str, &outer_inner_rels);
1219 if ((str = parse_quoted_value(str, &name, true)) == NULL)
1222 outer_inner_rels = OuterInnerRelsCreate(name, NIL);
1225 outer_inner_pair = lappend(outer_inner_pair, outer_inner_rels);
1230 (str = skip_parenthesis(str, ')')) == NULL)
1232 list_free(outer_inner_pair);
1236 *outer_inner = OuterInnerRelsCreate(NULL, outer_inner_pair);
1242 parse_parentheses_Leading(const char *str, List **name_list,
1243 OuterInnerRels **outer_inner)
1246 bool truncate = true;
1248 if ((str = skip_parenthesis(str, '(')) == NULL)
1254 if ((str = parse_parentheses_Leading_in(str, outer_inner)) == NULL)
1259 /* Store words in parentheses into name_list. */
1260 while(*str != ')' && *str != '\0')
1262 if ((str = parse_quoted_value(str, &name, truncate)) == NULL)
1264 list_free(*name_list);
1268 *name_list = lappend(*name_list, name);
1273 if ((str = skip_parenthesis(str, ')')) == NULL)
1279 parse_parentheses(const char *str, List **name_list, HintKeyword keyword)
1282 bool truncate = true;
1284 if ((str = skip_parenthesis(str, '(')) == NULL)
1289 /* Store words in parentheses into name_list. */
1290 while(*str != ')' && *str != '\0')
1292 if ((str = parse_quoted_value(str, &name, truncate)) == NULL)
1294 list_free(*name_list);
1298 *name_list = lappend(*name_list, name);
1301 if (keyword == HINT_KEYWORD_INDEXSCANREGEXP ||
1302 #if PG_VERSION_NUM >= 90200
1303 keyword == HINT_KEYWORD_INDEXONLYSCANREGEXP ||
1305 keyword == HINT_KEYWORD_BITMAPSCANREGEXP ||
1306 keyword == HINT_KEYWORD_SET)
1312 if ((str = skip_parenthesis(str, ')')) == NULL)
1318 parse_hints(HintState *hstate, Query *parse, const char *str)
1323 initStringInfo(&buf);
1324 while (*str != '\0')
1326 const HintParser *parser;
1328 /* in error message, we output the comment including the keyword. */
1329 head = (char *) str;
1331 /* parse only the keyword of the hint. */
1332 resetStringInfo(&buf);
1333 str = parse_keyword(str, &buf);
1335 for (parser = parsers; parser->keyword != NULL; parser++)
1337 char *keyword = parser->keyword;
1340 if (strcasecmp(buf.data, keyword) != 0)
1343 hint = parser->create_func(head, keyword, parser->hint_keyword);
1345 /* parser of each hint does parse in a parenthesis. */
1346 if ((str = hint->parse_func(hint, hstate, parse, str)) == NULL)
1348 hint->delete_func(hint);
1354 * Add hint information into all_hints array. If we don't have
1355 * enough space, double the array.
1357 if (hstate->nall_hints == 0)
1359 hstate->max_all_hints = HINT_ARRAY_DEFAULT_INITSIZE;
1360 hstate->all_hints = (Hint **)
1361 palloc(sizeof(Hint *) * hstate->max_all_hints);
1363 else if (hstate->nall_hints == hstate->max_all_hints)
1365 hstate->max_all_hints *= 2;
1366 hstate->all_hints = (Hint **)
1367 repalloc(hstate->all_hints,
1368 sizeof(Hint *) * hstate->max_all_hints);
1371 hstate->all_hints[hstate->nall_hints] = hint;
1372 hstate->nall_hints++;
1379 if (parser->keyword == NULL)
1382 ("Unrecognized hint keyword \"%s\".", buf.data));
1393 * Get hints from table by client-supplied query string and application name.
1396 get_hints_from_table(const char *client_query, const char *client_application)
1398 const char *search_query =
1400 " FROM hint_plan.hints "
1401 " WHERE norm_query_string = $1 "
1402 " AND ( application_name = $2 "
1403 " OR application_name = '' ) "
1404 " ORDER BY application_name DESC";
1405 static SPIPlanPtr plan = NULL;
1407 Oid argtypes[2] = { TEXTOID, TEXTOID };
1409 bool nulls[2] = { false, false };
1422 p = SPI_prepare(search_query, 2, argtypes);
1423 plan = SPI_saveplan(p);
1427 qry = cstring_to_text(client_query);
1428 app = cstring_to_text(client_application);
1429 values[0] = PointerGetDatum(qry);
1430 values[1] = PointerGetDatum(app);
1432 SPI_execute_plan(plan, values, nulls, true, 1);
1434 if (SPI_processed > 0)
1438 hints = SPI_getvalue(SPI_tuptable->vals[0],
1439 SPI_tuptable->tupdesc, 1);
1441 * Here we use SPI_palloc to ensure that hints string is valid even
1442 * after SPI_finish call. We can't use simple palloc because it
1443 * allocates memory in SPI's context and that context is deleted in
1446 buf = SPI_palloc(strlen(hints) + 1);
1466 * Get client-supplied query string.
1469 get_query_string(void)
1475 PreparedStatement *entry;
1477 entry = FetchPreparedStatement(stmt_name, true);
1478 p = entry->plansource->query_string;
1480 else if (plpgsql_query_string)
1481 p = plpgsql_query_string;
1483 p = debug_query_string;
1489 * Get hints from the head block comment in client-supplied query string.
1492 get_hints_from_comment(const char *p)
1494 const char *hint_head;
1502 /* extract query head comment. */
1503 hint_head = strstr(p, HINT_START);
1504 if (hint_head == NULL)
1506 for (;p < hint_head; p++)
1509 * Allow these characters precedes hint comment:
1511 * - alphabets which are in ASCII range
1512 * - space, tabs and new-lines
1513 * - underscores, for identifier
1514 * - commas, for SELECT clause, EXPLAIN and PREPARE
1515 * - parentheses, for EXPLAIN and PREPARE
1517 * Note that we don't use isalpha() nor isalnum() in ctype.h here to
1518 * avoid behavior which depends on locale setting.
1520 if (!(*p >= '0' && *p <= '9') &&
1521 !(*p >= 'A' && *p <= 'Z') &&
1522 !(*p >= 'a' && *p <= 'z') &&
1526 *p != '(' && *p != ')')
1530 len = strlen(HINT_START);
1535 /* find hint end keyword. */
1536 if ((tail = strstr(p, HINT_END)) == NULL)
1538 hint_ereport(head, ("Unterminated block comment."));
1542 /* We don't support nested block comments. */
1543 if ((head = strstr(p, BLOCK_COMMENT_START)) != NULL && head < tail)
1545 hint_ereport(head, ("Nested block comments are not supported."));
1549 /* Make a copy of hint. */
1551 head = palloc(len + 1);
1552 memcpy(head, p, len);
1560 * Parse hints that got, create hint struct from parse tree and parse hints.
1563 create_hintstate(Query *parse, const char *hints)
1573 hstate = HintStateCreate();
1574 hstate->hint_str = (char *) hints;
1576 /* parse each hint. */
1577 parse_hints(hstate, parse, p);
1579 /* When nothing specified a hint, we free HintState and returns NULL. */
1580 if (hstate->nall_hints == 0)
1582 HintStateDelete(hstate);
1586 /* Sort hints in order of original position. */
1587 qsort(hstate->all_hints, hstate->nall_hints, sizeof(Hint *),
1590 /* Count number of hints per hint-type. */
1591 for (i = 0; i < hstate->nall_hints; i++)
1593 Hint *cur_hint = hstate->all_hints[i];
1594 hstate->num_hints[cur_hint->type]++;
1598 * If an object (or a set of objects) has multiple hints of same hint-type,
1599 * only the last hint is valid and others are igonred in planning.
1600 * Hints except the last are marked as 'duplicated' to remember the order.
1602 for (i = 0; i < hstate->nall_hints - 1; i++)
1604 Hint *cur_hint = hstate->all_hints[i];
1605 Hint *next_hint = hstate->all_hints[i + 1];
1608 * Leading hint is marked as 'duplicated' in transform_join_hints.
1610 if (cur_hint->type == HINT_TYPE_LEADING &&
1611 next_hint->type == HINT_TYPE_LEADING)
1615 * Note that we need to pass addresses of hint pointers, because
1616 * HintCmp is designed to sort array of Hint* by qsort.
1618 if (HintCmp(&cur_hint, &next_hint) == 0)
1620 hint_ereport(cur_hint->hint_str,
1621 ("Conflict %s hint.", HintTypeName[cur_hint->type]));
1622 cur_hint->state = HINT_STATE_DUPLICATION;
1627 * Make sure that per-type array pointers point proper position in the
1628 * array which consists of all hints.
1630 hstate->scan_hints = (ScanMethodHint **) hstate->all_hints;
1631 hstate->join_hints = (JoinMethodHint **) (hstate->scan_hints +
1632 hstate->num_hints[HINT_TYPE_SCAN_METHOD]);
1633 hstate->leading_hint = (LeadingHint **) (hstate->join_hints +
1634 hstate->num_hints[HINT_TYPE_JOIN_METHOD]);
1635 hstate->set_hints = (SetHint **) (hstate->leading_hint +
1636 hstate->num_hints[HINT_TYPE_LEADING]);
1642 * Parse inside of parentheses of scan-method hints.
1645 ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse,
1648 const char *keyword = hint->base.keyword;
1649 HintKeyword hint_keyword = hint->base.hint_keyword;
1650 List *name_list = NIL;
1653 if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
1656 /* Parse relation name and index name(s) if given hint accepts. */
1657 length = list_length(name_list);
1660 hint->relname = linitial(name_list);
1661 hint->indexnames = list_delete_first(name_list);
1663 /* check whether the hint accepts index name(s). */
1665 hint_keyword != HINT_KEYWORD_INDEXSCAN &&
1666 hint_keyword != HINT_KEYWORD_INDEXSCANREGEXP &&
1667 #if PG_VERSION_NUM >= 90200
1668 hint_keyword != HINT_KEYWORD_INDEXONLYSCAN &&
1669 hint_keyword != HINT_KEYWORD_INDEXONLYSCANREGEXP &&
1671 hint_keyword != HINT_KEYWORD_BITMAPSCAN &&
1672 hint_keyword != HINT_KEYWORD_BITMAPSCANREGEXP)
1675 ("%s hint accepts only one relation.",
1676 hint->base.keyword));
1677 hint->base.state = HINT_STATE_ERROR;
1684 ("%s hint requires a relation.",
1685 hint->base.keyword));
1686 hint->base.state = HINT_STATE_ERROR;
1690 /* Set a bit for specified hint. */
1691 switch (hint_keyword)
1693 case HINT_KEYWORD_SEQSCAN:
1694 hint->enforce_mask = ENABLE_SEQSCAN;
1696 case HINT_KEYWORD_INDEXSCAN:
1697 hint->enforce_mask = ENABLE_INDEXSCAN;
1699 case HINT_KEYWORD_INDEXSCANREGEXP:
1700 hint->enforce_mask = ENABLE_INDEXSCAN;
1701 hint->regexp = true;
1703 case HINT_KEYWORD_BITMAPSCAN:
1704 hint->enforce_mask = ENABLE_BITMAPSCAN;
1706 case HINT_KEYWORD_BITMAPSCANREGEXP:
1707 hint->enforce_mask = ENABLE_BITMAPSCAN;
1708 hint->regexp = true;
1710 case HINT_KEYWORD_TIDSCAN:
1711 hint->enforce_mask = ENABLE_TIDSCAN;
1713 case HINT_KEYWORD_NOSEQSCAN:
1714 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_SEQSCAN;
1716 case HINT_KEYWORD_NOINDEXSCAN:
1717 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXSCAN;
1719 case HINT_KEYWORD_NOBITMAPSCAN:
1720 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_BITMAPSCAN;
1722 case HINT_KEYWORD_NOTIDSCAN:
1723 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_TIDSCAN;
1725 #if PG_VERSION_NUM >= 90200
1726 case HINT_KEYWORD_INDEXONLYSCAN:
1727 hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
1729 case HINT_KEYWORD_INDEXONLYSCANREGEXP:
1730 hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
1731 hint->regexp = true;
1733 case HINT_KEYWORD_NOINDEXONLYSCAN:
1734 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXONLYSCAN;
1738 hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
1747 JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate, Query *parse,
1750 const char *keyword = hint->base.keyword;
1751 HintKeyword hint_keyword = hint->base.hint_keyword;
1752 List *name_list = NIL;
1754 if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
1757 hint->nrels = list_length(name_list);
1759 if (hint->nrels > 0)
1765 * Transform relation names from list to array to sort them with qsort
1768 hint->relnames = palloc(sizeof(char *) * hint->nrels);
1769 foreach (l, name_list)
1771 hint->relnames[i] = lfirst(l);
1776 list_free(name_list);
1778 /* A join hint requires at least two relations */
1779 if (hint->nrels < 2)
1782 ("%s hint requires at least two relations.",
1783 hint->base.keyword));
1784 hint->base.state = HINT_STATE_ERROR;
1788 /* Sort hints in alphabetical order of relation names. */
1789 qsort(hint->relnames, hint->nrels, sizeof(char *), RelnameCmp);
1791 switch (hint_keyword)
1793 case HINT_KEYWORD_NESTLOOP:
1794 hint->enforce_mask = ENABLE_NESTLOOP;
1796 case HINT_KEYWORD_MERGEJOIN:
1797 hint->enforce_mask = ENABLE_MERGEJOIN;
1799 case HINT_KEYWORD_HASHJOIN:
1800 hint->enforce_mask = ENABLE_HASHJOIN;
1802 case HINT_KEYWORD_NONESTLOOP:
1803 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_NESTLOOP;
1805 case HINT_KEYWORD_NOMERGEJOIN:
1806 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_MERGEJOIN;
1808 case HINT_KEYWORD_NOHASHJOIN:
1809 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_HASHJOIN;
1812 hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
1821 OuterInnerPairCheck(OuterInnerRels *outer_inner)
1824 if (outer_inner->outer_inner_pair == NIL)
1826 if (outer_inner->relation)
1832 if (list_length(outer_inner->outer_inner_pair) == 2)
1834 foreach(l, outer_inner->outer_inner_pair)
1836 if (!OuterInnerPairCheck(lfirst(l)))
1847 OuterInnerList(OuterInnerRels *outer_inner)
1849 List *outer_inner_list = NIL;
1851 OuterInnerRels *outer_inner_rels;
1853 foreach(l, outer_inner->outer_inner_pair)
1855 outer_inner_rels = (OuterInnerRels *)(lfirst(l));
1857 if (outer_inner_rels->relation != NULL)
1858 outer_inner_list = lappend(outer_inner_list,
1859 outer_inner_rels->relation);
1861 outer_inner_list = list_concat(outer_inner_list,
1862 OuterInnerList(outer_inner_rels));
1864 return outer_inner_list;
1868 LeadingHintParse(LeadingHint *hint, HintState *hstate, Query *parse,
1871 List *name_list = NIL;
1872 OuterInnerRels *outer_inner = NULL;
1874 if ((str = parse_parentheses_Leading(str, &name_list, &outer_inner)) ==
1878 if (outer_inner != NULL)
1879 name_list = OuterInnerList(outer_inner);
1881 hint->relations = name_list;
1882 hint->outer_inner = outer_inner;
1884 /* A Leading hint requires at least two relations */
1885 if ( hint->outer_inner == NULL && list_length(hint->relations) < 2)
1887 hint_ereport(hint->base.hint_str,
1888 ("%s hint requires at least two relations.",
1890 hint->base.state = HINT_STATE_ERROR;
1892 else if (hint->outer_inner != NULL &&
1893 !OuterInnerPairCheck(hint->outer_inner))
1895 hint_ereport(hint->base.hint_str,
1896 ("%s hint requires two sets of relations when parentheses nests.",
1898 hint->base.state = HINT_STATE_ERROR;
1905 SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str)
1907 List *name_list = NIL;
1909 if ((str = parse_parentheses(str, &name_list, hint->base.hint_keyword))
1913 hint->words = name_list;
1915 /* We need both name and value to set GUC parameter. */
1916 if (list_length(name_list) == 2)
1918 hint->name = linitial(name_list);
1919 hint->value = lsecond(name_list);
1923 hint_ereport(hint->base.hint_str,
1924 ("%s hint requires name and value of GUC parameter.",
1926 hint->base.state = HINT_STATE_ERROR;
1933 * set GUC parameter functions
1937 set_config_option_wrapper(const char *name, const char *value,
1938 GucContext context, GucSource source,
1939 GucAction action, bool changeVal, int elevel)
1942 MemoryContext ccxt = CurrentMemoryContext;
1946 #if PG_VERSION_NUM >= 90200
1947 result = set_config_option(name, value, context, source,
1948 action, changeVal, 0);
1950 result = set_config_option(name, value, context, source,
1958 /* Save error info */
1959 MemoryContextSwitchTo(ccxt);
1960 errdata = CopyErrorData();
1963 ereport(elevel, (errcode(errdata->sqlerrcode),
1964 errmsg("%s", errdata->message),
1965 errdata->detail ? errdetail("%s", errdata->detail) : 0,
1966 errdata->hint ? errhint("%s", errdata->hint) : 0));
1967 FreeErrorData(errdata);
1975 set_config_options(SetHint **options, int noptions, GucContext context)
1980 save_nestlevel = NewGUCNestLevel();
1982 for (i = 0; i < noptions; i++)
1984 SetHint *hint = options[i];
1987 if (!hint_state_enabled(hint))
1990 result = set_config_option_wrapper(hint->name, hint->value, context,
1991 PGC_S_SESSION, GUC_ACTION_SAVE, true,
1992 pg_hint_plan_parse_messages);
1994 hint->base.state = HINT_STATE_USED;
1996 hint->base.state = HINT_STATE_ERROR;
1999 return save_nestlevel;
2002 #define SET_CONFIG_OPTION(name, type_bits) \
2003 set_config_option_wrapper((name), \
2004 (mask & (type_bits)) ? "true" : "false", \
2005 context, PGC_S_SESSION, GUC_ACTION_SAVE, true, ERROR)
2008 set_scan_config_options(unsigned char enforce_mask, GucContext context)
2012 if (enforce_mask == ENABLE_SEQSCAN || enforce_mask == ENABLE_INDEXSCAN ||
2013 enforce_mask == ENABLE_BITMAPSCAN || enforce_mask == ENABLE_TIDSCAN
2014 #if PG_VERSION_NUM >= 90200
2015 || enforce_mask == (ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN)
2018 mask = enforce_mask;
2020 mask = enforce_mask & current_hint->init_scan_mask;
2022 SET_CONFIG_OPTION("enable_seqscan", ENABLE_SEQSCAN);
2023 SET_CONFIG_OPTION("enable_indexscan", ENABLE_INDEXSCAN);
2024 SET_CONFIG_OPTION("enable_bitmapscan", ENABLE_BITMAPSCAN);
2025 SET_CONFIG_OPTION("enable_tidscan", ENABLE_TIDSCAN);
2026 #if PG_VERSION_NUM >= 90200
2027 SET_CONFIG_OPTION("enable_indexonlyscan", ENABLE_INDEXONLYSCAN);
2032 set_join_config_options(unsigned char enforce_mask, GucContext context)
2036 if (enforce_mask == ENABLE_NESTLOOP || enforce_mask == ENABLE_MERGEJOIN ||
2037 enforce_mask == ENABLE_HASHJOIN)
2038 mask = enforce_mask;
2040 mask = enforce_mask & current_hint->init_join_mask;
2042 SET_CONFIG_OPTION("enable_nestloop", ENABLE_NESTLOOP);
2043 SET_CONFIG_OPTION("enable_mergejoin", ENABLE_MERGEJOIN);
2044 SET_CONFIG_OPTION("enable_hashjoin", ENABLE_HASHJOIN);
2048 * pg_hint_plan hook functions
2052 pg_hint_plan_ProcessUtility(Node *parsetree, const char *queryString,
2053 ParamListInfo params, bool isTopLevel,
2054 DestReceiver *dest, char *completionTag)
2059 * Use standard planner if pg_hint_plan is disabled or current nesting
2060 * depth is nesting depth of SPI calls.
2062 if (!pg_hint_plan_enable_hint || nested_level > 0)
2064 if (prev_ProcessUtility)
2065 (*prev_ProcessUtility) (parsetree, queryString, params,
2066 isTopLevel, dest, completionTag);
2068 standard_ProcessUtility(parsetree, queryString, params,
2069 isTopLevel, dest, completionTag);
2075 if (IsA(node, ExplainStmt))
2078 * Draw out parse tree of actual query from Query struct of EXPLAIN
2084 stmt = (ExplainStmt *) node;
2086 Assert(IsA(stmt->query, Query));
2087 query = (Query *) stmt->query;
2089 if (query->commandType == CMD_UTILITY && query->utilityStmt != NULL)
2090 node = query->utilityStmt;
2094 * If the query was a EXECUTE or CREATE TABLE AS EXECUTE, get query string
2095 * specified to preceding PREPARE command to use it as source of hints.
2097 if (IsA(node, ExecuteStmt))
2101 stmt = (ExecuteStmt *) node;
2102 stmt_name = stmt->name;
2104 #if PG_VERSION_NUM >= 90200
2106 * CREATE AS EXECUTE behavior has changed since 9.2, so we must handle it
2109 if (IsA(node, CreateTableAsStmt))
2111 CreateTableAsStmt *stmt;
2114 stmt = (CreateTableAsStmt *) node;
2115 Assert(IsA(stmt->query, Query));
2116 query = (Query *) stmt->query;
2118 if (query->commandType == CMD_UTILITY &&
2119 IsA(query->utilityStmt, ExecuteStmt))
2121 ExecuteStmt *estmt = (ExecuteStmt *) query->utilityStmt;
2122 stmt_name = estmt->name;
2130 if (prev_ProcessUtility)
2131 (*prev_ProcessUtility) (parsetree, queryString, params,
2132 isTopLevel, dest, completionTag);
2134 standard_ProcessUtility(parsetree, queryString, params,
2135 isTopLevel, dest, completionTag);
2149 if (prev_ProcessUtility)
2150 (*prev_ProcessUtility) (parsetree, queryString, params,
2151 isTopLevel, dest, completionTag);
2153 standard_ProcessUtility(parsetree, queryString, params,
2154 isTopLevel, dest, completionTag);
2158 * Push a hint into hint stack which is implemented with List struct. Head of
2159 * list is top of stack.
2162 push_hint(HintState *hstate)
2164 /* Prepend new hint to the list means pushing to stack. */
2165 HintStateStack = lcons(hstate, HintStateStack);
2167 /* Pushed hint is the one which should be used hereafter. */
2168 current_hint = hstate;
2171 /* Pop a hint from hint stack. Popped hint is automatically discarded. */
2175 /* Hint stack must not be empty. */
2176 if(HintStateStack == NIL)
2177 elog(ERROR, "hint stack is empty");
2180 * Take a hint at the head from the list, and free it. Switch current_hint
2181 * to point new head (NULL if the list is empty).
2183 HintStateStack = list_delete_first(HintStateStack);
2184 HintStateDelete(current_hint);
2185 if(HintStateStack == NIL)
2186 current_hint = NULL;
2188 current_hint = (HintState *) lfirst(list_head(HintStateStack));
2191 static PlannedStmt *
2192 pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams)
2194 const char *hints = NULL;
2197 pgssJumbleState jstate;
2200 PlannedStmt *result;
2204 * Use standard planner if pg_hint_plan is disabled or current nesting
2205 * depth is nesting depth of SPI calls. Other hook functions try to change
2206 * plan with current_hint if any, so set it to NULL.
2208 if (!pg_hint_plan_enable_hint || nested_level > 0)
2209 goto standard_planner_proc;
2211 /* Create hint struct from client-supplied query string. */
2212 query = get_query_string();
2215 * ヒント用テーブルの検索は、プラン作成の性能に与える影響が大きい。
2216 * そのため、GUCパラメータでテーブル検索を制御できるようにした。
2217 * デフォルトでは、テーブル検索をしない設定である。
2219 if (pg_hint_plan_lookup_hint_in_table)
2222 * Search hint information which is stored for the query and the
2223 * application. Query string is normalized before using in condition
2224 * in order to allow fuzzy matching.
2226 * XXX: normalizing code is copied from pg_stat_statements.c, so be
2227 * careful when supporting PostgreSQL's version up.
2229 jstate.jumble = (unsigned char *) palloc(JUMBLE_SIZE);
2230 jstate.jumble_len = 0;
2231 jstate.clocations_buf_size = 32;
2232 jstate.clocations = (pgssLocationLen *)
2233 palloc(jstate.clocations_buf_size * sizeof(pgssLocationLen));
2234 jstate.clocations_count = 0;
2235 JumbleQuery(&jstate, parse);
2237 * generate_normalized_query() copies exact given query_len bytes, so we
2238 * add 1 byte for null-termination here. As comments on
2239 * generate_normalized_query says, generate_normalized_query doesn't
2240 * take care of null-terminate, but additional 1 byte ensures that '\0'
2241 * byte in the source buffer to be copied into norm_query.
2243 query_len = strlen(query) + 1;
2244 norm_query = generate_normalized_query(&jstate,
2247 GetDatabaseEncoding());
2248 hints = get_hints_from_table(norm_query, application_name);
2250 "pg_hint_plan: get_hints_from_table [%s][%s]=>[%s]",
2251 norm_query, application_name, hints ? hints : "(none)");
2254 hints = get_hints_from_comment(query);
2255 hstate = create_hintstate(parse, hints);
2258 * Use standard planner if the statement has not valid hint. Other hook
2259 * functions try to change plan with current_hint if any, so set it to
2263 goto standard_planner_proc;
2266 * Push new hint struct to the hint stack to disable previous hint context.
2270 /* Set GUC parameters which are specified with Set hint. */
2271 save_nestlevel = set_config_options(current_hint->set_hints,
2272 current_hint->num_hints[HINT_TYPE_SET],
2273 current_hint->context);
2276 current_hint->init_scan_mask |= ENABLE_SEQSCAN;
2277 if (enable_indexscan)
2278 current_hint->init_scan_mask |= ENABLE_INDEXSCAN;
2279 if (enable_bitmapscan)
2280 current_hint->init_scan_mask |= ENABLE_BITMAPSCAN;
2282 current_hint->init_scan_mask |= ENABLE_TIDSCAN;
2283 #if PG_VERSION_NUM >= 90200
2284 if (enable_indexonlyscan)
2285 current_hint->init_scan_mask |= ENABLE_INDEXONLYSCAN;
2287 if (enable_nestloop)
2288 current_hint->init_join_mask |= ENABLE_NESTLOOP;
2289 if (enable_mergejoin)
2290 current_hint->init_join_mask |= ENABLE_MERGEJOIN;
2291 if (enable_hashjoin)
2292 current_hint->init_join_mask |= ENABLE_HASHJOIN;
2295 * Use PG_TRY mechanism to recover GUC parameters and current_hint to the
2296 * state when this planner started when error occurred in planner.
2301 result = (*prev_planner) (parse, cursorOptions, boundParams);
2303 result = standard_planner(parse, cursorOptions, boundParams);
2308 * Rollback changes of GUC parameters, and pop current hint context
2309 * from hint stack to rewind the state.
2311 AtEOXact_GUC(true, save_nestlevel);
2317 /* Print hint in debug mode. */
2318 if (pg_hint_plan_debug_print)
2319 HintStateDump(current_hint);
2322 * Rollback changes of GUC parameters, and pop current hint context from
2323 * hint stack to rewind the state.
2325 AtEOXact_GUC(true, save_nestlevel);
2330 standard_planner_proc:
2331 current_hint = NULL;
2333 return (*prev_planner) (parse, cursorOptions, boundParams);
2335 return standard_planner(parse, cursorOptions, boundParams);
2339 * Return scan method hint which matches given aliasname.
2341 static ScanMethodHint *
2342 find_scan_hint(PlannerInfo *root, RelOptInfo *rel)
2348 * We can't apply scan method hint if the relation is:
2349 * - not a base relation
2350 * - not an ordinary relation (such as join and subquery)
2352 if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
2355 rte = root->simple_rte_array[rel->relid];
2357 /* We can't force scan method of foreign tables */
2358 if (rte->relkind == RELKIND_FOREIGN_TABLE)
2361 /* Find scan method hint, which matches given names, from the list. */
2362 for (i = 0; i < current_hint->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
2364 ScanMethodHint *hint = current_hint->scan_hints[i];
2366 /* We ignore disabled hints. */
2367 if (!hint_state_enabled(hint))
2370 if (RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0)
2380 * Returns TRUE on match, FALSE on no match.
2382 * s1 --- the data to match against
2383 * s2 --- the pattern
2385 * Because we copy s1 to NameData, make the size of s1 less than NAMEDATALEN.
2388 regexpeq(const char *s1, const char *s2)
2394 strcpy(name.data, s1);
2395 regexp = cstring_to_text(s2);
2397 result = DirectFunctionCall2Coll(nameregexeq,
2398 DEFAULT_COLLATION_OID,
2399 NameGetDatum(&name),
2400 PointerGetDatum(regexp));
2401 return DatumGetBool(result);
2405 delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId)
2413 * We delete all the IndexOptInfo list and prevent you from being usable by
2416 if (hint->enforce_mask == ENABLE_SEQSCAN ||
2417 hint->enforce_mask == ENABLE_TIDSCAN)
2419 list_free_deep(rel->indexlist);
2420 rel->indexlist = NIL;
2421 hint->base.state = HINT_STATE_USED;
2427 * When a list of indexes is not specified, we just use all indexes.
2429 if (hint->indexnames == NIL)
2433 * Leaving only an specified index, we delete it from a IndexOptInfo list
2437 if (pg_hint_plan_debug_print)
2438 initStringInfo(&buf);
2440 for (cell = list_head(rel->indexlist); cell; cell = next)
2442 IndexOptInfo *info = (IndexOptInfo *) lfirst(cell);
2443 char *indexname = get_rel_name(info->indexoid);
2445 bool use_index = false;
2449 foreach(l, hint->indexnames)
2451 char *hintname = (char *) lfirst(l);
2455 result = regexpeq(indexname, hintname);
2457 result = RelnameCmp(&indexname, &hintname) == 0;
2462 if (pg_hint_plan_debug_print)
2464 appendStringInfoCharMacro(&buf, ' ');
2465 quote_value(&buf, indexname);
2473 * to make the index a candidate when definition of this index is
2474 * matched with the index's definition of current_hint.
2476 if (OidIsValid(relationObjectId) && !use_index)
2478 foreach(l, current_hint->parent_index_infos)
2482 ParentIndexInfo *p_info = (ParentIndexInfo *)lfirst(l);
2484 /* check to match the parameter of unique */
2485 if (p_info->indisunique != info->unique)
2488 /* check to match the parameter of index's method */
2489 if (p_info->method != info->relam)
2492 /* to check to match the indexkey's configuration */
2493 if ((list_length(p_info->column_names)) !=
2497 /* check to match the indexkey's configuration */
2498 for (i = 0; i < info->ncolumns; i++)
2500 char *c_attname = NULL;
2501 char *p_attname = NULL;
2504 list_nth(p_info->column_names, i);
2506 /* both are expressions */
2507 if (info->indexkeys[i] == 0 && !p_attname)
2510 /* one's column is expression, the other is not */
2511 if (info->indexkeys[i] == 0 || !p_attname)
2514 c_attname = get_attname(relationObjectId,
2515 info->indexkeys[i]);
2517 if (strcmp(p_attname, c_attname) != 0)
2520 if (p_info->indcollation[i] != info->indexcollations[i])
2523 if (p_info->opclass[i] != info->opcintype[i])
2526 if (((p_info->indoption[i] & INDOPTION_DESC) != 0) !=
2527 info->reverse_sort[i])
2530 if (((p_info->indoption[i] & INDOPTION_NULLS_FIRST) != 0) !=
2531 info->nulls_first[i])
2536 if (i != info->ncolumns)
2539 if ((p_info->expression_str && (info->indexprs != NIL)) ||
2540 (p_info->indpred_str && (info->indpred != NIL)))
2543 * Fetch the pg_index tuple by the Oid of the index
2545 ht_idx = SearchSysCache1(INDEXRELID,
2546 ObjectIdGetDatum(info->indexoid));
2548 /* check to match the expression's parameter of index */
2549 if (p_info->expression_str &&
2550 !heap_attisnull(ht_idx, Anum_pg_index_indexprs))
2557 * to change the expression's parameter of child's
2560 exprsDatum = SysCacheGetAttr(INDEXRELID, ht_idx,
2561 Anum_pg_index_indexprs,
2564 result = DirectFunctionCall2(pg_get_expr,
2569 if (strcmp(p_info->expression_str,
2570 text_to_cstring(DatumGetTextP(result))) != 0)
2573 ReleaseSysCache(ht_idx);
2579 /* Check to match the predicate's paraameter of index */
2580 if (p_info->indpred_str &&
2581 !heap_attisnull(ht_idx, Anum_pg_index_indpred))
2588 * to change the predicate's parabeter of child's
2591 predDatum = SysCacheGetAttr(INDEXRELID, ht_idx,
2592 Anum_pg_index_indpred,
2595 result = DirectFunctionCall2(pg_get_expr,
2600 if (strcmp(p_info->indpred_str,
2601 text_to_cstring(DatumGetTextP(result))) != 0)
2604 ReleaseSysCache(ht_idx);
2611 ReleaseSysCache(ht_idx);
2613 else if (p_info->expression_str || (info->indexprs != NIL))
2615 else if (p_info->indpred_str || (info->indpred != NIL))
2620 /* to log the candidate of index */
2621 if (pg_hint_plan_debug_print)
2623 appendStringInfoCharMacro(&buf, ' ');
2624 quote_value(&buf, indexname);
2632 rel->indexlist = list_delete_cell(rel->indexlist, cell, prev);
2639 if (pg_hint_plan_debug_print)
2642 StringInfoData rel_buf;
2644 if (OidIsValid(relationObjectId))
2645 relname = get_rel_name(relationObjectId);
2647 relname = hint->relname;
2649 initStringInfo(&rel_buf);
2650 quote_value(&rel_buf, relname);
2653 (errmsg("available indexes for %s(%s):%s",
2658 pfree(rel_buf.data);
2663 * Return information of index definition.
2665 static ParentIndexInfo *
2666 get_parent_index_info(Oid indexoid, Oid relid)
2668 ParentIndexInfo *p_info = palloc(sizeof(ParentIndexInfo));
2669 Relation indexRelation;
2670 Form_pg_index index;
2674 indexRelation = index_open(indexoid, RowExclusiveLock);
2676 index = indexRelation->rd_index;
2678 p_info->indisunique = index->indisunique;
2679 p_info->method = indexRelation->rd_rel->relam;
2681 p_info->column_names = NIL;
2682 p_info->indcollation = (Oid *) palloc(sizeof(Oid) * index->indnatts);
2683 p_info->opclass = (Oid *) palloc(sizeof(Oid) * index->indnatts);
2684 p_info->indoption = (int16 *) palloc(sizeof(Oid) * index->indnatts);
2686 for (i = 0; i < index->indnatts; i++)
2688 attname = get_attname(relid, index->indkey.values[i]);
2689 p_info->column_names = lappend(p_info->column_names, attname);
2691 p_info->indcollation[i] = indexRelation->rd_indcollation[i];
2692 p_info->opclass[i] = indexRelation->rd_opcintype[i];
2693 p_info->indoption[i] = indexRelation->rd_indoption[i];
2697 * to check to match the expression's paraameter of index with child indexes
2699 p_info->expression_str = NULL;
2700 if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indexprs))
2706 exprsDatum = SysCacheGetAttr(INDEXRELID, indexRelation->rd_indextuple,
2707 Anum_pg_index_indexprs, &isnull);
2709 result = DirectFunctionCall2(pg_get_expr,
2711 ObjectIdGetDatum(relid));
2713 p_info->expression_str = text_to_cstring(DatumGetTextP(result));
2717 * to check to match the predicate's paraameter of index with child indexes
2719 p_info->indpred_str = NULL;
2720 if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indpred))
2726 predDatum = SysCacheGetAttr(INDEXRELID, indexRelation->rd_indextuple,
2727 Anum_pg_index_indpred, &isnull);
2729 result = DirectFunctionCall2(pg_get_expr,
2731 ObjectIdGetDatum(relid));
2733 p_info->indpred_str = text_to_cstring(DatumGetTextP(result));
2736 index_close(indexRelation, NoLock);
2742 pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
2743 bool inhparent, RelOptInfo *rel)
2745 ScanMethodHint *hint;
2747 if (prev_get_relation_info)
2748 (*prev_get_relation_info) (root, relationObjectId, inhparent, rel);
2751 * Do nothing if we don't have valid hint in this context or current
2752 * nesting depth is nesting depth of SPI calls.
2754 if (!current_hint || nested_level > 0)
2759 /* store does relids of parent table. */
2760 current_hint->parent_relid = rel->relid;
2761 current_hint->parent_rel_oid = relationObjectId;
2763 else if (current_hint->parent_relid != 0)
2766 * We use the same GUC parameter if this table is the child table of a
2767 * table called pg_hint_plan_get_relation_info just before that.
2771 /* append_rel_list contains all append rels; ignore others */
2772 foreach(l, root->append_rel_list)
2774 AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l);
2776 /* This rel is child table. */
2777 if (appinfo->parent_relid == current_hint->parent_relid &&
2778 appinfo->child_relid == rel->relid)
2780 if (current_hint->parent_hint)
2781 delete_indexes(current_hint->parent_hint, rel,
2788 /* This rel is not inherit table. */
2789 current_hint->parent_relid = 0;
2790 current_hint->parent_rel_oid = InvalidOid;
2791 current_hint->parent_hint = NULL;
2795 * If scan method hint was given, reset GUC parameters which control
2796 * planner behavior about choosing scan methods.
2798 if ((hint = find_scan_hint(root, rel)) == NULL)
2800 set_scan_config_options(current_hint->init_scan_mask,
2801 current_hint->context);
2804 set_scan_config_options(hint->enforce_mask, current_hint->context);
2805 hint->base.state = HINT_STATE_USED;
2813 current_hint->parent_hint = hint;
2815 relation = heap_open(relationObjectId, NoLock);
2816 indexoidlist = RelationGetIndexList(relation);
2818 foreach(l, indexoidlist)
2820 Oid indexoid = lfirst_oid(l);
2821 char *indexname = get_rel_name(indexoid);
2822 bool use_index = false;
2824 ParentIndexInfo *parent_index_info;
2826 foreach(lc, hint->indexnames)
2828 if (RelnameCmp(&indexname, &lfirst(lc)) == 0)
2837 parent_index_info = get_parent_index_info(indexoid,
2839 current_hint->parent_index_infos =
2840 lappend(current_hint->parent_index_infos, parent_index_info);
2842 heap_close(relation, NoLock);
2845 delete_indexes(hint, rel, InvalidOid);
2849 * Return index of relation which matches given aliasname, or 0 if not found.
2850 * If same aliasname was used multiple times in a query, return -1.
2853 find_relid_aliasname(PlannerInfo *root, char *aliasname, List *initial_rels,
2859 for (i = 1; i < root->simple_rel_array_size; i++)
2863 if (root->simple_rel_array[i] == NULL)
2866 Assert(i == root->simple_rel_array[i]->relid);
2868 if (RelnameCmp(&aliasname,
2869 &root->simple_rte_array[i]->eref->aliasname) != 0)
2872 foreach(l, initial_rels)
2874 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
2876 if (rel->reloptkind == RELOPT_BASEREL)
2878 if (rel->relid != i)
2883 Assert(rel->reloptkind == RELOPT_JOINREL);
2885 if (!bms_is_member(i, rel->relids))
2892 ("Relation name \"%s\" is ambiguous.",
2907 * Return join hint which matches given joinrelids.
2909 static JoinMethodHint *
2910 find_join_hint(Relids joinrelids)
2915 join_hint = current_hint->join_hint_level[bms_num_members(joinrelids)];
2917 foreach(l, join_hint)
2919 JoinMethodHint *hint = (JoinMethodHint *) lfirst(l);
2921 if (bms_equal(joinrelids, hint->joinrelids))
2929 OuterInnerJoinCreate(OuterInnerRels *outer_inner, LeadingHint *leading_hint,
2930 PlannerInfo *root, List *initial_rels, HintState *hstate, int nbaserel)
2932 OuterInnerRels *outer_rels;
2933 OuterInnerRels *inner_rels;
2934 Relids outer_relids;
2935 Relids inner_relids;
2937 JoinMethodHint *hint;
2939 if (outer_inner->relation != NULL)
2941 return bms_make_singleton(
2942 find_relid_aliasname(root, outer_inner->relation,
2944 leading_hint->base.hint_str));
2947 outer_rels = lfirst(outer_inner->outer_inner_pair->head);
2948 inner_rels = lfirst(outer_inner->outer_inner_pair->tail);
2950 outer_relids = OuterInnerJoinCreate(outer_rels,
2956 inner_relids = OuterInnerJoinCreate(inner_rels,
2963 join_relids = bms_add_members(outer_relids, inner_relids);
2965 if (bms_num_members(join_relids) > nbaserel)
2969 * If we don't have join method hint, create new one for the
2970 * join combination with all join methods are enabled.
2972 hint = find_join_hint(join_relids);
2976 * Here relnames is not set, since Relids bitmap is sufficient to
2977 * control paths of this query afterward.
2979 hint = (JoinMethodHint *) JoinMethodHintCreate(
2980 leading_hint->base.hint_str,
2982 HINT_KEYWORD_LEADING);
2983 hint->base.state = HINT_STATE_USED;
2984 hint->nrels = bms_num_members(join_relids);
2985 hint->enforce_mask = ENABLE_ALL_JOIN;
2986 hint->joinrelids = bms_copy(join_relids);
2987 hint->inner_nrels = bms_num_members(inner_relids);
2988 hint->inner_joinrelids = bms_copy(inner_relids);
2990 hstate->join_hint_level[hint->nrels] =
2991 lappend(hstate->join_hint_level[hint->nrels], hint);
2995 hint->inner_nrels = bms_num_members(inner_relids);
2996 hint->inner_joinrelids = bms_copy(inner_relids);
3003 * Transform join method hint into handy form.
3005 * - create bitmap of relids from alias names, to make it easier to check
3006 * whether a join path matches a join method hint.
3007 * - add join method hints which are necessary to enforce join order
3008 * specified by Leading hint
3011 transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel,
3012 List *initial_rels, JoinMethodHint **join_method_hints)
3020 LeadingHint *lhint = NULL;
3023 * Create bitmap of relids from alias names for each join method hint.
3024 * Bitmaps are more handy than strings in join searching.
3026 for (i = 0; i < hstate->num_hints[HINT_TYPE_JOIN_METHOD]; i++)
3028 JoinMethodHint *hint = hstate->join_hints[i];
3031 if (!hint_state_enabled(hint) || hint->nrels > nbaserel)
3034 bms_free(hint->joinrelids);
3035 hint->joinrelids = NULL;
3037 for (j = 0; j < hint->nrels; j++)
3039 relname = hint->relnames[j];
3041 relid = find_relid_aliasname(root, relname, initial_rels,
3042 hint->base.hint_str);
3045 hint->base.state = HINT_STATE_ERROR;
3050 if (bms_is_member(relid, hint->joinrelids))
3052 hint_ereport(hint->base.hint_str,
3053 ("Relation name \"%s\" is duplicated.", relname));
3054 hint->base.state = HINT_STATE_ERROR;
3058 hint->joinrelids = bms_add_member(hint->joinrelids, relid);
3061 if (relid <= 0 || hint->base.state == HINT_STATE_ERROR)
3064 hstate->join_hint_level[hint->nrels] =
3065 lappend(hstate->join_hint_level[hint->nrels], hint);
3068 /* Do nothing if no Leading hint was supplied. */
3069 if (hstate->num_hints[HINT_TYPE_LEADING] == 0)
3073 * Decide to use Leading hint。
3075 for (i = 0; i < hstate->num_hints[HINT_TYPE_LEADING]; i++)
3077 LeadingHint *leading_hint = (LeadingHint *)hstate->leading_hint[i];
3080 if (leading_hint->base.state == HINT_STATE_ERROR)
3086 foreach(l, leading_hint->relations)
3088 relname = (char *)lfirst(l);;
3090 relid = find_relid_aliasname(root, relname, initial_rels,
3091 leading_hint->base.hint_str);
3093 leading_hint->base.state = HINT_STATE_ERROR;
3098 if (bms_is_member(relid, relids))
3100 hint_ereport(leading_hint->base.hint_str,
3101 ("Relation name \"%s\" is duplicated.", relname));
3102 leading_hint->base.state = HINT_STATE_ERROR;
3106 relids = bms_add_member(relids, relid);
3109 if (relid <= 0 || leading_hint->base.state == HINT_STATE_ERROR)
3114 hint_ereport(lhint->base.hint_str,
3115 ("Conflict %s hint.", HintTypeName[lhint->base.type]));
3116 lhint->base.state = HINT_STATE_DUPLICATION;
3118 leading_hint->base.state = HINT_STATE_USED;
3119 lhint = leading_hint;
3122 /* check to exist Leading hint marked with 'used'. */
3127 * We need join method hints which fit specified join order in every join
3128 * level. For example, Leading(A B C) virtually requires following join
3129 * method hints, if no join method hint supplied:
3131 * - level 2: NestLoop(A B), MergeJoin(A B), HashJoin(A B)
3132 * - level 3: NestLoop(A B C), MergeJoin(A B C), HashJoin(A B C)
3134 * If we already have join method hint which fits specified join order in
3135 * that join level, we leave it as-is and don't add new hints.
3139 if (lhint->outer_inner == NULL)
3141 foreach(l, lhint->relations)
3143 JoinMethodHint *hint;
3145 relname = (char *)lfirst(l);
3148 * Find relid of the relation which has given name. If we have the
3149 * name given in Leading hint multiple times in the join, nothing to
3152 relid = find_relid_aliasname(root, relname, initial_rels,
3155 /* Create bitmap of relids for current join level. */
3156 joinrelids = bms_add_member(joinrelids, relid);
3159 /* We never have join method hint for single relation. */
3164 * If we don't have join method hint, create new one for the
3165 * join combination with all join methods are enabled.
3167 hint = find_join_hint(joinrelids);
3171 * Here relnames is not set, since Relids bitmap is sufficient
3172 * to control paths of this query afterward.
3174 hint = (JoinMethodHint *) JoinMethodHintCreate(
3175 lhint->base.hint_str,
3177 HINT_KEYWORD_LEADING);
3178 hint->base.state = HINT_STATE_USED;
3179 hint->nrels = njoinrels;
3180 hint->enforce_mask = ENABLE_ALL_JOIN;
3181 hint->joinrelids = bms_copy(joinrelids);
3184 join_method_hints[njoinrels] = hint;
3186 if (njoinrels >= nbaserel)
3189 bms_free(joinrelids);
3195 * Delete all join hints which have different combination from Leading
3198 for (i = 2; i <= njoinrels; i++)
3200 list_free(hstate->join_hint_level[i]);
3202 hstate->join_hint_level[i] = lappend(NIL, join_method_hints[i]);
3207 joinrelids = OuterInnerJoinCreate(lhint->outer_inner,
3214 njoinrels = bms_num_members(joinrelids);
3215 Assert(njoinrels >= 2);
3218 * Delete all join hints which have different combination from Leading
3221 for (i = 2;i <= njoinrels; i++)
3223 if (hstate->join_hint_level[i] != NIL)
3225 ListCell *prev = NULL;
3226 ListCell *next = NULL;
3227 for(l = list_head(hstate->join_hint_level[i]); l; l = next)
3230 JoinMethodHint *hint = (JoinMethodHint *)lfirst(l);
3234 if (hint->inner_nrels == 0 &&
3235 !(bms_intersect(hint->joinrelids, joinrelids) == NULL ||
3236 bms_equal(bms_union(hint->joinrelids, joinrelids),
3239 hstate->join_hint_level[i] =
3240 list_delete_cell(hstate->join_hint_level[i], l,
3249 bms_free(joinrelids);
3252 if (hint_state_enabled(lhint))
3254 set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
3261 * set_plain_rel_pathlist
3262 * Build access paths for a plain relation (no subquery, no inheritance)
3264 * This function was copied and edited from set_plain_rel_pathlist() in
3265 * src/backend/optimizer/path/allpaths.c
3268 set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
3270 /* Consider sequential scan */
3271 #if PG_VERSION_NUM >= 90200
3272 add_path(rel, create_seqscan_path(root, rel, NULL));
3274 add_path(rel, create_seqscan_path(root, rel));
3277 /* Consider index scans */
3278 create_index_paths(root, rel);
3280 /* Consider TID scans */
3281 create_tidscan_paths(root, rel);
3283 /* Now find the cheapest of the paths for this rel */
3288 rebuild_scan_path(HintState *hstate, PlannerInfo *root, int level,
3293 foreach(l, initial_rels)
3295 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
3297 ScanMethodHint *hint;
3299 /* Skip relations which we can't choose scan method. */
3300 if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
3303 rte = root->simple_rte_array[rel->relid];
3305 /* We can't force scan method of foreign tables */
3306 if (rte->relkind == RELKIND_FOREIGN_TABLE)
3310 * Create scan paths with GUC parameters which are at the beginning of
3311 * planner if scan method hint is not specified, otherwise use
3312 * specified hints and mark the hint as used.
3314 if ((hint = find_scan_hint(root, rel)) == NULL)
3315 set_scan_config_options(hstate->init_scan_mask,
3319 set_scan_config_options(hint->enforce_mask, hstate->context);
3320 hint->base.state = HINT_STATE_USED;
3323 list_free_deep(rel->pathlist);
3324 rel->pathlist = NIL;
3327 /* It's an "append relation", process accordingly */
3328 set_append_rel_pathlist(root, rel, rel->relid, rte);
3332 set_plain_rel_pathlist(root, rel, rte);
3337 * Restore the GUC variables we set above.
3339 set_scan_config_options(hstate->init_scan_mask, hstate->context);
3343 * wrapper of make_join_rel()
3345 * call make_join_rel() after changing enable_* parameters according to given
3349 make_join_rel_wrapper(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
3352 JoinMethodHint *hint;
3356 joinrelids = bms_union(rel1->relids, rel2->relids);
3357 hint = find_join_hint(joinrelids);
3358 bms_free(joinrelids);
3361 return pg_hint_plan_make_join_rel(root, rel1, rel2);
3363 if (hint->inner_nrels == 0)
3365 save_nestlevel = NewGUCNestLevel();
3367 set_join_config_options(hint->enforce_mask, current_hint->context);
3369 rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
3370 hint->base.state = HINT_STATE_USED;
3373 * Restore the GUC variables we set above.
3375 AtEOXact_GUC(true, save_nestlevel);
3378 rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
3387 add_paths_to_joinrel_wrapper(PlannerInfo *root,
3388 RelOptInfo *joinrel,
3389 RelOptInfo *outerrel,
3390 RelOptInfo *innerrel,
3392 SpecialJoinInfo *sjinfo,
3395 ScanMethodHint *scan_hint = NULL;
3397 JoinMethodHint *join_hint;
3400 if ((scan_hint = find_scan_hint(root, innerrel)) != NULL)
3402 set_scan_config_options(scan_hint->enforce_mask, current_hint->context);
3403 scan_hint->base.state = HINT_STATE_USED;
3406 joinrelids = bms_union(outerrel->relids, innerrel->relids);
3407 join_hint = find_join_hint(joinrelids);
3408 bms_free(joinrelids);
3410 if (join_hint && join_hint->inner_nrels != 0)
3412 save_nestlevel = NewGUCNestLevel();
3414 if (bms_equal(join_hint->inner_joinrelids, innerrel->relids))
3417 set_join_config_options(join_hint->enforce_mask,
3418 current_hint->context);
3420 add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
3421 sjinfo, restrictlist);
3422 join_hint->base.state = HINT_STATE_USED;
3426 set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
3427 add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
3428 sjinfo, restrictlist);
3432 * Restore the GUC variables we set above.
3434 AtEOXact_GUC(true, save_nestlevel);
3437 add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
3438 sjinfo, restrictlist);
3440 if (scan_hint != NULL)
3441 set_scan_config_options(current_hint->init_scan_mask,
3442 current_hint->context);
3446 get_num_baserels(List *initial_rels)
3451 foreach(l, initial_rels)
3453 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
3455 if (rel->reloptkind == RELOPT_BASEREL)
3457 else if (rel->reloptkind ==RELOPT_JOINREL)
3458 nbaserel+= bms_num_members(rel->relids);
3461 /* other values not expected here */
3462 elog(ERROR, "unrecognized reloptkind type: %d", rel->reloptkind);
3470 pg_hint_plan_join_search(PlannerInfo *root, int levels_needed,
3473 JoinMethodHint **join_method_hints;
3477 bool leading_hint_enable;
3480 * Use standard planner (or geqo planner) if pg_hint_plan is disabled or no
3481 * valid hint is supplied or current nesting depth is nesting depth of SPI
3484 if (!current_hint || nested_level > 0)
3486 if (prev_join_search)
3487 return (*prev_join_search) (root, levels_needed, initial_rels);
3488 else if (enable_geqo && levels_needed >= geqo_threshold)
3489 return geqo(root, levels_needed, initial_rels);
3491 return standard_join_search(root, levels_needed, initial_rels);
3494 /* We apply scan method hint rebuild scan path. */
3495 rebuild_scan_path(current_hint, root, levels_needed, initial_rels);
3498 * In the case using GEQO, only scan method hints and Set hints have
3499 * effect. Join method and join order is not controllable by hints.
3501 if (enable_geqo && levels_needed >= geqo_threshold)
3502 return geqo(root, levels_needed, initial_rels);
3504 nbaserel = get_num_baserels(initial_rels);
3505 current_hint->join_hint_level = palloc0(sizeof(List *) * (nbaserel + 1));
3506 join_method_hints = palloc0(sizeof(JoinMethodHint *) * (nbaserel + 1));
3508 leading_hint_enable = transform_join_hints(current_hint, root, nbaserel,
3509 initial_rels, join_method_hints);
3511 rel = pg_hint_plan_standard_join_search(root, levels_needed, initial_rels);
3513 for (i = 2; i <= nbaserel; i++)
3515 list_free(current_hint->join_hint_level[i]);
3517 /* free Leading hint only */
3518 if (join_method_hints[i] != NULL &&
3519 join_method_hints[i]->enforce_mask == ENABLE_ALL_JOIN)
3520 JoinMethodHintDelete(join_method_hints[i]);
3522 pfree(current_hint->join_hint_level);
3523 pfree(join_method_hints);
3525 if (leading_hint_enable)
3526 set_join_config_options(current_hint->init_join_mask,
3527 current_hint->context);
3534 * Build access paths for a base relation
3536 * This function was copied and edited from set_rel_pathlist() in
3537 * src/backend/optimizer/path/allpaths.c
3540 set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
3541 Index rti, RangeTblEntry *rte)
3543 #if PG_VERSION_NUM >= 90200
3544 if (IS_DUMMY_REL(rel))
3546 /* We already proved the relation empty, so nothing more to do */
3553 /* It's an "append relation", process accordingly */
3554 set_append_rel_pathlist(root, rel, rti, rte);
3558 if (rel->rtekind == RTE_RELATION)
3560 if (rte->relkind == RELKIND_RELATION)
3562 /* Plain relation */
3563 set_plain_rel_pathlist(root, rel, rte);
3566 elog(ERROR, "unexpected relkind: %c", rte->relkind);
3569 elog(ERROR, "unexpected rtekind: %d", (int) rel->rtekind);
3574 * stmt_beg callback is called when each query in PL/pgSQL function is about
3575 * to be executed. At that timing, we save query string in the global variable
3576 * plpgsql_query_string to use it in planner hook. It's safe to use one global
3577 * variable for the purpose, because its content is only necessary until
3578 * planner hook is called for the query, so recursive PL/pgSQL function calls
3579 * don't harm this mechanismk.
3582 pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt)
3584 if ((enum PLpgSQL_stmt_types) stmt->cmd_type == PLPGSQL_STMT_EXECSQL)
3586 PLpgSQL_expr *expr = ((PLpgSQL_stmt_execsql *) stmt)->sqlstmt;
3587 plpgsql_query_string = expr->query;
3592 * stmt_end callback is called then each query in PL/pgSQL function has
3593 * finished. At that timing, we clear plpgsql_query_string to tell planner
3594 * hook that next call is not for a query written in PL/pgSQL block.
3597 pg_hint_plan_plpgsql_stmt_end(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt)
3599 if ((enum PLpgSQL_stmt_types) stmt->cmd_type == PLPGSQL_STMT_EXECSQL)
3600 plpgsql_query_string = NULL;
3603 #define standard_join_search pg_hint_plan_standard_join_search
3604 #define join_search_one_level pg_hint_plan_join_search_one_level
3605 #define make_join_rel make_join_rel_wrapper
3608 #undef make_join_rel
3609 #define make_join_rel pg_hint_plan_make_join_rel
3610 #define add_paths_to_joinrel add_paths_to_joinrel_wrapper
3611 #include "make_join_rel.c"
3613 #include "pg_stat_statements.c"