PostgreSQL Source Code  git master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
blutils.c File Reference
#include "postgres.h"
#include "access/amapi.h"
#include "access/generic_xlog.h"
#include "catalog/index.h"
#include "storage/lmgr.h"
#include "miscadmin.h"
#include "storage/bufmgr.h"
#include "storage/indexfsm.h"
#include "utils/memutils.h"
#include "access/reloptions.h"
#include "storage/freespace.h"
#include "bloom.h"
Include dependency graph for blutils.c:

Go to the source code of this file.

Macros

#define GETWORD(x, i)   ( *( (BloomSignatureWord *)(x) + ( (i) / SIGNWORDBITS ) ) )
 
#define CLRBIT(x, i)   GETWORD(x,i) &= ~( 0x01 << ( (i) % SIGNWORDBITS ) )
 
#define SETBIT(x, i)   GETWORD(x,i) |= ( 0x01 << ( (i) % SIGNWORDBITS ) )
 
#define GETBIT(x, i)   ( (GETWORD(x,i) >> ( (i) % SIGNWORDBITS )) & 0x01 )
 

Functions

 PG_FUNCTION_INFO_V1 (blhandler)
 
static int32 myRand (void)
 
static void mySrand (uint32 seed)
 
void _PG_init (void)
 
static BloomOptionsmakeDefaultBloomOptions (void)
 
Datum blhandler (PG_FUNCTION_ARGS)
 
void initBloomState (BloomState *state, 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)
 
Buffer BloomNewBuffer (Relation index)
 
void BloomInitPage (Page page, uint16 flags)
 
void BloomFillMetapage (Relation index, Page metaPage)
 
void BloomInitMetapage (Relation index)
 
byteabloptions (Datum reloptions, bool validate)
 

Variables

static relopt_kind bl_relopt_kind
 
static relopt_parse_elt bl_relopt_tab [INDEX_MAX_KEYS+1]
 
static int32 next
 

Macro Definition Documentation

#define CLRBIT (   x,
  i 
)    GETWORD(x,i) &= ~( 0x01 << ( (i) % SIGNWORDBITS ) )

Definition at line 32 of file blutils.c.

Referenced by _hash_freeovflpage(), and hash_xlog_squeeze_page().

#define GETBIT (   x,
  i 
)    ( (GETWORD(x,i) >> ( (i) % SIGNWORDBITS )) & 0x01 )
#define GETWORD (   x,
  i 
)    ( *( (BloomSignatureWord *)(x) + ( (i) / SIGNWORDBITS ) ) )

Definition at line 31 of file blutils.c.

#define SETBIT (   x,
  i 
)    GETWORD(x,i) |= ( 0x01 << ( (i) % SIGNWORDBITS ) )

Definition at line 33 of file blutils.c.

Referenced by _hash_addovflpage(), hash_xlog_add_ovfl_page(), makesign(), and signValue().

Function Documentation

void _PG_init ( void  )

Definition at line 53 of file blutils.c.

References add_int_reloption(), add_reloption_kind(), bl_relopt_kind, buf, DEFAULT_BLOOM_BITS, DEFAULT_BLOOM_LENGTH, i, INDEX_MAX_KEYS, MAX_BLOOM_BITS, MAX_BLOOM_LENGTH, MemoryContextStrdup(), relopt_parse_elt::offset, offsetof, relopt_parse_elt::optname, relopt_parse_elt::opttype, RELOPT_TYPE_INT, snprintf(), and TopMemoryContext.

54 {
55  int i;
56  char buf[16];
57 
59 
60  /* Option for length of signature */
62  "Length of signature in bits",
64  bl_relopt_tab[0].optname = "length";
66  bl_relopt_tab[0].offset = offsetof(BloomOptions, bloomLength);
67 
68  /* Number of bits for each possible index column: col1, col2, ... */
69  for (i = 0; i < INDEX_MAX_KEYS; i++)
70  {
71  snprintf(buf, sizeof(buf), "col%d", i + 1);
73  "Number of bits generated for each index column",
76  buf);
78  bl_relopt_tab[i + 1].offset = offsetof(BloomOptions, bitSize[0]) + sizeof(int) * i;
79  }
80 }
relopt_type opttype
Definition: reloptions.h:126
#define MAX_BLOOM_LENGTH
Definition: bloom.h:91
#define DEFAULT_BLOOM_BITS
Definition: bloom.h:96
int snprintf(char *str, size_t count, const char *fmt,...) pg_attribute_printf(3
#define DEFAULT_BLOOM_LENGTH
Definition: bloom.h:90
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
static char * buf
Definition: pg_test_fsync.c:67
MemoryContext TopMemoryContext
Definition: mcxt.c:43
const char * optname
Definition: reloptions.h:125
#define INDEX_MAX_KEYS
relopt_kind add_reloption_kind(void)
Definition: reloptions.c:534
#define MAX_BLOOM_BITS
Definition: bloom.h:97
char * MemoryContextStrdup(MemoryContext context, const char *string)
Definition: mcxt.c:1063
int i
void add_int_reloption(bits32 kinds, char *name, char *desc, int default_val, int min_val, int max_val)
Definition: reloptions.c:649
#define offsetof(type, field)
Definition: c.h:549
Datum blhandler ( PG_FUNCTION_ARGS  )

Definition at line 105 of file blutils.c.

References IndexAmRoutine::ambeginscan, IndexAmRoutine::ambuild, IndexAmRoutine::ambuildempty, IndexAmRoutine::ambulkdelete, IndexAmRoutine::amcanbackward, IndexAmRoutine::amcanmulticol, IndexAmRoutine::amcanorder, IndexAmRoutine::amcanorderbyop, IndexAmRoutine::amcanparallel, IndexAmRoutine::amcanreturn, IndexAmRoutine::amcanunique, IndexAmRoutine::amclusterable, IndexAmRoutine::amcostestimate, IndexAmRoutine::amendscan, IndexAmRoutine::amestimateparallelscan, IndexAmRoutine::amgetbitmap, IndexAmRoutine::amgettuple, IndexAmRoutine::aminitparallelscan, IndexAmRoutine::aminsert, IndexAmRoutine::amkeytype, IndexAmRoutine::ammarkpos, IndexAmRoutine::amoptionalkey, IndexAmRoutine::amoptions, IndexAmRoutine::amparallelrescan, IndexAmRoutine::ampredlocks, IndexAmRoutine::amproperty, IndexAmRoutine::amrescan, IndexAmRoutine::amrestrpos, IndexAmRoutine::amsearcharray, IndexAmRoutine::amsearchnulls, IndexAmRoutine::amstorage, IndexAmRoutine::amstrategies, IndexAmRoutine::amsupport, IndexAmRoutine::amvacuumcleanup, IndexAmRoutine::amvalidate, blbeginscan(), blbuild(), blbuildempty(), blbulkdelete(), blcostestimate(), blendscan(), blgetbitmap(), blinsert(), BLOOM_NPROC, BLOOM_NSTRATEGIES, bloptions(), blrescan(), blvacuumcleanup(), blvalidate(), InvalidOid, makeNode, and PG_RETURN_POINTER.

106 {
107  IndexAmRoutine *amroutine = makeNode(IndexAmRoutine);
108 
109  amroutine->amstrategies = BLOOM_NSTRATEGIES;
110  amroutine->amsupport = BLOOM_NPROC;
111  amroutine->amcanorder = false;
112  amroutine->amcanorderbyop = false;
113  amroutine->amcanbackward = false;
114  amroutine->amcanunique = false;
115  amroutine->amcanmulticol = true;
116  amroutine->amoptionalkey = true;
117  amroutine->amsearcharray = false;
118  amroutine->amsearchnulls = false;
119  amroutine->amstorage = false;
120  amroutine->amclusterable = false;
121  amroutine->ampredlocks = false;
122  amroutine->amcanparallel = false;
123  amroutine->amkeytype = InvalidOid;
124 
125  amroutine->ambuild = blbuild;
126  amroutine->ambuildempty = blbuildempty;
127  amroutine->aminsert = blinsert;
128  amroutine->ambulkdelete = blbulkdelete;
129  amroutine->amvacuumcleanup = blvacuumcleanup;
130  amroutine->amcanreturn = NULL;
131  amroutine->amcostestimate = blcostestimate;
132  amroutine->amoptions = bloptions;
133  amroutine->amproperty = NULL;
134  amroutine->amvalidate = blvalidate;
135  amroutine->ambeginscan = blbeginscan;
136  amroutine->amrescan = blrescan;
137  amroutine->amgettuple = NULL;
138  amroutine->amgetbitmap = blgetbitmap;
139  amroutine->amendscan = blendscan;
140  amroutine->ammarkpos = NULL;
141  amroutine->amrestrpos = NULL;
142  amroutine->amestimateparallelscan = NULL;
143  amroutine->aminitparallelscan = NULL;
144  amroutine->amparallelrescan = NULL;
145 
146  PG_RETURN_POINTER(amroutine);
147 }
ambeginscan_function ambeginscan
Definition: amapi.h:208
#define PG_RETURN_POINTER(x)
Definition: fmgr.h:321
ambulkdelete_function ambulkdelete
Definition: amapi.h:201
bool amcanmulticol
Definition: amapi.h:179
uint16 amsupport
Definition: amapi.h:169
IndexBuildResult * blbuild(Relation heap, Relation index, IndexInfo *indexInfo)
Definition: blinsert.c:115
amgettuple_function amgettuple
Definition: amapi.h:210
bool amcanorderbyop
Definition: amapi.h:173
amproperty_function amproperty
Definition: amapi.h:206
amparallelrescan_function amparallelrescan
Definition: amapi.h:219
#define BLOOM_NPROC
Definition: bloom.h:25
bool amstorage
Definition: amapi.h:187
bool ampredlocks
Definition: amapi.h:191
aminsert_function aminsert
Definition: amapi.h:200
Oid amkeytype
Definition: amapi.h:195
void blcostestimate(PlannerInfo *root, IndexPath *path, double loop_count, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, double *indexCorrelation, double *indexPages)
Definition: blcost.c:25
bool amoptionalkey
Definition: amapi.h:181
amvalidate_function amvalidate
Definition: amapi.h:207
IndexBulkDeleteResult * blvacuumcleanup(IndexVacuumInfo *info, IndexBulkDeleteResult *stats)
Definition: blvacuum.c:169
bool blvalidate(Oid opclassoid)
Definition: blvalidate.c:33
void blendscan(IndexScanDesc scan)
Definition: blscan.c:69
amgetbitmap_function amgetbitmap
Definition: amapi.h:211
ambuild_function ambuild
Definition: amapi.h:198
amoptions_function amoptions
Definition: amapi.h:205
amcostestimate_function amcostestimate
Definition: amapi.h:204
bool amcanunique
Definition: amapi.h:177
IndexBulkDeleteResult * blbulkdelete(IndexVacuumInfo *info, IndexBulkDeleteResult *stats, IndexBulkDeleteCallback callback, void *callback_state)
Definition: blvacuum.c:34
amvacuumcleanup_function amvacuumcleanup
Definition: amapi.h:202
amendscan_function amendscan
Definition: amapi.h:212
bool amcanbackward
Definition: amapi.h:175
int64 blgetbitmap(IndexScanDesc scan, TIDBitmap *tbm)
Definition: blscan.c:82
amrescan_function amrescan
Definition: amapi.h:209
bool amcanparallel
Definition: amapi.h:193
#define BLOOM_NSTRATEGIES
Definition: bloom.h:29
bool amsearchnulls
Definition: amapi.h:185
void blrescan(IndexScanDesc scan, ScanKey scankey, int nscankeys, ScanKey orderbys, int norderbys)
Definition: blscan.c:49
bool amclusterable
Definition: amapi.h:189
bool amsearcharray
Definition: amapi.h:183
#define InvalidOid
Definition: postgres_ext.h:36
#define makeNode(_type_)
Definition: nodes.h:558
bool blinsert(Relation index, Datum *values, bool *isnull, ItemPointer ht_ctid, Relation heapRel, IndexUniqueCheck checkUnique, IndexInfo *indexInfo)
Definition: blinsert.c:192
ammarkpos_function ammarkpos
Definition: amapi.h:213
bool amcanorder
Definition: amapi.h:171
amestimateparallelscan_function amestimateparallelscan
Definition: amapi.h:217
void blbuildempty(Relation index)
Definition: blinsert.c:159
uint16 amstrategies
Definition: amapi.h:167
IndexScanDesc blbeginscan(Relation r, int nkeys, int norderbys)
Definition: blscan.c:29
ambuildempty_function ambuildempty
Definition: amapi.h:199
bytea * bloptions(Datum reloptions, bool validate)
Definition: blutils.c:473
amcanreturn_function amcanreturn
Definition: amapi.h:203
aminitparallelscan_function aminitparallelscan
Definition: amapi.h:218
amrestrpos_function amrestrpos
Definition: amapi.h:214
void BloomFillMetapage ( Relation  index,
Page  metaPage 
)

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

415 {
416  BloomOptions *opts;
417  BloomMetaPageData *metadata;
418 
419  /*
420  * Choose the index's options. If reloptions have been assigned, use
421  * those, otherwise create default options.
422  */
423  opts = (BloomOptions *) index->rd_options;
424  if (!opts)
425  opts = makeDefaultBloomOptions();
426 
427  /*
428  * Initialize contents of meta page, including a copy of the options,
429  * which are now frozen for the life of the index.
430  */
431  BloomInitPage(metaPage, BLOOM_META);
432  metadata = BloomPageGetMeta(metaPage);
433  memset(metadata, 0, sizeof(BloomMetaPageData));
434  metadata->magickNumber = BLOOM_MAGICK_NUMBER;
435  metadata->opts = *opts;
436  ((PageHeader) metaPage)->pd_lower += sizeof(BloomMetaPageData);
437 
438  /* If this fails, probably FreeBlockNumberArray size calc is wrong: */
439  Assert(((PageHeader) metaPage)->pd_lower <= ((PageHeader) metaPage)->pd_upper);
440 }
static BloomOptions * makeDefaultBloomOptions(void)
Definition: blutils.c:86
#define BloomPageGetMeta(page)
Definition: bloom.h:135
BloomOptions opts
Definition: bloom.h:125
PageHeaderData * PageHeader
Definition: bufpage.h:162
#define Assert(condition)
Definition: c.h:681
uint32 magickNumber
Definition: bloom.h:122
void BloomInitPage(Page page, uint16 flags)
Definition: blutils.c:398
#define BLOOM_META
Definition: bloom.h:45
struct BloomMetaPageData BloomMetaPageData
#define BLOOM_MAGICK_NUMBER
Definition: bloom.h:130
bytea * rd_options
Definition: rel.h:156
BloomTuple* BloomFormTuple ( BloomState state,
ItemPointer  iptr,
Datum values,
bool isnull 
)

Definition at line 284 of file blutils.c.

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

Referenced by blinsert(), and bloomBuildCallback().

285 {
286  int i;
287  BloomTuple *res = (BloomTuple *) palloc0(state->sizeOfBloomTuple);
288 
289  res->heapPtr = *iptr;
290 
291  /* Blooming each column */
292  for (i = 0; i < state->nColumns; i++)
293  {
294  /* skip nulls */
295  if (isnull[i])
296  continue;
297 
298  signValue(state, res->sign, values[i], i);
299  }
300 
301  return res;
302 }
void * palloc0(Size size)
Definition: mcxt.c:877
void signValue(BloomState *state, BloomSignatureWord *sign, Datum value, int attno)
Definition: blutils.c:251
int32 nColumns
Definition: bloom.h:141
BloomSignatureWord sign[FLEXIBLE_ARRAY_MEMBER]
Definition: bloom.h:161
static Datum values[MAXATTR]
Definition: bootstrap.c:164
ItemPointerData heapPtr
Definition: bloom.h:160
int i
Size sizeOfBloomTuple
Definition: bloom.h:147
void BloomInitMetapage ( Relation  index)

Definition at line 446 of file blutils.c.

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

Referenced by blbuild().

447 {
448  Buffer metaBuffer;
449  Page metaPage;
451 
452  /*
453  * Make a new page; since it is first page it should be associated with
454  * block number 0 (BLOOM_METAPAGE_BLKNO).
455  */
456  metaBuffer = BloomNewBuffer(index);
458 
459  /* Initialize contents of meta page */
460  state = GenericXLogStart(index);
461  metaPage = GenericXLogRegisterBuffer(state, metaBuffer,
463  BloomFillMetapage(index, metaPage);
464  GenericXLogFinish(state);
465 
466  UnlockReleaseBuffer(metaBuffer);
467 }
#define BLOOM_METAPAGE_BLKNO
Definition: bloom.h:77
Page GenericXLogRegisterBuffer(GenericXLogState *state, Buffer buffer, int flags)
Definition: generic_xlog.c:298
Buffer BloomNewBuffer(Relation index)
Definition: blutils.c:344
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3332
void BloomFillMetapage(Relation index, Page metaPage)
Definition: blutils.c:414
#define Assert(condition)
Definition: c.h:681
Definition: regguts.h:298
XLogRecPtr GenericXLogFinish(GenericXLogState *state)
Definition: generic_xlog.c:336
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2605
int Buffer
Definition: buf.h:23
#define GENERIC_XLOG_FULL_IMAGE
Definition: generic_xlog.h:26
GenericXLogState * GenericXLogStart(Relation relation)
Definition: generic_xlog.c:270
Pointer Page
Definition: bufpage.h:74
void BloomInitPage ( Page  page,
uint16  flags 
)

Definition at line 398 of file blutils.c.

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

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

399 {
400  BloomPageOpaque opaque;
401 
402  PageInit(page, BLCKSZ, sizeof(BloomPageOpaqueData));
403 
404  opaque = BloomPageGetOpaque(page);
405  memset(opaque, 0, sizeof(BloomPageOpaqueData));
406  opaque->flags = flags;
407  opaque->bloom_page_id = BLOOM_PAGE_ID;
408 }
#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:41
Buffer BloomNewBuffer ( Relation  index)

Definition at line 344 of file blutils.c.

References BloomPageIsDeleted, buffer, 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().

345 {
346  Buffer buffer;
347  bool needLock;
348 
349  /* First, try to get a page from FSM */
350  for (;;)
351  {
352  BlockNumber blkno = GetFreeIndexPage(index);
353 
354  if (blkno == InvalidBlockNumber)
355  break;
356 
357  buffer = ReadBuffer(index, blkno);
358 
359  /*
360  * We have to guard against the possibility that someone else already
361  * recycled this page; the buffer may be locked if so.
362  */
363  if (ConditionalLockBuffer(buffer))
364  {
365  Page page = BufferGetPage(buffer);
366 
367  if (PageIsNew(page))
368  return buffer; /* OK to use, if never initialized */
369 
370  if (BloomPageIsDeleted(page))
371  return buffer; /* OK to use */
372 
374  }
375 
376  /* Can't use it, so release buffer and try again */
377  ReleaseBuffer(buffer);
378  }
379 
380  /* Must extend the file */
381  needLock = !RELATION_IS_LOCAL(index);
382  if (needLock)
384 
385  buffer = ReadBuffer(index, P_NEW);
387 
388  if (needLock)
390 
391  return buffer;
392 }
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:87
#define BloomPageIsDeleted(page)
Definition: bloom.h:63
#define ExclusiveLock
Definition: lockdefs.h:44
#define RELATION_IS_LOCAL(relation)
Definition: rel.h:523
uint32 BlockNumber
Definition: block.h:31
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3309
#define P_NEW
Definition: bufmgr.h:82
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:89
#define BufferGetPage(buffer)
Definition: bufmgr.h:160
bool ConditionalLockBuffer(Buffer buffer)
Definition: bufmgr.c:3572
void LockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:332
void UnlockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:382
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3546
BlockNumber GetFreeIndexPage(Relation rel)
Definition: indexfsm.c:38
WalTimeSample buffer[LAG_TRACKER_BUFFER_SIZE]
Definition: walsender.c:214
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:594
#define InvalidBlockNumber
Definition: block.h:33
#define PageIsNew(page)
Definition: bufpage.h:225
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:74
bool BloomPageAddItem ( BloomState state,
Page  page,
BloomTuple tuple 
)

Definition at line 309 of file blutils.c.

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

Referenced by blinsert(), and bloomBuildCallback().

310 {
311  BloomTuple *itup;
312  BloomPageOpaque opaque;
313  Pointer ptr;
314 
315  /* We shouldn't be pointed to an invalid page */
316  Assert(!PageIsNew(page) && !BloomPageIsDeleted(page));
317 
318  /* Does new tuple fit on the page? */
319  if (BloomPageGetFreeSpace(state, page) < state->sizeOfBloomTuple)
320  return false;
321 
322  /* Copy new tuple to the end of page */
323  opaque = BloomPageGetOpaque(page);
324  itup = BloomPageGetTuple(state, page, opaque->maxoff + 1);
325  memcpy((Pointer) itup, (Pointer) tuple, state->sizeOfBloomTuple);
326 
327  /* Adjust maxoff and pd_lower */
328  opaque->maxoff++;
329  ptr = (Pointer) BloomPageGetTuple(state, page, opaque->maxoff + 1);
330  ((PageHeader) page)->pd_lower = ptr - page;
331 
332  /* Assert we didn't overrun available space */
333  Assert(((PageHeader) page)->pd_lower <= ((PageHeader) page)->pd_upper);
334 
335  return true;
336 }
#define BloomPageIsDeleted(page)
Definition: bloom.h:63
OffsetNumber maxoff
Definition: bloom.h:34
char * Pointer
Definition: c.h:235
#define BloomPageGetOpaque(page)
Definition: bloom.h:59
#define BloomPageGetFreeSpace(state, page)
Definition: bloom.h:150
#define BloomPageGetTuple(state, page, offset)
Definition: bloom.h:70
PageHeaderData * PageHeader
Definition: bufpage.h:162
#define Assert(condition)
Definition: c.h:681
#define PageIsNew(page)
Definition: bufpage.h:225
Size sizeOfBloomTuple
Definition: bloom.h:147
bytea* bloptions ( Datum  reloptions,
bool  validate 
)

Definition at line 473 of file blutils.c.

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

Referenced by blhandler().

474 {
476  int numoptions;
477  BloomOptions *rdopts;
478 
479  /* Parse the user-given reloptions */
480  options = parseRelOptions(reloptions, validate, bl_relopt_kind, &numoptions);
481  rdopts = allocateReloptStruct(sizeof(BloomOptions), options, numoptions);
482  fillRelOptions((void *) rdopts, sizeof(BloomOptions), options, numoptions,
483  validate, bl_relopt_tab, lengthof(bl_relopt_tab));
484 
485  /* Convert signature length from # of bits to # to words, rounding up */
486  rdopts->bloomLength = (rdopts->bloomLength + SIGNWORDBITS - 1) / SIGNWORDBITS;
487 
488  return (bytea *) rdopts;
489 }
#define lengthof(array)
Definition: c.h:556
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:1215
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:1239
int bloomLength
Definition: bloom.h:103
Definition: c.h:433
relopt_value * parseRelOptions(Datum options, bool validate, relopt_kind kind, int *numrelopts)
Definition: reloptions.c:1020
void initBloomState ( BloomState state,
Relation  index 
)

Definition at line 153 of file blutils.c.

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

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

154 {
155  int i;
156 
157  state->nColumns = index->rd_att->natts;
158 
159  /* Initialize hash function for each attribute */
160  for (i = 0; i < index->rd_att->natts; i++)
161  {
162  fmgr_info_copy(&(state->hashFn[i]),
163  index_getprocinfo(index, i + 1, BLOOM_HASH_PROC),
165  }
166 
167  /* Initialize amcache if needed with options from metapage */
168  if (!index->rd_amcache)
169  {
170  Buffer buffer;
171  Page page;
172  BloomMetaPageData *meta;
173  BloomOptions *opts;
174 
175  opts = MemoryContextAlloc(index->rd_indexcxt, sizeof(BloomOptions));
176 
177  buffer = ReadBuffer(index, BLOOM_METAPAGE_BLKNO);
178  LockBuffer(buffer, BUFFER_LOCK_SHARE);
179 
180  page = BufferGetPage(buffer);
181 
182  if (!BloomPageIsMeta(page))
183  elog(ERROR, "Relation is not a bloom index");
184  meta = BloomPageGetMeta(BufferGetPage(buffer));
185 
186  if (meta->magickNumber != BLOOM_MAGICK_NUMBER)
187  elog(ERROR, "Relation is not a bloom index");
188 
189  *opts = meta->opts;
190 
191  UnlockReleaseBuffer(buffer);
192 
193  index->rd_amcache = (void *) opts;
194  }
195 
196  memcpy(&state->opts, index->rd_amcache, sizeof(state->opts));
198  sizeof(BloomSignatureWord) * state->opts.bloomLength;
199 }
#define BLOOM_METAPAGE_BLKNO
Definition: bloom.h:77
BloomOptions opts
Definition: bloom.h:140
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:855
#define BloomPageIsMeta(page)
Definition: bloom.h:61
FmgrInfo hashFn[INDEX_MAX_KEYS]
Definition: bloom.h:139
int natts
Definition: tupdesc.h:73
uint16 BloomSignatureWord
Definition: bloom.h:83
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3332
#define ERROR
Definition: elog.h:43
void fmgr_info_copy(FmgrInfo *dstinfo, FmgrInfo *srcinfo, MemoryContext destcxt)
Definition: fmgr.c:519
MemoryContext CurrentMemoryContext
Definition: mcxt.c:37
#define BufferGetPage(buffer)
Definition: bufmgr.h:160
#define BloomPageGetMeta(page)
Definition: bloom.h:135
#define BLOOMTUPLEHDRSZ
Definition: bloom.h:164
BloomOptions opts
Definition: bloom.h:125
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3546
int32 nColumns
Definition: bloom.h:141
TupleDesc rd_att
Definition: rel.h:115
WalTimeSample buffer[LAG_TRACKER_BUFFER_SIZE]
Definition: walsender.c:214
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:594
int bloomLength
Definition: bloom.h:103
uint32 magickNumber
Definition: bloom.h:122
void * MemoryContextAlloc(MemoryContext context, Size size)
Definition: mcxt.c:706
MemoryContext rd_indexcxt
Definition: rel.h:179
int i
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:88
#define elog
Definition: elog.h:219
void * rd_amcache
Definition: rel.h:192
#define BLOOM_MAGICK_NUMBER
Definition: bloom.h:130
Size sizeOfBloomTuple
Definition: bloom.h:147
int Buffer
Definition: buf.h:23
#define BLOOM_HASH_PROC
Definition: bloom.h:24
Pointer Page
Definition: bufpage.h:74
static BloomOptions* makeDefaultBloomOptions ( void  )
static

Definition at line 86 of file blutils.c.

References BloomOptions::bitSize, BloomOptions::bloomLength, DEFAULT_BLOOM_BITS, DEFAULT_BLOOM_LENGTH, i, INDEX_MAX_KEYS, palloc0(), SET_VARSIZE, and SIGNWORDBITS.

Referenced by BloomFillMetapage().

87 {
88  BloomOptions *opts;
89  int i;
90 
91  opts = (BloomOptions *) palloc0(sizeof(BloomOptions));
92  /* Convert DEFAULT_BLOOM_LENGTH from # of bits to # of words */
94  for (i = 0; i < INDEX_MAX_KEYS; i++)
95  opts->bitSize[i] = DEFAULT_BLOOM_BITS;
96  SET_VARSIZE(opts, sizeof(BloomOptions));
97  return opts;
98 }
#define DEFAULT_BLOOM_BITS
Definition: bloom.h:96
int bitSize[INDEX_MAX_KEYS]
Definition: bloom.h:104
#define DEFAULT_BLOOM_LENGTH
Definition: bloom.h:90
#define SIGNWORDBITS
Definition: bloom.h:85
void * palloc0(Size size)
Definition: mcxt.c:877
#define INDEX_MAX_KEYS
int bloomLength
Definition: bloom.h:103
int i
#define SET_VARSIZE(PTR, len)
Definition: postgres.h:328
static int32 myRand ( void  )
static

Definition at line 213 of file blutils.c.

References next.

Referenced by signValue().

214 {
215  /*----------
216  * Compute x = (7^5 * x) mod (2^31 - 1)
217  * without overflowing 31 bits:
218  * (2^31 - 1) = 127773 * (7^5) + 2836
219  * From "Random number generators: good ones are hard to find",
220  * Park and Miller, Communications of the ACM, vol. 31, no. 10,
221  * October 1988, p. 1195.
222  *----------
223  */
224  int32 hi,
225  lo,
226  x;
227 
228  /* Must be in [1, 0x7ffffffe] range at this point. */
229  hi = next / 127773;
230  lo = next % 127773;
231  x = 16807 * lo - 2836 * hi;
232  if (x < 0)
233  x += 0x7fffffff;
234  next = x;
235  /* Transform to [0, 0x7ffffffd] range. */
236  return (x - 1);
237 }
static int32 next
Definition: blutils.c:210
signed int int32
Definition: c.h:246
static void mySrand ( uint32  seed)
static

Definition at line 240 of file blutils.c.

References next.

Referenced by signValue().

241 {
242  next = seed;
243  /* Transform to [1, 0x7ffffffe] range. */
244  next = (next % 0x7ffffffe) + 1;
245 }
static int32 next
Definition: blutils.c:210
PG_FUNCTION_INFO_V1 ( blhandler  )
void signValue ( BloomState state,
BloomSignatureWord sign,
Datum  value,
int  attno 
)

Definition at line 251 of file blutils.c.

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

Referenced by blgetbitmap(), and BloomFormTuple().

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

Variable Documentation

relopt_kind bl_relopt_kind
static

Definition at line 39 of file blutils.c.

Referenced by _PG_init(), and bloptions().

relopt_parse_elt bl_relopt_tab[INDEX_MAX_KEYS+1]
static

Definition at line 42 of file blutils.c.

int32 next
static

Definition at line 210 of file blutils.c.

Referenced by addItemsToLeaf(), addKey(), AllocSetDelete(), AllocSetReset(), AlterTSDictionary(), AtEOSubXact_SPI(), AtSubAbort_Snapshot(), cipher_free_callback(), create_nestloop_plan(), deallocate_one(), delete_item_from_bucket(), delete_key_from_bucket(), digest_free_callback(), do_setval(), dsa_trim(), ECPGconnect(), filemap_list_to_array(), find_struct(), find_struct_member(), find_variable(), FreePageManagerGetInternal(), FreePagePopSpanLeader(), get_best_segment(), get_foreign_key_join_selectivity(), get_source_line(), get_typedef(), getNextFlagFromString(), GinDataLeafPageGetItems(), heap_lock_updated_tuple_rec(), infer_arbiter_indexes(), IssuePendingWritebacks(), LagTrackerRead(), main(), make_new_segment(), merge_children(), MergeAttributes(), myRand(), mySrand(), nextval_internal(), pg_event_trigger_dropped_objects(), plpgsql_destroy_econtext(), plpgsql_subxact_cb(), PLySequence_ToArray(), PostPrepare_smgr(), prepare_common(), pushf_create(), reconsider_outer_join_clauses(), reduce_unique_semijoins(), RelationPreserveStorage(), RememberFsyncRequest(), ReorderBufferIterTXNNext(), select_active_windows(), sepgsql_avc_reclaim(), sepgsql_subxact_callback(), SetClientEncoding(), setCompoundAffixFlagValue(), setval3_oid(), setval_oid(), smgrDoPendingDeletes(), SPI_freetuptable(), StandbyReleaseAllLocks(), StandbyReleaseLocks(), StandbyReleaseOldLocks(), SyncRepGetSyncStandbysPriority(), unicode_normalize_kc(), unlink_segment(), and unlink_span().