path: root/eth/peer.go

package eth

import (
    "errors"
    "fmt"
    "math/big"
    "sync"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core/types"
    "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"
    "gopkg.in/fatih/set.v0"
)

var (
    errAlreadyRegistered = errors.New("peer is already registered")
    errNotRegistered     = errors.New("peer is not registered")
)

type statusMsgData struct {
    ProtocolVersion uint32
    NetworkId       uint32
    TD              *big.Int
    CurrentBlock    common.Hash
    GenesisBlock    common.Hash
}

type getBlockHashesMsgData struct {
    Hash   common.Hash
    Amount uint64
}

type peer struct {
    *p2p.Peer

    rw p2p.MsgReadWriter

    version int // Protocol version negotiated
    network int // Network ID being on

    id string

    head common.Hash
    td   *big.Int
    lock sync.RWMutex

    genesis, ourHash common.Hash
    ourTd            *big.Int

    txHashes    *set.Set
    blockHashes *set.Set
}

func newPeer(version, network int, genesis, head common.Hash, td *big.Int, p *p2p.Peer, rw p2p.MsgReadWriter) *peer {
    id := p.ID()

    return &peer{
        Peer:        p,
        rw:          rw,
        genesis:     genesis,
        ourHash:     head,
        ourTd:       td,
        version:     version,
        network:     network,
        id:          fmt.Sprintf("%x", id[:8]),
        txHashes:    set.New(),
        blockHashes: set.New(),
    }
}

// Head retrieves a copy of the current head (most recent) hash of the peer.
func (p *peer) Head() (hash common.Hash) {
    p.lock.RLock()
    defer p.lock.RUnlock()

    copy(hash[:], p.head[:])
    return hash
}

// SetHead updates the head (most recent) hash of the peer.
func (p *peer) SetHead(hash common.Hash) {
    p.lock.Lock()
    defer p.lock.Unlock()

    copy(p.head[:], hash[:])
}

// Td retrieves the current total difficulty of a peer.
func (p *peer) Td() *big.Int {
    p.lock.RLock()
    defer p.lock.RUnlock()

    return new(big.Int).Set(p.td)
}

// SetTd updates the current total difficulty of a peer.
func (p *peer) SetTd(td *big.Int) {
    p.lock.Lock()
    defer p.lock.Unlock()

    p.td.Set(td)
}

// sendTransactions sends transactions to the peer and includes the hashes
// in its transaction hash set for future reference.
func (p *peer) sendTransactions(txs types.Transactions) error {
    propTxnOutPacketsMeter.Mark(1)
    for _, tx := range txs {
        propTxnOutTrafficMeter.Mark(tx.Size().Int64())
        p.txHashes.Add(tx.Hash())
    }
    return p2p.Send(p.rw, TxMsg, txs)
}

// sendBlockHashes sends a batch of known hashes to the remote peer.
func (p *peer) sendBlockHashes(hashes []common.Hash) error {
    reqHashOutPacketsMeter.Mark(1)
    reqHashOutTrafficMeter.Mark(int64(32 * len(hashes)))

    return p2p.Send(p.rw, BlockHashesMsg, hashes)
}

// sendBlocks sends a batch of blocks to the remote peer.
func (p *peer) sendBlocks(blocks []*types.Block) error {
    reqBlockOutPacketsMeter.Mark(1)
    for _, block := range blocks {
        reqBlockOutTrafficMeter.Mark(block.Size().Int64())
    }
    return p2p.Send(p.rw, BlocksMsg, blocks)
}

// sendNewBlockHashes announces the availability of a number of blocks through
// a hash notification.
func (p *peer) sendNewBlockHashes(hashes []common.Hash) error {
    propHashOutPacketsMeter.Mark(1)
    propHashOutTrafficMeter.Mark(int64(32 * len(hashes)))

    for _, hash := range hashes {
        p.blockHashes.Add(hash)
    }
    return p2p.Send(p.rw, NewBlockHashesMsg, hashes)
}

// sendNewBlock propagates an entire block to a remote peer.
func (p *peer) sendNewBlock(block *types.Block) error {
    propBlockOutPacketsMeter.Mark(1)
    propBlockOutTrafficMeter.Mark(block.Size().Int64())

    p.blockHashes.Add(block.Hash())
    return p2p.Send(p.rw, NewBlockMsg, []interface{}{block, block.Td})
}

// requestHashes fetches a batch of hashes from a peer, starting at from, going
// towards the genesis block.
func (p *peer) requestHashes(from common.Hash) error {
    glog.V(logger.Debug).Infof("Peer [%s] fetching hashes (%d) %x...\n", p.id, downloader.MaxHashFetch, from[:4])
    return p2p.Send(p.rw, GetBlockHashesMsg, getBlockHashesMsgData{from, uint64(downloader.MaxHashFetch)})
}

func (p *peer) requestBlocks(hashes []common.Hash) error {
    glog.V(logger.Debug).Infof("[%s] fetching %v blocks\n", p.id, len(hashes))
    return p2p.Send(p.rw, GetBlocksMsg, hashes)
}

func (p *peer) handleStatus() error {
    errc := make(chan error, 1)
    go func() {
        errc <- p2p.Send(p.rw, StatusMsg, &statusMsgData{
            ProtocolVersion: uint32(p.version),
            NetworkId:       uint32(p.network),
            TD:              p.ourTd,
            CurrentBlock:    p.ourHash,
            GenesisBlock:    p.genesis,
        })
    }()

    // read and handle remote status
    msg, err := p.rw.ReadMsg()
    if err != nil {
        return err
    }
    if msg.Code != StatusMsg {
        return errResp(ErrNoStatusMsg, "first msg has code %x (!= %x)", msg.Code, StatusMsg)
    }
    if msg.Size > ProtocolMaxMsgSize {
        return errResp(ErrMsgTooLarge, "%v > %v", msg.Size, ProtocolMaxMsgSize)
    }

    var status statusMsgData
    if err := msg.Decode(&status); err != nil {
        return errResp(ErrDecode, "msg %v: %v", msg, err)
    }

    if status.GenesisBlock != p.genesis {
        return errResp(ErrGenesisBlockMismatch, "%x (!= %x)", status.GenesisBlock, p.genesis)
    }

    if int(status.NetworkId) != p.network {
        return errResp(ErrNetworkIdMismatch, "%d (!= %d)", status.NetworkId, p.network)
    }

    if int(status.ProtocolVersion) != p.version {
        return errResp(ErrProtocolVersionMismatch, "%d (!= %d)", status.ProtocolVersion, p.version)
    }
    // Set the total difficulty of the peer
    p.td = status.TD
    // set the best hash of the peer
    p.head = status.CurrentBlock

    return <-errc
}

// String implements fmt.Stringer.
func (p *peer) String() string {
    return fmt.Sprintf("Peer %s [%s]", p.id,
        fmt.Sprintf("eth/%2d", p.version),
    )
}

// peerSet represents the collection of active peers currently participating in
// the Ethereum sub-protocol.
type peerSet struct {
    peers map[string]*peer
    lock  sync.RWMutex
}

// newPeerSet creates a new peer set to track the active participants.
func newPeerSet() *peerSet {
    return &peerSet{
        peers: make(map[string]*peer),
    }
}

// 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()

    if _, ok := ps.peers[p.id]; ok {
        return errAlreadyRegistered
    }
    ps.peers[p.id] = p
    return nil
}

// 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)
    return nil
}

// 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]
}

// Len returns if the current number of peers in the set.
func (ps *peerSet) Len() int {
    ps.lock.RLock()
    defer ps.lock.RUnlock()

    return len(ps.peers)
}

// PeersWithoutBlock retrieves a list of peers that do not have a given block in
// their set of known hashes.
func (ps *peerSet) PeersWithoutBlock(hash common.Hash) []*peer {
    ps.lock.RLock()
    defer ps.lock.RUnlock()

    list := make([]*peer, 0, len(ps.peers))
    for _, p := range ps.peers {
        if !p.blockHashes.Has(hash) {
            list = append(list, p)
        }
    }
    return list
}

// PeersWithoutTx retrieves a list of peers that do not have a given transaction
// in their set of known hashes.
func (ps *peerSet) PeersWithoutTx(hash common.Hash) []*peer {
    ps.lock.RLock()
    defer ps.lock.RUnlock()

    list := make([]*peer, 0, len(ps.peers))
    for _, p := range ps.peers {
        if !p.txHashes.Has(hash) {
            list = append(list, p)
        }
    }
    return list
}

// BestPeer retrieves the known peer with the currently highest total difficulty.
func (ps *peerSet) BestPeer() *peer {
    ps.lock.RLock()
    defer ps.lock.RUnlock()

    var (
        bestPeer *peer
        bestTd   *big.Int
    )
    for _, p := range ps.peers {
        if td := p.Td(); bestPeer == nil || td.Cmp(bestTd) > 0 {
            bestPeer, bestTd = p, td
        }
    }
    return bestPeer
}