PostgreSQL Source Code  git master
bloom.h File Reference
#include "access/amapi.h"
#include "access/generic_xlog.h"
#include "access/itup.h"
#include "access/xlog.h"
#include "nodes/pathnodes.h"
#include "fmgr.h"
Include dependency graph for bloom.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  BloomPageOpaqueData
 
struct  BloomOptions
 
struct  BloomMetaPageData
 
struct  BloomState
 
struct  BloomTuple
 
struct  BloomScanOpaqueData
 

Macros

#define BLOOM_HASH_PROC   1
 
#define BLOOM_NPROC   1
 
#define BLOOM_EQUAL_STRATEGY   1
 
#define BLOOM_NSTRATEGIES   1
 
#define BLOOM_META   (1<<0)
 
#define BLOOM_DELETED   (2<<0)
 
#define BLOOM_PAGE_ID   0xFF83
 
#define BloomPageGetOpaque(page)   ((BloomPageOpaque) PageGetSpecialPointer(page))
 
#define BloomPageGetMaxOffset(page)   (BloomPageGetOpaque(page)->maxoff)
 
#define BloomPageIsMeta(page)   ((BloomPageGetOpaque(page)->flags & BLOOM_META) != 0)
 
#define BloomPageIsDeleted(page)   ((BloomPageGetOpaque(page)->flags & BLOOM_DELETED) != 0)
 
#define BloomPageSetDeleted(page)   (BloomPageGetOpaque(page)->flags |= BLOOM_DELETED)
 
#define BloomPageSetNonDeleted(page)   (BloomPageGetOpaque(page)->flags &= ~BLOOM_DELETED)
 
#define BloomPageGetData(page)   ((BloomTuple *)PageGetContents(page))
 
#define BloomPageGetTuple(state, page, offset)
 
#define BloomPageGetNextTuple(state, tuple)   ((BloomTuple *)((Pointer)(tuple) + (state)->sizeOfBloomTuple))
 
#define BLOOM_METAPAGE_BLKNO   (0)
 
#define BLOOM_HEAD_BLKNO   (1) /* first data page */
 
#define SIGNWORDBITS   ((int) (BITS_PER_BYTE * sizeof(BloomSignatureWord)))
 
#define DEFAULT_BLOOM_LENGTH   (5 * SIGNWORDBITS)
 
#define MAX_BLOOM_LENGTH   (256 * SIGNWORDBITS)
 
#define DEFAULT_BLOOM_BITS   2
 
#define MAX_BLOOM_BITS   (MAX_BLOOM_LENGTH - 1)
 
#define BLOOM_MAGICK_NUMBER   (0xDBAC0DED)
 
#define BloomMetaBlockN   (sizeof(FreeBlockNumberArray) / sizeof(BlockNumber))
 
#define BloomPageGetMeta(page)   ((BloomMetaPageData *) PageGetContents(page))
 
#define BloomPageGetFreeSpace(state, page)
 
#define BLOOMTUPLEHDRSZ   offsetof(BloomTuple, sign)
 

Typedefs

typedef struct BloomPageOpaqueData BloomPageOpaqueData
 
typedef BloomPageOpaqueDataBloomPageOpaque
 
typedef uint16 BloomSignatureWord
 
typedef struct BloomOptions BloomOptions
 
typedef BlockNumber FreeBlockNumberArray[MAXALIGN_DOWN(BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(BloomPageOpaqueData)) - MAXALIGN(sizeof(uint16) *2+sizeof(uint32)+sizeof(BloomOptions)))/sizeof(BlockNumber)]
 
typedef struct BloomMetaPageData BloomMetaPageData
 
typedef struct BloomState BloomState
 
typedef struct BloomTuple BloomTuple
 
typedef struct BloomScanOpaqueData BloomScanOpaqueData
 
typedef BloomScanOpaqueDataBloomScanOpaque
 

Functions

void _PG_init (void)
 
void initBloomState (BloomState *state, Relation index)
 
void BloomFillMetapage (Relation index, Page metaPage)
 
void BloomInitMetapage (Relation index)
 
void BloomInitPage (Page page, uint16 flags)
 
Buffer BloomNewBuffer (Relation index)
 
void signValue (BloomState *state, BloomSignatureWord *sign, Datum value, int attno)
 
BloomTupleBloomFormTuple (BloomState *state, ItemPointer iptr, Datum *values, bool *isnull)
 
bool BloomPageAddItem (BloomState *state, Page page, BloomTuple *tuple)
 
bool blvalidate (Oid opclassoid)
 
bool blinsert (Relation index, Datum *values, bool *isnull, ItemPointer ht_ctid, Relation heapRel, IndexUniqueCheck checkUnique, struct IndexInfo *indexInfo)
 
IndexScanDesc blbeginscan (Relation r, int nkeys, int norderbys)
 
int64 blgetbitmap (IndexScanDesc scan, TIDBitmap *tbm)
 
void blrescan (IndexScanDesc scan, ScanKey scankey, int nscankeys, ScanKey orderbys, int norderbys)
 
void blendscan (IndexScanDesc scan)
 
IndexBuildResultblbuild (Relation heap, Relation index, struct IndexInfo *indexInfo)
 
void blbuildempty (Relation index)
 
IndexBulkDeleteResultblbulkdelete (IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
 
IndexBulkDeleteResultblvacuumcleanup (IndexVacuumInfo *info, IndexBulkDeleteResult *stats)
 
byteabloptions (Datum reloptions, bool validate)
 
void blcostestimate (PlannerInfo *root, IndexPath *path, double loop_count, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, double *indexCorrelation, double *indexPages)
 

Macro Definition Documentation

◆ BLOOM_DELETED

#define BLOOM_DELETED   (2<<0)

Definition at line 46 of file bloom.h.

◆ BLOOM_EQUAL_STRATEGY

#define BLOOM_EQUAL_STRATEGY   1

Definition at line 28 of file bloom.h.

◆ BLOOM_HASH_PROC

#define BLOOM_HASH_PROC   1

Definition at line 24 of file bloom.h.

Referenced by blvalidate(), and initBloomState().

◆ BLOOM_HEAD_BLKNO

#define BLOOM_HEAD_BLKNO   (1) /* first data page */

Definition at line 78 of file bloom.h.

Referenced by blbulkdelete(), blgetbitmap(), and blvacuumcleanup().

◆ BLOOM_MAGICK_NUMBER

#define BLOOM_MAGICK_NUMBER   (0xDBAC0DED)

Definition at line 130 of file bloom.h.

Referenced by BloomFillMetapage(), and initBloomState().

◆ BLOOM_META

#define BLOOM_META   (1<<0)

Definition at line 45 of file bloom.h.

Referenced by BloomFillMetapage().

◆ BLOOM_METAPAGE_BLKNO

#define BLOOM_METAPAGE_BLKNO   (0)

Definition at line 77 of file bloom.h.

Referenced by blbuildempty(), blbulkdelete(), blinsert(), BloomInitMetapage(), and initBloomState().

◆ BLOOM_NPROC

#define BLOOM_NPROC   1

Definition at line 25 of file bloom.h.

Referenced by blhandler(), and blvalidate().

◆ BLOOM_NSTRATEGIES

#define BLOOM_NSTRATEGIES   1

Definition at line 29 of file bloom.h.

Referenced by blhandler(), and blvalidate().

◆ BLOOM_PAGE_ID

#define BLOOM_PAGE_ID   0xFF83

Definition at line 56 of file bloom.h.

Referenced by BloomInitPage().

◆ BloomMetaBlockN

#define BloomMetaBlockN   (sizeof(FreeBlockNumberArray) / sizeof(BlockNumber))

Definition at line 133 of file bloom.h.

Referenced by blbulkdelete().

◆ BloomPageGetData

#define BloomPageGetData (   page)    ((BloomTuple *)PageGetContents(page))

Definition at line 69 of file bloom.h.

◆ BloomPageGetFreeSpace

#define BloomPageGetFreeSpace (   state,
  page 
)
Value:
- BloomPageGetMaxOffset(page) * (state)->sizeOfBloomTuple \
#define SizeOfPageHeaderData
Definition: bufpage.h:216
Definition: regguts.h:298
#define MAXALIGN(LEN)
Definition: c.h:685
#define BloomPageGetMaxOffset(page)
Definition: bloom.h:60

Definition at line 151 of file bloom.h.

Referenced by blbulkdelete(), and BloomPageAddItem().

◆ BloomPageGetMaxOffset

#define BloomPageGetMaxOffset (   page)    (BloomPageGetOpaque(page)->maxoff)

Definition at line 60 of file bloom.h.

Referenced by blbulkdelete(), blgetbitmap(), and blvacuumcleanup().

◆ BloomPageGetMeta

#define BloomPageGetMeta (   page)    ((BloomMetaPageData *) PageGetContents(page))

Definition at line 135 of file bloom.h.

Referenced by blbulkdelete(), blinsert(), BloomFillMetapage(), and initBloomState().

◆ BloomPageGetNextTuple

#define BloomPageGetNextTuple (   state,
  tuple 
)    ((BloomTuple *)((Pointer)(tuple) + (state)->sizeOfBloomTuple))

Definition at line 73 of file bloom.h.

Referenced by blbulkdelete().

◆ BloomPageGetOpaque

#define BloomPageGetOpaque (   page)    ((BloomPageOpaque) PageGetSpecialPointer(page))

Definition at line 59 of file bloom.h.

Referenced by blbulkdelete(), BloomInitPage(), and BloomPageAddItem().

◆ BloomPageGetTuple

#define BloomPageGetTuple (   state,
  page,
  offset 
)
Value:
+ (state)->sizeOfBloomTuple * ((offset) - 1)))
#define PageGetContents(page)
Definition: bufpage.h:246
Definition: regguts.h:298

Definition at line 70 of file bloom.h.

Referenced by blbulkdelete(), blgetbitmap(), and BloomPageAddItem().

◆ BloomPageIsDeleted

#define BloomPageIsDeleted (   page)    ((BloomPageGetOpaque(page)->flags & BLOOM_DELETED) != 0)

◆ BloomPageIsMeta

#define BloomPageIsMeta (   page)    ((BloomPageGetOpaque(page)->flags & BLOOM_META) != 0)

Definition at line 61 of file bloom.h.

Referenced by initBloomState().

◆ BloomPageSetDeleted

#define BloomPageSetDeleted (   page)    (BloomPageGetOpaque(page)->flags |= BLOOM_DELETED)

Definition at line 65 of file bloom.h.

Referenced by blbulkdelete().

◆ BloomPageSetNonDeleted

#define BloomPageSetNonDeleted (   page)    (BloomPageGetOpaque(page)->flags &= ~BLOOM_DELETED)

Definition at line 67 of file bloom.h.

◆ BLOOMTUPLEHDRSZ

#define BLOOMTUPLEHDRSZ   offsetof(BloomTuple, sign)

Definition at line 165 of file bloom.h.

Referenced by initBloomState().

◆ DEFAULT_BLOOM_BITS

#define DEFAULT_BLOOM_BITS   2

Definition at line 96 of file bloom.h.

Referenced by _PG_init(), and makeDefaultBloomOptions().

◆ DEFAULT_BLOOM_LENGTH

#define DEFAULT_BLOOM_LENGTH   (5 * SIGNWORDBITS)

Definition at line 90 of file bloom.h.

Referenced by _PG_init(), and makeDefaultBloomOptions().

◆ MAX_BLOOM_BITS

#define MAX_BLOOM_BITS   (MAX_BLOOM_LENGTH - 1)

Definition at line 97 of file bloom.h.

Referenced by _PG_init().

◆ MAX_BLOOM_LENGTH

#define MAX_BLOOM_LENGTH   (256 * SIGNWORDBITS)

Definition at line 91 of file bloom.h.

Referenced by _PG_init().

◆ SIGNWORDBITS

#define SIGNWORDBITS   ((int) (BITS_PER_BYTE * sizeof(BloomSignatureWord)))

Definition at line 85 of file bloom.h.

Referenced by bloptions(), makeDefaultBloomOptions(), and signValue().

Typedef Documentation

◆ BloomMetaPageData

◆ BloomOptions

typedef struct BloomOptions BloomOptions

◆ BloomPageOpaque

Definition at line 42 of file bloom.h.

◆ BloomPageOpaqueData

◆ BloomScanOpaque

Definition at line 174 of file bloom.h.

◆ BloomScanOpaqueData

◆ BloomSignatureWord

Definition at line 83 of file bloom.h.

◆ BloomState

typedef struct BloomState BloomState

◆ BloomTuple

typedef struct BloomTuple BloomTuple

◆ FreeBlockNumberArray

typedef BlockNumber FreeBlockNumberArray[ MAXALIGN_DOWN( BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(BloomPageOpaqueData)) - MAXALIGN(sizeof(uint16) *2+sizeof(uint32)+sizeof(BloomOptions)))/sizeof(BlockNumber)]

Definition at line 117 of file bloom.h.

Function Documentation

◆ _PG_init()

void _PG_init ( void  )

Definition at line 56 of file auth_delay.c.

57 {
58  /* Define custom GUC variables */
59  DefineCustomIntVariable("auth_delay.milliseconds",
60  "Milliseconds to delay before reporting authentication failure",
61  NULL,
63  0,
64  0, INT_MAX / 1000,
65  PGC_SIGHUP,
67  NULL,
68  NULL,
69  NULL);
70  /* Install Hooks */
73 }
void DefineCustomIntVariable(const char *name, const char *short_desc, const char *long_desc, int *valueAddr, int bootValue, int minValue, int maxValue, GucContext context, int flags, GucIntCheckHook check_hook, GucIntAssignHook assign_hook, GucShowHook show_hook)
Definition: guc.c:8599
ClientAuthentication_hook_type ClientAuthentication_hook
Definition: auth.c:239
static ClientAuthentication_hook_type original_client_auth_hook
Definition: auth_delay.c:29
Definition: guc.h:72
static void auth_delay_checks(Port *port, int status)
Definition: auth_delay.c:35
static int auth_delay_milliseconds
Definition: auth_delay.c:26
#define GUC_UNIT_MS
Definition: guc.h:225

◆ blbeginscan()

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

Definition at line 29 of file blscan.c.

References IndexScanDescData::indexRelation, initBloomState(), IndexScanDescData::opaque, palloc(), RelationGetIndexScan(), BloomScanOpaqueData::sign, and BloomScanOpaqueData::state.

Referenced by blhandler().

30 {
31  IndexScanDesc scan;
32  BloomScanOpaque so;
33 
34  scan = RelationGetIndexScan(r, nkeys, norderbys);
35 
37  initBloomState(&so->state, scan->indexRelation);
38  so->sign = NULL;
39 
40  scan->opaque = so;
41 
42  return scan;
43 }
void initBloomState(BloomState *state, Relation index)
Definition: blutils.c:157
Relation indexRelation
Definition: relscan.h:103
BloomState state
Definition: bloom.h:171
void * palloc(Size size)
Definition: mcxt.c:949
BloomScanOpaqueData * BloomScanOpaque
Definition: bloom.h:174
BloomSignatureWord * sign
Definition: bloom.h:170
IndexScanDesc RelationGetIndexScan(Relation indexRelation, int nkeys, int norderbys)
Definition: genam.c:80

◆ blbuild()

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

Definition at line 123 of file blinsert.c.

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, bloomBuildCallback(), BloomInitMetapage(), BloomBuildState::blstate, CurrentMemoryContext, elog, ERROR, flushCachedPage(), IndexBuildResult::heap_tuples, IndexBuildResult::index_tuples, initBloomState(), initCachedPage(), MemoryContextDelete(), palloc(), RelationGetNumberOfBlocks, RelationGetRelationName, reltuples, table_index_build_scan(), and BloomBuildState::tmpCtx.

Referenced by blhandler().

124 {
125  IndexBuildResult *result;
126  double reltuples;
127  BloomBuildState buildstate;
128 
129  if (RelationGetNumberOfBlocks(index) != 0)
130  elog(ERROR, "index \"%s\" already contains data",
131  RelationGetRelationName(index));
132 
133  /* Initialize the meta page */
134  BloomInitMetapage(index);
135 
136  /* Initialize the bloom build state */
137  memset(&buildstate, 0, sizeof(buildstate));
138  initBloomState(&buildstate.blstate, index);
140  "Bloom build temporary context",
142  initCachedPage(&buildstate);
143 
144  /* Do the heap scan */
145  reltuples = table_index_build_scan(heap, index, indexInfo, true, true,
146  bloomBuildCallback, (void *) &buildstate,
147  NULL);
148 
149  /* Flush last page if needed (it will be, unless heap was empty) */
150  if (buildstate.count > 0)
151  flushCachedPage(index, &buildstate);
152 
153  MemoryContextDelete(buildstate.tmpCtx);
154 
155  result = (IndexBuildResult *) palloc(sizeof(IndexBuildResult));
156  result->heap_tuples = reltuples;
157  result->index_tuples = buildstate.indtuples;
158 
159  return result;
160 }
static void bloomBuildCallback(Relation index, HeapTuple htup, Datum *values, bool *isnull, bool tupleIsAlive, void *state)
Definition: blinsert.c:76
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
#define AllocSetContextCreate
Definition: memutils.h:170
void initBloomState(BloomState *state, Relation index)
Definition: blutils.c:157
#define ERROR
Definition: elog.h:43
static void flushCachedPage(Relation index, BloomBuildState *buildstate)
Definition: blinsert.c:48
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:1499
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
MemoryContext tmpCtx
Definition: blinsert.c:38
#define RelationGetRelationName(relation)
Definition: rel.h:453
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:198
static void initCachedPage(BloomBuildState *buildstate)
Definition: blinsert.c:65
void * palloc(Size size)
Definition: mcxt.c:949
#define elog(elevel,...)
Definition: elog.h:226
BloomState blstate
Definition: blinsert.c:36
int64 indtuples
Definition: blinsert.c:37
float4 reltuples
Definition: pg_class.h:63
double index_tuples
Definition: genam.h:33
double heap_tuples
Definition: genam.h:32
void BloomInitMetapage(Relation index)
Definition: blutils.c:451

◆ blbuildempty()

void blbuildempty ( Relation  index)

Definition at line 166 of file blinsert.c.

References BLOOM_METAPAGE_BLKNO, BloomFillMetapage(), INIT_FORKNUM, log_newpage(), RelFileNodeBackend::node, PageSetChecksumInplace(), palloc(), RelationData::rd_smgr, SMgrRelationData::smgr_rnode, smgrimmedsync(), and smgrwrite().

Referenced by blhandler().

167 {
168  Page metapage;
169 
170  /* Construct metapage. */
171  metapage = (Page) palloc(BLCKSZ);
172  BloomFillMetapage(index, metapage);
173 
174  /*
175  * Write the page and log it. It might seem that an immediate sync would
176  * be sufficient to guarantee that the file exists on disk, but recovery
177  * itself might remove it while replaying, for example, an
178  * XLOG_DBASE_CREATE or XLOG_TBLSPC_CREATE record. Therefore, we need
179  * this even when wal_level=minimal.
180  */
183  (char *) metapage, true);
185  BLOOM_METAPAGE_BLKNO, metapage, true);
186 
187  /*
188  * An immediate sync is required even if we xlog'd the page, because the
189  * write did not go through shared_buffers and therefore a concurrent
190  * checkpoint may have moved the redo pointer past our xlog record.
191  */
193 }
#define BLOOM_METAPAGE_BLKNO
Definition: bloom.h:77
struct SMgrRelationData * rd_smgr
Definition: rel.h:56
RelFileNodeBackend smgr_rnode
Definition: smgr.h:42
void smgrwrite(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum, char *buffer, bool skipFsync)
Definition: smgr.c:530
RelFileNode node
Definition: relfilenode.h:74
void BloomFillMetapage(Relation index, Page metaPage)
Definition: blutils.c:419
void PageSetChecksumInplace(Page page, BlockNumber blkno)
Definition: bufpage.c:1198
void * palloc(Size size)
Definition: mcxt.c:949
XLogRecPtr log_newpage(RelFileNode *rnode, ForkNumber forkNum, BlockNumber blkno, Page page, bool page_std)
Definition: xloginsert.c:972
void smgrimmedsync(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:637
Pointer Page
Definition: bufpage.h:78

◆ blbulkdelete()

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

Definition at line 34 of file blvacuum.c.

References Assert, BLOOM_HEAD_BLKNO, BLOOM_METAPAGE_BLKNO, BloomMetaBlockN, BloomPageGetFreeSpace, BloomPageGetMaxOffset, BloomPageGetMeta, BloomPageGetNextTuple, BloomPageGetOpaque, BloomPageGetTuple, BloomPageIsDeleted, BloomPageSetDeleted, BUFFER_LOCK_EXCLUSIVE, callback(), FirstOffsetNumber, GenericXLogAbort(), GenericXLogFinish(), GenericXLogRegisterBuffer(), GenericXLogStart(), BloomTuple::heapPtr, IndexVacuumInfo::index, initBloomState(), LockBuffer(), MAIN_FORKNUM, memmove, BloomMetaPageData::nEnd, BloomMetaPageData::notFullPage, BloomMetaPageData::nStart, OffsetNumberNext, PageIsNew, palloc0(), RBM_NORMAL, ReadBuffer(), ReadBufferExtended(), RelationGetNumberOfBlocks, BloomState::sizeOfBloomTuple, IndexVacuumInfo::strategy, IndexBulkDeleteResult::tuples_removed, UnlockReleaseBuffer(), and vacuum_delay_point().

Referenced by blhandler().

36 {
37  Relation index = info->index;
38  BlockNumber blkno,
39  npages;
40  FreeBlockNumberArray notFullPage;
41  int countPage = 0;
43  Buffer buffer;
44  Page page;
45  BloomMetaPageData *metaData;
46  GenericXLogState *gxlogState;
47 
48  if (stats == NULL)
50 
51  initBloomState(&state, index);
52 
53  /*
54  * Iterate over the pages. We don't care about concurrently added pages,
55  * they can't contain tuples to delete.
56  */
57  npages = RelationGetNumberOfBlocks(index);
58  for (blkno = BLOOM_HEAD_BLKNO; blkno < npages; blkno++)
59  {
60  BloomTuple *itup,
61  *itupPtr,
62  *itupEnd;
63 
65 
66  buffer = ReadBufferExtended(index, MAIN_FORKNUM, blkno,
67  RBM_NORMAL, info->strategy);
68 
70  gxlogState = GenericXLogStart(index);
71  page = GenericXLogRegisterBuffer(gxlogState, buffer, 0);
72 
73  /* Ignore empty/deleted pages until blvacuumcleanup() */
74  if (PageIsNew(page) || BloomPageIsDeleted(page))
75  {
76  UnlockReleaseBuffer(buffer);
77  GenericXLogAbort(gxlogState);
78  continue;
79  }
80 
81  /*
82  * Iterate over the tuples. itup points to current tuple being
83  * scanned, itupPtr points to where to save next non-deleted tuple.
84  */
85  itup = itupPtr = BloomPageGetTuple(&state, page, FirstOffsetNumber);
86  itupEnd = BloomPageGetTuple(&state, page,
88  while (itup < itupEnd)
89  {
90  /* Do we have to delete this tuple? */
91  if (callback(&itup->heapPtr, callback_state))
92  {
93  /* Yes; adjust count of tuples that will be left on page */
94  BloomPageGetOpaque(page)->maxoff--;
95  stats->tuples_removed += 1;
96  }
97  else
98  {
99  /* No; copy it to itupPtr++, but skip copy if not needed */
100  if (itupPtr != itup)
101  memmove((Pointer) itupPtr, (Pointer) itup,
102  state.sizeOfBloomTuple);
103  itupPtr = BloomPageGetNextTuple(&state, itupPtr);
104  }
105 
106  itup = BloomPageGetNextTuple(&state, itup);
107  }
108 
109  /* Assert that we counted correctly */
110  Assert(itupPtr == BloomPageGetTuple(&state, page,
112 
113  /*
114  * Add page to new notFullPage list if we will not mark page as
115  * deleted and there is free space on it
116  */
117  if (BloomPageGetMaxOffset(page) != 0 &&
118  BloomPageGetFreeSpace(&state, page) >= state.sizeOfBloomTuple &&
119  countPage < BloomMetaBlockN)
120  notFullPage[countPage++] = blkno;
121 
122  /* Did we delete something? */
123  if (itupPtr != itup)
124  {
125  /* Is it empty page now? */
126  if (BloomPageGetMaxOffset(page) == 0)
127  BloomPageSetDeleted(page);
128  /* Adjust pd_lower */
129  ((PageHeader) page)->pd_lower = (Pointer) itupPtr - page;
130  /* Finish WAL-logging */
131  GenericXLogFinish(gxlogState);
132  }
133  else
134  {
135  /* Didn't change anything: abort WAL-logging */
136  GenericXLogAbort(gxlogState);
137  }
138  UnlockReleaseBuffer(buffer);
139  }
140 
141  /*
142  * Update the metapage's notFullPage list with whatever we found. Our
143  * info could already be out of date at this point, but blinsert() will
144  * cope if so.
145  */
146  buffer = ReadBuffer(index, BLOOM_METAPAGE_BLKNO);
148 
149  gxlogState = GenericXLogStart(index);
150  page = GenericXLogRegisterBuffer(gxlogState, buffer, 0);
151 
152  metaData = BloomPageGetMeta(page);
153  memcpy(metaData->notFullPage, notFullPage, sizeof(BlockNumber) * countPage);
154  metaData->nStart = 0;
155  metaData->nEnd = countPage;
156 
157  GenericXLogFinish(gxlogState);
158  UnlockReleaseBuffer(buffer);
159 
160  return stats;
161 }
BlockNumber FreeBlockNumberArray[MAXALIGN_DOWN(BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(BloomPageOpaqueData)) - MAXALIGN(sizeof(uint16) *2+sizeof(uint32)+sizeof(BloomOptions)))/sizeof(BlockNumber)]
Definition: bloom.h:117
#define BLOOM_METAPAGE_BLKNO
Definition: bloom.h:77
#define BloomPageIsDeleted(page)
Definition: bloom.h:63
double tuples_removed
Definition: genam.h:78
void initBloomState(BloomState *state, Relation index)
Definition: blutils.c:157
uint16 nEnd
Definition: bloom.h:124
Buffer ReadBufferExtended(Relation reln, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy)
Definition: bufmgr.c:642
BufferAccessStrategy strategy
Definition: genam.h:52
Relation index
Definition: genam.h:46
uint32 BlockNumber
Definition: block.h:31
#define BLOOM_HEAD_BLKNO
Definition: bloom.h:78
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:88
Page GenericXLogRegisterBuffer(GenericXLogState *state, Buffer buffer, int flags)
Definition: generic_xlog.c:295
Definition: type.h:89
char * Pointer
Definition: c.h:335
#define BloomMetaBlockN
Definition: bloom.h:133
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3388
#define BloomPageGetOpaque(page)
Definition: bloom.h:59
static void callback(struct sockaddr *addr, struct sockaddr *mask, void *unused)
Definition: test_ifaddrs.c:48
#define BloomPageGetFreeSpace(state, page)
Definition: bloom.h:151
#define memmove(d, s, c)
Definition: c.h:1238
#define FirstOffsetNumber
Definition: off.h:27
FreeBlockNumberArray notFullPage
Definition: bloom.h:126
#define BloomPageGetTuple(state, page, offset)
Definition: bloom.h:70
#define BloomPageGetMeta(page)
Definition: bloom.h:135
void * palloc0(Size size)
Definition: mcxt.c:980
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3602
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:198
#define BloomPageGetNextTuple(state, tuple)
Definition: bloom.h:73
PageHeaderData * PageHeader
Definition: bufpage.h:166
#define Assert(condition)
Definition: c.h:732
Definition: regguts.h:298
XLogRecPtr GenericXLogFinish(GenericXLogState *state)
Definition: generic_xlog.c:333
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define OffsetNumberNext(offsetNumber)
Definition: off.h:52
uint16 nStart
Definition: bloom.h:123
ItemPointerData heapPtr
Definition: bloom.h:161
#define PageIsNew(page)
Definition: bufpage.h:229
#define BloomPageGetMaxOffset(page)
Definition: bloom.h:60
void GenericXLogAbort(GenericXLogState *state)
Definition: generic_xlog.c:444
void vacuum_delay_point(void)
Definition: vacuum.c:1940
Size sizeOfBloomTuple
Definition: bloom.h:148
int Buffer
Definition: buf.h:23
GenericXLogState * GenericXLogStart(Relation relation)
Definition: generic_xlog.c:267
Pointer Page
Definition: bufpage.h:78
#define BloomPageSetDeleted(page)
Definition: bloom.h:65

◆ blcostestimate()

void blcostestimate ( PlannerInfo root,
IndexPath path,
double  loop_count,
Cost indexStartupCost,
Cost indexTotalCost,
Selectivity indexSelectivity,
double *  indexCorrelation,
double *  indexPages 
)

Definition at line 24 of file blcost.c.

References genericcostestimate(), GenericCosts::indexCorrelation, IndexPath::indexinfo, GenericCosts::indexSelectivity, GenericCosts::indexStartupCost, GenericCosts::indexTotalCost, MemSet, GenericCosts::numIndexPages, GenericCosts::numIndexTuples, and IndexOptInfo::tuples.

Referenced by blhandler().

28 {
29  IndexOptInfo *index = path->indexinfo;
30  GenericCosts costs;
31 
32  MemSet(&costs, 0, sizeof(costs));
33 
34  /* We have to visit all index tuples anyway */
35  costs.numIndexTuples = index->tuples;
36 
37  /* Use generic estimate */
38  genericcostestimate(root, path, loop_count, &costs);
39 
40  *indexStartupCost = costs.indexStartupCost;
41  *indexTotalCost = costs.indexTotalCost;
42  *indexSelectivity = costs.indexSelectivity;
43  *indexCorrelation = costs.indexCorrelation;
44  *indexPages = costs.numIndexPages;
45 }
Selectivity indexSelectivity
Definition: selfuncs.h:106
IndexOptInfo * indexinfo
Definition: pathnodes.h:1177
#define MemSet(start, val, len)
Definition: c.h:955
double tuples
Definition: pathnodes.h:795
Definition: type.h:89
void genericcostestimate(PlannerInfo *root, IndexPath *path, double loop_count, GenericCosts *costs)
Definition: selfuncs.c:5524
Cost indexTotalCost
Definition: selfuncs.h:105
double indexCorrelation
Definition: selfuncs.h:107
double numIndexTuples
Definition: selfuncs.h:111
Cost indexStartupCost
Definition: selfuncs.h:104
double numIndexPages
Definition: selfuncs.h:110

◆ blendscan()

void blendscan ( IndexScanDesc  scan)

Definition at line 69 of file blscan.c.

References IndexScanDescData::opaque, pfree(), and BloomScanOpaqueData::sign.

Referenced by blhandler().

70 {
72 
73  if (so->sign)
74  pfree(so->sign);
75  so->sign = NULL;
76 }
void pfree(void *pointer)
Definition: mcxt.c:1056
BloomScanOpaqueData * BloomScanOpaque
Definition: bloom.h:174
BloomSignatureWord * sign
Definition: bloom.h:170

◆ blgetbitmap()

int64 blgetbitmap ( IndexScanDesc  scan,
TIDBitmap tbm 
)

Definition at line 82 of file blscan.c.

References BAS_BULKREAD, BLOOM_HEAD_BLKNO, BloomOptions::bloomLength, BloomPageGetMaxOffset, BloomPageGetTuple, BloomPageIsDeleted, BUFFER_LOCK_SHARE, BufferGetPage, CHECK_FOR_INTERRUPTS, FreeAccessStrategy(), GetAccessStrategy(), BloomTuple::heapPtr, i, IndexScanDescData::indexRelation, IndexScanDescData::keyData, LockBuffer(), MAIN_FORKNUM, IndexScanDescData::numberOfKeys, IndexScanDescData::opaque, BloomState::opts, PageIsNew, palloc0(), pfree(), RBM_NORMAL, ReadBufferExtended(), RelationGetNumberOfBlocks, BloomTuple::sign, BloomScanOpaqueData::sign, signValue(), ScanKeyData::sk_argument, ScanKeyData::sk_attno, ScanKeyData::sk_flags, SK_ISNULL, BloomScanOpaqueData::state, tbm_add_tuples(), TestForOldSnapshot(), UnlockReleaseBuffer(), and IndexScanDescData::xs_snapshot.

Referenced by blhandler().

83 {
84  int64 ntids = 0;
86  npages;
87  int i;
90 
91  if (so->sign == NULL)
92  {
93  /* New search: have to calculate search signature */
94  ScanKey skey = scan->keyData;
95 
96  so->sign = palloc0(sizeof(BloomSignatureWord) * so->state.opts.bloomLength);
97 
98  for (i = 0; i < scan->numberOfKeys; i++)
99  {
100  /*
101  * Assume bloom-indexable operators to be strict, so nothing could
102  * be found for NULL key.
103  */
104  if (skey->sk_flags & SK_ISNULL)
105  {
106  pfree(so->sign);
107  so->sign = NULL;
108  return 0;
109  }
110 
111  /* Add next value to the signature */
112  signValue(&so->state, so->sign, skey->sk_argument,
113  skey->sk_attno - 1);
114 
115  skey++;
116  }
117  }
118 
119  /*
120  * We're going to read the whole index. This is why we use appropriate
121  * buffer access strategy.
122  */
125 
126  for (blkno = BLOOM_HEAD_BLKNO; blkno < npages; blkno++)
127  {
128  Buffer buffer;
129  Page page;
130 
132  blkno, RBM_NORMAL, bas);
133 
134  LockBuffer(buffer, BUFFER_LOCK_SHARE);
135  page = BufferGetPage(buffer);
136  TestForOldSnapshot(scan->xs_snapshot, scan->indexRelation, page);
137 
138  if (!PageIsNew(page) && !BloomPageIsDeleted(page))
139  {
140  OffsetNumber offset,
141  maxOffset = BloomPageGetMaxOffset(page);
142 
143  for (offset = 1; offset <= maxOffset; offset++)
144  {
145  BloomTuple *itup = BloomPageGetTuple(&so->state, page, offset);
146  bool res = true;
147 
148  /* Check index signature with scan signature */
149  for (i = 0; i < so->state.opts.bloomLength; i++)
150  {
151  if ((itup->sign[i] & so->sign[i]) != so->sign[i])
152  {
153  res = false;
154  break;
155  }
156  }
157 
158  /* Add matching tuples to bitmap */
159  if (res)
160  {
161  tbm_add_tuples(tbm, &itup->heapPtr, 1, true);
162  ntids++;
163  }
164  }
165  }
166 
167  UnlockReleaseBuffer(buffer);
169  }
170  FreeAccessStrategy(bas);
171 
172  return ntids;
173 }
BufferAccessStrategy GetAccessStrategy(BufferAccessStrategyType btype)
Definition: freelist.c:542
#define BloomPageIsDeleted(page)
Definition: bloom.h:63
static void TestForOldSnapshot(Snapshot snapshot, Relation relation, Page page)
Definition: bufmgr.h:264
BloomOptions opts
Definition: bloom.h:141
void signValue(BloomState *state, BloomSignatureWord *sign, Datum value, int attno)
Definition: blutils.c:256
void tbm_add_tuples(TIDBitmap *tbm, const ItemPointer tids, int ntids, bool recheck)
Definition: tidbitmap.c:376
Buffer ReadBufferExtended(Relation reln, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy)
Definition: bufmgr.c:642
struct SnapshotData * xs_snapshot
Definition: relscan.h:104
uint32 BlockNumber
Definition: block.h:31
#define BLOOM_HEAD_BLKNO
Definition: bloom.h:78
Relation indexRelation
Definition: relscan.h:103
uint16 OffsetNumber
Definition: off.h:24
uint16 BloomSignatureWord
Definition: bloom.h:83
void pfree(void *pointer)
Definition: mcxt.c:1056
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3388
#define BloomPageGetTuple(state, page, offset)
Definition: bloom.h:70
#define SK_ISNULL
Definition: skey.h:115
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
void * palloc0(Size size)
Definition: mcxt.c:980
BloomState state
Definition: bloom.h:171
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3602
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:198
void FreeAccessStrategy(BufferAccessStrategy strategy)
Definition: freelist.c:597
int sk_flags
Definition: skey.h:66
BloomSignatureWord sign[FLEXIBLE_ARRAY_MEMBER]
Definition: bloom.h:162
int bloomLength
Definition: bloom.h:103
struct ScanKeyData * keyData
Definition: relscan.h:107
ItemPointerData heapPtr
Definition: bloom.h:161
#define PageIsNew(page)
Definition: bufpage.h:229
#define BloomPageGetMaxOffset(page)
Definition: bloom.h:60
int i
BloomScanOpaqueData * BloomScanOpaque
Definition: bloom.h:174
BloomSignatureWord * sign
Definition: bloom.h:170
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:87
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
int Buffer
Definition: buf.h:23
Datum sk_argument
Definition: skey.h:72
AttrNumber sk_attno
Definition: skey.h:67
Pointer Page
Definition: bufpage.h:78

◆ blinsert()

bool blinsert ( Relation  index,
Datum values,
bool isnull,
ItemPointer  ht_ctid,
Relation  heapRel,
IndexUniqueCheck  checkUnique,
struct IndexInfo indexInfo 
)

Definition at line 199 of file blinsert.c.

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, BLOOM_METAPAGE_BLKNO, BloomFormTuple(), BloomInitPage(), BloomNewBuffer(), BloomPageAddItem(), BloomPageGetMeta, BloomPageIsDeleted, BUFFER_LOCK_EXCLUSIVE, BUFFER_LOCK_SHARE, BUFFER_LOCK_UNLOCK, BufferGetBlockNumber(), BufferGetPage, CurrentMemoryContext, elog, ERROR, GENERIC_XLOG_FULL_IMAGE, GenericXLogAbort(), GenericXLogFinish(), GenericXLogRegisterBuffer(), GenericXLogStart(), initBloomState(), InvalidBlockNumber, LockBuffer(), MemoryContextDelete(), MemoryContextSwitchTo(), BloomMetaPageData::nEnd, BloomMetaPageData::notFullPage, BloomMetaPageData::nStart, PageIsNew, ReadBuffer(), ReleaseBuffer(), and UnlockReleaseBuffer().

Referenced by blhandler().

203 {
204  BloomState blstate;
205  BloomTuple *itup;
206  MemoryContext oldCtx;
207  MemoryContext insertCtx;
208  BloomMetaPageData *metaData;
209  Buffer buffer,
210  metaBuffer;
211  Page page,
212  metaPage;
214  OffsetNumber nStart;
216 
218  "Bloom insert temporary context",
220 
221  oldCtx = MemoryContextSwitchTo(insertCtx);
222 
223  initBloomState(&blstate, index);
224  itup = BloomFormTuple(&blstate, ht_ctid, values, isnull);
225 
226  /*
227  * At first, try to insert new tuple to the first page in notFullPage
228  * array. If successful, we don't need to modify the meta page.
229  */
230  metaBuffer = ReadBuffer(index, BLOOM_METAPAGE_BLKNO);
231  LockBuffer(metaBuffer, BUFFER_LOCK_SHARE);
232  metaData = BloomPageGetMeta(BufferGetPage(metaBuffer));
233 
234  if (metaData->nEnd > metaData->nStart)
235  {
236  Page page;
237 
238  blkno = metaData->notFullPage[metaData->nStart];
239  Assert(blkno != InvalidBlockNumber);
240 
241  /* Don't hold metabuffer lock while doing insert */
242  LockBuffer(metaBuffer, BUFFER_LOCK_UNLOCK);
243 
244  buffer = ReadBuffer(index, blkno);
246 
247  state = GenericXLogStart(index);
248  page = GenericXLogRegisterBuffer(state, buffer, 0);
249 
250  /*
251  * We might have found a page that was recently deleted by VACUUM. If
252  * so, we can reuse it, but we must reinitialize it.
253  */
254  if (PageIsNew(page) || BloomPageIsDeleted(page))
255  BloomInitPage(page, 0);
256 
257  if (BloomPageAddItem(&blstate, page, itup))
258  {
259  /* Success! Apply the change, clean up, and exit */
260  GenericXLogFinish(state);
261  UnlockReleaseBuffer(buffer);
262  ReleaseBuffer(metaBuffer);
263  MemoryContextSwitchTo(oldCtx);
264  MemoryContextDelete(insertCtx);
265  return false;
266  }
267 
268  /* Didn't fit, must try other pages */
269  GenericXLogAbort(state);
270  UnlockReleaseBuffer(buffer);
271  }
272  else
273  {
274  /* No entries in notFullPage */
275  LockBuffer(metaBuffer, BUFFER_LOCK_UNLOCK);
276  }
277 
278  /*
279  * Try other pages in notFullPage array. We will have to change nStart in
280  * metapage. Thus, grab exclusive lock on metapage.
281  */
282  LockBuffer(metaBuffer, BUFFER_LOCK_EXCLUSIVE);
283 
284  /* nStart might have changed while we didn't have lock */
285  nStart = metaData->nStart;
286 
287  /* Skip first page if we already tried it above */
288  if (nStart < metaData->nEnd &&
289  blkno == metaData->notFullPage[nStart])
290  nStart++;
291 
292  /*
293  * This loop iterates for each page we try from the notFullPage array, and
294  * will also initialize a GenericXLogState for the fallback case of having
295  * to allocate a new page.
296  */
297  for (;;)
298  {
299  state = GenericXLogStart(index);
300 
301  /* get modifiable copy of metapage */
302  metaPage = GenericXLogRegisterBuffer(state, metaBuffer, 0);
303  metaData = BloomPageGetMeta(metaPage);
304 
305  if (nStart >= metaData->nEnd)
306  break; /* no more entries in notFullPage array */
307 
308  blkno = metaData->notFullPage[nStart];
309  Assert(blkno != InvalidBlockNumber);
310 
311  buffer = ReadBuffer(index, blkno);
313  page = GenericXLogRegisterBuffer(state, buffer, 0);
314 
315  /* Basically same logic as above */
316  if (PageIsNew(page) || BloomPageIsDeleted(page))
317  BloomInitPage(page, 0);
318 
319  if (BloomPageAddItem(&blstate, page, itup))
320  {
321  /* Success! Apply the changes, clean up, and exit */
322  metaData->nStart = nStart;
323  GenericXLogFinish(state);
324  UnlockReleaseBuffer(buffer);
325  UnlockReleaseBuffer(metaBuffer);
326  MemoryContextSwitchTo(oldCtx);
327  MemoryContextDelete(insertCtx);
328  return false;
329  }
330 
331  /* Didn't fit, must try other pages */
332  GenericXLogAbort(state);
333  UnlockReleaseBuffer(buffer);
334  nStart++;
335  }
336 
337  /*
338  * Didn't find place to insert in notFullPage array. Allocate new page.
339  * (XXX is it good to do this while holding ex-lock on the metapage??)
340  */
341  buffer = BloomNewBuffer(index);
342 
343  page = GenericXLogRegisterBuffer(state, buffer, GENERIC_XLOG_FULL_IMAGE);
344  BloomInitPage(page, 0);
345 
346  if (!BloomPageAddItem(&blstate, page, itup))
347  {
348  /* We shouldn't be here since we're inserting to an empty page */
349  elog(ERROR, "could not add new bloom tuple to empty page");
350  }
351 
352  /* Reset notFullPage array to contain just this new page */
353  metaData->nStart = 0;
354  metaData->nEnd = 1;
355  metaData->notFullPage[0] = BufferGetBlockNumber(buffer);
356 
357  /* Apply the changes, clean up, and exit */
358  GenericXLogFinish(state);
359 
360  UnlockReleaseBuffer(buffer);
361  UnlockReleaseBuffer(metaBuffer);
362 
363  MemoryContextSwitchTo(oldCtx);
364  MemoryContextDelete(insertCtx);
365 
366  return false;
367 }
#define BLOOM_METAPAGE_BLKNO
Definition: bloom.h:77
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:86
#define BloomPageIsDeleted(page)
Definition: bloom.h:63
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:211
#define AllocSetContextCreate
Definition: memutils.h:170
void initBloomState(BloomState *state, Relation index)
Definition: blutils.c:157
uint16 nEnd
Definition: bloom.h:124
Buffer BloomNewBuffer(Relation index)
Definition: blutils.c:349
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
uint32 BlockNumber
Definition: block.h:31
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3365
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:88
Page GenericXLogRegisterBuffer(GenericXLogState *state, Buffer buffer, int flags)
Definition: generic_xlog.c:295
uint16 OffsetNumber
Definition: off.h:24
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3388
#define ERROR
Definition: elog.h:43
void BloomInitPage(Page page, uint16 flags)
Definition: blutils.c:403
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:192
bool BloomPageAddItem(BloomState *state, Page page, BloomTuple *tuple)
Definition: blutils.c:314
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
FreeBlockNumberArray notFullPage
Definition: bloom.h:126
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define BloomPageGetMeta(page)
Definition: bloom.h:135
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3602
#define Assert(condition)
Definition: c.h:732
Definition: regguts.h:298
BloomTuple * BloomFormTuple(BloomState *state, ItemPointer iptr, Datum *values, bool *isnull)
Definition: blutils.c:289
XLogRecPtr GenericXLogFinish(GenericXLogState *state)
Definition: generic_xlog.c:333
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define InvalidBlockNumber
Definition: block.h:33
uint16 nStart
Definition: bloom.h:123
static Datum values[MAXATTR]
Definition: bootstrap.c:167
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2613
#define PageIsNew(page)
Definition: bufpage.h:229
#define elog(elevel,...)
Definition: elog.h:226
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:87
void GenericXLogAbort(GenericXLogState *state)
Definition: generic_xlog.c:444
int Buffer
Definition: buf.h:23
#define GENERIC_XLOG_FULL_IMAGE
Definition: generic_xlog.h:26
GenericXLogState * GenericXLogStart(Relation relation)
Definition: generic_xlog.c:267
Pointer Page
Definition: bufpage.h:78

◆ BloomFillMetapage()

void BloomFillMetapage ( Relation  index,
Page  metaPage 
)

Definition at line 419 of file blutils.c.

References Assert, BLOOM_MAGICK_NUMBER, BLOOM_META, BloomInitPage(), BloomPageGetMeta, BloomMetaPageData::magickNumber, makeDefaultBloomOptions(), BloomMetaPageData::opts, and RelationData::rd_options.

Referenced by blbuildempty(), and BloomInitMetapage().

420 {
421  BloomOptions *opts;
422  BloomMetaPageData *metadata;
423 
424  /*
425  * Choose the index's options. If reloptions have been assigned, use
426  * those, otherwise create default options.
427  */
428  opts = (BloomOptions *) index->rd_options;
429  if (!opts)
430  opts = makeDefaultBloomOptions();
431 
432  /*
433  * Initialize contents of meta page, including a copy of the options,
434  * which are now frozen for the life of the index.
435  */
436  BloomInitPage(metaPage, BLOOM_META);
437  metadata = BloomPageGetMeta(metaPage);
438  memset(metadata, 0, sizeof(BloomMetaPageData));
439  metadata->magickNumber = BLOOM_MAGICK_NUMBER;
440  metadata->opts = *opts;
441  ((PageHeader) metaPage)->pd_lower += sizeof(BloomMetaPageData);
442 
443  /* If this fails, probably FreeBlockNumberArray size calc is wrong: */
444  Assert(((PageHeader) metaPage)->pd_lower <= ((PageHeader) metaPage)->pd_upper);
445 }
static BloomOptions * makeDefaultBloomOptions(void)
Definition: blutils.c:88
#define BloomPageGetMeta(page)
Definition: bloom.h:135
BloomOptions opts
Definition: bloom.h:125
PageHeaderData * PageHeader
Definition: bufpage.h:166
#define Assert(condition)
Definition: c.h:732
uint32 magickNumber
Definition: bloom.h:122
void BloomInitPage(Page page, uint16 flags)
Definition: blutils.c:403
#define BLOOM_META
Definition: bloom.h:45
struct BloomMetaPageData BloomMetaPageData
#define BLOOM_MAGICK_NUMBER
Definition: bloom.h:130
bytea * rd_options
Definition: rel.h:126

◆ BloomFormTuple()

BloomTuple* BloomFormTuple ( BloomState state,
ItemPointer  iptr,
Datum values,
bool isnull 
)

Definition at line 289 of file blutils.c.

References BloomTuple::heapPtr, i, BloomState::nColumns, palloc0(), BloomTuple::sign, signValue(), and BloomState::sizeOfBloomTuple.

Referenced by blinsert(), and bloomBuildCallback().

290 {
291  int i;
292  BloomTuple *res = (BloomTuple *) palloc0(state->sizeOfBloomTuple);
293 
294  res->heapPtr = *iptr;
295 
296  /* Blooming each column */
297  for (i = 0; i < state->nColumns; i++)
298  {
299  /* skip nulls */
300  if (isnull[i])
301  continue;
302 
303  signValue(state, res->sign, values[i], i);
304  }
305 
306  return res;
307 }
void * palloc0(Size size)
Definition: mcxt.c:980
void signValue(BloomState *state, BloomSignatureWord *sign, Datum value, int attno)
Definition: blutils.c:256
int32 nColumns
Definition: bloom.h:142
BloomSignatureWord sign[FLEXIBLE_ARRAY_MEMBER]
Definition: bloom.h:162
static Datum values[MAXATTR]
Definition: bootstrap.c:167
ItemPointerData heapPtr
Definition: bloom.h:161
int i
Size sizeOfBloomTuple
Definition: bloom.h:148

◆ BloomInitMetapage()

void BloomInitMetapage ( Relation  index)

Definition at line 451 of file blutils.c.

References Assert, BLOOM_METAPAGE_BLKNO, BloomFillMetapage(), BloomNewBuffer(), BufferGetBlockNumber(), GENERIC_XLOG_FULL_IMAGE, GenericXLogFinish(), GenericXLogRegisterBuffer(), GenericXLogStart(), and UnlockReleaseBuffer().

Referenced by blbuild().

452 {
453  Buffer metaBuffer;
454  Page metaPage;
456 
457  /*
458  * Make a new page; since it is first page it should be associated with
459  * block number 0 (BLOOM_METAPAGE_BLKNO).
460  */
461  metaBuffer = BloomNewBuffer(index);
463 
464  /* Initialize contents of meta page */
465  state = GenericXLogStart(index);
466  metaPage = GenericXLogRegisterBuffer(state, metaBuffer,
468  BloomFillMetapage(index, metaPage);
469  GenericXLogFinish(state);
470 
471  UnlockReleaseBuffer(metaBuffer);
472 }
#define BLOOM_METAPAGE_BLKNO
Definition: bloom.h:77
Page GenericXLogRegisterBuffer(GenericXLogState *state, Buffer buffer, int flags)
Definition: generic_xlog.c:295
Buffer BloomNewBuffer(Relation index)
Definition: blutils.c:349
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3388
void BloomFillMetapage(Relation index, Page metaPage)
Definition: blutils.c:419
#define Assert(condition)
Definition: c.h:732
Definition: regguts.h:298
XLogRecPtr GenericXLogFinish(GenericXLogState *state)
Definition: generic_xlog.c:333
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2613
int Buffer
Definition: buf.h:23
#define GENERIC_XLOG_FULL_IMAGE
Definition: generic_xlog.h:26
GenericXLogState * GenericXLogStart(Relation relation)
Definition: generic_xlog.c:267
Pointer Page
Definition: bufpage.h:78

◆ BloomInitPage()

void BloomInitPage ( Page  page,
uint16  flags 
)

Definition at line 403 of file blutils.c.

References BloomPageOpaqueData::bloom_page_id, BLOOM_PAGE_ID, BloomPageGetOpaque, BloomPageOpaqueData::flags, and PageInit().

Referenced by blinsert(), BloomFillMetapage(), and initCachedPage().

404 {
405  BloomPageOpaque opaque;
406 
407  PageInit(page, BLCKSZ, sizeof(BloomPageOpaqueData));
408 
409  opaque = BloomPageGetOpaque(page);
410  memset(opaque, 0, sizeof(BloomPageOpaqueData));
411  opaque->flags = flags;
412  opaque->bloom_page_id = BLOOM_PAGE_ID;
413 }
#define BLOOM_PAGE_ID
Definition: bloom.h:56
uint16 bloom_page_id
Definition: bloom.h:39
uint16 flags
Definition: bloom.h:35
#define BloomPageGetOpaque(page)
Definition: bloom.h:59
void PageInit(Page page, Size pageSize, Size specialSize)
Definition: bufpage.c:42

◆ BloomNewBuffer()

Buffer BloomNewBuffer ( Relation  index)

Definition at line 349 of file blutils.c.

References BloomPageIsDeleted, BUFFER_LOCK_EXCLUSIVE, BUFFER_LOCK_UNLOCK, BufferGetPage, ConditionalLockBuffer(), ExclusiveLock, GetFreeIndexPage(), InvalidBlockNumber, LockBuffer(), LockRelationForExtension(), P_NEW, PageIsNew, ReadBuffer(), RELATION_IS_LOCAL, ReleaseBuffer(), and UnlockRelationForExtension().

Referenced by blinsert(), BloomInitMetapage(), and flushCachedPage().

350 {
351  Buffer buffer;
352  bool needLock;
353 
354  /* First, try to get a page from FSM */
355  for (;;)
356  {
357  BlockNumber blkno = GetFreeIndexPage(index);
358 
359  if (blkno == InvalidBlockNumber)
360  break;
361 
362  buffer = ReadBuffer(index, blkno);
363 
364  /*
365  * We have to guard against the possibility that someone else already
366  * recycled this page; the buffer may be locked if so.
367  */
368  if (ConditionalLockBuffer(buffer))
369  {
370  Page page = BufferGetPage(buffer);
371 
372  if (PageIsNew(page))
373  return buffer; /* OK to use, if never initialized */
374 
375  if (BloomPageIsDeleted(page))
376  return buffer; /* OK to use */
377 
379  }
380 
381  /* Can't use it, so release buffer and try again */
382  ReleaseBuffer(buffer);
383  }
384 
385  /* Must extend the file */
386  needLock = !RELATION_IS_LOCAL(index);
387  if (needLock)
389 
390  buffer = ReadBuffer(index, P_NEW);
392 
393  if (needLock)
395 
396  return buffer;
397 }
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:86
#define BloomPageIsDeleted(page)
Definition: bloom.h:63
#define ExclusiveLock
Definition: lockdefs.h:44
#define RELATION_IS_LOCAL(relation)
Definition: rel.h:539
uint32 BlockNumber
Definition: block.h:31
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3365
#define P_NEW
Definition: bufmgr.h:81
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:88
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
bool ConditionalLockBuffer(Buffer buffer)
Definition: bufmgr.c:3628
void LockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:402
void UnlockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:452
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3602
BlockNumber GetFreeIndexPage(Relation rel)
Definition: indexfsm.c:38
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define InvalidBlockNumber
Definition: block.h:33
#define PageIsNew(page)
Definition: bufpage.h:229
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78

◆ BloomPageAddItem()

bool BloomPageAddItem ( BloomState state,
Page  page,
BloomTuple tuple 
)

Definition at line 314 of file blutils.c.

References Assert, BloomPageGetFreeSpace, BloomPageGetOpaque, BloomPageGetTuple, BloomPageIsDeleted, BloomPageOpaqueData::maxoff, PageIsNew, and BloomState::sizeOfBloomTuple.

Referenced by blinsert(), and bloomBuildCallback().

315 {
316  BloomTuple *itup;
317  BloomPageOpaque opaque;
318  Pointer ptr;
319 
320  /* We shouldn't be pointed to an invalid page */
321  Assert(!PageIsNew(page) && !BloomPageIsDeleted(page));
322 
323  /* Does new tuple fit on the page? */
324  if (BloomPageGetFreeSpace(state, page) < state->sizeOfBloomTuple)
325  return false;
326 
327  /* Copy new tuple to the end of page */
328  opaque = BloomPageGetOpaque(page);
329  itup = BloomPageGetTuple(state, page, opaque->maxoff + 1);
330  memcpy((Pointer) itup, (Pointer) tuple, state->sizeOfBloomTuple);
331 
332  /* Adjust maxoff and pd_lower */
333  opaque->maxoff++;
334  ptr = (Pointer) BloomPageGetTuple(state, page, opaque->maxoff + 1);
335  ((PageHeader) page)->pd_lower = ptr - page;
336 
337  /* Assert we didn't overrun available space */
338  Assert(((PageHeader) page)->pd_lower <= ((PageHeader) page)->pd_upper);
339 
340  return true;
341 }
#define BloomPageIsDeleted(page)
Definition: bloom.h:63
OffsetNumber maxoff
Definition: bloom.h:34
char * Pointer
Definition: c.h:335
#define BloomPageGetOpaque(page)
Definition: bloom.h:59
#define BloomPageGetFreeSpace(state, page)
Definition: bloom.h:151
#define BloomPageGetTuple(state, page, offset)
Definition: bloom.h:70
PageHeaderData * PageHeader
Definition: bufpage.h:166
#define Assert(condition)
Definition: c.h:732
#define PageIsNew(page)
Definition: bufpage.h:229
Size sizeOfBloomTuple
Definition: bloom.h:148

◆ bloptions()

bytea* bloptions ( Datum  reloptions,
bool  validate 
)

Definition at line 478 of file blutils.c.

References allocateReloptStruct(), bl_relopt_kind, fillRelOptions(), lengthof, options, parseRelOptions(), and SIGNWORDBITS.

Referenced by blhandler().

479 {
481  int numoptions;
482  BloomOptions *rdopts;
483 
484  /* Parse the user-given reloptions */
485  options = parseRelOptions(reloptions, validate, bl_relopt_kind, &numoptions);
486  rdopts = allocateReloptStruct(sizeof(BloomOptions), options, numoptions);
487  fillRelOptions((void *) rdopts, sizeof(BloomOptions), options, numoptions,
488  validate, bl_relopt_tab, lengthof(bl_relopt_tab));
489 
490  /* Convert signature length from # of bits to # to words, rounding up */
491  rdopts->bloomLength = (rdopts->bloomLength + SIGNWORDBITS - 1) / SIGNWORDBITS;
492 
493  return (bytea *) rdopts;
494 }
#define lengthof(array)
Definition: c.h:662
static relopt_kind bl_relopt_kind
Definition: blutils.c:39
static relopt_parse_elt bl_relopt_tab[INDEX_MAX_KEYS+1]
Definition: blutils.c:42
#define SIGNWORDBITS
Definition: bloom.h:85
void * allocateReloptStruct(Size base, relopt_value *options, int numoptions)
Definition: reloptions.c:1369
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:1393
Definition: c.h:549
relopt_value * parseRelOptions(Datum options, bool validate, relopt_kind kind, int *numrelopts)
Definition: reloptions.c:1144

◆ blrescan()

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

Definition at line 49 of file blscan.c.

References IndexScanDescData::keyData, memmove, IndexScanDescData::numberOfKeys, IndexScanDescData::opaque, pfree(), and BloomScanOpaqueData::sign.

Referenced by blhandler().

51 {
53 
54  if (so->sign)
55  pfree(so->sign);
56  so->sign = NULL;
57 
58  if (scankey && scan->numberOfKeys > 0)
59  {
60  memmove(scan->keyData, scankey,
61  scan->numberOfKeys * sizeof(ScanKeyData));
62  }
63 }
void pfree(void *pointer)
Definition: mcxt.c:1056
#define memmove(d, s, c)
Definition: c.h:1238
struct ScanKeyData * keyData
Definition: relscan.h:107
BloomScanOpaqueData * BloomScanOpaque
Definition: bloom.h:174
BloomSignatureWord * sign
Definition: bloom.h:170

◆ blvacuumcleanup()

IndexBulkDeleteResult* blvacuumcleanup ( IndexVacuumInfo info,
IndexBulkDeleteResult stats 
)

Definition at line 169 of file blvacuum.c.

References IndexVacuumInfo::analyze_only, BLOOM_HEAD_BLKNO, BloomPageGetMaxOffset, BloomPageIsDeleted, BUFFER_LOCK_SHARE, BufferGetPage, IndexVacuumInfo::index, IndexFreeSpaceMapVacuum(), LockBuffer(), MAIN_FORKNUM, IndexBulkDeleteResult::num_index_tuples, IndexBulkDeleteResult::num_pages, PageIsNew, IndexBulkDeleteResult::pages_free, palloc0(), RBM_NORMAL, ReadBufferExtended(), RecordFreeIndexPage(), RelationGetNumberOfBlocks, IndexVacuumInfo::strategy, UnlockReleaseBuffer(), and vacuum_delay_point().

Referenced by blhandler().

170 {
171  Relation index = info->index;
172  BlockNumber npages,
173  blkno;
174 
175  if (info->analyze_only)
176  return stats;
177 
178  if (stats == NULL)
180 
181  /*
182  * Iterate over the pages: insert deleted pages into FSM and collect
183  * statistics.
184  */
185  npages = RelationGetNumberOfBlocks(index);
186  stats->num_pages = npages;
187  stats->pages_free = 0;
188  stats->num_index_tuples = 0;
189  for (blkno = BLOOM_HEAD_BLKNO; blkno < npages; blkno++)
190  {
191  Buffer buffer;
192  Page page;
193 
195 
196  buffer = ReadBufferExtended(index, MAIN_FORKNUM, blkno,
197  RBM_NORMAL, info->strategy);
198  LockBuffer(buffer, BUFFER_LOCK_SHARE);
199  page = (Page) BufferGetPage(buffer);
200 
201  if (PageIsNew(page) || BloomPageIsDeleted(page))
202  {
203  RecordFreeIndexPage(index, blkno);
204  stats->pages_free++;
205  }
206  else
207  {
208  stats->num_index_tuples += BloomPageGetMaxOffset(page);
209  }
210 
211  UnlockReleaseBuffer(buffer);
212  }
213 
215 
216  return stats;
217 }
#define BloomPageIsDeleted(page)
Definition: bloom.h:63
bool analyze_only
Definition: genam.h:47
Buffer ReadBufferExtended(Relation reln, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy)
Definition: bufmgr.c:642
BufferAccessStrategy strategy
Definition: genam.h:52
Relation index
Definition: genam.h:46
uint32 BlockNumber
Definition: block.h:31
#define BLOOM_HEAD_BLKNO
Definition: bloom.h:78
Definition: type.h:89
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3388
BlockNumber num_pages
Definition: genam.h:74
BlockNumber pages_free
Definition: genam.h:80
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
void * palloc0(Size size)
Definition: mcxt.c:980
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3602
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:198
void IndexFreeSpaceMapVacuum(Relation rel)
Definition: indexfsm.c:71
#define PageIsNew(page)
Definition: bufpage.h:229
#define BloomPageGetMaxOffset(page)
Definition: bloom.h:60
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:87
void vacuum_delay_point(void)
Definition: vacuum.c:1940
void RecordFreeIndexPage(Relation rel, BlockNumber freeBlock)
Definition: indexfsm.c:52
double num_index_tuples
Definition: genam.h:77
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78

◆ blvalidate()

bool blvalidate ( Oid  opclassoid)

Definition at line 33 of file blvalidate.c.

References AMOPSTRATEGY, AMPROCNUM, BLOOM_HASH_PROC, BLOOM_NPROC, BLOOM_NSTRATEGIES, check_amop_signature(), check_amproc_signature(), CLAOID, elog, ereport, errcode(), errmsg(), ERROR, format_operator(), format_procedure(), OpFamilyOpFuncGroup::functionset, GETSTRUCT, HeapTupleIsValid, i, identify_opfamily_groups(), INFO, OpFamilyOpFuncGroup::lefttype, lfirst, catclist::members, catclist::n_members, NameStr, ObjectIdGetDatum, OidIsValid, OPFAMILYOID, ReleaseCatCacheList(), ReleaseSysCache(), OpFamilyOpFuncGroup::righttype, SearchSysCache1(), SearchSysCacheList1, and catctup::tuple.

Referenced by blhandler().

34 {
35  bool result = true;
36  HeapTuple classtup;
37  Form_pg_opclass classform;
38  Oid opfamilyoid;
39  Oid opcintype;
40  Oid opckeytype;
41  char *opclassname;
42  HeapTuple familytup;
43  Form_pg_opfamily familyform;
44  char *opfamilyname;
45  CatCList *proclist,
46  *oprlist;
47  List *grouplist;
48  OpFamilyOpFuncGroup *opclassgroup;
49  int i;
50  ListCell *lc;
51 
52  /* Fetch opclass information */
53  classtup = SearchSysCache1(CLAOID, ObjectIdGetDatum(opclassoid));
54  if (!HeapTupleIsValid(classtup))
55  elog(ERROR, "cache lookup failed for operator class %u", opclassoid);
56  classform = (Form_pg_opclass) GETSTRUCT(classtup);
57 
58  opfamilyoid = classform->opcfamily;
59  opcintype = classform->opcintype;
60  opckeytype = classform->opckeytype;
61  if (!OidIsValid(opckeytype))
62  opckeytype = opcintype;
63  opclassname = NameStr(classform->opcname);
64 
65  /* Fetch opfamily information */
66  familytup = SearchSysCache1(OPFAMILYOID, ObjectIdGetDatum(opfamilyoid));
67  if (!HeapTupleIsValid(familytup))
68  elog(ERROR, "cache lookup failed for operator family %u", opfamilyoid);
69  familyform = (Form_pg_opfamily) GETSTRUCT(familytup);
70 
71  opfamilyname = NameStr(familyform->opfname);
72 
73  /* Fetch all operators and support functions of the opfamily */
74  oprlist = SearchSysCacheList1(AMOPSTRATEGY, ObjectIdGetDatum(opfamilyoid));
75  proclist = SearchSysCacheList1(AMPROCNUM, ObjectIdGetDatum(opfamilyoid));
76 
77  /* Check individual support functions */
78  for (i = 0; i < proclist->n_members; i++)
79  {
80  HeapTuple proctup = &proclist->members[i]->tuple;
81  Form_pg_amproc procform = (Form_pg_amproc) GETSTRUCT(proctup);
82  bool ok;
83 
84  /*
85  * All bloom support functions should be registered with matching
86  * left/right types
87  */
88  if (procform->amproclefttype != procform->amprocrighttype)
89  {
90  ereport(INFO,
91  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
92  errmsg("bloom opfamily %s contains support procedure %s with cross-type registration",
93  opfamilyname,
94  format_procedure(procform->amproc))));
95  result = false;
96  }
97 
98  /*
99  * We can't check signatures except within the specific opclass, since
100  * we need to know the associated opckeytype in many cases.
101  */
102  if (procform->amproclefttype != opcintype)
103  continue;
104 
105  /* Check procedure numbers and function signatures */
106  switch (procform->amprocnum)
107  {
108  case BLOOM_HASH_PROC:
109  ok = check_amproc_signature(procform->amproc, INT4OID, false,
110  1, 1, opckeytype);
111  break;
112  default:
113  ereport(INFO,
114  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
115  errmsg("bloom opfamily %s contains function %s with invalid support number %d",
116  opfamilyname,
117  format_procedure(procform->amproc),
118  procform->amprocnum)));
119  result = false;
120  continue; /* don't want additional message */
121  }
122 
123  if (!ok)
124  {
125  ereport(INFO,
126  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
127  errmsg("gist opfamily %s contains function %s with wrong signature for support number %d",
128  opfamilyname,
129  format_procedure(procform->amproc),
130  procform->amprocnum)));
131  result = false;
132  }
133  }
134 
135  /* Check individual operators */
136  for (i = 0; i < oprlist->n_members; i++)
137  {
138  HeapTuple oprtup = &oprlist->members[i]->tuple;
139  Form_pg_amop oprform = (Form_pg_amop) GETSTRUCT(oprtup);
140 
141  /* Check it's allowed strategy for bloom */
142  if (oprform->amopstrategy < 1 ||
143  oprform->amopstrategy > BLOOM_NSTRATEGIES)
144  {
145  ereport(INFO,
146  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
147  errmsg("bloom opfamily %s contains operator %s with invalid strategy number %d",
148  opfamilyname,
149  format_operator(oprform->amopopr),
150  oprform->amopstrategy)));
151  result = false;
152  }
153 
154  /* bloom doesn't support ORDER BY operators */
155  if (oprform->amoppurpose != AMOP_SEARCH ||
156  OidIsValid(oprform->amopsortfamily))
157  {
158  ereport(INFO,
159  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
160  errmsg("bloom opfamily %s contains invalid ORDER BY specification for operator %s",
161  opfamilyname,
162  format_operator(oprform->amopopr))));
163  result = false;
164  }
165 
166  /* Check operator signature --- same for all bloom strategies */
167  if (!check_amop_signature(oprform->amopopr, BOOLOID,
168  oprform->amoplefttype,
169  oprform->amoprighttype))
170  {
171  ereport(INFO,
172  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
173  errmsg("bloom opfamily %s contains operator %s with wrong signature",
174  opfamilyname,
175  format_operator(oprform->amopopr))));
176  result = false;
177  }
178  }
179 
180  /* Now check for inconsistent groups of operators/functions */
181  grouplist = identify_opfamily_groups(oprlist, proclist);
182  opclassgroup = NULL;
183  foreach(lc, grouplist)
184  {
185  OpFamilyOpFuncGroup *thisgroup = (OpFamilyOpFuncGroup *) lfirst(lc);
186 
187  /* Remember the group exactly matching the test opclass */
188  if (thisgroup->lefttype == opcintype &&
189  thisgroup->righttype == opcintype)
190  opclassgroup = thisgroup;
191 
192  /*
193  * There is not a lot we can do to check the operator sets, since each
194  * bloom opclass is more or less a law unto itself, and some contain
195  * only operators that are binary-compatible with the opclass datatype
196  * (meaning that empty operator sets can be OK). That case also means
197  * that we shouldn't insist on nonempty function sets except for the
198  * opclass's own group.
199  */
200  }
201 
202  /* Check that the originally-named opclass is complete */
203  for (i = 1; i <= BLOOM_NPROC; i++)
204  {
205  if (opclassgroup &&
206  (opclassgroup->functionset & (((uint64) 1) << i)) != 0)
207  continue; /* got it */
208  ereport(INFO,
209  (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
210  errmsg("bloom opclass %s is missing support function %d",
211  opclassname, i)));
212  result = false;
213  }
214 
215  ReleaseCatCacheList(proclist);
216  ReleaseCatCacheList(oprlist);
217  ReleaseSysCache(familytup);
218  ReleaseSysCache(classtup);
219 
220  return result;
221 }
int n_members
Definition: catcache.h:176
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
FormData_pg_amproc * Form_pg_amproc
Definition: pg_amproc.h:68
#define BLOOM_NPROC
Definition: bloom.h:25
int errcode(int sqlerrcode)
Definition: elog.c:570
#define INFO
Definition: elog.h:33
char * format_operator(Oid operator_oid)
Definition: regproc.c:820
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:638
void ReleaseCatCacheList(CatCList *list)
Definition: catcache.c:1782
CatCTup * members[FLEXIBLE_ARRAY_MEMBER]
Definition: catcache.h:178
bool check_amproc_signature(Oid funcid, Oid restype, bool exact, int minargs, int maxargs,...)
Definition: amvalidate.c:150
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define ERROR
Definition: elog.h:43
List * identify_opfamily_groups(CatCList *oprlist, CatCList *proclist)
Definition: amvalidate.c:41
#define SearchSysCacheList1(cacheId, key1)
Definition: syscache.h:210
#define ereport(elevel, rest)
Definition: elog.h:141
#define BLOOM_NSTRATEGIES
Definition: bloom.h:29
HeapTuple SearchSysCache1(int cacheId, Datum key1)
Definition: syscache.c:1124
FormData_pg_opfamily * Form_pg_opfamily
Definition: pg_opfamily.h:51
void ReleaseSysCache(HeapTuple tuple)
Definition: syscache.c:1172
char * format_procedure(Oid procedure_oid)
Definition: regproc.c:323
#define HeapTupleIsValid(tuple)
Definition: htup.h:78
#define lfirst(lc)
Definition: pg_list.h:190
bool check_amop_signature(Oid opno, Oid restype, Oid lefttype, Oid righttype)
Definition: amvalidate.c:194
int errmsg(const char *fmt,...)
Definition: elog.c:784
FormData_pg_amop * Form_pg_amop
Definition: pg_amop.h:88
#define elog(elevel,...)
Definition: elog.h:226
int i
#define NameStr(name)
Definition: c.h:609
HeapTupleData tuple
Definition: catcache.h:121
FormData_pg_opclass * Form_pg_opclass
Definition: pg_opclass.h:83
Definition: pg_list.h:50
#define BLOOM_HASH_PROC
Definition: bloom.h:24

◆ initBloomState()

void initBloomState ( BloomState state,
Relation  index 
)

Definition at line 157 of file blutils.c.

References BLOOM_HASH_PROC, BLOOM_MAGICK_NUMBER, BLOOM_METAPAGE_BLKNO, BloomOptions::bloomLength, BloomPageGetMeta, BloomPageIsMeta, BLOOMTUPLEHDRSZ, BUFFER_LOCK_SHARE, BufferGetPage, BloomState::collations, CurrentMemoryContext, elog, ERROR, fmgr_info_copy(), BloomState::hashFn, i, index_getprocinfo(), LockBuffer(), BloomMetaPageData::magickNumber, MemoryContextAlloc(), TupleDescData::natts, BloomState::nColumns, BloomMetaPageData::opts, BloomState::opts, RelationData::rd_amcache, RelationData::rd_att, RelationData::rd_indcollation, RelationData::rd_indexcxt, ReadBuffer(), BloomState::sizeOfBloomTuple, and UnlockReleaseBuffer().

Referenced by blbeginscan(), blbuild(), blbulkdelete(), and blinsert().

158 {
159  int i;
160 
161  state->nColumns = index->rd_att->natts;
162 
163  /* Initialize hash function for each attribute */
164  for (i = 0; i < index->rd_att->natts; i++)
165  {
166  fmgr_info_copy(&(state->hashFn[i]),
167  index_getprocinfo(index, i + 1, BLOOM_HASH_PROC),
169  state->collations[i] = index->rd_indcollation[i];
170  }
171 
172  /* Initialize amcache if needed with options from metapage */
173  if (!index->rd_amcache)
174  {
175  Buffer buffer;
176  Page page;
177  BloomMetaPageData *meta;
178  BloomOptions *opts;
179 
180  opts = MemoryContextAlloc(index->rd_indexcxt, sizeof(BloomOptions));
181 
182  buffer = ReadBuffer(index, BLOOM_METAPAGE_BLKNO);
183  LockBuffer(buffer, BUFFER_LOCK_SHARE);
184 
185  page = BufferGetPage(buffer);
186 
187  if (!BloomPageIsMeta(page))
188  elog(ERROR, "Relation is not a bloom index");
189  meta = BloomPageGetMeta(BufferGetPage(buffer));
190 
191  if (meta->magickNumber != BLOOM_MAGICK_NUMBER)
192  elog(ERROR, "Relation is not a bloom index");
193 
194  *opts = meta->opts;
195 
196  UnlockReleaseBuffer(buffer);
197 
198  index->rd_amcache = (void *) opts;
199  }
200 
201  memcpy(&state->opts, index->rd_amcache, sizeof(state->opts));
203  sizeof(BloomSignatureWord) * state->opts.bloomLength;
204 }
#define BLOOM_METAPAGE_BLKNO
Definition: bloom.h:77
BloomOptions opts
Definition: bloom.h:141
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:794
#define BloomPageIsMeta(page)
Definition: bloom.h:61
FmgrInfo hashFn[INDEX_MAX_KEYS]
Definition: bloom.h:139
Oid collations[INDEX_MAX_KEYS]
Definition: bloom.h:140
uint16 BloomSignatureWord
Definition: bloom.h:83
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3388
Oid * rd_indcollation
Definition: rel.h:168
#define ERROR
Definition: elog.h:43
void fmgr_info_copy(FmgrInfo *dstinfo, FmgrInfo *srcinfo, MemoryContext destcxt)
Definition: fmgr.c:610
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define BloomPageGetMeta(page)
Definition: bloom.h:135
#define BLOOMTUPLEHDRSZ
Definition: bloom.h:165
BloomOptions opts
Definition: bloom.h:125
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3602
int32 nColumns
Definition: bloom.h:142
TupleDesc rd_att
Definition: rel.h:84
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
int bloomLength
Definition: bloom.h:103
uint32 magickNumber
Definition: bloom.h:122
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:796
#define elog(elevel,...)
Definition: elog.h:226
MemoryContext rd_indexcxt
Definition: rel.h:155
int i
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:87
void * rd_amcache
Definition: rel.h:179
#define BLOOM_MAGICK_NUMBER
Definition: bloom.h:130
Size sizeOfBloomTuple
Definition: bloom.h:148
int Buffer
Definition: buf.h:23
#define BLOOM_HASH_PROC
Definition: bloom.h:24
Pointer Page
Definition: bufpage.h:78

◆ signValue()

void signValue ( BloomState state,
BloomSignatureWord sign,
Datum  value,
int  attno 
)

Definition at line 256 of file blutils.c.

References BloomOptions::bitSize, BloomOptions::bloomLength, BloomState::collations, DatumGetInt32, FunctionCall1Coll(), BloomState::hashFn, myRand(), mySrand(), BloomState::opts, SETBIT, and SIGNWORDBITS.

Referenced by blgetbitmap(), and BloomFormTuple().

257 {
258  uint32 hashVal;
259  int nBit,
260  j;
261 
262  /*
263  * init generator with "column's" number to get "hashed" seed for new
264  * value. We don't want to map the same numbers from different columns
265  * into the same bits!
266  */
267  mySrand(attno);
268 
269  /*
270  * Init hash sequence to map our value into bits. the same values in
271  * different columns will be mapped into different bits because of step
272  * above
273  */
274  hashVal = DatumGetInt32(FunctionCall1Coll(&state->hashFn[attno], state->collations[attno], value));
275  mySrand(hashVal ^ myRand());
276 
277  for (j = 0; j < state->opts.bitSize[attno]; j++)
278  {
279  /* prevent multiple evaluation in SETBIT macro */
280  nBit = myRand() % (state->opts.bloomLength * SIGNWORDBITS);
281  SETBIT(sign, nBit);
282  }
283 }
#define SETBIT(x, i)
Definition: blutils.c:33
BloomOptions opts
Definition: bloom.h:141
#define DatumGetInt32(X)
Definition: postgres.h:472
FmgrInfo hashFn[INDEX_MAX_KEYS]
Definition: bloom.h:139
static struct @145 value
int bitSize[INDEX_MAX_KEYS]
Definition: bloom.h:104
Oid collations[INDEX_MAX_KEYS]
Definition: bloom.h:140
#define SIGNWORDBITS
Definition: bloom.h:85
char sign
Definition: informix.c:688
unsigned int uint32
Definition: c.h:358
Datum FunctionCall1Coll(FmgrInfo *flinfo, Oid collation, Datum arg1)
Definition: fmgr.c:1130
static int32 myRand(void)
Definition: blutils.c:218
static void mySrand(uint32 seed)
Definition: blutils.c:245
int bloomLength
Definition: bloom.h:103