PostgreSQL Source Code  git master
brin_internal.h File Reference
#include "access/amapi.h"
#include "storage/bufpage.h"
#include "utils/typcache.h"
Include dependency graph for brin_internal.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  BrinOpcInfo
 
struct  BrinDesc
 

Macros

#define SizeofBrinOpcInfo(ncols)    (offsetof(BrinOpcInfo, oi_typcache) + sizeof(TypeCacheEntry *) * ncols)
 
#define BRIN_PROCNUM_OPCINFO   1
 
#define BRIN_PROCNUM_ADDVALUE   2
 
#define BRIN_PROCNUM_CONSISTENT   3
 
#define BRIN_PROCNUM_UNION   4
 
#define BRIN_MANDATORY_NPROCS   4
 
#define BRIN_PROCNUM_OPTIONS   5 /* optional */
 
#define BRIN_FIRST_OPTIONAL_PROCNUM   11
 
#define BRIN_LAST_OPTIONAL_PROCNUM   15
 
#define BRIN_elog(args)   ((void) 0)
 

Typedefs

typedef struct BrinOpcInfo BrinOpcInfo
 
typedef struct BrinDesc BrinDesc
 

Functions

BrinDescbrin_build_desc (Relation rel)
 
void brin_free_desc (BrinDesc *bdesc)
 
IndexBuildResultbrinbuild (Relation heap, Relation index, struct IndexInfo *indexInfo)
 
void brinbuildempty (Relation index)
 
bool brininsert (Relation idxRel, Datum *values, bool *nulls, ItemPointer heaptid, Relation heapRel, IndexUniqueCheck checkUnique, bool indexUnchanged, struct IndexInfo *indexInfo)
 
IndexScanDesc brinbeginscan (Relation r, int nkeys, int norderbys)
 
int64 bringetbitmap (IndexScanDesc scan, TIDBitmap *tbm)
 
void brinrescan (IndexScanDesc scan, ScanKey scankey, int nscankeys, ScanKey orderbys, int norderbys)
 
void brinendscan (IndexScanDesc scan)
 
IndexBulkDeleteResultbrinbulkdelete (IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
 
IndexBulkDeleteResultbrinvacuumcleanup (IndexVacuumInfo *info, IndexBulkDeleteResult *stats)
 
byteabrinoptions (Datum reloptions, bool validate)
 
bool brinvalidate (Oid opclassoid)
 

Macro Definition Documentation

◆ BRIN_elog

#define BRIN_elog (   args)    ((void) 0)

Definition at line 85 of file brin_internal.h.

◆ BRIN_FIRST_OPTIONAL_PROCNUM

#define BRIN_FIRST_OPTIONAL_PROCNUM   11

Definition at line 77 of file brin_internal.h.

◆ BRIN_LAST_OPTIONAL_PROCNUM

#define BRIN_LAST_OPTIONAL_PROCNUM   15

Definition at line 78 of file brin_internal.h.

◆ BRIN_MANDATORY_NPROCS

#define BRIN_MANDATORY_NPROCS   4

Definition at line 74 of file brin_internal.h.

◆ BRIN_PROCNUM_ADDVALUE

#define BRIN_PROCNUM_ADDVALUE   2

Definition at line 71 of file brin_internal.h.

◆ BRIN_PROCNUM_CONSISTENT

#define BRIN_PROCNUM_CONSISTENT   3

Definition at line 72 of file brin_internal.h.

◆ BRIN_PROCNUM_OPCINFO

#define BRIN_PROCNUM_OPCINFO   1

Definition at line 70 of file brin_internal.h.

◆ BRIN_PROCNUM_OPTIONS

#define BRIN_PROCNUM_OPTIONS   5 /* optional */

Definition at line 75 of file brin_internal.h.

◆ BRIN_PROCNUM_UNION

#define BRIN_PROCNUM_UNION   4

Definition at line 73 of file brin_internal.h.

◆ SizeofBrinOpcInfo

#define SizeofBrinOpcInfo (   ncols)     (offsetof(BrinOpcInfo, oi_typcache) + sizeof(TypeCacheEntry *) * ncols)

Definition at line 41 of file brin_internal.h.

Typedef Documentation

◆ BrinDesc

typedef struct BrinDesc BrinDesc

◆ BrinOpcInfo

typedef struct BrinOpcInfo BrinOpcInfo

Function Documentation

◆ brin_build_desc()

BrinDesc* brin_build_desc ( Relation  rel)

Definition at line 1161 of file brin.c.

1162 {
1163  BrinOpcInfo **opcinfo;
1164  BrinDesc *bdesc;
1165  TupleDesc tupdesc;
1166  int totalstored = 0;
1167  int keyno;
1168  long totalsize;
1169  MemoryContext cxt;
1170  MemoryContext oldcxt;
1171 
1173  "brin desc cxt",
1175  oldcxt = MemoryContextSwitchTo(cxt);
1176  tupdesc = RelationGetDescr(rel);
1177 
1178  /*
1179  * Obtain BrinOpcInfo for each indexed column. While at it, accumulate
1180  * the number of columns stored, since the number is opclass-defined.
1181  */
1182  opcinfo = (BrinOpcInfo **) palloc(sizeof(BrinOpcInfo *) * tupdesc->natts);
1183  for (keyno = 0; keyno < tupdesc->natts; keyno++)
1184  {
1185  FmgrInfo *opcInfoFn;
1186  Form_pg_attribute attr = TupleDescAttr(tupdesc, keyno);
1187 
1188  opcInfoFn = index_getprocinfo(rel, keyno + 1, BRIN_PROCNUM_OPCINFO);
1189 
1190  opcinfo[keyno] = (BrinOpcInfo *)
1191  DatumGetPointer(FunctionCall1(opcInfoFn, attr->atttypid));
1192  totalstored += opcinfo[keyno]->oi_nstored;
1193  }
1194 
1195  /* Allocate our result struct and fill it in */
1196  totalsize = offsetof(BrinDesc, bd_info) +
1197  sizeof(BrinOpcInfo *) * tupdesc->natts;
1198 
1199  bdesc = palloc(totalsize);
1200  bdesc->bd_context = cxt;
1201  bdesc->bd_index = rel;
1202  bdesc->bd_tupdesc = tupdesc;
1203  bdesc->bd_disktdesc = NULL; /* generated lazily */
1204  bdesc->bd_totalstored = totalstored;
1205 
1206  for (keyno = 0; keyno < tupdesc->natts; keyno++)
1207  bdesc->bd_info[keyno] = opcinfo[keyno];
1208  pfree(opcinfo);
1209 
1210  MemoryContextSwitchTo(oldcxt);
1211 
1212  return bdesc;
1213 }
#define BRIN_PROCNUM_OPCINFO
Definition: brin_internal.h:70
#define offsetof(type, field)
Definition: c.h:727
#define FunctionCall1(flinfo, arg1)
Definition: fmgr.h:649
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:803
void pfree(void *pointer)
Definition: mcxt.c:1169
MemoryContext CurrentMemoryContext
Definition: mcxt.c:42
void * palloc(Size size)
Definition: mcxt.c:1062
#define AllocSetContextCreate
Definition: memutils.h:173
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:205
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:207
#define DatumGetPointer(X)
Definition: postgres.h:593
#define RelationGetDescr(relation)
Definition: rel.h:504
int bd_totalstored
Definition: brin_internal.h:59
TupleDesc bd_tupdesc
Definition: brin_internal.h:53
BrinOpcInfo * bd_info[FLEXIBLE_ARRAY_MEMBER]
Definition: brin_internal.h:62
Relation bd_index
Definition: brin_internal.h:50
MemoryContext bd_context
Definition: brin_internal.h:47
TupleDesc bd_disktdesc
Definition: brin_internal.h:56
uint16 oi_nstored
Definition: brin_internal.h:28
Definition: fmgr.h:57
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92

References ALLOCSET_SMALL_SIZES, AllocSetContextCreate, BrinDesc::bd_context, BrinDesc::bd_disktdesc, BrinDesc::bd_index, BrinDesc::bd_info, BrinDesc::bd_totalstored, BrinDesc::bd_tupdesc, BRIN_PROCNUM_OPCINFO, CurrentMemoryContext, DatumGetPointer, FunctionCall1, index_getprocinfo(), MemoryContextSwitchTo(), TupleDescData::natts, offsetof, BrinOpcInfo::oi_nstored, palloc(), pfree(), RelationGetDescr, and TupleDescAttr.

Referenced by brin_page_items(), brinbeginscan(), brininsert(), and initialize_brin_buildstate().

◆ brin_free_desc()

void brin_free_desc ( BrinDesc bdesc)

Definition at line 1216 of file brin.c.

1217 {
1218  /* make sure the tupdesc is still valid */
1219  Assert(bdesc->bd_tupdesc->tdrefcount >= 1);
1220  /* no need for retail pfree */
1222 }
Assert(fmt[strlen(fmt) - 1] !='\n')
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:218
int tdrefcount
Definition: tupdesc.h:84

References Assert(), BrinDesc::bd_context, BrinDesc::bd_tupdesc, MemoryContextDelete(), and TupleDescData::tdrefcount.

Referenced by brin_page_items(), brinendscan(), and terminate_brin_buildstate().

◆ brinbeginscan()

IndexScanDesc brinbeginscan ( Relation  r,
int  nkeys,
int  norderbys 
)

Definition at line 326 of file brin.c.

327 {
328  IndexScanDesc scan;
329  BrinOpaque *opaque;
330 
331  scan = RelationGetIndexScan(r, nkeys, norderbys);
332 
333  opaque = (BrinOpaque *) palloc(sizeof(BrinOpaque));
334  opaque->bo_rmAccess = brinRevmapInitialize(r, &opaque->bo_pagesPerRange,
335  scan->xs_snapshot);
336  opaque->bo_bdesc = brin_build_desc(r);
337  scan->opaque = opaque;
338 
339  return scan;
340 }
BrinDesc * brin_build_desc(Relation rel)
Definition: brin.c:1161
BrinRevmap * brinRevmapInitialize(Relation idxrel, BlockNumber *pagesPerRange, Snapshot snapshot)
Definition: brin_revmap.c:71
IndexScanDesc RelationGetIndexScan(Relation indexRelation, int nkeys, int norderbys)
Definition: genam.c:81
BlockNumber bo_pagesPerRange
Definition: brin.c:65
BrinDesc * bo_bdesc
Definition: brin.c:67
BrinRevmap * bo_rmAccess
Definition: brin.c:66
struct SnapshotData * xs_snapshot
Definition: relscan.h:119

References BrinOpaque::bo_bdesc, BrinOpaque::bo_pagesPerRange, BrinOpaque::bo_rmAccess, brin_build_desc(), brinRevmapInitialize(), IndexScanDescData::opaque, palloc(), RelationGetIndexScan(), and IndexScanDescData::xs_snapshot.

Referenced by brinhandler().

◆ brinbuild()

IndexBuildResult* brinbuild ( Relation  heap,
Relation  index,
struct IndexInfo indexInfo 
)

Definition at line 811 of file brin.c.

812 {
813  IndexBuildResult *result;
814  double reltuples;
815  double idxtuples;
816  BrinRevmap *revmap;
818  Buffer meta;
819  BlockNumber pagesPerRange;
820 
821  /*
822  * We expect to be called exactly once for any index relation.
823  */
825  elog(ERROR, "index \"%s\" already contains data",
827 
828  /*
829  * Critical section not required, because on error the creation of the
830  * whole relation will be rolled back.
831  */
832 
833  meta = ReadBuffer(index, P_NEW);
836 
839  MarkBufferDirty(meta);
840 
841  if (RelationNeedsWAL(index))
842  {
843  xl_brin_createidx xlrec;
844  XLogRecPtr recptr;
845  Page page;
846 
849 
850  XLogBeginInsert();
851  XLogRegisterData((char *) &xlrec, SizeOfBrinCreateIdx);
853 
854  recptr = XLogInsert(RM_BRIN_ID, XLOG_BRIN_CREATE_INDEX);
855 
856  page = BufferGetPage(meta);
857  PageSetLSN(page, recptr);
858  }
859 
860  UnlockReleaseBuffer(meta);
861 
862  /*
863  * Initialize our state, including the deformed tuple state.
864  */
865  revmap = brinRevmapInitialize(index, &pagesPerRange, NULL);
866  state = initialize_brin_buildstate(index, revmap, pagesPerRange);
867 
868  /*
869  * Now scan the relation. No syncscan allowed here because we want the
870  * heap blocks in physical order.
871  */
872  reltuples = table_index_build_scan(heap, index, indexInfo, false, true,
873  brinbuildCallback, (void *) state, NULL);
874 
875  /* process the final batch */
877 
878  /* release resources */
879  idxtuples = state->bs_numtuples;
880  brinRevmapTerminate(state->bs_rmAccess);
882 
883  /*
884  * Return statistics
885  */
886  result = (IndexBuildResult *) palloc(sizeof(IndexBuildResult));
887 
888  result->heap_tuples = reltuples;
889  result->index_tuples = idxtuples;
890 
891  return result;
892 }
uint32 BlockNumber
Definition: block.h:31
static BrinBuildState * initialize_brin_buildstate(Relation idxRel, BrinRevmap *revmap, BlockNumber pagesPerRange)
Definition: brin.c:1249
static void terminate_brin_buildstate(BrinBuildState *state)
Definition: brin.c:1274
static void form_and_insert_tuple(BrinBuildState *state)
Definition: brin.c:1543
static void brinbuildCallback(Relation index, ItemPointer tid, Datum *values, bool *isnull, bool tupleIsAlive, void *brstate)
Definition: brin.c:766
#define BrinGetPagesPerRange(relation)
Definition: brin.h:39
#define BRIN_CURRENT_VERSION
Definition: brin_page.h:72
#define BRIN_METAPAGE_BLKNO
Definition: brin_page.h:75
void brin_metapage_init(Page page, BlockNumber pagesPerRange, uint16 version)
Definition: brin_pageops.c:487
void brinRevmapTerminate(BrinRevmap *revmap)
Definition: brin_revmap.c:103
#define SizeOfBrinCreateIdx
Definition: brin_xlog.h:55
#define XLOG_BRIN_CREATE_INDEX
Definition: brin_xlog.h:31
int Buffer
Definition: buf.h:23
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2748
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3791
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1565
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:4007
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:694
#define P_NEW
Definition: bufmgr.h:91
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:212
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:98
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
Pointer Page
Definition: bufpage.h:78
#define PageSetLSN(page, lsn)
Definition: bufpage.h:367
#define ERROR
Definition: elog.h:33
#define elog(elevel,...)
Definition: elog.h:218
#define RelationGetRelationName(relation)
Definition: rel.h:512
#define RelationNeedsWAL(relation)
Definition: rel.h:602
double heap_tuples
Definition: genam.h:32
double index_tuples
Definition: genam.h:33
Definition: type.h:90
Definition: regguts.h:318
BlockNumber pagesPerRange
Definition: brin_xlog.h:52
static double table_index_build_scan(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, bool allow_sync, bool progress, IndexBuildCallback callback, void *callback_state, TableScanDesc scan)
Definition: tableam.h:1747
uint64 XLogRecPtr
Definition: xlogdefs.h:21
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:429
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:229
void XLogBeginInsert(void)
Definition: xloginsert.c:136
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:337
#define REGBUF_STANDARD
Definition: xloginsert.h:34
#define REGBUF_WILL_INIT
Definition: xloginsert.h:33

References Assert(), BRIN_CURRENT_VERSION, BRIN_METAPAGE_BLKNO, brin_metapage_init(), brinbuildCallback(), BrinGetPagesPerRange, brinRevmapInitialize(), brinRevmapTerminate(), BUFFER_LOCK_EXCLUSIVE, BufferGetBlockNumber(), BufferGetPage, elog, ERROR, form_and_insert_tuple(), IndexBuildResult::heap_tuples, IndexBuildResult::index_tuples, initialize_brin_buildstate(), LockBuffer(), MarkBufferDirty(), P_NEW, PageSetLSN, xl_brin_createidx::pagesPerRange, palloc(), ReadBuffer(), REGBUF_STANDARD, REGBUF_WILL_INIT, RelationGetNumberOfBlocks, RelationGetRelationName, RelationNeedsWAL, SizeOfBrinCreateIdx, table_index_build_scan(), terminate_brin_buildstate(), UnlockReleaseBuffer(), xl_brin_createidx::version, XLOG_BRIN_CREATE_INDEX, XLogBeginInsert(), XLogInsert(), XLogRegisterBuffer(), and XLogRegisterData().

Referenced by brinhandler().

◆ brinbuildempty()

void brinbuildempty ( Relation  index)

Definition at line 895 of file brin.c.

896 {
897  Buffer metabuf;
898 
899  /* An empty BRIN index has a metapage only. */
900  metabuf =
903 
904  /* Initialize and xlog metabuffer. */
908  MarkBufferDirty(metabuf);
909  log_newpage_buffer(metabuf, true);
911 
912  UnlockReleaseBuffer(metabuf);
913 }
Buffer ReadBufferExtended(Relation reln, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy)
Definition: bufmgr.c:741
@ RBM_NORMAL
Definition: bufmgr.h:39
#define START_CRIT_SECTION()
Definition: miscadmin.h:147
#define END_CRIT_SECTION()
Definition: miscadmin.h:149
@ INIT_FORKNUM
Definition: relpath.h:46
XLogRecPtr log_newpage_buffer(Buffer buffer, bool page_std)
Definition: xloginsert.c:1144

References BRIN_CURRENT_VERSION, brin_metapage_init(), BrinGetPagesPerRange, BUFFER_LOCK_EXCLUSIVE, BufferGetPage, END_CRIT_SECTION, INIT_FORKNUM, LockBuffer(), log_newpage_buffer(), MarkBufferDirty(), P_NEW, RBM_NORMAL, ReadBufferExtended(), START_CRIT_SECTION, and UnlockReleaseBuffer().

Referenced by brinhandler().

◆ brinbulkdelete()

IndexBulkDeleteResult* brinbulkdelete ( IndexVacuumInfo info,
IndexBulkDeleteResult stats,
IndexBulkDeleteCallback  callback,
void *  callback_state 
)

Definition at line 925 of file brin.c.

927 {
928  /* allocate stats if first time through, else re-use existing struct */
929  if (stats == NULL)
931 
932  return stats;
933 }
void * palloc0(Size size)
Definition: mcxt.c:1093

References palloc0().

Referenced by brinhandler().

◆ brinendscan()

void brinendscan ( IndexScanDesc  scan)

Definition at line 749 of file brin.c.

750 {
751  BrinOpaque *opaque = (BrinOpaque *) scan->opaque;
752 
754  brin_free_desc(opaque->bo_bdesc);
755  pfree(opaque);
756 }
void brin_free_desc(BrinDesc *bdesc)
Definition: brin.c:1216

References BrinOpaque::bo_bdesc, BrinOpaque::bo_rmAccess, brin_free_desc(), brinRevmapTerminate(), IndexScanDescData::opaque, and pfree().

Referenced by brinhandler().

◆ bringetbitmap()

int64 bringetbitmap ( IndexScanDesc  scan,
TIDBitmap tbm 
)

Definition at line 355 of file brin.c.

356 {
357  Relation idxRel = scan->indexRelation;
359  BrinDesc *bdesc;
360  Oid heapOid;
361  Relation heapRel;
362  BrinOpaque *opaque;
363  BlockNumber nblocks;
364  BlockNumber heapBlk;
365  int totalpages = 0;
366  FmgrInfo *consistentFn;
367  MemoryContext oldcxt;
368  MemoryContext perRangeCxt;
369  BrinMemTuple *dtup;
370  BrinTuple *btup = NULL;
371  Size btupsz = 0;
372  ScanKey **keys,
373  **nullkeys;
374  int *nkeys,
375  *nnullkeys;
376  int keyno;
377  char *ptr;
378  Size len;
379  char *tmp PG_USED_FOR_ASSERTS_ONLY;
380 
381  opaque = (BrinOpaque *) scan->opaque;
382  bdesc = opaque->bo_bdesc;
383  pgstat_count_index_scan(idxRel);
384 
385  /*
386  * We need to know the size of the table so that we know how long to
387  * iterate on the revmap.
388  */
389  heapOid = IndexGetRelation(RelationGetRelid(idxRel), false);
390  heapRel = table_open(heapOid, AccessShareLock);
391  nblocks = RelationGetNumberOfBlocks(heapRel);
392  table_close(heapRel, AccessShareLock);
393 
394  /*
395  * Make room for the consistent support procedures of indexed columns. We
396  * don't look them up here; we do that lazily the first time we see a scan
397  * key reference each of them. We rely on zeroing fn_oid to InvalidOid.
398  */
399  consistentFn = palloc0(sizeof(FmgrInfo) * bdesc->bd_tupdesc->natts);
400 
401  /*
402  * Make room for per-attribute lists of scan keys that we'll pass to the
403  * consistent support procedure. We don't know which attributes have scan
404  * keys, so we allocate space for all attributes. That may use more memory
405  * but it's probably cheaper than determining which attributes are used.
406  *
407  * We keep null and regular keys separate, so that we can pass just the
408  * regular keys to the consistent function easily.
409  *
410  * To reduce the allocation overhead, we allocate one big chunk and then
411  * carve it into smaller arrays ourselves. All the pieces have exactly the
412  * same lifetime, so that's OK.
413  *
414  * XXX The widest index can have 32 attributes, so the amount of wasted
415  * memory is negligible. We could invent a more compact approach (with
416  * just space for used attributes) but that would make the matching more
417  * complex so it's not a good trade-off.
418  */
419  len =
420  MAXALIGN(sizeof(ScanKey *) * bdesc->bd_tupdesc->natts) + /* regular keys */
421  MAXALIGN(sizeof(ScanKey) * scan->numberOfKeys) * bdesc->bd_tupdesc->natts +
422  MAXALIGN(sizeof(int) * bdesc->bd_tupdesc->natts) +
423  MAXALIGN(sizeof(ScanKey *) * bdesc->bd_tupdesc->natts) + /* NULL keys */
424  MAXALIGN(sizeof(ScanKey) * scan->numberOfKeys) * bdesc->bd_tupdesc->natts +
425  MAXALIGN(sizeof(int) * bdesc->bd_tupdesc->natts);
426 
427  ptr = palloc(len);
428  tmp = ptr;
429 
430  keys = (ScanKey **) ptr;
431  ptr += MAXALIGN(sizeof(ScanKey *) * bdesc->bd_tupdesc->natts);
432 
433  nullkeys = (ScanKey **) ptr;
434  ptr += MAXALIGN(sizeof(ScanKey *) * bdesc->bd_tupdesc->natts);
435 
436  nkeys = (int *) ptr;
437  ptr += MAXALIGN(sizeof(int) * bdesc->bd_tupdesc->natts);
438 
439  nnullkeys = (int *) ptr;
440  ptr += MAXALIGN(sizeof(int) * bdesc->bd_tupdesc->natts);
441 
442  for (int i = 0; i < bdesc->bd_tupdesc->natts; i++)
443  {
444  keys[i] = (ScanKey *) ptr;
445  ptr += MAXALIGN(sizeof(ScanKey) * scan->numberOfKeys);
446 
447  nullkeys[i] = (ScanKey *) ptr;
448  ptr += MAXALIGN(sizeof(ScanKey) * scan->numberOfKeys);
449  }
450 
451  Assert(tmp + len == ptr);
452 
453  /* zero the number of keys */
454  memset(nkeys, 0, sizeof(int) * bdesc->bd_tupdesc->natts);
455  memset(nnullkeys, 0, sizeof(int) * bdesc->bd_tupdesc->natts);
456 
457  /* Preprocess the scan keys - split them into per-attribute arrays. */
458  for (keyno = 0; keyno < scan->numberOfKeys; keyno++)
459  {
460  ScanKey key = &scan->keyData[keyno];
461  AttrNumber keyattno = key->sk_attno;
462 
463  /*
464  * The collation of the scan key must match the collation used in the
465  * index column (but only if the search is not IS NULL/ IS NOT NULL).
466  * Otherwise we shouldn't be using this index ...
467  */
468  Assert((key->sk_flags & SK_ISNULL) ||
469  (key->sk_collation ==
470  TupleDescAttr(bdesc->bd_tupdesc,
471  keyattno - 1)->attcollation));
472 
473  /*
474  * First time we see this index attribute, so init as needed.
475  *
476  * This is a bit of an overkill - we don't know how many scan keys are
477  * there for this attribute, so we simply allocate the largest number
478  * possible (as if all keys were for this attribute). This may waste a
479  * bit of memory, but we only expect small number of scan keys in
480  * general, so this should be negligible, and repeated repalloc calls
481  * are not free either.
482  */
483  if (consistentFn[keyattno - 1].fn_oid == InvalidOid)
484  {
485  FmgrInfo *tmp;
486 
487  /* First time we see this attribute, so no key/null keys. */
488  Assert(nkeys[keyattno - 1] == 0);
489  Assert(nnullkeys[keyattno - 1] == 0);
490 
491  tmp = index_getprocinfo(idxRel, keyattno,
493  fmgr_info_copy(&consistentFn[keyattno - 1], tmp,
495  }
496 
497  /* Add key to the proper per-attribute array. */
498  if (key->sk_flags & SK_ISNULL)
499  {
500  nullkeys[keyattno - 1][nnullkeys[keyattno - 1]] = key;
501  nnullkeys[keyattno - 1]++;
502  }
503  else
504  {
505  keys[keyattno - 1][nkeys[keyattno - 1]] = key;
506  nkeys[keyattno - 1]++;
507  }
508  }
509 
510  /* allocate an initial in-memory tuple, out of the per-range memcxt */
511  dtup = brin_new_memtuple(bdesc);
512 
513  /*
514  * Setup and use a per-range memory context, which is reset every time we
515  * loop below. This avoids having to free the tuples within the loop.
516  */
518  "bringetbitmap cxt",
520  oldcxt = MemoryContextSwitchTo(perRangeCxt);
521 
522  /*
523  * Now scan the revmap. We start by querying for heap page 0,
524  * incrementing by the number of pages per range; this gives us a full
525  * view of the table.
526  */
527  for (heapBlk = 0; heapBlk < nblocks; heapBlk += opaque->bo_pagesPerRange)
528  {
529  bool addrange;
530  bool gottuple = false;
531  BrinTuple *tup;
532  OffsetNumber off;
533  Size size;
534 
536 
538 
539  tup = brinGetTupleForHeapBlock(opaque->bo_rmAccess, heapBlk, &buf,
540  &off, &size, BUFFER_LOCK_SHARE,
541  scan->xs_snapshot);
542  if (tup)
543  {
544  gottuple = true;
545  btup = brin_copy_tuple(tup, size, btup, &btupsz);
547  }
548 
549  /*
550  * For page ranges with no indexed tuple, we must return the whole
551  * range; otherwise, compare it to the scan keys.
552  */
553  if (!gottuple)
554  {
555  addrange = true;
556  }
557  else
558  {
559  dtup = brin_deform_tuple(bdesc, btup, dtup);
560  if (dtup->bt_placeholder)
561  {
562  /*
563  * Placeholder tuples are always returned, regardless of the
564  * values stored in them.
565  */
566  addrange = true;
567  }
568  else
569  {
570  int attno;
571 
572  /*
573  * Compare scan keys with summary values stored for the range.
574  * If scan keys are matched, the page range must be added to
575  * the bitmap. We initially assume the range needs to be
576  * added; in particular this serves the case where there are
577  * no keys.
578  */
579  addrange = true;
580  for (attno = 1; attno <= bdesc->bd_tupdesc->natts; attno++)
581  {
582  BrinValues *bval;
583  Datum add;
584  Oid collation;
585 
586  /*
587  * skip attributes without any scan keys (both regular and
588  * IS [NOT] NULL)
589  */
590  if (nkeys[attno - 1] == 0 && nnullkeys[attno - 1] == 0)
591  continue;
592 
593  bval = &dtup->bt_columns[attno - 1];
594 
595  /*
596  * First check if there are any IS [NOT] NULL scan keys,
597  * and if we're violating them. In that case we can
598  * terminate early, without invoking the support function.
599  *
600  * As there may be more keys, we can only determine
601  * mismatch within this loop.
602  */
603  if (bdesc->bd_info[attno - 1]->oi_regular_nulls &&
604  !check_null_keys(bval, nullkeys[attno - 1],
605  nnullkeys[attno - 1]))
606  {
607  /*
608  * If any of the IS [NOT] NULL keys failed, the page
609  * range as a whole can't pass. So terminate the loop.
610  */
611  addrange = false;
612  break;
613  }
614 
615  /*
616  * So either there are no IS [NOT] NULL keys, or all
617  * passed. If there are no regular scan keys, we're done -
618  * the page range matches. If there are regular keys, but
619  * the page range is marked as 'all nulls' it can't
620  * possibly pass (we're assuming the operators are
621  * strict).
622  */
623 
624  /* No regular scan keys - page range as a whole passes. */
625  if (!nkeys[attno - 1])
626  continue;
627 
628  Assert((nkeys[attno - 1] > 0) &&
629  (nkeys[attno - 1] <= scan->numberOfKeys));
630 
631  /* If it is all nulls, it cannot possibly be consistent. */
632  if (bval->bv_allnulls)
633  {
634  addrange = false;
635  break;
636  }
637 
638  /*
639  * Collation from the first key (has to be the same for
640  * all keys for the same attribute).
641  */
642  collation = keys[attno - 1][0]->sk_collation;
643 
644  /*
645  * Check whether the scan key is consistent with the page
646  * range values; if so, have the pages in the range added
647  * to the output bitmap.
648  *
649  * The opclass may or may not support processing of
650  * multiple scan keys. We can determine that based on the
651  * number of arguments - functions with extra parameter
652  * (number of scan keys) do support this, otherwise we
653  * have to simply pass the scan keys one by one.
654  */
655  if (consistentFn[attno - 1].fn_nargs >= 4)
656  {
657  /* Check all keys at once */
658  add = FunctionCall4Coll(&consistentFn[attno - 1],
659  collation,
660  PointerGetDatum(bdesc),
661  PointerGetDatum(bval),
662  PointerGetDatum(keys[attno - 1]),
663  Int32GetDatum(nkeys[attno - 1]));
664  addrange = DatumGetBool(add);
665  }
666  else
667  {
668  /*
669  * Check keys one by one
670  *
671  * When there are multiple scan keys, failure to meet
672  * the criteria for a single one of them is enough to
673  * discard the range as a whole, so break out of the
674  * loop as soon as a false return value is obtained.
675  */
676  int keyno;
677 
678  for (keyno = 0; keyno < nkeys[attno - 1]; keyno++)
679  {
680  add = FunctionCall3Coll(&consistentFn[attno - 1],
681  keys[attno - 1][keyno]->sk_collation,
682  PointerGetDatum(bdesc),
683  PointerGetDatum(bval),
684  PointerGetDatum(keys[attno - 1][keyno]));
685  addrange = DatumGetBool(add);
686  if (!addrange)
687  break;
688  }
689  }
690  }
691  }
692  }
693 
694  /* add the pages in the range to the output bitmap, if needed */
695  if (addrange)
696  {
697  BlockNumber pageno;
698 
699  for (pageno = heapBlk;
700  pageno <= Min(nblocks, heapBlk + opaque->bo_pagesPerRange) - 1;
701  pageno++)
702  {
703  MemoryContextSwitchTo(oldcxt);
704  tbm_add_page(tbm, pageno);
705  totalpages++;
706  MemoryContextSwitchTo(perRangeCxt);
707  }
708  }
709  }
710 
711  MemoryContextSwitchTo(oldcxt);
712  MemoryContextDelete(perRangeCxt);
713 
714  if (buf != InvalidBuffer)
716 
717  /*
718  * XXX We have an approximation of the number of *pages* that our scan
719  * returns, but we don't have a precise idea of the number of heap tuples
720  * involved.
721  */
722  return totalpages * 10;
723 }
int16 AttrNumber
Definition: attnum.h:21
static bool check_null_keys(BrinValues *bval, ScanKey *nullkeys, int nnullkeys)
Definition: brin.c:1723
#define BRIN_PROCNUM_CONSISTENT
Definition: brin_internal.h:72
BrinTuple * brinGetTupleForHeapBlock(BrinRevmap *revmap, BlockNumber heapBlk, Buffer *buf, OffsetNumber *off, Size *size, int mode, Snapshot snapshot)
Definition: brin_revmap.c:197
BrinMemTuple * brin_new_memtuple(BrinDesc *brdesc)
Definition: brin_tuple.c:479
BrinMemTuple * brin_deform_tuple(BrinDesc *brdesc, BrinTuple *tuple, BrinMemTuple *dMemtuple)
Definition: brin_tuple.c:546
BrinTuple * brin_copy_tuple(BrinTuple *tuple, Size len, BrinTuple *dest, Size *destsz)
Definition: brin_tuple.c:443
#define InvalidBuffer
Definition: buf.h:25
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3768
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:96
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:97
#define Min(x, y)
Definition: c.h:986
#define MAXALIGN(LEN)
Definition: c.h:757
#define PG_USED_FOR_ASSERTS_ONLY
Definition: c.h:155
size_t Size
Definition: c.h:540
Datum FunctionCall4Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3, Datum arg4)
Definition: fmgr.c:1195
Datum FunctionCall3Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3)
Definition: fmgr.c:1170
void fmgr_info_copy(FmgrInfo *dstinfo, FmgrInfo *srcinfo, MemoryContext destcxt)
Definition: fmgr.c:608
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3485
int i
Definition: isn.c:73
#define AccessShareLock
Definition: lockdefs.h:36
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:195
#define MemoryContextResetAndDeleteChildren(ctx)
Definition: memutils.h:67
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:120
uint16 OffsetNumber
Definition: off.h:24
const void size_t len
static char * buf
Definition: pg_test_fsync.c:70
#define pgstat_count_index_scan(rel)
Definition: pgstat.h:1164
uintptr_t Datum
Definition: postgres.h:411
#define DatumGetBool(X)
Definition: postgres.h:437
#define Int32GetDatum(X)
Definition: postgres.h:523
#define PointerGetDatum(X)
Definition: postgres.h:600
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
static void addrange(struct cvec *cv, chr from, chr to)
Definition: regc_cvec.c:90
#define RelationGetRelid(relation)
Definition: rel.h:478
#define SK_ISNULL
Definition: skey.h:115
BrinValues bt_columns[FLEXIBLE_ARRAY_MEMBER]
Definition: brin_tuple.h:54
bool bt_placeholder
Definition: brin_tuple.h:46
bool oi_regular_nulls
Definition: brin_internal.h:31
bool bv_allnulls
Definition: brin_tuple.h:33
struct ScanKeyData * keyData
Definition: relscan.h:122
Relation indexRelation
Definition: relscan.h:118
Oid sk_collation
Definition: skey.h:70
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
void tbm_add_page(TIDBitmap *tbm, BlockNumber pageno)
Definition: tidbitmap.c:442

References AccessShareLock, addrange(), ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert(), BrinDesc::bd_info, BrinDesc::bd_tupdesc, BrinOpaque::bo_bdesc, BrinOpaque::bo_pagesPerRange, BrinOpaque::bo_rmAccess, brin_copy_tuple(), brin_deform_tuple(), brin_new_memtuple(), BRIN_PROCNUM_CONSISTENT, brinGetTupleForHeapBlock(), BrinMemTuple::bt_columns, BrinMemTuple::bt_placeholder, buf, BUFFER_LOCK_SHARE, BUFFER_LOCK_UNLOCK, BrinValues::bv_allnulls, CHECK_FOR_INTERRUPTS, check_null_keys(), CurrentMemoryContext, DatumGetBool, fmgr_info_copy(), FunctionCall3Coll(), FunctionCall4Coll(), i, index_getprocinfo(), IndexGetRelation(), IndexScanDescData::indexRelation, Int32GetDatum, InvalidBuffer, InvalidOid, sort-test::key, IndexScanDescData::keyData, len, LockBuffer(), MAXALIGN, MemoryContextDelete(), MemoryContextResetAndDeleteChildren, MemoryContextSwitchTo(), Min, TupleDescData::natts, IndexScanDescData::numberOfKeys, BrinOpcInfo::oi_regular_nulls, IndexScanDescData::opaque, palloc(), palloc0(), PG_USED_FOR_ASSERTS_ONLY, pgstat_count_index_scan, PointerGetDatum, RelationGetNumberOfBlocks, RelationGetRelid, ReleaseBuffer(), ScanKeyData::sk_collation, SK_ISNULL, table_close(), table_open(), tbm_add_page(), TupleDescAttr, and IndexScanDescData::xs_snapshot.

Referenced by brinhandler().

◆ brininsert()

bool brininsert ( Relation  idxRel,
Datum values,
bool nulls,
ItemPointer  heaptid,
Relation  heapRel,
IndexUniqueCheck  checkUnique,
bool  indexUnchanged,
struct IndexInfo indexInfo 
)

Definition at line 155 of file brin.c.

160 {
161  BlockNumber pagesPerRange;
162  BlockNumber origHeapBlk;
163  BlockNumber heapBlk;
164  BrinDesc *bdesc = (BrinDesc *) indexInfo->ii_AmCache;
165  BrinRevmap *revmap;
167  MemoryContext tupcxt = NULL;
169  bool autosummarize = BrinGetAutoSummarize(idxRel);
170 
171  revmap = brinRevmapInitialize(idxRel, &pagesPerRange, NULL);
172 
173  /*
174  * origHeapBlk is the block number where the insertion occurred. heapBlk
175  * is the first block in the corresponding page range.
176  */
177  origHeapBlk = ItemPointerGetBlockNumber(heaptid);
178  heapBlk = (origHeapBlk / pagesPerRange) * pagesPerRange;
179 
180  for (;;)
181  {
182  bool need_insert = false;
183  OffsetNumber off;
184  BrinTuple *brtup;
185  BrinMemTuple *dtup;
186 
188 
189  /*
190  * If auto-summarization is enabled and we just inserted the first
191  * tuple into the first block of a new non-first page range, request a
192  * summarization run of the previous range.
193  */
194  if (autosummarize &&
195  heapBlk > 0 &&
196  heapBlk == origHeapBlk &&
198  {
199  BlockNumber lastPageRange = heapBlk - 1;
200  BrinTuple *lastPageTuple;
201 
202  lastPageTuple =
203  brinGetTupleForHeapBlock(revmap, lastPageRange, &buf, &off,
204  NULL, BUFFER_LOCK_SHARE, NULL);
205  if (!lastPageTuple)
206  {
207  bool recorded;
208 
210  RelationGetRelid(idxRel),
211  lastPageRange);
212  if (!recorded)
213  ereport(LOG,
214  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
215  errmsg("request for BRIN range summarization for index \"%s\" page %u was not recorded",
216  RelationGetRelationName(idxRel),
217  lastPageRange)));
218  }
219  else
221  }
222 
223  brtup = brinGetTupleForHeapBlock(revmap, heapBlk, &buf, &off,
224  NULL, BUFFER_LOCK_SHARE, NULL);
225 
226  /* if range is unsummarized, there's nothing to do */
227  if (!brtup)
228  break;
229 
230  /* First time through in this statement? */
231  if (bdesc == NULL)
232  {
233  MemoryContextSwitchTo(indexInfo->ii_Context);
234  bdesc = brin_build_desc(idxRel);
235  indexInfo->ii_AmCache = (void *) bdesc;
236  MemoryContextSwitchTo(oldcxt);
237  }
238  /* First time through in this brininsert call? */
239  if (tupcxt == NULL)
240  {
242  "brininsert cxt",
244  MemoryContextSwitchTo(tupcxt);
245  }
246 
247  dtup = brin_deform_tuple(bdesc, brtup, NULL);
248 
249  need_insert = add_values_to_range(idxRel, bdesc, dtup, values, nulls);
250 
251  if (!need_insert)
252  {
253  /*
254  * The tuple is consistent with the new values, so there's nothing
255  * to do.
256  */
258  }
259  else
260  {
261  Page page = BufferGetPage(buf);
262  ItemId lp = PageGetItemId(page, off);
263  Size origsz;
264  BrinTuple *origtup;
265  Size newsz;
266  BrinTuple *newtup;
267  bool samepage;
268 
269  /*
270  * Make a copy of the old tuple, so that we can compare it after
271  * re-acquiring the lock.
272  */
273  origsz = ItemIdGetLength(lp);
274  origtup = brin_copy_tuple(brtup, origsz, NULL, NULL);
275 
276  /*
277  * Before releasing the lock, check if we can attempt a same-page
278  * update. Another process could insert a tuple concurrently in
279  * the same page though, so downstream we must be prepared to cope
280  * if this turns out to not be possible after all.
281  */
282  newtup = brin_form_tuple(bdesc, heapBlk, dtup, &newsz);
283  samepage = brin_can_do_samepage_update(buf, origsz, newsz);
285 
286  /*
287  * Try to update the tuple. If this doesn't work for whatever
288  * reason, we need to restart from the top; the revmap might be
289  * pointing at a different tuple for this block now, so we need to
290  * recompute to ensure both our new heap tuple and the other
291  * inserter's are covered by the combined tuple. It might be that
292  * we don't need to update at all.
293  */
294  if (!brin_doupdate(idxRel, pagesPerRange, revmap, heapBlk,
295  buf, off, origtup, origsz, newtup, newsz,
296  samepage))
297  {
298  /* no luck; start over */
300  continue;
301  }
302  }
303 
304  /* success! */
305  break;
306  }
307 
308  brinRevmapTerminate(revmap);
309  if (BufferIsValid(buf))
311  MemoryContextSwitchTo(oldcxt);
312  if (tupcxt != NULL)
313  MemoryContextDelete(tupcxt);
314 
315  return false;
316 }
bool AutoVacuumRequestWork(AutoVacuumWorkItemType type, Oid relationId, BlockNumber blkno)
Definition: autovacuum.c:3349
@ AVW_BRINSummarizeRange
Definition: autovacuum.h:25
static Datum values[MAXATTR]
Definition: bootstrap.c:156
static bool add_values_to_range(Relation idxRel, BrinDesc *bdesc, BrinMemTuple *dtup, Datum *values, bool *nulls)
Definition: brin.c:1671
#define BrinGetAutoSummarize(relation)
Definition: brin.h:45
bool brin_doupdate(Relation idxrel, BlockNumber pagesPerRange, BrinRevmap *revmap, BlockNumber heapBlk, Buffer oldbuf, OffsetNumber oldoff, const BrinTuple *origtup, Size origsz, const BrinTuple *newtup, Size newsz, bool samepage)
Definition: brin_pageops.c:54
bool brin_can_do_samepage_update(Buffer buffer, Size origsz, Size newsz)
Definition: brin_pageops.c:324
BrinTuple * brin_form_tuple(BrinDesc *brdesc, BlockNumber blkno, BrinMemTuple *tuple, Size *size)
Definition: brin_tuple.c:99
#define BufferIsValid(bufnum)
Definition: bufmgr.h:123
#define PageGetItemId(page, offsetNumber)
Definition: bufpage.h:234
int errcode(int sqlerrcode)
Definition: elog.c:698
int errmsg(const char *fmt,...)
Definition: elog.c:909
#define LOG
Definition: elog.h:25
#define ereport(elevel,...)
Definition: elog.h:143
#define ItemIdGetLength(itemId)
Definition: itemid.h:59
#define ItemPointerGetBlockNumber(pointer)
Definition: itemptr.h:98
#define ItemPointerGetOffsetNumber(pointer)
Definition: itemptr.h:117
#define FirstOffsetNumber
Definition: off.h:27
void * ii_AmCache
Definition: execnodes.h:179
MemoryContext ii_Context
Definition: execnodes.h:180

References add_values_to_range(), ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, AutoVacuumRequestWork(), AVW_BRINSummarizeRange, brin_build_desc(), brin_can_do_samepage_update(), brin_copy_tuple(), brin_deform_tuple(), brin_doupdate(), brin_form_tuple(), BrinGetAutoSummarize, brinGetTupleForHeapBlock(), brinRevmapInitialize(), brinRevmapTerminate(), buf, BUFFER_LOCK_SHARE, BUFFER_LOCK_UNLOCK, BufferGetPage, BufferIsValid, CHECK_FOR_INTERRUPTS, CurrentMemoryContext, ereport, errcode(), errmsg(), FirstOffsetNumber, IndexInfo::ii_AmCache, IndexInfo::ii_Context, InvalidBuffer, ItemIdGetLength, ItemPointerGetBlockNumber, ItemPointerGetOffsetNumber, LockBuffer(), LOG, MemoryContextDelete(), MemoryContextResetAndDeleteChildren, MemoryContextSwitchTo(), PageGetItemId, RelationGetRelationName, RelationGetRelid, ReleaseBuffer(), and values.

Referenced by brinhandler().

◆ brinoptions()

bytea* brinoptions ( Datum  reloptions,
bool  validate 
)

Definition at line 970 of file brin.c.

971 {
972  static const relopt_parse_elt tab[] = {
973  {"pages_per_range", RELOPT_TYPE_INT, offsetof(BrinOptions, pagesPerRange)},
974  {"autosummarize", RELOPT_TYPE_BOOL, offsetof(BrinOptions, autosummarize)}
975  };
976 
977  return (bytea *) build_reloptions(reloptions, validate,
979  sizeof(BrinOptions),
980  tab, lengthof(tab));
981 }
#define lengthof(array)
Definition: c.h:734
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:1904
@ RELOPT_KIND_BRIN
Definition: reloptions.h:52
@ RELOPT_TYPE_INT
Definition: reloptions.h:32
@ RELOPT_TYPE_BOOL
Definition: reloptions.h:31
Definition: c.h:622

References build_reloptions(), lengthof, offsetof, RELOPT_KIND_BRIN, RELOPT_TYPE_BOOL, and RELOPT_TYPE_INT.

Referenced by brinhandler().

◆ brinrescan()

void brinrescan ( IndexScanDesc  scan,
ScanKey  scankey,
int  nscankeys,
ScanKey  orderbys,
int  norderbys 
)

Definition at line 729 of file brin.c.

731 {
732  /*
733  * Other index AMs preprocess the scan keys at this point, or sometime
734  * early during the scan; this lets them optimize by removing redundant
735  * keys, or doing early returns when they are impossible to satisfy; see
736  * _bt_preprocess_keys for an example. Something like that could be added
737  * here someday, too.
738  */
739 
740  if (scankey && scan->numberOfKeys > 0)
741  memmove(scan->keyData, scankey,
742  scan->numberOfKeys * sizeof(ScanKeyData));
743 }

References IndexScanDescData::keyData, and IndexScanDescData::numberOfKeys.

Referenced by brinhandler().

◆ brinvacuumcleanup()

IndexBulkDeleteResult* brinvacuumcleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult stats 
)

Definition at line 940 of file brin.c.

941 {
942  Relation heapRel;
943 
944  /* No-op in ANALYZE ONLY mode */
945  if (info->analyze_only)
946  return stats;
947 
948  if (!stats)
950  stats->num_pages = RelationGetNumberOfBlocks(info->index);
951  /* rest of stats is initialized by zeroing */
952 
953  heapRel = table_open(IndexGetRelation(RelationGetRelid(info->index), false),
955 
956  brin_vacuum_scan(info->index, info->strategy);
957 
958  brinsummarize(info->index, heapRel, BRIN_ALL_BLOCKRANGES, false,
959  &stats->num_index_tuples, &stats->num_index_tuples);
960 
961  table_close(heapRel, AccessShareLock);
962 
963  return stats;
964 }
static void brin_vacuum_scan(Relation idxrel, BufferAccessStrategy strategy)
Definition: brin.c:1638
#define BRIN_ALL_BLOCKRANGES
Definition: brin.c:70
static void brinsummarize(Relation index, Relation heapRel, BlockNumber pageRange, bool include_partial, double *numSummarized, double *numExisting)
Definition: brin.c:1446
BlockNumber num_pages
Definition: genam.h:76
double num_index_tuples
Definition: genam.h:78
Relation index
Definition: genam.h:46
bool analyze_only
Definition: genam.h:47
BufferAccessStrategy strategy
Definition: genam.h:52

References AccessShareLock, IndexVacuumInfo::analyze_only, BRIN_ALL_BLOCKRANGES, brin_vacuum_scan(), brinsummarize(), IndexVacuumInfo::index, IndexGetRelation(), IndexBulkDeleteResult::num_index_tuples, IndexBulkDeleteResult::num_pages, palloc0(), RelationGetNumberOfBlocks, RelationGetRelid, IndexVacuumInfo::strategy, table_close(), and table_open().

Referenced by brinhandler().

◆ brinvalidate()

bool brinvalidate ( Oid  opclassoid)

Definition at line 37 of file brin_validate.c.

38 {
39  bool result = true;
40  HeapTuple classtup;
41  Form_pg_opclass classform;
42  Oid opfamilyoid;
43  Oid opcintype;
44  char *opclassname;
45  HeapTuple familytup;
46  Form_pg_opfamily familyform;
47  char *opfamilyname;
48  CatCList *proclist,
49  *oprlist;
50  uint64 allfuncs = 0;
51  uint64 allops = 0;
52  List *grouplist;
53  OpFamilyOpFuncGroup *opclassgroup;
54  int i;
55  ListCell *lc;
56 
57  /* Fetch opclass information */
58  classtup = SearchSysCache1(CLAOID, ObjectIdGetDatum(opclassoid));
59  if (!HeapTupleIsValid(classtup))
60  elog(ERROR, "cache lookup failed for operator class %u", opclassoid);
61  classform = (Form_pg_opclass) GETSTRUCT(classtup);
62 
63  opfamilyoid = classform->opcfamily;
64  opcintype = classform->opcintype;
65  opclassname = NameStr(classform->opcname);
66 
67  /* Fetch opfamily information */
68  familytup = SearchSysCache1(OPFAMILYOID, ObjectIdGetDatum(opfamilyoid));
69  if (!HeapTupleIsValid(familytup))
70  elog(ERROR, "cache lookup failed for operator family %u", opfamilyoid);
71  familyform = (Form_pg_opfamily) GETSTRUCT(familytup);
72 
73  opfamilyname = NameStr(familyform->opfname);
74 
75  /* Fetch all operators and support functions of the opfamily */
76  oprlist = SearchSysCacheList1(AMOPSTRATEGY, ObjectIdGetDatum(opfamilyoid));
77  proclist = SearchSysCacheList1(AMPROCNUM, ObjectIdGetDatum(opfamilyoid));
78 
79  /* Check individual support functions */
80  for (i = 0; i < proclist->n_members; i++)
81  {
82  HeapTuple proctup = &proclist->members[i]->tuple;
83  Form_pg_amproc procform = (Form_pg_amproc) GETSTRUCT(proctup);
84  bool ok;
85 
86  /* Check procedure numbers and function signatures */
87  switch (procform->amprocnum)
88  {
90  ok = check_amproc_signature(procform->amproc, INTERNALOID, true,
91  1, 1, INTERNALOID);
92  break;
94  ok = check_amproc_signature(procform->amproc, BOOLOID, true,
95  4, 4, INTERNALOID, INTERNALOID,
96  INTERNALOID, INTERNALOID);
97  break;
99  ok = check_amproc_signature(procform->amproc, BOOLOID, true,
100  3, 4, INTERNALOID, INTERNALOID,
101  INTERNALOID, INT4OID);
102  break;
103  case BRIN_PROCNUM_UNION:
104  ok = check_amproc_signature(procform->amproc, BOOLOID, true,
105  3, 3, INTERNALOID, INTERNALOID,
106  INTERNALOID);
107  break;
109  ok = check_amoptsproc_signature(procform->amproc);
110  break;
111  default:
112  /* Complain if it's not a valid optional proc number */
113  if (procform->amprocnum < BRIN_FIRST_OPTIONAL_PROCNUM ||
114  procform->amprocnum > BRIN_LAST_OPTIONAL_PROCNUM)
115  {
116  ereport(INFO,
117  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
118  errmsg("operator family \"%s\" of access method %s contains function %s with invalid support number %d",
119  opfamilyname, "brin",
120  format_procedure(procform->amproc),
121  procform->amprocnum)));
122  result = false;
123  continue; /* omit bad proc numbers from allfuncs */
124  }
125  /* Can't check signatures of optional procs, so assume OK */
126  ok = true;
127  break;
128  }
129 
130  if (!ok)
131  {
132  ereport(INFO,
133  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
134  errmsg("operator family \"%s\" of access method %s contains function %s with wrong signature for support number %d",
135  opfamilyname, "brin",
136  format_procedure(procform->amproc),
137  procform->amprocnum)));
138  result = false;
139  }
140 
141  /* Track all valid procedure numbers seen in opfamily */
142  allfuncs |= ((uint64) 1) << procform->amprocnum;
143  }
144 
145  /* Check individual operators */
146  for (i = 0; i < oprlist->n_members; i++)
147  {
148  HeapTuple oprtup = &oprlist->members[i]->tuple;
149  Form_pg_amop oprform = (Form_pg_amop) GETSTRUCT(oprtup);
150 
151  /* Check that only allowed strategy numbers exist */
152  if (oprform->amopstrategy < 1 || oprform->amopstrategy > 63)
153  {
154  ereport(INFO,
155  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
156  errmsg("operator family \"%s\" of access method %s contains operator %s with invalid strategy number %d",
157  opfamilyname, "brin",
158  format_operator(oprform->amopopr),
159  oprform->amopstrategy)));
160  result = false;
161  }
162  else
163  {
164  /*
165  * The set of operators supplied varies across BRIN opfamilies.
166  * Our plan is to identify all operator strategy numbers used in
167  * the opfamily and then complain about datatype combinations that
168  * are missing any operator(s). However, consider only numbers
169  * that appear in some non-cross-type case, since cross-type
170  * operators may have unique strategies. (This is not a great
171  * heuristic, in particular an erroneous number used in a
172  * cross-type operator will not get noticed; but the core BRIN
173  * opfamilies are messy enough to make it necessary.)
174  */
175  if (oprform->amoplefttype == oprform->amoprighttype)
176  allops |= ((uint64) 1) << oprform->amopstrategy;
177  }
178 
179  /* brin doesn't support ORDER BY operators */
180  if (oprform->amoppurpose != AMOP_SEARCH ||
181  OidIsValid(oprform->amopsortfamily))
182  {
183  ereport(INFO,
184  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
185  errmsg("operator family \"%s\" of access method %s contains invalid ORDER BY specification for operator %s",
186  opfamilyname, "brin",
187  format_operator(oprform->amopopr))));
188  result = false;
189  }
190 
191  /* Check operator signature --- same for all brin strategies */
192  if (!check_amop_signature(oprform->amopopr, BOOLOID,
193  oprform->amoplefttype,
194  oprform->amoprighttype))
195  {
196  ereport(INFO,
197  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
198  errmsg("operator family \"%s\" of access method %s contains operator %s with wrong signature",
199  opfamilyname, "brin",
200  format_operator(oprform->amopopr))));
201  result = false;
202  }
203  }
204 
205  /* Now check for inconsistent groups of operators/functions */
206  grouplist = identify_opfamily_groups(oprlist, proclist);
207  opclassgroup = NULL;
208  foreach(lc, grouplist)
209  {
210  OpFamilyOpFuncGroup *thisgroup = (OpFamilyOpFuncGroup *) lfirst(lc);
211 
212  /* Remember the group exactly matching the test opclass */
213  if (thisgroup->lefttype == opcintype &&
214  thisgroup->righttype == opcintype)
215  opclassgroup = thisgroup;
216 
217  /*
218  * Some BRIN opfamilies expect cross-type support functions to exist,
219  * and some don't. We don't know exactly which are which, so if we
220  * find a cross-type operator for which there are no support functions
221  * at all, let it pass. (Don't expect that all operators exist for
222  * such cross-type cases, either.)
223  */
224  if (thisgroup->functionset == 0 &&
225  thisgroup->lefttype != thisgroup->righttype)
226  continue;
227 
228  /*
229  * Else complain if there seems to be an incomplete set of either
230  * operators or support functions for this datatype pair.
231  */
232  if (thisgroup->operatorset != allops)
233  {
234  ereport(INFO,
235  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
236  errmsg("operator family \"%s\" of access method %s is missing operator(s) for types %s and %s",
237  opfamilyname, "brin",
238  format_type_be(thisgroup->lefttype),
239  format_type_be(thisgroup->righttype))));
240  result = false;
241  }
242  if (thisgroup->functionset != allfuncs)
243  {
244  ereport(INFO,
245  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
246  errmsg("operator family \"%s\" of access method %s is missing support function(s) for types %s and %s",
247  opfamilyname, "brin",
248  format_type_be(thisgroup->lefttype),
249  format_type_be(thisgroup->righttype))));
250  result = false;
251  }
252  }
253 
254  /* Check that the originally-named opclass is complete */
255  if (!opclassgroup || opclassgroup->operatorset != allops)
256  {
257  ereport(INFO,
258  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
259  errmsg("operator class \"%s\" of access method %s is missing operator(s)",
260  opclassname, "brin")));
261  result = false;
262  }
263  for (i = 1; i <= BRIN_MANDATORY_NPROCS; i++)
264  {
265  if (opclassgroup &&
266  (opclassgroup->functionset & (((int64) 1) << i)) != 0)
267  continue; /* got it */
268  ereport(INFO,
269  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
270  errmsg("operator class \"%s\" of access method %s is missing support function %d",
271  opclassname, "brin", i)));
272  result = false;
273  }
274 
275  ReleaseCatCacheList(proclist);
276  ReleaseCatCacheList(oprlist);
277  ReleaseSysCache(familytup);
278  ReleaseSysCache(classtup);
279 
280  return result;
281 }
bool check_amproc_signature(Oid funcid, Oid restype, bool exact, int minargs, int maxargs,...)
Definition: amvalidate.c:152
bool check_amop_signature(Oid opno, Oid restype, Oid lefttype, Oid righttype)
Definition: amvalidate.c:206
List * identify_opfamily_groups(CatCList *oprlist, CatCList *proclist)
Definition: amvalidate.c:43
bool check_amoptsproc_signature(Oid funcid)
Definition: amvalidate.c:192
#define BRIN_LAST_OPTIONAL_PROCNUM
Definition: brin_internal.h:78
#define BRIN_PROCNUM_UNION
Definition: brin_internal.h:73
#define BRIN_MANDATORY_NPROCS
Definition: brin_internal.h:74
#define BRIN_PROCNUM_OPTIONS
Definition: brin_internal.h:75
#define BRIN_FIRST_OPTIONAL_PROCNUM
Definition: brin_internal.h:77
#define BRIN_PROCNUM_ADDVALUE
Definition: brin_internal.h:71
#define NameStr(name)
Definition: c.h:681
#define OidIsValid(objectId)
Definition: c.h:710
void ReleaseCatCacheList(CatCList *list)
Definition: catcache.c:1784
#define INFO
Definition: elog.h:28
char * format_type_be(Oid type_oid)
Definition: format_type.c:339
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define GETSTRUCT(TUP)
Definition: htup_details.h:649
FormData_pg_amop * Form_pg_amop
Definition: pg_amop.h:88
FormData_pg_amproc * Form_pg_amproc
Definition: pg_amproc.h:68
#define lfirst(lc)
Definition: pg_list.h:169
FormData_pg_opclass * Form_pg_opclass
Definition: pg_opclass.h:83
FormData_pg_opfamily * Form_pg_opfamily
Definition: pg_opfamily.h:51
#define ObjectIdGetDatum(X)
Definition: postgres.h:551
char * format_operator(Oid operator_oid)
Definition: regproc.c:852
char * format_procedure(Oid procedure_oid)
Definition: regproc.c:323
Definition: pg_list.h:51
CatCTup * members[FLEXIBLE_ARRAY_MEMBER]
Definition: catcache.h:178
int n_members
Definition: catcache.h:176
HeapTupleData tuple
Definition: catcache.h:121
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1198
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1150
@ OPFAMILYOID
Definition: syscache.h:74
@ CLAOID
Definition: syscache.h:48
@ AMPROCNUM
Definition: syscache.h:39
@ AMOPSTRATEGY
Definition: syscache.h:38
#define SearchSysCacheList1(cacheId, key1)
Definition: syscache.h:213

References AMOPSTRATEGY, AMPROCNUM, BRIN_FIRST_OPTIONAL_PROCNUM, BRIN_LAST_OPTIONAL_PROCNUM, BRIN_MANDATORY_NPROCS, BRIN_PROCNUM_ADDVALUE, BRIN_PROCNUM_CONSISTENT, BRIN_PROCNUM_OPCINFO, BRIN_PROCNUM_OPTIONS, BRIN_PROCNUM_UNION, check_amop_signature(), check_amoptsproc_signature(), check_amproc_signature(), CLAOID, elog, ereport, errcode(), errmsg(), ERROR, format_operator(), format_procedure(), format_type_be(), OpFamilyOpFuncGroup::functionset, GETSTRUCT, HeapTupleIsValid, i, identify_opfamily_groups(), INFO, OpFamilyOpFuncGroup::lefttype, lfirst, catclist::members, catclist::n_members, NameStr, ObjectIdGetDatum, OidIsValid, OpFamilyOpFuncGroup::operatorset, OPFAMILYOID, ReleaseCatCacheList(), ReleaseSysCache(), OpFamilyOpFuncGroup::righttype, SearchSysCache1(), SearchSysCacheList1, and catctup::tuple.

Referenced by brinhandler().