PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
brin_pageops.c
Go to the documentation of this file.
1/*
2 * brin_pageops.c
3 * Page-handling routines for BRIN indexes
4 *
5 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
6 * Portions Copyright (c) 1994, Regents of the University of California
7 *
8 * IDENTIFICATION
9 * src/backend/access/brin/brin_pageops.c
10 */
11#include "postgres.h"
12
13#include "access/brin_page.h"
14#include "access/brin_pageops.h"
15#include "access/brin_revmap.h"
16#include "access/brin_xlog.h"
17#include "access/xloginsert.h"
18#include "miscadmin.h"
19#include "storage/bufmgr.h"
20#include "storage/freespace.h"
21#include "storage/lmgr.h"
22#include "utils/rel.h"
23
24/*
25 * Maximum size of an entry in a BRIN_PAGETYPE_REGULAR page. We can tolerate
26 * a single item per page, unlike other index AMs.
27 */
28#define BrinMaxItemSize \
29 MAXALIGN_DOWN(BLCKSZ - \
30 (MAXALIGN(SizeOfPageHeaderData + \
31 sizeof(ItemIdData)) + \
32 MAXALIGN(sizeof(BrinSpecialSpace))))
33
34static Buffer brin_getinsertbuffer(Relation irel, Buffer oldbuf, Size itemsz,
35 bool *extended);
37static void brin_initialize_empty_new_buffer(Relation idxrel, Buffer buffer);
38
39
40/*
41 * Update tuple origtup (size origsz), located in offset oldoff of buffer
42 * oldbuf, to newtup (size newsz) as summary tuple for the page range starting
43 * at heapBlk. oldbuf must not be locked on entry, and is not locked at exit.
44 *
45 * If samepage is true, attempt to put the new tuple in the same page, but if
46 * there's no room, use some other one.
47 *
48 * If the update is successful, return true; the revmap is updated to point to
49 * the new tuple. If the update is not done for whatever reason, return false.
50 * Caller may retry the update if this happens.
51 */
52bool
53brin_doupdate(Relation idxrel, BlockNumber pagesPerRange,
54 BrinRevmap *revmap, BlockNumber heapBlk,
55 Buffer oldbuf, OffsetNumber oldoff,
56 const BrinTuple *origtup, Size origsz,
57 const BrinTuple *newtup, Size newsz,
58 bool samepage)
59{
60 Page oldpage;
61 ItemId oldlp;
62 BrinTuple *oldtup;
63 Size oldsz;
64 Buffer newbuf;
66 bool extended;
67
68 Assert(newsz == MAXALIGN(newsz));
69
70 /* If the item is oversized, don't bother. */
71 if (newsz > BrinMaxItemSize)
72 {
74 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
75 errmsg("index row size %zu exceeds maximum %zu for index \"%s\"",
77 return false; /* keep compiler quiet */
78 }
79
80 /* make sure the revmap is long enough to contain the entry we need */
81 brinRevmapExtend(revmap, heapBlk);
82
83 if (!samepage)
84 {
85 /* need a page on which to put the item */
86 newbuf = brin_getinsertbuffer(idxrel, oldbuf, newsz, &extended);
87 if (!BufferIsValid(newbuf))
88 {
89 Assert(!extended);
90 return false;
91 }
92
93 /*
94 * Note: it's possible (though unlikely) that the returned newbuf is
95 * the same as oldbuf, if brin_getinsertbuffer determined that the old
96 * buffer does in fact have enough space.
97 */
98 if (newbuf == oldbuf)
99 {
100 Assert(!extended);
101 newbuf = InvalidBuffer;
102 }
103 else
104 newblk = BufferGetBlockNumber(newbuf);
105 }
106 else
107 {
109 newbuf = InvalidBuffer;
110 extended = false;
111 }
112 oldpage = BufferGetPage(oldbuf);
113 oldlp = PageGetItemId(oldpage, oldoff);
114
115 /*
116 * Check that the old tuple wasn't updated concurrently: it might have
117 * moved someplace else entirely, and for that matter the whole page
118 * might've become a revmap page. Note that in the first two cases
119 * checked here, the "oldlp" we just calculated is garbage; but
120 * PageGetItemId() is simple enough that it was safe to do that
121 * calculation anyway.
122 */
123 if (!BRIN_IS_REGULAR_PAGE(oldpage) ||
124 oldoff > PageGetMaxOffsetNumber(oldpage) ||
125 !ItemIdIsNormal(oldlp))
126 {
128
129 /*
130 * If this happens, and the new buffer was obtained by extending the
131 * relation, then we need to ensure we don't leave it uninitialized or
132 * forget about it.
133 */
134 if (BufferIsValid(newbuf))
135 {
136 if (extended)
137 brin_initialize_empty_new_buffer(idxrel, newbuf);
138 UnlockReleaseBuffer(newbuf);
139 if (extended)
140 FreeSpaceMapVacuumRange(idxrel, newblk, newblk + 1);
141 }
142 return false;
143 }
144
145 oldsz = ItemIdGetLength(oldlp);
146 oldtup = (BrinTuple *) PageGetItem(oldpage, oldlp);
147
148 /*
149 * ... or it might have been updated in place to different contents.
150 */
151 if (!brin_tuples_equal(oldtup, oldsz, origtup, origsz))
152 {
154 if (BufferIsValid(newbuf))
155 {
156 /* As above, initialize and record new page if we got one */
157 if (extended)
158 brin_initialize_empty_new_buffer(idxrel, newbuf);
159 UnlockReleaseBuffer(newbuf);
160 if (extended)
161 FreeSpaceMapVacuumRange(idxrel, newblk, newblk + 1);
162 }
163 return false;
164 }
165
166 /*
167 * Great, the old tuple is intact. We can proceed with the update.
168 *
169 * If there's enough room in the old page for the new tuple, replace it.
170 *
171 * Note that there might now be enough space on the page even though the
172 * caller told us there isn't, if a concurrent update moved another tuple
173 * elsewhere or replaced a tuple with a smaller one.
174 */
175 if (((BrinPageFlags(oldpage) & BRIN_EVACUATE_PAGE) == 0) &&
176 brin_can_do_samepage_update(oldbuf, origsz, newsz))
177 {
179 if (!PageIndexTupleOverwrite(oldpage, oldoff, newtup, newsz))
180 elog(ERROR, "failed to replace BRIN tuple");
181 MarkBufferDirty(oldbuf);
182
183 /* XLOG stuff */
184 if (RelationNeedsWAL(idxrel))
185 {
187 XLogRecPtr recptr;
189
190 xlrec.offnum = oldoff;
191
194
196 XLogRegisterBufData(0, newtup, newsz);
197
198 recptr = XLogInsert(RM_BRIN_ID, info);
199
200 PageSetLSN(oldpage, recptr);
201 }
202
204
206
207 if (BufferIsValid(newbuf))
208 {
209 /* As above, initialize and record new page if we got one */
210 if (extended)
211 brin_initialize_empty_new_buffer(idxrel, newbuf);
212 UnlockReleaseBuffer(newbuf);
213 if (extended)
214 FreeSpaceMapVacuumRange(idxrel, newblk, newblk + 1);
215 }
216
217 return true;
218 }
219 else if (newbuf == InvalidBuffer)
220 {
221 /*
222 * Not enough space, but caller said that there was. Tell them to
223 * start over.
224 */
226 return false;
227 }
228 else
229 {
230 /*
231 * Not enough free space on the oldpage. Put the new tuple on the new
232 * page, and update the revmap.
233 */
234 Page newpage = BufferGetPage(newbuf);
235 Buffer revmapbuf;
236 ItemPointerData newtid;
237 OffsetNumber newoff;
238 Size freespace = 0;
239
240 revmapbuf = brinLockRevmapPageForUpdate(revmap, heapBlk);
241
243
244 /*
245 * We need to initialize the page if it's newly obtained. Note we
246 * will WAL-log the initialization as part of the update, so we don't
247 * need to do that here.
248 */
249 if (extended)
251
252 PageIndexTupleDeleteNoCompact(oldpage, oldoff);
253 newoff = PageAddItem(newpage, newtup, newsz, InvalidOffsetNumber, false, false);
254 if (newoff == InvalidOffsetNumber)
255 elog(ERROR, "failed to add BRIN tuple to new page");
256 MarkBufferDirty(oldbuf);
257 MarkBufferDirty(newbuf);
258
259 /* needed to update FSM below */
260 if (extended)
261 freespace = br_page_get_freespace(newpage);
262
263 ItemPointerSet(&newtid, newblk, newoff);
264 brinSetHeapBlockItemptr(revmapbuf, pagesPerRange, heapBlk, newtid);
265 MarkBufferDirty(revmapbuf);
266
267 /* XLOG stuff */
268 if (RelationNeedsWAL(idxrel))
269 {
270 xl_brin_update xlrec;
271 XLogRecPtr recptr;
272 uint8 info;
273
274 info = XLOG_BRIN_UPDATE | (extended ? XLOG_BRIN_INIT_PAGE : 0);
275
276 xlrec.insert.offnum = newoff;
277 xlrec.insert.heapBlk = heapBlk;
278 xlrec.insert.pagesPerRange = pagesPerRange;
279 xlrec.oldOffnum = oldoff;
280
282
283 /* new page */
285
286 XLogRegisterBuffer(0, newbuf, REGBUF_STANDARD | (extended ? REGBUF_WILL_INIT : 0));
287 XLogRegisterBufData(0, newtup, newsz);
288
289 /* revmap page */
290 XLogRegisterBuffer(1, revmapbuf, 0);
291
292 /* old page */
294
295 recptr = XLogInsert(RM_BRIN_ID, info);
296
297 PageSetLSN(oldpage, recptr);
298 PageSetLSN(newpage, recptr);
299 PageSetLSN(BufferGetPage(revmapbuf), recptr);
300 }
301
303
304 LockBuffer(revmapbuf, BUFFER_LOCK_UNLOCK);
306 UnlockReleaseBuffer(newbuf);
307
308 if (extended)
309 {
310 RecordPageWithFreeSpace(idxrel, newblk, freespace);
311 FreeSpaceMapVacuumRange(idxrel, newblk, newblk + 1);
312 }
313
314 return true;
315 }
316}
317
318/*
319 * Return whether brin_doupdate can do a samepage update.
320 */
321bool
323{
324 return
325 ((newsz <= origsz) ||
326 PageGetExactFreeSpace(BufferGetPage(buffer)) >= (newsz - origsz));
327}
328
329/*
330 * Insert an index tuple into the index relation. The revmap is updated to
331 * mark the range containing the given page as pointing to the inserted entry.
332 * A WAL record is written.
333 *
334 * The buffer, if valid, is first checked for free space to insert the new
335 * entry; if there isn't enough, a new buffer is obtained and pinned. No
336 * buffer lock must be held on entry, no buffer lock is held on exit.
337 *
338 * Return value is the offset number where the tuple was inserted.
339 */
341brin_doinsert(Relation idxrel, BlockNumber pagesPerRange,
342 BrinRevmap *revmap, Buffer *buffer, BlockNumber heapBlk,
343 const BrinTuple *tup, Size itemsz)
344{
345 Page page;
346 BlockNumber blk;
347 OffsetNumber off;
348 Size freespace = 0;
349 Buffer revmapbuf;
350 ItemPointerData tid;
351 bool extended;
352
353 Assert(itemsz == MAXALIGN(itemsz));
354
355 /* If the item is oversized, don't even bother. */
356 if (itemsz > BrinMaxItemSize)
357 {
359 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
360 errmsg("index row size %zu exceeds maximum %zu for index \"%s\"",
361 itemsz, BrinMaxItemSize, RelationGetRelationName(idxrel))));
362 return InvalidOffsetNumber; /* keep compiler quiet */
363 }
364
365 /* Make sure the revmap is long enough to contain the entry we need */
366 brinRevmapExtend(revmap, heapBlk);
367
368 /*
369 * Acquire lock on buffer supplied by caller, if any. If it doesn't have
370 * enough space, unpin it to obtain a new one below.
371 */
372 if (BufferIsValid(*buffer))
373 {
374 /*
375 * It's possible that another backend (or ourselves!) extended the
376 * revmap over the page we held a pin on, so we cannot assume that
377 * it's still a regular page.
378 */
380 if (br_page_get_freespace(BufferGetPage(*buffer)) < itemsz)
381 {
382 UnlockReleaseBuffer(*buffer);
383 *buffer = InvalidBuffer;
384 }
385 }
386
387 /*
388 * If we still don't have a usable buffer, have brin_getinsertbuffer
389 * obtain one for us.
390 */
391 if (!BufferIsValid(*buffer))
392 {
393 do
394 *buffer = brin_getinsertbuffer(idxrel, InvalidBuffer, itemsz, &extended);
395 while (!BufferIsValid(*buffer));
396 }
397 else
398 extended = false;
399
400 /* Now obtain lock on revmap buffer */
401 revmapbuf = brinLockRevmapPageForUpdate(revmap, heapBlk);
402
403 page = BufferGetPage(*buffer);
404 blk = BufferGetBlockNumber(*buffer);
405
406 /* Execute the actual insertion */
408 if (extended)
410 off = PageAddItem(page, tup, itemsz, InvalidOffsetNumber, false, false);
411 if (off == InvalidOffsetNumber)
412 elog(ERROR, "failed to add BRIN tuple to new page");
413 MarkBufferDirty(*buffer);
414
415 /* needed to update FSM below */
416 if (extended)
417 freespace = br_page_get_freespace(page);
418
419 ItemPointerSet(&tid, blk, off);
420 brinSetHeapBlockItemptr(revmapbuf, pagesPerRange, heapBlk, tid);
421 MarkBufferDirty(revmapbuf);
422
423 /* XLOG stuff */
424 if (RelationNeedsWAL(idxrel))
425 {
426 xl_brin_insert xlrec;
427 XLogRecPtr recptr;
428 uint8 info;
429
430 info = XLOG_BRIN_INSERT | (extended ? XLOG_BRIN_INIT_PAGE : 0);
431 xlrec.heapBlk = heapBlk;
432 xlrec.pagesPerRange = pagesPerRange;
433 xlrec.offnum = off;
434
437
438 XLogRegisterBuffer(0, *buffer, REGBUF_STANDARD | (extended ? REGBUF_WILL_INIT : 0));
439 XLogRegisterBufData(0, tup, itemsz);
440
441 XLogRegisterBuffer(1, revmapbuf, 0);
442
443 recptr = XLogInsert(RM_BRIN_ID, info);
444
445 PageSetLSN(page, recptr);
446 PageSetLSN(BufferGetPage(revmapbuf), recptr);
447 }
448
450
451 /* Tuple is firmly on buffer; we can release our locks */
453 LockBuffer(revmapbuf, BUFFER_LOCK_UNLOCK);
454
455 BRIN_elog((DEBUG2, "inserted tuple (%u,%u) for range starting at %u",
456 blk, off, heapBlk));
457
458 if (extended)
459 {
460 RecordPageWithFreeSpace(idxrel, blk, freespace);
461 FreeSpaceMapVacuumRange(idxrel, blk, blk + 1);
462 }
463
464 return off;
465}
466
467/*
468 * Initialize a page with the given type.
469 *
470 * Caller is responsible for marking it dirty, as appropriate.
471 */
472void
474{
475 PageInit(page, BLCKSZ, sizeof(BrinSpecialSpace));
476
477 BrinPageType(page) = type;
478}
479
480/*
481 * Initialize a new BRIN index's metapage.
482 */
483void
484brin_metapage_init(Page page, BlockNumber pagesPerRange, uint16 version)
485{
486 BrinMetaPageData *metadata;
487
489
490 metadata = (BrinMetaPageData *) PageGetContents(page);
491
492 metadata->brinMagic = BRIN_META_MAGIC;
493 metadata->brinVersion = version;
494 metadata->pagesPerRange = pagesPerRange;
495
496 /*
497 * Note we cheat here a little. 0 is not a valid revmap block number
498 * (because it's the metapage buffer), but doing this enables the first
499 * revmap page to be created when the index is.
500 */
501 metadata->lastRevmapPage = 0;
502
503 /*
504 * Set pd_lower just past the end of the metadata. This is essential,
505 * because without doing so, metadata will be lost if xlog.c compresses
506 * the page.
507 */
508 ((PageHeader) page)->pd_lower =
509 ((char *) metadata + sizeof(BrinMetaPageData)) - (char *) page;
510}
511
512/*
513 * Initiate page evacuation protocol.
514 *
515 * The page must be locked in exclusive mode by the caller.
516 *
517 * If the page is not yet initialized or empty, return false without doing
518 * anything; it can be used for revmap without any further changes. If it
519 * contains tuples, mark it for evacuation and return true.
520 */
521bool
523{
524 OffsetNumber off;
525 OffsetNumber maxoff;
526 Page page;
527
528 page = BufferGetPage(buf);
529
530 if (PageIsNew(page))
531 return false;
532
533 maxoff = PageGetMaxOffsetNumber(page);
534 for (off = FirstOffsetNumber; off <= maxoff; off++)
535 {
536 ItemId lp;
537
538 lp = PageGetItemId(page, off);
539 if (ItemIdIsUsed(lp))
540 {
541 /*
542 * Prevent other backends from adding more stuff to this page:
543 * BRIN_EVACUATE_PAGE informs br_page_get_freespace that this page
544 * can no longer be used to add new tuples. Note that this flag
545 * is not WAL-logged, except accidentally.
546 */
549
550 return true;
551 }
552 }
553 return false;
554}
555
556/*
557 * Move all tuples out of a page.
558 *
559 * The caller must hold lock on the page. The lock and pin are released.
560 */
561void
563 BrinRevmap *revmap, Buffer buf)
564{
565 OffsetNumber off;
566 OffsetNumber maxoff;
567 Page page;
568 BrinTuple *btup = NULL;
569 Size btupsz = 0;
570
571 page = BufferGetPage(buf);
572
574
575 maxoff = PageGetMaxOffsetNumber(page);
576 for (off = FirstOffsetNumber; off <= maxoff; off++)
577 {
578 BrinTuple *tup;
579 Size sz;
580 ItemId lp;
581
583
584 lp = PageGetItemId(page, off);
585 if (ItemIdIsUsed(lp))
586 {
587 sz = ItemIdGetLength(lp);
588 tup = (BrinTuple *) PageGetItem(page, lp);
589 tup = brin_copy_tuple(tup, sz, btup, &btupsz);
590
592
593 if (!brin_doupdate(idxRel, pagesPerRange, revmap, tup->bt_blkno,
594 buf, off, tup, sz, tup, sz, false))
595 off--; /* retry */
596
598
599 /* It's possible that someone extended the revmap over this page */
600 if (!BRIN_IS_REGULAR_PAGE(page))
601 break;
602 }
603 }
604
606}
607
608/*
609 * Given a BRIN index page, initialize it if necessary, and record its
610 * current free space in the FSM.
611 *
612 * The main use for this is when, during vacuuming, an uninitialized page is
613 * found, which could be the result of relation extension followed by a crash
614 * before the page can be used.
615 *
616 * Here, we don't bother to update upper FSM pages, instead expecting that our
617 * caller (brin_vacuum_scan) will fix them at the end of the scan. Elsewhere
618 * in this file, it's generally a good idea to propagate additions of free
619 * space into the upper FSM pages immediately.
620 */
621void
623{
624 Page page = BufferGetPage(buf);
625
626 /*
627 * If a page was left uninitialized, initialize it now; also record it in
628 * FSM.
629 *
630 * Somebody else might be extending the relation concurrently. To avoid
631 * re-initializing the page before they can grab the buffer lock, we
632 * acquire the extension lock momentarily. Since they hold the extension
633 * lock from before getting the page and after its been initialized, we're
634 * sure to see their initialization.
635 */
636 if (PageIsNew(page))
637 {
640
642 if (PageIsNew(page))
643 {
646 return;
647 }
649 }
650
651 /* Nothing to be done for non-regular index pages */
654 return;
655
656 /* Measure free space and record it */
659}
660
661/*
662 * Return a pinned and exclusively locked buffer which can be used to insert an
663 * index item of size itemsz (caller must ensure not to request sizes
664 * impossible to fulfill). If oldbuf is a valid buffer, it is also locked (in
665 * an order determined to avoid deadlocks).
666 *
667 * If we find that the old page is no longer a regular index page (because
668 * of a revmap extension), the old buffer is unlocked and we return
669 * InvalidBuffer.
670 *
671 * If there's no existing page with enough free space to accommodate the new
672 * item, the relation is extended. If this happens, *extended is set to true,
673 * and it is the caller's responsibility to initialize the page (and WAL-log
674 * that fact) prior to use. The caller should also update the FSM with the
675 * page's remaining free space after the insertion.
676 *
677 * Note that the caller is not expected to update FSM unless *extended is set
678 * true. This policy means that we'll update FSM when a page is created, and
679 * when it's found to have too little space for a desired tuple insertion,
680 * but not every single time we add a tuple to the page.
681 *
682 * Note that in some corner cases it is possible for this routine to extend
683 * the relation and then not return the new page. It is this routine's
684 * responsibility to WAL-log the page initialization and to record the page in
685 * FSM if that happens, since the caller certainly can't do it.
686 */
687static Buffer
689 bool *extended)
690{
691 BlockNumber oldblk;
692 BlockNumber newblk;
693 Page page;
694 Size freespace;
695
696 /* callers must have checked */
697 Assert(itemsz <= BrinMaxItemSize);
698
699 if (BufferIsValid(oldbuf))
700 oldblk = BufferGetBlockNumber(oldbuf);
701 else
702 oldblk = InvalidBlockNumber;
703
704 /* Choose initial target page, re-using existing target if known */
705 newblk = RelationGetTargetBlock(irel);
706 if (newblk == InvalidBlockNumber)
707 newblk = GetPageWithFreeSpace(irel, itemsz);
708
709 /*
710 * Loop until we find a page with sufficient free space. By the time we
711 * return to caller out of this loop, both buffers are valid and locked;
712 * if we have to restart here, neither page is locked and newblk isn't
713 * pinned (if it's even valid).
714 */
715 for (;;)
716 {
717 Buffer buf;
718 bool extensionLockHeld = false;
719
721
722 *extended = false;
723
724 if (newblk == InvalidBlockNumber)
725 {
726 /*
727 * There's not enough free space in any existing index page,
728 * according to the FSM: extend the relation to obtain a shiny new
729 * page.
730 *
731 * XXX: It's likely possible to use RBM_ZERO_AND_LOCK here,
732 * which'd avoid the need to hold the extension lock during buffer
733 * reclaim.
734 */
735 if (!RELATION_IS_LOCAL(irel))
736 {
738 extensionLockHeld = true;
739 }
740 buf = ReadBuffer(irel, P_NEW);
741 newblk = BufferGetBlockNumber(buf);
742 *extended = true;
743
744 BRIN_elog((DEBUG2, "brin_getinsertbuffer: extending to page %u",
746 }
747 else if (newblk == oldblk)
748 {
749 /*
750 * There's an odd corner-case here where the FSM is out-of-date,
751 * and gave us the old page.
752 */
753 buf = oldbuf;
754 }
755 else
756 {
757 buf = ReadBuffer(irel, newblk);
758 }
759
760 /*
761 * We lock the old buffer first, if it's earlier than the new one; but
762 * then we need to check that it hasn't been turned into a revmap page
763 * concurrently. If we detect that that happened, give up and tell
764 * caller to start over.
765 */
766 if (BufferIsValid(oldbuf) && oldblk < newblk)
767 {
770 {
772
773 /*
774 * It is possible that the new page was obtained from
775 * extending the relation. In that case, we must be sure to
776 * record it in the FSM before leaving, because otherwise the
777 * space would be lost forever. However, we cannot let an
778 * uninitialized page get in the FSM, so we need to initialize
779 * it first.
780 */
781 if (*extended)
783
784 if (extensionLockHeld)
786
788
789 if (*extended)
790 {
791 FreeSpaceMapVacuumRange(irel, newblk, newblk + 1);
792 /* shouldn't matter, but don't confuse caller */
793 *extended = false;
794 }
795
796 return InvalidBuffer;
797 }
798 }
799
801
802 if (extensionLockHeld)
804
805 page = BufferGetPage(buf);
806
807 /*
808 * We have a new buffer to insert into. Check that the new page has
809 * enough free space, and return it if it does; otherwise start over.
810 * (br_page_get_freespace also checks that the FSM didn't hand us a
811 * page that has since been repurposed for the revmap.)
812 */
813 freespace = *extended ?
815 if (freespace >= itemsz)
816 {
817 RelationSetTargetBlock(irel, newblk);
818
819 /*
820 * Lock the old buffer if not locked already. Note that in this
821 * case we know for sure it's a regular page: it's later than the
822 * new page we just got, which is not a revmap page, and revmap
823 * pages are always consecutive.
824 */
825 if (BufferIsValid(oldbuf) && oldblk > newblk)
826 {
829 }
830
831 return buf;
832 }
833
834 /* This page is no good. */
835
836 /*
837 * If an entirely new page does not contain enough free space for the
838 * new item, then surely that item is oversized. Complain loudly; but
839 * first make sure we initialize the page and record it as free, for
840 * next time.
841 */
842 if (*extended)
843 {
845 /* since this should not happen, skip FreeSpaceMapVacuum */
846
848 (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
849 errmsg("index row size %zu exceeds maximum %zu for index \"%s\"",
850 itemsz, freespace, RelationGetRelationName(irel))));
851 return InvalidBuffer; /* keep compiler quiet */
852 }
853
854 if (newblk != oldblk)
856 if (BufferIsValid(oldbuf) && oldblk <= newblk)
858
859 /*
860 * Update the FSM with the new, presumably smaller, freespace value
861 * for this page, then search for a new target page.
862 */
863 newblk = RecordAndGetPageWithFreeSpace(irel, newblk, freespace, itemsz);
864 }
865}
866
867/*
868 * Initialize a page as an empty regular BRIN page, WAL-log this, and record
869 * the page in FSM.
870 *
871 * There are several corner situations in which we extend the relation to
872 * obtain a new page and later find that we cannot use it immediately. When
873 * that happens, we don't want to leave the page go unrecorded in FSM, because
874 * there is no mechanism to get the space back and the index would bloat.
875 * Also, because we would not WAL-log the action that would initialize the
876 * page, the page would go uninitialized in a standby (or after recovery).
877 *
878 * While we record the page in FSM here, caller is responsible for doing FSM
879 * upper-page update if that seems appropriate.
880 */
881static void
883{
884 Page page;
885
887 "brin_initialize_empty_new_buffer: initializing blank page %u",
888 BufferGetBlockNumber(buffer)));
889
891 page = BufferGetPage(buffer);
893 MarkBufferDirty(buffer);
894 log_newpage_buffer(buffer, true);
896
897 /*
898 * We update the FSM for this page, but this is not WAL-logged. This is
899 * acceptable because VACUUM will scan the index and update the FSM with
900 * pages whose FSM records were forgotten in a crash.
901 */
904}
905
906
907/*
908 * Return the amount of free space on a regular BRIN index page.
909 *
910 * If the page is not a regular page, or has been marked with the
911 * BRIN_EVACUATE_PAGE flag, returns 0.
912 */
913static Size
915{
916 if (!BRIN_IS_REGULAR_PAGE(page) ||
917 (BrinPageFlags(page) & BRIN_EVACUATE_PAGE) != 0)
918 return 0;
919 else
920 return PageGetFreeSpace(page);
921}
uint32 BlockNumber
Definition: block.h:31
#define InvalidBlockNumber
Definition: block.h:33
#define BRIN_elog(args)
Definition: brin_internal.h:85
#define BRIN_IS_META_PAGE(page)
Definition: brin_page.h:55
#define BrinPageFlags(page)
Definition: brin_page.h:46
#define BRIN_META_MAGIC
Definition: brin_page.h:73
#define BRIN_EVACUATE_PAGE
Definition: brin_page.h:60
#define BRIN_PAGETYPE_REGULAR
Definition: brin_page.h:53
#define BRIN_PAGETYPE_META
Definition: brin_page.h:51
#define BRIN_IS_REVMAP_PAGE(page)
Definition: brin_page.h:56
#define BrinPageType(page)
Definition: brin_page.h:42
#define BRIN_IS_REGULAR_PAGE(page)
Definition: brin_page.h:57
void brin_evacuate_page(Relation idxRel, BlockNumber pagesPerRange, BrinRevmap *revmap, Buffer buf)
Definition: brin_pageops.c:562
bool brin_start_evacuating_page(Relation idxRel, Buffer buf)
Definition: brin_pageops.c:522
bool brin_doupdate(Relation idxrel, BlockNumber pagesPerRange, BrinRevmap *revmap, BlockNumber heapBlk, Buffer oldbuf, OffsetNumber oldoff, const BrinTuple *origtup, Size origsz, const BrinTuple *newtup, Size newsz, bool samepage)
Definition: brin_pageops.c:53
static void brin_initialize_empty_new_buffer(Relation idxrel, Buffer buffer)
Definition: brin_pageops.c:882
void brin_page_cleanup(Relation idxrel, Buffer buf)
Definition: brin_pageops.c:622
OffsetNumber brin_doinsert(Relation idxrel, BlockNumber pagesPerRange, BrinRevmap *revmap, Buffer *buffer, BlockNumber heapBlk, const BrinTuple *tup, Size itemsz)
Definition: brin_pageops.c:341
#define BrinMaxItemSize
Definition: brin_pageops.c:28
void brin_page_init(Page page, uint16 type)
Definition: brin_pageops.c:473
static Size br_page_get_freespace(Page page)
Definition: brin_pageops.c:914
static Buffer brin_getinsertbuffer(Relation irel, Buffer oldbuf, Size itemsz, bool *extended)
Definition: brin_pageops.c:688
void brin_metapage_init(Page page, BlockNumber pagesPerRange, uint16 version)
Definition: brin_pageops.c:484
bool brin_can_do_samepage_update(Buffer buffer, Size origsz, Size newsz)
Definition: brin_pageops.c:322
void brinRevmapExtend(BrinRevmap *revmap, BlockNumber heapBlk)
Definition: brin_revmap.c:112
void brinSetHeapBlockItemptr(Buffer buf, BlockNumber pagesPerRange, BlockNumber heapBlk, ItemPointerData tid)
Definition: brin_revmap.c:155
Buffer brinLockRevmapPageForUpdate(BrinRevmap *revmap, BlockNumber heapBlk)
Definition: brin_revmap.c:134
BrinTuple * brin_copy_tuple(BrinTuple *tuple, Size len, BrinTuple *dest, Size *destsz)
Definition: brin_tuple.c:446
bool brin_tuples_equal(const BrinTuple *a, Size alen, const BrinTuple *b, Size blen)
Definition: brin_tuple.c:465
#define SizeOfBrinInsert
Definition: brin_xlog.h:74
#define SizeOfBrinUpdate
Definition: brin_xlog.h:95
#define XLOG_BRIN_SAMEPAGE_UPDATE
Definition: brin_xlog.h:34
#define SizeOfBrinSamepageUpdate
Definition: brin_xlog.h:107
#define XLOG_BRIN_INIT_PAGE
Definition: brin_xlog.h:43
#define XLOG_BRIN_UPDATE
Definition: brin_xlog.h:33
#define XLOG_BRIN_INSERT
Definition: brin_xlog.h:32
int Buffer
Definition: buf.h:23
#define InvalidBuffer
Definition: buf.h:25
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:4224
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:5371
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:5388
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:2937
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:5605
void MarkBufferDirtyHint(Buffer buffer, bool buffer_std)
Definition: bufmgr.c:5435
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:745
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:203
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:204
#define P_NEW
Definition: bufmgr.h:198
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:425
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:205
static bool BufferIsValid(Buffer bufnum)
Definition: bufmgr.h:376
Size PageGetFreeSpace(const PageData *page)
Definition: bufpage.c:906
bool PageIndexTupleOverwrite(Page page, OffsetNumber offnum, const void *newtup, Size newsize)
Definition: bufpage.c:1404
Size PageGetExactFreeSpace(const PageData *page)
Definition: bufpage.c:957
void PageInit(Page page, Size pageSize, Size specialSize)
Definition: bufpage.c:42
void PageIndexTupleDeleteNoCompact(Page page, OffsetNumber offnum)
Definition: bufpage.c:1294
PageHeaderData * PageHeader
Definition: bufpage.h:173
static void * PageGetItem(const PageData *page, const ItemIdData *itemId)
Definition: bufpage.h:353
static bool PageIsNew(const PageData *page)
Definition: bufpage.h:233
static char * PageGetContents(Page page)
Definition: bufpage.h:257
static ItemId PageGetItemId(Page page, OffsetNumber offsetNumber)
Definition: bufpage.h:243
static void PageSetLSN(Page page, XLogRecPtr lsn)
Definition: bufpage.h:390
PageData * Page
Definition: bufpage.h:81
#define PageAddItem(page, item, size, offsetNumber, overwrite, is_heap)
Definition: bufpage.h:471
static OffsetNumber PageGetMaxOffsetNumber(const PageData *page)
Definition: bufpage.h:371
#define MAXALIGN(LEN)
Definition: c.h:814
uint8_t uint8
Definition: c.h:540
uint16_t uint16
Definition: c.h:541
size_t Size
Definition: c.h:614
int errcode(int sqlerrcode)
Definition: elog.c:863
int errmsg(const char *fmt,...)
Definition: elog.c:1080
#define DEBUG2
Definition: elog.h:29
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:226
#define ereport(elevel,...)
Definition: elog.h:150
void FreeSpaceMapVacuumRange(Relation rel, BlockNumber start, BlockNumber end)
Definition: freespace.c:377
BlockNumber RecordAndGetPageWithFreeSpace(Relation rel, BlockNumber oldPage, Size oldSpaceAvail, Size spaceNeeded)
Definition: freespace.c:154
void RecordPageWithFreeSpace(Relation rel, BlockNumber heapBlk, Size spaceAvail)
Definition: freespace.c:194
BlockNumber GetPageWithFreeSpace(Relation rel, Size spaceNeeded)
Definition: freespace.c:137
Assert(PointerIsAligned(start, uint64))
#define ItemIdGetLength(itemId)
Definition: itemid.h:59
#define ItemIdIsNormal(itemId)
Definition: itemid.h:99
#define ItemIdIsUsed(itemId)
Definition: itemid.h:92
static void ItemPointerSet(ItemPointerData *pointer, BlockNumber blockNumber, OffsetNumber offNum)
Definition: itemptr.h:135
void LockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:424
void UnlockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:474
#define ExclusiveLock
Definition: lockdefs.h:42
#define ShareLock
Definition: lockdefs.h:40
#define START_CRIT_SECTION()
Definition: miscadmin.h:149
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:122
#define END_CRIT_SECTION()
Definition: miscadmin.h:151
#define InvalidOffsetNumber
Definition: off.h:26
uint16 OffsetNumber
Definition: off.h:24
#define FirstOffsetNumber
Definition: off.h:27
static char * buf
Definition: pg_test_fsync.c:72
#define RELATION_IS_LOCAL(relation)
Definition: rel.h:658
#define RelationGetRelationName(relation)
Definition: rel.h:549
#define RelationGetTargetBlock(relation)
Definition: rel.h:611
#define RelationNeedsWAL(relation)
Definition: rel.h:638
#define RelationSetTargetBlock(relation, targblock)
Definition: rel.h:618
uint32 brinVersion
Definition: brin_page.h:67
uint32 brinMagic
Definition: brin_page.h:66
BlockNumber lastRevmapPage
Definition: brin_page.h:69
BlockNumber pagesPerRange
Definition: brin_page.h:68
BlockNumber bt_blkno
Definition: brin_tuple.h:66
OffsetNumber offnum
Definition: brin_xlog.h:71
BlockNumber pagesPerRange
Definition: brin_xlog.h:68
BlockNumber heapBlk
Definition: brin_xlog.h:65
OffsetNumber offnum
Definition: brin_xlog.h:104
OffsetNumber oldOffnum
Definition: brin_xlog.h:90
xl_brin_insert insert
Definition: brin_xlog.h:92
const char * type
uint64 XLogRecPtr
Definition: xlogdefs.h:21
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:478
void XLogRegisterBufData(uint8 block_id, const void *data, uint32 len)
Definition: xloginsert.c:409
void XLogRegisterData(const void *data, uint32 len)
Definition: xloginsert.c:368
XLogRecPtr log_newpage_buffer(Buffer buffer, bool page_std)
Definition: xloginsert.c:1259
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:245
void XLogBeginInsert(void)
Definition: xloginsert.c:152
#define REGBUF_STANDARD
Definition: xloginsert.h:35
#define REGBUF_WILL_INIT
Definition: xloginsert.h:34