12 log "github.com/sirupsen/logrus"
13 crypto "github.com/tendermint/go-crypto"
14 cmn "github.com/tendermint/tmlibs/common"
15 dbm "github.com/tendermint/tmlibs/db"
17 cfg "github.com/bytom/config"
18 "github.com/bytom/errors"
19 "github.com/bytom/p2p/trust"
23 reconnectAttempts = 10
24 reconnectInterval = 10 * time.Second
26 bannedPeerKey = "BannedPeer"
27 defaultBanDuration = time.Hour * 24
31 var ErrConnectBannedPeer = errors.New("Connect banned peer")
33 type Reactor interface {
34 cmn.Service // Start, Stop
37 GetChannels() []*ChannelDescriptor
38 AddPeer(peer *Peer) error
39 RemovePeer(peer *Peer, reason interface{})
40 Receive(chID byte, peer *Peer, msgBytes []byte)
43 //--------------------------------------
45 type BaseReactor struct {
46 cmn.BaseService // Provides Start, Stop, .Quit
50 func NewBaseReactor(name string, impl Reactor) *BaseReactor {
52 BaseService: *cmn.NewBaseService(nil, name, impl),
57 func (br *BaseReactor) SetSwitch(sw *Switch) {
60 func (_ *BaseReactor) GetChannels() []*ChannelDescriptor { return nil }
61 func (_ *BaseReactor) AddPeer(peer *Peer) {}
62 func (_ *BaseReactor) RemovePeer(peer *Peer, reason interface{}) {}
63 func (_ *BaseReactor) Receive(chID byte, peer *Peer, msgBytes []byte) {}
65 //-----------------------------------------------------------------------------
68 The `Switch` handles peer connections and exposes an API to receive incoming messages
69 on `Reactors`. Each `Reactor` is responsible for handling incoming messages of one
70 or more `Channels`. So while sending outgoing messages is typically performed on the peer,
71 incoming messages are received on the reactor.
77 peerConfig *PeerConfig
79 reactors map[string]Reactor
80 chDescs []*ChannelDescriptor
81 reactorsByCh map[byte]Reactor
84 nodeInfo *NodeInfo // our node info
85 nodePrivKey crypto.PrivKeyEd25519 // our node privkey
86 bannedPeer map[string]time.Time
88 TrustMetricStore *trust.TrustMetricStore
92 filterConnByAddr func(net.Addr) error
93 filterConnByPubKey func(crypto.PubKeyEd25519) error
97 ErrSwitchDuplicatePeer = errors.New("Duplicate peer")
98 ErrConnectSelf = errors.New("Connect self")
99 ErrPeerConnected = errors.New("Peer is connected")
102 func NewSwitch(config *cfg.P2PConfig, trustHistoryDB dbm.DB) *Switch {
105 peerConfig: DefaultPeerConfig(config),
106 reactors: make(map[string]Reactor),
107 chDescs: make([]*ChannelDescriptor, 0),
108 reactorsByCh: make(map[byte]Reactor),
110 dialing: cmn.NewCMap(),
113 ScamPeerCh: make(chan *Peer),
115 sw.BaseService = *cmn.NewBaseService(nil, "P2P Switch", sw)
116 sw.TrustMetricStore = trust.NewTrustMetricStore(trustHistoryDB, trust.DefaultConfig())
117 sw.TrustMetricStore.Start()
119 sw.bannedPeer = make(map[string]time.Time)
120 if datajson := sw.db.Get([]byte(bannedPeerKey)); datajson != nil {
121 if err := json.Unmarshal(datajson, &sw.bannedPeer); err != nil {
125 go sw.scamPeerHandler()
129 // Not goroutine safe.
130 func (sw *Switch) AddReactor(name string, reactor Reactor) Reactor {
131 // Validate the reactor.
132 // No two reactors can share the same channel.
133 reactorChannels := reactor.GetChannels()
134 for _, chDesc := range reactorChannels {
136 if sw.reactorsByCh[chID] != nil {
137 cmn.PanicSanity(fmt.Sprintf("Channel %X has multiple reactors %v & %v", chID, sw.reactorsByCh[chID], reactor))
139 sw.chDescs = append(sw.chDescs, chDesc)
140 sw.reactorsByCh[chID] = reactor
142 sw.reactors[name] = reactor
143 reactor.SetSwitch(sw)
147 // Not goroutine safe.
148 func (sw *Switch) Reactors() map[string]Reactor {
152 // Not goroutine safe.
153 func (sw *Switch) Reactor(name string) Reactor {
154 return sw.reactors[name]
157 // Not goroutine safe.
158 func (sw *Switch) AddListener(l Listener) {
159 sw.listeners = append(sw.listeners, l)
162 // Not goroutine safe.
163 func (sw *Switch) Listeners() []Listener {
167 // Not goroutine safe.
168 func (sw *Switch) IsListening() bool {
169 return len(sw.listeners) > 0
172 // Not goroutine safe.
173 func (sw *Switch) SetNodeInfo(nodeInfo *NodeInfo) {
174 sw.nodeInfo = nodeInfo
177 // Not goroutine safe.
178 func (sw *Switch) NodeInfo() *NodeInfo {
182 // Not goroutine safe.
183 // NOTE: Overwrites sw.nodeInfo.PubKey
184 func (sw *Switch) SetNodePrivKey(nodePrivKey crypto.PrivKeyEd25519) {
185 sw.nodePrivKey = nodePrivKey
186 if sw.nodeInfo != nil {
187 sw.nodeInfo.PubKey = nodePrivKey.PubKey().Unwrap().(crypto.PubKeyEd25519)
191 // Switch.Start() starts all the reactors, peers, and listeners.
192 func (sw *Switch) OnStart() error {
193 sw.BaseService.OnStart()
195 for _, reactor := range sw.reactors {
196 _, err := reactor.Start()
202 for _, peer := range sw.peers.List() {
203 sw.startInitPeer(peer)
206 for _, listener := range sw.listeners {
207 go sw.listenerRoutine(listener)
212 func (sw *Switch) OnStop() {
213 sw.BaseService.OnStop()
215 for _, listener := range sw.listeners {
220 for _, peer := range sw.peers.List() {
222 sw.peers.Remove(peer)
225 for _, reactor := range sw.reactors {
230 // NOTE: This performs a blocking handshake before the peer is added.
231 // CONTRACT: If error is returned, peer is nil, and conn is immediately closed.
232 func (sw *Switch) AddPeer(peer *Peer) error {
233 if err := sw.FilterConnByAddr(peer.Addr()); err != nil {
237 if err := sw.FilterConnByPubKey(peer.PubKey()); err != nil {
241 if err := peer.HandshakeTimeout(sw.nodeInfo, time.Duration(sw.peerConfig.HandshakeTimeout*time.Second)); err != nil {
245 if err := sw.checkBannedPeer(peer.NodeInfo.ListenHost()); err != nil {
250 if sw.nodeInfo.PubKey.Equals(peer.PubKey().Wrap()) {
251 return errors.New("Ignoring connection from self")
254 // Check version, chain id
255 if err := sw.nodeInfo.CompatibleWith(peer.NodeInfo); err != nil {
259 // Check for duplicate peer
260 if sw.peers.Has(peer.Key) {
261 return ErrSwitchDuplicatePeer
267 if err := sw.startInitPeer(peer); err != nil {
272 // Add the peer to .peers.
273 // We start it first so that a peer in the list is safe to Stop.
274 // It should not err since we already checked peers.Has()
275 if err := sw.peers.Add(peer); err != nil {
279 tm := trust.NewMetric()
282 sw.TrustMetricStore.AddPeerTrustMetric(peer.mconn.RemoteAddress.IP.String(), tm)
284 log.WithField("peer", peer).Info("Added peer")
288 func (sw *Switch) FilterConnByAddr(addr net.Addr) error {
289 if sw.filterConnByAddr != nil {
290 return sw.filterConnByAddr(addr)
295 func (sw *Switch) FilterConnByPubKey(pubkey crypto.PubKeyEd25519) error {
296 if sw.filterConnByPubKey != nil {
297 return sw.filterConnByPubKey(pubkey)
303 func (sw *Switch) SetAddrFilter(f func(net.Addr) error) {
304 sw.filterConnByAddr = f
307 func (sw *Switch) SetPubKeyFilter(f func(crypto.PubKeyEd25519) error) {
308 sw.filterConnByPubKey = f
311 func (sw *Switch) startInitPeer(peer *Peer) error {
312 peer.Start() // spawn send/recv routines
313 for _, reactor := range sw.reactors {
314 if err := reactor.AddPeer(peer); err != nil {
321 // Dial a list of seeds asynchronously in random order
322 func (sw *Switch) DialSeeds(addrBook *AddrBook, seeds []string) error {
324 netAddrs, err := NewNetAddressStrings(seeds)
330 // add seeds to `addrBook`
331 ourAddrS := sw.nodeInfo.ListenAddr
332 ourAddr, _ := NewNetAddressString(ourAddrS)
333 for _, netAddr := range netAddrs {
334 // do not add ourselves
335 if netAddr.Equals(ourAddr) {
338 addrBook.AddAddress(netAddr, ourAddr)
343 // permute the list, dial them in random order.
344 perm := rand.Perm(len(netAddrs))
345 for i := 0; i < len(perm); i++ {
347 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 {
365 if strings.Compare(addr.IP.String(), sw.nodeInfo.ListenHost()) == 0 {
366 return nil, ErrConnectSelf
368 for _, v := range sw.Peers().list {
369 if strings.Compare(v.mconn.RemoteAddress.IP.String(), addr.IP.String()) == 0 {
370 return nil, ErrPeerConnected
373 sw.dialing.Set(addr.IP.String(), addr)
374 defer sw.dialing.Delete(addr.IP.String())
376 log.WithField("address", addr).Info("Dialing peer")
377 peer, err := newOutboundPeerWithConfig(addr, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.peerConfig)
379 log.WithFields(log.Fields{
382 }).Info("Failed to dial peer")
385 peer.SetLogger(sw.Logger.With("peer", addr))
387 peer.makePersistent()
389 err = sw.AddPeer(peer)
391 log.WithFields(log.Fields{
394 }).Info("Failed to add peer")
398 log.WithFields(log.Fields{
400 }).Info("Dialed and added peer")
404 func (sw *Switch) IsDialing(addr *NetAddress) bool {
405 return sw.dialing.Has(addr.IP.String())
408 // Broadcast runs a go routine for each attempted send, which will block
409 // trying to send for defaultSendTimeoutSeconds. Returns a channel
410 // which receives success values for each attempted send (false if times out)
411 // NOTE: Broadcast uses goroutines, so order of broadcast may not be preserved.
412 func (sw *Switch) Broadcast(chID byte, msg interface{}) chan bool {
413 successChan := make(chan bool, len(sw.peers.List()))
414 log.WithFields(log.Fields{
417 }).Debug("Broadcast")
418 for _, peer := range sw.peers.List() {
419 go func(peer *Peer) {
420 success := peer.Send(chID, msg)
421 successChan <- success
427 // Returns the count of outbound/inbound and outbound-dialing peers.
428 func (sw *Switch) NumPeers() (outbound, inbound, dialing int) {
429 peers := sw.peers.List()
430 for _, peer := range peers {
437 dialing = sw.dialing.Size()
441 func (sw *Switch) Peers() *PeerSet {
445 // Disconnect from a peer due to external error, retry if it is a persistent peer.
446 // TODO: make record depending on reason.
447 func (sw *Switch) StopPeerForError(peer *Peer, reason interface{}) {
448 addr := NewNetAddress(peer.Addr())
449 log.WithFields(log.Fields{
452 }).Info("Stopping peer due to error")
453 sw.stopAndRemovePeer(peer, reason)
455 if peer.IsPersistent() {
456 log.WithField("peer", peer).Info("Reconnecting to peer")
457 for i := 1; i < reconnectAttempts; i++ {
462 peer, err := sw.DialPeerWithAddress(addr, true)
464 if i == reconnectAttempts {
465 log.WithFields(log.Fields{
468 }).Info("Error reconnecting to peer. Giving up")
472 if errors.Root(err) == ErrConnectBannedPeer || errors.Root(err) == ErrPeerConnected || errors.Root(err) == ErrSwitchDuplicatePeer || errors.Root(err) == ErrConnectSelf {
473 log.WithField("error", err).Info("Error reconnecting to peer. ")
477 log.WithFields(log.Fields{
480 }).Info("Error reconnecting to peer. Trying again")
481 time.Sleep(reconnectInterval)
485 log.WithField("peer", peer).Info("Reconnected to peer")
491 // Disconnect from a peer gracefully.
492 // TODO: handle graceful disconnects.
493 func (sw *Switch) StopPeerGracefully(peer *Peer) {
494 log.Info("Stopping peer gracefully")
495 sw.stopAndRemovePeer(peer, nil)
498 func (sw *Switch) stopAndRemovePeer(peer *Peer, reason interface{}) {
499 sw.peers.Remove(peer)
501 for _, reactor := range sw.reactors {
502 reactor.RemovePeer(peer, reason)
506 func (sw *Switch) listenerRoutine(l Listener) {
508 inConn, ok := <-l.Connections()
513 // ignore connection if we already have enough
514 maxPeers := sw.config.MaxNumPeers
515 if maxPeers <= sw.peers.Size() {
518 log.WithFields(log.Fields{
519 "address": inConn.RemoteAddr().String(),
520 "numPeers": sw.peers.Size(),
522 }).Info("Ignoring inbound connection: already have enough peers")
526 // New inbound connection!
527 err := sw.addPeerWithConnectionAndConfig(inConn, sw.peerConfig)
529 // conn close for returing err
531 log.WithFields(log.Fields{
532 "address": inConn.RemoteAddr().String(),
534 }).Info("Ignoring inbound connection: error while adding peer")
538 // NOTE: We don't yet have the listening port of the
539 // remote (if they have a listener at all).
540 // The peerHandshake will handle that
546 //-----------------------------------------------------------------------------
548 type SwitchEventNewPeer struct {
552 type SwitchEventDonePeer struct {
557 //------------------------------------------------------------------
558 // Switches connected via arbitrary net.Conn; useful for testing
560 // Returns n switches, connected according to the connect func.
561 // If connect==Connect2Switches, the switches will be fully connected.
562 // initSwitch defines how the ith switch should be initialized (ie. with what reactors).
563 // NOTE: panics if any switch fails to start.
564 func MakeConnectedSwitches(cfg *cfg.P2PConfig, n int, initSwitch func(int, *Switch) *Switch, connect func([]*Switch, int, int)) []*Switch {
565 switches := make([]*Switch, n)
566 for i := 0; i < n; i++ {
567 switches[i] = makeSwitch(cfg, i, "testing", "123.123.123", initSwitch)
570 if err := StartSwitches(switches); err != nil {
574 for i := 0; i < n; i++ {
575 for j := i; j < n; j++ {
576 connect(switches, i, j)
583 var PanicOnAddPeerErr = false
585 // Will connect switches i and j via net.Pipe()
586 // Blocks until a conection is established.
587 // NOTE: caller ensures i and j are within bounds
588 func Connect2Switches(switches []*Switch, i, j int) {
589 switchI := switches[i]
590 switchJ := switches[j]
592 doneCh := make(chan struct{})
594 err := switchI.addPeerWithConnection(c1)
595 if PanicOnAddPeerErr && err != nil {
601 err := switchJ.addPeerWithConnection(c2)
602 if PanicOnAddPeerErr && err != nil {
611 func StartSwitches(switches []*Switch) error {
612 for _, s := range switches {
613 _, err := s.Start() // start switch and reactors
621 func makeSwitch(cfg *cfg.P2PConfig, i int, network, version string, initSwitch func(int, *Switch) *Switch) *Switch {
622 privKey := crypto.GenPrivKeyEd25519()
623 // new switch, add reactors
624 // TODO: let the config be passed in?
625 s := initSwitch(i, NewSwitch(cfg, nil))
626 s.SetNodeInfo(&NodeInfo{
627 PubKey: privKey.PubKey().Unwrap().(crypto.PubKeyEd25519),
628 Moniker: cmn.Fmt("switch%d", i),
631 RemoteAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
632 ListenAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
634 s.SetNodePrivKey(privKey)
638 func (sw *Switch) addPeerWithConnection(conn net.Conn) error {
639 peer, err := newInboundPeer(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.config)
644 peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
645 if err = sw.AddPeer(peer); err != nil {
653 func (sw *Switch) addPeerWithConnectionAndConfig(conn net.Conn, config *PeerConfig) error {
654 fullAddr := conn.RemoteAddr().String()
655 host, _, err := net.SplitHostPort(fullAddr)
660 if err = sw.checkBannedPeer(host); err != nil {
664 peer, err := newInboundPeerWithConfig(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, config)
668 peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
669 if err = sw.AddPeer(peer); err != nil {
676 func (sw *Switch) AddBannedPeer(peer *Peer) error {
678 defer sw.mtx.Unlock()
680 key := peer.mconn.RemoteAddress.IP.String()
681 sw.bannedPeer[key] = time.Now().Add(defaultBanDuration)
682 datajson, err := json.Marshal(sw.bannedPeer)
686 sw.db.Set([]byte(bannedPeerKey), datajson)
690 func (sw *Switch) DelBannedPeer(addr string) error {
692 defer sw.mtx.Unlock()
694 delete(sw.bannedPeer, addr)
695 datajson, err := json.Marshal(sw.bannedPeer)
699 sw.db.Set([]byte(bannedPeerKey), datajson)
703 func (sw *Switch) scamPeerHandler() {
704 for src := range sw.ScamPeerCh {
705 var tm *trust.TrustMetric
706 key := src.Connection().RemoteAddress.IP.String()
707 if tm = sw.TrustMetricStore.GetPeerTrustMetric(key); tm == nil {
708 log.Errorf("Can't get peer trust metric")
711 sw.delTrustMetric(tm, src)
715 func (sw *Switch) AddScamPeer(src *Peer) {
719 func (sw *Switch) delTrustMetric(tm *trust.TrustMetric, src *Peer) {
720 key := src.Connection().RemoteAddress.IP.String()
722 if tm.TrustScore() < peerBannedTM {
723 sw.AddBannedPeer(src)
724 sw.TrustMetricStore.PeerDisconnected(key)
725 sw.StopPeerGracefully(src)
729 func (sw *Switch) checkBannedPeer(peer string) error {
730 if banEnd, ok := sw.bannedPeer[peer]; ok {
731 if time.Now().Before(banEnd) {
732 return ErrConnectBannedPeer
734 sw.DelBannedPeer(peer)