2015-02-25 06:34:12 -06:00
package blockpool
import (
"fmt"
"math/big"
"sync"
"time"
2015-03-16 17:10:26 -05:00
"github.com/ethereum/go-ethereum/common"
2015-03-19 17:53:15 -05:00
"github.com/ethereum/go-ethereum/core"
2015-02-25 06:34:12 -06:00
"github.com/ethereum/go-ethereum/core/types"
"github.com/ethereum/go-ethereum/errs"
2015-03-19 17:53:15 -05:00
"github.com/ethereum/go-ethereum/event"
2015-04-12 14:25:09 -05:00
"github.com/ethereum/go-ethereum/logger"
2015-04-07 07:57:04 -05:00
"github.com/ethereum/go-ethereum/logger/glog"
2015-02-25 06:34:12 -06:00
"github.com/ethereum/go-ethereum/pow"
)
var (
// max number of block hashes sent in one request
2015-03-03 13:06:15 -06:00
blockHashesBatchSize = 256
2015-02-25 06:34:12 -06:00
// max number of blocks sent in one request
blockBatchSize = 64
// interval between two consecutive block checks (and requests)
blocksRequestInterval = 3 * time . Second
// level of redundancy in block requests sent
blocksRequestRepetition = 1
// interval between two consecutive block hash checks (and requests)
blockHashesRequestInterval = 3 * time . Second
// max number of idle iterations, ie., check through a section without new blocks coming in
2015-03-03 13:06:15 -06:00
blocksRequestMaxIdleRounds = 20
2015-02-25 06:34:12 -06:00
// timeout interval: max time allowed for peer without sending a block hash
blockHashesTimeout = 60 * time . Second
// timeout interval: max time allowed for peer without sending a block
2015-03-03 13:06:15 -06:00
blocksTimeout = 60 * time . Second
2015-03-19 17:53:15 -05:00
// timeout interval: max time allowed for best peer to remain idle (not send new block after sync complete)
2015-04-12 14:25:09 -05:00
idleBestPeerTimeout = 60 * time . Second
2015-03-19 17:53:15 -05:00
// duration of suspension after peer fatal error during which peer is not allowed to reconnect
2015-03-19 17:46:54 -05:00
peerSuspensionInterval = 300 * time . Second
2015-03-19 18:14:08 -05:00
// status is logged every statusUpdateInterval
statusUpdateInterval = 3 * time . Second
2015-04-12 14:25:09 -05:00
//
nodeCacheSize = 1000
2015-02-25 06:34:12 -06:00
)
2015-03-19 18:14:08 -05:00
// blockpool config, values default to constants
2015-02-25 06:34:12 -06:00
type Config struct {
BlockHashesBatchSize int
BlockBatchSize int
BlocksRequestRepetition int
BlocksRequestMaxIdleRounds int
2015-04-12 14:25:09 -05:00
NodeCacheSize int
2015-02-25 06:34:12 -06:00
BlockHashesRequestInterval time . Duration
BlocksRequestInterval time . Duration
BlockHashesTimeout time . Duration
BlocksTimeout time . Duration
2015-03-03 13:06:15 -06:00
IdleBestPeerTimeout time . Duration
2015-03-19 17:46:54 -05:00
PeerSuspensionInterval time . Duration
2015-03-19 18:14:08 -05:00
StatusUpdateInterval time . Duration
2015-02-25 06:34:12 -06:00
}
// blockpool errors
const (
ErrInvalidBlock = iota
ErrInvalidPoW
ErrInsufficientChainInfo
2015-03-03 13:06:15 -06:00
ErrIdleTooLong
2015-03-19 18:00:19 -05:00
ErrIncorrectTD
2015-03-19 18:14:08 -05:00
ErrUnrequestedBlock
2015-02-25 06:34:12 -06:00
)
2015-03-19 18:14:08 -05:00
// error descriptions
2015-02-25 06:34:12 -06:00
var errorToString = map [ int ] string {
2015-03-19 18:14:08 -05:00
ErrInvalidBlock : "Invalid block" , // fatal
ErrInvalidPoW : "Invalid PoW" , // fatal
ErrInsufficientChainInfo : "Insufficient chain info" , // fatal
ErrIdleTooLong : "Idle too long" , // fatal
2015-04-12 14:25:09 -05:00
ErrIncorrectTD : "Incorrect Total Difficulty" , // should be fatal, not now temporarily
2015-02-25 06:34:12 -06:00
ErrUnrequestedBlock : "Unrequested block" ,
}
2015-03-19 18:14:08 -05:00
// error severity
2015-04-12 14:25:09 -05:00
func severity ( code int ) logger . LogLevel {
2015-03-19 18:14:08 -05:00
switch code {
2015-04-12 14:25:09 -05:00
case ErrIncorrectTD :
return logger . WarnLevel
2015-03-19 18:14:08 -05:00
case ErrUnrequestedBlock :
2015-04-12 14:25:09 -05:00
return logger . WarnLevel
2015-03-19 18:14:08 -05:00
default :
2015-04-12 14:25:09 -05:00
return logger . ErrorLevel
2015-03-19 18:14:08 -05:00
}
}
// init initialises the Config, zero values fall back to constants
2015-02-25 06:34:12 -06:00
func ( self * Config ) init ( ) {
if self . BlockHashesBatchSize == 0 {
self . BlockHashesBatchSize = blockHashesBatchSize
}
if self . BlockBatchSize == 0 {
self . BlockBatchSize = blockBatchSize
}
if self . BlocksRequestRepetition == 0 {
self . BlocksRequestRepetition = blocksRequestRepetition
}
if self . BlocksRequestMaxIdleRounds == 0 {
self . BlocksRequestMaxIdleRounds = blocksRequestMaxIdleRounds
}
if self . BlockHashesRequestInterval == 0 {
self . BlockHashesRequestInterval = blockHashesRequestInterval
}
if self . BlocksRequestInterval == 0 {
self . BlocksRequestInterval = blocksRequestInterval
}
if self . BlockHashesTimeout == 0 {
self . BlockHashesTimeout = blockHashesTimeout
}
if self . BlocksTimeout == 0 {
self . BlocksTimeout = blocksTimeout
}
2015-03-03 13:06:15 -06:00
if self . IdleBestPeerTimeout == 0 {
self . IdleBestPeerTimeout = idleBestPeerTimeout
}
2015-03-19 17:46:54 -05:00
if self . PeerSuspensionInterval == 0 {
self . PeerSuspensionInterval = peerSuspensionInterval
}
2015-04-12 14:25:09 -05:00
if self . NodeCacheSize == 0 {
self . NodeCacheSize = nodeCacheSize
}
2015-03-19 18:14:08 -05:00
if self . StatusUpdateInterval == 0 {
self . StatusUpdateInterval = statusUpdateInterval
}
2015-02-25 06:34:12 -06:00
}
// node is the basic unit of the internal model of block chain/tree in the blockpool
type node struct {
lock sync . RWMutex
2015-03-16 17:10:26 -05:00
hash common . Hash
2015-02-25 06:34:12 -06:00
block * types . Block
hashBy string
blockBy string
2015-04-07 21:34:20 -05:00
peers map [ string ] bool
2015-02-25 06:34:12 -06:00
td * big . Int
}
type index struct {
int
}
// entry is the struct kept and indexed in the pool
type entry struct {
node * node
section * section
index * index
}
type BlockPool struct {
Config * Config
2015-03-19 18:14:08 -05:00
// the minimal interface with blockchain manager
hasBlock func ( hash common . Hash ) bool // query if block is known
insertChain func ( types . Blocks ) error // add section to blockchain
verifyPoW func ( pow . Block ) bool // soft PoW verification
chainEvents * event . TypeMux // ethereum eventer for chainEvents
2015-03-19 17:53:15 -05:00
2015-03-19 18:14:08 -05:00
tdSub event . Subscription // subscription to core.ChainHeadEvent
td * big . Int // our own total difficulty
2015-02-25 06:34:12 -06:00
2015-03-20 06:57:47 -05:00
pool map [ common . Hash ] * entry // the actual blockpool
peers * peers // peers manager in peers.go
2015-03-19 18:14:08 -05:00
status * status // info about blockpool (UI interface) in status.go
2015-02-25 06:34:12 -06:00
lock sync . RWMutex
chainLock sync . RWMutex
// alloc-easy pool of hash slices
2015-03-16 17:10:26 -05:00
hashSlicePool chan [ ] common . Hash
2015-02-25 06:34:12 -06:00
2015-04-10 10:31:00 -05:00
nodeCache map [ common . Hash ] * node
nodeCacheLock sync . RWMutex
2015-04-12 14:25:09 -05:00
nodeCacheList [ ] common . Hash
2015-04-10 10:31:00 -05:00
2015-03-19 18:14:08 -05:00
// waitgroup is used in tests to wait for result-critical routines
// as well as in determining idle / syncing status
wg sync . WaitGroup //
quit chan bool // chan used for quitting parallel routines
running bool //
2015-02-25 06:34:12 -06:00
}
// public constructor
2015-03-19 18:14:08 -05:00
// after blockpool returned, config can be set
// BlockPool.Start will call Config.init to set missing values
2015-02-25 06:34:12 -06:00
func New (
2015-03-16 17:10:26 -05:00
hasBlock func ( hash common . Hash ) bool ,
2015-02-25 06:34:12 -06:00
insertChain func ( types . Blocks ) error ,
verifyPoW func ( pow . Block ) bool ,
2015-03-19 17:53:15 -05:00
chainEvents * event . TypeMux ,
td * big . Int ,
2015-02-25 06:34:12 -06:00
) * BlockPool {
return & BlockPool {
Config : & Config { } ,
hasBlock : hasBlock ,
insertChain : insertChain ,
verifyPoW : verifyPoW ,
2015-03-19 17:53:15 -05:00
chainEvents : chainEvents ,
td : td ,
2015-02-25 06:34:12 -06:00
}
}
// allows restart
func ( self * BlockPool ) Start ( ) {
self . lock . Lock ( )
defer self . lock . Unlock ( )
if self . running {
return
}
2015-03-19 18:14:08 -05:00
// set missing values
2015-02-25 06:34:12 -06:00
self . Config . init ( )
2015-03-19 18:14:08 -05:00
2015-03-16 17:10:26 -05:00
self . hashSlicePool = make ( chan [ ] common . Hash , 150 )
2015-04-10 10:31:00 -05:00
self . nodeCache = make ( map [ common . Hash ] * node )
2015-02-25 06:34:12 -06:00
self . status = newStatus ( )
self . quit = make ( chan bool )
2015-03-20 06:57:47 -05:00
self . pool = make ( map [ common . Hash ] * entry )
2015-02-25 06:34:12 -06:00
self . running = true
self . peers = & peers {
errors : & errs . Errors {
Package : "Blockpool" ,
Errors : errorToString ,
2015-03-02 11:43:12 -06:00
Level : severity ,
2015-02-25 06:34:12 -06:00
} ,
2015-03-19 17:46:54 -05:00
peers : make ( map [ string ] * peer ) ,
blacklist : make ( map [ string ] time . Time ) ,
status : self . status ,
bp : self ,
2015-02-25 06:34:12 -06:00
}
2015-03-19 17:53:15 -05:00
2015-03-19 18:14:08 -05:00
// subscribe and listen to core.ChainHeadEvent{} for uptodate TD
2015-03-19 17:53:15 -05:00
self . tdSub = self . chainEvents . Subscribe ( core . ChainHeadEvent { } )
2015-03-19 18:14:08 -05:00
// status update interval
timer := time . NewTicker ( self . Config . StatusUpdateInterval )
2015-02-25 06:34:12 -06:00
go func ( ) {
for {
select {
case <- self . quit :
return
2015-03-19 17:53:15 -05:00
case event := <- self . tdSub . Chan ( ) :
if ev , ok := event . ( core . ChainHeadEvent ) ; ok {
td := ev . Block . Td
2015-03-25 06:28:17 -05:00
var height * big . Int
if ( ev . Block . HeaderHash == common . Hash { } ) {
height = ev . Block . Header ( ) . Number
}
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "ChainHeadEvent: height: %v, td: %v, hash: %s" , height , td , hex ( ev . Block . Hash ( ) ) )
2015-03-19 17:53:15 -05:00
self . setTD ( td )
self . peers . lock . Lock ( )
if best := self . peers . best ; best != nil {
2015-03-25 06:09:50 -05:00
// only switch if we strictly go above otherwise we may stall if only
if td . Cmp ( best . td ) > 0 {
2015-03-19 17:53:15 -05:00
self . peers . best = nil
self . switchPeer ( best , nil )
}
}
self . peers . lock . Unlock ( )
}
2015-02-25 06:34:12 -06:00
case <- timer . C :
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "status:\n%v" , self . Status ( ) )
2015-02-25 06:34:12 -06:00
}
}
} ( )
2015-04-12 14:25:09 -05:00
glog . V ( logger . Info ) . Infoln ( "Blockpool started" )
2015-02-25 06:34:12 -06:00
}
func ( self * BlockPool ) Stop ( ) {
self . lock . Lock ( )
if ! self . running {
self . lock . Unlock ( )
return
}
self . running = false
self . lock . Unlock ( )
2015-04-12 14:25:09 -05:00
glog . V ( logger . Info ) . Infoln ( "Stopping..." )
2015-02-25 06:34:12 -06:00
2015-03-19 17:53:15 -05:00
self . tdSub . Unsubscribe ( )
2015-02-25 06:34:12 -06:00
close ( self . quit )
self . lock . Lock ( )
self . peers = nil
self . pool = nil
self . lock . Unlock ( )
2015-04-12 14:25:09 -05:00
glog . V ( logger . Info ) . Infoln ( "Stopped" )
2015-02-25 06:34:12 -06:00
}
// Wait blocks until active processes finish
func ( self * BlockPool ) Wait ( t time . Duration ) {
self . lock . Lock ( )
if ! self . running {
self . lock . Unlock ( )
return
}
self . lock . Unlock ( )
2015-04-12 14:25:09 -05:00
glog . V ( logger . Info ) . Infoln ( "Waiting for processes to complete..." )
2015-02-25 06:34:12 -06:00
w := make ( chan bool )
go func ( ) {
self . wg . Wait ( )
close ( w )
} ( )
select {
case <- w :
2015-04-12 14:25:09 -05:00
glog . V ( logger . Info ) . Infoln ( "Processes complete" )
2015-02-25 06:34:12 -06:00
case <- time . After ( t ) :
2015-04-12 14:25:09 -05:00
glog . V ( logger . Warn ) . Infoln ( "Timeout" )
2015-02-25 06:34:12 -06:00
}
}
/ *
AddPeer is called by the eth protocol instance running on the peer after
the status message has been received with total difficulty and current block hash
2015-03-19 18:14:08 -05:00
Called a second time with the same peer id , it is used to update chain info for a peer .
This is used when a new ( mined ) block message is received .
2015-02-25 06:34:12 -06:00
RemovePeer needs to be called when the peer disconnects .
2015-03-19 18:14:08 -05:00
Peer info is currently not persisted across disconnects ( or sessions ) except for suspension
2015-02-25 06:34:12 -06:00
* /
func ( self * BlockPool ) AddPeer (
2015-03-16 17:10:26 -05:00
td * big . Int , currentBlockHash common . Hash ,
2015-02-25 06:34:12 -06:00
peerId string ,
2015-03-16 17:10:26 -05:00
requestBlockHashes func ( common . Hash ) error ,
requestBlocks func ( [ ] common . Hash ) error ,
2015-02-25 06:34:12 -06:00
peerError func ( * errs . Error ) ,
2015-03-19 17:46:54 -05:00
) ( best bool , suspended bool ) {
2015-02-25 06:34:12 -06:00
return self . peers . addPeer ( td , currentBlockHash , peerId , requestBlockHashes , requestBlocks , peerError )
}
// RemovePeer needs to be called when the peer disconnects
func ( self * BlockPool ) RemovePeer ( peerId string ) {
2015-04-12 14:25:09 -05:00
self . peers . removePeer ( peerId , true )
2015-02-25 06:34:12 -06:00
}
/ *
AddBlockHashes
Entry point for eth protocol to add block hashes received via BlockHashesMsg
2015-03-19 18:14:08 -05:00
Only hashes from the best peer are handled
2015-02-25 06:34:12 -06:00
2015-03-19 18:14:08 -05:00
Initiates further hash requests until a known parent is reached ( unless cancelled by a peerSwitch event , i . e . , when a better peer becomes best peer )
Launches all block request processes on each chain section
2015-02-25 06:34:12 -06:00
2015-03-19 18:14:08 -05:00
The first argument is an iterator function . Using this block hashes are decoded from the rlp message payload on demand . As a result , AddBlockHashes needs to run synchronously for one peer since the message is discarded if the caller thread returns .
2015-02-25 06:34:12 -06:00
* /
2015-03-16 17:10:26 -05:00
func ( self * BlockPool ) AddBlockHashes ( next func ( ) ( common . Hash , bool ) , peerId string ) {
2015-02-25 06:34:12 -06:00
bestpeer , best := self . peers . getPeer ( peerId )
if ! best {
return
}
// bestpeer is still the best peer
self . wg . Add ( 1 )
defer func ( ) { self . wg . Done ( ) } ( )
self . status . lock . Lock ( )
self . status . activePeers [ bestpeer . id ] ++
self . status . lock . Unlock ( )
var n int
2015-03-16 17:10:26 -05:00
var hash common . Hash
2015-02-25 06:34:12 -06:00
var ok , headSection , peerswitch bool
var sec , child , parent * section
var entry * entry
var nodes [ ] * node
hash , ok = next ( )
2015-04-08 14:33:54 -05:00
bestpeer . lock . RLock ( )
2015-02-25 06:34:12 -06:00
2015-04-12 14:25:09 -05:00
glog . V ( logger . Debug ) . Infof ( "AddBlockHashes: peer <%s> starting from [%s] (peer head: %s)" , peerId , hex ( bestpeer . parentHash ) , hex ( bestpeer . currentBlockHash ) )
2015-02-25 06:34:12 -06:00
// first check if we are building the head section of a peer's chain
2015-03-16 17:10:26 -05:00
if bestpeer . parentHash == hash {
2015-02-25 06:34:12 -06:00
if self . hasBlock ( bestpeer . currentBlockHash ) {
2015-04-09 00:31:06 -05:00
bestpeer . lock . RUnlock ( )
2015-02-25 06:34:12 -06:00
return
}
/ *
2015-03-19 18:14:08 -05:00
When peer is promoted in switchPeer , a new header section process is launched .
Once the head section skeleton is actually created here , it is signaled to the process
so that it can quit .
In the special case that the node for parent of the head block is found in the blockpool
( with or without fetched block ) , a singleton section containing only the head block node is created .
2015-02-25 06:34:12 -06:00
* /
headSection = true
if entry := self . get ( bestpeer . currentBlockHash ) ; entry == nil {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s) head section starting from [%s] " , peerId , hex ( bestpeer . currentBlockHash ) , hex ( bestpeer . parentHash ) )
2015-02-25 06:34:12 -06:00
// if head block is not yet in the pool, create entry and start node list for section
2015-04-12 14:25:09 -05:00
self . nodeCacheLock . Lock ( )
n := self . findOrCreateNode ( bestpeer . currentBlockHash , peerId )
n . block = bestpeer . currentBlock
n . blockBy = peerId
n . td = bestpeer . td
self . nodeCacheLock . Unlock ( )
2015-04-07 21:34:20 -05:00
2015-02-25 06:34:12 -06:00
// nodes is a list of nodes in one section ordered top-bottom (old to young)
2015-04-12 14:25:09 -05:00
nodes = append ( nodes , n )
2015-02-25 06:34:12 -06:00
} else {
// otherwise set child section iff found node is the root of a section
// this is a possible scenario when a singleton head section was created
2015-03-19 18:14:08 -05:00
// on an earlier occasion when this peer or another with the same block was best peer
2015-02-25 06:34:12 -06:00
if entry . node == entry . section . bottom {
child = entry . section
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s>: connects to child section root %s" , peerId , hex ( bestpeer . currentBlockHash ) )
2015-02-25 06:34:12 -06:00
}
}
} else {
// otherwise : we are not building the head section of the peer
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s) section starting from [%s] " , peerId , hex ( bestpeer . currentBlockHash ) , hex ( hash ) )
2015-02-25 06:34:12 -06:00
}
// the switch channel signals peerswitch event
2015-04-08 14:33:54 -05:00
bestpeer . lock . RUnlock ( )
2015-02-25 06:34:12 -06:00
// iterate over hashes coming from peer (first round we have hash set above)
LOOP :
for ; ok ; hash , ok = next ( ) {
2015-04-12 14:25:09 -05:00
n ++
2015-02-25 06:34:12 -06:00
select {
case <- self . quit :
// global quit for blockpool
return
2015-04-12 14:25:09 -05:00
case <- bestpeer . switchC :
2015-02-25 06:34:12 -06:00
// if the peer is demoted, no more hashes read
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: demoted peer <%s> (head: %s)" , peerId , hex ( bestpeer . currentBlockHash ) , hex ( hash ) )
2015-02-25 06:34:12 -06:00
peerswitch = true
break LOOP
default :
}
2015-03-19 18:14:08 -05:00
// if we reach the blockchain we stop reading further blockhashes
2015-02-25 06:34:12 -06:00
if self . hasBlock ( hash ) {
// check if known block connecting the downloaded chain to our blockchain
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s) found block %s in the blockchain" , peerId , hex ( bestpeer . currentBlockHash ) , hex ( hash ) )
2015-02-25 06:34:12 -06:00
if len ( nodes ) == 1 {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: singleton section pushed to blockchain peer <%s> (head: %s) found block %s in the blockchain" , peerId , hex ( bestpeer . currentBlockHash ) , hex ( hash ) )
2015-03-02 11:43:12 -06:00
2015-02-25 06:34:12 -06:00
// create new section if needed and push it to the blockchain
sec = self . newSection ( nodes )
sec . addSectionToBlockChain ( bestpeer )
} else {
/ *
not added hash yet but according to peer child section built
earlier chain connects with blockchain
this maybe a potential vulnarability
the root block arrives ( or already there but its parenthash was not pointing to known block in the blockchain )
we start inserting - > error - > remove the entire chain
instead of punishing this peer
solution : when switching peers always make sure best peers own head block
and td together with blockBy are recorded on the node
* /
if len ( nodes ) == 0 && child != nil {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: child section [%s] pushed to blockchain peer <%s> (head: %s) found block %s in the blockchain" , sectionhex ( child ) , peerId , hex ( bestpeer . currentBlockHash ) , hex ( hash ) )
2015-03-02 11:43:12 -06:00
2015-02-25 06:34:12 -06:00
child . addSectionToBlockChain ( bestpeer )
}
}
break LOOP
}
// look up node in the pool
entry = self . get ( hash )
if entry != nil {
// reached a known chain in the pool
if entry . node == entry . section . bottom && n == 1 {
/ *
2015-03-19 18:14:08 -05:00
The first block hash received is an orphan node in the pool
This also supports clients that ( despite the spec ) include < from > hash in their
2015-02-25 06:34:12 -06:00
response to hashes request . Note that by providing < from > we can link sections
2015-03-19 18:14:08 -05:00
without having to wait for the root block of the child section to arrive , so it allows for superior performance .
2015-02-25 06:34:12 -06:00
* /
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s) found head block [%s] as root of connecting child section [%s] skipping" , peerId , hex ( bestpeer . currentBlockHash ) , hex ( hash ) , sectionhex ( entry . section ) )
2015-02-25 06:34:12 -06:00
// record the entry's chain section as child section
child = entry . section
continue LOOP
}
// otherwise record entry's chain section as parent connecting it to the pool
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s) found block [%s] in section [%s]. Connected to pool." , peerId , hex ( bestpeer . currentBlockHash ) , hex ( hash ) , sectionhex ( entry . section ) )
2015-02-25 06:34:12 -06:00
parent = entry . section
break LOOP
}
// finally if node for block hash does not exist, create it and append node to section nodes
2015-04-12 14:25:09 -05:00
self . nodeCacheLock . Lock ( )
nodes = append ( nodes , self . findOrCreateNode ( hash , peerId ) )
self . nodeCacheLock . Unlock ( )
2015-02-25 06:34:12 -06:00
} //for
/ *
we got here if
- run out of hashes ( parent = nil ) sent by our best peer
- our peer is demoted ( peerswitch = true )
- reached blockchain or blockpool
- quitting
* /
self . chainLock . Lock ( )
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s): %v nodes in new section" , peerId , hex ( bestpeer . currentBlockHash ) , len ( nodes ) )
2015-02-25 06:34:12 -06:00
/ *
2015-03-19 18:14:08 -05:00
Handle forks where connecting node is mid - section by splitting section at fork .
No splitting needed if connecting node is head of a section .
2015-02-25 06:34:12 -06:00
* /
if parent != nil && entry != nil && entry . node != parent . top && len ( nodes ) > 0 {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s): fork after %s" , peerId , hex ( bestpeer . currentBlockHash ) , hex ( hash ) )
2015-02-25 06:34:12 -06:00
self . splitSection ( parent , entry )
self . status . lock . Lock ( )
self . status . values . Forks ++
self . status . lock . Unlock ( )
}
2015-03-19 18:14:08 -05:00
// If new section is created, link it to parent/child sections.
2015-02-25 06:34:12 -06:00
sec = self . linkSections ( nodes , parent , child )
2015-03-02 11:43:12 -06:00
if sec != nil {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s): section [%s] created" , peerId , hex ( bestpeer . currentBlockHash ) , sectionhex ( sec ) )
2015-03-02 11:43:12 -06:00
}
2015-02-25 06:34:12 -06:00
self . chainLock . Unlock ( )
/ *
2015-03-19 18:14:08 -05:00
If a blockpool node is reached ( parent section is not nil ) ,
2015-02-25 06:34:12 -06:00
activate section ( unless our peer is demoted by now ) .
2015-03-19 18:14:08 -05:00
This can be the bottom half of a newly split section in case of a fork .
2015-02-25 06:34:12 -06:00
bestPeer is nil if we got here after our peer got demoted while processing .
2015-03-19 18:14:08 -05:00
In this case no activation should happen
2015-02-25 06:34:12 -06:00
* /
if parent != nil && ! peerswitch {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s): parent section [%s]" , peerId , hex ( bestpeer . currentBlockHash ) , sectionhex ( parent ) )
2015-04-08 14:33:54 -05:00
self . activateChain ( parent , bestpeer , bestpeer . switchC , nil )
2015-02-25 06:34:12 -06:00
}
/ *
2015-03-19 18:14:08 -05:00
If a new section was created , register section iff head section or no child known
Activate it with this peer .
2015-02-25 06:34:12 -06:00
* /
if sec != nil {
// switch on section process (it is paused by switchC)
if ! peerswitch {
if headSection || child == nil {
bestpeer . lock . Lock ( )
bestpeer . sections = append ( bestpeer . sections , sec . top . hash )
bestpeer . lock . Unlock ( )
}
/ *
2015-03-19 18:14:08 -05:00
Request another batch of older block hashes for parent section here .
But only once , repeating only when the section ' s root block arrives .
Otherwise no way to check if it arrived .
2015-02-25 06:34:12 -06:00
* /
bestpeer . requestBlockHashes ( sec . bottom . hash )
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s): start requesting blocks for section [%s]" , peerId , hex ( bestpeer . currentBlockHash ) , sectionhex ( sec ) )
2015-02-25 06:34:12 -06:00
sec . activate ( bestpeer )
} else {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s) no longer best: delay requesting blocks for section [%s]" , peerId , hex ( bestpeer . currentBlockHash ) , sectionhex ( sec ) )
2015-02-25 06:34:12 -06:00
sec . deactivate ( )
}
}
2015-03-19 18:14:08 -05:00
// If we are processing peer's head section, signal it to headSection process that it is created.
2015-02-25 06:34:12 -06:00
if headSection {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s) head section registered on head section process" , peerId , hex ( bestpeer . currentBlockHash ) )
2015-02-25 06:34:12 -06:00
var headSec * section
switch {
case sec != nil :
headSec = sec
case child != nil :
headSec = child
default :
headSec = parent
}
if ! peerswitch {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlockHashes: peer <%s> (head: %s) head section [%s] created signalled to head section process" , peerId , hex ( bestpeer . currentBlockHash ) , sectionhex ( headSec ) )
2015-02-25 06:34:12 -06:00
bestpeer . headSectionC <- headSec
}
}
}
/ *
AddBlock is the entry point for the eth protocol to call when blockMsg is received .
2015-03-19 18:14:08 -05:00
It has a strict interpretation of the protocol in that if the block received has not been requested , it results in an error .
2015-02-25 06:34:12 -06:00
At the same time it is opportunistic in that if a requested block may be provided by any peer .
The received block is checked for PoW . Only the first PoW - valid block for a hash is considered legit .
2015-03-19 18:14:08 -05:00
If the block received is the head block of the current best peer , signal it to the head section process
2015-02-25 06:34:12 -06:00
* /
func ( self * BlockPool ) AddBlock ( block * types . Block , peerId string ) {
self . status . lock . Lock ( )
self . status . activePeers [ peerId ] ++
self . status . lock . Unlock ( )
2015-04-10 10:31:00 -05:00
hash := block . Hash ( )
2015-04-07 12:53:05 -05:00
2015-04-10 10:31:00 -05:00
// check if block is already inserted in the blockchain
if self . hasBlock ( hash ) {
2015-02-25 06:34:12 -06:00
return
}
2015-04-10 10:31:00 -05:00
sender , _ := self . peers . getPeer ( peerId )
if sender == nil {
2015-02-25 06:34:12 -06:00
return
}
2015-04-12 14:25:09 -05:00
sender . lock . Lock ( )
2015-04-10 10:31:00 -05:00
tdFromCurrentHead , currentBlockHash := sender . setChainInfoFromBlock ( block )
2015-02-25 06:34:12 -06:00
2015-04-10 10:31:00 -05:00
entry := self . get ( hash )
2015-02-25 06:34:12 -06:00
2015-04-10 10:31:00 -05:00
/ * @ zelig ! ! !
requested 5 hashes from both A & B . A responds sooner then B , process blocks . Close section .
delayed B sends you block ... UNREQUESTED . Blocked
if entry == nil {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlock: unrequested block %s received from peer <%s> (head: %s)" , hex ( hash ) , peerId , hex ( sender . currentBlockHash ) )
2015-04-10 10:31:00 -05:00
sender . addError ( ErrUnrequestedBlock , "%x" , hash )
self . status . lock . Lock ( )
self . status . badPeers [ peerId ] ++
self . status . lock . Unlock ( )
return
}
2015-04-05 08:14:06 -05:00
* /
2015-02-25 06:34:12 -06:00
2015-04-10 10:31:00 -05:00
var bnode * node
if entry == nil {
self . nodeCacheLock . Lock ( )
2015-04-12 14:25:09 -05:00
bnode = self . findOrCreateNode ( currentBlockHash , peerId )
2015-04-10 10:31:00 -05:00
self . nodeCacheLock . Unlock ( )
} else {
bnode = entry . node
}
bnode . lock . Lock ( )
2015-02-25 06:34:12 -06:00
2015-04-10 10:31:00 -05:00
// check if block already received
if bnode . block != nil {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlock: block %s from peer <%s> (head: %s) already sent by <%s> " , hex ( hash ) , peerId , hex ( sender . currentBlockHash ) , bnode . blockBy )
2015-04-10 10:31:00 -05:00
// register peer on node as source
if bnode . peers == nil {
bnode . peers = make ( map [ string ] bool )
}
foundBlockCurrentHead , found := bnode . peers [ sender . id ]
if ! found || foundBlockCurrentHead {
// if found but not FoundBlockCurrentHead, then no update
// necessary (||)
bnode . peers [ sender . id ] = ( currentBlockHash == hash )
// for those that are false, TD will update their head
// for those that are true, TD is checked !
// this is checked at the time of TD calculation in checkTD
}
sender . setChainInfoFromNode ( bnode )
} else {
/ *
@ zelig needs discussing
Viktor : pow check can be delayed in a go routine and therefore cache
creation is not blocking
// validate block for PoW
if ! self . verifyPoW ( block ) {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Warn ) . Warnf ( "AddBlock: invalid PoW on block %s from peer <%s> (head: %s)" , hex ( hash ) , peerId , hex ( sender . currentBlockHash ) )
2015-04-10 10:31:00 -05:00
sender . addError ( ErrInvalidPoW , "%x" , hash )
self . status . lock . Lock ( )
self . status . badPeers [ peerId ] ++
self . status . lock . Unlock ( )
return
}
* /
bnode . block = block
bnode . blockBy = peerId
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "AddBlock: set td on node %s from peer <%s> (head: %s) to %v (was %v) " , hex ( hash ) , peerId , hex ( sender . currentBlockHash ) , bnode . td , tdFromCurrentHead )
2015-04-10 10:31:00 -05:00
bnode . td = tdFromCurrentHead
self . status . lock . Lock ( )
self . status . values . Blocks ++
self . status . values . BlocksInPool ++
self . status . lock . Unlock ( )
}
2015-04-12 14:25:09 -05:00
bnode . lock . Unlock ( )
currentBlockC := sender . currentBlockC
switchC := sender . switchC
sender . lock . Unlock ( )
// this must be called without peerlock.
// peerlock held can halt the loop and block on select forever
if tdFromCurrentHead != nil {
select {
case currentBlockC <- block :
case <- switchC : // peer is not best peer
}
}
}
func ( self * BlockPool ) findOrCreateNode ( hash common . Hash , peerId string ) ( bnode * node ) {
bnode , _ = self . nodeCache [ hash ]
if bnode == nil {
bnode = & node {
hash : hash ,
hashBy : peerId ,
}
self . nodeCache [ hash ] = bnode
// purge oversize cache
if len ( self . nodeCache ) > self . Config . NodeCacheSize {
delete ( self . nodeCache , self . nodeCacheList [ 0 ] )
self . nodeCacheList = append ( self . nodeCacheList [ 1 : ] , hash )
} else {
self . nodeCacheList = append ( self . nodeCacheList , hash )
}
2015-02-25 06:34:12 -06:00
2015-04-12 14:25:09 -05:00
self . status . lock . Lock ( )
self . status . values . BlockHashes ++
self . status . lock . Unlock ( )
}
return
2015-02-25 06:34:12 -06:00
}
/ *
2015-03-19 18:14:08 -05:00
activateChain iterates down a chain section by section .
It activates the section process on incomplete sections with peer .
It relinks orphaned sections with their parent if root block ( and its parent hash ) is known .
2015-02-25 06:34:12 -06:00
* /
2015-04-08 14:33:54 -05:00
func ( self * BlockPool ) activateChain ( sec * section , p * peer , switchC chan bool , connected map [ common . Hash ] * section ) {
2015-02-25 06:34:12 -06:00
var i int
LOOP :
for sec != nil {
2015-04-12 14:25:09 -05:00
parent := sec . parent
glog . V ( logger . Detail ) . Infof ( "activateChain: section [%s] activated by peer <%s>" , sectionhex ( sec ) , p . id )
2015-02-25 06:34:12 -06:00
sec . activate ( p )
if i > 0 && connected != nil {
2015-03-25 06:09:50 -05:00
connected [ sec . top . hash ] = sec
2015-02-25 06:34:12 -06:00
}
/ *
2015-03-19 18:14:08 -05:00
Need to relink both complete and incomplete sections
An incomplete section could have been blockHashesRequestsComplete before being delinked from its parent .
2015-02-25 06:34:12 -06:00
* /
2015-03-02 11:43:12 -06:00
if parent == nil {
if sec . bottom . block != nil {
if entry := self . get ( sec . bottom . block . ParentHash ( ) ) ; entry != nil {
parent = entry . section
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "activateChain: [%s]-[%s] link" , sectionhex ( parent ) , sectionhex ( sec ) )
2015-03-02 11:43:12 -06:00
link ( parent , sec )
}
} else {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "activateChain: section [%s] activated by peer <%s> has missing root block" , sectionhex ( sec ) , p . id )
2015-02-25 06:34:12 -06:00
}
}
sec = parent
2015-03-19 18:14:08 -05:00
// stop if peer got demoted or global quit
2015-02-25 06:34:12 -06:00
select {
case <- switchC :
break LOOP
case <- self . quit :
break LOOP
default :
}
}
}
2015-03-19 18:14:08 -05:00
// check if block's actual TD (calculated after successful insertChain) is identical to TD advertised for peer's head block.
2015-03-19 18:00:19 -05:00
func ( self * BlockPool ) checkTD ( nodes ... * node ) {
for _ , n := range nodes {
2015-04-08 06:43:55 -05:00
// skip check if queued future block
2015-04-12 14:25:09 -05:00
n . lock . RLock ( )
2015-04-08 06:43:55 -05:00
if n . td != nil && ! n . block . Queued ( ) {
2015-04-12 14:25:09 -05:00
glog . V ( logger . Detail ) . Infof ( "peer td %v =?= block td %v" , n . td , n . block . Td )
// @zelig: Commented out temp untill the rest of the network has been fixed.
2015-03-19 18:00:19 -05:00
if n . td . Cmp ( n . block . Td ) != 0 {
2015-04-12 14:25:09 -05:00
self . peers . peerError ( n . blockBy , ErrIncorrectTD , "on block %x peer td %v =?= block td %v" , n . hash , n . td , n . block . Td )
2015-04-08 15:14:49 -05:00
self . status . lock . Lock ( )
self . status . badPeers [ n . blockBy ] ++
self . status . lock . Unlock ( )
2015-03-19 18:00:19 -05:00
}
}
2015-04-12 14:25:09 -05:00
n . lock . RUnlock ( )
2015-03-19 18:00:19 -05:00
}
}
2015-03-19 18:14:08 -05:00
// requestBlocks must run in separate go routine, otherwise
2015-02-25 06:34:12 -06:00
// switchpeer -> activateChain -> activate deadlocks on section process select and peers.lock
2015-03-16 17:10:26 -05:00
func ( self * BlockPool ) requestBlocks ( attempts int , hashes [ ] common . Hash ) {
2015-02-25 06:34:12 -06:00
self . wg . Add ( 1 )
go func ( ) {
self . peers . requestBlocks ( attempts , hashes )
self . wg . Done ( )
} ( )
}
// convenience methods to access adjacent sections
func ( self * BlockPool ) getParent ( sec * section ) * section {
self . chainLock . RLock ( )
defer self . chainLock . RUnlock ( )
return sec . parent
}
func ( self * BlockPool ) getChild ( sec * section ) * section {
self . chainLock . RLock ( )
defer self . chainLock . RUnlock ( )
return sec . child
}
// accessor and setter for entries in the pool
2015-03-16 17:10:26 -05:00
func ( self * BlockPool ) get ( hash common . Hash ) * entry {
2015-02-25 06:34:12 -06:00
self . lock . RLock ( )
defer self . lock . RUnlock ( )
2015-03-20 06:57:47 -05:00
return self . pool [ hash ]
2015-02-25 06:34:12 -06:00
}
2015-03-16 17:10:26 -05:00
func ( self * BlockPool ) set ( hash common . Hash , e * entry ) {
2015-02-25 06:34:12 -06:00
self . lock . Lock ( )
defer self . lock . Unlock ( )
2015-03-20 06:57:47 -05:00
self . pool [ hash ] = e
2015-02-25 06:34:12 -06:00
}
2015-03-19 17:53:15 -05:00
// accessor and setter for total difficulty
func ( self * BlockPool ) getTD ( ) * big . Int {
self . lock . RLock ( )
defer self . lock . RUnlock ( )
return self . td
}
func ( self * BlockPool ) setTD ( td * big . Int ) {
self . lock . Lock ( )
defer self . lock . Unlock ( )
self . td = td
}
2015-02-25 06:34:12 -06:00
func ( self * BlockPool ) remove ( sec * section ) {
// delete node entries from pool index under pool lock
self . lock . Lock ( )
defer self . lock . Unlock ( )
2015-03-02 11:43:12 -06:00
2015-02-25 06:34:12 -06:00
for _ , node := range sec . nodes {
2015-03-20 06:57:47 -05:00
delete ( self . pool , node . hash )
2015-02-25 06:34:12 -06:00
}
2015-03-02 11:43:12 -06:00
if sec . initialised && sec . poolRootIndex != 0 {
self . status . lock . Lock ( )
self . status . values . BlocksInPool -= len ( sec . nodes ) - sec . missing
self . status . lock . Unlock ( )
}
2015-02-25 06:34:12 -06:00
}
2015-03-19 18:14:08 -05:00
// get/put for optimised allocation similar to sync.Pool
2015-03-16 17:10:26 -05:00
func ( self * BlockPool ) getHashSlice ( ) ( s [ ] common . Hash ) {
2015-02-25 06:34:12 -06:00
select {
case s = <- self . hashSlicePool :
default :
2015-03-16 17:10:26 -05:00
s = make ( [ ] common . Hash , self . Config . BlockBatchSize )
2015-02-25 06:34:12 -06:00
}
return
}
2015-03-16 17:10:26 -05:00
func ( self * BlockPool ) putHashSlice ( s [ ] common . Hash ) {
2015-02-25 06:34:12 -06:00
if len ( s ) == self . Config . BlockBatchSize {
select {
case self . hashSlicePool <- s :
default :
}
}
}
// pretty prints hash (byte array) with first 4 bytes in hex
2015-03-16 17:10:26 -05:00
func hex ( hash common . Hash ) ( name string ) {
if ( hash == common . Hash { } ) {
2015-02-25 06:34:12 -06:00
name = ""
} else {
name = fmt . Sprintf ( "%x" , hash [ : 4 ] )
}
return
}
// pretty prints a section using first 4 bytes in hex of bottom and top blockhash of the section
func sectionhex ( section * section ) ( name string ) {
if section == nil {
name = ""
} else {
name = fmt . Sprintf ( "%x-%x" , section . bottom . hash [ : 4 ] , section . top . hash [ : 4 ] )
}
return
}