PostgreSQL Source Code  git master
ginutil.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * ginutil.c
4  * Utility routines for the Postgres inverted index access method.
5  *
6  *
7  * Portions Copyright (c) 1996-2020, PostgreSQL Global Development Group
8  * Portions Copyright (c) 1994, Regents of the University of California
9  *
10  * IDENTIFICATION
11  * src/backend/access/gin/ginutil.c
12  *-------------------------------------------------------------------------
13  */
14 
15 #include "postgres.h"
16 
17 #include "access/gin_private.h"
18 #include "access/ginxlog.h"
19 #include "access/reloptions.h"
20 #include "access/xloginsert.h"
21 #include "catalog/pg_collation.h"
22 #include "catalog/pg_type.h"
23 #include "commands/vacuum.h"
24 #include "miscadmin.h"
25 #include "storage/indexfsm.h"
26 #include "storage/lmgr.h"
27 #include "storage/predicate.h"
28 #include "utils/builtins.h"
29 #include "utils/index_selfuncs.h"
30 #include "utils/typcache.h"
31 
32 
33 /*
34  * GIN handler function: return IndexAmRoutine with access method parameters
35  * and callbacks.
36  */
37 Datum
39 {
41 
42  amroutine->amstrategies = 0;
43  amroutine->amsupport = GINNProcs;
44  amroutine->amcanorder = false;
45  amroutine->amcanorderbyop = false;
46  amroutine->amcanbackward = false;
47  amroutine->amcanunique = false;
48  amroutine->amcanmulticol = true;
49  amroutine->amoptionalkey = true;
50  amroutine->amsearcharray = false;
51  amroutine->amsearchnulls = false;
52  amroutine->amstorage = true;
53  amroutine->amclusterable = false;
54  amroutine->ampredlocks = true;
55  amroutine->amcanparallel = false;
56  amroutine->amcaninclude = false;
57  amroutine->amusemaintenanceworkmem = true;
58  amroutine->amparallelvacuumoptions =
60  amroutine->amkeytype = InvalidOid;
61 
62  amroutine->ambuild = ginbuild;
63  amroutine->ambuildempty = ginbuildempty;
64  amroutine->aminsert = gininsert;
65  amroutine->ambulkdelete = ginbulkdelete;
66  amroutine->amvacuumcleanup = ginvacuumcleanup;
67  amroutine->amcanreturn = NULL;
68  amroutine->amcostestimate = gincostestimate;
69  amroutine->amoptions = ginoptions;
70  amroutine->amproperty = NULL;
71  amroutine->ambuildphasename = NULL;
72  amroutine->amvalidate = ginvalidate;
73  amroutine->ambeginscan = ginbeginscan;
74  amroutine->amrescan = ginrescan;
75  amroutine->amgettuple = NULL;
76  amroutine->amgetbitmap = gingetbitmap;
77  amroutine->amendscan = ginendscan;
78  amroutine->ammarkpos = NULL;
79  amroutine->amrestrpos = NULL;
80  amroutine->amestimateparallelscan = NULL;
81  amroutine->aminitparallelscan = NULL;
82  amroutine->amparallelrescan = NULL;
83 
84  PG_RETURN_POINTER(amroutine);
85 }
86 
87 /*
88  * initGinState: fill in an empty GinState struct to describe the index
89  *
90  * Note: assorted subsidiary data is allocated in the CurrentMemoryContext.
91  */
92 void
94 {
95  TupleDesc origTupdesc = RelationGetDescr(index);
96  int i;
97 
98  MemSet(state, 0, sizeof(GinState));
99 
100  state->index = index;
101  state->oneCol = (origTupdesc->natts == 1) ? true : false;
102  state->origTupdesc = origTupdesc;
103 
104  for (i = 0; i < origTupdesc->natts; i++)
105  {
106  Form_pg_attribute attr = TupleDescAttr(origTupdesc, i);
107 
108  if (state->oneCol)
109  state->tupdesc[i] = state->origTupdesc;
110  else
111  {
112  state->tupdesc[i] = CreateTemplateTupleDesc(2);
113 
114  TupleDescInitEntry(state->tupdesc[i], (AttrNumber) 1, NULL,
115  INT2OID, -1, 0);
116  TupleDescInitEntry(state->tupdesc[i], (AttrNumber) 2, NULL,
117  attr->atttypid,
118  attr->atttypmod,
119  attr->attndims);
121  attr->attcollation);
122  }
123 
124  /*
125  * If the compare proc isn't specified in the opclass definition, look
126  * up the index key type's default btree comparator.
127  */
128  if (index_getprocid(index, i + 1, GIN_COMPARE_PROC) != InvalidOid)
129  {
130  fmgr_info_copy(&(state->compareFn[i]),
131  index_getprocinfo(index, i + 1, GIN_COMPARE_PROC),
133  }
134  else
135  {
136  TypeCacheEntry *typentry;
137 
138  typentry = lookup_type_cache(attr->atttypid,
140  if (!OidIsValid(typentry->cmp_proc_finfo.fn_oid))
141  ereport(ERROR,
142  (errcode(ERRCODE_UNDEFINED_FUNCTION),
143  errmsg("could not identify a comparison function for type %s",
144  format_type_be(attr->atttypid))));
145  fmgr_info_copy(&(state->compareFn[i]),
146  &(typentry->cmp_proc_finfo),
148  }
149 
150  /* Opclass must always provide extract procs */
151  fmgr_info_copy(&(state->extractValueFn[i]),
154  fmgr_info_copy(&(state->extractQueryFn[i]),
157 
158  /*
159  * Check opclass capability to do tri-state or binary logic consistent
160  * check.
161  */
162  if (index_getprocid(index, i + 1, GIN_TRICONSISTENT_PROC) != InvalidOid)
163  {
164  fmgr_info_copy(&(state->triConsistentFn[i]),
167  }
168 
169  if (index_getprocid(index, i + 1, GIN_CONSISTENT_PROC) != InvalidOid)
170  {
171  fmgr_info_copy(&(state->consistentFn[i]),
172  index_getprocinfo(index, i + 1, GIN_CONSISTENT_PROC),
174  }
175 
176  if (state->consistentFn[i].fn_oid == InvalidOid &&
177  state->triConsistentFn[i].fn_oid == InvalidOid)
178  {
179  elog(ERROR, "missing GIN support function (%d or %d) for attribute %d of index \"%s\"",
181  i + 1, RelationGetRelationName(index));
182  }
183 
184  /*
185  * Check opclass capability to do partial match.
186  */
188  {
189  fmgr_info_copy(&(state->comparePartialFn[i]),
192  state->canPartialMatch[i] = true;
193  }
194  else
195  {
196  state->canPartialMatch[i] = false;
197  }
198 
199  /*
200  * If the index column has a specified collation, we should honor that
201  * while doing comparisons. However, we may have a collatable storage
202  * type for a noncollatable indexed data type (for instance, hstore
203  * uses text index entries). If there's no index collation then
204  * specify default collation in case the support functions need
205  * collation. This is harmless if the support functions don't care
206  * about collation, so we just do it unconditionally. (We could
207  * alternatively call get_typcollation, but that seems like expensive
208  * overkill --- there aren't going to be any cases where a GIN storage
209  * type has a nondefault collation.)
210  */
211  if (OidIsValid(index->rd_indcollation[i]))
212  state->supportCollation[i] = index->rd_indcollation[i];
213  else
214  state->supportCollation[i] = DEFAULT_COLLATION_OID;
215  }
216 }
217 
218 /*
219  * Extract attribute (column) number of stored entry from GIN tuple
220  */
223 {
224  OffsetNumber colN;
225 
226  if (ginstate->oneCol)
227  {
228  /* column number is not stored explicitly */
229  colN = FirstOffsetNumber;
230  }
231  else
232  {
233  Datum res;
234  bool isnull;
235 
236  /*
237  * First attribute is always int16, so we can safely use any tuple
238  * descriptor to obtain first attribute of tuple
239  */
240  res = index_getattr(tuple, FirstOffsetNumber, ginstate->tupdesc[0],
241  &isnull);
242  Assert(!isnull);
243 
244  colN = DatumGetUInt16(res);
245  Assert(colN >= FirstOffsetNumber && colN <= ginstate->origTupdesc->natts);
246  }
247 
248  return colN;
249 }
250 
251 /*
252  * Extract stored datum (and possible null category) from GIN tuple
253  */
254 Datum
256  GinNullCategory *category)
257 {
258  Datum res;
259  bool isnull;
260 
261  if (ginstate->oneCol)
262  {
263  /*
264  * Single column index doesn't store attribute numbers in tuples
265  */
266  res = index_getattr(tuple, FirstOffsetNumber, ginstate->origTupdesc,
267  &isnull);
268  }
269  else
270  {
271  /*
272  * Since the datum type depends on which index column it's from, we
273  * must be careful to use the right tuple descriptor here.
274  */
275  OffsetNumber colN = gintuple_get_attrnum(ginstate, tuple);
276 
278  ginstate->tupdesc[colN - 1],
279  &isnull);
280  }
281 
282  if (isnull)
283  *category = GinGetNullCategory(tuple, ginstate);
284  else
285  *category = GIN_CAT_NORM_KEY;
286 
287  return res;
288 }
289 
290 /*
291  * Allocate a new page (either by recycling, or by extending the index file)
292  * The returned buffer is already pinned and exclusive-locked
293  * Caller is responsible for initializing the page by calling GinInitBuffer
294  */
295 Buffer
297 {
298  Buffer buffer;
299  bool needLock;
300 
301  /* First, try to get a page from FSM */
302  for (;;)
303  {
304  BlockNumber blkno = GetFreeIndexPage(index);
305 
306  if (blkno == InvalidBlockNumber)
307  break;
308 
309  buffer = ReadBuffer(index, blkno);
310 
311  /*
312  * We have to guard against the possibility that someone else already
313  * recycled this page; the buffer may be locked if so.
314  */
315  if (ConditionalLockBuffer(buffer))
316  {
317  if (GinPageIsRecyclable(BufferGetPage(buffer)))
318  return buffer; /* OK to use */
319 
320  LockBuffer(buffer, GIN_UNLOCK);
321  }
322 
323  /* Can't use it, so release buffer and try again */
324  ReleaseBuffer(buffer);
325  }
326 
327  /* Must extend the file */
328  needLock = !RELATION_IS_LOCAL(index);
329  if (needLock)
331 
332  buffer = ReadBuffer(index, P_NEW);
333  LockBuffer(buffer, GIN_EXCLUSIVE);
334 
335  if (needLock)
337 
338  return buffer;
339 }
340 
341 void
342 GinInitPage(Page page, uint32 f, Size pageSize)
343 {
344  GinPageOpaque opaque;
345 
346  PageInit(page, pageSize, sizeof(GinPageOpaqueData));
347 
348  opaque = GinPageGetOpaque(page);
349  memset(opaque, 0, sizeof(GinPageOpaqueData));
350  opaque->flags = f;
351  opaque->rightlink = InvalidBlockNumber;
352 }
353 
354 void
356 {
358 }
359 
360 void
362 {
363  GinMetaPageData *metadata;
364  Page page = BufferGetPage(b);
365 
367 
368  metadata = GinPageGetMeta(page);
369 
370  metadata->head = metadata->tail = InvalidBlockNumber;
371  metadata->tailFreeSize = 0;
372  metadata->nPendingPages = 0;
373  metadata->nPendingHeapTuples = 0;
374  metadata->nTotalPages = 0;
375  metadata->nEntryPages = 0;
376  metadata->nDataPages = 0;
377  metadata->nEntries = 0;
378  metadata->ginVersion = GIN_CURRENT_VERSION;
379 
380  /*
381  * Set pd_lower just past the end of the metadata. This is essential,
382  * because without doing so, metadata will be lost if xlog.c compresses
383  * the page.
384  */
385  ((PageHeader) page)->pd_lower =
386  ((char *) metadata + sizeof(GinMetaPageData)) - (char *) page;
387 }
388 
389 /*
390  * Compare two keys of the same index column
391  */
392 int
394  Datum a, GinNullCategory categorya,
395  Datum b, GinNullCategory categoryb)
396 {
397  /* if not of same null category, sort by that first */
398  if (categorya != categoryb)
399  return (categorya < categoryb) ? -1 : 1;
400 
401  /* all null items in same category are equal */
402  if (categorya != GIN_CAT_NORM_KEY)
403  return 0;
404 
405  /* both not null, so safe to call the compareFn */
406  return DatumGetInt32(FunctionCall2Coll(&ginstate->compareFn[attnum - 1],
407  ginstate->supportCollation[attnum - 1],
408  a, b));
409 }
410 
411 /*
412  * Compare two keys of possibly different index columns
413  */
414 int
416  OffsetNumber attnuma, Datum a, GinNullCategory categorya,
417  OffsetNumber attnumb, Datum b, GinNullCategory categoryb)
418 {
419  /* attribute number is the first sort key */
420  if (attnuma != attnumb)
421  return (attnuma < attnumb) ? -1 : 1;
422 
423  return ginCompareEntries(ginstate, attnuma, a, categorya, b, categoryb);
424 }
425 
426 
427 /*
428  * Support for sorting key datums in ginExtractEntries
429  *
430  * Note: we only have to worry about null and not-null keys here;
431  * ginExtractEntries never generates more than one placeholder null,
432  * so it doesn't have to sort those.
433  */
434 typedef struct
435 {
437  bool isnull;
438 } keyEntryData;
439 
440 typedef struct
441 {
444  bool haveDups;
445 } cmpEntriesArg;
446 
447 static int
448 cmpEntries(const void *a, const void *b, void *arg)
449 {
450  const keyEntryData *aa = (const keyEntryData *) a;
451  const keyEntryData *bb = (const keyEntryData *) b;
452  cmpEntriesArg *data = (cmpEntriesArg *) arg;
453  int res;
454 
455  if (aa->isnull)
456  {
457  if (bb->isnull)
458  res = 0; /* NULL "=" NULL */
459  else
460  res = 1; /* NULL ">" not-NULL */
461  }
462  else if (bb->isnull)
463  res = -1; /* not-NULL "<" NULL */
464  else
466  data->collation,
467  aa->datum, bb->datum));
468 
469  /*
470  * Detect if we have any duplicates. If there are equal keys, qsort must
471  * compare them at some point, else it wouldn't know whether one should go
472  * before or after the other.
473  */
474  if (res == 0)
475  data->haveDups = true;
476 
477  return res;
478 }
479 
480 
481 /*
482  * Extract the index key values from an indexable item
483  *
484  * The resulting key values are sorted, and any duplicates are removed.
485  * This avoids generating redundant index entries.
486  */
487 Datum *
489  Datum value, bool isNull,
490  int32 *nentries, GinNullCategory **categories)
491 {
492  Datum *entries;
493  bool *nullFlags;
494  int32 i;
495 
496  /*
497  * We don't call the extractValueFn on a null item. Instead generate a
498  * placeholder.
499  */
500  if (isNull)
501  {
502  *nentries = 1;
503  entries = (Datum *) palloc(sizeof(Datum));
504  entries[0] = (Datum) 0;
505  *categories = (GinNullCategory *) palloc(sizeof(GinNullCategory));
506  (*categories)[0] = GIN_CAT_NULL_ITEM;
507  return entries;
508  }
509 
510  /* OK, call the opclass's extractValueFn */
511  nullFlags = NULL; /* in case extractValue doesn't set it */
512  entries = (Datum *)
513  DatumGetPointer(FunctionCall3Coll(&ginstate->extractValueFn[attnum - 1],
514  ginstate->supportCollation[attnum - 1],
515  value,
516  PointerGetDatum(nentries),
517  PointerGetDatum(&nullFlags)));
518 
519  /*
520  * Generate a placeholder if the item contained no keys.
521  */
522  if (entries == NULL || *nentries <= 0)
523  {
524  *nentries = 1;
525  entries = (Datum *) palloc(sizeof(Datum));
526  entries[0] = (Datum) 0;
527  *categories = (GinNullCategory *) palloc(sizeof(GinNullCategory));
528  (*categories)[0] = GIN_CAT_EMPTY_ITEM;
529  return entries;
530  }
531 
532  /*
533  * If the extractValueFn didn't create a nullFlags array, create one,
534  * assuming that everything's non-null.
535  */
536  if (nullFlags == NULL)
537  nullFlags = (bool *) palloc0(*nentries * sizeof(bool));
538 
539  /*
540  * If there's more than one key, sort and unique-ify.
541  *
542  * XXX Using qsort here is notationally painful, and the overhead is
543  * pretty bad too. For small numbers of keys it'd likely be better to use
544  * a simple insertion sort.
545  */
546  if (*nentries > 1)
547  {
548  keyEntryData *keydata;
550 
551  keydata = (keyEntryData *) palloc(*nentries * sizeof(keyEntryData));
552  for (i = 0; i < *nentries; i++)
553  {
554  keydata[i].datum = entries[i];
555  keydata[i].isnull = nullFlags[i];
556  }
557 
558  arg.cmpDatumFunc = &ginstate->compareFn[attnum - 1];
559  arg.collation = ginstate->supportCollation[attnum - 1];
560  arg.haveDups = false;
561  qsort_arg(keydata, *nentries, sizeof(keyEntryData),
562  cmpEntries, (void *) &arg);
563 
564  if (arg.haveDups)
565  {
566  /* there are duplicates, must get rid of 'em */
567  int32 j;
568 
569  entries[0] = keydata[0].datum;
570  nullFlags[0] = keydata[0].isnull;
571  j = 1;
572  for (i = 1; i < *nentries; i++)
573  {
574  if (cmpEntries(&keydata[i - 1], &keydata[i], &arg) != 0)
575  {
576  entries[j] = keydata[i].datum;
577  nullFlags[j] = keydata[i].isnull;
578  j++;
579  }
580  }
581  *nentries = j;
582  }
583  else
584  {
585  /* easy, no duplicates */
586  for (i = 0; i < *nentries; i++)
587  {
588  entries[i] = keydata[i].datum;
589  nullFlags[i] = keydata[i].isnull;
590  }
591  }
592 
593  pfree(keydata);
594  }
595 
596  /*
597  * Create GinNullCategory representation from nullFlags.
598  */
599  *categories = (GinNullCategory *) palloc0(*nentries * sizeof(GinNullCategory));
600  for (i = 0; i < *nentries; i++)
601  (*categories)[i] = (nullFlags[i] ? GIN_CAT_NULL_KEY : GIN_CAT_NORM_KEY);
602 
603  return entries;
604 }
605 
606 bytea *
607 ginoptions(Datum reloptions, bool validate)
608 {
609  static const relopt_parse_elt tab[] = {
610  {"fastupdate", RELOPT_TYPE_BOOL, offsetof(GinOptions, useFastUpdate)},
611  {"gin_pending_list_limit", RELOPT_TYPE_INT, offsetof(GinOptions,
612  pendingListCleanupSize)}
613  };
614 
615  return (bytea *) build_reloptions(reloptions, validate,
617  sizeof(GinOptions),
618  tab, lengthof(tab));
619 }
620 
621 /*
622  * Fetch index's statistical data into *stats
623  *
624  * Note: in the result, nPendingPages can be trusted to be up-to-date,
625  * as can ginVersion; but the other fields are as of the last VACUUM.
626  */
627 void
629 {
630  Buffer metabuffer;
631  Page metapage;
632  GinMetaPageData *metadata;
633 
634  metabuffer = ReadBuffer(index, GIN_METAPAGE_BLKNO);
635  LockBuffer(metabuffer, GIN_SHARE);
636  metapage = BufferGetPage(metabuffer);
637  metadata = GinPageGetMeta(metapage);
638 
639  stats->nPendingPages = metadata->nPendingPages;
640  stats->nTotalPages = metadata->nTotalPages;
641  stats->nEntryPages = metadata->nEntryPages;
642  stats->nDataPages = metadata->nDataPages;
643  stats->nEntries = metadata->nEntries;
644  stats->ginVersion = metadata->ginVersion;
645 
646  UnlockReleaseBuffer(metabuffer);
647 }
648 
649 /*
650  * Write the given statistics to the index's metapage
651  *
652  * Note: nPendingPages and ginVersion are *not* copied over
653  */
654 void
655 ginUpdateStats(Relation index, const GinStatsData *stats, bool is_build)
656 {
657  Buffer metabuffer;
658  Page metapage;
659  GinMetaPageData *metadata;
660 
661  metabuffer = ReadBuffer(index, GIN_METAPAGE_BLKNO);
662  LockBuffer(metabuffer, GIN_EXCLUSIVE);
663  metapage = BufferGetPage(metabuffer);
664  metadata = GinPageGetMeta(metapage);
665 
667 
668  metadata->nTotalPages = stats->nTotalPages;
669  metadata->nEntryPages = stats->nEntryPages;
670  metadata->nDataPages = stats->nDataPages;
671  metadata->nEntries = stats->nEntries;
672 
673  /*
674  * Set pd_lower just past the end of the metadata. This is essential,
675  * because without doing so, metadata will be lost if xlog.c compresses
676  * the page. (We must do this here because pre-v11 versions of PG did not
677  * set the metapage's pd_lower correctly, so a pg_upgraded index might
678  * contain the wrong value.)
679  */
680  ((PageHeader) metapage)->pd_lower =
681  ((char *) metadata + sizeof(GinMetaPageData)) - (char *) metapage;
682 
683  MarkBufferDirty(metabuffer);
684 
685  if (RelationNeedsWAL(index) && !is_build)
686  {
687  XLogRecPtr recptr;
688  ginxlogUpdateMeta data;
689 
690  data.node = index->rd_node;
691  data.ntuples = 0;
693  memcpy(&data.metadata, metadata, sizeof(GinMetaPageData));
694 
695  XLogBeginInsert();
696  XLogRegisterData((char *) &data, sizeof(ginxlogUpdateMeta));
698 
699  recptr = XLogInsert(RM_GIN_ID, XLOG_GIN_UPDATE_META_PAGE);
700  PageSetLSN(metapage, recptr);
701  }
702 
703  UnlockReleaseBuffer(metabuffer);
704 
706 }
BlockNumber nEntryPages
Definition: ginblock.h:80
BlockNumber prevTail
Definition: ginxlog.h:172
ambeginscan_function ambeginscan
Definition: amapi.h:225
#define GIN_UNLOCK
Definition: gin_private.h:48
uint8 amparallelvacuumoptions
Definition: amapi.h:203
#define PG_RETURN_POINTER(x)
Definition: fmgr.h:351
BlockNumber nEntryPages
Definition: gin.h:45
Buffer GinNewBuffer(Relation index)
Definition: ginutil.c:296
IndexBulkDeleteResult * ginvacuumcleanup(IndexVacuumInfo *info, IndexBulkDeleteResult *stats)
Definition: ginvacuum.c:684
IndexScanDesc ginbeginscan(Relation rel, int nkeys, int norderbys)
Definition: ginscan.c:25
int64 gingetbitmap(IndexScanDesc scan, TIDBitmap *tbm)
Definition: ginget.c:1893
void ginendscan(IndexScanDesc scan)
Definition: ginscan.c:458
Definition: fmgr.h:56
Oid supportCollation[INDEX_MAX_KEYS]
Definition: gin_private.h:87
ambulkdelete_function ambulkdelete
Definition: amapi.h:217
void ginrescan(IndexScanDesc scan, ScanKey scankey, int nscankeys, ScanKey orderbys, int norderbys)
Definition: ginscan.c:442
bool amcanmulticol
Definition: amapi.h:183
void GinInitMetabuffer(Buffer b)
Definition: ginutil.c:361
uint16 amsupport
Definition: amapi.h:173
RelFileNode node
Definition: ginxlog.h:170
FmgrInfo * cmpDatumFunc
Definition: ginutil.c:442
#define GinPageIsRecyclable(page)
Definition: ginblock.h:137
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:794
#define GIN_EXTRACTQUERY_PROC
Definition: gin.h:24
amgettuple_function amgettuple
Definition: amapi.h:227
TupleDesc CreateTemplateTupleDesc(int natts)
Definition: tupdesc.c:44
Relation index
Definition: gin_private.h:58
void gincostestimate(PlannerInfo *root, IndexPath *path, double loop_count, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, double *indexCorrelation, double *indexPages)
Definition: selfuncs.c:6648
#define DatumGetInt32(X)
Definition: postgres.h:472
#define RelationGetDescr(relation)
Definition: rel.h:454
void GinInitPage(Page page, uint32 f, Size pageSize)
Definition: ginutil.c:342
bool amcanorderbyop
Definition: amapi.h:177
#define DatumGetUInt16(X)
Definition: postgres.h:458
amproperty_function amproperty
Definition: amapi.h:222
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1458
#define ExclusiveLock
Definition: lockdefs.h:44
bool isnull
Definition: ginutil.c:437
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:213
#define PointerGetDatum(X)
Definition: postgres.h:556
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
#define GinGetNullCategory(itup, ginstate)
Definition: ginblock.h:221
#define RELATION_IS_LOCAL(relation)
Definition: rel.h:548
BlockNumber rightlink
Definition: ginblock.h:31
amparallelrescan_function amparallelrescan
Definition: amapi.h:236
#define END_CRIT_SECTION()
Definition: miscadmin.h:134
bool amstorage
Definition: amapi.h:191
static struct @145 value
#define REGBUF_WILL_INIT
Definition: xloginsert.h:33
bool canPartialMatch[INDEX_MAX_KEYS]
Definition: gin_private.h:85
#define START_CRIT_SECTION()
Definition: miscadmin.h:132
int ginCompareEntries(GinState *ginstate, OffsetNumber attnum, Datum a, GinNullCategory categorya, Datum b, GinNullCategory categoryb)
Definition: ginutil.c:393
int ginCompareAttEntries(GinState *ginstate, OffsetNumber attnuma, Datum a, GinNullCategory categorya, OffsetNumber attnumb, Datum b, GinNullCategory categoryb)
Definition: ginutil.c:415
int errcode(int sqlerrcode)
Definition: elog.c:608
int64 nEntries
Definition: gin.h:47
#define MemSet(start, val, len)
Definition: c.h:962
FmgrInfo consistentFn[INDEX_MAX_KEYS]
Definition: gin_private.h:81
char * format_type_be(Oid type_oid)
Definition: format_type.c:326
bool ampredlocks
Definition: amapi.h:195
FmgrInfo extractValueFn[INDEX_MAX_KEYS]
Definition: gin_private.h:79
#define GIN_TRICONSISTENT_PROC
Definition: gin.h:27
BlockNumber nTotalPages
Definition: ginblock.h:79
uint32 BlockNumber
Definition: block.h:31
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3375
#define GinPageGetOpaque(page)
Definition: ginblock.h:110
#define GIN_METAPAGE_BLKNO
Definition: ginblock.h:51
Datum ginhandler(PG_FUNCTION_ARGS)
Definition: ginutil.c:38
#define P_NEW
Definition: bufmgr.h:81
void ginbuildempty(Relation index)
Definition: gininsert.c:435
aminsert_function aminsert
Definition: amapi.h:216
#define GIN_COMPARE_PARTIAL_PROC
Definition: gin.h:26
#define lengthof(array)
Definition: c.h:669
int64 nEntries
Definition: ginblock.h:82
Datum FunctionCall2Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2)
Definition: fmgr.c:1150
unsigned int Oid
Definition: postgres_ext.h:31
Oid amkeytype
Definition: amapi.h:205
#define OidIsValid(objectId)
Definition: c.h:645
bool amoptionalkey
Definition: amapi.h:185
amvalidate_function amvalidate
Definition: amapi.h:224
Datum datum
Definition: ginutil.c:436
signed int int32
Definition: c.h:347
void * build_reloptions(Datum reloptions, bool validate, relopt_kind kind, Size relopt_struct_size, const relopt_parse_elt *relopt_elems, int num_relopt_elems)
Definition: reloptions.c:1552
uint16 OffsetNumber
Definition: off.h:24
Definition: type.h:89
int64 nPendingHeapTuples
Definition: ginblock.h:74
FmgrInfo cmp_proc_finfo
Definition: typcache.h:73
void pfree(void *pointer)
Definition: mcxt.c:1056
amgetbitmap_function amgetbitmap
Definition: amapi.h:228
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3398
Oid * rd_indcollation
Definition: rel.h:174
#define ERROR
Definition: elog.h:43
IndexBuildResult * ginbuild(Relation heap, Relation index, IndexInfo *indexInfo)
Definition: gininsert.c:318
ambuild_function ambuild
Definition: amapi.h:214
#define GIN_META
Definition: ginblock.h:43
signed char GinNullCategory
Definition: ginblock.h:207
bool haveDups
Definition: ginutil.c:444
amoptions_function amoptions
Definition: amapi.h:221
bool ginvalidate(Oid opclassoid)
Definition: ginvalidate.c:33
#define XLOG_GIN_UPDATE_META_PAGE
Definition: ginxlog.h:162
void TupleDescInitEntryCollation(TupleDesc desc, AttrNumber attributeNumber, Oid collationid)
Definition: tupdesc.c:769
bool amcaninclude
Definition: amapi.h:199
BlockNumber head
Definition: ginblock.h:61
void fmgr_info_copy(FmgrInfo *dstinfo, FmgrInfo *srcinfo, MemoryContext destcxt)
Definition: fmgr.c:610
amcostestimate_function amcostestimate
Definition: amapi.h:220
bool gininsert(Relation index, Datum *values, bool *isnull, ItemPointer ht_ctid, Relation heapRel, IndexUniqueCheck checkUnique, IndexInfo *indexInfo)
Definition: gininsert.c:486
OffsetNumber gintuple_get_attrnum(GinState *ginstate, IndexTuple tuple)
Definition: ginutil.c:222
bool amcanunique
Definition: amapi.h:181
#define GIN_CAT_NORM_KEY
Definition: ginblock.h:209
amvacuumcleanup_function amvacuumcleanup
Definition: amapi.h:218
amendscan_function amendscan
Definition: amapi.h:229
FmgrInfo comparePartialFn[INDEX_MAX_KEYS]
Definition: gin_private.h:83
bool amcanbackward
Definition: amapi.h:179
BlockNumber tail
Definition: ginblock.h:62
#define FirstOffsetNumber
Definition: off.h:27
#define GIN_CONSISTENT_PROC
Definition: gin.h:25
#define REGBUF_STANDARD
Definition: xloginsert.h:35
void initGinState(GinState *state, Relation index)
Definition: ginutil.c:93
#define RelationGetRelationName(relation)
Definition: rel.h:462
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:200
unsigned int uint32
Definition: c.h:359
FmgrInfo extractQueryFn[INDEX_MAX_KEYS]
Definition: gin_private.h:80
#define GINNProcs
Definition: gin.h:28
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
Datum gintuple_get_key(GinState *ginstate, IndexTuple tuple, GinNullCategory *category)
Definition: ginutil.c:255
void TupleDescInitEntry(TupleDesc desc, AttrNumber attributeNumber, const char *attributeName, Oid oidtypeid, int32 typmod, int attdim)
Definition: tupdesc.c:603
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define ereport(elevel, rest)
Definition: elog.h:141
amrescan_function amrescan
Definition: amapi.h:226
bool amcanparallel
Definition: amapi.h:197
bool ConditionalLockBuffer(Buffer buffer)
Definition: bufmgr.c:3638
BlockNumber newRightlink
Definition: ginxlog.h:173
bytea * ginoptions(Datum reloptions, bool validate)
Definition: ginutil.c:607
#define GIN_SHARE
Definition: gin_private.h:49
void qsort_arg(void *base, size_t nel, size_t elsize, qsort_arg_comparator cmp, void *arg)
Definition: qsort_arg.c:113
void LockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:402
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:323
BlockNumber nPendingPages
Definition: gin.h:43
bool amsearchnulls
Definition: amapi.h:189
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:415
#define GIN_CAT_NULL_KEY
Definition: ginblock.h:210
void * palloc0(Size size)
Definition: mcxt.c:980
void UnlockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:452
uintptr_t Datum
Definition: postgres.h:367
void ginGetStats(Relation index, GinStatsData *stats)
Definition: ginutil.c:628
TupleDesc tupdesc[INDEX_MAX_KEYS]
Definition: gin_private.h:73
#define BufferGetPageSize(buffer)
Definition: bufmgr.h:146
#define GIN_EXCLUSIVE
Definition: gin_private.h:50
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3612
#define GIN_CAT_NULL_ITEM
Definition: ginblock.h:212
bool amclusterable
Definition: amapi.h:193
bool amsearcharray
Definition: amapi.h:187
TypeCacheEntry * lookup_type_cache(Oid type_id, int flags)
Definition: typcache.c:322
#define InvalidOid
Definition: postgres_ext.h:36
BlockNumber nDataPages
Definition: gin.h:46
int16 attnum
Definition: pg_attribute.h:79
Oid fn_oid
Definition: fmgr.h:59
Datum FunctionCall3Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3)
Definition: fmgr.c:1172
bool amusemaintenanceworkmem
Definition: amapi.h:201
BlockNumber GetFreeIndexPage(Relation rel)
Definition: indexfsm.c:38
GinMetaPageData metadata
Definition: ginxlog.h:171
RelFileNode rd_node
Definition: rel.h:55
#define makeNode(_type_)
Definition: nodes.h:573
PageHeaderData * PageHeader
Definition: bufpage.h:166
uint32 tailFreeSize
Definition: ginblock.h:67
#define GIN_EXTRACTVALUE_PROC
Definition: gin.h:23
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:739
Definition: regguts.h:298
IndexBulkDeleteResult * ginbulkdelete(IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
Definition: ginvacuum.c:561
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define OffsetNumberNext(offsetNumber)
Definition: off.h:52
size_t Size
Definition: c.h:467
#define GIN_CURRENT_VERSION
Definition: ginblock.h:102
#define InvalidBlockNumber
Definition: block.h:33
void GinInitBuffer(Buffer b, uint32 f)
Definition: ginutil.c:355
BlockNumber nTotalPages
Definition: gin.h:44
#define index_getattr(tup, attnum, tupleDesc, isnull)
Definition: itup.h:100
ammarkpos_function ammarkpos
Definition: amapi.h:230
bool amcanorder
Definition: amapi.h:175
ambuildphasename_function ambuildphasename
Definition: amapi.h:223
Oid collation
Definition: ginutil.c:443
#define VACUUM_OPTION_PARALLEL_BULKDEL
Definition: vacuum.h:45
#define RelationNeedsWAL(relation)
Definition: rel.h:530
int32 ginVersion
Definition: ginblock.h:99
amestimateparallelscan_function amestimateparallelscan
Definition: amapi.h:234
int32 ginVersion
Definition: gin.h:48
#define DatumGetPointer(X)
Definition: postgres.h:549
uint16 amstrategies
Definition: amapi.h:171
void ginUpdateStats(Relation index, const GinStatsData *stats, bool is_build)
Definition: ginutil.c:655
void * palloc(Size size)
Definition: mcxt.c:949
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define elog(elevel,...)
Definition: elog.h:228
ambuildempty_function ambuildempty
Definition: amapi.h:215
int i
void * arg
BlockNumber nDataPages
Definition: ginblock.h:81
Definition: c.h:556
TupleDesc origTupdesc
Definition: gin_private.h:72
#define PG_FUNCTION_ARGS
Definition: fmgr.h:188
#define TYPECACHE_CMP_PROC_FINFO
Definition: typcache.h:134
#define GinPageGetMeta(p)
Definition: ginblock.h:104
FmgrInfo triConsistentFn[INDEX_MAX_KEYS]
Definition: gin_private.h:82
#define GIN_CAT_EMPTY_ITEM
Definition: ginblock.h:211
void XLogBeginInsert(void)
Definition: xloginsert.c:120
#define VACUUM_OPTION_PARALLEL_CLEANUP
Definition: vacuum.h:60
bool oneCol
Definition: gin_private.h:59
#define PageSetLSN(page, lsn)
Definition: bufpage.h:368
int Buffer
Definition: buf.h:23
amcanreturn_function amcanreturn
Definition: amapi.h:219
int16 AttrNumber
Definition: attnum.h:21
Datum * ginExtractEntries(GinState *ginstate, OffsetNumber attnum, Datum value, bool isNull, int32 *nentries, GinNullCategory **categories)
Definition: ginutil.c:488
static int cmpEntries(const void *a, const void *b, void *arg)
Definition: ginutil.c:448
#define offsetof(type, field)
Definition: c.h:662
Pointer Page
Definition: bufpage.h:78
aminitparallelscan_function aminitparallelscan
Definition: amapi.h:235
#define GIN_COMPARE_PROC
Definition: gin.h:22
FmgrInfo compareFn[INDEX_MAX_KEYS]
Definition: gin_private.h:78
amrestrpos_function amrestrpos
Definition: amapi.h:231
BlockNumber nPendingPages
Definition: ginblock.h:73
void PageInit(Page page, Size pageSize, Size specialSize)
Definition: bufpage.c:42
RegProcedure index_getprocid(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:760