ipfs-cluster/consensus.go

package ipfscluster

import (
	"context"
	"errors"

	host "gx/ipfs/QmPTGbC34bPKaUm9wTxBo7zSCac7pDuG42ZmnXC718CKZZ/go-libp2p-host"
	consensus "gx/ipfs/QmZ88KbrvZMJpXaNwAGffswcYKz8EbeafzAFGMCA6MEZKt/go-libp2p-consensus"
	libp2praft "gx/ipfs/QmdHo2LQKmGQ6rDAWFxnzNuW3z8b6Xmw3wEFsMQaj9Rsqj/go-libp2p-raft"
	peer "gx/ipfs/QmfMmLGoKzCHDN7cGgk64PJr4iipzidDRME8HABSJqvmhC/go-libp2p-peer"

	cid "gx/ipfs/QmcTcsTvfaeEBRFo1TkFgT8sRmgi1n1LTZpecfVP8fzpGD/go-cid"
)

const (
	maxSnapshots   = 5
	raftSingleMode = true
)

// Type of pin operation
const (
	LogOpPin = iota + 1
	LogOpUnpin
)

type clusterLogOpType int

// clusterLogOp represents an operation for the OpLogConsensus system.
// It implements the consensus.Op interface.
type clusterLogOp struct {
	Cid   string
	Type  clusterLogOpType
	ctx   context.Context
	rpcCh chan ClusterRPC
}

// ApplyTo applies the operation to the ClusterState
func (op clusterLogOp) ApplyTo(cstate consensus.State) (consensus.State, error) {
	state, ok := cstate.(ClusterState)
	var err error
	if !ok {
		// Should never be here
		panic("Received unexpected state type")
	}

	cidObj, err := cid.Decode(op.Cid)
	if err != nil {
		// Should never be here
		panic("Could not decode a CID we ourselves encoded")
	}

	async_op := func(try, success RPCMethod, c *cid.Cid) {
		ctx, cancel := context.WithCancel(op.ctx)
		defer cancel()
		resp := MakeRPC(ctx, op.rpcCh, RPC(try, *c), true)
		if resp.Error != nil {
			MakeRPC(ctx, op.rpcCh, RPC(StatePinError, *c), false)
		} else {
			logger.Debugf("Pinop (%d) success", try)
			MakeRPC(ctx, op.rpcCh, RPC(success, *c), false)
		}
	}

	switch op.Type {
	case LogOpPin:
		if state.ShouldPin(cidObj) {
			err = state.Pinning(cidObj)
			if err != nil {
				goto ROLLBACK
			}
			go async_op(IPFSPinRPC, StatePinSuccess, cidObj)
		} else {
			err = state.Pinned(cidObj)
			if err != nil {
				goto ROLLBACK
			}
		}
	case LogOpUnpin:
		err = state.Unpinning(cidObj)
		if err != nil {
			goto ROLLBACK
		}
		go async_op(IPFSUnpinRPC, StateUnpinSuccess, cidObj)
	default:
		logger.Error("unknown clusterLogOp type. Ignoring")
	}
	return state, nil

ROLLBACK:
	// We failed to apply the operation to the state
	// and therefore we need to request a rollback to the
	// cluster to the previous state. This operation can only be performed
	// by the cluster leader.
	rllbckRPC := RPC(RollbackRPC, state)
	leadrRPC := RPC(LeaderRPC, rllbckRPC)
	ctx, cancel := context.WithCancel(op.ctx)
	defer cancel()
	MakeRPC(ctx, op.rpcCh, leadrRPC, false)
	logger.Errorf("an error ocurred when applying Op to state: %s", err)
	logger.Error("a rollback was requested")
	// Make sure the consensus algorithm nows this update did not work
	return nil, errors.New("a rollback was requested. Reason: " + err.Error())
}

// ClusterConsensus handles the work of keeping a shared-state between
// the members of an IPFS Cluster, as well as modifying that state and
// applying any updates in a thread-safe manner.
type ClusterConsensus struct {
	ctx    context.Context
	cancel context.CancelFunc

	consensus consensus.OpLogConsensus
	actor     consensus.Actor

	rpcCh chan ClusterRPC

	p2pRaft *libp2pRaftWrap
}

// NewClusterConsensus builds a new ClusterConsensus component. The state
// is used to initialize the Consensus system, so any information in it
// is discarded.
func NewClusterConsensus(cfg *ClusterConfig, host host.Host, state ClusterState) (*ClusterConsensus, error) {
	logger.Info("Starting Consensus component")
	ctx, cancel := context.WithCancel(context.Background())
	rpcCh := make(chan ClusterRPC, RPCMaxQueue)
	op := clusterLogOp{
		ctx:   ctx,
		rpcCh: rpcCh,
	}
	con, actor, wrapper, err := makeLibp2pRaft(cfg, host, state, op)
	if err != nil {
		return nil, err
	}

	con.SetActor(actor)

	cc := &ClusterConsensus{
		ctx:       ctx,
		cancel:    cancel,
		consensus: con,
		actor:     actor,
		rpcCh:     rpcCh,
		p2pRaft:   wrapper,
	}
	return cc, nil
}

// Shutdown stops the component so it will not process any
// more updates. The underlying consensus is permanently
// shutdown, along with the libp2p transport.
func (cc *ClusterConsensus) Shutdown() error {
	logger.Info("Stopping Consensus component")
	cc.cancel()

	// When we take snapshot, we make sure that
	// we re-start from the previous state, and that
	// we don't replay the log. This includes
	// pin and pin certain stuff.
	f := cc.p2pRaft.raft.Snapshot()
	_ = f.Error()
	f = cc.p2pRaft.raft.Shutdown()
	err := f.Error()
	cc.p2pRaft.transport.Close()
	if err != nil {
		return err
	}
	return nil
}

// RpcChan can be used by Cluster to read any
// requests from this component
func (cc *ClusterConsensus) RpcChan() <-chan ClusterRPC {
	return cc.rpcCh
}

func (cc *ClusterConsensus) op(c *cid.Cid, t clusterLogOpType) clusterLogOp {
	return clusterLogOp{
		Cid:  c.String(),
		Type: t,
	}
}

// AddPin submits a Cid to the shared state of the cluster.
func (cc *ClusterConsensus) AddPin(c *cid.Cid) error {
	// Create pin operation for the log
	op := cc.op(c, LogOpPin)
	_, err := cc.consensus.CommitOp(op)
	if err != nil {
		// This means the op did not make it to the log
		return err
	}

	// Note: the returned state could be nil
	// if ApplyTo failed. We deal with this in ApplyTo.
	// We must schedule a Rollback in that case.
	// Here we only care that the operation was commited
	// to the log, not if the resulting state is valid.

	logger.Infof("Pin commited to global state: %s", c)
	return nil
}

// RmPin removes a Cid from the shared state of the cluster.
func (cc *ClusterConsensus) RmPin(c *cid.Cid) error {
	// Create  unpin operation for the log
	op := cc.op(c, LogOpUnpin)
	_, err := cc.consensus.CommitOp(op)
	if err != nil {
		return err
	}

	// Note: the returned state could be nil
	// if ApplyTo failed. We deal with this in ApplyTo.
	// We must schedule a Rollback in that case.
	// Here we only care that the operation was commited
	// to the log, not if the resulting state is valid.

	logger.Infof("Unpin commited to global state: %s", c)
	return nil
}

// ListPins returns the list of Cids which are part of the
// shared state of the cluster.
func (cc *ClusterConsensus) ListPins() ([]Pin, error) {
	cstate, err := cc.consensus.GetLogHead()
	if err != nil {
		return nil, err
	}
	state := cstate.(ClusterState)
	return state.ListPins(), nil
}

// Leader() returns the peerID of the Leader of the
// cluster.
func (cc *ClusterConsensus) Leader() peer.ID {
	// FIXME: Hashicorp Raft specific
	raftactor := cc.actor.(*libp2praft.Actor)
	return raftactor.Leader()
}

func (cc *ClusterConsensus) Rollback(state ClusterState) error {
	return cc.consensus.Rollback(state)
}