pgpa_trove.h File Reference

#include "pgpa_ast.h"
#include "nodes/bitmapset.h"

Include dependency graph for pgpa_trove.h:

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

Go to the source code of this file.

Data Structures
struct	pgpa_trove_entry
struct	pgpa_trove_result

Macros
#define	PGPA_TE_MATCH_PARTIAL   0x0001
#define	PGPA_TE_MATCH_FULL   0x0002
#define	PGPA_TE_INAPPLICABLE   0x0004
#define	PGPA_TE_CONFLICTING   0x0008
#define	PGPA_TE_FAILED   0x0010

Typedefs
typedef struct pgpa_trove	pgpa_trove
typedef struct pgpa_trove_entry	pgpa_trove_entry
typedef enum pgpa_trove_lookup_type	pgpa_trove_lookup_type
typedef struct pgpa_trove_result	pgpa_trove_result

Enumerations
enum	pgpa_trove_lookup_type { PGPA_TROVE_LOOKUP_JOIN , PGPA_TROVE_LOOKUP_REL , PGPA_TROVE_LOOKUP_SCAN }

Functions
pgpa_trove *	pgpa_build_trove (List *advice_items)
void	pgpa_trove_lookup (pgpa_trove *trove, pgpa_trove_lookup_type type, int nrids, pgpa_identifier *rids, pgpa_trove_result *result)
void	pgpa_trove_lookup_all (pgpa_trove *trove, pgpa_trove_lookup_type type, pgpa_trove_entry **entries, int *nentries)
char *	pgpa_cstring_trove_entry (pgpa_trove_entry *entry)
void	pgpa_trove_set_flags (pgpa_trove_entry *entries, Bitmapset *indexes, int flags)
void	pgpa_trove_append_flags (StringInfo buf, int flags)

Macro Definition Documentation

PGPA_TE_CONFLICTING

#define PGPA_TE_CONFLICTING   0x0008

Definition at line 49 of file pgpa_trove.h.

PGPA_TE_FAILED

#define PGPA_TE_FAILED   0x0010

Definition at line 50 of file pgpa_trove.h.

PGPA_TE_INAPPLICABLE

#define PGPA_TE_INAPPLICABLE   0x0004

Definition at line 48 of file pgpa_trove.h.

PGPA_TE_MATCH_FULL

#define PGPA_TE_MATCH_FULL   0x0002

Definition at line 47 of file pgpa_trove.h.

PGPA_TE_MATCH_PARTIAL

#define PGPA_TE_MATCH_PARTIAL   0x0001

Definition at line 46 of file pgpa_trove.h.

Typedef Documentation

pgpa_trove

typedef struct pgpa_trove pgpa_trove

Definition at line 20 of file pgpa_trove.h.

pgpa_trove_entry

typedef struct pgpa_trove_entry pgpa_trove_entry

pgpa_trove_lookup_type

typedef enum pgpa_trove_lookup_type pgpa_trove_lookup_type

pgpa_trove_result

typedef struct pgpa_trove_result pgpa_trove_result

Enumeration Type Documentation

pgpa_trove_lookup_type

enum pgpa_trove_lookup_type

Enumerator
PGPA_TROVE_LOOKUP_JOIN
PGPA_TROVE_LOOKUP_REL
PGPA_TROVE_LOOKUP_SCAN

Definition at line 81 of file pgpa_trove.h.

{
    PGPA_TROVE_LOOKUP_JOIN,
    PGPA_TROVE_LOOKUP_REL,
    PGPA_TROVE_LOOKUP_SCAN
} pgpa_trove_lookup_type;

Function Documentation

pgpa_build_trove()

pgpa_trove * pgpa_build_trove ( List *  advice_items )

extern

Definition at line 132 of file pgpa_trove.c.

{
    pgpa_trove *trove = palloc_object(pgpa_trove);
 
    pgpa_init_trove_slice(&trove->join);
    pgpa_init_trove_slice(&trove->rel);
    pgpa_init_trove_slice(&trove->scan);
 
    foreach_ptr(pgpa_advice_item, item, advice_items)
    {
        switch (item->tag)
        {
            case PGPA_TAG_JOIN_ORDER:
                {
                    pgpa_advice_target *target;
 
                    /*
                     * For most advice types, each element in the top-level
                     * list is a separate target, but it's most convenient to
                     * regard the entirety of a JOIN_ORDER specification as a
                     * single target. Since it wasn't represented that way
                     * during parsing, build a surrogate object now.
                     */
                    target = palloc0_object(pgpa_advice_target);
                    target->ttype = PGPA_TARGET_ORDERED_LIST;
                    target->children = item->targets;
 
                    pgpa_trove_add_to_slice(&trove->join,
                                            item->tag, target);
                }
                break;
 
            case PGPA_TAG_BITMAP_HEAP_SCAN:
            case PGPA_TAG_DO_NOT_SCAN:
            case PGPA_TAG_INDEX_ONLY_SCAN:
            case PGPA_TAG_INDEX_SCAN:
            case PGPA_TAG_SEQ_SCAN:
            case PGPA_TAG_TID_SCAN:
 
                /*
                 * Scan advice.
                 */
                foreach_ptr(pgpa_advice_target, target, item->targets)
                {
                    /*
                     * For now, all of our scan types target single relations,
                     * but in the future this might not be true, e.g. a custom
                     * scan could replace a join.
                     */
                    Assert(target->ttype == PGPA_TARGET_IDENTIFIER);
                    pgpa_trove_add_to_slice(&trove->scan,
                                            item->tag, target);
                }
                break;
 
            case PGPA_TAG_FOREIGN_JOIN:
            case PGPA_TAG_HASH_JOIN:
            case PGPA_TAG_MERGE_JOIN_MATERIALIZE:
            case PGPA_TAG_MERGE_JOIN_PLAIN:
            case PGPA_TAG_NESTED_LOOP_MATERIALIZE:
            case PGPA_TAG_NESTED_LOOP_MEMOIZE:
            case PGPA_TAG_NESTED_LOOP_PLAIN:
            case PGPA_TAG_SEMIJOIN_NON_UNIQUE:
            case PGPA_TAG_SEMIJOIN_UNIQUE:
 
                /*
                 * Join strategy advice.
                 */
                foreach_ptr(pgpa_advice_target, target, item->targets)
                {
                    pgpa_trove_add_to_slice(&trove->join,
                                            item->tag, target);
                }
                break;
 
            case PGPA_TAG_PARTITIONWISE:
            case PGPA_TAG_GATHER:
            case PGPA_TAG_GATHER_MERGE:
            case PGPA_TAG_NO_GATHER:
 
                /*
                 * Advice about a RelOptInfo relevant to both scans and joins.
                 */
                foreach_ptr(pgpa_advice_target, target, item->targets)
                {
                    pgpa_trove_add_to_slice(&trove->rel,
                                            item->tag, target);
                }
                break;
        }
    }
 
    return trove;
}

References Assert, pgpa_advice_target::children, fb(), foreach_ptr, pgpa_trove::join, palloc0_object, palloc_object, pgpa_init_trove_slice(), 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_TARGET_IDENTIFIER, PGPA_TARGET_ORDERED_LIST, pgpa_trove_add_to_slice(), pgpa_trove::rel, pgpa_trove::scan, and pgpa_advice_target::ttype.

Referenced by pgpa_planner_setup().

pgpa_cstring_trove_entry()

char * pgpa_cstring_trove_entry ( pgpa_trove_entry *  entry )

extern

Definition at line 296 of file pgpa_trove.c.

{
    StringInfoData buf;
 
    initStringInfo(&buf);
    appendStringInfo(&buf, "%s", pgpa_cstring_advice_tag(entry->tag));
 
    /* JOIN_ORDER tags are transformed by pgpa_build_trove; undo that here */
    if (entry->tag != PGPA_TAG_JOIN_ORDER)
        appendStringInfoChar(&buf, '(');
    else
        Assert(entry->target->ttype == PGPA_TARGET_ORDERED_LIST);
 
    pgpa_format_advice_target(&buf, entry->target);
 
    if (entry->target->itarget != NULL)
    {
        appendStringInfoChar(&buf, ' ');
        pgpa_format_index_target(&buf, entry->target->itarget);
    }
 
    if (entry->tag != PGPA_TAG_JOIN_ORDER)
        appendStringInfoChar(&buf, ')');
 
    return buf.data;
}

References appendStringInfo(), appendStringInfoChar(), Assert, buf, fb(), initStringInfo(), pgpa_advice_target::itarget, pgpa_cstring_advice_tag(), pgpa_format_advice_target(), pgpa_format_index_target(), PGPA_TAG_JOIN_ORDER, PGPA_TARGET_ORDERED_LIST, pgpa_trove_entry::tag, pgpa_trove_entry::target, and pgpa_advice_target::ttype.

Referenced by pgpa_planner_append_feedback().

pgpa_trove_append_flags()

void pgpa_trove_append_flags ( StringInfo  buf, int  flags  )

extern

Definition at line 344 of file pgpa_trove.c.

{
    if ((flags & PGPA_TE_MATCH_FULL) != 0)
    {
        Assert((flags & PGPA_TE_MATCH_PARTIAL) != 0);
        appendStringInfo(buf, "matched");
    }
    else if ((flags & PGPA_TE_MATCH_PARTIAL) != 0)
        appendStringInfo(buf, "partially matched");
    else
        appendStringInfo(buf, "not matched");
    if ((flags & PGPA_TE_INAPPLICABLE) != 0)
        appendStringInfo(buf, ", inapplicable");
    if ((flags & PGPA_TE_CONFLICTING) != 0)
        appendStringInfo(buf, ", conflicting");
    if ((flags & PGPA_TE_FAILED) != 0)
        appendStringInfo(buf, ", failed");
}

References appendStringInfo(), Assert, buf, PGPA_TE_CONFLICTING, PGPA_TE_FAILED, PGPA_TE_INAPPLICABLE, PGPA_TE_MATCH_FULL, and PGPA_TE_MATCH_PARTIAL.

Referenced by pg_plan_advice_explain_feedback(), and pgpa_planner_feedback_warning().

pgpa_trove_lookup()

void pgpa_trove_lookup ( pgpa_trove *  trove, pgpa_trove_lookup_type  type, int  nrids, pgpa_identifier *  rids, pgpa_trove_result *  result  )

extern

Definition at line 234 of file pgpa_trove.c.

{
    pgpa_trove_slice *tslice;
    Bitmapset  *indexes;
 
    Assert(nrids > 0);
 
    if (type == PGPA_TROVE_LOOKUP_SCAN)
        tslice = &trove->scan;
    else if (type == PGPA_TROVE_LOOKUP_JOIN)
        tslice = &trove->join;
    else
        tslice = &trove->rel;
 
    indexes = pgpa_trove_slice_lookup(tslice, &rids[0]);
    for (int i = 1; i < nrids; ++i)
    {
        Bitmapset  *other_indexes;
 
        /*
         * If the caller is asking about two relations that aren't part of the
         * same subquery, they've messed up.
         */
        Assert(strings_equal_or_both_null(rids[0].plan_name,
                                          rids[i].plan_name));
 
        other_indexes = pgpa_trove_slice_lookup(tslice, &rids[i]);
        indexes = bms_union(indexes, other_indexes);
    }
 
    result->entries = tslice->entries;
    result->indexes = indexes;
}

References Assert, bms_union(), pgpa_trove_result::entries, fb(), i, pgpa_trove_result::indexes, pgpa_trove::join, PGPA_TROVE_LOOKUP_JOIN, PGPA_TROVE_LOOKUP_SCAN, pgpa_trove_slice_lookup(), pgpa_trove::rel, pgpa_trove::scan, strings_equal_or_both_null(), and type.

Referenced by pgpa_build_simple_rel(), and pgpa_get_join_state().

pgpa_trove_lookup_all()

void pgpa_trove_lookup_all ( pgpa_trove *  trove, pgpa_trove_lookup_type  type, pgpa_trove_entry **  entries, int *  nentries  )

extern

Definition at line 276 of file pgpa_trove.c.

{
    pgpa_trove_slice *tslice;
 
    if (type == PGPA_TROVE_LOOKUP_SCAN)
        tslice = &trove->scan;
    else if (type == PGPA_TROVE_LOOKUP_JOIN)
        tslice = &trove->join;
    else
        tslice = &trove->rel;
 
    *entries = tslice->entries;
    *nentries = tslice->nused;
}

References fb(), pgpa_trove::join, PGPA_TROVE_LOOKUP_JOIN, PGPA_TROVE_LOOKUP_SCAN, pgpa_trove::rel, pgpa_trove::scan, and type.

Referenced by pgpa_planner_append_feedback().

pgpa_trove_set_flags()

void pgpa_trove_set_flags ( pgpa_trove_entry *  entries, Bitmapset *  indexes, int  flags  )

extern

Definition at line 327 of file pgpa_trove.c.

{
    int         i = -1;
 
    while ((i = bms_next_member(indexes, i)) >= 0)
    {
        pgpa_trove_entry *entry = &entries[i];
 
        entry->flags |= flags;
    }
}

References bms_next_member(), pgpa_trove_entry::flags, and i.

Referenced by pgpa_planner_apply_join_path_advice(), pgpa_planner_apply_joinrel_advice(), and pgpa_planner_apply_scan_advice().