eth: began split up of peers and protocol manager
This commit is contained in:
383
eth/protocol.go
383
eth/protocol.go
@ -1,17 +1,10 @@
|
||||
package eth
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"math/big"
|
||||
|
||||
"github.com/ethereum/go-ethereum/common"
|
||||
"github.com/ethereum/go-ethereum/core/types"
|
||||
"github.com/ethereum/go-ethereum/errs"
|
||||
"github.com/ethereum/go-ethereum/eth/downloader"
|
||||
"github.com/ethereum/go-ethereum/logger"
|
||||
"github.com/ethereum/go-ethereum/logger/glog"
|
||||
"github.com/ethereum/go-ethereum/p2p"
|
||||
"github.com/ethereum/go-ethereum/rlp"
|
||||
)
|
||||
|
||||
const (
|
||||
@ -35,6 +28,8 @@ const (
|
||||
NewBlockMsg
|
||||
)
|
||||
|
||||
type errCode int
|
||||
|
||||
const (
|
||||
ErrMsgTooLarge = iota
|
||||
ErrDecode
|
||||
@ -47,6 +42,11 @@ const (
|
||||
ErrSuspendedPeer
|
||||
)
|
||||
|
||||
func (e errCode) String() string {
|
||||
return errorToString[int(e)]
|
||||
}
|
||||
|
||||
// XXX change once legacy code is out
|
||||
var errorToString = map[int]string{
|
||||
ErrMsgTooLarge: "Message too long",
|
||||
ErrDecode: "Invalid message",
|
||||
@ -59,21 +59,6 @@ var errorToString = map[int]string{
|
||||
ErrSuspendedPeer: "Suspended peer",
|
||||
}
|
||||
|
||||
// ethProtocol represents the ethereum wire protocol
|
||||
// instance is running on each peer
|
||||
type ethProtocol struct {
|
||||
txPool txPool
|
||||
chainManager chainManager
|
||||
blockPool blockPool
|
||||
downloader *downloader.Downloader
|
||||
peer *p2p.Peer
|
||||
id string
|
||||
rw p2p.MsgReadWriter
|
||||
errors *errs.Errors
|
||||
protocolVersion int
|
||||
networkId int
|
||||
}
|
||||
|
||||
// backend is the interface the ethereum protocol backend should implement
|
||||
// used as an argument to EthProtocol
|
||||
type txPool interface {
|
||||
@ -87,362 +72,8 @@ type chainManager interface {
|
||||
Status() (td *big.Int, currentBlock common.Hash, genesisBlock common.Hash)
|
||||
}
|
||||
|
||||
type blockPool interface {
|
||||
AddBlockHashes(next func() (common.Hash, bool), peerId string)
|
||||
AddBlock(block *types.Block, peerId string)
|
||||
AddPeer(td *big.Int, currentBlock common.Hash, peerId string, requestHashes func(common.Hash) error, requestBlocks func([]common.Hash) error, peerError func(*errs.Error)) (best bool, suspended bool)
|
||||
RemovePeer(peerId string)
|
||||
}
|
||||
|
||||
// message structs used for RLP serialization
|
||||
type newBlockMsgData struct {
|
||||
Block *types.Block
|
||||
TD *big.Int
|
||||
}
|
||||
|
||||
type getBlockHashesMsgData struct {
|
||||
Hash common.Hash
|
||||
Amount uint64
|
||||
}
|
||||
|
||||
type statusMsgData struct {
|
||||
ProtocolVersion uint32
|
||||
NetworkId uint32
|
||||
TD *big.Int
|
||||
CurrentBlock common.Hash
|
||||
GenesisBlock common.Hash
|
||||
}
|
||||
|
||||
// main entrypoint, wrappers starting a server running the eth protocol
|
||||
// use this constructor to attach the protocol ("class") to server caps
|
||||
// the Dev p2p layer then runs the protocol instance on each peer
|
||||
func EthProtocol(protocolVersion, networkId int, txPool txPool, chainManager chainManager, blockPool blockPool, downloader *downloader.Downloader) p2p.Protocol {
|
||||
return p2p.Protocol{
|
||||
Name: "eth",
|
||||
Version: uint(protocolVersion),
|
||||
Length: ProtocolLength,
|
||||
Run: func(peer *p2p.Peer, rw p2p.MsgReadWriter) error {
|
||||
return runEthProtocol(protocolVersion, networkId, txPool, chainManager, blockPool, downloader, peer, rw)
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// the main loop that handles incoming messages
|
||||
// note RemovePeer in the post-disconnect hook
|
||||
func runEthProtocol(protocolVersion, networkId int, txPool txPool, chainManager chainManager, blockPool blockPool, downloader *downloader.Downloader, peer *p2p.Peer, rw p2p.MsgReadWriter) (err error) {
|
||||
id := peer.ID()
|
||||
self := ðProtocol{
|
||||
txPool: txPool,
|
||||
chainManager: chainManager,
|
||||
blockPool: blockPool,
|
||||
downloader: downloader,
|
||||
rw: rw,
|
||||
peer: peer,
|
||||
protocolVersion: protocolVersion,
|
||||
networkId: networkId,
|
||||
errors: &errs.Errors{
|
||||
Package: "ETH",
|
||||
Errors: errorToString,
|
||||
},
|
||||
id: fmt.Sprintf("%x", id[:8]),
|
||||
}
|
||||
|
||||
// handshake.
|
||||
if err := self.handleStatus(); err != nil {
|
||||
return err
|
||||
}
|
||||
defer self.blockPool.RemovePeer(self.id)
|
||||
|
||||
// propagate existing transactions. new transactions appearing
|
||||
// after this will be sent via broadcasts.
|
||||
if err := p2p.Send(rw, TxMsg, txPool.GetTransactions()); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// main loop. handle incoming messages.
|
||||
for {
|
||||
if err := self.handle(); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (self *ethProtocol) handle() error {
|
||||
msg, err := self.rw.ReadMsg()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if msg.Size > ProtocolMaxMsgSize {
|
||||
return self.protoError(ErrMsgTooLarge, "%v > %v", msg.Size, ProtocolMaxMsgSize)
|
||||
}
|
||||
// make sure that the payload has been fully consumed
|
||||
defer msg.Discard()
|
||||
|
||||
switch msg.Code {
|
||||
case GetTxMsg: // ignore
|
||||
case StatusMsg:
|
||||
return self.protoError(ErrExtraStatusMsg, "")
|
||||
|
||||
case TxMsg:
|
||||
// TODO: rework using lazy RLP stream
|
||||
var txs []*types.Transaction
|
||||
if err := msg.Decode(&txs); err != nil {
|
||||
return self.protoError(ErrDecode, "msg %v: %v", msg, err)
|
||||
}
|
||||
for i, tx := range txs {
|
||||
if tx == nil {
|
||||
return self.protoError(ErrDecode, "transaction %d is nil", i)
|
||||
}
|
||||
jsonlogger.LogJson(&logger.EthTxReceived{
|
||||
TxHash: tx.Hash().Hex(),
|
||||
RemoteId: self.peer.ID().String(),
|
||||
})
|
||||
}
|
||||
self.txPool.AddTransactions(txs)
|
||||
|
||||
case GetBlockHashesMsg:
|
||||
var request getBlockHashesMsgData
|
||||
if err := msg.Decode(&request); err != nil {
|
||||
return self.protoError(ErrDecode, "->msg %v: %v", msg, err)
|
||||
}
|
||||
|
||||
if request.Amount > maxHashes {
|
||||
request.Amount = maxHashes
|
||||
}
|
||||
hashes := self.chainManager.GetBlockHashesFromHash(request.Hash, request.Amount)
|
||||
return p2p.Send(self.rw, BlockHashesMsg, hashes)
|
||||
|
||||
case BlockHashesMsg:
|
||||
msgStream := rlp.NewStream(msg.Payload)
|
||||
|
||||
var hashes []common.Hash
|
||||
if err := msgStream.Decode(&hashes); err != nil {
|
||||
break
|
||||
}
|
||||
self.downloader.HashCh <- hashes
|
||||
|
||||
/*
|
||||
if _, err := msgStream.List(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var i int
|
||||
iter := func() (hash common.Hash, err error) {
|
||||
err = msgStream.Decode(&hash)
|
||||
if err == rlp.EOL {
|
||||
return common.Hash{}, err
|
||||
} else if err != nil {
|
||||
return common.Hash{}, fmt.Errorf("Fetching hashes err (%d): %v", i, err)
|
||||
}
|
||||
|
||||
i++
|
||||
return hash, nil
|
||||
}
|
||||
self.downloader.HashCh <- iter
|
||||
//self.blockPool.AddBlockHashes(iter, self.id)
|
||||
*/
|
||||
|
||||
case GetBlocksMsg:
|
||||
msgStream := rlp.NewStream(msg.Payload)
|
||||
if _, err := msgStream.List(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var blocks []*types.Block
|
||||
var i int
|
||||
for {
|
||||
i++
|
||||
var hash common.Hash
|
||||
err := msgStream.Decode(&hash)
|
||||
if err == rlp.EOL {
|
||||
break
|
||||
} else if err != nil {
|
||||
return self.protoError(ErrDecode, "msg %v: %v", msg, err)
|
||||
}
|
||||
|
||||
block := self.chainManager.GetBlock(hash)
|
||||
if block != nil {
|
||||
blocks = append(blocks, block)
|
||||
}
|
||||
if i == maxBlocks {
|
||||
break
|
||||
}
|
||||
}
|
||||
return p2p.Send(self.rw, BlocksMsg, blocks)
|
||||
|
||||
case BlocksMsg:
|
||||
msgStream := rlp.NewStream(msg.Payload)
|
||||
|
||||
var blocks []*types.Block
|
||||
if err := msgStream.Decode(&blocks); err != nil {
|
||||
glog.V(logger.Detail).Infoln("Decode error", err)
|
||||
fmt.Println("decode error", err)
|
||||
blocks = nil
|
||||
}
|
||||
self.downloader.DeliverChunk(self.id, blocks)
|
||||
/*
|
||||
msgStream := rlp.NewStream(msg.Payload)
|
||||
if _, err := msgStream.List(); err != nil {
|
||||
return err
|
||||
}
|
||||
for {
|
||||
var block types.Block
|
||||
if err := msgStream.Decode(&block); err != nil {
|
||||
if err == rlp.EOL {
|
||||
break
|
||||
} else {
|
||||
return self.protoError(ErrDecode, "msg %v: %v", msg, err)
|
||||
}
|
||||
}
|
||||
if err := block.ValidateFields(); err != nil {
|
||||
return self.protoError(ErrDecode, "block validation %v: %v", msg, err)
|
||||
}
|
||||
self.blockPool.AddBlock(&block, self.id)
|
||||
}
|
||||
*/
|
||||
|
||||
case NewBlockMsg:
|
||||
var request newBlockMsgData
|
||||
if err := msg.Decode(&request); err != nil {
|
||||
return self.protoError(ErrDecode, "%v: %v", msg, err)
|
||||
}
|
||||
if err := request.Block.ValidateFields(); err != nil {
|
||||
return self.protoError(ErrDecode, "block validation %v: %v", msg, err)
|
||||
}
|
||||
hash := request.Block.Hash()
|
||||
_, chainHead, _ := self.chainManager.Status()
|
||||
|
||||
jsonlogger.LogJson(&logger.EthChainReceivedNewBlock{
|
||||
BlockHash: hash.Hex(),
|
||||
BlockNumber: request.Block.Number(), // this surely must be zero
|
||||
ChainHeadHash: chainHead.Hex(),
|
||||
BlockPrevHash: request.Block.ParentHash().Hex(),
|
||||
RemoteId: self.peer.ID().String(),
|
||||
})
|
||||
|
||||
self.downloader.AddBlock(self.id, request.Block, request.TD)
|
||||
// to simplify backend interface adding a new block
|
||||
// uses AddPeer followed by AddBlock only if peer is the best peer
|
||||
// (or selected as new best peer)
|
||||
if _, suspended := self.blockPool.AddPeer(request.TD, hash, self.id, self.requestBlockHashes, self.requestBlocks, self.protoErrorDisconnect); !suspended {
|
||||
self.blockPool.AddBlock(request.Block, self.id)
|
||||
}
|
||||
|
||||
default:
|
||||
return self.protoError(ErrInvalidMsgCode, "%v", msg.Code)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (self *ethProtocol) handleStatus() error {
|
||||
if err := self.sendStatus(); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// read and handle remote status
|
||||
msg, err := self.rw.ReadMsg()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if msg.Code != StatusMsg {
|
||||
return self.protoError(ErrNoStatusMsg, "first msg has code %x (!= %x)", msg.Code, StatusMsg)
|
||||
}
|
||||
if msg.Size > ProtocolMaxMsgSize {
|
||||
return self.protoError(ErrMsgTooLarge, "%v > %v", msg.Size, ProtocolMaxMsgSize)
|
||||
}
|
||||
|
||||
var status statusMsgData
|
||||
if err := msg.Decode(&status); err != nil {
|
||||
return self.protoError(ErrDecode, "msg %v: %v", msg, err)
|
||||
}
|
||||
|
||||
_, _, genesisBlock := self.chainManager.Status()
|
||||
|
||||
if status.GenesisBlock != genesisBlock {
|
||||
return self.protoError(ErrGenesisBlockMismatch, "%x (!= %x)", status.GenesisBlock, genesisBlock)
|
||||
}
|
||||
|
||||
if int(status.NetworkId) != self.networkId {
|
||||
return self.protoError(ErrNetworkIdMismatch, "%d (!= %d)", status.NetworkId, self.networkId)
|
||||
}
|
||||
|
||||
if int(status.ProtocolVersion) != self.protocolVersion {
|
||||
return self.protoError(ErrProtocolVersionMismatch, "%d (!= %d)", status.ProtocolVersion, self.protocolVersion)
|
||||
}
|
||||
|
||||
err = self.downloader.RegisterPeer(self.id, status.TD, status.CurrentBlock, self.requestBlockHashes, self.requestBlocks)
|
||||
if err != nil {
|
||||
return self.protoError(ErrSuspendedPeer, "something")
|
||||
}
|
||||
/*
|
||||
_, suspended := self.blockPool.AddPeer(status.TD, status.CurrentBlock, self.id, self.requestBlockHashes, self.requestBlocks, self.protoErrorDisconnect)
|
||||
if suspended {
|
||||
return self.protoError(ErrSuspendedPeer, "")
|
||||
}
|
||||
*/
|
||||
|
||||
self.peer.Debugf("Peer is [eth] capable (%d/%d). TD=%v H=%x\n", status.ProtocolVersion, status.NetworkId, status.TD, status.CurrentBlock[:4])
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (self *ethProtocol) requestBlockHashes(from common.Hash) error {
|
||||
self.peer.Debugf("fetching hashes (%d) %x...\n", maxHashes, from[0:4])
|
||||
return p2p.Send(self.rw, GetBlockHashesMsg, getBlockHashesMsgData{from, maxHashes})
|
||||
}
|
||||
|
||||
func (self *ethProtocol) requestBlocks(hashes []common.Hash) error {
|
||||
self.peer.Debugf("fetching %v blocks", len(hashes))
|
||||
return p2p.Send(self.rw, GetBlocksMsg, hashes)
|
||||
}
|
||||
|
||||
/*
|
||||
func (self *ethProtocol) newRespBlockCh() BlockPack {
|
||||
self.blockRespCh = make(chan blockResp)
|
||||
return self.blockRespCh
|
||||
}
|
||||
|
||||
func (self *ethProtocol) RequestBlocks(hashes *set.Set) <-chan []*types.Block {
|
||||
out := make(chan []*types.Block)
|
||||
go func() {
|
||||
done:
|
||||
for {
|
||||
select {
|
||||
case blockResp := <-self.newRespBlockCh():
|
||||
if len(blockResp.blocks) {
|
||||
}
|
||||
case <-time.After(5 * time.Second):
|
||||
}
|
||||
}
|
||||
|
||||
close(out)
|
||||
}()
|
||||
return out
|
||||
}
|
||||
*/
|
||||
|
||||
func (self *ethProtocol) protoError(code int, format string, params ...interface{}) (err *errs.Error) {
|
||||
err = self.errors.New(code, format, params...)
|
||||
//err.Log(self.peer.Logger)
|
||||
err.Log(glog.V(logger.Info))
|
||||
return
|
||||
}
|
||||
|
||||
func (self *ethProtocol) sendStatus() error {
|
||||
td, currentBlock, genesisBlock := self.chainManager.Status()
|
||||
return p2p.Send(self.rw, StatusMsg, &statusMsgData{
|
||||
ProtocolVersion: uint32(self.protocolVersion),
|
||||
NetworkId: uint32(self.networkId),
|
||||
TD: td,
|
||||
CurrentBlock: currentBlock,
|
||||
GenesisBlock: genesisBlock,
|
||||
})
|
||||
}
|
||||
|
||||
func (self *ethProtocol) protoErrorDisconnect(err *errs.Error) {
|
||||
err.Log(glog.V(logger.Info))
|
||||
if err.Fatal() {
|
||||
self.peer.Disconnect(p2p.DiscSubprotocolError)
|
||||
}
|
||||
|
||||
}
|
||||
|
Reference in New Issue
Block a user