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	ApplyUnsignedSortComparator (Datum datum1, bool isNull1, Datum datum2, bool isNull2, SortSupport ssup)
static int	ApplyInt32SortComparator (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_int32_cmp (Datum x, Datum y, SortSupport ssup)
void	PrepareSortSupportComparisonShim (Oid cmpFunc, SortSupport ssup)
void	PrepareSortSupportFromOrderingOp (Oid orderingOp, SortSupport ssup)
void	PrepareSortSupportFromIndexRel (Relation indexRel, int16 strategy, 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

ApplyInt32SortComparator()

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

inlinestatic

Definition at line 302 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 = DatumGetInt32(datum1) < DatumGetInt32(datum2) ? -1 :
            DatumGetInt32(datum1) > DatumGetInt32(datum2) ? 1 : 0;
        if (ssup->ssup_reverse)
            INVERT_COMPARE_RESULT(compare);
    }
 
    return compare;
}

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

Referenced by qsort_tuple_int32_compare().

ApplySortAbbrevFullComparator()

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

inlinestatic

Definition at line 341 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(), 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(), INVERT_COMPARE_RESULT, SortSupportData::ssup_nulls_first, and SortSupportData::ssup_reverse.

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

ApplyUnsignedSortComparator()

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

inlinestatic

Definition at line 233 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 = datum1 < datum2 ? -1 : datum1 > datum2 ? 1 : 0;
        if (ssup->ssup_reverse)
            INVERT_COMPARE_RESULT(compare);
    }
 
    return compare;
}

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

Referenced by qsort_tuple_unsigned_compare().

PrepareSortSupportComparisonShim()

void PrepareSortSupportComparisonShim	(	Oid	cmpFunc,
		SortSupport	ssup
	)

Definition at line 69 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(), 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(), and MJExamineQuals().

PrepareSortSupportFromGistIndexRel()

void PrepareSortSupportFromGistIndexRel	(	Relation	indexRel,
		SortSupport	ssup
	)

Definition at line 189 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, 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,
		int16	strategy,
		SortSupport	ssup
	)

Definition at line 162 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_rel->relam != BTREE_AM_OID)
        elog(ERROR, "unexpected non-btree AM: %u", indexRel->rd_rel->relam);
    if (strategy != BTGreaterStrategyNumber &&
        strategy != BTLessStrategyNumber)
        elog(ERROR, "unexpected sort support strategy: %d", strategy);
    ssup->ssup_reverse = (strategy == BTGreaterStrategyNumber);
 
    FinishSortSupportFunction(opfamily, opcintype, ssup);
}

References Assert(), BTGreaterStrategyNumber, BTLessStrategyNumber, SortSupportData::comparator, elog(), ERROR, FinishSortSupportFunction(), 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
	)

Definition at line 135 of file sortsupport.c.

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

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

Referenced by compute_scalar_stats(), ExecInitGatherMerge(), ExecInitIndexScan(), ExecInitMergeAppend(), 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
	)

Definition at line 3201 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(), x, and y.

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

ssup_datum_unsigned_cmp()

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

Definition at line 3174 of file tuplesort.c.

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

References x, and y.

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