torrent.go

   1 package torrent
   2
   3 import (
   4         "bytes"
   5         "container/heap"
   6         "context"
   7         "crypto/sha1"
   8         "errors"
   9         "fmt"
  10         "io"
  11         "net/url"
  12         "sort"
  13         "strings"
  14         "text/tabwriter"
  15         "time"
  16         "unsafe"
  17
  18         "github.com/RoaringBitmap/roaring"
  19         "github.com/anacrolix/chansync"
  20         "github.com/anacrolix/chansync/events"
  21         "github.com/anacrolix/dht/v2"
  22         "github.com/anacrolix/log"
  23         "github.com/anacrolix/missinggo/perf"
  24         "github.com/anacrolix/missinggo/pubsub"
  25         "github.com/anacrolix/missinggo/slices"
  26         "github.com/anacrolix/missinggo/v2"
  27         "github.com/anacrolix/missinggo/v2/bitmap"
  28         "github.com/anacrolix/multiless"
  29         "github.com/anacrolix/sync"
  30         request_strategy "github.com/anacrolix/torrent/request-strategy"
  31         "github.com/davecgh/go-spew/spew"
  32         "github.com/pion/datachannel"
  33
  34         "github.com/anacrolix/torrent/bencode"
  35         "github.com/anacrolix/torrent/common"
  36         "github.com/anacrolix/torrent/metainfo"
  37         pp "github.com/anacrolix/torrent/peer_protocol"
  38         "github.com/anacrolix/torrent/segments"
  39         "github.com/anacrolix/torrent/storage"
  40         "github.com/anacrolix/torrent/tracker"
  41         "github.com/anacrolix/torrent/webseed"
  42         "github.com/anacrolix/torrent/webtorrent"
  43 )
  44
  45 // Maintains state of torrent within a Client. Many methods should not be called before the info is
  46 // available, see .Info and .GotInfo.
  47 type Torrent struct {
  48         // Torrent-level aggregate statistics. First in struct to ensure 64-bit
  49         // alignment. See #262.
  50         stats  ConnStats
  51         cl     *Client
  52         logger log.Logger
  53
  54         networkingEnabled      chansync.Flag
  55         dataDownloadDisallowed chansync.Flag
  56         dataUploadDisallowed   bool
  57         userOnWriteChunkErr    func(error)
  58
  59         closed   chansync.SetOnce
  60         infoHash metainfo.Hash
  61         pieces   []Piece
  62         // Values are the piece indices that changed.
  63         pieceStateChanges *pubsub.PubSub
  64         // The size of chunks to request from peers over the wire. This is
  65         // normally 16KiB by convention these days.
  66         chunkSize pp.Integer
  67         chunkPool sync.Pool
  68         // Total length of the torrent in bytes. Stored because it's not O(1) to
  69         // get this from the info dict.
  70         length *int64
  71
  72         // The storage to open when the info dict becomes available.
  73         storageOpener *storage.Client
  74         // Storage for torrent data.
  75         storage *storage.Torrent
  76         // Read-locked for using storage, and write-locked for Closing.
  77         storageLock sync.RWMutex
  78
  79         // TODO: Only announce stuff is used?
  80         metainfo metainfo.MetaInfo
  81
  82         // The info dict. nil if we don't have it (yet).
  83         info      *metainfo.Info
  84         fileIndex segments.Index
  85         files     *[]*File
  86
  87         webSeeds map[string]*Peer
  88
  89         // Active peer connections, running message stream loops. TODO: Make this
  90         // open (not-closed) connections only.
  91         conns               map[*PeerConn]struct{}
  92         maxEstablishedConns int
  93         // Set of addrs to which we're attempting to connect. Connections are
  94         // half-open until all handshakes are completed.
  95         halfOpen map[string]PeerInfo
  96
  97         // Reserve of peers to connect to. A peer can be both here and in the
  98         // active connections if were told about the peer after connecting with
  99         // them. That encourages us to reconnect to peers that are well known in
 100         // the swarm.
 101         peers prioritizedPeers
 102         // Whether we want to know to know more peers.
 103         wantPeersEvent missinggo.Event
 104         // An announcer for each tracker URL.
 105         trackerAnnouncers map[string]torrentTrackerAnnouncer
 106         // How many times we've initiated a DHT announce. TODO: Move into stats.
 107         numDHTAnnounces int
 108
 109         // Name used if the info name isn't available. Should be cleared when the
 110         // Info does become available.
 111         nameMu      sync.RWMutex
 112         displayName string
 113
 114         // The bencoded bytes of the info dict. This is actively manipulated if
 115         // the info bytes aren't initially available, and we try to fetch them
 116         // from peers.
 117         metadataBytes []byte
 118         // Each element corresponds to the 16KiB metadata pieces. If true, we have
 119         // received that piece.
 120         metadataCompletedChunks []bool
 121         metadataChanged         sync.Cond
 122
 123         // Closed when .Info is obtained.
 124         gotMetainfoC chan struct{}
 125
 126         readers                map[*reader]struct{}
 127         _readerNowPieces       bitmap.Bitmap
 128         _readerReadaheadPieces bitmap.Bitmap
 129
 130         // A cache of pieces we need to get. Calculated from various piece and
 131         // file priorities and completion states elsewhere.
 132         _pendingPieces roaring.Bitmap
 133         // A cache of completed piece indices.
 134         _completedPieces roaring.Bitmap
 135         // Pieces that need to be hashed.
 136         piecesQueuedForHash       bitmap.Bitmap
 137         activePieceHashes         int
 138         initialPieceCheckDisabled bool
 139
 140         // Count of each request across active connections.
 141         pendingRequests map[RequestIndex]*Peer
 142         lastRequested   map[RequestIndex]time.Time
 143         // Chunks we've written to since the corresponding piece was last checked.
 144         dirtyChunks roaring.Bitmap
 145
 146         pex pexState
 147
 148         // Is On when all pieces are complete.
 149         Complete chansync.Flag
 150 }
 151
 152 func (t *Torrent) pieceAvailabilityFromPeers(i pieceIndex) (count int) {
 153         t.iterPeers(func(peer *Peer) {
 154                 if peer.peerHasPiece(i) {
 155                         count++
 156                 }
 157         })
 158         return
 159 }
 160
 161 func (t *Torrent) decPieceAvailability(i pieceIndex) {
 162         if !t.haveInfo() {
 163                 return
 164         }
 165         p := t.piece(i)
 166         if p.availability <= 0 {
 167                 panic(p.availability)
 168         }
 169         p.availability--
 170         t.updatePieceRequestOrder(i)
 171 }
 172
 173 func (t *Torrent) incPieceAvailability(i pieceIndex) {
 174         // If we don't the info, this should be reconciled when we do.
 175         if t.haveInfo() {
 176                 p := t.piece(i)
 177                 p.availability++
 178                 t.updatePieceRequestOrder(i)
 179         }
 180 }
 181
 182 func (t *Torrent) readerNowPieces() bitmap.Bitmap {
 183         return t._readerNowPieces
 184 }
 185
 186 func (t *Torrent) readerReadaheadPieces() bitmap.Bitmap {
 187         return t._readerReadaheadPieces
 188 }
 189
 190 func (t *Torrent) ignorePieceForRequests(i pieceIndex) bool {
 191         return !t.wantPieceIndex(i)
 192 }
 193
 194 // Returns a channel that is closed when the Torrent is closed.
 195 func (t *Torrent) Closed() events.Done {
 196         return t.closed.Done()
 197 }
 198
 199 // KnownSwarm returns the known subset of the peers in the Torrent's swarm, including active,
 200 // pending, and half-open peers.
 201 func (t *Torrent) KnownSwarm() (ks []PeerInfo) {
 202         // Add pending peers to the list
 203         t.peers.Each(func(peer PeerInfo) {
 204                 ks = append(ks, peer)
 205         })
 206
 207         // Add half-open peers to the list
 208         for _, peer := range t.halfOpen {
 209                 ks = append(ks, peer)
 210         }
 211
 212         // Add active peers to the list
 213         for conn := range t.conns {
 214                 ks = append(ks, PeerInfo{
 215                         Id:     conn.PeerID,
 216                         Addr:   conn.RemoteAddr,
 217                         Source: conn.Discovery,
 218                         // > If the connection is encrypted, that's certainly enough to set SupportsEncryption.
 219                         // > But if we're not connected to them with an encrypted connection, I couldn't say
 220                         // > what's appropriate. We can carry forward the SupportsEncryption value as we
 221                         // > received it from trackers/DHT/PEX, or just use the encryption state for the
 222                         // > connection. It's probably easiest to do the latter for now.
 223                         // https://github.com/anacrolix/torrent/pull/188
 224                         SupportsEncryption: conn.headerEncrypted,
 225                 })
 226         }
 227
 228         return
 229 }
 230
 231 func (t *Torrent) setChunkSize(size pp.Integer) {
 232         t.chunkSize = size
 233         t.chunkPool = sync.Pool{
 234                 New: func() interface{} {
 235                         b := make([]byte, size)
 236                         return &b
 237                 },
 238         }
 239 }
 240
 241 func (t *Torrent) pieceComplete(piece pieceIndex) bool {
 242         return t._completedPieces.Contains(bitmap.BitIndex(piece))
 243 }
 244
 245 func (t *Torrent) pieceCompleteUncached(piece pieceIndex) storage.Completion {
 246         return t.pieces[piece].Storage().Completion()
 247 }
 248
 249 // There's a connection to that address already.
 250 func (t *Torrent) addrActive(addr string) bool {
 251         if _, ok := t.halfOpen[addr]; ok {
 252                 return true
 253         }
 254         for c := range t.conns {
 255                 ra := c.RemoteAddr
 256                 if ra.String() == addr {
 257                         return true
 258                 }
 259         }
 260         return false
 261 }
 262
 263 func (t *Torrent) appendUnclosedConns(ret []*PeerConn) []*PeerConn {
 264         return t.appendConns(ret, func(conn *PeerConn) bool {
 265                 return !conn.closed.IsSet()
 266         })
 267 }
 268
 269 func (t *Torrent) appendConns(ret []*PeerConn, f func(*PeerConn) bool) []*PeerConn {
 270         for c := range t.conns {
 271                 if f(c) {
 272                         ret = append(ret, c)
 273                 }
 274         }
 275         return ret
 276 }
 277
 278 func (t *Torrent) addPeer(p PeerInfo) (added bool) {
 279         cl := t.cl
 280         torrent.Add(fmt.Sprintf("peers added by source %q", p.Source), 1)
 281         if t.closed.IsSet() {
 282                 return false
 283         }
 284         if ipAddr, ok := tryIpPortFromNetAddr(p.Addr); ok {
 285                 if cl.badPeerIPPort(ipAddr.IP, ipAddr.Port) {
 286                         torrent.Add("peers not added because of bad addr", 1)
 287                         // cl.logger.Printf("peers not added because of bad addr: %v", p)
 288                         return false
 289                 }
 290         }
 291         if replaced, ok := t.peers.AddReturningReplacedPeer(p); ok {
 292                 torrent.Add("peers replaced", 1)
 293                 if !replaced.equal(p) {
 294                         t.logger.WithDefaultLevel(log.Debug).Printf("added %v replacing %v", p, replaced)
 295                         added = true
 296                 }
 297         } else {
 298                 added = true
 299         }
 300         t.openNewConns()
 301         for t.peers.Len() > cl.config.TorrentPeersHighWater {
 302                 _, ok := t.peers.DeleteMin()
 303                 if ok {
 304                         torrent.Add("excess reserve peers discarded", 1)
 305                 }
 306         }
 307         return
 308 }
 309
 310 func (t *Torrent) invalidateMetadata() {
 311         for i := 0; i < len(t.metadataCompletedChunks); i++ {
 312                 t.metadataCompletedChunks[i] = false
 313         }
 314         t.nameMu.Lock()
 315         t.gotMetainfoC = make(chan struct{})
 316         t.info = nil
 317         t.nameMu.Unlock()
 318 }
 319
 320 func (t *Torrent) saveMetadataPiece(index int, data []byte) {
 321         if t.haveInfo() {
 322                 return
 323         }
 324         if index >= len(t.metadataCompletedChunks) {
 325                 t.logger.Printf("%s: ignoring metadata piece %d", t, index)
 326                 return
 327         }
 328         copy(t.metadataBytes[(1<<14)*index:], data)
 329         t.metadataCompletedChunks[index] = true
 330 }
 331
 332 func (t *Torrent) metadataPieceCount() int {
 333         return (len(t.metadataBytes) + (1 << 14) - 1) / (1 << 14)
 334 }
 335
 336 func (t *Torrent) haveMetadataPiece(piece int) bool {
 337         if t.haveInfo() {
 338                 return (1<<14)*piece < len(t.metadataBytes)
 339         } else {
 340                 return piece < len(t.metadataCompletedChunks) && t.metadataCompletedChunks[piece]
 341         }
 342 }
 343
 344 func (t *Torrent) metadataSize() int {
 345         return len(t.metadataBytes)
 346 }
 347
 348 func infoPieceHashes(info *metainfo.Info) (ret [][]byte) {
 349         for i := 0; i < len(info.Pieces); i += sha1.Size {
 350                 ret = append(ret, info.Pieces[i:i+sha1.Size])
 351         }
 352         return
 353 }
 354
 355 func (t *Torrent) makePieces() {
 356         hashes := infoPieceHashes(t.info)
 357         t.pieces = make([]Piece, len(hashes))
 358         for i, hash := range hashes {
 359                 piece := &t.pieces[i]
 360                 piece.t = t
 361                 piece.index = pieceIndex(i)
 362                 piece.noPendingWrites.L = &piece.pendingWritesMutex
 363                 piece.hash = (*metainfo.Hash)(unsafe.Pointer(&hash[0]))
 364                 files := *t.files
 365                 beginFile := pieceFirstFileIndex(piece.torrentBeginOffset(), files)
 366                 endFile := pieceEndFileIndex(piece.torrentEndOffset(), files)
 367                 piece.files = files[beginFile:endFile]
 368                 piece.undirtiedChunksIter = undirtiedChunksIter{
 369                         TorrentDirtyChunks: &t.dirtyChunks,
 370                         StartRequestIndex:  piece.requestIndexOffset(),
 371                         EndRequestIndex:    piece.requestIndexOffset() + piece.numChunks(),
 372                 }
 373         }
 374 }
 375
 376 // Returns the index of the first file containing the piece. files must be
 377 // ordered by offset.
 378 func pieceFirstFileIndex(pieceOffset int64, files []*File) int {
 379         for i, f := range files {
 380                 if f.offset+f.length > pieceOffset {
 381                         return i
 382                 }
 383         }
 384         return 0
 385 }
 386
 387 // Returns the index after the last file containing the piece. files must be
 388 // ordered by offset.
 389 func pieceEndFileIndex(pieceEndOffset int64, files []*File) int {
 390         for i, f := range files {
 391                 if f.offset+f.length >= pieceEndOffset {
 392                         return i + 1
 393                 }
 394         }
 395         return 0
 396 }
 397
 398 func (t *Torrent) cacheLength() {
 399         var l int64
 400         for _, f := range t.info.UpvertedFiles() {
 401                 l += f.Length
 402         }
 403         t.length = &l
 404 }
 405
 406 // TODO: This shouldn't fail for storage reasons. Instead we should handle storage failure
 407 // separately.
 408 func (t *Torrent) setInfo(info *metainfo.Info) error {
 409         if err := validateInfo(info); err != nil {
 410                 return fmt.Errorf("bad info: %s", err)
 411         }
 412         if t.storageOpener != nil {
 413                 var err error
 414                 t.storage, err = t.storageOpener.OpenTorrent(info, t.infoHash)
 415                 if err != nil {
 416                         return fmt.Errorf("error opening torrent storage: %s", err)
 417                 }
 418         }
 419         t.nameMu.Lock()
 420         t.info = info
 421         t.nameMu.Unlock()
 422         t.updateComplete()
 423         t.fileIndex = segments.NewIndex(common.LengthIterFromUpvertedFiles(info.UpvertedFiles()))
 424         t.displayName = "" // Save a few bytes lol.
 425         t.initFiles()
 426         t.cacheLength()
 427         t.makePieces()
 428         return nil
 429 }
 430
 431 func (t *Torrent) pieceRequestOrderKey(i int) request_strategy.PieceRequestOrderKey {
 432         return request_strategy.PieceRequestOrderKey{
 433                 InfoHash: t.infoHash,
 434                 Index:    i,
 435         }
 436 }
 437
 438 // This seems to be all the follow-up tasks after info is set, that can't fail.
 439 func (t *Torrent) onSetInfo() {
 440         t.initPieceRequestOrder()
 441         for i := range t.pieces {
 442                 p := &t.pieces[i]
 443                 // Need to add availability before updating piece completion, as that may result in conns
 444                 // being dropped.
 445                 if p.availability != 0 {
 446                         panic(p.availability)
 447                 }
 448                 p.availability = int64(t.pieceAvailabilityFromPeers(i))
 449                 t.addRequestOrderPiece(i)
 450                 t.updatePieceCompletion(pieceIndex(i))
 451                 if !t.initialPieceCheckDisabled && !p.storageCompletionOk {
 452                         // t.logger.Printf("piece %s completion unknown, queueing check", p)
 453                         t.queuePieceCheck(pieceIndex(i))
 454                 }
 455         }
 456         t.cl.event.Broadcast()
 457         close(t.gotMetainfoC)
 458         t.updateWantPeersEvent()
 459         t.pendingRequests = make(map[RequestIndex]*Peer)
 460         t.lastRequested = make(map[RequestIndex]time.Time)
 461         t.tryCreateMorePieceHashers()
 462         t.iterPeers(func(p *Peer) {
 463                 p.onGotInfo(t.info)
 464                 p.updateRequests("onSetInfo")
 465         })
 466 }
 467
 468 // Called when metadata for a torrent becomes available.
 469 func (t *Torrent) setInfoBytesLocked(b []byte) error {
 470         if metainfo.HashBytes(b) != t.infoHash {
 471                 return errors.New("info bytes have wrong hash")
 472         }
 473         var info metainfo.Info
 474         if err := bencode.Unmarshal(b, &info); err != nil {
 475                 return fmt.Errorf("error unmarshalling info bytes: %s", err)
 476         }
 477         t.metadataBytes = b
 478         t.metadataCompletedChunks = nil
 479         if t.info != nil {
 480                 return nil
 481         }
 482         if err := t.setInfo(&info); err != nil {
 483                 return err
 484         }
 485         t.onSetInfo()
 486         return nil
 487 }
 488
 489 func (t *Torrent) haveAllMetadataPieces() bool {
 490         if t.haveInfo() {
 491                 return true
 492         }
 493         if t.metadataCompletedChunks == nil {
 494                 return false
 495         }
 496         for _, have := range t.metadataCompletedChunks {
 497                 if !have {
 498                         return false
 499                 }
 500         }
 501         return true
 502 }
 503
 504 // TODO: Propagate errors to disconnect peer.
 505 func (t *Torrent) setMetadataSize(size int) (err error) {
 506         if t.haveInfo() {
 507                 // We already know the correct metadata size.
 508                 return
 509         }
 510         if uint32(size) > maxMetadataSize {
 511                 return errors.New("bad size")
 512         }
 513         if len(t.metadataBytes) == size {
 514                 return
 515         }
 516         t.metadataBytes = make([]byte, size)
 517         t.metadataCompletedChunks = make([]bool, (size+(1<<14)-1)/(1<<14))
 518         t.metadataChanged.Broadcast()
 519         for c := range t.conns {
 520                 c.requestPendingMetadata()
 521         }
 522         return
 523 }
 524
 525 // The current working name for the torrent. Either the name in the info dict,
 526 // or a display name given such as by the dn value in a magnet link, or "".
 527 func (t *Torrent) name() string {
 528         t.nameMu.RLock()
 529         defer t.nameMu.RUnlock()
 530         if t.haveInfo() {
 531                 return t.info.Name
 532         }
 533         if t.displayName != "" {
 534                 return t.displayName
 535         }
 536         return "infohash:" + t.infoHash.HexString()
 537 }
 538
 539 func (t *Torrent) pieceState(index pieceIndex) (ret PieceState) {
 540         p := &t.pieces[index]
 541         ret.Priority = t.piecePriority(index)
 542         ret.Completion = p.completion()
 543         ret.QueuedForHash = p.queuedForHash()
 544         ret.Hashing = p.hashing
 545         ret.Checking = ret.QueuedForHash || ret.Hashing
 546         ret.Marking = p.marking
 547         if !ret.Complete && t.piecePartiallyDownloaded(index) {
 548                 ret.Partial = true
 549         }
 550         return
 551 }
 552
 553 func (t *Torrent) metadataPieceSize(piece int) int {
 554         return metadataPieceSize(len(t.metadataBytes), piece)
 555 }
 556
 557 func (t *Torrent) newMetadataExtensionMessage(c *PeerConn, msgType pp.ExtendedMetadataRequestMsgType, piece int, data []byte) pp.Message {
 558         return pp.Message{
 559                 Type:       pp.Extended,
 560                 ExtendedID: c.PeerExtensionIDs[pp.ExtensionNameMetadata],
 561                 ExtendedPayload: append(bencode.MustMarshal(pp.ExtendedMetadataRequestMsg{
 562                         Piece:     piece,
 563                         TotalSize: len(t.metadataBytes),
 564                         Type:      msgType,
 565                 }), data...),
 566         }
 567 }
 568
 569 type pieceAvailabilityRun struct {
 570         count        pieceIndex
 571         availability int64
 572 }
 573
 574 func (me pieceAvailabilityRun) String() string {
 575         return fmt.Sprintf("%v(%v)", me.count, me.availability)
 576 }
 577
 578 func (t *Torrent) pieceAvailabilityRuns() (ret []pieceAvailabilityRun) {
 579         rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
 580                 ret = append(ret, pieceAvailabilityRun{availability: el.(int64), count: int(count)})
 581         })
 582         for i := range t.pieces {
 583                 rle.Append(t.pieces[i].availability, 1)
 584         }
 585         rle.Flush()
 586         return
 587 }
 588
 589 func (t *Torrent) pieceStateRuns() (ret PieceStateRuns) {
 590         rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
 591                 ret = append(ret, PieceStateRun{
 592                         PieceState: el.(PieceState),
 593                         Length:     int(count),
 594                 })
 595         })
 596         for index := range t.pieces {
 597                 rle.Append(t.pieceState(pieceIndex(index)), 1)
 598         }
 599         rle.Flush()
 600         return
 601 }
 602
 603 // Produces a small string representing a PieceStateRun.
 604 func (psr PieceStateRun) String() (ret string) {
 605         ret = fmt.Sprintf("%d", psr.Length)
 606         ret += func() string {
 607                 switch psr.Priority {
 608                 case PiecePriorityNext:
 609                         return "N"
 610                 case PiecePriorityNormal:
 611                         return "."
 612                 case PiecePriorityReadahead:
 613                         return "R"
 614                 case PiecePriorityNow:
 615                         return "!"
 616                 case PiecePriorityHigh:
 617                         return "H"
 618                 default:
 619                         return ""
 620                 }
 621         }()
 622         if psr.Hashing {
 623                 ret += "H"
 624         }
 625         if psr.QueuedForHash {
 626                 ret += "Q"
 627         }
 628         if psr.Marking {
 629                 ret += "M"
 630         }
 631         if psr.Partial {
 632                 ret += "P"
 633         }
 634         if psr.Complete {
 635                 ret += "C"
 636         }
 637         if !psr.Ok {
 638                 ret += "?"
 639         }
 640         return
 641 }
 642
 643 func (t *Torrent) writeStatus(w io.Writer) {
 644         fmt.Fprintf(w, "Infohash: %s\n", t.infoHash.HexString())
 645         fmt.Fprintf(w, "Metadata length: %d\n", t.metadataSize())
 646         if !t.haveInfo() {
 647                 fmt.Fprintf(w, "Metadata have: ")
 648                 for _, h := range t.metadataCompletedChunks {
 649                         fmt.Fprintf(w, "%c", func() rune {
 650                                 if h {
 651                                         return 'H'
 652                                 } else {
 653                                         return '.'
 654                                 }
 655                         }())
 656                 }
 657                 fmt.Fprintln(w)
 658         }
 659         fmt.Fprintf(w, "Piece length: %s\n",
 660                 func() string {
 661                         if t.haveInfo() {
 662                                 return fmt.Sprintf("%v (%v chunks)",
 663                                         t.usualPieceSize(),
 664                                         float64(t.usualPieceSize())/float64(t.chunkSize))
 665                         } else {
 666                                 return "no info"
 667                         }
 668                 }(),
 669         )
 670         if t.info != nil {
 671                 fmt.Fprintf(w, "Num Pieces: %d (%d completed)\n", t.numPieces(), t.numPiecesCompleted())
 672                 fmt.Fprintf(w, "Piece States: %s\n", t.pieceStateRuns())
 673                 fmt.Fprintf(w, "Piece availability: %v\n", strings.Join(func() (ret []string) {
 674                         for _, run := range t.pieceAvailabilityRuns() {
 675                                 ret = append(ret, run.String())
 676                         }
 677                         return
 678                 }(), " "))
 679         }
 680         fmt.Fprintf(w, "Reader Pieces:")
 681         t.forReaderOffsetPieces(func(begin, end pieceIndex) (again bool) {
 682                 fmt.Fprintf(w, " %d:%d", begin, end)
 683                 return true
 684         })
 685         fmt.Fprintln(w)
 686
 687         fmt.Fprintf(w, "Enabled trackers:\n")
 688         func() {
 689                 tw := tabwriter.NewWriter(w, 0, 0, 2, ' ', 0)
 690                 fmt.Fprintf(tw, "    URL\tExtra\n")
 691                 for _, ta := range slices.Sort(slices.FromMapElems(t.trackerAnnouncers), func(l, r torrentTrackerAnnouncer) bool {
 692                         lu := l.URL()
 693                         ru := r.URL()
 694                         var luns, runs url.URL = *lu, *ru
 695                         luns.Scheme = ""
 696                         runs.Scheme = ""
 697                         var ml missinggo.MultiLess
 698                         ml.StrictNext(luns.String() == runs.String(), luns.String() < runs.String())
 699                         ml.StrictNext(lu.String() == ru.String(), lu.String() < ru.String())
 700                         return ml.Less()
 701                 }).([]torrentTrackerAnnouncer) {
 702                         fmt.Fprintf(tw, "    %q\t%v\n", ta.URL(), ta.statusLine())
 703                 }
 704                 tw.Flush()
 705         }()
 706
 707         fmt.Fprintf(w, "DHT Announces: %d\n", t.numDHTAnnounces)
 708
 709         spew.NewDefaultConfig()
 710         spew.Fdump(w, t.statsLocked())
 711
 712         peers := t.peersAsSlice()
 713         sort.Slice(peers, func(_i, _j int) bool {
 714                 i := peers[_i]
 715                 j := peers[_j]
 716                 if less, ok := multiless.New().EagerSameLess(
 717                         i.downloadRate() == j.downloadRate(), i.downloadRate() < j.downloadRate(),
 718                 ).LessOk(); ok {
 719                         return less
 720                 }
 721                 return worseConn(i, j)
 722         })
 723         for i, c := range peers {
 724                 fmt.Fprintf(w, "%2d. ", i+1)
 725                 c.writeStatus(w, t)
 726         }
 727 }
 728
 729 func (t *Torrent) haveInfo() bool {
 730         return t.info != nil
 731 }
 732
 733 // Returns a run-time generated MetaInfo that includes the info bytes and
 734 // announce-list as currently known to the client.
 735 func (t *Torrent) newMetaInfo() metainfo.MetaInfo {
 736         return metainfo.MetaInfo{
 737                 CreationDate: time.Now().Unix(),
 738                 Comment:      "dynamic metainfo from client",
 739                 CreatedBy:    "go.torrent",
 740                 AnnounceList: t.metainfo.UpvertedAnnounceList().Clone(),
 741                 InfoBytes: func() []byte {
 742                         if t.haveInfo() {
 743                                 return t.metadataBytes
 744                         } else {
 745                                 return nil
 746                         }
 747                 }(),
 748                 UrlList: func() []string {
 749                         ret := make([]string, 0, len(t.webSeeds))
 750                         for url := range t.webSeeds {
 751                                 ret = append(ret, url)
 752                         }
 753                         return ret
 754                 }(),
 755         }
 756 }
 757
 758 // Get bytes left
 759 func (t *Torrent) BytesMissing() (n int64) {
 760         t.cl.rLock()
 761         n = t.bytesMissingLocked()
 762         t.cl.rUnlock()
 763         return
 764 }
 765
 766 func (t *Torrent) bytesMissingLocked() int64 {
 767         return t.bytesLeft()
 768 }
 769
 770 func iterFlipped(b *roaring.Bitmap, end uint64, cb func(uint32) bool) {
 771         roaring.Flip(b, 0, end).Iterate(cb)
 772 }
 773
 774 func (t *Torrent) bytesLeft() (left int64) {
 775         iterFlipped(&t._completedPieces, uint64(t.numPieces()), func(x uint32) bool {
 776                 p := t.piece(pieceIndex(x))
 777                 left += int64(p.length() - p.numDirtyBytes())
 778                 return true
 779         })
 780         return
 781 }
 782
 783 // Bytes left to give in tracker announces.
 784 func (t *Torrent) bytesLeftAnnounce() int64 {
 785         if t.haveInfo() {
 786                 return t.bytesLeft()
 787         } else {
 788                 return -1
 789         }
 790 }
 791
 792 func (t *Torrent) piecePartiallyDownloaded(piece pieceIndex) bool {
 793         if t.pieceComplete(piece) {
 794                 return false
 795         }
 796         if t.pieceAllDirty(piece) {
 797                 return false
 798         }
 799         return t.pieces[piece].hasDirtyChunks()
 800 }
 801
 802 func (t *Torrent) usualPieceSize() int {
 803         return int(t.info.PieceLength)
 804 }
 805
 806 func (t *Torrent) numPieces() pieceIndex {
 807         return pieceIndex(t.info.NumPieces())
 808 }
 809
 810 func (t *Torrent) numPiecesCompleted() (num pieceIndex) {
 811         return pieceIndex(t._completedPieces.GetCardinality())
 812 }
 813
 814 func (t *Torrent) close(wg *sync.WaitGroup) (err error) {
 815         t.closed.Set()
 816         if t.storage != nil {
 817                 wg.Add(1)
 818                 go func() {
 819                         defer wg.Done()
 820                         t.storageLock.Lock()
 821                         defer t.storageLock.Unlock()
 822                         if f := t.storage.Close; f != nil {
 823                                 err1 := f()
 824                                 if err1 != nil {
 825                                         t.logger.WithDefaultLevel(log.Warning).Printf("error closing storage: %v", err1)
 826                                 }
 827                         }
 828                 }()
 829         }
 830         t.iterPeers(func(p *Peer) {
 831                 p.close()
 832         })
 833         if t.storage != nil {
 834                 t.deletePieceRequestOrder()
 835         }
 836         t.pex.Reset()
 837         t.cl.event.Broadcast()
 838         t.pieceStateChanges.Close()
 839         t.updateWantPeersEvent()
 840         return
 841 }
 842
 843 func (t *Torrent) requestOffset(r Request) int64 {
 844         return torrentRequestOffset(*t.length, int64(t.usualPieceSize()), r)
 845 }
 846
 847 // Return the request that would include the given offset into the torrent data. Returns !ok if
 848 // there is no such request.
 849 func (t *Torrent) offsetRequest(off int64) (req Request, ok bool) {
 850         return torrentOffsetRequest(*t.length, t.info.PieceLength, int64(t.chunkSize), off)
 851 }
 852
 853 func (t *Torrent) writeChunk(piece int, begin int64, data []byte) (err error) {
 854         defer perf.ScopeTimerErr(&err)()
 855         n, err := t.pieces[piece].Storage().WriteAt(data, begin)
 856         if err == nil && n != len(data) {
 857                 err = io.ErrShortWrite
 858         }
 859         return err
 860 }
 861
 862 func (t *Torrent) bitfield() (bf []bool) {
 863         bf = make([]bool, t.numPieces())
 864         t._completedPieces.Iterate(func(piece uint32) (again bool) {
 865                 bf[piece] = true
 866                 return true
 867         })
 868         return
 869 }
 870
 871 func (t *Torrent) pieceNumChunks(piece pieceIndex) chunkIndexType {
 872         return chunkIndexType((t.pieceLength(piece) + t.chunkSize - 1) / t.chunkSize)
 873 }
 874
 875 func (t *Torrent) chunksPerRegularPiece() uint32 {
 876         return uint32((pp.Integer(t.usualPieceSize()) + t.chunkSize - 1) / t.chunkSize)
 877 }
 878
 879 func (t *Torrent) numRequests() RequestIndex {
 880         if t.numPieces() == 0 {
 881                 return 0
 882         }
 883         return uint32(t.numPieces()-1)*t.chunksPerRegularPiece() + t.pieceNumChunks(t.numPieces()-1)
 884 }
 885
 886 func (t *Torrent) pendAllChunkSpecs(pieceIndex pieceIndex) {
 887         t.dirtyChunks.RemoveRange(
 888                 uint64(t.pieceRequestIndexOffset(pieceIndex)),
 889                 uint64(t.pieceRequestIndexOffset(pieceIndex+1)))
 890 }
 891
 892 func (t *Torrent) pieceLength(piece pieceIndex) pp.Integer {
 893         if t.info.PieceLength == 0 {
 894                 // There will be no variance amongst pieces. Only pain.
 895                 return 0
 896         }
 897         if piece == t.numPieces()-1 {
 898                 ret := pp.Integer(*t.length % t.info.PieceLength)
 899                 if ret != 0 {
 900                         return ret
 901                 }
 902         }
 903         return pp.Integer(t.info.PieceLength)
 904 }
 905
 906 func (t *Torrent) hashPiece(piece pieceIndex) (ret metainfo.Hash, err error) {
 907         p := t.piece(piece)
 908         p.waitNoPendingWrites()
 909         storagePiece := t.pieces[piece].Storage()
 910
 911         // Does the backend want to do its own hashing?
 912         if i, ok := storagePiece.PieceImpl.(storage.SelfHashing); ok {
 913                 var sum metainfo.Hash
 914                 // log.Printf("A piece decided to self-hash: %d", piece)
 915                 sum, err = i.SelfHash()
 916                 missinggo.CopyExact(&ret, sum)
 917                 return
 918         }
 919
 920         hash := pieceHash.New()
 921         const logPieceContents = false
 922         if logPieceContents {
 923                 var examineBuf bytes.Buffer
 924                 _, err = storagePiece.WriteTo(io.MultiWriter(hash, &examineBuf))
 925                 log.Printf("hashed %q with copy err %v", examineBuf.Bytes(), err)
 926         } else {
 927                 _, err = storagePiece.WriteTo(hash)
 928         }
 929         missinggo.CopyExact(&ret, hash.Sum(nil))
 930         return
 931 }
 932
 933 func (t *Torrent) haveAnyPieces() bool {
 934         return !t._completedPieces.IsEmpty()
 935 }
 936
 937 func (t *Torrent) haveAllPieces() bool {
 938         if !t.haveInfo() {
 939                 return false
 940         }
 941         return t._completedPieces.GetCardinality() == bitmap.BitRange(t.numPieces())
 942 }
 943
 944 func (t *Torrent) havePiece(index pieceIndex) bool {
 945         return t.haveInfo() && t.pieceComplete(index)
 946 }
 947
 948 func (t *Torrent) maybeDropMutuallyCompletePeer(
 949         // I'm not sure about taking peer here, not all peer implementations actually drop. Maybe that's
 950         // okay?
 951         p *Peer,
 952 ) {
 953         if !t.cl.config.DropMutuallyCompletePeers {
 954                 return
 955         }
 956         if !t.haveAllPieces() {
 957                 return
 958         }
 959         if all, known := p.peerHasAllPieces(); !(known && all) {
 960                 return
 961         }
 962         if p.useful() {
 963                 return
 964         }
 965         t.logger.WithDefaultLevel(log.Debug).Printf("dropping %v, which is mutually complete", p)
 966         p.drop()
 967 }
 968
 969 func (t *Torrent) haveChunk(r Request) (ret bool) {
 970         // defer func() {
 971         //      log.Println("have chunk", r, ret)
 972         // }()
 973         if !t.haveInfo() {
 974                 return false
 975         }
 976         if t.pieceComplete(pieceIndex(r.Index)) {
 977                 return true
 978         }
 979         p := &t.pieces[r.Index]
 980         return !p.pendingChunk(r.ChunkSpec, t.chunkSize)
 981 }
 982
 983 func chunkIndexFromChunkSpec(cs ChunkSpec, chunkSize pp.Integer) chunkIndexType {
 984         return chunkIndexType(cs.Begin / chunkSize)
 985 }
 986
 987 func (t *Torrent) wantPieceIndex(index pieceIndex) bool {
 988         return t._pendingPieces.Contains(uint32(index))
 989 }
 990
 991 // A pool of []*PeerConn, to reduce allocations in functions that need to index or sort Torrent
 992 // conns (which is a map).
 993 var peerConnSlices sync.Pool
 994
 995 func getPeerConnSlice(cap int) []*PeerConn {
 996         getInterface := peerConnSlices.Get()
 997         if getInterface == nil {
 998                 return make([]*PeerConn, 0, cap)
 999         } else {
1000                 return getInterface.([]*PeerConn)[:0]
1001         }
1002 }
1003
1004 // The worst connection is one that hasn't been sent, or sent anything useful for the longest. A bad
1005 // connection is one that usually sends us unwanted pieces, or has been in the worse half of the
1006 // established connections for more than a minute. This is O(n log n). If there was a way to not
1007 // consider the position of a conn relative to the total number, it could be reduced to O(n).
1008 func (t *Torrent) worstBadConn() (ret *PeerConn) {
1009         wcs := worseConnSlice{conns: t.appendUnclosedConns(getPeerConnSlice(len(t.conns)))}
1010         defer peerConnSlices.Put(wcs.conns)
1011         wcs.initKeys()
1012         heap.Init(&wcs)
1013         for wcs.Len() != 0 {
1014                 c := heap.Pop(&wcs).(*PeerConn)
1015                 if c._stats.ChunksReadWasted.Int64() >= 6 && c._stats.ChunksReadWasted.Int64() > c._stats.ChunksReadUseful.Int64() {
1016                         return c
1017                 }
1018                 // If the connection is in the worst half of the established
1019                 // connection quota and is older than a minute.
1020                 if wcs.Len() >= (t.maxEstablishedConns+1)/2 {
1021                         // Give connections 1 minute to prove themselves.
1022                         if time.Since(c.completedHandshake) > time.Minute {
1023                                 return c
1024                         }
1025                 }
1026         }
1027         return nil
1028 }
1029
1030 type PieceStateChange struct {
1031         Index int
1032         PieceState
1033 }
1034
1035 func (t *Torrent) publishPieceChange(piece pieceIndex) {
1036         t.cl._mu.Defer(func() {
1037                 cur := t.pieceState(piece)
1038                 p := &t.pieces[piece]
1039                 if cur != p.publicPieceState {
1040                         p.publicPieceState = cur
1041                         t.pieceStateChanges.Publish(PieceStateChange{
1042                                 int(piece),
1043                                 cur,
1044                         })
1045                 }
1046         })
1047 }
1048
1049 func (t *Torrent) pieceNumPendingChunks(piece pieceIndex) pp.Integer {
1050         if t.pieceComplete(piece) {
1051                 return 0
1052         }
1053         return pp.Integer(t.pieceNumChunks(piece) - t.pieces[piece].numDirtyChunks())
1054 }
1055
1056 func (t *Torrent) pieceAllDirty(piece pieceIndex) bool {
1057         return t.pieces[piece].allChunksDirty()
1058 }
1059
1060 func (t *Torrent) readersChanged() {
1061         t.updateReaderPieces()
1062         t.updateAllPiecePriorities("Torrent.readersChanged")
1063 }
1064
1065 func (t *Torrent) updateReaderPieces() {
1066         t._readerNowPieces, t._readerReadaheadPieces = t.readerPiecePriorities()
1067 }
1068
1069 func (t *Torrent) readerPosChanged(from, to pieceRange) {
1070         if from == to {
1071                 return
1072         }
1073         t.updateReaderPieces()
1074         // Order the ranges, high and low.
1075         l, h := from, to
1076         if l.begin > h.begin {
1077                 l, h = h, l
1078         }
1079         if l.end < h.begin {
1080                 // Two distinct ranges.
1081                 t.updatePiecePriorities(l.begin, l.end, "Torrent.readerPosChanged")
1082                 t.updatePiecePriorities(h.begin, h.end, "Torrent.readerPosChanged")
1083         } else {
1084                 // Ranges overlap.
1085                 end := l.end
1086                 if h.end > end {
1087                         end = h.end
1088                 }
1089                 t.updatePiecePriorities(l.begin, end, "Torrent.readerPosChanged")
1090         }
1091 }
1092
1093 func (t *Torrent) maybeNewConns() {
1094         // Tickle the accept routine.
1095         t.cl.event.Broadcast()
1096         t.openNewConns()
1097 }
1098
1099 func (t *Torrent) piecePriorityChanged(piece pieceIndex, reason string) {
1100         if t._pendingPieces.Contains(uint32(piece)) {
1101                 t.iterPeers(func(c *Peer) {
1102                         // if c.requestState.Interested {
1103                         //      return
1104                         // }
1105                         if !c.isLowOnRequests() {
1106                                 return
1107                         }
1108                         if !c.peerHasPiece(piece) {
1109                                 return
1110                         }
1111                         if c.peerChoking && !c.peerAllowedFast.Contains(uint32(piece)) {
1112                                 return
1113                         }
1114                         c.updateRequests(reason)
1115                 })
1116         }
1117         t.maybeNewConns()
1118         t.publishPieceChange(piece)
1119 }
1120
1121 func (t *Torrent) updatePiecePriority(piece pieceIndex, reason string) {
1122         if !t.closed.IsSet() {
1123                 // It would be possible to filter on pure-priority changes here to avoid churning the piece
1124                 // request order.
1125                 t.updatePieceRequestOrder(piece)
1126         }
1127         p := &t.pieces[piece]
1128         newPrio := p.uncachedPriority()
1129         // t.logger.Printf("torrent %p: piece %d: uncached priority: %v", t, piece, newPrio)
1130         if newPrio == PiecePriorityNone {
1131                 if !t._pendingPieces.CheckedRemove(uint32(piece)) {
1132                         return
1133                 }
1134         } else {
1135                 if !t._pendingPieces.CheckedAdd(uint32(piece)) {
1136                         return
1137                 }
1138         }
1139         t.piecePriorityChanged(piece, reason)
1140 }
1141
1142 func (t *Torrent) updateAllPiecePriorities(reason string) {
1143         t.updatePiecePriorities(0, t.numPieces(), reason)
1144 }
1145
1146 // Update all piece priorities in one hit. This function should have the same
1147 // output as updatePiecePriority, but across all pieces.
1148 func (t *Torrent) updatePiecePriorities(begin, end pieceIndex, reason string) {
1149         for i := begin; i < end; i++ {
1150                 t.updatePiecePriority(i, reason)
1151         }
1152 }
1153
1154 // Returns the range of pieces [begin, end) that contains the extent of bytes.
1155 func (t *Torrent) byteRegionPieces(off, size int64) (begin, end pieceIndex) {
1156         if off >= *t.length {
1157                 return
1158         }
1159         if off < 0 {
1160                 size += off
1161                 off = 0
1162         }
1163         if size <= 0 {
1164                 return
1165         }
1166         begin = pieceIndex(off / t.info.PieceLength)
1167         end = pieceIndex((off + size + t.info.PieceLength - 1) / t.info.PieceLength)
1168         if end > pieceIndex(t.info.NumPieces()) {
1169                 end = pieceIndex(t.info.NumPieces())
1170         }
1171         return
1172 }
1173
1174 // Returns true if all iterations complete without breaking. Returns the read regions for all
1175 // readers. The reader regions should not be merged as some callers depend on this method to
1176 // enumerate readers.
1177 func (t *Torrent) forReaderOffsetPieces(f func(begin, end pieceIndex) (more bool)) (all bool) {
1178         for r := range t.readers {
1179                 p := r.pieces
1180                 if p.begin >= p.end {
1181                         continue
1182                 }
1183                 if !f(p.begin, p.end) {
1184                         return false
1185                 }
1186         }
1187         return true
1188 }
1189
1190 func (t *Torrent) piecePriority(piece pieceIndex) piecePriority {
1191         return t.piece(piece).uncachedPriority()
1192 }
1193
1194 func (t *Torrent) pendRequest(req RequestIndex) {
1195         t.piece(int(req / t.chunksPerRegularPiece())).pendChunkIndex(req % t.chunksPerRegularPiece())
1196 }
1197
1198 func (t *Torrent) pieceCompletionChanged(piece pieceIndex, reason string) {
1199         t.cl.event.Broadcast()
1200         if t.pieceComplete(piece) {
1201                 t.onPieceCompleted(piece)
1202         } else {
1203                 t.onIncompletePiece(piece)
1204         }
1205         t.updatePiecePriority(piece, reason)
1206 }
1207
1208 func (t *Torrent) numReceivedConns() (ret int) {
1209         for c := range t.conns {
1210                 if c.Discovery == PeerSourceIncoming {
1211                         ret++
1212                 }
1213         }
1214         return
1215 }
1216
1217 func (t *Torrent) maxHalfOpen() int {
1218         // Note that if we somehow exceed the maximum established conns, we want
1219         // the negative value to have an effect.
1220         establishedHeadroom := int64(t.maxEstablishedConns - len(t.conns))
1221         extraIncoming := int64(t.numReceivedConns() - t.maxEstablishedConns/2)
1222         // We want to allow some experimentation with new peers, and to try to
1223         // upset an oversupply of received connections.
1224         return int(min(max(5, extraIncoming)+establishedHeadroom, int64(t.cl.config.HalfOpenConnsPerTorrent)))
1225 }
1226
1227 func (t *Torrent) openNewConns() (initiated int) {
1228         defer t.updateWantPeersEvent()
1229         for t.peers.Len() != 0 {
1230                 if !t.wantConns() {
1231                         return
1232                 }
1233                 if len(t.halfOpen) >= t.maxHalfOpen() {
1234                         return
1235                 }
1236                 if len(t.cl.dialers) == 0 {
1237                         return
1238                 }
1239                 if t.cl.numHalfOpen >= t.cl.config.TotalHalfOpenConns {
1240                         return
1241                 }
1242                 p := t.peers.PopMax()
1243                 t.initiateConn(p)
1244                 initiated++
1245         }
1246         return
1247 }
1248
1249 func (t *Torrent) updatePieceCompletion(piece pieceIndex) bool {
1250         p := t.piece(piece)
1251         uncached := t.pieceCompleteUncached(piece)
1252         cached := p.completion()
1253         changed := cached != uncached
1254         complete := uncached.Complete
1255         p.storageCompletionOk = uncached.Ok
1256         x := uint32(piece)
1257         if complete {
1258                 t._completedPieces.Add(x)
1259                 t.openNewConns()
1260         } else {
1261                 t._completedPieces.Remove(x)
1262         }
1263         p.t.updatePieceRequestOrder(piece)
1264         t.updateComplete()
1265         if complete && len(p.dirtiers) != 0 {
1266                 t.logger.Printf("marked piece %v complete but still has dirtiers", piece)
1267         }
1268         if changed {
1269                 log.Fstr("piece %d completion changed: %+v -> %+v", piece, cached, uncached).SetLevel(log.Debug).Log(t.logger)
1270                 t.pieceCompletionChanged(piece, "Torrent.updatePieceCompletion")
1271         }
1272         return changed
1273 }
1274
1275 // Non-blocking read. Client lock is not required.
1276 func (t *Torrent) readAt(b []byte, off int64) (n int, err error) {
1277         for len(b) != 0 {
1278                 p := &t.pieces[off/t.info.PieceLength]
1279                 p.waitNoPendingWrites()
1280                 var n1 int
1281                 n1, err = p.Storage().ReadAt(b, off-p.Info().Offset())
1282                 if n1 == 0 {
1283                         break
1284                 }
1285                 off += int64(n1)
1286                 n += n1
1287                 b = b[n1:]
1288         }
1289         return
1290 }
1291
1292 // Returns an error if the metadata was completed, but couldn't be set for some reason. Blame it on
1293 // the last peer to contribute. TODO: Actually we shouldn't blame peers for failure to open storage
1294 // etc. Also we should probably cached metadata pieces per-Peer, to isolate failure appropriately.
1295 func (t *Torrent) maybeCompleteMetadata() error {
1296         if t.haveInfo() {
1297                 // Nothing to do.
1298                 return nil
1299         }
1300         if !t.haveAllMetadataPieces() {
1301                 // Don't have enough metadata pieces.
1302                 return nil
1303         }
1304         err := t.setInfoBytesLocked(t.metadataBytes)
1305         if err != nil {
1306                 t.invalidateMetadata()
1307                 return fmt.Errorf("error setting info bytes: %s", err)
1308         }
1309         if t.cl.config.Debug {
1310                 t.logger.Printf("%s: got metadata from peers", t)
1311         }
1312         return nil
1313 }
1314
1315 func (t *Torrent) readerPiecePriorities() (now, readahead bitmap.Bitmap) {
1316         t.forReaderOffsetPieces(func(begin, end pieceIndex) bool {
1317                 if end > begin {
1318                         now.Add(bitmap.BitIndex(begin))
1319                         readahead.AddRange(bitmap.BitRange(begin)+1, bitmap.BitRange(end))
1320                 }
1321                 return true
1322         })
1323         return
1324 }
1325
1326 func (t *Torrent) needData() bool {
1327         if t.closed.IsSet() {
1328                 return false
1329         }
1330         if !t.haveInfo() {
1331                 return true
1332         }
1333         return !t._pendingPieces.IsEmpty()
1334 }
1335
1336 func appendMissingStrings(old, new []string) (ret []string) {
1337         ret = old
1338 new:
1339         for _, n := range new {
1340                 for _, o := range old {
1341                         if o == n {
1342                                 continue new
1343                         }
1344                 }
1345                 ret = append(ret, n)
1346         }
1347         return
1348 }
1349
1350 func appendMissingTrackerTiers(existing [][]string, minNumTiers int) (ret [][]string) {
1351         ret = existing
1352         for minNumTiers > len(ret) {
1353                 ret = append(ret, nil)
1354         }
1355         return
1356 }
1357
1358 func (t *Torrent) addTrackers(announceList [][]string) {
1359         fullAnnounceList := &t.metainfo.AnnounceList
1360         t.metainfo.AnnounceList = appendMissingTrackerTiers(*fullAnnounceList, len(announceList))
1361         for tierIndex, trackerURLs := range announceList {
1362                 (*fullAnnounceList)[tierIndex] = appendMissingStrings((*fullAnnounceList)[tierIndex], trackerURLs)
1363         }
1364         t.startMissingTrackerScrapers()
1365         t.updateWantPeersEvent()
1366 }
1367
1368 // Don't call this before the info is available.
1369 func (t *Torrent) bytesCompleted() int64 {
1370         if !t.haveInfo() {
1371                 return 0
1372         }
1373         return *t.length - t.bytesLeft()
1374 }
1375
1376 func (t *Torrent) SetInfoBytes(b []byte) (err error) {
1377         t.cl.lock()
1378         defer t.cl.unlock()
1379         return t.setInfoBytesLocked(b)
1380 }
1381
1382 // Returns true if connection is removed from torrent.Conns.
1383 func (t *Torrent) deletePeerConn(c *PeerConn) (ret bool) {
1384         if !c.closed.IsSet() {
1385                 panic("connection is not closed")
1386                 // There are behaviours prevented by the closed state that will fail
1387                 // if the connection has been deleted.
1388         }
1389         _, ret = t.conns[c]
1390         delete(t.conns, c)
1391         // Avoid adding a drop event more than once. Probably we should track whether we've generated
1392         // the drop event against the PexConnState instead.
1393         if ret {
1394                 if !t.cl.config.DisablePEX {
1395                         t.pex.Drop(c)
1396                 }
1397         }
1398         torrent.Add("deleted connections", 1)
1399         c.deleteAllRequests()
1400         t.assertPendingRequests()
1401         return
1402 }
1403
1404 func (t *Torrent) decPeerPieceAvailability(p *Peer) {
1405         if !t.haveInfo() {
1406                 return
1407         }
1408         p.newPeerPieces().Iterate(func(i uint32) bool {
1409                 p.t.decPieceAvailability(pieceIndex(i))
1410                 return true
1411         })
1412 }
1413
1414 func (t *Torrent) assertPendingRequests() {
1415         if !check {
1416                 return
1417         }
1418         // var actual pendingRequests
1419         // if t.haveInfo() {
1420         //      actual.m = make([]int, t.numRequests())
1421         // }
1422         // t.iterPeers(func(p *Peer) {
1423         //      p.requestState.Requests.Iterate(func(x uint32) bool {
1424         //              actual.Inc(x)
1425         //              return true
1426         //      })
1427         // })
1428         // diff := cmp.Diff(actual.m, t.pendingRequests.m)
1429         // if diff != "" {
1430         //      panic(diff)
1431         // }
1432 }
1433
1434 func (t *Torrent) dropConnection(c *PeerConn) {
1435         t.cl.event.Broadcast()
1436         c.close()
1437         if t.deletePeerConn(c) {
1438                 t.openNewConns()
1439         }
1440 }
1441
1442 // Peers as in contact information for dialing out.
1443 func (t *Torrent) wantPeers() bool {
1444         if t.closed.IsSet() {
1445                 return false
1446         }
1447         if t.peers.Len() > t.cl.config.TorrentPeersLowWater {
1448                 return false
1449         }
1450         return t.wantConns()
1451 }
1452
1453 func (t *Torrent) updateWantPeersEvent() {
1454         if t.wantPeers() {
1455                 t.wantPeersEvent.Set()
1456         } else {
1457                 t.wantPeersEvent.Clear()
1458         }
1459 }
1460
1461 // Returns whether the client should make effort to seed the torrent.
1462 func (t *Torrent) seeding() bool {
1463         cl := t.cl
1464         if t.closed.IsSet() {
1465                 return false
1466         }
1467         if t.dataUploadDisallowed {
1468                 return false
1469         }
1470         if cl.config.NoUpload {
1471                 return false
1472         }
1473         if !cl.config.Seed {
1474                 return false
1475         }
1476         if cl.config.DisableAggressiveUpload && t.needData() {
1477                 return false
1478         }
1479         return true
1480 }
1481
1482 func (t *Torrent) onWebRtcConn(
1483         c datachannel.ReadWriteCloser,
1484         dcc webtorrent.DataChannelContext,
1485 ) {
1486         defer c.Close()
1487         pc, err := t.cl.initiateProtocolHandshakes(
1488                 context.Background(),
1489                 webrtcNetConn{c, dcc},
1490                 t,
1491                 dcc.LocalOffered,
1492                 false,
1493                 webrtcNetAddr{dcc.Remote},
1494                 webrtcNetwork,
1495                 fmt.Sprintf("webrtc offer_id %x", dcc.OfferId),
1496         )
1497         if err != nil {
1498                 t.logger.WithDefaultLevel(log.Error).Printf("error in handshaking webrtc connection: %v", err)
1499                 return
1500         }
1501         if dcc.LocalOffered {
1502                 pc.Discovery = PeerSourceTracker
1503         } else {
1504                 pc.Discovery = PeerSourceIncoming
1505         }
1506         pc.conn.SetWriteDeadline(time.Time{})
1507         t.cl.lock()
1508         defer t.cl.unlock()
1509         err = t.cl.runHandshookConn(pc, t)
1510         if err != nil {
1511                 t.logger.WithDefaultLevel(log.Critical).Printf("error running handshook webrtc conn: %v", err)
1512         }
1513 }
1514
1515 func (t *Torrent) logRunHandshookConn(pc *PeerConn, logAll bool, level log.Level) {
1516         err := t.cl.runHandshookConn(pc, t)
1517         if err != nil || logAll {
1518                 t.logger.WithDefaultLevel(level).Printf("error running handshook conn: %v", err)
1519         }
1520 }
1521
1522 func (t *Torrent) runHandshookConnLoggingErr(pc *PeerConn) {
1523         t.logRunHandshookConn(pc, false, log.Debug)
1524 }
1525
1526 func (t *Torrent) startWebsocketAnnouncer(u url.URL) torrentTrackerAnnouncer {
1527         wtc, release := t.cl.websocketTrackers.Get(u.String())
1528         go func() {
1529                 <-t.closed.Done()
1530                 release()
1531         }()
1532         wst := websocketTrackerStatus{u, wtc}
1533         go func() {
1534                 err := wtc.Announce(tracker.Started, t.infoHash)
1535                 if err != nil {
1536                         t.logger.WithDefaultLevel(log.Warning).Printf(
1537                                 "error in initial announce to %q: %v",
1538                                 u.String(), err,
1539                         )
1540                 }
1541         }()
1542         return wst
1543 }
1544
1545 func (t *Torrent) startScrapingTracker(_url string) {
1546         if _url == "" {
1547                 return
1548         }
1549         u, err := url.Parse(_url)
1550         if err != nil {
1551                 // URLs with a leading '*' appear to be a uTorrent convention to
1552                 // disable trackers.
1553                 if _url[0] != '*' {
1554                         log.Str("error parsing tracker url").AddValues("url", _url).Log(t.logger)
1555                 }
1556                 return
1557         }
1558         if u.Scheme == "udp" {
1559                 u.Scheme = "udp4"
1560                 t.startScrapingTracker(u.String())
1561                 u.Scheme = "udp6"
1562                 t.startScrapingTracker(u.String())
1563                 return
1564         }
1565         if _, ok := t.trackerAnnouncers[_url]; ok {
1566                 return
1567         }
1568         sl := func() torrentTrackerAnnouncer {
1569                 switch u.Scheme {
1570                 case "ws", "wss":
1571                         if t.cl.config.DisableWebtorrent {
1572                                 return nil
1573                         }
1574                         return t.startWebsocketAnnouncer(*u)
1575                 case "udp4":
1576                         if t.cl.config.DisableIPv4Peers || t.cl.config.DisableIPv4 {
1577                                 return nil
1578                         }
1579                 case "udp6":
1580                         if t.cl.config.DisableIPv6 {
1581                                 return nil
1582                         }
1583                 }
1584                 newAnnouncer := &trackerScraper{
1585                         u:               *u,
1586                         t:               t,
1587                         lookupTrackerIp: t.cl.config.LookupTrackerIp,
1588                 }
1589                 go newAnnouncer.Run()
1590                 return newAnnouncer
1591         }()
1592         if sl == nil {
1593                 return
1594         }
1595         if t.trackerAnnouncers == nil {
1596                 t.trackerAnnouncers = make(map[string]torrentTrackerAnnouncer)
1597         }
1598         t.trackerAnnouncers[_url] = sl
1599 }
1600
1601 // Adds and starts tracker scrapers for tracker URLs that aren't already
1602 // running.
1603 func (t *Torrent) startMissingTrackerScrapers() {
1604         if t.cl.config.DisableTrackers {
1605                 return
1606         }
1607         t.startScrapingTracker(t.metainfo.Announce)
1608         for _, tier := range t.metainfo.AnnounceList {
1609                 for _, url := range tier {
1610                         t.startScrapingTracker(url)
1611                 }
1612         }
1613 }
1614
1615 // Returns an AnnounceRequest with fields filled out to defaults and current
1616 // values.
1617 func (t *Torrent) announceRequest(event tracker.AnnounceEvent) tracker.AnnounceRequest {
1618         // Note that IPAddress is not set. It's set for UDP inside the tracker code, since it's
1619         // dependent on the network in use.
1620         return tracker.AnnounceRequest{
1621                 Event: event,
1622                 NumWant: func() int32 {
1623                         if t.wantPeers() && len(t.cl.dialers) > 0 {
1624                                 return -1
1625                         } else {
1626                                 return 0
1627                         }
1628                 }(),
1629                 Port:     uint16(t.cl.incomingPeerPort()),
1630                 PeerId:   t.cl.peerID,
1631                 InfoHash: t.infoHash,
1632                 Key:      t.cl.announceKey(),
1633
1634                 // The following are vaguely described in BEP 3.
1635
1636                 Left:     t.bytesLeftAnnounce(),
1637                 Uploaded: t.stats.BytesWrittenData.Int64(),
1638                 // There's no mention of wasted or unwanted download in the BEP.
1639                 Downloaded: t.stats.BytesReadUsefulData.Int64(),
1640         }
1641 }
1642
1643 // Adds peers revealed in an announce until the announce ends, or we have
1644 // enough peers.
1645 func (t *Torrent) consumeDhtAnnouncePeers(pvs <-chan dht.PeersValues) {
1646         cl := t.cl
1647         for v := range pvs {
1648                 cl.lock()
1649                 added := 0
1650                 for _, cp := range v.Peers {
1651                         if cp.Port == 0 {
1652                                 // Can't do anything with this.
1653                                 continue
1654                         }
1655                         if t.addPeer(PeerInfo{
1656                                 Addr:   ipPortAddr{cp.IP, cp.Port},
1657                                 Source: PeerSourceDhtGetPeers,
1658                         }) {
1659                                 added++
1660                         }
1661                 }
1662                 cl.unlock()
1663                 // if added != 0 {
1664                 //      log.Printf("added %v peers from dht for %v", added, t.InfoHash().HexString())
1665                 // }
1666         }
1667 }
1668
1669 // Announce using the provided DHT server. Peers are consumed automatically. done is closed when the
1670 // announce ends. stop will force the announce to end.
1671 func (t *Torrent) AnnounceToDht(s DhtServer) (done <-chan struct{}, stop func(), err error) {
1672         ps, err := s.Announce(t.infoHash, t.cl.incomingPeerPort(), true)
1673         if err != nil {
1674                 return
1675         }
1676         _done := make(chan struct{})
1677         done = _done
1678         stop = ps.Close
1679         go func() {
1680                 t.consumeDhtAnnouncePeers(ps.Peers())
1681                 close(_done)
1682         }()
1683         return
1684 }
1685
1686 func (t *Torrent) timeboxedAnnounceToDht(s DhtServer) error {
1687         _, stop, err := t.AnnounceToDht(s)
1688         if err != nil {
1689                 return err
1690         }
1691         select {
1692         case <-t.closed.Done():
1693         case <-time.After(5 * time.Minute):
1694         }
1695         stop()
1696         return nil
1697 }
1698
1699 func (t *Torrent) dhtAnnouncer(s DhtServer) {
1700         cl := t.cl
1701         cl.lock()
1702         defer cl.unlock()
1703         for {
1704                 for {
1705                         if t.closed.IsSet() {
1706                                 return
1707                         }
1708                         // We're also announcing ourselves as a listener, so we don't just want peer addresses.
1709                         // TODO: We can include the announce_peer step depending on whether we can receive
1710                         // inbound connections. We should probably only announce once every 15 mins too.
1711                         if !t.wantConns() {
1712                                 goto wait
1713                         }
1714                         // TODO: Determine if there's a listener on the port we're announcing.
1715                         if len(cl.dialers) == 0 && len(cl.listeners) == 0 {
1716                                 goto wait
1717                         }
1718                         break
1719                 wait:
1720                         cl.event.Wait()
1721                 }
1722                 func() {
1723                         t.numDHTAnnounces++
1724                         cl.unlock()
1725                         defer cl.lock()
1726                         err := t.timeboxedAnnounceToDht(s)
1727                         if err != nil {
1728                                 t.logger.WithDefaultLevel(log.Warning).Printf("error announcing %q to DHT: %s", t, err)
1729                         }
1730                 }()
1731         }
1732 }
1733
1734 func (t *Torrent) addPeers(peers []PeerInfo) (added int) {
1735         for _, p := range peers {
1736                 if t.addPeer(p) {
1737                         added++
1738                 }
1739         }
1740         return
1741 }
1742
1743 // The returned TorrentStats may require alignment in memory. See
1744 // https://github.com/anacrolix/torrent/issues/383.
1745 func (t *Torrent) Stats() TorrentStats {
1746         t.cl.rLock()
1747         defer t.cl.rUnlock()
1748         return t.statsLocked()
1749 }
1750
1751 func (t *Torrent) statsLocked() (ret TorrentStats) {
1752         ret.ActivePeers = len(t.conns)
1753         ret.HalfOpenPeers = len(t.halfOpen)
1754         ret.PendingPeers = t.peers.Len()
1755         ret.TotalPeers = t.numTotalPeers()
1756         ret.ConnectedSeeders = 0
1757         for c := range t.conns {
1758                 if all, ok := c.peerHasAllPieces(); all && ok {
1759                         ret.ConnectedSeeders++
1760                 }
1761         }
1762         ret.ConnStats = t.stats.Copy()
1763         ret.PiecesComplete = t.numPiecesCompleted()
1764         return
1765 }
1766
1767 // The total number of peers in the torrent.
1768 func (t *Torrent) numTotalPeers() int {
1769         peers := make(map[string]struct{})
1770         for conn := range t.conns {
1771                 ra := conn.conn.RemoteAddr()
1772                 if ra == nil {
1773                         // It's been closed and doesn't support RemoteAddr.
1774                         continue
1775                 }
1776                 peers[ra.String()] = struct{}{}
1777         }
1778         for addr := range t.halfOpen {
1779                 peers[addr] = struct{}{}
1780         }
1781         t.peers.Each(func(peer PeerInfo) {
1782                 peers[peer.Addr.String()] = struct{}{}
1783         })
1784         return len(peers)
1785 }
1786
1787 // Reconcile bytes transferred before connection was associated with a
1788 // torrent.
1789 func (t *Torrent) reconcileHandshakeStats(c *PeerConn) {
1790         if c._stats != (ConnStats{
1791                 // Handshakes should only increment these fields:
1792                 BytesWritten: c._stats.BytesWritten,
1793                 BytesRead:    c._stats.BytesRead,
1794         }) {
1795                 panic("bad stats")
1796         }
1797         c.postHandshakeStats(func(cs *ConnStats) {
1798                 cs.BytesRead.Add(c._stats.BytesRead.Int64())
1799                 cs.BytesWritten.Add(c._stats.BytesWritten.Int64())
1800         })
1801         c.reconciledHandshakeStats = true
1802 }
1803
1804 // Returns true if the connection is added.
1805 func (t *Torrent) addPeerConn(c *PeerConn) (err error) {
1806         defer func() {
1807                 if err == nil {
1808                         torrent.Add("added connections", 1)
1809                 }
1810         }()
1811         if t.closed.IsSet() {
1812                 return errors.New("torrent closed")
1813         }
1814         for c0 := range t.conns {
1815                 if c.PeerID != c0.PeerID {
1816                         continue
1817                 }
1818                 if !t.cl.config.DropDuplicatePeerIds {
1819                         continue
1820                 }
1821                 if left, ok := c.hasPreferredNetworkOver(c0); ok && left {
1822                         c0.close()
1823                         t.deletePeerConn(c0)
1824                 } else {
1825                         return errors.New("existing connection preferred")
1826                 }
1827         }
1828         if len(t.conns) >= t.maxEstablishedConns {
1829                 c := t.worstBadConn()
1830                 if c == nil {
1831                         return errors.New("don't want conns")
1832                 }
1833                 c.close()
1834                 t.deletePeerConn(c)
1835         }
1836         if len(t.conns) >= t.maxEstablishedConns {
1837                 panic(len(t.conns))
1838         }
1839         t.conns[c] = struct{}{}
1840         if !t.cl.config.DisablePEX && !c.PeerExtensionBytes.SupportsExtended() {
1841                 t.pex.Add(c) // as no further extended handshake expected
1842         }
1843         return nil
1844 }
1845
1846 func (t *Torrent) wantConns() bool {
1847         if !t.networkingEnabled.Bool() {
1848                 return false
1849         }
1850         if t.closed.IsSet() {
1851                 return false
1852         }
1853         if !t.needData() && (!t.seeding() || !t.haveAnyPieces()) {
1854                 return false
1855         }
1856         return len(t.conns) < t.maxEstablishedConns || t.worstBadConn() != nil
1857 }
1858
1859 func (t *Torrent) SetMaxEstablishedConns(max int) (oldMax int) {
1860         t.cl.lock()
1861         defer t.cl.unlock()
1862         oldMax = t.maxEstablishedConns
1863         t.maxEstablishedConns = max
1864         wcs := worseConnSlice{
1865                 conns: t.appendConns(nil, func(*PeerConn) bool {
1866                         return true
1867                 }),
1868         }
1869         wcs.initKeys()
1870         heap.Init(&wcs)
1871         for len(t.conns) > t.maxEstablishedConns && wcs.Len() > 0 {
1872                 t.dropConnection(heap.Pop(&wcs).(*PeerConn))
1873         }
1874         t.openNewConns()
1875         return oldMax
1876 }
1877
1878 func (t *Torrent) pieceHashed(piece pieceIndex, passed bool, hashIoErr error) {
1879         t.logger.Log(log.Fstr("hashed piece %d (passed=%t)", piece, passed).SetLevel(log.Debug))
1880         p := t.piece(piece)
1881         p.numVerifies++
1882         t.cl.event.Broadcast()
1883         if t.closed.IsSet() {
1884                 return
1885         }
1886
1887         // Don't score the first time a piece is hashed, it could be an initial check.
1888         if p.storageCompletionOk {
1889                 if passed {
1890                         pieceHashedCorrect.Add(1)
1891                 } else {
1892                         log.Fmsg(
1893                                 "piece %d failed hash: %d connections contributed", piece, len(p.dirtiers),
1894                         ).AddValues(t, p).SetLevel(log.Debug).Log(t.logger)
1895                         pieceHashedNotCorrect.Add(1)
1896                 }
1897         }
1898
1899         p.marking = true
1900         t.publishPieceChange(piece)
1901         defer func() {
1902                 p.marking = false
1903                 t.publishPieceChange(piece)
1904         }()
1905
1906         if passed {
1907                 if len(p.dirtiers) != 0 {
1908                         // Don't increment stats above connection-level for every involved connection.
1909                         t.allStats((*ConnStats).incrementPiecesDirtiedGood)
1910                 }
1911                 for c := range p.dirtiers {
1912                         c._stats.incrementPiecesDirtiedGood()
1913                 }
1914                 t.clearPieceTouchers(piece)
1915                 t.cl.unlock()
1916                 err := p.Storage().MarkComplete()
1917                 if err != nil {
1918                         t.logger.Printf("%T: error marking piece complete %d: %s", t.storage, piece, err)
1919                 }
1920                 t.cl.lock()
1921
1922                 if t.closed.IsSet() {
1923                         return
1924                 }
1925                 t.pendAllChunkSpecs(piece)
1926         } else {
1927                 if len(p.dirtiers) != 0 && p.allChunksDirty() && hashIoErr == nil {
1928                         // Peers contributed to all the data for this piece hash failure, and the failure was
1929                         // not due to errors in the storage (such as data being dropped in a cache).
1930
1931                         // Increment Torrent and above stats, and then specific connections.
1932                         t.allStats((*ConnStats).incrementPiecesDirtiedBad)
1933                         for c := range p.dirtiers {
1934                                 // Y u do dis peer?!
1935                                 c.stats().incrementPiecesDirtiedBad()
1936                         }
1937
1938                         bannableTouchers := make([]*Peer, 0, len(p.dirtiers))
1939                         for c := range p.dirtiers {
1940                                 if !c.trusted {
1941                                         bannableTouchers = append(bannableTouchers, c)
1942                                 }
1943                         }
1944                         t.clearPieceTouchers(piece)
1945                         slices.Sort(bannableTouchers, connLessTrusted)
1946
1947                         if t.cl.config.Debug {
1948                                 t.logger.Printf(
1949                                         "bannable conns by trust for piece %d: %v",
1950                                         piece,
1951                                         func() (ret []connectionTrust) {
1952                                                 for _, c := range bannableTouchers {
1953                                                         ret = append(ret, c.trust())
1954                                                 }
1955                                                 return
1956                                         }(),
1957                                 )
1958                         }
1959
1960                         if len(bannableTouchers) >= 1 {
1961                                 c := bannableTouchers[0]
1962                                 t.cl.banPeerIP(c.remoteIp())
1963                                 c.drop()
1964                         }
1965                 }
1966                 t.onIncompletePiece(piece)
1967                 p.Storage().MarkNotComplete()
1968         }
1969         t.updatePieceCompletion(piece)
1970 }
1971
1972 func (t *Torrent) cancelRequestsForPiece(piece pieceIndex) {
1973         // TODO: Make faster
1974         for cn := range t.conns {
1975                 cn.tickleWriter()
1976         }
1977 }
1978
1979 func (t *Torrent) onPieceCompleted(piece pieceIndex) {
1980         t.pendAllChunkSpecs(piece)
1981         t.cancelRequestsForPiece(piece)
1982         t.piece(piece).readerCond.Broadcast()
1983         for conn := range t.conns {
1984                 conn.have(piece)
1985                 t.maybeDropMutuallyCompletePeer(&conn.Peer)
1986         }
1987 }
1988
1989 // Called when a piece is found to be not complete.
1990 func (t *Torrent) onIncompletePiece(piece pieceIndex) {
1991         if t.pieceAllDirty(piece) {
1992                 t.pendAllChunkSpecs(piece)
1993         }
1994         if !t.wantPieceIndex(piece) {
1995                 // t.logger.Printf("piece %d incomplete and unwanted", piece)
1996                 return
1997         }
1998         // We could drop any connections that we told we have a piece that we
1999         // don't here. But there's a test failure, and it seems clients don't care
2000         // if you request pieces that you already claim to have. Pruning bad
2001         // connections might just remove any connections that aren't treating us
2002         // favourably anyway.
2003
2004         // for c := range t.conns {
2005         //      if c.sentHave(piece) {
2006         //              c.drop()
2007         //      }
2008         // }
2009         t.iterPeers(func(conn *Peer) {
2010                 if conn.peerHasPiece(piece) {
2011                         conn.updateRequests("piece incomplete")
2012                 }
2013         })
2014 }
2015
2016 func (t *Torrent) tryCreateMorePieceHashers() {
2017         for !t.closed.IsSet() && t.activePieceHashes < 2 && t.tryCreatePieceHasher() {
2018         }
2019 }
2020
2021 func (t *Torrent) tryCreatePieceHasher() bool {
2022         if t.storage == nil {
2023                 return false
2024         }
2025         pi, ok := t.getPieceToHash()
2026         if !ok {
2027                 return false
2028         }
2029         p := t.piece(pi)
2030         t.piecesQueuedForHash.Remove(bitmap.BitIndex(pi))
2031         p.hashing = true
2032         t.publishPieceChange(pi)
2033         t.updatePiecePriority(pi, "Torrent.tryCreatePieceHasher")
2034         t.storageLock.RLock()
2035         t.activePieceHashes++
2036         go t.pieceHasher(pi)
2037         return true
2038 }
2039
2040 func (t *Torrent) getPieceToHash() (ret pieceIndex, ok bool) {
2041         t.piecesQueuedForHash.IterTyped(func(i pieceIndex) bool {
2042                 if t.piece(i).hashing {
2043                         return true
2044                 }
2045                 ret = i
2046                 ok = true
2047                 return false
2048         })
2049         return
2050 }
2051
2052 func (t *Torrent) pieceHasher(index pieceIndex) {
2053         p := t.piece(index)
2054         sum, copyErr := t.hashPiece(index)
2055         correct := sum == *p.hash
2056         switch copyErr {
2057         case nil, io.EOF:
2058         default:
2059                 log.Fmsg("piece %v (%s) hash failure copy error: %v", p, p.hash.HexString(), copyErr).Log(t.logger)
2060         }
2061         t.storageLock.RUnlock()
2062         t.cl.lock()
2063         defer t.cl.unlock()
2064         p.hashing = false
2065         t.pieceHashed(index, correct, copyErr)
2066         t.updatePiecePriority(index, "Torrent.pieceHasher")
2067         t.activePieceHashes--
2068         t.tryCreateMorePieceHashers()
2069 }
2070
2071 // Return the connections that touched a piece, and clear the entries while doing it.
2072 func (t *Torrent) clearPieceTouchers(pi pieceIndex) {
2073         p := t.piece(pi)
2074         for c := range p.dirtiers {
2075                 delete(c.peerTouchedPieces, pi)
2076                 delete(p.dirtiers, c)
2077         }
2078 }
2079
2080 func (t *Torrent) peersAsSlice() (ret []*Peer) {
2081         t.iterPeers(func(p *Peer) {
2082                 ret = append(ret, p)
2083         })
2084         return
2085 }
2086
2087 func (t *Torrent) queuePieceCheck(pieceIndex pieceIndex) {
2088         piece := t.piece(pieceIndex)
2089         if piece.queuedForHash() {
2090                 return
2091         }
2092         t.piecesQueuedForHash.Add(bitmap.BitIndex(pieceIndex))
2093         t.publishPieceChange(pieceIndex)
2094         t.updatePiecePriority(pieceIndex, "Torrent.queuePieceCheck")
2095         t.tryCreateMorePieceHashers()
2096 }
2097
2098 // Forces all the pieces to be re-hashed. See also Piece.VerifyData. This should not be called
2099 // before the Info is available.
2100 func (t *Torrent) VerifyData() {
2101         for i := pieceIndex(0); i < t.NumPieces(); i++ {
2102                 t.Piece(i).VerifyData()
2103         }
2104 }
2105
2106 // Start the process of connecting to the given peer for the given torrent if appropriate.
2107 func (t *Torrent) initiateConn(peer PeerInfo) {
2108         if peer.Id == t.cl.peerID {
2109                 return
2110         }
2111         if t.cl.badPeerAddr(peer.Addr) && !peer.Trusted {
2112                 return
2113         }
2114         addr := peer.Addr
2115         if t.addrActive(addr.String()) {
2116                 return
2117         }
2118         t.cl.numHalfOpen++
2119         t.halfOpen[addr.String()] = peer
2120         go t.cl.outgoingConnection(t, addr, peer.Source, peer.Trusted)
2121 }
2122
2123 // Adds a trusted, pending peer for each of the given Client's addresses. Typically used in tests to
2124 // quickly make one Client visible to the Torrent of another Client.
2125 func (t *Torrent) AddClientPeer(cl *Client) int {
2126         return t.AddPeers(func() (ps []PeerInfo) {
2127                 for _, la := range cl.ListenAddrs() {
2128                         ps = append(ps, PeerInfo{
2129                                 Addr:    la,
2130                                 Trusted: true,
2131                         })
2132                 }
2133                 return
2134         }())
2135 }
2136
2137 // All stats that include this Torrent. Useful when we want to increment ConnStats but not for every
2138 // connection.
2139 func (t *Torrent) allStats(f func(*ConnStats)) {
2140         f(&t.stats)
2141         f(&t.cl.stats)
2142 }
2143
2144 func (t *Torrent) hashingPiece(i pieceIndex) bool {
2145         return t.pieces[i].hashing
2146 }
2147
2148 func (t *Torrent) pieceQueuedForHash(i pieceIndex) bool {
2149         return t.piecesQueuedForHash.Get(bitmap.BitIndex(i))
2150 }
2151
2152 func (t *Torrent) dialTimeout() time.Duration {
2153         return reducedDialTimeout(t.cl.config.MinDialTimeout, t.cl.config.NominalDialTimeout, t.cl.config.HalfOpenConnsPerTorrent, t.peers.Len())
2154 }
2155
2156 func (t *Torrent) piece(i int) *Piece {
2157         return &t.pieces[i]
2158 }
2159
2160 func (t *Torrent) onWriteChunkErr(err error) {
2161         if t.userOnWriteChunkErr != nil {
2162                 go t.userOnWriteChunkErr(err)
2163                 return
2164         }
2165         t.logger.WithDefaultLevel(log.Critical).Printf("default chunk write error handler: disabling data download")
2166         t.disallowDataDownloadLocked()
2167 }
2168
2169 func (t *Torrent) DisallowDataDownload() {
2170         t.disallowDataDownloadLocked()
2171 }
2172
2173 func (t *Torrent) disallowDataDownloadLocked() {
2174         t.dataDownloadDisallowed.Set()
2175 }
2176
2177 func (t *Torrent) AllowDataDownload() {
2178         t.dataDownloadDisallowed.Clear()
2179 }
2180
2181 // Enables uploading data, if it was disabled.
2182 func (t *Torrent) AllowDataUpload() {
2183         t.cl.lock()
2184         defer t.cl.unlock()
2185         t.dataUploadDisallowed = false
2186         for c := range t.conns {
2187                 c.updateRequests("allow data upload")
2188         }
2189 }
2190
2191 // Disables uploading data, if it was enabled.
2192 func (t *Torrent) DisallowDataUpload() {
2193         t.cl.lock()
2194         defer t.cl.unlock()
2195         t.dataUploadDisallowed = true
2196         for c := range t.conns {
2197                 c.updateRequests("disallow data upload")
2198         }
2199 }
2200
2201 // Sets a handler that is called if there's an error writing a chunk to local storage. By default,
2202 // or if nil, a critical message is logged, and data download is disabled.
2203 func (t *Torrent) SetOnWriteChunkError(f func(error)) {
2204         t.cl.lock()
2205         defer t.cl.unlock()
2206         t.userOnWriteChunkErr = f
2207 }
2208
2209 func (t *Torrent) iterPeers(f func(p *Peer)) {
2210         for pc := range t.conns {
2211                 f(&pc.Peer)
2212         }
2213         for _, ws := range t.webSeeds {
2214                 f(ws)
2215         }
2216 }
2217
2218 func (t *Torrent) callbacks() *Callbacks {
2219         return &t.cl.config.Callbacks
2220 }
2221
2222 func (t *Torrent) addWebSeed(url string) {
2223         if t.cl.config.DisableWebseeds {
2224                 return
2225         }
2226         if _, ok := t.webSeeds[url]; ok {
2227                 return
2228         }
2229         // I don't think Go http supports pipelining requests. However, we can have more ready to go
2230         // right away. This value should be some multiple of the number of connections to a host. I
2231         // would expect that double maxRequests plus a bit would be appropriate. This value is based on
2232         // downloading Sintel (08ada5a7a6183aae1e09d831df6748d566095a10) from
2233         // "https://webtorrent.io/torrents/".
2234         const maxRequests = 16
2235         ws := webseedPeer{
2236                 peer: Peer{
2237                         t:                        t,
2238                         outgoing:                 true,
2239                         Network:                  "http",
2240                         reconciledHandshakeStats: true,
2241                         // This should affect how often we have to recompute requests for this peer. Note that
2242                         // because we can request more than 1 thing at a time over HTTP, we will hit the low
2243                         // requests mark more often, so recomputation is probably sooner than with regular peer
2244                         // conns. ~4x maxRequests would be about right.
2245                         PeerMaxRequests: 128,
2246                         RemoteAddr:      remoteAddrFromUrl(url),
2247                         callbacks:       t.callbacks(),
2248                 },
2249                 client: webseed.Client{
2250                         HttpClient: t.cl.webseedHttpClient,
2251                         Url:        url,
2252                 },
2253                 activeRequests: make(map[Request]webseed.Request, maxRequests),
2254                 maxRequests:    maxRequests,
2255         }
2256         ws.peer.initUpdateRequestsTimer()
2257         ws.requesterCond.L = t.cl.locker()
2258         for i := 0; i < maxRequests; i += 1 {
2259                 go ws.requester(i)
2260         }
2261         for _, f := range t.callbacks().NewPeer {
2262                 f(&ws.peer)
2263         }
2264         ws.peer.logger = t.logger.WithContextValue(&ws)
2265         ws.peer.peerImpl = &ws
2266         if t.haveInfo() {
2267                 ws.onGotInfo(t.info)
2268         }
2269         t.webSeeds[url] = &ws.peer
2270 }
2271
2272 func (t *Torrent) peerIsActive(p *Peer) (active bool) {
2273         t.iterPeers(func(p1 *Peer) {
2274                 if p1 == p {
2275                         active = true
2276                 }
2277         })
2278         return
2279 }
2280
2281 func (t *Torrent) requestIndexToRequest(ri RequestIndex) Request {
2282         index := ri / t.chunksPerRegularPiece()
2283         return Request{
2284                 pp.Integer(index),
2285                 t.piece(int(index)).chunkIndexSpec(ri % t.chunksPerRegularPiece()),
2286         }
2287 }
2288
2289 func (t *Torrent) requestIndexFromRequest(r Request) RequestIndex {
2290         return t.pieceRequestIndexOffset(pieceIndex(r.Index)) + uint32(r.Begin/t.chunkSize)
2291 }
2292
2293 func (t *Torrent) pieceRequestIndexOffset(piece pieceIndex) RequestIndex {
2294         return RequestIndex(piece) * t.chunksPerRegularPiece()
2295 }
2296
2297 func (t *Torrent) updateComplete() {
2298         t.Complete.SetBool(t.haveAllPieces())
2299 }
2300
2301 func (t *Torrent) cancelRequest(r RequestIndex) *Peer {
2302         p := t.pendingRequests[r]
2303         if p != nil {
2304                 p.cancel(r)
2305         }
2306         delete(t.pendingRequests, r)
2307         return p
2308 }
2309
2310 func (t *Torrent) requestingPeer(r RequestIndex) *Peer {
2311         return t.pendingRequests[r]
2312 }