xlog.c 210.3 KB
Newer Older
1
/*-------------------------------------------------------------------------
2 3
 *
 * xlog.c
4
 *		PostgreSQL transaction log manager
5 6
 *
 *
7
 * Portions Copyright (c) 1996-2008, 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.292.2.11 2010/06/09 10:54:50 mha Exp $
11 12 13
 *
 *-------------------------------------------------------------------------
 */
14

15 16
#include "postgres.h"

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

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

55

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


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

74 75 76 77
#ifdef WAL_DEBUG
bool		XLOG_DEBUG = false;
#endif

78
/*
79 80 81 82 83
 * XLOGfileslop is the maximum number of preallocated future XLOG segments.
 * When we are done with an old XLOG segment file, we will recycle it as a
 * future XLOG segment as long as there aren't already XLOGfileslop future
 * segments; else we'll delete it.  This could be made a separate GUC
 * variable, but at present I think it's sufficient to hardwire it as
B
Bruce Momjian 已提交
84
 * 2*CheckPointSegments+1.	Under normal conditions, a checkpoint will free
85 86 87
 * 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.
88 89 90 91
 */
#define XLOGfileslop	(2*CheckPointSegments + 1)


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

#define XLOG_SYNC_BIT  (enableFsync ? open_sync_bit : 0)

T
Tom Lane 已提交
98

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

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

112
/* Are we doing recovery from XLOG? */
T
Tom Lane 已提交
113
bool		InRecovery = false;
B
Bruce Momjian 已提交
114

115
/* Are we recovering using offline XLOG archives? */
B
Bruce Momjian 已提交
116 117
static bool InArchiveRecovery = false;

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

121 122
/* options taken from recovery.conf */
static char *recoveryRestoreCommand = NULL;
123 124 125
static bool recoveryTarget = false;
static bool recoveryTargetExact = false;
static bool recoveryTargetInclusive = true;
126
static bool recoveryLogRestartpoints = false;
B
Bruce Momjian 已提交
127
static TransactionId recoveryTargetXid;
128
static TimestampTz recoveryTargetTime;
129
static TimestampTz recoveryLastXTime = 0;
130

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

/*
 * 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 已提交
148
 * first list member).	Only these TLIs are expected to be seen in the WAL
149 150 151 152 153 154 155 156 157
 * 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 已提交
158 159 160
static TimeLineID recoveryTargetTLI;
static List *expectedTLIs;
static TimeLineID curFileTLI;
161

T
Tom Lane 已提交
162 163
/*
 * ProcLastRecPtr points to the start of the last XLOG record inserted by the
164 165 166 167
 * current backend.  It is updated for all inserts.  XactLastRecEnd points to
 * end+1 of the last record, and is reset when we end a top-level transaction,
 * or start a new one; so it can be used to tell if the current transaction has
 * created any XLOG records.
T
Tom Lane 已提交
168 169
 */
static XLogRecPtr ProcLastRecPtr = {0, 0};
170

171
XLogRecPtr	XactLastRecEnd = {0, 0};
172

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

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

T
Tom Lane 已提交
242
typedef struct XLogwrtRqst
243
{
T
Tom Lane 已提交
244 245
	XLogRecPtr	Write;			/* last byte + 1 to write out */
	XLogRecPtr	Flush;			/* last byte + 1 to flush */
246
} XLogwrtRqst;
247

248 249 250 251 252 253
typedef struct XLogwrtResult
{
	XLogRecPtr	Write;			/* last byte + 1 written out */
	XLogRecPtr	Flush;			/* last byte + 1 flushed */
} XLogwrtResult;

T
Tom Lane 已提交
254 255 256
/*
 * Shared state data for XLogInsert.
 */
257 258
typedef struct XLogCtlInsert
{
B
Bruce Momjian 已提交
259 260
	XLogwrtResult LogwrtResult; /* a recent value of LogwrtResult */
	XLogRecPtr	PrevRecord;		/* start of previously-inserted record */
261
	int			curridx;		/* current block index in cache */
B
Bruce Momjian 已提交
262 263 264
	XLogPageHeader currpage;	/* points to header of block in cache */
	char	   *currpos;		/* current insertion point in cache */
	XLogRecPtr	RedoRecPtr;		/* current redo point for insertions */
265
	bool		forcePageWrites;	/* forcing full-page writes for PITR? */
266 267
} XLogCtlInsert;

T
Tom Lane 已提交
268 269 270
/*
 * Shared state data for XLogWrite/XLogFlush.
 */
271 272
typedef struct XLogCtlWrite
{
B
Bruce Momjian 已提交
273 274 275
	XLogwrtResult LogwrtResult; /* current value of LogwrtResult */
	int			curridx;		/* cache index of next block to write */
	time_t		lastSegSwitchTime;		/* time of last xlog segment switch */
276 277
} XLogCtlWrite;

T
Tom Lane 已提交
278 279 280
/*
 * Total shared-memory state for XLOG.
 */
281 282
typedef struct XLogCtlData
{
283
	/* Protected by WALInsertLock: */
B
Bruce Momjian 已提交
284
	XLogCtlInsert Insert;
285

T
Tom Lane 已提交
286
	/* Protected by info_lck: */
B
Bruce Momjian 已提交
287 288
	XLogwrtRqst LogwrtRqst;
	XLogwrtResult LogwrtResult;
289 290
	uint32		ckptXidEpoch;	/* nextXID & epoch of latest checkpoint */
	TransactionId ckptXid;
B
Bruce Momjian 已提交
291
	XLogRecPtr	asyncCommitLSN; /* LSN of newest async commit */
292

293
	/* Protected by WALWriteLock: */
B
Bruce Momjian 已提交
294 295
	XLogCtlWrite Write;

T
Tom Lane 已提交
296
	/*
B
Bruce Momjian 已提交
297 298 299
	 * 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 已提交
300
	 */
B
Bruce Momjian 已提交
301
	char	   *pages;			/* buffers for unwritten XLOG pages */
302
	XLogRecPtr *xlblocks;		/* 1st byte ptr-s + XLOG_BLCKSZ */
303 304
	Size		XLogCacheByte;	/* # bytes in xlog buffers */
	int			XLogCacheBlck;	/* highest allocated xlog buffer index */
305
	TimeLineID	ThisTimeLineID;
T
Tom Lane 已提交
306

307
	slock_t		info_lck;		/* locks shared variables shown above */
308 309
} XLogCtlData;

310
static XLogCtlData *XLogCtl = NULL;
311

312
/*
T
Tom Lane 已提交
313
 * We maintain an image of pg_control in shared memory.
314
 */
315
static ControlFileData *ControlFile = NULL;
316

T
Tom Lane 已提交
317 318 319 320 321
/*
 * 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.
 */
322

T
Tom Lane 已提交
323 324
/* Free space remaining in the current xlog page buffer */
#define INSERT_FREESPACE(Insert)  \
325
	(XLOG_BLCKSZ - ((Insert)->currpos - (char *) (Insert)->currpage))
T
Tom Lane 已提交
326 327 328 329 330 331

/* Construct XLogRecPtr value for current insertion point */
#define INSERT_RECPTR(recptr,Insert,curridx)  \
	( \
	  (recptr).xlogid = XLogCtl->xlblocks[curridx].xlogid, \
	  (recptr).xrecoff = \
B
Bruce Momjian 已提交
332
		XLogCtl->xlblocks[curridx].xrecoff - INSERT_FREESPACE(Insert) \
T
Tom Lane 已提交
333 334 335 336 337 338 339
	)

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

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

T
Tom Lane 已提交
341 342 343 344
/*
 * Private, possibly out-of-date copy of shared LogwrtResult.
 * See discussion above.
 */
345
static XLogwrtResult LogwrtResult = {{0, 0}, {0, 0}};
346

T
Tom Lane 已提交
347 348 349 350 351 352 353 354 355 356
/*
 * 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;
357

T
Tom Lane 已提交
358 359 360 361 362 363
/*
 * 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.
 */
364 365 366 367
static int	readFile = -1;
static uint32 readId = 0;
static uint32 readSeg = 0;
static uint32 readOff = 0;
B
Bruce Momjian 已提交
368

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

372 373 374 375
/* Buffer for current ReadRecord result (expandable) */
static char *readRecordBuf = NULL;
static uint32 readRecordBufSize = 0;

T
Tom Lane 已提交
376
/* State information for XLOG reading */
B
Bruce Momjian 已提交
377 378
static XLogRecPtr ReadRecPtr;	/* start of last record read */
static XLogRecPtr EndRecPtr;	/* end+1 of last record read */
379
static XLogRecord *nextRecord = NULL;
380
static TimeLineID lastPageTLI = 0;
381

V
WAL  
Vadim B. Mikheev 已提交
382 383
static bool InRedo = false;

384

385 386
static void XLogArchiveNotify(const char *xlog);
static void XLogArchiveNotifySeg(uint32 log, uint32 seg);
387
static bool XLogArchiveCheckDone(const char *xlog);
388 389
static void XLogArchiveCleanup(const char *xlog);
static void readRecoveryCommandFile(void);
390
static void exitArchiveRecovery(TimeLineID endTLI,
B
Bruce Momjian 已提交
391
					uint32 endLogId, uint32 endLogSeg);
392
static bool recoveryStopsHere(XLogRecord *record, bool *includeThis);
393
static void CheckPointGuts(XLogRecPtr checkPointRedo, int flags);
T
Tom Lane 已提交
394

395
static bool XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
B
Bruce Momjian 已提交
396
				XLogRecPtr *lsn, BkpBlock *bkpb);
397 398
static bool AdvanceXLInsertBuffer(bool new_segment);
static void XLogWrite(XLogwrtRqst WriteRqst, bool flexible, bool xlog_switch);
B
Bruce Momjian 已提交
399 400
static int XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock);
401 402
static bool InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
403
					   bool use_lock);
404 405
static int	XLogFileOpen(uint32 log, uint32 seg);
static int	XLogFileRead(uint32 log, uint32 seg, int emode);
B
Bruce Momjian 已提交
406
static void XLogFileClose(void);
407
static bool RestoreArchivedFile(char *path, const char *xlogfname,
B
Bruce Momjian 已提交
408
					const char *recovername, off_t expectedSize);
409 410
static void PreallocXlogFiles(XLogRecPtr endptr);
static void RemoveOldXlogFiles(uint32 log, uint32 seg, XLogRecPtr endptr);
411
static void CleanupBackupHistory(void);
412
static XLogRecord *ReadRecord(XLogRecPtr *RecPtr, int emode);
413
static bool ValidXLOGHeader(XLogPageHeader hdr, int emode);
414
static XLogRecord *ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt);
415 416 417 418
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 已提交
419 420
					 TimeLineID endTLI,
					 uint32 endLogId, uint32 endLogSeg);
T
Tom Lane 已提交
421 422
static void WriteControlFile(void);
static void ReadControlFile(void);
423
static char *str_time(pg_time_t tnow);
424
#ifdef WAL_DEBUG
425
static void xlog_outrec(StringInfo buf, XLogRecord *record);
426
#endif
427 428
static void issue_xlog_fsync(void);
static void pg_start_backup_callback(int code, Datum arg);
429
static bool read_backup_label(XLogRecPtr *checkPointLoc,
B
Bruce Momjian 已提交
430
				  XLogRecPtr *minRecoveryLoc);
431
static void rm_redo_error_callback(void *arg);
T
Tom Lane 已提交
432 433 434 435 436


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

475
	/* info's high bits are reserved for use by me */
V
Vadim B. Mikheev 已提交
476
	if (info & XLR_INFO_MASK)
477
		elog(PANIC, "invalid xlog info mask %02X", info);
V
Vadim B. Mikheev 已提交
478

T
Tom Lane 已提交
479
	/*
B
Bruce Momjian 已提交
480 481
	 * In bootstrap mode, we don't actually log anything but XLOG resources;
	 * return a phony record pointer.
T
Tom Lane 已提交
482
	 */
V
Vadim B. Mikheev 已提交
483
	if (IsBootstrapProcessingMode() && rmid != RM_XLOG_ID)
V
WAL  
Vadim B. Mikheev 已提交
484 485
	{
		RecPtr.xlogid = 0;
B
Bruce Momjian 已提交
486
		RecPtr.xrecoff = SizeOfXLogLongPHD;		/* start of 1st chkpt record */
487
		return RecPtr;
V
WAL  
Vadim B. Mikheev 已提交
488 489
	}

T
Tom Lane 已提交
490
	/*
491
	 * Here we scan the rdata chain, determine which buffers must be backed
T
Tom Lane 已提交
492
	 * up, and compute the CRC values for the data.  Note that the record
B
Bruce Momjian 已提交
493 494 495 496
	 * 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 已提交
497
	 *
498 499 500 501 502
	 * 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 已提交
503 504 505 506 507
	 * 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 已提交
508
	 */
509
begin:;
T
Tom Lane 已提交
510 511 512 513 514 515
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
	{
		dtbuf[i] = InvalidBuffer;
		dtbuf_bkp[i] = false;
	}

516 517 518 519 520 521 522 523
	/*
	 * 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;

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

579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
	/*
	 * 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 已提交
612
	/*
613 614
	 * 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 已提交
615 616 617
	 * 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 已提交
618
	 */
619
	if (len == 0 && !isLogSwitch)
620
		elog(PANIC, "invalid xlog record length %u", len);
621

622
	START_CRIT_SECTION();
623

624 625 626
	/* Now wait to get insert lock */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);

T
Tom Lane 已提交
627
	/*
B
Bruce Momjian 已提交
628 629 630
	 * 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.
631 632
	 *
	 * If we aren't doing full-page writes then RedoRecPtr doesn't actually
B
Bruce Momjian 已提交
633 634
	 * affect the contents of the XLOG record, so we'll update our local copy
	 * but not force a recomputation.
T
Tom Lane 已提交
635 636
	 */
	if (!XLByteEQ(RedoRecPtr, Insert->RedoRecPtr))
637
	{
T
Tom Lane 已提交
638 639 640
		Assert(XLByteLT(RedoRecPtr, Insert->RedoRecPtr));
		RedoRecPtr = Insert->RedoRecPtr;

641
		if (doPageWrites)
642
		{
643
			for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
T
Tom Lane 已提交
644
			{
645 646 647 648 649 650 651 652 653 654 655 656 657
				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 已提交
658
			}
659 660 661
		}
	}

662
	/*
B
Bruce Momjian 已提交
663 664 665 666
	 * 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.)
667 668 669 670 671 672 673 674 675
	 */
	if (Insert->forcePageWrites && !doPageWrites)
	{
		/* Oops, must redo it with full-page data */
		LWLockRelease(WALInsertLock);
		END_CRIT_SECTION();
		goto begin;
	}

T
Tom Lane 已提交
676
	/*
B
Bruce Momjian 已提交
677 678 679 680
	 * 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 已提交
681
	 *
682 683 684
	 * 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 已提交
685 686 687
	 */
	write_len = len;
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
688
	{
689 690 691
		BkpBlock   *bkpb;
		char	   *page;

692
		if (!dtbuf_bkp[i])
693 694
			continue;

T
Tom Lane 已提交
695
		info |= XLR_SET_BKP_BLOCK(i);
696

697 698 699 700 701
		bkpb = &(dtbuf_xlg[i]);
		page = (char *) BufferGetBlock(dtbuf[i]);

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

703 704
		rdt->data = (char *) bkpb;
		rdt->len = sizeof(BkpBlock);
T
Tom Lane 已提交
705
		write_len += sizeof(BkpBlock);
706

707 708
		rdt->next = &(dtbuf_rdt2[i]);
		rdt = rdt->next;
709

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
		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;
		}
732 733
	}

734 735 736 737 738 739 740
	/*
	 * If we backed up any full blocks and online backup is not in progress,
	 * mark the backup blocks as removable.  This allows the WAL archiver to
	 * know whether it is safe to compress archived WAL data by transforming
	 * full-block records into the non-full-block format.
	 *
	 * Note: we could just set the flag whenever !forcePageWrites, but
B
Bruce Momjian 已提交
741 742
	 * defining it like this leaves the info bit free for some potential other
	 * use in records without any backup blocks.
743 744 745 746
	 */
	if ((info & XLR_BKP_BLOCK_MASK) && !Insert->forcePageWrites)
		info |= XLR_BKP_REMOVABLE;

747
	/*
748
	 * If there isn't enough space on the current XLOG page for a record
B
Bruce Momjian 已提交
749
	 * header, advance to the next page (leaving the unused space as zeroes).
750
	 */
T
Tom Lane 已提交
751 752
	updrqst = false;
	freespace = INSERT_FREESPACE(Insert);
753 754
	if (freespace < SizeOfXLogRecord)
	{
755
		updrqst = AdvanceXLInsertBuffer(false);
756 757 758
		freespace = INSERT_FREESPACE(Insert);
	}

759
	/* Compute record's XLOG location */
T
Tom Lane 已提交
760
	curridx = Insert->curridx;
761 762 763
	INSERT_RECPTR(RecPtr, Insert, curridx);

	/*
B
Bruce Momjian 已提交
764 765 766 767 768
	 * 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.
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
	 */
	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 已提交
800

801 802
	/* Insert record header */

803
	record = (XLogRecord *) Insert->currpos;
804
	record->xl_prev = Insert->PrevRecord;
805
	record->xl_xid = GetCurrentTransactionIdIfAny();
806
	record->xl_tot_len = SizeOfXLogRecord + write_len;
T
Tom Lane 已提交
807
	record->xl_len = len;		/* doesn't include backup blocks */
808
	record->xl_info = info;
809
	record->xl_rmid = rmid;
810

811 812 813 814
	/* 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);
815 816
	record->xl_crc = rdata_crc;

817
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
818 819
	if (XLOG_DEBUG)
	{
B
Bruce Momjian 已提交
820
		StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
821

822
		initStringInfo(&buf);
823 824
		appendStringInfo(&buf, "INSERT @ %X/%X: ",
						 RecPtr.xlogid, RecPtr.xrecoff);
825
		xlog_outrec(&buf, record);
826
		if (rdata->data != NULL)
V
WAL  
Vadim B. Mikheev 已提交
827
		{
828 829
			appendStringInfo(&buf, " - ");
			RmgrTable[record->xl_rmid].rm_desc(&buf, record->xl_info, rdata->data);
V
WAL  
Vadim B. Mikheev 已提交
830
		}
831 832
		elog(LOG, "%s", buf.data);
		pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
833
	}
834
#endif
V
WAL  
Vadim B. Mikheev 已提交
835

T
Tom Lane 已提交
836 837 838 839
	/* Record begin of record in appropriate places */
	ProcLastRecPtr = RecPtr;
	Insert->PrevRecord = RecPtr;

840
	Insert->currpos += SizeOfXLogRecord;
T
Tom Lane 已提交
841
	freespace -= SizeOfXLogRecord;
842

T
Tom Lane 已提交
843 844 845 846
	/*
	 * Append the data, including backup blocks if any
	 */
	while (write_len)
847
	{
848 849 850 851
		while (rdata->data == NULL)
			rdata = rdata->next;

		if (freespace > 0)
852
		{
853 854 855 856 857
			if (rdata->len > freespace)
			{
				memcpy(Insert->currpos, rdata->data, freespace);
				rdata->data += freespace;
				rdata->len -= freespace;
T
Tom Lane 已提交
858
				write_len -= freespace;
859 860 861 862 863
			}
			else
			{
				memcpy(Insert->currpos, rdata->data, rdata->len);
				freespace -= rdata->len;
T
Tom Lane 已提交
864
				write_len -= rdata->len;
865 866 867 868
				Insert->currpos += rdata->len;
				rdata = rdata->next;
				continue;
			}
869 870
		}

871
		/* Use next buffer */
872
		updrqst = AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
873 874 875 876 877 878
		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;
879
		freespace = INSERT_FREESPACE(Insert);
880
	}
881

T
Tom Lane 已提交
882 883
	/* Ensure next record will be properly aligned */
	Insert->currpos = (char *) Insert->currpage +
B
Bruce Momjian 已提交
884
		MAXALIGN(Insert->currpos - (char *) Insert->currpage);
T
Tom Lane 已提交
885
	freespace = INSERT_FREESPACE(Insert);
886

V
Vadim B. Mikheev 已提交
887
	/*
B
Bruce Momjian 已提交
888 889
	 * 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 已提交
890
	 */
T
Tom Lane 已提交
891
	INSERT_RECPTR(RecPtr, Insert, curridx);
V
Vadim B. Mikheev 已提交
892

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
	/*
	 * 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 已提交
910 911
		 * Flush through the end of the page containing XLOG_SWITCH, and
		 * perform end-of-segment actions (eg, notifying archiver).
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
		 */
		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 */
	}
962
	else
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
	{
		/* 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];
	}
979

980
	LWLockRelease(WALInsertLock);
981 982 983

	if (updrqst)
	{
984 985 986
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

987
		SpinLockAcquire(&xlogctl->info_lck);
T
Tom Lane 已提交
988
		/* advance global request to include new block(s) */
989 990
		if (XLByteLT(xlogctl->LogwrtRqst.Write, WriteRqst))
			xlogctl->LogwrtRqst.Write = WriteRqst;
T
Tom Lane 已提交
991
		/* update local result copy while I have the chance */
992
		LogwrtResult = xlogctl->LogwrtResult;
993
		SpinLockRelease(&xlogctl->info_lck);
994 995
	}

996
	XactLastRecEnd = RecPtr;
997

998
	END_CRIT_SECTION();
999

1000
	return RecPtr;
1001
}
1002

1003
/*
1004 1005 1006
 * 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.
1007
 */
1008
static bool
1009
XLogCheckBuffer(XLogRecData *rdata, bool doPageWrites,
1010
				XLogRecPtr *lsn, BkpBlock *bkpb)
1011 1012
{
	PageHeader	page;
1013 1014 1015 1016

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

	/*
B
Bruce Momjian 已提交
1017 1018 1019
	 * 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.
1020 1021 1022
	 */
	*lsn = page->pd_lsn;

1023
	if (doPageWrites &&
1024
		XLByteLE(page->pd_lsn, RedoRecPtr))
1025
	{
1026 1027 1028 1029 1030
		/*
		 * The page needs to be backed up, so set up *bkpb
		 */
		bkpb->node = BufferGetFileNode(rdata->buffer);
		bkpb->block = BufferGetBlockNumber(rdata->buffer);
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
		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;
		}
1058

1059
		return true;			/* buffer requires backup */
1060
	}
1061 1062

	return false;				/* buffer does not need to be backed up */
1063 1064
}

1065 1066 1067 1068 1069 1070
/*
 * XLogArchiveNotify
 *
 * Create an archive notification file
 *
 * The name of the notification file is the message that will be picked up
1071
 * by the archiver, e.g. we write 0000000100000001000000C6.ready
1072
 * and the archiver then knows to archive XLOGDIR/0000000100000001000000C6,
1073
 * then when complete, rename it to 0000000100000001000000C6.done
1074 1075 1076 1077 1078
 */
static void
XLogArchiveNotify(const char *xlog)
{
	char		archiveStatusPath[MAXPGPATH];
B
Bruce Momjian 已提交
1079
	FILE	   *fd;
1080 1081 1082 1083

	/* insert an otherwise empty file called <XLOG>.ready */
	StatusFilePath(archiveStatusPath, xlog, ".ready");
	fd = AllocateFile(archiveStatusPath, "w");
B
Bruce Momjian 已提交
1084 1085
	if (fd == NULL)
	{
1086 1087 1088 1089 1090 1091
		ereport(LOG,
				(errcode_for_file_access(),
				 errmsg("could not create archive status file \"%s\": %m",
						archiveStatusPath)));
		return;
	}
B
Bruce Momjian 已提交
1092 1093
	if (FreeFile(fd))
	{
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
		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];

1114
	XLogFileName(xlog, ThisTimeLineID, log, seg);
1115 1116 1117 1118
	XLogArchiveNotify(xlog);
}

/*
1119
 * XLogArchiveCheckDone
1120
 *
1121 1122 1123 1124
 * 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.
1125 1126
 *
 * If <XLOG>.done exists, then return true; else if <XLOG>.ready exists,
1127 1128 1129 1130
 * 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.
1131 1132
 */
static bool
1133
XLogArchiveCheckDone(const char *xlog)
1134 1135 1136 1137
{
	char		archiveStatusPath[MAXPGPATH];
	struct stat stat_buf;

1138 1139 1140 1141 1142
	/* Always deletable if archiving is off */
	if (!XLogArchivingActive())
		return true;

	/* First check for .done --- this means archiver is done with it */
1143 1144 1145 1146 1147 1148 1149
	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 已提交
1150
		return false;
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164

	/* 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
 *
1165
 * Cleanup archive notification file(s) for a particular xlog segment
1166 1167 1168 1169
 */
static void
XLogArchiveCleanup(const char *xlog)
{
B
Bruce Momjian 已提交
1170
	char		archiveStatusPath[MAXPGPATH];
1171

1172
	/* Remove the .done file */
1173 1174 1175
	StatusFilePath(archiveStatusPath, xlog, ".done");
	unlink(archiveStatusPath);
	/* should we complain about failure? */
1176 1177 1178 1179 1180

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

T
Tom Lane 已提交
1183 1184 1185 1186
/*
 * Advance the Insert state to the next buffer page, writing out the next
 * buffer if it still contains unwritten data.
 *
1187 1188 1189 1190
 * 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 已提交
1191
 * The global LogwrtRqst.Write pointer needs to be advanced to include the
1192
 * just-filled page.  If we can do this for free (without an extra lock),
T
Tom Lane 已提交
1193 1194 1195
 * 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.
 *
1196
 * Must be called with WALInsertLock held.
T
Tom Lane 已提交
1197 1198
 */
static bool
1199
AdvanceXLInsertBuffer(bool new_segment)
1200
{
T
Tom Lane 已提交
1201 1202
	XLogCtlInsert *Insert = &XLogCtl->Insert;
	XLogCtlWrite *Write = &XLogCtl->Write;
1203
	int			nextidx = NextBufIdx(Insert->curridx);
T
Tom Lane 已提交
1204 1205 1206
	bool		update_needed = true;
	XLogRecPtr	OldPageRqstPtr;
	XLogwrtRqst WriteRqst;
1207 1208
	XLogRecPtr	NewPageEndPtr;
	XLogPageHeader NewPage;
1209

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

T
Tom Lane 已提交
1214
	/*
B
Bruce Momjian 已提交
1215 1216 1217
	 * 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 已提交
1218 1219 1220 1221 1222 1223
	 */
	OldPageRqstPtr = XLogCtl->xlblocks[nextidx];
	if (!XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
	{
		/* nope, got work to do... */
		XLogRecPtr	FinishedPageRqstPtr;
1224

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

1227
		/* Before waiting, get info_lck and update LogwrtResult */
1228 1229 1230 1231
		{
			/* use volatile pointer to prevent code rearrangement */
			volatile XLogCtlData *xlogctl = XLogCtl;

1232
			SpinLockAcquire(&xlogctl->info_lck);
1233 1234 1235
			if (XLByteLT(xlogctl->LogwrtRqst.Write, FinishedPageRqstPtr))
				xlogctl->LogwrtRqst.Write = FinishedPageRqstPtr;
			LogwrtResult = xlogctl->LogwrtResult;
1236
			SpinLockRelease(&xlogctl->info_lck);
1237
		}
1238 1239 1240 1241 1242 1243 1244 1245 1246

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

		if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
		{
			/* OK, someone wrote it already */
			Insert->LogwrtResult = LogwrtResult;
		}
		else
1247
		{
1248 1249 1250 1251
			/* Must acquire write lock */
			LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
			LogwrtResult = Write->LogwrtResult;
			if (XLByteLE(OldPageRqstPtr, LogwrtResult.Write))
1252
			{
1253 1254 1255
				/* OK, someone wrote it already */
				LWLockRelease(WALWriteLock);
				Insert->LogwrtResult = LogwrtResult;
T
Tom Lane 已提交
1256
			}
1257
			else
T
Tom Lane 已提交
1258 1259
			{
				/*
B
Bruce Momjian 已提交
1260 1261
				 * Have to write buffers while holding insert lock. This is
				 * not good, so only write as much as we absolutely must.
T
Tom Lane 已提交
1262 1263 1264 1265
				 */
				WriteRqst.Write = OldPageRqstPtr;
				WriteRqst.Flush.xlogid = 0;
				WriteRqst.Flush.xrecoff = 0;
1266
				XLogWrite(WriteRqst, false, false);
1267
				LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1268
				Insert->LogwrtResult = LogwrtResult;
1269 1270 1271 1272
			}
		}
	}

T
Tom Lane 已提交
1273
	/*
B
Bruce Momjian 已提交
1274 1275
	 * Now the next buffer slot is free and we can set it up to be the next
	 * output page.
T
Tom Lane 已提交
1276
	 */
1277
	NewPageEndPtr = XLogCtl->xlblocks[Insert->curridx];
1278 1279 1280 1281 1282 1283 1284 1285

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

1286
	if (NewPageEndPtr.xrecoff >= XLogFileSize)
1287
	{
T
Tom Lane 已提交
1288
		/* crossing a logid boundary */
1289
		NewPageEndPtr.xlogid += 1;
1290
		NewPageEndPtr.xrecoff = XLOG_BLCKSZ;
1291
	}
T
Tom Lane 已提交
1292
	else
1293
		NewPageEndPtr.xrecoff += XLOG_BLCKSZ;
1294
	XLogCtl->xlblocks[nextidx] = NewPageEndPtr;
1295
	NewPage = (XLogPageHeader) (XLogCtl->pages + nextidx * (Size) XLOG_BLCKSZ);
B
Bruce Momjian 已提交
1296

T
Tom Lane 已提交
1297
	Insert->curridx = nextidx;
1298
	Insert->currpage = NewPage;
B
Bruce Momjian 已提交
1299 1300

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

T
Tom Lane 已提交
1302
	/*
B
Bruce Momjian 已提交
1303 1304
	 * 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 已提交
1305
	 */
1306
	MemSet((char *) NewPage, 0, XLOG_BLCKSZ);
1307

1308 1309 1310
	/*
	 * Fill the new page's header
	 */
B
Bruce Momjian 已提交
1311 1312
	NewPage   ->xlp_magic = XLOG_PAGE_MAGIC;

1313
	/* NewPage->xlp_info = 0; */	/* done by memset */
B
Bruce Momjian 已提交
1314 1315
	NewPage   ->xlp_tli = ThisTimeLineID;
	NewPage   ->xlp_pageaddr.xlogid = NewPageEndPtr.xlogid;
1316
	NewPage   ->xlp_pageaddr.xrecoff = NewPageEndPtr.xrecoff - XLOG_BLCKSZ;
T
Tom Lane 已提交
1317

1318
	/*
1319
	 * If first page of an XLOG segment file, make it a long header.
1320 1321 1322
	 */
	if ((NewPage->xlp_pageaddr.xrecoff % XLogSegSize) == 0)
	{
1323
		XLogLongPageHeader NewLongPage = (XLogLongPageHeader) NewPage;
1324

1325 1326
		NewLongPage->xlp_sysid = ControlFile->system_identifier;
		NewLongPage->xlp_seg_size = XLogSegSize;
1327
		NewLongPage->xlp_xlog_blcksz = XLOG_BLCKSZ;
B
Bruce Momjian 已提交
1328 1329 1330
		NewPage   ->xlp_info |= XLP_LONG_HEADER;

		Insert->currpos = ((char *) NewPage) +SizeOfXLogLongPHD;
1331 1332
	}

T
Tom Lane 已提交
1333
	return update_needed;
1334 1335
}

1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
/*
 * Check whether we've consumed enough xlog space that a checkpoint is needed.
 *
 * Caller must have just finished filling the open log file (so that
 * openLogId/openLogSeg are valid).  We measure the distance from RedoRecPtr
 * to the open log file and see if that exceeds CheckPointSegments.
 *
 * Note: it is caller's responsibility that RedoRecPtr is up-to-date.
 */
static bool
XLogCheckpointNeeded(void)
{
	/*
1349 1350
	 * A straight computation of segment number could overflow 32 bits. Rather
	 * than assuming we have working 64-bit arithmetic, we compare the
B
Bruce Momjian 已提交
1351 1352
	 * highest-order bits separately, and force a checkpoint immediately when
	 * they change.
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
	 */
	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 ||
B
Bruce Momjian 已提交
1365
		new_segno >= old_segno + (uint32) (CheckPointSegments - 1))
1366 1367 1368 1369
		return true;
	return false;
}

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

1399 1400 1401
	/* We should always be inside a critical section here */
	Assert(CritSectionCount > 0);

B
Bruce Momjian 已提交
1402
	/*
B
Bruce Momjian 已提交
1403
	 * Update local LogwrtResult (caller probably did this already, but...)
B
Bruce Momjian 已提交
1404
	 */
T
Tom Lane 已提交
1405 1406
	LogwrtResult = Write->LogwrtResult;

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

T
Tom Lane 已提交
1429
	while (XLByteLT(LogwrtResult.Write, WriteRqst.Write))
1430
	{
1431
		/*
B
Bruce Momjian 已提交
1432 1433 1434
		 * 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.
1435
		 */
1436
		if (!XLByteLT(LogwrtResult.Write, XLogCtl->xlblocks[curridx]))
1437
			elog(PANIC, "xlog write request %X/%X is past end of log %X/%X",
1438
				 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
1439 1440
				 XLogCtl->xlblocks[curridx].xlogid,
				 XLogCtl->xlblocks[curridx].xrecoff);
1441

T
Tom Lane 已提交
1442
		/* Advance LogwrtResult.Write to end of current buffer page */
1443
		LogwrtResult.Write = XLogCtl->xlblocks[curridx];
T
Tom Lane 已提交
1444 1445 1446
		ispartialpage = XLByteLT(WriteRqst.Write, LogwrtResult.Write);

		if (!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1447
		{
T
Tom Lane 已提交
1448
			/*
1449 1450
			 * Switch to new logfile segment.  We cannot have any pending
			 * pages here (since we dump what we have at segment end).
T
Tom Lane 已提交
1451
			 */
1452
			Assert(npages == 0);
T
Tom Lane 已提交
1453
			if (openLogFile >= 0)
1454
				XLogFileClose();
T
Tom Lane 已提交
1455 1456
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);

1457 1458 1459 1460
			/* create/use new log file */
			use_existent = true;
			openLogFile = XLogFileInit(openLogId, openLogSeg,
									   &use_existent, true);
T
Tom Lane 已提交
1461
			openLogOff = 0;
1462 1463
		}

1464
		/* Make sure we have the current logfile open */
T
Tom Lane 已提交
1465
		if (openLogFile < 0)
1466
		{
T
Tom Lane 已提交
1467
			XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1468
			openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
1469
			openLogOff = 0;
1470 1471
		}

1472 1473 1474 1475 1476
		/* Add current page to the set of pending pages-to-dump */
		if (npages == 0)
		{
			/* first of group */
			startidx = curridx;
1477
			startoffset = (LogwrtResult.Write.xrecoff - XLOG_BLCKSZ) % XLogSegSize;
1478 1479
		}
		npages++;
1480

T
Tom Lane 已提交
1481
		/*
B
Bruce Momjian 已提交
1482 1483 1484 1485
		 * 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 已提交
1486
		 */
1487 1488
		last_iteration = !XLByteLT(LogwrtResult.Write, WriteRqst.Write);

1489
		finishing_seg = !ispartialpage &&
1490
			(startoffset + npages * XLOG_BLCKSZ) >= XLogSegSize;
1491

1492
		if (last_iteration ||
1493 1494
			curridx == XLogCtl->XLogCacheBlck ||
			finishing_seg)
T
Tom Lane 已提交
1495
		{
1496 1497
			char	   *from;
			Size		nbytes;
1498

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

				if (XLogArchivingActive())
					XLogArchiveNotifySeg(openLogId, openLogSeg);
1556 1557

				Write->lastSegSwitchTime = time(NULL);
1558 1559

				/*
1560
				 * Signal bgwriter to start a checkpoint if we've consumed too
1561
				 * much xlog since the last one.  For speed, we first check
B
Bruce Momjian 已提交
1562 1563 1564
				 * using the local copy of RedoRecPtr, which might be out of
				 * date; if it looks like a checkpoint is needed, forcibly
				 * update RedoRecPtr and recheck.
1565
				 */
1566 1567
				if (IsUnderPostmaster &&
					XLogCheckpointNeeded())
1568
				{
1569 1570
					(void) GetRedoRecPtr();
					if (XLogCheckpointNeeded())
1571
						RequestCheckpoint(CHECKPOINT_CAUSE_XLOG);
1572
				}
1573
			}
T
Tom Lane 已提交
1574
		}
1575

T
Tom Lane 已提交
1576 1577 1578 1579 1580 1581
		if (ispartialpage)
		{
			/* Only asked to write a partial page */
			LogwrtResult.Write = WriteRqst.Write;
			break;
		}
1582 1583 1584 1585 1586
		curridx = NextBufIdx(curridx);

		/* If flexible, break out of loop as soon as we wrote something */
		if (flexible && npages == 0)
			break;
1587
	}
1588 1589 1590

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

T
Tom Lane 已提交
1592 1593 1594 1595 1596
	/*
	 * If asked to flush, do so
	 */
	if (XLByteLT(LogwrtResult.Flush, WriteRqst.Flush) &&
		XLByteLT(LogwrtResult.Flush, LogwrtResult.Write))
1597
	{
T
Tom Lane 已提交
1598
		/*
B
Bruce Momjian 已提交
1599 1600 1601
		 * 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 已提交
1602
		 */
1603
		if (sync_method != SYNC_METHOD_OPEN)
T
Tom Lane 已提交
1604
		{
1605
			if (openLogFile >= 0 &&
B
Bruce Momjian 已提交
1606
				!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
1607
				XLogFileClose();
1608 1609 1610
			if (openLogFile < 0)
			{
				XLByteToPrevSeg(LogwrtResult.Write, openLogId, openLogSeg);
1611
				openLogFile = XLogFileOpen(openLogId, openLogSeg);
1612 1613 1614
				openLogOff = 0;
			}
			issue_xlog_fsync();
T
Tom Lane 已提交
1615 1616
		}
		LogwrtResult.Flush = LogwrtResult.Write;
1617 1618
	}

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

1630
		SpinLockAcquire(&xlogctl->info_lck);
1631 1632 1633 1634 1635
		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;
1636
		SpinLockRelease(&xlogctl->info_lck);
1637
	}
1638

T
Tom Lane 已提交
1639 1640 1641
	Write->LogwrtResult = LogwrtResult;
}

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

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

T
Tom Lane 已提交
1658 1659 1660
/*
 * Ensure that all XLOG data through the given position is flushed to disk.
 *
1661
 * NOTE: this differs from XLogWrite mainly in that the WALWriteLock is not
T
Tom Lane 已提交
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
 * 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;

1678
#ifdef WAL_DEBUG
1679
	if (XLOG_DEBUG)
1680
		elog(LOG, "xlog flush request %X/%X; write %X/%X; flush %X/%X",
1681 1682 1683
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Write.xlogid, LogwrtResult.Write.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1684
#endif
1685

T
Tom Lane 已提交
1686 1687 1688 1689
	START_CRIT_SECTION();

	/*
	 * Since fsync is usually a horribly expensive operation, we try to
B
Bruce Momjian 已提交
1690 1691 1692 1693
	 * 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 已提交
1694 1695 1696 1697 1698
	 */

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

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

1704
		SpinLockAcquire(&xlogctl->info_lck);
1705 1706 1707
		if (XLByteLT(WriteRqstPtr, xlogctl->LogwrtRqst.Write))
			WriteRqstPtr = xlogctl->LogwrtRqst.Write;
		LogwrtResult = xlogctl->LogwrtResult;
1708
		SpinLockRelease(&xlogctl->info_lck);
1709
	}
1710 1711 1712

	/* done already? */
	if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1713
	{
1714 1715 1716 1717
		/* now wait for the write lock */
		LWLockAcquire(WALWriteLock, LW_EXCLUSIVE);
		LogwrtResult = XLogCtl->Write.LogwrtResult;
		if (!XLByteLE(record, LogwrtResult.Flush))
T
Tom Lane 已提交
1718
		{
1719 1720 1721 1722 1723 1724
			/* 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 已提交
1725
				if (freespace < SizeOfXLogRecord)		/* buffer is full */
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
					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;
			}
1741
			XLogWrite(WriteRqst, false, false);
T
Tom Lane 已提交
1742
		}
1743
		LWLockRelease(WALWriteLock);
T
Tom Lane 已提交
1744 1745 1746
	}

	END_CRIT_SECTION();
1747 1748 1749

	/*
	 * If we still haven't flushed to the request point then we have a
B
Bruce Momjian 已提交
1750 1751
	 * 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.
1752
	 *
1753 1754 1755 1756 1757 1758 1759 1760 1761
	 * 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.)
1762
	 *
1763 1764 1765 1766
	 * 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 已提交
1767 1768
	 * 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.
1769 1770
	 */
	if (XLByteLT(LogwrtResult.Flush, record))
B
Bruce Momjian 已提交
1771
		elog(InRecovery ? WARNING : ERROR,
B
Bruce Momjian 已提交
1772
		"xlog flush request %X/%X is not satisfied --- flushed only to %X/%X",
1773 1774
			 record.xlogid, record.xrecoff,
			 LogwrtResult.Flush.xlogid, LogwrtResult.Flush.xrecoff);
1775 1776
}

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

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

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

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

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

1818
		SpinLockAcquire(&xlogctl->info_lck);
1819
		WriteRqstPtr = xlogctl->asyncCommitLSN;
1820
		SpinLockRelease(&xlogctl->info_lck);
1821 1822 1823
		flexible = false;		/* ensure it all gets written */
	}

1824 1825 1826 1827 1828
	/*
	 * If already known flushed, we're done. Just need to check if we
	 * are holding an open file handle to a logfile that's no longer
	 * in use, preventing the file from being deleted.
	 */
1829
	if (XLByteLE(WriteRqstPtr, LogwrtResult.Flush))
1830 1831 1832 1833 1834 1835 1836
	{
		if (openLogFile >= 0) {
			if (!XLByteInPrevSeg(LogwrtResult.Write, openLogId, openLogSeg))
			{
				XLogFileClose();
			}
		}
1837
		return;
1838
	}
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865

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

	START_CRIT_SECTION();

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

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

	END_CRIT_SECTION();
}

1866 1867
/*
 * Flush any previous asynchronously-committed transactions' commit records.
1868 1869 1870 1871
 *
 * NOTE: it is unwise to assume that this provides any strong guarantees.
 * In particular, because of the inexact LSN bookkeeping used by clog.c,
 * we cannot assume that hint bits will be settable for these transactions.
1872 1873 1874 1875 1876
 */
void
XLogAsyncCommitFlush(void)
{
	XLogRecPtr	WriteRqstPtr;
B
Bruce Momjian 已提交
1877

1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;

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

	XLogFlush(WriteRqstPtr);
}

1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
/*
 * Test whether XLOG data has been flushed up to (at least) the given position.
 *
 * Returns true if a flush is still needed.  (It may be that someone else
 * is already in process of flushing that far, however.)
 */
bool
XLogNeedsFlush(XLogRecPtr record)
{
	/* Quick exit if already known flushed */
	if (XLByteLE(record, LogwrtResult.Flush))
		return false;

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

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

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

	return true;
}

T
Tom Lane 已提交
1918 1919 1920
/*
 * Create a new XLOG file segment, or open a pre-existing one.
 *
1921 1922 1923
 * log, seg: identify segment to be created/opened.
 *
 * *use_existent: if TRUE, OK to use a pre-existing file (else, any
B
Bruce Momjian 已提交
1924
 * pre-existing file will be deleted).	On return, TRUE if a pre-existing
1925 1926
 * file was used.
 *
1927
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
1928
 * place.  This should be TRUE except during bootstrap log creation.  The
1929
 * caller must *not* hold the lock at call.
1930
 *
T
Tom Lane 已提交
1931
 * Returns FD of opened file.
1932 1933 1934 1935 1936
 *
 * 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 已提交
1937
 */
1938
static int
1939 1940
XLogFileInit(uint32 log, uint32 seg,
			 bool *use_existent, bool use_lock)
1941
{
1942
	char		path[MAXPGPATH];
1943
	char		tmppath[MAXPGPATH];
1944
	char	   *zbuffer;
1945 1946 1947
	uint32		installed_log;
	uint32		installed_seg;
	int			max_advance;
1948
	int			fd;
1949
	int			nbytes;
1950

1951
	XLogFilePath(path, ThisTimeLineID, log, seg);
V
Vadim B. Mikheev 已提交
1952 1953

	/*
B
Bruce Momjian 已提交
1954
	 * Try to use existent file (checkpoint maker may have created it already)
V
Vadim B. Mikheev 已提交
1955
	 */
1956
	if (*use_existent)
V
Vadim B. Mikheev 已提交
1957
	{
1958 1959
		fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
						   S_IRUSR | S_IWUSR);
V
Vadim B. Mikheev 已提交
1960 1961 1962
		if (fd < 0)
		{
			if (errno != ENOENT)
1963
				ereport(ERROR,
1964
						(errcode_for_file_access(),
1965
						 errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
1966
								path, log, seg)));
V
Vadim B. Mikheev 已提交
1967 1968
		}
		else
1969
			return fd;
V
Vadim B. Mikheev 已提交
1970 1971
	}

1972
	/*
B
Bruce Momjian 已提交
1973 1974 1975 1976
	 * 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.
1977
	 */
1978 1979
	elog(DEBUG2, "creating and filling new WAL file");

1980
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
1981 1982

	unlink(tmppath);
1983

1984
	/* do not use XLOG_SYNC_BIT here --- want to fsync only at end of fill */
1985
	fd = BasicOpenFile(tmppath, O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
T
Tom Lane 已提交
1986
					   S_IRUSR | S_IWUSR);
1987
	if (fd < 0)
1988
		ereport(ERROR,
1989
				(errcode_for_file_access(),
1990
				 errmsg("could not create file \"%s\": %m", tmppath)));
1991

1992
	/*
B
Bruce Momjian 已提交
1993 1994 1995 1996 1997 1998 1999
	 * 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.
2000 2001 2002 2003
	 *
	 * Note: palloc zbuffer, instead of just using a local char array, to
	 * ensure it is reasonably well-aligned; this may save a few cycles
	 * transferring data to the kernel.
2004
	 */
2005 2006
	zbuffer = (char *) palloc0(XLOG_BLCKSZ);
	for (nbytes = 0; nbytes < XLogSegSize; nbytes += XLOG_BLCKSZ)
2007
	{
2008
		errno = 0;
2009
		if ((int) write(fd, zbuffer, XLOG_BLCKSZ) != (int) XLOG_BLCKSZ)
T
Tom Lane 已提交
2010
		{
B
Bruce Momjian 已提交
2011
			int			save_errno = errno;
T
Tom Lane 已提交
2012

B
Bruce Momjian 已提交
2013
			/*
B
Bruce Momjian 已提交
2014
			 * If we fail to make the file, delete it to release disk space
B
Bruce Momjian 已提交
2015
			 */
2016
			unlink(tmppath);
2017 2018
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;
T
Tom Lane 已提交
2019

2020
			ereport(ERROR,
2021
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2022
					 errmsg("could not write to file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
2023
		}
2024
	}
2025
	pfree(zbuffer);
2026

2027
	if (pg_fsync(fd) != 0)
2028
		ereport(ERROR,
2029
				(errcode_for_file_access(),
2030
				 errmsg("could not fsync file \"%s\": %m", tmppath)));
2031

2032
	if (close(fd))
2033
		ereport(ERROR,
2034 2035
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));
T
Tom Lane 已提交
2036

2037
	/*
2038 2039
	 * Now move the segment into place with its final name.
	 *
2040
	 * If caller didn't want to use a pre-existing file, get rid of any
B
Bruce Momjian 已提交
2041 2042 2043
	 * 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.
2044
	 */
2045 2046 2047 2048 2049
	installed_log = log;
	installed_seg = seg;
	max_advance = XLOGfileslop;
	if (!InstallXLogFileSegment(&installed_log, &installed_seg, tmppath,
								*use_existent, &max_advance,
2050 2051
								use_lock))
	{
2052 2053 2054 2055 2056
		/*
		 * No need for any more future segments, or InstallXLogFileSegment()
		 * failed to rename the file into place. If the rename failed, opening
		 * the file below will fail.
		 */
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
		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)
2067
		ereport(ERROR,
2068
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2069 2070
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2071

2072 2073
	elog(DEBUG2, "done creating and filling new WAL file");

2074
	return fd;
2075 2076
}

2077 2078 2079 2080 2081 2082 2083 2084 2085
/*
 * 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 已提交
2086
 * considerations.	But we should be just as tense as XLogFileInit to avoid
2087 2088 2089 2090 2091 2092 2093 2094
 * emplacing a bogus file.
 */
static void
XLogFileCopy(uint32 log, uint32 seg,
			 TimeLineID srcTLI, uint32 srclog, uint32 srcseg)
{
	char		path[MAXPGPATH];
	char		tmppath[MAXPGPATH];
2095
	char		buffer[XLOG_BLCKSZ];
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105
	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)
2106
		ereport(ERROR,
2107 2108 2109 2110 2111 2112
				(errcode_for_file_access(),
				 errmsg("could not open file \"%s\": %m", path)));

	/*
	 * Copy into a temp file name.
	 */
2113
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
2114 2115 2116 2117 2118 2119 2120

	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)
2121
		ereport(ERROR,
2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133
				(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)
2134
				ereport(ERROR,
2135 2136 2137
						(errcode_for_file_access(),
						 errmsg("could not read file \"%s\": %m", path)));
			else
2138
				ereport(ERROR,
B
Bruce Momjian 已提交
2139
						(errmsg("not enough data in file \"%s\"", path)));
2140 2141 2142 2143 2144 2145 2146
		}
		errno = 0;
		if ((int) write(fd, buffer, sizeof(buffer)) != (int) sizeof(buffer))
		{
			int			save_errno = errno;

			/*
B
Bruce Momjian 已提交
2147
			 * If we fail to make the file, delete it to release disk space
2148 2149 2150 2151 2152
			 */
			unlink(tmppath);
			/* if write didn't set errno, assume problem is no disk space */
			errno = save_errno ? save_errno : ENOSPC;

2153
			ereport(ERROR,
2154
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2155
					 errmsg("could not write to file \"%s\": %m", tmppath)));
2156 2157 2158 2159
		}
	}

	if (pg_fsync(fd) != 0)
2160
		ereport(ERROR,
2161 2162 2163 2164
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

	if (close(fd))
2165
		ereport(ERROR,
2166 2167 2168 2169 2170 2171 2172 2173
				(errcode_for_file_access(),
				 errmsg("could not close file \"%s\": %m", tmppath)));

	close(srcfd);

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

2178 2179 2180 2181 2182 2183
/*
 * 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.
 *
2184 2185 2186
 * *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.
2187 2188 2189 2190 2191 2192 2193
 *
 * 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.
 *
2194 2195 2196 2197
 * *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.)
2198
 *
2199
 * use_lock: if TRUE, acquire ControlFileLock while moving file into
2200
 * place.  This should be TRUE except during bootstrap log creation.  The
2201
 * caller must *not* hold the lock at call.
2202
 *
2203 2204 2205
 * Returns TRUE if the file was installed successfully.  FALSE indicates that
 * max_advance limit was exceeded, or an error occurred while renaming the
 * file into place.
2206 2207
 */
static bool
2208 2209
InstallXLogFileSegment(uint32 *log, uint32 *seg, char *tmppath,
					   bool find_free, int *max_advance,
2210 2211 2212
					   bool use_lock)
{
	char		path[MAXPGPATH];
2213
	struct stat stat_buf;
2214

2215
	XLogFilePath(path, ThisTimeLineID, *log, *seg);
2216 2217 2218 2219 2220

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

2223 2224 2225 2226 2227
	if (!find_free)
	{
		/* Force installation: get rid of any pre-existing segment file */
		unlink(path);
	}
2228 2229
	else
	{
2230
		/* Find a free slot to put it in */
2231
		while (stat(path, &stat_buf) == 0)
2232
		{
2233
			if (*max_advance <= 0)
2234 2235 2236
			{
				/* Failed to find a free slot within specified range */
				if (use_lock)
2237
					LWLockRelease(ControlFileLock);
2238 2239
				return false;
			}
2240 2241 2242
			NextLogSeg(*log, *seg);
			(*max_advance)--;
			XLogFilePath(path, ThisTimeLineID, *log, *seg);
2243 2244 2245 2246 2247 2248 2249
		}
	}

	/*
	 * 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.
2250
	 */
2251
#if HAVE_WORKING_LINK
2252
	if (link(tmppath, path) < 0)
2253 2254 2255 2256
	{
		if (use_lock)
			LWLockRelease(ControlFileLock);
		ereport(LOG,
2257
				(errcode_for_file_access(),
2258
				 errmsg("could not link file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2259
						tmppath, path, *log, *seg)));
2260 2261
		return false;
	}
2262
	unlink(tmppath);
2263
#else
2264
	if (rename(tmppath, path) < 0)
2265
	{
2266 2267 2268
		if (use_lock)
			LWLockRelease(ControlFileLock);
		ereport(LOG,
2269
				(errcode_for_file_access(),
2270
				 errmsg("could not rename file \"%s\" to \"%s\" (initialization of log file %u, segment %u): %m",
2271
						tmppath, path, *log, *seg)));
2272
		return false;
2273
	}
2274
#endif
V
Vadim B. Mikheev 已提交
2275

2276
	if (use_lock)
2277
		LWLockRelease(ControlFileLock);
2278

2279
	return true;
2280 2281
}

T
Tom Lane 已提交
2282
/*
2283
 * Open a pre-existing logfile segment for writing.
T
Tom Lane 已提交
2284
 */
2285
static int
2286
XLogFileOpen(uint32 log, uint32 seg)
2287
{
2288 2289
	char		path[MAXPGPATH];
	int			fd;
2290

2291
	XLogFilePath(path, ThisTimeLineID, log, seg);
2292

2293 2294
	fd = BasicOpenFile(path, O_RDWR | PG_BINARY | XLOG_SYNC_BIT,
					   S_IRUSR | S_IWUSR);
2295
	if (fd < 0)
2296 2297
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2298 2299
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311

	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];
2312
	char		activitymsg[MAXFNAMELEN + 16];
2313 2314
	ListCell   *cell;
	int			fd;
2315

2316
	/*
B
Bruce Momjian 已提交
2317 2318
	 * Loop looking for a suitable timeline ID: we might need to read any of
	 * the timelines listed in expectedTLIs.
2319
	 *
B
Bruce Momjian 已提交
2320
	 * We expect curFileTLI on entry to be the TLI of the preceding file in
B
Bruce Momjian 已提交
2321 2322 2323 2324
	 * 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.
2325
	 */
2326 2327 2328
	foreach(cell, expectedTLIs)
	{
		TimeLineID	tli = (TimeLineID) lfirst_int(cell);
2329

2330 2331 2332
		if (tli < curFileTLI)
			break;				/* don't bother looking at too-old TLIs */

2333 2334
		XLogFileName(xlogfname, tli, log, seg);

2335 2336
		if (InArchiveRecovery)
		{
2337 2338 2339 2340 2341
			/* Report recovery progress in PS display */
			snprintf(activitymsg, sizeof(activitymsg), "waiting for %s",
					 xlogfname);
			set_ps_display(activitymsg, false);

2342
			restoredFromArchive = RestoreArchivedFile(path, xlogfname,
2343 2344
													  "RECOVERYXLOG",
													  XLogSegSize);
2345 2346 2347 2348 2349 2350 2351 2352 2353
		}
		else
			XLogFilePath(path, tli, log, seg);

		fd = BasicOpenFile(path, O_RDONLY | PG_BINARY, 0);
		if (fd >= 0)
		{
			/* Success! */
			curFileTLI = tli;
2354 2355

			/* Report recovery progress in PS display */
2356 2357
			snprintf(activitymsg, sizeof(activitymsg), "recovering %s",
					 xlogfname);
2358 2359
			set_ps_display(activitymsg, false);

2360 2361 2362 2363 2364
			return fd;
		}
		if (errno != ENOENT)	/* unexpected failure? */
			ereport(PANIC,
					(errcode_for_file_access(),
B
Bruce Momjian 已提交
2365 2366
			errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				   path, log, seg)));
2367 2368 2369 2370 2371 2372 2373
	}

	/* 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 已提交
2374 2375
		   errmsg("could not open file \"%s\" (log file %u, segment %u): %m",
				  path, log, seg)));
2376
	return -1;
2377 2378
}

2379 2380 2381 2382 2383 2384 2385 2386
/*
 * Close the current logfile segment for writing.
 */
static void
XLogFileClose(void)
{
	Assert(openLogFile >= 0);

2387
	/*
B
Bruce Momjian 已提交
2388 2389 2390 2391 2392 2393
	 * 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.
2394 2395 2396
	 */
#ifdef NOT_USED

2397
	/*
2398
	 * WAL segment files will not be re-read in normal operation, so we advise
B
Bruce Momjian 已提交
2399
	 * OS to release any cached pages.	But do not do so if WAL archiving is
2400 2401 2402
	 * active, because archiver process could use the cache to read the WAL
	 * segment.
	 *
B
Bruce Momjian 已提交
2403 2404
	 * While O_DIRECT works for O_SYNC, posix_fadvise() works for fsync() and
	 * O_SYNC, and some platforms only have posix_fadvise().
2405
	 */
2406
#if defined(HAVE_DECL_POSIX_FADVISE) && defined(POSIX_FADV_DONTNEED)
2407 2408 2409
	if (!XLogArchivingActive())
		posix_fadvise(openLogFile, 0, 0, POSIX_FADV_DONTNEED);
#endif
B
Bruce Momjian 已提交
2410
#endif   /* NOT_USED */
2411

2412 2413
	if (close(openLogFile))
		ereport(PANIC,
B
Bruce Momjian 已提交
2414 2415 2416
				(errcode_for_file_access(),
				 errmsg("could not close log file %u, segment %u: %m",
						openLogId, openLogSeg)));
2417 2418 2419
	openLogFile = -1;
}

2420
/*
2421
 * Attempt to retrieve the specified file from off-line archival storage.
2422
 * If successful, fill "path" with its complete path (note that this will be
2423 2424
 * a temp file name that doesn't follow the normal naming convention), and
 * return TRUE.
2425
 *
2426 2427 2428
 * 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.
2429 2430 2431 2432
 *
 * 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.
2433
 */
2434 2435
static bool
RestoreArchivedFile(char *path, const char *xlogfname,
2436
					const char *recovername, off_t expectedSize)
2437
{
B
Bruce Momjian 已提交
2438 2439
	char		xlogpath[MAXPGPATH];
	char		xlogRestoreCmd[MAXPGPATH];
2440
	char		lastRestartPointFname[MAXPGPATH];
B
Bruce Momjian 已提交
2441 2442
	char	   *dp;
	char	   *endp;
2443
	const char *sp;
B
Bruce Momjian 已提交
2444
	int			rc;
2445
	bool		signaled;
2446
	struct stat stat_buf;
B
Bruce Momjian 已提交
2447 2448
	uint32		restartLog;
	uint32		restartSeg;
2449 2450

	/*
B
Bruce Momjian 已提交
2451 2452 2453 2454
	 * 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.
2455
	 *
B
Bruce Momjian 已提交
2456
	 * We could try to optimize this slightly by checking the local copy
B
Bruce Momjian 已提交
2457 2458 2459 2460
	 * 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.
2461
	 *
2462 2463 2464
	 * 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.
2465
	 *
2466 2467 2468 2469
	 * 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 已提交
2470 2471
	 * copy-from-archive filename is always the same, ensuring that we don't
	 * run out of disk space on long recoveries.
2472
	 */
2473
	snprintf(xlogpath, MAXPGPATH, XLOGDIR "/%s", recovername);
2474 2475

	/*
2476
	 * Make sure there is no existing file named recovername.
2477 2478 2479 2480 2481 2482
	 */
	if (stat(xlogpath, &stat_buf) != 0)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
2483
					 errmsg("could not stat file \"%s\": %m",
2484 2485 2486 2487 2488 2489 2490
							xlogpath)));
	}
	else
	{
		if (unlink(xlogpath) != 0)
			ereport(FATAL,
					(errcode_for_file_access(),
2491
					 errmsg("could not remove file \"%s\": %m",
2492 2493 2494
							xlogpath)));
	}

2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518
	/*
	 * Calculate the archive file cutoff point for use during log shipping
	 * replication. All files earlier than this point can be deleted
	 * from the archive, though there is no requirement to do so.
	 *
	 * We initialise this with the filename of an InvalidXLogRecPtr, which
	 * will prevent the deletion of any WAL files from the archive
	 * because of the alphabetic sorting property of WAL filenames. 
	 *
	 * Once we have successfully located the redo pointer of the checkpoint
	 * from which we start recovery we never request a file prior to the redo
	 * pointer of the last restartpoint. When redo begins we know that we
	 * have successfully located it, so there is no need for additional
	 * status flags to signify the point when we can begin deleting WAL files
	 * from the archive. 
	 */
	if (InRedo)
	{
		XLByteToSeg(ControlFile->checkPointCopy.redo,
					restartLog, restartSeg);
		XLogFileName(lastRestartPointFname,
					 ControlFile->checkPointCopy.ThisTimeLineID,
					 restartLog, restartSeg);
		/* we shouldn't need anything earlier than last restart point */
2519
		Assert(strcmp(lastRestartPointFname, xlogfname) <= 0);
2520 2521 2522 2523
	}
	else
		XLogFileName(lastRestartPointFname, 0, 0, 0);

2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
	/*
	 * 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':
2538
					/* %p: relative path of target file */
2539
					sp++;
B
Bruce Momjian 已提交
2540
					StrNCpy(dp, xlogpath, endp - dp);
2541
					make_native_path(dp);
2542 2543 2544 2545 2546
					dp += strlen(dp);
					break;
				case 'f':
					/* %f: filename of desired file */
					sp++;
B
Bruce Momjian 已提交
2547
					StrNCpy(dp, xlogfname, endp - dp);
2548 2549
					dp += strlen(dp);
					break;
2550 2551 2552 2553 2554 2555
				case 'r':
					/* %r: filename of last restartpoint */
					sp++;
					StrNCpy(dp, lastRestartPointFname, endp - dp);
					dp += strlen(dp);
					break;
2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577
				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 已提交
2578
			(errmsg_internal("executing restore command \"%s\"",
2579 2580 2581
							 xlogRestoreCmd)));

	/*
2582
	 * Copy xlog from archival storage to XLOGDIR
2583 2584 2585 2586
	 */
	rc = system(xlogRestoreCmd);
	if (rc == 0)
	{
2587 2588 2589 2590
		/*
		 * command apparently succeeded, but let's make sure the file is
		 * really there now and has the correct size.
		 *
2591 2592 2593 2594 2595
		 * 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 ...
2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619
		 */
		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 已提交
2620
						 errmsg("could not stat file \"%s\": %m",
2621
								xlogpath)));
2622 2623 2624 2625
		}
	}

	/*
2626
	 * Remember, we rollforward UNTIL the restore fails so failure here is
B
Bruce Momjian 已提交
2627
	 * just part of the process... that makes it difficult to determine
B
Bruce Momjian 已提交
2628 2629 2630
	 * 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.
2631 2632
	 *
	 * However, if the failure was due to any sort of signal, it's best to
B
Bruce Momjian 已提交
2633 2634 2635
	 * punt and abort recovery.  (If we "return false" here, upper levels will
	 * assume that recovery is complete and start up the database!) It's
	 * essential to abort on child SIGINT and SIGQUIT, because per spec
2636 2637 2638 2639
	 * system() ignores SIGINT and SIGQUIT while waiting; if we see one of
	 * those it's a good bet we should have gotten it too.  Aborting on other
	 * signals such as SIGTERM seems a good idea as well.
	 *
B
Bruce Momjian 已提交
2640 2641 2642 2643
	 * Per the Single Unix Spec, shells report exit status > 128 when a called
	 * command died on a signal.  Also, 126 and 127 are used to report
	 * problems such as an unfindable command; treat those as fatal errors
	 * too.
2644
	 */
2645 2646 2647
	signaled = WIFSIGNALED(rc) || WEXITSTATUS(rc) > 125;

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

	/*
B
Bruce Momjian 已提交
2652 2653
	 * 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.
2654
	 *
B
Bruce Momjian 已提交
2655 2656
	 * In many recovery scenarios we expect this to fail also, but if so that
	 * just means we've reached the end of WAL.
2657
	 */
2658
	snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlogfname);
2659
	return false;
2660 2661
}

V
Vadim B. Mikheev 已提交
2662
/*
2663 2664 2665 2666 2667 2668 2669 2670
 * Preallocate log files beyond the specified log endpoint.
 *
 * XXX this is currently extremely conservative, since it forces only one
 * future log segment to exist, and even that only if we are 75% done with
 * the current one.  This is only appropriate for very low-WAL-volume systems.
 * High-volume systems will be OK once they've built up a sufficient set of
 * recycled log segments, but the startup transient is likely to include
 * a lot of segment creations by foreground processes, which is not so good.
T
Tom Lane 已提交
2671
 */
2672
static void
T
Tom Lane 已提交
2673 2674 2675 2676 2677
PreallocXlogFiles(XLogRecPtr endptr)
{
	uint32		_logId;
	uint32		_logSeg;
	int			lf;
2678
	bool		use_existent;
T
Tom Lane 已提交
2679 2680

	XLByteToPrevSeg(endptr, _logId, _logSeg);
B
Bruce Momjian 已提交
2681
	if ((endptr.xrecoff - 1) % XLogSegSize >=
B
Bruce Momjian 已提交
2682
		(uint32) (0.75 * XLogSegSize))
T
Tom Lane 已提交
2683 2684
	{
		NextLogSeg(_logId, _logSeg);
2685 2686
		use_existent = true;
		lf = XLogFileInit(_logId, _logSeg, &use_existent, true);
T
Tom Lane 已提交
2687
		close(lf);
2688
		if (!use_existent)
2689
			CheckpointStats.ckpt_segs_added++;
T
Tom Lane 已提交
2690 2691 2692 2693
	}
}

/*
2694
 * Recycle or remove all log files older or equal to passed log/seg#
2695 2696 2697
 *
 * 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 已提交
2698 2699
 */
static void
2700
RemoveOldXlogFiles(uint32 log, uint32 seg, XLogRecPtr endptr)
V
Vadim B. Mikheev 已提交
2701
{
2702 2703
	uint32		endlogId;
	uint32		endlogSeg;
2704
	int			max_advance;
B
Bruce Momjian 已提交
2705 2706
	DIR		   *xldir;
	struct dirent *xlde;
2707
	char		lastoff[MAXFNAMELEN];
B
Bruce Momjian 已提交
2708
	char		path[MAXPGPATH];
2709 2710 2711
#ifdef WIN32
	char		newpath[MAXPGPATH];
#endif
2712
	struct stat statbuf;
V
Vadim B. Mikheev 已提交
2713

2714 2715 2716 2717
	/*
	 * Initialize info about where to try to recycle to.  We allow recycling
	 * segments up to XLOGfileslop segments beyond the current XLOG location.
	 */
2718
	XLByteToPrevSeg(endptr, endlogId, endlogSeg);
2719
	max_advance = XLOGfileslop;
V
Vadim B. Mikheev 已提交
2720

2721
	xldir = AllocateDir(XLOGDIR);
V
Vadim B. Mikheev 已提交
2722
	if (xldir == NULL)
2723
		ereport(ERROR,
2724
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2725 2726
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
V
Vadim B. Mikheev 已提交
2727

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

2730
	while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
V
Vadim B. Mikheev 已提交
2731
	{
2732
		/*
2733
		 * We ignore the timeline part of the XLOG segment identifiers in
B
Bruce Momjian 已提交
2734 2735 2736 2737 2738
		 * 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.
2739
		 *
B
Bruce Momjian 已提交
2740 2741
		 * We use the alphanumeric sorting property of the filenames to decide
		 * which ones are earlier than the lastoff segment.
2742
		 */
2743 2744 2745
		if (strlen(xlde->d_name) == 24 &&
			strspn(xlde->d_name, "0123456789ABCDEF") == 24 &&
			strcmp(xlde->d_name + 8, lastoff + 8) <= 0)
V
Vadim B. Mikheev 已提交
2746
		{
2747
			if (XLogArchiveCheckDone(xlde->d_name))
2748
			{
2749
				snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlde->d_name);
2750

2751
				/*
B
Bruce Momjian 已提交
2752
				 * Before deleting the file, see if it can be recycled as a
2753 2754 2755
				 * future log segment. Only recycle normal files, pg_standby
				 * for example can create symbolic links pointing to a
				 * separate archive directory.
2756
				 */
2757 2758 2759
				if (lstat(path, &statbuf) == 0 && S_ISREG(statbuf.st_mode) &&
					InstallXLogFileSegment(&endlogId, &endlogSeg, path,
										   true, &max_advance, true))
2760
				{
2761
					ereport(DEBUG2,
B
Bruce Momjian 已提交
2762 2763
							(errmsg("recycled transaction log file \"%s\"",
									xlde->d_name)));
2764
					CheckpointStats.ckpt_segs_recycled++;
2765 2766 2767 2768 2769 2770
					/* Needn't recheck that slot on future iterations */
					if (max_advance > 0)
					{
						NextLogSeg(endlogId, endlogSeg);
						max_advance--;
					}
2771 2772 2773 2774
				}
				else
				{
					/* No need for any more future segments... */
2775 2776
					int rc;

2777
					ereport(DEBUG2,
B
Bruce Momjian 已提交
2778 2779
							(errmsg("removing transaction log file \"%s\"",
									xlde->d_name)));
2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796

#ifdef WIN32
					/*
					 * On Windows, if another process (e.g another backend)
					 * holds the file open in FILE_SHARE_DELETE mode, unlink
					 * will succeed, but the file will still show up in
					 * directory listing until the last handle is closed.
					 * To avoid confusing the lingering deleted file for a
					 * live WAL file that needs to be archived, rename it
					 * before deleting it.
					 *
					 * If another process holds the file open without
					 * FILE_SHARE_DELETE flag, rename will fail. We'll try
					 * again at the next checkpoint.
					 */
					snprintf(newpath, MAXPGPATH, "%s.deleted", path);
					if (rename(path, newpath) != 0)
2797 2798
					{
						ereport(LOG,
2799
								(errcode_for_file_access(),
2800
								 errmsg("could not rename old transaction log file \"%s\": %m",
2801
										path)));
2802 2803
						continue;
					}
2804 2805 2806 2807 2808
					rc = unlink(newpath);
#else
					rc = unlink(path);
#endif
					if (rc != 0)
2809 2810
					{
						ereport(LOG,
2811 2812 2813
								(errcode_for_file_access(),
								 errmsg("could not remove old transaction log file \"%s\": %m",
										path)));
2814 2815
						continue;
					}
2816
					CheckpointStats.ckpt_segs_removed++;
2817
				}
2818 2819

				XLogArchiveCleanup(xlde->d_name);
2820
			}
V
Vadim B. Mikheev 已提交
2821 2822
		}
	}
B
Bruce Momjian 已提交
2823

2824
	FreeDir(xldir);
V
Vadim B. Mikheev 已提交
2825 2826
}

2827
/*
2828 2829 2830
 * Remove previous backup history files.  This also retries creation of
 * .ready files for any backup history files for which XLogArchiveNotify
 * failed earlier.
2831 2832
 */
static void
2833
CleanupBackupHistory(void)
2834 2835 2836 2837 2838
{
	DIR		   *xldir;
	struct dirent *xlde;
	char		path[MAXPGPATH];

2839
	xldir = AllocateDir(XLOGDIR);
2840 2841 2842
	if (xldir == NULL)
		ereport(ERROR,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
2843 2844
				 errmsg("could not open transaction log directory \"%s\": %m",
						XLOGDIR)));
2845

2846
	while ((xlde = ReadDir(xldir, XLOGDIR)) != NULL)
2847 2848 2849 2850 2851 2852
	{
		if (strlen(xlde->d_name) > 24 &&
			strspn(xlde->d_name, "0123456789ABCDEF") == 24 &&
			strcmp(xlde->d_name + strlen(xlde->d_name) - strlen(".backup"),
				   ".backup") == 0)
		{
2853
			if (XLogArchiveCheckDone(xlde->d_name))
2854 2855
			{
				ereport(DEBUG2,
B
Bruce Momjian 已提交
2856 2857
				(errmsg("removing transaction log backup history file \"%s\"",
						xlde->d_name)));
2858
				snprintf(path, MAXPGPATH, XLOGDIR "/%s", xlde->d_name);
2859 2860 2861 2862 2863 2864 2865 2866 2867
				unlink(path);
				XLogArchiveCleanup(xlde->d_name);
			}
		}
	}

	FreeDir(xldir);
}

T
Tom Lane 已提交
2868 2869 2870 2871
/*
 * Restore the backup blocks present in an XLOG record, if any.
 *
 * We assume all of the record has been read into memory at *record.
2872 2873 2874 2875 2876 2877 2878 2879 2880
 *
 * 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 已提交
2881
 */
2882 2883 2884 2885 2886 2887 2888 2889 2890 2891
static void
RestoreBkpBlocks(XLogRecord *record, XLogRecPtr lsn)
{
	Relation	reln;
	Buffer		buffer;
	Page		page;
	BkpBlock	bkpb;
	char	   *blk;
	int			i;

B
Bruce Momjian 已提交
2892
	blk = (char *) XLogRecGetData(record) + record->xl_len;
T
Tom Lane 已提交
2893
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2894
	{
T
Tom Lane 已提交
2895
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2896 2897
			continue;

2898
		memcpy(&bkpb, blk, sizeof(BkpBlock));
2899 2900
		blk += sizeof(BkpBlock);

2901
		reln = XLogOpenRelation(bkpb.node);
2902 2903 2904
		buffer = XLogReadBuffer(reln, bkpb.block, true);
		Assert(BufferIsValid(buffer));
		page = (Page) BufferGetPage(buffer);
2905

2906
		if (bkpb.hole_length == 0)
2907
		{
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917
			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));
2918 2919
		}

2920 2921
		PageSetLSN(page, lsn);
		PageSetTLI(page, ThisTimeLineID);
2922 2923
		MarkBufferDirty(buffer);
		UnlockReleaseBuffer(buffer);
2924

2925
		blk += BLCKSZ - bkpb.hole_length;
2926 2927 2928
	}
}

T
Tom Lane 已提交
2929 2930 2931 2932 2933 2934 2935
/*
 * 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.
 */
2936 2937 2938
static bool
RecordIsValid(XLogRecord *record, XLogRecPtr recptr, int emode)
{
2939
	pg_crc32	crc;
2940 2941
	int			i;
	uint32		len = record->xl_len;
2942
	BkpBlock	bkpb;
2943 2944
	char	   *blk;

2945 2946 2947
	/* First the rmgr data */
	INIT_CRC32(crc);
	COMP_CRC32(crc, XLogRecGetData(record), len);
2948

2949
	/* Add in the backup blocks, if any */
B
Bruce Momjian 已提交
2950
	blk = (char *) XLogRecGetData(record) + len;
T
Tom Lane 已提交
2951
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
2952
	{
B
Bruce Momjian 已提交
2953
		uint32		blen;
2954

T
Tom Lane 已提交
2955
		if (!(record->xl_info & XLR_SET_BKP_BLOCK(i)))
2956 2957
			continue;

2958 2959
		memcpy(&bkpb, blk, sizeof(BkpBlock));
		if (bkpb.hole_offset + bkpb.hole_length > BLCKSZ)
2960
		{
2961
			ereport(emode,
2962 2963 2964
					(errmsg("incorrect hole size in record at %X/%X",
							recptr.xlogid, recptr.xrecoff)));
			return false;
2965
		}
2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987
		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 已提交
2988 2989
		(errmsg("incorrect resource manager data checksum in record at %X/%X",
				recptr.xlogid, recptr.xrecoff)));
2990
		return false;
2991 2992
	}

2993
	return true;
2994 2995
}

T
Tom Lane 已提交
2996 2997 2998 2999 3000 3001
/*
 * 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.
 *
3002 3003
 * If no valid record is available, returns NULL, or fails if emode is PANIC.
 * (emode must be either PANIC or LOG.)
T
Tom Lane 已提交
3004
 *
3005 3006
 * The record is copied into readRecordBuf, so that on successful return,
 * the returned record pointer always points there.
T
Tom Lane 已提交
3007
 */
3008
static XLogRecord *
3009
ReadRecord(XLogRecPtr *RecPtr, int emode)
3010
{
3011
	XLogRecord *record;
3012
	char	   *buffer;
3013
	XLogRecPtr	tmpRecPtr = EndRecPtr;
3014
	bool		randAccess = false;
T
Tom Lane 已提交
3015 3016 3017
	uint32		len,
				total_len;
	uint32		targetPageOff;
3018 3019
	uint32		targetRecOff;
	uint32		pageHeaderSize;
T
Tom Lane 已提交
3020 3021 3022 3023

	if (readBuf == NULL)
	{
		/*
B
Bruce Momjian 已提交
3024 3025 3026 3027 3028
		 * 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 已提交
3029
		 */
3030
		readBuf = (char *) malloc(XLOG_BLCKSZ);
T
Tom Lane 已提交
3031 3032
		Assert(readBuf != NULL);
	}
3033

T
Tom Lane 已提交
3034
	if (RecPtr == NULL)
3035
	{
3036
		RecPtr = &tmpRecPtr;
T
Tom Lane 已提交
3037
		/* fast case if next record is on same page */
3038 3039 3040 3041 3042
		if (nextRecord != NULL)
		{
			record = nextRecord;
			goto got_record;
		}
T
Tom Lane 已提交
3043
		/* align old recptr to next page */
3044 3045
		if (tmpRecPtr.xrecoff % XLOG_BLCKSZ != 0)
			tmpRecPtr.xrecoff += (XLOG_BLCKSZ - tmpRecPtr.xrecoff % XLOG_BLCKSZ);
3046 3047 3048 3049 3050
		if (tmpRecPtr.xrecoff >= XLogFileSize)
		{
			(tmpRecPtr.xlogid)++;
			tmpRecPtr.xrecoff = 0;
		}
3051 3052 3053 3054 3055 3056 3057 3058
		/* 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 已提交
3059

3060
		/*
B
Bruce Momjian 已提交
3061 3062 3063 3064 3065
		 * 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).
3066 3067 3068
		 */
		lastPageTLI = 0;		/* see comment in ValidXLOGHeader */
		randAccess = true;		/* allow curFileTLI to go backwards too */
3069 3070
	}

T
Tom Lane 已提交
3071
	if (readFile >= 0 && !XLByteInSeg(*RecPtr, readId, readSeg))
3072
	{
3073 3074
		close(readFile);
		readFile = -1;
3075
	}
T
Tom Lane 已提交
3076
	XLByteToSeg(*RecPtr, readId, readSeg);
3077
	if (readFile < 0)
3078
	{
3079 3080 3081 3082 3083
		/* Now it's okay to reset curFileTLI if random fetch */
		if (randAccess)
			curFileTLI = 0;

		readFile = XLogFileRead(readId, readSeg, emode);
3084 3085
		if (readFile < 0)
			goto next_record_is_invalid;
3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104

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

3107
	targetPageOff = ((RecPtr->xrecoff % XLogSegSize) / XLOG_BLCKSZ) * XLOG_BLCKSZ;
T
Tom Lane 已提交
3108
	if (readOff != targetPageOff)
3109
	{
T
Tom Lane 已提交
3110 3111 3112
		readOff = targetPageOff;
		if (lseek(readFile, (off_t) readOff, SEEK_SET) < 0)
		{
3113 3114
			ereport(emode,
					(errcode_for_file_access(),
3115
					 errmsg("could not seek in log file %u, segment %u to offset %u: %m",
3116
							readId, readSeg, readOff)));
T
Tom Lane 已提交
3117 3118
			goto next_record_is_invalid;
		}
3119
		if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
T
Tom Lane 已提交
3120
		{
3121 3122
			ereport(emode,
					(errcode_for_file_access(),
3123
					 errmsg("could not read from log file %u, segment %u, offset %u: %m",
3124
							readId, readSeg, readOff)));
T
Tom Lane 已提交
3125 3126
			goto next_record_is_invalid;
		}
3127
		if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
3128 3129
			goto next_record_is_invalid;
	}
3130
	pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
3131
	targetRecOff = RecPtr->xrecoff % XLOG_BLCKSZ;
3132 3133 3134
	if (targetRecOff == 0)
	{
		/*
B
Bruce Momjian 已提交
3135 3136 3137
		 * 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.
3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148
		 */
		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 已提交
3149
	if ((((XLogPageHeader) readBuf)->xlp_info & XLP_FIRST_IS_CONTRECORD) &&
3150
		targetRecOff == pageHeaderSize)
3151
	{
3152 3153 3154
		ereport(emode,
				(errmsg("contrecord is requested by %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
3155 3156
		goto next_record_is_invalid;
	}
3157
	record = (XLogRecord *) ((char *) readBuf + RecPtr->xrecoff % XLOG_BLCKSZ);
3158 3159

got_record:;
B
Bruce Momjian 已提交
3160

T
Tom Lane 已提交
3161
	/*
B
Bruce Momjian 已提交
3162 3163
	 * xl_len == 0 is bad data for everything except XLOG SWITCH, where it is
	 * required.
T
Tom Lane 已提交
3164
	 */
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175
	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)
3176
	{
3177 3178 3179
		ereport(emode,
				(errmsg("record with zero length at %X/%X",
						RecPtr->xlogid, RecPtr->xrecoff)));
3180 3181
		goto next_record_is_invalid;
	}
3182 3183 3184 3185 3186 3187 3188 3189 3190
	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;
	}
3191 3192 3193 3194
	if (record->xl_rmid > RM_MAX_ID)
	{
		ereport(emode,
				(errmsg("invalid resource manager ID %u at %X/%X",
B
Bruce Momjian 已提交
3195
						record->xl_rmid, RecPtr->xlogid, RecPtr->xrecoff)));
3196 3197
		goto next_record_is_invalid;
	}
3198 3199 3200
	if (randAccess)
	{
		/*
B
Bruce Momjian 已提交
3201 3202
		 * We can't exactly verify the prev-link, but surely it should be less
		 * than the record's own address.
3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215
		 */
		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 已提交
3216 3217 3218
		 * 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.
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228
		 */
		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 已提交
3229

T
Tom Lane 已提交
3230
	/*
B
Bruce Momjian 已提交
3231
	 * Allocate or enlarge readRecordBuf as needed.  To avoid useless small
3232 3233 3234 3235
	 * 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 已提交
3236
	 */
3237
	total_len = record->xl_tot_len;
3238
	if (total_len > readRecordBufSize)
3239
	{
3240 3241
		uint32		newSize = total_len;

3242 3243
		newSize += XLOG_BLCKSZ - (newSize % XLOG_BLCKSZ);
		newSize = Max(newSize, 4 * Max(BLCKSZ, XLOG_BLCKSZ));
3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256
		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;
3257
	}
3258 3259

	buffer = readRecordBuf;
3260
	nextRecord = NULL;
3261
	len = XLOG_BLCKSZ - RecPtr->xrecoff % XLOG_BLCKSZ;
T
Tom Lane 已提交
3262
	if (total_len > len)
3263
	{
T
Tom Lane 已提交
3264 3265
		/* Need to reassemble record */
		XLogContRecord *contrecord;
B
Bruce Momjian 已提交
3266
		uint32		gotlen = len;
3267

T
Tom Lane 已提交
3268
		memcpy(buffer, record, len);
3269
		record = (XLogRecord *) buffer;
T
Tom Lane 已提交
3270
		buffer += len;
3271
		for (;;)
3272
		{
3273
			readOff += XLOG_BLCKSZ;
T
Tom Lane 已提交
3274
			if (readOff >= XLogSegSize)
3275 3276
			{
				close(readFile);
T
Tom Lane 已提交
3277 3278
				readFile = -1;
				NextLogSeg(readId, readSeg);
3279
				readFile = XLogFileRead(readId, readSeg, emode);
3280 3281
				if (readFile < 0)
					goto next_record_is_invalid;
T
Tom Lane 已提交
3282
				readOff = 0;
3283
			}
3284
			if (read(readFile, readBuf, XLOG_BLCKSZ) != XLOG_BLCKSZ)
T
Tom Lane 已提交
3285
			{
3286 3287
				ereport(emode,
						(errcode_for_file_access(),
T
Tom Lane 已提交
3288
						 errmsg("could not read from log file %u, segment %u, offset %u: %m",
3289
								readId, readSeg, readOff)));
T
Tom Lane 已提交
3290 3291
				goto next_record_is_invalid;
			}
3292
			if (!ValidXLOGHeader((XLogPageHeader) readBuf, emode))
3293
				goto next_record_is_invalid;
T
Tom Lane 已提交
3294
			if (!(((XLogPageHeader) readBuf)->xlp_info & XLP_FIRST_IS_CONTRECORD))
3295
			{
3296 3297 3298
				ereport(emode,
						(errmsg("there is no contrecord flag in log file %u, segment %u, offset %u",
								readId, readSeg, readOff)));
3299 3300
				goto next_record_is_invalid;
			}
3301 3302
			pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
			contrecord = (XLogContRecord *) ((char *) readBuf + pageHeaderSize);
B
Bruce Momjian 已提交
3303
			if (contrecord->xl_rem_len == 0 ||
T
Tom Lane 已提交
3304
				total_len != (contrecord->xl_rem_len + gotlen))
3305
			{
3306 3307 3308 3309
				ereport(emode,
						(errmsg("invalid contrecord length %u in log file %u, segment %u, offset %u",
								contrecord->xl_rem_len,
								readId, readSeg, readOff)));
3310 3311
				goto next_record_is_invalid;
			}
3312
			len = XLOG_BLCKSZ - pageHeaderSize - SizeOfXLogContRecord;
T
Tom Lane 已提交
3313
			if (contrecord->xl_rem_len > len)
3314
			{
B
Bruce Momjian 已提交
3315
				memcpy(buffer, (char *) contrecord + SizeOfXLogContRecord, len);
T
Tom Lane 已提交
3316 3317 3318 3319 3320 3321 3322 3323 3324 3325
				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;
3326
		pageHeaderSize = XLogPageHeaderSize((XLogPageHeader) readBuf);
3327
		if (XLOG_BLCKSZ - SizeOfXLogRecord >= pageHeaderSize +
3328
			MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len))
T
Tom Lane 已提交
3329
		{
B
Bruce Momjian 已提交
3330
			nextRecord = (XLogRecord *) ((char *) contrecord +
B
Bruce Momjian 已提交
3331
					MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len));
T
Tom Lane 已提交
3332 3333 3334
		}
		EndRecPtr.xlogid = readId;
		EndRecPtr.xrecoff = readSeg * XLogSegSize + readOff +
3335 3336
			pageHeaderSize +
			MAXALIGN(SizeOfXLogContRecord + contrecord->xl_rem_len);
T
Tom Lane 已提交
3337
		ReadRecPtr = *RecPtr;
3338
		/* needn't worry about XLOG SWITCH, it can't cross page boundaries */
T
Tom Lane 已提交
3339
		return record;
3340 3341
	}

T
Tom Lane 已提交
3342 3343 3344
	/* Record does not cross a page boundary */
	if (!RecordIsValid(record, *RecPtr, emode))
		goto next_record_is_invalid;
3345
	if (XLOG_BLCKSZ - SizeOfXLogRecord >= RecPtr->xrecoff % XLOG_BLCKSZ +
T
Tom Lane 已提交
3346 3347 3348 3349 3350 3351
		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 已提交
3352

3353 3354 3355 3356 3357 3358 3359 3360 3361
	/*
	 * 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 已提交
3362

3363
		/*
B
Bruce Momjian 已提交
3364 3365 3366
		 * 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.
3367 3368 3369
		 */
		readOff = XLogSegSize - XLOG_BLCKSZ;
	}
T
Tom Lane 已提交
3370
	return (XLogRecord *) buffer;
3371

T
Tom Lane 已提交
3372
next_record_is_invalid:;
3373 3374 3375 3376 3377
	if (readFile >= 0)
	{
		close(readFile);
		readFile = -1;
	}
T
Tom Lane 已提交
3378 3379
	nextRecord = NULL;
	return NULL;
3380 3381
}

3382 3383 3384 3385
/*
 * 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 已提交
3386
 * ReadRecord.	It's not intended for use from anywhere else.
3387 3388
 */
static bool
3389
ValidXLOGHeader(XLogPageHeader hdr, int emode)
3390
{
3391 3392
	XLogRecPtr	recaddr;

3393 3394
	if (hdr->xlp_magic != XLOG_PAGE_MAGIC)
	{
3395 3396 3397
		ereport(emode,
				(errmsg("invalid magic number %04X in log file %u, segment %u, offset %u",
						hdr->xlp_magic, readId, readSeg, readOff)));
3398 3399 3400 3401
		return false;
	}
	if ((hdr->xlp_info & ~XLP_ALL_FLAGS) != 0)
	{
3402 3403 3404
		ereport(emode,
				(errmsg("invalid info bits %04X in log file %u, segment %u, offset %u",
						hdr->xlp_info, readId, readSeg, readOff)));
3405 3406
		return false;
	}
3407
	if (hdr->xlp_info & XLP_LONG_HEADER)
3408
	{
3409
		XLogLongPageHeader longhdr = (XLogLongPageHeader) hdr;
B
Bruce Momjian 已提交
3410

3411
		if (longhdr->xlp_sysid != ControlFile->system_identifier)
3412
		{
3413 3414
			char		fhdrident_str[32];
			char		sysident_str[32];
3415

3416
			/*
B
Bruce Momjian 已提交
3417 3418
			 * Format sysids separately to keep platform-dependent format code
			 * out of the translatable message string.
3419 3420 3421 3422 3423 3424 3425
			 */
			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 已提交
3426 3427
					 errdetail("WAL file SYSID is %s, pg_control SYSID is %s",
							   fhdrident_str, sysident_str)));
3428 3429 3430 3431 3432 3433
			return false;
		}
		if (longhdr->xlp_seg_size != XLogSegSize)
		{
			ereport(emode,
					(errmsg("WAL file is from different system"),
B
Bruce Momjian 已提交
3434
					 errdetail("Incorrect XLOG_SEG_SIZE in page header.")));
3435 3436
			return false;
		}
3437 3438 3439 3440 3441 3442 3443
		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;
		}
3444
	}
3445 3446 3447 3448 3449 3450 3451 3452 3453
	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;
	}

3454 3455 3456 3457 3458 3459
	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 已提交
3460
						hdr->xlp_pageaddr.xlogid, hdr->xlp_pageaddr.xrecoff,
3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481
						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 已提交
3482 3483 3484
	 * 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.
3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501
	 */
	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 已提交
3502
 * its ancestor TLIs).	If we can't find the history file, assume that the
3503 3504 3505 3506 3507 3508 3509 3510 3511 3512
 * 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 已提交
3513
	FILE	   *fd;
3514 3515 3516 3517

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, targetTLI);
3518
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3519 3520 3521 3522
	}
	else
		TLHistoryFilePath(path, targetTLI);

B
Bruce Momjian 已提交
3523
	fd = AllocateFile(path, "r");
3524 3525 3526 3527 3528
	if (fd == NULL)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3529
					 errmsg("could not open file \"%s\": %m", path)));
3530 3531 3532 3533 3534 3535
		/* Not there, so assume no parents */
		return list_make1_int((int) targetTLI);
	}

	result = NIL;

B
Bruce Momjian 已提交
3536 3537 3538
	/*
	 * Parse the file...
	 */
3539
	while (fgets(fline, sizeof(fline), fd) != NULL)
3540 3541
	{
		/* skip leading whitespace and check for # comment */
B
Bruce Momjian 已提交
3542 3543 3544
		char	   *ptr;
		char	   *endptr;
		TimeLineID	tli;
3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564

		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 已提交
3565
				   errhint("Timeline IDs must be in increasing sequence.")));
3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578

		/* 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 已提交
3579
			errhint("Timeline IDs must be less than child timeline's ID.")));
3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597

	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 已提交
3598
	FILE	   *fd;
3599 3600 3601 3602

	if (InArchiveRecovery)
	{
		TLHistoryFileName(histfname, probeTLI);
3603
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618
	}
	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 已提交
3619
					 errmsg("could not open file \"%s\": %m", path)));
3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637
		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 已提交
3638 3639
	 * The algorithm is just to probe for the existence of timeline history
	 * files.  XXX is it useful to allow gaps in the sequence?
3640 3641 3642
	 */
	newestTLI = startTLI;

B
Bruce Momjian 已提交
3643
	for (probeTLI = startTLI + 1;; probeTLI++)
3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666
	{
		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 已提交
3667
 * considerations.	But we should be just as tense as XLogFileInit to avoid
3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682
 * 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 已提交
3683
	Assert(newTLI > parentTLI); /* else bad selection of newTLI */
3684 3685 3686 3687

	/*
	 * Write into a temp file name.
	 */
3688
	snprintf(tmppath, MAXPGPATH, XLOGDIR "/xlogtemp.%d", (int) getpid());
3689 3690 3691 3692 3693 3694 3695

	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)
3696
		ereport(ERROR,
3697 3698 3699 3700 3701 3702 3703 3704 3705
				(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);
3706
		RestoreArchivedFile(path, histfname, "RECOVERYHISTORY", 0);
3707 3708 3709 3710 3711 3712 3713 3714
	}
	else
		TLHistoryFilePath(path, parentTLI);

	srcfd = BasicOpenFile(path, O_RDONLY, 0);
	if (srcfd < 0)
	{
		if (errno != ENOENT)
3715
			ereport(ERROR,
3716
					(errcode_for_file_access(),
P
Peter Eisentraut 已提交
3717
					 errmsg("could not open file \"%s\": %m", path)));
3718 3719 3720 3721 3722 3723 3724 3725 3726
		/* Not there, so assume parent has no parents */
	}
	else
	{
		for (;;)
		{
			errno = 0;
			nbytes = (int) read(srcfd, buffer, sizeof(buffer));
			if (nbytes < 0 || errno != 0)
3727
				ereport(ERROR,
3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
						(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 已提交
3742 3743

				/*
B
Bruce Momjian 已提交
3744
				 * if write didn't set errno, assume problem is no disk space
B
Bruce Momjian 已提交
3745
				 */
3746 3747
				errno = save_errno ? save_errno : ENOSPC;

3748
				ereport(ERROR,
3749
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
3750
					 errmsg("could not write to file \"%s\": %m", tmppath)));
3751 3752 3753 3754 3755 3756 3757 3758
			}
		}
		close(srcfd);
	}

	/*
	 * Append one line with the details of this timeline split.
	 *
B
Bruce Momjian 已提交
3759 3760
	 * If we did have a parent file, insert an extra newline just in case the
	 * parent file failed to end with one.
3761 3762 3763 3764 3765 3766 3767 3768 3769 3770
	 */
	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,
3771
			 timestamptz_to_str(recoveryStopTime));
3772 3773 3774 3775 3776 3777 3778 3779

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

		/*
B
Bruce Momjian 已提交
3780
		 * If we fail to make the file, delete it to release disk space
3781 3782 3783 3784 3785
		 */
		unlink(tmppath);
		/* if write didn't set errno, assume problem is no disk space */
		errno = save_errno ? save_errno : ENOSPC;

3786
		ereport(ERROR,
3787 3788 3789 3790 3791
				(errcode_for_file_access(),
				 errmsg("could not write to file \"%s\": %m", tmppath)));
	}

	if (pg_fsync(fd) != 0)
3792
		ereport(ERROR,
3793 3794 3795 3796
				(errcode_for_file_access(),
				 errmsg("could not fsync file \"%s\": %m", tmppath)));

	if (close(fd))
3797
		ereport(ERROR,
3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813
				(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)
3814
		ereport(ERROR,
3815 3816 3817 3818 3819 3820
				(errcode_for_file_access(),
				 errmsg("could not link file \"%s\" to \"%s\": %m",
						tmppath, path)));
	unlink(tmppath);
#else
	if (rename(tmppath, path) < 0)
3821
		ereport(ERROR,
3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833
				(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
3834 3835
 *
 * *ControlFile is a buffer in shared memory that holds an image of the
B
Bruce Momjian 已提交
3836
 * contents of pg_control.	WriteControlFile() initializes pg_control
3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849
 * 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 已提交
3850
	char		buffer[PG_CONTROL_SIZE];		/* need not be aligned */
3851 3852 3853
	char	   *localeptr;

	/*
T
Tom Lane 已提交
3854
	 * Initialize version and compatibility-check fields
3855
	 */
T
Tom Lane 已提交
3856 3857
	ControlFile->pg_control_version = PG_CONTROL_VERSION;
	ControlFile->catalog_version_no = CATALOG_VERSION_NO;
3858 3859 3860 3861

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

3862 3863
	ControlFile->blcksz = BLCKSZ;
	ControlFile->relseg_size = RELSEG_SIZE;
3864
	ControlFile->xlog_blcksz = XLOG_BLCKSZ;
3865
	ControlFile->xlog_seg_size = XLOG_SEG_SIZE;
3866 3867

	ControlFile->nameDataLen = NAMEDATALEN;
3868
	ControlFile->indexMaxKeys = INDEX_MAX_KEYS;
3869

3870 3871
	ControlFile->toast_max_chunk_size = TOAST_MAX_CHUNK_SIZE;

3872 3873 3874 3875 3876 3877 3878
#ifdef HAVE_INT64_TIMESTAMP
	ControlFile->enableIntTimes = TRUE;
#else
	ControlFile->enableIntTimes = FALSE;
#endif

	ControlFile->localeBuflen = LOCALE_NAME_BUFLEN;
3879 3880
	localeptr = setlocale(LC_COLLATE, NULL);
	if (!localeptr)
3881 3882
		ereport(PANIC,
				(errmsg("invalid LC_COLLATE setting")));
3883 3884 3885
	StrNCpy(ControlFile->lc_collate, localeptr, LOCALE_NAME_BUFLEN);
	localeptr = setlocale(LC_CTYPE, NULL);
	if (!localeptr)
3886 3887
		ereport(PANIC,
				(errmsg("invalid LC_CTYPE setting")));
3888
	StrNCpy(ControlFile->lc_ctype, localeptr, LOCALE_NAME_BUFLEN);
B
Bruce Momjian 已提交
3889

T
Tom Lane 已提交
3890
	/* Contents are protected with a CRC */
3891 3892 3893 3894 3895
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
T
Tom Lane 已提交
3896

3897
	/*
3898 3899 3900 3901 3902
	 * 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".
3903
	 */
3904 3905
	if (sizeof(ControlFileData) > PG_CONTROL_SIZE)
		elog(PANIC, "sizeof(ControlFileData) is larger than PG_CONTROL_SIZE; fix either one");
3906

3907
	memset(buffer, 0, PG_CONTROL_SIZE);
3908 3909
	memcpy(buffer, ControlFile, sizeof(ControlFileData));

3910 3911
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | O_CREAT | O_EXCL | PG_BINARY,
3912
					   S_IRUSR | S_IWUSR);
3913
	if (fd < 0)
3914 3915 3916
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not create control file \"%s\": %m",
3917
						XLOG_CONTROL_FILE)));
3918

3919
	errno = 0;
3920
	if (write(fd, buffer, PG_CONTROL_SIZE) != PG_CONTROL_SIZE)
3921 3922 3923 3924
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
3925 3926
		ereport(PANIC,
				(errcode_for_file_access(),
3927
				 errmsg("could not write to control file: %m")));
3928
	}
3929

3930
	if (pg_fsync(fd) != 0)
3931 3932
		ereport(PANIC,
				(errcode_for_file_access(),
3933
				 errmsg("could not fsync control file: %m")));
3934

3935 3936 3937 3938
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
3939 3940 3941 3942 3943
}

static void
ReadControlFile(void)
{
3944
	pg_crc32	crc;
3945 3946 3947 3948 3949
	int			fd;

	/*
	 * Read data...
	 */
3950 3951 3952
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | PG_BINARY,
					   S_IRUSR | S_IWUSR);
3953
	if (fd < 0)
3954 3955 3956
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not open control file \"%s\": %m",
3957
						XLOG_CONTROL_FILE)));
3958 3959

	if (read(fd, ControlFile, sizeof(ControlFileData)) != sizeof(ControlFileData))
3960 3961
		ereport(PANIC,
				(errcode_for_file_access(),
3962
				 errmsg("could not read from control file: %m")));
3963 3964 3965

	close(fd);

T
Tom Lane 已提交
3966
	/*
B
Bruce Momjian 已提交
3967 3968 3969 3970
	 * 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 已提交
3971
	 */
3972 3973 3974 3975 3976 3977 3978 3979 3980 3981

	if (ControlFile->pg_control_version != PG_CONTROL_VERSION && ControlFile->pg_control_version % 65536 == 0 && ControlFile->pg_control_version / 65536 != 0)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with PG_CONTROL_VERSION %d (0x%08x),"
						   " but the server was compiled with PG_CONTROL_VERSION %d (0x%08x).",
						   ControlFile->pg_control_version, ControlFile->pg_control_version,
						   PG_CONTROL_VERSION, PG_CONTROL_VERSION),
				 errhint("This could be a problem of mismatched byte ordering.  It looks like you need to initdb.")));

T
Tom Lane 已提交
3982
	if (ControlFile->pg_control_version != PG_CONTROL_VERSION)
3983 3984 3985
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with PG_CONTROL_VERSION %d,"
B
Bruce Momjian 已提交
3986 3987
				  " but the server was compiled with PG_CONTROL_VERSION %d.",
						ControlFile->pg_control_version, PG_CONTROL_VERSION),
3988
				 errhint("It looks like you need to initdb.")));
3989

T
Tom Lane 已提交
3990
	/* Now check the CRC. */
3991 3992 3993 3994 3995
	INIT_CRC32(crc);
	COMP_CRC32(crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(crc);
3996

3997
	if (!EQ_CRC32(crc, ControlFile->crc))
3998
		ereport(FATAL,
3999
				(errmsg("incorrect checksum in control file")));
4000

4001
	/*
B
Bruce Momjian 已提交
4002
	 * Do compatibility checking immediately.  We do this here for 2 reasons:
4003
	 *
4004 4005
	 * (1) if the database isn't compatible with the backend executable, we
	 * want to abort before we can possibly do any damage;
4006 4007
	 *
	 * (2) this code is executed in the postmaster, so the setlocale() will
B
Bruce Momjian 已提交
4008 4009
	 * propagate to forked backends, which aren't going to read this file for
	 * themselves.	(These locale settings are considered critical
4010 4011
	 * compatibility items because they can affect sort order of indexes.)
	 */
T
Tom Lane 已提交
4012
	if (ControlFile->catalog_version_no != CATALOG_VERSION_NO)
4013 4014 4015
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with CATALOG_VERSION_NO %d,"
B
Bruce Momjian 已提交
4016 4017
				  " but the server was compiled with CATALOG_VERSION_NO %d.",
						ControlFile->catalog_version_no, CATALOG_VERSION_NO),
4018
				 errhint("It looks like you need to initdb.")));
4019 4020 4021
	if (ControlFile->maxAlign != MAXIMUM_ALIGNOF)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
4022 4023 4024 4025
		   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.")));
4026 4027 4028
	if (ControlFile->floatFormat != FLOATFORMAT_VALUE)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
P
Peter Eisentraut 已提交
4029
				 errdetail("The database cluster appears to use a different floating-point number format than the server executable."),
4030
				 errhint("It looks like you need to initdb.")));
4031
	if (ControlFile->blcksz != BLCKSZ)
4032 4033
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
4034 4035 4036 4037
			 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.")));
4038
	if (ControlFile->relseg_size != RELSEG_SIZE)
4039 4040
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
4041 4042 4043 4044
		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.")));
4045 4046 4047
	if (ControlFile->xlog_blcksz != XLOG_BLCKSZ)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
4048 4049 4050
		errdetail("The database cluster was initialized with XLOG_BLCKSZ %d,"
				  " but the server was compiled with XLOG_BLCKSZ %d.",
				  ControlFile->xlog_blcksz, XLOG_BLCKSZ),
4051
				 errhint("It looks like you need to recompile or initdb.")));
4052 4053 4054 4055
	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 已提交
4056
					   " but the server was compiled with XLOG_SEG_SIZE %d.",
4057
						   ControlFile->xlog_seg_size, XLOG_SEG_SIZE),
B
Bruce Momjian 已提交
4058
				 errhint("It looks like you need to recompile or initdb.")));
4059
	if (ControlFile->nameDataLen != NAMEDATALEN)
4060 4061
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
B
Bruce Momjian 已提交
4062 4063 4064 4065
		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.")));
4066
	if (ControlFile->indexMaxKeys != INDEX_MAX_KEYS)
4067 4068
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
4069
				 errdetail("The database cluster was initialized with INDEX_MAX_KEYS %d,"
B
Bruce Momjian 已提交
4070
					  " but the server was compiled with INDEX_MAX_KEYS %d.",
4071
						   ControlFile->indexMaxKeys, INDEX_MAX_KEYS),
B
Bruce Momjian 已提交
4072
				 errhint("It looks like you need to recompile or initdb.")));
4073 4074 4075 4076
	if (ControlFile->toast_max_chunk_size != TOAST_MAX_CHUNK_SIZE)
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with TOAST_MAX_CHUNK_SIZE %d,"
B
Bruce Momjian 已提交
4077 4078
				" but the server was compiled with TOAST_MAX_CHUNK_SIZE %d.",
			  ControlFile->toast_max_chunk_size, (int) TOAST_MAX_CHUNK_SIZE),
4079
				 errhint("It looks like you need to recompile or initdb.")));
4080 4081 4082

#ifdef HAVE_INT64_TIMESTAMP
	if (ControlFile->enableIntTimes != TRUE)
4083 4084 4085
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized without HAVE_INT64_TIMESTAMP"
B
Bruce Momjian 已提交
4086 4087
				  " but the server was compiled with HAVE_INT64_TIMESTAMP."),
				 errhint("It looks like you need to recompile or initdb.")));
4088 4089
#else
	if (ControlFile->enableIntTimes != FALSE)
4090 4091 4092
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with HAVE_INT64_TIMESTAMP"
B
Bruce Momjian 已提交
4093 4094
			   " but the server was compiled without HAVE_INT64_TIMESTAMP."),
				 errhint("It looks like you need to recompile or initdb.")));
4095 4096 4097
#endif

	if (ControlFile->localeBuflen != LOCALE_NAME_BUFLEN)
4098 4099 4100
		ereport(FATAL,
				(errmsg("database files are incompatible with server"),
				 errdetail("The database cluster was initialized with LOCALE_NAME_BUFLEN %d,"
B
Bruce Momjian 已提交
4101
				  " but the server was compiled with LOCALE_NAME_BUFLEN %d.",
4102
						   ControlFile->localeBuflen, LOCALE_NAME_BUFLEN),
B
Bruce Momjian 已提交
4103
				 errhint("It looks like you need to recompile or initdb.")));
4104
	if (pg_perm_setlocale(LC_COLLATE, ControlFile->lc_collate) == NULL)
4105
		ereport(FATAL,
B
Bruce Momjian 已提交
4106 4107 4108 4109 4110
			(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.")));
4111
	if (pg_perm_setlocale(LC_CTYPE, ControlFile->lc_ctype) == NULL)
4112
		ereport(FATAL,
B
Bruce Momjian 已提交
4113 4114 4115 4116 4117
			(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.")));
4118 4119 4120 4121 4122 4123

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

4126
void
4127
UpdateControlFile(void)
4128
{
4129
	int			fd;
4130

4131 4132 4133 4134 4135
	INIT_CRC32(ControlFile->crc);
	COMP_CRC32(ControlFile->crc,
			   (char *) ControlFile,
			   offsetof(ControlFileData, crc));
	FIN_CRC32(ControlFile->crc);
4136

4137 4138 4139
	fd = BasicOpenFile(XLOG_CONTROL_FILE,
					   O_RDWR | PG_BINARY,
					   S_IRUSR | S_IWUSR);
4140
	if (fd < 0)
4141 4142 4143
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not open control file \"%s\": %m",
4144
						XLOG_CONTROL_FILE)));
4145

4146
	errno = 0;
4147
	if (write(fd, ControlFile, sizeof(ControlFileData)) != sizeof(ControlFileData))
4148 4149 4150 4151
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
4152 4153
		ereport(PANIC,
				(errcode_for_file_access(),
4154
				 errmsg("could not write to control file: %m")));
4155
	}
4156

4157
	if (pg_fsync(fd) != 0)
4158 4159
		ereport(PANIC,
				(errcode_for_file_access(),
4160
				 errmsg("could not fsync control file: %m")));
4161

4162 4163 4164 4165
	if (close(fd))
		ereport(PANIC,
				(errcode_for_file_access(),
				 errmsg("could not close control file: %m")));
4166 4167
}

4168
/*
T
Tom Lane 已提交
4169
 * Initialization of shared memory for XLOG
4170
 */
4171
Size
4172
XLOGShmemSize(void)
4173
{
4174
	Size		size;
4175

4176 4177 4178 4179 4180 4181 4182
	/* 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 */
4183
	size = add_size(size, mul_size(XLOG_BLCKSZ, XLOGbuffers));
4184 4185

	/*
B
Bruce Momjian 已提交
4186 4187 4188
	 * 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.
4189 4190 4191
	 */

	return size;
4192 4193 4194 4195 4196
}

void
XLOGShmemInit(void)
{
4197 4198
	bool		foundCFile,
				foundXLog;
4199
	char	   *allocptr;
4200

4201
	ControlFile = (ControlFileData *)
4202
		ShmemInitStruct("Control File", sizeof(ControlFileData), &foundCFile);
4203 4204
	XLogCtl = (XLogCtlData *)
		ShmemInitStruct("XLOG Ctl", XLOGShmemSize(), &foundXLog);
4205

4206
	if (foundCFile || foundXLog)
4207 4208
	{
		/* both should be present or neither */
4209
		Assert(foundCFile && foundXLog);
4210 4211
		return;
	}
4212

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

T
Tom Lane 已提交
4215
	/*
B
Bruce Momjian 已提交
4216 4217 4218
	 * 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 已提交
4219
	 */
4220 4221
	allocptr = ((char *) XLogCtl) + sizeof(XLogCtlData);
	XLogCtl->xlblocks = (XLogRecPtr *) allocptr;
T
Tom Lane 已提交
4222
	memset(XLogCtl->xlblocks, 0, sizeof(XLogRecPtr) * XLOGbuffers);
4223
	allocptr += sizeof(XLogRecPtr) * XLOGbuffers;
B
Bruce Momjian 已提交
4224

T
Tom Lane 已提交
4225
	/*
4226
	 * Align the start of the page buffers to an ALIGNOF_XLOG_BUFFER boundary.
T
Tom Lane 已提交
4227
	 */
4228 4229
	allocptr = (char *) TYPEALIGN(ALIGNOF_XLOG_BUFFER, allocptr);
	XLogCtl->pages = allocptr;
4230
	memset(XLogCtl->pages, 0, (Size) XLOG_BLCKSZ * XLOGbuffers);
T
Tom Lane 已提交
4231 4232

	/*
B
Bruce Momjian 已提交
4233 4234
	 * Do basic initialization of XLogCtl shared data. (StartupXLOG will fill
	 * in additional info.)
T
Tom Lane 已提交
4235
	 */
B
Bruce Momjian 已提交
4236
	XLogCtl->XLogCacheByte = (Size) XLOG_BLCKSZ *XLOGbuffers;
B
Bruce Momjian 已提交
4237

T
Tom Lane 已提交
4238 4239
	XLogCtl->XLogCacheBlck = XLOGbuffers - 1;
	XLogCtl->Insert.currpage = (XLogPageHeader) (XLogCtl->pages);
4240
	SpinLockInit(&XLogCtl->info_lck);
T
Tom Lane 已提交
4241

4242
	/*
B
Bruce Momjian 已提交
4243 4244 4245
	 * 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).
4246 4247 4248
	 */
	if (!IsBootstrapProcessingMode())
		ReadControlFile();
4249 4250 4251
}

/*
T
Tom Lane 已提交
4252 4253
 * This func must be called ONCE on system install.  It creates pg_control
 * and the initial XLOG segment.
4254 4255
 */
void
T
Tom Lane 已提交
4256
BootStrapXLOG(void)
4257
{
4258
	CheckPoint	checkPoint;
T
Tom Lane 已提交
4259 4260
	char	   *buffer;
	XLogPageHeader page;
4261
	XLogLongPageHeader longpage;
4262
	XLogRecord *record;
B
Bruce Momjian 已提交
4263
	bool		use_existent;
4264 4265
	uint64		sysidentifier;
	struct timeval tv;
4266
	pg_crc32	crc;
4267

4268
	/*
B
Bruce Momjian 已提交
4269 4270 4271 4272 4273 4274 4275 4276 4277 4278
	 * 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.
4279 4280 4281 4282 4283
	 */
	gettimeofday(&tv, NULL);
	sysidentifier = ((uint64) tv.tv_sec) << 32;
	sysidentifier |= (uint32) (tv.tv_sec | tv.tv_usec);

4284 4285 4286
	/* First timeline ID is always 1 */
	ThisTimeLineID = 1;

4287
	/* page buffer must be aligned suitably for O_DIRECT */
4288
	buffer = (char *) palloc(XLOG_BLCKSZ + ALIGNOF_XLOG_BUFFER);
4289
	page = (XLogPageHeader) TYPEALIGN(ALIGNOF_XLOG_BUFFER, buffer);
4290
	memset(page, 0, XLOG_BLCKSZ);
T
Tom Lane 已提交
4291

4292
	/* Set up information for the initial checkpoint record */
4293
	checkPoint.redo.xlogid = 0;
4294 4295
	checkPoint.redo.xrecoff = SizeOfXLogLongPHD;
	checkPoint.ThisTimeLineID = ThisTimeLineID;
4296
	checkPoint.nextXidEpoch = 0;
4297
	checkPoint.nextXid = FirstNormalTransactionId;
4298
	checkPoint.nextOid = FirstBootstrapObjectId;
4299
	checkPoint.nextMulti = FirstMultiXactId;
4300
	checkPoint.nextMultiOffset = 0;
T
Tom Lane 已提交
4301
	checkPoint.time = time(NULL);
4302

4303 4304 4305
	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
	ShmemVariableCache->oidCount = 0;
4306
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
4307

4308
	/* Set up the XLOG page header */
4309
	page->xlp_magic = XLOG_PAGE_MAGIC;
4310 4311
	page->xlp_info = XLP_LONG_HEADER;
	page->xlp_tli = ThisTimeLineID;
4312 4313
	page->xlp_pageaddr.xlogid = 0;
	page->xlp_pageaddr.xrecoff = 0;
4314 4315 4316
	longpage = (XLogLongPageHeader) page;
	longpage->xlp_sysid = sysidentifier;
	longpage->xlp_seg_size = XLogSegSize;
4317
	longpage->xlp_xlog_blcksz = XLOG_BLCKSZ;
4318 4319

	/* Insert the initial checkpoint record */
4320
	record = (XLogRecord *) ((char *) page + SizeOfXLogLongPHD);
4321
	record->xl_prev.xlogid = 0;
4322
	record->xl_prev.xrecoff = 0;
4323
	record->xl_xid = InvalidTransactionId;
4324
	record->xl_tot_len = SizeOfXLogRecord + sizeof(checkPoint);
4325
	record->xl_len = sizeof(checkPoint);
T
Tom Lane 已提交
4326
	record->xl_info = XLOG_CHECKPOINT_SHUTDOWN;
4327
	record->xl_rmid = RM_XLOG_ID;
T
Tom Lane 已提交
4328
	memcpy(XLogRecGetData(record), &checkPoint, sizeof(checkPoint));
4329

4330 4331 4332 4333 4334
	INIT_CRC32(crc);
	COMP_CRC32(crc, &checkPoint, sizeof(checkPoint));
	COMP_CRC32(crc, (char *) record + sizeof(pg_crc32),
			   SizeOfXLogRecord - sizeof(pg_crc32));
	FIN_CRC32(crc);
4335 4336
	record->xl_crc = crc;

4337
	/* Create first XLOG segment file */
4338 4339
	use_existent = false;
	openLogFile = XLogFileInit(0, 0, &use_existent, false);
4340

4341
	/* Write the first page with the initial record */
4342
	errno = 0;
4343
	if (write(openLogFile, page, XLOG_BLCKSZ) != XLOG_BLCKSZ)
4344 4345 4346 4347
	{
		/* if write didn't set errno, assume problem is no disk space */
		if (errno == 0)
			errno = ENOSPC;
4348 4349
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4350
			  errmsg("could not write bootstrap transaction log file: %m")));
4351
	}
4352

T
Tom Lane 已提交
4353
	if (pg_fsync(openLogFile) != 0)
4354 4355
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4356
			  errmsg("could not fsync bootstrap transaction log file: %m")));
4357

4358 4359 4360
	if (close(openLogFile))
		ereport(PANIC,
				(errcode_for_file_access(),
B
Bruce Momjian 已提交
4361
			  errmsg("could not close bootstrap transaction log file: %m")));
4362

T
Tom Lane 已提交
4363
	openLogFile = -1;
4364

4365 4366
	/* Now create pg_control */

4367
	memset(ControlFile, 0, sizeof(ControlFileData));
T
Tom Lane 已提交
4368
	/* Initialize pg_control status fields */
4369
	ControlFile->system_identifier = sysidentifier;
T
Tom Lane 已提交
4370 4371
	ControlFile->state = DB_SHUTDOWNED;
	ControlFile->time = checkPoint.time;
4372
	ControlFile->checkPoint = checkPoint.redo;
T
Tom Lane 已提交
4373
	ControlFile->checkPointCopy = checkPoint;
4374
	/* some additional ControlFile fields are set in WriteControlFile() */
4375

4376
	WriteControlFile();
4377 4378 4379

	/* Bootstrap the commit log, too */
	BootStrapCLOG();
4380
	BootStrapSUBTRANS();
4381
	BootStrapMultiXact();
4382

4383
	pfree(buffer);
4384 4385
}

4386
static char *
4387
str_time(pg_time_t tnow)
4388
{
4389
	static char buf[128];
4390

4391 4392 4393
	pg_strftime(buf, sizeof(buf),
				"%Y-%m-%d %H:%M:%S %Z",
				pg_localtime(&tnow, log_timezone));
4394

4395
	return buf;
4396 4397
}

4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408
/*
 * 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 已提交
4409 4410 4411 4412 4413 4414
	FILE	   *fd;
	char		cmdline[MAXPGPATH];
	TimeLineID	rtli = 0;
	bool		rtliGiven = false;
	bool		syntaxError = false;

4415
	fd = AllocateFile(RECOVERY_COMMAND_FILE, "r");
4416 4417 4418 4419 4420
	if (fd == NULL)
	{
		if (errno == ENOENT)
			return;				/* not there, so no archive recovery */
		ereport(FATAL,
B
Bruce Momjian 已提交
4421
				(errcode_for_file_access(),
4422
				 errmsg("could not open recovery command file \"%s\": %m",
4423
						RECOVERY_COMMAND_FILE)));
4424 4425 4426
	}

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

B
Bruce Momjian 已提交
4429 4430 4431
	/*
	 * Parse the file...
	 */
4432
	while (fgets(cmdline, sizeof(cmdline), fd) != NULL)
4433 4434
	{
		/* skip leading whitespace and check for # comment */
B
Bruce Momjian 已提交
4435 4436 4437
		char	   *ptr;
		char	   *tok1;
		char	   *tok2;
4438 4439 4440 4441 4442 4443 4444 4445 4446 4447

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

		/* identify the quoted parameter value */
B
Bruce Momjian 已提交
4448
		tok1 = strtok(ptr, "'");
4449 4450 4451 4452 4453
		if (!tok1)
		{
			syntaxError = true;
			break;
		}
B
Bruce Momjian 已提交
4454
		tok2 = strtok(NULL, "'");
4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467
		if (!tok2)
		{
			syntaxError = true;
			break;
		}
		/* reparse to get just the parameter name */
		tok1 = strtok(ptr, " \t=");
		if (!tok1)
		{
			syntaxError = true;
			break;
		}

B
Bruce Momjian 已提交
4468 4469
		if (strcmp(tok1, "restore_command") == 0)
		{
4470
			recoveryRestoreCommand = pstrdup(tok2);
4471
			ereport(LOG,
4472
					(errmsg("restore_command = '%s'",
4473 4474
							recoveryRestoreCommand)));
		}
B
Bruce Momjian 已提交
4475 4476
		else if (strcmp(tok1, "recovery_target_timeline") == 0)
		{
4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495
			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 已提交
4496 4497
		else if (strcmp(tok1, "recovery_target_xid") == 0)
		{
4498 4499 4500 4501
			errno = 0;
			recoveryTargetXid = (TransactionId) strtoul(tok2, NULL, 0);
			if (errno == EINVAL || errno == ERANGE)
				ereport(FATAL,
B
Bruce Momjian 已提交
4502 4503
				 (errmsg("recovery_target_xid is not a valid number: \"%s\"",
						 tok2)));
4504 4505 4506 4507 4508 4509
			ereport(LOG,
					(errmsg("recovery_target_xid = %u",
							recoveryTargetXid)));
			recoveryTarget = true;
			recoveryTargetExact = true;
		}
B
Bruce Momjian 已提交
4510 4511
		else if (strcmp(tok1, "recovery_target_time") == 0)
		{
4512 4513 4514 4515 4516 4517 4518 4519
			/*
			 * if recovery_target_xid specified, then this overrides
			 * recovery_target_time
			 */
			if (recoveryTargetExact)
				continue;
			recoveryTarget = true;
			recoveryTargetExact = false;
B
Bruce Momjian 已提交
4520

4521
			/*
4522
			 * Convert the time string given by the user to TimestampTz form.
4523
			 */
4524 4525
			recoveryTargetTime =
				DatumGetTimestampTz(DirectFunctionCall3(timestamptz_in,
B
Bruce Momjian 已提交
4526
														CStringGetDatum(tok2),
4527 4528
												ObjectIdGetDatum(InvalidOid),
														Int32GetDatum(-1)));
4529
			ereport(LOG,
4530
					(errmsg("recovery_target_time = '%s'",
4531
							timestamptz_to_str(recoveryTargetTime))));
4532
		}
B
Bruce Momjian 已提交
4533 4534
		else if (strcmp(tok1, "recovery_target_inclusive") == 0)
		{
4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547
			/*
			 * 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)));
		}
4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562
		else if (strcmp(tok1, "log_restartpoints") == 0)
		{
			/*
			 * does nothing if a recovery_target is not also set
			 */
			if (strcmp(tok2, "true") == 0)
				recoveryLogRestartpoints = true;
			else
			{
				recoveryLogRestartpoints = false;
				tok2 = "false";
			}
			ereport(LOG,
					(errmsg("log_restartpoints = %s", tok2)));
		}
4563 4564 4565 4566 4567 4568 4569 4570
		else
			ereport(FATAL,
					(errmsg("unrecognized recovery parameter \"%s\"",
							tok1)));
	}

	FreeFile(fd);

B
Bruce Momjian 已提交
4571 4572
	if (syntaxError)
		ereport(FATAL,
4573 4574
				(errmsg("syntax error in recovery command file: %s",
						cmdline),
B
Bruce Momjian 已提交
4575
			  errhint("Lines should have the format parameter = 'value'.")));
4576 4577

	/* Check that required parameters were supplied */
4578
	if (recoveryRestoreCommand == NULL)
4579 4580
		ereport(FATAL,
				(errmsg("recovery command file \"%s\" did not specify restore_command",
4581
						RECOVERY_COMMAND_FILE)));
4582

4583 4584 4585
	/* Enable fetching from archive recovery area */
	InArchiveRecovery = true;

4586
	/*
B
Bruce Momjian 已提交
4587 4588 4589 4590
	 * 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.
4591
	 */
4592 4593 4594 4595 4596 4597 4598
	if (rtliGiven)
	{
		if (rtli)
		{
			/* Timeline 1 does not have a history file, all else should */
			if (rtli != 1 && !existsTimeLineHistory(rtli))
				ereport(FATAL,
4599
						(errmsg("recovery target timeline %u does not exist",
B
Bruce Momjian 已提交
4600
								rtli)));
4601 4602 4603 4604 4605 4606 4607 4608
			recoveryTargetTLI = rtli;
		}
		else
		{
			/* We start the "latest" search from pg_control's timeline */
			recoveryTargetTLI = findNewestTimeLine(recoveryTargetTLI);
		}
	}
4609 4610 4611 4612 4613 4614
}

/*
 * Exit archive-recovery state
 */
static void
4615
exitArchiveRecovery(TimeLineID endTLI, uint32 endLogId, uint32 endLogSeg)
4616
{
B
Bruce Momjian 已提交
4617 4618
	char		recoveryPath[MAXPGPATH];
	char		xlogpath[MAXPGPATH];
4619 4620

	/*
4621
	 * We are no longer in archive recovery state.
4622 4623 4624 4625
	 */
	InArchiveRecovery = false;

	/*
B
Bruce Momjian 已提交
4626 4627 4628
	 * 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).
4629 4630 4631 4632 4633 4634 4635 4636 4637
	 */
	Assert(readFile >= 0);
	Assert(readId == endLogId);
	Assert(readSeg == endLogSeg);

	close(readFile);
	readFile = -1;

	/*
B
Bruce Momjian 已提交
4638 4639 4640 4641 4642 4643 4644
	 * 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.
4645
	 *
4646 4647
	 * 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
4648 4649
	 * of overwriting any existing file.  (This is, in fact, always the case
	 * at present.)
4650
	 */
4651
	snprintf(recoveryPath, MAXPGPATH, XLOGDIR "/RECOVERYXLOG");
4652
	XLogFilePath(xlogpath, ThisTimeLineID, endLogId, endLogSeg);
4653 4654 4655 4656 4657 4658 4659 4660 4661 4662

	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(),
4663
					 errmsg("could not rename file \"%s\" to \"%s\": %m",
4664 4665 4666 4667 4668 4669 4670 4671 4672 4673
							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 已提交
4674

4675
		/*
B
Bruce Momjian 已提交
4676 4677 4678
		 * 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.
4679 4680 4681 4682
		 */
		if (endTLI != ThisTimeLineID)
			XLogFileCopy(endLogId, endLogSeg,
						 endTLI, endLogId, endLogSeg);
4683 4684 4685
	}

	/*
B
Bruce Momjian 已提交
4686 4687
	 * Let's just make real sure there are not .ready or .done flags posted
	 * for the new segment.
4688
	 */
4689 4690
	XLogFileName(xlogpath, ThisTimeLineID, endLogId, endLogSeg);
	XLogArchiveCleanup(xlogpath);
4691

4692
	/* Get rid of any remaining recovered timeline-history file, too */
4693
	snprintf(recoveryPath, MAXPGPATH, XLOGDIR "/RECOVERYHISTORY");
B
Bruce Momjian 已提交
4694
	unlink(recoveryPath);		/* ignore any error */
4695 4696

	/*
B
Bruce Momjian 已提交
4697 4698
	 * Rename the config file out of the way, so that we don't accidentally
	 * re-enter archive recovery mode in a subsequent crash.
4699
	 */
4700 4701
	unlink(RECOVERY_COMMAND_DONE);
	if (rename(RECOVERY_COMMAND_FILE, RECOVERY_COMMAND_DONE) != 0)
4702 4703
		ereport(FATAL,
				(errcode_for_file_access(),
4704
				 errmsg("could not rename file \"%s\" to \"%s\": %m",
4705
						RECOVERY_COMMAND_FILE, RECOVERY_COMMAND_DONE)));
4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716

	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.
4717 4718 4719
 *
 * We also track the timestamp of the latest applied COMMIT/ABORT record
 * in recoveryLastXTime, for logging purposes.
4720 4721
 * Also, some information is saved in recoveryStopXid et al for use in
 * annotating the new timeline's history file.
4722 4723 4724 4725 4726
 */
static bool
recoveryStopsHere(XLogRecord *record, bool *includeThis)
{
	bool		stopsHere;
B
Bruce Momjian 已提交
4727
	uint8		record_info;
B
Bruce Momjian 已提交
4728
	TimestampTz recordXtime;
4729 4730 4731 4732 4733 4734 4735

	/* 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 已提交
4736
		xl_xact_commit *recordXactCommitData;
4737 4738

		recordXactCommitData = (xl_xact_commit *) XLogRecGetData(record);
4739
		recordXtime = recordXactCommitData->xact_time;
4740 4741 4742
	}
	else if (record_info == XLOG_XACT_ABORT)
	{
B
Bruce Momjian 已提交
4743
		xl_xact_abort *recordXactAbortData;
4744 4745

		recordXactAbortData = (xl_xact_abort *) XLogRecGetData(record);
4746
		recordXtime = recordXactAbortData->xact_time;
4747 4748 4749 4750
	}
	else
		return false;

4751 4752
	/* Do we have a PITR target at all? */
	if (!recoveryTarget)
4753 4754
	{
		recoveryLastXTime = recordXtime;
4755
		return false;
4756
	}
4757

4758 4759 4760
	if (recoveryTargetExact)
	{
		/*
B
Bruce Momjian 已提交
4761 4762
		 * there can be only one transaction end record with this exact
		 * transactionid
4763
		 *
B
Bruce Momjian 已提交
4764
		 * when testing for an xid, we MUST test for equality only, since
B
Bruce Momjian 已提交
4765 4766 4767
		 * 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...
4768 4769 4770 4771 4772 4773 4774 4775
		 */
		stopsHere = (record->xl_xid == recoveryTargetXid);
		if (stopsHere)
			*includeThis = recoveryTargetInclusive;
	}
	else
	{
		/*
B
Bruce Momjian 已提交
4776 4777 4778
		 * 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
4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789
		 */
		if (recoveryTargetInclusive)
			stopsHere = (recordXtime > recoveryTargetTime);
		else
			stopsHere = (recordXtime >= recoveryTargetTime);
		if (stopsHere)
			*includeThis = false;
	}

	if (stopsHere)
	{
4790 4791 4792 4793
		recoveryStopXid = record->xl_xid;
		recoveryStopTime = recordXtime;
		recoveryStopAfter = *includeThis;

4794 4795
		if (record_info == XLOG_XACT_COMMIT)
		{
4796
			if (recoveryStopAfter)
4797 4798
				ereport(LOG,
						(errmsg("recovery stopping after commit of transaction %u, time %s",
4799 4800
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4801 4802 4803
			else
				ereport(LOG,
						(errmsg("recovery stopping before commit of transaction %u, time %s",
4804 4805
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4806 4807 4808
		}
		else
		{
4809
			if (recoveryStopAfter)
4810 4811
				ereport(LOG,
						(errmsg("recovery stopping after abort of transaction %u, time %s",
4812 4813
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4814 4815 4816
			else
				ereport(LOG,
						(errmsg("recovery stopping before abort of transaction %u, time %s",
4817 4818
								recoveryStopXid,
								timestamptz_to_str(recoveryStopTime))));
4819
		}
4820 4821 4822

		if (recoveryStopAfter)
			recoveryLastXTime = recordXtime;
4823
	}
4824 4825
	else
		recoveryLastXTime = recordXtime;
4826 4827 4828 4829

	return stopsHere;
}

4830
/*
T
Tom Lane 已提交
4831
 * This must be called ONCE during postmaster or standalone-backend startup
4832 4833
 */
void
T
Tom Lane 已提交
4834
StartupXLOG(void)
4835
{
4836 4837
	XLogCtlInsert *Insert;
	CheckPoint	checkPoint;
T
Tom Lane 已提交
4838
	bool		wasShutdown;
4839
	bool		reachedStopPoint = false;
4840
	bool		haveBackupLabel = false;
4841
	XLogRecPtr	RecPtr,
T
Tom Lane 已提交
4842 4843
				LastRec,
				checkPointLoc,
4844
				minRecoveryLoc,
T
Tom Lane 已提交
4845
				EndOfLog;
4846 4847
	uint32		endLogId;
	uint32		endLogSeg;
4848
	XLogRecord *record;
4849
	uint32		freespace;
4850
	TransactionId oldestActiveXID;
4851

4852
	/*
4853 4854
	 * Read control file and check XLOG status looks valid.
	 *
4855 4856
	 * 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.
4857
	 */
4858
	ReadControlFile();
4859

4860
	if (ControlFile->state < DB_SHUTDOWNED ||
4861
		ControlFile->state > DB_IN_PRODUCTION ||
4862
		!XRecOffIsValid(ControlFile->checkPoint.xrecoff))
4863 4864
		ereport(FATAL,
				(errmsg("control file contains invalid data")));
4865 4866

	if (ControlFile->state == DB_SHUTDOWNED)
4867 4868 4869
		ereport(LOG,
				(errmsg("database system was shut down at %s",
						str_time(ControlFile->time))));
4870
	else if (ControlFile->state == DB_SHUTDOWNING)
4871
		ereport(LOG,
4872
				(errmsg("database system shutdown was interrupted; last known up at %s",
4873
						str_time(ControlFile->time))));
4874
	else if (ControlFile->state == DB_IN_CRASH_RECOVERY)
4875
		ereport(LOG,
B
Bruce Momjian 已提交
4876 4877 4878 4879
		   (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.")));
4880 4881
	else if (ControlFile->state == DB_IN_ARCHIVE_RECOVERY)
		ereport(LOG,
B
Bruce Momjian 已提交
4882 4883
				(errmsg("database system was interrupted while in recovery at log time %s",
						str_time(ControlFile->checkPointCopy.time)),
4884
				 errhint("If this has occurred more than once some data might be corrupted"
B
Bruce Momjian 已提交
4885
			  " and you might need to choose an earlier recovery target.")));
4886
	else if (ControlFile->state == DB_IN_PRODUCTION)
4887
		ereport(LOG,
B
Bruce Momjian 已提交
4888 4889
			  (errmsg("database system was interrupted; last known up at %s",
					  str_time(ControlFile->time))));
4890

4891 4892
	/* This is just to allow attaching to startup process with a debugger */
#ifdef XLOG_REPLAY_DELAY
4893
	if (ControlFile->state != DB_SHUTDOWNED)
4894
		pg_usleep(60000000L);
4895 4896
#endif

4897
	/*
B
Bruce Momjian 已提交
4898 4899
	 * Initialize on the assumption we want to recover to the same timeline
	 * that's active according to pg_control.
4900 4901 4902
	 */
	recoveryTargetTLI = ControlFile->checkPointCopy.ThisTimeLineID;

4903
	/*
B
Bruce Momjian 已提交
4904 4905
	 * Check for recovery control file, and if so set up state for offline
	 * recovery
4906 4907 4908
	 */
	readRecoveryCommandFile();

4909 4910 4911
	/* Now we can determine the list of expected TLIs */
	expectedTLIs = readTimeLineHistory(recoveryTargetTLI);

4912 4913 4914 4915 4916 4917
	/*
	 * 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 已提交
4918
						 (int) ControlFile->checkPointCopy.ThisTimeLineID))
4919 4920 4921 4922 4923
		ereport(FATAL,
				(errmsg("requested timeline %u is not a child of database system timeline %u",
						recoveryTargetTLI,
						ControlFile->checkPointCopy.ThisTimeLineID)));

4924
	if (read_backup_label(&checkPointLoc, &minRecoveryLoc))
T
Tom Lane 已提交
4925
	{
4926
		/*
B
Bruce Momjian 已提交
4927 4928
		 * When a backup_label file is present, we want to roll forward from
		 * the checkpoint it identifies, rather than using pg_control.
4929
		 */
4930
		record = ReadCheckpointRecord(checkPointLoc, 0);
4931 4932
		if (record != NULL)
		{
4933
			memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
4934
			ereport(DEBUG1,
4935
					(errmsg("checkpoint record is at %X/%X",
B
Bruce Momjian 已提交
4936
							checkPointLoc.xlogid, checkPointLoc.xrecoff)));
4937
			InRecovery = true;	/* force recovery even if SHUTDOWNED */
4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951

			/*
			 * Make sure that REDO location exists. This may not be
			 * the case if there was a crash during an online backup,
			 * which left a backup_label around that references a WAL
			 * segment that's already been archived.
			 */
			if (XLByteLT(checkPoint.redo, checkPointLoc))
			{
				if (!ReadRecord(&(checkPoint.redo), LOG))
					ereport(FATAL,
							(errmsg("could not find redo location referenced by checkpoint record"),
							 errhint("If you are not restoring from a backup, try removing the file \"%s/backup_label\".", DataDir)));
			}
4952 4953 4954
		}
		else
		{
4955
			ereport(FATAL,
B
Bruce Momjian 已提交
4956 4957
					(errmsg("could not locate required checkpoint record"),
					 errhint("If you are not restoring from a backup, try removing the file \"%s/backup_label\".", DataDir)));
4958
		}
4959 4960
		/* set flag to delete it later */
		haveBackupLabel = true;
T
Tom Lane 已提交
4961 4962 4963
	}
	else
	{
4964
		/*
B
Bruce Momjian 已提交
4965 4966
		 * Get the last valid checkpoint record.  If the latest one according
		 * to pg_control is broken, try the next-to-last one.
4967 4968
		 */
		checkPointLoc = ControlFile->checkPoint;
4969
		record = ReadCheckpointRecord(checkPointLoc, 1);
T
Tom Lane 已提交
4970 4971
		if (record != NULL)
		{
4972
			ereport(DEBUG1,
4973
					(errmsg("checkpoint record is at %X/%X",
B
Bruce Momjian 已提交
4974
							checkPointLoc.xlogid, checkPointLoc.xrecoff)));
T
Tom Lane 已提交
4975 4976
		}
		else
4977 4978
		{
			checkPointLoc = ControlFile->prevCheckPoint;
4979
			record = ReadCheckpointRecord(checkPointLoc, 2);
4980 4981 4982
			if (record != NULL)
			{
				ereport(LOG,
B
Bruce Momjian 已提交
4983 4984 4985
						(errmsg("using previous checkpoint record at %X/%X",
							  checkPointLoc.xlogid, checkPointLoc.xrecoff)));
				InRecovery = true;		/* force recovery even if SHUTDOWNED */
4986 4987 4988
			}
			else
				ereport(PANIC,
B
Bruce Momjian 已提交
4989
					 (errmsg("could not locate a valid checkpoint record")));
4990
		}
4991
		memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
T
Tom Lane 已提交
4992
	}
4993

T
Tom Lane 已提交
4994 4995
	LastRec = RecPtr = checkPointLoc;
	wasShutdown = (record->xl_info == XLOG_CHECKPOINT_SHUTDOWN);
4996

4997
	ereport(DEBUG1,
B
Bruce Momjian 已提交
4998 4999 5000
			(errmsg("redo record is at %X/%X; shutdown %s",
					checkPoint.redo.xlogid, checkPoint.redo.xrecoff,
					wasShutdown ? "TRUE" : "FALSE")));
5001
	ereport(DEBUG1,
5002 5003 5004
			(errmsg("next transaction ID: %u/%u; next OID: %u",
					checkPoint.nextXidEpoch, checkPoint.nextXid,
					checkPoint.nextOid)));
5005
	ereport(DEBUG1,
5006 5007
			(errmsg("next MultiXactId: %u; next MultiXactOffset: %u",
					checkPoint.nextMulti, checkPoint.nextMultiOffset)));
5008
	if (!TransactionIdIsNormal(checkPoint.nextXid))
5009
		ereport(PANIC,
5010
				(errmsg("invalid next transaction ID")));
5011 5012 5013

	ShmemVariableCache->nextXid = checkPoint.nextXid;
	ShmemVariableCache->nextOid = checkPoint.nextOid;
5014
	ShmemVariableCache->oidCount = 0;
5015
	MultiXactSetNextMXact(checkPoint.nextMulti, checkPoint.nextMultiOffset);
5016

5017
	/*
B
Bruce Momjian 已提交
5018 5019 5020
	 * 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()).
5021
	 */
5022
	ThisTimeLineID = checkPoint.ThisTimeLineID;
5023

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

5026
	if (XLByteLT(RecPtr, checkPoint.redo))
5027 5028
		ereport(PANIC,
				(errmsg("invalid redo in checkpoint record")));
5029

5030
	/*
B
Bruce Momjian 已提交
5031
	 * Check whether we need to force recovery from WAL.  If it appears to
B
Bruce Momjian 已提交
5032 5033
	 * have been a clean shutdown and we did not have a recovery.conf file,
	 * then assume no recovery needed.
5034
	 */
5035
	if (XLByteLT(checkPoint.redo, RecPtr))
5036
	{
T
Tom Lane 已提交
5037
		if (wasShutdown)
5038
			ereport(PANIC,
B
Bruce Momjian 已提交
5039
					(errmsg("invalid redo record in shutdown checkpoint")));
V
WAL  
Vadim B. Mikheev 已提交
5040
		InRecovery = true;
5041 5042
	}
	else if (ControlFile->state != DB_SHUTDOWNED)
V
WAL  
Vadim B. Mikheev 已提交
5043
		InRecovery = true;
5044 5045 5046 5047 5048
	else if (InArchiveRecovery)
	{
		/* force recovery due to presence of recovery.conf */
		InRecovery = true;
	}
5049

V
WAL  
Vadim B. Mikheev 已提交
5050
	/* REDO */
5051
	if (InRecovery)
5052
	{
B
Bruce Momjian 已提交
5053
		int			rmid;
5054

5055
		/*
B
Bruce Momjian 已提交
5056 5057 5058 5059
		 * 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.
5060
		 */
5061
		if (InArchiveRecovery)
5062
		{
5063
			ereport(LOG,
5064
					(errmsg("automatic recovery in progress")));
5065 5066
			ControlFile->state = DB_IN_ARCHIVE_RECOVERY;
		}
5067
		else
5068
		{
5069
			ereport(LOG,
5070 5071
					(errmsg("database system was not properly shut down; "
							"automatic recovery in progress")));
5072 5073 5074 5075 5076 5077 5078
			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;
5079 5080 5081
		ControlFile->time = time(NULL);
		UpdateControlFile();

5082
		/*
B
Bruce Momjian 已提交
5083 5084 5085 5086 5087 5088
		 * 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.
5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099
		 */
		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)));
		}

5100
		/* Start up the recovery environment */
V
WAL  
Vadim B. Mikheev 已提交
5101
		XLogInitRelationCache();
V
Vadim B. Mikheev 已提交
5102

5103 5104 5105 5106 5107 5108
		for (rmid = 0; rmid <= RM_MAX_ID; rmid++)
		{
			if (RmgrTable[rmid].rm_startup != NULL)
				RmgrTable[rmid].rm_startup();
		}

5109
		/*
B
Bruce Momjian 已提交
5110 5111
		 * Find the first record that logically follows the checkpoint --- it
		 * might physically precede it, though.
5112
		 */
5113
		if (XLByteLT(checkPoint.redo, RecPtr))
5114 5115
		{
			/* back up to find the record */
5116
			record = ReadRecord(&(checkPoint.redo), PANIC);
5117
		}
B
Bruce Momjian 已提交
5118
		else
5119
		{
5120
			/* just have to read next record after CheckPoint */
5121
			record = ReadRecord(NULL, LOG);
5122
		}
5123

T
Tom Lane 已提交
5124
		if (record != NULL)
5125
		{
5126 5127
			bool		recoveryContinue = true;
			bool		recoveryApply = true;
B
Bruce Momjian 已提交
5128
			ErrorContextCallback errcontext;
5129

V
WAL  
Vadim B. Mikheev 已提交
5130
			InRedo = true;
5131 5132 5133
			ereport(LOG,
					(errmsg("redo starts at %X/%X",
							ReadRecPtr.xlogid, ReadRecPtr.xrecoff)));
5134 5135 5136 5137

			/*
			 * main redo apply loop
			 */
5138 5139
			do
			{
5140
#ifdef WAL_DEBUG
V
WAL  
Vadim B. Mikheev 已提交
5141 5142
				if (XLOG_DEBUG)
				{
B
Bruce Momjian 已提交
5143
					StringInfoData buf;
V
WAL  
Vadim B. Mikheev 已提交
5144

5145 5146
					initStringInfo(&buf);
					appendStringInfo(&buf, "REDO @ %X/%X; LSN %X/%X: ",
B
Bruce Momjian 已提交
5147 5148
									 ReadRecPtr.xlogid, ReadRecPtr.xrecoff,
									 EndRecPtr.xlogid, EndRecPtr.xrecoff);
5149 5150 5151 5152
					xlog_outrec(&buf, record);
					appendStringInfo(&buf, " - ");
					RmgrTable[record->xl_rmid].rm_desc(&buf,
													   record->xl_info,
B
Bruce Momjian 已提交
5153
													 XLogRecGetData(record));
5154 5155
					elog(LOG, "%s", buf.data);
					pfree(buf.data);
V
WAL  
Vadim B. Mikheev 已提交
5156
				}
5157
#endif
V
WAL  
Vadim B. Mikheev 已提交
5158

5159 5160 5161 5162 5163
				/*
				 * Have we reached our recovery target?
				 */
				if (recoveryStopsHere(record, &recoveryApply))
				{
B
Bruce Momjian 已提交
5164
					reachedStopPoint = true;	/* see below */
5165 5166 5167 5168 5169
					recoveryContinue = false;
					if (!recoveryApply)
						break;
				}

5170 5171 5172 5173 5174 5175
				/* 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;

5176 5177
				/* nextXid must be beyond record's xid */
				if (TransactionIdFollowsOrEquals(record->xl_xid,
B
Bruce Momjian 已提交
5178
												 ShmemVariableCache->nextXid))
5179 5180 5181 5182 5183
				{
					ShmemVariableCache->nextXid = record->xl_xid;
					TransactionIdAdvance(ShmemVariableCache->nextXid);
				}

T
Tom Lane 已提交
5184
				if (record->xl_info & XLR_BKP_BLOCK_MASK)
5185 5186
					RestoreBkpBlocks(record, EndRecPtr);

5187
				RmgrTable[record->xl_rmid].rm_redo(EndRecPtr, record);
5188

5189 5190 5191
				/* Pop the error context stack */
				error_context_stack = errcontext.previous;

5192 5193
				LastRec = ReadRecPtr;

5194
				record = ReadRecord(NULL, LOG);
5195
			} while (record != NULL && recoveryContinue);
B
Bruce Momjian 已提交
5196

5197 5198 5199 5200
			/*
			 * end of main redo apply loop
			 */

5201 5202 5203
			ereport(LOG,
					(errmsg("redo done at %X/%X",
							ReadRecPtr.xlogid, ReadRecPtr.xrecoff)));
5204 5205
			if (recoveryLastXTime)
				ereport(LOG,
B
Bruce Momjian 已提交
5206 5207
					 (errmsg("last completed transaction was at log time %s",
							 timestamptz_to_str(recoveryLastXTime))));
V
WAL  
Vadim B. Mikheev 已提交
5208
			InRedo = false;
5209 5210
		}
		else
5211 5212
		{
			/* there are no WAL records following the checkpoint */
5213 5214
			ereport(LOG,
					(errmsg("redo is not required")));
5215
		}
V
WAL  
Vadim B. Mikheev 已提交
5216 5217
	}

T
Tom Lane 已提交
5218
	/*
B
Bruce Momjian 已提交
5219 5220
	 * 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 已提交
5221
	 */
5222
	record = ReadRecord(&LastRec, PANIC);
T
Tom Lane 已提交
5223
	EndOfLog = EndRecPtr;
5224 5225
	XLByteToPrevSeg(EndOfLog, endLogId, endLogSeg);

5226 5227 5228 5229
	/*
	 * Complain if we did not roll forward far enough to render the backup
	 * dump consistent.
	 */
5230
	if (XLByteLT(EndOfLog, ControlFile->minRecoveryPoint))
5231
	{
5232
		if (reachedStopPoint)	/* stopped because of stop request */
5233 5234
			ereport(FATAL,
					(errmsg("requested recovery stop point is before end time of backup dump")));
B
Bruce Momjian 已提交
5235
		else	/* ran off end of WAL */
5236 5237 5238 5239
			ereport(FATAL,
					(errmsg("WAL ends before end time of backup dump")));
	}

5240 5241 5242
	/*
	 * Consider whether we need to assign a new timeline ID.
	 *
B
Bruce Momjian 已提交
5243 5244
	 * If we are doing an archive recovery, we always assign a new ID.	This
	 * handles a couple of issues.	If we stopped short of the end of WAL
5245 5246
	 * during recovery, then we are clearly generating a new timeline and must
	 * assign it a unique new ID.  Even if we ran to the end, modifying the
B
Bruce Momjian 已提交
5247 5248
	 * current last segment is problematic because it may result in trying to
	 * overwrite an already-archived copy of that segment, and we encourage
5249 5250 5251 5252
	 * DBAs to make their archive_commands reject that.  We can dodge the
	 * problem by making the new active segment have a new timeline ID.
	 *
	 * In a normal crash recovery, we can just extend the timeline we were in.
5253
	 */
5254
	if (InArchiveRecovery)
5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265
	{
		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;

5266
	/*
B
Bruce Momjian 已提交
5267 5268 5269 5270
	 * 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.)
5271 5272
	 */
	if (InArchiveRecovery)
5273
		exitArchiveRecovery(curFileTLI, endLogId, endLogSeg);
5274 5275 5276 5277 5278 5279 5280 5281

	/*
	 * 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;
5282
	openLogFile = XLogFileOpen(openLogId, openLogSeg);
T
Tom Lane 已提交
5283
	openLogOff = 0;
V
WAL  
Vadim B. Mikheev 已提交
5284
	Insert = &XLogCtl->Insert;
5285
	Insert->PrevRecord = LastRec;
5286 5287
	XLogCtl->xlblocks[0].xlogid = openLogId;
	XLogCtl->xlblocks[0].xrecoff =
5288
		((EndOfLog.xrecoff - 1) / XLOG_BLCKSZ + 1) * XLOG_BLCKSZ;
B
Bruce Momjian 已提交
5289 5290

	/*
B
Bruce Momjian 已提交
5291 5292 5293
	 * 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 已提交
5294
	 */
5295 5296
	Assert(readOff == (XLogCtl->xlblocks[0].xrecoff - XLOG_BLCKSZ) % XLogSegSize);
	memcpy((char *) Insert->currpage, readBuf, XLOG_BLCKSZ);
5297
	Insert->currpos = (char *) Insert->currpage +
5298
		(EndOfLog.xrecoff + XLOG_BLCKSZ - XLogCtl->xlblocks[0].xrecoff);
V
WAL  
Vadim B. Mikheev 已提交
5299

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

T
Tom Lane 已提交
5302 5303 5304
	XLogCtl->Write.LogwrtResult = LogwrtResult;
	Insert->LogwrtResult = LogwrtResult;
	XLogCtl->LogwrtResult = LogwrtResult;
V
WAL  
Vadim B. Mikheev 已提交
5305

T
Tom Lane 已提交
5306 5307
	XLogCtl->LogwrtRqst.Write = EndOfLog;
	XLogCtl->LogwrtRqst.Flush = EndOfLog;
5308

5309 5310 5311 5312 5313 5314 5315 5316 5317 5318
	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 已提交
5319 5320
		 * Whenever Write.LogwrtResult points to exactly the end of a page,
		 * Write.curridx must point to the *next* page (see XLogWrite()).
5321
		 *
B
Bruce Momjian 已提交
5322
		 * Note: it might seem we should do AdvanceXLInsertBuffer() here, but
B
Bruce Momjian 已提交
5323
		 * this is sufficient.	The first actual attempt to insert a log
5324
		 * record will advance the insert state.
5325 5326 5327 5328
		 */
		XLogCtl->Write.curridx = NextBufIdx(0);
	}

5329 5330
	/* Pre-scan prepared transactions to find out the range of XIDs present */
	oldestActiveXID = PrescanPreparedTransactions();
5331

V
WAL  
Vadim B. Mikheev 已提交
5332
	if (InRecovery)
5333
	{
B
Bruce Momjian 已提交
5334
		int			rmid;
5335 5336 5337 5338 5339 5340 5341 5342 5343 5344

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

5345 5346 5347 5348 5349 5350
		/*
		 * Check to see if the XLOG sequence contained any unresolved
		 * references to uninitialized pages.
		 */
		XLogCheckInvalidPages();

5351 5352 5353 5354 5355
		/*
		 * Reset pgstat data, because it may be invalid after recovery.
		 */
		pgstat_reset_all();

T
Tom Lane 已提交
5356
		/*
5357
		 * Perform a checkpoint to update all our recovery activity to disk.
5358
		 *
5359 5360 5361 5362 5363
		 * 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 已提交
5364
		 */
5365
		CreateCheckPoint(CHECKPOINT_IS_SHUTDOWN | CHECKPOINT_IMMEDIATE);
5366 5367 5368 5369

		/*
		 * Close down recovery environment
		 */
V
WAL  
Vadim B. Mikheev 已提交
5370
		XLogCloseRelationCache();
5371
	}
5372

T
Tom Lane 已提交
5373 5374 5375
	/*
	 * Preallocate additional log files, if wanted.
	 */
5376
	PreallocXlogFiles(EndOfLog);
5377

5378 5379 5380
	/*
	 * Okay, we're officially UP.
	 */
V
WAL  
Vadim B. Mikheev 已提交
5381
	InRecovery = false;
5382 5383 5384 5385 5386

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

5387 5388 5389
	/* start the archive_timeout timer running */
	XLogCtl->Write.lastSegSwitchTime = ControlFile->time;

5390 5391 5392 5393
	/* initialize shared-memory copy of latest checkpoint XID/epoch */
	XLogCtl->ckptXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	XLogCtl->ckptXid = ControlFile->checkPointCopy.nextXid;

5394 5395 5396 5397
	/* also initialize latestCompletedXid, to nextXid - 1 */
	ShmemVariableCache->latestCompletedXid = ShmemVariableCache->nextXid;
	TransactionIdRetreat(ShmemVariableCache->latestCompletedXid);

5398
	/* Start up the commit log and related stuff, too */
5399
	StartupCLOG();
5400
	StartupSUBTRANS(oldestActiveXID);
5401
	StartupMultiXact();
5402

5403 5404 5405
	/* Reload shared-memory state for prepared transactions */
	RecoverPreparedTransactions();

T
Tom Lane 已提交
5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416
	/* Shut down readFile facility, free space */
	if (readFile >= 0)
	{
		close(readFile);
		readFile = -1;
	}
	if (readBuf)
	{
		free(readBuf);
		readBuf = NULL;
	}
5417 5418 5419 5420 5421 5422
	if (readRecordBuf)
	{
		free(readRecordBuf);
		readRecordBuf = NULL;
		readRecordBufSize = 0;
	}
T
Tom Lane 已提交
5423 5424
}

5425 5426
/*
 * Subroutine to try to fetch and validate a prior checkpoint record.
5427 5428 5429
 *
 * whichChkpt identifies the checkpoint (merely for reporting purposes).
 * 1 for "primary", 2 for "secondary", 0 for "other" (backup_label)
5430
 */
T
Tom Lane 已提交
5431
static XLogRecord *
5432
ReadCheckpointRecord(XLogRecPtr RecPtr, int whichChkpt)
T
Tom Lane 已提交
5433 5434 5435 5436 5437
{
	XLogRecord *record;

	if (!XRecOffIsValid(RecPtr.xrecoff))
	{
5438 5439 5440 5441
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5442
				(errmsg("invalid primary checkpoint link in control file")));
5443 5444 5445 5446 5447 5448 5449
				break;
			case 2:
				ereport(LOG,
						(errmsg("invalid secondary checkpoint link in control file")));
				break;
			default:
				ereport(LOG,
B
Bruce Momjian 已提交
5450
				   (errmsg("invalid checkpoint link in backup_label file")));
5451 5452
				break;
		}
T
Tom Lane 已提交
5453 5454 5455
		return NULL;
	}

5456
	record = ReadRecord(&RecPtr, LOG);
T
Tom Lane 已提交
5457 5458 5459

	if (record == NULL)
	{
5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474
		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 已提交
5475 5476 5477 5478
		return NULL;
	}
	if (record->xl_rmid != RM_XLOG_ID)
	{
5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490
		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 已提交
5491
				(errmsg("invalid resource manager ID in checkpoint record")));
5492 5493
				break;
		}
T
Tom Lane 已提交
5494 5495 5496 5497 5498
		return NULL;
	}
	if (record->xl_info != XLOG_CHECKPOINT_SHUTDOWN &&
		record->xl_info != XLOG_CHECKPOINT_ONLINE)
	{
5499 5500 5501 5502
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5503
				   (errmsg("invalid xl_info in primary checkpoint record")));
5504 5505 5506
				break;
			case 2:
				ereport(LOG,
B
Bruce Momjian 已提交
5507
				 (errmsg("invalid xl_info in secondary checkpoint record")));
5508 5509 5510 5511 5512 5513
				break;
			default:
				ereport(LOG,
						(errmsg("invalid xl_info in checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5514 5515
		return NULL;
	}
5516 5517
	if (record->xl_len != sizeof(CheckPoint) ||
		record->xl_tot_len != SizeOfXLogRecord + sizeof(CheckPoint))
T
Tom Lane 已提交
5518
	{
5519 5520 5521 5522
		switch (whichChkpt)
		{
			case 1:
				ereport(LOG,
B
Bruce Momjian 已提交
5523
					(errmsg("invalid length of primary checkpoint record")));
5524 5525 5526
				break;
			case 2:
				ereport(LOG,
B
Bruce Momjian 已提交
5527
				  (errmsg("invalid length of secondary checkpoint record")));
5528 5529 5530 5531 5532 5533
				break;
			default:
				ereport(LOG,
						(errmsg("invalid length of checkpoint record")));
				break;
		}
T
Tom Lane 已提交
5534 5535 5536
		return NULL;
	}
	return record;
5537 5538
}

V
WAL  
Vadim B. Mikheev 已提交
5539
/*
5540 5541
 * This must be called during startup of a backend process, except that
 * it need not be called in a standalone backend (which does StartupXLOG
5542
 * instead).  We need to initialize the local copies of ThisTimeLineID and
5543 5544
 * RedoRecPtr.
 *
5545
 * Note: before Postgres 8.0, we went to some effort to keep the postmaster
5546
 * process's copies of ThisTimeLineID and RedoRecPtr valid too.  This was
5547
 * unnecessary however, since the postmaster itself never touches XLOG anyway.
V
WAL  
Vadim B. Mikheev 已提交
5548 5549
 */
void
5550
InitXLOGAccess(void)
V
WAL  
Vadim B. Mikheev 已提交
5551
{
5552 5553
	/* ThisTimeLineID doesn't change so we need no lock to copy it */
	ThisTimeLineID = XLogCtl->ThisTimeLineID;
5554 5555
	/* Use GetRedoRecPtr to copy the RedoRecPtr safely */
	(void) GetRedoRecPtr();
5556 5557 5558 5559 5560 5561 5562 5563
}

/*
 * 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
5564 5565
GetRedoRecPtr(void)
{
5566 5567 5568
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;

5569
	SpinLockAcquire(&xlogctl->info_lck);
5570 5571
	Assert(XLByteLE(RedoRecPtr, xlogctl->Insert.RedoRecPtr));
	RedoRecPtr = xlogctl->Insert.RedoRecPtr;
5572
	SpinLockRelease(&xlogctl->info_lck);
5573 5574

	return RedoRecPtr;
V
WAL  
Vadim B. Mikheev 已提交
5575 5576
}

5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590
/*
 * GetInsertRecPtr -- Returns the current insert position.
 *
 * NOTE: The value *actually* returned is the position of the last full
 * xlog page. It lags behind the real insert position by at most 1 page.
 * For that, we don't need to acquire WALInsertLock which can be quite
 * heavily contended, and an approximation is enough for the current
 * usage of this function.
 */
XLogRecPtr
GetInsertRecPtr(void)
{
	/* use volatile pointer to prevent code rearrangement */
	volatile XLogCtlData *xlogctl = XLogCtl;
B
Bruce Momjian 已提交
5591
	XLogRecPtr	recptr;
5592 5593 5594 5595 5596 5597 5598 5599

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

	return recptr;
}

5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615
/*
 * 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;
}

5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626
/*
 * 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 已提交
5627 5628 5629
	uint32		ckptXidEpoch;
	TransactionId ckptXid;
	TransactionId nextXid;
5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655

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

5656
/*
T
Tom Lane 已提交
5657
 * This must be called ONCE during postmaster or standalone-backend shutdown
5658 5659
 */
void
5660
ShutdownXLOG(int code, Datum arg)
5661
{
5662 5663
	ereport(LOG,
			(errmsg("shutting down")));
5664

5665
	CreateCheckPoint(CHECKPOINT_IS_SHUTDOWN | CHECKPOINT_IMMEDIATE);
5666
	ShutdownCLOG();
5667
	ShutdownSUBTRANS();
5668
	ShutdownMultiXact();
5669

5670 5671
	ereport(LOG,
			(errmsg("database system is shut down")));
5672 5673
}

5674
/*
5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688
 * Log start of a checkpoint.
 */
static void
LogCheckpointStart(int flags)
{
	elog(LOG, "checkpoint starting:%s%s%s%s%s%s",
		 (flags & CHECKPOINT_IS_SHUTDOWN) ? " shutdown" : "",
		 (flags & CHECKPOINT_IMMEDIATE) ? " immediate" : "",
		 (flags & CHECKPOINT_FORCE) ? " force" : "",
		 (flags & CHECKPOINT_WAIT) ? " wait" : "",
		 (flags & CHECKPOINT_CAUSE_XLOG) ? " xlog" : "",
		 (flags & CHECKPOINT_CAUSE_TIME) ? " time" : "");
}

5689
/*
5690 5691 5692 5693 5694
 * Log end of a checkpoint.
 */
static void
LogCheckpointEnd(void)
{
B
Bruce Momjian 已提交
5695 5696 5697 5698 5699 5700
	long		write_secs,
				sync_secs,
				total_secs;
	int			write_usecs,
				sync_usecs,
				total_usecs;
5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723

	CheckpointStats.ckpt_end_t = GetCurrentTimestamp();

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

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

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

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

T
Tom Lane 已提交
5729 5730
/*
 * Perform a checkpoint --- either during shutdown, or on-the-fly
5731
 *
5732 5733 5734
 * flags is a bitwise OR of the following:
 *	CHECKPOINT_IS_SHUTDOWN: checkpoint is for database shutdown.
 *	CHECKPOINT_IMMEDIATE: finish the checkpoint ASAP,
5735
 *		ignoring checkpoint_completion_target parameter.
5736 5737 5738
 *	CHECKPOINT_FORCE: force a checkpoint even if no XLOG activity has occured
 *		since the last one (implied by CHECKPOINT_IS_SHUTDOWN).
 *
5739
 * Note: flags contains other bits, of interest here only for logging purposes.
5740 5741
 * In particular note that this routine is synchronous and does not pay
 * attention to CHECKPOINT_WAIT.
T
Tom Lane 已提交
5742
 */
5743
void
5744
CreateCheckPoint(int flags)
5745
{
5746
	bool		shutdown = (flags & CHECKPOINT_IS_SHUTDOWN) != 0;
5747 5748 5749
	CheckPoint	checkPoint;
	XLogRecPtr	recptr;
	XLogCtlInsert *Insert = &XLogCtl->Insert;
B
Bruce Momjian 已提交
5750
	XLogRecData rdata;
5751
	uint32		freespace;
V
Vadim B. Mikheev 已提交
5752 5753
	uint32		_logId;
	uint32		_logSeg;
5754 5755
	TransactionId *inCommitXids;
	int			nInCommit;
V
Vadim B. Mikheev 已提交
5756

5757
	/*
B
Bruce Momjian 已提交
5758 5759 5760 5761
	 * 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.)
5762
	 */
5763
	LWLockAcquire(CheckpointLock, LW_EXCLUSIVE);
5764

5765 5766 5767 5768 5769 5770 5771 5772 5773 5774
	/*
	 * Prepare to accumulate statistics.
	 *
	 * Note: because it is possible for log_checkpoints to change while a
	 * checkpoint proceeds, we always accumulate stats, even if
	 * log_checkpoints is currently off.
	 */
	MemSet(&CheckpointStats, 0, sizeof(CheckpointStats));
	CheckpointStats.ckpt_start_t = GetCurrentTimestamp();

5775 5776 5777
	/*
	 * Use a critical section to force system panic if we have trouble.
	 */
5778 5779
	START_CRIT_SECTION();

5780 5781 5782 5783 5784 5785
	if (shutdown)
	{
		ControlFile->state = DB_SHUTDOWNING;
		ControlFile->time = time(NULL);
		UpdateControlFile();
	}
T
Tom Lane 已提交
5786

5787
	/*
B
Bruce Momjian 已提交
5788 5789 5790
	 * Let smgr prepare for checkpoint; this has to happen before we determine
	 * the REDO pointer.  Note that smgr must not do anything that'd have to
	 * be undone if we decide no checkpoint is needed.
5791 5792 5793 5794
	 */
	smgrpreckpt();

	/* Begin filling in the checkpoint WAL record */
5795
	MemSet(&checkPoint, 0, sizeof(checkPoint));
5796
	checkPoint.ThisTimeLineID = ThisTimeLineID;
T
Tom Lane 已提交
5797
	checkPoint.time = time(NULL);
5798

5799
	/*
5800 5801
	 * We must hold WALInsertLock while examining insert state to determine
	 * the checkpoint REDO pointer.
5802
	 */
5803
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
T
Tom Lane 已提交
5804 5805

	/*
B
Bruce Momjian 已提交
5806 5807 5808 5809 5810 5811 5812 5813
	 * 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 已提交
5814
	 *
5815 5816 5817 5818
	 * 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 已提交
5819
	 */
5820
	if ((flags & (CHECKPOINT_IS_SHUTDOWN | CHECKPOINT_FORCE)) == 0)
T
Tom Lane 已提交
5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832
	{
		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)
		{
5833 5834
			LWLockRelease(WALInsertLock);
			LWLockRelease(CheckpointLock);
T
Tom Lane 已提交
5835 5836 5837 5838 5839 5840 5841 5842
			END_CRIT_SECTION();
			return;
		}
	}

	/*
	 * Compute new REDO record ptr = location of next XLOG record.
	 *
B
Bruce Momjian 已提交
5843 5844 5845 5846
	 * 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 已提交
5847 5848
	 */
	freespace = INSERT_FREESPACE(Insert);
5849 5850
	if (freespace < SizeOfXLogRecord)
	{
5851
		(void) AdvanceXLInsertBuffer(false);
T
Tom Lane 已提交
5852
		/* OK to ignore update return flag, since we will do flush anyway */
5853
		freespace = INSERT_FREESPACE(Insert);
5854
	}
T
Tom Lane 已提交
5855
	INSERT_RECPTR(checkPoint.redo, Insert, Insert->curridx);
B
Bruce Momjian 已提交
5856

T
Tom Lane 已提交
5857
	/*
B
Bruce Momjian 已提交
5858 5859
	 * Here we update the shared RedoRecPtr for future XLogInsert calls; this
	 * must be done while holding the insert lock AND the info_lck.
5860
	 *
B
Bruce Momjian 已提交
5861
	 * Note: if we fail to complete the checkpoint, RedoRecPtr will be left
B
Bruce Momjian 已提交
5862 5863 5864 5865 5866
	 * 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 已提交
5867
	 */
5868 5869 5870 5871
	{
		/* use volatile pointer to prevent code rearrangement */
		volatile XLogCtlData *xlogctl = XLogCtl;

5872
		SpinLockAcquire(&xlogctl->info_lck);
5873
		RedoRecPtr = xlogctl->Insert.RedoRecPtr = checkPoint.redo;
5874
		SpinLockRelease(&xlogctl->info_lck);
5875
	}
B
Bruce Momjian 已提交
5876

T
Tom Lane 已提交
5877
	/*
5878 5879
	 * Now we can release WAL insert lock, allowing other xacts to proceed
	 * while we are flushing disk buffers.
T
Tom Lane 已提交
5880
	 */
5881
	LWLockRelease(WALInsertLock);
5882

5883
	/*
B
Bruce Momjian 已提交
5884 5885
	 * If enabled, log checkpoint start.  We postpone this until now so as not
	 * to log anything if we decided to skip the checkpoint.
5886 5887 5888
	 */
	if (log_checkpoints)
		LogCheckpointStart(flags);
5889

5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904
	/*
	 * Before flushing data, we must wait for any transactions that are
	 * currently in their commit critical sections.  If an xact inserted its
	 * commit record into XLOG just before the REDO point, then a crash
	 * restart from the REDO point would not replay that record, which means
	 * that our flushing had better include the xact's update of pg_clog.  So
	 * we wait till he's out of his commit critical section before proceeding.
	 * See notes in RecordTransactionCommit().
	 *
	 * Because we've already released WALInsertLock, this test is a bit fuzzy:
	 * it is possible that we will wait for xacts we didn't really need to
	 * wait for.  But the delay should be short and it seems better to make
	 * checkpoint take a bit longer than to hold locks longer than necessary.
	 * (In fact, the whole reason we have this issue is that xact.c does
	 * commit record XLOG insertion and clog update as two separate steps
B
Bruce Momjian 已提交
5905 5906
	 * protected by different locks, but again that seems best on grounds of
	 * minimizing lock contention.)
5907
	 *
B
Bruce Momjian 已提交
5908 5909
	 * A transaction that has not yet set inCommit when we look cannot be at
	 * risk, since he's not inserted his commit record yet; and one that's
5910 5911 5912 5913 5914 5915 5916
	 * already cleared it is not at risk either, since he's done fixing clog
	 * and we will correctly flush the update below.  So we cannot miss any
	 * xacts we need to wait for.
	 */
	nInCommit = GetTransactionsInCommit(&inCommitXids);
	if (nInCommit > 0)
	{
B
Bruce Momjian 已提交
5917 5918 5919
		do
		{
			pg_usleep(10000L);	/* wait for 10 msec */
5920 5921 5922 5923
		} while (HaveTransactionsInCommit(inCommitXids, nInCommit));
	}
	pfree(inCommitXids);

5924 5925 5926
	/*
	 * Get the other info we need for the checkpoint record.
	 */
5927
	LWLockAcquire(XidGenLock, LW_SHARED);
5928
	checkPoint.nextXid = ShmemVariableCache->nextXid;
5929
	LWLockRelease(XidGenLock);
T
Tom Lane 已提交
5930

5931 5932 5933 5934 5935
	/* Increase XID epoch if we've wrapped around since last checkpoint */
	checkPoint.nextXidEpoch = ControlFile->checkPointCopy.nextXidEpoch;
	if (checkPoint.nextXid < ControlFile->checkPointCopy.nextXid)
		checkPoint.nextXidEpoch++;

5936
	LWLockAcquire(OidGenLock, LW_SHARED);
5937
	checkPoint.nextOid = ShmemVariableCache->nextOid;
5938 5939
	if (!shutdown)
		checkPoint.nextOid += ShmemVariableCache->oidCount;
5940
	LWLockRelease(OidGenLock);
5941

5942 5943 5944
	MultiXactGetCheckptMulti(shutdown,
							 &checkPoint.nextMulti,
							 &checkPoint.nextMultiOffset);
5945

T
Tom Lane 已提交
5946
	/*
B
Bruce Momjian 已提交
5947 5948
	 * Having constructed the checkpoint record, ensure all shmem disk buffers
	 * and commit-log buffers are flushed to disk.
5949
	 *
5950 5951
	 * 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
5952
	 * panic. Accordingly, exit critical section while doing it.
T
Tom Lane 已提交
5953
	 */
5954 5955
	END_CRIT_SECTION();

5956
	CheckPointGuts(checkPoint.redo, flags);
5957

5958 5959
	START_CRIT_SECTION();

T
Tom Lane 已提交
5960 5961 5962
	/*
	 * Now insert the checkpoint record into XLOG.
	 */
B
Bruce Momjian 已提交
5963
	rdata.data = (char *) (&checkPoint);
5964
	rdata.len = sizeof(checkPoint);
5965
	rdata.buffer = InvalidBuffer;
5966 5967
	rdata.next = NULL;

T
Tom Lane 已提交
5968 5969 5970 5971 5972 5973
	recptr = XLogInsert(RM_XLOG_ID,
						shutdown ? XLOG_CHECKPOINT_SHUTDOWN :
						XLOG_CHECKPOINT_ONLINE,
						&rdata);

	XLogFlush(recptr);
5974

T
Tom Lane 已提交
5975
	/*
B
Bruce Momjian 已提交
5976 5977
	 * We now have ProcLastRecPtr = start of actual checkpoint record, recptr
	 * = end of actual checkpoint record.
T
Tom Lane 已提交
5978 5979
	 */
	if (shutdown && !XLByteEQ(checkPoint.redo, ProcLastRecPtr))
5980 5981
		ereport(PANIC,
				(errmsg("concurrent transaction log activity while database system is shutting down")));
5982

T
Tom Lane 已提交
5983
	/*
5984 5985
	 * Select point at which we can truncate the log, which we base on the
	 * prior checkpoint's earliest info.
T
Tom Lane 已提交
5986
	 */
5987
	XLByteToSeg(ControlFile->checkPointCopy.redo, _logId, _logSeg);
5988

T
Tom Lane 已提交
5989 5990 5991
	/*
	 * Update the control file.
	 */
5992
	LWLockAcquire(ControlFileLock, LW_EXCLUSIVE);
5993 5994
	if (shutdown)
		ControlFile->state = DB_SHUTDOWNED;
T
Tom Lane 已提交
5995 5996 5997
	ControlFile->prevCheckPoint = ControlFile->checkPoint;
	ControlFile->checkPoint = ProcLastRecPtr;
	ControlFile->checkPointCopy = checkPoint;
5998 5999
	ControlFile->time = time(NULL);
	UpdateControlFile();
6000
	LWLockRelease(ControlFileLock);
6001

6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012
	/* 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);
	}

6013
	/*
B
Bruce Momjian 已提交
6014
	 * We are now done with critical updates; no need for system panic if we
6015
	 * have trouble while fooling with old log segments.
6016 6017 6018
	 */
	END_CRIT_SECTION();

6019 6020 6021 6022 6023
	/*
	 * Let smgr do post-checkpoint cleanup (eg, deleting old files).
	 */
	smgrpostckpt();

V
Vadim B. Mikheev 已提交
6024
	/*
6025
	 * Delete old log files (those no longer needed even for previous
T
Tom Lane 已提交
6026
	 * checkpoint).
V
Vadim B. Mikheev 已提交
6027 6028 6029
	 */
	if (_logId || _logSeg)
	{
T
Tom Lane 已提交
6030
		PrevLogSeg(_logId, _logSeg);
6031
		RemoveOldXlogFiles(_logId, _logSeg, recptr);
V
Vadim B. Mikheev 已提交
6032 6033
	}

T
Tom Lane 已提交
6034
	/*
6035 6036
	 * Make more log segments if needed.  (Do this after recycling old log
	 * segments, since that may supply some of the needed files.)
T
Tom Lane 已提交
6037 6038
	 */
	if (!shutdown)
6039
		PreallocXlogFiles(recptr);
T
Tom Lane 已提交
6040

6041
	/*
B
Bruce Momjian 已提交
6042 6043 6044 6045 6046
	 * 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.
6047
	 */
6048
	if (!InRecovery)
6049
		TruncateSUBTRANS(GetOldestXmin(true, false));
6050

6051 6052 6053
	/* All real work is done, but log before releasing lock. */
	if (log_checkpoints)
		LogCheckpointEnd();
6054

6055
	LWLockRelease(CheckpointLock);
6056
}
V
WAL  
Vadim B. Mikheev 已提交
6057

6058 6059 6060 6061 6062 6063 6064
/*
 * Flush all data in shared memory to disk, and fsync
 *
 * This is the common code shared between regular checkpoints and
 * recovery restartpoints.
 */
static void
6065
CheckPointGuts(XLogRecPtr checkPointRedo, int flags)
6066 6067 6068 6069
{
	CheckPointCLOG();
	CheckPointSUBTRANS();
	CheckPointMultiXact();
B
Bruce Momjian 已提交
6070
	CheckPointBuffers(flags);	/* performs all required fsyncs */
6071 6072 6073 6074 6075 6076 6077
	/* We deliberately delay 2PC checkpointing as long as possible */
	CheckPointTwoPhase(checkPointRedo);
}

/*
 * Set a recovery restart point if appropriate
 *
6078
 * This is similar to CreateCheckPoint, but is used during WAL recovery
6079 6080 6081 6082 6083 6084 6085 6086
 * 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 已提交
6087 6088
	int			elapsed_secs;
	int			rmid;
6089 6090

	/*
B
Bruce Momjian 已提交
6091 6092
	 * Do nothing if the elapsed time since the last restartpoint is less than
	 * half of checkpoint_timeout.	(We use a value less than
6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112
	 * 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()))
6113 6114 6115 6116 6117
			{
				elog(DEBUG2, "RM %d not safe to record restart point at %X/%X",
					 rmid,
					 checkPoint->redo.xlogid,
					 checkPoint->redo.xrecoff);
6118
				return;
6119
			}
6120 6121 6122 6123 6124
	}

	/*
	 * OK, force data out to disk
	 */
6125
	CheckPointGuts(checkPoint->redo, CHECKPOINT_IMMEDIATE);
6126 6127

	/*
B
Bruce Momjian 已提交
6128 6129 6130
	 * Update pg_control so that any subsequent crash will restart from this
	 * checkpoint.	Note: ReadRecPtr gives the XLOG address of the checkpoint
	 * record itself.
6131 6132 6133 6134 6135 6136 6137
	 */
	ControlFile->prevCheckPoint = ControlFile->checkPoint;
	ControlFile->checkPoint = ReadRecPtr;
	ControlFile->checkPointCopy = *checkPoint;
	ControlFile->time = time(NULL);
	UpdateControlFile();

6138
	ereport((recoveryLogRestartpoints ? LOG : DEBUG2),
6139 6140
			(errmsg("recovery restart point at %X/%X",
					checkPoint->redo.xlogid, checkPoint->redo.xrecoff)));
6141 6142 6143 6144
	if (recoveryLastXTime)
		ereport((recoveryLogRestartpoints ? LOG : DEBUG2),
				(errmsg("last completed transaction was at log time %s",
						timestamptz_to_str(recoveryLastXTime))));
6145 6146
}

T
Tom Lane 已提交
6147 6148 6149
/*
 * Write a NEXTOID log record
 */
6150 6151 6152
void
XLogPutNextOid(Oid nextOid)
{
B
Bruce Momjian 已提交
6153
	XLogRecData rdata;
6154

B
Bruce Momjian 已提交
6155
	rdata.data = (char *) (&nextOid);
6156
	rdata.len = sizeof(Oid);
6157
	rdata.buffer = InvalidBuffer;
6158 6159
	rdata.next = NULL;
	(void) XLogInsert(RM_XLOG_ID, XLOG_NEXTOID, &rdata);
B
Bruce Momjian 已提交
6160

6161 6162
	/*
	 * We need not flush the NEXTOID record immediately, because any of the
B
Bruce Momjian 已提交
6163 6164 6165 6166 6167
	 * 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.
6168 6169
	 *
	 * Note, however, that the above statement only covers state "within" the
B
Bruce Momjian 已提交
6170 6171
	 * 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
6172
	 * change may reach disk before the NEXTOID WAL record does.  The impact
B
Bruce Momjian 已提交
6173 6174 6175 6176 6177
	 * 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.
6178 6179 6180
	 */
}

6181 6182 6183 6184 6185 6186 6187 6188 6189 6190
/*
 * 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.
 */
6191
XLogRecPtr
6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207
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 已提交
6208 6209 6210
/*
 * XLOG resource manager's routines
 */
V
WAL  
Vadim B. Mikheev 已提交
6211 6212 6213
void
xlog_redo(XLogRecPtr lsn, XLogRecord *record)
{
B
Bruce Momjian 已提交
6214
	uint8		info = record->xl_info & ~XLR_INFO_MASK;
6215

6216
	if (info == XLOG_NEXTOID)
6217
	{
B
Bruce Momjian 已提交
6218
		Oid			nextOid;
6219 6220 6221

		memcpy(&nextOid, XLogRecGetData(record), sizeof(Oid));
		if (ShmemVariableCache->nextOid < nextOid)
T
Tom Lane 已提交
6222
		{
6223
			ShmemVariableCache->nextOid = nextOid;
T
Tom Lane 已提交
6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235
			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;
6236 6237
		MultiXactSetNextMXact(checkPoint.nextMulti,
							  checkPoint.nextMultiOffset);
B
Bruce Momjian 已提交
6238

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

6243
		/*
B
Bruce Momjian 已提交
6244
		 * TLI may change in a shutdown checkpoint, but it shouldn't decrease
6245 6246 6247 6248 6249 6250 6251 6252
		 */
		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 已提交
6253
								checkPoint.ThisTimeLineID, ThisTimeLineID)));
6254 6255 6256
			/* Following WAL records should be run with new TLI */
			ThisTimeLineID = checkPoint.ThisTimeLineID;
		}
6257 6258

		RecoveryRestartPoint(&checkPoint);
T
Tom Lane 已提交
6259 6260 6261 6262 6263 6264
	}
	else if (info == XLOG_CHECKPOINT_ONLINE)
	{
		CheckPoint	checkPoint;

		memcpy(&checkPoint, XLogRecGetData(record), sizeof(CheckPoint));
6265
		/* In an ONLINE checkpoint, treat the counters like NEXTOID */
6266 6267
		if (TransactionIdPrecedes(ShmemVariableCache->nextXid,
								  checkPoint.nextXid))
T
Tom Lane 已提交
6268 6269 6270 6271 6272 6273
			ShmemVariableCache->nextXid = checkPoint.nextXid;
		if (ShmemVariableCache->nextOid < checkPoint.nextOid)
		{
			ShmemVariableCache->nextOid = checkPoint.nextOid;
			ShmemVariableCache->oidCount = 0;
		}
6274 6275
		MultiXactAdvanceNextMXact(checkPoint.nextMulti,
								  checkPoint.nextMultiOffset);
6276 6277 6278 6279 6280

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

6281 6282
		/* TLI should not change in an on-line checkpoint */
		if (checkPoint.ThisTimeLineID != ThisTimeLineID)
6283
			ereport(PANIC,
6284 6285
					(errmsg("unexpected timeline ID %u (should be %u) in checkpoint record",
							checkPoint.ThisTimeLineID, ThisTimeLineID)));
6286 6287

		RecoveryRestartPoint(&checkPoint);
6288
	}
6289 6290 6291 6292
	else if (info == XLOG_NOOP)
	{
		/* nothing to do here */
	}
6293 6294 6295 6296
	else if (info == XLOG_SWITCH)
	{
		/* nothing to do here */
	}
V
WAL  
Vadim B. Mikheev 已提交
6297
}
B
Bruce Momjian 已提交
6298

V
WAL  
Vadim B. Mikheev 已提交
6299
void
6300
xlog_desc(StringInfo buf, uint8 xl_info, char *rec)
V
WAL  
Vadim B. Mikheev 已提交
6301
{
B
Bruce Momjian 已提交
6302
	uint8		info = xl_info & ~XLR_INFO_MASK;
V
WAL  
Vadim B. Mikheev 已提交
6303

T
Tom Lane 已提交
6304 6305
	if (info == XLOG_CHECKPOINT_SHUTDOWN ||
		info == XLOG_CHECKPOINT_ONLINE)
V
WAL  
Vadim B. Mikheev 已提交
6306
	{
B
Bruce Momjian 已提交
6307 6308
		CheckPoint *checkpoint = (CheckPoint *) rec;

6309
		appendStringInfo(buf, "checkpoint: redo %X/%X; "
B
Bruce Momjian 已提交
6310 6311 6312 6313 6314 6315 6316 6317
						 "tli %u; xid %u/%u; oid %u; multi %u; offset %u; %s",
						 checkpoint->redo.xlogid, checkpoint->redo.xrecoff,
						 checkpoint->ThisTimeLineID,
						 checkpoint->nextXidEpoch, checkpoint->nextXid,
						 checkpoint->nextOid,
						 checkpoint->nextMulti,
						 checkpoint->nextMultiOffset,
				 (info == XLOG_CHECKPOINT_SHUTDOWN) ? "shutdown" : "online");
T
Tom Lane 已提交
6318
	}
6319 6320 6321 6322
	else if (info == XLOG_NOOP)
	{
		appendStringInfo(buf, "xlog no-op");
	}
6323 6324
	else if (info == XLOG_NEXTOID)
	{
B
Bruce Momjian 已提交
6325
		Oid			nextOid;
6326 6327

		memcpy(&nextOid, rec, sizeof(Oid));
6328
		appendStringInfo(buf, "nextOid: %u", nextOid);
6329
	}
6330 6331 6332 6333
	else if (info == XLOG_SWITCH)
	{
		appendStringInfo(buf, "xlog switch");
	}
V
WAL  
Vadim B. Mikheev 已提交
6334
	else
6335
		appendStringInfo(buf, "UNKNOWN");
V
WAL  
Vadim B. Mikheev 已提交
6336 6337
}

6338
#ifdef WAL_DEBUG
6339

V
WAL  
Vadim B. Mikheev 已提交
6340
static void
6341
xlog_outrec(StringInfo buf, XLogRecord *record)
V
WAL  
Vadim B. Mikheev 已提交
6342
{
B
Bruce Momjian 已提交
6343
	int			i;
6344

6345
	appendStringInfo(buf, "prev %X/%X; xid %u",
6346 6347
					 record->xl_prev.xlogid, record->xl_prev.xrecoff,
					 record->xl_xid);
6348

6349
	for (i = 0; i < XLR_MAX_BKP_BLOCKS; i++)
6350
	{
6351
		if (record->xl_info & XLR_SET_BKP_BLOCK(i))
B
Bruce Momjian 已提交
6352
			appendStringInfo(buf, "; bkpb%d", i + 1);
6353 6354
	}

6355
	appendStringInfo(buf, ": %s", RmgrTable[record->xl_rmid].rm_name);
V
WAL  
Vadim B. Mikheev 已提交
6356
}
B
Bruce Momjian 已提交
6357
#endif   /* WAL_DEBUG */
6358 6359 6360


/*
6361
 * GUC support
6362
 */
6363
const char *
6364
assign_xlog_sync_method(const char *method, bool doit, GucSource source)
6365
{
B
Bruce Momjian 已提交
6366 6367
	int			new_sync_method;
	int			new_sync_bit;
6368

6369
	if (pg_strcasecmp(method, "fsync") == 0)
6370 6371 6372 6373
	{
		new_sync_method = SYNC_METHOD_FSYNC;
		new_sync_bit = 0;
	}
6374 6375 6376 6377 6378 6379 6380
#ifdef HAVE_FSYNC_WRITETHROUGH
	else if (pg_strcasecmp(method, "fsync_writethrough") == 0)
	{
		new_sync_method = SYNC_METHOD_FSYNC_WRITETHROUGH;
		new_sync_bit = 0;
	}
#endif
6381
#ifdef HAVE_FDATASYNC
6382
	else if (pg_strcasecmp(method, "fdatasync") == 0)
6383 6384 6385 6386 6387 6388
	{
		new_sync_method = SYNC_METHOD_FDATASYNC;
		new_sync_bit = 0;
	}
#endif
#ifdef OPEN_SYNC_FLAG
6389
	else if (pg_strcasecmp(method, "open_sync") == 0)
6390 6391 6392 6393 6394 6395
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_SYNC_FLAG;
	}
#endif
#ifdef OPEN_DATASYNC_FLAG
6396
	else if (pg_strcasecmp(method, "open_datasync") == 0)
6397 6398 6399 6400 6401 6402
	{
		new_sync_method = SYNC_METHOD_OPEN;
		new_sync_bit = OPEN_DATASYNC_FLAG;
	}
#endif
	else
6403
		return NULL;
6404

6405 6406 6407
	if (!doit)
		return method;

6408 6409 6410
	if (sync_method != new_sync_method || open_sync_bit != new_sync_bit)
	{
		/*
B
Bruce Momjian 已提交
6411 6412
		 * 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 已提交
6413 6414
		 * changing, close the log file so it will be reopened (with new flag
		 * bit) at next use.
6415 6416 6417 6418
		 */
		if (openLogFile >= 0)
		{
			if (pg_fsync(openLogFile) != 0)
6419 6420
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6421 6422
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6423
			if (open_sync_bit != new_sync_bit)
6424
				XLogFileClose();
6425 6426 6427 6428
		}
		sync_method = new_sync_method;
		open_sync_bit = new_sync_bit;
	}
6429 6430

	return method;
6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441
}


/*
 * Issue appropriate kind of fsync (if any) on the current XLOG output file
 */
static void
issue_xlog_fsync(void)
{
	switch (sync_method)
	{
6442
		case SYNC_METHOD_FSYNC:
6443
			if (pg_fsync_no_writethrough(openLogFile) != 0)
6444 6445
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6446 6447
						 errmsg("could not fsync log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6448
			break;
6449 6450 6451 6452 6453
#ifdef HAVE_FSYNC_WRITETHROUGH
		case SYNC_METHOD_FSYNC_WRITETHROUGH:
			if (pg_fsync_writethrough(openLogFile) != 0)
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6454 6455
						 errmsg("could not fsync write-through log file %u, segment %u: %m",
								openLogId, openLogSeg)));
6456 6457
			break;
#endif
6458 6459 6460
#ifdef HAVE_FDATASYNC
		case SYNC_METHOD_FDATASYNC:
			if (pg_fdatasync(openLogFile) != 0)
6461 6462
				ereport(PANIC,
						(errcode_for_file_access(),
B
Bruce Momjian 已提交
6463 6464
					errmsg("could not fdatasync log file %u, segment %u: %m",
						   openLogId, openLogSeg)));
6465 6466 6467 6468 6469 6470
			break;
#endif
		case SYNC_METHOD_OPEN:
			/* write synced it already */
			break;
		default:
6471
			elog(PANIC, "unrecognized wal_sync_method: %d", sync_method);
6472 6473 6474
			break;
	}
}
6475 6476 6477 6478 6479 6480 6481 6482 6483


/*
 * 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
6484
 * starting WAL location for the dump.
6485 6486 6487 6488 6489 6490 6491
 */
Datum
pg_start_backup(PG_FUNCTION_ARGS)
{
	text	   *backupid = PG_GETARG_TEXT_P(0);
	text	   *result;
	char	   *backupidstr;
6492
	XLogRecPtr	checkpointloc;
6493
	XLogRecPtr	startpoint;
6494
	pg_time_t	stamp_time;
6495 6496 6497 6498 6499 6500 6501
	char		strfbuf[128];
	char		xlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	struct stat stat_buf;
	FILE	   *fp;

B
Bruce Momjian 已提交
6502
	if (!superuser())
6503 6504
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
6505
				 errmsg("must be superuser to run a backup")));
6506 6507 6508 6509

	if (!XLogArchivingActive())
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
6510 6511 6512 6513 6514 6515 6516 6517 6518
				 errmsg("WAL archiving is not active"),
				 errhint("archive_mode must be enabled at server start.")));

	if (!XLogArchiveCommandSet())
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
				 errmsg("WAL archiving is not active"),
				 errhint("archive_command must be defined before "
						 "online backups can be made safely.")));
6519

6520
	backupidstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6521
												 PointerGetDatum(backupid)));
B
Bruce Momjian 已提交
6522

6523
	/*
6524 6525 6526
	 * 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 已提交
6527 6528 6529 6530 6531 6532 6533 6534 6535
	 * 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.)
6536
	 *
B
Bruce Momjian 已提交
6537 6538
	 * We must hold WALInsertLock to change the value of forcePageWrites, to
	 * ensure adequate interlocking against XLogInsert().
6539
	 */
6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550
	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 已提交
6551

6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564
	/*
	 * Force an XLOG file switch before the checkpoint, to ensure that the WAL
	 * segment the checkpoint is written to doesn't contain pages with old
	 * timeline IDs. That would otherwise happen if you called
	 * pg_start_backup() right after restoring from a PITR archive: the first
	 * WAL segment containing the startup checkpoint has pages in the
	 * beginning with the old timeline ID. That can cause trouble at recovery:
	 * we won't have a history file covering the old timeline if pg_xlog
	 * directory was not included in the base backup and the WAL archive was
	 * cleared too before starting the backup.
	 */
	RequestXLogSwitch();

6565 6566
	/* Ensure we release forcePageWrites if fail below */
	PG_ENSURE_ERROR_CLEANUP(pg_start_backup_callback, (Datum) 0);
6567 6568
	{
		/*
B
Bruce Momjian 已提交
6569
		 * Force a CHECKPOINT.	Aside from being necessary to prevent torn
6570 6571 6572
		 * 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.
6573 6574
		 *
		 * We don't use CHECKPOINT_IMMEDIATE, hence this can take awhile.
6575
		 */
6576
		RequestCheckpoint(CHECKPOINT_FORCE | CHECKPOINT_WAIT);
6577

6578 6579 6580 6581 6582 6583 6584 6585 6586
		/*
		 * 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 已提交
6587

6588 6589
		XLByteToSeg(startpoint, _logId, _logSeg);
		XLogFileName(xlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6590

6591 6592 6593 6594 6595
		/* Use the log timezone here, not the session timezone */
		stamp_time = (pg_time_t) time(NULL);
		pg_strftime(strfbuf, sizeof(strfbuf),
					"%Y-%m-%d %H:%M:%S %Z",
					pg_localtime(&stamp_time, log_timezone));
6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621

		/*
		 * 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)
6622 6623
			ereport(ERROR,
					(errcode_for_file_access(),
6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635
					 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",
6636
							BACKUP_LABEL_FILE)));
6637
	}
6638
	PG_END_ENSURE_ERROR_CLEANUP(pg_start_backup_callback, (Datum) 0);
B
Bruce Momjian 已提交
6639

6640
	/*
6641
	 * We're done.  As a convenience, return the starting WAL location.
6642 6643 6644 6645
	 */
	snprintf(xlogfilename, sizeof(xlogfilename), "%X/%X",
			 startpoint.xlogid, startpoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6646
											 CStringGetDatum(xlogfilename)));
6647 6648 6649
	PG_RETURN_TEXT_P(result);
}

6650 6651 6652 6653 6654 6655 6656 6657 6658 6659
/* Error cleanup callback for pg_start_backup */
static void
pg_start_backup_callback(int code, Datum arg)
{
	/* Turn off forcePageWrites on failure */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
	XLogCtl->Insert.forcePageWrites = false;
	LWLockRelease(WALInsertLock);
}

6660 6661 6662 6663 6664 6665
/*
 * 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
6666
 * the label file, plus the backup-end time and WAL location.
6667 6668 6669 6670 6671 6672 6673
 */
Datum
pg_stop_backup(PG_FUNCTION_ARGS)
{
	text	   *result;
	XLogRecPtr	startpoint;
	XLogRecPtr	stoppoint;
6674
	pg_time_t	stamp_time;
6675
	char		strfbuf[128];
6676
	char		histfilepath[MAXPGPATH];
6677 6678 6679 6680 6681 6682 6683 6684 6685
	char		startxlogfilename[MAXFNAMELEN];
	char		stopxlogfilename[MAXFNAMELEN];
	uint32		_logId;
	uint32		_logSeg;
	FILE	   *lfp;
	FILE	   *fp;
	char		ch;
	int			ich;

B
Bruce Momjian 已提交
6686
	if (!superuser())
6687 6688 6689
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
				 (errmsg("must be superuser to run a backup"))));
B
Bruce Momjian 已提交
6690

6691
	/*
6692
	 * OK to clear forcePageWrites
6693 6694
	 */
	LWLockAcquire(WALInsertLock, LW_EXCLUSIVE);
6695
	XLogCtl->Insert.forcePageWrites = false;
6696 6697
	LWLockRelease(WALInsertLock);

6698
	/*
B
Bruce Momjian 已提交
6699 6700 6701
	 * 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.
6702 6703 6704
	 */
	stoppoint = RequestXLogSwitch();

6705
	XLByteToPrevSeg(stoppoint, _logId, _logSeg);
6706
	XLogFileName(stopxlogfilename, ThisTimeLineID, _logId, _logSeg);
B
Bruce Momjian 已提交
6707

6708 6709 6710 6711 6712
	/* Use the log timezone here, not the session timezone */
	stamp_time = (pg_time_t) time(NULL);
	pg_strftime(strfbuf, sizeof(strfbuf),
				"%Y-%m-%d %H:%M:%S %Z",
				pg_localtime(&stamp_time, log_timezone));
B
Bruce Momjian 已提交
6713

6714 6715 6716
	/*
	 * Open the existing label file
	 */
6717
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
6718 6719 6720 6721 6722 6723
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(ERROR,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
6724
							BACKUP_LABEL_FILE)));
6725 6726 6727 6728
		ereport(ERROR,
				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
				 errmsg("a backup is not in progress")));
	}
B
Bruce Momjian 已提交
6729

6730
	/*
B
Bruce Momjian 已提交
6731 6732
	 * Read and parse the START WAL LOCATION line (this code is pretty crude,
	 * but we are not expecting any variability in the file format).
6733 6734 6735 6736 6737 6738
	 */
	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),
6739
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6740

6741 6742 6743 6744
	/*
	 * Write the backup history file
	 */
	XLByteToSeg(startpoint, _logId, _logSeg);
6745
	BackupHistoryFilePath(histfilepath, ThisTimeLineID, _logId, _logSeg,
6746
						  startpoint.xrecoff % XLogSegSize);
6747
	fp = AllocateFile(histfilepath, "w");
6748 6749 6750 6751
	if (!fp)
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not create file \"%s\": %m",
6752
						histfilepath)));
6753 6754 6755 6756
	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);
6757
	/* transfer remaining lines from label to history file */
6758 6759 6760 6761 6762 6763 6764
	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",
6765
						histfilepath)));
B
Bruce Momjian 已提交
6766

6767 6768 6769 6770 6771 6772 6773
	/*
	 * 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",
6774 6775
						BACKUP_LABEL_FILE)));
	if (unlink(BACKUP_LABEL_FILE) != 0)
6776 6777 6778
		ereport(ERROR,
				(errcode_for_file_access(),
				 errmsg("could not remove file \"%s\": %m",
6779
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
6780

6781
	/*
B
Bruce Momjian 已提交
6782 6783 6784
	 * 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.
6785
	 */
6786
	CleanupBackupHistory();
B
Bruce Momjian 已提交
6787

6788
	/*
6789
	 * We're done.  As a convenience, return the ending WAL location.
6790 6791 6792 6793
	 */
	snprintf(stopxlogfilename, sizeof(stopxlogfilename), "%X/%X",
			 stoppoint.xlogid, stoppoint.xrecoff);
	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6794
										 CStringGetDatum(stopxlogfilename)));
6795 6796
	PG_RETURN_TEXT_P(result);
}
6797

6798 6799 6800 6801 6802 6803 6804
/*
 * pg_switch_xlog: switch to next xlog file
 */
Datum
pg_switch_xlog(PG_FUNCTION_ARGS)
{
	text	   *result;
B
Bruce Momjian 已提交
6805
	XLogRecPtr	switchpoint;
6806 6807 6808 6809 6810
	char		location[MAXFNAMELEN];

	if (!superuser())
		ereport(ERROR,
				(errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
B
Bruce Momjian 已提交
6811
			 (errmsg("must be superuser to switch transaction log files"))));
6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825

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

/*
6826 6827 6828 6829 6830
 * 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.
6831 6832 6833
 */
Datum
pg_current_xlog_location(PG_FUNCTION_ARGS)
6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862
{
	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)
6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903
{
	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 已提交
6904 6905 6906 6907 6908
	Datum		values[2];
	bool		isnull[2];
	TupleDesc	resultTupleDesc;
	HeapTuple	resultHeapTuple;
	Datum		result;
6909

6910 6911 6912
	/*
	 * Read input and parse
	 */
6913
	locationstr = DatumGetCString(DirectFunctionCall1(textout,
B
Bruce Momjian 已提交
6914
												 PointerGetDatum(location)));
6915 6916 6917 6918

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6919
				 errmsg("could not parse transaction log location \"%s\"",
6920 6921 6922 6923 6924
						locationstr)));

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

6925
	/*
B
Bruce Momjian 已提交
6926 6927
	 * Construct a tuple descriptor for the result row.  This must match this
	 * function's pg_proc entry!
6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939
	 */
	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
	 */
6940 6941 6942
	XLByteToPrevSeg(locationpoint, xlogid, xlogseg);
	XLogFileName(xlogfilename, ThisTimeLineID, xlogid, xlogseg);

6943 6944 6945 6946 6947 6948 6949
	values[0] = DirectFunctionCall1(textin,
									CStringGetDatum(xlogfilename));
	isnull[0] = false;

	/*
	 * offset
	 */
6950 6951
	xrecoff = locationpoint.xrecoff - xlogseg * XLogSegSize;

6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962
	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);
6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982
}

/*
 * 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 已提交
6983
												 PointerGetDatum(location)));
6984 6985 6986 6987

	if (sscanf(locationstr, "%X/%X", &uxlogid, &uxrecoff) != 2)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
P
Peter Eisentraut 已提交
6988
				 errmsg("could not parse transaction log location \"%s\"",
6989 6990 6991 6992 6993 6994 6995 6996 6997
						locationstr)));

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

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

	result = DatumGetTextP(DirectFunctionCall1(textin,
B
Bruce Momjian 已提交
6998
											 CStringGetDatum(xlogfilename)));
6999 7000 7001
	PG_RETURN_TEXT_P(result);
}

7002 7003 7004 7005 7006
/*
 * 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 已提交
7007
 * identified by the label file, NOT what pg_control says.	This avoids the
7008 7009 7010 7011 7012
 * 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.
7013
 * If successful, set *minRecoveryLoc to constrain valid PITR stopping
7014 7015 7016 7017 7018 7019
 * points.
 *
 * Returns TRUE if a backup_label was found (and fills the checkpoint
 * location into *checkPointLoc); returns FALSE if not.
 */
static bool
7020
read_backup_label(XLogRecPtr *checkPointLoc, XLogRecPtr *minRecoveryLoc)
7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034
{
	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;

7035 7036 7037 7038
	/* Default is to not constrain recovery stop point */
	minRecoveryLoc->xlogid = 0;
	minRecoveryLoc->xrecoff = 0;

7039 7040 7041
	/*
	 * See if label file is present
	 */
7042
	lfp = AllocateFile(BACKUP_LABEL_FILE, "r");
7043 7044 7045 7046 7047 7048
	if (!lfp)
	{
		if (errno != ENOENT)
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
7049
							BACKUP_LABEL_FILE)));
7050 7051
		return false;			/* it's not there, all is fine */
	}
B
Bruce Momjian 已提交
7052

7053
	/*
B
Bruce Momjian 已提交
7054 7055 7056
	 * 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).
7057 7058 7059 7060 7061 7062
	 */
	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),
7063
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
7064 7065 7066 7067 7068
	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),
7069
				 errmsg("invalid data in file \"%s\"", BACKUP_LABEL_FILE)));
7070 7071 7072 7073
	if (ferror(lfp) || FreeFile(lfp))
		ereport(FATAL,
				(errcode_for_file_access(),
				 errmsg("could not read file \"%s\": %m",
7074
						BACKUP_LABEL_FILE)));
B
Bruce Momjian 已提交
7075

7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088
	/*
	 * 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 已提交
7089
	fp = AllocateFile(histfilepath, "r");
7090 7091 7092 7093 7094 7095
	if (fp)
	{
		/*
		 * Parse history file to identify stop point.
		 */
		if (fscanf(fp, "START WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
7096
				   &startpoint.xlogid, &startpoint.xrecoff, startxlogfilename,
7097 7098 7099
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
7100
					 errmsg("invalid data in file \"%s\"", histfilename)));
7101
		if (fscanf(fp, "STOP WAL LOCATION: %X/%X (file %24s)%c",
B
Bruce Momjian 已提交
7102
				   &stoppoint.xlogid, &stoppoint.xrecoff, stopxlogfilename,
7103 7104 7105
				   &ch) != 4 || ch != '\n')
			ereport(FATAL,
					(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
B
Bruce Momjian 已提交
7106
					 errmsg("invalid data in file \"%s\"", histfilename)));
7107
		*minRecoveryLoc = stoppoint;
7108 7109 7110 7111 7112 7113 7114 7115 7116 7117
		if (ferror(fp) || FreeFile(fp))
			ereport(FATAL,
					(errcode_for_file_access(),
					 errmsg("could not read file \"%s\": %m",
							histfilepath)));
	}

	return true;
}

7118 7119 7120 7121 7122 7123
/*
 * Error context callback for errors occurring during rm_redo().
 */
static void
rm_redo_error_callback(void *arg)
{
B
Bruce Momjian 已提交
7124 7125
	XLogRecord *record = (XLogRecord *) arg;
	StringInfoData buf;
7126 7127

	initStringInfo(&buf);
7128 7129
	RmgrTable[record->xl_rmid].rm_desc(&buf,
									   record->xl_info,
7130 7131 7132 7133 7134 7135 7136 7137
									   XLogRecGetData(record));

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

	pfree(buf.data);
}