PostgreSQL Source Code  git master
xlog.c File Reference
#include "postgres.h"
#include <ctype.h>
#include <math.h>
#include <time.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <unistd.h>
#include "access/clog.h"
#include "access/commit_ts.h"
#include "access/heaptoast.h"
#include "access/multixact.h"
#include "access/rewriteheap.h"
#include "access/subtrans.h"
#include "access/timeline.h"
#include "access/transam.h"
#include "access/twophase.h"
#include "access/xact.h"
#include "access/xlog_internal.h"
#include "access/xloginsert.h"
#include "access/xlogreader.h"
#include "access/xlogutils.h"
#include "catalog/catversion.h"
#include "catalog/pg_control.h"
#include "catalog/pg_database.h"
#include "commands/tablespace.h"
#include "common/controldata_utils.h"
#include "miscadmin.h"
#include "pg_trace.h"
#include "pgstat.h"
#include "port/atomics.h"
#include "postmaster/bgwriter.h"
#include "postmaster/startup.h"
#include "postmaster/walwriter.h"
#include "replication/basebackup.h"
#include "replication/logical.h"
#include "replication/origin.h"
#include "replication/slot.h"
#include "replication/snapbuild.h"
#include "replication/walreceiver.h"
#include "replication/walsender.h"
#include "storage/bufmgr.h"
#include "storage/fd.h"
#include "storage/ipc.h"
#include "storage/large_object.h"
#include "storage/latch.h"
#include "storage/pmsignal.h"
#include "storage/predicate.h"
#include "storage/proc.h"
#include "storage/procarray.h"
#include "storage/reinit.h"
#include "storage/smgr.h"
#include "storage/spin.h"
#include "storage/sync.h"
#include "utils/builtins.h"
#include "utils/guc.h"
#include "utils/memutils.h"
#include "utils/ps_status.h"
#include "utils/relmapper.h"
#include "utils/snapmgr.h"
#include "utils/timestamp.h"
Include dependency graph for xlog.c:

Go to the source code of this file.

Data Structures

struct  XLogwrtRqst
 
struct  XLogwrtResult
 
struct  WALInsertLock
 
union  WALInsertLockPadded
 
struct  XLogCtlInsert
 
struct  XLogCtlData
 
struct  XLogPageReadPrivate
 

Macros

#define RECOVERY_COMMAND_FILE   "recovery.conf"
 
#define RECOVERY_COMMAND_DONE   "recovery.done"
 
#define NUM_XLOGINSERT_LOCKS   8
 
#define INSERT_FREESPACE(endptr)   (((endptr) % XLOG_BLCKSZ == 0) ? 0 : (XLOG_BLCKSZ - (endptr) % XLOG_BLCKSZ))
 
#define NextBufIdx(idx)   (((idx) == XLogCtl->XLogCacheBlck) ? 0 : ((idx) + 1))
 
#define XLogRecPtrToBufIdx(recptr)   (((recptr) / XLOG_BLCKSZ) % (XLogCtl->XLogCacheBlck + 1))
 
#define UsableBytesInPage   (XLOG_BLCKSZ - SizeOfXLogShortPHD)
 
#define ConvertToXSegs(x, segsize)   (x / ((segsize) / (1024 * 1024)))
 
#define RecoveryRequiresIntParameter(param_name, currValue, minValue)
 

Typedefs

typedef struct XLogwrtRqst XLogwrtRqst
 
typedef struct XLogwrtResult XLogwrtResult
 
typedef union WALInsertLockPadded WALInsertLockPadded
 
typedef enum ExclusiveBackupState ExclusiveBackupState
 
typedef struct XLogCtlInsert XLogCtlInsert
 
typedef struct XLogCtlData XLogCtlData
 
typedef struct XLogPageReadPrivate XLogPageReadPrivate
 

Enumerations

enum  ExclusiveBackupState { EXCLUSIVE_BACKUP_NONE = 0, EXCLUSIVE_BACKUP_STARTING, EXCLUSIVE_BACKUP_IN_PROGRESS, EXCLUSIVE_BACKUP_STOPPING }
 
enum  XLogSource { XLOG_FROM_ANY = 0, XLOG_FROM_ARCHIVE, XLOG_FROM_PG_WAL, XLOG_FROM_STREAM }
 

Functions

static void readRecoverySignalFile (void)
 
static void validateRecoveryParameters (void)
 
static void exitArchiveRecovery (TimeLineID endTLI, XLogRecPtr endOfLog)
 
static bool recoveryStopsBefore (XLogReaderState *record)
 
static bool recoveryStopsAfter (XLogReaderState *record)
 
static void recoveryPausesHere (void)
 
static bool recoveryApplyDelay (XLogReaderState *record)
 
static void SetLatestXTime (TimestampTz xtime)
 
static void SetCurrentChunkStartTime (TimestampTz xtime)
 
static void CheckRequiredParameterValues (void)
 
static void XLogReportParameters (void)
 
static void checkTimeLineSwitch (XLogRecPtr lsn, TimeLineID newTLI, TimeLineID prevTLI)
 
static void LocalSetXLogInsertAllowed (void)
 
static void CreateEndOfRecoveryRecord (void)
 
static void CheckPointGuts (XLogRecPtr checkPointRedo, int flags)
 
static void KeepLogSeg (XLogRecPtr recptr, XLogSegNo *logSegNo)
 
static XLogRecPtr XLogGetReplicationSlotMinimumLSN (void)
 
static void AdvanceXLInsertBuffer (XLogRecPtr upto, bool opportunistic)
 
static bool XLogCheckpointNeeded (XLogSegNo new_segno)
 
static void XLogWrite (XLogwrtRqst WriteRqst, bool flexible)
 
static bool InstallXLogFileSegment (XLogSegNo *segno, char *tmppath, bool find_free, XLogSegNo max_segno, bool use_lock)
 
static int XLogFileRead (XLogSegNo segno, int emode, TimeLineID tli, int source, bool notfoundOk)
 
static int XLogFileReadAnyTLI (XLogSegNo segno, int emode, int source)
 
static int XLogPageRead (XLogReaderState *xlogreader, XLogRecPtr targetPagePtr, int reqLen, XLogRecPtr targetRecPtr, char *readBuf)
 
static bool WaitForWALToBecomeAvailable (XLogRecPtr RecPtr, bool randAccess, bool fetching_ckpt, XLogRecPtr tliRecPtr)
 
static int emode_for_corrupt_record (int emode, XLogRecPtr RecPtr)
 
static void XLogFileClose (void)
 
static void PreallocXlogFiles (XLogRecPtr endptr)
 
static void RemoveTempXlogFiles (void)
 
static void RemoveOldXlogFiles (XLogSegNo segno, XLogRecPtr RedoRecPtr, XLogRecPtr endptr)
 
static void RemoveXlogFile (const char *segname, XLogRecPtr RedoRecPtr, XLogRecPtr endptr)
 
static void UpdateLastRemovedPtr (char *filename)
 
static void ValidateXLOGDirectoryStructure (void)
 
static void CleanupBackupHistory (void)
 
static void UpdateMinRecoveryPoint (XLogRecPtr lsn, bool force)
 
static XLogRecordReadRecord (XLogReaderState *xlogreader, XLogRecPtr RecPtr, int emode, bool fetching_ckpt)
 
static void CheckRecoveryConsistency (void)
 
static XLogRecordReadCheckpointRecord (XLogReaderState *xlogreader, XLogRecPtr RecPtr, int whichChkpt, bool report)
 
static bool rescanLatestTimeLine (void)
 
static void WriteControlFile (void)
 
static void ReadControlFile (void)
 
static char * str_time (pg_time_t tnow)
 
static bool CheckForStandbyTrigger (void)
 
static void xlog_outdesc (StringInfo buf, XLogReaderState *record)
 
static void pg_start_backup_callback (int code, Datum arg)
 
static void pg_stop_backup_callback (int code, Datum arg)
 
static bool read_backup_label (XLogRecPtr *checkPointLoc, bool *backupEndRequired, bool *backupFromStandby)
 
static bool read_tablespace_map (List **tablespaces)
 
static void rm_redo_error_callback (void *arg)
 
static int get_sync_bit (int method)
 
static void CopyXLogRecordToWAL (int write_len, bool isLogSwitch, XLogRecData *rdata, XLogRecPtr StartPos, XLogRecPtr EndPos)
 
static void ReserveXLogInsertLocation (int size, XLogRecPtr *StartPos, XLogRecPtr *EndPos, XLogRecPtr *PrevPtr)
 
static bool ReserveXLogSwitch (XLogRecPtr *StartPos, XLogRecPtr *EndPos, XLogRecPtr *PrevPtr)
 
static XLogRecPtr WaitXLogInsertionsToFinish (XLogRecPtr upto)
 
static char * GetXLogBuffer (XLogRecPtr ptr)
 
static XLogRecPtr XLogBytePosToRecPtr (uint64 bytepos)
 
static XLogRecPtr XLogBytePosToEndRecPtr (uint64 bytepos)
 
static uint64 XLogRecPtrToBytePos (XLogRecPtr ptr)
 
static void checkXLogConsistency (XLogReaderState *record)
 
static void WALInsertLockAcquire (void)
 
static void WALInsertLockAcquireExclusive (void)
 
static void WALInsertLockRelease (void)
 
static void WALInsertLockUpdateInsertingAt (XLogRecPtr insertingAt)
 
XLogRecPtr XLogInsertRecord (XLogRecData *rdata, XLogRecPtr fpw_lsn, uint8 flags)
 
static void CalculateCheckpointSegments (void)
 
void assign_max_wal_size (int newval, void *extra)
 
void assign_checkpoint_completion_target (double newval, void *extra)
 
static XLogSegNo XLOGfileslop (XLogRecPtr RedoRecPtr)
 
void XLogSetAsyncXactLSN (XLogRecPtr asyncXactLSN)
 
void XLogSetReplicationSlotMinimumLSN (XLogRecPtr lsn)
 
void XLogFlush (XLogRecPtr record)
 
bool XLogBackgroundFlush (void)
 
bool XLogNeedsFlush (XLogRecPtr record)
 
int XLogFileInit (XLogSegNo logsegno, bool *use_existent, bool use_lock)
 
static void XLogFileCopy (XLogSegNo destsegno, TimeLineID srcTLI, XLogSegNo srcsegno, int upto)
 
int XLogFileOpen (XLogSegNo segno)
 
void CheckXLogRemoved (XLogSegNo segno, TimeLineID tli)
 
XLogSegNo XLogGetLastRemovedSegno (void)
 
static void RemoveNonParentXlogFiles (XLogRecPtr switchpoint, TimeLineID newTLI)
 
void UpdateControlFile (void)
 
uint64 GetSystemIdentifier (void)
 
char * GetMockAuthenticationNonce (void)
 
bool DataChecksumsEnabled (void)
 
XLogRecPtr GetFakeLSNForUnloggedRel (void)
 
static int XLOGChooseNumBuffers (void)
 
bool check_wal_buffers (int *newval, void **extra, GucSource source)
 
void LocalProcessControlFile (bool reset)
 
Size XLOGShmemSize (void)
 
void XLOGShmemInit (void)
 
void BootStrapXLOG (void)
 
static bool getRecordTimestamp (XLogReaderState *record, TimestampTz *recordXtime)
 
bool RecoveryIsPaused (void)
 
void SetRecoveryPause (bool recoveryPause)
 
TimestampTz GetLatestXTime (void)
 
TimestampTz GetCurrentChunkReplayStartTime (void)
 
void GetXLogReceiptTime (TimestampTz *rtime, bool *fromStream)
 
void StartupXLOG (void)
 
bool RecoveryInProgress (void)
 
bool HotStandbyActive (void)
 
bool HotStandbyActiveInReplay (void)
 
bool XLogInsertAllowed (void)
 
void InitXLOGAccess (void)
 
XLogRecPtr GetRedoRecPtr (void)
 
void GetFullPageWriteInfo (XLogRecPtr *RedoRecPtr_p, bool *doPageWrites_p)
 
XLogRecPtr GetInsertRecPtr (void)
 
XLogRecPtr GetFlushRecPtr (void)
 
XLogRecPtr GetLastImportantRecPtr (void)
 
pg_time_t GetLastSegSwitchData (XLogRecPtr *lastSwitchLSN)
 
void ShutdownXLOG (int code, Datum arg)
 
static void LogCheckpointStart (int flags, bool restartpoint)
 
static void LogCheckpointEnd (bool restartpoint)
 
static void UpdateCheckPointDistanceEstimate (uint64 nbytes)
 
void CreateCheckPoint (int flags)
 
static void RecoveryRestartPoint (const CheckPoint *checkPoint)
 
bool CreateRestartPoint (int flags)
 
void XLogPutNextOid (Oid nextOid)
 
XLogRecPtr RequestXLogSwitch (bool mark_unimportant)
 
XLogRecPtr XLogRestorePoint (const char *rpName)
 
void UpdateFullPageWrites (void)
 
void xlog_redo (XLogReaderState *record)
 
void assign_xlog_sync_method (int new_sync_method, void *extra)
 
void issue_xlog_fsync (int fd, XLogSegNo segno)
 
XLogRecPtr do_pg_start_backup (const char *backupidstr, bool fast, TimeLineID *starttli_p, StringInfo labelfile, List **tablespaces, StringInfo tblspcmapfile, bool infotbssize, bool needtblspcmapfile)
 
SessionBackupState get_backup_status (void)
 
XLogRecPtr do_pg_stop_backup (char *labelfile, bool waitforarchive, TimeLineID *stoptli_p)
 
void do_pg_abort_backup (void)
 
XLogRecPtr GetXLogReplayRecPtr (TimeLineID *replayTLI)
 
XLogRecPtr GetXLogInsertRecPtr (void)
 
XLogRecPtr GetXLogWriteRecPtr (void)
 
void GetOldestRestartPoint (XLogRecPtr *oldrecptr, TimeLineID *oldtli)
 
bool BackupInProgress (void)
 
void CancelBackup (void)
 
void RemovePromoteSignalFiles (void)
 
bool CheckPromoteSignal (void)
 
void WakeupRecovery (void)
 
void SetWalWriterSleeping (bool sleeping)
 
void XLogRequestWalReceiverReply (void)
 

Variables

uint32 bootstrap_data_checksum_version
 
int max_wal_size_mb = 1024
 
int min_wal_size_mb = 80
 
int wal_keep_segments = 0
 
int XLOGbuffers = -1
 
int XLogArchiveTimeout = 0
 
int XLogArchiveMode = ARCHIVE_MODE_OFF
 
char * XLogArchiveCommand = NULL
 
bool EnableHotStandby = false
 
bool fullPageWrites = true
 
bool wal_log_hints = false
 
bool wal_compression = false
 
char * wal_consistency_checking_string = NULL
 
boolwal_consistency_checking = NULL
 
bool wal_init_zero = true
 
bool wal_recycle = true
 
bool log_checkpoints = false
 
int sync_method = DEFAULT_SYNC_METHOD
 
int wal_level = WAL_LEVEL_MINIMAL
 
int CommitDelay = 0
 
int CommitSiblings = 5
 
int wal_retrieve_retry_interval = 5000
 
int wal_segment_size = DEFAULT_XLOG_SEG_SIZE
 
int CheckPointSegments
 
static double CheckPointDistanceEstimate = 0
 
static double PrevCheckPointDistance = 0
 
const struct config_enum_entry sync_method_options []
 
const struct config_enum_entry archive_mode_options []
 
const struct config_enum_entry recovery_target_action_options []
 
CheckpointStatsData CheckpointStats
 
TimeLineID ThisTimeLineID = 0
 
bool InRecovery = false
 
HotStandbyState standbyState = STANDBY_DISABLED
 
static XLogRecPtr LastRec
 
static XLogRecPtr receivedUpto = 0
 
static TimeLineID receiveTLI = 0
 
static bool lastFullPageWrites
 
static bool LocalRecoveryInProgress = true
 
static bool LocalHotStandbyActive = false
 
static int LocalXLogInsertAllowed = -1
 
bool ArchiveRecoveryRequested = false
 
bool InArchiveRecovery = false
 
static bool standby_signal_file_found = false
 
static bool recovery_signal_file_found = false
 
static bool restoredFromArchive = false
 
static char * replay_image_masked = NULL
 
static char * master_image_masked = NULL
 
char * recoveryRestoreCommand = NULL
 
char * recoveryEndCommand = NULL
 
char * archiveCleanupCommand = NULL
 
RecoveryTargetType recoveryTarget = RECOVERY_TARGET_UNSET
 
bool recoveryTargetInclusive = true
 
int recoveryTargetAction = RECOVERY_TARGET_ACTION_PAUSE
 
TransactionId recoveryTargetXid
 
char * recovery_target_time_string
 
static TimestampTz recoveryTargetTime
 
const char * recoveryTargetName
 
XLogRecPtr recoveryTargetLSN
 
int recovery_min_apply_delay = 0
 
TimestampTz recoveryDelayUntilTime
 
bool StandbyModeRequested = false
 
char * PrimaryConnInfo = NULL
 
char * PrimarySlotName = NULL
 
char * PromoteTriggerFile = NULL
 
bool StandbyMode = false
 
static bool fast_promote = false
 
static TransactionId recoveryStopXid
 
static TimestampTz recoveryStopTime
 
static XLogRecPtr recoveryStopLSN
 
static char recoveryStopName [MAXFNAMELEN]
 
static bool recoveryStopAfter
 
RecoveryTargetTimeLineGoal recoveryTargetTimeLineGoal = RECOVERY_TARGET_TIMELINE_LATEST
 
TimeLineID recoveryTargetTLIRequested = 0
 
TimeLineID recoveryTargetTLI = 0
 
static ListexpectedTLEs
 
static TimeLineID curFileTLI
 
XLogRecPtr ProcLastRecPtr = InvalidXLogRecPtr
 
XLogRecPtr XactLastRecEnd = InvalidXLogRecPtr
 
XLogRecPtr XactLastCommitEnd = InvalidXLogRecPtr
 
static XLogRecPtr RedoRecPtr
 
static bool doPageWrites
 
static bool doRequestWalReceiverReply
 
static XLogRecPtr RedoStartLSN = InvalidXLogRecPtr
 
static SessionBackupState sessionBackupState = SESSION_BACKUP_NONE
 
static XLogCtlDataXLogCtl = NULL
 
static WALInsertLockPaddedWALInsertLocks = NULL
 
static ControlFileDataControlFile = NULL
 
static int UsableBytesInSegment
 
static XLogwrtResult LogwrtResult = {0, 0}
 
static const char *const xlogSourceNames [] = {"any", "archive", "pg_wal", "stream"}
 
static int openLogFile = -1
 
static XLogSegNo openLogSegNo = 0
 
static int readFile = -1
 
static XLogSegNo readSegNo = 0
 
static uint32 readOff = 0
 
static uint32 readLen = 0
 
static XLogSource readSource = 0
 
static XLogSource currentSource = 0
 
static bool lastSourceFailed = false
 
static TimestampTz XLogReceiptTime = 0
 
static XLogSource XLogReceiptSource = 0
 
static XLogRecPtr ReadRecPtr
 
static XLogRecPtr EndRecPtr
 
static XLogRecPtr minRecoveryPoint
 
static TimeLineID minRecoveryPointTLI
 
static bool updateMinRecoveryPoint = true
 
bool reachedConsistency = false
 
static bool InRedo = false
 
static bool bgwriterLaunched = false
 
static int MyLockNo = 0
 
static bool holdingAllLocks = false
 

Macro Definition Documentation

◆ ConvertToXSegs

#define ConvertToXSegs (   x,
  segsize 
)    (x / ((segsize) / (1024 * 1024)))

Definition at line 747 of file xlog.c.

Referenced by CalculateCheckpointSegments(), ReadControlFile(), and XLOGfileslop().

◆ INSERT_FREESPACE

#define INSERT_FREESPACE (   endptr)    (((endptr) % XLOG_BLCKSZ == 0) ? 0 : (XLOG_BLCKSZ - (endptr) % XLOG_BLCKSZ))

Definition at line 727 of file xlog.c.

Referenced by CopyXLogRecordToWAL(), and CreateCheckPoint().

◆ NextBufIdx

#define NextBufIdx (   idx)    (((idx) == XLogCtl->XLogCacheBlck) ? 0 : ((idx) + 1))

Definition at line 731 of file xlog.c.

Referenced by XLogWrite().

◆ NUM_XLOGINSERT_LOCKS

◆ RECOVERY_COMMAND_DONE

#define RECOVERY_COMMAND_DONE   "recovery.done"

Definition at line 83 of file xlog.c.

Referenced by readRecoverySignalFile().

◆ RECOVERY_COMMAND_FILE

#define RECOVERY_COMMAND_FILE   "recovery.conf"

Definition at line 82 of file xlog.c.

Referenced by readRecoverySignalFile().

◆ RecoveryRequiresIntParameter

#define RecoveryRequiresIntParameter (   param_name,
  currValue,
  minValue 
)
Value:
do { \
if ((currValue) < (minValue)) \
ereport(ERROR, \
(errcode(ERRCODE_INVALID_PARAMETER_VALUE), \
errmsg("hot standby is not possible because " \
"%s = %d is a lower setting than on the master server " \
"(its value was %d)", \
param_name, \
currValue, \
minValue))); \
} while(0)
int errcode(int sqlerrcode)
Definition: elog.c:608
#define ERROR
Definition: elog.h:43
int errmsg(const char *fmt,...)
Definition: elog.c:822

Definition at line 6136 of file xlog.c.

Referenced by CheckRequiredParameterValues().

◆ UsableBytesInPage

#define UsableBytesInPage   (XLOG_BLCKSZ - SizeOfXLogShortPHD)

◆ XLogRecPtrToBufIdx

#define XLogRecPtrToBufIdx (   recptr)    (((recptr) / XLOG_BLCKSZ) % (XLogCtl->XLogCacheBlck + 1))

Definition at line 738 of file xlog.c.

Referenced by AdvanceXLInsertBuffer(), GetXLogBuffer(), StartupXLOG(), and XLogWrite().

Typedef Documentation

◆ ExclusiveBackupState

◆ WALInsertLockPadded

◆ XLogCtlData

typedef struct XLogCtlData XLogCtlData

◆ XLogCtlInsert

typedef struct XLogCtlInsert XLogCtlInsert

◆ XLogPageReadPrivate

◆ XLogwrtResult

typedef struct XLogwrtResult XLogwrtResult

◆ XLogwrtRqst

typedef struct XLogwrtRqst XLogwrtRqst

Enumeration Type Documentation

◆ ExclusiveBackupState

Enumerator
EXCLUSIVE_BACKUP_NONE 
EXCLUSIVE_BACKUP_STARTING 
EXCLUSIVE_BACKUP_IN_PROGRESS 
EXCLUSIVE_BACKUP_STOPPING 

Definition at line 513 of file xlog.c.

◆ XLogSource

enum XLogSource
Enumerator
XLOG_FROM_ANY 
XLOG_FROM_ARCHIVE 
XLOG_FROM_PG_WAL 
XLOG_FROM_STREAM 

Definition at line 763 of file xlog.c.

764 {
765  XLOG_FROM_ANY = 0, /* request to read WAL from any source */
766  XLOG_FROM_ARCHIVE, /* restored using restore_command */
767  XLOG_FROM_PG_WAL, /* existing file in pg_wal */
768  XLOG_FROM_STREAM /* streamed from master */
769 } XLogSource;
XLogSource
Definition: xlog.c:763

Function Documentation

◆ AdvanceXLInsertBuffer()

static void AdvanceXLInsertBuffer ( XLogRecPtr  upto,
bool  opportunistic 
)
static

Definition at line 2086 of file xlog.c.

References Assert, DEBUG1, elog, XLogwrtRqst::Flush, XLogCtlInsert::forcePageWrites, XLogCtlData::info_lck, XLogCtlData::InitializedUpTo, Insert(), XLogCtlData::Insert, InvalidXLogRecPtr, XLogCtlData::LogwrtResult, XLogCtlData::LogwrtRqst, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MemSet, XLogCtlData::pages, pg_write_barrier, SpinLockAcquire, SpinLockRelease, ControlFileData::system_identifier, ThisTimeLineID, WaitXLogInsertionsToFinish(), wal_segment_size, XLogwrtRqst::Write, XLogwrtResult::Write, XLogCtlData::xlblocks, XLOG_PAGE_MAGIC, XLogRecPtrToBufIdx, XLogSegmentOffset, XLogWrite(), XLP_BKP_REMOVABLE, XLP_LONG_HEADER, XLogLongPageHeaderData::xlp_seg_size, XLogLongPageHeaderData::xlp_sysid, and XLogLongPageHeaderData::xlp_xlog_blcksz.

Referenced by GetXLogBuffer(), and XLogBackgroundFlush().

2087 {
2089  int nextidx;
2090  XLogRecPtr OldPageRqstPtr;
2091  XLogwrtRqst WriteRqst;
2092  XLogRecPtr NewPageEndPtr = InvalidXLogRecPtr;
2093  XLogRecPtr NewPageBeginPtr;
2094  XLogPageHeader NewPage;
2095  int npages = 0;
2096 
2097  LWLockAcquire(WALBufMappingLock, LW_EXCLUSIVE);
2098 
2099  /*
2100  * Now that we have the lock, check if someone initialized the page
2101  * already.
2102  */
2103  while (upto >= XLogCtl->InitializedUpTo || opportunistic)
2104  {
2106 
2107  /*
2108  * Get ending-offset of the buffer page we need to replace (this may
2109  * be zero if the buffer hasn't been used yet). Fall through if it's
2110  * already written out.
2111  */
2112  OldPageRqstPtr = XLogCtl->xlblocks[nextidx];
2113  if (LogwrtResult.Write < OldPageRqstPtr)
2114  {
2115  /*
2116  * Nope, got work to do. If we just want to pre-initialize as much
2117  * as we can without flushing, give up now.
2118  */
2119  if (opportunistic)
2120  break;
2121 
2122  /* Before waiting, get info_lck and update LogwrtResult */
2124  if (XLogCtl->LogwrtRqst.Write < OldPageRqstPtr)
2125  XLogCtl->LogwrtRqst.Write = OldPageRqstPtr;
2128 
2129  /*
2130  * Now that we have an up-to-date LogwrtResult value, see if we
2131  * still need to write it or if someone else already did.
2132  */
2133  if (LogwrtResult.Write < OldPageRqstPtr)
2134  {
2135  /*
2136  * Must acquire write lock. Release WALBufMappingLock first,
2137  * to make sure that all insertions that we need to wait for
2138  * can finish (up to this same position). Otherwise we risk
2139  * deadlock.
2140  */
2141  LWLockRelease(WALBufMappingLock);
2142 
2143  WaitXLogInsertionsToFinish(OldPageRqstPtr);
2144 
2145  LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
2146 
2148  if (LogwrtResult.Write >= OldPageRqstPtr)
2149  {
2150  /* OK, someone wrote it already */
2151  LWLockRelease(WALWriteLock);
2152  }
2153  else
2154  {
2155  /* Have to write it ourselves */
2156  TRACE_POSTGRESQL_WAL_BUFFER_WRITE_DIRTY_START();
2157  WriteRqst.Write = OldPageRqstPtr;
2158  WriteRqst.Flush = 0;
2159  XLogWrite(WriteRqst, false);
2160  LWLockRelease(WALWriteLock);
2161  TRACE_POSTGRESQL_WAL_BUFFER_WRITE_DIRTY_DONE();
2162  }
2163  /* Re-acquire WALBufMappingLock and retry */
2164  LWLockAcquire(WALBufMappingLock, LW_EXCLUSIVE);
2165  continue;
2166  }
2167  }
2168 
2169  /*
2170  * Now the next buffer slot is free and we can set it up to be the
2171  * next output page.
2172  */
2173  NewPageBeginPtr = XLogCtl->InitializedUpTo;
2174  NewPageEndPtr = NewPageBeginPtr + XLOG_BLCKSZ;
2175 
2176  Assert(XLogRecPtrToBufIdx(NewPageBeginPtr) == nextidx);
2177 
2178  NewPage = (XLogPageHeader) (XLogCtl->pages + nextidx * (Size) XLOG_BLCKSZ);
2179 
2180  /*
2181  * Be sure to re-zero the buffer so that bytes beyond what we've
2182  * written will look like zeroes and not valid XLOG records...
2183  */
2184  MemSet((char *) NewPage, 0, XLOG_BLCKSZ);
2185 
2186  /*
2187  * Fill the new page's header
2188  */
2189  NewPage->xlp_magic = XLOG_PAGE_MAGIC;
2190 
2191  /* NewPage->xlp_info = 0; */ /* done by memset */
2192  NewPage->xlp_tli = ThisTimeLineID;
2193  NewPage->xlp_pageaddr = NewPageBeginPtr;
2194 
2195  /* NewPage->xlp_rem_len = 0; */ /* done by memset */
2196 
2197  /*
2198  * If online backup is not in progress, mark the header to indicate
2199  * that WAL records beginning in this page have removable backup
2200  * blocks. This allows the WAL archiver to know whether it is safe to
2201  * compress archived WAL data by transforming full-block records into
2202  * the non-full-block format. It is sufficient to record this at the
2203  * page level because we force a page switch (in fact a segment
2204  * switch) when starting a backup, so the flag will be off before any
2205  * records can be written during the backup. At the end of a backup,
2206  * the last page will be marked as all unsafe when perhaps only part
2207  * is unsafe, but at worst the archiver would miss the opportunity to
2208  * compress a few records.
2209  */
2210  if (!Insert->forcePageWrites)
2211  NewPage->xlp_info |= XLP_BKP_REMOVABLE;
2212 
2213  /*
2214  * If first page of an XLOG segment file, make it a long header.
2215  */
2216  if ((XLogSegmentOffset(NewPage->xlp_pageaddr, wal_segment_size)) == 0)
2217  {
2218  XLogLongPageHeader NewLongPage = (XLogLongPageHeader) NewPage;
2219 
2220  NewLongPage->xlp_sysid = ControlFile->system_identifier;
2221  NewLongPage->xlp_seg_size = wal_segment_size;
2222  NewLongPage->xlp_xlog_blcksz = XLOG_BLCKSZ;
2223  NewPage->xlp_info |= XLP_LONG_HEADER;
2224  }
2225 
2226  /*
2227  * Make sure the initialization of the page becomes visible to others
2228  * before the xlblocks update. GetXLogBuffer() reads xlblocks without
2229  * holding a lock.
2230  */
2231  pg_write_barrier();
2232 
2233  *((volatile XLogRecPtr *) &XLogCtl->xlblocks[nextidx]) = NewPageEndPtr;
2234 
2235  XLogCtl->InitializedUpTo = NewPageEndPtr;
2236 
2237  npages++;
2238  }
2239  LWLockRelease(WALBufMappingLock);
2240 
2241 #ifdef WAL_DEBUG
2242  if (XLOG_DEBUG && npages > 0)
2243  {
2244  elog(DEBUG1, "initialized %d pages, up to %X/%X",
2245  npages, (uint32) (NewPageEndPtr >> 32), (uint32) NewPageEndPtr);
2246  }
2247 #endif
2248 }
XLogRecPtr InitializedUpTo
Definition: xlog.c:625
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
#define DEBUG1
Definition: elog.h:25
int wal_segment_size
Definition: xlog.c:112
XLogRecPtr * xlblocks
Definition: xlog.c:633
static XLogwrtResult LogwrtResult
Definition: xlog.c:757
slock_t info_lck
Definition: xlog.c:710
#define MemSet(start, val, len)
Definition: c.h:962
static XLogRecPtr WaitXLogInsertionsToFinish(XLogRecPtr upto)
Definition: xlog.c:1749
XLogPageHeaderData * XLogPageHeader
Definition: xlog_internal.h:57
XLogCtlInsert Insert
Definition: xlog.c:590
XLogRecPtr Flush
Definition: xlog.c:433
XLogLongPageHeaderData * XLogLongPageHeader
Definition: xlog_internal.h:74
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define XLP_BKP_REMOVABLE
Definition: xlog_internal.h:81
bool forcePageWrites
Definition: xlog.c:564
uint64 system_identifier
Definition: pg_control.h:106
#define XLOG_PAGE_MAGIC
Definition: xlog_internal.h:34
XLogwrtResult LogwrtResult
Definition: xlog.c:613
unsigned int uint32
Definition: c.h:359
static void Insert(File file)
Definition: fd.c:1096
TimeLineID xlp_tli
Definition: xlog_internal.h:40
static void XLogWrite(XLogwrtRqst WriteRqst, bool flexible)
Definition: xlog.c:2376
XLogRecPtr xlp_pageaddr
Definition: xlog_internal.h:41
#define SpinLockRelease(lock)
Definition: spin.h:64
XLogRecPtr Write
Definition: xlog.c:432
#define XLogSegmentOffset(xlogptr, wal_segsz_bytes)
static ControlFileData * ControlFile
Definition: xlog.c:721
XLogwrtRqst LogwrtRqst
Definition: xlog.c:593
TimeLineID ThisTimeLineID
Definition: xlog.c:187
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:739
#define XLP_LONG_HEADER
Definition: xlog_internal.h:79
size_t Size
Definition: c.h:467
static XLogCtlData * XLogCtl
Definition: xlog.c:713
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1122
#define XLogRecPtrToBufIdx(recptr)
Definition: xlog.c:738
XLogRecPtr Write
Definition: xlog.c:438
#define elog(elevel,...)
Definition: elog.h:228
#define pg_write_barrier()
Definition: atomics.h:159
char * pages
Definition: xlog.c:632

◆ assign_checkpoint_completion_target()

void assign_checkpoint_completion_target ( double  newval,
void *  extra 
)

Definition at line 2291 of file xlog.c.

References CalculateCheckpointSegments(), CheckPointCompletionTarget, and newval.

2292 {
2295 }
static void CalculateCheckpointSegments(void)
Definition: xlog.c:2255
#define newval
double CheckPointCompletionTarget
Definition: checkpointer.c:149

◆ assign_max_wal_size()

void assign_max_wal_size ( int  newval,
void *  extra 
)

Definition at line 2284 of file xlog.c.

References CalculateCheckpointSegments(), max_wal_size_mb, and newval.

2285 {
2288 }
static void CalculateCheckpointSegments(void)
Definition: xlog.c:2255
int max_wal_size_mb
Definition: xlog.c:86
#define newval

◆ assign_xlog_sync_method()

void assign_xlog_sync_method ( int  new_sync_method,
void *  extra 
)

Definition at line 10089 of file xlog.c.

References ereport, errcode_for_file_access(), errmsg(), get_sync_bit(), MAXFNAMELEN, openLogFile, openLogSegNo, PANIC, pg_fsync(), pgstat_report_wait_end(), pgstat_report_wait_start(), sync_method, ThisTimeLineID, WAIT_EVENT_WAL_SYNC_METHOD_ASSIGN, wal_segment_size, XLogFileClose(), and XLogFileName.

10090 {
10091  if (sync_method != new_sync_method)
10092  {
10093  /*
10094  * To ensure that no blocks escape unsynced, force an fsync on the
10095  * currently open log segment (if any). Also, if the open flag is
10096  * changing, close the log file so it will be reopened (with new flag
10097  * bit) at next use.
10098  */
10099  if (openLogFile >= 0)
10100  {
10102  if (pg_fsync(openLogFile) != 0)
10103  {
10104  char xlogfname[MAXFNAMELEN];
10105  int save_errno;
10106 
10107  save_errno = errno;
10110  errno = save_errno;
10111  ereport(PANIC,
10113  errmsg("could not fsync file \"%s\": %m", xlogfname)));
10114  }
10115 
10117  if (get_sync_bit(sync_method) != get_sync_bit(new_sync_method))
10118  XLogFileClose();
10119  }
10120  }
10121 }
int wal_segment_size
Definition: xlog.c:112
static int get_sync_bit(int method)
Definition: xlog.c:10033
#define PANIC
Definition: elog.h:53
static XLogSegNo openLogSegNo
Definition: xlog.c:780
static void XLogFileClose(void)
Definition: xlog.c:3786
int errcode_for_file_access(void)
Definition: elog.c:631
static void pgstat_report_wait_end(void)
Definition: pgstat.h:1342
#define ereport(elevel, rest)
Definition: elog.h:141
#define MAXFNAMELEN
static int openLogFile
Definition: xlog.c:779
TimeLineID ThisTimeLineID
Definition: xlog.c:187
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
static void pgstat_report_wait_start(uint32 wait_event_info)
Definition: pgstat.h:1318
int sync_method
Definition: xlog.c:102
int errmsg(const char *fmt,...)
Definition: elog.c:822
int pg_fsync(int fd)
Definition: fd.c:330

◆ BackupInProgress()

bool BackupInProgress ( void  )

Definition at line 11468 of file xlog.c.

References BACKUP_LABEL_FILE, and stat.

Referenced by pg_is_in_backup(), and PostmasterStateMachine().

11469 {
11470  struct stat stat_buf;
11471 
11472  return (stat(BACKUP_LABEL_FILE, &stat_buf) == 0);
11473 }
struct stat stat_buf
Definition: pg_standby.c:100
#define stat(a, b)
Definition: win32_port.h:255
#define BACKUP_LABEL_FILE
Definition: xlog.h:358

◆ BootStrapXLOG()

void BootStrapXLOG ( void  )

Definition at line 5084 of file xlog.c.

References AdvanceOldestClogXid(), Assert, bootstrap_data_checksum_version, BootStrapCLOG(), BootStrapCommitTs(), BootStrapMultiXact(), BootStrapSUBTRANS(), ControlFileData::checkPoint, ControlFileData::checkPointCopy, close, COMP_CRC32C, ControlFileData::data_checksum_version, DB_SHUTDOWNED, ereport, errcode(), errcode_for_file_access(), errmsg(), FIN_CRC32C, FirstBootstrapObjectId, FirstMultiXactId, FirstNormalTransactionId, FirstNormalUnloggedLSN, CheckPoint::fullPageWrites, fullPageWrites, FullTransactionIdFromEpochAndXid(), gettimeofday(), INIT_CRC32C, InvalidTransactionId, max_locks_per_xact, ControlFileData::max_locks_per_xact, max_prepared_xacts, ControlFileData::max_prepared_xacts, max_wal_senders, ControlFileData::max_wal_senders, max_worker_processes, ControlFileData::max_worker_processes, MaxConnections, ControlFileData::MaxConnections, MOCK_AUTH_NONCE_LEN, ControlFileData::mock_authentication_nonce, MultiXactSetNextMXact(), CheckPoint::newestCommitTsXid, CheckPoint::nextFullXid, VariableCacheData::nextFullXid, CheckPoint::nextMulti, CheckPoint::nextMultiOffset, CheckPoint::nextOid, VariableCacheData::nextOid, offsetof, VariableCacheData::oidCount, CheckPoint::oldestActiveXid, CheckPoint::oldestCommitTsXid, CheckPoint::oldestMulti, CheckPoint::oldestMultiDB, CheckPoint::oldestXid, CheckPoint::oldestXidDB, openLogFile, palloc(), PANIC, pfree(), pg_fsync(), pg_strong_random(), pgstat_report_wait_end(), pgstat_report_wait_start(), CheckPoint::PrevTimeLineID, ReadControlFile(), CheckPoint::redo, SetCommitTsLimit(), SetMultiXactIdLimit(), SetTransactionIdLimit(), ShmemVariableCache, SizeOfXLogLongPHD, SizeOfXLogRecord, SizeOfXLogRecordDataHeaderShort, ControlFileData::state, ControlFileData::system_identifier, CheckPoint::ThisTimeLineID, ThisTimeLineID, CheckPoint::time, ControlFileData::time, track_commit_timestamp, ControlFileData::track_commit_timestamp, TYPEALIGN, ControlFileData::unloggedLSN, WAIT_EVENT_WAL_BOOTSTRAP_SYNC, WAIT_EVENT_WAL_BOOTSTRAP_WRITE, wal_level, ControlFileData::wal_level, wal_log_hints, ControlFileData::wal_log_hints, wal_segment_size, write, WriteControlFile(), XLogRecord::xl_info, XLogRecord::xl_prev, XLogRecord::xl_rmid, XLogRecord::xl_tot_len, XLogRecord::xl_xid, XLOG_CHECKPOINT_SHUTDOWN, XLOG_PAGE_MAGIC, XLogFileInit(), XLogPageHeaderData::xlp_info, XLP_LONG_HEADER, XLogPageHeaderData::xlp_magic, XLogPageHeaderData::xlp_pageaddr, XLogLongPageHeaderData::xlp_seg_size, XLogLongPageHeaderData::xlp_sysid, XLogPageHeaderData::xlp_tli, XLogLongPageHeaderData::xlp_xlog_blcksz, and XLR_BLOCK_ID_DATA_SHORT.

Referenced by AuxiliaryProcessMain().

5085 {
5086  CheckPoint checkPoint;
5087  char *buffer;
5088  XLogPageHeader page;
5089  XLogLongPageHeader longpage;
5090  XLogRecord *record;
5091  char *recptr;
5092  bool use_existent;
5093  uint64 sysidentifier;
5094  char mock_auth_nonce[MOCK_AUTH_NONCE_LEN];
5095  struct timeval tv;
5096  pg_crc32c crc;
5097 
5098  /*
5099  * Select a hopefully-unique system identifier code for this installation.
5100  * We use the result of gettimeofday(), including the fractional seconds
5101  * field, as being about as unique as we can easily get. (Think not to
5102  * use random(), since it hasn't been seeded and there's no portable way
5103  * to seed it other than the system clock value...) The upper half of the
5104  * uint64 value is just the tv_sec part, while the lower half contains the
5105  * tv_usec part (which must fit in 20 bits), plus 12 bits from our current
5106  * PID for a little extra uniqueness. A person knowing this encoding can
5107  * determine the initialization time of the installation, which could
5108  * perhaps be useful sometimes.
5109  */
5110  gettimeofday(&tv, NULL);
5111  sysidentifier = ((uint64) tv.tv_sec) << 32;
5112  sysidentifier |= ((uint64) tv.tv_usec) << 12;
5113  sysidentifier |= getpid() & 0xFFF;
5114 
5115  /*
5116  * Generate a random nonce. This is used for authentication requests that
5117  * will fail because the user does not exist. The nonce is used to create
5118  * a genuine-looking password challenge for the non-existent user, in lieu
5119  * of an actual stored password.
5120  */
5121  if (!pg_strong_random(mock_auth_nonce, MOCK_AUTH_NONCE_LEN))
5122  ereport(PANIC,
5123  (errcode(ERRCODE_INTERNAL_ERROR),
5124  errmsg("could not generate secret authorization token")));
5125 
5126  /* First timeline ID is always 1 */
5127  ThisTimeLineID = 1;
5128 
5129  /* page buffer must be aligned suitably for O_DIRECT */
5130  buffer = (char *) palloc(XLOG_BLCKSZ + XLOG_BLCKSZ);
5131  page = (XLogPageHeader) TYPEALIGN(XLOG_BLCKSZ, buffer);
5132  memset(page, 0, XLOG_BLCKSZ);
5133 
5134  /*
5135  * Set up information for the initial checkpoint record
5136  *
5137  * The initial checkpoint record is written to the beginning of the WAL
5138  * segment with logid=0 logseg=1. The very first WAL segment, 0/0, is not
5139  * used, so that we can use 0/0 to mean "before any valid WAL segment".
5140  */
5141  checkPoint.redo = wal_segment_size + SizeOfXLogLongPHD;
5142  checkPoint.ThisTimeLineID = ThisTimeLineID;
5143  checkPoint.PrevTimeLineID = ThisTimeLineID;
5144  checkPoint.fullPageWrites = fullPageWrites;
5145  checkPoint.nextFullXid =
5147  checkPoint.nextOid = FirstBootstrapObjectId;
5148  checkPoint.nextMulti = FirstMultiXactId;
5149  checkPoint.nextMultiOffset = 0;
5150  checkPoint.oldestXid = FirstNormalTransactionId;
5151  checkPoint.oldestXidDB = TemplateDbOid;
5152  checkPoint.oldestMulti = FirstMultiXactId;
5153  checkPoint.oldestMultiDB = TemplateDbOid;
5156  checkPoint.time = (pg_time_t) time(NULL);
5158 
5160  ShmemVariableCache->nextOid = checkPoint.nextOid;
5162  MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
5163  AdvanceOldestClogXid(checkPoint.oldestXid);
5164  SetTransactionIdLimit(checkPoint.oldestXid, checkPoint.oldestXidDB);
5165  SetMultiXactIdLimit(checkPoint.oldestMulti, checkPoint.oldestMultiDB, true);
5167 
5168  /* Set up the XLOG page header */
5169  page->xlp_magic = XLOG_PAGE_MAGIC;
5170  page->xlp_info = XLP_LONG_HEADER;
5171  page->xlp_tli = ThisTimeLineID;
5173  longpage = (XLogLongPageHeader) page;
5174  longpage->xlp_sysid = sysidentifier;
5175  longpage->xlp_seg_size = wal_segment_size;
5176  longpage->xlp_xlog_blcksz = XLOG_BLCKSZ;
5177 
5178  /* Insert the initial checkpoint record */
5179  recptr = ((char *) page + SizeOfXLogLongPHD);
5180  record = (XLogRecord *) recptr;
5181  record->xl_prev = 0;
5182  record->xl_xid = InvalidTransactionId;
5183  record->xl_tot_len = SizeOfXLogRecord + SizeOfXLogRecordDataHeaderShort + sizeof(checkPoint);
5185  record->xl_rmid = RM_XLOG_ID;
5186  recptr += SizeOfXLogRecord;
5187  /* fill the XLogRecordDataHeaderShort struct */
5188  *(recptr++) = (char) XLR_BLOCK_ID_DATA_SHORT;
5189  *(recptr++) = sizeof(checkPoint);
5190  memcpy(recptr, &checkPoint, sizeof(checkPoint));
5191  recptr += sizeof(checkPoint);
5192  Assert(recptr - (char *) record == record->xl_tot_len);
5193 
5194  INIT_CRC32C(crc);
5195  COMP_CRC32C(crc, ((char *) record) + SizeOfXLogRecord, record->xl_tot_len - SizeOfXLogRecord);
5196  COMP_CRC32C(crc, (char *) record, offsetof(XLogRecord, xl_crc));
5197  FIN_CRC32C(crc);
5198  record->xl_crc = crc;
5199 
5200  /* Create first XLOG segment file */
5201  use_existent = false;
5202  openLogFile = XLogFileInit(1, &use_existent, false);
5203 
5204  /* Write the first page with the initial record */
5205  errno = 0;
5207  if (write(openLogFile, page, XLOG_BLCKSZ) != XLOG_BLCKSZ)
5208  {
5209  /* if write didn't set errno, assume problem is no disk space */
5210  if (errno == 0)
5211  errno = ENOSPC;
5212  ereport(PANIC,
5214  errmsg("could not write bootstrap write-ahead log file: %m")));
5215  }
5217 
5219  if (pg_fsync(openLogFile) != 0)
5220  ereport(PANIC,
5222  errmsg("could not fsync bootstrap write-ahead log file: %m")));
5224 
5225  if (close(openLogFile) != 0)
5226  ereport(PANIC,
5228  errmsg("could not close bootstrap write-ahead log file: %m")));
5229 
5230  openLogFile = -1;
5231 
5232  /* Now create pg_control */
5233 
5234  memset(ControlFile, 0, sizeof(ControlFileData));
5235  /* Initialize pg_control status fields */
5236  ControlFile->system_identifier = sysidentifier;
5237  memcpy(ControlFile->mock_authentication_nonce, mock_auth_nonce, MOCK_AUTH_NONCE_LEN);
5239  ControlFile->time = checkPoint.time;
5240  ControlFile->checkPoint = checkPoint.redo;
5241  ControlFile->checkPointCopy = checkPoint;
5243 
5244  /* Set important parameter values for use when replaying WAL */
5254 
5255  /* some additional ControlFile fields are set in WriteControlFile() */
5256 
5257  WriteControlFile();
5258 
5259  /* Bootstrap the commit log, too */
5260  BootStrapCLOG();
5264 
5265  pfree(buffer);
5266 
5267  /*
5268  * Force control file to be read - in contrast to normal processing we'd
5269  * otherwise never run the checks and GUC related initializations therein.
5270  */
5271  ReadControlFile();
5272 }
static void WriteControlFile(void)
Definition: xlog.c:4499
#define INIT_CRC32C(crc)
Definition: pg_crc32c.h:41
XLogRecPtr xl_prev
Definition: xlogrecord.h:45
int max_locks_per_xact
Definition: pg_control.h:182
int gettimeofday(struct timeval *tp, struct timezone *tzp)
Definition: gettimeofday.c:105
int max_prepared_xacts
Definition: pg_control.h:181
int64 pg_time_t
Definition: pgtime.h:23
int wal_segment_size
Definition: xlog.c:112
pg_time_t time
Definition: pg_control.h:128
void SetCommitTsLimit(TransactionId oldestXact, TransactionId newestXact)
Definition: commit_ts.c:848
uint32 oidCount
Definition: transam.h:159
#define write(a, b, c)
Definition: win32.h:14
#define SizeOfXLogRecordDataHeaderShort
Definition: xlogrecord.h:200
int max_worker_processes
Definition: pg_control.h:179
uint32 pg_crc32c
Definition: pg_crc32c.h:38
TransactionId oldestActiveXid
Definition: pg_control.h:63
int wal_level
Definition: xlog.c:103
int XLogFileInit(XLogSegNo logsegno, bool *use_existent, bool use_lock)
Definition: xlog.c:3212
void BootStrapMultiXact(void)
Definition: multixact.c:1868
MultiXactId oldestMulti
Definition: pg_control.h:49
TimeLineID PrevTimeLineID
Definition: pg_control.h:40
int errcode(int sqlerrcode)
Definition: elog.c:608
RmgrId xl_rmid
Definition: xlogrecord.h:47
XLogPageHeaderData * XLogPageHeader
Definition: xlog_internal.h:57
FullTransactionId nextFullXid
Definition: transam.h:164
CheckPoint checkPointCopy
Definition: pg_control.h:131
TransactionId oldestXid
Definition: pg_control.h:47
pg_time_t time
Definition: pg_control.h:51
#define PANIC
Definition: elog.h:53
uint32 bootstrap_data_checksum_version
Definition: bootstrap.c:53
XLogLongPageHeaderData * XLogLongPageHeader
Definition: xlog_internal.h:74
#define MOCK_AUTH_NONCE_LEN
Definition: pg_control.h:28
bool fullPageWrites
Definition: xlog.c:94
void BootStrapSUBTRANS(void)
Definition: subtrans.c:212
MultiXactOffset nextMultiOffset
Definition: pg_control.h:46
void AdvanceOldestClogXid(TransactionId oldest_datfrozenxid)
Definition: varsup.c:313
TransactionId oldestCommitTsXid
Definition: pg_control.h:52
void pfree(void *pointer)
Definition: mcxt.c:1056
#define FirstNormalTransactionId
Definition: transam.h:34
int max_prepared_xacts
Definition: twophase.c:117
uint64 system_identifier
Definition: pg_control.h:106
uint32 xl_tot_len
Definition: xlogrecord.h:43
#define XLOG_PAGE_MAGIC
Definition: xlog_internal.h:34
static void ReadControlFile(void)
Definition: xlog.c:4590
bool track_commit_timestamp
Definition: commit_ts.c:103
uint32 data_checksum_version
Definition: pg_control.h:220
#define XLOG_CHECKPOINT_SHUTDOWN
Definition: pg_control.h:67
XLogRecPtr unloggedLSN
Definition: pg_control.h:133
int errcode_for_file_access(void)
Definition: elog.c:631
VariableCache ShmemVariableCache
Definition: varsup.c:34
#define InvalidTransactionId
Definition: transam.h:31
#define FirstBootstrapObjectId
Definition: transam.h:140
static void pgstat_report_wait_end(void)
Definition: pgstat.h:1342
#define FirstMultiXactId
Definition: multixact.h:24
#define ereport(elevel, rest)
Definition: elog.h:141
int max_locks_per_xact
Definition: lock.c:54
TimeLineID xlp_tli
Definition: xlog_internal.h:40
int max_wal_senders
Definition: walsender.c:120
XLogRecPtr xlp_pageaddr
Definition: xlog_internal.h:41
#define SizeOfXLogRecord
Definition: xlogrecord.h:55
TransactionId newestCommitTsXid
Definition: pg_control.h:54
#define FirstNormalUnloggedLSN
Definition: xlogdefs.h:36
char mock_authentication_nonce[MOCK_AUTH_NONCE_LEN]
Definition: pg_control.h:227
int MaxConnections
Definition: globals.c:132
Oid oldestMultiDB
Definition: pg_control.h:50
static int openLogFile
Definition: xlog.c:779
static ControlFileData * ControlFile
Definition: xlog.c:721
void SetMultiXactIdLimit(MultiXactId oldest_datminmxid, Oid oldest_datoid, bool is_startup)
Definition: multixact.c:2196
TimeLineID ThisTimeLineID
Definition: xlog.c:187
Oid nextOid
Definition: pg_control.h:44
#define TYPEALIGN(ALIGNVAL, LEN)
Definition: c.h:685
bool fullPageWrites
Definition: pg_control.h:42
bool wal_log_hints
Definition: xlog.c:95
void BootStrapCLOG(void)
Definition: clog.c:712
bool pg_strong_random(void *buf, size_t len)
bool track_commit_timestamp
Definition: pg_control.h:183
#define Assert(condition)
Definition: c.h:739
#define XLP_LONG_HEADER
Definition: xlog_internal.h:79
FullTransactionId nextFullXid
Definition: pg_control.h:43
Oid oldestXidDB
Definition: pg_control.h:48
static void pgstat_report_wait_start(uint32 wait_event_info)
Definition: pgstat.h:1318
void SetTransactionIdLimit(TransactionId oldest_datfrozenxid, Oid oldest_datoid)
Definition: varsup.c:330
uint8 xl_info
Definition: xlogrecord.h:46
MultiXactId nextMulti
Definition: pg_control.h:45
static FullTransactionId FullTransactionIdFromEpochAndXid(uint32 epoch, TransactionId xid)
Definition: transam.h:65
#define XLR_BLOCK_ID_DATA_SHORT
Definition: xlogrecord.h:223
TransactionId xl_xid
Definition: xlogrecord.h:44
TimeLineID ThisTimeLineID
Definition: pg_control.h:39
void * palloc(Size size)
Definition: mcxt.c:949
int errmsg(const char *fmt,...)
Definition: elog.c:822
int max_worker_processes
Definition: globals.c:133
int pg_fsync(int fd)
Definition: fd.c:330
#define close(a)
Definition: win32.h:12
void BootStrapCommitTs(void)
Definition: commit_ts.c:523
#define COMP_CRC32C(crc, data, len)
Definition: pg_crc32c.h:89
#define FIN_CRC32C(crc)
Definition: pg_crc32c.h:94
XLogRecPtr checkPoint
Definition: pg_control.h:129
XLogRecPtr redo
Definition: pg_control.h:37
#define offsetof(type, field)
Definition: c.h:662
#define SizeOfXLogLongPHD
Definition: xlog_internal.h:72
void MultiXactSetNextMXact(MultiXactId nextMulti, MultiXactOffset nextMultiOffset)
Definition: multixact.c:2162

◆ CalculateCheckpointSegments()

static void CalculateCheckpointSegments ( void  )
static

Definition at line 2255 of file xlog.c.

References CheckPointCompletionTarget, CheckPointSegments, ConvertToXSegs, max_wal_size_mb, and wal_segment_size.

Referenced by assign_checkpoint_completion_target(), assign_max_wal_size(), and ReadControlFile().

2256 {
2257  double target;
2258 
2259  /*-------
2260  * Calculate the distance at which to trigger a checkpoint, to avoid
2261  * exceeding max_wal_size_mb. This is based on two assumptions:
2262  *
2263  * a) we keep WAL for only one checkpoint cycle (prior to PG11 we kept
2264  * WAL for two checkpoint cycles to allow us to recover from the
2265  * secondary checkpoint if the first checkpoint failed, though we
2266  * only did this on the master anyway, not on standby. Keeping just
2267  * one checkpoint simplifies processing and reduces disk space in
2268  * many smaller databases.)
2269  * b) during checkpoint, we consume checkpoint_completion_target *
2270  * number of segments consumed between checkpoints.
2271  *-------
2272  */
2273  target = (double) ConvertToXSegs(max_wal_size_mb, wal_segment_size) /
2275 
2276  /* round down */
2277  CheckPointSegments = (int) target;
2278 
2279  if (CheckPointSegments < 1)
2280  CheckPointSegments = 1;
2281 }
#define ConvertToXSegs(x, segsize)
Definition: xlog.c:747
int wal_segment_size
Definition: xlog.c:112
int max_wal_size_mb
Definition: xlog.c:86
int CheckPointSegments
Definition: xlog.c:125
double CheckPointCompletionTarget
Definition: checkpointer.c:149

◆ CancelBackup()

void CancelBackup ( void  )

Definition at line 11488 of file xlog.c.

References BACKUP_LABEL_FILE, BACKUP_LABEL_OLD, DEBUG1, durable_rename(), ereport, errcode_for_file_access(), errdetail(), errmsg(), LOG, stat, TABLESPACE_MAP, TABLESPACE_MAP_OLD, and WARNING.

Referenced by PostmasterStateMachine().

11489 {
11490  struct stat stat_buf;
11491 
11492  /* if the backup_label file is not there, return */
11493  if (stat(BACKUP_LABEL_FILE, &stat_buf) < 0)
11494  return;
11495 
11496  /* remove leftover file from previously canceled backup if it exists */
11497  unlink(BACKUP_LABEL_OLD);
11498 
11500  {
11501  ereport(WARNING,
11503  errmsg("online backup mode was not canceled"),
11504  errdetail("File \"%s\" could not be renamed to \"%s\": %m.",
11506  return;
11507  }
11508 
11509  /* if the tablespace_map file is not there, return */
11510  if (stat(TABLESPACE_MAP, &stat_buf) < 0)
11511  {
11512  ereport(LOG,
11513  (errmsg("online backup mode canceled"),
11514  errdetail("File \"%s\" was renamed to \"%s\".",
11516  return;
11517  }
11518 
11519  /* remove leftover file from previously canceled backup if it exists */
11520  unlink(TABLESPACE_MAP_OLD);
11521 
11523  {
11524  ereport(LOG,
11525  (errmsg("online backup mode canceled"),
11526  errdetail("Files \"%s\" and \"%s\" were renamed to "
11527  "\"%s\" and \"%s\", respectively.",
11530  }
11531  else
11532  {
11533  ereport(WARNING,
11535  errmsg("online backup mode canceled"),
11536  errdetail("File \"%s\" was renamed to \"%s\", but "
11537  "file \"%s\" could not be renamed to \"%s\": %m.",
11540  }
11541 }
#define DEBUG1
Definition: elog.h:25
#define LOG
Definition: elog.h:26
#define BACKUP_LABEL_OLD
Definition: xlog.h:359
#define TABLESPACE_MAP
Definition: xlog.h:361
struct stat stat_buf
Definition: pg_standby.c:100
int errdetail(const char *fmt,...)
Definition: elog.c:955
int errcode_for_file_access(void)
Definition: elog.c:631
#define ereport(elevel, rest)
Definition: elog.h:141
int durable_rename(const char *oldfile, const char *newfile, int elevel)
Definition: fd.c:643
#define WARNING
Definition: elog.h:40
#define stat(a, b)
Definition: win32_port.h:255
#define TABLESPACE_MAP_OLD
Definition: xlog.h:362
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define BACKUP_LABEL_FILE
Definition: xlog.h:358

◆ check_wal_buffers()

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

Definition at line 4875 of file xlog.c.

References XLOGbuffers, and XLOGChooseNumBuffers().

4876 {
4877  /*
4878  * -1 indicates a request for auto-tune.
4879  */
4880  if (*newval == -1)
4881  {
4882  /*
4883  * If we haven't yet changed the boot_val default of -1, just let it
4884  * be. We'll fix it when XLOGShmemSize is called.
4885  */
4886  if (XLOGbuffers == -1)
4887  return true;
4888 
4889  /* Otherwise, substitute the auto-tune value */
4891  }
4892 
4893  /*
4894  * We clamp manually-set values to at least 4 blocks. Prior to PostgreSQL
4895  * 9.1, a minimum of 4 was enforced by guc.c, but since that is no longer
4896  * the case, we just silently treat such values as a request for the
4897  * minimum. (We could throw an error instead, but that doesn't seem very
4898  * helpful.)
4899  */
4900  if (*newval < 4)
4901  *newval = 4;
4902 
4903  return true;
4904 }
static int XLOGChooseNumBuffers(void)
Definition: xlog.c:4859
#define newval
int XLOGbuffers
Definition: xlog.c:89

◆ CheckForStandbyTrigger()

static bool CheckForStandbyTrigger ( void  )
static

Definition at line 12191 of file xlog.c.

References ereport, errcode_for_file_access(), errmsg(), ERROR, FALLBACK_PROMOTE_SIGNAL_FILE, fast_promote, IsPromoteTriggered(), LOG, PROMOTE_SIGNAL_FILE, PromoteTriggerFile, ResetPromoteTriggered(), and stat.

Referenced by ReadRecord(), recoveryApplyDelay(), and WaitForWALToBecomeAvailable().

12192 {
12193  struct stat stat_buf;
12194  static bool triggered = false;
12195 
12196  if (triggered)
12197  return true;
12198 
12199  if (IsPromoteTriggered())
12200  {
12201  /*
12202  * In 9.1 and 9.2 the postmaster unlinked the promote file inside the
12203  * signal handler. It now leaves the file in place and lets the
12204  * Startup process do the unlink. This allows Startup to know whether
12205  * it should create a full checkpoint before starting up (fallback
12206  * mode). Fast promotion takes precedence.
12207  */
12208  if (stat(PROMOTE_SIGNAL_FILE, &stat_buf) == 0)
12209  {
12210  unlink(PROMOTE_SIGNAL_FILE);
12212  fast_promote = true;
12213  }
12214  else if (stat(FALLBACK_PROMOTE_SIGNAL_FILE, &stat_buf) == 0)
12215  {
12217  fast_promote = false;
12218  }
12219 
12220  ereport(LOG, (errmsg("received promote request")));
12221 
12223  triggered = true;
12224  return true;
12225  }
12226 
12227  if (PromoteTriggerFile == NULL || strcmp(PromoteTriggerFile, "") == 0)
12228  return false;
12229 
12230  if (stat(PromoteTriggerFile, &stat_buf) == 0)
12231  {
12232  ereport(LOG,
12233  (errmsg("promote trigger file found: %s", PromoteTriggerFile)));
12234  unlink(PromoteTriggerFile);
12235  triggered = true;
12236  fast_promote = true;
12237  return true;
12238  }
12239  else if (errno != ENOENT)
12240  ereport(ERROR,
12242  errmsg("could not stat promote trigger file \"%s\": %m",
12243  PromoteTriggerFile)));
12244 
12245  return false;
12246 }
char * PromoteTriggerFile
Definition: xlog.c:286
void ResetPromoteTriggered(void)
Definition: startup.c:232
#define PROMOTE_SIGNAL_FILE
Definition: xlog.h:365
#define LOG
Definition: elog.h:26
#define ERROR
Definition: elog.h:43
struct stat stat_buf
Definition: pg_standby.c:100
int errcode_for_file_access(void)
Definition: elog.c:631
bool IsPromoteTriggered(void)
Definition: startup.c:226
#define ereport(elevel, rest)
Definition: elog.h:141
#define FALLBACK_PROMOTE_SIGNAL_FILE
Definition: xlog.h:366
#define stat(a, b)
Definition: win32_port.h:255
int errmsg(const char *fmt,...)
Definition: elog.c:822
static bool fast_promote
Definition: xlog.c:292

◆ CheckPointGuts()

static void CheckPointGuts ( XLogRecPtr  checkPointRedo,
int  flags 
)
static

Definition at line 9017 of file xlog.c.

References CheckPointBuffers(), CheckPointCLOG(), CheckPointCommitTs(), CheckPointLogicalRewriteHeap(), CheckPointMultiXact(), CheckPointPredicate(), CheckPointRelationMap(), CheckPointReplicationOrigin(), CheckPointReplicationSlots(), CheckPointSnapBuild(), CheckPointSUBTRANS(), and CheckPointTwoPhase().

Referenced by CreateCheckPoint(), and CreateRestartPoint().

9018 {
9019  CheckPointCLOG();
9028  CheckPointBuffers(flags); /* performs all required fsyncs */
9030  /* We deliberately delay 2PC checkpointing as long as possible */
9031  CheckPointTwoPhase(checkPointRedo);
9032 }
void CheckPointBuffers(int flags)
Definition: bufmgr.c:2582
void CheckPointLogicalRewriteHeap(void)
Definition: rewriteheap.c:1213
void CheckPointReplicationOrigin(void)
Definition: origin.c:542
void CheckPointSnapBuild(void)
Definition: snapbuild.c:1932
void CheckPointCLOG(void)
Definition: clog.c:842
void CheckPointMultiXact(void)
Definition: multixact.c:2142
void CheckPointCommitTs(void)
Definition: commit_ts.c:760
void CheckPointSUBTRANS(void)
Definition: subtrans.c:302
void CheckPointRelationMap(void)
Definition: relmapper.c:546
void CheckPointPredicate(void)
Definition: predicate.c:1018
void CheckPointTwoPhase(XLogRecPtr redo_horizon)
Definition: twophase.c:1695
void CheckPointReplicationSlots(void)
Definition: slot.c:1074

◆ CheckPromoteSignal()

bool CheckPromoteSignal ( void  )

Definition at line 12263 of file xlog.c.

References FALLBACK_PROMOTE_SIGNAL_FILE, PROMOTE_SIGNAL_FILE, and stat.

Referenced by sigusr1_handler().

12264 {
12265  struct stat stat_buf;
12266 
12267  if (stat(PROMOTE_SIGNAL_FILE, &stat_buf) == 0 ||
12269  return true;
12270 
12271  return false;
12272 }
#define PROMOTE_SIGNAL_FILE
Definition: xlog.h:365
struct stat stat_buf
Definition: pg_standby.c:100
#define FALLBACK_PROMOTE_SIGNAL_FILE
Definition: xlog.h:366
#define stat(a, b)
Definition: win32_port.h:255

◆ CheckRecoveryConsistency()

static void CheckRecoveryConsistency ( void  )
static

Definition at line 7834 of file xlog.c.

References Assert, ControlFileData::backupEndPoint, ControlFileData::backupEndRequired, ControlFileData::backupStartPoint, DEBUG1, elog, ereport, errmsg(), InArchiveRecovery, XLogCtlData::info_lck, InvalidXLogRecPtr, IsUnderPostmaster, XLogCtlData::lastReplayedEndRecPtr, LocalHotStandbyActive, LOG, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), ControlFileData::minRecoveryPoint, minRecoveryPoint, PMSIGNAL_BEGIN_HOT_STANDBY, reachedConsistency, SendPostmasterSignal(), XLogCtlData::SharedHotStandbyActive, SpinLockAcquire, SpinLockRelease, STANDBY_SNAPSHOT_READY, standbyState, UpdateControlFile(), XLogCheckInvalidPages(), and XLogRecPtrIsInvalid.

Referenced by ReadRecord(), and StartupXLOG().

7835 {
7836  XLogRecPtr lastReplayedEndRecPtr;
7837 
7838  /*
7839  * During crash recovery, we don't reach a consistent state until we've
7840  * replayed all the WAL.
7841  */
7843  return;
7844 
7846 
7847  /*
7848  * assume that we are called in the startup process, and hence don't need
7849  * a lock to read lastReplayedEndRecPtr
7850  */
7851  lastReplayedEndRecPtr = XLogCtl->lastReplayedEndRecPtr;
7852 
7853  /*
7854  * Have we reached the point where our base backup was completed?
7855  */
7857  ControlFile->backupEndPoint <= lastReplayedEndRecPtr)
7858  {
7859  /*
7860  * We have reached the end of base backup, as indicated by pg_control.
7861  * The data on disk is now consistent. Reset backupStartPoint and
7862  * backupEndPoint, and update minRecoveryPoint to make sure we don't
7863  * allow starting up at an earlier point even if recovery is stopped
7864  * and restarted soon after this.
7865  */
7866  elog(DEBUG1, "end of backup reached");
7867 
7868  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
7869 
7870  if (ControlFile->minRecoveryPoint < lastReplayedEndRecPtr)
7871  ControlFile->minRecoveryPoint = lastReplayedEndRecPtr;
7872 
7875  ControlFile->backupEndRequired = false;
7877 
7878  LWLockRelease(ControlFileLock);
7879  }
7880 
7881  /*
7882  * Have we passed our safe starting point? Note that minRecoveryPoint is
7883  * known to be incorrectly set if ControlFile->backupEndRequired, until
7884  * the XLOG_BACKUP_END arrives to advise us of the correct
7885  * minRecoveryPoint. All we know prior to that is that we're not
7886  * consistent yet.
7887  */
7889  minRecoveryPoint <= lastReplayedEndRecPtr &&
7891  {
7892  /*
7893  * Check to see if the XLOG sequence contained any unresolved
7894  * references to uninitialized pages.
7895  */
7897 
7898  reachedConsistency = true;
7899  ereport(LOG,
7900  (errmsg("consistent recovery state reached at %X/%X",
7901  (uint32) (lastReplayedEndRecPtr >> 32),
7902  (uint32) lastReplayedEndRecPtr)));
7903  }
7904 
7905  /*
7906  * Have we got a valid starting snapshot that will allow queries to be
7907  * run? If so, we can tell postmaster that the database is consistent now,
7908  * enabling connections.
7909  */
7914  {
7918 
7919  LocalHotStandbyActive = true;
7920 
7922  }
7923 }
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
#define DEBUG1
Definition: elog.h:25
void XLogCheckInvalidPages(void)
Definition: xlogutils.c:220
bool SharedHotStandbyActive
Definition: xlog.c:655
slock_t info_lck
Definition: xlog.c:710
#define LOG
Definition: elog.h:26
bool InArchiveRecovery
Definition: xlog.c:255
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
bool backupEndRequired
Definition: pg_control.h:170
#define SpinLockAcquire(lock)
Definition: spin.h:62
static bool LocalHotStandbyActive
Definition: xlog.c:229
void UpdateControlFile(void)
Definition: xlog.c:4790
bool IsUnderPostmaster
Definition: globals.c:109
unsigned int uint32
Definition: c.h:359
#define ereport(elevel, rest)
Definition: elog.h:141
#define XLogRecPtrIsInvalid(r)
Definition: xlogdefs.h:29
#define SpinLockRelease(lock)
Definition: spin.h:64
static ControlFileData * ControlFile
Definition: xlog.c:721
XLogRecPtr backupEndPoint
Definition: pg_control.h:169
bool reachedConsistency
Definition: xlog.c:844
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:739
static XLogCtlData * XLogCtl
Definition: xlog.c:713
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1122
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define elog(elevel,...)
Definition: elog.h:228
void SendPostmasterSignal(PMSignalReason reason)
Definition: pmsignal.c:146
HotStandbyState standbyState
Definition: xlog.c:203
XLogRecPtr backupStartPoint
Definition: pg_control.h:168
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:166
static XLogRecPtr minRecoveryPoint
Definition: xlog.c:835
XLogRecPtr lastReplayedEndRecPtr
Definition: xlog.c:689

◆ CheckRequiredParameterValues()

static void CheckRequiredParameterValues ( void  )
static

Definition at line 6158 of file xlog.c.

References ArchiveRecoveryRequested, EnableHotStandby, ereport, errhint(), errmsg(), ERROR, max_locks_per_xact, ControlFileData::max_locks_per_xact, max_prepared_xacts, ControlFileData::max_prepared_xacts, max_wal_senders, ControlFileData::max_wal_senders, max_worker_processes, ControlFileData::max_worker_processes, MaxConnections, ControlFileData::MaxConnections, RecoveryRequiresIntParameter, ControlFileData::wal_level, WAL_LEVEL_MINIMAL, WAL_LEVEL_REPLICA, and WARNING.

Referenced by StartupXLOG(), and xlog_redo().

6159 {
6160  /*
6161  * For archive recovery, the WAL must be generated with at least 'replica'
6162  * wal_level.
6163  */
6165  {
6166  ereport(WARNING,
6167  (errmsg("WAL was generated with wal_level=minimal, data may be missing"),
6168  errhint("This happens if you temporarily set wal_level=minimal without taking a new base backup.")));
6169  }
6170 
6171  /*
6172  * For Hot Standby, the WAL must be generated with 'replica' mode, and we
6173  * must have at least as many backend slots as the primary.
6174  */
6176  {
6178  ereport(ERROR,
6179  (errmsg("hot standby is not possible because wal_level was not set to \"replica\" or higher on the master server"),
6180  errhint("Either set wal_level to \"replica\" on the master, or turn off hot_standby here.")));
6181 
6182  /* We ignore autovacuum_max_workers when we make this test. */
6183  RecoveryRequiresIntParameter("max_connections",
6186  RecoveryRequiresIntParameter("max_worker_processes",
6189  RecoveryRequiresIntParameter("max_wal_senders",
6192  RecoveryRequiresIntParameter("max_prepared_transactions",
6195  RecoveryRequiresIntParameter("max_locks_per_transaction",
6198  }
6199 }
bool ArchiveRecoveryRequested
Definition: xlog.c:254
int max_locks_per_xact
Definition: pg_control.h:182
int errhint(const char *fmt,...)
Definition: elog.c:1069
int max_prepared_xacts
Definition: pg_control.h:181
int max_worker_processes
Definition: pg_control.h:179
#define ERROR
Definition: elog.h:43
int max_prepared_xacts
Definition: twophase.c:117
#define ereport(elevel, rest)
Definition: elog.h:141
int max_locks_per_xact
Definition: lock.c:54
int max_wal_senders
Definition: walsender.c:120
#define WARNING
Definition: elog.h:40
int MaxConnections
Definition: globals.c:132
static ControlFileData * ControlFile
Definition: xlog.c:721
bool EnableHotStandby
Definition: xlog.c:93
int errmsg(const char *fmt,...)
Definition: elog.c:822
int max_worker_processes
Definition: globals.c:133
#define RecoveryRequiresIntParameter(param_name, currValue, minValue)
Definition: xlog.c:6136

◆ checkTimeLineSwitch()

static void checkTimeLineSwitch ( XLogRecPtr  lsn,
TimeLineID  newTLI,
TimeLineID  prevTLI 
)
static

Definition at line 9582 of file xlog.c.

References ereport, errmsg(), minRecoveryPoint, minRecoveryPointTLI, PANIC, ThisTimeLineID, tliInHistory(), and XLogRecPtrIsInvalid.

Referenced by StartupXLOG().

9583 {
9584  /* Check that the record agrees on what the current (old) timeline is */
9585  if (prevTLI != ThisTimeLineID)
9586  ereport(PANIC,
9587  (errmsg("unexpected previous timeline ID %u (current timeline ID %u) in checkpoint record",
9588  prevTLI, ThisTimeLineID)));
9589 
9590  /*
9591  * The new timeline better be in the list of timelines we expect to see,
9592  * according to the timeline history. It should also not decrease.
9593  */
9594  if (newTLI < ThisTimeLineID || !tliInHistory(newTLI, expectedTLEs))
9595  ereport(PANIC,
9596  (errmsg("unexpected timeline ID %u (after %u) in checkpoint record",
9597  newTLI, ThisTimeLineID)));
9598 
9599  /*
9600  * If we have not yet reached min recovery point, and we're about to
9601  * switch to a timeline greater than the timeline of the min recovery
9602  * point: trouble. After switching to the new timeline, we could not
9603  * possibly visit the min recovery point on the correct timeline anymore.
9604  * This can happen if there is a newer timeline in the archive that
9605  * branched before the timeline the min recovery point is on, and you
9606  * attempt to do PITR to the new timeline.
9607  */
9609  lsn < minRecoveryPoint &&
9610  newTLI > minRecoveryPointTLI)
9611  ereport(PANIC,
9612  (errmsg("unexpected timeline ID %u in checkpoint record, before reaching minimum recovery point %X/%X on timeline %u",
9613  newTLI,
9614  (uint32) (minRecoveryPoint >> 32),
9617 
9618  /* Looks good */
9619 }
static List * expectedTLEs
Definition: xlog.c:333
#define PANIC
Definition: elog.h:53
unsigned int uint32
Definition: c.h:359
#define ereport(elevel, rest)
Definition: elog.h:141
#define XLogRecPtrIsInvalid(r)
Definition: xlogdefs.h:29
static TimeLineID minRecoveryPointTLI
Definition: xlog.c:836
TimeLineID ThisTimeLineID
Definition: xlog.c:187
int errmsg(const char *fmt,...)
Definition: elog.c:822
bool tliInHistory(TimeLineID tli, List *expectedTLEs)
Definition: timeline.c:517
static XLogRecPtr minRecoveryPoint
Definition: xlog.c:835

◆ checkXLogConsistency()

static void checkXLogConsistency ( XLogReaderState record)
static

Definition at line 1368 of file xlog.c.

References Assert, buf, BUFFER_LOCK_EXCLUSIVE, BufferGetPage, BufferIsValid, RelFileNode::dbNode, elog, XLogReaderState::EndRecPtr, ERROR, FATAL, LockBuffer(), master_image_masked, XLogReaderState::max_block_id, PageGetLSN, RBM_NORMAL_NO_LOG, RelFileNode::relNode, replay_image_masked, RestoreBlockImage(), RmgrData::rm_mask, RmgrTable, RelFileNode::spcNode, UnlockReleaseBuffer(), XLogReadBufferExtended(), XLogRecBlockImageApply, XLogRecGetBlockTag(), XLogRecGetInfo, XLogRecGetRmid, XLogRecHasAnyBlockRefs, XLogRecHasBlockImage, and XLR_CHECK_CONSISTENCY.

Referenced by StartupXLOG().

1369 {
1370  RmgrId rmid = XLogRecGetRmid(record);
1371  RelFileNode rnode;
1372  ForkNumber forknum;
1373  BlockNumber blkno;
1374  int block_id;
1375 
1376  /* Records with no backup blocks have no need for consistency checks. */
1377  if (!XLogRecHasAnyBlockRefs(record))
1378  return;
1379 
1380  Assert((XLogRecGetInfo(record) & XLR_CHECK_CONSISTENCY) != 0);
1381 
1382  for (block_id = 0; block_id <= record->max_block_id; block_id++)
1383  {
1384  Buffer buf;
1385  Page page;
1386 
1387  if (!XLogRecGetBlockTag(record, block_id, &rnode, &forknum, &blkno))
1388  {
1389  /*
1390  * WAL record doesn't contain a block reference with the given id.
1391  * Do nothing.
1392  */
1393  continue;
1394  }
1395 
1396  Assert(XLogRecHasBlockImage(record, block_id));
1397 
1398  if (XLogRecBlockImageApply(record, block_id))
1399  {
1400  /*
1401  * WAL record has already applied the page, so bypass the
1402  * consistency check as that would result in comparing the full
1403  * page stored in the record with itself.
1404  */
1405  continue;
1406  }
1407 
1408  /*
1409  * Read the contents from the current buffer and store it in a
1410  * temporary page.
1411  */
1412  buf = XLogReadBufferExtended(rnode, forknum, blkno,
1414  if (!BufferIsValid(buf))
1415  continue;
1416 
1418  page = BufferGetPage(buf);
1419 
1420  /*
1421  * Take a copy of the local page where WAL has been applied to have a
1422  * comparison base before masking it...
1423  */
1424  memcpy(replay_image_masked, page, BLCKSZ);
1425 
1426  /* No need for this page anymore now that a copy is in. */
1427  UnlockReleaseBuffer(buf);
1428 
1429  /*
1430  * If the block LSN is already ahead of this WAL record, we can't
1431  * expect contents to match. This can happen if recovery is
1432  * restarted.
1433  */
1434  if (PageGetLSN(replay_image_masked) > record->EndRecPtr)
1435  continue;
1436 
1437  /*
1438  * Read the contents from the backup copy, stored in WAL record and
1439  * store it in a temporary page. There is no need to allocate a new
1440  * page here, a local buffer is fine to hold its contents and a mask
1441  * can be directly applied on it.
1442  */
1443  if (!RestoreBlockImage(record, block_id, master_image_masked))
1444  elog(ERROR, "failed to restore block image");
1445 
1446  /*
1447  * If masking function is defined, mask both the master and replay
1448  * images
1449  */
1450  if (RmgrTable[rmid].rm_mask != NULL)
1451  {
1452  RmgrTable[rmid].rm_mask(replay_image_masked, blkno);
1453  RmgrTable[rmid].rm_mask(master_image_masked, blkno);
1454  }
1455 
1456  /* Time to compare the master and replay images. */
1457  if (memcmp(replay_image_masked, master_image_masked, BLCKSZ) != 0)
1458  {
1459  elog(FATAL,
1460  "inconsistent page found, rel %u/%u/%u, forknum %u, blkno %u",
1461  rnode.spcNode, rnode.dbNode, rnode.relNode,
1462  forknum, blkno);
1463  }
1464  }
1465 }
#define XLogRecHasBlockImage(decoder, block_id)
Definition: xlogreader.h:288
Buffer XLogReadBufferExtended(RelFileNode rnode, ForkNumber forknum, BlockNumber blkno, ReadBufferMode mode)
Definition: xlogutils.c:437
const RmgrData RmgrTable[RM_MAX_ID+1]
Definition: rmgr.c:36
uint32 BlockNumber
Definition: block.h:31
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:88
#define XLR_CHECK_CONSISTENCY
Definition: xlogrecord.h:80
XLogRecPtr EndRecPtr
Definition: xlogreader.h:132
static char * replay_image_masked
Definition: xlog.c:264
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3388
#define ERROR
Definition: elog.h:43
#define FATAL
Definition: elog.h:52
static char * buf
Definition: pg_test_fsync.c:67
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define XLogRecGetInfo(decoder)
Definition: xlogreader.h:279
ForkNumber
Definition: relpath.h:40
void(* rm_mask)(char *pagedata, BlockNumber blkno)
bool XLogRecGetBlockTag(XLogReaderState *record, uint8 block_id, RelFileNode *rnode, ForkNumber *forknum, BlockNumber *blknum)
Definition: xlogreader.c:1460
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3602
uint8 RmgrId
Definition: rmgr.h:11
#define Assert(condition)
Definition: c.h:739
#define BufferIsValid(bufnum)
Definition: bufmgr.h:113
bool RestoreBlockImage(XLogReaderState *record, uint8 block_id, char *page)
Definition: xlogreader.c:1513
#define PageGetLSN(page)
Definition: bufpage.h:366
#define elog(elevel,...)
Definition: elog.h:228
#define XLogRecHasAnyBlockRefs(decoder)
Definition: xlogreader.h:285
#define XLogRecBlockImageApply(decoder, block_id)
Definition: xlogreader.h:290
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78
#define XLogRecGetRmid(decoder)
Definition: xlogreader.h:280
static char * master_image_masked
Definition: xlog.c:265

◆ CheckXLogRemoved()

void CheckXLogRemoved ( XLogSegNo  segno,
TimeLineID  tli 
)

Definition at line 3860 of file xlog.c.

References ereport, errcode_for_file_access(), errmsg(), ERROR, filename, XLogCtlData::info_lck, XLogCtlData::lastRemovedSegNo, MAXFNAMELEN, SpinLockAcquire, SpinLockRelease, wal_segment_size, and XLogFileName.

Referenced by logical_read_xlog_page(), perform_base_backup(), and XLogSendPhysical().

3861 {
3862  int save_errno = errno;
3863  XLogSegNo lastRemovedSegNo;
3864 
3866  lastRemovedSegNo = XLogCtl->lastRemovedSegNo;
3868 
3869  if (segno <= lastRemovedSegNo)
3870  {
3871  char filename[MAXFNAMELEN];
3872 
3873  XLogFileName(filename, tli, segno, wal_segment_size);
3874  errno = save_errno;
3875  ereport(ERROR,
3877  errmsg("requested WAL segment %s has already been removed",
3878  filename)));
3879  }
3880  errno = save_errno;
3881 }
int wal_segment_size
Definition: xlog.c:112
slock_t info_lck
Definition: xlog.c:710
XLogSegNo lastRemovedSegNo
Definition: xlog.c:599
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define ERROR
Definition: elog.h:43
uint64 XLogSegNo
Definition: xlogdefs.h:41
int errcode_for_file_access(void)
Definition: elog.c:631
#define ereport(elevel, rest)
Definition: elog.h:141
#define MAXFNAMELEN
#define SpinLockRelease(lock)
Definition: spin.h:64
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
static XLogCtlData * XLogCtl
Definition: xlog.c:713
static char * filename
Definition: pg_dumpall.c:90
int errmsg(const char *fmt,...)
Definition: elog.c:822

◆ CleanupBackupHistory()

static void CleanupBackupHistory ( void  )
static

Definition at line 4223 of file xlog.c.

References AllocateDir(), dirent::d_name, DEBUG2, elog, FreeDir(), IsBackupHistoryFileName, MAXPGPATH, ReadDir(), snprintf, XLogArchiveCheckDone(), XLogArchiveCleanup(), and XLOGDIR.

Referenced by do_pg_stop_backup().

4224 {
4225  DIR *xldir;
4226  struct dirent *xlde;
4227  char path[MAXPGPATH + sizeof(XLOGDIR)];
4228 
4229  xldir = AllocateDir(XLOGDIR);
4230 
4231  while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
4232  {
4233  if (IsBackupHistoryFileName(xlde->d_name))
4234  {
4235  if (XLogArchiveCheckDone(xlde->d_name))
4236  {
4237  elog(DEBUG2, "removing WAL backup history file \"%s\"",
4238  xlde->d_name);
4239  snprintf(path, sizeof(path), XLOGDIR "/%s", xlde->d_name);
4240  unlink(path);
4241  XLogArchiveCleanup(xlde->d_name);
4242  }
4243  }
4244  }
4245 
4246  FreeDir(xldir);
4247 }
Definition: dirent.h:9
void XLogArchiveCleanup(const char *xlog)
Definition: xlogarchive.c:756
Definition: dirent.c:25
bool XLogArchiveCheckDone(const char *xlog)
Definition: xlogarchive.c:616
#define MAXPGPATH
#define DEBUG2
Definition: elog.h:24
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2503
#define IsBackupHistoryFileName(fname)
#define XLOGDIR
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition: fd.c:2569
#define elog(elevel,...)
Definition: elog.h:228
char d_name[MAX_PATH]
Definition: dirent.h:14
#define snprintf
Definition: port.h:192
int FreeDir(DIR *dir)
Definition: fd.c:2621

◆ CopyXLogRecordToWAL()

static void CopyXLogRecordToWAL ( int  write_len,
bool  isLogSwitch,
XLogRecData rdata,
XLogRecPtr  StartPos,
XLogRecPtr  EndPos 
)
static

Definition at line 1472 of file xlog.c.

References Assert, XLogRecData::data, elog, GetXLogBuffer(), INSERT_FREESPACE, XLogRecData::len, MAXALIGN64, MemSet, XLogRecData::next, PANIC, SizeOfXLogLongPHD, SizeOfXLogRecord, SizeOfXLogShortPHD, wal_segment_size, XLogSegmentOffset, XLP_FIRST_IS_CONTRECORD, XLogPageHeaderData::xlp_info, and XLogPageHeaderData::xlp_rem_len.

Referenced by XLogInsertRecord().

1474 {
1475  char *currpos;
1476  int freespace;
1477  int written;
1478  XLogRecPtr CurrPos;
1479  XLogPageHeader pagehdr;
1480 
1481  /*
1482  * Get a pointer to the right place in the right WAL buffer to start
1483  * inserting to.
1484  */
1485  CurrPos = StartPos;
1486  currpos = GetXLogBuffer(CurrPos);
1487  freespace = INSERT_FREESPACE(CurrPos);
1488 
1489  /*
1490  * there should be enough space for at least the first field (xl_tot_len)
1491  * on this page.
1492  */
1493  Assert(freespace >= sizeof(uint32));
1494 
1495  /* Copy record data */
1496  written = 0;
1497  while (rdata != NULL)
1498  {
1499  char *rdata_data = rdata->data;
1500  int rdata_len = rdata->len;
1501 
1502  while (rdata_len > freespace)
1503  {
1504  /*
1505  * Write what fits on this page, and continue on the next page.
1506  */
1507  Assert(CurrPos % XLOG_BLCKSZ >= SizeOfXLogShortPHD || freespace == 0);
1508  memcpy(currpos, rdata_data, freespace);
1509  rdata_data += freespace;
1510  rdata_len -= freespace;
1511  written += freespace;
1512  CurrPos += freespace;
1513 
1514  /*
1515  * Get pointer to beginning of next page, and set the xlp_rem_len
1516  * in the page header. Set XLP_FIRST_IS_CONTRECORD.
1517  *
1518  * It's safe to set the contrecord flag and xlp_rem_len without a
1519  * lock on the page. All the other flags were already set when the
1520  * page was initialized, in AdvanceXLInsertBuffer, and we're the
1521  * only backend that needs to set the contrecord flag.
1522  */
1523  currpos = GetXLogBuffer(CurrPos);
1524  pagehdr = (XLogPageHeader) currpos;
1525  pagehdr->xlp_rem_len = write_len - written;
1526  pagehdr->xlp_info |= XLP_FIRST_IS_CONTRECORD;
1527 
1528  /* skip over the page header */
1529  if (XLogSegmentOffset(CurrPos, wal_segment_size) == 0)
1530  {
1531  CurrPos += SizeOfXLogLongPHD;
1532  currpos += SizeOfXLogLongPHD;
1533  }
1534  else
1535  {
1536  CurrPos += SizeOfXLogShortPHD;
1537  currpos += SizeOfXLogShortPHD;
1538  }
1539  freespace = INSERT_FREESPACE(CurrPos);
1540  }
1541 
1542  Assert(CurrPos % XLOG_BLCKSZ >= SizeOfXLogShortPHD || rdata_len == 0);
1543  memcpy(currpos, rdata_data, rdata_len);
1544  currpos += rdata_len;
1545  CurrPos += rdata_len;
1546  freespace -= rdata_len;
1547  written += rdata_len;
1548 
1549  rdata = rdata->next;
1550  }
1551  Assert(written == write_len);
1552 
1553  /*
1554  * If this was an xlog-switch, it's not enough to write the switch record,
1555  * we also have to consume all the remaining space in the WAL segment. We
1556  * have already reserved that space, but we need to actually fill it.
1557  */
1558  if (isLogSwitch && XLogSegmentOffset(CurrPos, wal_segment_size) != 0)
1559  {
1560  /* An xlog-switch record doesn't contain any data besides the header */
1561  Assert(write_len == SizeOfXLogRecord);
1562 
1563  /* Assert that we did reserve the right amount of space */
1564  Assert(XLogSegmentOffset(EndPos, wal_segment_size) == 0);
1565 
1566  /* Use up all the remaining space on the current page */
1567  CurrPos += freespace;
1568 
1569  /*
1570  * Cause all remaining pages in the segment to be flushed, leaving the
1571  * XLog position where it should be, at the start of the next segment.
1572  * We do this one page at a time, to make sure we don't deadlock
1573  * against ourselves if wal_buffers < wal_segment_size.
1574  */
1575  while (CurrPos < EndPos)
1576  {
1577  /*
1578  * The minimal action to flush the page would be to call
1579  * WALInsertLockUpdateInsertingAt(CurrPos) followed by
1580  * AdvanceXLInsertBuffer(...). The page would be left initialized
1581  * mostly to zeros, except for the page header (always the short
1582  * variant, as this is never a segment's first page).
1583  *
1584  * The large vistas of zeros are good for compressibility, but the
1585  * headers interrupting them every XLOG_BLCKSZ (with values that
1586  * differ from page to page) are not. The effect varies with
1587  * compression tool, but bzip2 for instance compresses about an
1588  * order of magnitude worse if those headers are left in place.
1589  *
1590  * Rather than complicating AdvanceXLInsertBuffer itself (which is
1591  * called in heavily-loaded circumstances as well as this lightly-
1592  * loaded one) with variant behavior, we just use GetXLogBuffer
1593  * (which itself calls the two methods we need) to get the pointer
1594  * and zero most of the page. Then we just zero the page header.
1595  */
1596  currpos = GetXLogBuffer(CurrPos);
1597  MemSet(currpos, 0, SizeOfXLogShortPHD);
1598 
1599  CurrPos += XLOG_BLCKSZ;
1600  }
1601  }
1602  else
1603  {
1604  /* Align the end position, so that the next record starts aligned */
1605  CurrPos = MAXALIGN64(CurrPos);
1606  }
1607 
1608  if (CurrPos != EndPos)
1609  elog(PANIC, "space reserved for WAL record does not match what was written");
1610 }
int wal_segment_size
Definition: xlog.c:112
#define MemSet(start, val, len)
Definition: c.h:962
XLogPageHeaderData * XLogPageHeader
Definition: xlog_internal.h:57
#define PANIC
Definition: elog.h:53
static char * GetXLogBuffer(XLogRecPtr ptr)
Definition: xlog.c:1848
#define MAXALIGN64(LEN)
Definition: c.h:717
unsigned int uint32
Definition: c.h:359
#define INSERT_FREESPACE(endptr)
Definition: xlog.c:727
#define SizeOfXLogRecord
Definition: xlogrecord.h:55
#define XLogSegmentOffset(xlogptr, wal_segsz_bytes)
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:739
#define SizeOfXLogShortPHD
Definition: xlog_internal.h:55
#define XLP_FIRST_IS_CONTRECORD
Definition: xlog_internal.h:77
struct XLogRecData * next
#define elog(elevel,...)
Definition: elog.h:228
#define SizeOfXLogLongPHD
Definition: xlog_internal.h:72

◆ CreateCheckPoint()

void CreateCheckPoint ( int  flags)

Definition at line 8547 of file xlog.c.

References ControlFileData::checkPoint, CHECKPOINT_END_OF_RECOVERY, CHECKPOINT_FORCE, CHECKPOINT_IS_SHUTDOWN, ControlFileData::checkPointCopy, CheckPointGuts(), CheckpointStatsData::ckpt_bufs_written, CheckpointStatsData::ckpt_segs_added, CheckpointStatsData::ckpt_segs_recycled, CheckpointStatsData::ckpt_segs_removed, CheckpointStatsData::ckpt_start_t, XLogCtlData::ckptFullXid, XLogCtlInsert::CurrBytePos, DB_SHUTDOWNED, DB_SHUTDOWNING, DEBUG1, elog, END_CRIT_SECTION, ereport, errmsg(), ERROR, CheckPoint::fullPageWrites, XLogCtlInsert::fullPageWrites, GetCurrentTimestamp(), GetLastImportantRecPtr(), GetOldestActiveTransactionId(), GetOldestXmin(), GetVirtualXIDsDelayingChkpt(), HaveVirtualXIDsDelayingChkpt(), XLogCtlData::info_lck, InitXLogInsert(), Insert(), XLogCtlData::Insert, INSERT_FREESPACE, InvalidTransactionId, InvalidXLogRecPtr, KeepLogSeg(), LocalSetXLogInsertAllowed(), LocalXLogInsertAllowed, log_checkpoints, LogCheckpointEnd(), LogCheckpointStart(), LogStandbySnapshot(), LW_EXCLUSIVE, LW_SHARED, LWLockAcquire(), LWLockRelease(), MemSet, ControlFileData::minRecoveryPoint, ControlFileData::minRecoveryPointTLI, MultiXactGetCheckptMulti(), NBuffers, CheckPoint::newestCommitTsXid, VariableCacheData::newestCommitTsXid, CheckPoint::nextFullXid, VariableCacheData::nextFullXid, CheckPoint::nextMulti, CheckPoint::nextMultiOffset, CheckPoint::nextOid, VariableCacheData::nextOid, VariableCacheData::oidCount, CheckPoint::oldestActiveXid, CheckPoint::oldestCommitTsXid, VariableCacheData::oldestCommitTsXid, CheckPoint::oldestMulti, CheckPoint::oldestMultiDB, CheckPoint::oldestXid, VariableCacheData::oldestXid, CheckPoint::oldestXidDB, VariableCacheData::oldestXidDB, PANIC, pfree(), pg_usleep(), PreallocXlogFiles(), CheckPoint::PrevTimeLineID, XLogCtlData::PrevTimeLineID, PROCARRAY_FLAGS_DEFAULT, ProcLastRecPtr, RecoveryInProgress(), CheckPoint::redo, RedoRecPtr, XLogCtlInsert::RedoRecPtr, XLogCtlData::RedoRecPtr, RemoveOldXlogFiles(), ShmemVariableCache, SizeOfXLogLongPHD, SizeOfXLogShortPHD, SpinLockAcquire, SpinLockRelease, START_CRIT_SECTION, ControlFileData::state, SyncPostCheckpoint(), SyncPreCheckpoint(), CheckPoint::ThisTimeLineID, ThisTimeLineID, CheckPoint::time, ControlFileData::time, TruncateSUBTRANS(), XLogCtlData::ulsn_lck, ControlFileData::unloggedLSN, XLogCtlData::unloggedLSN, UpdateCheckPointDistanceEstimate(), UpdateControlFile(), wal_segment_size, WALInsertLockAcquireExclusive(), WALInsertLockRelease(), XLByteToSeg, XLOG_CHECKPOINT_ONLINE, XLOG_CHECKPOINT_SHUTDOWN, XLogBeginInsert(), XLogBytePosToRecPtr(), XLogFlush(), XLogInsert(), XLogRegisterData(), XLogSegmentOffset, and XLogStandbyInfoActive.

Referenced by CheckpointerMain(), RequestCheckpoint(), ShutdownXLOG(), and StartupXLOG().

8548 {
8549  bool shutdown;
8550  CheckPoint checkPoint;
8551  XLogRecPtr recptr;
8552  XLogSegNo _logSegNo;
8554  uint32 freespace;
8555  XLogRecPtr PriorRedoPtr;
8556  XLogRecPtr curInsert;
8557  XLogRecPtr last_important_lsn;
8558  VirtualTransactionId *vxids;
8559  int nvxids;
8560 
8561  /*
8562  * An end-of-recovery checkpoint is really a shutdown checkpoint, just
8563  * issued at a different time.
8564  */
8566  shutdown = true;
8567  else
8568  shutdown = false;
8569 
8570  /* sanity check */
8571  if (RecoveryInProgress() && (flags & CHECKPOINT_END_OF_RECOVERY) == 0)
8572  elog(ERROR, "can't create a checkpoint during recovery");
8573 
8574  /*
8575  * Initialize InitXLogInsert working areas before entering the critical
8576  * section. Normally, this is done by the first call to
8577  * RecoveryInProgress() or LocalSetXLogInsertAllowed(), but when creating
8578  * an end-of-recovery checkpoint, the LocalSetXLogInsertAllowed call is
8579  * done below in a critical section, and InitXLogInsert cannot be called
8580  * in a critical section.
8581  */
8582  InitXLogInsert();
8583 
8584  /*
8585  * Acquire CheckpointLock to ensure only one checkpoint happens at a time.
8586  * (This is just pro forma, since in the present system structure there is
8587  * only one process that is allowed to issue checkpoints at any given
8588  * time.)
8589  */
8590  LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
8591 
8592  /*
8593  * Prepare to accumulate statistics.
8594  *
8595  * Note: because it is possible for log_checkpoints to change while a
8596  * checkpoint proceeds, we always accumulate stats, even if
8597  * log_checkpoints is currently off.
8598  */
8599  MemSet(&CheckpointStats, 0, sizeof(CheckpointStats));
8601 
8602  /*
8603  * Use a critical section to force system panic if we have trouble.
8604  */
8606 
8607  if (shutdown)
8608  {
8609  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
8611  ControlFile->time = (pg_time_t) time(NULL);
8613  LWLockRelease(ControlFileLock);
8614  }
8615 
8616  /*
8617  * Let smgr prepare for checkpoint; this has to happen before we determine
8618  * the REDO pointer. Note that smgr must not do anything that'd have to
8619  * be undone if we decide no checkpoint is needed.
8620  */
8622 
8623  /* Begin filling in the checkpoint WAL record */
8624  MemSet(&checkPoint, 0, sizeof(checkPoint));
8625  checkPoint.time = (pg_time_t) time(NULL);
8626 
8627  /*
8628  * For Hot Standby, derive the oldestActiveXid before we fix the redo
8629  * pointer. This allows us to begin accumulating changes to assemble our
8630  * starting snapshot of locks and transactions.
8631  */
8632  if (!shutdown && XLogStandbyInfoActive())
8634  else
8636 
8637  /*
8638  * Get location of last important record before acquiring insert locks (as
8639  * GetLastImportantRecPtr() also locks WAL locks).
8640  */
8641  last_important_lsn = GetLastImportantRecPtr();
8642 
8643  /*
8644  * We must block concurrent insertions while examining insert state to
8645  * determine the checkpoint REDO pointer.
8646  */
8648  curInsert = XLogBytePosToRecPtr(Insert->CurrBytePos);
8649 
8650  /*
8651  * If this isn't a shutdown or forced checkpoint, and if there has been no
8652  * WAL activity requiring a checkpoint, skip it. The idea here is to
8653  * avoid inserting duplicate checkpoints when the system is idle.
8654  */
8655  if ((flags & (CHECKPOINT_IS_SHUTDOWN | CHECKPOINT_END_OF_RECOVERY |
8656  CHECKPOINT_FORCE)) == 0)
8657  {
8658  if (last_important_lsn == ControlFile->checkPoint)
8659  {
8661  LWLockRelease(CheckpointLock);
8662  END_CRIT_SECTION();
8663  ereport(DEBUG1,
8664  (errmsg("checkpoint skipped because system is idle")));
8665  return;
8666  }
8667  }
8668 
8669  /*
8670  * An end-of-recovery checkpoint is created before anyone is allowed to
8671  * write WAL. To allow us to write the checkpoint record, temporarily
8672  * enable XLogInsertAllowed. (This also ensures ThisTimeLineID is
8673  * initialized, which we need here and in AdvanceXLInsertBuffer.)
8674  */
8675  if (flags & CHECKPOINT_END_OF_RECOVERY)
8677 
8678  checkPoint.ThisTimeLineID = ThisTimeLineID;
8679  if (flags & CHECKPOINT_END_OF_RECOVERY)
8680  checkPoint.PrevTimeLineID = XLogCtl->PrevTimeLineID;
8681  else
8682  checkPoint.PrevTimeLineID = ThisTimeLineID;
8683 
8684  checkPoint.fullPageWrites = Insert->fullPageWrites;
8685 
8686  /*
8687  * Compute new REDO record ptr = location of next XLOG record.
8688  *
8689  * NB: this is NOT necessarily where the checkpoint record itself will be,
8690  * since other backends may insert more XLOG records while we're off doing
8691  * the buffer flush work. Those XLOG records are logically after the
8692  * checkpoint, even though physically before it. Got that?
8693  */
8694  freespace = INSERT_FREESPACE(curInsert);
8695  if (freespace == 0)
8696  {
8697  if (XLogSegmentOffset(curInsert, wal_segment_size) == 0)
8698  curInsert += SizeOfXLogLongPHD;
8699  else
8700  curInsert += SizeOfXLogShortPHD;
8701  }
8702  checkPoint.redo = curInsert;
8703 
8704  /*
8705  * Here we update the shared RedoRecPtr for future XLogInsert calls; this
8706  * must be done while holding all the insertion locks.
8707  *
8708  * Note: if we fail to complete the checkpoint, RedoRecPtr will be left
8709  * pointing past where it really needs to point. This is okay; the only
8710  * consequence is that XLogInsert might back up whole buffers that it
8711  * didn't really need to. We can't postpone advancing RedoRecPtr because
8712  * XLogInserts that happen while we are dumping buffers must assume that
8713  * their buffer changes are not included in the checkpoint.
8714  */
8715  RedoRecPtr = XLogCtl->Insert.RedoRecPtr = checkPoint.redo;
8716 
8717  /*
8718  * Now we can release the WAL insertion locks, allowing other xacts to
8719  * proceed while we are flushing disk buffers.
8720  */
8722 
8723  /* Update the info_lck-protected copy of RedoRecPtr as well */
8725  XLogCtl->RedoRecPtr = checkPoint.redo;
8727 
8728  /*
8729  * If enabled, log checkpoint start. We postpone this until now so as not
8730  * to log anything if we decided to skip the checkpoint.
8731  */
8732  if (log_checkpoints)
8733  LogCheckpointStart(flags, false);
8734 
8735  TRACE_POSTGRESQL_CHECKPOINT_START(flags);
8736 
8737  /*
8738  * Get the other info we need for the checkpoint record.
8739  *
8740  * We don't need to save oldestClogXid in the checkpoint, it only matters
8741  * for the short period in which clog is being truncated, and if we crash
8742  * during that we'll redo the clog truncation and fix up oldestClogXid
8743  * there.
8744  */
8745  LWLockAcquire(XidGenLock, LW_SHARED);
8747  checkPoint.oldestXid = ShmemVariableCache->oldestXid;
8749  LWLockRelease(XidGenLock);
8750 
8751  LWLockAcquire(CommitTsLock, LW_SHARED);
8754  LWLockRelease(CommitTsLock);
8755 
8756  LWLockAcquire(OidGenLock, LW_SHARED);
8757  checkPoint.nextOid = ShmemVariableCache->nextOid;
8758  if (!shutdown)
8759  checkPoint.nextOid += ShmemVariableCache->oidCount;
8760  LWLockRelease(OidGenLock);
8761 
8762  MultiXactGetCheckptMulti(shutdown,
8763  &checkPoint.nextMulti,
8764  &checkPoint.nextMultiOffset,
8765  &checkPoint.oldestMulti,
8766  &checkPoint.oldestMultiDB);
8767 
8768  /*
8769  * Having constructed the checkpoint record, ensure all shmem disk buffers
8770  * and commit-log buffers are flushed to disk.
8771  *
8772  * This I/O could fail for various reasons. If so, we will fail to
8773  * complete the checkpoint, but there is no reason to force a system
8774  * panic. Accordingly, exit critical section while doing it.
8775  */
8776  END_CRIT_SECTION();
8777 
8778  /*
8779  * In some cases there are groups of actions that must all occur on one
8780  * side or the other of a checkpoint record. Before flushing the
8781  * checkpoint record we must explicitly wait for any backend currently
8782  * performing those groups of actions.
8783  *
8784  * One example is end of transaction, so we must wait for any transactions
8785  * that are currently in commit critical sections. If an xact inserted
8786  * its commit record into XLOG just before the REDO point, then a crash
8787  * restart from the REDO point would not replay that record, which means
8788  * that our flushing had better include the xact's update of pg_xact. So
8789  * we wait till he's out of his commit critical section before proceeding.
8790  * See notes in RecordTransactionCommit().
8791  *
8792  * Because we've already released the insertion locks, this test is a bit
8793  * fuzzy: it is possible that we will wait for xacts we didn't really need
8794  * to wait for. But the delay should be short and it seems better to make
8795  * checkpoint take a bit longer than to hold off insertions longer than
8796  * necessary. (In fact, the whole reason we have this issue is that xact.c
8797  * does commit record XLOG insertion and clog update as two separate steps
8798  * protected by different locks, but again that seems best on grounds of
8799  * minimizing lock contention.)
8800  *
8801  * A transaction that has not yet set delayChkpt when we look cannot be at
8802  * risk, since he's not inserted his commit record yet; and one that's
8803  * already cleared it is not at risk either, since he's done fixing clog
8804  * and we will correctly flush the update below. So we cannot miss any
8805  * xacts we need to wait for.
8806  */
8807  vxids = GetVirtualXIDsDelayingChkpt(&nvxids);
8808  if (nvxids > 0)
8809  {
8810  do
8811  {
8812  pg_usleep(10000L); /* wait for 10 msec */
8813  } while (HaveVirtualXIDsDelayingChkpt(vxids, nvxids));
8814  }
8815  pfree(vxids);
8816 
8817  CheckPointGuts(checkPoint.redo, flags);
8818 
8819  /*
8820  * Take a snapshot of running transactions and write this to WAL. This
8821  * allows us to reconstruct the state of running transactions during
8822  * archive recovery, if required. Skip, if this info disabled.
8823  *
8824  * If we are shutting down, or Startup process is completing crash
8825  * recovery we don't need to write running xact data.
8826  */
8827  if (!shutdown && XLogStandbyInfoActive())
8829 
8831 
8832  /*
8833  * Now insert the checkpoint record into XLOG.
8834  */
8835  XLogBeginInsert();
8836  XLogRegisterData((char *) (&checkPoint), sizeof(checkPoint));
8837  recptr = XLogInsert(RM_XLOG_ID,
8838  shutdown ? XLOG_CHECKPOINT_SHUTDOWN :
8840 
8841  XLogFlush(recptr);
8842 
8843  /*
8844  * We mustn't write any new WAL after a shutdown checkpoint, or it will be
8845  * overwritten at next startup. No-one should even try, this just allows
8846  * sanity-checking. In the case of an end-of-recovery checkpoint, we want
8847  * to just temporarily disable writing until the system has exited
8848  * recovery.
8849  */
8850  if (shutdown)
8851  {
8852  if (flags & CHECKPOINT_END_OF_RECOVERY)
8853  LocalXLogInsertAllowed = -1; /* return to "check" state */
8854  else
8855  LocalXLogInsertAllowed = 0; /* never again write WAL */
8856  }
8857 
8858  /*
8859  * We now have ProcLastRecPtr = start of actual checkpoint record, recptr
8860  * = end of actual checkpoint record.
8861  */
8862  if (shutdown && checkPoint.redo != ProcLastRecPtr)
8863  ereport(PANIC,
8864  (errmsg("concurrent write-ahead log activity while database system is shutting down")));
8865 
8866  /*
8867  * Remember the prior checkpoint's redo ptr for
8868  * UpdateCheckPointDistanceEstimate()
8869  */
8870  PriorRedoPtr = ControlFile->checkPointCopy.redo;
8871 
8872  /*
8873  * Update the control file.
8874  */
8875  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
8876  if (shutdown)
8879  ControlFile->checkPointCopy = checkPoint;
8880  ControlFile->time = (pg_time_t) time(NULL);
8881  /* crash recovery should always recover to the end of WAL */
8884 
8885  /*
8886  * Persist unloggedLSN value. It's reset on crash recovery, so this goes
8887  * unused on non-shutdown checkpoints, but seems useful to store it always
8888  * for debugging purposes.
8889  */
8893 
8895  LWLockRelease(ControlFileLock);
8896 
8897  /* Update shared-memory copy of checkpoint XID/epoch */
8899  XLogCtl->ckptFullXid = checkPoint.nextFullXid;
8901 
8902  /*
8903  * We are now done with critical updates; no need for system panic if we
8904  * have trouble while fooling with old log segments.
8905  */
8906  END_CRIT_SECTION();
8907 
8908  /*
8909  * Let smgr do post-checkpoint cleanup (eg, deleting old files).
8910  */
8912 
8913  /*
8914  * Update the average distance between checkpoints if the prior checkpoint
8915  * exists.
8916  */
8917  if (PriorRedoPtr != InvalidXLogRecPtr)
8919 
8920  /*
8921  * Delete old log files, those no longer needed for last checkpoint to
8922  * prevent the disk holding the xlog from growing full.
8923  */
8925  KeepLogSeg(recptr, &_logSegNo);
8926  _logSegNo--;
8927  RemoveOldXlogFiles(_logSegNo, RedoRecPtr, recptr);
8928 
8929  /*
8930  * Make more log segments if needed. (Do this after recycling old log
8931  * segments, since that may supply some of the needed files.)
8932  */
8933  if (!shutdown)
8934  PreallocXlogFiles(recptr);
8935 
8936  /*
8937  * Truncate pg_subtrans if possible. We can throw away all data before
8938  * the oldest XMIN of any running transaction. No future transaction will
8939  * attempt to reference any pg_subtrans entry older than that (see Asserts
8940  * in subtrans.c). During recovery, though, we mustn't do this because
8941  * StartupSUBTRANS hasn't been called yet.
8942  */
8943  if (!RecoveryInProgress())
8945 
8946  /* Real work is done, but log and update stats before releasing lock. */
8947  LogCheckpointEnd(false);
8948 
8949  TRACE_POSTGRESQL_CHECKPOINT_DONE(CheckpointStats.ckpt_bufs_written,
8950  NBuffers,
8954 
8955  LWLockRelease(CheckpointLock);
8956 }
XLogRecPtr GetLastImportantRecPtr(void)
Definition: xlog.c:8285
static void UpdateCheckPointDistanceEstimate(uint64 nbytes)
Definition: xlog.c:8485
static int LocalXLogInsertAllowed
Definition: xlog.c:241
bool log_checkpoints
Definition: xlog.c:101
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
#define DEBUG1
Definition: elog.h:25
int64 pg_time_t
Definition: pgtime.h:23
static void WALInsertLockRelease(void)
Definition: xlog.c:1690
int wal_segment_size
Definition: xlog.c:112
pg_time_t time
Definition: pg_control.h:128
#define XLOG_CHECKPOINT_ONLINE
Definition: pg_control.h:68
TimeLineID minRecoveryPointTLI
Definition: pg_control.h:167
uint32 oidCount
Definition: transam.h:159
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1583
static XLogRecPtr XLogBytePosToRecPtr(uint64 bytepos)
Definition: xlog.c:1959
XLogRecPtr unloggedLSN
Definition: xlog.c:602
XLogRecPtr ProcLastRecPtr
Definition: xlog.c:351
TransactionId oldestActiveXid
Definition: pg_control.h:63
void InitXLogInsert(void)
Definition: xloginsert.c:1110
TimestampTz ckpt_start_t
Definition: xlog.h:235
slock_t info_lck
Definition: xlog.c:710
#define END_CRIT_SECTION()
Definition: miscadmin.h:134
VirtualTransactionId * GetVirtualXIDsDelayingChkpt(int *nvxids)
Definition: procarray.c:2273
MultiXactId oldestMulti
Definition: pg_control.h:49
TimeLineID PrevTimeLineID
Definition: xlog.c:643
TimeLineID PrevTimeLineID
Definition: pg_control.h:40
#define START_CRIT_SECTION()
Definition: miscadmin.h:132
int ckpt_segs_recycled
Definition: xlog.h:245
TransactionId oldestXid
Definition: transam.h:166
#define MemSet(start, val, len)
Definition: c.h:962
void MultiXactGetCheckptMulti(bool is_shutdown, MultiXactId *nextMulti, MultiXactOffset *nextMultiOffset, MultiXactId *oldestMulti, Oid *oldestMultiDB)
Definition: multixact.c:2120
static void CheckPointGuts(XLogRecPtr checkPointRedo, int flags)
Definition: xlog.c:9017
FullTransactionId nextFullXid
Definition: transam.h:164
CheckPoint checkPointCopy
Definition: pg_control.h:131
XLogCtlInsert Insert
Definition: xlog.c:590
TransactionId oldestXid
Definition: pg_control.h:47
bool RecoveryInProgress(void)
Definition: xlog.c:7935
void TruncateSUBTRANS(TransactionId oldestXact)
Definition: subtrans.c:356
pg_time_t time
Definition: pg_control.h:51
#define PANIC
Definition: elog.h:53
bool fullPageWrites
Definition: xlog.c:565
void XLogFlush(XLogRecPtr record)
Definition: xlog.c:2805
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
#define SpinLockAcquire(lock)
Definition: spin.h:62
void pg_usleep(long microsec)
Definition: signal.c:53
MultiXactOffset nextMultiOffset
Definition: pg_control.h:46
void UpdateControlFile(void)
Definition: xlog.c:4790
TransactionId oldestCommitTsXid
Definition: pg_control.h:52
void pfree(void *pointer)
Definition: mcxt.c:1056
XLogRecPtr LogStandbySnapshot(void)
Definition: standby.c:901
#define ERROR
Definition: elog.h:43
static void LogCheckpointEnd(bool restartpoint)
Definition: xlog.c:8400
static XLogRecPtr RedoRecPtr
Definition: xlog.c:365
#define XLOG_CHECKPOINT_SHUTDOWN
Definition: pg_control.h:67
XLogRecPtr unloggedLSN
Definition: pg_control.h:133
static void PreallocXlogFiles(XLogRecPtr endptr)
Definition: xlog.c:3827
uint64 XLogSegNo
Definition: xlogdefs.h:41
#define CHECKPOINT_END_OF_RECOVERY
Definition: xlog.h:212
VariableCache ShmemVariableCache
Definition: varsup.c:34
#define InvalidTransactionId
Definition: transam.h:31
uint64 CurrBytePos
Definition: xlog.c:541
unsigned int uint32
Definition: c.h:359
XLogRecPtr RedoRecPtr
Definition: xlog.c:594
int ckpt_segs_removed
Definition: xlog.h:244
#define CHECKPOINT_FORCE
Definition: xlog.h:215
#define INSERT_FREESPACE(endptr)
Definition: xlog.c:727
#define ereport(elevel, rest)
Definition: elog.h:141
TransactionId oldestCommitTsXid
Definition: transam.h:176
static void Insert(File file)
Definition: fd.c:1096
int ckpt_bufs_written
Definition: xlog.h:241
static void LocalSetXLogInsertAllowed(void)
Definition: xlog.c:8061
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:323
#define SpinLockRelease(lock)
Definition: spin.h:64
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:415
TransactionId newestCommitTsXid
Definition: pg_control.h:54
#define PROCARRAY_FLAGS_DEFAULT
Definition: procarray.h:50
static void KeepLogSeg(XLogRecPtr recptr, XLogSegNo *logSegNo)
Definition: xlog.c:9337
#define XLogSegmentOffset(xlogptr, wal_segsz_bytes)
Oid oldestMultiDB
Definition: pg_control.h:50
FullTransactionId ckptFullXid
Definition: xlog.c:595
#define XLogStandbyInfoActive()
Definition: xlog.h:195
static ControlFileData * ControlFile
Definition: xlog.c:721
TimeLineID ThisTimeLineID
Definition: xlog.c:187
Oid nextOid
Definition: pg_control.h:44
static void RemoveOldXlogFiles(XLogSegNo segno, XLogRecPtr RedoRecPtr, XLogRecPtr endptr)
Definition: xlog.c:3957
bool fullPageWrites
Definition: pg_control.h:42
TransactionId GetOldestXmin(Relation rel, int flags)
Definition: procarray.c:1306
uint64 XLogRecPtr
Definition: xlogdefs.h:21
FullTransactionId nextFullXid
Definition: pg_control.h:43
Oid oldestXidDB
Definition: pg_control.h:48
TransactionId newestCommitTsXid
Definition: transam.h:177
CheckpointStatsData CheckpointStats
Definition: xlog.c:181
#define SizeOfXLogShortPHD
Definition: xlog_internal.h:55
MultiXactId nextMulti
Definition: pg_control.h:45
static void WALInsertLockAcquireExclusive(void)
Definition: xlog.c:1661
static XLogCtlData * XLogCtl
Definition: xlog.c:713
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1122
int ckpt_segs_added
Definition: xlog.h:243
slock_t ulsn_lck
Definition: xlog.c:603
TimeLineID ThisTimeLineID
Definition: pg_control.h:39
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define elog(elevel,...)
Definition: elog.h:228
void SyncPostCheckpoint(void)
Definition: sync.c:174
TransactionId GetOldestActiveTransactionId(void)
Definition: procarray.c:2111
int NBuffers
Definition: globals.c:131
bool HaveVirtualXIDsDelayingChkpt(VirtualTransactionId *vxids, int nvxids)
Definition: procarray.c:2318
void XLogBeginInsert(void)
Definition: xloginsert.c:120
XLogRecPtr RedoRecPtr
Definition: xlog.c:563
XLogRecPtr checkPoint
Definition: pg_control.h:129
XLogRecPtr redo
Definition: pg_control.h:37
static void LogCheckpointStart(int flags, bool restartpoint)
Definition: xlog.c:8382
#define CHECKPOINT_IS_SHUTDOWN
Definition: xlog.h:211
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:166
void SyncPreCheckpoint(void)
Definition: sync.c:159
#define SizeOfXLogLongPHD
Definition: xlog_internal.h:72
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)

◆ CreateEndOfRecoveryRecord()

static void CreateEndOfRecoveryRecord ( void  )
static

Definition at line 8968 of file xlog.c.

References elog, END_CRIT_SECTION, xl_end_of_recovery::end_time, ERROR, GetCurrentTimestamp(), LocalSetXLogInsertAllowed(), LocalXLogInsertAllowed, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), ControlFileData::minRecoveryPoint, ControlFileData::minRecoveryPointTLI, xl_end_of_recovery::PrevTimeLineID, XLogCtlData::PrevTimeLineID, RecoveryInProgress(), START_CRIT_SECTION, ThisTimeLineID, xl_end_of_recovery::ThisTimeLineID, ControlFileData::time, UpdateControlFile(), WALInsertLockAcquireExclusive(), WALInsertLockRelease(), XLOG_END_OF_RECOVERY, XLogBeginInsert(), XLogFlush(), XLogInsert(), and XLogRegisterData().

Referenced by StartupXLOG().

8969 {
8970  xl_end_of_recovery xlrec;
8971  XLogRecPtr recptr;
8972 
8973  /* sanity check */
8974  if (!RecoveryInProgress())
8975  elog(ERROR, "can only be used to end recovery");
8976 
8977  xlrec.end_time = GetCurrentTimestamp();
8978 
8983 
8985 
8987 
8988  XLogBeginInsert();
8989  XLogRegisterData((char *) &xlrec, sizeof(xl_end_of_recovery));
8990  recptr = XLogInsert(RM_XLOG_ID, XLOG_END_OF_RECOVERY);
8991 
8992  XLogFlush(recptr);
8993 
8994  /*
8995  * Update the control file so that crash recovery can follow the timeline
8996  * changes to this point.
8997  */
8998  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
8999  ControlFile->time = (pg_time_t) time(NULL);
9000  ControlFile->minRecoveryPoint = recptr;
9003  LWLockRelease(ControlFileLock);
9004 
9005  END_CRIT_SECTION();
9006 
9007  LocalXLogInsertAllowed = -1; /* return to "check" state */
9008 }
static int LocalXLogInsertAllowed
Definition: xlog.c:241
int64 pg_time_t
Definition: pgtime.h:23
static void WALInsertLockRelease(void)
Definition: xlog.c:1690
pg_time_t time
Definition: pg_control.h:128
TimeLineID minRecoveryPointTLI
Definition: pg_control.h:167
TimeLineID PrevTimeLineID
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1583
#define END_CRIT_SECTION()
Definition: miscadmin.h:134
TimeLineID PrevTimeLineID
Definition: xlog.c:643
#define START_CRIT_SECTION()
Definition: miscadmin.h:132
bool RecoveryInProgress(void)
Definition: xlog.c:7935
#define XLOG_END_OF_RECOVERY
Definition: pg_control.h:76
void XLogFlush(XLogRecPtr record)
Definition: xlog.c:2805
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
void UpdateControlFile(void)
Definition: xlog.c:4790
#define ERROR
Definition: elog.h:43
static void LocalSetXLogInsertAllowed(void)
Definition: xlog.c:8061
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:323
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:415
static ControlFileData * ControlFile
Definition: xlog.c:721
TimeLineID ThisTimeLineID
Definition: xlog.c:187
TimestampTz end_time
uint64 XLogRecPtr
Definition: xlogdefs.h:21
static void WALInsertLockAcquireExclusive(void)
Definition: xlog.c:1661
static XLogCtlData * XLogCtl
Definition: xlog.c:713
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1122
TimeLineID ThisTimeLineID
#define elog(elevel,...)
Definition: elog.h:228
void XLogBeginInsert(void)
Definition: xloginsert.c:120
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:166

◆ CreateRestartPoint()

bool CreateRestartPoint ( int  flags)

Definition at line 9087 of file xlog.c.

References archiveCleanupCommand, ControlFileData::checkPoint, CHECKPOINT_IS_SHUTDOWN, ControlFileData::checkPointCopy, CheckPointGuts(), CheckpointStatsData::ckpt_start_t, DB_IN_ARCHIVE_RECOVERY, DB_SHUTDOWNED_IN_RECOVERY, DEBUG2, EnableHotStandby, ereport, errdetail(), errmsg(), ExecuteRecoveryCommand(), GetCurrentTimestamp(), GetLatestXTime(), GetOldestXmin(), GetWalRcvWriteRecPtr(), GetXLogReplayRecPtr(), XLogCtlData::info_lck, XLogCtlData::Insert, InvalidXLogRecPtr, KeepLogSeg(), XLogCtlData::lastCheckPoint, XLogCtlData::lastCheckPointEndPtr, XLogCtlData::lastCheckPointRecPtr, LOG, log_checkpoints, LogCheckpointEnd(), LogCheckpointStart(), LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), MemSet, ControlFileData::minRecoveryPoint, minRecoveryPoint, ControlFileData::minRecoveryPointTLI, minRecoveryPointTLI, PreallocXlogFiles(), PROCARRAY_FLAGS_DEFAULT, RecoveryInProgress(), CheckPoint::redo, RedoRecPtr, XLogCtlInsert::RedoRecPtr, XLogCtlData::RedoRecPtr, RemoveOldXlogFiles(), SpinLockAcquire, SpinLockRelease, ControlFileData::state, CheckPoint::ThisTimeLineID, ThisTimeLineID, ControlFileData::time, timestamptz_to_str(), TruncateSUBTRANS(), UpdateCheckPointDistanceEstimate(), UpdateControlFile(), UpdateMinRecoveryPoint(), wal_segment_size, WALInsertLockAcquireExclusive(), WALInsertLockRelease(), XLByteToSeg, and XLogRecPtrIsInvalid.

Referenced by CheckpointerMain(), and ShutdownXLOG().

9088 {
9089  XLogRecPtr lastCheckPointRecPtr;
9090  XLogRecPtr lastCheckPointEndPtr;
9091  CheckPoint lastCheckPoint;
9092  XLogRecPtr PriorRedoPtr;
9093  XLogRecPtr receivePtr;
9094  XLogRecPtr replayPtr;
9095  TimeLineID replayTLI;
9096  XLogRecPtr endptr;
9097  XLogSegNo _logSegNo;
9098  TimestampTz xtime;
9099 
9100  /*
9101  * Acquire CheckpointLock to ensure only one restartpoint or checkpoint
9102  * happens at a time.
9103  */
9104  LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
9105 
9106  /* Get a local copy of the last safe checkpoint record. */
9108  lastCheckPointRecPtr = XLogCtl->lastCheckPointRecPtr;
9109  lastCheckPointEndPtr = XLogCtl->lastCheckPointEndPtr;
9110  lastCheckPoint = XLogCtl->lastCheckPoint;
9112 
9113  /*
9114  * Check that we're still in recovery mode. It's ok if we exit recovery
9115  * mode after this check, the restart point is valid anyway.
9116  */
9117  if (!RecoveryInProgress())
9118  {
9119  ereport(DEBUG2,
9120  (errmsg("skipping restartpoint, recovery has already ended")));
9121  LWLockRelease(CheckpointLock);
9122  return false;
9123  }
9124 
9125  /*
9126  * If the last checkpoint record we've replayed is already our last
9127  * restartpoint, we can't perform a new restart point. We still update
9128  * minRecoveryPoint in that case, so that if this is a shutdown restart
9129  * point, we won't start up earlier than before. That's not strictly
9130  * necessary, but when hot standby is enabled, it would be rather weird if
9131  * the database opened up for read-only connections at a point-in-time
9132  * before the last shutdown. Such time travel is still possible in case of
9133  * immediate shutdown, though.
9134  *
9135  * We don't explicitly advance minRecoveryPoint when we do create a
9136  * restartpoint. It's assumed that flushing the buffers will do that as a
9137  * side-effect.
9138  */
9139  if (XLogRecPtrIsInvalid(lastCheckPointRecPtr) ||
9140  lastCheckPoint.redo <= ControlFile->checkPointCopy.redo)
9141  {
9142  ereport(DEBUG2,
9143  (errmsg("skipping restartpoint, already performed at %X/%X",
9144  (uint32) (lastCheckPoint.redo >> 32),
9145  (uint32) lastCheckPoint.redo)));
9146 
9148  if (flags & CHECKPOINT_IS_SHUTDOWN)
9149  {
9150  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
9152  ControlFile->time = (pg_time_t) time(NULL);
9154  LWLockRelease(ControlFileLock);
9155  }
9156  LWLockRelease(CheckpointLock);
9157  return false;
9158  }
9159 
9160  /*
9161  * Update the shared RedoRecPtr so that the startup process can calculate
9162  * the number of segments replayed since last restartpoint, and request a
9163  * restartpoint if it exceeds CheckPointSegments.
9164  *
9165  * Like in CreateCheckPoint(), hold off insertions to update it, although
9166  * during recovery this is just pro forma, because no WAL insertions are
9167  * happening.
9168  */
9170  RedoRecPtr = XLogCtl->Insert.RedoRecPtr = lastCheckPoint.redo;
9172 
9173  /* Also update the info_lck-protected copy */
9175  XLogCtl->RedoRecPtr = lastCheckPoint.redo;
9177 
9178  /*
9179  * Prepare to accumulate statistics.
9180  *
9181  * Note: because it is possible for log_checkpoints to change while a
9182  * checkpoint proceeds, we always accumulate stats, even if
9183  * log_checkpoints is currently off.
9184  */
9185  MemSet(&CheckpointStats, 0, sizeof(CheckpointStats));
9187 
9188  if (log_checkpoints)
9189  LogCheckpointStart(flags, true);
9190 
9191  CheckPointGuts(lastCheckPoint.redo, flags);
9192 
9193  /*
9194  * Remember the prior checkpoint's redo ptr for
9195  * UpdateCheckPointDistanceEstimate()
9196  */
9197  PriorRedoPtr = ControlFile->checkPointCopy.redo;
9198 
9199  /*
9200  * Update pg_control, using current time. Check that it still shows
9201  * DB_IN_ARCHIVE_RECOVERY state and an older checkpoint, else do nothing;
9202  * this is a quick hack to make sure nothing really bad happens if somehow
9203  * we get here after the end-of-recovery checkpoint.
9204  */
9205  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
9207  ControlFile->checkPointCopy.redo < lastCheckPoint.redo)
9208  {
9209  ControlFile->checkPoint = lastCheckPointRecPtr;
9210  ControlFile->checkPointCopy = lastCheckPoint;
9211  ControlFile->time = (pg_time_t) time(NULL);
9212 
9213  /*
9214  * Ensure minRecoveryPoint is past the checkpoint record. Normally,
9215  * this will have happened already while writing out dirty buffers,
9216  * but not necessarily - e.g. because no buffers were dirtied. We do
9217  * this because a non-exclusive base backup uses minRecoveryPoint to
9218  * determine which WAL files must be included in the backup, and the
9219  * file (or files) containing the checkpoint record must be included,
9220  * at a minimum. Note that for an ordinary restart of recovery there's
9221  * no value in having the minimum recovery point any earlier than this
9222  * anyway, because redo will begin just after the checkpoint record.
9223  */
9224  if (ControlFile->minRecoveryPoint < lastCheckPointEndPtr)
9225  {
9226  ControlFile->minRecoveryPoint = lastCheckPointEndPtr;
9228 
9229  /* update local copy */
9232  }
9233  if (flags & CHECKPOINT_IS_SHUTDOWN)
9236  }
9237  LWLockRelease(ControlFileLock);
9238 
9239  /*
9240  * Update the average distance between checkpoints/restartpoints if the
9241  * prior checkpoint exists.
9242  */
9243  if (PriorRedoPtr != InvalidXLogRecPtr)
9245 
9246  /*
9247  * Delete old log files, those no longer needed for last restartpoint to
9248  * prevent the disk holding the xlog from growing full.
9249  */
9251 
9252  /*
9253  * Retreat _logSegNo using the current end of xlog replayed or received,
9254  * whichever is later.
9255  */
9256  receivePtr = GetWalRcvWriteRecPtr(NULL, NULL);
9257  replayPtr = GetXLogReplayRecPtr(&replayTLI);
9258  endptr = (receivePtr < replayPtr) ? replayPtr : receivePtr;
9259  KeepLogSeg(endptr, &_logSegNo);
9260  _logSegNo--;
9261 
9262  /*
9263  * Try to recycle segments on a useful timeline. If we've been promoted
9264  * since the beginning of this restartpoint, use the new timeline chosen
9265  * at end of recovery (RecoveryInProgress() sets ThisTimeLineID in that
9266  * case). If we're still in recovery, use the timeline we're currently
9267  * replaying.
9268  *
9269  * There is no guarantee that the WAL segments will be useful on the
9270  * current timeline; if recovery proceeds to a new timeline right after
9271  * this, the pre-allocated WAL segments on this timeline will not be used,
9272  * and will go wasted until recycled on the next restartpoint. We'll live
9273  * with that.
9274  */
9275  if (RecoveryInProgress())
9276  ThisTimeLineID = replayTLI;
9277 
9278  RemoveOldXlogFiles(_logSegNo, RedoRecPtr, endptr);
9279 
9280  /*
9281  * Make more log segments if needed. (Do this after recycling old log
9282  * segments, since that may supply some of the needed files.)
9283  */
9284  PreallocXlogFiles(endptr);
9285 
9286  /*
9287  * ThisTimeLineID is normally not set when we're still in recovery.
9288  * However, recycling/preallocating segments above needed ThisTimeLineID
9289  * to determine which timeline to install the segments on. Reset it now,
9290  * to restore the normal state of affairs for debugging purposes.
9291  */
9292  if (RecoveryInProgress())
9293  ThisTimeLineID = 0;
9294 
9295  /*
9296  * Truncate pg_subtrans if possible. We can throw away all data before
9297  * the oldest XMIN of any running transaction. No future transaction will
9298  * attempt to reference any pg_subtrans entry older than that (see Asserts
9299  * in subtrans.c). When hot standby is disabled, though, we mustn't do
9300  * this because StartupSUBTRANS hasn't been called yet.
9301  */
9302  if (EnableHotStandby)
9304 
9305  /* Real work is done, but log and update before releasing lock. */
9306  LogCheckpointEnd(true);
9307 
9308  xtime = GetLatestXTime();
9310  (errmsg("recovery restart point at %X/%X",
9311  (uint32) (lastCheckPoint.redo >> 32), (uint32) lastCheckPoint.redo),
9312  xtime ? errdetail("Last completed transaction was at log time %s.",
9313  timestamptz_to_str(xtime)) : 0));
9314 
9315  LWLockRelease(CheckpointLock);
9316 
9317  /*
9318  * Finally, execute archive_cleanup_command, if any.
9319  */
9320  if (archiveCleanupCommand && strcmp(archiveCleanupCommand, "") != 0)
9322  "archive_cleanup_command",
9323  false);
9324 
9325  return true;
9326 }
static void UpdateCheckPointDistanceEstimate(uint64 nbytes)
Definition: xlog.c:8485
bool log_checkpoints
Definition: xlog.c:101
void ExecuteRecoveryCommand(const char *command, const char *commandName, bool failOnSignal)
Definition: xlogarchive.c:331
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
uint32 TimeLineID
Definition: xlogdefs.h:52
int64 pg_time_t
Definition: pgtime.h:23
XLogRecPtr GetWalRcvWriteRecPtr(XLogRecPtr *latestChunkStart, TimeLineID *receiveTLI)
static void WALInsertLockRelease(void)
Definition: xlog.c:1690
int wal_segment_size
Definition: xlog.c:112
pg_time_t time
Definition: pg_control.h:128
TimeLineID minRecoveryPointTLI
Definition: pg_control.h:167
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1583
int64 TimestampTz
Definition: timestamp.h:39
static void UpdateMinRecoveryPoint(XLogRecPtr lsn, bool force)
Definition: xlog.c:2718
TimestampTz ckpt_start_t
Definition: xlog.h:235
slock_t info_lck
Definition: xlog.c:710
#define MemSet(start, val, len)
Definition: c.h:962
static void CheckPointGuts(XLogRecPtr checkPointRedo, int flags)
Definition: xlog.c:9017
TimestampTz GetLatestXTime(void)
Definition: xlog.c:6074
CheckPoint checkPointCopy
Definition: pg_control.h:131
XLogCtlInsert Insert
Definition: xlog.c:590
#define LOG
Definition: elog.h:26
bool RecoveryInProgress(void)
Definition: xlog.c:7935
void TruncateSUBTRANS(TransactionId oldestXact)
Definition: subtrans.c:356
XLogRecPtr lastCheckPointRecPtr
Definition: xlog.c:679
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
#define SpinLockAcquire(lock)
Definition: spin.h:62
void UpdateControlFile(void)
Definition: xlog.c:4790
static void LogCheckpointEnd(bool restartpoint)
Definition: xlog.c:8400
XLogRecPtr GetXLogReplayRecPtr(TimeLineID *replayTLI)
Definition: xlog.c:11172
#define DEBUG2
Definition: elog.h:24
static XLogRecPtr RedoRecPtr
Definition: xlog.c:365
static void PreallocXlogFiles(XLogRecPtr endptr)
Definition: xlog.c:3827
uint64 XLogSegNo
Definition: xlogdefs.h:41
int errdetail(const char *fmt,...)
Definition: elog.c:955
unsigned int uint32
Definition: c.h:359
XLogRecPtr RedoRecPtr
Definition: xlog.c:594
#define ereport(elevel, rest)
Definition: elog.h:141
CheckPoint lastCheckPoint
Definition: xlog.c:681
#define XLogRecPtrIsInvalid(r)
Definition: xlogdefs.h:29
#define SpinLockRelease(lock)
Definition: spin.h:64
static TimeLineID minRecoveryPointTLI
Definition: xlog.c:836
#define PROCARRAY_FLAGS_DEFAULT
Definition: procarray.h:50
static void KeepLogSeg(XLogRecPtr recptr, XLogSegNo *logSegNo)
Definition: xlog.c:9337
static ControlFileData * ControlFile
Definition: xlog.c:721
TimeLineID ThisTimeLineID
Definition: xlog.c:187
static void RemoveOldXlogFiles(XLogSegNo segno, XLogRecPtr RedoRecPtr, XLogRecPtr endptr)
Definition: xlog.c:3957
TransactionId GetOldestXmin(Relation rel, int flags)
Definition: procarray.c:1306
uint64 XLogRecPtr
Definition: xlogdefs.h:21
CheckpointStatsData CheckpointStats
Definition: xlog.c:181
static void WALInsertLockAcquireExclusive(void)
Definition: xlog.c:1661
static XLogCtlData * XLogCtl
Definition: xlog.c:713
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1122
bool EnableHotStandby
Definition: xlog.c:93
TimeLineID ThisTimeLineID
Definition: pg_control.h:39
int errmsg(const char *fmt,...)
Definition: elog.c:822
XLogRecPtr RedoRecPtr
Definition: xlog.c:563
XLogRecPtr lastCheckPointEndPtr
Definition: xlog.c:680
XLogRecPtr checkPoint
Definition: pg_control.h:129
XLogRecPtr redo
Definition: pg_control.h:37
static void LogCheckpointStart(int flags, bool restartpoint)
Definition: xlog.c:8382
char * archiveCleanupCommand
Definition: xlog.c:270
#define CHECKPOINT_IS_SHUTDOWN
Definition: xlog.h:211
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:166
static XLogRecPtr minRecoveryPoint
Definition: xlog.c:835
const char * timestamptz_to_str(TimestampTz t)
Definition: timestamp.c:1743
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)

◆ DataChecksumsEnabled()

bool DataChecksumsEnabled ( void  )

Definition at line 4819 of file xlog.c.

References Assert, and ControlFileData::data_checksum_version.

Referenced by PageIsVerified(), PageSetChecksumCopy(), PageSetChecksumInplace(), pg_stat_get_db_checksum_failures(), pg_stat_get_db_checksum_last_failure(), ReadControlFile(), and sendFile().

4820 {
4821  Assert(ControlFile != NULL);
4822  return (ControlFile->data_checksum_version > 0);
4823 }
uint32 data_checksum_version
Definition: pg_control.h:220
static ControlFileData * ControlFile
Definition: xlog.c:721
#define Assert(condition)
Definition: c.h:739

◆ do_pg_abort_backup()

void do_pg_abort_backup ( void  )

Definition at line 11144 of file xlog.c.

References Assert, EXCLUSIVE_BACKUP_NONE, XLogCtlInsert::exclusiveBackupState, XLogCtlInsert::forcePageWrites, XLogCtlData::Insert, XLogCtlInsert::nonExclusiveBackups, SESSION_BACKUP_NON_EXCLUSIVE, SESSION_BACKUP_NONE, sessionBackupState, WALInsertLockAcquireExclusive(), and WALInsertLockRelease().

Referenced by base_backup_cleanup(), and nonexclusive_base_backup_cleanup().

11145 {
11146  /*
11147  * Quick exit if session is not keeping around a non-exclusive backup
11148  * already started.
11149  */
11151  return;
11152 
11157 
11160  {
11161  XLogCtl->Insert.forcePageWrites = false;
11162  }
11164 }
static void WALInsertLockRelease(void)
Definition: xlog.c:1690
static SessionBackupState sessionBackupState
Definition: xlog.c:525
XLogCtlInsert Insert
Definition: xlog.c:590
bool forcePageWrites
Definition: xlog.c:564
int nonExclusiveBackups
Definition: xlog.c:576
ExclusiveBackupState exclusiveBackupState
Definition: xlog.c:575
#define Assert(condition)
Definition: c.h:739
static void WALInsertLockAcquireExclusive(void)
Definition: xlog.c:1661
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ do_pg_start_backup()

XLogRecPtr do_pg_start_backup ( const char *  backupidstr,
bool  fast,
TimeLineID starttli_p,
StringInfo  labelfile,
List **  tablespaces,
StringInfo  tblspcmapfile,
bool  infotbssize,
bool  needtblspcmapfile 
)

Definition at line 10220 of file xlog.c.

References AllocateDir(), AllocateFile(), appendStringInfo(), appendStringInfoChar(), BACKUP_LABEL_FILE, backup_started_in_recovery, BoolGetDatum, ControlFileData::checkPoint, CHECKPOINT_FORCE, CHECKPOINT_IMMEDIATE, CHECKPOINT_WAIT, ControlFileData::checkPointCopy, dirent::d_name, StringInfoData::data, DataDir, ereport, errcode(), errcode_for_file_access(), errhint(), errmsg(), ERROR, EXCLUSIVE_BACKUP_IN_PROGRESS, EXCLUSIVE_BACKUP_NONE, EXCLUSIVE_BACKUP_STARTING, XLogCtlInsert::exclusiveBackupState, XLogCtlInsert::forcePageWrites, FreeDir(), FreeFile(), CheckPoint::fullPageWrites, XLogCtlData::info_lck, initStringInfo(), XLogCtlData::Insert, IS_DIR_SEP, lappend(), XLogCtlInsert::lastBackupStart, XLogCtlData::lastFpwDisableRecPtr, StringInfoData::len, log_timezone, LW_SHARED, LWLockAcquire(), LWLockRelease(), makeStringInfo(), MAXFNAMELEN, MAXPGPATH, XLogCtlInsert::nonExclusiveBackups, tablespaceinfo::oid, palloc(), tablespaceinfo::path, pfree(), PG_END_ENSURE_ERROR_CLEANUP, PG_ENSURE_ERROR_CLEANUP, pg_fsync(), pg_localtime(), pg_start_backup_callback(), pg_strftime(), pstrdup(), ReadDir(), readlink, RecoveryInProgress(), CheckPoint::redo, relpath, RequestCheckpoint(), RequestXLogSwitch(), tablespaceinfo::rpath, sendTablespace(), SESSION_BACKUP_EXCLUSIVE, SESSION_BACKUP_NON_EXCLUSIVE, sessionBackupState, tablespaceinfo::size, snprintf, SpinLockAcquire, SpinLockRelease, stat, TABLESPACE_MAP, CheckPoint::ThisTimeLineID, wal_segment_size, WALInsertLockAcquireExclusive(), WALInsertLockRelease(), WARNING, XLByteToSeg, XLogFileName, and XLogIsNeeded.

Referenced by perform_base_backup(), and pg_start_backup().

10224 {
10225  bool exclusive = (labelfile == NULL);
10226  bool backup_started_in_recovery = false;
10227  XLogRecPtr checkpointloc;
10228  XLogRecPtr startpoint;
10229  TimeLineID starttli;
10230  pg_time_t stamp_time;
10231  char strfbuf[128];
10232  char xlogfilename[MAXFNAMELEN];
10233  XLogSegNo _logSegNo;
10234  struct stat stat_buf;
10235  FILE *fp;
10236 
10237  backup_started_in_recovery = RecoveryInProgress();
10238 
10239  /*
10240  * Currently only non-exclusive backup can be taken during recovery.
10241  */
10242  if (backup_started_in_recovery && exclusive)
10243  ereport(ERROR,
10244  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10245  errmsg("recovery is in progress"),
10246  errhint("WAL control functions cannot be executed during recovery.")));
10247 
10248  /*
10249  * During recovery, we don't need to check WAL level. Because, if WAL
10250  * level is not sufficient, it's impossible to get here during recovery.
10251  */
10252  if (!backup_started_in_recovery && !XLogIsNeeded())
10253  ereport(ERROR,
10254  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10255  errmsg("WAL level not sufficient for making an online backup"),
10256  errhint("wal_level must be set to \"replica\" or \"logical\" at server start.")));
10257 
10258  if (strlen(backupidstr) > MAXPGPATH)
10259  ereport(ERROR,
10260  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
10261  errmsg("backup label too long (max %d bytes)",
10262  MAXPGPATH)));
10263 
10264  /*
10265  * Mark backup active in shared memory. We must do full-page WAL writes
10266  * during an on-line backup even if not doing so at other times, because
10267  * it's quite possible for the backup dump to obtain a "torn" (partially
10268  * written) copy of a database page if it reads the page concurrently with
10269  * our write to the same page. This can be fixed as long as the first
10270  * write to the page in the WAL sequence is a full-page write. Hence, we
10271  * turn on forcePageWrites and then force a CHECKPOINT, to ensure there
10272  * are no dirty pages in shared memory that might get dumped while the
10273  * backup is in progress without having a corresponding WAL record. (Once
10274  * the backup is complete, we need not force full-page writes anymore,
10275  * since we expect that any pages not modified during the backup interval
10276  * must have been correctly captured by the backup.)
10277  *
10278  * Note that forcePageWrites has no effect during an online backup from
10279  * the standby.
10280  *
10281  * We must hold all the insertion locks to change the value of
10282  * forcePageWrites, to ensure adequate interlocking against
10283  * XLogInsertRecord().
10284  */
10286  if (exclusive)
10287  {
10288  /*
10289  * At first, mark that we're now starting an exclusive backup, to
10290  * ensure that there are no other sessions currently running
10291  * pg_start_backup() or pg_stop_backup().
10292  */
10294  {
10296  ereport(ERROR,
10297  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10298  errmsg("a backup is already in progress"),
10299  errhint("Run pg_stop_backup() and try again.")));
10300  }
10302  }
10303  else
10305  XLogCtl->Insert.forcePageWrites = true;
10307 
10308  /* Ensure we release forcePageWrites if fail below */
10310  {
10311  bool gotUniqueStartpoint = false;
10312  DIR *tblspcdir;
10313  struct dirent *de;
10314  tablespaceinfo *ti;
10315  int datadirpathlen;
10316 
10317  /*
10318  * Force an XLOG file switch before the checkpoint, to ensure that the
10319  * WAL segment the checkpoint is written to doesn't contain pages with
10320  * old timeline IDs. That would otherwise happen if you called
10321  * pg_start_backup() right after restoring from a PITR archive: the
10322  * first WAL segment containing the startup checkpoint has pages in
10323  * the beginning with the old timeline ID. That can cause trouble at
10324  * recovery: we won't have a history file covering the old timeline if
10325  * pg_wal directory was not included in the base backup and the WAL
10326  * archive was cleared too before starting the backup.
10327  *
10328  * This also ensures that we have emitted a WAL page header that has
10329  * XLP_BKP_REMOVABLE off before we emit the checkpoint record.
10330  * Therefore, if a WAL archiver (such as pglesslog) is trying to
10331  * compress out removable backup blocks, it won't remove any that
10332  * occur after this point.
10333  *
10334  * During recovery, we skip forcing XLOG file switch, which means that
10335  * the backup taken during recovery is not available for the special
10336  * recovery case described above.
10337  */
10338  if (!backup_started_in_recovery)
10339  RequestXLogSwitch(false);
10340 
10341  do
10342  {
10343  bool checkpointfpw;
10344 
10345  /*
10346  * Force a CHECKPOINT. Aside from being necessary to prevent torn
10347  * page problems, this guarantees that two successive backup runs
10348  * will have different checkpoint positions and hence different
10349  * history file names, even if nothing happened in between.
10350  *
10351  * During recovery, establish a restartpoint if possible. We use
10352  * the last restartpoint as the backup starting checkpoint. This
10353  * means that two successive backup runs can have same checkpoint
10354  * positions.
10355  *
10356  * Since the fact that we are executing do_pg_start_backup()
10357  * during recovery means that checkpointer is running, we can use
10358  * RequestCheckpoint() to establish a restartpoint.
10359  *
10360  * We use CHECKPOINT_IMMEDIATE only if requested by user (via
10361  * passing fast = true). Otherwise this can take awhile.
10362  */
10364  (fast ? CHECKPOINT_IMMEDIATE : 0));
10365 
10366  /*
10367  * Now we need to fetch the checkpoint record location, and also
10368  * its REDO pointer. The oldest point in WAL that would be needed
10369  * to restore starting from the checkpoint is precisely the REDO
10370  * pointer.
10371  */
10372  LWLockAcquire(ControlFileLock, LW_SHARED);
10373  checkpointloc = ControlFile->checkPoint;
10374  startpoint = ControlFile->checkPointCopy.redo;
10376  checkpointfpw = ControlFile->checkPointCopy.fullPageWrites;
10377  LWLockRelease(ControlFileLock);
10378 
10379  if (backup_started_in_recovery)
10380  {
10381  XLogRecPtr recptr;
10382 
10383  /*
10384  * Check to see if all WAL replayed during online backup
10385  * (i.e., since last restartpoint used as backup starting
10386  * checkpoint) contain full-page writes.
10387  */
10389  recptr = XLogCtl->lastFpwDisableRecPtr;
10391 
10392  if (!checkpointfpw || startpoint <= recptr)
10393  ereport(ERROR,
10394  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10395  errmsg("WAL generated with full_page_writes=off was replayed "
10396  "since last restartpoint"),
10397  errhint("This means that the backup being taken on the standby "
10398  "is corrupt and should not be used. "
10399  "Enable full_page_writes and run CHECKPOINT on the master, "
10400  "and then try an online backup again.")));
10401 
10402  /*
10403  * During recovery, since we don't use the end-of-backup WAL
10404  * record and don't write the backup history file, the
10405  * starting WAL location doesn't need to be unique. This means
10406  * that two base backups started at the same time might use
10407  * the same checkpoint as starting locations.
10408  */
10409  gotUniqueStartpoint = true;
10410  }
10411 
10412  /*
10413  * If two base backups are started at the same time (in WAL sender
10414  * processes), we need to make sure that they use different
10415  * checkpoints as starting locations, because we use the starting
10416  * WAL location as a unique identifier for the base backup in the
10417  * end-of-backup WAL record and when we write the backup history
10418  * file. Perhaps it would be better generate a separate unique ID
10419  * for each backup instead of forcing another checkpoint, but
10420  * taking a checkpoint right after another is not that expensive
10421  * either because only few buffers have been dirtied yet.
10422  */
10424  if (XLogCtl->Insert.lastBackupStart < startpoint)
10425  {
10426  XLogCtl->Insert.lastBackupStart = startpoint;
10427  gotUniqueStartpoint = true;
10428  }
10430  } while (!gotUniqueStartpoint);
10431 
10432  XLByteToSeg(startpoint, _logSegNo, wal_segment_size);
10433  XLogFileName(xlogfilename, starttli, _logSegNo, wal_segment_size);
10434 
10435  /*
10436  * Construct tablespace_map file
10437  */
10438  if (exclusive)
10439  tblspcmapfile = makeStringInfo();
10440 
10441  datadirpathlen = strlen(DataDir);
10442 
10443  /* Collect information about all tablespaces */
10444  tblspcdir = AllocateDir("pg_tblspc");
10445  while ((de = ReadDir(tblspcdir, "pg_tblspc")) != NULL)
10446  {
10447  char fullpath[MAXPGPATH + 10];
10448  char linkpath[MAXPGPATH];
10449  char *relpath = NULL;
10450  int rllen;
10451  StringInfoData buflinkpath;
10452  char *s = linkpath;
10453 
10454  /* Skip special stuff */
10455  if (strcmp(de->d_name, ".") == 0 || strcmp(de->d_name, "..") == 0)
10456  continue;
10457 
10458  snprintf(fullpath, sizeof(fullpath), "pg_tblspc/%s", de->d_name);
10459 
10460 #if defined(HAVE_READLINK) || defined(WIN32)
10461  rllen = readlink(fullpath, linkpath, sizeof(linkpath));
10462  if (rllen < 0)
10463  {
10464  ereport(WARNING,
10465  (errmsg("could not read symbolic link \"%s\": %m",
10466  fullpath)));
10467  continue;
10468  }
10469  else if (rllen >= sizeof(linkpath))
10470  {
10471  ereport(WARNING,
10472  (errmsg("symbolic link \"%s\" target is too long",
10473  fullpath)));
10474  continue;
10475  }
10476  linkpath[rllen] = '\0';
10477 
10478  /*
10479  * Add the escape character '\\' before newline in a string to
10480  * ensure that we can distinguish between the newline in the
10481  * tablespace path and end of line while reading tablespace_map
10482  * file during archive recovery.
10483  */
10484  initStringInfo(&buflinkpath);
10485 
10486  while (*s)
10487  {
10488  if ((*s == '\n' || *s == '\r') && needtblspcmapfile)
10489  appendStringInfoChar(&buflinkpath, '\\');
10490  appendStringInfoChar(&buflinkpath, *s++);
10491  }
10492 
10493  /*
10494  * Relpath holds the relative path of the tablespace directory
10495  * when it's located within PGDATA, or NULL if it's located
10496  * elsewhere.
10497  */
10498  if (rllen > datadirpathlen &&
10499  strncmp(linkpath, DataDir, datadirpathlen) == 0 &&
10500  IS_DIR_SEP(linkpath[datadirpathlen]))
10501  relpath = linkpath + datadirpathlen + 1;
10502 
10503  ti = palloc(sizeof(tablespaceinfo));
10504  ti->oid = pstrdup(de->d_name);
10505  ti->path = pstrdup(buflinkpath.data);
10506  ti->rpath = relpath ? pstrdup(relpath) : NULL;
10507  ti->size = infotbssize ? sendTablespace(fullpath, true) : -1;
10508 
10509  if (tablespaces)
10510  *tablespaces = lappend(*tablespaces, ti);
10511 
10512  appendStringInfo(tblspcmapfile, "%s %s\n", ti->oid, ti->path);
10513 
10514  pfree(buflinkpath.data);
10515 #else
10516 
10517  /*
10518  * If the platform does not have symbolic links, it should not be
10519  * possible to have tablespaces - clearly somebody else created
10520  * them. Warn about it and ignore.
10521  */
10522  ereport(WARNING,
10523  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
10524  errmsg("tablespaces are not supported on this platform")));
10525 #endif
10526  }
10527  FreeDir(tblspcdir);
10528 
10529  /*
10530  * Construct backup label file
10531  */
10532  if (exclusive)
10533  labelfile = makeStringInfo();
10534 
10535  /* Use the log timezone here, not the session timezone */
10536  stamp_time = (pg_time_t) time(NULL);
10537  pg_strftime(strfbuf, sizeof(strfbuf),
10538  "%Y-%m-%d %H:%M:%S %Z",
10539  pg_localtime(&stamp_time, log_timezone));
10540  appendStringInfo(labelfile, "START WAL LOCATION: %X/%X (file %s)\n",
10541  (uint32) (startpoint >> 32), (uint32) startpoint, xlogfilename);
10542  appendStringInfo(labelfile, "CHECKPOINT LOCATION: %X/%X\n",
10543  (uint32) (checkpointloc >> 32), (uint32) checkpointloc);
10544  appendStringInfo(labelfile, "BACKUP METHOD: %s\n",
10545  exclusive ? "pg_start_backup" : "streamed");
10546  appendStringInfo(labelfile, "BACKUP FROM: %s\n",
10547  backup_started_in_recovery ? "standby" : "master");
10548  appendStringInfo(labelfile, "START TIME: %s\n", strfbuf);
10549  appendStringInfo(labelfile, "LABEL: %s\n", backupidstr);
10550  appendStringInfo(labelfile, "START TIMELINE: %u\n", starttli);
10551 
10552  /*
10553  * Okay, write the file, or return its contents to caller.
10554  */
10555  if (exclusive)
10556  {
10557  /*
10558  * Check for existing backup label --- implies a backup is already
10559  * running. (XXX given that we checked exclusiveBackupState
10560  * above, maybe it would be OK to just unlink any such label
10561  * file?)
10562  */
10563  if (stat(BACKUP_LABEL_FILE, &stat_buf) != 0)
10564  {
10565  if (errno != ENOENT)
10566  ereport(ERROR,
10568  errmsg("could not stat file \"%s\": %m",
10569  BACKUP_LABEL_FILE)));
10570  }
10571  else
10572  ereport(ERROR,
10573  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10574  errmsg("a backup is already in progress"),
10575  errhint("If you're sure there is no backup in progress, remove file \"%s\" and try again.",
10576  BACKUP_LABEL_FILE)));
10577 
10578  fp = AllocateFile(BACKUP_LABEL_FILE, "w");
10579 
10580  if (!fp)
10581  ereport(ERROR,
10583  errmsg("could not create file \"%s\": %m",
10584  BACKUP_LABEL_FILE)));
10585  if (fwrite(labelfile->data, labelfile->len, 1, fp) != 1 ||
10586  fflush(fp) != 0 ||
10587  pg_fsync(fileno(fp)) != 0 ||
10588  ferror(fp) ||
10589  FreeFile(fp))
10590  ereport(ERROR,
10592  errmsg("could not write file \"%s\": %m",
10593  BACKUP_LABEL_FILE)));
10594  /* Allocated locally for exclusive backups, so free separately */
10595  pfree(labelfile->data);
10596  pfree(labelfile);
10597 
10598  /* Write backup tablespace_map file. */
10599  if (tblspcmapfile->len > 0)
10600  {
10601  if (stat(TABLESPACE_MAP, &stat_buf) != 0)
10602  {
10603  if (errno != ENOENT)
10604  ereport(ERROR,
10606  errmsg("could not stat file \"%s\": %m",
10607  TABLESPACE_MAP)));
10608  }
10609  else
10610  ereport(ERROR,
10611  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10612  errmsg("a backup is already in progress"),
10613  errhint("If you're sure there is no backup in progress, remove file \"%s\" and try again.",
10614  TABLESPACE_MAP)));
10615 
10616  fp = AllocateFile(TABLESPACE_MAP, "w");
10617 
10618  if (!fp)
10619  ereport(ERROR,
10621  errmsg("could not create file \"%s\": %m",
10622  TABLESPACE_MAP)));
10623  if (fwrite(tblspcmapfile->data, tblspcmapfile->len, 1, fp) != 1 ||
10624  fflush(fp) != 0 ||
10625  pg_fsync(fileno(fp)) != 0 ||
10626  ferror(fp) ||
10627  FreeFile(fp))
10628  ereport(ERROR,
10630  errmsg("could not write file \"%s\": %m",
10631  TABLESPACE_MAP)));
10632  }
10633 
10634  /* Allocated locally for exclusive backups, so free separately */
10635  pfree(tblspcmapfile->data);
10636  pfree(tblspcmapfile);
10637  }
10638  }
10640 
10641  /*
10642  * Mark that start phase has correctly finished for an exclusive backup.
10643  * Session-level locks are updated as well to reflect that state.
10644  *
10645  * Note that CHECK_FOR_INTERRUPTS() must not occur while updating backup
10646  * counters and session-level lock. Otherwise they can be updated
10647  * inconsistently, and which might cause do_pg_abort_backup() to fail.
10648  */
10649  if (exclusive)
10650  {
10653 
10654  /* Set session-level lock */
10657  }
10658  else
10660 
10661  /*
10662  * We're done. As a convenience, return the starting WAL location.
10663  */
10664  if (starttli_p)
10665  *starttli_p = starttli;
10666  return startpoint;
10667 }
size_t pg_strftime(char *s, size_t max, const char *format, const struct pg_tm *tm)
Definition: strftime.c:122
XLogRecPtr RequestXLogSwitch(bool mark_unimportant)
Definition: xlog.c:9414
int errhint(const char *fmt,...)
Definition: elog.c:1069
uint32 TimeLineID
Definition: xlogdefs.h:52
int64 pg_time_t
Definition: pgtime.h:23
static void WALInsertLockRelease(void)
Definition: xlog.c:1690
int wal_segment_size
Definition: xlog.c:112
XLogRecPtr lastFpwDisableRecPtr
Definition: xlog.c:708
static SessionBackupState sessionBackupState
Definition: xlog.c:525
XLogRecPtr lastBackupStart
Definition: xlog.c:577
char * pstrdup(const char *in)
Definition: mcxt.c:1186
#define XLogIsNeeded()
Definition: xlog.h:181
char * rpath
Definition: basebackup.h:28
StringInfo makeStringInfo(void)
Definition: stringinfo.c:41
slock_t info_lck
Definition: xlog.c:710
int errcode(int sqlerrcode)
Definition: elog.c:608
CheckPoint checkPointCopy
Definition: pg_control.h:131
XLogCtlInsert Insert
Definition: xlog.c:590
bool RecoveryInProgress(void)
Definition: xlog.c:7935
static bool backup_started_in_recovery
Definition: basebackup.c:77
Definition: dirent.h:9
#define IS_DIR_SEP(ch)
Definition: port.h:84
pg_tz * log_timezone
Definition: pgtz.c:31
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
#define TABLESPACE_MAP
Definition: xlog.h:361
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define PG_ENSURE_ERROR_CLEANUP(cleanup_function, arg)
Definition: ipc.h:47
void pfree(void *pointer)
Definition: mcxt.c:1056
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:91
bool forcePageWrites
Definition: xlog.c:564
Definition: dirent.c:25
#define ERROR
Definition: elog.h:43
struct stat stat_buf
Definition: pg_standby.c:100
#define MAXPGPATH
uint64 XLogSegNo
Definition: xlogdefs.h:41
#define readlink(path, buf, size)
Definition: win32_port.h:222
int errcode_for_file_access(void)
Definition: elog.c:631
FILE * AllocateFile(const char *name, const char *mode)
Definition: fd.c:2242
unsigned int uint32
Definition: c.h:359
int64 sendTablespace(char *path, bool sizeonly)
Definition: basebackup.c:970
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2503
#define CHECKPOINT_FORCE
Definition: xlog.h:215
#define ereport(elevel, rest)
Definition: elog.h:141
List * lappend(List *list, void *datum)
Definition: list.c:322
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:188
void initStringInfo(StringInfo str)
Definition: stringinfo.c:59
#define WARNING
Definition: elog.h:40
int nonExclusiveBackups
Definition: xlog.c:576
#define stat(a, b)
Definition: win32_port.h:255
#define MAXFNAMELEN
#define SpinLockRelease(lock)
Definition: spin.h:64
static void pg_start_backup_callback(int code, Datum arg)
Definition: xlog.c:10671
ExclusiveBackupState exclusiveBackupState
Definition: xlog.c:575
uintptr_t Datum
Definition: postgres.h:367
static ControlFileData * ControlFile
Definition: xlog.c:721
#define BoolGetDatum(X)
Definition: postgres.h:402
bool fullPageWrites
Definition: pg_control.h:42
#define CHECKPOINT_WAIT
Definition: xlog.h:219
uint64 XLogRecPtr
Definition: xlogdefs.h:21
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition: fd.c:2569
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
static void WALInsertLockAcquireExclusive(void)
Definition: xlog.c:1661
static XLogCtlData * XLogCtl
Definition: xlog.c:713
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1122
#define PG_END_ENSURE_ERROR_CLEANUP(cleanup_function, arg)
Definition: ipc.h:52
struct pg_tm * pg_localtime(const pg_time_t *timep, const pg_tz *tz)
Definition: localtime.c:1375
int FreeFile(FILE *file)
Definition: fd.c:2441
void * palloc(Size size)
Definition: mcxt.c:949
TimeLineID ThisTimeLineID
Definition: pg_control.h:39
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define CHECKPOINT_IMMEDIATE
Definition: xlog.h:214
#define relpath(rnode, forknum)
Definition: relpath.h:87
char * DataDir
Definition: globals.c:62
#define BACKUP_LABEL_FILE
Definition: xlog.h:358
int pg_fsync(int fd)
Definition: fd.c:330
char d_name[MAX_PATH]
Definition: dirent.h:14
#define snprintf
Definition: port.h:192
XLogRecPtr checkPoint
Definition: pg_control.h:129
XLogRecPtr redo
Definition: pg_control.h:37
int FreeDir(DIR *dir)
Definition: fd.c:2621
void RequestCheckpoint(int flags)
Definition: checkpointer.c:941
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)

◆ do_pg_stop_backup()

XLogRecPtr do_pg_stop_backup ( char *  labelfile,
bool  waitforarchive,
TimeLineID stoptli_p 
)

Definition at line 10739 of file xlog.c.

References AllocateFile(), Assert, BACKUP_LABEL_FILE, backup_started_in_recovery, BackupHistoryFileName, BackupHistoryFilePath, BoolGetDatum, CHECK_FOR_INTERRUPTS, CleanupBackupHistory(), DEBUG1, durable_unlink(), ereport, errcode(), errcode_for_file_access(), errhint(), errmsg(), ERROR, EXCLUSIVE_BACKUP_IN_PROGRESS, EXCLUSIVE_BACKUP_NONE, EXCLUSIVE_BACKUP_STOPPING, XLogCtlInsert::exclusiveBackupState, XLogCtlInsert::forcePageWrites, fprintf, FreeFile(), XLogCtlData::info_lck, XLogCtlData::Insert, XLogCtlData::lastFpwDisableRecPtr, log_timezone, LW_SHARED, LWLockAcquire(), LWLockRelease(), MAXFNAMELEN, MAXPGPATH, ControlFileData::minRecoveryPoint, ControlFileData::minRecoveryPointTLI, XLogCtlInsert::nonExclusiveBackups, NOTICE, palloc(), PG_END_ENSURE_ERROR_CLEANUP, PG_ENSURE_ERROR_CLEANUP, pg_localtime(), pg_stop_backup_callback(), pg_strftime(), pg_usleep(), RecoveryInProgress(), remaining, RequestXLogSwitch(), SESSION_BACKUP_NONE, sessionBackupState, SpinLockAcquire, SpinLockRelease, stat, TABLESPACE_MAP, ThisTimeLineID, wal_segment_size, WALInsertLockAcquireExclusive(), WALInsertLockRelease(), WARNING, XLByteToPrevSeg, XLByteToSeg, XLOG_BACKUP_END, XLogArchiveIsBusy(), XLogArchivingActive, XLogArchivingAlways, XLogBeginInsert(), XLogFileName, XLogInsert(), XLogIsNeeded, and XLogRegisterData().

Referenced by perform_base_backup(), pg_stop_backup(), and pg_stop_backup_v2().

10740 {
10741  bool exclusive = (labelfile == NULL);
10742  bool backup_started_in_recovery = false;
10743  XLogRecPtr startpoint;
10744  XLogRecPtr stoppoint;
10745  TimeLineID stoptli;
10746  pg_time_t stamp_time;
10747  char strfbuf[128];
10748  char histfilepath[MAXPGPATH];
10749  char startxlogfilename[MAXFNAMELEN];
10750  char stopxlogfilename[MAXFNAMELEN];
10751  char lastxlogfilename[MAXFNAMELEN];
10752  char histfilename[MAXFNAMELEN];
10753  char backupfrom[20];
10754  XLogSegNo _logSegNo;
10755  FILE *lfp;
10756  FILE *fp;
10757  char ch;
10758  int seconds_before_warning;
10759  int waits = 0;
10760  bool reported_waiting = false;
10761  char *remaining;
10762  char *ptr;
10763  uint32 hi,
10764  lo;
10765 
10766  backup_started_in_recovery = RecoveryInProgress();
10767 
10768  /*
10769  * Currently only non-exclusive backup can be taken during recovery.
10770  */
10771  if (backup_started_in_recovery && exclusive)
10772  ereport(ERROR,
10773  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10774  errmsg("recovery is in progress"),
10775  errhint("WAL control functions cannot be executed during recovery.")));
10776 
10777  /*
10778  * During recovery, we don't need to check WAL level. Because, if WAL
10779  * level is not sufficient, it's impossible to get here during recovery.
10780  */
10781  if (!backup_started_in_recovery && !XLogIsNeeded())
10782  ereport(ERROR,
10783  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10784  errmsg("WAL level not sufficient for making an online backup"),
10785  errhint("wal_level must be set to \"replica\" or \"logical\" at server start.")));
10786 
10787  if (exclusive)
10788  {
10789  /*
10790  * At first, mark that we're now stopping an exclusive backup, to
10791  * ensure that there are no other sessions currently running
10792  * pg_start_backup() or pg_stop_backup().
10793  */
10796  {
10798  ereport(ERROR,
10799  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10800  errmsg("exclusive backup not in progress")));
10801  }
10804 
10805  /*
10806  * Remove backup_label. In case of failure, the state for an exclusive
10807  * backup is switched back to in-progress.
10808  */
10810  {
10811  /*
10812  * Read the existing label file into memory.
10813  */
10814  struct stat statbuf;
10815  int r;
10816 
10817  if (stat(BACKUP_LABEL_FILE, &statbuf))
10818  {
10819  /* should not happen per the upper checks */
10820  if (errno != ENOENT)
10821  ereport(ERROR,
10823  errmsg("could not stat file \"%s\": %m",
10824  BACKUP_LABEL_FILE)));
10825  ereport(ERROR,
10826  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10827  errmsg("a backup is not in progress")));
10828  }
10829 
10830  lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
10831  if (!lfp)
10832  {
10833  ereport(ERROR,
10835  errmsg("could not read file \"%s\": %m",
10836  BACKUP_LABEL_FILE)));
10837  }
10838  labelfile = palloc(statbuf.st_size + 1);
10839  r = fread(labelfile, statbuf.st_size, 1, lfp);
10840  labelfile[statbuf.st_size] = '\0';
10841 
10842  /*
10843  * Close and remove the backup label file
10844  */
10845  if (r != 1 || ferror(lfp) || FreeFile(lfp))
10846  ereport(ERROR,
10848  errmsg("could not read file \"%s\": %m",
10849  BACKUP_LABEL_FILE)));
10851 
10852  /*
10853  * Remove tablespace_map file if present, it is created only if
10854  * there are tablespaces.
10855  */
10857  }
10859  }
10860 
10861  /*
10862  * OK to update backup counters, forcePageWrites and session-level lock.
10863  *
10864  * Note that CHECK_FOR_INTERRUPTS() must not occur while updating them.
10865  * Otherwise they can be updated inconsistently, and which might cause
10866  * do_pg_abort_backup() to fail.
10867  */
10869  if (exclusive)
10870  {
10872  }
10873  else
10874  {
10875  /*
10876  * The user-visible pg_start/stop_backup() functions that operate on
10877  * exclusive backups can be called at any time, but for non-exclusive
10878  * backups, it is expected that each do_pg_start_backup() call is
10879  * matched by exactly one do_pg_stop_backup() call.
10880  */
10883  }
10884 
10887  {
10888  XLogCtl->Insert.forcePageWrites = false;
10889  }
10890 
10891  /*
10892  * Clean up session-level lock.
10893  *
10894  * You might think that WALInsertLockRelease() can be called before
10895  * cleaning up session-level lock because session-level lock doesn't need
10896  * to be protected with WAL insertion lock. But since
10897  * CHECK_FOR_INTERRUPTS() can occur in it, session-level lock must be
10898  * cleaned up before it.
10899  */
10901 
10903 
10904  /*
10905  * Read and parse the START WAL LOCATION line (this code is pretty crude,
10906  * but we are not expecting any variability in the file format).
10907  */
10908  if (sscanf(labelfile, "START WAL LOCATION: %X/%X (file %24s)%c",
10909  &hi, &lo, startxlogfilename,
10910  &ch) != 4 || ch != '\n')
10911  ereport(ERROR,
10912  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10913  errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
10914  startpoint = ((uint64) hi) << 32 | lo;
10915  remaining = strchr(labelfile, '\n') + 1; /* %n is not portable enough */
10916 
10917  /*
10918  * Parse the BACKUP FROM line. If we are taking an online backup from the
10919  * standby, we confirm that the standby has not been promoted during the
10920  * backup.
10921  */
10922  ptr = strstr(remaining, "BACKUP FROM:");
10923  if (!ptr || sscanf(ptr, "BACKUP FROM: %19s\n", backupfrom) != 1)
10924  ereport(ERROR,
10925  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10926  errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
10927  if (strcmp(backupfrom, "standby") == 0 && !backup_started_in_recovery)
10928  ereport(ERROR,
10929  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10930  errmsg("the standby was promoted during online backup"),
10931  errhint("This means that the backup being taken is corrupt "
10932  "and should not be used. "
10933  "Try taking another online backup.")));
10934 
10935  /*
10936  * During recovery, we don't write an end-of-backup record. We assume that
10937  * pg_control was backed up last and its minimum recovery point can be
10938  * available as the backup end location. Since we don't have an
10939  * end-of-backup record, we use the pg_control value to check whether
10940  * we've reached the end of backup when starting recovery from this
10941  * backup. We have no way of checking if pg_control wasn't backed up last
10942  * however.
10943  *
10944  * We don't force a switch to new WAL file but it is still possible to
10945  * wait for all the required files to be archived if waitforarchive is
10946  * true. This is okay if we use the backup to start a standby and fetch
10947  * the missing WAL using streaming replication. But in the case of an
10948  * archive recovery, a user should set waitforarchive to true and wait for
10949  * them to be archived to ensure that all the required files are
10950  * available.
10951  *
10952  * We return the current minimum recovery point as the backup end
10953  * location. Note that it can be greater than the exact backup end
10954  * location if the minimum recovery point is updated after the backup of
10955  * pg_control. This is harmless for current uses.
10956  *
10957  * XXX currently a backup history file is for informational and debug
10958  * purposes only. It's not essential for an online backup. Furthermore,
10959  * even if it's created, it will not be archived during recovery because
10960  * an archiver is not invoked. So it doesn't seem worthwhile to write a
10961  * backup history file during recovery.
10962  */
10963  if (backup_started_in_recovery)
10964  {
10965  XLogRecPtr recptr;
10966 
10967  /*
10968  * Check to see if all WAL replayed during online backup contain
10969  * full-page writes.
10970  */
10972  recptr = XLogCtl->lastFpwDisableRecPtr;
10974 
10975  if (startpoint <= recptr)
10976  ereport(ERROR,
10977  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10978  errmsg("WAL generated with full_page_writes=off was replayed "
10979  "during online backup"),
10980  errhint("This means that the backup being taken on the standby "
10981  "is corrupt and should not be used. "
10982  "Enable full_page_writes and run CHECKPOINT on the master, "
10983  "and then try an online backup again.")));
10984 
10985 
10986  LWLockAcquire(ControlFileLock, LW_SHARED);
10987  stoppoint = ControlFile->minRecoveryPoint;
10988  stoptli = ControlFile->minRecoveryPointTLI;
10989  LWLockRelease(ControlFileLock);
10990  }
10991  else
10992  {
10993  /*
10994  * Write the backup-end xlog record
10995  */
10996  XLogBeginInsert();
10997  XLogRegisterData((char *) (&startpoint), sizeof(startpoint));
10998  stoppoint = XLogInsert(RM_XLOG_ID, XLOG_BACKUP_END);
10999  stoptli = ThisTimeLineID;
11000 
11001  /*
11002  * Force a switch to a new xlog segment file, so that the backup is
11003  * valid as soon as archiver moves out the current segment file.
11004  */
11005  RequestXLogSwitch(false);
11006 
11007  XLByteToPrevSeg(stoppoint, _logSegNo, wal_segment_size);
11008  XLogFileName(stopxlogfilename, stoptli, _logSegNo, wal_segment_size);
11009 
11010  /* Use the log timezone here, not the session timezone */
11011  stamp_time = (pg_time_t) time(NULL);
11012  pg_strftime(strfbuf, sizeof(strfbuf),
11013  "%Y-%m-%d %H:%M:%S %Z",
11014  pg_localtime(&stamp_time, log_timezone));
11015 
11016  /*
11017  * Write the backup history file
11018  */
11019  XLByteToSeg(startpoint, _logSegNo, wal_segment_size);
11020  BackupHistoryFilePath(histfilepath, stoptli, _logSegNo,
11021  startpoint, wal_segment_size);
11022  fp = AllocateFile(histfilepath, "w");
11023  if (!fp)
11024  ereport(ERROR,
11026  errmsg("could not create file \"%s\": %m",
11027  histfilepath)));
11028  fprintf(fp, "START WAL LOCATION: %X/%X (file %s)\n",
11029  (uint32) (startpoint >> 32), (uint32) startpoint, startxlogfilename);
11030  fprintf(fp, "STOP WAL LOCATION: %X/%X (file %s)\n",
11031  (uint32) (stoppoint >> 32), (uint32) stoppoint, stopxlogfilename);
11032 
11033  /*
11034  * Transfer remaining lines including label and start timeline to
11035  * history file.
11036  */
11037  fprintf(fp, "%s", remaining);
11038  fprintf(fp, "STOP TIME: %s\n", strfbuf);
11039  fprintf(fp, "STOP TIMELINE: %u\n", stoptli);
11040  if (fflush(fp) || ferror(fp) || FreeFile(fp))
11041  ereport(ERROR,
11043  errmsg("could not write file \"%s\": %m",
11044  histfilepath)));
11045 
11046  /*
11047  * Clean out any no-longer-needed history files. As a side effect,
11048  * this will post a .ready file for the newly created history file,
11049  * notifying the archiver that history file may be archived
11050  * immediately.
11051  */
11053  }
11054 
11055  /*
11056  * If archiving is enabled, wait for all the required WAL files to be
11057  * archived before returning. If archiving isn't enabled, the required WAL
11058  * needs to be transported via streaming replication (hopefully with
11059  * wal_keep_segments set high enough), or some more exotic mechanism like
11060  * polling and copying files from pg_wal with script. We have no knowledge
11061  * of those mechanisms, so it's up to the user to ensure that he gets all
11062  * the required WAL.
11063  *
11064  * We wait until both the last WAL file filled during backup and the
11065  * history file have been archived, and assume that the alphabetic sorting
11066  * property of the WAL files ensures any earlier WAL files are safely
11067  * archived as well.
11068  *
11069  * We wait forever, since archive_command is supposed to work and we
11070  * assume the admin wanted his backup to work completely. If you don't
11071  * wish to wait, then either waitforarchive should be passed in as false,
11072  * or you can set statement_timeout. Also, some notices are issued to
11073  * clue in anyone who might be doing this interactively.
11074  */
11075 
11076  if (waitforarchive &&
11077  ((!backup_started_in_recovery && XLogArchivingActive()) ||
11078  (backup_started_in_recovery && XLogArchivingAlways())))
11079  {
11080  XLByteToPrevSeg(stoppoint, _logSegNo, wal_segment_size);
11081  XLogFileName(lastxlogfilename, stoptli, _logSegNo, wal_segment_size);
11082 
11083  XLByteToSeg(startpoint, _logSegNo, wal_segment_size);
11084  BackupHistoryFileName(histfilename, stoptli, _logSegNo,
11085  startpoint, wal_segment_size);
11086 
11087  seconds_before_warning = 60;
11088  waits = 0;
11089 
11090  while (XLogArchiveIsBusy(lastxlogfilename) ||
11091  XLogArchiveIsBusy(histfilename))
11092  {
11094 
11095  if (!reported_waiting && waits > 5)
11096  {
11097  ereport(NOTICE,
11098  (errmsg("base backup done, waiting for required WAL segments to be archived")));
11099  reported_waiting = true;
11100  }
11101 
11102  pg_usleep(1000000L);
11103 
11104  if (++waits >= seconds_before_warning)
11105  {
11106  seconds_before_warning *= 2; /* This wraps in >10 years... */
11107  ereport(WARNING,
11108  (errmsg("still waiting for all required WAL segments to be archived (%d seconds elapsed)",
11109  waits),
11110  errhint("Check that your archive_command is executing properly. "
11111  "You can safely cancel this backup, "
11112  "but the database backup will not be usable without all the WAL segments.")));
11113  }
11114  }
11115 
11116  ereport(NOTICE,
11117  (errmsg("all required WAL segments have been archived")));
11118  }
11119  else if (waitforarchive)
11120  ereport(NOTICE,
11121  (errmsg("WAL archiving is not enabled; you must ensure that all required WAL segments are copied through other means to complete the backup")));
11122 
11123  /*
11124  * We're done. As a convenience, return the ending WAL location.
11125  */
11126  if (stoptli_p)
11127  *stoptli_p = stoptli;
11128  return stoppoint;
11129 }
int remaining
Definition: informix.c:667
size_t pg_strftime(char *s, size_t max, const char *format, const struct pg_tm *tm)
Definition: strftime.c:122
XLogRecPtr RequestXLogSwitch(bool mark_unimportant)
Definition: xlog.c:9414
#define DEBUG1
Definition: elog.h:25
int errhint(const char *fmt,...)
Definition: elog.c:1069
uint32 TimeLineID
Definition: xlogdefs.h:52
int64 pg_time_t
Definition: pgtime.h:23
static void WALInsertLockRelease(void)
Definition: xlog.c:1690
int wal_segment_size
Definition: xlog.c:112
TimeLineID minRecoveryPointTLI
Definition: pg_control.h:167
XLogRecPtr lastFpwDisableRecPtr
Definition: xlog.c:708
static SessionBackupState sessionBackupState
Definition: xlog.c:525
#define XLByteToPrevSeg(xlrp, logSegNo, wal_segsz_bytes)
#define XLogIsNeeded()
Definition: xlog.h:181
slock_t info_lck
Definition: xlog.c:710
int errcode(int sqlerrcode)
Definition: elog.c:608
XLogCtlInsert Insert
Definition: xlog.c:590
#define BackupHistoryFileName(fname, tli, logSegNo, startpoint, wal_segsz_bytes)
bool RecoveryInProgress(void)
Definition: xlog.c:7935
static bool backup_started_in_recovery
Definition: basebackup.c:77
#define fprintf
Definition: port.h:196
pg_tz * log_timezone
Definition: pgtz.c:31
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
#define TABLESPACE_MAP
Definition: xlog.h:361
#define SpinLockAcquire(lock)
Definition: spin.h:62
void pg_usleep(long microsec)
Definition: signal.c:53
#define PG_ENSURE_ERROR_CLEANUP(cleanup_function, arg)
Definition: ipc.h:47
#define XLogArchivingAlways()
Definition: xlog.h:173
bool forcePageWrites
Definition: xlog.c:564
#define ERROR
Definition: elog.h:43
static void CleanupBackupHistory(void)
Definition: xlog.c:4223
#define MAXPGPATH
uint64 XLogSegNo
Definition: xlogdefs.h:41
int errcode_for_file_access(void)
Definition: elog.c:631
FILE * AllocateFile(const char *name, const char *mode)
Definition: fd.c:2242
unsigned int uint32
Definition: c.h:359
#define ereport(elevel, rest)
Definition: elog.h:141
#define XLOG_BACKUP_END
Definition: pg_control.h:72
#define WARNING
Definition: elog.h:40
int nonExclusiveBackups
Definition: xlog.c:576
#define stat(a, b)
Definition: win32_port.h:255
#define MAXFNAMELEN
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:323
#define SpinLockRelease(lock)
Definition: spin.h:64
#define BackupHistoryFilePath(path, tli, logSegNo, startpoint, wal_segsz_bytes)
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:415
ExclusiveBackupState exclusiveBackupState
Definition: xlog.c:575
uintptr_t Datum
Definition: postgres.h:367
static ControlFileData * ControlFile
Definition: xlog.c:721
#define BoolGetDatum(X)
Definition: postgres.h:402
TimeLineID ThisTimeLineID
Definition: xlog.c:187
#define NOTICE
Definition: elog.h:37
bool XLogArchiveIsBusy(const char *xlog)
Definition: xlogarchive.c:663
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:739
#define XLogArchivingActive()
Definition: xlog.h:170
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
static void WALInsertLockAcquireExclusive(void)
Definition: xlog.c:1661
static XLogCtlData * XLogCtl
Definition: xlog.c:713
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1122
static void pg_stop_backup_callback(int code, Datum arg)
Definition: xlog.c:10700
#define PG_END_ENSURE_ERROR_CLEANUP(cleanup_function, arg)
Definition: ipc.h:52
struct pg_tm * pg_localtime(const pg_time_t *timep, const pg_tz *tz)
Definition: localtime.c:1375
int durable_unlink(const char *fname, int elevel)
Definition: fd.c:733
int FreeFile(FILE *file)
Definition: fd.c:2441
void * palloc(Size size)
Definition: mcxt.c:949
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define BACKUP_LABEL_FILE
Definition: xlog.h:358
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
void XLogBeginInsert(void)
Definition: xloginsert.c:120
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:166
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)

◆ emode_for_corrupt_record()

static int emode_for_corrupt_record ( int  emode,
XLogRecPtr  RecPtr 
)
static

Definition at line 12172 of file xlog.c.

References DEBUG1, LOG, readSource, and XLOG_FROM_PG_WAL.

Referenced by ReadRecord(), and XLogPageRead().

12173 {
12174  static XLogRecPtr lastComplaint = 0;
12175 
12176  if (readSource == XLOG_FROM_PG_WAL && emode == LOG)
12177  {
12178  if (RecPtr == lastComplaint)
12179  emode = DEBUG1;
12180  else
12181  lastComplaint = RecPtr;
12182  }
12183  return emode;
12184 }
#define DEBUG1
Definition: elog.h:25
static XLogSource readSource
Definition: xlog.c:794
#define LOG
Definition: elog.h:26
uint64 XLogRecPtr
Definition: xlogdefs.h:21

◆ exitArchiveRecovery()

static void exitArchiveRecovery ( TimeLineID  endTLI,
XLogRecPtr  endOfLog 
)
static

Definition at line 5459 of file xlog.c.

References Assert, close, durable_unlink(), ereport, errcode_for_file_access(), errmsg(), ERROR, FATAL, fd(), InArchiveRecovery, InvalidXLogRecPtr, LOG, MAXFNAMELEN, readFile, RECOVERY_SIGNAL_FILE, recovery_signal_file_found, STANDBY_SIGNAL_FILE, standby_signal_file_found, ThisTimeLineID, UpdateMinRecoveryPoint(), wal_segment_size, XLByteToPrevSeg, XLByteToSeg, XLogArchiveCleanup(), XLogFileCopy(), XLogFileInit(), XLogFileName, and XLogSegmentOffset.

Referenced by StartupXLOG().

5460 {
5461  char xlogfname[MAXFNAMELEN];
5462  XLogSegNo endLogSegNo;
5463  XLogSegNo startLogSegNo;
5464 
5465  /* we always switch to a new timeline after archive recovery */
5466  Assert(endTLI != ThisTimeLineID);
5467 
5468  /*
5469  * We are no longer in archive recovery state.
5470  */
5471  InArchiveRecovery = false;
5472 
5473  /*
5474  * Update min recovery point one last time.
5475  */
5477 
5478  /*
5479  * If the ending log segment is still open, close it (to avoid problems on
5480  * Windows with trying to rename or delete an open file).
5481  */
5482  if (readFile >= 0)
5483  {
5484  close(readFile);
5485  readFile = -1;
5486  }
5487 
5488  /*
5489  * Calculate the last segment on the old timeline, and the first segment
5490  * on the new timeline. If the switch happens in the middle of a segment,
5491  * they are the same, but if the switch happens exactly at a segment
5492  * boundary, startLogSegNo will be endLogSegNo + 1.
5493  */
5494  XLByteToPrevSeg(endOfLog, endLogSegNo, wal_segment_size);
5495  XLByteToSeg(endOfLog, startLogSegNo, wal_segment_size);
5496 
5497  /*
5498  * Initialize the starting WAL segment for the new timeline. If the switch
5499  * happens in the middle of a segment, copy data from the last WAL segment
5500  * of the old timeline up to the switch point, to the starting WAL segment
5501  * on the new timeline.
5502  */
5503  if (endLogSegNo == startLogSegNo)
5504  {
5505  /*
5506  * Make a copy of the file on the new tim