PostgreSQL Source Code  git master
ginbtree.c File Reference
#include "postgres.h"
#include "access/gin_private.h"
#include "access/ginxlog.h"
#include "access/xloginsert.h"
#include "miscadmin.h"
#include "storage/predicate.h"
#include "utils/memutils.h"
#include "utils/rel.h"
Include dependency graph for ginbtree.c:

Go to the source code of this file.

Functions

static void ginFindParents (GinBtree btree, GinBtreeStack *stack)
 
static bool ginPlaceToPage (GinBtree btree, GinBtreeStack *stack, void *insertdata, BlockNumber updateblkno, Buffer childbuf, GinStatsData *buildStats)
 
static void ginFinishSplit (GinBtree btree, GinBtreeStack *stack, bool freestack, GinStatsData *buildStats)
 
int ginTraverseLock (Buffer buffer, bool searchMode)
 
GinBtreeStackginFindLeafPage (GinBtree btree, bool searchMode, bool rootConflictCheck, Snapshot snapshot)
 
Buffer ginStepRight (Buffer buffer, Relation index, int lockmode)
 
void freeGinBtreeStack (GinBtreeStack *stack)
 
void ginInsertValue (GinBtree btree, GinBtreeStack *stack, void *insertdata, GinStatsData *buildStats)
 

Function Documentation

◆ freeGinBtreeStack()

void freeGinBtreeStack ( GinBtreeStack stack)

Definition at line 194 of file ginbtree.c.

195 {
196  while (stack)
197  {
198  GinBtreeStack *tmp = stack->parent;
199 
200  if (stack->buffer != InvalidBuffer)
201  ReleaseBuffer(stack->buffer);
202 
203  pfree(stack);
204  stack = tmp;
205  }
206 }
#define InvalidBuffer
Definition: buf.h:25
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3915
void pfree(void *pointer)
Definition: mcxt.c:1175
struct GinBtreeStack * parent
Definition: gin_private.h:136

References GinBtreeStack::buffer, InvalidBuffer, GinBtreeStack::parent, pfree(), and ReleaseBuffer().

Referenced by entryLoadMoreItems(), ginEntryInsert(), ginFinishSplit(), ginInsertValue(), scanPostingTree(), and startScanEntry().

◆ ginFindLeafPage()

GinBtreeStack* ginFindLeafPage ( GinBtree  btree,
bool  searchMode,
bool  rootConflictCheck,
Snapshot  snapshot 
)

Definition at line 80 of file ginbtree.c.

82 {
83  GinBtreeStack *stack;
84 
85  stack = (GinBtreeStack *) palloc(sizeof(GinBtreeStack));
86  stack->blkno = btree->rootBlkno;
87  stack->buffer = ReadBuffer(btree->index, btree->rootBlkno);
88  stack->parent = NULL;
89  stack->predictNumber = 1;
90 
91  if (rootConflictCheck)
92  CheckForSerializableConflictIn(btree->index, NULL, btree->rootBlkno);
93 
94  for (;;)
95  {
96  Page page;
97  BlockNumber child;
98  int access;
99 
100  stack->off = InvalidOffsetNumber;
101 
102  page = BufferGetPage(stack->buffer);
103  TestForOldSnapshot(snapshot, btree->index, page);
104 
105  access = ginTraverseLock(stack->buffer, searchMode);
106 
107  /*
108  * If we're going to modify the tree, finish any incomplete splits we
109  * encounter on the way.
110  */
111  if (!searchMode && GinPageIsIncompleteSplit(page))
112  ginFinishSplit(btree, stack, false, NULL);
113 
114  /*
115  * ok, page is correctly locked, we should check to move right ..,
116  * root never has a right link, so small optimization
117  */
118  while (btree->fullScan == false && stack->blkno != btree->rootBlkno &&
119  btree->isMoveRight(btree, page))
120  {
121  BlockNumber rightlink = GinPageGetOpaque(page)->rightlink;
122 
123  if (rightlink == InvalidBlockNumber)
124  /* rightmost page */
125  break;
126 
127  stack->buffer = ginStepRight(stack->buffer, btree->index, access);
128  stack->blkno = rightlink;
129  page = BufferGetPage(stack->buffer);
130  TestForOldSnapshot(snapshot, btree->index, page);
131 
132  if (!searchMode && GinPageIsIncompleteSplit(page))
133  ginFinishSplit(btree, stack, false, NULL);
134  }
135 
136  if (GinPageIsLeaf(page)) /* we found, return locked page */
137  return stack;
138 
139  /* now we have correct buffer, try to find child */
140  child = btree->findChildPage(btree, stack);
141 
142  LockBuffer(stack->buffer, GIN_UNLOCK);
143  Assert(child != InvalidBlockNumber);
144  Assert(stack->blkno != child);
145 
146  if (searchMode)
147  {
148  /* in search mode we may forget path to leaf */
149  stack->blkno = child;
150  stack->buffer = ReleaseAndReadBuffer(stack->buffer, btree->index, stack->blkno);
151  }
152  else
153  {
154  GinBtreeStack *ptr = (GinBtreeStack *) palloc(sizeof(GinBtreeStack));
155 
156  ptr->parent = stack;
157  stack = ptr;
158  stack->blkno = child;
159  stack->buffer = ReadBuffer(btree->index, stack->blkno);
160  stack->predictNumber = 1;
161  }
162  }
163 }
uint32 BlockNumber
Definition: block.h:31
#define InvalidBlockNumber
Definition: block.h:33
Buffer ReleaseAndReadBuffer(Buffer buffer, Relation relation, BlockNumber blockNum)
Definition: bufmgr.c:1636
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:4156
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:702
static void TestForOldSnapshot(Snapshot snapshot, Relation relation, Page page)
Definition: bufmgr.h:282
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
Pointer Page
Definition: bufpage.h:78
#define GIN_UNLOCK
Definition: gin_private.h:48
#define GinPageGetOpaque(page)
Definition: ginblock.h:110
#define GinPageIsLeaf(page)
Definition: ginblock.h:112
#define GinPageIsIncompleteSplit(page)
Definition: ginblock.h:127
int ginTraverseLock(Buffer buffer, bool searchMode)
Definition: ginbtree.c:36
static void ginFinishSplit(GinBtree btree, GinBtreeStack *stack, bool freestack, GinStatsData *buildStats)
Definition: ginbtree.c:666
Buffer ginStepRight(Buffer buffer, Relation index, int lockmode)
Definition: ginbtree.c:173
Assert(fmt[strlen(fmt) - 1] !='\n')
void * palloc(Size size)
Definition: mcxt.c:1068
#define InvalidOffsetNumber
Definition: off.h:26
void CheckForSerializableConflictIn(Relation relation, ItemPointer tid, BlockNumber blkno)
Definition: predicate.c:4448
BlockNumber(* findChildPage)(GinBtree, GinBtreeStack *)
Definition: gin_private.h:152
bool(* isMoveRight)(GinBtree, Page)
Definition: gin_private.h:154
Relation index
Definition: gin_private.h:166
BlockNumber rootBlkno
Definition: gin_private.h:167
OffsetNumber off
Definition: gin_private.h:132
uint32 predictNumber
Definition: gin_private.h:135
BlockNumber blkno
Definition: gin_private.h:130

References Assert(), GinBtreeStack::blkno, GinBtreeStack::buffer, BufferGetPage, CheckForSerializableConflictIn(), GinBtreeData::findChildPage, GinBtreeData::fullScan, GIN_UNLOCK, ginFinishSplit(), GinPageGetOpaque, GinPageIsIncompleteSplit, GinPageIsLeaf, ginStepRight(), ginTraverseLock(), GinBtreeData::index, InvalidBlockNumber, InvalidOffsetNumber, GinBtreeData::isMoveRight, LockBuffer(), GinBtreeStack::off, palloc(), GinBtreeStack::parent, GinBtreeStack::predictNumber, ReadBuffer(), ReleaseAndReadBuffer(), GinBtreeData::rootBlkno, and TestForOldSnapshot().

Referenced by entryLoadMoreItems(), ginEntryInsert(), ginInsertItemPointers(), ginScanBeginPostingTree(), and startScanEntry().

◆ ginFindParents()

static void ginFindParents ( GinBtree  btree,
GinBtreeStack stack 
)
static

Definition at line 214 of file ginbtree.c.

215 {
216  Page page;
217  Buffer buffer;
218  BlockNumber blkno,
219  leftmostBlkno;
220  OffsetNumber offset;
221  GinBtreeStack *root;
222  GinBtreeStack *ptr;
223 
224  /*
225  * Unwind the stack all the way up to the root, leaving only the root
226  * item.
227  *
228  * Be careful not to release the pin on the root page! The pin on root
229  * page is required to lock out concurrent vacuums on the tree.
230  */
231  root = stack->parent;
232  while (root->parent)
233  {
234  ReleaseBuffer(root->buffer);
235  root = root->parent;
236  }
237 
238  Assert(root->blkno == btree->rootBlkno);
239  Assert(BufferGetBlockNumber(root->buffer) == btree->rootBlkno);
240  root->off = InvalidOffsetNumber;
241 
242  blkno = root->blkno;
243  buffer = root->buffer;
244 
245  ptr = (GinBtreeStack *) palloc(sizeof(GinBtreeStack));
246 
247  for (;;)
248  {
249  LockBuffer(buffer, GIN_EXCLUSIVE);
250  page = BufferGetPage(buffer);
251  if (GinPageIsLeaf(page))
252  elog(ERROR, "Lost path");
253 
254  if (GinPageIsIncompleteSplit(page))
255  {
256  Assert(blkno != btree->rootBlkno);
257  ptr->blkno = blkno;
258  ptr->buffer = buffer;
259 
260  /*
261  * parent may be wrong, but if so, the ginFinishSplit call will
262  * recurse to call ginFindParents again to fix it.
263  */
264  ptr->parent = root;
265  ptr->off = InvalidOffsetNumber;
266 
267  ginFinishSplit(btree, ptr, false, NULL);
268  }
269 
270  leftmostBlkno = btree->getLeftMostChild(btree, page);
271 
272  while ((offset = btree->findChildPtr(btree, page, stack->blkno, InvalidOffsetNumber)) == InvalidOffsetNumber)
273  {
274  blkno = GinPageGetOpaque(page)->rightlink;
275  if (blkno == InvalidBlockNumber)
276  {
277  UnlockReleaseBuffer(buffer);
278  break;
279  }
280  buffer = ginStepRight(buffer, btree->index, GIN_EXCLUSIVE);
281  page = BufferGetPage(buffer);
282 
283  /* finish any incomplete splits, as above */
284  if (GinPageIsIncompleteSplit(page))
285  {
286  Assert(blkno != btree->rootBlkno);
287  ptr->blkno = blkno;
288  ptr->buffer = buffer;
289  ptr->parent = root;
290  ptr->off = InvalidOffsetNumber;
291 
292  ginFinishSplit(btree, ptr, false, NULL);
293  }
294  }
295 
296  if (blkno != InvalidBlockNumber)
297  {
298  ptr->blkno = blkno;
299  ptr->buffer = buffer;
300  ptr->parent = root; /* it may be wrong, but in next call we will
301  * correct */
302  ptr->off = offset;
303  stack->parent = ptr;
304  return;
305  }
306 
307  /* Descend down to next level */
308  blkno = leftmostBlkno;
309  buffer = ReadBuffer(btree->index, blkno);
310  }
311 }
int Buffer
Definition: buf.h:23
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2755
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3938
#define ERROR
Definition: elog.h:33
#define elog(elevel,...)
Definition: elog.h:218
#define GIN_EXCLUSIVE
Definition: gin_private.h:50
uint16 OffsetNumber
Definition: off.h:24
BlockNumber(* getLeftMostChild)(GinBtree, Page)
Definition: gin_private.h:153
OffsetNumber(* findChildPtr)(GinBtree, Page, BlockNumber, OffsetNumber)
Definition: gin_private.h:158

References Assert(), GinBtreeStack::blkno, GinBtreeStack::buffer, BufferGetBlockNumber(), BufferGetPage, elog, ERROR, GinBtreeData::findChildPtr, GinBtreeData::getLeftMostChild, GIN_EXCLUSIVE, ginFinishSplit(), GinPageGetOpaque, GinPageIsIncompleteSplit, GinPageIsLeaf, ginStepRight(), GinBtreeData::index, InvalidBlockNumber, InvalidOffsetNumber, LockBuffer(), GinBtreeStack::off, palloc(), GinBtreeStack::parent, ReadBuffer(), ReleaseBuffer(), GinBtreeData::rootBlkno, and UnlockReleaseBuffer().

Referenced by ginFinishSplit().

◆ ginFinishSplit()

static void ginFinishSplit ( GinBtree  btree,
GinBtreeStack stack,
bool  freestack,
GinStatsData buildStats 
)
static

Definition at line 666 of file ginbtree.c.

668 {
669  Page page;
670  bool done;
671  bool first = true;
672 
673  /*
674  * freestack == false when we encounter an incompletely split page during
675  * a scan, while freestack == true is used in the normal scenario that a
676  * split is finished right after the initial insert.
677  */
678  if (!freestack)
679  elog(DEBUG1, "finishing incomplete split of block %u in gin index \"%s\"",
680  stack->blkno, RelationGetRelationName(btree->index));
681 
682  /* this loop crawls up the stack until the insertion is complete */
683  do
684  {
685  GinBtreeStack *parent = stack->parent;
686  void *insertdata;
687  BlockNumber updateblkno;
688 
689  /* search parent to lock */
690  LockBuffer(parent->buffer, GIN_EXCLUSIVE);
691 
692  /*
693  * If the parent page was incompletely split, finish that split first,
694  * then continue with the current one.
695  *
696  * Note: we have to finish *all* incomplete splits we encounter, even
697  * if we have to move right. Otherwise we might choose as the target a
698  * page that has no downlink in the parent, and splitting it further
699  * would fail.
700  */
702  ginFinishSplit(btree, parent, false, buildStats);
703 
704  /* move right if it's needed */
705  page = BufferGetPage(parent->buffer);
706  while ((parent->off = btree->findChildPtr(btree, page, stack->blkno, parent->off)) == InvalidOffsetNumber)
707  {
708  if (GinPageRightMost(page))
709  {
710  /*
711  * rightmost page, but we don't find parent, we should use
712  * plain search...
713  */
714  LockBuffer(parent->buffer, GIN_UNLOCK);
715  ginFindParents(btree, stack);
716  parent = stack->parent;
717  Assert(parent != NULL);
718  break;
719  }
720 
721  parent->buffer = ginStepRight(parent->buffer, btree->index, GIN_EXCLUSIVE);
722  parent->blkno = BufferGetBlockNumber(parent->buffer);
723  page = BufferGetPage(parent->buffer);
724 
726  ginFinishSplit(btree, parent, false, buildStats);
727  }
728 
729  /* insert the downlink */
730  insertdata = btree->prepareDownlink(btree, stack->buffer);
731  updateblkno = GinPageGetOpaque(BufferGetPage(stack->buffer))->rightlink;
732  done = ginPlaceToPage(btree, parent,
733  insertdata, updateblkno,
734  stack->buffer, buildStats);
735  pfree(insertdata);
736 
737  /*
738  * If the caller requested to free the stack, unlock and release the
739  * child buffer now. Otherwise keep it pinned and locked, but if we
740  * have to recurse up the tree, we can unlock the upper pages, only
741  * keeping the page at the bottom of the stack locked.
742  */
743  if (!first || freestack)
744  LockBuffer(stack->buffer, GIN_UNLOCK);
745  if (freestack)
746  {
747  ReleaseBuffer(stack->buffer);
748  pfree(stack);
749  }
750  stack = parent;
751 
752  first = false;
753  } while (!done);
754 
755  /* unlock the parent */
756  LockBuffer(stack->buffer, GIN_UNLOCK);
757 
758  if (freestack)
759  freeGinBtreeStack(stack);
760 }
#define DEBUG1
Definition: elog.h:24
#define GinPageRightMost(page)
Definition: ginblock.h:129
void freeGinBtreeStack(GinBtreeStack *stack)
Definition: ginbtree.c:194
static bool ginPlaceToPage(GinBtree btree, GinBtreeStack *stack, void *insertdata, BlockNumber updateblkno, Buffer childbuf, GinStatsData *buildStats)
Definition: ginbtree.c:329
static void ginFindParents(GinBtree btree, GinBtreeStack *stack)
Definition: ginbtree.c:214
#define RelationGetRelationName(relation)
Definition: rel.h:523
void *(* prepareDownlink)(GinBtree, Buffer)
Definition: gin_private.h:161

References Assert(), GinBtreeStack::blkno, GinBtreeStack::buffer, BufferGetBlockNumber(), BufferGetPage, DEBUG1, elog, GinBtreeData::findChildPtr, freeGinBtreeStack(), GIN_EXCLUSIVE, GIN_UNLOCK, ginFindParents(), GinPageGetOpaque, GinPageIsIncompleteSplit, GinPageRightMost, ginPlaceToPage(), ginStepRight(), GinBtreeData::index, InvalidOffsetNumber, LockBuffer(), GinBtreeStack::off, GinBtreeStack::parent, pfree(), GinBtreeData::prepareDownlink, RelationGetRelationName, and ReleaseBuffer().

Referenced by ginFindLeafPage(), ginFindParents(), and ginInsertValue().

◆ ginInsertValue()

void ginInsertValue ( GinBtree  btree,
GinBtreeStack stack,
void *  insertdata,
GinStatsData buildStats 
)

Definition at line 775 of file ginbtree.c.

777 {
778  bool done;
779 
780  /* If the leaf page was incompletely split, finish the split first */
782  ginFinishSplit(btree, stack, false, buildStats);
783 
784  done = ginPlaceToPage(btree, stack,
785  insertdata, InvalidBlockNumber,
786  InvalidBuffer, buildStats);
787  if (done)
788  {
789  LockBuffer(stack->buffer, GIN_UNLOCK);
790  freeGinBtreeStack(stack);
791  }
792  else
793  ginFinishSplit(btree, stack, true, buildStats);
794 }

References GinBtreeStack::buffer, BufferGetPage, freeGinBtreeStack(), GIN_UNLOCK, ginFinishSplit(), GinPageIsIncompleteSplit, ginPlaceToPage(), InvalidBlockNumber, InvalidBuffer, and LockBuffer().

Referenced by ginEntryInsert(), and ginInsertItemPointers().

◆ ginPlaceToPage()

static bool ginPlaceToPage ( GinBtree  btree,
GinBtreeStack stack,
void *  insertdata,
BlockNumber  updateblkno,
Buffer  childbuf,
GinStatsData buildStats 
)
static

Definition at line 329 of file ginbtree.c.

332 {
333  Page page = BufferGetPage(stack->buffer);
334  bool result;
335  GinPlaceToPageRC rc;
336  uint16 xlflags = 0;
337  Page childpage = NULL;
338  Page newlpage = NULL,
339  newrpage = NULL;
340  void *ptp_workspace = NULL;
341  MemoryContext tmpCxt;
342  MemoryContext oldCxt;
343 
344  /*
345  * We do all the work of this function and its subfunctions in a temporary
346  * memory context. This avoids leakages and simplifies APIs, since some
347  * subfunctions allocate storage that has to survive until we've finished
348  * the WAL insertion.
349  */
351  "ginPlaceToPage temporary context",
353  oldCxt = MemoryContextSwitchTo(tmpCxt);
354 
355  if (GinPageIsData(page))
356  xlflags |= GIN_INSERT_ISDATA;
357  if (GinPageIsLeaf(page))
358  {
359  xlflags |= GIN_INSERT_ISLEAF;
360  Assert(!BufferIsValid(childbuf));
361  Assert(updateblkno == InvalidBlockNumber);
362  }
363  else
364  {
365  Assert(BufferIsValid(childbuf));
366  Assert(updateblkno != InvalidBlockNumber);
367  childpage = BufferGetPage(childbuf);
368  }
369 
370  /*
371  * See if the incoming tuple will fit on the page. beginPlaceToPage will
372  * decide if the page needs to be split, and will compute the split
373  * contents if so. See comments for beginPlaceToPage and execPlaceToPage
374  * functions for more details of the API here.
375  */
376  rc = btree->beginPlaceToPage(btree, stack->buffer, stack,
377  insertdata, updateblkno,
378  &ptp_workspace,
379  &newlpage, &newrpage);
380 
381  if (rc == GPTP_NO_WORK)
382  {
383  /* Nothing to do */
384  result = true;
385  }
386  else if (rc == GPTP_INSERT)
387  {
388  /* It will fit, perform the insertion */
390 
391  if (RelationNeedsWAL(btree->index) && !btree->isBuild)
392  {
393  XLogBeginInsert();
395  if (BufferIsValid(childbuf))
396  XLogRegisterBuffer(1, childbuf, REGBUF_STANDARD);
397  }
398 
399  /* Perform the page update, and register any extra WAL data */
400  btree->execPlaceToPage(btree, stack->buffer, stack,
401  insertdata, updateblkno, ptp_workspace);
402 
403  MarkBufferDirty(stack->buffer);
404 
405  /* An insert to an internal page finishes the split of the child. */
406  if (BufferIsValid(childbuf))
407  {
408  GinPageGetOpaque(childpage)->flags &= ~GIN_INCOMPLETE_SPLIT;
409  MarkBufferDirty(childbuf);
410  }
411 
412  if (RelationNeedsWAL(btree->index) && !btree->isBuild)
413  {
414  XLogRecPtr recptr;
415  ginxlogInsert xlrec;
416  BlockIdData childblknos[2];
417 
418  xlrec.flags = xlflags;
419 
420  XLogRegisterData((char *) &xlrec, sizeof(ginxlogInsert));
421 
422  /*
423  * Log information about child if this was an insertion of a
424  * downlink.
425  */
426  if (BufferIsValid(childbuf))
427  {
428  BlockIdSet(&childblknos[0], BufferGetBlockNumber(childbuf));
429  BlockIdSet(&childblknos[1], GinPageGetOpaque(childpage)->rightlink);
430  XLogRegisterData((char *) childblknos,
431  sizeof(BlockIdData) * 2);
432  }
433 
434  recptr = XLogInsert(RM_GIN_ID, XLOG_GIN_INSERT);
435  PageSetLSN(page, recptr);
436  if (BufferIsValid(childbuf))
437  PageSetLSN(childpage, recptr);
438  }
439 
441 
442  /* Insertion is complete. */
443  result = true;
444  }
445  else if (rc == GPTP_SPLIT)
446  {
447  /*
448  * Didn't fit, need to split. The split has been computed in newlpage
449  * and newrpage, which are pointers to palloc'd pages, not associated
450  * with buffers. stack->buffer is not touched yet.
451  */
452  Buffer rbuffer;
453  BlockNumber savedRightLink;
455  Buffer lbuffer = InvalidBuffer;
456  Page newrootpg = NULL;
457 
458  /* Get a new index page to become the right page */
459  rbuffer = GinNewBuffer(btree->index);
460 
461  /* During index build, count the new page */
462  if (buildStats)
463  {
464  if (btree->isData)
465  buildStats->nDataPages++;
466  else
467  buildStats->nEntryPages++;
468  }
469 
470  savedRightLink = GinPageGetOpaque(page)->rightlink;
471 
472  /* Begin setting up WAL record */
473  data.node = btree->index->rd_node;
474  data.flags = xlflags;
475  if (BufferIsValid(childbuf))
476  {
477  data.leftChildBlkno = BufferGetBlockNumber(childbuf);
478  data.rightChildBlkno = GinPageGetOpaque(childpage)->rightlink;
479  }
480  else
481  data.leftChildBlkno = data.rightChildBlkno = InvalidBlockNumber;
482 
483  if (stack->parent == NULL)
484  {
485  /*
486  * splitting the root, so we need to allocate new left page and
487  * place pointers to left and right page on root page.
488  */
489  lbuffer = GinNewBuffer(btree->index);
490 
491  /* During index build, count the new left page */
492  if (buildStats)
493  {
494  if (btree->isData)
495  buildStats->nDataPages++;
496  else
497  buildStats->nEntryPages++;
498  }
499 
500  data.rrlink = InvalidBlockNumber;
501  data.flags |= GIN_SPLIT_ROOT;
502 
503  GinPageGetOpaque(newrpage)->rightlink = InvalidBlockNumber;
504  GinPageGetOpaque(newlpage)->rightlink = BufferGetBlockNumber(rbuffer);
505 
506  /*
507  * Construct a new root page containing downlinks to the new left
508  * and right pages. (Do this in a temporary copy rather than
509  * overwriting the original page directly, since we're not in the
510  * critical section yet.)
511  */
512  newrootpg = PageGetTempPage(newrpage);
513  GinInitPage(newrootpg, GinPageGetOpaque(newlpage)->flags & ~(GIN_LEAF | GIN_COMPRESSED), BLCKSZ);
514 
515  btree->fillRoot(btree, newrootpg,
516  BufferGetBlockNumber(lbuffer), newlpage,
517  BufferGetBlockNumber(rbuffer), newrpage);
518 
519  if (GinPageIsLeaf(BufferGetPage(stack->buffer)))
520  {
521 
524  BufferGetBlockNumber(lbuffer));
525 
528  BufferGetBlockNumber(rbuffer));
529  }
530  }
531  else
532  {
533  /* splitting a non-root page */
534  data.rrlink = savedRightLink;
535 
536  GinPageGetOpaque(newrpage)->rightlink = savedRightLink;
537  GinPageGetOpaque(newlpage)->flags |= GIN_INCOMPLETE_SPLIT;
538  GinPageGetOpaque(newlpage)->rightlink = BufferGetBlockNumber(rbuffer);
539 
540  if (GinPageIsLeaf(BufferGetPage(stack->buffer)))
541  {
542 
545  BufferGetBlockNumber(rbuffer));
546  }
547  }
548 
549  /*
550  * OK, we have the new contents of the left page in a temporary copy
551  * now (newlpage), and likewise for the new contents of the
552  * newly-allocated right block. The original page is still unchanged.
553  *
554  * If this is a root split, we also have a temporary page containing
555  * the new contents of the root.
556  */
557 
559 
560  MarkBufferDirty(rbuffer);
561  MarkBufferDirty(stack->buffer);
562 
563  /*
564  * Restore the temporary copies over the real buffers.
565  */
566  if (stack->parent == NULL)
567  {
568  /* Splitting the root, three pages to update */
569  MarkBufferDirty(lbuffer);
570  memcpy(page, newrootpg, BLCKSZ);
571  memcpy(BufferGetPage(lbuffer), newlpage, BLCKSZ);
572  memcpy(BufferGetPage(rbuffer), newrpage, BLCKSZ);
573  }
574  else
575  {
576  /* Normal split, only two pages to update */
577  memcpy(page, newlpage, BLCKSZ);
578  memcpy(BufferGetPage(rbuffer), newrpage, BLCKSZ);
579  }
580 
581  /* We also clear childbuf's INCOMPLETE_SPLIT flag, if passed */
582  if (BufferIsValid(childbuf))
583  {
584  GinPageGetOpaque(childpage)->flags &= ~GIN_INCOMPLETE_SPLIT;
585  MarkBufferDirty(childbuf);
586  }
587 
588  /* write WAL record */
589  if (RelationNeedsWAL(btree->index) && !btree->isBuild)
590  {
591  XLogRecPtr recptr;
592 
593  XLogBeginInsert();
594 
595  /*
596  * We just take full page images of all the split pages. Splits
597  * are uncommon enough that it's not worth complicating the code
598  * to be more efficient.
599  */
600  if (stack->parent == NULL)
601  {
605  }
606  else
607  {
610  }
611  if (BufferIsValid(childbuf))
612  XLogRegisterBuffer(3, childbuf, REGBUF_STANDARD);
613 
614  XLogRegisterData((char *) &data, sizeof(ginxlogSplit));
615 
616  recptr = XLogInsert(RM_GIN_ID, XLOG_GIN_SPLIT);
617 
618  PageSetLSN(page, recptr);
619  PageSetLSN(BufferGetPage(rbuffer), recptr);
620  if (stack->parent == NULL)
621  PageSetLSN(BufferGetPage(lbuffer), recptr);
622  if (BufferIsValid(childbuf))
623  PageSetLSN(childpage, recptr);
624  }
626 
627  /*
628  * We can release the locks/pins on the new pages now, but keep
629  * stack->buffer locked. childbuf doesn't get unlocked either.
630  */
631  UnlockReleaseBuffer(rbuffer);
632  if (stack->parent == NULL)
633  UnlockReleaseBuffer(lbuffer);
634 
635  /*
636  * If we split the root, we're done. Otherwise the split is not
637  * complete until the downlink for the new page has been inserted to
638  * the parent.
639  */
640  result = (stack->parent == NULL);
641  }
642  else
643  {
644  elog(ERROR, "invalid return code from GIN beginPlaceToPage method: %d", rc);
645  result = false; /* keep compiler quiet */
646  }
647 
648  /* Clean up temp context */
649  MemoryContextSwitchTo(oldCxt);
650  MemoryContextDelete(tmpCxt);
651 
652  return result;
653 }
#define BlockIdSet(blockId, blockNumber)
Definition: block.h:84
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1573
#define BufferIsValid(bufnum)
Definition: bufmgr.h:123
Page PageGetTempPage(Page page)
Definition: bufpage.c:365
#define PageSetLSN(page, lsn)
Definition: bufpage.h:367
unsigned short uint16
Definition: c.h:440
GinPlaceToPageRC
Definition: gin_private.h:143
@ GPTP_INSERT
Definition: gin_private.h:145
@ GPTP_SPLIT
Definition: gin_private.h:146
@ GPTP_NO_WORK
Definition: gin_private.h:144
#define GIN_COMPRESSED
Definition: ginblock.h:48
#define GIN_LEAF
Definition: ginblock.h:42
#define GinPageIsData(page)
Definition: ginblock.h:115
#define GIN_INCOMPLETE_SPLIT
Definition: ginblock.h:47
void GinInitPage(Page page, uint32 f, Size pageSize)
Definition: ginutil.c:345
Buffer GinNewBuffer(Relation index)
Definition: ginutil.c:299
#define GIN_INSERT_ISDATA
Definition: ginxlog.h:124
#define GIN_INSERT_ISLEAF
Definition: ginxlog.h:125
#define GIN_SPLIT_ROOT
Definition: ginxlog.h:126
#define XLOG_GIN_INSERT
Definition: ginxlog.h:35
#define XLOG_GIN_SPLIT
Definition: ginxlog.h:109
MemoryContext CurrentMemoryContext
Definition: mcxt.c:42
void MemoryContextDelete(MemoryContext context)
Definition: mcxt.c:218
#define AllocSetContextCreate
Definition: memutils.h:173
#define ALLOCSET_DEFAULT_SIZES
Definition: memutils.h:197
#define START_CRIT_SECTION()
Definition: miscadmin.h:148
#define END_CRIT_SECTION()
Definition: miscadmin.h:150
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
const void * data
void PredicateLockPageSplit(Relation relation, BlockNumber oldblkno, BlockNumber newblkno)
Definition: predicate.c:3169
#define RelationNeedsWAL(relation)
Definition: rel.h:613
void(* execPlaceToPage)(GinBtree, Buffer, GinBtreeStack *, void *, BlockNumber, void *)
Definition: gin_private.h:160
GinPlaceToPageRC(* beginPlaceToPage)(GinBtree, Buffer, GinBtreeStack *, void *, BlockNumber, void **, Page *, Page *)
Definition: gin_private.h:159
void(* fillRoot)(GinBtree, Page, BlockNumber, Page, BlockNumber, Page)
Definition: gin_private.h:162
BlockNumber nDataPages
Definition: gin.h:47
BlockNumber nEntryPages
Definition: gin.h:46
RelFileNode rd_node
Definition: rel.h:56
uint16 flags
Definition: ginxlog.h:39
uint64 XLogRecPtr
Definition: xlogdefs.h:21
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:443
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:243
void XLogBeginInsert(void)
Definition: xloginsert.c:150
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:351
#define REGBUF_STANDARD
Definition: xloginsert.h:34
#define REGBUF_FORCE_IMAGE
Definition: xloginsert.h:31

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert(), GinBtreeData::beginPlaceToPage, BlockIdSet, GinBtreeStack::buffer, BufferGetBlockNumber(), BufferGetPage, BufferIsValid, CurrentMemoryContext, data, elog, END_CRIT_SECTION, ERROR, GinBtreeData::execPlaceToPage, GinBtreeData::fillRoot, ginxlogInsert::flags, GIN_COMPRESSED, GIN_INCOMPLETE_SPLIT, GIN_INSERT_ISDATA, GIN_INSERT_ISLEAF, GIN_LEAF, GIN_SPLIT_ROOT, GinInitPage(), GinNewBuffer(), GinPageGetOpaque, GinPageIsData, GinPageIsLeaf, GPTP_INSERT, GPTP_NO_WORK, GPTP_SPLIT, GinBtreeData::index, InvalidBlockNumber, InvalidBuffer, GinBtreeData::isBuild, GinBtreeData::isData, MarkBufferDirty(), MemoryContextDelete(), MemoryContextSwitchTo(), GinStatsData::nDataPages, GinStatsData::nEntryPages, PageGetTempPage(), PageSetLSN, GinBtreeStack::parent, PredicateLockPageSplit(), RelationData::rd_node, REGBUF_FORCE_IMAGE, REGBUF_STANDARD, RelationNeedsWAL, START_CRIT_SECTION, UnlockReleaseBuffer(), XLOG_GIN_INSERT, XLOG_GIN_SPLIT, XLogBeginInsert(), XLogInsert(), XLogRegisterBuffer(), and XLogRegisterData().

Referenced by ginFinishSplit(), and ginInsertValue().

◆ ginStepRight()

Buffer ginStepRight ( Buffer  buffer,
Relation  index,
int  lockmode 
)

Definition at line 173 of file ginbtree.c.

174 {
175  Buffer nextbuffer;
176  Page page = BufferGetPage(buffer);
177  bool isLeaf = GinPageIsLeaf(page);
178  bool isData = GinPageIsData(page);
179  BlockNumber blkno = GinPageGetOpaque(page)->rightlink;
180 
181  nextbuffer = ReadBuffer(index, blkno);
182  LockBuffer(nextbuffer, lockmode);
183  UnlockReleaseBuffer(buffer);
184 
185  /* Sanity check that the page we stepped to is of similar kind. */
186  page = BufferGetPage(nextbuffer);
187  if (isLeaf != GinPageIsLeaf(page) || isData != GinPageIsData(page))
188  elog(ERROR, "right sibling of GIN page is of different type");
189 
190  return nextbuffer;
191 }
Definition: type.h:90

References BufferGetPage, elog, ERROR, GinPageGetOpaque, GinPageIsData, GinPageIsLeaf, LockBuffer(), ReadBuffer(), and UnlockReleaseBuffer().

Referenced by entryLoadMoreItems(), ginFindLeafPage(), ginFindParents(), ginFinishSplit(), moveRightIfItNeeded(), and scanPostingTree().

◆ ginTraverseLock()

int ginTraverseLock ( Buffer  buffer,
bool  searchMode 
)

Definition at line 36 of file ginbtree.c.

37 {
38  Page page;
39  int access = GIN_SHARE;
40 
41  LockBuffer(buffer, GIN_SHARE);
42  page = BufferGetPage(buffer);
43  if (GinPageIsLeaf(page))
44  {
45  if (searchMode == false)
46  {
47  /* we should relock our page */
48  LockBuffer(buffer, GIN_UNLOCK);
49  LockBuffer(buffer, GIN_EXCLUSIVE);
50 
51  /* But root can become non-leaf during relock */
52  if (!GinPageIsLeaf(page))
53  {
54  /* restore old lock type (very rare) */
55  LockBuffer(buffer, GIN_UNLOCK);
56  LockBuffer(buffer, GIN_SHARE);
57  }
58  else
59  access = GIN_EXCLUSIVE;
60  }
61  }
62 
63  return access;
64 }
#define GIN_SHARE
Definition: gin_private.h:49

References BufferGetPage, GIN_EXCLUSIVE, GIN_SHARE, GIN_UNLOCK, GinPageIsLeaf, and LockBuffer().

Referenced by ginFindLeafPage().