sortsupport.h File Reference

#include "access/attnum.h"
#include "utils/relcache.h"

Include dependency graph for sortsupport.h:

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

Go to the source code of this file.

Data Structures
struct	SortSupportData

Typedefs
typedef struct SortSupportData *	SortSupport
typedef struct SortSupportData	SortSupportData

Functions
static int	ApplySortComparator (Datum datum1, bool isNull1, Datum datum2, bool isNull2, SortSupport ssup)
static int	ApplySortAbbrevFullComparator (Datum datum1, bool isNull1, Datum datum2, bool isNull2, SortSupport ssup)
int	ssup_datum_unsigned_cmp (Datum x, Datum y, SortSupport ssup)
int	ssup_datum_signed_cmp (Datum x, Datum y, SortSupport ssup)
int	ssup_datum_int32_cmp (Datum x, Datum y, SortSupport ssup)
void	PrepareSortSupportComparisonShim (Oid cmpFunc, SortSupport ssup)
void	PrepareSortSupportFromOrderingOp (Oid orderingOp, SortSupport ssup)
void	PrepareSortSupportFromIndexRel (Relation indexRel, bool reverse, SortSupport ssup)
void	PrepareSortSupportFromGistIndexRel (Relation indexRel, SortSupport ssup)

Typedef Documentation

SortSupport

typedef struct SortSupportData* SortSupport

Definition at line 58 of file sortsupport.h.

SortSupportData

typedef struct SortSupportData SortSupportData

Function Documentation

ApplySortAbbrevFullComparator()

static int ApplySortAbbrevFullComparator ( Datum  datum1, bool  isNull1, Datum  datum2, bool  isNull2, SortSupport  ssup  )

inlinestatic

Definition at line 238 of file sortsupport.h.

{
    int         compare;
 
    if (isNull1)
    {
        if (isNull2)
            compare = 0;        /* NULL "=" NULL */
        else if (ssup->ssup_nulls_first)
            compare = -1;       /* NULL "<" NOT_NULL */
        else
            compare = 1;        /* NULL ">" NOT_NULL */
    }
    else if (isNull2)
    {
        if (ssup->ssup_nulls_first)
            compare = 1;        /* NOT_NULL ">" NULL */
        else
            compare = -1;       /* NOT_NULL "<" NULL */
    }
    else
    {
        compare = ssup->abbrev_full_comparator(datum1, datum2, ssup);
        if (ssup->ssup_reverse)
            INVERT_COMPARE_RESULT(compare);
    }
 
    return compare;
}

References SortSupportData::abbrev_full_comparator, compare(), fb(), INVERT_COMPARE_RESULT, SortSupportData::ssup_nulls_first, and SortSupportData::ssup_reverse.

Referenced by comparetup_cluster_tiebreak(), comparetup_datum_tiebreak(), comparetup_heap_tiebreak(), and comparetup_index_btree_tiebreak().

ApplySortComparator()

static int ApplySortComparator ( Datum  datum1, bool  isNull1, Datum  datum2, bool  isNull2, SortSupport  ssup  )

inlinestatic

Definition at line 200 of file sortsupport.h.

{
    int         compare;
 
    if (isNull1)
    {
        if (isNull2)
            compare = 0;        /* NULL "=" NULL */
        else if (ssup->ssup_nulls_first)
            compare = -1;       /* NULL "<" NOT_NULL */
        else
            compare = 1;        /* NULL ">" NOT_NULL */
    }
    else if (isNull2)
    {
        if (ssup->ssup_nulls_first)
            compare = 1;        /* NOT_NULL ">" NULL */
        else
            compare = -1;       /* NOT_NULL "<" NULL */
    }
    else
    {
        compare = ssup->comparator(datum1, datum2, ssup);
        if (ssup->ssup_reverse)
            INVERT_COMPARE_RESULT(compare);
    }
 
    return compare;
}

References SortSupportData::comparator, compare(), fb(), INVERT_COMPARE_RESULT, SortSupportData::ssup_nulls_first, and SortSupportData::ssup_reverse.

Referenced by _bt_load(), _gin_compare_tuples(), compare_datums_simple(), compare_scalars(), comparetup_cluster(), comparetup_cluster_tiebreak(), comparetup_datum(), comparetup_heap(), comparetup_heap_tiebreak(), comparetup_index_btree(), comparetup_index_btree_tiebreak(), GinBufferKeyEquals(), heap_compare_slots(), heap_compare_slots(), MJCompare(), multi_sort_compare(), multi_sort_compare_dim(), multi_sort_compare_dims(), setop_compare_slots(), and sort_item_compare().

PrepareSortSupportComparisonShim()

void PrepareSortSupportComparisonShim ( Oid  cmpFunc, SortSupport  ssup  )

extern

Definition at line 68 of file sortsupport.c.

{
    SortShimExtra *extra;
 
    extra = (SortShimExtra *) MemoryContextAlloc(ssup->ssup_cxt,
                                                 SizeForSortShimExtra(2));
 
    /* Lookup the comparison function */
    fmgr_info_cxt(cmpFunc, &extra->flinfo, ssup->ssup_cxt);
 
    /* We can initialize the callinfo just once and re-use it */
    InitFunctionCallInfoData(extra->fcinfo, &extra->flinfo, 2,
                             ssup->ssup_collation, NULL, NULL);
    extra->fcinfo.args[0].isnull = false;
    extra->fcinfo.args[1].isnull = false;
 
    ssup->ssup_extra = extra;
    ssup->comparator = comparison_shim;
}

References FunctionCallInfoBaseData::args, SortSupportData::comparator, comparison_shim(), fb(), SortShimExtra::fcinfo, SortShimExtra::flinfo, fmgr_info_cxt(), InitFunctionCallInfoData, NullableDatum::isnull, MemoryContextAlloc(), SizeForSortShimExtra, SortSupportData::ssup_collation, SortSupportData::ssup_cxt, and SortSupportData::ssup_extra.

Referenced by FinishSortSupportFunction(), GinBufferInit(), MJExamineQuals(), and tuplesort_begin_index_gin().

PrepareSortSupportFromGistIndexRel()

void PrepareSortSupportFromGistIndexRel ( Relation  indexRel, SortSupport  ssup  )

extern

Definition at line 185 of file sortsupport.c.

{
    Oid         opfamily = indexRel->rd_opfamily[ssup->ssup_attno - 1];
    Oid         opcintype = indexRel->rd_opcintype[ssup->ssup_attno - 1];
    Oid         sortSupportFunction;
 
    Assert(ssup->comparator == NULL);
 
    if (indexRel->rd_rel->relam != GIST_AM_OID)
        elog(ERROR, "unexpected non-gist AM: %u", indexRel->rd_rel->relam);
    ssup->ssup_reverse = false;
 
    /*
     * Look up the sort support function. This is simpler than for B-tree
     * indexes because we don't support the old-style btree comparators.
     */
    sortSupportFunction = get_opfamily_proc(opfamily, opcintype, opcintype,
                                            GIST_SORTSUPPORT_PROC);
    if (!OidIsValid(sortSupportFunction))
        elog(ERROR, "missing support function %d(%u,%u) in opfamily %u",
             GIST_SORTSUPPORT_PROC, opcintype, opcintype, opfamily);
    OidFunctionCall1(sortSupportFunction, PointerGetDatum(ssup));
}

References Assert, SortSupportData::comparator, elog, ERROR, fb(), get_opfamily_proc(), GIST_SORTSUPPORT_PROC, OidFunctionCall1, OidIsValid, PointerGetDatum(), RelationData::rd_opcintype, RelationData::rd_opfamily, RelationData::rd_rel, SortSupportData::ssup_attno, and SortSupportData::ssup_reverse.

Referenced by tuplesort_begin_index_gist().

PrepareSortSupportFromIndexRel()

void PrepareSortSupportFromIndexRel ( Relation  indexRel, bool  reverse, SortSupport  ssup  )

extern

Definition at line 161 of file sortsupport.c.

{
    Oid         opfamily = indexRel->rd_opfamily[ssup->ssup_attno - 1];
    Oid         opcintype = indexRel->rd_opcintype[ssup->ssup_attno - 1];
 
    Assert(ssup->comparator == NULL);
 
    if (!indexRel->rd_indam->amcanorder)
        elog(ERROR, "unexpected non-amcanorder AM: %u", indexRel->rd_rel->relam);
    ssup->ssup_reverse = reverse;
 
    FinishSortSupportFunction(opfamily, opcintype, ssup);
}

References IndexAmRoutine::amcanorder, Assert, SortSupportData::comparator, elog, ERROR, fb(), FinishSortSupportFunction(), RelationData::rd_indam, RelationData::rd_opcintype, RelationData::rd_opfamily, RelationData::rd_rel, SortSupportData::ssup_attno, and SortSupportData::ssup_reverse.

Referenced by _bt_load(), tuplesort_begin_cluster(), and tuplesort_begin_index_btree().

PrepareSortSupportFromOrderingOp()

void PrepareSortSupportFromOrderingOp ( Oid  orderingOp, SortSupport  ssup  )

extern

Definition at line 134 of file sortsupport.c.

{
    Oid         opfamily;
    Oid         opcintype;
    CompareType cmptype;
 
    Assert(ssup->comparator == NULL);
 
    /* Find the operator in pg_amop */
    if (!get_ordering_op_properties(orderingOp, &opfamily, &opcintype,
                                    &cmptype))
        elog(ERROR, "operator %u is not a valid ordering operator",
             orderingOp);
    ssup->ssup_reverse = (cmptype == COMPARE_GT);
 
    FinishSortSupportFunction(opfamily, opcintype, ssup);
}

References Assert, SortSupportData::comparator, COMPARE_GT, elog, ERROR, fb(), FinishSortSupportFunction(), get_ordering_op_properties(), and SortSupportData::ssup_reverse.

Referenced by compute_scalar_stats(), ExecInitGatherMerge(), ExecInitIndexScan(), ExecInitMergeAppend(), ExecInitSetOp(), multi_sort_add_dimension(), statext_mcv_serialize(), tuplesort_begin_datum(), and tuplesort_begin_heap().

ssup_datum_int32_cmp()

int ssup_datum_int32_cmp ( Datum  x, Datum  y, SortSupport  ssup  )

extern

Definition at line 3436 of file tuplesort.c.

{
    int32       xx = DatumGetInt32(x);
    int32       yy = DatumGetInt32(y);
 
    if (xx < yy)
        return -1;
    else if (xx > yy)
        return 1;
    else
        return 0;
}

References DatumGetInt32(), fb(), x, and y.

Referenced by btint4sortsupport(), date_sortsupport(), normalize_datum(), and tuplesort_sort_memtuples().

ssup_datum_signed_cmp()

int ssup_datum_signed_cmp ( Datum  x, Datum  y, SortSupport  ssup  )

extern

Definition at line 3422 of file tuplesort.c.

{
    int64       xx = DatumGetInt64(x);
    int64       yy = DatumGetInt64(y);
 
    if (xx < yy)
        return -1;
    else if (xx > yy)
        return 1;
    else
        return 0;
}

References DatumGetInt64(), fb(), x, and y.

Referenced by btint8sortsupport(), normalize_datum(), timestamp_sortsupport(), and tuplesort_sort_memtuples().

ssup_datum_unsigned_cmp()

int ssup_datum_unsigned_cmp ( Datum  x, Datum  y, SortSupport  ssup  )

extern

Definition at line 3411 of file tuplesort.c.

{
    if (x < y)
        return -1;
    else if (x > y)
        return 1;
    else
        return 0;
}

References x, and y.

Referenced by bytea_sortsupport(), gist_point_sortsupport(), macaddr_sortsupport(), network_sortsupport(), normalize_datum(), tuplesort_sort_memtuples(), uuid_sortsupport(), and varstr_sortsupport().