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.

Enumerations

enum  XLogRedoAction { BLK_NEEDS_REDO, BLK_DONE, BLK_RESTORED, BLK_NOTFOUND }
 

Functions

bool XLogHaveInvalidPages (void)
 
void XLogCheckInvalidPages (void)
 
void XLogDropRelation (RelFileNode rnode, ForkNumber forknum)
 
void XLogDropDatabase (Oid dbid)
 
void XLogTruncateRelation (RelFileNode rnode, ForkNumber forkNum, BlockNumber nblocks)
 
XLogRedoAction XLogReadBufferForRedo (XLogReaderState *record, uint8 buffer_id, Buffer *buf)
 
Buffer XLogInitBufferForRedo (XLogReaderState *record, uint8 block_id)
 
XLogRedoAction XLogReadBufferForRedoExtended (XLogReaderState *record, uint8 buffer_id, ReadBufferMode mode, bool get_cleanup_lock, Buffer *buf)
 
Buffer XLogReadBufferExtended (RelFileNode rnode, ForkNumber forknum, BlockNumber blkno, ReadBufferMode mode)
 
Relation CreateFakeRelcacheEntry (RelFileNode rnode)
 
void FreeFakeRelcacheEntry (Relation fakerel)
 
int read_local_xlog_page (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)
 
void WALReadRaiseError (WALReadError *errinfo)
 

Enumeration Type Documentation

◆ XLogRedoAction

Enumerator
BLK_NEEDS_REDO 
BLK_DONE 
BLK_RESTORED 
BLK_NOTFOUND 

Definition at line 27 of file xlogutils.h.

28 {
29  BLK_NEEDS_REDO, /* changes from WAL record need to be applied */
30  BLK_DONE, /* block is already up-to-date */
31  BLK_RESTORED, /* block was restored from a full-page image */
32  BLK_NOTFOUND /* block was not found (and hence does not
33  * need to be replayed) */
XLogRedoAction
Definition: xlogutils.h:27

Function Documentation

◆ CreateFakeRelcacheEntry()

Relation CreateFakeRelcacheEntry ( RelFileNode  rnode)

Definition at line 557 of file xlogutils.c.

References LockRelId::dbId, RelFileNode::dbNode, InvalidBackendId, LockInfoData::lockRelId, palloc0(), FakeRelCacheEntryData::pgc, RelationData::rd_backend, RelationData::rd_lockInfo, RelationData::rd_node, RelationData::rd_rel, RelationData::rd_smgr, RelationGetRelationName, LockRelId::relId, RelFileNode::relNode, 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().

558 {
559  FakeRelCacheEntry fakeentry;
560  Relation rel;
561 
562  /* Allocate the Relation struct and all related space in one block. */
563  fakeentry = palloc0(sizeof(FakeRelCacheEntryData));
564  rel = (Relation) fakeentry;
565 
566  rel->rd_rel = &fakeentry->pgc;
567  rel->rd_node = rnode;
568 
569  /*
570  * We will never be working with temp rels during recovery or while
571  * syncing WAL-skipped files.
572  */
574 
575  /* It must be a permanent table here */
576  rel->rd_rel->relpersistence = RELPERSISTENCE_PERMANENT;
577 
578  /* We don't know the name of the relation; use relfilenode instead */
579  sprintf(RelationGetRelationName(rel), "%u", rnode.relNode);
580 
581  /*
582  * We set up the lockRelId in case anything tries to lock the dummy
583  * relation. Note that this is fairly bogus since relNode may be
584  * different from the relation's OID. It shouldn't really matter though.
585  * In recovery, we are running by ourselves and can't have any lock
586  * conflicts. While syncing, we already hold AccessExclusiveLock.
587  */
588  rel->rd_lockInfo.lockRelId.dbId = rnode.dbNode;
589  rel->rd_lockInfo.lockRelId.relId = rnode.relNode;
590 
591  rel->rd_smgr = NULL;
592 
593  return rel;
594 }
LockRelId lockRelId
Definition: rel.h:44
struct SMgrRelationData * rd_smgr
Definition: rel.h:57
Oid dbId
Definition: rel.h:39
Form_pg_class rd_rel
Definition: rel.h:109
#define sprintf
Definition: port.h:195
struct RelationData * Relation
Definition: relcache.h:27
LockInfoData rd_lockInfo
Definition: rel.h:112
#define RelationGetRelationName(relation)
Definition: rel.h:490
#define InvalidBackendId
Definition: backendid.h:23
void * palloc0(Size size)
Definition: mcxt.c:980
RelFileNode rd_node
Definition: rel.h:55
BackendId rd_backend
Definition: rel.h:59
FormData_pg_class pgc
Definition: xlogutils.c:537
Oid relId
Definition: rel.h:38

◆ FreeFakeRelcacheEntry()

void FreeFakeRelcacheEntry ( Relation  fakerel)

Definition at line 600 of file xlogutils.c.

References pfree(), RelationData::rd_smgr, and smgrclearowner().

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().

601 {
602  /* make sure the fakerel is not referenced by the SmgrRelation anymore */
603  if (fakerel->rd_smgr != NULL)
604  smgrclearowner(&fakerel->rd_smgr, fakerel->rd_smgr);
605  pfree(fakerel);
606 }
void smgrclearowner(SMgrRelation *owner, SMgrRelation reln)
Definition: smgr.c:228
struct SMgrRelationData * rd_smgr
Definition: rel.h:57
void pfree(void *pointer)
Definition: mcxt.c:1056

◆ read_local_xlog_page()

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

Definition at line 832 of file xlogutils.c.

References CHECK_FOR_INTERRUPTS, XLogReaderState::currTLI, XLogReaderState::currTLIValidUntil, GetFlushRecPtr(), GetXLogReplayRecPtr(), pg_usleep(), RecoveryInProgress(), ThisTimeLineID, WALRead(), WALReadRaiseError(), and XLogReadDetermineTimeline().

Referenced by create_logical_replication_slot(), pg_logical_replication_slot_advance(), pg_logical_slot_get_changes_guts(), and XlogReadTwoPhaseData().

834 {
835  XLogRecPtr read_upto,
836  loc;
837  TimeLineID tli;
838  int count;
839  WALReadError errinfo;
840 
841  loc = targetPagePtr + reqLen;
842 
843  /* Loop waiting for xlog to be available if necessary */
844  while (1)
845  {
846  /*
847  * Determine the limit of xlog we can currently read to, and what the
848  * most recent timeline is.
849  *
850  * RecoveryInProgress() will update ThisTimeLineID when it first
851  * notices recovery finishes, so we only have to maintain it for the
852  * local process until recovery ends.
853  */
854  if (!RecoveryInProgress())
855  read_upto = GetFlushRecPtr();
856  else
857  read_upto = GetXLogReplayRecPtr(&ThisTimeLineID);
858  tli = ThisTimeLineID;
859 
860  /*
861  * Check which timeline to get the record from.
862  *
863  * We have to do it each time through the loop because if we're in
864  * recovery as a cascading standby, the current timeline might've
865  * become historical. We can't rely on RecoveryInProgress() because in
866  * a standby configuration like
867  *
868  * A => B => C
869  *
870  * if we're a logical decoding session on C, and B gets promoted, our
871  * timeline will change while we remain in recovery.
872  *
873  * We can't just keep reading from the old timeline as the last WAL
874  * archive in the timeline will get renamed to .partial by
875  * StartupXLOG().
876  *
877  * If that happens after our caller updated ThisTimeLineID but before
878  * we actually read the xlog page, we might still try to read from the
879  * old (now renamed) segment and fail. There's not much we can do
880  * about this, but it can only happen when we're a leaf of a cascading
881  * standby whose primary gets promoted while we're decoding, so a
882  * one-off ERROR isn't too bad.
883  */
884  XLogReadDetermineTimeline(state, targetPagePtr, reqLen);
885 
886  if (state->currTLI == ThisTimeLineID)
887  {
888 
889  if (loc <= read_upto)
890  break;
891 
893  pg_usleep(1000L);
894  }
895  else
896  {
897  /*
898  * We're on a historical timeline, so limit reading to the switch
899  * point where we moved to the next timeline.
900  *
901  * We don't need to GetFlushRecPtr or GetXLogReplayRecPtr. We know
902  * about the new timeline, so we must've received past the end of
903  * it.
904  */
905  read_upto = state->currTLIValidUntil;
906 
907  /*
908  * Setting tli to our wanted record's TLI is slightly wrong; the
909  * page might begin on an older timeline if it contains a timeline
910  * switch, since its xlog segment will have been copied from the
911  * prior timeline. This is pretty harmless though, as nothing
912  * cares so long as the timeline doesn't go backwards. We should
913  * read the page header instead; FIXME someday.
914  */
915  tli = state->currTLI;
916 
917  /* No need to wait on a historical timeline */
918  break;
919  }
920  }
921 
922  if (targetPagePtr + XLOG_BLCKSZ <= read_upto)
923  {
924  /*
925  * more than one block available; read only that block, have caller
926  * come back if they need more.
927  */
928  count = XLOG_BLCKSZ;
929  }
930  else if (targetPagePtr + reqLen > read_upto)
931  {
932  /* not enough data there */
933  return -1;
934  }
935  else
936  {
937  /* enough bytes available to satisfy the request */
938  count = read_upto - targetPagePtr;
939  }
940 
941  /*
942  * Even though we just determined how much of the page can be validly read
943  * as 'count', read the whole page anyway. It's guaranteed to be
944  * zero-padded up to the page boundary if it's incomplete.
945  */
946  if (!WALRead(state, cur_page, targetPagePtr, XLOG_BLCKSZ, tli,
947  &errinfo))
948  WALReadRaiseError(&errinfo);
949 
950  /* number of valid bytes in the buffer */
951  return count;
952 }
uint32 TimeLineID
Definition: xlogdefs.h:52
void WALReadRaiseError(WALReadError *errinfo)
Definition: xlogutils.c:959
XLogRecPtr GetFlushRecPtr(void)
Definition: xlog.c:8421
bool RecoveryInProgress(void)
Definition: xlog.c:8069
void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength)
Definition: xlogutils.c:690
void pg_usleep(long microsec)
Definition: signal.c:53
XLogRecPtr GetXLogReplayRecPtr(TimeLineID *replayTLI)
Definition: xlog.c:11475
XLogRecPtr currTLIValidUntil
Definition: xlogreader.h:238
TimeLineID ThisTimeLineID
Definition: xlog.c:191
TimeLineID currTLI
Definition: xlogreader.h:228
uint64 XLogRecPtr
Definition: xlogdefs.h:21
bool WALRead(XLogReaderState *state, char *buf, XLogRecPtr startptr, Size count, TimeLineID tli, WALReadError *errinfo)
Definition: xlogreader.c:1062
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99

◆ wal_segment_close()

void wal_segment_close ( XLogReaderState state)

◆ wal_segment_open()

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

Definition at line 788 of file xlogutils.c.

References BasicOpenFile(), ereport, errcode_for_file_access(), errmsg(), ERROR, MAXPGPATH, PG_BINARY, XLogReaderState::seg, XLogReaderState::segcxt, WALOpenSegment::ws_file, WALSegmentContext::ws_segsize, and XLogFilePath.

Referenced by create_logical_replication_slot(), pg_logical_replication_slot_advance(), pg_logical_slot_get_changes_guts(), and XlogReadTwoPhaseData().

790 {
791  TimeLineID tli = *tli_p;
792  char path[MAXPGPATH];
793 
794  XLogFilePath(path, tli, nextSegNo, state->segcxt.ws_segsize);
795  state->seg.ws_file = BasicOpenFile(path, O_RDONLY | PG_BINARY);
796  if (state->seg.ws_file >= 0)
797  return;
798 
799  if (errno == ENOENT)
800  ereport(ERROR,
802  errmsg("requested WAL segment %s has already been removed",
803  path)));
804  else
805  ereport(ERROR,
807  errmsg("could not open file \"%s\": %m",
808  path)));
809 }
uint32 TimeLineID
Definition: xlogdefs.h:52
#define PG_BINARY
Definition: c.h:1211
WALOpenSegment seg
Definition: xlogreader.h:215
#define ERROR
Definition: elog.h:43
#define MAXPGPATH
int errcode_for_file_access(void)
Definition: elog.c:633
#define ereport(elevel,...)
Definition: elog.h:144
int BasicOpenFile(const char *fileName, int fileFlags)
Definition: fd.c:985
#define XLogFilePath(path, tli, logSegNo, wal_segsz_bytes)
int errmsg(const char *fmt,...)
Definition: elog.c:824
WALSegmentContext segcxt
Definition: xlogreader.h:214

◆ WALReadRaiseError()

void WALReadRaiseError ( WALReadError errinfo)

Definition at line 959 of file xlogutils.c.

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(), and XLogSendPhysical().

960 {
961  WALOpenSegment *seg = &errinfo->wre_seg;
962  char fname[MAXFNAMELEN];
963 
964  XLogFileName(fname, seg->ws_tli, seg->ws_segno, wal_segment_size);
965 
966  if (errinfo->wre_read < 0)
967  {
968  errno = errinfo->wre_errno;
969  ereport(ERROR,
971  errmsg("could not read from log segment %s, offset %u: %m",
972  fname, errinfo->wre_off)));
973  }
974  else if (errinfo->wre_read == 0)
975  {
976  ereport(ERROR,
978  errmsg("could not read from log segment %s, offset %u: read %d of %zu",
979  fname, errinfo->wre_off, errinfo->wre_read,
980  (Size) errinfo->wre_req)));
981  }
982 }
WALOpenSegment wre_seg
Definition: xlogreader.h:291
int wal_segment_size
Definition: xlog.c:116
int errcode(int sqlerrcode)
Definition: elog.c:610
#define ERROR
Definition: elog.h:43
XLogSegNo ws_segno
Definition: xlogreader.h:47
int errcode_for_file_access(void)
Definition: elog.c:633
#define ERRCODE_DATA_CORRUPTED
Definition: pg_basebackup.c:45
#define MAXFNAMELEN
#define ereport(elevel,...)
Definition: elog.h:144
size_t Size
Definition: c.h:473
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
TimeLineID ws_tli
Definition: xlogreader.h:48
int errmsg(const char *fmt,...)
Definition: elog.c:824

◆ XLogCheckInvalidPages()

void XLogCheckInvalidPages ( void  )

Definition at line 224 of file xlogutils.c.

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

Referenced by CheckRecoveryConsistency().

225 {
227  xl_invalid_page *hentry;
228  bool foundone = false;
229 
230  if (invalid_page_tab == NULL)
231  return; /* nothing to do */
232 
234 
235  /*
236  * Our strategy is to emit WARNING messages for all remaining entries and
237  * only PANIC after we've dumped all the available info.
238  */
239  while ((hentry = (xl_invalid_page *) hash_seq_search(&status)) != NULL)
240  {
241  report_invalid_page(WARNING, hentry->key.node, hentry->key.forkno,
242  hentry->key.blkno, hentry->present);
243  foundone = true;
244  }
245 
246  if (foundone)
248  "WAL contains references to invalid pages");
249 
251  invalid_page_tab = NULL;
252 }
void hash_destroy(HTAB *hashp)
Definition: dynahash.c:835
ForkNumber forkno
Definition: xlogutils.c:50
#define PANIC
Definition: elog.h:53
RelFileNode node
Definition: xlogutils.c:49
static void report_invalid_page(int elevel, RelFileNode node, ForkNumber forkno, BlockNumber blkno, bool present)
Definition: xlogutils.c:65
BlockNumber blkno
Definition: xlogutils.c:51
xl_invalid_page_key key
Definition: xlogutils.c:56
bool ignore_invalid_pages
Definition: xlogutils.c:35
#define WARNING
Definition: elog.h:40
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition: dynahash.c:1410
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition: dynahash.c:1400
#define elog(elevel,...)
Definition: elog.h:214
static HTAB * invalid_page_tab
Definition: xlogutils.c:60
static void static void status(const char *fmt,...) pg_attribute_printf(1
Definition: pg_regress.c:225

◆ XLogDropDatabase()

void XLogDropDatabase ( Oid  dbid)

Definition at line 626 of file xlogutils.c.

References forget_invalid_pages_db(), and smgrcloseall().

Referenced by dbase_redo().

627 {
628  /*
629  * This is unnecessarily heavy-handed, as it will close SMgrRelation
630  * objects for other databases as well. DROP DATABASE occurs seldom enough
631  * that it's not worth introducing a variant of smgrclose for just this
632  * purpose. XXX: Or should we rather leave the smgr entries dangling?
633  */
634  smgrcloseall();
635 
637 }
static void forget_invalid_pages_db(Oid dbid)
Definition: xlogutils.c:181
void smgrcloseall(void)
Definition: smgr.c:287

◆ XLogDropRelation()

void XLogDropRelation ( RelFileNode  rnode,
ForkNumber  forknum 
)

Definition at line 615 of file xlogutils.c.

References forget_invalid_pages().

Referenced by DropRelationFiles().

616 {
617  forget_invalid_pages(rnode, forknum, 0);
618 }
static void forget_invalid_pages(RelFileNode node, ForkNumber forkno, BlockNumber minblkno)
Definition: xlogutils.c:146

◆ XLogHaveInvalidPages()

bool XLogHaveInvalidPages ( void  )

Definition at line 214 of file xlogutils.c.

References hash_get_num_entries().

Referenced by RecoveryRestartPoint().

215 {
216  if (invalid_page_tab != NULL &&
218  return true;
219  return false;
220 }
long hash_get_num_entries(HTAB *hashp)
Definition: dynahash.c:1356
static HTAB * invalid_page_tab
Definition: xlogutils.c:60

◆ XLogInitBufferForRedo()

◆ XLogReadBufferExtended()

Buffer XLogReadBufferExtended ( RelFileNode  rnode,
ForkNumber  forknum,
BlockNumber  blkno,
ReadBufferMode  mode 
)

Definition at line 442 of file xlogutils.c.

References Assert, BUFFER_LOCK_UNLOCK, BufferGetBlockNumber(), BufferGetPage, InRecovery, InvalidBackendId, InvalidBuffer, LockBuffer(), log_invalid_page(), P_NEW, PageIsNew, RBM_NORMAL, RBM_NORMAL_NO_LOG, RBM_ZERO_AND_CLEANUP_LOCK, RBM_ZERO_AND_LOCK, ReadBufferWithoutRelcache(), ReleaseBuffer(), smgrcreate(), smgrnblocks(), and smgropen().

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

444 {
445  BlockNumber lastblock;
446  Buffer buffer;
447  SMgrRelation smgr;
448 
449  Assert(blkno != P_NEW);
450 
451  /* Open the relation at smgr level */
452  smgr = smgropen(rnode, InvalidBackendId);
453 
454  /*
455  * Create the target file if it doesn't already exist. This lets us cope
456  * if the replay sequence contains writes to a relation that is later
457  * deleted. (The original coding of this routine would instead suppress
458  * the writes, but that seems like it risks losing valuable data if the
459  * filesystem loses an inode during a crash. Better to write the data
460  * until we are actually told to delete the file.)
461  */
462  smgrcreate(smgr, forknum, true);
463 
464  lastblock = smgrnblocks(smgr, forknum);
465 
466  if (blkno < lastblock)
467  {
468  /* page exists in file */
469  buffer = ReadBufferWithoutRelcache(rnode, forknum, blkno,
470  mode, NULL);
471  }
472  else
473  {
474  /* hm, page doesn't exist in file */
475  if (mode == RBM_NORMAL)
476  {
477  log_invalid_page(rnode, forknum, blkno, false);
478  return InvalidBuffer;
479  }
480  if (mode == RBM_NORMAL_NO_LOG)
481  return InvalidBuffer;
482  /* OK to extend the file */
483  /* we do this in recovery only - no rel-extension lock needed */
485  buffer = InvalidBuffer;
486  do
487  {
488  if (buffer != InvalidBuffer)
489  {
492  ReleaseBuffer(buffer);
493  }
494  buffer = ReadBufferWithoutRelcache(rnode, forknum,
495  P_NEW, mode, NULL);
496  }
497  while (BufferGetBlockNumber(buffer) < blkno);
498  /* Handle the corner case that P_NEW returns non-consecutive pages */
499  if (BufferGetBlockNumber(buffer) != blkno)
500  {
503  ReleaseBuffer(buffer);
504  buffer = ReadBufferWithoutRelcache(rnode, forknum, blkno,
505  mode, NULL);
506  }
507  }
508 
509  if (mode == RBM_NORMAL)
510  {
511  /* check that page has been initialized */
512  Page page = (Page) BufferGetPage(buffer);
513 
514  /*
515  * We assume that PageIsNew is safe without a lock. During recovery,
516  * there should be no other backends that could modify the buffer at
517  * the same time.
518  */
519  if (PageIsNew(page))
520  {
521  ReleaseBuffer(buffer);
522  log_invalid_page(rnode, forknum, blkno, true);
523  return InvalidBuffer;
524  }
525  }
526 
527  return buffer;
528 }
static PgChecksumMode mode
Definition: pg_checksums.c:61
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:96
void smgrcreate(SMgrRelation reln, ForkNumber forknum, bool isRedo)
Definition: smgr.c:334
bool InRecovery
Definition: xlog.c:204
#define InvalidBuffer
Definition: buf.h:25
Buffer ReadBufferWithoutRelcache(RelFileNode rnode, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy)
Definition: bufmgr.c:695
uint32 BlockNumber
Definition: block.h:31
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3518
#define P_NEW
Definition: bufmgr.h:91
static void log_invalid_page(RelFileNode node, ForkNumber forkno, BlockNumber blkno, bool present)
Definition: xlogutils.c:81
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
SMgrRelation smgropen(RelFileNode rnode, BackendId backend)
Definition: smgr.c:146
#define InvalidBackendId
Definition: backendid.h:23
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3757
BlockNumber smgrnblocks(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:549
#define Assert(condition)
Definition: c.h:745
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2668
#define PageIsNew(page)
Definition: bufpage.h:229
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78

◆ XLogReadBufferForRedo()

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

Definition at line 294 of file xlogutils.c.

References 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_freeze_page(), 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().

296 {
297  return XLogReadBufferForRedoExtended(record, block_id, RBM_NORMAL,
298  false, buf);
299 }
static char * buf
Definition: pg_test_fsync.c:67
XLogRedoAction XLogReadBufferForRedoExtended(XLogReaderState *record, uint8 block_id, ReadBufferMode mode, bool get_cleanup_lock, Buffer *buf)
Definition: xlogutils.c:331

◆ XLogReadBufferForRedoExtended()

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

Definition at line 331 of file xlogutils.c.

References Assert, BKPBLOCK_WILL_INIT, BLK_DONE, BLK_NEEDS_REDO, BLK_NOTFOUND, BLK_RESTORED, xl_invalid_page_key::blkno, XLogReaderState::blocks, BUFFER_LOCK_EXCLUSIVE, BufferGetPage, BufferIsValid, elog, XLogReaderState::EndRecPtr, ERROR, DecodedBkpBlock::flags, FlushOneBuffer(), INIT_FORKNUM, LockBuffer(), LockBufferForCleanup(), MarkBufferDirty(), PageGetLSN, PageIsNew, PageSetLSN, PANIC, RBM_ZERO_AND_CLEANUP_LOCK, RBM_ZERO_AND_LOCK, RestoreBlockImage(), XLogReadBufferExtended(), XLogRecBlockImageApply, XLogRecGetBlockTag(), 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_clean(), heap_xlog_visible(), XLogInitBufferForRedo(), and XLogReadBufferForRedo().

335 {
336  XLogRecPtr lsn = record->EndRecPtr;
337  RelFileNode rnode;
338  ForkNumber forknum;
339  BlockNumber blkno;
340  Page page;
341  bool zeromode;
342  bool willinit;
343 
344  if (!XLogRecGetBlockTag(record, block_id, &rnode, &forknum, &blkno))
345  {
346  /* Caller specified a bogus block_id */
347  elog(PANIC, "failed to locate backup block with ID %d", block_id);
348  }
349 
350  /*
351  * Make sure that if the block is marked with WILL_INIT, the caller is
352  * going to initialize it. And vice versa.
353  */
355  willinit = (record->blocks[block_id].flags & BKPBLOCK_WILL_INIT) != 0;
356  if (willinit && !zeromode)
357  elog(PANIC, "block with WILL_INIT flag in WAL record must be zeroed by redo routine");
358  if (!willinit && zeromode)
359  elog(PANIC, "block to be initialized in redo routine must be marked with WILL_INIT flag in the WAL record");
360 
361  /* If it has a full-page image and it should be restored, do it. */
362  if (XLogRecBlockImageApply(record, block_id))
363  {
364  Assert(XLogRecHasBlockImage(record, block_id));
365  *buf = XLogReadBufferExtended(rnode, forknum, blkno,
366  get_cleanup_lock ? RBM_ZERO_AND_CLEANUP_LOCK : RBM_ZERO_AND_LOCK);
367  page = BufferGetPage(*buf);
368  if (!RestoreBlockImage(record, block_id, page))
369  elog(ERROR, "failed to restore block image");
370 
371  /*
372  * The page may be uninitialized. If so, we can't set the LSN because
373  * that would corrupt the page.
374  */
375  if (!PageIsNew(page))
376  {
377  PageSetLSN(page, lsn);
378  }
379 
381 
382  /*
383  * At the end of crash recovery the init forks of unlogged relations
384  * are copied, without going through shared buffers. So we need to
385  * force the on-disk state of init forks to always be in sync with the
386  * state in shared buffers.
387  */
388  if (forknum == INIT_FORKNUM)
390 
391  return BLK_RESTORED;
392  }
393  else
394  {
395  *buf = XLogReadBufferExtended(rnode, forknum, blkno, mode);
396  if (BufferIsValid(*buf))
397  {
399  {
400  if (get_cleanup_lock)
402  else
404  }
405  if (lsn <= PageGetLSN(BufferGetPage(*buf)))
406  return BLK_DONE;
407  else
408  return BLK_NEEDS_REDO;
409  }
410  else
411  return BLK_NOTFOUND;
412  }
413 }
static PgChecksumMode mode
Definition: pg_checksums.c:61
void LockBufferForCleanup(Buffer buffer)
Definition: bufmgr.c:3814
#define XLogRecHasBlockImage(decoder, block_id)
Definition: xlogreader.h:315
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1469
Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, BlockNumber blkno, ReadBufferMode mode)
Definition: xlogutils.c:442
uint32 BlockNumber
Definition: block.h:31
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:98
#define PANIC
Definition: elog.h:53
XLogRecPtr EndRecPtr
Definition: xlogreader.h:176
#define ERROR
Definition: elog.h:43
static char * buf
Definition: pg_test_fsync.c:67
#define BufferGetPage(buffer)
Definition: bufmgr.h:169
#define BKPBLOCK_WILL_INIT
Definition: xlogrecord.h:182
ForkNumber
Definition: relpath.h:40
bool XLogRecGetBlockTag(XLogReaderState *record, uint8 block_id, RelFileNode *rnode, ForkNumber *forknum, BlockNumber *blknum)
Definition: xlogreader.c:1497
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3757
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:745
#define BufferIsValid(bufnum)
Definition: bufmgr.h:123
void FlushOneBuffer(Buffer buffer)
Definition: bufmgr.c:3498
bool RestoreBlockImage(XLogReaderState *record, uint8 block_id, char *page)
Definition: xlogreader.c:1550
#define PageGetLSN(page)
Definition: bufpage.h:366
#define PageIsNew(page)
Definition: bufpage.h:229
#define elog(elevel,...)
Definition: elog.h:214
#define XLogRecBlockImageApply(decoder, block_id)
Definition: xlogreader.h:317
#define PageSetLSN(page, lsn)
Definition: bufpage.h:368
Pointer Page
Definition: bufpage.h:78
DecodedBkpBlock blocks[XLR_MAX_BLOCK_ID+1]
Definition: xlogreader.h:197

◆ XLogReadDetermineTimeline()

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

Definition at line 690 of file xlogutils.c.

References Assert, XLogReaderState::currTLI, XLogReaderState::currTLIValidUntil, DEBUG3, elog, InvalidXLogRecPtr, list_free_deep(), Min, XLogReaderState::nextTLI, XLogReaderState::readLen, readTimeLineHistory(), XLogReaderState::seg, XLogReaderState::segcxt, XLogReaderState::segoff, ThisTimeLineID, tliOfPointInHistory(), tliSwitchPoint(), WALOpenSegment::ws_segno, and WALSegmentContext::ws_segsize.

Referenced by logical_read_xlog_page(), and read_local_xlog_page().

691 {
692  const XLogRecPtr lastReadPage = (state->seg.ws_segno *
693  state->segcxt.ws_segsize + state->segoff);
694 
695  Assert(wantPage != InvalidXLogRecPtr && wantPage % XLOG_BLCKSZ == 0);
696  Assert(wantLength <= XLOG_BLCKSZ);
697  Assert(state->readLen == 0 || state->readLen <= XLOG_BLCKSZ);
698 
699  /*
700  * If the desired page is currently read in and valid, we have nothing to
701  * do.
702  *
703  * The caller should've ensured that it didn't previously advance readOff
704  * past the valid limit of this timeline, so it doesn't matter if the
705  * current TLI has since become historical.
706  */
707  if (lastReadPage == wantPage &&
708  state->readLen != 0 &&
709  lastReadPage + state->readLen >= wantPage + Min(wantLength, XLOG_BLCKSZ - 1))
710  return;
711 
712  /*
713  * If we're reading from the current timeline, it hasn't become historical
714  * and the page we're reading is after the last page read, we can again
715  * just carry on. (Seeking backwards requires a check to make sure the
716  * older page isn't on a prior timeline).
717  *
718  * ThisTimeLineID might've become historical since we last looked, but the
719  * caller is required not to read past the flush limit it saw at the time
720  * it looked up the timeline. There's nothing we can do about it if
721  * StartupXLOG() renames it to .partial concurrently.
722  */
723  if (state->currTLI == ThisTimeLineID && wantPage >= lastReadPage)
724  {
726  return;
727  }
728 
729  /*
730  * If we're just reading pages from a previously validated historical
731  * timeline and the timeline we're reading from is valid until the end of
732  * the current segment we can just keep reading.
733  */
734  if (state->currTLIValidUntil != InvalidXLogRecPtr &&
735  state->currTLI != ThisTimeLineID &&
736  state->currTLI != 0 &&
737  ((wantPage + wantLength) / state->segcxt.ws_segsize) <
738  (state->currTLIValidUntil / state->segcxt.ws_segsize))
739  return;
740 
741  /*
742  * If we reach this point we're either looking up a page for random
743  * access, the current timeline just became historical, or we're reading
744  * from a new segment containing a timeline switch. In all cases we need
745  * to determine the newest timeline on the segment.
746  *
747  * If it's the current timeline we can just keep reading from here unless
748  * we detect a timeline switch that makes the current timeline historical.
749  * If it's a historical timeline we can read all the segment on the newest
750  * timeline because it contains all the old timelines' data too. So only
751  * one switch check is required.
752  */
753  {
754  /*
755  * We need to re-read the timeline history in case it's been changed
756  * by a promotion or replay from a cascaded replica.
757  */
758  List *timelineHistory = readTimeLineHistory(ThisTimeLineID);
759  XLogRecPtr endOfSegment;
760 
761  endOfSegment = ((wantPage / state->segcxt.ws_segsize) + 1) *
762  state->segcxt.ws_segsize - 1;
763  Assert(wantPage / state->segcxt.ws_segsize ==
764  endOfSegment / state->segcxt.ws_segsize);
765 
766  /*
767  * Find the timeline of the last LSN on the segment containing
768  * wantPage.
769  */
770  state->currTLI = tliOfPointInHistory(endOfSegment, timelineHistory);
771  state->currTLIValidUntil = tliSwitchPoint(state->currTLI, timelineHistory,
772  &state->nextTLI);
773 
775  wantPage + wantLength < state->currTLIValidUntil);
776 
777  list_free_deep(timelineHistory);
778 
779  elog(DEBUG3, "switched to timeline %u valid until %X/%X",
780  state->currTLI,
781  (uint32) (state->currTLIValidUntil >> 32),
782  (uint32) (state->currTLIValidUntil));
783  }
784 }
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
TimeLineID tliOfPointInHistory(XLogRecPtr ptr, List *history)
Definition: timeline.c:552
#define DEBUG3
Definition: elog.h:23
#define Min(x, y)
Definition: c.h:927
List * readTimeLineHistory(TimeLineID targetTLI)
Definition: timeline.c:76
void list_free_deep(List *list)
Definition: list.c:1390
WALOpenSegment seg
Definition: xlogreader.h:215
XLogSegNo ws_segno
Definition: xlogreader.h:47
XLogRecPtr currTLIValidUntil
Definition: xlogreader.h:238
unsigned int uint32
Definition: c.h:374
TimeLineID nextTLI
Definition: xlogreader.h:244
XLogRecPtr tliSwitchPoint(TimeLineID tli, List *history, TimeLineID *nextTLI)
Definition: timeline.c:580
TimeLineID ThisTimeLineID
Definition: xlog.c:191
TimeLineID currTLI
Definition: xlogreader.h:228
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:745
#define elog(elevel,...)
Definition: elog.h:214
WALSegmentContext segcxt
Definition: xlogreader.h:214
Definition: pg_list.h:50

◆ XLogTruncateRelation()

void XLogTruncateRelation ( RelFileNode  rnode,
ForkNumber  forkNum,
BlockNumber  nblocks 
)

Definition at line 645 of file xlogutils.c.

References forget_invalid_pages().

Referenced by smgr_redo().

647 {
648  forget_invalid_pages(rnode, forkNum, nblocks);
649 }
static void forget_invalid_pages(RelFileNode node, ForkNumber forkno, BlockNumber minblkno)
Definition: xlogutils.c:146