xlog.c 197.0 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.271 2007/05/31 07:36:12 petere 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 788 789 790 791 792 793 794 795 796 797 798
	/*
	 * If we backed up any full blocks and online backup is not in progress,
	 * mark the backup blocks as removable.  This allows the WAL archiver to
	 * know whether it is safe to compress archived WAL data by transforming
	 * full-block records into the non-full-block format.
	 *
	 * Note: we could just set the flag whenever !forcePageWrites, but
	 * defining it like this leaves the info bit free for some potential
	 * other use in records without any backup blocks.
	 */
	if ((info & XLR_BKP_BLOCK_MASK) && !Insert->forcePageWrites)
		info |= XLR_BKP_REMOVABLE;

799
	/*
800
	 * If there isn't enough space on the current XLOG page for a record
B
Bruce Momjian 已提交
801
	 * header, advance to the next page (leaving the unused space as zeroes).
802
	 */
T
Tom Lane 已提交
803 804
	updrqst = false;
	freespace = INSERT_FREESPACE(Insert);
805 806
	if (freespace < SizeOfXLogRecord)
	{
807
		updrqst = AdvanceXLInsertBuffer(false);
808 809 810
		freespace = INSERT_FREESPACE(Insert);
	}

811
	/* Compute record's XLOG location */
T
Tom Lane 已提交
812
	curridx = Insert->curridx;
813 814 815
	INSERT_RECPTR(RecPtr, Insert, curridx);

	/*
B
Bruce Momjian 已提交
816 817 818 819 820
	 * 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.
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
	 */
	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 已提交
852

853 854
	/* Insert record header */

855
	record = (XLogRecord *) Insert->currpos;
856
	record->xl_prev = Insert->PrevRecord;
857
	record->xl_xid = GetCurrentTransactionIdIfAny();
858
	record->xl_tot_len = SizeOfXLogRecord + write_len;
T
Tom Lane 已提交
859
	record->xl_len = len;		/* doesn't include backup blocks */
860
	record->xl_info = info;
861
	record->xl_rmid = rmid;
862

863 864 865 866
	/* 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);
867 868
	record->xl_crc = rdata_crc;

869
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
870 871
	if (XLOG_DEBUG)
	{
B
Bruce Momjian 已提交
872
		StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
873

874
		initStringInfo(&buf);
875 876
		appendStringInfo(&buf, "INSERT @ %X/%X: ",
						 RecPtr.xlogid, RecPtr.xrecoff);
877
		xlog_outrec(&buf, record);
878
		if (rdata->data != NULL)
V
WAL  
Vadim B. Mikheev 已提交
879
		{
880 881
			appendStringInfo(&buf, " - ");
			RmgrTable[record->xl_rmid].rm_desc(&buf, record->xl_info, rdata->data);
V
WAL  
Vadim B. Mikheev 已提交
882
		}
883 884
		elog(LOG, "%s", buf.data);
		pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
885
	}
886
#endif
V
WAL  
Vadim B. Mikheev 已提交
887

T
Tom Lane 已提交
888 889 890 891 892
	/* Record begin of record in appropriate places */
	if (!no_tran)
		MyLastRecPtr = RecPtr;
	ProcLastRecPtr = RecPtr;
	Insert->PrevRecord = RecPtr;
893
	MyXactMadeXLogEntry = true;
T
Tom Lane 已提交
894

895
	Insert->currpos += SizeOfXLogRecord;
T
Tom Lane 已提交
896
	freespace -= SizeOfXLogRecord;
897

T
Tom Lane 已提交
898 899 900 901
	/*
	 * Append the data, including backup blocks if any
	 */
	while (write_len)
902
	{
903 904 905 906
		while (rdata->data == NULL)
			rdata = rdata->next;

		if (freespace > 0)
907
		{
908 909 910 911 912
			if (rdata->len > freespace)
			{
				memcpy(Insert->currpos, rdata->data, freespace);
				rdata->data += freespace;
				rdata->len -= freespace;
T
Tom Lane 已提交
913
				write_len -= freespace;
914 915 916 917 918
			}
			else
			{
				memcpy(Insert->currpos, rdata->data, rdata->len);
				freespace -= rdata->len;
T
Tom Lane 已提交
919
				write_len -= rdata->len;
920 921 922 923
				Insert->currpos += rdata->len;
				rdata = rdata->next;
				continue;
			}
924 925
		}

926
		/* Use next buffer */
927
		updrqst = AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
928 929 930 931 932 933
		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;
934
		freespace = INSERT_FREESPACE(Insert);
935
	}
936

T
Tom Lane 已提交
937 938
	/* Ensure next record will be properly aligned */
	Insert->currpos = (char *) Insert->currpage +
B
Bruce Momjian 已提交
939
		MAXALIGN(Insert->currpos - (char *) Insert->currpage);
T
Tom Lane 已提交
940
	freespace = INSERT_FREESPACE(Insert);
941

V
Vadim B. Mikheev 已提交
942
	/*
B
Bruce Momjian 已提交
943 944
	 * 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 已提交
945
	 */
T
Tom Lane 已提交
946
	INSERT_RECPTR(RecPtr, Insert, curridx);
V
Vadim B. Mikheev 已提交
947

948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
	/*
	 * 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 已提交
965 966
		 * Flush through the end of the page containing XLOG_SWITCH, and
		 * perform end-of-segment actions (eg, notifying archiver).
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 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
		 */
		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 */
	}
1017
	else
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
	{
		/* 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];
	}
1034

1035
	LWLockRelease(WALInsertLock);
1036 1037 1038

	if (updrqst)
	{
1039 1040 1041
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1042
		SpinLockAcquire(&xlogctl->info_lck);
T
Tom Lane 已提交
1043
		/* advance global request to include new block(s) */
1044 1045
		if (XLByteLT(xlogctl->LogwrtRqst.Write, WriteRqst))
			xlogctl->LogwrtRqst.Write = WriteRqst;
T
Tom Lane 已提交
1046
		/* update local result copy while I have the chance */
1047
		LogwrtResult = xlogctl->LogwrtResult;
1048
		SpinLockRelease(&xlogctl->info_lck);
1049 1050
	}

1051 1052
	ProcLastRecEnd = RecPtr;

1053
	END_CRIT_SECTION();
1054

1055
	return RecPtr;
1056
}
1057

1058
/*
1059 1060 1061
 * 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.
1062
 */
1063
static bool
1064
XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
1065
				XLogRecPtr *lsn, BkpBlock *bkpb)
1066 1067
{
	PageHeader	page;
1068 1069 1070 1071

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

	/*
B
Bruce Momjian 已提交
1072 1073 1074
	 * 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.
1075 1076 1077
	 */
	*lsn = page->pd_lsn;

1078
	if (doPageWrites &&
1079
		XLByteLE(page->pd_lsn, RedoRecPtr))
1080
	{
1081 1082 1083 1084 1085
		/*
		 * The page needs to be backed up, so set up *bkpb
		 */
		bkpb->node = BufferGetFileNode(rdata->buffer);
		bkpb->block = BufferGetBlockNumber(rdata->buffer);
1086

1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
		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;
		}
1113

1114
		return true;			/* buffer requires backup */
1115
	}
1116 1117

	return false;				/* buffer does not need to be backed up */
1118 1119
}

1120 1121 1122 1123 1124 1125
/*
 * XLogArchiveNotify
 *
 * Create an archive notification file
 *
 * The name of the notification file is the message that will be picked up
1126
 * by the archiver, e.g. we write 0000000100000001000000C6.ready
1127
 * and the archiver then knows to archive XLOGDIR/0000000100000001000000C6,
1128
 * then when complete, rename it to 0000000100000001000000C6.done
1129 1130 1131 1132 1133
 */
static void
XLogArchiveNotify(const char *xlog)
{
	char		archiveStatusPath[MAXPGPATH];
B
Bruce Momjian 已提交
1134
	FILE	   *fd;
1135 1136 1137 1138

	/* insert an otherwise empty file called <XLOG>.ready */
	StatusFilePath(archiveStatusPath, xlog, ".ready");
	fd = AllocateFile(archiveStatusPath, "w");
B
Bruce Momjian 已提交
1139 1140
	if (fd == NULL)
	{
1141 1142 1143 1144 1145 1146
		ereport(LOG,
				(errcode_for_file_access(),
				 errmsg("could not create archive status file \"%s\": %m",
						archiveStatusPath)));
		return;
	}
B
Bruce Momjian 已提交
1147 1148
	if (FreeFile(fd))
	{
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
		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];

1169
	XLogFileName(xlog, ThisTimeLineID, log, seg);
1170 1171 1172 1173
	XLogArchiveNotify(xlog);
}

/*
1174
 * XLogArchiveCheckDone
1175
 *
1176 1177 1178 1179
 * 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.
1180 1181
 *
 * If <XLOG>.done exists, then return true; else if <XLOG>.ready exists,
1182 1183 1184 1185
 * 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.
1186 1187
 */
static bool
1188
XLogArchiveCheckDone(const char *xlog)
1189 1190 1191 1192
{
	char		archiveStatusPath[MAXPGPATH];
	struct stat stat_buf;

1193 1194 1195 1196 1197
	/* Always deletable if archiving is off */
	if (!XLogArchivingActive())
		return true;

	/* First check for .done --- this means archiver is done with it */
1198 1199 1200 1201 1202 1203 1204
	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 已提交
1205
		return false;
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219

	/* 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
 *
1220
 * Cleanup archive notification file(s) for a particular xlog segment
1221 1222 1223 1224
 */
static void
XLogArchiveCleanup(const char *xlog)
{
B
Bruce Momjian 已提交
1225
	char		archiveStatusPath[MAXPGPATH];
1226

1227
	/* Remove the .done file */
1228 1229 1230
	StatusFilePath(archiveStatusPath, xlog, ".done");
	unlink(archiveStatusPath);
	/* should we complain about failure? */
1231 1232 1233 1234 1235

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

T
Tom Lane 已提交
1238 1239 1240 1241
/*
 * Advance the Insert state to the next buffer page, writing out the next
 * buffer if it still contains unwritten data.
 *
1242 1243 1244 1245
 * 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 已提交
1246
 * The global LogwrtRqst.Write pointer needs to be advanced to include the
1247
 * just-filled page.  If we can do this for free (without an extra lock),
T
Tom Lane 已提交
1248 1249 1250
 * 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.
 *
1251
 * Must be called with WALInsertLock held.
T
Tom Lane 已提交
1252 1253
 */
static bool
1254
AdvanceXLInsertBuffer(bool new_segment)
1255
{
T
Tom Lane 已提交
1256 1257
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogCtlWrite *Write = &XLogCtl->Write;
1258
	int			nextidx = NextBufIdx(Insert->curridx);
T
Tom Lane 已提交
1259 1260 1261
	bool		update_needed = true;
	XLogRecPtr	OldPageRqstPtr;
	XLogwrtRqst WriteRqst;
1262 1263
	XLogRecPtr	NewPageEndPtr;
	XLogPageHeader NewPage;
1264

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

T
Tom Lane 已提交
1269
	/*
B
Bruce Momjian 已提交
1270 1271 1272
	 * 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 已提交
1273 1274 1275 1276 1277 1278
	 */
	OldPageRqstPtr = XLogCtl->xlblocks[nextidx];
	if (!XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
	{
		/* nope, got work to do... */
		XLogRecPtr	FinishedPageRqstPtr;
1279

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

1282
		/* Before waiting, get info_lck and update LogwrtResult */
1283 1284 1285 1286
		{
			/* use volatile pointer to prevent code rearrangement */
			volatile XLogCtlData *xlogctl = XLogCtl;

1287
			SpinLockAcquire(&xlogctl->info_lck);
1288 1289 1290
			if (XLByteLT(xlogctl->LogwrtRqst.Write, FinishedPageRqstPtr))
				xlogctl->LogwrtRqst.Write = FinishedPageRqstPtr;
			LogwrtResult = xlogctl->LogwrtResult;
1291
			SpinLockRelease(&xlogctl->info_lck);
1292
		}
1293 1294 1295 1296 1297 1298 1299 1300 1301

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

		if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
		{
			/* OK, someone wrote it already */
			Insert->LogwrtResult = LogwrtResult;
		}
		else
1302
		{
1303 1304 1305 1306
			/* Must acquire write lock */
			LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
			LogwrtResult = Write->LogwrtResult;
			if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
1307
			{
1308 1309 1310
				/* OK, someone wrote it already */
				LWLockRelease(WALWriteLock);
				Insert->LogwrtResult = LogwrtResult;
T
Tom Lane 已提交
1311
			}
1312
			else
T
Tom Lane 已提交
1313 1314
			{
				/*
B
Bruce Momjian 已提交
1315 1316
				 * Have to write buffers while holding insert lock. This is
				 * not good, so only write as much as we absolutely must.
T
Tom Lane 已提交
1317 1318 1319 1320
				 */
				WriteRqst.Write = OldPageRqstPtr;
				WriteRqst.Flush.xlogid = 0;
				WriteRqst.Flush.xrecoff = 0;
1321
				XLogWrite(WriteRqst, false, false);
1322
				LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1323
				Insert->LogwrtResult = LogwrtResult;
1324 1325 1326 1327
			}
		}
	}

T
Tom Lane 已提交
1328
	/*
B
Bruce Momjian 已提交
1329 1330
	 * Now the next buffer slot is free and we can set it up to be the next
	 * output page.
T
Tom Lane 已提交
1331
	 */
1332
	NewPageEndPtr = XLogCtl->xlblocks[Insert->curridx];
1333 1334 1335 1336 1337 1338 1339 1340

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

1341
	if (NewPageEndPtr.xrecoff >= XLogFileSize)
1342
	{
T
Tom Lane 已提交
1343
		/* crossing a logid boundary */
1344
		NewPageEndPtr.xlogid += 1;
1345
		NewPageEndPtr.xrecoff = XLOG_BLCKSZ;
1346
	}
T
Tom Lane 已提交
1347
	else
1348
		NewPageEndPtr.xrecoff += XLOG_BLCKSZ;
1349
	XLogCtl->xlblocks[nextidx] = NewPageEndPtr;
1350
	NewPage = (XLogPageHeader) (XLogCtl->pages + nextidx * (Size) XLOG_BLCKSZ);
B
Bruce Momjian 已提交
1351

T
Tom Lane 已提交
1352
	Insert->curridx = nextidx;
1353
	Insert->currpage = NewPage;
B
Bruce Momjian 已提交
1354 1355

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

T
Tom Lane 已提交
1357
	/*
B
Bruce Momjian 已提交
1358 1359
	 * 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 已提交
1360
	 */
1361
	MemSet((char *) NewPage, 0, XLOG_BLCKSZ);
1362

1363 1364 1365
	/*
	 * Fill the new page's header
	 */
B
Bruce Momjian 已提交
1366 1367
	NewPage   ->xlp_magic = XLOG_PAGE_MAGIC;

1368
	/* NewPage->xlp_info = 0; */	/* done by memset */
B
Bruce Momjian 已提交
1369 1370
	NewPage   ->xlp_tli = ThisTimeLineID;
	NewPage   ->xlp_pageaddr.xlogid = NewPageEndPtr.xlogid;
1371
	NewPage   ->xlp_pageaddr.xrecoff = NewPageEndPtr.xrecoff - XLOG_BLCKSZ;
T
Tom Lane 已提交
1372

1373
	/*
1374
	 * If first page of an XLOG segment file, make it a long header.
1375 1376 1377
	 */
	if ((NewPage->xlp_pageaddr.xrecoff % XLogSegSize) == 0)
	{
1378
		XLogLongPageHeader NewLongPage = (XLogLongPageHeader) NewPage;
1379

1380 1381
		NewLongPage->xlp_sysid = ControlFile->system_identifier;
		NewLongPage->xlp_seg_size = XLogSegSize;
1382
		NewLongPage->xlp_xlog_blcksz = XLOG_BLCKSZ;
B
Bruce Momjian 已提交
1383 1384 1385
		NewPage   ->xlp_info |= XLP_LONG_HEADER;

		Insert->currpos = ((char *) NewPage) +SizeOfXLogLongPHD;
1386 1387
	}

T
Tom Lane 已提交
1388
	return update_needed;
1389 1390
}

T
Tom Lane 已提交
1391 1392 1393
/*
 * Write and/or fsync the log at least as far as WriteRqst indicates.
 *
1394 1395 1396 1397 1398
 * 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.
 *
1399 1400 1401 1402 1403 1404
 * 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.)
 *
1405
 * Must be called with WALWriteLock held.
T
Tom Lane 已提交
1406
 */
1407
static void
1408
XLogWrite(XLogwrtRqst WriteRqst, bool flexible, bool xlog_switch)
1409
{
1410
	XLogCtlWrite *Write = &XLogCtl->Write;
T
Tom Lane 已提交
1411
	bool		ispartialpage;
1412
	bool		last_iteration;
1413
	bool		finishing_seg;
1414
	bool		use_existent;
1415 1416 1417 1418
	int			curridx;
	int			npages;
	int			startidx;
	uint32		startoffset;
1419

1420 1421 1422
	/* We should always be inside a critical section here */
	Assert(CritSectionCount > 0);

B
Bruce Momjian 已提交
1423
	/*
B
Bruce Momjian 已提交
1424
	 * Update local LogwrtResult (caller probably did this already, but...)
B
Bruce Momjian 已提交
1425
	 */
T
Tom Lane 已提交
1426 1427
	LogwrtResult = Write->LogwrtResult;

1428 1429 1430
	/*
	 * Since successive pages in the xlog cache are consecutively allocated,
	 * we can usually gather multiple pages together and issue just one
B
Bruce Momjian 已提交
1431 1432 1433 1434 1435
	 * 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.
1436 1437 1438 1439 1440 1441 1442 1443 1444
	 */
	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 已提交
1445 1446
	 * going to PANIC if any error occurs anyway; but someday it may come in
	 * useful.)
1447 1448
	 */
	curridx = Write->curridx;
B
 
Bruce Momjian 已提交
1449

T
Tom Lane 已提交
1450
	while (XLByteLT(LogwrtResult.Write, WriteRqst.Write))
1451
	{
1452
		/*
B
Bruce Momjian 已提交
1453 1454 1455
		 * 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.
1456
		 */
1457
		if (!XLByteLT(LogwrtResult.Write, XLogCtl->xlblocks[curridx]))
1458
			elog(PANIC, "xlog write request %X/%X is past end of log %X/%X",
1459
				 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
1460 1461
				 XLogCtl->xlblocks[curridx].xlogid,
				 XLogCtl->xlblocks[curridx].xrecoff);
1462

T
Tom Lane 已提交
1463
		/* Advance LogwrtResult.Write to end of current buffer page */
1464
		LogwrtResult.Write = XLogCtl->xlblocks[curridx];
T
Tom Lane 已提交
1465 1466 1467
		ispartialpage = XLByteLT(WriteRqst.Write, LogwrtResult.Write);

		if (!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1468
		{
T
Tom Lane 已提交
1469
			/*
1470 1471
			 * Switch to new logfile segment.  We cannot have any pending
			 * pages here (since we dump what we have at segment end).
T
Tom Lane 已提交
1472
			 */
1473
			Assert(npages == 0);
T
Tom Lane 已提交
1474
			if (openLogFile >= 0)
1475
				XLogFileClose();
T
Tom Lane 已提交
1476 1477
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);

1478 1479 1480 1481
			/* create/use new log file */
			use_existent = true;
			openLogFile = XLogFileInit(openLogId, openLogSeg,
									   &use_existent, true);
T
Tom Lane 已提交
1482
			openLogOff = 0;
1483 1484
		}

1485
		/* Make sure we have the current logfile open */
T
Tom Lane 已提交
1486
		if (openLogFile < 0)
1487
		{
T
Tom Lane 已提交
1488
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1489
			openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
1490
			openLogOff = 0;
1491 1492
		}

1493 1494 1495 1496 1497
		/* Add current page to the set of pending pages-to-dump */
		if (npages == 0)
		{
			/* first of group */
			startidx = curridx;
1498
			startoffset = (LogwrtResult.Write.xrecoff - XLOG_BLCKSZ) % XLogSegSize;
1499 1500
		}
		npages++;
1501

T
Tom Lane 已提交
1502
		/*
B
Bruce Momjian 已提交
1503 1504 1505 1506
		 * 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 已提交
1507
		 */
1508 1509
		last_iteration = !XLByteLT(LogwrtResult.Write, WriteRqst.Write);

1510
		finishing_seg = !ispartialpage &&
1511
			(startoffset + npages * XLOG_BLCKSZ) >= XLogSegSize;
1512

1513
		if (last_iteration ||
1514 1515
			curridx == XLogCtl->XLogCacheBlck ||
			finishing_seg)
T
Tom Lane 已提交
1516
		{
1517 1518
			char	   *from;
			Size		nbytes;
1519

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

				if (XLogArchivingActive())
					XLogArchiveNotifySeg(openLogId, openLogSeg);
1577 1578

				Write->lastSegSwitchTime = time(NULL);
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613

				/*
				 * 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);
					}
				}
1614
			}
T
Tom Lane 已提交
1615
		}
1616

T
Tom Lane 已提交
1617 1618 1619 1620 1621 1622
		if (ispartialpage)
		{
			/* Only asked to write a partial page */
			LogwrtResult.Write = WriteRqst.Write;
			break;
		}
1623 1624 1625 1626 1627
		curridx = NextBufIdx(curridx);

		/* If flexible, break out of loop as soon as we wrote something */
		if (flexible && npages == 0)
			break;
1628
	}
1629 1630 1631

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

T
Tom Lane 已提交
1633 1634 1635 1636 1637
	/*
	 * If asked to flush, do so
	 */
	if (XLByteLT(LogwrtResult.Flush, WriteRqst.Flush) &&
		XLByteLT(LogwrtResult.Flush, LogwrtResult.Write))
1638
	{
T
Tom Lane 已提交
1639
		/*
B
Bruce Momjian 已提交
1640 1641 1642
		 * 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 已提交
1643
		 */
1644
		if (sync_method != SYNC_METHOD_OPEN)
T
Tom Lane 已提交
1645
		{
1646
			if (openLogFile >= 0 &&
B
Bruce Momjian 已提交
1647
				!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1648
				XLogFileClose();
1649 1650 1651
			if (openLogFile < 0)
			{
				XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1652
				openLogFile = XLogFileOpen(openLogId, openLogSeg);
1653 1654 1655
				openLogOff = 0;
			}
			issue_xlog_fsync();
T
Tom Lane 已提交
1656 1657
		}
		LogwrtResult.Flush = LogwrtResult.Write;
1658 1659
	}

T
Tom Lane 已提交
1660 1661 1662
	/*
	 * Update shared-memory status
	 *
B
Bruce Momjian 已提交
1663
	 * We make sure that the shared 'request' values do not fall behind the
B
Bruce Momjian 已提交
1664 1665
	 * 'result' values.  This is not absolutely essential, but it saves some
	 * code in a couple of places.
T
Tom Lane 已提交
1666
	 */
1667 1668 1669 1670
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1671
		SpinLockAcquire(&xlogctl->info_lck);
1672 1673 1674 1675 1676
		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;
1677
		SpinLockRelease(&xlogctl->info_lck);
1678
	}
1679

T
Tom Lane 已提交
1680 1681 1682 1683 1684 1685
	Write->LogwrtResult = LogwrtResult;
}

/*
 * Ensure that all XLOG data through the given position is flushed to disk.
 *
1686
 * NOTE: this differs from XLogWrite mainly in that the WALWriteLock is not
T
Tom Lane 已提交
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
 * 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;

1703
#ifdef WAL_DEBUG
1704
	if (XLOG_DEBUG)
1705
		elog(LOG, "xlog flush request %X/%X; write %X/%X; flush %X/%X",
1706 1707 1708
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1709
#endif
1710

T
Tom Lane 已提交
1711 1712 1713 1714
	START_CRIT_SECTION();

	/*
	 * Since fsync is usually a horribly expensive operation, we try to
B
Bruce Momjian 已提交
1715 1716 1717 1718
	 * 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 已提交
1719 1720 1721 1722 1723
	 */

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

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

1729
		SpinLockAcquire(&xlogctl->info_lck);
1730 1731 1732
		if (XLByteLT(WriteRqstPtr, xlogctl->LogwrtRqst.Write))
			WriteRqstPtr = xlogctl->LogwrtRqst.Write;
		LogwrtResult = xlogctl->LogwrtResult;
1733
		SpinLockRelease(&xlogctl->info_lck);
1734
	}
1735 1736 1737

	/* done already? */
	if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1738
	{
1739 1740 1741 1742
		/* now wait for the write lock */
		LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
		LogwrtResult = XLogCtl->Write.LogwrtResult;
		if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1743
		{
1744 1745 1746 1747 1748 1749
			/* 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 已提交
1750
				if (freespace < SizeOfXLogRecord)		/* buffer is full */
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765
					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;
			}
1766
			XLogWrite(WriteRqst, false, false);
T
Tom Lane 已提交
1767
		}
1768
		LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1769 1770 1771
	}

	END_CRIT_SECTION();
1772 1773 1774

	/*
	 * If we still haven't flushed to the request point then we have a
B
Bruce Momjian 已提交
1775 1776
	 * 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.
1777
	 *
1778 1779 1780 1781 1782 1783 1784 1785 1786
	 * 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.)
1787
	 *
1788 1789 1790 1791
	 * 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 已提交
1792 1793
	 * 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.
1794 1795
	 */
	if (XLByteLT(LogwrtResult.Flush, record))
B
Bruce Momjian 已提交
1796
		elog(InRecovery ? WARNING : ERROR,
B
Bruce Momjian 已提交
1797
		"xlog flush request %X/%X is not satisfied --- flushed only to %X/%X",
1798 1799
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1800 1801
}

1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
/*
 * Test whether XLOG data has been flushed up to (at least) the given position.
 *
 * Returns true if a flush is still needed.  (It may be that someone else
 * is already in process of flushing that far, however.)
 */
bool
XLogNeedsFlush(XLogRecPtr record)
{
	/* Quick exit if already known flushed */
	if (XLByteLE(record, LogwrtResult.Flush))
		return false;

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

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

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

	return true;
}

T
Tom Lane 已提交
1832 1833 1834
/*
 * Create a new XLOG file segment, or open a pre-existing one.
 *
1835 1836 1837
 * log, seg: identify segment to be created/opened.
 *
 * *use_existent: if TRUE, OK to use a pre-existing file (else, any
B
Bruce Momjian 已提交
1838
 * pre-existing file will be deleted).	On return, TRUE if a pre-existing
1839 1840
 * file was used.
 *
1841
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
1842
 * place.  This should be TRUE except during bootstrap log creation.  The
1843
 * caller must *not* hold the lock at call.
1844
 *
T
Tom Lane 已提交
1845
 * Returns FD of opened file.
1846 1847 1848 1849 1850
 *
 * 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 已提交
1851
 */
1852
static int
1853 1854
XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock)
1855
{
1856
	char		path[MAXPGPATH];
1857
	char		tmppath[MAXPGPATH];
1858
	char		zbuffer[XLOG_BLCKSZ];
1859 1860 1861
	uint32		installed_log;
	uint32		installed_seg;
	int			max_advance;
1862
	int			fd;
1863
	int			nbytes;
1864

1865
	XLogFilePath(path, ThisTimeLineID, log, seg);
V
Vadim B. Mikheev 已提交
1866 1867

	/*
B
Bruce Momjian 已提交
1868
	 * Try to use existent file (checkpoint maker may have created it already)
V
Vadim B. Mikheev 已提交
1869
	 */
1870
	if (*use_existent)
V
Vadim B. Mikheev 已提交
1871
	{
1872 1873
		fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
						   S_IRUSR | S_IWUSR);
V
Vadim B. Mikheev 已提交
1874 1875 1876
		if (fd < 0)
		{
			if (errno != ENOENT)
1877
				ereport(ERROR,
1878
						(errcode_for_file_access(),
1879
						 errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
1880
								path, log, seg)));
V
Vadim B. Mikheev 已提交
1881 1882
		}
		else
1883
			return fd;
V
Vadim B. Mikheev 已提交
1884 1885
	}

1886
	/*
B
Bruce Momjian 已提交
1887 1888 1889 1890
	 * 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.
1891
	 */
1892
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
1893 1894

	unlink(tmppath);
1895

1896
	/* do not use XLOG_SYNC_BIT here --- want to fsync only at end of fill */
1897
	fd = BasicOpenFile(tmppath, O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
T
Tom Lane 已提交
1898
					   S_IRUSR | S_IWUSR);
1899
	if (fd < 0)
1900
		ereport(ERROR,
1901
				(errcode_for_file_access(),
1902
				 errmsg("could not create file \"%s\": %m", tmppath)));
1903

1904
	/*
B
Bruce Momjian 已提交
1905 1906 1907 1908 1909 1910 1911
	 * 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.
1912 1913 1914 1915
	 */
	MemSet(zbuffer, 0, sizeof(zbuffer));
	for (nbytes = 0; nbytes < XLogSegSize; nbytes += sizeof(zbuffer))
	{
1916
		errno = 0;
1917
		if ((int) write(fd, zbuffer, sizeof(zbuffer)) != (int) sizeof(zbuffer))
T
Tom Lane 已提交
1918
		{
B
Bruce Momjian 已提交
1919
			int			save_errno = errno;
T
Tom Lane 已提交
1920

B
Bruce Momjian 已提交
1921
			/*
B
Bruce Momjian 已提交
1922
			 * If we fail to make the file, delete it to release disk space
B
Bruce Momjian 已提交
1923
			 */
1924
			unlink(tmppath);
1925 1926
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;
T
Tom Lane 已提交
1927

1928
			ereport(ERROR,
1929
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
1930
					 errmsg("could not write to file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
1931
		}
1932
	}
1933

1934
	if (pg_fsync(fd) != 0)
1935
		ereport(ERROR,
1936
				(errcode_for_file_access(),
1937
				 errmsg("could not fsync file \"%s\": %m", tmppath)));
1938

1939
	if (close(fd))
1940
		ereport(ERROR,
1941 1942
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
1943

1944
	/*
1945 1946
	 * Now move the segment into place with its final name.
	 *
1947
	 * If caller didn't want to use a pre-existing file, get rid of any
B
Bruce Momjian 已提交
1948 1949 1950
	 * 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.
1951
	 */
1952 1953 1954 1955 1956
	installed_log = log;
	installed_seg = seg;
	max_advance = XLOGfileslop;
	if (!InstallXLogFileSegment(&installed_log, &installed_seg, tmppath,
								*use_existent, &max_advance,
1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
								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)
1970
		ereport(ERROR,
1971
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
1972 1973
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
1974

1975
	return fd;
1976 1977
}

1978 1979 1980 1981 1982 1983 1984 1985 1986
/*
 * 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 已提交
1987
 * considerations.	But we should be just as tense as XLogFileInit to avoid
1988 1989 1990 1991 1992 1993 1994 1995
 * emplacing a bogus file.
 */
static void
XLogFileCopy(uint32 log, uint32 seg,
			 TimeLineID srcTLI, uint32 srclog, uint32 srcseg)
{
	char		path[MAXPGPATH];
	char		tmppath[MAXPGPATH];
1996
	char		buffer[XLOG_BLCKSZ];
1997 1998 1999 2000 2001 2002 2003 2004 2005 2006
	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)
2007
		ereport(ERROR,
2008 2009 2010 2011 2012 2013
				(errcode_for_file_access(),
				 errmsg("could not open file \"%s\": %m", path)));

	/*
	 * Copy into a temp file name.
	 */
2014
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
2015 2016 2017 2018 2019 2020 2021

	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)
2022
		ereport(ERROR,
2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034
				(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)
2035
				ereport(ERROR,
2036 2037 2038
						(errcode_for_file_access(),
						 errmsg("could not read file \"%s\": %m", path)));
			else
2039
				ereport(ERROR,
B
Bruce Momjian 已提交
2040
						(errmsg("not enough data in file \"%s\"", path)));
2041 2042 2043 2044 2045 2046 2047
		}
		errno = 0;
		if ((int) write(fd, buffer, sizeof(buffer)) != (int) sizeof(buffer))
		{
			int			save_errno = errno;

			/*
B
Bruce Momjian 已提交
2048
			 * If we fail to make the file, delete it to release disk space
2049 2050 2051 2052 2053
			 */
			unlink(tmppath);
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;

2054
			ereport(ERROR,
2055
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2056
					 errmsg("could not write to file \"%s\": %m", tmppath)));
2057 2058 2059 2060
		}
	}

	if (pg_fsync(fd) != 0)
2061
		ereport(ERROR,
2062 2063 2064 2065
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

	if (close(fd))
2066
		ereport(ERROR,
2067 2068 2069 2070 2071 2072 2073 2074
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));

	close(srcfd);

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

2079 2080 2081 2082 2083 2084
/*
 * 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.
 *
2085 2086 2087
 * *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.
2088 2089 2090 2091 2092 2093 2094
 *
 * 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.
 *
2095 2096 2097 2098
 * *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.)
2099
 *
2100
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
2101
 * place.  This should be TRUE except during bootstrap log creation.  The
2102
 * caller must *not* hold the lock at call.
2103 2104
 *
 * Returns TRUE if file installed, FALSE if not installed because of
2105 2106 2107
 * 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().)
2108 2109
 */
static bool
2110 2111
InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
2112 2113 2114
					   bool use_lock)
{
	char		path[MAXPGPATH];
2115
	struct stat stat_buf;
2116

2117
	XLogFilePath(path, ThisTimeLineID, *log, *seg);
2118 2119 2120 2121 2122

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

2125 2126 2127 2128 2129
	if (!find_free)
	{
		/* Force installation: get rid of any pre-existing segment file */
		unlink(path);
	}
2130 2131
	else
	{
2132
		/* Find a free slot to put it in */
2133
		while (stat(path, &stat_buf) == 0)
2134
		{
2135
			if (*max_advance <= 0)
2136 2137 2138
			{
				/* Failed to find a free slot within specified range */
				if (use_lock)
2139
					LWLockRelease(ControlFileLock);
2140 2141
				return false;
			}
2142 2143 2144
			NextLogSeg(*log, *seg);
			(*max_advance)--;
			XLogFilePath(path, ThisTimeLineID, *log, *seg);
2145 2146 2147 2148 2149 2150 2151
		}
	}

	/*
	 * 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.
2152
	 */
2153
#if HAVE_WORKING_LINK
2154
	if (link(tmppath, path) < 0)
2155
		ereport(ERROR,
2156
				(errcode_for_file_access(),
2157
				 errmsg("could not link file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2158
						tmppath, path, *log, *seg)));
2159
	unlink(tmppath);
2160
#else
2161
	if (rename(tmppath, path) < 0)
2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175
	{
#ifdef WIN32
#if !defined(__CYGWIN__)
		if (GetLastError() == ERROR_ACCESS_DENIED)
#else
		if (errno == EACCES)
#endif
		{
			if (use_lock)
				LWLockRelease(ControlFileLock);
			return false;
		}
#endif /* WIN32 */

2176
		ereport(ERROR,
2177
				(errcode_for_file_access(),
2178
				 errmsg("could not rename file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2179
						tmppath, path, *log, *seg)));
2180
	}
2181
#endif
V
Vadim B. Mikheev 已提交
2182

2183
	if (use_lock)
2184
		LWLockRelease(ControlFileLock);
2185

2186
	return true;
2187 2188
}

T
Tom Lane 已提交
2189
/*
2190
 * Open a pre-existing logfile segment for writing.
T
Tom Lane 已提交
2191
 */
2192
static int
2193
XLogFileOpen(uint32 log, uint32 seg)
2194
{
2195 2196
	char		path[MAXPGPATH];
	int			fd;
2197

2198
	XLogFilePath(path, ThisTimeLineID, log, seg);
2199

2200 2201
	fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
					   S_IRUSR | S_IWUSR);
2202
	if (fd < 0)
2203 2204
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2205 2206
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220

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

2222
	/*
B
Bruce Momjian 已提交
2223 2224
	 * Loop looking for a suitable timeline ID: we might need to read any of
	 * the timelines listed in expectedTLIs.
2225
	 *
B
Bruce Momjian 已提交
2226
	 * We expect curFileTLI on entry to be the TLI of the preceding file in
B
Bruce Momjian 已提交
2227 2228 2229 2230
	 * 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.
2231
	 */
2232 2233 2234
	foreach(cell, expectedTLIs)
	{
		TimeLineID	tli = (TimeLineID) lfirst_int(cell);
2235

2236 2237 2238 2239 2240 2241 2242
		if (tli < curFileTLI)
			break;				/* don't bother looking at too-old TLIs */

		if (InArchiveRecovery)
		{
			XLogFileName(xlogfname, tli, log, seg);
			restoredFromArchive = RestoreArchivedFile(path, xlogfname,
2243 2244
													  "RECOVERYXLOG",
													  XLogSegSize);
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
		}
		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 已提交
2259 2260
			errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				   path, log, seg)));
2261 2262 2263 2264 2265 2266 2267
	}

	/* 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 已提交
2268 2269
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2270
	return -1;
2271 2272
}

2273 2274 2275 2276 2277 2278 2279 2280
/*
 * Close the current logfile segment for writing.
 */
static void
XLogFileClose(void)
{
	Assert(openLogFile >= 0);

2281
	/*
B
Bruce Momjian 已提交
2282 2283 2284 2285 2286 2287
	 * 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.
2288 2289 2290
	 */
#ifdef NOT_USED

2291
	/*
2292
	 * WAL segment files will not be re-read in normal operation, so we advise
B
Bruce Momjian 已提交
2293
	 * OS to release any cached pages.	But do not do so if WAL archiving is
2294 2295 2296
	 * active, because archiver process could use the cache to read the WAL
	 * segment.
	 *
B
Bruce Momjian 已提交
2297 2298
	 * While O_DIRECT works for O_SYNC, posix_fadvise() works for fsync() and
	 * O_SYNC, and some platforms only have posix_fadvise().
2299
	 */
2300
#if defined(HAVE_DECL_POSIX_FADVISE) && defined(POSIX_FADV_DONTNEED)
2301 2302 2303
	if (!XLogArchivingActive())
		posix_fadvise(openLogFile, 0, 0, POSIX_FADV_DONTNEED);
#endif
B
Bruce Momjian 已提交
2304
#endif   /* NOT_USED */
2305

2306 2307
	if (close(openLogFile))
		ereport(PANIC,
B
Bruce Momjian 已提交
2308 2309 2310
				(errcode_for_file_access(),
				 errmsg("could not close log file %u, segment %u: %m",
						openLogId, openLogSeg)));
2311 2312 2313
	openLogFile = -1;
}

2314
/*
2315
 * Attempt to retrieve the specified file from off-line archival storage.
2316
 * If successful, fill "path" with its complete path (note that this will be
2317 2318
 * a temp file name that doesn't follow the normal naming convention), and
 * return TRUE.
2319
 *
2320 2321 2322
 * 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.
2323 2324 2325 2326
 *
 * 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.
2327
 */
2328 2329
static bool
RestoreArchivedFile(char *path, const char *xlogfname,
2330
					const char *recovername, off_t expectedSize)
2331
{
B
Bruce Momjian 已提交
2332 2333 2334 2335
	char		xlogpath[MAXPGPATH];
	char		xlogRestoreCmd[MAXPGPATH];
	char	   *dp;
	char	   *endp;
2336
	const char *sp;
B
Bruce Momjian 已提交
2337
	int			rc;
2338
	bool		signaled;
2339 2340 2341
	struct stat stat_buf;

	/*
B
Bruce Momjian 已提交
2342 2343 2344 2345
	 * 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.
2346
	 *
B
Bruce Momjian 已提交
2347
	 * We could try to optimize this slightly by checking the local copy
B
Bruce Momjian 已提交
2348 2349 2350 2351
	 * 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.
2352
	 *
2353 2354 2355
	 * 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.
2356
	 *
2357 2358 2359 2360
	 * 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 已提交
2361 2362
	 * copy-from-archive filename is always the same, ensuring that we don't
	 * run out of disk space on long recoveries.
2363
	 */
2364
	snprintf(xlogpath, MAXPGPATH, XLOGDIR "/%s", recovername);
2365 2366

	/*
2367
	 * Make sure there is no existing file named recovername.
2368 2369 2370 2371 2372 2373
	 */
	if (stat(xlogpath, &stat_buf) != 0)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
2374
					 errmsg("could not stat file \"%s\": %m",
2375 2376 2377 2378 2379 2380 2381
							xlogpath)));
	}
	else
	{
		if (unlink(xlogpath) != 0)
			ereport(FATAL,
					(errcode_for_file_access(),
2382
					 errmsg("could not remove file \"%s\": %m",
2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399
							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':
2400
					/* %p: relative path of target file */
2401
					sp++;
B
Bruce Momjian 已提交
2402
					StrNCpy(dp, xlogpath, endp - dp);
2403
					make_native_path(dp);
2404 2405 2406 2407 2408
					dp += strlen(dp);
					break;
				case 'f':
					/* %f: filename of desired file */
					sp++;
B
Bruce Momjian 已提交
2409
					StrNCpy(dp, xlogfname, endp - dp);
2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433
					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 已提交
2434
			(errmsg_internal("executing restore command \"%s\"",
2435 2436 2437
							 xlogRestoreCmd)));

	/*
2438
	 * Copy xlog from archival storage to XLOGDIR
2439 2440 2441 2442
	 */
	rc = system(xlogRestoreCmd);
	if (rc == 0)
	{
2443 2444 2445 2446
		/*
		 * command apparently succeeded, but let's make sure the file is
		 * really there now and has the correct size.
		 *
2447 2448 2449 2450 2451
		 * 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 ...
2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
		 */
		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 已提交
2476
						 errmsg("could not stat file \"%s\": %m",
2477
								xlogpath)));
2478 2479 2480 2481
		}
	}

	/*
2482
	 * Remember, we rollforward UNTIL the restore fails so failure here is
B
Bruce Momjian 已提交
2483
	 * just part of the process... that makes it difficult to determine
B
Bruce Momjian 已提交
2484 2485 2486
	 * 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.
2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499
	 *
	 * 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.
2500
	 */
2501 2502 2503
	signaled = WIFSIGNALED(rc) || WEXITSTATUS(rc) > 125;

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

	/*
B
Bruce Momjian 已提交
2508 2509
	 * 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.
2510
	 *
B
Bruce Momjian 已提交
2511 2512
	 * In many recovery scenarios we expect this to fail also, but if so that
	 * just means we've reached the end of WAL.
2513
	 */
2514
	snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlogfname);
2515
	return false;
2516 2517
}

V
Vadim B. Mikheev 已提交
2518
/*
T
Tom Lane 已提交
2519 2520 2521
 * Preallocate log files beyond the specified log endpoint, according to
 * the XLOGfile user parameter.
 */
2522
static int
T
Tom Lane 已提交
2523 2524
PreallocXlogFiles(XLogRecPtr endptr)
{
2525
	int			nsegsadded = 0;
T
Tom Lane 已提交
2526 2527 2528
	uint32		_logId;
	uint32		_logSeg;
	int			lf;
2529
	bool		use_existent;
T
Tom Lane 已提交
2530 2531

	XLByteToPrevSeg(endptr, _logId, _logSeg);
B
Bruce Momjian 已提交
2532
	if ((endptr.xrecoff - 1) % XLogSegSize >=
B
Bruce Momjian 已提交
2533
		(uint32) (0.75 * XLogSegSize))
T
Tom Lane 已提交
2534 2535
	{
		NextLogSeg(_logId, _logSeg);
2536 2537
		use_existent = true;
		lf = XLogFileInit(_logId, _logSeg, &use_existent, true);
T
Tom Lane 已提交
2538
		close(lf);
2539 2540
		if (!use_existent)
			nsegsadded++;
T
Tom Lane 已提交
2541
	}
2542
	return nsegsadded;
T
Tom Lane 已提交
2543 2544 2545 2546
}

/*
 * Remove or move offline all log files older or equal to passed log/seg#
2547 2548 2549
 *
 * 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 已提交
2550 2551
 */
static void
2552 2553
MoveOfflineLogs(uint32 log, uint32 seg, XLogRecPtr endptr,
				int *nsegsremoved, int *nsegsrecycled)
V
Vadim B. Mikheev 已提交
2554
{
2555 2556
	uint32		endlogId;
	uint32		endlogSeg;
2557
	int			max_advance;
B
Bruce Momjian 已提交
2558 2559
	DIR		   *xldir;
	struct dirent *xlde;
2560
	char		lastoff[MAXFNAMELEN];
B
Bruce Momjian 已提交
2561
	char		path[MAXPGPATH];
V
Vadim B. Mikheev 已提交
2562

2563 2564 2565
	*nsegsremoved = 0;
	*nsegsrecycled = 0;

2566 2567 2568 2569
	/*
	 * Initialize info about where to try to recycle to.  We allow recycling
	 * segments up to XLOGfileslop segments beyond the current XLOG location.
	 */
2570
	XLByteToPrevSeg(endptr, endlogId, endlogSeg);
2571
	max_advance = XLOGfileslop;
V
Vadim B. Mikheev 已提交
2572

2573
	xldir = AllocateDir(XLOGDIR);
V
Vadim B. Mikheev 已提交
2574
	if (xldir == NULL)
2575
		ereport(ERROR,
2576
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2577 2578
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
V
Vadim B. Mikheev 已提交
2579

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

2582
	while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
V
Vadim B. Mikheev 已提交
2583
	{
2584
		/*
2585
		 * We ignore the timeline part of the XLOG segment identifiers in
B
Bruce Momjian 已提交
2586 2587 2588 2589 2590
		 * 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.
2591
		 *
B
Bruce Momjian 已提交
2592 2593
		 * We use the alphanumeric sorting property of the filenames to decide
		 * which ones are earlier than the lastoff segment.
2594
		 */
2595 2596 2597
		if (strlen(xlde->d_name) == 24 &&
			strspn(xlde->d_name, "0123456789ABCDEF") == 24 &&
			strcmp(xlde->d_name + 8, lastoff + 8) <= 0)
V
Vadim B. Mikheev 已提交
2598
		{
2599
			if (XLogArchiveCheckDone(xlde->d_name))
2600
			{
2601
				snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlde->d_name);
2602

2603
				/*
B
Bruce Momjian 已提交
2604 2605
				 * Before deleting the file, see if it can be recycled as a
				 * future log segment.
2606
				 */
2607 2608
				if (InstallXLogFileSegment(&endlogId, &endlogSeg, path,
										   true, &max_advance,
2609 2610
										   true))
				{
2611
					ereport(DEBUG2,
B
Bruce Momjian 已提交
2612 2613
							(errmsg("recycled transaction log file \"%s\"",
									xlde->d_name)));
2614
					(*nsegsrecycled)++;
2615 2616 2617 2618 2619 2620
					/* Needn't recheck that slot on future iterations */
					if (max_advance > 0)
					{
						NextLogSeg(endlogId, endlogSeg);
						max_advance--;
					}
2621 2622 2623 2624
				}
				else
				{
					/* No need for any more future segments... */
2625
					ereport(DEBUG2,
B
Bruce Momjian 已提交
2626 2627
							(errmsg("removing transaction log file \"%s\"",
									xlde->d_name)));
2628
					unlink(path);
2629
					(*nsegsremoved)++;
2630
				}
2631 2632

				XLogArchiveCleanup(xlde->d_name);
2633
			}
V
Vadim B. Mikheev 已提交
2634 2635
		}
	}
B
Bruce Momjian 已提交
2636

2637
	FreeDir(xldir);
V
Vadim B. Mikheev 已提交
2638 2639
}

2640
/*
2641 2642 2643
 * Remove previous backup history files.  This also retries creation of
 * .ready files for any backup history files for which XLogArchiveNotify
 * failed earlier.
2644 2645
 */
static void
2646
CleanupBackupHistory(void)
2647 2648 2649 2650 2651
{
	DIR		   *xldir;
	struct dirent *xlde;
	char		path[MAXPGPATH];

2652
	xldir = AllocateDir(XLOGDIR);
2653 2654 2655
	if (xldir == NULL)
		ereport(ERROR,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2656 2657
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
2658

2659
	while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
2660 2661 2662 2663 2664 2665
	{
		if (strlen(xlde->d_name) > 24 &&
			strspn(xlde->d_name, "0123456789ABCDEF") == 24 &&
			strcmp(xlde->d_name + strlen(xlde->d_name) - strlen(".backup"),
				   ".backup") == 0)
		{
2666
			if (XLogArchiveCheckDone(xlde->d_name))
2667 2668
			{
				ereport(DEBUG2,
B
Bruce Momjian 已提交
2669 2670
				(errmsg("removing transaction log backup history file \"%s\"",
						xlde->d_name)));
2671
				snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlde->d_name);
2672 2673 2674 2675 2676 2677 2678 2679 2680
				unlink(path);
				XLogArchiveCleanup(xlde->d_name);
			}
		}
	}

	FreeDir(xldir);
}

T
Tom Lane 已提交
2681 2682 2683 2684
/*
 * Restore the backup blocks present in an XLOG record, if any.
 *
 * We assume all of the record has been read into memory at *record.
2685 2686 2687 2688 2689 2690 2691 2692 2693
 *
 * 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 已提交
2694
 */
2695 2696 2697 2698 2699 2700 2701 2702 2703 2704
static void
RestoreBkpBlocks(XLogRecord *record, XLogRecPtr lsn)
{
	Relation	reln;
	Buffer		buffer;
	Page		page;
	BkpBlock	bkpb;
	char	   *blk;
	int			i;

B
Bruce Momjian 已提交
2705
	blk = (char *) XLogRecGetData(record) + record->xl_len;
T
Tom Lane 已提交
2706
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2707
	{
T
Tom Lane 已提交
2708
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2709 2710
			continue;

2711
		memcpy(&bkpb, blk, sizeof(BkpBlock));
2712 2713
		blk += sizeof(BkpBlock);

2714
		reln = XLogOpenRelation(bkpb.node);
2715 2716 2717
		buffer = XLogReadBuffer(reln, bkpb.block, true);
		Assert(BufferIsValid(buffer));
		page = (Page) BufferGetPage(buffer);
2718

2719
		if (bkpb.hole_length == 0)
2720
		{
2721 2722 2723 2724 2725 2726 2727 2728 2729 2730
			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));
2731 2732
		}

2733 2734
		PageSetLSN(page, lsn);
		PageSetTLI(page, ThisTimeLineID);
2735 2736
		MarkBufferDirty(buffer);
		UnlockReleaseBuffer(buffer);
2737

2738
		blk += BLCKSZ - bkpb.hole_length;
2739 2740 2741
	}
}

T
Tom Lane 已提交
2742 2743 2744 2745 2746 2747 2748
/*
 * 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.
 */
2749 2750 2751
static bool
RecordIsValid(XLogRecord *record, XLogRecPtr recptr, int emode)
{
2752
	pg_crc32	crc;
2753 2754
	int			i;
	uint32		len = record->xl_len;
2755
	BkpBlock	bkpb;
2756 2757
	char	   *blk;

2758 2759 2760
	/* First the rmgr data */
	INIT_CRC32(crc);
	COMP_CRC32(crc, XLogRecGetData(record), len);
2761

2762
	/* Add in the backup blocks, if any */
B
Bruce Momjian 已提交
2763
	blk = (char *) XLogRecGetData(record) + len;
T
Tom Lane 已提交
2764
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2765
	{
B
Bruce Momjian 已提交
2766
		uint32		blen;
2767

T
Tom Lane 已提交
2768
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2769 2770
			continue;

2771 2772
		memcpy(&bkpb, blk, sizeof(BkpBlock));
		if (bkpb.hole_offset + bkpb.hole_length > BLCKSZ)
2773
		{
2774
			ereport(emode,
2775 2776 2777
					(errmsg("incorrect hole size in record at %X/%X",
							recptr.xlogid, recptr.xrecoff)));
			return false;
2778
		}
2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800
		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 已提交
2801 2802
		(errmsg("incorrect resource manager data checksum in record at %X/%X",
				recptr.xlogid, recptr.xrecoff)));
2803
		return false;
2804 2805
	}

2806
	return true;
2807 2808
}

T
Tom Lane 已提交
2809 2810 2811 2812 2813 2814
/*
 * 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.
 *
2815 2816
 * If no valid record is available, returns NULL, or fails if emode is PANIC.
 * (emode must be either PANIC or LOG.)
T
Tom Lane 已提交
2817
 *
2818 2819
 * The record is copied into readRecordBuf, so that on successful return,
 * the returned record pointer always points there.
T
Tom Lane 已提交
2820
 */
2821
static XLogRecord *
2822
ReadRecord(XLogRecPtr *RecPtr, int emode)
2823
{
2824
	XLogRecord *record;
2825
	char	   *buffer;
2826
	XLogRecPtr	tmpRecPtr = EndRecPtr;
2827
	bool		randAccess = false;
T
Tom Lane 已提交
2828 2829 2830
	uint32		len,
				total_len;
	uint32		targetPageOff;
2831 2832
	uint32		targetRecOff;
	uint32		pageHeaderSize;
T
Tom Lane 已提交
2833 2834 2835 2836

	if (readBuf == NULL)
	{
		/*
B
Bruce Momjian 已提交
2837 2838 2839 2840 2841
		 * 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 已提交
2842
		 */
2843
		readBuf = (char *) malloc(XLOG_BLCKSZ);
T
Tom Lane 已提交
2844 2845
		Assert(readBuf != NULL);
	}
2846

T
Tom Lane 已提交
2847
	if (RecPtr == NULL)
2848
	{
2849
		RecPtr = &tmpRecPtr;
T
Tom Lane 已提交
2850
		/* fast case if next record is on same page */
2851 2852 2853 2854 2855
		if (nextRecord != NULL)
		{
			record = nextRecord;
			goto got_record;
		}
T
Tom Lane 已提交
2856
		/* align old recptr to next page */
2857 2858
		if (tmpRecPtr.xrecoff % XLOG_BLCKSZ != 0)
			tmpRecPtr.xrecoff += (XLOG_BLCKSZ - tmpRecPtr.xrecoff % XLOG_BLCKSZ);
2859 2860 2861 2862 2863
		if (tmpRecPtr.xrecoff >= XLogFileSize)
		{
			(tmpRecPtr.xlogid)++;
			tmpRecPtr.xrecoff = 0;
		}
2864 2865 2866 2867 2868 2869 2870 2871
		/* 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 已提交
2872

2873
		/*
B
Bruce Momjian 已提交
2874 2875 2876 2877 2878
		 * 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).
2879 2880 2881
		 */
		lastPageTLI = 0;		/* see comment in ValidXLOGHeader */
		randAccess = true;		/* allow curFileTLI to go backwards too */
2882 2883
	}

T
Tom Lane 已提交
2884
	if (readFile >= 0 && !XLByteInSeg(*RecPtr, readId, readSeg))
2885
	{
2886 2887
		close(readFile);
		readFile = -1;
2888
	}
T
Tom Lane 已提交
2889
	XLByteToSeg(*RecPtr, readId, readSeg);
2890
	if (readFile < 0)
2891
	{
2892 2893 2894 2895 2896
		/* Now it's okay to reset curFileTLI if random fetch */
		if (randAccess)
			curFileTLI = 0;

		readFile = XLogFileRead(readId, readSeg, emode);
2897 2898
		if (readFile < 0)
			goto next_record_is_invalid;
2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917

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

2920
	targetPageOff = ((RecPtr->xrecoff % XLogSegSize) / XLOG_BLCKSZ) * XLOG_BLCKSZ;
T
Tom Lane 已提交
2921
	if (readOff != targetPageOff)
2922
	{
T
Tom Lane 已提交
2923 2924 2925
		readOff = targetPageOff;
		if (lseek(readFile, (off_t) readOff, SEEK_SET) < 0)
		{
2926 2927
			ereport(emode,
					(errcode_for_file_access(),
2928
					 errmsg("could not seek in log file %u, segment %u to offset %u: %m",
2929
							readId, readSeg, readOff)));
T
Tom Lane 已提交
2930 2931
			goto next_record_is_invalid;
		}
2932
		if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
T
Tom Lane 已提交
2933
		{
2934 2935
			ereport(emode,
					(errcode_for_file_access(),
2936
					 errmsg("could not read from log file %u, segment %u at offset %u: %m",
2937
							readId, readSeg, readOff)));
T
Tom Lane 已提交
2938 2939
			goto next_record_is_invalid;
		}
2940
		if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
2941 2942
			goto next_record_is_invalid;
	}
2943
	pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
2944
	targetRecOff = RecPtr->xrecoff % XLOG_BLCKSZ;
2945 2946 2947
	if (targetRecOff == 0)
	{
		/*
B
Bruce Momjian 已提交
2948 2949 2950
		 * 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.
2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961
		 */
		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 已提交
2962
	if ((((XLogPageHeader) readBuf)->xlp_info & XLP_FIRST_IS_CONTRECORD) &&
2963
		targetRecOff == pageHeaderSize)
2964
	{
2965 2966 2967
		ereport(emode,
				(errmsg("contrecord is requested by %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
2968 2969
		goto next_record_is_invalid;
	}
2970
	record = (XLogRecord *) ((char *) readBuf + RecPtr->xrecoff % XLOG_BLCKSZ);
2971 2972

got_record:;
B
Bruce Momjian 已提交
2973

T
Tom Lane 已提交
2974
	/*
B
Bruce Momjian 已提交
2975 2976
	 * xl_len == 0 is bad data for everything except XLOG SWITCH, where it is
	 * required.
T
Tom Lane 已提交
2977
	 */
2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988
	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)
2989
	{
2990 2991 2992
		ereport(emode,
				(errmsg("record with zero length at %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
2993 2994
		goto next_record_is_invalid;
	}
2995 2996 2997 2998 2999 3000 3001 3002 3003
	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;
	}
3004 3005 3006 3007
	if (record->xl_rmid > RM_MAX_ID)
	{
		ereport(emode,
				(errmsg("invalid resource manager ID %u at %X/%X",
B
Bruce Momjian 已提交
3008
						record->xl_rmid, RecPtr->xlogid, RecPtr->xrecoff)));
3009 3010
		goto next_record_is_invalid;
	}
3011 3012 3013
	if (randAccess)
	{
		/*
B
Bruce Momjian 已提交
3014 3015
		 * We can't exactly verify the prev-link, but surely it should be less
		 * than the record's own address.
3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028
		 */
		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 已提交
3029 3030 3031
		 * 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.
3032 3033 3034 3035 3036 3037 3038 3039 3040 3041
		 */
		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 已提交
3042

T
Tom Lane 已提交
3043
	/*
B
Bruce Momjian 已提交
3044
	 * Allocate or enlarge readRecordBuf as needed.  To avoid useless small
3045 3046 3047 3048
	 * 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 已提交
3049
	 */
3050
	total_len = record->xl_tot_len;
3051
	if (total_len > readRecordBufSize)
3052
	{
3053 3054
		uint32		newSize = total_len;

3055 3056
		newSize += XLOG_BLCKSZ - (newSize % XLOG_BLCKSZ);
		newSize = Max(newSize, 4 * Max(BLCKSZ, XLOG_BLCKSZ));
3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069
		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;
3070
	}
3071 3072

	buffer = readRecordBuf;
3073
	nextRecord = NULL;
3074
	len = XLOG_BLCKSZ - RecPtr->xrecoff % XLOG_BLCKSZ;
T
Tom Lane 已提交
3075
	if (total_len > len)
3076
	{
T
Tom Lane 已提交
3077 3078
		/* Need to reassemble record */
		XLogContRecord *contrecord;
B
Bruce Momjian 已提交
3079
		uint32		gotlen = len;
3080

T
Tom Lane 已提交
3081
		memcpy(buffer, record, len);
3082
		record = (XLogRecord *) buffer;
T
Tom Lane 已提交
3083
		buffer += len;
3084
		for (;;)
3085
		{
3086
			readOff += XLOG_BLCKSZ;
T
Tom Lane 已提交
3087
			if (readOff >= XLogSegSize)
3088 3089
			{
				close(readFile);
T
Tom Lane 已提交
3090 3091
				readFile = -1;
				NextLogSeg(readId, readSeg);
3092
				readFile = XLogFileRead(readId, readSeg, emode);
3093 3094
				if (readFile < 0)
					goto next_record_is_invalid;
T
Tom Lane 已提交
3095
				readOff = 0;
3096
			}
3097
			if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
T
Tom Lane 已提交
3098
			{
3099 3100
				ereport(emode,
						(errcode_for_file_access(),
T
Tom Lane 已提交
3101
						 errmsg("could not read from log file %u, segment %u, offset %u: %m",
3102
								readId, readSeg, readOff)));
T
Tom Lane 已提交
3103 3104
				goto next_record_is_invalid;
			}
3105
			if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
3106
				goto next_record_is_invalid;
T
Tom Lane 已提交
3107
			if (!(((XLogPageHeader) readBuf)->xlp_info & XLP_FIRST_IS_CONTRECORD))
3108
			{
3109 3110 3111
				ereport(emode,
						(errmsg("there is no contrecord flag in log file %u, segment %u, offset %u",
								readId, readSeg, readOff)));
3112 3113
				goto next_record_is_invalid;
			}
3114 3115
			pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
			contrecord = (XLogContRecord *) ((char *) readBuf + pageHeaderSize);
B
Bruce Momjian 已提交
3116
			if (contrecord->xl_rem_len == 0 ||
T
Tom Lane 已提交
3117
				total_len != (contrecord->xl_rem_len + gotlen))
3118
			{
3119 3120 3121 3122
				ereport(emode,
						(errmsg("invalid contrecord length %u in log file %u, segment %u, offset %u",
								contrecord->xl_rem_len,
								readId, readSeg, readOff)));
3123 3124
				goto next_record_is_invalid;
			}
3125
			len = XLOG_BLCKSZ - pageHeaderSize - SizeOfXLogContRecord;
T
Tom Lane 已提交
3126
			if (contrecord->xl_rem_len > len)
3127
			{
B
Bruce Momjian 已提交
3128
				memcpy(buffer, (char *) contrecord + SizeOfXLogContRecord, len);
T
Tom Lane 已提交
3129 3130 3131 3132 3133 3134 3135 3136 3137 3138
				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;
3139
		pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
3140
		if (XLOG_BLCKSZ - SizeOfXLogRecord >= pageHeaderSize +
3141
			MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len))
T
Tom Lane 已提交
3142
		{
B
Bruce Momjian 已提交
3143
			nextRecord = (XLogRecord *) ((char *) contrecord +
B
Bruce Momjian 已提交
3144
					MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len));
T
Tom Lane 已提交
3145 3146 3147
		}
		EndRecPtr.xlogid = readId;
		EndRecPtr.xrecoff = readSeg * XLogSegSize + readOff +
3148 3149
			pageHeaderSize +
			MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len);
T
Tom Lane 已提交
3150
		ReadRecPtr = *RecPtr;
3151
		/* needn't worry about XLOG SWITCH, it can't cross page boundaries */
T
Tom Lane 已提交
3152
		return record;
3153 3154
	}

T
Tom Lane 已提交
3155 3156 3157
	/* Record does not cross a page boundary */
	if (!RecordIsValid(record, *RecPtr, emode))
		goto next_record_is_invalid;
3158
	if (XLOG_BLCKSZ - SizeOfXLogRecord >= RecPtr->xrecoff % XLOG_BLCKSZ +
T
Tom Lane 已提交
3159 3160 3161 3162 3163 3164
		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 已提交
3165

3166 3167 3168 3169 3170 3171 3172 3173 3174
	/*
	 * 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 已提交
3175

3176
		/*
B
Bruce Momjian 已提交
3177 3178 3179
		 * 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.
3180 3181 3182
		 */
		readOff = XLogSegSize - XLOG_BLCKSZ;
	}
T
Tom Lane 已提交
3183
	return (XLogRecord *) buffer;
3184

T
Tom Lane 已提交
3185 3186 3187 3188 3189
next_record_is_invalid:;
	close(readFile);
	readFile = -1;
	nextRecord = NULL;
	return NULL;
3190 3191
}

3192 3193 3194 3195
/*
 * 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 已提交
3196
 * ReadRecord.	It's not intended for use from anywhere else.
3197 3198
 */
static bool
3199
ValidXLOGHeader(XLogPageHeader hdr, int emode)
3200
{
3201 3202
	XLogRecPtr	recaddr;

3203 3204
	if (hdr->xlp_magic != XLOG_PAGE_MAGIC)
	{
3205 3206 3207
		ereport(emode,
				(errmsg("invalid magic number %04X in log file %u, segment %u, offset %u",
						hdr->xlp_magic, readId, readSeg, readOff)));
3208 3209 3210 3211
		return false;
	}
	if ((hdr->xlp_info & ~XLP_ALL_FLAGS) != 0)
	{
3212 3213 3214
		ereport(emode,
				(errmsg("invalid info bits %04X in log file %u, segment %u, offset %u",
						hdr->xlp_info, readId, readSeg, readOff)));
3215 3216
		return false;
	}
3217
	if (hdr->xlp_info & XLP_LONG_HEADER)
3218
	{
3219
		XLogLongPageHeader longhdr = (XLogLongPageHeader) hdr;
B
Bruce Momjian 已提交
3220

3221
		if (longhdr->xlp_sysid != ControlFile->system_identifier)
3222
		{
3223 3224
			char		fhdrident_str[32];
			char		sysident_str[32];
3225

3226
			/*
B
Bruce Momjian 已提交
3227 3228
			 * Format sysids separately to keep platform-dependent format code
			 * out of the translatable message string.
3229 3230 3231 3232 3233 3234 3235
			 */
			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 已提交
3236 3237
					 errdetail("WAL file SYSID is %s, pg_control SYSID is %s",
							   fhdrident_str, sysident_str)));
3238 3239 3240 3241 3242 3243
			return false;
		}
		if (longhdr->xlp_seg_size != XLogSegSize)
		{
			ereport(emode,
					(errmsg("WAL file is from different system"),
B
Bruce Momjian 已提交
3244
					 errdetail("Incorrect XLOG_SEG_SIZE in page header.")));
3245 3246
			return false;
		}
3247 3248 3249 3250 3251 3252 3253
		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;
		}
3254
	}
3255 3256 3257 3258 3259 3260 3261 3262 3263
	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;
	}

3264 3265 3266 3267 3268 3269
	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 已提交
3270
						hdr->xlp_pageaddr.xlogid, hdr->xlp_pageaddr.xrecoff,
3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291
						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 已提交
3292 3293 3294
	 * 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.
3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311
	 */
	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 已提交
3312
 * its ancestor TLIs).	If we can't find the history file, assume that the
3313 3314 3315 3316 3317 3318 3319 3320 3321 3322
 * 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 已提交
3323
	FILE	   *fd;
3324 3325 3326 3327

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, targetTLI);
3328
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3329 3330 3331 3332
	}
	else
		TLHistoryFilePath(path, targetTLI);

B
Bruce Momjian 已提交
3333
	fd = AllocateFile(path, "r");
3334 3335 3336 3337 3338
	if (fd == NULL)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3339
					 errmsg("could not open file \"%s\": %m", path)));
3340 3341 3342 3343 3344 3345
		/* Not there, so assume no parents */
		return list_make1_int((int) targetTLI);
	}

	result = NIL;

B
Bruce Momjian 已提交
3346 3347 3348
	/*
	 * Parse the file...
	 */
3349
	while (fgets(fline, sizeof(fline), fd) != NULL)
3350 3351
	{
		/* skip leading whitespace and check for # comment */
B
Bruce Momjian 已提交
3352 3353 3354
		char	   *ptr;
		char	   *endptr;
		TimeLineID	tli;
3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374

		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 已提交
3375
				   errhint("Timeline IDs must be in increasing sequence.")));
3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388

		/* 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 已提交
3389
			errhint("Timeline IDs must be less than child timeline's ID.")));
3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407

	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 已提交
3408
	FILE	   *fd;
3409 3410 3411 3412

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, probeTLI);
3413
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428
	}
	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 已提交
3429
					 errmsg("could not open file \"%s\": %m", path)));
3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447
		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 已提交
3448 3449
	 * The algorithm is just to probe for the existence of timeline history
	 * files.  XXX is it useful to allow gaps in the sequence?
3450 3451 3452
	 */
	newestTLI = startTLI;

B
Bruce Momjian 已提交
3453
	for (probeTLI = startTLI + 1;; probeTLI++)
3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476
	{
		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 已提交
3477
 * considerations.	But we should be just as tense as XLogFileInit to avoid
3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492
 * 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 已提交
3493
	Assert(newTLI > parentTLI); /* else bad selection of newTLI */
3494 3495 3496 3497

	/*
	 * Write into a temp file name.
	 */
3498
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
3499 3500 3501 3502 3503 3504 3505

	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)
3506
		ereport(ERROR,
3507 3508 3509 3510 3511 3512 3513 3514 3515
				(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);
3516
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3517 3518 3519 3520 3521 3522 3523 3524
	}
	else
		TLHistoryFilePath(path, parentTLI);

	srcfd = BasicOpenFile(path, O_RDONLY, 0);
	if (srcfd < 0)
	{
		if (errno != ENOENT)
3525
			ereport(ERROR,
3526
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3527
					 errmsg("could not open file \"%s\": %m", path)));
3528 3529 3530 3531 3532 3533 3534 3535 3536
		/* Not there, so assume parent has no parents */
	}
	else
	{
		for (;;)
		{
			errno = 0;
			nbytes = (int) read(srcfd, buffer, sizeof(buffer));
			if (nbytes < 0 || errno != 0)
3537
				ereport(ERROR,
3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551
						(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 已提交
3552 3553

				/*
B
Bruce Momjian 已提交
3554
				 * if write didn't set errno, assume problem is no disk space
B
Bruce Momjian 已提交
3555
				 */
3556 3557
				errno = save_errno ? save_errno : ENOSPC;

3558
				ereport(ERROR,
3559
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
3560
					 errmsg("could not write to file \"%s\": %m", tmppath)));
3561 3562 3563 3564 3565 3566 3567 3568
			}
		}
		close(srcfd);
	}

	/*
	 * Append one line with the details of this timeline split.
	 *
B
Bruce Momjian 已提交
3569 3570
	 * If we did have a parent file, insert an extra newline just in case the
	 * parent file failed to end with one.
3571 3572 3573 3574 3575 3576 3577 3578 3579 3580
	 */
	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,
3581
			 timestamptz_to_str(recoveryStopTime));
3582 3583 3584 3585 3586 3587 3588 3589

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

		/*
B
Bruce Momjian 已提交
3590
		 * If we fail to make the file, delete it to release disk space
3591 3592 3593 3594 3595
		 */
		unlink(tmppath);
		/* if write didn't set errno, assume problem is no disk space */
		errno = save_errno ? save_errno : ENOSPC;

3596
		ereport(ERROR,
3597 3598 3599 3600 3601
				(errcode_for_file_access(),
				 errmsg("could not write to file \"%s\": %m", tmppath)));
	}

	if (pg_fsync(fd) != 0)
3602
		ereport(ERROR,
3603 3604 3605 3606
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

	if (close(fd))
3607
		ereport(ERROR,
3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623
				(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)
3624
		ereport(ERROR,
3625 3626 3627 3628 3629 3630
				(errcode_for_file_access(),
				 errmsg("could not link file \"%s\" to \"%s\": %m",
						tmppath, path)));
	unlink(tmppath);
#else
	if (rename(tmppath, path) < 0)
3631
		ereport(ERROR,
3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643
				(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
3644 3645
 *
 * *ControlFile is a buffer in shared memory that holds an image of the
B
Bruce Momjian 已提交
3646
 * contents of pg_control.	WriteControlFile() initializes pg_control
3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659
 * 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 已提交
3660
	char		buffer[PG_CONTROL_SIZE];		/* need not be aligned */
3661 3662 3663
	char	   *localeptr;

	/*
T
Tom Lane 已提交
3664
	 * Initialize version and compatibility-check fields
3665
	 */
T
Tom Lane 已提交
3666 3667
	ControlFile->pg_control_version = PG_CONTROL_VERSION;
	ControlFile->catalog_version_no = CATALOG_VERSION_NO;
3668 3669 3670 3671

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

3672 3673
	ControlFile->blcksz = BLCKSZ;
	ControlFile->relseg_size = RELSEG_SIZE;
3674
	ControlFile->xlog_blcksz = XLOG_BLCKSZ;
3675
	ControlFile->xlog_seg_size = XLOG_SEG_SIZE;
3676 3677

	ControlFile->nameDataLen = NAMEDATALEN;
3678
	ControlFile->indexMaxKeys = INDEX_MAX_KEYS;
3679

3680 3681
	ControlFile->toast_max_chunk_size = TOAST_MAX_CHUNK_SIZE;

3682 3683 3684 3685 3686 3687 3688
#ifdef HAVE_INT64_TIMESTAMP
	ControlFile->enableIntTimes = TRUE;
#else
	ControlFile->enableIntTimes = FALSE;
#endif

	ControlFile->localeBuflen = LOCALE_NAME_BUFLEN;
3689 3690
	localeptr = setlocale(LC_COLLATE, NULL);
	if (!localeptr)
3691 3692
		ereport(PANIC,
				(errmsg("invalid LC_COLLATE setting")));
3693 3694 3695
	StrNCpy(ControlFile->lc_collate, localeptr, LOCALE_NAME_BUFLEN);
	localeptr = setlocale(LC_CTYPE, NULL);
	if (!localeptr)
3696 3697
		ereport(PANIC,
				(errmsg("invalid LC_CTYPE setting")));
3698
	StrNCpy(ControlFile->lc_ctype, localeptr, LOCALE_NAME_BUFLEN);
B
Bruce Momjian 已提交
3699

T
Tom Lane 已提交
3700
	/* Contents are protected with a CRC */
3701 3702 3703 3704 3705
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
T
Tom Lane 已提交
3706

3707
	/*
3708 3709 3710 3711 3712
	 * 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".
3713
	 */
3714 3715
	if (sizeof(ControlFileData) > PG_CONTROL_SIZE)
		elog(PANIC, "sizeof(ControlFileData) is larger than PG_CONTROL_SIZE; fix either one");
3716

3717
	memset(buffer, 0, PG_CONTROL_SIZE);
3718 3719
	memcpy(buffer, ControlFile, sizeof(ControlFileData));

3720 3721
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
3722
					   S_IRUSR | S_IWUSR);
3723
	if (fd < 0)
3724 3725 3726
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not create control file \"%s\": %m",
3727
						XLOG_CONTROL_FILE)));
3728

3729
	errno = 0;
3730
	if (write(fd, buffer, PG_CONTROL_SIZE) != PG_CONTROL_SIZE)
3731 3732 3733 3734
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
3735 3736
		ereport(PANIC,
				(errcode_for_file_access(),
3737
				 errmsg("could not write to control file: %m")));
3738
	}
3739

3740
	if (pg_fsync(fd) != 0)
3741 3742
		ereport(PANIC,
				(errcode_for_file_access(),
3743
				 errmsg("could not fsync control file: %m")));
3744

3745 3746 3747 3748
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
3749 3750 3751 3752 3753
}

static void
ReadControlFile(void)
{
3754
	pg_crc32	crc;
3755 3756 3757 3758 3759
	int			fd;

	/*
	 * Read data...
	 */
3760 3761 3762
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | PG_BINARY,
					   S_IRUSR | S_IWUSR);
3763
	if (fd < 0)
3764 3765 3766
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not open control file \"%s\": %m",
3767
						XLOG_CONTROL_FILE)));
3768 3769

	if (read(fd, ControlFile, sizeof(ControlFileData)) != sizeof(ControlFileData))
3770 3771
		ereport(PANIC,
				(errcode_for_file_access(),
3772
				 errmsg("could not read from control file: %m")));
3773 3774 3775

	close(fd);

T
Tom Lane 已提交
3776
	/*
B
Bruce Momjian 已提交
3777 3778 3779 3780
	 * 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 已提交
3781 3782
	 */
	if (ControlFile->pg_control_version != PG_CONTROL_VERSION)
3783 3784 3785
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with PG_CONTROL_VERSION %d,"
B
Bruce Momjian 已提交
3786 3787
				  " but the server was compiled with PG_CONTROL_VERSION %d.",
						ControlFile->pg_control_version, PG_CONTROL_VERSION),
3788
				 errhint("It looks like you need to initdb.")));
T
Tom Lane 已提交
3789
	/* Now check the CRC. */
3790 3791 3792 3793 3794
	INIT_CRC32(crc);
	COMP_CRC32(crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(crc);
3795

3796
	if (!EQ_CRC32(crc, ControlFile->crc))
3797
		ereport(FATAL,
3798
				(errmsg("incorrect checksum in control file")));
3799

3800
	/*
B
Bruce Momjian 已提交
3801
	 * Do compatibility checking immediately.  We do this here for 2 reasons:
3802
	 *
3803 3804
	 * (1) if the database isn't compatible with the backend executable, we
	 * want to abort before we can possibly do any damage;
3805 3806
	 *
	 * (2) this code is executed in the postmaster, so the setlocale() will
B
Bruce Momjian 已提交
3807 3808
	 * propagate to forked backends, which aren't going to read this file for
	 * themselves.	(These locale settings are considered critical
3809 3810
	 * compatibility items because they can affect sort order of indexes.)
	 */
T
Tom Lane 已提交
3811
	if (ControlFile->catalog_version_no != CATALOG_VERSION_NO)
3812 3813 3814
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with CATALOG_VERSION_NO %d,"
B
Bruce Momjian 已提交
3815 3816
				  " but the server was compiled with CATALOG_VERSION_NO %d.",
						ControlFile->catalog_version_no, CATALOG_VERSION_NO),
3817
				 errhint("It looks like you need to initdb.")));
3818 3819 3820
	if (ControlFile->maxAlign != MAXIMUM_ALIGNOF)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3821 3822 3823 3824
		   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.")));
3825 3826 3827
	if (ControlFile->floatFormat != FLOATFORMAT_VALUE)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
P
Peter Eisentraut 已提交
3828
				 errdetail("The database cluster appears to use a different floating-point number format than the server executable."),
3829
				 errhint("It looks like you need to initdb.")));
3830
	if (ControlFile->blcksz != BLCKSZ)
3831 3832
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3833 3834 3835 3836
			 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.")));
3837
	if (ControlFile->relseg_size != RELSEG_SIZE)
3838 3839
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3840 3841 3842 3843
		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.")));
3844 3845 3846
	if (ControlFile->xlog_blcksz != XLOG_BLCKSZ)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3847 3848 3849
		errdetail("The database cluster was initialized with XLOG_BLCKSZ %d,"
				  " but the server was compiled with XLOG_BLCKSZ %d.",
				  ControlFile->xlog_blcksz, XLOG_BLCKSZ),
3850
				 errhint("It looks like you need to recompile or initdb.")));
3851 3852 3853 3854
	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 已提交
3855
					   " but the server was compiled with XLOG_SEG_SIZE %d.",
3856
						   ControlFile->xlog_seg_size, XLOG_SEG_SIZE),
B
Bruce Momjian 已提交
3857
				 errhint("It looks like you need to recompile or initdb.")));
3858
	if (ControlFile->nameDataLen != NAMEDATALEN)
3859 3860
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
3861 3862 3863 3864
		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.")));
3865
	if (ControlFile->indexMaxKeys != INDEX_MAX_KEYS)
3866 3867
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
3868
				 errdetail("The database cluster was initialized with INDEX_MAX_KEYS %d,"
B
Bruce Momjian 已提交
3869
					  " but the server was compiled with INDEX_MAX_KEYS %d.",
3870
						   ControlFile->indexMaxKeys, INDEX_MAX_KEYS),
B
Bruce Momjian 已提交
3871
				 errhint("It looks like you need to recompile or initdb.")));
3872 3873 3874 3875 3876 3877 3878
	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.")));
3879 3880 3881

#ifdef HAVE_INT64_TIMESTAMP
	if (ControlFile->enableIntTimes != TRUE)
3882 3883 3884
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized without HAVE_INT64_TIMESTAMP"
B
Bruce Momjian 已提交
3885 3886
				  " but the server was compiled with HAVE_INT64_TIMESTAMP."),
				 errhint("It looks like you need to recompile or initdb.")));
3887 3888
#else
	if (ControlFile->enableIntTimes != FALSE)
3889 3890 3891
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with HAVE_INT64_TIMESTAMP"
B
Bruce Momjian 已提交
3892 3893
			   " but the server was compiled without HAVE_INT64_TIMESTAMP."),
				 errhint("It looks like you need to recompile or initdb.")));
3894 3895 3896
#endif

	if (ControlFile->localeBuflen != LOCALE_NAME_BUFLEN)
3897 3898 3899
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with LOCALE_NAME_BUFLEN %d,"
B
Bruce Momjian 已提交
3900
				  " but the server was compiled with LOCALE_NAME_BUFLEN %d.",
3901
						   ControlFile->localeBuflen, LOCALE_NAME_BUFLEN),
B
Bruce Momjian 已提交
3902
				 errhint("It looks like you need to recompile or initdb.")));
3903
	if (pg_perm_setlocale(LC_COLLATE, ControlFile->lc_collate) == NULL)
3904
		ereport(FATAL,
B
Bruce Momjian 已提交
3905 3906 3907 3908 3909
			(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.")));
3910
	if (pg_perm_setlocale(LC_CTYPE, ControlFile->lc_ctype) == NULL)
3911
		ereport(FATAL,
B
Bruce Momjian 已提交
3912 3913 3914 3915 3916
			(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.")));
3917 3918 3919 3920 3921 3922

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

3925
void
3926
UpdateControlFile(void)
3927
{
3928
	int			fd;
3929

3930 3931 3932 3933 3934
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
3935

3936 3937 3938
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | PG_BINARY,
					   S_IRUSR | S_IWUSR);
3939
	if (fd < 0)
3940 3941 3942
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not open control file \"%s\": %m",
3943
						XLOG_CONTROL_FILE)));
3944

3945
	errno = 0;
3946
	if (write(fd, ControlFile, sizeof(ControlFileData)) != sizeof(ControlFileData))
3947 3948 3949 3950
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
3951 3952
		ereport(PANIC,
				(errcode_for_file_access(),
3953
				 errmsg("could not write to control file: %m")));
3954
	}
3955

3956
	if (pg_fsync(fd) != 0)
3957 3958
		ereport(PANIC,
				(errcode_for_file_access(),
3959
				 errmsg("could not fsync control file: %m")));
3960

3961 3962 3963 3964
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
3965 3966
}

3967
/*
T
Tom Lane 已提交
3968
 * Initialization of shared memory for XLOG
3969
 */
3970
Size
3971
XLOGShmemSize(void)
3972
{
3973
	Size		size;
3974

3975 3976 3977 3978 3979 3980 3981
	/* 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 */
3982
	size = add_size(size, mul_size(XLOG_BLCKSZ, XLOGbuffers));
3983 3984

	/*
B
Bruce Momjian 已提交
3985 3986 3987
	 * 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.
3988 3989 3990
	 */

	return size;
3991 3992 3993 3994 3995
}

void
XLOGShmemInit(void)
{
3996 3997
	bool		foundCFile,
				foundXLog;
3998
	char	   *allocptr;
3999

4000
	ControlFile = (ControlFileData *)
4001
		ShmemInitStruct("Control File", sizeof(ControlFileData), &foundCFile);
4002 4003
	XLogCtl = (XLogCtlData *)
		ShmemInitStruct("XLOG Ctl", XLOGShmemSize(), &foundXLog);
4004

4005
	if (foundCFile || foundXLog)
4006 4007
	{
		/* both should be present or neither */
4008
		Assert(foundCFile && foundXLog);
4009 4010
		return;
	}
4011

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

T
Tom Lane 已提交
4014
	/*
B
Bruce Momjian 已提交
4015 4016 4017
	 * 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 已提交
4018
	 */
4019 4020
	allocptr = ((char *) XLogCtl) + sizeof(XLogCtlData);
	XLogCtl->xlblocks = (XLogRecPtr *) allocptr;
T
Tom Lane 已提交
4021
	memset(XLogCtl->xlblocks, 0, sizeof(XLogRecPtr) * XLOGbuffers);
4022
	allocptr += sizeof(XLogRecPtr) * XLOGbuffers;
B
Bruce Momjian 已提交
4023

T
Tom Lane 已提交
4024
	/*
4025
	 * Align the start of the page buffers to an ALIGNOF_XLOG_BUFFER boundary.
T
Tom Lane 已提交
4026
	 */
4027 4028
	allocptr = (char *) TYPEALIGN(ALIGNOF_XLOG_BUFFER, allocptr);
	XLogCtl->pages = allocptr;
4029
	memset(XLogCtl->pages, 0, (Size) XLOG_BLCKSZ * XLOGbuffers);
T
Tom Lane 已提交
4030 4031

	/*
B
Bruce Momjian 已提交
4032 4033
	 * Do basic initialization of XLogCtl shared data. (StartupXLOG will fill
	 * in additional info.)
T
Tom Lane 已提交
4034
	 */
B
Bruce Momjian 已提交
4035
	XLogCtl->XLogCacheByte = (Size) XLOG_BLCKSZ *XLOGbuffers;
B
Bruce Momjian 已提交
4036

T
Tom Lane 已提交
4037 4038
	XLogCtl->XLogCacheBlck = XLOGbuffers - 1;
	XLogCtl->Insert.currpage = (XLogPageHeader) (XLogCtl->pages);
4039
	SpinLockInit(&XLogCtl->info_lck);
T
Tom Lane 已提交
4040

4041
	/*
B
Bruce Momjian 已提交
4042 4043 4044
	 * 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).
4045 4046 4047
	 */
	if (!IsBootstrapProcessingMode())
		ReadControlFile();
4048 4049 4050
}

/*
T
Tom Lane 已提交
4051 4052
 * This func must be called ONCE on system install.  It creates pg_control
 * and the initial XLOG segment.
4053 4054
 */
void
T
Tom Lane 已提交
4055
BootStrapXLOG(void)
4056
{
4057
	CheckPoint	checkPoint;
T
Tom Lane 已提交
4058 4059
	char	   *buffer;
	XLogPageHeader page;
4060
	XLogLongPageHeader longpage;
4061
	XLogRecord *record;
B
Bruce Momjian 已提交
4062
	bool		use_existent;
4063 4064
	uint64		sysidentifier;
	struct timeval tv;
4065
	pg_crc32	crc;
4066

4067
	/*
B
Bruce Momjian 已提交
4068 4069 4070 4071 4072 4073 4074 4075 4076 4077
	 * 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.
4078 4079 4080 4081 4082
	 */
	gettimeofday(&tv, NULL);
	sysidentifier = ((uint64) tv.tv_sec) << 32;
	sysidentifier |= (uint32) (tv.tv_sec | tv.tv_usec);

4083 4084 4085
	/* First timeline ID is always 1 */
	ThisTimeLineID = 1;

4086
	/* page buffer must be aligned suitably for O_DIRECT */
4087
	buffer = (char *) palloc(XLOG_BLCKSZ + ALIGNOF_XLOG_BUFFER);
4088
	page = (XLogPageHeader) TYPEALIGN(ALIGNOF_XLOG_BUFFER, buffer);
4089
	memset(page, 0, XLOG_BLCKSZ);
T
Tom Lane 已提交
4090

4091
	/* Set up information for the initial checkpoint record */
4092
	checkPoint.redo.xlogid = 0;
4093 4094
	checkPoint.redo.xrecoff = SizeOfXLogLongPHD;
	checkPoint.ThisTimeLineID = ThisTimeLineID;
4095
	checkPoint.nextXidEpoch = 0;
4096
	checkPoint.nextXid = FirstNormalTransactionId;
4097
	checkPoint.nextOid = FirstBootstrapObjectId;
4098
	checkPoint.nextMulti = FirstMultiXactId;
4099
	checkPoint.nextMultiOffset = 0;
T
Tom Lane 已提交
4100
	checkPoint.time = time(NULL);
4101

4102 4103 4104
	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
	ShmemVariableCache->oidCount = 0;
4105
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
4106

4107
	/* Set up the XLOG page header */
4108
	page->xlp_magic = XLOG_PAGE_MAGIC;
4109 4110
	page->xlp_info = XLP_LONG_HEADER;
	page->xlp_tli = ThisTimeLineID;
4111 4112
	page->xlp_pageaddr.xlogid = 0;
	page->xlp_pageaddr.xrecoff = 0;
4113 4114 4115
	longpage = (XLogLongPageHeader) page;
	longpage->xlp_sysid = sysidentifier;
	longpage->xlp_seg_size = XLogSegSize;
4116
	longpage->xlp_xlog_blcksz = XLOG_BLCKSZ;
4117 4118

	/* Insert the initial checkpoint record */
4119
	record = (XLogRecord *) ((char *) page + SizeOfXLogLongPHD);
4120
	record->xl_prev.xlogid = 0;
4121
	record->xl_prev.xrecoff = 0;
4122
	record->xl_xid = InvalidTransactionId;
4123
	record->xl_tot_len = SizeOfXLogRecord + sizeof(checkPoint);
4124
	record->xl_len = sizeof(checkPoint);
T
Tom Lane 已提交
4125
	record->xl_info = XLOG_CHECKPOINT_SHUTDOWN;
4126
	record->xl_rmid = RM_XLOG_ID;
T
Tom Lane 已提交
4127
	memcpy(XLogRecGetData(record), &checkPoint, sizeof(checkPoint));
4128

4129 4130 4131 4132 4133
	INIT_CRC32(crc);
	COMP_CRC32(crc, &checkPoint, sizeof(checkPoint));
	COMP_CRC32(crc, (char *) record + sizeof(pg_crc32),
			   SizeOfXLogRecord - sizeof(pg_crc32));
	FIN_CRC32(crc);
4134 4135
	record->xl_crc = crc;

4136
	/* Create first XLOG segment file */
4137 4138
	use_existent = false;
	openLogFile = XLogFileInit(0, 0, &use_existent, false);
4139

4140
	/* Write the first page with the initial record */
4141
	errno = 0;
4142
	if (write(openLogFile, page, XLOG_BLCKSZ) != XLOG_BLCKSZ)
4143 4144 4145 4146
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
4147 4148
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4149
			  errmsg("could not write bootstrap transaction log file: %m")));
4150
	}
4151

T
Tom Lane 已提交
4152
	if (pg_fsync(openLogFile) != 0)
4153 4154
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4155
			  errmsg("could not fsync bootstrap transaction log file: %m")));
4156

4157 4158 4159
	if (close(openLogFile))
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4160
			  errmsg("could not close bootstrap transaction log file: %m")));
4161

T
Tom Lane 已提交
4162
	openLogFile = -1;
4163

4164 4165
	/* Now create pg_control */

4166
	memset(ControlFile, 0, sizeof(ControlFileData));
T
Tom Lane 已提交
4167
	/* Initialize pg_control status fields */
4168
	ControlFile->system_identifier = sysidentifier;
T
Tom Lane 已提交
4169 4170
	ControlFile->state = DB_SHUTDOWNED;
	ControlFile->time = checkPoint.time;
4171
	ControlFile->checkPoint = checkPoint.redo;
T
Tom Lane 已提交
4172
	ControlFile->checkPointCopy = checkPoint;
4173
	/* some additional ControlFile fields are set in WriteControlFile() */
4174

4175
	WriteControlFile();
4176 4177 4178

	/* Bootstrap the commit log, too */
	BootStrapCLOG();
4179
	BootStrapSUBTRANS();
4180
	BootStrapMultiXact();
4181

4182
	pfree(buffer);
4183 4184
}

4185
static char *
4186 4187
str_time(time_t tnow)
{
4188
	static char buf[128];
4189

4190
	strftime(buf, sizeof(buf),
T
Tom Lane 已提交
4191
			 "%Y-%m-%d %H:%M:%S %Z",
4192
			 localtime(&tnow));
4193

4194
	return buf;
4195 4196
}

4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207
/*
 * 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 已提交
4208 4209 4210 4211 4212 4213
	FILE	   *fd;
	char		cmdline[MAXPGPATH];
	TimeLineID	rtli = 0;
	bool		rtliGiven = false;
	bool		syntaxError = false;

4214
	fd = AllocateFile(RECOVERY_COMMAND_FILE, "r");
4215 4216 4217 4218 4219
	if (fd == NULL)
	{
		if (errno == ENOENT)
			return;				/* not there, so no archive recovery */
		ereport(FATAL,
B
Bruce Momjian 已提交
4220
				(errcode_for_file_access(),
4221
				 errmsg("could not open recovery command file \"%s\": %m",
4222
						RECOVERY_COMMAND_FILE)));
4223 4224 4225
	}

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

B
Bruce Momjian 已提交
4228 4229 4230
	/*
	 * Parse the file...
	 */
4231
	while (fgets(cmdline, sizeof(cmdline), fd) != NULL)
4232 4233
	{
		/* skip leading whitespace and check for # comment */
B
Bruce Momjian 已提交
4234 4235 4236
		char	   *ptr;
		char	   *tok1;
		char	   *tok2;
4237 4238 4239 4240 4241 4242 4243 4244 4245 4246

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

		/* identify the quoted parameter value */
B
Bruce Momjian 已提交
4247
		tok1 = strtok(ptr, "'");
4248 4249 4250 4251 4252
		if (!tok1)
		{
			syntaxError = true;
			break;
		}
B
Bruce Momjian 已提交
4253
		tok2 = strtok(NULL, "'");
4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266
		if (!tok2)
		{
			syntaxError = true;
			break;
		}
		/* reparse to get just the parameter name */
		tok1 = strtok(ptr, " \t=");
		if (!tok1)
		{
			syntaxError = true;
			break;
		}

B
Bruce Momjian 已提交
4267 4268
		if (strcmp(tok1, "restore_command") == 0)
		{
4269
			recoveryRestoreCommand = pstrdup(tok2);
4270 4271 4272 4273
			ereport(LOG,
					(errmsg("restore_command = \"%s\"",
							recoveryRestoreCommand)));
		}
B
Bruce Momjian 已提交
4274 4275
		else if (strcmp(tok1, "recovery_target_timeline") == 0)
		{
4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294
			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 已提交
4295 4296
		else if (strcmp(tok1, "recovery_target_xid") == 0)
		{
4297 4298 4299 4300
			errno = 0;
			recoveryTargetXid = (TransactionId) strtoul(tok2, NULL, 0);
			if (errno == EINVAL || errno == ERANGE)
				ereport(FATAL,
B
Bruce Momjian 已提交
4301 4302
				 (errmsg("recovery_target_xid is not a valid number: \"%s\"",
						 tok2)));
4303 4304 4305 4306 4307 4308
			ereport(LOG,
					(errmsg("recovery_target_xid = %u",
							recoveryTargetXid)));
			recoveryTarget = true;
			recoveryTargetExact = true;
		}
B
Bruce Momjian 已提交
4309 4310
		else if (strcmp(tok1, "recovery_target_time") == 0)
		{
4311 4312 4313 4314 4315 4316 4317 4318
			/*
			 * if recovery_target_xid specified, then this overrides
			 * recovery_target_time
			 */
			if (recoveryTargetExact)
				continue;
			recoveryTarget = true;
			recoveryTargetExact = false;
B
Bruce Momjian 已提交
4319

4320
			/*
4321
			 * Convert the time string given by the user to TimestampTz form.
4322
			 */
4323 4324 4325 4326 4327
			recoveryTargetTime =
				DatumGetTimestampTz(DirectFunctionCall3(timestamptz_in,
												   CStringGetDatum(tok2),
												ObjectIdGetDatum(InvalidOid),
														Int32GetDatum(-1)));
4328 4329
			ereport(LOG,
					(errmsg("recovery_target_time = %s",
4330
							timestamptz_to_str(recoveryTargetTime))));
4331
		}
B
Bruce Momjian 已提交
4332 4333
		else if (strcmp(tok1, "recovery_target_inclusive") == 0)
		{
4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354
			/*
			 * 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 已提交
4355 4356
	if (syntaxError)
		ereport(FATAL,
4357 4358
				(errmsg("syntax error in recovery command file: %s",
						cmdline),
B
Bruce Momjian 已提交
4359
			  errhint("Lines should have the format parameter = 'value'.")));
4360 4361

	/* Check that required parameters were supplied */
4362
	if (recoveryRestoreCommand == NULL)
4363 4364
		ereport(FATAL,
				(errmsg("recovery command file \"%s\" did not specify restore_command",
4365
						RECOVERY_COMMAND_FILE)));
4366

4367 4368 4369
	/* Enable fetching from archive recovery area */
	InArchiveRecovery = true;

4370
	/*
B
Bruce Momjian 已提交
4371 4372 4373 4374
	 * 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.
4375
	 */
4376 4377 4378 4379 4380 4381 4382
	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 已提交
4383 4384
						(errmsg("recovery_target_timeline %u does not exist",
								rtli)));
4385 4386 4387 4388 4389 4390 4391 4392
			recoveryTargetTLI = rtli;
		}
		else
		{
			/* We start the "latest" search from pg_control's timeline */
			recoveryTargetTLI = findNewestTimeLine(recoveryTargetTLI);
		}
	}
4393 4394 4395 4396 4397 4398
}

/*
 * Exit archive-recovery state
 */
static void
4399
exitArchiveRecovery(TimeLineID endTLI, uint32 endLogId, uint32 endLogSeg)
4400
{
B
Bruce Momjian 已提交
4401 4402
	char		recoveryPath[MAXPGPATH];
	char		xlogpath[MAXPGPATH];
4403 4404

	/*
4405
	 * We are no longer in archive recovery state.
4406 4407 4408 4409
	 */
	InArchiveRecovery = false;

	/*
B
Bruce Momjian 已提交
4410 4411 4412
	 * 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).
4413 4414 4415 4416 4417 4418 4419 4420 4421
	 */
	Assert(readFile >= 0);
	Assert(readId == endLogId);
	Assert(readSeg == endLogSeg);

	close(readFile);
	readFile = -1;

	/*
B
Bruce Momjian 已提交
4422 4423 4424 4425 4426 4427 4428
	 * 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.
4429
	 *
4430 4431 4432
	 * 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.
4433
	 */
4434
	snprintf(recoveryPath, MAXPGPATH, XLOGDIR "/RECOVERYXLOG");
4435
	XLogFilePath(xlogpath, ThisTimeLineID, endLogId, endLogSeg);
4436 4437 4438 4439 4440 4441 4442 4443 4444 4445

	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(),
4446
					 errmsg("could not rename file \"%s\" to \"%s\": %m",
4447 4448 4449 4450 4451 4452 4453 4454 4455 4456
							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 已提交
4457

4458
		/*
B
Bruce Momjian 已提交
4459 4460 4461
		 * 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.
4462 4463 4464 4465
		 */
		if (endTLI != ThisTimeLineID)
			XLogFileCopy(endLogId, endLogSeg,
						 endTLI, endLogId, endLogSeg);
4466 4467 4468
	}

	/*
B
Bruce Momjian 已提交
4469 4470
	 * Let's just make real sure there are not .ready or .done flags posted
	 * for the new segment.
4471
	 */
4472 4473
	XLogFileName(xlogpath, ThisTimeLineID, endLogId, endLogSeg);
	XLogArchiveCleanup(xlogpath);
4474

4475
	/* Get rid of any remaining recovered timeline-history file, too */
4476
	snprintf(recoveryPath, MAXPGPATH, XLOGDIR "/RECOVERYHISTORY");
B
Bruce Momjian 已提交
4477
	unlink(recoveryPath);		/* ignore any error */
4478 4479

	/*
B
Bruce Momjian 已提交
4480 4481
	 * Rename the config file out of the way, so that we don't accidentally
	 * re-enter archive recovery mode in a subsequent crash.
4482
	 */
4483 4484
	unlink(RECOVERY_COMMAND_DONE);
	if (rename(RECOVERY_COMMAND_FILE, RECOVERY_COMMAND_DONE) != 0)
4485 4486
		ereport(FATAL,
				(errcode_for_file_access(),
4487
				 errmsg("could not rename file \"%s\" to \"%s\": %m",
4488
						RECOVERY_COMMAND_FILE, RECOVERY_COMMAND_DONE)));
4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499

	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.
4500 4501
 * Also, some information is saved in recoveryStopXid et al for use in
 * annotating the new timeline's history file.
4502 4503 4504 4505 4506
 */
static bool
recoveryStopsHere(XLogRecord *record, bool *includeThis)
{
	bool		stopsHere;
B
Bruce Momjian 已提交
4507
	uint8		record_info;
4508
	TimestampTz	recordXtime;
4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519

	/* 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 已提交
4520
		xl_xact_commit *recordXactCommitData;
4521 4522

		recordXactCommitData = (xl_xact_commit *) XLogRecGetData(record);
4523
		recordXtime = recordXactCommitData->xact_time;
4524 4525 4526
	}
	else if (record_info == XLOG_XACT_ABORT)
	{
B
Bruce Momjian 已提交
4527
		xl_xact_abort *recordXactAbortData;
4528 4529

		recordXactAbortData = (xl_xact_abort *) XLogRecGetData(record);
4530
		recordXtime = recordXactAbortData->xact_time;
4531 4532 4533 4534 4535 4536 4537
	}
	else
		return false;

	if (recoveryTargetExact)
	{
		/*
B
Bruce Momjian 已提交
4538 4539
		 * there can be only one transaction end record with this exact
		 * transactionid
4540
		 *
B
Bruce Momjian 已提交
4541
		 * when testing for an xid, we MUST test for equality only, since
B
Bruce Momjian 已提交
4542 4543 4544
		 * 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...
4545 4546 4547 4548 4549 4550 4551 4552
		 */
		stopsHere = (record->xl_xid == recoveryTargetXid);
		if (stopsHere)
			*includeThis = recoveryTargetInclusive;
	}
	else
	{
		/*
B
Bruce Momjian 已提交
4553 4554 4555
		 * 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
4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566
		 */
		if (recoveryTargetInclusive)
			stopsHere = (recordXtime > recoveryTargetTime);
		else
			stopsHere = (recordXtime >= recoveryTargetTime);
		if (stopsHere)
			*includeThis = false;
	}

	if (stopsHere)
	{
4567 4568 4569 4570
		recoveryStopXid = record->xl_xid;
		recoveryStopTime = recordXtime;
		recoveryStopAfter = *includeThis;

4571 4572
		if (record_info == XLOG_XACT_COMMIT)
		{
4573
			if (recoveryStopAfter)
4574 4575
				ereport(LOG,
						(errmsg("recovery stopping after commit of transaction %u, time %s",
4576 4577
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4578 4579 4580
			else
				ereport(LOG,
						(errmsg("recovery stopping before commit of transaction %u, time %s",
4581 4582
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4583 4584 4585
		}
		else
		{
4586
			if (recoveryStopAfter)
4587 4588
				ereport(LOG,
						(errmsg("recovery stopping after abort of transaction %u, time %s",
4589 4590
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4591 4592 4593
			else
				ereport(LOG,
						(errmsg("recovery stopping before abort of transaction %u, time %s",
4594 4595
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4596 4597 4598 4599 4600 4601
		}
	}

	return stopsHere;
}

4602
/*
T
Tom Lane 已提交
4603
 * This must be called ONCE during postmaster or standalone-backend startup
4604 4605
 */
void
T
Tom Lane 已提交
4606
StartupXLOG(void)
4607
{
4608 4609
	XLogCtlInsert *Insert;
	CheckPoint	checkPoint;
T
Tom Lane 已提交
4610
	bool		wasShutdown;
4611
	bool		needNewTimeLine = false;
4612
	bool		haveBackupLabel = false;
4613
	XLogRecPtr	RecPtr,
T
Tom Lane 已提交
4614 4615
				LastRec,
				checkPointLoc,
4616
				minRecoveryLoc,
T
Tom Lane 已提交
4617
				EndOfLog;
4618 4619
	uint32		endLogId;
	uint32		endLogSeg;
4620
	XLogRecord *record;
4621
	uint32		freespace;
4622
	TransactionId oldestActiveXID;
4623

4624
	/*
4625 4626
	 * Read control file and check XLOG status looks valid.
	 *
4627 4628
	 * 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.
4629
	 */
4630
	ReadControlFile();
4631

4632
	if (ControlFile->state < DB_SHUTDOWNED ||
4633
		ControlFile->state > DB_IN_PRODUCTION ||
4634
		!XRecOffIsValid(ControlFile->checkPoint.xrecoff))
4635 4636
		ereport(FATAL,
				(errmsg("control file contains invalid data")));
4637 4638

	if (ControlFile->state == DB_SHUTDOWNED)
4639 4640 4641
		ereport(LOG,
				(errmsg("database system was shut down at %s",
						str_time(ControlFile->time))));
4642
	else if (ControlFile->state == DB_SHUTDOWNING)
4643
		ereport(LOG,
4644
				(errmsg("database system shutdown was interrupted; last known up at %s",
4645
						str_time(ControlFile->time))));
4646
	else if (ControlFile->state == DB_IN_CRASH_RECOVERY)
4647
		ereport(LOG,
B
Bruce Momjian 已提交
4648 4649 4650 4651
		   (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.")));
4652 4653
	else if (ControlFile->state == DB_IN_ARCHIVE_RECOVERY)
		ereport(LOG,
B
Bruce Momjian 已提交
4654 4655
				(errmsg("database system was interrupted while in recovery at log time %s",
						str_time(ControlFile->checkPointCopy.time)),
4656 4657
				 errhint("If this has occurred more than once some data might be corrupted"
				" and you might need to choose an earlier recovery target.")));
4658
	else if (ControlFile->state == DB_IN_PRODUCTION)
4659
		ereport(LOG,
4660
				(errmsg("database system was interrupted; last known up at %s",
4661
						str_time(ControlFile->time))));
4662

4663 4664
	/* This is just to allow attaching to startup process with a debugger */
#ifdef XLOG_REPLAY_DELAY
4665
	if (ControlFile->state != DB_SHUTDOWNED)
4666
		pg_usleep(60000000L);
4667 4668
#endif

4669
	/*
B
Bruce Momjian 已提交
4670 4671
	 * Initialize on the assumption we want to recover to the same timeline
	 * that's active according to pg_control.
4672 4673 4674
	 */
	recoveryTargetTLI = ControlFile->checkPointCopy.ThisTimeLineID;

4675
	/*
B
Bruce Momjian 已提交
4676 4677
	 * Check for recovery control file, and if so set up state for offline
	 * recovery
4678 4679 4680
	 */
	readRecoveryCommandFile();

4681 4682 4683
	/* Now we can determine the list of expected TLIs */
	expectedTLIs = readTimeLineHistory(recoveryTargetTLI);

4684 4685 4686 4687 4688 4689
	/*
	 * 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 已提交
4690
						 (int) ControlFile->checkPointCopy.ThisTimeLineID))
4691 4692 4693 4694 4695
		ereport(FATAL,
				(errmsg("requested timeline %u is not a child of database system timeline %u",
						recoveryTargetTLI,
						ControlFile->checkPointCopy.ThisTimeLineID)));

4696
	if (read_backup_label(&checkPointLoc, &minRecoveryLoc))
T
Tom Lane 已提交
4697
	{
4698
		/*
B
Bruce Momjian 已提交
4699 4700
		 * When a backup_label file is present, we want to roll forward from
		 * the checkpoint it identifies, rather than using pg_control.
4701
		 */
4702
		record = ReadCheckpointRecord(checkPointLoc, 0);
4703 4704
		if (record != NULL)
		{
4705
			ereport(DEBUG1,
4706
					(errmsg("checkpoint record is at %X/%X",
B
Bruce Momjian 已提交
4707
							checkPointLoc.xlogid, checkPointLoc.xrecoff)));
4708 4709 4710 4711 4712
			InRecovery = true;	/* force recovery even if SHUTDOWNED */
		}
		else
		{
			ereport(PANIC,
B
Bruce Momjian 已提交
4713 4714
					(errmsg("could not locate required checkpoint record"),
					 errhint("If you are not restoring from a backup, try removing the file \"%s/backup_label\".", DataDir)));
4715
		}
4716 4717
		/* set flag to delete it later */
		haveBackupLabel = true;
T
Tom Lane 已提交
4718 4719 4720
	}
	else
	{
4721
		/*
B
Bruce Momjian 已提交
4722 4723
		 * Get the last valid checkpoint record.  If the latest one according
		 * to pg_control is broken, try the next-to-last one.
4724 4725
		 */
		checkPointLoc = ControlFile->checkPoint;
4726
		record = ReadCheckpointRecord(checkPointLoc, 1);
T
Tom Lane 已提交
4727 4728
		if (record != NULL)
		{
4729
			ereport(DEBUG1,
4730
					(errmsg("checkpoint record is at %X/%X",
B
Bruce Momjian 已提交
4731
							checkPointLoc.xlogid, checkPointLoc.xrecoff)));
T
Tom Lane 已提交
4732 4733
		}
		else
4734 4735
		{
			checkPointLoc = ControlFile->prevCheckPoint;
4736
			record = ReadCheckpointRecord(checkPointLoc, 2);
4737 4738 4739
			if (record != NULL)
			{
				ereport(LOG,
B
Bruce Momjian 已提交
4740 4741 4742
						(errmsg("using previous checkpoint record at %X/%X",
							  checkPointLoc.xlogid, checkPointLoc.xrecoff)));
				InRecovery = true;		/* force recovery even if SHUTDOWNED */
4743 4744 4745
			}
			else
				ereport(PANIC,
B
Bruce Momjian 已提交
4746
					 (errmsg("could not locate a valid checkpoint record")));
4747
		}
T
Tom Lane 已提交
4748
	}
4749

T
Tom Lane 已提交
4750 4751 4752
	LastRec = RecPtr = checkPointLoc;
	memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
	wasShutdown = (record->xl_info == XLOG_CHECKPOINT_SHUTDOWN);
4753

4754
	ereport(DEBUG1,
4755
	 (errmsg("redo record is at %X/%X; shutdown %s",
B
Bruce Momjian 已提交
4756 4757
			 checkPoint.redo.xlogid, checkPoint.redo.xrecoff,
			 wasShutdown ? "TRUE" : "FALSE")));
4758
	ereport(DEBUG1,
4759 4760 4761
			(errmsg("next transaction ID: %u/%u; next OID: %u",
					checkPoint.nextXidEpoch, checkPoint.nextXid,
					checkPoint.nextOid)));
4762
	ereport(DEBUG1,
4763 4764
			(errmsg("next MultiXactId: %u; next MultiXactOffset: %u",
					checkPoint.nextMulti, checkPoint.nextMultiOffset)));
4765
	if (!TransactionIdIsNormal(checkPoint.nextXid))
4766
		ereport(PANIC,
4767
				(errmsg("invalid next transaction ID")));
4768 4769 4770

	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
4771
	ShmemVariableCache->oidCount = 0;
4772
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
4773

4774
	/*
B
Bruce Momjian 已提交
4775 4776 4777
	 * 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()).
4778
	 */
4779
	ThisTimeLineID = checkPoint.ThisTimeLineID;
4780

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

4783
	if (XLByteLT(RecPtr, checkPoint.redo))
4784 4785
		ereport(PANIC,
				(errmsg("invalid redo in checkpoint record")));
4786

4787
	/*
B
Bruce Momjian 已提交
4788
	 * Check whether we need to force recovery from WAL.  If it appears to
B
Bruce Momjian 已提交
4789 4790
	 * have been a clean shutdown and we did not have a recovery.conf file,
	 * then assume no recovery needed.
4791
	 */
4792
	if (XLByteLT(checkPoint.redo, RecPtr))
4793
	{
T
Tom Lane 已提交
4794
		if (wasShutdown)
4795
			ereport(PANIC,
4796
				(errmsg("invalid redo record in shutdown checkpoint")));
V
WAL  
Vadim B. Mikheev 已提交
4797
		InRecovery = true;
4798 4799
	}
	else if (ControlFile->state != DB_SHUTDOWNED)
V
WAL  
Vadim B. Mikheev 已提交
4800
		InRecovery = true;
4801 4802 4803 4804 4805
	else if (InArchiveRecovery)
	{
		/* force recovery due to presence of recovery.conf */
		InRecovery = true;
	}
4806

V
WAL  
Vadim B. Mikheev 已提交
4807
	/* REDO */
4808
	if (InRecovery)
4809
	{
B
Bruce Momjian 已提交
4810
		int			rmid;
4811

4812
		/*
B
Bruce Momjian 已提交
4813 4814 4815 4816
		 * 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.
4817
		 */
4818
		if (InArchiveRecovery)
4819
		{
4820
			ereport(LOG,
4821
					(errmsg("automatic recovery in progress")));
4822 4823
			ControlFile->state = DB_IN_ARCHIVE_RECOVERY;
		}
4824
		else
4825
		{
4826
			ereport(LOG,
4827 4828
					(errmsg("database system was not properly shut down; "
							"automatic recovery in progress")));
4829 4830 4831 4832 4833 4834 4835
			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;
4836 4837 4838
		ControlFile->time = time(NULL);
		UpdateControlFile();

4839
		/*
B
Bruce Momjian 已提交
4840 4841 4842 4843 4844 4845
		 * 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.
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856
		 */
		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)));
		}

4857
		/* Start up the recovery environment */
V
WAL  
Vadim B. Mikheev 已提交
4858
		XLogInitRelationCache();
V
Vadim B. Mikheev 已提交
4859

4860 4861 4862 4863 4864 4865
		for (rmid = 0; rmid <= RM_MAX_ID; rmid++)
		{
			if (RmgrTable[rmid].rm_startup != NULL)
				RmgrTable[rmid].rm_startup();
		}

4866
		/*
B
Bruce Momjian 已提交
4867 4868
		 * Find the first record that logically follows the checkpoint --- it
		 * might physically precede it, though.
4869
		 */
4870
		if (XLByteLT(checkPoint.redo, RecPtr))
4871 4872
		{
			/* back up to find the record */
4873
			record = ReadRecord(&(checkPoint.redo), PANIC);
4874
		}
B
Bruce Momjian 已提交
4875
		else
4876
		{
4877
			/* just have to read next record after CheckPoint */
4878
			record = ReadRecord(NULL, LOG);
4879
		}
4880

T
Tom Lane 已提交
4881
		if (record != NULL)
4882
		{
4883 4884
			bool		recoveryContinue = true;
			bool		recoveryApply = true;
B
Bruce Momjian 已提交
4885
			ErrorContextCallback errcontext;
4886

V
WAL  
Vadim B. Mikheev 已提交
4887
			InRedo = true;
4888 4889 4890
			ereport(LOG,
					(errmsg("redo starts at %X/%X",
							ReadRecPtr.xlogid, ReadRecPtr.xrecoff)));
4891 4892 4893 4894

			/*
			 * main redo apply loop
			 */
4895 4896
			do
			{
4897
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
4898 4899
				if (XLOG_DEBUG)
				{
B
Bruce Momjian 已提交
4900
					StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
4901

4902 4903
					initStringInfo(&buf);
					appendStringInfo(&buf, "REDO @ %X/%X; LSN %X/%X: ",
B
Bruce Momjian 已提交
4904 4905
									 ReadRecPtr.xlogid, ReadRecPtr.xrecoff,
									 EndRecPtr.xlogid, EndRecPtr.xrecoff);
4906 4907 4908 4909
					xlog_outrec(&buf, record);
					appendStringInfo(&buf, " - ");
					RmgrTable[record->xl_rmid].rm_desc(&buf,
													   record->xl_info,
B
Bruce Momjian 已提交
4910
													 XLogRecGetData(record));
4911 4912
					elog(LOG, "%s", buf.data);
					pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
4913
				}
4914
#endif
V
WAL  
Vadim B. Mikheev 已提交
4915

4916 4917 4918 4919 4920
				/*
				 * Have we reached our recovery target?
				 */
				if (recoveryStopsHere(record, &recoveryApply))
				{
B
Bruce Momjian 已提交
4921
					needNewTimeLine = true;		/* see below */
4922 4923 4924 4925 4926
					recoveryContinue = false;
					if (!recoveryApply)
						break;
				}

4927 4928 4929 4930 4931 4932
				/* 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;

4933 4934
				/* nextXid must be beyond record's xid */
				if (TransactionIdFollowsOrEquals(record->xl_xid,
B
Bruce Momjian 已提交
4935
												 ShmemVariableCache->nextXid))
4936 4937 4938 4939 4940
				{
					ShmemVariableCache->nextXid = record->xl_xid;
					TransactionIdAdvance(ShmemVariableCache->nextXid);
				}

T
Tom Lane 已提交
4941
				if (record->xl_info & XLR_BKP_BLOCK_MASK)
4942 4943
					RestoreBkpBlocks(record, EndRecPtr);

4944
				RmgrTable[record->xl_rmid].rm_redo(EndRecPtr, record);
4945

4946 4947 4948
				/* Pop the error context stack */
				error_context_stack = errcontext.previous;

4949 4950
				LastRec = ReadRecPtr;

4951
				record = ReadRecord(NULL, LOG);
4952
			} while (record != NULL && recoveryContinue);
B
Bruce Momjian 已提交
4953

4954 4955 4956 4957
			/*
			 * end of main redo apply loop
			 */

4958 4959 4960
			ereport(LOG,
					(errmsg("redo done at %X/%X",
							ReadRecPtr.xlogid, ReadRecPtr.xrecoff)));
V
WAL  
Vadim B. Mikheev 已提交
4961
			InRedo = false;
4962 4963
		}
		else
4964 4965
		{
			/* there are no WAL records following the checkpoint */
4966 4967
			ereport(LOG,
					(errmsg("redo is not required")));
4968
		}
V
WAL  
Vadim B. Mikheev 已提交
4969 4970
	}

T
Tom Lane 已提交
4971
	/*
B
Bruce Momjian 已提交
4972 4973
	 * 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 已提交
4974
	 */
4975
	record = ReadRecord(&LastRec, PANIC);
T
Tom Lane 已提交
4976
	EndOfLog = EndRecPtr;
4977 4978
	XLByteToPrevSeg(EndOfLog, endLogId, endLogSeg);

4979 4980 4981 4982
	/*
	 * Complain if we did not roll forward far enough to render the backup
	 * dump consistent.
	 */
4983
	if (XLByteLT(EndOfLog, ControlFile->minRecoveryPoint))
4984 4985 4986 4987
	{
		if (needNewTimeLine)	/* stopped because of stop request */
			ereport(FATAL,
					(errmsg("requested recovery stop point is before end time of backup dump")));
B
Bruce Momjian 已提交
4988
		else
4989
			/* ran off end of WAL */
4990 4991 4992 4993
			ereport(FATAL,
					(errmsg("WAL ends before end time of backup dump")));
	}

4994 4995 4996
	/*
	 * Consider whether we need to assign a new timeline ID.
	 *
B
Bruce Momjian 已提交
4997 4998
	 * 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 已提交
4999 5000
	 * Otherwise, we can just extend the timeline we were in when we ran out
	 * of WAL.
5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013
	 */
	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;

5014
	/*
B
Bruce Momjian 已提交
5015 5016 5017 5018
	 * 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.)
5019 5020
	 */
	if (InArchiveRecovery)
5021
		exitArchiveRecovery(curFileTLI, endLogId, endLogSeg);
5022 5023 5024 5025 5026 5027 5028 5029

	/*
	 * 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;
5030
	openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
5031
	openLogOff = 0;
V
WAL  
Vadim B. Mikheev 已提交
5032
	Insert = &XLogCtl->Insert;
5033
	Insert->PrevRecord = LastRec;
5034 5035
	XLogCtl->xlblocks[0].xlogid = openLogId;
	XLogCtl->xlblocks[0].xrecoff =
5036
		((EndOfLog.xrecoff - 1) / XLOG_BLCKSZ + 1) * XLOG_BLCKSZ;
B
Bruce Momjian 已提交
5037 5038

	/*
B
Bruce Momjian 已提交
5039 5040 5041
	 * 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 已提交
5042
	 */
5043 5044
	Assert(readOff == (XLogCtl->xlblocks[0].xrecoff - XLOG_BLCKSZ) % XLogSegSize);
	memcpy((char *) Insert->currpage, readBuf, XLOG_BLCKSZ);
5045
	Insert->currpos = (char *) Insert->currpage +
5046
		(EndOfLog.xrecoff + XLOG_BLCKSZ - XLogCtl->xlblocks[0].xrecoff);
V
WAL  
Vadim B. Mikheev 已提交
5047

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

T
Tom Lane 已提交
5050 5051 5052
	XLogCtl->Write.LogwrtResult = LogwrtResult;
	Insert->LogwrtResult = LogwrtResult;
	XLogCtl->LogwrtResult = LogwrtResult;
V
WAL  
Vadim B. Mikheev 已提交
5053

T
Tom Lane 已提交
5054 5055
	XLogCtl->LogwrtRqst.Write = EndOfLog;
	XLogCtl->LogwrtRqst.Flush = EndOfLog;
5056

5057 5058 5059 5060 5061 5062 5063 5064 5065 5066
	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 已提交
5067 5068
		 * Whenever Write.LogwrtResult points to exactly the end of a page,
		 * Write.curridx must point to the *next* page (see XLogWrite()).
5069
		 *
B
Bruce Momjian 已提交
5070
		 * Note: it might seem we should do AdvanceXLInsertBuffer() here, but
B
Bruce Momjian 已提交
5071
		 * this is sufficient.	The first actual attempt to insert a log
5072
		 * record will advance the insert state.
5073 5074 5075 5076
		 */
		XLogCtl->Write.curridx = NextBufIdx(0);
	}

5077 5078
	/* Pre-scan prepared transactions to find out the range of XIDs present */
	oldestActiveXID = PrescanPreparedTransactions();
5079

V
WAL  
Vadim B. Mikheev 已提交
5080
	if (InRecovery)
5081
	{
B
Bruce Momjian 已提交
5082
		int			rmid;
5083 5084 5085 5086 5087 5088 5089 5090 5091 5092

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

5093 5094 5095 5096 5097 5098
		/*
		 * Check to see if the XLOG sequence contained any unresolved
		 * references to uninitialized pages.
		 */
		XLogCheckInvalidPages();

5099 5100 5101 5102 5103
		/*
		 * Reset pgstat data, because it may be invalid after recovery.
		 */
		pgstat_reset_all();

T
Tom Lane 已提交
5104
		/*
5105
		 * Perform a checkpoint to update all our recovery activity to disk.
5106
		 *
5107 5108 5109 5110 5111
		 * 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 已提交
5112
		 */
5113
		CreateCheckPoint(true, true);
5114 5115 5116 5117

		/*
		 * Close down recovery environment
		 */
V
WAL  
Vadim B. Mikheev 已提交
5118
		XLogCloseRelationCache();
5119
	}
5120

T
Tom Lane 已提交
5121 5122 5123
	/*
	 * Preallocate additional log files, if wanted.
	 */
5124
	(void) PreallocXlogFiles(EndOfLog);
5125

5126 5127 5128
	/*
	 * Okay, we're officially UP.
	 */
V
WAL  
Vadim B. Mikheev 已提交
5129
	InRecovery = false;
5130 5131 5132 5133 5134

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

5135 5136 5137
	/* start the archive_timeout timer running */
	XLogCtl->Write.lastSegSwitchTime = ControlFile->time;

5138 5139 5140 5141
	/* initialize shared-memory copy of latest checkpoint XID/epoch */
	XLogCtl->ckptXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	XLogCtl->ckptXid = ControlFile->checkPointCopy.nextXid;

5142
	/* Start up the commit log and related stuff, too */
5143
	StartupCLOG();
5144
	StartupSUBTRANS(oldestActiveXID);
5145
	StartupMultiXact();
5146

5147 5148 5149
	/* Reload shared-memory state for prepared transactions */
	RecoverPreparedTransactions();

T
Tom Lane 已提交
5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160
	/* Shut down readFile facility, free space */
	if (readFile >= 0)
	{
		close(readFile);
		readFile = -1;
	}
	if (readBuf)
	{
		free(readBuf);
		readBuf = NULL;
	}
5161 5162 5163 5164 5165 5166
	if (readRecordBuf)
	{
		free(readRecordBuf);
		readRecordBuf = NULL;
		readRecordBufSize = 0;
	}
T
Tom Lane 已提交
5167 5168
}

5169 5170
/*
 * Subroutine to try to fetch and validate a prior checkpoint record.
5171 5172 5173
 *
 * whichChkpt identifies the checkpoint (merely for reporting purposes).
 * 1 for "primary", 2 for "secondary", 0 for "other" (backup_label)
5174
 */
T
Tom Lane 已提交
5175
static XLogRecord *
5176
ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt)
T
Tom Lane 已提交
5177 5178 5179 5180 5181
{
	XLogRecord *record;

	if (!XRecOffIsValid(RecPtr.xrecoff))
	{
5182 5183 5184 5185
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5186
				(errmsg("invalid primary checkpoint link in control file")));
5187 5188 5189 5190 5191 5192 5193
				break;
			case 2:
				ereport(LOG,
						(errmsg("invalid secondary checkpoint link in control file")));
				break;
			default:
				ereport(LOG,
B
Bruce Momjian 已提交
5194
				   (errmsg("invalid checkpoint link in backup_label file")));
5195 5196
				break;
		}
T
Tom Lane 已提交
5197 5198 5199
		return NULL;
	}

5200
	record = ReadRecord(&RecPtr, LOG);
T
Tom Lane 已提交
5201 5202 5203

	if (record == NULL)
	{
5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218
		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 已提交
5219 5220 5221 5222
		return NULL;
	}
	if (record->xl_rmid != RM_XLOG_ID)
	{
5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234
		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 已提交
5235
				(errmsg("invalid resource manager ID in checkpoint record")));
5236 5237
				break;
		}
T
Tom Lane 已提交
5238 5239 5240 5241 5242
		return NULL;
	}
	if (record->xl_info != XLOG_CHECKPOINT_SHUTDOWN &&
		record->xl_info != XLOG_CHECKPOINT_ONLINE)
	{
5243 5244 5245 5246
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5247
				   (errmsg("invalid xl_info in primary checkpoint record")));
5248 5249 5250
				break;
			case 2:
				ereport(LOG,
B
Bruce Momjian 已提交
5251
				 (errmsg("invalid xl_info in secondary checkpoint record")));
5252 5253 5254 5255 5256 5257
				break;
			default:
				ereport(LOG,
						(errmsg("invalid xl_info in checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5258 5259
		return NULL;
	}
5260 5261
	if (record->xl_len != sizeof(CheckPoint) ||
		record->xl_tot_len != SizeOfXLogRecord + sizeof(CheckPoint))
T
Tom Lane 已提交
5262
	{
5263 5264 5265 5266
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5267
					(errmsg("invalid length of primary checkpoint record")));
5268 5269 5270
				break;
			case 2:
				ereport(LOG,
B
Bruce Momjian 已提交
5271
				  (errmsg("invalid length of secondary checkpoint record")));
5272 5273 5274 5275 5276 5277
				break;
			default:
				ereport(LOG,
						(errmsg("invalid length of checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5278 5279 5280
		return NULL;
	}
	return record;
5281 5282
}

V
WAL  
Vadim B. Mikheev 已提交
5283
/*
5284 5285
 * This must be called during startup of a backend process, except that
 * it need not be called in a standalone backend (which does StartupXLOG
5286
 * instead).  We need to initialize the local copies of ThisTimeLineID and
5287 5288
 * RedoRecPtr.
 *
5289
 * Note: before Postgres 8.0, we went to some effort to keep the postmaster
5290
 * process's copies of ThisTimeLineID and RedoRecPtr valid too.  This was
5291
 * unnecessary however, since the postmaster itself never touches XLOG anyway.
V
WAL  
Vadim B. Mikheev 已提交
5292 5293
 */
void
5294
InitXLOGAccess(void)
V
WAL  
Vadim B. Mikheev 已提交
5295
{
5296 5297
	/* ThisTimeLineID doesn't change so we need no lock to copy it */
	ThisTimeLineID = XLogCtl->ThisTimeLineID;
5298 5299
	/* Use GetRedoRecPtr to copy the RedoRecPtr safely */
	(void) GetRedoRecPtr();
5300 5301 5302 5303 5304 5305 5306 5307
}

/*
 * 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
5308 5309
GetRedoRecPtr(void)
{
5310 5311 5312
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;

5313
	SpinLockAcquire(&xlogctl->info_lck);
5314 5315
	Assert(XLByteLE(RedoRecPtr, xlogctl->Insert.RedoRecPtr));
	RedoRecPtr = xlogctl->Insert.RedoRecPtr;
5316
	SpinLockRelease(&xlogctl->info_lck);
5317 5318

	return RedoRecPtr;
V
WAL  
Vadim B. Mikheev 已提交
5319 5320
}

5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336
/*
 * 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;
}

5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347
/*
 * 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 已提交
5348 5349 5350
	uint32		ckptXidEpoch;
	TransactionId ckptXid;
	TransactionId nextXid;
5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376

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

5377
/*
T
Tom Lane 已提交
5378
 * This must be called ONCE during postmaster or standalone-backend shutdown
5379 5380
 */
void
5381
ShutdownXLOG(int code, Datum arg)
5382
{
5383 5384
	ereport(LOG,
			(errmsg("shutting down")));
5385

5386
	CreateCheckPoint(true, true);
5387
	ShutdownCLOG();
5388
	ShutdownSUBTRANS();
5389
	ShutdownMultiXact();
5390

5391 5392
	ereport(LOG,
			(errmsg("database system is shut down")));
5393 5394
}

T
Tom Lane 已提交
5395 5396
/*
 * Perform a checkpoint --- either during shutdown, or on-the-fly
5397 5398 5399
 *
 * If force is true, we force a checkpoint regardless of whether any XLOG
 * activity has occurred since the last one.
T
Tom Lane 已提交
5400
 */
5401
void
5402
CreateCheckPoint(bool shutdown, bool force)
5403
{
5404 5405 5406
	CheckPoint	checkPoint;
	XLogRecPtr	recptr;
	XLogCtlInsert *Insert = &XLogCtl->Insert;
B
Bruce Momjian 已提交
5407
	XLogRecData rdata;
5408
	uint32		freespace;
V
Vadim B. Mikheev 已提交
5409 5410
	uint32		_logId;
	uint32		_logSeg;
5411 5412 5413
	int			nsegsadded = 0;
	int			nsegsremoved = 0;
	int			nsegsrecycled = 0;
5414 5415
	TransactionId *inCommitXids;
	int			nInCommit;
V
Vadim B. Mikheev 已提交
5416

5417
	/*
B
Bruce Momjian 已提交
5418 5419 5420 5421
	 * 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.)
5422
	 */
5423
	LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
5424

5425 5426 5427
	/*
	 * Use a critical section to force system panic if we have trouble.
	 */
5428 5429
	START_CRIT_SECTION();

5430 5431 5432 5433 5434 5435
	if (shutdown)
	{
		ControlFile->state = DB_SHUTDOWNING;
		ControlFile->time = time(NULL);
		UpdateControlFile();
	}
T
Tom Lane 已提交
5436

5437
	MemSet(&checkPoint, 0, sizeof(checkPoint));
5438
	checkPoint.ThisTimeLineID = ThisTimeLineID;
T
Tom Lane 已提交
5439
	checkPoint.time = time(NULL);
5440

5441
	/*
5442 5443
	 * We must hold WALInsertLock while examining insert state to determine
	 * the checkpoint REDO pointer.
5444
	 */
5445
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
T
Tom Lane 已提交
5446 5447

	/*
B
Bruce Momjian 已提交
5448 5449 5450 5451 5452 5453 5454 5455
	 * 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 已提交
5456
	 *
5457 5458 5459 5460
	 * 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 已提交
5461
	 */
5462
	if (!shutdown && !force)
T
Tom Lane 已提交
5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474
	{
		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)
		{
5475 5476
			LWLockRelease(WALInsertLock);
			LWLockRelease(CheckpointLock);
T
Tom Lane 已提交
5477 5478 5479 5480 5481 5482 5483 5484
			END_CRIT_SECTION();
			return;
		}
	}

	/*
	 * Compute new REDO record ptr = location of next XLOG record.
	 *
B
Bruce Momjian 已提交
5485 5486 5487 5488
	 * 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 已提交
5489 5490
	 */
	freespace = INSERT_FREESPACE(Insert);
5491 5492
	if (freespace < SizeOfXLogRecord)
	{
5493
		(void) AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
5494
		/* OK to ignore update return flag, since we will do flush anyway */
5495
		freespace = INSERT_FREESPACE(Insert);
5496
	}
T
Tom Lane 已提交
5497
	INSERT_RECPTR(checkPoint.redo, Insert, Insert->curridx);
B
Bruce Momjian 已提交
5498

T
Tom Lane 已提交
5499
	/*
B
Bruce Momjian 已提交
5500 5501
	 * Here we update the shared RedoRecPtr for future XLogInsert calls; this
	 * must be done while holding the insert lock AND the info_lck.
5502
	 *
B
Bruce Momjian 已提交
5503
	 * Note: if we fail to complete the checkpoint, RedoRecPtr will be left
B
Bruce Momjian 已提交
5504 5505 5506 5507 5508
	 * 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 已提交
5509
	 */
5510 5511 5512 5513
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

5514
		SpinLockAcquire(&xlogctl->info_lck);
5515
		RedoRecPtr = xlogctl->Insert.RedoRecPtr = checkPoint.redo;
5516
		SpinLockRelease(&xlogctl->info_lck);
5517
	}
B
Bruce Momjian 已提交
5518

T
Tom Lane 已提交
5519
	/*
5520 5521
	 * Now we can release WAL insert lock, allowing other xacts to proceed
	 * while we are flushing disk buffers.
T
Tom Lane 已提交
5522
	 */
5523
	LWLockRelease(WALInsertLock);
5524

5525 5526 5527 5528
	if (!shutdown)
		ereport(DEBUG2,
				(errmsg("checkpoint starting")));

5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561
	/*
	 * 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);

5562 5563 5564
	/*
	 * Get the other info we need for the checkpoint record.
	 */
5565
	LWLockAcquire(XidGenLock, LW_SHARED);
5566
	checkPoint.nextXid = ShmemVariableCache->nextXid;
5567
	LWLockRelease(XidGenLock);
T
Tom Lane 已提交
5568

5569 5570 5571 5572 5573
	/* Increase XID epoch if we've wrapped around since last checkpoint */
	checkPoint.nextXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	if (checkPoint.nextXid < ControlFile->checkPointCopy.nextXid)
		checkPoint.nextXidEpoch++;

5574
	LWLockAcquire(OidGenLock, LW_SHARED);
5575
	checkPoint.nextOid = ShmemVariableCache->nextOid;
5576 5577
	if (!shutdown)
		checkPoint.nextOid += ShmemVariableCache->oidCount;
5578
	LWLockRelease(OidGenLock);
5579

5580 5581 5582
	MultiXactGetCheckptMulti(shutdown,
							 &checkPoint.nextMulti,
							 &checkPoint.nextMultiOffset);
5583

T
Tom Lane 已提交
5584
	/*
B
Bruce Momjian 已提交
5585 5586
	 * Having constructed the checkpoint record, ensure all shmem disk buffers
	 * and commit-log buffers are flushed to disk.
5587
	 *
5588 5589
	 * 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
5590
	 * panic. Accordingly, exit critical section while doing it.
T
Tom Lane 已提交
5591
	 */
5592 5593
	END_CRIT_SECTION();

5594
	CheckPointGuts(checkPoint.redo);
5595

5596 5597
	START_CRIT_SECTION();

T
Tom Lane 已提交
5598 5599 5600
	/*
	 * Now insert the checkpoint record into XLOG.
	 */
B
Bruce Momjian 已提交
5601
	rdata.data = (char *) (&checkPoint);
5602
	rdata.len = sizeof(checkPoint);
5603
	rdata.buffer = InvalidBuffer;
5604 5605
	rdata.next = NULL;

T
Tom Lane 已提交
5606 5607 5608 5609 5610 5611
	recptr = XLogInsert(RM_XLOG_ID,
						shutdown ? XLOG_CHECKPOINT_SHUTDOWN :
						XLOG_CHECKPOINT_ONLINE,
						&rdata);

	XLogFlush(recptr);
5612

T
Tom Lane 已提交
5613
	/*
B
Bruce Momjian 已提交
5614 5615
	 * We now have ProcLastRecPtr = start of actual checkpoint record, recptr
	 * = end of actual checkpoint record.
T
Tom Lane 已提交
5616 5617
	 */
	if (shutdown && !XLByteEQ(checkPoint.redo, ProcLastRecPtr))
5618 5619
		ereport(PANIC,
				(errmsg("concurrent transaction log activity while database system is shutting down")));
5620

T
Tom Lane 已提交
5621
	/*
5622 5623
	 * Select point at which we can truncate the log, which we base on the
	 * prior checkpoint's earliest info.
T
Tom Lane 已提交
5624
	 */
5625
	XLByteToSeg(ControlFile->checkPointCopy.redo, _logId, _logSeg);
5626

T
Tom Lane 已提交
5627 5628 5629
	/*
	 * Update the control file.
	 */
5630
	LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
5631 5632
	if (shutdown)
		ControlFile->state = DB_SHUTDOWNED;
T
Tom Lane 已提交
5633 5634 5635
	ControlFile->prevCheckPoint = ControlFile->checkPoint;
	ControlFile->checkPoint = ProcLastRecPtr;
	ControlFile->checkPointCopy = checkPoint;
5636 5637
	ControlFile->time = time(NULL);
	UpdateControlFile();
5638
	LWLockRelease(ControlFileLock);
5639

5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650
	/* 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);
	}

5651
	/*
B
Bruce Momjian 已提交
5652 5653
	 * We are now done with critical updates; no need for system panic if we
	 * have trouble while fooling with offline log segments.
5654 5655 5656
	 */
	END_CRIT_SECTION();

V
Vadim B. Mikheev 已提交
5657
	/*
T
Tom Lane 已提交
5658 5659
	 * Delete offline log files (those no longer needed even for previous
	 * checkpoint).
V
Vadim B. Mikheev 已提交
5660 5661 5662
	 */
	if (_logId || _logSeg)
	{
T
Tom Lane 已提交
5663
		PrevLogSeg(_logId, _logSeg);
5664 5665
		MoveOfflineLogs(_logId, _logSeg, recptr,
						&nsegsremoved, &nsegsrecycled);
V
Vadim B. Mikheev 已提交
5666 5667
	}

T
Tom Lane 已提交
5668
	/*
B
Bruce Momjian 已提交
5669 5670
	 * 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 已提交
5671 5672
	 */
	if (!shutdown)
5673
		nsegsadded = PreallocXlogFiles(recptr);
T
Tom Lane 已提交
5674

5675
	/*
B
Bruce Momjian 已提交
5676 5677 5678 5679 5680
	 * 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.
5681
	 */
5682
	if (!InRecovery)
5683
		TruncateSUBTRANS(GetOldestXmin(true, false));
5684

5685
	if (!shutdown)
5686
		ereport(DEBUG2,
5687 5688 5689
				(errmsg("checkpoint complete; %d transaction log file(s) added, %d removed, %d recycled",
						nsegsadded, nsegsremoved, nsegsrecycled)));

5690
	LWLockRelease(CheckpointLock);
5691
}
V
WAL  
Vadim B. Mikheev 已提交
5692

5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704
/*
 * 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 已提交
5705
	FlushBufferPool();			/* performs all required fsyncs */
5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721
	/* 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 已提交
5722 5723
	int			elapsed_secs;
	int			rmid;
5724 5725

	/*
B
Bruce Momjian 已提交
5726 5727
	 * Do nothing if the elapsed time since the last restartpoint is less than
	 * half of checkpoint_timeout.	(We use a value less than
5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756
	 * 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 已提交
5757 5758 5759
	 * Update pg_control so that any subsequent crash will restart from this
	 * checkpoint.	Note: ReadRecPtr gives the XLOG address of the checkpoint
	 * record itself.
5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771
	 */
	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 已提交
5772 5773 5774
/*
 * Write a NEXTOID log record
 */
5775 5776 5777
void
XLogPutNextOid(Oid nextOid)
{
B
Bruce Momjian 已提交
5778
	XLogRecData rdata;
5779

B
Bruce Momjian 已提交
5780
	rdata.data = (char *) (&nextOid);
5781
	rdata.len = sizeof(Oid);
5782
	rdata.buffer = InvalidBuffer;
5783 5784
	rdata.next = NULL;
	(void) XLogInsert(RM_XLOG_ID, XLOG_NEXTOID, &rdata);
B
Bruce Momjian 已提交
5785

5786 5787
	/*
	 * We need not flush the NEXTOID record immediately, because any of the
B
Bruce Momjian 已提交
5788 5789 5790 5791 5792
	 * 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.
5793 5794 5795 5796 5797 5798 5799 5800 5801 5802
	 *
	 * 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.
5803 5804 5805
	 */
}

5806 5807 5808 5809 5810 5811 5812 5813 5814 5815
/*
 * 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.
 */
5816
XLogRecPtr
5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832
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 已提交
5833 5834 5835
/*
 * XLOG resource manager's routines
 */
V
WAL  
Vadim B. Mikheev 已提交
5836 5837 5838
void
xlog_redo(XLogRecPtr lsn, XLogRecord *record)
{
B
Bruce Momjian 已提交
5839
	uint8		info = record->xl_info & ~XLR_INFO_MASK;
5840

5841
	if (info == XLOG_NEXTOID)
5842
	{
B
Bruce Momjian 已提交
5843
		Oid			nextOid;
5844 5845 5846

		memcpy(&nextOid, XLogRecGetData(record), sizeof(Oid));
		if (ShmemVariableCache->nextOid < nextOid)
T
Tom Lane 已提交
5847
		{
5848
			ShmemVariableCache->nextOid = nextOid;
T
Tom Lane 已提交
5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860
			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;
5861 5862
		MultiXactSetNextMXact(checkPoint.nextMulti,
							  checkPoint.nextMultiOffset);
B
Bruce Momjian 已提交
5863

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

5868
		/*
B
Bruce Momjian 已提交
5869
		 * TLI may change in a shutdown checkpoint, but it shouldn't decrease
5870 5871 5872 5873 5874 5875 5876 5877
		 */
		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 已提交
5878
								checkPoint.ThisTimeLineID, ThisTimeLineID)));
5879 5880 5881
			/* Following WAL records should be run with new TLI */
			ThisTimeLineID = checkPoint.ThisTimeLineID;
		}
5882 5883

		RecoveryRestartPoint(&checkPoint);
T
Tom Lane 已提交
5884 5885 5886 5887 5888 5889
	}
	else if (info == XLOG_CHECKPOINT_ONLINE)
	{
		CheckPoint	checkPoint;

		memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
5890
		/* In an ONLINE checkpoint, treat the counters like NEXTOID */
5891 5892
		if (TransactionIdPrecedes(ShmemVariableCache->nextXid,
								  checkPoint.nextXid))
T
Tom Lane 已提交
5893 5894 5895 5896 5897 5898
			ShmemVariableCache->nextXid = checkPoint.nextXid;
		if (ShmemVariableCache->nextOid < checkPoint.nextOid)
		{
			ShmemVariableCache->nextOid = checkPoint.nextOid;
			ShmemVariableCache->oidCount = 0;
		}
5899 5900
		MultiXactAdvanceNextMXact(checkPoint.nextMulti,
								  checkPoint.nextMultiOffset);
5901 5902 5903 5904 5905

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

5906 5907
		/* TLI should not change in an on-line checkpoint */
		if (checkPoint.ThisTimeLineID != ThisTimeLineID)
5908
			ereport(PANIC,
5909 5910
					(errmsg("unexpected timeline ID %u (should be %u) in checkpoint record",
							checkPoint.ThisTimeLineID, ThisTimeLineID)));
5911 5912

		RecoveryRestartPoint(&checkPoint);
5913
	}
5914 5915 5916 5917
	else if (info == XLOG_NOOP)
	{
		/* nothing to do here */
	}
5918 5919 5920 5921
	else if (info == XLOG_SWITCH)
	{
		/* nothing to do here */
	}
V
WAL  
Vadim B. Mikheev 已提交
5922
}
B
Bruce Momjian 已提交
5923

V
WAL  
Vadim B. Mikheev 已提交
5924
void
5925
xlog_desc(StringInfo buf, uint8 xl_info, char *rec)
V
WAL  
Vadim B. Mikheev 已提交
5926
{
B
Bruce Momjian 已提交
5927
	uint8		info = xl_info & ~XLR_INFO_MASK;
V
WAL  
Vadim B. Mikheev 已提交
5928

T
Tom Lane 已提交
5929 5930
	if (info == XLOG_CHECKPOINT_SHUTDOWN ||
		info == XLOG_CHECKPOINT_ONLINE)
V
WAL  
Vadim B. Mikheev 已提交
5931
	{
B
Bruce Momjian 已提交
5932 5933
		CheckPoint *checkpoint = (CheckPoint *) rec;

5934
		appendStringInfo(buf, "checkpoint: redo %X/%X; "
B
Bruce Momjian 已提交
5935 5936 5937 5938 5939 5940 5941 5942
						 "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 已提交
5943
	}
5944 5945 5946 5947
	else if (info == XLOG_NOOP)
	{
		appendStringInfo(buf, "xlog no-op");
	}
5948 5949
	else if (info == XLOG_NEXTOID)
	{
B
Bruce Momjian 已提交
5950
		Oid			nextOid;
5951 5952

		memcpy(&nextOid, rec, sizeof(Oid));
5953
		appendStringInfo(buf, "nextOid: %u", nextOid);
5954
	}
5955 5956 5957 5958
	else if (info == XLOG_SWITCH)
	{
		appendStringInfo(buf, "xlog switch");
	}
V
WAL  
Vadim B. Mikheev 已提交
5959
	else
5960
		appendStringInfo(buf, "UNKNOWN");
V
WAL  
Vadim B. Mikheev 已提交
5961 5962
}

5963
#ifdef WAL_DEBUG
5964

V
WAL  
Vadim B. Mikheev 已提交
5965
static void
5966
xlog_outrec(StringInfo buf, XLogRecord *record)
V
WAL  
Vadim B. Mikheev 已提交
5967
{
B
Bruce Momjian 已提交
5968
	int			i;
5969

5970
	appendStringInfo(buf, "prev %X/%X; xid %u",
5971 5972
					 record->xl_prev.xlogid, record->xl_prev.xrecoff,
					 record->xl_xid);
5973

5974
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
5975
	{
5976
		if (record->xl_info & XLR_SET_BKP_BLOCK(i))
B
Bruce Momjian 已提交
5977
			appendStringInfo(buf, "; bkpb%d", i + 1);
5978 5979
	}

5980
	appendStringInfo(buf, ": %s", RmgrTable[record->xl_rmid].rm_name);
V
WAL  
Vadim B. Mikheev 已提交
5981
}
B
Bruce Momjian 已提交
5982
#endif   /* WAL_DEBUG */
5983 5984 5985


/*
5986
 * GUC support
5987
 */
5988
const char *
5989
assign_xlog_sync_method(const char *method, bool doit, GucSource source)
5990
{
B
Bruce Momjian 已提交
5991 5992
	int			new_sync_method;
	int			new_sync_bit;
5993

5994
	if (pg_strcasecmp(method, "fsync") == 0)
5995 5996 5997 5998
	{
		new_sync_method = SYNC_METHOD_FSYNC;
		new_sync_bit = 0;
	}
5999 6000 6001 6002 6003 6004 6005
#ifdef HAVE_FSYNC_WRITETHROUGH
	else if (pg_strcasecmp(method, "fsync_writethrough") == 0)
	{
		new_sync_method = SYNC_METHOD_FSYNC_WRITETHROUGH;
		new_sync_bit = 0;
	}
#endif
6006
#ifdef HAVE_FDATASYNC
6007
	else if (pg_strcasecmp(method, "fdatasync") == 0)
6008 6009 6010 6011 6012 6013
	{
		new_sync_method = SYNC_METHOD_FDATASYNC;
		new_sync_bit = 0;
	}
#endif
#ifdef OPEN_SYNC_FLAG
6014
	else if (pg_strcasecmp(method, "open_sync") == 0)
6015 6016 6017 6018 6019 6020
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_SYNC_FLAG;
	}
#endif
#ifdef OPEN_DATASYNC_FLAG
6021
	else if (pg_strcasecmp(method, "open_datasync") == 0)
6022 6023 6024 6025 6026 6027
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_DATASYNC_FLAG;
	}
#endif
	else
6028
		return NULL;
6029

6030 6031 6032
	if (!doit)
		return method;

6033 6034 6035
	if (sync_method != new_sync_method || open_sync_bit != new_sync_bit)
	{
		/*
B
Bruce Momjian 已提交
6036 6037
		 * 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 已提交
6038 6039
		 * changing, close the log file so it will be reopened (with new flag
		 * bit) at next use.
6040 6041 6042 6043
		 */
		if (openLogFile >= 0)
		{
			if (pg_fsync(openLogFile) != 0)
6044 6045
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6046 6047
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6048
			if (open_sync_bit != new_sync_bit)
6049
				XLogFileClose();
6050 6051 6052 6053
		}
		sync_method = new_sync_method;
		open_sync_bit = new_sync_bit;
	}
6054 6055

	return method;
6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066
}


/*
 * Issue appropriate kind of fsync (if any) on the current XLOG output file
 */
static void
issue_xlog_fsync(void)
{
	switch (sync_method)
	{
6067
		case SYNC_METHOD_FSYNC:
6068
			if (pg_fsync_no_writethrough(openLogFile) != 0)
6069 6070
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6071 6072
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6073
			break;
6074 6075 6076 6077 6078
#ifdef HAVE_FSYNC_WRITETHROUGH
		case SYNC_METHOD_FSYNC_WRITETHROUGH:
			if (pg_fsync_writethrough(openLogFile) != 0)
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6079 6080
						 errmsg("could not fsync write-through log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6081 6082
			break;
#endif
6083 6084 6085
#ifdef HAVE_FDATASYNC
		case SYNC_METHOD_FDATASYNC:
			if (pg_fdatasync(openLogFile) != 0)
6086 6087
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6088 6089
					errmsg("could not fdatasync log file %u, segment %u: %m",
						   openLogId, openLogSeg)));
6090 6091 6092 6093 6094 6095
			break;
#endif
		case SYNC_METHOD_OPEN:
			/* write synced it already */
			break;
		default:
6096
			elog(PANIC, "unrecognized wal_sync_method: %d", sync_method);
6097 6098 6099
			break;
	}
}
6100 6101 6102 6103 6104 6105 6106 6107 6108


/*
 * 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
6109
 * starting WAL location for the dump.
6110 6111 6112 6113 6114 6115 6116
 */
Datum
pg_start_backup(PG_FUNCTION_ARGS)
{
	text	   *backupid = PG_GETARG_TEXT_P(0);
	text	   *result;
	char	   *backupidstr;
6117
	XLogRecPtr	checkpointloc;
6118
	XLogRecPtr	startpoint;
B
Bruce Momjian 已提交
6119
	time_t		stamp_time;
6120 6121 6122 6123 6124 6125 6126
	char		strfbuf[128];
	char		xlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	struct stat stat_buf;
	FILE	   *fp;

B
Bruce Momjian 已提交
6127
	if (!superuser())
6128 6129 6130
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
6131 6132 6133 6134

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

6139
	backupidstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6140
												 PointerGetDatum(backupid)));
B
Bruce Momjian 已提交
6141

6142
	/*
6143 6144 6145
	 * 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 已提交
6146 6147 6148 6149 6150 6151 6152 6153 6154
	 * 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.)
6155
	 *
B
Bruce Momjian 已提交
6156 6157
	 * We must hold WALInsertLock to change the value of forcePageWrites, to
	 * ensure adequate interlocking against XLogInsert().
6158
	 */
6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169
	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 已提交
6170

6171 6172 6173 6174
	/* Use a TRY block to ensure we release forcePageWrites if fail below */
	PG_TRY();
	{
		/*
B
Bruce Momjian 已提交
6175
		 * Force a CHECKPOINT.	Aside from being necessary to prevent torn
6176 6177 6178 6179 6180
		 * 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);
6181

6182 6183 6184 6185 6186 6187 6188 6189 6190
		/*
		 * 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 已提交
6191

6192 6193
		XLByteToSeg(startpoint, _logId, _logSeg);
		XLogFileName(xlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6194

6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230
		/*
		 * 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)
6231 6232
			ereport(ERROR,
					(errcode_for_file_access(),
6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244
					 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",
6245
							BACKUP_LABEL_FILE)));
6246
	}
6247 6248 6249 6250 6251 6252
	PG_CATCH();
	{
		/* Turn off forcePageWrites on failure */
		LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
		XLogCtl->Insert.forcePageWrites = false;
		LWLockRelease(WALInsertLock);
B
Bruce Momjian 已提交
6253

6254 6255 6256
		PG_RE_THROW();
	}
	PG_END_TRY();
B
Bruce Momjian 已提交
6257

6258
	/*
6259
	 * We're done.  As a convenience, return the starting WAL location.
6260 6261 6262 6263
	 */
	snprintf(xlogfilename, sizeof(xlogfilename), "%X/%X",
			 startpoint.xlogid, startpoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6264
											 CStringGetDatum(xlogfilename)));
6265 6266 6267 6268 6269 6270 6271 6272 6273
	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
6274
 * the label file, plus the backup-end time and WAL location.
6275 6276 6277 6278 6279 6280 6281
 */
Datum
pg_stop_backup(PG_FUNCTION_ARGS)
{
	text	   *result;
	XLogRecPtr	startpoint;
	XLogRecPtr	stoppoint;
B
Bruce Momjian 已提交
6282
	time_t		stamp_time;
6283
	char		strfbuf[128];
6284
	char		histfilepath[MAXPGPATH];
6285 6286 6287 6288 6289 6290 6291 6292 6293
	char		startxlogfilename[MAXFNAMELEN];
	char		stopxlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	FILE	   *lfp;
	FILE	   *fp;
	char		ch;
	int			ich;

B
Bruce Momjian 已提交
6294
	if (!superuser())
6295 6296 6297
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
B
Bruce Momjian 已提交
6298

6299
	/*
6300
	 * OK to clear forcePageWrites
6301 6302
	 */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
6303
	XLogCtl->Insert.forcePageWrites = false;
6304 6305
	LWLockRelease(WALInsertLock);

6306
	/*
B
Bruce Momjian 已提交
6307 6308 6309
	 * 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.
6310 6311 6312
	 */
	stoppoint = RequestXLogSwitch();

6313 6314
	XLByteToSeg(stoppoint, _logId, _logSeg);
	XLogFileName(stopxlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6315

6316
	/*
B
Bruce Momjian 已提交
6317 6318 6319 6320
	 * 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.
6321 6322 6323 6324 6325
	 */
	stamp_time = time(NULL);
	strftime(strfbuf, sizeof(strfbuf),
			 "%Y-%m-%d %H:%M:%S %Z",
			 localtime(&stamp_time));
B
Bruce Momjian 已提交
6326

6327 6328 6329
	/*
	 * Open the existing label file
	 */
6330
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6331 6332 6333 6334 6335 6336
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(ERROR,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6337
							BACKUP_LABEL_FILE)));
6338 6339 6340 6341
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
				 errmsg("a backup is not in progress")));
	}
B
Bruce Momjian 已提交
6342

6343
	/*
B
Bruce Momjian 已提交
6344 6345
	 * Read and parse the START WAL LOCATION line (this code is pretty crude,
	 * but we are not expecting any variability in the file format).
6346 6347 6348 6349 6350 6351
	 */
	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),
6352
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6353

6354 6355 6356 6357
	/*
	 * Write the backup history file
	 */
	XLByteToSeg(startpoint, _logId, _logSeg);
6358
	BackupHistoryFilePath(histfilepath, ThisTimeLineID, _logId, _logSeg,
6359
						  startpoint.xrecoff % XLogSegSize);
6360
	fp = AllocateFile(histfilepath, "w");
6361 6362 6363 6364
	if (!fp)
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not create file \"%s\": %m",
6365
						histfilepath)));
6366 6367 6368 6369
	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);
6370
	/* transfer remaining lines from label to history file */
6371 6372 6373 6374 6375 6376 6377
	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",
6378
						histfilepath)));
B
Bruce Momjian 已提交
6379

6380 6381 6382 6383 6384 6385 6386
	/*
	 * 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",
6387 6388
						BACKUP_LABEL_FILE)));
	if (unlink(BACKUP_LABEL_FILE) != 0)
6389 6390 6391
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not remove file \"%s\": %m",
6392
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6393

6394
	/*
B
Bruce Momjian 已提交
6395 6396 6397
	 * 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.
6398
	 */
6399
	CleanupBackupHistory();
B
Bruce Momjian 已提交
6400

6401
	/*
6402
	 * We're done.  As a convenience, return the ending WAL location.
6403 6404 6405 6406
	 */
	snprintf(stopxlogfilename, sizeof(stopxlogfilename), "%X/%X",
			 stoppoint.xlogid, stoppoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6407
										 CStringGetDatum(stopxlogfilename)));
6408 6409
	PG_RETURN_TEXT_P(result);
}
6410

6411 6412 6413 6414 6415 6416 6417
/*
 * pg_switch_xlog: switch to next xlog file
 */
Datum
pg_switch_xlog(PG_FUNCTION_ARGS)
{
	text	   *result;
B
Bruce Momjian 已提交
6418
	XLogRecPtr	switchpoint;
6419 6420 6421 6422 6423
	char		location[MAXFNAMELEN];

	if (!superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
P
Peter Eisentraut 已提交
6424
				 (errmsg("must be superuser to switch transaction log files"))));
6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438

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

/*
6439 6440 6441 6442 6443
 * 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.
6444 6445 6446
 */
Datum
pg_current_xlog_location(PG_FUNCTION_ARGS)
6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475
{
	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)
6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516
{
	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 已提交
6517 6518 6519 6520 6521
	Datum		values[2];
	bool		isnull[2];
	TupleDesc	resultTupleDesc;
	HeapTuple	resultHeapTuple;
	Datum		result;
6522

6523 6524 6525
	/*
	 * Read input and parse
	 */
6526
	locationstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6527
												 PointerGetDatum(location)));
6528 6529 6530 6531

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6532
				 errmsg("could not parse transaction log location \"%s\"",
6533 6534 6535 6536 6537
						locationstr)));

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

6538
	/*
B
Bruce Momjian 已提交
6539 6540
	 * Construct a tuple descriptor for the result row.  This must match this
	 * function's pg_proc entry!
6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552
	 */
	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
	 */
6553 6554 6555
	XLByteToPrevSeg(locationpoint, xlogid, xlogseg);
	XLogFileName(xlogfilename, ThisTimeLineID, xlogid, xlogseg);

6556 6557 6558 6559 6560 6561 6562
	values[0] = DirectFunctionCall1(textin,
									CStringGetDatum(xlogfilename));
	isnull[0] = false;

	/*
	 * offset
	 */
6563 6564
	xrecoff = locationpoint.xrecoff - xlogseg * XLogSegSize;

6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575
	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);
6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595
}

/*
 * 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 已提交
6596
												 PointerGetDatum(location)));
6597 6598 6599 6600

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6601
				 errmsg("could not parse transaction log location \"%s\"",
6602 6603 6604 6605 6606 6607 6608 6609 6610
						locationstr)));

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

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

	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6611
											 CStringGetDatum(xlogfilename)));
6612 6613 6614
	PG_RETURN_TEXT_P(result);
}

6615 6616 6617 6618 6619
/*
 * 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 已提交
6620
 * identified by the label file, NOT what pg_control says.	This avoids the
6621 6622 6623 6624 6625
 * 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.
6626
 * If successful, set *minRecoveryLoc to constrain valid PITR stopping
6627 6628 6629 6630 6631 6632
 * points.
 *
 * Returns TRUE if a backup_label was found (and fills the checkpoint
 * location into *checkPointLoc); returns FALSE if not.
 */
static bool
6633
read_backup_label(XLogRecPtr *checkPointLoc, XLogRecPtr *minRecoveryLoc)
6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647
{
	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;

6648 6649 6650 6651
	/* Default is to not constrain recovery stop point */
	minRecoveryLoc->xlogid = 0;
	minRecoveryLoc->xrecoff = 0;

6652 6653 6654
	/*
	 * See if label file is present
	 */
6655
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6656 6657 6658 6659 6660 6661
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6662
							BACKUP_LABEL_FILE)));
6663 6664
		return false;			/* it's not there, all is fine */
	}
B
Bruce Momjian 已提交
6665

6666
	/*
B
Bruce Momjian 已提交
6667 6668 6669
	 * 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).
6670 6671 6672 6673 6674 6675
	 */
	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),
6676
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
6677 6678 6679 6680 6681
	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),
6682
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
6683 6684 6685 6686
	if (ferror(lfp) || FreeFile(lfp))
		ereport(FATAL,
				(errcode_for_file_access(),
				 errmsg("could not read file \"%s\": %m",
6687
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6688

6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701
	/*
	 * 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 已提交
6702
	fp = AllocateFile(histfilepath, "r");
6703 6704 6705 6706 6707 6708
	if (fp)
	{
		/*
		 * Parse history file to identify stop point.
		 */
		if (fscanf(fp, "START WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
6709
				   &startpoint.xlogid, &startpoint.xrecoff, startxlogfilename,
6710 6711 6712
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
6713
					 errmsg("invalid data in file \"%s\"", histfilename)));
6714
		if (fscanf(fp, "STOP WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
6715
				   &stoppoint.xlogid, &stoppoint.xrecoff, stopxlogfilename,
6716 6717 6718
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
6719
					 errmsg("invalid data in file \"%s\"", histfilename)));
6720
		*minRecoveryLoc = stoppoint;
6721 6722 6723 6724 6725 6726 6727 6728 6729 6730
		if (ferror(fp) || FreeFile(fp))
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
							histfilepath)));
	}

	return true;
}

6731 6732 6733 6734 6735 6736
/*
 * Error context callback for errors occurring during rm_redo().
 */
static void
rm_redo_error_callback(void *arg)
{
B
Bruce Momjian 已提交
6737 6738
	XLogRecord *record = (XLogRecord *) arg;
	StringInfoData buf;
6739 6740

	initStringInfo(&buf);
6741 6742
	RmgrTable[record->xl_rmid].rm_desc(&buf,
									   record->xl_info,
6743 6744 6745 6746 6747 6748 6749 6750
									   XLogRecGetData(record));

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

	pfree(buf.data);
}