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