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