p2p/switch.go

   1 package p2p
   2
   3 import (
   4         "encoding/json"
   5         "fmt"
   6         "net"
   7         "sync"
   8         "time"
   9
  10         log "github.com/sirupsen/logrus"
  11         "github.com/tendermint/go-crypto"
  12         cmn "github.com/tendermint/tmlibs/common"
  13         dbm "github.com/tendermint/tmlibs/db"
  14
  15         cfg "github.com/bytom/config"
  16         "github.com/bytom/errors"
  17         "github.com/bytom/p2p/connection"
  18         "github.com/bytom/p2p/trust"
  19 )
  20
  21 const (
  22         bannedPeerKey      = "BannedPeer"
  23         defaultBanDuration = time.Hour * 1
  24 )
  25
  26 //pre-define errors for connecting fail
  27 var (
  28         ErrDuplicatePeer     = errors.New("Duplicate peer")
  29         ErrConnectSelf       = errors.New("Connect self")
  30         ErrConnectBannedPeer = errors.New("Connect banned peer")
  31 )
  32
  33 // Switch handles peer connections and exposes an API to receive incoming messages
  34 // on `Reactors`.  Each `Reactor` is responsible for handling incoming messages of one
  35 // or more `Channels`.  So while sending outgoing messages is typically performed on the peer,
  36 // incoming messages are received on the reactor.
  37 type Switch struct {
  38         cmn.BaseService
  39
  40         Config       *cfg.Config
  41         peerConfig   *PeerConfig
  42         listeners    []Listener
  43         reactors     map[string]Reactor
  44         chDescs      []*connection.ChannelDescriptor
  45         reactorsByCh map[byte]Reactor
  46         peers        *PeerSet
  47         dialing      *cmn.CMap
  48         nodeInfo     *NodeInfo             // our node info
  49         nodePrivKey  crypto.PrivKeyEd25519 // our node privkey
  50         bannedPeer   map[string]time.Time
  51         db           dbm.DB
  52         mtx          sync.Mutex
  53 }
  54
  55 // NewSwitch creates a new Switch with the given config.
  56 func NewSwitch(config *cfg.Config) *Switch {
  57         sw := &Switch{
  58                 Config:       config,
  59                 peerConfig:   DefaultPeerConfig(config.P2P),
  60                 reactors:     make(map[string]Reactor),
  61                 chDescs:      make([]*connection.ChannelDescriptor, 0),
  62                 reactorsByCh: make(map[byte]Reactor),
  63                 peers:        NewPeerSet(),
  64                 dialing:      cmn.NewCMap(),
  65                 nodeInfo:     nil,
  66                 db:           dbm.NewDB("trusthistory", config.DBBackend, config.DBDir()),
  67         }
  68         sw.BaseService = *cmn.NewBaseService(nil, "P2P Switch", sw)
  69         sw.bannedPeer = make(map[string]time.Time)
  70         if datajson := sw.db.Get([]byte(bannedPeerKey)); datajson != nil {
  71                 if err := json.Unmarshal(datajson, &sw.bannedPeer); err != nil {
  72                         return nil
  73                 }
  74         }
  75         trust.Init()
  76         return sw
  77 }
  78
  79 // OnStart implements BaseService. It starts all the reactors, peers, and listeners.
  80 func (sw *Switch) OnStart() error {
  81         for _, reactor := range sw.reactors {
  82                 if _, err := reactor.Start(); err != nil {
  83                         return err
  84                 }
  85         }
  86         for _, listener := range sw.listeners {
  87                 go sw.listenerRoutine(listener)
  88         }
  89         return nil
  90 }
  91
  92 // OnStop implements BaseService. It stops all listeners, peers, and reactors.
  93 func (sw *Switch) OnStop() {
  94         for _, listener := range sw.listeners {
  95                 listener.Stop()
  96         }
  97         sw.listeners = nil
  98
  99         for _, peer := range sw.peers.List() {
 100                 peer.Stop()
 101                 sw.peers.Remove(peer)
 102         }
 103
 104         for _, reactor := range sw.reactors {
 105                 reactor.Stop()
 106         }
 107 }
 108
 109 //AddBannedPeer add peer to blacklist
 110 func (sw *Switch) AddBannedPeer(ip string) error {
 111         sw.mtx.Lock()
 112         defer sw.mtx.Unlock()
 113
 114         sw.bannedPeer[ip] = time.Now().Add(defaultBanDuration)
 115         datajson, err := json.Marshal(sw.bannedPeer)
 116         if err != nil {
 117                 return err
 118         }
 119
 120         sw.db.Set([]byte(bannedPeerKey), datajson)
 121         return nil
 122 }
 123
 124 // AddPeer performs the P2P handshake with a peer
 125 // that already has a SecretConnection. If all goes well,
 126 // it starts the peer and adds it to the switch.
 127 // NOTE: This performs a blocking handshake before the peer is added.
 128 // CONTRACT: If error is returned, peer is nil, and conn is immediately closed.
 129 func (sw *Switch) AddPeer(pc *peerConn) error {
 130         peerNodeInfo, err := pc.HandshakeTimeout(sw.nodeInfo, time.Duration(sw.peerConfig.HandshakeTimeout*time.Second))
 131         if err != nil {
 132                 return err
 133         }
 134
 135         if err := sw.nodeInfo.CompatibleWith(peerNodeInfo); err != nil {
 136                 return err
 137         }
 138
 139         peer := newPeer(pc, peerNodeInfo, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError)
 140         if err := sw.filterConnByPeer(peer); err != nil {
 141                 return err
 142         }
 143
 144         // Start peer
 145         if sw.IsRunning() {
 146                 if err := sw.startInitPeer(peer); err != nil {
 147                         return err
 148                 }
 149         }
 150         return sw.peers.Add(peer)
 151 }
 152
 153 // AddReactor adds the given reactor to the switch.
 154 // NOTE: Not goroutine safe.
 155 func (sw *Switch) AddReactor(name string, reactor Reactor) Reactor {
 156         // Validate the reactor.
 157         // No two reactors can share the same channel.
 158         for _, chDesc := range reactor.GetChannels() {
 159                 chID := chDesc.ID
 160                 if sw.reactorsByCh[chID] != nil {
 161                         cmn.PanicSanity(fmt.Sprintf("Channel %X has multiple reactors %v & %v", chID, sw.reactorsByCh[chID], reactor))
 162                 }
 163                 sw.chDescs = append(sw.chDescs, chDesc)
 164                 sw.reactorsByCh[chID] = reactor
 165         }
 166         sw.reactors[name] = reactor
 167         reactor.SetSwitch(sw)
 168         return reactor
 169 }
 170
 171 // AddListener adds the given listener to the switch for listening to incoming peer connections.
 172 // NOTE: Not goroutine safe.
 173 func (sw *Switch) AddListener(l Listener) {
 174         sw.listeners = append(sw.listeners, l)
 175 }
 176
 177 //DialPeerWithAddress dial node from net address
 178 func (sw *Switch) DialPeerWithAddress(addr *NetAddress) error {
 179         log.Debug("Dialing peer address:", addr)
 180         sw.dialing.Set(addr.IP.String(), addr)
 181         defer sw.dialing.Delete(addr.IP.String())
 182         if err := sw.filterConnByIP(addr.IP.String()); err != nil {
 183                 return err
 184         }
 185
 186         pc, err := newOutboundPeerConn(addr, sw.nodePrivKey, sw.peerConfig)
 187         if err != nil {
 188                 log.WithFields(log.Fields{"address": addr, " err": err}).Debug("DialPeer fail on newOutboundPeerConn")
 189                 return err
 190         }
 191
 192         if err = sw.AddPeer(pc); err != nil {
 193                 log.WithFields(log.Fields{"address": addr, " err": err}).Debug("DialPeer fail on switch AddPeer")
 194                 pc.CloseConn()
 195                 return err
 196         }
 197         log.Debug("DialPeer added peer:", addr)
 198         return nil
 199 }
 200
 201 //IsDialing prevent duplicate dialing
 202 func (sw *Switch) IsDialing(addr *NetAddress) bool {
 203         return sw.dialing.Has(addr.IP.String())
 204 }
 205
 206 // IsListening returns true if the switch has at least one listener.
 207 // NOTE: Not goroutine safe.
 208 func (sw *Switch) IsListening() bool {
 209         return len(sw.listeners) > 0
 210 }
 211
 212 // Listeners returns the list of listeners the switch listens on.
 213 // NOTE: Not goroutine safe.
 214 func (sw *Switch) Listeners() []Listener {
 215         return sw.listeners
 216 }
 217
 218 // NumPeers Returns the count of outbound/inbound and outbound-dialing peers.
 219 func (sw *Switch) NumPeers() (outbound, inbound, dialing int) {
 220         peers := sw.peers.List()
 221         for _, peer := range peers {
 222                 if peer.outbound {
 223                         outbound++
 224                 } else {
 225                         inbound++
 226                 }
 227         }
 228         dialing = sw.dialing.Size()
 229         return
 230 }
 231
 232 // NodeInfo returns the switch's NodeInfo.
 233 // NOTE: Not goroutine safe.
 234 func (sw *Switch) NodeInfo() *NodeInfo {
 235         return sw.nodeInfo
 236 }
 237
 238 //Peers return switch peerset
 239 func (sw *Switch) Peers() *PeerSet {
 240         return sw.peers
 241 }
 242
 243 // SetNodeInfo sets the switch's NodeInfo for checking compatibility and handshaking with other nodes.
 244 // NOTE: Not goroutine safe.
 245 func (sw *Switch) SetNodeInfo(nodeInfo *NodeInfo) {
 246         sw.nodeInfo = nodeInfo
 247 }
 248
 249 // SetNodePrivKey sets the switch's private key for authenticated encryption.
 250 // NOTE: Not goroutine safe.
 251 func (sw *Switch) SetNodePrivKey(nodePrivKey crypto.PrivKeyEd25519) {
 252         sw.nodePrivKey = nodePrivKey
 253         if sw.nodeInfo != nil {
 254                 sw.nodeInfo.PubKey = nodePrivKey.PubKey().Unwrap().(crypto.PubKeyEd25519)
 255         }
 256 }
 257
 258 // StopPeerForError disconnects from a peer due to external error.
 259 func (sw *Switch) StopPeerForError(peer *Peer, reason interface{}) {
 260         log.WithFields(log.Fields{"peer": peer, " err": reason}).Debug("stopping peer for error")
 261         sw.stopAndRemovePeer(peer, reason)
 262 }
 263
 264 // StopPeerGracefully disconnect from a peer gracefully.
 265 func (sw *Switch) StopPeerGracefully(peerID string) {
 266         if peer := sw.peers.Get(peerID); peer != nil {
 267                 sw.stopAndRemovePeer(peer, nil)
 268         }
 269 }
 270
 271 func (sw *Switch) addPeerWithConnection(conn net.Conn) error {
 272         peerConn, err := newInboundPeerConn(conn, sw.nodePrivKey, sw.Config.P2P)
 273         if err != nil {
 274                 conn.Close()
 275                 return err
 276         }
 277
 278         if err = sw.AddPeer(peerConn); err != nil {
 279                 conn.Close()
 280                 return err
 281         }
 282         return nil
 283 }
 284
 285 func (sw *Switch) checkBannedPeer(peer string) error {
 286         sw.mtx.Lock()
 287         defer sw.mtx.Unlock()
 288
 289         if banEnd, ok := sw.bannedPeer[peer]; ok {
 290                 if time.Now().Before(banEnd) {
 291                         return ErrConnectBannedPeer
 292                 }
 293                 sw.delBannedPeer(peer)
 294         }
 295         return nil
 296 }
 297
 298 func (sw *Switch) delBannedPeer(addr string) error {
 299         sw.mtx.Lock()
 300         defer sw.mtx.Unlock()
 301
 302         delete(sw.bannedPeer, addr)
 303         datajson, err := json.Marshal(sw.bannedPeer)
 304         if err != nil {
 305                 return err
 306         }
 307
 308         sw.db.Set([]byte(bannedPeerKey), datajson)
 309         return nil
 310 }
 311
 312 func (sw *Switch) filterConnByIP(ip string) error {
 313         if ip == sw.nodeInfo.ListenHost() {
 314                 return ErrConnectSelf
 315         }
 316         return sw.checkBannedPeer(ip)
 317 }
 318
 319 func (sw *Switch) filterConnByPeer(peer *Peer) error {
 320         if err := sw.checkBannedPeer(peer.RemoteAddrHost()); err != nil {
 321                 return err
 322         }
 323
 324         if sw.nodeInfo.PubKey.Equals(peer.PubKey().Wrap()) {
 325                 return ErrConnectSelf
 326         }
 327
 328         if sw.peers.Has(peer.Key) {
 329                 return ErrDuplicatePeer
 330         }
 331         return nil
 332 }
 333
 334 func (sw *Switch) listenerRoutine(l Listener) {
 335         for {
 336                 inConn, ok := <-l.Connections()
 337                 if !ok {
 338                         break
 339                 }
 340
 341                 // disconnect if we alrady have 2 * MaxNumPeers, we do this because we wanna address book get exchanged even if
 342                 // the connect is full. The pex will disconnect the peer after address exchange, the max connected peer won't
 343                 // be double of MaxNumPeers
 344                 if sw.peers.Size() >= sw.Config.P2P.MaxNumPeers*2 {
 345                         inConn.Close()
 346                         log.Info("Ignoring inbound connection: already have enough peers.")
 347                         continue
 348                 }
 349
 350                 // New inbound connection!
 351                 if err := sw.addPeerWithConnection(inConn); err != nil {
 352                         log.Info("Ignoring inbound connection: error while adding peer.", " address:", inConn.RemoteAddr().String(), " error:", err)
 353                         continue
 354                 }
 355         }
 356 }
 357
 358 func (sw *Switch) startInitPeer(peer *Peer) error {
 359         peer.Start() // spawn send/recv routines
 360         for _, reactor := range sw.reactors {
 361                 if err := reactor.AddPeer(peer); err != nil {
 362                         return err
 363                 }
 364         }
 365         return nil
 366 }
 367
 368 func (sw *Switch) stopAndRemovePeer(peer *Peer, reason interface{}) {
 369         sw.peers.Remove(peer)
 370         for _, reactor := range sw.reactors {
 371                 reactor.RemovePeer(peer, reason)
 372         }
 373         peer.Stop()
 374 }