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)
 
char * XLogFileNameP (TimeLineID tli, XLogSegNo segno)
 
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 (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

◆ CheckpointStatsData

◆ SessionBackupState

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

References CalculateCheckpointSegments(), CheckPointCompletionTarget, and newval.

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

◆ assign_max_wal_size()

void assign_max_wal_size ( int  newval,
void *  extra 
)

Definition at line 2284 of file xlog.c.

References CalculateCheckpointSegments(), max_wal_size_mb, and newval.

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

◆ BootStrapXLOG()

void BootStrapXLOG ( void  )

Definition at line 5087 of file xlog.c.

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

Referenced by AuxiliaryProcessMain().

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

◆ CheckPromoteSignal()

bool CheckPromoteSignal ( void  )

Definition at line 12209 of file xlog.c.

References FALLBACK_PROMOTE_SIGNAL_FILE, PROMOTE_SIGNAL_FILE, and stat.

Referenced by sigusr1_handler().

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

◆ CheckXLogRemoved()

void CheckXLogRemoved ( XLogSegNo  segno,
TimeLineID  tli 
)

Definition at line 3846 of file xlog.c.

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

Referenced by perform_base_backup(), and XLogRead().

3847 {
3848  int save_errno = errno;
3849  XLogSegNo lastRemovedSegNo;
3850 
3852  lastRemovedSegNo = XLogCtl->lastRemovedSegNo;
3854 
3855  if (segno <= lastRemovedSegNo)
3856  {
3857  char filename[MAXFNAMELEN];
3858 
3859  XLogFileName(filename, tli, segno, wal_segment_size);
3860  errno = save_errno;
3861  ereport(ERROR,
3863  errmsg("requested WAL segment %s has already been removed",
3864  filename)));
3865  }
3866  errno = save_errno;
3867 }
int wal_segment_size
Definition: xlog.c:112
slock_t info_lck
Definition: xlog.c:710
XLogSegNo lastRemovedSegNo
Definition: xlog.c:599
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define ERROR
Definition: elog.h:43
uint64 XLogSegNo
Definition: xlogdefs.h:41
int errcode_for_file_access(void)
Definition: elog.c:593
#define ereport(elevel, rest)
Definition: elog.h:141
#define MAXFNAMELEN
#define SpinLockRelease(lock)
Definition: spin.h:64
#define XLogFileName(fname, tli, logSegNo, wal_segsz_bytes)
static XLogCtlData * XLogCtl
Definition: xlog.c:713
static char * filename
Definition: pg_dumpall.c:91
int errmsg(const char *fmt,...)
Definition: elog.c:784

◆ CreateCheckPoint()

void CreateCheckPoint ( int  flags)

Definition at line 8510 of file xlog.c.

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

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

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

◆ CreateRestartPoint()

bool CreateRestartPoint ( int  flags)

Definition at line 9050 of file xlog.c.

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

Referenced by CheckpointerMain(), and ShutdownXLOG().

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

◆ DataChecksumsEnabled()

bool DataChecksumsEnabled ( void  )

Definition at line 4822 of file xlog.c.

References Assert, and ControlFileData::data_checksum_version.

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

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

◆ do_pg_abort_backup()

void do_pg_abort_backup ( void  )

Definition at line 11102 of file xlog.c.

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

Referenced by base_backup_cleanup(), and nonexclusive_base_backup_cleanup().

11103 {
11104  /*
11105  * Quick exit if session is not keeping around a non-exclusive backup
11106  * already started.
11107  */
11109  return;
11110 
11115 
11118  {
11119  XLogCtl->Insert.forcePageWrites = false;
11120  }
11122 }
static void WALInsertLockRelease(void)
Definition: xlog.c:1690
static SessionBackupState sessionBackupState
Definition: xlog.c:525
XLogCtlInsert Insert
Definition: xlog.c:590
bool forcePageWrites
Definition: xlog.c:564
int nonExclusiveBackups
Definition: xlog.c:576
ExclusiveBackupState exclusiveBackupState
Definition: xlog.c:575
#define Assert(condition)
Definition: c.h:732
static void WALInsertLockAcquireExclusive(void)
Definition: xlog.c:1661
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ do_pg_start_backup()

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

Definition at line 10178 of file xlog.c.

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

Referenced by perform_base_backup(), and pg_start_backup().

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

◆ do_pg_stop_backup()

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

Definition at line 10697 of file xlog.c.

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

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

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

◆ get_backup_status()

SessionBackupState get_backup_status ( void  )

Definition at line 10676 of file xlog.c.

References sessionBackupState.

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

10677 {
10678  return sessionBackupState;
10679 }
static SessionBackupState sessionBackupState
Definition: xlog.c:525

◆ GetCurrentChunkReplayStartTime()

TimestampTz GetCurrentChunkReplayStartTime ( void  )

Definition at line 6094 of file xlog.c.

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

Referenced by GetReplicationApplyDelay().

6095 {
6096  TimestampTz xtime;
6097 
6099  xtime = XLogCtl->currentChunkStartTime;
6101 
6102  return xtime;
6103 }
int64 TimestampTz
Definition: timestamp.h:39
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:713
TimestampTz currentChunkStartTime
Definition: xlog.c:700

◆ GetFakeLSNForUnloggedRel()

XLogRecPtr GetFakeLSNForUnloggedRel ( void  )

Definition at line 4838 of file xlog.c.

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

Referenced by gistGetFakeLSN().

4839 {
4840  XLogRecPtr nextUnloggedLSN;
4841 
4842  /* increment the unloggedLSN counter, need SpinLock */
4844  nextUnloggedLSN = XLogCtl->unloggedLSN++;
4846 
4847  return nextUnloggedLSN;
4848 }
XLogRecPtr unloggedLSN
Definition: xlog.c:602
#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:713
slock_t ulsn_lck
Definition: xlog.c:603

◆ GetFlushRecPtr()

XLogRecPtr GetFlushRecPtr ( void  )

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

8231 {
8235 
8236  return LogwrtResult.Flush;
8237 }
static XLogwrtResult LogwrtResult
Definition: xlog.c:757
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
XLogwrtResult LogwrtResult
Definition: xlog.c:613
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:713
XLogRecPtr Flush
Definition: xlog.c:439

◆ GetFullPageWriteInfo()

void GetFullPageWriteInfo ( XLogRecPtr RedoRecPtr_p,
bool doPageWrites_p 
)

Definition at line 8199 of file xlog.c.

References doPageWrites, and RedoRecPtr.

Referenced by XLogCheckBufferNeedsBackup(), and XLogInsert().

8200 {
8201  *RedoRecPtr_p = RedoRecPtr;
8202  *doPageWrites_p = doPageWrites;
8203 }
static bool doPageWrites
Definition: xlog.c:372
static XLogRecPtr RedoRecPtr
Definition: xlog.c:365

◆ GetInsertRecPtr()

XLogRecPtr GetInsertRecPtr ( void  )

Definition at line 8214 of file xlog.c.

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

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

8215 {
8216  XLogRecPtr recptr;
8217 
8219  recptr = XLogCtl->LogwrtRqst.Write;
8221 
8222  return recptr;
8223 }
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
XLogRecPtr Write
Definition: xlog.c:432
XLogwrtRqst LogwrtRqst
Definition: xlog.c:593
uint64 XLogRecPtr
Definition: xlogdefs.h:21
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ GetLastImportantRecPtr()

XLogRecPtr GetLastImportantRecPtr ( void  )

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

8249 {
8251  int i;
8252 
8253  for (i = 0; i < NUM_XLOGINSERT_LOCKS; i++)
8254  {
8255  XLogRecPtr last_important;
8256 
8257  /*
8258  * Need to take a lock to prevent torn reads of the LSN, which are
8259  * possible on some of the supported platforms. WAL insert locks only
8260  * support exclusive mode, so we have to use that.
8261  */
8263  last_important = WALInsertLocks[i].l.lastImportantAt;
8264  LWLockRelease(&WALInsertLocks[i].l.lock);
8265 
8266  if (res < last_important)
8267  res = last_important;
8268  }
8269 
8270  return res;
8271 }
#define InvalidXLogRecPtr
Definition: xlogdefs.h:28
XLogRecPtr lastImportantAt
Definition: xlog.c:482
#define NUM_XLOGINSERT_LOCKS
Definition: xlog.c:119
WALInsertLock l
Definition: xlog.c:494
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:716

◆ GetLatestXTime()

TimestampTz GetLatestXTime ( void  )

Definition at line 6064 of file xlog.c.

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

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

6065 {
6066  TimestampTz xtime;
6067 
6069  xtime = XLogCtl->recoveryLastXTime;
6071 
6072  return xtime;
6073 }
int64 TimestampTz
Definition: timestamp.h:39
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
TimestampTz recoveryLastXTime
Definition: xlog.c:694
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ GetMockAuthenticationNonce()

char* GetMockAuthenticationNonce ( void  )

Definition at line 4812 of file xlog.c.

References Assert, and ControlFileData::mock_authentication_nonce.

Referenced by scram_mock_salt().

4813 {
4814  Assert(ControlFile != NULL);
4816 }
char mock_authentication_nonce[MOCK_AUTH_NONCE_LEN]
Definition: pg_control.h:229
static ControlFileData * ControlFile
Definition: xlog.c:721
#define Assert(condition)
Definition: c.h:732

◆ GetRedoRecPtr()

XLogRecPtr GetRedoRecPtr ( void  )

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

8172 {
8173  XLogRecPtr ptr;
8174 
8175  /*
8176  * The possibly not up-to-date copy in XlogCtl is enough. Even if we
8177  * grabbed a WAL insertion lock to read the master copy, someone might
8178  * update it just after we've released the lock.
8179  */
8181  ptr = XLogCtl->RedoRecPtr;
8183 
8184  if (RedoRecPtr < ptr)
8185  RedoRecPtr = ptr;
8186 
8187  return RedoRecPtr;
8188 }
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
static XLogRecPtr RedoRecPtr
Definition: xlog.c:365
XLogRecPtr RedoRecPtr
Definition: xlog.c:594
#define SpinLockRelease(lock)
Definition: spin.h:64
uint64 XLogRecPtr
Definition: xlogdefs.h:21
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ GetSystemIdentifier()

uint64 GetSystemIdentifier ( void  )

Definition at line 4802 of file xlog.c.

References Assert, and ControlFileData::system_identifier.

Referenced by IdentifySystem(), and WalReceiverMain().

4803 {
4804  Assert(ControlFile != NULL);
4806 }
uint64 system_identifier
Definition: pg_control.h:106
static ControlFileData * ControlFile
Definition: xlog.c:721
#define Assert(condition)
Definition: c.h:732

◆ GetXLogInsertRecPtr()

XLogRecPtr GetXLogInsertRecPtr ( void  )

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

11150 {
11152  uint64 current_bytepos;
11153 
11154  SpinLockAcquire(&Insert->insertpos_lck);
11155  current_bytepos = Insert->CurrBytePos;
11156  SpinLockRelease(&Insert->insertpos_lck);
11157 
11158  return XLogBytePosToRecPtr(current_bytepos);
11159 }
slock_t insertpos_lck
Definition: xlog.c:532
static XLogRecPtr XLogBytePosToRecPtr(uint64 bytepos)
Definition: xlog.c:1959
XLogCtlInsert Insert
Definition: xlog.c:590
#define SpinLockAcquire(lock)
Definition: spin.h:62
uint64 CurrBytePos
Definition: xlog.c:541
static void Insert(File file)
Definition: fd.c:1061
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ GetXLogReceiptTime()

void GetXLogReceiptTime ( TimestampTz rtime,
bool fromStream 
)

Definition at line 6110 of file xlog.c.

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

Referenced by GetStandbyLimitTime().

6111 {
6112  /*
6113  * This must be executed in the startup process, since we don't export the
6114  * relevant state to shared memory.
6115  */
6116  Assert(InRecovery);
6117 
6118  *rtime = XLogReceiptTime;
6119  *fromStream = (XLogReceiptSource == XLOG_FROM_STREAM);
6120 }
static XLogSource XLogReceiptSource
Definition: xlog.c:822
bool InRecovery
Definition: xlog.c:200
static TimestampTz XLogReceiptTime
Definition: xlog.c:821
#define Assert(condition)
Definition: c.h:732

◆ GetXLogReplayRecPtr()

XLogRecPtr GetXLogReplayRecPtr ( TimeLineID replayTLI)

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

11131 {
11132  XLogRecPtr recptr;
11133  TimeLineID tli;
11134 
11136  recptr = XLogCtl->lastReplayedEndRecPtr;
11137  tli = XLogCtl->lastReplayedTLI;
11139 
11140  if (replayTLI)
11141  *replayTLI = tli;
11142  return recptr;
11143 }
uint32 TimeLineID
Definition: xlogdefs.h:52
slock_t info_lck
Definition: xlog.c:710
#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:713
TimeLineID lastReplayedTLI
Definition: xlog.c:690
XLogRecPtr lastReplayedEndRecPtr
Definition: xlog.c:689

◆ GetXLogWriteRecPtr()

XLogRecPtr GetXLogWriteRecPtr ( void  )

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

11166 {
11170 
11171  return LogwrtResult.Write;
11172 }
static XLogwrtResult LogwrtResult
Definition: xlog.c:757
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
XLogwrtResult LogwrtResult
Definition: xlog.c:613
#define SpinLockRelease(lock)
Definition: spin.h:64
static XLogCtlData * XLogCtl
Definition: xlog.c:713
XLogRecPtr Write
Definition: xlog.c:438

◆ HotStandbyActive()

bool HotStandbyActive ( void  )

Definition at line 7954 of file xlog.c.

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

Referenced by XLogWalRcvSendHSFeedback().

7955 {
7956  /*
7957  * We check shared state each time only until Hot Standby is active. We
7958  * can't de-activate Hot Standby, so there's no need to keep checking
7959  * after the shared variable has once been seen true.
7960  */
7962  return true;
7963  else
7964  {
7965  /* spinlock is essential on machines with weak memory ordering! */
7969 
7970  return LocalHotStandbyActive;
7971  }
7972 }
bool SharedHotStandbyActive
Definition: xlog.c:655
slock_t info_lck
Definition: xlog.c:710
#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:713

◆ HotStandbyActiveInReplay()

bool HotStandbyActiveInReplay ( void  )

Definition at line 7979 of file xlog.c.

References AmStartupProcess, Assert, IsPostmasterEnvironment, and LocalHotStandbyActive.

Referenced by btree_xlog_vacuum().

7980 {
7982  return LocalHotStandbyActive;
7983 }
#define AmStartupProcess()
Definition: miscadmin.h:412
bool IsPostmasterEnvironment
Definition: globals.c:108
static bool LocalHotStandbyActive
Definition: xlog.c:229
#define Assert(condition)
Definition: c.h:732

◆ InitXLOGAccess()

void InitXLOGAccess ( void  )

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

8146 {
8148 
8149  /* ThisTimeLineID doesn't change so we need no lock to copy it */
8152 
8153  /* set wal_segment_size */
8155 
8156  /* Use GetRedoRecPtr to copy the RedoRecPtr safely */
8157  (void) GetRedoRecPtr();
8158  /* Also update our copy of doPageWrites. */
8159  doPageWrites = (Insert->fullPageWrites || Insert->forcePageWrites);
8160 
8161  /* Also initialize the working areas for constructing WAL records */
8162  InitXLogInsert();
8163 }
int wal_segment_size
Definition: xlog.c:112
void InitXLogInsert(void)
Definition: xloginsert.c:1110
TimeLineID ThisTimeLineID
Definition: xlog.c:642
XLogCtlInsert Insert
Definition: xlog.c:590
bool fullPageWrites
Definition: xlog.c:565
uint32 xlog_seg_size
Definition: pg_control.h:209
static bool doPageWrites
Definition: xlog.c:372
bool forcePageWrites
Definition: xlog.c:564
static void Insert(File file)
Definition: fd.c:1061
static ControlFileData * ControlFile
Definition: xlog.c:721
TimeLineID ThisTimeLineID
Definition: xlog.c:187
#define Assert(condition)
Definition: c.h:732
static XLogCtlData * XLogCtl
Definition: xlog.c:713
XLogRecPtr GetRedoRecPtr(void)
Definition: xlog.c:8171
#define IsBootstrapProcessingMode()
Definition: miscadmin.h:374

◆ issue_xlog_fsync()

void issue_xlog_fsync ( int  fd,
XLogSegNo  segno 
)

Definition at line 10085 of file xlog.c.

References elog, ereport, errcode_for_file_access(), errmsg(), 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, and XLogFileNameP().

Referenced by XLogWalRcvFlush(), and XLogWrite().

10086 {
10088  switch (sync_method)
10089  {
10090  case SYNC_METHOD_FSYNC:
10091  if (pg_fsync_no_writethrough(fd) != 0)
10092  ereport(PANIC,
10094  errmsg("could not fsync file \"%s\": %m",
10095  XLogFileNameP(ThisTimeLineID, segno))));
10096  break;
10097 #ifdef HAVE_FSYNC_WRITETHROUGH
10099  if (pg_fsync_writethrough(fd) != 0)
10100  ereport(PANIC,
10102  errmsg("could not fsync write-through file \"%s\": %m",
10103  XLogFileNameP(ThisTimeLineID, segno))));
10104  break;
10105 #endif
10106 #ifdef HAVE_FDATASYNC
10107  case SYNC_METHOD_FDATASYNC:
10108  if (pg_fdatasync(fd) != 0)
10109  ereport(PANIC,
10111  errmsg("could not fdatasync file \"%s\": %m",
10112  XLogFileNameP(ThisTimeLineID, segno))));
10113  break;
10114 #endif
10115  case SYNC_METHOD_OPEN:
10117  /* write synced it already */
10118  break;
10119  default:
10120  elog(PANIC, "unrecognized wal_sync_method: %d", sync_method);
10121  break;
10122  }
10124 }
int pg_fdatasync(int fd)
Definition: fd.c:385
#define SYNC_METHOD_FSYNC_WRITETHROUGH
Definition: xlog.h:28
int pg_fsync_writethrough(int fd)
Definition: fd.c:362
int pg_fsync_no_writethrough(int fd)
Definition: fd.c:350
#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
char * XLogFileNameP(TimeLineID tli, XLogSegNo segno)
Definition: xlog.c:10130
int errcode_for_file_access(void)
Definition: elog.c:593
#define SYNC_METHOD_FSYNC
Definition: xlog.h:25
static void pgstat_report_wait_end(void)
Definition: pgstat.h:1342
#define ereport(elevel, rest)
Definition: elog.h:141
#define SYNC_METHOD_OPEN
Definition: xlog.h:27
TimeLineID ThisTimeLineID
Definition: xlog.c:187
static void pgstat_report_wait_start(uint32 wait_event_info)
Definition: pgstat.h:1318
int sync_method
Definition: xlog.c:102
#define SYNC_METHOD_FDATASYNC
Definition: xlog.h:26
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226

◆ LocalProcessControlFile()

void LocalProcessControlFile ( bool  reset)

Definition at line 4922 of file xlog.c.

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

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

4923 {
4924  Assert(reset || ControlFile == NULL);
4925  ControlFile = palloc(sizeof(ControlFileData));
4926  ReadControlFile();
4927 }
void reset(void)
Definition: sql-declare.c:577
static void ReadControlFile(void)
Definition: xlog.c:4577
static ControlFileData * ControlFile
Definition: xlog.c:721
#define Assert(condition)
Definition: c.h:732
void * palloc(Size size)
Definition: mcxt.c:924

◆ RecoveryInProgress()

bool RecoveryInProgress ( void  )

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

7899 {
7900  /*
7901  * We check shared state each time only until we leave recovery mode. We
7902  * can't re-enter recovery, so there's no need to keep checking after the
7903  * shared variable has once been seen false.
7904  */
7906  return false;
7907  else
7908  {
7909  /*
7910  * use volatile pointer to make sure we make a fresh read of the
7911  * shared variable.
7912  */
7913  volatile XLogCtlData *xlogctl = XLogCtl;
7914 
7916 
7917  /*
7918  * Initialize TimeLineID and RedoRecPtr when we discover that recovery
7919  * is finished. InitPostgres() relies upon this behaviour to ensure
7920  * that InitXLOGAccess() is called at backend startup. (If you change
7921  * this, see also LocalSetXLogInsertAllowed.)
7922  */
7924  {
7925  /*
7926  * If we just exited recovery, make sure we read TimeLineID and
7927  * RedoRecPtr after SharedRecoveryInProgress (for machines with
7928  * weak memory ordering).
7929  */
7931  InitXLOGAccess();
7932  }
7933 
7934  /*
7935  * Note: We don't need a memory barrier when we're still in recovery.
7936  * We might exit recovery immediately after return, so the caller
7937  * can't rely on 'true' meaning that we're still in recovery anyway.
7938  */
7939 
7940  return LocalRecoveryInProgress;
7941  }
7942 }
void InitXLOGAccess(void)
Definition: xlog.c:8145
bool SharedRecoveryInProgress
Definition: xlog.c:649
#define pg_memory_barrier()
Definition: atomics.h:148
static XLogCtlData * XLogCtl
Definition: xlog.c:713
static bool LocalRecoveryInProgress
Definition: xlog.c:223

◆ RecoveryIsPaused()

bool RecoveryIsPaused ( void  )

Definition at line 5930 of file xlog.c.

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

Referenced by pg_is_wal_replay_paused(), and recoveryPausesHere().

5931 {
5932  bool recoveryPause;
5933 
5935  recoveryPause = XLogCtl->recoveryPause;
5937 
5938  return recoveryPause;
5939 }
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
bool recoveryPause
Definition: xlog.c:702
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ RemovePromoteSignalFiles()

void RemovePromoteSignalFiles ( void  )

Definition at line 12198 of file xlog.c.

References FALLBACK_PROMOTE_SIGNAL_FILE, and PROMOTE_SIGNAL_FILE.

Referenced by PostmasterMain().

12199 {
12200  unlink(PROMOTE_SIGNAL_FILE);
12202 }
#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 5942 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().

5943 {
5945  XLogCtl->recoveryPause = recoveryPause;
5947 }
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
bool recoveryPause
Definition: xlog.c:702
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ SetWalWriterSleeping()

void SetWalWriterSleeping ( bool  sleeping)

Definition at line 12234 of file xlog.c.

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

Referenced by WalWriterMain().

12235 {
12237  XLogCtl->WalWriterSleeping = sleeping;
12239 }
slock_t info_lck
Definition: xlog.c:710
#define SpinLockAcquire(lock)
Definition: spin.h:62
#define SpinLockRelease(lock)
Definition: spin.h:64
bool WalWriterSleeping
Definition: xlog.c:662
static XLogCtlData * XLogCtl
Definition: xlog.c:713

◆ ShutdownXLOG()

void ShutdownXLOG ( int  code,
Datum  arg 
)

Definition at line 8294 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 CheckpointerMain(), and InitPostgres().

8295 {
8296  /*
8297  * We should have an aux process resource owner to use, and we should not
8298  * be in a transaction that's installed some other resowner.
8299  */
8301  Assert(CurrentResourceOwner == NULL ||
8304 
8305  /* Don't be chatty in standalone mode */
8307  (errmsg("shutting down")));
8308 
8309  /*
8310  * Signal walsenders to move to stopping state.
8311  */
8313 
8314  /*
8315  * Wait for WAL senders to be in stopping state. This prevents commands
8316  * from writing new WAL.
8317  */
8319 
8320  if (RecoveryInProgress())
8322  else
8323  {
8324  /*
8325  * If archiving is enabled, rotate the last XLOG file so that all the
8326  * remaining records are archived (postmaster wakes up the archiver
8327  * process one more time at the end of shutdown). The checkpoint
8328  * record will go to the next XLOG file and won't be archived (yet).
8329  */
8331  RequestXLogSwitch(false);
8332 
8334  }
8335  ShutdownCLOG();
8336  ShutdownCommitTs();
8337  ShutdownSUBTRANS();
8339 }
bool IsPostmasterEnvironment
Definition: globals.c:108
XLogRecPtr RequestXLogSwitch(bool mark_unimportant)
Definition: xlog.c:9377
void ShutdownSUBTRANS(void)
Definition: subtrans.c:285
void CreateCheckPoint(int flags)
Definition: xlog.c:8510
ResourceOwner CurrentResourceOwner
Definition: resowner.c:142
void ShutdownCLOG(void)
Definition: clog.c:823
bool CreateRestartPoint(int flags)
Definition: xlog.c:9050
#define XLogArchiveCommandSet()
Definition: xlog.h:175
#define LOG
Definition: elog.h:26
bool RecoveryInProgress(void)
Definition: xlog.c:7898
ResourceOwner AuxProcessResourceOwner
Definition: resowner.c:145
void WalSndWaitStopping(void)
Definition: walsender.c:3139
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:3113
void ShutdownCommitTs(void)
Definition: commit_ts.c:744
#define Assert(condition)
Definition: c.h:732
#define XLogArchivingActive()
Definition: xlog.h:170
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define CHECKPOINT_IMMEDIATE
Definition: xlog.h:214
#define CHECKPOINT_IS_SHUTDOWN
Definition: xlog.h:211

◆ StartupXLOG()

void StartupXLOG ( void  )

Definition at line 6195 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(), 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, XLogReaderState::readPageTLI, 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, 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(), 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, 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().

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