X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=pg_hint_plan.c;h=4e2f5e592eae0ec79413d29a9e831841a325a460;hb=8241ef0732b65ff8635eb5cc56860b2e9db40ab7;hp=4ae79e399d0372eccaf425cd5217ef8e19471a81;hpb=8cbf53017f7fc03ebda968559865af0046990e22;p=pghintplan%2Fpg_hint_plan.git diff --git a/pg_hint_plan.c b/pg_hint_plan.c index 4ae79e3..4e2f5e5 100644 --- a/pg_hint_plan.c +++ b/pg_hint_plan.c @@ -1,52 +1,67 @@ /*------------------------------------------------------------------------- * * pg_hint_plan.c - * do instructions or hints to the planner using C-style block comments - * of the SQL. + * hinting on how to execute a query for PostgreSQL * - * Copyright (c) 2012-2013, NIPPON TELEGRAPH AND TELEPHONE CORPORATION + * Copyright (c) 2012-2019, NIPPON TELEGRAPH AND TELEPHONE CORPORATION * *------------------------------------------------------------------------- */ +#include + #include "postgres.h" +#include "access/genam.h" +#include "access/heapam.h" +#include "access/relation.h" #include "catalog/pg_collation.h" #include "catalog/pg_index.h" #include "commands/prepare.h" #include "mb/pg_wchar.h" #include "miscadmin.h" #include "nodes/nodeFuncs.h" +#include "nodes/params.h" +#include "optimizer/appendinfo.h" #include "optimizer/clauses.h" #include "optimizer/cost.h" #include "optimizer/geqo.h" #include "optimizer/joininfo.h" +#include "optimizer/optimizer.h" #include "optimizer/pathnode.h" #include "optimizer/paths.h" #include "optimizer/plancat.h" #include "optimizer/planner.h" #include "optimizer/prep.h" #include "optimizer/restrictinfo.h" +#include "parser/analyze.h" +#include "parser/parsetree.h" #include "parser/scansup.h" +#include "partitioning/partbounds.h" #include "tcop/utility.h" #include "utils/builtins.h" #include "utils/lsyscache.h" #include "utils/memutils.h" #include "utils/rel.h" +#include "utils/snapmgr.h" #include "utils/syscache.h" -#if PG_VERSION_NUM >= 90200 +#include "utils/resowner.h" + #include "catalog/pg_class.h" -#endif #include "executor/spi.h" #include "catalog/pg_type.h" +#include "plpgsql.h" + +/* partially copied from pg_stat_statements */ +#include "normalize_query.h" + +/* PostgreSQL */ +#include "access/htup_details.h" + #ifdef PG_MODULE_MAGIC PG_MODULE_MAGIC; #endif -#if PG_VERSION_NUM < 90100 -#error unsupported PostgreSQL version -#endif - #define BLOCK_COMMENT_START "/*" #define BLOCK_COMMENT_END "*/" #define HINT_COMMENT_KEYWORD "+" @@ -64,11 +79,11 @@ PG_MODULE_MAGIC; #define HINT_NOINDEXSCAN "NoIndexScan" #define HINT_NOBITMAPSCAN "NoBitmapScan" #define HINT_NOTIDSCAN "NoTidScan" -#if PG_VERSION_NUM >= 90200 #define HINT_INDEXONLYSCAN "IndexOnlyScan" #define HINT_INDEXONLYSCANREGEXP "IndexOnlyScanRegexp" #define HINT_NOINDEXONLYSCAN "NoIndexOnlyScan" -#endif +#define HINT_PARALLEL "Parallel" + #define HINT_NESTLOOP "NestLoop" #define HINT_MERGEJOIN "MergeJoin" #define HINT_HASHJOIN "HashJoin" @@ -77,13 +92,17 @@ PG_MODULE_MAGIC; #define HINT_NOHASHJOIN "NoHashJoin" #define HINT_LEADING "Leading" #define HINT_SET "Set" +#define HINT_ROWS "Rows" #define HINT_ARRAY_DEFAULT_INITSIZE 8 -#define hint_ereport(str, detail) \ - ereport(pg_hint_plan_parse_messages, \ - (errmsg("hint syntax error at or near \"%s\"", (str)), \ - errdetail detail)) +#define hint_ereport(str, detail) hint_parse_ereport(str, detail) +#define hint_parse_ereport(str, detail) \ + do { \ + ereport(pg_hint_plan_parse_message_level, \ + (errmsg("pg_hint_plan: hint syntax error at or near \"%s\"", (str)), \ + errdetail detail)); \ + } while(0) #define skip_space(str) \ while (isspace(*str)) \ @@ -95,9 +114,7 @@ enum ENABLE_INDEXSCAN = 0x02, ENABLE_BITMAPSCAN = 0x04, ENABLE_TIDSCAN = 0x08, -#if PG_VERSION_NUM >= 90200 ENABLE_INDEXONLYSCAN = 0x10 -#endif } SCAN_TYPE_BITS; enum @@ -107,14 +124,9 @@ enum ENABLE_HASHJOIN = 0x04 } JOIN_TYPE_BITS; -#if PG_VERSION_NUM >= 90200 #define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \ ENABLE_BITMAPSCAN | ENABLE_TIDSCAN | \ ENABLE_INDEXONLYSCAN) -#else -#define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \ - ENABLE_BITMAPSCAN | ENABLE_TIDSCAN) -#endif #define ENABLE_ALL_JOIN (ENABLE_NESTLOOP | ENABLE_MERGEJOIN | ENABLE_HASHJOIN) #define DISABLE_ALL_SCAN 0 #define DISABLE_ALL_JOIN 0 @@ -132,22 +144,34 @@ typedef enum HintKeyword HINT_KEYWORD_NOINDEXSCAN, HINT_KEYWORD_NOBITMAPSCAN, HINT_KEYWORD_NOTIDSCAN, -#if PG_VERSION_NUM >= 90200 HINT_KEYWORD_INDEXONLYSCAN, HINT_KEYWORD_INDEXONLYSCANREGEXP, HINT_KEYWORD_NOINDEXONLYSCAN, -#endif + HINT_KEYWORD_NESTLOOP, HINT_KEYWORD_MERGEJOIN, HINT_KEYWORD_HASHJOIN, HINT_KEYWORD_NONESTLOOP, HINT_KEYWORD_NOMERGEJOIN, HINT_KEYWORD_NOHASHJOIN, + HINT_KEYWORD_LEADING, HINT_KEYWORD_SET, + HINT_KEYWORD_ROWS, + HINT_KEYWORD_PARALLEL, + HINT_KEYWORD_UNRECOGNIZED } HintKeyword; +#define SCAN_HINT_ACCEPTS_INDEX_NAMES(kw) \ + (kw == HINT_KEYWORD_INDEXSCAN || \ + kw == HINT_KEYWORD_INDEXSCANREGEXP || \ + kw == HINT_KEYWORD_INDEXONLYSCAN || \ + kw == HINT_KEYWORD_INDEXONLYSCANREGEXP || \ + kw == HINT_KEYWORD_BITMAPSCAN || \ + kw == HINT_KEYWORD_BITMAPSCANREGEXP) + + typedef struct Hint Hint; typedef struct HintState HintState; @@ -155,26 +179,36 @@ typedef Hint *(*HintCreateFunction) (const char *hint_str, const char *keyword, HintKeyword hint_keyword); typedef void (*HintDeleteFunction) (Hint *hint); -typedef void (*HintDescFunction) (Hint *hint, StringInfo buf); +typedef void (*HintDescFunction) (Hint *hint, StringInfo buf, bool nolf); typedef int (*HintCmpFunction) (const Hint *a, const Hint *b); typedef const char *(*HintParseFunction) (Hint *hint, HintState *hstate, Query *parse, const char *str); /* hint types */ -#define NUM_HINT_TYPE 4 +#define NUM_HINT_TYPE 6 typedef enum HintType { HINT_TYPE_SCAN_METHOD, HINT_TYPE_JOIN_METHOD, HINT_TYPE_LEADING, - HINT_TYPE_SET + HINT_TYPE_SET, + HINT_TYPE_ROWS, + HINT_TYPE_PARALLEL } HintType; +typedef enum HintTypeBitmap +{ + HINT_BM_SCAN_METHOD = 1, + HINT_BM_PARALLEL = 2 +} HintTypeBitmap; + static const char *HintTypeName[] = { "scan method", "join method", "leading", - "set" + "set", + "rows", + "parallel" }; /* hint status */ @@ -190,6 +224,19 @@ typedef enum HintStatus #define hint_state_enabled(hint) ((hint)->base.state == HINT_STATE_NOTUSED || \ (hint)->base.state == HINT_STATE_USED) +static unsigned int qno = 0; +static unsigned int msgqno = 0; +static char qnostr[32]; +static const char *current_hint_str = NULL; + +/* + * However we usually take a hint stirng in post_parse_analyze_hook, we still + * need to do so in planner_hook when client starts query execution from the + * bind message on a prepared query. This variable prevent duplicate and + * sometimes harmful hint string retrieval. + */ +static bool current_hint_retrieved = false; + /* common data for all hints. */ struct Hint { @@ -261,6 +308,36 @@ typedef struct SetHint List *words; } SetHint; +/* rows hints */ +typedef enum RowsValueType { + RVT_ABSOLUTE, /* Rows(... #1000) */ + RVT_ADD, /* Rows(... +1000) */ + RVT_SUB, /* Rows(... -1000) */ + RVT_MULTI, /* Rows(... *1.2) */ +} RowsValueType; +typedef struct RowsHint +{ + Hint base; + int nrels; + int inner_nrels; + char **relnames; + Relids joinrelids; + Relids inner_joinrelids; + char *rows_str; + RowsValueType value_type; + double rows; +} RowsHint; + +/* parallel hints */ +typedef struct ParallelHint +{ + Hint base; + char *relname; + char *nworkers_str; /* original string of nworkers */ + int nworkers; /* num of workers specified by Worker */ + bool force_parallel; /* force parallel scan */ +} ParallelHint; + /* * Describes a context of hint processing. */ @@ -278,24 +355,31 @@ struct HintState /* for scan method hints */ ScanMethodHint **scan_hints; /* parsed scan hints */ - int init_scan_mask; /* initial value scan parameter */ - Index parent_relid; /* inherit parent table relid */ - Oid parent_rel_oid; /* inherit parent table relid */ - ScanMethodHint *parent_hint; /* inherit parent table scan hint */ - List *parent_index_infos; /* infomation of inherit parent table's - * index */ - - /* for join method hints */ + + /* Initial values of parameters */ + int init_scan_mask; /* enable_* mask */ + int init_nworkers; /* max_parallel_workers_per_gather */ + /* min_parallel_table_scan_size*/ + int init_min_para_tablescan_size; + /* min_parallel_index_scan_size*/ + int init_min_para_indexscan_size; + int init_paratup_cost; /* parallel_tuple_cost */ + int init_parasetup_cost;/* parallel_setup_cost */ + + PlannerInfo *current_root; /* PlannerInfo for the followings */ + Index parent_relid; /* inherit parent of table relid */ + ScanMethodHint *parent_scan_hint; /* scan hint for the parent */ + ParallelHint *parent_parallel_hint; /* parallel hint for the parent */ + List *parent_index_infos; /* list of parent table's index */ + JoinMethodHint **join_hints; /* parsed join hints */ int init_join_mask; /* initial value join parameter */ List **join_hint_level; - - /* for Leading hint */ LeadingHint **leading_hint; /* parsed Leading hints */ - - /* for Set hints */ SetHint **set_hints; /* parsed Set hints */ GucContext context; /* which GUC parameters can we set? */ + RowsHint **rows_hints; /* parsed Rows hints */ + ParallelHint **parallel_hints; /* parsed Parallel hints */ }; /* @@ -315,49 +399,72 @@ void _PG_fini(void); static void push_hint(HintState *hstate); static void pop_hint(void); -static void pg_hint_plan_ProcessUtility(Node *parsetree, - const char *queryString, - ParamListInfo params, bool isTopLevel, - DestReceiver *dest, - char *completionTag); +static void pg_hint_plan_post_parse_analyze(ParseState *pstate, Query *query); +static void pg_hint_plan_ProcessUtility(PlannedStmt *pstmt, + const char *queryString, + ProcessUtilityContext context, + ParamListInfo params, QueryEnvironment *queryEnv, + DestReceiver *dest, char *completionTag); static PlannedStmt *pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams); -static void pg_hint_plan_get_relation_info(PlannerInfo *root, - Oid relationObjectId, - bool inhparent, RelOptInfo *rel); static RelOptInfo *pg_hint_plan_join_search(PlannerInfo *root, int levels_needed, List *initial_rels); +/* Scan method hint callbacks */ static Hint *ScanMethodHintCreate(const char *hint_str, const char *keyword, HintKeyword hint_keyword); static void ScanMethodHintDelete(ScanMethodHint *hint); -static void ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf); +static void ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf, bool nolf); static int ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b); static const char *ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse, const char *str); + +/* Join method hint callbacks */ static Hint *JoinMethodHintCreate(const char *hint_str, const char *keyword, HintKeyword hint_keyword); static void JoinMethodHintDelete(JoinMethodHint *hint); -static void JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf); +static void JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf, bool nolf); static int JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b); static const char *JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate, Query *parse, const char *str); + +/* Leading hint callbacks */ static Hint *LeadingHintCreate(const char *hint_str, const char *keyword, HintKeyword hint_keyword); static void LeadingHintDelete(LeadingHint *hint); -static void LeadingHintDesc(LeadingHint *hint, StringInfo buf); +static void LeadingHintDesc(LeadingHint *hint, StringInfo buf, bool nolf); static int LeadingHintCmp(const LeadingHint *a, const LeadingHint *b); static const char *LeadingHintParse(LeadingHint *hint, HintState *hstate, Query *parse, const char *str); + +/* Set hint callbacks */ static Hint *SetHintCreate(const char *hint_str, const char *keyword, HintKeyword hint_keyword); static void SetHintDelete(SetHint *hint); -static void SetHintDesc(SetHint *hint, StringInfo buf); +static void SetHintDesc(SetHint *hint, StringInfo buf, bool nolf); static int SetHintCmp(const SetHint *a, const SetHint *b); static const char *SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str); +/* Rows hint callbacks */ +static Hint *RowsHintCreate(const char *hint_str, const char *keyword, + HintKeyword hint_keyword); +static void RowsHintDelete(RowsHint *hint); +static void RowsHintDesc(RowsHint *hint, StringInfo buf, bool nolf); +static int RowsHintCmp(const RowsHint *a, const RowsHint *b); +static const char *RowsHintParse(RowsHint *hint, HintState *hstate, + Query *parse, const char *str); + +/* Parallel hint callbacks */ +static Hint *ParallelHintCreate(const char *hint_str, const char *keyword, + HintKeyword hint_keyword); +static void ParallelHintDelete(ParallelHint *hint); +static void ParallelHintDesc(ParallelHint *hint, StringInfo buf, bool nolf); +static int ParallelHintCmp(const ParallelHint *a, const ParallelHint *b); +static const char *ParallelHintParse(ParallelHint *hint, HintState *hstate, + Query *parse, const char *str); + static void quote_value(StringInfo buf, const char *value); static const char *parse_quoted_value(const char *str, char **word, @@ -367,30 +474,51 @@ RelOptInfo *pg_hint_plan_standard_join_search(PlannerInfo *root, int levels_needed, List *initial_rels); void pg_hint_plan_join_search_one_level(PlannerInfo *root, int level); +void pg_hint_plan_set_rel_pathlist(PlannerInfo * root, RelOptInfo *rel, + Index rti, RangeTblEntry *rte); +static void create_plain_partial_paths(PlannerInfo *root, + RelOptInfo *rel); static void make_rels_by_clause_joins(PlannerInfo *root, RelOptInfo *old_rel, ListCell *other_rels); static void make_rels_by_clauseless_joins(PlannerInfo *root, RelOptInfo *old_rel, ListCell *other_rels); static bool has_join_restriction(PlannerInfo *root, RelOptInfo *rel); +static void set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, + RangeTblEntry *rte); static void set_append_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, Index rti, RangeTblEntry *rte); -#if PG_VERSION_NUM >= 90200 -static void generate_mergeappend_paths(PlannerInfo *root, RelOptInfo *rel, - List *live_childrels, - List *all_child_pathkeys); -#endif -static List *accumulate_append_subpath(List *subpaths, Path *path); -#if PG_VERSION_NUM < 90200 -static void set_dummy_rel_pathlist(RelOptInfo *rel); -#endif RelOptInfo *pg_hint_plan_make_join_rel(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2); +static void pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate, + PLpgSQL_stmt *stmt); +static void pg_hint_plan_plpgsql_stmt_end(PLpgSQL_execstate *estate, + PLpgSQL_stmt *stmt); +static void plpgsql_query_erase_callback(ResourceReleasePhase phase, + bool isCommit, + bool isTopLevel, + void *arg); +static int set_config_option_noerror(const char *name, const char *value, + GucContext context, GucSource source, + GucAction action, bool changeVal, int elevel); +static void setup_scan_method_enforcement(ScanMethodHint *scanhint, + HintState *state); +static int set_config_int32_option(const char *name, int32 value, + GucContext context); + /* GUC variables */ static bool pg_hint_plan_enable_hint = true; -static bool pg_hint_plan_debug_print = false; -static int pg_hint_plan_parse_messages = INFO; +static int debug_level = 0; +static int pg_hint_plan_parse_message_level = INFO; +static int pg_hint_plan_debug_message_level = LOG; +/* Default is off, to keep backward compatibility. */ +static bool pg_hint_plan_enable_hint_table = false; + +static int plpgsql_recurse_level = 0; /* PLpgSQL recursion level */ +static int hint_inhibit_level = 0; /* Inhibit hinting if this is above 0 */ + /* (This could not be above 1) */ +static int max_hint_nworkers = -1; /* Maximum nworkers of Workers hints */ static const struct config_enum_entry parse_messages_level_options[] = { {"debug", DEBUG2, true}, @@ -411,27 +539,39 @@ static const struct config_enum_entry parse_messages_level_options[] = { {NULL, 0, false} }; +static const struct config_enum_entry parse_debug_level_options[] = { + {"off", 0, false}, + {"on", 1, false}, + {"detailed", 2, false}, + {"verbose", 3, false}, + {"0", 0, true}, + {"1", 1, true}, + {"2", 2, true}, + {"3", 3, true}, + {"no", 0, true}, + {"yes", 1, true}, + {"false", 0, true}, + {"true", 1, true}, + {NULL, 0, false} +}; + /* Saved hook values in case of unload */ -static ProcessUtility_hook_type prev_ProcessUtility = NULL; +static post_parse_analyze_hook_type prev_post_parse_analyze_hook = NULL; static planner_hook_type prev_planner = NULL; -static get_relation_info_hook_type prev_get_relation_info = NULL; static join_search_hook_type prev_join_search = NULL; +static set_rel_pathlist_hook_type prev_set_rel_pathlist = NULL; +static ProcessUtility_hook_type prev_ProcessUtility_hook = NULL; /* Hold reference to currently active hint */ -static HintState *current_hint = NULL; +static HintState *current_hint_state = NULL; /* * List of hint contexts. We treat the head of the list as the Top of the - * context stack, so current_hint always points the first element of this list. + * context stack, so current_hint_state always points the first element of this + * list. */ static List *HintStateStack = NIL; -/* - * Holds statement name during executing EXECUTE command. NULL for other - * statements. - */ -static char *stmt_name = NULL; - static const HintParser parsers[] = { {HINT_SEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_SEQSCAN}, {HINT_INDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCAN}, @@ -444,31 +584,35 @@ static const HintParser parsers[] = { {HINT_NOINDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXSCAN}, {HINT_NOBITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOBITMAPSCAN}, {HINT_NOTIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOTIDSCAN}, -#if PG_VERSION_NUM >= 90200 {HINT_INDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXONLYSCAN}, {HINT_INDEXONLYSCANREGEXP, ScanMethodHintCreate, HINT_KEYWORD_INDEXONLYSCANREGEXP}, {HINT_NOINDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXONLYSCAN}, -#endif + {HINT_NESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NESTLOOP}, {HINT_MERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_MERGEJOIN}, {HINT_HASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_HASHJOIN}, {HINT_NONESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NONESTLOOP}, {HINT_NOMERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOMERGEJOIN}, {HINT_NOHASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOHASHJOIN}, + {HINT_LEADING, LeadingHintCreate, HINT_KEYWORD_LEADING}, {HINT_SET, SetHintCreate, HINT_KEYWORD_SET}, + {HINT_ROWS, RowsHintCreate, HINT_KEYWORD_ROWS}, + {HINT_PARALLEL, ParallelHintCreate, HINT_KEYWORD_PARALLEL}, + {NULL, NULL, HINT_KEYWORD_UNRECOGNIZED} }; -/* search hint. */ -static const char *search_query = - "SELECT hints " - " FROM hint_plan.hints " - " WHERE norm_query_string = $1 " - " AND ( application_name = $2 " - " OR application_name = '' ) " - " ORDER BY application_name DESC"; +PLpgSQL_plugin plugin_funcs = { + NULL, + NULL, + NULL, + pg_hint_plan_plpgsql_stmt_beg, + pg_hint_plan_plpgsql_stmt_end, + NULL, + NULL, +}; /* * Module load callbacks @@ -476,23 +620,26 @@ static const char *search_query = void _PG_init(void) { + PLpgSQL_plugin **var_ptr; + /* Define custom GUC variables. */ DefineCustomBoolVariable("pg_hint_plan.enable_hint", "Force planner to use plans specified in the hint comment preceding to the query.", NULL, &pg_hint_plan_enable_hint, true, - PGC_USERSET, + PGC_USERSET, 0, NULL, NULL, NULL); - DefineCustomBoolVariable("pg_hint_plan.debug_print", + DefineCustomEnumVariable("pg_hint_plan.debug_print", "Logs results of hint parsing.", NULL, - &pg_hint_plan_debug_print, + &debug_level, false, + parse_debug_level_options, PGC_USERSET, 0, NULL, @@ -502,7 +649,7 @@ _PG_init(void) DefineCustomEnumVariable("pg_hint_plan.parse_messages", "Message level of parse errors.", NULL, - &pg_hint_plan_parse_messages, + &pg_hint_plan_parse_message_level, INFO, parse_messages_level_options, PGC_USERSET, @@ -511,15 +658,46 @@ _PG_init(void) NULL, NULL); + DefineCustomEnumVariable("pg_hint_plan.message_level", + "Message level of debug messages.", + NULL, + &pg_hint_plan_debug_message_level, + LOG, + parse_messages_level_options, + PGC_USERSET, + 0, + NULL, + NULL, + NULL); + + DefineCustomBoolVariable("pg_hint_plan.enable_hint_table", + "Let pg_hint_plan look up the hint table.", + NULL, + &pg_hint_plan_enable_hint_table, + false, + PGC_USERSET, + 0, + NULL, + NULL, + NULL); + /* Install hooks. */ - prev_ProcessUtility = ProcessUtility_hook; - ProcessUtility_hook = pg_hint_plan_ProcessUtility; + prev_post_parse_analyze_hook = post_parse_analyze_hook; + post_parse_analyze_hook = pg_hint_plan_post_parse_analyze; prev_planner = planner_hook; planner_hook = pg_hint_plan_planner; - prev_get_relation_info = get_relation_info_hook; - get_relation_info_hook = pg_hint_plan_get_relation_info; prev_join_search = join_search_hook; join_search_hook = pg_hint_plan_join_search; + prev_set_rel_pathlist = set_rel_pathlist_hook; + set_rel_pathlist_hook = pg_hint_plan_set_rel_pathlist; + prev_ProcessUtility_hook = ProcessUtility_hook; + ProcessUtility_hook = pg_hint_plan_ProcessUtility; + + /* setup PL/pgSQL plugin hook */ + var_ptr = (PLpgSQL_plugin **) find_rendezvous_variable("PLpgSQL_plugin"); + *var_ptr = &plugin_funcs; + + RegisterResourceReleaseCallback(plpgsql_query_erase_callback, NULL); } /* @@ -529,11 +707,18 @@ _PG_init(void) void _PG_fini(void) { + PLpgSQL_plugin **var_ptr; + /* Uninstall hooks. */ - ProcessUtility_hook = prev_ProcessUtility; + post_parse_analyze_hook = prev_post_parse_analyze_hook; planner_hook = prev_planner; - get_relation_info_hook = prev_get_relation_info; join_search_hook = prev_join_search; + set_rel_pathlist_hook = prev_set_rel_pathlist; + ProcessUtility_hook = prev_ProcessUtility_hook; + + /* uninstall PL/pgSQL plugin hook */ + var_ptr = (PLpgSQL_plugin **) find_rendezvous_variable("PLpgSQL_plugin"); + *var_ptr = NULL; } /* @@ -694,6 +879,89 @@ SetHintDelete(SetHint *hint) pfree(hint); } +static Hint * +RowsHintCreate(const char *hint_str, const char *keyword, + HintKeyword hint_keyword) +{ + RowsHint *hint; + + hint = palloc(sizeof(RowsHint)); + hint->base.hint_str = hint_str; + hint->base.keyword = keyword; + hint->base.hint_keyword = hint_keyword; + hint->base.type = HINT_TYPE_ROWS; + hint->base.state = HINT_STATE_NOTUSED; + hint->base.delete_func = (HintDeleteFunction) RowsHintDelete; + hint->base.desc_func = (HintDescFunction) RowsHintDesc; + hint->base.cmp_func = (HintCmpFunction) RowsHintCmp; + hint->base.parse_func = (HintParseFunction) RowsHintParse; + hint->nrels = 0; + hint->inner_nrels = 0; + hint->relnames = NULL; + hint->joinrelids = NULL; + hint->inner_joinrelids = NULL; + hint->rows_str = NULL; + hint->value_type = RVT_ABSOLUTE; + hint->rows = 0; + + return (Hint *) hint; +} + +static void +RowsHintDelete(RowsHint *hint) +{ + if (!hint) + return; + + if (hint->relnames) + { + int i; + + for (i = 0; i < hint->nrels; i++) + pfree(hint->relnames[i]); + pfree(hint->relnames); + } + + bms_free(hint->joinrelids); + bms_free(hint->inner_joinrelids); + pfree(hint); +} + +static Hint * +ParallelHintCreate(const char *hint_str, const char *keyword, + HintKeyword hint_keyword) +{ + ParallelHint *hint; + + hint = palloc(sizeof(ScanMethodHint)); + hint->base.hint_str = hint_str; + hint->base.keyword = keyword; + hint->base.hint_keyword = hint_keyword; + hint->base.type = HINT_TYPE_PARALLEL; + hint->base.state = HINT_STATE_NOTUSED; + hint->base.delete_func = (HintDeleteFunction) ParallelHintDelete; + hint->base.desc_func = (HintDescFunction) ParallelHintDesc; + hint->base.cmp_func = (HintCmpFunction) ParallelHintCmp; + hint->base.parse_func = (HintParseFunction) ParallelHintParse; + hint->relname = NULL; + hint->nworkers = 0; + hint->nworkers_str = "0"; + + return (Hint *) hint; +} + +static void +ParallelHintDelete(ParallelHint *hint) +{ + if (!hint) + return; + + if (hint->relname) + pfree(hint->relname); + pfree(hint); +} + + static HintState * HintStateCreate(void) { @@ -707,9 +975,15 @@ HintStateCreate(void) memset(hstate->num_hints, 0, sizeof(hstate->num_hints)); hstate->scan_hints = NULL; hstate->init_scan_mask = 0; + hstate->init_nworkers = 0; + hstate->init_min_para_tablescan_size = 0; + hstate->init_min_para_indexscan_size = 0; + hstate->init_paratup_cost = 0; + hstate->init_parasetup_cost = 0; + hstate->current_root = NULL; hstate->parent_relid = 0; - hstate->parent_rel_oid = InvalidOid; - hstate->parent_hint = NULL; + hstate->parent_scan_hint = NULL; + hstate->parent_parallel_hint = NULL; hstate->parent_index_infos = NIL; hstate->join_hints = NULL; hstate->init_join_mask = 0; @@ -717,6 +991,8 @@ HintStateCreate(void) hstate->leading_hint = NULL; hstate->context = superuser() ? PGC_SUSET : PGC_USERSET; hstate->set_hints = NULL; + hstate->rows_hints = NULL; + hstate->parallel_hints = NULL; return hstate; } @@ -772,7 +1048,7 @@ quote_value(StringInfo buf, const char *value) } static void -ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf) +ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf, bool nolf) { ListCell *l; @@ -786,11 +1062,13 @@ ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf) quote_value(buf, (char *) lfirst(l)); } } - appendStringInfoString(buf, ")\n"); + appendStringInfoString(buf, ")"); + if (!nolf) + appendStringInfoChar(buf, '\n'); } static void -JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf) +JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf, bool nolf) { int i; @@ -804,8 +1082,9 @@ JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf) quote_value(buf, hint->relnames[i]); } } - appendStringInfoString(buf, ")\n"); - + appendStringInfoString(buf, ")"); + if (!nolf) + appendStringInfoChar(buf, '\n'); } static void @@ -836,7 +1115,7 @@ OuterInnerDesc(OuterInnerRels *outer_inner, StringInfo buf) } static void -LeadingHintDesc(LeadingHint *hint, StringInfo buf) +LeadingHintDesc(LeadingHint *hint, StringInfo buf, bool nolf) { appendStringInfo(buf, "%s(", HINT_LEADING); if (hint->outer_inner == NULL) @@ -859,11 +1138,13 @@ LeadingHintDesc(LeadingHint *hint, StringInfo buf) else OuterInnerDesc(hint->outer_inner, buf); - appendStringInfoString(buf, ")\n"); + appendStringInfoString(buf, ")"); + if (!nolf) + appendStringInfoChar(buf, '\n'); } static void -SetHintDesc(SetHint *hint, StringInfo buf) +SetHintDesc(SetHint *hint, StringInfo buf, bool nolf) { bool is_first = true; ListCell *l; @@ -878,27 +1159,79 @@ SetHintDesc(SetHint *hint, StringInfo buf) quote_value(buf, (char *) lfirst(l)); } - appendStringInfo(buf, ")\n"); + appendStringInfo(buf, ")"); + if (!nolf) + appendStringInfoChar(buf, '\n'); +} + +static void +RowsHintDesc(RowsHint *hint, StringInfo buf, bool nolf) +{ + int i; + + appendStringInfo(buf, "%s(", hint->base.keyword); + if (hint->relnames != NULL) + { + quote_value(buf, hint->relnames[0]); + for (i = 1; i < hint->nrels; i++) + { + appendStringInfoCharMacro(buf, ' '); + quote_value(buf, hint->relnames[i]); + } + } + appendStringInfo(buf, " %s", hint->rows_str); + appendStringInfoString(buf, ")"); + if (!nolf) + appendStringInfoChar(buf, '\n'); +} + +static void +ParallelHintDesc(ParallelHint *hint, StringInfo buf, bool nolf) +{ + appendStringInfo(buf, "%s(", hint->base.keyword); + if (hint->relname != NULL) + { + quote_value(buf, hint->relname); + + /* number of workers */ + appendStringInfoCharMacro(buf, ' '); + quote_value(buf, hint->nworkers_str); + /* application mode of num of workers */ + appendStringInfoCharMacro(buf, ' '); + appendStringInfoString(buf, + (hint->force_parallel ? "hard" : "soft")); + } + appendStringInfoString(buf, ")"); + if (!nolf) + appendStringInfoChar(buf, '\n'); } /* - * Append string which repserents all hints in a given state to buf, with + * Append string which represents all hints in a given state to buf, with * preceding title with them. */ static void desc_hint_in_state(HintState *hstate, StringInfo buf, const char *title, - HintStatus state) + HintStatus state, bool nolf) { - int i; + int i, nshown; + + appendStringInfo(buf, "%s:", title); + if (!nolf) + appendStringInfoChar(buf, '\n'); - appendStringInfo(buf, "%s:\n", title); + nshown = 0; for (i = 0; i < hstate->nall_hints; i++) { if (hstate->all_hints[i]->state != state) continue; - hstate->all_hints[i]->desc_func(hstate->all_hints[i], buf); + hstate->all_hints[i]->desc_func(hstate->all_hints[i], buf, nolf); + nshown++; } + + if (nolf && nshown == 0) + appendStringInfoString(buf, "(none)"); } /* @@ -911,19 +1244,48 @@ HintStateDump(HintState *hstate) if (!hstate) { - elog(LOG, "pg_hint_plan:\nno hint"); + elog(pg_hint_plan_debug_message_level, "pg_hint_plan:\nno hint"); return; } initStringInfo(&buf); appendStringInfoString(&buf, "pg_hint_plan:\n"); - desc_hint_in_state(hstate, &buf, "used hint", HINT_STATE_USED); - desc_hint_in_state(hstate, &buf, "not used hint", HINT_STATE_NOTUSED); - desc_hint_in_state(hstate, &buf, "duplication hint", HINT_STATE_DUPLICATION); - desc_hint_in_state(hstate, &buf, "error hint", HINT_STATE_ERROR); + desc_hint_in_state(hstate, &buf, "used hint", HINT_STATE_USED, false); + desc_hint_in_state(hstate, &buf, "not used hint", HINT_STATE_NOTUSED, false); + desc_hint_in_state(hstate, &buf, "duplication hint", HINT_STATE_DUPLICATION, false); + desc_hint_in_state(hstate, &buf, "error hint", HINT_STATE_ERROR, false); + + ereport(pg_hint_plan_debug_message_level, + (errmsg ("%s", buf.data))); - elog(LOG, "%s", buf.data); + pfree(buf.data); +} + +static void +HintStateDump2(HintState *hstate) +{ + StringInfoData buf; + + if (!hstate) + { + elog(pg_hint_plan_debug_message_level, + "pg_hint_plan%s: HintStateDump: no hint", qnostr); + return; + } + + initStringInfo(&buf); + appendStringInfo(&buf, "pg_hint_plan%s: HintStateDump: ", qnostr); + desc_hint_in_state(hstate, &buf, "{used hints", HINT_STATE_USED, true); + desc_hint_in_state(hstate, &buf, "}, {not used hints", HINT_STATE_NOTUSED, true); + desc_hint_in_state(hstate, &buf, "}, {duplicate hints", HINT_STATE_DUPLICATION, true); + desc_hint_in_state(hstate, &buf, "}, {error hints", HINT_STATE_ERROR, true); + appendStringInfoChar(&buf, '}'); + + ereport(pg_hint_plan_debug_message_level, + (errmsg("%s", buf.data), + errhidestmt(true), + errhidecontext(true))); pfree(buf.data); } @@ -978,6 +1340,30 @@ SetHintCmp(const SetHint *a, const SetHint *b) } static int +RowsHintCmp(const RowsHint *a, const RowsHint *b) +{ + int i; + + if (a->nrels != b->nrels) + return a->nrels - b->nrels; + + for (i = 0; i < a->nrels; i++) + { + int result; + if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0) + return result; + } + + return 0; +} + +static int +ParallelHintCmp(const ParallelHint *a, const ParallelHint *b) +{ + return RelnameCmp(&a->relname, &b->relname); +} + +static int HintCmp(const void *a, const void *b) { const Hint *hinta = *((const Hint **) a); @@ -1243,9 +1629,7 @@ parse_parentheses(const char *str, List **name_list, HintKeyword keyword) skip_space(str); if (keyword == HINT_KEYWORD_INDEXSCANREGEXP || -#if PG_VERSION_NUM >= 90200 keyword == HINT_KEYWORD_INDEXONLYSCANREGEXP || -#endif keyword == HINT_KEYWORD_BITMAPSCANREGEXP || keyword == HINT_KEYWORD_SET) { @@ -1281,7 +1665,7 @@ parse_hints(HintState *hstate, Query *parse, const char *str) char *keyword = parser->keyword; Hint *hint; - if (strcasecmp(buf.data, keyword) != 0) + if (pg_strcasecmp(buf.data, keyword) != 0) continue; hint = parser->create_func(head, keyword, parser->hint_keyword); @@ -1333,84 +1717,208 @@ parse_hints(HintState *hstate, Query *parse, const char *str) } -/* search hint. */ -static bool -search_hints( - const char *query, - const char *query_string, - const char *app_name) +/* + * Get hints from table by client-supplied query string and application name. + */ +static const char * +get_hints_from_table(const char *client_query, const char *client_application) { + const char *search_query = + "SELECT hints " + " FROM hint_plan.hints " + " WHERE norm_query_string = $1 " + " AND ( application_name = $2 " + " OR application_name = '' ) " + " ORDER BY application_name DESC"; static SPIPlanPtr plan = NULL; - int ret; - char buf[8192]; + char *hints = NULL; Oid argtypes[2] = { TEXTOID, TEXTOID }; Datum values[2]; - bool nulls[2] = { false, false }; - text *str; + char nulls[2] = {' ', ' '}; + text *qry; text *app; - ret = SPI_connect(); - if (ret != SPI_OK_CONNECT) - elog(ERROR, "pg_hint_plan: SPI_connect => %d", ret); - - if (plan == NULL) + PG_TRY(); { - SPIPlanPtr p; - p = SPI_prepare(query, 2, argtypes); - if (p == NULL) - elog(ERROR, "pg_hint_plan: SPI_prepare => %d", SPI_result); - plan = SPI_saveplan(p); - SPI_freeplan(p); - } + bool snapshot_set = false; + + hint_inhibit_level++; - str = cstring_to_text(query_string); - app = cstring_to_text(app_name); - values[0] = PointerGetDatum(str); - values[1] = PointerGetDatum(app); + if (!ActiveSnapshotSet()) + { + PushActiveSnapshot(GetTransactionSnapshot()); + snapshot_set = true; + } + + SPI_connect(); + + if (plan == NULL) + { + SPIPlanPtr p; + p = SPI_prepare(search_query, 2, argtypes); + plan = SPI_saveplan(p); + SPI_freeplan(p); + } + + qry = cstring_to_text(client_query); + app = cstring_to_text(client_application); + values[0] = PointerGetDatum(qry); + values[1] = PointerGetDatum(app); + + SPI_execute_plan(plan, values, nulls, true, 1); + + if (SPI_processed > 0) + { + char *buf; + + hints = SPI_getvalue(SPI_tuptable->vals[0], + SPI_tuptable->tupdesc, 1); + /* + * Here we use SPI_palloc to ensure that hints string is valid even + * after SPI_finish call. We can't use simple palloc because it + * allocates memory in SPI's context and that context is deleted in + * SPI_finish. + */ + buf = SPI_palloc(strlen(hints) + 1); + strcpy(buf, hints); + hints = buf; + } + + SPI_finish(); - pg_hint_plan_enable_hint = false; - ret = SPI_execute_plan(plan, values, nulls, true, 1); - pg_hint_plan_enable_hint = true; - if (ret != SPI_OK_SELECT) - elog(ERROR, "pg_hint_plan: SPI_execute_plan => %d", ret); + if (snapshot_set) + PopActiveSnapshot(); - if (SPI_processed > 0) + hint_inhibit_level--; + } + PG_CATCH(); { - sprintf(buf, "%s", SPI_getvalue(SPI_tuptable->vals[0], SPI_tuptable->tupdesc, 1)); - elog(LOG, "pg_hint_plan: SPI_execute_plan vals => %s", buf); + hint_inhibit_level--; + PG_RE_THROW(); } - else - elog(LOG, "pg_hint_plan: SPI_execute_plan rows => 0"); - - SPI_finish(); + PG_END_TRY(); - return SPI_processed > 0; + return hints; } /* - * Do basic parsing of the query head comment. + * Get client-supplied query string. Addtion to that the jumbled query is + * supplied if the caller requested. From the restriction of JumbleQuery, some + * kind of query needs special amendments. Reutrns NULL if this query doesn't + * change the current hint. This function returns NULL also when something + * wrong has happend and let the caller continue using the current hints. */ -static HintState * -parse_head_comment(Query *parse) +static const char * +get_query_string(ParseState *pstate, Query *query, Query **jumblequery) { - const char *p; - const char *hint_head; - char *head; - char *tail; - int len; - int i; - HintState *hstate; + const char *p = debug_query_string; - /* get client-supplied query string. */ - if (stmt_name) - { - PreparedStatement *entry; + /* + * If debug_query_string is set, it is the top level statement. But in some + * cases we reach here with debug_query_string set NULL for example in the + * case of DESCRIBE message handling or EXECUTE command. We may still see a + * candidate top-level query in pstate in the case. + */ + if (!p && pstate) + p = pstate->p_sourcetext; - entry = FetchPreparedStatement(stmt_name, true); - p = entry->plansource->query_string; - } - else - p = debug_query_string; + /* We don't see a query string, return NULL */ + if (!p) + return NULL; + + if (jumblequery != NULL) + *jumblequery = query; + + if (query->commandType == CMD_UTILITY) + { + Query *target_query = (Query *)query->utilityStmt; + + /* + * Some CMD_UTILITY statements have a subquery that we can hint on. + * Since EXPLAIN can be placed before other kind of utility statements + * and EXECUTE can be contained other kind of utility statements, these + * conditions are not mutually exclusive and should be considered in + * this order. + */ + if (IsA(target_query, ExplainStmt)) + { + ExplainStmt *stmt = (ExplainStmt *)target_query; + + Assert(IsA(stmt->query, Query)); + target_query = (Query *)stmt->query; + + /* strip out the top-level query for further processing */ + if (target_query->commandType == CMD_UTILITY && + target_query->utilityStmt != NULL) + target_query = (Query *)target_query->utilityStmt; + } + + if (IsA(target_query, DeclareCursorStmt)) + { + DeclareCursorStmt *stmt = (DeclareCursorStmt *)target_query; + Query *query = (Query *)stmt->query; + + /* the target must be CMD_SELECT in this case */ + Assert(IsA(query, Query) && query->commandType == CMD_SELECT); + target_query = query; + } + + if (IsA(target_query, CreateTableAsStmt)) + { + CreateTableAsStmt *stmt = (CreateTableAsStmt *) target_query; + + Assert(IsA(stmt->query, Query)); + target_query = (Query *) stmt->query; + + /* strip out the top-level query for further processing */ + if (target_query->commandType == CMD_UTILITY && + target_query->utilityStmt != NULL) + target_query = (Query *)target_query->utilityStmt; + } + + if (IsA(target_query, ExecuteStmt)) + { + /* + * Use the prepared query for EXECUTE. The Query for jumble + * also replaced with the corresponding one. + */ + ExecuteStmt *stmt = (ExecuteStmt *)target_query; + PreparedStatement *entry; + + entry = FetchPreparedStatement(stmt->name, true); + p = entry->plansource->query_string; + target_query = (Query *) linitial (entry->plansource->query_list); + } + + /* JumbleQuery accespts only a non-utility Query */ + if (!IsA(target_query, Query) || + target_query->utilityStmt != NULL) + target_query = NULL; + + if (jumblequery) + *jumblequery = target_query; + } + /* + * Return NULL if pstate is not of top-level query. We don't need this + * when jumble info is not requested or cannot do this when pstate is NULL. + */ + else if (!jumblequery && pstate && pstate->p_sourcetext != p && + strcmp(pstate->p_sourcetext, p) != 0) + p = NULL; + + return p; +} + +/* + * Get hints from the head block comment in client-supplied query string. + */ +static const char * +get_hints_from_comment(const char *p) +{ + const char *hint_head; + char *head; + char *tail; + int len; if (p == NULL) return NULL; @@ -1469,8 +1977,28 @@ parse_head_comment(Query *parse) head[len] = '\0'; p = head; + return p; +} + +/* + * Parse hints that got, create hint struct from parse tree and parse hints. + */ +static HintState * +create_hintstate(Query *parse, const char *hints) +{ + const char *p; + int i; + HintState *hstate; + + if (hints == NULL) + return NULL; + + /* -1 means that no Parallel hint is specified. */ + max_hint_nworkers = -1; + + p = hints; hstate = HintStateCreate(); - hstate->hint_str = head; + hstate->hint_str = (char *) hints; /* parse each hint. */ parse_hints(hstate, parse, p); @@ -1495,7 +2023,7 @@ parse_head_comment(Query *parse) /* * If an object (or a set of objects) has multiple hints of same hint-type, - * only the last hint is valid and others are igonred in planning. + * only the last hint is valid and others are ignored in planning. * Hints except the last are marked as 'duplicated' to remember the order. */ for (i = 0; i < hstate->nall_hints - 1; i++) @@ -1533,6 +2061,10 @@ parse_head_comment(Query *parse) hstate->num_hints[HINT_TYPE_JOIN_METHOD]); hstate->set_hints = (SetHint **) (hstate->leading_hint + hstate->num_hints[HINT_TYPE_LEADING]); + hstate->rows_hints = (RowsHint **) (hstate->set_hints + + hstate->num_hints[HINT_TYPE_SET]); + hstate->parallel_hints = (ParallelHint **) (hstate->set_hints + + hstate->num_hints[HINT_TYPE_ROWS]); return hstate; } @@ -1554,33 +2086,24 @@ ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse, /* Parse relation name and index name(s) if given hint accepts. */ length = list_length(name_list); - if (length > 0) - { - hint->relname = linitial(name_list); - hint->indexnames = list_delete_first(name_list); - - /* check whether the hint accepts index name(s). */ - if (length != 1 && - hint_keyword != HINT_KEYWORD_INDEXSCAN && - hint_keyword != HINT_KEYWORD_INDEXSCANREGEXP && -#if PG_VERSION_NUM >= 90200 - hint_keyword != HINT_KEYWORD_INDEXONLYSCAN && - hint_keyword != HINT_KEYWORD_INDEXONLYSCANREGEXP && -#endif - hint_keyword != HINT_KEYWORD_BITMAPSCAN && - hint_keyword != HINT_KEYWORD_BITMAPSCANREGEXP) - { - hint_ereport(str, - ("%s hint accepts only one relation.", - hint->base.keyword)); - hint->base.state = HINT_STATE_ERROR; - return str; - } + + /* at least twp parameters required */ + if (length < 1) + { + hint_ereport(str, + ("%s hint requires a relation.", hint->base.keyword)); + hint->base.state = HINT_STATE_ERROR; + return str; } - else + + hint->relname = linitial(name_list); + hint->indexnames = list_delete_first(name_list); + + /* check whether the hint accepts index name(s) */ + if (length > 1 && !SCAN_HINT_ACCEPTS_INDEX_NAMES(hint_keyword)) { hint_ereport(str, - ("%s hint requires a relation.", + ("%s hint accepts only one relation.", hint->base.keyword)); hint->base.state = HINT_STATE_ERROR; return str; @@ -1621,7 +2144,6 @@ ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse, case HINT_KEYWORD_NOTIDSCAN: hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_TIDSCAN; break; -#if PG_VERSION_NUM >= 90200 case HINT_KEYWORD_INDEXONLYSCAN: hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN; break; @@ -1632,7 +2154,6 @@ ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse, case HINT_KEYWORD_NOINDEXONLYSCAN: hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXONLYSCAN; break; -#endif default: hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword)); return NULL; @@ -1828,12 +2349,216 @@ SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str) return str; } +static const char * +RowsHintParse(RowsHint *hint, HintState *hstate, Query *parse, + const char *str) +{ + HintKeyword hint_keyword = hint->base.hint_keyword; + List *name_list = NIL; + char *rows_str; + char *end_ptr; + + if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL) + return NULL; + + /* Last element must be rows specification */ + hint->nrels = list_length(name_list) - 1; + + if (hint->nrels > 0) + { + ListCell *l; + int i = 0; + + /* + * Transform relation names from list to array to sort them with qsort + * after. + */ + hint->relnames = palloc(sizeof(char *) * hint->nrels); + foreach (l, name_list) + { + if (hint->nrels <= i) + break; + hint->relnames[i] = lfirst(l); + i++; + } + } + + /* Retieve rows estimation */ + rows_str = list_nth(name_list, hint->nrels); + hint->rows_str = rows_str; /* store as-is for error logging */ + if (rows_str[0] == '#') + { + hint->value_type = RVT_ABSOLUTE; + rows_str++; + } + else if (rows_str[0] == '+') + { + hint->value_type = RVT_ADD; + rows_str++; + } + else if (rows_str[0] == '-') + { + hint->value_type = RVT_SUB; + rows_str++; + } + else if (rows_str[0] == '*') + { + hint->value_type = RVT_MULTI; + rows_str++; + } + else + { + hint_ereport(rows_str, ("Unrecognized rows value type notation.")); + hint->base.state = HINT_STATE_ERROR; + return str; + } + hint->rows = strtod(rows_str, &end_ptr); + if (*end_ptr) + { + hint_ereport(rows_str, + ("%s hint requires valid number as rows estimation.", + hint->base.keyword)); + hint->base.state = HINT_STATE_ERROR; + return str; + } + + /* A join hint requires at least two relations */ + if (hint->nrels < 2) + { + hint_ereport(str, + ("%s hint requires at least two relations.", + hint->base.keyword)); + hint->base.state = HINT_STATE_ERROR; + return str; + } + + list_free(name_list); + + /* Sort relnames in alphabetical order. */ + qsort(hint->relnames, hint->nrels, sizeof(char *), RelnameCmp); + + return str; +} + +static const char * +ParallelHintParse(ParallelHint *hint, HintState *hstate, Query *parse, + const char *str) +{ + HintKeyword hint_keyword = hint->base.hint_keyword; + List *name_list = NIL; + int length; + char *end_ptr; + int nworkers; + bool force_parallel = false; + + if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL) + return NULL; + + /* Parse relation name and index name(s) if given hint accepts. */ + length = list_length(name_list); + + if (length < 2 || length > 3) + { + hint_ereport(")", + ("wrong number of arguments (%d): %s", + length, hint->base.keyword)); + hint->base.state = HINT_STATE_ERROR; + return str; + } + + hint->relname = linitial(name_list); + + /* The second parameter is number of workers */ + hint->nworkers_str = list_nth(name_list, 1); + nworkers = strtod(hint->nworkers_str, &end_ptr); + if (*end_ptr || nworkers < 0 || nworkers > max_worker_processes) + { + if (*end_ptr) + hint_ereport(hint->nworkers_str, + ("number of workers must be a number: %s", + hint->base.keyword)); + else if (nworkers < 0) + hint_ereport(hint->nworkers_str, + ("number of workers must be positive: %s", + hint->base.keyword)); + else if (nworkers > max_worker_processes) + hint_ereport(hint->nworkers_str, + ("number of workers = %d is larger than max_worker_processes(%d): %s", + nworkers, max_worker_processes, hint->base.keyword)); + + hint->base.state = HINT_STATE_ERROR; + } + + hint->nworkers = nworkers; + + /* optional third parameter is specified */ + if (length == 3) + { + const char *modeparam = (const char *)list_nth(name_list, 2); + if (pg_strcasecmp(modeparam, "hard") == 0) + force_parallel = true; + else if (pg_strcasecmp(modeparam, "soft") != 0) + { + hint_ereport(modeparam, + ("enforcement must be soft or hard: %s", + hint->base.keyword)); + hint->base.state = HINT_STATE_ERROR; + } + } + + hint->force_parallel = force_parallel; + + if (hint->base.state != HINT_STATE_ERROR && + nworkers > max_hint_nworkers) + max_hint_nworkers = nworkers; + + return str; +} + /* * set GUC parameter functions */ static int -set_config_option_wrapper(const char *name, const char *value, +get_current_scan_mask() +{ + int mask = 0; + + if (enable_seqscan) + mask |= ENABLE_SEQSCAN; + if (enable_indexscan) + mask |= ENABLE_INDEXSCAN; + if (enable_bitmapscan) + mask |= ENABLE_BITMAPSCAN; + if (enable_tidscan) + mask |= ENABLE_TIDSCAN; + if (enable_indexonlyscan) + mask |= ENABLE_INDEXONLYSCAN; + + return mask; +} + +static int +get_current_join_mask() +{ + int mask = 0; + + if (enable_nestloop) + mask |= ENABLE_NESTLOOP; + if (enable_mergejoin) + mask |= ENABLE_MERGEJOIN; + if (enable_hashjoin) + mask |= ENABLE_HASHJOIN; + + return mask; +} + +/* + * Sets GUC prameters without throwing exception. Reutrns false if something + * wrong. + */ +static int +set_config_option_noerror(const char *name, const char *value, GucContext context, GucSource source, GucAction action, bool changeVal, int elevel) { @@ -1842,13 +2567,8 @@ set_config_option_wrapper(const char *name, const char *value, PG_TRY(); { -#if PG_VERSION_NUM >= 90200 result = set_config_option(name, value, context, source, - action, changeVal, 0); -#else - result = set_config_option(name, value, context, source, - action, changeVal); -#endif + action, changeVal, 0, false); } PG_CATCH(); { @@ -1859,10 +2579,12 @@ set_config_option_wrapper(const char *name, const char *value, errdata = CopyErrorData(); FlushErrorState(); - ereport(elevel, (errcode(errdata->sqlerrcode), - errmsg("%s", errdata->message), - errdata->detail ? errdetail("%s", errdata->detail) : 0, - errdata->hint ? errhint("%s", errdata->hint) : 0)); + ereport(elevel, + (errcode(errdata->sqlerrcode), + errmsg("%s", errdata->message), + errdata->detail ? errdetail("%s", errdata->detail) : 0, + errdata->hint ? errhint("%s", errdata->hint) : 0)); + msgqno = qno; FreeErrorData(errdata); } PG_END_TRY(); @@ -1870,13 +2592,33 @@ set_config_option_wrapper(const char *name, const char *value, return result; } +/* + * Sets GUC parameter of int32 type without throwing exceptions. Returns false + * if something wrong. + */ static int -set_config_options(SetHint **options, int noptions, GucContext context) +set_config_int32_option(const char *name, int32 value, GucContext context) { - int i; - int save_nestlevel; + char buf[16]; /* enough for int32 */ - save_nestlevel = NewGUCNestLevel(); + if (snprintf(buf, 16, "%d", value) < 0) + { + ereport(pg_hint_plan_parse_message_level, + (errmsg ("Failed to convert integer to string: %d", value))); + return false; + } + + return + set_config_option_noerror(name, buf, context, + PGC_S_SESSION, GUC_ACTION_SAVE, true, + pg_hint_plan_parse_message_level); +} + +/* setup scan method enforcement according to given options */ +static void +setup_guc_enforcement(SetHint **options, int noptions, GucContext context) +{ + int i; for (i = 0; i < noptions; i++) { @@ -1886,45 +2628,97 @@ set_config_options(SetHint **options, int noptions, GucContext context) if (!hint_state_enabled(hint)) continue; - result = set_config_option_wrapper(hint->name, hint->value, context, + result = set_config_option_noerror(hint->name, hint->value, context, PGC_S_SESSION, GUC_ACTION_SAVE, true, - pg_hint_plan_parse_messages); + pg_hint_plan_parse_message_level); if (result != 0) hint->base.state = HINT_STATE_USED; else hint->base.state = HINT_STATE_ERROR; } - return save_nestlevel; + return; +} + +/* + * Setup parallel execution environment. + * + * If hint is not NULL, set up using it, elsewise reset to initial environment. + */ +static void +setup_parallel_plan_enforcement(ParallelHint *hint, HintState *state) +{ + if (hint) + { + hint->base.state = HINT_STATE_USED; + set_config_int32_option("max_parallel_workers_per_gather", + hint->nworkers, state->context); + } + else + set_config_int32_option("max_parallel_workers_per_gather", + state->init_nworkers, state->context); + + /* force means that enforce parallel as far as possible */ + if (hint && hint->force_parallel && hint->nworkers > 0) + { + set_config_int32_option("parallel_tuple_cost", 0, state->context); + set_config_int32_option("parallel_setup_cost", 0, state->context); + set_config_int32_option("min_parallel_table_scan_size", 0, + state->context); + set_config_int32_option("min_parallel_index_scan_size", 0, + state->context); + } + else + { + set_config_int32_option("parallel_tuple_cost", + state->init_paratup_cost, state->context); + set_config_int32_option("parallel_setup_cost", + state->init_parasetup_cost, state->context); + set_config_int32_option("min_parallel_table_scan_size", + state->init_min_para_tablescan_size, + state->context); + set_config_int32_option("min_parallel_index_scan_size", + state->init_min_para_indexscan_size, + state->context); + } } #define SET_CONFIG_OPTION(name, type_bits) \ - set_config_option_wrapper((name), \ + set_config_option_noerror((name), \ (mask & (type_bits)) ? "true" : "false", \ context, PGC_S_SESSION, GUC_ACTION_SAVE, true, ERROR) + +/* + * Setup GUC environment to enforce scan methods. If scanhint is NULL, reset + * GUCs to the saved state in state. + */ static void -set_scan_config_options(unsigned char enforce_mask, GucContext context) +setup_scan_method_enforcement(ScanMethodHint *scanhint, HintState *state) { + unsigned char enforce_mask = state->init_scan_mask; + GucContext context = state->context; unsigned char mask; + if (scanhint) + { + enforce_mask = scanhint->enforce_mask; + scanhint->base.state = HINT_STATE_USED; + } + if (enforce_mask == ENABLE_SEQSCAN || enforce_mask == ENABLE_INDEXSCAN || enforce_mask == ENABLE_BITMAPSCAN || enforce_mask == ENABLE_TIDSCAN -#if PG_VERSION_NUM >= 90200 || enforce_mask == (ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN) -#endif ) mask = enforce_mask; else - mask = enforce_mask & current_hint->init_scan_mask; + mask = enforce_mask & current_hint_state->init_scan_mask; SET_CONFIG_OPTION("enable_seqscan", ENABLE_SEQSCAN); SET_CONFIG_OPTION("enable_indexscan", ENABLE_INDEXSCAN); SET_CONFIG_OPTION("enable_bitmapscan", ENABLE_BITMAPSCAN); SET_CONFIG_OPTION("enable_tidscan", ENABLE_TIDSCAN); -#if PG_VERSION_NUM >= 90200 SET_CONFIG_OPTION("enable_indexonlyscan", ENABLE_INDEXONLYSCAN); -#endif } static void @@ -1936,7 +2730,7 @@ set_join_config_options(unsigned char enforce_mask, GucContext context) enforce_mask == ENABLE_HASHJOIN) mask = enforce_mask; else - mask = enforce_mask & current_hint->init_join_mask; + mask = enforce_mask & current_hint_state->init_join_mask; SET_CONFIG_OPTION("enable_nestloop", ENABLE_NESTLOOP); SET_CONFIG_OPTION("enable_mergejoin", ENABLE_MERGEJOIN); @@ -1944,145 +2738,250 @@ set_join_config_options(unsigned char enforce_mask, GucContext context) } /* - * pg_hint_plan hook functions + * Push a hint into hint stack which is implemented with List struct. Head of + * list is top of stack. */ - static void -pg_hint_plan_ProcessUtility(Node *parsetree, const char *queryString, - ParamListInfo params, bool isTopLevel, - DestReceiver *dest, char *completionTag) +push_hint(HintState *hstate) { - Node *node; + /* Prepend new hint to the list means pushing to stack. */ + HintStateStack = lcons(hstate, HintStateStack); - if (!pg_hint_plan_enable_hint) - { - if (prev_ProcessUtility) - (*prev_ProcessUtility) (parsetree, queryString, params, - isTopLevel, dest, completionTag); - else - standard_ProcessUtility(parsetree, queryString, params, - isTopLevel, dest, completionTag); + /* Pushed hint is the one which should be used hereafter. */ + current_hint_state = hstate; +} - return; - } +/* Pop a hint from hint stack. Popped hint is automatically discarded. */ +static void +pop_hint(void) +{ + /* Hint stack must not be empty. */ + if(HintStateStack == NIL) + elog(ERROR, "hint stack is empty"); - node = parsetree; - if (IsA(node, ExplainStmt)) - { - /* - * Draw out parse tree of actual query from Query struct of EXPLAIN - * statement. - */ - ExplainStmt *stmt; - Query *query; + /* + * Take a hint at the head from the list, and free it. Switch + * current_hint_state to point new head (NULL if the list is empty). + */ + HintStateStack = list_delete_first(HintStateStack); + HintStateDelete(current_hint_state); + if(HintStateStack == NIL) + current_hint_state = NULL; + else + current_hint_state = (HintState *) lfirst(list_head(HintStateStack)); +} - stmt = (ExplainStmt *) node; +/* + * Retrieve and store hint string from given query or from the hint table. + */ +static void +get_current_hint_string(ParseState *pstate, Query *query) +{ + const char *query_str; + MemoryContext oldcontext; - Assert(IsA(stmt->query, Query)); - query = (Query *) stmt->query; + /* do nothing under hint table search */ + if (hint_inhibit_level > 0) + return; - if (query->commandType == CMD_UTILITY && query->utilityStmt != NULL) - node = query->utilityStmt; - } + /* We alredy have one, don't parse it again. */ + if (current_hint_retrieved) + return; - /* - * If the query was a EXECUTE or CREATE TABLE AS EXECUTE, get query string - * specified to preceding PREPARE command to use it as source of hints. - */ - if (IsA(node, ExecuteStmt)) - { - ExecuteStmt *stmt; + /* Don't parse the current query hereafter */ + current_hint_retrieved = true; - stmt = (ExecuteStmt *) node; - stmt_name = stmt->name; - } -#if PG_VERSION_NUM >= 90200 - /* - * CREATE AS EXECUTE behavior has changed since 9.2, so we must handle it - * specially here. - */ - if (IsA(node, CreateTableAsStmt)) + if (!pg_hint_plan_enable_hint) { - CreateTableAsStmt *stmt; - Query *query; - - stmt = (CreateTableAsStmt *) node; - Assert(IsA(stmt->query, Query)); - query = (Query *) stmt->query; - - if (query->commandType == CMD_UTILITY && - IsA(query->utilityStmt, ExecuteStmt)) + if (current_hint_str) { - ExecuteStmt *estmt = (ExecuteStmt *) query->utilityStmt; - stmt_name = estmt->name; + pfree((void *)current_hint_str); + current_hint_str = NULL; } + return; } -#endif - if (stmt_name) + + /* increment the query number */ + qnostr[0] = 0; + if (debug_level > 1) + snprintf(qnostr, sizeof(qnostr), "[qno=0x%x]", qno++); + qno++; + + /* search the hint table for a hint if requested */ + if (pg_hint_plan_enable_hint_table) { - PG_TRY(); + int query_len; + pgssJumbleState jstate; + Query *jumblequery; + char *normalized_query = NULL; + + query_str = get_query_string(pstate, query, &jumblequery); + + /* If this query is not for hint, just return */ + if (!query_str) + return; + + /* clear the previous hint string */ + if (current_hint_str) { - if (prev_ProcessUtility) - (*prev_ProcessUtility) (parsetree, queryString, params, - isTopLevel, dest, completionTag); - else - standard_ProcessUtility(parsetree, queryString, params, - isTopLevel, dest, completionTag); + pfree((void *)current_hint_str); + current_hint_str = NULL; } - PG_CATCH(); + + if (jumblequery) { - stmt_name = NULL; - PG_RE_THROW(); + /* + * XXX: normalization code is copied from pg_stat_statements.c. + * Make sure to keep up-to-date with it. + */ + jstate.jumble = (unsigned char *) palloc(JUMBLE_SIZE); + jstate.jumble_len = 0; + jstate.clocations_buf_size = 32; + jstate.clocations = (pgssLocationLen *) + palloc(jstate.clocations_buf_size * sizeof(pgssLocationLen)); + jstate.clocations_count = 0; + + JumbleQuery(&jstate, jumblequery); + + /* + * Normalize the query string by replacing constants with '?' + */ + /* + * Search hint string which is stored keyed by query string + * and application name. The query string is normalized to allow + * fuzzy matching. + * + * Adding 1 byte to query_len ensures that the returned string has + * a terminating NULL. + */ + query_len = strlen(query_str) + 1; + normalized_query = + generate_normalized_query(&jstate, query_str, + query->stmt_location, + &query_len, + GetDatabaseEncoding()); + + /* + * find a hint for the normalized query. the result should be in + * TopMemoryContext + */ + oldcontext = MemoryContextSwitchTo(TopMemoryContext); + current_hint_str = + get_hints_from_table(normalized_query, application_name); + MemoryContextSwitchTo(oldcontext); + + if (debug_level > 1) + { + if (current_hint_str) + ereport(pg_hint_plan_debug_message_level, + (errmsg("pg_hint_plan[qno=0x%x]: " + "post_parse_analyze_hook: " + "hints from table: \"%s\": " + "normalized_query=\"%s\", " + "application name =\"%s\"", + qno, current_hint_str, + normalized_query, application_name), + errhidestmt(msgqno != qno), + errhidecontext(msgqno != qno))); + else + ereport(pg_hint_plan_debug_message_level, + (errmsg("pg_hint_plan[qno=0x%x]: " + "no match found in table: " + "application name = \"%s\", " + "normalized_query=\"%s\"", + qno, application_name, + normalized_query), + errhidestmt(msgqno != qno), + errhidecontext(msgqno != qno))); + + msgqno = qno; + } } - PG_END_TRY(); - stmt_name = NULL; + /* retrun if we have hint here */ + if (current_hint_str) + return; + } + else + query_str = get_query_string(pstate, query, NULL); - return; + if (query_str) + { + /* + * get hints from the comment. However we may have the same query + * string with the previous call, but the extra comparison seems no + * use.. + */ + if (current_hint_str) + pfree((void *)current_hint_str); + + oldcontext = MemoryContextSwitchTo(TopMemoryContext); + current_hint_str = get_hints_from_comment(query_str); + MemoryContextSwitchTo(oldcontext); } - if (prev_ProcessUtility) - (*prev_ProcessUtility) (parsetree, queryString, params, - isTopLevel, dest, completionTag); - else - standard_ProcessUtility(parsetree, queryString, params, - isTopLevel, dest, completionTag); + if (debug_level > 1) + { + if (debug_level == 1 && query_str && debug_query_string && + strcmp(query_str, debug_query_string)) + ereport(pg_hint_plan_debug_message_level, + (errmsg("hints in comment=\"%s\"", + current_hint_str ? current_hint_str : "(none)"), + errhidestmt(msgqno != qno), + errhidecontext(msgqno != qno))); + else + ereport(pg_hint_plan_debug_message_level, + (errmsg("hints in comment=\"%s\", query=\"%s\", debug_query_string=\"%s\"", + current_hint_str ? current_hint_str : "(none)", + query_str ? query_str : "(none)", + debug_query_string ? debug_query_string : "(none)"), + errhidestmt(msgqno != qno), + errhidecontext(msgqno != qno))); + msgqno = qno; + } } /* - * Push a hint into hint stack which is implemented with List struct. Head of - * list is top of stack. + * Retrieve hint string from the current query. */ static void -push_hint(HintState *hstate) +pg_hint_plan_post_parse_analyze(ParseState *pstate, Query *query) { - /* Prepend new hint to the list means pushing to stack. */ - HintStateStack = lcons(hstate, HintStateStack); + if (prev_post_parse_analyze_hook) + prev_post_parse_analyze_hook(pstate, query); - /* Pushed hint is the one which should be used hereafter. */ - current_hint = hstate; + /* always retrieve hint from the top-level query string */ + if (plpgsql_recurse_level == 0) + current_hint_retrieved = false; + + get_current_hint_string(pstate, query); } -/* Pop a hint from hint stack. Popped hint is automatically discarded. */ +/* + * We need to reset current_hint_retrieved flag always when a command execution + * is finished. This is true even for a pure utility command that doesn't + * involve planning phase. + */ static void -pop_hint(void) +pg_hint_plan_ProcessUtility(PlannedStmt *pstmt, const char *queryString, + ProcessUtilityContext context, + ParamListInfo params, QueryEnvironment *queryEnv, + DestReceiver *dest, char *completionTag) { - /* Hint stack must not be empty. */ - if(HintStateStack == NIL) - elog(ERROR, "hint stack is empty"); - - /* - * Take a hint at the head from the list, and free it. Switch current_hint - * to point new head (NULL if the list is empty). - */ - HintStateStack = list_delete_first(HintStateStack); - HintStateDelete(current_hint); - if(HintStateStack == NIL) - current_hint = NULL; + if (prev_ProcessUtility_hook) + prev_ProcessUtility_hook(pstmt, queryString, context, params, queryEnv, + dest, completionTag); else - current_hint = (HintState *) lfirst(list_head(HintStateStack)); + standard_ProcessUtility(pstmt, queryString, context, params, queryEnv, + dest, completionTag); + + if (plpgsql_recurse_level == 0) + current_hint_retrieved = false; } +/* + * Read and set up hint information + */ static PlannedStmt * pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams) { @@ -2091,77 +2990,101 @@ pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams) HintState *hstate; /* - * Use standard planner if pg_hint_plan is disabled. Other hook functions - * try to change plan with current_hint if any, so set it to NULL. + * Use standard planner if pg_hint_plan is disabled or current nesting + * depth is nesting depth of SPI calls. Other hook functions try to change + * plan with current_hint_state if any, so set it to NULL. */ - if (!pg_hint_plan_enable_hint) + if (!pg_hint_plan_enable_hint || hint_inhibit_level > 0) { - current_hint = NULL; - - if (prev_planner) - return (*prev_planner) (parse, cursorOptions, boundParams); - else - return standard_planner(parse, cursorOptions, boundParams); + if (debug_level > 1) + ereport(pg_hint_plan_debug_message_level, + (errmsg ("pg_hint_plan%s: planner: enable_hint=%d," + " hint_inhibit_level=%d", + qnostr, pg_hint_plan_enable_hint, + hint_inhibit_level), + errhidestmt(msgqno != qno))); + msgqno = qno; + + goto standard_planner_proc; } /* - *search hint. - * TODO: replace "app1" with current application_name setting of the - * session. - * XXX: use something instead of debug_query_string? + * Support for nested plpgsql functions. This is quite ugly but this is the + * only point I could find where I can get the query string. */ - search_hints(search_query, debug_query_string, "app1"); + if (plpgsql_recurse_level > 0) + { + MemoryContext oldcontext; - /* Create hint struct from parse tree. */ - hstate = parse_head_comment(parse); + if (current_hint_str) + pfree((void *)current_hint_str); + + oldcontext = MemoryContextSwitchTo(TopMemoryContext); + current_hint_str = + get_hints_from_comment((char *)error_context_stack->arg); + MemoryContextSwitchTo(oldcontext); + } /* - * Use standard planner if the statement has not valid hint. Other hook - * functions try to change plan with current_hint if any, so set it to - * NULL. + * Query execution in extended protocol can be started without the analyze + * phase. In the case retrieve hint string here. */ - if (!hstate) - { - current_hint = NULL; + if (!current_hint_str) + get_current_hint_string(NULL, parse); - if (prev_planner) - return (*prev_planner) (parse, cursorOptions, boundParams); - else - return standard_planner(parse, cursorOptions, boundParams); - } + /* No hint, go the normal way */ + if (!current_hint_str) + goto standard_planner_proc; + /* parse the hint into hint state struct */ + hstate = create_hintstate(parse, pstrdup(current_hint_str)); + + /* run standard planner if the statement has not valid hint */ + if (!hstate) + goto standard_planner_proc; + /* * Push new hint struct to the hint stack to disable previous hint context. */ push_hint(hstate); - /* Set GUC parameters which are specified with Set hint. */ - save_nestlevel = set_config_options(current_hint->set_hints, - current_hint->num_hints[HINT_TYPE_SET], - current_hint->context); + /* Set scan enforcement here. */ + save_nestlevel = NewGUCNestLevel(); - if (enable_seqscan) - current_hint->init_scan_mask |= ENABLE_SEQSCAN; - if (enable_indexscan) - current_hint->init_scan_mask |= ENABLE_INDEXSCAN; - if (enable_bitmapscan) - current_hint->init_scan_mask |= ENABLE_BITMAPSCAN; - if (enable_tidscan) - current_hint->init_scan_mask |= ENABLE_TIDSCAN; -#if PG_VERSION_NUM >= 90200 - if (enable_indexonlyscan) - current_hint->init_scan_mask |= ENABLE_INDEXONLYSCAN; -#endif - if (enable_nestloop) - current_hint->init_join_mask |= ENABLE_NESTLOOP; - if (enable_mergejoin) - current_hint->init_join_mask |= ENABLE_MERGEJOIN; - if (enable_hashjoin) - current_hint->init_join_mask |= ENABLE_HASHJOIN; + /* Apply Set hints, then save it as the initial state */ + setup_guc_enforcement(current_hint_state->set_hints, + current_hint_state->num_hints[HINT_TYPE_SET], + current_hint_state->context); + + current_hint_state->init_scan_mask = get_current_scan_mask(); + current_hint_state->init_join_mask = get_current_join_mask(); + current_hint_state->init_min_para_tablescan_size = + min_parallel_table_scan_size; + current_hint_state->init_min_para_indexscan_size = + min_parallel_index_scan_size; + current_hint_state->init_paratup_cost = parallel_tuple_cost; + current_hint_state->init_parasetup_cost = parallel_setup_cost; /* - * Use PG_TRY mechanism to recover GUC parameters and current_hint to the - * state when this planner started when error occurred in planner. + * max_parallel_workers_per_gather should be non-zero here if Workers hint + * is specified. + */ + if (max_hint_nworkers > 0 && max_parallel_workers_per_gather < 1) + set_config_int32_option("max_parallel_workers_per_gather", + 1, current_hint_state->context); + current_hint_state->init_nworkers = max_parallel_workers_per_gather; + + if (debug_level > 1) + { + ereport(pg_hint_plan_debug_message_level, + (errhidestmt(msgqno != qno), + errmsg("pg_hint_plan%s: planner", qnostr))); + msgqno = qno; + } + + /* + * Use PG_TRY mechanism to recover GUC parameters and current_hint_state to + * the state when this planner started when error occurred in planner. */ PG_TRY(); { @@ -2182,9 +3105,22 @@ pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams) } PG_END_TRY(); + + /* + * current_hint_str is useless after planning of the top-level query. + */ + if (plpgsql_recurse_level < 1 && current_hint_str) + { + pfree((void *)current_hint_str); + current_hint_str = NULL; + current_hint_retrieved = false; + } + /* Print hint in debug mode. */ - if (pg_hint_plan_debug_print) - HintStateDump(current_hint); + if (debug_level == 1) + HintStateDump(current_hint_state); + else if (debug_level > 1) + HintStateDump2(current_hint_state); /* * Rollback changes of GUC parameters, and pop current hint context from @@ -2194,45 +3130,165 @@ pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams) pop_hint(); return result; + +standard_planner_proc: + if (debug_level > 1) + { + ereport(pg_hint_plan_debug_message_level, + (errhidestmt(msgqno != qno), + errmsg("pg_hint_plan%s: planner: no valid hint", + qnostr))); + msgqno = qno; + } + current_hint_state = NULL; + if (prev_planner) + return (*prev_planner) (parse, cursorOptions, boundParams); + else + return standard_planner(parse, cursorOptions, boundParams); } /* - * Return scan method hint which matches given aliasname. + * Find scan method hint to be applied to the given relation + * */ static ScanMethodHint * -find_scan_hint(PlannerInfo *root, RelOptInfo *rel) +find_scan_hint(PlannerInfo *root, Index relid) { + RelOptInfo *rel; RangeTblEntry *rte; + ScanMethodHint *real_name_hint = NULL; + ScanMethodHint *alias_hint = NULL; int i; + /* This should not be a join rel */ + Assert(relid > 0); + rel = root->simple_rel_array[relid]; + /* - * We can't apply scan method hint if the relation is: - * - not a base relation - * - not an ordinary relation (such as join and subquery) + * This function is called for any RelOptInfo or its inheritance parent if + * any. If we are called from inheritance planner, the RelOptInfo for the + * parent of target child relation is not set in the planner info. + * + * Otherwise we should check that the reloptinfo is base relation or + * inheritance children. */ - if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION) + if (rel && + rel->reloptkind != RELOPT_BASEREL && + rel->reloptkind != RELOPT_OTHER_MEMBER_REL) return NULL; - rte = root->simple_rte_array[rel->relid]; + /* + * This is baserel or appendrel children. We can refer to RangeTblEntry. + */ + rte = root->simple_rte_array[relid]; + Assert(rte); - /* We can't force scan method of foreign tables */ - if (rte->relkind == RELKIND_FOREIGN_TABLE) + /* We don't hint on other than relation and foreign tables */ + if (rte->rtekind != RTE_RELATION || + rte->relkind == RELKIND_FOREIGN_TABLE) return NULL; /* Find scan method hint, which matches given names, from the list. */ - for (i = 0; i < current_hint->num_hints[HINT_TYPE_SCAN_METHOD]; i++) + for (i = 0; i < current_hint_state->num_hints[HINT_TYPE_SCAN_METHOD]; i++) { - ScanMethodHint *hint = current_hint->scan_hints[i]; + ScanMethodHint *hint = current_hint_state->scan_hints[i]; /* We ignore disabled hints. */ if (!hint_state_enabled(hint)) continue; - if (RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0) - return hint; + if (!alias_hint && + RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0) + alias_hint = hint; + + /* check the real name for appendrel children */ + if (!real_name_hint && + rel && rel->reloptkind == RELOPT_OTHER_MEMBER_REL) + { + char *realname = get_rel_name(rte->relid); + + if (realname && RelnameCmp(&realname, &hint->relname) == 0) + real_name_hint = hint; + } + + /* No more match expected, break */ + if(alias_hint && real_name_hint) + break; } - return NULL; + /* real name match precedes alias match */ + if (real_name_hint) + return real_name_hint; + + return alias_hint; +} + +static ParallelHint * +find_parallel_hint(PlannerInfo *root, Index relid) +{ + RelOptInfo *rel; + RangeTblEntry *rte; + ParallelHint *real_name_hint = NULL; + ParallelHint *alias_hint = NULL; + int i; + + /* This should not be a join rel */ + Assert(relid > 0); + rel = root->simple_rel_array[relid]; + + /* + * Parallel planning is appliable only on base relation, which has + * RelOptInfo. + */ + if (!rel) + return NULL; + + /* + * We have set root->glob->parallelModeOK if needed. What we should do here + * is just following the decision of planner. + */ + if (!rel->consider_parallel) + return NULL; + + /* + * This is baserel or appendrel children. We can refer to RangeTblEntry. + */ + rte = root->simple_rte_array[relid]; + Assert(rte); + + /* Find parallel method hint, which matches given names, from the list. */ + for (i = 0; i < current_hint_state->num_hints[HINT_TYPE_PARALLEL]; i++) + { + ParallelHint *hint = current_hint_state->parallel_hints[i]; + + /* We ignore disabled hints. */ + if (!hint_state_enabled(hint)) + continue; + + if (!alias_hint && + RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0) + alias_hint = hint; + + /* check the real name for appendrel children */ + if (!real_name_hint && + rel && rel->reloptkind == RELOPT_OTHER_MEMBER_REL) + { + char *realname = get_rel_name(rte->relid); + + if (realname && RelnameCmp(&realname, &hint->relname) == 0) + real_name_hint = hint; + } + + /* No more match expected, break */ + if(alias_hint && real_name_hint) + break; + } + + /* real name match precedes alias match */ + if (real_name_hint) + return real_name_hint; + + return alias_hint; } /* @@ -2262,13 +3318,18 @@ regexpeq(const char *s1, const char *s2) return DatumGetBool(result); } + +/* Remove indexes instructed not to use by hint. */ static void -delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId) +restrict_indexes(PlannerInfo *root, ScanMethodHint *hint, RelOptInfo *rel, + bool using_parent_hint) { ListCell *cell; ListCell *prev; ListCell *next; StringInfoData buf; + RangeTblEntry *rte = root->simple_rte_array[rel->relid]; + Oid relationObjectId = rte->relid; /* * We delete all the IndexOptInfo list and prevent you from being usable by @@ -2295,7 +3356,7 @@ delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId) * other than it. */ prev = NULL; - if (pg_hint_plan_debug_print) + if (debug_level > 0) initStringInfo(&buf); for (cell = list_head(rel->indexlist); cell; cell = next) @@ -2320,7 +3381,7 @@ delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId) if (result) { use_index = true; - if (pg_hint_plan_debug_print) + if (debug_level > 0) { appendStringInfoCharMacro(&buf, ' '); quote_value(&buf, indexname); @@ -2331,84 +3392,75 @@ delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId) } /* - * to make the index a candidate when definition of this index is - * matched with the index's definition of current_hint. + * Apply index restriction of parent hint to children. Since index + * inheritance is not explicitly described we should search for an + * children's index with the same definition to that of the parent. */ - if (OidIsValid(relationObjectId) && !use_index) + if (using_parent_hint && !use_index) { - foreach(l, current_hint->parent_index_infos) + foreach(l, current_hint_state->parent_index_infos) { int i; HeapTuple ht_idx; ParentIndexInfo *p_info = (ParentIndexInfo *)lfirst(l); - /* check to match the parameter of unique */ - if (p_info->indisunique != info->unique) - continue; - - /* check to match the parameter of index's method */ - if (p_info->method != info->relam) - continue; - - /* to check to match the indexkey's configuration */ - if ((list_length(p_info->column_names)) != - info->ncolumns) + /* + * we check the 'same' index by comparing uniqueness, access + * method and index key columns. + */ + if (p_info->indisunique != info->unique || + p_info->method != info->relam || + list_length(p_info->column_names) != info->ncolumns) continue; - /* check to match the indexkey's configuration */ + /* Check if index key columns match */ for (i = 0; i < info->ncolumns; i++) { char *c_attname = NULL; char *p_attname = NULL; - p_attname = - list_nth(p_info->column_names, i); + p_attname = list_nth(p_info->column_names, i); - /* both are expressions */ + /* + * if both of the key of the same position are expressions, + * ignore them for now and check later. + */ if (info->indexkeys[i] == 0 && !p_attname) continue; - /* one's column is expression, the other is not */ + /* deny if one is expression while another is not */ if (info->indexkeys[i] == 0 || !p_attname) break; c_attname = get_attname(relationObjectId, - info->indexkeys[i]); - - if (strcmp(p_attname, c_attname) != 0) - break; - - if (p_info->indcollation[i] != info->indexcollations[i]) - break; - - if (p_info->opclass[i] != info->opcintype[i]) - break; - - if (((p_info->indoption[i] & INDOPTION_DESC) != 0) != - info->reverse_sort[i]) + info->indexkeys[i], false); + + /* deny if any of column attributes don't match */ + if (strcmp(p_attname, c_attname) != 0 || + p_info->indcollation[i] != info->indexcollations[i] || + p_info->opclass[i] != info->opcintype[i]|| + ((p_info->indoption[i] & INDOPTION_DESC) != 0) + != info->reverse_sort[i] || + ((p_info->indoption[i] & INDOPTION_NULLS_FIRST) != 0) + != info->nulls_first[i]) break; - - if (((p_info->indoption[i] & INDOPTION_NULLS_FIRST) != 0) != - info->nulls_first[i]) - break; - } + /* deny this if any difference found */ if (i != info->ncolumns) continue; + /* check on key expressions */ if ((p_info->expression_str && (info->indexprs != NIL)) || (p_info->indpred_str && (info->indpred != NIL))) { - /* - * Fetch the pg_index tuple by the Oid of the index - */ + /* fetch the index of this child */ ht_idx = SearchSysCache1(INDEXRELID, ObjectIdGetDatum(info->indexoid)); - /* check to match the expression's parameter of index */ + /* check expressions if both expressions are available */ if (p_info->expression_str && - !heap_attisnull(ht_idx, Anum_pg_index_indexprs)) + !heap_attisnull(ht_idx, Anum_pg_index_indexprs, NULL)) { Datum exprsDatum; bool isnull; @@ -2427,28 +3479,24 @@ delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId) ObjectIdGetDatum( relationObjectId)); + /* deny if expressions don't match */ if (strcmp(p_info->expression_str, text_to_cstring(DatumGetTextP(result))) != 0) { /* Clean up */ ReleaseSysCache(ht_idx); - continue; } } - /* Check to match the predicate's paraameter of index */ + /* compare index predicates */ if (p_info->indpred_str && - !heap_attisnull(ht_idx, Anum_pg_index_indpred)) + !heap_attisnull(ht_idx, Anum_pg_index_indpred, NULL)) { Datum predDatum; bool isnull; Datum result; - /* - * to change the predicate's parabeter of child's - * index to strings - */ predDatum = SysCacheGetAttr(INDEXRELID, ht_idx, Anum_pg_index_indpred, &isnull); @@ -2463,7 +3511,6 @@ delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId) { /* Clean up */ ReleaseSysCache(ht_idx); - continue; } } @@ -2479,7 +3526,7 @@ delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId) use_index = true; /* to log the candidate of index */ - if (pg_hint_plan_debug_print) + if (debug_level > 0) { appendStringInfoCharMacro(&buf, ' '); quote_value(&buf, indexname); @@ -2497,20 +3544,25 @@ delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId) pfree(indexname); } - if (pg_hint_plan_debug_print) + if (debug_level == 1) { - char *relname; StringInfoData rel_buf; + char *disprelname = ""; - if (OidIsValid(relationObjectId)) - relname = get_rel_name(relationObjectId); + /* + * If this hint targetted the parent, use the real name of this + * child. Otherwise use hint specification. + */ + if (using_parent_hint) + disprelname = get_rel_name(rte->relid); else - relname = hint->relname; + disprelname = hint->relname; + initStringInfo(&rel_buf); - quote_value(&rel_buf, relname); + quote_value(&rel_buf, disprelname); - ereport(LOG, + ereport(pg_hint_plan_debug_message_level, (errmsg("available indexes for %s(%s):%s", hint->base.keyword, rel_buf.data, @@ -2544,9 +3596,14 @@ get_parent_index_info(Oid indexoid, Oid relid) p_info->opclass = (Oid *) palloc(sizeof(Oid) * index->indnatts); p_info->indoption = (int16 *) palloc(sizeof(Oid) * index->indnatts); + /* + * Collect relation attribute names of index columns for index + * identification, not index attribute names. NULL means expression index + * columns. + */ for (i = 0; i < index->indnatts; i++) { - attname = get_attname(relid, index->indkey.values[i]); + attname = get_attname(relid, index->indkey.values[i], true); p_info->column_names = lappend(p_info->column_names, attname); p_info->indcollation[i] = indexRelation->rd_indcollation[i]; @@ -2555,10 +3612,11 @@ get_parent_index_info(Oid indexoid, Oid relid) } /* - * to check to match the expression's paraameter of index with child indexes + * to check to match the expression's parameter of index with child indexes */ p_info->expression_str = NULL; - if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indexprs)) + if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indexprs, + NULL)) { Datum exprsDatum; bool isnull; @@ -2575,10 +3633,11 @@ get_parent_index_info(Oid indexoid, Oid relid) } /* - * to check to match the predicate's paraameter of index with child indexes + * to check to match the predicate's parameter of index with child indexes */ p_info->indpred_str = NULL; - if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indpred)) + if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indpred, + NULL)) { Datum predDatum; bool isnull; @@ -2599,108 +3658,233 @@ get_parent_index_info(Oid indexoid, Oid relid) return p_info; } +/* + * cancel hint enforcement + */ static void -pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId, - bool inhparent, RelOptInfo *rel) +reset_hint_enforcement() { - ScanMethodHint *hint; + setup_scan_method_enforcement(NULL, current_hint_state); + setup_parallel_plan_enforcement(NULL, current_hint_state); +} - if (prev_get_relation_info) - (*prev_get_relation_info) (root, relationObjectId, inhparent, rel); +/* + * Set planner guc parameters according to corresponding scan hints. Returns + * bitmap of HintTypeBitmap. If shint or phint is not NULL, set used hint + * there respectively. + */ +static int +setup_hint_enforcement(PlannerInfo *root, RelOptInfo *rel, + ScanMethodHint **rshint, ParallelHint **rphint) +{ + Index new_parent_relid = 0; + ListCell *l; + ScanMethodHint *shint = NULL; + ParallelHint *phint = NULL; + bool inhparent = root->simple_rte_array[rel->relid]->inh; + Oid relationObjectId = root->simple_rte_array[rel->relid]->relid; + int ret = 0; - /* Do nothing if we don't have valid hint in this context. */ - if (!current_hint) - return; + /* reset returns if requested */ + if (rshint != NULL) *rshint = NULL; + if (rphint != NULL) *rphint = NULL; + /* + * We could register the parent relation of the following children here + * when inhparent == true but inheritnce planner doesn't call this function + * for parents. Since we cannot distinguish who called this function we + * cannot do other than always seeking the parent regardless of who called + * this function. + */ if (inhparent) { - /* store does relids of parent table. */ - current_hint->parent_relid = rel->relid; - current_hint->parent_rel_oid = relationObjectId; + /* set up only parallel hints for parent relation */ + phint = find_parallel_hint(root, rel->relid); + if (phint) + { + setup_parallel_plan_enforcement(phint, current_hint_state); + if (rphint) *rphint = phint; + ret |= HINT_BM_PARALLEL; + return ret; + } + + if (debug_level > 1) + ereport(pg_hint_plan_debug_message_level, + (errhidestmt(true), + errmsg ("pg_hint_plan%s: setup_hint_enforcement" + " skipping inh parent: relation=%u(%s), inhparent=%d," + " current_hint_state=%p, hint_inhibit_level=%d", + qnostr, relationObjectId, + get_rel_name(relationObjectId), + inhparent, current_hint_state, hint_inhibit_level))); + return 0; + } + + /* Forget about the parent of another subquery */ + if (root != current_hint_state->current_root) + current_hint_state->parent_relid = 0; + + /* Find the parent for this relation other than the registered parent */ + foreach (l, root->append_rel_list) + { + AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l); + + if (appinfo->child_relid == rel->relid) + { + if (current_hint_state->parent_relid != appinfo->parent_relid) + { + new_parent_relid = appinfo->parent_relid; + current_hint_state->current_root = root; + } + break; + } + } + + if (!l) + { + /* This relation doesn't have a parent. Cancel current_hint_state. */ + current_hint_state->parent_relid = 0; + current_hint_state->parent_scan_hint = NULL; + current_hint_state->parent_parallel_hint = NULL; } - else if (current_hint->parent_relid != 0) + + if (new_parent_relid > 0) { /* - * We use the same GUC parameter if this table is the child table of a - * table called pg_hint_plan_get_relation_info just before that. + * Here we found a new parent for the current relation. Scan continues + * hint to other childrens of this parent so remember it to avoid + * redundant setup cost. */ - ListCell *l; + current_hint_state->parent_relid = new_parent_relid; + + /* Find hints for the parent */ + current_hint_state->parent_scan_hint = + find_scan_hint(root, current_hint_state->parent_relid); - /* append_rel_list contains all append rels; ignore others */ - foreach(l, root->append_rel_list) + current_hint_state->parent_parallel_hint = + find_parallel_hint(root, current_hint_state->parent_relid); + + /* + * If hint is found for the parent, apply it for this child instead + * of its own. + */ + if (current_hint_state->parent_scan_hint) { - AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l); + ScanMethodHint * pshint = current_hint_state->parent_scan_hint; + + pshint->base.state = HINT_STATE_USED; + + /* Apply index mask in the same manner to the parent. */ + if (pshint->indexnames) + { + Oid parentrel_oid; + Relation parent_rel; + + parentrel_oid = + root->simple_rte_array[current_hint_state->parent_relid]->relid; + parent_rel = heap_open(parentrel_oid, NoLock); + + /* Search the parent relation for indexes match the hint spec */ + foreach(l, RelationGetIndexList(parent_rel)) + { + Oid indexoid = lfirst_oid(l); + char *indexname = get_rel_name(indexoid); + ListCell *lc; + ParentIndexInfo *parent_index_info; - /* This rel is child table. */ - if (appinfo->parent_relid == current_hint->parent_relid && - appinfo->child_relid == rel->relid) - { - if (current_hint->parent_hint) - delete_indexes(current_hint->parent_hint, rel, - relationObjectId); + foreach(lc, pshint->indexnames) + { + if (RelnameCmp(&indexname, &lfirst(lc)) == 0) + break; + } + if (!lc) + continue; - return; + parent_index_info = + get_parent_index_info(indexoid, parentrel_oid); + current_hint_state->parent_index_infos = + lappend(current_hint_state->parent_index_infos, + parent_index_info); + } + heap_close(parent_rel, NoLock); } } - - /* This rel is not inherit table. */ - current_hint->parent_relid = 0; - current_hint->parent_rel_oid = InvalidOid; - current_hint->parent_hint = NULL; } - /* - * If scan method hint was given, reset GUC parameters which control - * planner behavior about choosing scan methods. - */ - if ((hint = find_scan_hint(root, rel)) == NULL) - { - set_scan_config_options(current_hint->init_scan_mask, - current_hint->context); - return; - } - set_scan_config_options(hint->enforce_mask, current_hint->context); - hint->base.state = HINT_STATE_USED; + shint = find_scan_hint(root, rel->relid); + if (!shint) + shint = current_hint_state->parent_scan_hint; - if (inhparent) + if (shint) { - Relation relation; - List *indexoidlist; - ListCell *l; + bool using_parent_hint = + (shint == current_hint_state->parent_scan_hint); - current_hint->parent_hint = hint; + ret |= HINT_BM_SCAN_METHOD; - relation = heap_open(relationObjectId, NoLock); - indexoidlist = RelationGetIndexList(relation); + /* Setup scan enforcement environment */ + setup_scan_method_enforcement(shint, current_hint_state); - foreach(l, indexoidlist) + /* restrict unwanted inexes */ + restrict_indexes(root, shint, rel, using_parent_hint); + + if (debug_level > 1) { - Oid indexoid = lfirst_oid(l); - char *indexname = get_rel_name(indexoid); - bool use_index = false; - ListCell *lc; - ParentIndexInfo *parent_index_info; + char *additional_message = ""; + + if (shint == current_hint_state->parent_scan_hint) + additional_message = " by parent hint"; + + ereport(pg_hint_plan_debug_message_level, + (errhidestmt(true), + errmsg ("pg_hint_plan%s: setup_hint_enforcement" + " index deletion%s:" + " relation=%u(%s), inhparent=%d, " + "current_hint_state=%p," + " hint_inhibit_level=%d, scanmask=0x%x", + qnostr, additional_message, + relationObjectId, + get_rel_name(relationObjectId), + inhparent, current_hint_state, + hint_inhibit_level, + shint->enforce_mask))); + } + } - foreach(lc, hint->indexnames) - { - if (RelnameCmp(&indexname, &lfirst(lc)) == 0) - { - use_index = true; - break; - } - } - if (!use_index) - continue; + /* Do the same for parallel plan enforcement */ + phint = find_parallel_hint(root, rel->relid); + if (!phint) + phint = current_hint_state->parent_parallel_hint; - parent_index_info = get_parent_index_info(indexoid, - relationObjectId); - current_hint->parent_index_infos = - lappend(current_hint->parent_index_infos, parent_index_info); - } - heap_close(relation, NoLock); + setup_parallel_plan_enforcement(phint, current_hint_state); + + if (phint) + ret |= HINT_BM_PARALLEL; + + /* Nothing to apply. Reset the scan mask to intial state */ + if (!shint && ! phint) + { + if (debug_level > 1) + ereport(pg_hint_plan_debug_message_level, + (errhidestmt (true), + errmsg ("pg_hint_plan%s: setup_hint_enforcement" + " no hint applied:" + " relation=%u(%s), inhparent=%d, current_hint=%p," + " hint_inhibit_level=%d, scanmask=0x%x", + qnostr, relationObjectId, + get_rel_name(relationObjectId), + inhparent, current_hint_state, hint_inhibit_level, + current_hint_state->init_scan_mask))); + + setup_scan_method_enforcement(NULL, current_hint_state); + + return ret; } - else - delete_indexes(hint, rel, InvalidOid); + + if (rshint != NULL) *rshint = shint; + if (rphint != NULL) *rphint = phint; + + return ret; } /* @@ -2770,7 +3954,7 @@ find_join_hint(Relids joinrelids) List *join_hint; ListCell *l; - join_hint = current_hint->join_hint_level[bms_num_members(joinrelids)]; + join_hint = current_hint_state->join_hint_level[bms_num_members(joinrelids)]; foreach(l, join_hint) { @@ -2857,6 +4041,46 @@ OuterInnerJoinCreate(OuterInnerRels *outer_inner, LeadingHint *leading_hint, return join_relids; } +static Relids +create_bms_of_relids(Hint *base, PlannerInfo *root, List *initial_rels, + int nrels, char **relnames) +{ + int relid; + Relids relids = NULL; + int j; + char *relname; + + for (j = 0; j < nrels; j++) + { + relname = relnames[j]; + + relid = find_relid_aliasname(root, relname, initial_rels, + base->hint_str); + + if (relid == -1) + base->state = HINT_STATE_ERROR; + + /* + * the aliasname is not found(relid == 0) or same aliasname was used + * multiple times in a query(relid == -1) + */ + if (relid <= 0) + { + relids = NULL; + break; + } + if (bms_is_member(relid, relids)) + { + hint_ereport(base->hint_str, + ("Relation name \"%s\" is duplicated.", relname)); + base->state = HINT_STATE_ERROR; + break; + } + + relids = bms_add_member(relids, relid); + } + return relids; +} /* * Transform join method hint into handy form. * @@ -2884,43 +4108,33 @@ transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel, for (i = 0; i < hstate->num_hints[HINT_TYPE_JOIN_METHOD]; i++) { JoinMethodHint *hint = hstate->join_hints[i]; - int j; if (!hint_state_enabled(hint) || hint->nrels > nbaserel) continue; - bms_free(hint->joinrelids); - hint->joinrelids = NULL; - relid = 0; - for (j = 0; j < hint->nrels; j++) - { - relname = hint->relnames[j]; - - relid = find_relid_aliasname(root, relname, initial_rels, - hint->base.hint_str); + hint->joinrelids = create_bms_of_relids(&(hint->base), root, + initial_rels, hint->nrels, hint->relnames); - if (relid == -1) - hint->base.state = HINT_STATE_ERROR; - - if (relid <= 0) - break; + if (hint->joinrelids == NULL || hint->base.state == HINT_STATE_ERROR) + continue; - if (bms_is_member(relid, hint->joinrelids)) - { - hint_ereport(hint->base.hint_str, - ("Relation name \"%s\" is duplicated.", relname)); - hint->base.state = HINT_STATE_ERROR; - break; - } + hstate->join_hint_level[hint->nrels] = + lappend(hstate->join_hint_level[hint->nrels], hint); + } - hint->joinrelids = bms_add_member(hint->joinrelids, relid); - } + /* + * Create bitmap of relids from alias names for each rows hint. + * Bitmaps are more handy than strings in join searching. + */ + for (i = 0; i < hstate->num_hints[HINT_TYPE_ROWS]; i++) + { + RowsHint *hint = hstate->rows_hints[i]; - if (relid <= 0 || hint->base.state == HINT_STATE_ERROR) + if (!hint_state_enabled(hint) || hint->nrels > nbaserel) continue; - hstate->join_hint_level[hint->nrels] = - lappend(hstate->join_hint_level[hint->nrels], hint); + hint->joinrelids = create_bms_of_relids(&(hint->base), root, + initial_rels, hint->nrels, hint->relnames); } /* Do nothing if no Leading hint was supplied. */ @@ -2928,7 +4142,7 @@ transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel, return false; /* - * Decide to use Leading hint。 + * Decide whether to use Leading hint */ for (i = 0; i < hstate->num_hints[HINT_TYPE_LEADING]; i++) { @@ -3109,95 +4323,13 @@ transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel, if (hint_state_enabled(lhint)) { - set_join_config_options(DISABLE_ALL_JOIN, current_hint->context); + set_join_config_options(DISABLE_ALL_JOIN, current_hint_state->context); return true; } return false; } /* - * set_plain_rel_pathlist - * Build access paths for a plain relation (no subquery, no inheritance) - * - * This function was copied and edited from set_plain_rel_pathlist() in - * src/backend/optimizer/path/allpaths.c - */ -static void -set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte) -{ - /* Consider sequential scan */ -#if PG_VERSION_NUM >= 90200 - add_path(rel, create_seqscan_path(root, rel, NULL)); -#else - add_path(rel, create_seqscan_path(root, rel)); -#endif - - /* Consider index scans */ - create_index_paths(root, rel); - - /* Consider TID scans */ - create_tidscan_paths(root, rel); - - /* Now find the cheapest of the paths for this rel */ - set_cheapest(rel); -} - -static void -rebuild_scan_path(HintState *hstate, PlannerInfo *root, int level, - List *initial_rels) -{ - ListCell *l; - - foreach(l, initial_rels) - { - RelOptInfo *rel = (RelOptInfo *) lfirst(l); - RangeTblEntry *rte; - ScanMethodHint *hint; - - /* Skip relations which we can't choose scan method. */ - if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION) - continue; - - rte = root->simple_rte_array[rel->relid]; - - /* We can't force scan method of foreign tables */ - if (rte->relkind == RELKIND_FOREIGN_TABLE) - continue; - - /* - * Create scan paths with GUC parameters which are at the beginning of - * planner if scan method hint is not specified, otherwise use - * specified hints and mark the hint as used. - */ - if ((hint = find_scan_hint(root, rel)) == NULL) - set_scan_config_options(hstate->init_scan_mask, - hstate->context); - else - { - set_scan_config_options(hint->enforce_mask, hstate->context); - hint->base.state = HINT_STATE_USED; - } - - list_free_deep(rel->pathlist); - rel->pathlist = NIL; - if (rte->inh) - { - /* It's an "append relation", process accordingly */ - set_append_rel_pathlist(root, rel, rel->relid, rte); - } - else - { - set_plain_rel_pathlist(root, rel, rte); - } - } - - /* - * Restore the GUC variables we set above. - */ - set_scan_config_options(hstate->init_scan_mask, hstate->context); -} - -/* * wrapper of make_join_rel() * * call make_join_rel() after changing enable_* parameters according to given @@ -3222,7 +4354,8 @@ make_join_rel_wrapper(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2) { save_nestlevel = NewGUCNestLevel(); - set_join_config_options(hint->enforce_mask, current_hint->context); + set_join_config_options(hint->enforce_mask, + current_hint_state->context); rel = pg_hint_plan_make_join_rel(root, rel1, rel2); hint->base.state = HINT_STATE_USED; @@ -3250,17 +4383,10 @@ add_paths_to_joinrel_wrapper(PlannerInfo *root, SpecialJoinInfo *sjinfo, List *restrictlist) { - ScanMethodHint *scan_hint = NULL; Relids joinrelids; JoinMethodHint *join_hint; int save_nestlevel; - if ((scan_hint = find_scan_hint(root, innerrel)) != NULL) - { - set_scan_config_options(scan_hint->enforce_mask, current_hint->context); - scan_hint->base.state = HINT_STATE_USED; - } - joinrelids = bms_union(outerrel->relids, innerrel->relids); join_hint = find_join_hint(joinrelids); bms_free(joinrelids); @@ -3273,7 +4399,7 @@ add_paths_to_joinrel_wrapper(PlannerInfo *root, { set_join_config_options(join_hint->enforce_mask, - current_hint->context); + current_hint_state->context); add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype, sjinfo, restrictlist); @@ -3281,7 +4407,8 @@ add_paths_to_joinrel_wrapper(PlannerInfo *root, } else { - set_join_config_options(DISABLE_ALL_JOIN, current_hint->context); + set_join_config_options(DISABLE_ALL_JOIN, + current_hint_state->context); add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype, sjinfo, restrictlist); } @@ -3294,10 +4421,6 @@ add_paths_to_joinrel_wrapper(PlannerInfo *root, else add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype, sjinfo, restrictlist); - - if (scan_hint != NULL) - set_scan_config_options(current_hint->init_scan_mask, - current_hint->context); } static int @@ -3336,9 +4459,10 @@ pg_hint_plan_join_search(PlannerInfo *root, int levels_needed, /* * Use standard planner (or geqo planner) if pg_hint_plan is disabled or no - * valid hint is supplied. + * valid hint is supplied or current nesting depth is nesting depth of SPI + * calls. */ - if (!current_hint) + if (!current_hint_state || hint_inhibit_level > 0) { if (prev_join_search) return (*prev_join_search) (root, levels_needed, initial_rels); @@ -3348,9 +4472,6 @@ pg_hint_plan_join_search(PlannerInfo *root, int levels_needed, return standard_join_search(root, levels_needed, initial_rels); } - /* We apply scan method hint rebuild scan path. */ - rebuild_scan_path(current_hint, root, levels_needed, initial_rels); - /* * In the case using GEQO, only scan method hints and Set hints have * effect. Join method and join order is not controllable by hints. @@ -3359,53 +4480,277 @@ pg_hint_plan_join_search(PlannerInfo *root, int levels_needed, return geqo(root, levels_needed, initial_rels); nbaserel = get_num_baserels(initial_rels); - current_hint->join_hint_level = palloc0(sizeof(List *) * (nbaserel + 1)); + current_hint_state->join_hint_level = + palloc0(sizeof(List *) * (nbaserel + 1)); join_method_hints = palloc0(sizeof(JoinMethodHint *) * (nbaserel + 1)); - leading_hint_enable = transform_join_hints(current_hint, root, nbaserel, + leading_hint_enable = transform_join_hints(current_hint_state, + root, nbaserel, initial_rels, join_method_hints); rel = pg_hint_plan_standard_join_search(root, levels_needed, initial_rels); + /* + * Adjust number of parallel workers of the result rel to the largest + * number of the component paths. + */ + if (current_hint_state->num_hints[HINT_TYPE_PARALLEL] > 0) + { + ListCell *lc; + int nworkers = 0; + + foreach (lc, initial_rels) + { + ListCell *lcp; + RelOptInfo *rel = (RelOptInfo *) lfirst(lc); + + foreach (lcp, rel->partial_pathlist) + { + Path *path = (Path *) lfirst(lcp); + + if (nworkers < path-> parallel_workers) + nworkers = path-> parallel_workers; + } + } + + foreach (lc, rel->partial_pathlist) + { + Path *path = (Path *) lfirst(lc); + + if (path->parallel_safe && path->parallel_workers < nworkers) + path->parallel_workers = nworkers; + } + } + for (i = 2; i <= nbaserel; i++) { - list_free(current_hint->join_hint_level[i]); + list_free(current_hint_state->join_hint_level[i]); /* free Leading hint only */ if (join_method_hints[i] != NULL && join_method_hints[i]->enforce_mask == ENABLE_ALL_JOIN) JoinMethodHintDelete(join_method_hints[i]); } - pfree(current_hint->join_hint_level); + pfree(current_hint_state->join_hint_level); pfree(join_method_hints); if (leading_hint_enable) - set_join_config_options(current_hint->init_join_mask, - current_hint->context); + set_join_config_options(current_hint_state->init_join_mask, + current_hint_state->context); return rel; } /* + * Force number of wokers if instructed by hint + */ +void +pg_hint_plan_set_rel_pathlist(PlannerInfo * root, RelOptInfo *rel, + Index rti, RangeTblEntry *rte) +{ + ParallelHint *phint; + ListCell *l; + int found_hints; + + /* call the previous hook */ + if (prev_set_rel_pathlist) + prev_set_rel_pathlist(root, rel, rti, rte); + + /* Nothing to do if no hint available */ + if (current_hint_state == NULL) + return; + + /* Don't touch dummy rels. */ + if (IS_DUMMY_REL(rel)) + return; + + /* + * We can accept only plain relations, foreign tables and table saples are + * also unacceptable. See set_rel_pathlist. + */ + if ((rel->rtekind != RTE_RELATION && + rel->rtekind != RTE_SUBQUERY)|| + rte->relkind == RELKIND_FOREIGN_TABLE || + rte->tablesample != NULL) + return; + + /* + * Even though UNION ALL node doesn't have particular name so usually it is + * unhintable, turn on parallel when it contains parallel nodes. + */ + if (rel->rtekind == RTE_SUBQUERY) + { + ListCell *lc; + bool inhibit_nonparallel = false; + + if (rel->partial_pathlist == NIL) + return; + + foreach(lc, rel->partial_pathlist) + { + ListCell *lcp; + AppendPath *apath = (AppendPath *) lfirst(lc); + int parallel_workers = 0; + + if (!IsA(apath, AppendPath)) + continue; + + foreach (lcp, apath->subpaths) + { + Path *spath = (Path *) lfirst(lcp); + + if (spath->parallel_aware && + parallel_workers < spath->parallel_workers) + parallel_workers = spath->parallel_workers; + } + + apath->path.parallel_workers = parallel_workers; + inhibit_nonparallel = true; + } + + if (inhibit_nonparallel) + { + ListCell *lc; + + foreach(lc, rel->pathlist) + { + Path *path = (Path *) lfirst(lc); + + if (path->startup_cost < disable_cost) + { + path->startup_cost += disable_cost; + path->total_cost += disable_cost; + } + } + } + + return; + } + + /* We cannot handle if this requires an outer */ + if (rel->lateral_relids) + return; + + /* Return if this relation gets no enfocement */ + if ((found_hints = setup_hint_enforcement(root, rel, NULL, &phint)) == 0) + return; + + /* Here, we regenerate paths with the current hint restriction */ + if (found_hints & HINT_BM_SCAN_METHOD || found_hints & HINT_BM_PARALLEL) + { + /* + * When hint is specified on non-parent relations, discard existing + * paths and regenerate based on the hint considered. Otherwise we + * already have hinted childx paths then just adjust the number of + * planned number of workers. + */ + if (root->simple_rte_array[rel->relid]->inh) + { + /* enforce number of workers if requested */ + if (phint && phint->force_parallel) + { + if (phint->nworkers == 0) + { + list_free_deep(rel->partial_pathlist); + rel->partial_pathlist = NIL; + } + else + { + /* prioritize partial paths */ + foreach (l, rel->partial_pathlist) + { + Path *ppath = (Path *) lfirst(l); + + if (ppath->parallel_safe) + { + ppath->parallel_workers = phint->nworkers; + ppath->startup_cost = 0; + ppath->total_cost = 0; + } + } + + /* disable non-partial paths */ + foreach (l, rel->pathlist) + { + Path *ppath = (Path *) lfirst(l); + + if (ppath->startup_cost < disable_cost) + { + ppath->startup_cost += disable_cost; + ppath->total_cost += disable_cost; + } + } + } + } + } + else + { + /* Just discard all the paths considered so far */ + list_free_deep(rel->pathlist); + rel->pathlist = NIL; + list_free_deep(rel->partial_pathlist); + rel->partial_pathlist = NIL; + + /* Regenerate paths with the current enforcement */ + set_plain_rel_pathlist(root, rel, rte); + + /* Additional work to enforce parallel query execution */ + if (phint && phint->nworkers > 0) + { + /* + * For Parallel Append to be planned properly, we shouldn't set + * the costs of non-partial paths to disable-value. Lower the + * priority of non-parallel paths by setting partial path costs + * to 0 instead. + */ + foreach (l, rel->partial_pathlist) + { + Path *path = (Path *) lfirst(l); + + path->startup_cost = 0; + path->total_cost = 0; + } + + /* enforce number of workers if requested */ + if (phint->force_parallel) + { + foreach (l, rel->partial_pathlist) + { + Path *ppath = (Path *) lfirst(l); + + if (ppath->parallel_safe) + ppath->parallel_workers = phint->nworkers; + } + } + + /* Generate gather paths */ + if (rel->reloptkind == RELOPT_BASEREL && + bms_membership(root->all_baserels) != BMS_SINGLETON) + generate_gather_paths(root, rel, false); + } + } + } + + reset_hint_enforcement(); +} + +/* * set_rel_pathlist * Build access paths for a base relation * * This function was copied and edited from set_rel_pathlist() in - * src/backend/optimizer/path/allpaths.c + * src/backend/optimizer/path/allpaths.c in order not to copy other static + * functions not required here. */ static void set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, Index rti, RangeTblEntry *rte) { -#if PG_VERSION_NUM >= 90200 if (IS_DUMMY_REL(rel)) { /* We already proved the relation empty, so nothing more to do */ } else if (rte->inh) -#else - if (rte->inh) -#endif { /* It's an "append relation", process accordingly */ set_append_rel_pathlist(root, rel, rti, rte); @@ -3416,6 +4761,9 @@ set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, { if (rte->relkind == RELKIND_RELATION) { + if(rte->tablesample != NULL) + elog(ERROR, "sampled relation is not supported"); + /* Plain relation */ set_plain_rel_pathlist(root, rel, rte); } @@ -3425,6 +4773,53 @@ set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, else elog(ERROR, "unexpected rtekind: %d", (int) rel->rtekind); } + + /* + * Allow a plugin to editorialize on the set of Paths for this base + * relation. It could add new paths (such as CustomPaths) by calling + * add_path(), or delete or modify paths added by the core code. + */ + if (set_rel_pathlist_hook) + (*set_rel_pathlist_hook) (root, rel, rti, rte); + + /* Now find the cheapest of the paths for this rel */ + set_cheapest(rel); +} + +/* + * stmt_beg callback is called when each query in PL/pgSQL function is about + * to be executed. At that timing, we save query string in the global variable + * plpgsql_query_string to use it in planner hook. It's safe to use one global + * variable for the purpose, because its content is only necessary until + * planner hook is called for the query, so recursive PL/pgSQL function calls + * don't harm this mechanism. + */ +static void +pg_hint_plan_plpgsql_stmt_beg(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt) +{ + plpgsql_recurse_level++; +} + +/* + * stmt_end callback is called then each query in PL/pgSQL function has + * finished. At that timing, we clear plpgsql_query_string to tell planner + * hook that next call is not for a query written in PL/pgSQL block. + */ +static void +pg_hint_plan_plpgsql_stmt_end(PLpgSQL_execstate *estate, PLpgSQL_stmt *stmt) +{ + plpgsql_recurse_level--; +} + +void plpgsql_query_erase_callback(ResourceReleasePhase phase, + bool isCommit, + bool isTopLevel, + void *arg) +{ + if (!isTopLevel || phase != RESOURCE_RELEASE_AFTER_LOCKS) + return; + /* Cancel plpgsql nest level*/ + plpgsql_recurse_level = 0; } #define standard_join_search pg_hint_plan_standard_join_search @@ -3436,3 +4831,5 @@ set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, #define make_join_rel pg_hint_plan_make_join_rel #define add_paths_to_joinrel add_paths_to_joinrel_wrapper #include "make_join_rel.c" + +#include "pg_stat_statements.c"