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
89 filterConnByAddr func(net.Addr) error
90 filterConnByPubKey func(crypto.PubKeyEd25519) error
94 ErrSwitchDuplicatePeer = errors.New("Duplicate peer")
95 ErrConnectSelf = errors.New("Connect self")
96 ErrPeerConnected = errors.New("Peer is connected")
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(),
111 sw.BaseService = *cmn.NewBaseService(nil, "P2P Switch", sw)
113 sw.bannedPeer = make(map[string]time.Time)
114 if datajson := sw.db.Get([]byte(bannedPeerKey)); datajson != nil {
115 if err := json.Unmarshal(datajson, &sw.bannedPeer); err != nil {
123 // Not goroutine safe.
124 func (sw *Switch) AddReactor(name string, reactor Reactor) Reactor {
125 // Validate the reactor.
126 // No two reactors can share the same channel.
127 reactorChannels := reactor.GetChannels()
128 for _, chDesc := range reactorChannels {
130 if sw.reactorsByCh[chID] != nil {
131 cmn.PanicSanity(fmt.Sprintf("Channel %X has multiple reactors %v & %v", chID, sw.reactorsByCh[chID], reactor))
133 sw.chDescs = append(sw.chDescs, chDesc)
134 sw.reactorsByCh[chID] = reactor
136 sw.reactors[name] = reactor
137 reactor.SetSwitch(sw)
141 // Not goroutine safe.
142 func (sw *Switch) Reactors() map[string]Reactor {
146 // Not goroutine safe.
147 func (sw *Switch) Reactor(name string) Reactor {
148 return sw.reactors[name]
151 // Not goroutine safe.
152 func (sw *Switch) AddListener(l Listener) {
153 sw.listeners = append(sw.listeners, l)
156 // Not goroutine safe.
157 func (sw *Switch) Listeners() []Listener {
161 // Not goroutine safe.
162 func (sw *Switch) IsListening() bool {
163 return len(sw.listeners) > 0
166 // Not goroutine safe.
167 func (sw *Switch) SetNodeInfo(nodeInfo *NodeInfo) {
168 sw.nodeInfo = nodeInfo
171 // Not goroutine safe.
172 func (sw *Switch) NodeInfo() *NodeInfo {
176 // Not goroutine safe.
177 // NOTE: Overwrites sw.nodeInfo.PubKey
178 func (sw *Switch) SetNodePrivKey(nodePrivKey crypto.PrivKeyEd25519) {
179 sw.nodePrivKey = nodePrivKey
180 if sw.nodeInfo != nil {
181 sw.nodeInfo.PubKey = nodePrivKey.PubKey().Unwrap().(crypto.PubKeyEd25519)
185 // Switch.Start() starts all the reactors, peers, and listeners.
186 func (sw *Switch) OnStart() error {
187 sw.BaseService.OnStart()
189 for _, reactor := range sw.reactors {
190 _, err := reactor.Start()
196 for _, peer := range sw.peers.List() {
197 sw.startInitPeer(peer)
200 for _, listener := range sw.listeners {
201 go sw.listenerRoutine(listener)
206 func (sw *Switch) OnStop() {
207 sw.BaseService.OnStop()
209 for _, listener := range sw.listeners {
214 for _, peer := range sw.peers.List() {
216 sw.peers.Remove(peer)
219 for _, reactor := range sw.reactors {
224 // NOTE: This performs a blocking handshake before the peer is added.
225 // CONTRACT: If error is returned, peer is nil, and conn is immediately closed.
226 func (sw *Switch) AddPeer(peer *Peer) error {
227 if err := sw.FilterConnByAddr(peer.Addr()); err != nil {
231 if err := sw.FilterConnByPubKey(peer.PubKey()); err != nil {
235 if err := peer.HandshakeTimeout(sw.nodeInfo, time.Duration(sw.peerConfig.HandshakeTimeout*time.Second)); err != nil {
239 if err := sw.checkBannedPeer(peer.NodeInfo.ListenHost()); err != nil {
244 if sw.nodeInfo.PubKey.Equals(peer.PubKey().Wrap()) {
245 return errors.New("Ignoring connection from self")
248 // Check version, chain id
249 if err := sw.nodeInfo.CompatibleWith(peer.NodeInfo); err != nil {
253 // Check for duplicate peer
254 if sw.peers.Has(peer.Key) {
255 return ErrSwitchDuplicatePeer
261 if err := sw.startInitPeer(peer); err != nil {
266 // Add the peer to .peers.
267 // We start it first so that a peer in the list is safe to Stop.
268 // It should not err since we already checked peers.Has()
269 if err := sw.peers.Add(peer); err != nil {
273 log.WithField("peer", peer).Info("Added peer")
277 func (sw *Switch) FilterConnByAddr(addr net.Addr) error {
278 if sw.filterConnByAddr != nil {
279 return sw.filterConnByAddr(addr)
284 func (sw *Switch) FilterConnByPubKey(pubkey crypto.PubKeyEd25519) error {
285 if sw.filterConnByPubKey != nil {
286 return sw.filterConnByPubKey(pubkey)
292 func (sw *Switch) SetAddrFilter(f func(net.Addr) error) {
293 sw.filterConnByAddr = f
296 func (sw *Switch) SetPubKeyFilter(f func(crypto.PubKeyEd25519) error) {
297 sw.filterConnByPubKey = f
300 func (sw *Switch) startInitPeer(peer *Peer) error {
301 peer.Start() // spawn send/recv routines
302 for _, reactor := range sw.reactors {
303 if err := reactor.AddPeer(peer); err != nil {
310 // Dial a list of seeds asynchronously in random order
311 func (sw *Switch) DialSeeds(addrBook *AddrBook, seeds []string) error {
313 netAddrs, err := NewNetAddressStrings(seeds)
319 // add seeds to `addrBook`
320 ourAddrS := sw.nodeInfo.ListenAddr
321 ourAddr, _ := NewNetAddressString(ourAddrS)
322 for _, netAddr := range netAddrs {
323 // do not add ourselves
324 if netAddr.Equals(ourAddr) {
327 addrBook.AddAddress(netAddr, ourAddr)
336 func (sw *Switch) dialSeed(addr *NetAddress) {
337 peer, err := sw.DialPeerWithAddress(addr, true)
339 log.WithField("error", err).Error("Error dialing seed")
341 log.WithField("peer", peer).Info("Connected to seed")
345 func (sw *Switch) DialPeerWithAddress(addr *NetAddress, persistent bool) (*Peer, error) {
346 if err := sw.checkBannedPeer(addr.IP.String()); err != nil {
349 if strings.Compare(addr.IP.String(), sw.nodeInfo.ListenHost()) == 0 {
350 return nil, ErrConnectSelf
352 for _, v := range sw.Peers().list {
353 if strings.Compare(v.mconn.RemoteAddress.IP.String(), addr.IP.String()) == 0 {
354 return nil, ErrPeerConnected
357 sw.dialing.Set(addr.IP.String(), addr)
358 defer sw.dialing.Delete(addr.IP.String())
360 log.WithField("address", addr).Info("Dialing peer")
361 peer, err := newOutboundPeerWithConfig(addr, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.peerConfig)
363 log.WithFields(log.Fields{
366 }).Info("Failed to dial peer")
369 peer.SetLogger(sw.Logger.With("peer", addr))
371 peer.makePersistent()
373 err = sw.AddPeer(peer)
375 log.WithFields(log.Fields{
378 }).Info("Failed to add peer")
382 log.WithFields(log.Fields{
384 }).Info("Dialed and added peer")
388 func (sw *Switch) IsDialing(addr *NetAddress) bool {
389 return sw.dialing.Has(addr.IP.String())
392 // Broadcast runs a go routine for each attempted send, which will block
393 // trying to send for defaultSendTimeoutSeconds. Returns a channel
394 // which receives success values for each attempted send (false if times out)
395 // NOTE: Broadcast uses goroutines, so order of broadcast may not be preserved.
396 func (sw *Switch) Broadcast(chID byte, msg interface{}) chan bool {
397 successChan := make(chan bool, len(sw.peers.List()))
398 log.WithFields(log.Fields{
401 }).Debug("Broadcast")
402 for _, peer := range sw.peers.List() {
403 go func(peer *Peer) {
404 success := peer.Send(chID, msg)
405 successChan <- success
411 // Returns the count of outbound/inbound and outbound-dialing peers.
412 func (sw *Switch) NumPeers() (outbound, inbound, dialing int) {
413 peers := sw.peers.List()
414 for _, peer := range peers {
421 dialing = sw.dialing.Size()
425 func (sw *Switch) Peers() *PeerSet {
429 // Disconnect from a peer due to external error, retry if it is a persistent peer.
430 // TODO: make record depending on reason.
431 func (sw *Switch) StopPeerForError(peer *Peer, reason interface{}) {
432 addr := NewNetAddress(peer.Addr())
433 log.WithFields(log.Fields{
436 }).Info("Stopping peer due to error")
437 sw.stopAndRemovePeer(peer, reason)
439 if peer.IsPersistent() {
440 log.WithField("peer", peer).Info("Reconnecting to peer")
441 for i := 1; i < reconnectAttempts; i++ {
446 peer, err := sw.DialPeerWithAddress(addr, true)
448 if i == reconnectAttempts {
449 log.WithFields(log.Fields{
452 }).Info("Error reconnecting to peer. Giving up")
456 if errors.Root(err) == ErrConnectBannedPeer || errors.Root(err) == ErrPeerConnected || errors.Root(err) == ErrSwitchDuplicatePeer || errors.Root(err) == ErrConnectSelf {
457 log.WithField("error", err).Info("Error reconnecting to peer. ")
461 log.WithFields(log.Fields{
464 }).Info("Error reconnecting to peer. Trying again")
465 time.Sleep(reconnectInterval)
469 log.WithField("peer", peer).Info("Reconnected to peer")
475 // Disconnect from a peer gracefully.
476 // TODO: handle graceful disconnects.
477 func (sw *Switch) StopPeerGracefully(peer *Peer) {
478 log.Info("Stopping peer gracefully")
479 sw.stopAndRemovePeer(peer, nil)
482 func (sw *Switch) stopAndRemovePeer(peer *Peer, reason interface{}) {
483 for _, reactor := range sw.reactors {
484 reactor.RemovePeer(peer, reason)
486 sw.peers.Remove(peer)
490 func (sw *Switch) listenerRoutine(l Listener) {
492 inConn, ok := <-l.Connections()
497 // ignore connection if we already have enough
498 maxPeers := sw.config.MaxNumPeers
499 if maxPeers <= sw.peers.Size() {
502 log.WithFields(log.Fields{
503 "address": inConn.RemoteAddr().String(),
504 "numPeers": sw.peers.Size(),
506 }).Info("Ignoring inbound connection: already have enough peers")
510 // New inbound connection!
511 err := sw.addPeerWithConnectionAndConfig(inConn, sw.peerConfig)
513 // conn close for returing err
515 log.WithFields(log.Fields{
516 "address": inConn.RemoteAddr().String(),
518 }).Info("Ignoring inbound connection: error while adding peer")
522 // NOTE: We don't yet have the listening port of the
523 // remote (if they have a listener at all).
524 // The peerHandshake will handle that
530 //-----------------------------------------------------------------------------
532 type SwitchEventNewPeer struct {
536 type SwitchEventDonePeer struct {
541 //------------------------------------------------------------------
542 // Switches connected via arbitrary net.Conn; useful for testing
544 // Returns n switches, connected according to the connect func.
545 // If connect==Connect2Switches, the switches will be fully connected.
546 // initSwitch defines how the ith switch should be initialized (ie. with what reactors).
547 // NOTE: panics if any switch fails to start.
548 func MakeConnectedSwitches(cfg *cfg.P2PConfig, n int, initSwitch func(int, *Switch) *Switch, connect func([]*Switch, int, int)) []*Switch {
549 switches := make([]*Switch, n)
550 for i := 0; i < n; i++ {
551 switches[i] = makeSwitch(cfg, i, "testing", "123.123.123", initSwitch)
554 if err := StartSwitches(switches); err != nil {
558 for i := 0; i < n; i++ {
559 for j := i; j < n; j++ {
560 connect(switches, i, j)
567 var PanicOnAddPeerErr = false
569 // Will connect switches i and j via net.Pipe()
570 // Blocks until a conection is established.
571 // NOTE: caller ensures i and j are within bounds
572 func Connect2Switches(switches []*Switch, i, j int) {
573 switchI := switches[i]
574 switchJ := switches[j]
576 doneCh := make(chan struct{})
578 err := switchI.addPeerWithConnection(c1)
579 if PanicOnAddPeerErr && err != nil {
585 err := switchJ.addPeerWithConnection(c2)
586 if PanicOnAddPeerErr && err != nil {
595 func StartSwitches(switches []*Switch) error {
596 for _, s := range switches {
597 _, err := s.Start() // start switch and reactors
605 func makeSwitch(cfg *cfg.P2PConfig, i int, network, version string, initSwitch func(int, *Switch) *Switch) *Switch {
606 privKey := crypto.GenPrivKeyEd25519()
607 // new switch, add reactors
608 // TODO: let the config be passed in?
609 s := initSwitch(i, NewSwitch(cfg, nil))
610 s.SetNodeInfo(&NodeInfo{
611 PubKey: privKey.PubKey().Unwrap().(crypto.PubKeyEd25519),
612 Moniker: cmn.Fmt("switch%d", i),
615 RemoteAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
616 ListenAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
618 s.SetNodePrivKey(privKey)
622 func (sw *Switch) addPeerWithConnection(conn net.Conn) error {
623 peer, err := newInboundPeer(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.config)
628 peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
629 if err = sw.AddPeer(peer); err != nil {
637 func (sw *Switch) addPeerWithConnectionAndConfig(conn net.Conn, config *PeerConfig) error {
638 fullAddr := conn.RemoteAddr().String()
639 host, _, err := net.SplitHostPort(fullAddr)
644 if err = sw.checkBannedPeer(host); err != nil {
648 peer, err := newInboundPeerWithConfig(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, config)
652 peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
653 if err = sw.AddPeer(peer); err != nil {
660 func (sw *Switch) AddBannedPeer(peer *Peer) error {
662 defer sw.mtx.Unlock()
666 key := peer.mconn.RemoteAddress.IP.String()
667 sw.bannedPeer[key] = time.Now().Add(defaultBanDuration)
668 datajson, err := json.Marshal(sw.bannedPeer)
672 sw.db.Set([]byte(bannedPeerKey), datajson)
676 func (sw *Switch) DelBannedPeer(addr string) error {
678 defer sw.mtx.Unlock()
680 delete(sw.bannedPeer, addr)
681 datajson, err := json.Marshal(sw.bannedPeer)
685 sw.db.Set([]byte(bannedPeerKey), datajson)
689 func (sw *Switch) checkBannedPeer(peer string) error {
690 if banEnd, ok := sw.bannedPeer[peer]; ok {
691 if time.Now().Before(banEnd) {
692 return ErrConnectBannedPeer
694 sw.DelBannedPeer(peer)