btree_gin.c File Reference

#include "postgres.h"
#include <limits.h>
#include "access/stratnum.h"
#include "mb/pg_wchar.h"
#include "utils/builtins.h"
#include "utils/date.h"
#include "utils/float.h"
#include "utils/inet.h"
#include "utils/numeric.h"
#include "utils/timestamp.h"
#include "utils/uuid.h"
#include "varatt.h"

Include dependency graph for btree_gin.c:

Go to the source code of this file.

Data Structures
struct	QueryInfo

Macros
#define	BTGIN_GET_BTREE_STRATEGY(strat)   ((strat) & 0x0F)
#define	BTGIN_GET_RHS_TYPE_CODE(strat)   ((strat) >> 4)
#define	GIN_SUPPORT(type, leftmostvalue, is_varlena, cvtfns, cmpfns)
#define	NUMERIC_IS_LEFTMOST(x)   ((x) == NULL)
#define	ENUM_IS_LEFTMOST(x)   ((x) == InvalidOid)

Typedefs
typedef struct QueryInfo	QueryInfo
typedef Datum(*	btree_gin_convert_function) (Datum input)
typedef Datum(*	btree_gin_leftmost_function) (void)

Functions
	PG_MODULE_MAGIC_EXT (.name="btree_gin",.version=PG_VERSION)
static Datum	gin_btree_extract_value (FunctionCallInfo fcinfo, bool is_varlena)
static Datum	gin_btree_extract_query (FunctionCallInfo fcinfo, btree_gin_leftmost_function leftmostvalue, const bool *rhs_is_varlena, const btree_gin_convert_function *cvt_fns, const PGFunction *cmp_fns)
static Datum	gin_btree_compare_prefix (FunctionCallInfo fcinfo)
	PG_FUNCTION_INFO_V1 (gin_btree_consistent)
Datum	gin_btree_consistent (PG_FUNCTION_ARGS)
static Datum	leftmostvalue_int2 (void)
static Datum	cvt_int4_int2 (Datum input)
static Datum	cvt_int8_int2 (Datum input)
static Datum	leftmostvalue_int4 (void)
static Datum	cvt_int2_int4 (Datum input)
static Datum	cvt_int8_int4 (Datum input)
static Datum	leftmostvalue_int8 (void)
static Datum	cvt_int2_int8 (Datum input)
static Datum	cvt_int4_int8 (Datum input)
static Datum	leftmostvalue_float4 (void)
static Datum	cvt_float8_float4 (Datum input)
static Datum	leftmostvalue_float8 (void)
static Datum	cvt_float4_float8 (Datum input)
static Datum	leftmostvalue_money (void)
static Datum	leftmostvalue_oid (void)
static Datum	leftmostvalue_timestamp (void)
static Datum	cvt_date_timestamp (Datum input)
static Datum	cvt_timestamptz_timestamp (Datum input)
static Datum	cvt_date_timestamptz (Datum input)
static Datum	cvt_timestamp_timestamptz (Datum input)
static Datum	leftmostvalue_time (void)
static Datum	leftmostvalue_timetz (void)
static Datum	leftmostvalue_date (void)
static Datum	cvt_timestamp_date (Datum input)
static Datum	cvt_timestamptz_date (Datum input)
static Datum	leftmostvalue_interval (void)
static Datum	leftmostvalue_macaddr (void)
static Datum	leftmostvalue_macaddr8 (void)
static Datum	leftmostvalue_inet (void)
static Datum	leftmostvalue_text (void)
static Datum	cvt_name_text (Datum input)
static Datum	leftmostvalue_char (void)
static Datum	leftmostvalue_bit (void)
static Datum	leftmostvalue_varbit (void)
	PG_FUNCTION_INFO_V1 (gin_numeric_cmp)
Datum	gin_numeric_cmp (PG_FUNCTION_ARGS)
static Datum	leftmostvalue_numeric (void)
	PG_FUNCTION_INFO_V1 (gin_enum_cmp)
Datum	gin_enum_cmp (PG_FUNCTION_ARGS)
static Datum	leftmostvalue_enum (void)
static Datum	leftmostvalue_uuid (void)
static Datum	leftmostvalue_name (void)
static Datum	cvt_text_name (Datum input)
static Datum	leftmostvalue_bool (void)

Variables
static const bool	int2_rhs_is_varlena []
static const btree_gin_convert_function	int2_cvt_fns []
static const PGFunction	int2_cmp_fns []
static const bool	int4_rhs_is_varlena []
static const btree_gin_convert_function	int4_cvt_fns []
static const PGFunction	int4_cmp_fns []
static const bool	int8_rhs_is_varlena []
static const btree_gin_convert_function	int8_cvt_fns []
static const PGFunction	int8_cmp_fns []
static const bool	float4_rhs_is_varlena []
static const btree_gin_convert_function	float4_cvt_fns []
static const PGFunction	float4_cmp_fns []
static const bool	float8_rhs_is_varlena []
static const btree_gin_convert_function	float8_cvt_fns []
static const PGFunction	float8_cmp_fns []
static const bool	money_rhs_is_varlena []
static const PGFunction	money_cmp_fns []
static const bool	oid_rhs_is_varlena []
static const PGFunction	oid_cmp_fns []
static const bool	timestamp_rhs_is_varlena []
static const btree_gin_convert_function	timestamp_cvt_fns []
static const PGFunction	timestamp_cmp_fns []
static const bool	timestamptz_rhs_is_varlena []
static const btree_gin_convert_function	timestamptz_cvt_fns []
static const PGFunction	timestamptz_cmp_fns []
static const bool	time_rhs_is_varlena []
static const PGFunction	time_cmp_fns []
static const bool	timetz_rhs_is_varlena []
static const PGFunction	timetz_cmp_fns []
static const bool	date_rhs_is_varlena []
static const btree_gin_convert_function	date_cvt_fns []
static const PGFunction	date_cmp_fns []
static const bool	interval_rhs_is_varlena []
static const PGFunction	interval_cmp_fns []
static const bool	macaddr_rhs_is_varlena []
static const PGFunction	macaddr_cmp_fns []
static const bool	macaddr8_rhs_is_varlena []
static const PGFunction	macaddr8_cmp_fns []
static const bool	inet_rhs_is_varlena []
static const PGFunction	inet_cmp_fns []
static const bool	cidr_rhs_is_varlena []
static const PGFunction	cidr_cmp_fns []
static const bool	text_rhs_is_varlena []
static const btree_gin_convert_function	text_cvt_fns []
static const PGFunction	text_cmp_fns []
static const bool	bpchar_rhs_is_varlena []
static const PGFunction	bpchar_cmp_fns []
static const bool	char_rhs_is_varlena []
static const PGFunction	char_cmp_fns []
static const bool	bytea_rhs_is_varlena []
static const PGFunction	bytea_cmp_fns []
static const bool	bit_rhs_is_varlena []
static const PGFunction	bit_cmp_fns []
static const bool	varbit_rhs_is_varlena []
static const PGFunction	varbit_cmp_fns []
static const bool	numeric_rhs_is_varlena []
static const PGFunction	numeric_cmp_fns []
static const bool	enum_rhs_is_varlena []
static const PGFunction	enum_cmp_fns []
static const bool	uuid_rhs_is_varlena []
static const PGFunction	uuid_cmp_fns []
static const bool	name_rhs_is_varlena []
static const btree_gin_convert_function	name_cvt_fns []
static const PGFunction	name_cmp_fns []
static const bool	bool_rhs_is_varlena []
static const PGFunction	bool_cmp_fns []

Macro Definition Documentation

BTGIN_GET_BTREE_STRATEGY

#define BTGIN_GET_BTREE_STRATEGY

(

strat

)

((strat) & 0x0F)

Definition at line 30 of file btree_gin.c.

BTGIN_GET_RHS_TYPE_CODE

#define BTGIN_GET_RHS_TYPE_CODE

(

strat

)

((strat) >> 4)

Definition at line 31 of file btree_gin.c.

ENUM_IS_LEFTMOST

#define ENUM_IS_LEFTMOST

(

x

)

((x) == InvalidOid)

Definition at line 860 of file btree_gin.c.

GIN_SUPPORT

#define GIN_SUPPORT	(		type,
			leftmostvalue,
			is_varlena,
			cvtfns,
			cmpfns
	)

Value:

PG_FUNCTION_INFO_V1(gin_extract_value_##type);                              \
Datum                                                                       \
gin_extract_value_##type(PG_FUNCTION_ARGS)                                  \
{                                                                           \
    return gin_btree_extract_value(fcinfo, is_varlena[0]);                  \
}   \
PG_FUNCTION_INFO_V1(gin_extract_query_##type);                              \
Datum                                                                       \
gin_extract_query_##type(PG_FUNCTION_ARGS)                                  \
{                                                                           \
    return gin_btree_extract_query(fcinfo,                                  \
                                   leftmostvalue, is_varlena,               \
                                   cvtfns, cmpfns);                         \
}   \
PG_FUNCTION_INFO_V1(gin_compare_prefix_##type);                             \
Datum                                                                       \
gin_compare_prefix_##type(PG_FUNCTION_ARGS)                                 \
{                                                                           \
    return gin_btree_compare_prefix(fcinfo);                                \
}

Definition at line 246 of file btree_gin.c.

NUMERIC_IS_LEFTMOST

#define NUMERIC_IS_LEFTMOST

(

x

)

((x) == NULL)

Definition at line 807 of file btree_gin.c.

Typedef Documentation

btree_gin_convert_function

typedef Datum(* btree_gin_convert_function) (Datum input)

Definition at line 42 of file btree_gin.c.

btree_gin_leftmost_function

typedef Datum(* btree_gin_leftmost_function) (void)

Definition at line 44 of file btree_gin.c.

QueryInfo

typedef struct QueryInfo QueryInfo

Function Documentation

cvt_date_timestamp()

static Datum cvt_date_timestamp ( Datum  input )

static

Definition at line 495 of file btree_gin.c.

{
    DateADT     val = DatumGetDateADT(input);
    Timestamp   result;
    int         overflow;
 
    result = date2timestamp_opt_overflow(val, &overflow);
    /* We can ignore the overflow result, since result is useful as-is */
    return TimestampGetDatum(result);
}

References date2timestamp_opt_overflow(), DatumGetDateADT(), input, TimestampGetDatum(), and val.

cvt_date_timestamptz()

static Datum cvt_date_timestamptz ( Datum  input )

static

Definition at line 530 of file btree_gin.c.

{
    DateADT     val = DatumGetDateADT(input);
    TimestampTz result;
    int         overflow;
 
    result = date2timestamptz_opt_overflow(val, &overflow);
    /* We can ignore the overflow result, since result is useful as-is */
    return TimestampTzGetDatum(result);
}

References date2timestamptz_opt_overflow(), DatumGetDateADT(), input, TimestampTzGetDatum(), and val.

cvt_float4_float8()

static Datum cvt_float4_float8 ( Datum  input )

static

Definition at line 442 of file btree_gin.c.

{
    float4      val = DatumGetFloat4(input);
 
    return Float8GetDatum((float8) val);
}

References DatumGetFloat4(), Float8GetDatum(), input, and val.

cvt_float8_float4()

static Datum cvt_float8_float4 ( Datum  input )

static

Definition at line 407 of file btree_gin.c.

{
    float8      val = DatumGetFloat8(input);
    float4      result;
 
    /*
     * Assume that ordinary C conversion will produce a usable result.
     * (Compare dtof(), which raises error conditions that we don't need.)
     * Note that for inputs that aren't exactly representable as float4, it
     * doesn't matter whether the conversion rounds up or down.  That might
     * cause us to scan a few index entries that we'll reject as not matching,
     * but we won't miss any that should match.
     */
    result = (float4) val;
    return Float4GetDatum(result);
}

References DatumGetFloat8(), Float4GetDatum(), input, and val.

cvt_int2_int4()

static Datum cvt_int2_int4 ( Datum  input )

static

Definition at line 339 of file btree_gin.c.

{
    int16       val = DatumGetInt16(input);
 
    return Int32GetDatum((int32) val);
}

References DatumGetInt16(), input, Int32GetDatum(), and val.

cvt_int2_int8()

static Datum cvt_int2_int8 ( Datum  input )

static

Definition at line 374 of file btree_gin.c.

{
    int16       val = DatumGetInt16(input);
 
    return Int64GetDatum((int64) val);
}

References DatumGetInt16(), input, Int64GetDatum(), and val.

cvt_int4_int2()

static Datum cvt_int4_int2 ( Datum  input )

static

Definition at line 295 of file btree_gin.c.

{
    int32       val = DatumGetInt32(input);
 
    val = Max(val, SHRT_MIN);
    val = Min(val, SHRT_MAX);
    return Int16GetDatum((int16) val);
}

References DatumGetInt32(), input, Int16GetDatum(), Max, Min, and val.

cvt_int4_int8()

static Datum cvt_int4_int8 ( Datum  input )

static

Definition at line 382 of file btree_gin.c.

{
    int32       val = DatumGetInt32(input);
 
    return Int64GetDatum((int64) val);
}

References DatumGetInt32(), input, Int64GetDatum(), and val.

cvt_int8_int2()

static Datum cvt_int8_int2 ( Datum  input )

static

Definition at line 305 of file btree_gin.c.

{
    int64       val = DatumGetInt64(input);
 
    val = Max(val, SHRT_MIN);
    val = Min(val, SHRT_MAX);
    return Int16GetDatum((int16) val);
}

References DatumGetInt64(), input, Int16GetDatum(), Max, Min, and val.

cvt_int8_int4()

static Datum cvt_int8_int4 ( Datum  input )

static

Definition at line 347 of file btree_gin.c.

{
    int64       val = DatumGetInt64(input);
 
    val = Max(val, INT_MIN);
    val = Min(val, INT_MAX);
    return Int32GetDatum((int32) val);
}

References DatumGetInt64(), input, Int32GetDatum(), Max, Min, and val.

cvt_name_text()

static Datum cvt_name_text ( Datum  input )

static

Definition at line 717 of file btree_gin.c.

{
    Name        val = DatumGetName(input);
 
    return PointerGetDatum(cstring_to_text(NameStr(*val)));
}

References cstring_to_text(), DatumGetName(), input, NameStr, PointerGetDatum(), and val.

cvt_text_name()

static Datum cvt_text_name ( Datum  input )

static

Definition at line 934 of file btree_gin.c.

{
    text       *val = DatumGetTextPP(input);
    NameData   *result = (NameData *) palloc0(NAMEDATALEN);
    int         len = VARSIZE_ANY_EXHDR(val);
 
    /*
     * Truncate oversize input.  We're assuming this will produce a result
     * considered less than the original.  That could be a bad assumption in
     * some collations, but fortunately an index on "name" is generally going
     * to use C collation.
     */
    if (len >= NAMEDATALEN)
        len = pg_mbcliplen(VARDATA_ANY(val), len, NAMEDATALEN - 1);
 
    memcpy(NameStr(*result), VARDATA_ANY(val), len);
 
    return NameGetDatum(result);
}

References DatumGetTextPP, input, len, NAMEDATALEN, NameGetDatum(), NameStr, palloc0(), pg_mbcliplen(), val, VARDATA_ANY(), and VARSIZE_ANY_EXHDR().

cvt_timestamp_date()

static Datum cvt_timestamp_date ( Datum  input )

static

Definition at line 604 of file btree_gin.c.

{
    Timestamp   val = DatumGetTimestamp(input);
    DateADT     result;
    int         overflow;
 
    result = timestamp2date_opt_overflow(val, &overflow);
    /* We can ignore the overflow result, since result is useful as-is */
    return DateADTGetDatum(result);
}

References DateADTGetDatum(), DatumGetTimestamp(), input, timestamp2date_opt_overflow(), and val.

cvt_timestamp_timestamptz()

static Datum cvt_timestamp_timestamptz ( Datum  input )

static

Definition at line 542 of file btree_gin.c.

{
    Timestamp   val = DatumGetTimestamp(input);
    TimestampTz result;
    int         overflow;
 
    result = timestamp2timestamptz_opt_overflow(val, &overflow);
    /* We can ignore the overflow result, since result is useful as-is */
    return TimestampTzGetDatum(result);
}

References DatumGetTimestamp(), input, timestamp2timestamptz_opt_overflow(), TimestampTzGetDatum(), and val.

cvt_timestamptz_date()

static Datum cvt_timestamptz_date ( Datum  input )

static

Definition at line 616 of file btree_gin.c.

{
    TimestampTz val = DatumGetTimestampTz(input);
    DateADT     result;
    int         overflow;
 
    result = timestamptz2date_opt_overflow(val, &overflow);
    /* We can ignore the overflow result, since result is useful as-is */
    return DateADTGetDatum(result);
}

References DateADTGetDatum(), DatumGetTimestampTz(), input, timestamptz2date_opt_overflow(), and val.

cvt_timestamptz_timestamp()

static Datum cvt_timestamptz_timestamp ( Datum  input )

static

Definition at line 507 of file btree_gin.c.

{
    TimestampTz val = DatumGetTimestampTz(input);
    Timestamp   result;
    int         overflow;
 
    result = timestamptz2timestamp_opt_overflow(val, &overflow);
    /* We can ignore the overflow result, since result is useful as-is */
    return TimestampGetDatum(result);
}

References DatumGetTimestampTz(), input, TimestampGetDatum(), timestamptz2timestamp_opt_overflow(), and val.

gin_btree_compare_prefix()

static Datum gin_btree_compare_prefix ( FunctionCallInfo  fcinfo )

static

Definition at line 149 of file btree_gin.c.

{
    Datum       partial_key PG_USED_FOR_ASSERTS_ONLY = PG_GETARG_DATUM(0);
    Datum       key = PG_GETARG_DATUM(1);
    QueryInfo  *data = (QueryInfo *) PG_GETARG_POINTER(3);
    int32       res,
                cmp;
 
    /*
     * partial_key is only an approximation to the real comparison value,
     * especially if it's a leftmost value.  We can get an accurate answer by
     * doing a possibly-cross-type comparison to the real comparison value.
     * (Note that partial_key and key are of the indexed datatype while
     * orig_datum is of the query operator's RHS datatype.)
     *
     * But just to be sure that things are what we expect, let's assert that
     * partial_key is indeed what gin_btree_extract_query reported, so that
     * we'll notice if anyone ever changes the core code in a way that breaks
     * our assumptions.
     */
    Assert(partial_key == data->entry_datum);
 
    cmp = DatumGetInt32(CallerFInfoFunctionCall2(data->typecmp,
                                                 fcinfo->flinfo,
                                                 PG_GET_COLLATION(),
                                                 data->orig_datum,
                                                 key));
 
    /*
     * Convert the comparison result to the correct thing for the search
     * operator strategy.  When dealing with cross-type comparisons, an
     * imprecise entry datum could lead GIN to start the scan just before the
     * first possible match, so we must continue the scan if the current index
     * entry doesn't satisfy the search condition for >= and > cases.  But if
     * that happens in an = search we can stop, because an imprecise entry
     * datum means that the search value is unrepresentable in the indexed
     * data type, so that there will be no exact matches.
     */
    switch (BTGIN_GET_BTREE_STRATEGY(data->strategy))
    {
        case BTLessStrategyNumber:
            /* If original datum > indexed one then return match */
            if (cmp > 0)
                res = 0;
            else
                res = 1;        /* end scan */
            break;
        case BTLessEqualStrategyNumber:
            /* If original datum >= indexed one then return match */
            if (cmp >= 0)
                res = 0;
            else
                res = 1;        /* end scan */
            break;
        case BTEqualStrategyNumber:
            /* If original datum = indexed one then return match */
            /* See above about why we can end scan when cmp < 0 */
            if (cmp == 0)
                res = 0;
            else
                res = 1;        /* end scan */
            break;
        case BTGreaterEqualStrategyNumber:
            /* If original datum <= indexed one then return match */
            if (cmp <= 0)
                res = 0;
            else
                res = -1;       /* keep scanning */
            break;
        case BTGreaterStrategyNumber:
            /* If original datum < indexed one then return match */
            if (cmp < 0)
                res = 0;
            else
                res = -1;       /* keep scanning */
            break;
        default:
            elog(ERROR, "unrecognized strategy number: %d",
                 data->strategy);
            res = 0;
    }
 
    PG_RETURN_INT32(res);
}

References Assert(), BTEqualStrategyNumber, BTGIN_GET_BTREE_STRATEGY, BTGreaterEqualStrategyNumber, BTGreaterStrategyNumber, BTLessEqualStrategyNumber, BTLessStrategyNumber, CallerFInfoFunctionCall2(), cmp(), data, DatumGetInt32(), elog, ERROR, FunctionCallInfoBaseData::flinfo, sort-test::key, PG_GET_COLLATION, PG_GETARG_DATUM, PG_GETARG_POINTER, PG_RETURN_INT32, and PG_USED_FOR_ASSERTS_ONLY.

gin_btree_consistent()

Datum gin_btree_consistent

(

PG_FUNCTION_ARGS

)

Definition at line 236 of file btree_gin.c.

{
    bool       *recheck = (bool *) PG_GETARG_POINTER(5);
 
    *recheck = false;
    PG_RETURN_BOOL(true);
}

References PG_GETARG_POINTER, and PG_RETURN_BOOL.

gin_btree_extract_query()

static Datum gin_btree_extract_query ( FunctionCallInfo  fcinfo, btree_gin_leftmost_function  leftmostvalue, const bool *  rhs_is_varlena, const btree_gin_convert_function *  cvt_fns, const PGFunction *  cmp_fns  )

static

Definition at line 66 of file btree_gin.c.

{
    Datum       datum = PG_GETARG_DATUM(0);
    int32      *nentries = (int32 *) PG_GETARG_POINTER(1);
    StrategyNumber strategy = PG_GETARG_UINT16(2);
    bool      **partialmatch = (bool **) PG_GETARG_POINTER(3);
    Pointer   **extra_data = (Pointer **) PG_GETARG_POINTER(4);
    Datum      *entries = (Datum *) palloc(sizeof(Datum));
    QueryInfo  *data = (QueryInfo *) palloc(sizeof(QueryInfo));
    bool       *ptr_partialmatch = (bool *) palloc(sizeof(bool));
    int         btree_strat,
                rhs_code;
 
    /*
     * Extract the btree strategy code and the RHS data type code from the
     * given strategy number.
     */
    btree_strat = BTGIN_GET_BTREE_STRATEGY(strategy);
    rhs_code = BTGIN_GET_RHS_TYPE_CODE(strategy);
 
    /*
     * Detoast the comparison datum.  This isn't necessary for correctness,
     * but it can save repeat detoastings within the comparison function.
     */
    if (rhs_is_varlena[rhs_code])
        datum = PointerGetDatum(PG_DETOAST_DATUM(datum));
 
    /* Prep single comparison key with possible partial-match flag */
    *nentries = 1;
    *partialmatch = ptr_partialmatch;
    *ptr_partialmatch = false;
 
    /*
     * For BTGreaterEqualStrategyNumber, BTGreaterStrategyNumber, and
     * BTEqualStrategyNumber we want to start the index scan at the supplied
     * query datum, and work forward.  For BTLessStrategyNumber and
     * BTLessEqualStrategyNumber, we need to start at the leftmost key, and
     * work forward until the supplied query datum (which we'll send along
     * inside the QueryInfo structure).  Use partial match rules except for
     * BTEqualStrategyNumber without a conversion function.  (If there is a
     * conversion function, comparison to the entry value is not trustworthy.)
     */
    switch (btree_strat)
    {
        case BTLessStrategyNumber:
        case BTLessEqualStrategyNumber:
            entries[0] = leftmostvalue();
            *ptr_partialmatch = true;
            break;
        case BTGreaterEqualStrategyNumber:
        case BTGreaterStrategyNumber:
            *ptr_partialmatch = true;
            /* FALLTHROUGH */
        case BTEqualStrategyNumber:
            /* If we have a conversion function, apply it */
            if (cvt_fns && cvt_fns[rhs_code])
            {
                entries[0] = (*cvt_fns[rhs_code]) (datum);
                *ptr_partialmatch = true;
            }
            else
                entries[0] = datum;
            break;
        default:
            elog(ERROR, "unrecognized strategy number: %d", strategy);
    }
 
    /* Fill "extra" data */
    data->strategy = strategy;
    data->orig_datum = datum;
    data->entry_datum = entries[0];
    data->typecmp = cmp_fns[rhs_code];
    *extra_data = (Pointer *) palloc(sizeof(Pointer));
    **extra_data = (Pointer) data;
 
    PG_RETURN_POINTER(entries);
}

References BTEqualStrategyNumber, BTGIN_GET_BTREE_STRATEGY, BTGIN_GET_RHS_TYPE_CODE, BTGreaterEqualStrategyNumber, BTGreaterStrategyNumber, BTLessEqualStrategyNumber, BTLessStrategyNumber, data, elog, ERROR, palloc(), PG_DETOAST_DATUM, PG_GETARG_DATUM, PG_GETARG_POINTER, PG_GETARG_UINT16, PG_RETURN_POINTER, and PointerGetDatum().

gin_btree_extract_value()

static Datum gin_btree_extract_value ( FunctionCallInfo  fcinfo, bool  is_varlena  )

static

Definition at line 50 of file btree_gin.c.

{
    Datum       datum = PG_GETARG_DATUM(0);
    int32      *nentries = (int32 *) PG_GETARG_POINTER(1);
    Datum      *entries = (Datum *) palloc(sizeof(Datum));
 
    /* Ensure that values stored in the index are not toasted */
    if (is_varlena)
        datum = PointerGetDatum(PG_DETOAST_DATUM(datum));
    entries[0] = datum;
    *nentries = 1;
 
    PG_RETURN_POINTER(entries);
}

References palloc(), PG_DETOAST_DATUM, PG_GETARG_DATUM, PG_GETARG_POINTER, PG_RETURN_POINTER, and PointerGetDatum().

gin_enum_cmp()

Datum gin_enum_cmp

(

PG_FUNCTION_ARGS

)

Definition at line 865 of file btree_gin.c.

{
    Oid         a = PG_GETARG_OID(0);
    Oid         b = PG_GETARG_OID(1);
    int         res = 0;
 
    if (ENUM_IS_LEFTMOST(a))
    {
        res = (ENUM_IS_LEFTMOST(b)) ? 0 : -1;
    }
    else if (ENUM_IS_LEFTMOST(b))
    {
        res = 1;
    }
    else
    {
        res = DatumGetInt32(CallerFInfoFunctionCall2(enum_cmp,
                                                     fcinfo->flinfo,
                                                     PG_GET_COLLATION(),
                                                     ObjectIdGetDatum(a),
                                                     ObjectIdGetDatum(b)));
    }
 
    PG_RETURN_INT32(res);
}

References a, b, CallerFInfoFunctionCall2(), DatumGetInt32(), enum_cmp(), ENUM_IS_LEFTMOST, ObjectIdGetDatum(), PG_GET_COLLATION, PG_GETARG_OID, and PG_RETURN_INT32.

gin_numeric_cmp()

Datum gin_numeric_cmp

(

PG_FUNCTION_ARGS

)

Definition at line 812 of file btree_gin.c.

{
    Numeric     a = (Numeric) PG_GETARG_POINTER(0);
    Numeric     b = (Numeric) PG_GETARG_POINTER(1);
    int         res = 0;
 
    if (NUMERIC_IS_LEFTMOST(a))
    {
        res = (NUMERIC_IS_LEFTMOST(b)) ? 0 : -1;
    }
    else if (NUMERIC_IS_LEFTMOST(b))
    {
        res = 1;
    }
    else
    {
        res = DatumGetInt32(DirectFunctionCall2(numeric_cmp,
                                                NumericGetDatum(a),
                                                NumericGetDatum(b)));
    }
 
    PG_RETURN_INT32(res);
}

References a, b, DatumGetInt32(), DirectFunctionCall2, numeric_cmp(), NUMERIC_IS_LEFTMOST, NumericGetDatum(), PG_GETARG_POINTER, and PG_RETURN_INT32.

leftmostvalue_bit()

static Datum leftmostvalue_bit ( void  )

static

Definition at line 766 of file btree_gin.c.

{
    return DirectFunctionCall3(bit_in,
                               CStringGetDatum(""),
                               ObjectIdGetDatum(0),
                               Int32GetDatum(-1));
}

References bit_in(), CStringGetDatum(), DirectFunctionCall3, Int32GetDatum(), and ObjectIdGetDatum().

leftmostvalue_bool()

static Datum leftmostvalue_bool ( void  )

static

Definition at line 966 of file btree_gin.c.

{
    return BoolGetDatum(false);
}

References BoolGetDatum().

leftmostvalue_char()

static Datum leftmostvalue_char ( void  )

static

Definition at line 744 of file btree_gin.c.

{
    return CharGetDatum(0);
}

References CharGetDatum().

leftmostvalue_date()

static Datum leftmostvalue_date ( void  )

static

Definition at line 598 of file btree_gin.c.

{
    return DateADTGetDatum(DATEVAL_NOBEGIN);
}

References DateADTGetDatum(), and DATEVAL_NOBEGIN.

leftmostvalue_enum()

static Datum leftmostvalue_enum ( void  )

static

Definition at line 892 of file btree_gin.c.

{
    return ObjectIdGetDatum(InvalidOid);
}

References InvalidOid, and ObjectIdGetDatum().

leftmostvalue_float4()

static Datum leftmostvalue_float4 ( void  )

static

Definition at line 401 of file btree_gin.c.

{
    return Float4GetDatum(-get_float4_infinity());
}

References Float4GetDatum(), and get_float4_infinity().

leftmostvalue_float8()

static Datum leftmostvalue_float8 ( void  )

static

Definition at line 436 of file btree_gin.c.

{
    return Float8GetDatum(-get_float8_infinity());
}

References Float8GetDatum(), and get_float8_infinity().

leftmostvalue_inet()

static Datum leftmostvalue_inet ( void  )

static

Definition at line 689 of file btree_gin.c.

{
    return DirectFunctionCall1(inet_in, CStringGetDatum("0.0.0.0/0"));
}

References CStringGetDatum(), DirectFunctionCall1, and inet_in().

leftmostvalue_int2()

static Datum leftmostvalue_int2 ( void  )

static

Definition at line 273 of file btree_gin.c.

{
    return Int16GetDatum(SHRT_MIN);
}

References Int16GetDatum().

leftmostvalue_int4()

static Datum leftmostvalue_int4 ( void  )

static

Definition at line 333 of file btree_gin.c.

{
    return Int32GetDatum(INT_MIN);
}

References Int32GetDatum().

leftmostvalue_int8()

static Datum leftmostvalue_int8 ( void  )

static

Definition at line 368 of file btree_gin.c.

{
    return Int64GetDatum(PG_INT64_MIN);
}

References Int64GetDatum(), and PG_INT64_MIN.

leftmostvalue_interval()

static Datum leftmostvalue_interval ( void  )

static

Definition at line 639 of file btree_gin.c.

{
    Interval   *v = palloc(sizeof(Interval));
 
    INTERVAL_NOBEGIN(v);
 
    return IntervalPGetDatum(v);
}

References INTERVAL_NOBEGIN, IntervalPGetDatum(), and palloc().

leftmostvalue_macaddr()

static Datum leftmostvalue_macaddr ( void  )

static

Definition at line 657 of file btree_gin.c.

{
    macaddr    *v = palloc0(sizeof(macaddr));
 
    return MacaddrPGetDatum(v);
}

References MacaddrPGetDatum(), and palloc0().

leftmostvalue_macaddr8()

static Datum leftmostvalue_macaddr8 ( void  )

static

Definition at line 673 of file btree_gin.c.

{
    macaddr8   *v = palloc0(sizeof(macaddr8));
 
    return Macaddr8PGetDatum(v);
}

References Macaddr8PGetDatum(), and palloc0().

leftmostvalue_money()

static Datum leftmostvalue_money ( void  )

static

Definition at line 461 of file btree_gin.c.

{
    return Int64GetDatum(PG_INT64_MIN);
}

References Int64GetDatum(), and PG_INT64_MIN.

leftmostvalue_name()

static Datum leftmostvalue_name ( void  )

static

Definition at line 926 of file btree_gin.c.

{
    NameData   *result = (NameData *) palloc0(NAMEDATALEN);
 
    return NameGetDatum(result);
}

References NAMEDATALEN, NameGetDatum(), and palloc0().

leftmostvalue_numeric()

static Datum leftmostvalue_numeric ( void  )

static

Definition at line 837 of file btree_gin.c.

{
    return PointerGetDatum(NULL);
}

References PointerGetDatum().

leftmostvalue_oid()

static Datum leftmostvalue_oid ( void  )

static

Definition at line 475 of file btree_gin.c.

{
    return ObjectIdGetDatum(0);
}

References ObjectIdGetDatum().

leftmostvalue_text()

static Datum leftmostvalue_text ( void  )

static

Definition at line 711 of file btree_gin.c.

{
    return PointerGetDatum(cstring_to_text_with_len("", 0));
}

References cstring_to_text_with_len(), and PointerGetDatum().

leftmostvalue_time()

static Datum leftmostvalue_time ( void  )

static

Definition at line 565 of file btree_gin.c.

{
    return TimeADTGetDatum(0);
}

References TimeADTGetDatum().

leftmostvalue_timestamp()

static Datum leftmostvalue_timestamp ( void  )

static

Definition at line 489 of file btree_gin.c.

{
    return TimestampGetDatum(DT_NOBEGIN);
}

References DT_NOBEGIN, and TimestampGetDatum().

leftmostvalue_timetz()

static Datum leftmostvalue_timetz ( void  )

static

Definition at line 579 of file btree_gin.c.

{
    TimeTzADT  *v = palloc(sizeof(TimeTzADT));
 
    v->time = 0;
    v->zone = -24 * 3600;       /* XXX is that true? */
 
    return TimeTzADTPGetDatum(v);
}

References palloc(), TimeTzADT::time, TimeTzADTPGetDatum(), and TimeTzADT::zone.

leftmostvalue_uuid()

static Datum leftmostvalue_uuid ( void  )

static

Definition at line 906 of file btree_gin.c.

{
    /*
     * palloc0 will create the UUID with all zeroes:
     * "00000000-0000-0000-0000-000000000000"
     */
    pg_uuid_t  *retval = (pg_uuid_t *) palloc0(sizeof(pg_uuid_t));
 
    return UUIDPGetDatum(retval);
}

References palloc0(), and UUIDPGetDatum().

leftmostvalue_varbit()

static Datum leftmostvalue_varbit ( void  )

static

Definition at line 783 of file btree_gin.c.

{
    return DirectFunctionCall3(varbit_in,
                               CStringGetDatum(""),
                               ObjectIdGetDatum(0),
                               Int32GetDatum(-1));
}

References CStringGetDatum(), DirectFunctionCall3, Int32GetDatum(), ObjectIdGetDatum(), and varbit_in().

PG_FUNCTION_INFO_V1() [1/3]

PG_FUNCTION_INFO_V1

(

gin_btree_consistent

)

PG_FUNCTION_INFO_V1() [2/3]

PG_FUNCTION_INFO_V1

(

gin_enum_cmp

)

PG_FUNCTION_INFO_V1() [3/3]

PG_FUNCTION_INFO_V1

(

gin_numeric_cmp

)

PG_MODULE_MAGIC_EXT()

PG_MODULE_MAGIC_EXT	(	.	name = "btree_gin",
		.	version = PG_VERSION
	)

Variable Documentation

bit_cmp_fns

const PGFunction bit_cmp_fns[]

static

Initial value:

=
{bitcmp}

Definition at line 777 of file btree_gin.c.

bit_rhs_is_varlena

const bool bit_rhs_is_varlena[]

static

Initial value:

=
{true}

Definition at line 774 of file btree_gin.c.

bool_cmp_fns

const PGFunction bool_cmp_fns[]

static

Initial value:

=
{btboolcmp}

Definition at line 974 of file btree_gin.c.

bool_rhs_is_varlena

const bool bool_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 971 of file btree_gin.c.

bpchar_cmp_fns

const PGFunction bpchar_cmp_fns[]

static

Initial value:

=
{bpcharcmp}

Definition at line 738 of file btree_gin.c.

bpchar_rhs_is_varlena

const bool bpchar_rhs_is_varlena[]

static

Initial value:

=
{true}

Definition at line 735 of file btree_gin.c.

bytea_cmp_fns

const PGFunction bytea_cmp_fns[]

static

Initial value:

=
{byteacmp}

Definition at line 760 of file btree_gin.c.

bytea_rhs_is_varlena

const bool bytea_rhs_is_varlena[]

static

Initial value:

=
{true}

Definition at line 757 of file btree_gin.c.

char_cmp_fns

const PGFunction char_cmp_fns[]

static

Initial value:

=
{btcharcmp}

Definition at line 752 of file btree_gin.c.

char_rhs_is_varlena

const bool char_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 749 of file btree_gin.c.

cidr_cmp_fns

const PGFunction cidr_cmp_fns[]

static

Initial value:

=
{network_cmp}

Definition at line 705 of file btree_gin.c.

cidr_rhs_is_varlena

const bool cidr_rhs_is_varlena[]

static

Initial value:

=
{true}

Definition at line 702 of file btree_gin.c.

date_cmp_fns

const PGFunction date_cmp_fns[]

static

Initial value:

=
{date_cmp, timestamp_cmp_date, timestamptz_cmp_date}

Definition at line 633 of file btree_gin.c.

date_cvt_fns

const btree_gin_convert_function date_cvt_fns[]

static

Initial value:

=
{NULL, cvt_timestamp_date, cvt_timestamptz_date}

Definition at line 630 of file btree_gin.c.

date_rhs_is_varlena

const bool date_rhs_is_varlena[]

static

Initial value:

=
{false, false, false}

Definition at line 627 of file btree_gin.c.

enum_cmp_fns

const PGFunction enum_cmp_fns[]

static

Initial value:

=
{gin_enum_cmp}

Definition at line 900 of file btree_gin.c.

enum_rhs_is_varlena

const bool enum_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 897 of file btree_gin.c.

float4_cmp_fns

const PGFunction float4_cmp_fns[]

static

Initial value:

=
{btfloat4cmp, btfloat84cmp}

Definition at line 430 of file btree_gin.c.

float4_cvt_fns

const btree_gin_convert_function float4_cvt_fns[]

static

Initial value:

=
{NULL, cvt_float8_float4}

Definition at line 427 of file btree_gin.c.

float4_rhs_is_varlena

const bool float4_rhs_is_varlena[]

static

Initial value:

=
{false, false}

Definition at line 424 of file btree_gin.c.

float8_cmp_fns

const PGFunction float8_cmp_fns[]

static

Initial value:

=
{btfloat8cmp, btfloat48cmp}

Definition at line 455 of file btree_gin.c.

float8_cvt_fns

const btree_gin_convert_function float8_cvt_fns[]

static

Initial value:

=
{NULL, cvt_float4_float8}

Definition at line 452 of file btree_gin.c.

float8_rhs_is_varlena

const bool float8_rhs_is_varlena[]

static

Initial value:

=
{false, false}

Definition at line 449 of file btree_gin.c.

inet_cmp_fns

const PGFunction inet_cmp_fns[]

static

Initial value:

=
{network_cmp}

Definition at line 697 of file btree_gin.c.

inet_rhs_is_varlena

const bool inet_rhs_is_varlena[]

static

Initial value:

=
{true}

Definition at line 694 of file btree_gin.c.

int2_cmp_fns

const PGFunction int2_cmp_fns[]

static

Initial value:

=
{btint2cmp, btint42cmp, btint82cmp}

Definition at line 327 of file btree_gin.c.

int2_cvt_fns

const btree_gin_convert_function int2_cvt_fns[]

static

Initial value:

=
{NULL, cvt_int4_int2, cvt_int8_int2}

Definition at line 324 of file btree_gin.c.

int2_rhs_is_varlena

const bool int2_rhs_is_varlena[]

static

Initial value:

=
{false, false, false}

Definition at line 321 of file btree_gin.c.

int4_cmp_fns

const PGFunction int4_cmp_fns[]

static

Initial value:

=
{btint4cmp, btint24cmp, btint84cmp}

Definition at line 362 of file btree_gin.c.

int4_cvt_fns

const btree_gin_convert_function int4_cvt_fns[]

static

Initial value:

=
{NULL, cvt_int2_int4, cvt_int8_int4}

Definition at line 359 of file btree_gin.c.

int4_rhs_is_varlena

const bool int4_rhs_is_varlena[]

static

Initial value:

=
{false, false, false}

Definition at line 356 of file btree_gin.c.

int8_cmp_fns

const PGFunction int8_cmp_fns[]

static

Initial value:

=
{btint8cmp, btint28cmp, btint48cmp}

Definition at line 395 of file btree_gin.c.

int8_cvt_fns

const btree_gin_convert_function int8_cvt_fns[]

static

Initial value:

=
{NULL, cvt_int2_int8, cvt_int4_int8}

Definition at line 392 of file btree_gin.c.

int8_rhs_is_varlena

const bool int8_rhs_is_varlena[]

static

Initial value:

=
{false, false, false}

Definition at line 389 of file btree_gin.c.

interval_cmp_fns

const PGFunction interval_cmp_fns[]

static

Initial value:

=
{interval_cmp}

Definition at line 651 of file btree_gin.c.

interval_rhs_is_varlena

const bool interval_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 648 of file btree_gin.c.

macaddr8_cmp_fns

const PGFunction macaddr8_cmp_fns[]

static

Initial value:

=
{macaddr8_cmp}

Definition at line 683 of file btree_gin.c.

macaddr8_rhs_is_varlena

const bool macaddr8_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 680 of file btree_gin.c.

macaddr_cmp_fns

const PGFunction macaddr_cmp_fns[]

static

Initial value:

=
{macaddr_cmp}

Definition at line 667 of file btree_gin.c.

macaddr_rhs_is_varlena

const bool macaddr_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 664 of file btree_gin.c.

money_cmp_fns

const PGFunction money_cmp_fns[]

static

Initial value:

=
{cash_cmp}

Definition at line 469 of file btree_gin.c.

money_rhs_is_varlena

const bool money_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 466 of file btree_gin.c.

name_cmp_fns

const PGFunction name_cmp_fns[]

static

Initial value:

=
{btnamecmp, bttextnamecmp}

Definition at line 960 of file btree_gin.c.

name_cvt_fns

const btree_gin_convert_function name_cvt_fns[]

static

Initial value:

=
{NULL, cvt_text_name}

Definition at line 957 of file btree_gin.c.

name_rhs_is_varlena

const bool name_rhs_is_varlena[]

static

Initial value:

=
{false, true}

Definition at line 954 of file btree_gin.c.

numeric_cmp_fns

const PGFunction numeric_cmp_fns[]

static

Initial value:

=
{gin_numeric_cmp}

Definition at line 845 of file btree_gin.c.

numeric_rhs_is_varlena

const bool numeric_rhs_is_varlena[]

static

Initial value:

=
{true}

Definition at line 842 of file btree_gin.c.

oid_cmp_fns

const PGFunction oid_cmp_fns[]

static

Initial value:

=
{btoidcmp}

Definition at line 483 of file btree_gin.c.

oid_rhs_is_varlena

const bool oid_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 480 of file btree_gin.c.

text_cmp_fns

const PGFunction text_cmp_fns[]

static

Initial value:

=
{bttextcmp, btnametextcmp}

Definition at line 730 of file btree_gin.c.

text_cvt_fns

const btree_gin_convert_function text_cvt_fns[]

static

Initial value:

=
{NULL, cvt_name_text}

Definition at line 727 of file btree_gin.c.

text_rhs_is_varlena

const bool text_rhs_is_varlena[]

static

Initial value:

=
{true, false}

Definition at line 724 of file btree_gin.c.

time_cmp_fns

const PGFunction time_cmp_fns[]

static

Initial value:

=
{time_cmp}

Definition at line 573 of file btree_gin.c.

time_rhs_is_varlena

const bool time_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 570 of file btree_gin.c.

timestamp_cmp_fns

const PGFunction timestamp_cmp_fns[]

static

Initial value:

=
{timestamp_cmp, date_cmp_timestamp, timestamptz_cmp_timestamp}

Definition at line 524 of file btree_gin.c.

timestamp_cvt_fns

const btree_gin_convert_function timestamp_cvt_fns[]

static

Initial value:

=
{NULL, cvt_date_timestamp, cvt_timestamptz_timestamp}

Definition at line 521 of file btree_gin.c.

timestamp_rhs_is_varlena

const bool timestamp_rhs_is_varlena[]

static

Initial value:

=
{false, false, false}

Definition at line 518 of file btree_gin.c.

timestamptz_cmp_fns

const PGFunction timestamptz_cmp_fns[]

static

Initial value:

=
{timestamp_cmp, date_cmp_timestamptz, timestamp_cmp_timestamptz}

Definition at line 559 of file btree_gin.c.

timestamptz_cvt_fns

const btree_gin_convert_function timestamptz_cvt_fns[]

static

Initial value:

=
{NULL, cvt_date_timestamptz, cvt_timestamp_timestamptz}

Definition at line 556 of file btree_gin.c.

timestamptz_rhs_is_varlena

const bool timestamptz_rhs_is_varlena[]

static

Initial value:

=
{false, false, false}

Definition at line 553 of file btree_gin.c.

timetz_cmp_fns

const PGFunction timetz_cmp_fns[]

static

Initial value:

=
{timetz_cmp}

Definition at line 592 of file btree_gin.c.

timetz_rhs_is_varlena

const bool timetz_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 589 of file btree_gin.c.

uuid_cmp_fns

const PGFunction uuid_cmp_fns[]

static

Initial value:

=
{uuid_cmp}

Definition at line 920 of file btree_gin.c.

uuid_rhs_is_varlena

const bool uuid_rhs_is_varlena[]

static

Initial value:

=
{false}

Definition at line 917 of file btree_gin.c.

varbit_cmp_fns

const PGFunction varbit_cmp_fns[]

static

Initial value:

=
{bitcmp}

Definition at line 794 of file btree_gin.c.

varbit_rhs_is_varlena

const bool varbit_rhs_is_varlena[]

static

Initial value:

=
{true}

Definition at line 791 of file btree_gin.c.