PostgreSQL Source Code  git master
xlog.c File Reference
#include "postgres.h"
#include <ctype.h>
#include <math.h>
#include <time.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <unistd.h>
#include "access/clog.h"
#include "access/commit_ts.h"
#include "access/heaptoast.h"
#include "access/multixact.h"
#include "access/rewriteheap.h"
#include "access/subtrans.h"
#include "access/timeline.h"
#include "access/transam.h"
#include "access/twophase.h"
#include "access/xact.h"
#include "access/xlog_internal.h"
#include "access/xloginsert.h"
#include "access/xlogreader.h"
#include "access/xlogutils.h"
#include "catalog/catversion.h"
#include "catalog/pg_control.h"
#include "catalog/pg_database.h"
#include "commands/tablespace.h"
#include "common/controldata_utils.h"
#include "miscadmin.h"
#include "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)
 
static bool WaitForWALToBecomeAvailable (XLogRecPtr RecPtr, bool randAccess, bool fetching_ckpt, XLogRecPtr tliRecPtr)
 
static int emode_for_corrupt_record (int emode, XLogRecPtr RecPtr)
 
static void XLogFileClose (void)
 
static void PreallocXlogFiles (XLogRecPtr endptr)
 
static void RemoveTempXlogFiles (void)
 
static void RemoveOldXlogFiles (XLogSegNo segno, XLogRecPtr RedoRecPtr, XLogRecPtr endptr)
 
static void RemoveXlogFile (const char *segname, XLogRecPtr RedoRecPtr, XLogRecPtr endptr)
 
static void UpdateLastRemovedPtr (char *filename)
 
static void ValidateXLOGDirectoryStructure (void)
 
static void CleanupBackupHistory (void)
 
static void UpdateMinRecoveryPoint (XLogRecPtr lsn, bool force)
 
static XLogRecordReadRecord (XLogReaderState *xlogreader, XLogRecPtr RecPtr, int emode, bool fetching_ckpt)
 
static void CheckRecoveryConsistency (void)
 
static XLogRecordReadCheckpointRecord (XLogReaderState *xlogreader, XLogRecPtr RecPtr, int whichChkpt, bool report)
 
static bool rescanLatestTimeLine (void)
 
static void WriteControlFile (void)
 
static void ReadControlFile (void)
 
static char * str_time (pg_time_t tnow)
 
static bool CheckForStandbyTrigger (void)
 
static void xlog_outdesc (StringInfo buf, XLogReaderState *record)
 
static void pg_start_backup_callback (int code, Datum arg)
 
static void pg_stop_backup_callback (int code, Datum arg)
 
static bool read_backup_label (XLogRecPtr *checkPointLoc, bool *backupEndRequired, bool *backupFromStandby)
 
static bool read_tablespace_map (List **tablespaces)
 
static void rm_redo_error_callback (void *arg)
 
static int get_sync_bit (int method)
 
static void CopyXLogRecordToWAL (int write_len, bool isLogSwitch, XLogRecData *rdata, XLogRecPtr StartPos, XLogRecPtr EndPos)
 
static void ReserveXLogInsertLocation (int size, XLogRecPtr *StartPos, XLogRecPtr *EndPos, XLogRecPtr *PrevPtr)
 
static bool ReserveXLogSwitch (XLogRecPtr *StartPos, XLogRecPtr *EndPos, XLogRecPtr *PrevPtr)
 
static XLogRecPtr WaitXLogInsertionsToFinish (XLogRecPtr upto)
 
static char * GetXLogBuffer (XLogRecPtr ptr)
 
static XLogRecPtr XLogBytePosToRecPtr (uint64 bytepos)
 
static XLogRecPtr XLogBytePosToEndRecPtr (uint64 bytepos)
 
static uint64 XLogRecPtrToBytePos (XLogRecPtr ptr)
 
static void checkXLogConsistency (XLogReaderState *record)
 
static void WALInsertLockAcquire (void)
 
static void WALInsertLockAcquireExclusive (void)
 
static void WALInsertLockRelease (void)
 
static void WALInsertLockUpdateInsertingAt (XLogRecPtr insertingAt)
 
XLogRecPtr XLogInsertRecord (XLogRecData *rdata, XLogRecPtr fpw_lsn, uint8 flags)
 
static void CalculateCheckpointSegments (void)
 
void assign_max_wal_size (int newval, void *extra)
 
void assign_checkpoint_completion_target (double newval, void *extra)
 
static XLogSegNo XLOGfileslop (XLogRecPtr RedoRecPtr)
 
void XLogSetAsyncXactLSN (XLogRecPtr asyncXactLSN)
 
void XLogSetReplicationSlotMinimumLSN (XLogRecPtr lsn)
 
void XLogFlush (XLogRecPtr record)
 
bool XLogBackgroundFlush (void)
 
bool XLogNeedsFlush (XLogRecPtr record)
 
int XLogFileInit (XLogSegNo logsegno, bool *use_existent, bool use_lock)
 
static void XLogFileCopy (XLogSegNo destsegno, TimeLineID srcTLI, XLogSegNo srcsegno, int upto)
 
int XLogFileOpen (XLogSegNo segno)
 
void CheckXLogRemoved (XLogSegNo segno, TimeLineID tli)
 
XLogSegNo XLogGetLastRemovedSegno (void)
 
static void RemoveNonParentXlogFiles (XLogRecPtr switchpoint, TimeLineID newTLI)
 
void UpdateControlFile (void)
 
uint64 GetSystemIdentifier (void)
 
char * GetMockAuthenticationNonce (void)
 
bool DataChecksumsEnabled (void)
 
XLogRecPtr GetFakeLSNForUnloggedRel (void)
 
static int XLOGChooseNumBuffers (void)
 
bool check_wal_buffers (int *newval, void **extra, GucSource source)
 
void LocalProcessControlFile (bool reset)
 
Size XLOGShmemSize (void)
 
void XLOGShmemInit (void)
 
void BootStrapXLOG (void)
 
static bool getRecordTimestamp (XLogReaderState *record, TimestampTz *recordXtime)
 
bool RecoveryIsPaused (void)
 
void SetRecoveryPause (bool recoveryPause)
 
TimestampTz GetLatestXTime (void)
 
TimestampTz GetCurrentChunkReplayStartTime (void)
 
void GetXLogReceiptTime (TimestampTz *rtime, bool *fromStream)
 
void StartupXLOG (void)
 
bool RecoveryInProgress (void)
 
bool HotStandbyActive (void)
 
bool HotStandbyActiveInReplay (void)
 
bool XLogInsertAllowed (void)
 
void InitXLOGAccess (void)
 
XLogRecPtr GetRedoRecPtr (void)
 
void GetFullPageWriteInfo (XLogRecPtr *RedoRecPtr_p, bool *doPageWrites_p)
 
XLogRecPtr GetInsertRecPtr (void)
 
XLogRecPtr GetFlushRecPtr (void)
 
XLogRecPtr GetLastImportantRecPtr (void)
 
pg_time_t GetLastSegSwitchData (XLogRecPtr *lastSwitchLSN)
 
void ShutdownXLOG (int code, Datum arg)
 
static void LogCheckpointStart (int flags, bool restartpoint)
 
static void LogCheckpointEnd (bool restartpoint)
 
static void UpdateCheckPointDistanceEstimate (uint64 nbytes)
 
void CreateCheckPoint (int flags)
 
static void RecoveryRestartPoint (const CheckPoint *checkPoint)
 
bool CreateRestartPoint (int flags)
 
void XLogPutNextOid (Oid nextOid)
 
XLogRecPtr RequestXLogSwitch (bool mark_unimportant)
 
XLogRecPtr XLogRestorePoint (const char *rpName)
 
void UpdateFullPageWrites (void)
 
void xlog_redo (XLogReaderState *record)
 
void assign_xlog_sync_method (int new_sync_method, void *extra)
 
void issue_xlog_fsync (int fd, XLogSegNo segno)
 
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 *const xlogSourceNames [] = {"any", "archive", "pg_wal", "stream"}
 
static int openLogFile = -1
 
static XLogSegNo openLogSegNo = 0
 
static int readFile = -1
 
static XLogSegNo readSegNo = 0
 
static uint32 readOff = 0
 
static uint32 readLen = 0
 
static XLogSource readSource = 0
 
static XLogSource currentSource = 0
 
static bool lastSourceFailed = false
 
static TimestampTz XLogReceiptTime = 0
 
static XLogSource XLogReceiptSource = 0
 
static XLogRecPtr ReadRecPtr
 
static XLogRecPtr EndRecPtr
 
static XLogRecPtr minRecoveryPoint
 
static TimeLineID minRecoveryPointTLI
 
static bool updateMinRecoveryPoint = true
 
bool reachedConsistency = false
 
static bool InRedo = false
 
static bool bgwriterLaunched = false
 
static int MyLockNo = 0
 
static bool holdingAllLocks = false
 

Macro Definition Documentation

◆ ConvertToXSegs

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

Definition at line 747 of file xlog.c.

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

◆ INSERT_FREESPACE

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

Definition at line 727 of file xlog.c.

Referenced by CopyXLogRecordToWAL(), and CreateCheckPoint().

◆ NextBufIdx

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

Definition at line 731 of file xlog.c.

Referenced by XLogWrite().

◆ NUM_XLOGINSERT_LOCKS

◆ RECOVERY_COMMAND_DONE

#define RECOVERY_COMMAND_DONE   "recovery.done"

Definition at line 83 of file xlog.c.

Referenced by readRecoverySignalFile().

◆ RECOVERY_COMMAND_FILE

#define RECOVERY_COMMAND_FILE   "recovery.conf"

Definition at line 82 of file xlog.c.

Referenced by readRecoverySignalFile().

◆ RecoveryRequiresIntParameter

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

Definition at line 6132 of file xlog.c.

Referenced by CheckRequiredParameterValues().

◆ UsableBytesInPage

#define UsableBytesInPage   (XLOG_BLCKSZ - SizeOfXLogShortPHD)

◆ XLogRecPtrToBufIdx

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

Definition at line 738 of file xlog.c.

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

Typedef Documentation

◆ ExclusiveBackupState

◆ WALInsertLockPadded

◆ XLogCtlData

typedef struct XLogCtlData XLogCtlData

◆ XLogCtlInsert

typedef struct XLogCtlInsert XLogCtlInsert

◆ XLogPageReadPrivate

◆ XLogwrtResult

typedef struct XLogwrtResult XLogwrtResult

◆ XLogwrtRqst

typedef struct XLogwrtRqst XLogwrtRqst

Enumeration Type Documentation

◆ ExclusiveBackupState

Enumerator
EXCLUSIVE_BACKUP_NONE 
EXCLUSIVE_BACKUP_STARTING 
EXCLUSIVE_BACKUP_IN_PROGRESS 
EXCLUSIVE_BACKUP_STOPPING 

Definition at line 513 of file xlog.c.

◆ XLogSource

enum XLogSource
Enumerator
XLOG_FROM_ANY 
XLOG_FROM_ARCHIVE 
XLOG_FROM_PG_WAL 
XLOG_FROM_STREAM 

Definition at line 763 of file xlog.c.

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

Function Documentation

◆ AdvanceXLInsertBuffer()

static void AdvanceXLInsertBuffer ( XLogRecPtr  upto,
bool  opportunistic 
)
static

Definition at line 2086 of file xlog.c.

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

Referenced by GetXLogBuffer(), and XLogBackgroundFlush().

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

◆ assign_checkpoint_completion_target()

void assign_checkpoint_completion_target ( double  newval,
void *  extra 
)

Definition at line 2291 of file xlog.c.

References CalculateCheckpointSegments(), CheckPointCompletionTarget, and newval.

2292 {
2295 }
static void CalculateCheckpointSegments(void)
Definition: xlog.c:2255
#define newval
double CheckPointCompletionTarget
Definition: checkpointer.c: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 10071 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().

10072 {
10073  if (sync_method != new_sync_method)
10074  {
10075  /*
10076  * To ensure that no blocks escape unsynced, force an fsync on the
10077  * currently open log segment (if any). Also, if the open flag is
10078  * changing, close the log file so it will be reopened (with new flag
10079  * bit) at next use.
10080  */
10081  if (openLogFile >= 0)
10082  {
10084  if (pg_fsync(openLogFile) != 0)
10085  ereport(PANIC,
10087  errmsg("could not fsync file \"%s\": %m",
10090  if (get_sync_bit(sync_method) != get_sync_bit(new_sync_method))
10091  XLogFileClose();
10092  }
10093  }
10094 }
static int get_sync_bit(int method)
Definition: xlog.c:10015
#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:10149
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:331

◆ BackupInProgress()

bool BackupInProgress ( void  )

Definition at line 11445 of file xlog.c.

References BACKUP_LABEL_FILE, and stat.

Referenced by pg_is_in_backup(), and PostmasterStateMachine().

11446 {
11447  struct stat stat_buf;
11448 
11449  return (stat(BACKUP_LABEL_FILE, &stat_buf) == 0);
11450 }
struct stat stat_buf
Definition: pg_standby.c:101
#define stat(a, b)
Definition: win32_port.h:255
#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:1056
#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:949
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:331
#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 11465 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().

11466 {
11467  struct stat stat_buf;
11468 
11469  /* if the backup_label file is not there, return */
11470  if (stat(BACKUP_LABEL_FILE, &stat_buf) < 0)
11471  return;
11472 
11473  /* remove leftover file from previously canceled backup if it exists */
11474  unlink(BACKUP_LABEL_OLD);
11475 
11477  {
11478  ereport(WARNING,
11480  errmsg("online backup mode was not canceled"),
11481  errdetail("File \"%s\" could not be renamed to \"%s\": %m.",
11483  return;
11484  }
11485 
11486  /* if the tablespace_map file is not there, return */
11487  if (stat(TABLESPACE_MAP, &stat_buf) < 0)
11488  {
11489  ereport(LOG,
11490  (errmsg("online backup mode canceled"),
11491  errdetail("File \"%s\" was renamed to \"%s\".",
11493  return;
11494  }
11495 
11496  /* remove leftover file from previously canceled backup if it exists */
11497  unlink(TABLESPACE_MAP_OLD);
11498 
11500  {
11501  ereport(LOG,
11502  (errmsg("online backup mode canceled"),
11503  errdetail("Files \"%s\" and \"%s\" were renamed to "
11504  "\"%s\" and \"%s\", respectively.",
11507  }
11508  else
11509  {
11510  ereport(WARNING,
11512  errmsg("online backup mode canceled"),
11513  errdetail("File \"%s\" was renamed to \"%s\", but "
11514  "file \"%s\" could not be renamed to \"%s\": %m.",
11517  }
11518 }
#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:606
#define WARNING
Definition: elog.h:40
#define stat(a, b)
Definition: win32_port.h:255
#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 12168 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().

12169 {
12170  struct stat stat_buf;
12171  static bool triggered = false;
12172 
12173  if (triggered)
12174  return true;
12175 
12176  if (IsPromoteTriggered())
12177  {
12178  /*
12179  * In 9.1 and 9.2 the postmaster unlinked the promote file inside the
12180  * signal handler. It now leaves the file in place and lets the
12181  * Startup process do the unlink. This allows Startup to know whether
12182  * it should create a full checkpoint before starting up (fallback
12183  * mode). Fast promotion takes precedence.
12184  */
12185  if (stat(PROMOTE_SIGNAL_FILE, &stat_buf) == 0)
12186  {
12187  unlink(PROMOTE_SIGNAL_FILE);
12189  fast_promote = true;
12190  }
12191  else if (stat(FALLBACK_PROMOTE_SIGNAL_FILE, &stat_buf) == 0)
12192  {
12194  fast_promote = false;
12195  }
12196 
12197  ereport(LOG, (errmsg("received promote request")));
12198 
12200  triggered = true;
12201  return true;
12202  }
12203 
12204  if (PromoteTriggerFile == NULL || strcmp(PromoteTriggerFile, "") == 0)
12205  return false;
12206 
12207  if (stat(PromoteTriggerFile, &stat_buf) == 0)
12208  {
12209  ereport(LOG,
12210  (errmsg("promote trigger file found: %s", PromoteTriggerFile)));
12211  unlink(PromoteTriggerFile);
12212  triggered = true;
12213  fast_promote = true;
12214  return true;
12215  }
12216  else if (errno != ENOENT)
12217  ereport(ERROR,
12219  errmsg("could not stat promote trigger file \"%s\": %m",
12220  PromoteTriggerFile)));
12221 
12222  return false;
12223 }
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:255
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 8999 of file xlog.c.

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

Referenced by CreateCheckPoint(), and CreateRestartPoint().

9000 {
9001  CheckPointCLOG();
9010  CheckPointBuffers(flags); /* performs all required fsyncs */
9012  /* We deliberately delay 2PC checkpointing as long as possible */
9013  CheckPointTwoPhase(checkPointRedo);
9014 }
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:1750
void CheckPointReplicationSlots(void)
Definition: slot.c:1074

◆ CheckPromoteSignal()

bool CheckPromoteSignal ( void  )

Definition at line 12240 of file xlog.c.

References FALLBACK_PROMOTE_SIGNAL_FILE, PROMOTE_SIGNAL_FILE, and stat.

Referenced by sigusr1_handler().

12241 {
12242  struct stat stat_buf;
12243 
12244  if (stat(PROMOTE_SIGNAL_FILE, &stat_buf) == 0 ||
12246  return true;
12247 
12248  return false;
12249 }
#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:255

◆ CheckRecoveryConsistency()

static void CheckRecoveryConsistency ( void  )
static

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

7817 {
7818  XLogRecPtr lastReplayedEndRecPtr;
7819 
7820  /*
7821  * During crash recovery, we don't reach a consistent state until we've
7822  * replayed all the WAL.
7823  */
7825  return;
7826 
7828 
7829  /*
7830  * assume that we are called in the startup process, and hence don't need
7831  * a lock to read lastReplayedEndRecPtr
7832  */
7833  lastReplayedEndRecPtr = XLogCtl->lastReplayedEndRecPtr;
7834 
7835  /*
7836  * Have we reached the point where our base backup was completed?
7837  */
7839  ControlFile->backupEndPoint <= lastReplayedEndRecPtr)
7840  {
7841  /*
7842  * We have reached the end of base backup, as indicated by pg_control.
7843  * The data on disk is now consistent. Reset backupStartPoint and
7844  * backupEndPoint, and update minRecoveryPoint to make sure we don't
7845  * allow starting up at an earlier point even if recovery is stopped
7846  * and restarted soon after this.
7847  */
7848  elog(DEBUG1, "end of backup reached");
7849 
7850  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
7851 
7852  if (ControlFile->minRecoveryPoint < lastReplayedEndRecPtr)
7853  ControlFile->minRecoveryPoint = lastReplayedEndRecPtr;
7854 
7857  ControlFile->backupEndRequired = false;
7859 
7860  LWLockRelease(ControlFileLock);
7861  }
7862 
7863  /*
7864  * Have we passed our safe starting point? Note that minRecoveryPoint is
7865  * known to be incorrectly set if ControlFile->backupEndRequired, until
7866  * the XLOG_BACKUP_END arrives to advise us of the correct
7867  * minRecoveryPoint. All we know prior to that is that we're not
7868  * consistent yet.
7869  */
7871  minRecoveryPoint <= lastReplayedEndRecPtr &&
7873  {
7874  /*
7875  * Check to see if the XLOG sequence contained any unresolved
7876  * references to uninitialized pages.
7877  */
7879 
7880  reachedConsistency = true;
7881  ereport(LOG,
7882  (errmsg("consistent recovery state reached at %X/%X",
7883  (uint32) (lastReplayedEndRecPtr >> 32),
7884  (uint32) lastReplayedEndRecPtr)));
7885  }
7886 
7887  /*
7888  * Have we got a valid starting snapshot that will allow queries to be
7889  * run? If so, we can tell postmaster that the database is consistent now,
7890  * enabling connections.
7891  */
7896  {
7900 
7901  LocalHotStandbyActive = true;
7902 
7904  }
7905 }
#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 6154 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().

6155 {
6156  /*
6157  * For archive recovery, the WAL must be generated with at least 'replica'
6158  * wal_level.
6159  */
6161  {
6162  ereport(WARNING,
6163  (errmsg("WAL was generated with wal_level=minimal, data may be missing"),
6164  errhint("This happens if you temporarily set wal_level=minimal without taking a new base backup.")));
6165  }
6166 
6167  /*
6168  * For Hot Standby, the WAL must be generated with 'replica' mode, and we
6169  * must have at least as many backend slots as the primary.
6170  */
6172  {
6174  ereport(ERROR,
6175  (errmsg("hot standby is not possible because wal_level was not set to \"replica\" or higher on the master server"),
6176  errhint("Either set wal_level to \"replica\" on the master, or turn off hot_standby here.")));
6177 
6178  /* We ignore autovacuum_max_workers when we make this test. */
6179  RecoveryRequiresIntParameter("max_connections",
6182  RecoveryRequiresIntParameter("max_worker_processes",
6185  RecoveryRequiresIntParameter("max_wal_senders",
6188  RecoveryRequiresIntParameter("max_prepared_transactions",
6191  RecoveryRequiresIntParameter("max_locks_per_transaction",
6194  }
6195 }
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:6132

◆ checkTimeLineSwitch()

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

Definition at line 9564 of file xlog.c.

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

Referenced by StartupXLOG().

9565 {
9566  /* Check that the record agrees on what the current (old) timeline is */
9567  if (prevTLI != ThisTimeLineID)
9568  ereport(PANIC,
9569  (errmsg("unexpected previous timeline ID %u (current timeline ID %u) in checkpoint record",
9570  prevTLI, ThisTimeLineID)));
9571 
9572  /*
9573  * The new timeline better be in the list of timelines we expect to see,
9574  * according to the timeline history. It should also not decrease.
9575  */
9576  if (newTLI < ThisTimeLineID || !tliInHistory(newTLI, expectedTLEs))
9577  ereport(PANIC,
9578  (errmsg("unexpected timeline ID %u (after %u) in checkpoint record",
9579  newTLI, ThisTimeLineID)));
9580 
9581  /*
9582  * If we have not yet reached min recovery point, and we're about to
9583  * switch to a timeline greater than the timeline of the min recovery
9584  * point: trouble. After switching to the new timeline, we could not
9585  * possibly visit the min recovery point on the correct timeline anymore.
9586  * This can happen if there is a newer timeline in the archive that
9587  * branched before the timeline the min recovery point is on, and you
9588  * attempt to do PITR to the new timeline.
9589  */
9591  lsn < minRecoveryPoint &&
9592  newTLI > minRecoveryPointTLI)
9593  ereport(PANIC,
9594  (errmsg("unexpected timeline ID %u in checkpoint record, before reaching minimum recovery point %X/%X on timeline %u",
9595  newTLI,
9596  (uint32) (minRecoveryPoint >> 32),
9599 
9600  /* Looks good */
9601 }
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:251
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:133
static char * replay_image_masked
Definition: xlog.c:264
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3388
#define ERROR
Definition: elog.h:43
#define FATAL
Definition: elog.h:52
static char * buf
Definition: pg_test_fsync.c:68
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define XLogRecGetInfo(decoder)
Definition: xlogreader.h:242
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:1367
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3602
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:1420
#define PageGetLSN(page)
Definition: bufpage.h:366
#define elog(elevel,...)
Definition: elog.h:226
#define XLogRecHasAnyBlockRefs(decoder)
Definition: xlogreader.h:248
#define XLogRecBlockImageApply(decoder, block_id)
Definition: xlogreader.h:253
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78
#define XLogRecGetRmid(decoder)
Definition: xlogreader.h:243
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:756
Definition: dirent.c:25
bool XLogArchiveCheckDone(const char *xlog)
Definition: xlogarchive.c:616
#define MAXPGPATH
#define DEBUG2
Definition: elog.h:24
DIR * AllocateDir(const char *dirname)
Definition: fd.c:2466
#define IsBackupHistoryFileName(fname)
#define XLOGDIR
struct dirent * ReadDir(DIR *dir, const char *dirname)
Definition: fd.c:2532
#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:2584

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

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

8951 {
8952  xl_end_of_recovery xlrec;
8953  XLogRecPtr recptr;
8954 
8955  /* sanity check */
8956  if (!RecoveryInProgress())
8957  elog(ERROR, "can only be used to end recovery");
8958 
8959  xlrec.end_time = GetCurrentTimestamp();
8960 
8965 
8967 
8969 
8970  XLogBeginInsert();
8971  XLogRegisterData((char *) &xlrec, sizeof(xl_end_of_recovery));
8972  recptr = XLogInsert(RM_XLOG_ID, XLOG_END_OF_RECOVERY);
8973 
8974  XLogFlush(recptr);
8975 
8976  /*
8977  * Update the control file so that crash recovery can follow the timeline
8978  * changes to this point.
8979  */
8980  LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
8981  ControlFile->time = (pg_time_t) time(NULL);
8982  ControlFile->minRecoveryPoint = recptr;
8985  LWLockRelease(ControlFileLock);
8986 
8987  END_CRIT_SECTION();
8988 
8989  LocalXLogInsertAllowed = -1; /* return to "check" state */
8990 }
static int LocalXLogInsertAllowed
Definition: xlog.c:241
int64 pg_time_t
Definition: pgtime.h:23
static void WALInsertLockRelease(void)
Definition: xlog.c:1690
pg_time_t time
Definition: pg_control.h:128
TimeLineID minRecoveryPointTLI
Definition: pg_control.h:167
TimeLineID PrevTimeLineID
TimestampTz GetCurrentTimestamp(void)
Definition: timestamp.c:1583
#define END_CRIT_SECTION()
Definition: miscadmin.h:134
TimeLineID PrevTimeLineID
Definition: xlog.c:643
#define START_CRIT_SECTION()
Definition: miscadmin.h:132
bool RecoveryInProgress(void)
Definition: xlog.c:7917
#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:8043
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 9069 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().

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

◆ DataChecksumsEnabled()

bool DataChecksumsEnabled ( void  )

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

11122 {
11123  /*
11124  * Quick exit if session is not keeping around a non-exclusive backup
11125  * already started.
11126  */
11128  return;
11129 
11134 
11137  {
11138  XLogCtl->Insert.forcePageWrites = false;
11139  }
11141 }
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 10197 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().

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

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

References DEBUG1, LOG, readSource, and XLOG_FROM_PG_WAL.

Referenced by ReadRecord(), and XLogPageRead().

12150 {
12151  static XLogRecPtr lastComplaint = 0;
12152 
12153  if (readSource == XLOG_FROM_PG_WAL && emode == LOG)
12154  {
12155  if (RecPtr == lastComplaint)
12156  emode = DEBUG1;
12157  else
12158  lastComplaint = RecPtr;
12159  }
12160  return emode;
12161 }
#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, readFile, RECOVERY_SIGNAL_FILE, recovery_signal_file_found, STANDBY_SIGNAL_FILE, standby_signal_file_found, ThisTimeLineID, UpdateMinRecoveryPoint(), wal_segment_size, XLByteToPrevSeg, XLByteToSeg, XLogArchiveCleanup(), XLogFileCopy(), XLogFileInit(), XLogFileName, XLogFileNameP(), and XLogSegmentOffset.

Referenced by StartupXLOG().

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