ginlogic.c File Reference

#include "postgres.h"
#include "access/gin_private.h"

Include dependency graph for ginlogic.c:

Go to the source code of this file.

Macros
#define	MAX_MAYBE_ENTRIES   4

Functions
static bool	trueConsistentFn (GinScanKey key)
static GinTernaryValue	trueTriConsistentFn (GinScanKey key)
static bool	directBoolConsistentFn (GinScanKey key)
static GinTernaryValue	directTriConsistentFn (GinScanKey key)
static bool	shimBoolConsistentFn (GinScanKey key)
static GinTernaryValue	shimTriConsistentFn (GinScanKey key)
void	ginInitConsistentFunction (GinState *ginstate, GinScanKey key)

Macro Definition Documentation

MAX_MAYBE_ENTRIES

#define MAX_MAYBE_ENTRIES   4

Definition at line 44 of file ginlogic.c.

Function Documentation

directBoolConsistentFn()

static bool directBoolConsistentFn ( GinScanKey  key )

static

Definition at line 65 of file ginlogic.c.

{
    /*
     * Initialize recheckCurItem in case the consistentFn doesn't know it
     * should set it.  The safe assumption in that case is to force recheck.
     */
    key->recheckCurItem = true;
 
    return DatumGetBool(FunctionCall8Coll(key->consistentFmgrInfo,
                                          key->collation,
                                          PointerGetDatum(key->entryRes),
                                          UInt16GetDatum(key->strategy),
                                          key->query,
                                          UInt32GetDatum(key->nuserentries),
                                          PointerGetDatum(key->extra_data),
                                          PointerGetDatum(&key->recheckCurItem),
                                          PointerGetDatum(key->queryValues),
                                          PointerGetDatum(key->queryCategories)));
}

References DatumGetBool(), FunctionCall8Coll(), sort-test::key, PointerGetDatum(), UInt16GetDatum(), and UInt32GetDatum().

Referenced by ginInitConsistentFunction(), and shimTriConsistentFn().

directTriConsistentFn()

static GinTernaryValue directTriConsistentFn ( GinScanKey  key )

static

Definition at line 89 of file ginlogic.c.

{
    return DatumGetGinTernaryValue(FunctionCall7Coll(key->triConsistentFmgrInfo,
                                                     key->collation,
                                                     PointerGetDatum(key->entryRes),
                                                     UInt16GetDatum(key->strategy),
                                                     key->query,
                                                     UInt32GetDatum(key->nuserentries),
                                                     PointerGetDatum(key->extra_data),
                                                     PointerGetDatum(key->queryValues),
                                                     PointerGetDatum(key->queryCategories)));
}

References DatumGetGinTernaryValue(), FunctionCall7Coll(), sort-test::key, PointerGetDatum(), UInt16GetDatum(), and UInt32GetDatum().

Referenced by ginInitConsistentFunction().

ginInitConsistentFunction()

void ginInitConsistentFunction	(	GinState *	ginstate,
		GinScanKey	key
	)

Definition at line 227 of file ginlogic.c.

{
    if (key->searchMode == GIN_SEARCH_MODE_EVERYTHING)
    {
        key->boolConsistentFn = trueConsistentFn;
        key->triConsistentFn = trueTriConsistentFn;
    }
    else
    {
        key->consistentFmgrInfo = &ginstate->consistentFn[key->attnum - 1];
        key->triConsistentFmgrInfo = &ginstate->triConsistentFn[key->attnum - 1];
        key->collation = ginstate->supportCollation[key->attnum - 1];
 
        if (OidIsValid(ginstate->consistentFn[key->attnum - 1].fn_oid))
            key->boolConsistentFn = directBoolConsistentFn;
        else
            key->boolConsistentFn = shimBoolConsistentFn;
 
        if (OidIsValid(ginstate->triConsistentFn[key->attnum - 1].fn_oid))
            key->triConsistentFn = directTriConsistentFn;
        else
            key->triConsistentFn = shimTriConsistentFn;
    }
}

References GinState::consistentFn, directBoolConsistentFn(), directTriConsistentFn(), FmgrInfo::fn_oid, GIN_SEARCH_MODE_EVERYTHING, sort-test::key, OidIsValid, shimBoolConsistentFn(), shimTriConsistentFn(), GinState::supportCollation, GinState::triConsistentFn, trueConsistentFn(), and trueTriConsistentFn().

Referenced by ginFillScanKey().

shimBoolConsistentFn()

static bool shimBoolConsistentFn ( GinScanKey  key )

static

Definition at line 108 of file ginlogic.c.

{
    GinTernaryValue result;
 
    result = DatumGetGinTernaryValue(FunctionCall7Coll(key->triConsistentFmgrInfo,
                                                       key->collation,
                                                       PointerGetDatum(key->entryRes),
                                                       UInt16GetDatum(key->strategy),
                                                       key->query,
                                                       UInt32GetDatum(key->nuserentries),
                                                       PointerGetDatum(key->extra_data),
                                                       PointerGetDatum(key->queryValues),
                                                       PointerGetDatum(key->queryCategories)));
    if (result == GIN_MAYBE)
    {
        key->recheckCurItem = true;
        return true;
    }
    else
    {
        key->recheckCurItem = false;
        return result;
    }
}

References DatumGetGinTernaryValue(), FunctionCall7Coll(), GIN_MAYBE, sort-test::key, PointerGetDatum(), UInt16GetDatum(), and UInt32GetDatum().

Referenced by ginInitConsistentFunction().

shimTriConsistentFn()

static GinTernaryValue shimTriConsistentFn ( GinScanKey  key )

static

Definition at line 148 of file ginlogic.c.

{
    int         nmaybe;
    int         maybeEntries[MAX_MAYBE_ENTRIES];
    int         i;
    bool        boolResult;
    bool        recheck;
    GinTernaryValue curResult;
 
    /*
     * Count how many MAYBE inputs there are, and store their indexes in
     * maybeEntries. If there are too many MAYBE inputs, it's not feasible to
     * test all combinations, so give up and return MAYBE.
     */
    nmaybe = 0;
    for (i = 0; i < key->nentries; i++)
    {
        if (key->entryRes[i] == GIN_MAYBE)
        {
            if (nmaybe >= MAX_MAYBE_ENTRIES)
                return GIN_MAYBE;
            maybeEntries[nmaybe++] = i;
        }
    }
 
    /*
     * If none of the inputs were MAYBE, we can just call the consistent
     * function as-is.
     */
    if (nmaybe == 0)
        return directBoolConsistentFn(key);
 
    /* First call consistent function with all the maybe-inputs set FALSE */
    for (i = 0; i < nmaybe; i++)
        key->entryRes[maybeEntries[i]] = GIN_FALSE;
    curResult = directBoolConsistentFn(key);
    recheck = key->recheckCurItem;
 
    for (;;)
    {
        /* Twiddle the entries for next combination. */
        for (i = 0; i < nmaybe; i++)
        {
            if (key->entryRes[maybeEntries[i]] == GIN_FALSE)
            {
                key->entryRes[maybeEntries[i]] = GIN_TRUE;
                break;
            }
            else
                key->entryRes[maybeEntries[i]] = GIN_FALSE;
        }
        if (i == nmaybe)
            break;
 
        boolResult = directBoolConsistentFn(key);
        recheck |= key->recheckCurItem;
 
        if (curResult != boolResult)
        {
            curResult = GIN_MAYBE;
            break;
        }
    }
 
    /* TRUE with recheck is taken to mean MAYBE */
    if (curResult == GIN_TRUE && recheck)
        curResult = GIN_MAYBE;
 
    /* We must restore the original state of the entryRes array */
    for (i = 0; i < nmaybe; i++)
        key->entryRes[maybeEntries[i]] = GIN_MAYBE;
 
    return curResult;
}

References directBoolConsistentFn(), GIN_FALSE, GIN_MAYBE, GIN_TRUE, i, sort-test::key, and MAX_MAYBE_ENTRIES.

Referenced by ginInitConsistentFunction().

trueConsistentFn()

static bool trueConsistentFn ( GinScanKey  key )

static

Definition at line 50 of file ginlogic.c.

{
    key->recheckCurItem = false;
    return true;
}

References sort-test::key.

Referenced by ginInitConsistentFunction().

trueTriConsistentFn()

static GinTernaryValue trueTriConsistentFn ( GinScanKey  key )

static

Definition at line 56 of file ginlogic.c.

{
    return GIN_TRUE;
}

References GIN_TRUE.

Referenced by ginInitConsistentFunction().