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