consensus/istanbul: implement gossip network

Author: markya0616

consensus/istanbul/backend.go

@@ -34,9 +34,12 @@ type Backend interface {
 	// EventMux returns the event mux in backend
 	EventMux() *event.TypeMux
 
-	// Broadcast sends a message to all validators
+	// Broadcast sends a message to all validators (include self)
 	Broadcast(valSet ValidatorSet, payload []byte) error
 
+	// Gossip sends a message to all validators (exclude self)
+	Gossip(valSet ValidatorSet, payload []byte) error
+
 	// Commit delivers an approved proposal to backend.
 	// The delivered proposal will be put into blockchain.
 	Commit(proposal Proposal, seals [][]byte) error

consensus/istanbul/backend/backend.go

@@ -39,6 +39,8 @@ import (
 func New(config *istanbul.Config, eventMux *event.TypeMux, privateKey *ecdsa.PrivateKey, db ethdb.Database) consensus.Istanbul {
 	// Allocate the snapshot caches and create the engine
 	recents, _ := lru.NewARC(inmemorySnapshots)
+	recentMessages, _ := lru.NewARC(inmemoryPeers)
+	knownMessages, _ := lru.NewARC(inmemoryMessages)
 	backend := &backend{
 		config:           config,
 		eventMux:         eventMux,
@@ -51,6 +53,8 @@ func New(config *istanbul.Config, eventMux *event.TypeMux, privateKey *ecdsa.Pri
 		recents:          recents,
 		candidates:       make(map[common.Address]bool),
 		coreStarted:      false,
+		recentMessages:   recentMessages,
+		knownMessages:    knownMessages,
 	}
 	backend.core = istanbulCore.New(backend, backend.config)
 	return backend
@@ -87,6 +91,9 @@ type backend struct {
 	// event subscription for ChainHeadEvent event
 	eventSub    *event.TypeMuxSubscription
 	broadcaster consensus.Broadcaster
+
+	recentMessages *lru.ARCCache // the cache of peer's messages
+	knownMessages  *lru.ARCCache // the cache of self messages
 }
 
 // Address implements istanbul.Backend.Address
@@ -111,7 +118,11 @@ func (sb *backend) Broadcast(valSet istanbul.ValidatorSet, payload []byte) error
 	return nil
 }
 
+// Broadcast implements istanbul.Backend.Gossip
 func (sb *backend) Gossip(valSet istanbul.ValidatorSet, payload []byte) error {
+	hash := istanbul.RLPHash(payload)
+	sb.knownMessages.Add(hash, true)
+
 	targets := make(map[common.Address]bool)
 	for _, val := range valSet.List() {
 		if val.Address() != sb.Address() {
@@ -121,7 +132,22 @@ func (sb *backend) Gossip(valSet istanbul.ValidatorSet, payload []byte) error {
 
 	if sb.broadcaster != nil && len(targets) > 0 {
 		ps := sb.broadcaster.FindPeers(targets)
-		for _, p := range ps {
+		for addr, p := range ps {
+			ms, ok := sb.recentMessages.Get(addr)
+			var m *lru.ARCCache
+			if ok {
+				m, _ = ms.(*lru.ARCCache)
+				if _, k := m.Get(hash); k {
+					// This peer had this event, skip it
+					continue
+				}
+			} else {
+				m, _ = lru.NewARC(inmemoryMessages)
+			}
+
+			m.Add(hash, true)
+			sb.recentMessages.Add(addr, m)
+
 			go p.Send(istanbulMsg, payload)
 		}
 	}

consensus/istanbul/backend/engine.go

@@ -42,6 +42,8 @@ import (
 const (
 	checkpointInterval = 1024 // Number of blocks after which to save the vote snapshot to the database
 	inmemorySnapshots  = 128  // Number of recent vote snapshots to keep in memory
+	inmemoryPeers      = 40
+	inmemoryMessages   = 100
 )
 
 var (

consensus/istanbul/backend/handler.go

@@ -25,6 +25,7 @@ import (
 	"github.com/ethereum/go-ethereum/core"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/p2p"
+	lru "github.com/hashicorp/golang-lru"
 )
 
 const (
@@ -60,6 +61,25 @@ func (sb *backend) HandleMsg(addr common.Address, msg p2p.Msg) (bool, error) {
 			return true, errDecodeFailed
 		}
 
+		hash := istanbul.RLPHash(data)
+
+		// Mark peer's message
+		ms, ok := sb.recentMessages.Get(addr)
+		var m *lru.ARCCache
+		if ok {
+			m, _ = ms.(*lru.ARCCache)
+		} else {
+			m, _ = lru.NewARC(inmemoryMessages)
+			sb.recentMessages.Add(addr, m)
+		}
+		m.Add(hash, true)
+
+		// Mark self known message
+		if _, ok := sb.knownMessages.Get(hash); ok {
+			return true, nil
+		}
+		sb.knownMessages.Add(hash, true)
+
 		go sb.istanbulEventMux.Post(istanbul.MessageEvent{
 			Payload: data,
 		})

consensus/istanbul/core/handler.go

@@ -95,11 +95,19 @@ func (c *core) handleEvents() {
 					c.storeRequestMsg(r)
 				}
 			case istanbul.MessageEvent:
-				c.handleMsg(ev.Payload)
+				if err := c.handleMsg(ev.Payload); err == nil {
+					c.backend.Gossip(c.valSet, ev.Payload)
+				}
 			case backlogEvent:
 				// No need to check signature for internal messages
-				c.handleCheckedMsg(ev.msg, ev.src)
-
+				if err := c.handleCheckedMsg(ev.msg, ev.src); err == nil {
+					p, err := ev.msg.Payload()
+					if err != nil {
+						c.logger.Warn("Get message payload failed", "err", err)
+						continue
+					}
+					c.backend.Gossip(c.valSet, p)
+				}
 			}
 		case _, ok := <-c.timeoutSub.Chan():
 			if !ok {

consensus/istanbul/core/testbackend_test.go

@@ -87,6 +87,11 @@ func (self *testSystemBackend) Broadcast(valSet istanbul.ValidatorSet, message [
 	return nil
 }
 
+func (self *testSystemBackend) Gossip(valSet istanbul.ValidatorSet, message []byte) error {
+	testLogger.Warn("not sign any data")
+	return nil
+}
+
 func (self *testSystemBackend) NextRound() error {
 	testLogger.Warn("nothing to happen")
 	return nil