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

Go to the source code of this file.

Data Structures

struct  BrinOpcInfo
 
struct  BrinDesc
 

Macros

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

Typedefs

typedef struct BrinOpcInfo BrinOpcInfo
 
typedef struct BrinDesc BrinDesc
 

Functions

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

Macro Definition Documentation

◆ BRIN_elog

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

Definition at line 85 of file brin_internal.h.

◆ BRIN_FIRST_OPTIONAL_PROCNUM

#define BRIN_FIRST_OPTIONAL_PROCNUM   11

Definition at line 77 of file brin_internal.h.

◆ BRIN_LAST_OPTIONAL_PROCNUM

#define BRIN_LAST_OPTIONAL_PROCNUM   15

Definition at line 78 of file brin_internal.h.

◆ BRIN_MANDATORY_NPROCS

#define BRIN_MANDATORY_NPROCS   4

Definition at line 74 of file brin_internal.h.

◆ BRIN_PROCNUM_ADDVALUE

#define BRIN_PROCNUM_ADDVALUE   2

Definition at line 71 of file brin_internal.h.

◆ BRIN_PROCNUM_CONSISTENT

#define BRIN_PROCNUM_CONSISTENT   3

Definition at line 72 of file brin_internal.h.

◆ BRIN_PROCNUM_OPCINFO

#define BRIN_PROCNUM_OPCINFO   1

Definition at line 70 of file brin_internal.h.

◆ BRIN_PROCNUM_OPTIONS

#define BRIN_PROCNUM_OPTIONS   5 /* optional */

Definition at line 75 of file brin_internal.h.

◆ BRIN_PROCNUM_UNION

#define BRIN_PROCNUM_UNION   4

Definition at line 73 of file brin_internal.h.

◆ SizeofBrinOpcInfo

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

Definition at line 41 of file brin_internal.h.

Typedef Documentation

◆ BrinDesc

typedef struct BrinDesc BrinDesc

◆ BrinOpcInfo

typedef struct BrinOpcInfo BrinOpcInfo

Function Documentation

◆ brin_build_desc()

BrinDesc* brin_build_desc ( Relation  rel)

Definition at line 1566 of file brin.c.

1567 {
1568  BrinOpcInfo **opcinfo;
1569  BrinDesc *bdesc;
1570  TupleDesc tupdesc;
1571  int totalstored = 0;
1572  int keyno;
1573  long totalsize;
1574  MemoryContext cxt;
1575  MemoryContext oldcxt;
1576 
1578  "brin desc cxt",
1580  oldcxt = MemoryContextSwitchTo(cxt);
1581  tupdesc = RelationGetDescr(rel);
1582 
1583  /*
1584  * Obtain BrinOpcInfo for each indexed column. While at it, accumulate
1585  * the number of columns stored, since the number is opclass-defined.
1586  */
1587  opcinfo = palloc_array(BrinOpcInfo *, tupdesc->natts);
1588  for (keyno = 0; keyno < tupdesc->natts; keyno++)
1589  {
1590  FmgrInfo *opcInfoFn;
1591  Form_pg_attribute attr = TupleDescAttr(tupdesc, keyno);
1592 
1593  opcInfoFn = index_getprocinfo(rel, keyno + 1, BRIN_PROCNUM_OPCINFO);
1594 
1595  opcinfo[keyno] = (BrinOpcInfo *)
1596  DatumGetPointer(FunctionCall1(opcInfoFn, attr->atttypid));
1597  totalstored += opcinfo[keyno]->oi_nstored;
1598  }
1599 
1600  /* Allocate our result struct and fill it in */
1601  totalsize = offsetof(BrinDesc, bd_info) +
1602  sizeof(BrinOpcInfo *) * tupdesc->natts;
1603 
1604  bdesc = palloc(totalsize);
1605  bdesc->bd_context = cxt;
1606  bdesc->bd_index = rel;
1607  bdesc->bd_tupdesc = tupdesc;
1608  bdesc->bd_disktdesc = NULL; /* generated lazily */
1609  bdesc->bd_totalstored = totalstored;
1610 
1611  for (keyno = 0; keyno < tupdesc->natts; keyno++)
1612  bdesc->bd_info[keyno] = opcinfo[keyno];
1613  pfree(opcinfo);
1614 
1615  MemoryContextSwitchTo(oldcxt);
1616 
1617  return bdesc;
1618 }
#define BRIN_PROCNUM_OPCINFO
Definition: brin_internal.h:70
#define palloc_array(type, count)
Definition: fe_memutils.h:64
#define FunctionCall1(flinfo, arg1)
Definition: fmgr.h:660
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:863
void pfree(void *pointer)
Definition: mcxt.c:1401
MemoryContext CurrentMemoryContext
Definition: mcxt.c:131
void * palloc(Size size)
Definition: mcxt.c:1197
#define AllocSetContextCreate
Definition: memutils.h:128
#define ALLOCSET_SMALL_SIZES
Definition: memutils.h:162
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:124
FormData_pg_attribute * Form_pg_attribute
Definition: pg_attribute.h:209
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:312
#define RelationGetDescr(relation)
Definition: rel.h:530
int bd_totalstored
Definition: brin_internal.h:59
TupleDesc bd_tupdesc
Definition: brin_internal.h:53
BrinOpcInfo * bd_info[FLEXIBLE_ARRAY_MEMBER]
Definition: brin_internal.h:62
Relation bd_index
Definition: brin_internal.h:50
MemoryContext bd_context
Definition: brin_internal.h:47
TupleDesc bd_disktdesc
Definition: brin_internal.h:56
uint16 oi_nstored
Definition: brin_internal.h:28
Definition: fmgr.h:57
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92

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

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

◆ brin_free_desc()

void brin_free_desc ( BrinDesc bdesc)

Definition at line 1621 of file brin.c.

1622 {
1623  /* make sure the tupdesc is still valid */
1624  Assert(bdesc->bd_tupdesc->tdrefcount >= 1);
1625  /* no need for retail pfree */
1627 }
Assert(fmt[strlen(fmt) - 1] !='\n')
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:399
int tdrefcount
Definition: tupdesc.h:84

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

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

◆ brinbeginscan()

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

Definition at line 524 of file brin.c.

525 {
526  IndexScanDesc scan;
527  BrinOpaque *opaque;
528 
529  scan = RelationGetIndexScan(r, nkeys, norderbys);
530 
531  opaque = palloc_object(BrinOpaque);
532  opaque->bo_rmAccess = brinRevmapInitialize(r, &opaque->bo_pagesPerRange);
533  opaque->bo_bdesc = brin_build_desc(r);
534  scan->opaque = opaque;
535 
536  return scan;
537 }
BrinDesc * brin_build_desc(Relation rel)
Definition: brin.c:1566
BrinRevmap * brinRevmapInitialize(Relation idxrel, BlockNumber *pagesPerRange)
Definition: brin_revmap.c:70
#define palloc_object(type)
Definition: fe_memutils.h:62
IndexScanDesc RelationGetIndexScan(Relation indexRelation, int nkeys, int norderbys)
Definition: genam.c:78
BlockNumber bo_pagesPerRange
Definition: brin.c:201
BrinDesc * bo_bdesc
Definition: brin.c:203
BrinRevmap * bo_rmAccess
Definition: brin.c:202

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

Referenced by brinhandler().

◆ brinbuild()

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

Definition at line 1089 of file brin.c.

1090 {
1091  IndexBuildResult *result;
1092  double reltuples;
1093  double idxtuples;
1094  BrinRevmap *revmap;
1096  Buffer meta;
1097  BlockNumber pagesPerRange;
1098 
1099  /*
1100  * We expect to be called exactly once for any index relation.
1101  */
1102  if (RelationGetNumberOfBlocks(index) != 0)
1103  elog(ERROR, "index \"%s\" already contains data",
1105 
1106  /*
1107  * Critical section not required, because on error the creation of the
1108  * whole relation will be rolled back.
1109  */
1110 
1114 
1117  MarkBufferDirty(meta);
1118 
1119  if (RelationNeedsWAL(index))
1120  {
1121  xl_brin_createidx xlrec;
1122  XLogRecPtr recptr;
1123  Page page;
1124 
1125  xlrec.version = BRIN_CURRENT_VERSION;
1127 
1128  XLogBeginInsert();
1129  XLogRegisterData((char *) &xlrec, SizeOfBrinCreateIdx);
1131 
1132  recptr = XLogInsert(RM_BRIN_ID, XLOG_BRIN_CREATE_INDEX);
1133 
1134  page = BufferGetPage(meta);
1135  PageSetLSN(page, recptr);
1136  }
1137 
1138  UnlockReleaseBuffer(meta);
1139 
1140  /*
1141  * Initialize our state, including the deformed tuple state.
1142  */
1143  revmap = brinRevmapInitialize(index, &pagesPerRange);
1144  state = initialize_brin_buildstate(index, revmap, pagesPerRange,
1146 
1147  /*
1148  * Attempt to launch parallel worker scan when required
1149  *
1150  * XXX plan_create_index_workers makes the number of workers dependent on
1151  * maintenance_work_mem, requiring 32MB for each worker. That makes sense
1152  * for btree, but not for BRIN, which can do away with much less memory.
1153  * So maybe make that somehow less strict, optionally?
1154  */
1155  if (indexInfo->ii_ParallelWorkers > 0)
1156  _brin_begin_parallel(state, heap, index, indexInfo->ii_Concurrent,
1157  indexInfo->ii_ParallelWorkers);
1158 
1159  /*
1160  * If parallel build requested and at least one worker process was
1161  * successfully launched, set up coordination state, wait for workers to
1162  * complete. Then read all tuples from the shared tuplesort and insert
1163  * them into the index.
1164  *
1165  * In serial mode, simply scan the table and build the index one index
1166  * tuple at a time.
1167  */
1168  if (state->bs_leader)
1169  {
1170  SortCoordinate coordinate;
1171 
1172  coordinate = (SortCoordinate) palloc0(sizeof(SortCoordinateData));
1173  coordinate->isWorker = false;
1174  coordinate->nParticipants =
1175  state->bs_leader->nparticipanttuplesorts;
1176  coordinate->sharedsort = state->bs_leader->sharedsort;
1177 
1178  /*
1179  * Begin leader tuplesort.
1180  *
1181  * In cases where parallelism is involved, the leader receives the
1182  * same share of maintenance_work_mem as a serial sort (it is
1183  * generally treated in the same way as a serial sort once we return).
1184  * Parallel worker Tuplesortstates will have received only a fraction
1185  * of maintenance_work_mem, though.
1186  *
1187  * We rely on the lifetime of the Leader Tuplesortstate almost not
1188  * overlapping with any worker Tuplesortstate's lifetime. There may
1189  * be some small overlap, but that's okay because we rely on leader
1190  * Tuplesortstate only allocating a small, fixed amount of memory
1191  * here. When its tuplesort_performsort() is called (by our caller),
1192  * and significant amounts of memory are likely to be used, all
1193  * workers must have already freed almost all memory held by their
1194  * Tuplesortstates (they are about to go away completely, too). The
1195  * overall effect is that maintenance_work_mem always represents an
1196  * absolute high watermark on the amount of memory used by a CREATE
1197  * INDEX operation, regardless of the use of parallelism or any other
1198  * factor.
1199  */
1200  state->bs_sortstate =
1202  TUPLESORT_NONE);
1203 
1204  _brin_end_parallel(state->bs_leader, state);
1205  }
1206  else /* no parallel index build */
1207  {
1208  /*
1209  * Now scan the relation. No syncscan allowed here because we want
1210  * the heap blocks in physical order (we want to produce the ranges
1211  * starting from block 0, and the callback also relies on this to not
1212  * generate summary for the same range twice).
1213  */
1214  reltuples = table_index_build_scan(heap, index, indexInfo, false, true,
1215  brinbuildCallback, (void *) state, NULL);
1216 
1217  /*
1218  * process the final batch
1219  *
1220  * XXX Note this does not update state->bs_currRangeStart, i.e. it
1221  * stays set to the last range added to the index. This is OK, because
1222  * that's what brin_fill_empty_ranges expects.
1223  */
1225 
1226  /*
1227  * Backfill the final ranges with empty data.
1228  *
1229  * This saves us from doing what amounts to full table scans when the
1230  * index with a predicate like WHERE (nonnull_column IS NULL), or
1231  * other very selective predicates.
1232  */
1234  state->bs_currRangeStart,
1235  state->bs_maxRangeStart);
1236 
1237  /* track the number of relation tuples */
1238  state->bs_reltuples = reltuples;
1239  }
1240 
1241  /* release resources */
1242  idxtuples = state->bs_numtuples;
1243  reltuples = state->bs_reltuples;
1244  brinRevmapTerminate(state->bs_rmAccess);
1246 
1247  /*
1248  * Return statistics
1249  */
1250  result = palloc_object(IndexBuildResult);
1251 
1252  result->heap_tuples = reltuples;
1253  result->index_tuples = idxtuples;
1254 
1255  return result;
1256 }
uint32 BlockNumber
Definition: block.h:31
static void terminate_brin_buildstate(BrinBuildState *state)
Definition: brin.c:1701
static void form_and_insert_tuple(BrinBuildState *state)
Definition: brin.c:1970
static BrinBuildState * initialize_brin_buildstate(Relation idxRel, BrinRevmap *revmap, BlockNumber pagesPerRange, BlockNumber tablePages)
Definition: brin.c:1654
static void _brin_begin_parallel(BrinBuildState *buildstate, Relation heap, Relation index, bool isconcurrent, int request)
Definition: brin.c:2332
static void _brin_end_parallel(BrinLeader *brinleader, BrinBuildState *state)
Definition: brin.c:2516
static void brin_fill_empty_ranges(BrinBuildState *state, BlockNumber prevRange, BlockNumber maxRange)
Definition: brin.c:2911
static void brinbuildCallback(Relation index, ItemPointer tid, Datum *values, bool *isnull, bool tupleIsAlive, void *brstate)
Definition: brin.c:979
#define BrinGetPagesPerRange(relation)
Definition: brin.h:40
#define BRIN_CURRENT_VERSION
Definition: brin_page.h:72
#define BRIN_METAPAGE_BLKNO
Definition: brin_page.h:75
void brin_metapage_init(Page page, BlockNumber pagesPerRange, uint16 version)
Definition: brin_pageops.c:486
void brinRevmapTerminate(BrinRevmap *revmap)
Definition: brin_revmap.c:100
#define SizeOfBrinCreateIdx
Definition: brin_xlog.h:55
#define XLOG_BRIN_CREATE_INDEX
Definition: brin_xlog.h:31
int Buffer
Definition: buf.h:23
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:3377
Buffer ExtendBufferedRel(BufferManagerRelation bmr, ForkNumber forkNum, BufferAccessStrategy strategy, uint32 flags)
Definition: bufmgr.c:838
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:4577
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:2189
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:229
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:350
@ EB_SKIP_EXTENSION_LOCK
Definition: bufmgr.h:73
@ EB_LOCK_FIRST
Definition: bufmgr.h:85
#define BMR_REL(p_rel)
Definition: bufmgr.h:106
Pointer Page
Definition: bufpage.h:78
static void PageSetLSN(Page page, XLogRecPtr lsn)
Definition: bufpage.h:388
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:224
int maintenance_work_mem
Definition: globals.c:129
void * palloc0(Size size)
Definition: mcxt.c:1227
#define RelationGetRelationName(relation)
Definition: rel.h:538
#define RelationNeedsWAL(relation)
Definition: rel.h:627
@ MAIN_FORKNUM
Definition: relpath.h:50
double heap_tuples
Definition: genam.h:32
double index_tuples
Definition: genam.h:33
int ii_ParallelWorkers
Definition: execnodes.h:205
bool ii_Concurrent
Definition: execnodes.h:202
Sharedsort * sharedsort
Definition: tuplesort.h:58
Definition: type.h:95
Definition: regguts.h:323
BlockNumber pagesPerRange
Definition: brin_xlog.h:52
static double table_index_build_scan(Relation table_rel, Relation index_rel, struct IndexInfo *index_info, bool allow_sync, bool progress, IndexBuildCallback callback, void *callback_state, TableScanDesc scan)
Definition: tableam.h:1772
struct SortCoordinateData * SortCoordinate
Definition: tuplesort.h:61
#define TUPLESORT_NONE
Definition: tuplesort.h:93
Tuplesortstate * tuplesort_begin_index_brin(int workMem, SortCoordinate coordinate, int sortopt)
uint64 XLogRecPtr
Definition: xlogdefs.h:21
void XLogRegisterData(char *data, uint32 len)
Definition: xloginsert.c:364
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:474
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:242
void XLogBeginInsert(void)
Definition: xloginsert.c:149
#define REGBUF_STANDARD
Definition: xloginsert.h:34
#define REGBUF_WILL_INIT
Definition: xloginsert.h:33

References _brin_begin_parallel(), _brin_end_parallel(), Assert(), BMR_REL, BRIN_CURRENT_VERSION, brin_fill_empty_ranges(), BRIN_METAPAGE_BLKNO, brin_metapage_init(), brinbuildCallback(), BrinGetPagesPerRange, brinRevmapInitialize(), brinRevmapTerminate(), BufferGetBlockNumber(), BufferGetPage(), EB_LOCK_FIRST, EB_SKIP_EXTENSION_LOCK, elog, ERROR, ExtendBufferedRel(), form_and_insert_tuple(), IndexBuildResult::heap_tuples, IndexInfo::ii_Concurrent, IndexInfo::ii_ParallelWorkers, IndexBuildResult::index_tuples, initialize_brin_buildstate(), SortCoordinateData::isWorker, MAIN_FORKNUM, maintenance_work_mem, MarkBufferDirty(), SortCoordinateData::nParticipants, PageSetLSN(), xl_brin_createidx::pagesPerRange, palloc0(), palloc_object, REGBUF_STANDARD, REGBUF_WILL_INIT, RelationGetNumberOfBlocks, RelationGetRelationName, RelationNeedsWAL, SortCoordinateData::sharedsort, SizeOfBrinCreateIdx, table_index_build_scan(), terminate_brin_buildstate(), tuplesort_begin_index_brin(), TUPLESORT_NONE, UnlockReleaseBuffer(), xl_brin_createidx::version, XLOG_BRIN_CREATE_INDEX, XLogBeginInsert(), XLogInsert(), XLogRegisterBuffer(), and XLogRegisterData().

Referenced by brinhandler().

◆ brinbuildempty()

void brinbuildempty ( Relation  index)

Definition at line 1259 of file brin.c.

1260 {
1261  Buffer metabuf;
1262 
1263  /* An empty BRIN index has a metapage only. */
1264  metabuf = ExtendBufferedRel(BMR_REL(index), INIT_FORKNUM, NULL,
1266 
1267  /* Initialize and xlog metabuffer. */
1271  MarkBufferDirty(metabuf);
1272  log_newpage_buffer(metabuf, true);
1273  END_CRIT_SECTION();
1274 
1275  UnlockReleaseBuffer(metabuf);
1276 }
#define START_CRIT_SECTION()
Definition: miscadmin.h:149
#define END_CRIT_SECTION()
Definition: miscadmin.h:151
@ INIT_FORKNUM
Definition: relpath.h:53
XLogRecPtr log_newpage_buffer(Buffer buffer, bool page_std)
Definition: xloginsert.c:1237

References BMR_REL, BRIN_CURRENT_VERSION, brin_metapage_init(), BrinGetPagesPerRange, BufferGetPage(), EB_LOCK_FIRST, EB_SKIP_EXTENSION_LOCK, END_CRIT_SECTION, ExtendBufferedRel(), INIT_FORKNUM, log_newpage_buffer(), MarkBufferDirty(), START_CRIT_SECTION, and UnlockReleaseBuffer().

Referenced by brinhandler().

◆ brinbulkdelete()

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

Definition at line 1288 of file brin.c.

1290 {
1291  /* allocate stats if first time through, else re-use existing struct */
1292  if (stats == NULL)
1294 
1295  return stats;
1296 }
#define palloc0_object(type)
Definition: fe_memutils.h:63

References palloc0_object.

Referenced by brinhandler().

◆ brinendscan()

void brinendscan ( IndexScanDesc  scan)

Definition at line 962 of file brin.c.

963 {
964  BrinOpaque *opaque = (BrinOpaque *) scan->opaque;
965 
967  brin_free_desc(opaque->bo_bdesc);
968  pfree(opaque);
969 }
void brin_free_desc(BrinDesc *bdesc)
Definition: brin.c:1621

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

Referenced by brinhandler().

◆ bringetbitmap()

int64 bringetbitmap ( IndexScanDesc  scan,
TIDBitmap tbm 
)

Definition at line 552 of file brin.c.

553 {
554  Relation idxRel = scan->indexRelation;
556  BrinDesc *bdesc;
557  Oid heapOid;
558  Relation heapRel;
559  BrinOpaque *opaque;
560  BlockNumber nblocks;
561  BlockNumber heapBlk;
562  int totalpages = 0;
563  FmgrInfo *consistentFn;
564  MemoryContext oldcxt;
565  MemoryContext perRangeCxt;
566  BrinMemTuple *dtup;
567  BrinTuple *btup = NULL;
568  Size btupsz = 0;
569  ScanKey **keys,
570  **nullkeys;
571  int *nkeys,
572  *nnullkeys;
573  char *ptr;
574  Size len;
575  char *tmp PG_USED_FOR_ASSERTS_ONLY;
576 
577  opaque = (BrinOpaque *) scan->opaque;
578  bdesc = opaque->bo_bdesc;
579  pgstat_count_index_scan(idxRel);
580 
581  /*
582  * We need to know the size of the table so that we know how long to
583  * iterate on the revmap.
584  */
585  heapOid = IndexGetRelation(RelationGetRelid(idxRel), false);
586  heapRel = table_open(heapOid, AccessShareLock);
587  nblocks = RelationGetNumberOfBlocks(heapRel);
588  table_close(heapRel, AccessShareLock);
589 
590  /*
591  * Make room for the consistent support procedures of indexed columns. We
592  * don't look them up here; we do that lazily the first time we see a scan
593  * key reference each of them. We rely on zeroing fn_oid to InvalidOid.
594  */
595  consistentFn = palloc0_array(FmgrInfo, bdesc->bd_tupdesc->natts);
596 
597  /*
598  * Make room for per-attribute lists of scan keys that we'll pass to the
599  * consistent support procedure. We don't know which attributes have scan
600  * keys, so we allocate space for all attributes. That may use more memory
601  * but it's probably cheaper than determining which attributes are used.
602  *
603  * We keep null and regular keys separate, so that we can pass just the
604  * regular keys to the consistent function easily.
605  *
606  * To reduce the allocation overhead, we allocate one big chunk and then
607  * carve it into smaller arrays ourselves. All the pieces have exactly the
608  * same lifetime, so that's OK.
609  *
610  * XXX The widest index can have 32 attributes, so the amount of wasted
611  * memory is negligible. We could invent a more compact approach (with
612  * just space for used attributes) but that would make the matching more
613  * complex so it's not a good trade-off.
614  */
615  len =
616  MAXALIGN(sizeof(ScanKey *) * bdesc->bd_tupdesc->natts) + /* regular keys */
617  MAXALIGN(sizeof(ScanKey) * scan->numberOfKeys) * bdesc->bd_tupdesc->natts +
618  MAXALIGN(sizeof(int) * bdesc->bd_tupdesc->natts) +
619  MAXALIGN(sizeof(ScanKey *) * bdesc->bd_tupdesc->natts) + /* NULL keys */
620  MAXALIGN(sizeof(ScanKey) * scan->numberOfKeys) * bdesc->bd_tupdesc->natts +
621  MAXALIGN(sizeof(int) * bdesc->bd_tupdesc->natts);
622 
623  ptr = palloc(len);
624  tmp = ptr;
625 
626  keys = (ScanKey **) ptr;
627  ptr += MAXALIGN(sizeof(ScanKey *) * bdesc->bd_tupdesc->natts);
628 
629  nullkeys = (ScanKey **) ptr;
630  ptr += MAXALIGN(sizeof(ScanKey *) * bdesc->bd_tupdesc->natts);
631 
632  nkeys = (int *) ptr;
633  ptr += MAXALIGN(sizeof(int) * bdesc->bd_tupdesc->natts);
634 
635  nnullkeys = (int *) ptr;
636  ptr += MAXALIGN(sizeof(int) * bdesc->bd_tupdesc->natts);
637 
638  for (int i = 0; i < bdesc->bd_tupdesc->natts; i++)
639  {
640  keys[i] = (ScanKey *) ptr;
641  ptr += MAXALIGN(sizeof(ScanKey) * scan->numberOfKeys);
642 
643  nullkeys[i] = (ScanKey *) ptr;
644  ptr += MAXALIGN(sizeof(ScanKey) * scan->numberOfKeys);
645  }
646 
647  Assert(tmp + len == ptr);
648 
649  /* zero the number of keys */
650  memset(nkeys, 0, sizeof(int) * bdesc->bd_tupdesc->natts);
651  memset(nnullkeys, 0, sizeof(int) * bdesc->bd_tupdesc->natts);
652 
653  /* Preprocess the scan keys - split them into per-attribute arrays. */
654  for (int keyno = 0; keyno < scan->numberOfKeys; keyno++)
655  {
656  ScanKey key = &scan->keyData[keyno];
657  AttrNumber keyattno = key->sk_attno;
658 
659  /*
660  * The collation of the scan key must match the collation used in the
661  * index column (but only if the search is not IS NULL/ IS NOT NULL).
662  * Otherwise we shouldn't be using this index ...
663  */
664  Assert((key->sk_flags & SK_ISNULL) ||
665  (key->sk_collation ==
666  TupleDescAttr(bdesc->bd_tupdesc,
667  keyattno - 1)->attcollation));
668 
669  /*
670  * First time we see this index attribute, so init as needed.
671  *
672  * This is a bit of an overkill - we don't know how many scan keys are
673  * there for this attribute, so we simply allocate the largest number
674  * possible (as if all keys were for this attribute). This may waste a
675  * bit of memory, but we only expect small number of scan keys in
676  * general, so this should be negligible, and repeated repalloc calls
677  * are not free either.
678  */
679  if (consistentFn[keyattno - 1].fn_oid == InvalidOid)
680  {
681  FmgrInfo *tmp;
682 
683  /* First time we see this attribute, so no key/null keys. */
684  Assert(nkeys[keyattno - 1] == 0);
685  Assert(nnullkeys[keyattno - 1] == 0);
686 
687  tmp = index_getprocinfo(idxRel, keyattno,
689  fmgr_info_copy(&consistentFn[keyattno - 1], tmp,
691  }
692 
693  /* Add key to the proper per-attribute array. */
694  if (key->sk_flags & SK_ISNULL)
695  {
696  nullkeys[keyattno - 1][nnullkeys[keyattno - 1]] = key;
697  nnullkeys[keyattno - 1]++;
698  }
699  else
700  {
701  keys[keyattno - 1][nkeys[keyattno - 1]] = key;
702  nkeys[keyattno - 1]++;
703  }
704  }
705 
706  /* allocate an initial in-memory tuple, out of the per-range memcxt */
707  dtup = brin_new_memtuple(bdesc);
708 
709  /*
710  * Setup and use a per-range memory context, which is reset every time we
711  * loop below. This avoids having to free the tuples within the loop.
712  */
714  "bringetbitmap cxt",
716  oldcxt = MemoryContextSwitchTo(perRangeCxt);
717 
718  /*
719  * Now scan the revmap. We start by querying for heap page 0,
720  * incrementing by the number of pages per range; this gives us a full
721  * view of the table.
722  */
723  for (heapBlk = 0; heapBlk < nblocks; heapBlk += opaque->bo_pagesPerRange)
724  {
725  bool addrange;
726  bool gottuple = false;
727  BrinTuple *tup;
728  OffsetNumber off;
729  Size size;
730 
732 
733  MemoryContextReset(perRangeCxt);
734 
735  tup = brinGetTupleForHeapBlock(opaque->bo_rmAccess, heapBlk, &buf,
736  &off, &size, BUFFER_LOCK_SHARE);
737  if (tup)
738  {
739  gottuple = true;
740  btup = brin_copy_tuple(tup, size, btup, &btupsz);
742  }
743 
744  /*
745  * For page ranges with no indexed tuple, we must return the whole
746  * range; otherwise, compare it to the scan keys.
747  */
748  if (!gottuple)
749  {
750  addrange = true;
751  }
752  else
753  {
754  dtup = brin_deform_tuple(bdesc, btup, dtup);
755  if (dtup->bt_placeholder)
756  {
757  /*
758  * Placeholder tuples are always returned, regardless of the
759  * values stored in them.
760  */
761  addrange = true;
762  }
763  else
764  {
765  int attno;
766 
767  /*
768  * Compare scan keys with summary values stored for the range.
769  * If scan keys are matched, the page range must be added to
770  * the bitmap. We initially assume the range needs to be
771  * added; in particular this serves the case where there are
772  * no keys.
773  */
774  addrange = true;
775  for (attno = 1; attno <= bdesc->bd_tupdesc->natts; attno++)
776  {
777  BrinValues *bval;
778  Datum add;
779  Oid collation;
780 
781  /*
782  * skip attributes without any scan keys (both regular and
783  * IS [NOT] NULL)
784  */
785  if (nkeys[attno - 1] == 0 && nnullkeys[attno - 1] == 0)
786  continue;
787 
788  bval = &dtup->bt_columns[attno - 1];
789 
790  /*
791  * If the BRIN tuple indicates that this range is empty,
792  * we can skip it: there's nothing to match. We don't
793  * need to examine the next columns.
794  */
795  if (dtup->bt_empty_range)
796  {
797  addrange = false;
798  break;
799  }
800 
801  /*
802  * First check if there are any IS [NOT] NULL scan keys,
803  * and if we're violating them. In that case we can
804  * terminate early, without invoking the support function.
805  *
806  * As there may be more keys, we can only determine
807  * mismatch within this loop.
808  */
809  if (bdesc->bd_info[attno - 1]->oi_regular_nulls &&
810  !check_null_keys(bval, nullkeys[attno - 1],
811  nnullkeys[attno - 1]))
812  {
813  /*
814  * If any of the IS [NOT] NULL keys failed, the page
815  * range as a whole can't pass. So terminate the loop.
816  */
817  addrange = false;
818  break;
819  }
820 
821  /*
822  * So either there are no IS [NOT] NULL keys, or all
823  * passed. If there are no regular scan keys, we're done -
824  * the page range matches. If there are regular keys, but
825  * the page range is marked as 'all nulls' it can't
826  * possibly pass (we're assuming the operators are
827  * strict).
828  */
829 
830  /* No regular scan keys - page range as a whole passes. */
831  if (!nkeys[attno - 1])
832  continue;
833 
834  Assert((nkeys[attno - 1] > 0) &&
835  (nkeys[attno - 1] <= scan->numberOfKeys));
836 
837  /* If it is all nulls, it cannot possibly be consistent. */
838  if (bval->bv_allnulls)
839  {
840  addrange = false;
841  break;
842  }
843 
844  /*
845  * Collation from the first key (has to be the same for
846  * all keys for the same attribute).
847  */
848  collation = keys[attno - 1][0]->sk_collation;
849 
850  /*
851  * Check whether the scan key is consistent with the page
852  * range values; if so, have the pages in the range added
853  * to the output bitmap.
854  *
855  * The opclass may or may not support processing of
856  * multiple scan keys. We can determine that based on the
857  * number of arguments - functions with extra parameter
858  * (number of scan keys) do support this, otherwise we
859  * have to simply pass the scan keys one by one.
860  */
861  if (consistentFn[attno - 1].fn_nargs >= 4)
862  {
863  /* Check all keys at once */
864  add = FunctionCall4Coll(&consistentFn[attno - 1],
865  collation,
866  PointerGetDatum(bdesc),
867  PointerGetDatum(bval),
868  PointerGetDatum(keys[attno - 1]),
869  Int32GetDatum(nkeys[attno - 1]));
870  addrange = DatumGetBool(add);
871  }
872  else
873  {
874  /*
875  * Check keys one by one
876  *
877  * When there are multiple scan keys, failure to meet
878  * the criteria for a single one of them is enough to
879  * discard the range as a whole, so break out of the
880  * loop as soon as a false return value is obtained.
881  */
882  int keyno;
883 
884  for (keyno = 0; keyno < nkeys[attno - 1]; keyno++)
885  {
886  add = FunctionCall3Coll(&consistentFn[attno - 1],
887  keys[attno - 1][keyno]->sk_collation,
888  PointerGetDatum(bdesc),
889  PointerGetDatum(bval),
890  PointerGetDatum(keys[attno - 1][keyno]));
891  addrange = DatumGetBool(add);
892  if (!addrange)
893  break;
894  }
895  }
896 
897  /*
898  * If we found a scan key eliminating the range, no need
899  * to check additional ones.
900  */
901  if (!addrange)
902  break;
903  }
904  }
905  }
906 
907  /* add the pages in the range to the output bitmap, if needed */
908  if (addrange)
909  {
910  BlockNumber pageno;
911 
912  for (pageno = heapBlk;
913  pageno <= Min(nblocks, heapBlk + opaque->bo_pagesPerRange) - 1;
914  pageno++)
915  {
916  MemoryContextSwitchTo(oldcxt);
917  tbm_add_page(tbm, pageno);
918  totalpages++;
919  MemoryContextSwitchTo(perRangeCxt);
920  }
921  }
922  }
923 
924  MemoryContextSwitchTo(oldcxt);
925  MemoryContextDelete(perRangeCxt);
926 
927  if (buf != InvalidBuffer)
929 
930  /*
931  * XXX We have an approximation of the number of *pages* that our scan
932  * returns, but we don't have a precise idea of the number of heap tuples
933  * involved.
934  */
935  return totalpages * 10;
936 }
int16 AttrNumber
Definition: attnum.h:21
static bool check_null_keys(BrinValues *bval, ScanKey *nullkeys, int nnullkeys)
Definition: brin.c:2284
#define BRIN_PROCNUM_CONSISTENT
Definition: brin_internal.h:72
BrinTuple * brinGetTupleForHeapBlock(BrinRevmap *revmap, BlockNumber heapBlk, Buffer *buf, OffsetNumber *off, Size *size, int mode)
Definition: brin_revmap.c:194
BrinMemTuple * brin_new_memtuple(BrinDesc *brdesc)
Definition: brin_tuple.c:482
BrinMemTuple * brin_deform_tuple(BrinDesc *brdesc, BrinTuple *tuple, BrinMemTuple *dMemtuple)
Definition: brin_tuple.c:553
BrinTuple * brin_copy_tuple(BrinTuple *tuple, Size len, BrinTuple *dest, Size *destsz)
Definition: brin_tuple.c:446
#define InvalidBuffer
Definition: buf.h:25
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:4560
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:4795
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:157
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:158
#define Min(x, y)
Definition: c.h:991
#define MAXALIGN(LEN)
Definition: c.h:798
#define PG_USED_FOR_ASSERTS_ONLY
Definition: c.h:169
size_t Size
Definition: c.h:592
#define palloc0_array(type, count)
Definition: fe_memutils.h:65
Datum FunctionCall4Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3, Datum arg4)
Definition: fmgr.c:1196
Datum FunctionCall3Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2, Datum arg3)
Definition: fmgr.c:1171
void fmgr_info_copy(FmgrInfo *dstinfo, FmgrInfo *srcinfo, MemoryContext destcxt)
Definition: fmgr.c:580
Oid IndexGetRelation(Oid indexId, bool missing_ok)
Definition: index.c:3544
int i
Definition: isn.c:73
#define AccessShareLock
Definition: lockdefs.h:36
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:326
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:152
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122
uint16 OffsetNumber
Definition: off.h:24
const void size_t len
static char * buf
Definition: pg_test_fsync.c:73
#define pgstat_count_index_scan(rel)
Definition: pgstat.h:625
static bool DatumGetBool(Datum X)
Definition: postgres.h:90
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:322
uintptr_t Datum
Definition: postgres.h:64
static Datum Int32GetDatum(int32 X)
Definition: postgres.h:212
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
static void addrange(struct cvec *cv, chr from, chr to)
Definition: regc_cvec.c:90
#define RelationGetRelid(relation)
Definition: rel.h:504
#define SK_ISNULL
Definition: skey.h:115
static pg_noinline void Size size
Definition: slab.c:607
BrinValues bt_columns[FLEXIBLE_ARRAY_MEMBER]
Definition: brin_tuple.h:55
bool bt_placeholder
Definition: brin_tuple.h:46
bool bt_empty_range
Definition: brin_tuple.h:47
bool oi_regular_nulls
Definition: brin_internal.h:31
bool bv_allnulls
Definition: brin_tuple.h:33
struct ScanKeyData * keyData
Definition: relscan.h:122
Relation indexRelation
Definition: relscan.h:118
Oid sk_collation
Definition: skey.h:70
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:126
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:40
void tbm_add_page(TIDBitmap *tbm, BlockNumber pageno)
Definition: tidbitmap.c:443

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

Referenced by brinhandler().

◆ brininsert()

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

Definition at line 333 of file brin.c.

338 {
339  BlockNumber pagesPerRange;
340  BlockNumber origHeapBlk;
341  BlockNumber heapBlk;
342  BrinInsertState *bistate = (BrinInsertState *) indexInfo->ii_AmCache;
343  BrinRevmap *revmap;
344  BrinDesc *bdesc;
346  MemoryContext tupcxt = NULL;
348  bool autosummarize = BrinGetAutoSummarize(idxRel);
349 
350  /*
351  * If first time through in this statement, initialize the insert state
352  * that we keep for all the inserts in the command.
353  */
354  if (!bistate)
355  bistate = initialize_brin_insertstate(idxRel, indexInfo);
356 
357  revmap = bistate->bis_rmAccess;
358  bdesc = bistate->bis_desc;
359  pagesPerRange = bistate->bis_pages_per_range;
360 
361  /*
362  * origHeapBlk is the block number where the insertion occurred. heapBlk
363  * is the first block in the corresponding page range.
364  */
365  origHeapBlk = ItemPointerGetBlockNumber(heaptid);
366  heapBlk = (origHeapBlk / pagesPerRange) * pagesPerRange;
367 
368  for (;;)
369  {
370  bool need_insert = false;
371  OffsetNumber off;
372  BrinTuple *brtup;
373  BrinMemTuple *dtup;
374 
376 
377  /*
378  * If auto-summarization is enabled and we just inserted the first
379  * tuple into the first block of a new non-first page range, request a
380  * summarization run of the previous range.
381  */
382  if (autosummarize &&
383  heapBlk > 0 &&
384  heapBlk == origHeapBlk &&
386  {
387  BlockNumber lastPageRange = heapBlk - 1;
388  BrinTuple *lastPageTuple;
389 
390  lastPageTuple =
391  brinGetTupleForHeapBlock(revmap, lastPageRange, &buf, &off,
392  NULL, BUFFER_LOCK_SHARE);
393  if (!lastPageTuple)
394  {
395  bool recorded;
396 
398  RelationGetRelid(idxRel),
399  lastPageRange);
400  if (!recorded)
401  ereport(LOG,
402  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
403  errmsg("request for BRIN range summarization for index \"%s\" page %u was not recorded",
404  RelationGetRelationName(idxRel),
405  lastPageRange)));
406  }
407  else
409  }
410 
411  brtup = brinGetTupleForHeapBlock(revmap, heapBlk, &buf, &off,
412  NULL, BUFFER_LOCK_SHARE);
413 
414  /* if range is unsummarized, there's nothing to do */
415  if (!brtup)
416  break;
417 
418  /* First time through in this brininsert call? */
419  if (tupcxt == NULL)
420  {
422  "brininsert cxt",
424  MemoryContextSwitchTo(tupcxt);
425  }
426 
427  dtup = brin_deform_tuple(bdesc, brtup, NULL);
428 
429  need_insert = add_values_to_range(idxRel, bdesc, dtup, values, nulls);
430 
431  if (!need_insert)
432  {
433  /*
434  * The tuple is consistent with the new values, so there's nothing
435  * to do.
436  */
438  }
439  else
440  {
441  Page page = BufferGetPage(buf);
442  ItemId lp = PageGetItemId(page, off);
443  Size origsz;
444  BrinTuple *origtup;
445  Size newsz;
446  BrinTuple *newtup;
447  bool samepage;
448 
449  /*
450  * Make a copy of the old tuple, so that we can compare it after
451  * re-acquiring the lock.
452  */
453  origsz = ItemIdGetLength(lp);
454  origtup = brin_copy_tuple(brtup, origsz, NULL, NULL);
455 
456  /*
457  * Before releasing the lock, check if we can attempt a same-page
458  * update. Another process could insert a tuple concurrently in
459  * the same page though, so downstream we must be prepared to cope
460  * if this turns out to not be possible after all.
461  */
462  newtup = brin_form_tuple(bdesc, heapBlk, dtup, &newsz);
463  samepage = brin_can_do_samepage_update(buf, origsz, newsz);
465 
466  /*
467  * Try to update the tuple. If this doesn't work for whatever
468  * reason, we need to restart from the top; the revmap might be
469  * pointing at a different tuple for this block now, so we need to
470  * recompute to ensure both our new heap tuple and the other
471  * inserter's are covered by the combined tuple. It might be that
472  * we don't need to update at all.
473  */
474  if (!brin_doupdate(idxRel, pagesPerRange, revmap, heapBlk,
475  buf, off, origtup, origsz, newtup, newsz,
476  samepage))
477  {
478  /* no luck; start over */
479  MemoryContextReset(tupcxt);
480  continue;
481  }
482  }
483 
484  /* success! */
485  break;
486  }
487 
488  if (BufferIsValid(buf))
490  MemoryContextSwitchTo(oldcxt);
491  if (tupcxt != NULL)
492  MemoryContextDelete(tupcxt);
493 
494  return false;
495 }
bool AutoVacuumRequestWork(AutoVacuumWorkItemType type, Oid relationId, BlockNumber blkno)
Definition: autovacuum.c:3296
@ AVW_BRINSummarizeRange
Definition: autovacuum.h:25
static Datum values[MAXATTR]
Definition: bootstrap.c:152
static bool add_values_to_range(Relation idxRel, BrinDesc *bdesc, BrinMemTuple *dtup, const Datum *values, const bool *nulls)
Definition: brin.c:2190
static BrinInsertState * initialize_brin_insertstate(Relation idxRel, IndexInfo *indexInfo)
Definition: brin.c:304
#define BrinGetAutoSummarize(relation)
Definition: brin.h:46
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:53
bool brin_can_do_samepage_update(Buffer buffer, Size origsz, Size newsz)
Definition: brin_pageops.c:323
BrinTuple * brin_form_tuple(BrinDesc *brdesc, BlockNumber blkno, BrinMemTuple *tuple, Size *size)
Definition: brin_tuple.c:99
static bool BufferIsValid(Buffer bufnum)
Definition: bufmgr.h:301
static ItemId PageGetItemId(Page page, OffsetNumber offsetNumber)
Definition: bufpage.h:240
int errcode(int sqlerrcode)
Definition: elog.c:859
int errmsg(const char *fmt,...)
Definition: elog.c:1072
#define LOG
Definition: elog.h:31
#define ereport(elevel,...)
Definition: elog.h:149
#define ItemIdGetLength(itemId)
Definition: itemid.h:59
static OffsetNumber ItemPointerGetOffsetNumber(const ItemPointerData *pointer)
Definition: itemptr.h:124
static BlockNumber ItemPointerGetBlockNumber(const ItemPointerData *pointer)
Definition: itemptr.h:103
#define FirstOffsetNumber
Definition: off.h:27
BrinDesc * bis_desc
Definition: brin.c:192
BrinRevmap * bis_rmAccess
Definition: brin.c:191
BlockNumber bis_pages_per_range
Definition: brin.c:193
void * ii_AmCache
Definition: execnodes.h:207

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

Referenced by brinhandler().

◆ brininsertcleanup()

void brininsertcleanup ( struct IndexInfo indexInfo)

Definition at line 501 of file brin.c.

502 {
503  BrinInsertState *bistate = (BrinInsertState *) indexInfo->ii_AmCache;
504 
505  Assert(bistate);
506 
507  /*
508  * Clean up the revmap. Note that the brinDesc has already been cleaned up
509  * as part of its own memory context.
510  */
512  bistate->bis_rmAccess = NULL;
513  bistate->bis_desc = NULL;
514 }

References Assert(), BrinInsertState::bis_desc, BrinInsertState::bis_rmAccess, brinRevmapTerminate(), and IndexInfo::ii_AmCache.

Referenced by brinhandler().

◆ brinoptions()

bytea* brinoptions ( Datum  reloptions,
bool  validate 
)

Definition at line 1333 of file brin.c.

1334 {
1335  static const relopt_parse_elt tab[] = {
1336  {"pages_per_range", RELOPT_TYPE_INT, offsetof(BrinOptions, pagesPerRange)},
1337  {"autosummarize", RELOPT_TYPE_BOOL, offsetof(BrinOptions, autosummarize)}
1338  };
1339 
1340  return (bytea *) build_reloptions(reloptions, validate,
1342  sizeof(BrinOptions),
1343  tab, lengthof(tab));
1344 }
#define lengthof(array)
Definition: c.h:775
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:1908
@ RELOPT_KIND_BRIN
Definition: reloptions.h:52
@ RELOPT_TYPE_INT
Definition: reloptions.h:32
@ RELOPT_TYPE_BOOL
Definition: reloptions.h:31
Definition: c.h:674

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

Referenced by brinhandler().

◆ brinrescan()

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

Definition at line 942 of file brin.c.

944 {
945  /*
946  * Other index AMs preprocess the scan keys at this point, or sometime
947  * early during the scan; this lets them optimize by removing redundant
948  * keys, or doing early returns when they are impossible to satisfy; see
949  * _bt_preprocess_keys for an example. Something like that could be added
950  * here someday, too.
951  */
952 
953  if (scankey && scan->numberOfKeys > 0)
954  memmove(scan->keyData, scankey,
955  scan->numberOfKeys * sizeof(ScanKeyData));
956 }

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

Referenced by brinhandler().

◆ brinvacuumcleanup()

IndexBulkDeleteResult* brinvacuumcleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult stats 
)

Definition at line 1303 of file brin.c.

1304 {
1305  Relation heapRel;
1306 
1307  /* No-op in ANALYZE ONLY mode */
1308  if (info->analyze_only)
1309  return stats;
1310 
1311  if (!stats)
1313  stats->num_pages = RelationGetNumberOfBlocks(info->index);
1314  /* rest of stats is initialized by zeroing */
1315 
1316  heapRel = table_open(IndexGetRelation(RelationGetRelid(info->index), false),
1317  AccessShareLock);
1318 
1319  brin_vacuum_scan(info->index, info->strategy);
1320 
1321  brinsummarize(info->index, heapRel, BRIN_ALL_BLOCKRANGES, false,
1322  &stats->num_index_tuples, &stats->num_index_tuples);
1323 
1324  table_close(heapRel, AccessShareLock);
1325 
1326  return stats;
1327 }
static void brin_vacuum_scan(Relation idxrel, BufferAccessStrategy strategy)
Definition: brin.c:2157
#define BRIN_ALL_BLOCKRANGES
Definition: brin.c:206
static void brinsummarize(Relation index, Relation heapRel, BlockNumber pageRange, bool include_partial, double *numSummarized, double *numExisting)
Definition: brin.c:1872
BlockNumber num_pages
Definition: genam.h:77
double num_index_tuples
Definition: genam.h:79
Relation index
Definition: genam.h:46
bool analyze_only
Definition: genam.h:48
BufferAccessStrategy strategy
Definition: genam.h:53

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

Referenced by brinhandler().

◆ brinvalidate()

bool brinvalidate ( Oid  opclassoid)

Definition at line 37 of file brin_validate.c.

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

References 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(), 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, ReleaseCatCacheList(), ReleaseSysCache(), OpFamilyOpFuncGroup::righttype, SearchSysCache1(), SearchSysCacheList1, and catctup::tuple.

Referenced by brinhandler().