12 log "github.com/sirupsen/logrus"
13 "github.com/tendermint/go-crypto"
14 cmn "github.com/tendermint/tmlibs/common"
16 cfg "github.com/vapor/config"
17 "github.com/vapor/consensus"
18 "github.com/vapor/crypto/ed25519"
19 "github.com/vapor/crypto/sha3pool"
20 dbm "github.com/vapor/database/leveldb"
21 "github.com/vapor/errors"
22 "github.com/vapor/event"
23 "github.com/vapor/p2p/connection"
24 "github.com/vapor/p2p/discover/dht"
25 "github.com/vapor/p2p/discover/mdns"
26 "github.com/vapor/p2p/netutil"
27 "github.com/vapor/p2p/trust"
28 "github.com/vapor/version"
32 bannedPeerKey = "BannedPeer"
33 defaultBanDuration = time.Hour * 1
36 minNumOutboundPeers = 4
38 //magicNumber used to generate unique netID
39 magicNumber = uint64(0x054c5638)
42 //pre-define errors for connecting fail
44 ErrDuplicatePeer = errors.New("Duplicate peer")
45 ErrConnectSelf = errors.New("Connect self")
46 ErrConnectBannedPeer = errors.New("Connect banned peer")
47 ErrConnectSpvPeer = errors.New("Outbound connect spv peer")
50 type discv interface {
51 ReadRandomNodes(buf []*dht.Node) (n int)
54 type lanDiscv interface {
55 Subscribe() (*event.Subscription, error)
59 // Switch handles peer connections and exposes an API to receive incoming messages
60 // on `Reactors`. Each `Reactor` is responsible for handling incoming messages of one
61 // or more `Channels`. So while sending outgoing messages is typically performed on the peer,
62 // incoming messages are received on the reactor.
67 peerConfig *PeerConfig
69 reactors map[string]Reactor
70 chDescs []*connection.ChannelDescriptor
71 reactorsByCh map[byte]Reactor
74 nodeInfo *NodeInfo // our node info
75 nodePrivKey crypto.PrivKeyEd25519 // our node privkey
78 bannedPeer map[string]time.Time
83 // NewSwitch create a new Switch and set discover.
84 func NewSwitch(config *cfg.Config) (*Switch, error) {
88 var discv *dht.Network
89 var lanDiscv *mdns.LANDiscover
91 //generate unique netID
94 data = append(data, cfg.GenesisBlock().Hash().Bytes()...)
95 magic := make([]byte, 8)
96 binary.BigEndian.PutUint64(magic, magicNumber)
97 data = append(data, magic[:]...)
98 sha3pool.Sum256(h[:], data)
99 netID := binary.BigEndian.Uint64(h[:8])
101 blacklistDB := dbm.NewDB("trusthistory", config.DBBackend, config.DBDir())
102 config.P2P.PrivateKey, err = config.NodeKey()
107 bytes, err := hex.DecodeString(config.P2P.PrivateKey)
113 copy(newKey[:], bytes)
114 privKey := crypto.PrivKeyEd25519(newKey)
115 if !config.VaultMode {
117 l, listenAddr = GetListener(config.P2P)
118 discv, err = dht.NewDiscover(config, ed25519.PrivateKey(bytes), l.ExternalAddress().Port, netID)
122 if config.P2P.LANDiscover {
123 lanDiscv = mdns.NewLANDiscover(mdns.NewProtocol(), int(l.ExternalAddress().Port))
127 return newSwitch(config, discv, lanDiscv, blacklistDB, l, privKey, listenAddr, netID)
130 // newSwitch creates a new Switch with the given config.
131 func newSwitch(config *cfg.Config, discv discv, lanDiscv lanDiscv, blacklistDB dbm.DB, l Listener, priv crypto.PrivKeyEd25519, listenAddr string, netID uint64) (*Switch, error) {
134 peerConfig: DefaultPeerConfig(config.P2P),
135 reactors: make(map[string]Reactor),
136 chDescs: make([]*connection.ChannelDescriptor, 0),
137 reactorsByCh: make(map[byte]Reactor),
139 dialing: cmn.NewCMap(),
144 nodeInfo: NewNodeInfo(config, priv.PubKey().Unwrap().(crypto.PubKeyEd25519), listenAddr, netID),
145 bannedPeer: make(map[string]time.Time),
147 if err := sw.loadBannedPeers(); err != nil {
152 sw.BaseService = *cmn.NewBaseService(nil, "P2P Switch", sw)
157 // OnStart implements BaseService. It starts all the reactors, peers, and listeners.
158 func (sw *Switch) OnStart() error {
159 for _, reactor := range sw.reactors {
160 if _, err := reactor.Start(); err != nil {
164 for _, listener := range sw.listeners {
165 go sw.listenerRoutine(listener)
167 go sw.ensureOutboundPeersRoutine()
168 go sw.connectLANPeersRoutine()
173 // OnStop implements BaseService. It stops all listeners, peers, and reactors.
174 func (sw *Switch) OnStop() {
175 if sw.Config.P2P.LANDiscover {
179 for _, listener := range sw.listeners {
184 for _, peer := range sw.peers.List() {
186 sw.peers.Remove(peer)
189 for _, reactor := range sw.reactors {
194 //AddBannedPeer add peer to blacklist
195 func (sw *Switch) AddBannedPeer(ip string) error {
197 defer sw.mtx.Unlock()
199 sw.bannedPeer[ip] = time.Now().Add(defaultBanDuration)
200 dataJSON, err := json.Marshal(sw.bannedPeer)
205 sw.db.Set([]byte(bannedPeerKey), dataJSON)
209 // AddPeer performs the P2P handshake with a peer
210 // that already has a SecretConnection. If all goes well,
211 // it starts the peer and adds it to the switch.
212 // NOTE: This performs a blocking handshake before the peer is added.
213 // CONTRACT: If error is returned, peer is nil, and conn is immediately closed.
214 func (sw *Switch) AddPeer(pc *peerConn, isLAN bool) error {
215 peerNodeInfo, err := pc.HandshakeTimeout(sw.nodeInfo, sw.peerConfig.HandshakeTimeout)
220 if err := version.Status.CheckUpdate(sw.nodeInfo.Version, peerNodeInfo.Version, peerNodeInfo.RemoteAddr); err != nil {
223 if err := sw.nodeInfo.CompatibleWith(peerNodeInfo); err != nil {
227 peer := newPeer(pc, peerNodeInfo, sw.reactorsByCh, sw.chDescs, sw.StopPeerForError, isLAN)
228 if err := sw.filterConnByPeer(peer); err != nil {
232 if pc.outbound && !peer.ServiceFlag().IsEnable(consensus.SFFullNode) {
233 return ErrConnectSpvPeer
238 if err := sw.startInitPeer(peer); err != nil {
243 return sw.peers.Add(peer)
246 // AddReactor adds the given reactor to the switch.
247 // NOTE: Not goroutine safe.
248 func (sw *Switch) AddReactor(name string, reactor Reactor) Reactor {
249 // Validate the reactor.
250 // No two reactors can share the same channel.
251 for _, chDesc := range reactor.GetChannels() {
253 if sw.reactorsByCh[chID] != nil {
254 cmn.PanicSanity(fmt.Sprintf("Channel %X has multiple reactors %v & %v", chID, sw.reactorsByCh[chID], reactor))
256 sw.chDescs = append(sw.chDescs, chDesc)
257 sw.reactorsByCh[chID] = reactor
259 sw.reactors[name] = reactor
260 reactor.SetSwitch(sw)
264 // AddListener adds the given listener to the switch for listening to incoming peer connections.
265 // NOTE: Not goroutine safe.
266 func (sw *Switch) AddListener(l Listener) {
267 sw.listeners = append(sw.listeners, l)
270 //DialPeerWithAddress dial node from net address
271 func (sw *Switch) DialPeerWithAddress(addr *NetAddress) error {
272 log.WithFields(log.Fields{"module": logModule, "address": addr}).Debug("Dialing peer")
273 sw.dialing.Set(addr.IP.String(), addr)
274 defer sw.dialing.Delete(addr.IP.String())
275 if err := sw.filterConnByIP(addr.IP.String()); err != nil {
279 pc, err := newOutboundPeerConn(addr, sw.nodePrivKey, sw.peerConfig)
281 log.WithFields(log.Fields{"module": logModule, "address": addr, " err": err}).Error("DialPeer fail on newOutboundPeerConn")
285 if err = sw.AddPeer(pc, addr.isLAN); err != nil {
286 log.WithFields(log.Fields{"module": logModule, "address": addr, " err": err}).Error("DialPeer fail on switch AddPeer")
290 log.WithFields(log.Fields{"module": logModule, "address": addr, "peer num": sw.peers.Size()}).Debug("DialPeer added peer")
294 //IsDialing prevent duplicate dialing
295 func (sw *Switch) IsDialing(addr *NetAddress) bool {
296 return sw.dialing.Has(addr.IP.String())
299 // IsListening returns true if the switch has at least one listener.
300 // NOTE: Not goroutine safe.
301 func (sw *Switch) IsListening() bool {
302 return len(sw.listeners) > 0
305 // loadBannedPeers load banned peers from db
306 func (sw *Switch) loadBannedPeers() error {
307 if dataJSON := sw.db.Get([]byte(bannedPeerKey)); dataJSON != nil {
308 if err := json.Unmarshal(dataJSON, &sw.bannedPeer); err != nil {
316 // Listeners returns the list of listeners the switch listens on.
317 // NOTE: Not goroutine safe.
318 func (sw *Switch) Listeners() []Listener {
322 // NumPeers Returns the count of outbound/inbound and outbound-dialing peers.
323 func (sw *Switch) NumPeers() (lan, outbound, inbound, dialing int) {
324 peers := sw.peers.List()
325 for _, peer := range peers {
326 if peer.outbound && !peer.isLAN {
335 dialing = sw.dialing.Size()
339 // NodeInfo returns the switch's NodeInfo.
340 // NOTE: Not goroutine safe.
341 func (sw *Switch) NodeInfo() *NodeInfo {
345 //Peers return switch peerset
346 func (sw *Switch) Peers() *PeerSet {
350 // StopPeerForError disconnects from a peer due to external error.
351 func (sw *Switch) StopPeerForError(peer *Peer, reason interface{}) {
352 log.WithFields(log.Fields{"module": logModule, "peer": peer, " err": reason}).Debug("stopping peer for error")
353 sw.stopAndRemovePeer(peer, reason)
356 // StopPeerGracefully disconnect from a peer gracefully.
357 func (sw *Switch) StopPeerGracefully(peerID string) {
358 if peer := sw.peers.Get(peerID); peer != nil {
359 sw.stopAndRemovePeer(peer, nil)
363 func (sw *Switch) addPeerWithConnection(conn net.Conn) error {
364 peerConn, err := newInboundPeerConn(conn, sw.nodePrivKey, sw.Config.P2P)
366 if err := conn.Close(); err != nil {
367 log.WithFields(log.Fields{"module": logModule, "remote peer:": conn.RemoteAddr().String(), " err:": err}).Error("closes connection err")
372 if err = sw.AddPeer(peerConn, false); err != nil {
373 if err := conn.Close(); err != nil {
374 log.WithFields(log.Fields{"module": logModule, "remote peer:": conn.RemoteAddr().String(), " err:": err}).Error("closes connection err")
379 log.WithFields(log.Fields{"module": logModule, "address": conn.RemoteAddr().String(), "peer num": sw.peers.Size()}).Debug("add inbound peer")
383 func (sw *Switch) checkBannedPeer(peer string) error {
385 defer sw.mtx.Unlock()
387 if banEnd, ok := sw.bannedPeer[peer]; ok {
388 if time.Now().Before(banEnd) {
389 return ErrConnectBannedPeer
392 if err := sw.delBannedPeer(peer); err != nil {
399 func (sw *Switch) connectLANPeers(lanPeer mdns.LANPeerEvent) {
400 lanPeers, _, _, numDialing := sw.NumPeers()
401 numToDial := maxNumLANPeers - lanPeers
402 log.WithFields(log.Fields{"module": logModule, "numDialing": numDialing, "numToDial": numToDial}).Debug("connect LAN peers")
406 addresses := make([]*NetAddress, 0)
407 for i := 0; i < len(lanPeer.IP); i++ {
408 addresses = append(addresses, NewLANNetAddressIPPort(lanPeer.IP[i], uint16(lanPeer.Port)))
410 sw.dialPeers(addresses)
413 func (sw *Switch) connectLANPeersRoutine() {
414 if !sw.Config.P2P.LANDiscover {
418 lanPeerEventSub, err := sw.lanDiscv.Subscribe()
420 log.WithFields(log.Fields{"module": logModule, "err": err}).Warning("subscribe LAN Peer Event error")
426 case obj, ok := <-lanPeerEventSub.Chan():
428 log.WithFields(log.Fields{"module": logModule}).Warning("LAN peer event subscription channel closed")
431 LANPeer, ok := obj.Data.(mdns.LANPeerEvent)
433 log.WithFields(log.Fields{"module": logModule}).Error("event type error")
436 sw.connectLANPeers(LANPeer)
443 func (sw *Switch) delBannedPeer(addr string) error {
445 defer sw.mtx.Unlock()
447 delete(sw.bannedPeer, addr)
448 datajson, err := json.Marshal(sw.bannedPeer)
453 sw.db.Set([]byte(bannedPeerKey), datajson)
457 func (sw *Switch) filterConnByIP(ip string) error {
458 if ip == sw.nodeInfo.listenHost() {
459 return ErrConnectSelf
461 return sw.checkBannedPeer(ip)
464 func (sw *Switch) filterConnByPeer(peer *Peer) error {
465 if err := sw.checkBannedPeer(peer.remoteAddrHost()); err != nil {
469 if sw.nodeInfo.getPubkey().Equals(peer.PubKey().Wrap()) {
470 return ErrConnectSelf
473 if sw.peers.Has(peer.Key) {
474 return ErrDuplicatePeer
479 func (sw *Switch) listenerRoutine(l Listener) {
481 inConn, ok := <-l.Connections()
486 // disconnect if we alrady have MaxNumPeers
487 if sw.peers.Size() >= sw.Config.P2P.MaxNumPeers {
488 if err := inConn.Close(); err != nil {
489 log.WithFields(log.Fields{"module": logModule, "remote peer:": inConn.RemoteAddr().String(), " err:": err}).Error("closes connection err")
491 log.Info("Ignoring inbound connection: already have enough peers.")
495 // New inbound connection!
496 if err := sw.addPeerWithConnection(inConn); err != nil {
497 log.Info("Ignoring inbound connection: error while adding peer.", " address:", inConn.RemoteAddr().String(), " error:", err)
503 func (sw *Switch) dialPeerWorker(a *NetAddress, wg *sync.WaitGroup) {
504 if err := sw.DialPeerWithAddress(a); err != nil {
505 log.WithFields(log.Fields{"module": logModule, "addr": a, "err": err}).Error("dialPeerWorker fail on dial peer")
510 func (sw *Switch) dialPeers(addresses []*NetAddress) {
511 connectedPeers := make(map[string]struct{})
512 for _, peer := range sw.Peers().List() {
513 connectedPeers[peer.remoteAddrHost()] = struct{}{}
516 var wg sync.WaitGroup
517 for _, address := range addresses {
518 if sw.NodeInfo().ListenAddr == address.String() {
521 if dialling := sw.IsDialing(address); dialling {
524 if _, ok := connectedPeers[address.IP.String()]; ok {
529 go sw.dialPeerWorker(address, &wg)
534 func (sw *Switch) ensureKeepConnectPeers() {
535 keepDials := netutil.CheckAndSplitAddresses(sw.Config.P2P.KeepDial)
536 addresses := make([]*NetAddress, 0)
537 for _, keepDial := range keepDials {
538 address, err := NewNetAddressString(keepDial)
540 log.WithFields(log.Fields{"module": logModule, "err": err, "address": keepDial}).Warn("parse address to NetAddress")
543 addresses = append(addresses, address)
546 sw.dialPeers(addresses)
549 func (sw *Switch) ensureOutboundPeers() {
550 lanPeers, numOutPeers, _, numDialing := sw.NumPeers()
551 numToDial := minNumOutboundPeers - (numOutPeers + numDialing)
552 log.WithFields(log.Fields{"module": logModule, "numOutPeers": numOutPeers, "LANPeers": lanPeers, "numDialing": numDialing, "numToDial": numToDial}).Debug("ensure peers")
557 nodes := make([]*dht.Node, numToDial)
558 n := sw.discv.ReadRandomNodes(nodes)
559 addresses := make([]*NetAddress, 0)
560 for i := 0; i < n; i++ {
561 address := NewNetAddressIPPort(nodes[i].IP, nodes[i].TCP)
562 addresses = append(addresses, address)
564 sw.dialPeers(addresses)
567 func (sw *Switch) ensureOutboundPeersRoutine() {
568 sw.ensureKeepConnectPeers()
569 sw.ensureOutboundPeers()
571 ticker := time.NewTicker(10 * time.Second)
577 sw.ensureKeepConnectPeers()
578 sw.ensureOutboundPeers()
585 func (sw *Switch) startInitPeer(peer *Peer) error {
586 // spawn send/recv routines
587 if _, err := peer.Start(); err != nil {
588 log.WithFields(log.Fields{"module": logModule, "remote peer:": peer.RemoteAddr, " err:": err}).Error("init peer err")
591 for _, reactor := range sw.reactors {
592 if err := reactor.AddPeer(peer); err != nil {
599 func (sw *Switch) stopAndRemovePeer(peer *Peer, reason interface{}) {
600 sw.peers.Remove(peer)
601 for _, reactor := range sw.reactors {
602 reactor.RemovePeer(peer, reason)
606 sentStatus, receivedStatus := peer.TrafficStatus()
607 log.WithFields(log.Fields{
609 "address": peer.Addr().String(),
611 "duration": sentStatus.Duration.String(),
612 "total_sent": sentStatus.Bytes,
613 "total_received": receivedStatus.Bytes,
614 "average_sent_rate": sentStatus.AvgRate,
615 "average_received_rate": receivedStatus.AvgRate,
616 "peer num": sw.peers.Size(),
617 }).Info("disconnect with peer")