xlog.c 202.9 KB
Newer Older
1
/*-------------------------------------------------------------------------
2 3
 *
 * xlog.c
4
 *		PostgreSQL transaction log manager
5 6
 *
 *
7
 * Portions Copyright (c) 1996-2007, PostgreSQL Global Development Group
B
Add:  
Bruce Momjian 已提交
8
 * Portions Copyright (c) 1994, Regents of the University of California
9
 *
10
 * $PostgreSQL: pgsql/src/backend/access/transam/xlog.c,v 1.276 2007/08/01 22:45:08 tgl Exp $
11 12 13
 *
 *-------------------------------------------------------------------------
 */
14

15 16
#include "postgres.h"

17
#include <ctype.h>
18
#include <fcntl.h>
T
Tom Lane 已提交
19
#include <signal.h>
20
#include <time.h>
21
#include <sys/stat.h>
22
#include <sys/time.h>
23 24
#include <sys/wait.h>
#include <unistd.h>
25

26
#include "access/clog.h"
27
#include "access/heapam.h"
28
#include "access/multixact.h"
29
#include "access/subtrans.h"
30
#include "access/transam.h"
31
#include "access/tuptoaster.h"
32
#include "access/twophase.h"
33
#include "access/xact.h"
34
#include "access/xlog_internal.h"
35
#include "access/xlogdefs.h"
36
#include "access/xlogutils.h"
37
#include "catalog/catversion.h"
T
Tom Lane 已提交
38
#include "catalog/pg_control.h"
39 40
#include "catalog/pg_type.h"
#include "funcapi.h"
41
#include "miscadmin.h"
42
#include "pgstat.h"
43
#include "postmaster/bgwriter.h"
44
#include "storage/bufpage.h"
45
#include "storage/fd.h"
46
#include "storage/pmsignal.h"
47
#include "storage/procarray.h"
48
#include "storage/spin.h"
49
#include "utils/builtins.h"
50
#include "utils/pg_locale.h"
V
WAL  
Vadim B. Mikheev 已提交
51

52

53

54 55
/* File path names (all relative to $PGDATA) */
#define BACKUP_LABEL_FILE		"backup_label"
56
#define BACKUP_LABEL_OLD		"backup_label.old"
57 58 59 60
#define RECOVERY_COMMAND_FILE	"recovery.conf"
#define RECOVERY_COMMAND_DONE	"recovery.done"


T
Tom Lane 已提交
61 62
/* User-settable parameters */
int			CheckPointSegments = 3;
V
Vadim B. Mikheev 已提交
63
int			XLOGbuffers = 8;
64
int			XLogArchiveTimeout = 0;
65
char	   *XLogArchiveCommand = NULL;
66 67
char	   *XLOG_sync_method = NULL;
const char	XLOG_sync_method_default[] = DEFAULT_SYNC_METHOD_STR;
68
bool		fullPageWrites = true;
69
bool		log_checkpoints = false;
T
Tom Lane 已提交
70

71 72 73 74
#ifdef WAL_DEBUG
bool		XLOG_DEBUG = false;
#endif

75
/*
76 77 78 79 80 81 82 83 84
 * XLOGfileslop is the maximum number of preallocated future XLOG segments.
 * When we are done with an old XLOG segment file, we will recycle it as a
 * future XLOG segment as long as there aren't already XLOGfileslop future
 * segments; else we'll delete it.  This could be made a separate GUC
 * variable, but at present I think it's sufficient to hardwire it as
 * 2*CheckPointSegments+1.  Under normal conditions, a checkpoint will free
 * no more than 2*CheckPointSegments log segments, and we want to recycle all
 * of them; the +1 allows boundary cases to happen without wasting a
 * delete/create-segment cycle.
85 86 87 88
 */
#define XLOGfileslop	(2*CheckPointSegments + 1)


89
/* these are derived from XLOG_sync_method by assign_xlog_sync_method */
B
Bruce Momjian 已提交
90
int			sync_method = DEFAULT_SYNC_METHOD;
91 92 93 94
static int	open_sync_bit = DEFAULT_SYNC_FLAGBIT;

#define XLOG_SYNC_BIT  (enableFsync ? open_sync_bit : 0)

T
Tom Lane 已提交
95

96 97 98 99 100 101 102
/*
 * Statistics for current checkpoint are collected in this global struct.
 * Because only the background writer or a stand-alone backend can perform
 * checkpoints, this will be unused in normal backends.
 */
CheckpointStatsData CheckpointStats;

T
Tom Lane 已提交
103
/*
104 105
 * ThisTimeLineID will be same in all backends --- it identifies current
 * WAL timeline for the database system.
T
Tom Lane 已提交
106
 */
107
TimeLineID	ThisTimeLineID = 0;
V
WAL  
Vadim B. Mikheev 已提交
108

109
/* Are we doing recovery from XLOG? */
T
Tom Lane 已提交
110
bool		InRecovery = false;
B
Bruce Momjian 已提交
111

112
/* Are we recovering using offline XLOG archives? */
B
Bruce Momjian 已提交
113 114
static bool InArchiveRecovery = false;

115
/* Was the last xlog file restored from archive, or local? */
B
Bruce Momjian 已提交
116
static bool restoredFromArchive = false;
117

118 119
/* options taken from recovery.conf */
static char *recoveryRestoreCommand = NULL;
120 121 122
static bool recoveryTarget = false;
static bool recoveryTargetExact = false;
static bool recoveryTargetInclusive = true;
B
Bruce Momjian 已提交
123
static TransactionId recoveryTargetXid;
124
static TimestampTz recoveryTargetTime;
125

126
/* if recoveryStopsHere returns true, it saves actual stop xid/time here */
B
Bruce Momjian 已提交
127
static TransactionId recoveryStopXid;
128
static TimestampTz recoveryStopTime;
B
Bruce Momjian 已提交
129
static bool recoveryStopAfter;
130 131 132 133 134 135 136 137 138 139 140 141 142

/*
 * During normal operation, the only timeline we care about is ThisTimeLineID.
 * During recovery, however, things are more complicated.  To simplify life
 * for rmgr code, we keep ThisTimeLineID set to the "current" timeline as we
 * scan through the WAL history (that is, it is the line that was active when
 * the currently-scanned WAL record was generated).  We also need these
 * timeline values:
 *
 * recoveryTargetTLI: the desired timeline that we want to end in.
 *
 * expectedTLIs: an integer list of recoveryTargetTLI and the TLIs of
 * its known parents, newest first (so recoveryTargetTLI is always the
B
Bruce Momjian 已提交
143
 * first list member).	Only these TLIs are expected to be seen in the WAL
144 145 146 147 148 149 150 151 152
 * segments we read, and indeed only these TLIs will be considered as
 * candidate WAL files to open at all.
 *
 * curFileTLI: the TLI appearing in the name of the current input WAL file.
 * (This is not necessarily the same as ThisTimeLineID, because we could
 * be scanning data that was copied from an ancestor timeline when the current
 * file was created.)  During a sequential scan we do not allow this value
 * to decrease.
 */
B
Bruce Momjian 已提交
153 154 155
static TimeLineID recoveryTargetTLI;
static List *expectedTLIs;
static TimeLineID curFileTLI;
156

T
Tom Lane 已提交
157 158
/*
 * MyLastRecPtr points to the start of the last XLOG record inserted by the
159 160
 * current transaction.  If MyLastRecPtr.xrecoff == 0, then the current
 * xact hasn't yet inserted any transaction-controlled XLOG records.
T
Tom Lane 已提交
161 162
 *
 * Note that XLOG records inserted outside transaction control are not
163
 * reflected into MyLastRecPtr.  They do, however, cause MyXactMadeXLogEntry
B
Bruce Momjian 已提交
164
 * to be set true.	The latter can be used to test whether the current xact
165 166
 * made any loggable changes (including out-of-xact changes, such as
 * sequence updates).
167 168 169
 *
 * When we insert/update/delete a tuple in a temporary relation, we do not
 * make any XLOG record, since we don't care about recovering the state of
B
Bruce Momjian 已提交
170
 * the temp rel after a crash.	However, we will still need to remember
171 172 173
 * whether our transaction committed or aborted in that case.  So, we must
 * set MyXactMadeTempRelUpdate true to indicate that the XID will be of
 * interest later.
T
Tom Lane 已提交
174 175
 */
XLogRecPtr	MyLastRecPtr = {0, 0};
V
Vadim B. Mikheev 已提交
176

177 178
bool		MyXactMadeXLogEntry = false;

179 180
bool		MyXactMadeTempRelUpdate = false;

T
Tom Lane 已提交
181 182 183
/*
 * ProcLastRecPtr points to the start of the last XLOG record inserted by the
 * current backend.  It is updated for all inserts, transaction-controlled
B
Bruce Momjian 已提交
184
 * or not.	ProcLastRecEnd is similar but points to end+1 of last record.
T
Tom Lane 已提交
185 186
 */
static XLogRecPtr ProcLastRecPtr = {0, 0};
187

188 189
XLogRecPtr	ProcLastRecEnd = {0, 0};

T
Tom Lane 已提交
190 191 192
/*
 * RedoRecPtr is this backend's local copy of the REDO record pointer
 * (which is almost but not quite the same as a pointer to the most recent
B
Bruce Momjian 已提交
193
 * CHECKPOINT record).	We update this from the shared-memory copy,
T
Tom Lane 已提交
194
 * XLogCtl->Insert.RedoRecPtr, whenever we can safely do so (ie, when we
B
Bruce Momjian 已提交
195
 * hold the Insert lock).  See XLogInsert for details.	We are also allowed
196
 * to update from XLogCtl->Insert.RedoRecPtr if we hold the info_lck;
197 198
 * see GetRedoRecPtr.  A freshly spawned backend obtains the value during
 * InitXLOGAccess.
T
Tom Lane 已提交
199
 */
200
static XLogRecPtr RedoRecPtr;
201

T
Tom Lane 已提交
202 203 204 205 206 207 208 209 210
/*----------
 * Shared-memory data structures for XLOG control
 *
 * LogwrtRqst indicates a byte position that we need to write and/or fsync
 * the log up to (all records before that point must be written or fsynced).
 * LogwrtResult indicates the byte positions we have already written/fsynced.
 * These structs are identical but are declared separately to indicate their
 * slightly different functions.
 *
211
 * We do a lot of pushups to minimize the amount of access to lockable
T
Tom Lane 已提交
212 213 214
 * shared memory values.  There are actually three shared-memory copies of
 * LogwrtResult, plus one unshared copy in each backend.  Here's how it works:
 *		XLogCtl->LogwrtResult is protected by info_lck
215 216 217 218
 *		XLogCtl->Write.LogwrtResult is protected by WALWriteLock
 *		XLogCtl->Insert.LogwrtResult is protected by WALInsertLock
 * One must hold the associated lock to read or write any of these, but
 * of course no lock is needed to read/write the unshared LogwrtResult.
T
Tom Lane 已提交
219 220 221
 *
 * XLogCtl->LogwrtResult and XLogCtl->Write.LogwrtResult are both "always
 * right", since both are updated by a write or flush operation before
222 223
 * it releases WALWriteLock.  The point of keeping XLogCtl->Write.LogwrtResult
 * is that it can be examined/modified by code that already holds WALWriteLock
T
Tom Lane 已提交
224 225 226
 * without needing to grab info_lck as well.
 *
 * XLogCtl->Insert.LogwrtResult may lag behind the reality of the other two,
B
Bruce Momjian 已提交
227
 * but is updated when convenient.	Again, it exists for the convenience of
228
 * code that is already holding WALInsertLock but not the other locks.
T
Tom Lane 已提交
229 230 231 232 233 234 235 236 237 238
 *
 * The unshared LogwrtResult may lag behind any or all of these, and again
 * is updated when convenient.
 *
 * The request bookkeeping is simpler: there is a shared XLogCtl->LogwrtRqst
 * (protected by info_lck), but we don't need to cache any copies of it.
 *
 * Note that this all works because the request and result positions can only
 * advance forward, never back up, and so we can easily determine which of two
 * values is "more up to date".
239 240 241 242 243 244 245 246 247 248 249 250 251 252
 *
 * info_lck is only held long enough to read/update the protected variables,
 * so it's a plain spinlock.  The other locks are held longer (potentially
 * over I/O operations), so we use LWLocks for them.  These locks are:
 *
 * WALInsertLock: must be held to insert a record into the WAL buffers.
 *
 * WALWriteLock: must be held to write WAL buffers to disk (XLogWrite or
 * XLogFlush).
 *
 * ControlFileLock: must be held to read/update control file or create
 * new log file.
 *
 * CheckpointLock: must be held to do a checkpoint (ensures only one
253 254
 * checkpointer at a time; currently, with all checkpoints done by the
 * bgwriter, this is just pro forma).
255
 *
T
Tom Lane 已提交
256 257
 *----------
 */
258

T
Tom Lane 已提交
259
typedef struct XLogwrtRqst
260
{
T
Tom Lane 已提交
261 262
	XLogRecPtr	Write;			/* last byte + 1 to write out */
	XLogRecPtr	Flush;			/* last byte + 1 to flush */
263
} XLogwrtRqst;
264

265 266 267 268 269 270
typedef struct XLogwrtResult
{
	XLogRecPtr	Write;			/* last byte + 1 written out */
	XLogRecPtr	Flush;			/* last byte + 1 flushed */
} XLogwrtResult;

T
Tom Lane 已提交
271 272 273
/*
 * Shared state data for XLogInsert.
 */
274 275
typedef struct XLogCtlInsert
{
B
Bruce Momjian 已提交
276 277
	XLogwrtResult LogwrtResult; /* a recent value of LogwrtResult */
	XLogRecPtr	PrevRecord;		/* start of previously-inserted record */
278
	int			curridx;		/* current block index in cache */
B
Bruce Momjian 已提交
279 280 281
	XLogPageHeader currpage;	/* points to header of block in cache */
	char	   *currpos;		/* current insertion point in cache */
	XLogRecPtr	RedoRecPtr;		/* current redo point for insertions */
282
	bool		forcePageWrites;	/* forcing full-page writes for PITR? */
283 284
} XLogCtlInsert;

T
Tom Lane 已提交
285 286 287
/*
 * Shared state data for XLogWrite/XLogFlush.
 */
288 289
typedef struct XLogCtlWrite
{
B
Bruce Momjian 已提交
290 291 292
	XLogwrtResult LogwrtResult; /* current value of LogwrtResult */
	int			curridx;		/* cache index of next block to write */
	time_t		lastSegSwitchTime;		/* time of last xlog segment switch */
293 294
} XLogCtlWrite;

T
Tom Lane 已提交
295 296 297
/*
 * Total shared-memory state for XLOG.
 */
298 299
typedef struct XLogCtlData
{
300
	/* Protected by WALInsertLock: */
B
Bruce Momjian 已提交
301
	XLogCtlInsert Insert;
302

T
Tom Lane 已提交
303
	/* Protected by info_lck: */
B
Bruce Momjian 已提交
304 305
	XLogwrtRqst LogwrtRqst;
	XLogwrtResult LogwrtResult;
306 307
	uint32		ckptXidEpoch;	/* nextXID & epoch of latest checkpoint */
	TransactionId ckptXid;
308
	XLogRecPtr	asyncCommitLSN;	/* LSN of newest async commit */
309

310
	/* Protected by WALWriteLock: */
B
Bruce Momjian 已提交
311 312
	XLogCtlWrite Write;

T
Tom Lane 已提交
313
	/*
B
Bruce Momjian 已提交
314 315 316
	 * These values do not change after startup, although the pointed-to pages
	 * and xlblocks values certainly do.  Permission to read/write the pages
	 * and xlblocks values depends on WALInsertLock and WALWriteLock.
T
Tom Lane 已提交
317
	 */
B
Bruce Momjian 已提交
318
	char	   *pages;			/* buffers for unwritten XLOG pages */
319
	XLogRecPtr *xlblocks;		/* 1st byte ptr-s + XLOG_BLCKSZ */
320 321
	Size		XLogCacheByte;	/* # bytes in xlog buffers */
	int			XLogCacheBlck;	/* highest allocated xlog buffer index */
322
	TimeLineID	ThisTimeLineID;
T
Tom Lane 已提交
323

324
	slock_t		info_lck;		/* locks shared variables shown above */
325 326
} XLogCtlData;

327
static XLogCtlData *XLogCtl = NULL;
328

329
/*
T
Tom Lane 已提交
330
 * We maintain an image of pg_control in shared memory.
331
 */
332
static ControlFileData *ControlFile = NULL;
333

T
Tom Lane 已提交
334 335 336 337 338
/*
 * Macros for managing XLogInsert state.  In most cases, the calling routine
 * has local copies of XLogCtl->Insert and/or XLogCtl->Insert->curridx,
 * so these are passed as parameters instead of being fetched via XLogCtl.
 */
339

T
Tom Lane 已提交
340 341
/* Free space remaining in the current xlog page buffer */
#define INSERT_FREESPACE(Insert)  \
342
	(XLOG_BLCKSZ - ((Insert)->currpos - (char *) (Insert)->currpage))
T
Tom Lane 已提交
343 344 345 346 347 348

/* Construct XLogRecPtr value for current insertion point */
#define INSERT_RECPTR(recptr,Insert,curridx)  \
	( \
	  (recptr).xlogid = XLogCtl->xlblocks[curridx].xlogid, \
	  (recptr).xrecoff = \
B
Bruce Momjian 已提交
349
		XLogCtl->xlblocks[curridx].xrecoff - INSERT_FREESPACE(Insert) \
T
Tom Lane 已提交
350 351 352 353 354 355 356
	)

#define PrevBufIdx(idx)		\
		(((idx) == 0) ? XLogCtl->XLogCacheBlck : ((idx) - 1))

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

T
Tom Lane 已提交
358 359 360 361
/*
 * Private, possibly out-of-date copy of shared LogwrtResult.
 * See discussion above.
 */
362
static XLogwrtResult LogwrtResult = {{0, 0}, {0, 0}};
363

T
Tom Lane 已提交
364 365 366 367 368 369 370 371 372 373
/*
 * openLogFile is -1 or a kernel FD for an open log file segment.
 * When it's open, openLogOff is the current seek offset in the file.
 * openLogId/openLogSeg identify the segment.  These variables are only
 * used to write the XLOG, and so will normally refer to the active segment.
 */
static int	openLogFile = -1;
static uint32 openLogId = 0;
static uint32 openLogSeg = 0;
static uint32 openLogOff = 0;
374

T
Tom Lane 已提交
375 376 377 378 379 380
/*
 * These variables are used similarly to the ones above, but for reading
 * the XLOG.  Note, however, that readOff generally represents the offset
 * of the page just read, not the seek position of the FD itself, which
 * will be just past that page.
 */
381 382 383 384
static int	readFile = -1;
static uint32 readId = 0;
static uint32 readSeg = 0;
static uint32 readOff = 0;
B
Bruce Momjian 已提交
385

386
/* Buffer for currently read page (XLOG_BLCKSZ bytes) */
T
Tom Lane 已提交
387
static char *readBuf = NULL;
B
Bruce Momjian 已提交
388

389 390 391 392
/* Buffer for current ReadRecord result (expandable) */
static char *readRecordBuf = NULL;
static uint32 readRecordBufSize = 0;

T
Tom Lane 已提交
393
/* State information for XLOG reading */
B
Bruce Momjian 已提交
394 395
static XLogRecPtr ReadRecPtr;	/* start of last record read */
static XLogRecPtr EndRecPtr;	/* end+1 of last record read */
396
static XLogRecord *nextRecord = NULL;
397
static TimeLineID lastPageTLI = 0;
398

V
WAL  
Vadim B. Mikheev 已提交
399 400
static bool InRedo = false;

401

402 403
static void XLogArchiveNotify(const char *xlog);
static void XLogArchiveNotifySeg(uint32 log, uint32 seg);
404
static bool XLogArchiveCheckDone(const char *xlog);
405 406
static void XLogArchiveCleanup(const char *xlog);
static void readRecoveryCommandFile(void);
407
static void exitArchiveRecovery(TimeLineID endTLI,
B
Bruce Momjian 已提交
408
					uint32 endLogId, uint32 endLogSeg);
409
static bool recoveryStopsHere(XLogRecord *record, bool *includeThis);
410
static void CheckPointGuts(XLogRecPtr checkPointRedo, int flags);
T
Tom Lane 已提交
411

412
static bool XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
B
Bruce Momjian 已提交
413
				XLogRecPtr *lsn, BkpBlock *bkpb);
414 415
static bool AdvanceXLInsertBuffer(bool new_segment);
static void XLogWrite(XLogwrtRqst WriteRqst, bool flexible, bool xlog_switch);
B
Bruce Momjian 已提交
416 417
static int XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock);
418 419
static bool InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
420
					   bool use_lock);
421 422
static int	XLogFileOpen(uint32 log, uint32 seg);
static int	XLogFileRead(uint32 log, uint32 seg, int emode);
B
Bruce Momjian 已提交
423
static void XLogFileClose(void);
424
static bool RestoreArchivedFile(char *path, const char *xlogfname,
B
Bruce Momjian 已提交
425
					const char *recovername, off_t expectedSize);
426 427
static void PreallocXlogFiles(XLogRecPtr endptr);
static void RemoveOldXlogFiles(uint32 log, uint32 seg, XLogRecPtr endptr);
428
static void CleanupBackupHistory(void);
429
static XLogRecord *ReadRecord(XLogRecPtr *RecPtr, int emode);
430
static bool ValidXLOGHeader(XLogPageHeader hdr, int emode);
431
static XLogRecord *ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt);
432 433 434 435
static List *readTimeLineHistory(TimeLineID targetTLI);
static bool existsTimeLineHistory(TimeLineID probeTLI);
static TimeLineID findNewestTimeLine(TimeLineID startTLI);
static void writeTimeLineHistory(TimeLineID newTLI, TimeLineID parentTLI,
B
Bruce Momjian 已提交
436 437
					 TimeLineID endTLI,
					 uint32 endLogId, uint32 endLogSeg);
T
Tom Lane 已提交
438 439 440
static void WriteControlFile(void);
static void ReadControlFile(void);
static char *str_time(time_t tnow);
441
static void issue_xlog_fsync(void);
B
Bruce Momjian 已提交
442

443
#ifdef WAL_DEBUG
444
static void xlog_outrec(StringInfo buf, XLogRecord *record);
445
#endif
446
static bool read_backup_label(XLogRecPtr *checkPointLoc,
B
Bruce Momjian 已提交
447
				  XLogRecPtr *minRecoveryLoc);
448
static void rm_redo_error_callback(void *arg);
T
Tom Lane 已提交
449 450 451 452 453


/*
 * Insert an XLOG record having the specified RMID and info bytes,
 * with the body of the record being the data chunk(s) described by
454
 * the rdata chain (see xlog.h for notes about rdata).
T
Tom Lane 已提交
455 456 457 458 459 460 461 462 463 464 465
 *
 * Returns XLOG pointer to end of record (beginning of next record).
 * This can be used as LSN for data pages affected by the logged action.
 * (LSN is the XLOG point up to which the XLOG must be flushed to disk
 * before the data page can be written out.  This implements the basic
 * WAL rule "write the log before the data".)
 *
 * NB: this routine feels free to scribble on the XLogRecData structs,
 * though not on the data they reference.  This is OK since the XLogRecData
 * structs are always just temporaries in the calling code.
 */
466
XLogRecPtr
467
XLogInsert(RmgrId rmid, uint8 info, XLogRecData *rdata)
468
{
B
Bruce Momjian 已提交
469 470
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogRecord *record;
T
Tom Lane 已提交
471
	XLogContRecord *contrecord;
B
Bruce Momjian 已提交
472 473 474
	XLogRecPtr	RecPtr;
	XLogRecPtr	WriteRqst;
	uint32		freespace;
475
	int			curridx;
B
Bruce Momjian 已提交
476 477 478 479 480
	XLogRecData *rdt;
	Buffer		dtbuf[XLR_MAX_BKP_BLOCKS];
	bool		dtbuf_bkp[XLR_MAX_BKP_BLOCKS];
	BkpBlock	dtbuf_xlg[XLR_MAX_BKP_BLOCKS];
	XLogRecPtr	dtbuf_lsn[XLR_MAX_BKP_BLOCKS];
481 482 483 484
	XLogRecData dtbuf_rdt1[XLR_MAX_BKP_BLOCKS];
	XLogRecData dtbuf_rdt2[XLR_MAX_BKP_BLOCKS];
	XLogRecData dtbuf_rdt3[XLR_MAX_BKP_BLOCKS];
	pg_crc32	rdata_crc;
B
Bruce Momjian 已提交
485 486 487 488
	uint32		len,
				write_len;
	unsigned	i;
	bool		updrqst;
489
	bool		doPageWrites;
490 491
	bool		isLogSwitch = (rmid == RM_XLOG_ID && info == XLOG_SWITCH);
	bool		no_tran = (rmid == RM_XLOG_ID);
V
Vadim B. Mikheev 已提交
492 493 494 495

	if (info & XLR_INFO_MASK)
	{
		if ((info & XLR_INFO_MASK) != XLOG_NO_TRAN)
496
			elog(PANIC, "invalid xlog info mask %02X", (info & XLR_INFO_MASK));
V
Vadim B. Mikheev 已提交
497 498 499 500
		no_tran = true;
		info &= ~XLR_INFO_MASK;
	}

T
Tom Lane 已提交
501
	/*
B
Bruce Momjian 已提交
502 503
	 * In bootstrap mode, we don't actually log anything but XLOG resources;
	 * return a phony record pointer.
T
Tom Lane 已提交
504
	 */
V
Vadim B. Mikheev 已提交
505
	if (IsBootstrapProcessingMode() && rmid != RM_XLOG_ID)
V
WAL  
Vadim B. Mikheev 已提交
506 507
	{
		RecPtr.xlogid = 0;
B
Bruce Momjian 已提交
508
		RecPtr.xrecoff = SizeOfXLogLongPHD;		/* start of 1st chkpt record */
509
		return RecPtr;
V
WAL  
Vadim B. Mikheev 已提交
510 511
	}

T
Tom Lane 已提交
512
	/*
513
	 * Here we scan the rdata chain, determine which buffers must be backed
T
Tom Lane 已提交
514
	 * up, and compute the CRC values for the data.  Note that the record
B
Bruce Momjian 已提交
515 516 517 518
	 * header isn't added into the CRC initially since we don't know the final
	 * length or info bits quite yet.  Thus, the CRC will represent the CRC of
	 * the whole record in the order "rdata, then backup blocks, then record
	 * header".
T
Tom Lane 已提交
519
	 *
520 521 522 523 524
	 * We may have to loop back to here if a race condition is detected below.
	 * We could prevent the race by doing all this work while holding the
	 * insert lock, but it seems better to avoid doing CRC calculations while
	 * holding the lock.  This means we have to be careful about modifying the
	 * rdata chain until we know we aren't going to loop back again.  The only
B
Bruce Momjian 已提交
525 526 527 528 529
	 * change we allow ourselves to make earlier is to set rdt->data = NULL in
	 * chain items we have decided we will have to back up the whole buffer
	 * for.  This is OK because we will certainly decide the same thing again
	 * for those items if we do it over; doing it here saves an extra pass
	 * over the chain later.
T
Tom Lane 已提交
530
	 */
531
begin:;
T
Tom Lane 已提交
532 533 534 535 536 537
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
	{
		dtbuf[i] = InvalidBuffer;
		dtbuf_bkp[i] = false;
	}

538 539 540 541 542 543 544 545
	/*
	 * Decide if we need to do full-page writes in this XLOG record: true if
	 * full_page_writes is on or we have a PITR request for it.  Since we
	 * don't yet have the insert lock, forcePageWrites could change under us,
	 * but we'll recheck it once we have the lock.
	 */
	doPageWrites = fullPageWrites || Insert->forcePageWrites;

546
	INIT_CRC32(rdata_crc);
T
Tom Lane 已提交
547
	len = 0;
B
Bruce Momjian 已提交
548
	for (rdt = rdata;;)
549 550 551
	{
		if (rdt->buffer == InvalidBuffer)
		{
T
Tom Lane 已提交
552
			/* Simple data, just include it */
553
			len += rdt->len;
554
			COMP_CRC32(rdata_crc, rdt->data, rdt->len);
555
		}
T
Tom Lane 已提交
556
		else
557
		{
T
Tom Lane 已提交
558 559
			/* Find info for buffer */
			for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
560
			{
T
Tom Lane 已提交
561
				if (rdt->buffer == dtbuf[i])
562
				{
563
					/* Buffer already referenced by earlier chain item */
T
Tom Lane 已提交
564 565 566 567 568
					if (dtbuf_bkp[i])
						rdt->data = NULL;
					else if (rdt->data)
					{
						len += rdt->len;
569
						COMP_CRC32(rdata_crc, rdt->data, rdt->len);
T
Tom Lane 已提交
570 571
					}
					break;
572
				}
T
Tom Lane 已提交
573
				if (dtbuf[i] == InvalidBuffer)
574
				{
T
Tom Lane 已提交
575 576
					/* OK, put it in this slot */
					dtbuf[i] = rdt->buffer;
577 578
					if (XLogCheckBuffer(rdt, doPageWrites,
										&(dtbuf_lsn[i]), &(dtbuf_xlg[i])))
T
Tom Lane 已提交
579 580 581 582 583 584 585
					{
						dtbuf_bkp[i] = true;
						rdt->data = NULL;
					}
					else if (rdt->data)
					{
						len += rdt->len;
586
						COMP_CRC32(rdata_crc, rdt->data, rdt->len);
T
Tom Lane 已提交
587 588
					}
					break;
589 590
				}
			}
T
Tom Lane 已提交
591
			if (i >= XLR_MAX_BKP_BLOCKS)
592
				elog(PANIC, "can backup at most %d blocks per xlog record",
T
Tom Lane 已提交
593
					 XLR_MAX_BKP_BLOCKS);
594
		}
595
		/* Break out of loop when rdt points to last chain item */
596 597 598 599 600
		if (rdt->next == NULL)
			break;
		rdt = rdt->next;
	}

601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
	/*
	 * Now add the backup block headers and data into the CRC
	 */
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
	{
		if (dtbuf_bkp[i])
		{
			BkpBlock   *bkpb = &(dtbuf_xlg[i]);
			char	   *page;

			COMP_CRC32(rdata_crc,
					   (char *) bkpb,
					   sizeof(BkpBlock));
			page = (char *) BufferGetBlock(dtbuf[i]);
			if (bkpb->hole_length == 0)
			{
				COMP_CRC32(rdata_crc,
						   page,
						   BLCKSZ);
			}
			else
			{
				/* must skip the hole */
				COMP_CRC32(rdata_crc,
						   page,
						   bkpb->hole_offset);
				COMP_CRC32(rdata_crc,
						   page + (bkpb->hole_offset + bkpb->hole_length),
						   BLCKSZ - (bkpb->hole_offset + bkpb->hole_length));
			}
		}
	}

T
Tom Lane 已提交
634
	/*
635 636
	 * NOTE: We disallow len == 0 because it provides a useful bit of extra
	 * error checking in ReadRecord.  This means that all callers of
B
Bruce Momjian 已提交
637 638 639
	 * XLogInsert must supply at least some not-in-a-buffer data.  However, we
	 * make an exception for XLOG SWITCH records because we don't want them to
	 * ever cross a segment boundary.
T
Tom Lane 已提交
640
	 */
641
	if (len == 0 && !isLogSwitch)
642
		elog(PANIC, "invalid xlog record length %u", len);
643

644
	START_CRIT_SECTION();
645

646 647 648
	/* Now wait to get insert lock */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);

T
Tom Lane 已提交
649
	/*
B
Bruce Momjian 已提交
650 651 652
	 * Check to see if my RedoRecPtr is out of date.  If so, may have to go
	 * back and recompute everything.  This can only happen just after a
	 * checkpoint, so it's better to be slow in this case and fast otherwise.
653 654
	 *
	 * If we aren't doing full-page writes then RedoRecPtr doesn't actually
B
Bruce Momjian 已提交
655 656
	 * affect the contents of the XLOG record, so we'll update our local copy
	 * but not force a recomputation.
T
Tom Lane 已提交
657 658
	 */
	if (!XLByteEQ(RedoRecPtr, Insert->RedoRecPtr))
659
	{
T
Tom Lane 已提交
660 661 662
		Assert(XLByteLT(RedoRecPtr, Insert->RedoRecPtr));
		RedoRecPtr = Insert->RedoRecPtr;

663
		if (doPageWrites)
664
		{
665
			for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
T
Tom Lane 已提交
666
			{
667 668 669 670 671 672 673 674 675 676 677 678 679
				if (dtbuf[i] == InvalidBuffer)
					continue;
				if (dtbuf_bkp[i] == false &&
					XLByteLE(dtbuf_lsn[i], RedoRecPtr))
				{
					/*
					 * Oops, this buffer now needs to be backed up, but we
					 * didn't think so above.  Start over.
					 */
					LWLockRelease(WALInsertLock);
					END_CRIT_SECTION();
					goto begin;
				}
T
Tom Lane 已提交
680
			}
681 682 683
		}
	}

684
	/*
B
Bruce Momjian 已提交
685 686 687 688
	 * Also check to see if forcePageWrites was just turned on; if we weren't
	 * already doing full-page writes then go back and recompute. (If it was
	 * just turned off, we could recompute the record without full pages, but
	 * we choose not to bother.)
689 690 691 692 693 694 695 696 697
	 */
	if (Insert->forcePageWrites && !doPageWrites)
	{
		/* Oops, must redo it with full-page data */
		LWLockRelease(WALInsertLock);
		END_CRIT_SECTION();
		goto begin;
	}

T
Tom Lane 已提交
698
	/*
B
Bruce Momjian 已提交
699 700 701 702
	 * Make additional rdata chain entries for the backup blocks, so that we
	 * don't need to special-case them in the write loop.  Note that we have
	 * now irrevocably changed the input rdata chain.  At the exit of this
	 * loop, write_len includes the backup block data.
T
Tom Lane 已提交
703
	 *
704 705 706
	 * Also set the appropriate info bits to show which buffers were backed
	 * up. The i'th XLR_SET_BKP_BLOCK bit corresponds to the i'th distinct
	 * buffer value (ignoring InvalidBuffer) appearing in the rdata chain.
T
Tom Lane 已提交
707 708 709
	 */
	write_len = len;
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
710
	{
711 712 713
		BkpBlock   *bkpb;
		char	   *page;

714
		if (!dtbuf_bkp[i])
715 716
			continue;

T
Tom Lane 已提交
717
		info |= XLR_SET_BKP_BLOCK(i);
718

719 720 721 722 723
		bkpb = &(dtbuf_xlg[i]);
		page = (char *) BufferGetBlock(dtbuf[i]);

		rdt->next = &(dtbuf_rdt1[i]);
		rdt = rdt->next;
724

725 726
		rdt->data = (char *) bkpb;
		rdt->len = sizeof(BkpBlock);
T
Tom Lane 已提交
727
		write_len += sizeof(BkpBlock);
728

729 730
		rdt->next = &(dtbuf_rdt2[i]);
		rdt = rdt->next;
731

732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
		if (bkpb->hole_length == 0)
		{
			rdt->data = page;
			rdt->len = BLCKSZ;
			write_len += BLCKSZ;
			rdt->next = NULL;
		}
		else
		{
			/* must skip the hole */
			rdt->data = page;
			rdt->len = bkpb->hole_offset;
			write_len += bkpb->hole_offset;

			rdt->next = &(dtbuf_rdt3[i]);
			rdt = rdt->next;

			rdt->data = page + (bkpb->hole_offset + bkpb->hole_length);
			rdt->len = BLCKSZ - (bkpb->hole_offset + bkpb->hole_length);
			write_len += rdt->len;
			rdt->next = NULL;
		}
754 755
	}

756 757 758 759 760 761 762 763 764 765 766 767 768
	/*
	 * If we backed up any full blocks and online backup is not in progress,
	 * mark the backup blocks as removable.  This allows the WAL archiver to
	 * know whether it is safe to compress archived WAL data by transforming
	 * full-block records into the non-full-block format.
	 *
	 * Note: we could just set the flag whenever !forcePageWrites, but
	 * defining it like this leaves the info bit free for some potential
	 * other use in records without any backup blocks.
	 */
	if ((info & XLR_BKP_BLOCK_MASK) && !Insert->forcePageWrites)
		info |= XLR_BKP_REMOVABLE;

769
	/*
770
	 * If there isn't enough space on the current XLOG page for a record
B
Bruce Momjian 已提交
771
	 * header, advance to the next page (leaving the unused space as zeroes).
772
	 */
T
Tom Lane 已提交
773 774
	updrqst = false;
	freespace = INSERT_FREESPACE(Insert);
775 776
	if (freespace < SizeOfXLogRecord)
	{
777
		updrqst = AdvanceXLInsertBuffer(false);
778 779 780
		freespace = INSERT_FREESPACE(Insert);
	}

781
	/* Compute record's XLOG location */
T
Tom Lane 已提交
782
	curridx = Insert->curridx;
783 784 785
	INSERT_RECPTR(RecPtr, Insert, curridx);

	/*
B
Bruce Momjian 已提交
786 787 788 789 790
	 * If the record is an XLOG_SWITCH, and we are exactly at the start of a
	 * segment, we need not insert it (and don't want to because we'd like
	 * consecutive switch requests to be no-ops).  Instead, make sure
	 * everything is written and flushed through the end of the prior segment,
	 * and return the prior segment's end address.
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
	 */
	if (isLogSwitch &&
		(RecPtr.xrecoff % XLogSegSize) == SizeOfXLogLongPHD)
	{
		/* We can release insert lock immediately */
		LWLockRelease(WALInsertLock);

		RecPtr.xrecoff -= SizeOfXLogLongPHD;
		if (RecPtr.xrecoff == 0)
		{
			/* crossing a logid boundary */
			RecPtr.xlogid -= 1;
			RecPtr.xrecoff = XLogFileSize;
		}

		LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
		LogwrtResult = XLogCtl->Write.LogwrtResult;
		if (!XLByteLE(RecPtr, LogwrtResult.Flush))
		{
			XLogwrtRqst FlushRqst;

			FlushRqst.Write = RecPtr;
			FlushRqst.Flush = RecPtr;
			XLogWrite(FlushRqst, false, false);
		}
		LWLockRelease(WALWriteLock);

		END_CRIT_SECTION();

		return RecPtr;
	}
T
Tom Lane 已提交
822

823 824
	/* Insert record header */

825
	record = (XLogRecord *) Insert->currpos;
826
	record->xl_prev = Insert->PrevRecord;
827
	record->xl_xid = GetCurrentTransactionIdIfAny();
828
	record->xl_tot_len = SizeOfXLogRecord + write_len;
T
Tom Lane 已提交
829
	record->xl_len = len;		/* doesn't include backup blocks */
830
	record->xl_info = info;
831
	record->xl_rmid = rmid;
832

833 834 835 836
	/* Now we can finish computing the record's CRC */
	COMP_CRC32(rdata_crc, (char *) record + sizeof(pg_crc32),
			   SizeOfXLogRecord - sizeof(pg_crc32));
	FIN_CRC32(rdata_crc);
837 838
	record->xl_crc = rdata_crc;

839
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
840 841
	if (XLOG_DEBUG)
	{
B
Bruce Momjian 已提交
842
		StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
843

844
		initStringInfo(&buf);
845 846
		appendStringInfo(&buf, "INSERT @ %X/%X: ",
						 RecPtr.xlogid, RecPtr.xrecoff);
847
		xlog_outrec(&buf, record);
848
		if (rdata->data != NULL)
V
WAL  
Vadim B. Mikheev 已提交
849
		{
850 851
			appendStringInfo(&buf, " - ");
			RmgrTable[record->xl_rmid].rm_desc(&buf, record->xl_info, rdata->data);
V
WAL  
Vadim B. Mikheev 已提交
852
		}
853 854
		elog(LOG, "%s", buf.data);
		pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
855
	}
856
#endif
V
WAL  
Vadim B. Mikheev 已提交
857

T
Tom Lane 已提交
858 859 860 861 862
	/* Record begin of record in appropriate places */
	if (!no_tran)
		MyLastRecPtr = RecPtr;
	ProcLastRecPtr = RecPtr;
	Insert->PrevRecord = RecPtr;
863
	MyXactMadeXLogEntry = true;
T
Tom Lane 已提交
864

865
	Insert->currpos += SizeOfXLogRecord;
T
Tom Lane 已提交
866
	freespace -= SizeOfXLogRecord;
867

T
Tom Lane 已提交
868 869 870 871
	/*
	 * Append the data, including backup blocks if any
	 */
	while (write_len)
872
	{
873 874 875 876
		while (rdata->data == NULL)
			rdata = rdata->next;

		if (freespace > 0)
877
		{
878 879 880 881 882
			if (rdata->len > freespace)
			{
				memcpy(Insert->currpos, rdata->data, freespace);
				rdata->data += freespace;
				rdata->len -= freespace;
T
Tom Lane 已提交
883
				write_len -= freespace;
884 885 886 887 888
			}
			else
			{
				memcpy(Insert->currpos, rdata->data, rdata->len);
				freespace -= rdata->len;
T
Tom Lane 已提交
889
				write_len -= rdata->len;
890 891 892 893
				Insert->currpos += rdata->len;
				rdata = rdata->next;
				continue;
			}
894 895
		}

896
		/* Use next buffer */
897
		updrqst = AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
898 899 900 901 902 903
		curridx = Insert->curridx;
		/* Insert cont-record header */
		Insert->currpage->xlp_info |= XLP_FIRST_IS_CONTRECORD;
		contrecord = (XLogContRecord *) Insert->currpos;
		contrecord->xl_rem_len = write_len;
		Insert->currpos += SizeOfXLogContRecord;
904
		freespace = INSERT_FREESPACE(Insert);
905
	}
906

T
Tom Lane 已提交
907 908
	/* Ensure next record will be properly aligned */
	Insert->currpos = (char *) Insert->currpage +
B
Bruce Momjian 已提交
909
		MAXALIGN(Insert->currpos - (char *) Insert->currpage);
T
Tom Lane 已提交
910
	freespace = INSERT_FREESPACE(Insert);
911

V
Vadim B. Mikheev 已提交
912
	/*
B
Bruce Momjian 已提交
913 914
	 * The recptr I return is the beginning of the *next* record. This will be
	 * stored as LSN for changed data pages...
V
Vadim B. Mikheev 已提交
915
	 */
T
Tom Lane 已提交
916
	INSERT_RECPTR(RecPtr, Insert, curridx);
V
Vadim B. Mikheev 已提交
917

918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
	/*
	 * If the record is an XLOG_SWITCH, we must now write and flush all the
	 * existing data, and then forcibly advance to the start of the next
	 * segment.  It's not good to do this I/O while holding the insert lock,
	 * but there seems too much risk of confusion if we try to release the
	 * lock sooner.  Fortunately xlog switch needn't be a high-performance
	 * operation anyway...
	 */
	if (isLogSwitch)
	{
		XLogCtlWrite *Write = &XLogCtl->Write;
		XLogwrtRqst FlushRqst;
		XLogRecPtr	OldSegEnd;

		LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);

		/*
B
Bruce Momjian 已提交
935 936
		 * Flush through the end of the page containing XLOG_SWITCH, and
		 * perform end-of-segment actions (eg, notifying archiver).
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
		 */
		WriteRqst = XLogCtl->xlblocks[curridx];
		FlushRqst.Write = WriteRqst;
		FlushRqst.Flush = WriteRqst;
		XLogWrite(FlushRqst, false, true);

		/* Set up the next buffer as first page of next segment */
		/* Note: AdvanceXLInsertBuffer cannot need to do I/O here */
		(void) AdvanceXLInsertBuffer(true);

		/* There should be no unwritten data */
		curridx = Insert->curridx;
		Assert(curridx == Write->curridx);

		/* Compute end address of old segment */
		OldSegEnd = XLogCtl->xlblocks[curridx];
		OldSegEnd.xrecoff -= XLOG_BLCKSZ;
		if (OldSegEnd.xrecoff == 0)
		{
			/* crossing a logid boundary */
			OldSegEnd.xlogid -= 1;
			OldSegEnd.xrecoff = XLogFileSize;
		}

		/* Make it look like we've written and synced all of old segment */
		LogwrtResult.Write = OldSegEnd;
		LogwrtResult.Flush = OldSegEnd;

		/*
		 * Update shared-memory status --- this code should match XLogWrite
		 */
		{
			/* use volatile pointer to prevent code rearrangement */
			volatile XLogCtlData *xlogctl = XLogCtl;

			SpinLockAcquire(&xlogctl->info_lck);
			xlogctl->LogwrtResult = LogwrtResult;
			if (XLByteLT(xlogctl->LogwrtRqst.Write, LogwrtResult.Write))
				xlogctl->LogwrtRqst.Write = LogwrtResult.Write;
			if (XLByteLT(xlogctl->LogwrtRqst.Flush, LogwrtResult.Flush))
				xlogctl->LogwrtRqst.Flush = LogwrtResult.Flush;
			SpinLockRelease(&xlogctl->info_lck);
		}

		Write->LogwrtResult = LogwrtResult;

		LWLockRelease(WALWriteLock);

		updrqst = false;		/* done already */
	}
987
	else
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
	{
		/* normal case, ie not xlog switch */

		/* Need to update shared LogwrtRqst if some block was filled up */
		if (freespace < SizeOfXLogRecord)
		{
			/* curridx is filled and available for writing out */
			updrqst = true;
		}
		else
		{
			/* if updrqst already set, write through end of previous buf */
			curridx = PrevBufIdx(curridx);
		}
		WriteRqst = XLogCtl->xlblocks[curridx];
	}
1004

1005
	LWLockRelease(WALInsertLock);
1006 1007 1008

	if (updrqst)
	{
1009 1010 1011
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1012
		SpinLockAcquire(&xlogctl->info_lck);
T
Tom Lane 已提交
1013
		/* advance global request to include new block(s) */
1014 1015
		if (XLByteLT(xlogctl->LogwrtRqst.Write, WriteRqst))
			xlogctl->LogwrtRqst.Write = WriteRqst;
T
Tom Lane 已提交
1016
		/* update local result copy while I have the chance */
1017
		LogwrtResult = xlogctl->LogwrtResult;
1018
		SpinLockRelease(&xlogctl->info_lck);
1019 1020
	}

1021 1022
	ProcLastRecEnd = RecPtr;

1023
	END_CRIT_SECTION();
1024

1025
	return RecPtr;
1026
}
1027

1028
/*
1029 1030 1031
 * Determine whether the buffer referenced by an XLogRecData item has to
 * be backed up, and if so fill a BkpBlock struct for it.  In any case
 * save the buffer's LSN at *lsn.
1032
 */
1033
static bool
1034
XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
1035
				XLogRecPtr *lsn, BkpBlock *bkpb)
1036 1037
{
	PageHeader	page;
1038 1039 1040 1041

	page = (PageHeader) BufferGetBlock(rdata->buffer);

	/*
B
Bruce Momjian 已提交
1042 1043 1044
	 * XXX We assume page LSN is first data on *every* page that can be passed
	 * to XLogInsert, whether it otherwise has the standard page layout or
	 * not.
1045 1046 1047
	 */
	*lsn = page->pd_lsn;

1048
	if (doPageWrites &&
1049
		XLByteLE(page->pd_lsn, RedoRecPtr))
1050
	{
1051 1052 1053 1054 1055
		/*
		 * The page needs to be backed up, so set up *bkpb
		 */
		bkpb->node = BufferGetFileNode(rdata->buffer);
		bkpb->block = BufferGetBlockNumber(rdata->buffer);
1056

1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
		if (rdata->buffer_std)
		{
			/* Assume we can omit data between pd_lower and pd_upper */
			uint16		lower = page->pd_lower;
			uint16		upper = page->pd_upper;

			if (lower >= SizeOfPageHeaderData &&
				upper > lower &&
				upper <= BLCKSZ)
			{
				bkpb->hole_offset = lower;
				bkpb->hole_length = upper - lower;
			}
			else
			{
				/* No "hole" to compress out */
				bkpb->hole_offset = 0;
				bkpb->hole_length = 0;
			}
		}
		else
		{
			/* Not a standard page header, don't try to eliminate "hole" */
			bkpb->hole_offset = 0;
			bkpb->hole_length = 0;
		}
1083

1084
		return true;			/* buffer requires backup */
1085
	}
1086 1087

	return false;				/* buffer does not need to be backed up */
1088 1089
}

1090 1091 1092 1093 1094 1095
/*
 * XLogArchiveNotify
 *
 * Create an archive notification file
 *
 * The name of the notification file is the message that will be picked up
1096
 * by the archiver, e.g. we write 0000000100000001000000C6.ready
1097
 * and the archiver then knows to archive XLOGDIR/0000000100000001000000C6,
1098
 * then when complete, rename it to 0000000100000001000000C6.done
1099 1100 1101 1102 1103
 */
static void
XLogArchiveNotify(const char *xlog)
{
	char		archiveStatusPath[MAXPGPATH];
B
Bruce Momjian 已提交
1104
	FILE	   *fd;
1105 1106 1107 1108

	/* insert an otherwise empty file called <XLOG>.ready */
	StatusFilePath(archiveStatusPath, xlog, ".ready");
	fd = AllocateFile(archiveStatusPath, "w");
B
Bruce Momjian 已提交
1109 1110
	if (fd == NULL)
	{
1111 1112 1113 1114 1115 1116
		ereport(LOG,
				(errcode_for_file_access(),
				 errmsg("could not create archive status file \"%s\": %m",
						archiveStatusPath)));
		return;
	}
B
Bruce Momjian 已提交
1117 1118
	if (FreeFile(fd))
	{
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
		ereport(LOG,
				(errcode_for_file_access(),
				 errmsg("could not write archive status file \"%s\": %m",
						archiveStatusPath)));
		return;
	}

	/* Notify archiver that it's got something to do */
	if (IsUnderPostmaster)
		SendPostmasterSignal(PMSIGNAL_WAKEN_ARCHIVER);
}

/*
 * Convenience routine to notify using log/seg representation of filename
 */
static void
XLogArchiveNotifySeg(uint32 log, uint32 seg)
{
	char		xlog[MAXFNAMELEN];

1139
	XLogFileName(xlog, ThisTimeLineID, log, seg);
1140 1141 1142 1143
	XLogArchiveNotify(xlog);
}

/*
1144
 * XLogArchiveCheckDone
1145
 *
1146 1147 1148 1149
 * This is called when we are ready to delete or recycle an old XLOG segment
 * file or backup history file.  If it is okay to delete it then return true.
 * If it is not time to delete it, make sure a .ready file exists, and return
 * false.
1150 1151
 *
 * If <XLOG>.done exists, then return true; else if <XLOG>.ready exists,
1152 1153 1154 1155
 * then return false; else create <XLOG>.ready and return false.
 *
 * The reason we do things this way is so that if the original attempt to
 * create <XLOG>.ready fails, we'll retry during subsequent checkpoints.
1156 1157
 */
static bool
1158
XLogArchiveCheckDone(const char *xlog)
1159 1160 1161 1162
{
	char		archiveStatusPath[MAXPGPATH];
	struct stat stat_buf;

1163 1164 1165 1166 1167
	/* Always deletable if archiving is off */
	if (!XLogArchivingActive())
		return true;

	/* First check for .done --- this means archiver is done with it */
1168 1169 1170 1171 1172 1173 1174
	StatusFilePath(archiveStatusPath, xlog, ".done");
	if (stat(archiveStatusPath, &stat_buf) == 0)
		return true;

	/* check for .ready --- this means archiver is still busy with it */
	StatusFilePath(archiveStatusPath, xlog, ".ready");
	if (stat(archiveStatusPath, &stat_buf) == 0)
B
Bruce Momjian 已提交
1175
		return false;
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189

	/* Race condition --- maybe archiver just finished, so recheck */
	StatusFilePath(archiveStatusPath, xlog, ".done");
	if (stat(archiveStatusPath, &stat_buf) == 0)
		return true;

	/* Retry creation of the .ready file */
	XLogArchiveNotify(xlog);
	return false;
}

/*
 * XLogArchiveCleanup
 *
1190
 * Cleanup archive notification file(s) for a particular xlog segment
1191 1192 1193 1194
 */
static void
XLogArchiveCleanup(const char *xlog)
{
B
Bruce Momjian 已提交
1195
	char		archiveStatusPath[MAXPGPATH];
1196

1197
	/* Remove the .done file */
1198 1199 1200
	StatusFilePath(archiveStatusPath, xlog, ".done");
	unlink(archiveStatusPath);
	/* should we complain about failure? */
1201 1202 1203 1204 1205

	/* Remove the .ready file if present --- normally it shouldn't be */
	StatusFilePath(archiveStatusPath, xlog, ".ready");
	unlink(archiveStatusPath);
	/* should we complain about failure? */
1206 1207
}

T
Tom Lane 已提交
1208 1209 1210 1211
/*
 * Advance the Insert state to the next buffer page, writing out the next
 * buffer if it still contains unwritten data.
 *
1212 1213 1214 1215
 * If new_segment is TRUE then we set up the next buffer page as the first
 * page of the next xlog segment file, possibly but not usually the next
 * consecutive file page.
 *
T
Tom Lane 已提交
1216
 * The global LogwrtRqst.Write pointer needs to be advanced to include the
1217
 * just-filled page.  If we can do this for free (without an extra lock),
T
Tom Lane 已提交
1218 1219 1220
 * we do so here.  Otherwise the caller must do it.  We return TRUE if the
 * request update still needs to be done, FALSE if we did it internally.
 *
1221
 * Must be called with WALInsertLock held.
T
Tom Lane 已提交
1222 1223
 */
static bool
1224
AdvanceXLInsertBuffer(bool new_segment)
1225
{
T
Tom Lane 已提交
1226 1227
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogCtlWrite *Write = &XLogCtl->Write;
1228
	int			nextidx = NextBufIdx(Insert->curridx);
T
Tom Lane 已提交
1229 1230 1231
	bool		update_needed = true;
	XLogRecPtr	OldPageRqstPtr;
	XLogwrtRqst WriteRqst;
1232 1233
	XLogRecPtr	NewPageEndPtr;
	XLogPageHeader NewPage;
1234

T
Tom Lane 已提交
1235 1236 1237
	/* Use Insert->LogwrtResult copy if it's more fresh */
	if (XLByteLT(LogwrtResult.Write, Insert->LogwrtResult.Write))
		LogwrtResult = Insert->LogwrtResult;
V
WAL  
Vadim B. Mikheev 已提交
1238

T
Tom Lane 已提交
1239
	/*
B
Bruce Momjian 已提交
1240 1241 1242
	 * Get ending-offset of the buffer page we need to replace (this may be
	 * zero if the buffer hasn't been used yet).  Fall through if it's already
	 * written out.
T
Tom Lane 已提交
1243 1244 1245 1246 1247 1248
	 */
	OldPageRqstPtr = XLogCtl->xlblocks[nextidx];
	if (!XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
	{
		/* nope, got work to do... */
		XLogRecPtr	FinishedPageRqstPtr;
1249

T
Tom Lane 已提交
1250
		FinishedPageRqstPtr = XLogCtl->xlblocks[Insert->curridx];
1251

1252
		/* Before waiting, get info_lck and update LogwrtResult */
1253 1254 1255 1256
		{
			/* use volatile pointer to prevent code rearrangement */
			volatile XLogCtlData *xlogctl = XLogCtl;

1257
			SpinLockAcquire(&xlogctl->info_lck);
1258 1259 1260
			if (XLByteLT(xlogctl->LogwrtRqst.Write, FinishedPageRqstPtr))
				xlogctl->LogwrtRqst.Write = FinishedPageRqstPtr;
			LogwrtResult = xlogctl->LogwrtResult;
1261
			SpinLockRelease(&xlogctl->info_lck);
1262
		}
1263 1264 1265 1266 1267 1268 1269 1270 1271

		update_needed = false;	/* Did the shared-request update */

		if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
		{
			/* OK, someone wrote it already */
			Insert->LogwrtResult = LogwrtResult;
		}
		else
1272
		{
1273 1274 1275 1276
			/* Must acquire write lock */
			LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
			LogwrtResult = Write->LogwrtResult;
			if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
1277
			{
1278 1279 1280
				/* OK, someone wrote it already */
				LWLockRelease(WALWriteLock);
				Insert->LogwrtResult = LogwrtResult;
T
Tom Lane 已提交
1281
			}
1282
			else
T
Tom Lane 已提交
1283 1284
			{
				/*
B
Bruce Momjian 已提交
1285 1286
				 * Have to write buffers while holding insert lock. This is
				 * not good, so only write as much as we absolutely must.
T
Tom Lane 已提交
1287 1288 1289 1290
				 */
				WriteRqst.Write = OldPageRqstPtr;
				WriteRqst.Flush.xlogid = 0;
				WriteRqst.Flush.xrecoff = 0;
1291
				XLogWrite(WriteRqst, false, false);
1292
				LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1293
				Insert->LogwrtResult = LogwrtResult;
1294 1295 1296 1297
			}
		}
	}

T
Tom Lane 已提交
1298
	/*
B
Bruce Momjian 已提交
1299 1300
	 * Now the next buffer slot is free and we can set it up to be the next
	 * output page.
T
Tom Lane 已提交
1301
	 */
1302
	NewPageEndPtr = XLogCtl->xlblocks[Insert->curridx];
1303 1304 1305 1306 1307 1308 1309 1310

	if (new_segment)
	{
		/* force it to a segment start point */
		NewPageEndPtr.xrecoff += XLogSegSize - 1;
		NewPageEndPtr.xrecoff -= NewPageEndPtr.xrecoff % XLogSegSize;
	}

1311
	if (NewPageEndPtr.xrecoff >= XLogFileSize)
1312
	{
T
Tom Lane 已提交
1313
		/* crossing a logid boundary */
1314
		NewPageEndPtr.xlogid += 1;
1315
		NewPageEndPtr.xrecoff = XLOG_BLCKSZ;
1316
	}
T
Tom Lane 已提交
1317
	else
1318
		NewPageEndPtr.xrecoff += XLOG_BLCKSZ;
1319
	XLogCtl->xlblocks[nextidx] = NewPageEndPtr;
1320
	NewPage = (XLogPageHeader) (XLogCtl->pages + nextidx * (Size) XLOG_BLCKSZ);
B
Bruce Momjian 已提交
1321

T
Tom Lane 已提交
1322
	Insert->curridx = nextidx;
1323
	Insert->currpage = NewPage;
B
Bruce Momjian 已提交
1324 1325

	Insert->currpos = ((char *) NewPage) +SizeOfXLogShortPHD;
B
Bruce Momjian 已提交
1326

T
Tom Lane 已提交
1327
	/*
B
Bruce Momjian 已提交
1328 1329
	 * Be sure to re-zero the buffer so that bytes beyond what we've written
	 * will look like zeroes and not valid XLOG records...
T
Tom Lane 已提交
1330
	 */
1331
	MemSet((char *) NewPage, 0, XLOG_BLCKSZ);
1332

1333 1334 1335
	/*
	 * Fill the new page's header
	 */
B
Bruce Momjian 已提交
1336 1337
	NewPage   ->xlp_magic = XLOG_PAGE_MAGIC;

1338
	/* NewPage->xlp_info = 0; */	/* done by memset */
B
Bruce Momjian 已提交
1339 1340
	NewPage   ->xlp_tli = ThisTimeLineID;
	NewPage   ->xlp_pageaddr.xlogid = NewPageEndPtr.xlogid;
1341
	NewPage   ->xlp_pageaddr.xrecoff = NewPageEndPtr.xrecoff - XLOG_BLCKSZ;
T
Tom Lane 已提交
1342

1343
	/*
1344
	 * If first page of an XLOG segment file, make it a long header.
1345 1346 1347
	 */
	if ((NewPage->xlp_pageaddr.xrecoff % XLogSegSize) == 0)
	{
1348
		XLogLongPageHeader NewLongPage = (XLogLongPageHeader) NewPage;
1349

1350 1351
		NewLongPage->xlp_sysid = ControlFile->system_identifier;
		NewLongPage->xlp_seg_size = XLogSegSize;
1352
		NewLongPage->xlp_xlog_blcksz = XLOG_BLCKSZ;
B
Bruce Momjian 已提交
1353 1354 1355
		NewPage   ->xlp_info |= XLP_LONG_HEADER;

		Insert->currpos = ((char *) NewPage) +SizeOfXLogLongPHD;
1356 1357
	}

T
Tom Lane 已提交
1358
	return update_needed;
1359 1360
}

T
Tom Lane 已提交
1361 1362 1363
/*
 * Write and/or fsync the log at least as far as WriteRqst indicates.
 *
1364 1365 1366 1367 1368
 * If flexible == TRUE, we don't have to write as far as WriteRqst, but
 * may stop at any convenient boundary (such as a cache or logfile boundary).
 * This option allows us to avoid uselessly issuing multiple writes when a
 * single one would do.
 *
1369 1370 1371 1372 1373 1374
 * If xlog_switch == TRUE, we are intending an xlog segment switch, so
 * perform end-of-segment actions after writing the last page, even if
 * it's not physically the end of its segment.  (NB: this will work properly
 * only if caller specifies WriteRqst == page-end and flexible == false,
 * and there is some data to write.)
 *
1375
 * Must be called with WALWriteLock held.
T
Tom Lane 已提交
1376
 */
1377
static void
1378
XLogWrite(XLogwrtRqst WriteRqst, bool flexible, bool xlog_switch)
1379
{
1380
	XLogCtlWrite *Write = &XLogCtl->Write;
T
Tom Lane 已提交
1381
	bool		ispartialpage;
1382
	bool		last_iteration;
1383
	bool		finishing_seg;
1384
	bool		use_existent;
1385 1386 1387 1388
	int			curridx;
	int			npages;
	int			startidx;
	uint32		startoffset;
1389

1390 1391 1392
	/* We should always be inside a critical section here */
	Assert(CritSectionCount > 0);

B
Bruce Momjian 已提交
1393
	/*
B
Bruce Momjian 已提交
1394
	 * Update local LogwrtResult (caller probably did this already, but...)
B
Bruce Momjian 已提交
1395
	 */
T
Tom Lane 已提交
1396 1397
	LogwrtResult = Write->LogwrtResult;

1398 1399 1400
	/*
	 * Since successive pages in the xlog cache are consecutively allocated,
	 * we can usually gather multiple pages together and issue just one
B
Bruce Momjian 已提交
1401 1402 1403 1404 1405
	 * write() call.  npages is the number of pages we have determined can be
	 * written together; startidx is the cache block index of the first one,
	 * and startoffset is the file offset at which it should go. The latter
	 * two variables are only valid when npages > 0, but we must initialize
	 * all of them to keep the compiler quiet.
1406 1407 1408 1409 1410 1411 1412 1413 1414
	 */
	npages = 0;
	startidx = 0;
	startoffset = 0;

	/*
	 * Within the loop, curridx is the cache block index of the page to
	 * consider writing.  We advance Write->curridx only after successfully
	 * writing pages.  (Right now, this refinement is useless since we are
B
Bruce Momjian 已提交
1415 1416
	 * going to PANIC if any error occurs anyway; but someday it may come in
	 * useful.)
1417 1418
	 */
	curridx = Write->curridx;
B
 
Bruce Momjian 已提交
1419

T
Tom Lane 已提交
1420
	while (XLByteLT(LogwrtResult.Write, WriteRqst.Write))
1421
	{
1422
		/*
B
Bruce Momjian 已提交
1423 1424 1425
		 * Make sure we're not ahead of the insert process.  This could happen
		 * if we're passed a bogus WriteRqst.Write that is past the end of the
		 * last page that's been initialized by AdvanceXLInsertBuffer.
1426
		 */
1427
		if (!XLByteLT(LogwrtResult.Write, XLogCtl->xlblocks[curridx]))
1428
			elog(PANIC, "xlog write request %X/%X is past end of log %X/%X",
1429
				 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
1430 1431
				 XLogCtl->xlblocks[curridx].xlogid,
				 XLogCtl->xlblocks[curridx].xrecoff);
1432

T
Tom Lane 已提交
1433
		/* Advance LogwrtResult.Write to end of current buffer page */
1434
		LogwrtResult.Write = XLogCtl->xlblocks[curridx];
T
Tom Lane 已提交
1435 1436 1437
		ispartialpage = XLByteLT(WriteRqst.Write, LogwrtResult.Write);

		if (!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1438
		{
T
Tom Lane 已提交
1439
			/*
1440 1441
			 * Switch to new logfile segment.  We cannot have any pending
			 * pages here (since we dump what we have at segment end).
T
Tom Lane 已提交
1442
			 */
1443
			Assert(npages == 0);
T
Tom Lane 已提交
1444
			if (openLogFile >= 0)
1445
				XLogFileClose();
T
Tom Lane 已提交
1446 1447
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);

1448 1449 1450 1451
			/* create/use new log file */
			use_existent = true;
			openLogFile = XLogFileInit(openLogId, openLogSeg,
									   &use_existent, true);
T
Tom Lane 已提交
1452
			openLogOff = 0;
1453 1454
		}

1455
		/* Make sure we have the current logfile open */
T
Tom Lane 已提交
1456
		if (openLogFile < 0)
1457
		{
T
Tom Lane 已提交
1458
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1459
			openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
1460
			openLogOff = 0;
1461 1462
		}

1463 1464 1465 1466 1467
		/* Add current page to the set of pending pages-to-dump */
		if (npages == 0)
		{
			/* first of group */
			startidx = curridx;
1468
			startoffset = (LogwrtResult.Write.xrecoff - XLOG_BLCKSZ) % XLogSegSize;
1469 1470
		}
		npages++;
1471

T
Tom Lane 已提交
1472
		/*
B
Bruce Momjian 已提交
1473 1474 1475 1476
		 * Dump the set if this will be the last loop iteration, or if we are
		 * at the last page of the cache area (since the next page won't be
		 * contiguous in memory), or if we are at the end of the logfile
		 * segment.
T
Tom Lane 已提交
1477
		 */
1478 1479
		last_iteration = !XLByteLT(LogwrtResult.Write, WriteRqst.Write);

1480
		finishing_seg = !ispartialpage &&
1481
			(startoffset + npages * XLOG_BLCKSZ) >= XLogSegSize;
1482

1483
		if (last_iteration ||
1484 1485
			curridx == XLogCtl->XLogCacheBlck ||
			finishing_seg)
T
Tom Lane 已提交
1486
		{
1487 1488
			char	   *from;
			Size		nbytes;
1489

1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
			/* Need to seek in the file? */
			if (openLogOff != startoffset)
			{
				if (lseek(openLogFile, (off_t) startoffset, SEEK_SET) < 0)
					ereport(PANIC,
							(errcode_for_file_access(),
							 errmsg("could not seek in log file %u, "
									"segment %u to offset %u: %m",
									openLogId, openLogSeg, startoffset)));
				openLogOff = startoffset;
			}

			/* OK to write the page(s) */
1503 1504
			from = XLogCtl->pages + startidx * (Size) XLOG_BLCKSZ;
			nbytes = npages * (Size) XLOG_BLCKSZ;
1505 1506 1507 1508 1509 1510 1511 1512 1513
			errno = 0;
			if (write(openLogFile, from, nbytes) != nbytes)
			{
				/* if write didn't set errno, assume no disk space */
				if (errno == 0)
					errno = ENOSPC;
				ereport(PANIC,
						(errcode_for_file_access(),
						 errmsg("could not write to log file %u, segment %u "
P
Peter Eisentraut 已提交
1514
								"at offset %u, length %lu: %m",
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
								openLogId, openLogSeg,
								openLogOff, (unsigned long) nbytes)));
			}

			/* Update state for write */
			openLogOff += nbytes;
			Write->curridx = ispartialpage ? curridx : NextBufIdx(curridx);
			npages = 0;

			/*
			 * If we just wrote the whole last page of a logfile segment,
			 * fsync the segment immediately.  This avoids having to go back
			 * and re-open prior segments when an fsync request comes along
			 * later. Doing it here ensures that one and only one backend will
			 * perform this fsync.
			 *
1531 1532 1533
			 * We also do this if this is the last page written for an xlog
			 * switch.
			 *
1534
			 * This is also the right place to notify the Archiver that the
B
Bruce Momjian 已提交
1535
			 * segment is ready to copy to archival storage, and to update the
1536 1537 1538
			 * timer for archive_timeout, and to signal for a checkpoint if
			 * too many logfile segments have been used since the last
			 * checkpoint.
1539
			 */
1540
			if (finishing_seg || (xlog_switch && last_iteration))
1541 1542
			{
				issue_xlog_fsync();
B
Bruce Momjian 已提交
1543
				LogwrtResult.Flush = LogwrtResult.Write;		/* end of page */
1544 1545 1546

				if (XLogArchivingActive())
					XLogArchiveNotifySeg(openLogId, openLogSeg);
1547 1548

				Write->lastSegSwitchTime = time(NULL);
1549 1550

				/*
1551 1552 1553 1554
				 * Signal bgwriter to start a checkpoint if we've consumed too
				 * much xlog since the last one.  (We look at local copy of
				 * RedoRecPtr which might be a little out of date, but should
				 * be close enough for this purpose.)
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
				 *
				 * A straight computation of segment number could overflow 32
				 * bits.  Rather than assuming we have working 64-bit
				 * arithmetic, we compare the highest-order bits separately,
				 * and force a checkpoint immediately when they change.
				 */
				if (IsUnderPostmaster)
				{
					uint32		old_segno,
								new_segno;
					uint32		old_highbits,
								new_highbits;

					old_segno = (RedoRecPtr.xlogid % XLogSegSize) * XLogSegsPerFile +
						(RedoRecPtr.xrecoff / XLogSegSize);
					old_highbits = RedoRecPtr.xlogid / XLogSegSize;
					new_segno = (openLogId % XLogSegSize) * XLogSegsPerFile +
						openLogSeg;
					new_highbits = openLogId / XLogSegSize;
					if (new_highbits != old_highbits ||
						new_segno >= old_segno + (uint32) (CheckPointSegments-1))
1576
						RequestCheckpoint(CHECKPOINT_CAUSE_XLOG);
1577
				}
1578
			}
T
Tom Lane 已提交
1579
		}
1580

T
Tom Lane 已提交
1581 1582 1583 1584 1585 1586
		if (ispartialpage)
		{
			/* Only asked to write a partial page */
			LogwrtResult.Write = WriteRqst.Write;
			break;
		}
1587 1588 1589 1590 1591
		curridx = NextBufIdx(curridx);

		/* If flexible, break out of loop as soon as we wrote something */
		if (flexible && npages == 0)
			break;
1592
	}
1593 1594 1595

	Assert(npages == 0);
	Assert(curridx == Write->curridx);
1596

T
Tom Lane 已提交
1597 1598 1599 1600 1601
	/*
	 * If asked to flush, do so
	 */
	if (XLByteLT(LogwrtResult.Flush, WriteRqst.Flush) &&
		XLByteLT(LogwrtResult.Flush, LogwrtResult.Write))
1602
	{
T
Tom Lane 已提交
1603
		/*
B
Bruce Momjian 已提交
1604 1605 1606
		 * Could get here without iterating above loop, in which case we might
		 * have no open file or the wrong one.	However, we do not need to
		 * fsync more than one file.
T
Tom Lane 已提交
1607
		 */
1608
		if (sync_method != SYNC_METHOD_OPEN)
T
Tom Lane 已提交
1609
		{
1610
			if (openLogFile >= 0 &&
B
Bruce Momjian 已提交
1611
				!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1612
				XLogFileClose();
1613 1614 1615
			if (openLogFile < 0)
			{
				XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1616
				openLogFile = XLogFileOpen(openLogId, openLogSeg);
1617 1618 1619
				openLogOff = 0;
			}
			issue_xlog_fsync();
T
Tom Lane 已提交
1620 1621
		}
		LogwrtResult.Flush = LogwrtResult.Write;
1622 1623
	}

T
Tom Lane 已提交
1624 1625 1626
	/*
	 * Update shared-memory status
	 *
B
Bruce Momjian 已提交
1627
	 * We make sure that the shared 'request' values do not fall behind the
B
Bruce Momjian 已提交
1628 1629
	 * 'result' values.  This is not absolutely essential, but it saves some
	 * code in a couple of places.
T
Tom Lane 已提交
1630
	 */
1631 1632 1633 1634
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1635
		SpinLockAcquire(&xlogctl->info_lck);
1636 1637 1638 1639 1640
		xlogctl->LogwrtResult = LogwrtResult;
		if (XLByteLT(xlogctl->LogwrtRqst.Write, LogwrtResult.Write))
			xlogctl->LogwrtRqst.Write = LogwrtResult.Write;
		if (XLByteLT(xlogctl->LogwrtRqst.Flush, LogwrtResult.Flush))
			xlogctl->LogwrtRqst.Flush = LogwrtResult.Flush;
1641
		SpinLockRelease(&xlogctl->info_lck);
1642
	}
1643

T
Tom Lane 已提交
1644 1645 1646
	Write->LogwrtResult = LogwrtResult;
}

1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
/*
 * Record the LSN for an asynchronous transaction commit.
 * (This should not be called for aborts, nor for synchronous commits.)
 */
void
XLogSetAsyncCommitLSN(XLogRecPtr asyncCommitLSN)
{
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;

	SpinLockAcquire(&xlogctl->info_lck);
	if (XLByteLT(xlogctl->asyncCommitLSN, asyncCommitLSN))
		xlogctl->asyncCommitLSN = asyncCommitLSN;
	SpinLockRelease(&xlogctl->info_lck);
}

T
Tom Lane 已提交
1663 1664 1665
/*
 * Ensure that all XLOG data through the given position is flushed to disk.
 *
1666
 * NOTE: this differs from XLogWrite mainly in that the WALWriteLock is not
T
Tom Lane 已提交
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682
 * already held, and we try to avoid acquiring it if possible.
 */
void
XLogFlush(XLogRecPtr record)
{
	XLogRecPtr	WriteRqstPtr;
	XLogwrtRqst WriteRqst;

	/* Disabled during REDO */
	if (InRedo)
		return;

	/* Quick exit if already known flushed */
	if (XLByteLE(record, LogwrtResult.Flush))
		return;

1683
#ifdef WAL_DEBUG
1684
	if (XLOG_DEBUG)
1685
		elog(LOG, "xlog flush request %X/%X; write %X/%X; flush %X/%X",
1686 1687 1688
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1689
#endif
1690

T
Tom Lane 已提交
1691 1692 1693 1694
	START_CRIT_SECTION();

	/*
	 * Since fsync is usually a horribly expensive operation, we try to
B
Bruce Momjian 已提交
1695 1696 1697 1698
	 * piggyback as much data as we can on each fsync: if we see any more data
	 * entered into the xlog buffer, we'll write and fsync that too, so that
	 * the final value of LogwrtResult.Flush is as large as possible. This
	 * gives us some chance of avoiding another fsync immediately after.
T
Tom Lane 已提交
1699 1700 1701 1702 1703
	 */

	/* initialize to given target; may increase below */
	WriteRqstPtr = record;

1704
	/* read LogwrtResult and update local state */
1705 1706 1707 1708
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1709
		SpinLockAcquire(&xlogctl->info_lck);
1710 1711 1712
		if (XLByteLT(WriteRqstPtr, xlogctl->LogwrtRqst.Write))
			WriteRqstPtr = xlogctl->LogwrtRqst.Write;
		LogwrtResult = xlogctl->LogwrtResult;
1713
		SpinLockRelease(&xlogctl->info_lck);
1714
	}
1715 1716 1717

	/* done already? */
	if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1718
	{
1719 1720 1721 1722
		/* now wait for the write lock */
		LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
		LogwrtResult = XLogCtl->Write.LogwrtResult;
		if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1723
		{
1724 1725 1726 1727 1728 1729
			/* try to write/flush later additions to XLOG as well */
			if (LWLockConditionalAcquire(WALInsertLock, LW_EXCLUSIVE))
			{
				XLogCtlInsert *Insert = &XLogCtl->Insert;
				uint32		freespace = INSERT_FREESPACE(Insert);

B
Bruce Momjian 已提交
1730
				if (freespace < SizeOfXLogRecord)		/* buffer is full */
1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
					WriteRqstPtr = XLogCtl->xlblocks[Insert->curridx];
				else
				{
					WriteRqstPtr = XLogCtl->xlblocks[Insert->curridx];
					WriteRqstPtr.xrecoff -= freespace;
				}
				LWLockRelease(WALInsertLock);
				WriteRqst.Write = WriteRqstPtr;
				WriteRqst.Flush = WriteRqstPtr;
			}
			else
			{
				WriteRqst.Write = WriteRqstPtr;
				WriteRqst.Flush = record;
			}
1746
			XLogWrite(WriteRqst, false, false);
T
Tom Lane 已提交
1747
		}
1748
		LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1749 1750 1751
	}

	END_CRIT_SECTION();
1752 1753 1754

	/*
	 * If we still haven't flushed to the request point then we have a
B
Bruce Momjian 已提交
1755 1756
	 * problem; most likely, the requested flush point is past end of XLOG.
	 * This has been seen to occur when a disk page has a corrupted LSN.
1757
	 *
1758 1759 1760 1761 1762 1763 1764 1765 1766
	 * Formerly we treated this as a PANIC condition, but that hurts the
	 * system's robustness rather than helping it: we do not want to take down
	 * the whole system due to corruption on one data page.  In particular, if
	 * the bad page is encountered again during recovery then we would be
	 * unable to restart the database at all!  (This scenario has actually
	 * happened in the field several times with 7.1 releases. Note that we
	 * cannot get here while InRedo is true, but if the bad page is brought in
	 * and marked dirty during recovery then CreateCheckPoint will try to
	 * flush it at the end of recovery.)
1767
	 *
1768 1769 1770 1771
	 * The current approach is to ERROR under normal conditions, but only
	 * WARNING during recovery, so that the system can be brought up even if
	 * there's a corrupt LSN.  Note that for calls from xact.c, the ERROR will
	 * be promoted to PANIC since xact.c calls this routine inside a critical
B
Bruce Momjian 已提交
1772 1773
	 * section.  However, calls from bufmgr.c are not within critical sections
	 * and so we will not force a restart for a bad LSN on a data page.
1774 1775
	 */
	if (XLByteLT(LogwrtResult.Flush, record))
B
Bruce Momjian 已提交
1776
		elog(InRecovery ? WARNING : ERROR,
B
Bruce Momjian 已提交
1777
		"xlog flush request %X/%X is not satisfied --- flushed only to %X/%X",
1778 1779
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1780 1781
}

1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822
/*
 * Flush xlog, but without specifying exactly where to flush to.
 *
 * We normally flush only completed blocks; but if there is nothing to do on
 * that basis, we check for unflushed async commits in the current incomplete
 * block, and flush through the latest one of those.  Thus, if async commits
 * are not being used, we will flush complete blocks only.  We can guarantee
 * that async commits reach disk after at most three cycles; normally only
 * one or two.  (We allow XLogWrite to write "flexibly", meaning it can stop
 * at the end of the buffer ring; this makes a difference only with very high
 * load or long wal_writer_delay, but imposes one extra cycle for the worst
 * case for async commits.)
 *
 * This routine is invoked periodically by the background walwriter process.
 */
void
XLogBackgroundFlush(void)
{
	XLogRecPtr	WriteRqstPtr;
	bool		flexible = true;

	/* read LogwrtResult and update local state */
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

		SpinLockAcquire(&xlogctl->info_lck);
		LogwrtResult = xlogctl->LogwrtResult;
		WriteRqstPtr = xlogctl->LogwrtRqst.Write;
		SpinLockRelease(&xlogctl->info_lck);
	}

	/* back off to last completed page boundary */
	WriteRqstPtr.xrecoff -= WriteRqstPtr.xrecoff % XLOG_BLCKSZ;

	/* if we have already flushed that far, consider async commit records */
	if (XLByteLE(WriteRqstPtr, LogwrtResult.Flush))
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1823
		SpinLockAcquire(&xlogctl->info_lck);
1824
		WriteRqstPtr = xlogctl->asyncCommitLSN;
1825
		SpinLockRelease(&xlogctl->info_lck);
1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
		flexible = false;		/* ensure it all gets written */
	}

	/* Done if already known flushed */
	if (XLByteLE(WriteRqstPtr, LogwrtResult.Flush))
		return;

#ifdef WAL_DEBUG
	if (XLOG_DEBUG)
		elog(LOG, "xlog bg flush request %X/%X; write %X/%X; flush %X/%X",
			 WriteRqstPtr.xlogid, WriteRqstPtr.xrecoff,
			 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
#endif

	START_CRIT_SECTION();

	/* now wait for the write lock */
	LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
	LogwrtResult = XLogCtl->Write.LogwrtResult;
	if (!XLByteLE(WriteRqstPtr, LogwrtResult.Flush))
	{
		XLogwrtRqst WriteRqst;

		WriteRqst.Write = WriteRqstPtr;
		WriteRqst.Flush = WriteRqstPtr;
		XLogWrite(WriteRqst, flexible, false);
	}
	LWLockRelease(WALWriteLock);

	END_CRIT_SECTION();
}

1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
/*
 * Flush any previous asynchronously-committed transactions' commit records.
 */
void
XLogAsyncCommitFlush(void)
{
	XLogRecPtr	WriteRqstPtr;
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;

	SpinLockAcquire(&xlogctl->info_lck);
	WriteRqstPtr = xlogctl->asyncCommitLSN;
	SpinLockRelease(&xlogctl->info_lck);

	XLogFlush(WriteRqstPtr);
}

1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905
/*
 * Test whether XLOG data has been flushed up to (at least) the given position.
 *
 * Returns true if a flush is still needed.  (It may be that someone else
 * is already in process of flushing that far, however.)
 */
bool
XLogNeedsFlush(XLogRecPtr record)
{
	/* Quick exit if already known flushed */
	if (XLByteLE(record, LogwrtResult.Flush))
		return false;

	/* read LogwrtResult and update local state */
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

		SpinLockAcquire(&xlogctl->info_lck);
		LogwrtResult = xlogctl->LogwrtResult;
		SpinLockRelease(&xlogctl->info_lck);
	}

	/* check again */
	if (XLByteLE(record, LogwrtResult.Flush))
		return false;

	return true;
}

T
Tom Lane 已提交
1906 1907 1908
/*
 * Create a new XLOG file segment, or open a pre-existing one.
 *
1909 1910 1911
 * log, seg: identify segment to be created/opened.
 *
 * *use_existent: if TRUE, OK to use a pre-existing file (else, any
B
Bruce Momjian 已提交
1912
 * pre-existing file will be deleted).	On return, TRUE if a pre-existing
1913 1914
 * file was used.
 *
1915
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
1916
 * place.  This should be TRUE except during bootstrap log creation.  The
1917
 * caller must *not* hold the lock at call.
1918
 *
T
Tom Lane 已提交
1919
 * Returns FD of opened file.
1920 1921 1922 1923 1924
 *
 * Note: errors here are ERROR not PANIC because we might or might not be
 * inside a critical section (eg, during checkpoint there is no reason to
 * take down the system on failure).  They will promote to PANIC if we are
 * in a critical section.
T
Tom Lane 已提交
1925
 */
1926
static int
1927 1928
XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock)
1929
{
1930
	char		path[MAXPGPATH];
1931
	char		tmppath[MAXPGPATH];
1932
	char	   *zbuffer;
1933 1934 1935
	uint32		installed_log;
	uint32		installed_seg;
	int			max_advance;
1936
	int			fd;
1937
	int			nbytes;
1938

1939
	XLogFilePath(path, ThisTimeLineID, log, seg);
V
Vadim B. Mikheev 已提交
1940 1941

	/*
B
Bruce Momjian 已提交
1942
	 * Try to use existent file (checkpoint maker may have created it already)
V
Vadim B. Mikheev 已提交
1943
	 */
1944
	if (*use_existent)
V
Vadim B. Mikheev 已提交
1945
	{
1946 1947
		fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
						   S_IRUSR | S_IWUSR);
V
Vadim B. Mikheev 已提交
1948 1949 1950
		if (fd < 0)
		{
			if (errno != ENOENT)
1951
				ereport(ERROR,
1952
						(errcode_for_file_access(),
1953
						 errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
1954
								path, log, seg)));
V
Vadim B. Mikheev 已提交
1955 1956
		}
		else
1957
			return fd;
V
Vadim B. Mikheev 已提交
1958 1959
	}

1960
	/*
B
Bruce Momjian 已提交
1961 1962 1963 1964
	 * Initialize an empty (all zeroes) segment.  NOTE: it is possible that
	 * another process is doing the same thing.  If so, we will end up
	 * pre-creating an extra log segment.  That seems OK, and better than
	 * holding the lock throughout this lengthy process.
1965
	 */
1966 1967
	elog(DEBUG2, "creating and filling new WAL file");

1968
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
1969 1970

	unlink(tmppath);
1971

1972
	/* do not use XLOG_SYNC_BIT here --- want to fsync only at end of fill */
1973
	fd = BasicOpenFile(tmppath, O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
T
Tom Lane 已提交
1974
					   S_IRUSR | S_IWUSR);
1975
	if (fd < 0)
1976
		ereport(ERROR,
1977
				(errcode_for_file_access(),
1978
				 errmsg("could not create file \"%s\": %m", tmppath)));
1979

1980
	/*
B
Bruce Momjian 已提交
1981 1982 1983 1984 1985 1986 1987
	 * Zero-fill the file.	We have to do this the hard way to ensure that all
	 * the file space has really been allocated --- on platforms that allow
	 * "holes" in files, just seeking to the end doesn't allocate intermediate
	 * space.  This way, we know that we have all the space and (after the
	 * fsync below) that all the indirect blocks are down on disk.	Therefore,
	 * fdatasync(2) or O_DSYNC will be sufficient to sync future writes to the
	 * log file.
1988 1989 1990 1991
	 *
	 * Note: palloc zbuffer, instead of just using a local char array, to
	 * ensure it is reasonably well-aligned; this may save a few cycles
	 * transferring data to the kernel.
1992
	 */
1993 1994
	zbuffer = (char *) palloc0(XLOG_BLCKSZ);
	for (nbytes = 0; nbytes < XLogSegSize; nbytes += XLOG_BLCKSZ)
1995
	{
1996
		errno = 0;
1997
		if ((int) write(fd, zbuffer, XLOG_BLCKSZ) != (int) XLOG_BLCKSZ)
T
Tom Lane 已提交
1998
		{
B
Bruce Momjian 已提交
1999
			int			save_errno = errno;
T
Tom Lane 已提交
2000

B
Bruce Momjian 已提交
2001
			/*
B
Bruce Momjian 已提交
2002
			 * If we fail to make the file, delete it to release disk space
B
Bruce Momjian 已提交
2003
			 */
2004
			unlink(tmppath);
2005 2006
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;
T
Tom Lane 已提交
2007

2008
			ereport(ERROR,
2009
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2010
					 errmsg("could not write to file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
2011
		}
2012
	}
2013
	pfree(zbuffer);
2014

2015
	if (pg_fsync(fd) != 0)
2016
		ereport(ERROR,
2017
				(errcode_for_file_access(),
2018
				 errmsg("could not fsync file \"%s\": %m", tmppath)));
2019

2020
	if (close(fd))
2021
		ereport(ERROR,
2022 2023
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
2024

2025
	/*
2026 2027
	 * Now move the segment into place with its final name.
	 *
2028
	 * If caller didn't want to use a pre-existing file, get rid of any
B
Bruce Momjian 已提交
2029 2030 2031
	 * pre-existing file.  Otherwise, cope with possibility that someone else
	 * has created the file while we were filling ours: if so, use ours to
	 * pre-create a future log segment.
2032
	 */
2033 2034 2035 2036 2037
	installed_log = log;
	installed_seg = seg;
	max_advance = XLOGfileslop;
	if (!InstallXLogFileSegment(&installed_log, &installed_seg, tmppath,
								*use_existent, &max_advance,
2038 2039 2040 2041 2042 2043
								use_lock))
	{
		/* No need for any more future segments... */
		unlink(tmppath);
	}

2044 2045
	elog(DEBUG2, "done creating and filling new WAL file");

2046 2047 2048 2049 2050 2051 2052
	/* Set flag to tell caller there was no existent file */
	*use_existent = false;

	/* Now open original target segment (might not be file I just made) */
	fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
					   S_IRUSR | S_IWUSR);
	if (fd < 0)
2053
		ereport(ERROR,
2054
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2055 2056
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2057

2058
	return fd;
2059 2060
}

2061 2062 2063 2064 2065 2066 2067 2068 2069
/*
 * Create a new XLOG file segment by copying a pre-existing one.
 *
 * log, seg: identify segment to be created.
 *
 * srcTLI, srclog, srcseg: identify segment to be copied (could be from
 *		a different timeline)
 *
 * Currently this is only used during recovery, and so there are no locking
B
Bruce Momjian 已提交
2070
 * considerations.	But we should be just as tense as XLogFileInit to avoid
2071 2072 2073 2074 2075 2076 2077 2078
 * emplacing a bogus file.
 */
static void
XLogFileCopy(uint32 log, uint32 seg,
			 TimeLineID srcTLI, uint32 srclog, uint32 srcseg)
{
	char		path[MAXPGPATH];
	char		tmppath[MAXPGPATH];
2079
	char		buffer[XLOG_BLCKSZ];
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
	int			srcfd;
	int			fd;
	int			nbytes;

	/*
	 * Open the source file
	 */
	XLogFilePath(path, srcTLI, srclog, srcseg);
	srcfd = BasicOpenFile(path, O_RDONLY | PG_BINARY, 0);
	if (srcfd < 0)
2090
		ereport(ERROR,
2091 2092 2093 2094 2095 2096
				(errcode_for_file_access(),
				 errmsg("could not open file \"%s\": %m", path)));

	/*
	 * Copy into a temp file name.
	 */
2097
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
2098 2099 2100 2101 2102 2103 2104

	unlink(tmppath);

	/* do not use XLOG_SYNC_BIT here --- want to fsync only at end of fill */
	fd = BasicOpenFile(tmppath, O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
					   S_IRUSR | S_IWUSR);
	if (fd < 0)
2105
		ereport(ERROR,
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
				(errcode_for_file_access(),
				 errmsg("could not create file \"%s\": %m", tmppath)));

	/*
	 * Do the data copying.
	 */
	for (nbytes = 0; nbytes < XLogSegSize; nbytes += sizeof(buffer))
	{
		errno = 0;
		if ((int) read(srcfd, buffer, sizeof(buffer)) != (int) sizeof(buffer))
		{
			if (errno != 0)
2118
				ereport(ERROR,
2119 2120 2121
						(errcode_for_file_access(),
						 errmsg("could not read file \"%s\": %m", path)));
			else
2122
				ereport(ERROR,
B
Bruce Momjian 已提交
2123
						(errmsg("not enough data in file \"%s\"", path)));
2124 2125 2126 2127 2128 2129 2130
		}
		errno = 0;
		if ((int) write(fd, buffer, sizeof(buffer)) != (int) sizeof(buffer))
		{
			int			save_errno = errno;

			/*
B
Bruce Momjian 已提交
2131
			 * If we fail to make the file, delete it to release disk space
2132 2133 2134 2135 2136
			 */
			unlink(tmppath);
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;

2137
			ereport(ERROR,
2138
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2139
					 errmsg("could not write to file \"%s\": %m", tmppath)));
2140 2141 2142 2143
		}
	}

	if (pg_fsync(fd) != 0)
2144
		ereport(ERROR,
2145 2146 2147 2148
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

	if (close(fd))
2149
		ereport(ERROR,
2150 2151 2152 2153 2154 2155 2156 2157
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));

	close(srcfd);

	/*
	 * Now move the segment into place with its final name.
	 */
2158
	if (!InstallXLogFileSegment(&log, &seg, tmppath, false, NULL, false))
2159
		elog(ERROR, "InstallXLogFileSegment should not have failed");
2160 2161
}

2162 2163 2164 2165 2166 2167
/*
 * Install a new XLOG segment file as a current or future log segment.
 *
 * This is used both to install a newly-created segment (which has a temp
 * filename while it's being created) and to recycle an old segment.
 *
2168 2169 2170
 * *log, *seg: identify segment to install as (or first possible target).
 * When find_free is TRUE, these are modified on return to indicate the
 * actual installation location or last segment searched.
2171 2172 2173 2174 2175 2176 2177
 *
 * tmppath: initial name of file to install.  It will be renamed into place.
 *
 * find_free: if TRUE, install the new segment at the first empty log/seg
 * number at or after the passed numbers.  If FALSE, install the new segment
 * exactly where specified, deleting any existing segment file there.
 *
2178 2179 2180 2181
 * *max_advance: maximum number of log/seg slots to advance past the starting
 * point.  Fail if no free slot is found in this range.  On return, reduced
 * by the number of slots skipped over.  (Irrelevant, and may be NULL,
 * when find_free is FALSE.)
2182
 *
2183
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
2184
 * place.  This should be TRUE except during bootstrap log creation.  The
2185
 * caller must *not* hold the lock at call.
2186 2187
 *
 * Returns TRUE if file installed, FALSE if not installed because of
2188 2189 2190
 * exceeding max_advance limit.  On Windows, we also return FALSE if we
 * can't rename the file into place because someone's got it open.
 * (Any other kind of failure causes ereport().)
2191 2192
 */
static bool
2193 2194
InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
2195 2196 2197
					   bool use_lock)
{
	char		path[MAXPGPATH];
2198
	struct stat stat_buf;
2199

2200
	XLogFilePath(path, ThisTimeLineID, *log, *seg);
2201 2202 2203 2204 2205

	/*
	 * We want to be sure that only one process does this at a time.
	 */
	if (use_lock)
2206
		LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
2207

2208 2209 2210 2211 2212
	if (!find_free)
	{
		/* Force installation: get rid of any pre-existing segment file */
		unlink(path);
	}
2213 2214
	else
	{
2215
		/* Find a free slot to put it in */
2216
		while (stat(path, &stat_buf) == 0)
2217
		{
2218
			if (*max_advance <= 0)
2219 2220 2221
			{
				/* Failed to find a free slot within specified range */
				if (use_lock)
2222
					LWLockRelease(ControlFileLock);
2223 2224
				return false;
			}
2225 2226 2227
			NextLogSeg(*log, *seg);
			(*max_advance)--;
			XLogFilePath(path, ThisTimeLineID, *log, *seg);
2228 2229 2230 2231 2232 2233 2234
		}
	}

	/*
	 * Prefer link() to rename() here just to be really sure that we don't
	 * overwrite an existing logfile.  However, there shouldn't be one, so
	 * rename() is an acceptable substitute except for the truly paranoid.
2235
	 */
2236
#if HAVE_WORKING_LINK
2237
	if (link(tmppath, path) < 0)
2238
		ereport(ERROR,
2239
				(errcode_for_file_access(),
2240
				 errmsg("could not link file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2241
						tmppath, path, *log, *seg)));
2242
	unlink(tmppath);
2243
#else
2244
	if (rename(tmppath, path) < 0)
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
	{
#ifdef WIN32
#if !defined(__CYGWIN__)
		if (GetLastError() == ERROR_ACCESS_DENIED)
#else
		if (errno == EACCES)
#endif
		{
			if (use_lock)
				LWLockRelease(ControlFileLock);
			return false;
		}
#endif /* WIN32 */

2259
		ereport(ERROR,
2260
				(errcode_for_file_access(),
2261
				 errmsg("could not rename file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2262
						tmppath, path, *log, *seg)));
2263
	}
2264
#endif
V
Vadim B. Mikheev 已提交
2265

2266
	if (use_lock)
2267
		LWLockRelease(ControlFileLock);
2268

2269
	return true;
2270 2271
}

T
Tom Lane 已提交
2272
/*
2273
 * Open a pre-existing logfile segment for writing.
T
Tom Lane 已提交
2274
 */
2275
static int
2276
XLogFileOpen(uint32 log, uint32 seg)
2277
{
2278 2279
	char		path[MAXPGPATH];
	int			fd;
2280

2281
	XLogFilePath(path, ThisTimeLineID, log, seg);
2282

2283 2284
	fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
					   S_IRUSR | S_IWUSR);
2285
	if (fd < 0)
2286 2287
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2288 2289
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303

	return fd;
}

/*
 * Open a logfile segment for reading (during recovery).
 */
static int
XLogFileRead(uint32 log, uint32 seg, int emode)
{
	char		path[MAXPGPATH];
	char		xlogfname[MAXFNAMELEN];
	ListCell   *cell;
	int			fd;
2304

2305
	/*
B
Bruce Momjian 已提交
2306 2307
	 * Loop looking for a suitable timeline ID: we might need to read any of
	 * the timelines listed in expectedTLIs.
2308
	 *
B
Bruce Momjian 已提交
2309
	 * We expect curFileTLI on entry to be the TLI of the preceding file in
B
Bruce Momjian 已提交
2310 2311 2312 2313
	 * sequence, or 0 if there was no predecessor.	We do not allow curFileTLI
	 * to go backwards; this prevents us from picking up the wrong file when a
	 * parent timeline extends to higher segment numbers than the child we
	 * want to read.
2314
	 */
2315 2316 2317
	foreach(cell, expectedTLIs)
	{
		TimeLineID	tli = (TimeLineID) lfirst_int(cell);
2318

2319 2320 2321 2322 2323 2324 2325
		if (tli < curFileTLI)
			break;				/* don't bother looking at too-old TLIs */

		if (InArchiveRecovery)
		{
			XLogFileName(xlogfname, tli, log, seg);
			restoredFromArchive = RestoreArchivedFile(path, xlogfname,
2326 2327
													  "RECOVERYXLOG",
													  XLogSegSize);
2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341
		}
		else
			XLogFilePath(path, tli, log, seg);

		fd = BasicOpenFile(path, O_RDONLY | PG_BINARY, 0);
		if (fd >= 0)
		{
			/* Success! */
			curFileTLI = tli;
			return fd;
		}
		if (errno != ENOENT)	/* unexpected failure? */
			ereport(PANIC,
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2342 2343
			errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				   path, log, seg)));
2344 2345 2346 2347 2348 2349 2350
	}

	/* Couldn't find it.  For simplicity, complain about front timeline */
	XLogFilePath(path, recoveryTargetTLI, log, seg);
	errno = ENOENT;
	ereport(emode,
			(errcode_for_file_access(),
B
Bruce Momjian 已提交
2351 2352
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2353
	return -1;
2354 2355
}

2356 2357 2358 2359 2360 2361 2362 2363
/*
 * Close the current logfile segment for writing.
 */
static void
XLogFileClose(void)
{
	Assert(openLogFile >= 0);

2364
	/*
B
Bruce Momjian 已提交
2365 2366 2367 2368 2369 2370
	 * posix_fadvise is problematic on many platforms: on older x86 Linux it
	 * just dumps core, and there are reports of problems on PPC platforms as
	 * well.  The following is therefore disabled for the time being. We could
	 * consider some kind of configure test to see if it's safe to use, but
	 * since we lack hard evidence that there's any useful performance gain to
	 * be had, spending time on that seems unprofitable for now.
2371 2372 2373
	 */
#ifdef NOT_USED

2374
	/*
2375
	 * WAL segment files will not be re-read in normal operation, so we advise
B
Bruce Momjian 已提交
2376
	 * OS to release any cached pages.	But do not do so if WAL archiving is
2377 2378 2379
	 * active, because archiver process could use the cache to read the WAL
	 * segment.
	 *
B
Bruce Momjian 已提交
2380 2381
	 * While O_DIRECT works for O_SYNC, posix_fadvise() works for fsync() and
	 * O_SYNC, and some platforms only have posix_fadvise().
2382
	 */
2383
#if defined(HAVE_DECL_POSIX_FADVISE) && defined(POSIX_FADV_DONTNEED)
2384 2385 2386
	if (!XLogArchivingActive())
		posix_fadvise(openLogFile, 0, 0, POSIX_FADV_DONTNEED);
#endif
B
Bruce Momjian 已提交
2387
#endif   /* NOT_USED */
2388

2389 2390
	if (close(openLogFile))
		ereport(PANIC,
B
Bruce Momjian 已提交
2391 2392 2393
				(errcode_for_file_access(),
				 errmsg("could not close log file %u, segment %u: %m",
						openLogId, openLogSeg)));
2394 2395 2396
	openLogFile = -1;
}

2397
/*
2398
 * Attempt to retrieve the specified file from off-line archival storage.
2399
 * If successful, fill "path" with its complete path (note that this will be
2400 2401
 * a temp file name that doesn't follow the normal naming convention), and
 * return TRUE.
2402
 *
2403 2404 2405
 * If not successful, fill "path" with the name of the normal on-line file
 * (which may or may not actually exist, but we'll try to use it), and return
 * FALSE.
2406 2407 2408 2409
 *
 * For fixed-size files, the caller may pass the expected size as an
 * additional crosscheck on successful recovery.  If the file size is not
 * known, set expectedSize = 0.
2410
 */
2411 2412
static bool
RestoreArchivedFile(char *path, const char *xlogfname,
2413
					const char *recovername, off_t expectedSize)
2414
{
B
Bruce Momjian 已提交
2415 2416 2417 2418
	char		xlogpath[MAXPGPATH];
	char		xlogRestoreCmd[MAXPGPATH];
	char	   *dp;
	char	   *endp;
2419
	const char *sp;
B
Bruce Momjian 已提交
2420
	int			rc;
2421
	bool		signaled;
2422 2423 2424
	struct stat stat_buf;

	/*
B
Bruce Momjian 已提交
2425 2426 2427 2428
	 * When doing archive recovery, we always prefer an archived log file even
	 * if a file of the same name exists in XLOGDIR.  The reason is that the
	 * file in XLOGDIR could be an old, un-filled or partly-filled version
	 * that was copied and restored as part of backing up $PGDATA.
2429
	 *
B
Bruce Momjian 已提交
2430
	 * We could try to optimize this slightly by checking the local copy
B
Bruce Momjian 已提交
2431 2432 2433 2434
	 * lastchange timestamp against the archived copy, but we have no API to
	 * do this, nor can we guarantee that the lastchange timestamp was
	 * preserved correctly when we copied to archive. Our aim is robustness,
	 * so we elect not to do this.
2435
	 *
2436 2437 2438
	 * If we cannot obtain the log file from the archive, however, we will try
	 * to use the XLOGDIR file if it exists.  This is so that we can make use
	 * of log segments that weren't yet transferred to the archive.
2439
	 *
2440 2441 2442 2443
	 * Notice that we don't actually overwrite any files when we copy back
	 * from archive because the recoveryRestoreCommand may inadvertently
	 * restore inappropriate xlogs, or they may be corrupt, so we may wish to
	 * fallback to the segments remaining in current XLOGDIR later. The
B
Bruce Momjian 已提交
2444 2445
	 * copy-from-archive filename is always the same, ensuring that we don't
	 * run out of disk space on long recoveries.
2446
	 */
2447
	snprintf(xlogpath, MAXPGPATH, XLOGDIR "/%s", recovername);
2448 2449

	/*
2450
	 * Make sure there is no existing file named recovername.
2451 2452 2453 2454 2455 2456
	 */
	if (stat(xlogpath, &stat_buf) != 0)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
2457
					 errmsg("could not stat file \"%s\": %m",
2458 2459 2460 2461 2462 2463 2464
							xlogpath)));
	}
	else
	{
		if (unlink(xlogpath) != 0)
			ereport(FATAL,
					(errcode_for_file_access(),
2465
					 errmsg("could not remove file \"%s\": %m",
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482
							xlogpath)));
	}

	/*
	 * construct the command to be executed
	 */
	dp = xlogRestoreCmd;
	endp = xlogRestoreCmd + MAXPGPATH - 1;
	*endp = '\0';

	for (sp = recoveryRestoreCommand; *sp; sp++)
	{
		if (*sp == '%')
		{
			switch (sp[1])
			{
				case 'p':
2483
					/* %p: relative path of target file */
2484
					sp++;
B
Bruce Momjian 已提交
2485
					StrNCpy(dp, xlogpath, endp - dp);
2486
					make_native_path(dp);
2487 2488 2489 2490 2491
					dp += strlen(dp);
					break;
				case 'f':
					/* %f: filename of desired file */
					sp++;
B
Bruce Momjian 已提交
2492
					StrNCpy(dp, xlogfname, endp - dp);
2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516
					dp += strlen(dp);
					break;
				case '%':
					/* convert %% to a single % */
					sp++;
					if (dp < endp)
						*dp++ = *sp;
					break;
				default:
					/* otherwise treat the % as not special */
					if (dp < endp)
						*dp++ = *sp;
					break;
			}
		}
		else
		{
			if (dp < endp)
				*dp++ = *sp;
		}
	}
	*dp = '\0';

	ereport(DEBUG3,
B
Bruce Momjian 已提交
2517
			(errmsg_internal("executing restore command \"%s\"",
2518 2519 2520
							 xlogRestoreCmd)));

	/*
2521
	 * Copy xlog from archival storage to XLOGDIR
2522 2523 2524 2525
	 */
	rc = system(xlogRestoreCmd);
	if (rc == 0)
	{
2526 2527 2528 2529
		/*
		 * command apparently succeeded, but let's make sure the file is
		 * really there now and has the correct size.
		 *
2530 2531 2532 2533 2534
		 * XXX I made wrong-size a fatal error to ensure the DBA would notice
		 * it, but is that too strong?	We could try to plow ahead with a
		 * local copy of the file ... but the problem is that there probably
		 * isn't one, and we'd incorrectly conclude we've reached the end of
		 * WAL and we're done recovering ...
2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
		 */
		if (stat(xlogpath, &stat_buf) == 0)
		{
			if (expectedSize > 0 && stat_buf.st_size != expectedSize)
				ereport(FATAL,
						(errmsg("archive file \"%s\" has wrong size: %lu instead of %lu",
								xlogfname,
								(unsigned long) stat_buf.st_size,
								(unsigned long) expectedSize)));
			else
			{
				ereport(LOG,
						(errmsg("restored log file \"%s\" from archive",
								xlogfname)));
				strcpy(path, xlogpath);
				return true;
			}
		}
		else
		{
			/* stat failed */
			if (errno != ENOENT)
				ereport(FATAL,
						(errcode_for_file_access(),
P
Peter Eisentraut 已提交
2559
						 errmsg("could not stat file \"%s\": %m",
2560
								xlogpath)));
2561 2562 2563 2564
		}
	}

	/*
2565
	 * Remember, we rollforward UNTIL the restore fails so failure here is
B
Bruce Momjian 已提交
2566
	 * just part of the process... that makes it difficult to determine
B
Bruce Momjian 已提交
2567 2568 2569
	 * whether the restore failed because there isn't an archive to restore,
	 * or because the administrator has specified the restore program
	 * incorrectly.  We have to assume the former.
2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582
	 *
	 * However, if the failure was due to any sort of signal, it's best to
	 * punt and abort recovery.  (If we "return false" here, upper levels
	 * will assume that recovery is complete and start up the database!)
	 * It's essential to abort on child SIGINT and SIGQUIT, because per spec
	 * system() ignores SIGINT and SIGQUIT while waiting; if we see one of
	 * those it's a good bet we should have gotten it too.  Aborting on other
	 * signals such as SIGTERM seems a good idea as well.
	 *
	 * Per the Single Unix Spec, shells report exit status > 128 when
	 * a called command died on a signal.  Also, 126 and 127 are used to
	 * report problems such as an unfindable command; treat those as fatal
	 * errors too.
2583
	 */
2584 2585 2586
	signaled = WIFSIGNALED(rc) || WEXITSTATUS(rc) > 125;

	ereport(signaled ? FATAL : DEBUG2,
B
Bruce Momjian 已提交
2587 2588
		(errmsg("could not restore file \"%s\" from archive: return code %d",
				xlogfname, rc)));
2589 2590

	/*
B
Bruce Momjian 已提交
2591 2592
	 * if an archived file is not available, there might still be a version of
	 * this file in XLOGDIR, so return that as the filename to open.
2593
	 *
B
Bruce Momjian 已提交
2594 2595
	 * In many recovery scenarios we expect this to fail also, but if so that
	 * just means we've reached the end of WAL.
2596
	 */
2597
	snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlogfname);
2598
	return false;
2599 2600
}

V
Vadim B. Mikheev 已提交
2601
/*
2602 2603 2604 2605 2606 2607 2608 2609
 * Preallocate log files beyond the specified log endpoint.
 *
 * XXX this is currently extremely conservative, since it forces only one
 * future log segment to exist, and even that only if we are 75% done with
 * the current one.  This is only appropriate for very low-WAL-volume systems.
 * High-volume systems will be OK once they've built up a sufficient set of
 * recycled log segments, but the startup transient is likely to include
 * a lot of segment creations by foreground processes, which is not so good.
T
Tom Lane 已提交
2610
 */
2611
static void
T
Tom Lane 已提交
2612 2613 2614 2615 2616
PreallocXlogFiles(XLogRecPtr endptr)
{
	uint32		_logId;
	uint32		_logSeg;
	int			lf;
2617
	bool		use_existent;
T
Tom Lane 已提交
2618 2619

	XLByteToPrevSeg(endptr, _logId, _logSeg);
B
Bruce Momjian 已提交
2620
	if ((endptr.xrecoff - 1) % XLogSegSize >=
B
Bruce Momjian 已提交
2621
		(uint32) (0.75 * XLogSegSize))
T
Tom Lane 已提交
2622 2623
	{
		NextLogSeg(_logId, _logSeg);
2624 2625
		use_existent = true;
		lf = XLogFileInit(_logId, _logSeg, &use_existent, true);
T
Tom Lane 已提交
2626
		close(lf);
2627
		if (!use_existent)
2628
			CheckpointStats.ckpt_segs_added++;
T
Tom Lane 已提交
2629 2630 2631 2632
	}
}

/*
2633
 * Recycle or remove all log files older or equal to passed log/seg#
2634 2635 2636
 *
 * endptr is current (or recent) end of xlog; this is used to determine
 * whether we want to recycle rather than delete no-longer-wanted log files.
V
Vadim B. Mikheev 已提交
2637 2638
 */
static void
2639
RemoveOldXlogFiles(uint32 log, uint32 seg, XLogRecPtr endptr)
V
Vadim B. Mikheev 已提交
2640
{
2641 2642
	uint32		endlogId;
	uint32		endlogSeg;
2643
	int			max_advance;
B
Bruce Momjian 已提交
2644 2645
	DIR		   *xldir;
	struct dirent *xlde;
2646
	char		lastoff[MAXFNAMELEN];
B
Bruce Momjian 已提交
2647
	char		path[MAXPGPATH];
V
Vadim B. Mikheev 已提交
2648

2649 2650 2651 2652
	/*
	 * Initialize info about where to try to recycle to.  We allow recycling
	 * segments up to XLOGfileslop segments beyond the current XLOG location.
	 */
2653
	XLByteToPrevSeg(endptr, endlogId, endlogSeg);
2654
	max_advance = XLOGfileslop;
V
Vadim B. Mikheev 已提交
2655

2656
	xldir = AllocateDir(XLOGDIR);
V
Vadim B. Mikheev 已提交
2657
	if (xldir == NULL)
2658
		ereport(ERROR,
2659
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2660 2661
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
V
Vadim B. Mikheev 已提交
2662

2663
	XLogFileName(lastoff, ThisTimeLineID, log, seg);
V
Vadim B. Mikheev 已提交
2664

2665
	while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
V
Vadim B. Mikheev 已提交
2666
	{
2667
		/*
2668
		 * We ignore the timeline part of the XLOG segment identifiers in
B
Bruce Momjian 已提交
2669 2670 2671 2672 2673
		 * deciding whether a segment is still needed.	This ensures that we
		 * won't prematurely remove a segment from a parent timeline. We could
		 * probably be a little more proactive about removing segments of
		 * non-parent timelines, but that would be a whole lot more
		 * complicated.
2674
		 *
B
Bruce Momjian 已提交
2675 2676
		 * We use the alphanumeric sorting property of the filenames to decide
		 * which ones are earlier than the lastoff segment.
2677
		 */
2678 2679 2680
		if (strlen(xlde->d_name) == 24 &&
			strspn(xlde->d_name, "0123456789ABCDEF") == 24 &&
			strcmp(xlde->d_name + 8, lastoff + 8) <= 0)
V
Vadim B. Mikheev 已提交
2681
		{
2682
			if (XLogArchiveCheckDone(xlde->d_name))
2683
			{
2684
				snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlde->d_name);
2685

2686
				/*
B
Bruce Momjian 已提交
2687 2688
				 * Before deleting the file, see if it can be recycled as a
				 * future log segment.
2689
				 */
2690 2691
				if (InstallXLogFileSegment(&endlogId, &endlogSeg, path,
										   true, &max_advance,
2692 2693
										   true))
				{
2694
					ereport(DEBUG2,
B
Bruce Momjian 已提交
2695 2696
							(errmsg("recycled transaction log file \"%s\"",
									xlde->d_name)));
2697
					CheckpointStats.ckpt_segs_recycled++;
2698 2699 2700 2701 2702 2703
					/* Needn't recheck that slot on future iterations */
					if (max_advance > 0)
					{
						NextLogSeg(endlogId, endlogSeg);
						max_advance--;
					}
2704 2705 2706 2707
				}
				else
				{
					/* No need for any more future segments... */
2708
					ereport(DEBUG2,
B
Bruce Momjian 已提交
2709 2710
							(errmsg("removing transaction log file \"%s\"",
									xlde->d_name)));
2711
					unlink(path);
2712
					CheckpointStats.ckpt_segs_removed++;
2713
				}
2714 2715

				XLogArchiveCleanup(xlde->d_name);
2716
			}
V
Vadim B. Mikheev 已提交
2717 2718
		}
	}
B
Bruce Momjian 已提交
2719

2720
	FreeDir(xldir);
V
Vadim B. Mikheev 已提交
2721 2722
}

2723
/*
2724 2725 2726
 * Remove previous backup history files.  This also retries creation of
 * .ready files for any backup history files for which XLogArchiveNotify
 * failed earlier.
2727 2728
 */
static void
2729
CleanupBackupHistory(void)
2730 2731 2732 2733 2734
{
	DIR		   *xldir;
	struct dirent *xlde;
	char		path[MAXPGPATH];

2735
	xldir = AllocateDir(XLOGDIR);
2736 2737 2738
	if (xldir == NULL)
		ereport(ERROR,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2739 2740
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
2741

2742
	while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
2743 2744 2745 2746 2747 2748
	{
		if (strlen(xlde->d_name) > 24 &&
			strspn(xlde->d_name, "0123456789ABCDEF") == 24 &&
			strcmp(xlde->d_name + strlen(xlde->d_name) - strlen(".backup"),
				   ".backup") == 0)
		{
2749
			if (XLogArchiveCheckDone(xlde->d_name))
2750 2751
			{
				ereport(DEBUG2,
B
Bruce Momjian 已提交
2752 2753
				(errmsg("removing transaction log backup history file \"%s\"",
						xlde->d_name)));
2754
				snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlde->d_name);
2755 2756 2757 2758 2759 2760 2761 2762 2763
				unlink(path);
				XLogArchiveCleanup(xlde->d_name);
			}
		}
	}

	FreeDir(xldir);
}

T
Tom Lane 已提交
2764 2765 2766 2767
/*
 * Restore the backup blocks present in an XLOG record, if any.
 *
 * We assume all of the record has been read into memory at *record.
2768 2769 2770 2771 2772 2773 2774 2775 2776
 *
 * Note: when a backup block is available in XLOG, we restore it
 * unconditionally, even if the page in the database appears newer.
 * This is to protect ourselves against database pages that were partially
 * or incorrectly written during a crash.  We assume that the XLOG data
 * must be good because it has passed a CRC check, while the database
 * page might not be.  This will force us to replay all subsequent
 * modifications of the page that appear in XLOG, rather than possibly
 * ignoring them as already applied, but that's not a huge drawback.
T
Tom Lane 已提交
2777
 */
2778 2779 2780 2781 2782 2783 2784 2785 2786 2787
static void
RestoreBkpBlocks(XLogRecord *record, XLogRecPtr lsn)
{
	Relation	reln;
	Buffer		buffer;
	Page		page;
	BkpBlock	bkpb;
	char	   *blk;
	int			i;

B
Bruce Momjian 已提交
2788
	blk = (char *) XLogRecGetData(record) + record->xl_len;
T
Tom Lane 已提交
2789
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2790
	{
T
Tom Lane 已提交
2791
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2792 2793
			continue;

2794
		memcpy(&bkpb, blk, sizeof(BkpBlock));
2795 2796
		blk += sizeof(BkpBlock);

2797
		reln = XLogOpenRelation(bkpb.node);
2798 2799 2800
		buffer = XLogReadBuffer(reln, bkpb.block, true);
		Assert(BufferIsValid(buffer));
		page = (Page) BufferGetPage(buffer);
2801

2802
		if (bkpb.hole_length == 0)
2803
		{
2804 2805 2806 2807 2808 2809 2810 2811 2812 2813
			memcpy((char *) page, blk, BLCKSZ);
		}
		else
		{
			/* must zero-fill the hole */
			MemSet((char *) page, 0, BLCKSZ);
			memcpy((char *) page, blk, bkpb.hole_offset);
			memcpy((char *) page + (bkpb.hole_offset + bkpb.hole_length),
				   blk + bkpb.hole_offset,
				   BLCKSZ - (bkpb.hole_offset + bkpb.hole_length));
2814 2815
		}

2816 2817
		PageSetLSN(page, lsn);
		PageSetTLI(page, ThisTimeLineID);
2818 2819
		MarkBufferDirty(buffer);
		UnlockReleaseBuffer(buffer);
2820

2821
		blk += BLCKSZ - bkpb.hole_length;
2822 2823 2824
	}
}

T
Tom Lane 已提交
2825 2826 2827 2828 2829 2830 2831
/*
 * CRC-check an XLOG record.  We do not believe the contents of an XLOG
 * record (other than to the minimal extent of computing the amount of
 * data to read in) until we've checked the CRCs.
 *
 * We assume all of the record has been read into memory at *record.
 */
2832 2833 2834
static bool
RecordIsValid(XLogRecord *record, XLogRecPtr recptr, int emode)
{
2835
	pg_crc32	crc;
2836 2837
	int			i;
	uint32		len = record->xl_len;
2838
	BkpBlock	bkpb;
2839 2840
	char	   *blk;

2841 2842 2843
	/* First the rmgr data */
	INIT_CRC32(crc);
	COMP_CRC32(crc, XLogRecGetData(record), len);
2844

2845
	/* Add in the backup blocks, if any */
B
Bruce Momjian 已提交
2846
	blk = (char *) XLogRecGetData(record) + len;
T
Tom Lane 已提交
2847
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2848
	{
B
Bruce Momjian 已提交
2849
		uint32		blen;
2850

T
Tom Lane 已提交
2851
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2852 2853
			continue;

2854 2855
		memcpy(&bkpb, blk, sizeof(BkpBlock));
		if (bkpb.hole_offset + bkpb.hole_length > BLCKSZ)
2856
		{
2857
			ereport(emode,
2858 2859 2860
					(errmsg("incorrect hole size in record at %X/%X",
							recptr.xlogid, recptr.xrecoff)));
			return false;
2861
		}
2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883
		blen = sizeof(BkpBlock) + BLCKSZ - bkpb.hole_length;
		COMP_CRC32(crc, blk, blen);
		blk += blen;
	}

	/* Check that xl_tot_len agrees with our calculation */
	if (blk != (char *) record + record->xl_tot_len)
	{
		ereport(emode,
				(errmsg("incorrect total length in record at %X/%X",
						recptr.xlogid, recptr.xrecoff)));
		return false;
	}

	/* Finally include the record header */
	COMP_CRC32(crc, (char *) record + sizeof(pg_crc32),
			   SizeOfXLogRecord - sizeof(pg_crc32));
	FIN_CRC32(crc);

	if (!EQ_CRC32(record->xl_crc, crc))
	{
		ereport(emode,
B
Bruce Momjian 已提交
2884 2885
		(errmsg("incorrect resource manager data checksum in record at %X/%X",
				recptr.xlogid, recptr.xrecoff)));
2886
		return false;
2887 2888
	}

2889
	return true;
2890 2891
}

T
Tom Lane 已提交
2892 2893 2894 2895 2896 2897
/*
 * Attempt to read an XLOG record.
 *
 * If RecPtr is not NULL, try to read a record at that position.  Otherwise
 * try to read a record just after the last one previously read.
 *
2898 2899
 * If no valid record is available, returns NULL, or fails if emode is PANIC.
 * (emode must be either PANIC or LOG.)
T
Tom Lane 已提交
2900
 *
2901 2902
 * The record is copied into readRecordBuf, so that on successful return,
 * the returned record pointer always points there.
T
Tom Lane 已提交
2903
 */
2904
static XLogRecord *
2905
ReadRecord(XLogRecPtr *RecPtr, int emode)
2906
{
2907
	XLogRecord *record;
2908
	char	   *buffer;
2909
	XLogRecPtr	tmpRecPtr = EndRecPtr;
2910
	bool		randAccess = false;
T
Tom Lane 已提交
2911 2912 2913
	uint32		len,
				total_len;
	uint32		targetPageOff;
2914 2915
	uint32		targetRecOff;
	uint32		pageHeaderSize;
T
Tom Lane 已提交
2916 2917 2918 2919

	if (readBuf == NULL)
	{
		/*
B
Bruce Momjian 已提交
2920 2921 2922 2923 2924
		 * First time through, permanently allocate readBuf.  We do it this
		 * way, rather than just making a static array, for two reasons: (1)
		 * no need to waste the storage in most instantiations of the backend;
		 * (2) a static char array isn't guaranteed to have any particular
		 * alignment, whereas malloc() will provide MAXALIGN'd storage.
T
Tom Lane 已提交
2925
		 */
2926
		readBuf = (char *) malloc(XLOG_BLCKSZ);
T
Tom Lane 已提交
2927 2928
		Assert(readBuf != NULL);
	}
2929

T
Tom Lane 已提交
2930
	if (RecPtr == NULL)
2931
	{
2932
		RecPtr = &tmpRecPtr;
T
Tom Lane 已提交
2933
		/* fast case if next record is on same page */
2934 2935 2936 2937 2938
		if (nextRecord != NULL)
		{
			record = nextRecord;
			goto got_record;
		}
T
Tom Lane 已提交
2939
		/* align old recptr to next page */
2940 2941
		if (tmpRecPtr.xrecoff % XLOG_BLCKSZ != 0)
			tmpRecPtr.xrecoff += (XLOG_BLCKSZ - tmpRecPtr.xrecoff % XLOG_BLCKSZ);
2942 2943 2944 2945 2946
		if (tmpRecPtr.xrecoff >= XLogFileSize)
		{
			(tmpRecPtr.xlogid)++;
			tmpRecPtr.xrecoff = 0;
		}
2947 2948 2949 2950 2951 2952 2953 2954
		/* We will account for page header size below */
	}
	else
	{
		if (!XRecOffIsValid(RecPtr->xrecoff))
			ereport(PANIC,
					(errmsg("invalid record offset at %X/%X",
							RecPtr->xlogid, RecPtr->xrecoff)));
B
Bruce Momjian 已提交
2955

2956
		/*
B
Bruce Momjian 已提交
2957 2958 2959 2960 2961
		 * Since we are going to a random position in WAL, forget any prior
		 * state about what timeline we were in, and allow it to be any
		 * timeline in expectedTLIs.  We also set a flag to allow curFileTLI
		 * to go backwards (but we can't reset that variable right here, since
		 * we might not change files at all).
2962 2963 2964
		 */
		lastPageTLI = 0;		/* see comment in ValidXLOGHeader */
		randAccess = true;		/* allow curFileTLI to go backwards too */
2965 2966
	}

T
Tom Lane 已提交
2967
	if (readFile >= 0 && !XLByteInSeg(*RecPtr, readId, readSeg))
2968
	{
2969 2970
		close(readFile);
		readFile = -1;
2971
	}
T
Tom Lane 已提交
2972
	XLByteToSeg(*RecPtr, readId, readSeg);
2973
	if (readFile < 0)
2974
	{
2975 2976 2977 2978 2979
		/* Now it's okay to reset curFileTLI if random fetch */
		if (randAccess)
			curFileTLI = 0;

		readFile = XLogFileRead(readId, readSeg, emode);
2980 2981
		if (readFile < 0)
			goto next_record_is_invalid;
2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000

		/*
		 * Whenever switching to a new WAL segment, we read the first page of
		 * the file and validate its header, even if that's not where the
		 * target record is.  This is so that we can check the additional
		 * identification info that is present in the first page's "long"
		 * header.
		 */
		readOff = 0;
		if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
		{
			ereport(emode,
					(errcode_for_file_access(),
					 errmsg("could not read from log file %u, segment %u, offset %u: %m",
							readId, readSeg, readOff)));
			goto next_record_is_invalid;
		}
		if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
			goto next_record_is_invalid;
3001 3002
	}

3003
	targetPageOff = ((RecPtr->xrecoff % XLogSegSize) / XLOG_BLCKSZ) * XLOG_BLCKSZ;
T
Tom Lane 已提交
3004
	if (readOff != targetPageOff)
3005
	{
T
Tom Lane 已提交
3006 3007 3008
		readOff = targetPageOff;
		if (lseek(readFile, (off_t) readOff, SEEK_SET) < 0)
		{
3009 3010
			ereport(emode,
					(errcode_for_file_access(),
3011
					 errmsg("could not seek in log file %u, segment %u to offset %u: %m",
3012
							readId, readSeg, readOff)));
T
Tom Lane 已提交
3013 3014
			goto next_record_is_invalid;
		}
3015
		if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
T
Tom Lane 已提交
3016
		{
3017 3018
			ereport(emode,
					(errcode_for_file_access(),
3019
					 errmsg("could not read from log file %u, segment %u, offset %u: %m",
3020
							readId, readSeg, readOff)));
T
Tom Lane 已提交
3021 3022
			goto next_record_is_invalid;
		}
3023
		if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
3024 3025
			goto next_record_is_invalid;
	}
3026
	pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
3027
	targetRecOff = RecPtr->xrecoff % XLOG_BLCKSZ;
3028 3029 3030
	if (targetRecOff == 0)
	{
		/*
B
Bruce Momjian 已提交
3031 3032 3033
		 * Can only get here in the continuing-from-prev-page case, because
		 * XRecOffIsValid eliminated the zero-page-offset case otherwise. Need
		 * to skip over the new page's header.
3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044
		 */
		tmpRecPtr.xrecoff += pageHeaderSize;
		targetRecOff = pageHeaderSize;
	}
	else if (targetRecOff < pageHeaderSize)
	{
		ereport(emode,
				(errmsg("invalid record offset at %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
		goto next_record_is_invalid;
	}
T
Tom Lane 已提交
3045
	if ((((XLogPageHeader) readBuf)->xlp_info & XLP_FIRST_IS_CONTRECORD) &&
3046
		targetRecOff == pageHeaderSize)
3047
	{
3048 3049 3050
		ereport(emode,
				(errmsg("contrecord is requested by %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
3051 3052
		goto next_record_is_invalid;
	}
3053
	record = (XLogRecord *) ((char *) readBuf + RecPtr->xrecoff % XLOG_BLCKSZ);
3054 3055

got_record:;
B
Bruce Momjian 已提交
3056

T
Tom Lane 已提交
3057
	/*
B
Bruce Momjian 已提交
3058 3059
	 * xl_len == 0 is bad data for everything except XLOG SWITCH, where it is
	 * required.
T
Tom Lane 已提交
3060
	 */
3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071
	if (record->xl_rmid == RM_XLOG_ID && record->xl_info == XLOG_SWITCH)
	{
		if (record->xl_len != 0)
		{
			ereport(emode,
					(errmsg("invalid xlog switch record at %X/%X",
							RecPtr->xlogid, RecPtr->xrecoff)));
			goto next_record_is_invalid;
		}
	}
	else if (record->xl_len == 0)
3072
	{
3073 3074 3075
		ereport(emode,
				(errmsg("record with zero length at %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
3076 3077
		goto next_record_is_invalid;
	}
3078 3079 3080 3081 3082 3083 3084 3085 3086
	if (record->xl_tot_len < SizeOfXLogRecord + record->xl_len ||
		record->xl_tot_len > SizeOfXLogRecord + record->xl_len +
		XLR_MAX_BKP_BLOCKS * (sizeof(BkpBlock) + BLCKSZ))
	{
		ereport(emode,
				(errmsg("invalid record length at %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
		goto next_record_is_invalid;
	}
3087 3088 3089 3090
	if (record->xl_rmid > RM_MAX_ID)
	{
		ereport(emode,
				(errmsg("invalid resource manager ID %u at %X/%X",
B
Bruce Momjian 已提交
3091
						record->xl_rmid, RecPtr->xlogid, RecPtr->xrecoff)));
3092 3093
		goto next_record_is_invalid;
	}
3094 3095 3096
	if (randAccess)
	{
		/*
B
Bruce Momjian 已提交
3097 3098
		 * We can't exactly verify the prev-link, but surely it should be less
		 * than the record's own address.
3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111
		 */
		if (!XLByteLT(record->xl_prev, *RecPtr))
		{
			ereport(emode,
					(errmsg("record with incorrect prev-link %X/%X at %X/%X",
							record->xl_prev.xlogid, record->xl_prev.xrecoff,
							RecPtr->xlogid, RecPtr->xrecoff)));
			goto next_record_is_invalid;
		}
	}
	else
	{
		/*
B
Bruce Momjian 已提交
3112 3113 3114
		 * Record's prev-link should exactly match our previous location. This
		 * check guards against torn WAL pages where a stale but valid-looking
		 * WAL record starts on a sector boundary.
3115 3116 3117 3118 3119 3120 3121 3122 3123 3124
		 */
		if (!XLByteEQ(record->xl_prev, ReadRecPtr))
		{
			ereport(emode,
					(errmsg("record with incorrect prev-link %X/%X at %X/%X",
							record->xl_prev.xlogid, record->xl_prev.xrecoff,
							RecPtr->xlogid, RecPtr->xrecoff)));
			goto next_record_is_invalid;
		}
	}
B
Bruce Momjian 已提交
3125

T
Tom Lane 已提交
3126
	/*
B
Bruce Momjian 已提交
3127
	 * Allocate or enlarge readRecordBuf as needed.  To avoid useless small
3128 3129 3130 3131
	 * increases, round its size to a multiple of XLOG_BLCKSZ, and make sure
	 * it's at least 4*Max(BLCKSZ, XLOG_BLCKSZ) to start with.  (That is
	 * enough for all "normal" records, but very large commit or abort records
	 * might need more space.)
T
Tom Lane 已提交
3132
	 */
3133
	total_len = record->xl_tot_len;
3134
	if (total_len > readRecordBufSize)
3135
	{
3136 3137
		uint32		newSize = total_len;

3138 3139
		newSize += XLOG_BLCKSZ - (newSize % XLOG_BLCKSZ);
		newSize = Max(newSize, 4 * Max(BLCKSZ, XLOG_BLCKSZ));
3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152
		if (readRecordBuf)
			free(readRecordBuf);
		readRecordBuf = (char *) malloc(newSize);
		if (!readRecordBuf)
		{
			readRecordBufSize = 0;
			/* We treat this as a "bogus data" condition */
			ereport(emode,
					(errmsg("record length %u at %X/%X too long",
							total_len, RecPtr->xlogid, RecPtr->xrecoff)));
			goto next_record_is_invalid;
		}
		readRecordBufSize = newSize;
3153
	}
3154 3155

	buffer = readRecordBuf;
3156
	nextRecord = NULL;
3157
	len = XLOG_BLCKSZ - RecPtr->xrecoff % XLOG_BLCKSZ;
T
Tom Lane 已提交
3158
	if (total_len > len)
3159
	{
T
Tom Lane 已提交
3160 3161
		/* Need to reassemble record */
		XLogContRecord *contrecord;
B
Bruce Momjian 已提交
3162
		uint32		gotlen = len;
3163

T
Tom Lane 已提交
3164
		memcpy(buffer, record, len);
3165
		record = (XLogRecord *) buffer;
T
Tom Lane 已提交
3166
		buffer += len;
3167
		for (;;)
3168
		{
3169
			readOff += XLOG_BLCKSZ;
T
Tom Lane 已提交
3170
			if (readOff >= XLogSegSize)
3171 3172
			{
				close(readFile);
T
Tom Lane 已提交
3173 3174
				readFile = -1;
				NextLogSeg(readId, readSeg);
3175
				readFile = XLogFileRead(readId, readSeg, emode);
3176 3177
				if (readFile < 0)
					goto next_record_is_invalid;
T
Tom Lane 已提交
3178
				readOff = 0;
3179
			}
3180
			if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
T
Tom Lane 已提交
3181
			{
3182 3183
				ereport(emode,
						(errcode_for_file_access(),
T
Tom Lane 已提交
3184
						 errmsg("could not read from log file %u, segment %u, offset %u: %m",
3185
								readId, readSeg, readOff)));
T
Tom Lane 已提交
3186 3187
				goto next_record_is_invalid;
			}
3188
			if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
3189
				goto next_record_is_invalid;
T
Tom Lane 已提交
3190
			if (!(((XLogPageHeader) readBuf)->xlp_info & XLP_FIRST_IS_CONTRECORD))
3191
			{
3192 3193 3194
				ereport(emode,
						(errmsg("there is no contrecord flag in log file %u, segment %u, offset %u",
								readId, readSeg, readOff)));
3195 3196
				goto next_record_is_invalid;
			}
3197 3198
			pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
			contrecord = (XLogContRecord *) ((char *) readBuf + pageHeaderSize);
B
Bruce Momjian 已提交
3199
			if (contrecord->xl_rem_len == 0 ||
T
Tom Lane 已提交
3200
				total_len != (contrecord->xl_rem_len + gotlen))
3201
			{
3202 3203 3204 3205
				ereport(emode,
						(errmsg("invalid contrecord length %u in log file %u, segment %u, offset %u",
								contrecord->xl_rem_len,
								readId, readSeg, readOff)));
3206 3207
				goto next_record_is_invalid;
			}
3208
			len = XLOG_BLCKSZ - pageHeaderSize - SizeOfXLogContRecord;
T
Tom Lane 已提交
3209
			if (contrecord->xl_rem_len > len)
3210
			{
B
Bruce Momjian 已提交
3211
				memcpy(buffer, (char *) contrecord + SizeOfXLogContRecord, len);
T
Tom Lane 已提交
3212 3213 3214 3215 3216 3217 3218 3219 3220 3221
				gotlen += len;
				buffer += len;
				continue;
			}
			memcpy(buffer, (char *) contrecord + SizeOfXLogContRecord,
				   contrecord->xl_rem_len);
			break;
		}
		if (!RecordIsValid(record, *RecPtr, emode))
			goto next_record_is_invalid;
3222
		pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
3223
		if (XLOG_BLCKSZ - SizeOfXLogRecord >= pageHeaderSize +
3224
			MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len))
T
Tom Lane 已提交
3225
		{
B
Bruce Momjian 已提交
3226
			nextRecord = (XLogRecord *) ((char *) contrecord +
B
Bruce Momjian 已提交
3227
					MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len));
T
Tom Lane 已提交
3228 3229 3230
		}
		EndRecPtr.xlogid = readId;
		EndRecPtr.xrecoff = readSeg * XLogSegSize + readOff +
3231 3232
			pageHeaderSize +
			MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len);
T
Tom Lane 已提交
3233
		ReadRecPtr = *RecPtr;
3234
		/* needn't worry about XLOG SWITCH, it can't cross page boundaries */
T
Tom Lane 已提交
3235
		return record;
3236 3237
	}

T
Tom Lane 已提交
3238 3239 3240
	/* Record does not cross a page boundary */
	if (!RecordIsValid(record, *RecPtr, emode))
		goto next_record_is_invalid;
3241
	if (XLOG_BLCKSZ - SizeOfXLogRecord >= RecPtr->xrecoff % XLOG_BLCKSZ +
T
Tom Lane 已提交
3242 3243 3244 3245 3246 3247
		MAXALIGN(total_len))
		nextRecord = (XLogRecord *) ((char *) record + MAXALIGN(total_len));
	EndRecPtr.xlogid = RecPtr->xlogid;
	EndRecPtr.xrecoff = RecPtr->xrecoff + MAXALIGN(total_len);
	ReadRecPtr = *RecPtr;
	memcpy(buffer, record, total_len);
B
Bruce Momjian 已提交
3248

3249 3250 3251 3252 3253 3254 3255 3256 3257
	/*
	 * Special processing if it's an XLOG SWITCH record
	 */
	if (record->xl_rmid == RM_XLOG_ID && record->xl_info == XLOG_SWITCH)
	{
		/* Pretend it extends to end of segment */
		EndRecPtr.xrecoff += XLogSegSize - 1;
		EndRecPtr.xrecoff -= EndRecPtr.xrecoff % XLogSegSize;
		nextRecord = NULL;		/* definitely not on same page */
B
Bruce Momjian 已提交
3258

3259
		/*
B
Bruce Momjian 已提交
3260 3261 3262
		 * Pretend that readBuf contains the last page of the segment. This is
		 * just to avoid Assert failure in StartupXLOG if XLOG ends with this
		 * segment.
3263 3264 3265
		 */
		readOff = XLogSegSize - XLOG_BLCKSZ;
	}
T
Tom Lane 已提交
3266
	return (XLogRecord *) buffer;
3267

T
Tom Lane 已提交
3268 3269 3270 3271 3272
next_record_is_invalid:;
	close(readFile);
	readFile = -1;
	nextRecord = NULL;
	return NULL;
3273 3274
}

3275 3276 3277 3278
/*
 * Check whether the xlog header of a page just read in looks valid.
 *
 * This is just a convenience subroutine to avoid duplicated code in
B
Bruce Momjian 已提交
3279
 * ReadRecord.	It's not intended for use from anywhere else.
3280 3281
 */
static bool
3282
ValidXLOGHeader(XLogPageHeader hdr, int emode)
3283
{
3284 3285
	XLogRecPtr	recaddr;

3286 3287
	if (hdr->xlp_magic != XLOG_PAGE_MAGIC)
	{
3288 3289 3290
		ereport(emode,
				(errmsg("invalid magic number %04X in log file %u, segment %u, offset %u",
						hdr->xlp_magic, readId, readSeg, readOff)));
3291 3292 3293 3294
		return false;
	}
	if ((hdr->xlp_info & ~XLP_ALL_FLAGS) != 0)
	{
3295 3296 3297
		ereport(emode,
				(errmsg("invalid info bits %04X in log file %u, segment %u, offset %u",
						hdr->xlp_info, readId, readSeg, readOff)));
3298 3299
		return false;
	}
3300
	if (hdr->xlp_info & XLP_LONG_HEADER)
3301
	{
3302
		XLogLongPageHeader longhdr = (XLogLongPageHeader) hdr;
B
Bruce Momjian 已提交
3303

3304
		if (longhdr->xlp_sysid != ControlFile->system_identifier)
3305
		{
3306 3307
			char		fhdrident_str[32];
			char		sysident_str[32];
3308

3309
			/*
B
Bruce Momjian 已提交
3310 3311
			 * Format sysids separately to keep platform-dependent format code
			 * out of the translatable message string.
3312 3313 3314 3315 3316 3317 3318
			 */
			snprintf(fhdrident_str, sizeof(fhdrident_str), UINT64_FORMAT,
					 longhdr->xlp_sysid);
			snprintf(sysident_str, sizeof(sysident_str), UINT64_FORMAT,
					 ControlFile->system_identifier);
			ereport(emode,
					(errmsg("WAL file is from different system"),
B
Bruce Momjian 已提交
3319 3320
					 errdetail("WAL file SYSID is %s, pg_control SYSID is %s",
							   fhdrident_str, sysident_str)));
3321 3322 3323 3324 3325 3326
			return false;
		}
		if (longhdr->xlp_seg_size != XLogSegSize)
		{
			ereport(emode,
					(errmsg("WAL file is from different system"),
B
Bruce Momjian 已提交
3327
					 errdetail("Incorrect XLOG_SEG_SIZE in page header.")));
3328 3329
			return false;
		}
3330 3331 3332 3333 3334 3335 3336
		if (longhdr->xlp_xlog_blcksz != XLOG_BLCKSZ)
		{
			ereport(emode,
					(errmsg("WAL file is from different system"),
					 errdetail("Incorrect XLOG_BLCKSZ in page header.")));
			return false;
		}
3337
	}
3338 3339 3340 3341 3342 3343 3344 3345 3346
	else if (readOff == 0)
	{
		/* hmm, first page of file doesn't have a long header? */
		ereport(emode,
				(errmsg("invalid info bits %04X in log file %u, segment %u, offset %u",
						hdr->xlp_info, readId, readSeg, readOff)));
		return false;
	}

3347 3348 3349 3350 3351 3352
	recaddr.xlogid = readId;
	recaddr.xrecoff = readSeg * XLogSegSize + readOff;
	if (!XLByteEQ(hdr->xlp_pageaddr, recaddr))
	{
		ereport(emode,
				(errmsg("unexpected pageaddr %X/%X in log file %u, segment %u, offset %u",
B
Bruce Momjian 已提交
3353
						hdr->xlp_pageaddr.xlogid, hdr->xlp_pageaddr.xrecoff,
3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374
						readId, readSeg, readOff)));
		return false;
	}

	/*
	 * Check page TLI is one of the expected values.
	 */
	if (!list_member_int(expectedTLIs, (int) hdr->xlp_tli))
	{
		ereport(emode,
				(errmsg("unexpected timeline ID %u in log file %u, segment %u, offset %u",
						hdr->xlp_tli,
						readId, readSeg, readOff)));
		return false;
	}

	/*
	 * Since child timelines are always assigned a TLI greater than their
	 * immediate parent's TLI, we should never see TLI go backwards across
	 * successive pages of a consistent WAL sequence.
	 *
B
Bruce Momjian 已提交
3375 3376 3377
	 * Of course this check should only be applied when advancing sequentially
	 * across pages; therefore ReadRecord resets lastPageTLI to zero when
	 * going to a random page.
3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394
	 */
	if (hdr->xlp_tli < lastPageTLI)
	{
		ereport(emode,
				(errmsg("out-of-sequence timeline ID %u (after %u) in log file %u, segment %u, offset %u",
						hdr->xlp_tli, lastPageTLI,
						readId, readSeg, readOff)));
		return false;
	}
	lastPageTLI = hdr->xlp_tli;
	return true;
}

/*
 * Try to read a timeline's history file.
 *
 * If successful, return the list of component TLIs (the given TLI followed by
B
Bruce Momjian 已提交
3395
 * its ancestor TLIs).	If we can't find the history file, assume that the
3396 3397 3398 3399 3400 3401 3402 3403 3404 3405
 * timeline has no parents, and return a list of just the specified timeline
 * ID.
 */
static List *
readTimeLineHistory(TimeLineID targetTLI)
{
	List	   *result;
	char		path[MAXPGPATH];
	char		histfname[MAXFNAMELEN];
	char		fline[MAXPGPATH];
B
Bruce Momjian 已提交
3406
	FILE	   *fd;
3407 3408 3409 3410

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, targetTLI);
3411
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3412 3413 3414 3415
	}
	else
		TLHistoryFilePath(path, targetTLI);

B
Bruce Momjian 已提交
3416
	fd = AllocateFile(path, "r");
3417 3418 3419 3420 3421
	if (fd == NULL)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3422
					 errmsg("could not open file \"%s\": %m", path)));
3423 3424 3425 3426 3427 3428
		/* Not there, so assume no parents */
		return list_make1_int((int) targetTLI);
	}

	result = NIL;

B
Bruce Momjian 已提交
3429 3430 3431
	/*
	 * Parse the file...
	 */
3432
	while (fgets(fline, sizeof(fline), fd) != NULL)
3433 3434
	{
		/* skip leading whitespace and check for # comment */
B
Bruce Momjian 已提交
3435 3436 3437
		char	   *ptr;
		char	   *endptr;
		TimeLineID	tli;
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457

		for (ptr = fline; *ptr; ptr++)
		{
			if (!isspace((unsigned char) *ptr))
				break;
		}
		if (*ptr == '\0' || *ptr == '#')
			continue;

		/* expect a numeric timeline ID as first field of line */
		tli = (TimeLineID) strtoul(ptr, &endptr, 0);
		if (endptr == ptr)
			ereport(FATAL,
					(errmsg("syntax error in history file: %s", fline),
					 errhint("Expected a numeric timeline ID.")));

		if (result &&
			tli <= (TimeLineID) linitial_int(result))
			ereport(FATAL,
					(errmsg("invalid data in history file: %s", fline),
B
Bruce Momjian 已提交
3458
				   errhint("Timeline IDs must be in increasing sequence.")));
3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471

		/* Build list with newest item first */
		result = lcons_int((int) tli, result);

		/* we ignore the remainder of each line */
	}

	FreeFile(fd);

	if (result &&
		targetTLI <= (TimeLineID) linitial_int(result))
		ereport(FATAL,
				(errmsg("invalid data in history file \"%s\"", path),
B
Bruce Momjian 已提交
3472
			errhint("Timeline IDs must be less than child timeline's ID.")));
3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490

	result = lcons_int((int) targetTLI, result);

	ereport(DEBUG3,
			(errmsg_internal("history of timeline %u is %s",
							 targetTLI, nodeToString(result))));

	return result;
}

/*
 * Probe whether a timeline history file exists for the given timeline ID
 */
static bool
existsTimeLineHistory(TimeLineID probeTLI)
{
	char		path[MAXPGPATH];
	char		histfname[MAXFNAMELEN];
B
Bruce Momjian 已提交
3491
	FILE	   *fd;
3492 3493 3494 3495

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, probeTLI);
3496
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511
	}
	else
		TLHistoryFilePath(path, probeTLI);

	fd = AllocateFile(path, "r");
	if (fd != NULL)
	{
		FreeFile(fd);
		return true;
	}
	else
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3512
					 errmsg("could not open file \"%s\": %m", path)));
3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530
		return false;
	}
}

/*
 * Find the newest existing timeline, assuming that startTLI exists.
 *
 * Note: while this is somewhat heuristic, it does positively guarantee
 * that (result + 1) is not a known timeline, and therefore it should
 * be safe to assign that ID to a new timeline.
 */
static TimeLineID
findNewestTimeLine(TimeLineID startTLI)
{
	TimeLineID	newestTLI;
	TimeLineID	probeTLI;

	/*
B
Bruce Momjian 已提交
3531 3532
	 * The algorithm is just to probe for the existence of timeline history
	 * files.  XXX is it useful to allow gaps in the sequence?
3533 3534 3535
	 */
	newestTLI = startTLI;

B
Bruce Momjian 已提交
3536
	for (probeTLI = startTLI + 1;; probeTLI++)
3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559
	{
		if (existsTimeLineHistory(probeTLI))
		{
			newestTLI = probeTLI;		/* probeTLI exists */
		}
		else
		{
			/* doesn't exist, assume we're done */
			break;
		}
	}

	return newestTLI;
}

/*
 * Create a new timeline history file.
 *
 *	newTLI: ID of the new timeline
 *	parentTLI: ID of its immediate parent
 *	endTLI et al: ID of the last used WAL file, for annotation purposes
 *
 * Currently this is only used during recovery, and so there are no locking
B
Bruce Momjian 已提交
3560
 * considerations.	But we should be just as tense as XLogFileInit to avoid
3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575
 * emplacing a bogus file.
 */
static void
writeTimeLineHistory(TimeLineID newTLI, TimeLineID parentTLI,
					 TimeLineID endTLI, uint32 endLogId, uint32 endLogSeg)
{
	char		path[MAXPGPATH];
	char		tmppath[MAXPGPATH];
	char		histfname[MAXFNAMELEN];
	char		xlogfname[MAXFNAMELEN];
	char		buffer[BLCKSZ];
	int			srcfd;
	int			fd;
	int			nbytes;

B
Bruce Momjian 已提交
3576
	Assert(newTLI > parentTLI); /* else bad selection of newTLI */
3577 3578 3579 3580

	/*
	 * Write into a temp file name.
	 */
3581
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
3582 3583 3584 3585 3586 3587 3588

	unlink(tmppath);

	/* do not use XLOG_SYNC_BIT here --- want to fsync only at end of fill */
	fd = BasicOpenFile(tmppath, O_RDWR | O_CREAT | O_EXCL,
					   S_IRUSR | S_IWUSR);
	if (fd < 0)
3589
		ereport(ERROR,
3590 3591 3592 3593 3594 3595 3596 3597 3598
				(errcode_for_file_access(),
				 errmsg("could not create file \"%s\": %m", tmppath)));

	/*
	 * If a history file exists for the parent, copy it verbatim
	 */
	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, parentTLI);
3599
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3600 3601 3602 3603 3604 3605 3606 3607
	}
	else
		TLHistoryFilePath(path, parentTLI);

	srcfd = BasicOpenFile(path, O_RDONLY, 0);
	if (srcfd < 0)
	{
		if (errno != ENOENT)
3608
			ereport(ERROR,
3609
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3610
					 errmsg("could not open file \"%s\": %m", path)));
3611 3612 3613 3614 3615 3616 3617 3618 3619
		/* Not there, so assume parent has no parents */
	}
	else
	{
		for (;;)
		{
			errno = 0;
			nbytes = (int) read(srcfd, buffer, sizeof(buffer));
			if (nbytes < 0 || errno != 0)
3620
				ereport(ERROR,
3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634
						(errcode_for_file_access(),
						 errmsg("could not read file \"%s\": %m", path)));
			if (nbytes == 0)
				break;
			errno = 0;
			if ((int) write(fd, buffer, nbytes) != nbytes)
			{
				int			save_errno = errno;

				/*
				 * If we fail to make the file, delete it to release disk
				 * space
				 */
				unlink(tmppath);
B
Bruce Momjian 已提交
3635 3636

				/*
B
Bruce Momjian 已提交
3637
				 * if write didn't set errno, assume problem is no disk space
B
Bruce Momjian 已提交
3638
				 */
3639 3640
				errno = save_errno ? save_errno : ENOSPC;

3641
				ereport(ERROR,
3642
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
3643
					 errmsg("could not write to file \"%s\": %m", tmppath)));
3644 3645 3646 3647 3648 3649 3650 3651
			}
		}
		close(srcfd);
	}

	/*
	 * Append one line with the details of this timeline split.
	 *
B
Bruce Momjian 已提交
3652 3653
	 * If we did have a parent file, insert an extra newline just in case the
	 * parent file failed to end with one.
3654 3655 3656 3657 3658 3659 3660 3661 3662 3663
	 */
	XLogFileName(xlogfname, endTLI, endLogId, endLogSeg);

	snprintf(buffer, sizeof(buffer),
			 "%s%u\t%s\t%s transaction %u at %s\n",
			 (srcfd < 0) ? "" : "\n",
			 parentTLI,
			 xlogfname,
			 recoveryStopAfter ? "after" : "before",
			 recoveryStopXid,
3664
			 timestamptz_to_str(recoveryStopTime));
3665 3666 3667 3668 3669 3670 3671 3672

	nbytes = strlen(buffer);
	errno = 0;
	if ((int) write(fd, buffer, nbytes) != nbytes)
	{
		int			save_errno = errno;

		/*
B
Bruce Momjian 已提交
3673
		 * If we fail to make the file, delete it to release disk space
3674 3675 3676 3677 3678
		 */
		unlink(tmppath);
		/* if write didn't set errno, assume problem is no disk space */
		errno = save_errno ? save_errno : ENOSPC;

3679
		ereport(ERROR,
3680 3681 3682 3683 3684
				(errcode_for_file_access(),
				 errmsg("could not write to file \"%s\": %m", tmppath)));
	}

	if (pg_fsync(fd) != 0)
3685
		ereport(ERROR,
3686 3687 3688 3689
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

	if (close(fd))
3690
		ereport(ERROR,
3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));


	/*
	 * Now move the completed history file into place with its final name.
	 */
	TLHistoryFilePath(path, newTLI);

	/*
	 * Prefer link() to rename() here just to be really sure that we don't
	 * overwrite an existing logfile.  However, there shouldn't be one, so
	 * rename() is an acceptable substitute except for the truly paranoid.
	 */
#if HAVE_WORKING_LINK
	if (link(tmppath, path) < 0)
3707
		ereport(ERROR,
3708 3709 3710 3711 3712 3713
				(errcode_for_file_access(),
				 errmsg("could not link file \"%s\" to \"%s\": %m",
						tmppath, path)));
	unlink(tmppath);
#else
	if (rename(tmppath, path) < 0)
3714
		ereport(ERROR,
3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
				(errcode_for_file_access(),
				 errmsg("could not rename file \"%s\" to \"%s\": %m",
						tmppath, path)));
#endif

	/* The history file can be archived immediately. */
	TLHistoryFileName(histfname, newTLI);
	XLogArchiveNotify(histfname);
}

/*
 * I/O routines for pg_control
3727 3728
 *
 * *ControlFile is a buffer in shared memory that holds an image of the
B
Bruce Momjian 已提交
3729
 * contents of pg_control.	WriteControlFile() initializes pg_control
3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742
 * given a preloaded buffer, ReadControlFile() loads the buffer from
 * the pg_control file (during postmaster or standalone-backend startup),
 * and UpdateControlFile() rewrites pg_control after we modify xlog state.
 *
 * For simplicity, WriteControlFile() initializes the fields of pg_control
 * that are related to checking backend/database compatibility, and
 * ReadControlFile() verifies they are correct.  We could split out the
 * I/O and compatibility-check functions, but there seems no need currently.
 */
static void
WriteControlFile(void)
{
	int			fd;
B
Bruce Momjian 已提交
3743
	char		buffer[PG_CONTROL_SIZE];		/* need not be aligned */
3744 3745 3746
	char	   *localeptr;

	/*
T
Tom Lane 已提交
3747
	 * Initialize version and compatibility-check fields
3748
	 */
T
Tom Lane 已提交
3749 3750
	ControlFile->pg_control_version = PG_CONTROL_VERSION;
	ControlFile->catalog_version_no = CATALOG_VERSION_NO;
3751 3752 3753 3754

	ControlFile->maxAlign = MAXIMUM_ALIGNOF;
	ControlFile->floatFormat = FLOATFORMAT_VALUE;

3755 3756
	ControlFile->blcksz = BLCKSZ;
	ControlFile->relseg_size = RELSEG_SIZE;
3757
	ControlFile->xlog_blcksz = XLOG_BLCKSZ;
3758
	ControlFile->xlog_seg_size = XLOG_SEG_SIZE;
3759 3760

	ControlFile->nameDataLen = NAMEDATALEN;
3761
	ControlFile->indexMaxKeys = INDEX_MAX_KEYS;
3762

3763 3764
	ControlFile->toast_max_chunk_size = TOAST_MAX_CHUNK_SIZE;

3765 3766 3767 3768 3769 3770 3771
#ifdef HAVE_INT64_TIMESTAMP
	ControlFile->enableIntTimes = TRUE;
#else
	ControlFile->enableIntTimes = FALSE;
#endif

	ControlFile->localeBuflen = LOCALE_NAME_BUFLEN;
3772 3773
	localeptr = setlocale(LC_COLLATE, NULL);
	if (!localeptr)
3774 3775
		ereport(PANIC,
				(errmsg("invalid LC_COLLATE setting")));
3776 3777 3778
	StrNCpy(ControlFile->lc_collate, localeptr, LOCALE_NAME_BUFLEN);
	localeptr = setlocale(LC_CTYPE, NULL);
	if (!localeptr)
3779 3780
		ereport(PANIC,
				(errmsg("invalid LC_CTYPE setting")));
3781
	StrNCpy(ControlFile->lc_ctype, localeptr, LOCALE_NAME_BUFLEN);
B
Bruce Momjian 已提交
3782

T
Tom Lane 已提交
3783
	/* Contents are protected with a CRC */
3784 3785 3786 3787 3788
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
T
Tom Lane 已提交
3789

3790
	/*
3791 3792 3793 3794 3795
	 * We write out PG_CONTROL_SIZE bytes into pg_control, zero-padding the
	 * excess over sizeof(ControlFileData).  This reduces the odds of
	 * premature-EOF errors when reading pg_control.  We'll still fail when we
	 * check the contents of the file, but hopefully with a more specific
	 * error than "couldn't read pg_control".
3796
	 */
3797 3798
	if (sizeof(ControlFileData) > PG_CONTROL_SIZE)
		elog(PANIC, "sizeof(ControlFileData) is larger than PG_CONTROL_SIZE; fix either one");
3799

3800
	memset(buffer, 0, PG_CONTROL_SIZE);
3801 3802
	memcpy(buffer, ControlFile, sizeof(ControlFileData));

3803 3804
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
3805
					   S_IRUSR | S_IWUSR);
3806
	if (fd < 0)
3807 3808 3809
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not create control file \"%s\": %m",
3810
						XLOG_CONTROL_FILE)));
3811

3812
	errno = 0;
3813
	if (write(fd, buffer, PG_CONTROL_SIZE) != PG_CONTROL_SIZE)
3814 3815 3816 3817
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
3818 3819
		ereport(PANIC,
				(errcode_for_file_access(),
3820
				 errmsg("could not write to control file: %m")));
3821
	}
3822

3823
	if (pg_fsync(fd) != 0)
3824 3825
		ereport(PANIC,
				(errcode_for_file_access(),
3826
				 errmsg("could not fsync control file: %m")));
3827

3828 3829 3830 3831
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
3832 3833 3834 3835 3836
}

static void
ReadControlFile(void)
{
3837
	pg_crc32	crc;
3838 3839 3840 3841 3842
	int			fd;

	/*
	 * Read data...
	 */
3843 3844 3845
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | PG_BINARY,
					   S_IRUSR | S_IWUSR);
3846
	if (fd < 0)
3847 3848 3849
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not open control file \"%s\": %m",
3850
						XLOG_CONTROL_FILE)));
3851 3852

	if (read(fd, ControlFile, sizeof(ControlFileData)) != sizeof(ControlFileData))
3853 3854
		ereport(PANIC,
				(errcode_for_file_access(),
3855
				 errmsg("could not read from control file: %m")));
3856 3857 3858

	close(fd);

T
Tom Lane 已提交
3859
	/*
B
Bruce Momjian 已提交
3860 3861 3862 3863
	 * Check for expected pg_control format version.  If this is wrong, the
	 * CRC check will likely fail because we'll be checking the wrong number
	 * of bytes.  Complaining about wrong version will probably be more
	 * enlightening than complaining about wrong CRC.
T
Tom Lane 已提交
3864 3865
	 */
	if (ControlFile->pg_control_version != PG_CONTROL_VERSION)
3866 3867 3868
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with PG_CONTROL_VERSION %d,"
B
Bruce Momjian 已提交
3869 3870
				  " but the server was compiled with PG_CONTROL_VERSION %d.",
						ControlFile->pg_control_version, PG_CONTROL_VERSION),
3871
				 errhint("It looks like you need to initdb.")));
T
Tom Lane 已提交
3872
	/* Now check the CRC. */
3873 3874 3875 3876 3877
	INIT_CRC32(crc);
	COMP_CRC32(crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(crc);
3878

3879
	if (!EQ_CRC32(crc, ControlFile->crc))
3880
		ereport(FATAL,
3881
				(errmsg("incorrect checksum in control file")));
3882

3883
	/*
B
Bruce Momjian 已提交
3884
	 * Do compatibility checking immediately.  We do this here for 2 reasons:
3885
	 *
3886 3887
	 * (1) if the database isn't compatible with the backend executable, we
	 * want to abort before we can possibly do any damage;
3888 3889
	 *
	 * (2) this code is executed in the postmaster, so the setlocale() will
B
Bruce Momjian 已提交
3890 3891
	 * propagate to forked backends, which aren't going to read this file for
	 * themselves.	(These locale settings are considered critical
3892 3893
	 * compatibility items because they can affect sort order of indexes.)
	 */
T
Tom Lane 已提交
3894
	if (ControlFile->catalog_version_no != CATALOG_VERSION_NO)
3895 3896 3897
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with CATALOG_VERSION_NO %d,"
B
Bruce Momjian 已提交
3898 3899
				  " but the server was compiled with CATALOG_VERSION_NO %d.",
						ControlFile->catalog_version_no, CATALOG_VERSION_NO),
3900
				 errhint("It looks like you need to initdb.")));
3901 3902 3903
	if (ControlFile->maxAlign != MAXIMUM_ALIGNOF)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3904 3905 3906 3907
		   errdetail("The database cluster was initialized with MAXALIGN %d,"
					 " but the server was compiled with MAXALIGN %d.",
					 ControlFile->maxAlign, MAXIMUM_ALIGNOF),
				 errhint("It looks like you need to initdb.")));
3908 3909 3910
	if (ControlFile->floatFormat != FLOATFORMAT_VALUE)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
P
Peter Eisentraut 已提交
3911
				 errdetail("The database cluster appears to use a different floating-point number format than the server executable."),
3912
				 errhint("It looks like you need to initdb.")));
3913
	if (ControlFile->blcksz != BLCKSZ)
3914 3915
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3916 3917 3918 3919
			 errdetail("The database cluster was initialized with BLCKSZ %d,"
					   " but the server was compiled with BLCKSZ %d.",
					   ControlFile->blcksz, BLCKSZ),
				 errhint("It looks like you need to recompile or initdb.")));
3920
	if (ControlFile->relseg_size != RELSEG_SIZE)
3921 3922
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3923 3924 3925 3926
		errdetail("The database cluster was initialized with RELSEG_SIZE %d,"
				  " but the server was compiled with RELSEG_SIZE %d.",
				  ControlFile->relseg_size, RELSEG_SIZE),
				 errhint("It looks like you need to recompile or initdb.")));
3927 3928 3929
	if (ControlFile->xlog_blcksz != XLOG_BLCKSZ)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3930 3931 3932
		errdetail("The database cluster was initialized with XLOG_BLCKSZ %d,"
				  " but the server was compiled with XLOG_BLCKSZ %d.",
				  ControlFile->xlog_blcksz, XLOG_BLCKSZ),
3933
				 errhint("It looks like you need to recompile or initdb.")));
3934 3935 3936 3937
	if (ControlFile->xlog_seg_size != XLOG_SEG_SIZE)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with XLOG_SEG_SIZE %d,"
B
Bruce Momjian 已提交
3938
					   " but the server was compiled with XLOG_SEG_SIZE %d.",
3939
						   ControlFile->xlog_seg_size, XLOG_SEG_SIZE),
B
Bruce Momjian 已提交
3940
				 errhint("It looks like you need to recompile or initdb.")));
3941
	if (ControlFile->nameDataLen != NAMEDATALEN)
3942 3943
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3944 3945 3946 3947
		errdetail("The database cluster was initialized with NAMEDATALEN %d,"
				  " but the server was compiled with NAMEDATALEN %d.",
				  ControlFile->nameDataLen, NAMEDATALEN),
				 errhint("It looks like you need to recompile or initdb.")));
3948
	if (ControlFile->indexMaxKeys != INDEX_MAX_KEYS)
3949 3950
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
3951
				 errdetail("The database cluster was initialized with INDEX_MAX_KEYS %d,"
B
Bruce Momjian 已提交
3952
					  " but the server was compiled with INDEX_MAX_KEYS %d.",
3953
						   ControlFile->indexMaxKeys, INDEX_MAX_KEYS),
B
Bruce Momjian 已提交
3954
				 errhint("It looks like you need to recompile or initdb.")));
3955 3956 3957 3958 3959 3960 3961
	if (ControlFile->toast_max_chunk_size != TOAST_MAX_CHUNK_SIZE)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with TOAST_MAX_CHUNK_SIZE %d,"
						   " but the server was compiled with TOAST_MAX_CHUNK_SIZE %d.",
						   ControlFile->toast_max_chunk_size, (int) TOAST_MAX_CHUNK_SIZE),
				 errhint("It looks like you need to recompile or initdb.")));
3962 3963 3964

#ifdef HAVE_INT64_TIMESTAMP
	if (ControlFile->enableIntTimes != TRUE)
3965 3966 3967
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized without HAVE_INT64_TIMESTAMP"
B
Bruce Momjian 已提交
3968 3969
				  " but the server was compiled with HAVE_INT64_TIMESTAMP."),
				 errhint("It looks like you need to recompile or initdb.")));
3970 3971
#else
	if (ControlFile->enableIntTimes != FALSE)
3972 3973 3974
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with HAVE_INT64_TIMESTAMP"
B
Bruce Momjian 已提交
3975 3976
			   " but the server was compiled without HAVE_INT64_TIMESTAMP."),
				 errhint("It looks like you need to recompile or initdb.")));
3977 3978 3979
#endif

	if (ControlFile->localeBuflen != LOCALE_NAME_BUFLEN)
3980 3981 3982
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with LOCALE_NAME_BUFLEN %d,"
B
Bruce Momjian 已提交
3983
				  " but the server was compiled with LOCALE_NAME_BUFLEN %d.",
3984
						   ControlFile->localeBuflen, LOCALE_NAME_BUFLEN),
B
Bruce Momjian 已提交
3985
				 errhint("It looks like you need to recompile or initdb.")));
3986
	if (pg_perm_setlocale(LC_COLLATE, ControlFile->lc_collate) == NULL)
3987
		ereport(FATAL,
B
Bruce Momjian 已提交
3988 3989 3990 3991 3992
			(errmsg("database files are incompatible with operating system"),
			 errdetail("The database cluster was initialized with LC_COLLATE \"%s\","
					   " which is not recognized by setlocale().",
					   ControlFile->lc_collate),
			 errhint("It looks like you need to initdb or install locale support.")));
3993
	if (pg_perm_setlocale(LC_CTYPE, ControlFile->lc_ctype) == NULL)
3994
		ereport(FATAL,
B
Bruce Momjian 已提交
3995 3996 3997 3998 3999
			(errmsg("database files are incompatible with operating system"),
		errdetail("The database cluster was initialized with LC_CTYPE \"%s\","
				  " which is not recognized by setlocale().",
				  ControlFile->lc_ctype),
			 errhint("It looks like you need to initdb or install locale support.")));
4000 4001 4002 4003 4004 4005

	/* Make the fixed locale settings visible as GUC variables, too */
	SetConfigOption("lc_collate", ControlFile->lc_collate,
					PGC_INTERNAL, PGC_S_OVERRIDE);
	SetConfigOption("lc_ctype", ControlFile->lc_ctype,
					PGC_INTERNAL, PGC_S_OVERRIDE);
4006 4007
}

4008
void
4009
UpdateControlFile(void)
4010
{
4011
	int			fd;
4012

4013 4014 4015 4016 4017
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
4018

4019 4020 4021
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | PG_BINARY,
					   S_IRUSR | S_IWUSR);
4022
	if (fd < 0)
4023 4024 4025
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not open control file \"%s\": %m",
4026
						XLOG_CONTROL_FILE)));
4027

4028
	errno = 0;
4029
	if (write(fd, ControlFile, sizeof(ControlFileData)) != sizeof(ControlFileData))
4030 4031 4032 4033
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
4034 4035
		ereport(PANIC,
				(errcode_for_file_access(),
4036
				 errmsg("could not write to control file: %m")));
4037
	}
4038

4039
	if (pg_fsync(fd) != 0)
4040 4041
		ereport(PANIC,
				(errcode_for_file_access(),
4042
				 errmsg("could not fsync control file: %m")));
4043

4044 4045 4046 4047
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
4048 4049
}

4050
/*
T
Tom Lane 已提交
4051
 * Initialization of shared memory for XLOG
4052
 */
4053
Size
4054
XLOGShmemSize(void)
4055
{
4056
	Size		size;
4057

4058 4059 4060 4061 4062 4063 4064
	/* XLogCtl */
	size = sizeof(XLogCtlData);
	/* xlblocks array */
	size = add_size(size, mul_size(sizeof(XLogRecPtr), XLOGbuffers));
	/* extra alignment padding for XLOG I/O buffers */
	size = add_size(size, ALIGNOF_XLOG_BUFFER);
	/* and the buffers themselves */
4065
	size = add_size(size, mul_size(XLOG_BLCKSZ, XLOGbuffers));
4066 4067

	/*
B
Bruce Momjian 已提交
4068 4069 4070
	 * Note: we don't count ControlFileData, it comes out of the "slop factor"
	 * added by CreateSharedMemoryAndSemaphores.  This lets us use this
	 * routine again below to compute the actual allocation size.
4071 4072 4073
	 */

	return size;
4074 4075 4076 4077 4078
}

void
XLOGShmemInit(void)
{
4079 4080
	bool		foundCFile,
				foundXLog;
4081
	char	   *allocptr;
4082

4083
	ControlFile = (ControlFileData *)
4084
		ShmemInitStruct("Control File", sizeof(ControlFileData), &foundCFile);
4085 4086
	XLogCtl = (XLogCtlData *)
		ShmemInitStruct("XLOG Ctl", XLOGShmemSize(), &foundXLog);
4087

4088
	if (foundCFile || foundXLog)
4089 4090
	{
		/* both should be present or neither */
4091
		Assert(foundCFile && foundXLog);
4092 4093
		return;
	}
4094

T
Tom Lane 已提交
4095
	memset(XLogCtl, 0, sizeof(XLogCtlData));
B
Bruce Momjian 已提交
4096

T
Tom Lane 已提交
4097
	/*
B
Bruce Momjian 已提交
4098 4099 4100
	 * Since XLogCtlData contains XLogRecPtr fields, its sizeof should be a
	 * multiple of the alignment for same, so no extra alignment padding is
	 * needed here.
T
Tom Lane 已提交
4101
	 */
4102 4103
	allocptr = ((char *) XLogCtl) + sizeof(XLogCtlData);
	XLogCtl->xlblocks = (XLogRecPtr *) allocptr;
T
Tom Lane 已提交
4104
	memset(XLogCtl->xlblocks, 0, sizeof(XLogRecPtr) * XLOGbuffers);
4105
	allocptr += sizeof(XLogRecPtr) * XLOGbuffers;
B
Bruce Momjian 已提交
4106

T
Tom Lane 已提交
4107
	/*
4108
	 * Align the start of the page buffers to an ALIGNOF_XLOG_BUFFER boundary.
T
Tom Lane 已提交
4109
	 */
4110 4111
	allocptr = (char *) TYPEALIGN(ALIGNOF_XLOG_BUFFER, allocptr);
	XLogCtl->pages = allocptr;
4112
	memset(XLogCtl->pages, 0, (Size) XLOG_BLCKSZ * XLOGbuffers);
T
Tom Lane 已提交
4113 4114

	/*
B
Bruce Momjian 已提交
4115 4116
	 * Do basic initialization of XLogCtl shared data. (StartupXLOG will fill
	 * in additional info.)
T
Tom Lane 已提交
4117
	 */
B
Bruce Momjian 已提交
4118
	XLogCtl->XLogCacheByte = (Size) XLOG_BLCKSZ *XLOGbuffers;
B
Bruce Momjian 已提交
4119

T
Tom Lane 已提交
4120 4121
	XLogCtl->XLogCacheBlck = XLOGbuffers - 1;
	XLogCtl->Insert.currpage = (XLogPageHeader) (XLogCtl->pages);
4122
	SpinLockInit(&XLogCtl->info_lck);
T
Tom Lane 已提交
4123

4124
	/*
B
Bruce Momjian 已提交
4125 4126 4127
	 * If we are not in bootstrap mode, pg_control should already exist. Read
	 * and validate it immediately (see comments in ReadControlFile() for the
	 * reasons why).
4128 4129 4130
	 */
	if (!IsBootstrapProcessingMode())
		ReadControlFile();
4131 4132 4133
}

/*
T
Tom Lane 已提交
4134 4135
 * This func must be called ONCE on system install.  It creates pg_control
 * and the initial XLOG segment.
4136 4137
 */
void
T
Tom Lane 已提交
4138
BootStrapXLOG(void)
4139
{
4140
	CheckPoint	checkPoint;
T
Tom Lane 已提交
4141 4142
	char	   *buffer;
	XLogPageHeader page;
4143
	XLogLongPageHeader longpage;
4144
	XLogRecord *record;
B
Bruce Momjian 已提交
4145
	bool		use_existent;
4146 4147
	uint64		sysidentifier;
	struct timeval tv;
4148
	pg_crc32	crc;
4149

4150
	/*
B
Bruce Momjian 已提交
4151 4152 4153 4154 4155 4156 4157 4158 4159 4160
	 * Select a hopefully-unique system identifier code for this installation.
	 * We use the result of gettimeofday(), including the fractional seconds
	 * field, as being about as unique as we can easily get.  (Think not to
	 * use random(), since it hasn't been seeded and there's no portable way
	 * to seed it other than the system clock value...)  The upper half of the
	 * uint64 value is just the tv_sec part, while the lower half is the XOR
	 * of tv_sec and tv_usec.  This is to ensure that we don't lose uniqueness
	 * unnecessarily if "uint64" is really only 32 bits wide.  A person
	 * knowing this encoding can determine the initialization time of the
	 * installation, which could perhaps be useful sometimes.
4161 4162 4163 4164 4165
	 */
	gettimeofday(&tv, NULL);
	sysidentifier = ((uint64) tv.tv_sec) << 32;
	sysidentifier |= (uint32) (tv.tv_sec | tv.tv_usec);

4166 4167 4168
	/* First timeline ID is always 1 */
	ThisTimeLineID = 1;

4169
	/* page buffer must be aligned suitably for O_DIRECT */
4170
	buffer = (char *) palloc(XLOG_BLCKSZ + ALIGNOF_XLOG_BUFFER);
4171
	page = (XLogPageHeader) TYPEALIGN(ALIGNOF_XLOG_BUFFER, buffer);
4172
	memset(page, 0, XLOG_BLCKSZ);
T
Tom Lane 已提交
4173

4174
	/* Set up information for the initial checkpoint record */
4175
	checkPoint.redo.xlogid = 0;
4176 4177
	checkPoint.redo.xrecoff = SizeOfXLogLongPHD;
	checkPoint.ThisTimeLineID = ThisTimeLineID;
4178
	checkPoint.nextXidEpoch = 0;
4179
	checkPoint.nextXid = FirstNormalTransactionId;
4180
	checkPoint.nextOid = FirstBootstrapObjectId;
4181
	checkPoint.nextMulti = FirstMultiXactId;
4182
	checkPoint.nextMultiOffset = 0;
T
Tom Lane 已提交
4183
	checkPoint.time = time(NULL);
4184

4185 4186 4187
	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
	ShmemVariableCache->oidCount = 0;
4188
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
4189

4190
	/* Set up the XLOG page header */
4191
	page->xlp_magic = XLOG_PAGE_MAGIC;
4192 4193
	page->xlp_info = XLP_LONG_HEADER;
	page->xlp_tli = ThisTimeLineID;
4194 4195
	page->xlp_pageaddr.xlogid = 0;
	page->xlp_pageaddr.xrecoff = 0;
4196 4197 4198
	longpage = (XLogLongPageHeader) page;
	longpage->xlp_sysid = sysidentifier;
	longpage->xlp_seg_size = XLogSegSize;
4199
	longpage->xlp_xlog_blcksz = XLOG_BLCKSZ;
4200 4201

	/* Insert the initial checkpoint record */
4202
	record = (XLogRecord *) ((char *) page + SizeOfXLogLongPHD);
4203
	record->xl_prev.xlogid = 0;
4204
	record->xl_prev.xrecoff = 0;
4205
	record->xl_xid = InvalidTransactionId;
4206
	record->xl_tot_len = SizeOfXLogRecord + sizeof(checkPoint);
4207
	record->xl_len = sizeof(checkPoint);
T
Tom Lane 已提交
4208
	record->xl_info = XLOG_CHECKPOINT_SHUTDOWN;
4209
	record->xl_rmid = RM_XLOG_ID;
T
Tom Lane 已提交
4210
	memcpy(XLogRecGetData(record), &checkPoint, sizeof(checkPoint));
4211

4212 4213 4214 4215 4216
	INIT_CRC32(crc);
	COMP_CRC32(crc, &checkPoint, sizeof(checkPoint));
	COMP_CRC32(crc, (char *) record + sizeof(pg_crc32),
			   SizeOfXLogRecord - sizeof(pg_crc32));
	FIN_CRC32(crc);
4217 4218
	record->xl_crc = crc;

4219
	/* Create first XLOG segment file */
4220 4221
	use_existent = false;
	openLogFile = XLogFileInit(0, 0, &use_existent, false);
4222

4223
	/* Write the first page with the initial record */
4224
	errno = 0;
4225
	if (write(openLogFile, page, XLOG_BLCKSZ) != XLOG_BLCKSZ)
4226 4227 4228 4229
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
4230 4231
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4232
			  errmsg("could not write bootstrap transaction log file: %m")));
4233
	}
4234

T
Tom Lane 已提交
4235
	if (pg_fsync(openLogFile) != 0)
4236 4237
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4238
			  errmsg("could not fsync bootstrap transaction log file: %m")));
4239

4240 4241 4242
	if (close(openLogFile))
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4243
			  errmsg("could not close bootstrap transaction log file: %m")));
4244

T
Tom Lane 已提交
4245
	openLogFile = -1;
4246

4247 4248
	/* Now create pg_control */

4249
	memset(ControlFile, 0, sizeof(ControlFileData));
T
Tom Lane 已提交
4250
	/* Initialize pg_control status fields */
4251
	ControlFile->system_identifier = sysidentifier;
T
Tom Lane 已提交
4252 4253
	ControlFile->state = DB_SHUTDOWNED;
	ControlFile->time = checkPoint.time;
4254
	ControlFile->checkPoint = checkPoint.redo;
T
Tom Lane 已提交
4255
	ControlFile->checkPointCopy = checkPoint;
4256
	/* some additional ControlFile fields are set in WriteControlFile() */
4257

4258
	WriteControlFile();
4259 4260 4261

	/* Bootstrap the commit log, too */
	BootStrapCLOG();
4262
	BootStrapSUBTRANS();
4263
	BootStrapMultiXact();
4264

4265
	pfree(buffer);
4266 4267
}

4268
static char *
4269 4270
str_time(time_t tnow)
{
4271
	static char buf[128];
4272

4273
	strftime(buf, sizeof(buf),
T
Tom Lane 已提交
4274
			 "%Y-%m-%d %H:%M:%S %Z",
4275
			 localtime(&tnow));
4276

4277
	return buf;
4278 4279
}

4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290
/*
 * See if there is a recovery command file (recovery.conf), and if so
 * read in parameters for archive recovery.
 *
 * XXX longer term intention is to expand this to
 * cater for additional parameters and controls
 * possibly use a flex lexer similar to the GUC one
 */
static void
readRecoveryCommandFile(void)
{
B
Bruce Momjian 已提交
4291 4292 4293 4294 4295 4296
	FILE	   *fd;
	char		cmdline[MAXPGPATH];
	TimeLineID	rtli = 0;
	bool		rtliGiven = false;
	bool		syntaxError = false;

4297
	fd = AllocateFile(RECOVERY_COMMAND_FILE, "r");
4298 4299 4300 4301 4302
	if (fd == NULL)
	{
		if (errno == ENOENT)
			return;				/* not there, so no archive recovery */
		ereport(FATAL,
B
Bruce Momjian 已提交
4303
				(errcode_for_file_access(),
4304
				 errmsg("could not open recovery command file \"%s\": %m",
4305
						RECOVERY_COMMAND_FILE)));
4306 4307 4308
	}

	ereport(LOG,
B
Bruce Momjian 已提交
4309
			(errmsg("starting archive recovery")));
4310

B
Bruce Momjian 已提交
4311 4312 4313
	/*
	 * Parse the file...
	 */
4314
	while (fgets(cmdline, sizeof(cmdline), fd) != NULL)
4315 4316
	{
		/* skip leading whitespace and check for # comment */
B
Bruce Momjian 已提交
4317 4318 4319
		char	   *ptr;
		char	   *tok1;
		char	   *tok2;
4320 4321 4322 4323 4324 4325 4326 4327 4328 4329

		for (ptr = cmdline; *ptr; ptr++)
		{
			if (!isspace((unsigned char) *ptr))
				break;
		}
		if (*ptr == '\0' || *ptr == '#')
			continue;

		/* identify the quoted parameter value */
B
Bruce Momjian 已提交
4330
		tok1 = strtok(ptr, "'");
4331 4332 4333 4334 4335
		if (!tok1)
		{
			syntaxError = true;
			break;
		}
B
Bruce Momjian 已提交
4336
		tok2 = strtok(NULL, "'");
4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349
		if (!tok2)
		{
			syntaxError = true;
			break;
		}
		/* reparse to get just the parameter name */
		tok1 = strtok(ptr, " \t=");
		if (!tok1)
		{
			syntaxError = true;
			break;
		}

B
Bruce Momjian 已提交
4350 4351
		if (strcmp(tok1, "restore_command") == 0)
		{
4352
			recoveryRestoreCommand = pstrdup(tok2);
4353 4354 4355 4356
			ereport(LOG,
					(errmsg("restore_command = \"%s\"",
							recoveryRestoreCommand)));
		}
B
Bruce Momjian 已提交
4357 4358
		else if (strcmp(tok1, "recovery_target_timeline") == 0)
		{
4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377
			rtliGiven = true;
			if (strcmp(tok2, "latest") == 0)
				rtli = 0;
			else
			{
				errno = 0;
				rtli = (TimeLineID) strtoul(tok2, NULL, 0);
				if (errno == EINVAL || errno == ERANGE)
					ereport(FATAL,
							(errmsg("recovery_target_timeline is not a valid number: \"%s\"",
									tok2)));
			}
			if (rtli)
				ereport(LOG,
						(errmsg("recovery_target_timeline = %u", rtli)));
			else
				ereport(LOG,
						(errmsg("recovery_target_timeline = latest")));
		}
B
Bruce Momjian 已提交
4378 4379
		else if (strcmp(tok1, "recovery_target_xid") == 0)
		{
4380 4381 4382 4383
			errno = 0;
			recoveryTargetXid = (TransactionId) strtoul(tok2, NULL, 0);
			if (errno == EINVAL || errno == ERANGE)
				ereport(FATAL,
B
Bruce Momjian 已提交
4384 4385
				 (errmsg("recovery_target_xid is not a valid number: \"%s\"",
						 tok2)));
4386 4387 4388 4389 4390 4391
			ereport(LOG,
					(errmsg("recovery_target_xid = %u",
							recoveryTargetXid)));
			recoveryTarget = true;
			recoveryTargetExact = true;
		}
B
Bruce Momjian 已提交
4392 4393
		else if (strcmp(tok1, "recovery_target_time") == 0)
		{
4394 4395 4396 4397 4398 4399 4400 4401
			/*
			 * if recovery_target_xid specified, then this overrides
			 * recovery_target_time
			 */
			if (recoveryTargetExact)
				continue;
			recoveryTarget = true;
			recoveryTargetExact = false;
B
Bruce Momjian 已提交
4402

4403
			/*
4404
			 * Convert the time string given by the user to TimestampTz form.
4405
			 */
4406 4407 4408 4409 4410
			recoveryTargetTime =
				DatumGetTimestampTz(DirectFunctionCall3(timestamptz_in,
												   CStringGetDatum(tok2),
												ObjectIdGetDatum(InvalidOid),
														Int32GetDatum(-1)));
4411 4412
			ereport(LOG,
					(errmsg("recovery_target_time = %s",
4413
							timestamptz_to_str(recoveryTargetTime))));
4414
		}
B
Bruce Momjian 已提交
4415 4416
		else if (strcmp(tok1, "recovery_target_inclusive") == 0)
		{
4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437
			/*
			 * does nothing if a recovery_target is not also set
			 */
			if (strcmp(tok2, "true") == 0)
				recoveryTargetInclusive = true;
			else
			{
				recoveryTargetInclusive = false;
				tok2 = "false";
			}
			ereport(LOG,
					(errmsg("recovery_target_inclusive = %s", tok2)));
		}
		else
			ereport(FATAL,
					(errmsg("unrecognized recovery parameter \"%s\"",
							tok1)));
	}

	FreeFile(fd);

B
Bruce Momjian 已提交
4438 4439
	if (syntaxError)
		ereport(FATAL,
4440 4441
				(errmsg("syntax error in recovery command file: %s",
						cmdline),
B
Bruce Momjian 已提交
4442
			  errhint("Lines should have the format parameter = 'value'.")));
4443 4444

	/* Check that required parameters were supplied */
4445
	if (recoveryRestoreCommand == NULL)
4446 4447
		ereport(FATAL,
				(errmsg("recovery command file \"%s\" did not specify restore_command",
4448
						RECOVERY_COMMAND_FILE)));
4449

4450 4451 4452
	/* Enable fetching from archive recovery area */
	InArchiveRecovery = true;

4453
	/*
B
Bruce Momjian 已提交
4454 4455 4456 4457
	 * If user specified recovery_target_timeline, validate it or compute the
	 * "latest" value.	We can't do this until after we've gotten the restore
	 * command and set InArchiveRecovery, because we need to fetch timeline
	 * history files from the archive.
4458
	 */
4459 4460 4461 4462 4463 4464 4465
	if (rtliGiven)
	{
		if (rtli)
		{
			/* Timeline 1 does not have a history file, all else should */
			if (rtli != 1 && !existsTimeLineHistory(rtli))
				ereport(FATAL,
B
Bruce Momjian 已提交
4466 4467
						(errmsg("recovery_target_timeline %u does not exist",
								rtli)));
4468 4469 4470 4471 4472 4473 4474 4475
			recoveryTargetTLI = rtli;
		}
		else
		{
			/* We start the "latest" search from pg_control's timeline */
			recoveryTargetTLI = findNewestTimeLine(recoveryTargetTLI);
		}
	}
4476 4477 4478 4479 4480 4481
}

/*
 * Exit archive-recovery state
 */
static void
4482
exitArchiveRecovery(TimeLineID endTLI, uint32 endLogId, uint32 endLogSeg)
4483
{
B
Bruce Momjian 已提交
4484 4485
	char		recoveryPath[MAXPGPATH];
	char		xlogpath[MAXPGPATH];
4486 4487

	/*
4488
	 * We are no longer in archive recovery state.
4489 4490 4491 4492
	 */
	InArchiveRecovery = false;

	/*
B
Bruce Momjian 已提交
4493 4494 4495
	 * We should have the ending log segment currently open.  Verify, and then
	 * close it (to avoid problems on Windows with trying to rename or delete
	 * an open file).
4496 4497 4498 4499 4500 4501 4502 4503 4504
	 */
	Assert(readFile >= 0);
	Assert(readId == endLogId);
	Assert(readSeg == endLogSeg);

	close(readFile);
	readFile = -1;

	/*
B
Bruce Momjian 已提交
4505 4506 4507 4508 4509 4510 4511
	 * If the segment was fetched from archival storage, we want to replace
	 * the existing xlog segment (if any) with the archival version.  This is
	 * because whatever is in XLOGDIR is very possibly older than what we have
	 * from the archives, since it could have come from restoring a PGDATA
	 * backup.	In any case, the archival version certainly is more
	 * descriptive of what our current database state is, because that is what
	 * we replayed from.
4512
	 *
4513 4514 4515
	 * Note that if we are establishing a new timeline, ThisTimeLineID is
	 * already set to the new value, and so we will create a new file instead
	 * of overwriting any existing file.
4516
	 */
4517
	snprintf(recoveryPath, MAXPGPATH, XLOGDIR "/RECOVERYXLOG");
4518
	XLogFilePath(xlogpath, ThisTimeLineID, endLogId, endLogSeg);
4519 4520 4521 4522 4523 4524 4525 4526 4527 4528

	if (restoredFromArchive)
	{
		ereport(DEBUG3,
				(errmsg_internal("moving last restored xlog to \"%s\"",
								 xlogpath)));
		unlink(xlogpath);		/* might or might not exist */
		if (rename(recoveryPath, xlogpath) != 0)
			ereport(FATAL,
					(errcode_for_file_access(),
4529
					 errmsg("could not rename file \"%s\" to \"%s\": %m",
4530 4531 4532 4533 4534 4535 4536 4537 4538 4539
							recoveryPath, xlogpath)));
		/* XXX might we need to fix permissions on the file? */
	}
	else
	{
		/*
		 * If the latest segment is not archival, but there's still a
		 * RECOVERYXLOG laying about, get rid of it.
		 */
		unlink(recoveryPath);	/* ignore any error */
B
Bruce Momjian 已提交
4540

4541
		/*
B
Bruce Momjian 已提交
4542 4543 4544
		 * If we are establishing a new timeline, we have to copy data from
		 * the last WAL segment of the old timeline to create a starting WAL
		 * segment for the new timeline.
4545 4546 4547 4548
		 */
		if (endTLI != ThisTimeLineID)
			XLogFileCopy(endLogId, endLogSeg,
						 endTLI, endLogId, endLogSeg);
4549 4550 4551
	}

	/*
B
Bruce Momjian 已提交
4552 4553
	 * Let's just make real sure there are not .ready or .done flags posted
	 * for the new segment.
4554
	 */
4555 4556
	XLogFileName(xlogpath, ThisTimeLineID, endLogId, endLogSeg);
	XLogArchiveCleanup(xlogpath);
4557

4558
	/* Get rid of any remaining recovered timeline-history file, too */
4559
	snprintf(recoveryPath, MAXPGPATH, XLOGDIR "/RECOVERYHISTORY");
B
Bruce Momjian 已提交
4560
	unlink(recoveryPath);		/* ignore any error */
4561 4562

	/*
B
Bruce Momjian 已提交
4563 4564
	 * Rename the config file out of the way, so that we don't accidentally
	 * re-enter archive recovery mode in a subsequent crash.
4565
	 */
4566 4567
	unlink(RECOVERY_COMMAND_DONE);
	if (rename(RECOVERY_COMMAND_FILE, RECOVERY_COMMAND_DONE) != 0)
4568 4569
		ereport(FATAL,
				(errcode_for_file_access(),
4570
				 errmsg("could not rename file \"%s\" to \"%s\": %m",
4571
						RECOVERY_COMMAND_FILE, RECOVERY_COMMAND_DONE)));
4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582

	ereport(LOG,
			(errmsg("archive recovery complete")));
}

/*
 * For point-in-time recovery, this function decides whether we want to
 * stop applying the XLOG at or after the current record.
 *
 * Returns TRUE if we are stopping, FALSE otherwise.  On TRUE return,
 * *includeThis is set TRUE if we should apply this record before stopping.
4583 4584
 * Also, some information is saved in recoveryStopXid et al for use in
 * annotating the new timeline's history file.
4585 4586 4587 4588 4589
 */
static bool
recoveryStopsHere(XLogRecord *record, bool *includeThis)
{
	bool		stopsHere;
B
Bruce Momjian 已提交
4590
	uint8		record_info;
4591
	TimestampTz	recordXtime;
4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602

	/* Do we have a PITR target at all? */
	if (!recoveryTarget)
		return false;

	/* We only consider stopping at COMMIT or ABORT records */
	if (record->xl_rmid != RM_XACT_ID)
		return false;
	record_info = record->xl_info & ~XLR_INFO_MASK;
	if (record_info == XLOG_XACT_COMMIT)
	{
B
Bruce Momjian 已提交
4603
		xl_xact_commit *recordXactCommitData;
4604 4605

		recordXactCommitData = (xl_xact_commit *) XLogRecGetData(record);
4606
		recordXtime = recordXactCommitData->xact_time;
4607 4608 4609
	}
	else if (record_info == XLOG_XACT_ABORT)
	{
B
Bruce Momjian 已提交
4610
		xl_xact_abort *recordXactAbortData;
4611 4612

		recordXactAbortData = (xl_xact_abort *) XLogRecGetData(record);
4613
		recordXtime = recordXactAbortData->xact_time;
4614 4615 4616 4617 4618 4619 4620
	}
	else
		return false;

	if (recoveryTargetExact)
	{
		/*
B
Bruce Momjian 已提交
4621 4622
		 * there can be only one transaction end record with this exact
		 * transactionid
4623
		 *
B
Bruce Momjian 已提交
4624
		 * when testing for an xid, we MUST test for equality only, since
B
Bruce Momjian 已提交
4625 4626 4627
		 * transactions are numbered in the order they start, not the order
		 * they complete. A higher numbered xid will complete before you about
		 * 50% of the time...
4628 4629 4630 4631 4632 4633 4634 4635
		 */
		stopsHere = (record->xl_xid == recoveryTargetXid);
		if (stopsHere)
			*includeThis = recoveryTargetInclusive;
	}
	else
	{
		/*
B
Bruce Momjian 已提交
4636 4637 4638
		 * there can be many transactions that share the same commit time, so
		 * we stop after the last one, if we are inclusive, or stop at the
		 * first one if we are exclusive
4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649
		 */
		if (recoveryTargetInclusive)
			stopsHere = (recordXtime > recoveryTargetTime);
		else
			stopsHere = (recordXtime >= recoveryTargetTime);
		if (stopsHere)
			*includeThis = false;
	}

	if (stopsHere)
	{
4650 4651 4652 4653
		recoveryStopXid = record->xl_xid;
		recoveryStopTime = recordXtime;
		recoveryStopAfter = *includeThis;

4654 4655
		if (record_info == XLOG_XACT_COMMIT)
		{
4656
			if (recoveryStopAfter)
4657 4658
				ereport(LOG,
						(errmsg("recovery stopping after commit of transaction %u, time %s",
4659 4660
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4661 4662 4663
			else
				ereport(LOG,
						(errmsg("recovery stopping before commit of transaction %u, time %s",
4664 4665
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4666 4667 4668
		}
		else
		{
4669
			if (recoveryStopAfter)
4670 4671
				ereport(LOG,
						(errmsg("recovery stopping after abort of transaction %u, time %s",
4672 4673
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4674 4675 4676
			else
				ereport(LOG,
						(errmsg("recovery stopping before abort of transaction %u, time %s",
4677 4678
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4679 4680 4681 4682 4683 4684
		}
	}

	return stopsHere;
}

4685
/*
T
Tom Lane 已提交
4686
 * This must be called ONCE during postmaster or standalone-backend startup
4687 4688
 */
void
T
Tom Lane 已提交
4689
StartupXLOG(void)
4690
{
4691 4692
	XLogCtlInsert *Insert;
	CheckPoint	checkPoint;
T
Tom Lane 已提交
4693
	bool		wasShutdown;
4694
	bool		needNewTimeLine = false;
4695
	bool		haveBackupLabel = false;
4696
	XLogRecPtr	RecPtr,
T
Tom Lane 已提交
4697 4698
				LastRec,
				checkPointLoc,
4699
				minRecoveryLoc,
T
Tom Lane 已提交
4700
				EndOfLog;
4701 4702
	uint32		endLogId;
	uint32		endLogSeg;
4703
	XLogRecord *record;
4704
	uint32		freespace;
4705
	TransactionId oldestActiveXID;
4706

4707
	/*
4708 4709
	 * Read control file and check XLOG status looks valid.
	 *
4710 4711
	 * Note: in most control paths, *ControlFile is already valid and we need
	 * not do ReadControlFile() here, but might as well do it to be sure.
4712
	 */
4713
	ReadControlFile();
4714

4715
	if (ControlFile->state < DB_SHUTDOWNED ||
4716
		ControlFile->state > DB_IN_PRODUCTION ||
4717
		!XRecOffIsValid(ControlFile->checkPoint.xrecoff))
4718 4719
		ereport(FATAL,
				(errmsg("control file contains invalid data")));
4720 4721

	if (ControlFile->state == DB_SHUTDOWNED)
4722 4723 4724
		ereport(LOG,
				(errmsg("database system was shut down at %s",
						str_time(ControlFile->time))));
4725
	else if (ControlFile->state == DB_SHUTDOWNING)
4726
		ereport(LOG,
4727
				(errmsg("database system shutdown was interrupted; last known up at %s",
4728
						str_time(ControlFile->time))));
4729
	else if (ControlFile->state == DB_IN_CRASH_RECOVERY)
4730
		ereport(LOG,
B
Bruce Momjian 已提交
4731 4732 4733 4734
		   (errmsg("database system was interrupted while in recovery at %s",
				   str_time(ControlFile->time)),
			errhint("This probably means that some data is corrupted and"
					" you will have to use the last backup for recovery.")));
4735 4736
	else if (ControlFile->state == DB_IN_ARCHIVE_RECOVERY)
		ereport(LOG,
B
Bruce Momjian 已提交
4737 4738
				(errmsg("database system was interrupted while in recovery at log time %s",
						str_time(ControlFile->checkPointCopy.time)),
4739 4740
				 errhint("If this has occurred more than once some data might be corrupted"
				" and you might need to choose an earlier recovery target.")));
4741
	else if (ControlFile->state == DB_IN_PRODUCTION)
4742
		ereport(LOG,
4743
				(errmsg("database system was interrupted; last known up at %s",
4744
						str_time(ControlFile->time))));
4745

4746 4747
	/* This is just to allow attaching to startup process with a debugger */
#ifdef XLOG_REPLAY_DELAY
4748
	if (ControlFile->state != DB_SHUTDOWNED)
4749
		pg_usleep(60000000L);
4750 4751
#endif

4752
	/*
B
Bruce Momjian 已提交
4753 4754
	 * Initialize on the assumption we want to recover to the same timeline
	 * that's active according to pg_control.
4755 4756 4757
	 */
	recoveryTargetTLI = ControlFile->checkPointCopy.ThisTimeLineID;

4758
	/*
B
Bruce Momjian 已提交
4759 4760
	 * Check for recovery control file, and if so set up state for offline
	 * recovery
4761 4762 4763
	 */
	readRecoveryCommandFile();

4764 4765 4766
	/* Now we can determine the list of expected TLIs */
	expectedTLIs = readTimeLineHistory(recoveryTargetTLI);

4767 4768 4769 4770 4771 4772
	/*
	 * If pg_control's timeline is not in expectedTLIs, then we cannot
	 * proceed: the backup is not part of the history of the requested
	 * timeline.
	 */
	if (!list_member_int(expectedTLIs,
B
Bruce Momjian 已提交
4773
						 (int) ControlFile->checkPointCopy.ThisTimeLineID))
4774 4775 4776 4777 4778
		ereport(FATAL,
				(errmsg("requested timeline %u is not a child of database system timeline %u",
						recoveryTargetTLI,
						ControlFile->checkPointCopy.ThisTimeLineID)));

4779
	if (read_backup_label(&checkPointLoc, &minRecoveryLoc))
T
Tom Lane 已提交
4780
	{
4781
		/*
B
Bruce Momjian 已提交
4782 4783
		 * When a backup_label file is present, we want to roll forward from
		 * the checkpoint it identifies, rather than using pg_control.
4784
		 */
4785
		record = ReadCheckpointRecord(checkPointLoc, 0);
4786 4787
		if (record != NULL)
		{
4788
			ereport(DEBUG1,
4789
					(errmsg("checkpoint record is at %X/%X",
B
Bruce Momjian 已提交
4790
							checkPointLoc.xlogid, checkPointLoc.xrecoff)));
4791 4792 4793 4794 4795
			InRecovery = true;	/* force recovery even if SHUTDOWNED */
		}
		else
		{
			ereport(PANIC,
B
Bruce Momjian 已提交
4796 4797
					(errmsg("could not locate required checkpoint record"),
					 errhint("If you are not restoring from a backup, try removing the file \"%s/backup_label\".", DataDir)));
4798
		}
4799 4800
		/* set flag to delete it later */
		haveBackupLabel = true;
T
Tom Lane 已提交
4801 4802 4803
	}
	else
	{
4804
		/*
B
Bruce Momjian 已提交
4805 4806
		 * Get the last valid checkpoint record.  If the latest one according
		 * to pg_control is broken, try the next-to-last one.
4807 4808
		 */
		checkPointLoc = ControlFile->checkPoint;
4809
		record = ReadCheckpointRecord(checkPointLoc, 1);
T
Tom Lane 已提交
4810 4811
		if (record != NULL)
		{
4812
			ereport(DEBUG1,
4813
					(errmsg("checkpoint record is at %X/%X",
B
Bruce Momjian 已提交
4814
							checkPointLoc.xlogid, checkPointLoc.xrecoff)));
T
Tom Lane 已提交
4815 4816
		}
		else
4817 4818
		{
			checkPointLoc = ControlFile->prevCheckPoint;
4819
			record = ReadCheckpointRecord(checkPointLoc, 2);
4820 4821 4822
			if (record != NULL)
			{
				ereport(LOG,
B
Bruce Momjian 已提交
4823 4824 4825
						(errmsg("using previous checkpoint record at %X/%X",
							  checkPointLoc.xlogid, checkPointLoc.xrecoff)));
				InRecovery = true;		/* force recovery even if SHUTDOWNED */
4826 4827 4828
			}
			else
				ereport(PANIC,
B
Bruce Momjian 已提交
4829
					 (errmsg("could not locate a valid checkpoint record")));
4830
		}
T
Tom Lane 已提交
4831
	}
4832

T
Tom Lane 已提交
4833 4834 4835
	LastRec = RecPtr = checkPointLoc;
	memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
	wasShutdown = (record->xl_info == XLOG_CHECKPOINT_SHUTDOWN);
4836

4837
	ereport(DEBUG1,
4838
	 (errmsg("redo record is at %X/%X; shutdown %s",
B
Bruce Momjian 已提交
4839 4840
			 checkPoint.redo.xlogid, checkPoint.redo.xrecoff,
			 wasShutdown ? "TRUE" : "FALSE")));
4841
	ereport(DEBUG1,
4842 4843 4844
			(errmsg("next transaction ID: %u/%u; next OID: %u",
					checkPoint.nextXidEpoch, checkPoint.nextXid,
					checkPoint.nextOid)));
4845
	ereport(DEBUG1,
4846 4847
			(errmsg("next MultiXactId: %u; next MultiXactOffset: %u",
					checkPoint.nextMulti, checkPoint.nextMultiOffset)));
4848
	if (!TransactionIdIsNormal(checkPoint.nextXid))
4849
		ereport(PANIC,
4850
				(errmsg("invalid next transaction ID")));
4851 4852 4853

	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
4854
	ShmemVariableCache->oidCount = 0;
4855
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
4856

4857
	/*
B
Bruce Momjian 已提交
4858 4859 4860
	 * We must replay WAL entries using the same TimeLineID they were created
	 * under, so temporarily adopt the TLI indicated by the checkpoint (see
	 * also xlog_redo()).
4861
	 */
4862
	ThisTimeLineID = checkPoint.ThisTimeLineID;
4863

4864
	RedoRecPtr = XLogCtl->Insert.RedoRecPtr = checkPoint.redo;
V
WAL  
Vadim B. Mikheev 已提交
4865

4866
	if (XLByteLT(RecPtr, checkPoint.redo))
4867 4868
		ereport(PANIC,
				(errmsg("invalid redo in checkpoint record")));
4869

4870
	/*
B
Bruce Momjian 已提交
4871
	 * Check whether we need to force recovery from WAL.  If it appears to
B
Bruce Momjian 已提交
4872 4873
	 * have been a clean shutdown and we did not have a recovery.conf file,
	 * then assume no recovery needed.
4874
	 */
4875
	if (XLByteLT(checkPoint.redo, RecPtr))
4876
	{
T
Tom Lane 已提交
4877
		if (wasShutdown)
4878
			ereport(PANIC,
4879
				(errmsg("invalid redo record in shutdown checkpoint")));
V
WAL  
Vadim B. Mikheev 已提交
4880
		InRecovery = true;
4881 4882
	}
	else if (ControlFile->state != DB_SHUTDOWNED)
V
WAL  
Vadim B. Mikheev 已提交
4883
		InRecovery = true;
4884 4885 4886 4887 4888
	else if (InArchiveRecovery)
	{
		/* force recovery due to presence of recovery.conf */
		InRecovery = true;
	}
4889

V
WAL  
Vadim B. Mikheev 已提交
4890
	/* REDO */
4891
	if (InRecovery)
4892
	{
B
Bruce Momjian 已提交
4893
		int			rmid;
4894

4895
		/*
B
Bruce Momjian 已提交
4896 4897 4898 4899
		 * Update pg_control to show that we are recovering and to show the
		 * selected checkpoint as the place we are starting from. We also mark
		 * pg_control with any minimum recovery stop point obtained from a
		 * backup history file.
4900
		 */
4901
		if (InArchiveRecovery)
4902
		{
4903
			ereport(LOG,
4904
					(errmsg("automatic recovery in progress")));
4905 4906
			ControlFile->state = DB_IN_ARCHIVE_RECOVERY;
		}
4907
		else
4908
		{
4909
			ereport(LOG,
4910 4911
					(errmsg("database system was not properly shut down; "
							"automatic recovery in progress")));
4912 4913 4914 4915 4916 4917 4918
			ControlFile->state = DB_IN_CRASH_RECOVERY;
		}
		ControlFile->prevCheckPoint = ControlFile->checkPoint;
		ControlFile->checkPoint = checkPointLoc;
		ControlFile->checkPointCopy = checkPoint;
		if (minRecoveryLoc.xlogid != 0 || minRecoveryLoc.xrecoff != 0)
			ControlFile->minRecoveryPoint = minRecoveryLoc;
4919 4920 4921
		ControlFile->time = time(NULL);
		UpdateControlFile();

4922
		/*
B
Bruce Momjian 已提交
4923 4924 4925 4926 4927 4928
		 * If there was a backup label file, it's done its job and the info
		 * has now been propagated into pg_control.  We must get rid of the
		 * label file so that if we crash during recovery, we'll pick up at
		 * the latest recovery restartpoint instead of going all the way back
		 * to the backup start point.  It seems prudent though to just rename
		 * the file out of the way rather than delete it completely.
4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939
		 */
		if (haveBackupLabel)
		{
			unlink(BACKUP_LABEL_OLD);
			if (rename(BACKUP_LABEL_FILE, BACKUP_LABEL_OLD) != 0)
				ereport(FATAL,
						(errcode_for_file_access(),
						 errmsg("could not rename file \"%s\" to \"%s\": %m",
								BACKUP_LABEL_FILE, BACKUP_LABEL_OLD)));
		}

4940
		/* Start up the recovery environment */
V
WAL  
Vadim B. Mikheev 已提交
4941
		XLogInitRelationCache();
V
Vadim B. Mikheev 已提交
4942

4943 4944 4945 4946 4947 4948
		for (rmid = 0; rmid <= RM_MAX_ID; rmid++)
		{
			if (RmgrTable[rmid].rm_startup != NULL)
				RmgrTable[rmid].rm_startup();
		}

4949
		/*
B
Bruce Momjian 已提交
4950 4951
		 * Find the first record that logically follows the checkpoint --- it
		 * might physically precede it, though.
4952
		 */
4953
		if (XLByteLT(checkPoint.redo, RecPtr))
4954 4955
		{
			/* back up to find the record */
4956
			record = ReadRecord(&(checkPoint.redo), PANIC);
4957
		}
B
Bruce Momjian 已提交
4958
		else
4959
		{
4960
			/* just have to read next record after CheckPoint */
4961
			record = ReadRecord(NULL, LOG);
4962
		}
4963

T
Tom Lane 已提交
4964
		if (record != NULL)
4965
		{
4966 4967
			bool		recoveryContinue = true;
			bool		recoveryApply = true;
B
Bruce Momjian 已提交
4968
			ErrorContextCallback errcontext;
4969

V
WAL  
Vadim B. Mikheev 已提交
4970
			InRedo = true;
4971 4972 4973
			ereport(LOG,
					(errmsg("redo starts at %X/%X",
							ReadRecPtr.xlogid, ReadRecPtr.xrecoff)));
4974 4975 4976 4977

			/*
			 * main redo apply loop
			 */
4978 4979
			do
			{
4980
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
4981 4982
				if (XLOG_DEBUG)
				{
B
Bruce Momjian 已提交
4983
					StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
4984

4985 4986
					initStringInfo(&buf);
					appendStringInfo(&buf, "REDO @ %X/%X; LSN %X/%X: ",
B
Bruce Momjian 已提交
4987 4988
									 ReadRecPtr.xlogid, ReadRecPtr.xrecoff,
									 EndRecPtr.xlogid, EndRecPtr.xrecoff);
4989 4990 4991 4992
					xlog_outrec(&buf, record);
					appendStringInfo(&buf, " - ");
					RmgrTable[record->xl_rmid].rm_desc(&buf,
													   record->xl_info,
B
Bruce Momjian 已提交
4993
													 XLogRecGetData(record));
4994 4995
					elog(LOG, "%s", buf.data);
					pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
4996
				}
4997
#endif
V
WAL  
Vadim B. Mikheev 已提交
4998

4999 5000 5001 5002 5003
				/*
				 * Have we reached our recovery target?
				 */
				if (recoveryStopsHere(record, &recoveryApply))
				{
B
Bruce Momjian 已提交
5004
					needNewTimeLine = true;		/* see below */
5005 5006 5007 5008 5009
					recoveryContinue = false;
					if (!recoveryApply)
						break;
				}

5010 5011 5012 5013 5014 5015
				/* Setup error traceback support for ereport() */
				errcontext.callback = rm_redo_error_callback;
				errcontext.arg = (void *) record;
				errcontext.previous = error_context_stack;
				error_context_stack = &errcontext;

5016 5017
				/* nextXid must be beyond record's xid */
				if (TransactionIdFollowsOrEquals(record->xl_xid,
B
Bruce Momjian 已提交
5018
												 ShmemVariableCache->nextXid))
5019 5020 5021 5022 5023
				{
					ShmemVariableCache->nextXid = record->xl_xid;
					TransactionIdAdvance(ShmemVariableCache->nextXid);
				}

T
Tom Lane 已提交
5024
				if (record->xl_info & XLR_BKP_BLOCK_MASK)
5025 5026
					RestoreBkpBlocks(record, EndRecPtr);

5027
				RmgrTable[record->xl_rmid].rm_redo(EndRecPtr, record);
5028

5029 5030 5031
				/* Pop the error context stack */
				error_context_stack = errcontext.previous;

5032 5033
				LastRec = ReadRecPtr;

5034
				record = ReadRecord(NULL, LOG);
5035
			} while (record != NULL && recoveryContinue);
B
Bruce Momjian 已提交
5036

5037 5038 5039 5040
			/*
			 * end of main redo apply loop
			 */

5041 5042 5043
			ereport(LOG,
					(errmsg("redo done at %X/%X",
							ReadRecPtr.xlogid, ReadRecPtr.xrecoff)));
V
WAL  
Vadim B. Mikheev 已提交
5044
			InRedo = false;
5045 5046
		}
		else
5047 5048
		{
			/* there are no WAL records following the checkpoint */
5049 5050
			ereport(LOG,
					(errmsg("redo is not required")));
5051
		}
V
WAL  
Vadim B. Mikheev 已提交
5052 5053
	}

T
Tom Lane 已提交
5054
	/*
B
Bruce Momjian 已提交
5055 5056
	 * Re-fetch the last valid or last applied record, so we can identify the
	 * exact endpoint of what we consider the valid portion of WAL.
T
Tom Lane 已提交
5057
	 */
5058
	record = ReadRecord(&LastRec, PANIC);
T
Tom Lane 已提交
5059
	EndOfLog = EndRecPtr;
5060 5061
	XLByteToPrevSeg(EndOfLog, endLogId, endLogSeg);

5062 5063 5064 5065
	/*
	 * Complain if we did not roll forward far enough to render the backup
	 * dump consistent.
	 */
5066
	if (XLByteLT(EndOfLog, ControlFile->minRecoveryPoint))
5067 5068 5069 5070
	{
		if (needNewTimeLine)	/* stopped because of stop request */
			ereport(FATAL,
					(errmsg("requested recovery stop point is before end time of backup dump")));
B
Bruce Momjian 已提交
5071
		else
5072
			/* ran off end of WAL */
5073 5074 5075 5076
			ereport(FATAL,
					(errmsg("WAL ends before end time of backup dump")));
	}

5077 5078 5079
	/*
	 * Consider whether we need to assign a new timeline ID.
	 *
B
Bruce Momjian 已提交
5080 5081
	 * If we stopped short of the end of WAL during recovery, then we are
	 * generating a new timeline and must assign it a unique new ID.
B
Bruce Momjian 已提交
5082 5083
	 * Otherwise, we can just extend the timeline we were in when we ran out
	 * of WAL.
5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096
	 */
	if (needNewTimeLine)
	{
		ThisTimeLineID = findNewestTimeLine(recoveryTargetTLI) + 1;
		ereport(LOG,
				(errmsg("selected new timeline ID: %u", ThisTimeLineID)));
		writeTimeLineHistory(ThisTimeLineID, recoveryTargetTLI,
							 curFileTLI, endLogId, endLogSeg);
	}

	/* Save the selected TimeLineID in shared memory, too */
	XLogCtl->ThisTimeLineID = ThisTimeLineID;

5097
	/*
B
Bruce Momjian 已提交
5098 5099 5100 5101
	 * We are now done reading the old WAL.  Turn off archive fetching if it
	 * was active, and make a writable copy of the last WAL segment. (Note
	 * that we also have a copy of the last block of the old WAL in readBuf;
	 * we will use that below.)
5102 5103
	 */
	if (InArchiveRecovery)
5104
		exitArchiveRecovery(curFileTLI, endLogId, endLogSeg);
5105 5106 5107 5108 5109 5110 5111 5112

	/*
	 * Prepare to write WAL starting at EndOfLog position, and init xlog
	 * buffer cache using the block containing the last record from the
	 * previous incarnation.
	 */
	openLogId = endLogId;
	openLogSeg = endLogSeg;
5113
	openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
5114
	openLogOff = 0;
V
WAL  
Vadim B. Mikheev 已提交
5115
	Insert = &XLogCtl->Insert;
5116
	Insert->PrevRecord = LastRec;
5117 5118
	XLogCtl->xlblocks[0].xlogid = openLogId;
	XLogCtl->xlblocks[0].xrecoff =
5119
		((EndOfLog.xrecoff - 1) / XLOG_BLCKSZ + 1) * XLOG_BLCKSZ;
B
Bruce Momjian 已提交
5120 5121

	/*
B
Bruce Momjian 已提交
5122 5123 5124
	 * Tricky point here: readBuf contains the *last* block that the LastRec
	 * record spans, not the one it starts in.	The last block is indeed the
	 * one we want to use.
T
Tom Lane 已提交
5125
	 */
5126 5127
	Assert(readOff == (XLogCtl->xlblocks[0].xrecoff - XLOG_BLCKSZ) % XLogSegSize);
	memcpy((char *) Insert->currpage, readBuf, XLOG_BLCKSZ);
5128
	Insert->currpos = (char *) Insert->currpage +
5129
		(EndOfLog.xrecoff + XLOG_BLCKSZ - XLogCtl->xlblocks[0].xrecoff);
V
WAL  
Vadim B. Mikheev 已提交
5130

T
Tom Lane 已提交
5131
	LogwrtResult.Write = LogwrtResult.Flush = EndOfLog;
V
WAL  
Vadim B. Mikheev 已提交
5132

T
Tom Lane 已提交
5133 5134 5135
	XLogCtl->Write.LogwrtResult = LogwrtResult;
	Insert->LogwrtResult = LogwrtResult;
	XLogCtl->LogwrtResult = LogwrtResult;
V
WAL  
Vadim B. Mikheev 已提交
5136

T
Tom Lane 已提交
5137 5138
	XLogCtl->LogwrtRqst.Write = EndOfLog;
	XLogCtl->LogwrtRqst.Flush = EndOfLog;
5139

5140 5141 5142 5143 5144 5145 5146 5147 5148 5149
	freespace = INSERT_FREESPACE(Insert);
	if (freespace > 0)
	{
		/* Make sure rest of page is zero */
		MemSet(Insert->currpos, 0, freespace);
		XLogCtl->Write.curridx = 0;
	}
	else
	{
		/*
B
Bruce Momjian 已提交
5150 5151
		 * Whenever Write.LogwrtResult points to exactly the end of a page,
		 * Write.curridx must point to the *next* page (see XLogWrite()).
5152
		 *
B
Bruce Momjian 已提交
5153
		 * Note: it might seem we should do AdvanceXLInsertBuffer() here, but
B
Bruce Momjian 已提交
5154
		 * this is sufficient.	The first actual attempt to insert a log
5155
		 * record will advance the insert state.
5156 5157 5158 5159
		 */
		XLogCtl->Write.curridx = NextBufIdx(0);
	}

5160 5161
	/* Pre-scan prepared transactions to find out the range of XIDs present */
	oldestActiveXID = PrescanPreparedTransactions();
5162

V
WAL  
Vadim B. Mikheev 已提交
5163
	if (InRecovery)
5164
	{
B
Bruce Momjian 已提交
5165
		int			rmid;
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175

		/*
		 * Allow resource managers to do any required cleanup.
		 */
		for (rmid = 0; rmid <= RM_MAX_ID; rmid++)
		{
			if (RmgrTable[rmid].rm_cleanup != NULL)
				RmgrTable[rmid].rm_cleanup();
		}

5176 5177 5178 5179 5180 5181
		/*
		 * Check to see if the XLOG sequence contained any unresolved
		 * references to uninitialized pages.
		 */
		XLogCheckInvalidPages();

5182 5183 5184 5185 5186
		/*
		 * Reset pgstat data, because it may be invalid after recovery.
		 */
		pgstat_reset_all();

T
Tom Lane 已提交
5187
		/*
5188
		 * Perform a checkpoint to update all our recovery activity to disk.
5189
		 *
5190 5191 5192 5193 5194
		 * Note that we write a shutdown checkpoint rather than an on-line
		 * one. This is not particularly critical, but since we may be
		 * assigning a new TLI, using a shutdown checkpoint allows us to have
		 * the rule that TLI only changes in shutdown checkpoints, which
		 * allows some extra error checking in xlog_redo.
T
Tom Lane 已提交
5195
		 */
5196
		CreateCheckPoint(CHECKPOINT_IS_SHUTDOWN | CHECKPOINT_IMMEDIATE);
5197 5198 5199 5200

		/*
		 * Close down recovery environment
		 */
V
WAL  
Vadim B. Mikheev 已提交
5201
		XLogCloseRelationCache();
5202
	}
5203

T
Tom Lane 已提交
5204 5205 5206
	/*
	 * Preallocate additional log files, if wanted.
	 */
5207
	PreallocXlogFiles(EndOfLog);
5208

5209 5210 5211
	/*
	 * Okay, we're officially UP.
	 */
V
WAL  
Vadim B. Mikheev 已提交
5212
	InRecovery = false;
5213 5214 5215 5216 5217

	ControlFile->state = DB_IN_PRODUCTION;
	ControlFile->time = time(NULL);
	UpdateControlFile();

5218 5219 5220
	/* start the archive_timeout timer running */
	XLogCtl->Write.lastSegSwitchTime = ControlFile->time;

5221 5222 5223 5224
	/* initialize shared-memory copy of latest checkpoint XID/epoch */
	XLogCtl->ckptXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	XLogCtl->ckptXid = ControlFile->checkPointCopy.nextXid;

5225
	/* Start up the commit log and related stuff, too */
5226
	StartupCLOG();
5227
	StartupSUBTRANS(oldestActiveXID);
5228
	StartupMultiXact();
5229

5230 5231 5232
	/* Reload shared-memory state for prepared transactions */
	RecoverPreparedTransactions();

T
Tom Lane 已提交
5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243
	/* Shut down readFile facility, free space */
	if (readFile >= 0)
	{
		close(readFile);
		readFile = -1;
	}
	if (readBuf)
	{
		free(readBuf);
		readBuf = NULL;
	}
5244 5245 5246 5247 5248 5249
	if (readRecordBuf)
	{
		free(readRecordBuf);
		readRecordBuf = NULL;
		readRecordBufSize = 0;
	}
T
Tom Lane 已提交
5250 5251
}

5252 5253
/*
 * Subroutine to try to fetch and validate a prior checkpoint record.
5254 5255 5256
 *
 * whichChkpt identifies the checkpoint (merely for reporting purposes).
 * 1 for "primary", 2 for "secondary", 0 for "other" (backup_label)
5257
 */
T
Tom Lane 已提交
5258
static XLogRecord *
5259
ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt)
T
Tom Lane 已提交
5260 5261 5262 5263 5264
{
	XLogRecord *record;

	if (!XRecOffIsValid(RecPtr.xrecoff))
	{
5265 5266 5267 5268
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5269
				(errmsg("invalid primary checkpoint link in control file")));
5270 5271 5272 5273 5274 5275 5276
				break;
			case 2:
				ereport(LOG,
						(errmsg("invalid secondary checkpoint link in control file")));
				break;
			default:
				ereport(LOG,
B
Bruce Momjian 已提交
5277
				   (errmsg("invalid checkpoint link in backup_label file")));
5278 5279
				break;
		}
T
Tom Lane 已提交
5280 5281 5282
		return NULL;
	}

5283
	record = ReadRecord(&RecPtr, LOG);
T
Tom Lane 已提交
5284 5285 5286

	if (record == NULL)
	{
5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
						(errmsg("invalid primary checkpoint record")));
				break;
			case 2:
				ereport(LOG,
						(errmsg("invalid secondary checkpoint record")));
				break;
			default:
				ereport(LOG,
						(errmsg("invalid checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5302 5303 5304 5305
		return NULL;
	}
	if (record->xl_rmid != RM_XLOG_ID)
	{
5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
						(errmsg("invalid resource manager ID in primary checkpoint record")));
				break;
			case 2:
				ereport(LOG,
						(errmsg("invalid resource manager ID in secondary checkpoint record")));
				break;
			default:
				ereport(LOG,
B
Bruce Momjian 已提交
5318
				(errmsg("invalid resource manager ID in checkpoint record")));
5319 5320
				break;
		}
T
Tom Lane 已提交
5321 5322 5323 5324 5325
		return NULL;
	}
	if (record->xl_info != XLOG_CHECKPOINT_SHUTDOWN &&
		record->xl_info != XLOG_CHECKPOINT_ONLINE)
	{
5326 5327 5328 5329
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5330
				   (errmsg("invalid xl_info in primary checkpoint record")));
5331 5332 5333
				break;
			case 2:
				ereport(LOG,
B
Bruce Momjian 已提交
5334
				 (errmsg("invalid xl_info in secondary checkpoint record")));
5335 5336 5337 5338 5339 5340
				break;
			default:
				ereport(LOG,
						(errmsg("invalid xl_info in checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5341 5342
		return NULL;
	}
5343 5344
	if (record->xl_len != sizeof(CheckPoint) ||
		record->xl_tot_len != SizeOfXLogRecord + sizeof(CheckPoint))
T
Tom Lane 已提交
5345
	{
5346 5347 5348 5349
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5350
					(errmsg("invalid length of primary checkpoint record")));
5351 5352 5353
				break;
			case 2:
				ereport(LOG,
B
Bruce Momjian 已提交
5354
				  (errmsg("invalid length of secondary checkpoint record")));
5355 5356 5357 5358 5359 5360
				break;
			default:
				ereport(LOG,
						(errmsg("invalid length of checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5361 5362 5363
		return NULL;
	}
	return record;
5364 5365
}

V
WAL  
Vadim B. Mikheev 已提交
5366
/*
5367 5368
 * This must be called during startup of a backend process, except that
 * it need not be called in a standalone backend (which does StartupXLOG
5369
 * instead).  We need to initialize the local copies of ThisTimeLineID and
5370 5371
 * RedoRecPtr.
 *
5372
 * Note: before Postgres 8.0, we went to some effort to keep the postmaster
5373
 * process's copies of ThisTimeLineID and RedoRecPtr valid too.  This was
5374
 * unnecessary however, since the postmaster itself never touches XLOG anyway.
V
WAL  
Vadim B. Mikheev 已提交
5375 5376
 */
void
5377
InitXLOGAccess(void)
V
WAL  
Vadim B. Mikheev 已提交
5378
{
5379 5380
	/* ThisTimeLineID doesn't change so we need no lock to copy it */
	ThisTimeLineID = XLogCtl->ThisTimeLineID;
5381 5382
	/* Use GetRedoRecPtr to copy the RedoRecPtr safely */
	(void) GetRedoRecPtr();
5383 5384 5385 5386 5387 5388 5389 5390
}

/*
 * Once spawned, a backend may update its local RedoRecPtr from
 * XLogCtl->Insert.RedoRecPtr; it must hold the insert lock or info_lck
 * to do so.  This is done in XLogInsert() or GetRedoRecPtr().
 */
XLogRecPtr
5391 5392
GetRedoRecPtr(void)
{
5393 5394 5395
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;

5396
	SpinLockAcquire(&xlogctl->info_lck);
5397 5398
	Assert(XLByteLE(RedoRecPtr, xlogctl->Insert.RedoRecPtr));
	RedoRecPtr = xlogctl->Insert.RedoRecPtr;
5399
	SpinLockRelease(&xlogctl->info_lck);
5400 5401

	return RedoRecPtr;
V
WAL  
Vadim B. Mikheev 已提交
5402 5403
}

5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426
/*
 * GetInsertRecPtr -- Returns the current insert position.
 *
 * NOTE: The value *actually* returned is the position of the last full
 * xlog page. It lags behind the real insert position by at most 1 page.
 * For that, we don't need to acquire WALInsertLock which can be quite
 * heavily contended, and an approximation is enough for the current
 * usage of this function.
 */
XLogRecPtr
GetInsertRecPtr(void)
{
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;
	XLogRecPtr recptr;

	SpinLockAcquire(&xlogctl->info_lck);
	recptr = xlogctl->LogwrtRqst.Write;
	SpinLockRelease(&xlogctl->info_lck);

	return recptr;
}

5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442
/*
 * Get the time of the last xlog segment switch
 */
time_t
GetLastSegSwitchTime(void)
{
	time_t		result;

	/* Need WALWriteLock, but shared lock is sufficient */
	LWLockAcquire(WALWriteLock, LW_SHARED);
	result = XLogCtl->Write.lastSegSwitchTime;
	LWLockRelease(WALWriteLock);

	return result;
}

5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453
/*
 * GetNextXidAndEpoch - get the current nextXid value and associated epoch
 *
 * This is exported for use by code that would like to have 64-bit XIDs.
 * We don't really support such things, but all XIDs within the system
 * can be presumed "close to" the result, and thus the epoch associated
 * with them can be determined.
 */
void
GetNextXidAndEpoch(TransactionId *xid, uint32 *epoch)
{
B
Bruce Momjian 已提交
5454 5455 5456
	uint32		ckptXidEpoch;
	TransactionId ckptXid;
	TransactionId nextXid;
5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482

	/* Must read checkpoint info first, else have race condition */
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

		SpinLockAcquire(&xlogctl->info_lck);
		ckptXidEpoch = xlogctl->ckptXidEpoch;
		ckptXid = xlogctl->ckptXid;
		SpinLockRelease(&xlogctl->info_lck);
	}

	/* Now fetch current nextXid */
	nextXid = ReadNewTransactionId();

	/*
	 * nextXid is certainly logically later than ckptXid.  So if it's
	 * numerically less, it must have wrapped into the next epoch.
	 */
	if (nextXid < ckptXid)
		ckptXidEpoch++;

	*xid = nextXid;
	*epoch = ckptXidEpoch;
}

5483
/*
T
Tom Lane 已提交
5484
 * This must be called ONCE during postmaster or standalone-backend shutdown
5485 5486
 */
void
5487
ShutdownXLOG(int code, Datum arg)
5488
{
5489 5490
	ereport(LOG,
			(errmsg("shutting down")));
5491

5492
	CreateCheckPoint(CHECKPOINT_IS_SHUTDOWN | CHECKPOINT_IMMEDIATE);
5493
	ShutdownCLOG();
5494
	ShutdownSUBTRANS();
5495
	ShutdownMultiXact();
5496

5497 5498
	ereport(LOG,
			(errmsg("database system is shut down")));
5499 5500
}

5501
/*
5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515
 * Log start of a checkpoint.
 */
static void
LogCheckpointStart(int flags)
{
	elog(LOG, "checkpoint starting:%s%s%s%s%s%s",
		 (flags & CHECKPOINT_IS_SHUTDOWN) ? " shutdown" : "",
		 (flags & CHECKPOINT_IMMEDIATE) ? " immediate" : "",
		 (flags & CHECKPOINT_FORCE) ? " force" : "",
		 (flags & CHECKPOINT_WAIT) ? " wait" : "",
		 (flags & CHECKPOINT_CAUSE_XLOG) ? " xlog" : "",
		 (flags & CHECKPOINT_CAUSE_TIME) ? " time" : "");
}

5516
/*
5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551
 * Log end of a checkpoint.
 */
static void
LogCheckpointEnd(void)
{
	long	write_secs, sync_secs, total_secs;
	int		write_usecs, sync_usecs, total_usecs;

	CheckpointStats.ckpt_end_t = GetCurrentTimestamp();

	TimestampDifference(CheckpointStats.ckpt_start_t,
						CheckpointStats.ckpt_end_t,
						&total_secs, &total_usecs);

	TimestampDifference(CheckpointStats.ckpt_write_t,
						CheckpointStats.ckpt_sync_t,
						&write_secs, &write_usecs);

	TimestampDifference(CheckpointStats.ckpt_sync_t,
						CheckpointStats.ckpt_sync_end_t,
						&sync_secs, &sync_usecs);

	elog(LOG, "checkpoint complete: wrote %d buffers (%.1f%%); "
		 "%d transaction log file(s) added, %d removed, %d recycled; "
		 "write=%ld.%03d s, sync=%ld.%03d s, total=%ld.%03d s",
		 CheckpointStats.ckpt_bufs_written,
		 (double) CheckpointStats.ckpt_bufs_written * 100 / NBuffers,
		 CheckpointStats.ckpt_segs_added,
		 CheckpointStats.ckpt_segs_removed,
		 CheckpointStats.ckpt_segs_recycled,
		 write_secs, write_usecs/1000,
		 sync_secs, sync_usecs/1000,
		 total_secs, total_usecs/1000);
}

T
Tom Lane 已提交
5552 5553
/*
 * Perform a checkpoint --- either during shutdown, or on-the-fly
5554
 *
5555 5556 5557
 * flags is a bitwise OR of the following:
 *	CHECKPOINT_IS_SHUTDOWN: checkpoint is for database shutdown.
 *	CHECKPOINT_IMMEDIATE: finish the checkpoint ASAP,
5558
 *		ignoring checkpoint_completion_target parameter.
5559 5560 5561
 *	CHECKPOINT_FORCE: force a checkpoint even if no XLOG activity has occured
 *		since the last one (implied by CHECKPOINT_IS_SHUTDOWN).
 *
5562
 * Note: flags contains other bits, of interest here only for logging purposes.
5563 5564
 * In particular note that this routine is synchronous and does not pay
 * attention to CHECKPOINT_WAIT.
T
Tom Lane 已提交
5565
 */
5566
void
5567
CreateCheckPoint(int flags)
5568
{
5569
	bool		shutdown = (flags & CHECKPOINT_IS_SHUTDOWN) != 0;
5570 5571 5572
	CheckPoint	checkPoint;
	XLogRecPtr	recptr;
	XLogCtlInsert *Insert = &XLogCtl->Insert;
B
Bruce Momjian 已提交
5573
	XLogRecData rdata;
5574
	uint32		freespace;
V
Vadim B. Mikheev 已提交
5575 5576
	uint32		_logId;
	uint32		_logSeg;
5577 5578
	TransactionId *inCommitXids;
	int			nInCommit;
V
Vadim B. Mikheev 已提交
5579

5580
	/*
B
Bruce Momjian 已提交
5581 5582 5583 5584
	 * Acquire CheckpointLock to ensure only one checkpoint happens at a time.
	 * (This is just pro forma, since in the present system structure there is
	 * only one process that is allowed to issue checkpoints at any given
	 * time.)
5585
	 */
5586
	LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
5587

5588 5589 5590 5591 5592 5593 5594 5595 5596 5597
	/*
	 * Prepare to accumulate statistics.
	 *
	 * Note: because it is possible for log_checkpoints to change while a
	 * checkpoint proceeds, we always accumulate stats, even if
	 * log_checkpoints is currently off.
	 */
	MemSet(&CheckpointStats, 0, sizeof(CheckpointStats));
	CheckpointStats.ckpt_start_t = GetCurrentTimestamp();

5598 5599 5600
	/*
	 * Use a critical section to force system panic if we have trouble.
	 */
5601 5602
	START_CRIT_SECTION();

5603 5604 5605 5606 5607 5608
	if (shutdown)
	{
		ControlFile->state = DB_SHUTDOWNING;
		ControlFile->time = time(NULL);
		UpdateControlFile();
	}
T
Tom Lane 已提交
5609

5610
	MemSet(&checkPoint, 0, sizeof(checkPoint));
5611
	checkPoint.ThisTimeLineID = ThisTimeLineID;
T
Tom Lane 已提交
5612
	checkPoint.time = time(NULL);
5613

5614
	/*
5615 5616
	 * We must hold WALInsertLock while examining insert state to determine
	 * the checkpoint REDO pointer.
5617
	 */
5618
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
T
Tom Lane 已提交
5619 5620

	/*
B
Bruce Momjian 已提交
5621 5622 5623 5624 5625 5626 5627 5628
	 * If this isn't a shutdown or forced checkpoint, and we have not inserted
	 * any XLOG records since the start of the last checkpoint, skip the
	 * checkpoint.	The idea here is to avoid inserting duplicate checkpoints
	 * when the system is idle. That wastes log space, and more importantly it
	 * exposes us to possible loss of both current and previous checkpoint
	 * records if the machine crashes just as we're writing the update.
	 * (Perhaps it'd make even more sense to checkpoint only when the previous
	 * checkpoint record is in a different xlog page?)
T
Tom Lane 已提交
5629
	 *
5630 5631 5632 5633
	 * We have to make two tests to determine that nothing has happened since
	 * the start of the last checkpoint: current insertion point must match
	 * the end of the last checkpoint record, and its redo pointer must point
	 * to itself.
T
Tom Lane 已提交
5634
	 */
5635
	if ((flags & (CHECKPOINT_IS_SHUTDOWN | CHECKPOINT_FORCE)) == 0)
T
Tom Lane 已提交
5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647
	{
		XLogRecPtr	curInsert;

		INSERT_RECPTR(curInsert, Insert, Insert->curridx);
		if (curInsert.xlogid == ControlFile->checkPoint.xlogid &&
			curInsert.xrecoff == ControlFile->checkPoint.xrecoff +
			MAXALIGN(SizeOfXLogRecord + sizeof(CheckPoint)) &&
			ControlFile->checkPoint.xlogid ==
			ControlFile->checkPointCopy.redo.xlogid &&
			ControlFile->checkPoint.xrecoff ==
			ControlFile->checkPointCopy.redo.xrecoff)
		{
5648 5649
			LWLockRelease(WALInsertLock);
			LWLockRelease(CheckpointLock);
T
Tom Lane 已提交
5650 5651 5652 5653 5654 5655 5656 5657
			END_CRIT_SECTION();
			return;
		}
	}

	/*
	 * Compute new REDO record ptr = location of next XLOG record.
	 *
B
Bruce Momjian 已提交
5658 5659 5660 5661
	 * NB: this is NOT necessarily where the checkpoint record itself will be,
	 * since other backends may insert more XLOG records while we're off doing
	 * the buffer flush work.  Those XLOG records are logically after the
	 * checkpoint, even though physically before it.  Got that?
T
Tom Lane 已提交
5662 5663
	 */
	freespace = INSERT_FREESPACE(Insert);
5664 5665
	if (freespace < SizeOfXLogRecord)
	{
5666
		(void) AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
5667
		/* OK to ignore update return flag, since we will do flush anyway */
5668
		freespace = INSERT_FREESPACE(Insert);
5669
	}
T
Tom Lane 已提交
5670
	INSERT_RECPTR(checkPoint.redo, Insert, Insert->curridx);
B
Bruce Momjian 已提交
5671

T
Tom Lane 已提交
5672
	/*
B
Bruce Momjian 已提交
5673 5674
	 * Here we update the shared RedoRecPtr for future XLogInsert calls; this
	 * must be done while holding the insert lock AND the info_lck.
5675
	 *
B
Bruce Momjian 已提交
5676
	 * Note: if we fail to complete the checkpoint, RedoRecPtr will be left
B
Bruce Momjian 已提交
5677 5678 5679 5680 5681
	 * pointing past where it really needs to point.  This is okay; the only
	 * consequence is that XLogInsert might back up whole buffers that it
	 * didn't really need to.  We can't postpone advancing RedoRecPtr because
	 * XLogInserts that happen while we are dumping buffers must assume that
	 * their buffer changes are not included in the checkpoint.
T
Tom Lane 已提交
5682
	 */
5683 5684 5685 5686
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

5687
		SpinLockAcquire(&xlogctl->info_lck);
5688
		RedoRecPtr = xlogctl->Insert.RedoRecPtr = checkPoint.redo;
5689
		SpinLockRelease(&xlogctl->info_lck);
5690
	}
B
Bruce Momjian 已提交
5691

T
Tom Lane 已提交
5692
	/*
5693 5694
	 * Now we can release WAL insert lock, allowing other xacts to proceed
	 * while we are flushing disk buffers.
T
Tom Lane 已提交
5695
	 */
5696
	LWLockRelease(WALInsertLock);
5697

5698 5699 5700 5701 5702 5703
	/*
	 * If enabled, log checkpoint start.  We postpone this until now
	 * so as not to log anything if we decided to skip the checkpoint.
	 */
	if (log_checkpoints)
		LogCheckpointStart(flags);
5704

5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737
	/*
	 * Before flushing data, we must wait for any transactions that are
	 * currently in their commit critical sections.  If an xact inserted its
	 * commit record into XLOG just before the REDO point, then a crash
	 * restart from the REDO point would not replay that record, which means
	 * that our flushing had better include the xact's update of pg_clog.  So
	 * we wait till he's out of his commit critical section before proceeding.
	 * See notes in RecordTransactionCommit().
	 *
	 * Because we've already released WALInsertLock, this test is a bit fuzzy:
	 * it is possible that we will wait for xacts we didn't really need to
	 * wait for.  But the delay should be short and it seems better to make
	 * checkpoint take a bit longer than to hold locks longer than necessary.
	 * (In fact, the whole reason we have this issue is that xact.c does
	 * commit record XLOG insertion and clog update as two separate steps
	 * protected by different locks, but again that seems best on grounds
	 * of minimizing lock contention.)
	 *
	 * A transaction that has not yet set inCommit when we look cannot be
	 * at risk, since he's not inserted his commit record yet; and one that's
	 * already cleared it is not at risk either, since he's done fixing clog
	 * and we will correctly flush the update below.  So we cannot miss any
	 * xacts we need to wait for.
	 */
	nInCommit = GetTransactionsInCommit(&inCommitXids);
	if (nInCommit > 0)
	{
		do {
			pg_usleep(10000L);				/* wait for 10 msec */
		} while (HaveTransactionsInCommit(inCommitXids, nInCommit));
	}
	pfree(inCommitXids);

5738 5739 5740
	/*
	 * Get the other info we need for the checkpoint record.
	 */
5741
	LWLockAcquire(XidGenLock, LW_SHARED);
5742
	checkPoint.nextXid = ShmemVariableCache->nextXid;
5743
	LWLockRelease(XidGenLock);
T
Tom Lane 已提交
5744

5745 5746 5747 5748 5749
	/* Increase XID epoch if we've wrapped around since last checkpoint */
	checkPoint.nextXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	if (checkPoint.nextXid < ControlFile->checkPointCopy.nextXid)
		checkPoint.nextXidEpoch++;

5750
	LWLockAcquire(OidGenLock, LW_SHARED);
5751
	checkPoint.nextOid = ShmemVariableCache->nextOid;
5752 5753
	if (!shutdown)
		checkPoint.nextOid += ShmemVariableCache->oidCount;
5754
	LWLockRelease(OidGenLock);
5755

5756 5757 5758
	MultiXactGetCheckptMulti(shutdown,
							 &checkPoint.nextMulti,
							 &checkPoint.nextMultiOffset);
5759

T
Tom Lane 已提交
5760
	/*
B
Bruce Momjian 已提交
5761 5762
	 * Having constructed the checkpoint record, ensure all shmem disk buffers
	 * and commit-log buffers are flushed to disk.
5763
	 *
5764 5765
	 * This I/O could fail for various reasons.  If so, we will fail to
	 * complete the checkpoint, but there is no reason to force a system
5766
	 * panic. Accordingly, exit critical section while doing it.
T
Tom Lane 已提交
5767
	 */
5768 5769
	END_CRIT_SECTION();

5770
	CheckPointGuts(checkPoint.redo, flags);
5771

5772 5773
	START_CRIT_SECTION();

T
Tom Lane 已提交
5774 5775 5776
	/*
	 * Now insert the checkpoint record into XLOG.
	 */
B
Bruce Momjian 已提交
5777
	rdata.data = (char *) (&checkPoint);
5778
	rdata.len = sizeof(checkPoint);
5779
	rdata.buffer = InvalidBuffer;
5780 5781
	rdata.next = NULL;

T
Tom Lane 已提交
5782 5783 5784 5785 5786 5787
	recptr = XLogInsert(RM_XLOG_ID,
						shutdown ? XLOG_CHECKPOINT_SHUTDOWN :
						XLOG_CHECKPOINT_ONLINE,
						&rdata);

	XLogFlush(recptr);
5788

T
Tom Lane 已提交
5789
	/*
B
Bruce Momjian 已提交
5790 5791
	 * We now have ProcLastRecPtr = start of actual checkpoint record, recptr
	 * = end of actual checkpoint record.
T
Tom Lane 已提交
5792 5793
	 */
	if (shutdown && !XLByteEQ(checkPoint.redo, ProcLastRecPtr))
5794 5795
		ereport(PANIC,
				(errmsg("concurrent transaction log activity while database system is shutting down")));
5796

T
Tom Lane 已提交
5797
	/*
5798 5799
	 * Select point at which we can truncate the log, which we base on the
	 * prior checkpoint's earliest info.
T
Tom Lane 已提交
5800
	 */
5801
	XLByteToSeg(ControlFile->checkPointCopy.redo, _logId, _logSeg);
5802

T
Tom Lane 已提交
5803 5804 5805
	/*
	 * Update the control file.
	 */
5806
	LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
5807 5808
	if (shutdown)
		ControlFile->state = DB_SHUTDOWNED;
T
Tom Lane 已提交
5809 5810 5811
	ControlFile->prevCheckPoint = ControlFile->checkPoint;
	ControlFile->checkPoint = ProcLastRecPtr;
	ControlFile->checkPointCopy = checkPoint;
5812 5813
	ControlFile->time = time(NULL);
	UpdateControlFile();
5814
	LWLockRelease(ControlFileLock);
5815

5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826
	/* Update shared-memory copy of checkpoint XID/epoch */
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

		SpinLockAcquire(&xlogctl->info_lck);
		xlogctl->ckptXidEpoch = checkPoint.nextXidEpoch;
		xlogctl->ckptXid = checkPoint.nextXid;
		SpinLockRelease(&xlogctl->info_lck);
	}

5827
	/*
B
Bruce Momjian 已提交
5828
	 * We are now done with critical updates; no need for system panic if we
5829
	 * have trouble while fooling with old log segments.
5830 5831 5832
	 */
	END_CRIT_SECTION();

V
Vadim B. Mikheev 已提交
5833
	/*
5834
	 * Delete old log files (those no longer needed even for previous
T
Tom Lane 已提交
5835
	 * checkpoint).
V
Vadim B. Mikheev 已提交
5836 5837 5838
	 */
	if (_logId || _logSeg)
	{
T
Tom Lane 已提交
5839
		PrevLogSeg(_logId, _logSeg);
5840
		RemoveOldXlogFiles(_logId, _logSeg, recptr);
V
Vadim B. Mikheev 已提交
5841 5842
	}

T
Tom Lane 已提交
5843
	/*
5844 5845
	 * Make more log segments if needed.  (Do this after recycling old log
	 * segments, since that may supply some of the needed files.)
T
Tom Lane 已提交
5846 5847
	 */
	if (!shutdown)
5848
		PreallocXlogFiles(recptr);
T
Tom Lane 已提交
5849

5850
	/*
B
Bruce Momjian 已提交
5851 5852 5853 5854 5855
	 * Truncate pg_subtrans if possible.  We can throw away all data before
	 * the oldest XMIN of any running transaction.	No future transaction will
	 * attempt to reference any pg_subtrans entry older than that (see Asserts
	 * in subtrans.c).	During recovery, though, we mustn't do this because
	 * StartupSUBTRANS hasn't been called yet.
5856
	 */
5857
	if (!InRecovery)
5858
		TruncateSUBTRANS(GetOldestXmin(true, false));
5859

5860 5861 5862
	/* All real work is done, but log before releasing lock. */
	if (log_checkpoints)
		LogCheckpointEnd();
5863

5864
	LWLockRelease(CheckpointLock);
5865
}
V
WAL  
Vadim B. Mikheev 已提交
5866

5867 5868 5869 5870 5871 5872 5873
/*
 * Flush all data in shared memory to disk, and fsync
 *
 * This is the common code shared between regular checkpoints and
 * recovery restartpoints.
 */
static void
5874
CheckPointGuts(XLogRecPtr checkPointRedo, int flags)
5875 5876 5877 5878
{
	CheckPointCLOG();
	CheckPointSUBTRANS();
	CheckPointMultiXact();
5879
	CheckPointBuffers(flags);		/* performs all required fsyncs */
5880 5881 5882 5883 5884 5885 5886
	/* We deliberately delay 2PC checkpointing as long as possible */
	CheckPointTwoPhase(checkPointRedo);
}

/*
 * Set a recovery restart point if appropriate
 *
5887
 * This is similar to CreateCheckPoint, but is used during WAL recovery
5888 5889 5890 5891 5892 5893 5894 5895
 * to establish a point from which recovery can roll forward without
 * replaying the entire recovery log.  This function is called each time
 * a checkpoint record is read from XLOG; it must determine whether a
 * restartpoint is needed or not.
 */
static void
RecoveryRestartPoint(const CheckPoint *checkPoint)
{
B
Bruce Momjian 已提交
5896 5897
	int			elapsed_secs;
	int			rmid;
5898 5899

	/*
B
Bruce Momjian 已提交
5900 5901
	 * Do nothing if the elapsed time since the last restartpoint is less than
	 * half of checkpoint_timeout.	(We use a value less than
5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927
	 * checkpoint_timeout so that variations in the timing of checkpoints on
	 * the master, or speed of transmission of WAL segments to a slave, won't
	 * make the slave skip a restartpoint once it's synced with the master.)
	 * Checking true elapsed time keeps us from doing restartpoints too often
	 * while rapidly scanning large amounts of WAL.
	 */
	elapsed_secs = time(NULL) - ControlFile->time;
	if (elapsed_secs < CheckPointTimeout / 2)
		return;

	/*
	 * Is it safe to checkpoint?  We must ask each of the resource managers
	 * whether they have any partial state information that might prevent a
	 * correct restart from this point.  If so, we skip this opportunity, but
	 * return at the next checkpoint record for another try.
	 */
	for (rmid = 0; rmid <= RM_MAX_ID; rmid++)
	{
		if (RmgrTable[rmid].rm_safe_restartpoint != NULL)
			if (!(RmgrTable[rmid].rm_safe_restartpoint()))
				return;
	}

	/*
	 * OK, force data out to disk
	 */
5928
	CheckPointGuts(checkPoint->redo, CHECKPOINT_IMMEDIATE);
5929 5930

	/*
B
Bruce Momjian 已提交
5931 5932 5933
	 * Update pg_control so that any subsequent crash will restart from this
	 * checkpoint.	Note: ReadRecPtr gives the XLOG address of the checkpoint
	 * record itself.
5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945
	 */
	ControlFile->prevCheckPoint = ControlFile->checkPoint;
	ControlFile->checkPoint = ReadRecPtr;
	ControlFile->checkPointCopy = *checkPoint;
	ControlFile->time = time(NULL);
	UpdateControlFile();

	ereport(DEBUG2,
			(errmsg("recovery restart point at %X/%X",
					checkPoint->redo.xlogid, checkPoint->redo.xrecoff)));
}

T
Tom Lane 已提交
5946 5947 5948
/*
 * Write a NEXTOID log record
 */
5949 5950 5951
void
XLogPutNextOid(Oid nextOid)
{
B
Bruce Momjian 已提交
5952
	XLogRecData rdata;
5953

B
Bruce Momjian 已提交
5954
	rdata.data = (char *) (&nextOid);
5955
	rdata.len = sizeof(Oid);
5956
	rdata.buffer = InvalidBuffer;
5957 5958
	rdata.next = NULL;
	(void) XLogInsert(RM_XLOG_ID, XLOG_NEXTOID, &rdata);
B
Bruce Momjian 已提交
5959

5960 5961
	/*
	 * We need not flush the NEXTOID record immediately, because any of the
B
Bruce Momjian 已提交
5962 5963 5964 5965 5966
	 * just-allocated OIDs could only reach disk as part of a tuple insert or
	 * update that would have its own XLOG record that must follow the NEXTOID
	 * record.	Therefore, the standard buffer LSN interlock applied to those
	 * records will ensure no such OID reaches disk before the NEXTOID record
	 * does.
5967 5968 5969 5970 5971 5972 5973 5974 5975 5976
	 *
	 * Note, however, that the above statement only covers state "within" the
	 * database.  When we use a generated OID as a file or directory name,
	 * we are in a sense violating the basic WAL rule, because that filesystem
	 * change may reach disk before the NEXTOID WAL record does.  The impact
	 * of this is that if a database crash occurs immediately afterward,
	 * we might after restart re-generate the same OID and find that it
	 * conflicts with the leftover file or directory.  But since for safety's
	 * sake we always loop until finding a nonconflicting filename, this poses
	 * no real problem in practice. See pgsql-hackers discussion 27-Sep-2006.
5977 5978 5979
	 */
}

5980 5981 5982 5983 5984 5985 5986 5987 5988 5989
/*
 * Write an XLOG SWITCH record.
 *
 * Here we just blindly issue an XLogInsert request for the record.
 * All the magic happens inside XLogInsert.
 *
 * The return value is either the end+1 address of the switch record,
 * or the end+1 address of the prior segment if we did not need to
 * write a switch record because we are already at segment start.
 */
5990
XLogRecPtr
5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006
RequestXLogSwitch(void)
{
	XLogRecPtr	RecPtr;
	XLogRecData rdata;

	/* XLOG SWITCH, alone among xlog record types, has no data */
	rdata.buffer = InvalidBuffer;
	rdata.data = NULL;
	rdata.len = 0;
	rdata.next = NULL;

	RecPtr = XLogInsert(RM_XLOG_ID, XLOG_SWITCH, &rdata);

	return RecPtr;
}

T
Tom Lane 已提交
6007 6008 6009
/*
 * XLOG resource manager's routines
 */
V
WAL  
Vadim B. Mikheev 已提交
6010 6011 6012
void
xlog_redo(XLogRecPtr lsn, XLogRecord *record)
{
B
Bruce Momjian 已提交
6013
	uint8		info = record->xl_info & ~XLR_INFO_MASK;
6014

6015
	if (info == XLOG_NEXTOID)
6016
	{
B
Bruce Momjian 已提交
6017
		Oid			nextOid;
6018 6019 6020

		memcpy(&nextOid, XLogRecGetData(record), sizeof(Oid));
		if (ShmemVariableCache->nextOid < nextOid)
T
Tom Lane 已提交
6021
		{
6022
			ShmemVariableCache->nextOid = nextOid;
T
Tom Lane 已提交
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034
			ShmemVariableCache->oidCount = 0;
		}
	}
	else if (info == XLOG_CHECKPOINT_SHUTDOWN)
	{
		CheckPoint	checkPoint;

		memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
		/* In a SHUTDOWN checkpoint, believe the counters exactly */
		ShmemVariableCache->nextXid = checkPoint.nextXid;
		ShmemVariableCache->nextOid = checkPoint.nextOid;
		ShmemVariableCache->oidCount = 0;
6035 6036
		MultiXactSetNextMXact(checkPoint.nextMulti,
							  checkPoint.nextMultiOffset);
B
Bruce Momjian 已提交
6037

6038 6039 6040 6041
		/* ControlFile->checkPointCopy always tracks the latest ckpt XID */
		ControlFile->checkPointCopy.nextXidEpoch = checkPoint.nextXidEpoch;
		ControlFile->checkPointCopy.nextXid = checkPoint.nextXid;

6042
		/*
B
Bruce Momjian 已提交
6043
		 * TLI may change in a shutdown checkpoint, but it shouldn't decrease
6044 6045 6046 6047 6048 6049 6050 6051
		 */
		if (checkPoint.ThisTimeLineID != ThisTimeLineID)
		{
			if (checkPoint.ThisTimeLineID < ThisTimeLineID ||
				!list_member_int(expectedTLIs,
								 (int) checkPoint.ThisTimeLineID))
				ereport(PANIC,
						(errmsg("unexpected timeline ID %u (after %u) in checkpoint record",
B
Bruce Momjian 已提交
6052
								checkPoint.ThisTimeLineID, ThisTimeLineID)));
6053 6054 6055
			/* Following WAL records should be run with new TLI */
			ThisTimeLineID = checkPoint.ThisTimeLineID;
		}
6056 6057

		RecoveryRestartPoint(&checkPoint);
T
Tom Lane 已提交
6058 6059 6060 6061 6062 6063
	}
	else if (info == XLOG_CHECKPOINT_ONLINE)
	{
		CheckPoint	checkPoint;

		memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
6064
		/* In an ONLINE checkpoint, treat the counters like NEXTOID */
6065 6066
		if (TransactionIdPrecedes(ShmemVariableCache->nextXid,
								  checkPoint.nextXid))
T
Tom Lane 已提交
6067 6068 6069 6070 6071 6072
			ShmemVariableCache->nextXid = checkPoint.nextXid;
		if (ShmemVariableCache->nextOid < checkPoint.nextOid)
		{
			ShmemVariableCache->nextOid = checkPoint.nextOid;
			ShmemVariableCache->oidCount = 0;
		}
6073 6074
		MultiXactAdvanceNextMXact(checkPoint.nextMulti,
								  checkPoint.nextMultiOffset);
6075 6076 6077 6078 6079

		/* ControlFile->checkPointCopy always tracks the latest ckpt XID */
		ControlFile->checkPointCopy.nextXidEpoch = checkPoint.nextXidEpoch;
		ControlFile->checkPointCopy.nextXid = checkPoint.nextXid;

6080 6081
		/* TLI should not change in an on-line checkpoint */
		if (checkPoint.ThisTimeLineID != ThisTimeLineID)
6082
			ereport(PANIC,
6083 6084
					(errmsg("unexpected timeline ID %u (should be %u) in checkpoint record",
							checkPoint.ThisTimeLineID, ThisTimeLineID)));
6085 6086

		RecoveryRestartPoint(&checkPoint);
6087
	}
6088 6089 6090 6091
	else if (info == XLOG_NOOP)
	{
		/* nothing to do here */
	}
6092 6093 6094 6095
	else if (info == XLOG_SWITCH)
	{
		/* nothing to do here */
	}
V
WAL  
Vadim B. Mikheev 已提交
6096
}
B
Bruce Momjian 已提交
6097

V
WAL  
Vadim B. Mikheev 已提交
6098
void
6099
xlog_desc(StringInfo buf, uint8 xl_info, char *rec)
V
WAL  
Vadim B. Mikheev 已提交
6100
{
B
Bruce Momjian 已提交
6101
	uint8		info = xl_info & ~XLR_INFO_MASK;
V
WAL  
Vadim B. Mikheev 已提交
6102

T
Tom Lane 已提交
6103 6104
	if (info == XLOG_CHECKPOINT_SHUTDOWN ||
		info == XLOG_CHECKPOINT_ONLINE)
V
WAL  
Vadim B. Mikheev 已提交
6105
	{
B
Bruce Momjian 已提交
6106 6107
		CheckPoint *checkpoint = (CheckPoint *) rec;

6108
		appendStringInfo(buf, "checkpoint: redo %X/%X; "
B
Bruce Momjian 已提交
6109 6110 6111 6112 6113 6114 6115 6116
						 "tli %u; xid %u/%u; oid %u; multi %u; offset %u; %s",
						 checkpoint->redo.xlogid, checkpoint->redo.xrecoff,
						 checkpoint->ThisTimeLineID,
						 checkpoint->nextXidEpoch, checkpoint->nextXid,
						 checkpoint->nextOid,
						 checkpoint->nextMulti,
						 checkpoint->nextMultiOffset,
				 (info == XLOG_CHECKPOINT_SHUTDOWN) ? "shutdown" : "online");
T
Tom Lane 已提交
6117
	}
6118 6119 6120 6121
	else if (info == XLOG_NOOP)
	{
		appendStringInfo(buf, "xlog no-op");
	}
6122 6123
	else if (info == XLOG_NEXTOID)
	{
B
Bruce Momjian 已提交
6124
		Oid			nextOid;
6125 6126

		memcpy(&nextOid, rec, sizeof(Oid));
6127
		appendStringInfo(buf, "nextOid: %u", nextOid);
6128
	}
6129 6130 6131 6132
	else if (info == XLOG_SWITCH)
	{
		appendStringInfo(buf, "xlog switch");
	}
V
WAL  
Vadim B. Mikheev 已提交
6133
	else
6134
		appendStringInfo(buf, "UNKNOWN");
V
WAL  
Vadim B. Mikheev 已提交
6135 6136
}

6137
#ifdef WAL_DEBUG
6138

V
WAL  
Vadim B. Mikheev 已提交
6139
static void
6140
xlog_outrec(StringInfo buf, XLogRecord *record)
V
WAL  
Vadim B. Mikheev 已提交
6141
{
B
Bruce Momjian 已提交
6142
	int			i;
6143

6144
	appendStringInfo(buf, "prev %X/%X; xid %u",
6145 6146
					 record->xl_prev.xlogid, record->xl_prev.xrecoff,
					 record->xl_xid);
6147

6148
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
6149
	{
6150
		if (record->xl_info & XLR_SET_BKP_BLOCK(i))
B
Bruce Momjian 已提交
6151
			appendStringInfo(buf, "; bkpb%d", i + 1);
6152 6153
	}

6154
	appendStringInfo(buf, ": %s", RmgrTable[record->xl_rmid].rm_name);
V
WAL  
Vadim B. Mikheev 已提交
6155
}
B
Bruce Momjian 已提交
6156
#endif   /* WAL_DEBUG */
6157 6158 6159


/*
6160
 * GUC support
6161
 */
6162
const char *
6163
assign_xlog_sync_method(const char *method, bool doit, GucSource source)
6164
{
B
Bruce Momjian 已提交
6165 6166
	int			new_sync_method;
	int			new_sync_bit;
6167

6168
	if (pg_strcasecmp(method, "fsync") == 0)
6169 6170 6171 6172
	{
		new_sync_method = SYNC_METHOD_FSYNC;
		new_sync_bit = 0;
	}
6173 6174 6175 6176 6177 6178 6179
#ifdef HAVE_FSYNC_WRITETHROUGH
	else if (pg_strcasecmp(method, "fsync_writethrough") == 0)
	{
		new_sync_method = SYNC_METHOD_FSYNC_WRITETHROUGH;
		new_sync_bit = 0;
	}
#endif
6180
#ifdef HAVE_FDATASYNC
6181
	else if (pg_strcasecmp(method, "fdatasync") == 0)
6182 6183 6184 6185 6186 6187
	{
		new_sync_method = SYNC_METHOD_FDATASYNC;
		new_sync_bit = 0;
	}
#endif
#ifdef OPEN_SYNC_FLAG
6188
	else if (pg_strcasecmp(method, "open_sync") == 0)
6189 6190 6191 6192 6193 6194
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_SYNC_FLAG;
	}
#endif
#ifdef OPEN_DATASYNC_FLAG
6195
	else if (pg_strcasecmp(method, "open_datasync") == 0)
6196 6197 6198 6199 6200 6201
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_DATASYNC_FLAG;
	}
#endif
	else
6202
		return NULL;
6203

6204 6205 6206
	if (!doit)
		return method;

6207 6208 6209
	if (sync_method != new_sync_method || open_sync_bit != new_sync_bit)
	{
		/*
B
Bruce Momjian 已提交
6210 6211
		 * To ensure that no blocks escape unsynced, force an fsync on the
		 * currently open log segment (if any).  Also, if the open flag is
B
Bruce Momjian 已提交
6212 6213
		 * changing, close the log file so it will be reopened (with new flag
		 * bit) at next use.
6214 6215 6216 6217
		 */
		if (openLogFile >= 0)
		{
			if (pg_fsync(openLogFile) != 0)
6218 6219
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6220 6221
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6222
			if (open_sync_bit != new_sync_bit)
6223
				XLogFileClose();
6224 6225 6226 6227
		}
		sync_method = new_sync_method;
		open_sync_bit = new_sync_bit;
	}
6228 6229

	return method;
6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240
}


/*
 * Issue appropriate kind of fsync (if any) on the current XLOG output file
 */
static void
issue_xlog_fsync(void)
{
	switch (sync_method)
	{
6241
		case SYNC_METHOD_FSYNC:
6242
			if (pg_fsync_no_writethrough(openLogFile) != 0)
6243 6244
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6245 6246
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6247
			break;
6248 6249 6250 6251 6252
#ifdef HAVE_FSYNC_WRITETHROUGH
		case SYNC_METHOD_FSYNC_WRITETHROUGH:
			if (pg_fsync_writethrough(openLogFile) != 0)
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6253 6254
						 errmsg("could not fsync write-through log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6255 6256
			break;
#endif
6257 6258 6259
#ifdef HAVE_FDATASYNC
		case SYNC_METHOD_FDATASYNC:
			if (pg_fdatasync(openLogFile) != 0)
6260 6261
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6262 6263
					errmsg("could not fdatasync log file %u, segment %u: %m",
						   openLogId, openLogSeg)));
6264 6265 6266 6267 6268 6269
			break;
#endif
		case SYNC_METHOD_OPEN:
			/* write synced it already */
			break;
		default:
6270
			elog(PANIC, "unrecognized wal_sync_method: %d", sync_method);
6271 6272 6273
			break;
	}
}
6274 6275 6276 6277 6278 6279 6280 6281 6282


/*
 * pg_start_backup: set up for taking an on-line backup dump
 *
 * Essentially what this does is to create a backup label file in $PGDATA,
 * where it will be archived as part of the backup dump.  The label file
 * contains the user-supplied label string (typically this would be used
 * to tell where the backup dump will be stored) and the starting time and
6283
 * starting WAL location for the dump.
6284 6285 6286 6287 6288 6289 6290
 */
Datum
pg_start_backup(PG_FUNCTION_ARGS)
{
	text	   *backupid = PG_GETARG_TEXT_P(0);
	text	   *result;
	char	   *backupidstr;
6291
	XLogRecPtr	checkpointloc;
6292
	XLogRecPtr	startpoint;
B
Bruce Momjian 已提交
6293
	time_t		stamp_time;
6294 6295 6296 6297 6298 6299 6300
	char		strfbuf[128];
	char		xlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	struct stat stat_buf;
	FILE	   *fp;

B
Bruce Momjian 已提交
6301
	if (!superuser())
6302 6303 6304
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
6305 6306 6307 6308

	if (!XLogArchivingActive())
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
T
Tom Lane 已提交
6309
				 (errmsg("WAL archiving is not active"),
B
Bruce Momjian 已提交
6310 6311
				  (errhint("archive_command must be defined before "
						   "online backups can be made safely.")))));
6312

6313
	backupidstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6314
												 PointerGetDatum(backupid)));
B
Bruce Momjian 已提交
6315

6316
	/*
6317 6318 6319
	 * Mark backup active in shared memory.  We must do full-page WAL writes
	 * during an on-line backup even if not doing so at other times, because
	 * it's quite possible for the backup dump to obtain a "torn" (partially
B
Bruce Momjian 已提交
6320 6321 6322 6323 6324 6325 6326 6327 6328
	 * written) copy of a database page if it reads the page concurrently with
	 * our write to the same page.	This can be fixed as long as the first
	 * write to the page in the WAL sequence is a full-page write. Hence, we
	 * turn on forcePageWrites and then force a CHECKPOINT, to ensure there
	 * are no dirty pages in shared memory that might get dumped while the
	 * backup is in progress without having a corresponding WAL record.  (Once
	 * the backup is complete, we need not force full-page writes anymore,
	 * since we expect that any pages not modified during the backup interval
	 * must have been correctly captured by the backup.)
6329
	 *
B
Bruce Momjian 已提交
6330 6331
	 * We must hold WALInsertLock to change the value of forcePageWrites, to
	 * ensure adequate interlocking against XLogInsert().
6332
	 */
6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
	if (XLogCtl->Insert.forcePageWrites)
	{
		LWLockRelease(WALInsertLock);
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
				 errmsg("a backup is already in progress"),
				 errhint("Run pg_stop_backup() and try again.")));
	}
	XLogCtl->Insert.forcePageWrites = true;
	LWLockRelease(WALInsertLock);
B
Bruce Momjian 已提交
6344

6345 6346 6347 6348
	/* Use a TRY block to ensure we release forcePageWrites if fail below */
	PG_TRY();
	{
		/*
B
Bruce Momjian 已提交
6349
		 * Force a CHECKPOINT.	Aside from being necessary to prevent torn
6350 6351 6352
		 * page problems, this guarantees that two successive backup runs will
		 * have different checkpoint positions and hence different history
		 * file names, even if nothing happened in between.
6353 6354
		 *
		 * We don't use CHECKPOINT_IMMEDIATE, hence this can take awhile.
6355
		 */
6356
		RequestCheckpoint(CHECKPOINT_FORCE | CHECKPOINT_WAIT);
6357

6358 6359 6360 6361 6362 6363 6364 6365 6366
		/*
		 * Now we need to fetch the checkpoint record location, and also its
		 * REDO pointer.  The oldest point in WAL that would be needed to
		 * restore starting from the checkpoint is precisely the REDO pointer.
		 */
		LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
		checkpointloc = ControlFile->checkPoint;
		startpoint = ControlFile->checkPointCopy.redo;
		LWLockRelease(ControlFileLock);
B
Bruce Momjian 已提交
6367

6368 6369
		XLByteToSeg(startpoint, _logId, _logSeg);
		XLogFileName(xlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6370

6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406
		/*
		 * We deliberately use strftime/localtime not the src/timezone
		 * functions, so that backup labels will consistently be recorded in
		 * the same timezone regardless of TimeZone setting.  This matches
		 * elog.c's practice.
		 */
		stamp_time = time(NULL);
		strftime(strfbuf, sizeof(strfbuf),
				 "%Y-%m-%d %H:%M:%S %Z",
				 localtime(&stamp_time));

		/*
		 * Check for existing backup label --- implies a backup is already
		 * running.  (XXX given that we checked forcePageWrites above, maybe
		 * it would be OK to just unlink any such label file?)
		 */
		if (stat(BACKUP_LABEL_FILE, &stat_buf) != 0)
		{
			if (errno != ENOENT)
				ereport(ERROR,
						(errcode_for_file_access(),
						 errmsg("could not stat file \"%s\": %m",
								BACKUP_LABEL_FILE)));
		}
		else
			ereport(ERROR,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
					 errmsg("a backup is already in progress"),
					 errhint("If you're sure there is no backup in progress, remove file \"%s\" and try again.",
							 BACKUP_LABEL_FILE)));

		/*
		 * Okay, write the file
		 */
		fp = AllocateFile(BACKUP_LABEL_FILE, "w");
		if (!fp)
6407 6408
			ereport(ERROR,
					(errcode_for_file_access(),
6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420
					 errmsg("could not create file \"%s\": %m",
							BACKUP_LABEL_FILE)));
		fprintf(fp, "START WAL LOCATION: %X/%X (file %s)\n",
				startpoint.xlogid, startpoint.xrecoff, xlogfilename);
		fprintf(fp, "CHECKPOINT LOCATION: %X/%X\n",
				checkpointloc.xlogid, checkpointloc.xrecoff);
		fprintf(fp, "START TIME: %s\n", strfbuf);
		fprintf(fp, "LABEL: %s\n", backupidstr);
		if (fflush(fp) || ferror(fp) || FreeFile(fp))
			ereport(ERROR,
					(errcode_for_file_access(),
					 errmsg("could not write file \"%s\": %m",
6421
							BACKUP_LABEL_FILE)));
6422
	}
6423 6424 6425 6426 6427 6428
	PG_CATCH();
	{
		/* Turn off forcePageWrites on failure */
		LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
		XLogCtl->Insert.forcePageWrites = false;
		LWLockRelease(WALInsertLock);
B
Bruce Momjian 已提交
6429

6430 6431 6432
		PG_RE_THROW();
	}
	PG_END_TRY();
B
Bruce Momjian 已提交
6433

6434
	/*
6435
	 * We're done.  As a convenience, return the starting WAL location.
6436 6437 6438 6439
	 */
	snprintf(xlogfilename, sizeof(xlogfilename), "%X/%X",
			 startpoint.xlogid, startpoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6440
											 CStringGetDatum(xlogfilename)));
6441 6442 6443 6444 6445 6446 6447 6448 6449
	PG_RETURN_TEXT_P(result);
}

/*
 * pg_stop_backup: finish taking an on-line backup dump
 *
 * We remove the backup label file created by pg_start_backup, and instead
 * create a backup history file in pg_xlog (whence it will immediately be
 * archived).  The backup history file contains the same info found in
6450
 * the label file, plus the backup-end time and WAL location.
6451 6452 6453 6454 6455 6456 6457
 */
Datum
pg_stop_backup(PG_FUNCTION_ARGS)
{
	text	   *result;
	XLogRecPtr	startpoint;
	XLogRecPtr	stoppoint;
B
Bruce Momjian 已提交
6458
	time_t		stamp_time;
6459
	char		strfbuf[128];
6460
	char		histfilepath[MAXPGPATH];
6461 6462 6463 6464 6465 6466 6467 6468 6469
	char		startxlogfilename[MAXFNAMELEN];
	char		stopxlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	FILE	   *lfp;
	FILE	   *fp;
	char		ch;
	int			ich;

B
Bruce Momjian 已提交
6470
	if (!superuser())
6471 6472 6473
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
B
Bruce Momjian 已提交
6474

6475
	/*
6476
	 * OK to clear forcePageWrites
6477 6478
	 */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
6479
	XLogCtl->Insert.forcePageWrites = false;
6480 6481
	LWLockRelease(WALInsertLock);

6482
	/*
B
Bruce Momjian 已提交
6483 6484 6485
	 * Force a switch to a new xlog segment file, so that the backup is valid
	 * as soon as archiver moves out the current segment file. We'll report
	 * the end address of the XLOG SWITCH record as the backup stopping point.
6486 6487 6488
	 */
	stoppoint = RequestXLogSwitch();

6489 6490
	XLByteToSeg(stoppoint, _logId, _logSeg);
	XLogFileName(stopxlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6491

6492
	/*
B
Bruce Momjian 已提交
6493 6494 6495 6496
	 * We deliberately use strftime/localtime not the src/timezone functions,
	 * so that backup labels will consistently be recorded in the same
	 * timezone regardless of TimeZone setting.  This matches elog.c's
	 * practice.
6497 6498 6499 6500 6501
	 */
	stamp_time = time(NULL);
	strftime(strfbuf, sizeof(strfbuf),
			 "%Y-%m-%d %H:%M:%S %Z",
			 localtime(&stamp_time));
B
Bruce Momjian 已提交
6502

6503 6504 6505
	/*
	 * Open the existing label file
	 */
6506
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6507 6508 6509 6510 6511 6512
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(ERROR,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6513
							BACKUP_LABEL_FILE)));
6514 6515 6516 6517
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
				 errmsg("a backup is not in progress")));
	}
B
Bruce Momjian 已提交
6518

6519
	/*
B
Bruce Momjian 已提交
6520 6521
	 * Read and parse the START WAL LOCATION line (this code is pretty crude,
	 * but we are not expecting any variability in the file format).
6522 6523 6524 6525 6526 6527
	 */
	if (fscanf(lfp, "START WAL LOCATION: %X/%X (file %24s)%c",
			   &startpoint.xlogid, &startpoint.xrecoff, startxlogfilename,
			   &ch) != 4 || ch != '\n')
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
6528
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6529

6530 6531 6532 6533
	/*
	 * Write the backup history file
	 */
	XLByteToSeg(startpoint, _logId, _logSeg);
6534
	BackupHistoryFilePath(histfilepath, ThisTimeLineID, _logId, _logSeg,
6535
						  startpoint.xrecoff % XLogSegSize);
6536
	fp = AllocateFile(histfilepath, "w");
6537 6538 6539 6540
	if (!fp)
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not create file \"%s\": %m",
6541
						histfilepath)));
6542 6543 6544 6545
	fprintf(fp, "START WAL LOCATION: %X/%X (file %s)\n",
			startpoint.xlogid, startpoint.xrecoff, startxlogfilename);
	fprintf(fp, "STOP WAL LOCATION: %X/%X (file %s)\n",
			stoppoint.xlogid, stoppoint.xrecoff, stopxlogfilename);
6546
	/* transfer remaining lines from label to history file */
6547 6548 6549 6550 6551 6552 6553
	while ((ich = fgetc(lfp)) != EOF)
		fputc(ich, fp);
	fprintf(fp, "STOP TIME: %s\n", strfbuf);
	if (fflush(fp) || ferror(fp) || FreeFile(fp))
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not write file \"%s\": %m",
6554
						histfilepath)));
B
Bruce Momjian 已提交
6555

6556 6557 6558 6559 6560 6561 6562
	/*
	 * Close and remove the backup label file
	 */
	if (ferror(lfp) || FreeFile(lfp))
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not read file \"%s\": %m",
6563 6564
						BACKUP_LABEL_FILE)));
	if (unlink(BACKUP_LABEL_FILE) != 0)
6565 6566 6567
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not remove file \"%s\": %m",
6568
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6569

6570
	/*
B
Bruce Momjian 已提交
6571 6572 6573
	 * Clean out any no-longer-needed history files.  As a side effect, this
	 * will post a .ready file for the newly created history file, notifying
	 * the archiver that history file may be archived immediately.
6574
	 */
6575
	CleanupBackupHistory();
B
Bruce Momjian 已提交
6576

6577
	/*
6578
	 * We're done.  As a convenience, return the ending WAL location.
6579 6580 6581 6582
	 */
	snprintf(stopxlogfilename, sizeof(stopxlogfilename), "%X/%X",
			 stoppoint.xlogid, stoppoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6583
										 CStringGetDatum(stopxlogfilename)));
6584 6585
	PG_RETURN_TEXT_P(result);
}
6586

6587 6588 6589 6590 6591 6592 6593
/*
 * pg_switch_xlog: switch to next xlog file
 */
Datum
pg_switch_xlog(PG_FUNCTION_ARGS)
{
	text	   *result;
B
Bruce Momjian 已提交
6594
	XLogRecPtr	switchpoint;
6595 6596 6597 6598 6599
	char		location[MAXFNAMELEN];

	if (!superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
P
Peter Eisentraut 已提交
6600
				 (errmsg("must be superuser to switch transaction log files"))));
6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614

	switchpoint = RequestXLogSwitch();

	/*
	 * As a convenience, return the WAL location of the switch record
	 */
	snprintf(location, sizeof(location), "%X/%X",
			 switchpoint.xlogid, switchpoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
											   CStringGetDatum(location)));
	PG_RETURN_TEXT_P(result);
}

/*
6615 6616 6617 6618 6619
 * Report the current WAL write location (same format as pg_start_backup etc)
 *
 * This is useful for determining how much of WAL is visible to an external
 * archiving process.  Note that the data before this point is written out
 * to the kernel, but is not necessarily synced to disk.
6620 6621 6622
 */
Datum
pg_current_xlog_location(PG_FUNCTION_ARGS)
6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651
{
	text	   *result;
	char		location[MAXFNAMELEN];

	/* Make sure we have an up-to-date local LogwrtResult */
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

		SpinLockAcquire(&xlogctl->info_lck);
		LogwrtResult = xlogctl->LogwrtResult;
		SpinLockRelease(&xlogctl->info_lck);
	}

	snprintf(location, sizeof(location), "%X/%X",
			 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff);

	result = DatumGetTextP(DirectFunctionCall1(textin,
											   CStringGetDatum(location)));
	PG_RETURN_TEXT_P(result);
}

/*
 * Report the current WAL insert location (same format as pg_start_backup etc)
 *
 * This function is mostly for debugging purposes.
 */
Datum
pg_current_xlog_insert_location(PG_FUNCTION_ARGS)
6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692
{
	text	   *result;
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogRecPtr	current_recptr;
	char		location[MAXFNAMELEN];

	/*
	 * Get the current end-of-WAL position ... shared lock is sufficient
	 */
	LWLockAcquire(WALInsertLock, LW_SHARED);
	INSERT_RECPTR(current_recptr, Insert, Insert->curridx);
	LWLockRelease(WALInsertLock);

	snprintf(location, sizeof(location), "%X/%X",
			 current_recptr.xlogid, current_recptr.xrecoff);

	result = DatumGetTextP(DirectFunctionCall1(textin,
											   CStringGetDatum(location)));
	PG_RETURN_TEXT_P(result);
}

/*
 * Compute an xlog file name and decimal byte offset given a WAL location,
 * such as is returned by pg_stop_backup() or pg_xlog_switch().
 *
 * Note that a location exactly at a segment boundary is taken to be in
 * the previous segment.  This is usually the right thing, since the
 * expected usage is to determine which xlog file(s) are ready to archive.
 */
Datum
pg_xlogfile_name_offset(PG_FUNCTION_ARGS)
{
	text	   *location = PG_GETARG_TEXT_P(0);
	char	   *locationstr;
	unsigned int uxlogid;
	unsigned int uxrecoff;
	uint32		xlogid;
	uint32		xlogseg;
	uint32		xrecoff;
	XLogRecPtr	locationpoint;
	char		xlogfilename[MAXFNAMELEN];
B
Bruce Momjian 已提交
6693 6694 6695 6696 6697
	Datum		values[2];
	bool		isnull[2];
	TupleDesc	resultTupleDesc;
	HeapTuple	resultHeapTuple;
	Datum		result;
6698

6699 6700 6701
	/*
	 * Read input and parse
	 */
6702
	locationstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6703
												 PointerGetDatum(location)));
6704 6705 6706 6707

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6708
				 errmsg("could not parse transaction log location \"%s\"",
6709 6710 6711 6712 6713
						locationstr)));

	locationpoint.xlogid = uxlogid;
	locationpoint.xrecoff = uxrecoff;

6714
	/*
B
Bruce Momjian 已提交
6715 6716
	 * Construct a tuple descriptor for the result row.  This must match this
	 * function's pg_proc entry!
6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728
	 */
	resultTupleDesc = CreateTemplateTupleDesc(2, false);
	TupleDescInitEntry(resultTupleDesc, (AttrNumber) 1, "file_name",
					   TEXTOID, -1, 0);
	TupleDescInitEntry(resultTupleDesc, (AttrNumber) 2, "file_offset",
					   INT4OID, -1, 0);

	resultTupleDesc = BlessTupleDesc(resultTupleDesc);

	/*
	 * xlogfilename
	 */
6729 6730 6731
	XLByteToPrevSeg(locationpoint, xlogid, xlogseg);
	XLogFileName(xlogfilename, ThisTimeLineID, xlogid, xlogseg);

6732 6733 6734 6735 6736 6737 6738
	values[0] = DirectFunctionCall1(textin,
									CStringGetDatum(xlogfilename));
	isnull[0] = false;

	/*
	 * offset
	 */
6739 6740
	xrecoff = locationpoint.xrecoff - xlogseg * XLogSegSize;

6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751
	values[1] = UInt32GetDatum(xrecoff);
	isnull[1] = false;

	/*
	 * Tuple jam: Having first prepared your Datums, then squash together
	 */
	resultHeapTuple = heap_form_tuple(resultTupleDesc, values, isnull);

	result = HeapTupleGetDatum(resultHeapTuple);

	PG_RETURN_DATUM(result);
6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771
}

/*
 * Compute an xlog file name given a WAL location,
 * such as is returned by pg_stop_backup() or pg_xlog_switch().
 */
Datum
pg_xlogfile_name(PG_FUNCTION_ARGS)
{
	text	   *location = PG_GETARG_TEXT_P(0);
	text	   *result;
	char	   *locationstr;
	unsigned int uxlogid;
	unsigned int uxrecoff;
	uint32		xlogid;
	uint32		xlogseg;
	XLogRecPtr	locationpoint;
	char		xlogfilename[MAXFNAMELEN];

	locationstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6772
												 PointerGetDatum(location)));
6773 6774 6775 6776

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6777
				 errmsg("could not parse transaction log location \"%s\"",
6778 6779 6780 6781 6782 6783 6784 6785 6786
						locationstr)));

	locationpoint.xlogid = uxlogid;
	locationpoint.xrecoff = uxrecoff;

	XLByteToPrevSeg(locationpoint, xlogid, xlogseg);
	XLogFileName(xlogfilename, ThisTimeLineID, xlogid, xlogseg);

	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6787
											 CStringGetDatum(xlogfilename)));
6788 6789 6790
	PG_RETURN_TEXT_P(result);
}

6791 6792 6793 6794 6795
/*
 * read_backup_label: check to see if a backup_label file is present
 *
 * If we see a backup_label during recovery, we assume that we are recovering
 * from a backup dump file, and we therefore roll forward from the checkpoint
B
Bruce Momjian 已提交
6796
 * identified by the label file, NOT what pg_control says.	This avoids the
6797 6798 6799 6800 6801
 * problem that pg_control might have been archived one or more checkpoints
 * later than the start of the dump, and so if we rely on it as the start
 * point, we will fail to restore a consistent database state.
 *
 * We also attempt to retrieve the corresponding backup history file.
6802
 * If successful, set *minRecoveryLoc to constrain valid PITR stopping
6803 6804 6805 6806 6807 6808
 * points.
 *
 * Returns TRUE if a backup_label was found (and fills the checkpoint
 * location into *checkPointLoc); returns FALSE if not.
 */
static bool
6809
read_backup_label(XLogRecPtr *checkPointLoc, XLogRecPtr *minRecoveryLoc)
6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823
{
	XLogRecPtr	startpoint;
	XLogRecPtr	stoppoint;
	char		histfilename[MAXFNAMELEN];
	char		histfilepath[MAXPGPATH];
	char		startxlogfilename[MAXFNAMELEN];
	char		stopxlogfilename[MAXFNAMELEN];
	TimeLineID	tli;
	uint32		_logId;
	uint32		_logSeg;
	FILE	   *lfp;
	FILE	   *fp;
	char		ch;

6824 6825 6826 6827
	/* Default is to not constrain recovery stop point */
	minRecoveryLoc->xlogid = 0;
	minRecoveryLoc->xrecoff = 0;

6828 6829 6830
	/*
	 * See if label file is present
	 */
6831
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6832 6833 6834 6835 6836 6837
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6838
							BACKUP_LABEL_FILE)));
6839 6840
		return false;			/* it's not there, all is fine */
	}
B
Bruce Momjian 已提交
6841

6842
	/*
B
Bruce Momjian 已提交
6843 6844 6845
	 * Read and parse the START WAL LOCATION and CHECKPOINT lines (this code
	 * is pretty crude, but we are not expecting any variability in the file
	 * format).
6846 6847 6848 6849 6850 6851
	 */
	if (fscanf(lfp, "START WAL LOCATION: %X/%X (file %08X%16s)%c",
			   &startpoint.xlogid, &startpoint.xrecoff, &tli,
			   startxlogfilename, &ch) != 5 || ch != '\n')
		ereport(FATAL,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
6852
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
6853 6854 6855 6856 6857
	if (fscanf(lfp, "CHECKPOINT LOCATION: %X/%X%c",
			   &checkPointLoc->xlogid, &checkPointLoc->xrecoff,
			   &ch) != 3 || ch != '\n')
		ereport(FATAL,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
6858
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
6859 6860 6861 6862
	if (ferror(lfp) || FreeFile(lfp))
		ereport(FATAL,
				(errcode_for_file_access(),
				 errmsg("could not read file \"%s\": %m",
6863
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6864

6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877
	/*
	 * Try to retrieve the backup history file (no error if we can't)
	 */
	XLByteToSeg(startpoint, _logId, _logSeg);
	BackupHistoryFileName(histfilename, tli, _logId, _logSeg,
						  startpoint.xrecoff % XLogSegSize);

	if (InArchiveRecovery)
		RestoreArchivedFile(histfilepath, histfilename, "RECOVERYHISTORY", 0);
	else
		BackupHistoryFilePath(histfilepath, tli, _logId, _logSeg,
							  startpoint.xrecoff % XLogSegSize);

B
Bruce Momjian 已提交
6878
	fp = AllocateFile(histfilepath, "r");
6879 6880 6881 6882 6883 6884
	if (fp)
	{
		/*
		 * Parse history file to identify stop point.
		 */
		if (fscanf(fp, "START WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
6885
				   &startpoint.xlogid, &startpoint.xrecoff, startxlogfilename,
6886 6887 6888
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
6889
					 errmsg("invalid data in file \"%s\"", histfilename)));
6890
		if (fscanf(fp, "STOP WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
6891
				   &stoppoint.xlogid, &stoppoint.xrecoff, stopxlogfilename,
6892 6893 6894
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
6895
					 errmsg("invalid data in file \"%s\"", histfilename)));
6896
		*minRecoveryLoc = stoppoint;
6897 6898 6899 6900 6901 6902 6903 6904 6905 6906
		if (ferror(fp) || FreeFile(fp))
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
							histfilepath)));
	}

	return true;
}

6907 6908 6909 6910 6911 6912
/*
 * Error context callback for errors occurring during rm_redo().
 */
static void
rm_redo_error_callback(void *arg)
{
B
Bruce Momjian 已提交
6913 6914
	XLogRecord *record = (XLogRecord *) arg;
	StringInfoData buf;
6915 6916

	initStringInfo(&buf);
6917 6918
	RmgrTable[record->xl_rmid].rm_desc(&buf,
									   record->xl_info,
6919 6920 6921 6922 6923 6924 6925 6926
									   XLogRecGetData(record));

	/* don't bother emitting empty description */
	if (buf.len > 0)
		errcontext("xlog redo %s", buf.data);

	pfree(buf.data);
}