OSDN Git Service

Merge pull request #958 from freewind/902-remove-unnecessery-code
[bytom/bytom.git] / p2p / switch.go
1 package p2p
2
3 import (
4         "encoding/json"
5         "fmt"
6         "math/rand"
7         "net"
8         "strings"
9         "sync"
10         "time"
11
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"
16
17         cfg "github.com/bytom/config"
18         "github.com/bytom/errors"
19         "github.com/bytom/p2p/trust"
20 )
21
22 const (
23         reconnectAttempts = 5
24         reconnectInterval = 10 * time.Second
25
26         bannedPeerKey      = "BannedPeer"
27         defaultBanDuration = time.Hour * 1
28 )
29
30 var ErrConnectBannedPeer = errors.New("Connect banned peer")
31
32 type Reactor interface {
33         cmn.Service // Start, Stop
34
35         SetSwitch(*Switch)
36         GetChannels() []*ChannelDescriptor
37         AddPeer(peer *Peer) error
38         RemovePeer(peer *Peer, reason interface{})
39         Receive(chID byte, peer *Peer, msgBytes []byte)
40 }
41
42 //--------------------------------------
43
44 type BaseReactor struct {
45         cmn.BaseService // Provides Start, Stop, .Quit
46         Switch          *Switch
47 }
48
49 func NewBaseReactor(name string, impl Reactor) *BaseReactor {
50         return &BaseReactor{
51                 BaseService: *cmn.NewBaseService(nil, name, impl),
52                 Switch:      nil,
53         }
54 }
55
56 func (br *BaseReactor) SetSwitch(sw *Switch) {
57         br.Switch = sw
58 }
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) {}
63
64 //-----------------------------------------------------------------------------
65
66 /*
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.
71 */
72 type Switch struct {
73         cmn.BaseService
74
75         config       *cfg.P2PConfig
76         peerConfig   *PeerConfig
77         listeners    []Listener
78         reactors     map[string]Reactor
79         chDescs      []*ChannelDescriptor
80         reactorsByCh map[byte]Reactor
81         peers        *PeerSet
82         dialing      *cmn.CMap
83         nodeInfo     *NodeInfo             // our node info
84         nodePrivKey  crypto.PrivKeyEd25519 // our node privkey
85         bannedPeer   map[string]time.Time
86         db           dbm.DB
87         mtx          sync.Mutex
88
89         filterConnByAddr   func(net.Addr) error
90         filterConnByPubKey func(crypto.PubKeyEd25519) error
91 }
92
93 var (
94         ErrSwitchDuplicatePeer = errors.New("Duplicate peer")
95         ErrConnectSelf         = errors.New("Connect self")
96         ErrPeerConnected       = errors.New("Peer is connected")
97 )
98
99 func NewSwitch(config *cfg.P2PConfig, trustHistoryDB dbm.DB) *Switch {
100         sw := &Switch{
101                 config:       config,
102                 peerConfig:   DefaultPeerConfig(config),
103                 reactors:     make(map[string]Reactor),
104                 chDescs:      make([]*ChannelDescriptor, 0),
105                 reactorsByCh: make(map[byte]Reactor),
106                 peers:        NewPeerSet(),
107                 dialing:      cmn.NewCMap(),
108                 nodeInfo:     nil,
109                 db:           trustHistoryDB,
110         }
111         sw.BaseService = *cmn.NewBaseService(nil, "P2P Switch", sw)
112
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 {
116                         return nil
117                 }
118         }
119         trust.Init()
120         return sw
121 }
122
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 {
129                 chID := chDesc.ID
130                 if sw.reactorsByCh[chID] != nil {
131                         cmn.PanicSanity(fmt.Sprintf("Channel %X has multiple reactors %v & %v", chID, sw.reactorsByCh[chID], reactor))
132                 }
133                 sw.chDescs = append(sw.chDescs, chDesc)
134                 sw.reactorsByCh[chID] = reactor
135         }
136         sw.reactors[name] = reactor
137         reactor.SetSwitch(sw)
138         return reactor
139 }
140
141 // Not goroutine safe.
142 func (sw *Switch) Reactors() map[string]Reactor {
143         return sw.reactors
144 }
145
146 // Not goroutine safe.
147 func (sw *Switch) Reactor(name string) Reactor {
148         return sw.reactors[name]
149 }
150
151 // Not goroutine safe.
152 func (sw *Switch) AddListener(l Listener) {
153         sw.listeners = append(sw.listeners, l)
154 }
155
156 // Not goroutine safe.
157 func (sw *Switch) Listeners() []Listener {
158         return sw.listeners
159 }
160
161 // Not goroutine safe.
162 func (sw *Switch) IsListening() bool {
163         return len(sw.listeners) > 0
164 }
165
166 // Not goroutine safe.
167 func (sw *Switch) SetNodeInfo(nodeInfo *NodeInfo) {
168         sw.nodeInfo = nodeInfo
169 }
170
171 // Not goroutine safe.
172 func (sw *Switch) NodeInfo() *NodeInfo {
173         return sw.nodeInfo
174 }
175
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)
182         }
183 }
184
185 // Switch.Start() starts all the reactors, peers, and listeners.
186 func (sw *Switch) OnStart() error {
187         sw.BaseService.OnStart()
188         // Start reactors
189         for _, reactor := range sw.reactors {
190                 _, err := reactor.Start()
191                 if err != nil {
192                         return err
193                 }
194         }
195         // Start listeners
196         for _, listener := range sw.listeners {
197                 go sw.listenerRoutine(listener)
198         }
199         return nil
200 }
201
202 func (sw *Switch) OnStop() {
203         sw.BaseService.OnStop()
204         // Stop listeners
205         for _, listener := range sw.listeners {
206                 listener.Stop()
207         }
208         sw.listeners = nil
209         // Stop peers
210         for _, peer := range sw.peers.List() {
211                 peer.Stop()
212                 sw.peers.Remove(peer)
213         }
214         // Stop reactors
215         for _, reactor := range sw.reactors {
216                 reactor.Stop()
217         }
218 }
219
220 // NOTE: This performs a blocking handshake before the peer is added.
221 // CONTRACT: If error is returned, peer is nil, and conn is immediately closed.
222 func (sw *Switch) AddPeer(peer *Peer) error {
223         if err := sw.FilterConnByAddr(peer.Addr()); err != nil {
224                 return err
225         }
226
227         if err := sw.FilterConnByPubKey(peer.PubKey()); err != nil {
228                 return err
229         }
230
231         if err := peer.HandshakeTimeout(sw.nodeInfo, time.Duration(sw.peerConfig.HandshakeTimeout*time.Second)); err != nil {
232                 return err
233         }
234
235         if err := sw.checkBannedPeer(peer.NodeInfo.ListenHost()); err != nil {
236                 return err
237         }
238
239         // Avoid self
240         if sw.nodeInfo.PubKey.Equals(peer.PubKey().Wrap()) {
241                 return errors.New("Ignoring connection from self")
242         }
243
244         // Check version, chain id
245         if err := sw.nodeInfo.CompatibleWith(peer.NodeInfo); err != nil {
246                 return err
247         }
248
249         // Check for duplicate peer
250         if sw.peers.Has(peer.Key) {
251                 return ErrSwitchDuplicatePeer
252
253         }
254
255         // Start peer
256         if sw.IsRunning() {
257                 if err := sw.startInitPeer(peer); err != nil {
258                         return err
259                 }
260         }
261
262         // Add the peer to .peers.
263         // We start it first so that a peer in the list is safe to Stop.
264         // It should not err since we already checked peers.Has()
265         if err := sw.peers.Add(peer); err != nil {
266                 return err
267         }
268
269         log.WithField("peer", peer).Info("Added peer")
270         return nil
271 }
272
273 func (sw *Switch) FilterConnByAddr(addr net.Addr) error {
274         if sw.filterConnByAddr != nil {
275                 return sw.filterConnByAddr(addr)
276         }
277         return nil
278 }
279
280 func (sw *Switch) FilterConnByPubKey(pubkey crypto.PubKeyEd25519) error {
281         if sw.filterConnByPubKey != nil {
282                 return sw.filterConnByPubKey(pubkey)
283         }
284         return nil
285
286 }
287
288 func (sw *Switch) SetAddrFilter(f func(net.Addr) error) {
289         sw.filterConnByAddr = f
290 }
291
292 func (sw *Switch) SetPubKeyFilter(f func(crypto.PubKeyEd25519) error) {
293         sw.filterConnByPubKey = f
294 }
295
296 func (sw *Switch) startInitPeer(peer *Peer) error {
297         peer.Start() // spawn send/recv routines
298         for _, reactor := range sw.reactors {
299                 if err := reactor.AddPeer(peer); err != nil {
300                         return err
301                 }
302         }
303         return nil
304 }
305
306 // Dial a list of seeds asynchronously in random order
307 func (sw *Switch) DialSeeds(addrBook *AddrBook, seeds []string) error {
308
309         netAddrs, err := NewNetAddressStrings(seeds)
310         if err != nil {
311                 return err
312         }
313
314         if addrBook != nil {
315                 // add seeds to `addrBook`
316                 ourAddrS := sw.nodeInfo.ListenAddr
317                 ourAddr, _ := NewNetAddressString(ourAddrS)
318                 for _, netAddr := range netAddrs {
319                         // do not add ourselves
320                         if netAddr.Equals(ourAddr) {
321                                 continue
322                         }
323                         addrBook.AddAddress(netAddr, ourAddr)
324                 }
325
326                 addrBook.Save()
327         }
328         //permute the list, dial them in random order.
329         perm := rand.Perm(len(netAddrs))
330         for i := 0; i < len(perm); i += 2 {
331                 j := perm[i]
332                 sw.dialSeed(netAddrs[j])
333         }
334
335         return nil
336 }
337
338 func (sw *Switch) dialSeed(addr *NetAddress) {
339         peer, err := sw.DialPeerWithAddress(addr, false)
340         if err != nil {
341                 log.WithField("error", err).Error("Error dialing seed")
342         } else {
343                 log.WithField("peer", peer).Info("Connected to seed")
344         }
345 }
346
347 func (sw *Switch) DialPeerWithAddress(addr *NetAddress, persistent bool) (*Peer, error) {
348         if err := sw.checkBannedPeer(addr.IP.String()); err != nil {
349                 return nil, err
350         }
351         if strings.Compare(addr.IP.String(), sw.nodeInfo.ListenHost()) == 0 {
352                 return nil, ErrConnectSelf
353         }
354         for _, v := range sw.Peers().list {
355                 if strings.Compare(v.mconn.RemoteAddress.IP.String(), addr.IP.String()) == 0 {
356                         return nil, ErrPeerConnected
357                 }
358         }
359         sw.dialing.Set(addr.IP.String(), addr)
360         defer sw.dialing.Delete(addr.IP.String())
361
362         log.Debug("Dialing peer address:", addr)
363         peer, err := newOutboundPeerWithConfig(addr, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.peerConfig)
364         if err != nil {
365                 log.Debug("Failed to dial peer", " address:", addr, " error:", err)
366                 return nil, err
367         }
368         peer.SetLogger(sw.Logger.With("peer", addr))
369         if persistent {
370                 peer.makePersistent()
371         }
372         err = sw.AddPeer(peer)
373         if err != nil {
374                 log.WithFields(log.Fields{
375                         "address": addr,
376                         "error":   err,
377                 }).Info("Failed to add peer")
378                 peer.CloseConn()
379                 return nil, err
380         }
381         log.WithFields(log.Fields{
382                 "address": addr,
383         }).Info("Dialed and added peer")
384         return peer, nil
385 }
386
387 func (sw *Switch) IsDialing(addr *NetAddress) bool {
388         return sw.dialing.Has(addr.IP.String())
389 }
390
391 // Broadcast runs a go routine for each attempted send, which will block
392 // trying to send for defaultSendTimeoutSeconds. Returns a channel
393 // which receives success values for each attempted send (false if times out)
394 // NOTE: Broadcast uses goroutines, so order of broadcast may not be preserved.
395 func (sw *Switch) Broadcast(chID byte, msg interface{}) chan bool {
396         successChan := make(chan bool, len(sw.peers.List()))
397         log.WithFields(log.Fields{
398                 "chID": chID,
399                 "msg":  msg,
400         }).Debug("Broadcast")
401         for _, peer := range sw.peers.List() {
402                 go func(peer *Peer) {
403                         success := peer.Send(chID, msg)
404                         successChan <- success
405                 }(peer)
406         }
407         return successChan
408 }
409
410 // Returns the count of outbound/inbound and outbound-dialing peers.
411 func (sw *Switch) NumPeers() (outbound, inbound, dialing int) {
412         peers := sw.peers.List()
413         for _, peer := range peers {
414                 if peer.outbound {
415                         outbound++
416                 } else {
417                         inbound++
418                 }
419         }
420         dialing = sw.dialing.Size()
421         return
422 }
423
424 func (sw *Switch) Peers() *PeerSet {
425         return sw.peers
426 }
427
428 // Disconnect from a peer due to external error, retry if it is a persistent peer.
429 // TODO: make record depending on reason.
430 func (sw *Switch) StopPeerForError(peer *Peer, reason interface{}) {
431         addr := NewNetAddress(peer.Addr())
432         log.WithFields(log.Fields{
433                 "peer":  peer,
434                 "error": reason,
435         }).Info("Stopping peer due to error")
436         sw.stopAndRemovePeer(peer, reason)
437
438         if peer.IsPersistent() {
439                 log.WithField("peer", peer).Info("Reconnecting to peer")
440                 for i := 1; i < reconnectAttempts; i++ {
441                         if !sw.IsRunning() {
442                                 return
443                         }
444
445                         peer, err := sw.DialPeerWithAddress(addr, false)
446                         if err != nil {
447                                 if i == reconnectAttempts {
448                                         log.WithFields(log.Fields{
449                                                 "retries": i,
450                                                 "error":   err,
451                                         }).Info("Error reconnecting to peer. Giving up")
452                                         return
453                                 }
454
455                                 if errors.Root(err) == ErrConnectBannedPeer || errors.Root(err) == ErrPeerConnected || errors.Root(err) == ErrSwitchDuplicatePeer || errors.Root(err) == ErrConnectSelf {
456                                         log.WithField("error", err).Info("Error reconnecting to peer. ")
457                                         return
458                                 }
459
460                                 log.WithFields(log.Fields{
461                                         "retries": i,
462                                         "error":   err,
463                                 }).Info("Error reconnecting to peer. Trying again")
464                                 time.Sleep(reconnectInterval)
465                                 continue
466                         }
467
468                         log.WithField("peer", peer).Info("Reconnected to peer")
469                         return
470                 }
471         }
472 }
473
474 // Disconnect from a peer gracefully.
475 // TODO: handle graceful disconnects.
476 func (sw *Switch) StopPeerGracefully(peer *Peer) {
477         log.Info("Stopping peer gracefully")
478         sw.stopAndRemovePeer(peer, nil)
479 }
480
481 func (sw *Switch) stopAndRemovePeer(peer *Peer, reason interface{}) {
482         for _, reactor := range sw.reactors {
483                 reactor.RemovePeer(peer, reason)
484         }
485         sw.peers.Remove(peer)
486         log.Info("Del peer from switch.")
487         peer.Stop()
488         log.Info("Peer connection is closed.")
489 }
490
491 func (sw *Switch) listenerRoutine(l Listener) {
492         for {
493                 inConn, ok := <-l.Connections()
494                 if !ok {
495                         break
496                 }
497
498                 // disconnect if we alrady have 2 * MaxNumPeers, we do this because we wanna address book get exchanged even if
499                 // the connect is full. The pex will disconnect the peer after address exchange, the max connected peer won't
500                 // be double of MaxNumPeers
501                 if sw.config.MaxNumPeers*2 <= sw.peers.Size() {
502                         // close inConn
503                         inConn.Close()
504                         log.WithFields(log.Fields{
505                                 "address":  inConn.RemoteAddr().String(),
506                                 "numPeers": sw.peers.Size(),
507                         }).Info("Ignoring inbound connection: already have enough peers")
508                         continue
509                 }
510
511                 // New inbound connection!
512                 err := sw.addPeerWithConnectionAndConfig(inConn, sw.peerConfig)
513                 if err != nil {
514                         // conn close for returing err
515                         inConn.Close()
516                         log.WithFields(log.Fields{
517                                 "address": inConn.RemoteAddr().String(),
518                                 "error":   err,
519                         }).Info("Ignoring inbound connection: error while adding peer")
520                         continue
521                 }
522
523                 // NOTE: We don't yet have the listening port of the
524                 // remote (if they have a listener at all).
525                 // The peerHandshake will handle that
526         }
527
528         // cleanup
529 }
530
531 //-----------------------------------------------------------------------------
532
533 type SwitchEventNewPeer struct {
534         Peer *Peer
535 }
536
537 type SwitchEventDonePeer struct {
538         Peer  *Peer
539         Error interface{}
540 }
541
542 //------------------------------------------------------------------
543 // Switches connected via arbitrary net.Conn; useful for testing
544
545 // Returns n switches, connected according to the connect func.
546 // If connect==Connect2Switches, the switches will be fully connected.
547 // initSwitch defines how the ith switch should be initialized (ie. with what reactors).
548 // NOTE: panics if any switch fails to start.
549 func MakeConnectedSwitches(cfg *cfg.P2PConfig, n int, initSwitch func(int, *Switch) *Switch, connect func([]*Switch, int, int)) []*Switch {
550         switches := make([]*Switch, n)
551         for i := 0; i < n; i++ {
552                 switches[i] = makeSwitch(cfg, i, "testing", "123.123.123", initSwitch)
553         }
554
555         if err := StartSwitches(switches); err != nil {
556                 panic(err)
557         }
558
559         for i := 0; i < n; i++ {
560                 for j := i; j < n; j++ {
561                         connect(switches, i, j)
562                 }
563         }
564
565         return switches
566 }
567
568 var PanicOnAddPeerErr = false
569
570 // Will connect switches i and j via net.Pipe()
571 // Blocks until a conection is established.
572 // NOTE: caller ensures i and j are within bounds
573 func Connect2Switches(switches []*Switch, i, j int) {
574         switchI := switches[i]
575         switchJ := switches[j]
576         c1, c2 := net.Pipe()
577         doneCh := make(chan struct{})
578         go func() {
579                 err := switchI.addPeerWithConnection(c1)
580                 if PanicOnAddPeerErr && err != nil {
581                         panic(err)
582                 }
583                 doneCh <- struct{}{}
584         }()
585         go func() {
586                 err := switchJ.addPeerWithConnection(c2)
587                 if PanicOnAddPeerErr && err != nil {
588                         panic(err)
589                 }
590                 doneCh <- struct{}{}
591         }()
592         <-doneCh
593         <-doneCh
594 }
595
596 func StartSwitches(switches []*Switch) error {
597         for _, s := range switches {
598                 _, err := s.Start() // start switch and reactors
599                 if err != nil {
600                         return err
601                 }
602         }
603         return nil
604 }
605
606 func makeSwitch(cfg *cfg.P2PConfig, i int, network, version string, initSwitch func(int, *Switch) *Switch) *Switch {
607         privKey := crypto.GenPrivKeyEd25519()
608         // new switch, add reactors
609         // TODO: let the config be passed in?
610         s := initSwitch(i, NewSwitch(cfg, nil))
611         s.SetNodeInfo(&NodeInfo{
612                 PubKey:     privKey.PubKey().Unwrap().(crypto.PubKeyEd25519),
613                 Moniker:    cmn.Fmt("switch%d", i),
614                 Network:    network,
615                 Version:    version,
616                 RemoteAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
617                 ListenAddr: cmn.Fmt("%v:%v", network, rand.Intn(64512)+1023),
618         })
619         s.SetNodePrivKey(privKey)
620         return s
621 }
622
623 func (sw *Switch) addPeerWithConnection(conn net.Conn) error {
624         peer, err := newInboundPeer(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, sw.config)
625         if err != nil {
626                 conn.Close()
627                 return err
628         }
629         peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
630         if err = sw.AddPeer(peer); err != nil {
631                 conn.Close()
632                 return err
633         }
634
635         return nil
636 }
637
638 func (sw *Switch) addPeerWithConnectionAndConfig(conn net.Conn, config *PeerConfig) error {
639         fullAddr := conn.RemoteAddr().String()
640         host, _, err := net.SplitHostPort(fullAddr)
641         if err != nil {
642                 return err
643         }
644
645         if err = sw.checkBannedPeer(host); err != nil {
646                 return err
647         }
648
649         peer, err := newInboundPeerWithConfig(conn, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, sw.nodePrivKey, config)
650         if err != nil {
651                 return err
652         }
653         peer.SetLogger(sw.Logger.With("peer", conn.RemoteAddr()))
654         if err = sw.AddPeer(peer); err != nil {
655                 return err
656         }
657
658         return nil
659 }
660
661 func (sw *Switch) AddBannedPeer(peer *Peer) error {
662         sw.mtx.Lock()
663         defer sw.mtx.Unlock()
664         if peer == nil {
665                 return nil
666         }
667         key := peer.mconn.RemoteAddress.IP.String()
668         sw.bannedPeer[key] = time.Now().Add(defaultBanDuration)
669         datajson, err := json.Marshal(sw.bannedPeer)
670         if err != nil {
671                 return err
672         }
673         sw.db.Set([]byte(bannedPeerKey), datajson)
674         return nil
675 }
676
677 func (sw *Switch) delBannedPeer(addr string) error {
678         delete(sw.bannedPeer, addr)
679         datajson, err := json.Marshal(sw.bannedPeer)
680         if err != nil {
681                 return err
682         }
683         sw.db.Set([]byte(bannedPeerKey), datajson)
684         return nil
685 }
686
687 func (sw *Switch) checkBannedPeer(peer string) error {
688         sw.mtx.Lock()
689         defer sw.mtx.Unlock()
690
691         if banEnd, ok := sw.bannedPeer[peer]; ok {
692                 if time.Now().Before(banEnd) {
693                         return ErrConnectBannedPeer
694                 }
695                 sw.delBannedPeer(peer)
696         }
697         return nil
698 }