PostgreSQL Source Code  git master
ginlogic.c File Reference
#include "postgres.h"
#include "access/gin_private.h"
#include "access/reloptions.h"
#include "catalog/pg_collation.h"
#include "catalog/pg_type.h"
#include "miscadmin.h"
#include "storage/indexfsm.h"
#include "storage/lmgr.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 50 of file ginlogic.c.

Function Documentation

◆ directBoolConsistentFn()

static bool directBoolConsistentFn ( GinScanKey  key)
static

Definition at line 71 of file ginlogic.c.

72 {
73  /*
74  * Initialize recheckCurItem in case the consistentFn doesn't know it
75  * should set it. The safe assumption in that case is to force recheck.
76  */
77  key->recheckCurItem = true;
78 
79  return DatumGetBool(FunctionCall8Coll(key->consistentFmgrInfo,
80  key->collation,
81  PointerGetDatum(key->entryRes),
82  UInt16GetDatum(key->strategy),
83  key->query,
84  UInt32GetDatum(key->nuserentries),
85  PointerGetDatum(key->extra_data),
86  PointerGetDatum(&key->recheckCurItem),
87  PointerGetDatum(key->queryValues),
88  PointerGetDatum(key->queryCategories)));
89 }
Datum FunctionCall8Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3, Datum arg4, Datum arg5, Datum arg6, Datum arg7, Datum arg8)
Definition: fmgr.c:1303
static bool DatumGetBool(Datum X)
Definition: postgres.h:438
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:670
static Datum UInt16GetDatum(uint16 X)
Definition: postgres.h:540
static Datum UInt32GetDatum(uint32 X)
Definition: postgres.h:580

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 95 of file ginlogic.c.

96 {
97  return DatumGetGinTernaryValue(FunctionCall7Coll(key->triConsistentFmgrInfo,
98  key->collation,
99  PointerGetDatum(key->entryRes),
100  UInt16GetDatum(key->strategy),
101  key->query,
102  UInt32GetDatum(key->nuserentries),
103  PointerGetDatum(key->extra_data),
104  PointerGetDatum(key->queryValues),
105  PointerGetDatum(key->queryCategories)));
106 }
Datum FunctionCall7Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3, Datum arg4, Datum arg5, Datum arg6, Datum arg7)
Definition: fmgr.c:1269
static GinTernaryValue DatumGetGinTernaryValue(Datum X)
Definition: gin.h:65

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

Referenced by ginInitConsistentFunction().

◆ ginInitConsistentFunction()

void ginInitConsistentFunction ( GinState ginstate,
GinScanKey  key 
)

Definition at line 223 of file ginlogic.c.

224 {
225  if (key->searchMode == GIN_SEARCH_MODE_EVERYTHING)
226  {
227  key->boolConsistentFn = trueConsistentFn;
228  key->triConsistentFn = trueTriConsistentFn;
229  }
230  else
231  {
232  key->consistentFmgrInfo = &ginstate->consistentFn[key->attnum - 1];
233  key->triConsistentFmgrInfo = &ginstate->triConsistentFn[key->attnum - 1];
234  key->collation = ginstate->supportCollation[key->attnum - 1];
235 
236  if (OidIsValid(ginstate->consistentFn[key->attnum - 1].fn_oid))
237  key->boolConsistentFn = directBoolConsistentFn;
238  else
239  key->boolConsistentFn = shimBoolConsistentFn;
240 
241  if (OidIsValid(ginstate->triConsistentFn[key->attnum - 1].fn_oid))
242  key->triConsistentFn = directTriConsistentFn;
243  else
244  key->triConsistentFn = shimTriConsistentFn;
245  }
246 }
#define OidIsValid(objectId)
Definition: c.h:711
#define GIN_SEARCH_MODE_EVERYTHING
Definition: gin.h:37
static GinTernaryValue trueTriConsistentFn(GinScanKey key)
Definition: ginlogic.c:62
static GinTernaryValue shimTriConsistentFn(GinScanKey key)
Definition: ginlogic.c:152
static GinTernaryValue directTriConsistentFn(GinScanKey key)
Definition: ginlogic.c:95
static bool trueConsistentFn(GinScanKey key)
Definition: ginlogic.c:56
static bool directBoolConsistentFn(GinScanKey key)
Definition: ginlogic.c:71
static bool shimBoolConsistentFn(GinScanKey key)
Definition: ginlogic.c:114
Oid fn_oid
Definition: fmgr.h:59
FmgrInfo triConsistentFn[INDEX_MAX_KEYS]
Definition: gin_private.h:82
FmgrInfo consistentFn[INDEX_MAX_KEYS]
Definition: gin_private.h:81
Oid supportCollation[INDEX_MAX_KEYS]
Definition: gin_private.h:87

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 114 of file ginlogic.c.

115 {
116  GinTernaryValue result;
117 
118  result = DatumGetGinTernaryValue(FunctionCall7Coll(key->triConsistentFmgrInfo,
119  key->collation,
120  PointerGetDatum(key->entryRes),
121  UInt16GetDatum(key->strategy),
122  key->query,
123  UInt32GetDatum(key->nuserentries),
124  PointerGetDatum(key->extra_data),
125  PointerGetDatum(key->queryValues),
126  PointerGetDatum(key->queryCategories)));
127  if (result == GIN_MAYBE)
128  {
129  key->recheckCurItem = true;
130  return true;
131  }
132  else
133  {
134  key->recheckCurItem = false;
135  return result;
136  }
137 }
char GinTernaryValue
Definition: gin.h:58
#define GIN_MAYBE
Definition: gin.h:62

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 152 of file ginlogic.c.

153 {
154  int nmaybe;
155  int maybeEntries[MAX_MAYBE_ENTRIES];
156  int i;
157  bool boolResult;
158  bool recheck = false;
159  GinTernaryValue curResult;
160 
161  /*
162  * Count how many MAYBE inputs there are, and store their indexes in
163  * maybeEntries. If there are too many MAYBE inputs, it's not feasible to
164  * test all combinations, so give up and return MAYBE.
165  */
166  nmaybe = 0;
167  for (i = 0; i < key->nentries; i++)
168  {
169  if (key->entryRes[i] == GIN_MAYBE)
170  {
171  if (nmaybe >= MAX_MAYBE_ENTRIES)
172  return GIN_MAYBE;
173  maybeEntries[nmaybe++] = i;
174  }
175  }
176 
177  /*
178  * If none of the inputs were MAYBE, so we can just call consistent
179  * function as is.
180  */
181  if (nmaybe == 0)
182  return directBoolConsistentFn(key);
183 
184  /* First call consistent function with all the maybe-inputs set FALSE */
185  for (i = 0; i < nmaybe; i++)
186  key->entryRes[maybeEntries[i]] = GIN_FALSE;
187  curResult = directBoolConsistentFn(key);
188 
189  for (;;)
190  {
191  /* Twiddle the entries for next combination. */
192  for (i = 0; i < nmaybe; i++)
193  {
194  if (key->entryRes[maybeEntries[i]] == GIN_FALSE)
195  {
196  key->entryRes[maybeEntries[i]] = GIN_TRUE;
197  break;
198  }
199  else
200  key->entryRes[maybeEntries[i]] = GIN_FALSE;
201  }
202  if (i == nmaybe)
203  break;
204 
205  boolResult = directBoolConsistentFn(key);
206  recheck |= key->recheckCurItem;
207 
208  if (curResult != boolResult)
209  return GIN_MAYBE;
210  }
211 
212  /* TRUE with recheck is taken to mean MAYBE */
213  if (curResult == GIN_TRUE && recheck)
214  curResult = GIN_MAYBE;
215 
216  return curResult;
217 }
#define GIN_FALSE
Definition: gin.h:60
#define GIN_TRUE
Definition: gin.h:61
#define MAX_MAYBE_ENTRIES
Definition: ginlogic.c:50
int i
Definition: isn.c:73

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 56 of file ginlogic.c.

57 {
58  key->recheckCurItem = false;
59  return true;
60 }

References sort-test::key.

Referenced by ginInitConsistentFunction().

◆ trueTriConsistentFn()

static GinTernaryValue trueTriConsistentFn ( GinScanKey  key)
static

Definition at line 62 of file ginlogic.c.

63 {
64  return GIN_TRUE;
65 }

References GIN_TRUE.

Referenced by ginInitConsistentFunction().