btree_gin.c File Reference

#include "postgres.h"
#include <limits.h>
#include "access/stratnum.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 dependency graph for btree_gin.c:

Go to the source code of this file.

Data Structures
struct	QueryInfo

Macros
#define	GIN_SUPPORT(type, is_varlena, leftmostvalue, typecmp)
#define	NUMERIC_IS_LEFTMOST(x)   ((x) == NULL)
#define	ENUM_IS_LEFTMOST(x)   ((x) == InvalidOid)

Typedefs
typedef struct QueryInfo	QueryInfo

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, bool is_varlena, Datum(*leftmostvalue)(void), Datum(*typecmp)(FunctionCallInfo))
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	leftmostvalue_int4 (void)
static Datum	leftmostvalue_int8 (void)
static Datum	leftmostvalue_float4 (void)
static Datum	leftmostvalue_float8 (void)
static Datum	leftmostvalue_money (void)
static Datum	leftmostvalue_oid (void)
static Datum	leftmostvalue_timestamp (void)
static Datum	leftmostvalue_time (void)
static Datum	leftmostvalue_timetz (void)
static Datum	leftmostvalue_date (void)
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	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	leftmostvalue_bool (void)

Macro Definition Documentation

ENUM_IS_LEFTMOST

#define ENUM_IS_LEFTMOST

(

x

)

((x) == InvalidOid)

Definition at line 443 of file btree_gin.c.

GIN_SUPPORT

#define GIN_SUPPORT	(		type,
			is_varlena,
			leftmostvalue,
			typecmp
	)

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);                     \
}   \
PG_FUNCTION_INFO_V1(gin_extract_query_##type);                              \
Datum                                                                       \
gin_extract_query_##type(PG_FUNCTION_ARGS)                                  \
{                                                                           \
    return gin_btree_extract_query(fcinfo,                                  \
                                   is_varlena, leftmostvalue, typecmp);     \
}   \
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 185 of file btree_gin.c.

NUMERIC_IS_LEFTMOST

#define NUMERIC_IS_LEFTMOST

(

x

)

((x) == NULL)

Definition at line 396 of file btree_gin.c.

Typedef Documentation

QueryInfo

typedef struct QueryInfo QueryInfo

Function Documentation

gin_btree_compare_prefix()

static Datum gin_btree_compare_prefix ( FunctionCallInfo  fcinfo )

static

Definition at line 109 of file btree_gin.c.

{
    Datum       a = PG_GETARG_DATUM(0);
    Datum       b = PG_GETARG_DATUM(1);
    QueryInfo  *data = (QueryInfo *) PG_GETARG_POINTER(3);
    int32       res,
                cmp;
 
    cmp = DatumGetInt32(CallerFInfoFunctionCall2(data->typecmp,
                                                 fcinfo->flinfo,
                                                 PG_GET_COLLATION(),
                                                 (data->strategy == BTLessStrategyNumber ||
                                                  data->strategy == BTLessEqualStrategyNumber)
                                                 ? data->datum : a,
                                                 b));
 
    switch (data->strategy)
    {
        case BTLessStrategyNumber:
            /* If original datum > indexed one then return match */
            if (cmp > 0)
                res = 0;
            else
                res = 1;
            break;
        case BTLessEqualStrategyNumber:
            /* The same except equality */
            if (cmp >= 0)
                res = 0;
            else
                res = 1;
            break;
        case BTEqualStrategyNumber:
            if (cmp != 0)
                res = 1;
            else
                res = 0;
            break;
        case BTGreaterEqualStrategyNumber:
            /* If original datum <= indexed one then return match */
            if (cmp <= 0)
                res = 0;
            else
                res = 1;
            break;
        case BTGreaterStrategyNumber:
            /* If original datum <= indexed one then return match */
            /* If original datum == indexed one then continue scan */
            if (cmp < 0)
                res = 0;
            else if (cmp == 0)
                res = -1;
            else
                res = 1;
            break;
        default:
            elog(ERROR, "unrecognized strategy number: %d",
                 data->strategy);
            res = 0;
    }
 
    PG_RETURN_INT32(res);
}

References a, b, BTEqualStrategyNumber, BTGreaterEqualStrategyNumber, BTGreaterStrategyNumber, BTLessEqualStrategyNumber, BTLessStrategyNumber, CallerFInfoFunctionCall2(), cmp(), data, DatumGetInt32(), elog, ERROR, FunctionCallInfoBaseData::flinfo, PG_GET_COLLATION, PG_GETARG_DATUM, PG_GETARG_POINTER, and PG_RETURN_INT32.

gin_btree_consistent()

Datum gin_btree_consistent

(

PG_FUNCTION_ARGS

)

Definition at line 175 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, bool  is_varlena, Datum(*)(void)  leftmostvalue, Datum(*)(FunctionCallInfo)  typecmp  )

static

Definition at line 56 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;
 
    *nentries = 1;
    ptr_partialmatch = *partialmatch = (bool *) palloc(sizeof(bool));
    *ptr_partialmatch = false;
    if (is_varlena)
        datum = PointerGetDatum(PG_DETOAST_DATUM(datum));
    data->strategy = strategy;
    data->datum = datum;
    data->is_varlena = is_varlena;
    data->typecmp = typecmp;
    *extra_data = (Pointer *) palloc(sizeof(Pointer));
    **extra_data = (Pointer) data;
 
    switch (strategy)
    {
        case BTLessStrategyNumber:
        case BTLessEqualStrategyNumber:
            entries[0] = leftmostvalue();
            *ptr_partialmatch = true;
            break;
        case BTGreaterEqualStrategyNumber:
        case BTGreaterStrategyNumber:
            *ptr_partialmatch = true;
            /* FALLTHROUGH */
        case BTEqualStrategyNumber:
            entries[0] = datum;
            break;
        default:
            elog(ERROR, "unrecognized strategy number: %d", strategy);
    }
 
    PG_RETURN_POINTER(entries);
}

References BTEqualStrategyNumber, 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 33 of file btree_gin.c.

{
    Datum       datum = PG_GETARG_DATUM(0);
    int32      *nentries = (int32 *) PG_GETARG_POINTER(1);
    Datum      *entries = (Datum *) palloc(sizeof(Datum));
 
    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 448 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, FunctionCallInfoBaseData::flinfo, ObjectIdGetDatum(), PG_GET_COLLATION, PG_GETARG_OID, and PG_RETURN_INT32.

gin_numeric_cmp()

Datum gin_numeric_cmp

(

PG_FUNCTION_ARGS

)

Definition at line 401 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 367 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 507 of file btree_gin.c.

{
    return BoolGetDatum(false);
}

References BoolGetDatum().

leftmostvalue_char()

static Datum leftmostvalue_char ( void  )

static

Definition at line 357 of file btree_gin.c.

{
    return CharGetDatum(0);
}

References CharGetDatum().

leftmostvalue_date()

static Datum leftmostvalue_date ( void  )

static

Definition at line 297 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 475 of file btree_gin.c.

{
    return ObjectIdGetDatum(InvalidOid);
}

References InvalidOid, and ObjectIdGetDatum().

leftmostvalue_float4()

static Datum leftmostvalue_float4 ( void  )

static

Definition at line 234 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 242 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 337 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 210 of file btree_gin.c.

{
    return Int16GetDatum(SHRT_MIN);
}

References Int16GetDatum().

leftmostvalue_int4()

static Datum leftmostvalue_int4 ( void  )

static

Definition at line 218 of file btree_gin.c.

{
    return Int32GetDatum(INT_MIN);
}

References Int32GetDatum().

leftmostvalue_int8()

static Datum leftmostvalue_int8 ( void  )

static

Definition at line 226 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 305 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 317 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 327 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 250 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 497 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 426 of file btree_gin.c.

{
    return PointerGetDatum(NULL);
}

References PointerGetDatum().

leftmostvalue_oid()

static Datum leftmostvalue_oid ( void  )

static

Definition at line 258 of file btree_gin.c.

{
    return ObjectIdGetDatum(0);
}

References ObjectIdGetDatum().

leftmostvalue_text()

static Datum leftmostvalue_text ( void  )

static

Definition at line 347 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 276 of file btree_gin.c.

{
    return TimeADTGetDatum(0);
}

References TimeADTGetDatum().

leftmostvalue_timestamp()

static Datum leftmostvalue_timestamp ( void  )

static

Definition at line 266 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 284 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 483 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 378 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
	)