PostgreSQL Source Code  git master
blinsert.c
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * blinsert.c
4  * Bloom index build and insert functions.
5  *
6  * Copyright (c) 2016-2024, PostgreSQL Global Development Group
7  *
8  * IDENTIFICATION
9  * contrib/bloom/blinsert.c
10  *
11  *-------------------------------------------------------------------------
12  */
13 #include "postgres.h"
14 
15 #include "access/genam.h"
16 #include "access/generic_xlog.h"
17 #include "access/tableam.h"
18 #include "bloom.h"
19 #include "catalog/index.h"
20 #include "miscadmin.h"
21 #include "storage/bufmgr.h"
22 #include "storage/indexfsm.h"
23 #include "storage/smgr.h"
24 #include "utils/memutils.h"
25 #include "utils/rel.h"
26 
28 
29 /*
30  * State of bloom index build. We accumulate one page data here before
31  * flushing it to buffer manager.
32  */
33 typedef struct
34 {
35  BloomState blstate; /* bloom index state */
36  int64 indtuples; /* total number of tuples indexed */
37  MemoryContext tmpCtx; /* temporary memory context reset after each
38  * tuple */
39  PGAlignedBlock data; /* cached page */
40  int count; /* number of tuples in cached page */
42 
43 /*
44  * Flush page cached in BloomBuildState.
45  */
46 static void
48 {
49  Page page;
50  Buffer buffer = BloomNewBuffer(index);
52 
55  memcpy(page, buildstate->data.data, BLCKSZ);
57  UnlockReleaseBuffer(buffer);
58 }
59 
60 /*
61  * (Re)initialize cached page in BloomBuildState.
62  */
63 static void
65 {
66  BloomInitPage(buildstate->data.data, 0);
67  buildstate->count = 0;
68 }
69 
70 /*
71  * Per-tuple callback for table_index_build_scan.
72  */
73 static void
75  bool *isnull, bool tupleIsAlive, void *state)
76 {
77  BloomBuildState *buildstate = (BloomBuildState *) state;
78  MemoryContext oldCtx;
79  BloomTuple *itup;
80 
81  oldCtx = MemoryContextSwitchTo(buildstate->tmpCtx);
82 
83  itup = BloomFormTuple(&buildstate->blstate, tid, values, isnull);
84 
85  /* Try to add next item to cached page */
86  if (BloomPageAddItem(&buildstate->blstate, buildstate->data.data, itup))
87  {
88  /* Next item was added successfully */
89  buildstate->count++;
90  }
91  else
92  {
93  /* Cached page is full, flush it out and make a new one */
94  flushCachedPage(index, buildstate);
95 
97 
98  initCachedPage(buildstate);
99 
100  if (!BloomPageAddItem(&buildstate->blstate, buildstate->data.data, itup))
101  {
102  /* We shouldn't be here since we're inserting to the empty page */
103  elog(ERROR, "could not add new bloom tuple to empty page");
104  }
105 
106  /* Next item was added successfully */
107  buildstate->count++;
108  }
109 
110  /* Update total tuple count */
111  buildstate->indtuples += 1;
112 
113  MemoryContextSwitchTo(oldCtx);
114  MemoryContextReset(buildstate->tmpCtx);
115 }
116 
117 /*
118  * Build a new bloom index.
119  */
122 {
123  IndexBuildResult *result;
124  double reltuples;
125  BloomBuildState buildstate;
126 
128  elog(ERROR, "index \"%s\" already contains data",
130 
131  /* Initialize the meta page */
133 
134  /* Initialize the bloom build state */
135  memset(&buildstate, 0, sizeof(buildstate));
136  initBloomState(&buildstate.blstate, index);
138  "Bloom build temporary context",
140  initCachedPage(&buildstate);
141 
142  /* Do the heap scan */
143  reltuples = table_index_build_scan(heap, index, indexInfo, true, true,
144  bloomBuildCallback, (void *) &buildstate,
145  NULL);
146 
147  /* Flush last page if needed (it will be, unless heap was empty) */
148  if (buildstate.count > 0)
149  flushCachedPage(index, &buildstate);
150 
151  MemoryContextDelete(buildstate.tmpCtx);
152 
153  result = (IndexBuildResult *) palloc(sizeof(IndexBuildResult));
154  result->heap_tuples = reltuples;
155  result->index_tuples = buildstate.indtuples;
156 
157  return result;
158 }
159 
160 /*
161  * Build an empty bloom index in the initialization fork.
162  */
163 void
165 {
166  /* Initialize the meta page */
168 }
169 
170 /*
171  * Insert new tuple to the bloom index.
172  */
173 bool
175  ItemPointer ht_ctid, Relation heapRel,
176  IndexUniqueCheck checkUnique,
177  bool indexUnchanged,
178  IndexInfo *indexInfo)
179 {
180  BloomState blstate;
181  BloomTuple *itup;
182  MemoryContext oldCtx;
183  MemoryContext insertCtx;
184  BloomMetaPageData *metaData;
185  Buffer buffer,
186  metaBuffer;
187  Page page,
188  metaPage;
190  OffsetNumber nStart;
192 
194  "Bloom insert temporary context",
196 
197  oldCtx = MemoryContextSwitchTo(insertCtx);
198 
199  initBloomState(&blstate, index);
200  itup = BloomFormTuple(&blstate, ht_ctid, values, isnull);
201 
202  /*
203  * At first, try to insert new tuple to the first page in notFullPage
204  * array. If successful, we don't need to modify the meta page.
205  */
206  metaBuffer = ReadBuffer(index, BLOOM_METAPAGE_BLKNO);
207  LockBuffer(metaBuffer, BUFFER_LOCK_SHARE);
208  metaData = BloomPageGetMeta(BufferGetPage(metaBuffer));
209 
210  if (metaData->nEnd > metaData->nStart)
211  {
212  blkno = metaData->notFullPage[metaData->nStart];
213  Assert(blkno != InvalidBlockNumber);
214 
215  /* Don't hold metabuffer lock while doing insert */
216  LockBuffer(metaBuffer, BUFFER_LOCK_UNLOCK);
217 
218  buffer = ReadBuffer(index, blkno);
220 
222  page = GenericXLogRegisterBuffer(state, buffer, 0);
223 
224  /*
225  * We might have found a page that was recently deleted by VACUUM. If
226  * so, we can reuse it, but we must reinitialize it.
227  */
228  if (PageIsNew(page) || BloomPageIsDeleted(page))
229  BloomInitPage(page, 0);
230 
231  if (BloomPageAddItem(&blstate, page, itup))
232  {
233  /* Success! Apply the change, clean up, and exit */
235  UnlockReleaseBuffer(buffer);
236  ReleaseBuffer(metaBuffer);
237  MemoryContextSwitchTo(oldCtx);
238  MemoryContextDelete(insertCtx);
239  return false;
240  }
241 
242  /* Didn't fit, must try other pages */
244  UnlockReleaseBuffer(buffer);
245  }
246  else
247  {
248  /* No entries in notFullPage */
249  LockBuffer(metaBuffer, BUFFER_LOCK_UNLOCK);
250  }
251 
252  /*
253  * Try other pages in notFullPage array. We will have to change nStart in
254  * metapage. Thus, grab exclusive lock on metapage.
255  */
256  LockBuffer(metaBuffer, BUFFER_LOCK_EXCLUSIVE);
257 
258  /* nStart might have changed while we didn't have lock */
259  nStart = metaData->nStart;
260 
261  /* Skip first page if we already tried it above */
262  if (nStart < metaData->nEnd &&
263  blkno == metaData->notFullPage[nStart])
264  nStart++;
265 
266  /*
267  * This loop iterates for each page we try from the notFullPage array, and
268  * will also initialize a GenericXLogState for the fallback case of having
269  * to allocate a new page.
270  */
271  for (;;)
272  {
274 
275  /* get modifiable copy of metapage */
276  metaPage = GenericXLogRegisterBuffer(state, metaBuffer, 0);
277  metaData = BloomPageGetMeta(metaPage);
278 
279  if (nStart >= metaData->nEnd)
280  break; /* no more entries in notFullPage array */
281 
282  blkno = metaData->notFullPage[nStart];
283  Assert(blkno != InvalidBlockNumber);
284 
285  buffer = ReadBuffer(index, blkno);
287  page = GenericXLogRegisterBuffer(state, buffer, 0);
288 
289  /* Basically same logic as above */
290  if (PageIsNew(page) || BloomPageIsDeleted(page))
291  BloomInitPage(page, 0);
292 
293  if (BloomPageAddItem(&blstate, page, itup))
294  {
295  /* Success! Apply the changes, clean up, and exit */
296  metaData->nStart = nStart;
298  UnlockReleaseBuffer(buffer);
299  UnlockReleaseBuffer(metaBuffer);
300  MemoryContextSwitchTo(oldCtx);
301  MemoryContextDelete(insertCtx);
302  return false;
303  }
304 
305  /* Didn't fit, must try other pages */
307  UnlockReleaseBuffer(buffer);
308  nStart++;
309  }
310 
311  /*
312  * Didn't find place to insert in notFullPage array. Allocate new page.
313  * (XXX is it good to do this while holding ex-lock on the metapage??)
314  */
315  buffer = BloomNewBuffer(index);
316 
318  BloomInitPage(page, 0);
319 
320  if (!BloomPageAddItem(&blstate, page, itup))
321  {
322  /* We shouldn't be here since we're inserting to an empty page */
323  elog(ERROR, "could not add new bloom tuple to empty page");
324  }
325 
326  /* Reset notFullPage array to contain just this new page */
327  metaData->nStart = 0;
328  metaData->nEnd = 1;
329  metaData->notFullPage[0] = BufferGetBlockNumber(buffer);
330 
331  /* Apply the changes, clean up, and exit */
333 
334  UnlockReleaseBuffer(buffer);
335  UnlockReleaseBuffer(metaBuffer);
336 
337  MemoryContextSwitchTo(oldCtx);
338  MemoryContextDelete(insertCtx);
339 
340  return false;
341 }
static void initCachedPage(BloomBuildState *buildstate)
Definition: blinsert.c:64
PG_MODULE_MAGIC
Definition: blinsert.c:27
void blbuildempty(Relation index)
Definition: blinsert.c:164
IndexBuildResult * blbuild(Relation heap, Relation index, IndexInfo *indexInfo)
Definition: blinsert.c:121
static void flushCachedPage(Relation index, BloomBuildState *buildstate)
Definition: blinsert.c:47
static void bloomBuildCallback(Relation index, ItemPointer tid, Datum *values, bool *isnull, bool tupleIsAlive, void *state)
Definition: blinsert.c:74
bool blinsert(Relation index, Datum *values, bool *isnull, ItemPointer ht_ctid, Relation heapRel, IndexUniqueCheck checkUnique, bool indexUnchanged, IndexInfo *indexInfo)
Definition: blinsert.c:174
uint32 BlockNumber
Definition: block.h:31
#define InvalidBlockNumber
Definition: block.h:33
BloomTuple * BloomFormTuple(BloomState *state, ItemPointer iptr, Datum *values, bool *isnull)
Definition: blutils.c:295
void BloomInitPage(Page page, uint16 flags)
Definition: blutils.c:401
#define BloomPageGetMeta(page)
Definition: bloom.h:136
bool BloomPageAddItem(BloomState *state, Page page, BloomTuple *tuple)
Definition: blutils.c:320
Buffer BloomNewBuffer(Relation index)
Definition: blutils.c:355
void BloomInitMetapage(Relation index, ForkNumber forknum)
Definition: blutils.c:448
#define BloomPageIsDeleted(page)
Definition: bloom.h:64
void initBloomState(BloomState *state, Relation index)
Definition: blutils.c:163
#define BLOOM_METAPAGE_BLKNO
Definition: bloom.h:78
static Datum values[MAXATTR]
Definition: bootstrap.c:150
int Buffer
Definition: buf.h:23
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:3736
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:4936
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:4953
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:5171
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:773
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:189
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:190
#define RelationGetNumberOfBlocks(reln)
Definition: bufmgr.h:273
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:400
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:191
Pointer Page
Definition: bufpage.h:78
static bool PageIsNew(Page page)
Definition: bufpage.h:230
#define Assert(condition)
Definition: c.h:858
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:224
IndexUniqueCheck
Definition: genam.h:116
Page GenericXLogRegisterBuffer(GenericXLogState *state, Buffer buffer, int flags)
Definition: generic_xlog.c:299
GenericXLogState * GenericXLogStart(Relation relation)
Definition: generic_xlog.c:269
XLogRecPtr GenericXLogFinish(GenericXLogState *state)
Definition: generic_xlog.c:337
void GenericXLogAbort(GenericXLogState *state)
Definition: generic_xlog.c:444
#define GENERIC_XLOG_FULL_IMAGE
Definition: generic_xlog.h:26
void MemoryContextReset(MemoryContext context)
Definition: mcxt.c:383
MemoryContext CurrentMemoryContext
Definition: mcxt.c:143
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:454
void * palloc(Size size)
Definition: mcxt.c:1317
#define AllocSetContextCreate
Definition: memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:160
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122
uint16 OffsetNumber
Definition: off.h:24
uintptr_t Datum
Definition: postgres.h:64
MemoryContextSwitchTo(old_ctx)
#define RelationGetRelationName(relation)
Definition: rel.h:539
@ MAIN_FORKNUM
Definition: relpath.h:50
@ INIT_FORKNUM
Definition: relpath.h:53
int64 indtuples
Definition: blinsert.c:36
BloomState blstate
Definition: blinsert.c:35
MemoryContext tmpCtx
Definition: blinsert.c:37
PGAlignedBlock data
Definition: blinsert.c:39
FreeBlockNumberArray notFullPage
Definition: bloom.h:127
uint16 nEnd
Definition: bloom.h:125
uint16 nStart
Definition: bloom.h:124
double heap_tuples
Definition: genam.h:32
double index_tuples
Definition: genam.h:33
Definition: type.h:95
Definition: regguts.h:323
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:1775
char data[BLCKSZ]
Definition: c.h:1119