1 /*-------------------------------------------------------------------------
4 * hinting on how to execute a query for PostgreSQL
6 * Copyright (c) 2012-2020, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
8 *-------------------------------------------------------------------------
13 #include "access/genam.h"
14 #include "access/heapam.h"
15 #include "access/relation.h"
16 #include "catalog/pg_collation.h"
17 #include "catalog/pg_index.h"
18 #include "commands/prepare.h"
19 #include "mb/pg_wchar.h"
20 #include "miscadmin.h"
21 #include "nodes/nodeFuncs.h"
22 #include "nodes/params.h"
23 #include "optimizer/appendinfo.h"
24 #include "optimizer/clauses.h"
25 #include "optimizer/cost.h"
26 #include "optimizer/geqo.h"
27 #include "optimizer/joininfo.h"
28 #include "optimizer/optimizer.h"
29 #include "optimizer/pathnode.h"
30 #include "optimizer/paths.h"
31 #include "optimizer/plancat.h"
32 #include "optimizer/planner.h"
33 #include "optimizer/prep.h"
34 #include "optimizer/restrictinfo.h"
35 #include "parser/analyze.h"
36 #include "parser/parsetree.h"
37 #include "parser/scansup.h"
38 #include "partitioning/partbounds.h"
39 #include "tcop/utility.h"
40 #include "utils/builtins.h"
41 #include "utils/float.h"
42 #include "utils/lsyscache.h"
43 #include "utils/memutils.h"
44 #include "utils/rel.h"
45 #include "utils/snapmgr.h"
46 #include "utils/syscache.h"
47 #include "utils/resowner.h"
49 #include "catalog/pg_class.h"
51 #include "executor/spi.h"
52 #include "catalog/pg_type.h"
56 /* partially copied from pg_stat_statements */
57 #include "normalize_query.h"
60 #include "access/htup_details.h"
62 #ifdef PG_MODULE_MAGIC
66 #define BLOCK_COMMENT_START "/*"
67 #define BLOCK_COMMENT_END "*/"
68 #define HINT_COMMENT_KEYWORD "+"
69 #define HINT_START BLOCK_COMMENT_START HINT_COMMENT_KEYWORD
70 #define HINT_END BLOCK_COMMENT_END
73 #define HINT_SEQSCAN "SeqScan"
74 #define HINT_INDEXSCAN "IndexScan"
75 #define HINT_INDEXSCANREGEXP "IndexScanRegexp"
76 #define HINT_BITMAPSCAN "BitmapScan"
77 #define HINT_BITMAPSCANREGEXP "BitmapScanRegexp"
78 #define HINT_TIDSCAN "TidScan"
79 #define HINT_NOSEQSCAN "NoSeqScan"
80 #define HINT_NOINDEXSCAN "NoIndexScan"
81 #define HINT_NOBITMAPSCAN "NoBitmapScan"
82 #define HINT_NOTIDSCAN "NoTidScan"
83 #define HINT_INDEXONLYSCAN "IndexOnlyScan"
84 #define HINT_INDEXONLYSCANREGEXP "IndexOnlyScanRegexp"
85 #define HINT_NOINDEXONLYSCAN "NoIndexOnlyScan"
86 #define HINT_PARALLEL "Parallel"
88 #define HINT_NESTLOOP "NestLoop"
89 #define HINT_MERGEJOIN "MergeJoin"
90 #define HINT_HASHJOIN "HashJoin"
91 #define HINT_NONESTLOOP "NoNestLoop"
92 #define HINT_NOMERGEJOIN "NoMergeJoin"
93 #define HINT_NOHASHJOIN "NoHashJoin"
94 #define HINT_LEADING "Leading"
95 #define HINT_SET "Set"
96 #define HINT_ROWS "Rows"
98 #define HINT_ARRAY_DEFAULT_INITSIZE 8
100 #define hint_ereport(str, detail) hint_parse_ereport(str, detail)
101 #define hint_parse_ereport(str, detail) \
103 ereport(pg_hint_plan_parse_message_level, \
104 (errmsg("pg_hint_plan: hint syntax error at or near \"%s\"", (str)), \
105 errdetail detail)); \
108 #define skip_space(str) \
109 while (isspace(*str)) \
114 ENABLE_SEQSCAN = 0x01,
115 ENABLE_INDEXSCAN = 0x02,
116 ENABLE_BITMAPSCAN = 0x04,
117 ENABLE_TIDSCAN = 0x08,
118 ENABLE_INDEXONLYSCAN = 0x10
123 ENABLE_NESTLOOP = 0x01,
124 ENABLE_MERGEJOIN = 0x02,
125 ENABLE_HASHJOIN = 0x04
128 #define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
129 ENABLE_BITMAPSCAN | ENABLE_TIDSCAN | \
130 ENABLE_INDEXONLYSCAN)
131 #define ENABLE_ALL_JOIN (ENABLE_NESTLOOP | ENABLE_MERGEJOIN | ENABLE_HASHJOIN)
132 #define DISABLE_ALL_SCAN 0
133 #define DISABLE_ALL_JOIN 0
135 /* hint keyword of enum type*/
136 typedef enum HintKeyword
138 HINT_KEYWORD_SEQSCAN,
139 HINT_KEYWORD_INDEXSCAN,
140 HINT_KEYWORD_INDEXSCANREGEXP,
141 HINT_KEYWORD_BITMAPSCAN,
142 HINT_KEYWORD_BITMAPSCANREGEXP,
143 HINT_KEYWORD_TIDSCAN,
144 HINT_KEYWORD_NOSEQSCAN,
145 HINT_KEYWORD_NOINDEXSCAN,
146 HINT_KEYWORD_NOBITMAPSCAN,
147 HINT_KEYWORD_NOTIDSCAN,
148 HINT_KEYWORD_INDEXONLYSCAN,
149 HINT_KEYWORD_INDEXONLYSCANREGEXP,
150 HINT_KEYWORD_NOINDEXONLYSCAN,
152 HINT_KEYWORD_NESTLOOP,
153 HINT_KEYWORD_MERGEJOIN,
154 HINT_KEYWORD_HASHJOIN,
155 HINT_KEYWORD_NONESTLOOP,
156 HINT_KEYWORD_NOMERGEJOIN,
157 HINT_KEYWORD_NOHASHJOIN,
159 HINT_KEYWORD_LEADING,
162 HINT_KEYWORD_PARALLEL,
164 HINT_KEYWORD_UNRECOGNIZED
167 #define SCAN_HINT_ACCEPTS_INDEX_NAMES(kw) \
168 (kw == HINT_KEYWORD_INDEXSCAN || \
169 kw == HINT_KEYWORD_INDEXSCANREGEXP || \
170 kw == HINT_KEYWORD_INDEXONLYSCAN || \
171 kw == HINT_KEYWORD_INDEXONLYSCANREGEXP || \
172 kw == HINT_KEYWORD_BITMAPSCAN || \
173 kw == HINT_KEYWORD_BITMAPSCANREGEXP)
176 typedef struct Hint Hint;
177 typedef struct HintState HintState;
179 typedef Hint *(*HintCreateFunction) (const char *hint_str,
181 HintKeyword hint_keyword);
182 typedef void (*HintDeleteFunction) (Hint *hint);
183 typedef void (*HintDescFunction) (Hint *hint, StringInfo buf, bool nolf);
184 typedef int (*HintCmpFunction) (const Hint *a, const Hint *b);
185 typedef const char *(*HintParseFunction) (Hint *hint, HintState *hstate,
186 Query *parse, const char *str);
189 #define NUM_HINT_TYPE 6
190 typedef enum HintType
192 HINT_TYPE_SCAN_METHOD,
193 HINT_TYPE_JOIN_METHOD,
200 typedef enum HintTypeBitmap
202 HINT_BM_SCAN_METHOD = 1,
206 static const char *HintTypeName[] = {
216 typedef enum HintStatus
218 HINT_STATE_NOTUSED = 0, /* specified relation not used in query */
219 HINT_STATE_USED, /* hint is used */
220 HINT_STATE_DUPLICATION, /* specified hint duplication */
221 HINT_STATE_ERROR /* execute error (parse error does not include
225 #define hint_state_enabled(hint) ((hint)->base.state == HINT_STATE_NOTUSED || \
226 (hint)->base.state == HINT_STATE_USED)
228 static unsigned int qno = 0;
229 static unsigned int msgqno = 0;
230 static char qnostr[32];
231 static const char *current_hint_str = NULL;
234 * However we usually take a hint stirng in post_parse_analyze_hook, we still
235 * need to do so in planner_hook when client starts query execution from the
236 * bind message on a prepared query. This variable prevent duplicate and
237 * sometimes harmful hint string retrieval.
239 static bool current_hint_retrieved = false;
241 /* common data for all hints. */
244 const char *hint_str; /* must not do pfree */
245 const char *keyword; /* must not do pfree */
246 HintKeyword hint_keyword;
249 HintDeleteFunction delete_func;
250 HintDescFunction desc_func;
251 HintCmpFunction cmp_func;
252 HintParseFunction parse_func;
255 /* scan method hints */
256 typedef struct ScanMethodHint
262 unsigned char enforce_mask;
265 typedef struct ParentIndexInfo
270 char *expression_str;
277 /* join method hints */
278 typedef struct JoinMethodHint
284 unsigned char enforce_mask;
286 Relids inner_joinrelids;
289 /* join order hints */
290 typedef struct OuterInnerRels
293 List *outer_inner_pair;
296 typedef struct LeadingHint
299 List *relations; /* relation names specified in Leading hint */
300 OuterInnerRels *outer_inner;
303 /* change a run-time parameter hints */
304 typedef struct SetHint
307 char *name; /* name of variable */
313 typedef enum RowsValueType {
314 RVT_ABSOLUTE, /* Rows(... #1000) */
315 RVT_ADD, /* Rows(... +1000) */
316 RVT_SUB, /* Rows(... -1000) */
317 RVT_MULTI, /* Rows(... *1.2) */
319 typedef struct RowsHint
326 Relids inner_joinrelids;
328 RowsValueType value_type;
333 typedef struct ParallelHint
337 char *nworkers_str; /* original string of nworkers */
338 int nworkers; /* num of workers specified by Worker */
339 bool force_parallel; /* force parallel scan */
343 * Describes a context of hint processing.
347 char *hint_str; /* original hint string */
350 int nall_hints; /* # of valid all hints */
351 int max_all_hints; /* # of slots for all hints */
352 Hint **all_hints; /* parsed all hints */
354 /* # of each hints */
355 int num_hints[NUM_HINT_TYPE];
357 /* for scan method hints */
358 ScanMethodHint **scan_hints; /* parsed scan hints */
360 /* Initial values of parameters */
361 int init_scan_mask; /* enable_* mask */
362 int init_nworkers; /* max_parallel_workers_per_gather */
363 /* min_parallel_table_scan_size*/
364 int init_min_para_tablescan_size;
365 /* min_parallel_index_scan_size*/
366 int init_min_para_indexscan_size;
367 double init_paratup_cost; /* parallel_tuple_cost */
368 double init_parasetup_cost;/* parallel_setup_cost */
370 PlannerInfo *current_root; /* PlannerInfo for the followings */
371 Index parent_relid; /* inherit parent of table relid */
372 ScanMethodHint *parent_scan_hint; /* scan hint for the parent */
373 ParallelHint *parent_parallel_hint; /* parallel hint for the parent */
374 List *parent_index_infos; /* list of parent table's index */
376 JoinMethodHint **join_hints; /* parsed join hints */
377 int init_join_mask; /* initial value join parameter */
378 List **join_hint_level;
379 LeadingHint **leading_hint; /* parsed Leading hints */
380 SetHint **set_hints; /* parsed Set hints */
381 GucContext context; /* which GUC parameters can we set? */
382 RowsHint **rows_hints; /* parsed Rows hints */
383 ParallelHint **parallel_hints; /* parsed Parallel hints */
387 * Describes a hint parser module which is bound with particular hint keyword.
389 typedef struct HintParser
392 HintCreateFunction create_func;
393 HintKeyword hint_keyword;
396 /* Module callbacks */
400 static void push_hint(HintState *hstate);
401 static void pop_hint(void);
403 static void pg_hint_plan_post_parse_analyze(ParseState *pstate, Query *query);
404 static void pg_hint_plan_ProcessUtility(PlannedStmt *pstmt,
405 const char *queryString,
406 ProcessUtilityContext context,
407 ParamListInfo params, QueryEnvironment *queryEnv,
408 DestReceiver *dest, QueryCompletion *qc);
409 static PlannedStmt *pg_hint_plan_planner(Query *parse, const char *query_string,
411 ParamListInfo boundParams);
412 static RelOptInfo *pg_hint_plan_join_search(PlannerInfo *root,
416 /* Scan method hint callbacks */
417 static Hint *ScanMethodHintCreate(const char *hint_str, const char *keyword,
418 HintKeyword hint_keyword);
419 static void ScanMethodHintDelete(ScanMethodHint *hint);
420 static void ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf, bool nolf);
421 static int ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b);
422 static const char *ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate,
423 Query *parse, const char *str);
425 /* Join method hint callbacks */
426 static Hint *JoinMethodHintCreate(const char *hint_str, const char *keyword,
427 HintKeyword hint_keyword);
428 static void JoinMethodHintDelete(JoinMethodHint *hint);
429 static void JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf, bool nolf);
430 static int JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b);
431 static const char *JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate,
432 Query *parse, const char *str);
434 /* Leading hint callbacks */
435 static Hint *LeadingHintCreate(const char *hint_str, const char *keyword,
436 HintKeyword hint_keyword);
437 static void LeadingHintDelete(LeadingHint *hint);
438 static void LeadingHintDesc(LeadingHint *hint, StringInfo buf, bool nolf);
439 static int LeadingHintCmp(const LeadingHint *a, const LeadingHint *b);
440 static const char *LeadingHintParse(LeadingHint *hint, HintState *hstate,
441 Query *parse, const char *str);
443 /* Set hint callbacks */
444 static Hint *SetHintCreate(const char *hint_str, const char *keyword,
445 HintKeyword hint_keyword);
446 static void SetHintDelete(SetHint *hint);
447 static void SetHintDesc(SetHint *hint, StringInfo buf, bool nolf);
448 static int SetHintCmp(const SetHint *a, const SetHint *b);
449 static const char *SetHintParse(SetHint *hint, HintState *hstate, Query *parse,
452 /* Rows hint callbacks */
453 static Hint *RowsHintCreate(const char *hint_str, const char *keyword,
454 HintKeyword hint_keyword);
455 static void RowsHintDelete(RowsHint *hint);
456 static void RowsHintDesc(RowsHint *hint, StringInfo buf, bool nolf);
457 static int RowsHintCmp(const RowsHint *a, const RowsHint *b);
458 static const char *RowsHintParse(RowsHint *hint, HintState *hstate,
459 Query *parse, const char *str);
461 /* Parallel hint callbacks */
462 static Hint *ParallelHintCreate(const char *hint_str, const char *keyword,
463 HintKeyword hint_keyword);
464 static void ParallelHintDelete(ParallelHint *hint);
465 static void ParallelHintDesc(ParallelHint *hint, StringInfo buf, bool nolf);
466 static int ParallelHintCmp(const ParallelHint *a, const ParallelHint *b);
467 static const char *ParallelHintParse(ParallelHint *hint, HintState *hstate,
468 Query *parse, const char *str);
470 static void quote_value(StringInfo buf, const char *value);
472 static const char *parse_quoted_value(const char *str, char **word,
475 RelOptInfo *pg_hint_plan_standard_join_search(PlannerInfo *root,
478 void pg_hint_plan_join_search_one_level(PlannerInfo *root, int level);
479 void pg_hint_plan_set_rel_pathlist(PlannerInfo * root, RelOptInfo *rel,
480 Index rti, RangeTblEntry *rte);
481 static void create_plain_partial_paths(PlannerInfo *root,
483 static void make_rels_by_clause_joins(PlannerInfo *root, RelOptInfo *old_rel,
484 List *other_rels_list,
485 ListCell *other_rels);
486 static void make_rels_by_clauseless_joins(PlannerInfo *root,
489 static bool has_join_restriction(PlannerInfo *root, RelOptInfo *rel);
490 static void set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
492 static void set_append_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
493 Index rti, RangeTblEntry *rte);
494 RelOptInfo *pg_hint_plan_make_join_rel(PlannerInfo *root, RelOptInfo *rel1,
497 static void pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate,
499 static void pg_hint_plan_plpgsql_stmt_end(PLpgSQL_execstate *estate,
501 static void plpgsql_query_erase_callback(ResourceReleasePhase phase,
505 static int set_config_option_noerror(const char *name, const char *value,
506 GucContext context, GucSource source,
507 GucAction action, bool changeVal, int elevel);
508 static void setup_scan_method_enforcement(ScanMethodHint *scanhint,
510 static int set_config_int32_option(const char *name, int32 value,
512 static int set_config_double_option(const char *name, double value,
516 static bool pg_hint_plan_enable_hint = true;
517 static int debug_level = 0;
518 static int pg_hint_plan_parse_message_level = INFO;
519 static int pg_hint_plan_debug_message_level = LOG;
520 /* Default is off, to keep backward compatibility. */
521 static bool pg_hint_plan_enable_hint_table = false;
523 static int plpgsql_recurse_level = 0; /* PLpgSQL recursion level */
524 static int recurse_level = 0; /* recursion level incl. direct SPI calls */
525 static int hint_inhibit_level = 0; /* Inhibit hinting if this is above 0 */
526 /* (This could not be above 1) */
527 static int max_hint_nworkers = -1; /* Maximum nworkers of Workers hints */
529 static const struct config_enum_entry parse_messages_level_options[] = {
530 {"debug", DEBUG2, true},
531 {"debug5", DEBUG5, false},
532 {"debug4", DEBUG4, false},
533 {"debug3", DEBUG3, false},
534 {"debug2", DEBUG2, false},
535 {"debug1", DEBUG1, false},
537 {"info", INFO, false},
538 {"notice", NOTICE, false},
539 {"warning", WARNING, false},
540 {"error", ERROR, false},
542 * {"fatal", FATAL, true},
543 * {"panic", PANIC, true},
548 static const struct config_enum_entry parse_debug_level_options[] = {
551 {"detailed", 2, false},
552 {"verbose", 3, false},
564 /* Saved hook values in case of unload */
565 static post_parse_analyze_hook_type prev_post_parse_analyze_hook = NULL;
566 static planner_hook_type prev_planner = NULL;
567 static join_search_hook_type prev_join_search = NULL;
568 static set_rel_pathlist_hook_type prev_set_rel_pathlist = NULL;
569 static ProcessUtility_hook_type prev_ProcessUtility_hook = NULL;
571 /* Hold reference to currently active hint */
572 static HintState *current_hint_state = NULL;
575 * List of hint contexts. We treat the head of the list as the Top of the
576 * context stack, so current_hint_state always points the first element of this
579 static List *HintStateStack = NIL;
581 static const HintParser parsers[] = {
582 {HINT_SEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_SEQSCAN},
583 {HINT_INDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCAN},
584 {HINT_INDEXSCANREGEXP, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCANREGEXP},
585 {HINT_BITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_BITMAPSCAN},
586 {HINT_BITMAPSCANREGEXP, ScanMethodHintCreate,
587 HINT_KEYWORD_BITMAPSCANREGEXP},
588 {HINT_TIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_TIDSCAN},
589 {HINT_NOSEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOSEQSCAN},
590 {HINT_NOINDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXSCAN},
591 {HINT_NOBITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOBITMAPSCAN},
592 {HINT_NOTIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOTIDSCAN},
593 {HINT_INDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXONLYSCAN},
594 {HINT_INDEXONLYSCANREGEXP, ScanMethodHintCreate,
595 HINT_KEYWORD_INDEXONLYSCANREGEXP},
596 {HINT_NOINDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXONLYSCAN},
598 {HINT_NESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NESTLOOP},
599 {HINT_MERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_MERGEJOIN},
600 {HINT_HASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_HASHJOIN},
601 {HINT_NONESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NONESTLOOP},
602 {HINT_NOMERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOMERGEJOIN},
603 {HINT_NOHASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOHASHJOIN},
605 {HINT_LEADING, LeadingHintCreate, HINT_KEYWORD_LEADING},
606 {HINT_SET, SetHintCreate, HINT_KEYWORD_SET},
607 {HINT_ROWS, RowsHintCreate, HINT_KEYWORD_ROWS},
608 {HINT_PARALLEL, ParallelHintCreate, HINT_KEYWORD_PARALLEL},
610 {NULL, NULL, HINT_KEYWORD_UNRECOGNIZED}
613 PLpgSQL_plugin plugin_funcs = {
617 pg_hint_plan_plpgsql_stmt_beg,
618 pg_hint_plan_plpgsql_stmt_end,
624 * Module load callbacks
629 PLpgSQL_plugin **var_ptr;
631 /* Define custom GUC variables. */
632 DefineCustomBoolVariable("pg_hint_plan.enable_hint",
633 "Force planner to use plans specified in the hint comment preceding to the query.",
635 &pg_hint_plan_enable_hint,
643 DefineCustomEnumVariable("pg_hint_plan.debug_print",
644 "Logs results of hint parsing.",
648 parse_debug_level_options,
655 DefineCustomEnumVariable("pg_hint_plan.parse_messages",
656 "Message level of parse errors.",
658 &pg_hint_plan_parse_message_level,
660 parse_messages_level_options,
667 DefineCustomEnumVariable("pg_hint_plan.message_level",
668 "Message level of debug messages.",
670 &pg_hint_plan_debug_message_level,
672 parse_messages_level_options,
679 DefineCustomBoolVariable("pg_hint_plan.enable_hint_table",
680 "Let pg_hint_plan look up the hint table.",
682 &pg_hint_plan_enable_hint_table,
691 prev_post_parse_analyze_hook = post_parse_analyze_hook;
692 post_parse_analyze_hook = pg_hint_plan_post_parse_analyze;
693 prev_planner = planner_hook;
694 planner_hook = pg_hint_plan_planner;
695 prev_join_search = join_search_hook;
696 join_search_hook = pg_hint_plan_join_search;
697 prev_set_rel_pathlist = set_rel_pathlist_hook;
698 set_rel_pathlist_hook = pg_hint_plan_set_rel_pathlist;
699 prev_ProcessUtility_hook = ProcessUtility_hook;
700 ProcessUtility_hook = pg_hint_plan_ProcessUtility;
702 /* setup PL/pgSQL plugin hook */
703 var_ptr = (PLpgSQL_plugin **) find_rendezvous_variable("PLpgSQL_plugin");
704 *var_ptr = &plugin_funcs;
706 RegisterResourceReleaseCallback(plpgsql_query_erase_callback, NULL);
710 * Module unload callback
716 PLpgSQL_plugin **var_ptr;
718 /* Uninstall hooks. */
719 post_parse_analyze_hook = prev_post_parse_analyze_hook;
720 planner_hook = prev_planner;
721 join_search_hook = prev_join_search;
722 set_rel_pathlist_hook = prev_set_rel_pathlist;
723 ProcessUtility_hook = prev_ProcessUtility_hook;
725 /* uninstall PL/pgSQL plugin hook */
726 var_ptr = (PLpgSQL_plugin **) find_rendezvous_variable("PLpgSQL_plugin");
731 * create and delete functions the hint object
735 ScanMethodHintCreate(const char *hint_str, const char *keyword,
736 HintKeyword hint_keyword)
738 ScanMethodHint *hint;
740 hint = palloc(sizeof(ScanMethodHint));
741 hint->base.hint_str = hint_str;
742 hint->base.keyword = keyword;
743 hint->base.hint_keyword = hint_keyword;
744 hint->base.type = HINT_TYPE_SCAN_METHOD;
745 hint->base.state = HINT_STATE_NOTUSED;
746 hint->base.delete_func = (HintDeleteFunction) ScanMethodHintDelete;
747 hint->base.desc_func = (HintDescFunction) ScanMethodHintDesc;
748 hint->base.cmp_func = (HintCmpFunction) ScanMethodHintCmp;
749 hint->base.parse_func = (HintParseFunction) ScanMethodHintParse;
750 hint->relname = NULL;
751 hint->indexnames = NIL;
752 hint->regexp = false;
753 hint->enforce_mask = 0;
755 return (Hint *) hint;
759 ScanMethodHintDelete(ScanMethodHint *hint)
765 pfree(hint->relname);
766 list_free_deep(hint->indexnames);
771 JoinMethodHintCreate(const char *hint_str, const char *keyword,
772 HintKeyword hint_keyword)
774 JoinMethodHint *hint;
776 hint = palloc(sizeof(JoinMethodHint));
777 hint->base.hint_str = hint_str;
778 hint->base.keyword = keyword;
779 hint->base.hint_keyword = hint_keyword;
780 hint->base.type = HINT_TYPE_JOIN_METHOD;
781 hint->base.state = HINT_STATE_NOTUSED;
782 hint->base.delete_func = (HintDeleteFunction) JoinMethodHintDelete;
783 hint->base.desc_func = (HintDescFunction) JoinMethodHintDesc;
784 hint->base.cmp_func = (HintCmpFunction) JoinMethodHintCmp;
785 hint->base.parse_func = (HintParseFunction) JoinMethodHintParse;
787 hint->inner_nrels = 0;
788 hint->relnames = NULL;
789 hint->enforce_mask = 0;
790 hint->joinrelids = NULL;
791 hint->inner_joinrelids = NULL;
793 return (Hint *) hint;
797 JoinMethodHintDelete(JoinMethodHint *hint)
806 for (i = 0; i < hint->nrels; i++)
807 pfree(hint->relnames[i]);
808 pfree(hint->relnames);
811 bms_free(hint->joinrelids);
812 bms_free(hint->inner_joinrelids);
817 LeadingHintCreate(const char *hint_str, const char *keyword,
818 HintKeyword hint_keyword)
822 hint = palloc(sizeof(LeadingHint));
823 hint->base.hint_str = hint_str;
824 hint->base.keyword = keyword;
825 hint->base.hint_keyword = hint_keyword;
826 hint->base.type = HINT_TYPE_LEADING;
827 hint->base.state = HINT_STATE_NOTUSED;
828 hint->base.delete_func = (HintDeleteFunction)LeadingHintDelete;
829 hint->base.desc_func = (HintDescFunction) LeadingHintDesc;
830 hint->base.cmp_func = (HintCmpFunction) LeadingHintCmp;
831 hint->base.parse_func = (HintParseFunction) LeadingHintParse;
832 hint->relations = NIL;
833 hint->outer_inner = NULL;
835 return (Hint *) hint;
839 LeadingHintDelete(LeadingHint *hint)
844 list_free_deep(hint->relations);
845 if (hint->outer_inner)
846 pfree(hint->outer_inner);
851 SetHintCreate(const char *hint_str, const char *keyword,
852 HintKeyword hint_keyword)
856 hint = palloc(sizeof(SetHint));
857 hint->base.hint_str = hint_str;
858 hint->base.keyword = keyword;
859 hint->base.hint_keyword = hint_keyword;
860 hint->base.type = HINT_TYPE_SET;
861 hint->base.state = HINT_STATE_NOTUSED;
862 hint->base.delete_func = (HintDeleteFunction) SetHintDelete;
863 hint->base.desc_func = (HintDescFunction) SetHintDesc;
864 hint->base.cmp_func = (HintCmpFunction) SetHintCmp;
865 hint->base.parse_func = (HintParseFunction) SetHintParse;
870 return (Hint *) hint;
874 SetHintDelete(SetHint *hint)
884 list_free(hint->words);
889 RowsHintCreate(const char *hint_str, const char *keyword,
890 HintKeyword hint_keyword)
894 hint = palloc(sizeof(RowsHint));
895 hint->base.hint_str = hint_str;
896 hint->base.keyword = keyword;
897 hint->base.hint_keyword = hint_keyword;
898 hint->base.type = HINT_TYPE_ROWS;
899 hint->base.state = HINT_STATE_NOTUSED;
900 hint->base.delete_func = (HintDeleteFunction) RowsHintDelete;
901 hint->base.desc_func = (HintDescFunction) RowsHintDesc;
902 hint->base.cmp_func = (HintCmpFunction) RowsHintCmp;
903 hint->base.parse_func = (HintParseFunction) RowsHintParse;
905 hint->inner_nrels = 0;
906 hint->relnames = NULL;
907 hint->joinrelids = NULL;
908 hint->inner_joinrelids = NULL;
909 hint->rows_str = NULL;
910 hint->value_type = RVT_ABSOLUTE;
913 return (Hint *) hint;
917 RowsHintDelete(RowsHint *hint)
926 for (i = 0; i < hint->nrels; i++)
927 pfree(hint->relnames[i]);
928 pfree(hint->relnames);
931 bms_free(hint->joinrelids);
932 bms_free(hint->inner_joinrelids);
937 ParallelHintCreate(const char *hint_str, const char *keyword,
938 HintKeyword hint_keyword)
942 hint = palloc(sizeof(ParallelHint));
943 hint->base.hint_str = hint_str;
944 hint->base.keyword = keyword;
945 hint->base.hint_keyword = hint_keyword;
946 hint->base.type = HINT_TYPE_PARALLEL;
947 hint->base.state = HINT_STATE_NOTUSED;
948 hint->base.delete_func = (HintDeleteFunction) ParallelHintDelete;
949 hint->base.desc_func = (HintDescFunction) ParallelHintDesc;
950 hint->base.cmp_func = (HintCmpFunction) ParallelHintCmp;
951 hint->base.parse_func = (HintParseFunction) ParallelHintParse;
952 hint->relname = NULL;
954 hint->nworkers_str = "0";
956 return (Hint *) hint;
960 ParallelHintDelete(ParallelHint *hint)
966 pfree(hint->relname);
972 HintStateCreate(void)
976 hstate = palloc(sizeof(HintState));
977 hstate->hint_str = NULL;
978 hstate->nall_hints = 0;
979 hstate->max_all_hints = 0;
980 hstate->all_hints = NULL;
981 memset(hstate->num_hints, 0, sizeof(hstate->num_hints));
982 hstate->scan_hints = NULL;
983 hstate->init_scan_mask = 0;
984 hstate->init_nworkers = 0;
985 hstate->init_min_para_tablescan_size = 0;
986 hstate->init_min_para_indexscan_size = 0;
987 hstate->init_paratup_cost = 0;
988 hstate->init_parasetup_cost = 0;
989 hstate->current_root = NULL;
990 hstate->parent_relid = 0;
991 hstate->parent_scan_hint = NULL;
992 hstate->parent_parallel_hint = NULL;
993 hstate->parent_index_infos = NIL;
994 hstate->join_hints = NULL;
995 hstate->init_join_mask = 0;
996 hstate->join_hint_level = NULL;
997 hstate->leading_hint = NULL;
998 hstate->context = superuser() ? PGC_SUSET : PGC_USERSET;
999 hstate->set_hints = NULL;
1000 hstate->rows_hints = NULL;
1001 hstate->parallel_hints = NULL;
1007 HintStateDelete(HintState *hstate)
1014 if (hstate->hint_str)
1015 pfree(hstate->hint_str);
1017 for (i = 0; i < hstate->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
1018 hstate->all_hints[i]->delete_func(hstate->all_hints[i]);
1019 if (hstate->all_hints)
1020 pfree(hstate->all_hints);
1021 if (hstate->parent_index_infos)
1022 list_free(hstate->parent_index_infos);
1026 * Copy given value into buf, with quoting with '"' if necessary.
1029 quote_value(StringInfo buf, const char *value)
1031 bool need_quote = false;
1034 for (str = value; *str != '\0'; str++)
1036 if (isspace(*str) || *str == '(' || *str == ')' || *str == '"')
1039 appendStringInfoCharMacro(buf, '"');
1044 for (str = value; *str != '\0'; str++)
1047 appendStringInfoCharMacro(buf, '"');
1049 appendStringInfoCharMacro(buf, *str);
1053 appendStringInfoCharMacro(buf, '"');
1057 ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf, bool nolf)
1061 appendStringInfo(buf, "%s(", hint->base.keyword);
1062 if (hint->relname != NULL)
1064 quote_value(buf, hint->relname);
1065 foreach(l, hint->indexnames)
1067 appendStringInfoCharMacro(buf, ' ');
1068 quote_value(buf, (char *) lfirst(l));
1071 appendStringInfoString(buf, ")");
1073 appendStringInfoChar(buf, '\n');
1077 JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf, bool nolf)
1081 appendStringInfo(buf, "%s(", hint->base.keyword);
1082 if (hint->relnames != NULL)
1084 quote_value(buf, hint->relnames[0]);
1085 for (i = 1; i < hint->nrels; i++)
1087 appendStringInfoCharMacro(buf, ' ');
1088 quote_value(buf, hint->relnames[i]);
1091 appendStringInfoString(buf, ")");
1093 appendStringInfoChar(buf, '\n');
1097 OuterInnerDesc(OuterInnerRels *outer_inner, StringInfo buf)
1099 if (outer_inner->relation == NULL)
1106 appendStringInfoCharMacro(buf, '(');
1107 foreach(l, outer_inner->outer_inner_pair)
1112 appendStringInfoCharMacro(buf, ' ');
1114 OuterInnerDesc(lfirst(l), buf);
1117 appendStringInfoCharMacro(buf, ')');
1120 quote_value(buf, outer_inner->relation);
1124 LeadingHintDesc(LeadingHint *hint, StringInfo buf, bool nolf)
1126 appendStringInfo(buf, "%s(", HINT_LEADING);
1127 if (hint->outer_inner == NULL)
1134 foreach(l, hint->relations)
1139 appendStringInfoCharMacro(buf, ' ');
1141 quote_value(buf, (char *) lfirst(l));
1145 OuterInnerDesc(hint->outer_inner, buf);
1147 appendStringInfoString(buf, ")");
1149 appendStringInfoChar(buf, '\n');
1153 SetHintDesc(SetHint *hint, StringInfo buf, bool nolf)
1155 bool is_first = true;
1158 appendStringInfo(buf, "%s(", HINT_SET);
1159 foreach(l, hint->words)
1164 appendStringInfoCharMacro(buf, ' ');
1166 quote_value(buf, (char *) lfirst(l));
1168 appendStringInfo(buf, ")");
1170 appendStringInfoChar(buf, '\n');
1174 RowsHintDesc(RowsHint *hint, StringInfo buf, bool nolf)
1178 appendStringInfo(buf, "%s(", hint->base.keyword);
1179 if (hint->relnames != NULL)
1181 quote_value(buf, hint->relnames[0]);
1182 for (i = 1; i < hint->nrels; i++)
1184 appendStringInfoCharMacro(buf, ' ');
1185 quote_value(buf, hint->relnames[i]);
1188 if (hint->rows_str != NULL)
1189 appendStringInfo(buf, " %s", hint->rows_str);
1190 appendStringInfoString(buf, ")");
1192 appendStringInfoChar(buf, '\n');
1196 ParallelHintDesc(ParallelHint *hint, StringInfo buf, bool nolf)
1198 appendStringInfo(buf, "%s(", hint->base.keyword);
1199 if (hint->relname != NULL)
1201 quote_value(buf, hint->relname);
1203 /* number of workers */
1204 appendStringInfoCharMacro(buf, ' ');
1205 quote_value(buf, hint->nworkers_str);
1206 /* application mode of num of workers */
1207 appendStringInfoCharMacro(buf, ' ');
1208 appendStringInfoString(buf,
1209 (hint->force_parallel ? "hard" : "soft"));
1211 appendStringInfoString(buf, ")");
1213 appendStringInfoChar(buf, '\n');
1217 * Append string which represents all hints in a given state to buf, with
1218 * preceding title with them.
1221 desc_hint_in_state(HintState *hstate, StringInfo buf, const char *title,
1222 HintStatus state, bool nolf)
1226 appendStringInfo(buf, "%s:", title);
1228 appendStringInfoChar(buf, '\n');
1231 for (i = 0; i < hstate->nall_hints; i++)
1233 if (hstate->all_hints[i]->state != state)
1236 hstate->all_hints[i]->desc_func(hstate->all_hints[i], buf, nolf);
1240 if (nolf && nshown == 0)
1241 appendStringInfoString(buf, "(none)");
1245 * Dump contents of given hstate to server log with log level LOG.
1248 HintStateDump(HintState *hstate)
1254 elog(pg_hint_plan_debug_message_level, "pg_hint_plan:\nno hint");
1258 initStringInfo(&buf);
1260 appendStringInfoString(&buf, "pg_hint_plan:\n");
1261 desc_hint_in_state(hstate, &buf, "used hint", HINT_STATE_USED, false);
1262 desc_hint_in_state(hstate, &buf, "not used hint", HINT_STATE_NOTUSED, false);
1263 desc_hint_in_state(hstate, &buf, "duplication hint", HINT_STATE_DUPLICATION, false);
1264 desc_hint_in_state(hstate, &buf, "error hint", HINT_STATE_ERROR, false);
1266 ereport(pg_hint_plan_debug_message_level,
1267 (errmsg ("%s", buf.data)));
1273 HintStateDump2(HintState *hstate)
1279 elog(pg_hint_plan_debug_message_level,
1280 "pg_hint_plan%s: HintStateDump: no hint", qnostr);
1284 initStringInfo(&buf);
1285 appendStringInfo(&buf, "pg_hint_plan%s: HintStateDump: ", qnostr);
1286 desc_hint_in_state(hstate, &buf, "{used hints", HINT_STATE_USED, true);
1287 desc_hint_in_state(hstate, &buf, "}, {not used hints", HINT_STATE_NOTUSED, true);
1288 desc_hint_in_state(hstate, &buf, "}, {duplicate hints", HINT_STATE_DUPLICATION, true);
1289 desc_hint_in_state(hstate, &buf, "}, {error hints", HINT_STATE_ERROR, true);
1290 appendStringInfoChar(&buf, '}');
1292 ereport(pg_hint_plan_debug_message_level,
1293 (errmsg("%s", buf.data),
1295 errhidecontext(true)));
1305 RelnameCmp(const void *a, const void *b)
1307 const char *relnamea = *((const char **) a);
1308 const char *relnameb = *((const char **) b);
1310 return strcmp(relnamea, relnameb);
1314 ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b)
1316 return RelnameCmp(&a->relname, &b->relname);
1320 JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b)
1324 if (a->nrels != b->nrels)
1325 return a->nrels - b->nrels;
1327 for (i = 0; i < a->nrels; i++)
1330 if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0)
1338 LeadingHintCmp(const LeadingHint *a, const LeadingHint *b)
1344 SetHintCmp(const SetHint *a, const SetHint *b)
1346 return strcmp(a->name, b->name);
1350 RowsHintCmp(const RowsHint *a, const RowsHint *b)
1354 if (a->nrels != b->nrels)
1355 return a->nrels - b->nrels;
1357 for (i = 0; i < a->nrels; i++)
1360 if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0)
1368 ParallelHintCmp(const ParallelHint *a, const ParallelHint *b)
1370 return RelnameCmp(&a->relname, &b->relname);
1374 HintCmp(const void *a, const void *b)
1376 const Hint *hinta = *((const Hint **) a);
1377 const Hint *hintb = *((const Hint **) b);
1379 if (hinta->type != hintb->type)
1380 return hinta->type - hintb->type;
1381 if (hinta->state == HINT_STATE_ERROR)
1383 if (hintb->state == HINT_STATE_ERROR)
1385 return hinta->cmp_func(hinta, hintb);
1389 * Returns byte offset of hint b from hint a. If hint a was specified before
1390 * b, positive value is returned.
1393 HintCmpWithPos(const void *a, const void *b)
1395 const Hint *hinta = *((const Hint **) a);
1396 const Hint *hintb = *((const Hint **) b);
1399 result = HintCmp(a, b);
1401 result = hinta->hint_str - hintb->hint_str;
1410 parse_keyword(const char *str, StringInfo buf)
1414 while (!isspace(*str) && *str != '(' && *str != '\0')
1415 appendStringInfoCharMacro(buf, *str++);
1421 skip_parenthesis(const char *str, char parenthesis)
1425 if (*str != parenthesis)
1427 if (parenthesis == '(')
1428 hint_ereport(str, ("Opening parenthesis is necessary."));
1429 else if (parenthesis == ')')
1430 hint_ereport(str, ("Closing parenthesis is necessary."));
1441 * Parse a token from str, and store malloc'd copy into word. A token can be
1442 * quoted with '"'. Return value is pointer to unparsed portion of original
1443 * string, or NULL if an error occurred.
1445 * Parsed token is truncated within NAMEDATALEN-1 bytes, when truncate is true.
1448 parse_quoted_value(const char *str, char **word, bool truncate)
1453 /* Skip leading spaces. */
1456 initStringInfo(&buf);
1469 /* Double quotation must be closed. */
1473 hint_ereport(str, ("Unterminated quoted string."));
1478 * Skip escaped double quotation.
1480 * We don't allow slash-asterisk and asterisk-slash (delimiters of
1481 * block comments) to be an object name, so users must specify
1482 * alias for such object names.
1484 * Those special names can be allowed if we care escaped slashes
1485 * and asterisks, but we don't.
1494 else if (isspace(*str) || *str == '(' || *str == ')' || *str == '"' ||
1498 appendStringInfoCharMacro(&buf, *str++);
1503 hint_ereport(str, ("Zero-length delimited string."));
1510 /* Truncate name if it's too long */
1512 truncate_identifier(buf.data, strlen(buf.data), true);
1519 static OuterInnerRels *
1520 OuterInnerRelsCreate(char *name, List *outer_inner_list)
1522 OuterInnerRels *outer_inner;
1524 outer_inner = palloc(sizeof(OuterInnerRels));
1525 outer_inner->relation = name;
1526 outer_inner->outer_inner_pair = outer_inner_list;
1532 parse_parentheses_Leading_in(const char *str, OuterInnerRels **outer_inner)
1534 List *outer_inner_pair = NIL;
1536 if ((str = skip_parenthesis(str, '(')) == NULL)
1541 /* Store words in parentheses into outer_inner_list. */
1542 while(*str != ')' && *str != '\0')
1544 OuterInnerRels *outer_inner_rels;
1548 str = parse_parentheses_Leading_in(str, &outer_inner_rels);
1556 if ((str = parse_quoted_value(str, &name, true)) == NULL)
1559 outer_inner_rels = OuterInnerRelsCreate(name, NIL);
1562 outer_inner_pair = lappend(outer_inner_pair, outer_inner_rels);
1567 (str = skip_parenthesis(str, ')')) == NULL)
1569 list_free(outer_inner_pair);
1573 *outer_inner = OuterInnerRelsCreate(NULL, outer_inner_pair);
1579 parse_parentheses_Leading(const char *str, List **name_list,
1580 OuterInnerRels **outer_inner)
1583 bool truncate = true;
1585 if ((str = skip_parenthesis(str, '(')) == NULL)
1591 if ((str = parse_parentheses_Leading_in(str, outer_inner)) == NULL)
1596 /* Store words in parentheses into name_list. */
1597 while(*str != ')' && *str != '\0')
1599 if ((str = parse_quoted_value(str, &name, truncate)) == NULL)
1601 list_free(*name_list);
1605 *name_list = lappend(*name_list, name);
1610 if ((str = skip_parenthesis(str, ')')) == NULL)
1616 parse_parentheses(const char *str, List **name_list, HintKeyword keyword)
1619 bool truncate = true;
1621 if ((str = skip_parenthesis(str, '(')) == NULL)
1626 /* Store words in parentheses into name_list. */
1627 while(*str != ')' && *str != '\0')
1629 if ((str = parse_quoted_value(str, &name, truncate)) == NULL)
1631 list_free(*name_list);
1635 *name_list = lappend(*name_list, name);
1638 if (keyword == HINT_KEYWORD_INDEXSCANREGEXP ||
1639 keyword == HINT_KEYWORD_INDEXONLYSCANREGEXP ||
1640 keyword == HINT_KEYWORD_BITMAPSCANREGEXP ||
1641 keyword == HINT_KEYWORD_SET)
1647 if ((str = skip_parenthesis(str, ')')) == NULL)
1653 parse_hints(HintState *hstate, Query *parse, const char *str)
1658 initStringInfo(&buf);
1659 while (*str != '\0')
1661 const HintParser *parser;
1663 /* in error message, we output the comment including the keyword. */
1664 head = (char *) str;
1666 /* parse only the keyword of the hint. */
1667 resetStringInfo(&buf);
1668 str = parse_keyword(str, &buf);
1670 for (parser = parsers; parser->keyword != NULL; parser++)
1672 char *keyword = parser->keyword;
1675 if (pg_strcasecmp(buf.data, keyword) != 0)
1678 hint = parser->create_func(head, keyword, parser->hint_keyword);
1680 /* parser of each hint does parse in a parenthesis. */
1681 if ((str = hint->parse_func(hint, hstate, parse, str)) == NULL)
1683 hint->delete_func(hint);
1689 * Add hint information into all_hints array. If we don't have
1690 * enough space, double the array.
1692 if (hstate->nall_hints == 0)
1694 hstate->max_all_hints = HINT_ARRAY_DEFAULT_INITSIZE;
1695 hstate->all_hints = (Hint **)
1696 palloc(sizeof(Hint *) * hstate->max_all_hints);
1698 else if (hstate->nall_hints == hstate->max_all_hints)
1700 hstate->max_all_hints *= 2;
1701 hstate->all_hints = (Hint **)
1702 repalloc(hstate->all_hints,
1703 sizeof(Hint *) * hstate->max_all_hints);
1706 hstate->all_hints[hstate->nall_hints] = hint;
1707 hstate->nall_hints++;
1714 if (parser->keyword == NULL)
1717 ("Unrecognized hint keyword \"%s\".", buf.data));
1728 * Get hints from table by client-supplied query string and application name.
1731 get_hints_from_table(const char *client_query, const char *client_application)
1733 const char *search_query =
1735 " FROM hint_plan.hints "
1736 " WHERE norm_query_string = $1 "
1737 " AND ( application_name = $2 "
1738 " OR application_name = '' ) "
1739 " ORDER BY application_name DESC";
1740 static SPIPlanPtr plan = NULL;
1742 Oid argtypes[2] = { TEXTOID, TEXTOID };
1744 char nulls[2] = {' ', ' '};
1750 bool snapshot_set = false;
1752 hint_inhibit_level++;
1754 if (!ActiveSnapshotSet())
1756 PushActiveSnapshot(GetTransactionSnapshot());
1757 snapshot_set = true;
1765 p = SPI_prepare(search_query, 2, argtypes);
1766 plan = SPI_saveplan(p);
1770 qry = cstring_to_text(client_query);
1771 app = cstring_to_text(client_application);
1772 values[0] = PointerGetDatum(qry);
1773 values[1] = PointerGetDatum(app);
1775 SPI_execute_plan(plan, values, nulls, true, 1);
1777 if (SPI_processed > 0)
1781 hints = SPI_getvalue(SPI_tuptable->vals[0],
1782 SPI_tuptable->tupdesc, 1);
1784 * Here we use SPI_palloc to ensure that hints string is valid even
1785 * after SPI_finish call. We can't use simple palloc because it
1786 * allocates memory in SPI's context and that context is deleted in
1789 buf = SPI_palloc(strlen(hints) + 1);
1797 PopActiveSnapshot();
1799 hint_inhibit_level--;
1803 hint_inhibit_level--;
1812 * Get client-supplied query string. Addtion to that the jumbled query is
1813 * supplied if the caller requested. From the restriction of JumbleQuery, some
1814 * kind of query needs special amendments. Reutrns NULL if this query doesn't
1815 * change the current hint. This function returns NULL also when something
1816 * wrong has happend and let the caller continue using the current hints.
1819 get_query_string(ParseState *pstate, Query *query, Query **jumblequery)
1821 const char *p = debug_query_string;
1824 * If debug_query_string is set, it is the top level statement. But in some
1825 * cases we reach here with debug_query_string set NULL for example in the
1826 * case of DESCRIBE message handling or EXECUTE command. We may still see a
1827 * candidate top-level query in pstate in the case.
1829 if (pstate && pstate->p_sourcetext)
1830 p = pstate->p_sourcetext;
1832 /* We don't see a query string, return NULL */
1836 if (jumblequery != NULL)
1837 *jumblequery = query;
1839 if (query->commandType == CMD_UTILITY)
1841 Query *target_query = (Query *)query->utilityStmt;
1844 * Some CMD_UTILITY statements have a subquery that we can hint on.
1845 * Since EXPLAIN can be placed before other kind of utility statements
1846 * and EXECUTE can be contained other kind of utility statements, these
1847 * conditions are not mutually exclusive and should be considered in
1850 if (IsA(target_query, ExplainStmt))
1852 ExplainStmt *stmt = (ExplainStmt *)target_query;
1854 Assert(IsA(stmt->query, Query));
1855 target_query = (Query *)stmt->query;
1857 /* strip out the top-level query for further processing */
1858 if (target_query->commandType == CMD_UTILITY &&
1859 target_query->utilityStmt != NULL)
1860 target_query = (Query *)target_query->utilityStmt;
1863 if (IsA(target_query, DeclareCursorStmt))
1865 DeclareCursorStmt *stmt = (DeclareCursorStmt *)target_query;
1866 Query *query = (Query *)stmt->query;
1868 /* the target must be CMD_SELECT in this case */
1869 Assert(IsA(query, Query) && query->commandType == CMD_SELECT);
1870 target_query = query;
1873 if (IsA(target_query, CreateTableAsStmt))
1875 CreateTableAsStmt *stmt = (CreateTableAsStmt *) target_query;
1877 Assert(IsA(stmt->query, Query));
1878 target_query = (Query *) stmt->query;
1880 /* strip out the top-level query for further processing */
1881 if (target_query->commandType == CMD_UTILITY &&
1882 target_query->utilityStmt != NULL)
1883 target_query = (Query *)target_query->utilityStmt;
1886 if (IsA(target_query, ExecuteStmt))
1889 * Use the prepared query for EXECUTE. The Query for jumble
1890 * also replaced with the corresponding one.
1892 ExecuteStmt *stmt = (ExecuteStmt *)target_query;
1893 PreparedStatement *entry;
1895 entry = FetchPreparedStatement(stmt->name, true);
1897 if (entry->plansource->is_valid)
1899 p = entry->plansource->query_string;
1900 target_query = (Query *) linitial (entry->plansource->query_list);
1904 /* igonre the hint for EXECUTE if invalidated */
1906 target_query = NULL;
1910 /* JumbleQuery accespts only a non-utility Query */
1912 (!IsA(target_query, Query) ||
1913 target_query->utilityStmt != NULL))
1914 target_query = NULL;
1917 *jumblequery = target_query;
1920 * Return NULL if pstate is not of top-level query. We don't need this
1921 * when jumble info is not requested or cannot do this when pstate is NULL.
1923 else if (!jumblequery && pstate && pstate->p_sourcetext != p &&
1924 strcmp(pstate->p_sourcetext, p) != 0)
1931 * Get hints from the head block comment in client-supplied query string.
1934 get_hints_from_comment(const char *p)
1936 const char *hint_head;
1944 /* extract query head comment. */
1945 hint_head = strstr(p, HINT_START);
1946 if (hint_head == NULL)
1948 for (;p < hint_head; p++)
1951 * Allow these characters precedes hint comment:
1953 * - alphabets which are in ASCII range
1954 * - space, tabs and new-lines
1955 * - underscores, for identifier
1956 * - commas, for SELECT clause, EXPLAIN and PREPARE
1957 * - parentheses, for EXPLAIN and PREPARE
1959 * Note that we don't use isalpha() nor isalnum() in ctype.h here to
1960 * avoid behavior which depends on locale setting.
1962 if (!(*p >= '0' && *p <= '9') &&
1963 !(*p >= 'A' && *p <= 'Z') &&
1964 !(*p >= 'a' && *p <= 'z') &&
1968 *p != '(' && *p != ')')
1972 len = strlen(HINT_START);
1977 /* find hint end keyword. */
1978 if ((tail = strstr(p, HINT_END)) == NULL)
1980 hint_ereport(head, ("Unterminated block comment."));
1984 /* We don't support nested block comments. */
1985 if ((head = strstr(p, BLOCK_COMMENT_START)) != NULL && head < tail)
1987 hint_ereport(head, ("Nested block comments are not supported."));
1991 /* Make a copy of hint. */
1993 head = palloc(len + 1);
1994 memcpy(head, p, len);
2002 * Parse hints that got, create hint struct from parse tree and parse hints.
2005 create_hintstate(Query *parse, const char *hints)
2014 /* -1 means that no Parallel hint is specified. */
2015 max_hint_nworkers = -1;
2018 hstate = HintStateCreate();
2019 hstate->hint_str = (char *) hints;
2021 /* parse each hint. */
2022 parse_hints(hstate, parse, p);
2024 /* When nothing specified a hint, we free HintState and returns NULL. */
2025 if (hstate->nall_hints == 0)
2027 HintStateDelete(hstate);
2031 /* Sort hints in order of original position. */
2032 qsort(hstate->all_hints, hstate->nall_hints, sizeof(Hint *),
2035 /* Count number of hints per hint-type. */
2036 for (i = 0; i < hstate->nall_hints; i++)
2038 Hint *cur_hint = hstate->all_hints[i];
2039 hstate->num_hints[cur_hint->type]++;
2043 * If an object (or a set of objects) has multiple hints of same hint-type,
2044 * only the last hint is valid and others are ignored in planning.
2045 * Hints except the last are marked as 'duplicated' to remember the order.
2047 for (i = 0; i < hstate->nall_hints - 1; i++)
2049 Hint *cur_hint = hstate->all_hints[i];
2050 Hint *next_hint = hstate->all_hints[i + 1];
2053 * Leading hint is marked as 'duplicated' in transform_join_hints.
2055 if (cur_hint->type == HINT_TYPE_LEADING &&
2056 next_hint->type == HINT_TYPE_LEADING)
2060 * Note that we need to pass addresses of hint pointers, because
2061 * HintCmp is designed to sort array of Hint* by qsort.
2063 if (HintCmp(&cur_hint, &next_hint) == 0)
2065 hint_ereport(cur_hint->hint_str,
2066 ("Conflict %s hint.", HintTypeName[cur_hint->type]));
2067 cur_hint->state = HINT_STATE_DUPLICATION;
2072 * Make sure that per-type array pointers point proper position in the
2073 * array which consists of all hints.
2075 hstate->scan_hints = (ScanMethodHint **) hstate->all_hints;
2076 hstate->join_hints = (JoinMethodHint **) (hstate->scan_hints +
2077 hstate->num_hints[HINT_TYPE_SCAN_METHOD]);
2078 hstate->leading_hint = (LeadingHint **) (hstate->join_hints +
2079 hstate->num_hints[HINT_TYPE_JOIN_METHOD]);
2080 hstate->set_hints = (SetHint **) (hstate->leading_hint +
2081 hstate->num_hints[HINT_TYPE_LEADING]);
2082 hstate->rows_hints = (RowsHint **) (hstate->set_hints +
2083 hstate->num_hints[HINT_TYPE_SET]);
2084 hstate->parallel_hints = (ParallelHint **) (hstate->rows_hints +
2085 hstate->num_hints[HINT_TYPE_ROWS]);
2091 * Parse inside of parentheses of scan-method hints.
2094 ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse,
2097 const char *keyword = hint->base.keyword;
2098 HintKeyword hint_keyword = hint->base.hint_keyword;
2099 List *name_list = NIL;
2102 if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
2105 /* Parse relation name and index name(s) if given hint accepts. */
2106 length = list_length(name_list);
2108 /* at least twp parameters required */
2112 ("%s hint requires a relation.", hint->base.keyword));
2113 hint->base.state = HINT_STATE_ERROR;
2117 hint->relname = linitial(name_list);
2118 hint->indexnames = list_delete_first(name_list);
2120 /* check whether the hint accepts index name(s) */
2121 if (length > 1 && !SCAN_HINT_ACCEPTS_INDEX_NAMES(hint_keyword))
2124 ("%s hint accepts only one relation.",
2125 hint->base.keyword));
2126 hint->base.state = HINT_STATE_ERROR;
2130 /* Set a bit for specified hint. */
2131 switch (hint_keyword)
2133 case HINT_KEYWORD_SEQSCAN:
2134 hint->enforce_mask = ENABLE_SEQSCAN;
2136 case HINT_KEYWORD_INDEXSCAN:
2137 hint->enforce_mask = ENABLE_INDEXSCAN;
2139 case HINT_KEYWORD_INDEXSCANREGEXP:
2140 hint->enforce_mask = ENABLE_INDEXSCAN;
2141 hint->regexp = true;
2143 case HINT_KEYWORD_BITMAPSCAN:
2144 hint->enforce_mask = ENABLE_BITMAPSCAN;
2146 case HINT_KEYWORD_BITMAPSCANREGEXP:
2147 hint->enforce_mask = ENABLE_BITMAPSCAN;
2148 hint->regexp = true;
2150 case HINT_KEYWORD_TIDSCAN:
2151 hint->enforce_mask = ENABLE_TIDSCAN;
2153 case HINT_KEYWORD_NOSEQSCAN:
2154 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_SEQSCAN;
2156 case HINT_KEYWORD_NOINDEXSCAN:
2157 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXSCAN;
2159 case HINT_KEYWORD_NOBITMAPSCAN:
2160 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_BITMAPSCAN;
2162 case HINT_KEYWORD_NOTIDSCAN:
2163 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_TIDSCAN;
2165 case HINT_KEYWORD_INDEXONLYSCAN:
2166 hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
2168 case HINT_KEYWORD_INDEXONLYSCANREGEXP:
2169 hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
2170 hint->regexp = true;
2172 case HINT_KEYWORD_NOINDEXONLYSCAN:
2173 hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXONLYSCAN;
2176 hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
2185 JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate, Query *parse,
2188 const char *keyword = hint->base.keyword;
2189 HintKeyword hint_keyword = hint->base.hint_keyword;
2190 List *name_list = NIL;
2192 if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
2195 hint->nrels = list_length(name_list);
2197 if (hint->nrels > 0)
2203 * Transform relation names from list to array to sort them with qsort
2206 hint->relnames = palloc(sizeof(char *) * hint->nrels);
2207 foreach (l, name_list)
2209 hint->relnames[i] = lfirst(l);
2214 list_free(name_list);
2216 /* A join hint requires at least two relations */
2217 if (hint->nrels < 2)
2220 ("%s hint requires at least two relations.",
2221 hint->base.keyword));
2222 hint->base.state = HINT_STATE_ERROR;
2226 /* Sort hints in alphabetical order of relation names. */
2227 qsort(hint->relnames, hint->nrels, sizeof(char *), RelnameCmp);
2229 switch (hint_keyword)
2231 case HINT_KEYWORD_NESTLOOP:
2232 hint->enforce_mask = ENABLE_NESTLOOP;
2234 case HINT_KEYWORD_MERGEJOIN:
2235 hint->enforce_mask = ENABLE_MERGEJOIN;
2237 case HINT_KEYWORD_HASHJOIN:
2238 hint->enforce_mask = ENABLE_HASHJOIN;
2240 case HINT_KEYWORD_NONESTLOOP:
2241 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_NESTLOOP;
2243 case HINT_KEYWORD_NOMERGEJOIN:
2244 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_MERGEJOIN;
2246 case HINT_KEYWORD_NOHASHJOIN:
2247 hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_HASHJOIN;
2250 hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
2259 OuterInnerPairCheck(OuterInnerRels *outer_inner)
2262 if (outer_inner->outer_inner_pair == NIL)
2264 if (outer_inner->relation)
2270 if (list_length(outer_inner->outer_inner_pair) == 2)
2272 foreach(l, outer_inner->outer_inner_pair)
2274 if (!OuterInnerPairCheck(lfirst(l)))
2285 OuterInnerList(OuterInnerRels *outer_inner)
2287 List *outer_inner_list = NIL;
2289 OuterInnerRels *outer_inner_rels;
2291 foreach(l, outer_inner->outer_inner_pair)
2293 outer_inner_rels = (OuterInnerRels *)(lfirst(l));
2295 if (outer_inner_rels->relation != NULL)
2296 outer_inner_list = lappend(outer_inner_list,
2297 outer_inner_rels->relation);
2299 outer_inner_list = list_concat(outer_inner_list,
2300 OuterInnerList(outer_inner_rels));
2302 return outer_inner_list;
2306 LeadingHintParse(LeadingHint *hint, HintState *hstate, Query *parse,
2309 List *name_list = NIL;
2310 OuterInnerRels *outer_inner = NULL;
2312 if ((str = parse_parentheses_Leading(str, &name_list, &outer_inner)) ==
2316 if (outer_inner != NULL)
2317 name_list = OuterInnerList(outer_inner);
2319 hint->relations = name_list;
2320 hint->outer_inner = outer_inner;
2322 /* A Leading hint requires at least two relations */
2323 if ( hint->outer_inner == NULL && list_length(hint->relations) < 2)
2325 hint_ereport(hint->base.hint_str,
2326 ("%s hint requires at least two relations.",
2328 hint->base.state = HINT_STATE_ERROR;
2330 else if (hint->outer_inner != NULL &&
2331 !OuterInnerPairCheck(hint->outer_inner))
2333 hint_ereport(hint->base.hint_str,
2334 ("%s hint requires two sets of relations when parentheses nests.",
2336 hint->base.state = HINT_STATE_ERROR;
2343 SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str)
2345 List *name_list = NIL;
2347 if ((str = parse_parentheses(str, &name_list, hint->base.hint_keyword))
2351 hint->words = name_list;
2353 /* We need both name and value to set GUC parameter. */
2354 if (list_length(name_list) == 2)
2356 hint->name = linitial(name_list);
2357 hint->value = lsecond(name_list);
2361 hint_ereport(hint->base.hint_str,
2362 ("%s hint requires name and value of GUC parameter.",
2364 hint->base.state = HINT_STATE_ERROR;
2371 RowsHintParse(RowsHint *hint, HintState *hstate, Query *parse,
2374 HintKeyword hint_keyword = hint->base.hint_keyword;
2375 List *name_list = NIL;
2381 if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
2384 /* Last element must be rows specification */
2385 hint->nrels = list_length(name_list) - 1;
2387 if (hint->nrels < 1)
2390 ("%s hint needs at least one relation followed by one correction term.",
2391 hint->base.keyword));
2392 hint->base.state = HINT_STATE_ERROR;
2399 * Transform relation names from list to array to sort them with qsort
2402 hint->relnames = palloc(sizeof(char *) * hint->nrels);
2403 foreach (l, name_list)
2405 if (hint->nrels <= i)
2407 hint->relnames[i] = lfirst(l);
2411 /* Retieve rows estimation */
2412 rows_str = list_nth(name_list, hint->nrels);
2413 hint->rows_str = rows_str; /* store as-is for error logging */
2414 if (rows_str[0] == '#')
2416 hint->value_type = RVT_ABSOLUTE;
2419 else if (rows_str[0] == '+')
2421 hint->value_type = RVT_ADD;
2424 else if (rows_str[0] == '-')
2426 hint->value_type = RVT_SUB;
2429 else if (rows_str[0] == '*')
2431 hint->value_type = RVT_MULTI;
2436 hint_ereport(rows_str, ("Unrecognized rows value type notation."));
2437 hint->base.state = HINT_STATE_ERROR;
2440 hint->rows = strtod(rows_str, &end_ptr);
2443 hint_ereport(rows_str,
2444 ("%s hint requires valid number as rows estimation.",
2445 hint->base.keyword));
2446 hint->base.state = HINT_STATE_ERROR;
2450 /* A join hint requires at least two relations */
2451 if (hint->nrels < 2)
2454 ("%s hint requires at least two relations.",
2455 hint->base.keyword));
2456 hint->base.state = HINT_STATE_ERROR;
2460 list_free(name_list);
2462 /* Sort relnames in alphabetical order. */
2463 qsort(hint->relnames, hint->nrels, sizeof(char *), RelnameCmp);
2469 ParallelHintParse(ParallelHint *hint, HintState *hstate, Query *parse,
2472 HintKeyword hint_keyword = hint->base.hint_keyword;
2473 List *name_list = NIL;
2477 bool force_parallel = false;
2479 if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
2482 /* Parse relation name and index name(s) if given hint accepts. */
2483 length = list_length(name_list);
2485 if (length < 2 || length > 3)
2488 ("wrong number of arguments (%d): %s",
2489 length, hint->base.keyword));
2490 hint->base.state = HINT_STATE_ERROR;
2494 hint->relname = linitial(name_list);
2496 /* The second parameter is number of workers */
2497 hint->nworkers_str = list_nth(name_list, 1);
2498 nworkers = strtod(hint->nworkers_str, &end_ptr);
2499 if (*end_ptr || nworkers < 0 || nworkers > max_worker_processes)
2502 hint_ereport(hint->nworkers_str,
2503 ("number of workers must be a number: %s",
2504 hint->base.keyword));
2505 else if (nworkers < 0)
2506 hint_ereport(hint->nworkers_str,
2507 ("number of workers must be positive: %s",
2508 hint->base.keyword));
2509 else if (nworkers > max_worker_processes)
2510 hint_ereport(hint->nworkers_str,
2511 ("number of workers = %d is larger than max_worker_processes(%d): %s",
2512 nworkers, max_worker_processes, hint->base.keyword));
2514 hint->base.state = HINT_STATE_ERROR;
2517 hint->nworkers = nworkers;
2519 /* optional third parameter is specified */
2522 const char *modeparam = (const char *)list_nth(name_list, 2);
2523 if (pg_strcasecmp(modeparam, "hard") == 0)
2524 force_parallel = true;
2525 else if (pg_strcasecmp(modeparam, "soft") != 0)
2527 hint_ereport(modeparam,
2528 ("enforcement must be soft or hard: %s",
2529 hint->base.keyword));
2530 hint->base.state = HINT_STATE_ERROR;
2534 hint->force_parallel = force_parallel;
2536 if (hint->base.state != HINT_STATE_ERROR &&
2537 nworkers > max_hint_nworkers)
2538 max_hint_nworkers = nworkers;
2544 * set GUC parameter functions
2548 get_current_scan_mask()
2553 mask |= ENABLE_SEQSCAN;
2554 if (enable_indexscan)
2555 mask |= ENABLE_INDEXSCAN;
2556 if (enable_bitmapscan)
2557 mask |= ENABLE_BITMAPSCAN;
2559 mask |= ENABLE_TIDSCAN;
2560 if (enable_indexonlyscan)
2561 mask |= ENABLE_INDEXONLYSCAN;
2567 get_current_join_mask()
2571 if (enable_nestloop)
2572 mask |= ENABLE_NESTLOOP;
2573 if (enable_mergejoin)
2574 mask |= ENABLE_MERGEJOIN;
2575 if (enable_hashjoin)
2576 mask |= ENABLE_HASHJOIN;
2582 * Sets GUC prameters without throwing exception. Reutrns false if something
2586 set_config_option_noerror(const char *name, const char *value,
2587 GucContext context, GucSource source,
2588 GucAction action, bool changeVal, int elevel)
2591 MemoryContext ccxt = CurrentMemoryContext;
2595 result = set_config_option(name, value, context, source,
2596 action, changeVal, 0, false);
2602 /* Save error info */
2603 MemoryContextSwitchTo(ccxt);
2604 errdata = CopyErrorData();
2608 (errcode(errdata->sqlerrcode),
2609 errmsg("%s", errdata->message),
2610 errdata->detail ? errdetail("%s", errdata->detail) : 0,
2611 errdata->hint ? errhint("%s", errdata->hint) : 0));
2613 FreeErrorData(errdata);
2621 * Sets GUC parameter of int32 type without throwing exceptions. Returns false
2622 * if something wrong.
2625 set_config_int32_option(const char *name, int32 value, GucContext context)
2627 char buf[16]; /* enough for int32 */
2629 if (snprintf(buf, 16, "%d", value) < 0)
2631 ereport(pg_hint_plan_parse_message_level,
2632 (errmsg ("Failed to convert integer to string: %d", value)));
2637 set_config_option_noerror(name, buf, context,
2638 PGC_S_SESSION, GUC_ACTION_SAVE, true,
2639 pg_hint_plan_parse_message_level);
2643 * Sets GUC parameter of double type without throwing exceptions. Returns false
2644 * if something wrong.
2647 set_config_double_option(const char *name, double value, GucContext context)
2649 char *buf = float8out_internal(value);
2652 result = set_config_option_noerror(name, buf, context,
2653 PGC_S_SESSION, GUC_ACTION_SAVE, true,
2654 pg_hint_plan_parse_message_level);
2659 /* setup scan method enforcement according to given options */
2661 setup_guc_enforcement(SetHint **options, int noptions, GucContext context)
2665 for (i = 0; i < noptions; i++)
2667 SetHint *hint = options[i];
2670 if (!hint_state_enabled(hint))
2673 result = set_config_option_noerror(hint->name, hint->value, context,
2674 PGC_S_SESSION, GUC_ACTION_SAVE, true,
2675 pg_hint_plan_parse_message_level);
2677 hint->base.state = HINT_STATE_USED;
2679 hint->base.state = HINT_STATE_ERROR;
2686 * Setup parallel execution environment.
2688 * If hint is not NULL, set up using it, elsewise reset to initial environment.
2691 setup_parallel_plan_enforcement(ParallelHint *hint, HintState *state)
2695 hint->base.state = HINT_STATE_USED;
2696 set_config_int32_option("max_parallel_workers_per_gather",
2697 hint->nworkers, state->context);
2700 set_config_int32_option("max_parallel_workers_per_gather",
2701 state->init_nworkers, state->context);
2703 /* force means that enforce parallel as far as possible */
2704 if (hint && hint->force_parallel && hint->nworkers > 0)
2706 set_config_double_option("parallel_tuple_cost", 0.0, state->context);
2707 set_config_double_option("parallel_setup_cost", 0.0, state->context);
2708 set_config_int32_option("min_parallel_table_scan_size", 0,
2710 set_config_int32_option("min_parallel_index_scan_size", 0,
2715 set_config_double_option("parallel_tuple_cost",
2716 state->init_paratup_cost, state->context);
2717 set_config_double_option("parallel_setup_cost",
2718 state->init_parasetup_cost, state->context);
2719 set_config_int32_option("min_parallel_table_scan_size",
2720 state->init_min_para_tablescan_size,
2722 set_config_int32_option("min_parallel_index_scan_size",
2723 state->init_min_para_indexscan_size,
2728 #define SET_CONFIG_OPTION(name, type_bits) \
2729 set_config_option_noerror((name), \
2730 (mask & (type_bits)) ? "true" : "false", \
2731 context, PGC_S_SESSION, GUC_ACTION_SAVE, true, ERROR)
2735 * Setup GUC environment to enforce scan methods. If scanhint is NULL, reset
2736 * GUCs to the saved state in state.
2739 setup_scan_method_enforcement(ScanMethodHint *scanhint, HintState *state)
2741 unsigned char enforce_mask = state->init_scan_mask;
2742 GucContext context = state->context;
2747 enforce_mask = scanhint->enforce_mask;
2748 scanhint->base.state = HINT_STATE_USED;
2751 if (enforce_mask == ENABLE_SEQSCAN || enforce_mask == ENABLE_INDEXSCAN ||
2752 enforce_mask == ENABLE_BITMAPSCAN || enforce_mask == ENABLE_TIDSCAN
2753 || enforce_mask == (ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN)
2755 mask = enforce_mask;
2757 mask = enforce_mask & current_hint_state->init_scan_mask;
2759 SET_CONFIG_OPTION("enable_seqscan", ENABLE_SEQSCAN);
2760 SET_CONFIG_OPTION("enable_indexscan", ENABLE_INDEXSCAN);
2761 SET_CONFIG_OPTION("enable_bitmapscan", ENABLE_BITMAPSCAN);
2762 SET_CONFIG_OPTION("enable_tidscan", ENABLE_TIDSCAN);
2763 SET_CONFIG_OPTION("enable_indexonlyscan", ENABLE_INDEXONLYSCAN);
2767 set_join_config_options(unsigned char enforce_mask, GucContext context)
2771 if (enforce_mask == ENABLE_NESTLOOP || enforce_mask == ENABLE_MERGEJOIN ||
2772 enforce_mask == ENABLE_HASHJOIN)
2773 mask = enforce_mask;
2775 mask = enforce_mask & current_hint_state->init_join_mask;
2777 SET_CONFIG_OPTION("enable_nestloop", ENABLE_NESTLOOP);
2778 SET_CONFIG_OPTION("enable_mergejoin", ENABLE_MERGEJOIN);
2779 SET_CONFIG_OPTION("enable_hashjoin", ENABLE_HASHJOIN);
2782 * Hash join may be rejected for the reason of estimated memory usage. Try
2783 * getting rid of that limitation.
2785 if (enforce_mask == ENABLE_HASHJOIN)
2790 /* See final_cost_hashjoin(). */
2791 new_multipler = MAX_KILOBYTES / work_mem;
2793 /* See guc.c for the upper limit */
2794 if (new_multipler >= 1000)
2795 new_multipler = 1000;
2797 if (new_multipler > hash_mem_multiplier)
2799 snprintf(buf, sizeof(buf), UINT64_FORMAT, (uint64)new_multipler);
2800 set_config_option_noerror("hash_mem_multiplier", buf,
2801 context, PGC_S_SESSION, GUC_ACTION_SAVE,
2808 * Push a hint into hint stack which is implemented with List struct. Head of
2809 * list is top of stack.
2812 push_hint(HintState *hstate)
2814 /* Prepend new hint to the list means pushing to stack. */
2815 HintStateStack = lcons(hstate, HintStateStack);
2817 /* Pushed hint is the one which should be used hereafter. */
2818 current_hint_state = hstate;
2821 /* Pop a hint from hint stack. Popped hint is automatically discarded. */
2825 /* Hint stack must not be empty. */
2826 if(HintStateStack == NIL)
2827 elog(ERROR, "hint stack is empty");
2830 * Take a hint at the head from the list, and free it. Switch
2831 * current_hint_state to point new head (NULL if the list is empty).
2833 HintStateStack = list_delete_first(HintStateStack);
2834 HintStateDelete(current_hint_state);
2835 if(HintStateStack == NIL)
2836 current_hint_state = NULL;
2838 current_hint_state = (HintState *) lfirst(list_head(HintStateStack));
2842 * Retrieve and store hint string from given query or from the hint table.
2845 get_current_hint_string(ParseState *pstate, Query *query)
2847 const char *query_str;
2848 MemoryContext oldcontext;
2850 /* do nothing under hint table search */
2851 if (hint_inhibit_level > 0)
2854 /* We alredy have one, don't parse it again. */
2855 if (current_hint_retrieved)
2858 /* Don't parse the current query hereafter */
2859 current_hint_retrieved = true;
2861 if (!pg_hint_plan_enable_hint)
2863 if (current_hint_str)
2865 pfree((void *)current_hint_str);
2866 current_hint_str = NULL;
2871 /* increment the query number */
2873 if (debug_level > 1)
2874 snprintf(qnostr, sizeof(qnostr), "[qno=0x%x]", qno++);
2877 /* search the hint table for a hint if requested */
2878 if (pg_hint_plan_enable_hint_table)
2881 pgssJumbleState jstate;
2883 char *normalized_query = NULL;
2885 query_str = get_query_string(pstate, query, &jumblequery);
2887 /* If this query is not for hint, just return */
2891 /* clear the previous hint string */
2892 if (current_hint_str)
2894 pfree((void *)current_hint_str);
2895 current_hint_str = NULL;
2901 * XXX: normalization code is copied from pg_stat_statements.c.
2902 * Make sure to keep up-to-date with it.
2904 jstate.jumble = (unsigned char *) palloc(JUMBLE_SIZE);
2905 jstate.jumble_len = 0;
2906 jstate.clocations_buf_size = 32;
2907 jstate.clocations = (pgssLocationLen *)
2908 palloc(jstate.clocations_buf_size * sizeof(pgssLocationLen));
2909 jstate.clocations_count = 0;
2911 JumbleQuery(&jstate, jumblequery);
2914 * Normalize the query string by replacing constants with '?'
2917 * Search hint string which is stored keyed by query string
2918 * and application name. The query string is normalized to allow
2921 * Adding 1 byte to query_len ensures that the returned string has
2922 * a terminating NULL.
2924 query_len = strlen(query_str) + 1;
2926 generate_normalized_query(&jstate, query_str, 0, &query_len,
2927 GetDatabaseEncoding());
2930 * find a hint for the normalized query. the result should be in
2933 oldcontext = MemoryContextSwitchTo(TopMemoryContext);
2935 get_hints_from_table(normalized_query, application_name);
2936 MemoryContextSwitchTo(oldcontext);
2938 if (debug_level > 1)
2940 if (current_hint_str)
2941 ereport(pg_hint_plan_debug_message_level,
2942 (errmsg("pg_hint_plan[qno=0x%x]: "
2943 "post_parse_analyze_hook: "
2944 "hints from table: \"%s\": "
2945 "normalized_query=\"%s\", "
2946 "application name =\"%s\"",
2947 qno, current_hint_str,
2948 normalized_query, application_name),
2949 errhidestmt(msgqno != qno),
2950 errhidecontext(msgqno != qno)));
2952 ereport(pg_hint_plan_debug_message_level,
2953 (errmsg("pg_hint_plan[qno=0x%x]: "
2954 "no match found in table: "
2955 "application name = \"%s\", "
2956 "normalized_query=\"%s\"",
2957 qno, application_name,
2959 errhidestmt(msgqno != qno),
2960 errhidecontext(msgqno != qno)));
2966 /* retrun if we have hint here */
2967 if (current_hint_str)
2971 query_str = get_query_string(pstate, query, NULL);
2976 * get hints from the comment. However we may have the same query
2977 * string with the previous call, but the extra comparison seems no
2980 if (current_hint_str)
2981 pfree((void *)current_hint_str);
2983 oldcontext = MemoryContextSwitchTo(TopMemoryContext);
2984 current_hint_str = get_hints_from_comment(query_str);
2985 MemoryContextSwitchTo(oldcontext);
2990 * Failed to get query. We would be in fetching invalidated
2991 * plancache. Try the next chance.
2993 current_hint_retrieved = false;
2996 if (debug_level > 1)
2998 if (debug_level == 1 && query_str && debug_query_string &&
2999 strcmp(query_str, debug_query_string))
3000 ereport(pg_hint_plan_debug_message_level,
3001 (errmsg("hints in comment=\"%s\"",
3002 current_hint_str ? current_hint_str : "(none)"),
3003 errhidestmt(msgqno != qno),
3004 errhidecontext(msgqno != qno)));
3006 ereport(pg_hint_plan_debug_message_level,
3007 (errmsg("hints in comment=\"%s\", query=\"%s\", debug_query_string=\"%s\"",
3008 current_hint_str ? current_hint_str : "(none)",
3009 query_str ? query_str : "(none)",
3010 debug_query_string ? debug_query_string : "(none)"),
3011 errhidestmt(msgqno != qno),
3012 errhidecontext(msgqno != qno)));
3018 * Retrieve hint string from the current query.
3021 pg_hint_plan_post_parse_analyze(ParseState *pstate, Query *query)
3023 if (prev_post_parse_analyze_hook)
3024 prev_post_parse_analyze_hook(pstate, query);
3026 /* always retrieve hint from the top-level query string */
3027 if (plpgsql_recurse_level == 0)
3028 current_hint_retrieved = false;
3030 get_current_hint_string(pstate, query);
3034 * We need to reset current_hint_retrieved flag always when a command execution
3035 * is finished. This is true even for a pure utility command that doesn't
3036 * involve planning phase.
3039 pg_hint_plan_ProcessUtility(PlannedStmt *pstmt, const char *queryString,
3040 ProcessUtilityContext context,
3041 ParamListInfo params, QueryEnvironment *queryEnv,
3042 DestReceiver *dest, QueryCompletion *qc)
3044 if (prev_ProcessUtility_hook)
3045 prev_ProcessUtility_hook(pstmt, queryString, context, params, queryEnv,
3048 standard_ProcessUtility(pstmt, queryString, context, params, queryEnv,
3051 if (plpgsql_recurse_level == 0)
3052 current_hint_retrieved = false;
3056 * Read and set up hint information
3058 static PlannedStmt *
3059 pg_hint_plan_planner(Query *parse, const char *query_string, int cursorOptions, ParamListInfo boundParams)
3062 PlannedStmt *result;
3064 const char *prev_hint_str = NULL;
3067 * Use standard planner if pg_hint_plan is disabled or current nesting
3068 * depth is nesting depth of SPI calls. Other hook functions try to change
3069 * plan with current_hint_state if any, so set it to NULL.
3071 if (!pg_hint_plan_enable_hint || hint_inhibit_level > 0)
3073 if (debug_level > 1)
3074 ereport(pg_hint_plan_debug_message_level,
3075 (errmsg ("pg_hint_plan%s: planner: enable_hint=%d,"
3076 " hint_inhibit_level=%d",
3077 qnostr, pg_hint_plan_enable_hint,
3078 hint_inhibit_level),
3079 errhidestmt(msgqno != qno)));
3082 goto standard_planner_proc;
3086 * Support for nested plpgsql functions. This is quite ugly but this is the
3087 * only point I could find where I can get the query string.
3089 if (plpgsql_recurse_level > 0 &&
3090 error_context_stack && error_context_stack->arg)
3092 MemoryContext oldcontext;
3094 oldcontext = MemoryContextSwitchTo(TopMemoryContext);
3096 get_hints_from_comment((char *)error_context_stack->arg);
3097 MemoryContextSwitchTo(oldcontext);
3101 * Query execution in extended protocol can be started without the analyze
3102 * phase. In the case retrieve hint string here.
3104 if (!current_hint_str)
3105 get_current_hint_string(NULL, parse);
3107 /* No hint, go the normal way */
3108 if (!current_hint_str)
3109 goto standard_planner_proc;
3111 /* parse the hint into hint state struct */
3112 hstate = create_hintstate(parse, pstrdup(current_hint_str));
3114 /* run standard planner if the statement has not valid hint */
3116 goto standard_planner_proc;
3119 * Push new hint struct to the hint stack to disable previous hint context.
3123 /* Set scan enforcement here. */
3124 save_nestlevel = NewGUCNestLevel();
3126 /* Apply Set hints, then save it as the initial state */
3127 setup_guc_enforcement(current_hint_state->set_hints,
3128 current_hint_state->num_hints[HINT_TYPE_SET],
3129 current_hint_state->context);
3131 current_hint_state->init_scan_mask = get_current_scan_mask();
3132 current_hint_state->init_join_mask = get_current_join_mask();
3133 current_hint_state->init_min_para_tablescan_size =
3134 min_parallel_table_scan_size;
3135 current_hint_state->init_min_para_indexscan_size =
3136 min_parallel_index_scan_size;
3137 current_hint_state->init_paratup_cost = parallel_tuple_cost;
3138 current_hint_state->init_parasetup_cost = parallel_setup_cost;
3141 * max_parallel_workers_per_gather should be non-zero here if Workers hint
3144 if (max_hint_nworkers > 0 && max_parallel_workers_per_gather < 1)
3145 set_config_int32_option("max_parallel_workers_per_gather",
3146 1, current_hint_state->context);
3147 current_hint_state->init_nworkers = max_parallel_workers_per_gather;
3149 if (debug_level > 1)
3151 ereport(pg_hint_plan_debug_message_level,
3152 (errhidestmt(msgqno != qno),
3153 errmsg("pg_hint_plan%s: planner", qnostr)));
3158 * The planner call below may replace current_hint_str. Store and restore
3159 * it so that the subsequent planning in the upper level doesn't get
3163 prev_hint_str = current_hint_str;
3164 current_hint_str = NULL;
3167 * Use PG_TRY mechanism to recover GUC parameters and current_hint_state to
3168 * the state when this planner started when error occurred in planner.
3173 result = (*prev_planner) (parse, query_string,
3174 cursorOptions, boundParams);
3176 result = standard_planner(parse, query_string,
3177 cursorOptions, boundParams);
3179 current_hint_str = prev_hint_str;
3185 * Rollback changes of GUC parameters, and pop current hint context
3186 * from hint stack to rewind the state.
3188 current_hint_str = prev_hint_str;
3190 AtEOXact_GUC(true, save_nestlevel);
3198 * current_hint_str is useless after planning of the top-level query.
3200 if (recurse_level < 1 && current_hint_str)
3202 pfree((void *)current_hint_str);
3203 current_hint_str = NULL;
3204 current_hint_retrieved = false;
3207 /* Print hint in debug mode. */
3208 if (debug_level == 1)
3209 HintStateDump(current_hint_state);
3210 else if (debug_level > 1)
3211 HintStateDump2(current_hint_state);
3214 * Rollback changes of GUC parameters, and pop current hint context from
3215 * hint stack to rewind the state.
3217 AtEOXact_GUC(true, save_nestlevel);
3222 standard_planner_proc:
3223 if (debug_level > 1)
3225 ereport(pg_hint_plan_debug_message_level,
3226 (errhidestmt(msgqno != qno),
3227 errmsg("pg_hint_plan%s: planner: no valid hint",
3231 current_hint_state = NULL;
3233 result = (*prev_planner) (parse, query_string,
3234 cursorOptions, boundParams);
3236 result = standard_planner(parse, query_string,
3237 cursorOptions, boundParams);
3239 /* The upper-level planner still needs the current hint state */
3240 if (HintStateStack != NIL)
3241 current_hint_state = (HintState *) lfirst(list_head(HintStateStack));
3247 * Find scan method hint to be applied to the given relation
3250 static ScanMethodHint *
3251 find_scan_hint(PlannerInfo *root, Index relid)
3255 ScanMethodHint *real_name_hint = NULL;
3256 ScanMethodHint *alias_hint = NULL;
3259 /* This should not be a join rel */
3261 rel = root->simple_rel_array[relid];
3264 * This function is called for any RelOptInfo or its inheritance parent if
3265 * any. If we are called from inheritance planner, the RelOptInfo for the
3266 * parent of target child relation is not set in the planner info.
3268 * Otherwise we should check that the reloptinfo is base relation or
3269 * inheritance children.
3272 rel->reloptkind != RELOPT_BASEREL &&
3273 rel->reloptkind != RELOPT_OTHER_MEMBER_REL)
3277 * This is baserel or appendrel children. We can refer to RangeTblEntry.
3279 rte = root->simple_rte_array[relid];
3282 /* We don't hint on other than relation and foreign tables */
3283 if (rte->rtekind != RTE_RELATION ||
3284 rte->relkind == RELKIND_FOREIGN_TABLE)
3287 /* Find scan method hint, which matches given names, from the list. */
3288 for (i = 0; i < current_hint_state->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
3290 ScanMethodHint *hint = current_hint_state->scan_hints[i];
3292 /* We ignore disabled hints. */
3293 if (!hint_state_enabled(hint))
3297 RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0)
3300 /* check the real name for appendrel children */
3301 if (!real_name_hint &&
3302 rel && rel->reloptkind == RELOPT_OTHER_MEMBER_REL)
3304 char *realname = get_rel_name(rte->relid);
3306 if (realname && RelnameCmp(&realname, &hint->relname) == 0)
3307 real_name_hint = hint;
3310 /* No more match expected, break */
3311 if(alias_hint && real_name_hint)
3315 /* real name match precedes alias match */
3317 return real_name_hint;
3322 static ParallelHint *
3323 find_parallel_hint(PlannerInfo *root, Index relid)
3327 ParallelHint *real_name_hint = NULL;
3328 ParallelHint *alias_hint = NULL;
3331 /* This should not be a join rel */
3333 rel = root->simple_rel_array[relid];
3336 * Parallel planning is appliable only on base relation, which has
3343 * We have set root->glob->parallelModeOK if needed. What we should do here
3344 * is just following the decision of planner.
3346 if (!rel->consider_parallel)
3350 * This is baserel or appendrel children. We can refer to RangeTblEntry.
3352 rte = root->simple_rte_array[relid];
3355 /* Find parallel method hint, which matches given names, from the list. */
3356 for (i = 0; i < current_hint_state->num_hints[HINT_TYPE_PARALLEL]; i++)
3358 ParallelHint *hint = current_hint_state->parallel_hints[i];
3360 /* We ignore disabled hints. */
3361 if (!hint_state_enabled(hint))
3365 RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0)
3368 /* check the real name for appendrel children */
3369 if (!real_name_hint &&
3370 rel && rel->reloptkind == RELOPT_OTHER_MEMBER_REL)
3372 char *realname = get_rel_name(rte->relid);
3374 if (realname && RelnameCmp(&realname, &hint->relname) == 0)
3375 real_name_hint = hint;
3378 /* No more match expected, break */
3379 if(alias_hint && real_name_hint)
3383 /* real name match precedes alias match */
3385 return real_name_hint;
3393 * Returns TRUE on match, FALSE on no match.
3395 * s1 --- the data to match against
3396 * s2 --- the pattern
3398 * Because we copy s1 to NameData, make the size of s1 less than NAMEDATALEN.
3401 regexpeq(const char *s1, const char *s2)
3407 strcpy(name.data, s1);
3408 regexp = cstring_to_text(s2);
3410 result = DirectFunctionCall2Coll(nameregexeq,
3411 DEFAULT_COLLATION_OID,
3412 NameGetDatum(&name),
3413 PointerGetDatum(regexp));
3414 return DatumGetBool(result);
3418 /* Remove indexes instructed not to use by hint. */
3420 restrict_indexes(PlannerInfo *root, ScanMethodHint *hint, RelOptInfo *rel,
3421 bool using_parent_hint)
3426 RangeTblEntry *rte = root->simple_rte_array[rel->relid];
3427 Oid relationObjectId = rte->relid;
3430 * We delete all the IndexOptInfo list and prevent you from being usable by
3433 if (hint->enforce_mask == ENABLE_SEQSCAN ||
3434 hint->enforce_mask == ENABLE_TIDSCAN)
3436 list_free_deep(rel->indexlist);
3437 rel->indexlist = NIL;
3438 hint->base.state = HINT_STATE_USED;
3444 * When a list of indexes is not specified, we just use all indexes.
3446 if (hint->indexnames == NIL)
3450 * Leaving only an specified index, we delete it from a IndexOptInfo list
3453 if (debug_level > 0)
3454 initStringInfo(&buf);
3456 for (cell = list_head(rel->indexlist); cell; cell = next)
3458 IndexOptInfo *info = (IndexOptInfo *) lfirst(cell);
3459 char *indexname = get_rel_name(info->indexoid);
3461 bool use_index = false;
3463 next = lnext(rel->indexlist, cell);
3464 foreach(l, hint->indexnames)
3466 char *hintname = (char *) lfirst(l);
3470 result = regexpeq(indexname, hintname);
3472 result = RelnameCmp(&indexname, &hintname) == 0;
3477 if (debug_level > 0)
3479 appendStringInfoCharMacro(&buf, ' ');
3480 quote_value(&buf, indexname);
3488 * Apply index restriction of parent hint to children. Since index
3489 * inheritance is not explicitly described we should search for an
3490 * children's index with the same definition to that of the parent.
3492 if (using_parent_hint && !use_index)
3494 foreach(l, current_hint_state->parent_index_infos)
3498 ParentIndexInfo *p_info = (ParentIndexInfo *)lfirst(l);
3501 * we check the 'same' index by comparing uniqueness, access
3502 * method and index key columns.
3504 if (p_info->indisunique != info->unique ||
3505 p_info->method != info->relam ||
3506 list_length(p_info->column_names) != info->ncolumns)
3509 /* Check if index key columns match */
3510 for (i = 0; i < info->ncolumns; i++)
3512 char *c_attname = NULL;
3513 char *p_attname = NULL;
3515 p_attname = list_nth(p_info->column_names, i);
3518 * if both of the key of the same position are expressions,
3519 * ignore them for now and check later.
3521 if (info->indexkeys[i] == 0 && !p_attname)
3524 /* deny if one is expression while another is not */
3525 if (info->indexkeys[i] == 0 || !p_attname)
3528 c_attname = get_attname(relationObjectId,
3529 info->indexkeys[i], false);
3531 /* deny if any of column attributes don't match */
3532 if (strcmp(p_attname, c_attname) != 0 ||
3533 p_info->indcollation[i] != info->indexcollations[i] ||
3534 p_info->opclass[i] != info->opcintype[i]||
3535 ((p_info->indoption[i] & INDOPTION_DESC) != 0)
3536 != info->reverse_sort[i] ||
3537 ((p_info->indoption[i] & INDOPTION_NULLS_FIRST) != 0)
3538 != info->nulls_first[i])
3542 /* deny this if any difference found */
3543 if (i != info->ncolumns)
3546 /* check on key expressions */
3547 if ((p_info->expression_str && (info->indexprs != NIL)) ||
3548 (p_info->indpred_str && (info->indpred != NIL)))
3550 /* fetch the index of this child */
3551 ht_idx = SearchSysCache1(INDEXRELID,
3552 ObjectIdGetDatum(info->indexoid));
3554 /* check expressions if both expressions are available */
3555 if (p_info->expression_str &&
3556 !heap_attisnull(ht_idx, Anum_pg_index_indexprs, NULL))
3563 * to change the expression's parameter of child's
3566 exprsDatum = SysCacheGetAttr(INDEXRELID, ht_idx,
3567 Anum_pg_index_indexprs,
3570 result = DirectFunctionCall2(pg_get_expr,
3575 /* deny if expressions don't match */
3576 if (strcmp(p_info->expression_str,
3577 text_to_cstring(DatumGetTextP(result))) != 0)
3580 ReleaseSysCache(ht_idx);
3585 /* compare index predicates */
3586 if (p_info->indpred_str &&
3587 !heap_attisnull(ht_idx, Anum_pg_index_indpred, NULL))
3593 predDatum = SysCacheGetAttr(INDEXRELID, ht_idx,
3594 Anum_pg_index_indpred,
3597 result = DirectFunctionCall2(pg_get_expr,
3602 if (strcmp(p_info->indpred_str,
3603 text_to_cstring(DatumGetTextP(result))) != 0)
3606 ReleaseSysCache(ht_idx);
3612 ReleaseSysCache(ht_idx);
3614 else if (p_info->expression_str || (info->indexprs != NIL))
3616 else if (p_info->indpred_str || (info->indpred != NIL))
3621 /* to log the candidate of index */
3622 if (debug_level > 0)
3624 appendStringInfoCharMacro(&buf, ' ');
3625 quote_value(&buf, indexname);
3634 rel->indexlist = list_delete_cell(rel->indexlist, cell);
3637 * The cells after the deleted cell have been moved towards the
3638 * list head by 1 element. the next iteration should visit the
3639 * cell at the same address if any.
3648 if (debug_level == 1)
3650 StringInfoData rel_buf;
3651 char *disprelname = "";
3654 * If this hint targetted the parent, use the real name of this
3655 * child. Otherwise use hint specification.
3657 if (using_parent_hint)
3658 disprelname = get_rel_name(rte->relid);
3660 disprelname = hint->relname;
3663 initStringInfo(&rel_buf);
3664 quote_value(&rel_buf, disprelname);
3666 ereport(pg_hint_plan_debug_message_level,
3667 (errmsg("available indexes for %s(%s):%s",
3672 pfree(rel_buf.data);
3677 * Return information of index definition.
3679 static ParentIndexInfo *
3680 get_parent_index_info(Oid indexoid, Oid relid)
3682 ParentIndexInfo *p_info = palloc(sizeof(ParentIndexInfo));
3683 Relation indexRelation;
3684 Form_pg_index index;
3688 indexRelation = index_open(indexoid, RowExclusiveLock);
3690 index = indexRelation->rd_index;
3692 p_info->indisunique = index->indisunique;
3693 p_info->method = indexRelation->rd_rel->relam;
3695 p_info->column_names = NIL;
3696 p_info->indcollation = (Oid *) palloc(sizeof(Oid) * index->indnatts);
3697 p_info->opclass = (Oid *) palloc(sizeof(Oid) * index->indnatts);
3698 p_info->indoption = (int16 *) palloc(sizeof(Oid) * index->indnatts);
3701 * Collect relation attribute names of index columns for index
3702 * identification, not index attribute names. NULL means expression index
3705 for (i = 0; i < index->indnatts; i++)
3707 attname = get_attname(relid, index->indkey.values[i], true);
3708 p_info->column_names = lappend(p_info->column_names, attname);
3710 p_info->indcollation[i] = indexRelation->rd_indcollation[i];
3711 p_info->opclass[i] = indexRelation->rd_opcintype[i];
3712 p_info->indoption[i] = indexRelation->rd_indoption[i];
3716 * to check to match the expression's parameter of index with child indexes
3718 p_info->expression_str = NULL;
3719 if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indexprs,
3726 exprsDatum = SysCacheGetAttr(INDEXRELID, indexRelation->rd_indextuple,
3727 Anum_pg_index_indexprs, &isnull);
3729 result = DirectFunctionCall2(pg_get_expr,
3731 ObjectIdGetDatum(relid));
3733 p_info->expression_str = text_to_cstring(DatumGetTextP(result));
3737 * to check to match the predicate's parameter of index with child indexes
3739 p_info->indpred_str = NULL;
3740 if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indpred,
3747 predDatum = SysCacheGetAttr(INDEXRELID, indexRelation->rd_indextuple,
3748 Anum_pg_index_indpred, &isnull);
3750 result = DirectFunctionCall2(pg_get_expr,
3752 ObjectIdGetDatum(relid));
3754 p_info->indpred_str = text_to_cstring(DatumGetTextP(result));
3757 index_close(indexRelation, NoLock);
3763 * cancel hint enforcement
3766 reset_hint_enforcement()
3768 setup_scan_method_enforcement(NULL, current_hint_state);
3769 setup_parallel_plan_enforcement(NULL, current_hint_state);
3773 * Set planner guc parameters according to corresponding scan hints. Returns
3774 * bitmap of HintTypeBitmap. If shint or phint is not NULL, set used hint
3775 * there respectively.
3778 setup_hint_enforcement(PlannerInfo *root, RelOptInfo *rel,
3779 ScanMethodHint **rshint, ParallelHint **rphint)
3781 Index new_parent_relid = 0;
3783 ScanMethodHint *shint = NULL;
3784 ParallelHint *phint = NULL;
3785 bool inhparent = root->simple_rte_array[rel->relid]->inh;
3786 Oid relationObjectId = root->simple_rte_array[rel->relid]->relid;
3789 /* reset returns if requested */
3790 if (rshint != NULL) *rshint = NULL;
3791 if (rphint != NULL) *rphint = NULL;
3794 * We could register the parent relation of the following children here
3795 * when inhparent == true but inheritnce planner doesn't call this function
3796 * for parents. Since we cannot distinguish who called this function we
3797 * cannot do other than always seeking the parent regardless of who called
3802 /* set up only parallel hints for parent relation */
3803 phint = find_parallel_hint(root, rel->relid);
3806 setup_parallel_plan_enforcement(phint, current_hint_state);
3807 if (rphint) *rphint = phint;
3808 ret |= HINT_BM_PARALLEL;
3812 if (debug_level > 1)
3813 ereport(pg_hint_plan_debug_message_level,
3815 errmsg ("pg_hint_plan%s: setup_hint_enforcement"
3816 " skipping inh parent: relation=%u(%s), inhparent=%d,"
3817 " current_hint_state=%p, hint_inhibit_level=%d",
3818 qnostr, relationObjectId,
3819 get_rel_name(relationObjectId),
3820 inhparent, current_hint_state, hint_inhibit_level)));
3825 * Forget about the parent of another subquery, but don't forget if the
3826 * inhTargetkind of the root is not INHKIND_NONE, which signals the root
3827 * contains only appendrel members. See inheritance_planner for details.
3829 * (PG12.0) 428b260f87 added one more planning cycle for updates on
3830 * partitioned tables and hints set up in the cycle are overriden by the
3831 * second cycle. Since I didn't find no apparent distinction between the
3832 * PlannerRoot of the cycle and that of ordinary CMD_SELECT, pg_hint_plan
3833 * accepts both cycles and the later one wins. In the second cycle root
3834 * doesn't have inheritance information at all so use the parent_relid set
3835 * in the first cycle.
3837 if (root->inhTargetKind == INHKIND_NONE)
3839 if (root != current_hint_state->current_root)
3840 current_hint_state->parent_relid = 0;
3842 /* Find the parent for this relation other than the registered parent */
3843 foreach (l, root->append_rel_list)
3845 AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l);
3847 if (appinfo->child_relid == rel->relid)
3849 if (current_hint_state->parent_relid != appinfo->parent_relid)
3851 new_parent_relid = appinfo->parent_relid;
3852 current_hint_state->current_root = root;
3861 * This relation doesn't have a parent. Cancel
3862 * current_hint_state.
3864 current_hint_state->parent_relid = 0;
3865 current_hint_state->parent_scan_hint = NULL;
3866 current_hint_state->parent_parallel_hint = NULL;
3870 if (new_parent_relid > 0)
3873 * Here we found a new parent for the current relation. Scan continues
3874 * hint to other childrens of this parent so remember it to avoid
3875 * redundant setup cost.
3877 current_hint_state->parent_relid = new_parent_relid;
3879 /* Find hints for the parent */
3880 current_hint_state->parent_scan_hint =
3881 find_scan_hint(root, current_hint_state->parent_relid);
3883 current_hint_state->parent_parallel_hint =
3884 find_parallel_hint(root, current_hint_state->parent_relid);
3887 * If hint is found for the parent, apply it for this child instead
3890 if (current_hint_state->parent_scan_hint)
3892 ScanMethodHint * pshint = current_hint_state->parent_scan_hint;
3894 pshint->base.state = HINT_STATE_USED;
3896 /* Apply index mask in the same manner to the parent. */
3897 if (pshint->indexnames)
3900 Relation parent_rel;
3903 root->simple_rte_array[current_hint_state->parent_relid]->relid;
3904 parent_rel = table_open(parentrel_oid, NoLock);
3906 /* Search the parent relation for indexes match the hint spec */
3907 foreach(l, RelationGetIndexList(parent_rel))
3909 Oid indexoid = lfirst_oid(l);
3910 char *indexname = get_rel_name(indexoid);
3912 ParentIndexInfo *parent_index_info;
3914 foreach(lc, pshint->indexnames)
3916 if (RelnameCmp(&indexname, &lfirst(lc)) == 0)
3923 get_parent_index_info(indexoid, parentrel_oid);
3924 current_hint_state->parent_index_infos =
3925 lappend(current_hint_state->parent_index_infos,
3928 table_close(parent_rel, NoLock);
3933 shint = find_scan_hint(root, rel->relid);
3935 shint = current_hint_state->parent_scan_hint;
3939 bool using_parent_hint =
3940 (shint == current_hint_state->parent_scan_hint);
3942 ret |= HINT_BM_SCAN_METHOD;
3944 /* Setup scan enforcement environment */
3945 setup_scan_method_enforcement(shint, current_hint_state);
3947 /* restrict unwanted inexes */
3948 restrict_indexes(root, shint, rel, using_parent_hint);
3950 if (debug_level > 1)
3952 char *additional_message = "";
3954 if (shint == current_hint_state->parent_scan_hint)
3955 additional_message = " by parent hint";
3957 ereport(pg_hint_plan_debug_message_level,
3959 errmsg ("pg_hint_plan%s: setup_hint_enforcement"
3960 " index deletion%s:"
3961 " relation=%u(%s), inhparent=%d, "
3962 "current_hint_state=%p,"
3963 " hint_inhibit_level=%d, scanmask=0x%x",
3964 qnostr, additional_message,
3966 get_rel_name(relationObjectId),
3967 inhparent, current_hint_state,
3969 shint->enforce_mask)));
3973 /* Do the same for parallel plan enforcement */
3974 phint = find_parallel_hint(root, rel->relid);
3976 phint = current_hint_state->parent_parallel_hint;
3978 setup_parallel_plan_enforcement(phint, current_hint_state);
3981 ret |= HINT_BM_PARALLEL;
3983 /* Nothing to apply. Reset the scan mask to intial state */
3984 if (!shint && ! phint)
3986 if (debug_level > 1)
3987 ereport(pg_hint_plan_debug_message_level,
3988 (errhidestmt (true),
3989 errmsg ("pg_hint_plan%s: setup_hint_enforcement"
3991 " relation=%u(%s), inhparent=%d, current_hint=%p,"
3992 " hint_inhibit_level=%d, scanmask=0x%x",
3993 qnostr, relationObjectId,
3994 get_rel_name(relationObjectId),
3995 inhparent, current_hint_state, hint_inhibit_level,
3996 current_hint_state->init_scan_mask)));
3998 setup_scan_method_enforcement(NULL, current_hint_state);
4003 if (rshint != NULL) *rshint = shint;
4004 if (rphint != NULL) *rphint = phint;
4010 * Return index of relation which matches given aliasname, or 0 if not found.
4011 * If same aliasname was used multiple times in a query, return -1.
4014 find_relid_aliasname(PlannerInfo *root, char *aliasname, List *initial_rels,
4020 for (i = 1; i < root->simple_rel_array_size; i++)
4024 if (root->simple_rel_array[i] == NULL)
4027 Assert(i == root->simple_rel_array[i]->relid);
4029 if (RelnameCmp(&aliasname,
4030 &root->simple_rte_array[i]->eref->aliasname) != 0)
4033 foreach(l, initial_rels)
4035 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
4037 if (rel->reloptkind == RELOPT_BASEREL)
4039 if (rel->relid != i)
4044 Assert(rel->reloptkind == RELOPT_JOINREL);
4046 if (!bms_is_member(i, rel->relids))
4053 ("Relation name \"%s\" is ambiguous.",
4068 * Return join hint which matches given joinrelids.
4070 static JoinMethodHint *
4071 find_join_hint(Relids joinrelids)
4076 join_hint = current_hint_state->join_hint_level[bms_num_members(joinrelids)];
4078 foreach(l, join_hint)
4080 JoinMethodHint *hint = (JoinMethodHint *) lfirst(l);
4082 if (bms_equal(joinrelids, hint->joinrelids))
4090 OuterInnerJoinCreate(OuterInnerRels *outer_inner, LeadingHint *leading_hint,
4091 PlannerInfo *root, List *initial_rels, HintState *hstate, int nbaserel)
4093 OuterInnerRels *outer_rels;
4094 OuterInnerRels *inner_rels;
4095 Relids outer_relids;
4096 Relids inner_relids;
4098 JoinMethodHint *hint;
4100 if (outer_inner->relation != NULL)
4102 return bms_make_singleton(
4103 find_relid_aliasname(root, outer_inner->relation,
4105 leading_hint->base.hint_str));
4108 outer_rels = linitial(outer_inner->outer_inner_pair);
4109 inner_rels = llast(outer_inner->outer_inner_pair);
4111 outer_relids = OuterInnerJoinCreate(outer_rels,
4117 inner_relids = OuterInnerJoinCreate(inner_rels,
4124 join_relids = bms_add_members(outer_relids, inner_relids);
4126 if (bms_num_members(join_relids) > nbaserel)
4130 * If we don't have join method hint, create new one for the
4131 * join combination with all join methods are enabled.
4133 hint = find_join_hint(join_relids);
4137 * Here relnames is not set, since Relids bitmap is sufficient to
4138 * control paths of this query afterward.
4140 hint = (JoinMethodHint *) JoinMethodHintCreate(
4141 leading_hint->base.hint_str,
4143 HINT_KEYWORD_LEADING);
4144 hint->base.state = HINT_STATE_USED;
4145 hint->nrels = bms_num_members(join_relids);
4146 hint->enforce_mask = ENABLE_ALL_JOIN;
4147 hint->joinrelids = bms_copy(join_relids);
4148 hint->inner_nrels = bms_num_members(inner_relids);
4149 hint->inner_joinrelids = bms_copy(inner_relids);
4151 hstate->join_hint_level[hint->nrels] =
4152 lappend(hstate->join_hint_level[hint->nrels], hint);
4156 hint->inner_nrels = bms_num_members(inner_relids);
4157 hint->inner_joinrelids = bms_copy(inner_relids);
4164 create_bms_of_relids(Hint *base, PlannerInfo *root, List *initial_rels,
4165 int nrels, char **relnames)
4168 Relids relids = NULL;
4172 for (j = 0; j < nrels; j++)
4174 relname = relnames[j];
4176 relid = find_relid_aliasname(root, relname, initial_rels,
4180 base->state = HINT_STATE_ERROR;
4183 * the aliasname is not found(relid == 0) or same aliasname was used
4184 * multiple times in a query(relid == -1)
4191 if (bms_is_member(relid, relids))
4193 hint_ereport(base->hint_str,
4194 ("Relation name \"%s\" is duplicated.", relname));
4195 base->state = HINT_STATE_ERROR;
4199 relids = bms_add_member(relids, relid);
4204 * Transform join method hint into handy form.
4206 * - create bitmap of relids from alias names, to make it easier to check
4207 * whether a join path matches a join method hint.
4208 * - add join method hints which are necessary to enforce join order
4209 * specified by Leading hint
4212 transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel,
4213 List *initial_rels, JoinMethodHint **join_method_hints)
4221 LeadingHint *lhint = NULL;
4224 * Create bitmap of relids from alias names for each join method hint.
4225 * Bitmaps are more handy than strings in join searching.
4227 for (i = 0; i < hstate->num_hints[HINT_TYPE_JOIN_METHOD]; i++)
4229 JoinMethodHint *hint = hstate->join_hints[i];
4231 if (!hint_state_enabled(hint) || hint->nrels > nbaserel)
4234 hint->joinrelids = create_bms_of_relids(&(hint->base), root,
4235 initial_rels, hint->nrels, hint->relnames);
4237 if (hint->joinrelids == NULL || hint->base.state == HINT_STATE_ERROR)
4240 hstate->join_hint_level[hint->nrels] =
4241 lappend(hstate->join_hint_level[hint->nrels], hint);
4245 * Create bitmap of relids from alias names for each rows hint.
4246 * Bitmaps are more handy than strings in join searching.
4248 for (i = 0; i < hstate->num_hints[HINT_TYPE_ROWS]; i++)
4250 RowsHint *hint = hstate->rows_hints[i];
4252 if (!hint_state_enabled(hint) || hint->nrels > nbaserel)
4255 hint->joinrelids = create_bms_of_relids(&(hint->base), root,
4256 initial_rels, hint->nrels, hint->relnames);
4259 /* Do nothing if no Leading hint was supplied. */
4260 if (hstate->num_hints[HINT_TYPE_LEADING] == 0)
4264 * Decide whether to use Leading hint
4266 for (i = 0; i < hstate->num_hints[HINT_TYPE_LEADING]; i++)
4268 LeadingHint *leading_hint = (LeadingHint *)hstate->leading_hint[i];
4271 if (leading_hint->base.state == HINT_STATE_ERROR)
4277 foreach(l, leading_hint->relations)
4279 relname = (char *)lfirst(l);;
4281 relid = find_relid_aliasname(root, relname, initial_rels,
4282 leading_hint->base.hint_str);
4284 leading_hint->base.state = HINT_STATE_ERROR;
4289 if (bms_is_member(relid, relids))
4291 hint_ereport(leading_hint->base.hint_str,
4292 ("Relation name \"%s\" is duplicated.", relname));
4293 leading_hint->base.state = HINT_STATE_ERROR;
4297 relids = bms_add_member(relids, relid);
4300 if (relid <= 0 || leading_hint->base.state == HINT_STATE_ERROR)
4305 hint_ereport(lhint->base.hint_str,
4306 ("Conflict %s hint.", HintTypeName[lhint->base.type]));
4307 lhint->base.state = HINT_STATE_DUPLICATION;
4309 leading_hint->base.state = HINT_STATE_USED;
4310 lhint = leading_hint;
4313 /* check to exist Leading hint marked with 'used'. */
4318 * We need join method hints which fit specified join order in every join
4319 * level. For example, Leading(A B C) virtually requires following join
4320 * method hints, if no join method hint supplied:
4322 * - level 2: NestLoop(A B), MergeJoin(A B), HashJoin(A B)
4323 * - level 3: NestLoop(A B C), MergeJoin(A B C), HashJoin(A B C)
4325 * If we already have join method hint which fits specified join order in
4326 * that join level, we leave it as-is and don't add new hints.
4330 if (lhint->outer_inner == NULL)
4332 foreach(l, lhint->relations)
4334 JoinMethodHint *hint;
4336 relname = (char *)lfirst(l);
4339 * Find relid of the relation which has given name. If we have the
4340 * name given in Leading hint multiple times in the join, nothing to
4343 relid = find_relid_aliasname(root, relname, initial_rels,
4346 /* Create bitmap of relids for current join level. */
4347 joinrelids = bms_add_member(joinrelids, relid);
4350 /* We never have join method hint for single relation. */
4355 * If we don't have join method hint, create new one for the
4356 * join combination with all join methods are enabled.
4358 hint = find_join_hint(joinrelids);
4362 * Here relnames is not set, since Relids bitmap is sufficient
4363 * to control paths of this query afterward.
4365 hint = (JoinMethodHint *) JoinMethodHintCreate(
4366 lhint->base.hint_str,
4368 HINT_KEYWORD_LEADING);
4369 hint->base.state = HINT_STATE_USED;
4370 hint->nrels = njoinrels;
4371 hint->enforce_mask = ENABLE_ALL_JOIN;
4372 hint->joinrelids = bms_copy(joinrelids);
4375 join_method_hints[njoinrels] = hint;
4377 if (njoinrels >= nbaserel)
4380 bms_free(joinrelids);
4386 * Delete all join hints which have different combination from Leading
4389 for (i = 2; i <= njoinrels; i++)
4391 list_free(hstate->join_hint_level[i]);
4393 hstate->join_hint_level[i] = lappend(NIL, join_method_hints[i]);
4398 joinrelids = OuterInnerJoinCreate(lhint->outer_inner,
4405 njoinrels = bms_num_members(joinrelids);
4406 Assert(njoinrels >= 2);
4409 * Delete all join hints which have different combination from Leading
4412 for (i = 2;i <= njoinrels; i++)
4414 if (hstate->join_hint_level[i] != NIL)
4416 ListCell *next = NULL;
4417 for(l = list_head(hstate->join_hint_level[i]); l; l = next)
4420 JoinMethodHint *hint = (JoinMethodHint *)lfirst(l);
4422 next = lnext(hstate->join_hint_level[i], l);
4424 if (hint->inner_nrels == 0 &&
4425 !(bms_intersect(hint->joinrelids, joinrelids) == NULL ||
4426 bms_equal(bms_union(hint->joinrelids, joinrelids),
4429 hstate->join_hint_level[i] =
4430 list_delete_cell(hstate->join_hint_level[i], l);
4432 * The cells after the deleted cell have been moved
4433 * towards the list head by 1 element. the next
4434 * iteration should visit the cell at the same address
4444 bms_free(joinrelids);
4447 if (hint_state_enabled(lhint))
4449 set_join_config_options(DISABLE_ALL_JOIN, current_hint_state->context);
4456 * wrapper of make_join_rel()
4458 * call make_join_rel() after changing enable_* parameters according to given
4462 make_join_rel_wrapper(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
4465 JoinMethodHint *hint;
4469 joinrelids = bms_union(rel1->relids, rel2->relids);
4470 hint = find_join_hint(joinrelids);
4471 bms_free(joinrelids);
4474 return pg_hint_plan_make_join_rel(root, rel1, rel2);
4476 if (hint->inner_nrels == 0)
4478 save_nestlevel = NewGUCNestLevel();
4480 set_join_config_options(hint->enforce_mask,
4481 current_hint_state->context);
4483 rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
4484 hint->base.state = HINT_STATE_USED;
4487 * Restore the GUC variables we set above.
4489 AtEOXact_GUC(true, save_nestlevel);
4492 rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
4501 add_paths_to_joinrel_wrapper(PlannerInfo *root,
4502 RelOptInfo *joinrel,
4503 RelOptInfo *outerrel,
4504 RelOptInfo *innerrel,
4506 SpecialJoinInfo *sjinfo,
4510 JoinMethodHint *join_hint;
4513 joinrelids = bms_union(outerrel->relids, innerrel->relids);
4514 join_hint = find_join_hint(joinrelids);
4515 bms_free(joinrelids);
4517 if (join_hint && join_hint->inner_nrels != 0)
4519 save_nestlevel = NewGUCNestLevel();
4521 if (bms_equal(join_hint->inner_joinrelids, innerrel->relids))
4524 set_join_config_options(join_hint->enforce_mask,
4525 current_hint_state->context);
4527 add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
4528 sjinfo, restrictlist);
4529 join_hint->base.state = HINT_STATE_USED;
4533 set_join_config_options(DISABLE_ALL_JOIN,
4534 current_hint_state->context);
4535 add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
4536 sjinfo, restrictlist);
4540 * Restore the GUC variables we set above.
4542 AtEOXact_GUC(true, save_nestlevel);
4545 add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
4546 sjinfo, restrictlist);
4550 get_num_baserels(List *initial_rels)
4555 foreach(l, initial_rels)
4557 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
4559 if (rel->reloptkind == RELOPT_BASEREL)
4561 else if (rel->reloptkind ==RELOPT_JOINREL)
4562 nbaserel+= bms_num_members(rel->relids);
4565 /* other values not expected here */
4566 elog(ERROR, "unrecognized reloptkind type: %d", rel->reloptkind);
4574 pg_hint_plan_join_search(PlannerInfo *root, int levels_needed,
4577 JoinMethodHint **join_method_hints;
4581 bool leading_hint_enable;
4584 * Use standard planner (or geqo planner) if pg_hint_plan is disabled or no
4585 * valid hint is supplied or current nesting depth is nesting depth of SPI
4588 if (!current_hint_state || hint_inhibit_level > 0)
4590 if (prev_join_search)
4591 return (*prev_join_search) (root, levels_needed, initial_rels);
4592 else if (enable_geqo && levels_needed >= geqo_threshold)
4593 return geqo(root, levels_needed, initial_rels);
4595 return standard_join_search(root, levels_needed, initial_rels);
4599 * In the case using GEQO, only scan method hints and Set hints have
4600 * effect. Join method and join order is not controllable by hints.
4602 if (enable_geqo && levels_needed >= geqo_threshold)
4603 return geqo(root, levels_needed, initial_rels);
4605 nbaserel = get_num_baserels(initial_rels);
4606 current_hint_state->join_hint_level =
4607 palloc0(sizeof(List *) * (nbaserel + 1));
4608 join_method_hints = palloc0(sizeof(JoinMethodHint *) * (nbaserel + 1));
4610 leading_hint_enable = transform_join_hints(current_hint_state,
4612 initial_rels, join_method_hints);
4614 rel = pg_hint_plan_standard_join_search(root, levels_needed, initial_rels);
4617 * Adjust number of parallel workers of the result rel to the largest
4618 * number of the component paths.
4620 if (current_hint_state->num_hints[HINT_TYPE_PARALLEL] > 0)
4625 foreach (lc, initial_rels)
4628 RelOptInfo *rel = (RelOptInfo *) lfirst(lc);
4630 foreach (lcp, rel->partial_pathlist)
4632 Path *path = (Path *) lfirst(lcp);
4634 if (nworkers < path-> parallel_workers)
4635 nworkers = path-> parallel_workers;
4639 foreach (lc, rel->partial_pathlist)
4641 Path *path = (Path *) lfirst(lc);
4643 if (path->parallel_safe && path->parallel_workers < nworkers)
4644 path->parallel_workers = nworkers;
4648 for (i = 2; i <= nbaserel; i++)
4650 list_free(current_hint_state->join_hint_level[i]);
4652 /* free Leading hint only */
4653 if (join_method_hints[i] != NULL &&
4654 join_method_hints[i]->enforce_mask == ENABLE_ALL_JOIN)
4655 JoinMethodHintDelete(join_method_hints[i]);
4657 pfree(current_hint_state->join_hint_level);
4658 pfree(join_method_hints);
4660 if (leading_hint_enable)
4661 set_join_config_options(current_hint_state->init_join_mask,
4662 current_hint_state->context);
4668 * Force number of wokers if instructed by hint
4671 pg_hint_plan_set_rel_pathlist(PlannerInfo * root, RelOptInfo *rel,
4672 Index rti, RangeTblEntry *rte)
4674 ParallelHint *phint;
4678 /* call the previous hook */
4679 if (prev_set_rel_pathlist)
4680 prev_set_rel_pathlist(root, rel, rti, rte);
4682 /* Nothing to do if no hint available */
4683 if (current_hint_state == NULL)
4686 /* Don't touch dummy rels. */
4687 if (IS_DUMMY_REL(rel))
4691 * We can accept only plain relations, foreign tables and table saples are
4692 * also unacceptable. See set_rel_pathlist.
4694 if ((rel->rtekind != RTE_RELATION &&
4695 rel->rtekind != RTE_SUBQUERY)||
4696 rte->relkind == RELKIND_FOREIGN_TABLE ||
4697 rte->tablesample != NULL)
4701 * Even though UNION ALL node doesn't have particular name so usually it is
4702 * unhintable, turn on parallel when it contains parallel nodes.
4704 if (rel->rtekind == RTE_SUBQUERY)
4707 bool inhibit_nonparallel = false;
4709 if (rel->partial_pathlist == NIL)
4712 foreach(lc, rel->partial_pathlist)
4715 AppendPath *apath = (AppendPath *) lfirst(lc);
4716 int parallel_workers = 0;
4718 if (!IsA(apath, AppendPath))
4721 foreach (lcp, apath->subpaths)
4723 Path *spath = (Path *) lfirst(lcp);
4725 if (spath->parallel_aware &&
4726 parallel_workers < spath->parallel_workers)
4727 parallel_workers = spath->parallel_workers;
4730 apath->path.parallel_workers = parallel_workers;
4731 inhibit_nonparallel = true;
4734 if (inhibit_nonparallel)
4738 foreach(lc, rel->pathlist)
4740 Path *path = (Path *) lfirst(lc);
4742 if (path->startup_cost < disable_cost)
4744 path->startup_cost += disable_cost;
4745 path->total_cost += disable_cost;
4753 /* We cannot handle if this requires an outer */
4754 if (rel->lateral_relids)
4757 /* Return if this relation gets no enfocement */
4758 if ((found_hints = setup_hint_enforcement(root, rel, NULL, &phint)) == 0)
4761 /* Here, we regenerate paths with the current hint restriction */
4762 if (found_hints & HINT_BM_SCAN_METHOD || found_hints & HINT_BM_PARALLEL)
4765 * When hint is specified on non-parent relations, discard existing
4766 * paths and regenerate based on the hint considered. Otherwise we
4767 * already have hinted childx paths then just adjust the number of
4768 * planned number of workers.
4770 if (root->simple_rte_array[rel->relid]->inh)
4772 /* enforce number of workers if requested */
4773 if (phint && phint->force_parallel)
4775 if (phint->nworkers == 0)
4777 list_free_deep(rel->partial_pathlist);
4778 rel->partial_pathlist = NIL;
4782 /* prioritize partial paths */
4783 foreach (l, rel->partial_pathlist)
4785 Path *ppath = (Path *) lfirst(l);
4787 if (ppath->parallel_safe)
4789 ppath->parallel_workers = phint->nworkers;
4790 ppath->startup_cost = 0;
4791 ppath->total_cost = 0;
4795 /* disable non-partial paths */
4796 foreach (l, rel->pathlist)
4798 Path *ppath = (Path *) lfirst(l);
4800 if (ppath->startup_cost < disable_cost)
4802 ppath->startup_cost += disable_cost;
4803 ppath->total_cost += disable_cost;
4811 /* Just discard all the paths considered so far */
4812 list_free_deep(rel->pathlist);
4813 rel->pathlist = NIL;
4814 list_free_deep(rel->partial_pathlist);
4815 rel->partial_pathlist = NIL;
4817 /* Regenerate paths with the current enforcement */
4818 set_plain_rel_pathlist(root, rel, rte);
4820 /* Additional work to enforce parallel query execution */
4821 if (phint && phint->nworkers > 0)
4824 * For Parallel Append to be planned properly, we shouldn't set
4825 * the costs of non-partial paths to disable-value. Lower the
4826 * priority of non-parallel paths by setting partial path costs
4829 foreach (l, rel->partial_pathlist)
4831 Path *path = (Path *) lfirst(l);
4833 path->startup_cost = 0;
4834 path->total_cost = 0;
4837 /* enforce number of workers if requested */
4838 if (phint->force_parallel)
4840 foreach (l, rel->partial_pathlist)
4842 Path *ppath = (Path *) lfirst(l);
4844 if (ppath->parallel_safe)
4845 ppath->parallel_workers = phint->nworkers;
4849 /* Generate gather paths */
4850 if (rel->reloptkind == RELOPT_BASEREL &&
4851 bms_membership(root->all_baserels) != BMS_SINGLETON)
4852 generate_gather_paths(root, rel, false);
4857 reset_hint_enforcement();
4862 * Build access paths for a base relation
4864 * This function was copied and edited from set_rel_pathlist() in
4865 * src/backend/optimizer/path/allpaths.c in order not to copy other static
4866 * functions not required here.
4869 set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
4870 Index rti, RangeTblEntry *rte)
4872 if (IS_DUMMY_REL(rel))
4874 /* We already proved the relation empty, so nothing more to do */
4878 /* It's an "append relation", process accordingly */
4879 set_append_rel_pathlist(root, rel, rti, rte);
4883 if (rel->rtekind == RTE_RELATION)
4885 if (rte->relkind == RELKIND_RELATION)
4887 if(rte->tablesample != NULL)
4888 elog(ERROR, "sampled relation is not supported");
4890 /* Plain relation */
4891 set_plain_rel_pathlist(root, rel, rte);
4894 elog(ERROR, "unexpected relkind: %c", rte->relkind);
4897 elog(ERROR, "unexpected rtekind: %d", (int) rel->rtekind);
4901 * Allow a plugin to editorialize on the set of Paths for this base
4902 * relation. It could add new paths (such as CustomPaths) by calling
4903 * add_path(), or delete or modify paths added by the core code.
4905 if (set_rel_pathlist_hook)
4906 (*set_rel_pathlist_hook) (root, rel, rti, rte);
4908 /* Now find the cheapest of the paths for this rel */
4913 * stmt_beg callback is called when each query in PL/pgSQL function is about
4914 * to be executed. At that timing, we save query string in the global variable
4915 * plpgsql_query_string to use it in planner hook. It's safe to use one global
4916 * variable for the purpose, because its content is only necessary until
4917 * planner hook is called for the query, so recursive PL/pgSQL function calls
4918 * don't harm this mechanism.
4921 pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt)
4923 plpgsql_recurse_level++;
4927 * stmt_end callback is called then each query in PL/pgSQL function has
4928 * finished. At that timing, we clear plpgsql_query_string to tell planner
4929 * hook that next call is not for a query written in PL/pgSQL block.
4932 pg_hint_plan_plpgsql_stmt_end(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt)
4934 plpgsql_recurse_level--;
4937 void plpgsql_query_erase_callback(ResourceReleasePhase phase,
4942 if (!isTopLevel || phase != RESOURCE_RELEASE_AFTER_LOCKS)
4944 /* Cancel plpgsql nest level*/
4945 plpgsql_recurse_level = 0;
4948 #define standard_join_search pg_hint_plan_standard_join_search
4949 #define join_search_one_level pg_hint_plan_join_search_one_level
4950 #define make_join_rel make_join_rel_wrapper
4953 #undef make_join_rel
4954 #define make_join_rel pg_hint_plan_make_join_rel
4955 #define add_paths_to_joinrel add_paths_to_joinrel_wrapper
4956 #include "make_join_rel.c"
4958 #include "pg_stat_statements.c"