xlog_record_header.go

package walparser

import (
	"fmt"

	"github.com/pkg/errors"
	"github.com/wal-g/tracelog"
)

const (
	// info flags

	XlrInfoMask     = 0x0F
	XlrRmgrInfoMask = 0xF0

	XlrSpecialRelUpdate  = 0x01
	XlrCheckConsistency  = 0x02
	XLogRecordHeaderSize = 24
)

type InconsistentXLogRecordTotalLengthError struct {
	error
}

func NewInconsistentXLogRecordTotalLengthError(totalRecordLength uint32) InconsistentXLogRecordTotalLengthError {
	return InconsistentXLogRecordTotalLengthError{
		errors.Errorf("total record length is too small: %v, expected at least: %v",
			totalRecordLength, XLogRecordHeaderSize),
	}
}

func (err InconsistentXLogRecordTotalLengthError) Error() string {
	return fmt.Sprintf(tracelog.GetErrorFormatter(), err.error)
}

type InvalidXLogRecordResourceManagerIDError struct {
	error
}

func NewInvalidXLogRecordResourceManagerIDError(resourceManagerID uint8) InvalidXLogRecordResourceManagerIDError {
	return InvalidXLogRecordResourceManagerIDError{
		errors.Errorf("resource manager id is invalid: %v, while it should be less than: %v",
			resourceManagerID, RmNextFreeID),
	}
}

func (err InvalidXLogRecordResourceManagerIDError) Error() string {
	return fmt.Sprintf(tracelog.GetErrorFormatter(), err.error)
}

type ZeroRecordHeaderError struct {
	error
}

func NewZeroRecordHeaderError() ZeroRecordHeaderError {
	return ZeroRecordHeaderError{
		errors.New(
			"whole record header is zero, maybe it's parsed from .partial file or after WAL-Switch operation"),
	}
}

func (err ZeroRecordHeaderError) Error() string {
	return fmt.Sprintf(tracelog.GetErrorFormatter(), err.error)
}

/* This struct corresponds to postgres struct XLogRecord.
 * For clarification you can find it in postgres:
 * src/include/access/xlogrecord.h
 */
type XLogRecordHeader struct {
	TotalRecordLength uint32
	XactID            uint32
	PrevRecordPtr     XLogRecordPtr
	Info              uint8
	ResourceManagerID uint8
	/* 2 bytes of padding here, initialize to zero */
	Crc32Hash uint32
	/* XLogRecordBlockHeaders and XLogRecordDataHeader follow, no padding */
}

func (header *XLogRecordHeader) checkTotalRecordLengthConsistency() error {
	if header.TotalRecordLength < XLogRecordHeaderSize {
		return NewInconsistentXLogRecordTotalLengthError(header.TotalRecordLength)
	}
	return nil
}

func (header *XLogRecordHeader) checkResourceManagerIDValidity() error {
	if header.ResourceManagerID >= RmNextFreeID {
		return NewInvalidXLogRecordResourceManagerIDError(header.ResourceManagerID)
	}
	return nil
}

func (header *XLogRecordHeader) checkConsistency() error {
	err := header.checkTotalRecordLengthConsistency()
	if err != nil {
		if header.isZero() {
			return NewZeroRecordHeaderError()
		}
		return err
	}
	return header.checkResourceManagerIDValidity()
}

func (header *XLogRecordHeader) isZero() bool {
	return header.TotalRecordLength == 0 &&
		header.XactID == 0 &&
		header.PrevRecordPtr == 0 &&
		header.Info == 0 &&
		header.ResourceManagerID == 0 &&
		header.Crc32Hash == 0
}