PostgreSQL Source Code git master
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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/xlogutils.h"
#include "miscadmin.h"
#include "storage/fd.h"
#include "storage/smgr.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 554 of file xlogutils.c.

◆ xl_invalid_page

◆ xl_invalid_page_key

Function Documentation

◆ CreateFakeRelcacheEntry()

Relation CreateFakeRelcacheEntry ( RelFileLocator  rlocator)

Definition at line 571 of file xlogutils.c.

572{
573 FakeRelCacheEntry fakeentry;
574 Relation rel;
575
576 /* Allocate the Relation struct and all related space in one block. */
577 fakeentry = palloc0(sizeof(FakeRelCacheEntryData));
578 rel = (Relation) fakeentry;
579
580 rel->rd_rel = &fakeentry->pgc;
581 rel->rd_locator = rlocator;
582
583 /*
584 * We will never be working with temp rels during recovery or while
585 * syncing WAL-skipped files.
586 */
588
589 /* It must be a permanent table here */
590 rel->rd_rel->relpersistence = RELPERSISTENCE_PERMANENT;
591
592 /* We don't know the name of the relation; use relfilenumber instead */
593 sprintf(RelationGetRelationName(rel), "%u", rlocator.relNumber);
594
595 /*
596 * We set up the lockRelId in case anything tries to lock the dummy
597 * relation. Note that this is fairly bogus since relNumber may be
598 * different from the relation's OID. It shouldn't really matter though.
599 * In recovery, we are running by ourselves and can't have any lock
600 * conflicts. While syncing, we already hold AccessExclusiveLock.
601 */
602 rel->rd_lockInfo.lockRelId.dbId = rlocator.dbOid;
603 rel->rd_lockInfo.lockRelId.relId = rlocator.relNumber;
604
605 /*
606 * Set up a non-pinned SMgrRelation reference, so that we don't need to
607 * worry about unpinning it on error.
608 */
609 rel->rd_smgr = smgropen(rlocator, INVALID_PROC_NUMBER);
610
611 return rel;
612}
void * palloc0(Size size)
Definition: mcxt.c:1970
#define sprintf
Definition: port.h:241
#define INVALID_PROC_NUMBER
Definition: procnumber.h:26
#define RelationGetRelationName(relation)
Definition: rel.h:550
struct RelationData * Relation
Definition: relcache.h:27
SMgrRelation smgropen(RelFileLocator rlocator, ProcNumber backend)
Definition: smgr.c:240
FormData_pg_class pgc
Definition: xlogutils.c:551
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().

◆ forget_invalid_pages()

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

Definition at line 165 of file xlogutils.c.

167{
168 HASH_SEQ_STATUS status;
169 xl_invalid_page *hentry;
170
171 if (invalid_page_tab == NULL)
172 return; /* nothing to do */
173
175
176 while ((hentry = (xl_invalid_page *) hash_seq_search(&status)) != NULL)
177 {
178 if (RelFileLocatorEquals(hentry->key.locator, locator) &&
179 hentry->key.forkno == forkno &&
180 hentry->key.blkno >= minblkno)
181 {
182 elog(DEBUG2, "page %u of relation %s has been dropped",
183 hentry->key.blkno,
184 relpathperm(hentry->key.locator, forkno).str);
185
187 &hentry->key,
188 HASH_REMOVE, NULL) == NULL)
189 elog(ERROR, "hash table corrupted");
190 }
191 }
192}
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition: dynahash.c:955
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition: dynahash.c:1420
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition: dynahash.c:1385
#define DEBUG2
Definition: elog.h:29
#define ERROR
Definition: elog.h:39
#define elog(elevel,...)
Definition: elog.h:226
@ HASH_REMOVE
Definition: hsearch.h:115
#define RelFileLocatorEquals(locator1, locator2)
#define relpathperm(rlocator, forknum)
Definition: relpath.h:146
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
static HTAB * invalid_page_tab
Definition: xlogutils.c:78

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, RelFileLocatorEquals, and relpathperm.

Referenced by XLogDropRelation(), and XLogTruncateRelation().

◆ forget_invalid_pages_db()

static void forget_invalid_pages_db ( Oid  dbid)
static

Definition at line 196 of file xlogutils.c.

197{
198 HASH_SEQ_STATUS status;
199 xl_invalid_page *hentry;
200
201 if (invalid_page_tab == NULL)
202 return; /* nothing to do */
203
205
206 while ((hentry = (xl_invalid_page *) hash_seq_search(&status)) != NULL)
207 {
208 if (hentry->key.locator.dbOid == dbid)
209 {
210 elog(DEBUG2, "page %u of relation %s has been dropped",
211 hentry->key.blkno,
212 relpathperm(hentry->key.locator, hentry->key.forkno).str);
213
215 &hentry->key,
216 HASH_REMOVE, NULL) == NULL)
217 elog(ERROR, "hash table corrupted");
218 }
219 }
220}

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, and relpathperm.

Referenced by XLogDropDatabase().

◆ FreeFakeRelcacheEntry()

void FreeFakeRelcacheEntry ( Relation  fakerel)

Definition at line 618 of file xlogutils.c.

619{
620 pfree(fakerel);
621}
void pfree(void *pointer)
Definition: mcxt.c:2147

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

◆ log_invalid_page()

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

Definition at line 101 of file xlogutils.c.

103{
105 xl_invalid_page *hentry;
106 bool found;
107
108 /*
109 * Once recovery has reached a consistent state, the invalid-page table
110 * should be empty and remain so. If a reference to an invalid page is
111 * found after consistency is reached, PANIC immediately. This might seem
112 * aggressive, but it's better than letting the invalid reference linger
113 * in the hash table until the end of recovery and PANIC there, which
114 * might come only much later if this is a standby server.
115 */
117 {
118 report_invalid_page(WARNING, locator, forkno, blkno, present);
120 "WAL contains references to invalid pages");
121 }
122
123 /*
124 * Log references to invalid pages at DEBUG1 level. This allows some
125 * tracing of the cause (note the elog context mechanism will tell us
126 * something about the XLOG record that generated the reference).
127 */
129 report_invalid_page(DEBUG1, locator, forkno, blkno, present);
130
131 if (invalid_page_tab == NULL)
132 {
133 /* create hash table when first needed */
134 HASHCTL ctl;
135
136 ctl.keysize = sizeof(xl_invalid_page_key);
137 ctl.entrysize = sizeof(xl_invalid_page);
138
139 invalid_page_tab = hash_create("XLOG invalid-page table",
140 100,
141 &ctl,
143 }
144
145 /* we currently assume xl_invalid_page_key contains no padding */
146 key.locator = locator;
147 key.forkno = forkno;
148 key.blkno = blkno;
149 hentry = (xl_invalid_page *)
151
152 if (!found)
153 {
154 /* hash_search already filled in the key */
155 hentry->present = present;
156 }
157 else
158 {
159 /* repeat reference ... leave "present" as it was */
160 }
161}
HTAB * hash_create(const char *tabname, long nelem, const HASHCTL *info, int flags)
Definition: dynahash.c:352
bool message_level_is_interesting(int elevel)
Definition: elog.c:273
#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
tree ctl
Definition: radixtree.h:1838
bool reachedConsistency
Definition: xlogrecovery.c:300
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
struct xl_invalid_page xl_invalid_page
struct xl_invalid_page_key xl_invalid_page_key

References ctl, DEBUG1, elog, HASH_BLOBS, hash_create(), HASH_ELEM, HASH_ENTER, hash_search(), ignore_invalid_pages, invalid_page_tab, sort-test::key, 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 845 of file xlogutils.c.

847{
848 return read_local_xlog_page_guts(state, targetPagePtr, reqLen,
849 targetRecPtr, cur_page, true);
850}
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:869

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

872{
873 XLogRecPtr read_upto,
874 loc;
875 TimeLineID tli;
876 int count;
877 WALReadError errinfo;
878 TimeLineID currTLI;
879
880 loc = targetPagePtr + reqLen;
881
882 /*
883 * Loop waiting for xlog to be available if necessary
884 *
885 * TODO: The walsender has its own version of this function, which uses a
886 * condition variable to wake up whenever WAL is flushed. We could use the
887 * same infrastructure here, instead of the check/sleep/repeat style of
888 * loop.
889 */
890 while (1)
891 {
892 /*
893 * Determine the limit of xlog we can currently read to, and what the
894 * most recent timeline is.
895 */
896 if (!RecoveryInProgress())
897 read_upto = GetFlushRecPtr(&currTLI);
898 else
899 read_upto = GetXLogReplayRecPtr(&currTLI);
900 tli = currTLI;
901
902 /*
903 * Check which timeline to get the record from.
904 *
905 * We have to do it each time through the loop because if we're in
906 * recovery as a cascading standby, the current timeline might've
907 * become historical. We can't rely on RecoveryInProgress() because in
908 * a standby configuration like
909 *
910 * A => B => C
911 *
912 * if we're a logical decoding session on C, and B gets promoted, our
913 * timeline will change while we remain in recovery.
914 *
915 * We can't just keep reading from the old timeline as the last WAL
916 * archive in the timeline will get renamed to .partial by
917 * StartupXLOG().
918 *
919 * If that happens after our caller determined the TLI but before we
920 * actually read the xlog page, we might still try to read from the
921 * old (now renamed) segment and fail. There's not much we can do
922 * about this, but it can only happen when we're a leaf of a cascading
923 * standby whose primary gets promoted while we're decoding, so a
924 * one-off ERROR isn't too bad.
925 */
926 XLogReadDetermineTimeline(state, targetPagePtr, reqLen, tli);
927
928 if (state->currTLI == currTLI)
929 {
930
931 if (loc <= read_upto)
932 break;
933
934 /* If asked, let's not wait for future WAL. */
935 if (!wait_for_wal)
936 {
937 ReadLocalXLogPageNoWaitPrivate *private_data;
938
939 /*
940 * Inform the caller of read_local_xlog_page_no_wait that the
941 * end of WAL has been reached.
942 */
943 private_data = (ReadLocalXLogPageNoWaitPrivate *)
944 state->private_data;
945 private_data->end_of_wal = true;
946 break;
947 }
948
950 pg_usleep(1000L);
951 }
952 else
953 {
954 /*
955 * We're on a historical timeline, so limit reading to the switch
956 * point where we moved to the next timeline.
957 *
958 * We don't need to GetFlushRecPtr or GetXLogReplayRecPtr. We know
959 * about the new timeline, so we must've received past the end of
960 * it.
961 */
962 read_upto = state->currTLIValidUntil;
963
964 /*
965 * Setting tli to our wanted record's TLI is slightly wrong; the
966 * page might begin on an older timeline if it contains a timeline
967 * switch, since its xlog segment will have been copied from the
968 * prior timeline. This is pretty harmless though, as nothing
969 * cares so long as the timeline doesn't go backwards. We should
970 * read the page header instead; FIXME someday.
971 */
972 tli = state->currTLI;
973
974 /* No need to wait on a historical timeline */
975 break;
976 }
977 }
978
979 if (targetPagePtr + XLOG_BLCKSZ <= read_upto)
980 {
981 /*
982 * more than one block available; read only that block, have caller
983 * come back if they need more.
984 */
985 count = XLOG_BLCKSZ;
986 }
987 else if (targetPagePtr + reqLen > read_upto)
988 {
989 /* not enough data there */
990 return -1;
991 }
992 else
993 {
994 /* enough bytes available to satisfy the request */
995 count = read_upto - targetPagePtr;
996 }
997
998 if (!WALRead(state, cur_page, targetPagePtr, count, tli,
999 &errinfo))
1000 WALReadRaiseError(&errinfo);
1001
1002 /* number of valid bytes in the buffer */
1003 return count;
1004}
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:123
void pg_usleep(long microsec)
Definition: signal.c:53
bool RecoveryInProgress(void)
Definition: xlog.c:6522
XLogRecPtr GetFlushRecPtr(TimeLineID *insertTLI)
Definition: xlog.c:6687
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:1504
XLogRecPtr GetXLogReplayRecPtr(TimeLineID *replayTLI)
void XLogReadDetermineTimeline(XLogReaderState *state, XLogRecPtr wantPage, uint32 wantLength, TimeLineID currTLI)
Definition: xlogutils.c:707
void WALReadRaiseError(WALReadError *errinfo)
Definition: xlogutils.c:1011

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

860{
861 return read_local_xlog_page_guts(state, targetPagePtr, reqLen,
862 targetRecPtr, cur_page, false);
863}

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

88{
89 RelPathStr path = relpathperm(locator, forkno);
90
91 if (present)
92 elog(elevel, "page %u of relation %s is uninitialized",
93 blkno, path.str);
94 else
95 elog(elevel, "page %u of relation %s does not exist",
96 blkno, path.str);
97}
char str[REL_PATH_STR_MAXLEN+1]
Definition: relpath.h:123

References elog, relpathperm, and RelPathStr::str.

Referenced by log_invalid_page(), and XLogCheckInvalidPages().

◆ wal_segment_close()

◆ wal_segment_open()

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

Definition at line 806 of file xlogutils.c.

808{
809 TimeLineID tli = *tli_p;
810 char path[MAXPGPATH];
811
812 XLogFilePath(path, tli, nextSegNo, state->segcxt.ws_segsize);
813 state->seg.ws_file = BasicOpenFile(path, O_RDONLY | PG_BINARY);
814 if (state->seg.ws_file >= 0)
815 return;
816
817 if (errno == ENOENT)
820 errmsg("requested WAL segment %s has already been removed",
821 path)));
822 else
825 errmsg("could not open file \"%s\": %m",
826 path)));
827}
#define PG_BINARY
Definition: c.h:1244
int errcode_for_file_access(void)
Definition: elog.c:877
int errmsg(const char *fmt,...)
Definition: elog.c:1071
#define ereport(elevel,...)
Definition: elog.h:149
int BasicOpenFile(const char *fileName, int fileFlags)
Definition: fd.c:1089
#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(), LogicalReplicationSlotHasPendingWal(), LogicalSlotAdvanceAndCheckSnapState(), pg_logical_slot_get_changes_guts(), SummarizeWAL(), and XlogReadTwoPhaseData().

◆ WALReadRaiseError()

void WALReadRaiseError ( WALReadError errinfo)

Definition at line 1011 of file xlogutils.c.

1012{
1013 WALOpenSegment *seg = &errinfo->wre_seg;
1014 char fname[MAXFNAMELEN];
1015
1016 XLogFileName(fname, seg->ws_tli, seg->ws_segno, wal_segment_size);
1017
1018 if (errinfo->wre_read < 0)
1019 {
1020 errno = errinfo->wre_errno;
1021 ereport(ERROR,
1023 errmsg("could not read from WAL segment %s, offset %d: %m",
1024 fname, errinfo->wre_off)));
1025 }
1026 else if (errinfo->wre_read == 0)
1027 {
1028 ereport(ERROR,
1030 errmsg("could not read from WAL segment %s, offset %d: read %d of %d",
1031 fname, errinfo->wre_off, errinfo->wre_read,
1032 errinfo->wre_req)));
1033 }
1034}
int errcode(int sqlerrcode)
Definition: elog.c:854
#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 234 of file xlogutils.c.

235{
236 HASH_SEQ_STATUS status;
237 xl_invalid_page *hentry;
238 bool foundone = false;
239
240 if (invalid_page_tab == NULL)
241 return; /* nothing to do */
242
244
245 /*
246 * Our strategy is to emit WARNING messages for all remaining entries and
247 * only PANIC after we've dumped all the available info.
248 */
249 while ((hentry = (xl_invalid_page *) hash_seq_search(&status)) != NULL)
250 {
252 hentry->key.blkno, hentry->present);
253 foundone = true;
254 }
255
256 if (foundone)
258 "WAL contains references to invalid pages");
259
261 invalid_page_tab = NULL;
262}
void hash_destroy(HTAB *hashp)
Definition: dynahash.c:865

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

642{
643 /*
644 * This is unnecessarily heavy-handed, as it will close SMgrRelation
645 * objects for other databases as well. DROP DATABASE occurs seldom enough
646 * that it's not worth introducing a variant of smgrdestroy for just this
647 * purpose.
648 */
650
652}
void smgrdestroyall(void)
Definition: smgr.c:386
static void forget_invalid_pages_db(Oid dbid)
Definition: xlogutils.c:196

References forget_invalid_pages_db(), and smgrdestroyall().

Referenced by dbase_redo().

◆ XLogDropRelation()

void XLogDropRelation ( RelFileLocator  rlocator,
ForkNumber  forknum 
)

Definition at line 630 of file xlogutils.c.

631{
632 forget_invalid_pages(rlocator, forknum, 0);
633}
static void forget_invalid_pages(RelFileLocator locator, ForkNumber forkno, BlockNumber minblkno)
Definition: xlogutils.c:165

References forget_invalid_pages().

Referenced by DropRelationFiles().

◆ XLogHaveInvalidPages()

bool XLogHaveInvalidPages ( void  )

Definition at line 224 of file xlogutils.c.

225{
226 if (invalid_page_tab != NULL &&
228 return true;
229 return false;
230}
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 460 of file xlogutils.c.

463{
464 BlockNumber lastblock;
465 Buffer buffer;
466 SMgrRelation smgr;
467
468 Assert(blkno != P_NEW);
469
470 /* Do we have a clue where the buffer might be already? */
471 if (BufferIsValid(recent_buffer) &&
472 mode == RBM_NORMAL &&
473 ReadRecentBuffer(rlocator, forknum, blkno, recent_buffer))
474 {
475 buffer = recent_buffer;
476 goto recent_buffer_fast_path;
477 }
478
479 /* Open the relation at smgr level */
480 smgr = smgropen(rlocator, INVALID_PROC_NUMBER);
481
482 /*
483 * Create the target file if it doesn't already exist. This lets us cope
484 * if the replay sequence contains writes to a relation that is later
485 * deleted. (The original coding of this routine would instead suppress
486 * the writes, but that seems like it risks losing valuable data if the
487 * filesystem loses an inode during a crash. Better to write the data
488 * until we are actually told to delete the file.)
489 */
490 smgrcreate(smgr, forknum, true);
491
492 lastblock = smgrnblocks(smgr, forknum);
493
494 if (blkno < lastblock)
495 {
496 /* page exists in file */
497 buffer = ReadBufferWithoutRelcache(rlocator, forknum, blkno,
498 mode, NULL, true);
499 }
500 else
501 {
502 /* hm, page doesn't exist in file */
503 if (mode == RBM_NORMAL)
504 {
505 log_invalid_page(rlocator, forknum, blkno, false);
506 return InvalidBuffer;
507 }
508 if (mode == RBM_NORMAL_NO_LOG)
509 return InvalidBuffer;
510 /* OK to extend the file */
511 /* we do this in recovery only - no rel-extension lock needed */
513 buffer = ExtendBufferedRelTo(BMR_SMGR(smgr, RELPERSISTENCE_PERMANENT),
514 forknum,
515 NULL,
518 blkno + 1,
519 mode);
520 }
521
522recent_buffer_fast_path:
523 if (mode == RBM_NORMAL)
524 {
525 /* check that page has been initialized */
526 Page page = (Page) BufferGetPage(buffer);
527
528 /*
529 * We assume that PageIsNew is safe without a lock. During recovery,
530 * there should be no other backends that could modify the buffer at
531 * the same time.
532 */
533 if (PageIsNew(page))
534 {
535 ReleaseBuffer(buffer);
536 log_invalid_page(rlocator, forknum, blkno, true);
537 return InvalidBuffer;
538 }
539 }
540
541 return buffer;
542}
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:915
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:5303
Buffer ReadBufferWithoutRelcache(RelFileLocator rlocator, ForkNumber forkNum, BlockNumber blockNum, ReadBufferMode mode, BufferAccessStrategy strategy, bool permanent)
Definition: bufmgr.c:835
bool ReadRecentBuffer(RelFileLocator rlocator, ForkNumber forkNum, BlockNumber blockNum, Buffer recent_buffer)
Definition: bufmgr.c:675
#define P_NEW
Definition: bufmgr.h:191
static Page BufferGetPage(Buffer buffer)
Definition: bufmgr.h:414
#define BMR_SMGR(p_smgr, p_relpersistence)
Definition: bufmgr.h:109
@ EB_PERFORMING_RECOVERY
Definition: bufmgr.h:78
@ EB_SKIP_EXTENSION_LOCK
Definition: bufmgr.h:75
@ RBM_NORMAL
Definition: bufmgr.h:46
@ RBM_NORMAL_NO_LOG
Definition: bufmgr.h:52
static bool BufferIsValid(Buffer bufnum)
Definition: bufmgr.h:365
static bool PageIsNew(const PageData *page)
Definition: bufpage.h:234
PageData * Page
Definition: bufpage.h:82
Assert(PointerIsAligned(start, uint64))
static PgChecksumMode mode
Definition: pg_checksums.c:55
BlockNumber smgrnblocks(SMgrRelation reln, ForkNumber forknum)
Definition: smgr.c:819
void smgrcreate(SMgrRelation reln, ForkNumber forknum, bool isRedo)
Definition: smgr.c:481
bool InRecovery
Definition: xlogutils.c:50
static void log_invalid_page(RelFileLocator locator, ForkNumber forkno, BlockNumber blkno, bool present)
Definition: xlogutils.c:101

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

305{
306 return XLogReadBufferForRedoExtended(record, block_id, RBM_NORMAL,
307 false, buf);
308}

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

344{
345 XLogRecPtr lsn = record->EndRecPtr;
346 RelFileLocator rlocator;
347 ForkNumber forknum;
348 BlockNumber blkno;
349 Buffer prefetch_buffer;
350 Page page;
351 bool zeromode;
352 bool willinit;
353
354 if (!XLogRecGetBlockTagExtended(record, block_id, &rlocator, &forknum, &blkno,
355 &prefetch_buffer))
356 {
357 /* Caller specified a bogus block_id */
358 elog(PANIC, "failed to locate backup block with ID %d in WAL record",
359 block_id);
360 }
361
362 /*
363 * Make sure that if the block is marked with WILL_INIT, the caller is
364 * going to initialize it. And vice versa.
365 */
367 willinit = (XLogRecGetBlock(record, block_id)->flags & BKPBLOCK_WILL_INIT) != 0;
368 if (willinit && !zeromode)
369 elog(PANIC, "block with WILL_INIT flag in WAL record must be zeroed by redo routine");
370 if (!willinit && zeromode)
371 elog(PANIC, "block to be initialized in redo routine must be marked with WILL_INIT flag in the WAL record");
372
373 /* If it has a full-page image and it should be restored, do it. */
374 if (XLogRecBlockImageApply(record, block_id))
375 {
376 Assert(XLogRecHasBlockImage(record, block_id));
377 *buf = XLogReadBufferExtended(rlocator, forknum, blkno,
378 get_cleanup_lock ? RBM_ZERO_AND_CLEANUP_LOCK : RBM_ZERO_AND_LOCK,
379 prefetch_buffer);
380 page = BufferGetPage(*buf);
381 if (!RestoreBlockImage(record, block_id, page))
383 (errcode(ERRCODE_INTERNAL_ERROR),
384 errmsg_internal("%s", record->errormsg_buf)));
385
386 /*
387 * The page may be uninitialized. If so, we can't set the LSN because
388 * that would corrupt the page.
389 */
390 if (!PageIsNew(page))
391 {
392 PageSetLSN(page, lsn);
393 }
394
396
397 /*
398 * At the end of crash recovery the init forks of unlogged relations
399 * are copied, without going through shared buffers. So we need to
400 * force the on-disk state of init forks to always be in sync with the
401 * state in shared buffers.
402 */
403 if (forknum == INIT_FORKNUM)
405
406 return BLK_RESTORED;
407 }
408 else
409 {
410 *buf = XLogReadBufferExtended(rlocator, forknum, blkno, mode, prefetch_buffer);
411 if (BufferIsValid(*buf))
412 {
414 {
415 if (get_cleanup_lock)
417 else
419 }
420 if (lsn <= PageGetLSN(BufferGetPage(*buf)))
421 return BLK_DONE;
422 else
423 return BLK_NEEDS_REDO;
424 }
425 else
426 return BLK_NOTFOUND;
427 }
428}
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:2945
void LockBufferForCleanup(Buffer buffer)
Definition: bufmgr.c:5617
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:5537
void FlushOneBuffer(Buffer buffer)
Definition: bufmgr.c:5283
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:198
@ RBM_ZERO_AND_CLEANUP_LOCK
Definition: bufmgr.h:49
static void PageSetLSN(Page page, XLogRecPtr lsn)
Definition: bufpage.h:391
static XLogRecPtr PageGetLSN(const PageData *page)
Definition: bufpage.h:386
int errmsg_internal(const char *fmt,...)
Definition: elog.c:1158
ForkNumber
Definition: relpath.h:56
@ INIT_FORKNUM
Definition: relpath.h:61
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:2007
bool RestoreBlockImage(XLogReaderState *record, uint8 block_id, char *page)
Definition: xlogreader.c:2066
#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:460
@ BLK_RESTORED
Definition: xlogutils.h:76
@ BLK_NEEDS_REDO
Definition: xlogutils.h:74
@ BLK_DONE
Definition: xlogutils.h:75
@ BLK_NOTFOUND
Definition: xlogutils.h:77

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

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

662{
663 forget_invalid_pages(rlocator, forkNum, nblocks);
664}

References forget_invalid_pages().

Referenced by smgr_redo().

Variable Documentation

◆ ignore_invalid_pages

bool ignore_invalid_pages = false

Definition at line 34 of file xlogutils.c.

Referenced by log_invalid_page(), and XLogCheckInvalidPages().

◆ InRecovery

◆ invalid_page_tab

HTAB* invalid_page_tab = NULL
static

◆ standbyState