2015-05-11 11:26:20 +00:00
|
|
|
// Contains the active peer-set of the downloader, maintaining both failures
|
|
|
|
// as well as reputation metrics to prioritize the block retrievals.
|
|
|
|
|
2015-04-12 10:38:25 +00:00
|
|
|
package downloader
|
|
|
|
|
|
|
|
import (
|
2015-04-12 11:33:42 +00:00
|
|
|
"errors"
|
2015-06-03 11:39:21 +00:00
|
|
|
"math"
|
2015-04-12 10:38:25 +00:00
|
|
|
"sync"
|
2015-05-11 11:26:20 +00:00
|
|
|
"sync/atomic"
|
2015-06-03 11:39:21 +00:00
|
|
|
"time"
|
2015-04-12 10:38:25 +00:00
|
|
|
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
2015-06-03 11:39:21 +00:00
|
|
|
"github.com/ethereum/go-ethereum/logger"
|
|
|
|
"github.com/ethereum/go-ethereum/logger/glog"
|
2015-04-18 16:54:57 +00:00
|
|
|
"gopkg.in/fatih/set.v0"
|
2015-04-12 10:38:25 +00:00
|
|
|
)
|
|
|
|
|
2015-04-13 14:38:32 +00:00
|
|
|
type hashFetcherFn func(common.Hash) error
|
|
|
|
type blockFetcherFn func([]common.Hash) error
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
var (
|
|
|
|
errAlreadyFetching = errors.New("already fetching blocks from peer")
|
|
|
|
errAlreadyRegistered = errors.New("peer is already registered")
|
|
|
|
errNotRegistered = errors.New("peer is not registered")
|
|
|
|
)
|
2015-04-13 14:38:32 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// peer represents an active peer from which hashes and blocks are retrieved.
|
|
|
|
type peer struct {
|
|
|
|
id string // Unique identifier of the peer
|
|
|
|
head common.Hash // Hash of the peers latest known block
|
|
|
|
|
|
|
|
idle int32 // Current activity state of the peer (idle = 0, active = 1)
|
2015-06-03 11:39:21 +00:00
|
|
|
rep int32 // Simple peer reputation
|
2015-05-11 11:26:20 +00:00
|
|
|
|
2015-06-03 11:39:21 +00:00
|
|
|
capacity int32 // Number of blocks allowed to fetch per request
|
|
|
|
started time.Time // Time instance when the last fetch was started
|
2015-05-11 11:26:20 +00:00
|
|
|
|
2015-06-03 11:39:21 +00:00
|
|
|
ignored *set.Set // Set of hashes not to request (didn't have previously)
|
2015-05-11 11:26:20 +00:00
|
|
|
|
2015-06-03 11:39:21 +00:00
|
|
|
getHashes hashFetcherFn // Method to retrieve a batch of hashes (mockable for testing)
|
|
|
|
getBlocks blockFetcherFn // Method to retrieve a batch of blocks (mockable for testing)
|
2015-04-18 18:25:55 +00:00
|
|
|
}
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// newPeer create a new downloader peer, with specific hash and block retrieval
|
|
|
|
// mechanisms.
|
|
|
|
func newPeer(id string, head common.Hash, getHashes hashFetcherFn, getBlocks blockFetcherFn) *peer {
|
|
|
|
return &peer{
|
|
|
|
id: id,
|
|
|
|
head: head,
|
2015-06-03 11:39:21 +00:00
|
|
|
capacity: 1,
|
2015-05-11 11:26:20 +00:00
|
|
|
getHashes: getHashes,
|
|
|
|
getBlocks: getBlocks,
|
|
|
|
ignored: set.New(),
|
2015-04-13 14:38:32 +00:00
|
|
|
}
|
2015-05-11 11:26:20 +00:00
|
|
|
}
|
2015-04-13 14:38:32 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Reset clears the internal state of a peer entity.
|
|
|
|
func (p *peer) Reset() {
|
|
|
|
atomic.StoreInt32(&p.idle, 0)
|
2015-06-03 11:39:21 +00:00
|
|
|
atomic.StoreInt32(&p.capacity, 1)
|
2015-05-11 11:26:20 +00:00
|
|
|
p.ignored.Clear()
|
2015-04-13 14:38:32 +00:00
|
|
|
}
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Fetch sends a block retrieval request to the remote peer.
|
|
|
|
func (p *peer) Fetch(request *fetchRequest) error {
|
|
|
|
// Short circuit if the peer is already fetching
|
|
|
|
if !atomic.CompareAndSwapInt32(&p.idle, 0, 1) {
|
|
|
|
return errAlreadyFetching
|
2015-04-13 14:38:32 +00:00
|
|
|
}
|
2015-06-03 11:39:21 +00:00
|
|
|
p.started = time.Now()
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Convert the hash set to a retrievable slice
|
|
|
|
hashes := make([]common.Hash, 0, len(request.Hashes))
|
|
|
|
for hash, _ := range request.Hashes {
|
|
|
|
hashes = append(hashes, hash)
|
|
|
|
}
|
|
|
|
p.getBlocks(hashes)
|
2015-04-13 14:38:32 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
return nil
|
2015-04-13 14:38:32 +00:00
|
|
|
}
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// SetIdle sets the peer to idle, allowing it to execute new retrieval requests.
|
2015-06-03 11:39:21 +00:00
|
|
|
// Its block retrieval allowance will also be updated either up- or downwards,
|
|
|
|
// depending on whether the previous fetch completed in time or not.
|
2015-05-11 11:26:20 +00:00
|
|
|
func (p *peer) SetIdle() {
|
2015-06-03 11:39:21 +00:00
|
|
|
// Update the peer's download allowance based on previous performance
|
|
|
|
scale := 2.0
|
|
|
|
if time.Since(p.started) > blockSoftTTL {
|
|
|
|
scale = 0.5
|
|
|
|
}
|
|
|
|
for {
|
|
|
|
// Calculate the new download bandwidth allowance
|
|
|
|
prev := atomic.LoadInt32(&p.capacity)
|
|
|
|
next := int32(math.Max(1, math.Min(MaxBlockFetch, float64(prev)*scale)))
|
2015-06-03 12:43:12 +00:00
|
|
|
|
2015-06-03 11:39:21 +00:00
|
|
|
// Try to update the old value
|
|
|
|
if atomic.CompareAndSwapInt32(&p.capacity, prev, next) {
|
2015-06-03 12:43:12 +00:00
|
|
|
// If we're having problems at 1 capacity, try to find better peers
|
|
|
|
if next == 1 {
|
|
|
|
p.Demote()
|
|
|
|
}
|
|
|
|
if prev != next {
|
|
|
|
glog.V(logger.Detail).Infof("%s: changing block download capacity from %d to %d", p.id, prev, next)
|
|
|
|
}
|
2015-06-03 11:39:21 +00:00
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// Set the peer to idle to allow further block requests
|
2015-05-11 11:26:20 +00:00
|
|
|
atomic.StoreInt32(&p.idle, 0)
|
|
|
|
}
|
2015-04-12 10:38:25 +00:00
|
|
|
|
2015-06-03 11:39:21 +00:00
|
|
|
// Capacity retrieves the peers block download allowance based on its previously
|
|
|
|
// discovered bandwidth capacity.
|
|
|
|
func (p *peer) Capacity() int {
|
|
|
|
return int(atomic.LoadInt32(&p.capacity))
|
|
|
|
}
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Promote increases the peer's reputation.
|
|
|
|
func (p *peer) Promote() {
|
|
|
|
atomic.AddInt32(&p.rep, 1)
|
|
|
|
}
|
2015-04-12 10:38:25 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Demote decreases the peer's reputation or leaves it at 0.
|
|
|
|
func (p *peer) Demote() {
|
|
|
|
for {
|
|
|
|
// Calculate the new reputation value
|
|
|
|
prev := atomic.LoadInt32(&p.rep)
|
2015-05-11 13:47:58 +00:00
|
|
|
next := prev / 2
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Try to update the old value
|
|
|
|
if atomic.CompareAndSwapInt32(&p.rep, prev, next) {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2015-04-18 16:54:57 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// peerSet represents the collection of active peer participating in the block
|
|
|
|
// download procedure.
|
|
|
|
type peerSet struct {
|
|
|
|
peers map[string]*peer
|
|
|
|
lock sync.RWMutex
|
2015-04-12 10:38:25 +00:00
|
|
|
}
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// newPeerSet creates a new peer set top track the active download sources.
|
|
|
|
func newPeerSet() *peerSet {
|
|
|
|
return &peerSet{
|
|
|
|
peers: make(map[string]*peer),
|
2015-04-18 16:54:57 +00:00
|
|
|
}
|
2015-04-12 10:38:25 +00:00
|
|
|
}
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Reset iterates over the current peer set, and resets each of the known peers
|
|
|
|
// to prepare for a next batch of block retrieval.
|
|
|
|
func (ps *peerSet) Reset() {
|
|
|
|
ps.lock.RLock()
|
|
|
|
defer ps.lock.RUnlock()
|
2015-04-12 10:38:25 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
for _, peer := range ps.peers {
|
|
|
|
peer.Reset()
|
2015-04-12 11:33:42 +00:00
|
|
|
}
|
2015-05-11 11:26:20 +00:00
|
|
|
}
|
2015-04-12 11:33:42 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Register injects a new peer into the working set, or returns an error if the
|
|
|
|
// peer is already known.
|
|
|
|
func (ps *peerSet) Register(p *peer) error {
|
|
|
|
ps.lock.Lock()
|
|
|
|
defer ps.lock.Unlock()
|
2015-05-06 12:32:53 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
if _, ok := ps.peers[p.id]; ok {
|
|
|
|
return errAlreadyRegistered
|
2015-05-06 12:32:53 +00:00
|
|
|
}
|
2015-05-11 11:26:20 +00:00
|
|
|
ps.peers[p.id] = p
|
|
|
|
return nil
|
|
|
|
}
|
2015-04-12 11:33:42 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Unregister removes a remote peer from the active set, disabling any further
|
|
|
|
// actions to/from that particular entity.
|
|
|
|
func (ps *peerSet) Unregister(id string) error {
|
|
|
|
ps.lock.Lock()
|
|
|
|
defer ps.lock.Unlock()
|
|
|
|
|
|
|
|
if _, ok := ps.peers[id]; !ok {
|
|
|
|
return errNotRegistered
|
|
|
|
}
|
|
|
|
delete(ps.peers, id)
|
2015-04-12 11:33:42 +00:00
|
|
|
return nil
|
2015-04-12 10:38:25 +00:00
|
|
|
}
|
2015-04-16 00:16:33 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// Peer retrieves the registered peer with the given id.
|
|
|
|
func (ps *peerSet) Peer(id string) *peer {
|
|
|
|
ps.lock.RLock()
|
|
|
|
defer ps.lock.RUnlock()
|
|
|
|
|
|
|
|
return ps.peers[id]
|
|
|
|
}
|
|
|
|
|
2015-05-11 14:06:42 +00:00
|
|
|
// Len returns if the current number of peers in the set.
|
|
|
|
func (ps *peerSet) Len() int {
|
2015-05-11 11:26:20 +00:00
|
|
|
ps.lock.RLock()
|
|
|
|
defer ps.lock.RUnlock()
|
2015-04-16 00:16:33 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
return len(ps.peers)
|
2015-04-16 00:16:33 +00:00
|
|
|
}
|
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// AllPeers retrieves a flat list of all the peers within the set.
|
|
|
|
func (ps *peerSet) AllPeers() []*peer {
|
|
|
|
ps.lock.RLock()
|
|
|
|
defer ps.lock.RUnlock()
|
2015-04-16 00:16:33 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
list := make([]*peer, 0, len(ps.peers))
|
|
|
|
for _, p := range ps.peers {
|
|
|
|
list = append(list, p)
|
2015-04-16 00:16:33 +00:00
|
|
|
}
|
2015-05-11 11:26:20 +00:00
|
|
|
return list
|
2015-04-16 00:16:33 +00:00
|
|
|
}
|
2015-04-18 18:25:55 +00:00
|
|
|
|
2015-05-11 11:26:20 +00:00
|
|
|
// IdlePeers retrieves a flat list of all the currently idle peers within the
|
2015-05-11 13:47:58 +00:00
|
|
|
// active peer set, ordered by their reputation.
|
2015-05-11 11:26:20 +00:00
|
|
|
func (ps *peerSet) IdlePeers() []*peer {
|
|
|
|
ps.lock.RLock()
|
|
|
|
defer ps.lock.RUnlock()
|
|
|
|
|
|
|
|
list := make([]*peer, 0, len(ps.peers))
|
|
|
|
for _, p := range ps.peers {
|
|
|
|
if atomic.LoadInt32(&p.idle) == 0 {
|
|
|
|
list = append(list, p)
|
|
|
|
}
|
|
|
|
}
|
2015-05-11 13:47:58 +00:00
|
|
|
for i := 0; i < len(list); i++ {
|
|
|
|
for j := i + 1; j < len(list); j++ {
|
|
|
|
if atomic.LoadInt32(&list[i].rep) < atomic.LoadInt32(&list[j].rep) {
|
|
|
|
list[i], list[j] = list[j], list[i]
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2015-05-11 11:26:20 +00:00
|
|
|
return list
|
2015-04-18 18:25:55 +00:00
|
|
|
}
|