pex.go

   1 package torrent
   2
   3 import (
   4         "net"
   5
   6         "github.com/anacrolix/dht/v2/krpc"
   7         pp "github.com/anacrolix/torrent/peer_protocol"
   8 )
   9
  10 type pexEventType int
  11
  12 const (
  13         pexAdd pexEventType = iota
  14         pexDrop
  15 )
  16
  17 // internal, based on BEP11
  18 const (
  19         pexTargAdded = 25 // put drops on hold when the number of alive connections is lower than this
  20         pexMaxHold   = 25 // length of the drop hold-back buffer
  21         pexMaxDelta  = 50 // upper bound on added+added6 and dropped+dropped6 in a single PEX message
  22 )
  23
  24 // represents a single connection (t=pexAdd) or disconnection (t=pexDrop) event
  25 type pexEvent struct {
  26         t    pexEventType
  27         addr net.Addr
  28         f    pp.PexPeerFlags
  29 }
  30
  31 // Combines the node addr, as required for pp.PexMsg.
  32 type pexMsgAdded struct {
  33         krpc.NodeAddr
  34         pp.PexPeerFlags
  35 }
  36
  37 // Makes generating a PexMsg more efficient.
  38 type pexMsgFactory struct {
  39         added   map[string]pexMsgAdded
  40         dropped map[string]krpc.NodeAddr
  41 }
  42
  43 func (me *pexMsgFactory) DeltaLen() int {
  44         return int(max(
  45                 int64(len(me.added)),
  46                 int64(len(me.dropped))))
  47 }
  48
  49 // Returns the key to use to identify a given addr in the factory. Panics if we can't support the
  50 // addr later in generating a PexMsg (since adding an unusable addr will cause DeltaLen to be out.)
  51 func (me *pexMsgFactory) addrKey(addr krpc.NodeAddr) string {
  52         if addr.IP.To4() != nil {
  53                 addr.IP = addr.IP.To4()
  54         }
  55         keyBytes, err := addr.MarshalBinary()
  56         if err != nil {
  57                 panic(err)
  58         }
  59         switch len(keyBytes) {
  60         case compactIpv4NodeAddrElemSize:
  61         case compactIpv6NodeAddrElemSize:
  62         default:
  63                 panic(len(keyBytes))
  64         }
  65         return string(keyBytes)
  66 }
  67
  68 // Returns whether the entry was added (we can check if we're cancelling out another entry and so
  69 // won't hit the limit consuming this event).
  70 func (me *pexMsgFactory) Add(addr krpc.NodeAddr, flags pp.PexPeerFlags) {
  71         key := me.addrKey(addr)
  72         if _, ok := me.dropped[key]; ok {
  73                 delete(me.dropped, key)
  74                 return
  75         }
  76         if me.added == nil {
  77                 me.added = make(map[string]pexMsgAdded, pexMaxDelta)
  78         }
  79         me.added[key] = pexMsgAdded{addr, flags}
  80
  81 }
  82
  83 // Returns whether the entry was added (we can check if we're cancelling out another entry and so
  84 // won't hit the limit consuming this event).
  85 func (me *pexMsgFactory) Drop(addr krpc.NodeAddr) {
  86         key := me.addrKey(addr)
  87         if _, ok := me.added[key]; ok {
  88                 delete(me.added, key)
  89                 return
  90         }
  91         if me.dropped == nil {
  92                 me.dropped = make(map[string]krpc.NodeAddr, pexMaxDelta)
  93         }
  94         me.dropped[key] = addr
  95 }
  96
  97 func (me *pexMsgFactory) addEvent(event pexEvent) {
  98         addr, ok := nodeAddr(event.addr)
  99         if !ok {
 100                 return
 101         }
 102         switch event.t {
 103         case pexAdd:
 104                 me.Add(addr, event.f)
 105         case pexDrop:
 106                 me.Drop(addr)
 107         default:
 108                 panic(event.t)
 109         }
 110 }
 111
 112 var compactIpv4NodeAddrElemSize = krpc.CompactIPv4NodeAddrs{}.ElemSize()
 113 var compactIpv6NodeAddrElemSize = krpc.CompactIPv6NodeAddrs{}.ElemSize()
 114
 115 func (me *pexMsgFactory) PexMsg() (ret pp.PexMsg) {
 116         for key, added := range me.added {
 117                 switch len(key) {
 118                 case compactIpv4NodeAddrElemSize:
 119                         ret.Added = append(ret.Added, added.NodeAddr)
 120                         ret.AddedFlags = append(ret.AddedFlags, added.PexPeerFlags)
 121                 case compactIpv6NodeAddrElemSize:
 122                         ret.Added6 = append(ret.Added6, added.NodeAddr)
 123                         ret.Added6Flags = append(ret.Added6Flags, added.PexPeerFlags)
 124                 default:
 125                         panic(key)
 126                 }
 127         }
 128         for key, addr := range me.dropped {
 129                 switch len(key) {
 130                 case compactIpv4NodeAddrElemSize:
 131                         ret.Dropped = append(ret.Dropped, addr)
 132                 case compactIpv6NodeAddrElemSize:
 133                         ret.Dropped6 = append(ret.Dropped6, addr)
 134                 default:
 135                         panic(key)
 136                 }
 137         }
 138         return
 139 }
 140
 141 func mustNodeAddr(addr net.Addr) krpc.NodeAddr {
 142         ret, ok := nodeAddr(addr)
 143         if !ok {
 144                 panic(addr)
 145         }
 146         return ret
 147 }
 148
 149 // Convert an arbitrary torrent peer Addr into one that can be represented by the compact addr
 150 // format.
 151 func nodeAddr(addr net.Addr) (_ krpc.NodeAddr, ok bool) {
 152         ipport, ok := tryIpPortFromNetAddr(addr)
 153         if !ok {
 154                 return
 155         }
 156         return krpc.NodeAddr{IP: shortestIP(ipport.IP), Port: ipport.Port}, true
 157 }
 158
 159 // mainly for the krpc marshallers
 160 func shortestIP(ip net.IP) net.IP {
 161         if ip4 := ip.To4(); ip4 != nil {
 162                 return ip4
 163         }
 164         return ip
 165 }
 166
 167 // Per-torrent PEX state
 168 type pexState struct {
 169         ev   []pexEvent // event feed, append-only
 170         hold []pexEvent // delayed drops
 171         nc   int        // net number of alive conns
 172 }
 173
 174 func (s *pexState) Reset() {
 175         s.ev = nil
 176         s.hold = nil
 177         s.nc = 0
 178 }
 179
 180 func (s *pexState) Add(c *PeerConn) {
 181         s.nc++
 182         if s.nc >= pexTargAdded {
 183                 s.ev = append(s.ev, s.hold...)
 184                 s.hold = s.hold[:0]
 185         }
 186         e := c.pexEvent(pexAdd)
 187         s.ev = append(s.ev, e)
 188         c.pex.Listed = true
 189 }
 190
 191 func (s *pexState) Drop(c *PeerConn) {
 192         if !c.pex.Listed {
 193                 // skip connections which were not previously Added
 194                 return
 195         }
 196         e := c.pexEvent(pexDrop)
 197         s.nc--
 198         if s.nc < pexTargAdded && len(s.hold) < pexMaxHold {
 199                 s.hold = append(s.hold, e)
 200         } else {
 201                 s.ev = append(s.ev, e)
 202         }
 203 }
 204
 205 // Generate a PEX message based on the event feed. Also returns an index to pass to the subsequent
 206 // calls, producing incremental deltas.
 207 func (s *pexState) Genmsg(start int) (pp.PexMsg, int) {
 208         var factory pexMsgFactory
 209         n := start
 210         for _, e := range s.ev[start:] {
 211                 if start > 0 && factory.DeltaLen() >= pexMaxDelta {
 212                         break
 213                 }
 214                 factory.addEvent(e)
 215                 n++
 216         }
 217         return factory.PexMsg(), n
 218 }