wal

Documentation

Overview

Package wal provides an implementation of a write ahead log that is used by etcd.

A WAL is created at a particular directory and is made up of a number of discrete WAL files. Inside of each file the raft state and entries are appended to it with the Save method:

metadata := []byte{}
w, err := wal.Create("/var/lib/etcd", metadata)
...
err := w.Save(s, ents)

After saving an raft snapshot to disk, SaveSnapshot method should be called to record it. So WAL can match with the saved snapshot when restarting.

err := w.SaveSnapshot(walpb.Snapshot{Index: 10, Term: 2})

When a user has finished using a WAL it must be closed:

w.Close()

WAL files are placed inside of the directory in the following format: $seq-$index.wal

The first WAL file to be created will be 0000000000000000-0000000000000000.wal indicating an initial sequence of 0 and an initial raft index of 0. The first entry written to WAL MUST have raft index 0.

Periodically a user will want to "cut" the WAL and place new entries into a new file. This will increment an internal sequence number and cause a new file to be created. If the last raft index saved was 0x20 and this is the first time Cut has been called on this WAL then the sequence will increment from 0x0 to 0x1. The new file will be: 0000000000000001-0000000000000021.wal. If a second Cut issues 0x10 entries with incremental index later then the file will be called: 0000000000000002-0000000000000031.wal.

At a later time a WAL can be opened at a particular snapshot. If there is no snapshot, an empty snapshot should be passed in.

w, err := wal.Open("/var/lib/etcd", walpb.Snapshot{Index: 10, Term: 2})
...

The snapshot must have been written to the WAL.

Additional items cannot be Saved to this WAL until all of the items from the given snapshot to the end of the WAL are read first:

metadata, state, ents, err := w.ReadAll()

This will give you the metadata, the last raft.State and the slice of raft.Entry items in the log.

Index

• Variables
• func Exist(dirpath string) bool
• func MultiReadCloser(readClosers ...io.ReadCloser) io.ReadCloser
• type WAL
  • func Create(dirpath string, metadata []byte) (*WAL, error)
  • func Open(dirpath string, snap walpb.Snapshot) (*WAL, error)
  • func OpenNotInUse(dirpath string, snap walpb.Snapshot) (*WAL, error)
  • func (w *WAL) Close() error
  • func (w *WAL) Cut() error
  • func (w *WAL) ReadAll() (metadata []byte, state raftpb.HardState, ents []raftpb.Entry, err error)
  • func (w *WAL) ReleaseLockTo(index uint64) error
  • func (w *WAL) Save(st raftpb.HardState, ents []raftpb.Entry) error
  • func (w *WAL) SaveSnapshot(e walpb.Snapshot) error
• type WalVersion
  • func DetectVersion(dirpath string) (WalVersion, error)

Variables

var (
	ErrMetadataConflict = errors.New("wal: conflicting metadata found")
	ErrFileNotFound     = errors.New("wal: file not found")
	ErrCRCMismatch      = errors.New("wal: crc mismatch")
	ErrSnapshotMismatch = errors.New("wal: snapshot mismatch")
	ErrSnapshotNotFound = errors.New("wal: snapshot not found")
)

Functions

func Exist

func Exist(dirpath string) bool

func MultiReadCloser

func MultiReadCloser(readClosers ...io.ReadCloser) io.ReadCloser

Types

type WAL

type WAL struct {
	// contains filtered or unexported fields
}

WAL is a logical repersentation of the stable storage. WAL is either in read mode or append mode but not both. A newly created WAL is in append mode, and ready for appending records. A just opened WAL is in read mode, and ready for reading records. The WAL will be ready for appending after reading out all the previous records.

func Create

func Create(dirpath string, metadata []byte) (*WAL, error)

Create creates a WAL ready for appending records. The given metadata is recorded at the head of each WAL file, and can be retrieved with ReadAll.

func Open

func Open(dirpath string, snap walpb.Snapshot) (*WAL, error)

Open opens the WAL at the given snap. The snap SHOULD have been previously saved to the WAL, or the following ReadAll will fail. The returned WAL is ready to read and the first record will be the one after the given snap. The WAL cannot be appended to before reading out all of its previous records.

func OpenNotInUse

func OpenNotInUse(dirpath string, snap walpb.Snapshot) (*WAL, error)

OpenNotInUse only opens the wal files that are not in use. Other than that, it is similar to Open.

func (*WAL) Close

func (w *WAL) Close() error

func (*WAL) Cut

func (w *WAL) Cut() error

Cut closes current file written and creates a new one ready to append.

func (*WAL) ReadAll

func (w *WAL) ReadAll() (metadata []byte, state raftpb.HardState, ents []raftpb.Entry, err error)

ReadAll reads out all records of the current WAL. If it cannot read out the expected snap, it will return ErrSnapshotNotFound. If loaded snap doesn't match with the expected one, it will return all the records and error ErrSnapshotMismatch. TODO: detect not-last-snap error. TODO: maybe loose the checking of match. After ReadAll, the WAL will be ready for appending new records.

func (*WAL) ReleaseLockTo

func (w *WAL) ReleaseLockTo(index uint64) error

ReleaseLockTo releases the locks w is holding, which have index smaller or equal to the given index.

func (*WAL) Save

func (w *WAL) Save(st raftpb.HardState, ents []raftpb.Entry) error

func (*WAL) SaveSnapshot

func (w *WAL) SaveSnapshot(e walpb.Snapshot) error

type WalVersion

type WalVersion string

WalVersion is an enum for versions of etcd logs.

const (
	WALUnknown  WalVersion = "Unknown WAL"
	WALNotExist WalVersion = "No WAL"
	WALv0_4     WalVersion = "0.4.x"
	WALv0_5     WalVersion = "0.5.x"
)

func DetectVersion

func DetectVersion(dirpath string) (WalVersion, error)