chaitanyaphalak / shreplic

A tool that simplifies the implementation of consensus/broadcast/replication protocols

shreplic

Shreplic is a framework that simplifies the implementation of broadcast protocols for SMR-replication in message-passing systems where any minority of processes can fail by crashing. Based on message definitions it automatically generates "boring" communication and marshaling code and embeds it in the main application.

Originally fork of Pierre Sutra's fork of epaxos, shreplic improves on both of its predecessors by fixing several bugs and adding new protocols and functionality.

Installation

go get github.com/vonaka/shreplic
go install github.com/vonaka/shreplic
shreplic -i

Supported protocols

Name	Comments
Paxos	Sutra's version with some minor fixes.
N2Paxos	All-to-all variant of Paxos.
Epaxos	Sutra's version with no changes whatsoever.
Paxoi	-
CURP	-

Add new protocol

To add a new protocol named shmaxos, first create a go file with the message definitions, let's call it def.go. Each message is a go structure, which name starts with a capital M:

package shmaxos

import "github.com/vonaka/shreplic/state"

type M2A struct {
	Replica int32
	Ballot  int32
	Cmd     state.Command
	CmdSlot int
}

type M2B struct {
	Replica int32
	Ballot  int32
	CmdSlot int
}

Then pass this definition to shreplic:

shreplic -n shmaxos -msg def.go

This will generate the following tree:

shmaxos
├── defs.go
├── Makefile
├── proto.go
└── shmaxos.go

After editing shmaxos.go run shreplic -i.

Usage

First start master, which coordinates communications between clients and (in this case three) servers:

shr-master -N 3

Run each server with the appropriate options:

shr-server -shmaxos

Once all servers are ready start a client:

shr-client -q 100