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, 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)

◆ BRIN_FIRST_OPTIONAL_PROCNUM

#define BRIN_FIRST_OPTIONAL_PROCNUM   11

Definition at line 74 of file brin_internal.h.

Referenced by brinvalidate().

◆ BRIN_LAST_OPTIONAL_PROCNUM

#define BRIN_LAST_OPTIONAL_PROCNUM   15

Definition at line 75 of file brin_internal.h.

Referenced by brinhandler(), and brinvalidate().

◆ BRIN_MANDATORY_NPROCS

#define BRIN_MANDATORY_NPROCS   4

Definition at line 71 of file brin_internal.h.

Referenced by brinvalidate().

◆ BRIN_PROCNUM_ADDVALUE

#define BRIN_PROCNUM_ADDVALUE   2

Definition at line 68 of file brin_internal.h.

Referenced by brinbuildCallback(), brininsert(), and brinvalidate().

◆ BRIN_PROCNUM_CONSISTENT

#define BRIN_PROCNUM_CONSISTENT   3

Definition at line 69 of file brin_internal.h.

Referenced by bringetbitmap(), and brinvalidate().

◆ BRIN_PROCNUM_OPCINFO

#define BRIN_PROCNUM_OPCINFO   1

Definition at line 67 of file brin_internal.h.

Referenced by brin_build_desc(), and brinvalidate().

◆ BRIN_PROCNUM_OPTIONS

#define BRIN_PROCNUM_OPTIONS   5 /* optional */

Definition at line 72 of file brin_internal.h.

Referenced by brinhandler(), and brinvalidate().

◆ BRIN_PROCNUM_UNION

#define BRIN_PROCNUM_UNION   4

Definition at line 70 of file brin_internal.h.

Referenced by brinvalidate(), and union_tuples().

◆ SizeofBrinOpcInfo

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

Definition at line 38 of file brin_internal.h.

Referenced by brin_inclusion_opcinfo(), and brin_minmax_opcinfo().

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 1019 of file brin.c.

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().

1020 {
1021  BrinOpcInfo **opcinfo;
1022  BrinDesc *bdesc;
1023  TupleDesc tupdesc;
1024  int totalstored = 0;
1025  int keyno;
1026  long totalsize;
1027  MemoryContext cxt;
1028  MemoryContext oldcxt;
1029 
1031  "brin desc cxt",
1033  oldcxt = MemoryContextSwitchTo(cxt);
1034  tupdesc = RelationGetDescr(rel);
1035 
1036  /*
1037  * Obtain BrinOpcInfo for each indexed column. While at it, accumulate
1038  * the number of columns stored, since the number is opclass-defined.
1039  */
1040  opcinfo = (BrinOpcInfo **) palloc(sizeof(BrinOpcInfo *) * tupdesc->natts);
1041  for (keyno = 0; keyno < tupdesc->natts; keyno++)
1042  {
1043  FmgrInfo *opcInfoFn;
1044  Form_pg_attribute attr = TupleDescAttr(tupdesc, keyno);
1045 
1046  opcInfoFn = index_getprocinfo(rel, keyno + 1, BRIN_PROCNUM_OPCINFO);
1047 
1048  opcinfo[keyno] = (BrinOpcInfo *)
1049  DatumGetPointer(FunctionCall1(opcInfoFn, attr->atttypid));
1050  totalstored += opcinfo[keyno]->oi_nstored;
1051  }
1052 
1053  /* Allocate our result struct and fill it in */
1054  totalsize = offsetof(BrinDesc, bd_info) +
1055  sizeof(BrinOpcInfo *) * tupdesc->natts;
1056 
1057  bdesc = palloc(totalsize);
1058  bdesc->bd_context = cxt;
1059  bdesc->bd_index = rel;
1060  bdesc->bd_tupdesc = tupdesc;
1061  bdesc->bd_disktdesc = NULL; /* generated lazily */
1062  bdesc->bd_totalstored = totalstored;
1063 
1064  for (keyno = 0; keyno < tupdesc->natts; keyno++)
1065  bdesc->bd_info[keyno] = opcinfo[keyno];
1066  pfree(opcinfo);
1067 
1068  MemoryContextSwitchTo(oldcxt);
1069 
1070  return bdesc;
1071 }
Definition: fmgr.h:56
#define AllocSetContextCreate
Definition: memutils.h:170
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:801
#define RelationGetDescr(relation)
Definition: rel.h:482
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:202
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define BRIN_PROCNUM_OPCINFO
Definition: brin_internal.h:67
void pfree(void *pointer)
Definition: mcxt.c:1057
Relation bd_index
Definition: brin_internal.h:47
uint16 oi_nstored
Definition: brin_internal.h:28
int bd_totalstored
Definition: brin_internal.h:56
TupleDesc bd_tupdesc
Definition: brin_internal.h:50
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:193
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
BrinOpcInfo * bd_info[FLEXIBLE_ARRAY_MEMBER]
Definition: brin_internal.h:59
#define DatumGetPointer(X)
Definition: postgres.h:549
MemoryContext bd_context
Definition: brin_internal.h:44
void * palloc(Size size)
Definition: mcxt.c:950
TupleDesc bd_disktdesc
Definition: brin_internal.h:53
#define FunctionCall1(flinfo, arg1)
Definition: fmgr.h:642
#define offsetof(type, field)
Definition: c.h:668

◆ brin_free_desc()

void brin_free_desc ( BrinDesc bdesc)

Definition at line 1074 of file brin.c.

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

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

1075 {
1076  /* make sure the tupdesc is still valid */
1077  Assert(bdesc->bd_tupdesc->tdrefcount >= 1);
1078  /* no need for retail pfree */
1080 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:212
TupleDesc bd_tupdesc
Definition: brin_internal.h:50
#define Assert(condition)
Definition: c.h:745
MemoryContext bd_context
Definition: brin_internal.h:44
int tdrefcount
Definition: tupdesc.h:84

◆ brinbeginscan()

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

Definition at line 346 of file brin.c.

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().

347 {
348  IndexScanDesc scan;
349  BrinOpaque *opaque;
350 
351  scan = RelationGetIndexScan(r, nkeys, norderbys);
352 
353  opaque = (BrinOpaque *) palloc(sizeof(BrinOpaque));
354  opaque->bo_rmAccess = brinRevmapInitialize(r, &opaque->bo_pagesPerRange,
355  scan->xs_snapshot);
356  opaque->bo_bdesc = brin_build_desc(r);
357  scan->opaque = opaque;
358 
359  return scan;
360 }
struct SnapshotData * xs_snapshot
Definition: relscan.h:116
BlockNumber bo_pagesPerRange
Definition: brin.c:64
BrinRevmap * bo_rmAccess
Definition: brin.c:65
BrinDesc * bo_bdesc
Definition: brin.c:66
BrinDesc * brin_build_desc(Relation rel)
Definition: brin.c:1019
BrinRevmap * brinRevmapInitialize(Relation idxrel, BlockNumber *pagesPerRange, Snapshot snapshot)
Definition: brin_revmap.c:71
void * palloc(Size size)
Definition: mcxt.c:950
IndexScanDesc RelationGetIndexScan(Relation indexRelation, int nkeys, int norderbys)
Definition: genam.c:81

◆ brinbuild()

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

Definition at line 669 of file brin.c.

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().

670 {
671  IndexBuildResult *result;
672  double reltuples;
673  double idxtuples;
674  BrinRevmap *revmap;
676  Buffer meta;
677  BlockNumber pagesPerRange;
678 
679  /*
680  * We expect to be called exactly once for any index relation.
681  */
682  if (RelationGetNumberOfBlocks(index) != 0)
683  elog(ERROR, "index \"%s\" already contains data",
684  RelationGetRelationName(index));
685 
686  /*
687  * Critical section not required, because on error the creation of the
688  * whole relation will be rolled back.
689  */
690 
691  meta = ReadBuffer(index, P_NEW);
694 
697  MarkBufferDirty(meta);
698 
699  if (RelationNeedsWAL(index))
700  {
701  xl_brin_createidx xlrec;
702  XLogRecPtr recptr;
703  Page page;
704 
706  xlrec.pagesPerRange = BrinGetPagesPerRange(index);
707 
708  XLogBeginInsert();
709  XLogRegisterData((char *) &xlrec, SizeOfBrinCreateIdx);
711 
712  recptr = XLogInsert(RM_BRIN_ID, XLOG_BRIN_CREATE_INDEX);
713 
714  page = BufferGetPage(meta);
715  PageSetLSN(page, recptr);
716  }
717 
718  UnlockReleaseBuffer(meta);
719 
720  /*
721  * Initialize our state, including the deformed tuple state.
722  */
723  revmap = brinRevmapInitialize(index, &pagesPerRange, NULL);
724  state = initialize_brin_buildstate(index, revmap, pagesPerRange);
725 
726  /*
727  * Now scan the relation. No syncscan allowed here because we want the
728  * heap blocks in physical order.
729  */
730  reltuples = table_index_build_scan(heap, index, indexInfo, false, true,
731  brinbuildCallback, (void *) state, NULL);
732 
733  /* process the final batch */
734  form_and_insert_tuple(state);
735 
736  /* release resources */
737  idxtuples = state->bs_numtuples;
740 
741  /*
742  * Return statistics
743  */
744  result = (IndexBuildResult *) palloc(sizeof(IndexBuildResult));
745 
746  result->heap_tuples = reltuples;
747  result->index_tuples = idxtuples;
748 
749  return result;
750 }
#define BRIN_CURRENT_VERSION
Definition: brin_page.h:72
#define BRIN_METAPAGE_BLKNO
Definition: brin_page.h:75
#define SizeOfBrinCreateIdx
Definition: brin_xlog.h:55
void brinRevmapTerminate(BrinRevmap *revmap)
Definition: brin_revmap.c:103
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1469
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:220
#define XLOG_BRIN_CREATE_INDEX
Definition: brin_xlog.h:31
#define REGBUF_WILL_INIT
Definition: xloginsert.h:33
uint32 BlockNumber
Definition: block.h:31
static void form_and_insert_tuple(BrinBuildState *state)
Definition: brin.c:1401
#define P_NEW
Definition: bufmgr.h:91
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:98
#define BrinGetPagesPerRange(relation)
Definition: brin.h:39
void brin_metapage_init(Page page, BlockNumber pagesPerRange, uint16 version)
Definition: brin_pageops.c:487
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3541
#define ERROR
Definition: elog.h:43
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:1552
#define REGBUF_STANDARD
Definition: xloginsert.h:35
BrinRevmap * bs_rmAccess
Definition: brin.c:54
#define RelationGetRelationName(relation)
Definition: rel.h:490
static void brinbuildCallback(Relation index, ItemPointer tid, Datum *values, bool *isnull, bool tupleIsAlive, void *brstate)
Definition: brin.c:606
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:330
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:422
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3757
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:211
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:745
Definition: regguts.h:298
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:607
BrinRevmap * brinRevmapInitialize(Relation idxrel, BlockNumber *pagesPerRange, Snapshot snapshot)
Definition: brin_revmap.c:71
#define RelationNeedsWAL(relation)
Definition: rel.h:562
int bs_numtuples
Definition: brin.c:50
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2668
void * palloc(Size size)
Definition: mcxt.c:950
#define elog(elevel,...)
Definition: elog.h:214
BlockNumber pagesPerRange
Definition: brin_xlog.h:52
static BrinBuildState * initialize_brin_buildstate(Relation idxRel, BrinRevmap *revmap, BlockNumber pagesPerRange)
Definition: brin.c:1107
void XLogBeginInsert(void)
Definition: xloginsert.c:123
#define PageSetLSN(page, lsn)
Definition: bufpage.h:368
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78
double index_tuples
Definition: genam.h:33
double heap_tuples
Definition: genam.h:32
static void terminate_brin_buildstate(BrinBuildState *state)
Definition: brin.c:1132

◆ brinbuildempty()

void brinbuildempty ( Relation  index)

Definition at line 753 of file brin.c.

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().

754 {
755  Buffer metabuf;
756 
757  /* An empty BRIN index has a metapage only. */
758  metabuf =
761 
762  /* Initialize and xlog metabuffer. */
766  MarkBufferDirty(metabuf);
767  log_newpage_buffer(metabuf, true);
769 
770  UnlockReleaseBuffer(metabuf);
771 }
#define BRIN_CURRENT_VERSION
Definition: brin_page.h:72
XLogRecPtr log_newpage_buffer(Buffer buffer, bool page_std)
Definition: xloginsert.c:1090
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1469
Buffer ReadBufferExtended(Relation reln, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy)
Definition: bufmgr.c:653
#define END_CRIT_SECTION()
Definition: miscadmin.h:134
#define START_CRIT_SECTION()
Definition: miscadmin.h:132
#define P_NEW
Definition: bufmgr.h:91
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:98
#define BrinGetPagesPerRange(relation)
Definition: brin.h:39
void brin_metapage_init(Page page, BlockNumber pagesPerRange, uint16 version)
Definition: brin_pageops.c:487
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3541
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3757
int Buffer
Definition: buf.h:23

◆ brinbulkdelete()

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

Definition at line 783 of file brin.c.

References palloc0().

Referenced by brinhandler().

785 {
786  /* allocate stats if first time through, else re-use existing struct */
787  if (stats == NULL)
789 
790  return stats;
791 }
void * palloc0(Size size)
Definition: mcxt.c:981

◆ brinendscan()

void brinendscan ( IndexScanDesc  scan)

Definition at line 589 of file brin.c.

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

Referenced by brinhandler().

590 {
591  BrinOpaque *opaque = (BrinOpaque *) scan->opaque;
592 
594  brin_free_desc(opaque->bo_bdesc);
595  pfree(opaque);
596 }
void brin_free_desc(BrinDesc *bdesc)
Definition: brin.c:1074
void brinRevmapTerminate(BrinRevmap *revmap)
Definition: brin_revmap.c:103
void pfree(void *pointer)
Definition: mcxt.c:1057
BrinRevmap * bo_rmAccess
Definition: brin.c:65
BrinDesc * bo_bdesc
Definition: brin.c:66

◆ bringetbitmap()

int64 bringetbitmap ( IndexScanDesc  scan,
TIDBitmap tbm 
)

Definition at line 375 of file brin.c.

References AccessShareLock, addrange(), ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, 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, CHECK_FOR_INTERRUPTS, CurrentMemoryContext, DatumGetBool, fmgr_info_copy(), FunctionCall3Coll(), index_getprocinfo(), IndexGetRelation(), IndexScanDescData::indexRelation, InvalidBuffer, InvalidOid, sort-test::key, IndexScanDescData::keyData, LockBuffer(), MemoryContextDelete(), MemoryContextResetAndDeleteChildren, MemoryContextSwitchTo(), TupleDescData::natts, IndexScanDescData::numberOfKeys, IndexScanDescData::opaque, palloc0(), pgstat_count_index_scan, PointerGetDatum, RelationGetNumberOfBlocks, RelationGetRelid, ReleaseBuffer(), ScanKeyData::sk_attno, ScanKeyData::sk_collation, ScanKeyData::sk_flags, SK_ISNULL, table_close(), table_open(), tbm_add_page(), TupleDescAttr, and IndexScanDescData::xs_snapshot.

Referenced by brinhandler().

376 {
377  Relation idxRel = scan->indexRelation;
379  BrinDesc *bdesc;
380  Oid heapOid;
381  Relation heapRel;
382  BrinOpaque *opaque;
383  BlockNumber nblocks;
384  BlockNumber heapBlk;
385  int totalpages = 0;
386  FmgrInfo *consistentFn;
387  MemoryContext oldcxt;
388  MemoryContext perRangeCxt;
389  BrinMemTuple *dtup;
390  BrinTuple *btup = NULL;
391  Size btupsz = 0;
392 
393  opaque = (BrinOpaque *) scan->opaque;
394  bdesc = opaque->bo_bdesc;
395  pgstat_count_index_scan(idxRel);
396 
397  /*
398  * We need to know the size of the table so that we know how long to
399  * iterate on the revmap.
400  */
401  heapOid = IndexGetRelation(RelationGetRelid(idxRel), false);
402  heapRel = table_open(heapOid, AccessShareLock);
403  nblocks = RelationGetNumberOfBlocks(heapRel);
404  table_close(heapRel, AccessShareLock);
405 
406  /*
407  * Make room for the consistent support procedures of indexed columns. We
408  * don't look them up here; we do that lazily the first time we see a scan
409  * key reference each of them. We rely on zeroing fn_oid to InvalidOid.
410  */
411  consistentFn = palloc0(sizeof(FmgrInfo) * bdesc->bd_tupdesc->natts);
412 
413  /* allocate an initial in-memory tuple, out of the per-range memcxt */
414  dtup = brin_new_memtuple(bdesc);
415 
416  /*
417  * Setup and use a per-range memory context, which is reset every time we
418  * loop below. This avoids having to free the tuples within the loop.
419  */
421  "bringetbitmap cxt",
423  oldcxt = MemoryContextSwitchTo(perRangeCxt);
424 
425  /*
426  * Now scan the revmap. We start by querying for heap page 0,
427  * incrementing by the number of pages per range; this gives us a full
428  * view of the table.
429  */
430  for (heapBlk = 0; heapBlk < nblocks; heapBlk += opaque->bo_pagesPerRange)
431  {
432  bool addrange;
433  bool gottuple = false;
434  BrinTuple *tup;
435  OffsetNumber off;
436  Size size;
437 
439 
441 
442  tup = brinGetTupleForHeapBlock(opaque->bo_rmAccess, heapBlk, &buf,
443  &off, &size, BUFFER_LOCK_SHARE,
444  scan->xs_snapshot);
445  if (tup)
446  {
447  gottuple = true;
448  btup = brin_copy_tuple(tup, size, btup, &btupsz);
450  }
451 
452  /*
453  * For page ranges with no indexed tuple, we must return the whole
454  * range; otherwise, compare it to the scan keys.
455  */
456  if (!gottuple)
457  {
458  addrange = true;
459  }
460  else
461  {
462  dtup = brin_deform_tuple(bdesc, btup, dtup);
463  if (dtup->bt_placeholder)
464  {
465  /*
466  * Placeholder tuples are always returned, regardless of the
467  * values stored in them.
468  */
469  addrange = true;
470  }
471  else
472  {
473  int keyno;
474 
475  /*
476  * Compare scan keys with summary values stored for the range.
477  * If scan keys are matched, the page range must be added to
478  * the bitmap. We initially assume the range needs to be
479  * added; in particular this serves the case where there are
480  * no keys.
481  */
482  addrange = true;
483  for (keyno = 0; keyno < scan->numberOfKeys; keyno++)
484  {
485  ScanKey key = &scan->keyData[keyno];
486  AttrNumber keyattno = key->sk_attno;
487  BrinValues *bval = &dtup->bt_columns[keyattno - 1];
488  Datum add;
489 
490  /*
491  * The collation of the scan key must match the collation
492  * used in the index column (but only if the search is not
493  * IS NULL/ IS NOT NULL). Otherwise we shouldn't be using
494  * this index ...
495  */
496  Assert((key->sk_flags & SK_ISNULL) ||
497  (key->sk_collation ==
498  TupleDescAttr(bdesc->bd_tupdesc,
499  keyattno - 1)->attcollation));
500 
501  /* First time this column? look up consistent function */
502  if (consistentFn[keyattno - 1].fn_oid == InvalidOid)
503  {
504  FmgrInfo *tmp;
505 
506  tmp = index_getprocinfo(idxRel, keyattno,
508  fmgr_info_copy(&consistentFn[keyattno - 1], tmp,
510  }
511 
512  /*
513  * Check whether the scan key is consistent with the page
514  * range values; if so, have the pages in the range added
515  * to the output bitmap.
516  *
517  * When there are multiple scan keys, failure to meet the
518  * criteria for a single one of them is enough to discard
519  * the range as a whole, so break out of the loop as soon
520  * as a false return value is obtained.
521  */
522  add = FunctionCall3Coll(&consistentFn[keyattno - 1],
523  key->sk_collation,
524  PointerGetDatum(bdesc),
525  PointerGetDatum(bval),
526  PointerGetDatum(key));
527  addrange = DatumGetBool(add);
528  if (!addrange)
529  break;
530  }
531  }
532  }
533 
534  /* add the pages in the range to the output bitmap, if needed */
535  if (addrange)
536  {
537  BlockNumber pageno;
538 
539  for (pageno = heapBlk;
540  pageno <= heapBlk + opaque->bo_pagesPerRange - 1;
541  pageno++)
542  {
543  MemoryContextSwitchTo(oldcxt);
544  tbm_add_page(tbm, pageno);
545  totalpages++;
546  MemoryContextSwitchTo(perRangeCxt);
547  }
548  }
549  }
550 
551  MemoryContextSwitchTo(oldcxt);
552  MemoryContextDelete(perRangeCxt);
553 
554  if (buf != InvalidBuffer)
555  ReleaseBuffer(buf);
556 
557  /*
558  * XXX We have an approximation of the number of *pages* that our scan
559  * returns, but we don't have a precise idea of the number of heap tuples
560  * involved.
561  */
562  return totalpages * 10;
563 }
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:96
Definition: fmgr.h:56
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3401
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:212
#define AllocSetContextCreate
Definition: memutils.h:170
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:801
BrinTuple * brin_copy_tuple(BrinTuple *tuple, Size len, BrinTuple *dest, Size *destsz)
Definition: brin_tuple.c:319
BrinTuple * brinGetTupleForHeapBlock(BrinRevmap *revmap, BlockNumber heapBlk, Buffer *buf, OffsetNumber *off, Size *size, int mode, Snapshot snapshot)
Definition: brin_revmap.c:197
#define PointerGetDatum(X)
Definition: postgres.h:556
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
static void addrange(struct cvec *cv, chr from, chr to)
Definition: regc_cvec.c:90
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define AccessShareLock
Definition: lockdefs.h:36
#define InvalidBuffer
Definition: buf.h:25
struct SnapshotData * xs_snapshot
Definition: relscan.h:116
uint32 BlockNumber
Definition: block.h:31
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3518
unsigned int Oid
Definition: postgres_ext.h:31
BrinMemTuple * brin_new_memtuple(BrinDesc *brdesc)
Definition: brin_tuple.c:355
BlockNumber bo_pagesPerRange
Definition: brin.c:64
Relation indexRelation
Definition: relscan.h:115
uint16 OffsetNumber
Definition: off.h:24
BrinMemTuple * brin_deform_tuple(BrinDesc *brdesc, BrinTuple *tuple, BrinMemTuple *dMemtuple)
Definition: brin_tuple.c:420
bool bt_placeholder
Definition: brin_tuple.h:38
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
void fmgr_info_copy(FmgrInfo *dstinfo, FmgrInfo *srcinfo, MemoryContext destcxt)
Definition: fmgr.c:612
BrinValues bt_columns[FLEXIBLE_ARRAY_MEMBER]
Definition: brin_tuple.h:46
static char * buf
Definition: pg_test_fsync.c:67
BrinRevmap * bo_rmAccess
Definition: brin.c:65
#define DatumGetBool(X)
Definition: postgres.h:393
#define pgstat_count_index_scan(rel)
Definition: pgstat.h:1417
TupleDesc bd_tupdesc
Definition: brin_internal.h:50
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
#define SK_ISNULL
Definition: skey.h:115
#define MemoryContextResetAndDeleteChildren(ctx)
Definition: memutils.h:67
BrinDesc * bo_bdesc
Definition: brin.c:66
void * palloc0(Size size)
Definition: mcxt.c:981
uintptr_t Datum
Definition: postgres.h:367
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3757
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:211
#define InvalidOid
Definition: postgres_ext.h:36
Datum FunctionCall3Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3)
Definition: fmgr.c:1174
int sk_flags
Definition: skey.h:66
#define Assert(condition)
Definition: c.h:745
#define BRIN_PROCNUM_CONSISTENT
Definition: brin_internal.h:69
size_t Size
Definition: c.h:473
struct ScanKeyData * keyData
Definition: relscan.h:119
void tbm_add_page(TIDBitmap *tbm, BlockNumber pageno)
Definition: tidbitmap.c:442
Oid sk_collation
Definition: skey.h:70
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:97
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
int Buffer
Definition: buf.h:23
int16 AttrNumber
Definition: attnum.h:21
#define RelationGetRelid(relation)
Definition: rel.h:456
AttrNumber sk_attno
Definition: skey.h:67

◆ brininsert()

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

Definition at line 151 of file brin.c.

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, AutoVacuumRequestWork(), AVW_BRINSummarizeRange, BrinDesc::bd_tupdesc, brin_build_desc(), brin_can_do_samepage_update(), brin_copy_tuple(), brin_deform_tuple(), brin_doupdate(), brin_form_tuple(), BRIN_PROCNUM_ADDVALUE, BrinGetAutoSummarize, brinGetTupleForHeapBlock(), brinRevmapInitialize(), brinRevmapTerminate(), BrinMemTuple::bt_columns, buf, BUFFER_LOCK_SHARE, BUFFER_LOCK_UNLOCK, BufferGetPage, BufferIsValid, CHECK_FOR_INTERRUPTS, CurrentMemoryContext, DatumGetBool, ereport, errcode(), errmsg(), FirstOffsetNumber, FunctionCall4Coll(), IndexInfo::ii_AmCache, IndexInfo::ii_Context, index_getprocinfo(), InvalidBuffer, ItemIdGetLength, ItemPointerGetBlockNumber, ItemPointerGetOffsetNumber, LockBuffer(), LOG, MemoryContextDelete(), MemoryContextResetAndDeleteChildren, MemoryContextSwitchTo(), TupleDescData::natts, PageGetItemId, PointerGetDatum, RelationData::rd_indcollation, RelationGetRelationName, RelationGetRelid, and ReleaseBuffer().

Referenced by brinhandler().

155 {
156  BlockNumber pagesPerRange;
157  BlockNumber origHeapBlk;
158  BlockNumber heapBlk;
159  BrinDesc *bdesc = (BrinDesc *) indexInfo->ii_AmCache;
160  BrinRevmap *revmap;
162  MemoryContext tupcxt = NULL;
164  bool autosummarize = BrinGetAutoSummarize(idxRel);
165 
166  revmap = brinRevmapInitialize(idxRel, &pagesPerRange, NULL);
167 
168  /*
169  * origHeapBlk is the block number where the insertion occurred. heapBlk
170  * is the first block in the corresponding page range.
171  */
172  origHeapBlk = ItemPointerGetBlockNumber(heaptid);
173  heapBlk = (origHeapBlk / pagesPerRange) * pagesPerRange;
174 
175  for (;;)
176  {
177  bool need_insert = false;
178  OffsetNumber off;
179  BrinTuple *brtup;
180  BrinMemTuple *dtup;
181  int keyno;
182 
184 
185  /*
186  * If auto-summarization is enabled and we just inserted the first
187  * tuple into the first block of a new non-first page range, request a
188  * summarization run of the previous range.
189  */
190  if (autosummarize &&
191  heapBlk > 0 &&
192  heapBlk == origHeapBlk &&
194  {
195  BlockNumber lastPageRange = heapBlk - 1;
196  BrinTuple *lastPageTuple;
197 
198  lastPageTuple =
199  brinGetTupleForHeapBlock(revmap, lastPageRange, &buf, &off,
200  NULL, BUFFER_LOCK_SHARE, NULL);
201  if (!lastPageTuple)
202  {
203  bool recorded;
204 
206  RelationGetRelid(idxRel),
207  lastPageRange);
208  if (!recorded)
209  ereport(LOG,
210  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
211  errmsg("request for BRIN range summarization for index \"%s\" page %u was not recorded",
212  RelationGetRelationName(idxRel),
213  lastPageRange)));
214  }
215  else
217  }
218 
219  brtup = brinGetTupleForHeapBlock(revmap, heapBlk, &buf, &off,
220  NULL, BUFFER_LOCK_SHARE, NULL);
221 
222  /* if range is unsummarized, there's nothing to do */
223  if (!brtup)
224  break;
225 
226  /* First time through in this statement? */
227  if (bdesc == NULL)
228  {
229  MemoryContextSwitchTo(indexInfo->ii_Context);
230  bdesc = brin_build_desc(idxRel);
231  indexInfo->ii_AmCache = (void *) bdesc;
232  MemoryContextSwitchTo(oldcxt);
233  }
234  /* First time through in this brininsert call? */
235  if (tupcxt == NULL)
236  {
238  "brininsert cxt",
240  MemoryContextSwitchTo(tupcxt);
241  }
242 
243  dtup = brin_deform_tuple(bdesc, brtup, NULL);
244 
245  /*
246  * Compare the key values of the new tuple to the stored index values;
247  * our deformed tuple will get updated if the new tuple doesn't fit
248  * the original range (note this means we can't break out of the loop
249  * early). Make a note of whether this happens, so that we know to
250  * insert the modified tuple later.
251  */
252  for (keyno = 0; keyno < bdesc->bd_tupdesc->natts; keyno++)
253  {
254  Datum result;
255  BrinValues *bval;
256  FmgrInfo *addValue;
257 
258  bval = &dtup->bt_columns[keyno];
259  addValue = index_getprocinfo(idxRel, keyno + 1,
261  result = FunctionCall4Coll(addValue,
262  idxRel->rd_indcollation[keyno],
263  PointerGetDatum(bdesc),
264  PointerGetDatum(bval),
265  values[keyno],
266  nulls[keyno]);
267  /* if that returned true, we need to insert the updated tuple */
268  need_insert |= DatumGetBool(result);
269  }
270 
271  if (!need_insert)
272  {
273  /*
274  * The tuple is consistent with the new values, so there's nothing
275  * to do.
276  */
278  }
279  else
280  {
281  Page page = BufferGetPage(buf);
282  ItemId lp = PageGetItemId(page, off);
283  Size origsz;
284  BrinTuple *origtup;
285  Size newsz;
286  BrinTuple *newtup;
287  bool samepage;
288 
289  /*
290  * Make a copy of the old tuple, so that we can compare it after
291  * re-acquiring the lock.
292  */
293  origsz = ItemIdGetLength(lp);
294  origtup = brin_copy_tuple(brtup, origsz, NULL, NULL);
295 
296  /*
297  * Before releasing the lock, check if we can attempt a same-page
298  * update. Another process could insert a tuple concurrently in
299  * the same page though, so downstream we must be prepared to cope
300  * if this turns out to not be possible after all.
301  */
302  newtup = brin_form_tuple(bdesc, heapBlk, dtup, &newsz);
303  samepage = brin_can_do_samepage_update(buf, origsz, newsz);
305 
306  /*
307  * Try to update the tuple. If this doesn't work for whatever
308  * reason, we need to restart from the top; the revmap might be
309  * pointing at a different tuple for this block now, so we need to
310  * recompute to ensure both our new heap tuple and the other
311  * inserter's are covered by the combined tuple. It might be that
312  * we don't need to update at all.
313  */
314  if (!brin_doupdate(idxRel, pagesPerRange, revmap, heapBlk,
315  buf, off, origtup, origsz, newtup, newsz,
316  samepage))
317  {
318  /* no luck; start over */
320  continue;
321  }
322  }
323 
324  /* success! */
325  break;
326  }
327 
328  brinRevmapTerminate(revmap);
329  if (BufferIsValid(buf))
331  MemoryContextSwitchTo(oldcxt);
332  if (tupcxt != NULL)
333  MemoryContextDelete(tupcxt);
334 
335  return false;
336 }
bool AutoVacuumRequestWork(AutoVacuumWorkItemType type, Oid relationId, BlockNumber blkno)
Definition: autovacuum.c:3263
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:96
MemoryContext ii_Context
Definition: execnodes.h:179
Definition: fmgr.h:56
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:212
#define AllocSetContextCreate
Definition: memutils.h:170
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:801
BrinTuple * brin_copy_tuple(BrinTuple *tuple, Size len, BrinTuple *dest, Size *destsz)
Definition: brin_tuple.c:319
void brinRevmapTerminate(BrinRevmap *revmap)
Definition: brin_revmap.c:103
BrinTuple * brinGetTupleForHeapBlock(BrinRevmap *revmap, BlockNumber heapBlk, Buffer *buf, OffsetNumber *off, Size *size, int mode, Snapshot snapshot)
Definition: brin_revmap.c:197
#define PointerGetDatum(X)
Definition: postgres.h:556
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define InvalidBuffer
Definition: buf.h:25
int errcode(int sqlerrcode)
Definition: elog.c:610
Datum FunctionCall4Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3, Datum arg4)
Definition: fmgr.c:1199
uint32 BlockNumber
Definition: block.h:31
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3518
#define LOG
Definition: elog.h:26
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
uint16 OffsetNumber
Definition: off.h:24
BrinMemTuple * brin_deform_tuple(BrinDesc *brdesc, BrinTuple *tuple, BrinMemTuple *dMemtuple)
Definition: brin_tuple.c:420
#define BRIN_PROCNUM_ADDVALUE
Definition: brin_internal.h:68
#define ItemIdGetLength(itemId)
Definition: itemid.h:59
Oid * rd_indcollation
Definition: rel.h:199
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
BrinValues bt_columns[FLEXIBLE_ARRAY_MEMBER]
Definition: brin_tuple.h:46
static char * buf
Definition: pg_test_fsync.c:67
#define FirstOffsetNumber
Definition: off.h:27
#define DatumGetBool(X)
Definition: postgres.h:393
#define RelationGetRelationName(relation)
Definition: rel.h:490
TupleDesc bd_tupdesc
Definition: brin_internal.h:50
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
bool brin_can_do_samepage_update(Buffer buffer, Size origsz, Size newsz)
Definition: brin_pageops.c:324
void * ii_AmCache
Definition: execnodes.h:178
#define PageGetItemId(page, offsetNumber)
Definition: bufpage.h:235
#define MemoryContextResetAndDeleteChildren(ctx)
Definition: memutils.h:67
uintptr_t Datum
Definition: postgres.h:367
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3757
#define ereport(elevel,...)
Definition: elog.h:144
BrinDesc * brin_build_desc(Relation rel)
Definition: brin.c:1019
size_t Size
Definition: c.h:473
BrinRevmap * brinRevmapInitialize(Relation idxrel, BlockNumber *pagesPerRange, Snapshot snapshot)
Definition: brin_revmap.c:71
#define BufferIsValid(bufnum)
Definition: bufmgr.h:123
#define ItemPointerGetOffsetNumber(pointer)
Definition: itemptr.h:117
static Datum values[MAXATTR]
Definition: bootstrap.c:165
#define BrinGetAutoSummarize(relation)
Definition: brin.h:45
int errmsg(const char *fmt,...)
Definition: elog.c:824
BrinTuple * brin_form_tuple(BrinDesc *brdesc, BlockNumber blkno, BrinMemTuple *tuple, Size *size)
Definition: brin_tuple.c:88
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:97
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
#define ItemPointerGetBlockNumber(pointer)
Definition: itemptr.h:98
int Buffer
Definition: buf.h:23
#define RelationGetRelid(relation)
Definition: rel.h:456
Pointer Page
Definition: bufpage.h:78

◆ brinoptions()

bytea* brinoptions ( Datum  reloptions,
bool  validate 
)

Definition at line 828 of file brin.c.

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

Referenced by brinhandler().

829 {
830  static const relopt_parse_elt tab[] = {
831  {"pages_per_range", RELOPT_TYPE_INT, offsetof(BrinOptions, pagesPerRange)},
832  {"autosummarize", RELOPT_TYPE_BOOL, offsetof(BrinOptions, autosummarize)}
833  };
834 
835  return (bytea *) build_reloptions(reloptions, validate,
837  sizeof(BrinOptions),
838  tab, lengthof(tab));
839 }
#define lengthof(array)
Definition: c.h:675
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:1887
Definition: c.h:562
#define offsetof(type, field)
Definition: c.h:668

◆ brinrescan()

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

Definition at line 569 of file brin.c.

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

Referenced by brinhandler().

571 {
572  /*
573  * Other index AMs preprocess the scan keys at this point, or sometime
574  * early during the scan; this lets them optimize by removing redundant
575  * keys, or doing early returns when they are impossible to satisfy; see
576  * _bt_preprocess_keys for an example. Something like that could be added
577  * here someday, too.
578  */
579 
580  if (scankey && scan->numberOfKeys > 0)
581  memmove(scan->keyData, scankey,
582  scan->numberOfKeys * sizeof(ScanKeyData));
583 }
struct ScanKeyData * keyData
Definition: relscan.h:119

◆ brinvacuumcleanup()

IndexBulkDeleteResult* brinvacuumcleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult stats 
)

Definition at line 798 of file brin.c.

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().

799 {
800  Relation heapRel;
801 
802  /* No-op in ANALYZE ONLY mode */
803  if (info->analyze_only)
804  return stats;
805 
806  if (!stats)
808  stats->num_pages = RelationGetNumberOfBlocks(info->index);
809  /* rest of stats is initialized by zeroing */
810 
811  heapRel = table_open(IndexGetRelation(RelationGetRelid(info->index), false),
813 
814  brin_vacuum_scan(info->index, info->strategy);
815 
816  brinsummarize(info->index, heapRel, BRIN_ALL_BLOCKRANGES, false,
817  &stats->num_index_tuples, &stats->num_index_tuples);
818 
819  table_close(heapRel, AccessShareLock);
820 
821  return stats;
822 }
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3401
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
bool analyze_only
Definition: genam.h:47
BufferAccessStrategy strategy
Definition: genam.h:52
#define AccessShareLock
Definition: lockdefs.h:36
Relation index
Definition: genam.h:46
BlockNumber num_pages
Definition: genam.h:74
static void brin_vacuum_scan(Relation idxrel, BufferAccessStrategy strategy)
Definition: brin.c:1463
static void brinsummarize(Relation index, Relation heapRel, BlockNumber pageRange, bool include_partial, double *numSummarized, double *numExisting)
Definition: brin.c:1304
void * palloc0(Size size)
Definition: mcxt.c:981
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:211
#define BRIN_ALL_BLOCKRANGES
Definition: brin.c:69
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39
double num_index_tuples
Definition: genam.h:77
#define RelationGetRelid(relation)
Definition: rel.h:456

◆ brinvalidate()

bool brinvalidate ( Oid  opclassoid)

Definition at line 37 of file brin_validate.c.

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().

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, 3, INTERNALOID, INTERNALOID,
101  INTERNALOID);
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 }
int n_members
Definition: catcache.h:176
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
FormData_pg_amproc * Form_pg_amproc
Definition: pg_amproc.h:68
#define BRIN_PROCNUM_OPCINFO
Definition: brin_internal.h:67
int errcode(int sqlerrcode)
Definition: elog.c:610
#define INFO
Definition: elog.h:33
char * format_type_be(Oid type_oid)
Definition: format_type.c:339
char * format_operator(Oid operator_oid)
Definition: regproc.c:851
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:651
bool check_amoptsproc_signature(Oid funcid)
Definition: amvalidate.c:192
void ReleaseCatCacheList(CatCList *list)
Definition: catcache.c:1782
CatCTup * members[FLEXIBLE_ARRAY_MEMBER]
Definition: catcache.h:178
#define BRIN_PROCNUM_ADDVALUE
Definition: brin_internal.h:68
bool check_amproc_signature(Oid funcid, Oid restype, bool exact, int minargs, int maxargs,...)
Definition: amvalidate.c:152
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
#define BRIN_MANDATORY_NPROCS
Definition: brin_internal.h:71
List * identify_opfamily_groups(CatCList *oprlist, CatCList *proclist)
Definition: amvalidate.c:43
#define BRIN_PROCNUM_OPTIONS
Definition: brin_internal.h:72
#define SearchSysCacheList1(cacheId, key1)
Definition: syscache.h:210
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1116
FormData_pg_opfamily * Form_pg_opfamily
Definition: pg_opfamily.h:51
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1164
#define ereport(elevel,...)
Definition: elog.h:144
char * format_procedure(Oid procedure_oid)
Definition: regproc.c:322
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define lfirst(lc)
Definition: pg_list.h:190
#define BRIN_PROCNUM_CONSISTENT
Definition: brin_internal.h:69
bool check_amop_signature(Oid opno, Oid restype, Oid lefttype, Oid righttype)
Definition: amvalidate.c:206
#define BRIN_FIRST_OPTIONAL_PROCNUM
Definition: brin_internal.h:74
#define BRIN_LAST_OPTIONAL_PROCNUM
Definition: brin_internal.h:75
#define BRIN_PROCNUM_UNION
Definition: brin_internal.h:70
int errmsg(const char *fmt,...)
Definition: elog.c:824
FormData_pg_amop * Form_pg_amop
Definition: pg_amop.h:88
#define elog(elevel,...)
Definition: elog.h:214
int i
#define NameStr(name)
Definition: c.h:622
HeapTupleData tuple
Definition: catcache.h:121
FormData_pg_opclass * Form_pg_opclass
Definition: pg_opclass.h:83
Definition: pg_list.h:50