PostgreSQL Source Code  git master
xlogutils.c File Reference
#include "postgres.h"
#include <unistd.h>
#include "access/timeline.h"
#include "access/xlogrecovery.h"
#include "access/xlog_internal.h"
#include "access/xlogprefetcher.h"
#include "access/xlogutils.h"
#include "miscadmin.h"
#include "pgstat.h"
#include "storage/fd.h"
#include "storage/smgr.h"
#include "utils/guc.h"
#include "utils/hsearch.h"
#include "utils/rel.h"
Include dependency graph for xlogutils.c:

Go to the source code of this file.

Data Structures

struct  xl_invalid_page_key
 
struct  xl_invalid_page
 
struct  FakeRelCacheEntryData
 

Typedefs

typedef struct xl_invalid_page_key xl_invalid_page_key
 
typedef struct xl_invalid_page xl_invalid_page
 
typedef FakeRelCacheEntryDataFakeRelCacheEntry
 

Functions

static int read_local_xlog_page_guts (XLogReaderState *state, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *cur_page, bool wait_for_wal)
 
static void report_invalid_page (int elevel, RelFileLocator locator, ForkNumber forkno, BlockNumber blkno, bool present)
 
static void log_invalid_page (RelFileLocator locator, ForkNumber forkno, BlockNumber blkno, bool present)
 
static void forget_invalid_pages (RelFileLocator locator, ForkNumber forkno, BlockNumber minblkno)
 
static void forget_invalid_pages_db (Oid dbid)
 
bool XLogHaveInvalidPages (void)
 
void XLogCheckInvalidPages (void)
 
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)
 
void XLogDropRelation (RelFileLocator rlocator, ForkNumber forknum)
 
void XLogDropDatabase (Oid dbid)
 
void XLogTruncateRelation (RelFileLocator rlocator, ForkNumber forkNum, BlockNumber nblocks)
 
void XLogReadDetermineTimeline (XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength, TimeLineID currTLI)
 
void wal_segment_open (XLogReaderState *state, XLogSegNo nextSegNo, TimeLineID *tli_p)
 
void wal_segment_close (XLogReaderState *state)
 
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 WALReadRaiseError (WALReadError *errinfo)
 

Variables

bool ignore_invalid_pages = false
 
bool InRecovery = false
 
HotStandbyState standbyState = STANDBY_DISABLED
 
static HTABinvalid_page_tab = NULL
 

Typedef Documentation

◆ FakeRelCacheEntry

Definition at line 568 of file xlogutils.c.

◆ xl_invalid_page

◆ xl_invalid_page_key

Function Documentation

◆ CreateFakeRelcacheEntry()

Relation CreateFakeRelcacheEntry ( RelFileLocator  rlocator)

Definition at line 585 of file xlogutils.c.

586 {
587  FakeRelCacheEntry fakeentry;
588  Relation rel;
589 
590  /* Allocate the Relation struct and all related space in one block. */
591  fakeentry = palloc0(sizeof(FakeRelCacheEntryData));
592  rel = (Relation) fakeentry;
593 
594  rel->rd_rel = &fakeentry->pgc;
595  rel->rd_locator = rlocator;
596 
597  /*
598  * We will never be working with temp rels during recovery or while
599  * syncing WAL-skipped files.
600  */
602 
603  /* It must be a permanent table here */
604  rel->rd_rel->relpersistence = RELPERSISTENCE_PERMANENT;
605 
606  /* We don't know the name of the relation; use relfilenumber instead */
607  sprintf(RelationGetRelationName(rel), "%u", rlocator.relNumber);
608 
609  /*
610  * We set up the lockRelId in case anything tries to lock the dummy
611  * relation. Note that this is fairly bogus since relNumber may be
612  * different from the relation's OID. It shouldn't really matter though.
613  * In recovery, we are running by ourselves and can't have any lock
614  * conflicts. While syncing, we already hold AccessExclusiveLock.
615  */
616  rel->rd_lockInfo.lockRelId.dbId = rlocator.dbOid;
617  rel->rd_lockInfo.lockRelId.relId = rlocator.relNumber;
618 
619  rel->rd_smgr = NULL;
620 
621  return rel;
622 }
#define InvalidBackendId
Definition: backendid.h:23
void * palloc0(Size size)
Definition: mcxt.c:1257
#define sprintf
Definition: port.h:240
#define RelationGetRelationName(relation)
Definition: rel.h:538
struct RelationData * Relation
Definition: relcache.h:27
FormData_pg_class pgc
Definition: xlogutils.c:565
LockRelId lockRelId
Definition: rel.h:46
Oid relId
Definition: rel.h:40
Oid dbId
Definition: rel.h:41
RelFileNumber relNumber
LockInfoData rd_lockInfo
Definition: rel.h:114
BackendId rd_backend
Definition: rel.h:60
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, InvalidBackendId, 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, 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().

◆ forget_invalid_pages()

static void forget_invalid_pages ( RelFileLocator  locator,
ForkNumber  forkno,
BlockNumber  minblkno 
)
static

Definition at line 169 of file xlogutils.c.

171 {
172  HASH_SEQ_STATUS status;
173  xl_invalid_page *hentry;
174 
175  if (invalid_page_tab == NULL)
176  return; /* nothing to do */
177 
179 
180  while ((hentry = (xl_invalid_page *) hash_seq_search(&status)) != NULL)
181  {
182  if (RelFileLocatorEquals(hentry->key.locator, locator) &&
183  hentry->key.forkno == forkno &&
184  hentry->key.blkno >= minblkno)
185  {
187  {
188  char *path = relpathperm(hentry->key.locator, forkno);
189 
190  elog(DEBUG2, "page %u of relation %s has been dropped",
191  hentry->key.blkno, path);
192  pfree(path);
193  }
194 
196  &hentry->key,
197  HASH_REMOVE, NULL) == NULL)
198  elog(ERROR, "hash table corrupted");
199  }
200  }
201 }
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:953
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition: dynahash.c:1431
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition: dynahash.c:1421
bool message_level_is_interesting(int elevel)
Definition: elog.c:277
#define DEBUG2
Definition: elog.h:29
#define ERROR
Definition: elog.h:39
@ HASH_REMOVE
Definition: hsearch.h:115
void pfree(void *pointer)
Definition: mcxt.c:1456
#define RelFileLocatorEquals(locator1, locator2)
#define relpathperm(rlocator, forknum)
Definition: relpath.h:90
BlockNumber blkno
Definition: xlogutils.c:72
RelFileLocator locator
Definition: xlogutils.c:70
ForkNumber forkno
Definition: xlogutils.c:71
xl_invalid_page_key key
Definition: xlogutils.c:77
static HTAB * invalid_page_tab
Definition: xlogutils.c:81

References xl_invalid_page_key::blkno, DEBUG2, elog(), ERROR, xl_invalid_page_key::forkno, HASH_REMOVE, hash_search(), hash_seq_init(), hash_seq_search(), invalid_page_tab, xl_invalid_page::key, xl_invalid_page_key::locator, message_level_is_interesting(), pfree(), RelFileLocatorEquals, and relpathperm.

Referenced by XLogDropRelation(), and XLogTruncateRelation().

◆ forget_invalid_pages_db()

static void forget_invalid_pages_db ( Oid  dbid)
static

Definition at line 205 of file xlogutils.c.

206 {
207  HASH_SEQ_STATUS status;
208  xl_invalid_page *hentry;
209 
210  if (invalid_page_tab == NULL)
211  return; /* nothing to do */
212 
214 
215  while ((hentry = (xl_invalid_page *) hash_seq_search(&status)) != NULL)
216  {
217  if (hentry->key.locator.dbOid == dbid)
218  {
220  {
221  char *path = relpathperm(hentry->key.locator, hentry->key.forkno);
222 
223  elog(DEBUG2, "page %u of relation %s has been dropped",
224  hentry->key.blkno, path);
225  pfree(path);
226  }
227 
229  &hentry->key,
230  HASH_REMOVE, NULL) == NULL)
231  elog(ERROR, "hash table corrupted");
232  }
233  }
234 }

References xl_invalid_page_key::blkno, RelFileLocator::dbOid, DEBUG2, elog(), ERROR, xl_invalid_page_key::forkno, HASH_REMOVE, hash_search(), hash_seq_init(), hash_seq_search(), invalid_page_tab, xl_invalid_page::key, xl_invalid_page_key::locator, message_level_is_interesting(), pfree(), and relpathperm.

Referenced by XLogDropDatabase().

◆ FreeFakeRelcacheEntry()

void FreeFakeRelcacheEntry ( Relation  fakerel)

Definition at line 628 of file xlogutils.c.

629 {
630  /* make sure the fakerel is not referenced by the SmgrRelation anymore */
631  if (fakerel->rd_smgr != NULL)
632  smgrclearowner(&fakerel->rd_smgr, fakerel->rd_smgr);
633  pfree(fakerel);
634 }
void smgrclearowner(SMgrRelation *owner, SMgrRelation reln)
Definition: smgr.c:231

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

◆ log_invalid_page()

static void log_invalid_page ( RelFileLocator  locator,
ForkNumber  forkno,
BlockNumber  blkno,
bool  present 
)
static

Definition at line 105 of file xlogutils.c.

107 {
109  xl_invalid_page *hentry;
110  bool found;
111 
112  /*
113  * Once recovery has reached a consistent state, the invalid-page table
114  * should be empty and remain so. If a reference to an invalid page is
115  * found after consistency is reached, PANIC immediately. This might seem
116  * aggressive, but it's better than letting the invalid reference linger
117  * in the hash table until the end of recovery and PANIC there, which
118  * might come only much later if this is a standby server.
119  */
120  if (reachedConsistency)
121  {
122  report_invalid_page(WARNING, locator, forkno, blkno, present);
124  "WAL contains references to invalid pages");
125  }
126 
127  /*
128  * Log references to invalid pages at DEBUG1 level. This allows some
129  * tracing of the cause (note the elog context mechanism will tell us
130  * something about the XLOG record that generated the reference).
131  */
133  report_invalid_page(DEBUG1, locator, forkno, blkno, present);
134 
135  if (invalid_page_tab == NULL)
136  {
137  /* create hash table when first needed */
138  HASHCTL ctl;
139 
140  ctl.keysize = sizeof(xl_invalid_page_key);
141  ctl.entrysize = sizeof(xl_invalid_page);
142 
143  invalid_page_tab = hash_create("XLOG invalid-page table",
144  100,
145  &ctl,
147  }
148 
149  /* we currently assume xl_invalid_page_key contains no padding */
150  key.locator = locator;
151  key.forkno = forkno;
152  key.blkno = blkno;
153  hentry = (xl_invalid_page *)
155 
156  if (!found)
157  {
158  /* hash_search already filled in the key */
159  hentry->present = present;
160  }
161  else
162  {
163  /* repeat reference ... leave "present" as it was */
164  }
165 }
HTAB * hash_create(const char *tabname, long nelem, const HASHCTL *info, int flags)
Definition: dynahash.c:350
#define WARNING
Definition: elog.h:36
#define PANIC
Definition: elog.h:42
#define DEBUG1
Definition: elog.h:30
@ HASH_ENTER
Definition: hsearch.h:114
#define HASH_ELEM
Definition: hsearch.h:95
#define HASH_BLOBS
Definition: hsearch.h:97
Size keysize
Definition: hsearch.h:75
Size entrysize
Definition: hsearch.h:76
bool reachedConsistency
Definition: xlogrecovery.c:294
bool ignore_invalid_pages
Definition: xlogutils.c:37
static void report_invalid_page(int elevel, RelFileLocator locator, ForkNumber forkno, BlockNumber blkno, bool present)
Definition: xlogutils.c:89
struct xl_invalid_page xl_invalid_page
struct xl_invalid_page_key xl_invalid_page_key

References DEBUG1, elog(), HASHCTL::entrysize, HASH_BLOBS, hash_create(), HASH_ELEM, HASH_ENTER, hash_search(), ignore_invalid_pages, invalid_page_tab, sort-test::key, HASHCTL::keysize, message_level_is_interesting(), PANIC, xl_invalid_page::present, reachedConsistency, report_invalid_page(), and WARNING.

Referenced by XLogReadBufferExtended().

◆ read_local_xlog_page()

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

Definition at line 863 of file xlogutils.c.

865 {
866  return read_local_xlog_page_guts(state, targetPagePtr, reqLen,
867  targetRecPtr, cur_page, true);
868 }
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:887

References read_local_xlog_page_guts().

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

◆ read_local_xlog_page_guts()

static int read_local_xlog_page_guts ( XLogReaderState state,
XLogRecPtr  targetPagePtr,
int  reqLen,
XLogRecPtr  targetRecPtr,
char *  cur_page,
bool  wait_for_wal 
)
static

Definition at line 887 of file xlogutils.c.

890 {
891  XLogRecPtr read_upto,
892  loc;
893  TimeLineID tli;
894  int count;
895  WALReadError errinfo;
896  TimeLineID currTLI;
897 
898  loc = targetPagePtr + reqLen;
899 
900  /* Loop waiting for xlog to be available if necessary */
901  while (1)
902  {
903  /*
904  * Determine the limit of xlog we can currently read to, and what the
905  * most recent timeline is.
906  */
907  if (!RecoveryInProgress())
908  read_upto = GetFlushRecPtr(&currTLI);
909  else
910  read_upto = GetXLogReplayRecPtr(&currTLI);
911  tli = currTLI;
912 
913  /*
914  * Check which timeline to get the record from.
915  *
916  * We have to do it each time through the loop because if we're in
917  * recovery as a cascading standby, the current timeline might've
918  * become historical. We can't rely on RecoveryInProgress() because in
919  * a standby configuration like
920  *
921  * A => B => C
922  *
923  * if we're a logical decoding session on C, and B gets promoted, our
924  * timeline will change while we remain in recovery.
925  *
926  * We can't just keep reading from the old timeline as the last WAL
927  * archive in the timeline will get renamed to .partial by
928  * StartupXLOG().
929  *
930  * If that happens after our caller determined the TLI but before we
931  * actually read the xlog page, we might still try to read from the
932  * old (now renamed) segment and fail. There's not much we can do
933  * about this, but it can only happen when we're a leaf of a cascading
934  * standby whose primary gets promoted while we're decoding, so a
935  * one-off ERROR isn't too bad.
936  */
937  XLogReadDetermineTimeline(state, targetPagePtr, reqLen, tli);
938 
939  if (state->currTLI == currTLI)
940  {
941 
942  if (loc <= read_upto)
943  break;
944 
945  /* If asked, let's not wait for future WAL. */
946  if (!wait_for_wal)
947  {
948  ReadLocalXLogPageNoWaitPrivate *private_data;
949 
950  /*
951  * Inform the caller of read_local_xlog_page_no_wait that the
952  * end of WAL has been reached.
953  */
954  private_data = (ReadLocalXLogPageNoWaitPrivate *)
955  state->private_data;
956  private_data->end_of_wal = true;
957  break;
958  }
959 
961  pg_usleep(1000L);
962  }
963  else
964  {
965  /*
966  * We're on a historical timeline, so limit reading to the switch
967  * point where we moved to the next timeline.
968  *
969  * We don't need to GetFlushRecPtr or GetXLogReplayRecPtr. We know
970  * about the new timeline, so we must've received past the end of
971  * it.
972  */
973  read_upto = state->currTLIValidUntil;
974 
975  /*
976  * Setting tli to our wanted record's TLI is slightly wrong; the
977  * page might begin on an older timeline if it contains a timeline
978  * switch, since its xlog segment will have been copied from the
979  * prior timeline. This is pretty harmless though, as nothing
980  * cares so long as the timeline doesn't go backwards. We should
981  * read the page header instead; FIXME someday.
982  */
983  tli = state->currTLI;
984 
985  /* No need to wait on a historical timeline */
986  break;
987  }
988  }
989 
990  if (targetPagePtr + XLOG_BLCKSZ <= read_upto)
991  {
992  /*
993  * more than one block available; read only that block, have caller
994  * come back if they need more.
995  */
996  count = XLOG_BLCKSZ;
997  }
998  else if (targetPagePtr + reqLen > read_upto)
999  {
1000  /* not enough data there */
1001  return -1;
1002  }
1003  else
1004  {
1005  /* enough bytes available to satisfy the request */
1006  count = read_upto - targetPagePtr;
1007  }
1008 
1009  /*
1010  * Even though we just determined how much of the page can be validly read
1011  * as 'count', read the whole page anyway. It's guaranteed to be
1012  * zero-padded up to the page boundary if it's incomplete.
1013  */
1014  if (!WALRead(state, cur_page, targetPagePtr, XLOG_BLCKSZ, tli,
1015  &errinfo))
1016  WALReadRaiseError(&errinfo);
1017 
1018  /* number of valid bytes in the buffer */
1019  return count;
1020 }
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:121
void pg_usleep(long microsec)
Definition: signal.c:53
bool RecoveryInProgress(void)
Definition: xlog.c:5921
XLogRecPtr GetFlushRecPtr(TimeLineID *insertTLI)
Definition: xlog.c:6086
uint64 XLogRecPtr
Definition: xlogdefs.h:21
uint32 TimeLineID
Definition: xlogdefs.h:59
bool WALRead(XLogReaderState *state, char *buf, XLogRecPtr startptr, Size count, TimeLineID tli, WALReadError *errinfo)
Definition: xlogreader.c:1493
XLogRecPtr GetXLogReplayRecPtr(TimeLineID *replayTLI)
void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength, TimeLineID currTLI)
Definition: xlogutils.c:720
void WALReadRaiseError(WALReadError *errinfo)
Definition: xlogutils.c:1027

References CHECK_FOR_INTERRUPTS, ReadLocalXLogPageNoWaitPrivate::end_of_wal, GetFlushRecPtr(), GetXLogReplayRecPtr(), pg_usleep(), RecoveryInProgress(), WALRead(), WALReadRaiseError(), and XLogReadDetermineTimeline().

Referenced by read_local_xlog_page(), and read_local_xlog_page_no_wait().

◆ 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 875 of file xlogutils.c.

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

References read_local_xlog_page_guts().

Referenced by InitXLogReaderState().

◆ report_invalid_page()

static void report_invalid_page ( int  elevel,
RelFileLocator  locator,
ForkNumber  forkno,
BlockNumber  blkno,
bool  present 
)
static

Definition at line 89 of file xlogutils.c.

91 {
92  char *path = relpathperm(locator, forkno);
93 
94  if (present)
95  elog(elevel, "page %u of relation %s is uninitialized",
96  blkno, path);
97  else
98  elog(elevel, "page %u of relation %s does not exist",
99  blkno, path);
100  pfree(path);
101 }

References elog(), pfree(), and relpathperm.

Referenced by log_invalid_page(), and XLogCheckInvalidPages().

◆ 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 819 of file xlogutils.c.

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

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

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

◆ WALReadRaiseError()

void WALReadRaiseError ( WALReadError errinfo)

Definition at line 1027 of file xlogutils.c.

1028 {
1029  WALOpenSegment *seg = &errinfo->wre_seg;
1030  char fname[MAXFNAMELEN];
1031 
1032  XLogFileName(fname, seg->ws_tli, seg->ws_segno, wal_segment_size);
1033 
1034  if (errinfo->wre_read < 0)
1035  {
1036  errno = errinfo->wre_errno;
1037  ereport(ERROR,
1039  errmsg("could not read from WAL segment %s, offset %d: %m",
1040  fname, errinfo->wre_off)));
1041  }
1042  else if (errinfo->wre_read == 0)
1043  {
1044  ereport(ERROR,
1046  errmsg("could not read from WAL segment %s, offset %d: read %d of %d",
1047  fname, errinfo->wre_off, errinfo->wre_read,
1048  errinfo->wre_req)));
1049  }
1050 }
int errcode(int sqlerrcode)
Definition: elog.c:858
#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:146
#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(), and XLogSendPhysical().

◆ XLogCheckInvalidPages()

void XLogCheckInvalidPages ( void  )

Definition at line 248 of file xlogutils.c.

249 {
250  HASH_SEQ_STATUS status;
251  xl_invalid_page *hentry;
252  bool foundone = false;
253 
254  if (invalid_page_tab == NULL)
255  return; /* nothing to do */
256 
258 
259  /*
260  * Our strategy is to emit WARNING messages for all remaining entries and
261  * only PANIC after we've dumped all the available info.
262  */
263  while ((hentry = (xl_invalid_page *) hash_seq_search(&status)) != NULL)
264  {
265  report_invalid_page(WARNING, hentry->key.locator, hentry->key.forkno,
266  hentry->key.blkno, hentry->present);
267  foundone = true;
268  }
269 
270  if (foundone)
272  "WAL contains references to invalid pages");
273 
275  invalid_page_tab = NULL;
276 }
void hash_destroy(HTAB *hashp)
Definition: dynahash.c:863

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 654 of file xlogutils.c.

655 {
656  /*
657  * This is unnecessarily heavy-handed, as it will close SMgrRelation
658  * objects for other databases as well. DROP DATABASE occurs seldom enough
659  * that it's not worth introducing a variant of smgrclose for just this
660  * purpose. XXX: Or should we rather leave the smgr entries dangling?
661  */
662  smgrcloseall();
663 
665 }
void smgrcloseall(void)
Definition: smgr.c:326
static void forget_invalid_pages_db(Oid dbid)
Definition: xlogutils.c:205

References forget_invalid_pages_db(), and smgrcloseall().

Referenced by dbase_redo().

◆ XLogDropRelation()

void XLogDropRelation ( RelFileLocator  rlocator,
ForkNumber  forknum 
)

Definition at line 643 of file xlogutils.c.

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

References forget_invalid_pages().

Referenced by DropRelationFiles().

◆ XLogHaveInvalidPages()

bool XLogHaveInvalidPages ( void  )

Definition at line 238 of file xlogutils.c.

239 {
240  if (invalid_page_tab != NULL &&
242  return true;
243  return false;
244 }
long hash_get_num_entries(HTAB *hashp)
Definition: dynahash.c:1377

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 474 of file xlogutils.c.

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

References Assert(), BufferGetPage(), BufferIsValid(), EB_PERFORMING_RECOVERY, EB_SKIP_EXTENSION_LOCK, EB_SMGR, ExtendBufferedRelTo(), InRecovery, InvalidBackendId, 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 317 of file xlogutils.c.

319 {
320  return XLogReadBufferForRedoExtended(record, block_id, RBM_NORMAL,
321  false, buf);
322 }

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

◆ XLogReadBufferForRedoExtended()

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

Definition at line 354 of file xlogutils.c.

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

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(), heap_xlog_vacuum(), heap_xlog_visible(), XLogInitBufferForRedo(), and XLogReadBufferForRedo().

◆ XLogReadDetermineTimeline()

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

Definition at line 720 of file xlogutils.c.

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

675 {
676  forget_invalid_pages(rlocator, forkNum, nblocks);
677 }

References forget_invalid_pages().

Referenced by smgr_redo().

Variable Documentation

◆ ignore_invalid_pages

bool ignore_invalid_pages = false

Definition at line 37 of file xlogutils.c.

Referenced by log_invalid_page(), and XLogCheckInvalidPages().

◆ InRecovery

◆ invalid_page_tab

HTAB* invalid_page_tab = NULL
static

◆ standbyState