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