peerconn.go

   1 package torrent
   2
   3 import (
   4         "bufio"
   5         "bytes"
   6         "errors"
   7         "fmt"
   8         "io"
   9         "math/rand"
  10         "net"
  11         "sort"
  12         "strconv"
  13         "strings"
  14         "time"
  15
  16         "github.com/RoaringBitmap/roaring"
  17         "github.com/anacrolix/log"
  18         "github.com/anacrolix/missinggo/iter"
  19         "github.com/anacrolix/missinggo/v2/bitmap"
  20         "github.com/anacrolix/multiless"
  21
  22         "github.com/anacrolix/chansync"
  23         "github.com/anacrolix/torrent/bencode"
  24         "github.com/anacrolix/torrent/metainfo"
  25         "github.com/anacrolix/torrent/mse"
  26         pp "github.com/anacrolix/torrent/peer_protocol"
  27         request_strategy "github.com/anacrolix/torrent/request-strategy"
  28 )
  29
  30 type PeerSource string
  31
  32 const (
  33         PeerSourceTracker         = "Tr"
  34         PeerSourceIncoming        = "I"
  35         PeerSourceDhtGetPeers     = "Hg" // Peers we found by searching a DHT.
  36         PeerSourceDhtAnnouncePeer = "Ha" // Peers that were announced to us by a DHT.
  37         PeerSourcePex             = "X"
  38         // The peer was given directly, such as through a magnet link.
  39         PeerSourceDirect = "M"
  40 )
  41
  42 type peerRequestState struct {
  43         data []byte
  44 }
  45
  46 type PeerRemoteAddr interface {
  47         String() string
  48 }
  49
  50 // Since we have to store all the requests in memory, we can't reasonably exceed what would be
  51 // indexable with the memory space available.
  52 type (
  53         maxRequests  = int
  54         requestState = request_strategy.PeerNextRequestState
  55 )
  56
  57 type Peer struct {
  58         // First to ensure 64-bit alignment for atomics. See #262.
  59         _stats ConnStats
  60
  61         t *Torrent
  62
  63         peerImpl
  64         callbacks *Callbacks
  65
  66         outgoing   bool
  67         Network    string
  68         RemoteAddr PeerRemoteAddr
  69         // True if the connection is operating over MSE obfuscation.
  70         headerEncrypted bool
  71         cryptoMethod    mse.CryptoMethod
  72         Discovery       PeerSource
  73         trusted         bool
  74         closed          chansync.SetOnce
  75         // Set true after we've added our ConnStats generated during handshake to
  76         // other ConnStat instances as determined when the *Torrent became known.
  77         reconciledHandshakeStats bool
  78
  79         lastMessageReceived     time.Time
  80         completedHandshake      time.Time
  81         lastUsefulChunkReceived time.Time
  82         lastChunkSent           time.Time
  83
  84         // Stuff controlled by the local peer.
  85         needRequestUpdate    string
  86         actualRequestState   requestState
  87         updateRequestsTimer  *time.Timer
  88         cancelledRequests    roaring.Bitmap
  89         lastBecameInterested time.Time
  90         priorInterest        time.Duration
  91
  92         lastStartedExpectingToReceiveChunks time.Time
  93         cumulativeExpectedToReceiveChunks   time.Duration
  94         _chunksReceivedWhileExpecting       int64
  95
  96         choking                                bool
  97         piecesReceivedSinceLastRequestUpdate   maxRequests
  98         maxPiecesReceivedBetweenRequestUpdates maxRequests
  99         // Chunks that we might reasonably expect to receive from the peer. Due to
 100         // latency, buffering, and implementation differences, we may receive
 101         // chunks that are no longer in the set of requests actually want.
 102         validReceiveChunks map[RequestIndex]int
 103         // Indexed by metadata piece, set to true if posted and pending a
 104         // response.
 105         metadataRequests []bool
 106         sentHaves        bitmap.Bitmap
 107
 108         // Stuff controlled by the remote peer.
 109         peerInterested        bool
 110         peerChoking           bool
 111         peerRequests          map[Request]*peerRequestState
 112         PeerPrefersEncryption bool // as indicated by 'e' field in extension handshake
 113         PeerListenPort        int
 114         // The highest possible number of pieces the torrent could have based on
 115         // communication with the peer. Generally only useful until we have the
 116         // torrent info.
 117         peerMinPieces pieceIndex
 118         // Pieces we've accepted chunks for from the peer.
 119         peerTouchedPieces map[pieceIndex]struct{}
 120         peerAllowedFast   roaring.Bitmap
 121
 122         PeerMaxRequests  maxRequests // Maximum pending requests the peer allows.
 123         PeerExtensionIDs map[pp.ExtensionName]pp.ExtensionNumber
 124         PeerClientName   string
 125
 126         logger log.Logger
 127 }
 128
 129 // Maintains the state of a BitTorrent-protocol based connection with a peer.
 130 type PeerConn struct {
 131         Peer
 132
 133         // A string that should identify the PeerConn's net.Conn endpoints. The net.Conn could
 134         // be wrapping WebRTC, uTP, or TCP etc. Used in writing the conn status for peers.
 135         connString string
 136
 137         // See BEP 3 etc.
 138         PeerID             PeerID
 139         PeerExtensionBytes pp.PeerExtensionBits
 140
 141         // The actual Conn, used for closing, and setting socket options. Do not use methods on this
 142         // while holding any mutexes.
 143         conn net.Conn
 144         // The Reader and Writer for this Conn, with hooks installed for stats,
 145         // limiting, deadlines etc.
 146         w io.Writer
 147         r io.Reader
 148
 149         messageWriter peerConnMsgWriter
 150
 151         uploadTimer *time.Timer
 152         pex         pexConnState
 153
 154         // The pieces the peer has claimed to have.
 155         _peerPieces roaring.Bitmap
 156         // The peer has everything. This can occur due to a special message, when
 157         // we may not even know the number of pieces in the torrent yet.
 158         peerSentHaveAll bool
 159 }
 160
 161 func (cn *PeerConn) connStatusString() string {
 162         return fmt.Sprintf("%+-55q %s %s", cn.PeerID, cn.PeerExtensionBytes, cn.connString)
 163 }
 164
 165 func (cn *Peer) updateExpectingChunks() {
 166         if cn.expectingChunks() {
 167                 if cn.lastStartedExpectingToReceiveChunks.IsZero() {
 168                         cn.lastStartedExpectingToReceiveChunks = time.Now()
 169                 }
 170         } else {
 171                 if !cn.lastStartedExpectingToReceiveChunks.IsZero() {
 172                         cn.cumulativeExpectedToReceiveChunks += time.Since(cn.lastStartedExpectingToReceiveChunks)
 173                         cn.lastStartedExpectingToReceiveChunks = time.Time{}
 174                 }
 175         }
 176 }
 177
 178 func (cn *Peer) expectingChunks() bool {
 179         if cn.actualRequestState.Requests.IsEmpty() {
 180                 return false
 181         }
 182         if !cn.actualRequestState.Interested {
 183                 return false
 184         }
 185         if !cn.peerChoking {
 186                 return true
 187         }
 188         haveAllowedFastRequests := false
 189         cn.peerAllowedFast.Iterate(func(i uint32) bool {
 190                 haveAllowedFastRequests = roaringBitmapRangeCardinality(
 191                         &cn.actualRequestState.Requests,
 192                         cn.t.pieceRequestIndexOffset(pieceIndex(i)),
 193                         cn.t.pieceRequestIndexOffset(pieceIndex(i+1)),
 194                 ) == 0
 195                 return !haveAllowedFastRequests
 196         })
 197         return haveAllowedFastRequests
 198 }
 199
 200 func (cn *Peer) remoteChokingPiece(piece pieceIndex) bool {
 201         return cn.peerChoking && !cn.peerAllowedFast.Contains(bitmap.BitIndex(piece))
 202 }
 203
 204 // Returns true if the connection is over IPv6.
 205 func (cn *PeerConn) ipv6() bool {
 206         ip := cn.remoteIp()
 207         if ip.To4() != nil {
 208                 return false
 209         }
 210         return len(ip) == net.IPv6len
 211 }
 212
 213 // Returns true the if the dialer/initiator has the lower client peer ID. TODO: Find the
 214 // specification for this.
 215 func (cn *PeerConn) isPreferredDirection() bool {
 216         return bytes.Compare(cn.t.cl.peerID[:], cn.PeerID[:]) < 0 == cn.outgoing
 217 }
 218
 219 // Returns whether the left connection should be preferred over the right one,
 220 // considering only their networking properties. If ok is false, we can't
 221 // decide.
 222 func (l *PeerConn) hasPreferredNetworkOver(r *PeerConn) (left, ok bool) {
 223         var ml multiLess
 224         ml.NextBool(l.isPreferredDirection(), r.isPreferredDirection())
 225         ml.NextBool(!l.utp(), !r.utp())
 226         ml.NextBool(l.ipv6(), r.ipv6())
 227         return ml.FinalOk()
 228 }
 229
 230 func (cn *Peer) cumInterest() time.Duration {
 231         ret := cn.priorInterest
 232         if cn.actualRequestState.Interested {
 233                 ret += time.Since(cn.lastBecameInterested)
 234         }
 235         return ret
 236 }
 237
 238 func (cn *PeerConn) peerHasAllPieces() (all bool, known bool) {
 239         if cn.peerSentHaveAll {
 240                 return true, true
 241         }
 242         if !cn.t.haveInfo() {
 243                 return false, false
 244         }
 245         return cn._peerPieces.GetCardinality() == uint64(cn.t.numPieces()), true
 246 }
 247
 248 func (cn *Peer) locker() *lockWithDeferreds {
 249         return cn.t.cl.locker()
 250 }
 251
 252 func (cn *Peer) supportsExtension(ext pp.ExtensionName) bool {
 253         _, ok := cn.PeerExtensionIDs[ext]
 254         return ok
 255 }
 256
 257 // The best guess at number of pieces in the torrent for this peer.
 258 func (cn *Peer) bestPeerNumPieces() pieceIndex {
 259         if cn.t.haveInfo() {
 260                 return cn.t.numPieces()
 261         }
 262         return cn.peerMinPieces
 263 }
 264
 265 func (cn *Peer) completedString() string {
 266         have := pieceIndex(cn.peerPieces().GetCardinality())
 267         if all, _ := cn.peerHasAllPieces(); all {
 268                 have = cn.bestPeerNumPieces()
 269         }
 270         return fmt.Sprintf("%d/%d", have, cn.bestPeerNumPieces())
 271 }
 272
 273 func (cn *PeerConn) onGotInfo(info *metainfo.Info) {
 274         cn.setNumPieces(info.NumPieces())
 275 }
 276
 277 // Correct the PeerPieces slice length. Return false if the existing slice is invalid, such as by
 278 // receiving badly sized BITFIELD, or invalid HAVE messages.
 279 func (cn *PeerConn) setNumPieces(num pieceIndex) {
 280         cn._peerPieces.RemoveRange(bitmap.BitRange(num), bitmap.ToEnd)
 281         cn.peerPiecesChanged()
 282 }
 283
 284 func (cn *PeerConn) peerPieces() *roaring.Bitmap {
 285         return &cn._peerPieces
 286 }
 287
 288 func eventAgeString(t time.Time) string {
 289         if t.IsZero() {
 290                 return "never"
 291         }
 292         return fmt.Sprintf("%.2fs ago", time.Since(t).Seconds())
 293 }
 294
 295 func (cn *PeerConn) connectionFlags() (ret string) {
 296         c := func(b byte) {
 297                 ret += string([]byte{b})
 298         }
 299         if cn.cryptoMethod == mse.CryptoMethodRC4 {
 300                 c('E')
 301         } else if cn.headerEncrypted {
 302                 c('e')
 303         }
 304         ret += string(cn.Discovery)
 305         if cn.utp() {
 306                 c('U')
 307         }
 308         return
 309 }
 310
 311 func (cn *PeerConn) utp() bool {
 312         return parseNetworkString(cn.Network).Udp
 313 }
 314
 315 // Inspired by https://github.com/transmission/transmission/wiki/Peer-Status-Text.
 316 func (cn *Peer) statusFlags() (ret string) {
 317         c := func(b byte) {
 318                 ret += string([]byte{b})
 319         }
 320         if cn.actualRequestState.Interested {
 321                 c('i')
 322         }
 323         if cn.choking {
 324                 c('c')
 325         }
 326         c('-')
 327         ret += cn.connectionFlags()
 328         c('-')
 329         if cn.peerInterested {
 330                 c('i')
 331         }
 332         if cn.peerChoking {
 333                 c('c')
 334         }
 335         return
 336 }
 337
 338 func (cn *Peer) downloadRate() float64 {
 339         num := cn._stats.BytesReadUsefulData.Int64()
 340         if num == 0 {
 341                 return 0
 342         }
 343         return float64(num) / cn.totalExpectingTime().Seconds()
 344 }
 345
 346 func (cn *Peer) numRequestsByPiece() (ret map[pieceIndex]int) {
 347         ret = make(map[pieceIndex]int)
 348         cn.actualRequestState.Requests.Iterate(func(x uint32) bool {
 349                 ret[pieceIndex(x/cn.t.chunksPerRegularPiece())]++
 350                 return true
 351         })
 352         return
 353 }
 354
 355 func (cn *Peer) writeStatus(w io.Writer, t *Torrent) {
 356         // \t isn't preserved in <pre> blocks?
 357         if cn.closed.IsSet() {
 358                 fmt.Fprint(w, "CLOSED: ")
 359         }
 360         fmt.Fprintln(w, cn.connStatusString())
 361         prio, err := cn.peerPriority()
 362         prioStr := fmt.Sprintf("%08x", prio)
 363         if err != nil {
 364                 prioStr += ": " + err.Error()
 365         }
 366         fmt.Fprintf(w, "    bep40-prio: %v\n", prioStr)
 367         fmt.Fprintf(w, "    last msg: %s, connected: %s, last helpful: %s, itime: %s, etime: %s\n",
 368                 eventAgeString(cn.lastMessageReceived),
 369                 eventAgeString(cn.completedHandshake),
 370                 eventAgeString(cn.lastHelpful()),
 371                 cn.cumInterest(),
 372                 cn.totalExpectingTime(),
 373         )
 374         fmt.Fprintf(w,
 375                 "    %s completed, %d pieces touched, good chunks: %v/%v:%v reqq: %d-%v/(%d/%d):%d/%d, flags: %s, dr: %.1f KiB/s\n",
 376                 cn.completedString(),
 377                 len(cn.peerTouchedPieces),
 378                 &cn._stats.ChunksReadUseful,
 379                 &cn._stats.ChunksRead,
 380                 &cn._stats.ChunksWritten,
 381                 cn.actualRequestState.Requests.GetCardinality(),
 382                 cn.cancelledRequests.GetCardinality(),
 383                 cn.nominalMaxRequests(),
 384                 cn.PeerMaxRequests,
 385                 len(cn.peerRequests),
 386                 localClientReqq,
 387                 cn.statusFlags(),
 388                 cn.downloadRate()/(1<<10),
 389         )
 390         fmt.Fprintf(w, "    requested pieces:")
 391         type pieceNumRequestsType struct {
 392                 piece       pieceIndex
 393                 numRequests int
 394         }
 395         var pieceNumRequests []pieceNumRequestsType
 396         for piece, count := range cn.numRequestsByPiece() {
 397                 pieceNumRequests = append(pieceNumRequests, pieceNumRequestsType{piece, count})
 398         }
 399         sort.Slice(pieceNumRequests, func(i, j int) bool {
 400                 return pieceNumRequests[i].piece < pieceNumRequests[j].piece
 401         })
 402         for _, elem := range pieceNumRequests {
 403                 fmt.Fprintf(w, " %v(%v)", elem.piece, elem.numRequests)
 404         }
 405         fmt.Fprintf(w, "\n")
 406 }
 407
 408 func (p *Peer) close() {
 409         if !p.closed.Set() {
 410                 return
 411         }
 412         if p.updateRequestsTimer != nil {
 413                 p.updateRequestsTimer.Stop()
 414         }
 415         p.peerImpl.onClose()
 416         if p.t != nil {
 417                 p.t.decPeerPieceAvailability(p)
 418         }
 419         for _, f := range p.callbacks.PeerClosed {
 420                 f(p)
 421         }
 422 }
 423
 424 func (cn *PeerConn) onClose() {
 425         if cn.pex.IsEnabled() {
 426                 cn.pex.Close()
 427         }
 428         cn.tickleWriter()
 429         if cn.conn != nil {
 430                 go cn.conn.Close()
 431         }
 432         if cb := cn.callbacks.PeerConnClosed; cb != nil {
 433                 cb(cn)
 434         }
 435 }
 436
 437 // Peer definitely has a piece, for purposes of requesting. So it's not sufficient that we think
 438 // they do (known=true).
 439 func (cn *Peer) peerHasPiece(piece pieceIndex) bool {
 440         if all, known := cn.peerHasAllPieces(); all && known {
 441                 return true
 442         }
 443         return cn.peerPieces().ContainsInt(piece)
 444 }
 445
 446 // 64KiB, but temporarily less to work around an issue with WebRTC. TODO: Update when
 447 // https://github.com/pion/datachannel/issues/59 is fixed.
 448 const writeBufferHighWaterLen = 1 << 15
 449
 450 // Writes a message into the write buffer. Returns whether it's okay to keep writing. Writing is
 451 // done asynchronously, so it may be that we're not able to honour backpressure from this method.
 452 func (cn *PeerConn) write(msg pp.Message) bool {
 453         torrent.Add(fmt.Sprintf("messages written of type %s", msg.Type.String()), 1)
 454         // We don't need to track bytes here because the connection's Writer has that behaviour injected
 455         // (although there's some delay between us buffering the message, and the connection writer
 456         // flushing it out.).
 457         notFull := cn.messageWriter.write(msg)
 458         // Last I checked only Piece messages affect stats, and we don't write those.
 459         cn.wroteMsg(&msg)
 460         cn.tickleWriter()
 461         return notFull
 462 }
 463
 464 func (cn *PeerConn) requestMetadataPiece(index int) {
 465         eID := cn.PeerExtensionIDs[pp.ExtensionNameMetadata]
 466         if eID == pp.ExtensionDeleteNumber {
 467                 return
 468         }
 469         if index < len(cn.metadataRequests) && cn.metadataRequests[index] {
 470                 return
 471         }
 472         cn.logger.WithDefaultLevel(log.Debug).Printf("requesting metadata piece %d", index)
 473         cn.write(pp.MetadataExtensionRequestMsg(eID, index))
 474         for index >= len(cn.metadataRequests) {
 475                 cn.metadataRequests = append(cn.metadataRequests, false)
 476         }
 477         cn.metadataRequests[index] = true
 478 }
 479
 480 func (cn *PeerConn) requestedMetadataPiece(index int) bool {
 481         return index < len(cn.metadataRequests) && cn.metadataRequests[index]
 482 }
 483
 484 // The actual value to use as the maximum outbound requests.
 485 func (cn *Peer) nominalMaxRequests() (ret maxRequests) {
 486         return maxRequests(clamp(1, int64(cn.PeerMaxRequests), 2048))
 487 }
 488
 489 func (cn *Peer) totalExpectingTime() (ret time.Duration) {
 490         ret = cn.cumulativeExpectedToReceiveChunks
 491         if !cn.lastStartedExpectingToReceiveChunks.IsZero() {
 492                 ret += time.Since(cn.lastStartedExpectingToReceiveChunks)
 493         }
 494         return
 495 }
 496
 497 func (cn *PeerConn) onPeerSentCancel(r Request) {
 498         if _, ok := cn.peerRequests[r]; !ok {
 499                 torrent.Add("unexpected cancels received", 1)
 500                 return
 501         }
 502         if cn.fastEnabled() {
 503                 cn.reject(r)
 504         } else {
 505                 delete(cn.peerRequests, r)
 506         }
 507 }
 508
 509 func (cn *PeerConn) choke(msg messageWriter) (more bool) {
 510         if cn.choking {
 511                 return true
 512         }
 513         cn.choking = true
 514         more = msg(pp.Message{
 515                 Type: pp.Choke,
 516         })
 517         if cn.fastEnabled() {
 518                 for r := range cn.peerRequests {
 519                         // TODO: Don't reject pieces in allowed fast set.
 520                         cn.reject(r)
 521                 }
 522         } else {
 523                 cn.peerRequests = nil
 524         }
 525         return
 526 }
 527
 528 func (cn *PeerConn) unchoke(msg func(pp.Message) bool) bool {
 529         if !cn.choking {
 530                 return true
 531         }
 532         cn.choking = false
 533         return msg(pp.Message{
 534                 Type: pp.Unchoke,
 535         })
 536 }
 537
 538 func (cn *Peer) setInterested(interested bool) bool {
 539         if cn.actualRequestState.Interested == interested {
 540                 return true
 541         }
 542         cn.actualRequestState.Interested = interested
 543         if interested {
 544                 cn.lastBecameInterested = time.Now()
 545         } else if !cn.lastBecameInterested.IsZero() {
 546                 cn.priorInterest += time.Since(cn.lastBecameInterested)
 547         }
 548         cn.updateExpectingChunks()
 549         // log.Printf("%p: setting interest: %v", cn, interested)
 550         return cn.writeInterested(interested)
 551 }
 552
 553 func (pc *PeerConn) writeInterested(interested bool) bool {
 554         return pc.write(pp.Message{
 555                 Type: func() pp.MessageType {
 556                         if interested {
 557                                 return pp.Interested
 558                         } else {
 559                                 return pp.NotInterested
 560                         }
 561                 }(),
 562         })
 563 }
 564
 565 // The function takes a message to be sent, and returns true if more messages
 566 // are okay.
 567 type messageWriter func(pp.Message) bool
 568
 569 // This function seems to only used by Peer.request. It's all logic checks, so maybe we can no-op it
 570 // when we want to go fast.
 571 func (cn *Peer) shouldRequest(r RequestIndex) error {
 572         pi := pieceIndex(r / cn.t.chunksPerRegularPiece())
 573         if !cn.peerHasPiece(pi) {
 574                 return errors.New("requesting piece peer doesn't have")
 575         }
 576         if !cn.t.peerIsActive(cn) {
 577                 panic("requesting but not in active conns")
 578         }
 579         if cn.closed.IsSet() {
 580                 panic("requesting when connection is closed")
 581         }
 582         if cn.t.hashingPiece(pi) {
 583                 panic("piece is being hashed")
 584         }
 585         if cn.t.pieceQueuedForHash(pi) {
 586                 panic("piece is queued for hash")
 587         }
 588         if cn.peerChoking && !cn.peerAllowedFast.Contains(bitmap.BitIndex(pi)) {
 589                 // This could occur if we made a request with the fast extension, and then got choked and
 590                 // haven't had the request rejected yet.
 591                 if !cn.actualRequestState.Requests.Contains(r) {
 592                         panic("peer choking and piece not allowed fast")
 593                 }
 594         }
 595         return nil
 596 }
 597
 598 func (cn *Peer) mustRequest(r RequestIndex) bool {
 599         more, err := cn.request(r)
 600         if err != nil {
 601                 panic(err)
 602         }
 603         return more
 604 }
 605
 606 func (cn *Peer) request(r RequestIndex) (more bool, err error) {
 607         if err := cn.shouldRequest(r); err != nil {
 608                 panic(err)
 609         }
 610         if cn.actualRequestState.Requests.Contains(r) {
 611                 return true, nil
 612         }
 613         if maxRequests(cn.actualRequestState.Requests.GetCardinality()) >= cn.nominalMaxRequests() {
 614                 return true, errors.New("too many outstanding requests")
 615         }
 616         cn.actualRequestState.Requests.Add(r)
 617         if cn.validReceiveChunks == nil {
 618                 cn.validReceiveChunks = make(map[RequestIndex]int)
 619         }
 620         cn.validReceiveChunks[r]++
 621         cn.t.pendingRequests.Inc(r)
 622         cn.updateExpectingChunks()
 623         ppReq := cn.t.requestIndexToRequest(r)
 624         for _, f := range cn.callbacks.SentRequest {
 625                 f(PeerRequestEvent{cn, ppReq})
 626         }
 627         return cn.peerImpl._request(ppReq), nil
 628 }
 629
 630 func (me *PeerConn) _request(r Request) bool {
 631         return me.write(pp.Message{
 632                 Type:   pp.Request,
 633                 Index:  r.Index,
 634                 Begin:  r.Begin,
 635                 Length: r.Length,
 636         })
 637 }
 638
 639 func (me *Peer) cancel(r RequestIndex) bool {
 640         if !me.actualRequestState.Requests.Contains(r) {
 641                 return true
 642         }
 643         return me._cancel(r)
 644 }
 645
 646 func (me *PeerConn) _cancel(r RequestIndex) bool {
 647         if me.cancelledRequests.Contains(r) {
 648                 // Already cancelled and waiting for a response.
 649                 return true
 650         }
 651         if me.fastEnabled() {
 652                 me.cancelledRequests.Add(r)
 653         } else {
 654                 if !me.deleteRequest(r) {
 655                         panic("request not existing should have been guarded")
 656                 }
 657                 if me.isLowOnRequests() {
 658                         me.updateRequests("Peer.cancel")
 659                 }
 660         }
 661         return me.write(makeCancelMessage(me.t.requestIndexToRequest(r)))
 662 }
 663
 664 func (cn *PeerConn) fillWriteBuffer() {
 665         if !cn.maybeUpdateActualRequestState() {
 666                 return
 667         }
 668         if cn.pex.IsEnabled() {
 669                 if flow := cn.pex.Share(cn.write); !flow {
 670                         return
 671                 }
 672         }
 673         cn.upload(cn.write)
 674 }
 675
 676 func (cn *PeerConn) have(piece pieceIndex) {
 677         if cn.sentHaves.Get(bitmap.BitIndex(piece)) {
 678                 return
 679         }
 680         cn.write(pp.Message{
 681                 Type:  pp.Have,
 682                 Index: pp.Integer(piece),
 683         })
 684         cn.sentHaves.Add(bitmap.BitIndex(piece))
 685 }
 686
 687 func (cn *PeerConn) postBitfield() {
 688         if cn.sentHaves.Len() != 0 {
 689                 panic("bitfield must be first have-related message sent")
 690         }
 691         if !cn.t.haveAnyPieces() {
 692                 return
 693         }
 694         cn.write(pp.Message{
 695                 Type:     pp.Bitfield,
 696                 Bitfield: cn.t.bitfield(),
 697         })
 698         cn.sentHaves = bitmap.Bitmap{cn.t._completedPieces.Clone()}
 699 }
 700
 701 // Sets a reason to update requests, and if there wasn't already one, handle it.
 702 func (cn *Peer) updateRequests(reason string) {
 703         if cn.needRequestUpdate != "" {
 704                 return
 705         }
 706         cn.needRequestUpdate = reason
 707         cn.handleUpdateRequests()
 708 }
 709
 710 func (cn *PeerConn) handleUpdateRequests() {
 711         // The writer determines the request state as needed when it can write.
 712         cn.tickleWriter()
 713 }
 714
 715 // Emits the indices in the Bitmaps bms in order, never repeating any index.
 716 // skip is mutated during execution, and its initial values will never be
 717 // emitted.
 718 func iterBitmapsDistinct(skip *bitmap.Bitmap, bms ...bitmap.Bitmap) iter.Func {
 719         return func(cb iter.Callback) {
 720                 for _, bm := range bms {
 721                         if !iter.All(
 722                                 func(_i interface{}) bool {
 723                                         i := _i.(int)
 724                                         if skip.Contains(bitmap.BitIndex(i)) {
 725                                                 return true
 726                                         }
 727                                         skip.Add(bitmap.BitIndex(i))
 728                                         return cb(i)
 729                                 },
 730                                 bm.Iter,
 731                         ) {
 732                                 return
 733                         }
 734                 }
 735         }
 736 }
 737
 738 func (cn *Peer) peerPiecesChanged() {
 739         cn.t.maybeDropMutuallyCompletePeer(cn)
 740 }
 741
 742 func (cn *PeerConn) raisePeerMinPieces(newMin pieceIndex) {
 743         if newMin > cn.peerMinPieces {
 744                 cn.peerMinPieces = newMin
 745         }
 746 }
 747
 748 func (cn *PeerConn) peerSentHave(piece pieceIndex) error {
 749         if cn.t.haveInfo() && piece >= cn.t.numPieces() || piece < 0 {
 750                 return errors.New("invalid piece")
 751         }
 752         if cn.peerHasPiece(piece) {
 753                 return nil
 754         }
 755         cn.raisePeerMinPieces(piece + 1)
 756         if !cn.peerHasPiece(piece) {
 757                 cn.t.incPieceAvailability(piece)
 758         }
 759         cn._peerPieces.Add(uint32(piece))
 760         if cn.t.wantPieceIndex(piece) {
 761                 cn.updateRequests("have")
 762         }
 763         cn.peerPiecesChanged()
 764         return nil
 765 }
 766
 767 func (cn *PeerConn) peerSentBitfield(bf []bool) error {
 768         if len(bf)%8 != 0 {
 769                 panic("expected bitfield length divisible by 8")
 770         }
 771         // We know that the last byte means that at most the last 7 bits are wasted.
 772         cn.raisePeerMinPieces(pieceIndex(len(bf) - 7))
 773         if cn.t.haveInfo() && len(bf) > int(cn.t.numPieces()) {
 774                 // Ignore known excess pieces.
 775                 bf = bf[:cn.t.numPieces()]
 776         }
 777         pp := cn.newPeerPieces()
 778         cn.peerSentHaveAll = false
 779         for i, have := range bf {
 780                 if have {
 781                         cn.raisePeerMinPieces(pieceIndex(i) + 1)
 782                         if !pp.Contains(bitmap.BitIndex(i)) {
 783                                 cn.t.incPieceAvailability(i)
 784                         }
 785                 } else {
 786                         if pp.Contains(bitmap.BitIndex(i)) {
 787                                 cn.t.decPieceAvailability(i)
 788                         }
 789                 }
 790                 if have {
 791                         cn._peerPieces.Add(uint32(i))
 792                         if cn.t.wantPieceIndex(i) {
 793                                 cn.updateRequests("bitfield")
 794                         }
 795                 } else {
 796                         cn._peerPieces.Remove(uint32(i))
 797                 }
 798         }
 799         cn.peerPiecesChanged()
 800         return nil
 801 }
 802
 803 func (cn *PeerConn) onPeerHasAllPieces() {
 804         t := cn.t
 805         if t.haveInfo() {
 806                 npp, pc := cn.newPeerPieces(), t.numPieces()
 807                 for i := 0; i < pc; i += 1 {
 808                         if !npp.Contains(bitmap.BitIndex(i)) {
 809                                 t.incPieceAvailability(i)
 810                         }
 811                 }
 812         }
 813         cn.peerSentHaveAll = true
 814         cn._peerPieces.Clear()
 815         if !cn.t._pendingPieces.IsEmpty() {
 816                 cn.updateRequests("Peer.onPeerHasAllPieces")
 817         }
 818         cn.peerPiecesChanged()
 819 }
 820
 821 func (cn *PeerConn) onPeerSentHaveAll() error {
 822         cn.onPeerHasAllPieces()
 823         return nil
 824 }
 825
 826 func (cn *PeerConn) peerSentHaveNone() error {
 827         cn.t.decPeerPieceAvailability(&cn.Peer)
 828         cn._peerPieces.Clear()
 829         cn.peerSentHaveAll = false
 830         cn.peerPiecesChanged()
 831         return nil
 832 }
 833
 834 func (c *PeerConn) requestPendingMetadata() {
 835         if c.t.haveInfo() {
 836                 return
 837         }
 838         if c.PeerExtensionIDs[pp.ExtensionNameMetadata] == 0 {
 839                 // Peer doesn't support this.
 840                 return
 841         }
 842         // Request metadata pieces that we don't have in a random order.
 843         var pending []int
 844         for index := 0; index < c.t.metadataPieceCount(); index++ {
 845                 if !c.t.haveMetadataPiece(index) && !c.requestedMetadataPiece(index) {
 846                         pending = append(pending, index)
 847                 }
 848         }
 849         rand.Shuffle(len(pending), func(i, j int) { pending[i], pending[j] = pending[j], pending[i] })
 850         for _, i := range pending {
 851                 c.requestMetadataPiece(i)
 852         }
 853 }
 854
 855 func (cn *PeerConn) wroteMsg(msg *pp.Message) {
 856         torrent.Add(fmt.Sprintf("messages written of type %s", msg.Type.String()), 1)
 857         if msg.Type == pp.Extended {
 858                 for name, id := range cn.PeerExtensionIDs {
 859                         if id != msg.ExtendedID {
 860                                 continue
 861                         }
 862                         torrent.Add(fmt.Sprintf("Extended messages written for protocol %q", name), 1)
 863                 }
 864         }
 865         cn.allStats(func(cs *ConnStats) { cs.wroteMsg(msg) })
 866 }
 867
 868 // After handshake, we know what Torrent and Client stats to include for a
 869 // connection.
 870 func (cn *Peer) postHandshakeStats(f func(*ConnStats)) {
 871         t := cn.t
 872         f(&t.stats)
 873         f(&t.cl.stats)
 874 }
 875
 876 // All ConnStats that include this connection. Some objects are not known
 877 // until the handshake is complete, after which it's expected to reconcile the
 878 // differences.
 879 func (cn *Peer) allStats(f func(*ConnStats)) {
 880         f(&cn._stats)
 881         if cn.reconciledHandshakeStats {
 882                 cn.postHandshakeStats(f)
 883         }
 884 }
 885
 886 func (cn *PeerConn) wroteBytes(n int64) {
 887         cn.allStats(add(n, func(cs *ConnStats) *Count { return &cs.BytesWritten }))
 888 }
 889
 890 func (cn *Peer) readBytes(n int64) {
 891         cn.allStats(add(n, func(cs *ConnStats) *Count { return &cs.BytesRead }))
 892 }
 893
 894 // Returns whether the connection could be useful to us. We're seeding and
 895 // they want data, we don't have metainfo and they can provide it, etc.
 896 func (c *Peer) useful() bool {
 897         t := c.t
 898         if c.closed.IsSet() {
 899                 return false
 900         }
 901         if !t.haveInfo() {
 902                 return c.supportsExtension("ut_metadata")
 903         }
 904         if t.seeding() && c.peerInterested {
 905                 return true
 906         }
 907         if c.peerHasWantedPieces() {
 908                 return true
 909         }
 910         return false
 911 }
 912
 913 func (c *Peer) lastHelpful() (ret time.Time) {
 914         ret = c.lastUsefulChunkReceived
 915         if c.t.seeding() && c.lastChunkSent.After(ret) {
 916                 ret = c.lastChunkSent
 917         }
 918         return
 919 }
 920
 921 func (c *PeerConn) fastEnabled() bool {
 922         return c.PeerExtensionBytes.SupportsFast() && c.t.cl.config.Extensions.SupportsFast()
 923 }
 924
 925 func (c *PeerConn) reject(r Request) {
 926         if !c.fastEnabled() {
 927                 panic("fast not enabled")
 928         }
 929         c.write(r.ToMsg(pp.Reject))
 930         delete(c.peerRequests, r)
 931 }
 932
 933 func (c *PeerConn) onReadRequest(r Request) error {
 934         requestedChunkLengths.Add(strconv.FormatUint(r.Length.Uint64(), 10), 1)
 935         if _, ok := c.peerRequests[r]; ok {
 936                 torrent.Add("duplicate requests received", 1)
 937                 return nil
 938         }
 939         if c.choking {
 940                 torrent.Add("requests received while choking", 1)
 941                 if c.fastEnabled() {
 942                         torrent.Add("requests rejected while choking", 1)
 943                         c.reject(r)
 944                 }
 945                 return nil
 946         }
 947         // TODO: What if they've already requested this?
 948         if len(c.peerRequests) >= localClientReqq {
 949                 torrent.Add("requests received while queue full", 1)
 950                 if c.fastEnabled() {
 951                         c.reject(r)
 952                 }
 953                 // BEP 6 says we may close here if we choose.
 954                 return nil
 955         }
 956         if !c.t.havePiece(pieceIndex(r.Index)) {
 957                 // This isn't necessarily them screwing up. We can drop pieces
 958                 // from our storage, and can't communicate this to peers
 959                 // except by reconnecting.
 960                 requestsReceivedForMissingPieces.Add(1)
 961                 return fmt.Errorf("peer requested piece we don't have: %v", r.Index.Int())
 962         }
 963         // Check this after we know we have the piece, so that the piece length will be known.
 964         if r.Begin+r.Length > c.t.pieceLength(pieceIndex(r.Index)) {
 965                 torrent.Add("bad requests received", 1)
 966                 return errors.New("bad Request")
 967         }
 968         if c.peerRequests == nil {
 969                 c.peerRequests = make(map[Request]*peerRequestState, localClientReqq)
 970         }
 971         value := &peerRequestState{}
 972         c.peerRequests[r] = value
 973         go c.peerRequestDataReader(r, value)
 974         // c.tickleWriter()
 975         return nil
 976 }
 977
 978 func (c *PeerConn) peerRequestDataReader(r Request, prs *peerRequestState) {
 979         b, err := readPeerRequestData(r, c)
 980         c.locker().Lock()
 981         defer c.locker().Unlock()
 982         if err != nil {
 983                 c.peerRequestDataReadFailed(err, r)
 984         } else {
 985                 if b == nil {
 986                         panic("data must be non-nil to trigger send")
 987                 }
 988                 prs.data = b
 989                 c.tickleWriter()
 990         }
 991 }
 992
 993 // If this is maintained correctly, we might be able to support optional synchronous reading for
 994 // chunk sending, the way it used to work.
 995 func (c *PeerConn) peerRequestDataReadFailed(err error, r Request) {
 996         c.logger.WithDefaultLevel(log.Warning).Printf("error reading chunk for peer Request %v: %v", r, err)
 997         if c.t.closed.IsSet() {
 998                 return
 999         }
1000         i := pieceIndex(r.Index)
1001         if c.t.pieceComplete(i) {
1002                 // There used to be more code here that just duplicated the following break. Piece
1003                 // completions are currently cached, so I'm not sure how helpful this update is, except to
1004                 // pull any completion changes pushed to the storage backend in failed reads that got us
1005                 // here.
1006                 c.t.updatePieceCompletion(i)
1007         }
1008         // If we failed to send a chunk, choke the peer to ensure they flush all their requests. We've
1009         // probably dropped a piece from storage, but there's no way to communicate this to the peer. If
1010         // they ask for it again, we'll kick them to allow us to send them an updated bitfield on the
1011         // next connect. TODO: Support rejecting here too.
1012         if c.choking {
1013                 c.logger.WithDefaultLevel(log.Warning).Printf("already choking peer, requests might not be rejected correctly")
1014         }
1015         c.choke(c.write)
1016 }
1017
1018 func readPeerRequestData(r Request, c *PeerConn) ([]byte, error) {
1019         b := make([]byte, r.Length)
1020         p := c.t.info.Piece(int(r.Index))
1021         n, err := c.t.readAt(b, p.Offset()+int64(r.Begin))
1022         if n == len(b) {
1023                 if err == io.EOF {
1024                         err = nil
1025                 }
1026         } else {
1027                 if err == nil {
1028                         panic("expected error")
1029                 }
1030         }
1031         return b, err
1032 }
1033
1034 func runSafeExtraneous(f func()) {
1035         if true {
1036                 go f()
1037         } else {
1038                 f()
1039         }
1040 }
1041
1042 func (c *PeerConn) logProtocolBehaviour(level log.Level, format string, arg ...interface{}) {
1043         c.logger.WithLevel(level).WithContextText(fmt.Sprintf(
1044                 "peer id %q, ext v %q", c.PeerID, c.PeerClientName,
1045         )).SkipCallers(1).Printf(format, arg...)
1046 }
1047
1048 // Processes incoming BitTorrent wire-protocol messages. The client lock is held upon entry and
1049 // exit. Returning will end the connection.
1050 func (c *PeerConn) mainReadLoop() (err error) {
1051         defer func() {
1052                 if err != nil {
1053                         torrent.Add("connection.mainReadLoop returned with error", 1)
1054                 } else {
1055                         torrent.Add("connection.mainReadLoop returned with no error", 1)
1056                 }
1057         }()
1058         t := c.t
1059         cl := t.cl
1060
1061         decoder := pp.Decoder{
1062                 R:         bufio.NewReaderSize(c.r, 1<<17),
1063                 MaxLength: 256 * 1024,
1064                 Pool:      &t.chunkPool,
1065         }
1066         for {
1067                 var msg pp.Message
1068                 func() {
1069                         cl.unlock()
1070                         defer cl.lock()
1071                         err = decoder.Decode(&msg)
1072                 }()
1073                 if cb := c.callbacks.ReadMessage; cb != nil && err == nil {
1074                         cb(c, &msg)
1075                 }
1076                 if t.closed.IsSet() || c.closed.IsSet() {
1077                         return nil
1078                 }
1079                 if err != nil {
1080                         return err
1081                 }
1082                 c.lastMessageReceived = time.Now()
1083                 if msg.Keepalive {
1084                         receivedKeepalives.Add(1)
1085                         continue
1086                 }
1087                 messageTypesReceived.Add(msg.Type.String(), 1)
1088                 if msg.Type.FastExtension() && !c.fastEnabled() {
1089                         runSafeExtraneous(func() { torrent.Add("fast messages received when extension is disabled", 1) })
1090                         return fmt.Errorf("received fast extension message (type=%v) but extension is disabled", msg.Type)
1091                 }
1092                 switch msg.Type {
1093                 case pp.Choke:
1094                         if c.peerChoking {
1095                                 break
1096                         }
1097                         if !c.fastEnabled() {
1098                                 c.deleteAllRequests()
1099                         } else {
1100                                 // We don't decrement pending requests here, let's wait for the peer to either
1101                                 // reject or satisfy the outstanding requests. Additionally some peers may unchoke
1102                                 // us and resume where they left off, we don't want to have piled on to those chunks
1103                                 // in the meanwhile. I think a peers ability to abuse this should be limited: they
1104                                 // could let us request a lot of stuff, then choke us and never reject, but they're
1105                                 // only a single peer, our chunk balancing should smooth over this abuse.
1106                         }
1107                         c.peerChoking = true
1108                         // We can now reset our interest. I think we do this after setting the flag in case the
1109                         // peerImpl updates synchronously (webseeds?).
1110                         if !c.actualRequestState.Requests.IsEmpty() {
1111                                 c.updateRequests("choked")
1112                         }
1113                         c.updateExpectingChunks()
1114                 case pp.Unchoke:
1115                         if !c.peerChoking {
1116                                 // Some clients do this for some reason. Transmission doesn't error on this, so we
1117                                 // won't for consistency.
1118                                 c.logProtocolBehaviour(log.Debug, "received unchoke when already unchoked")
1119                                 break
1120                         }
1121                         c.peerChoking = false
1122                         preservedCount := 0
1123                         c.actualRequestState.Requests.Iterate(func(x uint32) bool {
1124                                 if !c.peerAllowedFast.Contains(x / c.t.chunksPerRegularPiece()) {
1125                                         preservedCount++
1126                                 }
1127                                 return true
1128                         })
1129                         if preservedCount != 0 {
1130                                 // TODO: Yes this is a debug log but I'm not happy with the state of the logging lib
1131                                 // right now.
1132                                 c.logger.WithLevel(log.Debug).Printf(
1133                                         "%v requests were preserved while being choked (fast=%v)",
1134                                         preservedCount,
1135                                         c.fastEnabled())
1136                                 torrent.Add("requestsPreservedThroughChoking", int64(preservedCount))
1137                         }
1138                         if !c.t._pendingPieces.IsEmpty() {
1139                                 c.updateRequests("unchoked")
1140                         }
1141                         c.updateExpectingChunks()
1142                 case pp.Interested:
1143                         c.peerInterested = true
1144                         c.tickleWriter()
1145                 case pp.NotInterested:
1146                         c.peerInterested = false
1147                         // We don't clear their requests since it isn't clear in the spec.
1148                         // We'll probably choke them for this, which will clear them if
1149                         // appropriate, and is clearly specified.
1150                 case pp.Have:
1151                         err = c.peerSentHave(pieceIndex(msg.Index))
1152                 case pp.Bitfield:
1153                         err = c.peerSentBitfield(msg.Bitfield)
1154                 case pp.Request:
1155                         r := newRequestFromMessage(&msg)
1156                         err = c.onReadRequest(r)
1157                 case pp.Piece:
1158                         c.doChunkReadStats(int64(len(msg.Piece)))
1159                         err = c.receiveChunk(&msg)
1160                         if len(msg.Piece) == int(t.chunkSize) {
1161                                 t.chunkPool.Put(&msg.Piece)
1162                         }
1163                         if err != nil {
1164                                 err = fmt.Errorf("receiving chunk: %w", err)
1165                         }
1166                 case pp.Cancel:
1167                         req := newRequestFromMessage(&msg)
1168                         c.onPeerSentCancel(req)
1169                 case pp.Port:
1170                         ipa, ok := tryIpPortFromNetAddr(c.RemoteAddr)
1171                         if !ok {
1172                                 break
1173                         }
1174                         pingAddr := net.UDPAddr{
1175                                 IP:   ipa.IP,
1176                                 Port: ipa.Port,
1177                         }
1178                         if msg.Port != 0 {
1179                                 pingAddr.Port = int(msg.Port)
1180                         }
1181                         cl.eachDhtServer(func(s DhtServer) {
1182                                 go s.Ping(&pingAddr)
1183                         })
1184                 case pp.Suggest:
1185                         torrent.Add("suggests received", 1)
1186                         log.Fmsg("peer suggested piece %d", msg.Index).AddValues(c, msg.Index).SetLevel(log.Debug).Log(c.t.logger)
1187                         c.updateRequests("suggested")
1188                 case pp.HaveAll:
1189                         err = c.onPeerSentHaveAll()
1190                 case pp.HaveNone:
1191                         err = c.peerSentHaveNone()
1192                 case pp.Reject:
1193                         c.remoteRejectedRequest(c.t.requestIndexFromRequest(newRequestFromMessage(&msg)))
1194                 case pp.AllowedFast:
1195                         torrent.Add("allowed fasts received", 1)
1196                         log.Fmsg("peer allowed fast: %d", msg.Index).AddValues(c).SetLevel(log.Debug).Log(c.t.logger)
1197                         c.updateRequests("PeerConn.mainReadLoop allowed fast")
1198                 case pp.Extended:
1199                         err = c.onReadExtendedMsg(msg.ExtendedID, msg.ExtendedPayload)
1200                 default:
1201                         err = fmt.Errorf("received unknown message type: %#v", msg.Type)
1202                 }
1203                 if err != nil {
1204                         return err
1205                 }
1206         }
1207 }
1208
1209 func (c *Peer) remoteRejectedRequest(r RequestIndex) {
1210         if c.deleteRequest(r) {
1211                 if c.isLowOnRequests() {
1212                         c.updateRequests("Peer.remoteRejectedRequest")
1213                 }
1214                 c.decExpectedChunkReceive(r)
1215         }
1216 }
1217
1218 func (c *Peer) decExpectedChunkReceive(r RequestIndex) {
1219         count := c.validReceiveChunks[r]
1220         if count == 1 {
1221                 delete(c.validReceiveChunks, r)
1222         } else if count > 1 {
1223                 c.validReceiveChunks[r] = count - 1
1224         } else {
1225                 panic(r)
1226         }
1227 }
1228
1229 func (c *PeerConn) onReadExtendedMsg(id pp.ExtensionNumber, payload []byte) (err error) {
1230         defer func() {
1231                 // TODO: Should we still do this?
1232                 if err != nil {
1233                         // These clients use their own extension IDs for outgoing message
1234                         // types, which is incorrect.
1235                         if bytes.HasPrefix(c.PeerID[:], []byte("-SD0100-")) || strings.HasPrefix(string(c.PeerID[:]), "-XL0012-") {
1236                                 err = nil
1237                         }
1238                 }
1239         }()
1240         t := c.t
1241         cl := t.cl
1242         switch id {
1243         case pp.HandshakeExtendedID:
1244                 var d pp.ExtendedHandshakeMessage
1245                 if err := bencode.Unmarshal(payload, &d); err != nil {
1246                         c.logger.Printf("error parsing extended handshake message %q: %s", payload, err)
1247                         return fmt.Errorf("unmarshalling extended handshake payload: %w", err)
1248                 }
1249                 if cb := c.callbacks.ReadExtendedHandshake; cb != nil {
1250                         cb(c, &d)
1251                 }
1252                 // c.logger.WithDefaultLevel(log.Debug).Printf("received extended handshake message:\n%s", spew.Sdump(d))
1253                 if d.Reqq != 0 {
1254                         c.PeerMaxRequests = d.Reqq
1255                 }
1256                 c.PeerClientName = d.V
1257                 if c.PeerExtensionIDs == nil {
1258                         c.PeerExtensionIDs = make(map[pp.ExtensionName]pp.ExtensionNumber, len(d.M))
1259                 }
1260                 c.PeerListenPort = d.Port
1261                 c.PeerPrefersEncryption = d.Encryption
1262                 for name, id := range d.M {
1263                         if _, ok := c.PeerExtensionIDs[name]; !ok {
1264                                 peersSupportingExtension.Add(
1265                                         // expvar.Var.String must produce valid JSON. "ut_payme\xeet_address" was being
1266                                         // entered here which caused problems later when unmarshalling.
1267                                         strconv.Quote(string(name)),
1268                                         1)
1269                         }
1270                         c.PeerExtensionIDs[name] = id
1271                 }
1272                 if d.MetadataSize != 0 {
1273                         if err = t.setMetadataSize(d.MetadataSize); err != nil {
1274                                 return fmt.Errorf("setting metadata size to %d: %w", d.MetadataSize, err)
1275                         }
1276                 }
1277                 c.requestPendingMetadata()
1278                 if !t.cl.config.DisablePEX {
1279                         t.pex.Add(c) // we learnt enough now
1280                         c.pex.Init(c)
1281                 }
1282                 return nil
1283         case metadataExtendedId:
1284                 err := cl.gotMetadataExtensionMsg(payload, t, c)
1285                 if err != nil {
1286                         return fmt.Errorf("handling metadata extension message: %w", err)
1287                 }
1288                 return nil
1289         case pexExtendedId:
1290                 if !c.pex.IsEnabled() {
1291                         return nil // or hang-up maybe?
1292                 }
1293                 return c.pex.Recv(payload)
1294         default:
1295                 return fmt.Errorf("unexpected extended message ID: %v", id)
1296         }
1297 }
1298
1299 // Set both the Reader and Writer for the connection from a single ReadWriter.
1300 func (cn *PeerConn) setRW(rw io.ReadWriter) {
1301         cn.r = rw
1302         cn.w = rw
1303 }
1304
1305 // Returns the Reader and Writer as a combined ReadWriter.
1306 func (cn *PeerConn) rw() io.ReadWriter {
1307         return struct {
1308                 io.Reader
1309                 io.Writer
1310         }{cn.r, cn.w}
1311 }
1312
1313 func (c *Peer) doChunkReadStats(size int64) {
1314         c.allStats(func(cs *ConnStats) { cs.receivedChunk(size) })
1315 }
1316
1317 // Handle a received chunk from a peer.
1318 func (c *Peer) receiveChunk(msg *pp.Message) error {
1319         chunksReceived.Add("total", 1)
1320
1321         ppReq := newRequestFromMessage(msg)
1322         req := c.t.requestIndexFromRequest(ppReq)
1323
1324         if c.peerChoking {
1325                 chunksReceived.Add("while choked", 1)
1326         }
1327
1328         if c.validReceiveChunks[req] <= 0 {
1329                 chunksReceived.Add("unexpected", 1)
1330                 return errors.New("received unexpected chunk")
1331         }
1332         c.decExpectedChunkReceive(req)
1333
1334         if c.peerChoking && c.peerAllowedFast.Contains(bitmap.BitIndex(ppReq.Index)) {
1335                 chunksReceived.Add("due to allowed fast", 1)
1336         }
1337
1338         // The request needs to be deleted immediately to prevent cancels occurring asynchronously when
1339         // have actually already received the piece, while we have the Client unlocked to write the data
1340         // out.
1341         deletedRequest := false
1342         {
1343                 if c.actualRequestState.Requests.Contains(req) {
1344                         for _, f := range c.callbacks.ReceivedRequested {
1345                                 f(PeerMessageEvent{c, msg})
1346                         }
1347                 }
1348                 // Request has been satisfied.
1349                 if c.deleteRequest(req) {
1350                         deletedRequest = true
1351                         if !c.peerChoking {
1352                                 c._chunksReceivedWhileExpecting++
1353                         }
1354                         if c.isLowOnRequests() {
1355                                 c.updateRequests("Peer.receiveChunk deleted request")
1356                         }
1357                 } else {
1358                         chunksReceived.Add("unwanted", 1)
1359                 }
1360         }
1361
1362         t := c.t
1363         cl := t.cl
1364
1365         // Do we actually want this chunk?
1366         if t.haveChunk(ppReq) {
1367                 // panic(fmt.Sprintf("%+v", ppReq))
1368                 chunksReceived.Add("wasted", 1)
1369                 c.allStats(add(1, func(cs *ConnStats) *Count { return &cs.ChunksReadWasted }))
1370                 return nil
1371         }
1372
1373         piece := &t.pieces[ppReq.Index]
1374
1375         c.allStats(add(1, func(cs *ConnStats) *Count { return &cs.ChunksReadUseful }))
1376         c.allStats(add(int64(len(msg.Piece)), func(cs *ConnStats) *Count { return &cs.BytesReadUsefulData }))
1377         if deletedRequest {
1378                 c.piecesReceivedSinceLastRequestUpdate++
1379                 c.allStats(add(int64(len(msg.Piece)), func(cs *ConnStats) *Count { return &cs.BytesReadUsefulIntendedData }))
1380         }
1381         for _, f := range c.t.cl.config.Callbacks.ReceivedUsefulData {
1382                 f(ReceivedUsefulDataEvent{c, msg})
1383         }
1384         c.lastUsefulChunkReceived = time.Now()
1385
1386         // Need to record that it hasn't been written yet, before we attempt to do
1387         // anything with it.
1388         piece.incrementPendingWrites()
1389         // Record that we have the chunk, so we aren't trying to download it while
1390         // waiting for it to be written to storage.
1391         piece.unpendChunkIndex(chunkIndexFromChunkSpec(ppReq.ChunkSpec, t.chunkSize))
1392
1393         // Cancel pending requests for this chunk from *other* peers.
1394         t.iterPeers(func(p *Peer) {
1395                 if p == c {
1396                         return
1397                 }
1398                 p.cancel(req)
1399         })
1400
1401         err := func() error {
1402                 cl.unlock()
1403                 defer cl.lock()
1404                 concurrentChunkWrites.Add(1)
1405                 defer concurrentChunkWrites.Add(-1)
1406                 // Write the chunk out. Note that the upper bound on chunk writing concurrency will be the
1407                 // number of connections. We write inline with receiving the chunk (with this lock dance),
1408                 // because we want to handle errors synchronously and I haven't thought of a nice way to
1409                 // defer any concurrency to the storage and have that notify the client of errors. TODO: Do
1410                 // that instead.
1411                 return t.writeChunk(int(msg.Index), int64(msg.Begin), msg.Piece)
1412         }()
1413
1414         piece.decrementPendingWrites()
1415
1416         if err != nil {
1417                 c.logger.WithDefaultLevel(log.Error).Printf("writing received chunk %v: %v", req, err)
1418                 t.pendRequest(req)
1419                 // Necessary to pass TestReceiveChunkStorageFailureSeederFastExtensionDisabled. I think a
1420                 // request update runs while we're writing the chunk that just failed. Then we never do a
1421                 // fresh update after pending the failed request.
1422                 c.updateRequests("Peer.receiveChunk error writing chunk")
1423                 t.onWriteChunkErr(err)
1424                 return nil
1425         }
1426
1427         c.onDirtiedPiece(pieceIndex(ppReq.Index))
1428
1429         // We need to ensure the piece is only queued once, so only the last chunk writer gets this job.
1430         if t.pieceAllDirty(pieceIndex(ppReq.Index)) && piece.pendingWrites == 0 {
1431                 t.queuePieceCheck(pieceIndex(ppReq.Index))
1432                 // We don't pend all chunks here anymore because we don't want code dependent on the dirty
1433                 // chunk status (such as the haveChunk call above) to have to check all the various other
1434                 // piece states like queued for hash, hashing etc. This does mean that we need to be sure
1435                 // that chunk pieces are pended at an appropriate time later however.
1436         }
1437
1438         cl.event.Broadcast()
1439         // We do this because we've written a chunk, and may change PieceState.Partial.
1440         t.publishPieceChange(pieceIndex(ppReq.Index))
1441
1442         return nil
1443 }
1444
1445 func (c *Peer) onDirtiedPiece(piece pieceIndex) {
1446         if c.peerTouchedPieces == nil {
1447                 c.peerTouchedPieces = make(map[pieceIndex]struct{})
1448         }
1449         c.peerTouchedPieces[piece] = struct{}{}
1450         ds := &c.t.pieces[piece].dirtiers
1451         if *ds == nil {
1452                 *ds = make(map[*Peer]struct{})
1453         }
1454         (*ds)[c] = struct{}{}
1455 }
1456
1457 func (c *PeerConn) uploadAllowed() bool {
1458         if c.t.cl.config.NoUpload {
1459                 return false
1460         }
1461         if c.t.dataUploadDisallowed {
1462                 return false
1463         }
1464         if c.t.seeding() {
1465                 return true
1466         }
1467         if !c.peerHasWantedPieces() {
1468                 return false
1469         }
1470         // Don't upload more than 100 KiB more than we download.
1471         if c._stats.BytesWrittenData.Int64() >= c._stats.BytesReadData.Int64()+100<<10 {
1472                 return false
1473         }
1474         return true
1475 }
1476
1477 func (c *PeerConn) setRetryUploadTimer(delay time.Duration) {
1478         if c.uploadTimer == nil {
1479                 c.uploadTimer = time.AfterFunc(delay, c.tickleWriter)
1480         } else {
1481                 c.uploadTimer.Reset(delay)
1482         }
1483 }
1484
1485 // Also handles choking and unchoking of the remote peer.
1486 func (c *PeerConn) upload(msg func(pp.Message) bool) bool {
1487         // Breaking or completing this loop means we don't want to upload to the
1488         // peer anymore, and we choke them.
1489 another:
1490         for c.uploadAllowed() {
1491                 // We want to upload to the peer.
1492                 if !c.unchoke(msg) {
1493                         return false
1494                 }
1495                 for r, state := range c.peerRequests {
1496                         if state.data == nil {
1497                                 continue
1498                         }
1499                         res := c.t.cl.config.UploadRateLimiter.ReserveN(time.Now(), int(r.Length))
1500                         if !res.OK() {
1501                                 panic(fmt.Sprintf("upload rate limiter burst size < %d", r.Length))
1502                         }
1503                         delay := res.Delay()
1504                         if delay > 0 {
1505                                 res.Cancel()
1506                                 c.setRetryUploadTimer(delay)
1507                                 // Hard to say what to return here.
1508                                 return true
1509                         }
1510                         more := c.sendChunk(r, msg, state)
1511                         delete(c.peerRequests, r)
1512                         if !more {
1513                                 return false
1514                         }
1515                         goto another
1516                 }
1517                 return true
1518         }
1519         return c.choke(msg)
1520 }
1521
1522 func (cn *PeerConn) drop() {
1523         cn.t.dropConnection(cn)
1524 }
1525
1526 func (cn *Peer) netGoodPiecesDirtied() int64 {
1527         return cn._stats.PiecesDirtiedGood.Int64() - cn._stats.PiecesDirtiedBad.Int64()
1528 }
1529
1530 func (c *Peer) peerHasWantedPieces() bool {
1531         if all, _ := c.peerHasAllPieces(); all {
1532                 return !c.t.haveAllPieces() && !c.t._pendingPieces.IsEmpty()
1533         }
1534         if !c.t.haveInfo() {
1535                 return !c.peerPieces().IsEmpty()
1536         }
1537         return c.peerPieces().Intersects(&c.t._pendingPieces)
1538 }
1539
1540 func (c *Peer) deleteRequest(r RequestIndex) bool {
1541         if !c.actualRequestState.Requests.CheckedRemove(r) {
1542                 return false
1543         }
1544         c.cancelledRequests.Remove(r)
1545         for _, f := range c.callbacks.DeletedRequest {
1546                 f(PeerRequestEvent{c, c.t.requestIndexToRequest(r)})
1547         }
1548         c.updateExpectingChunks()
1549         c.t.pendingRequests.Dec(r)
1550         return true
1551 }
1552
1553 func (c *Peer) deleteAllRequests() {
1554         c.actualRequestState.Requests.Clone().Iterate(func(x uint32) bool {
1555                 c.deleteRequest(x)
1556                 return true
1557         })
1558         if !c.actualRequestState.Requests.IsEmpty() {
1559                 panic(c.actualRequestState.Requests.GetCardinality())
1560         }
1561 }
1562
1563 // This is called when something has changed that should wake the writer, such as putting stuff into
1564 // the writeBuffer, or changing some state that the writer can act on.
1565 func (c *PeerConn) tickleWriter() {
1566         c.messageWriter.writeCond.Broadcast()
1567 }
1568
1569 func (c *PeerConn) sendChunk(r Request, msg func(pp.Message) bool, state *peerRequestState) (more bool) {
1570         c.lastChunkSent = time.Now()
1571         return msg(pp.Message{
1572                 Type:  pp.Piece,
1573                 Index: r.Index,
1574                 Begin: r.Begin,
1575                 Piece: state.data,
1576         })
1577 }
1578
1579 func (c *PeerConn) setTorrent(t *Torrent) {
1580         if c.t != nil {
1581                 panic("connection already associated with a torrent")
1582         }
1583         c.t = t
1584         c.logger.WithDefaultLevel(log.Debug).Printf("set torrent=%v", t)
1585         t.reconcileHandshakeStats(c)
1586 }
1587
1588 func (c *Peer) peerPriority() (peerPriority, error) {
1589         return bep40Priority(c.remoteIpPort(), c.t.cl.publicAddr(c.remoteIp()))
1590 }
1591
1592 func (c *Peer) remoteIp() net.IP {
1593         host, _, _ := net.SplitHostPort(c.RemoteAddr.String())
1594         return net.ParseIP(host)
1595 }
1596
1597 func (c *Peer) remoteIpPort() IpPort {
1598         ipa, _ := tryIpPortFromNetAddr(c.RemoteAddr)
1599         return IpPort{ipa.IP, uint16(ipa.Port)}
1600 }
1601
1602 func (c *PeerConn) pexPeerFlags() pp.PexPeerFlags {
1603         f := pp.PexPeerFlags(0)
1604         if c.PeerPrefersEncryption {
1605                 f |= pp.PexPrefersEncryption
1606         }
1607         if c.outgoing {
1608                 f |= pp.PexOutgoingConn
1609         }
1610         if c.utp() {
1611                 f |= pp.PexSupportsUtp
1612         }
1613         return f
1614 }
1615
1616 // This returns the address to use if we want to dial the peer again. It incorporates the peer's
1617 // advertised listen port.
1618 func (c *PeerConn) dialAddr() PeerRemoteAddr {
1619         if !c.outgoing && c.PeerListenPort != 0 {
1620                 switch addr := c.RemoteAddr.(type) {
1621                 case *net.TCPAddr:
1622                         dialAddr := *addr
1623                         dialAddr.Port = c.PeerListenPort
1624                         return &dialAddr
1625                 case *net.UDPAddr:
1626                         dialAddr := *addr
1627                         dialAddr.Port = c.PeerListenPort
1628                         return &dialAddr
1629                 }
1630         }
1631         return c.RemoteAddr
1632 }
1633
1634 func (c *PeerConn) pexEvent(t pexEventType) pexEvent {
1635         f := c.pexPeerFlags()
1636         addr := c.dialAddr()
1637         return pexEvent{t, addr, f, nil}
1638 }
1639
1640 func (c *PeerConn) String() string {
1641         return fmt.Sprintf("connection %p", c)
1642 }
1643
1644 func (c *Peer) trust() connectionTrust {
1645         return connectionTrust{c.trusted, c.netGoodPiecesDirtied()}
1646 }
1647
1648 type connectionTrust struct {
1649         Implicit            bool
1650         NetGoodPiecesDirted int64
1651 }
1652
1653 func (l connectionTrust) Less(r connectionTrust) bool {
1654         return multiless.New().Bool(l.Implicit, r.Implicit).Int64(l.NetGoodPiecesDirted, r.NetGoodPiecesDirted).Less()
1655 }
1656
1657 // Returns the pieces the peer could have based on their claims. If we don't know how many pieces
1658 // are in the torrent, it could be a very large range the peer has sent HaveAll.
1659 func (cn *PeerConn) PeerPieces() *roaring.Bitmap {
1660         cn.locker().RLock()
1661         defer cn.locker().RUnlock()
1662         return cn.newPeerPieces()
1663 }
1664
1665 // Returns a new Bitmap that includes bits for all pieces the peer could have based on their claims.
1666 func (cn *Peer) newPeerPieces() *roaring.Bitmap {
1667         // TODO: Can we use copy on write?
1668         ret := cn.peerPieces().Clone()
1669         if all, _ := cn.peerHasAllPieces(); all {
1670                 if cn.t.haveInfo() {
1671                         ret.AddRange(0, bitmap.BitRange(cn.t.numPieces()))
1672                 } else {
1673                         ret.AddRange(0, bitmap.ToEnd)
1674                 }
1675         }
1676         return ret
1677 }
1678
1679 func (cn *Peer) stats() *ConnStats {
1680         return &cn._stats
1681 }
1682
1683 func (p *Peer) TryAsPeerConn() (*PeerConn, bool) {
1684         pc, ok := p.peerImpl.(*PeerConn)
1685         return pc, ok
1686 }
1687
1688 func (pc *PeerConn) isLowOnRequests() bool {
1689         return pc.actualRequestState.Requests.IsEmpty()
1690 }