PostgreSQL Source Code  git master
xlogutils.h File Reference
#include "access/xlogreader.h"
#include "storage/bufmgr.h"
Include dependency graph for xlogutils.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ReadLocalXLogPageNoWaitPrivate
 

Macros

#define InHotStandby   (standbyState >= STANDBY_SNAPSHOT_PENDING)
 

Typedefs

typedef struct ReadLocalXLogPageNoWaitPrivate ReadLocalXLogPageNoWaitPrivate
 

Enumerations

enum  HotStandbyState { STANDBY_DISABLED , STANDBY_INITIALIZED , STANDBY_SNAPSHOT_PENDING , STANDBY_SNAPSHOT_READY }
 
enum  XLogRedoAction { BLK_NEEDS_REDO , BLK_DONE , BLK_RESTORED , BLK_NOTFOUND }
 

Functions

bool XLogHaveInvalidPages (void)
 
void XLogCheckInvalidPages (void)
 
void XLogDropRelation (RelFileLocator rlocator, ForkNumber forknum)
 
void XLogDropDatabase (Oid dbid)
 
void XLogTruncateRelation (RelFileLocator rlocator, ForkNumber forkNum, BlockNumber nblocks)
 
XLogRedoAction XLogReadBufferForRedo (XLogReaderState *record, uint8 block_id, Buffer *buf)
 
Buffer XLogInitBufferForRedo (XLogReaderState *record, uint8 block_id)
 
XLogRedoAction XLogReadBufferForRedoExtended (XLogReaderState *record, uint8 block_id, ReadBufferMode mode, bool get_cleanup_lock, Buffer *buf)
 
Buffer XLogReadBufferExtended (RelFileLocator rlocator, ForkNumber forknum, BlockNumber blkno, ReadBufferMode mode, Buffer recent_buffer)
 
Relation CreateFakeRelcacheEntry (RelFileLocator rlocator)
 
void FreeFakeRelcacheEntry (Relation fakerel)
 
int read_local_xlog_page (XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page)
 
int read_local_xlog_page_no_wait (XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page)
 
void wal_segment_open (XLogReaderState *state, XLogSegNo nextSegNo, TimeLineID *tli_p)
 
void wal_segment_close (XLogReaderState *state)
 
void XLogReadDetermineTimeline (XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength, TimeLineID currTLI)
 
void WALReadRaiseError (WALReadError *errinfo)
 

Variables

PGDLLIMPORT bool InRecovery
 
PGDLLIMPORT HotStandbyState standbyState
 

Macro Definition Documentation

◆ InHotStandby

#define InHotStandby   (standbyState >= STANDBY_SNAPSHOT_PENDING)

Definition at line 57 of file xlogutils.h.

Typedef Documentation

◆ ReadLocalXLogPageNoWaitPrivate

Enumeration Type Documentation

◆ HotStandbyState

Enumerator
STANDBY_DISABLED 
STANDBY_INITIALIZED 
STANDBY_SNAPSHOT_PENDING 
STANDBY_SNAPSHOT_READY 

Definition at line 47 of file xlogutils.h.

48 {
HotStandbyState
Definition: xlogutils.h:48
@ STANDBY_DISABLED
Definition: xlogutils.h:49
@ STANDBY_SNAPSHOT_READY
Definition: xlogutils.h:52
@ STANDBY_SNAPSHOT_PENDING
Definition: xlogutils.h:51
@ STANDBY_INITIALIZED
Definition: xlogutils.h:50

◆ XLogRedoAction

Enumerator
BLK_NEEDS_REDO 
BLK_DONE 
BLK_RESTORED 
BLK_NOTFOUND 

Definition at line 69 of file xlogutils.h.

70 {
71  BLK_NEEDS_REDO, /* changes from WAL record need to be applied */
72  BLK_DONE, /* block is already up-to-date */
73  BLK_RESTORED, /* block was restored from a full-page image */
74  BLK_NOTFOUND, /* block was not found (and hence does not
75  * need to be replayed) */
XLogRedoAction
Definition: xlogutils.h:70
@ BLK_RESTORED
Definition: xlogutils.h:73
@ BLK_NEEDS_REDO
Definition: xlogutils.h:71
@ BLK_DONE
Definition: xlogutils.h:72
@ BLK_NOTFOUND
Definition: xlogutils.h:74

Function Documentation

◆ CreateFakeRelcacheEntry()

Relation CreateFakeRelcacheEntry ( RelFileLocator  rlocator)

Definition at line 582 of file xlogutils.c.

583 {
584  FakeRelCacheEntry fakeentry;
585  Relation rel;
586 
587  /* Allocate the Relation struct and all related space in one block. */
588  fakeentry = palloc0(sizeof(FakeRelCacheEntryData));
589  rel = (Relation) fakeentry;
590 
591  rel->rd_rel = &fakeentry->pgc;
592  rel->rd_locator = rlocator;
593 
594  /*
595  * We will never be working with temp rels during recovery or while
596  * syncing WAL-skipped files.
597  */
599 
600  /* It must be a permanent table here */
601  rel->rd_rel->relpersistence = RELPERSISTENCE_PERMANENT;
602 
603  /* We don't know the name of the relation; use relfilenumber instead */
604  sprintf(RelationGetRelationName(rel), "%u", rlocator.relNumber);
605 
606  /*
607  * We set up the lockRelId in case anything tries to lock the dummy
608  * relation. Note that this is fairly bogus since relNumber may be
609  * different from the relation's OID. It shouldn't really matter though.
610  * In recovery, we are running by ourselves and can't have any lock
611  * conflicts. While syncing, we already hold AccessExclusiveLock.
612  */
613  rel->rd_lockInfo.lockRelId.dbId = rlocator.dbOid;
614  rel->rd_lockInfo.lockRelId.relId = rlocator.relNumber;
615 
616  /*
617  * Set up a non-pinned SMgrRelation reference, so that we don't need to
618  * worry about unpinning it on error.
619  */
620  rel->rd_smgr = smgropen(rlocator, INVALID_PROC_NUMBER);
621 
622  return rel;
623 }
void * palloc0(Size size)
Definition: mcxt.c:1347
#define sprintf
Definition: port.h:240
#define INVALID_PROC_NUMBER
Definition: procnumber.h:26
#define RelationGetRelationName(relation)
Definition: rel.h:539
struct RelationData * Relation
Definition: relcache.h:27
SMgrRelation smgropen(RelFileLocator rlocator, ProcNumber backend)
Definition: smgr.c:198
FormData_pg_class pgc
Definition: xlogutils.c:562
LockRelId lockRelId
Definition: rel.h:46
Oid relId
Definition: rel.h:40
Oid dbId
Definition: rel.h:41
RelFileNumber relNumber
ProcNumber rd_backend
Definition: rel.h:60
LockInfoData rd_lockInfo
Definition: rel.h:114
SMgrRelation rd_smgr
Definition: rel.h:58
RelFileLocator rd_locator
Definition: rel.h:57
Form_pg_class rd_rel
Definition: rel.h:111

References LockRelId::dbId, RelFileLocator::dbOid, INVALID_PROC_NUMBER, LockInfoData::lockRelId, palloc0(), FakeRelCacheEntryData::pgc, RelationData::rd_backend, RelationData::rd_locator, RelationData::rd_lockInfo, RelationData::rd_rel, RelationData::rd_smgr, RelationGetRelationName, LockRelId::relId, RelFileLocator::relNumber, smgropen(), and sprintf.

Referenced by heap_xlog_delete(), heap_xlog_insert(), heap_xlog_lock(), heap_xlog_lock_updated(), heap_xlog_multi_insert(), heap_xlog_update(), heap_xlog_visible(), smgr_redo(), and smgrDoPendingSyncs().

◆ FreeFakeRelcacheEntry()

void FreeFakeRelcacheEntry ( Relation  fakerel)

Definition at line 629 of file xlogutils.c.

630 {
631  pfree(fakerel);
632 }
void pfree(void *pointer)
Definition: mcxt.c:1521

References pfree().

Referenced by heap_xlog_delete(), heap_xlog_insert(), heap_xlog_lock(), heap_xlog_lock_updated(), heap_xlog_multi_insert(), heap_xlog_update(), heap_xlog_visible(), smgr_redo(), and smgrDoPendingSyncs().

◆ read_local_xlog_page()

int read_local_xlog_page ( XLogReaderState state,
XLogRecPtr  targetPagePtr,
int  reqLen,
XLogRecPtr  targetRecPtr,
char *  cur_page 
)

Definition at line 861 of file xlogutils.c.

863 {
864  return read_local_xlog_page_guts(state, targetPagePtr, reqLen,
865  targetRecPtr, cur_page, true);
866 }
Definition: regguts.h:323
static int read_local_xlog_page_guts(XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, bool wait_for_wal)
Definition: xlogutils.c:885

References read_local_xlog_page_guts().

Referenced by create_logical_replication_slot(), LogicalReplicationSlotHasPendingWal(), LogicalSlotAdvanceAndCheckSnapState(), pg_logical_slot_get_changes_guts(), and XlogReadTwoPhaseData().

◆ read_local_xlog_page_no_wait()

int read_local_xlog_page_no_wait ( XLogReaderState state,
XLogRecPtr  targetPagePtr,
int  reqLen,
XLogRecPtr  targetRecPtr,
char *  cur_page 
)

Definition at line 873 of file xlogutils.c.

876 {
877  return read_local_xlog_page_guts(state, targetPagePtr, reqLen,
878  targetRecPtr, cur_page, false);
879 }

References read_local_xlog_page_guts().

Referenced by InitXLogReaderState().

◆ wal_segment_close()

◆ wal_segment_open()

void wal_segment_open ( XLogReaderState state,
XLogSegNo  nextSegNo,
TimeLineID tli_p 
)

Definition at line 817 of file xlogutils.c.

819 {
820  TimeLineID tli = *tli_p;
821  char path[MAXPGPATH];
822 
823  XLogFilePath(path, tli, nextSegNo, state->segcxt.ws_segsize);
824  state->seg.ws_file = BasicOpenFile(path, O_RDONLY | PG_BINARY);
825  if (state->seg.ws_file >= 0)
826  return;
827 
828  if (errno == ENOENT)
829  ereport(ERROR,
831  errmsg("requested WAL segment %s has already been removed",
832  path)));
833  else
834  ereport(ERROR,
836  errmsg("could not open file \"%s\": %m",
837  path)));
838 }
#define PG_BINARY
Definition: c.h:1273
int errcode_for_file_access(void)
Definition: elog.c:878
int errmsg(const char *fmt,...)
Definition: elog.c:1068
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:149
int BasicOpenFile(const char *fileName, int fileFlags)
Definition: fd.c:1087
#define MAXPGPATH
static void XLogFilePath(char *path, TimeLineID tli, XLogSegNo logSegNo, int wal_segsz_bytes)
uint32 TimeLineID
Definition: xlogdefs.h:59

References BasicOpenFile(), ereport, errcode_for_file_access(), errmsg(), ERROR, MAXPGPATH, PG_BINARY, and XLogFilePath().

Referenced by create_logical_replication_slot(), InitXLogReaderState(), LogicalReplicationSlotHasPendingWal(), LogicalSlotAdvanceAndCheckSnapState(), pg_logical_slot_get_changes_guts(), SummarizeWAL(), and XlogReadTwoPhaseData().

◆ WALReadRaiseError()

void WALReadRaiseError ( WALReadError errinfo)

Definition at line 1020 of file xlogutils.c.

1021 {
1022  WALOpenSegment *seg = &errinfo->wre_seg;
1023  char fname[MAXFNAMELEN];
1024 
1025  XLogFileName(fname, seg->ws_tli, seg->ws_segno, wal_segment_size);
1026 
1027  if (errinfo->wre_read < 0)
1028  {
1029  errno = errinfo->wre_errno;
1030  ereport(ERROR,
1032  errmsg("could not read from WAL segment %s, offset %d: %m",
1033  fname, errinfo->wre_off)));
1034  }
1035  else if (errinfo->wre_read == 0)
1036  {
1037  ereport(ERROR,
1039  errmsg("could not read from WAL segment %s, offset %d: read %d of %d",
1040  fname, errinfo->wre_off, errinfo->wre_read,
1041  errinfo->wre_req)));
1042  }
1043 }
int errcode(int sqlerrcode)
Definition: elog.c:855
#define ERRCODE_DATA_CORRUPTED
Definition: pg_basebackup.c:41
XLogSegNo ws_segno
Definition: xlogreader.h:48
TimeLineID ws_tli
Definition: xlogreader.h:49
WALOpenSegment wre_seg
Definition: xlogreader.h:388
int wal_segment_size
Definition: xlog.c:143
#define MAXFNAMELEN
static void XLogFileName(char *fname, TimeLineID tli, XLogSegNo logSegNo, int wal_segsz_bytes)

References ereport, errcode(), ERRCODE_DATA_CORRUPTED, errcode_for_file_access(), errmsg(), ERROR, MAXFNAMELEN, wal_segment_size, WALReadError::wre_errno, WALReadError::wre_off, WALReadError::wre_read, WALReadError::wre_req, WALReadError::wre_seg, WALOpenSegment::ws_segno, WALOpenSegment::ws_tli, and XLogFileName().

Referenced by logical_read_xlog_page(), read_local_xlog_page_guts(), summarizer_read_local_xlog_page(), and XLogSendPhysical().

◆ XLogCheckInvalidPages()

void XLogCheckInvalidPages ( void  )

Definition at line 245 of file xlogutils.c.

246 {
247  HASH_SEQ_STATUS status;
248  xl_invalid_page *hentry;
249  bool foundone = false;
250 
251  if (invalid_page_tab == NULL)
252  return; /* nothing to do */
253 
255 
256  /*
257  * Our strategy is to emit WARNING messages for all remaining entries and
258  * only PANIC after we've dumped all the available info.
259  */
260  while ((hentry = (xl_invalid_page *) hash_seq_search(&status)) != NULL)
261  {
262  report_invalid_page(WARNING, hentry->key.locator, hentry->key.forkno,
263  hentry->key.blkno, hentry->present);
264  foundone = true;
265  }
266 
267  if (foundone)
269  "WAL contains references to invalid pages");
270 
272  invalid_page_tab = NULL;
273 }
void hash_destroy(HTAB *hashp)
Definition: dynahash.c:865
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition: dynahash.c:1395
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition: dynahash.c:1385
#define WARNING
Definition: elog.h:36
#define PANIC
Definition: elog.h:42
#define elog(elevel,...)
Definition: elog.h:224
BlockNumber blkno
Definition: xlogutils.c:69
RelFileLocator locator
Definition: xlogutils.c:67
ForkNumber forkno
Definition: xlogutils.c:68
xl_invalid_page_key key
Definition: xlogutils.c:74
bool ignore_invalid_pages
Definition: xlogutils.c:34
static void report_invalid_page(int elevel, RelFileLocator locator, ForkNumber forkno, BlockNumber blkno, bool present)
Definition: xlogutils.c:86
static HTAB * invalid_page_tab
Definition: xlogutils.c:78

References xl_invalid_page_key::blkno, elog, xl_invalid_page_key::forkno, hash_destroy(), hash_seq_init(), hash_seq_search(), ignore_invalid_pages, invalid_page_tab, xl_invalid_page::key, xl_invalid_page_key::locator, PANIC, xl_invalid_page::present, report_invalid_page(), and WARNING.

Referenced by CheckRecoveryConsistency().

◆ XLogDropDatabase()

void XLogDropDatabase ( Oid  dbid)

Definition at line 652 of file xlogutils.c.

653 {
654  /*
655  * This is unnecessarily heavy-handed, as it will close SMgrRelation
656  * objects for other databases as well. DROP DATABASE occurs seldom enough
657  * that it's not worth introducing a variant of smgrdestroy for just this
658  * purpose.
659  */
660  smgrdestroyall();
661 
663 }
void smgrdestroyall(void)
Definition: smgr.c:332
static void forget_invalid_pages_db(Oid dbid)
Definition: xlogutils.c:202

References forget_invalid_pages_db(), and smgrdestroyall().

Referenced by dbase_redo().

◆ XLogDropRelation()

void XLogDropRelation ( RelFileLocator  rlocator,
ForkNumber  forknum 
)

Definition at line 641 of file xlogutils.c.

642 {
643  forget_invalid_pages(rlocator, forknum, 0);
644 }
static void forget_invalid_pages(RelFileLocator locator, ForkNumber forkno, BlockNumber minblkno)
Definition: xlogutils.c:166

References forget_invalid_pages().

Referenced by DropRelationFiles().

◆ XLogHaveInvalidPages()

bool XLogHaveInvalidPages ( void  )

Definition at line 235 of file xlogutils.c.

236 {
237  if (invalid_page_tab != NULL &&
239  return true;
240  return false;
241 }
long hash_get_num_entries(HTAB *hashp)
Definition: dynahash.c:1341

References hash_get_num_entries(), and invalid_page_tab.

Referenced by RecoveryRestartPoint().

◆ XLogInitBufferForRedo()

◆ XLogReadBufferExtended()

Buffer XLogReadBufferExtended ( RelFileLocator  rlocator,
ForkNumber  forknum,
BlockNumber  blkno,
ReadBufferMode  mode,
Buffer  recent_buffer 
)

Definition at line 471 of file xlogutils.c.

474 {
475  BlockNumber lastblock;
476  Buffer buffer;
477  SMgrRelation smgr;
478 
479  Assert(blkno != P_NEW);
480 
481  /* Do we have a clue where the buffer might be already? */
482  if (BufferIsValid(recent_buffer) &&
483  mode == RBM_NORMAL &&
484  ReadRecentBuffer(rlocator, forknum, blkno, recent_buffer))
485  {
486  buffer = recent_buffer;
487  goto recent_buffer_fast_path;
488  }
489 
490  /* Open the relation at smgr level */
491  smgr = smgropen(rlocator, INVALID_PROC_NUMBER);
492 
493  /*
494  * Create the target file if it doesn't already exist. This lets us cope
495  * if the replay sequence contains writes to a relation that is later
496  * deleted. (The original coding of this routine would instead suppress
497  * the writes, but that seems like it risks losing valuable data if the
498  * filesystem loses an inode during a crash. Better to write the data
499  * until we are actually told to delete the file.)
500  */
501  smgrcreate(smgr, forknum, true);
502 
503  lastblock = smgrnblocks(smgr, forknum);
504 
505  if (blkno < lastblock)
506  {
507  /* page exists in file */
508  buffer = ReadBufferWithoutRelcache(rlocator, forknum, blkno,
509  mode, NULL, true);
510  }
511  else
512  {
513  /* hm, page doesn't exist in file */
514  if (mode == RBM_NORMAL)
515  {
516  log_invalid_page(rlocator, forknum, blkno, false);
517  return InvalidBuffer;
518  }
519  if (mode == RBM_NORMAL_NO_LOG)
520  return InvalidBuffer;
521  /* OK to extend the file */
522  /* we do this in recovery only - no rel-extension lock needed */
524  buffer = ExtendBufferedRelTo(BMR_SMGR(smgr, RELPERSISTENCE_PERMANENT),
525  forknum,
526  NULL,
529  blkno + 1,
530  mode);
531  }
532 
533 recent_buffer_fast_path:
534  if (mode == RBM_NORMAL)
535  {
536  /* check that page has been initialized */
537  Page page = (Page) BufferGetPage(buffer);
538 
539  /*
540  * We assume that PageIsNew is safe without a lock. During recovery,
541  * there should be no other backends that could modify the buffer at
542  * the same time.
543  */
544  if (PageIsNew(page))
545  {
546  ReleaseBuffer(buffer);
547  log_invalid_page(rlocator, forknum, blkno, true);
548  return InvalidBuffer;
549  }
550  }
551 
552  return buffer;
553 }
uint32 BlockNumber
Definition: block.h:31
#define InvalidBuffer
Definition: buf.h:25
Buffer ExtendBufferedRelTo(BufferManagerRelation bmr, ForkNumber fork, BufferAccessStrategy strategy, uint32 flags, BlockNumber extend_to, ReadBufferMode mode)
Definition: bufmgr.c:909
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:4896
Buffer ReadBufferWithoutRelcache(RelFileLocator rlocator, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy, bool permanent)
Definition: bufmgr.c:829
bool ReadRecentBuffer(RelFileLocator rlocator, ForkNumber forkNum, BlockNumber blockNum, Buffer recent_buffer)
Definition: bufmgr.c:669
#define P_NEW
Definition: bufmgr.h:188
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:404
#define BMR_SMGR(p_smgr, p_relpersistence)
Definition: bufmgr.h:108
@ EB_PERFORMING_RECOVERY
Definition: bufmgr.h:77
@ EB_SKIP_EXTENSION_LOCK
Definition: bufmgr.h:74
@ RBM_NORMAL
Definition: bufmgr.h:45
@ RBM_NORMAL_NO_LOG
Definition: bufmgr.h:51
static bool BufferIsValid(Buffer bufnum)
Definition: bufmgr.h:355
Pointer Page
Definition: bufpage.h:78
static bool PageIsNew(Page page)
Definition: bufpage.h:230
#define Assert(condition)
Definition: c.h:858
static PgChecksumMode mode
Definition: pg_checksums.c:56
BlockNumber smgrnblocks(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:655
void smgrcreate(SMgrRelation reln, ForkNumber forknum, bool isRedo)
Definition: smgr.c:411
bool InRecovery
Definition: xlogutils.c:50
static void log_invalid_page(RelFileLocator locator, ForkNumber forkno, BlockNumber blkno, bool present)
Definition: xlogutils.c:102

References Assert, BMR_SMGR, BufferGetPage(), BufferIsValid(), EB_PERFORMING_RECOVERY, EB_SKIP_EXTENSION_LOCK, ExtendBufferedRelTo(), InRecovery, INVALID_PROC_NUMBER, InvalidBuffer, log_invalid_page(), mode, P_NEW, PageIsNew(), RBM_NORMAL, RBM_NORMAL_NO_LOG, ReadBufferWithoutRelcache(), ReadRecentBuffer(), ReleaseBuffer(), smgrcreate(), smgrnblocks(), and smgropen().

Referenced by verifyBackupPageConsistency(), XLogReadBufferForRedoExtended(), and XLogRecordPageWithFreeSpace().

◆ XLogReadBufferForRedo()

XLogRedoAction XLogReadBufferForRedo ( XLogReaderState record,
uint8  block_id,
Buffer buf 
)

Definition at line 314 of file xlogutils.c.

316 {
317  return XLogReadBufferForRedoExtended(record, block_id, RBM_NORMAL,
318  false, buf);
319 }

References buf, RBM_NORMAL, and XLogReadBufferForRedoExtended().

Referenced by _bt_clear_incomplete_split(), brin_xlog_desummarize_page(), brin_xlog_insert_update(), brin_xlog_revmap_extend(), brin_xlog_samepage_update(), brin_xlog_update(), btree_xlog_dedup(), btree_xlog_delete(), btree_xlog_insert(), btree_xlog_mark_page_halfdead(), btree_xlog_split(), btree_xlog_unlink_page(), generic_redo(), ginRedoClearIncompleteSplit(), ginRedoDeletePage(), ginRedoInsert(), ginRedoSplit(), ginRedoUpdateMetapage(), ginRedoVacuumDataLeafPage(), ginRedoVacuumPage(), gistRedoClearFollowRight(), gistRedoDeleteRecord(), gistRedoPageDelete(), gistRedoPageUpdateRecord(), hash_xlog_add_ovfl_page(), hash_xlog_delete(), hash_xlog_init_bitmap_page(), hash_xlog_insert(), hash_xlog_move_page_contents(), hash_xlog_split_allocate_page(), hash_xlog_split_cleanup(), hash_xlog_split_complete(), hash_xlog_split_page(), hash_xlog_squeeze_page(), hash_xlog_update_meta_page(), hash_xlog_vacuum_one_page(), heap_xlog_confirm(), heap_xlog_delete(), heap_xlog_inplace(), heap_xlog_insert(), heap_xlog_lock(), heap_xlog_lock_updated(), heap_xlog_multi_insert(), heap_xlog_update(), heap_xlog_visible(), spgRedoAddLeaf(), spgRedoAddNode(), spgRedoMoveLeafs(), spgRedoPickSplit(), spgRedoSplitTuple(), spgRedoVacuumLeaf(), spgRedoVacuumRedirect(), spgRedoVacuumRoot(), and xlog_redo().

◆ XLogReadBufferForRedoExtended()

XLogRedoAction XLogReadBufferForRedoExtended ( XLogReaderState record,
uint8  block_id,
ReadBufferMode  mode,
bool  get_cleanup_lock,
Buffer buf 
)

Definition at line 351 of file xlogutils.c.

355 {
356  XLogRecPtr lsn = record->EndRecPtr;
357  RelFileLocator rlocator;
358  ForkNumber forknum;
359  BlockNumber blkno;
360  Buffer prefetch_buffer;
361  Page page;
362  bool zeromode;
363  bool willinit;
364 
365  if (!XLogRecGetBlockTagExtended(record, block_id, &rlocator, &forknum, &blkno,
366  &prefetch_buffer))
367  {
368  /* Caller specified a bogus block_id */
369  elog(PANIC, "failed to locate backup block with ID %d in WAL record",
370  block_id);
371  }
372 
373  /*
374  * Make sure that if the block is marked with WILL_INIT, the caller is
375  * going to initialize it. And vice versa.
376  */
378  willinit = (XLogRecGetBlock(record, block_id)->flags & BKPBLOCK_WILL_INIT) != 0;
379  if (willinit && !zeromode)
380  elog(PANIC, "block with WILL_INIT flag in WAL record must be zeroed by redo routine");
381  if (!willinit && zeromode)
382  elog(PANIC, "block to be initialized in redo routine must be marked with WILL_INIT flag in the WAL record");
383 
384  /* If it has a full-page image and it should be restored, do it. */
385  if (XLogRecBlockImageApply(record, block_id))
386  {
387  Assert(XLogRecHasBlockImage(record, block_id));
388  *buf = XLogReadBufferExtended(rlocator, forknum, blkno,
389  get_cleanup_lock ? RBM_ZERO_AND_CLEANUP_LOCK : RBM_ZERO_AND_LOCK,
390  prefetch_buffer);
391  page = BufferGetPage(*buf);
392  if (!RestoreBlockImage(record, block_id, page))
393  ereport(ERROR,
394  (errcode(ERRCODE_INTERNAL_ERROR),
395  errmsg_internal("%s", record->errormsg_buf)));
396 
397  /*
398  * The page may be uninitialized. If so, we can't set the LSN because
399  * that would corrupt the page.
400  */
401  if (!PageIsNew(page))
402  {
403  PageSetLSN(page, lsn);
404  }
405 
407 
408  /*
409  * At the end of crash recovery the init forks of unlogged relations
410  * are copied, without going through shared buffers. So we need to
411  * force the on-disk state of init forks to always be in sync with the
412  * state in shared buffers.
413  */
414  if (forknum == INIT_FORKNUM)
416 
417  return BLK_RESTORED;
418  }
419  else
420  {
421  *buf = XLogReadBufferExtended(rlocator, forknum, blkno, mode, prefetch_buffer);
422  if (BufferIsValid(*buf))
423  {
425  {
426  if (get_cleanup_lock)
428  else
430  }
431  if (lsn <= PageGetLSN(BufferGetPage(*buf)))
432  return BLK_DONE;
433  else
434  return BLK_NEEDS_REDO;
435  }
436  else
437  return BLK_NOTFOUND;
438  }
439 }
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:2520
void LockBufferForCleanup(Buffer buffer)
Definition: bufmgr.c:5211
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:5131
void FlushOneBuffer(Buffer buffer)
Definition: bufmgr.c:4876
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:195
@ RBM_ZERO_AND_CLEANUP_LOCK
Definition: bufmgr.h:48
static void PageSetLSN(Page page, XLogRecPtr lsn)
Definition: bufpage.h:388
static XLogRecPtr PageGetLSN(Page page)
Definition: bufpage.h:383
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1155
ForkNumber
Definition: relpath.h:48
@ INIT_FORKNUM
Definition: relpath.h:53
char * errormsg_buf
Definition: xlogreader.h:311
XLogRecPtr EndRecPtr
Definition: xlogreader.h:207
uint64 XLogRecPtr
Definition: xlogdefs.h:21
bool XLogRecGetBlockTagExtended(XLogReaderState *record, uint8 block_id, RelFileLocator *rlocator, ForkNumber *forknum, BlockNumber *blknum, Buffer *prefetch_buffer)
Definition: xlogreader.c:1997
bool RestoreBlockImage(XLogReaderState *record, uint8 block_id, char *page)
Definition: xlogreader.c:2056
#define XLogRecBlockImageApply(decoder, block_id)
Definition: xlogreader.h:425
#define XLogRecGetBlock(decoder, i)
Definition: xlogreader.h:419
#define XLogRecHasBlockImage(decoder, block_id)
Definition: xlogreader.h:423
#define BKPBLOCK_WILL_INIT
Definition: xlogrecord.h:199
Buffer XLogReadBufferExtended(RelFileLocator rlocator, ForkNumber forknum, BlockNumber blkno, ReadBufferMode mode, Buffer recent_buffer)
Definition: xlogutils.c:471

References Assert, BKPBLOCK_WILL_INIT, BLK_DONE, BLK_NEEDS_REDO, BLK_NOTFOUND, BLK_RESTORED, buf, BUFFER_LOCK_EXCLUSIVE, BufferGetPage(), BufferIsValid(), elog, XLogReaderState::EndRecPtr, ereport, errcode(), errmsg_internal(), ERROR, XLogReaderState::errormsg_buf, FlushOneBuffer(), INIT_FORKNUM, LockBuffer(), LockBufferForCleanup(), MarkBufferDirty(), mode, PageGetLSN(), PageIsNew(), PageSetLSN(), PANIC, RBM_ZERO_AND_CLEANUP_LOCK, RBM_ZERO_AND_LOCK, RestoreBlockImage(), XLogReadBufferExtended(), XLogRecBlockImageApply, XLogRecGetBlock, XLogRecGetBlockTagExtended(), and XLogRecHasBlockImage.

Referenced by btree_xlog_vacuum(), hash_xlog_delete(), hash_xlog_move_page_contents(), hash_xlog_split_allocate_page(), hash_xlog_squeeze_page(), hash_xlog_vacuum_one_page(), heap_xlog_prune_freeze(), heap_xlog_visible(), XLogInitBufferForRedo(), and XLogReadBufferForRedo().

◆ XLogReadDetermineTimeline()

void XLogReadDetermineTimeline ( XLogReaderState state,
XLogRecPtr  wantPage,
uint32  wantLength,
TimeLineID  currTLI 
)

Definition at line 718 of file xlogutils.c.

720 {
721  const XLogRecPtr lastReadPage = (state->seg.ws_segno *
722  state->segcxt.ws_segsize + state->segoff);
723 
724  Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0);
725  Assert(wantLength <= XLOG_BLCKSZ);
726  Assert(state->readLen == 0 || state->readLen <= XLOG_BLCKSZ);
727  Assert(currTLI != 0);
728 
729  /*
730  * If the desired page is currently read in and valid, we have nothing to
731  * do.
732  *
733  * The caller should've ensured that it didn't previously advance readOff
734  * past the valid limit of this timeline, so it doesn't matter if the
735  * current TLI has since become historical.
736  */
737  if (lastReadPage == wantPage &&
738  state->readLen != 0 &&
739  lastReadPage + state->readLen >= wantPage + Min(wantLength, XLOG_BLCKSZ - 1))
740  return;
741 
742  /*
743  * If we're reading from the current timeline, it hasn't become historical
744  * and the page we're reading is after the last page read, we can again
745  * just carry on. (Seeking backwards requires a check to make sure the
746  * older page isn't on a prior timeline).
747  *
748  * currTLI might've become historical since the caller obtained the value,
749  * but the caller is required not to read past the flush limit it saw at
750  * the time it looked up the timeline. There's nothing we can do about it
751  * if StartupXLOG() renames it to .partial concurrently.
752  */
753  if (state->currTLI == currTLI && wantPage >= lastReadPage)
754  {
755  Assert(state->currTLIValidUntil == InvalidXLogRecPtr);
756  return;
757  }
758 
759  /*
760  * If we're just reading pages from a previously validated historical
761  * timeline and the timeline we're reading from is valid until the end of
762  * the current segment we can just keep reading.
763  */
764  if (state->currTLIValidUntil != InvalidXLogRecPtr &&
765  state->currTLI != currTLI &&
766  state->currTLI != 0 &&
767  ((wantPage + wantLength) / state->segcxt.ws_segsize) <
768  (state->currTLIValidUntil / state->segcxt.ws_segsize))
769  return;
770 
771  /*
772  * If we reach this point we're either looking up a page for random
773  * access, the current timeline just became historical, or we're reading
774  * from a new segment containing a timeline switch. In all cases we need
775  * to determine the newest timeline on the segment.
776  *
777  * If it's the current timeline we can just keep reading from here unless
778  * we detect a timeline switch that makes the current timeline historical.
779  * If it's a historical timeline we can read all the segment on the newest
780  * timeline because it contains all the old timelines' data too. So only
781  * one switch check is required.
782  */
783  {
784  /*
785  * We need to re-read the timeline history in case it's been changed
786  * by a promotion or replay from a cascaded replica.
787  */
788  List *timelineHistory = readTimeLineHistory(currTLI);
789  XLogRecPtr endOfSegment;
790 
791  endOfSegment = ((wantPage / state->segcxt.ws_segsize) + 1) *
792  state->segcxt.ws_segsize - 1;
793  Assert(wantPage / state->segcxt.ws_segsize ==
794  endOfSegment / state->segcxt.ws_segsize);
795 
796  /*
797  * Find the timeline of the last LSN on the segment containing
798  * wantPage.
799  */
800  state->currTLI = tliOfPointInHistory(endOfSegment, timelineHistory);
801  state->currTLIValidUntil = tliSwitchPoint(state->currTLI, timelineHistory,
802  &state->nextTLI);
803 
804  Assert(state->currTLIValidUntil == InvalidXLogRecPtr ||
805  wantPage + wantLength < state->currTLIValidUntil);
806 
807  list_free_deep(timelineHistory);
808 
809  elog(DEBUG3, "switched to timeline %u valid until %X/%X",
810  state->currTLI,
811  LSN_FORMAT_ARGS(state->currTLIValidUntil));
812  }
813 }
TimeLineID tliOfPointInHistory(XLogRecPtr ptr, List *history)
Definition: timeline.c:544
XLogRecPtr tliSwitchPoint(TimeLineID tli, List *history, TimeLineID *nextTLI)
Definition: timeline.c:572
List * readTimeLineHistory(TimeLineID targetTLI)
Definition: timeline.c:76
#define Min(x, y)
Definition: c.h:1004
#define DEBUG3
Definition: elog.h:28
void list_free_deep(List *list)
Definition: list.c:1560
Definition: pg_list.h:54
#define LSN_FORMAT_ARGS(lsn)
Definition: xlogdefs.h:43
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28

References Assert, DEBUG3, elog, InvalidXLogRecPtr, list_free_deep(), LSN_FORMAT_ARGS, Min, readTimeLineHistory(), tliOfPointInHistory(), and tliSwitchPoint().

Referenced by logical_read_xlog_page(), and read_local_xlog_page_guts().

◆ XLogTruncateRelation()

void XLogTruncateRelation ( RelFileLocator  rlocator,
ForkNumber  forkNum,
BlockNumber  nblocks 
)

Definition at line 671 of file xlogutils.c.

673 {
674  forget_invalid_pages(rlocator, forkNum, nblocks);
675 }

References forget_invalid_pages().

Referenced by smgr_redo().

Variable Documentation

◆ InRecovery

◆ standbyState