netsync/handle.go

   1 package netsync
   2
   3 import (
   4         "encoding/hex"
   5         "errors"
   6         "net"
   7         "path"
   8         "reflect"
   9         "strconv"
  10         "strings"
  11
  12         log "github.com/sirupsen/logrus"
  13         "github.com/tendermint/go-crypto"
  14         cmn "github.com/tendermint/tmlibs/common"
  15
  16         cfg "github.com/bytom/config"
  17         "github.com/bytom/consensus"
  18         "github.com/bytom/p2p"
  19         "github.com/bytom/p2p/discover"
  20         core "github.com/bytom/protocol"
  21         "github.com/bytom/protocol/bc"
  22         "github.com/bytom/protocol/bc/types"
  23         "github.com/bytom/version"
  24 )
  25
  26 const (
  27         maxTxChanSize         = 10000
  28         maxFilterAddressSize  = 50
  29         maxFilterAddressCount = 1000
  30 )
  31
  32 // Chain is the interface for Bytom core
  33 type Chain interface {
  34         BestBlockHeader() *types.BlockHeader
  35         BestBlockHeight() uint64
  36         CalcNextSeed(*bc.Hash) (*bc.Hash, error)
  37         GetBlockByHash(*bc.Hash) (*types.Block, error)
  38         GetBlockByHeight(uint64) (*types.Block, error)
  39         GetHeaderByHash(*bc.Hash) (*types.BlockHeader, error)
  40         GetHeaderByHeight(uint64) (*types.BlockHeader, error)
  41         GetTransactionStatus(*bc.Hash) (*bc.TransactionStatus, error)
  42         InMainChain(bc.Hash) bool
  43         ProcessBlock(*types.Block) (bool, error)
  44         ValidateTx(*types.Tx) (bool, error)
  45 }
  46
  47 //SyncManager Sync Manager is responsible for the business layer information synchronization
  48 type SyncManager struct {
  49         sw          *p2p.Switch
  50         genesisHash bc.Hash
  51
  52         privKey      crypto.PrivKeyEd25519 // local node's p2p key
  53         chain        Chain
  54         txPool       *core.TxPool
  55         blockFetcher *blockFetcher
  56         blockKeeper  *blockKeeper
  57         peers        *peerSet
  58
  59         newTxCh    chan *types.Tx
  60         newBlockCh chan *bc.Hash
  61         txSyncCh   chan *txSyncMsg
  62         quitSync   chan struct{}
  63         config     *cfg.Config
  64 }
  65
  66 //NewSyncManager create a sync manager
  67 func NewSyncManager(config *cfg.Config, chain Chain, txPool *core.TxPool, newBlockCh chan *bc.Hash) (*SyncManager, error) {
  68         genesisHeader, err := chain.GetHeaderByHeight(0)
  69         if err != nil {
  70                 return nil, err
  71         }
  72
  73         sw := p2p.NewSwitch(config)
  74         peers := newPeerSet(sw)
  75         manager := &SyncManager{
  76                 sw:           sw,
  77                 genesisHash:  genesisHeader.Hash(),
  78                 txPool:       txPool,
  79                 chain:        chain,
  80                 privKey:      crypto.GenPrivKeyEd25519(),
  81                 blockFetcher: newBlockFetcher(chain, peers),
  82                 blockKeeper:  newBlockKeeper(chain, peers),
  83                 peers:        peers,
  84                 newTxCh:      make(chan *types.Tx, maxTxChanSize),
  85                 newBlockCh:   newBlockCh,
  86                 txSyncCh:     make(chan *txSyncMsg),
  87                 quitSync:     make(chan struct{}),
  88                 config:       config,
  89         }
  90
  91         protocolReactor := NewProtocolReactor(manager, manager.peers)
  92         manager.sw.AddReactor("PROTOCOL", protocolReactor)
  93
  94         // Create & add listener
  95         var listenerStatus bool
  96         var l p2p.Listener
  97         if !config.VaultMode {
  98                 p, address := protocolAndAddress(manager.config.P2P.ListenAddress)
  99                 l, listenerStatus = p2p.NewDefaultListener(p, address, manager.config.P2P.SkipUPNP)
 100                 manager.sw.AddListener(l)
 101
 102                 discv, err := initDiscover(config, &manager.privKey, l.ExternalAddress().Port)
 103                 if err != nil {
 104                         return nil, err
 105                 }
 106                 manager.sw.SetDiscv(discv)
 107         }
 108         manager.sw.SetNodeInfo(manager.makeNodeInfo(listenerStatus))
 109         manager.sw.SetNodePrivKey(manager.privKey)
 110         return manager, nil
 111 }
 112
 113 //BestPeer return the highest p2p peerInfo
 114 func (sm *SyncManager) BestPeer() *PeerInfo {
 115         bestPeer := sm.peers.bestPeer(consensus.SFFullNode)
 116         if bestPeer != nil {
 117                 return bestPeer.getPeerInfo()
 118         }
 119         return nil
 120 }
 121
 122 // GetNewTxCh return a unconfirmed transaction feed channel
 123 func (sm *SyncManager) GetNewTxCh() chan *types.Tx {
 124         return sm.newTxCh
 125 }
 126
 127 //GetPeerInfos return peer info of all peers
 128 func (sm *SyncManager) GetPeerInfos() []*PeerInfo {
 129         return sm.peers.getPeerInfos()
 130 }
 131
 132 //IsCaughtUp check wheather the peer finish the sync
 133 func (sm *SyncManager) IsCaughtUp() bool {
 134         peer := sm.peers.bestPeer(consensus.SFFullNode)
 135         return peer == nil || peer.Height() <= sm.chain.BestBlockHeight()
 136 }
 137
 138 //NodeInfo get P2P peer node info
 139 func (sm *SyncManager) NodeInfo() *p2p.NodeInfo {
 140         return sm.sw.NodeInfo()
 141 }
 142
 143 //StopPeer try to stop peer by given ID
 144 func (sm *SyncManager) StopPeer(peerID string) error {
 145         if peer := sm.peers.getPeer(peerID); peer == nil {
 146                 return errors.New("peerId not exist")
 147         }
 148         sm.peers.removePeer(peerID)
 149         return nil
 150 }
 151
 152 //Switch get sync manager switch
 153 func (sm *SyncManager) Switch() *p2p.Switch {
 154         return sm.sw
 155 }
 156
 157 func (sm *SyncManager) handleBlockMsg(peer *peer, msg *BlockMessage) {
 158         sm.blockKeeper.processBlock(peer.ID(), msg.GetBlock())
 159 }
 160
 161 func (sm *SyncManager) handleBlocksMsg(peer *peer, msg *BlocksMessage) {
 162         blocks, err := msg.GetBlocks()
 163         if err != nil {
 164                 log.WithField("err", err).Debug("fail on handleBlocksMsg GetBlocks")
 165                 return
 166         }
 167
 168         sm.blockKeeper.processBlocks(peer.ID(), blocks)
 169 }
 170
 171 func (sm *SyncManager) handleFilterAddMsg(peer *peer, msg *FilterAddMessage) {
 172         peer.addFilterAddress(msg.Address)
 173 }
 174
 175 func (sm *SyncManager) handleFilterClearMsg(peer *peer) {
 176         peer.filterAdds.Clear()
 177 }
 178
 179 func (sm *SyncManager) handleFilterLoadMsg(peer *peer, msg *FilterLoadMessage) {
 180         peer.addFilterAddresses(msg.Addresses)
 181 }
 182
 183 func (sm *SyncManager) handleGetBlockMsg(peer *peer, msg *GetBlockMessage) {
 184         var block *types.Block
 185         var err error
 186         if msg.Height != 0 {
 187                 block, err = sm.chain.GetBlockByHeight(msg.Height)
 188         } else {
 189                 block, err = sm.chain.GetBlockByHash(msg.GetHash())
 190         }
 191         if err != nil {
 192                 log.WithField("err", err).Warning("fail on handleGetBlockMsg get block from chain")
 193                 return
 194         }
 195
 196         ok, err := peer.sendBlock(block)
 197         if !ok {
 198                 sm.peers.removePeer(peer.ID())
 199         }
 200         if err != nil {
 201                 log.WithField("err", err).Error("fail on handleGetBlockMsg sentBlock")
 202         }
 203 }
 204
 205 func (sm *SyncManager) handleGetBlocksMsg(peer *peer, msg *GetBlocksMessage) {
 206         blocks, err := sm.blockKeeper.locateBlocks(msg.GetBlockLocator(), msg.GetStopHash())
 207         if err != nil || len(blocks) == 0 {
 208                 return
 209         }
 210
 211         totalSize := 0
 212         sendBlocks := []*types.Block{}
 213         for _, block := range blocks {
 214                 rawData, err := block.MarshalText()
 215                 if err != nil {
 216                         log.WithField("err", err).Error("fail on handleGetBlocksMsg marshal block")
 217                         continue
 218                 }
 219
 220                 if totalSize+len(rawData) > maxBlockchainResponseSize/2 {
 221                         break
 222                 }
 223                 totalSize += len(rawData)
 224                 sendBlocks = append(sendBlocks, block)
 225         }
 226
 227         ok, err := peer.sendBlocks(sendBlocks)
 228         if !ok {
 229                 sm.peers.removePeer(peer.ID())
 230         }
 231         if err != nil {
 232                 log.WithField("err", err).Error("fail on handleGetBlocksMsg sentBlock")
 233         }
 234 }
 235
 236 func (sm *SyncManager) handleGetHeadersMsg(peer *peer, msg *GetHeadersMessage) {
 237         headers, err := sm.blockKeeper.locateHeaders(msg.GetBlockLocator(), msg.GetStopHash())
 238         if err != nil || len(headers) == 0 {
 239                 log.WithField("err", err).Debug("fail on handleGetHeadersMsg locateHeaders")
 240                 return
 241         }
 242
 243         ok, err := peer.sendHeaders(headers)
 244         if !ok {
 245                 sm.peers.removePeer(peer.ID())
 246         }
 247         if err != nil {
 248                 log.WithField("err", err).Error("fail on handleGetHeadersMsg sentBlock")
 249         }
 250 }
 251
 252 func (sm *SyncManager) handleGetMerkleBlockMsg(peer *peer, msg *GetMerkleBlockMessage) {
 253         var err error
 254         var block *types.Block
 255         if msg.Height != 0 {
 256                 block, err = sm.chain.GetBlockByHeight(msg.Height)
 257         } else {
 258                 block, err = sm.chain.GetBlockByHash(msg.GetHash())
 259         }
 260         if err != nil {
 261                 log.WithField("err", err).Warning("fail on handleGetMerkleBlockMsg get block from chain")
 262                 return
 263         }
 264
 265         blockHash := block.Hash()
 266         txStatus, err := sm.chain.GetTransactionStatus(&blockHash)
 267         if err != nil {
 268                 log.WithField("err", err).Warning("fail on handleGetMerkleBlockMsg get transaction status")
 269                 return
 270         }
 271
 272         ok, err := peer.sendMerkleBlock(block, txStatus)
 273         if err != nil {
 274                 log.WithField("err", err).Error("fail on handleGetMerkleBlockMsg sentMerkleBlock")
 275                 return
 276         }
 277
 278         if !ok {
 279                 sm.peers.removePeer(peer.ID())
 280         }
 281 }
 282
 283 func (sm *SyncManager) handleHeadersMsg(peer *peer, msg *HeadersMessage) {
 284         headers, err := msg.GetHeaders()
 285         if err != nil {
 286                 log.WithField("err", err).Debug("fail on handleHeadersMsg GetHeaders")
 287                 return
 288         }
 289
 290         sm.blockKeeper.processHeaders(peer.ID(), headers)
 291 }
 292
 293 func (sm *SyncManager) handleMineBlockMsg(peer *peer, msg *MineBlockMessage) {
 294         block, err := msg.GetMineBlock()
 295         if err != nil {
 296                 log.WithField("err", err).Warning("fail on handleMineBlockMsg GetMineBlock")
 297                 return
 298         }
 299
 300         hash := block.Hash()
 301         peer.markBlock(&hash)
 302         sm.blockFetcher.processNewBlock(&blockMsg{peerID: peer.ID(), block: block})
 303         peer.setStatus(block.Height, &hash)
 304 }
 305
 306 func (sm *SyncManager) handleStatusRequestMsg(peer BasePeer) {
 307         bestHeader := sm.chain.BestBlockHeader()
 308         genesisBlock, err := sm.chain.GetBlockByHeight(0)
 309         if err != nil {
 310                 log.WithField("err", err).Error("fail on handleStatusRequestMsg get genesis")
 311         }
 312
 313         genesisHash := genesisBlock.Hash()
 314         msg := NewStatusResponseMessage(bestHeader, &genesisHash)
 315         if ok := peer.TrySend(BlockchainChannel, struct{ BlockchainMessage }{msg}); !ok {
 316                 sm.peers.removePeer(peer.ID())
 317         }
 318 }
 319
 320 func (sm *SyncManager) handleStatusResponseMsg(basePeer BasePeer, msg *StatusResponseMessage) {
 321         if peer := sm.peers.getPeer(basePeer.ID()); peer != nil {
 322                 peer.setStatus(msg.Height, msg.GetHash())
 323                 return
 324         }
 325
 326         if genesisHash := msg.GetGenesisHash(); sm.genesisHash != *genesisHash {
 327                 log.WithFields(log.Fields{
 328                         "remote genesis": genesisHash.String(),
 329                         "local genesis":  sm.genesisHash.String(),
 330                 }).Warn("fail hand shake due to differnt genesis")
 331                 return
 332         }
 333
 334         sm.peers.addPeer(basePeer, msg.Height, msg.GetHash())
 335 }
 336
 337 func (sm *SyncManager) handleTransactionMsg(peer *peer, msg *TransactionMessage) {
 338         tx, err := msg.GetTransaction()
 339         if err != nil {
 340                 sm.peers.addBanScore(peer.ID(), 0, 10, "fail on get tx from message")
 341                 return
 342         }
 343
 344         if isOrphan, err := sm.chain.ValidateTx(tx); err != nil && isOrphan == false {
 345                 sm.peers.addBanScore(peer.ID(), 10, 0, "fail on validate tx transaction")
 346         }
 347 }
 348
 349 func (sm *SyncManager) processMsg(basePeer BasePeer, msgType byte, msg BlockchainMessage) {
 350         peer := sm.peers.getPeer(basePeer.ID())
 351         if peer == nil && msgType != StatusResponseByte && msgType != StatusRequestByte {
 352                 return
 353         }
 354
 355         switch msg := msg.(type) {
 356         case *GetBlockMessage:
 357                 sm.handleGetBlockMsg(peer, msg)
 358
 359         case *BlockMessage:
 360                 sm.handleBlockMsg(peer, msg)
 361
 362         case *StatusRequestMessage:
 363                 sm.handleStatusRequestMsg(basePeer)
 364
 365         case *StatusResponseMessage:
 366                 sm.handleStatusResponseMsg(basePeer, msg)
 367
 368         case *TransactionMessage:
 369                 sm.handleTransactionMsg(peer, msg)
 370
 371         case *MineBlockMessage:
 372                 sm.handleMineBlockMsg(peer, msg)
 373
 374         case *GetHeadersMessage:
 375                 sm.handleGetHeadersMsg(peer, msg)
 376
 377         case *HeadersMessage:
 378                 sm.handleHeadersMsg(peer, msg)
 379
 380         case *GetBlocksMessage:
 381                 sm.handleGetBlocksMsg(peer, msg)
 382
 383         case *BlocksMessage:
 384                 sm.handleBlocksMsg(peer, msg)
 385
 386         case *FilterLoadMessage:
 387                 sm.handleFilterLoadMsg(peer, msg)
 388
 389         case *FilterAddMessage:
 390                 sm.handleFilterAddMsg(peer, msg)
 391
 392         case *FilterClearMessage:
 393                 sm.handleFilterClearMsg(peer)
 394
 395         case *GetMerkleBlockMessage:
 396                 sm.handleGetMerkleBlockMsg(peer, msg)
 397
 398         default:
 399                 log.Errorf("unknown message type %v", reflect.TypeOf(msg))
 400         }
 401 }
 402
 403 // Defaults to tcp
 404 func protocolAndAddress(listenAddr string) (string, string) {
 405         p, address := "tcp", listenAddr
 406         parts := strings.SplitN(address, "://", 2)
 407         if len(parts) == 2 {
 408                 p, address = parts[0], parts[1]
 409         }
 410         return p, address
 411 }
 412
 413 func (sm *SyncManager) makeNodeInfo(listenerStatus bool) *p2p.NodeInfo {
 414         nodeInfo := &p2p.NodeInfo{
 415                 PubKey:  sm.privKey.PubKey().Unwrap().(crypto.PubKeyEd25519),
 416                 Moniker: sm.config.Moniker,
 417                 Network: sm.config.ChainID,
 418                 Version: version.Version,
 419                 Other:   []string{strconv.FormatUint(uint64(consensus.DefaultServices), 10)},
 420         }
 421
 422         if !sm.sw.IsListening() {
 423                 return nodeInfo
 424         }
 425
 426         p2pListener := sm.sw.Listeners()[0]
 427
 428         // We assume that the rpcListener has the same ExternalAddress.
 429         // This is probably true because both P2P and RPC listeners use UPnP,
 430         // except of course if the rpc is only bound to localhost
 431         if listenerStatus {
 432                 nodeInfo.ListenAddr = cmn.Fmt("%v:%v", p2pListener.ExternalAddress().IP.String(), p2pListener.ExternalAddress().Port)
 433         } else {
 434                 nodeInfo.ListenAddr = cmn.Fmt("%v:%v", p2pListener.InternalAddress().IP.String(), p2pListener.InternalAddress().Port)
 435         }
 436         return nodeInfo
 437 }
 438
 439 //Start start sync manager service
 440 func (sm *SyncManager) Start() {
 441         if _, err := sm.sw.Start(); err != nil {
 442                 cmn.Exit(cmn.Fmt("fail on start SyncManager: %v", err))
 443         }
 444         // broadcast transactions
 445         go sm.txBroadcastLoop()
 446         go sm.minedBroadcastLoop()
 447         go sm.txSyncLoop()
 448 }
 449
 450 //Stop stop sync manager
 451 func (sm *SyncManager) Stop() {
 452         close(sm.quitSync)
 453         sm.sw.Stop()
 454 }
 455
 456 func initDiscover(config *cfg.Config, priv *crypto.PrivKeyEd25519, port uint16) (*discover.Network, error) {
 457         addr, err := net.ResolveUDPAddr("udp", net.JoinHostPort("0.0.0.0", strconv.FormatUint(uint64(port), 10)))
 458         if err != nil {
 459                 return nil, err
 460         }
 461
 462         conn, err := net.ListenUDP("udp", addr)
 463         if err != nil {
 464                 return nil, err
 465         }
 466
 467         realaddr := conn.LocalAddr().(*net.UDPAddr)
 468         ntab, err := discover.ListenUDP(priv, conn, realaddr, path.Join(config.DBDir(), "discover.db"), nil)
 469         if err != nil {
 470                 return nil, err
 471         }
 472
 473         // add the seeds node to the discover table
 474         if config.P2P.Seeds == "" {
 475                 return ntab, nil
 476         }
 477         nodes := []*discover.Node{}
 478         for _, seed := range strings.Split(config.P2P.Seeds, ",") {
 479                 version.Status.AddSeed(seed)
 480                 url := "enode://" + hex.EncodeToString(crypto.Sha256([]byte(seed))) + "@" + seed
 481                 nodes = append(nodes, discover.MustParseNode(url))
 482         }
 483         if err = ntab.SetFallbackNodes(nodes); err != nil {
 484                 return nil, err
 485         }
 486         return ntab, nil
 487 }
 488
 489 func (sm *SyncManager) minedBroadcastLoop() {
 490         for {
 491                 select {
 492                 case blockHash := <-sm.newBlockCh:
 493                         block, err := sm.chain.GetBlockByHash(blockHash)
 494                         if err != nil {
 495                                 log.Errorf("Failed on mined broadcast loop get block %v", err)
 496                                 return
 497                         }
 498                         if err := sm.peers.broadcastMinedBlock(block); err != nil {
 499                                 log.Errorf("Broadcast mine block error. %v", err)
 500                                 return
 501                         }
 502                 case <-sm.quitSync:
 503                         return
 504                 }
 505         }
 506 }