PostgreSQL Source Code  git master
brin_revmap.h File Reference
#include "access/brin_tuple.h"
#include "storage/block.h"
#include "storage/buf.h"
#include "storage/itemptr.h"
#include "storage/off.h"
#include "utils/relcache.h"
#include "utils/snapshot.h"
Include dependency graph for brin_revmap.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef struct BrinRevmap BrinRevmap
 

Functions

BrinRevmapbrinRevmapInitialize (Relation idxrel, BlockNumber *pagesPerRange)
 
void brinRevmapTerminate (BrinRevmap *revmap)
 
void brinRevmapExtend (BrinRevmap *revmap, BlockNumber heapBlk)
 
Buffer brinLockRevmapPageForUpdate (BrinRevmap *revmap, BlockNumber heapBlk)
 
void brinSetHeapBlockItemptr (Buffer buf, BlockNumber pagesPerRange, BlockNumber heapBlk, ItemPointerData tid)
 
BrinTuplebrinGetTupleForHeapBlock (BrinRevmap *revmap, BlockNumber heapBlk, Buffer *buf, OffsetNumber *off, Size *size, int mode)
 
bool brinRevmapDesummarizeRange (Relation idxrel, BlockNumber heapBlk)
 

Typedef Documentation

◆ BrinRevmap

typedef struct BrinRevmap BrinRevmap

Definition at line 1 of file brin_revmap.h.

Function Documentation

◆ brinGetTupleForHeapBlock()

BrinTuple* brinGetTupleForHeapBlock ( BrinRevmap revmap,
BlockNumber  heapBlk,
Buffer buf,
OffsetNumber off,
Size size,
int  mode 
)

Definition at line 195 of file brin_revmap.c.

197 {
198  Relation idxRel = revmap->rm_irel;
199  BlockNumber mapBlk;
200  RevmapContents *contents;
201  ItemPointerData *iptr;
202  BlockNumber blk;
203  Page page;
204  ItemId lp;
205  BrinTuple *tup;
206  ItemPointerData previptr;
207 
208  /* normalize the heap block number to be the first page in the range */
209  heapBlk = (heapBlk / revmap->rm_pagesPerRange) * revmap->rm_pagesPerRange;
210 
211  /*
212  * Compute the revmap page number we need. If Invalid is returned (i.e.,
213  * the revmap page hasn't been created yet), the requested page range is
214  * not summarized.
215  */
216  mapBlk = revmap_get_blkno(revmap, heapBlk);
217  if (mapBlk == InvalidBlockNumber)
218  {
219  *off = InvalidOffsetNumber;
220  return NULL;
221  }
222 
223  ItemPointerSetInvalid(&previptr);
224  for (;;)
225  {
227 
228  if (revmap->rm_currBuf == InvalidBuffer ||
229  BufferGetBlockNumber(revmap->rm_currBuf) != mapBlk)
230  {
231  if (revmap->rm_currBuf != InvalidBuffer)
232  ReleaseBuffer(revmap->rm_currBuf);
233 
234  Assert(mapBlk != InvalidBlockNumber);
235  revmap->rm_currBuf = ReadBuffer(revmap->rm_irel, mapBlk);
236  }
237 
239 
240  contents = (RevmapContents *)
242  iptr = contents->rm_tids;
243  iptr += HEAPBLK_TO_REVMAP_INDEX(revmap->rm_pagesPerRange, heapBlk);
244 
245  if (!ItemPointerIsValid(iptr))
246  {
248  return NULL;
249  }
250 
251  /*
252  * Check the TID we got in a previous iteration, if any, and save the
253  * current TID we got from the revmap; if we loop, we can sanity-check
254  * that the next one we get is different. Otherwise we might be stuck
255  * looping forever if the revmap is somehow badly broken.
256  */
257  if (ItemPointerIsValid(&previptr) && ItemPointerEquals(&previptr, iptr))
258  ereport(ERROR,
259  (errcode(ERRCODE_INDEX_CORRUPTED),
260  errmsg_internal("corrupted BRIN index: inconsistent range map")));
261  previptr = *iptr;
262 
263  blk = ItemPointerGetBlockNumber(iptr);
264  *off = ItemPointerGetOffsetNumber(iptr);
265 
267 
268  /* Ok, got a pointer to where the BrinTuple should be. Fetch it. */
269  if (!BufferIsValid(*buf) || BufferGetBlockNumber(*buf) != blk)
270  {
271  if (BufferIsValid(*buf))
272  ReleaseBuffer(*buf);
273  *buf = ReadBuffer(idxRel, blk);
274  }
275  LockBuffer(*buf, mode);
276  page = BufferGetPage(*buf);
277 
278  /* If we land on a revmap page, start over */
279  if (BRIN_IS_REGULAR_PAGE(page))
280  {
281  /*
282  * If the offset number is greater than what's in the page, it's
283  * possible that the range was desummarized concurrently. Just
284  * return NULL to handle that case.
285  */
286  if (*off > PageGetMaxOffsetNumber(page))
287  {
289  return NULL;
290  }
291 
292  lp = PageGetItemId(page, *off);
293  if (ItemIdIsUsed(lp))
294  {
295  tup = (BrinTuple *) PageGetItem(page, lp);
296 
297  if (tup->bt_blkno == heapBlk)
298  {
299  if (size)
300  *size = ItemIdGetLength(lp);
301  /* found it! */
302  return tup;
303  }
304  }
305  }
306 
307  /*
308  * No luck. Assume that the revmap was updated concurrently.
309  */
311  }
312  /* not reached, but keep compiler quiet */
313  return NULL;
314 }
uint32 BlockNumber
Definition: block.h:31
#define InvalidBlockNumber
Definition: block.h:33
#define BRIN_IS_REGULAR_PAGE(page)
Definition: brin_page.h:57
static BlockNumber revmap_get_blkno(BrinRevmap *revmap, BlockNumber heapBlk)
Definition: brin_revmap.c:443
#define HEAPBLK_TO_REVMAP_INDEX(pagesPerRange, heapBlk)
Definition: brin_revmap.c:43
#define InvalidBuffer
Definition: buf.h:25
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:3386
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:4573
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:4808
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:735
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:157
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:158
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:350
static bool BufferIsValid(Buffer bufnum)
Definition: bufmgr.h:301
static char * PageGetContents(Page page)
Definition: bufpage.h:254
Pointer Page
Definition: bufpage.h:78
static Item PageGetItem(Page page, ItemId itemId)
Definition: bufpage.h:351
static ItemId PageGetItemId(Page page, OffsetNumber offsetNumber)
Definition: bufpage.h:240
static OffsetNumber PageGetMaxOffsetNumber(Page page)
Definition: bufpage.h:369
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1156
int errcode(int sqlerrcode)
Definition: elog.c:858
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:149
#define ItemIdGetLength(itemId)
Definition: itemid.h:59
#define ItemIdIsUsed(itemId)
Definition: itemid.h:92
bool ItemPointerEquals(ItemPointer pointer1, ItemPointer pointer2)
Definition: itemptr.c:35
static void ItemPointerSetInvalid(ItemPointerData *pointer)
Definition: itemptr.h:184
static OffsetNumber ItemPointerGetOffsetNumber(const ItemPointerData *pointer)
Definition: itemptr.h:124
static BlockNumber ItemPointerGetBlockNumber(const ItemPointerData *pointer)
Definition: itemptr.h:103
static bool ItemPointerIsValid(const ItemPointerData *pointer)
Definition: itemptr.h:83
Assert(fmt[strlen(fmt) - 1] !='\n')
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:121
#define InvalidOffsetNumber
Definition: off.h:26
static PgChecksumMode mode
Definition: pg_checksums.c:56
static char * buf
Definition: pg_test_fsync.c:73
BlockNumber rm_pagesPerRange
Definition: brin_revmap.c:50
Buffer rm_currBuf
Definition: brin_revmap.c:53
Relation rm_irel
Definition: brin_revmap.c:49
BlockNumber bt_blkno
Definition: brin_tuple.h:66
ItemPointerData rm_tids[1]
Definition: brin_page.h:85

References Assert(), BRIN_IS_REGULAR_PAGE, BrinTuple::bt_blkno, buf, BUFFER_LOCK_SHARE, BUFFER_LOCK_UNLOCK, BufferGetBlockNumber(), BufferGetPage(), BufferIsValid(), CHECK_FOR_INTERRUPTS, ereport, errcode(), errmsg_internal(), ERROR, HEAPBLK_TO_REVMAP_INDEX, InvalidBlockNumber, InvalidBuffer, InvalidOffsetNumber, ItemIdGetLength, ItemIdIsUsed, ItemPointerEquals(), ItemPointerGetBlockNumber(), ItemPointerGetOffsetNumber(), ItemPointerIsValid(), ItemPointerSetInvalid(), LockBuffer(), mode, PageGetContents(), PageGetItem(), PageGetItemId(), PageGetMaxOffsetNumber(), ReadBuffer(), ReleaseBuffer(), revmap_get_blkno(), BrinRevmap::rm_currBuf, BrinRevmap::rm_irel, BrinRevmap::rm_pagesPerRange, and RevmapContents::rm_tids.

Referenced by bringetbitmap(), brininsert(), brinsummarize(), and summarize_range().

◆ brinLockRevmapPageForUpdate()

Buffer brinLockRevmapPageForUpdate ( BrinRevmap revmap,
BlockNumber  heapBlk 
)

Definition at line 135 of file brin_revmap.c.

136 {
137  Buffer rmBuf;
138 
139  rmBuf = revmap_get_buffer(revmap, heapBlk);
141 
142  return rmBuf;
143 }
static Buffer revmap_get_buffer(BrinRevmap *revmap, BlockNumber heapBlk)
Definition: brin_revmap.c:464
int Buffer
Definition: buf.h:23
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:159

References BUFFER_LOCK_EXCLUSIVE, LockBuffer(), and revmap_get_buffer().

Referenced by brin_doinsert(), brin_doupdate(), and brinRevmapDesummarizeRange().

◆ brinRevmapDesummarizeRange()

bool brinRevmapDesummarizeRange ( Relation  idxrel,
BlockNumber  heapBlk 
)

Definition at line 324 of file brin_revmap.c.

325 {
326  BrinRevmap *revmap;
327  BlockNumber pagesPerRange;
328  RevmapContents *contents;
329  ItemPointerData *iptr;
330  ItemPointerData invalidIptr;
331  BlockNumber revmapBlk;
332  Buffer revmapBuf;
333  Buffer regBuf;
334  Page revmapPg;
335  Page regPg;
336  OffsetNumber revmapOffset;
337  OffsetNumber regOffset;
338  ItemId lp;
339 
340  revmap = brinRevmapInitialize(idxrel, &pagesPerRange);
341 
342  revmapBlk = revmap_get_blkno(revmap, heapBlk);
343  if (!BlockNumberIsValid(revmapBlk))
344  {
345  /* revmap page doesn't exist: range not summarized, we're done */
346  brinRevmapTerminate(revmap);
347  return true;
348  }
349 
350  /* Lock the revmap page, obtain the index tuple pointer from it */
351  revmapBuf = brinLockRevmapPageForUpdate(revmap, heapBlk);
352  revmapPg = BufferGetPage(revmapBuf);
353  revmapOffset = HEAPBLK_TO_REVMAP_INDEX(revmap->rm_pagesPerRange, heapBlk);
354 
355  contents = (RevmapContents *) PageGetContents(revmapPg);
356  iptr = contents->rm_tids;
357  iptr += revmapOffset;
358 
359  if (!ItemPointerIsValid(iptr))
360  {
361  /* no index tuple: range not summarized, we're done */
362  LockBuffer(revmapBuf, BUFFER_LOCK_UNLOCK);
363  brinRevmapTerminate(revmap);
364  return true;
365  }
366 
367  regBuf = ReadBuffer(idxrel, ItemPointerGetBlockNumber(iptr));
369  regPg = BufferGetPage(regBuf);
370 
371  /* if this is no longer a regular page, tell caller to start over */
372  if (!BRIN_IS_REGULAR_PAGE(regPg))
373  {
374  LockBuffer(revmapBuf, BUFFER_LOCK_UNLOCK);
376  brinRevmapTerminate(revmap);
377  return false;
378  }
379 
380  regOffset = ItemPointerGetOffsetNumber(iptr);
381  if (regOffset > PageGetMaxOffsetNumber(regPg))
382  ereport(ERROR,
383  (errcode(ERRCODE_INDEX_CORRUPTED),
384  errmsg("corrupted BRIN index: inconsistent range map")));
385 
386  lp = PageGetItemId(regPg, regOffset);
387  if (!ItemIdIsUsed(lp))
388  ereport(ERROR,
389  (errcode(ERRCODE_INDEX_CORRUPTED),
390  errmsg("corrupted BRIN index: inconsistent range map")));
391 
392  /*
393  * Placeholder tuples only appear during unfinished summarization, and we
394  * hold ShareUpdateExclusiveLock, so this function cannot run concurrently
395  * with that. So any placeholder tuples that exist are leftovers from a
396  * crashed or aborted summarization; remove them silently.
397  */
398 
400 
401  ItemPointerSetInvalid(&invalidIptr);
402  brinSetHeapBlockItemptr(revmapBuf, revmap->rm_pagesPerRange, heapBlk,
403  invalidIptr);
404  PageIndexTupleDeleteNoCompact(regPg, regOffset);
405  /* XXX record free space in FSM? */
406 
407  MarkBufferDirty(regBuf);
408  MarkBufferDirty(revmapBuf);
409 
410  if (RelationNeedsWAL(idxrel))
411  {
412  xl_brin_desummarize xlrec;
413  XLogRecPtr recptr;
414 
415  xlrec.pagesPerRange = revmap->rm_pagesPerRange;
416  xlrec.heapBlk = heapBlk;
417  xlrec.regOffset = regOffset;
418 
419  XLogBeginInsert();
420  XLogRegisterData((char *) &xlrec, SizeOfBrinDesummarize);
421  XLogRegisterBuffer(0, revmapBuf, 0);
423  recptr = XLogInsert(RM_BRIN_ID, XLOG_BRIN_DESUMMARIZE);
424  PageSetLSN(revmapPg, recptr);
425  PageSetLSN(regPg, recptr);
426  }
427 
429 
430  UnlockReleaseBuffer(regBuf);
431  LockBuffer(revmapBuf, BUFFER_LOCK_UNLOCK);
432  brinRevmapTerminate(revmap);
433 
434  return true;
435 }
static bool BlockNumberIsValid(BlockNumber blockNumber)
Definition: block.h:71
void brinRevmapTerminate(BrinRevmap *revmap)
Definition: brin_revmap.c:101
BrinRevmap * brinRevmapInitialize(Relation idxrel, BlockNumber *pagesPerRange)
Definition: brin_revmap.c:71
void brinSetHeapBlockItemptr(Buffer buf, BlockNumber pagesPerRange, BlockNumber heapBlk, ItemPointerData tid)
Definition: brin_revmap.c:156
Buffer brinLockRevmapPageForUpdate(BrinRevmap *revmap, BlockNumber heapBlk)
Definition: brin_revmap.c:135
#define XLOG_BRIN_DESUMMARIZE
Definition: brin_xlog.h:36
#define SizeOfBrinDesummarize
Definition: brin_xlog.h:142
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:4590
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:2198
void PageIndexTupleDeleteNoCompact(Page page, OffsetNumber offnum)
Definition: bufpage.c:1295
static void PageSetLSN(Page page, XLogRecPtr lsn)
Definition: bufpage.h:388
int errmsg(const char *fmt,...)
Definition: elog.c:1069
#define START_CRIT_SECTION()
Definition: miscadmin.h:148
#define END_CRIT_SECTION()
Definition: miscadmin.h:150
uint16 OffsetNumber
Definition: off.h:24
#define RelationNeedsWAL(relation)
Definition: rel.h:629
BlockNumber pagesPerRange
Definition: brin_xlog.h:135
BlockNumber heapBlk
Definition: brin_xlog.h:137
OffsetNumber regOffset
Definition: brin_xlog.h:139
uint64 XLogRecPtr
Definition: xlogdefs.h:21
void XLogRegisterData(char *data, uint32 len)
Definition: xloginsert.c:365
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:475
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:243
void XLogBeginInsert(void)
Definition: xloginsert.c:150
#define REGBUF_STANDARD
Definition: xloginsert.h:34

References BlockNumberIsValid(), BRIN_IS_REGULAR_PAGE, brinLockRevmapPageForUpdate(), brinRevmapInitialize(), brinRevmapTerminate(), brinSetHeapBlockItemptr(), BUFFER_LOCK_EXCLUSIVE, BUFFER_LOCK_UNLOCK, BufferGetPage(), END_CRIT_SECTION, ereport, errcode(), errmsg(), ERROR, xl_brin_desummarize::heapBlk, HEAPBLK_TO_REVMAP_INDEX, ItemIdIsUsed, ItemPointerGetBlockNumber(), ItemPointerGetOffsetNumber(), ItemPointerIsValid(), ItemPointerSetInvalid(), LockBuffer(), MarkBufferDirty(), PageGetContents(), PageGetItemId(), PageGetMaxOffsetNumber(), PageIndexTupleDeleteNoCompact(), PageSetLSN(), xl_brin_desummarize::pagesPerRange, ReadBuffer(), REGBUF_STANDARD, xl_brin_desummarize::regOffset, RelationNeedsWAL, revmap_get_blkno(), BrinRevmap::rm_pagesPerRange, RevmapContents::rm_tids, SizeOfBrinDesummarize, START_CRIT_SECTION, UnlockReleaseBuffer(), XLOG_BRIN_DESUMMARIZE, XLogBeginInsert(), XLogInsert(), XLogRegisterBuffer(), and XLogRegisterData().

Referenced by brin_desummarize_range().

◆ brinRevmapExtend()

void brinRevmapExtend ( BrinRevmap revmap,
BlockNumber  heapBlk 
)

Definition at line 113 of file brin_revmap.c.

114 {
116 
117  mapBlk = revmap_extend_and_get_blkno(revmap, heapBlk);
118 
119  /* Ensure the buffer we got is in the expected range */
120  Assert(mapBlk != InvalidBlockNumber &&
121  mapBlk != BRIN_METAPAGE_BLKNO &&
122  mapBlk <= revmap->rm_lastRevmapPage);
123 }
#define BRIN_METAPAGE_BLKNO
Definition: brin_page.h:75
static BlockNumber revmap_extend_and_get_blkno(BrinRevmap *revmap, BlockNumber heapBlk)
Definition: brin_revmap.c:501
#define PG_USED_FOR_ASSERTS_ONLY
Definition: c.h:171

References Assert(), BRIN_METAPAGE_BLKNO, InvalidBlockNumber, PG_USED_FOR_ASSERTS_ONLY, and revmap_extend_and_get_blkno().

Referenced by brin_doinsert(), and brin_doupdate().

◆ brinRevmapInitialize()

BrinRevmap* brinRevmapInitialize ( Relation  idxrel,
BlockNumber pagesPerRange 
)

Definition at line 71 of file brin_revmap.c.

72 {
73  BrinRevmap *revmap;
74  Buffer meta;
75  BrinMetaPageData *metadata;
76  Page page;
77 
78  meta = ReadBuffer(idxrel, BRIN_METAPAGE_BLKNO);
80  page = BufferGetPage(meta);
81  metadata = (BrinMetaPageData *) PageGetContents(page);
82 
83  revmap = palloc(sizeof(BrinRevmap));
84  revmap->rm_irel = idxrel;
85  revmap->rm_pagesPerRange = metadata->pagesPerRange;
86  revmap->rm_lastRevmapPage = metadata->lastRevmapPage;
87  revmap->rm_metaBuf = meta;
88  revmap->rm_currBuf = InvalidBuffer;
89 
90  *pagesPerRange = metadata->pagesPerRange;
91 
93 
94  return revmap;
95 }
void * palloc(Size size)
Definition: mcxt.c:1226
BlockNumber lastRevmapPage
Definition: brin_page.h:69
BlockNumber pagesPerRange
Definition: brin_page.h:68
BlockNumber rm_lastRevmapPage
Definition: brin_revmap.c:51
Buffer rm_metaBuf
Definition: brin_revmap.c:52

References BRIN_METAPAGE_BLKNO, BUFFER_LOCK_SHARE, BUFFER_LOCK_UNLOCK, BufferGetPage(), InvalidBuffer, BrinMetaPageData::lastRevmapPage, LockBuffer(), PageGetContents(), BrinMetaPageData::pagesPerRange, palloc(), ReadBuffer(), BrinRevmap::rm_currBuf, BrinRevmap::rm_irel, BrinRevmap::rm_lastRevmapPage, BrinRevmap::rm_metaBuf, and BrinRevmap::rm_pagesPerRange.

Referenced by brinbeginscan(), brinbuild(), brinRevmapDesummarizeRange(), brinsummarize(), and initialize_brin_insertstate().

◆ brinRevmapTerminate()

void brinRevmapTerminate ( BrinRevmap revmap)

Definition at line 101 of file brin_revmap.c.

102 {
103  ReleaseBuffer(revmap->rm_metaBuf);
104  if (revmap->rm_currBuf != InvalidBuffer)
105  ReleaseBuffer(revmap->rm_currBuf);
106  pfree(revmap);
107 }
void pfree(void *pointer)
Definition: mcxt.c:1456

References InvalidBuffer, pfree(), ReleaseBuffer(), BrinRevmap::rm_currBuf, and BrinRevmap::rm_metaBuf.

Referenced by brinbuild(), brinendscan(), brininsertcleanup(), brinRevmapDesummarizeRange(), and brinsummarize().

◆ brinSetHeapBlockItemptr()

void brinSetHeapBlockItemptr ( Buffer  buf,
BlockNumber  pagesPerRange,
BlockNumber  heapBlk,
ItemPointerData  tid 
)

Definition at line 156 of file brin_revmap.c.

158 {
159  RevmapContents *contents;
160  ItemPointerData *iptr;
161  Page page;
162 
163  /* The correct page should already be pinned and locked */
164  page = BufferGetPage(buf);
165  contents = (RevmapContents *) PageGetContents(page);
166  iptr = (ItemPointerData *) contents->rm_tids;
167  iptr += HEAPBLK_TO_REVMAP_INDEX(pagesPerRange, heapBlk);
168 
169  if (ItemPointerIsValid(&tid))
170  ItemPointerSet(iptr,
173  else
174  ItemPointerSetInvalid(iptr);
175 }
static void ItemPointerSet(ItemPointerData *pointer, BlockNumber blockNumber, OffsetNumber offNum)
Definition: itemptr.h:135

References buf, BufferGetPage(), HEAPBLK_TO_REVMAP_INDEX, ItemPointerGetBlockNumber(), ItemPointerGetOffsetNumber(), ItemPointerIsValid(), ItemPointerSet(), ItemPointerSetInvalid(), PageGetContents(), and RevmapContents::rm_tids.

Referenced by brin_doinsert(), brin_doupdate(), brin_xlog_desummarize_page(), brin_xlog_insert_update(), and brinRevmapDesummarizeRange().