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/multixact.h"
#include "access/rewriteheap.h"
#include "access/subtrans.h"
#include "access/timeline.h"
#include "access/transam.h"
#include "access/tuptoaster.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 "pgstat.h"
#include "port/atomics.h"
#include "postmaster/bgwriter.h"
#include "postmaster/walwriter.h"
#include "postmaster/startup.h"
#include "replication/basebackup.h"
#include "replication/logical.h"
#include "replication/slot.h"
#include "replication/origin.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 "pg_trace.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, TimeLineID *readTLI)
 
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 whichChkpti, 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)
 
char * XLogFileNameP (TimeLineID tli, 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 * 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:570
#define ERROR
Definition: elog.h:43
int errmsg(const char *fmt,...)
Definition: elog.c:784

Definition at line 6126 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

◆ XLogCtlInsert

◆ XLogPageReadPrivate

◆ XLogwrtResult

◆ 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:955
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:358
static void Insert(File file)
Definition: fd.c:1061
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:732
#define XLP_LONG_HEADER
Definition: xlog_internal.h:79
size_t Size
Definition: c.h:466
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:226
#define pg_write_barrier()
Definition: atomics.h:162
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:148

◆ 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 10052 of file xlog.c.

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

10053 {
10054  if (sync_method != new_sync_method)
10055  {
10056  /*
10057  * To ensure that no blocks escape unsynced, force an fsync on the
10058  * currently open log segment (if any). Also, if the open flag is
10059  * changing, close the log file so it will be reopened (with new flag
10060  * bit) at next use.
10061  */
10062  if (openLogFile >= 0)
10063  {
10065  if (pg_fsync(openLogFile) != 0)
10066  ereport(PANIC,
10068  errmsg("could not fsync file \"%s\": %m",
10071  if (get_sync_bit(sync_method) != get_sync_bit(new_sync_method))
10072  XLogFileClose();
10073  }
10074  }
10075 }
static int get_sync_bit(int method)
Definition: xlog.c:9996
#define PANIC
Definition: elog.h:53
static XLogSegNo openLogSegNo
Definition: xlog.c:780
static void XLogFileClose(void)
Definition: xlog.c:3779
char * XLogFileNameP(TimeLineID tli, XLogSegNo segno)
Definition: xlog.c:10130
int errcode_for_file_access(void)
Definition: elog.c:593
static void pgstat_report_wait_end(void)
Definition: pgstat.h:1342
#define ereport(elevel, rest)
Definition: elog.h:141
static int openLogFile
Definition: xlog.c:779
TimeLineID ThisTimeLineID
Definition: xlog.c:187
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:784
int pg_fsync(int fd)
Definition: fd.c:333

◆ BackupInProgress()

bool BackupInProgress ( void  )

Definition at line 11426 of file xlog.c.

References BACKUP_LABEL_FILE, and stat.

Referenced by pg_is_in_backup(), and PostmasterStateMachine().

11427 {
11428  struct stat stat_buf;
11429 
11430  return (stat(BACKUP_LABEL_FILE, &stat_buf) == 0);
11431 }
struct stat stat_buf
Definition: pg_standby.c:101
#define stat(a, b)
Definition: win32_port.h:264
#define BACKUP_LABEL_FILE
Definition: xlog.h:359

◆ BootStrapXLOG()

void BootStrapXLOG ( void  )

Definition at line 5087 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().

5088 {
5089  CheckPoint checkPoint;
5090  char *buffer;
5091  XLogPageHeader page;
5092  XLogLongPageHeader longpage;
5093  XLogRecord *record;
5094  char *recptr;
5095  bool use_existent;
5096  uint64 sysidentifier;
5097  char mock_auth_nonce[MOCK_AUTH_NONCE_LEN];
5098  struct timeval tv;
5099  pg_crc32c crc;
5100 
5101  /*
5102  * Select a hopefully-unique system identifier code for this installation.
5103  * We use the result of gettimeofday(), including the fractional seconds
5104  * field, as being about as unique as we can easily get. (Think not to
5105  * use random(), since it hasn't been seeded and there's no portable way
5106  * to seed it other than the system clock value...) The upper half of the
5107  * uint64 value is just the tv_sec part, while the lower half contains the
5108  * tv_usec part (which must fit in 20 bits), plus 12 bits from our current
5109  * PID for a little extra uniqueness. A person knowing this encoding can
5110  * determine the initialization time of the installation, which could
5111  * perhaps be useful sometimes.
5112  */
5113  gettimeofday(&tv, NULL);
5114  sysidentifier = ((uint64) tv.tv_sec) << 32;
5115  sysidentifier |= ((uint64) tv.tv_usec) << 12;
5116  sysidentifier |= getpid() & 0xFFF;
5117 
5118  /*
5119  * Generate a random nonce. This is used for authentication requests that
5120  * will fail because the user does not exist. The nonce is used to create
5121  * a genuine-looking password challenge for the non-existent user, in lieu
5122  * of an actual stored password.
5123  */
5124  if (!pg_strong_random(mock_auth_nonce, MOCK_AUTH_NONCE_LEN))
5125  ereport(PANIC,
5126  (errcode(ERRCODE_INTERNAL_ERROR),
5127  errmsg("could not generate secret authorization token")));
5128 
5129  /* First timeline ID is always 1 */
5130  ThisTimeLineID = 1;
5131 
5132  /* page buffer must be aligned suitably for O_DIRECT */
5133  buffer = (char *) palloc(XLOG_BLCKSZ + XLOG_BLCKSZ);
5134  page = (XLogPageHeader) TYPEALIGN(XLOG_BLCKSZ, buffer);
5135  memset(page, 0, XLOG_BLCKSZ);
5136 
5137  /*
5138  * Set up information for the initial checkpoint record
5139  *
5140  * The initial checkpoint record is written to the beginning of the WAL
5141  * segment with logid=0 logseg=1. The very first WAL segment, 0/0, is not
5142  * used, so that we can use 0/0 to mean "before any valid WAL segment".
5143  */
5144  checkPoint.redo = wal_segment_size + SizeOfXLogLongPHD;
5145  checkPoint.ThisTimeLineID = ThisTimeLineID;
5146  checkPoint.PrevTimeLineID = ThisTimeLineID;
5147  checkPoint.fullPageWrites = fullPageWrites;
5148  checkPoint.nextFullXid =
5150  checkPoint.nextOid = FirstBootstrapObjectId;
5151  checkPoint.nextMulti = FirstMultiXactId;
5152  checkPoint.nextMultiOffset = 0;
5153  checkPoint.oldestXid = FirstNormalTransactionId;
5154  checkPoint.oldestXidDB = TemplateDbOid;
5155  checkPoint.oldestMulti = FirstMultiXactId;
5156  checkPoint.oldestMultiDB = TemplateDbOid;
5159  checkPoint.time = (pg_time_t) time(NULL);
5161 
5163  ShmemVariableCache->nextOid = checkPoint.nextOid;
5165  MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
5166  AdvanceOldestClogXid(checkPoint.oldestXid);
5167  SetTransactionIdLimit(checkPoint.oldestXid, checkPoint.oldestXidDB);
5168  SetMultiXactIdLimit(checkPoint.oldestMulti, checkPoint.oldestMultiDB, true);
5170 
5171  /* Set up the XLOG page header */
5172  page->xlp_magic = XLOG_PAGE_MAGIC;
5173  page->xlp_info = XLP_LONG_HEADER;
5174  page->xlp_tli = ThisTimeLineID;
5176  longpage = (XLogLongPageHeader) page;
5177  longpage->xlp_sysid = sysidentifier;
5178  longpage->xlp_seg_size = wal_segment_size;
5179  longpage->xlp_xlog_blcksz = XLOG_BLCKSZ;
5180 
5181  /* Insert the initial checkpoint record */
5182  recptr = ((char *) page + SizeOfXLogLongPHD);
5183  record = (XLogRecord *) recptr;
5184  record->xl_prev = 0;
5185  record->xl_xid = InvalidTransactionId;
5186  record->xl_tot_len = SizeOfXLogRecord + SizeOfXLogRecordDataHeaderShort + sizeof(checkPoint);
5188  record->xl_rmid = RM_XLOG_ID;
5189  recptr += SizeOfXLogRecord;
5190  /* fill the XLogRecordDataHeaderShort struct */
5191  *(recptr++) = (char) XLR_BLOCK_ID_DATA_SHORT;
5192  *(recptr++) = sizeof(checkPoint);
5193  memcpy(recptr, &checkPoint, sizeof(checkPoint));
5194  recptr += sizeof(checkPoint);
5195  Assert(recptr - (char *) record == record->xl_tot_len);
5196 
5197  INIT_CRC32C(crc);
5198  COMP_CRC32C(crc, ((char *) record) + SizeOfXLogRecord, record->xl_tot_len - SizeOfXLogRecord);
5199  COMP_CRC32C(crc, (char *) record, offsetof(XLogRecord, xl_crc));
5200  FIN_CRC32C(crc);
5201  record->xl_crc = crc;
5202 
5203  /* Create first XLOG segment file */
5204  use_existent = false;
5205  openLogFile = XLogFileInit(1, &use_existent, false);
5206 
5207  /* Write the first page with the initial record */
5208  errno = 0;
5210  if (write(openLogFile, page, XLOG_BLCKSZ) != XLOG_BLCKSZ)
5211  {
5212  /* if write didn't set errno, assume problem is no disk space */
5213  if (errno == 0)
5214  errno = ENOSPC;
5215  ereport(PANIC,
5217  errmsg("could not write bootstrap write-ahead log file: %m")));
5218  }
5220 
5222  if (pg_fsync(openLogFile) != 0)
5223  ereport(PANIC,
5225  errmsg("could not fsync bootstrap write-ahead log file: %m")));
5227 
5228  if (close(openLogFile) != 0)
5229  ereport(PANIC,
5231  errmsg("could not close bootstrap write-ahead log file: %m")));
5232 
5233  openLogFile = -1;
5234 
5235  /* Now create pg_control */
5236 
5237  memset(ControlFile, 0, sizeof(ControlFileData));
5238  /* Initialize pg_control status fields */
5239  ControlFile->system_identifier = sysidentifier;
5240  memcpy(ControlFile->mock_authentication_nonce, mock_auth_nonce, MOCK_AUTH_NONCE_LEN);
5242  ControlFile->time = checkPoint.time;
5243  ControlFile->checkPoint = checkPoint.redo;
5244  ControlFile->checkPointCopy = checkPoint;
5246 
5247  /* Set important parameter values for use when replaying WAL */
5257 
5258  /* some additional ControlFile fields are set in WriteControlFile() */
5259 
5260  WriteControlFile();
5261 
5262  /* Bootstrap the commit log, too */
5263  BootStrapCLOG();
5267 
5268  pfree(buffer);
5269 
5270  /*
5271  * Force control file to be read - in contrast to normal processing we'd
5272  * otherwise never run the checks and GUC related initializations therein.
5273  */
5274  ReadControlFile();
5275 }
static void WriteControlFile(void)
Definition: xlog.c:4485
#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:3205
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:570
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:1031
#define FirstNormalTransactionId
Definition: transam.h:34
int max_prepared_xacts
Definition: twophase.c:118
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:4577
bool track_commit_timestamp
Definition: commit_ts.c:103
uint32 data_checksum_version
Definition: pg_control.h:222
#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:593
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:229
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:678
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:732
#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:924
int errmsg(const char *fmt,...)
Definition: elog.c:784
int max_worker_processes
Definition: globals.c:133
int pg_fsync(int fd)
Definition: fd.c:333
#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:655
#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:148

◆ CancelBackup()

void CancelBackup ( void  )

Definition at line 11446 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().

11447 {
11448  struct stat stat_buf;
11449 
11450  /* if the backup_label file is not there, return */
11451  if (stat(BACKUP_LABEL_FILE, &stat_buf) < 0)
11452  return;
11453 
11454  /* remove leftover file from previously canceled backup if it exists */
11455  unlink(BACKUP_LABEL_OLD);
11456 
11458  {
11459  ereport(WARNING,
11461  errmsg("online backup mode was not canceled"),
11462  errdetail("File \"%s\" could not be renamed to \"%s\": %m.",
11464  return;
11465  }
11466 
11467  /* if the tablespace_map file is not there, return */
11468  if (stat(TABLESPACE_MAP, &stat_buf) < 0)
11469  {
11470  ereport(LOG,
11471  (errmsg("online backup mode canceled"),
11472  errdetail("File \"%s\" was renamed to \"%s\".",
11474  return;
11475  }
11476 
11477  /* remove leftover file from previously canceled backup if it exists */
11478  unlink(TABLESPACE_MAP_OLD);
11479 
11481  {
11482  ereport(LOG,
11483  (errmsg("online backup mode canceled"),
11484  errdetail("Files \"%s\" and \"%s\" were renamed to "
11485  "\"%s\" and \"%s\", respectively.",
11488  }
11489  else
11490  {
11491  ereport(WARNING,
11493  errmsg("online backup mode canceled"),
11494  errdetail("File \"%s\" was renamed to \"%s\", but "
11495  "file \"%s\" could not be renamed to \"%s\": %m.",
11498  }
11499 }
#define DEBUG1
Definition: elog.h:25
#define LOG
Definition: elog.h:26
#define BACKUP_LABEL_OLD
Definition: xlog.h:360
#define TABLESPACE_MAP
Definition: xlog.h:362
struct stat stat_buf
Definition: pg_standby.c:101
int errdetail(const char *fmt,...)
Definition: elog.c:860
int errcode_for_file_access(void)
Definition: elog.c:593
#define ereport(elevel, rest)
Definition: elog.h:141
int durable_rename(const char *oldfile, const char *newfile, int elevel)
Definition: fd.c:608
#define WARNING
Definition: elog.h:40
#define stat(a, b)
Definition: win32_port.h:264
#define TABLESPACE_MAP_OLD
Definition: xlog.h:363
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define BACKUP_LABEL_FILE
Definition: xlog.h:359

◆ check_wal_buffers()

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

Definition at line 4878 of file xlog.c.

References XLOGbuffers, and XLOGChooseNumBuffers().

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

◆ CheckForStandbyTrigger()

static bool CheckForStandbyTrigger ( void  )
static

Definition at line 12137 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().

12138 {
12139  struct stat stat_buf;
12140  static bool triggered = false;
12141 
12142  if (triggered)
12143  return true;
12144 
12145  if (IsPromoteTriggered())
12146  {
12147  /*
12148  * In 9.1 and 9.2 the postmaster unlinked the promote file inside the
12149  * signal handler. It now leaves the file in place and lets the
12150  * Startup process do the unlink. This allows Startup to know whether
12151  * it should create a full checkpoint before starting up (fallback
12152  * mode). Fast promotion takes precedence.
12153  */
12154  if (stat(PROMOTE_SIGNAL_FILE, &stat_buf) == 0)
12155  {
12156  unlink(PROMOTE_SIGNAL_FILE);
12158  fast_promote = true;
12159  }
12160  else if (stat(FALLBACK_PROMOTE_SIGNAL_FILE, &stat_buf) == 0)
12161  {
12163  fast_promote = false;
12164  }
12165 
12166  ereport(LOG, (errmsg("received promote request")));
12167 
12169  triggered = true;
12170  return true;
12171  }
12172 
12173  if (PromoteTriggerFile == NULL || strcmp(PromoteTriggerFile, "") == 0)
12174  return false;
12175 
12176  if (stat(PromoteTriggerFile, &stat_buf) == 0)
12177  {
12178  ereport(LOG,
12179  (errmsg("promote trigger file found: %s", PromoteTriggerFile)));
12180  unlink(PromoteTriggerFile);
12181  triggered = true;
12182  fast_promote = true;
12183  return true;
12184  }
12185  else if (errno != ENOENT)
12186  ereport(ERROR,
12188  errmsg("could not stat promote trigger file \"%s\": %m",
12189  PromoteTriggerFile)));
12190 
12191  return false;
12192 }
char * PromoteTriggerFile
Definition: xlog.c:286
void ResetPromoteTriggered(void)
Definition: startup.c:243
#define PROMOTE_SIGNAL_FILE
Definition: xlog.h:366
#define LOG
Definition: elog.h:26
#define ERROR
Definition: elog.h:43
struct stat stat_buf
Definition: pg_standby.c:101
int errcode_for_file_access(void)
Definition: elog.c:593
bool IsPromoteTriggered(void)
Definition: startup.c:237
#define ereport(elevel, rest)
Definition: elog.h:141
#define FALLBACK_PROMOTE_SIGNAL_FILE
Definition: xlog.h:367
#define stat(a, b)
Definition: win32_port.h:264
int errmsg(const char *fmt,...)
Definition: elog.c:784
static bool fast_promote
Definition: xlog.c:292

◆ CheckPointGuts()

static void CheckPointGuts ( XLogRecPtr  checkPointRedo,
int  flags 
)
static

Definition at line 8980 of file xlog.c.

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

Referenced by CreateCheckPoint(), and CreateRestartPoint().

8981 {
8982  CheckPointCLOG();
8991  CheckPointBuffers(flags); /* performs all required fsyncs */
8993  /* We deliberately delay 2PC checkpointing as long as possible */
8994  CheckPointTwoPhase(checkPointRedo);
8995 }
void CheckPointBuffers(int flags)
Definition: bufmgr.c:2582
void CheckPointLogicalRewriteHeap(void)
Definition: rewriteheap.c:1222
void CheckPointReplicationOrigin(void)
Definition: origin.c:546
void CheckPointSnapBuild(void)
Definition: snapbuild.c:1937
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:1751
void CheckPointReplicationSlots(void)
Definition: slot.c:1074

◆ CheckPromoteSignal()

bool CheckPromoteSignal ( void  )

Definition at line 12209 of file xlog.c.

References FALLBACK_PROMOTE_SIGNAL_FILE, PROMOTE_SIGNAL_FILE, and stat.

Referenced by sigusr1_handler().

12210 {
12211  struct stat stat_buf;
12212 
12213  if (stat(PROMOTE_SIGNAL_FILE, &stat_buf) == 0 ||
12215  return true;
12216 
12217  return false;
12218 }
#define PROMOTE_SIGNAL_FILE
Definition: xlog.h:366
struct stat stat_buf
Definition: pg_standby.c:101
#define FALLBACK_PROMOTE_SIGNAL_FILE
Definition: xlog.h:367
#define stat(a, b)
Definition: win32_port.h:264

◆ CheckRecoveryConsistency()

static void CheckRecoveryConsistency ( void  )
static

Definition at line 7797 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().

7798 {
7799  XLogRecPtr lastReplayedEndRecPtr;
7800 
7801  /*
7802  * During crash recovery, we don't reach a consistent state until we've
7803  * replayed all the WAL.
7804  */
7806  return;
7807 
7809 
7810  /*
7811  * assume that we are called in the startup process, and hence don't need
7812  * a lock to read lastReplayedEndRecPtr
7813  */
7814  lastReplayedEndRecPtr = XLogCtl->lastReplayedEndRecPtr;
7815 
7816  /*
7817  * Have we reached the point where our base backup was completed?
7818  */
7820  ControlFile->backupEndPoint <= lastReplayedEndRecPtr)
7821  {
7822  /*
7823  * We have reached the end of base backup, as indicated by pg_control.
7824  * The data on disk is now consistent. Reset backupStartPoint and
7825  * backupEndPoint, and update minRecoveryPoint to make sure we don't
7826  * allow starting up at an earlier point even if recovery is stopped
7827  * and restarted soon after this.
7828  */
7829  elog(DEBUG1, "end of backup reached");
7830 
7831  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
7832 
7833  if (ControlFile->minRecoveryPoint < lastReplayedEndRecPtr)
7834  ControlFile->minRecoveryPoint = lastReplayedEndRecPtr;
7835 
7838  ControlFile->backupEndRequired = false;
7840 
7841  LWLockRelease(ControlFileLock);
7842  }
7843 
7844  /*
7845  * Have we passed our safe starting point? Note that minRecoveryPoint is
7846  * known to be incorrectly set if ControlFile->backupEndRequired, until
7847  * the XLOG_BACKUP_END arrives to advise us of the correct
7848  * minRecoveryPoint. All we know prior to that is that we're not
7849  * consistent yet.
7850  */
7852  minRecoveryPoint <= lastReplayedEndRecPtr &&
7854  {
7855  /*
7856  * Check to see if the XLOG sequence contained any unresolved
7857  * references to uninitialized pages.
7858  */
7860 
7861  reachedConsistency = true;
7862  ereport(LOG,
7863  (errmsg("consistent recovery state reached at %X/%X",
7864  (uint32) (lastReplayedEndRecPtr >> 32),
7865  (uint32) lastReplayedEndRecPtr)));
7866  }
7867 
7868  /*
7869  * Have we got a valid starting snapshot that will allow queries to be
7870  * run? If so, we can tell postmaster that the database is consistent now,
7871  * enabling connections.
7872  */
7877  {
7881 
7882  LocalHotStandbyActive = true;
7883 
7885  }
7886 }
#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:4793
bool IsUnderPostmaster
Definition: globals.c:109
unsigned int uint32
Definition: c.h:358
#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:732
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:784
#define elog(elevel,...)
Definition: elog.h:226
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 6148 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().

6149 {
6150  /*
6151  * For archive recovery, the WAL must be generated with at least 'replica'
6152  * wal_level.
6153  */
6155  {
6156  ereport(WARNING,
6157  (errmsg("WAL was generated with wal_level=minimal, data may be missing"),
6158  errhint("This happens if you temporarily set wal_level=minimal without taking a new base backup.")));
6159  }
6160 
6161  /*
6162  * For Hot Standby, the WAL must be generated with 'replica' mode, and we
6163  * must have at least as many backend slots as the primary.
6164  */
6166  {
6168  ereport(ERROR,
6169  (errmsg("hot standby is not possible because wal_level was not set to \"replica\" or higher on the master server"),
6170  errhint("Either set wal_level to \"replica\" on the master, or turn off hot_standby here.")));
6171 
6172  /* We ignore autovacuum_max_workers when we make this test. */
6173  RecoveryRequiresIntParameter("max_connections",
6176  RecoveryRequiresIntParameter("max_worker_processes",
6179  RecoveryRequiresIntParameter("max_wal_senders",
6182  RecoveryRequiresIntParameter("max_prepared_transactions",
6185  RecoveryRequiresIntParameter("max_locks_per_transaction",
6188  }
6189 }
bool ArchiveRecoveryRequested
Definition: xlog.c:254
int max_locks_per_xact
Definition: pg_control.h:182
int errhint(const char *fmt,...)
Definition: elog.c:974
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:118
#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:784
int max_worker_processes
Definition: globals.c:133
#define RecoveryRequiresIntParameter(param_name, currValue, minValue)
Definition: xlog.c:6126

◆ checkTimeLineSwitch()

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

Definition at line 9545 of file xlog.c.

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

Referenced by StartupXLOG().

9546 {
9547  /* Check that the record agrees on what the current (old) timeline is */
9548  if (prevTLI != ThisTimeLineID)
9549  ereport(PANIC,
9550  (errmsg("unexpected previous timeline ID %u (current timeline ID %u) in checkpoint record",
9551  prevTLI, ThisTimeLineID)));
9552 
9553  /*
9554  * The new timeline better be in the list of timelines we expect to see,
9555  * according to the timeline history. It should also not decrease.
9556  */
9557  if (newTLI < ThisTimeLineID || !tliInHistory(newTLI, expectedTLEs))
9558  ereport(PANIC,
9559  (errmsg("unexpected timeline ID %u (after %u) in checkpoint record",
9560  newTLI, ThisTimeLineID)));
9561 
9562  /*
9563  * If we have not yet reached min recovery point, and we're about to
9564  * switch to a timeline greater than the timeline of the min recovery
9565  * point: trouble. After switching to the new timeline, we could not
9566  * possibly visit the min recovery point on the correct timeline anymore.
9567  * This can happen if there is a newer timeline in the archive that
9568  * branched before the timeline the min recovery point is on, and you
9569  * attempt to do PITR to the new timeline.
9570  */
9572  lsn < minRecoveryPoint &&
9573  newTLI > minRecoveryPointTLI)
9574  ereport(PANIC,
9575  (errmsg("unexpected timeline ID %u in checkpoint record, before reaching minimum recovery point %X/%X on timeline %u",
9576  newTLI,
9577  (uint32) (minRecoveryPoint >> 32),
9580 
9581  /* Looks good */
9582 }
static List * expectedTLEs
Definition: xlog.c:333
#define PANIC
Definition: elog.h:53
unsigned int uint32
Definition: c.h:358
#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:784
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:242
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:124
static char * replay_image_masked
Definition: xlog.c:264
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3376
#define ERROR
Definition: elog.h:43
#define FATAL
Definition: elog.h:52
static char * buf
Definition: pg_test_fsync.c:68
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define XLogRecGetInfo(decoder)
Definition: xlogreader.h:233
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:1348
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3590
uint8 RmgrId
Definition: rmgr.h:11
#define Assert(condition)
Definition: c.h:732
#define BufferIsValid(bufnum)
Definition: bufmgr.h:113
bool RestoreBlockImage(XLogReaderState *record, uint8 block_id, char *page)
Definition: xlogreader.c:1401
#define PageGetLSN(page)
Definition: bufpage.h:366
#define elog(elevel,...)
Definition: elog.h:226
#define XLogRecHasAnyBlockRefs(decoder)
Definition: xlogreader.h:239
#define XLogRecBlockImageApply(decoder, block_id)
Definition: xlogreader.h:244
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78
#define XLogRecGetRmid(decoder)
Definition: xlogreader.h:234
static char * master_image_masked
Definition: xlog.c:265

◆ CheckXLogRemoved()

void CheckXLogRemoved ( XLogSegNo  segno,
TimeLineID  tli 
)

Definition at line 3846 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 perform_base_backup(), and XLogRead().

3847 {
3848  int save_errno = errno;
3849  XLogSegNo lastRemovedSegNo;
3850 
3852  lastRemovedSegNo = XLogCtl->lastRemovedSegNo;
3854 
3855  if (segno <= lastRemovedSegNo)
3856  {
3857  char filename[MAXFNAMELEN];
3858 
3859  XLogFileName(filename, tli, segno, wal_segment_size);
3860  errno = save_errno;
3861  ereport(ERROR,
3863  errmsg("requested WAL segment %s has already been removed",
3864  filename)));
3865  }
3866  errno = save_errno;
3867 }
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:593
#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:91
int errmsg(const char *fmt,...)
Definition: elog.c:784

◆ CleanupBackupHistory()

static void CleanupBackupHistory ( void  )
static

Definition at line 4209 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().

4210 {
4211  DIR *xldir;
4212  struct dirent *xlde;
4213  char path[MAXPGPATH + sizeof(XLOGDIR)];
4214 
4215  xldir = AllocateDir(XLOGDIR);
4216 
4217  while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
4218  {
4219  if (IsBackupHistoryFileName(xlde->d_name))
4220  {
4221  if (XLogArchiveCheckDone(xlde->d_name))
4222  {
4223  elog(DEBUG2, "removing WAL backup history file \"%s\"",
4224  xlde->d_name);
4225  snprintf(path, sizeof(path), XLOGDIR "/%s", xlde->d_name);
4226  unlink(path);
4227  XLogArchiveCleanup(xlde->d_name);
4228  }
4229  }
4230  }
4231 
4232  FreeDir(xldir);
4233 }
Definition: dirent.h:9
void XLogArchiveCleanup(const char *xlog)
Definition: xlogarchive.c:749
Definition: dirent.c:25
bool XLogArchiveCheckDone(const char *xlog)
Definition: xlogarchive.c:609
#define MAXPGPATH
#define DEBUG2
Definition: elog.h:24
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2468
#define IsBackupHistoryFileName(fname)
#define XLOGDIR
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition: fd.c:2534
#define elog(elevel,...)
Definition: elog.h:226
char d_name[MAX_PATH]
Definition: dirent.h:14
#define snprintf
Definition: port.h:192
int FreeDir(DIR *dir)
Definition: fd.c:2586

◆ 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:955
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:710
unsigned int uint32
Definition: c.h:358
#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:732
#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:226
#define SizeOfXLogLongPHD
Definition: xlog_internal.h:72

◆ CreateCheckPoint()

void CreateCheckPoint ( int  flags)

Definition at line 8510 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().

8511 {
8512  bool shutdown;
8513  CheckPoint checkPoint;
8514  XLogRecPtr recptr;
8515  XLogSegNo _logSegNo;
8517  uint32 freespace;
8518  XLogRecPtr PriorRedoPtr;
8519  XLogRecPtr curInsert;
8520  XLogRecPtr last_important_lsn;
8521  VirtualTransactionId *vxids;
8522  int nvxids;
8523 
8524  /*
8525  * An end-of-recovery checkpoint is really a shutdown checkpoint, just
8526  * issued at a different time.
8527  */
8529  shutdown = true;
8530  else
8531  shutdown = false;
8532 
8533  /* sanity check */
8534  if (RecoveryInProgress() && (flags & CHECKPOINT_END_OF_RECOVERY) == 0)
8535  elog(ERROR, "can't create a checkpoint during recovery");
8536 
8537  /*
8538  * Initialize InitXLogInsert working areas before entering the critical
8539  * section. Normally, this is done by the first call to
8540  * RecoveryInProgress() or LocalSetXLogInsertAllowed(), but when creating
8541  * an end-of-recovery checkpoint, the LocalSetXLogInsertAllowed call is
8542  * done below in a critical section, and InitXLogInsert cannot be called
8543  * in a critical section.
8544  */
8545  InitXLogInsert();
8546 
8547  /*
8548  * Acquire CheckpointLock to ensure only one checkpoint happens at a time.
8549  * (This is just pro forma, since in the present system structure there is
8550  * only one process that is allowed to issue checkpoints at any given
8551  * time.)
8552  */
8553  LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
8554 
8555  /*
8556  * Prepare to accumulate statistics.
8557  *
8558  * Note: because it is possible for log_checkpoints to change while a
8559  * checkpoint proceeds, we always accumulate stats, even if
8560  * log_checkpoints is currently off.
8561  */
8562  MemSet(&CheckpointStats, 0, sizeof(CheckpointStats));
8564 
8565  /*
8566  * Use a critical section to force system panic if we have trouble.
8567  */
8569 
8570  if (shutdown)
8571  {
8572  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
8574  ControlFile->time = (pg_time_t) time(NULL);
8576  LWLockRelease(ControlFileLock);
8577  }
8578 
8579  /*
8580  * Let smgr prepare for checkpoint; this has to happen before we determine
8581  * the REDO pointer. Note that smgr must not do anything that'd have to
8582  * be undone if we decide no checkpoint is needed.
8583  */
8585 
8586  /* Begin filling in the checkpoint WAL record */
8587  MemSet(&checkPoint, 0, sizeof(checkPoint));
8588  checkPoint.time = (pg_time_t) time(NULL);
8589 
8590  /*
8591  * For Hot Standby, derive the oldestActiveXid before we fix the redo
8592  * pointer. This allows us to begin accumulating changes to assemble our
8593  * starting snapshot of locks and transactions.
8594  */
8595  if (!shutdown && XLogStandbyInfoActive())
8597  else
8599 
8600  /*
8601  * Get location of last important record before acquiring insert locks (as
8602  * GetLastImportantRecPtr() also locks WAL locks).
8603  */
8604  last_important_lsn = GetLastImportantRecPtr();
8605 
8606  /*
8607  * We must block concurrent insertions while examining insert state to
8608  * determine the checkpoint REDO pointer.
8609  */
8611  curInsert = XLogBytePosToRecPtr(Insert->CurrBytePos);
8612 
8613  /*
8614  * If this isn't a shutdown or forced checkpoint, and if there has been no
8615  * WAL activity requiring a checkpoint, skip it. The idea here is to
8616  * avoid inserting duplicate checkpoints when the system is idle.
8617  */
8618  if ((flags & (CHECKPOINT_IS_SHUTDOWN | CHECKPOINT_END_OF_RECOVERY |
8619  CHECKPOINT_FORCE)) == 0)
8620  {
8621  if (last_important_lsn == ControlFile->checkPoint)
8622  {
8624  LWLockRelease(CheckpointLock);
8625  END_CRIT_SECTION();
8626  ereport(DEBUG1,
8627  (errmsg("checkpoint skipped because system is idle")));
8628  return;
8629  }
8630  }
8631 
8632  /*
8633  * An end-of-recovery checkpoint is created before anyone is allowed to
8634  * write WAL. To allow us to write the checkpoint record, temporarily
8635  * enable XLogInsertAllowed. (This also ensures ThisTimeLineID is
8636  * initialized, which we need here and in AdvanceXLInsertBuffer.)
8637  */
8638  if (flags & CHECKPOINT_END_OF_RECOVERY)
8640 
8641  checkPoint.ThisTimeLineID = ThisTimeLineID;
8642  if (flags & CHECKPOINT_END_OF_RECOVERY)
8643  checkPoint.PrevTimeLineID = XLogCtl->PrevTimeLineID;
8644  else
8645  checkPoint.PrevTimeLineID = ThisTimeLineID;
8646 
8647  checkPoint.fullPageWrites = Insert->fullPageWrites;
8648 
8649  /*
8650  * Compute new REDO record ptr = location of next XLOG record.
8651  *
8652  * NB: this is NOT necessarily where the checkpoint record itself will be,
8653  * since other backends may insert more XLOG records while we're off doing
8654  * the buffer flush work. Those XLOG records are logically after the
8655  * checkpoint, even though physically before it. Got that?
8656  */
8657  freespace = INSERT_FREESPACE(curInsert);
8658  if (freespace == 0)
8659  {
8660  if (XLogSegmentOffset(curInsert, wal_segment_size) == 0)
8661  curInsert += SizeOfXLogLongPHD;
8662  else
8663  curInsert += SizeOfXLogShortPHD;
8664  }
8665  checkPoint.redo = curInsert;
8666 
8667  /*
8668  * Here we update the shared RedoRecPtr for future XLogInsert calls; this
8669  * must be done while holding all the insertion locks.
8670  *
8671  * Note: if we fail to complete the checkpoint, RedoRecPtr will be left
8672  * pointing past where it really needs to point. This is okay; the only
8673  * consequence is that XLogInsert might back up whole buffers that it
8674  * didn't really need to. We can't postpone advancing RedoRecPtr because
8675  * XLogInserts that happen while we are dumping buffers must assume that
8676  * their buffer changes are not included in the checkpoint.
8677  */
8678  RedoRecPtr = XLogCtl->Insert.RedoRecPtr = checkPoint.redo;
8679 
8680  /*
8681  * Now we can release the WAL insertion locks, allowing other xacts to
8682  * proceed while we are flushing disk buffers.
8683  */
8685 
8686  /* Update the info_lck-protected copy of RedoRecPtr as well */
8688  XLogCtl->RedoRecPtr = checkPoint.redo;
8690 
8691  /*
8692  * If enabled, log checkpoint start. We postpone this until now so as not
8693  * to log anything if we decided to skip the checkpoint.
8694  */
8695  if (log_checkpoints)
8696  LogCheckpointStart(flags, false);
8697 
8698  TRACE_POSTGRESQL_CHECKPOINT_START(flags);
8699 
8700  /*
8701  * Get the other info we need for the checkpoint record.
8702  *
8703  * We don't need to save oldestClogXid in the checkpoint, it only matters
8704  * for the short period in which clog is being truncated, and if we crash
8705  * during that we'll redo the clog truncation and fix up oldestClogXid
8706  * there.
8707  */
8708  LWLockAcquire(XidGenLock, LW_SHARED);
8710  checkPoint.oldestXid = ShmemVariableCache->oldestXid;
8712  LWLockRelease(XidGenLock);
8713 
8714  LWLockAcquire(CommitTsLock, LW_SHARED);
8717  LWLockRelease(CommitTsLock);
8718 
8719  LWLockAcquire(OidGenLock, LW_SHARED);
8720  checkPoint.nextOid = ShmemVariableCache->nextOid;
8721  if (!shutdown)
8722  checkPoint.nextOid += ShmemVariableCache->oidCount;
8723  LWLockRelease(OidGenLock);
8724 
8725  MultiXactGetCheckptMulti(shutdown,
8726  &checkPoint.nextMulti,
8727  &checkPoint.nextMultiOffset,
8728  &checkPoint.oldestMulti,
8729  &checkPoint.oldestMultiDB);
8730 
8731  /*
8732  * Having constructed the checkpoint record, ensure all shmem disk buffers
8733  * and commit-log buffers are flushed to disk.
8734  *
8735  * This I/O could fail for various reasons. If so, we will fail to
8736  * complete the checkpoint, but there is no reason to force a system
8737  * panic. Accordingly, exit critical section while doing it.
8738  */
8739  END_CRIT_SECTION();
8740 
8741  /*
8742  * In some cases there are groups of actions that must all occur on one
8743  * side or the other of a checkpoint record. Before flushing the
8744  * checkpoint record we must explicitly wait for any backend currently
8745  * performing those groups of actions.
8746  *
8747  * One example is end of transaction, so we must wait for any transactions
8748  * that are currently in commit critical sections. If an xact inserted
8749  * its commit record into XLOG just before the REDO point, then a crash
8750  * restart from the REDO point would not replay that record, which means
8751  * that our flushing had better include the xact's update of pg_xact. So
8752  * we wait till he's out of his commit critical section before proceeding.
8753  * See notes in RecordTransactionCommit().
8754  *
8755  * Because we've already released the insertion locks, this test is a bit
8756  * fuzzy: it is possible that we will wait for xacts we didn't really need
8757  * to wait for. But the delay should be short and it seems better to make
8758  * checkpoint take a bit longer than to hold off insertions longer than
8759  * necessary. (In fact, the whole reason we have this issue is that xact.c
8760  * does commit record XLOG insertion and clog update as two separate steps
8761  * protected by different locks, but again that seems best on grounds of
8762  * minimizing lock contention.)
8763  *
8764  * A transaction that has not yet set delayChkpt when we look cannot be at
8765  * risk, since he's not inserted his commit record yet; and one that's
8766  * already cleared it is not at risk either, since he's done fixing clog
8767  * and we will correctly flush the update below. So we cannot miss any
8768  * xacts we need to wait for.
8769  */
8770  vxids = GetVirtualXIDsDelayingChkpt(&nvxids);
8771  if (nvxids > 0)
8772  {
8773  do
8774  {
8775  pg_usleep(10000L); /* wait for 10 msec */
8776  } while (HaveVirtualXIDsDelayingChkpt(vxids, nvxids));
8777  }
8778  pfree(vxids);
8779 
8780  CheckPointGuts(checkPoint.redo, flags);
8781 
8782  /*
8783  * Take a snapshot of running transactions and write this to WAL. This
8784  * allows us to reconstruct the state of running transactions during
8785  * archive recovery, if required. Skip, if this info disabled.
8786  *
8787  * If we are shutting down, or Startup process is completing crash
8788  * recovery we don't need to write running xact data.
8789  */
8790  if (!shutdown && XLogStandbyInfoActive())
8792 
8794 
8795  /*
8796  * Now insert the checkpoint record into XLOG.
8797  */
8798  XLogBeginInsert();
8799  XLogRegisterData((char *) (&checkPoint), sizeof(checkPoint));
8800  recptr = XLogInsert(RM_XLOG_ID,
8801  shutdown ? XLOG_CHECKPOINT_SHUTDOWN :
8803 
8804  XLogFlush(recptr);
8805 
8806  /*
8807  * We mustn't write any new WAL after a shutdown checkpoint, or it will be
8808  * overwritten at next startup. No-one should even try, this just allows
8809  * sanity-checking. In the case of an end-of-recovery checkpoint, we want
8810  * to just temporarily disable writing until the system has exited
8811  * recovery.
8812  */
8813  if (shutdown)
8814  {
8815  if (flags & CHECKPOINT_END_OF_RECOVERY)
8816  LocalXLogInsertAllowed = -1; /* return to "check" state */
8817  else
8818  LocalXLogInsertAllowed = 0; /* never again write WAL */
8819  }
8820 
8821  /*
8822  * We now have ProcLastRecPtr = start of actual checkpoint record, recptr
8823  * = end of actual checkpoint record.
8824  */
8825  if (shutdown && checkPoint.redo != ProcLastRecPtr)
8826  ereport(PANIC,
8827  (errmsg("concurrent write-ahead log activity while database system is shutting down")));
8828 
8829  /*
8830  * Remember the prior checkpoint's redo ptr for
8831  * UpdateCheckPointDistanceEstimate()
8832  */
8833  PriorRedoPtr = ControlFile->checkPointCopy.redo;
8834 
8835  /*
8836  * Update the control file.
8837  */
8838  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
8839  if (shutdown)
8842  ControlFile->checkPointCopy = checkPoint;
8843  ControlFile->time = (pg_time_t) time(NULL);
8844  /* crash recovery should always recover to the end of WAL */
8847 
8848  /*
8849  * Persist unloggedLSN value. It's reset on crash recovery, so this goes
8850  * unused on non-shutdown checkpoints, but seems useful to store it always
8851  * for debugging purposes.
8852  */
8856 
8858  LWLockRelease(ControlFileLock);
8859 
8860  /* Update shared-memory copy of checkpoint XID/epoch */
8862  XLogCtl->ckptFullXid = checkPoint.nextFullXid;
8864 
8865  /*
8866  * We are now done with critical updates; no need for system panic if we
8867  * have trouble while fooling with old log segments.
8868  */
8869  END_CRIT_SECTION();
8870 
8871  /*
8872  * Let smgr do post-checkpoint cleanup (eg, deleting old files).
8873  */
8875 
8876  /*
8877  * Update the average distance between checkpoints if the prior checkpoint
8878  * exists.
8879  */
8880  if (PriorRedoPtr != InvalidXLogRecPtr)
8882 
8883  /*
8884  * Delete old log files, those no longer needed for last checkpoint to
8885  * prevent the disk holding the xlog from growing full.
8886  */
8888  KeepLogSeg(recptr, &_logSegNo);
8889  _logSegNo--;
8890  RemoveOldXlogFiles(_logSegNo, RedoRecPtr, recptr);
8891 
8892  /*
8893  * Make more log segments if needed. (Do this after recycling old log
8894  * segments, since that may supply some of the needed files.)
8895  */
8896  if (!shutdown)
8897  PreallocXlogFiles(recptr);
8898 
8899  /*
8900  * Truncate pg_subtrans if possible. We can throw away all data before
8901  * the oldest XMIN of any running transaction. No future transaction will
8902  * attempt to reference any pg_subtrans entry older than that (see Asserts
8903  * in subtrans.c). During recovery, though, we mustn't do this because
8904  * StartupSUBTRANS hasn't been called yet.
8905  */
8906  if (!RecoveryInProgress())
8908 
8909  /* Real work is done, but log and update stats before releasing lock. */
8910  LogCheckpointEnd(false);
8911 
8912  TRACE_POSTGRESQL_CHECKPOINT_DONE(CheckpointStats.ckpt_bufs_written,
8913  NBuffers,
8917 
8918  LWLockRelease(CheckpointLock);
8919 }
XLogRecPtr GetLastImportantRecPtr(void)
Definition: xlog.c:8248
static void UpdateCheckPointDistanceEstimate(uint64 nbytes)
Definition: xlog.c:8448
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:1569
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:2271
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:955
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:8980
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:7898
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:2798
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:4793
TransactionId oldestCommitTsXid
Definition: pg_control.h:52
void pfree(void *pointer)
Definition: mcxt.c:1031
XLogRecPtr LogStandbySnapshot(void)
Definition: standby.c:901
#define ERROR
Definition: elog.h:43
static void LogCheckpointEnd(bool restartpoint)
Definition: xlog.c:8363
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:3813
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:358
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:1061
int ckpt_bufs_written
Definition: xlog.h:241
static void LocalSetXLogInsertAllowed(void)
Definition: xlog.c:8024
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:9300
#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:3943
bool fullPageWrites
Definition: pg_control.h:42
TransactionId GetOldestXmin(Relation rel, int flags)
Definition: procarray.c:1304
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:784
#define elog(elevel,...)
Definition: elog.h:226
void SyncPostCheckpoint(void)
Definition: sync.c:174
TransactionId GetOldestActiveTransactionId(void)
Definition: procarray.c:2109
int NBuffers
Definition: globals.c:131
bool HaveVirtualXIDsDelayingChkpt(VirtualTransactionId *vxids, int nvxids)
Definition: procarray.c:2316
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:8345
#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 8931 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().

8932 {
8933  xl_end_of_recovery xlrec;
8934  XLogRecPtr recptr;
8935 
8936  /* sanity check */
8937  if (!RecoveryInProgress())
8938  elog(ERROR, "can only be used to end recovery");
8939 
8940  xlrec.end_time = GetCurrentTimestamp();
8941 
8946 
8948 
8950 
8951  XLogBeginInsert();
8952  XLogRegisterData((char *) &xlrec, sizeof(xl_end_of_recovery));
8953  recptr = XLogInsert(RM_XLOG_ID, XLOG_END_OF_RECOVERY);
8954 
8955  XLogFlush(recptr);
8956 
8957  /*
8958  * Update the control file so that crash recovery can follow the timeline
8959  * changes to this point.
8960  */
8961  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
8962  ControlFile->time = (pg_time_t) time(NULL);
8963  ControlFile->minRecoveryPoint = recptr;
8966  LWLockRelease(ControlFileLock);
8967 
8968  END_CRIT_SECTION();
8969 
8970  LocalXLogInsertAllowed = -1; /* return to "check" state */
8971 }
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:1569
#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:7898
#define XLOG_END_OF_RECOVERY
Definition: pg_control.h:76
void XLogFlush(XLogRecPtr record)
Definition: xlog.c:2798
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
void UpdateControlFile(void)
Definition: xlog.c:4793
#define ERROR
Definition: elog.h:43
static void LocalSetXLogInsertAllowed(void)
Definition: xlog.c:8024
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:226
void XLogBeginInsert(void)
Definition: xloginsert.c:120
XLogRecPtr minRecoveryPoint
Definition: pg_control.h:166

◆ CreateRestartPoint()

bool CreateRestartPoint ( int  flags)

Definition at line 9050 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().

9051 {
9052  XLogRecPtr lastCheckPointRecPtr;
9053  XLogRecPtr lastCheckPointEndPtr;
9054  CheckPoint lastCheckPoint;
9055  XLogRecPtr PriorRedoPtr;
9056  XLogRecPtr receivePtr;
9057  XLogRecPtr replayPtr;
9058  TimeLineID replayTLI;
9059  XLogRecPtr endptr;
9060  XLogSegNo _logSegNo;
9061  TimestampTz xtime;
9062 
9063  /*
9064  * Acquire CheckpointLock to ensure only one restartpoint or checkpoint
9065  * happens at a time.
9066  */
9067  LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
9068 
9069  /* Get a local copy of the last safe checkpoint record. */
9071  lastCheckPointRecPtr = XLogCtl->lastCheckPointRecPtr;
9072  lastCheckPointEndPtr = XLogCtl->lastCheckPointEndPtr;
9073  lastCheckPoint = XLogCtl->lastCheckPoint;
9075 
9076  /*
9077  * Check that we're still in recovery mode. It's ok if we exit recovery
9078  * mode after this check, the restart point is valid anyway.
9079  */
9080  if (!RecoveryInProgress())
9081  {
9082  ereport(DEBUG2,
9083  (errmsg("skipping restartpoint, recovery has already ended")));
9084  LWLockRelease(CheckpointLock);
9085  return false;
9086  }
9087 
9088  /*
9089  * If the last checkpoint record we've replayed is already our last
9090  * restartpoint, we can't perform a new restart point. We still update
9091  * minRecoveryPoint in that case, so that if this is a shutdown restart
9092  * point, we won't start up earlier than before. That's not strictly
9093  * necessary, but when hot standby is enabled, it would be rather weird if
9094  * the database opened up for read-only connections at a point-in-time
9095  * before the last shutdown. Such time travel is still possible in case of
9096  * immediate shutdown, though.
9097  *
9098  * We don't explicitly advance minRecoveryPoint when we do create a
9099  * restartpoint. It's assumed that flushing the buffers will do that as a
9100  * side-effect.
9101  */
9102  if (XLogRecPtrIsInvalid(lastCheckPointRecPtr) ||
9103  lastCheckPoint.redo <= ControlFile->checkPointCopy.redo)
9104  {
9105  ereport(DEBUG2,
9106  (errmsg("skipping restartpoint, already performed at %X/%X",
9107  (uint32) (lastCheckPoint.redo >> 32),
9108  (uint32) lastCheckPoint.redo)));
9109 
9111  if (flags & CHECKPOINT_IS_SHUTDOWN)
9112  {
9113  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
9115  ControlFile->time = (pg_time_t) time(NULL);
9117  LWLockRelease(ControlFileLock);
9118  }
9119  LWLockRelease(CheckpointLock);
9120  return false;
9121  }
9122 
9123  /*
9124  * Update the shared RedoRecPtr so that the startup process can calculate
9125  * the number of segments replayed since last restartpoint, and request a
9126  * restartpoint if it exceeds CheckPointSegments.
9127  *
9128  * Like in CreateCheckPoint(), hold off insertions to update it, although
9129  * during recovery this is just pro forma, because no WAL insertions are
9130  * happening.
9131  */
9133  RedoRecPtr = XLogCtl->Insert.RedoRecPtr = lastCheckPoint.redo;
9135 
9136  /* Also update the info_lck-protected copy */
9138  XLogCtl->RedoRecPtr = lastCheckPoint.redo;
9140 
9141  /*
9142  * Prepare to accumulate statistics.
9143  *
9144  * Note: because it is possible for log_checkpoints to change while a
9145  * checkpoint proceeds, we always accumulate stats, even if
9146  * log_checkpoints is currently off.
9147  */
9148  MemSet(&CheckpointStats, 0, sizeof(CheckpointStats));
9150 
9151  if (log_checkpoints)
9152  LogCheckpointStart(flags, true);
9153 
9154  CheckPointGuts(lastCheckPoint.redo, flags);
9155 
9156  /*
9157  * Remember the prior checkpoint's redo ptr for
9158  * UpdateCheckPointDistanceEstimate()
9159  */
9160  PriorRedoPtr = ControlFile->checkPointCopy.redo;
9161 
9162  /*
9163  * Update pg_control, using current time. Check that it still shows
9164  * DB_IN_ARCHIVE_RECOVERY state and an older checkpoint, else do nothing;
9165  * this is a quick hack to make sure nothing really bad happens if somehow
9166  * we get here after the end-of-recovery checkpoint.
9167  */
9168  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
9170  ControlFile->checkPointCopy.redo < lastCheckPoint.redo)
9171  {
9172  ControlFile->checkPoint = lastCheckPointRecPtr;
9173  ControlFile->checkPointCopy = lastCheckPoint;
9174  ControlFile->time = (pg_time_t) time(NULL);
9175 
9176  /*
9177  * Ensure minRecoveryPoint is past the checkpoint record. Normally,
9178  * this will have happened already while writing out dirty buffers,
9179  * but not necessarily - e.g. because no buffers were dirtied. We do
9180  * this because a non-exclusive base backup uses minRecoveryPoint to
9181  * determine which WAL files must be included in the backup, and the
9182  * file (or files) containing the checkpoint record must be included,
9183  * at a minimum. Note that for an ordinary restart of recovery there's
9184  * no value in having the minimum recovery point any earlier than this
9185  * anyway, because redo will begin just after the checkpoint record.
9186  */
9187  if (ControlFile->minRecoveryPoint < lastCheckPointEndPtr)
9188  {
9189  ControlFile->minRecoveryPoint = lastCheckPointEndPtr;
9191 
9192  /* update local copy */
9195  }
9196  if (flags & CHECKPOINT_IS_SHUTDOWN)
9199  }
9200  LWLockRelease(ControlFileLock);
9201 
9202  /*
9203  * Update the average distance between checkpoints/restartpoints if the
9204  * prior checkpoint exists.
9205  */
9206  if (PriorRedoPtr != InvalidXLogRecPtr)
9208 
9209  /*
9210  * Delete old log files, those no longer needed for last restartpoint to
9211  * prevent the disk holding the xlog from growing full.
9212  */
9214 
9215  /*
9216  * Retreat _logSegNo using the current end of xlog replayed or received,
9217  * whichever is later.
9218  */
9219  receivePtr = GetWalRcvWriteRecPtr(NULL, NULL);
9220  replayPtr = GetXLogReplayRecPtr(&replayTLI);
9221  endptr = (receivePtr < replayPtr) ? replayPtr : receivePtr;
9222  KeepLogSeg(endptr, &_logSegNo);
9223  _logSegNo--;
9224 
9225  /*
9226  * Try to recycle segments on a useful timeline. If we've been promoted
9227  * since the beginning of this restartpoint, use the new timeline chosen
9228  * at end of recovery (RecoveryInProgress() sets ThisTimeLineID in that
9229  * case). If we're still in recovery, use the timeline we're currently
9230  * replaying.
9231  *
9232  * There is no guarantee that the WAL segments will be useful on the
9233  * current timeline; if recovery proceeds to a new timeline right after
9234  * this, the pre-allocated WAL segments on this timeline will not be used,
9235  * and will go wasted until recycled on the next restartpoint. We'll live
9236  * with that.
9237  */
9238  if (RecoveryInProgress())
9239  ThisTimeLineID = replayTLI;
9240 
9241  RemoveOldXlogFiles(_logSegNo, RedoRecPtr, endptr);
9242 
9243  /*
9244  * Make more log segments if needed. (Do this after recycling old log
9245  * segments, since that may supply some of the needed files.)
9246  */
9247  PreallocXlogFiles(endptr);
9248 
9249  /*
9250  * ThisTimeLineID is normally not set when we're still in recovery.
9251  * However, recycling/preallocating segments above needed ThisTimeLineID
9252  * to determine which timeline to install the segments on. Reset it now,
9253  * to restore the normal state of affairs for debugging purposes.
9254  */
9255  if (RecoveryInProgress())
9256  ThisTimeLineID = 0;
9257 
9258  /*
9259  * Truncate pg_subtrans if possible. We can throw away all data before
9260  * the oldest XMIN of any running transaction. No future transaction will
9261  * attempt to reference any pg_subtrans entry older than that (see Asserts
9262  * in subtrans.c). When hot standby is disabled, though, we mustn't do
9263  * this because StartupSUBTRANS hasn't been called yet.
9264  */
9265  if (EnableHotStandby)
9267 
9268  /* Real work is done, but log and update before releasing lock. */
9269  LogCheckpointEnd(true);
9270 
9271  xtime = GetLatestXTime();
9273  (errmsg("recovery restart point at %X/%X",
9274  (uint32) (lastCheckPoint.redo >> 32), (uint32) lastCheckPoint.redo),
9275  xtime ? errdetail("Last completed transaction was at log time %s.",
9276  timestamptz_to_str(xtime)) : 0));
9277 
9278  LWLockRelease(CheckpointLock);
9279 
9280  /*
9281  * Finally, execute archive_cleanup_command, if any.
9282  */
9283  if (archiveCleanupCommand && strcmp(archiveCleanupCommand, "") != 0)
9285  "archive_cleanup_command",
9286  false);
9287 
9288  return true;
9289 }
static void UpdateCheckPointDistanceEstimate(uint64 nbytes)
Definition: xlog.c:8448
bool log_checkpoints
Definition: xlog.c:101
void ExecuteRecoveryCommand(const char *command, const char *commandName, bool failOnSignal)
Definition: xlogarchive.c:324
#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:1569
int64 TimestampTz
Definition: timestamp.h:39
static void UpdateMinRecoveryPoint(XLogRecPtr lsn, bool force)
Definition: xlog.c:2711
TimestampTz ckpt_start_t
Definition: xlog.h:235
slock_t info_lck
Definition: xlog.c:710
#define MemSet(start, val, len)
Definition: c.h:955
static void CheckPointGuts(XLogRecPtr checkPointRedo, int flags)
Definition: xlog.c:8980
TimestampTz GetLatestXTime(void)
Definition: xlog.c:6064
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:7898
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:4793
static void LogCheckpointEnd(bool restartpoint)
Definition: xlog.c:8363
XLogRecPtr GetXLogReplayRecPtr(TimeLineID *replayTLI)
Definition: xlog.c:11130
#define DEBUG2
Definition: elog.h:24
static XLogRecPtr RedoRecPtr
Definition: xlog.c:365
static void PreallocXlogFiles(XLogRecPtr endptr)
Definition: xlog.c:3813
uint64 XLogSegNo
Definition: xlogdefs.h:41
int errdetail(const char *fmt,...)
Definition: elog.c:860
unsigned int uint32
Definition: c.h:358
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:9300
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:3943
TransactionId GetOldestXmin(Relation rel, int flags)
Definition: procarray.c:1304
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:784
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:8345
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:1729
#define XLByteToSeg(xlrp, logSegNo, wal_segsz_bytes)

◆ DataChecksumsEnabled()

bool DataChecksumsEnabled ( void  )

Definition at line 4822 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().

4823 {
4824  Assert(ControlFile != NULL);
4825  return (ControlFile->data_checksum_version > 0);
4826 }
uint32 data_checksum_version
Definition: pg_control.h:222
static ControlFileData * ControlFile
Definition: xlog.c:721
#define Assert(condition)
Definition: c.h:732

◆ do_pg_abort_backup()

void do_pg_abort_backup ( void  )

Definition at line 11102 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().

11103 {
11104  /*
11105  * Quick exit if session is not keeping around a non-exclusive backup
11106  * already started.
11107  */
11109  return;
11110 
11115 
11118  {
11119  XLogCtl->Insert.forcePageWrites = false;
11120  }
11122 }
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:732
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 10178 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().

10182 {
10183  bool exclusive = (labelfile == NULL);
10184  bool backup_started_in_recovery = false;
10185  XLogRecPtr checkpointloc;
10186  XLogRecPtr startpoint;
10187  TimeLineID starttli;
10188  pg_time_t stamp_time;
10189  char strfbuf[128];
10190  char xlogfilename[MAXFNAMELEN];
10191  XLogSegNo _logSegNo;
10192  struct stat stat_buf;
10193  FILE *fp;
10194 
10195  backup_started_in_recovery = RecoveryInProgress();
10196 
10197  /*
10198  * Currently only non-exclusive backup can be taken during recovery.
10199  */
10200  if (backup_started_in_recovery && exclusive)
10201  ereport(ERROR,
10202  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10203  errmsg("recovery is in progress"),
10204  errhint("WAL control functions cannot be executed during recovery.")));
10205 
10206  /*
10207  * During recovery, we don't need to check WAL level. Because, if WAL
10208  * level is not sufficient, it's impossible to get here during recovery.
10209  */
10210  if (!backup_started_in_recovery && !XLogIsNeeded())
10211  ereport(ERROR,
10212  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10213  errmsg("WAL level not sufficient for making an online backup"),
10214  errhint("wal_level must be set to \"replica\" or \"logical\" at server start.")));
10215 
10216  if (strlen(backupidstr) > MAXPGPATH)
10217  ereport(ERROR,
10218  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
10219  errmsg("backup label too long (max %d bytes)",
10220  MAXPGPATH)));
10221 
10222  /*
10223  * Mark backup active in shared memory. We must do full-page WAL writes
10224  * during an on-line backup even if not doing so at other times, because
10225  * it's quite possible for the backup dump to obtain a "torn" (partially
10226  * written) copy of a database page if it reads the page concurrently with
10227  * our write to the same page. This can be fixed as long as the first
10228  * write to the page in the WAL sequence is a full-page write. Hence, we
10229  * turn on forcePageWrites and then force a CHECKPOINT, to ensure there
10230  * are no dirty pages in shared memory that might get dumped while the
10231  * backup is in progress without having a corresponding WAL record. (Once
10232  * the backup is complete, we need not force full-page writes anymore,
10233  * since we expect that any pages not modified during the backup interval
10234  * must have been correctly captured by the backup.)
10235  *
10236  * Note that forcePageWrites has no effect during an online backup from
10237  * the standby.
10238  *
10239  * We must hold all the insertion locks to change the value of
10240  * forcePageWrites, to ensure adequate interlocking against
10241  * XLogInsertRecord().
10242  */
10244  if (exclusive)
10245  {
10246  /*
10247  * At first, mark that we're now starting an exclusive backup, to
10248  * ensure that there are no other sessions currently running
10249  * pg_start_backup() or pg_stop_backup().
10250  */
10252  {
10254  ereport(ERROR,
10255  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10256  errmsg("a backup is already in progress"),
10257  errhint("Run pg_stop_backup() and try again.")));
10258  }
10260  }
10261  else
10263  XLogCtl->Insert.forcePageWrites = true;
10265 
10266  /* Ensure we release forcePageWrites if fail below */
10268  {
10269  bool gotUniqueStartpoint = false;
10270  DIR *tblspcdir;
10271  struct dirent *de;
10272  tablespaceinfo *ti;
10273  int datadirpathlen;
10274 
10275  /*
10276  * Force an XLOG file switch before the checkpoint, to ensure that the
10277  * WAL segment the checkpoint is written to doesn't contain pages with
10278  * old timeline IDs. That would otherwise happen if you called
10279  * pg_start_backup() right after restoring from a PITR archive: the
10280  * first WAL segment containing the startup checkpoint has pages in
10281  * the beginning with the old timeline ID. That can cause trouble at
10282  * recovery: we won't have a history file covering the old timeline if
10283  * pg_wal directory was not included in the base backup and the WAL
10284  * archive was cleared too before starting the backup.
10285  *
10286  * This also ensures that we have emitted a WAL page header that has
10287  * XLP_BKP_REMOVABLE off before we emit the checkpoint record.
10288  * Therefore, if a WAL archiver (such as pglesslog) is trying to
10289  * compress out removable backup blocks, it won't remove any that
10290  * occur after this point.
10291  *
10292  * During recovery, we skip forcing XLOG file switch, which means that
10293  * the backup taken during recovery is not available for the special
10294  * recovery case described above.
10295  */
10296  if (!backup_started_in_recovery)
10297  RequestXLogSwitch(false);
10298 
10299  do
10300  {
10301  bool checkpointfpw;
10302 
10303  /*
10304  * Force a CHECKPOINT. Aside from being necessary to prevent torn
10305  * page problems, this guarantees that two successive backup runs
10306  * will have different checkpoint positions and hence different
10307  * history file names, even if nothing happened in between.
10308  *
10309  * During recovery, establish a restartpoint if possible. We use
10310  * the last restartpoint as the backup starting checkpoint. This
10311  * means that two successive backup runs can have same checkpoint
10312  * positions.
10313  *
10314  * Since the fact that we are executing do_pg_start_backup()
10315  * during recovery means that checkpointer is running, we can use
10316  * RequestCheckpoint() to establish a restartpoint.
10317  *
10318  * We use CHECKPOINT_IMMEDIATE only if requested by user (via
10319  * passing fast = true). Otherwise this can take awhile.
10320  */
10322  (fast ? CHECKPOINT_IMMEDIATE : 0));
10323 
10324  /*
10325  * Now we need to fetch the checkpoint record location, and also
10326  * its REDO pointer. The oldest point in WAL that would be needed
10327  * to restore starting from the checkpoint is precisely the REDO
10328  * pointer.
10329  */
10330  LWLockAcquire(ControlFileLock, LW_SHARED);
10331  checkpointloc = ControlFile->checkPoint;
10332  startpoint = ControlFile->checkPointCopy.redo;
10334  checkpointfpw = ControlFile->checkPointCopy.fullPageWrites;
10335  LWLockRelease(ControlFileLock);
10336 
10337  if (backup_started_in_recovery)
10338  {
10339  XLogRecPtr recptr;
10340 
10341  /*
10342  * Check to see if all WAL replayed during online backup
10343  * (i.e., since last restartpoint used as backup starting
10344  * checkpoint) contain full-page writes.
10345  */
10347  recptr = XLogCtl->lastFpwDisableRecPtr;
10349 
10350  if (!checkpointfpw || startpoint <= recptr)
10351  ereport(ERROR,
10352  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10353  errmsg("WAL generated with full_page_writes=off was replayed "
10354  "since last restartpoint"),
10355  errhint("This means that the backup being taken on the standby "
10356  "is corrupt and should not be used. "
10357  "Enable full_page_writes and run CHECKPOINT on the master, "
10358  "and then try an online backup again.")));
10359 
10360  /*
10361  * During recovery, since we don't use the end-of-backup WAL
10362  * record and don't write the backup history file, the
10363  * starting WAL location doesn't need to be unique. This means
10364  * that two base backups started at the same time might use
10365  * the same checkpoint as starting locations.
10366  */
10367  gotUniqueStartpoint = true;
10368  }
10369 
10370  /*
10371  * If two base backups are started at the same time (in WAL sender
10372  * processes), we need to make sure that they use different
10373  * checkpoints as starting locations, because we use the starting
10374  * WAL location as a unique identifier for the base backup in the
10375  * end-of-backup WAL record and when we write the backup history
10376  * file. Perhaps it would be better generate a separate unique ID
10377  * for each backup instead of forcing another checkpoint, but
10378  * taking a checkpoint right after another is not that expensive
10379  * either because only few buffers have been dirtied yet.
10380  */
10382  if (XLogCtl->Insert.lastBackupStart < startpoint)
10383  {
10384  XLogCtl->Insert.lastBackupStart = startpoint;
10385  gotUniqueStartpoint = true;
10386  }
10388  } while (!gotUniqueStartpoint);
10389 
10390  XLByteToSeg(startpoint, _logSegNo, wal_segment_size);
10391  XLogFileName(xlogfilename, starttli, _logSegNo, wal_segment_size);
10392 
10393  /*
10394  * Construct tablespace_map file
10395  */
10396  if (exclusive)
10397  tblspcmapfile = makeStringInfo();
10398 
10399  datadirpathlen = strlen(DataDir);
10400 
10401  /* Collect information about all tablespaces */
10402  tblspcdir = AllocateDir("pg_tblspc");
10403  while ((de = ReadDir(tblspcdir, "pg_tblspc")) != NULL)
10404  {
10405  char fullpath[MAXPGPATH + 10];
10406  char linkpath[MAXPGPATH];
10407  char *relpath = NULL;
10408  int rllen;
10409  StringInfoData buflinkpath;
10410  char *s = linkpath;
10411 
10412  /* Skip special stuff */
10413  if (strcmp(de->d_name, ".") == 0 || strcmp(de->d_name, "..") == 0)
10414  continue;
10415 
10416  snprintf(fullpath, sizeof(fullpath), "pg_tblspc/%s", de->d_name);
10417 
10418 #if defined(HAVE_READLINK) || defined(WIN32)
10419  rllen = readlink(fullpath, linkpath, sizeof(linkpath));
10420  if (rllen < 0)
10421  {
10422  ereport(WARNING,
10423  (errmsg("could not read symbolic link \"%s\": %m",
10424  fullpath)));
10425  continue;
10426  }
10427  else if (rllen >= sizeof(linkpath))
10428  {
10429  ereport(WARNING,
10430  (errmsg("symbolic link \"%s\" target is too long",
10431  fullpath)));
10432  continue;
10433  }
10434  linkpath[rllen] = '\0';
10435 
10436  /*
10437  * Add the escape character '\\' before newline in a string to
10438  * ensure that we can distinguish between the newline in the
10439  * tablespace path and end of line while reading tablespace_map
10440  * file during archive recovery.
10441  */
10442  initStringInfo(&buflinkpath);
10443 
10444  while (*s)
10445  {
10446  if ((*s == '\n' || *s == '\r') && needtblspcmapfile)
10447  appendStringInfoChar(&buflinkpath, '\\');
10448  appendStringInfoChar(&buflinkpath, *s++);
10449  }
10450 
10451  /*
10452  * Relpath holds the relative path of the tablespace directory
10453  * when it's located within PGDATA, or NULL if it's located
10454  * elsewhere.
10455  */
10456  if (rllen > datadirpathlen &&
10457  strncmp(linkpath, DataDir, datadirpathlen) == 0 &&
10458  IS_DIR_SEP(linkpath[datadirpathlen]))
10459  relpath = linkpath + datadirpathlen + 1;
10460 
10461  ti = palloc(sizeof(tablespaceinfo));
10462  ti->oid = pstrdup(de->d_name);
10463  ti->path = pstrdup(buflinkpath.data);
10464  ti->rpath = relpath ? pstrdup(relpath) : NULL;
10465  ti->size = infotbssize ? sendTablespace(fullpath, true) : -1;
10466 
10467  if (tablespaces)
10468  *tablespaces = lappend(*tablespaces, ti);
10469 
10470  appendStringInfo(tblspcmapfile, "%s %s\n", ti->oid, ti->path);
10471 
10472  pfree(buflinkpath.data);
10473 #else
10474 
10475  /*
10476  * If the platform does not have symbolic links, it should not be
10477  * possible to have tablespaces - clearly somebody else created
10478  * them. Warn about it and ignore.
10479  */
10480  ereport(WARNING,
10481  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
10482  errmsg("tablespaces are not supported on this platform")));
10483 #endif
10484  }
10485  FreeDir(tblspcdir);
10486 
10487  /*
10488  * Construct backup label file
10489  */
10490  if (exclusive)
10491  labelfile = makeStringInfo();
10492 
10493  /* Use the log timezone here, not the session timezone */
10494  stamp_time = (pg_time_t) time(NULL);
10495  pg_strftime(strfbuf, sizeof(strfbuf),
10496  "%Y-%m-%d %H:%M:%S %Z",
10497  pg_localtime(&stamp_time, log_timezone));
10498  appendStringInfo(labelfile, "START WAL LOCATION: %X/%X (file %s)\n",
10499  (uint32) (startpoint >> 32), (uint32) startpoint, xlogfilename);
10500  appendStringInfo(labelfile, "CHECKPOINT LOCATION: %X/%X\n",
10501  (uint32) (checkpointloc >> 32), (uint32) checkpointloc);
10502  appendStringInfo(labelfile, "BACKUP METHOD: %s\n",
10503  exclusive ? "pg_start_backup" : "streamed");
10504  appendStringInfo(labelfile, "BACKUP FROM: %s\n",
10505  backup_started_in_recovery ? "standby" : "master");
10506  appendStringInfo(labelfile, "START TIME: %s\n", strfbuf);
10507  appendStringInfo(labelfile, "LABEL: %s\n", backupidstr);
10508  appendStringInfo(labelfile, "START TIMELINE: %u\n", starttli);
10509 
10510  /*
10511  * Okay, write the file, or return its contents to caller.
10512  */
10513  if (exclusive)
10514  {
10515  /*
10516  * Check for existing backup label --- implies a backup is already
10517  * running. (XXX given that we checked exclusiveBackupState
10518  * above, maybe it would be OK to just unlink any such label
10519  * file?)
10520  */
10521  if (stat(BACKUP_LABEL_FILE, &stat_buf) != 0)
10522  {
10523  if (errno != ENOENT)
10524  ereport(ERROR,
10526  errmsg("could not stat file \"%s\": %m",
10527  BACKUP_LABEL_FILE)));
10528  }
10529  else
10530  ereport(ERROR,
10531  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10532  errmsg("a backup is already in progress"),
10533  errhint("If you're sure there is no backup in progress, remove file \"%s\" and try again.",
10534  BACKUP_LABEL_FILE)));
10535 
10536  fp = AllocateFile(BACKUP_LABEL_FILE, "w");
10537 
10538  if (!fp)
10539  ereport(ERROR,
10541  errmsg("could not create file \"%s\": %m",
10542  BACKUP_LABEL_FILE)));
10543  if (fwrite(labelfile->data, labelfile->len, 1, fp) != 1 ||
10544  fflush(fp) != 0 ||
10545  pg_fsync(fileno(fp)) != 0 ||
10546  ferror(fp) ||
10547  FreeFile(fp))
10548  ereport(ERROR,
10550  errmsg("could not write file \"%s\": %m",
10551  BACKUP_LABEL_FILE)));
10552  /* Allocated locally for exclusive backups, so free separately */
10553  pfree(labelfile->data);
10554  pfree(labelfile);
10555 
10556  /* Write backup tablespace_map file. */
10557  if (tblspcmapfile->len > 0)
10558  {
10559  if (stat(TABLESPACE_MAP, &stat_buf) != 0)
10560  {
10561  if (errno != ENOENT)
10562  ereport(ERROR,
10564  errmsg("could not stat file \"%s\": %m",
10565  TABLESPACE_MAP)));
10566  }
10567  else
10568  ereport(ERROR,
10569  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10570  errmsg("a backup is already in progress"),
10571  errhint("If you're sure there is no backup in progress, remove file \"%s\" and try again.",
10572  TABLESPACE_MAP)));
10573 
10574  fp = AllocateFile(TABLESPACE_MAP, "w");
10575 
10576  if (!fp)
10577  ereport(ERROR,
10579  errmsg("could not create file \"%s\": %m",
10580  TABLESPACE_MAP)));
10581  if (fwrite(tblspcmapfile->data, tblspcmapfile->len, 1, fp) != 1 ||
10582  fflush(fp) != 0 ||
10583  pg_fsync(fileno(fp)) != 0 ||
10584  ferror(fp) ||
10585  FreeFile(fp))
10586  ereport(ERROR,
10588  errmsg("could not write file \"%s\": %m",
10589  TABLESPACE_MAP)));
10590  }
10591 
10592  /* Allocated locally for exclusive backups, so free separately */
10593  pfree(tblspcmapfile->data);
10594  pfree(tblspcmapfile);
10595  }
10596  }
10598 
10599  /*
10600  * Mark that start phase has correctly finished for an exclusive backup.
10601  * Session-level locks are updated as well to reflect that state.
10602  *
10603  * Note that CHECK_FOR_INTERRUPTS() must not occur while updating backup
10604  * counters and session-level lock. Otherwise they can be updated
10605  * inconsistently, and which might cause do_pg_abort_backup() to fail.
10606  */
10607  if (exclusive)
10608  {
10611 
10612  /* Set session-level lock */
10615  }
10616  else
10618 
10619  /*
10620  * We're done. As a convenience, return the starting WAL location.
10621  */
10622  if (starttli_p)
10623  *starttli_p = starttli;
10624  return startpoint;
10625 }
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:9377
int errhint(const char *fmt,...)
Definition: elog.c:974
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:1161
#define XLogIsNeeded()
Definition: xlog.h:181
char * rpath
Definition: basebackup.h:28
StringInfo makeStringInfo(void)
Definition: stringinfo.c:28
slock_t info_lck
Definition: xlog.c:710
int errcode(int sqlerrcode)
Definition: elog.c:570
CheckPoint checkPointCopy
Definition: pg_control.h:131
XLogCtlInsert Insert
Definition: xlog.c:590
bool RecoveryInProgress(void)
Definition: xlog.c:7898
static bool backup_started_in_recovery
Definition: basebackup.c:78
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:362
#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:1031
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition: stringinfo.c:78
bool forcePageWrites
Definition: xlog.c:564
Definition: dirent.c:25
#define ERROR
Definition: elog.h:43
struct stat stat_buf
Definition: pg_standby.c:101
#define MAXPGPATH
uint64 XLogSegNo
Definition: xlogdefs.h:41
#define readlink(path, buf, size)
Definition: win32_port.h:231
int errcode_for_file_access(void)
Definition: elog.c:593
FILE * AllocateFile(const char *name, const char *mode)
Definition: fd.c:2207
unsigned int uint32
Definition: c.h:358
int64 sendTablespace(char *path, bool sizeonly)
Definition: basebackup.c:957
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2468
#define CHECKPOINT_FORCE
Definition: xlog.h:215
#define ereport(elevel, rest)
Definition: elog.h:141
List * lappend(List *list, void *datum)
Definition: list.c:321
void appendStringInfoChar(StringInfo str, char ch)
Definition: stringinfo.c:175
void initStringInfo(StringInfo str)
Definition: stringinfo.c:46
#define WARNING
Definition: elog.h:40
int nonExclusiveBackups
Definition: xlog.c:576
#define stat(a, b)
Definition: win32_port.h:264
#define MAXFNAMELEN
#define SpinLockRelease(lock)
Definition: spin.h:64
static void pg_start_backup_callback(int code, Datum arg)
Definition: xlog.c:10629
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:2534
#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:2406
void * palloc(Size size)
Definition: mcxt.c:924
TimeLineID ThisTimeLineID
Definition: pg_control.h:39
int errmsg(const char *fmt,...)
Definition: elog.c:784
#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:359
int pg_fsync(int fd)
Definition: fd.c:333
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:2586
void RequestCheckpoint(int flags)
Definition: checkpointer.c:952
#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 10697 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().

10698 {
10699  bool exclusive = (labelfile == NULL);
10700  bool backup_started_in_recovery = false;
10701  XLogRecPtr startpoint;
10702  XLogRecPtr stoppoint;
10703  TimeLineID stoptli;
10704  pg_time_t stamp_time;
10705  char strfbuf[128];
10706  char histfilepath[MAXPGPATH];
10707  char startxlogfilename[MAXFNAMELEN];
10708  char stopxlogfilename[MAXFNAMELEN];
10709  char lastxlogfilename[MAXFNAMELEN];
10710  char histfilename[MAXFNAMELEN];
10711  char backupfrom[20];
10712  XLogSegNo _logSegNo;
10713  FILE *lfp;
10714  FILE *fp;
10715  char ch;
10716  int seconds_before_warning;
10717  int waits = 0;
10718  bool reported_waiting = false;
10719  char *remaining;
10720  char *ptr;
10721  uint32 hi,
10722  lo;
10723 
10724  backup_started_in_recovery = RecoveryInProgress();
10725 
10726  /*
10727  * Currently only non-exclusive backup can be taken during recovery.
10728  */
10729  if (backup_started_in_recovery && exclusive)
10730  ereport(ERROR,
10731  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10732  errmsg("recovery is in progress"),
10733  errhint("WAL control functions cannot be executed during recovery.")));
10734 
10735  /*
10736  * During recovery, we don't need to check WAL level. Because, if WAL
10737  * level is not sufficient, it's impossible to get here during recovery.
10738  */
10739  if (!backup_started_in_recovery && !XLogIsNeeded())
10740  ereport(ERROR,
10741  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10742  errmsg("WAL level not sufficient for making an online backup"),
10743  errhint("wal_level must be set to \"replica\" or \"logical\" at server start.")));
10744 
10745  if (exclusive)
10746  {
10747  /*
10748  * At first, mark that we're now stopping an exclusive backup, to
10749  * ensure that there are no other sessions currently running
10750  * pg_start_backup() or pg_stop_backup().
10751  */
10754  {
10756  ereport(ERROR,
10757  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10758  errmsg("exclusive backup not in progress")));
10759  }
10762 
10763  /*
10764  * Remove backup_label. In case of failure, the state for an exclusive
10765  * backup is switched back to in-progress.
10766  */
10768  {
10769  /*
10770  * Read the existing label file into memory.
10771  */
10772  struct stat statbuf;
10773  int r;
10774 
10775  if (stat(BACKUP_LABEL_FILE, &statbuf))
10776  {
10777  /* should not happen per the upper checks */
10778  if (errno != ENOENT)
10779  ereport(ERROR,
10781  errmsg("could not stat file \"%s\": %m",
10782  BACKUP_LABEL_FILE)));
10783  ereport(ERROR,
10784  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10785  errmsg("a backup is not in progress")));
10786  }
10787 
10788  lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
10789  if (!lfp)
10790  {
10791  ereport(ERROR,
10793  errmsg("could not read file \"%s\": %m",
10794  BACKUP_LABEL_FILE)));
10795  }
10796  labelfile = palloc(statbuf.st_size + 1);
10797  r = fread(labelfile, statbuf.st_size, 1, lfp);
10798  labelfile[statbuf.st_size] = '\0';
10799 
10800  /*
10801  * Close and remove the backup label file
10802  */
10803  if (r != 1 || ferror(lfp) || FreeFile(lfp))
10804  ereport(ERROR,
10806  errmsg("could not read file \"%s\": %m",
10807  BACKUP_LABEL_FILE)));
10809 
10810  /*
10811  * Remove tablespace_map file if present, it is created only if
10812  * there are tablespaces.
10813  */
10815  }
10817  }
10818 
10819  /*
10820  * OK to update backup counters, forcePageWrites and session-level lock.
10821  *
10822  * Note that CHECK_FOR_INTERRUPTS() must not occur while updating them.
10823  * Otherwise they can be updated inconsistently, and which might cause
10824  * do_pg_abort_backup() to fail.
10825  */
10827  if (exclusive)
10828  {
10830  }
10831  else
10832  {
10833  /*
10834  * The user-visible pg_start/stop_backup() functions that operate on
10835  * exclusive backups can be called at any time, but for non-exclusive
10836  * backups, it is expected that each do_pg_start_backup() call is
10837  * matched by exactly one do_pg_stop_backup() call.
10838  */
10841  }
10842 
10845  {
10846  XLogCtl->Insert.forcePageWrites = false;
10847  }
10848 
10849  /*
10850  * Clean up session-level lock.
10851  *
10852  * You might think that WALInsertLockRelease() can be called before
10853  * cleaning up session-level lock because session-level lock doesn't need
10854  * to be protected with WAL insertion lock. But since
10855  * CHECK_FOR_INTERRUPTS() can occur in it, session-level lock must be
10856  * cleaned up before it.
10857  */
10859 
10861 
10862  /*
10863  * Read and parse the START WAL LOCATION line (this code is pretty crude,
10864  * but we are not expecting any variability in the file format).
10865  */
10866  if (sscanf(labelfile, "START WAL LOCATION: %X/%X (file %24s)%c",
10867  &hi, &lo, startxlogfilename,
10868  &ch) != 4 || ch != '\n')
10869  ereport(ERROR,
10870  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10871  errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
10872  startpoint = ((uint64) hi) << 32 | lo;
10873  remaining = strchr(labelfile, '\n') + 1; /* %n is not portable enough */
10874 
10875  /*
10876  * Parse the BACKUP FROM line. If we are taking an online backup from the
10877  * standby, we confirm that the standby has not been promoted during the
10878  * backup.
10879  */
10880  ptr = strstr(remaining, "BACKUP FROM:");
10881  if (!ptr || sscanf(ptr, "BACKUP FROM: %19s\n", backupfrom) != 1)
10882  ereport(ERROR,
10883  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10884  errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
10885  if (strcmp(backupfrom, "standby") == 0 && !backup_started_in_recovery)
10886  ereport(ERROR,
10887  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10888  errmsg("the standby was promoted during online backup"),
10889  errhint("This means that the backup being taken is corrupt "
10890  "and should not be used. "
10891  "Try taking another online backup.")));
10892 
10893  /*
10894  * During recovery, we don't write an end-of-backup record. We assume that
10895  * pg_control was backed up last and its minimum recovery point can be
10896  * available as the backup end location. Since we don't have an
10897  * end-of-backup record, we use the pg_control value to check whether
10898  * we've reached the end of backup when starting recovery from this
10899  * backup. We have no way of checking if pg_control wasn't backed up last
10900  * however.
10901  *
10902  * We don't force a switch to new WAL file but it is still possible to
10903  * wait for all the required files to be archived if waitforarchive is
10904  * true. This is okay if we use the backup to start a standby and fetch
10905  * the missing WAL using streaming replication. But in the case of an
10906  * archive recovery, a user should set waitforarchive to true and wait for
10907  * them to be archived to ensure that all the required files are
10908  * available.
10909  *
10910  * We return the current minimum recovery point as the backup end
10911  * location. Note that it can be greater than the exact backup end
10912  * location if the minimum recovery point is updated after the backup of
10913  * pg_control. This is harmless for current uses.
10914  *
10915  * XXX currently a backup history file is for informational and debug
10916  * purposes only. It's not essential for an online backup. Furthermore,
10917  * even if it's created, it will not be archived during recovery because
10918  * an archiver is not invoked. So it doesn't seem worthwhile to write a
10919  * backup history file during recovery.
10920  */
10921  if (backup_started_in_recovery)
10922  {
10923  XLogRecPtr recptr;
10924 
10925  /*
10926  * Check to see if all WAL replayed during online backup contain
10927  * full-page writes.
10928  */
10930  recptr = XLogCtl->lastFpwDisableRecPtr;
10932 
10933  if (startpoint <= recptr)
10934  ereport(ERROR,
10935  (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
10936  errmsg("WAL generated with full_page_writes=off was replayed "
10937  "during online backup"),
10938  errhint("This means that the backup being taken on the standby "
10939  "is corrupt and should not be used. "
10940  "Enable full_page_writes and run CHECKPOINT on the master, "
10941  "and then try an online backup again.")));
10942 
10943 
10944  LWLockAcquire(ControlFileLock, LW_SHARED);
10945  stoppoint = ControlFile->minRecoveryPoint;
10946  stoptli = ControlFile->minRecoveryPointTLI;
10947  LWLockRelease(ControlFileLock);
10948  }
10949  else
10950  {
10951  /*
10952  * Write the backup-end xlog record
10953  */
10954  XLogBeginInsert();
10955  XLogRegisterData((char *) (&startpoint), sizeof(startpoint));
10956  stoppoint = XLogInsert(RM_XLOG_ID, XLOG_BACKUP_END);
10957  stoptli = ThisTimeLineID;
10958 
10959  /*
10960  * Force a switch to a new xlog segment file, so that the backup is
10961  * valid as soon as archiver moves out the current segment file.
10962  */
10963  RequestXLogSwitch(false);
10964 
10965  XLByteToPrevSeg(stoppoint, _logSegNo, wal_segment_size);
10966  XLogFileName(stopxlogfilename, stoptli, _logSegNo, wal_segment_size);
10967 
10968  /* Use the log timezone here, not the session timezone */
10969  stamp_time = (pg_time_t) time(NULL);
10970  pg_strftime(strfbuf, sizeof(strfbuf),
10971  "%Y-%m-%d %H:%M:%S %Z",
10972  pg_localtime(&stamp_time, log_timezone));
10973 
10974  /*
10975  * Write the backup history file
10976  */
10977  XLByteToSeg(startpoint, _logSegNo, wal_segment_size);
10978  BackupHistoryFilePath(histfilepath, stoptli, _logSegNo,
10979  startpoint, wal_segment_size);
10980  fp = AllocateFile(histfilepath, "w");
10981  if (!fp)
10982  ereport(ERROR,
10984  errmsg("could not create file \"%s\": %m",
10985  histfilepath)));
10986  fprintf(fp, "START WAL LOCATION: %X/%X (file %s)\n",
10987  (uint32) (startpoint >> 32), (uint32) startpoint, startxlogfilename);
10988  fprintf(fp, "STOP WAL LOCATION: %X/%X (file %s)\n",
10989  (uint32) (stoppoint >> 32), (uint32) stoppoint, stopxlogfilename);
10990 
10991  /*
10992  * Transfer remaining lines including label and start timeline to
10993  * history file.
10994  */
10995  fprintf(fp, "%s", remaining);
10996  fprintf(fp, "STOP TIME: %s\n", strfbuf);
10997  fprintf(fp, "STOP TIMELINE: %u\n", stoptli);
10998  if (fflush(fp) || ferror(fp) || FreeFile(fp))
10999  ereport(ERROR,
11001  errmsg("could not write file \"%s\": %m",
11002  histfilepath)));
11003 
11004  /*
11005  * Clean out any no-longer-needed history files. As a side effect,
11006  * this will post a .ready file for the newly created history file,
11007  * notifying the archiver that history file may be archived
11008  * immediately.
11009  */
11011  }
11012 
11013  /*
11014  * If archiving is enabled, wait for all the required WAL files to be
11015  * archived before returning. If archiving isn't enabled, the required WAL
11016  * needs to be transported via streaming replication (hopefully with
11017  * wal_keep_segments set high enough), or some more exotic mechanism like
11018  * polling and copying files from pg_wal with script. We have no knowledge
11019  * of those mechanisms, so it's up to the user to ensure that he gets all
11020  * the required WAL.
11021  *
11022  * We wait until both the last WAL file filled during backup and the
11023  * history file have been archived, and assume that the alphabetic sorting
11024  * property of the WAL files ensures any earlier WAL files are safely
11025  * archived as well.
11026  *
11027  * We wait forever, since archive_command is supposed to work and we
11028  * assume the admin wanted his backup to work completely. If you don't
11029  * wish to wait, then either waitforarchive should be passed in as false,
11030  * or you can set statement_timeout. Also, some notices are issued to
11031  * clue in anyone who might be doing this interactively.
11032  */
11033 
11034  if (waitforarchive &&
11035  ((!backup_started_in_recovery && XLogArchivingActive()) ||
11036  (backup_started_in_recovery && XLogArchivingAlways())))
11037  {
11038  XLByteToPrevSeg(stoppoint, _logSegNo, wal_segment_size);
11039  XLogFileName(lastxlogfilename, stoptli, _logSegNo, wal_segment_size);
11040 
11041  XLByteToSeg(startpoint, _logSegNo, wal_segment_size);
11042  BackupHistoryFileName(histfilename, stoptli, _logSegNo,
11043  startpoint, wal_segment_size);
11044 
11045  seconds_before_warning = 60;
11046  waits = 0;
11047 
11048  while (XLogArchiveIsBusy(lastxlogfilename) ||
11049  XLogArchiveIsBusy(histfilename))
11050  {
11052 
11053  if (!reported_waiting && waits > 5)
11054  {
11055  ereport(NOTICE,
11056  (errmsg("base backup done, waiting for required WAL segments to be archived")));
11057  reported_waiting = true;
11058  }
11059 
11060  pg_usleep(1000000L);
11061 
11062  if (++waits >= seconds_before_warning)
11063  {
11064  seconds_before_warning *= 2; /* This wraps in >10 years... */
11065  ereport(WARNING,
11066  (errmsg("still waiting for all required WAL segments to be archived (%d seconds elapsed)",
11067  waits),
11068  errhint("Check that your archive_command is executing properly. "
11069  "You can safely cancel this backup, "
11070  "but the database backup will not be usable without all the WAL segments.")));
11071  }
11072  }
11073 
11074  ereport(NOTICE,
11075  (errmsg("all required WAL segments have been archived")));
11076  }
11077  else if (waitforarchive)
11078  ereport(NOTICE,
11079  (errmsg("WAL archiving is not enabled; you must ensure that all required WAL segments are copied through other means to complete the backup")));
11080 
11081  /*
11082  * We're done. As a convenience, return the ending WAL location.
11083  */
11084  if (stoptli_p)
11085  *stoptli_p = stoptli;
11086  return stoppoint;
11087 }
int remaining
Definition: informix.c:687
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:9377
#define DEBUG1
Definition: elog.h:25
int errhint(const char *fmt,...)
Definition: elog.c:974
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:570
XLogCtlInsert Insert
Definition: xlog.c:590
#define BackupHistoryFileName(fname, tli, logSegNo, startpoint, wal_segsz_bytes)
bool RecoveryInProgress(void)
Definition: xlog.c:7898
static bool backup_started_in_recovery
Definition: basebackup.c:78
#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:362
#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:4209
#define MAXPGPATH
uint64 XLogSegNo
Definition: xlogdefs.h:41
int errcode_for_file_access(void)
Definition: elog.c:593
FILE * AllocateFile(const char *name, const char *mode)
Definition: fd.c:2207
unsigned int uint32
Definition: c.h:358
#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:264
#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:656
uint64 XLogRecPtr
Definition: xlogdefs.h:21
#define Assert(condition)
Definition: c.h:732
#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:10658
#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:698
int FreeFile(FILE *file)
Definition: fd.c:2406
void * palloc(Size size)
Definition: mcxt.c:924
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define BACKUP_LABEL_FILE
Definition: xlog.h:359
#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 12118 of file xlog.c.

References DEBUG1, LOG, readSource, and XLOG_FROM_PG_WAL.

Referenced by ReadRecord(), and XLogPageRead().

12119 {
12120  static XLogRecPtr lastComplaint = 0;
12121 
12122  if (readSource == XLOG_FROM_PG_WAL && emode == LOG)
12123  {
12124  if (RecPtr == lastComplaint)
12125  emode = DEBUG1;
12126  else
12127  lastComplaint = RecPtr;
12128  }
12129  return emode;
12130 }
#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 5462 of file xlog.c.

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

Referenced by StartupXLOG().

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