pg_hint_plan.c

   1 /*-------------------------------------------------------------------------
   2  *
   3  * pg_hint_plan.c
   4  *                do instructions or hints to the planner using C-style block comments
   5  *                of the SQL.
   6  *
   7  * Copyright (c) 2012-2013, NIPPON TELEGRAPH AND TELEPHONE CORPORATION
   8  *
   9  *-------------------------------------------------------------------------
  10  */
  11 #include "postgres.h"
  12 #include "catalog/pg_collation.h"
  13 #include "catalog/pg_index.h"
  14 #include "commands/prepare.h"
  15 #include "mb/pg_wchar.h"
  16 #include "miscadmin.h"
  17 #include "nodes/nodeFuncs.h"
  18 #include "optimizer/clauses.h"
  19 #include "optimizer/cost.h"
  20 #include "optimizer/geqo.h"
  21 #include "optimizer/joininfo.h"
  22 #include "optimizer/pathnode.h"
  23 #include "optimizer/paths.h"
  24 #include "optimizer/plancat.h"
  25 #include "optimizer/planner.h"
  26 #include "optimizer/prep.h"
  27 #include "optimizer/restrictinfo.h"
  28 #include "parser/scansup.h"
  29 #include "tcop/utility.h"
  30 #include "utils/builtins.h"
  31 #include "utils/lsyscache.h"
  32 #include "utils/memutils.h"
  33 #include "utils/rel.h"
  34 #include "utils/syscache.h"
  35 #if PG_VERSION_NUM >= 90200
  36 #include "catalog/pg_class.h"
  37 #endif
  38
  39 #include "executor/spi.h"
  40 #include "catalog/pg_type.h"
  41
  42 #ifdef PG_MODULE_MAGIC
  43 PG_MODULE_MAGIC;
  44 #endif
  45
  46 #if PG_VERSION_NUM < 90100
  47 #error unsupported PostgreSQL version
  48 #endif
  49
  50 #define BLOCK_COMMENT_START             "/*"
  51 #define BLOCK_COMMENT_END               "*/"
  52 #define HINT_COMMENT_KEYWORD    "+"
  53 #define HINT_START                              BLOCK_COMMENT_START HINT_COMMENT_KEYWORD
  54 #define HINT_END                                BLOCK_COMMENT_END
  55
  56 /* hint keywords */
  57 #define HINT_SEQSCAN                    "SeqScan"
  58 #define HINT_INDEXSCAN                  "IndexScan"
  59 #define HINT_INDEXSCANREGEXP    "IndexScanRegexp"
  60 #define HINT_BITMAPSCAN                 "BitmapScan"
  61 #define HINT_BITMAPSCANREGEXP   "BitmapScanRegexp"
  62 #define HINT_TIDSCAN                    "TidScan"
  63 #define HINT_NOSEQSCAN                  "NoSeqScan"
  64 #define HINT_NOINDEXSCAN                "NoIndexScan"
  65 #define HINT_NOBITMAPSCAN               "NoBitmapScan"
  66 #define HINT_NOTIDSCAN                  "NoTidScan"
  67 #if PG_VERSION_NUM >= 90200
  68 #define HINT_INDEXONLYSCAN              "IndexOnlyScan"
  69 #define HINT_INDEXONLYSCANREGEXP        "IndexOnlyScanRegexp"
  70 #define HINT_NOINDEXONLYSCAN    "NoIndexOnlyScan"
  71 #endif
  72 #define HINT_NESTLOOP                   "NestLoop"
  73 #define HINT_MERGEJOIN                  "MergeJoin"
  74 #define HINT_HASHJOIN                   "HashJoin"
  75 #define HINT_NONESTLOOP                 "NoNestLoop"
  76 #define HINT_NOMERGEJOIN                "NoMergeJoin"
  77 #define HINT_NOHASHJOIN                 "NoHashJoin"
  78 #define HINT_LEADING                    "Leading"
  79 #define HINT_SET                                "Set"
  80
  81 #define HINT_ARRAY_DEFAULT_INITSIZE 8
  82
  83 #define hint_ereport(str, detail) \
  84         ereport(pg_hint_plan_parse_messages, \
  85                         (errmsg("hint syntax error at or near \"%s\"", (str)), \
  86                          errdetail detail))
  87
  88 #define skip_space(str) \
  89         while (isspace(*str)) \
  90                 str++;
  91
  92 enum
  93 {
  94         ENABLE_SEQSCAN = 0x01,
  95         ENABLE_INDEXSCAN = 0x02,
  96         ENABLE_BITMAPSCAN = 0x04,
  97         ENABLE_TIDSCAN = 0x08,
  98 #if PG_VERSION_NUM >= 90200
  99         ENABLE_INDEXONLYSCAN = 0x10
 100 #endif
 101 } SCAN_TYPE_BITS;
 102
 103 enum
 104 {
 105         ENABLE_NESTLOOP = 0x01,
 106         ENABLE_MERGEJOIN = 0x02,
 107         ENABLE_HASHJOIN = 0x04
 108 } JOIN_TYPE_BITS;
 109
 110 #if PG_VERSION_NUM >= 90200
 111 #define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
 112                                                  ENABLE_BITMAPSCAN | ENABLE_TIDSCAN | \
 113                                                  ENABLE_INDEXONLYSCAN)
 114 #else
 115 #define ENABLE_ALL_SCAN (ENABLE_SEQSCAN | ENABLE_INDEXSCAN | \
 116                                                  ENABLE_BITMAPSCAN | ENABLE_TIDSCAN)
 117 #endif
 118 #define ENABLE_ALL_JOIN (ENABLE_NESTLOOP | ENABLE_MERGEJOIN | ENABLE_HASHJOIN)
 119 #define DISABLE_ALL_SCAN 0
 120 #define DISABLE_ALL_JOIN 0
 121
 122 /* hint keyword of enum type*/
 123 typedef enum HintKeyword
 124 {
 125         HINT_KEYWORD_SEQSCAN,
 126         HINT_KEYWORD_INDEXSCAN,
 127         HINT_KEYWORD_INDEXSCANREGEXP,
 128         HINT_KEYWORD_BITMAPSCAN,
 129         HINT_KEYWORD_BITMAPSCANREGEXP,
 130         HINT_KEYWORD_TIDSCAN,
 131         HINT_KEYWORD_NOSEQSCAN,
 132         HINT_KEYWORD_NOINDEXSCAN,
 133         HINT_KEYWORD_NOBITMAPSCAN,
 134         HINT_KEYWORD_NOTIDSCAN,
 135 #if PG_VERSION_NUM >= 90200
 136         HINT_KEYWORD_INDEXONLYSCAN,
 137         HINT_KEYWORD_INDEXONLYSCANREGEXP,
 138         HINT_KEYWORD_NOINDEXONLYSCAN,
 139 #endif
 140         HINT_KEYWORD_NESTLOOP,
 141         HINT_KEYWORD_MERGEJOIN,
 142         HINT_KEYWORD_HASHJOIN,
 143         HINT_KEYWORD_NONESTLOOP,
 144         HINT_KEYWORD_NOMERGEJOIN,
 145         HINT_KEYWORD_NOHASHJOIN,
 146         HINT_KEYWORD_LEADING,
 147         HINT_KEYWORD_SET,
 148         HINT_KEYWORD_UNRECOGNIZED
 149 } HintKeyword;
 150
 151 typedef struct Hint Hint;
 152 typedef struct HintState HintState;
 153
 154 typedef Hint *(*HintCreateFunction) (const char *hint_str,
 155                                                                          const char *keyword,
 156                                                                          HintKeyword hint_keyword);
 157 typedef void (*HintDeleteFunction) (Hint *hint);
 158 typedef void (*HintDescFunction) (Hint *hint, StringInfo buf);
 159 typedef int (*HintCmpFunction) (const Hint *a, const Hint *b);
 160 typedef const char *(*HintParseFunction) (Hint *hint, HintState *hstate,
 161                                                                                   Query *parse, const char *str);
 162
 163 /* hint types */
 164 #define NUM_HINT_TYPE   4
 165 typedef enum HintType
 166 {
 167         HINT_TYPE_SCAN_METHOD,
 168         HINT_TYPE_JOIN_METHOD,
 169         HINT_TYPE_LEADING,
 170         HINT_TYPE_SET
 171 } HintType;
 172
 173 static const char *HintTypeName[] = {
 174         "scan method",
 175         "join method",
 176         "leading",
 177         "set"
 178 };
 179
 180 /* hint status */
 181 typedef enum HintStatus
 182 {
 183         HINT_STATE_NOTUSED = 0,         /* specified relation not used in query */
 184         HINT_STATE_USED,                        /* hint is used */
 185         HINT_STATE_DUPLICATION,         /* specified hint duplication */
 186         HINT_STATE_ERROR                        /* execute error (parse error does not include
 187                                                                  * it) */
 188 } HintStatus;
 189
 190 #define hint_state_enabled(hint) ((hint)->base.state == HINT_STATE_NOTUSED || \
 191                                                                   (hint)->base.state == HINT_STATE_USED)
 192
 193 /* common data for all hints. */
 194 struct Hint
 195 {
 196         const char                 *hint_str;           /* must not do pfree */
 197         const char                 *keyword;            /* must not do pfree */
 198         HintKeyword                     hint_keyword;
 199         HintType                        type;
 200         HintStatus                      state;
 201         HintDeleteFunction      delete_func;
 202         HintDescFunction        desc_func;
 203         HintCmpFunction         cmp_func;
 204         HintParseFunction       parse_func;
 205 };
 206
 207 /* scan method hints */
 208 typedef struct ScanMethodHint
 209 {
 210         Hint                    base;
 211         char               *relname;
 212         List               *indexnames;
 213         bool                    regexp;
 214         unsigned char   enforce_mask;
 215 } ScanMethodHint;
 216
 217 typedef struct ParentIndexInfo
 218 {
 219         bool            indisunique;
 220         Oid                     method;
 221         List       *column_names;
 222         char       *expression_str;
 223         Oid                *indcollation;
 224         Oid                *opclass;
 225         int16      *indoption;
 226         char       *indpred_str;
 227 } ParentIndexInfo;
 228
 229 /* join method hints */
 230 typedef struct JoinMethodHint
 231 {
 232         Hint                    base;
 233         int                             nrels;
 234         int                             inner_nrels;
 235         char              **relnames;
 236         unsigned char   enforce_mask;
 237         Relids                  joinrelids;
 238         Relids                  inner_joinrelids;
 239 } JoinMethodHint;
 240
 241 /* join order hints */
 242 typedef struct OuterInnerRels
 243 {
 244         char   *relation;
 245         List   *outer_inner_pair;
 246 } OuterInnerRels;
 247
 248 typedef struct LeadingHint
 249 {
 250         Hint                    base;
 251         List               *relations;  /* relation names specified in Leading hint */
 252         OuterInnerRels *outer_inner;
 253 } LeadingHint;
 254
 255 /* change a run-time parameter hints */
 256 typedef struct SetHint
 257 {
 258         Hint    base;
 259         char   *name;                           /* name of variable */
 260         char   *value;
 261         List   *words;
 262 } SetHint;
 263
 264 /*
 265  * Describes a context of hint processing.
 266  */
 267 struct HintState
 268 {
 269         char               *hint_str;                   /* original hint string */
 270
 271         /* all hint */
 272         int                             nall_hints;                     /* # of valid all hints */
 273         int                             max_all_hints;          /* # of slots for all hints */
 274         Hint              **all_hints;                  /* parsed all hints */
 275
 276         /* # of each hints */
 277         int                             num_hints[NUM_HINT_TYPE];
 278
 279         /* for scan method hints */
 280         ScanMethodHint **scan_hints;            /* parsed scan hints */
 281         int                             init_scan_mask;         /* initial value scan parameter */
 282         Index                   parent_relid;           /* inherit parent table relid */
 283         Oid                             parent_rel_oid;     /* inherit parent table relid */
 284         ScanMethodHint *parent_hint;            /* inherit parent table scan hint */
 285         List               *parent_index_infos; /* infomation of inherit parent table's
 286                                                                                  * index */
 287
 288         /* for join method hints */
 289         JoinMethodHint **join_hints;            /* parsed join hints */
 290         int                             init_join_mask;         /* initial value join parameter */
 291         List              **join_hint_level;
 292
 293         /* for Leading hint */
 294         LeadingHint       **leading_hint;               /* parsed Leading hints */
 295
 296         /* for Set hints */
 297         SetHint           **set_hints;                  /* parsed Set hints */
 298         GucContext              context;                        /* which GUC parameters can we set? */
 299 };
 300
 301 /*
 302  * Describes a hint parser module which is bound with particular hint keyword.
 303  */
 304 typedef struct HintParser
 305 {
 306         char                       *keyword;
 307         HintCreateFunction      create_func;
 308         HintKeyword                     hint_keyword;
 309 } HintParser;
 310
 311 /* Module callbacks */
 312 void            _PG_init(void);
 313 void            _PG_fini(void);
 314
 315 static void push_hint(HintState *hstate);
 316 static void pop_hint(void);
 317
 318 static void pg_hint_plan_ProcessUtility(Node *parsetree,
 319                                                                                 const char *queryString,
 320                                                                                 ParamListInfo params, bool isTopLevel,
 321                                                                                 DestReceiver *dest,
 322                                                                                 char *completionTag);
 323 static PlannedStmt *pg_hint_plan_planner(Query *parse, int cursorOptions,
 324                                                                                  ParamListInfo boundParams);
 325 static void pg_hint_plan_get_relation_info(PlannerInfo *root,
 326                                                                                    Oid relationObjectId,
 327                                                                                    bool inhparent, RelOptInfo *rel);
 328 static RelOptInfo *pg_hint_plan_join_search(PlannerInfo *root,
 329                                                                                         int levels_needed,
 330                                                                                         List *initial_rels);
 331
 332 static Hint *ScanMethodHintCreate(const char *hint_str, const char *keyword,
 333                                                                   HintKeyword hint_keyword);
 334 static void ScanMethodHintDelete(ScanMethodHint *hint);
 335 static void ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf);
 336 static int ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b);
 337 static const char *ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate,
 338                                                                            Query *parse, const char *str);
 339 static Hint *JoinMethodHintCreate(const char *hint_str, const char *keyword,
 340                                                                   HintKeyword hint_keyword);
 341 static void JoinMethodHintDelete(JoinMethodHint *hint);
 342 static void JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf);
 343 static int JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b);
 344 static const char *JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate,
 345                                                                            Query *parse, const char *str);
 346 static Hint *LeadingHintCreate(const char *hint_str, const char *keyword,
 347                                                            HintKeyword hint_keyword);
 348 static void LeadingHintDelete(LeadingHint *hint);
 349 static void LeadingHintDesc(LeadingHint *hint, StringInfo buf);
 350 static int LeadingHintCmp(const LeadingHint *a, const LeadingHint *b);
 351 static const char *LeadingHintParse(LeadingHint *hint, HintState *hstate,
 352                                                                         Query *parse, const char *str);
 353 static Hint *SetHintCreate(const char *hint_str, const char *keyword,
 354                                                    HintKeyword hint_keyword);
 355 static void SetHintDelete(SetHint *hint);
 356 static void SetHintDesc(SetHint *hint, StringInfo buf);
 357 static int SetHintCmp(const SetHint *a, const SetHint *b);
 358 static const char *SetHintParse(SetHint *hint, HintState *hstate, Query *parse,
 359                                                                 const char *str);
 360
 361 static void quote_value(StringInfo buf, const char *value);
 362
 363 static const char *parse_quoted_value(const char *str, char **word,
 364                                                                           bool truncate);
 365
 366 RelOptInfo *pg_hint_plan_standard_join_search(PlannerInfo *root,
 367                                                                                           int levels_needed,
 368                                                                                           List *initial_rels);
 369 void pg_hint_plan_join_search_one_level(PlannerInfo *root, int level);
 370 static void make_rels_by_clause_joins(PlannerInfo *root, RelOptInfo *old_rel,
 371                                                                           ListCell *other_rels);
 372 static void make_rels_by_clauseless_joins(PlannerInfo *root,
 373                                                                                   RelOptInfo *old_rel,
 374                                                                                   ListCell *other_rels);
 375 static bool has_join_restriction(PlannerInfo *root, RelOptInfo *rel);
 376 static void set_append_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
 377                                                                         Index rti, RangeTblEntry *rte);
 378 #if PG_VERSION_NUM >= 90200
 379 static void generate_mergeappend_paths(PlannerInfo *root, RelOptInfo *rel,
 380                                                    List *live_childrels,
 381                                                    List *all_child_pathkeys);
 382 #endif
 383 static List *accumulate_append_subpath(List *subpaths, Path *path);
 384 #if PG_VERSION_NUM < 90200
 385 static void set_dummy_rel_pathlist(RelOptInfo *rel);
 386 #endif
 387 RelOptInfo *pg_hint_plan_make_join_rel(PlannerInfo *root, RelOptInfo *rel1,
 388                                                                            RelOptInfo *rel2);
 389
 390 /* GUC variables */
 391 static bool     pg_hint_plan_enable_hint = true;
 392 static bool     pg_hint_plan_debug_print = false;
 393 static int      pg_hint_plan_parse_messages = INFO;
 394
 395 static const struct config_enum_entry parse_messages_level_options[] = {
 396         {"debug", DEBUG2, true},
 397         {"debug5", DEBUG5, false},
 398         {"debug4", DEBUG4, false},
 399         {"debug3", DEBUG3, false},
 400         {"debug2", DEBUG2, false},
 401         {"debug1", DEBUG1, false},
 402         {"log", LOG, false},
 403         {"info", INFO, false},
 404         {"notice", NOTICE, false},
 405         {"warning", WARNING, false},
 406         {"error", ERROR, false},
 407         /*
 408          * {"fatal", FATAL, true},
 409          * {"panic", PANIC, true},
 410          */
 411         {NULL, 0, false}
 412 };
 413
 414 /* Saved hook values in case of unload */
 415 static ProcessUtility_hook_type prev_ProcessUtility = NULL;
 416 static planner_hook_type prev_planner = NULL;
 417 static get_relation_info_hook_type prev_get_relation_info = NULL;
 418 static join_search_hook_type prev_join_search = NULL;
 419
 420 /* Hold reference to currently active hint */
 421 static HintState *current_hint = NULL;
 422
 423 /*
 424  * List of hint contexts.  We treat the head of the list as the Top of the
 425  * context stack, so current_hint always points the first element of this list.
 426  */
 427 static List *HintStateStack = NIL;
 428
 429 /*
 430  * Holds statement name during executing EXECUTE command.  NULL for other
 431  * statements.
 432  */
 433 static char        *stmt_name = NULL;
 434
 435 static const HintParser parsers[] = {
 436         {HINT_SEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_SEQSCAN},
 437         {HINT_INDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCAN},
 438         {HINT_INDEXSCANREGEXP, ScanMethodHintCreate, HINT_KEYWORD_INDEXSCANREGEXP},
 439         {HINT_BITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_BITMAPSCAN},
 440         {HINT_BITMAPSCANREGEXP, ScanMethodHintCreate,
 441          HINT_KEYWORD_BITMAPSCANREGEXP},
 442         {HINT_TIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_TIDSCAN},
 443         {HINT_NOSEQSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOSEQSCAN},
 444         {HINT_NOINDEXSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXSCAN},
 445         {HINT_NOBITMAPSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOBITMAPSCAN},
 446         {HINT_NOTIDSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOTIDSCAN},
 447 #if PG_VERSION_NUM >= 90200
 448         {HINT_INDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_INDEXONLYSCAN},
 449         {HINT_INDEXONLYSCANREGEXP, ScanMethodHintCreate,
 450          HINT_KEYWORD_INDEXONLYSCANREGEXP},
 451         {HINT_NOINDEXONLYSCAN, ScanMethodHintCreate, HINT_KEYWORD_NOINDEXONLYSCAN},
 452 #endif
 453         {HINT_NESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NESTLOOP},
 454         {HINT_MERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_MERGEJOIN},
 455         {HINT_HASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_HASHJOIN},
 456         {HINT_NONESTLOOP, JoinMethodHintCreate, HINT_KEYWORD_NONESTLOOP},
 457         {HINT_NOMERGEJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOMERGEJOIN},
 458         {HINT_NOHASHJOIN, JoinMethodHintCreate, HINT_KEYWORD_NOHASHJOIN},
 459         {HINT_LEADING, LeadingHintCreate, HINT_KEYWORD_LEADING},
 460         {HINT_SET, SetHintCreate, HINT_KEYWORD_SET},
 461         {NULL, NULL, HINT_KEYWORD_UNRECOGNIZED}
 462 };
 463
 464 /*
 465  * Module load callbacks
 466  */
 467 void
 468 _PG_init(void)
 469 {
 470         /* Define custom GUC variables. */
 471         DefineCustomBoolVariable("pg_hint_plan.enable_hint",
 472                          "Force planner to use plans specified in the hint comment preceding to the query.",
 473                                                          NULL,
 474                                                          &pg_hint_plan_enable_hint,
 475                                                          true,
 476                                                          PGC_USERSET,
 477                                                          0,
 478                                                          NULL,
 479                                                          NULL,
 480                                                          NULL);
 481
 482         DefineCustomBoolVariable("pg_hint_plan.debug_print",
 483                                                          "Logs results of hint parsing.",
 484                                                          NULL,
 485                                                          &pg_hint_plan_debug_print,
 486                                                          false,
 487                                                          PGC_USERSET,
 488                                                          0,
 489                                                          NULL,
 490                                                          NULL,
 491                                                          NULL);
 492
 493         DefineCustomEnumVariable("pg_hint_plan.parse_messages",
 494                                                          "Message level of parse errors.",
 495                                                          NULL,
 496                                                          &pg_hint_plan_parse_messages,
 497                                                          INFO,
 498                                                          parse_messages_level_options,
 499                                                          PGC_USERSET,
 500                                                          0,
 501                                                          NULL,
 502                                                          NULL,
 503                                                          NULL);
 504
 505         /* Install hooks. */
 506         prev_ProcessUtility = ProcessUtility_hook;
 507         ProcessUtility_hook = pg_hint_plan_ProcessUtility;
 508         prev_planner = planner_hook;
 509         planner_hook = pg_hint_plan_planner;
 510         prev_get_relation_info = get_relation_info_hook;
 511         get_relation_info_hook = pg_hint_plan_get_relation_info;
 512         prev_join_search = join_search_hook;
 513         join_search_hook = pg_hint_plan_join_search;
 514 }
 515
 516 /*
 517  * Module unload callback
 518  * XXX never called
 519  */
 520 void
 521 _PG_fini(void)
 522 {
 523         /* Uninstall hooks. */
 524         ProcessUtility_hook = prev_ProcessUtility;
 525         planner_hook = prev_planner;
 526         get_relation_info_hook = prev_get_relation_info;
 527         join_search_hook = prev_join_search;
 528 }
 529
 530 /*
 531  * create and delete functions the hint object
 532  */
 533
 534 static Hint *
 535 ScanMethodHintCreate(const char *hint_str, const char *keyword,
 536                                          HintKeyword hint_keyword)
 537 {
 538         ScanMethodHint *hint;
 539
 540         hint = palloc(sizeof(ScanMethodHint));
 541         hint->base.hint_str = hint_str;
 542         hint->base.keyword = keyword;
 543         hint->base.hint_keyword = hint_keyword;
 544         hint->base.type = HINT_TYPE_SCAN_METHOD;
 545         hint->base.state = HINT_STATE_NOTUSED;
 546         hint->base.delete_func = (HintDeleteFunction) ScanMethodHintDelete;
 547         hint->base.desc_func = (HintDescFunction) ScanMethodHintDesc;
 548         hint->base.cmp_func = (HintCmpFunction) ScanMethodHintCmp;
 549         hint->base.parse_func = (HintParseFunction) ScanMethodHintParse;
 550         hint->relname = NULL;
 551         hint->indexnames = NIL;
 552         hint->regexp = false;
 553         hint->enforce_mask = 0;
 554
 555         return (Hint *) hint;
 556 }
 557
 558 static void
 559 ScanMethodHintDelete(ScanMethodHint *hint)
 560 {
 561         if (!hint)
 562                 return;
 563
 564         if (hint->relname)
 565                 pfree(hint->relname);
 566         list_free_deep(hint->indexnames);
 567         pfree(hint);
 568 }
 569
 570 static Hint *
 571 JoinMethodHintCreate(const char *hint_str, const char *keyword,
 572                                          HintKeyword hint_keyword)
 573 {
 574         JoinMethodHint *hint;
 575
 576         hint = palloc(sizeof(JoinMethodHint));
 577         hint->base.hint_str = hint_str;
 578         hint->base.keyword = keyword;
 579         hint->base.hint_keyword = hint_keyword;
 580         hint->base.type = HINT_TYPE_JOIN_METHOD;
 581         hint->base.state = HINT_STATE_NOTUSED;
 582         hint->base.delete_func = (HintDeleteFunction) JoinMethodHintDelete;
 583         hint->base.desc_func = (HintDescFunction) JoinMethodHintDesc;
 584         hint->base.cmp_func = (HintCmpFunction) JoinMethodHintCmp;
 585         hint->base.parse_func = (HintParseFunction) JoinMethodHintParse;
 586         hint->nrels = 0;
 587         hint->inner_nrels = 0;
 588         hint->relnames = NULL;
 589         hint->enforce_mask = 0;
 590         hint->joinrelids = NULL;
 591         hint->inner_joinrelids = NULL;
 592
 593         return (Hint *) hint;
 594 }
 595
 596 static void
 597 JoinMethodHintDelete(JoinMethodHint *hint)
 598 {
 599         if (!hint)
 600                 return;
 601
 602         if (hint->relnames)
 603         {
 604                 int     i;
 605
 606                 for (i = 0; i < hint->nrels; i++)
 607                         pfree(hint->relnames[i]);
 608                 pfree(hint->relnames);
 609         }
 610
 611         bms_free(hint->joinrelids);
 612         bms_free(hint->inner_joinrelids);
 613         pfree(hint);
 614 }
 615
 616 static Hint *
 617 LeadingHintCreate(const char *hint_str, const char *keyword,
 618                                   HintKeyword hint_keyword)
 619 {
 620         LeadingHint        *hint;
 621
 622         hint = palloc(sizeof(LeadingHint));
 623         hint->base.hint_str = hint_str;
 624         hint->base.keyword = keyword;
 625         hint->base.hint_keyword = hint_keyword;
 626         hint->base.type = HINT_TYPE_LEADING;
 627         hint->base.state = HINT_STATE_NOTUSED;
 628         hint->base.delete_func = (HintDeleteFunction)LeadingHintDelete;
 629         hint->base.desc_func = (HintDescFunction) LeadingHintDesc;
 630         hint->base.cmp_func = (HintCmpFunction) LeadingHintCmp;
 631         hint->base.parse_func = (HintParseFunction) LeadingHintParse;
 632         hint->relations = NIL;
 633         hint->outer_inner = NULL;
 634
 635         return (Hint *) hint;
 636 }
 637
 638 static void
 639 LeadingHintDelete(LeadingHint *hint)
 640 {
 641         if (!hint)
 642                 return;
 643
 644         list_free_deep(hint->relations);
 645         if (hint->outer_inner)
 646                 pfree(hint->outer_inner);
 647         pfree(hint);
 648 }
 649
 650 static Hint *
 651 SetHintCreate(const char *hint_str, const char *keyword,
 652                           HintKeyword hint_keyword)
 653 {
 654         SetHint    *hint;
 655
 656         hint = palloc(sizeof(SetHint));
 657         hint->base.hint_str = hint_str;
 658         hint->base.keyword = keyword;
 659         hint->base.hint_keyword = hint_keyword;
 660         hint->base.type = HINT_TYPE_SET;
 661         hint->base.state = HINT_STATE_NOTUSED;
 662         hint->base.delete_func = (HintDeleteFunction) SetHintDelete;
 663         hint->base.desc_func = (HintDescFunction) SetHintDesc;
 664         hint->base.cmp_func = (HintCmpFunction) SetHintCmp;
 665         hint->base.parse_func = (HintParseFunction) SetHintParse;
 666         hint->name = NULL;
 667         hint->value = NULL;
 668         hint->words = NIL;
 669
 670         return (Hint *) hint;
 671 }
 672
 673 static void
 674 SetHintDelete(SetHint *hint)
 675 {
 676         if (!hint)
 677                 return;
 678
 679         if (hint->name)
 680                 pfree(hint->name);
 681         if (hint->value)
 682                 pfree(hint->value);
 683         if (hint->words)
 684                 list_free(hint->words);
 685         pfree(hint);
 686 }
 687
 688 static HintState *
 689 HintStateCreate(void)
 690 {
 691         HintState   *hstate;
 692
 693         hstate = palloc(sizeof(HintState));
 694         hstate->hint_str = NULL;
 695         hstate->nall_hints = 0;
 696         hstate->max_all_hints = 0;
 697         hstate->all_hints = NULL;
 698         memset(hstate->num_hints, 0, sizeof(hstate->num_hints));
 699         hstate->scan_hints = NULL;
 700         hstate->init_scan_mask = 0;
 701         hstate->parent_relid = 0;
 702         hstate->parent_rel_oid = InvalidOid;
 703         hstate->parent_hint = NULL;
 704         hstate->parent_index_infos = NIL;
 705         hstate->join_hints = NULL;
 706         hstate->init_join_mask = 0;
 707         hstate->join_hint_level = NULL;
 708         hstate->leading_hint = NULL;
 709         hstate->context = superuser() ? PGC_SUSET : PGC_USERSET;
 710         hstate->set_hints = NULL;
 711
 712         return hstate;
 713 }
 714
 715 static void
 716 HintStateDelete(HintState *hstate)
 717 {
 718         int                     i;
 719
 720         if (!hstate)
 721                 return;
 722
 723         if (hstate->hint_str)
 724                 pfree(hstate->hint_str);
 725
 726         for (i = 0; i < hstate->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
 727                 hstate->all_hints[i]->delete_func(hstate->all_hints[i]);
 728         if (hstate->all_hints)
 729                 pfree(hstate->all_hints);
 730         if (hstate->parent_index_infos)
 731                 list_free(hstate->parent_index_infos);
 732 }
 733
 734 /*
 735  * Copy given value into buf, with quoting with '"' if necessary.
 736  */
 737 static void
 738 quote_value(StringInfo buf, const char *value)
 739 {
 740         bool            need_quote = false;
 741         const char *str;
 742
 743         for (str = value; *str != '\0'; str++)
 744         {
 745                 if (isspace(*str) || *str == '(' || *str == ')' || *str == '"')
 746                 {
 747                         need_quote = true;
 748                         appendStringInfoCharMacro(buf, '"');
 749                         break;
 750                 }
 751         }
 752
 753         for (str = value; *str != '\0'; str++)
 754         {
 755                 if (*str == '"')
 756                         appendStringInfoCharMacro(buf, '"');
 757
 758                 appendStringInfoCharMacro(buf, *str);
 759         }
 760
 761         if (need_quote)
 762                 appendStringInfoCharMacro(buf, '"');
 763 }
 764
 765 static void
 766 ScanMethodHintDesc(ScanMethodHint *hint, StringInfo buf)
 767 {
 768         ListCell   *l;
 769
 770         appendStringInfo(buf, "%s(", hint->base.keyword);
 771         if (hint->relname != NULL)
 772         {
 773                 quote_value(buf, hint->relname);
 774                 foreach(l, hint->indexnames)
 775                 {
 776                         appendStringInfoCharMacro(buf, ' ');
 777                         quote_value(buf, (char *) lfirst(l));
 778                 }
 779         }
 780         appendStringInfoString(buf, ")\n");
 781 }
 782
 783 static void
 784 JoinMethodHintDesc(JoinMethodHint *hint, StringInfo buf)
 785 {
 786         int     i;
 787
 788         appendStringInfo(buf, "%s(", hint->base.keyword);
 789         if (hint->relnames != NULL)
 790         {
 791                 quote_value(buf, hint->relnames[0]);
 792                 for (i = 1; i < hint->nrels; i++)
 793                 {
 794                         appendStringInfoCharMacro(buf, ' ');
 795                         quote_value(buf, hint->relnames[i]);
 796                 }
 797         }
 798         appendStringInfoString(buf, ")\n");
 799
 800 }
 801
 802 static void
 803 OuterInnerDesc(OuterInnerRels *outer_inner, StringInfo buf)
 804 {
 805         if (outer_inner->relation == NULL)
 806         {
 807                 bool            is_first;
 808                 ListCell   *l;
 809
 810                 is_first = true;
 811
 812                 appendStringInfoCharMacro(buf, '(');
 813                 foreach(l, outer_inner->outer_inner_pair)
 814                 {
 815                         if (is_first)
 816                                 is_first = false;
 817                         else
 818                                 appendStringInfoCharMacro(buf, ' ');
 819
 820                         OuterInnerDesc(lfirst(l), buf);
 821                 }
 822
 823                 appendStringInfoCharMacro(buf, ')');
 824         }
 825         else
 826                 quote_value(buf, outer_inner->relation);
 827 }
 828
 829 static void
 830 LeadingHintDesc(LeadingHint *hint, StringInfo buf)
 831 {
 832         appendStringInfo(buf, "%s(", HINT_LEADING);
 833         if (hint->outer_inner == NULL)
 834         {
 835                 ListCell   *l;
 836                 bool            is_first;
 837
 838                 is_first = true;
 839
 840                 foreach(l, hint->relations)
 841                 {
 842                         if (is_first)
 843                                 is_first = false;
 844                         else
 845                                 appendStringInfoCharMacro(buf, ' ');
 846
 847                         quote_value(buf, (char *) lfirst(l));
 848                 }
 849         }
 850         else
 851                 OuterInnerDesc(hint->outer_inner, buf);
 852
 853         appendStringInfoString(buf, ")\n");
 854 }
 855
 856 static void
 857 SetHintDesc(SetHint *hint, StringInfo buf)
 858 {
 859         bool            is_first = true;
 860         ListCell   *l;
 861
 862         appendStringInfo(buf, "%s(", HINT_SET);
 863         foreach(l, hint->words)
 864         {
 865                 if (is_first)
 866                         is_first = false;
 867                 else
 868                         appendStringInfoCharMacro(buf, ' ');
 869
 870                 quote_value(buf, (char *) lfirst(l));
 871         }
 872         appendStringInfo(buf, ")\n");
 873 }
 874
 875 /*
 876  * Append string which repserents all hints in a given state to buf, with
 877  * preceding title with them.
 878  */
 879 static void
 880 desc_hint_in_state(HintState *hstate, StringInfo buf, const char *title,
 881                                         HintStatus state)
 882 {
 883         int     i;
 884
 885         appendStringInfo(buf, "%s:\n", title);
 886         for (i = 0; i < hstate->nall_hints; i++)
 887         {
 888                 if (hstate->all_hints[i]->state != state)
 889                         continue;
 890
 891                 hstate->all_hints[i]->desc_func(hstate->all_hints[i], buf);
 892         }
 893 }
 894
 895 /*
 896  * Dump contents of given hstate to server log with log level LOG.
 897  */
 898 static void
 899 HintStateDump(HintState *hstate)
 900 {
 901         StringInfoData  buf;
 902
 903         if (!hstate)
 904         {
 905                 elog(LOG, "pg_hint_plan:\nno hint");
 906                 return;
 907         }
 908
 909         initStringInfo(&buf);
 910
 911         appendStringInfoString(&buf, "pg_hint_plan:\n");
 912         desc_hint_in_state(hstate, &buf, "used hint", HINT_STATE_USED);
 913         desc_hint_in_state(hstate, &buf, "not used hint", HINT_STATE_NOTUSED);
 914         desc_hint_in_state(hstate, &buf, "duplication hint", HINT_STATE_DUPLICATION);
 915         desc_hint_in_state(hstate, &buf, "error hint", HINT_STATE_ERROR);
 916
 917         elog(LOG, "%s", buf.data);
 918
 919         pfree(buf.data);
 920 }
 921
 922 /*
 923  * compare functions
 924  */
 925
 926 static int
 927 RelnameCmp(const void *a, const void *b)
 928 {
 929         const char *relnamea = *((const char **) a);
 930         const char *relnameb = *((const char **) b);
 931
 932         return strcmp(relnamea, relnameb);
 933 }
 934
 935 static int
 936 ScanMethodHintCmp(const ScanMethodHint *a, const ScanMethodHint *b)
 937 {
 938         return RelnameCmp(&a->relname, &b->relname);
 939 }
 940
 941 static int
 942 JoinMethodHintCmp(const JoinMethodHint *a, const JoinMethodHint *b)
 943 {
 944         int     i;
 945
 946         if (a->nrels != b->nrels)
 947                 return a->nrels - b->nrels;
 948
 949         for (i = 0; i < a->nrels; i++)
 950         {
 951                 int     result;
 952                 if ((result = RelnameCmp(&a->relnames[i], &b->relnames[i])) != 0)
 953                         return result;
 954         }
 955
 956         return 0;
 957 }
 958
 959 static int
 960 LeadingHintCmp(const LeadingHint *a, const LeadingHint *b)
 961 {
 962         return 0;
 963 }
 964
 965 static int
 966 SetHintCmp(const SetHint *a, const SetHint *b)
 967 {
 968         return strcmp(a->name, b->name);
 969 }
 970
 971 static int
 972 HintCmp(const void *a, const void *b)
 973 {
 974         const Hint *hinta = *((const Hint **) a);
 975         const Hint *hintb = *((const Hint **) b);
 976
 977         if (hinta->type != hintb->type)
 978                 return hinta->type - hintb->type;
 979         if (hinta->state == HINT_STATE_ERROR)
 980                 return -1;
 981         if (hintb->state == HINT_STATE_ERROR)
 982                 return 1;
 983         return hinta->cmp_func(hinta, hintb);
 984 }
 985
 986 /*
 987  * Returns byte offset of hint b from hint a.  If hint a was specified before
 988  * b, positive value is returned.
 989  */
 990 static int
 991 HintCmpWithPos(const void *a, const void *b)
 992 {
 993         const Hint *hinta = *((const Hint **) a);
 994         const Hint *hintb = *((const Hint **) b);
 995         int             result;
 996
 997         result = HintCmp(a, b);
 998         if (result == 0)
 999                 result = hinta->hint_str - hintb->hint_str;
1000
1001         return result;
1002 }
1003
1004 /*
1005  * parse functions
1006  */
1007 static const char *
1008 parse_keyword(const char *str, StringInfo buf)
1009 {
1010         skip_space(str);
1011
1012         while (!isspace(*str) && *str != '(' && *str != '\0')
1013                 appendStringInfoCharMacro(buf, *str++);
1014
1015         return str;
1016 }
1017
1018 static const char *
1019 skip_parenthesis(const char *str, char parenthesis)
1020 {
1021         skip_space(str);
1022
1023         if (*str != parenthesis)
1024         {
1025                 if (parenthesis == '(')
1026                         hint_ereport(str, ("Opening parenthesis is necessary."));
1027                 else if (parenthesis == ')')
1028                         hint_ereport(str, ("Closing parenthesis is necessary."));
1029
1030                 return NULL;
1031         }
1032
1033         str++;
1034
1035         return str;
1036 }
1037
1038 /*
1039  * Parse a token from str, and store malloc'd copy into word.  A token can be
1040  * quoted with '"'.  Return value is pointer to unparsed portion of original
1041  * string, or NULL if an error occurred.
1042  *
1043  * Parsed token is truncated within NAMEDATALEN-1 bytes, when truncate is true.
1044  */
1045 static const char *
1046 parse_quoted_value(const char *str, char **word, bool truncate)
1047 {
1048         StringInfoData  buf;
1049         bool                    in_quote;
1050
1051         /* Skip leading spaces. */
1052         skip_space(str);
1053
1054         initStringInfo(&buf);
1055         if (*str == '"')
1056         {
1057                 str++;
1058                 in_quote = true;
1059         }
1060         else
1061                 in_quote = false;
1062
1063         while (true)
1064         {
1065                 if (in_quote)
1066                 {
1067                         /* Double quotation must be closed. */
1068                         if (*str == '\0')
1069                         {
1070                                 pfree(buf.data);
1071                                 hint_ereport(str, ("Unterminated quoted string."));
1072                                 return NULL;
1073                         }
1074
1075                         /*
1076                          * Skip escaped double quotation.
1077                          *
1078                          * We don't allow slash-asterisk and asterisk-slash (delimiters of
1079                          * block comments) to be an object name, so users must specify
1080                          * alias for such object names.
1081                          *
1082                          * Those special names can be allowed if we care escaped slashes
1083                          * and asterisks, but we don't.
1084                          */
1085                         if (*str == '"')
1086                         {
1087                                 str++;
1088                                 if (*str != '"')
1089                                         break;
1090                         }
1091                 }
1092                 else if (isspace(*str) || *str == '(' || *str == ')' || *str == '"' ||
1093                                  *str == '\0')
1094                         break;
1095
1096                 appendStringInfoCharMacro(&buf, *str++);
1097         }
1098
1099         if (buf.len == 0)
1100         {
1101                 hint_ereport(str, ("Zero-length delimited string."));
1102
1103                 pfree(buf.data);
1104
1105                 return NULL;
1106         }
1107
1108         /* Truncate name if it's too long */
1109         if (truncate)
1110                 truncate_identifier(buf.data, strlen(buf.data), true);
1111
1112         *word = buf.data;
1113
1114         return str;
1115 }
1116
1117 static OuterInnerRels *
1118 OuterInnerRelsCreate(char *name, List *outer_inner_list)
1119 {
1120         OuterInnerRels *outer_inner;
1121
1122         outer_inner = palloc(sizeof(OuterInnerRels));
1123         outer_inner->relation = name;
1124         outer_inner->outer_inner_pair = outer_inner_list;
1125
1126         return outer_inner;
1127 }
1128
1129 static const char *
1130 parse_parentheses_Leading_in(const char *str, OuterInnerRels **outer_inner)
1131 {
1132         List   *outer_inner_pair = NIL;
1133
1134         if ((str = skip_parenthesis(str, '(')) == NULL)
1135                 return NULL;
1136
1137         skip_space(str);
1138
1139         /* Store words in parentheses into outer_inner_list. */
1140         while(*str != ')' && *str != '\0')
1141         {
1142                 OuterInnerRels *outer_inner_rels;
1143
1144                 if (*str == '(')
1145                 {
1146                         str = parse_parentheses_Leading_in(str, &outer_inner_rels);
1147                         if (str == NULL)
1148                                 break;
1149                 }
1150                 else
1151                 {
1152                         char   *name;
1153
1154                         if ((str = parse_quoted_value(str, &name, true)) == NULL)
1155                                 break;
1156                         else
1157                                 outer_inner_rels = OuterInnerRelsCreate(name, NIL);
1158                 }
1159
1160                 outer_inner_pair = lappend(outer_inner_pair, outer_inner_rels);
1161                 skip_space(str);
1162         }
1163
1164         if (str == NULL ||
1165                 (str = skip_parenthesis(str, ')')) == NULL)
1166         {
1167                 list_free(outer_inner_pair);
1168                 return NULL;
1169         }
1170
1171         *outer_inner = OuterInnerRelsCreate(NULL, outer_inner_pair);
1172
1173         return str;
1174 }
1175
1176 static const char *
1177 parse_parentheses_Leading(const char *str, List **name_list,
1178         OuterInnerRels **outer_inner)
1179 {
1180         char   *name;
1181         bool    truncate = true;
1182
1183         if ((str = skip_parenthesis(str, '(')) == NULL)
1184                 return NULL;
1185
1186         skip_space(str);
1187         if (*str =='(')
1188         {
1189                 if ((str = parse_parentheses_Leading_in(str, outer_inner)) == NULL)
1190                         return NULL;
1191         }
1192         else
1193         {
1194                 /* Store words in parentheses into name_list. */
1195                 while(*str != ')' && *str != '\0')
1196                 {
1197                         if ((str = parse_quoted_value(str, &name, truncate)) == NULL)
1198                         {
1199                                 list_free(*name_list);
1200                                 return NULL;
1201                         }
1202
1203                         *name_list = lappend(*name_list, name);
1204                         skip_space(str);
1205                 }
1206         }
1207
1208         if ((str = skip_parenthesis(str, ')')) == NULL)
1209                 return NULL;
1210         return str;
1211 }
1212
1213 static const char *
1214 parse_parentheses(const char *str, List **name_list, HintKeyword keyword)
1215 {
1216         char   *name;
1217         bool    truncate = true;
1218
1219         if ((str = skip_parenthesis(str, '(')) == NULL)
1220                 return NULL;
1221
1222         skip_space(str);
1223
1224         /* Store words in parentheses into name_list. */
1225         while(*str != ')' && *str != '\0')
1226         {
1227                 if ((str = parse_quoted_value(str, &name, truncate)) == NULL)
1228                 {
1229                         list_free(*name_list);
1230                         return NULL;
1231                 }
1232
1233                 *name_list = lappend(*name_list, name);
1234                 skip_space(str);
1235
1236                 if (keyword == HINT_KEYWORD_INDEXSCANREGEXP ||
1237 #if PG_VERSION_NUM >= 90200
1238                         keyword == HINT_KEYWORD_INDEXONLYSCANREGEXP ||
1239 #endif
1240                         keyword == HINT_KEYWORD_BITMAPSCANREGEXP ||
1241                         keyword == HINT_KEYWORD_SET)
1242                 {
1243                         truncate = false;
1244                 }
1245         }
1246
1247         if ((str = skip_parenthesis(str, ')')) == NULL)
1248                 return NULL;
1249         return str;
1250 }
1251
1252 static void
1253 parse_hints(HintState *hstate, Query *parse, const char *str)
1254 {
1255         StringInfoData  buf;
1256         char               *head;
1257
1258         initStringInfo(&buf);
1259         while (*str != '\0')
1260         {
1261                 const HintParser *parser;
1262
1263                 /* in error message, we output the comment including the keyword. */
1264                 head = (char *) str;
1265
1266                 /* parse only the keyword of the hint. */
1267                 resetStringInfo(&buf);
1268                 str = parse_keyword(str, &buf);
1269
1270                 for (parser = parsers; parser->keyword != NULL; parser++)
1271                 {
1272                         char   *keyword = parser->keyword;
1273                         Hint   *hint;
1274
1275                         if (strcasecmp(buf.data, keyword) != 0)
1276                                 continue;
1277
1278                         hint = parser->create_func(head, keyword, parser->hint_keyword);
1279
1280                         /* parser of each hint does parse in a parenthesis. */
1281                         if ((str = hint->parse_func(hint, hstate, parse, str)) == NULL)
1282                         {
1283                                 hint->delete_func(hint);
1284                                 pfree(buf.data);
1285                                 return;
1286                         }
1287
1288                         /*
1289                          * Add hint information into all_hints array.  If we don't have
1290                          * enough space, double the array.
1291                          */
1292                         if (hstate->nall_hints == 0)
1293                         {
1294                                 hstate->max_all_hints = HINT_ARRAY_DEFAULT_INITSIZE;
1295                                 hstate->all_hints = (Hint **)
1296                                         palloc(sizeof(Hint *) * hstate->max_all_hints);
1297                         }
1298                         else if (hstate->nall_hints == hstate->max_all_hints)
1299                         {
1300                                 hstate->max_all_hints *= 2;
1301                                 hstate->all_hints = (Hint **)
1302                                         repalloc(hstate->all_hints,
1303                                                          sizeof(Hint *) * hstate->max_all_hints);
1304                         }
1305
1306                         hstate->all_hints[hstate->nall_hints] = hint;
1307                         hstate->nall_hints++;
1308
1309                         skip_space(str);
1310
1311                         break;
1312                 }
1313
1314                 if (parser->keyword == NULL)
1315                 {
1316                         hint_ereport(head,
1317                                                  ("Unrecognized hint keyword \"%s\".", buf.data));
1318                         pfree(buf.data);
1319                         return;
1320                 }
1321         }
1322
1323         pfree(buf.data);
1324 }
1325
1326
1327 /* search hint. */
1328 static const char *
1329 search_hints(const char *client_query,
1330                          const char *client_application)
1331 {
1332         const char *search_query =
1333                 "SELECT hints "
1334                 "  FROM hint_plan.hints "
1335                 " WHERE norm_query_string = $1 "
1336                 "   AND ( application_name = $2 "
1337                 "    OR application_name = '' ) "
1338                 " ORDER BY application_name DESC";
1339         static SPIPlanPtr plan = NULL;
1340         int             ret;
1341         char   *hints = NULL;
1342         Oid             argtypes[2] = { TEXTOID, TEXTOID };
1343         Datum   values[2];
1344         bool    nulls[2] = { false, false };
1345         text   *qry;
1346         text   *app;
1347
1348         ret = SPI_connect();
1349         if (ret != SPI_OK_CONNECT)
1350                 elog(ERROR, "pg_hint_plan: SPI_connect => %d", ret);
1351
1352         if (plan == NULL)
1353         {
1354                 SPIPlanPtr      p;
1355                 p = SPI_prepare(search_query, 2, argtypes);
1356                 if (p == NULL)
1357                         elog(ERROR, "pg_hint_plan: SPI_prepare => %d", SPI_result);
1358                 plan = SPI_saveplan(p);
1359                 SPI_freeplan(p);
1360         }
1361
1362         qry = cstring_to_text(client_query);
1363         app = cstring_to_text(client_application);
1364         values[0] = PointerGetDatum(qry);
1365         values[1] = PointerGetDatum(app);
1366
1367         pg_hint_plan_enable_hint = false;
1368         ret = SPI_execute_plan(plan, values, nulls, true, 1);
1369         pg_hint_plan_enable_hint = true;
1370         if (ret != SPI_OK_SELECT)
1371                 elog(ERROR, "pg_hint_plan: SPI_execute_plan => %d", ret);
1372
1373         if (SPI_processed > 0)
1374         {
1375                 hints = pstrdup(SPI_getvalue(SPI_tuptable->vals[0],
1376                                                                            SPI_tuptable->tupdesc, 1));
1377         }
1378         SPI_finish();
1379
1380         return hints;
1381 }
1382
1383 /*
1384  * Do basic parsing of the query head comment.
1385  */
1386 static HintState *
1387 parse_head_comment(Query *parse)
1388 {
1389         const char *p;
1390         const char *hint_head;
1391         char       *head;
1392         char       *tail;
1393         int                     len;
1394         int                     i;
1395         HintState   *hstate;
1396
1397         /* get client-supplied query string. */
1398         if (stmt_name)
1399         {
1400                 PreparedStatement  *entry;
1401
1402                 entry = FetchPreparedStatement(stmt_name, true);
1403                 p = entry->plansource->query_string;
1404         }
1405         else
1406                 p = debug_query_string;
1407
1408         if (p == NULL)
1409                 return NULL;
1410
1411         /* extract query head comment. */
1412         hint_head = strstr(p, HINT_START);
1413         if (hint_head == NULL)
1414                 return NULL;
1415         for (;p < hint_head; p++)
1416         {
1417                 /*
1418                  * Allow these characters precedes hint comment:
1419                  *   - digits
1420                  *   - alphabets which are in ASCII range
1421                  *   - space, tabs and new-lines
1422                  *   - underscores, for identifier
1423                  *   - commas, for SELECT clause, EXPLAIN and PREPARE
1424                  *   - parentheses, for EXPLAIN and PREPARE
1425                  *
1426                  * Note that we don't use isalpha() nor isalnum() in ctype.h here to
1427                  * avoid behavior which depends on locale setting.
1428                  */
1429                 if (!(*p >= '0' && *p <= '9') &&
1430                         !(*p >= 'A' && *p <= 'Z') &&
1431                         !(*p >= 'a' && *p <= 'z') &&
1432                         !isspace(*p) &&
1433                         *p != '_' &&
1434                         *p != ',' &&
1435                         *p != '(' && *p != ')')
1436                         return NULL;
1437         }
1438
1439         len = strlen(HINT_START);
1440         head = (char *) p;
1441         p += len;
1442         skip_space(p);
1443
1444         /* find hint end keyword. */
1445         if ((tail = strstr(p, HINT_END)) == NULL)
1446         {
1447                 hint_ereport(head, ("Unterminated block comment."));
1448                 return NULL;
1449         }
1450
1451         /* We don't support nested block comments. */
1452         if ((head = strstr(p, BLOCK_COMMENT_START)) != NULL && head < tail)
1453         {
1454                 hint_ereport(head, ("Nested block comments are not supported."));
1455                 return NULL;
1456         }
1457
1458         /* Make a copy of hint. */
1459         len = tail - p;
1460         head = palloc(len + 1);
1461         memcpy(head, p, len);
1462         head[len] = '\0';
1463         p = head;
1464
1465         hstate = HintStateCreate();
1466         hstate->hint_str = head;
1467
1468         /* parse each hint. */
1469         parse_hints(hstate, parse, p);
1470
1471         /* When nothing specified a hint, we free HintState and returns NULL. */
1472         if (hstate->nall_hints == 0)
1473         {
1474                 HintStateDelete(hstate);
1475                 return NULL;
1476         }
1477
1478         /* Sort hints in order of original position. */
1479         qsort(hstate->all_hints, hstate->nall_hints, sizeof(Hint *),
1480                   HintCmpWithPos);
1481
1482         /* Count number of hints per hint-type. */
1483         for (i = 0; i < hstate->nall_hints; i++)
1484         {
1485                 Hint   *cur_hint = hstate->all_hints[i];
1486                 hstate->num_hints[cur_hint->type]++;
1487         }
1488
1489         /*
1490          * If an object (or a set of objects) has multiple hints of same hint-type,
1491          * only the last hint is valid and others are igonred in planning.
1492          * Hints except the last are marked as 'duplicated' to remember the order.
1493          */
1494         for (i = 0; i < hstate->nall_hints - 1; i++)
1495         {
1496                 Hint   *cur_hint = hstate->all_hints[i];
1497                 Hint   *next_hint = hstate->all_hints[i + 1];
1498
1499                 /*
1500                  * Leading hint is marked as 'duplicated' in transform_join_hints.
1501                  */
1502                 if (cur_hint->type == HINT_TYPE_LEADING &&
1503                         next_hint->type == HINT_TYPE_LEADING)
1504                         continue;
1505
1506                 /*
1507                  * Note that we need to pass addresses of hint pointers, because
1508                  * HintCmp is designed to sort array of Hint* by qsort.
1509                  */
1510                 if (HintCmp(&cur_hint, &next_hint) == 0)
1511                 {
1512                         hint_ereport(cur_hint->hint_str,
1513                                                  ("Conflict %s hint.", HintTypeName[cur_hint->type]));
1514                         cur_hint->state = HINT_STATE_DUPLICATION;
1515                 }
1516         }
1517
1518         /*
1519          * Make sure that per-type array pointers point proper position in the
1520          * array which consists of all hints.
1521          */
1522         hstate->scan_hints = (ScanMethodHint **) hstate->all_hints;
1523         hstate->join_hints = (JoinMethodHint **) (hstate->scan_hints +
1524                 hstate->num_hints[HINT_TYPE_SCAN_METHOD]);
1525         hstate->leading_hint = (LeadingHint **) (hstate->join_hints +
1526                 hstate->num_hints[HINT_TYPE_JOIN_METHOD]);
1527         hstate->set_hints = (SetHint **) (hstate->leading_hint +
1528                 hstate->num_hints[HINT_TYPE_LEADING]);
1529
1530         return hstate;
1531 }
1532
1533 /*
1534  * Parse inside of parentheses of scan-method hints.
1535  */
1536 static const char *
1537 ScanMethodHintParse(ScanMethodHint *hint, HintState *hstate, Query *parse,
1538                                         const char *str)
1539 {
1540         const char         *keyword = hint->base.keyword;
1541         HintKeyword             hint_keyword = hint->base.hint_keyword;
1542         List               *name_list = NIL;
1543         int                             length;
1544
1545         if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
1546                 return NULL;
1547
1548         /* Parse relation name and index name(s) if given hint accepts. */
1549         length = list_length(name_list);
1550         if (length > 0)
1551         {
1552                 hint->relname = linitial(name_list);
1553                 hint->indexnames = list_delete_first(name_list);
1554
1555                 /* check whether the hint accepts index name(s). */
1556                 if (length != 1 &&
1557                         hint_keyword != HINT_KEYWORD_INDEXSCAN &&
1558                         hint_keyword != HINT_KEYWORD_INDEXSCANREGEXP &&
1559 #if PG_VERSION_NUM >= 90200
1560                         hint_keyword != HINT_KEYWORD_INDEXONLYSCAN &&
1561                         hint_keyword != HINT_KEYWORD_INDEXONLYSCANREGEXP &&
1562 #endif
1563                         hint_keyword != HINT_KEYWORD_BITMAPSCAN &&
1564                         hint_keyword != HINT_KEYWORD_BITMAPSCANREGEXP)
1565                 {
1566                         hint_ereport(str,
1567                                                  ("%s hint accepts only one relation.",
1568                                                   hint->base.keyword));
1569                         hint->base.state = HINT_STATE_ERROR;
1570                         return str;
1571                 }
1572         }
1573         else
1574         {
1575                 hint_ereport(str,
1576                                          ("%s hint requires a relation.",
1577                                           hint->base.keyword));
1578                 hint->base.state = HINT_STATE_ERROR;
1579                 return str;
1580         }
1581
1582         /* Set a bit for specified hint. */
1583         switch (hint_keyword)
1584         {
1585                 case HINT_KEYWORD_SEQSCAN:
1586                         hint->enforce_mask = ENABLE_SEQSCAN;
1587                         break;
1588                 case HINT_KEYWORD_INDEXSCAN:
1589                         hint->enforce_mask = ENABLE_INDEXSCAN;
1590                         break;
1591                 case HINT_KEYWORD_INDEXSCANREGEXP:
1592                         hint->enforce_mask = ENABLE_INDEXSCAN;
1593                         hint->regexp = true;
1594                         break;
1595                 case HINT_KEYWORD_BITMAPSCAN:
1596                         hint->enforce_mask = ENABLE_BITMAPSCAN;
1597                         break;
1598                 case HINT_KEYWORD_BITMAPSCANREGEXP:
1599                         hint->enforce_mask = ENABLE_BITMAPSCAN;
1600                         hint->regexp = true;
1601                         break;
1602                 case HINT_KEYWORD_TIDSCAN:
1603                         hint->enforce_mask = ENABLE_TIDSCAN;
1604                         break;
1605                 case HINT_KEYWORD_NOSEQSCAN:
1606                         hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_SEQSCAN;
1607                         break;
1608                 case HINT_KEYWORD_NOINDEXSCAN:
1609                         hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXSCAN;
1610                         break;
1611                 case HINT_KEYWORD_NOBITMAPSCAN:
1612                         hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_BITMAPSCAN;
1613                         break;
1614                 case HINT_KEYWORD_NOTIDSCAN:
1615                         hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_TIDSCAN;
1616                         break;
1617 #if PG_VERSION_NUM >= 90200
1618                 case HINT_KEYWORD_INDEXONLYSCAN:
1619                         hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
1620                         break;
1621                 case HINT_KEYWORD_INDEXONLYSCANREGEXP:
1622                         hint->enforce_mask = ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN;
1623                         hint->regexp = true;
1624                         break;
1625                 case HINT_KEYWORD_NOINDEXONLYSCAN:
1626                         hint->enforce_mask = ENABLE_ALL_SCAN ^ ENABLE_INDEXONLYSCAN;
1627                         break;
1628 #endif
1629                 default:
1630                         hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
1631                         return NULL;
1632                         break;
1633         }
1634
1635         return str;
1636 }
1637
1638 static const char *
1639 JoinMethodHintParse(JoinMethodHint *hint, HintState *hstate, Query *parse,
1640                                         const char *str)
1641 {
1642         const char         *keyword = hint->base.keyword;
1643         HintKeyword             hint_keyword = hint->base.hint_keyword;
1644         List               *name_list = NIL;
1645
1646         if ((str = parse_parentheses(str, &name_list, hint_keyword)) == NULL)
1647                 return NULL;
1648
1649         hint->nrels = list_length(name_list);
1650
1651         if (hint->nrels > 0)
1652         {
1653                 ListCell   *l;
1654                 int                     i = 0;
1655
1656                 /*
1657                  * Transform relation names from list to array to sort them with qsort
1658                  * after.
1659                  */
1660                 hint->relnames = palloc(sizeof(char *) * hint->nrels);
1661                 foreach (l, name_list)
1662                 {
1663                         hint->relnames[i] = lfirst(l);
1664                         i++;
1665                 }
1666         }
1667
1668         list_free(name_list);
1669
1670         /* A join hint requires at least two relations */
1671         if (hint->nrels < 2)
1672         {
1673                 hint_ereport(str,
1674                                          ("%s hint requires at least two relations.",
1675                                           hint->base.keyword));
1676                 hint->base.state = HINT_STATE_ERROR;
1677                 return str;
1678         }
1679
1680         /* Sort hints in alphabetical order of relation names. */
1681         qsort(hint->relnames, hint->nrels, sizeof(char *), RelnameCmp);
1682
1683         switch (hint_keyword)
1684         {
1685                 case HINT_KEYWORD_NESTLOOP:
1686                         hint->enforce_mask = ENABLE_NESTLOOP;
1687                         break;
1688                 case HINT_KEYWORD_MERGEJOIN:
1689                         hint->enforce_mask = ENABLE_MERGEJOIN;
1690                         break;
1691                 case HINT_KEYWORD_HASHJOIN:
1692                         hint->enforce_mask = ENABLE_HASHJOIN;
1693                         break;
1694                 case HINT_KEYWORD_NONESTLOOP:
1695                         hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_NESTLOOP;
1696                         break;
1697                 case HINT_KEYWORD_NOMERGEJOIN:
1698                         hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_MERGEJOIN;
1699                         break;
1700                 case HINT_KEYWORD_NOHASHJOIN:
1701                         hint->enforce_mask = ENABLE_ALL_JOIN ^ ENABLE_HASHJOIN;
1702                         break;
1703                 default:
1704                         hint_ereport(str, ("Unrecognized hint keyword \"%s\".", keyword));
1705                         return NULL;
1706                         break;
1707         }
1708
1709         return str;
1710 }
1711
1712 static bool
1713 OuterInnerPairCheck(OuterInnerRels *outer_inner)
1714 {
1715         ListCell *l;
1716         if (outer_inner->outer_inner_pair == NIL)
1717         {
1718                 if (outer_inner->relation)
1719                         return true;
1720                 else
1721                         return false;
1722         }
1723
1724         if (list_length(outer_inner->outer_inner_pair) == 2)
1725         {
1726                 foreach(l, outer_inner->outer_inner_pair)
1727                 {
1728                         if (!OuterInnerPairCheck(lfirst(l)))
1729                                 return false;
1730                 }
1731         }
1732         else
1733                 return false;
1734
1735         return true;
1736 }
1737
1738 static List *
1739 OuterInnerList(OuterInnerRels *outer_inner)
1740 {
1741         List               *outer_inner_list = NIL;
1742         ListCell           *l;
1743         OuterInnerRels *outer_inner_rels;
1744
1745         foreach(l, outer_inner->outer_inner_pair)
1746         {
1747                 outer_inner_rels = (OuterInnerRels *)(lfirst(l));
1748
1749                 if (outer_inner_rels->relation != NULL)
1750                         outer_inner_list = lappend(outer_inner_list,
1751                                                                            outer_inner_rels->relation);
1752                 else
1753                         outer_inner_list = list_concat(outer_inner_list,
1754                                                                                    OuterInnerList(outer_inner_rels));
1755         }
1756         return outer_inner_list;
1757 }
1758
1759 static const char *
1760 LeadingHintParse(LeadingHint *hint, HintState *hstate, Query *parse,
1761                                  const char *str)
1762 {
1763         List               *name_list = NIL;
1764         OuterInnerRels *outer_inner = NULL;
1765
1766         if ((str = parse_parentheses_Leading(str, &name_list, &outer_inner)) ==
1767                 NULL)
1768                 return NULL;
1769
1770         if (outer_inner != NULL)
1771                 name_list = OuterInnerList(outer_inner);
1772
1773         hint->relations = name_list;
1774         hint->outer_inner = outer_inner;
1775
1776         /* A Leading hint requires at least two relations */
1777         if ( hint->outer_inner == NULL && list_length(hint->relations) < 2)
1778         {
1779                 hint_ereport(hint->base.hint_str,
1780                                          ("%s hint requires at least two relations.",
1781                                           HINT_LEADING));
1782                 hint->base.state = HINT_STATE_ERROR;
1783         }
1784         else if (hint->outer_inner != NULL &&
1785                          !OuterInnerPairCheck(hint->outer_inner))
1786         {
1787                 hint_ereport(hint->base.hint_str,
1788                                          ("%s hint requires two sets of relations when parentheses nests.",
1789                                           HINT_LEADING));
1790                 hint->base.state = HINT_STATE_ERROR;
1791         }
1792
1793         return str;
1794 }
1795
1796 static const char *
1797 SetHintParse(SetHint *hint, HintState *hstate, Query *parse, const char *str)
1798 {
1799         List   *name_list = NIL;
1800
1801         if ((str = parse_parentheses(str, &name_list, hint->base.hint_keyword))
1802                 == NULL)
1803                 return NULL;
1804
1805         hint->words = name_list;
1806
1807         /* We need both name and value to set GUC parameter. */
1808         if (list_length(name_list) == 2)
1809         {
1810                 hint->name = linitial(name_list);
1811                 hint->value = lsecond(name_list);
1812         }
1813         else
1814         {
1815                 hint_ereport(hint->base.hint_str,
1816                                          ("%s hint requires name and value of GUC parameter.",
1817                                           HINT_SET));
1818                 hint->base.state = HINT_STATE_ERROR;
1819         }
1820
1821         return str;
1822 }
1823
1824 /*
1825  * set GUC parameter functions
1826  */
1827
1828 static int
1829 set_config_option_wrapper(const char *name, const char *value,
1830                                                   GucContext context, GucSource source,
1831                                                   GucAction action, bool changeVal, int elevel)
1832 {
1833         int                             result = 0;
1834         MemoryContext   ccxt = CurrentMemoryContext;
1835
1836         PG_TRY();
1837         {
1838 #if PG_VERSION_NUM >= 90200
1839                 result = set_config_option(name, value, context, source,
1840                                                                    action, changeVal, 0);
1841 #else
1842                 result = set_config_option(name, value, context, source,
1843                                                                    action, changeVal);
1844 #endif
1845         }
1846         PG_CATCH();
1847         {
1848                 ErrorData          *errdata;
1849
1850                 /* Save error info */
1851                 MemoryContextSwitchTo(ccxt);
1852                 errdata = CopyErrorData();
1853                 FlushErrorState();
1854
1855                 ereport(elevel, (errcode(errdata->sqlerrcode),
1856                                 errmsg("%s", errdata->message),
1857                                 errdata->detail ? errdetail("%s", errdata->detail) : 0,
1858                                 errdata->hint ? errhint("%s", errdata->hint) : 0));
1859                 FreeErrorData(errdata);
1860         }
1861         PG_END_TRY();
1862
1863         return result;
1864 }
1865
1866 static int
1867 set_config_options(SetHint **options, int noptions, GucContext context)
1868 {
1869         int     i;
1870         int     save_nestlevel;
1871
1872         save_nestlevel = NewGUCNestLevel();
1873
1874         for (i = 0; i < noptions; i++)
1875         {
1876                 SetHint    *hint = options[i];
1877                 int                     result;
1878
1879                 if (!hint_state_enabled(hint))
1880                         continue;
1881
1882                 result = set_config_option_wrapper(hint->name, hint->value, context,
1883                                                                                    PGC_S_SESSION, GUC_ACTION_SAVE, true,
1884                                                                                    pg_hint_plan_parse_messages);
1885                 if (result != 0)
1886                         hint->base.state = HINT_STATE_USED;
1887                 else
1888                         hint->base.state = HINT_STATE_ERROR;
1889         }
1890
1891         return save_nestlevel;
1892 }
1893
1894 #define SET_CONFIG_OPTION(name, type_bits) \
1895         set_config_option_wrapper((name), \
1896                 (mask & (type_bits)) ? "true" : "false", \
1897                 context, PGC_S_SESSION, GUC_ACTION_SAVE, true, ERROR)
1898
1899 static void
1900 set_scan_config_options(unsigned char enforce_mask, GucContext context)
1901 {
1902         unsigned char   mask;
1903
1904         if (enforce_mask == ENABLE_SEQSCAN || enforce_mask == ENABLE_INDEXSCAN ||
1905                 enforce_mask == ENABLE_BITMAPSCAN || enforce_mask == ENABLE_TIDSCAN
1906 #if PG_VERSION_NUM >= 90200
1907                 || enforce_mask == (ENABLE_INDEXSCAN | ENABLE_INDEXONLYSCAN)
1908 #endif
1909                 )
1910                 mask = enforce_mask;
1911         else
1912                 mask = enforce_mask & current_hint->init_scan_mask;
1913
1914         SET_CONFIG_OPTION("enable_seqscan", ENABLE_SEQSCAN);
1915         SET_CONFIG_OPTION("enable_indexscan", ENABLE_INDEXSCAN);
1916         SET_CONFIG_OPTION("enable_bitmapscan", ENABLE_BITMAPSCAN);
1917         SET_CONFIG_OPTION("enable_tidscan", ENABLE_TIDSCAN);
1918 #if PG_VERSION_NUM >= 90200
1919         SET_CONFIG_OPTION("enable_indexonlyscan", ENABLE_INDEXONLYSCAN);
1920 #endif
1921 }
1922
1923 static void
1924 set_join_config_options(unsigned char enforce_mask, GucContext context)
1925 {
1926         unsigned char   mask;
1927
1928         if (enforce_mask == ENABLE_NESTLOOP || enforce_mask == ENABLE_MERGEJOIN ||
1929                 enforce_mask == ENABLE_HASHJOIN)
1930                 mask = enforce_mask;
1931         else
1932                 mask = enforce_mask & current_hint->init_join_mask;
1933
1934         SET_CONFIG_OPTION("enable_nestloop", ENABLE_NESTLOOP);
1935         SET_CONFIG_OPTION("enable_mergejoin", ENABLE_MERGEJOIN);
1936         SET_CONFIG_OPTION("enable_hashjoin", ENABLE_HASHJOIN);
1937 }
1938
1939 /*
1940  * pg_hint_plan hook functions
1941  */
1942
1943 static void
1944 pg_hint_plan_ProcessUtility(Node *parsetree, const char *queryString,
1945                                                         ParamListInfo params, bool isTopLevel,
1946                                                         DestReceiver *dest, char *completionTag)
1947 {
1948         Node                               *node;
1949
1950         if (!pg_hint_plan_enable_hint)
1951         {
1952                 if (prev_ProcessUtility)
1953                         (*prev_ProcessUtility) (parsetree, queryString, params,
1954                                                                         isTopLevel, dest, completionTag);
1955                 else
1956                         standard_ProcessUtility(parsetree, queryString, params,
1957                                                                         isTopLevel, dest, completionTag);
1958
1959                 return;
1960         }
1961
1962         node = parsetree;
1963         if (IsA(node, ExplainStmt))
1964         {
1965                 /*
1966                  * Draw out parse tree of actual query from Query struct of EXPLAIN
1967                  * statement.
1968                  */
1969                 ExplainStmt        *stmt;
1970                 Query              *query;
1971
1972                 stmt = (ExplainStmt *) node;
1973
1974                 Assert(IsA(stmt->query, Query));
1975                 query = (Query *) stmt->query;
1976
1977                 if (query->commandType == CMD_UTILITY && query->utilityStmt != NULL)
1978                         node = query->utilityStmt;
1979         }
1980
1981         /*
1982          * If the query was a EXECUTE or CREATE TABLE AS EXECUTE, get query string
1983          * specified to preceding PREPARE command to use it as source of hints.
1984          */
1985         if (IsA(node, ExecuteStmt))
1986         {
1987                 ExecuteStmt        *stmt;
1988
1989                 stmt = (ExecuteStmt *) node;
1990                 stmt_name = stmt->name;
1991         }
1992 #if PG_VERSION_NUM >= 90200
1993         /*
1994          * CREATE AS EXECUTE behavior has changed since 9.2, so we must handle it
1995          * specially here.
1996          */
1997         if (IsA(node, CreateTableAsStmt))
1998         {
1999                 CreateTableAsStmt          *stmt;
2000                 Query              *query;
2001
2002                 stmt = (CreateTableAsStmt *) node;
2003                 Assert(IsA(stmt->query, Query));
2004                 query = (Query *) stmt->query;
2005
2006                 if (query->commandType == CMD_UTILITY &&
2007                         IsA(query->utilityStmt, ExecuteStmt))
2008                 {
2009                         ExecuteStmt *estmt = (ExecuteStmt *) query->utilityStmt;
2010                         stmt_name = estmt->name;
2011                 }
2012         }
2013 #endif
2014         if (stmt_name)
2015         {
2016                 PG_TRY();
2017                 {
2018                         if (prev_ProcessUtility)
2019                                 (*prev_ProcessUtility) (parsetree, queryString, params,
2020                                                                                 isTopLevel, dest, completionTag);
2021                         else
2022                                 standard_ProcessUtility(parsetree, queryString, params,
2023                                                                                 isTopLevel, dest, completionTag);
2024                 }
2025                 PG_CATCH();
2026                 {
2027                         stmt_name = NULL;
2028                         PG_RE_THROW();
2029                 }
2030                 PG_END_TRY();
2031
2032                 stmt_name = NULL;
2033
2034                 return;
2035         }
2036
2037         if (prev_ProcessUtility)
2038                 (*prev_ProcessUtility) (parsetree, queryString, params,
2039                                                                 isTopLevel, dest, completionTag);
2040         else
2041                 standard_ProcessUtility(parsetree, queryString, params,
2042                                                                 isTopLevel, dest, completionTag);
2043 }
2044
2045 /*
2046  * Push a hint into hint stack which is implemented with List struct.  Head of
2047  * list is top of stack.
2048  */
2049 static void
2050 push_hint(HintState *hstate)
2051 {
2052         /* Prepend new hint to the list means pushing to stack. */
2053         HintStateStack = lcons(hstate, HintStateStack);
2054
2055         /* Pushed hint is the one which should be used hereafter. */
2056         current_hint = hstate;
2057 }
2058
2059 /* Pop a hint from hint stack.  Popped hint is automatically discarded. */
2060 static void
2061 pop_hint(void)
2062 {
2063         /* Hint stack must not be empty. */
2064         if(HintStateStack == NIL)
2065                 elog(ERROR, "hint stack is empty");
2066
2067         /*
2068          * Take a hint at the head from the list, and free it.  Switch current_hint
2069          * to point new head (NULL if the list is empty).
2070          */
2071         HintStateStack = list_delete_first(HintStateStack);
2072         HintStateDelete(current_hint);
2073         if(HintStateStack == NIL)
2074                 current_hint = NULL;
2075         else
2076                 current_hint = (HintState *) lfirst(list_head(HintStateStack));
2077 }
2078
2079 static PlannedStmt *
2080 pg_hint_plan_planner(Query *parse, int cursorOptions, ParamListInfo boundParams)
2081 {
2082         const char         *hints;
2083         int                             save_nestlevel;
2084         PlannedStmt        *result;
2085         HintState          *hstate;
2086
2087         /*
2088          * Use standard planner if pg_hint_plan is disabled.  Other hook functions
2089          * try to change plan with current_hint if any, so set it to NULL.
2090          */
2091         if (!pg_hint_plan_enable_hint)
2092         {
2093                 current_hint = NULL;
2094
2095                 if (prev_planner)
2096                         return (*prev_planner) (parse, cursorOptions, boundParams);
2097                 else
2098                         return standard_planner(parse, cursorOptions, boundParams);
2099         }
2100
2101         /*
2102          *search hint.
2103          * TODO: replace "app1" with current application_name setting of the
2104          * session.
2105          * XXX: use something instead of debug_query_string?
2106          */
2107         hints = search_hints(debug_query_string, application_name);
2108         elog(LOG,
2109                  "pg_hint_plan: search_hints [%s][%s]=>[%s]",
2110                  debug_query_string, application_name,
2111                  hints ? hints : "(none)");
2112
2113         /* Create hint struct from parse tree. */
2114         hstate = parse_head_comment(parse);
2115
2116         /*
2117          * Use standard planner if the statement has not valid hint.  Other hook
2118          * functions try to change plan with current_hint if any, so set it to
2119          * NULL.
2120          */
2121         if (!hstate)
2122         {
2123                 current_hint = NULL;
2124
2125                 if (prev_planner)
2126                         return (*prev_planner) (parse, cursorOptions, boundParams);
2127                 else
2128                         return standard_planner(parse, cursorOptions, boundParams);
2129         }
2130
2131         /*
2132          * Push new hint struct to the hint stack to disable previous hint context.
2133          */
2134         push_hint(hstate);
2135
2136         /* Set GUC parameters which are specified with Set hint. */
2137         save_nestlevel = set_config_options(current_hint->set_hints,
2138                                                                                 current_hint->num_hints[HINT_TYPE_SET],
2139                                                                                 current_hint->context);
2140
2141         if (enable_seqscan)
2142                 current_hint->init_scan_mask |= ENABLE_SEQSCAN;
2143         if (enable_indexscan)
2144                 current_hint->init_scan_mask |= ENABLE_INDEXSCAN;
2145         if (enable_bitmapscan)
2146                 current_hint->init_scan_mask |= ENABLE_BITMAPSCAN;
2147         if (enable_tidscan)
2148                 current_hint->init_scan_mask |= ENABLE_TIDSCAN;
2149 #if PG_VERSION_NUM >= 90200
2150         if (enable_indexonlyscan)
2151                 current_hint->init_scan_mask |= ENABLE_INDEXONLYSCAN;
2152 #endif
2153         if (enable_nestloop)
2154                 current_hint->init_join_mask |= ENABLE_NESTLOOP;
2155         if (enable_mergejoin)
2156                 current_hint->init_join_mask |= ENABLE_MERGEJOIN;
2157         if (enable_hashjoin)
2158                 current_hint->init_join_mask |= ENABLE_HASHJOIN;
2159
2160         /*
2161          * Use PG_TRY mechanism to recover GUC parameters and current_hint to the
2162          * state when this planner started when error occurred in planner.
2163          */
2164         PG_TRY();
2165         {
2166                 if (prev_planner)
2167                         result = (*prev_planner) (parse, cursorOptions, boundParams);
2168                 else
2169                         result = standard_planner(parse, cursorOptions, boundParams);
2170         }
2171         PG_CATCH();
2172         {
2173                 /*
2174                  * Rollback changes of GUC parameters, and pop current hint context
2175                  * from hint stack to rewind the state.
2176                  */
2177                 AtEOXact_GUC(true, save_nestlevel);
2178                 pop_hint();
2179                 PG_RE_THROW();
2180         }
2181         PG_END_TRY();
2182
2183         /* Print hint in debug mode. */
2184         if (pg_hint_plan_debug_print)
2185                 HintStateDump(current_hint);
2186
2187         /*
2188          * Rollback changes of GUC parameters, and pop current hint context from
2189          * hint stack to rewind the state.
2190          */
2191         AtEOXact_GUC(true, save_nestlevel);
2192         pop_hint();
2193
2194         return result;
2195 }
2196
2197 /*
2198  * Return scan method hint which matches given aliasname.
2199  */
2200 static ScanMethodHint *
2201 find_scan_hint(PlannerInfo *root, RelOptInfo *rel)
2202 {
2203         RangeTblEntry  *rte;
2204         int                             i;
2205
2206         /*
2207          * We can't apply scan method hint if the relation is:
2208          *   - not a base relation
2209          *   - not an ordinary relation (such as join and subquery)
2210          */
2211         if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
2212                 return NULL;
2213
2214         rte = root->simple_rte_array[rel->relid];
2215
2216         /* We can't force scan method of foreign tables */
2217         if (rte->relkind == RELKIND_FOREIGN_TABLE)
2218                 return NULL;
2219
2220         /* Find scan method hint, which matches given names, from the list. */
2221         for (i = 0; i < current_hint->num_hints[HINT_TYPE_SCAN_METHOD]; i++)
2222         {
2223                 ScanMethodHint *hint = current_hint->scan_hints[i];
2224
2225                 /* We ignore disabled hints. */
2226                 if (!hint_state_enabled(hint))
2227                         continue;
2228
2229                 if (RelnameCmp(&rte->eref->aliasname, &hint->relname) == 0)
2230                         return hint;
2231         }
2232
2233         return NULL;
2234 }
2235
2236 /*
2237  * regexeq
2238  *
2239  * Returns TRUE on match, FALSE on no match.
2240  *
2241  *   s1 --- the data to match against
2242  *   s2 --- the pattern
2243  *
2244  * Because we copy s1 to NameData, make the size of s1 less than NAMEDATALEN.
2245  */
2246 static bool
2247 regexpeq(const char *s1, const char *s2)
2248 {
2249         NameData        name;
2250         text       *regexp;
2251         Datum           result;
2252
2253         strcpy(name.data, s1);
2254         regexp = cstring_to_text(s2);
2255
2256         result = DirectFunctionCall2Coll(nameregexeq,
2257                                                                          DEFAULT_COLLATION_OID,
2258                                                                          NameGetDatum(&name),
2259                                                                          PointerGetDatum(regexp));
2260         return DatumGetBool(result);
2261 }
2262
2263 static void
2264 delete_indexes(ScanMethodHint *hint, RelOptInfo *rel, Oid relationObjectId)
2265 {
2266         ListCell           *cell;
2267         ListCell           *prev;
2268         ListCell           *next;
2269         StringInfoData  buf;
2270
2271         /*
2272          * We delete all the IndexOptInfo list and prevent you from being usable by
2273          * a scan.
2274          */
2275         if (hint->enforce_mask == ENABLE_SEQSCAN ||
2276                 hint->enforce_mask == ENABLE_TIDSCAN)
2277         {
2278                 list_free_deep(rel->indexlist);
2279                 rel->indexlist = NIL;
2280                 hint->base.state = HINT_STATE_USED;
2281
2282                 return;
2283         }
2284
2285         /*
2286          * When a list of indexes is not specified, we just use all indexes.
2287          */
2288         if (hint->indexnames == NIL)
2289                 return;
2290
2291         /*
2292          * Leaving only an specified index, we delete it from a IndexOptInfo list
2293          * other than it.
2294          */
2295         prev = NULL;
2296         if (pg_hint_plan_debug_print)
2297                 initStringInfo(&buf);
2298
2299         for (cell = list_head(rel->indexlist); cell; cell = next)
2300         {
2301                 IndexOptInfo   *info = (IndexOptInfo *) lfirst(cell);
2302                 char               *indexname = get_rel_name(info->indexoid);
2303                 ListCell           *l;
2304                 bool                    use_index = false;
2305
2306                 next = lnext(cell);
2307
2308                 foreach(l, hint->indexnames)
2309                 {
2310                         char   *hintname = (char *) lfirst(l);
2311                         bool    result;
2312
2313                         if (hint->regexp)
2314                                 result = regexpeq(indexname, hintname);
2315                         else
2316                                 result = RelnameCmp(&indexname, &hintname) == 0;
2317
2318                         if (result)
2319                         {
2320                                 use_index = true;
2321                                 if (pg_hint_plan_debug_print)
2322                                 {
2323                                         appendStringInfoCharMacro(&buf, ' ');
2324                                         quote_value(&buf, indexname);
2325                                 }
2326
2327                                 break;
2328                         }
2329                 }
2330
2331                 /*
2332                  * to make the index a candidate when definition of this index is
2333                  * matched with the index's definition of current_hint.
2334                  */
2335                 if (OidIsValid(relationObjectId) && !use_index)
2336                 {
2337                         foreach(l, current_hint->parent_index_infos)
2338                         {
2339                                 int                                     i;
2340                                 HeapTuple                       ht_idx;
2341                                 ParentIndexInfo    *p_info = (ParentIndexInfo *)lfirst(l);
2342
2343                                 /* check to match the parameter of unique */
2344                                 if (p_info->indisunique != info->unique)
2345                                         continue;
2346
2347                                 /* check to match the parameter of index's method */
2348                                 if (p_info->method != info->relam)
2349                                         continue;
2350
2351                                 /* to check to match the indexkey's configuration */
2352                                 if ((list_length(p_info->column_names)) !=
2353                                          info->ncolumns)
2354                                         continue;
2355
2356                                 /* check to match the indexkey's configuration */
2357                                 for (i = 0; i < info->ncolumns; i++)
2358                                 {
2359                                         char       *c_attname = NULL;
2360                                         char       *p_attname = NULL;
2361
2362                                         p_attname =
2363                                                 list_nth(p_info->column_names, i);
2364
2365                                         /* both are expressions */
2366                                         if (info->indexkeys[i] == 0 && !p_attname)
2367                                                 continue;
2368
2369                                         /* one's column is expression, the other is not */
2370                                         if (info->indexkeys[i] == 0 || !p_attname)
2371                                                 break;
2372
2373                                         c_attname = get_attname(relationObjectId,
2374                                                                                                 info->indexkeys[i]);
2375
2376                                         if (strcmp(p_attname, c_attname) != 0)
2377                                                 break;
2378
2379                                         if (p_info->indcollation[i] != info->indexcollations[i])
2380                                                 break;
2381
2382                                         if (p_info->opclass[i] != info->opcintype[i])
2383                                                 break;
2384
2385                                         if (((p_info->indoption[i] & INDOPTION_DESC) != 0) !=
2386                                                 info->reverse_sort[i])
2387                                                 break;
2388
2389                                         if (((p_info->indoption[i] & INDOPTION_NULLS_FIRST) != 0) !=
2390                                                 info->nulls_first[i])
2391                                                 break;
2392
2393                                 }
2394
2395                                 if (i != info->ncolumns)
2396                                         continue;
2397
2398                                 if ((p_info->expression_str && (info->indexprs != NIL)) ||
2399                                         (p_info->indpred_str && (info->indpred != NIL)))
2400                                 {
2401                                         /*
2402                                          * Fetch the pg_index tuple by the Oid of the index
2403                                          */
2404                                         ht_idx = SearchSysCache1(INDEXRELID,
2405                                                                                          ObjectIdGetDatum(info->indexoid));
2406
2407                                         /* check to match the expression's parameter of index */
2408                                         if (p_info->expression_str &&
2409                                                 !heap_attisnull(ht_idx, Anum_pg_index_indexprs))
2410                                         {
2411                                                 Datum       exprsDatum;
2412                                                 bool        isnull;
2413                                                 Datum       result;
2414
2415                                                 /*
2416                                                  * to change the expression's parameter of child's
2417                                                  * index to strings
2418                                                  */
2419                                                 exprsDatum = SysCacheGetAttr(INDEXRELID, ht_idx,
2420                                                                                                          Anum_pg_index_indexprs,
2421                                                                                                          &isnull);
2422
2423                                                 result = DirectFunctionCall2(pg_get_expr,
2424                                                                                                          exprsDatum,
2425                                                                                                          ObjectIdGetDatum(
2426                                                                                                                  relationObjectId));
2427
2428                                                 if (strcmp(p_info->expression_str,
2429                                                                    text_to_cstring(DatumGetTextP(result))) != 0)
2430                                                 {
2431                                                         /* Clean up */
2432                                                         ReleaseSysCache(ht_idx);
2433
2434                                                         continue;
2435                                                 }
2436                                         }
2437
2438                                         /* Check to match the predicate's paraameter of index */
2439                                         if (p_info->indpred_str &&
2440                                                 !heap_attisnull(ht_idx, Anum_pg_index_indpred))
2441                                         {
2442                                                 Datum       predDatum;
2443                                                 bool        isnull;
2444                                                 Datum       result;
2445
2446                                                 /*
2447                                                  * to change the predicate's parabeter of child's
2448                                                  * index to strings
2449                                                  */
2450                                                 predDatum = SysCacheGetAttr(INDEXRELID, ht_idx,
2451                                                                                                          Anum_pg_index_indpred,
2452                                                                                                          &isnull);
2453
2454                                                 result = DirectFunctionCall2(pg_get_expr,
2455                                                                                                          predDatum,
2456                                                                                                          ObjectIdGetDatum(
2457                                                                                                                  relationObjectId));
2458
2459                                                 if (strcmp(p_info->indpred_str,
2460                                                                    text_to_cstring(DatumGetTextP(result))) != 0)
2461                                                 {
2462                                                         /* Clean up */
2463                                                         ReleaseSysCache(ht_idx);
2464
2465                                                         continue;
2466                                                 }
2467                                         }
2468
2469                                         /* Clean up */
2470                                         ReleaseSysCache(ht_idx);
2471                                 }
2472                                 else if (p_info->expression_str || (info->indexprs != NIL))
2473                                         continue;
2474                                 else if (p_info->indpred_str || (info->indpred != NIL))
2475                                         continue;
2476
2477                                 use_index = true;
2478
2479                                 /* to log the candidate of index */
2480                                 if (pg_hint_plan_debug_print)
2481                                 {
2482                                         appendStringInfoCharMacro(&buf, ' ');
2483                                         quote_value(&buf, indexname);
2484                                 }
2485
2486                                 break;
2487                         }
2488                 }
2489
2490                 if (!use_index)
2491                         rel->indexlist = list_delete_cell(rel->indexlist, cell, prev);
2492                 else
2493                         prev = cell;
2494
2495                 pfree(indexname);
2496         }
2497
2498         if (pg_hint_plan_debug_print)
2499         {
2500                 char   *relname;
2501                 StringInfoData  rel_buf;
2502
2503                 if (OidIsValid(relationObjectId))
2504                         relname = get_rel_name(relationObjectId);
2505                 else
2506                         relname = hint->relname;
2507
2508                 initStringInfo(&rel_buf);
2509                 quote_value(&rel_buf, relname);
2510
2511                 ereport(LOG,
2512                                 (errmsg("available indexes for %s(%s):%s",
2513                                          hint->base.keyword,
2514                                          rel_buf.data,
2515                                          buf.data)));
2516                 pfree(buf.data);
2517                 pfree(rel_buf.data);
2518         }
2519 }
2520
2521 /*
2522  * Return information of index definition.
2523  */
2524 static ParentIndexInfo *
2525 get_parent_index_info(Oid indexoid, Oid relid)
2526 {
2527         ParentIndexInfo *p_info = palloc(sizeof(ParentIndexInfo));
2528         Relation            indexRelation;
2529         Form_pg_index   index;
2530         char               *attname;
2531         int                             i;
2532
2533         indexRelation = index_open(indexoid, RowExclusiveLock);
2534
2535         index = indexRelation->rd_index;
2536
2537         p_info->indisunique = index->indisunique;
2538         p_info->method = indexRelation->rd_rel->relam;
2539
2540         p_info->column_names = NIL;
2541         p_info->indcollation = (Oid *) palloc(sizeof(Oid) * index->indnatts);
2542         p_info->opclass = (Oid *) palloc(sizeof(Oid) * index->indnatts);
2543         p_info->indoption = (int16 *) palloc(sizeof(Oid) * index->indnatts);
2544
2545         for (i = 0; i < index->indnatts; i++)
2546         {
2547                 attname = get_attname(relid, index->indkey.values[i]);
2548                 p_info->column_names = lappend(p_info->column_names, attname);
2549
2550                 p_info->indcollation[i] = indexRelation->rd_indcollation[i];
2551                 p_info->opclass[i] = indexRelation->rd_opcintype[i];
2552                 p_info->indoption[i] = indexRelation->rd_indoption[i];
2553         }
2554
2555         /*
2556          * to check to match the expression's paraameter of index with child indexes
2557          */
2558         p_info->expression_str = NULL;
2559         if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indexprs))
2560         {
2561                 Datum       exprsDatum;
2562                 bool            isnull;
2563                 Datum           result;
2564
2565                 exprsDatum = SysCacheGetAttr(INDEXRELID, indexRelation->rd_indextuple,
2566                                                                          Anum_pg_index_indexprs, &isnull);
2567
2568                 result = DirectFunctionCall2(pg_get_expr,
2569                                                                          exprsDatum,
2570                                                                          ObjectIdGetDatum(relid));
2571
2572                 p_info->expression_str = text_to_cstring(DatumGetTextP(result));
2573         }
2574
2575         /*
2576          * to check to match the predicate's paraameter of index with child indexes
2577          */
2578         p_info->indpred_str = NULL;
2579         if(!heap_attisnull(indexRelation->rd_indextuple, Anum_pg_index_indpred))
2580         {
2581                 Datum       predDatum;
2582                 bool            isnull;
2583                 Datum           result;
2584
2585                 predDatum = SysCacheGetAttr(INDEXRELID, indexRelation->rd_indextuple,
2586                                                                          Anum_pg_index_indpred, &isnull);
2587
2588                 result = DirectFunctionCall2(pg_get_expr,
2589                                                                          predDatum,
2590                                                                          ObjectIdGetDatum(relid));
2591
2592                 p_info->indpred_str = text_to_cstring(DatumGetTextP(result));
2593         }
2594
2595         index_close(indexRelation, NoLock);
2596
2597         return p_info;
2598 }
2599
2600 static void
2601 pg_hint_plan_get_relation_info(PlannerInfo *root, Oid relationObjectId,
2602                                                            bool inhparent, RelOptInfo *rel)
2603 {
2604         ScanMethodHint *hint;
2605
2606         if (prev_get_relation_info)
2607                 (*prev_get_relation_info) (root, relationObjectId, inhparent, rel);
2608
2609         /* Do nothing if we don't have valid hint in this context. */
2610         if (!current_hint)
2611                 return;
2612
2613         if (inhparent)
2614         {
2615                 /* store does relids of parent table. */
2616                 current_hint->parent_relid = rel->relid;
2617                 current_hint->parent_rel_oid = relationObjectId;
2618         }
2619         else if (current_hint->parent_relid != 0)
2620         {
2621                 /*
2622                  * We use the same GUC parameter if this table is the child table of a
2623                  * table called pg_hint_plan_get_relation_info just before that.
2624                  */
2625                 ListCell   *l;
2626
2627                 /* append_rel_list contains all append rels; ignore others */
2628                 foreach(l, root->append_rel_list)
2629                 {
2630                         AppendRelInfo *appinfo = (AppendRelInfo *) lfirst(l);
2631
2632                         /* This rel is child table. */
2633                         if (appinfo->parent_relid == current_hint->parent_relid &&
2634                                 appinfo->child_relid == rel->relid)
2635                         {
2636                                 if (current_hint->parent_hint)
2637                                         delete_indexes(current_hint->parent_hint, rel,
2638                                                                    relationObjectId);
2639
2640                                 return;
2641                         }
2642                 }
2643
2644                 /* This rel is not inherit table. */
2645                 current_hint->parent_relid = 0;
2646                 current_hint->parent_rel_oid = InvalidOid;
2647                 current_hint->parent_hint = NULL;
2648         }
2649
2650         /*
2651          * If scan method hint was given, reset GUC parameters which control
2652          * planner behavior about choosing scan methods.
2653          */
2654         if ((hint = find_scan_hint(root, rel)) == NULL)
2655         {
2656                 set_scan_config_options(current_hint->init_scan_mask,
2657                                                                 current_hint->context);
2658                 return;
2659         }
2660         set_scan_config_options(hint->enforce_mask, current_hint->context);
2661         hint->base.state = HINT_STATE_USED;
2662
2663         if (inhparent)
2664         {
2665                 Relation    relation;
2666                 List       *indexoidlist;
2667                 ListCell   *l;
2668
2669                 current_hint->parent_hint = hint;
2670
2671                 relation = heap_open(relationObjectId, NoLock);
2672                 indexoidlist = RelationGetIndexList(relation);
2673
2674                 foreach(l, indexoidlist)
2675                 {
2676                         Oid         indexoid = lfirst_oid(l);
2677                         char       *indexname = get_rel_name(indexoid);
2678                         bool        use_index = false;
2679                         ListCell   *lc;
2680                         ParentIndexInfo *parent_index_info;
2681
2682                         foreach(lc, hint->indexnames)
2683                         {
2684                                 if (RelnameCmp(&indexname, &lfirst(lc)) == 0)
2685                                 {
2686                                         use_index = true;
2687                                         break;
2688                                 }
2689                         }
2690                         if (!use_index)
2691                                 continue;
2692
2693                         parent_index_info = get_parent_index_info(indexoid,
2694                                                                                                           relationObjectId);
2695                         current_hint->parent_index_infos =
2696                                 lappend(current_hint->parent_index_infos, parent_index_info);
2697                 }
2698                 heap_close(relation, NoLock);
2699         }
2700         else
2701                 delete_indexes(hint, rel, InvalidOid);
2702 }
2703
2704 /*
2705  * Return index of relation which matches given aliasname, or 0 if not found.
2706  * If same aliasname was used multiple times in a query, return -1.
2707  */
2708 static int
2709 find_relid_aliasname(PlannerInfo *root, char *aliasname, List *initial_rels,
2710                                          const char *str)
2711 {
2712         int             i;
2713         Index   found = 0;
2714
2715         for (i = 1; i < root->simple_rel_array_size; i++)
2716         {
2717                 ListCell   *l;
2718
2719                 if (root->simple_rel_array[i] == NULL)
2720                         continue;
2721
2722                 Assert(i == root->simple_rel_array[i]->relid);
2723
2724                 if (RelnameCmp(&aliasname,
2725                                            &root->simple_rte_array[i]->eref->aliasname) != 0)
2726                         continue;
2727
2728                 foreach(l, initial_rels)
2729                 {
2730                         RelOptInfo *rel = (RelOptInfo *) lfirst(l);
2731
2732                         if (rel->reloptkind == RELOPT_BASEREL)
2733                         {
2734                                 if (rel->relid != i)
2735                                         continue;
2736                         }
2737                         else
2738                         {
2739                                 Assert(rel->reloptkind == RELOPT_JOINREL);
2740
2741                                 if (!bms_is_member(i, rel->relids))
2742                                         continue;
2743                         }
2744
2745                         if (found != 0)
2746                         {
2747                                 hint_ereport(str,
2748                                                          ("Relation name \"%s\" is ambiguous.",
2749                                                           aliasname));
2750                                 return -1;
2751                         }
2752
2753                         found = i;
2754                         break;
2755                 }
2756
2757         }
2758
2759         return found;
2760 }
2761
2762 /*
2763  * Return join hint which matches given joinrelids.
2764  */
2765 static JoinMethodHint *
2766 find_join_hint(Relids joinrelids)
2767 {
2768         List       *join_hint;
2769         ListCell   *l;
2770
2771         join_hint = current_hint->join_hint_level[bms_num_members(joinrelids)];
2772
2773         foreach(l, join_hint)
2774         {
2775                 JoinMethodHint *hint = (JoinMethodHint *) lfirst(l);
2776
2777                 if (bms_equal(joinrelids, hint->joinrelids))
2778                         return hint;
2779         }
2780
2781         return NULL;
2782 }
2783
2784 static Relids
2785 OuterInnerJoinCreate(OuterInnerRels *outer_inner, LeadingHint *leading_hint,
2786         PlannerInfo *root, List *initial_rels, HintState *hstate, int nbaserel)
2787 {
2788         OuterInnerRels *outer_rels;
2789         OuterInnerRels *inner_rels;
2790         Relids                  outer_relids;
2791         Relids                  inner_relids;
2792         Relids                  join_relids;
2793         JoinMethodHint *hint;
2794
2795         if (outer_inner->relation != NULL)
2796         {
2797                 return bms_make_singleton(
2798                                         find_relid_aliasname(root, outer_inner->relation,
2799                                                                                  initial_rels,
2800                                                                                  leading_hint->base.hint_str));
2801         }
2802
2803         outer_rels = lfirst(outer_inner->outer_inner_pair->head);
2804         inner_rels = lfirst(outer_inner->outer_inner_pair->tail);
2805
2806         outer_relids = OuterInnerJoinCreate(outer_rels,
2807                                                                                 leading_hint,
2808                                                                                 root,
2809                                                                                 initial_rels,
2810                                                                                 hstate,
2811                                                                                 nbaserel);
2812         inner_relids = OuterInnerJoinCreate(inner_rels,
2813                                                                                 leading_hint,
2814                                                                                 root,
2815                                                                                 initial_rels,
2816                                                                                 hstate,
2817                                                                                 nbaserel);
2818
2819         join_relids = bms_add_members(outer_relids, inner_relids);
2820
2821         if (bms_num_members(join_relids) > nbaserel)
2822                 return join_relids;
2823
2824         /*
2825          * If we don't have join method hint, create new one for the
2826          * join combination with all join methods are enabled.
2827          */
2828         hint = find_join_hint(join_relids);
2829         if (hint == NULL)
2830         {
2831                 /*
2832                  * Here relnames is not set, since Relids bitmap is sufficient to
2833                  * control paths of this query afterward.
2834                  */
2835                 hint = (JoinMethodHint *) JoinMethodHintCreate(
2836                                         leading_hint->base.hint_str,
2837                                         HINT_LEADING,
2838                                         HINT_KEYWORD_LEADING);
2839                 hint->base.state = HINT_STATE_USED;
2840                 hint->nrels = bms_num_members(join_relids);
2841                 hint->enforce_mask = ENABLE_ALL_JOIN;
2842                 hint->joinrelids = bms_copy(join_relids);
2843                 hint->inner_nrels = bms_num_members(inner_relids);
2844                 hint->inner_joinrelids = bms_copy(inner_relids);
2845
2846                 hstate->join_hint_level[hint->nrels] =
2847                         lappend(hstate->join_hint_level[hint->nrels], hint);
2848         }
2849         else
2850         {
2851                 hint->inner_nrels = bms_num_members(inner_relids);
2852                 hint->inner_joinrelids = bms_copy(inner_relids);
2853         }
2854
2855         return join_relids;
2856 }
2857
2858 /*
2859  * Transform join method hint into handy form.
2860  *
2861  *   - create bitmap of relids from alias names, to make it easier to check
2862  *     whether a join path matches a join method hint.
2863  *   - add join method hints which are necessary to enforce join order
2864  *     specified by Leading hint
2865  */
2866 static bool
2867 transform_join_hints(HintState *hstate, PlannerInfo *root, int nbaserel,
2868                 List *initial_rels, JoinMethodHint **join_method_hints)
2869 {
2870         int                             i;
2871         int                             relid;
2872         Relids                  joinrelids;
2873         int                             njoinrels;
2874         ListCell           *l;
2875         char               *relname;
2876         LeadingHint        *lhint = NULL;
2877
2878         /*
2879          * Create bitmap of relids from alias names for each join method hint.
2880          * Bitmaps are more handy than strings in join searching.
2881          */
2882         for (i = 0; i < hstate->num_hints[HINT_TYPE_JOIN_METHOD]; i++)
2883         {
2884                 JoinMethodHint *hint = hstate->join_hints[i];
2885                 int     j;
2886
2887                 if (!hint_state_enabled(hint) || hint->nrels > nbaserel)
2888                         continue;
2889
2890                 bms_free(hint->joinrelids);
2891                 hint->joinrelids = NULL;
2892                 relid = 0;
2893                 for (j = 0; j < hint->nrels; j++)
2894                 {
2895                         relname = hint->relnames[j];
2896
2897                         relid = find_relid_aliasname(root, relname, initial_rels,
2898                                                                                  hint->base.hint_str);
2899
2900                         if (relid == -1)
2901                                 hint->base.state = HINT_STATE_ERROR;
2902
2903                         if (relid <= 0)
2904                                 break;
2905
2906                         if (bms_is_member(relid, hint->joinrelids))
2907                         {
2908                                 hint_ereport(hint->base.hint_str,
2909                                                          ("Relation name \"%s\" is duplicated.", relname));
2910                                 hint->base.state = HINT_STATE_ERROR;
2911                                 break;
2912                         }
2913
2914                         hint->joinrelids = bms_add_member(hint->joinrelids, relid);
2915                 }
2916
2917                 if (relid <= 0 || hint->base.state == HINT_STATE_ERROR)
2918                         continue;
2919
2920                 hstate->join_hint_level[hint->nrels] =
2921                         lappend(hstate->join_hint_level[hint->nrels], hint);
2922         }
2923
2924         /* Do nothing if no Leading hint was supplied. */
2925         if (hstate->num_hints[HINT_TYPE_LEADING] == 0)
2926                 return false;
2927
2928         /*
2929          * Decide to use Leading hint。
2930          */
2931         for (i = 0; i < hstate->num_hints[HINT_TYPE_LEADING]; i++)
2932         {
2933                 LeadingHint        *leading_hint = (LeadingHint *)hstate->leading_hint[i];
2934                 Relids                  relids;
2935
2936                 if (leading_hint->base.state == HINT_STATE_ERROR)
2937                         continue;
2938
2939                 relid = 0;
2940                 relids = NULL;
2941
2942                 foreach(l, leading_hint->relations)
2943                 {
2944                         relname = (char *)lfirst(l);;
2945
2946                         relid = find_relid_aliasname(root, relname, initial_rels,
2947                                                                                  leading_hint->base.hint_str);
2948                         if (relid == -1)
2949                                 leading_hint->base.state = HINT_STATE_ERROR;
2950
2951                         if (relid <= 0)
2952                                 break;
2953
2954                         if (bms_is_member(relid, relids))
2955                         {
2956                                 hint_ereport(leading_hint->base.hint_str,
2957                                                          ("Relation name \"%s\" is duplicated.", relname));
2958                                 leading_hint->base.state = HINT_STATE_ERROR;
2959                                 break;
2960                         }
2961
2962                         relids = bms_add_member(relids, relid);
2963                 }
2964
2965                 if (relid <= 0 || leading_hint->base.state == HINT_STATE_ERROR)
2966                         continue;
2967
2968                 if (lhint != NULL)
2969                 {
2970                         hint_ereport(lhint->base.hint_str,
2971                                  ("Conflict %s hint.", HintTypeName[lhint->base.type]));
2972                         lhint->base.state = HINT_STATE_DUPLICATION;
2973                 }
2974                 leading_hint->base.state = HINT_STATE_USED;
2975                 lhint = leading_hint;
2976         }
2977
2978         /* check to exist Leading hint marked with 'used'. */
2979         if (lhint == NULL)
2980                 return false;
2981
2982         /*
2983          * We need join method hints which fit specified join order in every join
2984          * level.  For example, Leading(A B C) virtually requires following join
2985          * method hints, if no join method hint supplied:
2986          *   - level 1: none
2987          *   - level 2: NestLoop(A B), MergeJoin(A B), HashJoin(A B)
2988          *   - level 3: NestLoop(A B C), MergeJoin(A B C), HashJoin(A B C)
2989          *
2990          * If we already have join method hint which fits specified join order in
2991          * that join level, we leave it as-is and don't add new hints.
2992          */
2993         joinrelids = NULL;
2994         njoinrels = 0;
2995         if (lhint->outer_inner == NULL)
2996         {
2997                 foreach(l, lhint->relations)
2998                 {
2999                         JoinMethodHint *hint;
3000
3001                         relname = (char *)lfirst(l);
3002
3003                         /*
3004                          * Find relid of the relation which has given name.  If we have the
3005                          * name given in Leading hint multiple times in the join, nothing to
3006                          * do.
3007                          */
3008                         relid = find_relid_aliasname(root, relname, initial_rels,
3009                                                                                  hstate->hint_str);
3010
3011                         /* Create bitmap of relids for current join level. */
3012                         joinrelids = bms_add_member(joinrelids, relid);
3013                         njoinrels++;
3014
3015                         /* We never have join method hint for single relation. */
3016                         if (njoinrels < 2)
3017                                 continue;
3018
3019                         /*
3020                          * If we don't have join method hint, create new one for the
3021                          * join combination with all join methods are enabled.
3022                          */
3023                         hint = find_join_hint(joinrelids);
3024                         if (hint == NULL)
3025                         {
3026                                 /*
3027                                  * Here relnames is not set, since Relids bitmap is sufficient
3028                                  * to control paths of this query afterward.
3029                                  */
3030                                 hint = (JoinMethodHint *) JoinMethodHintCreate(
3031                                                                                         lhint->base.hint_str,
3032                                                                                         HINT_LEADING,
3033                                                                                         HINT_KEYWORD_LEADING);
3034                                 hint->base.state = HINT_STATE_USED;
3035                                 hint->nrels = njoinrels;
3036                                 hint->enforce_mask = ENABLE_ALL_JOIN;
3037                                 hint->joinrelids = bms_copy(joinrelids);
3038                         }
3039
3040                         join_method_hints[njoinrels] = hint;
3041
3042                         if (njoinrels >= nbaserel)
3043                                 break;
3044                 }
3045                 bms_free(joinrelids);
3046
3047                 if (njoinrels < 2)
3048                         return false;
3049
3050                 /*
3051                  * Delete all join hints which have different combination from Leading
3052                  * hint.
3053                  */
3054                 for (i = 2; i <= njoinrels; i++)
3055                 {
3056                         list_free(hstate->join_hint_level[i]);
3057
3058                         hstate->join_hint_level[i] = lappend(NIL, join_method_hints[i]);
3059                 }
3060         }
3061         else
3062         {
3063                 joinrelids = OuterInnerJoinCreate(lhint->outer_inner,
3064                                                                                   lhint,
3065                                           root,
3066                                           initial_rels,
3067                                                                                   hstate,
3068                                                                                   nbaserel);
3069
3070                 njoinrels = bms_num_members(joinrelids);
3071                 Assert(njoinrels >= 2);
3072
3073                 /*
3074                  * Delete all join hints which have different combination from Leading
3075                  * hint.
3076                  */
3077                 for (i = 2;i <= njoinrels; i++)
3078                 {
3079                         if (hstate->join_hint_level[i] != NIL)
3080                         {
3081                                 ListCell *prev = NULL;
3082                                 ListCell *next = NULL;
3083                                 for(l = list_head(hstate->join_hint_level[i]); l; l = next)
3084                                 {
3085
3086                                         JoinMethodHint *hint = (JoinMethodHint *)lfirst(l);
3087
3088                                         next = lnext(l);
3089
3090                                         if (hint->inner_nrels == 0 &&
3091                                                 !(bms_intersect(hint->joinrelids, joinrelids) == NULL ||
3092                                                   bms_equal(bms_union(hint->joinrelids, joinrelids),
3093                                                   hint->joinrelids)))
3094                                         {
3095                                                 hstate->join_hint_level[i] =
3096                                                         list_delete_cell(hstate->join_hint_level[i], l,
3097                                                                                          prev);
3098                                         }
3099                                         else
3100                                                 prev = l;
3101                                 }
3102                         }
3103                 }
3104
3105                 bms_free(joinrelids);
3106         }
3107
3108         if (hint_state_enabled(lhint))
3109         {
3110                 set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
3111                 return true;
3112         }
3113         return false;
3114 }
3115
3116 /*
3117  * set_plain_rel_pathlist
3118  *        Build access paths for a plain relation (no subquery, no inheritance)
3119  *
3120  * This function was copied and edited from set_plain_rel_pathlist() in
3121  * src/backend/optimizer/path/allpaths.c
3122  */
3123 static void
3124 set_plain_rel_pathlist(PlannerInfo *root, RelOptInfo *rel, RangeTblEntry *rte)
3125 {
3126         /* Consider sequential scan */
3127 #if PG_VERSION_NUM >= 90200
3128         add_path(rel, create_seqscan_path(root, rel, NULL));
3129 #else
3130         add_path(rel, create_seqscan_path(root, rel));
3131 #endif
3132
3133         /* Consider index scans */
3134         create_index_paths(root, rel);
3135
3136         /* Consider TID scans */
3137         create_tidscan_paths(root, rel);
3138
3139         /* Now find the cheapest of the paths for this rel */
3140         set_cheapest(rel);
3141 }
3142
3143 static void
3144 rebuild_scan_path(HintState *hstate, PlannerInfo *root, int level,
3145                                   List *initial_rels)
3146 {
3147         ListCell   *l;
3148
3149         foreach(l, initial_rels)
3150         {
3151                 RelOptInfo         *rel = (RelOptInfo *) lfirst(l);
3152                 RangeTblEntry  *rte;
3153                 ScanMethodHint *hint;
3154
3155                 /* Skip relations which we can't choose scan method. */
3156                 if (rel->reloptkind != RELOPT_BASEREL || rel->rtekind != RTE_RELATION)
3157                         continue;
3158
3159                 rte = root->simple_rte_array[rel->relid];
3160
3161                 /* We can't force scan method of foreign tables */
3162                 if (rte->relkind == RELKIND_FOREIGN_TABLE)
3163                         continue;
3164
3165                 /*
3166                  * Create scan paths with GUC parameters which are at the beginning of
3167                  * planner if scan method hint is not specified, otherwise use
3168                  * specified hints and mark the hint as used.
3169                  */
3170                 if ((hint = find_scan_hint(root, rel)) == NULL)
3171                         set_scan_config_options(hstate->init_scan_mask,
3172                                                                         hstate->context);
3173                 else
3174                 {
3175                         set_scan_config_options(hint->enforce_mask, hstate->context);
3176                         hint->base.state = HINT_STATE_USED;
3177                 }
3178
3179                 list_free_deep(rel->pathlist);
3180                 rel->pathlist = NIL;
3181                 if (rte->inh)
3182                 {
3183                         /* It's an "append relation", process accordingly */
3184                         set_append_rel_pathlist(root, rel, rel->relid, rte);
3185                 }
3186                 else
3187                 {
3188                         set_plain_rel_pathlist(root, rel, rte);
3189                 }
3190         }
3191
3192         /*
3193          * Restore the GUC variables we set above.
3194          */
3195         set_scan_config_options(hstate->init_scan_mask, hstate->context);
3196 }
3197
3198 /*
3199  * wrapper of make_join_rel()
3200  *
3201  * call make_join_rel() after changing enable_* parameters according to given
3202  * hints.
3203  */
3204 static RelOptInfo *
3205 make_join_rel_wrapper(PlannerInfo *root, RelOptInfo *rel1, RelOptInfo *rel2)
3206 {
3207         Relids                  joinrelids;
3208         JoinMethodHint *hint;
3209         RelOptInfo         *rel;
3210         int                             save_nestlevel;
3211
3212         joinrelids = bms_union(rel1->relids, rel2->relids);
3213         hint = find_join_hint(joinrelids);
3214         bms_free(joinrelids);
3215
3216         if (!hint)
3217                 return pg_hint_plan_make_join_rel(root, rel1, rel2);
3218
3219         if (hint->inner_nrels == 0)
3220         {
3221                 save_nestlevel = NewGUCNestLevel();
3222
3223                 set_join_config_options(hint->enforce_mask, current_hint->context);
3224
3225                 rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
3226                 hint->base.state = HINT_STATE_USED;
3227
3228                 /*
3229                  * Restore the GUC variables we set above.
3230                  */
3231                 AtEOXact_GUC(true, save_nestlevel);
3232         }
3233         else
3234                 rel = pg_hint_plan_make_join_rel(root, rel1, rel2);
3235
3236         return rel;
3237 }
3238
3239 /*
3240  * TODO : comment
3241  */
3242 static void
3243 add_paths_to_joinrel_wrapper(PlannerInfo *root,
3244                                                          RelOptInfo *joinrel,
3245                                                          RelOptInfo *outerrel,
3246                                                          RelOptInfo *innerrel,
3247                                                          JoinType jointype,
3248                                                          SpecialJoinInfo *sjinfo,
3249                                                          List *restrictlist)
3250 {
3251         ScanMethodHint *scan_hint = NULL;
3252         Relids                  joinrelids;
3253         JoinMethodHint *join_hint;
3254         int                             save_nestlevel;
3255
3256         if ((scan_hint = find_scan_hint(root, innerrel)) != NULL)
3257         {
3258                 set_scan_config_options(scan_hint->enforce_mask, current_hint->context);
3259                 scan_hint->base.state = HINT_STATE_USED;
3260         }
3261
3262         joinrelids = bms_union(outerrel->relids, innerrel->relids);
3263         join_hint = find_join_hint(joinrelids);
3264         bms_free(joinrelids);
3265
3266         if (join_hint && join_hint->inner_nrels != 0)
3267         {
3268                 save_nestlevel = NewGUCNestLevel();
3269
3270                 if (bms_equal(join_hint->inner_joinrelids, innerrel->relids))
3271                 {
3272
3273                         set_join_config_options(join_hint->enforce_mask,
3274                                                                         current_hint->context);
3275
3276                         add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
3277                                                                  sjinfo, restrictlist);
3278                         join_hint->base.state = HINT_STATE_USED;
3279                 }
3280                 else
3281                 {
3282                         set_join_config_options(DISABLE_ALL_JOIN, current_hint->context);
3283                         add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
3284                                                                  sjinfo, restrictlist);
3285                 }
3286
3287                 /*
3288                  * Restore the GUC variables we set above.
3289                  */
3290                 AtEOXact_GUC(true, save_nestlevel);
3291         }
3292         else
3293                 add_paths_to_joinrel(root, joinrel, outerrel, innerrel, jointype,
3294                                                          sjinfo, restrictlist);
3295
3296         if (scan_hint != NULL)
3297                 set_scan_config_options(current_hint->init_scan_mask,
3298                                                                 current_hint->context);
3299 }
3300
3301 static int
3302 get_num_baserels(List *initial_rels)
3303 {
3304         int                     nbaserel = 0;
3305         ListCell   *l;
3306
3307         foreach(l, initial_rels)
3308         {
3309                 RelOptInfo *rel = (RelOptInfo *) lfirst(l);
3310
3311                 if (rel->reloptkind == RELOPT_BASEREL)
3312                         nbaserel++;
3313                 else if (rel->reloptkind ==RELOPT_JOINREL)
3314                         nbaserel+= bms_num_members(rel->relids);
3315                 else
3316                 {
3317                         /* other values not expected here */
3318                         elog(ERROR, "unrecognized reloptkind type: %d", rel->reloptkind);
3319                 }
3320         }
3321
3322         return nbaserel;
3323 }
3324
3325 static RelOptInfo *
3326 pg_hint_plan_join_search(PlannerInfo *root, int levels_needed,
3327                                                  List *initial_rels)
3328 {
3329         JoinMethodHint    **join_method_hints;
3330         int                                     nbaserel;
3331         RelOptInfo                 *rel;
3332         int                                     i;
3333         bool                            leading_hint_enable;
3334
3335         /*
3336          * Use standard planner (or geqo planner) if pg_hint_plan is disabled or no
3337          * valid hint is supplied.
3338          */
3339         if (!current_hint)
3340         {
3341                 if (prev_join_search)
3342                         return (*prev_join_search) (root, levels_needed, initial_rels);
3343                 else if (enable_geqo && levels_needed >= geqo_threshold)
3344                         return geqo(root, levels_needed, initial_rels);
3345                 else
3346                         return standard_join_search(root, levels_needed, initial_rels);
3347         }
3348
3349         /* We apply scan method hint rebuild scan path. */
3350         rebuild_scan_path(current_hint, root, levels_needed, initial_rels);
3351
3352         /*
3353          * In the case using GEQO, only scan method hints and Set hints have
3354          * effect.  Join method and join order is not controllable by hints.
3355          */
3356         if (enable_geqo && levels_needed >= geqo_threshold)
3357                 return geqo(root, levels_needed, initial_rels);
3358
3359         nbaserel = get_num_baserels(initial_rels);
3360         current_hint->join_hint_level = palloc0(sizeof(List *) * (nbaserel + 1));
3361         join_method_hints = palloc0(sizeof(JoinMethodHint *) * (nbaserel + 1));
3362
3363         leading_hint_enable = transform_join_hints(current_hint, root, nbaserel,
3364                                                                                            initial_rels, join_method_hints);
3365
3366         rel = pg_hint_plan_standard_join_search(root, levels_needed, initial_rels);
3367
3368         for (i = 2; i <= nbaserel; i++)
3369         {
3370                 list_free(current_hint->join_hint_level[i]);
3371
3372                 /* free Leading hint only */
3373                 if (join_method_hints[i] != NULL &&
3374                         join_method_hints[i]->enforce_mask == ENABLE_ALL_JOIN)
3375                         JoinMethodHintDelete(join_method_hints[i]);
3376         }
3377         pfree(current_hint->join_hint_level);
3378         pfree(join_method_hints);
3379
3380         if (leading_hint_enable)
3381                 set_join_config_options(current_hint->init_join_mask,
3382                                                                 current_hint->context);
3383
3384         return rel;
3385 }
3386
3387 /*
3388  * set_rel_pathlist
3389  *        Build access paths for a base relation
3390  *
3391  * This function was copied and edited from set_rel_pathlist() in
3392  * src/backend/optimizer/path/allpaths.c
3393  */
3394 static void
3395 set_rel_pathlist(PlannerInfo *root, RelOptInfo *rel,
3396                                  Index rti, RangeTblEntry *rte)
3397 {
3398 #if PG_VERSION_NUM >= 90200
3399         if (IS_DUMMY_REL(rel))
3400         {
3401                 /* We already proved the relation empty, so nothing more to do */
3402         }
3403         else if (rte->inh)
3404 #else
3405         if (rte->inh)
3406 #endif
3407         {
3408                 /* It's an "append relation", process accordingly */
3409                 set_append_rel_pathlist(root, rel, rti, rte);
3410         }
3411         else
3412         {
3413                 if (rel->rtekind == RTE_RELATION)
3414                 {
3415                         if (rte->relkind == RELKIND_RELATION)
3416                         {
3417                                 /* Plain relation */
3418                                 set_plain_rel_pathlist(root, rel, rte);
3419                         }
3420                         else
3421                                 elog(ERROR, "unexpected relkind: %c", rte->relkind);
3422                 }
3423                 else
3424                         elog(ERROR, "unexpected rtekind: %d", (int) rel->rtekind);
3425         }
3426 }
3427
3428 #define standard_join_search pg_hint_plan_standard_join_search
3429 #define join_search_one_level pg_hint_plan_join_search_one_level
3430 #define make_join_rel make_join_rel_wrapper
3431 #include "core.c"
3432
3433 #undef make_join_rel
3434 #define make_join_rel pg_hint_plan_make_join_rel
3435 #define add_paths_to_joinrel add_paths_to_joinrel_wrapper
3436 #include "make_join_rel.c"