PostgreSQL Source Code git master
Loading...
Searching...
No Matches
localbuf.c File Reference
#include "postgres.h"
#include "access/parallel.h"
#include "executor/instrument.h"
#include "pgstat.h"
#include "storage/aio.h"
#include "storage/buf_internals.h"
#include "storage/bufmgr.h"
#include "storage/fd.h"
#include "utils/guc_hooks.h"
#include "utils/memdebug.h"
#include "utils/memutils.h"
#include "utils/rel.h"
#include "utils/resowner.h"
Include dependency graph for localbuf.c:

Go to the source code of this file.

Data Structures

struct  LocalBufferLookupEnt
 

Macros

#define LocalBufHdrGetBlock(bufHdr)    LocalBufferBlockPointers[-((bufHdr)->buf_id + 2)]
 

Functions

static void InitLocalBuffers (void)
 
static Block GetLocalBufferStorage (void)
 
static Buffer GetLocalVictimBuffer (void)
 
PrefetchBufferResult PrefetchLocalBuffer (SMgrRelation smgr, ForkNumber forkNum, BlockNumber blockNum)
 
BufferDescLocalBufferAlloc (SMgrRelation smgr, ForkNumber forkNum, BlockNumber blockNum, bool *foundPtr)
 
void FlushLocalBuffer (BufferDesc *bufHdr, SMgrRelation reln)
 
uint32 GetLocalPinLimit (void)
 
uint32 GetAdditionalLocalPinLimit (void)
 
void LimitAdditionalLocalPins (uint32 *additional_pins)
 
BlockNumber ExtendBufferedRelLocal (BufferManagerRelation bmr, ForkNumber fork, uint32 flags, uint32 extend_by, BlockNumber extend_upto, Buffer *buffers, uint32 *extended_by)
 
void MarkLocalBufferDirty (Buffer buffer)
 
StartBufferIOResult StartLocalBufferIO (BufferDesc *bufHdr, bool forInput, bool wait, PgAioWaitRef *io_wref)
 
void TerminateLocalBufferIO (BufferDesc *bufHdr, bool clear_dirty, uint64 set_flag_bits, bool release_aio)
 
void InvalidateLocalBuffer (BufferDesc *bufHdr, bool check_unreferenced)
 
void DropRelationLocalBuffers (RelFileLocator rlocator, ForkNumber *forkNum, int nforks, BlockNumber *firstDelBlock)
 
void DropRelationAllLocalBuffers (RelFileLocator rlocator)
 
bool PinLocalBuffer (BufferDesc *buf_hdr, bool adjust_usagecount)
 
void UnpinLocalBuffer (Buffer buffer)
 
void UnpinLocalBufferNoOwner (Buffer buffer)
 
bool check_temp_buffers (int *newval, void **extra, GucSource source)
 
static void CheckForLocalBufferLeaks (void)
 
void AtEOXact_LocalBuffers (bool isCommit)
 
void AtProcExit_LocalBuffers (void)
 

Variables

int NLocBuffer = 0
 
BufferDescLocalBufferDescriptors = NULL
 
BlockLocalBufferBlockPointers = NULL
 
int32LocalRefCount = NULL
 
static int nextFreeLocalBufId = 0
 
static HTABLocalBufHash = NULL
 
static int NLocalPinnedBuffers = 0
 

Macro Definition Documentation

◆ LocalBufHdrGetBlock

#define LocalBufHdrGetBlock (   bufHdr)     LocalBufferBlockPointers[-((bufHdr)->buf_id + 2)]

Definition at line 42 of file localbuf.c.

73{
75 BufferTag newTag; /* identity of requested block */
77
78 InitBufferTag(&newTag, &smgr->smgr_rlocator.locator, forkNum, blockNum);
79
80 /* Initialize local buffers if first request in this session */
81 if (LocalBufHash == NULL)
83
84 /* See if the desired buffer already exists */
87
88 if (hresult)
89 {
90 /* Yes, so nothing to do */
91 result.recent_buffer = -hresult->id - 1;
92 }
93 else
94 {
95#ifdef USE_PREFETCH
96 /* Not in buffers, so initiate prefetch */
97 if ((io_direct_flags & IO_DIRECT_DATA) == 0 &&
98 smgrprefetch(smgr, forkNum, blockNum, 1))
99 {
100 result.initiated_io = true;
101 }
102#endif /* USE_PREFETCH */
103 }
104
105 return result;
106}
107
108
109/*
110 * LocalBufferAlloc -
111 * Find or create a local buffer for the given page of the given relation.
112 *
113 * API is similar to bufmgr.c's BufferAlloc, except that we do not need to do
114 * any locking since this is all local. We support only default access
115 * strategy (hence, usage_count is always advanced).
116 */
119 bool *foundPtr)
120{
121 BufferTag newTag; /* identity of requested block */
125 int bufid;
126 bool found;
127
128 InitBufferTag(&newTag, &smgr->smgr_rlocator.locator, forkNum, blockNum);
129
130 /* Initialize local buffers if first request in this session */
131 if (LocalBufHash == NULL)
133
135
136 /* See if the desired buffer already exists */
139
140 if (hresult)
141 {
142 bufid = hresult->id;
145
147 }
148 else
149 {
151
153 bufid = -victim_buffer - 1;
155
158 if (found) /* shouldn't happen */
159 elog(ERROR, "local buffer hash table corrupted");
160 hresult->id = bufid;
161
162 /*
163 * it's all ours now.
164 */
165 bufHdr->tag = newTag;
166
171
172 *foundPtr = false;
173 }
174
175 return bufHdr;
176}
177
178/*
179 * Like FlushBuffer(), just for local buffers.
180 */
181void
183{
186
188
189 /*
190 * Try to start an I/O operation. There currently are no reasons for
191 * StartLocalBufferIO to return anything other than
192 * BUFFER_IO_READY_FOR_IO, so we raise an error in that case.
193 */
195 elog(ERROR, "failed to start write IO on local buffer");
196
197 /* Find smgr relation for buffer */
198 if (reln == NULL)
201
202 PageSetChecksum(localpage, bufHdr->tag.blockNum);
203
205
206 /* And write... */
209 bufHdr->tag.blockNum,
210 localpage,
211 false);
212
213 /* Temporary table I/O does not use Buffer Access Strategies */
216
217 /* Mark not-dirty */
218 TerminateLocalBufferIO(bufHdr, true, 0, false);
219
221}
222
223static Buffer
225{
226 int victim_bufid;
227 int trycounter;
229
231
232 /*
233 * Need to get a new buffer. We use a clock-sweep algorithm (essentially
234 * the same as what freelist.c does now...)
235 */
237 for (;;)
238 {
240
243
245
246 if (LocalRefCount[victim_bufid] == 0)
247 {
249
251 {
255 }
256 else if (BUF_STATE_GET_REFCOUNT(buf_state) > 0)
257 {
258 /*
259 * This can be reached if the backend initiated AIO for this
260 * buffer and then errored out.
261 */
262 }
263 else
264 {
265 /* Found a usable buffer */
266 PinLocalBuffer(bufHdr, false);
267 break;
268 }
269 }
270 else if (--trycounter == 0)
273 errmsg("no empty local buffer available")));
274 }
275
276 /*
277 * lazy memory allocation: allocate space on first use of a buffer.
278 */
280 {
281 /* Set pointer for use by BufferGetBlock() macro */
283 }
284
285 /*
286 * this buffer is not referenced but it might still be dirty. if that's
287 * the case, write it out before reusing it!
288 */
289 if (pg_atomic_read_u64(&bufHdr->state) & BM_DIRTY)
291
292 /*
293 * Remove the victim buffer from the hashtable and mark as invalid.
294 */
296 {
298
300 }
301
303}
304
305/* see GetPinLimit() */
306uint32
308{
309 /* Every backend has its own temporary buffers, and can pin them all. */
310 return num_temp_buffers;
311}
312
313/* see GetAdditionalPinLimit() */
314uint32
316{
319}
320
321/* see LimitAdditionalPins() */
322void
324{
326
327 if (*additional_pins <= 1)
328 return;
329
330 /*
331 * In contrast to LimitAdditionalPins() other backends don't play a role
332 * here. We can allow up to NLocBuffer pins in total, but it might not be
333 * initialized yet so read num_temp_buffers.
334 */
336
339}
340
341/*
342 * Implementation of ExtendBufferedRelBy() and ExtendBufferedRelTo() for
343 * temporary buffers.
344 */
348 uint32 flags,
351 Buffer *buffers,
353{
356
357 /* Initialize local buffers if first request in this session */
358 if (LocalBufHash == NULL)
360
362
363 for (uint32 i = 0; i < extend_by; i++)
364 {
367
368 buffers[i] = GetLocalVictimBuffer();
369 buf_hdr = GetLocalBufferDescriptor(-buffers[i] - 1);
371
372 /* new buffers are zero-filled */
374 }
375
377
379 {
380 /*
381 * In contrast to shared relations, nothing could change the relation
382 * size concurrently. Thus we shouldn't end up finding that we don't
383 * need to do anything.
384 */
386
388 }
389
390 /* Fail if relation is already at maximum possible length */
394 errmsg("cannot extend relation %s beyond %u blocks",
395 relpath(BMR_GET_SMGR(bmr)->smgr_rlocator, fork).str,
397
398 for (uint32 i = 0; i < extend_by; i++)
399 {
400 int victim_buf_id;
402 BufferTag tag;
404 bool found;
405
406 victim_buf_id = -buffers[i] - 1;
408
409 /* in case we need to pin an existing buffer below */
411
412 InitBufferTag(&tag, &BMR_GET_SMGR(bmr)->smgr_rlocator.locator, fork,
413 first_block + i);
414
416 hash_search(LocalBufHash, &tag, HASH_ENTER, &found);
417 if (found)
418 {
421
423
427
428 /*
429 * Clear the BM_VALID bit, do StartLocalBufferIO() and proceed.
430 */
436
437 /* no need to loop for local buffers */
439 }
440 else
441 {
443
445
446 victim_buf_hdr->tag = tag;
447
449
451
453
455 }
456 }
457
459
460 /* actually extend relation */
462
465
466 for (uint32 i = 0; i < extend_by; i++)
467 {
468 Buffer buf = buffers[i];
471
473
477 }
478
480
482
483 return first_block;
484}
485
486/*
487 * MarkLocalBufferDirty -
488 * mark a local buffer dirty
489 */
490void
492{
493 int bufid;
496
497 Assert(BufferIsLocal(buffer));
498
499#ifdef LBDEBUG
500 fprintf(stderr, "LB DIRTY %d\n", buffer);
501#endif
502
503 bufid = -buffer - 1;
504
506
508
510
511 if (!(buf_state & BM_DIRTY))
513
515
517}
518
519/*
520 * Like StartSharedBufferIO, but for local buffers
521 */
523StartLocalBufferIO(BufferDesc *bufHdr, bool forInput, bool wait, PgAioWaitRef *io_wref)
524{
526
527 /*
528 * With AIO the buffer could have IO in progress, e.g. when there are two
529 * scans of the same relation. Either wait for the other IO (if wait =
530 * true and io_wref == NULL) or return BUFFER_IO_IN_PROGRESS;
531 */
532 if (pgaio_wref_valid(&bufHdr->io_wref))
533 {
534 PgAioWaitRef buf_wref = bufHdr->io_wref;
535
536 if (io_wref != NULL)
537 {
538 /* We've already asynchronously started this IO, so join it */
539 *io_wref = buf_wref;
541 }
542
543 /*
544 * For temp buffers we should never need to wait in
545 * StartLocalBufferIO() when called with io_wref == NULL while there
546 * are staged IOs, as it's not allowed to call code that is not aware
547 * of AIO while in batch mode.
548 */
550
551 if (!wait)
553
555 }
556
557 /* Once we get here, there is definitely no I/O active on this buffer */
558
559 /* Check if someone else already did the I/O */
562 {
564 }
565
566 /* BM_IO_IN_PROGRESS isn't currently used for local buffers */
567
568 /* local buffers don't track IO using resowners */
569
571}
572
573/*
574 * Like TerminateBufferIO, but for local buffers
575 */
576void
578 bool release_aio)
579{
580 /* Only need to adjust flags */
582
583 /* BM_IO_IN_PROGRESS isn't currently used for local buffers */
584
585 /* Clear earlier errors, if this IO failed, it'll be marked again */
587
588 if (clear_dirty)
590
591 if (release_aio)
592 {
593 /* release pin held by IO subsystem, see also buffer_stage_common() */
596 pgaio_wref_clear(&bufHdr->io_wref);
597 }
598
601
602 /* local buffers don't track IO using resowners */
603
604 /* local buffers don't use the IO CV, as no other process can see buffer */
605
606 /* local buffers don't use BM_PIN_COUNT_WAITER, so no need to wake */
607}
608
609/*
610 * InvalidateLocalBuffer -- mark a local buffer invalid.
611 *
612 * If check_unreferenced is true, error out if the buffer is still
613 * pinned. Passing false is appropriate when calling InvalidateLocalBuffer()
614 * as part of changing the identity of a buffer, instead of just dropping the
615 * buffer.
616 *
617 * See also InvalidateBuffer().
618 */
619void
621{
623 int bufid = -buffer - 1;
626
627 /*
628 * It's possible that we started IO on this buffer before e.g. aborting
629 * the transaction that created a table. We need to wait for that IO to
630 * complete before removing / reusing the buffer.
631 */
632 if (pgaio_wref_valid(&bufHdr->io_wref))
633 {
634 PgAioWaitRef iow = bufHdr->io_wref;
635
637 Assert(!pgaio_wref_valid(&bufHdr->io_wref));
638 }
639
641
642 /*
643 * We need to test not just LocalRefCount[bufid] but also the BufferDesc
644 * itself, as the latter is used to represent a pin by the AIO subsystem.
645 * This can happen if AIO is initiated and then the query errors out.
646 */
647 if (check_unreferenced &&
649 elog(ERROR, "block %u of %s is still referenced (local %d)",
650 bufHdr->tag.blockNum,
653 BufTagGetForkNum(&bufHdr->tag)).str,
655
656 /* Remove entry from hashtable */
659 if (!hresult) /* shouldn't happen */
660 elog(ERROR, "local buffer hash table corrupted");
661 /* Mark buffer invalid */
662 ClearBufferTag(&bufHdr->tag);
666}
667
668/*
669 * DropRelationLocalBuffers
670 * This function removes from the buffer pool all the pages of the
671 * specified relation that have block numbers >= firstDelBlock.
672 * (In particular, with firstDelBlock = 0, all pages are removed.)
673 * Dirty pages are simply dropped, without bothering to write them
674 * out first. Therefore, this is NOT rollback-able, and so should be
675 * used only with extreme caution!
676 *
677 * See DropRelationBuffers in bufmgr.c for more notes.
678 */
679void
682{
683 int i;
684 int j;
685
686 for (i = 0; i < NLocBuffer; i++)
687 {
690
692
693 if (!(buf_state & BM_TAG_VALID) ||
694 !BufTagMatchesRelFileLocator(&bufHdr->tag, &rlocator))
695 continue;
696
697 for (j = 0; j < nforks; j++)
698 {
699 if (BufTagGetForkNum(&bufHdr->tag) == forkNum[j] &&
700 bufHdr->tag.blockNum >= firstDelBlock[j])
701 {
703 break;
704 }
705 }
706 }
707}
708
709/*
710 * DropRelationAllLocalBuffers
711 * This function removes from the buffer pool all pages of all forks
712 * of the specified relation.
713 *
714 * See DropRelationsAllBuffers in bufmgr.c for more notes.
715 */
716void
718{
719 int i;
720
721 for (i = 0; i < NLocBuffer; i++)
722 {
725
727
728 if ((buf_state & BM_TAG_VALID) &&
729 BufTagMatchesRelFileLocator(&bufHdr->tag, &rlocator))
730 {
732 }
733 }
734}
735
736/*
737 * InitLocalBuffers -
738 * init the local buffer cache. Since most queries (esp. multi-user ones)
739 * don't involve local buffers, we delay allocating actual memory for the
740 * buffers until we need them; just make the buffer headers here.
741 */
742static void
744{
746 HASHCTL info;
747 int i;
748
749 /*
750 * Parallel workers can't access data in temporary tables, because they
751 * have no visibility into the local buffers of their leader. This is a
752 * convenient, low-cost place to provide a backstop check for that. Note
753 * that we don't wish to prevent a parallel worker from accessing catalog
754 * metadata about a temp table, so checks at higher levels would be
755 * inappropriate.
756 */
757 if (IsParallelWorker())
760 errmsg("cannot access temporary tables during a parallel operation")));
761
762 /* Allocate and zero buffer headers and auxiliary arrays */
765 LocalRefCount = (int32 *) calloc(nbufs, sizeof(int32));
769 errmsg("out of memory")));
770
772
773 /* initialize fields that need to start off nonzero */
774 for (i = 0; i < nbufs; i++)
775 {
777
778 /*
779 * negative to indicate local buffer. This is tricky: shared buffers
780 * start with 0. We have to start with -2. (Note that the routine
781 * BufferDescriptorGetBuffer adds 1 to buf_id so our first buffer id
782 * is -1.)
783 */
784 buf->buf_id = -i - 2;
785
786 pgaio_wref_clear(&buf->io_wref);
787
788 /*
789 * Intentionally do not initialize the buffer's atomic variable
790 * (besides zeroing the underlying memory above). That way we get
791 * errors on platforms without atomics, if somebody (re-)introduces
792 * atomic operations for local buffers.
793 */
794 }
795
796 /* Create the lookup hash table */
797 info.keysize = sizeof(BufferTag);
798 info.entrysize = sizeof(LocalBufferLookupEnt);
799
800 LocalBufHash = hash_create("Local Buffer Lookup Table",
801 nbufs,
802 &info,
804
805 if (!LocalBufHash)
806 elog(ERROR, "could not initialize local buffer hash table");
807
808 /* Initialization done, mark buffers allocated */
810}
811
812/*
813 * XXX: We could have a slightly more efficient version of PinLocalBuffer()
814 * that does not support adjusting the usagecount - but so far it does not
815 * seem worth the trouble.
816 *
817 * Note that ResourceOwnerEnlarge() must have been done already.
818 */
819bool
821{
824 int bufid = -buffer - 1;
825
827
828 if (LocalRefCount[bufid] == 0)
829 {
832 if (adjust_usagecount &&
834 {
836 }
838
839 /*
840 * See comment in PinBuffer().
841 *
842 * If the buffer isn't allocated yet, it'll be marked as defined in
843 * GetLocalBufferStorage().
844 */
847 }
851
852 return buf_state & BM_VALID;
853}
854
855void
857{
860}
861
862void
864{
865 int buffid = -buffer - 1;
866
867 Assert(BufferIsLocal(buffer));
870
871 if (--LocalRefCount[buffid] == 0)
872 {
875
877
882
883 /* see comment in UnpinBufferNoOwner */
885 }
886}
887
888/*
889 * GUC check_hook for temp_buffers
890 */
891bool
892check_temp_buffers(int *newval, void **extra, GucSource source)
893{
894 /*
895 * Once local buffers have been initialized, it's too late to change this.
896 * However, if this is only a test call, allow it.
897 */
899 {
900 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
901 return false;
902 }
903 return true;
904}
905
906/*
907 * GetLocalBufferStorage - allocate memory for a local buffer
908 *
909 * The idea of this function is to aggregate our requests for storage
910 * so that the memory manager doesn't see a whole lot of relatively small
911 * requests. Since we'll never give back a local buffer once it's created
912 * within a particular process, no point in burdening memmgr with separately
913 * managed chunks.
914 */
915static Block
917{
918 static char *cur_block = NULL;
919 static int next_buf_in_block = 0;
920 static int num_bufs_in_block = 0;
921 static int total_bufs_allocated = 0;
923
924 char *this_buf;
925
927
929 {
930 /* Need to make a new request to memmgr */
931 int num_bufs;
932
933 /*
934 * We allocate local buffers in a context of their own, so that the
935 * space eaten for them is easily recognizable in MemoryContextStats
936 * output. Create the context on first use.
937 */
941 "LocalBufferContext",
943
944 /* Start with a 16-buffer request; subsequent ones double each time */
945 num_bufs = Max(num_bufs_in_block * 2, 16);
946 /* But not more than what we need for all remaining local bufs */
948 /* And don't overflow MaxAllocSize, either */
950
951 /* Buffers should be I/O aligned. */
955 0);
956
959 }
960
961 /* Allocate next buffer in current memory block */
965
966 /*
967 * Caller's PinLocalBuffer() was too early for Valgrind updates, so do it
968 * here. The block is actually undefined, but we want consistency with
969 * the regular case of not needing to allocate memory. This is
970 * specifically needed when method_io_uring.c fills the block, because
971 * Valgrind doesn't recognize io_uring reads causing undefined memory to
972 * become defined.
973 */
975
976 return (Block) this_buf;
977}
978
979/*
980 * CheckForLocalBufferLeaks - ensure this backend holds no local buffer pins
981 *
982 * This is just like CheckForBufferLeaks(), but for local buffers.
983 */
984static void
986{
987#ifdef USE_ASSERT_CHECKING
988 if (LocalRefCount)
989 {
990 int RefCountErrors = 0;
991 int i;
992
993 for (i = 0; i < NLocBuffer; i++)
994 {
995 if (LocalRefCount[i] != 0)
996 {
997 Buffer b = -i - 1;
998 char *s;
999
1001 elog(WARNING, "local buffer refcount leak: %s", s);
1002 pfree(s);
1003
1005 }
1006 }
1007 Assert(RefCountErrors == 0);
1008 }
1009#endif
1010}
1011
1012/*
1013 * AtEOXact_LocalBuffers - clean up at end of transaction.
1014 *
1015 * This is just like AtEOXact_Buffers, but for local buffers.
1016 */
1017void
1019{
1021}
1022
1023/*
1024 * AtProcExit_LocalBuffers - ensure we have dropped pins during backend exit.
1025 *
1026 * This is just like AtProcExit_Buffers, but for local buffers.
1027 */
1028void
1030{
1031 /*
1032 * We shouldn't be holding any remaining pins; if we are, and assertions
1033 * aren't enabled, we'll fail later in DropRelationBuffers while trying to
1034 * drop the temp rels.
1035 */
1037}
bool pgaio_wref_valid(PgAioWaitRef *iow)
Definition aio.c:971
void pgaio_wref_clear(PgAioWaitRef *iow)
Definition aio.c:964
bool pgaio_have_staged(void)
Definition aio.c:1117
void pgaio_wref_wait(PgAioWaitRef *iow)
Definition aio.c:991
static void pg_atomic_unlocked_write_u64(volatile pg_atomic_uint64 *ptr, uint64 val)
Definition atomics.h:494
static uint64 pg_atomic_read_u64(volatile pg_atomic_uint64 *ptr)
Definition atomics.h:467
uint32 BlockNumber
Definition block.h:31
#define InvalidBlockNumber
Definition block.h:33
#define MaxBlockNumber
Definition block.h:35
int Buffer
Definition buf.h:23
#define InvalidBuffer
Definition buf.h:25
#define BufferIsLocal(buffer)
Definition buf.h:37
#define BM_MAX_USAGE_COUNT
static void InitBufferTag(BufferTag *tag, const RelFileLocator *rlocator, ForkNumber forkNum, BlockNumber blockNum)
#define BM_TAG_VALID
#define BUF_USAGECOUNT_MASK
static ForkNumber BufTagGetForkNum(const BufferTag *tag)
#define BUF_REFCOUNT_ONE
static bool BufferTagsEqual(const BufferTag *tag1, const BufferTag *tag2)
static bool BufTagMatchesRelFileLocator(const BufferTag *tag, const RelFileLocator *rlocator)
#define BUF_FLAG_MASK
#define BM_DIRTY
#define BUF_STATE_GET_USAGECOUNT(state)
StartBufferIOResult
@ BUFFER_IO_IN_PROGRESS
@ BUFFER_IO_ALREADY_DONE
@ BUFFER_IO_READY_FOR_IO
static void ClearBufferTag(BufferTag *tag)
static void ResourceOwnerRememberBuffer(ResourceOwner owner, Buffer buffer)
struct buftag BufferTag
static void ResourceOwnerForgetBuffer(ResourceOwner owner, Buffer buffer)
#define BUF_USAGECOUNT_ONE
#define BUF_STATE_GET_REFCOUNT(state)
static RelFileLocator BufTagGetRelFileLocator(const BufferTag *tag)
#define BM_VALID
static BufferDesc * GetLocalBufferDescriptor(uint32 id)
static Buffer BufferDescriptorGetBuffer(const BufferDesc *bdesc)
bool track_io_timing
Definition bufmgr.c:192
char * DebugPrintBufferRefcount(Buffer buffer)
Definition bufmgr.c:4389
void * Block
Definition bufmgr.h:26
#define BMR_GET_SMGR(bmr)
Definition bufmgr.h:118
void PageSetChecksum(Page page, BlockNumber blkno)
Definition bufpage.c:1518
PageData * Page
Definition bufpage.h:81
#define Min(x, y)
Definition c.h:1091
#define Max(x, y)
Definition c.h:1085
#define Assert(condition)
Definition c.h:943
int32_t int32
Definition c.h:620
uint64_t uint64
Definition c.h:625
uint32_t uint32
Definition c.h:624
#define MemSet(start, val, len)
Definition c.h:1107
uint32 result
#define fprintf(file, fmt, msg)
Definition cubescan.l:21
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition dynahash.c:889
HTAB * hash_create(const char *tabname, int64 nelem, const HASHCTL *info, int flags)
Definition dynahash.c:360
int errcode(int sqlerrcode)
Definition elog.c:874
#define FATAL
Definition elog.h:42
#define WARNING
Definition elog.h:37
#define ERROR
Definition elog.h:40
#define elog(elevel,...)
Definition elog.h:228
#define ereport(elevel,...)
Definition elog.h:152
int io_direct_flags
Definition fd.c:172
#define IO_DIRECT_DATA
Definition fd.h:54
#define MaxAllocSize
Definition fe_memutils.h:22
ProcNumber MyProcNumber
Definition globals.c:92
#define newval
#define GUC_check_errdetail
Definition guc.h:507
GucSource
Definition guc.h:112
@ PGC_S_TEST
Definition guc.h:125
int num_temp_buffers
Definition guc_tables.c:580
const char * str
@ HASH_FIND
Definition hsearch.h:108
@ HASH_REMOVE
Definition hsearch.h:110
@ HASH_ENTER
Definition hsearch.h:109
#define HASH_ELEM
Definition hsearch.h:90
#define HASH_BLOBS
Definition hsearch.h:92
#define IsParallelWorker()
Definition parallel.h:62
BufferUsage pgBufferUsage
Definition instrument.c:25
int b
Definition isn.c:74
int j
Definition isn.c:78
int i
Definition isn.c:77
int32 * LocalRefCount
Definition localbuf.c:49
void FlushLocalBuffer(BufferDesc *bufHdr, SMgrRelation reln)
Definition localbuf.c:183
void UnpinLocalBuffer(Buffer buffer)
Definition localbuf.c:857
static HTAB * LocalBufHash
Definition localbuf.c:53
static int NLocalPinnedBuffers
Definition localbuf.c:56
void AtEOXact_LocalBuffers(bool isCommit)
Definition localbuf.c:1019
#define LocalBufHdrGetBlock(bufHdr)
Definition localbuf.c:42
static void CheckForLocalBufferLeaks(void)
Definition localbuf.c:986
uint32 GetAdditionalLocalPinLimit(void)
Definition localbuf.c:316
StartBufferIOResult StartLocalBufferIO(BufferDesc *bufHdr, bool forInput, bool wait, PgAioWaitRef *io_wref)
Definition localbuf.c:524
static Block GetLocalBufferStorage(void)
Definition localbuf.c:917
static int nextFreeLocalBufId
Definition localbuf.c:51
bool check_temp_buffers(int *newval, void **extra, GucSource source)
Definition localbuf.c:893
void AtProcExit_LocalBuffers(void)
Definition localbuf.c:1030
bool PinLocalBuffer(BufferDesc *buf_hdr, bool adjust_usagecount)
Definition localbuf.c:821
static void InitLocalBuffers(void)
Definition localbuf.c:744
void LimitAdditionalLocalPins(uint32 *additional_pins)
Definition localbuf.c:324
uint32 GetLocalPinLimit(void)
Definition localbuf.c:308
static Buffer GetLocalVictimBuffer(void)
Definition localbuf.c:225
void MarkLocalBufferDirty(Buffer buffer)
Definition localbuf.c:492
void DropRelationAllLocalBuffers(RelFileLocator rlocator)
Definition localbuf.c:718
void InvalidateLocalBuffer(BufferDesc *bufHdr, bool check_unreferenced)
Definition localbuf.c:621
void TerminateLocalBufferIO(BufferDesc *bufHdr, bool clear_dirty, uint64 set_flag_bits, bool release_aio)
Definition localbuf.c:578
int NLocBuffer
Definition localbuf.c:45
BlockNumber ExtendBufferedRelLocal(BufferManagerRelation bmr, ForkNumber fork, uint32 flags, uint32 extend_by, BlockNumber extend_upto, Buffer *buffers, uint32 *extended_by)
Definition localbuf.c:347
Block * LocalBufferBlockPointers
Definition localbuf.c:48
void UnpinLocalBufferNoOwner(Buffer buffer)
Definition localbuf.c:864
void DropRelationLocalBuffers(RelFileLocator rlocator, ForkNumber *forkNum, int nforks, BlockNumber *firstDelBlock)
Definition localbuf.c:681
BufferDesc * LocalBufferDescriptors
Definition localbuf.c:47
BufferDesc * LocalBufferAlloc(SMgrRelation smgr, ForkNumber forkNum, BlockNumber blockNum, bool *foundPtr)
Definition localbuf.c:119
void pfree(void *pointer)
Definition mcxt.c:1616
void * MemoryContextAllocAligned(MemoryContext context, Size size, Size alignto, int flags)
Definition mcxt.c:1482
MemoryContext TopMemoryContext
Definition mcxt.c:166
#define VALGRIND_MAKE_MEM_DEFINED(addr, size)
Definition memdebug.h:26
#define VALGRIND_MAKE_MEM_NOACCESS(addr, size)
Definition memdebug.h:27
#define AllocSetContextCreate
Definition memutils.h:129
#define ALLOCSET_DEFAULT_SIZES
Definition memutils.h:160
static char * errmsg
#define PG_IO_ALIGN_SIZE
static rewind_source * source
Definition pg_rewind.c:89
static char buf[DEFAULT_XLOG_SEG_SIZE]
@ IOOBJECT_TEMP_RELATION
Definition pgstat.h:282
@ IOCONTEXT_NORMAL
Definition pgstat.h:293
@ IOOP_EXTEND
Definition pgstat.h:318
@ IOOP_EVICT
Definition pgstat.h:311
@ IOOP_WRITE
Definition pgstat.h:320
instr_time pgstat_prepare_io_time(bool track_io_guc)
Definition pgstat_io.c:91
void pgstat_count_io_op(IOObject io_object, IOContext io_context, IOOp io_op, uint32 cnt, uint64 bytes)
Definition pgstat_io.c:68
void pgstat_count_io_op_time(IOObject io_object, IOContext io_context, IOOp io_op, instr_time start_time, uint32 cnt, uint64 bytes)
Definition pgstat_io.c:122
static int fb(int x)
ForkNumber
Definition relpath.h:56
#define relpath(rlocator, forknum)
Definition relpath.h:150
#define relpathbackend(rlocator, backend, forknum)
Definition relpath.h:141
ResourceOwner CurrentResourceOwner
Definition resowner.c:173
void ResourceOwnerEnlarge(ResourceOwner owner)
Definition resowner.c:449
BlockNumber smgrnblocks(SMgrRelation reln, ForkNumber forknum)
Definition smgr.c:819
SMgrRelation smgropen(RelFileLocator rlocator, ProcNumber backend)
Definition smgr.c:240
void smgrzeroextend(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum, int nblocks, bool skipFsync)
Definition smgr.c:649
bool smgrprefetch(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum, int nblocks)
Definition smgr.c:678
static void smgrwrite(SMgrRelation reln, ForkNumber forknum, BlockNumber blocknum, const void *buffer, bool skipFsync)
Definition smgr.h:131
#define calloc(a, b)
int64 local_blks_written
Definition instrument.h:33
int64 local_blks_dirtied
Definition instrument.h:32
Size keysize
Definition hsearch.h:69
Size entrysize
Definition hsearch.h:70
RelFileLocator locator
RelFileLocatorBackend smgr_rlocator
Definition smgr.h:38

Function Documentation

◆ AtEOXact_LocalBuffers()

void AtEOXact_LocalBuffers ( bool  isCommit)

Definition at line 1019 of file localbuf.c.

1020{
1022}

References CheckForLocalBufferLeaks().

Referenced by AtEOXact_Buffers().

◆ AtProcExit_LocalBuffers()

void AtProcExit_LocalBuffers ( void  )

Definition at line 1030 of file localbuf.c.

1031{
1032 /*
1033 * We shouldn't be holding any remaining pins; if we are, and assertions
1034 * aren't enabled, we'll fail later in DropRelationBuffers while trying to
1035 * drop the temp rels.
1036 */
1038}

References CheckForLocalBufferLeaks().

Referenced by AtProcExit_Buffers().

◆ check_temp_buffers()

bool check_temp_buffers ( int newval,
void **  extra,
GucSource  source 
)

Definition at line 893 of file localbuf.c.

894{
895 /*
896 * Once local buffers have been initialized, it's too late to change this.
897 * However, if this is only a test call, allow it.
898 */
900 {
901 GUC_check_errdetail("\"temp_buffers\" cannot be changed after any temporary tables have been accessed in the session.");
902 return false;
903 }
904 return true;
905}

References GUC_check_errdetail, newval, NLocBuffer, PGC_S_TEST, and source.

◆ CheckForLocalBufferLeaks()

static void CheckForLocalBufferLeaks ( void  )
static

Definition at line 986 of file localbuf.c.

987{
988#ifdef USE_ASSERT_CHECKING
989 if (LocalRefCount)
990 {
991 int RefCountErrors = 0;
992 int i;
993
994 for (i = 0; i < NLocBuffer; i++)
995 {
996 if (LocalRefCount[i] != 0)
997 {
998 Buffer b = -i - 1;
999 char *s;
1000
1002 elog(WARNING, "local buffer refcount leak: %s", s);
1003 pfree(s);
1004
1006 }
1007 }
1008 Assert(RefCountErrors == 0);
1009 }
1010#endif
1011}

References Assert, b, DebugPrintBufferRefcount(), elog, fb(), i, LocalRefCount, NLocBuffer, pfree(), and WARNING.

Referenced by AtEOXact_LocalBuffers(), and AtProcExit_LocalBuffers().

◆ DropRelationAllLocalBuffers()

void DropRelationAllLocalBuffers ( RelFileLocator  rlocator)

Definition at line 718 of file localbuf.c.

719{
720 int i;
721
722 for (i = 0; i < NLocBuffer; i++)
723 {
726
728
729 if ((buf_state & BM_TAG_VALID) &&
730 BufTagMatchesRelFileLocator(&bufHdr->tag, &rlocator))
731 {
733 }
734 }
735}

References BM_TAG_VALID, BufTagMatchesRelFileLocator(), fb(), GetLocalBufferDescriptor(), i, InvalidateLocalBuffer(), NLocBuffer, and pg_atomic_read_u64().

Referenced by DropRelationsAllBuffers().

◆ DropRelationLocalBuffers()

void DropRelationLocalBuffers ( RelFileLocator  rlocator,
ForkNumber forkNum,
int  nforks,
BlockNumber firstDelBlock 
)

Definition at line 681 of file localbuf.c.

683{
684 int i;
685 int j;
686
687 for (i = 0; i < NLocBuffer; i++)
688 {
691
693
694 if (!(buf_state & BM_TAG_VALID) ||
695 !BufTagMatchesRelFileLocator(&bufHdr->tag, &rlocator))
696 continue;
697
698 for (j = 0; j < nforks; j++)
699 {
700 if (BufTagGetForkNum(&bufHdr->tag) == forkNum[j] &&
701 bufHdr->tag.blockNum >= firstDelBlock[j])
702 {
704 break;
705 }
706 }
707 }
708}

References BM_TAG_VALID, BufTagGetForkNum(), BufTagMatchesRelFileLocator(), fb(), GetLocalBufferDescriptor(), i, InvalidateLocalBuffer(), j, NLocBuffer, and pg_atomic_read_u64().

Referenced by DropRelationBuffers().

◆ ExtendBufferedRelLocal()

BlockNumber ExtendBufferedRelLocal ( BufferManagerRelation  bmr,
ForkNumber  fork,
uint32  flags,
uint32  extend_by,
BlockNumber  extend_upto,
Buffer buffers,
uint32 extended_by 
)

Definition at line 347 of file localbuf.c.

354{
357
358 /* Initialize local buffers if first request in this session */
359 if (LocalBufHash == NULL)
361
363
364 for (uint32 i = 0; i < extend_by; i++)
365 {
368
369 buffers[i] = GetLocalVictimBuffer();
370 buf_hdr = GetLocalBufferDescriptor(-buffers[i] - 1);
372
373 /* new buffers are zero-filled */
375 }
376
378
380 {
381 /*
382 * In contrast to shared relations, nothing could change the relation
383 * size concurrently. Thus we shouldn't end up finding that we don't
384 * need to do anything.
385 */
387
389 }
390
391 /* Fail if relation is already at maximum possible length */
395 errmsg("cannot extend relation %s beyond %u blocks",
396 relpath(BMR_GET_SMGR(bmr)->smgr_rlocator, fork).str,
398
399 for (uint32 i = 0; i < extend_by; i++)
400 {
401 int victim_buf_id;
403 BufferTag tag;
405 bool found;
406
407 victim_buf_id = -buffers[i] - 1;
409
410 /* in case we need to pin an existing buffer below */
412
413 InitBufferTag(&tag, &BMR_GET_SMGR(bmr)->smgr_rlocator.locator, fork,
414 first_block + i);
415
417 hash_search(LocalBufHash, &tag, HASH_ENTER, &found);
418 if (found)
419 {
422
424
428
429 /*
430 * Clear the BM_VALID bit, do StartLocalBufferIO() and proceed.
431 */
437
438 /* no need to loop for local buffers */
440 }
441 else
442 {
444
446
447 victim_buf_hdr->tag = tag;
448
450
452
454
456 }
457 }
458
460
461 /* actually extend relation */
463
466
467 for (uint32 i = 0; i < extend_by; i++)
468 {
469 Buffer buf = buffers[i];
472
474
478 }
479
481
483
484 return first_block;
485}

References Assert, BM_DIRTY, BM_TAG_VALID, BM_VALID, BMR_GET_SMGR, buf, BUF_USAGECOUNT_ONE, BufferDescriptorGetBuffer(), CurrentResourceOwner, ereport, errcode(), errmsg, ERROR, fb(), GetLocalBufferDescriptor(), GetLocalVictimBuffer(), HASH_ENTER, hash_search(), i, InitBufferTag(), InitLocalBuffers(), InvalidBlockNumber, IOCONTEXT_NORMAL, IOOBJECT_TEMP_RELATION, IOOP_EXTEND, LimitAdditionalLocalPins(), BufferUsage::local_blks_written, LocalBufHash, LocalBufHdrGetBlock, MaxBlockNumber, MemSet, pg_atomic_read_u64(), pg_atomic_unlocked_write_u64(), pgBufferUsage, pgstat_count_io_op_time(), pgstat_prepare_io_time(), PinLocalBuffer(), relpath, ResourceOwnerEnlarge(), smgrnblocks(), smgrzeroextend(), StartLocalBufferIO(), str, track_io_timing, and UnpinLocalBuffer().

Referenced by ExtendBufferedRelCommon().

◆ FlushLocalBuffer()

void FlushLocalBuffer ( BufferDesc bufHdr,
SMgrRelation  reln 
)

Definition at line 183 of file localbuf.c.

184{
187
189
190 /*
191 * Try to start an I/O operation. There currently are no reasons for
192 * StartLocalBufferIO to return anything other than
193 * BUFFER_IO_READY_FOR_IO, so we raise an error in that case.
194 */
196 elog(ERROR, "failed to start write IO on local buffer");
197
198 /* Find smgr relation for buffer */
199 if (reln == NULL)
202
203 PageSetChecksum(localpage, bufHdr->tag.blockNum);
204
206
207 /* And write... */
210 bufHdr->tag.blockNum,
211 localpage,
212 false);
213
214 /* Temporary table I/O does not use Buffer Access Strategies */
217
218 /* Mark not-dirty */
219 TerminateLocalBufferIO(bufHdr, true, 0, false);
220
222}

References Assert, BUFFER_IO_READY_FOR_IO, BufferDescriptorGetBuffer(), BufTagGetForkNum(), BufTagGetRelFileLocator(), elog, ERROR, fb(), IOCONTEXT_NORMAL, IOOBJECT_TEMP_RELATION, IOOP_WRITE, BufferUsage::local_blks_written, LocalBufHdrGetBlock, LocalRefCount, MyProcNumber, PageSetChecksum(), pgBufferUsage, pgstat_count_io_op_time(), pgstat_prepare_io_time(), smgropen(), smgrwrite(), StartLocalBufferIO(), TerminateLocalBufferIO(), and track_io_timing.

Referenced by FlushRelationBuffers(), GetLocalVictimBuffer(), and invalidate_one_block().

◆ GetAdditionalLocalPinLimit()

uint32 GetAdditionalLocalPinLimit ( void  )

◆ GetLocalBufferStorage()

static Block GetLocalBufferStorage ( void  )
static

Definition at line 917 of file localbuf.c.

918{
919 static char *cur_block = NULL;
920 static int next_buf_in_block = 0;
921 static int num_bufs_in_block = 0;
922 static int total_bufs_allocated = 0;
924
925 char *this_buf;
926
928
930 {
931 /* Need to make a new request to memmgr */
932 int num_bufs;
933
934 /*
935 * We allocate local buffers in a context of their own, so that the
936 * space eaten for them is easily recognizable in MemoryContextStats
937 * output. Create the context on first use.
938 */
942 "LocalBufferContext",
944
945 /* Start with a 16-buffer request; subsequent ones double each time */
946 num_bufs = Max(num_bufs_in_block * 2, 16);
947 /* But not more than what we need for all remaining local bufs */
949 /* And don't overflow MaxAllocSize, either */
951
952 /* Buffers should be I/O aligned. */
956 0);
957
960 }
961
962 /* Allocate next buffer in current memory block */
966
967 /*
968 * Caller's PinLocalBuffer() was too early for Valgrind updates, so do it
969 * here. The block is actually undefined, but we want consistency with
970 * the regular case of not needing to allocate memory. This is
971 * specifically needed when method_io_uring.c fills the block, because
972 * Valgrind doesn't recognize io_uring reads causing undefined memory to
973 * become defined.
974 */
976
977 return (Block) this_buf;
978}

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, Assert, fb(), Max, MaxAllocSize, MemoryContextAllocAligned(), Min, NLocBuffer, PG_IO_ALIGN_SIZE, TopMemoryContext, and VALGRIND_MAKE_MEM_DEFINED.

Referenced by GetLocalVictimBuffer().

◆ GetLocalPinLimit()

uint32 GetLocalPinLimit ( void  )

Definition at line 308 of file localbuf.c.

309{
310 /* Every backend has its own temporary buffers, and can pin them all. */
311 return num_temp_buffers;
312}

References num_temp_buffers.

Referenced by read_stream_begin_impl().

◆ GetLocalVictimBuffer()

static Buffer GetLocalVictimBuffer ( void  )
static

Definition at line 225 of file localbuf.c.

226{
227 int victim_bufid;
228 int trycounter;
230
232
233 /*
234 * Need to get a new buffer. We use a clock-sweep algorithm (essentially
235 * the same as what freelist.c does now...)
236 */
238 for (;;)
239 {
241
244
246
247 if (LocalRefCount[victim_bufid] == 0)
248 {
250
252 {
256 }
257 else if (BUF_STATE_GET_REFCOUNT(buf_state) > 0)
258 {
259 /*
260 * This can be reached if the backend initiated AIO for this
261 * buffer and then errored out.
262 */
263 }
264 else
265 {
266 /* Found a usable buffer */
267 PinLocalBuffer(bufHdr, false);
268 break;
269 }
270 }
271 else if (--trycounter == 0)
274 errmsg("no empty local buffer available")));
275 }
276
277 /*
278 * lazy memory allocation: allocate space on first use of a buffer.
279 */
281 {
282 /* Set pointer for use by BufferGetBlock() macro */
284 }
285
286 /*
287 * this buffer is not referenced but it might still be dirty. if that's
288 * the case, write it out before reusing it!
289 */
290 if (pg_atomic_read_u64(&bufHdr->state) & BM_DIRTY)
292
293 /*
294 * Remove the victim buffer from the hashtable and mark as invalid.
295 */
297 {
299
301 }
302
304}

References BM_DIRTY, BM_TAG_VALID, BUF_STATE_GET_REFCOUNT, BUF_STATE_GET_USAGECOUNT, BUF_USAGECOUNT_ONE, BufferDescriptorGetBuffer(), CurrentResourceOwner, ereport, errcode(), errmsg, ERROR, fb(), FlushLocalBuffer(), GetLocalBufferDescriptor(), GetLocalBufferStorage(), InvalidateLocalBuffer(), IOCONTEXT_NORMAL, IOOBJECT_TEMP_RELATION, IOOP_EVICT, LocalBufHdrGetBlock, LocalRefCount, nextFreeLocalBufId, NLocBuffer, pg_atomic_read_u64(), pg_atomic_unlocked_write_u64(), pgstat_count_io_op(), PinLocalBuffer(), and ResourceOwnerEnlarge().

Referenced by ExtendBufferedRelLocal(), and LocalBufferAlloc().

◆ InitLocalBuffers()

static void InitLocalBuffers ( void  )
static

Definition at line 744 of file localbuf.c.

745{
747 HASHCTL info;
748 int i;
749
750 /*
751 * Parallel workers can't access data in temporary tables, because they
752 * have no visibility into the local buffers of their leader. This is a
753 * convenient, low-cost place to provide a backstop check for that. Note
754 * that we don't wish to prevent a parallel worker from accessing catalog
755 * metadata about a temp table, so checks at higher levels would be
756 * inappropriate.
757 */
758 if (IsParallelWorker())
761 errmsg("cannot access temporary tables during a parallel operation")));
762
763 /* Allocate and zero buffer headers and auxiliary arrays */
766 LocalRefCount = (int32 *) calloc(nbufs, sizeof(int32));
770 errmsg("out of memory")));
771
773
774 /* initialize fields that need to start off nonzero */
775 for (i = 0; i < nbufs; i++)
776 {
778
779 /*
780 * negative to indicate local buffer. This is tricky: shared buffers
781 * start with 0. We have to start with -2. (Note that the routine
782 * BufferDescriptorGetBuffer adds 1 to buf_id so our first buffer id
783 * is -1.)
784 */
785 buf->buf_id = -i - 2;
786
787 pgaio_wref_clear(&buf->io_wref);
788
789 /*
790 * Intentionally do not initialize the buffer's atomic variable
791 * (besides zeroing the underlying memory above). That way we get
792 * errors on platforms without atomics, if somebody (re-)introduces
793 * atomic operations for local buffers.
794 */
795 }
796
797 /* Create the lookup hash table */
798 info.keysize = sizeof(BufferTag);
799 info.entrysize = sizeof(LocalBufferLookupEnt);
800
801 LocalBufHash = hash_create("Local Buffer Lookup Table",
802 nbufs,
803 &info,
805
806 if (!LocalBufHash)
807 elog(ERROR, "could not initialize local buffer hash table");
808
809 /* Initialization done, mark buffers allocated */
811}

References buf, calloc, elog, HASHCTL::entrysize, ereport, errcode(), errmsg, ERROR, FATAL, fb(), GetLocalBufferDescriptor(), HASH_BLOBS, hash_create(), HASH_ELEM, i, IsParallelWorker, HASHCTL::keysize, LocalBufferBlockPointers, LocalBufferDescriptors, LocalBufHash, LocalRefCount, nextFreeLocalBufId, NLocBuffer, num_temp_buffers, and pgaio_wref_clear().

Referenced by ExtendBufferedRelLocal(), LocalBufferAlloc(), and PrefetchLocalBuffer().

◆ InvalidateLocalBuffer()

void InvalidateLocalBuffer ( BufferDesc bufHdr,
bool  check_unreferenced 
)

Definition at line 621 of file localbuf.c.

622{
624 int bufid = -buffer - 1;
627
628 /*
629 * It's possible that we started IO on this buffer before e.g. aborting
630 * the transaction that created a table. We need to wait for that IO to
631 * complete before removing / reusing the buffer.
632 */
633 if (pgaio_wref_valid(&bufHdr->io_wref))
634 {
635 PgAioWaitRef iow = bufHdr->io_wref;
636
638 Assert(!pgaio_wref_valid(&bufHdr->io_wref));
639 }
640
642
643 /*
644 * We need to test not just LocalRefCount[bufid] but also the BufferDesc
645 * itself, as the latter is used to represent a pin by the AIO subsystem.
646 * This can happen if AIO is initiated and then the query errors out.
647 */
648 if (check_unreferenced &&
650 elog(ERROR, "block %u of %s is still referenced (local %d)",
651 bufHdr->tag.blockNum,
654 BufTagGetForkNum(&bufHdr->tag)).str,
656
657 /* Remove entry from hashtable */
660 if (!hresult) /* shouldn't happen */
661 elog(ERROR, "local buffer hash table corrupted");
662 /* Mark buffer invalid */
663 ClearBufferTag(&bufHdr->tag);
667}

References Assert, BUF_STATE_GET_REFCOUNT, BufferDescriptorGetBuffer(), BufTagGetForkNum(), BufTagGetRelFileLocator(), ClearBufferTag(), elog, ERROR, fb(), HASH_REMOVE, hash_search(), LocalBufHash, LocalRefCount, MyProcNumber, pg_atomic_read_u64(), pg_atomic_unlocked_write_u64(), pgaio_wref_valid(), pgaio_wref_wait(), and relpathbackend.

Referenced by DropRelationAllLocalBuffers(), DropRelationLocalBuffers(), GetLocalVictimBuffer(), invalidate_one_block(), and modify_rel_block().

◆ LimitAdditionalLocalPins()

void LimitAdditionalLocalPins ( uint32 additional_pins)

Definition at line 324 of file localbuf.c.

325{
327
328 if (*additional_pins <= 1)
329 return;
330
331 /*
332 * In contrast to LimitAdditionalPins() other backends don't play a role
333 * here. We can allow up to NLocBuffer pins in total, but it might not be
334 * initialized yet so read num_temp_buffers.
335 */
337
340}

References fb(), NLocalPinnedBuffers, and num_temp_buffers.

Referenced by ExtendBufferedRelLocal().

◆ LocalBufferAlloc()

BufferDesc * LocalBufferAlloc ( SMgrRelation  smgr,
ForkNumber  forkNum,
BlockNumber  blockNum,
bool foundPtr 
)

Definition at line 119 of file localbuf.c.

121{
122 BufferTag newTag; /* identity of requested block */
126 int bufid;
127 bool found;
128
129 InitBufferTag(&newTag, &smgr->smgr_rlocator.locator, forkNum, blockNum);
130
131 /* Initialize local buffers if first request in this session */
132 if (LocalBufHash == NULL)
134
136
137 /* See if the desired buffer already exists */
140
141 if (hresult)
142 {
143 bufid = hresult->id;
146
148 }
149 else
150 {
152
154 bufid = -victim_buffer - 1;
156
159 if (found) /* shouldn't happen */
160 elog(ERROR, "local buffer hash table corrupted");
161 hresult->id = bufid;
162
163 /*
164 * it's all ours now.
165 */
166 bufHdr->tag = newTag;
167
172
173 *foundPtr = false;
174 }
175
176 return bufHdr;
177}

References Assert, BM_TAG_VALID, BUF_FLAG_MASK, BUF_USAGECOUNT_MASK, BUF_USAGECOUNT_ONE, BufferTagsEqual(), CurrentResourceOwner, elog, ERROR, fb(), GetLocalBufferDescriptor(), GetLocalVictimBuffer(), HASH_ENTER, HASH_FIND, hash_search(), InitBufferTag(), InitLocalBuffers(), LocalBufHash, RelFileLocatorBackend::locator, pg_atomic_read_u64(), pg_atomic_unlocked_write_u64(), PinLocalBuffer(), ResourceOwnerEnlarge(), and SMgrRelationData::smgr_rlocator.

Referenced by PinBufferForBlock().

◆ MarkLocalBufferDirty()

void MarkLocalBufferDirty ( Buffer  buffer)

Definition at line 492 of file localbuf.c.

493{
494 int bufid;
497
498 Assert(BufferIsLocal(buffer));
499
500#ifdef LBDEBUG
501 fprintf(stderr, "LB DIRTY %d\n", buffer);
502#endif
503
504 bufid = -buffer - 1;
505
507
509
511
512 if (!(buf_state & BM_DIRTY))
514
516
518}

References Assert, BM_DIRTY, BufferIsLocal, fb(), fprintf, GetLocalBufferDescriptor(), BufferUsage::local_blks_dirtied, LocalRefCount, pg_atomic_read_u64(), pg_atomic_unlocked_write_u64(), and pgBufferUsage.

Referenced by BufferSetHintBits16(), MarkBufferDirty(), and MarkBufferDirtyHint().

◆ PinLocalBuffer()

bool PinLocalBuffer ( BufferDesc buf_hdr,
bool  adjust_usagecount 
)

◆ PrefetchLocalBuffer()

PrefetchBufferResult PrefetchLocalBuffer ( SMgrRelation  smgr,
ForkNumber  forkNum,
BlockNumber  blockNum 
)

Definition at line 72 of file localbuf.c.

74{
76 BufferTag newTag; /* identity of requested block */
78
79 InitBufferTag(&newTag, &smgr->smgr_rlocator.locator, forkNum, blockNum);
80
81 /* Initialize local buffers if first request in this session */
82 if (LocalBufHash == NULL)
84
85 /* See if the desired buffer already exists */
88
89 if (hresult)
90 {
91 /* Yes, so nothing to do */
92 result.recent_buffer = -hresult->id - 1;
93 }
94 else
95 {
96#ifdef USE_PREFETCH
97 /* Not in buffers, so initiate prefetch */
98 if ((io_direct_flags & IO_DIRECT_DATA) == 0 &&
99 smgrprefetch(smgr, forkNum, blockNum, 1))
100 {
101 result.initiated_io = true;
102 }
103#endif /* USE_PREFETCH */
104 }
105
106 return result;
107}

References fb(), HASH_FIND, hash_search(), InitBufferTag(), InitLocalBuffers(), InvalidBuffer, IO_DIRECT_DATA, io_direct_flags, LocalBufHash, RelFileLocatorBackend::locator, result, SMgrRelationData::smgr_rlocator, and smgrprefetch().

Referenced by PrefetchBuffer().

◆ StartLocalBufferIO()

StartBufferIOResult StartLocalBufferIO ( BufferDesc bufHdr,
bool  forInput,
bool  wait,
PgAioWaitRef io_wref 
)

Definition at line 524 of file localbuf.c.

525{
527
528 /*
529 * With AIO the buffer could have IO in progress, e.g. when there are two
530 * scans of the same relation. Either wait for the other IO (if wait =
531 * true and io_wref == NULL) or return BUFFER_IO_IN_PROGRESS;
532 */
533 if (pgaio_wref_valid(&bufHdr->io_wref))
534 {
535 PgAioWaitRef buf_wref = bufHdr->io_wref;
536
537 if (io_wref != NULL)
538 {
539 /* We've already asynchronously started this IO, so join it */
540 *io_wref = buf_wref;
542 }
543
544 /*
545 * For temp buffers we should never need to wait in
546 * StartLocalBufferIO() when called with io_wref == NULL while there
547 * are staged IOs, as it's not allowed to call code that is not aware
548 * of AIO while in batch mode.
549 */
551
552 if (!wait)
554
556 }
557
558 /* Once we get here, there is definitely no I/O active on this buffer */
559
560 /* Check if someone else already did the I/O */
563 {
565 }
566
567 /* BM_IO_IN_PROGRESS isn't currently used for local buffers */
568
569 /* local buffers don't track IO using resowners */
570
572}

References Assert, BM_DIRTY, BM_VALID, BUFFER_IO_ALREADY_DONE, BUFFER_IO_IN_PROGRESS, BUFFER_IO_READY_FOR_IO, fb(), pg_atomic_read_u64(), pgaio_have_staged(), pgaio_wref_valid(), and pgaio_wref_wait().

Referenced by buffer_call_start_io(), ExtendBufferedRelLocal(), FlushLocalBuffer(), read_rel_block_ll(), StartBufferIO(), and ZeroAndLockBuffer().

◆ TerminateLocalBufferIO()

void TerminateLocalBufferIO ( BufferDesc bufHdr,
bool  clear_dirty,
uint64  set_flag_bits,
bool  release_aio 
)

Definition at line 578 of file localbuf.c.

580{
581 /* Only need to adjust flags */
583
584 /* BM_IO_IN_PROGRESS isn't currently used for local buffers */
585
586 /* Clear earlier errors, if this IO failed, it'll be marked again */
588
589 if (clear_dirty)
591
592 if (release_aio)
593 {
594 /* release pin held by IO subsystem, see also buffer_stage_common() */
597 pgaio_wref_clear(&bufHdr->io_wref);
598 }
599
602
603 /* local buffers don't track IO using resowners */
604
605 /* local buffers don't use the IO CV, as no other process can see buffer */
606
607 /* local buffers don't use BM_PIN_COUNT_WAITER, so no need to wake */
608}

References Assert, BUF_REFCOUNT_ONE, BUF_STATE_GET_REFCOUNT, fb(), pg_atomic_read_u64(), pg_atomic_unlocked_write_u64(), and pgaio_wref_clear().

Referenced by buffer_call_terminate_io(), buffer_readv_complete_one(), FlushLocalBuffer(), and ZeroAndLockBuffer().

◆ UnpinLocalBuffer()

◆ UnpinLocalBufferNoOwner()

Variable Documentation

◆ LocalBufferBlockPointers

Block* LocalBufferBlockPointers = NULL

Definition at line 48 of file localbuf.c.

Referenced by BufferGetBlock(), and InitLocalBuffers().

◆ LocalBufferDescriptors

BufferDesc* LocalBufferDescriptors = NULL

Definition at line 47 of file localbuf.c.

Referenced by GetLocalBufferDescriptor(), and InitLocalBuffers().

◆ LocalBufHash

HTAB* LocalBufHash = NULL
static

◆ LocalRefCount

◆ nextFreeLocalBufId

int nextFreeLocalBufId = 0
static

Definition at line 51 of file localbuf.c.

Referenced by GetLocalVictimBuffer(), and InitLocalBuffers().

◆ NLocalPinnedBuffers

int NLocalPinnedBuffers = 0
static

◆ NLocBuffer