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
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
90 filterConnByAddr func(net.Addr) error
91 filterConnByPubKey func(crypto.PubKeyEd25519) error
95 ErrSwitchDuplicatePeer = errors.New("Duplicate peer")
96 ErrConnectSelf = errors.New("Connect self")
97 ErrPeerConnected = errors.New("Peer is connected")
100 func NewSwitch(config *cfg.P2PConfig, trustHistoryDB dbm.DB) *Switch {
103 peerConfig: DefaultPeerConfig(config),
104 reactors: make(map[string]Reactor),
105 chDescs: make([]*ChannelDescriptor, 0),
106 reactorsByCh: make(map[byte]Reactor),
108 dialing: cmn.NewCMap(),
111 ScamPeerCh: make(chan *Peer),
113 sw.BaseService = *cmn.NewBaseService(nil, "P2P Switch", sw)
115 sw.bannedPeer = make(map[string]time.Time)
116 if datajson := sw.db.Get([]byte(bannedPeerKey)); datajson != nil {
117 if err := json.Unmarshal(datajson, &sw.bannedPeer); err != nil {
125 // Not goroutine safe.
126 func (sw *Switch) AddReactor(name string, reactor Reactor) Reactor {
127 // Validate the reactor.
128 // No two reactors can share the same channel.
129 reactorChannels := reactor.GetChannels()
130 for _, chDesc := range reactorChannels {
132 if sw.reactorsByCh[chID] != nil {
133 cmn.PanicSanity(fmt.Sprintf("Channel %X has multiple reactors %v & %v", chID, sw.reactorsByCh[chID], reactor))
135 sw.chDescs = append(sw.chDescs, chDesc)
136 sw.reactorsByCh[chID] = reactor
138 sw.reactors[name] = reactor
139 reactor.SetSwitch(sw)
143 // Not goroutine safe.
144 func (sw *Switch) Reactors() map[string]Reactor {
148 // Not goroutine safe.
149 func (sw *Switch) Reactor(name string) Reactor {
150 return sw.reactors[name]
153 // Not goroutine safe.
154 func (sw *Switch) AddListener(l Listener) {
155 sw.listeners = append(sw.listeners, l)
158 // Not goroutine safe.
159 func (sw *Switch) Listeners() []Listener {
163 // Not goroutine safe.
164 func (sw *Switch) IsListening() bool {
165 return len(sw.listeners) > 0
168 // Not goroutine safe.
169 func (sw *Switch) SetNodeInfo(nodeInfo *NodeInfo) {
170 sw.nodeInfo = nodeInfo
173 // Not goroutine safe.
174 func (sw *Switch) NodeInfo() *NodeInfo {
178 // Not goroutine safe.
179 // NOTE: Overwrites sw.nodeInfo.PubKey
180 func (sw *Switch) SetNodePrivKey(nodePrivKey crypto.PrivKeyEd25519) {
181 sw.nodePrivKey = nodePrivKey
182 if sw.nodeInfo != nil {
183 sw.nodeInfo.PubKey = nodePrivKey.PubKey().Unwrap().(crypto.PubKeyEd25519)
187 // Switch.Start() starts all the reactors, peers, and listeners.
188 func (sw *Switch) OnStart() error {
189 sw.BaseService.OnStart()
191 for _, reactor := range sw.reactors {
192 _, err := reactor.Start()
198 for _, peer := range sw.peers.List() {
199 sw.startInitPeer(peer)
202 for _, listener := range sw.listeners {
203 go sw.listenerRoutine(listener)
208 func (sw *Switch) OnStop() {
209 sw.BaseService.OnStop()
211 for _, listener := range sw.listeners {
216 for _, peer := range sw.peers.List() {
218 sw.peers.Remove(peer)
221 for _, reactor := range sw.reactors {
226 // NOTE: This performs a blocking handshake before the peer is added.
227 // CONTRACT: If error is returned, peer is nil, and conn is immediately closed.
228 func (sw *Switch) AddPeer(peer *Peer) error {
229 if err := sw.FilterConnByAddr(peer.Addr()); err != nil {
233 if err := sw.FilterConnByPubKey(peer.PubKey()); err != nil {
237 if err := peer.HandshakeTimeout(sw.nodeInfo, time.Duration(sw.peerConfig.HandshakeTimeout*time.Second)); err != nil {
241 if err := sw.checkBannedPeer(peer.NodeInfo.ListenHost()); err != nil {
246 if sw.nodeInfo.PubKey.Equals(peer.PubKey().Wrap()) {
247 return errors.New("Ignoring connection from self")
250 // Check version, chain id
251 if err := sw.nodeInfo.CompatibleWith(peer.NodeInfo); err != nil {
255 // Check for duplicate peer
256 if sw.peers.Has(peer.Key) {
257 return ErrSwitchDuplicatePeer
263 if err := sw.startInitPeer(peer); err != nil {
268 // Add the peer to .peers.
269 // We start it first so that a peer in the list is safe to Stop.
270 // It should not err since we already checked peers.Has()
271 if err := sw.peers.Add(peer); err != nil {
275 log.WithField("peer", peer).Info("Added peer")
279 func (sw *Switch) FilterConnByAddr(addr net.Addr) error {
280 if sw.filterConnByAddr != nil {
281 return sw.filterConnByAddr(addr)
286 func (sw *Switch) FilterConnByPubKey(pubkey crypto.PubKeyEd25519) error {
287 if sw.filterConnByPubKey != nil {
288 return sw.filterConnByPubKey(pubkey)
294 func (sw *Switch) SetAddrFilter(f func(net.Addr) error) {
295 sw.filterConnByAddr = f
298 func (sw *Switch) SetPubKeyFilter(f func(crypto.PubKeyEd25519) error) {
299 sw.filterConnByPubKey = f
302 func (sw *Switch) startInitPeer(peer *Peer) error {
303 peer.Start() // spawn send/recv routines
304 for _, reactor := range sw.reactors {
305 if err := reactor.AddPeer(peer); err != nil {
312 // Dial a list of seeds asynchronously in random order
313 func (sw *Switch) DialSeeds(addrBook *AddrBook, seeds []string) error {
315 netAddrs, err := NewNetAddressStrings(seeds)
321 // add seeds to `addrBook`
322 ourAddrS := sw.nodeInfo.ListenAddr
323 ourAddr, _ := NewNetAddressString(ourAddrS)
324 for _, netAddr := range netAddrs {
325 // do not add ourselves
326 if netAddr.Equals(ourAddr) {
329 addrBook.AddAddress(netAddr, ourAddr)
335 // permute the list, dial them in random order.
336 //perm := rand.Perm(len(netAddrs))
337 //for i := 0; i < len(perm); i++ {
339 // sw.dialSeed(netAddrs[j])
344 func (sw *Switch) dialSeed(addr *NetAddress) {
345 peer, err := sw.DialPeerWithAddress(addr, true)
347 log.WithField("error", err).Error("Error dialing seed")
349 log.WithField("peer", peer).Info("Connected to seed")
353 func (sw *Switch) DialPeerWithAddress(addr *NetAddress, persistent bool) (*Peer, error) {
354 if err := sw.checkBannedPeer(addr.IP.String()); err != nil {
357 if strings.Compare(addr.IP.String(), sw.nodeInfo.ListenHost()) == 0 {
358 return nil, ErrConnectSelf
360 for _, v := range sw.Peers().list {
361 if strings.Compare(v.mconn.RemoteAddress.IP.String(), addr.IP.String()) == 0 {
362 return nil, ErrPeerConnected
365 sw.dialing.Set(addr.IP.String(), addr)
366 defer sw.dialing.Delete(addr.IP.String())
368 log.WithField("address", addr).Info("Dialing peer")
369 peer, err := newOutboundPeerWithConfig(addr, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.peerConfig)
371 log.WithFields(log.Fields{
374 }).Info("Failed to dial peer")
377 peer.SetLogger(sw.Logger.With("peer", addr))
379 peer.makePersistent()
381 err = sw.AddPeer(peer)
383 log.WithFields(log.Fields{
386 }).Info("Failed to add peer")
390 log.WithFields(log.Fields{
392 }).Info("Dialed and added peer")
396 func (sw *Switch) IsDialing(addr *NetAddress) bool {
397 return sw.dialing.Has(addr.IP.String())
400 // Broadcast runs a go routine for each attempted send, which will block
401 // trying to send for defaultSendTimeoutSeconds. Returns a channel
402 // which receives success values for each attempted send (false if times out)
403 // NOTE: Broadcast uses goroutines, so order of broadcast may not be preserved.
404 func (sw *Switch) Broadcast(chID byte, msg interface{}) chan bool {
405 successChan := make(chan bool, len(sw.peers.List()))
406 log.WithFields(log.Fields{
409 }).Debug("Broadcast")
410 for _, peer := range sw.peers.List() {
411 go func(peer *Peer) {
412 success := peer.Send(chID, msg)
413 successChan <- success
419 // Returns the count of outbound/inbound and outbound-dialing peers.
420 func (sw *Switch) NumPeers() (outbound, inbound, dialing int) {
421 peers := sw.peers.List()
422 for _, peer := range peers {
429 dialing = sw.dialing.Size()
433 func (sw *Switch) Peers() *PeerSet {
437 // Disconnect from a peer due to external error, retry if it is a persistent peer.
438 // TODO: make record depending on reason.
439 func (sw *Switch) StopPeerForError(peer *Peer, reason interface{}) {
440 addr := NewNetAddress(peer.Addr())
441 log.WithFields(log.Fields{
444 }).Info("Stopping peer due to error")
445 sw.stopAndRemovePeer(peer, reason)
447 if peer.IsPersistent() {
448 log.WithField("peer", peer).Info("Reconnecting to peer")
449 for i := 1; i < reconnectAttempts; i++ {
454 peer, err := sw.DialPeerWithAddress(addr, true)
456 if i == reconnectAttempts {
457 log.WithFields(log.Fields{
460 }).Info("Error reconnecting to peer. Giving up")
464 if errors.Root(err) == ErrConnectBannedPeer || errors.Root(err) == ErrPeerConnected || errors.Root(err) == ErrSwitchDuplicatePeer || errors.Root(err) == ErrConnectSelf {
465 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")
483 // Disconnect from a peer gracefully.
484 // TODO: handle graceful disconnects.
485 func (sw *Switch) StopPeerGracefully(peer *Peer) {
486 log.Info("Stopping peer gracefully")
487 sw.stopAndRemovePeer(peer, nil)
490 func (sw *Switch) stopAndRemovePeer(peer *Peer, reason interface{}) {
491 sw.peers.Remove(peer)
493 for _, reactor := range sw.reactors {
494 reactor.RemovePeer(peer, reason)
498 func (sw *Switch) listenerRoutine(l Listener) {
500 inConn, ok := <-l.Connections()
505 // ignore connection if we already have enough
506 maxPeers := sw.config.MaxNumPeers
507 if maxPeers <= sw.peers.Size() {
510 log.WithFields(log.Fields{
511 "address": inConn.RemoteAddr().String(),
512 "numPeers": sw.peers.Size(),
514 }).Info("Ignoring inbound connection: already have enough peers")
518 // New inbound connection!
519 err := sw.addPeerWithConnectionAndConfig(inConn, sw.peerConfig)
521 // conn close for returing err
523 log.WithFields(log.Fields{
524 "address": inConn.RemoteAddr().String(),
526 }).Info("Ignoring inbound connection: error while adding peer")
530 // NOTE: We don't yet have the listening port of the
531 // remote (if they have a listener at all).
532 // The peerHandshake will handle that
538 //-----------------------------------------------------------------------------
540 type SwitchEventNewPeer struct {
544 type SwitchEventDonePeer struct {
549 //------------------------------------------------------------------
550 // Switches connected via arbitrary net.Conn; useful for testing
552 // Returns n switches, connected according to the connect func.
553 // If connect==Connect2Switches, the switches will be fully connected.
554 // initSwitch defines how the ith switch should be initialized (ie. with what reactors).
555 // NOTE: panics if any switch fails to start.
556 func MakeConnectedSwitches(cfg *cfg.P2PConfig, n int, initSwitch func(int, *Switch) *Switch, connect func([]*Switch, int, int)) []*Switch {
557 switches := make([]*Switch, n)
558 for i := 0; i < n; i++ {
559 switches[i] = makeSwitch(cfg, i, "testing", "123.123.123", initSwitch)
562 if err := StartSwitches(switches); err != nil {
566 for i := 0; i < n; i++ {
567 for j := i; j < n; j++ {
568 connect(switches, i, j)
575 var PanicOnAddPeerErr = false
577 // Will connect switches i and j via net.Pipe()
578 // Blocks until a conection is established.
579 // NOTE: caller ensures i and j are within bounds
580 func Connect2Switches(switches []*Switch, i, j int) {
581 switchI := switches[i]
582 switchJ := switches[j]
584 doneCh := make(chan struct{})
586 err := switchI.addPeerWithConnection(c1)
587 if PanicOnAddPeerErr && err != nil {
593 err := switchJ.addPeerWithConnection(c2)
594 if PanicOnAddPeerErr && err != nil {
603 func StartSwitches(switches []*Switch) error {
604 for _, s := range switches {
605 _, err := s.Start() // start switch and reactors
613 func makeSwitch(cfg *cfg.P2PConfig, i int, network, version string, initSwitch func(int, *Switch) *Switch) *Switch {
614 privKey := crypto.GenPrivKeyEd25519()
615 // new switch, add reactors
616 // TODO: let the config be passed in?
617 s := initSwitch(i, NewSwitch(cfg, nil))
618 s.SetNodeInfo(&NodeInfo{
619 PubKey: privKey.PubKey().Unwrap().(crypto.PubKeyEd25519),
620 Moniker: cmn.Fmt("switch%d", i),
623 RemoteAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
624 ListenAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
626 s.SetNodePrivKey(privKey)
630 func (sw *Switch) addPeerWithConnection(conn net.Conn) error {
631 peer, err := newInboundPeer(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.config)
636 peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
637 if err = sw.AddPeer(peer); err != nil {
645 func (sw *Switch) addPeerWithConnectionAndConfig(conn net.Conn, config *PeerConfig) error {
646 fullAddr := conn.RemoteAddr().String()
647 host, _, err := net.SplitHostPort(fullAddr)
652 if err = sw.checkBannedPeer(host); err != nil {
656 peer, err := newInboundPeerWithConfig(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, config)
660 peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
661 if err = sw.AddPeer(peer); err != nil {
668 func (sw *Switch) AddBannedPeer(peer *Peer) error {
670 defer sw.mtx.Unlock()
672 key := peer.mconn.RemoteAddress.IP.String()
673 sw.bannedPeer[key] = time.Now().Add(defaultBanDuration)
674 datajson, err := json.Marshal(sw.bannedPeer)
678 sw.db.Set([]byte(bannedPeerKey), datajson)
682 func (sw *Switch) DelBannedPeer(addr string) error {
684 defer sw.mtx.Unlock()
686 delete(sw.bannedPeer, addr)
687 datajson, err := json.Marshal(sw.bannedPeer)
691 sw.db.Set([]byte(bannedPeerKey), datajson)
695 func (sw *Switch) checkBannedPeer(peer string) error {
696 if banEnd, ok := sw.bannedPeer[peer]; ok {
697 if time.Now().Before(banEnd) {
698 return ErrConnectBannedPeer
700 sw.DelBannedPeer(peer)