pgpa_ast.h File Reference

#include "pgpa_identifier.h"
#include "nodes/pg_list.h"

Include dependency graph for pgpa_ast.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	pgpa_index_target
struct	pgpa_advice_target
struct	pgpa_advice_item

Macros
#define	YY_TYPEDEF_YY_SCANNER_T

Typedefs
typedef struct pgpa_index_target	pgpa_index_target
typedef struct pgpa_advice_target	pgpa_advice_target
typedef enum pgpa_advice_tag_type	pgpa_advice_tag_type
typedef struct pgpa_advice_item	pgpa_advice_item
typedef void *	yyscan_t

Enumerations
enum	pgpa_target_type { PGPA_TARGET_IDENTIFIER , PGPA_TARGET_ORDERED_LIST , PGPA_TARGET_UNORDERED_LIST }
enum	pgpa_advice_tag_type {   PGPA_TAG_BITMAP_HEAP_SCAN , PGPA_TAG_DO_NOT_SCAN , PGPA_TAG_FOREIGN_JOIN , PGPA_TAG_GATHER ,   PGPA_TAG_GATHER_MERGE , PGPA_TAG_HASH_JOIN , PGPA_TAG_INDEX_ONLY_SCAN , PGPA_TAG_INDEX_SCAN ,   PGPA_TAG_JOIN_ORDER , PGPA_TAG_MERGE_JOIN_MATERIALIZE , PGPA_TAG_MERGE_JOIN_PLAIN , PGPA_TAG_NESTED_LOOP_MATERIALIZE ,   PGPA_TAG_NESTED_LOOP_MEMOIZE , PGPA_TAG_NESTED_LOOP_PLAIN , PGPA_TAG_NO_GATHER , PGPA_TAG_PARTITIONWISE ,   PGPA_TAG_SEMIJOIN_NON_UNIQUE , PGPA_TAG_SEMIJOIN_UNIQUE , PGPA_TAG_SEQ_SCAN , PGPA_TAG_TID_SCAN }
enum	pgpa_itm_type {   PGPA_ITM_EQUAL , PGPA_ITM_KEYS_ARE_SUBSET , PGPA_ITM_TARGETS_ARE_SUBSET , PGPA_ITM_INTERSECTING ,   PGPA_ITM_DISJOINT }

Functions
int	pgpa_yylex (union YYSTYPE *yylval_param, List **result, char **parse_error_msg_p, yyscan_t yyscanner)
void	pgpa_yyerror (List **result, char **parse_error_msg_p, yyscan_t yyscanner, const char *message)
void	pgpa_scanner_init (const char *str, yyscan_t *yyscannerp)
void	pgpa_scanner_finish (yyscan_t yyscanner)
int	pgpa_yyparse (List **result, char **parse_error_msg_p, yyscan_t yyscanner)
List *	pgpa_parse (const char *advice_string, char **error_p)
char *	pgpa_cstring_advice_tag (pgpa_advice_tag_type advice_tag)
bool	pgpa_identifier_matches_target (pgpa_identifier *rid, pgpa_advice_target *target)
pgpa_itm_type	pgpa_identifiers_match_target (int nrids, pgpa_identifier *rids, pgpa_advice_target *target)
bool	pgpa_index_targets_equal (pgpa_index_target *i1, pgpa_index_target *i2)
pgpa_advice_tag_type	pgpa_parse_advice_tag (const char *tag, bool *fail)
void	pgpa_format_advice_target (StringInfo str, pgpa_advice_target *target)
void	pgpa_format_index_target (StringInfo str, pgpa_index_target *itarget)

Macro Definition Documentation

YY_TYPEDEF_YY_SCANNER_T

#define YY_TYPEDEF_YY_SCANNER_T

Definition at line 153 of file pgpa_ast.h.

Typedef Documentation

pgpa_advice_item

typedef struct pgpa_advice_item pgpa_advice_item

pgpa_advice_tag_type

typedef enum pgpa_advice_tag_type pgpa_advice_tag_type

pgpa_advice_target

typedef struct pgpa_advice_target pgpa_advice_target

pgpa_index_target

typedef struct pgpa_index_target pgpa_index_target

yyscan_t

typedef void* yyscan_t

Definition at line 154 of file pgpa_ast.h.

Enumeration Type Documentation

pgpa_advice_tag_type

enum pgpa_advice_tag_type

Enumerator
PGPA_TAG_BITMAP_HEAP_SCAN
PGPA_TAG_DO_NOT_SCAN
PGPA_TAG_FOREIGN_JOIN
PGPA_TAG_GATHER
PGPA_TAG_GATHER_MERGE
PGPA_TAG_HASH_JOIN
PGPA_TAG_INDEX_ONLY_SCAN
PGPA_TAG_INDEX_SCAN
PGPA_TAG_JOIN_ORDER
PGPA_TAG_MERGE_JOIN_MATERIALIZE
PGPA_TAG_MERGE_JOIN_PLAIN
PGPA_TAG_NESTED_LOOP_MATERIALIZE
PGPA_TAG_NESTED_LOOP_MEMOIZE
PGPA_TAG_NESTED_LOOP_PLAIN
PGPA_TAG_NO_GATHER
PGPA_TAG_PARTITIONWISE
PGPA_TAG_SEMIJOIN_NON_UNIQUE
PGPA_TAG_SEMIJOIN_UNIQUE
PGPA_TAG_SEQ_SCAN
PGPA_TAG_TID_SCAN

Definition at line 80 of file pgpa_ast.h.

{
    PGPA_TAG_BITMAP_HEAP_SCAN,
    PGPA_TAG_DO_NOT_SCAN,
    PGPA_TAG_FOREIGN_JOIN,
    PGPA_TAG_GATHER,
    PGPA_TAG_GATHER_MERGE,
    PGPA_TAG_HASH_JOIN,
    PGPA_TAG_INDEX_ONLY_SCAN,
    PGPA_TAG_INDEX_SCAN,
    PGPA_TAG_JOIN_ORDER,
    PGPA_TAG_MERGE_JOIN_MATERIALIZE,
    PGPA_TAG_MERGE_JOIN_PLAIN,
    PGPA_TAG_NESTED_LOOP_MATERIALIZE,
    PGPA_TAG_NESTED_LOOP_MEMOIZE,
    PGPA_TAG_NESTED_LOOP_PLAIN,
    PGPA_TAG_NO_GATHER,
    PGPA_TAG_PARTITIONWISE,
    PGPA_TAG_SEMIJOIN_NON_UNIQUE,
    PGPA_TAG_SEMIJOIN_UNIQUE,
    PGPA_TAG_SEQ_SCAN,
    PGPA_TAG_TID_SCAN
} pgpa_advice_tag_type;

pgpa_itm_type

enum pgpa_itm_type

Enumerator
PGPA_ITM_EQUAL
PGPA_ITM_KEYS_ARE_SUBSET
PGPA_ITM_TARGETS_ARE_SUBSET
PGPA_ITM_INTERSECTING
PGPA_ITM_DISJOINT

Definition at line 141 of file pgpa_ast.h.

{
    PGPA_ITM_EQUAL,
    PGPA_ITM_KEYS_ARE_SUBSET,
    PGPA_ITM_TARGETS_ARE_SUBSET,
    PGPA_ITM_INTERSECTING,
    PGPA_ITM_DISJOINT
} pgpa_itm_type;

pgpa_target_type

enum pgpa_target_type

Enumerator
PGPA_TARGET_IDENTIFIER
PGPA_TARGET_ORDERED_LIST
PGPA_TARGET_UNORDERED_LIST

Definition at line 25 of file pgpa_ast.h.

{
    PGPA_TARGET_IDENTIFIER,     /* relation identifier */
    PGPA_TARGET_ORDERED_LIST,   /* (item ...) */
    PGPA_TARGET_UNORDERED_LIST  /* {item ...} */
} pgpa_target_type;

Function Documentation

pgpa_cstring_advice_tag()

char * pgpa_cstring_advice_tag ( pgpa_advice_tag_type  advice_tag )

extern

Definition at line 29 of file pgpa_ast.c.

{
    switch (advice_tag)
    {
        case PGPA_TAG_BITMAP_HEAP_SCAN:
            return "BITMAP_HEAP_SCAN";
        case PGPA_TAG_DO_NOT_SCAN:
            return "DO_NOT_SCAN";
        case PGPA_TAG_FOREIGN_JOIN:
            return "FOREIGN_JOIN";
        case PGPA_TAG_GATHER:
            return "GATHER";
        case PGPA_TAG_GATHER_MERGE:
            return "GATHER_MERGE";
        case PGPA_TAG_HASH_JOIN:
            return "HASH_JOIN";
        case PGPA_TAG_INDEX_ONLY_SCAN:
            return "INDEX_ONLY_SCAN";
        case PGPA_TAG_INDEX_SCAN:
            return "INDEX_SCAN";
        case PGPA_TAG_JOIN_ORDER:
            return "JOIN_ORDER";
        case PGPA_TAG_MERGE_JOIN_MATERIALIZE:
            return "MERGE_JOIN_MATERIALIZE";
        case PGPA_TAG_MERGE_JOIN_PLAIN:
            return "MERGE_JOIN_PLAIN";
        case PGPA_TAG_NESTED_LOOP_MATERIALIZE:
            return "NESTED_LOOP_MATERIALIZE";
        case PGPA_TAG_NESTED_LOOP_MEMOIZE:
            return "NESTED_LOOP_MEMOIZE";
        case PGPA_TAG_NESTED_LOOP_PLAIN:
            return "NESTED_LOOP_PLAIN";
        case PGPA_TAG_NO_GATHER:
            return "NO_GATHER";
        case PGPA_TAG_PARTITIONWISE:
            return "PARTITIONWISE";
        case PGPA_TAG_SEMIJOIN_NON_UNIQUE:
            return "SEMIJOIN_NON_UNIQUE";
        case PGPA_TAG_SEMIJOIN_UNIQUE:
            return "SEMIJOIN_UNIQUE";
        case PGPA_TAG_SEQ_SCAN:
            return "SEQ_SCAN";
        case PGPA_TAG_TID_SCAN:
            return "TID_SCAN";
    }
 
    pg_unreachable();
    return NULL;
}

References fb(), pg_unreachable, PGPA_TAG_BITMAP_HEAP_SCAN, PGPA_TAG_DO_NOT_SCAN, PGPA_TAG_FOREIGN_JOIN, PGPA_TAG_GATHER, PGPA_TAG_GATHER_MERGE, PGPA_TAG_HASH_JOIN, PGPA_TAG_INDEX_ONLY_SCAN, PGPA_TAG_INDEX_SCAN, PGPA_TAG_JOIN_ORDER, PGPA_TAG_MERGE_JOIN_MATERIALIZE, PGPA_TAG_MERGE_JOIN_PLAIN, PGPA_TAG_NESTED_LOOP_MATERIALIZE, PGPA_TAG_NESTED_LOOP_MEMOIZE, PGPA_TAG_NESTED_LOOP_PLAIN, PGPA_TAG_NO_GATHER, PGPA_TAG_PARTITIONWISE, PGPA_TAG_SEMIJOIN_NON_UNIQUE, PGPA_TAG_SEMIJOIN_UNIQUE, PGPA_TAG_SEQ_SCAN, and PGPA_TAG_TID_SCAN.

Referenced by pgpa_cstring_trove_entry().

pgpa_format_advice_target()

void pgpa_format_advice_target ( StringInfo  str, pgpa_advice_target *  target  )

extern

Definition at line 170 of file pgpa_ast.c.

{
    if (target->ttype != PGPA_TARGET_IDENTIFIER)
    {
        bool        first = true;
        char       *delims;
 
        if (target->ttype == PGPA_TARGET_UNORDERED_LIST)
            delims = "{}";
        else
            delims = "()";
 
        appendStringInfoChar(str, delims[0]);
        foreach_ptr(pgpa_advice_target, child_target, target->children)
        {
            if (first)
                first = false;
            else
                appendStringInfoChar(str, ' ');
            pgpa_format_advice_target(str, child_target);
        }
        appendStringInfoChar(str, delims[1]);
    }
    else
    {
        const char *rt_identifier;
 
        rt_identifier = pgpa_identifier_string(&target->rid);
        appendStringInfoString(str, rt_identifier);
    }
}

References appendStringInfoChar(), appendStringInfoString(), pgpa_advice_target::children, fb(), foreach_ptr, pgpa_format_advice_target(), pgpa_identifier_string(), PGPA_TARGET_IDENTIFIER, PGPA_TARGET_UNORDERED_LIST, pgpa_advice_target::rid, str, and pgpa_advice_target::ttype.

Referenced by pgpa_cstring_trove_entry(), and pgpa_format_advice_target().

pgpa_format_index_target()

void pgpa_format_index_target ( StringInfo  str, pgpa_index_target *  itarget  )

extern

Definition at line 206 of file pgpa_ast.c.

{
    if (itarget->indnamespace != NULL)
        appendStringInfo(str, "%s.",
                         quote_identifier(itarget->indnamespace));
    appendStringInfoString(str, quote_identifier(itarget->indname));
}

References appendStringInfo(), appendStringInfoString(), fb(), pgpa_index_target::indname, pgpa_index_target::indnamespace, quote_identifier(), and str.

Referenced by pgpa_cstring_trove_entry().

pgpa_identifier_matches_target()

bool pgpa_identifier_matches_target ( pgpa_identifier *  rid, pgpa_advice_target *  target  )

extern

Definition at line 235 of file pgpa_ast.c.

{
    /* For non-identifiers, check all descendants. */
    if (target->ttype != PGPA_TARGET_IDENTIFIER)
    {
        foreach_ptr(pgpa_advice_target, child_target, target->children)
        {
            if (pgpa_identifier_matches_target(rid, child_target))
                return true;
        }
        return false;
    }
 
    /* Straightforward comparisons of alias name and occurrence number. */
    if (strcmp(rid->alias_name, target->rid.alias_name) != 0)
        return false;
    if (rid->occurrence != target->rid.occurrence)
        return false;
 
    /*
     * If a relation identifier mentions a partition name, it should also
     * specify a partition schema. But the target may leave the schema NULL to
     * match anything.
     */
    Assert(rid->partnsp != NULL || rid->partrel == NULL);
    if (rid->partnsp != NULL && target->rid.partnsp != NULL &&
        strcmp(rid->partnsp, target->rid.partnsp) != 0)
        return false;
 
    /*
     * These fields can be NULL on either side, but NULL only matches another
     * NULL.
     */
    if (!strings_equal_or_both_null(rid->partrel, target->rid.partrel))
        return false;
    if (!strings_equal_or_both_null(rid->plan_name, target->rid.plan_name))
        return false;
 
    return true;
}

References pgpa_identifier::alias_name, Assert, pgpa_advice_target::children, fb(), foreach_ptr, pgpa_identifier::occurrence, pgpa_identifier::partnsp, pgpa_identifier::partrel, pgpa_identifier_matches_target(), PGPA_TARGET_IDENTIFIER, pgpa_identifier::plan_name, pgpa_advice_target::rid, strings_equal_or_both_null(), and pgpa_advice_target::ttype.

Referenced by pgpa_identifier_matches_target(), pgpa_identifiers_cover_target(), and pgpa_trove_slice_lookup().

pgpa_identifiers_match_target()

pgpa_itm_type pgpa_identifiers_match_target ( int  nrids, pgpa_identifier *  rids, pgpa_advice_target *  target  )

extern

Definition at line 283 of file pgpa_ast.c.

{
    bool        all_rids_used = true;
    bool        any_rids_used = false;
    bool        all_targets_used;
    bool       *rids_used = palloc0_array(bool, nrids);
 
    all_targets_used =
        pgpa_identifiers_cover_target(nrids, rids, target, rids_used);
 
    for (int i = 0; i < nrids; ++i)
    {
        if (rids_used[i])
            any_rids_used = true;
        else
            all_rids_used = false;
    }
 
    if (all_rids_used)
    {
        if (all_targets_used)
            return PGPA_ITM_EQUAL;
        else
            return PGPA_ITM_KEYS_ARE_SUBSET;
    }
    else
    {
        if (all_targets_used)
            return PGPA_ITM_TARGETS_ARE_SUBSET;
        else if (any_rids_used)
            return PGPA_ITM_INTERSECTING;
        else
            return PGPA_ITM_DISJOINT;
    }
}

References fb(), i, palloc0_array, pgpa_identifiers_cover_target(), PGPA_ITM_DISJOINT, PGPA_ITM_EQUAL, PGPA_ITM_INTERSECTING, PGPA_ITM_KEYS_ARE_SUBSET, and PGPA_ITM_TARGETS_ARE_SUBSET.

Referenced by pgpa_join_method_permits_join(), pgpa_join_order_permits_join(), pgpa_opaque_join_permits_join(), pgpa_planner_apply_join_path_advice(), pgpa_planner_apply_joinrel_advice(), and pgpa_semijoin_permits_join().

pgpa_index_targets_equal()

bool pgpa_index_targets_equal ( pgpa_index_target *  i1, pgpa_index_target *  i2  )

extern

Definition at line 218 of file pgpa_ast.c.

{
    /* indnamespace can be NULL, and two NULL values are equal */
    if ((i1->indnamespace != NULL || i2->indnamespace != NULL) &&
        (i1->indnamespace == NULL || i2->indnamespace == NULL ||
         strcmp(i1->indnamespace, i2->indnamespace) != 0))
        return false;
    if (strcmp(i1->indname, i2->indname) != 0)
        return false;
 
    return true;
}

References fb(), pgpa_index_target::indname, and pgpa_index_target::indnamespace.

Referenced by pgpa_planner_apply_scan_advice().

pgpa_parse()

List * pgpa_parse ( const char *  advice_string, char **  error_p  )

extern

Referenced by pg_plan_advice_advice_check_hook(), and pgpa_planner_setup().

pgpa_parse_advice_tag()

pgpa_advice_tag_type pgpa_parse_advice_tag ( const char *  tag, bool *  fail  )

extern

Definition at line 87 of file pgpa_ast.c.

{
    *fail = false;
 
    switch (tag[0])
    {
        case 'b':
            if (strcmp(tag, "bitmap_heap_scan") == 0)
                return PGPA_TAG_BITMAP_HEAP_SCAN;
            break;
        case 'd':
            if (strcmp(tag, "do_not_scan") == 0)
                return PGPA_TAG_DO_NOT_SCAN;
            break;
        case 'f':
            if (strcmp(tag, "foreign_join") == 0)
                return PGPA_TAG_FOREIGN_JOIN;
            break;
        case 'g':
            if (strcmp(tag, "gather") == 0)
                return PGPA_TAG_GATHER;
            if (strcmp(tag, "gather_merge") == 0)
                return PGPA_TAG_GATHER_MERGE;
            break;
        case 'h':
            if (strcmp(tag, "hash_join") == 0)
                return PGPA_TAG_HASH_JOIN;
            break;
        case 'i':
            if (strcmp(tag, "index_scan") == 0)
                return PGPA_TAG_INDEX_SCAN;
            if (strcmp(tag, "index_only_scan") == 0)
                return PGPA_TAG_INDEX_ONLY_SCAN;
            break;
        case 'j':
            if (strcmp(tag, "join_order") == 0)
                return PGPA_TAG_JOIN_ORDER;
            break;
        case 'm':
            if (strcmp(tag, "merge_join_materialize") == 0)
                return PGPA_TAG_MERGE_JOIN_MATERIALIZE;
            if (strcmp(tag, "merge_join_plain") == 0)
                return PGPA_TAG_MERGE_JOIN_PLAIN;
            break;
        case 'n':
            if (strcmp(tag, "nested_loop_materialize") == 0)
                return PGPA_TAG_NESTED_LOOP_MATERIALIZE;
            if (strcmp(tag, "nested_loop_memoize") == 0)
                return PGPA_TAG_NESTED_LOOP_MEMOIZE;
            if (strcmp(tag, "nested_loop_plain") == 0)
                return PGPA_TAG_NESTED_LOOP_PLAIN;
            if (strcmp(tag, "no_gather") == 0)
                return PGPA_TAG_NO_GATHER;
            break;
        case 'p':
            if (strcmp(tag, "partitionwise") == 0)
                return PGPA_TAG_PARTITIONWISE;
            break;
        case 's':
            if (strcmp(tag, "semijoin_non_unique") == 0)
                return PGPA_TAG_SEMIJOIN_NON_UNIQUE;
            if (strcmp(tag, "semijoin_unique") == 0)
                return PGPA_TAG_SEMIJOIN_UNIQUE;
            if (strcmp(tag, "seq_scan") == 0)
                return PGPA_TAG_SEQ_SCAN;
            break;
        case 't':
            if (strcmp(tag, "tid_scan") == 0)
                return PGPA_TAG_TID_SCAN;
            break;
    }
 
    /* didn't work out */
    *fail = true;
 
    /* return an arbitrary value to unwind the call stack */
    return PGPA_TAG_SEQ_SCAN;
}

References fb(), PGPA_TAG_BITMAP_HEAP_SCAN, PGPA_TAG_DO_NOT_SCAN, PGPA_TAG_FOREIGN_JOIN, PGPA_TAG_GATHER, PGPA_TAG_GATHER_MERGE, PGPA_TAG_HASH_JOIN, PGPA_TAG_INDEX_ONLY_SCAN, PGPA_TAG_INDEX_SCAN, PGPA_TAG_JOIN_ORDER, PGPA_TAG_MERGE_JOIN_MATERIALIZE, PGPA_TAG_MERGE_JOIN_PLAIN, PGPA_TAG_NESTED_LOOP_MATERIALIZE, PGPA_TAG_NESTED_LOOP_MEMOIZE, PGPA_TAG_NESTED_LOOP_PLAIN, PGPA_TAG_NO_GATHER, PGPA_TAG_PARTITIONWISE, PGPA_TAG_SEMIJOIN_NON_UNIQUE, PGPA_TAG_SEMIJOIN_UNIQUE, PGPA_TAG_SEQ_SCAN, and PGPA_TAG_TID_SCAN.

pgpa_scanner_finish()

void pgpa_scanner_finish ( yyscan_t  yyscanner )

extern

Definition at line 267 of file pgpa_scanner.l.

{
    yylex_destroy(yyscanner);
}

References fb().

pgpa_scanner_init()

void pgpa_scanner_init ( const char *  str, yyscan_t *  yyscannerp  )

extern

Definition at line 244 of file pgpa_scanner.l.

{
    yyscan_t    yyscanner;
    pgpa_yy_extra_type  *yyext = palloc0_object(pgpa_yy_extra_type);
 
    if (yylex_init(yyscannerp) != 0)
        elog(ERROR, "yylex_init() failed: %m");
 
    yyscanner = *yyscannerp;
 
    initStringInfo(&yyext->litbuf);
    pgpa_yyset_extra(yyext, yyscanner);
 
    yy_scan_string(str, yyscanner);
}

References elog, ERROR, fb(), initStringInfo(), palloc0_object, and str.

pgpa_yyerror()

void pgpa_yyerror ( List **  result, char **  parse_error_msg_p, yyscan_t  yyscanner, const char *  message  )

extern

Definition at line 221 of file pgpa_scanner.l.

{
    struct yyguts_t *yyg = (struct yyguts_t *) yyscanner;   /* needed for yytext
                                                             * macro */
 
 
    /* report only the first error in a parse operation */
    if (*parse_error_msg_p)
        return;
 
    if (yytext[0])
        *parse_error_msg_p = psprintf("%s at or near \"%s\"", message, yytext);
    else
        *parse_error_msg_p = psprintf("%s at end of input", message);
}

References fb(), and psprintf().

pgpa_yylex()

int pgpa_yylex ( union YYSTYPE *  yylval_param, List **  result, char **  parse_error_msg_p, yyscan_t  yyscanner  )

extern

pgpa_yyparse()

int pgpa_yyparse ( List **  result, char **  parse_error_msg_p, yyscan_t  yyscanner  )

extern