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