11 log "github.com/sirupsen/logrus"
12 crypto "github.com/tendermint/go-crypto"
13 cmn "github.com/tendermint/tmlibs/common"
14 dbm "github.com/tendermint/tmlibs/db"
16 cfg "github.com/bytom/config"
17 "github.com/bytom/errors"
18 "github.com/bytom/p2p/trust"
22 reconnectAttempts = 30
23 reconnectInterval = 3 * time.Second
25 bannedPeerKey = "BannedPeer"
26 defaultBanDuration = time.Hour * 24
30 var ErrConnectBannedPeer = errors.New("Connect banned peer")
32 type Reactor interface {
33 cmn.Service // Start, Stop
36 GetChannels() []*ChannelDescriptor
37 AddPeer(peer *Peer) error
38 RemovePeer(peer *Peer, reason interface{})
39 Receive(chID byte, peer *Peer, msgBytes []byte)
42 //--------------------------------------
44 type BaseReactor struct {
45 cmn.BaseService // Provides Start, Stop, .Quit
49 func NewBaseReactor(name string, impl Reactor) *BaseReactor {
51 BaseService: *cmn.NewBaseService(nil, name, impl),
56 func (br *BaseReactor) SetSwitch(sw *Switch) {
59 func (_ *BaseReactor) GetChannels() []*ChannelDescriptor { return nil }
60 func (_ *BaseReactor) AddPeer(peer *Peer) {}
61 func (_ *BaseReactor) RemovePeer(peer *Peer, reason interface{}) {}
62 func (_ *BaseReactor) Receive(chID byte, peer *Peer, msgBytes []byte) {}
64 //-----------------------------------------------------------------------------
67 The `Switch` handles peer connections and exposes an API to receive incoming messages
68 on `Reactors`. Each `Reactor` is responsible for handling incoming messages of one
69 or more `Channels`. So while sending outgoing messages is typically performed on the peer,
70 incoming messages are received on the reactor.
76 peerConfig *PeerConfig
78 reactors map[string]Reactor
79 chDescs []*ChannelDescriptor
80 reactorsByCh map[byte]Reactor
83 nodeInfo *NodeInfo // our node info
84 nodePrivKey crypto.PrivKeyEd25519 // our node privkey
85 bannedPeer map[string]time.Time
87 TrustMetricStore *trust.TrustMetricStore
91 filterConnByAddr func(net.Addr) error
92 filterConnByPubKey func(crypto.PubKeyEd25519) error
96 ErrSwitchDuplicatePeer = errors.New("Duplicate peer")
99 func NewSwitch(config *cfg.P2PConfig, trustHistoryDB dbm.DB) *Switch {
102 peerConfig: DefaultPeerConfig(config),
103 reactors: make(map[string]Reactor),
104 chDescs: make([]*ChannelDescriptor, 0),
105 reactorsByCh: make(map[byte]Reactor),
107 dialing: cmn.NewCMap(),
110 ScamPeerCh: make(chan *Peer),
112 sw.BaseService = *cmn.NewBaseService(nil, "P2P Switch", sw)
113 sw.TrustMetricStore = trust.NewTrustMetricStore(trustHistoryDB, trust.DefaultConfig())
114 sw.TrustMetricStore.Start()
116 sw.bannedPeer = make(map[string]time.Time)
117 if datajson := sw.db.Get([]byte(bannedPeerKey)); datajson != nil {
118 if err := json.Unmarshal(datajson, &sw.bannedPeer); err != nil {
122 go sw.scamPeerHandler()
126 // Not goroutine safe.
127 func (sw *Switch) AddReactor(name string, reactor Reactor) Reactor {
128 // Validate the reactor.
129 // No two reactors can share the same channel.
130 reactorChannels := reactor.GetChannels()
131 for _, chDesc := range reactorChannels {
133 if sw.reactorsByCh[chID] != nil {
134 cmn.PanicSanity(fmt.Sprintf("Channel %X has multiple reactors %v & %v", chID, sw.reactorsByCh[chID], reactor))
136 sw.chDescs = append(sw.chDescs, chDesc)
137 sw.reactorsByCh[chID] = reactor
139 sw.reactors[name] = reactor
140 reactor.SetSwitch(sw)
144 // Not goroutine safe.
145 func (sw *Switch) Reactors() map[string]Reactor {
149 // Not goroutine safe.
150 func (sw *Switch) Reactor(name string) Reactor {
151 return sw.reactors[name]
154 // Not goroutine safe.
155 func (sw *Switch) AddListener(l Listener) {
156 sw.listeners = append(sw.listeners, l)
159 // Not goroutine safe.
160 func (sw *Switch) Listeners() []Listener {
164 // Not goroutine safe.
165 func (sw *Switch) IsListening() bool {
166 return len(sw.listeners) > 0
169 // Not goroutine safe.
170 func (sw *Switch) SetNodeInfo(nodeInfo *NodeInfo) {
171 sw.nodeInfo = nodeInfo
174 // Not goroutine safe.
175 func (sw *Switch) NodeInfo() *NodeInfo {
179 // Not goroutine safe.
180 // NOTE: Overwrites sw.nodeInfo.PubKey
181 func (sw *Switch) SetNodePrivKey(nodePrivKey crypto.PrivKeyEd25519) {
182 sw.nodePrivKey = nodePrivKey
183 if sw.nodeInfo != nil {
184 sw.nodeInfo.PubKey = nodePrivKey.PubKey().Unwrap().(crypto.PubKeyEd25519)
188 // Switch.Start() starts all the reactors, peers, and listeners.
189 func (sw *Switch) OnStart() error {
190 sw.BaseService.OnStart()
192 for _, reactor := range sw.reactors {
193 _, err := reactor.Start()
199 for _, peer := range sw.peers.List() {
200 sw.startInitPeer(peer)
203 for _, listener := range sw.listeners {
204 go sw.listenerRoutine(listener)
209 func (sw *Switch) OnStop() {
210 sw.BaseService.OnStop()
212 for _, listener := range sw.listeners {
217 for _, peer := range sw.peers.List() {
219 sw.peers.Remove(peer)
222 for _, reactor := range sw.reactors {
227 // NOTE: This performs a blocking handshake before the peer is added.
228 // CONTRACT: If error is returned, peer is nil, and conn is immediately closed.
229 func (sw *Switch) AddPeer(peer *Peer) error {
230 if err := sw.FilterConnByAddr(peer.Addr()); err != nil {
234 if err := sw.FilterConnByPubKey(peer.PubKey()); err != nil {
238 if err := peer.HandshakeTimeout(sw.nodeInfo, time.Duration(sw.peerConfig.HandshakeTimeout*time.Second)); err != nil {
242 if err := sw.checkBannedPeer(peer.NodeInfo.ListenHost()); err != nil {
247 if sw.nodeInfo.PubKey.Equals(peer.PubKey().Wrap()) {
248 return errors.New("Ignoring connection from self")
251 // Check version, chain id
252 if err := sw.nodeInfo.CompatibleWith(peer.NodeInfo); err != nil {
256 // Check for duplicate peer
257 if sw.peers.Has(peer.Key) {
258 return ErrSwitchDuplicatePeer
264 if err := sw.startInitPeer(peer); err != nil {
269 // Add the peer to .peers.
270 // We start it first so that a peer in the list is safe to Stop.
271 // It should not err since we already checked peers.Has()
272 if err := sw.peers.Add(peer); err != nil {
276 tm := trust.NewMetric()
279 sw.TrustMetricStore.AddPeerTrustMetric(peer.mconn.RemoteAddress.IP.String(), tm)
281 log.WithField("peer", peer).Info("Added peer")
285 func (sw *Switch) FilterConnByAddr(addr net.Addr) error {
286 if sw.filterConnByAddr != nil {
287 return sw.filterConnByAddr(addr)
292 func (sw *Switch) FilterConnByPubKey(pubkey crypto.PubKeyEd25519) error {
293 if sw.filterConnByPubKey != nil {
294 return sw.filterConnByPubKey(pubkey)
300 func (sw *Switch) SetAddrFilter(f func(net.Addr) error) {
301 sw.filterConnByAddr = f
304 func (sw *Switch) SetPubKeyFilter(f func(crypto.PubKeyEd25519) error) {
305 sw.filterConnByPubKey = f
308 func (sw *Switch) startInitPeer(peer *Peer) error {
309 peer.Start() // spawn send/recv routines
310 for _, reactor := range sw.reactors {
311 if err := reactor.AddPeer(peer); err != nil {
318 // Dial a list of seeds asynchronously in random order
319 func (sw *Switch) DialSeeds(addrBook *AddrBook, seeds []string) error {
321 netAddrs, err := NewNetAddressStrings(seeds)
327 // add seeds to `addrBook`
328 ourAddrS := sw.nodeInfo.ListenAddr
329 ourAddr, _ := NewNetAddressString(ourAddrS)
330 for _, netAddr := range netAddrs {
331 // do not add ourselves
332 if netAddr.Equals(ourAddr) {
335 addrBook.AddAddress(netAddr, ourAddr)
340 // permute the list, dial them in random order.
341 perm := rand.Perm(len(netAddrs))
342 for i := 0; i < len(perm); i++ {
344 time.Sleep(time.Duration(rand.Int63n(3000)) * time.Millisecond)
346 sw.dialSeed(netAddrs[j])
352 func (sw *Switch) dialSeed(addr *NetAddress) {
353 peer, err := sw.DialPeerWithAddress(addr, true)
355 log.WithField("error", err).Error("Error dialing seed")
357 log.WithField("peer", peer).Info("Connected to seed")
361 func (sw *Switch) DialPeerWithAddress(addr *NetAddress, persistent bool) (*Peer, error) {
362 if err := sw.checkBannedPeer(addr.IP.String()); err != nil {
366 sw.dialing.Set(addr.IP.String(), addr)
367 defer sw.dialing.Delete(addr.IP.String())
369 log.WithField("address", addr).Info("Dialing peer")
370 peer, err := newOutboundPeerWithConfig(addr, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.peerConfig)
372 log.WithFields(log.Fields{
375 }).Info("Failed to dial peer")
378 peer.SetLogger(sw.Logger.With("peer", addr))
380 peer.makePersistent()
382 err = sw.AddPeer(peer)
384 log.WithFields(log.Fields{
387 }).Info("Failed to add peer")
391 log.WithFields(log.Fields{
393 }).Info("Dialed and added peer")
397 func (sw *Switch) IsDialing(addr *NetAddress) bool {
398 return sw.dialing.Has(addr.IP.String())
401 // Broadcast runs a go routine for each attempted send, which will block
402 // trying to send for defaultSendTimeoutSeconds. Returns a channel
403 // which receives success values for each attempted send (false if times out)
404 // NOTE: Broadcast uses goroutines, so order of broadcast may not be preserved.
405 func (sw *Switch) Broadcast(chID byte, msg interface{}) chan bool {
406 successChan := make(chan bool, len(sw.peers.List()))
407 log.WithFields(log.Fields{
410 }).Debug("Broadcast")
411 for _, peer := range sw.peers.List() {
412 go func(peer *Peer) {
413 success := peer.Send(chID, msg)
414 successChan <- success
420 // Returns the count of outbound/inbound and outbound-dialing peers.
421 func (sw *Switch) NumPeers() (outbound, inbound, dialing int) {
422 peers := sw.peers.List()
423 for _, peer := range peers {
430 dialing = sw.dialing.Size()
434 func (sw *Switch) Peers() *PeerSet {
438 // Disconnect from a peer due to external error, retry if it is a persistent peer.
439 // TODO: make record depending on reason.
440 func (sw *Switch) StopPeerForError(peer *Peer, reason interface{}) {
441 addr := NewNetAddress(peer.Addr())
442 log.WithFields(log.Fields{
445 }).Info("Stopping peer due to error")
446 sw.stopAndRemovePeer(peer, reason)
448 if peer.IsPersistent() {
450 log.WithField("peer", peer).Info("Reconnecting to peer")
451 for i := 1; i < reconnectAttempts; i++ {
456 peer, err := sw.DialPeerWithAddress(addr, true)
458 if i == reconnectAttempts {
459 log.WithFields(log.Fields{
462 }).Info("Error reconnecting to peer. Giving up")
465 if errors.Root(err) == ErrSwitchDuplicatePeer {
466 log.WithField("error", err).Info("Error reconnecting to peer. ")
469 log.WithFields(log.Fields{
472 }).Info("Error reconnecting to peer. Trying again")
473 time.Sleep(reconnectInterval)
477 log.WithField("peer", peer).Info("Reconnected to peer")
484 // Disconnect from a peer gracefully.
485 // TODO: handle graceful disconnects.
486 func (sw *Switch) StopPeerGracefully(peer *Peer) {
487 log.Info("Stopping peer gracefully")
488 sw.stopAndRemovePeer(peer, nil)
491 func (sw *Switch) stopAndRemovePeer(peer *Peer, reason interface{}) {
492 sw.peers.Remove(peer)
494 for _, reactor := range sw.reactors {
495 reactor.RemovePeer(peer, reason)
499 func (sw *Switch) listenerRoutine(l Listener) {
501 inConn, ok := <-l.Connections()
506 // ignore connection if we already have enough
507 maxPeers := sw.config.MaxNumPeers
508 if maxPeers <= sw.peers.Size() {
509 log.WithFields(log.Fields{
510 "address": inConn.RemoteAddr().String(),
511 "numPeers": sw.peers.Size(),
513 }).Info("Ignoring inbound connection: already have enough peers")
517 // New inbound connection!
518 err := sw.addPeerWithConnectionAndConfig(inConn, sw.peerConfig)
520 log.WithFields(log.Fields{
521 "address": inConn.RemoteAddr().String(),
523 }).Info("Ignoring inbound connection: error while adding peer")
527 // NOTE: We don't yet have the listening port of the
528 // remote (if they have a listener at all).
529 // The peerHandshake will handle that
535 //-----------------------------------------------------------------------------
537 type SwitchEventNewPeer struct {
541 type SwitchEventDonePeer struct {
546 //------------------------------------------------------------------
547 // Switches connected via arbitrary net.Conn; useful for testing
549 // Returns n switches, connected according to the connect func.
550 // If connect==Connect2Switches, the switches will be fully connected.
551 // initSwitch defines how the ith switch should be initialized (ie. with what reactors).
552 // NOTE: panics if any switch fails to start.
553 func MakeConnectedSwitches(cfg *cfg.P2PConfig, n int, initSwitch func(int, *Switch) *Switch, connect func([]*Switch, int, int)) []*Switch {
554 switches := make([]*Switch, n)
555 for i := 0; i < n; i++ {
556 switches[i] = makeSwitch(cfg, i, "testing", "123.123.123", initSwitch)
559 if err := StartSwitches(switches); err != nil {
563 for i := 0; i < n; i++ {
564 for j := i; j < n; j++ {
565 connect(switches, i, j)
572 var PanicOnAddPeerErr = false
574 // Will connect switches i and j via net.Pipe()
575 // Blocks until a conection is established.
576 // NOTE: caller ensures i and j are within bounds
577 func Connect2Switches(switches []*Switch, i, j int) {
578 switchI := switches[i]
579 switchJ := switches[j]
581 doneCh := make(chan struct{})
583 err := switchI.addPeerWithConnection(c1)
584 if PanicOnAddPeerErr && err != nil {
590 err := switchJ.addPeerWithConnection(c2)
591 if PanicOnAddPeerErr && err != nil {
600 func StartSwitches(switches []*Switch) error {
601 for _, s := range switches {
602 _, err := s.Start() // start switch and reactors
610 func makeSwitch(cfg *cfg.P2PConfig, i int, network, version string, initSwitch func(int, *Switch) *Switch) *Switch {
611 privKey := crypto.GenPrivKeyEd25519()
612 // new switch, add reactors
613 // TODO: let the config be passed in?
614 s := initSwitch(i, NewSwitch(cfg, nil))
615 s.SetNodeInfo(&NodeInfo{
616 PubKey: privKey.PubKey().Unwrap().(crypto.PubKeyEd25519),
617 Moniker: cmn.Fmt("switch%d", i),
620 RemoteAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
621 ListenAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
623 s.SetNodePrivKey(privKey)
627 func (sw *Switch) addPeerWithConnection(conn net.Conn) error {
628 peer, err := newInboundPeer(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.config)
633 peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
634 if err = sw.AddPeer(peer); err != nil {
642 func (sw *Switch) addPeerWithConnectionAndConfig(conn net.Conn, config *PeerConfig) error {
643 fullAddr := conn.RemoteAddr().String()
644 host, _, err := net.SplitHostPort(fullAddr)
649 if err = sw.checkBannedPeer(host); err != nil {
653 peer, err := newInboundPeerWithConfig(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, config)
658 peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
659 if err = sw.AddPeer(peer); err != nil {
667 func (sw *Switch) AddBannedPeer(peer *Peer) error {
669 defer sw.mtx.Unlock()
671 key := peer.mconn.RemoteAddress.IP.String()
672 sw.bannedPeer[key] = time.Now().Add(defaultBanDuration)
673 datajson, err := json.Marshal(sw.bannedPeer)
677 sw.db.Set([]byte(bannedPeerKey), datajson)
681 func (sw *Switch) DelBannedPeer(addr string) error {
683 defer sw.mtx.Unlock()
685 delete(sw.bannedPeer, addr)
686 datajson, err := json.Marshal(sw.bannedPeer)
690 sw.db.Set([]byte(bannedPeerKey), datajson)
694 func (sw *Switch) scamPeerHandler() {
695 for src := range sw.ScamPeerCh {
696 var tm *trust.TrustMetric
697 key := src.Connection().RemoteAddress.IP.String()
698 if tm = sw.TrustMetricStore.GetPeerTrustMetric(key); tm == nil {
699 log.Errorf("Can't get peer trust metric")
702 sw.delTrustMetric(tm, src)
706 func (sw *Switch) AddScamPeer(src *Peer) {
710 func (sw *Switch) delTrustMetric(tm *trust.TrustMetric, src *Peer) {
711 key := src.Connection().RemoteAddress.IP.String()
713 if tm.TrustScore() < peerBannedTM {
714 sw.AddBannedPeer(src)
715 sw.TrustMetricStore.PeerDisconnected(key)
716 sw.StopPeerGracefully(src)
720 func (sw *Switch) checkBannedPeer(peer string) error {
721 if banEnd, ok := sw.bannedPeer[peer]; ok {
722 if time.Now().Before(banEnd) {
723 return ErrConnectBannedPeer
725 sw.DelBannedPeer(peer)