xlogrecord.h File Reference

#include "access/rmgr.h"
#include "access/xlogdefs.h"
#include "port/pg_crc32c.h"
#include "storage/block.h"
#include "storage/relfilenode.h"

Include dependency graph for xlogrecord.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	XLogRecord
struct	XLogRecordBlockHeader
struct	XLogRecordBlockImageHeader
struct	XLogRecordBlockCompressHeader
struct	XLogRecordDataHeaderShort
struct	XLogRecordDataHeaderLong

Macros
#define	SizeOfXLogRecord   (offsetof(XLogRecord, xl_crc) + sizeof(pg_crc32c))
#define	XLR_INFO_MASK   0x0F
#define	XLR_RMGR_INFO_MASK   0xF0
#define	XLR_SPECIAL_REL_UPDATE   0x01
#define	XLR_CHECK_CONSISTENCY   0x02
#define	SizeOfXLogRecordBlockHeader   (offsetof(XLogRecordBlockHeader, data_length) + sizeof(uint16))
#define	SizeOfXLogRecordBlockImageHeader   (offsetof(XLogRecordBlockImageHeader, bimg_info) + sizeof(uint8))
#define	BKPIMAGE_HAS_HOLE   0x01 /* page image has "hole" */
#define	BKPIMAGE_IS_COMPRESSED   0x02 /* page image is compressed */
#define	BKPIMAGE_APPLY
#define	SizeOfXLogRecordBlockCompressHeader   sizeof(XLogRecordBlockCompressHeader)
#define	MaxSizeOfXLogRecordBlockHeader
#define	BKPBLOCK_FORK_MASK   0x0F
#define	BKPBLOCK_FLAG_MASK   0xF0
#define	BKPBLOCK_HAS_IMAGE   0x10 /* block data is an XLogRecordBlockImage */
#define	BKPBLOCK_HAS_DATA   0x20
#define	BKPBLOCK_WILL_INIT   0x40 /* redo will re-init the page */
#define	BKPBLOCK_SAME_REL   0x80 /* RelFileNode omitted, same as previous */
#define	SizeOfXLogRecordDataHeaderShort   (sizeof(uint8) * 2)
#define	SizeOfXLogRecordDataHeaderLong   (sizeof(uint8) + sizeof(uint32))
#define	XLR_MAX_BLOCK_ID   32
#define	XLR_BLOCK_ID_DATA_SHORT   255
#define	XLR_BLOCK_ID_DATA_LONG   254
#define	XLR_BLOCK_ID_ORIGIN   253

Typedefs
typedef struct XLogRecord	XLogRecord
typedef struct XLogRecordBlockHeader	XLogRecordBlockHeader
typedef struct XLogRecordBlockImageHeader	XLogRecordBlockImageHeader
typedef struct XLogRecordBlockCompressHeader	XLogRecordBlockCompressHeader
typedef struct XLogRecordDataHeaderShort	XLogRecordDataHeaderShort
typedef struct XLogRecordDataHeaderLong	XLogRecordDataHeaderLong

Macro Definition Documentation

#define BKPBLOCK_FLAG_MASK   0xF0

Definition at line 180 of file xlogrecord.h.

#define BKPBLOCK_FORK_MASK   0x0F

Definition at line 179 of file xlogrecord.h.

Referenced by DecodeXLogRecord().

#define BKPBLOCK_HAS_DATA   0x20

Definition at line 182 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), and XLogRecordAssemble().

#define BKPBLOCK_HAS_IMAGE   0x10 /* block data is an XLogRecordBlockImage */

Definition at line 181 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), and XLogRecordAssemble().

#define BKPBLOCK_SAME_REL   0x80 /* RelFileNode omitted, same as previous */

Definition at line 184 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), and XLogRecordAssemble().

#define BKPBLOCK_WILL_INIT   0x40 /* redo will re-init the page */

Definition at line 183 of file xlogrecord.h.

Referenced by XLogReadBufferForRedoExtended(), and XLogRecordAssemble().

#define BKPIMAGE_APPLY

Value:

0x04    /* page image should be restored during
                                     * replay */

Definition at line 149 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), and XLogRecordAssemble().

#define BKPIMAGE_HAS_HOLE   0x01 /* page image has "hole" */

Definition at line 147 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), and XLogRecordAssemble().

#define BKPIMAGE_IS_COMPRESSED   0x02 /* page image is compressed */

Definition at line 148 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), RestoreBlockImage(), XLogDumpDisplayRecord(), and XLogRecordAssemble().

#define MaxSizeOfXLogRecordBlockHeader

Value:

(SizeOfXLogRecordBlockHeader + \
	 SizeOfXLogRecordBlockImageHeader + \
	 SizeOfXLogRecordBlockCompressHeader + \
     sizeof(RelFileNode) + \
     sizeof(BlockNumber))

Definition at line 168 of file xlogrecord.h.

#define SizeOfXLogRecord   (offsetof(XLogRecord, xl_crc) + sizeof(pg_crc32c))

Definition at line 55 of file xlogrecord.h.

Referenced by BootStrapXLOG(), CopyXLogRecordToWAL(), DecodeXLogRecord(), ReadCheckpointRecord(), ReserveXLogInsertLocation(), ReserveXLogSwitch(), ValidXLogRecord(), ValidXLogRecordHeader(), WriteEmptyXLOG(), XLogInsertRecord(), XLogReadRecord(), and XLogRecordAssemble().

#define SizeOfXLogRecordBlockCompressHeader   sizeof(XLogRecordBlockCompressHeader)

Definition at line 161 of file xlogrecord.h.

Referenced by XLogCompressBackupBlock(), and XLogRecordAssemble().

#define SizeOfXLogRecordBlockHeader   (offsetof(XLogRecordBlockHeader, data_length) + sizeof(uint16))

Definition at line 104 of file xlogrecord.h.

Referenced by XLogRecordAssemble().

#define SizeOfXLogRecordBlockImageHeader   (offsetof(XLogRecordBlockImageHeader, bimg_info) + sizeof(uint8))

Definition at line 143 of file xlogrecord.h.

Referenced by XLogRecordAssemble().

#define SizeOfXLogRecordDataHeaderLong   (sizeof(uint8) + sizeof(uint32))

Definition at line 209 of file xlogrecord.h.

#define SizeOfXLogRecordDataHeaderShort   (sizeof(uint8) * 2)

Definition at line 201 of file xlogrecord.h.

Referenced by BootStrapXLOG(), ReadCheckpointRecord(), and WriteEmptyXLOG().

#define XLR_BLOCK_ID_DATA_LONG   254

Definition at line 225 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), and XLogRecordAssemble().

#define XLR_BLOCK_ID_DATA_SHORT   255

Definition at line 224 of file xlogrecord.h.

Referenced by BootStrapXLOG(), DecodeXLogRecord(), WriteEmptyXLOG(), and XLogRecordAssemble().

#define XLR_BLOCK_ID_ORIGIN   253

Definition at line 226 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), and XLogRecordAssemble().

#define XLR_CHECK_CONSISTENCY   0x02

Definition at line 80 of file xlogrecord.h.

Referenced by checkXLogConsistency(), StartupXLOG(), XLogInsert(), and XLogRecordAssemble().

#define XLR_INFO_MASK   0x0F

Definition at line 62 of file xlogrecord.h.

Referenced by brin_desc(), brin_identify(), brin_redo(), btree_desc(), btree_identify(), btree_redo(), clog_desc(), clog_identify(), clog_redo(), commit_ts_desc(), commit_ts_redo(), dbase_desc(), dbase_identify(), dbase_redo(), DecodeLogicalMsgOp(), DecodeStandbyOp(), DecodeXLogOp(), extractPageInfo(), findLastCheckpoint(), getRecordTimestamp(), gin_desc(), gin_identify(), gin_redo(), gist_desc(), gist_identify(), gist_redo(), hash_desc(), hash_identify(), hash_redo(), heap2_desc(), heap2_identify(), heap2_redo(), heap_desc(), heap_identify(), heap_redo(), logicalmsg_desc(), logicalmsg_identify(), logicalmsg_redo(), multixact_desc(), multixact_identify(), multixact_redo(), ReadCheckpointRecord(), recoveryStopsAfter(), relmap_desc(), relmap_identify(), relmap_redo(), replorigin_desc(), replorigin_redo(), seq_desc(), seq_identify(), seq_redo(), smgr_desc(), smgr_identify(), smgr_redo(), spg_desc(), spg_identify(), spg_redo(), standby_desc(), standby_identify(), standby_redo(), StartupXLOG(), tblspc_desc(), tblspc_identify(), tblspc_redo(), xlog_desc(), xlog_identify(), xlog_outdesc(), xlog_redo(), XLogDumpDisplayRecord(), XLogInsertRecord(), and XLogReadRecord().

#define XLR_MAX_BLOCK_ID   32

Definition at line 222 of file xlogrecord.h.

Referenced by DecodeXLogRecord(), XLogEnsureRecordSpace(), and XLogReaderFree().

#define XLR_RMGR_INFO_MASK   0xF0

Definition at line 63 of file xlogrecord.h.

Referenced by XLogInsert().

#define XLR_SPECIAL_REL_UPDATE   0x01

Definition at line 71 of file xlogrecord.h.

Referenced by createdb(), extractPageInfo(), log_smgrcreate(), movedb(), pg_truncate_visibility_map(), RelationTruncate(), remove_dbtablespaces(), and XLogInsert().

Typedef Documentation

typedef struct XLogRecord XLogRecord

typedef struct XLogRecordBlockCompressHeader XLogRecordBlockCompressHeader

typedef struct XLogRecordBlockHeader XLogRecordBlockHeader

typedef struct XLogRecordBlockImageHeader XLogRecordBlockImageHeader

typedef struct XLogRecordDataHeaderLong XLogRecordDataHeaderLong

typedef struct XLogRecordDataHeaderShort XLogRecordDataHeaderShort