PostgreSQL Source Code  git master
xlog.h File Reference
#include "access/rmgr.h"
#include "access/xlogdefs.h"
#include "access/xloginsert.h"
#include "access/xlogreader.h"
#include "datatype/timestamp.h"
#include "lib/stringinfo.h"
#include "nodes/pg_list.h"
#include "storage/fd.h"
Include dependency graph for xlog.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  CheckpointStatsData
 

Macros

#define SYNC_METHOD_FSYNC   0
 
#define SYNC_METHOD_FDATASYNC   1
 
#define SYNC_METHOD_OPEN   2 /* for O_SYNC */
 
#define SYNC_METHOD_FSYNC_WRITETHROUGH   3
 
#define SYNC_METHOD_OPEN_DSYNC   4 /* for O_DSYNC */
 
#define InHotStandby   (standbyState >= STANDBY_SNAPSHOT_PENDING)
 
#define XLogArchivingActive()   (AssertMacro(XLogArchiveMode == ARCHIVE_MODE_OFF || wal_level >= WAL_LEVEL_REPLICA), XLogArchiveMode > ARCHIVE_MODE_OFF)
 
#define XLogArchivingAlways()   (AssertMacro(XLogArchiveMode == ARCHIVE_MODE_OFF || wal_level >= WAL_LEVEL_REPLICA), XLogArchiveMode == ARCHIVE_MODE_ALWAYS)
 
#define XLogArchiveCommandSet()   (XLogArchiveCommand[0] != '\0')
 
#define XLogIsNeeded()   (wal_level >= WAL_LEVEL_REPLICA)
 
#define XLogHintBitIsNeeded()   (DataChecksumsEnabled() || wal_log_hints)
 
#define XLogStandbyInfoActive()   (wal_level >= WAL_LEVEL_REPLICA)
 
#define XLogLogicalInfoActive()   (wal_level >= WAL_LEVEL_LOGICAL)
 
#define CHECKPOINT_IS_SHUTDOWN   0x0001 /* Checkpoint is for shutdown */
 
#define CHECKPOINT_END_OF_RECOVERY
 
#define CHECKPOINT_IMMEDIATE   0x0004 /* Do it without delays */
 
#define CHECKPOINT_FORCE   0x0008 /* Force even if no activity */
 
#define CHECKPOINT_FLUSH_ALL
 
#define CHECKPOINT_WAIT   0x0020 /* Wait for completion */
 
#define CHECKPOINT_REQUESTED   0x0040 /* Checkpoint request has been made */
 
#define CHECKPOINT_CAUSE_XLOG   0x0080 /* XLOG consumption */
 
#define CHECKPOINT_CAUSE_TIME   0x0100 /* Elapsed time */
 
#define XLOG_INCLUDE_ORIGIN   0x01 /* include the replication origin */
 
#define XLOG_MARK_UNIMPORTANT   0x02 /* record not important for durability */
 
#define RECOVERY_SIGNAL_FILE   "recovery.signal"
 
#define STANDBY_SIGNAL_FILE   "standby.signal"
 
#define BACKUP_LABEL_FILE   "backup_label"
 
#define BACKUP_LABEL_OLD   "backup_label.old"
 
#define TABLESPACE_MAP   "tablespace_map"
 
#define TABLESPACE_MAP_OLD   "tablespace_map.old"
 
#define PROMOTE_SIGNAL_FILE   "promote"
 
#define FALLBACK_PROMOTE_SIGNAL_FILE   "fallback_promote"
 

Typedefs

typedef enum ArchiveMode ArchiveMode
 
typedef enum WalLevel WalLevel
 
typedef struct CheckpointStatsData CheckpointStatsData
 
typedef enum SessionBackupState SessionBackupState
 

Enumerations

enum  HotStandbyState { STANDBY_DISABLED, STANDBY_INITIALIZED, STANDBY_SNAPSHOT_PENDING, STANDBY_SNAPSHOT_READY }
 
enum  RecoveryTargetType {
  RECOVERY_TARGET_UNSET, RECOVERY_TARGET_XID, RECOVERY_TARGET_TIME, RECOVERY_TARGET_NAME,
  RECOVERY_TARGET_LSN, RECOVERY_TARGET_IMMEDIATE
}
 
enum  RecoveryTargetTimeLineGoal { RECOVERY_TARGET_TIMELINE_CONTROLFILE, RECOVERY_TARGET_TIMELINE_LATEST, RECOVERY_TARGET_TIMELINE_NUMERIC }
 
enum  ArchiveMode { ARCHIVE_MODE_OFF = 0, ARCHIVE_MODE_ON, ARCHIVE_MODE_ALWAYS }
 
enum  WalLevel { WAL_LEVEL_MINIMAL = 0, WAL_LEVEL_REPLICA, WAL_LEVEL_LOGICAL }
 
enum  SessionBackupState { SESSION_BACKUP_NONE, SESSION_BACKUP_EXCLUSIVE, SESSION_BACKUP_NON_EXCLUSIVE }
 

Functions

XLogRecPtr XLogInsertRecord (struct XLogRecData *rdata, XLogRecPtr fpw_lsn, uint8 flags)
 
void XLogFlush (XLogRecPtr RecPtr)
 
bool XLogBackgroundFlush (void)
 
bool XLogNeedsFlush (XLogRecPtr RecPtr)
 
int XLogFileInit (XLogSegNo segno, bool *use_existent, bool use_lock)
 
int XLogFileOpen (XLogSegNo segno)
 
void CheckXLogRemoved (XLogSegNo segno, TimeLineID tli)
 
XLogSegNo XLogGetLastRemovedSegno (void)
 
void XLogSetAsyncXactLSN (XLogRecPtr record)
 
void XLogSetReplicationSlotMinimumLSN (XLogRecPtr lsn)
 
void xlog_redo (XLogReaderState *record)
 
void xlog_desc (StringInfo buf, XLogReaderState *record)
 
const char * xlog_identify (uint8 info)
 
void issue_xlog_fsync (int fd, XLogSegNo segno)
 
bool RecoveryInProgress (void)
 
bool HotStandbyActive (void)
 
bool HotStandbyActiveInReplay (void)
 
bool XLogInsertAllowed (void)
 
void GetXLogReceiptTime (TimestampTz *rtime, bool *fromStream)
 
XLogRecPtr GetXLogReplayRecPtr (TimeLineID *replayTLI)
 
XLogRecPtr GetXLogInsertRecPtr (void)
 
XLogRecPtr GetXLogWriteRecPtr (void)
 
bool RecoveryIsPaused (void)
 
void SetRecoveryPause (bool recoveryPause)
 
TimestampTz GetLatestXTime (void)
 
TimestampTz GetCurrentChunkReplayStartTime (void)
 
void UpdateControlFile (void)
 
uint64 GetSystemIdentifier (void)
 
char * GetMockAuthenticationNonce (void)
 
bool DataChecksumsEnabled (void)
 
XLogRecPtr GetFakeLSNForUnloggedRel (void)
 
Size XLOGShmemSize (void)
 
void XLOGShmemInit (void)
 
void BootStrapXLOG (void)
 
void LocalProcessControlFile (bool reset)
 
void StartupXLOG (void)
 
void ShutdownXLOG (int code, Datum arg)
 
void InitXLOGAccess (void)
 
void CreateCheckPoint (int flags)
 
bool CreateRestartPoint (int flags)
 
void XLogPutNextOid (Oid nextOid)
 
XLogRecPtr XLogRestorePoint (const char *rpName)
 
void UpdateFullPageWrites (void)
 
void GetFullPageWriteInfo (XLogRecPtr *RedoRecPtr_p, bool *doPageWrites_p)
 
XLogRecPtr GetRedoRecPtr (void)
 
XLogRecPtr GetInsertRecPtr (void)
 
XLogRecPtr GetFlushRecPtr (void)
 
XLogRecPtr GetLastImportantRecPtr (void)
 
void RemovePromoteSignalFiles (void)
 
bool CheckPromoteSignal (void)
 
void WakeupRecovery (void)
 
void SetWalWriterSleeping (bool sleeping)
 
void XLogRequestWalReceiverReply (void)
 
void assign_max_wal_size (int newval, void *extra)
 
void assign_checkpoint_completion_target (double newval, void *extra)
 
XLogRecPtr do_pg_start_backup (const char *backupidstr, bool fast, TimeLineID *starttli_p, StringInfo labelfile, List **tablespaces, StringInfo tblspcmapfile, bool infotbssize, bool needtblspcmapfile)
 
XLogRecPtr do_pg_stop_backup (char *labelfile, bool waitforarchive, TimeLineID *stoptli_p)
 
void do_pg_abort_backup (int code, Datum arg)
 
void register_persistent_abort_backup_handler (void)
 
SessionBackupState get_backup_status (void)
 

Variables

int sync_method
 
PGDLLIMPORT TimeLineID ThisTimeLineID
 
bool InRecovery
 
HotStandbyState standbyState
 
XLogRecPtr ProcLastRecPtr
 
XLogRecPtr XactLastRecEnd
 
PGDLLIMPORT XLogRecPtr XactLastCommitEnd
 
bool reachedConsistency
 
int wal_segment_size
 
int min_wal_size_mb
 
int max_wal_size_mb
 
int wal_keep_segments
 
int XLOGbuffers
 
int XLogArchiveTimeout
 
int wal_retrieve_retry_interval
 
char * XLogArchiveCommand
 
bool EnableHotStandby
 
bool fullPageWrites
 
bool wal_log_hints
 
bool wal_compression
 
bool wal_init_zero
 
bool wal_recycle
 
boolwal_consistency_checking
 
char * wal_consistency_checking_string
 
bool log_checkpoints
 
char * recoveryRestoreCommand
 
char * recoveryEndCommand
 
char * archiveCleanupCommand
 
bool recoveryTargetInclusive
 
int recoveryTargetAction
 
int recovery_min_apply_delay
 
char * PrimaryConnInfo
 
char * PrimarySlotName
 
TransactionId recoveryTargetXid
 
char * recovery_target_time_string
 
const char * recoveryTargetName
 
XLogRecPtr recoveryTargetLSN
 
RecoveryTargetType recoveryTarget
 
char * PromoteTriggerFile
 
RecoveryTargetTimeLineGoal recoveryTargetTimeLineGoal
 
TimeLineID recoveryTargetTLIRequested
 
TimeLineID recoveryTargetTLI
 
int CheckPointSegments
 
bool StandbyModeRequested
 
bool StandbyMode
 
int XLogArchiveMode
 
PGDLLIMPORT int wal_level
 
CheckpointStatsData CheckpointStats
 

Macro Definition Documentation

◆ BACKUP_LABEL_FILE

#define BACKUP_LABEL_FILE   "backup_label"

◆ BACKUP_LABEL_OLD

#define BACKUP_LABEL_OLD   "backup_label.old"

Definition at line 360 of file xlog.h.

Referenced by CancelBackup(), and StartupXLOG().

◆ CHECKPOINT_CAUSE_TIME

#define CHECKPOINT_CAUSE_TIME   0x0100 /* Elapsed time */

Definition at line 223 of file xlog.h.

Referenced by CheckpointerMain(), and LogCheckpointStart().

◆ CHECKPOINT_CAUSE_XLOG

#define CHECKPOINT_CAUSE_XLOG   0x0080 /* XLOG consumption */

Definition at line 222 of file xlog.h.

Referenced by CheckpointerMain(), LogCheckpointStart(), XLogPageRead(), and XLogWrite().

◆ CHECKPOINT_END_OF_RECOVERY

#define CHECKPOINT_END_OF_RECOVERY
Value:
0x0002 /* Like shutdown checkpoint, but
* issued at end of WAL recovery */

Definition at line 212 of file xlog.h.

Referenced by BufferSync(), CheckpointerMain(), CreateCheckPoint(), LogCheckpointStart(), and StartupXLOG().

◆ CHECKPOINT_FLUSH_ALL

#define CHECKPOINT_FLUSH_ALL
Value:
0x0010 /* Flush all pages, including those
* belonging to unlogged tables */

Definition at line 216 of file xlog.h.

Referenced by BufferSync(), createdb(), LogCheckpointStart(), and movedb().

◆ CHECKPOINT_FORCE

#define CHECKPOINT_FORCE   0x0008 /* Force even if no activity */

◆ CHECKPOINT_IMMEDIATE

◆ CHECKPOINT_IS_SHUTDOWN

#define CHECKPOINT_IS_SHUTDOWN   0x0001 /* Checkpoint is for shutdown */

◆ CHECKPOINT_REQUESTED

#define CHECKPOINT_REQUESTED   0x0040 /* Checkpoint request has been made */

Definition at line 220 of file xlog.h.

Referenced by RequestCheckpoint().

◆ CHECKPOINT_WAIT

#define CHECKPOINT_WAIT   0x0020 /* Wait for completion */

◆ FALLBACK_PROMOTE_SIGNAL_FILE

#define FALLBACK_PROMOTE_SIGNAL_FILE   "fallback_promote"

Definition at line 367 of file xlog.h.

Referenced by CheckForStandbyTrigger(), CheckPromoteSignal(), and RemovePromoteSignalFiles().

◆ InHotStandby

◆ PROMOTE_SIGNAL_FILE

#define PROMOTE_SIGNAL_FILE   "promote"

◆ RECOVERY_SIGNAL_FILE

#define RECOVERY_SIGNAL_FILE   "recovery.signal"

Definition at line 357 of file xlog.h.

Referenced by exitArchiveRecovery(), and readRecoverySignalFile().

◆ STANDBY_SIGNAL_FILE

#define STANDBY_SIGNAL_FILE   "standby.signal"

Definition at line 358 of file xlog.h.

Referenced by exitArchiveRecovery(), and readRecoverySignalFile().

◆ SYNC_METHOD_FDATASYNC

#define SYNC_METHOD_FDATASYNC   1

Definition at line 26 of file xlog.h.

Referenced by get_sync_bit(), and issue_xlog_fsync().

◆ SYNC_METHOD_FSYNC

#define SYNC_METHOD_FSYNC   0

Definition at line 25 of file xlog.h.

Referenced by get_sync_bit(), and issue_xlog_fsync().

◆ SYNC_METHOD_FSYNC_WRITETHROUGH

#define SYNC_METHOD_FSYNC_WRITETHROUGH   3

Definition at line 28 of file xlog.h.

Referenced by get_sync_bit(), issue_xlog_fsync(), and pg_fsync().

◆ SYNC_METHOD_OPEN

#define SYNC_METHOD_OPEN   2 /* for O_SYNC */

Definition at line 27 of file xlog.h.

Referenced by get_sync_bit(), issue_xlog_fsync(), and XLogWrite().

◆ SYNC_METHOD_OPEN_DSYNC

#define SYNC_METHOD_OPEN_DSYNC   4 /* for O_DSYNC */

Definition at line 29 of file xlog.h.

Referenced by get_sync_bit(), issue_xlog_fsync(), and XLogWrite().

◆ TABLESPACE_MAP

#define TABLESPACE_MAP   "tablespace_map"

◆ TABLESPACE_MAP_OLD

#define TABLESPACE_MAP_OLD   "tablespace_map.old"

Definition at line 363 of file xlog.h.

Referenced by CancelBackup(), and StartupXLOG().

◆ XLOG_INCLUDE_ORIGIN

#define XLOG_INCLUDE_ORIGIN   0x01 /* include the replication origin */

◆ XLOG_MARK_UNIMPORTANT

#define XLOG_MARK_UNIMPORTANT   0x02 /* record not important for durability */

◆ XLogArchiveCommandSet

#define XLogArchiveCommandSet ( )    (XLogArchiveCommand[0] != '\0')

Definition at line 175 of file xlog.h.

Referenced by pgarch_ArchiverCopyLoop(), and ShutdownXLOG().

◆ XLogArchivingActive

◆ XLogArchivingAlways

Definition at line 173 of file xlog.h.

Referenced by do_pg_stop_backup(), sigusr1_handler(), and XLogArchiveCheckDone().

◆ XLogHintBitIsNeeded

◆ XLogIsNeeded

◆ XLogLogicalInfoActive

#define XLogLogicalInfoActive ( )    (wal_level >= WAL_LEVEL_LOGICAL)

◆ XLogStandbyInfoActive

Typedef Documentation

◆ ArchiveMode

typedef enum ArchiveMode ArchiveMode

◆ CheckpointStatsData

◆ SessionBackupState

◆ WalLevel

typedef enum WalLevel WalLevel

Enumeration Type Documentation

◆ ArchiveMode

Enumerator
ARCHIVE_MODE_OFF 
ARCHIVE_MODE_ON 
ARCHIVE_MODE_ALWAYS 

Definition at line 151 of file xlog.h.

152 {
153  ARCHIVE_MODE_OFF = 0, /* disabled */
154  ARCHIVE_MODE_ON, /* enabled while server is running normally */
155  ARCHIVE_MODE_ALWAYS /* enabled always (even during recovery) */
156 } ArchiveMode;
ArchiveMode
Definition: xlog.h:151

◆ HotStandbyState

Enumerator
STANDBY_DISABLED 
STANDBY_INITIALIZED 
STANDBY_SNAPSHOT_PENDING 
STANDBY_SNAPSHOT_READY 

Definition at line 64 of file xlog.h.

◆ RecoveryTargetTimeLineGoal

Enumerator
RECOVERY_TARGET_TIMELINE_CONTROLFILE 
RECOVERY_TARGET_TIMELINE_LATEST 
RECOVERY_TARGET_TIMELINE_NUMERIC 

Definition at line 93 of file xlog.h.

◆ RecoveryTargetType

Enumerator
RECOVERY_TARGET_UNSET 
RECOVERY_TARGET_XID 
RECOVERY_TARGET_TIME 
RECOVERY_TARGET_NAME 
RECOVERY_TARGET_LSN 
RECOVERY_TARGET_IMMEDIATE 

Definition at line 80 of file xlog.h.

◆ SessionBackupState

Enumerator
SESSION_BACKUP_NONE 
SESSION_BACKUP_EXCLUSIVE 
SESSION_BACKUP_NON_EXCLUSIVE 

Definition at line 339 of file xlog.h.

◆ WalLevel

enum WalLevel
Enumerator
WAL_LEVEL_MINIMAL 
WAL_LEVEL_REPLICA 
WAL_LEVEL_LOGICAL 

Definition at line 160 of file xlog.h.

Function Documentation

◆ assign_checkpoint_completion_target()

void assign_checkpoint_completion_target ( double  newval,
void *  extra 
)

Definition at line 2290 of file xlog.c.

References CalculateCheckpointSegments(), CheckPointCompletionTarget, and newval.

2291 {
2294 }
static void CalculateCheckpointSegments(void)
Definition: xlog.c:2254
#define newval
double CheckPointCompletionTarget
Definition: checkpointer.c:148

◆ assign_max_wal_size()

void assign_max_wal_size ( int  newval,
void *  extra 
)

Definition at line 2283 of file xlog.c.

References CalculateCheckpointSegments(), max_wal_size_mb, and newval.

2284 {
2287 }
static void CalculateCheckpointSegments(void)
Definition: xlog.c:2254
int max_wal_size_mb
Definition: xlog.c:86
#define newval

◆ BootStrapXLOG()

void BootStrapXLOG ( void  )

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

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

◆ CheckPromoteSignal()

bool CheckPromoteSignal ( void  )

Definition at line 12284 of file xlog.c.

References FALLBACK_PROMOTE_SIGNAL_FILE, PROMOTE_SIGNAL_FILE, and stat.

Referenced by sigusr1_handler().

12285 {
12286  struct stat stat_buf;
12287 
12288  if (stat(PROMOTE_SIGNAL_FILE, &stat_buf) == 0 ||
12290  return true;
12291 
12292  return false;
12293 }
#define PROMOTE_SIGNAL_FILE
Definition: xlog.h:366
struct stat stat_buf
Definition: pg_standby.c:100
#define FALLBACK_PROMOTE_SIGNAL_FILE
Definition: xlog.h:367
#define stat(a, b)
Definition: win32_port.h:255

◆ CheckXLogRemoved()

void CheckXLogRemoved ( XLogSegNo  segno,
TimeLineID  tli 
)

Definition at line 3859 of file xlog.c.

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

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

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

◆ CreateCheckPoint()

void CreateCheckPoint ( int  flags)

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

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

◆ CreateRestartPoint()

bool CreateRestartPoint ( int  flags)

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

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

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

◆ do_pg_abort_backup()

void do_pg_abort_backup ( int  code,
Datum  arg 
)

Definition at line 11145 of file xlog.c.

References Assert, DatumGetBool, ereport, errmsg(), EXCLUSIVE_BACKUP_NONE, XLogCtlInsert::exclusiveBackupState, XLogCtlInsert::forcePageWrites, XLogCtlData::Insert, XLogCtlInsert::nonExclusiveBackups, SESSION_BACKUP_NON_EXCLUSIVE, sessionBackupState, WALInsertLockAcquireExclusive(), WALInsertLockRelease(), and WARNING.

Referenced by perform_base_backup(), and register_persistent_abort_backup_handler().

11146 {
11147  bool emit_warning = DatumGetBool(arg);
11148 
11149  /*
11150  * Quick exit if session is not keeping around a non-exclusive backup
11151  * already started.
11152  */
11154  return;
11155 
11159 
11162  {
11163  XLogCtl->Insert.forcePageWrites = false;
11164  }
11166 
11167  if (emit_warning)
11168  ereport(WARNING,
11169  (errmsg("aborting backup due to backend exiting before pg_stop_back up was called")));
11170 }
static void WALInsertLockRelease(void)
Definition: xlog.c:1689
static SessionBackupState sessionBackupState
Definition: xlog.c:524
XLogCtlInsert Insert
Definition: xlog.c:589
bool forcePageWrites
Definition: xlog.c:563
#define DatumGetBool(X)
Definition: postgres.h:393
#define ereport(elevel, rest)
Definition: elog.h:141
#define WARNING
Definition: elog.h:40
int nonExclusiveBackups
Definition: xlog.c:575
ExclusiveBackupState exclusiveBackupState
Definition: xlog.c:574
#define Assert(condition)
Definition: c.h:739
static void WALInsertLockAcquireExclusive(void)
Definition: xlog.c:1660
static XLogCtlData * XLogCtl
Definition: xlog.c:712
int errmsg(const char *fmt,...)
Definition: elog.c:822
void * arg

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

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

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

◆ get_backup_status()

SessionBackupState get_backup_status ( void  )

Definition at line 10713 of file xlog.c.

References sessionBackupState.

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

10714 {
10715  return sessionBackupState;
10716 }
static SessionBackupState sessionBackupState
Definition: xlog.c:524

◆ GetCurrentChunkReplayStartTime()

TimestampTz GetCurrentChunkReplayStartTime ( void  )

Definition at line 6101 of file xlog.c.

References XLogCtlData::currentChunkStartTime, XLogCtlData::info_lck, SpinLockAcquire, and SpinLockRelease.

Referenced by GetReplicationApplyDelay().

6102 {
6103  TimestampTz xtime;
6104 
6106  xtime = XLogCtl->currentChunkStartTime;
6108 
6109  return xtime;
6110 }
int64 TimestampTz
Definition: timestamp.h:39
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:712
TimestampTz currentChunkStartTime
Definition: xlog.c:699

◆ GetFakeLSNForUnloggedRel()

XLogRecPtr GetFakeLSNForUnloggedRel ( void  )

Definition at line 4834 of file xlog.c.

References SpinLockAcquire, SpinLockRelease, XLogCtlData::ulsn_lck, and XLogCtlData::unloggedLSN.

Referenced by gistGetFakeLSN().

4835 {
4836  XLogRecPtr nextUnloggedLSN;
4837 
4838  /* increment the unloggedLSN counter, need SpinLock */
4840  nextUnloggedLSN = XLogCtl->unloggedLSN++;
4842 
4843  return nextUnloggedLSN;
4844 }
XLogRecPtr unloggedLSN
Definition: xlog.c:601
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
uint64 XLogRecPtr
Definition: xlogdefs.h:21
static XLogCtlData * XLogCtl
Definition: xlog.c:712
slock_t ulsn_lck
Definition: xlog.c:602

◆ GetFlushRecPtr()

XLogRecPtr GetFlushRecPtr ( void  )

Definition at line 8262 of file xlog.c.

References XLogwrtResult::Flush, XLogCtlData::info_lck, XLogCtlData::LogwrtResult, SpinLockAcquire, and SpinLockRelease.

Referenced by get_flush_position(), IdentifySystem(), pg_current_wal_flush_lsn(), pg_logical_slot_get_changes_guts(), pg_replication_slot_advance(), read_local_xlog_page(), StartReplication(), WalSndWaitForWal(), XLogSendLogical(), and XLogSendPhysical().

8263 {
8267 
8268  return LogwrtResult.Flush;
8269 }
static XLogwrtResult LogwrtResult
Definition: xlog.c:756
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
XLogwrtResult LogwrtResult
Definition: xlog.c:612
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:712
XLogRecPtr Flush
Definition: xlog.c:438

◆ GetFullPageWriteInfo()

void GetFullPageWriteInfo ( XLogRecPtr RedoRecPtr_p,
bool doPageWrites_p 
)

Definition at line 8231 of file xlog.c.

References doPageWrites, and RedoRecPtr.

Referenced by XLogCheckBufferNeedsBackup(), and XLogInsert().

8232 {
8233  *RedoRecPtr_p = RedoRecPtr;
8234  *doPageWrites_p = doPageWrites;
8235 }
static bool doPageWrites
Definition: xlog.c:371
static XLogRecPtr RedoRecPtr
Definition: xlog.c:364

◆ GetInsertRecPtr()

XLogRecPtr GetInsertRecPtr ( void  )

Definition at line 8246 of file xlog.c.

References XLogCtlData::info_lck, XLogCtlData::LogwrtRqst, SpinLockAcquire, SpinLockRelease, and XLogwrtRqst::Write.

Referenced by CheckpointerMain(), gistvacuumscan(), and IsCheckpointOnSchedule().

8247 {
8248  XLogRecPtr recptr;
8249 
8251  recptr = XLogCtl->LogwrtRqst.Write;
8253 
8254  return recptr;
8255 }
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
XLogRecPtr Write
Definition: xlog.c:431
XLogwrtRqst LogwrtRqst
Definition: xlog.c:592
uint64 XLogRecPtr
Definition: xlogdefs.h:21
static XLogCtlData * XLogCtl
Definition: xlog.c:712

◆ GetLastImportantRecPtr()

XLogRecPtr GetLastImportantRecPtr ( void  )

Definition at line 8280 of file xlog.c.

References i, InvalidXLogRecPtr, WALInsertLockPadded::l, WALInsertLock::lastImportantAt, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), and NUM_XLOGINSERT_LOCKS.

Referenced by BackgroundWriterMain(), CheckArchiveTimeout(), and CreateCheckPoint().

8281 {
8283  int i;
8284 
8285  for (i = 0; i < NUM_XLOGINSERT_LOCKS; i++)
8286  {
8287  XLogRecPtr last_important;
8288 
8289  /*
8290  * Need to take a lock to prevent torn reads of the LSN, which are
8291  * possible on some of the supported platforms. WAL insert locks only
8292  * support exclusive mode, so we have to use that.
8293  */
8295  last_important = WALInsertLocks[i].l.lastImportantAt;
8296  LWLockRelease(&WALInsertLocks[i].l.lock);
8297 
8298  if (res < last_important)
8299  res = last_important;
8300  }
8301 
8302  return res;
8303 }
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
XLogRecPtr lastImportantAt
Definition: xlog.c:481
#define NUM_XLOGINSERT_LOCKS
Definition: xlog.c:119
WALInsertLock l
Definition: xlog.c:493
void LWLockRelease(LWLock *lock)
Definition: lwlock.c:1726
uint64 XLogRecPtr
Definition: xlogdefs.h:21
bool LWLockAcquire(LWLock *lock, LWLockMode mode)
Definition: lwlock.c:1122
int i
static WALInsertLockPadded * WALInsertLocks
Definition: xlog.c:715

◆ GetLatestXTime()

TimestampTz GetLatestXTime ( void  )

Definition at line 6071 of file xlog.c.

References XLogCtlData::info_lck, XLogCtlData::recoveryLastXTime, SpinLockAcquire, and SpinLockRelease.

Referenced by CreateRestartPoint(), pg_last_xact_replay_timestamp(), and StartupXLOG().

6072 {
6073  TimestampTz xtime;
6074 
6076  xtime = XLogCtl->recoveryLastXTime;
6078 
6079  return xtime;
6080 }
int64 TimestampTz
Definition: timestamp.h:39
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
TimestampTz recoveryLastXTime
Definition: xlog.c:693
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:712

◆ GetMockAuthenticationNonce()

char* GetMockAuthenticationNonce ( void  )

Definition at line 4808 of file xlog.c.

References Assert, and ControlFileData::mock_authentication_nonce.

Referenced by scram_mock_salt().

4809 {
4810  Assert(ControlFile != NULL);
4812 }
char mock_authentication_nonce[MOCK_AUTH_NONCE_LEN]
Definition: pg_control.h:227
static ControlFileData * ControlFile
Definition: xlog.c:720
#define Assert(condition)
Definition: c.h:739

◆ GetRedoRecPtr()

XLogRecPtr GetRedoRecPtr ( void  )

Definition at line 8203 of file xlog.c.

References XLogCtlData::info_lck, RedoRecPtr, XLogCtlData::RedoRecPtr, SpinLockAcquire, and SpinLockRelease.

Referenced by CheckPointLogicalRewriteHeap(), CheckPointSnapBuild(), InitXLOGAccess(), nextval_internal(), ReplicationSlotReserveWal(), XLogPageRead(), XLogSaveBufferForHint(), and XLogWrite().

8204 {
8205  XLogRecPtr ptr;
8206 
8207  /*
8208  * The possibly not up-to-date copy in XlogCtl is enough. Even if we
8209  * grabbed a WAL insertion lock to read the master copy, someone might
8210  * update it just after we've released the lock.
8211  */
8213  ptr = XLogCtl->RedoRecPtr;
8215 
8216  if (RedoRecPtr < ptr)
8217  RedoRecPtr = ptr;
8218 
8219  return RedoRecPtr;
8220 }
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
static XLogRecPtr RedoRecPtr
Definition: xlog.c:364
XLogRecPtr RedoRecPtr
Definition: xlog.c:593
#define SpinLockRelease(lock)
Definition: spin.h:64
uint64 XLogRecPtr
Definition: xlogdefs.h:21
static XLogCtlData * XLogCtl
Definition: xlog.c:712

◆ GetSystemIdentifier()

uint64 GetSystemIdentifier ( void  )

Definition at line 4798 of file xlog.c.

References Assert, and ControlFileData::system_identifier.

Referenced by IdentifySystem(), and WalReceiverMain().

4799 {
4800  Assert(ControlFile != NULL);
4802 }
uint64 system_identifier
Definition: pg_control.h:106
static ControlFileData * ControlFile
Definition: xlog.c:720
#define Assert(condition)
Definition: c.h:739

◆ GetXLogInsertRecPtr()

XLogRecPtr GetXLogInsertRecPtr ( void  )

Definition at line 11212 of file xlog.c.

References XLogCtlInsert::CurrBytePos, Insert(), XLogCtlData::Insert, XLogCtlInsert::insertpos_lck, SpinLockAcquire, SpinLockRelease, and XLogBytePosToRecPtr().

Referenced by GetSnapshotData(), logical_begin_heap_rewrite(), pg_current_wal_insert_lsn(), and ReplicationSlotReserveWal().

11213 {
11215  uint64 current_bytepos;
11216 
11217  SpinLockAcquire(&Insert->insertpos_lck);
11218  current_bytepos = Insert->CurrBytePos;
11219  SpinLockRelease(&Insert->insertpos_lck);
11220 
11221  return XLogBytePosToRecPtr(current_bytepos);
11222 }
slock_t insertpos_lck
Definition: xlog.c:531
static XLogRecPtr XLogBytePosToRecPtr(uint64 bytepos)
Definition: xlog.c:1958
XLogCtlInsert Insert
Definition: xlog.c:589
#define SpinLockAcquire(lock)
Definition: spin.h:62
uint64 CurrBytePos
Definition: xlog.c:540
static void Insert(File file)
Definition: fd.c:1096
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:712

◆ GetXLogReceiptTime()

void GetXLogReceiptTime ( TimestampTz rtime,
bool fromStream 
)

Definition at line 6117 of file xlog.c.

References Assert, InRecovery, XLOG_FROM_STREAM, XLogReceiptSource, and XLogReceiptTime.

Referenced by GetStandbyLimitTime().

6118 {
6119  /*
6120  * This must be executed in the startup process, since we don't export the
6121  * relevant state to shared memory.
6122  */
6123  Assert(InRecovery);
6124 
6125  *rtime = XLogReceiptTime;
6126  *fromStream = (XLogReceiptSource == XLOG_FROM_STREAM);
6127 }
static XLogSource XLogReceiptSource
Definition: xlog.c:821
bool InRecovery
Definition: xlog.c:200
static TimestampTz XLogReceiptTime
Definition: xlog.c:820
#define Assert(condition)
Definition: c.h:739

◆ GetXLogReplayRecPtr()

XLogRecPtr GetXLogReplayRecPtr ( TimeLineID replayTLI)

Definition at line 11193 of file xlog.c.

References XLogCtlData::info_lck, XLogCtlData::lastReplayedEndRecPtr, XLogCtlData::lastReplayedTLI, SpinLockAcquire, and SpinLockRelease.

Referenced by CheckpointerMain(), CreateRestartPoint(), GetReplicationApplyDelay(), GetStandbyFlushRecPtr(), IsCheckpointOnSchedule(), pg_last_wal_replay_lsn(), pg_logical_slot_get_changes_guts(), pg_replication_slot_advance(), read_local_xlog_page(), WalReceiverMain(), WalSndWaitForWal(), and XLogWalRcvSendReply().

11194 {
11195  XLogRecPtr recptr;
11196  TimeLineID tli;
11197 
11199  recptr = XLogCtl->lastReplayedEndRecPtr;
11200  tli = XLogCtl->lastReplayedTLI;
11202 
11203  if (replayTLI)
11204  *replayTLI = tli;
11205  return recptr;
11206 }
uint32 TimeLineID
Definition: xlogdefs.h:52
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
uint64 XLogRecPtr
Definition: xlogdefs.h:21
static XLogCtlData * XLogCtl
Definition: xlog.c:712
TimeLineID lastReplayedTLI
Definition: xlog.c:689
XLogRecPtr lastReplayedEndRecPtr
Definition: xlog.c:688

◆ GetXLogWriteRecPtr()

XLogRecPtr GetXLogWriteRecPtr ( void  )

Definition at line 11228 of file xlog.c.

References XLogCtlData::info_lck, XLogCtlData::LogwrtResult, SpinLockAcquire, SpinLockRelease, and XLogwrtResult::Write.

Referenced by pg_attribute_noreturn(), and pg_current_wal_lsn().

11229 {
11233 
11234  return LogwrtResult.Write;
11235 }
static XLogwrtResult LogwrtResult
Definition: xlog.c:756
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
XLogwrtResult LogwrtResult
Definition: xlog.c:612
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:712
XLogRecPtr Write
Definition: xlog.c:437

◆ HotStandbyActive()

bool HotStandbyActive ( void  )

Definition at line 7986 of file xlog.c.

References XLogCtlData::info_lck, LocalHotStandbyActive, XLogCtlData::SharedHotStandbyActive, SpinLockAcquire, and SpinLockRelease.

Referenced by XLogWalRcvSendHSFeedback().

7987 {
7988  /*
7989  * We check shared state each time only until Hot Standby is active. We
7990  * can't de-activate Hot Standby, so there's no need to keep checking
7991  * after the shared variable has once been seen true.
7992  */
7994  return true;
7995  else
7996  {
7997  /* spinlock is essential on machines with weak memory ordering! */
8001 
8002  return LocalHotStandbyActive;
8003  }
8004 }
bool SharedHotStandbyActive
Definition: xlog.c:654
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
static bool LocalHotStandbyActive
Definition: xlog.c:229
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:712

◆ HotStandbyActiveInReplay()

bool HotStandbyActiveInReplay ( void  )

Definition at line 8011 of file xlog.c.

References AmStartupProcess, Assert, IsPostmasterEnvironment, and LocalHotStandbyActive.

8012 {
8014  return LocalHotStandbyActive;
8015 }
#define AmStartupProcess()
Definition: miscadmin.h:410
bool IsPostmasterEnvironment
Definition: globals.c:108
static bool LocalHotStandbyActive
Definition: xlog.c:229
#define Assert(condition)
Definition: c.h:739

◆ InitXLOGAccess()

void InitXLOGAccess ( void  )

Definition at line 8177 of file xlog.c.

References Assert, doPageWrites, XLogCtlInsert::forcePageWrites, XLogCtlInsert::fullPageWrites, GetRedoRecPtr(), InitXLogInsert(), Insert(), XLogCtlData::Insert, IsBootstrapProcessingMode, ThisTimeLineID, XLogCtlData::ThisTimeLineID, wal_segment_size, and ControlFileData::xlog_seg_size.

Referenced by AuxiliaryProcessMain(), LocalSetXLogInsertAllowed(), and RecoveryInProgress().

8178 {
8180 
8181  /* ThisTimeLineID doesn't change so we need no lock to copy it */
8184 
8185  /* set wal_segment_size */
8187 
8188  /* Use GetRedoRecPtr to copy the RedoRecPtr safely */
8189  (void) GetRedoRecPtr();
8190  /* Also update our copy of doPageWrites. */
8191  doPageWrites = (Insert->fullPageWrites || Insert->forcePageWrites);
8192 
8193  /* Also initialize the working areas for constructing WAL records */
8194  InitXLogInsert();
8195 }
int wal_segment_size
Definition: xlog.c:112
void InitXLogInsert(void)
Definition: xloginsert.c:1110
TimeLineID ThisTimeLineID
Definition: xlog.c:641
XLogCtlInsert Insert
Definition: xlog.c:589
bool fullPageWrites
Definition: xlog.c:564
uint32 xlog_seg_size
Definition: pg_control.h:209
static bool doPageWrites
Definition: xlog.c:371
bool forcePageWrites
Definition: xlog.c:563
static void Insert(File file)
Definition: fd.c:1096
static ControlFileData * ControlFile
Definition: xlog.c:720
TimeLineID ThisTimeLineID
Definition: xlog.c:187
#define Assert(condition)
Definition: c.h:739
static XLogCtlData * XLogCtl
Definition: xlog.c:712
XLogRecPtr GetRedoRecPtr(void)
Definition: xlog.c:8203
#define IsBootstrapProcessingMode()
Definition: miscadmin.h:372

◆ issue_xlog_fsync()

void issue_xlog_fsync ( int  fd,
XLogSegNo  segno 
)

Definition at line 10126 of file xlog.c.

References _, elog, ereport, errcode_for_file_access(), errmsg(), MAXFNAMELEN, PANIC, pg_fdatasync(), pg_fsync_no_writethrough(), pg_fsync_writethrough(), pgstat_report_wait_end(), pgstat_report_wait_start(), sync_method, SYNC_METHOD_FDATASYNC, SYNC_METHOD_FSYNC, SYNC_METHOD_FSYNC_WRITETHROUGH, SYNC_METHOD_OPEN, SYNC_METHOD_OPEN_DSYNC, ThisTimeLineID, WAIT_EVENT_WAL_SYNC, wal_segment_size, and XLogFileName.

Referenced by XLogWalRcvFlush(), and XLogWrite().

10127 {
10128  char *msg = NULL;
10129 
10131  switch (sync_method)
10132  {
10133  case SYNC_METHOD_FSYNC:
10134  if (pg_fsync_no_writethrough(fd) != 0)
10135  msg = _("could not fsync file \"%s\": %m");
10136  break;
10137 #ifdef HAVE_FSYNC_WRITETHROUGH
10139  if (pg_fsync_writethrough(fd) != 0)
10140  msg = _("could not fsync write-through file \"%s\": %m");
10141  break;
10142 #endif
10143 #ifdef HAVE_FDATASYNC
10144  case SYNC_METHOD_FDATASYNC:
10145  if (pg_fdatasync(fd) != 0)
10146  msg = _("could not fdatasync file \"%s\": %m");
10147  break;
10148 #endif
10149  case SYNC_METHOD_OPEN:
10151  /* write synced it already */
10152  break;
10153  default:
10154  elog(PANIC, "unrecognized wal_sync_method: %d", sync_method);
10155  break;
10156  }
10157 
10158  /* PANIC if failed to fsync */
10159  if (msg)
10160  {
10161  char xlogfname[MAXFNAMELEN];
10162  int save_errno = errno;
10163 
10164  XLogFileName(xlogfname, ThisTimeLineID, segno,
10166  errno = save_errno;
10167  ereport(PANIC,
10169  errmsg(msg, xlogfname)));
10170  }
10171 
10173 }
int pg_fdatasync(int fd)
Definition: fd.c:420
int wal_segment_size
Definition: xlog.c:112
#define SYNC_METHOD_FSYNC_WRITETHROUGH
Definition: xlog.h:28
int pg_fsync_writethrough(int fd)
Definition: fd.c:397
int pg_fsync_no_writethrough(int fd)
Definition: fd.c:385
#define PANIC
Definition: elog.h:53
static int fd(const char *x, int i)
Definition: preproc-init.c:105
#define SYNC_METHOD_OPEN_DSYNC
Definition: xlog.h:29
int errcode_for_file_access(void)
Definition: elog.c:631
#define SYNC_METHOD_FSYNC
Definition: xlog.h:25
static void pgstat_report_wait_end(void)
Definition: pgstat.h:1344
#define ereport(elevel, rest)
Definition: elog.h:141
#define SYNC_METHOD_OPEN
Definition: xlog.h:27
#define MAXFNAMELEN
TimeLineID ThisTimeLineID
Definition: xlog.c:187
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
static void pgstat_report_wait_start(uint32 wait_event_info)
Definition: pgstat.h:1320
int sync_method
Definition: xlog.c:102
#define SYNC_METHOD_FDATASYNC
Definition: xlog.h:26
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define elog(elevel,...)
Definition: elog.h:228
#define _(x)
Definition: elog.c:87

◆ LocalProcessControlFile()

void LocalProcessControlFile ( bool  reset)

Definition at line 4918 of file xlog.c.

References Assert, palloc(), and ReadControlFile().

Referenced by BackendRun(), PostgresMain(), PostmasterMain(), and PostmasterStateMachine().

4919 {
4920  Assert(reset || ControlFile == NULL);
4921  ControlFile = palloc(sizeof(ControlFileData));
4922  ReadControlFile();
4923 }
static void ReadControlFile(void)
Definition: xlog.c:4589
static ControlFileData * ControlFile
Definition: xlog.c:720
#define Assert(condition)
Definition: c.h:739
void * palloc(Size size)
Definition: mcxt.c:949

◆ RecoveryInProgress()

bool RecoveryInProgress ( void  )

Definition at line 7930 of file xlog.c.

References InitXLOGAccess(), LocalRecoveryInProgress, pg_memory_barrier, XLogCtlData::SharedRecoveryInProgress, and XLogCtl.

Referenced by BackgroundWriterMain(), brin_desummarize_range(), brin_summarize_range(), btree_index_mainfork_expected(), check_transaction_read_only(), check_XactIsoLevel(), CheckArchiveTimeout(), CheckLogicalDecodingRequirements(), CheckpointerMain(), CreateCheckPoint(), CreateEndOfRecoveryRecord(), CreateRestartPoint(), do_pg_start_backup(), do_pg_stop_backup(), error_commit_ts_disabled(), get_relation_info(), GetNewMultiXactId(), GetNewObjectId(), GetNewTransactionId(), GetOldestActiveTransactionId(), GetOldestSafeDecodingTransactionId(), GetOldestXmin(), GetRunningTransactionData(), GetSerializableTransactionSnapshot(), GetSerializableTransactionSnapshotInt(), GetSnapshotData(), gin_clean_pending_list(), heap_page_prune_opt(), IdentifySystem(), InitPostgres(), InitTempTableNamespace(), IsCheckpointOnSchedule(), LockAcquireExtended(), MarkBufferDirtyHint(), OldSerXidSetActiveSerXmin(), perform_base_backup(), pg_create_restore_point(), pg_current_wal_flush_lsn(), pg_current_wal_insert_lsn(), pg_current_wal_lsn(), pg_is_in_recovery(), pg_is_wal_replay_paused(), pg_logical_slot_get_changes_guts(), pg_promote(), pg_replication_slot_advance(), pg_switch_wal(), pg_wal_replay_pause(), pg_wal_replay_resume(), pg_walfile_name(), pg_walfile_name_offset(), PrepareRedoAdd(), PrepareRedoRemove(), PreventCommandDuringRecovery(), ProcSendSignal(), ProcSleep(), read_local_xlog_page(), ReplicationSlotReserveWal(), replorigin_check_prerequisites(), sendDir(), ShutdownXLOG(), SnapBuildWaitSnapshot(), standard_ProcessUtility(), StartLogicalReplication(), StartTransaction(), TransactionIdIsInProgress(), TruncateMultiXact(), UpdateFullPageWrites(), WalReceiverMain(), WalSndWaitForWal(), XLogArchiveCheckDone(), XLogBackgroundFlush(), XLogInsertAllowed(), XLogNeedsFlush(), and XLogSendPhysical().

7931 {
7932  /*
7933  * We check shared state each time only until we leave recovery mode. We
7934  * can't re-enter recovery, so there's no need to keep checking after the
7935  * shared variable has once been seen false.
7936  */
7938  return false;
7939  else
7940  {
7941  /*
7942  * use volatile pointer to make sure we make a fresh read of the
7943  * shared variable.
7944  */
7945  volatile XLogCtlData *xlogctl = XLogCtl;
7946 
7948 
7949  /*
7950  * Initialize TimeLineID and RedoRecPtr when we discover that recovery
7951  * is finished. InitPostgres() relies upon this behaviour to ensure
7952  * that InitXLOGAccess() is called at backend startup. (If you change
7953  * this, see also LocalSetXLogInsertAllowed.)
7954  */
7956  {
7957  /*
7958  * If we just exited recovery, make sure we read TimeLineID and
7959  * RedoRecPtr after SharedRecoveryInProgress (for machines with
7960  * weak memory ordering).
7961  */
7963  InitXLOGAccess();
7964  }
7965 
7966  /*
7967  * Note: We don't need a memory barrier when we're still in recovery.
7968  * We might exit recovery immediately after return, so the caller
7969  * can't rely on 'true' meaning that we're still in recovery anyway.
7970  */
7971 
7972  return LocalRecoveryInProgress;
7973  }
7974 }
void InitXLOGAccess(void)
Definition: xlog.c:8177
bool SharedRecoveryInProgress
Definition: xlog.c:648
#define pg_memory_barrier()
Definition: atomics.h:145
static XLogCtlData * XLogCtl
Definition: xlog.c:712
static bool LocalRecoveryInProgress
Definition: xlog.c:223

◆ RecoveryIsPaused()

bool RecoveryIsPaused ( void  )

Definition at line 5935 of file xlog.c.

References XLogCtlData::info_lck, XLogCtlData::recoveryPause, SpinLockAcquire, and SpinLockRelease.

Referenced by pg_is_wal_replay_paused(), and recoveryPausesHere().

5936 {
5937  bool recoveryPause;
5938 
5940  recoveryPause = XLogCtl->recoveryPause;
5942 
5943  return recoveryPause;
5944 }
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
bool recoveryPause
Definition: xlog.c:701
static XLogCtlData * XLogCtl
Definition: xlog.c:712

◆ register_persistent_abort_backup_handler()

void register_persistent_abort_backup_handler ( void  )

Definition at line 11177 of file xlog.c.

References before_shmem_exit(), DatumGetBool, and do_pg_abort_backup().

Referenced by pg_start_backup().

11178 {
11179  static bool already_done = false;
11180 
11181  if (already_done)
11182  return;
11184  already_done = true;
11185 }
void do_pg_abort_backup(int code, Datum arg)
Definition: xlog.c:11145
#define DatumGetBool(X)
Definition: postgres.h:393
void before_shmem_exit(pg_on_exit_callback function, Datum arg)
Definition: ipc.c:333

◆ RemovePromoteSignalFiles()

void RemovePromoteSignalFiles ( void  )

Definition at line 12273 of file xlog.c.

References FALLBACK_PROMOTE_SIGNAL_FILE, and PROMOTE_SIGNAL_FILE.

Referenced by PostmasterMain().

12274 {
12275  unlink(PROMOTE_SIGNAL_FILE);
12277 }
#define PROMOTE_SIGNAL_FILE
Definition: xlog.h:366
#define FALLBACK_PROMOTE_SIGNAL_FILE
Definition: xlog.h:367

◆ SetRecoveryPause()

void SetRecoveryPause ( bool  recoveryPause)

Definition at line 5947 of file xlog.c.

References XLogCtlData::info_lck, XLogCtlData::recoveryPause, SpinLockAcquire, and SpinLockRelease.

Referenced by pg_wal_replay_pause(), pg_wal_replay_resume(), and StartupXLOG().

5948 {
5950  XLogCtl->recoveryPause = recoveryPause;
5952 }
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
bool recoveryPause
Definition: xlog.c:701
static XLogCtlData * XLogCtl
Definition: xlog.c:712

◆ SetWalWriterSleeping()

void SetWalWriterSleeping ( bool  sleeping)

Definition at line 12309 of file xlog.c.

References XLogCtlData::info_lck, SpinLockAcquire, SpinLockRelease, and XLogCtlData::WalWriterSleeping.

Referenced by WalWriterMain().

12310 {
12312  XLogCtl->WalWriterSleeping = sleeping;
12314 }
slock_t info_lck
Definition: xlog.c:709
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
bool WalWriterSleeping
Definition: xlog.c:661
static XLogCtlData * XLogCtl
Definition: xlog.c:712

◆ ShutdownXLOG()

void ShutdownXLOG ( int  code,
Datum  arg 
)

Definition at line 8326 of file xlog.c.

References Assert, AuxProcessResourceOwner, CHECKPOINT_IMMEDIATE, CHECKPOINT_IS_SHUTDOWN, CreateCheckPoint(), CreateRestartPoint(), CurrentResourceOwner, ereport, errmsg(), IsPostmasterEnvironment, LOG, NOTICE, RecoveryInProgress(), RequestXLogSwitch(), ShutdownCLOG(), ShutdownCommitTs(), ShutdownMultiXact(), ShutdownSUBTRANS(), WalSndInitStopping(), WalSndWaitStopping(), XLogArchiveCommandSet, and XLogArchivingActive.

Referenced by HandleCheckpointerInterrupts(), and InitPostgres().

8327 {
8328  /*
8329  * We should have an aux process resource owner to use, and we should not
8330  * be in a transaction that's installed some other resowner.
8331  */
8333  Assert(CurrentResourceOwner == NULL ||
8336 
8337  /* Don't be chatty in standalone mode */
8339  (errmsg("shutting down")));
8340 
8341  /*
8342  * Signal walsenders to move to stopping state.
8343  */
8345 
8346  /*
8347  * Wait for WAL senders to be in stopping state. This prevents commands
8348  * from writing new WAL.
8349  */
8351 
8352  if (RecoveryInProgress())
8354  else
8355  {
8356  /*
8357  * If archiving is enabled, rotate the last XLOG file so that all the
8358  * remaining records are archived (postmaster wakes up the archiver
8359  * process one more time at the end of shutdown). The checkpoint
8360  * record will go to the next XLOG file and won't be archived (yet).
8361  */
8363  RequestXLogSwitch(false);
8364 
8366  }
8367  ShutdownCLOG();
8368  ShutdownCommitTs();
8369  ShutdownSUBTRANS();
8371 }
bool IsPostmasterEnvironment
Definition: globals.c:108
XLogRecPtr RequestXLogSwitch(bool mark_unimportant)
Definition: xlog.c:9409
void ShutdownSUBTRANS(void)
Definition: subtrans.c:285
void CreateCheckPoint(int flags)
Definition: xlog.c:8542
ResourceOwner CurrentResourceOwner
Definition: resowner.c:142
void ShutdownCLOG(void)
Definition: clog.c:816
bool CreateRestartPoint(int flags)
Definition: xlog.c:9082
#define XLogArchiveCommandSet()
Definition: xlog.h:175
#define LOG
Definition: elog.h:26
bool RecoveryInProgress(void)
Definition: xlog.c:7930
ResourceOwner AuxProcessResourceOwner
Definition: resowner.c:145
void WalSndWaitStopping(void)
Definition: walsender.c:3099
void ShutdownMultiXact(void)
Definition: multixact.c:2107
#define ereport(elevel, rest)
Definition: elog.h:141
#define NOTICE
Definition: elog.h:37
void WalSndInitStopping(void)
Definition: walsender.c:3073
void ShutdownCommitTs(void)
Definition: commit_ts.c:744
#define Assert(condition)
Definition: c.h:739
#define XLogArchivingActive()
Definition: xlog.h:170
int errmsg(const char *fmt,...)
Definition: elog.c:822
#define CHECKPOINT_IMMEDIATE
Definition: xlog.h:214
#define CHECKPOINT_IS_SHUTDOWN
Definition: xlog.h:211

◆ StartupXLOG()

void StartupXLOG ( void  )

Definition at line 6200 of file xlog.c.

References AdvanceNextFullTransactionIdPastXid(), AdvanceOldestClogXid(), AllowCascadeReplication, appendStringInfo(), appendStringInfoString(), ArchiveRecoveryRequested, ErrorContextCallback::arg, Assert, AuxProcessResourceOwner, BACKUP_LABEL_FILE, BACKUP_LABEL_OLD, ControlFileData::backupEndPoint, ControlFileData::backupEndRequired, ControlFileData::backupStartPoint, bgwriterLaunched, buf, ErrorContextCallback::callback, ControlFileData::checkPoint, CHECKPOINT_END_OF_RECOVERY, CHECKPOINT_FORCE, CHECKPOINT_IMMEDIATE, CHECKPOINT_WAIT, ControlFileData::checkPointCopy, CheckRecoveryConsistency(), CheckRequiredParameterValues(), checkTimeLineSwitch(), checkXLogConsistency(), XLogCtlData::ckptFullXid, close, CompleteCommitTsInitialization(), CreateCheckPoint(), CreateEndOfRecoveryRecord(), XLogCtlInsert::CurrBytePos, XLogCtlData::currentChunkStartTime, CurrentResourceOwner, StringInfoData::data, DataDir, DB_IN_ARCHIVE_RECOVERY, DB_IN_CRASH_RECOVERY, DB_IN_PRODUCTION, DB_SHUTDOWNED, DB_SHUTDOWNED_IN_RECOVERY, DB_SHUTDOWNING, DEBUG1, DEBUG2, DEBUG3, DeleteAllExportedSnapshotFiles(), DisownLatch(), doPageWrites, doRequestWalReceiverReply, durable_rename(), elog, EnableHotStandby, EnableSyncRequestForwarding(), EndRecPtr, ereport, errcode(), errcode_for_file_access(), errdetail(), errhint(), errmsg(), errmsg_internal(), ERROR, error_context_stack, ExecuteRecoveryCommand(), exitArchiveRecovery(), fast_promote, FATAL, findNewestTimeLine(), FirstNormalUnloggedLSN, XLogwrtRqst::Flush, XLogwrtResult::Flush, CheckPoint::fullPageWrites, XLogCtlInsert::fullPageWrites, GetCurrentTimestamp(), GetLatestXTime(), HandleStartupProcInterrupts(), InArchiveRecovery, XLogCtlData::info_lck, XLogCtlData::InitializedUpTo, InitRecoveryTransactionEnvironment(), initStringInfo(), InRecovery, InRedo, Insert(), XLogCtlData::Insert, InvalidXLogRecPtr, IsPostmasterEnvironment, IsUnderPostmaster, lastFullPageWrites, LastRec, XLogCtlData::lastReplayedEndRecPtr, XLogCtlData::lastReplayedTLI, XLogCtlData::lastSegSwitchLSN, XLogCtlData::lastSegSwitchTime, RunningTransactionsData::latestCompletedXid, VariableCacheData::latestCompletedXid, lfirst, LocalSetXLogInsertAllowed(), LocalXLogInsertAllowed, LOG, XLogCtlData::LogwrtResult, LogwrtResult, XLogCtlData::LogwrtRqst, LW_EXCLUSIVE, LWLockAcquire(), LWLockRelease(), master_image_masked, MAXFNAMELEN, MAXPGPATH, MemSet, ControlFileData::minRecoveryPoint, minRecoveryPoint, ControlFileData::minRecoveryPointTLI, minRecoveryPointTLI, MultiXactSetNextMXact(), CheckPoint::newestCommitTsXid, CheckPoint::nextFullXid, VariableCacheData::nextFullXid, CheckPoint::nextMulti, CheckPoint::nextMultiOffset, CheckPoint::nextOid, VariableCacheData::nextOid, RunningTransactionsData::nextXid, NIL, NOTICE, tablespaceinfo::oid, VariableCacheData::oidCount, CheckPoint::oldestActiveXid, CheckPoint::oldestCommitTsXid, CheckPoint::oldestMulti, CheckPoint::oldestMultiDB, RunningTransactionsData::oldestRunningXid, CheckPoint::oldestXid, CheckPoint::oldestXidDB, OwnLatch(), XLogCtlData::pages, palloc(), PANIC, tablespaceinfo::path, pfree(), pg_usleep(), pgstat_reset_all(), PMSIGNAL_RECOVERY_STARTED, PreallocXlogFiles(), PrescanPreparedTransactions(), XLogCtlInsert::PrevBytePos, ErrorContextCallback::previous, CheckPoint::PrevTimeLineID, xl_end_of_recovery::PrevTimeLineID, XLogCtlData::PrevTimeLineID, proc_exit(), ProcArrayApplyRecoveryInfo(), ProcArrayInitRecovery(), psprintf(), PublishStartupProcessInformation(), reachedConsistency, read_backup_label(), read_tablespace_map(), XLogReaderState::readBuf, ReadCheckpointRecord(), readFile, readOff, ReadRecord(), readRecoverySignalFile(), ReadRecPtr, RecordKnownAssignedTransactionIds(), RecoverPreparedTransactions(), RECOVERY_TARGET_ACTION_PAUSE, RECOVERY_TARGET_ACTION_PROMOTE, RECOVERY_TARGET_ACTION_SHUTDOWN, RECOVERY_TARGET_IMMEDIATE, RECOVERY_TARGET_LSN, RECOVERY_TARGET_NAME, RECOVERY_TARGET_TIME, RECOVERY_TARGET_XID, recoveryApplyDelay(), recoveryEndCommand, XLogCtlData::recoveryLastXTime, XLogCtlData::recoveryPause, recoveryPausesHere(), recoveryStopAfter, recoveryStopLSN, recoveryStopName, recoveryStopsAfter(), recoveryStopsBefore(), recoveryStopTime, recoveryStopXid, recoveryTarget, recoveryTargetAction, recoveryTargetLSN, recoveryTargetName, recoveryTargetTime, recoveryTargetTLI, recoveryTargetXid, XLogCtlData::recoveryWakeupLatch, CheckPoint::redo, RedoRecPtr, XLogCtlInsert::RedoRecPtr, XLogCtlData::RedoRecPtr, RedoStartLSN, RelationCacheInitFileRemove(), remove_tablespace_symlink(), RemoveNonParentXlogFiles(), RemoveTempXlogFiles(), replay_image_masked, XLogCtlData::replayEndRecPtr, XLogCtlData::replayEndTLI, RequestCheckpoint(), ResetUnloggedRelations(), restoreTimeLineHistoryFiles(), restoreTwoPhaseData(), RmgrData::rm_cleanup, RM_MAX_ID, RmgrData::rm_redo, rm_redo_error_callback(), RmgrData::rm_startup, RmgrTable, XLogReaderState::seg, SendPostmasterSignal(), SetCommitTsLimit(), SetMultiXactIdLimit(), SetRecoveryPause(), SetTransactionIdLimit(), XLogCtlData::SharedRecoveryInProgress, ShmemVariableCache, ShutdownRecoveryTransactionEnvironment(), ShutdownWalRcv(), snprintf, SpinLockAcquire, SpinLockRelease, STANDBY_DISABLED, STANDBY_INITIALIZED, StandbyMode, StandbyModeRequested, StandbyRecoverPreparedTransactions(), standbyState, StartupCLOG(), StartupCommitTs(), StartupMultiXact(), StartupReorderBuffer(), StartupReplicationOrigin(), StartupReplicationSlots(), StartupSUBTRANS(), stat, ControlFileData::state, str_time(), RunningTransactionsData::subxcnt, RunningTransactionsData::subxid_overflow, symlink, SyncDataDirectory(), ControlFileData::system_identifier, XLogReaderState::system_identifier, TABLESPACE_MAP, TABLESPACE_MAP_OLD, CheckPoint::ThisTimeLineID, ThisTimeLineID, xl_end_of_recovery::ThisTimeLineID, XLogCtlData::ThisTimeLineID, CheckPoint::time, ControlFileData::time, timestamptz_to_str(), tliOfPointInHistory(), tliSwitchPoint(), trace_recovery_messages, ControlFileData::track_commit_timestamp, TransactionIdIsNormal, TransactionIdIsValid, TransactionIdRetreat, TrimCLOG(), TrimMultiXact(), U64FromFullTransactionId, UINT64_FORMAT, UNLOGGED_RELATION_CLEANUP, UNLOGGED_RELATION_INIT, ControlFileData::unloggedLSN, XLogCtlData::unloggedLSN, UpdateControlFile(), UpdateFullPageWrites(), validateRecoveryParameters(), ValidateXLOGDirectoryStructure(), wal_segment_size, WalRcvForceReply(), WalSndWakeup(), XLogwrtRqst::Write, XLogwrtResult::Write, writeTimeLineHistory(), WALOpenSegment::ws_tli, RunningTransactionsData::xcnt, XidFromFullTransactionId, RunningTransactionsData::xids, XLogRecord::xl_info, XLogRecord::xl_rmid, XLogRecord::xl_xid, XLogCtlData::xlblocks, XLByteToPrevSeg, XLOG_CHECKPOINT_SHUTDOWN, XLOG_END_OF_RECOVERY, xlog_outdesc(), XLogArchiveCleanup(), XLogArchiveIsReadyOrDone(), XLogArchiveNotify(), XLogArchivingActive, XLOGDIR, XLogFileName, XLogFilePath, XLogPageRead(), XLogReaderAllocate(), XLogReaderFree(), XLogReceiptTime, XLogRecGetData, XLogRecPtrIsInvalid, XLogRecPtrToBufIdx, XLogRecPtrToBytePos(), XLogReportParameters(), XLogSegmentOffset, XLR_CHECK_CONSISTENCY, XLR_INFO_MASK, and XRecOffIsValid.

Referenced by InitPostgres(), and StartupProcessMain().

6201 {
6203  CheckPoint checkPoint;
6204  bool wasShutdown;
6205  bool reachedStopPoint = false;
6206  bool haveBackupLabel = false;
6207  bool haveTblspcMap = false;
6208  XLogRecPtr RecPtr,
6209  checkPointLoc,
6210  EndOfLog;
6211  TimeLineID EndOfLogTLI;
6212  TimeLineID PrevTimeLineID;
6213  XLogRecord *record;
6214  TransactionId oldestActiveXID;
6215  bool backupEndRequired = false;
6216  bool backupFromStandby = false;
6217  DBState dbstate_at_startup;
6218  XLogReaderState *xlogreader;
6219  XLogPageReadPrivate private;
6220  bool fast_promoted = false;
6221  struct stat st;
6222 
6223  /*
6224  * We should have an aux process resource owner to use, and we should not
6225  * be in a transaction that's installed some other resowner.
6226  */
6228  Assert(CurrentResourceOwner == NULL ||
6231 
6232  /*
6233  * Check that contents look valid.
6234  */
6236  ereport(FATAL,
6237  (errmsg("control file contains invalid checkpoint location")));
6238 
6239  switch (ControlFile->state)
6240  {
6241  case DB_SHUTDOWNED:
6242  /* This is the expected case, so don't be chatty in standalone mode */
6244  (errmsg("database system was shut down at %s",
6245  str_time(ControlFile->time))));
6246  break;
6247 
6249  ereport(LOG,
6250  (errmsg("database system was shut down in recovery at %s",
6251  str_time(ControlFile->time))));
6252  break;
6253 
6254  case DB_SHUTDOWNING:
6255  ereport(LOG,
6256  (errmsg("database system shutdown was interrupted; last known up at %s",
6257  str_time(ControlFile->time))));
6258  break;
6259 
6260  case DB_IN_CRASH_RECOVERY:
6261  ereport(LOG,
6262  (errmsg("database system was interrupted while in recovery at %s",
6264  errhint("This probably means that some data is corrupted and"
6265  " you will have to use the last backup for recovery.")));
6266  break;
6267 
6269  ereport(LOG,
6270  (errmsg("database system was interrupted while in recovery at log time %s",
6272  errhint("If this has occurred more than once some data might be corrupted"
6273  " and you might need to choose an earlier recovery target.")));
6274  break;
6275 
6276  case DB_IN_PRODUCTION:
6277  ereport(LOG,
6278  (errmsg("database system was interrupted; last known up at %s",
6279  str_time(ControlFile->time))));
6280  break;
6281 
6282  default:
6283  ereport(FATAL,
6284  (errmsg("control file contains invalid database cluster state")));
6285  }
6286 
6287  /* This is just to allow attaching to startup process with a debugger */
6288 #ifdef XLOG_REPLAY_DELAY
6290  pg_usleep(60000000L);
6291 #endif
6292 
6293  /*
6294  * Verify that pg_wal and pg_wal/archive_status exist. In cases where
6295  * someone has performed a copy for PITR, these directories may have been
6296  * excluded and need to be re-created.
6297  */
6299 
6300  /*----------
6301  * If we previously crashed, perform a couple of actions:
6302  * - The pg_wal directory may still include some temporary WAL segments
6303  * used when creating a new segment, so perform some clean up to not
6304  * bloat this path. This is done first as there is no point to sync this
6305  * temporary data.
6306  * - There might be data which we had written, intending to fsync it,
6307  * but which we had not actually fsync'd yet. Therefore, a power failure
6308  * in the near future might cause earlier unflushed writes to be lost,
6309  * even though more recent data written to disk from here on would be
6310  * persisted. To avoid that, fsync the entire data directory.
6311  *---------
6312  */
6313  if (ControlFile->state != DB_SHUTDOWNED &&
6315  {
6318  }
6319 
6320  /*
6321  * Initialize on the assumption we want to recover to the latest timeline
6322  * that's active according to pg_control.
6323  */
6327  else
6329 
6330  /*
6331  * Check for signal files, and if so set up state for offline recovery
6332  */
6335 
6337  {
6339  ereport(LOG,
6340  (errmsg("entering standby mode")));
6341  else if (recoveryTarget == RECOVERY_TARGET_XID)
6342  ereport(LOG,
6343  (errmsg("starting point-in-time recovery to XID %u",
6344  recoveryTargetXid)));
6346  ereport(LOG,
6347  (errmsg("starting point-in-time recovery to %s",
6350  ereport(LOG,
6351  (errmsg("starting point-in-time recovery to \"%s\"",
6352  recoveryTargetName)));
6353  else if (recoveryTarget == RECOVERY_TARGET_LSN)
6354  ereport(LOG,
6355  (errmsg("starting point-in-time recovery to WAL location (LSN) \"%X/%X\"",
6356  (uint32) (recoveryTargetLSN >> 32),
6359  ereport(LOG,
6360  (errmsg("starting point-in-time recovery to earliest consistent point")));
6361  else
6362  ereport(LOG,
6363  (errmsg("starting archive recovery")));
6364  }
6365 
6366  /*
6367  * Take ownership of the wakeup latch if we're going to sleep during
6368  * recovery.
6369  */
6372 
6373  /* Set up XLOG reader facility */
6374  MemSet(&private, 0, sizeof(XLogPageReadPrivate));
6375  xlogreader = XLogReaderAllocate(wal_segment_size, NULL,
6376  &XLogPageRead, &private);
6377  if (!xlogreader)
6378  ereport(ERROR,
6379  (errcode(ERRCODE_OUT_OF_MEMORY),
6380  errmsg("out of memory"),
6381  errdetail("Failed while allocating a WAL reading processor.")));
6383 
6384  /*
6385  * Allocate two page buffers dedicated to WAL consistency checks. We do
6386  * it this way, rather than just making static arrays, for two reasons:
6387  * (1) no need to waste the storage in most instantiations of the backend;
6388  * (2) a static char array isn't guaranteed to have any particular
6389  * alignment, whereas palloc() will provide MAXALIGN'd storage.
6390  */
6391  replay_image_masked = (char *) palloc(BLCKSZ);
6392  master_image_masked = (char *) palloc(BLCKSZ);
6393 
6394  if (read_backup_label(&checkPointLoc, &backupEndRequired,
6395  &backupFromStandby))
6396  {
6397  List *tablespaces = NIL;
6398 
6399  /*
6400  * Archive recovery was requested, and thanks to the backup label
6401  * file, we know how far we need to replay to reach consistency. Enter
6402  * archive recovery directly.
6403  */
6404  InArchiveRecovery = true;
6406  StandbyMode = true;
6407 
6408  /*
6409  * When a backup_label file is present, we want to roll forward from
6410  * the checkpoint it identifies, rather than using pg_control.
6411  */
6412  record = ReadCheckpointRecord(xlogreader, checkPointLoc, 0, true);
6413  if (record != NULL)
6414  {
6415  memcpy(&checkPoint, XLogRecGetData(xlogreader), sizeof(CheckPoint));
6416  wasShutdown = ((record->xl_info & ~XLR_INFO_MASK) == XLOG_CHECKPOINT_SHUTDOWN);
6417  ereport(DEBUG1,
6418  (errmsg("checkpoint record is at %X/%X",
6419  (uint32) (checkPointLoc >> 32), (uint32) checkPointLoc)));
6420  InRecovery = true; /* force recovery even if SHUTDOWNED */
6421 
6422  /*
6423  * Make sure that REDO location exists. This may not be the case
6424  * if there was a crash during an online backup, which left a
6425  * backup_label around that references a WAL segment that's
6426  * already been archived.
6427  */
6428  if (checkPoint.redo < checkPointLoc)
6429  {
6430  if (!ReadRecord(xlogreader, checkPoint.redo, LOG, false))
6431  ereport(FATAL,
6432  (errmsg("could not find redo location referenced by checkpoint record"),
6433  errhint("If you are restoring from a backup, touch \"%s/recovery.signal\" and add required recovery options.\n"
6434  "If you are not restoring from a backup, try removing the file \"%s/backup_label\".\n"
6435  "Be careful: removing \"%s/backup_label\" will result in a corrupt cluster if restoring from a backup.",
6436  DataDir, DataDir, DataDir)));
6437  }
6438  }
6439  else
6440  {
6441  ereport(FATAL,
6442  (errmsg("could not locate required checkpoint record"),
6443  errhint("If you are restoring from a backup, touch \"%s/recovery.signal\" and add required recovery options.\n"
6444  "If you are not restoring from a backup, try removing the file \"%s/backup_label\".\n"
6445  "Be careful: removing \"%s/backup_label\" will result in a corrupt cluster if restoring from a backup.",
6446  DataDir, DataDir, DataDir)));
6447  wasShutdown = false; /* keep compiler quiet */
6448  }
6449 
6450  /* read the tablespace_map file if present and create symlinks. */
6451  if (read_tablespace_map(&tablespaces))
6452  {
6453  ListCell *lc;
6454 
6455  foreach(lc, tablespaces)
6456  {
6457  tablespaceinfo *ti = lfirst(lc);
6458  char *linkloc;
6459 
6460  linkloc = psprintf("pg_tblspc/%s", ti->oid);
6461 
6462  /*
6463  * Remove the existing symlink if any and Create the symlink
6464  * under PGDATA.
6465  */
6466  remove_tablespace_symlink(linkloc);
6467 
6468  if (symlink(ti->path, linkloc) < 0)
6469  ereport(ERROR,
6471  errmsg("could not create symbolic link \"%s\": %m",
6472  linkloc)));
6473 
6474  pfree(ti->oid);
6475  pfree(ti->path);
6476  pfree(ti);
6477  }
6478 
6479  /* set flag to delete it later */
6480  haveTblspcMap = true;
6481  }
6482 
6483  /* set flag to delete it later */
6484  haveBackupLabel = true;
6485  }
6486  else
6487  {
6488  /*
6489  * If tablespace_map file is present without backup_label file, there
6490  * is no use of such file. There is no harm in retaining it, but it
6491  * is better to get rid of the map file so that we don't have any
6492  * redundant file in data directory and it will avoid any sort of
6493  * confusion. It seems prudent though to just rename the file out of
6494  * the way rather than delete it completely, also we ignore any error
6495  * that occurs in rename operation as even if map file is present
6496  * without backup_label file, it is harmless.
6497  */
6498  if (stat(TABLESPACE_MAP, &st) == 0)
6499  {
6500  unlink(TABLESPACE_MAP_OLD);
6502  ereport(LOG,
6503  (errmsg("ignoring file \"%s\" because no file \"%s\" exists",
6505  errdetail("File \"%s\" was renamed to \"%s\".",
6507  else
6508  ereport(LOG,
6509  (errmsg("ignoring file \"%s\" because no file \"%s\" exists",
6511  errdetail("Could not rename file \"%s\" to \"%s\": %m.",
6513  }
6514 
6515  /*
6516  * It's possible that archive recovery was requested, but we don't
6517  * know how far we need to replay the WAL before we reach consistency.
6518  * This can happen for example if a base backup is taken from a
6519  * running server using an atomic filesystem snapshot, without calling
6520  * pg_start/stop_backup. Or if you just kill a running master server
6521  * and put it into archive recovery by creating a recovery signal
6522  * file.
6523  *
6524  * Our strategy in that case is to perform crash recovery first,
6525  * replaying all the WAL present in pg_wal, and only enter archive
6526  * recovery after that.
6527  *
6528  * But usually we already know how far we need to replay the WAL (up
6529  * to minRecoveryPoint, up to backupEndPoint, or until we see an
6530  * end-of-backup record), and we can enter archive recovery directly.
6531  */
6537  {
6538  InArchiveRecovery = true;
6540  StandbyMode = true;
6541  }
6542 
6543  /* Get the last valid checkpoint record. */
6544  checkPointLoc = ControlFile->checkPoint;
6546  record = ReadCheckpointRecord(xlogreader, checkPointLoc, 1, true);
6547  if (record != NULL)
6548  {
6549  ereport(DEBUG1,
6550  (errmsg("checkpoint record is at %X/%X",
6551  (uint32) (checkPointLoc >> 32), (uint32) checkPointLoc)));
6552  }
6553  else
6554  {
6555  /*
6556  * We used to attempt to go back to a secondary checkpoint record
6557  * here, but only when not in standby mode. We now just fail if we
6558  * can't read the last checkpoint because this allows us to
6559  * simplify processing around checkpoints.
6560  */
6561  ereport(PANIC,
6562  (errmsg("could not locate a valid checkpoint record")));
6563  }
6564  memcpy(&checkPoint, XLogRecGetData(xlogreader), sizeof(CheckPoint));
6565  wasShutdown = ((record->xl_info & ~XLR_INFO_MASK) == XLOG_CHECKPOINT_SHUTDOWN);
6566  }
6567 
6568  /*
6569  * Clear out any old relcache cache files. This is *necessary* if we do
6570  * any WAL replay, since that would probably result in the cache files
6571  * being out of sync with database reality. In theory we could leave them
6572  * in place if the database had been cleanly shut down, but it seems
6573  * safest to just remove them always and let them be rebuilt during the
6574  * first backend startup. These files needs to be removed from all
6575  * directories including pg_tblspc, however the symlinks are created only
6576  * after reading tablespace_map file in case of archive recovery from
6577  * backup, so needs to clear old relcache files here after creating
6578  * symlinks.
6579  */
6581 
6582  /*
6583  * If the location of the checkpoint record is not on the expected
6584  * timeline in the history of the requested timeline, we cannot proceed:
6585  * the backup is not part of the history of the requested timeline.
6586  */
6587  Assert(expectedTLEs); /* was initialized by reading checkpoint
6588  * record */
6589  if (tliOfPointInHistory(checkPointLoc, expectedTLEs) !=
6590  checkPoint.ThisTimeLineID)
6591  {
6592  XLogRecPtr switchpoint;
6593 
6594  /*
6595  * tliSwitchPoint will throw an error if the checkpoint's timeline is
6596  * not in expectedTLEs at all.
6597  */
6599  ereport(FATAL,
6600  (errmsg("requested timeline %u is not a child of this server's history",
6602  errdetail("Latest checkpoint is at %X/%X on timeline %u, but in the history of the requested timeline, the server forked off from that timeline at %X/%X.",
6603  (uint32) (ControlFile->checkPoint >> 32),