xlog.c 195.6 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.268 2007/04/30 21:01:52 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;
T
Tom Lane 已提交
69

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

74
/*
75
 * XLOGfileslop is used in the code as the allowed "fuzz" in the number of
76
 * preallocated XLOG segments --- we try to have at least XLOGfiles advance
B
Bruce Momjian 已提交
77
 * segments but no more than XLOGfileslop segments.  This could
78 79 80 81 82 83 84 85 86 87
 * 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.
 */

#define XLOGfileslop	(2*CheckPointSegments + 1)


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

#define XLOG_SYNC_BIT  (enableFsync ? open_sync_bit : 0)

T
Tom Lane 已提交
94 95

/*
96 97
 * ThisTimeLineID will be same in all backends --- it identifies current
 * WAL timeline for the database system.
T
Tom Lane 已提交
98
 */
99
TimeLineID	ThisTimeLineID = 0;
V
WAL  
Vadim B. Mikheev 已提交
100

101
/* Are we doing recovery from XLOG? */
T
Tom Lane 已提交
102
bool		InRecovery = false;
B
Bruce Momjian 已提交
103

104
/* Are we recovering using offline XLOG archives? */
B
Bruce Momjian 已提交
105 106
static bool InArchiveRecovery = false;

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

110 111
/* options taken from recovery.conf */
static char *recoveryRestoreCommand = NULL;
112 113 114
static bool recoveryTarget = false;
static bool recoveryTargetExact = false;
static bool recoveryTargetInclusive = true;
B
Bruce Momjian 已提交
115
static TransactionId recoveryTargetXid;
116
static TimestampTz recoveryTargetTime;
117

118
/* if recoveryStopsHere returns true, it saves actual stop xid/time here */
B
Bruce Momjian 已提交
119
static TransactionId recoveryStopXid;
120
static TimestampTz recoveryStopTime;
B
Bruce Momjian 已提交
121
static bool recoveryStopAfter;
122 123 124 125 126 127 128 129 130 131 132 133 134

/*
 * 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 已提交
135
 * first list member).	Only these TLIs are expected to be seen in the WAL
136 137 138 139 140 141 142 143 144
 * 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 已提交
145 146 147
static TimeLineID recoveryTargetTLI;
static List *expectedTLIs;
static TimeLineID curFileTLI;
148

T
Tom Lane 已提交
149 150
/*
 * MyLastRecPtr points to the start of the last XLOG record inserted by the
151 152
 * current transaction.  If MyLastRecPtr.xrecoff == 0, then the current
 * xact hasn't yet inserted any transaction-controlled XLOG records.
T
Tom Lane 已提交
153 154
 *
 * Note that XLOG records inserted outside transaction control are not
155
 * reflected into MyLastRecPtr.  They do, however, cause MyXactMadeXLogEntry
B
Bruce Momjian 已提交
156
 * to be set true.	The latter can be used to test whether the current xact
157 158
 * made any loggable changes (including out-of-xact changes, such as
 * sequence updates).
159 160 161
 *
 * 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 已提交
162
 * the temp rel after a crash.	However, we will still need to remember
163 164 165
 * 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 已提交
166 167
 */
XLogRecPtr	MyLastRecPtr = {0, 0};
V
Vadim B. Mikheev 已提交
168

169 170
bool		MyXactMadeXLogEntry = false;

171 172
bool		MyXactMadeTempRelUpdate = false;

T
Tom Lane 已提交
173 174 175
/*
 * 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 已提交
176
 * or not.	ProcLastRecEnd is similar but points to end+1 of last record.
T
Tom Lane 已提交
177 178
 */
static XLogRecPtr ProcLastRecPtr = {0, 0};
179

180 181
XLogRecPtr	ProcLastRecEnd = {0, 0};

T
Tom Lane 已提交
182 183 184
/*
 * 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 已提交
185
 * CHECKPOINT record).	We update this from the shared-memory copy,
T
Tom Lane 已提交
186
 * XLogCtl->Insert.RedoRecPtr, whenever we can safely do so (ie, when we
B
Bruce Momjian 已提交
187
 * hold the Insert lock).  See XLogInsert for details.	We are also allowed
188
 * to update from XLogCtl->Insert.RedoRecPtr if we hold the info_lck;
189 190
 * see GetRedoRecPtr.  A freshly spawned backend obtains the value during
 * InitXLOGAccess.
T
Tom Lane 已提交
191
 */
192
static XLogRecPtr RedoRecPtr;
193

T
Tom Lane 已提交
194 195 196 197 198 199 200 201 202
/*----------
 * 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.
 *
203
 * We do a lot of pushups to minimize the amount of access to lockable
T
Tom Lane 已提交
204 205 206
 * 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
207 208 209 210
 *		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 已提交
211 212 213
 *
 * XLogCtl->LogwrtResult and XLogCtl->Write.LogwrtResult are both "always
 * right", since both are updated by a write or flush operation before
214 215
 * 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 已提交
216 217 218
 * without needing to grab info_lck as well.
 *
 * XLogCtl->Insert.LogwrtResult may lag behind the reality of the other two,
B
Bruce Momjian 已提交
219
 * but is updated when convenient.	Again, it exists for the convenience of
220
 * code that is already holding WALInsertLock but not the other locks.
T
Tom Lane 已提交
221 222 223 224 225 226 227 228 229 230
 *
 * 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".
231 232 233 234 235 236 237 238 239 240 241 242 243 244
 *
 * 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
245 246
 * checkpointer at a time; currently, with all checkpoints done by the
 * bgwriter, this is just pro forma).
247
 *
T
Tom Lane 已提交
248 249
 *----------
 */
250

T
Tom Lane 已提交
251
typedef struct XLogwrtRqst
252
{
T
Tom Lane 已提交
253 254
	XLogRecPtr	Write;			/* last byte + 1 to write out */
	XLogRecPtr	Flush;			/* last byte + 1 to flush */
255
} XLogwrtRqst;
256

257 258 259 260 261 262
typedef struct XLogwrtResult
{
	XLogRecPtr	Write;			/* last byte + 1 written out */
	XLogRecPtr	Flush;			/* last byte + 1 flushed */
} XLogwrtResult;

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

T
Tom Lane 已提交
277 278 279
/*
 * Shared state data for XLogWrite/XLogFlush.
 */
280 281
typedef struct XLogCtlWrite
{
B
Bruce Momjian 已提交
282 283 284
	XLogwrtResult LogwrtResult; /* current value of LogwrtResult */
	int			curridx;		/* cache index of next block to write */
	time_t		lastSegSwitchTime;		/* time of last xlog segment switch */
285 286
} XLogCtlWrite;

T
Tom Lane 已提交
287 288 289
/*
 * Total shared-memory state for XLOG.
 */
290 291
typedef struct XLogCtlData
{
292
	/* Protected by WALInsertLock: */
B
Bruce Momjian 已提交
293
	XLogCtlInsert Insert;
294

T
Tom Lane 已提交
295
	/* Protected by info_lck: */
B
Bruce Momjian 已提交
296 297
	XLogwrtRqst LogwrtRqst;
	XLogwrtResult LogwrtResult;
298 299 300
	uint32		ckptXidEpoch;	/* nextXID & epoch of latest checkpoint */
	TransactionId ckptXid;

301
	/* Protected by WALWriteLock: */
B
Bruce Momjian 已提交
302 303
	XLogCtlWrite Write;

T
Tom Lane 已提交
304
	/*
B
Bruce Momjian 已提交
305 306 307
	 * 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 已提交
308
	 */
B
Bruce Momjian 已提交
309
	char	   *pages;			/* buffers for unwritten XLOG pages */
310
	XLogRecPtr *xlblocks;		/* 1st byte ptr-s + XLOG_BLCKSZ */
311 312
	Size		XLogCacheByte;	/* # bytes in xlog buffers */
	int			XLogCacheBlck;	/* highest allocated xlog buffer index */
313
	TimeLineID	ThisTimeLineID;
T
Tom Lane 已提交
314

315
	slock_t		info_lck;		/* locks shared variables shown above */
316 317
} XLogCtlData;

318
static XLogCtlData *XLogCtl = NULL;
319

320
/*
T
Tom Lane 已提交
321
 * We maintain an image of pg_control in shared memory.
322
 */
323
static ControlFileData *ControlFile = NULL;
324

T
Tom Lane 已提交
325 326 327 328 329
/*
 * 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.
 */
330

T
Tom Lane 已提交
331 332
/* Free space remaining in the current xlog page buffer */
#define INSERT_FREESPACE(Insert)  \
333
	(XLOG_BLCKSZ - ((Insert)->currpos - (char *) (Insert)->currpage))
T
Tom Lane 已提交
334 335 336 337 338 339

/* Construct XLogRecPtr value for current insertion point */
#define INSERT_RECPTR(recptr,Insert,curridx)  \
	( \
	  (recptr).xlogid = XLogCtl->xlblocks[curridx].xlogid, \
	  (recptr).xrecoff = \
B
Bruce Momjian 已提交
340
		XLogCtl->xlblocks[curridx].xrecoff - INSERT_FREESPACE(Insert) \
T
Tom Lane 已提交
341 342 343 344 345 346 347
	)

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

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

T
Tom Lane 已提交
349 350 351 352
/*
 * Private, possibly out-of-date copy of shared LogwrtResult.
 * See discussion above.
 */
353
static XLogwrtResult LogwrtResult = {{0, 0}, {0, 0}};
354

T
Tom Lane 已提交
355 356 357 358 359 360 361 362 363 364
/*
 * 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;
365

T
Tom Lane 已提交
366 367 368 369 370 371
/*
 * 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.
 */
372 373 374 375
static int	readFile = -1;
static uint32 readId = 0;
static uint32 readSeg = 0;
static uint32 readOff = 0;
B
Bruce Momjian 已提交
376

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

380 381 382 383
/* Buffer for current ReadRecord result (expandable) */
static char *readRecordBuf = NULL;
static uint32 readRecordBufSize = 0;

T
Tom Lane 已提交
384
/* State information for XLOG reading */
B
Bruce Momjian 已提交
385 386
static XLogRecPtr ReadRecPtr;	/* start of last record read */
static XLogRecPtr EndRecPtr;	/* end+1 of last record read */
387
static XLogRecord *nextRecord = NULL;
388
static TimeLineID lastPageTLI = 0;
389

V
WAL  
Vadim B. Mikheev 已提交
390 391
static bool InRedo = false;

392

393 394
static void XLogArchiveNotify(const char *xlog);
static void XLogArchiveNotifySeg(uint32 log, uint32 seg);
395
static bool XLogArchiveCheckDone(const char *xlog);
396 397
static void XLogArchiveCleanup(const char *xlog);
static void readRecoveryCommandFile(void);
398
static void exitArchiveRecovery(TimeLineID endTLI,
B
Bruce Momjian 已提交
399
					uint32 endLogId, uint32 endLogSeg);
400
static bool recoveryStopsHere(XLogRecord *record, bool *includeThis);
401
static void CheckPointGuts(XLogRecPtr checkPointRedo);
T
Tom Lane 已提交
402

403
static bool XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
B
Bruce Momjian 已提交
404
				XLogRecPtr *lsn, BkpBlock *bkpb);
405 406
static bool AdvanceXLInsertBuffer(bool new_segment);
static void XLogWrite(XLogwrtRqst WriteRqst, bool flexible, bool xlog_switch);
B
Bruce Momjian 已提交
407 408
static int XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock);
409 410
static bool InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
411
					   bool use_lock);
412 413
static int	XLogFileOpen(uint32 log, uint32 seg);
static int	XLogFileRead(uint32 log, uint32 seg, int emode);
B
Bruce Momjian 已提交
414
static void XLogFileClose(void);
415
static bool RestoreArchivedFile(char *path, const char *xlogfname,
B
Bruce Momjian 已提交
416
					const char *recovername, off_t expectedSize);
417 418
static int	PreallocXlogFiles(XLogRecPtr endptr);
static void MoveOfflineLogs(uint32 log, uint32 seg, XLogRecPtr endptr,
B
Bruce Momjian 已提交
419
				int *nsegsremoved, int *nsegsrecycled);
420
static void CleanupBackupHistory(void);
421
static XLogRecord *ReadRecord(XLogRecPtr *RecPtr, int emode);
422
static bool ValidXLOGHeader(XLogPageHeader hdr, int emode);
423
static XLogRecord *ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt);
424 425 426 427
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 已提交
428 429
					 TimeLineID endTLI,
					 uint32 endLogId, uint32 endLogSeg);
T
Tom Lane 已提交
430 431 432
static void WriteControlFile(void);
static void ReadControlFile(void);
static char *str_time(time_t tnow);
433
static void issue_xlog_fsync(void);
B
Bruce Momjian 已提交
434

435
#ifdef WAL_DEBUG
436
static void xlog_outrec(StringInfo buf, XLogRecord *record);
437
#endif
438
static bool read_backup_label(XLogRecPtr *checkPointLoc,
B
Bruce Momjian 已提交
439
				  XLogRecPtr *minRecoveryLoc);
440
static void rm_redo_error_callback(void *arg);
T
Tom Lane 已提交
441 442 443 444 445


/*
 * Insert an XLOG record having the specified RMID and info bytes,
 * with the body of the record being the data chunk(s) described by
446
 * the rdata chain (see xlog.h for notes about rdata).
T
Tom Lane 已提交
447 448 449 450 451 452 453 454 455 456 457
 *
 * 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.
 */
458
XLogRecPtr
459
XLogInsert(RmgrId rmid, uint8 info, XLogRecData *rdata)
460
{
B
Bruce Momjian 已提交
461 462
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogRecord *record;
T
Tom Lane 已提交
463
	XLogContRecord *contrecord;
B
Bruce Momjian 已提交
464 465 466
	XLogRecPtr	RecPtr;
	XLogRecPtr	WriteRqst;
	uint32		freespace;
467
	int			curridx;
B
Bruce Momjian 已提交
468 469 470 471 472
	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];
473 474 475 476
	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 已提交
477 478 479
	uint32		len,
				write_len;
	unsigned	i;
480
	XLogwrtRqst LogwrtRqst;
B
Bruce Momjian 已提交
481
	bool		updrqst;
482
	bool		doPageWrites;
483 484
	bool		isLogSwitch = (rmid == RM_XLOG_ID && info == XLOG_SWITCH);
	bool		no_tran = (rmid == RM_XLOG_ID);
V
Vadim B. Mikheev 已提交
485 486 487 488

	if (info & XLR_INFO_MASK)
	{
		if ((info & XLR_INFO_MASK) != XLOG_NO_TRAN)
489
			elog(PANIC, "invalid xlog info mask %02X", (info & XLR_INFO_MASK));
V
Vadim B. Mikheev 已提交
490 491 492 493
		no_tran = true;
		info &= ~XLR_INFO_MASK;
	}

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

T
Tom Lane 已提交
505
	/*
506
	 * Here we scan the rdata chain, determine which buffers must be backed
T
Tom Lane 已提交
507
	 * up, and compute the CRC values for the data.  Note that the record
B
Bruce Momjian 已提交
508 509 510 511
	 * 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 已提交
512
	 *
513 514 515 516 517
	 * 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 已提交
518 519 520 521 522
	 * 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 已提交
523
	 */
524
begin:;
T
Tom Lane 已提交
525 526 527 528 529 530
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
	{
		dtbuf[i] = InvalidBuffer;
		dtbuf_bkp[i] = false;
	}

531 532 533 534 535 536 537 538
	/*
	 * 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;

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

594 595 596 597 598 599 600 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
	/*
	 * 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 已提交
627
	/*
628 629
	 * 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 已提交
630 631 632
	 * 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 已提交
633
	 */
634
	if (len == 0 && !isLogSwitch)
635
		elog(PANIC, "invalid xlog record length %u", len);
636

637
	START_CRIT_SECTION();
638

639
	/* update LogwrtResult before doing cache fill check */
640 641 642 643
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

644
		SpinLockAcquire(&xlogctl->info_lck);
645 646
		LogwrtRqst = xlogctl->LogwrtRqst;
		LogwrtResult = xlogctl->LogwrtResult;
647
		SpinLockRelease(&xlogctl->info_lck);
648
	}
649

650
	/*
651 652
	 * If cache is half filled then try to acquire write lock and do
	 * XLogWrite. Ignore any fractional blocks in performing this check.
653
	 */
654
	LogwrtRqst.Write.xrecoff -= LogwrtRqst.Write.xrecoff % XLOG_BLCKSZ;
655 656 657
	if (LogwrtRqst.Write.xlogid != LogwrtResult.Write.xlogid ||
		(LogwrtRqst.Write.xrecoff >= LogwrtResult.Write.xrecoff +
		 XLogCtl->XLogCacheByte / 2))
T
Tom Lane 已提交
658
	{
659
		if (LWLockConditionalAcquire(WALWriteLock, LW_EXCLUSIVE))
660
		{
661 662 663 664
			/*
			 * Since the amount of data we write here is completely optional
			 * anyway, tell XLogWrite it can be "flexible" and stop at a
			 * convenient boundary.  This allows writes triggered by this
B
Bruce Momjian 已提交
665 666 667
			 * mechanism to synchronize with the cache boundaries, so that in
			 * a long transaction we'll basically dump alternating halves of
			 * the buffer array.
668
			 */
669 670
			LogwrtResult = XLogCtl->Write.LogwrtResult;
			if (XLByteLT(LogwrtResult.Write, LogwrtRqst.Write))
671
				XLogWrite(LogwrtRqst, true, false);
672
			LWLockRelease(WALWriteLock);
673 674 675
		}
	}

676 677 678
	/* Now wait to get insert lock */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);

T
Tom Lane 已提交
679
	/*
B
Bruce Momjian 已提交
680 681 682
	 * 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.
683 684
	 *
	 * If we aren't doing full-page writes then RedoRecPtr doesn't actually
B
Bruce Momjian 已提交
685 686
	 * affect the contents of the XLOG record, so we'll update our local copy
	 * but not force a recomputation.
T
Tom Lane 已提交
687 688
	 */
	if (!XLByteEQ(RedoRecPtr, Insert->RedoRecPtr))
689
	{
T
Tom Lane 已提交
690 691 692
		Assert(XLByteLT(RedoRecPtr, Insert->RedoRecPtr));
		RedoRecPtr = Insert->RedoRecPtr;

693
		if (doPageWrites)
694
		{
695
			for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
T
Tom Lane 已提交
696
			{
697 698 699 700 701 702 703 704 705 706 707 708 709
				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 已提交
710
			}
711 712 713
		}
	}

714
	/*
B
Bruce Momjian 已提交
715 716 717 718
	 * 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.)
719 720 721 722 723 724 725 726 727
	 */
	if (Insert->forcePageWrites && !doPageWrites)
	{
		/* Oops, must redo it with full-page data */
		LWLockRelease(WALInsertLock);
		END_CRIT_SECTION();
		goto begin;
	}

T
Tom Lane 已提交
728
	/*
B
Bruce Momjian 已提交
729 730 731 732
	 * 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 已提交
733
	 *
734 735 736
	 * 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 已提交
737 738 739
	 */
	write_len = len;
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
740
	{
741 742 743
		BkpBlock   *bkpb;
		char	   *page;

744
		if (!dtbuf_bkp[i])
745 746
			continue;

T
Tom Lane 已提交
747
		info |= XLR_SET_BKP_BLOCK(i);
748

749 750 751 752 753
		bkpb = &(dtbuf_xlg[i]);
		page = (char *) BufferGetBlock(dtbuf[i]);

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

755 756
		rdt->data = (char *) bkpb;
		rdt->len = sizeof(BkpBlock);
T
Tom Lane 已提交
757
		write_len += sizeof(BkpBlock);
758

759 760
		rdt->next = &(dtbuf_rdt2[i]);
		rdt = rdt->next;
761

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
		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;
		}
784 785
	}

786
	/*
787
	 * If there isn't enough space on the current XLOG page for a record
B
Bruce Momjian 已提交
788
	 * header, advance to the next page (leaving the unused space as zeroes).
789
	 */
T
Tom Lane 已提交
790 791
	updrqst = false;
	freespace = INSERT_FREESPACE(Insert);
792 793
	if (freespace < SizeOfXLogRecord)
	{
794
		updrqst = AdvanceXLInsertBuffer(false);
795 796 797
		freespace = INSERT_FREESPACE(Insert);
	}

798
	/* Compute record's XLOG location */
T
Tom Lane 已提交
799
	curridx = Insert->curridx;
800 801 802
	INSERT_RECPTR(RecPtr, Insert, curridx);

	/*
B
Bruce Momjian 已提交
803 804 805 806 807
	 * 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.
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
	 */
	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 已提交
839

840 841
	/* Insert record header */

842
	record = (XLogRecord *) Insert->currpos;
843
	record->xl_prev = Insert->PrevRecord;
844
	record->xl_xid = GetCurrentTransactionIdIfAny();
845
	record->xl_tot_len = SizeOfXLogRecord + write_len;
T
Tom Lane 已提交
846
	record->xl_len = len;		/* doesn't include backup blocks */
847
	record->xl_info = info;
848
	record->xl_rmid = rmid;
849

850 851 852 853
	/* 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);
854 855
	record->xl_crc = rdata_crc;

856
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
857 858
	if (XLOG_DEBUG)
	{
B
Bruce Momjian 已提交
859
		StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
860

861
		initStringInfo(&buf);
862 863
		appendStringInfo(&buf, "INSERT @ %X/%X: ",
						 RecPtr.xlogid, RecPtr.xrecoff);
864
		xlog_outrec(&buf, record);
865
		if (rdata->data != NULL)
V
WAL  
Vadim B. Mikheev 已提交
866
		{
867 868
			appendStringInfo(&buf, " - ");
			RmgrTable[record->xl_rmid].rm_desc(&buf, record->xl_info, rdata->data);
V
WAL  
Vadim B. Mikheev 已提交
869
		}
870 871
		elog(LOG, "%s", buf.data);
		pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
872
	}
873
#endif
V
WAL  
Vadim B. Mikheev 已提交
874

T
Tom Lane 已提交
875 876 877 878 879
	/* Record begin of record in appropriate places */
	if (!no_tran)
		MyLastRecPtr = RecPtr;
	ProcLastRecPtr = RecPtr;
	Insert->PrevRecord = RecPtr;
880
	MyXactMadeXLogEntry = true;
T
Tom Lane 已提交
881

882
	Insert->currpos += SizeOfXLogRecord;
T
Tom Lane 已提交
883
	freespace -= SizeOfXLogRecord;
884

T
Tom Lane 已提交
885 886 887 888
	/*
	 * Append the data, including backup blocks if any
	 */
	while (write_len)
889
	{
890 891 892 893
		while (rdata->data == NULL)
			rdata = rdata->next;

		if (freespace > 0)
894
		{
895 896 897 898 899
			if (rdata->len > freespace)
			{
				memcpy(Insert->currpos, rdata->data, freespace);
				rdata->data += freespace;
				rdata->len -= freespace;
T
Tom Lane 已提交
900
				write_len -= freespace;
901 902 903 904 905
			}
			else
			{
				memcpy(Insert->currpos, rdata->data, rdata->len);
				freespace -= rdata->len;
T
Tom Lane 已提交
906
				write_len -= rdata->len;
907 908 909 910
				Insert->currpos += rdata->len;
				rdata = rdata->next;
				continue;
			}
911 912
		}

913
		/* Use next buffer */
914
		updrqst = AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
915 916 917 918 919 920
		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;
921
		freespace = INSERT_FREESPACE(Insert);
922
	}
923

T
Tom Lane 已提交
924 925
	/* Ensure next record will be properly aligned */
	Insert->currpos = (char *) Insert->currpage +
B
Bruce Momjian 已提交
926
		MAXALIGN(Insert->currpos - (char *) Insert->currpage);
T
Tom Lane 已提交
927
	freespace = INSERT_FREESPACE(Insert);
928

V
Vadim B. Mikheev 已提交
929
	/*
B
Bruce Momjian 已提交
930 931
	 * 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 已提交
932
	 */
T
Tom Lane 已提交
933
	INSERT_RECPTR(RecPtr, Insert, curridx);
V
Vadim B. Mikheev 已提交
934

935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
	/*
	 * 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 已提交
952 953
		 * Flush through the end of the page containing XLOG_SWITCH, and
		 * perform end-of-segment actions (eg, notifying archiver).
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 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
		 */
		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 */
	}
1004
	else
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
	{
		/* 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];
	}
1021

1022
	LWLockRelease(WALInsertLock);
1023 1024 1025

	if (updrqst)
	{
1026 1027 1028
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1029
		SpinLockAcquire(&xlogctl->info_lck);
T
Tom Lane 已提交
1030
		/* advance global request to include new block(s) */
1031 1032
		if (XLByteLT(xlogctl->LogwrtRqst.Write, WriteRqst))
			xlogctl->LogwrtRqst.Write = WriteRqst;
T
Tom Lane 已提交
1033
		/* update local result copy while I have the chance */
1034
		LogwrtResult = xlogctl->LogwrtResult;
1035
		SpinLockRelease(&xlogctl->info_lck);
1036 1037
	}

1038 1039
	ProcLastRecEnd = RecPtr;

1040
	END_CRIT_SECTION();
1041

1042
	return RecPtr;
1043
}
1044

1045
/*
1046 1047 1048
 * 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.
1049
 */
1050
static bool
1051
XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
1052
				XLogRecPtr *lsn, BkpBlock *bkpb)
1053 1054
{
	PageHeader	page;
1055 1056 1057 1058

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

	/*
B
Bruce Momjian 已提交
1059 1060 1061
	 * 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.
1062 1063 1064
	 */
	*lsn = page->pd_lsn;

1065
	if (doPageWrites &&
1066
		XLByteLE(page->pd_lsn, RedoRecPtr))
1067
	{
1068 1069 1070 1071 1072
		/*
		 * The page needs to be backed up, so set up *bkpb
		 */
		bkpb->node = BufferGetFileNode(rdata->buffer);
		bkpb->block = BufferGetBlockNumber(rdata->buffer);
1073

1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
		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;
		}
1100

1101
		return true;			/* buffer requires backup */
1102
	}
1103 1104

	return false;				/* buffer does not need to be backed up */
1105 1106
}

1107 1108 1109 1110 1111 1112
/*
 * XLogArchiveNotify
 *
 * Create an archive notification file
 *
 * The name of the notification file is the message that will be picked up
1113
 * by the archiver, e.g. we write 0000000100000001000000C6.ready
1114
 * and the archiver then knows to archive XLOGDIR/0000000100000001000000C6,
1115
 * then when complete, rename it to 0000000100000001000000C6.done
1116 1117 1118 1119 1120
 */
static void
XLogArchiveNotify(const char *xlog)
{
	char		archiveStatusPath[MAXPGPATH];
B
Bruce Momjian 已提交
1121
	FILE	   *fd;
1122 1123 1124 1125

	/* insert an otherwise empty file called <XLOG>.ready */
	StatusFilePath(archiveStatusPath, xlog, ".ready");
	fd = AllocateFile(archiveStatusPath, "w");
B
Bruce Momjian 已提交
1126 1127
	if (fd == NULL)
	{
1128 1129 1130 1131 1132 1133
		ereport(LOG,
				(errcode_for_file_access(),
				 errmsg("could not create archive status file \"%s\": %m",
						archiveStatusPath)));
		return;
	}
B
Bruce Momjian 已提交
1134 1135
	if (FreeFile(fd))
	{
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
		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];

1156
	XLogFileName(xlog, ThisTimeLineID, log, seg);
1157 1158 1159 1160
	XLogArchiveNotify(xlog);
}

/*
1161
 * XLogArchiveCheckDone
1162
 *
1163 1164 1165 1166
 * 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.
1167 1168
 *
 * If <XLOG>.done exists, then return true; else if <XLOG>.ready exists,
1169 1170 1171 1172
 * 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.
1173 1174
 */
static bool
1175
XLogArchiveCheckDone(const char *xlog)
1176 1177 1178 1179
{
	char		archiveStatusPath[MAXPGPATH];
	struct stat stat_buf;

1180 1181 1182 1183 1184
	/* Always deletable if archiving is off */
	if (!XLogArchivingActive())
		return true;

	/* First check for .done --- this means archiver is done with it */
1185 1186 1187 1188 1189 1190 1191
	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 已提交
1192
		return false;
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206

	/* 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
 *
1207
 * Cleanup archive notification file(s) for a particular xlog segment
1208 1209 1210 1211
 */
static void
XLogArchiveCleanup(const char *xlog)
{
B
Bruce Momjian 已提交
1212
	char		archiveStatusPath[MAXPGPATH];
1213

1214
	/* Remove the .done file */
1215 1216 1217
	StatusFilePath(archiveStatusPath, xlog, ".done");
	unlink(archiveStatusPath);
	/* should we complain about failure? */
1218 1219 1220 1221 1222

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

T
Tom Lane 已提交
1225 1226 1227 1228
/*
 * Advance the Insert state to the next buffer page, writing out the next
 * buffer if it still contains unwritten data.
 *
1229 1230 1231 1232
 * 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 已提交
1233
 * The global LogwrtRqst.Write pointer needs to be advanced to include the
1234
 * just-filled page.  If we can do this for free (without an extra lock),
T
Tom Lane 已提交
1235 1236 1237
 * 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.
 *
1238
 * Must be called with WALInsertLock held.
T
Tom Lane 已提交
1239 1240
 */
static bool
1241
AdvanceXLInsertBuffer(bool new_segment)
1242
{
T
Tom Lane 已提交
1243 1244
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogCtlWrite *Write = &XLogCtl->Write;
1245
	int			nextidx = NextBufIdx(Insert->curridx);
T
Tom Lane 已提交
1246 1247 1248
	bool		update_needed = true;
	XLogRecPtr	OldPageRqstPtr;
	XLogwrtRqst WriteRqst;
1249 1250
	XLogRecPtr	NewPageEndPtr;
	XLogPageHeader NewPage;
1251

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

T
Tom Lane 已提交
1256
	/*
B
Bruce Momjian 已提交
1257 1258 1259
	 * 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 已提交
1260 1261 1262 1263 1264 1265
	 */
	OldPageRqstPtr = XLogCtl->xlblocks[nextidx];
	if (!XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
	{
		/* nope, got work to do... */
		XLogRecPtr	FinishedPageRqstPtr;
1266

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

1269
		/* Before waiting, get info_lck and update LogwrtResult */
1270 1271 1272 1273
		{
			/* use volatile pointer to prevent code rearrangement */
			volatile XLogCtlData *xlogctl = XLogCtl;

1274
			SpinLockAcquire(&xlogctl->info_lck);
1275 1276 1277
			if (XLByteLT(xlogctl->LogwrtRqst.Write, FinishedPageRqstPtr))
				xlogctl->LogwrtRqst.Write = FinishedPageRqstPtr;
			LogwrtResult = xlogctl->LogwrtResult;
1278
			SpinLockRelease(&xlogctl->info_lck);
1279
		}
1280 1281 1282 1283 1284 1285 1286 1287 1288

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

		if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
		{
			/* OK, someone wrote it already */
			Insert->LogwrtResult = LogwrtResult;
		}
		else
1289
		{
1290 1291 1292 1293
			/* Must acquire write lock */
			LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
			LogwrtResult = Write->LogwrtResult;
			if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
1294
			{
1295 1296 1297
				/* OK, someone wrote it already */
				LWLockRelease(WALWriteLock);
				Insert->LogwrtResult = LogwrtResult;
T
Tom Lane 已提交
1298
			}
1299
			else
T
Tom Lane 已提交
1300 1301
			{
				/*
B
Bruce Momjian 已提交
1302 1303
				 * Have to write buffers while holding insert lock. This is
				 * not good, so only write as much as we absolutely must.
T
Tom Lane 已提交
1304 1305 1306 1307
				 */
				WriteRqst.Write = OldPageRqstPtr;
				WriteRqst.Flush.xlogid = 0;
				WriteRqst.Flush.xrecoff = 0;
1308
				XLogWrite(WriteRqst, false, false);
1309
				LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1310
				Insert->LogwrtResult = LogwrtResult;
1311 1312 1313 1314
			}
		}
	}

T
Tom Lane 已提交
1315
	/*
B
Bruce Momjian 已提交
1316 1317
	 * Now the next buffer slot is free and we can set it up to be the next
	 * output page.
T
Tom Lane 已提交
1318
	 */
1319
	NewPageEndPtr = XLogCtl->xlblocks[Insert->curridx];
1320 1321 1322 1323 1324 1325 1326 1327

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

1328
	if (NewPageEndPtr.xrecoff >= XLogFileSize)
1329
	{
T
Tom Lane 已提交
1330
		/* crossing a logid boundary */
1331
		NewPageEndPtr.xlogid += 1;
1332
		NewPageEndPtr.xrecoff = XLOG_BLCKSZ;
1333
	}
T
Tom Lane 已提交
1334
	else
1335
		NewPageEndPtr.xrecoff += XLOG_BLCKSZ;
1336
	XLogCtl->xlblocks[nextidx] = NewPageEndPtr;
1337
	NewPage = (XLogPageHeader) (XLogCtl->pages + nextidx * (Size) XLOG_BLCKSZ);
B
Bruce Momjian 已提交
1338

T
Tom Lane 已提交
1339
	Insert->curridx = nextidx;
1340
	Insert->currpage = NewPage;
B
Bruce Momjian 已提交
1341 1342

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

T
Tom Lane 已提交
1344
	/*
B
Bruce Momjian 已提交
1345 1346
	 * 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 已提交
1347
	 */
1348
	MemSet((char *) NewPage, 0, XLOG_BLCKSZ);
1349

1350 1351 1352
	/*
	 * Fill the new page's header
	 */
B
Bruce Momjian 已提交
1353 1354
	NewPage   ->xlp_magic = XLOG_PAGE_MAGIC;

1355
	/* NewPage->xlp_info = 0; */	/* done by memset */
B
Bruce Momjian 已提交
1356 1357
	NewPage   ->xlp_tli = ThisTimeLineID;
	NewPage   ->xlp_pageaddr.xlogid = NewPageEndPtr.xlogid;
1358
	NewPage   ->xlp_pageaddr.xrecoff = NewPageEndPtr.xrecoff - XLOG_BLCKSZ;
T
Tom Lane 已提交
1359

1360
	/*
1361
	 * If first page of an XLOG segment file, make it a long header.
1362 1363 1364
	 */
	if ((NewPage->xlp_pageaddr.xrecoff % XLogSegSize) == 0)
	{
1365
		XLogLongPageHeader NewLongPage = (XLogLongPageHeader) NewPage;
1366

1367 1368
		NewLongPage->xlp_sysid = ControlFile->system_identifier;
		NewLongPage->xlp_seg_size = XLogSegSize;
1369
		NewLongPage->xlp_xlog_blcksz = XLOG_BLCKSZ;
B
Bruce Momjian 已提交
1370 1371 1372
		NewPage   ->xlp_info |= XLP_LONG_HEADER;

		Insert->currpos = ((char *) NewPage) +SizeOfXLogLongPHD;
1373 1374
	}

T
Tom Lane 已提交
1375
	return update_needed;
1376 1377
}

T
Tom Lane 已提交
1378 1379 1380
/*
 * Write and/or fsync the log at least as far as WriteRqst indicates.
 *
1381 1382 1383 1384 1385
 * 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.
 *
1386 1387 1388 1389 1390 1391
 * 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.)
 *
1392
 * Must be called with WALWriteLock held.
T
Tom Lane 已提交
1393
 */
1394
static void
1395
XLogWrite(XLogwrtRqst WriteRqst, bool flexible, bool xlog_switch)
1396
{
1397
	XLogCtlWrite *Write = &XLogCtl->Write;
T
Tom Lane 已提交
1398
	bool		ispartialpage;
1399
	bool		last_iteration;
1400
	bool		finishing_seg;
1401
	bool		use_existent;
1402 1403 1404 1405
	int			curridx;
	int			npages;
	int			startidx;
	uint32		startoffset;
1406

1407 1408 1409
	/* We should always be inside a critical section here */
	Assert(CritSectionCount > 0);

B
Bruce Momjian 已提交
1410
	/*
B
Bruce Momjian 已提交
1411
	 * Update local LogwrtResult (caller probably did this already, but...)
B
Bruce Momjian 已提交
1412
	 */
T
Tom Lane 已提交
1413 1414
	LogwrtResult = Write->LogwrtResult;

1415 1416 1417
	/*
	 * Since successive pages in the xlog cache are consecutively allocated,
	 * we can usually gather multiple pages together and issue just one
B
Bruce Momjian 已提交
1418 1419 1420 1421 1422
	 * 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.
1423 1424 1425 1426 1427 1428 1429 1430 1431
	 */
	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 已提交
1432 1433
	 * going to PANIC if any error occurs anyway; but someday it may come in
	 * useful.)
1434 1435
	 */
	curridx = Write->curridx;
B
 
Bruce Momjian 已提交
1436

T
Tom Lane 已提交
1437
	while (XLByteLT(LogwrtResult.Write, WriteRqst.Write))
1438
	{
1439
		/*
B
Bruce Momjian 已提交
1440 1441 1442
		 * 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.
1443
		 */
1444
		if (!XLByteLT(LogwrtResult.Write, XLogCtl->xlblocks[curridx]))
1445
			elog(PANIC, "xlog write request %X/%X is past end of log %X/%X",
1446
				 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
1447 1448
				 XLogCtl->xlblocks[curridx].xlogid,
				 XLogCtl->xlblocks[curridx].xrecoff);
1449

T
Tom Lane 已提交
1450
		/* Advance LogwrtResult.Write to end of current buffer page */
1451
		LogwrtResult.Write = XLogCtl->xlblocks[curridx];
T
Tom Lane 已提交
1452 1453 1454
		ispartialpage = XLByteLT(WriteRqst.Write, LogwrtResult.Write);

		if (!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1455
		{
T
Tom Lane 已提交
1456
			/*
1457 1458
			 * Switch to new logfile segment.  We cannot have any pending
			 * pages here (since we dump what we have at segment end).
T
Tom Lane 已提交
1459
			 */
1460
			Assert(npages == 0);
T
Tom Lane 已提交
1461
			if (openLogFile >= 0)
1462
				XLogFileClose();
T
Tom Lane 已提交
1463 1464
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);

1465 1466 1467 1468
			/* create/use new log file */
			use_existent = true;
			openLogFile = XLogFileInit(openLogId, openLogSeg,
									   &use_existent, true);
T
Tom Lane 已提交
1469
			openLogOff = 0;
1470 1471
		}

1472
		/* Make sure we have the current logfile open */
T
Tom Lane 已提交
1473
		if (openLogFile < 0)
1474
		{
T
Tom Lane 已提交
1475
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1476
			openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
1477
			openLogOff = 0;
1478 1479
		}

1480 1481 1482 1483 1484
		/* Add current page to the set of pending pages-to-dump */
		if (npages == 0)
		{
			/* first of group */
			startidx = curridx;
1485
			startoffset = (LogwrtResult.Write.xrecoff - XLOG_BLCKSZ) % XLogSegSize;
1486 1487
		}
		npages++;
1488

T
Tom Lane 已提交
1489
		/*
B
Bruce Momjian 已提交
1490 1491 1492 1493
		 * 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 已提交
1494
		 */
1495 1496
		last_iteration = !XLByteLT(LogwrtResult.Write, WriteRqst.Write);

1497
		finishing_seg = !ispartialpage &&
1498
			(startoffset + npages * XLOG_BLCKSZ) >= XLogSegSize;
1499

1500
		if (last_iteration ||
1501 1502
			curridx == XLogCtl->XLogCacheBlck ||
			finishing_seg)
T
Tom Lane 已提交
1503
		{
1504 1505
			char	   *from;
			Size		nbytes;
1506

1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
			/* 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) */
1520 1521
			from = XLogCtl->pages + startidx * (Size) XLOG_BLCKSZ;
			nbytes = npages * (Size) XLOG_BLCKSZ;
1522 1523 1524 1525 1526 1527 1528 1529 1530
			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 已提交
1531
								"at offset %u, length %lu: %m",
1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
								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.
			 *
1548 1549 1550
			 * We also do this if this is the last page written for an xlog
			 * switch.
			 *
1551
			 * This is also the right place to notify the Archiver that the
B
Bruce Momjian 已提交
1552
			 * segment is ready to copy to archival storage, and to update the
1553 1554 1555
			 * timer for archive_timeout, and to signal for a checkpoint if
			 * too many logfile segments have been used since the last
			 * checkpoint.
1556
			 */
1557
			if (finishing_seg || (xlog_switch && last_iteration))
1558 1559
			{
				issue_xlog_fsync();
B
Bruce Momjian 已提交
1560
				LogwrtResult.Flush = LogwrtResult.Write;		/* end of page */
1561 1562 1563

				if (XLogArchivingActive())
					XLogArchiveNotifySeg(openLogId, openLogSeg);
1564 1565

				Write->lastSegSwitchTime = time(NULL);
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600

				/*
				 * Signal bgwriter to start a checkpoint if it's been too long
				 * 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.)
				 *
				 * 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))
					{
#ifdef WAL_DEBUG
						if (XLOG_DEBUG)
							elog(LOG, "time for a checkpoint, signaling bgwriter");
#endif
						RequestCheckpoint(false, true);
					}
				}
1601
			}
T
Tom Lane 已提交
1602
		}
1603

T
Tom Lane 已提交
1604 1605 1606 1607 1608 1609
		if (ispartialpage)
		{
			/* Only asked to write a partial page */
			LogwrtResult.Write = WriteRqst.Write;
			break;
		}
1610 1611 1612 1613 1614
		curridx = NextBufIdx(curridx);

		/* If flexible, break out of loop as soon as we wrote something */
		if (flexible && npages == 0)
			break;
1615
	}
1616 1617 1618

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

T
Tom Lane 已提交
1620 1621 1622 1623 1624
	/*
	 * If asked to flush, do so
	 */
	if (XLByteLT(LogwrtResult.Flush, WriteRqst.Flush) &&
		XLByteLT(LogwrtResult.Flush, LogwrtResult.Write))
1625
	{
T
Tom Lane 已提交
1626
		/*
B
Bruce Momjian 已提交
1627 1628 1629
		 * 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 已提交
1630
		 */
1631
		if (sync_method != SYNC_METHOD_OPEN)
T
Tom Lane 已提交
1632
		{
1633
			if (openLogFile >= 0 &&
B
Bruce Momjian 已提交
1634
				!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1635
				XLogFileClose();
1636 1637 1638
			if (openLogFile < 0)
			{
				XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1639
				openLogFile = XLogFileOpen(openLogId, openLogSeg);
1640 1641 1642
				openLogOff = 0;
			}
			issue_xlog_fsync();
T
Tom Lane 已提交
1643 1644
		}
		LogwrtResult.Flush = LogwrtResult.Write;
1645 1646
	}

T
Tom Lane 已提交
1647 1648 1649
	/*
	 * Update shared-memory status
	 *
B
Bruce Momjian 已提交
1650
	 * We make sure that the shared 'request' values do not fall behind the
B
Bruce Momjian 已提交
1651 1652
	 * 'result' values.  This is not absolutely essential, but it saves some
	 * code in a couple of places.
T
Tom Lane 已提交
1653
	 */
1654 1655 1656 1657
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1658
		SpinLockAcquire(&xlogctl->info_lck);
1659 1660 1661 1662 1663
		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;
1664
		SpinLockRelease(&xlogctl->info_lck);
1665
	}
1666

T
Tom Lane 已提交
1667 1668 1669 1670 1671 1672
	Write->LogwrtResult = LogwrtResult;
}

/*
 * Ensure that all XLOG data through the given position is flushed to disk.
 *
1673
 * NOTE: this differs from XLogWrite mainly in that the WALWriteLock is not
T
Tom Lane 已提交
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689
 * 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;

1690
#ifdef WAL_DEBUG
1691
	if (XLOG_DEBUG)
1692
		elog(LOG, "xlog flush request %X/%X; write %X/%X; flush %X/%X",
1693 1694 1695
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1696
#endif
1697

T
Tom Lane 已提交
1698 1699 1700 1701
	START_CRIT_SECTION();

	/*
	 * Since fsync is usually a horribly expensive operation, we try to
B
Bruce Momjian 已提交
1702 1703 1704 1705
	 * 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 已提交
1706 1707 1708 1709 1710
	 */

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

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

1716
		SpinLockAcquire(&xlogctl->info_lck);
1717 1718 1719
		if (XLByteLT(WriteRqstPtr, xlogctl->LogwrtRqst.Write))
			WriteRqstPtr = xlogctl->LogwrtRqst.Write;
		LogwrtResult = xlogctl->LogwrtResult;
1720
		SpinLockRelease(&xlogctl->info_lck);
1721
	}
1722 1723 1724

	/* done already? */
	if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1725
	{
1726 1727 1728 1729
		/* now wait for the write lock */
		LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
		LogwrtResult = XLogCtl->Write.LogwrtResult;
		if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1730
		{
1731 1732 1733 1734 1735 1736
			/* 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 已提交
1737
				if (freespace < SizeOfXLogRecord)		/* buffer is full */
1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752
					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;
			}
1753
			XLogWrite(WriteRqst, false, false);
T
Tom Lane 已提交
1754
		}
1755
		LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1756 1757 1758
	}

	END_CRIT_SECTION();
1759 1760 1761

	/*
	 * If we still haven't flushed to the request point then we have a
B
Bruce Momjian 已提交
1762 1763
	 * 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.
1764
	 *
1765 1766 1767 1768 1769 1770 1771 1772 1773
	 * 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.)
1774
	 *
1775 1776 1777 1778
	 * 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 已提交
1779 1780
	 * 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.
1781 1782
	 */
	if (XLByteLT(LogwrtResult.Flush, record))
B
Bruce Momjian 已提交
1783
		elog(InRecovery ? WARNING : ERROR,
B
Bruce Momjian 已提交
1784
		"xlog flush request %X/%X is not satisfied --- flushed only to %X/%X",
1785 1786
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1787 1788
}

T
Tom Lane 已提交
1789 1790 1791
/*
 * Create a new XLOG file segment, or open a pre-existing one.
 *
1792 1793 1794
 * log, seg: identify segment to be created/opened.
 *
 * *use_existent: if TRUE, OK to use a pre-existing file (else, any
B
Bruce Momjian 已提交
1795
 * pre-existing file will be deleted).	On return, TRUE if a pre-existing
1796 1797
 * file was used.
 *
1798
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
1799
 * place.  This should be TRUE except during bootstrap log creation.  The
1800
 * caller must *not* hold the lock at call.
1801
 *
T
Tom Lane 已提交
1802
 * Returns FD of opened file.
1803 1804 1805 1806 1807
 *
 * 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 已提交
1808
 */
1809
static int
1810 1811
XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock)
1812
{
1813
	char		path[MAXPGPATH];
1814
	char		tmppath[MAXPGPATH];
1815
	char		zbuffer[XLOG_BLCKSZ];
1816 1817 1818
	uint32		installed_log;
	uint32		installed_seg;
	int			max_advance;
1819
	int			fd;
1820
	int			nbytes;
1821

1822
	XLogFilePath(path, ThisTimeLineID, log, seg);
V
Vadim B. Mikheev 已提交
1823 1824

	/*
B
Bruce Momjian 已提交
1825
	 * Try to use existent file (checkpoint maker may have created it already)
V
Vadim B. Mikheev 已提交
1826
	 */
1827
	if (*use_existent)
V
Vadim B. Mikheev 已提交
1828
	{
1829 1830
		fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
						   S_IRUSR | S_IWUSR);
V
Vadim B. Mikheev 已提交
1831 1832 1833
		if (fd < 0)
		{
			if (errno != ENOENT)
1834
				ereport(ERROR,
1835
						(errcode_for_file_access(),
1836
						 errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
1837
								path, log, seg)));
V
Vadim B. Mikheev 已提交
1838 1839
		}
		else
1840
			return fd;
V
Vadim B. Mikheev 已提交
1841 1842
	}

1843
	/*
B
Bruce Momjian 已提交
1844 1845 1846 1847
	 * 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.
1848
	 */
1849
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
1850 1851

	unlink(tmppath);
1852

1853
	/* do not use XLOG_SYNC_BIT here --- want to fsync only at end of fill */
1854
	fd = BasicOpenFile(tmppath, O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
T
Tom Lane 已提交
1855
					   S_IRUSR | S_IWUSR);
1856
	if (fd < 0)
1857
		ereport(ERROR,
1858
				(errcode_for_file_access(),
1859
				 errmsg("could not create file \"%s\": %m", tmppath)));
1860

1861
	/*
B
Bruce Momjian 已提交
1862 1863 1864 1865 1866 1867 1868
	 * 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.
1869 1870 1871 1872
	 */
	MemSet(zbuffer, 0, sizeof(zbuffer));
	for (nbytes = 0; nbytes < XLogSegSize; nbytes += sizeof(zbuffer))
	{
1873
		errno = 0;
1874
		if ((int) write(fd, zbuffer, sizeof(zbuffer)) != (int) sizeof(zbuffer))
T
Tom Lane 已提交
1875
		{
B
Bruce Momjian 已提交
1876
			int			save_errno = errno;
T
Tom Lane 已提交
1877

B
Bruce Momjian 已提交
1878
			/*
B
Bruce Momjian 已提交
1879
			 * If we fail to make the file, delete it to release disk space
B
Bruce Momjian 已提交
1880
			 */
1881
			unlink(tmppath);
1882 1883
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;
T
Tom Lane 已提交
1884

1885
			ereport(ERROR,
1886
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
1887
					 errmsg("could not write to file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
1888
		}
1889
	}
1890

1891
	if (pg_fsync(fd) != 0)
1892
		ereport(ERROR,
1893
				(errcode_for_file_access(),
1894
				 errmsg("could not fsync file \"%s\": %m", tmppath)));
1895

1896
	if (close(fd))
1897
		ereport(ERROR,
1898 1899
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
1900

1901
	/*
1902 1903
	 * Now move the segment into place with its final name.
	 *
1904
	 * If caller didn't want to use a pre-existing file, get rid of any
B
Bruce Momjian 已提交
1905 1906 1907
	 * 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.
1908
	 */
1909 1910 1911 1912 1913
	installed_log = log;
	installed_seg = seg;
	max_advance = XLOGfileslop;
	if (!InstallXLogFileSegment(&installed_log, &installed_seg, tmppath,
								*use_existent, &max_advance,
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926
								use_lock))
	{
		/* No need for any more future segments... */
		unlink(tmppath);
	}

	/* 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)
1927
		ereport(ERROR,
1928
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
1929 1930
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
1931

1932
	return fd;
1933 1934
}

1935 1936 1937 1938 1939 1940 1941 1942 1943
/*
 * 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 已提交
1944
 * considerations.	But we should be just as tense as XLogFileInit to avoid
1945 1946 1947 1948 1949 1950 1951 1952
 * emplacing a bogus file.
 */
static void
XLogFileCopy(uint32 log, uint32 seg,
			 TimeLineID srcTLI, uint32 srclog, uint32 srcseg)
{
	char		path[MAXPGPATH];
	char		tmppath[MAXPGPATH];
1953
	char		buffer[XLOG_BLCKSZ];
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
	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)
1964
		ereport(ERROR,
1965 1966 1967 1968 1969 1970
				(errcode_for_file_access(),
				 errmsg("could not open file \"%s\": %m", path)));

	/*
	 * Copy into a temp file name.
	 */
1971
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
1972 1973 1974 1975 1976 1977 1978

	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)
1979
		ereport(ERROR,
1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
				(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)
1992
				ereport(ERROR,
1993 1994 1995
						(errcode_for_file_access(),
						 errmsg("could not read file \"%s\": %m", path)));
			else
1996
				ereport(ERROR,
B
Bruce Momjian 已提交
1997
						(errmsg("not enough data in file \"%s\"", path)));
1998 1999 2000 2001 2002 2003 2004
		}
		errno = 0;
		if ((int) write(fd, buffer, sizeof(buffer)) != (int) sizeof(buffer))
		{
			int			save_errno = errno;

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

2011
			ereport(ERROR,
2012
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2013
					 errmsg("could not write to file \"%s\": %m", tmppath)));
2014 2015 2016 2017
		}
	}

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

	if (close(fd))
2023
		ereport(ERROR,
2024 2025 2026 2027 2028 2029 2030 2031
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));

	close(srcfd);

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

2036 2037 2038 2039 2040 2041
/*
 * 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.
 *
2042 2043 2044
 * *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.
2045 2046 2047 2048 2049 2050 2051
 *
 * 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.
 *
2052 2053 2054 2055
 * *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.)
2056
 *
2057
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
2058
 * place.  This should be TRUE except during bootstrap log creation.  The
2059
 * caller must *not* hold the lock at call.
2060 2061
 *
 * Returns TRUE if file installed, FALSE if not installed because of
2062 2063 2064
 * 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().)
2065 2066
 */
static bool
2067 2068
InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
2069 2070 2071
					   bool use_lock)
{
	char		path[MAXPGPATH];
2072
	struct stat stat_buf;
2073

2074
	XLogFilePath(path, ThisTimeLineID, *log, *seg);
2075 2076 2077 2078 2079

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

2082 2083 2084 2085 2086
	if (!find_free)
	{
		/* Force installation: get rid of any pre-existing segment file */
		unlink(path);
	}
2087 2088
	else
	{
2089
		/* Find a free slot to put it in */
2090
		while (stat(path, &stat_buf) == 0)
2091
		{
2092
			if (*max_advance <= 0)
2093 2094 2095
			{
				/* Failed to find a free slot within specified range */
				if (use_lock)
2096
					LWLockRelease(ControlFileLock);
2097 2098
				return false;
			}
2099 2100 2101
			NextLogSeg(*log, *seg);
			(*max_advance)--;
			XLogFilePath(path, ThisTimeLineID, *log, *seg);
2102 2103 2104 2105 2106 2107 2108
		}
	}

	/*
	 * 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.
2109
	 */
2110
#if HAVE_WORKING_LINK
2111
	if (link(tmppath, path) < 0)
2112
		ereport(ERROR,
2113
				(errcode_for_file_access(),
2114
				 errmsg("could not link file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2115
						tmppath, path, *log, *seg)));
2116
	unlink(tmppath);
2117
#else
2118
	if (rename(tmppath, path) < 0)
2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
	{
#ifdef WIN32
#if !defined(__CYGWIN__)
		if (GetLastError() == ERROR_ACCESS_DENIED)
#else
		if (errno == EACCES)
#endif
		{
			if (use_lock)
				LWLockRelease(ControlFileLock);
			return false;
		}
#endif /* WIN32 */

2133
		ereport(ERROR,
2134
				(errcode_for_file_access(),
2135
				 errmsg("could not rename file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2136
						tmppath, path, *log, *seg)));
2137
	}
2138
#endif
V
Vadim B. Mikheev 已提交
2139

2140
	if (use_lock)
2141
		LWLockRelease(ControlFileLock);
2142

2143
	return true;
2144 2145
}

T
Tom Lane 已提交
2146
/*
2147
 * Open a pre-existing logfile segment for writing.
T
Tom Lane 已提交
2148
 */
2149
static int
2150
XLogFileOpen(uint32 log, uint32 seg)
2151
{
2152 2153
	char		path[MAXPGPATH];
	int			fd;
2154

2155
	XLogFilePath(path, ThisTimeLineID, log, seg);
2156

2157 2158
	fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
					   S_IRUSR | S_IWUSR);
2159
	if (fd < 0)
2160 2161
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2162 2163
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177

	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;
2178

2179
	/*
B
Bruce Momjian 已提交
2180 2181
	 * Loop looking for a suitable timeline ID: we might need to read any of
	 * the timelines listed in expectedTLIs.
2182
	 *
B
Bruce Momjian 已提交
2183
	 * We expect curFileTLI on entry to be the TLI of the preceding file in
B
Bruce Momjian 已提交
2184 2185 2186 2187
	 * 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.
2188
	 */
2189 2190 2191
	foreach(cell, expectedTLIs)
	{
		TimeLineID	tli = (TimeLineID) lfirst_int(cell);
2192

2193 2194 2195 2196 2197 2198 2199
		if (tli < curFileTLI)
			break;				/* don't bother looking at too-old TLIs */

		if (InArchiveRecovery)
		{
			XLogFileName(xlogfname, tli, log, seg);
			restoredFromArchive = RestoreArchivedFile(path, xlogfname,
2200 2201
													  "RECOVERYXLOG",
													  XLogSegSize);
2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215
		}
		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 已提交
2216 2217
			errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				   path, log, seg)));
2218 2219 2220 2221 2222 2223 2224
	}

	/* 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 已提交
2225 2226
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2227
	return -1;
2228 2229
}

2230 2231 2232 2233 2234 2235 2236 2237
/*
 * Close the current logfile segment for writing.
 */
static void
XLogFileClose(void)
{
	Assert(openLogFile >= 0);

2238
	/*
B
Bruce Momjian 已提交
2239 2240 2241 2242 2243 2244
	 * 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.
2245 2246 2247
	 */
#ifdef NOT_USED

2248
	/*
2249
	 * WAL segment files will not be re-read in normal operation, so we advise
B
Bruce Momjian 已提交
2250
	 * OS to release any cached pages.	But do not do so if WAL archiving is
2251 2252 2253
	 * active, because archiver process could use the cache to read the WAL
	 * segment.
	 *
B
Bruce Momjian 已提交
2254 2255
	 * While O_DIRECT works for O_SYNC, posix_fadvise() works for fsync() and
	 * O_SYNC, and some platforms only have posix_fadvise().
2256
	 */
2257
#if defined(HAVE_DECL_POSIX_FADVISE) && defined(POSIX_FADV_DONTNEED)
2258 2259 2260
	if (!XLogArchivingActive())
		posix_fadvise(openLogFile, 0, 0, POSIX_FADV_DONTNEED);
#endif
B
Bruce Momjian 已提交
2261
#endif   /* NOT_USED */
2262

2263 2264
	if (close(openLogFile))
		ereport(PANIC,
B
Bruce Momjian 已提交
2265 2266 2267
				(errcode_for_file_access(),
				 errmsg("could not close log file %u, segment %u: %m",
						openLogId, openLogSeg)));
2268 2269 2270
	openLogFile = -1;
}

2271
/*
2272
 * Attempt to retrieve the specified file from off-line archival storage.
2273
 * If successful, fill "path" with its complete path (note that this will be
2274 2275
 * a temp file name that doesn't follow the normal naming convention), and
 * return TRUE.
2276
 *
2277 2278 2279
 * 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.
2280 2281 2282 2283
 *
 * 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.
2284
 */
2285 2286
static bool
RestoreArchivedFile(char *path, const char *xlogfname,
2287
					const char *recovername, off_t expectedSize)
2288
{
B
Bruce Momjian 已提交
2289 2290 2291 2292
	char		xlogpath[MAXPGPATH];
	char		xlogRestoreCmd[MAXPGPATH];
	char	   *dp;
	char	   *endp;
2293
	const char *sp;
B
Bruce Momjian 已提交
2294
	int			rc;
2295
	bool		signaled;
2296 2297 2298
	struct stat stat_buf;

	/*
B
Bruce Momjian 已提交
2299 2300 2301 2302
	 * 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.
2303
	 *
B
Bruce Momjian 已提交
2304
	 * We could try to optimize this slightly by checking the local copy
B
Bruce Momjian 已提交
2305 2306 2307 2308
	 * 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.
2309
	 *
2310 2311 2312
	 * 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.
2313
	 *
2314 2315 2316 2317
	 * 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 已提交
2318 2319
	 * copy-from-archive filename is always the same, ensuring that we don't
	 * run out of disk space on long recoveries.
2320
	 */
2321
	snprintf(xlogpath, MAXPGPATH, XLOGDIR "/%s", recovername);
2322 2323

	/*
2324
	 * Make sure there is no existing file named recovername.
2325 2326 2327 2328 2329 2330
	 */
	if (stat(xlogpath, &stat_buf) != 0)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
2331
					 errmsg("could not stat file \"%s\": %m",
2332 2333 2334 2335 2336 2337 2338
							xlogpath)));
	}
	else
	{
		if (unlink(xlogpath) != 0)
			ereport(FATAL,
					(errcode_for_file_access(),
2339
					 errmsg("could not remove file \"%s\": %m",
2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
							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':
2357
					/* %p: relative path of target file */
2358
					sp++;
B
Bruce Momjian 已提交
2359
					StrNCpy(dp, xlogpath, endp - dp);
2360
					make_native_path(dp);
2361 2362 2363 2364 2365
					dp += strlen(dp);
					break;
				case 'f':
					/* %f: filename of desired file */
					sp++;
B
Bruce Momjian 已提交
2366
					StrNCpy(dp, xlogfname, endp - dp);
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390
					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 已提交
2391
			(errmsg_internal("executing restore command \"%s\"",
2392 2393 2394
							 xlogRestoreCmd)));

	/*
2395
	 * Copy xlog from archival storage to XLOGDIR
2396 2397 2398 2399
	 */
	rc = system(xlogRestoreCmd);
	if (rc == 0)
	{
2400 2401 2402 2403
		/*
		 * command apparently succeeded, but let's make sure the file is
		 * really there now and has the correct size.
		 *
2404 2405 2406 2407 2408
		 * 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 ...
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432
		 */
		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 已提交
2433
						 errmsg("could not stat file \"%s\": %m",
2434
								xlogpath)));
2435 2436 2437 2438
		}
	}

	/*
2439
	 * Remember, we rollforward UNTIL the restore fails so failure here is
B
Bruce Momjian 已提交
2440
	 * just part of the process... that makes it difficult to determine
B
Bruce Momjian 已提交
2441 2442 2443
	 * 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.
2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
	 *
	 * 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.
2457
	 */
2458 2459 2460
	signaled = WIFSIGNALED(rc) || WEXITSTATUS(rc) > 125;

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

	/*
B
Bruce Momjian 已提交
2465 2466
	 * 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.
2467
	 *
B
Bruce Momjian 已提交
2468 2469
	 * In many recovery scenarios we expect this to fail also, but if so that
	 * just means we've reached the end of WAL.
2470
	 */
2471
	snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlogfname);
2472
	return false;
2473 2474
}

V
Vadim B. Mikheev 已提交
2475
/*
T
Tom Lane 已提交
2476 2477 2478
 * Preallocate log files beyond the specified log endpoint, according to
 * the XLOGfile user parameter.
 */
2479
static int
T
Tom Lane 已提交
2480 2481
PreallocXlogFiles(XLogRecPtr endptr)
{
2482
	int			nsegsadded = 0;
T
Tom Lane 已提交
2483 2484 2485
	uint32		_logId;
	uint32		_logSeg;
	int			lf;
2486
	bool		use_existent;
T
Tom Lane 已提交
2487 2488

	XLByteToPrevSeg(endptr, _logId, _logSeg);
B
Bruce Momjian 已提交
2489
	if ((endptr.xrecoff - 1) % XLogSegSize >=
B
Bruce Momjian 已提交
2490
		(uint32) (0.75 * XLogSegSize))
T
Tom Lane 已提交
2491 2492
	{
		NextLogSeg(_logId, _logSeg);
2493 2494
		use_existent = true;
		lf = XLogFileInit(_logId, _logSeg, &use_existent, true);
T
Tom Lane 已提交
2495
		close(lf);
2496 2497
		if (!use_existent)
			nsegsadded++;
T
Tom Lane 已提交
2498
	}
2499
	return nsegsadded;
T
Tom Lane 已提交
2500 2501 2502 2503
}

/*
 * Remove or move offline all log files older or equal to passed log/seg#
2504 2505 2506
 *
 * 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 已提交
2507 2508
 */
static void
2509 2510
MoveOfflineLogs(uint32 log, uint32 seg, XLogRecPtr endptr,
				int *nsegsremoved, int *nsegsrecycled)
V
Vadim B. Mikheev 已提交
2511
{
2512 2513
	uint32		endlogId;
	uint32		endlogSeg;
2514
	int			max_advance;
B
Bruce Momjian 已提交
2515 2516
	DIR		   *xldir;
	struct dirent *xlde;
2517
	char		lastoff[MAXFNAMELEN];
B
Bruce Momjian 已提交
2518
	char		path[MAXPGPATH];
V
Vadim B. Mikheev 已提交
2519

2520 2521 2522
	*nsegsremoved = 0;
	*nsegsrecycled = 0;

2523 2524 2525 2526
	/*
	 * Initialize info about where to try to recycle to.  We allow recycling
	 * segments up to XLOGfileslop segments beyond the current XLOG location.
	 */
2527
	XLByteToPrevSeg(endptr, endlogId, endlogSeg);
2528
	max_advance = XLOGfileslop;
V
Vadim B. Mikheev 已提交
2529

2530
	xldir = AllocateDir(XLOGDIR);
V
Vadim B. Mikheev 已提交
2531
	if (xldir == NULL)
2532
		ereport(ERROR,
2533
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2534 2535
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
V
Vadim B. Mikheev 已提交
2536

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

2539
	while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
V
Vadim B. Mikheev 已提交
2540
	{
2541
		/*
2542
		 * We ignore the timeline part of the XLOG segment identifiers in
B
Bruce Momjian 已提交
2543 2544 2545 2546 2547
		 * 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.
2548
		 *
B
Bruce Momjian 已提交
2549 2550
		 * We use the alphanumeric sorting property of the filenames to decide
		 * which ones are earlier than the lastoff segment.
2551
		 */
2552 2553 2554
		if (strlen(xlde->d_name) == 24 &&
			strspn(xlde->d_name, "0123456789ABCDEF") == 24 &&
			strcmp(xlde->d_name + 8, lastoff + 8) <= 0)
V
Vadim B. Mikheev 已提交
2555
		{
2556
			if (XLogArchiveCheckDone(xlde->d_name))
2557
			{
2558
				snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlde->d_name);
2559

2560
				/*
B
Bruce Momjian 已提交
2561 2562
				 * Before deleting the file, see if it can be recycled as a
				 * future log segment.
2563
				 */
2564 2565
				if (InstallXLogFileSegment(&endlogId, &endlogSeg, path,
										   true, &max_advance,
2566 2567
										   true))
				{
2568
					ereport(DEBUG2,
B
Bruce Momjian 已提交
2569 2570
							(errmsg("recycled transaction log file \"%s\"",
									xlde->d_name)));
2571
					(*nsegsrecycled)++;
2572 2573 2574 2575 2576 2577
					/* Needn't recheck that slot on future iterations */
					if (max_advance > 0)
					{
						NextLogSeg(endlogId, endlogSeg);
						max_advance--;
					}
2578 2579 2580 2581
				}
				else
				{
					/* No need for any more future segments... */
2582
					ereport(DEBUG2,
B
Bruce Momjian 已提交
2583 2584
							(errmsg("removing transaction log file \"%s\"",
									xlde->d_name)));
2585
					unlink(path);
2586
					(*nsegsremoved)++;
2587
				}
2588 2589

				XLogArchiveCleanup(xlde->d_name);
2590
			}
V
Vadim B. Mikheev 已提交
2591 2592
		}
	}
B
Bruce Momjian 已提交
2593

2594
	FreeDir(xldir);
V
Vadim B. Mikheev 已提交
2595 2596
}

2597
/*
2598 2599 2600
 * Remove previous backup history files.  This also retries creation of
 * .ready files for any backup history files for which XLogArchiveNotify
 * failed earlier.
2601 2602
 */
static void
2603
CleanupBackupHistory(void)
2604 2605 2606 2607 2608
{
	DIR		   *xldir;
	struct dirent *xlde;
	char		path[MAXPGPATH];

2609
	xldir = AllocateDir(XLOGDIR);
2610 2611 2612
	if (xldir == NULL)
		ereport(ERROR,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2613 2614
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
2615

2616
	while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
2617 2618 2619 2620 2621 2622
	{
		if (strlen(xlde->d_name) > 24 &&
			strspn(xlde->d_name, "0123456789ABCDEF") == 24 &&
			strcmp(xlde->d_name + strlen(xlde->d_name) - strlen(".backup"),
				   ".backup") == 0)
		{
2623
			if (XLogArchiveCheckDone(xlde->d_name))
2624 2625
			{
				ereport(DEBUG2,
B
Bruce Momjian 已提交
2626 2627
				(errmsg("removing transaction log backup history file \"%s\"",
						xlde->d_name)));
2628
				snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlde->d_name);
2629 2630 2631 2632 2633 2634 2635 2636 2637
				unlink(path);
				XLogArchiveCleanup(xlde->d_name);
			}
		}
	}

	FreeDir(xldir);
}

T
Tom Lane 已提交
2638 2639 2640 2641
/*
 * Restore the backup blocks present in an XLOG record, if any.
 *
 * We assume all of the record has been read into memory at *record.
2642 2643 2644 2645 2646 2647 2648 2649 2650
 *
 * 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 已提交
2651
 */
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661
static void
RestoreBkpBlocks(XLogRecord *record, XLogRecPtr lsn)
{
	Relation	reln;
	Buffer		buffer;
	Page		page;
	BkpBlock	bkpb;
	char	   *blk;
	int			i;

B
Bruce Momjian 已提交
2662
	blk = (char *) XLogRecGetData(record) + record->xl_len;
T
Tom Lane 已提交
2663
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2664
	{
T
Tom Lane 已提交
2665
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2666 2667
			continue;

2668
		memcpy(&bkpb, blk, sizeof(BkpBlock));
2669 2670
		blk += sizeof(BkpBlock);

2671
		reln = XLogOpenRelation(bkpb.node);
2672 2673 2674
		buffer = XLogReadBuffer(reln, bkpb.block, true);
		Assert(BufferIsValid(buffer));
		page = (Page) BufferGetPage(buffer);
2675

2676
		if (bkpb.hole_length == 0)
2677
		{
2678 2679 2680 2681 2682 2683 2684 2685 2686 2687
			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));
2688 2689
		}

2690 2691
		PageSetLSN(page, lsn);
		PageSetTLI(page, ThisTimeLineID);
2692 2693
		MarkBufferDirty(buffer);
		UnlockReleaseBuffer(buffer);
2694

2695
		blk += BLCKSZ - bkpb.hole_length;
2696 2697 2698
	}
}

T
Tom Lane 已提交
2699 2700 2701 2702 2703 2704 2705
/*
 * 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.
 */
2706 2707 2708
static bool
RecordIsValid(XLogRecord *record, XLogRecPtr recptr, int emode)
{
2709
	pg_crc32	crc;
2710 2711
	int			i;
	uint32		len = record->xl_len;
2712
	BkpBlock	bkpb;
2713 2714
	char	   *blk;

2715 2716 2717
	/* First the rmgr data */
	INIT_CRC32(crc);
	COMP_CRC32(crc, XLogRecGetData(record), len);
2718

2719
	/* Add in the backup blocks, if any */
B
Bruce Momjian 已提交
2720
	blk = (char *) XLogRecGetData(record) + len;
T
Tom Lane 已提交
2721
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2722
	{
B
Bruce Momjian 已提交
2723
		uint32		blen;
2724

T
Tom Lane 已提交
2725
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2726 2727
			continue;

2728 2729
		memcpy(&bkpb, blk, sizeof(BkpBlock));
		if (bkpb.hole_offset + bkpb.hole_length > BLCKSZ)
2730
		{
2731
			ereport(emode,
2732 2733 2734
					(errmsg("incorrect hole size in record at %X/%X",
							recptr.xlogid, recptr.xrecoff)));
			return false;
2735
		}
2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757
		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 已提交
2758 2759
		(errmsg("incorrect resource manager data checksum in record at %X/%X",
				recptr.xlogid, recptr.xrecoff)));
2760
		return false;
2761 2762
	}

2763
	return true;
2764 2765
}

T
Tom Lane 已提交
2766 2767 2768 2769 2770 2771
/*
 * 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.
 *
2772 2773
 * If no valid record is available, returns NULL, or fails if emode is PANIC.
 * (emode must be either PANIC or LOG.)
T
Tom Lane 已提交
2774
 *
2775 2776
 * The record is copied into readRecordBuf, so that on successful return,
 * the returned record pointer always points there.
T
Tom Lane 已提交
2777
 */
2778
static XLogRecord *
2779
ReadRecord(XLogRecPtr *RecPtr, int emode)
2780
{
2781
	XLogRecord *record;
2782
	char	   *buffer;
2783
	XLogRecPtr	tmpRecPtr = EndRecPtr;
2784
	bool		randAccess = false;
T
Tom Lane 已提交
2785 2786 2787
	uint32		len,
				total_len;
	uint32		targetPageOff;
2788 2789
	uint32		targetRecOff;
	uint32		pageHeaderSize;
T
Tom Lane 已提交
2790 2791 2792 2793

	if (readBuf == NULL)
	{
		/*
B
Bruce Momjian 已提交
2794 2795 2796 2797 2798
		 * 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 已提交
2799
		 */
2800
		readBuf = (char *) malloc(XLOG_BLCKSZ);
T
Tom Lane 已提交
2801 2802
		Assert(readBuf != NULL);
	}
2803

T
Tom Lane 已提交
2804
	if (RecPtr == NULL)
2805
	{
2806
		RecPtr = &tmpRecPtr;
T
Tom Lane 已提交
2807
		/* fast case if next record is on same page */
2808 2809 2810 2811 2812
		if (nextRecord != NULL)
		{
			record = nextRecord;
			goto got_record;
		}
T
Tom Lane 已提交
2813
		/* align old recptr to next page */
2814 2815
		if (tmpRecPtr.xrecoff % XLOG_BLCKSZ != 0)
			tmpRecPtr.xrecoff += (XLOG_BLCKSZ - tmpRecPtr.xrecoff % XLOG_BLCKSZ);
2816 2817 2818 2819 2820
		if (tmpRecPtr.xrecoff >= XLogFileSize)
		{
			(tmpRecPtr.xlogid)++;
			tmpRecPtr.xrecoff = 0;
		}
2821 2822 2823 2824 2825 2826 2827 2828
		/* 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 已提交
2829

2830
		/*
B
Bruce Momjian 已提交
2831 2832 2833 2834 2835
		 * 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).
2836 2837 2838
		 */
		lastPageTLI = 0;		/* see comment in ValidXLOGHeader */
		randAccess = true;		/* allow curFileTLI to go backwards too */
2839 2840
	}

T
Tom Lane 已提交
2841
	if (readFile >= 0 && !XLByteInSeg(*RecPtr, readId, readSeg))
2842
	{
2843 2844
		close(readFile);
		readFile = -1;
2845
	}
T
Tom Lane 已提交
2846
	XLByteToSeg(*RecPtr, readId, readSeg);
2847
	if (readFile < 0)
2848
	{
2849 2850 2851 2852 2853
		/* Now it's okay to reset curFileTLI if random fetch */
		if (randAccess)
			curFileTLI = 0;

		readFile = XLogFileRead(readId, readSeg, emode);
2854 2855
		if (readFile < 0)
			goto next_record_is_invalid;
2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874

		/*
		 * 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;
2875 2876
	}

2877
	targetPageOff = ((RecPtr->xrecoff % XLogSegSize) / XLOG_BLCKSZ) * XLOG_BLCKSZ;
T
Tom Lane 已提交
2878
	if (readOff != targetPageOff)
2879
	{
T
Tom Lane 已提交
2880 2881 2882
		readOff = targetPageOff;
		if (lseek(readFile, (off_t) readOff, SEEK_SET) < 0)
		{
2883 2884
			ereport(emode,
					(errcode_for_file_access(),
2885
					 errmsg("could not seek in log file %u, segment %u to offset %u: %m",
2886
							readId, readSeg, readOff)));
T
Tom Lane 已提交
2887 2888
			goto next_record_is_invalid;
		}
2889
		if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
T
Tom Lane 已提交
2890
		{
2891 2892
			ereport(emode,
					(errcode_for_file_access(),
2893
					 errmsg("could not read from log file %u, segment %u at offset %u: %m",
2894
							readId, readSeg, readOff)));
T
Tom Lane 已提交
2895 2896
			goto next_record_is_invalid;
		}
2897
		if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
2898 2899
			goto next_record_is_invalid;
	}
2900
	pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
2901
	targetRecOff = RecPtr->xrecoff % XLOG_BLCKSZ;
2902 2903 2904
	if (targetRecOff == 0)
	{
		/*
B
Bruce Momjian 已提交
2905 2906 2907
		 * 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.
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918
		 */
		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 已提交
2919
	if ((((XLogPageHeader) readBuf)->xlp_info & XLP_FIRST_IS_CONTRECORD) &&
2920
		targetRecOff == pageHeaderSize)
2921
	{
2922 2923 2924
		ereport(emode,
				(errmsg("contrecord is requested by %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
2925 2926
		goto next_record_is_invalid;
	}
2927
	record = (XLogRecord *) ((char *) readBuf + RecPtr->xrecoff % XLOG_BLCKSZ);
2928 2929

got_record:;
B
Bruce Momjian 已提交
2930

T
Tom Lane 已提交
2931
	/*
B
Bruce Momjian 已提交
2932 2933
	 * xl_len == 0 is bad data for everything except XLOG SWITCH, where it is
	 * required.
T
Tom Lane 已提交
2934
	 */
2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945
	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)
2946
	{
2947 2948 2949
		ereport(emode,
				(errmsg("record with zero length at %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
2950 2951
		goto next_record_is_invalid;
	}
2952 2953 2954 2955 2956 2957 2958 2959 2960
	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;
	}
2961 2962 2963 2964
	if (record->xl_rmid > RM_MAX_ID)
	{
		ereport(emode,
				(errmsg("invalid resource manager ID %u at %X/%X",
B
Bruce Momjian 已提交
2965
						record->xl_rmid, RecPtr->xlogid, RecPtr->xrecoff)));
2966 2967
		goto next_record_is_invalid;
	}
2968 2969 2970
	if (randAccess)
	{
		/*
B
Bruce Momjian 已提交
2971 2972
		 * We can't exactly verify the prev-link, but surely it should be less
		 * than the record's own address.
2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985
		 */
		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 已提交
2986 2987 2988
		 * 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.
2989 2990 2991 2992 2993 2994 2995 2996 2997 2998
		 */
		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 已提交
2999

T
Tom Lane 已提交
3000
	/*
B
Bruce Momjian 已提交
3001
	 * Allocate or enlarge readRecordBuf as needed.  To avoid useless small
3002 3003 3004 3005
	 * 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 已提交
3006
	 */
3007
	total_len = record->xl_tot_len;
3008
	if (total_len > readRecordBufSize)
3009
	{
3010 3011
		uint32		newSize = total_len;

3012 3013
		newSize += XLOG_BLCKSZ - (newSize % XLOG_BLCKSZ);
		newSize = Max(newSize, 4 * Max(BLCKSZ, XLOG_BLCKSZ));
3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026
		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;
3027
	}
3028 3029

	buffer = readRecordBuf;
3030
	nextRecord = NULL;
3031
	len = XLOG_BLCKSZ - RecPtr->xrecoff % XLOG_BLCKSZ;
T
Tom Lane 已提交
3032
	if (total_len > len)
3033
	{
T
Tom Lane 已提交
3034 3035
		/* Need to reassemble record */
		XLogContRecord *contrecord;
B
Bruce Momjian 已提交
3036
		uint32		gotlen = len;
3037

T
Tom Lane 已提交
3038
		memcpy(buffer, record, len);
3039
		record = (XLogRecord *) buffer;
T
Tom Lane 已提交
3040
		buffer += len;
3041
		for (;;)
3042
		{
3043
			readOff += XLOG_BLCKSZ;
T
Tom Lane 已提交
3044
			if (readOff >= XLogSegSize)
3045 3046
			{
				close(readFile);
T
Tom Lane 已提交
3047 3048
				readFile = -1;
				NextLogSeg(readId, readSeg);
3049
				readFile = XLogFileRead(readId, readSeg, emode);
3050 3051
				if (readFile < 0)
					goto next_record_is_invalid;
T
Tom Lane 已提交
3052
				readOff = 0;
3053
			}
3054
			if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
T
Tom Lane 已提交
3055
			{
3056 3057
				ereport(emode,
						(errcode_for_file_access(),
T
Tom Lane 已提交
3058
						 errmsg("could not read from log file %u, segment %u, offset %u: %m",
3059
								readId, readSeg, readOff)));
T
Tom Lane 已提交
3060 3061
				goto next_record_is_invalid;
			}
3062
			if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
3063
				goto next_record_is_invalid;
T
Tom Lane 已提交
3064
			if (!(((XLogPageHeader) readBuf)->xlp_info & XLP_FIRST_IS_CONTRECORD))
3065
			{
3066 3067 3068
				ereport(emode,
						(errmsg("there is no contrecord flag in log file %u, segment %u, offset %u",
								readId, readSeg, readOff)));
3069 3070
				goto next_record_is_invalid;
			}
3071 3072
			pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
			contrecord = (XLogContRecord *) ((char *) readBuf + pageHeaderSize);
B
Bruce Momjian 已提交
3073
			if (contrecord->xl_rem_len == 0 ||
T
Tom Lane 已提交
3074
				total_len != (contrecord->xl_rem_len + gotlen))
3075
			{
3076 3077 3078 3079
				ereport(emode,
						(errmsg("invalid contrecord length %u in log file %u, segment %u, offset %u",
								contrecord->xl_rem_len,
								readId, readSeg, readOff)));
3080 3081
				goto next_record_is_invalid;
			}
3082
			len = XLOG_BLCKSZ - pageHeaderSize - SizeOfXLogContRecord;
T
Tom Lane 已提交
3083
			if (contrecord->xl_rem_len > len)
3084
			{
B
Bruce Momjian 已提交
3085
				memcpy(buffer, (char *) contrecord + SizeOfXLogContRecord, len);
T
Tom Lane 已提交
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095
				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;
3096
		pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
3097
		if (XLOG_BLCKSZ - SizeOfXLogRecord >= pageHeaderSize +
3098
			MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len))
T
Tom Lane 已提交
3099
		{
B
Bruce Momjian 已提交
3100
			nextRecord = (XLogRecord *) ((char *) contrecord +
B
Bruce Momjian 已提交
3101
					MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len));
T
Tom Lane 已提交
3102 3103 3104
		}
		EndRecPtr.xlogid = readId;
		EndRecPtr.xrecoff = readSeg * XLogSegSize + readOff +
3105 3106
			pageHeaderSize +
			MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len);
T
Tom Lane 已提交
3107
		ReadRecPtr = *RecPtr;
3108
		/* needn't worry about XLOG SWITCH, it can't cross page boundaries */
T
Tom Lane 已提交
3109
		return record;
3110 3111
	}

T
Tom Lane 已提交
3112 3113 3114
	/* Record does not cross a page boundary */
	if (!RecordIsValid(record, *RecPtr, emode))
		goto next_record_is_invalid;
3115
	if (XLOG_BLCKSZ - SizeOfXLogRecord >= RecPtr->xrecoff % XLOG_BLCKSZ +
T
Tom Lane 已提交
3116 3117 3118 3119 3120 3121
		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 已提交
3122

3123 3124 3125 3126 3127 3128 3129 3130 3131
	/*
	 * 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 已提交
3132

3133
		/*
B
Bruce Momjian 已提交
3134 3135 3136
		 * 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.
3137 3138 3139
		 */
		readOff = XLogSegSize - XLOG_BLCKSZ;
	}
T
Tom Lane 已提交
3140
	return (XLogRecord *) buffer;
3141

T
Tom Lane 已提交
3142 3143 3144 3145 3146
next_record_is_invalid:;
	close(readFile);
	readFile = -1;
	nextRecord = NULL;
	return NULL;
3147 3148
}

3149 3150 3151 3152
/*
 * 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 已提交
3153
 * ReadRecord.	It's not intended for use from anywhere else.
3154 3155
 */
static bool
3156
ValidXLOGHeader(XLogPageHeader hdr, int emode)
3157
{
3158 3159
	XLogRecPtr	recaddr;

3160 3161
	if (hdr->xlp_magic != XLOG_PAGE_MAGIC)
	{
3162 3163 3164
		ereport(emode,
				(errmsg("invalid magic number %04X in log file %u, segment %u, offset %u",
						hdr->xlp_magic, readId, readSeg, readOff)));
3165 3166 3167 3168
		return false;
	}
	if ((hdr->xlp_info & ~XLP_ALL_FLAGS) != 0)
	{
3169 3170 3171
		ereport(emode,
				(errmsg("invalid info bits %04X in log file %u, segment %u, offset %u",
						hdr->xlp_info, readId, readSeg, readOff)));
3172 3173
		return false;
	}
3174
	if (hdr->xlp_info & XLP_LONG_HEADER)
3175
	{
3176
		XLogLongPageHeader longhdr = (XLogLongPageHeader) hdr;
B
Bruce Momjian 已提交
3177

3178
		if (longhdr->xlp_sysid != ControlFile->system_identifier)
3179
		{
3180 3181
			char		fhdrident_str[32];
			char		sysident_str[32];
3182

3183
			/*
B
Bruce Momjian 已提交
3184 3185
			 * Format sysids separately to keep platform-dependent format code
			 * out of the translatable message string.
3186 3187 3188 3189 3190 3191 3192
			 */
			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 已提交
3193 3194
					 errdetail("WAL file SYSID is %s, pg_control SYSID is %s",
							   fhdrident_str, sysident_str)));
3195 3196 3197 3198 3199 3200
			return false;
		}
		if (longhdr->xlp_seg_size != XLogSegSize)
		{
			ereport(emode,
					(errmsg("WAL file is from different system"),
B
Bruce Momjian 已提交
3201
					 errdetail("Incorrect XLOG_SEG_SIZE in page header.")));
3202 3203
			return false;
		}
3204 3205 3206 3207 3208 3209 3210
		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;
		}
3211
	}
3212 3213 3214 3215 3216 3217 3218 3219 3220
	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;
	}

3221 3222 3223 3224 3225 3226
	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 已提交
3227
						hdr->xlp_pageaddr.xlogid, hdr->xlp_pageaddr.xrecoff,
3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248
						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 已提交
3249 3250 3251
	 * 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.
3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268
	 */
	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 已提交
3269
 * its ancestor TLIs).	If we can't find the history file, assume that the
3270 3271 3272 3273 3274 3275 3276 3277 3278 3279
 * 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 已提交
3280
	FILE	   *fd;
3281 3282 3283 3284

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, targetTLI);
3285
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3286 3287 3288 3289
	}
	else
		TLHistoryFilePath(path, targetTLI);

B
Bruce Momjian 已提交
3290
	fd = AllocateFile(path, "r");
3291 3292 3293 3294 3295
	if (fd == NULL)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3296
					 errmsg("could not open file \"%s\": %m", path)));
3297 3298 3299 3300 3301 3302
		/* Not there, so assume no parents */
		return list_make1_int((int) targetTLI);
	}

	result = NIL;

B
Bruce Momjian 已提交
3303 3304 3305
	/*
	 * Parse the file...
	 */
3306
	while (fgets(fline, sizeof(fline), fd) != NULL)
3307 3308
	{
		/* skip leading whitespace and check for # comment */
B
Bruce Momjian 已提交
3309 3310 3311
		char	   *ptr;
		char	   *endptr;
		TimeLineID	tli;
3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331

		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 已提交
3332
				   errhint("Timeline IDs must be in increasing sequence.")));
3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345

		/* 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 已提交
3346
			errhint("Timeline IDs must be less than child timeline's ID.")));
3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364

	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 已提交
3365
	FILE	   *fd;
3366 3367 3368 3369

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, probeTLI);
3370
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385
	}
	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 已提交
3386
					 errmsg("could not open file \"%s\": %m", path)));
3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404
		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 已提交
3405 3406
	 * The algorithm is just to probe for the existence of timeline history
	 * files.  XXX is it useful to allow gaps in the sequence?
3407 3408 3409
	 */
	newestTLI = startTLI;

B
Bruce Momjian 已提交
3410
	for (probeTLI = startTLI + 1;; probeTLI++)
3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433
	{
		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 已提交
3434
 * considerations.	But we should be just as tense as XLogFileInit to avoid
3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
 * 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 已提交
3450
	Assert(newTLI > parentTLI); /* else bad selection of newTLI */
3451 3452 3453 3454

	/*
	 * Write into a temp file name.
	 */
3455
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
3456 3457 3458 3459 3460 3461 3462

	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)
3463
		ereport(ERROR,
3464 3465 3466 3467 3468 3469 3470 3471 3472
				(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);
3473
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3474 3475 3476 3477 3478 3479 3480 3481
	}
	else
		TLHistoryFilePath(path, parentTLI);

	srcfd = BasicOpenFile(path, O_RDONLY, 0);
	if (srcfd < 0)
	{
		if (errno != ENOENT)
3482
			ereport(ERROR,
3483
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3484
					 errmsg("could not open file \"%s\": %m", path)));
3485 3486 3487 3488 3489 3490 3491 3492 3493
		/* Not there, so assume parent has no parents */
	}
	else
	{
		for (;;)
		{
			errno = 0;
			nbytes = (int) read(srcfd, buffer, sizeof(buffer));
			if (nbytes < 0 || errno != 0)
3494
				ereport(ERROR,
3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508
						(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 已提交
3509 3510

				/*
B
Bruce Momjian 已提交
3511
				 * if write didn't set errno, assume problem is no disk space
B
Bruce Momjian 已提交
3512
				 */
3513 3514
				errno = save_errno ? save_errno : ENOSPC;

3515
				ereport(ERROR,
3516
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
3517
					 errmsg("could not write to file \"%s\": %m", tmppath)));
3518 3519 3520 3521 3522 3523 3524 3525
			}
		}
		close(srcfd);
	}

	/*
	 * Append one line with the details of this timeline split.
	 *
B
Bruce Momjian 已提交
3526 3527
	 * If we did have a parent file, insert an extra newline just in case the
	 * parent file failed to end with one.
3528 3529 3530 3531 3532 3533 3534 3535 3536 3537
	 */
	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,
3538
			 timestamptz_to_str(recoveryStopTime));
3539 3540 3541 3542 3543 3544 3545 3546

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

		/*
B
Bruce Momjian 已提交
3547
		 * If we fail to make the file, delete it to release disk space
3548 3549 3550 3551 3552
		 */
		unlink(tmppath);
		/* if write didn't set errno, assume problem is no disk space */
		errno = save_errno ? save_errno : ENOSPC;

3553
		ereport(ERROR,
3554 3555 3556 3557 3558
				(errcode_for_file_access(),
				 errmsg("could not write to file \"%s\": %m", tmppath)));
	}

	if (pg_fsync(fd) != 0)
3559
		ereport(ERROR,
3560 3561 3562 3563
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

	if (close(fd))
3564
		ereport(ERROR,
3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580
				(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)
3581
		ereport(ERROR,
3582 3583 3584 3585 3586 3587
				(errcode_for_file_access(),
				 errmsg("could not link file \"%s\" to \"%s\": %m",
						tmppath, path)));
	unlink(tmppath);
#else
	if (rename(tmppath, path) < 0)
3588
		ereport(ERROR,
3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600
				(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
3601 3602
 *
 * *ControlFile is a buffer in shared memory that holds an image of the
B
Bruce Momjian 已提交
3603
 * contents of pg_control.	WriteControlFile() initializes pg_control
3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616
 * 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 已提交
3617
	char		buffer[PG_CONTROL_SIZE];		/* need not be aligned */
3618 3619 3620
	char	   *localeptr;

	/*
T
Tom Lane 已提交
3621
	 * Initialize version and compatibility-check fields
3622
	 */
T
Tom Lane 已提交
3623 3624
	ControlFile->pg_control_version = PG_CONTROL_VERSION;
	ControlFile->catalog_version_no = CATALOG_VERSION_NO;
3625 3626 3627 3628

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

3629 3630
	ControlFile->blcksz = BLCKSZ;
	ControlFile->relseg_size = RELSEG_SIZE;
3631
	ControlFile->xlog_blcksz = XLOG_BLCKSZ;
3632
	ControlFile->xlog_seg_size = XLOG_SEG_SIZE;
3633 3634

	ControlFile->nameDataLen = NAMEDATALEN;
3635
	ControlFile->indexMaxKeys = INDEX_MAX_KEYS;
3636

3637 3638
	ControlFile->toast_max_chunk_size = TOAST_MAX_CHUNK_SIZE;

3639 3640 3641 3642 3643 3644 3645
#ifdef HAVE_INT64_TIMESTAMP
	ControlFile->enableIntTimes = TRUE;
#else
	ControlFile->enableIntTimes = FALSE;
#endif

	ControlFile->localeBuflen = LOCALE_NAME_BUFLEN;
3646 3647
	localeptr = setlocale(LC_COLLATE, NULL);
	if (!localeptr)
3648 3649
		ereport(PANIC,
				(errmsg("invalid LC_COLLATE setting")));
3650 3651 3652
	StrNCpy(ControlFile->lc_collate, localeptr, LOCALE_NAME_BUFLEN);
	localeptr = setlocale(LC_CTYPE, NULL);
	if (!localeptr)
3653 3654
		ereport(PANIC,
				(errmsg("invalid LC_CTYPE setting")));
3655
	StrNCpy(ControlFile->lc_ctype, localeptr, LOCALE_NAME_BUFLEN);
B
Bruce Momjian 已提交
3656

T
Tom Lane 已提交
3657
	/* Contents are protected with a CRC */
3658 3659 3660 3661 3662
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
T
Tom Lane 已提交
3663

3664
	/*
3665 3666 3667 3668 3669
	 * 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".
3670
	 */
3671 3672
	if (sizeof(ControlFileData) > PG_CONTROL_SIZE)
		elog(PANIC, "sizeof(ControlFileData) is larger than PG_CONTROL_SIZE; fix either one");
3673

3674
	memset(buffer, 0, PG_CONTROL_SIZE);
3675 3676
	memcpy(buffer, ControlFile, sizeof(ControlFileData));

3677 3678
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
3679
					   S_IRUSR | S_IWUSR);
3680
	if (fd < 0)
3681 3682 3683
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not create control file \"%s\": %m",
3684
						XLOG_CONTROL_FILE)));
3685

3686
	errno = 0;
3687
	if (write(fd, buffer, PG_CONTROL_SIZE) != PG_CONTROL_SIZE)
3688 3689 3690 3691
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
3692 3693
		ereport(PANIC,
				(errcode_for_file_access(),
3694
				 errmsg("could not write to control file: %m")));
3695
	}
3696

3697
	if (pg_fsync(fd) != 0)
3698 3699
		ereport(PANIC,
				(errcode_for_file_access(),
3700
				 errmsg("could not fsync control file: %m")));
3701

3702 3703 3704 3705
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
3706 3707 3708 3709 3710
}

static void
ReadControlFile(void)
{
3711
	pg_crc32	crc;
3712 3713 3714 3715 3716
	int			fd;

	/*
	 * Read data...
	 */
3717 3718 3719
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | PG_BINARY,
					   S_IRUSR | S_IWUSR);
3720
	if (fd < 0)
3721 3722 3723
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not open control file \"%s\": %m",
3724
						XLOG_CONTROL_FILE)));
3725 3726

	if (read(fd, ControlFile, sizeof(ControlFileData)) != sizeof(ControlFileData))
3727 3728
		ereport(PANIC,
				(errcode_for_file_access(),
3729
				 errmsg("could not read from control file: %m")));
3730 3731 3732

	close(fd);

T
Tom Lane 已提交
3733
	/*
B
Bruce Momjian 已提交
3734 3735 3736 3737
	 * 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 已提交
3738 3739
	 */
	if (ControlFile->pg_control_version != PG_CONTROL_VERSION)
3740 3741 3742
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with PG_CONTROL_VERSION %d,"
B
Bruce Momjian 已提交
3743 3744
				  " but the server was compiled with PG_CONTROL_VERSION %d.",
						ControlFile->pg_control_version, PG_CONTROL_VERSION),
3745
				 errhint("It looks like you need to initdb.")));
T
Tom Lane 已提交
3746
	/* Now check the CRC. */
3747 3748 3749 3750 3751
	INIT_CRC32(crc);
	COMP_CRC32(crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(crc);
3752

3753
	if (!EQ_CRC32(crc, ControlFile->crc))
3754
		ereport(FATAL,
3755
				(errmsg("incorrect checksum in control file")));
3756

3757
	/*
B
Bruce Momjian 已提交
3758
	 * Do compatibility checking immediately.  We do this here for 2 reasons:
3759
	 *
3760 3761
	 * (1) if the database isn't compatible with the backend executable, we
	 * want to abort before we can possibly do any damage;
3762 3763
	 *
	 * (2) this code is executed in the postmaster, so the setlocale() will
B
Bruce Momjian 已提交
3764 3765
	 * propagate to forked backends, which aren't going to read this file for
	 * themselves.	(These locale settings are considered critical
3766 3767
	 * compatibility items because they can affect sort order of indexes.)
	 */
T
Tom Lane 已提交
3768
	if (ControlFile->catalog_version_no != CATALOG_VERSION_NO)
3769 3770 3771
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with CATALOG_VERSION_NO %d,"
B
Bruce Momjian 已提交
3772 3773
				  " but the server was compiled with CATALOG_VERSION_NO %d.",
						ControlFile->catalog_version_no, CATALOG_VERSION_NO),
3774
				 errhint("It looks like you need to initdb.")));
3775 3776 3777
	if (ControlFile->maxAlign != MAXIMUM_ALIGNOF)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3778 3779 3780 3781
		   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.")));
3782 3783 3784
	if (ControlFile->floatFormat != FLOATFORMAT_VALUE)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
P
Peter Eisentraut 已提交
3785
				 errdetail("The database cluster appears to use a different floating-point number format than the server executable."),
3786
				 errhint("It looks like you need to initdb.")));
3787
	if (ControlFile->blcksz != BLCKSZ)
3788 3789
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3790 3791 3792 3793
			 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.")));
3794
	if (ControlFile->relseg_size != RELSEG_SIZE)
3795 3796
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3797 3798 3799 3800
		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.")));
3801 3802 3803
	if (ControlFile->xlog_blcksz != XLOG_BLCKSZ)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3804 3805 3806
		errdetail("The database cluster was initialized with XLOG_BLCKSZ %d,"
				  " but the server was compiled with XLOG_BLCKSZ %d.",
				  ControlFile->xlog_blcksz, XLOG_BLCKSZ),
3807
				 errhint("It looks like you need to recompile or initdb.")));
3808 3809 3810 3811
	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 已提交
3812
					   " but the server was compiled with XLOG_SEG_SIZE %d.",
3813
						   ControlFile->xlog_seg_size, XLOG_SEG_SIZE),
B
Bruce Momjian 已提交
3814
				 errhint("It looks like you need to recompile or initdb.")));
3815
	if (ControlFile->nameDataLen != NAMEDATALEN)
3816 3817
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3818 3819 3820 3821
		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.")));
3822
	if (ControlFile->indexMaxKeys != INDEX_MAX_KEYS)
3823 3824
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
3825
				 errdetail("The database cluster was initialized with INDEX_MAX_KEYS %d,"
B
Bruce Momjian 已提交
3826
					  " but the server was compiled with INDEX_MAX_KEYS %d.",
3827
						   ControlFile->indexMaxKeys, INDEX_MAX_KEYS),
B
Bruce Momjian 已提交
3828
				 errhint("It looks like you need to recompile or initdb.")));
3829 3830 3831 3832 3833 3834 3835
	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.")));
3836 3837 3838

#ifdef HAVE_INT64_TIMESTAMP
	if (ControlFile->enableIntTimes != TRUE)
3839 3840 3841
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized without HAVE_INT64_TIMESTAMP"
B
Bruce Momjian 已提交
3842 3843
				  " but the server was compiled with HAVE_INT64_TIMESTAMP."),
				 errhint("It looks like you need to recompile or initdb.")));
3844 3845
#else
	if (ControlFile->enableIntTimes != FALSE)
3846 3847 3848
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with HAVE_INT64_TIMESTAMP"
B
Bruce Momjian 已提交
3849 3850
			   " but the server was compiled without HAVE_INT64_TIMESTAMP."),
				 errhint("It looks like you need to recompile or initdb.")));
3851 3852 3853
#endif

	if (ControlFile->localeBuflen != LOCALE_NAME_BUFLEN)
3854 3855 3856
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with LOCALE_NAME_BUFLEN %d,"
B
Bruce Momjian 已提交
3857
				  " but the server was compiled with LOCALE_NAME_BUFLEN %d.",
3858
						   ControlFile->localeBuflen, LOCALE_NAME_BUFLEN),
B
Bruce Momjian 已提交
3859
				 errhint("It looks like you need to recompile or initdb.")));
3860
	if (pg_perm_setlocale(LC_COLLATE, ControlFile->lc_collate) == NULL)
3861
		ereport(FATAL,
B
Bruce Momjian 已提交
3862 3863 3864 3865 3866
			(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.")));
3867
	if (pg_perm_setlocale(LC_CTYPE, ControlFile->lc_ctype) == NULL)
3868
		ereport(FATAL,
B
Bruce Momjian 已提交
3869 3870 3871 3872 3873
			(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.")));
3874 3875 3876 3877 3878 3879

	/* 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);
3880 3881
}

3882
void
3883
UpdateControlFile(void)
3884
{
3885
	int			fd;
3886

3887 3888 3889 3890 3891
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
3892

3893 3894 3895
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | PG_BINARY,
					   S_IRUSR | S_IWUSR);
3896
	if (fd < 0)
3897 3898 3899
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not open control file \"%s\": %m",
3900
						XLOG_CONTROL_FILE)));
3901

3902
	errno = 0;
3903
	if (write(fd, ControlFile, sizeof(ControlFileData)) != sizeof(ControlFileData))
3904 3905 3906 3907
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
3908 3909
		ereport(PANIC,
				(errcode_for_file_access(),
3910
				 errmsg("could not write to control file: %m")));
3911
	}
3912

3913
	if (pg_fsync(fd) != 0)
3914 3915
		ereport(PANIC,
				(errcode_for_file_access(),
3916
				 errmsg("could not fsync control file: %m")));
3917

3918 3919 3920 3921
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
3922 3923
}

3924
/*
T
Tom Lane 已提交
3925
 * Initialization of shared memory for XLOG
3926
 */
3927
Size
3928
XLOGShmemSize(void)
3929
{
3930
	Size		size;
3931

3932 3933 3934 3935 3936 3937 3938
	/* 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 */
3939
	size = add_size(size, mul_size(XLOG_BLCKSZ, XLOGbuffers));
3940 3941

	/*
B
Bruce Momjian 已提交
3942 3943 3944
	 * 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.
3945 3946 3947
	 */

	return size;
3948 3949 3950 3951 3952
}

void
XLOGShmemInit(void)
{
3953 3954
	bool		foundCFile,
				foundXLog;
3955
	char	   *allocptr;
3956

3957
	ControlFile = (ControlFileData *)
3958
		ShmemInitStruct("Control File", sizeof(ControlFileData), &foundCFile);
3959 3960
	XLogCtl = (XLogCtlData *)
		ShmemInitStruct("XLOG Ctl", XLOGShmemSize(), &foundXLog);
3961

3962
	if (foundCFile || foundXLog)
3963 3964
	{
		/* both should be present or neither */
3965
		Assert(foundCFile && foundXLog);
3966 3967
		return;
	}
3968

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

T
Tom Lane 已提交
3971
	/*
B
Bruce Momjian 已提交
3972 3973 3974
	 * 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 已提交
3975
	 */
3976 3977
	allocptr = ((char *) XLogCtl) + sizeof(XLogCtlData);
	XLogCtl->xlblocks = (XLogRecPtr *) allocptr;
T
Tom Lane 已提交
3978
	memset(XLogCtl->xlblocks, 0, sizeof(XLogRecPtr) * XLOGbuffers);
3979
	allocptr += sizeof(XLogRecPtr) * XLOGbuffers;
B
Bruce Momjian 已提交
3980

T
Tom Lane 已提交
3981
	/*
3982
	 * Align the start of the page buffers to an ALIGNOF_XLOG_BUFFER boundary.
T
Tom Lane 已提交
3983
	 */
3984 3985
	allocptr = (char *) TYPEALIGN(ALIGNOF_XLOG_BUFFER, allocptr);
	XLogCtl->pages = allocptr;
3986
	memset(XLogCtl->pages, 0, (Size) XLOG_BLCKSZ * XLOGbuffers);
T
Tom Lane 已提交
3987 3988

	/*
B
Bruce Momjian 已提交
3989 3990
	 * Do basic initialization of XLogCtl shared data. (StartupXLOG will fill
	 * in additional info.)
T
Tom Lane 已提交
3991
	 */
B
Bruce Momjian 已提交
3992
	XLogCtl->XLogCacheByte = (Size) XLOG_BLCKSZ *XLOGbuffers;
B
Bruce Momjian 已提交
3993

T
Tom Lane 已提交
3994 3995
	XLogCtl->XLogCacheBlck = XLOGbuffers - 1;
	XLogCtl->Insert.currpage = (XLogPageHeader) (XLogCtl->pages);
3996
	SpinLockInit(&XLogCtl->info_lck);
T
Tom Lane 已提交
3997

3998
	/*
B
Bruce Momjian 已提交
3999 4000 4001
	 * 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).
4002 4003 4004
	 */
	if (!IsBootstrapProcessingMode())
		ReadControlFile();
4005 4006 4007
}

/*
T
Tom Lane 已提交
4008 4009
 * This func must be called ONCE on system install.  It creates pg_control
 * and the initial XLOG segment.
4010 4011
 */
void
T
Tom Lane 已提交
4012
BootStrapXLOG(void)
4013
{
4014
	CheckPoint	checkPoint;
T
Tom Lane 已提交
4015 4016
	char	   *buffer;
	XLogPageHeader page;
4017
	XLogLongPageHeader longpage;
4018
	XLogRecord *record;
B
Bruce Momjian 已提交
4019
	bool		use_existent;
4020 4021
	uint64		sysidentifier;
	struct timeval tv;
4022
	pg_crc32	crc;
4023

4024
	/*
B
Bruce Momjian 已提交
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034
	 * 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.
4035 4036 4037 4038 4039
	 */
	gettimeofday(&tv, NULL);
	sysidentifier = ((uint64) tv.tv_sec) << 32;
	sysidentifier |= (uint32) (tv.tv_sec | tv.tv_usec);

4040 4041 4042
	/* First timeline ID is always 1 */
	ThisTimeLineID = 1;

4043
	/* page buffer must be aligned suitably for O_DIRECT */
4044
	buffer = (char *) palloc(XLOG_BLCKSZ + ALIGNOF_XLOG_BUFFER);
4045
	page = (XLogPageHeader) TYPEALIGN(ALIGNOF_XLOG_BUFFER, buffer);
4046
	memset(page, 0, XLOG_BLCKSZ);
T
Tom Lane 已提交
4047

4048
	/* Set up information for the initial checkpoint record */
4049
	checkPoint.redo.xlogid = 0;
4050 4051
	checkPoint.redo.xrecoff = SizeOfXLogLongPHD;
	checkPoint.ThisTimeLineID = ThisTimeLineID;
4052
	checkPoint.nextXidEpoch = 0;
4053
	checkPoint.nextXid = FirstNormalTransactionId;
4054
	checkPoint.nextOid = FirstBootstrapObjectId;
4055
	checkPoint.nextMulti = FirstMultiXactId;
4056
	checkPoint.nextMultiOffset = 0;
T
Tom Lane 已提交
4057
	checkPoint.time = time(NULL);
4058

4059 4060 4061
	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
	ShmemVariableCache->oidCount = 0;
4062
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
4063

4064
	/* Set up the XLOG page header */
4065
	page->xlp_magic = XLOG_PAGE_MAGIC;
4066 4067
	page->xlp_info = XLP_LONG_HEADER;
	page->xlp_tli = ThisTimeLineID;
4068 4069
	page->xlp_pageaddr.xlogid = 0;
	page->xlp_pageaddr.xrecoff = 0;
4070 4071 4072
	longpage = (XLogLongPageHeader) page;
	longpage->xlp_sysid = sysidentifier;
	longpage->xlp_seg_size = XLogSegSize;
4073
	longpage->xlp_xlog_blcksz = XLOG_BLCKSZ;
4074 4075

	/* Insert the initial checkpoint record */
4076
	record = (XLogRecord *) ((char *) page + SizeOfXLogLongPHD);
4077
	record->xl_prev.xlogid = 0;
4078
	record->xl_prev.xrecoff = 0;
4079
	record->xl_xid = InvalidTransactionId;
4080
	record->xl_tot_len = SizeOfXLogRecord + sizeof(checkPoint);
4081
	record->xl_len = sizeof(checkPoint);
T
Tom Lane 已提交
4082
	record->xl_info = XLOG_CHECKPOINT_SHUTDOWN;
4083
	record->xl_rmid = RM_XLOG_ID;
T
Tom Lane 已提交
4084
	memcpy(XLogRecGetData(record), &checkPoint, sizeof(checkPoint));
4085

4086 4087 4088 4089 4090
	INIT_CRC32(crc);
	COMP_CRC32(crc, &checkPoint, sizeof(checkPoint));
	COMP_CRC32(crc, (char *) record + sizeof(pg_crc32),
			   SizeOfXLogRecord - sizeof(pg_crc32));
	FIN_CRC32(crc);
4091 4092
	record->xl_crc = crc;

4093
	/* Create first XLOG segment file */
4094 4095
	use_existent = false;
	openLogFile = XLogFileInit(0, 0, &use_existent, false);
4096

4097
	/* Write the first page with the initial record */
4098
	errno = 0;
4099
	if (write(openLogFile, page, XLOG_BLCKSZ) != XLOG_BLCKSZ)
4100 4101 4102 4103
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
4104 4105
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4106
			  errmsg("could not write bootstrap transaction log file: %m")));
4107
	}
4108

T
Tom Lane 已提交
4109
	if (pg_fsync(openLogFile) != 0)
4110 4111
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4112
			  errmsg("could not fsync bootstrap transaction log file: %m")));
4113

4114 4115 4116
	if (close(openLogFile))
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4117
			  errmsg("could not close bootstrap transaction log file: %m")));
4118

T
Tom Lane 已提交
4119
	openLogFile = -1;
4120

4121 4122
	/* Now create pg_control */

4123
	memset(ControlFile, 0, sizeof(ControlFileData));
T
Tom Lane 已提交
4124
	/* Initialize pg_control status fields */
4125
	ControlFile->system_identifier = sysidentifier;
T
Tom Lane 已提交
4126 4127
	ControlFile->state = DB_SHUTDOWNED;
	ControlFile->time = checkPoint.time;
4128
	ControlFile->checkPoint = checkPoint.redo;
T
Tom Lane 已提交
4129
	ControlFile->checkPointCopy = checkPoint;
4130
	/* some additional ControlFile fields are set in WriteControlFile() */
4131

4132
	WriteControlFile();
4133 4134 4135

	/* Bootstrap the commit log, too */
	BootStrapCLOG();
4136
	BootStrapSUBTRANS();
4137
	BootStrapMultiXact();
4138

4139
	pfree(buffer);
4140 4141
}

4142
static char *
4143 4144
str_time(time_t tnow)
{
4145
	static char buf[128];
4146

4147
	strftime(buf, sizeof(buf),
T
Tom Lane 已提交
4148
			 "%Y-%m-%d %H:%M:%S %Z",
4149
			 localtime(&tnow));
4150

4151
	return buf;
4152 4153
}

4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164
/*
 * 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 已提交
4165 4166 4167 4168 4169 4170
	FILE	   *fd;
	char		cmdline[MAXPGPATH];
	TimeLineID	rtli = 0;
	bool		rtliGiven = false;
	bool		syntaxError = false;

4171
	fd = AllocateFile(RECOVERY_COMMAND_FILE, "r");
4172 4173 4174 4175 4176
	if (fd == NULL)
	{
		if (errno == ENOENT)
			return;				/* not there, so no archive recovery */
		ereport(FATAL,
B
Bruce Momjian 已提交
4177
				(errcode_for_file_access(),
4178
				 errmsg("could not open recovery command file \"%s\": %m",
4179
						RECOVERY_COMMAND_FILE)));
4180 4181 4182
	}

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

B
Bruce Momjian 已提交
4185 4186 4187
	/*
	 * Parse the file...
	 */
4188
	while (fgets(cmdline, sizeof(cmdline), fd) != NULL)
4189 4190
	{
		/* skip leading whitespace and check for # comment */
B
Bruce Momjian 已提交
4191 4192 4193
		char	   *ptr;
		char	   *tok1;
		char	   *tok2;
4194 4195 4196 4197 4198 4199 4200 4201 4202 4203

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

		/* identify the quoted parameter value */
B
Bruce Momjian 已提交
4204
		tok1 = strtok(ptr, "'");
4205 4206 4207 4208 4209
		if (!tok1)
		{
			syntaxError = true;
			break;
		}
B
Bruce Momjian 已提交
4210
		tok2 = strtok(NULL, "'");
4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223
		if (!tok2)
		{
			syntaxError = true;
			break;
		}
		/* reparse to get just the parameter name */
		tok1 = strtok(ptr, " \t=");
		if (!tok1)
		{
			syntaxError = true;
			break;
		}

B
Bruce Momjian 已提交
4224 4225
		if (strcmp(tok1, "restore_command") == 0)
		{
4226
			recoveryRestoreCommand = pstrdup(tok2);
4227 4228 4229 4230
			ereport(LOG,
					(errmsg("restore_command = \"%s\"",
							recoveryRestoreCommand)));
		}
B
Bruce Momjian 已提交
4231 4232
		else if (strcmp(tok1, "recovery_target_timeline") == 0)
		{
4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251
			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 已提交
4252 4253
		else if (strcmp(tok1, "recovery_target_xid") == 0)
		{
4254 4255 4256 4257
			errno = 0;
			recoveryTargetXid = (TransactionId) strtoul(tok2, NULL, 0);
			if (errno == EINVAL || errno == ERANGE)
				ereport(FATAL,
B
Bruce Momjian 已提交
4258 4259
				 (errmsg("recovery_target_xid is not a valid number: \"%s\"",
						 tok2)));
4260 4261 4262 4263 4264 4265
			ereport(LOG,
					(errmsg("recovery_target_xid = %u",
							recoveryTargetXid)));
			recoveryTarget = true;
			recoveryTargetExact = true;
		}
B
Bruce Momjian 已提交
4266 4267
		else if (strcmp(tok1, "recovery_target_time") == 0)
		{
4268 4269 4270 4271 4272 4273 4274 4275
			/*
			 * if recovery_target_xid specified, then this overrides
			 * recovery_target_time
			 */
			if (recoveryTargetExact)
				continue;
			recoveryTarget = true;
			recoveryTargetExact = false;
B
Bruce Momjian 已提交
4276

4277
			/*
4278
			 * Convert the time string given by the user to TimestampTz form.
4279
			 */
4280 4281 4282 4283 4284
			recoveryTargetTime =
				DatumGetTimestampTz(DirectFunctionCall3(timestamptz_in,
												   CStringGetDatum(tok2),
												ObjectIdGetDatum(InvalidOid),
														Int32GetDatum(-1)));
4285 4286
			ereport(LOG,
					(errmsg("recovery_target_time = %s",
4287
							timestamptz_to_str(recoveryTargetTime))));
4288
		}
B
Bruce Momjian 已提交
4289 4290
		else if (strcmp(tok1, "recovery_target_inclusive") == 0)
		{
4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311
			/*
			 * 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 已提交
4312 4313
	if (syntaxError)
		ereport(FATAL,
4314 4315
				(errmsg("syntax error in recovery command file: %s",
						cmdline),
B
Bruce Momjian 已提交
4316
			  errhint("Lines should have the format parameter = 'value'.")));
4317 4318

	/* Check that required parameters were supplied */
4319
	if (recoveryRestoreCommand == NULL)
4320 4321
		ereport(FATAL,
				(errmsg("recovery command file \"%s\" did not specify restore_command",
4322
						RECOVERY_COMMAND_FILE)));
4323

4324 4325 4326
	/* Enable fetching from archive recovery area */
	InArchiveRecovery = true;

4327
	/*
B
Bruce Momjian 已提交
4328 4329 4330 4331
	 * 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.
4332
	 */
4333 4334 4335 4336 4337 4338 4339
	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 已提交
4340 4341
						(errmsg("recovery_target_timeline %u does not exist",
								rtli)));
4342 4343 4344 4345 4346 4347 4348 4349
			recoveryTargetTLI = rtli;
		}
		else
		{
			/* We start the "latest" search from pg_control's timeline */
			recoveryTargetTLI = findNewestTimeLine(recoveryTargetTLI);
		}
	}
4350 4351 4352 4353 4354 4355
}

/*
 * Exit archive-recovery state
 */
static void
4356
exitArchiveRecovery(TimeLineID endTLI, uint32 endLogId, uint32 endLogSeg)
4357
{
B
Bruce Momjian 已提交
4358 4359
	char		recoveryPath[MAXPGPATH];
	char		xlogpath[MAXPGPATH];
4360 4361

	/*
4362
	 * We are no longer in archive recovery state.
4363 4364 4365 4366
	 */
	InArchiveRecovery = false;

	/*
B
Bruce Momjian 已提交
4367 4368 4369
	 * 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).
4370 4371 4372 4373 4374 4375 4376 4377 4378
	 */
	Assert(readFile >= 0);
	Assert(readId == endLogId);
	Assert(readSeg == endLogSeg);

	close(readFile);
	readFile = -1;

	/*
B
Bruce Momjian 已提交
4379 4380 4381 4382 4383 4384 4385
	 * 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.
4386
	 *
4387 4388 4389
	 * 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.
4390
	 */
4391
	snprintf(recoveryPath, MAXPGPATH, XLOGDIR "/RECOVERYXLOG");
4392
	XLogFilePath(xlogpath, ThisTimeLineID, endLogId, endLogSeg);
4393 4394 4395 4396 4397 4398 4399 4400 4401 4402

	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(),
4403
					 errmsg("could not rename file \"%s\" to \"%s\": %m",
4404 4405 4406 4407 4408 4409 4410 4411 4412 4413
							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 已提交
4414

4415
		/*
B
Bruce Momjian 已提交
4416 4417 4418
		 * 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.
4419 4420 4421 4422
		 */
		if (endTLI != ThisTimeLineID)
			XLogFileCopy(endLogId, endLogSeg,
						 endTLI, endLogId, endLogSeg);
4423 4424 4425
	}

	/*
B
Bruce Momjian 已提交
4426 4427
	 * Let's just make real sure there are not .ready or .done flags posted
	 * for the new segment.
4428
	 */
4429 4430
	XLogFileName(xlogpath, ThisTimeLineID, endLogId, endLogSeg);
	XLogArchiveCleanup(xlogpath);
4431

4432
	/* Get rid of any remaining recovered timeline-history file, too */
4433
	snprintf(recoveryPath, MAXPGPATH, XLOGDIR "/RECOVERYHISTORY");
B
Bruce Momjian 已提交
4434
	unlink(recoveryPath);		/* ignore any error */
4435 4436

	/*
B
Bruce Momjian 已提交
4437 4438
	 * Rename the config file out of the way, so that we don't accidentally
	 * re-enter archive recovery mode in a subsequent crash.
4439
	 */
4440 4441
	unlink(RECOVERY_COMMAND_DONE);
	if (rename(RECOVERY_COMMAND_FILE, RECOVERY_COMMAND_DONE) != 0)
4442 4443
		ereport(FATAL,
				(errcode_for_file_access(),
4444
				 errmsg("could not rename file \"%s\" to \"%s\": %m",
4445
						RECOVERY_COMMAND_FILE, RECOVERY_COMMAND_DONE)));
4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456

	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.
4457 4458
 * Also, some information is saved in recoveryStopXid et al for use in
 * annotating the new timeline's history file.
4459 4460 4461 4462 4463
 */
static bool
recoveryStopsHere(XLogRecord *record, bool *includeThis)
{
	bool		stopsHere;
B
Bruce Momjian 已提交
4464
	uint8		record_info;
4465
	TimestampTz	recordXtime;
4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476

	/* 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 已提交
4477
		xl_xact_commit *recordXactCommitData;
4478 4479

		recordXactCommitData = (xl_xact_commit *) XLogRecGetData(record);
4480
		recordXtime = recordXactCommitData->xact_time;
4481 4482 4483
	}
	else if (record_info == XLOG_XACT_ABORT)
	{
B
Bruce Momjian 已提交
4484
		xl_xact_abort *recordXactAbortData;
4485 4486

		recordXactAbortData = (xl_xact_abort *) XLogRecGetData(record);
4487
		recordXtime = recordXactAbortData->xact_time;
4488 4489 4490 4491 4492 4493 4494
	}
	else
		return false;

	if (recoveryTargetExact)
	{
		/*
B
Bruce Momjian 已提交
4495 4496
		 * there can be only one transaction end record with this exact
		 * transactionid
4497
		 *
B
Bruce Momjian 已提交
4498
		 * when testing for an xid, we MUST test for equality only, since
B
Bruce Momjian 已提交
4499 4500 4501
		 * 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...
4502 4503 4504 4505 4506 4507 4508 4509
		 */
		stopsHere = (record->xl_xid == recoveryTargetXid);
		if (stopsHere)
			*includeThis = recoveryTargetInclusive;
	}
	else
	{
		/*
B
Bruce Momjian 已提交
4510 4511 4512
		 * 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
4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523
		 */
		if (recoveryTargetInclusive)
			stopsHere = (recordXtime > recoveryTargetTime);
		else
			stopsHere = (recordXtime >= recoveryTargetTime);
		if (stopsHere)
			*includeThis = false;
	}

	if (stopsHere)
	{
4524 4525 4526 4527
		recoveryStopXid = record->xl_xid;
		recoveryStopTime = recordXtime;
		recoveryStopAfter = *includeThis;

4528 4529
		if (record_info == XLOG_XACT_COMMIT)
		{
4530
			if (recoveryStopAfter)
4531 4532
				ereport(LOG,
						(errmsg("recovery stopping after commit of transaction %u, time %s",
4533 4534
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4535 4536 4537
			else
				ereport(LOG,
						(errmsg("recovery stopping before commit of transaction %u, time %s",
4538 4539
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4540 4541 4542
		}
		else
		{
4543
			if (recoveryStopAfter)
4544 4545
				ereport(LOG,
						(errmsg("recovery stopping after abort of transaction %u, time %s",
4546 4547
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4548 4549 4550
			else
				ereport(LOG,
						(errmsg("recovery stopping before abort of transaction %u, time %s",
4551 4552
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4553 4554 4555 4556 4557 4558
		}
	}

	return stopsHere;
}

4559
/*
T
Tom Lane 已提交
4560
 * This must be called ONCE during postmaster or standalone-backend startup
4561 4562
 */
void
T
Tom Lane 已提交
4563
StartupXLOG(void)
4564
{
4565 4566
	XLogCtlInsert *Insert;
	CheckPoint	checkPoint;
T
Tom Lane 已提交
4567
	bool		wasShutdown;
4568
	bool		needNewTimeLine = false;
4569
	bool		haveBackupLabel = false;
4570
	XLogRecPtr	RecPtr,
T
Tom Lane 已提交
4571 4572
				LastRec,
				checkPointLoc,
4573
				minRecoveryLoc,
T
Tom Lane 已提交
4574
				EndOfLog;
4575 4576
	uint32		endLogId;
	uint32		endLogSeg;
4577
	XLogRecord *record;
4578
	uint32		freespace;
4579
	TransactionId oldestActiveXID;
4580

4581
	/*
4582 4583
	 * Read control file and check XLOG status looks valid.
	 *
4584 4585
	 * 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.
4586
	 */
4587
	ReadControlFile();
4588

4589
	if (ControlFile->state < DB_SHUTDOWNED ||
4590
		ControlFile->state > DB_IN_PRODUCTION ||
4591
		!XRecOffIsValid(ControlFile->checkPoint.xrecoff))
4592 4593
		ereport(FATAL,
				(errmsg("control file contains invalid data")));
4594 4595

	if (ControlFile->state == DB_SHUTDOWNED)
4596 4597 4598
		ereport(LOG,
				(errmsg("database system was shut down at %s",
						str_time(ControlFile->time))));
4599
	else if (ControlFile->state == DB_SHUTDOWNING)
4600
		ereport(LOG,
4601
				(errmsg("database system shutdown was interrupted; last known up at %s",
4602
						str_time(ControlFile->time))));
4603
	else if (ControlFile->state == DB_IN_CRASH_RECOVERY)
4604
		ereport(LOG,
B
Bruce Momjian 已提交
4605 4606 4607 4608
		   (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.")));
4609 4610
	else if (ControlFile->state == DB_IN_ARCHIVE_RECOVERY)
		ereport(LOG,
B
Bruce Momjian 已提交
4611 4612
				(errmsg("database system was interrupted while in recovery at log time %s",
						str_time(ControlFile->checkPointCopy.time)),
4613 4614
				 errhint("If this has occurred more than once some data might be corrupted"
				" and you might need to choose an earlier recovery target.")));
4615
	else if (ControlFile->state == DB_IN_PRODUCTION)
4616
		ereport(LOG,
4617
				(errmsg("database system was interrupted; last known up at %s",
4618
						str_time(ControlFile->time))));
4619

4620 4621
	/* This is just to allow attaching to startup process with a debugger */
#ifdef XLOG_REPLAY_DELAY
4622
	if (ControlFile->state != DB_SHUTDOWNED)
4623
		pg_usleep(60000000L);
4624 4625
#endif

4626
	/*
B
Bruce Momjian 已提交
4627 4628
	 * Initialize on the assumption we want to recover to the same timeline
	 * that's active according to pg_control.
4629 4630 4631
	 */
	recoveryTargetTLI = ControlFile->checkPointCopy.ThisTimeLineID;

4632
	/*
B
Bruce Momjian 已提交
4633 4634
	 * Check for recovery control file, and if so set up state for offline
	 * recovery
4635 4636 4637
	 */
	readRecoveryCommandFile();

4638 4639 4640
	/* Now we can determine the list of expected TLIs */
	expectedTLIs = readTimeLineHistory(recoveryTargetTLI);

4641 4642 4643 4644 4645 4646
	/*
	 * 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 已提交
4647
						 (int) ControlFile->checkPointCopy.ThisTimeLineID))
4648 4649 4650 4651 4652
		ereport(FATAL,
				(errmsg("requested timeline %u is not a child of database system timeline %u",
						recoveryTargetTLI,
						ControlFile->checkPointCopy.ThisTimeLineID)));

4653
	if (read_backup_label(&checkPointLoc, &minRecoveryLoc))
T
Tom Lane 已提交
4654
	{
4655
		/*
B
Bruce Momjian 已提交
4656 4657
		 * When a backup_label file is present, we want to roll forward from
		 * the checkpoint it identifies, rather than using pg_control.
4658
		 */
4659
		record = ReadCheckpointRecord(checkPointLoc, 0);
4660 4661 4662 4663
		if (record != NULL)
		{
			ereport(LOG,
					(errmsg("checkpoint record is at %X/%X",
B
Bruce Momjian 已提交
4664
							checkPointLoc.xlogid, checkPointLoc.xrecoff)));
4665 4666 4667 4668 4669
			InRecovery = true;	/* force recovery even if SHUTDOWNED */
		}
		else
		{
			ereport(PANIC,
B
Bruce Momjian 已提交
4670 4671
					(errmsg("could not locate required checkpoint record"),
					 errhint("If you are not restoring from a backup, try removing the file \"%s/backup_label\".", DataDir)));
4672
		}
4673 4674
		/* set flag to delete it later */
		haveBackupLabel = true;
T
Tom Lane 已提交
4675 4676 4677
	}
	else
	{
4678
		/*
B
Bruce Momjian 已提交
4679 4680
		 * Get the last valid checkpoint record.  If the latest one according
		 * to pg_control is broken, try the next-to-last one.
4681 4682
		 */
		checkPointLoc = ControlFile->checkPoint;
4683
		record = ReadCheckpointRecord(checkPointLoc, 1);
T
Tom Lane 已提交
4684 4685
		if (record != NULL)
		{
4686
			ereport(LOG,
4687
					(errmsg("checkpoint record is at %X/%X",
B
Bruce Momjian 已提交
4688
							checkPointLoc.xlogid, checkPointLoc.xrecoff)));
T
Tom Lane 已提交
4689 4690
		}
		else
4691 4692
		{
			checkPointLoc = ControlFile->prevCheckPoint;
4693
			record = ReadCheckpointRecord(checkPointLoc, 2);
4694 4695 4696
			if (record != NULL)
			{
				ereport(LOG,
B
Bruce Momjian 已提交
4697 4698 4699
						(errmsg("using previous checkpoint record at %X/%X",
							  checkPointLoc.xlogid, checkPointLoc.xrecoff)));
				InRecovery = true;		/* force recovery even if SHUTDOWNED */
4700 4701 4702
			}
			else
				ereport(PANIC,
B
Bruce Momjian 已提交
4703
					 (errmsg("could not locate a valid checkpoint record")));
4704
		}
T
Tom Lane 已提交
4705
	}
4706

T
Tom Lane 已提交
4707 4708 4709
	LastRec = RecPtr = checkPointLoc;
	memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
	wasShutdown = (record->xl_info == XLOG_CHECKPOINT_SHUTDOWN);
4710

4711
	ereport(LOG,
4712
	 (errmsg("redo record is at %X/%X; shutdown %s",
B
Bruce Momjian 已提交
4713 4714
			 checkPoint.redo.xlogid, checkPoint.redo.xrecoff,
			 wasShutdown ? "TRUE" : "FALSE")));
4715
	ereport(LOG,
4716 4717 4718
			(errmsg("next transaction ID: %u/%u; next OID: %u",
					checkPoint.nextXidEpoch, checkPoint.nextXid,
					checkPoint.nextOid)));
4719 4720 4721
	ereport(LOG,
			(errmsg("next MultiXactId: %u; next MultiXactOffset: %u",
					checkPoint.nextMulti, checkPoint.nextMultiOffset)));
4722
	if (!TransactionIdIsNormal(checkPoint.nextXid))
4723
		ereport(PANIC,
4724
				(errmsg("invalid next transaction ID")));
4725 4726 4727

	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
4728
	ShmemVariableCache->oidCount = 0;
4729
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
4730

4731
	/*
B
Bruce Momjian 已提交
4732 4733 4734
	 * 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()).
4735
	 */
4736
	ThisTimeLineID = checkPoint.ThisTimeLineID;
4737

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

4740
	if (XLByteLT(RecPtr, checkPoint.redo))
4741 4742
		ereport(PANIC,
				(errmsg("invalid redo in checkpoint record")));
4743

4744
	/*
B
Bruce Momjian 已提交
4745
	 * Check whether we need to force recovery from WAL.  If it appears to
B
Bruce Momjian 已提交
4746 4747
	 * have been a clean shutdown and we did not have a recovery.conf file,
	 * then assume no recovery needed.
4748
	 */
4749
	if (XLByteLT(checkPoint.redo, RecPtr))
4750
	{
T
Tom Lane 已提交
4751
		if (wasShutdown)
4752
			ereport(PANIC,
4753
				(errmsg("invalid redo record in shutdown checkpoint")));
V
WAL  
Vadim B. Mikheev 已提交
4754
		InRecovery = true;
4755 4756
	}
	else if (ControlFile->state != DB_SHUTDOWNED)
V
WAL  
Vadim B. Mikheev 已提交
4757
		InRecovery = true;
4758 4759 4760 4761 4762
	else if (InArchiveRecovery)
	{
		/* force recovery due to presence of recovery.conf */
		InRecovery = true;
	}
4763

V
WAL  
Vadim B. Mikheev 已提交
4764
	/* REDO */
4765
	if (InRecovery)
4766
	{
B
Bruce Momjian 已提交
4767
		int			rmid;
4768

4769
		/*
B
Bruce Momjian 已提交
4770 4771 4772 4773
		 * 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.
4774
		 */
4775
		if (InArchiveRecovery)
4776
		{
4777
			ereport(LOG,
4778
					(errmsg("automatic recovery in progress")));
4779 4780
			ControlFile->state = DB_IN_ARCHIVE_RECOVERY;
		}
4781
		else
4782
		{
4783
			ereport(LOG,
4784 4785
					(errmsg("database system was not properly shut down; "
							"automatic recovery in progress")));
4786 4787 4788 4789 4790 4791 4792
			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;
4793 4794 4795
		ControlFile->time = time(NULL);
		UpdateControlFile();

4796
		/*
B
Bruce Momjian 已提交
4797 4798 4799 4800 4801 4802
		 * 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.
4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813
		 */
		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)));
		}

4814
		/* Start up the recovery environment */
V
WAL  
Vadim B. Mikheev 已提交
4815
		XLogInitRelationCache();
V
Vadim B. Mikheev 已提交
4816

4817 4818 4819 4820 4821 4822
		for (rmid = 0; rmid <= RM_MAX_ID; rmid++)
		{
			if (RmgrTable[rmid].rm_startup != NULL)
				RmgrTable[rmid].rm_startup();
		}

4823
		/*
B
Bruce Momjian 已提交
4824 4825
		 * Find the first record that logically follows the checkpoint --- it
		 * might physically precede it, though.
4826
		 */
4827
		if (XLByteLT(checkPoint.redo, RecPtr))
4828 4829
		{
			/* back up to find the record */
4830
			record = ReadRecord(&(checkPoint.redo), PANIC);
4831
		}
B
Bruce Momjian 已提交
4832
		else
4833
		{
4834
			/* just have to read next record after CheckPoint */
4835
			record = ReadRecord(NULL, LOG);
4836
		}
4837

T
Tom Lane 已提交
4838
		if (record != NULL)
4839
		{
4840 4841
			bool		recoveryContinue = true;
			bool		recoveryApply = true;
B
Bruce Momjian 已提交
4842
			ErrorContextCallback errcontext;
4843

V
WAL  
Vadim B. Mikheev 已提交
4844
			InRedo = true;
4845 4846 4847
			ereport(LOG,
					(errmsg("redo starts at %X/%X",
							ReadRecPtr.xlogid, ReadRecPtr.xrecoff)));
4848 4849 4850 4851

			/*
			 * main redo apply loop
			 */
4852 4853
			do
			{
4854
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
4855 4856
				if (XLOG_DEBUG)
				{
B
Bruce Momjian 已提交
4857
					StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
4858

4859 4860
					initStringInfo(&buf);
					appendStringInfo(&buf, "REDO @ %X/%X; LSN %X/%X: ",
B
Bruce Momjian 已提交
4861 4862
									 ReadRecPtr.xlogid, ReadRecPtr.xrecoff,
									 EndRecPtr.xlogid, EndRecPtr.xrecoff);
4863 4864 4865 4866
					xlog_outrec(&buf, record);
					appendStringInfo(&buf, " - ");
					RmgrTable[record->xl_rmid].rm_desc(&buf,
													   record->xl_info,
B
Bruce Momjian 已提交
4867
													 XLogRecGetData(record));
4868 4869
					elog(LOG, "%s", buf.data);
					pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
4870
				}
4871
#endif
V
WAL  
Vadim B. Mikheev 已提交
4872

4873 4874 4875 4876 4877
				/*
				 * Have we reached our recovery target?
				 */
				if (recoveryStopsHere(record, &recoveryApply))
				{
B
Bruce Momjian 已提交
4878
					needNewTimeLine = true;		/* see below */
4879 4880 4881 4882 4883
					recoveryContinue = false;
					if (!recoveryApply)
						break;
				}

4884 4885 4886 4887 4888 4889
				/* 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;

4890 4891
				/* nextXid must be beyond record's xid */
				if (TransactionIdFollowsOrEquals(record->xl_xid,
B
Bruce Momjian 已提交
4892
												 ShmemVariableCache->nextXid))
4893 4894 4895 4896 4897
				{
					ShmemVariableCache->nextXid = record->xl_xid;
					TransactionIdAdvance(ShmemVariableCache->nextXid);
				}

T
Tom Lane 已提交
4898
				if (record->xl_info & XLR_BKP_BLOCK_MASK)
4899 4900
					RestoreBkpBlocks(record, EndRecPtr);

4901
				RmgrTable[record->xl_rmid].rm_redo(EndRecPtr, record);
4902

4903 4904 4905
				/* Pop the error context stack */
				error_context_stack = errcontext.previous;

4906 4907
				LastRec = ReadRecPtr;

4908
				record = ReadRecord(NULL, LOG);
4909
			} while (record != NULL && recoveryContinue);
B
Bruce Momjian 已提交
4910

4911 4912 4913 4914
			/*
			 * end of main redo apply loop
			 */

4915 4916 4917
			ereport(LOG,
					(errmsg("redo done at %X/%X",
							ReadRecPtr.xlogid, ReadRecPtr.xrecoff)));
V
WAL  
Vadim B. Mikheev 已提交
4918
			InRedo = false;
4919 4920
		}
		else
4921 4922
		{
			/* there are no WAL records following the checkpoint */
4923 4924
			ereport(LOG,
					(errmsg("redo is not required")));
4925
		}
V
WAL  
Vadim B. Mikheev 已提交
4926 4927
	}

T
Tom Lane 已提交
4928
	/*
B
Bruce Momjian 已提交
4929 4930
	 * 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 已提交
4931
	 */
4932
	record = ReadRecord(&LastRec, PANIC);
T
Tom Lane 已提交
4933
	EndOfLog = EndRecPtr;
4934 4935
	XLByteToPrevSeg(EndOfLog, endLogId, endLogSeg);

4936 4937 4938 4939
	/*
	 * Complain if we did not roll forward far enough to render the backup
	 * dump consistent.
	 */
4940
	if (XLByteLT(EndOfLog, ControlFile->minRecoveryPoint))
4941 4942 4943 4944
	{
		if (needNewTimeLine)	/* stopped because of stop request */
			ereport(FATAL,
					(errmsg("requested recovery stop point is before end time of backup dump")));
B
Bruce Momjian 已提交
4945
		else
4946
			/* ran off end of WAL */
4947 4948 4949 4950
			ereport(FATAL,
					(errmsg("WAL ends before end time of backup dump")));
	}

4951 4952 4953
	/*
	 * Consider whether we need to assign a new timeline ID.
	 *
B
Bruce Momjian 已提交
4954 4955
	 * 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 已提交
4956 4957
	 * Otherwise, we can just extend the timeline we were in when we ran out
	 * of WAL.
4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970
	 */
	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;

4971
	/*
B
Bruce Momjian 已提交
4972 4973 4974 4975
	 * 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.)
4976 4977
	 */
	if (InArchiveRecovery)
4978
		exitArchiveRecovery(curFileTLI, endLogId, endLogSeg);
4979 4980 4981 4982 4983 4984 4985 4986

	/*
	 * 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;
4987
	openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
4988
	openLogOff = 0;
V
WAL  
Vadim B. Mikheev 已提交
4989
	Insert = &XLogCtl->Insert;
4990
	Insert->PrevRecord = LastRec;
4991 4992
	XLogCtl->xlblocks[0].xlogid = openLogId;
	XLogCtl->xlblocks[0].xrecoff =
4993
		((EndOfLog.xrecoff - 1) / XLOG_BLCKSZ + 1) * XLOG_BLCKSZ;
B
Bruce Momjian 已提交
4994 4995

	/*
B
Bruce Momjian 已提交
4996 4997 4998
	 * 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 已提交
4999
	 */
5000 5001
	Assert(readOff == (XLogCtl->xlblocks[0].xrecoff - XLOG_BLCKSZ) % XLogSegSize);
	memcpy((char *) Insert->currpage, readBuf, XLOG_BLCKSZ);
5002
	Insert->currpos = (char *) Insert->currpage +
5003
		(EndOfLog.xrecoff + XLOG_BLCKSZ - XLogCtl->xlblocks[0].xrecoff);
V
WAL  
Vadim B. Mikheev 已提交
5004

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

T
Tom Lane 已提交
5007 5008 5009
	XLogCtl->Write.LogwrtResult = LogwrtResult;
	Insert->LogwrtResult = LogwrtResult;
	XLogCtl->LogwrtResult = LogwrtResult;
V
WAL  
Vadim B. Mikheev 已提交
5010

T
Tom Lane 已提交
5011 5012
	XLogCtl->LogwrtRqst.Write = EndOfLog;
	XLogCtl->LogwrtRqst.Flush = EndOfLog;
5013

5014 5015 5016 5017 5018 5019 5020 5021 5022 5023
	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 已提交
5024 5025
		 * Whenever Write.LogwrtResult points to exactly the end of a page,
		 * Write.curridx must point to the *next* page (see XLogWrite()).
5026
		 *
B
Bruce Momjian 已提交
5027
		 * Note: it might seem we should do AdvanceXLInsertBuffer() here, but
B
Bruce Momjian 已提交
5028
		 * this is sufficient.	The first actual attempt to insert a log
5029
		 * record will advance the insert state.
5030 5031 5032 5033
		 */
		XLogCtl->Write.curridx = NextBufIdx(0);
	}

5034 5035
	/* Pre-scan prepared transactions to find out the range of XIDs present */
	oldestActiveXID = PrescanPreparedTransactions();
5036

V
WAL  
Vadim B. Mikheev 已提交
5037
	if (InRecovery)
5038
	{
B
Bruce Momjian 已提交
5039
		int			rmid;
5040 5041 5042 5043 5044 5045 5046 5047 5048 5049

		/*
		 * 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();
		}

5050 5051 5052 5053 5054 5055
		/*
		 * Check to see if the XLOG sequence contained any unresolved
		 * references to uninitialized pages.
		 */
		XLogCheckInvalidPages();

5056 5057 5058 5059 5060
		/*
		 * Reset pgstat data, because it may be invalid after recovery.
		 */
		pgstat_reset_all();

T
Tom Lane 已提交
5061
		/*
5062
		 * Perform a checkpoint to update all our recovery activity to disk.
5063
		 *
5064 5065 5066 5067 5068
		 * 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 已提交
5069
		 */
5070
		CreateCheckPoint(true, true);
5071 5072 5073 5074

		/*
		 * Close down recovery environment
		 */
V
WAL  
Vadim B. Mikheev 已提交
5075
		XLogCloseRelationCache();
5076
	}
5077

T
Tom Lane 已提交
5078 5079 5080
	/*
	 * Preallocate additional log files, if wanted.
	 */
5081
	(void) PreallocXlogFiles(EndOfLog);
5082

5083 5084 5085
	/*
	 * Okay, we're officially UP.
	 */
V
WAL  
Vadim B. Mikheev 已提交
5086
	InRecovery = false;
5087 5088 5089 5090 5091

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

5092 5093 5094
	/* start the archive_timeout timer running */
	XLogCtl->Write.lastSegSwitchTime = ControlFile->time;

5095 5096 5097 5098
	/* initialize shared-memory copy of latest checkpoint XID/epoch */
	XLogCtl->ckptXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	XLogCtl->ckptXid = ControlFile->checkPointCopy.nextXid;

5099
	/* Start up the commit log and related stuff, too */
5100
	StartupCLOG();
5101
	StartupSUBTRANS(oldestActiveXID);
5102
	StartupMultiXact();
5103

5104 5105 5106
	/* Reload shared-memory state for prepared transactions */
	RecoverPreparedTransactions();

T
Tom Lane 已提交
5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117
	/* Shut down readFile facility, free space */
	if (readFile >= 0)
	{
		close(readFile);
		readFile = -1;
	}
	if (readBuf)
	{
		free(readBuf);
		readBuf = NULL;
	}
5118 5119 5120 5121 5122 5123
	if (readRecordBuf)
	{
		free(readRecordBuf);
		readRecordBuf = NULL;
		readRecordBufSize = 0;
	}
T
Tom Lane 已提交
5124 5125
}

5126 5127
/*
 * Subroutine to try to fetch and validate a prior checkpoint record.
5128 5129 5130
 *
 * whichChkpt identifies the checkpoint (merely for reporting purposes).
 * 1 for "primary", 2 for "secondary", 0 for "other" (backup_label)
5131
 */
T
Tom Lane 已提交
5132
static XLogRecord *
5133
ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt)
T
Tom Lane 已提交
5134 5135 5136 5137 5138
{
	XLogRecord *record;

	if (!XRecOffIsValid(RecPtr.xrecoff))
	{
5139 5140 5141 5142
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5143
				(errmsg("invalid primary checkpoint link in control file")));
5144 5145 5146 5147 5148 5149 5150
				break;
			case 2:
				ereport(LOG,
						(errmsg("invalid secondary checkpoint link in control file")));
				break;
			default:
				ereport(LOG,
B
Bruce Momjian 已提交
5151
				   (errmsg("invalid checkpoint link in backup_label file")));
5152 5153
				break;
		}
T
Tom Lane 已提交
5154 5155 5156
		return NULL;
	}

5157
	record = ReadRecord(&RecPtr, LOG);
T
Tom Lane 已提交
5158 5159 5160

	if (record == NULL)
	{
5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175
		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 已提交
5176 5177 5178 5179
		return NULL;
	}
	if (record->xl_rmid != RM_XLOG_ID)
	{
5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191
		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 已提交
5192
				(errmsg("invalid resource manager ID in checkpoint record")));
5193 5194
				break;
		}
T
Tom Lane 已提交
5195 5196 5197 5198 5199
		return NULL;
	}
	if (record->xl_info != XLOG_CHECKPOINT_SHUTDOWN &&
		record->xl_info != XLOG_CHECKPOINT_ONLINE)
	{
5200 5201 5202 5203
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5204
				   (errmsg("invalid xl_info in primary checkpoint record")));
5205 5206 5207
				break;
			case 2:
				ereport(LOG,
B
Bruce Momjian 已提交
5208
				 (errmsg("invalid xl_info in secondary checkpoint record")));
5209 5210 5211 5212 5213 5214
				break;
			default:
				ereport(LOG,
						(errmsg("invalid xl_info in checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5215 5216
		return NULL;
	}
5217 5218
	if (record->xl_len != sizeof(CheckPoint) ||
		record->xl_tot_len != SizeOfXLogRecord + sizeof(CheckPoint))
T
Tom Lane 已提交
5219
	{
5220 5221 5222 5223
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5224
					(errmsg("invalid length of primary checkpoint record")));
5225 5226 5227
				break;
			case 2:
				ereport(LOG,
B
Bruce Momjian 已提交
5228
				  (errmsg("invalid length of secondary checkpoint record")));
5229 5230 5231 5232 5233 5234
				break;
			default:
				ereport(LOG,
						(errmsg("invalid length of checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5235 5236 5237
		return NULL;
	}
	return record;
5238 5239
}

V
WAL  
Vadim B. Mikheev 已提交
5240
/*
5241 5242
 * This must be called during startup of a backend process, except that
 * it need not be called in a standalone backend (which does StartupXLOG
5243
 * instead).  We need to initialize the local copies of ThisTimeLineID and
5244 5245
 * RedoRecPtr.
 *
5246
 * Note: before Postgres 8.0, we went to some effort to keep the postmaster
5247
 * process's copies of ThisTimeLineID and RedoRecPtr valid too.  This was
5248
 * unnecessary however, since the postmaster itself never touches XLOG anyway.
V
WAL  
Vadim B. Mikheev 已提交
5249 5250
 */
void
5251
InitXLOGAccess(void)
V
WAL  
Vadim B. Mikheev 已提交
5252
{
5253 5254
	/* ThisTimeLineID doesn't change so we need no lock to copy it */
	ThisTimeLineID = XLogCtl->ThisTimeLineID;
5255 5256
	/* Use GetRedoRecPtr to copy the RedoRecPtr safely */
	(void) GetRedoRecPtr();
5257 5258 5259 5260 5261 5262 5263 5264
}

/*
 * 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
5265 5266
GetRedoRecPtr(void)
{
5267 5268 5269
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;

5270
	SpinLockAcquire(&xlogctl->info_lck);
5271 5272
	Assert(XLByteLE(RedoRecPtr, xlogctl->Insert.RedoRecPtr));
	RedoRecPtr = xlogctl->Insert.RedoRecPtr;
5273
	SpinLockRelease(&xlogctl->info_lck);
5274 5275

	return RedoRecPtr;
V
WAL  
Vadim B. Mikheev 已提交
5276 5277
}

5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293
/*
 * 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;
}

5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304
/*
 * 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 已提交
5305 5306 5307
	uint32		ckptXidEpoch;
	TransactionId ckptXid;
	TransactionId nextXid;
5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333

	/* 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;
}

5334
/*
T
Tom Lane 已提交
5335
 * This must be called ONCE during postmaster or standalone-backend shutdown
5336 5337
 */
void
5338
ShutdownXLOG(int code, Datum arg)
5339
{
5340 5341
	ereport(LOG,
			(errmsg("shutting down")));
5342

5343
	CreateCheckPoint(true, true);
5344
	ShutdownCLOG();
5345
	ShutdownSUBTRANS();
5346
	ShutdownMultiXact();
5347

5348 5349
	ereport(LOG,
			(errmsg("database system is shut down")));
5350 5351
}

T
Tom Lane 已提交
5352 5353
/*
 * Perform a checkpoint --- either during shutdown, or on-the-fly
5354 5355 5356
 *
 * If force is true, we force a checkpoint regardless of whether any XLOG
 * activity has occurred since the last one.
T
Tom Lane 已提交
5357
 */
5358
void
5359
CreateCheckPoint(bool shutdown, bool force)
5360
{
5361 5362 5363
	CheckPoint	checkPoint;
	XLogRecPtr	recptr;
	XLogCtlInsert *Insert = &XLogCtl->Insert;
B
Bruce Momjian 已提交
5364
	XLogRecData rdata;
5365
	uint32		freespace;
V
Vadim B. Mikheev 已提交
5366 5367
	uint32		_logId;
	uint32		_logSeg;
5368 5369 5370
	int			nsegsadded = 0;
	int			nsegsremoved = 0;
	int			nsegsrecycled = 0;
5371 5372
	TransactionId *inCommitXids;
	int			nInCommit;
V
Vadim B. Mikheev 已提交
5373

5374
	/*
B
Bruce Momjian 已提交
5375 5376 5377 5378
	 * 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.)
5379
	 */
5380
	LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
5381

5382 5383 5384
	/*
	 * Use a critical section to force system panic if we have trouble.
	 */
5385 5386
	START_CRIT_SECTION();

5387 5388 5389 5390 5391 5392
	if (shutdown)
	{
		ControlFile->state = DB_SHUTDOWNING;
		ControlFile->time = time(NULL);
		UpdateControlFile();
	}
T
Tom Lane 已提交
5393

5394
	MemSet(&checkPoint, 0, sizeof(checkPoint));
5395
	checkPoint.ThisTimeLineID = ThisTimeLineID;
T
Tom Lane 已提交
5396
	checkPoint.time = time(NULL);
5397

5398
	/*
5399 5400
	 * We must hold WALInsertLock while examining insert state to determine
	 * the checkpoint REDO pointer.
5401
	 */
5402
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
T
Tom Lane 已提交
5403 5404

	/*
B
Bruce Momjian 已提交
5405 5406 5407 5408 5409 5410 5411 5412
	 * 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 已提交
5413
	 *
5414 5415 5416 5417
	 * 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 已提交
5418
	 */
5419
	if (!shutdown && !force)
T
Tom Lane 已提交
5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431
	{
		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)
		{
5432 5433
			LWLockRelease(WALInsertLock);
			LWLockRelease(CheckpointLock);
T
Tom Lane 已提交
5434 5435 5436 5437 5438 5439 5440 5441
			END_CRIT_SECTION();
			return;
		}
	}

	/*
	 * Compute new REDO record ptr = location of next XLOG record.
	 *
B
Bruce Momjian 已提交
5442 5443 5444 5445
	 * 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 已提交
5446 5447
	 */
	freespace = INSERT_FREESPACE(Insert);
5448 5449
	if (freespace < SizeOfXLogRecord)
	{
5450
		(void) AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
5451
		/* OK to ignore update return flag, since we will do flush anyway */
5452
		freespace = INSERT_FREESPACE(Insert);
5453
	}
T
Tom Lane 已提交
5454
	INSERT_RECPTR(checkPoint.redo, Insert, Insert->curridx);
B
Bruce Momjian 已提交
5455

T
Tom Lane 已提交
5456
	/*
B
Bruce Momjian 已提交
5457 5458
	 * Here we update the shared RedoRecPtr for future XLogInsert calls; this
	 * must be done while holding the insert lock AND the info_lck.
5459
	 *
B
Bruce Momjian 已提交
5460
	 * Note: if we fail to complete the checkpoint, RedoRecPtr will be left
B
Bruce Momjian 已提交
5461 5462 5463 5464 5465
	 * 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 已提交
5466
	 */
5467 5468 5469 5470
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

5471
		SpinLockAcquire(&xlogctl->info_lck);
5472
		RedoRecPtr = xlogctl->Insert.RedoRecPtr = checkPoint.redo;
5473
		SpinLockRelease(&xlogctl->info_lck);
5474
	}
B
Bruce Momjian 已提交
5475

T
Tom Lane 已提交
5476
	/*
5477 5478
	 * Now we can release WAL insert lock, allowing other xacts to proceed
	 * while we are flushing disk buffers.
T
Tom Lane 已提交
5479
	 */
5480
	LWLockRelease(WALInsertLock);
5481

5482 5483 5484 5485
	if (!shutdown)
		ereport(DEBUG2,
				(errmsg("checkpoint starting")));

5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518
	/*
	 * 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);

5519 5520 5521
	/*
	 * Get the other info we need for the checkpoint record.
	 */
5522
	LWLockAcquire(XidGenLock, LW_SHARED);
5523
	checkPoint.nextXid = ShmemVariableCache->nextXid;
5524
	LWLockRelease(XidGenLock);
T
Tom Lane 已提交
5525

5526 5527 5528 5529 5530
	/* Increase XID epoch if we've wrapped around since last checkpoint */
	checkPoint.nextXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	if (checkPoint.nextXid < ControlFile->checkPointCopy.nextXid)
		checkPoint.nextXidEpoch++;

5531
	LWLockAcquire(OidGenLock, LW_SHARED);
5532
	checkPoint.nextOid = ShmemVariableCache->nextOid;
5533 5534
	if (!shutdown)
		checkPoint.nextOid += ShmemVariableCache->oidCount;
5535
	LWLockRelease(OidGenLock);
5536

5537 5538 5539
	MultiXactGetCheckptMulti(shutdown,
							 &checkPoint.nextMulti,
							 &checkPoint.nextMultiOffset);
5540

T
Tom Lane 已提交
5541
	/*
B
Bruce Momjian 已提交
5542 5543
	 * Having constructed the checkpoint record, ensure all shmem disk buffers
	 * and commit-log buffers are flushed to disk.
5544
	 *
5545 5546
	 * 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
5547
	 * panic. Accordingly, exit critical section while doing it.
T
Tom Lane 已提交
5548
	 */
5549 5550
	END_CRIT_SECTION();

5551
	CheckPointGuts(checkPoint.redo);
5552

5553 5554
	START_CRIT_SECTION();

T
Tom Lane 已提交
5555 5556 5557
	/*
	 * Now insert the checkpoint record into XLOG.
	 */
B
Bruce Momjian 已提交
5558
	rdata.data = (char *) (&checkPoint);
5559
	rdata.len = sizeof(checkPoint);
5560
	rdata.buffer = InvalidBuffer;
5561 5562
	rdata.next = NULL;

T
Tom Lane 已提交
5563 5564 5565 5566 5567 5568
	recptr = XLogInsert(RM_XLOG_ID,
						shutdown ? XLOG_CHECKPOINT_SHUTDOWN :
						XLOG_CHECKPOINT_ONLINE,
						&rdata);

	XLogFlush(recptr);
5569

T
Tom Lane 已提交
5570
	/*
B
Bruce Momjian 已提交
5571 5572
	 * We now have ProcLastRecPtr = start of actual checkpoint record, recptr
	 * = end of actual checkpoint record.
T
Tom Lane 已提交
5573 5574
	 */
	if (shutdown && !XLByteEQ(checkPoint.redo, ProcLastRecPtr))
5575 5576
		ereport(PANIC,
				(errmsg("concurrent transaction log activity while database system is shutting down")));
5577

T
Tom Lane 已提交
5578
	/*
5579 5580
	 * Select point at which we can truncate the log, which we base on the
	 * prior checkpoint's earliest info.
T
Tom Lane 已提交
5581
	 */
5582
	XLByteToSeg(ControlFile->checkPointCopy.redo, _logId, _logSeg);
5583

T
Tom Lane 已提交
5584 5585 5586
	/*
	 * Update the control file.
	 */
5587
	LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
5588 5589
	if (shutdown)
		ControlFile->state = DB_SHUTDOWNED;
T
Tom Lane 已提交
5590 5591 5592
	ControlFile->prevCheckPoint = ControlFile->checkPoint;
	ControlFile->checkPoint = ProcLastRecPtr;
	ControlFile->checkPointCopy = checkPoint;
5593 5594
	ControlFile->time = time(NULL);
	UpdateControlFile();
5595
	LWLockRelease(ControlFileLock);
5596

5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607
	/* 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);
	}

5608
	/*
B
Bruce Momjian 已提交
5609 5610
	 * We are now done with critical updates; no need for system panic if we
	 * have trouble while fooling with offline log segments.
5611 5612 5613
	 */
	END_CRIT_SECTION();

V
Vadim B. Mikheev 已提交
5614
	/*
T
Tom Lane 已提交
5615 5616
	 * Delete offline log files (those no longer needed even for previous
	 * checkpoint).
V
Vadim B. Mikheev 已提交
5617 5618 5619
	 */
	if (_logId || _logSeg)
	{
T
Tom Lane 已提交
5620
		PrevLogSeg(_logId, _logSeg);
5621 5622
		MoveOfflineLogs(_logId, _logSeg, recptr,
						&nsegsremoved, &nsegsrecycled);
V
Vadim B. Mikheev 已提交
5623 5624
	}

T
Tom Lane 已提交
5625
	/*
B
Bruce Momjian 已提交
5626 5627
	 * Make more log segments if needed.  (Do this after deleting offline log
	 * segments, to avoid having peak disk space usage higher than necessary.)
T
Tom Lane 已提交
5628 5629
	 */
	if (!shutdown)
5630
		nsegsadded = PreallocXlogFiles(recptr);
T
Tom Lane 已提交
5631

5632
	/*
B
Bruce Momjian 已提交
5633 5634 5635 5636 5637
	 * 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.
5638
	 */
5639
	if (!InRecovery)
5640
		TruncateSUBTRANS(GetOldestXmin(true, false));
5641

5642
	if (!shutdown)
5643
		ereport(DEBUG2,
5644 5645 5646
				(errmsg("checkpoint complete; %d transaction log file(s) added, %d removed, %d recycled",
						nsegsadded, nsegsremoved, nsegsrecycled)));

5647
	LWLockRelease(CheckpointLock);
5648
}
V
WAL  
Vadim B. Mikheev 已提交
5649

5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661
/*
 * Flush all data in shared memory to disk, and fsync
 *
 * This is the common code shared between regular checkpoints and
 * recovery restartpoints.
 */
static void
CheckPointGuts(XLogRecPtr checkPointRedo)
{
	CheckPointCLOG();
	CheckPointSUBTRANS();
	CheckPointMultiXact();
B
Bruce Momjian 已提交
5662
	FlushBufferPool();			/* performs all required fsyncs */
5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678
	/* We deliberately delay 2PC checkpointing as long as possible */
	CheckPointTwoPhase(checkPointRedo);
}

/*
 * Set a recovery restart point if appropriate
 *
 * This is similar to CreateCheckpoint, but is used during WAL recovery
 * 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 已提交
5679 5680
	int			elapsed_secs;
	int			rmid;
5681 5682

	/*
B
Bruce Momjian 已提交
5683 5684
	 * Do nothing if the elapsed time since the last restartpoint is less than
	 * half of checkpoint_timeout.	(We use a value less than
5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713
	 * 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
	 */
	CheckPointGuts(checkPoint->redo);

	/*
B
Bruce Momjian 已提交
5714 5715 5716
	 * Update pg_control so that any subsequent crash will restart from this
	 * checkpoint.	Note: ReadRecPtr gives the XLOG address of the checkpoint
	 * record itself.
5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728
	 */
	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 已提交
5729 5730 5731
/*
 * Write a NEXTOID log record
 */
5732 5733 5734
void
XLogPutNextOid(Oid nextOid)
{
B
Bruce Momjian 已提交
5735
	XLogRecData rdata;
5736

B
Bruce Momjian 已提交
5737
	rdata.data = (char *) (&nextOid);
5738
	rdata.len = sizeof(Oid);
5739
	rdata.buffer = InvalidBuffer;
5740 5741
	rdata.next = NULL;
	(void) XLogInsert(RM_XLOG_ID, XLOG_NEXTOID, &rdata);
B
Bruce Momjian 已提交
5742

5743 5744
	/*
	 * We need not flush the NEXTOID record immediately, because any of the
B
Bruce Momjian 已提交
5745 5746 5747 5748 5749
	 * 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.
5750 5751 5752 5753 5754 5755 5756 5757 5758 5759
	 *
	 * 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.
5760 5761 5762
	 */
}

5763 5764 5765 5766 5767 5768 5769 5770 5771 5772
/*
 * 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.
 */
5773
XLogRecPtr
5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789
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 已提交
5790 5791 5792
/*
 * XLOG resource manager's routines
 */
V
WAL  
Vadim B. Mikheev 已提交
5793 5794 5795
void
xlog_redo(XLogRecPtr lsn, XLogRecord *record)
{
B
Bruce Momjian 已提交
5796
	uint8		info = record->xl_info & ~XLR_INFO_MASK;
5797

5798
	if (info == XLOG_NEXTOID)
5799
	{
B
Bruce Momjian 已提交
5800
		Oid			nextOid;
5801 5802 5803

		memcpy(&nextOid, XLogRecGetData(record), sizeof(Oid));
		if (ShmemVariableCache->nextOid < nextOid)
T
Tom Lane 已提交
5804
		{
5805
			ShmemVariableCache->nextOid = nextOid;
T
Tom Lane 已提交
5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817
			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;
5818 5819
		MultiXactSetNextMXact(checkPoint.nextMulti,
							  checkPoint.nextMultiOffset);
B
Bruce Momjian 已提交
5820

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

5825
		/*
B
Bruce Momjian 已提交
5826
		 * TLI may change in a shutdown checkpoint, but it shouldn't decrease
5827 5828 5829 5830 5831 5832 5833 5834
		 */
		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 已提交
5835
								checkPoint.ThisTimeLineID, ThisTimeLineID)));
5836 5837 5838
			/* Following WAL records should be run with new TLI */
			ThisTimeLineID = checkPoint.ThisTimeLineID;
		}
5839 5840

		RecoveryRestartPoint(&checkPoint);
T
Tom Lane 已提交
5841 5842 5843 5844 5845 5846
	}
	else if (info == XLOG_CHECKPOINT_ONLINE)
	{
		CheckPoint	checkPoint;

		memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
5847
		/* In an ONLINE checkpoint, treat the counters like NEXTOID */
5848 5849
		if (TransactionIdPrecedes(ShmemVariableCache->nextXid,
								  checkPoint.nextXid))
T
Tom Lane 已提交
5850 5851 5852 5853 5854 5855
			ShmemVariableCache->nextXid = checkPoint.nextXid;
		if (ShmemVariableCache->nextOid < checkPoint.nextOid)
		{
			ShmemVariableCache->nextOid = checkPoint.nextOid;
			ShmemVariableCache->oidCount = 0;
		}
5856 5857
		MultiXactAdvanceNextMXact(checkPoint.nextMulti,
								  checkPoint.nextMultiOffset);
5858 5859 5860 5861 5862

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

5863 5864
		/* TLI should not change in an on-line checkpoint */
		if (checkPoint.ThisTimeLineID != ThisTimeLineID)
5865
			ereport(PANIC,
5866 5867
					(errmsg("unexpected timeline ID %u (should be %u) in checkpoint record",
							checkPoint.ThisTimeLineID, ThisTimeLineID)));
5868 5869

		RecoveryRestartPoint(&checkPoint);
5870
	}
5871 5872 5873 5874
	else if (info == XLOG_SWITCH)
	{
		/* nothing to do here */
	}
V
WAL  
Vadim B. Mikheev 已提交
5875
}
B
Bruce Momjian 已提交
5876

V
WAL  
Vadim B. Mikheev 已提交
5877
void
5878
xlog_desc(StringInfo buf, uint8 xl_info, char *rec)
V
WAL  
Vadim B. Mikheev 已提交
5879
{
B
Bruce Momjian 已提交
5880
	uint8		info = xl_info & ~XLR_INFO_MASK;
V
WAL  
Vadim B. Mikheev 已提交
5881

T
Tom Lane 已提交
5882 5883
	if (info == XLOG_CHECKPOINT_SHUTDOWN ||
		info == XLOG_CHECKPOINT_ONLINE)
V
WAL  
Vadim B. Mikheev 已提交
5884
	{
B
Bruce Momjian 已提交
5885 5886
		CheckPoint *checkpoint = (CheckPoint *) rec;

5887
		appendStringInfo(buf, "checkpoint: redo %X/%X; "
B
Bruce Momjian 已提交
5888 5889 5890 5891 5892 5893 5894 5895
						 "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 已提交
5896
	}
5897 5898
	else if (info == XLOG_NEXTOID)
	{
B
Bruce Momjian 已提交
5899
		Oid			nextOid;
5900 5901

		memcpy(&nextOid, rec, sizeof(Oid));
5902
		appendStringInfo(buf, "nextOid: %u", nextOid);
5903
	}
5904 5905 5906 5907
	else if (info == XLOG_SWITCH)
	{
		appendStringInfo(buf, "xlog switch");
	}
V
WAL  
Vadim B. Mikheev 已提交
5908
	else
5909
		appendStringInfo(buf, "UNKNOWN");
V
WAL  
Vadim B. Mikheev 已提交
5910 5911
}

5912
#ifdef WAL_DEBUG
5913

V
WAL  
Vadim B. Mikheev 已提交
5914
static void
5915
xlog_outrec(StringInfo buf, XLogRecord *record)
V
WAL  
Vadim B. Mikheev 已提交
5916
{
B
Bruce Momjian 已提交
5917
	int			i;
5918

5919
	appendStringInfo(buf, "prev %X/%X; xid %u",
5920 5921
					 record->xl_prev.xlogid, record->xl_prev.xrecoff,
					 record->xl_xid);
5922

5923
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
5924
	{
5925
		if (record->xl_info & XLR_SET_BKP_BLOCK(i))
B
Bruce Momjian 已提交
5926
			appendStringInfo(buf, "; bkpb%d", i + 1);
5927 5928
	}

5929
	appendStringInfo(buf, ": %s", RmgrTable[record->xl_rmid].rm_name);
V
WAL  
Vadim B. Mikheev 已提交
5930
}
B
Bruce Momjian 已提交
5931
#endif   /* WAL_DEBUG */
5932 5933 5934


/*
5935
 * GUC support
5936
 */
5937
const char *
5938
assign_xlog_sync_method(const char *method, bool doit, GucSource source)
5939
{
B
Bruce Momjian 已提交
5940 5941
	int			new_sync_method;
	int			new_sync_bit;
5942

5943
	if (pg_strcasecmp(method, "fsync") == 0)
5944 5945 5946 5947
	{
		new_sync_method = SYNC_METHOD_FSYNC;
		new_sync_bit = 0;
	}
5948 5949 5950 5951 5952 5953 5954
#ifdef HAVE_FSYNC_WRITETHROUGH
	else if (pg_strcasecmp(method, "fsync_writethrough") == 0)
	{
		new_sync_method = SYNC_METHOD_FSYNC_WRITETHROUGH;
		new_sync_bit = 0;
	}
#endif
5955
#ifdef HAVE_FDATASYNC
5956
	else if (pg_strcasecmp(method, "fdatasync") == 0)
5957 5958 5959 5960 5961 5962
	{
		new_sync_method = SYNC_METHOD_FDATASYNC;
		new_sync_bit = 0;
	}
#endif
#ifdef OPEN_SYNC_FLAG
5963
	else if (pg_strcasecmp(method, "open_sync") == 0)
5964 5965 5966 5967 5968 5969
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_SYNC_FLAG;
	}
#endif
#ifdef OPEN_DATASYNC_FLAG
5970
	else if (pg_strcasecmp(method, "open_datasync") == 0)
5971 5972 5973 5974 5975 5976
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_DATASYNC_FLAG;
	}
#endif
	else
5977
		return NULL;
5978

5979 5980 5981
	if (!doit)
		return method;

5982 5983 5984
	if (sync_method != new_sync_method || open_sync_bit != new_sync_bit)
	{
		/*
B
Bruce Momjian 已提交
5985 5986
		 * 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 已提交
5987 5988
		 * changing, close the log file so it will be reopened (with new flag
		 * bit) at next use.
5989 5990 5991 5992
		 */
		if (openLogFile >= 0)
		{
			if (pg_fsync(openLogFile) != 0)
5993 5994
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
5995 5996
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
5997
			if (open_sync_bit != new_sync_bit)
5998
				XLogFileClose();
5999 6000 6001 6002
		}
		sync_method = new_sync_method;
		open_sync_bit = new_sync_bit;
	}
6003 6004

	return method;
6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015
}


/*
 * Issue appropriate kind of fsync (if any) on the current XLOG output file
 */
static void
issue_xlog_fsync(void)
{
	switch (sync_method)
	{
6016
		case SYNC_METHOD_FSYNC:
6017
			if (pg_fsync_no_writethrough(openLogFile) != 0)
6018 6019
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6020 6021
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6022
			break;
6023 6024 6025 6026 6027
#ifdef HAVE_FSYNC_WRITETHROUGH
		case SYNC_METHOD_FSYNC_WRITETHROUGH:
			if (pg_fsync_writethrough(openLogFile) != 0)
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6028 6029
						 errmsg("could not fsync write-through log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6030 6031
			break;
#endif
6032 6033 6034
#ifdef HAVE_FDATASYNC
		case SYNC_METHOD_FDATASYNC:
			if (pg_fdatasync(openLogFile) != 0)
6035 6036
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6037 6038
					errmsg("could not fdatasync log file %u, segment %u: %m",
						   openLogId, openLogSeg)));
6039 6040 6041 6042 6043 6044
			break;
#endif
		case SYNC_METHOD_OPEN:
			/* write synced it already */
			break;
		default:
6045
			elog(PANIC, "unrecognized wal_sync_method: %d", sync_method);
6046 6047 6048
			break;
	}
}
6049 6050 6051 6052 6053 6054 6055 6056 6057


/*
 * 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
6058
 * starting WAL location for the dump.
6059 6060 6061 6062 6063 6064 6065
 */
Datum
pg_start_backup(PG_FUNCTION_ARGS)
{
	text	   *backupid = PG_GETARG_TEXT_P(0);
	text	   *result;
	char	   *backupidstr;
6066
	XLogRecPtr	checkpointloc;
6067
	XLogRecPtr	startpoint;
B
Bruce Momjian 已提交
6068
	time_t		stamp_time;
6069 6070 6071 6072 6073 6074 6075
	char		strfbuf[128];
	char		xlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	struct stat stat_buf;
	FILE	   *fp;

B
Bruce Momjian 已提交
6076
	if (!superuser())
6077 6078 6079
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
6080 6081 6082 6083

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

6088
	backupidstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6089
												 PointerGetDatum(backupid)));
B
Bruce Momjian 已提交
6090

6091
	/*
6092 6093 6094
	 * 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 已提交
6095 6096 6097 6098 6099 6100 6101 6102 6103
	 * 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.)
6104
	 *
B
Bruce Momjian 已提交
6105 6106
	 * We must hold WALInsertLock to change the value of forcePageWrites, to
	 * ensure adequate interlocking against XLogInsert().
6107
	 */
6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118
	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 已提交
6119

6120 6121 6122 6123
	/* Use a TRY block to ensure we release forcePageWrites if fail below */
	PG_TRY();
	{
		/*
B
Bruce Momjian 已提交
6124
		 * Force a CHECKPOINT.	Aside from being necessary to prevent torn
6125 6126 6127 6128 6129
		 * 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.
		 */
		RequestCheckpoint(true, false);
6130

6131 6132 6133 6134 6135 6136 6137 6138 6139
		/*
		 * 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 已提交
6140

6141 6142
		XLByteToSeg(startpoint, _logId, _logSeg);
		XLogFileName(xlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6143

6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179
		/*
		 * 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)
6180 6181
			ereport(ERROR,
					(errcode_for_file_access(),
6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193
					 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",
6194
							BACKUP_LABEL_FILE)));
6195
	}
6196 6197 6198 6199 6200 6201
	PG_CATCH();
	{
		/* Turn off forcePageWrites on failure */
		LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
		XLogCtl->Insert.forcePageWrites = false;
		LWLockRelease(WALInsertLock);
B
Bruce Momjian 已提交
6202

6203 6204 6205
		PG_RE_THROW();
	}
	PG_END_TRY();
B
Bruce Momjian 已提交
6206

6207
	/*
6208
	 * We're done.  As a convenience, return the starting WAL location.
6209 6210 6211 6212
	 */
	snprintf(xlogfilename, sizeof(xlogfilename), "%X/%X",
			 startpoint.xlogid, startpoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6213
											 CStringGetDatum(xlogfilename)));
6214 6215 6216 6217 6218 6219 6220 6221 6222
	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
6223
 * the label file, plus the backup-end time and WAL location.
6224 6225 6226 6227 6228 6229 6230
 */
Datum
pg_stop_backup(PG_FUNCTION_ARGS)
{
	text	   *result;
	XLogRecPtr	startpoint;
	XLogRecPtr	stoppoint;
B
Bruce Momjian 已提交
6231
	time_t		stamp_time;
6232
	char		strfbuf[128];
6233
	char		histfilepath[MAXPGPATH];
6234 6235 6236 6237 6238 6239 6240 6241 6242
	char		startxlogfilename[MAXFNAMELEN];
	char		stopxlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	FILE	   *lfp;
	FILE	   *fp;
	char		ch;
	int			ich;

B
Bruce Momjian 已提交
6243
	if (!superuser())
6244 6245 6246
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
B
Bruce Momjian 已提交
6247

6248
	/*
6249
	 * OK to clear forcePageWrites
6250 6251
	 */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
6252
	XLogCtl->Insert.forcePageWrites = false;
6253 6254
	LWLockRelease(WALInsertLock);

6255
	/*
B
Bruce Momjian 已提交
6256 6257 6258
	 * 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.
6259 6260 6261
	 */
	stoppoint = RequestXLogSwitch();

6262 6263
	XLByteToSeg(stoppoint, _logId, _logSeg);
	XLogFileName(stopxlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6264

6265
	/*
B
Bruce Momjian 已提交
6266 6267 6268 6269
	 * 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.
6270 6271 6272 6273 6274
	 */
	stamp_time = time(NULL);
	strftime(strfbuf, sizeof(strfbuf),
			 "%Y-%m-%d %H:%M:%S %Z",
			 localtime(&stamp_time));
B
Bruce Momjian 已提交
6275

6276 6277 6278
	/*
	 * Open the existing label file
	 */
6279
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6280 6281 6282 6283 6284 6285
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(ERROR,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6286
							BACKUP_LABEL_FILE)));
6287 6288 6289 6290
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
				 errmsg("a backup is not in progress")));
	}
B
Bruce Momjian 已提交
6291

6292
	/*
B
Bruce Momjian 已提交
6293 6294
	 * Read and parse the START WAL LOCATION line (this code is pretty crude,
	 * but we are not expecting any variability in the file format).
6295 6296 6297 6298 6299 6300
	 */
	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),
6301
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6302

6303 6304 6305 6306
	/*
	 * Write the backup history file
	 */
	XLByteToSeg(startpoint, _logId, _logSeg);
6307
	BackupHistoryFilePath(histfilepath, ThisTimeLineID, _logId, _logSeg,
6308
						  startpoint.xrecoff % XLogSegSize);
6309
	fp = AllocateFile(histfilepath, "w");
6310 6311 6312 6313
	if (!fp)
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not create file \"%s\": %m",
6314
						histfilepath)));
6315 6316 6317 6318
	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);
6319
	/* transfer remaining lines from label to history file */
6320 6321 6322 6323 6324 6325 6326
	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",
6327
						histfilepath)));
B
Bruce Momjian 已提交
6328

6329 6330 6331 6332 6333 6334 6335
	/*
	 * 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",
6336 6337
						BACKUP_LABEL_FILE)));
	if (unlink(BACKUP_LABEL_FILE) != 0)
6338 6339 6340
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not remove file \"%s\": %m",
6341
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6342

6343
	/*
B
Bruce Momjian 已提交
6344 6345 6346
	 * 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.
6347
	 */
6348
	CleanupBackupHistory();
B
Bruce Momjian 已提交
6349

6350
	/*
6351
	 * We're done.  As a convenience, return the ending WAL location.
6352 6353 6354 6355
	 */
	snprintf(stopxlogfilename, sizeof(stopxlogfilename), "%X/%X",
			 stoppoint.xlogid, stoppoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6356
										 CStringGetDatum(stopxlogfilename)));
6357 6358
	PG_RETURN_TEXT_P(result);
}
6359

6360 6361 6362 6363 6364 6365 6366
/*
 * pg_switch_xlog: switch to next xlog file
 */
Datum
pg_switch_xlog(PG_FUNCTION_ARGS)
{
	text	   *result;
B
Bruce Momjian 已提交
6367
	XLogRecPtr	switchpoint;
6368 6369 6370 6371 6372
	char		location[MAXFNAMELEN];

	if (!superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
P
Peter Eisentraut 已提交
6373
				 (errmsg("must be superuser to switch transaction log files"))));
6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387

	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);
}

/*
6388 6389 6390 6391 6392
 * 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.
6393 6394 6395
 */
Datum
pg_current_xlog_location(PG_FUNCTION_ARGS)
6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424
{
	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)
6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465
{
	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 已提交
6466 6467 6468 6469 6470
	Datum		values[2];
	bool		isnull[2];
	TupleDesc	resultTupleDesc;
	HeapTuple	resultHeapTuple;
	Datum		result;
6471

6472 6473 6474
	/*
	 * Read input and parse
	 */
6475
	locationstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6476
												 PointerGetDatum(location)));
6477 6478 6479 6480

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6481
				 errmsg("could not parse transaction log location \"%s\"",
6482 6483 6484 6485 6486
						locationstr)));

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

6487
	/*
B
Bruce Momjian 已提交
6488 6489
	 * Construct a tuple descriptor for the result row.  This must match this
	 * function's pg_proc entry!
6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501
	 */
	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
	 */
6502 6503 6504
	XLByteToPrevSeg(locationpoint, xlogid, xlogseg);
	XLogFileName(xlogfilename, ThisTimeLineID, xlogid, xlogseg);

6505 6506 6507 6508 6509 6510 6511
	values[0] = DirectFunctionCall1(textin,
									CStringGetDatum(xlogfilename));
	isnull[0] = false;

	/*
	 * offset
	 */
6512 6513
	xrecoff = locationpoint.xrecoff - xlogseg * XLogSegSize;

6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524
	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);
6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544
}

/*
 * 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 已提交
6545
												 PointerGetDatum(location)));
6546 6547 6548 6549

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6550
				 errmsg("could not parse transaction log location \"%s\"",
6551 6552 6553 6554 6555 6556 6557 6558 6559
						locationstr)));

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

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

	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6560
											 CStringGetDatum(xlogfilename)));
6561 6562 6563
	PG_RETURN_TEXT_P(result);
}

6564 6565 6566 6567 6568
/*
 * 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 已提交
6569
 * identified by the label file, NOT what pg_control says.	This avoids the
6570 6571 6572 6573 6574
 * 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.
6575
 * If successful, set *minRecoveryLoc to constrain valid PITR stopping
6576 6577 6578 6579 6580 6581
 * points.
 *
 * Returns TRUE if a backup_label was found (and fills the checkpoint
 * location into *checkPointLoc); returns FALSE if not.
 */
static bool
6582
read_backup_label(XLogRecPtr *checkPointLoc, XLogRecPtr *minRecoveryLoc)
6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596
{
	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;

6597 6598 6599 6600
	/* Default is to not constrain recovery stop point */
	minRecoveryLoc->xlogid = 0;
	minRecoveryLoc->xrecoff = 0;

6601 6602 6603
	/*
	 * See if label file is present
	 */
6604
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6605 6606 6607 6608 6609 6610
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6611
							BACKUP_LABEL_FILE)));
6612 6613
		return false;			/* it's not there, all is fine */
	}
B
Bruce Momjian 已提交
6614

6615
	/*
B
Bruce Momjian 已提交
6616 6617 6618
	 * 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).
6619 6620 6621 6622 6623 6624
	 */
	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),
6625
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
6626 6627 6628 6629 6630
	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),
6631
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
6632 6633 6634 6635
	if (ferror(lfp) || FreeFile(lfp))
		ereport(FATAL,
				(errcode_for_file_access(),
				 errmsg("could not read file \"%s\": %m",
6636
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6637

6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650
	/*
	 * 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 已提交
6651
	fp = AllocateFile(histfilepath, "r");
6652 6653 6654 6655 6656 6657
	if (fp)
	{
		/*
		 * Parse history file to identify stop point.
		 */
		if (fscanf(fp, "START WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
6658
				   &startpoint.xlogid, &startpoint.xrecoff, startxlogfilename,
6659 6660 6661
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
6662
					 errmsg("invalid data in file \"%s\"", histfilename)));
6663
		if (fscanf(fp, "STOP WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
6664
				   &stoppoint.xlogid, &stoppoint.xrecoff, stopxlogfilename,
6665 6666 6667
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
6668
					 errmsg("invalid data in file \"%s\"", histfilename)));
6669
		*minRecoveryLoc = stoppoint;
6670 6671 6672 6673 6674 6675 6676 6677 6678 6679
		if (ferror(fp) || FreeFile(fp))
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
							histfilepath)));
	}

	return true;
}

6680 6681 6682 6683 6684 6685
/*
 * Error context callback for errors occurring during rm_redo().
 */
static void
rm_redo_error_callback(void *arg)
{
B
Bruce Momjian 已提交
6686 6687
	XLogRecord *record = (XLogRecord *) arg;
	StringInfoData buf;
6688 6689

	initStringInfo(&buf);
6690 6691
	RmgrTable[record->xl_rmid].rm_desc(&buf,
									   record->xl_info,
6692 6693 6694 6695 6696 6697 6698 6699
									   XLogRecGetData(record));

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

	pfree(buf.data);
}