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 func (cn *PeerConn) onPeerSentCancel(r Request) {
 487         if _, ok := cn.peerRequests[r]; !ok {
 488                 torrent.Add("unexpected cancels received", 1)
 489                 return
 490         }
 491         if cn.fastEnabled() {
 492                 cn.reject(r)
 493         } else {
 494                 delete(cn.peerRequests, r)
 495         }
 496 }
 497
 498 func (cn *PeerConn) choke(msg messageWriter) (more bool) {
 499         if cn.choking {
 500                 return true
 501         }
 502         cn.choking = true
 503         more = msg(pp.Message{
 504                 Type: pp.Choke,
 505         })
 506         if cn.fastEnabled() {
 507                 for r := range cn.peerRequests {
 508                         // TODO: Don't reject pieces in allowed fast set.
 509                         cn.reject(r)
 510                 }
 511         } else {
 512                 cn.peerRequests = nil
 513         }
 514         return
 515 }
 516
 517 func (cn *PeerConn) unchoke(msg func(pp.Message) bool) bool {
 518         if !cn.choking {
 519                 return true
 520         }
 521         cn.choking = false
 522         return msg(pp.Message{
 523                 Type: pp.Unchoke,
 524         })
 525 }
 526
 527 func (cn *Peer) setInterested(interested bool) bool {
 528         if cn.actualRequestState.Interested == interested {
 529                 return true
 530         }
 531         cn.actualRequestState.Interested = interested
 532         if interested {
 533                 cn.lastBecameInterested = time.Now()
 534         } else if !cn.lastBecameInterested.IsZero() {
 535                 cn.priorInterest += time.Since(cn.lastBecameInterested)
 536         }
 537         cn.updateExpectingChunks()
 538         // log.Printf("%p: setting interest: %v", cn, interested)
 539         return cn.writeInterested(interested)
 540 }
 541
 542 func (pc *PeerConn) writeInterested(interested bool) bool {
 543         return pc.write(pp.Message{
 544                 Type: func() pp.MessageType {
 545                         if interested {
 546                                 return pp.Interested
 547                         } else {
 548                                 return pp.NotInterested
 549                         }
 550                 }(),
 551         })
 552 }
 553
 554 // The function takes a message to be sent, and returns true if more messages
 555 // are okay.
 556 type messageWriter func(pp.Message) bool
 557
 558 // This function seems to only used by Peer.request. It's all logic checks, so maybe we can no-op it
 559 // when we want to go fast.
 560 func (cn *Peer) shouldRequest(r RequestIndex) error {
 561         pi := pieceIndex(r / cn.t.chunksPerRegularPiece())
 562         if !cn.peerHasPiece(pi) {
 563                 return errors.New("requesting piece peer doesn't have")
 564         }
 565         if !cn.t.peerIsActive(cn) {
 566                 panic("requesting but not in active conns")
 567         }
 568         if cn.closed.IsSet() {
 569                 panic("requesting when connection is closed")
 570         }
 571         if cn.t.hashingPiece(pi) {
 572                 panic("piece is being hashed")
 573         }
 574         if cn.t.pieceQueuedForHash(pi) {
 575                 panic("piece is queued for hash")
 576         }
 577         if cn.peerChoking && !cn.peerAllowedFast.Contains(bitmap.BitIndex(pi)) {
 578                 // This could occur if we made a request with the fast extension, and then got choked and
 579                 // haven't had the request rejected yet.
 580                 if !cn.actualRequestState.Requests.Contains(r) {
 581                         panic("peer choking and piece not allowed fast")
 582                 }
 583         }
 584         return nil
 585 }
 586
 587 func (cn *Peer) mustRequest(r RequestIndex) bool {
 588         more, err := cn.request(r)
 589         if err != nil {
 590                 panic(err)
 591         }
 592         return more
 593 }
 594
 595 func (cn *Peer) request(r RequestIndex) (more bool, err error) {
 596         if err := cn.shouldRequest(r); err != nil {
 597                 panic(err)
 598         }
 599         if cn.actualRequestState.Requests.Contains(r) {
 600                 return true, nil
 601         }
 602         if maxRequests(cn.actualRequestState.Requests.GetCardinality()) >= cn.nominalMaxRequests() {
 603                 return true, errors.New("too many outstanding requests")
 604         }
 605         cn.actualRequestState.Requests.Add(r)
 606         if cn.validReceiveChunks == nil {
 607                 cn.validReceiveChunks = make(map[RequestIndex]int)
 608         }
 609         cn.validReceiveChunks[r]++
 610         cn.t.pendingRequests.Inc(r)
 611         cn.updateExpectingChunks()
 612         ppReq := cn.t.requestIndexToRequest(r)
 613         for _, f := range cn.callbacks.SentRequest {
 614                 f(PeerRequestEvent{cn, ppReq})
 615         }
 616         return cn.peerImpl._request(ppReq), nil
 617 }
 618
 619 func (me *PeerConn) _request(r Request) bool {
 620         return me.write(pp.Message{
 621                 Type:   pp.Request,
 622                 Index:  r.Index,
 623                 Begin:  r.Begin,
 624                 Length: r.Length,
 625         })
 626 }
 627
 628 func (me *Peer) cancel(r RequestIndex) bool {
 629         if !me.actualRequestState.Requests.Contains(r) {
 630                 return true
 631         }
 632         return me._cancel(r)
 633 }
 634
 635 func (me *PeerConn) _cancel(r RequestIndex) bool {
 636         if me.cancelledRequests.Contains(r) {
 637                 // Already cancelled and waiting for a response.
 638                 return true
 639         }
 640         if me.fastEnabled() {
 641                 me.cancelledRequests.Add(r)
 642         } else {
 643                 if !me.deleteRequest(r) {
 644                         panic("request not existing should have been guarded")
 645                 }
 646                 if me.isLowOnRequests() {
 647                         me.updateRequests("Peer.cancel")
 648                 }
 649         }
 650         return me.write(makeCancelMessage(me.t.requestIndexToRequest(r)))
 651 }
 652
 653 func (cn *PeerConn) fillWriteBuffer() {
 654         if !cn.maybeUpdateActualRequestState() {
 655                 return
 656         }
 657         if cn.pex.IsEnabled() {
 658                 if flow := cn.pex.Share(cn.write); !flow {
 659                         return
 660                 }
 661         }
 662         cn.upload(cn.write)
 663 }
 664
 665 func (cn *PeerConn) have(piece pieceIndex) {
 666         if cn.sentHaves.Get(bitmap.BitIndex(piece)) {
 667                 return
 668         }
 669         cn.write(pp.Message{
 670                 Type:  pp.Have,
 671                 Index: pp.Integer(piece),
 672         })
 673         cn.sentHaves.Add(bitmap.BitIndex(piece))
 674 }
 675
 676 func (cn *PeerConn) postBitfield() {
 677         if cn.sentHaves.Len() != 0 {
 678                 panic("bitfield must be first have-related message sent")
 679         }
 680         if !cn.t.haveAnyPieces() {
 681                 return
 682         }
 683         cn.write(pp.Message{
 684                 Type:     pp.Bitfield,
 685                 Bitfield: cn.t.bitfield(),
 686         })
 687         cn.sentHaves = bitmap.Bitmap{cn.t._completedPieces.Clone()}
 688 }
 689
 690 // Sets a reason to update requests, and if there wasn't already one, handle it.
 691 func (cn *Peer) updateRequests(reason string) {
 692         if cn.needRequestUpdate != "" {
 693                 return
 694         }
 695         cn.needRequestUpdate = reason
 696         cn.handleUpdateRequests()
 697 }
 698
 699 func (cn *PeerConn) handleUpdateRequests() {
 700         // The writer determines the request state as needed when it can write.
 701         cn.tickleWriter()
 702 }
 703
 704 // Emits the indices in the Bitmaps bms in order, never repeating any index.
 705 // skip is mutated during execution, and its initial values will never be
 706 // emitted.
 707 func iterBitmapsDistinct(skip *bitmap.Bitmap, bms ...bitmap.Bitmap) iter.Func {
 708         return func(cb iter.Callback) {
 709                 for _, bm := range bms {
 710                         if !iter.All(
 711                                 func(_i interface{}) bool {
 712                                         i := _i.(int)
 713                                         if skip.Contains(bitmap.BitIndex(i)) {
 714                                                 return true
 715                                         }
 716                                         skip.Add(bitmap.BitIndex(i))
 717                                         return cb(i)
 718                                 },
 719                                 bm.Iter,
 720                         ) {
 721                                 return
 722                         }
 723                 }
 724         }
 725 }
 726
 727 func (cn *Peer) peerPiecesChanged() {
 728         cn.t.maybeDropMutuallyCompletePeer(cn)
 729 }
 730
 731 func (cn *PeerConn) raisePeerMinPieces(newMin pieceIndex) {
 732         if newMin > cn.peerMinPieces {
 733                 cn.peerMinPieces = newMin
 734         }
 735 }
 736
 737 func (cn *PeerConn) peerSentHave(piece pieceIndex) error {
 738         if cn.t.haveInfo() && piece >= cn.t.numPieces() || piece < 0 {
 739                 return errors.New("invalid piece")
 740         }
 741         if cn.peerHasPiece(piece) {
 742                 return nil
 743         }
 744         cn.raisePeerMinPieces(piece + 1)
 745         if !cn.peerHasPiece(piece) {
 746                 cn.t.incPieceAvailability(piece)
 747         }
 748         cn._peerPieces.Add(uint32(piece))
 749         if cn.t.wantPieceIndex(piece) {
 750                 cn.updateRequests("have")
 751         }
 752         cn.peerPiecesChanged()
 753         return nil
 754 }
 755
 756 func (cn *PeerConn) peerSentBitfield(bf []bool) error {
 757         if len(bf)%8 != 0 {
 758                 panic("expected bitfield length divisible by 8")
 759         }
 760         // We know that the last byte means that at most the last 7 bits are wasted.
 761         cn.raisePeerMinPieces(pieceIndex(len(bf) - 7))
 762         if cn.t.haveInfo() && len(bf) > int(cn.t.numPieces()) {
 763                 // Ignore known excess pieces.
 764                 bf = bf[:cn.t.numPieces()]
 765         }
 766         pp := cn.newPeerPieces()
 767         cn.peerSentHaveAll = false
 768         for i, have := range bf {
 769                 if have {
 770                         cn.raisePeerMinPieces(pieceIndex(i) + 1)
 771                         if !pp.Contains(bitmap.BitIndex(i)) {
 772                                 cn.t.incPieceAvailability(i)
 773                         }
 774                 } else {
 775                         if pp.Contains(bitmap.BitIndex(i)) {
 776                                 cn.t.decPieceAvailability(i)
 777                         }
 778                 }
 779                 if have {
 780                         cn._peerPieces.Add(uint32(i))
 781                         if cn.t.wantPieceIndex(i) {
 782                                 cn.updateRequests("bitfield")
 783                         }
 784                 } else {
 785                         cn._peerPieces.Remove(uint32(i))
 786                 }
 787         }
 788         cn.peerPiecesChanged()
 789         return nil
 790 }
 791
 792 func (cn *Peer) onPeerHasAllPieces() {
 793         t := cn.t
 794         if t.haveInfo() {
 795                 npp, pc := cn.newPeerPieces(), t.numPieces()
 796                 for i := 0; i < pc; i += 1 {
 797                         if !npp.Contains(bitmap.BitIndex(i)) {
 798                                 t.incPieceAvailability(i)
 799                         }
 800                 }
 801         }
 802         cn.peerSentHaveAll = true
 803         cn._peerPieces.Clear()
 804         if !cn.t._pendingPieces.IsEmpty() {
 805                 cn.updateRequests("Peer.onPeerHasAllPieces")
 806         }
 807         cn.peerPiecesChanged()
 808 }
 809
 810 func (cn *PeerConn) onPeerSentHaveAll() error {
 811         cn.onPeerHasAllPieces()
 812         return nil
 813 }
 814
 815 func (cn *PeerConn) peerSentHaveNone() error {
 816         cn.t.decPeerPieceAvailability(&cn.Peer)
 817         cn._peerPieces.Clear()
 818         cn.peerSentHaveAll = false
 819         cn.peerPiecesChanged()
 820         return nil
 821 }
 822
 823 func (c *PeerConn) requestPendingMetadata() {
 824         if c.t.haveInfo() {
 825                 return
 826         }
 827         if c.PeerExtensionIDs[pp.ExtensionNameMetadata] == 0 {
 828                 // Peer doesn't support this.
 829                 return
 830         }
 831         // Request metadata pieces that we don't have in a random order.
 832         var pending []int
 833         for index := 0; index < c.t.metadataPieceCount(); index++ {
 834                 if !c.t.haveMetadataPiece(index) && !c.requestedMetadataPiece(index) {
 835                         pending = append(pending, index)
 836                 }
 837         }
 838         rand.Shuffle(len(pending), func(i, j int) { pending[i], pending[j] = pending[j], pending[i] })
 839         for _, i := range pending {
 840                 c.requestMetadataPiece(i)
 841         }
 842 }
 843
 844 func (cn *PeerConn) wroteMsg(msg *pp.Message) {
 845         torrent.Add(fmt.Sprintf("messages written of type %s", msg.Type.String()), 1)
 846         if msg.Type == pp.Extended {
 847                 for name, id := range cn.PeerExtensionIDs {
 848                         if id != msg.ExtendedID {
 849                                 continue
 850                         }
 851                         torrent.Add(fmt.Sprintf("Extended messages written for protocol %q", name), 1)
 852                 }
 853         }
 854         cn.allStats(func(cs *ConnStats) { cs.wroteMsg(msg) })
 855 }
 856
 857 // After handshake, we know what Torrent and Client stats to include for a
 858 // connection.
 859 func (cn *Peer) postHandshakeStats(f func(*ConnStats)) {
 860         t := cn.t
 861         f(&t.stats)
 862         f(&t.cl.stats)
 863 }
 864
 865 // All ConnStats that include this connection. Some objects are not known
 866 // until the handshake is complete, after which it's expected to reconcile the
 867 // differences.
 868 func (cn *Peer) allStats(f func(*ConnStats)) {
 869         f(&cn._stats)
 870         if cn.reconciledHandshakeStats {
 871                 cn.postHandshakeStats(f)
 872         }
 873 }
 874
 875 func (cn *PeerConn) wroteBytes(n int64) {
 876         cn.allStats(add(n, func(cs *ConnStats) *Count { return &cs.BytesWritten }))
 877 }
 878
 879 func (cn *Peer) readBytes(n int64) {
 880         cn.allStats(add(n, func(cs *ConnStats) *Count { return &cs.BytesRead }))
 881 }
 882
 883 // Returns whether the connection could be useful to us. We're seeding and
 884 // they want data, we don't have metainfo and they can provide it, etc.
 885 func (c *Peer) useful() bool {
 886         t := c.t
 887         if c.closed.IsSet() {
 888                 return false
 889         }
 890         if !t.haveInfo() {
 891                 return c.supportsExtension("ut_metadata")
 892         }
 893         if t.seeding() && c.peerInterested {
 894                 return true
 895         }
 896         if c.peerHasWantedPieces() {
 897                 return true
 898         }
 899         return false
 900 }
 901
 902 func (c *Peer) lastHelpful() (ret time.Time) {
 903         ret = c.lastUsefulChunkReceived
 904         if c.t.seeding() && c.lastChunkSent.After(ret) {
 905                 ret = c.lastChunkSent
 906         }
 907         return
 908 }
 909
 910 func (c *PeerConn) fastEnabled() bool {
 911         return c.PeerExtensionBytes.SupportsFast() && c.t.cl.config.Extensions.SupportsFast()
 912 }
 913
 914 func (c *PeerConn) reject(r Request) {
 915         if !c.fastEnabled() {
 916                 panic("fast not enabled")
 917         }
 918         c.write(r.ToMsg(pp.Reject))
 919         delete(c.peerRequests, r)
 920 }
 921
 922 func (c *PeerConn) onReadRequest(r Request) error {
 923         requestedChunkLengths.Add(strconv.FormatUint(r.Length.Uint64(), 10), 1)
 924         if _, ok := c.peerRequests[r]; ok {
 925                 torrent.Add("duplicate requests received", 1)
 926                 return nil
 927         }
 928         if c.choking {
 929                 torrent.Add("requests received while choking", 1)
 930                 if c.fastEnabled() {
 931                         torrent.Add("requests rejected while choking", 1)
 932                         c.reject(r)
 933                 }
 934                 return nil
 935         }
 936         // TODO: What if they've already requested this?
 937         if len(c.peerRequests) >= localClientReqq {
 938                 torrent.Add("requests received while queue full", 1)
 939                 if c.fastEnabled() {
 940                         c.reject(r)
 941                 }
 942                 // BEP 6 says we may close here if we choose.
 943                 return nil
 944         }
 945         if !c.t.havePiece(pieceIndex(r.Index)) {
 946                 // This isn't necessarily them screwing up. We can drop pieces
 947                 // from our storage, and can't communicate this to peers
 948                 // except by reconnecting.
 949                 requestsReceivedForMissingPieces.Add(1)
 950                 return fmt.Errorf("peer requested piece we don't have: %v", r.Index.Int())
 951         }
 952         // Check this after we know we have the piece, so that the piece length will be known.
 953         if r.Begin+r.Length > c.t.pieceLength(pieceIndex(r.Index)) {
 954                 torrent.Add("bad requests received", 1)
 955                 return errors.New("bad Request")
 956         }
 957         if c.peerRequests == nil {
 958                 c.peerRequests = make(map[Request]*peerRequestState, localClientReqq)
 959         }
 960         value := &peerRequestState{}
 961         c.peerRequests[r] = value
 962         go c.peerRequestDataReader(r, value)
 963         // c.tickleWriter()
 964         return nil
 965 }
 966
 967 func (c *PeerConn) peerRequestDataReader(r Request, prs *peerRequestState) {
 968         b, err := readPeerRequestData(r, c)
 969         c.locker().Lock()
 970         defer c.locker().Unlock()
 971         if err != nil {
 972                 c.peerRequestDataReadFailed(err, r)
 973         } else {
 974                 if b == nil {
 975                         panic("data must be non-nil to trigger send")
 976                 }
 977                 prs.data = b
 978                 c.tickleWriter()
 979         }
 980 }
 981
 982 // If this is maintained correctly, we might be able to support optional synchronous reading for
 983 // chunk sending, the way it used to work.
 984 func (c *PeerConn) peerRequestDataReadFailed(err error, r Request) {
 985         c.logger.WithDefaultLevel(log.Warning).Printf("error reading chunk for peer Request %v: %v", r, err)
 986         if c.t.closed.IsSet() {
 987                 return
 988         }
 989         i := pieceIndex(r.Index)
 990         if c.t.pieceComplete(i) {
 991                 // There used to be more code here that just duplicated the following break. Piece
 992                 // completions are currently cached, so I'm not sure how helpful this update is, except to
 993                 // pull any completion changes pushed to the storage backend in failed reads that got us
 994                 // here.
 995                 c.t.updatePieceCompletion(i)
 996         }
 997         // If we failed to send a chunk, choke the peer to ensure they flush all their requests. We've
 998         // probably dropped a piece from storage, but there's no way to communicate this to the peer. If
 999         // they ask for it again, we'll kick them to allow us to send them an updated bitfield on the
1000         // next connect. TODO: Support rejecting here too.
1001         if c.choking {
1002                 c.logger.WithDefaultLevel(log.Warning).Printf("already choking peer, requests might not be rejected correctly")
1003         }
1004         c.choke(c.write)
1005 }
1006
1007 func readPeerRequestData(r Request, c *PeerConn) ([]byte, error) {
1008         b := make([]byte, r.Length)
1009         p := c.t.info.Piece(int(r.Index))
1010         n, err := c.t.readAt(b, p.Offset()+int64(r.Begin))
1011         if n == len(b) {
1012                 if err == io.EOF {
1013                         err = nil
1014                 }
1015         } else {
1016                 if err == nil {
1017                         panic("expected error")
1018                 }
1019         }
1020         return b, err
1021 }
1022
1023 func runSafeExtraneous(f func()) {
1024         if true {
1025                 go f()
1026         } else {
1027                 f()
1028         }
1029 }
1030
1031 func (c *PeerConn) logProtocolBehaviour(level log.Level, format string, arg ...interface{}) {
1032         c.logger.WithLevel(level).WithContextText(fmt.Sprintf(
1033                 "peer id %q, ext v %q", c.PeerID, c.PeerClientName,
1034         )).SkipCallers(1).Printf(format, arg...)
1035 }
1036
1037 // Processes incoming BitTorrent wire-protocol messages. The client lock is held upon entry and
1038 // exit. Returning will end the connection.
1039 func (c *PeerConn) mainReadLoop() (err error) {
1040         defer func() {
1041                 if err != nil {
1042                         torrent.Add("connection.mainReadLoop returned with error", 1)
1043                 } else {
1044                         torrent.Add("connection.mainReadLoop returned with no error", 1)
1045                 }
1046         }()
1047         t := c.t
1048         cl := t.cl
1049
1050         decoder := pp.Decoder{
1051                 R:         bufio.NewReaderSize(c.r, 1<<17),
1052                 MaxLength: 256 * 1024,
1053                 Pool:      &t.chunkPool,
1054         }
1055         for {
1056                 var msg pp.Message
1057                 func() {
1058                         cl.unlock()
1059                         defer cl.lock()
1060                         err = decoder.Decode(&msg)
1061                 }()
1062                 if cb := c.callbacks.ReadMessage; cb != nil && err == nil {
1063                         cb(c, &msg)
1064                 }
1065                 if t.closed.IsSet() || c.closed.IsSet() {
1066                         return nil
1067                 }
1068                 if err != nil {
1069                         return err
1070                 }
1071                 c.lastMessageReceived = time.Now()
1072                 if msg.Keepalive {
1073                         receivedKeepalives.Add(1)
1074                         continue
1075                 }
1076                 messageTypesReceived.Add(msg.Type.String(), 1)
1077                 if msg.Type.FastExtension() && !c.fastEnabled() {
1078                         runSafeExtraneous(func() { torrent.Add("fast messages received when extension is disabled", 1) })
1079                         return fmt.Errorf("received fast extension message (type=%v) but extension is disabled", msg.Type)
1080                 }
1081                 switch msg.Type {
1082                 case pp.Choke:
1083                         if c.peerChoking {
1084                                 break
1085                         }
1086                         if !c.fastEnabled() {
1087                                 c.deleteAllRequests()
1088                         } else {
1089                                 // We don't decrement pending requests here, let's wait for the peer to either
1090                                 // reject or satisfy the outstanding requests. Additionally some peers may unchoke
1091                                 // us and resume where they left off, we don't want to have piled on to those chunks
1092                                 // in the meanwhile. I think a peers ability to abuse this should be limited: they
1093                                 // could let us request a lot of stuff, then choke us and never reject, but they're
1094                                 // only a single peer, our chunk balancing should smooth over this abuse.
1095                         }
1096                         c.peerChoking = true
1097                         // We can now reset our interest. I think we do this after setting the flag in case the
1098                         // peerImpl updates synchronously (webseeds?).
1099                         c.updateRequests("choked")
1100                         c.updateExpectingChunks()
1101                 case pp.Unchoke:
1102                         if !c.peerChoking {
1103                                 // Some clients do this for some reason. Transmission doesn't error on this, so we
1104                                 // won't for consistency.
1105                                 c.logProtocolBehaviour(log.Debug, "received unchoke when already unchoked")
1106                                 break
1107                         }
1108                         c.peerChoking = false
1109                         preservedCount := 0
1110                         c.actualRequestState.Requests.Iterate(func(x uint32) bool {
1111                                 if !c.peerAllowedFast.Contains(x / c.t.chunksPerRegularPiece()) {
1112                                         preservedCount++
1113                                 }
1114                                 return true
1115                         })
1116                         if preservedCount != 0 {
1117                                 // TODO: Yes this is a debug log but I'm not happy with the state of the logging lib
1118                                 // right now.
1119                                 c.logger.WithLevel(log.Debug).Printf(
1120                                         "%v requests were preserved while being choked (fast=%v)",
1121                                         preservedCount,
1122                                         c.fastEnabled())
1123                                 torrent.Add("requestsPreservedThroughChoking", int64(preservedCount))
1124                         }
1125                         c.updateRequests("unchoked")
1126                         c.updateExpectingChunks()
1127                 case pp.Interested:
1128                         c.peerInterested = true
1129                         c.tickleWriter()
1130                 case pp.NotInterested:
1131                         c.peerInterested = false
1132                         // We don't clear their requests since it isn't clear in the spec.
1133                         // We'll probably choke them for this, which will clear them if
1134                         // appropriate, and is clearly specified.
1135                 case pp.Have:
1136                         err = c.peerSentHave(pieceIndex(msg.Index))
1137                 case pp.Bitfield:
1138                         err = c.peerSentBitfield(msg.Bitfield)
1139                 case pp.Request:
1140                         r := newRequestFromMessage(&msg)
1141                         err = c.onReadRequest(r)
1142                 case pp.Piece:
1143                         c.doChunkReadStats(int64(len(msg.Piece)))
1144                         err = c.receiveChunk(&msg)
1145                         if len(msg.Piece) == int(t.chunkSize) {
1146                                 t.chunkPool.Put(&msg.Piece)
1147                         }
1148                         if err != nil {
1149                                 err = fmt.Errorf("receiving chunk: %w", err)
1150                         }
1151                 case pp.Cancel:
1152                         req := newRequestFromMessage(&msg)
1153                         c.onPeerSentCancel(req)
1154                 case pp.Port:
1155                         ipa, ok := tryIpPortFromNetAddr(c.RemoteAddr)
1156                         if !ok {
1157                                 break
1158                         }
1159                         pingAddr := net.UDPAddr{
1160                                 IP:   ipa.IP,
1161                                 Port: ipa.Port,
1162                         }
1163                         if msg.Port != 0 {
1164                                 pingAddr.Port = int(msg.Port)
1165                         }
1166                         cl.eachDhtServer(func(s DhtServer) {
1167                                 go s.Ping(&pingAddr)
1168                         })
1169                 case pp.Suggest:
1170                         torrent.Add("suggests received", 1)
1171                         log.Fmsg("peer suggested piece %d", msg.Index).AddValues(c, msg.Index).SetLevel(log.Debug).Log(c.t.logger)
1172                         c.updateRequests("suggested")
1173                 case pp.HaveAll:
1174                         err = c.onPeerSentHaveAll()
1175                 case pp.HaveNone:
1176                         err = c.peerSentHaveNone()
1177                 case pp.Reject:
1178                         c.remoteRejectedRequest(c.t.requestIndexFromRequest(newRequestFromMessage(&msg)))
1179                 case pp.AllowedFast:
1180                         torrent.Add("allowed fasts received", 1)
1181                         log.Fmsg("peer allowed fast: %d", msg.Index).AddValues(c).SetLevel(log.Debug).Log(c.t.logger)
1182                         c.updateRequests("PeerConn.mainReadLoop allowed fast")
1183                 case pp.Extended:
1184                         err = c.onReadExtendedMsg(msg.ExtendedID, msg.ExtendedPayload)
1185                 default:
1186                         err = fmt.Errorf("received unknown message type: %#v", msg.Type)
1187                 }
1188                 if err != nil {
1189                         return err
1190                 }
1191         }
1192 }
1193
1194 func (c *Peer) remoteRejectedRequest(r RequestIndex) {
1195         if c.deleteRequest(r) {
1196                 if c.isLowOnRequests() {
1197                         c.updateRequests("Peer.remoteRejectedRequest")
1198                 }
1199                 c.decExpectedChunkReceive(r)
1200         }
1201 }
1202
1203 func (c *Peer) decExpectedChunkReceive(r RequestIndex) {
1204         count := c.validReceiveChunks[r]
1205         if count == 1 {
1206                 delete(c.validReceiveChunks, r)
1207         } else if count > 1 {
1208                 c.validReceiveChunks[r] = count - 1
1209         } else {
1210                 panic(r)
1211         }
1212 }
1213
1214 func (c *PeerConn) onReadExtendedMsg(id pp.ExtensionNumber, payload []byte) (err error) {
1215         defer func() {
1216                 // TODO: Should we still do this?
1217                 if err != nil {
1218                         // These clients use their own extension IDs for outgoing message
1219                         // types, which is incorrect.
1220                         if bytes.HasPrefix(c.PeerID[:], []byte("-SD0100-")) || strings.HasPrefix(string(c.PeerID[:]), "-XL0012-") {
1221                                 err = nil
1222                         }
1223                 }
1224         }()
1225         t := c.t
1226         cl := t.cl
1227         switch id {
1228         case pp.HandshakeExtendedID:
1229                 var d pp.ExtendedHandshakeMessage
1230                 if err := bencode.Unmarshal(payload, &d); err != nil {
1231                         c.logger.Printf("error parsing extended handshake message %q: %s", payload, err)
1232                         return fmt.Errorf("unmarshalling extended handshake payload: %w", err)
1233                 }
1234                 if cb := c.callbacks.ReadExtendedHandshake; cb != nil {
1235                         cb(c, &d)
1236                 }
1237                 // c.logger.WithDefaultLevel(log.Debug).Printf("received extended handshake message:\n%s", spew.Sdump(d))
1238                 if d.Reqq != 0 {
1239                         c.PeerMaxRequests = d.Reqq
1240                 }
1241                 c.PeerClientName = d.V
1242                 if c.PeerExtensionIDs == nil {
1243                         c.PeerExtensionIDs = make(map[pp.ExtensionName]pp.ExtensionNumber, len(d.M))
1244                 }
1245                 c.PeerListenPort = d.Port
1246                 c.PeerPrefersEncryption = d.Encryption
1247                 for name, id := range d.M {
1248                         if _, ok := c.PeerExtensionIDs[name]; !ok {
1249                                 peersSupportingExtension.Add(string(name), 1)
1250                         }
1251                         c.PeerExtensionIDs[name] = id
1252                 }
1253                 if d.MetadataSize != 0 {
1254                         if err = t.setMetadataSize(d.MetadataSize); err != nil {
1255                                 return fmt.Errorf("setting metadata size to %d: %w", d.MetadataSize, err)
1256                         }
1257                 }
1258                 c.requestPendingMetadata()
1259                 if !t.cl.config.DisablePEX {
1260                         t.pex.Add(c) // we learnt enough now
1261                         c.pex.Init(c)
1262                 }
1263                 return nil
1264         case metadataExtendedId:
1265                 err := cl.gotMetadataExtensionMsg(payload, t, c)
1266                 if err != nil {
1267                         return fmt.Errorf("handling metadata extension message: %w", err)
1268                 }
1269                 return nil
1270         case pexExtendedId:
1271                 if !c.pex.IsEnabled() {
1272                         return nil // or hang-up maybe?
1273                 }
1274                 return c.pex.Recv(payload)
1275         default:
1276                 return fmt.Errorf("unexpected extended message ID: %v", id)
1277         }
1278 }
1279
1280 // Set both the Reader and Writer for the connection from a single ReadWriter.
1281 func (cn *PeerConn) setRW(rw io.ReadWriter) {
1282         cn.r = rw
1283         cn.w = rw
1284 }
1285
1286 // Returns the Reader and Writer as a combined ReadWriter.
1287 func (cn *PeerConn) rw() io.ReadWriter {
1288         return struct {
1289                 io.Reader
1290                 io.Writer
1291         }{cn.r, cn.w}
1292 }
1293
1294 func (c *Peer) doChunkReadStats(size int64) {
1295         c.allStats(func(cs *ConnStats) { cs.receivedChunk(size) })
1296 }
1297
1298 // Handle a received chunk from a peer.
1299 func (c *Peer) receiveChunk(msg *pp.Message) error {
1300         chunksReceived.Add("total", 1)
1301
1302         ppReq := newRequestFromMessage(msg)
1303         req := c.t.requestIndexFromRequest(ppReq)
1304
1305         if c.peerChoking {
1306                 chunksReceived.Add("while choked", 1)
1307         }
1308
1309         if c.validReceiveChunks[req] <= 0 {
1310                 chunksReceived.Add("unexpected", 1)
1311                 return errors.New("received unexpected chunk")
1312         }
1313         c.decExpectedChunkReceive(req)
1314
1315         if c.peerChoking && c.peerAllowedFast.Contains(bitmap.BitIndex(ppReq.Index)) {
1316                 chunksReceived.Add("due to allowed fast", 1)
1317         }
1318
1319         // The request needs to be deleted immediately to prevent cancels occurring asynchronously when
1320         // have actually already received the piece, while we have the Client unlocked to write the data
1321         // out.
1322         deletedRequest := false
1323         {
1324                 if c.actualRequestState.Requests.Contains(req) {
1325                         for _, f := range c.callbacks.ReceivedRequested {
1326                                 f(PeerMessageEvent{c, msg})
1327                         }
1328                 }
1329                 // Request has been satisfied.
1330                 if c.deleteRequest(req) {
1331                         deletedRequest = true
1332                         if !c.peerChoking {
1333                                 c._chunksReceivedWhileExpecting++
1334                         }
1335                         if c.isLowOnRequests() {
1336                                 c.updateRequests("Peer.receiveChunk deleted request")
1337                         }
1338                 } else {
1339                         chunksReceived.Add("unwanted", 1)
1340                 }
1341         }
1342
1343         t := c.t
1344         cl := t.cl
1345
1346         // Do we actually want this chunk?
1347         if t.haveChunk(ppReq) {
1348                 // panic(fmt.Sprintf("%+v", ppReq))
1349                 chunksReceived.Add("wasted", 1)
1350                 c.allStats(add(1, func(cs *ConnStats) *Count { return &cs.ChunksReadWasted }))
1351                 return nil
1352         }
1353
1354         piece := &t.pieces[ppReq.Index]
1355
1356         c.allStats(add(1, func(cs *ConnStats) *Count { return &cs.ChunksReadUseful }))
1357         c.allStats(add(int64(len(msg.Piece)), func(cs *ConnStats) *Count { return &cs.BytesReadUsefulData }))
1358         if deletedRequest {
1359                 c.piecesReceivedSinceLastRequestUpdate++
1360                 c.allStats(add(int64(len(msg.Piece)), func(cs *ConnStats) *Count { return &cs.BytesReadUsefulIntendedData }))
1361         }
1362         for _, f := range c.t.cl.config.Callbacks.ReceivedUsefulData {
1363                 f(ReceivedUsefulDataEvent{c, msg})
1364         }
1365         c.lastUsefulChunkReceived = time.Now()
1366
1367         // Need to record that it hasn't been written yet, before we attempt to do
1368         // anything with it.
1369         piece.incrementPendingWrites()
1370         // Record that we have the chunk, so we aren't trying to download it while
1371         // waiting for it to be written to storage.
1372         piece.unpendChunkIndex(chunkIndexFromChunkSpec(ppReq.ChunkSpec, t.chunkSize))
1373
1374         // Cancel pending requests for this chunk from *other* peers.
1375         t.iterPeers(func(p *Peer) {
1376                 if p == c {
1377                         return
1378                 }
1379                 p.cancel(req)
1380         })
1381
1382         err := func() error {
1383                 cl.unlock()
1384                 defer cl.lock()
1385                 concurrentChunkWrites.Add(1)
1386                 defer concurrentChunkWrites.Add(-1)
1387                 // Write the chunk out. Note that the upper bound on chunk writing concurrency will be the
1388                 // number of connections. We write inline with receiving the chunk (with this lock dance),
1389                 // because we want to handle errors synchronously and I haven't thought of a nice way to
1390                 // defer any concurrency to the storage and have that notify the client of errors. TODO: Do
1391                 // that instead.
1392                 return t.writeChunk(int(msg.Index), int64(msg.Begin), msg.Piece)
1393         }()
1394
1395         piece.decrementPendingWrites()
1396
1397         if err != nil {
1398                 c.logger.WithDefaultLevel(log.Error).Printf("writing received chunk %v: %v", req, err)
1399                 t.pendRequest(req)
1400                 // Necessary to pass TestReceiveChunkStorageFailureSeederFastExtensionDisabled. I think a
1401                 // request update runs while we're writing the chunk that just failed. Then we never do a
1402                 // fresh update after pending the failed request.
1403                 c.updateRequests("Peer.receiveChunk error writing chunk")
1404                 t.onWriteChunkErr(err)
1405                 return nil
1406         }
1407
1408         c.onDirtiedPiece(pieceIndex(ppReq.Index))
1409
1410         // We need to ensure the piece is only queued once, so only the last chunk writer gets this job.
1411         if t.pieceAllDirty(pieceIndex(ppReq.Index)) && piece.pendingWrites == 0 {
1412                 t.queuePieceCheck(pieceIndex(ppReq.Index))
1413                 // We don't pend all chunks here anymore because we don't want code dependent on the dirty
1414                 // chunk status (such as the haveChunk call above) to have to check all the various other
1415                 // piece states like queued for hash, hashing etc. This does mean that we need to be sure
1416                 // that chunk pieces are pended at an appropriate time later however.
1417         }
1418
1419         cl.event.Broadcast()
1420         // We do this because we've written a chunk, and may change PieceState.Partial.
1421         t.publishPieceChange(pieceIndex(ppReq.Index))
1422
1423         return nil
1424 }
1425
1426 func (c *Peer) onDirtiedPiece(piece pieceIndex) {
1427         if c.peerTouchedPieces == nil {
1428                 c.peerTouchedPieces = make(map[pieceIndex]struct{})
1429         }
1430         c.peerTouchedPieces[piece] = struct{}{}
1431         ds := &c.t.pieces[piece].dirtiers
1432         if *ds == nil {
1433                 *ds = make(map[*Peer]struct{})
1434         }
1435         (*ds)[c] = struct{}{}
1436 }
1437
1438 func (c *PeerConn) uploadAllowed() bool {
1439         if c.t.cl.config.NoUpload {
1440                 return false
1441         }
1442         if c.t.dataUploadDisallowed {
1443                 return false
1444         }
1445         if c.t.seeding() {
1446                 return true
1447         }
1448         if !c.peerHasWantedPieces() {
1449                 return false
1450         }
1451         // Don't upload more than 100 KiB more than we download.
1452         if c._stats.BytesWrittenData.Int64() >= c._stats.BytesReadData.Int64()+100<<10 {
1453                 return false
1454         }
1455         return true
1456 }
1457
1458 func (c *PeerConn) setRetryUploadTimer(delay time.Duration) {
1459         if c.uploadTimer == nil {
1460                 c.uploadTimer = time.AfterFunc(delay, c.tickleWriter)
1461         } else {
1462                 c.uploadTimer.Reset(delay)
1463         }
1464 }
1465
1466 // Also handles choking and unchoking of the remote peer.
1467 func (c *PeerConn) upload(msg func(pp.Message) bool) bool {
1468         // Breaking or completing this loop means we don't want to upload to the
1469         // peer anymore, and we choke them.
1470 another:
1471         for c.uploadAllowed() {
1472                 // We want to upload to the peer.
1473                 if !c.unchoke(msg) {
1474                         return false
1475                 }
1476                 for r, state := range c.peerRequests {
1477                         if state.data == nil {
1478                                 continue
1479                         }
1480                         res := c.t.cl.config.UploadRateLimiter.ReserveN(time.Now(), int(r.Length))
1481                         if !res.OK() {
1482                                 panic(fmt.Sprintf("upload rate limiter burst size < %d", r.Length))
1483                         }
1484                         delay := res.Delay()
1485                         if delay > 0 {
1486                                 res.Cancel()
1487                                 c.setRetryUploadTimer(delay)
1488                                 // Hard to say what to return here.
1489                                 return true
1490                         }
1491                         more := c.sendChunk(r, msg, state)
1492                         delete(c.peerRequests, r)
1493                         if !more {
1494                                 return false
1495                         }
1496                         goto another
1497                 }
1498                 return true
1499         }
1500         return c.choke(msg)
1501 }
1502
1503 func (cn *PeerConn) drop() {
1504         cn.t.dropConnection(cn)
1505 }
1506
1507 func (cn *Peer) netGoodPiecesDirtied() int64 {
1508         return cn._stats.PiecesDirtiedGood.Int64() - cn._stats.PiecesDirtiedBad.Int64()
1509 }
1510
1511 func (c *Peer) peerHasWantedPieces() bool {
1512         if c.peerSentHaveAll {
1513                 return !c.t.haveAllPieces()
1514         }
1515         if !c.t.haveInfo() {
1516                 return !c._peerPieces.IsEmpty()
1517         }
1518         return c._peerPieces.Intersects(&c.t._pendingPieces)
1519 }
1520
1521 func (c *Peer) deleteRequest(r RequestIndex) bool {
1522         if !c.actualRequestState.Requests.CheckedRemove(r) {
1523                 return false
1524         }
1525         c.cancelledRequests.Remove(r)
1526         for _, f := range c.callbacks.DeletedRequest {
1527                 f(PeerRequestEvent{c, c.t.requestIndexToRequest(r)})
1528         }
1529         c.updateExpectingChunks()
1530         c.t.pendingRequests.Dec(r)
1531         return true
1532 }
1533
1534 func (c *Peer) deleteAllRequests() {
1535         c.actualRequestState.Requests.Clone().Iterate(func(x uint32) bool {
1536                 c.deleteRequest(x)
1537                 return true
1538         })
1539         if !c.actualRequestState.Requests.IsEmpty() {
1540                 panic(c.actualRequestState.Requests.GetCardinality())
1541         }
1542 }
1543
1544 // This is called when something has changed that should wake the writer, such as putting stuff into
1545 // the writeBuffer, or changing some state that the writer can act on.
1546 func (c *PeerConn) tickleWriter() {
1547         c.messageWriter.writeCond.Broadcast()
1548 }
1549
1550 func (c *PeerConn) sendChunk(r Request, msg func(pp.Message) bool, state *peerRequestState) (more bool) {
1551         c.lastChunkSent = time.Now()
1552         return msg(pp.Message{
1553                 Type:  pp.Piece,
1554                 Index: r.Index,
1555                 Begin: r.Begin,
1556                 Piece: state.data,
1557         })
1558 }
1559
1560 func (c *PeerConn) setTorrent(t *Torrent) {
1561         if c.t != nil {
1562                 panic("connection already associated with a torrent")
1563         }
1564         c.t = t
1565         c.logger.WithDefaultLevel(log.Debug).Printf("set torrent=%v", t)
1566         t.reconcileHandshakeStats(c)
1567 }
1568
1569 func (c *Peer) peerPriority() (peerPriority, error) {
1570         return bep40Priority(c.remoteIpPort(), c.t.cl.publicAddr(c.remoteIp()))
1571 }
1572
1573 func (c *Peer) remoteIp() net.IP {
1574         host, _, _ := net.SplitHostPort(c.RemoteAddr.String())
1575         return net.ParseIP(host)
1576 }
1577
1578 func (c *Peer) remoteIpPort() IpPort {
1579         ipa, _ := tryIpPortFromNetAddr(c.RemoteAddr)
1580         return IpPort{ipa.IP, uint16(ipa.Port)}
1581 }
1582
1583 func (c *PeerConn) pexPeerFlags() pp.PexPeerFlags {
1584         f := pp.PexPeerFlags(0)
1585         if c.PeerPrefersEncryption {
1586                 f |= pp.PexPrefersEncryption
1587         }
1588         if c.outgoing {
1589                 f |= pp.PexOutgoingConn
1590         }
1591         if c.utp() {
1592                 f |= pp.PexSupportsUtp
1593         }
1594         return f
1595 }
1596
1597 // This returns the address to use if we want to dial the peer again. It incorporates the peer's
1598 // advertised listen port.
1599 func (c *PeerConn) dialAddr() PeerRemoteAddr {
1600         if !c.outgoing && c.PeerListenPort != 0 {
1601                 switch addr := c.RemoteAddr.(type) {
1602                 case *net.TCPAddr:
1603                         dialAddr := *addr
1604                         dialAddr.Port = c.PeerListenPort
1605                         return &dialAddr
1606                 case *net.UDPAddr:
1607                         dialAddr := *addr
1608                         dialAddr.Port = c.PeerListenPort
1609                         return &dialAddr
1610                 }
1611         }
1612         return c.RemoteAddr
1613 }
1614
1615 func (c *PeerConn) pexEvent(t pexEventType) pexEvent {
1616         f := c.pexPeerFlags()
1617         addr := c.dialAddr()
1618         return pexEvent{t, addr, f}
1619 }
1620
1621 func (c *PeerConn) String() string {
1622         return fmt.Sprintf("connection %p", c)
1623 }
1624
1625 func (c *Peer) trust() connectionTrust {
1626         return connectionTrust{c.trusted, c.netGoodPiecesDirtied()}
1627 }
1628
1629 type connectionTrust struct {
1630         Implicit            bool
1631         NetGoodPiecesDirted int64
1632 }
1633
1634 func (l connectionTrust) Less(r connectionTrust) bool {
1635         return multiless.New().Bool(l.Implicit, r.Implicit).Int64(l.NetGoodPiecesDirted, r.NetGoodPiecesDirted).Less()
1636 }
1637
1638 // Returns the pieces the peer could have based on their claims. If we don't know how many pieces
1639 // are in the torrent, it could be a very large range the peer has sent HaveAll.
1640 func (cn *PeerConn) PeerPieces() *roaring.Bitmap {
1641         cn.locker().RLock()
1642         defer cn.locker().RUnlock()
1643         return cn.newPeerPieces()
1644 }
1645
1646 // Returns a new Bitmap that includes bits for all pieces the peer could have based on their claims.
1647 func (cn *Peer) newPeerPieces() *roaring.Bitmap {
1648         // TODO: Can we use copy on write?
1649         ret := cn._peerPieces.Clone()
1650         if cn.peerSentHaveAll {
1651                 if cn.t.haveInfo() {
1652                         ret.AddRange(0, bitmap.BitRange(cn.t.numPieces()))
1653                 } else {
1654                         ret.AddRange(0, bitmap.ToEnd)
1655                 }
1656         }
1657         return ret
1658 }
1659
1660 func (cn *Peer) stats() *ConnStats {
1661         return &cn._stats
1662 }
1663
1664 func (p *Peer) TryAsPeerConn() (*PeerConn, bool) {
1665         pc, ok := p.peerImpl.(*PeerConn)
1666         return pc, ok
1667 }
1668
1669 func (pc *PeerConn) isLowOnRequests() bool {
1670         return pc.actualRequestState.Requests.IsEmpty()
1671 }