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