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