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_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 73 of file brin_internal.h.

Referenced by brinvalidate().

◆ BRIN_LAST_OPTIONAL_PROCNUM

#define BRIN_LAST_OPTIONAL_PROCNUM   15

Definition at line 74 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_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

◆ BrinOpcInfo

Function Documentation

◆ brin_build_desc()

BrinDesc* brin_build_desc ( Relation  rel)

Definition at line 1010 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(), tupleDesc::natts, offsetof, BrinOpcInfo::oi_nstored, palloc(), pfree(), RelationGetDescr, totalsize, and TupleDescAttr.

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

1011 {
1012  BrinOpcInfo **opcinfo;
1013  BrinDesc *bdesc;
1014  TupleDesc tupdesc;
1015  int totalstored = 0;
1016  int keyno;
1017  long totalsize;
1018  MemoryContext cxt;
1019  MemoryContext oldcxt;
1020 
1022  "brin desc cxt",
1024  oldcxt = MemoryContextSwitchTo(cxt);
1025  tupdesc = RelationGetDescr(rel);
1026 
1027  /*
1028  * Obtain BrinOpcInfo for each indexed column. While at it, accumulate
1029  * the number of columns stored, since the number is opclass-defined.
1030  */
1031  opcinfo = (BrinOpcInfo **) palloc(sizeof(BrinOpcInfo *) * tupdesc->natts);
1032  for (keyno = 0; keyno < tupdesc->natts; keyno++)
1033  {
1034  FmgrInfo *opcInfoFn;
1035  Form_pg_attribute attr = TupleDescAttr(tupdesc, keyno);
1036 
1037  opcInfoFn = index_getprocinfo(rel, keyno + 1, BRIN_PROCNUM_OPCINFO);
1038 
1039  opcinfo[keyno] = (BrinOpcInfo *)
1040  DatumGetPointer(FunctionCall1(opcInfoFn, attr->atttypid));
1041  totalstored += opcinfo[keyno]->oi_nstored;
1042  }
1043 
1044  /* Allocate our result struct and fill it in */
1045  totalsize = offsetof(BrinDesc, bd_info) +
1046  sizeof(BrinOpcInfo *) * tupdesc->natts;
1047 
1048  bdesc = palloc(totalsize);
1049  bdesc->bd_context = cxt;
1050  bdesc->bd_index = rel;
1051  bdesc->bd_tupdesc = tupdesc;
1052  bdesc->bd_disktdesc = NULL; /* generated lazily */
1053  bdesc->bd_totalstored = totalstored;
1054 
1055  for (keyno = 0; keyno < tupdesc->natts; keyno++)
1056  bdesc->bd_info[keyno] = opcinfo[keyno];
1057  pfree(opcinfo);
1058 
1059  MemoryContextSwitchTo(oldcxt);
1060 
1061  return bdesc;
1062 }
Definition: fmgr.h:56
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:855
#define RelationGetDescr(relation)
Definition: rel.h:433
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:93
#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
int natts
Definition: tupdesc.h:82
void pfree(void *pointer)
Definition: mcxt.c:1031
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:197
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
static uint64 totalsize
#define AllocSetContextCreate(parent, name, allocparams)
Definition: memutils.h:170
BrinOpcInfo * bd_info[FLEXIBLE_ARRAY_MEMBER]
Definition: brin_internal.h:59
#define DatumGetPointer(X)
Definition: postgres.h:532
MemoryContext bd_context
Definition: brin_internal.h:44
void * palloc(Size size)
Definition: mcxt.c:924
TupleDesc bd_disktdesc
Definition: brin_internal.h:53
#define FunctionCall1(flinfo, arg1)
Definition: fmgr.h:608
#define offsetof(type, field)
Definition: c.h:622

◆ brin_free_desc()

void brin_free_desc ( BrinDesc bdesc)

Definition at line 1065 of file brin.c.

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

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

1066 {
1067  /* make sure the tupdesc is still valid */
1068  Assert(bdesc->bd_tupdesc->tdrefcount >= 1);
1069  /* no need for retail pfree */
1071 }
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
TupleDesc bd_tupdesc
Definition: brin_internal.h:50
#define Assert(condition)
Definition: c.h:699
MemoryContext bd_context
Definition: brin_internal.h:44
int tdrefcount
Definition: tupdesc.h:86

◆ brinbeginscan()

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

Definition at line 335 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().

336 {
337  IndexScanDesc scan;
338  BrinOpaque *opaque;
339 
340  scan = RelationGetIndexScan(r, nkeys, norderbys);
341 
342  opaque = (BrinOpaque *) palloc(sizeof(BrinOpaque));
343  opaque->bo_rmAccess = brinRevmapInitialize(r, &opaque->bo_pagesPerRange,
344  scan->xs_snapshot);
345  opaque->bo_bdesc = brin_build_desc(r);
346  scan->opaque = opaque;
347 
348  return scan;
349 }
Snapshot xs_snapshot
Definition: relscan.h:92
BlockNumber bo_pagesPerRange
Definition: brin.c:59
BrinRevmap * bo_rmAccess
Definition: brin.c:60
BrinDesc * bo_bdesc
Definition: brin.c:61
BrinDesc * brin_build_desc(Relation rel)
Definition: brin.c:1010
BrinRevmap * brinRevmapInitialize(Relation idxrel, BlockNumber *pagesPerRange, Snapshot snapshot)
Definition: brin_revmap.c:71
void * palloc(Size size)
Definition: mcxt.c:924
IndexScanDesc RelationGetIndexScan(Relation indexRelation, int nkeys, int norderbys)
Definition: genam.c:78

◆ brinbuild()

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

Definition at line 658 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, IndexBuildHeapScan(), initialize_brin_buildstate(), LockBuffer(), MarkBufferDirty(), P_NEW, PageSetLSN, xl_brin_createidx::pagesPerRange, palloc(), ReadBuffer(), REGBUF_STANDARD, REGBUF_WILL_INIT, RelationGetNumberOfBlocks, RelationGetRelationName, RelationNeedsWAL, reltuples, SizeOfBrinCreateIdx, terminate_brin_buildstate(), UnlockReleaseBuffer(), xl_brin_createidx::version, XLOG_BRIN_CREATE_INDEX, XLogBeginInsert(), XLogInsert(), XLogRegisterBuffer(), and XLogRegisterData().

Referenced by brinhandler().

659 {
660  IndexBuildResult *result;
661  double reltuples;
662  double idxtuples;
663  BrinRevmap *revmap;
665  Buffer meta;
666  BlockNumber pagesPerRange;
667 
668  /*
669  * We expect to be called exactly once for any index relation.
670  */
671  if (RelationGetNumberOfBlocks(index) != 0)
672  elog(ERROR, "index \"%s\" already contains data",
673  RelationGetRelationName(index));
674 
675  /*
676  * Critical section not required, because on error the creation of the
677  * whole relation will be rolled back.
678  */
679 
680  meta = ReadBuffer(index, P_NEW);
683 
686  MarkBufferDirty(meta);
687 
688  if (RelationNeedsWAL(index))
689  {
690  xl_brin_createidx xlrec;
691  XLogRecPtr recptr;
692  Page page;
693 
695  xlrec.pagesPerRange = BrinGetPagesPerRange(index);
696 
697  XLogBeginInsert();
698  XLogRegisterData((char *) &xlrec, SizeOfBrinCreateIdx);
700 
701  recptr = XLogInsert(RM_BRIN_ID, XLOG_BRIN_CREATE_INDEX);
702 
703  page = BufferGetPage(meta);
704  PageSetLSN(page, recptr);
705  }
706 
707  UnlockReleaseBuffer(meta);
708 
709  /*
710  * Initialize our state, including the deformed tuple state.
711  */
712  revmap = brinRevmapInitialize(index, &pagesPerRange, NULL);
713  state = initialize_brin_buildstate(index, revmap, pagesPerRange);
714 
715  /*
716  * Now scan the relation. No syncscan allowed here because we want the
717  * heap blocks in physical order.
718  */
719  reltuples = IndexBuildHeapScan(heap, index, indexInfo, false,
720  brinbuildCallback, (void *) state, NULL);
721 
722  /* process the final batch */
723  form_and_insert_tuple(state);
724 
725  /* release resources */
726  idxtuples = state->bs_numtuples;
729 
730  /*
731  * Return statistics
732  */
733  result = (IndexBuildResult *) palloc(sizeof(IndexBuildResult));
734 
735  result->heap_tuples = reltuples;
736  result->index_tuples = idxtuples;
737 
738  return result;
739 }
#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:1450
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:213
#define XLOG_BRIN_CREATE_INDEX
Definition: brin_xlog.h:31
#define REGBUF_WILL_INIT
Definition: xloginsert.h:32
static void brinbuildCallback(Relation index, HeapTuple htup, Datum *values, bool *isnull, bool tupleIsAlive, void *brstate)
Definition: brin.c:595
uint32 BlockNumber
Definition: block.h:31
static void form_and_insert_tuple(BrinBuildState *state)
Definition: brin.c:1391
#define P_NEW
Definition: bufmgr.h:82
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:89
#define BrinGetPagesPerRange(relation)
Definition: brin.h:40
void brin_metapage_init(Page page, BlockNumber pagesPerRange, uint16 version)
Definition: brin_pageops.c:488
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3332
#define ERROR
Definition: elog.h:43
double IndexBuildHeapScan(Relation heapRelation, Relation indexRelation, IndexInfo *indexInfo, bool allow_sync, IndexBuildCallback callback, void *callback_state, HeapScanDesc scan)
Definition: index.c:2418
#define REGBUF_STANDARD
Definition: xloginsert.h:34
BrinRevmap * bs_rmAccess
Definition: brin.c:49
#define RelationGetRelationName(relation)
Definition: rel.h:441
#define BufferGetPage(buffer)
Definition: bufmgr.h:160
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:323
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:415
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3546
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:199
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:699
Definition: regguts.h:298
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:594
BrinRevmap * brinRevmapInitialize(Relation idxrel, BlockNumber *pagesPerRange, Snapshot snapshot)
Definition: brin_revmap.c:71
#define RelationNeedsWAL(relation)
Definition: rel.h:510
int bs_numtuples
Definition: brin.c:45
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2605
void * palloc(Size size)
Definition: mcxt.c:924
BlockNumber pagesPerRange
Definition: brin_xlog.h:52
static BrinBuildState * initialize_brin_buildstate(Relation idxRel, BrinRevmap *revmap, BlockNumber pagesPerRange)
Definition: brin.c:1098
#define elog
Definition: elog.h:219
void XLogBeginInsert(void)
Definition: xloginsert.c:120
#define PageSetLSN(page, lsn)
Definition: bufpage.h:364
int Buffer
Definition: buf.h:23
float4 reltuples
Definition: pg_class.h:44
Pointer Page
Definition: bufpage.h:74
double index_tuples
Definition: genam.h:33
double heap_tuples
Definition: genam.h:32
static void terminate_brin_buildstate(BrinBuildState *state)
Definition: brin.c:1123

◆ brinbuildempty()

void brinbuildempty ( Relation  index)

Definition at line 742 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().

743 {
744  Buffer metabuf;
745 
746  /* An empty BRIN index has a metapage only. */
747  metabuf =
750 
751  /* Initialize and xlog metabuffer. */
755  MarkBufferDirty(metabuf);
756  log_newpage_buffer(metabuf, true);
758 
759  UnlockReleaseBuffer(metabuf);
760 }
#define BRIN_CURRENT_VERSION
Definition: brin_page.h:72
XLogRecPtr log_newpage_buffer(Buffer buffer, bool page_std)
Definition: xloginsert.c:1009
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1450
Buffer ReadBufferExtended(Relation reln, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy)
Definition: bufmgr.c:640
#define END_CRIT_SECTION()
Definition: miscadmin.h:133
#define START_CRIT_SECTION()
Definition: miscadmin.h:131
#define P_NEW
Definition: bufmgr.h:82
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:89
#define BrinGetPagesPerRange(relation)
Definition: brin.h:40
void brin_metapage_init(Page page, BlockNumber pagesPerRange, uint16 version)
Definition: brin_pageops.c:488
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3332
#define BufferGetPage(buffer)
Definition: bufmgr.h:160
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3546
int Buffer
Definition: buf.h:23

◆ brinbulkdelete()

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

Definition at line 772 of file brin.c.

References palloc0().

Referenced by brinhandler().

774 {
775  /* allocate stats if first time through, else re-use existing struct */
776  if (stats == NULL)
778 
779  return stats;
780 }
void * palloc0(Size size)
Definition: mcxt.c:955

◆ brinendscan()

void brinendscan ( IndexScanDesc  scan)

Definition at line 578 of file brin.c.

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

Referenced by brinhandler().

579 {
580  BrinOpaque *opaque = (BrinOpaque *) scan->opaque;
581 
583  brin_free_desc(opaque->bo_bdesc);
584  pfree(opaque);
585 }
void brin_free_desc(BrinDesc *bdesc)
Definition: brin.c:1065
void brinRevmapTerminate(BrinRevmap *revmap)
Definition: brin_revmap.c:103
void pfree(void *pointer)
Definition: mcxt.c:1031
BrinRevmap * bo_rmAccess
Definition: brin.c:60
BrinDesc * bo_bdesc
Definition: brin.c:61

◆ bringetbitmap()

int64 bringetbitmap ( IndexScanDesc  scan,
TIDBitmap tbm 
)

Definition at line 364 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(), heap_close, heap_open(), index_getprocinfo(), IndexGetRelation(), IndexScanDescData::indexRelation, InvalidBuffer, InvalidOid, IndexScanDescData::keyData, LockBuffer(), MemoryContextDelete(), MemoryContextResetAndDeleteChildren, MemoryContextSwitchTo(), tupleDesc::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, tbm_add_page(), TupleDescAttr, and IndexScanDescData::xs_snapshot.

Referenced by brinhandler().

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

Referenced by brinhandler().

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

◆ brinoptions()

bytea* brinoptions ( Datum  reloptions,
bool  validate 
)

Definition at line 817 of file brin.c.

References allocateReloptStruct(), fillRelOptions(), lengthof, offsetof, options, parseRelOptions(), pfree(), RELOPT_KIND_BRIN, RELOPT_TYPE_BOOL, and RELOPT_TYPE_INT.

Referenced by brinhandler().

818 {
820  BrinOptions *rdopts;
821  int numoptions;
822  static const relopt_parse_elt tab[] = {
823  {"pages_per_range", RELOPT_TYPE_INT, offsetof(BrinOptions, pagesPerRange)},
824  {"autosummarize", RELOPT_TYPE_BOOL, offsetof(BrinOptions, autosummarize)}
825  };
826 
827  options = parseRelOptions(reloptions, validate, RELOPT_KIND_BRIN,
828  &numoptions);
829 
830  /* if none set, we're done */
831  if (numoptions == 0)
832  return NULL;
833 
834  rdopts = allocateReloptStruct(sizeof(BrinOptions), options, numoptions);
835 
836  fillRelOptions((void *) rdopts, sizeof(BrinOptions), options, numoptions,
837  validate, tab, lengthof(tab));
838 
839  pfree(options);
840 
841  return (bytea *) rdopts;
842 }
#define lengthof(array)
Definition: c.h:629
void pfree(void *pointer)
Definition: mcxt.c:1031
void * allocateReloptStruct(Size base, relopt_value *options, int numoptions)
Definition: reloptions.c:1242
static char ** options
void fillRelOptions(void *rdopts, Size basesize, relopt_value *options, int numoptions, bool validate, const relopt_parse_elt *elems, int numelems)
Definition: reloptions.c:1266
Definition: c.h:516
relopt_value * parseRelOptions(Datum options, bool validate, relopt_kind kind, int *numrelopts)
Definition: reloptions.c:1048
#define offsetof(type, field)
Definition: c.h:622

◆ brinrescan()

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

Definition at line 558 of file brin.c.

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

Referenced by brinhandler().

560 {
561  /*
562  * Other index AMs preprocess the scan keys at this point, or sometime
563  * early during the scan; this lets them optimize by removing redundant
564  * keys, or doing early returns when they are impossible to satisfy; see
565  * _bt_preprocess_keys for an example. Something like that could be added
566  * here someday, too.
567  */
568 
569  if (scankey && scan->numberOfKeys > 0)
570  memmove(scan->keyData, scankey,
571  scan->numberOfKeys * sizeof(ScanKeyData));
572 }
#define memmove(d, s, c)
Definition: c.h:1100
ScanKey keyData
Definition: relscan.h:95

◆ brinvacuumcleanup()

IndexBulkDeleteResult* brinvacuumcleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult stats 
)

Definition at line 787 of file brin.c.

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

Referenced by brinhandler().

788 {
789  Relation heapRel;
790 
791  /* No-op in ANALYZE ONLY mode */
792  if (info->analyze_only)
793  return stats;
794 
795  if (!stats)
797  stats->num_pages = RelationGetNumberOfBlocks(info->index);
798  /* rest of stats is initialized by zeroing */
799 
800  heapRel = heap_open(IndexGetRelation(RelationGetRelid(info->index), false),
802 
803  brin_vacuum_scan(info->index, info->strategy);
804 
805  brinsummarize(info->index, heapRel, BRIN_ALL_BLOCKRANGES, false,
806  &stats->num_index_tuples, &stats->num_index_tuples);
807 
808  heap_close(heapRel, AccessShareLock);
809 
810  return stats;
811 }
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3591
bool analyze_only
Definition: genam.h:47
BufferAccessStrategy strategy
Definition: genam.h:51
#define AccessShareLock
Definition: lockdefs.h:36
Relation index
Definition: genam.h:46
#define heap_close(r, l)
Definition: heapam.h:97
BlockNumber num_pages
Definition: genam.h:73
static void brin_vacuum_scan(Relation idxrel, BufferAccessStrategy strategy)
Definition: brin.c:1453
static void brinsummarize(Relation index, Relation heapRel, BlockNumber pageRange, bool include_partial, double *numSummarized, double *numExisting)
Definition: brin.c:1294
void * palloc0(Size size)
Definition: mcxt.c:955
Relation heap_open(Oid relationId, LOCKMODE lockmode)
Definition: heapam.c:1294
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:199
#define BRIN_ALL_BLOCKRANGES
Definition: brin.c:64
double num_index_tuples
Definition: genam.h:76
#define RelationGetRelid(relation)
Definition: rel.h:407

◆ brinvalidate()

bool brinvalidate ( Oid  opclassoid)

Definition at line 38 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_UNION, check_amop_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().

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