p2p/listener.go

   1 package p2p
   2
   3 import (
   4         "fmt"
   5         "net"
   6         "strconv"
   7         "time"
   8
   9         "github.com/bytom/p2p/upnp"
  10         log "github.com/sirupsen/logrus"
  11         cmn "github.com/tendermint/tmlibs/common"
  12 )
  13
  14 //Listener subset of the methods of DefaultListener
  15 type Listener interface {
  16         Connections() <-chan net.Conn
  17         InternalAddress() *NetAddress
  18         ExternalAddress() *NetAddress
  19         String() string
  20         Stop() bool
  21 }
  22
  23 //DefaultListener Implements bytomd server Listener
  24 type DefaultListener struct {
  25         cmn.BaseService
  26
  27         listener    net.Listener
  28         intAddr     *NetAddress
  29         extAddr     *NetAddress
  30         connections chan net.Conn
  31 }
  32
  33 const (
  34         numBufferedConnections = 10
  35         defaultExternalPort    = 8770
  36         tryListenSeconds       = 5
  37 )
  38
  39 func splitHostPort(addr string) (host string, port int) {
  40         host, portStr, err := net.SplitHostPort(addr)
  41         if err != nil {
  42                 cmn.PanicSanity(err)
  43         }
  44         port, err = strconv.Atoi(portStr)
  45         if err != nil {
  46                 cmn.PanicSanity(err)
  47         }
  48         return host, port
  49 }
  50
  51 //NewDefaultListener create a default listener
  52 func NewDefaultListener(protocol string, lAddr string, skipUPNP bool) (Listener, bool) {
  53         // Local listen IP & port
  54         lAddrIP, lAddrPort := splitHostPort(lAddr)
  55
  56         // Create listener
  57         var listener net.Listener
  58         var err error
  59         var getExtIP = false
  60         var listenerStatus = false
  61
  62         for i := 0; i < tryListenSeconds; i++ {
  63                 listener, err = net.Listen(protocol, lAddr)
  64                 if err == nil {
  65                         break
  66                 } else if i < tryListenSeconds-1 {
  67                         time.Sleep(time.Second * 1)
  68                 }
  69         }
  70         if err != nil {
  71                 cmn.PanicCrisis(err)
  72         }
  73         // Actual listener local IP & port
  74         listenerIP, listenerPort := splitHostPort(listener.Addr().String())
  75         log.Info("Local listener", " ip:", listenerIP, " port:", listenerPort)
  76
  77         // Determine internal address...
  78         var intAddr *NetAddress
  79         intAddr, err = NewNetAddressString(lAddr)
  80         if err != nil {
  81                 cmn.PanicCrisis(err)
  82         }
  83
  84         // Determine external address...
  85         var extAddr *NetAddress
  86         //skipUPNP: If true, does not try getUPNPExternalAddress()
  87         if !skipUPNP {
  88                 // If the lAddrIP is INADDR_ANY, try UPnP
  89                 if lAddrIP == "" || lAddrIP == "0.0.0.0" {
  90                         extAddr = getUPNPExternalAddress(lAddrPort, listenerPort)
  91                         if extAddr != nil {
  92                                 getExtIP = true
  93                                 listenerStatus = true
  94                         }
  95                 }
  96         }
  97         if extAddr == nil {
  98                 if address := GetIP(); address.Success == true {
  99                         extAddr = NewNetAddressIPPort(net.ParseIP(address.Ip), uint16(lAddrPort))
 100                         getExtIP = true
 101                 }
 102         }
 103         // Otherwise just use the local address...
 104         if extAddr == nil {
 105                 extAddr = getNaiveExternalAddress(listenerPort, false)
 106         }
 107         if extAddr == nil {
 108                 cmn.PanicCrisis("Could not determine external address!")
 109         }
 110
 111         dl := &DefaultListener{
 112                 listener:    listener,
 113                 intAddr:     intAddr,
 114                 extAddr:     extAddr,
 115                 connections: make(chan net.Conn, numBufferedConnections),
 116         }
 117         dl.BaseService = *cmn.NewBaseService(nil, "DefaultListener", dl)
 118         dl.Start() // Started upon construction
 119
 120         if !listenerStatus && getExtIP {
 121                 conn, err := net.DialTimeout("tcp", extAddr.String(), 3*time.Second)
 122
 123                 if err != nil && conn == nil {
 124                         log.Error("Could not open listen port")
 125                 }
 126
 127                 if err == nil && conn != nil {
 128                         log.Info("Success open listen port")
 129                         listenerStatus = true
 130                         conn.Close()
 131                 }
 132         }
 133
 134         return dl, listenerStatus
 135 }
 136
 137 //OnStart start listener
 138 func (l *DefaultListener) OnStart() error {
 139         l.BaseService.OnStart()
 140         go l.listenRoutine()
 141         return nil
 142 }
 143
 144 //OnStop stop listener
 145 func (l *DefaultListener) OnStop() {
 146         l.BaseService.OnStop()
 147         l.listener.Close()
 148 }
 149
 150 //listenRoutine Accept connections and pass on the channel
 151 func (l *DefaultListener) listenRoutine() {
 152         for {
 153                 conn, err := l.listener.Accept()
 154
 155                 if !l.IsRunning() {
 156                         break // Go to cleanup
 157                 }
 158
 159                 // listener wasn't stopped,
 160                 // yet we encountered an error.
 161                 if err != nil {
 162                         cmn.PanicCrisis(err)
 163                 }
 164
 165                 l.connections <- conn
 166         }
 167
 168         // Cleanup
 169         close(l.connections)
 170 }
 171
 172 //Connections a channel of inbound connections. It gets closed when the listener closes.
 173 func (l *DefaultListener) Connections() <-chan net.Conn {
 174         return l.connections
 175 }
 176
 177 //InternalAddress listener internal address
 178 func (l *DefaultListener) InternalAddress() *NetAddress {
 179         return l.intAddr
 180 }
 181
 182 //ExternalAddress listener external address for remote peer dial
 183 func (l *DefaultListener) ExternalAddress() *NetAddress {
 184         return l.extAddr
 185 }
 186
 187 // NetListener the returned listener is already Accept()'ing. So it's not suitable to pass into http.Serve().
 188 func (l *DefaultListener) NetListener() net.Listener {
 189         return l.listener
 190 }
 191
 192 //String string of default listener
 193 func (l *DefaultListener) String() string {
 194         return fmt.Sprintf("Listener(@%v)", l.extAddr)
 195 }
 196
 197 //getUPNPExternalAddress UPNP external address discovery & port mapping
 198 func getUPNPExternalAddress(externalPort, internalPort int) *NetAddress {
 199         log.Info("Getting UPNP external address")
 200         nat, err := upnp.Discover()
 201         if err != nil {
 202                 log.Info("Could not perform UPNP discover. error:", err)
 203                 return nil
 204         }
 205
 206         ext, err := nat.GetExternalAddress()
 207         if err != nil {
 208                 log.Info("Could not perform UPNP external address. error:", err)
 209                 return nil
 210         }
 211
 212         // UPnP can't seem to get the external port, so let's just be explicit.
 213         if externalPort == 0 {
 214                 externalPort = defaultExternalPort
 215         }
 216
 217         externalPort, err = nat.AddPortMapping("tcp", externalPort, internalPort, "bytomd", 0)
 218         if err != nil {
 219                 log.Info("Could not add UPNP port mapping. error:", err)
 220                 return nil
 221         }
 222
 223         log.Info("Got UPNP external address ", ext)
 224         return NewNetAddressIPPort(ext, uint16(externalPort))
 225 }
 226
 227 func getNaiveExternalAddress(port int, settleForLocal bool) *NetAddress {
 228         addrs, err := net.InterfaceAddrs()
 229         if err != nil {
 230                 cmn.PanicCrisis(cmn.Fmt("Could not fetch interface addresses: %v", err))
 231         }
 232
 233         for _, a := range addrs {
 234                 ipnet, ok := a.(*net.IPNet)
 235                 if !ok {
 236                         continue
 237                 }
 238                 v4 := ipnet.IP.To4()
 239                 if v4 == nil || (!settleForLocal && v4[0] == 127) {
 240                         continue
 241                 } // loopback
 242                 return NewNetAddressIPPort(ipnet.IP, uint16(port))
 243         }
 244
 245         // try again, but settle for local
 246         log.Info("Node may not be connected to internet. Settling for local address")
 247         return getNaiveExternalAddress(port, true)
 248 }