xlog.c 196.0 KB
Newer Older
1
/*-------------------------------------------------------------------------
2 3
 *
 * xlog.c
4
 *		PostgreSQL transaction log manager
5 6
 *
 *
7
 * Portions Copyright (c) 1996-2006, 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.253 2006/11/05 22:42:08 tgl Exp $
11 12 13
 *
 *-------------------------------------------------------------------------
 */
14

15 16
#include "postgres.h"

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

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

50

B
 
Bruce Momjian 已提交
51
/*
52
 *	Because O_DIRECT bypasses the kernel buffers, and because we never
B
 
Bruce Momjian 已提交
53
 *	read those buffers except during crash recovery, it is a win to use
B
Bruce Momjian 已提交
54
 *	it in all cases where we sync on each write().	We could allow O_DIRECT
B
 
Bruce Momjian 已提交
55 56 57
 *	with fsync(), but because skipping the kernel buffer forces writes out
 *	quickly, it seems best just to use it for O_SYNC.  It is hard to imagine
 *	how fsync() could be a win for O_DIRECT compared to O_SYNC and O_DIRECT.
B
Bruce Momjian 已提交
58 59
 *	Also, O_DIRECT is never enough to force data to the drives, it merely
 *	tries to bypass the kernel cache, so we still need O_SYNC or fsync().
B
 
Bruce Momjian 已提交
60 61 62 63 64 65 66
 */
#ifdef O_DIRECT
#define PG_O_DIRECT				O_DIRECT
#else
#define PG_O_DIRECT				0
#endif

67 68 69
/*
 * This chunk of hackery attempts to determine which file sync methods
 * are available on the current platform, and to choose an appropriate
B
Bruce Momjian 已提交
70
 * default method.	We assume that fsync() is always available, and that
71 72
 * configure determined whether fdatasync() is.
 */
73 74
#if defined(O_SYNC)
#define BARE_OPEN_SYNC_FLAG		O_SYNC
75
#elif defined(O_FSYNC)
76
#define BARE_OPEN_SYNC_FLAG		O_FSYNC
B
Bruce Momjian 已提交
77
#endif
78 79
#ifdef BARE_OPEN_SYNC_FLAG
#define OPEN_SYNC_FLAG			(BARE_OPEN_SYNC_FLAG | PG_O_DIRECT)
80
#endif
81

82 83
#if defined(O_DSYNC)
#if defined(OPEN_SYNC_FLAG)
84
/* O_DSYNC is distinct? */
85
#if O_DSYNC != BARE_OPEN_SYNC_FLAG
B
 
Bruce Momjian 已提交
86
#define OPEN_DATASYNC_FLAG		(O_DSYNC | PG_O_DIRECT)
87
#endif
B
Bruce Momjian 已提交
88
#else							/* !defined(OPEN_SYNC_FLAG) */
89
/* Win32 only has O_DSYNC */
B
 
Bruce Momjian 已提交
90
#define OPEN_DATASYNC_FLAG		(O_DSYNC | PG_O_DIRECT)
B
Bruce Momjian 已提交
91
#endif
92 93
#endif

94
#if defined(OPEN_DATASYNC_FLAG)
B
Bruce Momjian 已提交
95
#define DEFAULT_SYNC_METHOD_STR "open_datasync"
B
Bruce Momjian 已提交
96 97
#define DEFAULT_SYNC_METHOD		SYNC_METHOD_OPEN
#define DEFAULT_SYNC_FLAGBIT	OPEN_DATASYNC_FLAG
98
#elif defined(HAVE_FDATASYNC)
B
Bruce Momjian 已提交
99 100 101
#define DEFAULT_SYNC_METHOD_STR "fdatasync"
#define DEFAULT_SYNC_METHOD		SYNC_METHOD_FDATASYNC
#define DEFAULT_SYNC_FLAGBIT	0
102
#elif defined(HAVE_FSYNC_WRITETHROUGH_ONLY)
B
Bruce Momjian 已提交
103 104 105
#define DEFAULT_SYNC_METHOD_STR "fsync_writethrough"
#define DEFAULT_SYNC_METHOD		SYNC_METHOD_FSYNC_WRITETHROUGH
#define DEFAULT_SYNC_FLAGBIT	0
106 107 108 109
#else
#define DEFAULT_SYNC_METHOD_STR "fsync"
#define DEFAULT_SYNC_METHOD		SYNC_METHOD_FSYNC
#define DEFAULT_SYNC_FLAGBIT	0
B
Bruce Momjian 已提交
110
#endif
111 112


113 114
/*
 * Limitation of buffer-alignment for direct IO depends on OS and filesystem,
115
 * but XLOG_BLCKSZ is assumed to be enough for it.
116 117
 */
#ifdef O_DIRECT
118
#define ALIGNOF_XLOG_BUFFER		XLOG_BLCKSZ
119 120 121 122 123
#else
#define ALIGNOF_XLOG_BUFFER		ALIGNOF_BUFFER
#endif


124 125
/* File path names (all relative to $PGDATA) */
#define BACKUP_LABEL_FILE		"backup_label"
126
#define BACKUP_LABEL_OLD		"backup_label.old"
127 128 129 130
#define RECOVERY_COMMAND_FILE	"recovery.conf"
#define RECOVERY_COMMAND_DONE	"recovery.done"


T
Tom Lane 已提交
131 132
/* User-settable parameters */
int			CheckPointSegments = 3;
V
Vadim B. Mikheev 已提交
133
int			XLOGbuffers = 8;
134
int			XLogArchiveTimeout = 0;
135
char	   *XLogArchiveCommand = NULL;
136 137
char	   *XLOG_sync_method = NULL;
const char	XLOG_sync_method_default[] = DEFAULT_SYNC_METHOD_STR;
138
bool		fullPageWrites = true;
T
Tom Lane 已提交
139

140 141 142 143
#ifdef WAL_DEBUG
bool		XLOG_DEBUG = false;
#endif

144
/*
145
 * XLOGfileslop is used in the code as the allowed "fuzz" in the number of
146
 * preallocated XLOG segments --- we try to have at least XLOGfiles advance
B
Bruce Momjian 已提交
147
 * segments but no more than XLOGfileslop segments.  This could
148 149 150 151 152 153 154 155 156 157
 * 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)


158
/* these are derived from XLOG_sync_method by assign_xlog_sync_method */
B
Bruce Momjian 已提交
159
int			sync_method = DEFAULT_SYNC_METHOD;
160 161 162 163
static int	open_sync_bit = DEFAULT_SYNC_FLAGBIT;

#define XLOG_SYNC_BIT  (enableFsync ? open_sync_bit : 0)

T
Tom Lane 已提交
164 165

/*
166 167
 * ThisTimeLineID will be same in all backends --- it identifies current
 * WAL timeline for the database system.
T
Tom Lane 已提交
168
 */
169
TimeLineID	ThisTimeLineID = 0;
V
WAL  
Vadim B. Mikheev 已提交
170

171
/* Are we doing recovery from XLOG? */
T
Tom Lane 已提交
172
bool		InRecovery = false;
B
Bruce Momjian 已提交
173

174
/* Are we recovering using offline XLOG archives? */
B
Bruce Momjian 已提交
175 176
static bool InArchiveRecovery = false;

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

180 181
/* options taken from recovery.conf */
static char *recoveryRestoreCommand = NULL;
182 183 184
static bool recoveryTarget = false;
static bool recoveryTargetExact = false;
static bool recoveryTargetInclusive = true;
B
Bruce Momjian 已提交
185 186
static TransactionId recoveryTargetXid;
static time_t recoveryTargetTime;
187

188
/* if recoveryStopsHere returns true, it saves actual stop xid/time here */
B
Bruce Momjian 已提交
189 190 191
static TransactionId recoveryStopXid;
static time_t recoveryStopTime;
static bool recoveryStopAfter;
192 193 194 195 196 197 198 199 200 201 202 203 204

/*
 * 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 已提交
205
 * first list member).	Only these TLIs are expected to be seen in the WAL
206 207 208 209 210 211 212 213 214
 * 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 已提交
215 216 217
static TimeLineID recoveryTargetTLI;
static List *expectedTLIs;
static TimeLineID curFileTLI;
218

T
Tom Lane 已提交
219 220
/*
 * MyLastRecPtr points to the start of the last XLOG record inserted by the
221 222
 * current transaction.  If MyLastRecPtr.xrecoff == 0, then the current
 * xact hasn't yet inserted any transaction-controlled XLOG records.
T
Tom Lane 已提交
223 224
 *
 * Note that XLOG records inserted outside transaction control are not
225
 * reflected into MyLastRecPtr.  They do, however, cause MyXactMadeXLogEntry
B
Bruce Momjian 已提交
226
 * to be set true.	The latter can be used to test whether the current xact
227 228
 * made any loggable changes (including out-of-xact changes, such as
 * sequence updates).
229 230 231
 *
 * 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 已提交
232
 * the temp rel after a crash.	However, we will still need to remember
233 234 235
 * 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 已提交
236 237
 */
XLogRecPtr	MyLastRecPtr = {0, 0};
V
Vadim B. Mikheev 已提交
238

239 240
bool		MyXactMadeXLogEntry = false;

241 242
bool		MyXactMadeTempRelUpdate = false;

T
Tom Lane 已提交
243 244 245
/*
 * 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 已提交
246
 * or not.	ProcLastRecEnd is similar but points to end+1 of last record.
T
Tom Lane 已提交
247 248
 */
static XLogRecPtr ProcLastRecPtr = {0, 0};
249

250 251
XLogRecPtr	ProcLastRecEnd = {0, 0};

T
Tom Lane 已提交
252 253 254
/*
 * 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 已提交
255
 * CHECKPOINT record).	We update this from the shared-memory copy,
T
Tom Lane 已提交
256
 * XLogCtl->Insert.RedoRecPtr, whenever we can safely do so (ie, when we
B
Bruce Momjian 已提交
257
 * hold the Insert lock).  See XLogInsert for details.	We are also allowed
258
 * to update from XLogCtl->Insert.RedoRecPtr if we hold the info_lck;
259 260
 * see GetRedoRecPtr.  A freshly spawned backend obtains the value during
 * InitXLOGAccess.
T
Tom Lane 已提交
261
 */
262
static XLogRecPtr RedoRecPtr;
263

T
Tom Lane 已提交
264 265 266 267 268 269 270 271 272
/*----------
 * 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.
 *
273
 * We do a lot of pushups to minimize the amount of access to lockable
T
Tom Lane 已提交
274 275 276
 * 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
277 278 279 280
 *		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 已提交
281 282 283
 *
 * XLogCtl->LogwrtResult and XLogCtl->Write.LogwrtResult are both "always
 * right", since both are updated by a write or flush operation before
284 285
 * 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 已提交
286 287 288
 * without needing to grab info_lck as well.
 *
 * XLogCtl->Insert.LogwrtResult may lag behind the reality of the other two,
B
Bruce Momjian 已提交
289
 * but is updated when convenient.	Again, it exists for the convenience of
290
 * code that is already holding WALInsertLock but not the other locks.
T
Tom Lane 已提交
291 292 293 294 295 296 297 298 299 300
 *
 * 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".
301 302 303 304 305 306 307 308 309 310 311 312 313 314
 *
 * 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
315 316
 * checkpointer at a time; currently, with all checkpoints done by the
 * bgwriter, this is just pro forma).
317
 *
T
Tom Lane 已提交
318 319
 *----------
 */
320

T
Tom Lane 已提交
321
typedef struct XLogwrtRqst
322
{
T
Tom Lane 已提交
323 324
	XLogRecPtr	Write;			/* last byte + 1 to write out */
	XLogRecPtr	Flush;			/* last byte + 1 to flush */
325
} XLogwrtRqst;
326

327 328 329 330 331 332
typedef struct XLogwrtResult
{
	XLogRecPtr	Write;			/* last byte + 1 written out */
	XLogRecPtr	Flush;			/* last byte + 1 flushed */
} XLogwrtResult;

T
Tom Lane 已提交
333 334 335
/*
 * Shared state data for XLogInsert.
 */
336 337
typedef struct XLogCtlInsert
{
B
Bruce Momjian 已提交
338 339
	XLogwrtResult LogwrtResult; /* a recent value of LogwrtResult */
	XLogRecPtr	PrevRecord;		/* start of previously-inserted record */
340
	int			curridx;		/* current block index in cache */
B
Bruce Momjian 已提交
341 342 343
	XLogPageHeader currpage;	/* points to header of block in cache */
	char	   *currpos;		/* current insertion point in cache */
	XLogRecPtr	RedoRecPtr;		/* current redo point for insertions */
344
	bool		forcePageWrites;	/* forcing full-page writes for PITR? */
345 346
} XLogCtlInsert;

T
Tom Lane 已提交
347 348 349
/*
 * Shared state data for XLogWrite/XLogFlush.
 */
350 351
typedef struct XLogCtlWrite
{
B
Bruce Momjian 已提交
352 353 354
	XLogwrtResult LogwrtResult; /* current value of LogwrtResult */
	int			curridx;		/* cache index of next block to write */
	time_t		lastSegSwitchTime;		/* time of last xlog segment switch */
355 356
} XLogCtlWrite;

T
Tom Lane 已提交
357 358 359
/*
 * Total shared-memory state for XLOG.
 */
360 361
typedef struct XLogCtlData
{
362
	/* Protected by WALInsertLock: */
B
Bruce Momjian 已提交
363
	XLogCtlInsert Insert;
364

T
Tom Lane 已提交
365
	/* Protected by info_lck: */
B
Bruce Momjian 已提交
366 367
	XLogwrtRqst LogwrtRqst;
	XLogwrtResult LogwrtResult;
368 369 370
	uint32		ckptXidEpoch;	/* nextXID & epoch of latest checkpoint */
	TransactionId ckptXid;

371
	/* Protected by WALWriteLock: */
B
Bruce Momjian 已提交
372 373
	XLogCtlWrite Write;

T
Tom Lane 已提交
374
	/*
B
Bruce Momjian 已提交
375 376 377
	 * 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 已提交
378
	 */
B
Bruce Momjian 已提交
379
	char	   *pages;			/* buffers for unwritten XLOG pages */
380
	XLogRecPtr *xlblocks;		/* 1st byte ptr-s + XLOG_BLCKSZ */
381 382
	Size		XLogCacheByte;	/* # bytes in xlog buffers */
	int			XLogCacheBlck;	/* highest allocated xlog buffer index */
383
	TimeLineID	ThisTimeLineID;
T
Tom Lane 已提交
384

385
	slock_t		info_lck;		/* locks shared variables shown above */
386 387
} XLogCtlData;

388
static XLogCtlData *XLogCtl = NULL;
389

390
/*
T
Tom Lane 已提交
391
 * We maintain an image of pg_control in shared memory.
392
 */
393
static ControlFileData *ControlFile = NULL;
394

T
Tom Lane 已提交
395 396 397 398 399
/*
 * 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.
 */
400

T
Tom Lane 已提交
401 402
/* Free space remaining in the current xlog page buffer */
#define INSERT_FREESPACE(Insert)  \
403
	(XLOG_BLCKSZ - ((Insert)->currpos - (char *) (Insert)->currpage))
T
Tom Lane 已提交
404 405 406 407 408 409

/* Construct XLogRecPtr value for current insertion point */
#define INSERT_RECPTR(recptr,Insert,curridx)  \
	( \
	  (recptr).xlogid = XLogCtl->xlblocks[curridx].xlogid, \
	  (recptr).xrecoff = \
B
Bruce Momjian 已提交
410
		XLogCtl->xlblocks[curridx].xrecoff - INSERT_FREESPACE(Insert) \
T
Tom Lane 已提交
411 412 413 414 415 416 417
	)

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

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

T
Tom Lane 已提交
419 420 421 422
/*
 * Private, possibly out-of-date copy of shared LogwrtResult.
 * See discussion above.
 */
423
static XLogwrtResult LogwrtResult = {{0, 0}, {0, 0}};
424

T
Tom Lane 已提交
425 426 427 428 429 430 431 432 433 434
/*
 * 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;
435

T
Tom Lane 已提交
436 437 438 439 440 441
/*
 * 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.
 */
442 443 444 445
static int	readFile = -1;
static uint32 readId = 0;
static uint32 readSeg = 0;
static uint32 readOff = 0;
B
Bruce Momjian 已提交
446

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

450 451 452 453
/* Buffer for current ReadRecord result (expandable) */
static char *readRecordBuf = NULL;
static uint32 readRecordBufSize = 0;

T
Tom Lane 已提交
454
/* State information for XLOG reading */
B
Bruce Momjian 已提交
455 456
static XLogRecPtr ReadRecPtr;	/* start of last record read */
static XLogRecPtr EndRecPtr;	/* end+1 of last record read */
457
static XLogRecord *nextRecord = NULL;
458
static TimeLineID lastPageTLI = 0;
459

V
WAL  
Vadim B. Mikheev 已提交
460 461
static bool InRedo = false;

462

463 464
static void XLogArchiveNotify(const char *xlog);
static void XLogArchiveNotifySeg(uint32 log, uint32 seg);
465
static bool XLogArchiveCheckDone(const char *xlog);
466 467
static void XLogArchiveCleanup(const char *xlog);
static void readRecoveryCommandFile(void);
468
static void exitArchiveRecovery(TimeLineID endTLI,
B
Bruce Momjian 已提交
469
					uint32 endLogId, uint32 endLogSeg);
470
static bool recoveryStopsHere(XLogRecord *record, bool *includeThis);
471
static void CheckPointGuts(XLogRecPtr checkPointRedo);
T
Tom Lane 已提交
472

473
static bool XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
B
Bruce Momjian 已提交
474
				XLogRecPtr *lsn, BkpBlock *bkpb);
475 476
static bool AdvanceXLInsertBuffer(bool new_segment);
static void XLogWrite(XLogwrtRqst WriteRqst, bool flexible, bool xlog_switch);
B
Bruce Momjian 已提交
477 478
static int XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock);
479 480
static bool InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
481
					   bool use_lock);
482 483
static int	XLogFileOpen(uint32 log, uint32 seg);
static int	XLogFileRead(uint32 log, uint32 seg, int emode);
B
Bruce Momjian 已提交
484
static void XLogFileClose(void);
485
static bool RestoreArchivedFile(char *path, const char *xlogfname,
B
Bruce Momjian 已提交
486
					const char *recovername, off_t expectedSize);
487 488
static int	PreallocXlogFiles(XLogRecPtr endptr);
static void MoveOfflineLogs(uint32 log, uint32 seg, XLogRecPtr endptr,
B
Bruce Momjian 已提交
489
				int *nsegsremoved, int *nsegsrecycled);
490
static void CleanupBackupHistory(void);
491
static XLogRecord *ReadRecord(XLogRecPtr *RecPtr, int emode);
492
static bool ValidXLOGHeader(XLogPageHeader hdr, int emode);
493
static XLogRecord *ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt);
494 495 496 497
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 已提交
498 499
					 TimeLineID endTLI,
					 uint32 endLogId, uint32 endLogSeg);
T
Tom Lane 已提交
500 501 502
static void WriteControlFile(void);
static void ReadControlFile(void);
static char *str_time(time_t tnow);
503
static void issue_xlog_fsync(void);
B
Bruce Momjian 已提交
504

505
#ifdef WAL_DEBUG
506
static void xlog_outrec(StringInfo buf, XLogRecord *record);
507
#endif
508
static bool read_backup_label(XLogRecPtr *checkPointLoc,
B
Bruce Momjian 已提交
509
				  XLogRecPtr *minRecoveryLoc);
510
static void rm_redo_error_callback(void *arg);
T
Tom Lane 已提交
511 512 513 514 515


/*
 * Insert an XLOG record having the specified RMID and info bytes,
 * with the body of the record being the data chunk(s) described by
516
 * the rdata chain (see xlog.h for notes about rdata).
T
Tom Lane 已提交
517 518 519 520 521 522 523 524 525 526 527
 *
 * 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.
 */
528
XLogRecPtr
529
XLogInsert(RmgrId rmid, uint8 info, XLogRecData *rdata)
530
{
B
Bruce Momjian 已提交
531 532
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogRecord *record;
T
Tom Lane 已提交
533
	XLogContRecord *contrecord;
B
Bruce Momjian 已提交
534 535 536
	XLogRecPtr	RecPtr;
	XLogRecPtr	WriteRqst;
	uint32		freespace;
537
	int			curridx;
B
Bruce Momjian 已提交
538 539 540 541 542
	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];
543 544 545 546
	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 已提交
547 548 549
	uint32		len,
				write_len;
	unsigned	i;
550
	XLogwrtRqst LogwrtRqst;
B
Bruce Momjian 已提交
551
	bool		updrqst;
552
	bool		doPageWrites;
553 554
	bool		isLogSwitch = (rmid == RM_XLOG_ID && info == XLOG_SWITCH);
	bool		no_tran = (rmid == RM_XLOG_ID);
V
Vadim B. Mikheev 已提交
555 556 557 558

	if (info & XLR_INFO_MASK)
	{
		if ((info & XLR_INFO_MASK) != XLOG_NO_TRAN)
559
			elog(PANIC, "invalid xlog info mask %02X", (info & XLR_INFO_MASK));
V
Vadim B. Mikheev 已提交
560 561 562 563
		no_tran = true;
		info &= ~XLR_INFO_MASK;
	}

T
Tom Lane 已提交
564
	/*
B
Bruce Momjian 已提交
565 566
	 * In bootstrap mode, we don't actually log anything but XLOG resources;
	 * return a phony record pointer.
T
Tom Lane 已提交
567
	 */
V
Vadim B. Mikheev 已提交
568
	if (IsBootstrapProcessingMode() && rmid != RM_XLOG_ID)
V
WAL  
Vadim B. Mikheev 已提交
569 570
	{
		RecPtr.xlogid = 0;
B
Bruce Momjian 已提交
571
		RecPtr.xrecoff = SizeOfXLogLongPHD;		/* start of 1st chkpt record */
572
		return RecPtr;
V
WAL  
Vadim B. Mikheev 已提交
573 574
	}

T
Tom Lane 已提交
575
	/*
576
	 * Here we scan the rdata chain, determine which buffers must be backed
T
Tom Lane 已提交
577
	 * up, and compute the CRC values for the data.  Note that the record
B
Bruce Momjian 已提交
578 579 580 581
	 * 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 已提交
582
	 *
583 584 585 586 587
	 * 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 已提交
588 589 590 591 592
	 * 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 已提交
593
	 */
594
begin:;
T
Tom Lane 已提交
595 596 597 598 599 600
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
	{
		dtbuf[i] = InvalidBuffer;
		dtbuf_bkp[i] = false;
	}

601 602 603 604 605 606 607 608
	/*
	 * 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;

609
	INIT_CRC32(rdata_crc);
T
Tom Lane 已提交
610
	len = 0;
B
Bruce Momjian 已提交
611
	for (rdt = rdata;;)
612 613 614
	{
		if (rdt->buffer == InvalidBuffer)
		{
T
Tom Lane 已提交
615
			/* Simple data, just include it */
616
			len += rdt->len;
617
			COMP_CRC32(rdata_crc, rdt->data, rdt->len);
618
		}
T
Tom Lane 已提交
619
		else
620
		{
T
Tom Lane 已提交
621 622
			/* Find info for buffer */
			for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
623
			{
T
Tom Lane 已提交
624
				if (rdt->buffer == dtbuf[i])
625
				{
626
					/* Buffer already referenced by earlier chain item */
T
Tom Lane 已提交
627 628 629 630 631
					if (dtbuf_bkp[i])
						rdt->data = NULL;
					else if (rdt->data)
					{
						len += rdt->len;
632
						COMP_CRC32(rdata_crc, rdt->data, rdt->len);
T
Tom Lane 已提交
633 634
					}
					break;
635
				}
T
Tom Lane 已提交
636
				if (dtbuf[i] == InvalidBuffer)
637
				{
T
Tom Lane 已提交
638 639
					/* OK, put it in this slot */
					dtbuf[i] = rdt->buffer;
640 641
					if (XLogCheckBuffer(rdt, doPageWrites,
										&(dtbuf_lsn[i]), &(dtbuf_xlg[i])))
T
Tom Lane 已提交
642 643 644 645 646 647 648
					{
						dtbuf_bkp[i] = true;
						rdt->data = NULL;
					}
					else if (rdt->data)
					{
						len += rdt->len;
649
						COMP_CRC32(rdata_crc, rdt->data, rdt->len);
T
Tom Lane 已提交
650 651
					}
					break;
652 653
				}
			}
T
Tom Lane 已提交
654
			if (i >= XLR_MAX_BKP_BLOCKS)
655
				elog(PANIC, "can backup at most %d blocks per xlog record",
T
Tom Lane 已提交
656
					 XLR_MAX_BKP_BLOCKS);
657
		}
658
		/* Break out of loop when rdt points to last chain item */
659 660 661 662 663
		if (rdt->next == NULL)
			break;
		rdt = rdt->next;
	}

664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
	/*
	 * 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 已提交
697
	/*
698 699
	 * 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 已提交
700 701 702
	 * 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 已提交
703
	 */
704
	if (len == 0 && !isLogSwitch)
705
		elog(PANIC, "invalid xlog record length %u", len);
706

707
	START_CRIT_SECTION();
708

709
	/* update LogwrtResult before doing cache fill check */
710 711 712 713
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

714
		SpinLockAcquire(&xlogctl->info_lck);
715 716
		LogwrtRqst = xlogctl->LogwrtRqst;
		LogwrtResult = xlogctl->LogwrtResult;
717
		SpinLockRelease(&xlogctl->info_lck);
718
	}
719

720
	/*
721 722
	 * If cache is half filled then try to acquire write lock and do
	 * XLogWrite. Ignore any fractional blocks in performing this check.
723
	 */
724
	LogwrtRqst.Write.xrecoff -= LogwrtRqst.Write.xrecoff % XLOG_BLCKSZ;
725 726 727
	if (LogwrtRqst.Write.xlogid != LogwrtResult.Write.xlogid ||
		(LogwrtRqst.Write.xrecoff >= LogwrtResult.Write.xrecoff +
		 XLogCtl->XLogCacheByte / 2))
T
Tom Lane 已提交
728
	{
729
		if (LWLockConditionalAcquire(WALWriteLock, LW_EXCLUSIVE))
730
		{
731 732 733 734
			/*
			 * 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 已提交
735 736 737
			 * mechanism to synchronize with the cache boundaries, so that in
			 * a long transaction we'll basically dump alternating halves of
			 * the buffer array.
738
			 */
739 740
			LogwrtResult = XLogCtl->Write.LogwrtResult;
			if (XLByteLT(LogwrtResult.Write, LogwrtRqst.Write))
741
				XLogWrite(LogwrtRqst, true, false);
742
			LWLockRelease(WALWriteLock);
743 744 745
		}
	}

746 747 748
	/* Now wait to get insert lock */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);

T
Tom Lane 已提交
749
	/*
B
Bruce Momjian 已提交
750 751 752
	 * 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.
753 754
	 *
	 * If we aren't doing full-page writes then RedoRecPtr doesn't actually
B
Bruce Momjian 已提交
755 756
	 * affect the contents of the XLOG record, so we'll update our local copy
	 * but not force a recomputation.
T
Tom Lane 已提交
757 758
	 */
	if (!XLByteEQ(RedoRecPtr, Insert->RedoRecPtr))
759
	{
T
Tom Lane 已提交
760 761 762
		Assert(XLByteLT(RedoRecPtr, Insert->RedoRecPtr));
		RedoRecPtr = Insert->RedoRecPtr;

763
		if (doPageWrites)
764
		{
765
			for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
T
Tom Lane 已提交
766
			{
767 768 769 770 771 772 773 774 775 776 777 778 779
				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 已提交
780
			}
781 782 783
		}
	}

784
	/*
B
Bruce Momjian 已提交
785 786 787 788
	 * 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.)
789 790 791 792 793 794 795 796 797
	 */
	if (Insert->forcePageWrites && !doPageWrites)
	{
		/* Oops, must redo it with full-page data */
		LWLockRelease(WALInsertLock);
		END_CRIT_SECTION();
		goto begin;
	}

T
Tom Lane 已提交
798
	/*
B
Bruce Momjian 已提交
799 800 801 802
	 * 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 已提交
803
	 *
804 805 806
	 * 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 已提交
807 808 809
	 */
	write_len = len;
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
810
	{
811 812 813
		BkpBlock   *bkpb;
		char	   *page;

814
		if (!dtbuf_bkp[i])
815 816
			continue;

T
Tom Lane 已提交
817
		info |= XLR_SET_BKP_BLOCK(i);
818

819 820 821 822 823
		bkpb = &(dtbuf_xlg[i]);
		page = (char *) BufferGetBlock(dtbuf[i]);

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

825 826
		rdt->data = (char *) bkpb;
		rdt->len = sizeof(BkpBlock);
T
Tom Lane 已提交
827
		write_len += sizeof(BkpBlock);
828

829 830
		rdt->next = &(dtbuf_rdt2[i]);
		rdt = rdt->next;
831

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
		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;
		}
854 855
	}

856
	/*
857
	 * If there isn't enough space on the current XLOG page for a record
B
Bruce Momjian 已提交
858
	 * header, advance to the next page (leaving the unused space as zeroes).
859
	 */
T
Tom Lane 已提交
860 861
	updrqst = false;
	freespace = INSERT_FREESPACE(Insert);
862 863
	if (freespace < SizeOfXLogRecord)
	{
864
		updrqst = AdvanceXLInsertBuffer(false);
865 866 867
		freespace = INSERT_FREESPACE(Insert);
	}

868
	/* Compute record's XLOG location */
T
Tom Lane 已提交
869
	curridx = Insert->curridx;
870 871 872
	INSERT_RECPTR(RecPtr, Insert, curridx);

	/*
B
Bruce Momjian 已提交
873 874 875 876 877
	 * 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.
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
	 */
	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 已提交
909

910 911
	/* Insert record header */

912
	record = (XLogRecord *) Insert->currpos;
913
	record->xl_prev = Insert->PrevRecord;
914
	record->xl_xid = GetCurrentTransactionIdIfAny();
915
	record->xl_tot_len = SizeOfXLogRecord + write_len;
T
Tom Lane 已提交
916
	record->xl_len = len;		/* doesn't include backup blocks */
917
	record->xl_info = info;
918
	record->xl_rmid = rmid;
919

920 921 922 923
	/* 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);
924 925
	record->xl_crc = rdata_crc;

926
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
927 928
	if (XLOG_DEBUG)
	{
B
Bruce Momjian 已提交
929
		StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
930

931
		initStringInfo(&buf);
932 933
		appendStringInfo(&buf, "INSERT @ %X/%X: ",
						 RecPtr.xlogid, RecPtr.xrecoff);
934
		xlog_outrec(&buf, record);
935
		if (rdata->data != NULL)
V
WAL  
Vadim B. Mikheev 已提交
936
		{
937 938
			appendStringInfo(&buf, " - ");
			RmgrTable[record->xl_rmid].rm_desc(&buf, record->xl_info, rdata->data);
V
WAL  
Vadim B. Mikheev 已提交
939
		}
940 941
		elog(LOG, "%s", buf.data);
		pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
942
	}
943
#endif
V
WAL  
Vadim B. Mikheev 已提交
944

T
Tom Lane 已提交
945 946 947 948 949
	/* Record begin of record in appropriate places */
	if (!no_tran)
		MyLastRecPtr = RecPtr;
	ProcLastRecPtr = RecPtr;
	Insert->PrevRecord = RecPtr;
950
	MyXactMadeXLogEntry = true;
T
Tom Lane 已提交
951

952
	Insert->currpos += SizeOfXLogRecord;
T
Tom Lane 已提交
953
	freespace -= SizeOfXLogRecord;
954

T
Tom Lane 已提交
955 956 957 958
	/*
	 * Append the data, including backup blocks if any
	 */
	while (write_len)
959
	{
960 961 962 963
		while (rdata->data == NULL)
			rdata = rdata->next;

		if (freespace > 0)
964
		{
965 966 967 968 969
			if (rdata->len > freespace)
			{
				memcpy(Insert->currpos, rdata->data, freespace);
				rdata->data += freespace;
				rdata->len -= freespace;
T
Tom Lane 已提交
970
				write_len -= freespace;
971 972 973 974 975
			}
			else
			{
				memcpy(Insert->currpos, rdata->data, rdata->len);
				freespace -= rdata->len;
T
Tom Lane 已提交
976
				write_len -= rdata->len;
977 978 979 980
				Insert->currpos += rdata->len;
				rdata = rdata->next;
				continue;
			}
981 982
		}

983
		/* Use next buffer */
984
		updrqst = AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
985 986 987 988 989 990
		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;
991
		freespace = INSERT_FREESPACE(Insert);
992
	}
993

T
Tom Lane 已提交
994 995
	/* Ensure next record will be properly aligned */
	Insert->currpos = (char *) Insert->currpage +
B
Bruce Momjian 已提交
996
		MAXALIGN(Insert->currpos - (char *) Insert->currpage);
T
Tom Lane 已提交
997
	freespace = INSERT_FREESPACE(Insert);
998

V
Vadim B. Mikheev 已提交
999
	/*
B
Bruce Momjian 已提交
1000 1001
	 * 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 已提交
1002
	 */
T
Tom Lane 已提交
1003
	INSERT_RECPTR(RecPtr, Insert, curridx);
V
Vadim B. Mikheev 已提交
1004

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
	/*
	 * 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 已提交
1022 1023
		 * Flush through the end of the page containing XLOG_SWITCH, and
		 * perform end-of-segment actions (eg, notifying archiver).
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
		 */
		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 */
	}
1074
	else
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
	{
		/* 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];
	}
1091

1092
	LWLockRelease(WALInsertLock);
1093 1094 1095

	if (updrqst)
	{
1096 1097 1098
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1099
		SpinLockAcquire(&xlogctl->info_lck);
T
Tom Lane 已提交
1100
		/* advance global request to include new block(s) */
1101 1102
		if (XLByteLT(xlogctl->LogwrtRqst.Write, WriteRqst))
			xlogctl->LogwrtRqst.Write = WriteRqst;
T
Tom Lane 已提交
1103
		/* update local result copy while I have the chance */
1104
		LogwrtResult = xlogctl->LogwrtResult;
1105
		SpinLockRelease(&xlogctl->info_lck);
1106 1107
	}

1108 1109
	ProcLastRecEnd = RecPtr;

1110
	END_CRIT_SECTION();
1111

1112
	return RecPtr;
1113
}
1114

1115
/*
1116 1117 1118
 * 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.
1119
 */
1120
static bool
1121
XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
1122
				XLogRecPtr *lsn, BkpBlock *bkpb)
1123 1124
{
	PageHeader	page;
1125 1126 1127 1128

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

	/*
B
Bruce Momjian 已提交
1129 1130 1131
	 * 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.
1132 1133 1134
	 */
	*lsn = page->pd_lsn;

1135
	if (doPageWrites &&
1136
		XLByteLE(page->pd_lsn, RedoRecPtr))
1137
	{
1138 1139 1140 1141 1142
		/*
		 * The page needs to be backed up, so set up *bkpb
		 */
		bkpb->node = BufferGetFileNode(rdata->buffer);
		bkpb->block = BufferGetBlockNumber(rdata->buffer);
1143

1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
		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;
		}
1170

1171
		return true;			/* buffer requires backup */
1172
	}
1173 1174

	return false;				/* buffer does not need to be backed up */
1175 1176
}

1177 1178 1179 1180 1181 1182
/*
 * XLogArchiveNotify
 *
 * Create an archive notification file
 *
 * The name of the notification file is the message that will be picked up
1183
 * by the archiver, e.g. we write 0000000100000001000000C6.ready
1184
 * and the archiver then knows to archive XLOGDIR/0000000100000001000000C6,
1185
 * then when complete, rename it to 0000000100000001000000C6.done
1186 1187 1188 1189 1190
 */
static void
XLogArchiveNotify(const char *xlog)
{
	char		archiveStatusPath[MAXPGPATH];
B
Bruce Momjian 已提交
1191
	FILE	   *fd;
1192 1193 1194 1195

	/* insert an otherwise empty file called <XLOG>.ready */
	StatusFilePath(archiveStatusPath, xlog, ".ready");
	fd = AllocateFile(archiveStatusPath, "w");
B
Bruce Momjian 已提交
1196 1197
	if (fd == NULL)
	{
1198 1199 1200 1201 1202 1203
		ereport(LOG,
				(errcode_for_file_access(),
				 errmsg("could not create archive status file \"%s\": %m",
						archiveStatusPath)));
		return;
	}
B
Bruce Momjian 已提交
1204 1205
	if (FreeFile(fd))
	{
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
		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];

1226
	XLogFileName(xlog, ThisTimeLineID, log, seg);
1227 1228 1229 1230
	XLogArchiveNotify(xlog);
}

/*
1231
 * XLogArchiveCheckDone
1232
 *
1233 1234 1235 1236
 * 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.
1237 1238
 *
 * If <XLOG>.done exists, then return true; else if <XLOG>.ready exists,
1239 1240 1241 1242
 * 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.
1243 1244
 */
static bool
1245
XLogArchiveCheckDone(const char *xlog)
1246 1247 1248 1249
{
	char		archiveStatusPath[MAXPGPATH];
	struct stat stat_buf;

1250 1251 1252 1253 1254
	/* Always deletable if archiving is off */
	if (!XLogArchivingActive())
		return true;

	/* First check for .done --- this means archiver is done with it */
1255 1256 1257 1258 1259 1260 1261
	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 已提交
1262
		return false;
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276

	/* 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
 *
1277
 * Cleanup archive notification file(s) for a particular xlog segment
1278 1279 1280 1281
 */
static void
XLogArchiveCleanup(const char *xlog)
{
B
Bruce Momjian 已提交
1282
	char		archiveStatusPath[MAXPGPATH];
1283

1284
	/* Remove the .done file */
1285 1286 1287
	StatusFilePath(archiveStatusPath, xlog, ".done");
	unlink(archiveStatusPath);
	/* should we complain about failure? */
1288 1289 1290 1291 1292

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

T
Tom Lane 已提交
1295 1296 1297 1298
/*
 * Advance the Insert state to the next buffer page, writing out the next
 * buffer if it still contains unwritten data.
 *
1299 1300 1301 1302
 * 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 已提交
1303
 * The global LogwrtRqst.Write pointer needs to be advanced to include the
1304
 * just-filled page.  If we can do this for free (without an extra lock),
T
Tom Lane 已提交
1305 1306 1307
 * 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.
 *
1308
 * Must be called with WALInsertLock held.
T
Tom Lane 已提交
1309 1310
 */
static bool
1311
AdvanceXLInsertBuffer(bool new_segment)
1312
{
T
Tom Lane 已提交
1313 1314
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogCtlWrite *Write = &XLogCtl->Write;
1315
	int			nextidx = NextBufIdx(Insert->curridx);
T
Tom Lane 已提交
1316 1317 1318
	bool		update_needed = true;
	XLogRecPtr	OldPageRqstPtr;
	XLogwrtRqst WriteRqst;
1319 1320
	XLogRecPtr	NewPageEndPtr;
	XLogPageHeader NewPage;
1321

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

T
Tom Lane 已提交
1326
	/*
B
Bruce Momjian 已提交
1327 1328 1329
	 * 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 已提交
1330 1331 1332 1333 1334 1335
	 */
	OldPageRqstPtr = XLogCtl->xlblocks[nextidx];
	if (!XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
	{
		/* nope, got work to do... */
		XLogRecPtr	FinishedPageRqstPtr;
1336

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

1339
		/* Before waiting, get info_lck and update LogwrtResult */
1340 1341 1342 1343
		{
			/* use volatile pointer to prevent code rearrangement */
			volatile XLogCtlData *xlogctl = XLogCtl;

1344
			SpinLockAcquire(&xlogctl->info_lck);
1345 1346 1347
			if (XLByteLT(xlogctl->LogwrtRqst.Write, FinishedPageRqstPtr))
				xlogctl->LogwrtRqst.Write = FinishedPageRqstPtr;
			LogwrtResult = xlogctl->LogwrtResult;
1348
			SpinLockRelease(&xlogctl->info_lck);
1349
		}
1350 1351 1352 1353 1354 1355 1356 1357 1358

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

		if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
		{
			/* OK, someone wrote it already */
			Insert->LogwrtResult = LogwrtResult;
		}
		else
1359
		{
1360 1361 1362 1363
			/* Must acquire write lock */
			LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
			LogwrtResult = Write->LogwrtResult;
			if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
1364
			{
1365 1366 1367
				/* OK, someone wrote it already */
				LWLockRelease(WALWriteLock);
				Insert->LogwrtResult = LogwrtResult;
T
Tom Lane 已提交
1368
			}
1369
			else
T
Tom Lane 已提交
1370 1371
			{
				/*
B
Bruce Momjian 已提交
1372 1373
				 * Have to write buffers while holding insert lock. This is
				 * not good, so only write as much as we absolutely must.
T
Tom Lane 已提交
1374 1375 1376 1377
				 */
				WriteRqst.Write = OldPageRqstPtr;
				WriteRqst.Flush.xlogid = 0;
				WriteRqst.Flush.xrecoff = 0;
1378
				XLogWrite(WriteRqst, false, false);
1379
				LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1380
				Insert->LogwrtResult = LogwrtResult;
1381 1382 1383 1384
			}
		}
	}

T
Tom Lane 已提交
1385
	/*
B
Bruce Momjian 已提交
1386 1387
	 * Now the next buffer slot is free and we can set it up to be the next
	 * output page.
T
Tom Lane 已提交
1388
	 */
1389
	NewPageEndPtr = XLogCtl->xlblocks[Insert->curridx];
1390 1391 1392 1393 1394 1395 1396 1397

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

1398
	if (NewPageEndPtr.xrecoff >= XLogFileSize)
1399
	{
T
Tom Lane 已提交
1400
		/* crossing a logid boundary */
1401
		NewPageEndPtr.xlogid += 1;
1402
		NewPageEndPtr.xrecoff = XLOG_BLCKSZ;
1403
	}
T
Tom Lane 已提交
1404
	else
1405
		NewPageEndPtr.xrecoff += XLOG_BLCKSZ;
1406
	XLogCtl->xlblocks[nextidx] = NewPageEndPtr;
1407
	NewPage = (XLogPageHeader) (XLogCtl->pages + nextidx * (Size) XLOG_BLCKSZ);
B
Bruce Momjian 已提交
1408

T
Tom Lane 已提交
1409
	Insert->curridx = nextidx;
1410
	Insert->currpage = NewPage;
B
Bruce Momjian 已提交
1411 1412

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

T
Tom Lane 已提交
1414
	/*
B
Bruce Momjian 已提交
1415 1416
	 * 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 已提交
1417
	 */
1418
	MemSet((char *) NewPage, 0, XLOG_BLCKSZ);
1419

1420 1421 1422
	/*
	 * Fill the new page's header
	 */
B
Bruce Momjian 已提交
1423 1424
	NewPage   ->xlp_magic = XLOG_PAGE_MAGIC;

1425
	/* NewPage->xlp_info = 0; */	/* done by memset */
B
Bruce Momjian 已提交
1426 1427
	NewPage   ->xlp_tli = ThisTimeLineID;
	NewPage   ->xlp_pageaddr.xlogid = NewPageEndPtr.xlogid;
1428
	NewPage   ->xlp_pageaddr.xrecoff = NewPageEndPtr.xrecoff - XLOG_BLCKSZ;
T
Tom Lane 已提交
1429

1430
	/*
1431
	 * If first page of an XLOG segment file, make it a long header.
1432 1433 1434
	 */
	if ((NewPage->xlp_pageaddr.xrecoff % XLogSegSize) == 0)
	{
1435
		XLogLongPageHeader NewLongPage = (XLogLongPageHeader) NewPage;
1436

1437 1438
		NewLongPage->xlp_sysid = ControlFile->system_identifier;
		NewLongPage->xlp_seg_size = XLogSegSize;
1439
		NewLongPage->xlp_xlog_blcksz = XLOG_BLCKSZ;
B
Bruce Momjian 已提交
1440 1441 1442
		NewPage   ->xlp_info |= XLP_LONG_HEADER;

		Insert->currpos = ((char *) NewPage) +SizeOfXLogLongPHD;
1443 1444
	}

T
Tom Lane 已提交
1445
	return update_needed;
1446 1447
}

T
Tom Lane 已提交
1448 1449 1450
/*
 * Write and/or fsync the log at least as far as WriteRqst indicates.
 *
1451 1452 1453 1454 1455
 * 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.
 *
1456 1457 1458 1459 1460 1461
 * 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.)
 *
1462
 * Must be called with WALWriteLock held.
T
Tom Lane 已提交
1463
 */
1464
static void
1465
XLogWrite(XLogwrtRqst WriteRqst, bool flexible, bool xlog_switch)
1466
{
1467
	XLogCtlWrite *Write = &XLogCtl->Write;
T
Tom Lane 已提交
1468
	bool		ispartialpage;
1469
	bool		last_iteration;
1470
	bool		finishing_seg;
1471
	bool		use_existent;
1472 1473 1474 1475
	int			curridx;
	int			npages;
	int			startidx;
	uint32		startoffset;
1476

1477 1478 1479
	/* We should always be inside a critical section here */
	Assert(CritSectionCount > 0);

B
Bruce Momjian 已提交
1480
	/*
B
Bruce Momjian 已提交
1481
	 * Update local LogwrtResult (caller probably did this already, but...)
B
Bruce Momjian 已提交
1482
	 */
T
Tom Lane 已提交
1483 1484
	LogwrtResult = Write->LogwrtResult;

1485 1486 1487
	/*
	 * Since successive pages in the xlog cache are consecutively allocated,
	 * we can usually gather multiple pages together and issue just one
B
Bruce Momjian 已提交
1488 1489 1490 1491 1492
	 * 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.
1493 1494 1495 1496 1497 1498 1499 1500 1501
	 */
	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 已提交
1502 1503
	 * going to PANIC if any error occurs anyway; but someday it may come in
	 * useful.)
1504 1505
	 */
	curridx = Write->curridx;
B
 
Bruce Momjian 已提交
1506

T
Tom Lane 已提交
1507
	while (XLByteLT(LogwrtResult.Write, WriteRqst.Write))
1508
	{
1509
		/*
B
Bruce Momjian 已提交
1510 1511 1512
		 * 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.
1513
		 */
1514
		if (!XLByteLT(LogwrtResult.Write, XLogCtl->xlblocks[curridx]))
1515
			elog(PANIC, "xlog write request %X/%X is past end of log %X/%X",
1516
				 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
1517 1518
				 XLogCtl->xlblocks[curridx].xlogid,
				 XLogCtl->xlblocks[curridx].xrecoff);
1519

T
Tom Lane 已提交
1520
		/* Advance LogwrtResult.Write to end of current buffer page */
1521
		LogwrtResult.Write = XLogCtl->xlblocks[curridx];
T
Tom Lane 已提交
1522 1523 1524
		ispartialpage = XLByteLT(WriteRqst.Write, LogwrtResult.Write);

		if (!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1525
		{
T
Tom Lane 已提交
1526
			/*
1527 1528
			 * Switch to new logfile segment.  We cannot have any pending
			 * pages here (since we dump what we have at segment end).
T
Tom Lane 已提交
1529
			 */
1530
			Assert(npages == 0);
T
Tom Lane 已提交
1531
			if (openLogFile >= 0)
1532
				XLogFileClose();
T
Tom Lane 已提交
1533 1534
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);

1535 1536 1537 1538
			/* create/use new log file */
			use_existent = true;
			openLogFile = XLogFileInit(openLogId, openLogSeg,
									   &use_existent, true);
T
Tom Lane 已提交
1539
			openLogOff = 0;
1540

T
Tom Lane 已提交
1541
			/* update pg_control, unless someone else already did */
1542
			LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
1543 1544 1545
			if (ControlFile->logId < openLogId ||
				(ControlFile->logId == openLogId &&
				 ControlFile->logSeg < openLogSeg + 1))
T
Tom Lane 已提交
1546 1547 1548 1549 1550
			{
				ControlFile->logId = openLogId;
				ControlFile->logSeg = openLogSeg + 1;
				ControlFile->time = time(NULL);
				UpdateControlFile();
B
Bruce Momjian 已提交
1551

1552
				/*
B
Bruce Momjian 已提交
1553 1554 1555 1556
				 * 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.)
1557
				 *
B
Bruce Momjian 已提交
1558 1559
				 * A straight computation of segment number could overflow 32
				 * bits.  Rather than assuming we have working 64-bit
1560 1561
				 * arithmetic, we compare the highest-order bits separately,
				 * and force a checkpoint immediately when they change.
1562
				 */
1563
				if (IsUnderPostmaster)
1564
				{
1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578
					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)
					{
1579
#ifdef WAL_DEBUG
1580 1581
						if (XLOG_DEBUG)
							elog(LOG, "time for a checkpoint, signaling bgwriter");
1582
#endif
1583
						RequestCheckpoint(false, true);
1584
					}
1585
				}
T
Tom Lane 已提交
1586
			}
1587
			LWLockRelease(ControlFileLock);
1588 1589
		}

1590
		/* Make sure we have the current logfile open */
T
Tom Lane 已提交
1591
		if (openLogFile < 0)
1592
		{
T
Tom Lane 已提交
1593
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1594
			openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
1595
			openLogOff = 0;
1596 1597
		}

1598 1599 1600 1601 1602
		/* Add current page to the set of pending pages-to-dump */
		if (npages == 0)
		{
			/* first of group */
			startidx = curridx;
1603
			startoffset = (LogwrtResult.Write.xrecoff - XLOG_BLCKSZ) % XLogSegSize;
1604 1605
		}
		npages++;
1606

T
Tom Lane 已提交
1607
		/*
B
Bruce Momjian 已提交
1608 1609 1610 1611
		 * 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 已提交
1612
		 */
1613 1614
		last_iteration = !XLByteLT(LogwrtResult.Write, WriteRqst.Write);

1615
		finishing_seg = !ispartialpage &&
1616
			(startoffset + npages * XLOG_BLCKSZ) >= XLogSegSize;
1617

1618
		if (last_iteration ||
1619 1620
			curridx == XLogCtl->XLogCacheBlck ||
			finishing_seg)
T
Tom Lane 已提交
1621
		{
1622 1623
			char	   *from;
			Size		nbytes;
1624

1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
			/* 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) */
1638 1639
			from = XLogCtl->pages + startidx * (Size) XLOG_BLCKSZ;
			nbytes = npages * (Size) XLOG_BLCKSZ;
1640 1641 1642 1643 1644 1645 1646 1647 1648
			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 已提交
1649
								"at offset %u, length %lu: %m",
1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
								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.
			 *
1666 1667 1668
			 * We also do this if this is the last page written for an xlog
			 * switch.
			 *
1669
			 * This is also the right place to notify the Archiver that the
B
Bruce Momjian 已提交
1670 1671
			 * segment is ready to copy to archival storage, and to update the
			 * timer for archive_timeout.
1672
			 */
1673
			if (finishing_seg || (xlog_switch && last_iteration))
1674 1675
			{
				issue_xlog_fsync();
B
Bruce Momjian 已提交
1676
				LogwrtResult.Flush = LogwrtResult.Write;		/* end of page */
1677 1678 1679

				if (XLogArchivingActive())
					XLogArchiveNotifySeg(openLogId, openLogSeg);
1680 1681

				Write->lastSegSwitchTime = time(NULL);
1682
			}
T
Tom Lane 已提交
1683
		}
1684

T
Tom Lane 已提交
1685 1686 1687 1688 1689 1690
		if (ispartialpage)
		{
			/* Only asked to write a partial page */
			LogwrtResult.Write = WriteRqst.Write;
			break;
		}
1691 1692 1693 1694 1695
		curridx = NextBufIdx(curridx);

		/* If flexible, break out of loop as soon as we wrote something */
		if (flexible && npages == 0)
			break;
1696
	}
1697 1698 1699

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

T
Tom Lane 已提交
1701 1702 1703 1704 1705
	/*
	 * If asked to flush, do so
	 */
	if (XLByteLT(LogwrtResult.Flush, WriteRqst.Flush) &&
		XLByteLT(LogwrtResult.Flush, LogwrtResult.Write))
1706
	{
T
Tom Lane 已提交
1707
		/*
B
Bruce Momjian 已提交
1708 1709 1710
		 * 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 已提交
1711
		 */
1712
		if (sync_method != SYNC_METHOD_OPEN)
T
Tom Lane 已提交
1713
		{
1714
			if (openLogFile >= 0 &&
B
Bruce Momjian 已提交
1715
				!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1716
				XLogFileClose();
1717 1718 1719
			if (openLogFile < 0)
			{
				XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1720
				openLogFile = XLogFileOpen(openLogId, openLogSeg);
1721 1722 1723
				openLogOff = 0;
			}
			issue_xlog_fsync();
T
Tom Lane 已提交
1724 1725
		}
		LogwrtResult.Flush = LogwrtResult.Write;
1726 1727
	}

T
Tom Lane 已提交
1728 1729 1730
	/*
	 * Update shared-memory status
	 *
B
Bruce Momjian 已提交
1731
	 * We make sure that the shared 'request' values do not fall behind the
B
Bruce Momjian 已提交
1732 1733
	 * 'result' values.  This is not absolutely essential, but it saves some
	 * code in a couple of places.
T
Tom Lane 已提交
1734
	 */
1735 1736 1737 1738
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

1739
		SpinLockAcquire(&xlogctl->info_lck);
1740 1741 1742 1743 1744
		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;
1745
		SpinLockRelease(&xlogctl->info_lck);
1746
	}
1747

T
Tom Lane 已提交
1748 1749 1750 1751 1752 1753
	Write->LogwrtResult = LogwrtResult;
}

/*
 * Ensure that all XLOG data through the given position is flushed to disk.
 *
1754
 * NOTE: this differs from XLogWrite mainly in that the WALWriteLock is not
T
Tom Lane 已提交
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
 * 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;

1771
#ifdef WAL_DEBUG
1772
	if (XLOG_DEBUG)
1773
		elog(LOG, "xlog flush request %X/%X; write %X/%X; flush %X/%X",
1774 1775 1776
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1777
#endif
1778

T
Tom Lane 已提交
1779 1780 1781 1782
	START_CRIT_SECTION();

	/*
	 * Since fsync is usually a horribly expensive operation, we try to
B
Bruce Momjian 已提交
1783 1784 1785 1786
	 * 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 已提交
1787 1788 1789 1790 1791
	 */

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

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

1797
		SpinLockAcquire(&xlogctl->info_lck);
1798 1799 1800
		if (XLByteLT(WriteRqstPtr, xlogctl->LogwrtRqst.Write))
			WriteRqstPtr = xlogctl->LogwrtRqst.Write;
		LogwrtResult = xlogctl->LogwrtResult;
1801
		SpinLockRelease(&xlogctl->info_lck);
1802
	}
1803 1804 1805

	/* done already? */
	if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1806
	{
1807 1808 1809 1810
		/* now wait for the write lock */
		LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
		LogwrtResult = XLogCtl->Write.LogwrtResult;
		if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1811
		{
1812 1813 1814 1815 1816 1817
			/* 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 已提交
1818
				if (freespace < SizeOfXLogRecord)		/* buffer is full */
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
					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;
			}
1834
			XLogWrite(WriteRqst, false, false);
T
Tom Lane 已提交
1835
		}
1836
		LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1837 1838 1839
	}

	END_CRIT_SECTION();
1840 1841 1842

	/*
	 * If we still haven't flushed to the request point then we have a
B
Bruce Momjian 已提交
1843 1844
	 * 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.
1845
	 *
1846 1847 1848 1849 1850 1851 1852 1853 1854
	 * 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.)
1855
	 *
1856 1857 1858 1859
	 * 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 已提交
1860 1861
	 * 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.
1862 1863
	 */
	if (XLByteLT(LogwrtResult.Flush, record))
B
Bruce Momjian 已提交
1864
		elog(InRecovery ? WARNING : ERROR,
B
Bruce Momjian 已提交
1865
		"xlog flush request %X/%X is not satisfied --- flushed only to %X/%X",
1866 1867
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1868 1869
}

T
Tom Lane 已提交
1870 1871 1872
/*
 * Create a new XLOG file segment, or open a pre-existing one.
 *
1873 1874 1875
 * log, seg: identify segment to be created/opened.
 *
 * *use_existent: if TRUE, OK to use a pre-existing file (else, any
B
Bruce Momjian 已提交
1876
 * pre-existing file will be deleted).	On return, TRUE if a pre-existing
1877 1878
 * file was used.
 *
1879
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
1880
 * place.  This should be TRUE except during bootstrap log creation.  The
1881
 * caller must *not* hold the lock at call.
1882
 *
T
Tom Lane 已提交
1883
 * Returns FD of opened file.
1884 1885 1886 1887 1888
 *
 * 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 已提交
1889
 */
1890
static int
1891 1892
XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock)
1893
{
1894
	char		path[MAXPGPATH];
1895
	char		tmppath[MAXPGPATH];
1896
	char		zbuffer[XLOG_BLCKSZ];
1897 1898 1899
	uint32		installed_log;
	uint32		installed_seg;
	int			max_advance;
1900
	int			fd;
1901
	int			nbytes;
1902

1903
	XLogFilePath(path, ThisTimeLineID, log, seg);
V
Vadim B. Mikheev 已提交
1904 1905

	/*
B
Bruce Momjian 已提交
1906
	 * Try to use existent file (checkpoint maker may have created it already)
V
Vadim B. Mikheev 已提交
1907
	 */
1908
	if (*use_existent)
V
Vadim B. Mikheev 已提交
1909
	{
1910 1911
		fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
						   S_IRUSR | S_IWUSR);
V
Vadim B. Mikheev 已提交
1912 1913 1914
		if (fd < 0)
		{
			if (errno != ENOENT)
1915
				ereport(ERROR,
1916
						(errcode_for_file_access(),
1917
						 errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
1918
								path, log, seg)));
V
Vadim B. Mikheev 已提交
1919 1920
		}
		else
1921
			return fd;
V
Vadim B. Mikheev 已提交
1922 1923
	}

1924
	/*
B
Bruce Momjian 已提交
1925 1926 1927 1928
	 * 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.
1929
	 */
1930
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
1931 1932

	unlink(tmppath);
1933

1934
	/* do not use XLOG_SYNC_BIT here --- want to fsync only at end of fill */
1935
	fd = BasicOpenFile(tmppath, O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
T
Tom Lane 已提交
1936
					   S_IRUSR | S_IWUSR);
1937
	if (fd < 0)
1938
		ereport(ERROR,
1939
				(errcode_for_file_access(),
1940
				 errmsg("could not create file \"%s\": %m", tmppath)));
1941

1942
	/*
B
Bruce Momjian 已提交
1943 1944 1945 1946 1947 1948 1949
	 * 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.
1950 1951 1952 1953
	 */
	MemSet(zbuffer, 0, sizeof(zbuffer));
	for (nbytes = 0; nbytes < XLogSegSize; nbytes += sizeof(zbuffer))
	{
1954
		errno = 0;
1955
		if ((int) write(fd, zbuffer, sizeof(zbuffer)) != (int) sizeof(zbuffer))
T
Tom Lane 已提交
1956
		{
B
Bruce Momjian 已提交
1957
			int			save_errno = errno;
T
Tom Lane 已提交
1958

B
Bruce Momjian 已提交
1959
			/*
B
Bruce Momjian 已提交
1960
			 * If we fail to make the file, delete it to release disk space
B
Bruce Momjian 已提交
1961
			 */
1962
			unlink(tmppath);
1963 1964
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;
T
Tom Lane 已提交
1965

1966
			ereport(ERROR,
1967
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
1968
					 errmsg("could not write to file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
1969
		}
1970
	}
1971

1972
	if (pg_fsync(fd) != 0)
1973
		ereport(ERROR,
1974
				(errcode_for_file_access(),
1975
				 errmsg("could not fsync file \"%s\": %m", tmppath)));
1976

1977
	if (close(fd))
1978
		ereport(ERROR,
1979 1980
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
1981

1982
	/*
1983 1984
	 * Now move the segment into place with its final name.
	 *
1985
	 * If caller didn't want to use a pre-existing file, get rid of any
B
Bruce Momjian 已提交
1986 1987 1988
	 * 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.
1989
	 */
1990 1991 1992 1993 1994
	installed_log = log;
	installed_seg = seg;
	max_advance = XLOGfileslop;
	if (!InstallXLogFileSegment(&installed_log, &installed_seg, tmppath,
								*use_existent, &max_advance,
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
								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)
2008
		ereport(ERROR,
2009
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2010 2011
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2012

2013
	return fd;
2014 2015
}

2016 2017 2018 2019 2020 2021 2022 2023 2024
/*
 * 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 已提交
2025
 * considerations.	But we should be just as tense as XLogFileInit to avoid
2026 2027 2028 2029 2030 2031 2032 2033
 * emplacing a bogus file.
 */
static void
XLogFileCopy(uint32 log, uint32 seg,
			 TimeLineID srcTLI, uint32 srclog, uint32 srcseg)
{
	char		path[MAXPGPATH];
	char		tmppath[MAXPGPATH];
2034
	char		buffer[XLOG_BLCKSZ];
2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
	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)
2045
		ereport(ERROR,
2046 2047 2048 2049 2050 2051
				(errcode_for_file_access(),
				 errmsg("could not open file \"%s\": %m", path)));

	/*
	 * Copy into a temp file name.
	 */
2052
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
2053 2054 2055 2056 2057 2058 2059

	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)
2060
		ereport(ERROR,
2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072
				(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)
2073
				ereport(ERROR,
2074 2075 2076
						(errcode_for_file_access(),
						 errmsg("could not read file \"%s\": %m", path)));
			else
2077
				ereport(ERROR,
B
Bruce Momjian 已提交
2078
						(errmsg("not enough data in file \"%s\"", path)));
2079 2080 2081 2082 2083 2084 2085
		}
		errno = 0;
		if ((int) write(fd, buffer, sizeof(buffer)) != (int) sizeof(buffer))
		{
			int			save_errno = errno;

			/*
B
Bruce Momjian 已提交
2086
			 * If we fail to make the file, delete it to release disk space
2087 2088 2089 2090 2091
			 */
			unlink(tmppath);
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;

2092
			ereport(ERROR,
2093
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2094
					 errmsg("could not write to file \"%s\": %m", tmppath)));
2095 2096 2097 2098
		}
	}

	if (pg_fsync(fd) != 0)
2099
		ereport(ERROR,
2100 2101 2102 2103
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

	if (close(fd))
2104
		ereport(ERROR,
2105 2106 2107 2108 2109 2110 2111 2112
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));

	close(srcfd);

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

2117 2118 2119 2120 2121 2122
/*
 * 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.
 *
2123 2124 2125
 * *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.
2126 2127 2128 2129 2130 2131 2132
 *
 * 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.
 *
2133 2134 2135 2136
 * *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.)
2137
 *
2138
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
2139
 * place.  This should be TRUE except during bootstrap log creation.  The
2140
 * caller must *not* hold the lock at call.
2141 2142
 *
 * Returns TRUE if file installed, FALSE if not installed because of
2143
 * exceeding max_advance limit.  (Any other kind of failure causes ereport().)
2144 2145
 */
static bool
2146 2147
InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
2148 2149 2150
					   bool use_lock)
{
	char		path[MAXPGPATH];
2151
	struct stat stat_buf;
2152

2153
	XLogFilePath(path, ThisTimeLineID, *log, *seg);
2154 2155 2156 2157 2158

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

2161 2162 2163 2164 2165
	if (!find_free)
	{
		/* Force installation: get rid of any pre-existing segment file */
		unlink(path);
	}
2166 2167
	else
	{
2168
		/* Find a free slot to put it in */
2169
		while (stat(path, &stat_buf) == 0)
2170
		{
2171
			if (*max_advance <= 0)
2172 2173 2174
			{
				/* Failed to find a free slot within specified range */
				if (use_lock)
2175
					LWLockRelease(ControlFileLock);
2176 2177
				return false;
			}
2178 2179 2180
			NextLogSeg(*log, *seg);
			(*max_advance)--;
			XLogFilePath(path, ThisTimeLineID, *log, *seg);
2181 2182 2183 2184 2185 2186 2187
		}
	}

	/*
	 * 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.
2188
	 */
2189
#if HAVE_WORKING_LINK
2190
	if (link(tmppath, path) < 0)
2191
		ereport(ERROR,
2192
				(errcode_for_file_access(),
2193
				 errmsg("could not link file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2194
						tmppath, path, *log, *seg)));
2195
	unlink(tmppath);
2196
#else
2197
	if (rename(tmppath, path) < 0)
2198
		ereport(ERROR,
2199
				(errcode_for_file_access(),
2200
				 errmsg("could not rename file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2201
						tmppath, path, *log, *seg)));
2202
#endif
V
Vadim B. Mikheev 已提交
2203

2204
	if (use_lock)
2205
		LWLockRelease(ControlFileLock);
2206

2207
	return true;
2208 2209
}

T
Tom Lane 已提交
2210
/*
2211
 * Open a pre-existing logfile segment for writing.
T
Tom Lane 已提交
2212
 */
2213
static int
2214
XLogFileOpen(uint32 log, uint32 seg)
2215
{
2216 2217
	char		path[MAXPGPATH];
	int			fd;
2218

2219
	XLogFilePath(path, ThisTimeLineID, log, seg);
2220

2221 2222
	fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
					   S_IRUSR | S_IWUSR);
2223
	if (fd < 0)
2224 2225
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2226 2227
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241

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

2243
	/*
B
Bruce Momjian 已提交
2244 2245
	 * Loop looking for a suitable timeline ID: we might need to read any of
	 * the timelines listed in expectedTLIs.
2246
	 *
B
Bruce Momjian 已提交
2247
	 * We expect curFileTLI on entry to be the TLI of the preceding file in
B
Bruce Momjian 已提交
2248 2249 2250 2251
	 * 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.
2252
	 */
2253 2254 2255
	foreach(cell, expectedTLIs)
	{
		TimeLineID	tli = (TimeLineID) lfirst_int(cell);
2256

2257 2258 2259 2260 2261 2262 2263
		if (tli < curFileTLI)
			break;				/* don't bother looking at too-old TLIs */

		if (InArchiveRecovery)
		{
			XLogFileName(xlogfname, tli, log, seg);
			restoredFromArchive = RestoreArchivedFile(path, xlogfname,
2264 2265
													  "RECOVERYXLOG",
													  XLogSegSize);
2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
		}
		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 已提交
2280 2281
			errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				   path, log, seg)));
2282 2283 2284 2285 2286 2287 2288
	}

	/* 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 已提交
2289 2290
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2291
	return -1;
2292 2293
}

2294 2295 2296 2297 2298 2299 2300 2301
/*
 * Close the current logfile segment for writing.
 */
static void
XLogFileClose(void)
{
	Assert(openLogFile >= 0);

2302
	/*
B
Bruce Momjian 已提交
2303 2304 2305 2306 2307 2308
	 * 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.
2309 2310 2311
	 */
#ifdef NOT_USED

2312
	/*
2313
	 * WAL segment files will not be re-read in normal operation, so we advise
B
Bruce Momjian 已提交
2314
	 * OS to release any cached pages.	But do not do so if WAL archiving is
2315 2316 2317
	 * active, because archiver process could use the cache to read the WAL
	 * segment.
	 *
B
Bruce Momjian 已提交
2318 2319
	 * While O_DIRECT works for O_SYNC, posix_fadvise() works for fsync() and
	 * O_SYNC, and some platforms only have posix_fadvise().
2320
	 */
2321
#if defined(HAVE_DECL_POSIX_FADVISE) && defined(POSIX_FADV_DONTNEED)
2322 2323 2324
	if (!XLogArchivingActive())
		posix_fadvise(openLogFile, 0, 0, POSIX_FADV_DONTNEED);
#endif
B
Bruce Momjian 已提交
2325
#endif   /* NOT_USED */
2326

2327 2328
	if (close(openLogFile))
		ereport(PANIC,
B
Bruce Momjian 已提交
2329 2330 2331
				(errcode_for_file_access(),
				 errmsg("could not close log file %u, segment %u: %m",
						openLogId, openLogSeg)));
2332 2333 2334
	openLogFile = -1;
}

2335
/*
2336
 * Attempt to retrieve the specified file from off-line archival storage.
2337
 * If successful, fill "path" with its complete path (note that this will be
2338 2339
 * a temp file name that doesn't follow the normal naming convention), and
 * return TRUE.
2340
 *
2341 2342 2343
 * 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.
2344 2345 2346 2347
 *
 * 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.
2348
 */
2349 2350
static bool
RestoreArchivedFile(char *path, const char *xlogfname,
2351
					const char *recovername, off_t expectedSize)
2352
{
B
Bruce Momjian 已提交
2353 2354 2355 2356
	char		xlogpath[MAXPGPATH];
	char		xlogRestoreCmd[MAXPGPATH];
	char	   *dp;
	char	   *endp;
2357
	const char *sp;
B
Bruce Momjian 已提交
2358
	int			rc;
2359 2360 2361
	struct stat stat_buf;

	/*
B
Bruce Momjian 已提交
2362 2363 2364 2365
	 * 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.
2366
	 *
B
Bruce Momjian 已提交
2367
	 * We could try to optimize this slightly by checking the local copy
B
Bruce Momjian 已提交
2368 2369 2370 2371
	 * 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.
2372
	 *
2373 2374 2375
	 * 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.
2376
	 *
2377 2378 2379 2380
	 * 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 已提交
2381 2382
	 * copy-from-archive filename is always the same, ensuring that we don't
	 * run out of disk space on long recoveries.
2383
	 */
2384
	snprintf(xlogpath, MAXPGPATH, XLOGDIR "/%s", recovername);
2385 2386

	/*
2387
	 * Make sure there is no existing file named recovername.
2388 2389 2390 2391 2392 2393
	 */
	if (stat(xlogpath, &stat_buf) != 0)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
2394
					 errmsg("could not stat file \"%s\": %m",
2395 2396 2397 2398 2399 2400 2401
							xlogpath)));
	}
	else
	{
		if (unlink(xlogpath) != 0)
			ereport(FATAL,
					(errcode_for_file_access(),
2402
					 errmsg("could not remove file \"%s\": %m",
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
							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':
					/* %p: full path of target file */
					sp++;
B
Bruce Momjian 已提交
2422
					StrNCpy(dp, xlogpath, endp - dp);
2423
					make_native_path(dp);
2424 2425 2426 2427 2428
					dp += strlen(dp);
					break;
				case 'f':
					/* %f: filename of desired file */
					sp++;
B
Bruce Momjian 已提交
2429
					StrNCpy(dp, xlogfname, endp - dp);
2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453
					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 已提交
2454
			(errmsg_internal("executing restore command \"%s\"",
2455 2456 2457
							 xlogRestoreCmd)));

	/*
2458
	 * Copy xlog from archival storage to XLOGDIR
2459 2460 2461 2462
	 */
	rc = system(xlogRestoreCmd);
	if (rc == 0)
	{
2463 2464 2465 2466
		/*
		 * command apparently succeeded, but let's make sure the file is
		 * really there now and has the correct size.
		 *
2467 2468 2469 2470 2471
		 * 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 ...
2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
		 */
		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 已提交
2496
						 errmsg("could not stat file \"%s\": %m",
2497
								xlogpath)));
2498 2499 2500 2501
		}
	}

	/*
B
Bruce Momjian 已提交
2502 2503
	 * remember, we rollforward UNTIL the restore fails so failure here is
	 * just part of the process... that makes it difficult to determine
B
Bruce Momjian 已提交
2504 2505 2506
	 * 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.
2507
	 */
2508
	ereport(DEBUG2,
B
Bruce Momjian 已提交
2509 2510
		(errmsg("could not restore file \"%s\" from archive: return code %d",
				xlogfname, rc)));
2511 2512

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

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

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

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

2568 2569 2570
	*nsegsremoved = 0;
	*nsegsrecycled = 0;

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

2578
	xldir = AllocateDir(XLOGDIR);
V
Vadim B. Mikheev 已提交
2579
	if (xldir == NULL)
2580
		ereport(ERROR,
2581
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2582 2583
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
V
Vadim B. Mikheev 已提交
2584

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

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

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

				XLogArchiveCleanup(xlde->d_name);
2638
			}
V
Vadim B. Mikheev 已提交
2639 2640
		}
	}
B
Bruce Momjian 已提交
2641

2642
	FreeDir(xldir);
V
Vadim B. Mikheev 已提交
2643 2644
}

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

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

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

	FreeDir(xldir);
}

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

B
Bruce Momjian 已提交
2710
	blk = (char *) XLogRecGetData(record) + record->xl_len;
T
Tom Lane 已提交
2711
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2712
	{
T
Tom Lane 已提交
2713
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2714 2715
			continue;

2716
		memcpy(&bkpb, blk, sizeof(BkpBlock));
2717 2718
		blk += sizeof(BkpBlock);

2719
		reln = XLogOpenRelation(bkpb.node);
2720 2721 2722
		buffer = XLogReadBuffer(reln, bkpb.block, true);
		Assert(BufferIsValid(buffer));
		page = (Page) BufferGetPage(buffer);
2723

2724
		if (bkpb.hole_length == 0)
2725
		{
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735
			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));
2736 2737
		}

2738 2739
		PageSetLSN(page, lsn);
		PageSetTLI(page, ThisTimeLineID);
2740 2741
		MarkBufferDirty(buffer);
		UnlockReleaseBuffer(buffer);
2742

2743
		blk += BLCKSZ - bkpb.hole_length;
2744 2745 2746
	}
}

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

2763 2764 2765
	/* First the rmgr data */
	INIT_CRC32(crc);
	COMP_CRC32(crc, XLogRecGetData(record), len);
2766

2767
	/* Add in the backup blocks, if any */
B
Bruce Momjian 已提交
2768
	blk = (char *) XLogRecGetData(record) + len;
T
Tom Lane 已提交
2769
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2770
	{
B
Bruce Momjian 已提交
2771
		uint32		blen;
2772

T
Tom Lane 已提交
2773
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2774 2775
			continue;

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

2811
	return true;
2812 2813
}

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

	if (readBuf == NULL)
	{
		/*
B
Bruce Momjian 已提交
2842 2843 2844 2845 2846
		 * 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 已提交
2847
		 */
2848
		readBuf = (char *) malloc(XLOG_BLCKSZ);
T
Tom Lane 已提交
2849 2850
		Assert(readBuf != NULL);
	}
2851

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

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

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

		readFile = XLogFileRead(readId, readSeg, emode);
2902 2903
		if (readFile < 0)
			goto next_record_is_invalid;
2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922

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

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

got_record:;
B
Bruce Momjian 已提交
2978

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

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

3060 3061
		newSize += XLOG_BLCKSZ - (newSize % XLOG_BLCKSZ);
		newSize = Max(newSize, 4 * Max(BLCKSZ, XLOG_BLCKSZ));
3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074
		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;
3075
	}
3076 3077

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

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

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

3171 3172 3173 3174 3175 3176 3177 3178 3179
	/*
	 * 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 已提交
3180

3181
		/*
B
Bruce Momjian 已提交
3182 3183 3184
		 * 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.
3185 3186 3187
		 */
		readOff = XLogSegSize - XLOG_BLCKSZ;
	}
T
Tom Lane 已提交
3188
	return (XLogRecord *) buffer;
3189

T
Tom Lane 已提交
3190 3191 3192 3193 3194
next_record_is_invalid:;
	close(readFile);
	readFile = -1;
	nextRecord = NULL;
	return NULL;
3195 3196
}

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

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

3226
		if (longhdr->xlp_sysid != ControlFile->system_identifier)
3227
		{
3228 3229
			char		fhdrident_str[32];
			char		sysident_str[32];
3230

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

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

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, targetTLI);
3333
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3334 3335 3336 3337
	}
	else
		TLHistoryFilePath(path, targetTLI);

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

	result = NIL;

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

		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 已提交
3380
				   errhint("Timeline IDs must be in increasing sequence.")));
3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393

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

	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 已提交
3413
	FILE	   *fd;
3414 3415 3416 3417

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

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

	/*
	 * Write into a temp file name.
	 */
3503
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
3504 3505 3506 3507 3508 3509 3510

	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)
3511
		ereport(ERROR,
3512 3513 3514 3515 3516 3517 3518 3519 3520
				(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);
3521
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3522 3523 3524 3525 3526 3527 3528 3529
	}
	else
		TLHistoryFilePath(path, parentTLI);

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

				/*
B
Bruce Momjian 已提交
3559
				 * if write didn't set errno, assume problem is no disk space
B
Bruce Momjian 已提交
3560
				 */
3561 3562
				errno = save_errno ? save_errno : ENOSPC;

3563
				ereport(ERROR,
3564
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
3565
					 errmsg("could not write to file \"%s\": %m", tmppath)));
3566 3567 3568 3569 3570 3571 3572 3573
			}
		}
		close(srcfd);
	}

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

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

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

3601
		ereport(ERROR,
3602 3603 3604 3605 3606
				(errcode_for_file_access(),
				 errmsg("could not write to file \"%s\": %m", tmppath)));
	}

	if (pg_fsync(fd) != 0)
3607
		ereport(ERROR,
3608 3609 3610 3611
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

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

	/*
T
Tom Lane 已提交
3669
	 * Initialize version and compatibility-check fields
3670
	 */
T
Tom Lane 已提交
3671 3672
	ControlFile->pg_control_version = PG_CONTROL_VERSION;
	ControlFile->catalog_version_no = CATALOG_VERSION_NO;
3673 3674 3675 3676

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

3677 3678
	ControlFile->blcksz = BLCKSZ;
	ControlFile->relseg_size = RELSEG_SIZE;
3679
	ControlFile->xlog_blcksz = XLOG_BLCKSZ;
3680
	ControlFile->xlog_seg_size = XLOG_SEG_SIZE;
3681 3682

	ControlFile->nameDataLen = NAMEDATALEN;
3683
	ControlFile->indexMaxKeys = INDEX_MAX_KEYS;
3684 3685 3686 3687 3688 3689 3690 3691

#ifdef HAVE_INT64_TIMESTAMP
	ControlFile->enableIntTimes = TRUE;
#else
	ControlFile->enableIntTimes = FALSE;
#endif

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

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

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

3720
	memset(buffer, 0, PG_CONTROL_SIZE);
3721 3722
	memcpy(buffer, ControlFile, sizeof(ControlFileData));

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

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

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

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

static void
ReadControlFile(void)
{
3757
	pg_crc32	crc;
3758 3759 3760 3761 3762
	int			fd;

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

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

	close(fd);

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

3799
	if (!EQ_CRC32(crc, ControlFile->crc))
3800
		ereport(FATAL,
3801
				(errmsg("incorrect checksum in control file")));
3802

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

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

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

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

3921
void
3922
UpdateControlFile(void)
3923
{
3924
	int			fd;
3925

3926 3927 3928 3929 3930
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
3931

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

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

3952
	if (pg_fsync(fd) != 0)
3953 3954
		ereport(PANIC,
				(errcode_for_file_access(),
3955
				 errmsg("could not fsync control file: %m")));
3956

3957 3958 3959 3960
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
3961 3962
}

3963
/*
T
Tom Lane 已提交
3964
 * Initialization of shared memory for XLOG
3965
 */
3966
Size
3967
XLOGShmemSize(void)
3968
{
3969
	Size		size;
3970

3971 3972 3973 3974 3975 3976 3977
	/* 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 */
3978
	size = add_size(size, mul_size(XLOG_BLCKSZ, XLOGbuffers));
3979 3980

	/*
B
Bruce Momjian 已提交
3981 3982 3983
	 * 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.
3984 3985 3986
	 */

	return size;
3987 3988 3989 3990 3991
}

void
XLOGShmemInit(void)
{
3992 3993
	bool		foundCFile,
				foundXLog;
3994
	char	   *allocptr;
3995

3996
	ControlFile = (ControlFileData *)
3997
		ShmemInitStruct("Control File", sizeof(ControlFileData), &foundCFile);
3998 3999
	XLogCtl = (XLogCtlData *)
		ShmemInitStruct("XLOG Ctl", XLOGShmemSize(), &foundXLog);
4000

4001
	if (foundCFile || foundXLog)
4002 4003
	{
		/* both should be present or neither */
4004
		Assert(foundCFile && foundXLog);
4005 4006
		return;
	}
4007

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

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

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

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

T
Tom Lane 已提交
4033 4034
	XLogCtl->XLogCacheBlck = XLOGbuffers - 1;
	XLogCtl->Insert.currpage = (XLogPageHeader) (XLogCtl->pages);
4035
	SpinLockInit(&XLogCtl->info_lck);
T
Tom Lane 已提交
4036

4037
	/*
B
Bruce Momjian 已提交
4038 4039 4040
	 * 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).
4041 4042 4043
	 */
	if (!IsBootstrapProcessingMode())
		ReadControlFile();
4044 4045 4046
}

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

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

4079 4080 4081
	/* First timeline ID is always 1 */
	ThisTimeLineID = 1;

4082
	/* page buffer must be aligned suitably for O_DIRECT */
4083
	buffer = (char *) palloc(XLOG_BLCKSZ + ALIGNOF_XLOG_BUFFER);
4084
	page = (XLogPageHeader) TYPEALIGN(ALIGNOF_XLOG_BUFFER, buffer);
4085
	memset(page, 0, XLOG_BLCKSZ);
T
Tom Lane 已提交
4086

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

4099 4100 4101
	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
	ShmemVariableCache->oidCount = 0;
4102
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
4103

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

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

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

4133
	/* Create first XLOG segment file */
4134 4135
	use_existent = false;
	openLogFile = XLogFileInit(0, 0, &use_existent, false);
4136

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

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

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

T
Tom Lane 已提交
4159
	openLogFile = -1;
4160

4161 4162
	/* Now create pg_control */

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

4174
	WriteControlFile();
4175 4176 4177

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

4181
	pfree(buffer);
4182 4183
}

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

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

4193
	return buf;
4194 4195
}

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

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

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

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

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

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

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

4319
			/*
B
Bruce Momjian 已提交
4320 4321 4322
			 * Convert the time string given by the user to the time_t format.
			 * We use type abstime's input converter because we know abstime
			 * has the same representation as time_t.
4323
			 */
4324 4325
			recoveryTargetTime = (time_t)
				DatumGetAbsoluteTime(DirectFunctionCall1(abstimein,
B
Bruce Momjian 已提交
4326
													 CStringGetDatum(tok2)));
4327 4328
			ereport(LOG,
					(errmsg("recovery_target_time = %s",
B
Bruce Momjian 已提交
4329 4330
							DatumGetCString(DirectFunctionCall1(abstimeout,
				AbsoluteTimeGetDatum((AbsoluteTime) 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 4508
	uint8		record_info;
	time_t		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 4523 4524 4525 4526

		recordXactCommitData = (xl_xact_commit *) XLogRecGetData(record);
		recordXtime = recordXactCommitData->xtime;
	}
	else if (record_info == XLOG_XACT_ABORT)
	{
B
Bruce Momjian 已提交
4527
		xl_xact_abort *recordXactAbortData;
4528 4529 4530 4531 4532 4533 4534 4535 4536 4537

		recordXactAbortData = (xl_xact_abort *) XLogRecGetData(record);
		recordXtime = recordXactAbortData->xtime;
	}
	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",
B
Bruce Momjian 已提交
4576
							  recoveryStopXid, str_time(recoveryStopTime))));
4577 4578 4579
			else
				ereport(LOG,
						(errmsg("recovery stopping before commit of transaction %u, time %s",
B
Bruce Momjian 已提交
4580
							  recoveryStopXid, str_time(recoveryStopTime))));
4581 4582 4583
		}
		else
		{
4584
			if (recoveryStopAfter)
4585 4586
				ereport(LOG,
						(errmsg("recovery stopping after abort of transaction %u, time %s",
B
Bruce Momjian 已提交
4587
							  recoveryStopXid, str_time(recoveryStopTime))));
4588 4589 4590
			else
				ereport(LOG,
						(errmsg("recovery stopping before abort of transaction %u, time %s",
B
Bruce Momjian 已提交
4591
							  recoveryStopXid, str_time(recoveryStopTime))));
4592 4593 4594 4595 4596 4597
		}
	}

	return stopsHere;
}

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

T
Tom Lane 已提交
4620
	CritSectionCount++;
4621 4622

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

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

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

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

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

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

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

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

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

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

4753
	ereport(LOG,
B
Bruce Momjian 已提交
4754 4755 4756 4757
	 (errmsg("redo record is at %X/%X; undo record is at %X/%X; shutdown %s",
			 checkPoint.redo.xlogid, checkPoint.redo.xrecoff,
			 checkPoint.undo.xlogid, checkPoint.undo.xrecoff,
			 wasShutdown ? "TRUE" : "FALSE")));
4758
	ereport(LOG,
4759 4760 4761
			(errmsg("next transaction ID: %u/%u; next OID: %u",
					checkPoint.nextXidEpoch, checkPoint.nextXid,
					checkPoint.nextOid)));
4762 4763 4764
	ereport(LOG,
			(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 4788
	if (checkPoint.undo.xrecoff == 0)
		checkPoint.undo = RecPtr;

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

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

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

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

4860
		/* Start up the recovery environment */
V
WAL  
Vadim B. Mikheev 已提交
4861
		XLogInitRelationCache();
V
Vadim B. Mikheev 已提交
4862

4863 4864 4865 4866 4867 4868
		for (rmid = 0; rmid <= RM_MAX_ID; rmid++)
		{
			if (RmgrTable[rmid].rm_startup != NULL)
				RmgrTable[rmid].rm_startup();
		}

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

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

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

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

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

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

4930 4931 4932 4933 4934 4935
				/* 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;

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

T
Tom Lane 已提交
4944
				if (record->xl_info & XLR_BKP_BLOCK_MASK)
4945 4946
					RestoreBkpBlocks(record, EndRecPtr);

4947
				RmgrTable[record->xl_rmid].rm_redo(EndRecPtr, record);
4948

4949 4950 4951
				/* Pop the error context stack */
				error_context_stack = errcontext.previous;

4952 4953
				LastRec = ReadRecPtr;

4954
				record = ReadRecord(NULL, LOG);
4955
			} while (record != NULL && recoveryContinue);
B
Bruce Momjian 已提交
4956

4957 4958 4959 4960
			/*
			 * end of main redo apply loop
			 */

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

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

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

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

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

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

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

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

T
Tom Lane 已提交
5055 5056 5057
	XLogCtl->Write.LogwrtResult = LogwrtResult;
	Insert->LogwrtResult = LogwrtResult;
	XLogCtl->LogwrtResult = LogwrtResult;
V
WAL  
Vadim B. Mikheev 已提交
5058

T
Tom Lane 已提交
5059 5060
	XLogCtl->LogwrtRqst.Write = EndOfLog;
	XLogCtl->LogwrtRqst.Flush = EndOfLog;
5061

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

5082 5083
	/* Pre-scan prepared transactions to find out the range of XIDs present */
	oldestActiveXID = PrescanPreparedTransactions();
5084

V
WAL  
Vadim B. Mikheev 已提交
5085
	if (InRecovery)
5086
	{
B
Bruce Momjian 已提交
5087
		int			rmid;
5088 5089 5090 5091 5092 5093 5094 5095 5096 5097

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

5098 5099 5100 5101 5102 5103
		/*
		 * Check to see if the XLOG sequence contained any unresolved
		 * references to uninitialized pages.
		 */
		XLogCheckInvalidPages();

5104 5105 5106 5107 5108
		/*
		 * Reset pgstat data, because it may be invalid after recovery.
		 */
		pgstat_reset_all();

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

		/*
		 * Close down recovery environment
		 */
V
WAL  
Vadim B. Mikheev 已提交
5123
		XLogCloseRelationCache();
5124
	}
5125

T
Tom Lane 已提交
5126 5127 5128
	/*
	 * Preallocate additional log files, if wanted.
	 */
5129
	(void) PreallocXlogFiles(EndOfLog);
5130

5131 5132 5133
	/*
	 * Okay, we're officially UP.
	 */
V
WAL  
Vadim B. Mikheev 已提交
5134
	InRecovery = false;
5135 5136 5137 5138 5139

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

5140 5141 5142
	/* start the archive_timeout timer running */
	XLogCtl->Write.lastSegSwitchTime = ControlFile->time;

5143 5144 5145 5146
	/* initialize shared-memory copy of latest checkpoint XID/epoch */
	XLogCtl->ckptXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	XLogCtl->ckptXid = ControlFile->checkPointCopy.nextXid;

5147
	/* Start up the commit log and related stuff, too */
5148
	StartupCLOG();
5149
	StartupSUBTRANS(oldestActiveXID);
5150
	StartupMultiXact();
5151

5152 5153 5154
	/* Reload shared-memory state for prepared transactions */
	RecoverPreparedTransactions();

5155 5156
	ereport(LOG,
			(errmsg("database system is ready")));
5157
	CritSectionCount--;
5158

T
Tom Lane 已提交
5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169
	/* Shut down readFile facility, free space */
	if (readFile >= 0)
	{
		close(readFile);
		readFile = -1;
	}
	if (readBuf)
	{
		free(readBuf);
		readBuf = NULL;
	}
5170 5171 5172 5173 5174 5175
	if (readRecordBuf)
	{
		free(readRecordBuf);
		readRecordBuf = NULL;
		readRecordBufSize = 0;
	}
T
Tom Lane 已提交
5176 5177
}

5178 5179
/*
 * Subroutine to try to fetch and validate a prior checkpoint record.
5180 5181 5182
 *
 * whichChkpt identifies the checkpoint (merely for reporting purposes).
 * 1 for "primary", 2 for "secondary", 0 for "other" (backup_label)
5183
 */
T
Tom Lane 已提交
5184
static XLogRecord *
5185
ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt)
T
Tom Lane 已提交
5186 5187 5188 5189 5190
{
	XLogRecord *record;

	if (!XRecOffIsValid(RecPtr.xrecoff))
	{
5191 5192 5193 5194
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5195
				(errmsg("invalid primary checkpoint link in control file")));
5196 5197 5198 5199 5200 5201 5202
				break;
			case 2:
				ereport(LOG,
						(errmsg("invalid secondary checkpoint link in control file")));
				break;
			default:
				ereport(LOG,
B
Bruce Momjian 已提交
5203
				   (errmsg("invalid checkpoint link in backup_label file")));
5204 5205
				break;
		}
T
Tom Lane 已提交
5206 5207 5208
		return NULL;
	}

5209
	record = ReadRecord(&RecPtr, LOG);
T
Tom Lane 已提交
5210 5211 5212

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

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

/*
 * 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
5317 5318
GetRedoRecPtr(void)
{
5319 5320 5321
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;

5322
	SpinLockAcquire(&xlogctl->info_lck);
5323 5324
	Assert(XLByteLE(RedoRecPtr, xlogctl->Insert.RedoRecPtr));
	RedoRecPtr = xlogctl->Insert.RedoRecPtr;
5325
	SpinLockRelease(&xlogctl->info_lck);
5326 5327

	return RedoRecPtr;
V
WAL  
Vadim B. Mikheev 已提交
5328 5329
}

5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345
/*
 * 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;
}

5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356
/*
 * 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 已提交
5357 5358 5359
	uint32		ckptXidEpoch;
	TransactionId ckptXid;
	TransactionId nextXid;
5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385

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

5386
/*
T
Tom Lane 已提交
5387
 * This must be called ONCE during postmaster or standalone-backend shutdown
5388 5389
 */
void
5390
ShutdownXLOG(int code, Datum arg)
5391
{
5392 5393
	ereport(LOG,
			(errmsg("shutting down")));
5394

5395
	CritSectionCount++;
5396
	CreateCheckPoint(true, true);
5397
	ShutdownCLOG();
5398
	ShutdownSUBTRANS();
5399
	ShutdownMultiXact();
5400
	CritSectionCount--;
5401

5402 5403
	ereport(LOG,
			(errmsg("database system is shut down")));
5404 5405
}

T
Tom Lane 已提交
5406 5407
/*
 * Perform a checkpoint --- either during shutdown, or on-the-fly
5408 5409 5410
 *
 * If force is true, we force a checkpoint regardless of whether any XLOG
 * activity has occurred since the last one.
T
Tom Lane 已提交
5411
 */
5412
void
5413
CreateCheckPoint(bool shutdown, bool force)
5414
{
5415 5416 5417
	CheckPoint	checkPoint;
	XLogRecPtr	recptr;
	XLogCtlInsert *Insert = &XLogCtl->Insert;
B
Bruce Momjian 已提交
5418
	XLogRecData rdata;
5419
	uint32		freespace;
V
Vadim B. Mikheev 已提交
5420 5421
	uint32		_logId;
	uint32		_logSeg;
5422 5423 5424
	int			nsegsadded = 0;
	int			nsegsremoved = 0;
	int			nsegsrecycled = 0;
V
Vadim B. Mikheev 已提交
5425

5426
	/*
B
Bruce Momjian 已提交
5427 5428 5429 5430
	 * 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.)
5431
	 */
5432
	LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
5433

5434 5435 5436
	/*
	 * Use a critical section to force system panic if we have trouble.
	 */
5437 5438
	START_CRIT_SECTION();

5439 5440 5441 5442 5443 5444
	if (shutdown)
	{
		ControlFile->state = DB_SHUTDOWNING;
		ControlFile->time = time(NULL);
		UpdateControlFile();
	}
T
Tom Lane 已提交
5445

5446
	MemSet(&checkPoint, 0, sizeof(checkPoint));
5447
	checkPoint.ThisTimeLineID = ThisTimeLineID;
T
Tom Lane 已提交
5448
	checkPoint.time = time(NULL);
5449

5450
	/*
B
Bruce Momjian 已提交
5451 5452 5453 5454
	 * We must hold CheckpointStartLock while determining the checkpoint REDO
	 * pointer.  This ensures that any concurrent transaction commits will be
	 * either not yet logged, or logged and recorded in pg_clog. See notes in
	 * RecordTransactionCommit().
5455 5456 5457 5458
	 */
	LWLockAcquire(CheckpointStartLock, LW_EXCLUSIVE);

	/* And we need WALInsertLock too */
5459
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
T
Tom Lane 已提交
5460 5461

	/*
B
Bruce Momjian 已提交
5462 5463 5464 5465 5466 5467 5468 5469
	 * 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 已提交
5470
	 *
5471 5472 5473 5474
	 * 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 已提交
5475
	 */
5476
	if (!shutdown && !force)
T
Tom Lane 已提交
5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488
	{
		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)
		{
5489
			LWLockRelease(WALInsertLock);
5490
			LWLockRelease(CheckpointStartLock);
5491
			LWLockRelease(CheckpointLock);
T
Tom Lane 已提交
5492 5493 5494 5495 5496 5497 5498 5499
			END_CRIT_SECTION();
			return;
		}
	}

	/*
	 * Compute new REDO record ptr = location of next XLOG record.
	 *
B
Bruce Momjian 已提交
5500 5501 5502 5503
	 * 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 已提交
5504 5505
	 */
	freespace = INSERT_FREESPACE(Insert);
5506 5507
	if (freespace < SizeOfXLogRecord)
	{
5508
		(void) AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
5509
		/* OK to ignore update return flag, since we will do flush anyway */
5510
		freespace = INSERT_FREESPACE(Insert);
5511
	}
T
Tom Lane 已提交
5512
	INSERT_RECPTR(checkPoint.redo, Insert, Insert->curridx);
B
Bruce Momjian 已提交
5513

T
Tom Lane 已提交
5514
	/*
B
Bruce Momjian 已提交
5515 5516
	 * Here we update the shared RedoRecPtr for future XLogInsert calls; this
	 * must be done while holding the insert lock AND the info_lck.
5517
	 *
B
Bruce Momjian 已提交
5518
	 * Note: if we fail to complete the checkpoint, RedoRecPtr will be left
B
Bruce Momjian 已提交
5519 5520 5521 5522 5523
	 * 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 已提交
5524
	 */
5525 5526 5527 5528
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

5529
		SpinLockAcquire(&xlogctl->info_lck);
5530
		RedoRecPtr = xlogctl->Insert.RedoRecPtr = checkPoint.redo;
5531
		SpinLockRelease(&xlogctl->info_lck);
5532
	}
B
Bruce Momjian 已提交
5533

T
Tom Lane 已提交
5534
	/*
5535 5536
	 * Now we can release insert lock and checkpoint start lock, allowing
	 * other xacts to proceed even while we are flushing disk buffers.
T
Tom Lane 已提交
5537
	 */
5538
	LWLockRelease(WALInsertLock);
5539

5540 5541
	LWLockRelease(CheckpointStartLock);

5542 5543 5544 5545
	if (!shutdown)
		ereport(DEBUG2,
				(errmsg("checkpoint starting")));

5546 5547 5548
	/*
	 * Get the other info we need for the checkpoint record.
	 */
5549
	LWLockAcquire(XidGenLock, LW_SHARED);
5550
	checkPoint.nextXid = ShmemVariableCache->nextXid;
5551
	LWLockRelease(XidGenLock);
T
Tom Lane 已提交
5552

5553 5554 5555 5556 5557
	/* Increase XID epoch if we've wrapped around since last checkpoint */
	checkPoint.nextXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	if (checkPoint.nextXid < ControlFile->checkPointCopy.nextXid)
		checkPoint.nextXidEpoch++;

5558
	LWLockAcquire(OidGenLock, LW_SHARED);
5559
	checkPoint.nextOid = ShmemVariableCache->nextOid;
5560 5561
	if (!shutdown)
		checkPoint.nextOid += ShmemVariableCache->oidCount;
5562
	LWLockRelease(OidGenLock);
5563

5564 5565 5566
	MultiXactGetCheckptMulti(shutdown,
							 &checkPoint.nextMulti,
							 &checkPoint.nextMultiOffset);
5567

T
Tom Lane 已提交
5568
	/*
B
Bruce Momjian 已提交
5569 5570
	 * Having constructed the checkpoint record, ensure all shmem disk buffers
	 * and commit-log buffers are flushed to disk.
5571
	 *
5572 5573 5574 5575 5576
	 * 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
	 * panic. Accordingly, exit critical section while doing it.  (If we are
	 * doing a shutdown checkpoint, we probably *should* panic --- but that
	 * will happen anyway because we'll still be inside the critical section
B
Bruce Momjian 已提交
5577
	 * established by ShutdownXLOG.)
T
Tom Lane 已提交
5578
	 */
5579 5580
	END_CRIT_SECTION();

5581
	CheckPointGuts(checkPoint.redo);
5582

5583 5584
	START_CRIT_SECTION();

T
Tom Lane 已提交
5585 5586 5587
	/*
	 * Now insert the checkpoint record into XLOG.
	 */
B
Bruce Momjian 已提交
5588
	rdata.data = (char *) (&checkPoint);
5589
	rdata.len = sizeof(checkPoint);
5590
	rdata.buffer = InvalidBuffer;
5591 5592
	rdata.next = NULL;

T
Tom Lane 已提交
5593 5594 5595 5596 5597 5598
	recptr = XLogInsert(RM_XLOG_ID,
						shutdown ? XLOG_CHECKPOINT_SHUTDOWN :
						XLOG_CHECKPOINT_ONLINE,
						&rdata);

	XLogFlush(recptr);
5599

T
Tom Lane 已提交
5600
	/*
B
Bruce Momjian 已提交
5601 5602
	 * We now have ProcLastRecPtr = start of actual checkpoint record, recptr
	 * = end of actual checkpoint record.
T
Tom Lane 已提交
5603 5604
	 */
	if (shutdown && !XLByteEQ(checkPoint.redo, ProcLastRecPtr))
5605 5606
		ereport(PANIC,
				(errmsg("concurrent transaction log activity while database system is shutting down")));
5607

T
Tom Lane 已提交
5608
	/*
5609 5610
	 * Select point at which we can truncate the log, which we base on the
	 * prior checkpoint's earliest info.
T
Tom Lane 已提交
5611
	 */
5612
	XLByteToSeg(ControlFile->checkPointCopy.redo, _logId, _logSeg);
5613

T
Tom Lane 已提交
5614 5615 5616
	/*
	 * Update the control file.
	 */
5617
	LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
5618 5619
	if (shutdown)
		ControlFile->state = DB_SHUTDOWNED;
T
Tom Lane 已提交
5620 5621 5622
	ControlFile->prevCheckPoint = ControlFile->checkPoint;
	ControlFile->checkPoint = ProcLastRecPtr;
	ControlFile->checkPointCopy = checkPoint;
5623 5624
	ControlFile->time = time(NULL);
	UpdateControlFile();
5625
	LWLockRelease(ControlFileLock);
5626

5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637
	/* 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);
	}

5638
	/*
B
Bruce Momjian 已提交
5639 5640
	 * We are now done with critical updates; no need for system panic if we
	 * have trouble while fooling with offline log segments.
5641 5642 5643
	 */
	END_CRIT_SECTION();

V
Vadim B. Mikheev 已提交
5644
	/*
T
Tom Lane 已提交
5645 5646
	 * Delete offline log files (those no longer needed even for previous
	 * checkpoint).
V
Vadim B. Mikheev 已提交
5647 5648 5649
	 */
	if (_logId || _logSeg)
	{
T
Tom Lane 已提交
5650
		PrevLogSeg(_logId, _logSeg);
5651 5652
		MoveOfflineLogs(_logId, _logSeg, recptr,
						&nsegsremoved, &nsegsrecycled);
V
Vadim B. Mikheev 已提交
5653 5654
	}

T
Tom Lane 已提交
5655
	/*
B
Bruce Momjian 已提交
5656 5657
	 * 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 已提交
5658 5659
	 */
	if (!shutdown)
5660
		nsegsadded = PreallocXlogFiles(recptr);
T
Tom Lane 已提交
5661

5662
	/*
B
Bruce Momjian 已提交
5663 5664 5665 5666 5667
	 * 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.
5668
	 */
5669
	if (!InRecovery)
5670
		TruncateSUBTRANS(GetOldestXmin(true, false));
5671

5672
	if (!shutdown)
5673
		ereport(DEBUG2,
5674 5675 5676
				(errmsg("checkpoint complete; %d transaction log file(s) added, %d removed, %d recycled",
						nsegsadded, nsegsremoved, nsegsrecycled)));

5677
	LWLockRelease(CheckpointLock);
5678
}
V
WAL  
Vadim B. Mikheev 已提交
5679

5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691
/*
 * 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 已提交
5692
	FlushBufferPool();			/* performs all required fsyncs */
5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708
	/* 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 已提交
5709 5710
	int			elapsed_secs;
	int			rmid;
5711 5712

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

B
Bruce Momjian 已提交
5767
	rdata.data = (char *) (&nextOid);
5768
	rdata.len = sizeof(Oid);
5769
	rdata.buffer = InvalidBuffer;
5770 5771
	rdata.next = NULL;
	(void) XLogInsert(RM_XLOG_ID, XLOG_NEXTOID, &rdata);
B
Bruce Momjian 已提交
5772

5773 5774
	/*
	 * We need not flush the NEXTOID record immediately, because any of the
B
Bruce Momjian 已提交
5775 5776 5777 5778 5779
	 * 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.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789
	 *
	 * 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.
5790 5791 5792
	 */
}

5793 5794 5795 5796 5797 5798 5799 5800 5801 5802
/*
 * 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.
 */
5803
XLogRecPtr
5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819
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 已提交
5820 5821 5822
/*
 * XLOG resource manager's routines
 */
V
WAL  
Vadim B. Mikheev 已提交
5823 5824 5825
void
xlog_redo(XLogRecPtr lsn, XLogRecord *record)
{
B
Bruce Momjian 已提交
5826
	uint8		info = record->xl_info & ~XLR_INFO_MASK;
5827

5828
	if (info == XLOG_NEXTOID)
5829
	{
B
Bruce Momjian 已提交
5830
		Oid			nextOid;
5831 5832 5833

		memcpy(&nextOid, XLogRecGetData(record), sizeof(Oid));
		if (ShmemVariableCache->nextOid < nextOid)
T
Tom Lane 已提交
5834
		{
5835
			ShmemVariableCache->nextOid = nextOid;
T
Tom Lane 已提交
5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847
			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;
5848 5849
		MultiXactSetNextMXact(checkPoint.nextMulti,
							  checkPoint.nextMultiOffset);
B
Bruce Momjian 已提交
5850

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

5855
		/*
B
Bruce Momjian 已提交
5856
		 * TLI may change in a shutdown checkpoint, but it shouldn't decrease
5857 5858 5859 5860 5861 5862 5863 5864
		 */
		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 已提交
5865
								checkPoint.ThisTimeLineID, ThisTimeLineID)));
5866 5867 5868
			/* Following WAL records should be run with new TLI */
			ThisTimeLineID = checkPoint.ThisTimeLineID;
		}
5869 5870

		RecoveryRestartPoint(&checkPoint);
T
Tom Lane 已提交
5871 5872 5873 5874 5875 5876
	}
	else if (info == XLOG_CHECKPOINT_ONLINE)
	{
		CheckPoint	checkPoint;

		memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
5877
		/* In an ONLINE checkpoint, treat the counters like NEXTOID */
5878 5879
		if (TransactionIdPrecedes(ShmemVariableCache->nextXid,
								  checkPoint.nextXid))
T
Tom Lane 已提交
5880 5881 5882 5883 5884 5885
			ShmemVariableCache->nextXid = checkPoint.nextXid;
		if (ShmemVariableCache->nextOid < checkPoint.nextOid)
		{
			ShmemVariableCache->nextOid = checkPoint.nextOid;
			ShmemVariableCache->oidCount = 0;
		}
5886 5887
		MultiXactAdvanceNextMXact(checkPoint.nextMulti,
								  checkPoint.nextMultiOffset);
5888 5889 5890 5891 5892

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

5893 5894
		/* TLI should not change in an on-line checkpoint */
		if (checkPoint.ThisTimeLineID != ThisTimeLineID)
5895
			ereport(PANIC,
5896 5897
					(errmsg("unexpected timeline ID %u (should be %u) in checkpoint record",
							checkPoint.ThisTimeLineID, ThisTimeLineID)));
5898 5899

		RecoveryRestartPoint(&checkPoint);
5900
	}
5901 5902 5903 5904
	else if (info == XLOG_SWITCH)
	{
		/* nothing to do here */
	}
V
WAL  
Vadim B. Mikheev 已提交
5905
}
B
Bruce Momjian 已提交
5906

V
WAL  
Vadim B. Mikheev 已提交
5907
void
5908
xlog_desc(StringInfo buf, uint8 xl_info, char *rec)
V
WAL  
Vadim B. Mikheev 已提交
5909
{
B
Bruce Momjian 已提交
5910
	uint8		info = xl_info & ~XLR_INFO_MASK;
V
WAL  
Vadim B. Mikheev 已提交
5911

T
Tom Lane 已提交
5912 5913
	if (info == XLOG_CHECKPOINT_SHUTDOWN ||
		info == XLOG_CHECKPOINT_ONLINE)
V
WAL  
Vadim B. Mikheev 已提交
5914
	{
B
Bruce Momjian 已提交
5915 5916
		CheckPoint *checkpoint = (CheckPoint *) rec;

5917
		appendStringInfo(buf, "checkpoint: redo %X/%X; undo %X/%X; "
B
Bruce Momjian 已提交
5918 5919 5920 5921 5922 5923 5924 5925 5926
						 "tli %u; xid %u/%u; oid %u; multi %u; offset %u; %s",
						 checkpoint->redo.xlogid, checkpoint->redo.xrecoff,
						 checkpoint->undo.xlogid, checkpoint->undo.xrecoff,
						 checkpoint->ThisTimeLineID,
						 checkpoint->nextXidEpoch, checkpoint->nextXid,
						 checkpoint->nextOid,
						 checkpoint->nextMulti,
						 checkpoint->nextMultiOffset,
				 (info == XLOG_CHECKPOINT_SHUTDOWN) ? "shutdown" : "online");
T
Tom Lane 已提交
5927
	}
5928 5929
	else if (info == XLOG_NEXTOID)
	{
B
Bruce Momjian 已提交
5930
		Oid			nextOid;
5931 5932

		memcpy(&nextOid, rec, sizeof(Oid));
5933
		appendStringInfo(buf, "nextOid: %u", nextOid);
5934
	}
5935 5936 5937 5938
	else if (info == XLOG_SWITCH)
	{
		appendStringInfo(buf, "xlog switch");
	}
V
WAL  
Vadim B. Mikheev 已提交
5939
	else
5940
		appendStringInfo(buf, "UNKNOWN");
V
WAL  
Vadim B. Mikheev 已提交
5941 5942
}

5943
#ifdef WAL_DEBUG
5944

V
WAL  
Vadim B. Mikheev 已提交
5945
static void
5946
xlog_outrec(StringInfo buf, XLogRecord *record)
V
WAL  
Vadim B. Mikheev 已提交
5947
{
B
Bruce Momjian 已提交
5948
	int			i;
5949

5950
	appendStringInfo(buf, "prev %X/%X; xid %u",
5951 5952
					 record->xl_prev.xlogid, record->xl_prev.xrecoff,
					 record->xl_xid);
5953

5954
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
5955
	{
5956
		if (record->xl_info & XLR_SET_BKP_BLOCK(i))
B
Bruce Momjian 已提交
5957
			appendStringInfo(buf, "; bkpb%d", i + 1);
5958 5959
	}

5960
	appendStringInfo(buf, ": %s", RmgrTable[record->xl_rmid].rm_name);
V
WAL  
Vadim B. Mikheev 已提交
5961
}
B
Bruce Momjian 已提交
5962
#endif   /* WAL_DEBUG */
5963 5964 5965


/*
5966
 * GUC support
5967
 */
5968
const char *
5969
assign_xlog_sync_method(const char *method, bool doit, GucSource source)
5970
{
B
Bruce Momjian 已提交
5971 5972
	int			new_sync_method;
	int			new_sync_bit;
5973

5974
	if (pg_strcasecmp(method, "fsync") == 0)
5975 5976 5977 5978
	{
		new_sync_method = SYNC_METHOD_FSYNC;
		new_sync_bit = 0;
	}
5979 5980 5981 5982 5983 5984 5985
#ifdef HAVE_FSYNC_WRITETHROUGH
	else if (pg_strcasecmp(method, "fsync_writethrough") == 0)
	{
		new_sync_method = SYNC_METHOD_FSYNC_WRITETHROUGH;
		new_sync_bit = 0;
	}
#endif
5986
#ifdef HAVE_FDATASYNC
5987
	else if (pg_strcasecmp(method, "fdatasync") == 0)
5988 5989 5990 5991 5992 5993
	{
		new_sync_method = SYNC_METHOD_FDATASYNC;
		new_sync_bit = 0;
	}
#endif
#ifdef OPEN_SYNC_FLAG
5994
	else if (pg_strcasecmp(method, "open_sync") == 0)
5995 5996 5997 5998 5999 6000
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_SYNC_FLAG;
	}
#endif
#ifdef OPEN_DATASYNC_FLAG
6001
	else if (pg_strcasecmp(method, "open_datasync") == 0)
6002 6003 6004 6005 6006 6007
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_DATASYNC_FLAG;
	}
#endif
	else
6008
		return NULL;
6009

6010 6011 6012
	if (!doit)
		return method;

6013 6014 6015
	if (sync_method != new_sync_method || open_sync_bit != new_sync_bit)
	{
		/*
B
Bruce Momjian 已提交
6016 6017
		 * 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 已提交
6018 6019
		 * changing, close the log file so it will be reopened (with new flag
		 * bit) at next use.
6020 6021 6022 6023
		 */
		if (openLogFile >= 0)
		{
			if (pg_fsync(openLogFile) != 0)
6024 6025
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6026 6027
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6028
			if (open_sync_bit != new_sync_bit)
6029
				XLogFileClose();
6030 6031 6032 6033
		}
		sync_method = new_sync_method;
		open_sync_bit = new_sync_bit;
	}
6034 6035

	return method;
6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046
}


/*
 * Issue appropriate kind of fsync (if any) on the current XLOG output file
 */
static void
issue_xlog_fsync(void)
{
	switch (sync_method)
	{
6047
		case SYNC_METHOD_FSYNC:
6048
			if (pg_fsync_no_writethrough(openLogFile) != 0)
6049 6050
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6051 6052
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6053
			break;
6054 6055 6056 6057 6058
#ifdef HAVE_FSYNC_WRITETHROUGH
		case SYNC_METHOD_FSYNC_WRITETHROUGH:
			if (pg_fsync_writethrough(openLogFile) != 0)
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6059 6060
						 errmsg("could not fsync write-through log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6061 6062
			break;
#endif
6063 6064 6065
#ifdef HAVE_FDATASYNC
		case SYNC_METHOD_FDATASYNC:
			if (pg_fdatasync(openLogFile) != 0)
6066 6067
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6068 6069
					errmsg("could not fdatasync log file %u, segment %u: %m",
						   openLogId, openLogSeg)));
6070 6071 6072 6073 6074 6075
			break;
#endif
		case SYNC_METHOD_OPEN:
			/* write synced it already */
			break;
		default:
6076
			elog(PANIC, "unrecognized wal_sync_method: %d", sync_method);
6077 6078 6079
			break;
	}
}
6080 6081 6082 6083 6084 6085 6086 6087 6088


/*
 * 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
6089
 * starting WAL location for the dump.
6090 6091 6092 6093 6094 6095 6096
 */
Datum
pg_start_backup(PG_FUNCTION_ARGS)
{
	text	   *backupid = PG_GETARG_TEXT_P(0);
	text	   *result;
	char	   *backupidstr;
6097
	XLogRecPtr	checkpointloc;
6098
	XLogRecPtr	startpoint;
B
Bruce Momjian 已提交
6099
	time_t		stamp_time;
6100 6101 6102 6103 6104 6105 6106
	char		strfbuf[128];
	char		xlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	struct stat stat_buf;
	FILE	   *fp;

B
Bruce Momjian 已提交
6107
	if (!superuser())
6108 6109 6110
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
6111 6112 6113 6114

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

6119
	backupidstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6120
												 PointerGetDatum(backupid)));
B
Bruce Momjian 已提交
6121

6122
	/*
6123 6124 6125
	 * 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 已提交
6126 6127 6128 6129 6130 6131 6132 6133 6134
	 * 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.)
6135
	 *
B
Bruce Momjian 已提交
6136 6137
	 * We must hold WALInsertLock to change the value of forcePageWrites, to
	 * ensure adequate interlocking against XLogInsert().
6138
	 */
6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149
	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 已提交
6150

6151 6152 6153 6154
	/* Use a TRY block to ensure we release forcePageWrites if fail below */
	PG_TRY();
	{
		/*
B
Bruce Momjian 已提交
6155
		 * Force a CHECKPOINT.	Aside from being necessary to prevent torn
6156 6157 6158 6159 6160
		 * 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);
6161

6162 6163 6164 6165 6166 6167 6168 6169 6170
		/*
		 * 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 已提交
6171

6172 6173
		XLByteToSeg(startpoint, _logId, _logSeg);
		XLogFileName(xlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6174

6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210
		/*
		 * 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)
6211 6212
			ereport(ERROR,
					(errcode_for_file_access(),
6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224
					 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",
6225
							BACKUP_LABEL_FILE)));
6226
	}
6227 6228 6229 6230 6231 6232
	PG_CATCH();
	{
		/* Turn off forcePageWrites on failure */
		LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
		XLogCtl->Insert.forcePageWrites = false;
		LWLockRelease(WALInsertLock);
B
Bruce Momjian 已提交
6233

6234 6235 6236
		PG_RE_THROW();
	}
	PG_END_TRY();
B
Bruce Momjian 已提交
6237

6238
	/*
6239
	 * We're done.  As a convenience, return the starting WAL location.
6240 6241 6242 6243
	 */
	snprintf(xlogfilename, sizeof(xlogfilename), "%X/%X",
			 startpoint.xlogid, startpoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6244
											 CStringGetDatum(xlogfilename)));
6245 6246 6247 6248 6249 6250 6251 6252 6253
	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
6254
 * the label file, plus the backup-end time and WAL location.
6255 6256 6257 6258 6259 6260 6261
 */
Datum
pg_stop_backup(PG_FUNCTION_ARGS)
{
	text	   *result;
	XLogRecPtr	startpoint;
	XLogRecPtr	stoppoint;
B
Bruce Momjian 已提交
6262
	time_t		stamp_time;
6263
	char		strfbuf[128];
6264
	char		histfilepath[MAXPGPATH];
6265 6266 6267 6268 6269 6270 6271 6272 6273
	char		startxlogfilename[MAXFNAMELEN];
	char		stopxlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	FILE	   *lfp;
	FILE	   *fp;
	char		ch;
	int			ich;

B
Bruce Momjian 已提交
6274
	if (!superuser())
6275 6276 6277
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
B
Bruce Momjian 已提交
6278

6279
	/*
6280
	 * OK to clear forcePageWrites
6281 6282
	 */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
6283
	XLogCtl->Insert.forcePageWrites = false;
6284 6285
	LWLockRelease(WALInsertLock);

6286
	/*
B
Bruce Momjian 已提交
6287 6288 6289
	 * 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.
6290 6291 6292
	 */
	stoppoint = RequestXLogSwitch();

6293 6294
	XLByteToSeg(stoppoint, _logId, _logSeg);
	XLogFileName(stopxlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6295

6296
	/*
B
Bruce Momjian 已提交
6297 6298 6299 6300
	 * 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.
6301 6302 6303 6304 6305
	 */
	stamp_time = time(NULL);
	strftime(strfbuf, sizeof(strfbuf),
			 "%Y-%m-%d %H:%M:%S %Z",
			 localtime(&stamp_time));
B
Bruce Momjian 已提交
6306

6307 6308 6309
	/*
	 * Open the existing label file
	 */
6310
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6311 6312 6313 6314 6315 6316
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(ERROR,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6317
							BACKUP_LABEL_FILE)));
6318 6319 6320 6321
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
				 errmsg("a backup is not in progress")));
	}
B
Bruce Momjian 已提交
6322

6323
	/*
B
Bruce Momjian 已提交
6324 6325
	 * Read and parse the START WAL LOCATION line (this code is pretty crude,
	 * but we are not expecting any variability in the file format).
6326 6327 6328 6329 6330 6331
	 */
	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),
6332
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6333

6334 6335 6336 6337
	/*
	 * Write the backup history file
	 */
	XLByteToSeg(startpoint, _logId, _logSeg);
6338
	BackupHistoryFilePath(histfilepath, ThisTimeLineID, _logId, _logSeg,
6339
						  startpoint.xrecoff % XLogSegSize);
6340
	fp = AllocateFile(histfilepath, "w");
6341 6342 6343 6344
	if (!fp)
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not create file \"%s\": %m",
6345
						histfilepath)));
6346 6347 6348 6349
	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);
6350
	/* transfer remaining lines from label to history file */
6351 6352 6353 6354 6355 6356 6357
	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",
6358
						histfilepath)));
B
Bruce Momjian 已提交
6359

6360 6361 6362 6363 6364 6365 6366
	/*
	 * 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",
6367 6368
						BACKUP_LABEL_FILE)));
	if (unlink(BACKUP_LABEL_FILE) != 0)
6369 6370 6371
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not remove file \"%s\": %m",
6372
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6373

6374
	/*
B
Bruce Momjian 已提交
6375 6376 6377
	 * 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.
6378
	 */
6379
	CleanupBackupHistory();
B
Bruce Momjian 已提交
6380

6381
	/*
6382
	 * We're done.  As a convenience, return the ending WAL location.
6383 6384 6385 6386
	 */
	snprintf(stopxlogfilename, sizeof(stopxlogfilename), "%X/%X",
			 stoppoint.xlogid, stoppoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6387
										 CStringGetDatum(stopxlogfilename)));
6388 6389
	PG_RETURN_TEXT_P(result);
}
6390

6391 6392 6393 6394 6395 6396 6397
/*
 * pg_switch_xlog: switch to next xlog file
 */
Datum
pg_switch_xlog(PG_FUNCTION_ARGS)
{
	text	   *result;
B
Bruce Momjian 已提交
6398
	XLogRecPtr	switchpoint;
6399 6400 6401 6402 6403
	char		location[MAXFNAMELEN];

	if (!superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
P
Peter Eisentraut 已提交
6404
				 (errmsg("must be superuser to switch transaction log files"))));
6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418

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

/*
6419 6420 6421 6422 6423
 * 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.
6424 6425 6426
 */
Datum
pg_current_xlog_location(PG_FUNCTION_ARGS)
6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455
{
	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)
6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496
{
	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 已提交
6497 6498 6499 6500 6501
	Datum		values[2];
	bool		isnull[2];
	TupleDesc	resultTupleDesc;
	HeapTuple	resultHeapTuple;
	Datum		result;
6502

6503 6504 6505
	/*
	 * Read input and parse
	 */
6506
	locationstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6507
												 PointerGetDatum(location)));
6508 6509 6510 6511

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6512
				 errmsg("could not parse transaction log location \"%s\"",
6513 6514 6515 6516 6517
						locationstr)));

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

6518
	/*
B
Bruce Momjian 已提交
6519 6520
	 * Construct a tuple descriptor for the result row.  This must match this
	 * function's pg_proc entry!
6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532
	 */
	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
	 */
6533 6534 6535
	XLByteToPrevSeg(locationpoint, xlogid, xlogseg);
	XLogFileName(xlogfilename, ThisTimeLineID, xlogid, xlogseg);

6536 6537 6538 6539 6540 6541 6542
	values[0] = DirectFunctionCall1(textin,
									CStringGetDatum(xlogfilename));
	isnull[0] = false;

	/*
	 * offset
	 */
6543 6544
	xrecoff = locationpoint.xrecoff - xlogseg * XLogSegSize;

6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555
	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);
6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575
}

/*
 * 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 已提交
6576
												 PointerGetDatum(location)));
6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
				 errmsg("could not parse xlog location \"%s\"",
						locationstr)));

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

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

	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6591
											 CStringGetDatum(xlogfilename)));
6592 6593 6594
	PG_RETURN_TEXT_P(result);
}

6595 6596 6597 6598 6599
/*
 * 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 已提交
6600
 * identified by the label file, NOT what pg_control says.	This avoids the
6601 6602 6603 6604 6605
 * 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.
6606
 * If successful, set *minRecoveryLoc to constrain valid PITR stopping
6607 6608 6609 6610 6611 6612
 * points.
 *
 * Returns TRUE if a backup_label was found (and fills the checkpoint
 * location into *checkPointLoc); returns FALSE if not.
 */
static bool
6613
read_backup_label(XLogRecPtr *checkPointLoc, XLogRecPtr *minRecoveryLoc)
6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627
{
	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;

6628 6629 6630 6631
	/* Default is to not constrain recovery stop point */
	minRecoveryLoc->xlogid = 0;
	minRecoveryLoc->xrecoff = 0;

6632 6633 6634
	/*
	 * See if label file is present
	 */
6635
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6636 6637 6638 6639 6640 6641
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6642
							BACKUP_LABEL_FILE)));
6643 6644
		return false;			/* it's not there, all is fine */
	}
B
Bruce Momjian 已提交
6645

6646
	/*
B
Bruce Momjian 已提交
6647 6648 6649
	 * 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).
6650 6651 6652 6653 6654 6655
	 */
	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),
6656
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
6657 6658 6659 6660 6661
	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),
6662
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
6663 6664 6665 6666
	if (ferror(lfp) || FreeFile(lfp))
		ereport(FATAL,
				(errcode_for_file_access(),
				 errmsg("could not read file \"%s\": %m",
6667
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6668

6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681
	/*
	 * 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 已提交
6682
	fp = AllocateFile(histfilepath, "r");
6683 6684 6685 6686 6687 6688
	if (fp)
	{
		/*
		 * Parse history file to identify stop point.
		 */
		if (fscanf(fp, "START WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
6689
				   &startpoint.xlogid, &startpoint.xrecoff, startxlogfilename,
6690 6691 6692
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
6693
					 errmsg("invalid data in file \"%s\"", histfilename)));
6694
		if (fscanf(fp, "STOP WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
6695
				   &stoppoint.xlogid, &stoppoint.xrecoff, stopxlogfilename,
6696 6697 6698
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
6699
					 errmsg("invalid data in file \"%s\"", histfilename)));
6700
		*minRecoveryLoc = stoppoint;
6701 6702 6703 6704 6705 6706 6707 6708 6709 6710
		if (ferror(fp) || FreeFile(fp))
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
							histfilepath)));
	}

	return true;
}

6711 6712 6713 6714 6715 6716
/*
 * Error context callback for errors occurring during rm_redo().
 */
static void
rm_redo_error_callback(void *arg)
{
B
Bruce Momjian 已提交
6717 6718
	XLogRecord *record = (XLogRecord *) arg;
	StringInfoData buf;
6719 6720

	initStringInfo(&buf);
6721 6722
	RmgrTable[record->xl_rmid].rm_desc(&buf,
									   record->xl_info,
6723 6724 6725 6726 6727 6728 6729 6730
									   XLogRecGetData(record));

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

	pfree(buf.data);
}