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