torrent.go

   1 package torrent
   2
   3 import (
   4         "bytes"
   5         "container/heap"
   6         "context"
   7         "crypto/sha1"
   8         "errors"
   9         "fmt"
  10         "hash"
  11         "io"
  12         "math/rand"
  13         "net/netip"
  14         "net/url"
  15         "sort"
  16         "strings"
  17         "text/tabwriter"
  18         "time"
  19         "unsafe"
  20
  21         "github.com/RoaringBitmap/roaring"
  22         "github.com/anacrolix/chansync"
  23         "github.com/anacrolix/chansync/events"
  24         "github.com/anacrolix/dht/v2"
  25         . "github.com/anacrolix/generics"
  26         g "github.com/anacrolix/generics"
  27         "github.com/anacrolix/log"
  28         "github.com/anacrolix/missinggo/slices"
  29         "github.com/anacrolix/missinggo/v2"
  30         "github.com/anacrolix/missinggo/v2/bitmap"
  31         "github.com/anacrolix/missinggo/v2/pubsub"
  32         "github.com/anacrolix/multiless"
  33         "github.com/anacrolix/sync"
  34         "github.com/pion/datachannel"
  35         "golang.org/x/exp/maps"
  36         "golang.org/x/sync/errgroup"
  37
  38         "github.com/anacrolix/torrent/bencode"
  39         "github.com/anacrolix/torrent/internal/check"
  40         "github.com/anacrolix/torrent/internal/nestedmaps"
  41         "github.com/anacrolix/torrent/merkle"
  42         "github.com/anacrolix/torrent/metainfo"
  43         pp "github.com/anacrolix/torrent/peer_protocol"
  44         utHolepunch "github.com/anacrolix/torrent/peer_protocol/ut-holepunch"
  45         request_strategy "github.com/anacrolix/torrent/request-strategy"
  46         "github.com/anacrolix/torrent/storage"
  47         "github.com/anacrolix/torrent/tracker"
  48         typedRoaring "github.com/anacrolix/torrent/typed-roaring"
  49         "github.com/anacrolix/torrent/types/infohash"
  50         infohash_v2 "github.com/anacrolix/torrent/types/infohash-v2"
  51         "github.com/anacrolix/torrent/webseed"
  52         "github.com/anacrolix/torrent/webtorrent"
  53 )
  54
  55 // Maintains state of torrent within a Client. Many methods should not be called before the info is
  56 // available, see .Info and .GotInfo.
  57 type Torrent struct {
  58         // Torrent-level aggregate statistics. First in struct to ensure 64-bit
  59         // alignment. See #262.
  60         stats  ConnStats
  61         cl     *Client
  62         logger log.Logger
  63
  64         networkingEnabled      chansync.Flag
  65         dataDownloadDisallowed chansync.Flag
  66         dataUploadDisallowed   bool
  67         userOnWriteChunkErr    func(error)
  68
  69         closed  chansync.SetOnce
  70         onClose []func()
  71
  72         infoHash   g.Option[metainfo.Hash]
  73         infoHashV2 g.Option[infohash_v2.T]
  74
  75         pieces []Piece
  76
  77         // The order pieces are requested if there's no stronger reason like availability or priority.
  78         pieceRequestOrder []int
  79         // Values are the piece indices that changed.
  80         pieceStateChanges pubsub.PubSub[PieceStateChange]
  81         // The size of chunks to request from peers over the wire. This is
  82         // normally 16KiB by convention these days.
  83         chunkSize pp.Integer
  84         chunkPool sync.Pool
  85         // Total length of the torrent in bytes. Stored because it's not O(1) to
  86         // get this from the info dict.
  87         _length Option[int64]
  88
  89         // The storage to open when the info dict becomes available.
  90         storageOpener *storage.Client
  91         // Storage for torrent data.
  92         storage *storage.Torrent
  93         // Read-locked for using storage, and write-locked for Closing.
  94         storageLock sync.RWMutex
  95
  96         // TODO: Only announce stuff is used?
  97         metainfo metainfo.MetaInfo
  98
  99         // The info dict. nil if we don't have it (yet).
 100         info  *metainfo.Info
 101         files *[]*File
 102
 103         _chunksPerRegularPiece chunkIndexType
 104
 105         webSeeds map[string]*Peer
 106         // Active peer connections, running message stream loops. TODO: Make this
 107         // open (not-closed) connections only.
 108         conns               map[*PeerConn]struct{}
 109         maxEstablishedConns int
 110         // Set of addrs to which we're attempting to connect. Connections are
 111         // half-open until all handshakes are completed.
 112         halfOpen map[string]map[outgoingConnAttemptKey]*PeerInfo
 113
 114         // Reserve of peers to connect to. A peer can be both here and in the
 115         // active connections if were told about the peer after connecting with
 116         // them. That encourages us to reconnect to peers that are well known in
 117         // the swarm.
 118         peers prioritizedPeers
 119         // Whether we want to know more peers.
 120         wantPeersEvent missinggo.Event
 121         // An announcer for each tracker URL.
 122         trackerAnnouncers map[torrentTrackerAnnouncerKey]torrentTrackerAnnouncer
 123         // How many times we've initiated a DHT announce. TODO: Move into stats.
 124         numDHTAnnounces int
 125
 126         // Name used if the info name isn't available. Should be cleared when the
 127         // Info does become available.
 128         nameMu      sync.RWMutex
 129         displayName string
 130
 131         // The bencoded bytes of the info dict. This is actively manipulated if
 132         // the info bytes aren't initially available, and we try to fetch them
 133         // from peers.
 134         metadataBytes []byte
 135         // Each element corresponds to the 16KiB metadata pieces. If true, we have
 136         // received that piece.
 137         metadataCompletedChunks []bool
 138         metadataChanged         sync.Cond
 139
 140         // Closed when .Info is obtained.
 141         gotMetainfoC chan struct{}
 142
 143         readers                map[*reader]struct{}
 144         _readerNowPieces       bitmap.Bitmap
 145         _readerReadaheadPieces bitmap.Bitmap
 146
 147         // A cache of pieces we need to get. Calculated from various piece and file priorities and
 148         // completion states elsewhere. Includes piece data and piece v2 hashes.
 149         _pendingPieces roaring.Bitmap
 150         // A cache of completed piece indices.
 151         _completedPieces roaring.Bitmap
 152         // Pieces that need to be hashed.
 153         piecesQueuedForHash       bitmap.Bitmap
 154         activePieceHashes         int
 155         initialPieceCheckDisabled bool
 156
 157         connsWithAllPieces map[*Peer]struct{}
 158
 159         requestState map[RequestIndex]requestState
 160         // Chunks we've written to since the corresponding piece was last checked.
 161         dirtyChunks typedRoaring.Bitmap[RequestIndex]
 162
 163         pex pexState
 164
 165         // Is On when all pieces are complete.
 166         Complete chansync.Flag
 167
 168         // Torrent sources in use keyed by the source string.
 169         activeSources sync.Map
 170         sourcesLogger log.Logger
 171
 172         smartBanCache smartBanCache
 173
 174         // Large allocations reused between request state updates.
 175         requestPieceStates []request_strategy.PieceRequestOrderState
 176         requestIndexes     []RequestIndex
 177
 178         disableTriggers bool
 179 }
 180
 181 type torrentTrackerAnnouncerKey struct {
 182         shortInfohash [20]byte
 183         url           string
 184 }
 185
 186 type outgoingConnAttemptKey = *PeerInfo
 187
 188 func (t *Torrent) length() int64 {
 189         return t._length.Value
 190 }
 191
 192 func (t *Torrent) selectivePieceAvailabilityFromPeers(i pieceIndex) (count int) {
 193         // This could be done with roaring.BitSliceIndexing.
 194         t.iterPeers(func(peer *Peer) {
 195                 if _, ok := t.connsWithAllPieces[peer]; ok {
 196                         return
 197                 }
 198                 if peer.peerHasPiece(i) {
 199                         count++
 200                 }
 201         })
 202         return
 203 }
 204
 205 func (t *Torrent) decPieceAvailability(i pieceIndex) {
 206         if !t.haveInfo() {
 207                 return
 208         }
 209         p := t.piece(i)
 210         if p.relativeAvailability <= 0 {
 211                 panic(p.relativeAvailability)
 212         }
 213         p.relativeAvailability--
 214         t.updatePieceRequestOrderPiece(i)
 215 }
 216
 217 func (t *Torrent) incPieceAvailability(i pieceIndex) {
 218         // If we don't the info, this should be reconciled when we do.
 219         if t.haveInfo() {
 220                 p := t.piece(i)
 221                 p.relativeAvailability++
 222                 t.updatePieceRequestOrderPiece(i)
 223         }
 224 }
 225
 226 func (t *Torrent) readerNowPieces() bitmap.Bitmap {
 227         return t._readerNowPieces
 228 }
 229
 230 func (t *Torrent) readerReadaheadPieces() bitmap.Bitmap {
 231         return t._readerReadaheadPieces
 232 }
 233
 234 func (t *Torrent) ignorePieceForRequests(i pieceIndex) bool {
 235         return t.piece(i).ignoreForRequests()
 236 }
 237
 238 // Returns a channel that is closed when the Torrent is closed.
 239 func (t *Torrent) Closed() events.Done {
 240         return t.closed.Done()
 241 }
 242
 243 // KnownSwarm returns the known subset of the peers in the Torrent's swarm, including active,
 244 // pending, and half-open peers.
 245 func (t *Torrent) KnownSwarm() (ks []PeerInfo) {
 246         // Add pending peers to the list
 247         t.peers.Each(func(peer PeerInfo) {
 248                 ks = append(ks, peer)
 249         })
 250
 251         // Add half-open peers to the list
 252         for _, attempts := range t.halfOpen {
 253                 for _, peer := range attempts {
 254                         ks = append(ks, *peer)
 255                 }
 256         }
 257
 258         // Add active peers to the list
 259         t.cl.rLock()
 260         defer t.cl.rUnlock()
 261         for conn := range t.conns {
 262                 ks = append(ks, PeerInfo{
 263                         Id:     conn.PeerID,
 264                         Addr:   conn.RemoteAddr,
 265                         Source: conn.Discovery,
 266                         // > If the connection is encrypted, that's certainly enough to set SupportsEncryption.
 267                         // > But if we're not connected to them with an encrypted connection, I couldn't say
 268                         // > what's appropriate. We can carry forward the SupportsEncryption value as we
 269                         // > received it from trackers/DHT/PEX, or just use the encryption state for the
 270                         // > connection. It's probably easiest to do the latter for now.
 271                         // https://github.com/anacrolix/torrent/pull/188
 272                         SupportsEncryption: conn.headerEncrypted,
 273                 })
 274         }
 275
 276         return
 277 }
 278
 279 func (t *Torrent) setChunkSize(size pp.Integer) {
 280         t.chunkSize = size
 281         t.chunkPool = sync.Pool{
 282                 New: func() interface{} {
 283                         b := make([]byte, size)
 284                         return &b
 285                 },
 286         }
 287 }
 288
 289 func (t *Torrent) pieceComplete(piece pieceIndex) bool {
 290         return t._completedPieces.Contains(bitmap.BitIndex(piece))
 291 }
 292
 293 func (t *Torrent) pieceCompleteUncached(piece pieceIndex) storage.Completion {
 294         if t.storage == nil {
 295                 return storage.Completion{Complete: false, Ok: true}
 296         }
 297         return t.pieces[piece].Storage().Completion()
 298 }
 299
 300 // There's a connection to that address already.
 301 func (t *Torrent) addrActive(addr string) bool {
 302         if _, ok := t.halfOpen[addr]; ok {
 303                 return true
 304         }
 305         for c := range t.conns {
 306                 ra := c.RemoteAddr
 307                 if ra.String() == addr {
 308                         return true
 309                 }
 310         }
 311         return false
 312 }
 313
 314 func (t *Torrent) appendUnclosedConns(ret []*PeerConn) []*PeerConn {
 315         return t.appendConns(ret, func(conn *PeerConn) bool {
 316                 return !conn.closed.IsSet()
 317         })
 318 }
 319
 320 func (t *Torrent) appendConns(ret []*PeerConn, f func(*PeerConn) bool) []*PeerConn {
 321         for c := range t.conns {
 322                 if f(c) {
 323                         ret = append(ret, c)
 324                 }
 325         }
 326         return ret
 327 }
 328
 329 func (t *Torrent) addPeer(p PeerInfo) (added bool) {
 330         cl := t.cl
 331         torrent.Add(fmt.Sprintf("peers added by source %q", p.Source), 1)
 332         if t.closed.IsSet() {
 333                 return false
 334         }
 335         if ipAddr, ok := tryIpPortFromNetAddr(p.Addr); ok {
 336                 if cl.badPeerIPPort(ipAddr.IP, ipAddr.Port) {
 337                         torrent.Add("peers not added because of bad addr", 1)
 338                         // cl.logger.Printf("peers not added because of bad addr: %v", p)
 339                         return false
 340                 }
 341         }
 342         if replaced, ok := t.peers.AddReturningReplacedPeer(p); ok {
 343                 torrent.Add("peers replaced", 1)
 344                 if !replaced.equal(p) {
 345                         t.logger.WithDefaultLevel(log.Debug).Printf("added %v replacing %v", p, replaced)
 346                         added = true
 347                 }
 348         } else {
 349                 added = true
 350         }
 351         t.openNewConns()
 352         for t.peers.Len() > cl.config.TorrentPeersHighWater {
 353                 _, ok := t.peers.DeleteMin()
 354                 if ok {
 355                         torrent.Add("excess reserve peers discarded", 1)
 356                 }
 357         }
 358         return
 359 }
 360
 361 func (t *Torrent) invalidateMetadata() {
 362         for i := 0; i < len(t.metadataCompletedChunks); i++ {
 363                 t.metadataCompletedChunks[i] = false
 364         }
 365         t.nameMu.Lock()
 366         t.info = nil
 367         t.nameMu.Unlock()
 368 }
 369
 370 func (t *Torrent) saveMetadataPiece(index int, data []byte) {
 371         if t.haveInfo() {
 372                 return
 373         }
 374         if index >= len(t.metadataCompletedChunks) {
 375                 t.logger.Printf("%s: ignoring metadata piece %d", t, index)
 376                 return
 377         }
 378         copy(t.metadataBytes[(1<<14)*index:], data)
 379         t.metadataCompletedChunks[index] = true
 380 }
 381
 382 func (t *Torrent) metadataPieceCount() int {
 383         return (len(t.metadataBytes) + (1 << 14) - 1) / (1 << 14)
 384 }
 385
 386 func (t *Torrent) haveMetadataPiece(piece int) bool {
 387         if t.haveInfo() {
 388                 return (1<<14)*piece < len(t.metadataBytes)
 389         } else {
 390                 return piece < len(t.metadataCompletedChunks) && t.metadataCompletedChunks[piece]
 391         }
 392 }
 393
 394 func (t *Torrent) metadataSize() int {
 395         return len(t.metadataBytes)
 396 }
 397
 398 func (t *Torrent) makePieces() {
 399         t.pieces = make([]Piece, t.info.NumPieces())
 400         for i := range t.pieces {
 401                 piece := &t.pieces[i]
 402                 piece.t = t
 403                 piece.index = i
 404                 piece.noPendingWrites.L = &piece.pendingWritesMutex
 405                 if t.info.HasV1() {
 406                         piece.hash = (*metainfo.Hash)(unsafe.Pointer(
 407                                 unsafe.SliceData(t.info.Pieces[i*sha1.Size : (i+1)*sha1.Size])))
 408                 }
 409                 files := *t.files
 410                 beginFile := pieceFirstFileIndex(piece.torrentBeginOffset(), files)
 411                 endFile := pieceEndFileIndex(piece.torrentEndOffset(), files)
 412                 piece.files = files[beginFile:endFile]
 413                 if t.info.FilesArePieceAligned() {
 414                         numFiles := len(piece.files)
 415                         if numFiles != 1 {
 416                                 panic(fmt.Sprintf("%v:%v", beginFile, endFile))
 417                         }
 418                         if t.info.HasV2() {
 419                                 file := piece.mustGetOnlyFile()
 420                                 if file.numPieces() == 1 {
 421                                         piece.hashV2.Set(file.piecesRoot.Unwrap())
 422                                 }
 423                         }
 424                 }
 425         }
 426 }
 427
 428 func (t *Torrent) addPieceLayersLocked(layers map[string]string) (errs []error) {
 429         if layers == nil {
 430                 return
 431         }
 432 files:
 433         for _, f := range *t.files {
 434                 if !f.piecesRoot.Ok {
 435                         err := fmt.Errorf("no piece root set for file %v", f)
 436                         errs = append(errs, err)
 437                         continue files
 438                 }
 439                 compactLayer, ok := layers[string(f.piecesRoot.Value[:])]
 440                 var hashes [][32]byte
 441                 if ok {
 442                         var err error
 443                         hashes, err = merkle.CompactLayerToSliceHashes(compactLayer)
 444                         if err != nil {
 445                                 err = fmt.Errorf("bad piece layers for file %q: %w", f, err)
 446                                 errs = append(errs, err)
 447                                 continue files
 448                         }
 449                 } else if f.length > t.info.PieceLength {
 450                         // BEP 52 is pretty strongly worded about this, even though we should be able to
 451                         // recover: If a v2 torrent is added by magnet link or infohash, we need to fetch piece
 452                         // layers ourselves anyway, and that's how we can recover from this.
 453                         t.logger.Levelf(log.Warning, "no piece layers for file %q", f)
 454                         continue
 455                 } else {
 456                         hashes = [][32]byte{f.piecesRoot.Value}
 457                 }
 458                 if len(hashes) != f.numPieces() {
 459                         errs = append(
 460                                 errs,
 461                                 fmt.Errorf("file %q: got %v hashes expected %v", f, len(hashes), f.numPieces()),
 462                         )
 463                         continue files
 464                 }
 465                 root := merkle.RootWithPadHash(hashes, metainfo.HashForPiecePad(t.info.PieceLength))
 466                 if root != f.piecesRoot.Value {
 467                         errs = append(errs, fmt.Errorf("%v: expected hash %x got %x", f, f.piecesRoot.Value, root))
 468                         continue files
 469                 }
 470                 for i := range f.numPieces() {
 471                         pi := f.BeginPieceIndex() + i
 472                         p := t.piece(pi)
 473                         p.setV2Hash(hashes[i])
 474                 }
 475         }
 476         return
 477 }
 478
 479 func (t *Torrent) AddPieceLayers(layers map[string]string) (errs []error) {
 480         t.cl.lock()
 481         defer t.cl.unlock()
 482         return t.addPieceLayersLocked(layers)
 483 }
 484
 485 // Returns the index of the first file containing the piece. files must be
 486 // ordered by offset.
 487 func pieceFirstFileIndex(pieceOffset int64, files []*File) int {
 488         for i, f := range files {
 489                 if f.offset+f.length > pieceOffset {
 490                         return i
 491                 }
 492         }
 493         return 0
 494 }
 495
 496 // Returns the index after the last file containing the piece. files must be
 497 // ordered by offset.
 498 func pieceEndFileIndex(pieceEndOffset int64, files []*File) int {
 499         for i, f := range files {
 500                 if f.offset >= pieceEndOffset {
 501                         return i
 502                 }
 503         }
 504         return len(files)
 505 }
 506
 507 func (t *Torrent) cacheLength() {
 508         var l int64
 509         for _, f := range t.info.UpvertedFiles() {
 510                 l += f.Length
 511         }
 512         t._length = Some(l)
 513 }
 514
 515 // TODO: This shouldn't fail for storage reasons. Instead we should handle storage failure
 516 // separately.
 517 func (t *Torrent) setInfo(info *metainfo.Info) error {
 518         if err := validateInfo(info); err != nil {
 519                 return fmt.Errorf("bad info: %s", err)
 520         }
 521         if t.storageOpener != nil {
 522                 var err error
 523                 t.storage, err = t.storageOpener.OpenTorrent(info, *t.canonicalShortInfohash())
 524                 if err != nil {
 525                         return fmt.Errorf("error opening torrent storage: %s", err)
 526                 }
 527         }
 528         t.nameMu.Lock()
 529         t.info = info
 530         t.nameMu.Unlock()
 531         t._chunksPerRegularPiece = chunkIndexType((pp.Integer(t.usualPieceSize()) + t.chunkSize - 1) / t.chunkSize)
 532         t.updateComplete()
 533         t.displayName = "" // Save a few bytes lol.
 534         t.initFiles()
 535         t.cacheLength()
 536         t.makePieces()
 537         return nil
 538 }
 539
 540 func (t *Torrent) pieceRequestOrderKey(i int) request_strategy.PieceRequestOrderKey {
 541         return request_strategy.PieceRequestOrderKey{
 542                 InfoHash: *t.canonicalShortInfohash(),
 543                 Index:    i,
 544         }
 545 }
 546
 547 // This seems to be all the follow-up tasks after info is set, that can't fail.
 548 func (t *Torrent) onSetInfo() {
 549         t.pieceRequestOrder = rand.Perm(t.numPieces())
 550         t.initPieceRequestOrder()
 551         MakeSliceWithLength(&t.requestPieceStates, t.numPieces())
 552         for i := range t.pieces {
 553                 p := &t.pieces[i]
 554                 // Need to add relativeAvailability before updating piece completion, as that may result in conns
 555                 // being dropped.
 556                 if p.relativeAvailability != 0 {
 557                         panic(p.relativeAvailability)
 558                 }
 559                 p.relativeAvailability = t.selectivePieceAvailabilityFromPeers(i)
 560                 t.addRequestOrderPiece(i)
 561                 t.updatePieceCompletion(i)
 562                 t.queueInitialPieceCheck(i)
 563         }
 564         t.cl.event.Broadcast()
 565         close(t.gotMetainfoC)
 566         t.updateWantPeersEvent()
 567         t.requestState = make(map[RequestIndex]requestState)
 568         t.tryCreateMorePieceHashers()
 569         t.iterPeers(func(p *Peer) {
 570                 p.onGotInfo(t.info)
 571                 p.updateRequests("onSetInfo")
 572         })
 573 }
 574
 575 // Checks the info bytes hash to expected values. Fills in any missing infohashes.
 576 func (t *Torrent) hashInfoBytes(b []byte, info *metainfo.Info) error {
 577         v1Hash := infohash.HashBytes(b)
 578         v2Hash := infohash_v2.HashBytes(b)
 579         cl := t.cl
 580         if t.infoHash.Ok && !t.infoHashV2.Ok {
 581                 if v1Hash == t.infoHash.Value {
 582                         if info.HasV2() {
 583                                 t.infoHashV2.Set(v2Hash)
 584                                 cl.torrentsByShortHash[*v2Hash.ToShort()] = t
 585                         }
 586                 } else if *v2Hash.ToShort() == t.infoHash.Value {
 587                         if !info.HasV2() {
 588                                 return errors.New("invalid v2 info")
 589                         }
 590                         t.infoHashV2.Set(v2Hash)
 591                         t.infoHash.SetNone()
 592                         if info.HasV1() {
 593                                 cl.torrentsByShortHash[v1Hash] = t
 594                                 t.infoHash.Set(v1Hash)
 595                         }
 596                 }
 597         } else if t.infoHash.Ok && t.infoHashV2.Ok {
 598                 if v1Hash != t.infoHash.Value {
 599                         return errors.New("incorrect v1 infohash")
 600                 }
 601                 if v2Hash != t.infoHashV2.Value {
 602                         return errors.New("incorrect v2 infohash")
 603                 }
 604         } else if !t.infoHash.Ok && t.infoHashV2.Ok {
 605                 if v2Hash != t.infoHashV2.Value {
 606                         return errors.New("incorrect v2 infohash")
 607                 }
 608                 if info.HasV1() {
 609                         t.infoHash.Set(v1Hash)
 610                         cl.torrentsByShortHash[v1Hash] = t
 611                 }
 612         } else {
 613                 panic("no expected infohashes")
 614         }
 615         return nil
 616 }
 617
 618 // Called when metadata for a torrent becomes available.
 619 func (t *Torrent) setInfoBytesLocked(b []byte) (err error) {
 620         var info metainfo.Info
 621         err = bencode.Unmarshal(b, &info)
 622         if err != nil {
 623                 err = fmt.Errorf("unmarshalling info bytes: %w", err)
 624                 return
 625         }
 626         err = t.hashInfoBytes(b, &info)
 627         if err != nil {
 628                 return
 629         }
 630         t.metadataBytes = b
 631         t.metadataCompletedChunks = nil
 632         if t.info != nil {
 633                 return nil
 634         }
 635         if err := t.setInfo(&info); err != nil {
 636                 return err
 637         }
 638         t.onSetInfo()
 639         return nil
 640 }
 641
 642 func (t *Torrent) haveAllMetadataPieces() bool {
 643         if t.haveInfo() {
 644                 return true
 645         }
 646         if t.metadataCompletedChunks == nil {
 647                 return false
 648         }
 649         for _, have := range t.metadataCompletedChunks {
 650                 if !have {
 651                         return false
 652                 }
 653         }
 654         return true
 655 }
 656
 657 // TODO: Propagate errors to disconnect peer.
 658 func (t *Torrent) setMetadataSize(size int) (err error) {
 659         if t.haveInfo() {
 660                 // We already know the correct metadata size.
 661                 return
 662         }
 663         if uint32(size) > maxMetadataSize {
 664                 return log.WithLevel(log.Warning, errors.New("bad size"))
 665         }
 666         if len(t.metadataBytes) == size {
 667                 return
 668         }
 669         t.metadataBytes = make([]byte, size)
 670         t.metadataCompletedChunks = make([]bool, (size+(1<<14)-1)/(1<<14))
 671         t.metadataChanged.Broadcast()
 672         for c := range t.conns {
 673                 c.requestPendingMetadata()
 674         }
 675         return
 676 }
 677
 678 // The current working name for the torrent. Either the name in the info dict,
 679 // or a display name given such as by the dn value in a magnet link, or "".
 680 func (t *Torrent) name() string {
 681         t.nameMu.RLock()
 682         defer t.nameMu.RUnlock()
 683         if t.haveInfo() {
 684                 return t.info.BestName()
 685         }
 686         if t.displayName != "" {
 687                 return t.displayName
 688         }
 689         return "infohash:" + t.canonicalShortInfohash().HexString()
 690 }
 691
 692 func (t *Torrent) pieceState(index pieceIndex) (ret PieceState) {
 693         p := &t.pieces[index]
 694         ret.Priority = p.effectivePriority()
 695         ret.Completion = p.completion()
 696         ret.QueuedForHash = p.queuedForHash()
 697         ret.Hashing = p.hashing
 698         ret.Checking = ret.QueuedForHash || ret.Hashing
 699         ret.Marking = p.marking
 700         if !ret.Complete && t.piecePartiallyDownloaded(index) {
 701                 ret.Partial = true
 702         }
 703         if t.info.HasV2() && !p.hashV2.Ok {
 704                 ret.MissingPieceLayerHash = true
 705         }
 706         return
 707 }
 708
 709 func (t *Torrent) metadataPieceSize(piece int) int {
 710         return metadataPieceSize(len(t.metadataBytes), piece)
 711 }
 712
 713 func (t *Torrent) newMetadataExtensionMessage(c *PeerConn, msgType pp.ExtendedMetadataRequestMsgType, piece int, data []byte) pp.Message {
 714         return pp.Message{
 715                 Type:       pp.Extended,
 716                 ExtendedID: c.PeerExtensionIDs[pp.ExtensionNameMetadata],
 717                 ExtendedPayload: append(bencode.MustMarshal(pp.ExtendedMetadataRequestMsg{
 718                         Piece:     piece,
 719                         TotalSize: len(t.metadataBytes),
 720                         Type:      msgType,
 721                 }), data...),
 722         }
 723 }
 724
 725 type pieceAvailabilityRun struct {
 726         Count        pieceIndex
 727         Availability int
 728 }
 729
 730 func (me pieceAvailabilityRun) String() string {
 731         return fmt.Sprintf("%v(%v)", me.Count, me.Availability)
 732 }
 733
 734 func (t *Torrent) pieceAvailabilityRuns() (ret []pieceAvailabilityRun) {
 735         rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
 736                 ret = append(ret, pieceAvailabilityRun{Availability: el.(int), Count: int(count)})
 737         })
 738         for i := range t.pieces {
 739                 rle.Append(t.pieces[i].availability(), 1)
 740         }
 741         rle.Flush()
 742         return
 743 }
 744
 745 func (t *Torrent) pieceAvailabilityFrequencies() (freqs []int) {
 746         freqs = make([]int, t.numActivePeers()+1)
 747         for i := range t.pieces {
 748                 freqs[t.piece(i).availability()]++
 749         }
 750         return
 751 }
 752
 753 func (t *Torrent) pieceStateRuns() (ret PieceStateRuns) {
 754         rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
 755                 ret = append(ret, PieceStateRun{
 756                         PieceState: el.(PieceState),
 757                         Length:     int(count),
 758                 })
 759         })
 760         for index := range t.pieces {
 761                 rle.Append(t.pieceState(index), 1)
 762         }
 763         rle.Flush()
 764         return
 765 }
 766
 767 // Produces a small string representing a PieceStateRun.
 768 func (psr PieceStateRun) String() (ret string) {
 769         ret = fmt.Sprintf("%d", psr.Length)
 770         ret += func() string {
 771                 switch psr.Priority {
 772                 case PiecePriorityNext:
 773                         return "N"
 774                 case PiecePriorityNormal:
 775                         return "."
 776                 case PiecePriorityReadahead:
 777                         return "R"
 778                 case PiecePriorityNow:
 779                         return "!"
 780                 case PiecePriorityHigh:
 781                         return "H"
 782                 default:
 783                         return ""
 784                 }
 785         }()
 786         if psr.Hashing {
 787                 ret += "H"
 788         }
 789         if psr.QueuedForHash {
 790                 ret += "Q"
 791         }
 792         if psr.Marking {
 793                 ret += "M"
 794         }
 795         if psr.Partial {
 796                 ret += "P"
 797         }
 798         if psr.Complete {
 799                 ret += "C"
 800         }
 801         if !psr.Ok {
 802                 ret += "?"
 803         }
 804         if psr.MissingPieceLayerHash {
 805                 ret += "h"
 806         }
 807         return
 808 }
 809
 810 func (t *Torrent) writeStatus(w io.Writer) {
 811         if t.infoHash.Ok {
 812                 fmt.Fprintf(w, "Infohash: %s\n", t.infoHash.Value.HexString())
 813         }
 814         if t.infoHashV2.Ok {
 815                 fmt.Fprintf(w, "Infohash v2: %s\n", t.infoHashV2.Value.HexString())
 816         }
 817         fmt.Fprintf(w, "Metadata length: %d\n", t.metadataSize())
 818         if !t.haveInfo() {
 819                 fmt.Fprintf(w, "Metadata have: ")
 820                 for _, h := range t.metadataCompletedChunks {
 821                         fmt.Fprintf(w, "%c", func() rune {
 822                                 if h {
 823                                         return 'H'
 824                                 } else {
 825                                         return '.'
 826                                 }
 827                         }())
 828                 }
 829                 fmt.Fprintln(w)
 830         }
 831         fmt.Fprintf(w, "Piece length: %s\n",
 832                 func() string {
 833                         if t.haveInfo() {
 834                                 return fmt.Sprintf("%v (%v chunks)",
 835                                         t.usualPieceSize(),
 836                                         float64(t.usualPieceSize())/float64(t.chunkSize))
 837                         } else {
 838                                 return "no info"
 839                         }
 840                 }(),
 841         )
 842         if t.info != nil {
 843                 fmt.Fprintf(w, "Num Pieces: %d (%d completed)\n", t.numPieces(), t.numPiecesCompleted())
 844                 fmt.Fprintf(w, "Piece States: %s\n", t.pieceStateRuns())
 845                 // Generates a huge, unhelpful listing when piece availability is very scattered. Prefer
 846                 // availability frequencies instead.
 847                 if false {
 848                         fmt.Fprintf(w, "Piece availability: %v\n", strings.Join(func() (ret []string) {
 849                                 for _, run := range t.pieceAvailabilityRuns() {
 850                                         ret = append(ret, run.String())
 851                                 }
 852                                 return
 853                         }(), " "))
 854                 }
 855                 fmt.Fprintf(w, "Piece availability frequency: %v\n", strings.Join(
 856                         func() (ret []string) {
 857                                 for avail, freq := range t.pieceAvailabilityFrequencies() {
 858                                         if freq == 0 {
 859                                                 continue
 860                                         }
 861                                         ret = append(ret, fmt.Sprintf("%v: %v", avail, freq))
 862                                 }
 863                                 return
 864                         }(),
 865                         ", "))
 866         }
 867         fmt.Fprintf(w, "Reader Pieces:")
 868         t.forReaderOffsetPieces(func(begin, end pieceIndex) (again bool) {
 869                 fmt.Fprintf(w, " %d:%d", begin, end)
 870                 return true
 871         })
 872         fmt.Fprintln(w)
 873
 874         fmt.Fprintf(w, "Enabled trackers:\n")
 875         func() {
 876                 tw := tabwriter.NewWriter(w, 0, 0, 2, ' ', 0)
 877                 fmt.Fprintf(tw, "    URL\tExtra\n")
 878                 for _, ta := range slices.Sort(slices.FromMapElems(t.trackerAnnouncers), func(l, r torrentTrackerAnnouncer) bool {
 879                         lu := l.URL()
 880                         ru := r.URL()
 881                         var luns, runs url.URL = *lu, *ru
 882                         luns.Scheme = ""
 883                         runs.Scheme = ""
 884                         var ml missinggo.MultiLess
 885                         ml.StrictNext(luns.String() == runs.String(), luns.String() < runs.String())
 886                         ml.StrictNext(lu.String() == ru.String(), lu.String() < ru.String())
 887                         return ml.Less()
 888                 }).([]torrentTrackerAnnouncer) {
 889                         fmt.Fprintf(tw, "    %q\t%v\n", ta.URL(), ta.statusLine())
 890                 }
 891                 tw.Flush()
 892         }()
 893
 894         fmt.Fprintf(w, "DHT Announces: %d\n", t.numDHTAnnounces)
 895
 896         dumpStats(w, t.statsLocked())
 897
 898         fmt.Fprintf(w, "webseeds:\n")
 899         t.writePeerStatuses(w, maps.Values(t.webSeeds))
 900
 901         peerConns := maps.Keys(t.conns)
 902         // Peers without priorities first, then those with. I'm undecided about how to order peers
 903         // without priorities.
 904         sort.Slice(peerConns, func(li, ri int) bool {
 905                 l := peerConns[li]
 906                 r := peerConns[ri]
 907                 ml := multiless.New()
 908                 lpp := g.ResultFromTuple(l.peerPriority()).ToOption()
 909                 rpp := g.ResultFromTuple(r.peerPriority()).ToOption()
 910                 ml = ml.Bool(lpp.Ok, rpp.Ok)
 911                 ml = ml.Uint32(rpp.Value, lpp.Value)
 912                 return ml.Less()
 913         })
 914
 915         fmt.Fprintf(w, "%v peer conns:\n", len(peerConns))
 916         t.writePeerStatuses(w, g.SliceMap(peerConns, func(pc *PeerConn) *Peer {
 917                 return &pc.Peer
 918         }))
 919 }
 920
 921 func (t *Torrent) writePeerStatuses(w io.Writer, peers []*Peer) {
 922         var buf bytes.Buffer
 923         for _, c := range peers {
 924                 fmt.Fprintf(w, "- ")
 925                 buf.Reset()
 926                 c.writeStatus(&buf)
 927                 w.Write(bytes.TrimRight(
 928                         bytes.ReplaceAll(buf.Bytes(), []byte("\n"), []byte("\n  ")),
 929                         " "))
 930         }
 931 }
 932
 933 func (t *Torrent) haveInfo() bool {
 934         return t.info != nil
 935 }
 936
 937 // Returns a run-time generated MetaInfo that includes the info bytes and
 938 // announce-list as currently known to the client.
 939 func (t *Torrent) newMetaInfo() metainfo.MetaInfo {
 940         return metainfo.MetaInfo{
 941                 CreationDate: time.Now().Unix(),
 942                 Comment:      "dynamic metainfo from client",
 943                 CreatedBy:    "https://github.com/anacrolix/torrent",
 944                 AnnounceList: t.metainfo.UpvertedAnnounceList().Clone(),
 945                 InfoBytes: func() []byte {
 946                         if t.haveInfo() {
 947                                 return t.metadataBytes
 948                         } else {
 949                                 return nil
 950                         }
 951                 }(),
 952                 UrlList: func() []string {
 953                         ret := make([]string, 0, len(t.webSeeds))
 954                         for url := range t.webSeeds {
 955                                 ret = append(ret, url)
 956                         }
 957                         return ret
 958                 }(),
 959                 PieceLayers: t.pieceLayers(),
 960         }
 961 }
 962
 963 // Returns a count of bytes that are not complete in storage, and not pending being written to
 964 // storage. This value is from the perspective of the download manager, and may not agree with the
 965 // actual state in storage. If you want read data synchronously you should use a Reader. See
 966 // https://github.com/anacrolix/torrent/issues/828.
 967 func (t *Torrent) BytesMissing() (n int64) {
 968         t.cl.rLock()
 969         n = t.bytesMissingLocked()
 970         t.cl.rUnlock()
 971         return
 972 }
 973
 974 func (t *Torrent) bytesMissingLocked() int64 {
 975         return t.bytesLeft()
 976 }
 977
 978 func iterFlipped(b *roaring.Bitmap, end uint64, cb func(uint32) bool) {
 979         roaring.Flip(b, 0, end).Iterate(cb)
 980 }
 981
 982 func (t *Torrent) bytesLeft() (left int64) {
 983         iterFlipped(&t._completedPieces, uint64(t.numPieces()), func(x uint32) bool {
 984                 p := t.piece(pieceIndex(x))
 985                 left += int64(p.length() - p.numDirtyBytes())
 986                 return true
 987         })
 988         return
 989 }
 990
 991 // Bytes left to give in tracker announces.
 992 func (t *Torrent) bytesLeftAnnounce() int64 {
 993         if t.haveInfo() {
 994                 return t.bytesLeft()
 995         } else {
 996                 return -1
 997         }
 998 }
 999
1000 func (t *Torrent) piecePartiallyDownloaded(piece pieceIndex) bool {
1001         if t.pieceComplete(piece) {
1002                 return false
1003         }
1004         if t.pieceAllDirty(piece) {
1005                 return false
1006         }
1007         return t.pieces[piece].hasDirtyChunks()
1008 }
1009
1010 func (t *Torrent) usualPieceSize() int {
1011         return int(t.info.PieceLength)
1012 }
1013
1014 func (t *Torrent) numPieces() pieceIndex {
1015         return t.info.NumPieces()
1016 }
1017
1018 func (t *Torrent) numPiecesCompleted() (num pieceIndex) {
1019         return pieceIndex(t._completedPieces.GetCardinality())
1020 }
1021
1022 func (t *Torrent) close(wg *sync.WaitGroup) (err error) {
1023         if !t.closed.Set() {
1024                 err = errors.New("already closed")
1025                 return
1026         }
1027         for _, f := range t.onClose {
1028                 f()
1029         }
1030         if t.storage != nil {
1031                 wg.Add(1)
1032                 go func() {
1033                         defer wg.Done()
1034                         t.storageLock.Lock()
1035                         defer t.storageLock.Unlock()
1036                         if f := t.storage.Close; f != nil {
1037                                 err1 := f()
1038                                 if err1 != nil {
1039                                         t.logger.WithDefaultLevel(log.Warning).Printf("error closing storage: %v", err1)
1040                                 }
1041                         }
1042                 }()
1043         }
1044         t.iterPeers(func(p *Peer) {
1045                 p.close()
1046         })
1047         if t.storage != nil {
1048                 t.deletePieceRequestOrder()
1049         }
1050         t.assertAllPiecesRelativeAvailabilityZero()
1051         t.pex.Reset()
1052         t.cl.event.Broadcast()
1053         t.pieceStateChanges.Close()
1054         t.updateWantPeersEvent()
1055         return
1056 }
1057
1058 func (t *Torrent) assertAllPiecesRelativeAvailabilityZero() {
1059         for i := range t.pieces {
1060                 p := t.piece(i)
1061                 if p.relativeAvailability != 0 {
1062                         panic(fmt.Sprintf("piece %v has relative availability %v", i, p.relativeAvailability))
1063                 }
1064         }
1065 }
1066
1067 func (t *Torrent) requestOffset(r Request) int64 {
1068         return torrentRequestOffset(t.length(), int64(t.usualPieceSize()), r)
1069 }
1070
1071 // Return the request that would include the given offset into the torrent data. Returns !ok if
1072 // there is no such request.
1073 func (t *Torrent) offsetRequest(off int64) (req Request, ok bool) {
1074         return torrentOffsetRequest(t.length(), t.info.PieceLength, int64(t.chunkSize), off)
1075 }
1076
1077 func (t *Torrent) writeChunk(piece int, begin int64, data []byte) (err error) {
1078         //defer perf.ScopeTimerErr(&err)()
1079         n, err := t.pieces[piece].Storage().WriteAt(data, begin)
1080         if err == nil && n != len(data) {
1081                 err = io.ErrShortWrite
1082         }
1083         return err
1084 }
1085
1086 func (t *Torrent) bitfield() (bf []bool) {
1087         bf = make([]bool, t.numPieces())
1088         t._completedPieces.Iterate(func(piece uint32) (again bool) {
1089                 bf[piece] = true
1090                 return true
1091         })
1092         return
1093 }
1094
1095 func (t *Torrent) pieceNumChunks(piece pieceIndex) chunkIndexType {
1096         return chunkIndexType((t.pieceLength(piece) + t.chunkSize - 1) / t.chunkSize)
1097 }
1098
1099 func (t *Torrent) chunksPerRegularPiece() chunkIndexType {
1100         return t._chunksPerRegularPiece
1101 }
1102
1103 func (t *Torrent) numChunks() RequestIndex {
1104         if t.numPieces() == 0 {
1105                 return 0
1106         }
1107         return RequestIndex(t.numPieces()-1)*t.chunksPerRegularPiece() + t.pieceNumChunks(t.numPieces()-1)
1108 }
1109
1110 func (t *Torrent) pendAllChunkSpecs(pieceIndex pieceIndex) {
1111         t.dirtyChunks.RemoveRange(
1112                 uint64(t.pieceRequestIndexOffset(pieceIndex)),
1113                 uint64(t.pieceRequestIndexOffset(pieceIndex+1)))
1114 }
1115
1116 func (t *Torrent) pieceLength(piece pieceIndex) pp.Integer {
1117         if t.info.PieceLength == 0 {
1118                 // There will be no variance amongst pieces. Only pain.
1119                 return 0
1120         }
1121         if t.info.FilesArePieceAligned() {
1122                 p := t.piece(piece)
1123                 file := p.mustGetOnlyFile()
1124                 if piece == file.EndPieceIndex()-1 {
1125                         return pp.Integer(file.length - (p.torrentBeginOffset() - file.offset))
1126                 }
1127                 return pp.Integer(t.usualPieceSize())
1128         }
1129         if piece == t.numPieces()-1 {
1130                 ret := pp.Integer(t.length() % t.info.PieceLength)
1131                 if ret != 0 {
1132                         return ret
1133                 }
1134         }
1135         return pp.Integer(t.info.PieceLength)
1136 }
1137
1138 func (t *Torrent) smartBanBlockCheckingWriter(piece pieceIndex) *blockCheckingWriter {
1139         return &blockCheckingWriter{
1140                 cache:        &t.smartBanCache,
1141                 requestIndex: t.pieceRequestIndexOffset(piece),
1142                 chunkSize:    t.chunkSize.Int(),
1143         }
1144 }
1145
1146 func (t *Torrent) hashPiece(piece pieceIndex) (
1147         correct bool,
1148         // These are peers that sent us blocks that differ from what we hash here.
1149         differingPeers map[bannableAddr]struct{},
1150         err error,
1151 ) {
1152         p := t.piece(piece)
1153         p.waitNoPendingWrites()
1154         storagePiece := p.Storage()
1155
1156         var h hash.Hash
1157         if p.hash != nil {
1158                 h = pieceHash.New()
1159
1160                 // Does the backend want to do its own hashing?
1161                 if i, ok := storagePiece.PieceImpl.(storage.SelfHashing); ok {
1162                         var sum metainfo.Hash
1163                         // log.Printf("A piece decided to self-hash: %d", piece)
1164                         sum, err = i.SelfHash()
1165                         correct = sum == *p.hash
1166                         // Can't do smart banning without reading the piece. The smartBanCache is still cleared
1167                         // in pieceHasher regardless.
1168                         return
1169                 }
1170
1171         } else if p.hashV2.Ok {
1172                 h = merkle.NewHash()
1173         } else {
1174                 panic("no hash")
1175         }
1176
1177         const logPieceContents = false
1178         smartBanWriter := t.smartBanBlockCheckingWriter(piece)
1179         writers := []io.Writer{h, smartBanWriter}
1180         var examineBuf bytes.Buffer
1181         if logPieceContents {
1182                 writers = append(writers, &examineBuf)
1183         }
1184         var written int64
1185         written, err = storagePiece.WriteTo(io.MultiWriter(writers...))
1186         if err == nil && written != int64(p.length()) {
1187                 err = fmt.Errorf("wrote %v bytes from storage, piece has length %v", written, p.length())
1188         }
1189         if logPieceContents {
1190                 t.logger.WithDefaultLevel(log.Debug).Printf("hashed %q with copy err %v", examineBuf.Bytes(), err)
1191         }
1192         smartBanWriter.Flush()
1193         differingPeers = smartBanWriter.badPeers
1194         if p.hash != nil {
1195                 var sum [20]byte
1196                 n := len(h.Sum(sum[:0]))
1197                 if n != 20 {
1198                         panic(n)
1199                 }
1200                 correct = sum == *p.hash
1201         } else if p.hashV2.Ok {
1202                 var sum [32]byte
1203                 n := len(h.Sum(sum[:0]))
1204                 if n != 32 {
1205                         panic(n)
1206                 }
1207                 correct = sum == p.hashV2.Value
1208         } else {
1209                 panic("no hash")
1210         }
1211         return
1212 }
1213
1214 func (t *Torrent) haveAnyPieces() bool {
1215         return !t._completedPieces.IsEmpty()
1216 }
1217
1218 func (t *Torrent) haveAllPieces() bool {
1219         if !t.haveInfo() {
1220                 return false
1221         }
1222         return t._completedPieces.GetCardinality() == bitmap.BitRange(t.numPieces())
1223 }
1224
1225 func (t *Torrent) havePiece(index pieceIndex) bool {
1226         return t.haveInfo() && t.pieceComplete(index)
1227 }
1228
1229 func (t *Torrent) maybeDropMutuallyCompletePeer(
1230         // I'm not sure about taking peer here, not all peer implementations actually drop. Maybe that's
1231         // okay?
1232         p *PeerConn,
1233 ) {
1234         if !t.cl.config.DropMutuallyCompletePeers {
1235                 return
1236         }
1237         if !t.haveAllPieces() {
1238                 return
1239         }
1240         if all, known := p.peerHasAllPieces(); !(known && all) {
1241                 return
1242         }
1243         if p.useful() {
1244                 return
1245         }
1246         p.logger.Levelf(log.Debug, "is mutually complete; dropping")
1247         p.drop()
1248 }
1249
1250 func (t *Torrent) haveChunk(r Request) (ret bool) {
1251         // defer func() {
1252         //      log.Println("have chunk", r, ret)
1253         // }()
1254         if !t.haveInfo() {
1255                 return false
1256         }
1257         if t.pieceComplete(pieceIndex(r.Index)) {
1258                 return true
1259         }
1260         p := &t.pieces[r.Index]
1261         return !p.pendingChunk(r.ChunkSpec, t.chunkSize)
1262 }
1263
1264 func chunkIndexFromChunkSpec(cs ChunkSpec, chunkSize pp.Integer) chunkIndexType {
1265         return chunkIndexType(cs.Begin / chunkSize)
1266 }
1267
1268 func (t *Torrent) wantPieceIndex(index pieceIndex) bool {
1269         return !t._pendingPieces.IsEmpty() && t._pendingPieces.Contains(uint32(index))
1270 }
1271
1272 // A pool of []*PeerConn, to reduce allocations in functions that need to index or sort Torrent
1273 // conns (which is a map).
1274 var peerConnSlices sync.Pool
1275
1276 func getPeerConnSlice(cap int) []*PeerConn {
1277         getInterface := peerConnSlices.Get()
1278         if getInterface == nil {
1279                 return make([]*PeerConn, 0, cap)
1280         } else {
1281                 return getInterface.([]*PeerConn)[:0]
1282         }
1283 }
1284
1285 // Calls the given function with a slice of unclosed conns. It uses a pool to reduce allocations as
1286 // this is a frequent occurrence.
1287 func (t *Torrent) withUnclosedConns(f func([]*PeerConn)) {
1288         sl := t.appendUnclosedConns(getPeerConnSlice(len(t.conns)))
1289         f(sl)
1290         peerConnSlices.Put(sl)
1291 }
1292
1293 func (t *Torrent) worstBadConnFromSlice(opts worseConnLensOpts, sl []*PeerConn) *PeerConn {
1294         wcs := worseConnSlice{conns: sl}
1295         wcs.initKeys(opts)
1296         heap.Init(&wcs)
1297         for wcs.Len() != 0 {
1298                 c := heap.Pop(&wcs).(*PeerConn)
1299                 if opts.incomingIsBad && !c.outgoing {
1300                         return c
1301                 }
1302                 if opts.outgoingIsBad && c.outgoing {
1303                         return c
1304                 }
1305                 if c._stats.ChunksReadWasted.Int64() >= 6 && c._stats.ChunksReadWasted.Int64() > c._stats.ChunksReadUseful.Int64() {
1306                         return c
1307                 }
1308                 // If the connection is in the worst half of the established
1309                 // connection quota and is older than a minute.
1310                 if wcs.Len() >= (t.maxEstablishedConns+1)/2 {
1311                         // Give connections 1 minute to prove themselves.
1312                         if time.Since(c.completedHandshake) > time.Minute {
1313                                 return c
1314                         }
1315                 }
1316         }
1317         return nil
1318 }
1319
1320 // The worst connection is one that hasn't been sent, or sent anything useful for the longest. A bad
1321 // connection is one that usually sends us unwanted pieces, or has been in the worse half of the
1322 // established connections for more than a minute. This is O(n log n). If there was a way to not
1323 // consider the position of a conn relative to the total number, it could be reduced to O(n).
1324 func (t *Torrent) worstBadConn(opts worseConnLensOpts) (ret *PeerConn) {
1325         t.withUnclosedConns(func(ucs []*PeerConn) {
1326                 ret = t.worstBadConnFromSlice(opts, ucs)
1327         })
1328         return
1329 }
1330
1331 type PieceStateChange struct {
1332         Index int
1333         PieceState
1334 }
1335
1336 func (t *Torrent) publishPieceStateChange(piece pieceIndex) {
1337         t.cl._mu.Defer(func() {
1338                 cur := t.pieceState(piece)
1339                 p := &t.pieces[piece]
1340                 if cur != p.publicPieceState {
1341                         p.publicPieceState = cur
1342                         t.pieceStateChanges.Publish(PieceStateChange{
1343                                 int(piece),
1344                                 cur,
1345                         })
1346                 }
1347         })
1348 }
1349
1350 func (t *Torrent) pieceNumPendingChunks(piece pieceIndex) pp.Integer {
1351         if t.pieceComplete(piece) {
1352                 return 0
1353         }
1354         return pp.Integer(t.pieceNumChunks(piece) - t.pieces[piece].numDirtyChunks())
1355 }
1356
1357 func (t *Torrent) pieceAllDirty(piece pieceIndex) bool {
1358         return t.pieces[piece].allChunksDirty()
1359 }
1360
1361 func (t *Torrent) readersChanged() {
1362         t.updateReaderPieces()
1363         t.updateAllPiecePriorities("Torrent.readersChanged")
1364 }
1365
1366 func (t *Torrent) updateReaderPieces() {
1367         t._readerNowPieces, t._readerReadaheadPieces = t.readerPiecePriorities()
1368 }
1369
1370 func (t *Torrent) readerPosChanged(from, to pieceRange) {
1371         if from == to {
1372                 return
1373         }
1374         t.updateReaderPieces()
1375         // Order the ranges, high and low.
1376         l, h := from, to
1377         if l.begin > h.begin {
1378                 l, h = h, l
1379         }
1380         if l.end < h.begin {
1381                 // Two distinct ranges.
1382                 t.updatePiecePriorities(l.begin, l.end, "Torrent.readerPosChanged")
1383                 t.updatePiecePriorities(h.begin, h.end, "Torrent.readerPosChanged")
1384         } else {
1385                 // Ranges overlap.
1386                 end := l.end
1387                 if h.end > end {
1388                         end = h.end
1389                 }
1390                 t.updatePiecePriorities(l.begin, end, "Torrent.readerPosChanged")
1391         }
1392 }
1393
1394 func (t *Torrent) maybeNewConns() {
1395         // Tickle the accept routine.
1396         t.cl.event.Broadcast()
1397         t.openNewConns()
1398 }
1399
1400 func (t *Torrent) onPiecePendingTriggers(piece pieceIndex, reason string) {
1401         if t._pendingPieces.Contains(uint32(piece)) {
1402                 t.iterPeers(func(c *Peer) {
1403                         // if c.requestState.Interested {
1404                         //      return
1405                         // }
1406                         if !c.isLowOnRequests() {
1407                                 return
1408                         }
1409                         if !c.peerHasPiece(piece) {
1410                                 return
1411                         }
1412                         if c.requestState.Interested && c.peerChoking && !c.peerAllowedFast.Contains(piece) {
1413                                 return
1414                         }
1415                         c.updateRequests(reason)
1416                 })
1417         }
1418         t.maybeNewConns()
1419         t.publishPieceStateChange(piece)
1420 }
1421
1422 func (t *Torrent) updatePiecePriorityNoTriggers(piece pieceIndex) (pendingChanged bool) {
1423         if !t.closed.IsSet() {
1424                 // It would be possible to filter on pure-priority changes here to avoid churning the piece
1425                 // request order.
1426                 t.updatePieceRequestOrderPiece(piece)
1427         }
1428         p := t.piece(piece)
1429         newPrio := p.effectivePriority()
1430         // t.logger.Printf("torrent %p: piece %d: uncached priority: %v", t, piece, newPrio)
1431         if newPrio == PiecePriorityNone && p.haveHash() {
1432                 return t._pendingPieces.CheckedRemove(uint32(piece))
1433         } else {
1434                 return t._pendingPieces.CheckedAdd(uint32(piece))
1435         }
1436 }
1437
1438 func (t *Torrent) updatePiecePriority(piece pieceIndex, reason string) {
1439         if t.updatePiecePriorityNoTriggers(piece) && !t.disableTriggers {
1440                 t.onPiecePendingTriggers(piece, reason)
1441         }
1442         t.updatePieceRequestOrderPiece(piece)
1443 }
1444
1445 func (t *Torrent) updateAllPiecePriorities(reason string) {
1446         t.updatePiecePriorities(0, t.numPieces(), reason)
1447 }
1448
1449 // Update all piece priorities in one hit. This function should have the same
1450 // output as updatePiecePriority, but across all pieces.
1451 func (t *Torrent) updatePiecePriorities(begin, end pieceIndex, reason string) {
1452         for i := begin; i < end; i++ {
1453                 t.updatePiecePriority(i, reason)
1454         }
1455 }
1456
1457 // Returns the range of pieces [begin, end) that contains the extent of bytes.
1458 func (t *Torrent) byteRegionPieces(off, size int64) (begin, end pieceIndex) {
1459         if off >= t.length() {
1460                 return
1461         }
1462         if off < 0 {
1463                 size += off
1464                 off = 0
1465         }
1466         if size <= 0 {
1467                 return
1468         }
1469         begin = pieceIndex(off / t.info.PieceLength)
1470         end = pieceIndex((off + size + t.info.PieceLength - 1) / t.info.PieceLength)
1471         if end > pieceIndex(t.info.NumPieces()) {
1472                 end = pieceIndex(t.info.NumPieces())
1473         }
1474         return
1475 }
1476
1477 // Returns true if all iterations complete without breaking. Returns the read regions for all
1478 // readers. The reader regions should not be merged as some callers depend on this method to
1479 // enumerate readers.
1480 func (t *Torrent) forReaderOffsetPieces(f func(begin, end pieceIndex) (more bool)) (all bool) {
1481         for r := range t.readers {
1482                 p := r.pieces
1483                 if p.begin >= p.end {
1484                         continue
1485                 }
1486                 if !f(p.begin, p.end) {
1487                         return false
1488                 }
1489         }
1490         return true
1491 }
1492
1493 func (t *Torrent) pendRequest(req RequestIndex) {
1494         t.piece(t.pieceIndexOfRequestIndex(req)).pendChunkIndex(req % t.chunksPerRegularPiece())
1495 }
1496
1497 func (t *Torrent) pieceCompletionChanged(piece pieceIndex, reason string) {
1498         t.cl.event.Broadcast()
1499         if t.pieceComplete(piece) {
1500                 t.onPieceCompleted(piece)
1501         } else {
1502                 t.onIncompletePiece(piece)
1503         }
1504         t.updatePiecePriority(piece, reason)
1505 }
1506
1507 func (t *Torrent) numReceivedConns() (ret int) {
1508         for c := range t.conns {
1509                 if c.Discovery == PeerSourceIncoming {
1510                         ret++
1511                 }
1512         }
1513         return
1514 }
1515
1516 func (t *Torrent) numOutgoingConns() (ret int) {
1517         for c := range t.conns {
1518                 if c.outgoing {
1519                         ret++
1520                 }
1521         }
1522         return
1523 }
1524
1525 func (t *Torrent) maxHalfOpen() int {
1526         // Note that if we somehow exceed the maximum established conns, we want
1527         // the negative value to have an effect.
1528         establishedHeadroom := int64(t.maxEstablishedConns - len(t.conns))
1529         extraIncoming := int64(t.numReceivedConns() - t.maxEstablishedConns/2)
1530         // We want to allow some experimentation with new peers, and to try to
1531         // upset an oversupply of received connections.
1532         return int(min(
1533                 max(5, extraIncoming)+establishedHeadroom,
1534                 int64(t.cl.config.HalfOpenConnsPerTorrent),
1535         ))
1536 }
1537
1538 func (t *Torrent) openNewConns() (initiated int) {
1539         defer t.updateWantPeersEvent()
1540         for t.peers.Len() != 0 {
1541                 if !t.wantOutgoingConns() {
1542                         return
1543                 }
1544                 if len(t.halfOpen) >= t.maxHalfOpen() {
1545                         return
1546                 }
1547                 if len(t.cl.dialers) == 0 {
1548                         return
1549                 }
1550                 if t.cl.numHalfOpen >= t.cl.config.TotalHalfOpenConns {
1551                         return
1552                 }
1553                 p := t.peers.PopMax()
1554                 opts := outgoingConnOpts{
1555                         peerInfo:                 p,
1556                         t:                        t,
1557                         requireRendezvous:        false,
1558                         skipHolepunchRendezvous:  false,
1559                         receivedHolepunchConnect: false,
1560                         HeaderObfuscationPolicy:  t.cl.config.HeaderObfuscationPolicy,
1561                 }
1562                 initiateConn(opts, false)
1563                 initiated++
1564         }
1565         return
1566 }
1567
1568 func (t *Torrent) updatePieceCompletion(piece pieceIndex) bool {
1569         p := t.piece(piece)
1570         uncached := t.pieceCompleteUncached(piece)
1571         cached := p.completion()
1572         changed := cached != uncached
1573         complete := uncached.Complete
1574         p.storageCompletionOk = uncached.Ok
1575         x := uint32(piece)
1576         if complete {
1577                 t._completedPieces.Add(x)
1578                 t.openNewConns()
1579         } else {
1580                 t._completedPieces.Remove(x)
1581         }
1582         p.t.updatePieceRequestOrderPiece(piece)
1583         t.updateComplete()
1584         if complete && len(p.dirtiers) != 0 {
1585                 t.logger.Printf("marked piece %v complete but still has dirtiers", piece)
1586         }
1587         if changed {
1588                 //slog.Debug(
1589                 //      "piece completion changed",
1590                 //      slog.Int("piece", piece),
1591                 //      slog.Any("from", cached),
1592                 //      slog.Any("to", uncached))
1593                 t.pieceCompletionChanged(piece, "Torrent.updatePieceCompletion")
1594         }
1595         return changed
1596 }
1597
1598 // Non-blocking read. Client lock is not required.
1599 func (t *Torrent) readAt(b []byte, off int64) (n int, err error) {
1600         for len(b) != 0 {
1601                 p := &t.pieces[off/t.info.PieceLength]
1602                 p.waitNoPendingWrites()
1603                 var n1 int
1604                 n1, err = p.Storage().ReadAt(b, off-p.Info().Offset())
1605                 if n1 == 0 {
1606                         break
1607                 }
1608                 off += int64(n1)
1609                 n += n1
1610                 b = b[n1:]
1611         }
1612         return
1613 }
1614
1615 // Returns an error if the metadata was completed, but couldn't be set for some reason. Blame it on
1616 // the last peer to contribute. TODO: Actually we shouldn't blame peers for failure to open storage
1617 // etc. Also we should probably cached metadata pieces per-Peer, to isolate failure appropriately.
1618 func (t *Torrent) maybeCompleteMetadata() error {
1619         if t.haveInfo() {
1620                 // Nothing to do.
1621                 return nil
1622         }
1623         if !t.haveAllMetadataPieces() {
1624                 // Don't have enough metadata pieces.
1625                 return nil
1626         }
1627         err := t.setInfoBytesLocked(t.metadataBytes)
1628         if err != nil {
1629                 t.invalidateMetadata()
1630                 return fmt.Errorf("error setting info bytes: %s", err)
1631         }
1632         if t.cl.config.Debug {
1633                 t.logger.Printf("%s: got metadata from peers", t)
1634         }
1635         return nil
1636 }
1637
1638 func (t *Torrent) readerPiecePriorities() (now, readahead bitmap.Bitmap) {
1639         t.forReaderOffsetPieces(func(begin, end pieceIndex) bool {
1640                 if end > begin {
1641                         now.Add(bitmap.BitIndex(begin))
1642                         readahead.AddRange(bitmap.BitRange(begin)+1, bitmap.BitRange(end))
1643                 }
1644                 return true
1645         })
1646         return
1647 }
1648
1649 func (t *Torrent) needData() bool {
1650         if t.closed.IsSet() {
1651                 return false
1652         }
1653         if !t.haveInfo() {
1654                 return true
1655         }
1656         return !t._pendingPieces.IsEmpty()
1657 }
1658
1659 func appendMissingStrings(old, new []string) (ret []string) {
1660         ret = old
1661 new:
1662         for _, n := range new {
1663                 for _, o := range old {
1664                         if o == n {
1665                                 continue new
1666                         }
1667                 }
1668                 ret = append(ret, n)
1669         }
1670         return
1671 }
1672
1673 func appendMissingTrackerTiers(existing [][]string, minNumTiers int) (ret [][]string) {
1674         ret = existing
1675         for minNumTiers > len(ret) {
1676                 ret = append(ret, nil)
1677         }
1678         return
1679 }
1680
1681 func (t *Torrent) addTrackers(announceList [][]string) {
1682         fullAnnounceList := &t.metainfo.AnnounceList
1683         t.metainfo.AnnounceList = appendMissingTrackerTiers(*fullAnnounceList, len(announceList))
1684         for tierIndex, trackerURLs := range announceList {
1685                 (*fullAnnounceList)[tierIndex] = appendMissingStrings((*fullAnnounceList)[tierIndex], trackerURLs)
1686         }
1687         t.startMissingTrackerScrapers()
1688         t.updateWantPeersEvent()
1689 }
1690
1691 // Don't call this before the info is available.
1692 func (t *Torrent) bytesCompleted() int64 {
1693         if !t.haveInfo() {
1694                 return 0
1695         }
1696         return t.length() - t.bytesLeft()
1697 }
1698
1699 func (t *Torrent) SetInfoBytes(b []byte) (err error) {
1700         t.cl.lock()
1701         defer t.cl.unlock()
1702         return t.setInfoBytesLocked(b)
1703 }
1704
1705 // Returns true if connection is removed from torrent.Conns.
1706 func (t *Torrent) deletePeerConn(c *PeerConn) (ret bool) {
1707         if !c.closed.IsSet() {
1708                 panic("connection is not closed")
1709                 // There are behaviours prevented by the closed state that will fail
1710                 // if the connection has been deleted.
1711         }
1712         _, ret = t.conns[c]
1713         delete(t.conns, c)
1714         // Avoid adding a drop event more than once. Probably we should track whether we've generated
1715         // the drop event against the PexConnState instead.
1716         if ret {
1717                 if !t.cl.config.DisablePEX {
1718                         t.pex.Drop(c)
1719                 }
1720         }
1721         torrent.Add("deleted connections", 1)
1722         c.deleteAllRequests("Torrent.deletePeerConn")
1723         t.assertPendingRequests()
1724         if t.numActivePeers() == 0 && len(t.connsWithAllPieces) != 0 {
1725                 panic(t.connsWithAllPieces)
1726         }
1727         return
1728 }
1729
1730 func (t *Torrent) decPeerPieceAvailability(p *Peer) {
1731         if t.deleteConnWithAllPieces(p) {
1732                 return
1733         }
1734         if !t.haveInfo() {
1735                 return
1736         }
1737         p.peerPieces().Iterate(func(i uint32) bool {
1738                 p.t.decPieceAvailability(pieceIndex(i))
1739                 return true
1740         })
1741 }
1742
1743 func (t *Torrent) assertPendingRequests() {
1744         if !check.Enabled {
1745                 return
1746         }
1747         // var actual pendingRequests
1748         // if t.haveInfo() {
1749         //      actual.m = make([]int, t.numChunks())
1750         // }
1751         // t.iterPeers(func(p *Peer) {
1752         //      p.requestState.Requests.Iterate(func(x uint32) bool {
1753         //              actual.Inc(x)
1754         //              return true
1755         //      })
1756         // })
1757         // diff := cmp.Diff(actual.m, t.pendingRequests.m)
1758         // if diff != "" {
1759         //      panic(diff)
1760         // }
1761 }
1762
1763 func (t *Torrent) dropConnection(c *PeerConn) {
1764         t.cl.event.Broadcast()
1765         c.close()
1766         if t.deletePeerConn(c) {
1767                 t.openNewConns()
1768         }
1769 }
1770
1771 // Peers as in contact information for dialing out.
1772 func (t *Torrent) wantPeers() bool {
1773         if t.closed.IsSet() {
1774                 return false
1775         }
1776         if t.peers.Len() > t.cl.config.TorrentPeersLowWater {
1777                 return false
1778         }
1779         return t.wantOutgoingConns()
1780 }
1781
1782 func (t *Torrent) updateWantPeersEvent() {
1783         if t.wantPeers() {
1784                 t.wantPeersEvent.Set()
1785         } else {
1786                 t.wantPeersEvent.Clear()
1787         }
1788 }
1789
1790 // Returns whether the client should make effort to seed the torrent.
1791 func (t *Torrent) seeding() bool {
1792         cl := t.cl
1793         if t.closed.IsSet() {
1794                 return false
1795         }
1796         if t.dataUploadDisallowed {
1797                 return false
1798         }
1799         if cl.config.NoUpload {
1800                 return false
1801         }
1802         if !cl.config.Seed {
1803                 return false
1804         }
1805         if cl.config.DisableAggressiveUpload && t.needData() {
1806                 return false
1807         }
1808         return true
1809 }
1810
1811 func (t *Torrent) onWebRtcConn(
1812         c datachannel.ReadWriteCloser,
1813         dcc webtorrent.DataChannelContext,
1814 ) {
1815         defer c.Close()
1816         netConn := webrtcNetConn{
1817                 ReadWriteCloser:    c,
1818                 DataChannelContext: dcc,
1819         }
1820         peerRemoteAddr := netConn.RemoteAddr()
1821         //t.logger.Levelf(log.Critical, "onWebRtcConn remote addr: %v", peerRemoteAddr)
1822         if t.cl.badPeerAddr(peerRemoteAddr) {
1823                 return
1824         }
1825         localAddrIpPort := missinggo.IpPortFromNetAddr(netConn.LocalAddr())
1826         pc, err := t.cl.initiateProtocolHandshakes(
1827                 context.Background(),
1828                 netConn,
1829                 t,
1830                 false,
1831                 newConnectionOpts{
1832                         outgoing:        dcc.LocalOffered,
1833                         remoteAddr:      peerRemoteAddr,
1834                         localPublicAddr: localAddrIpPort,
1835                         network:         webrtcNetwork,
1836                         connString:      fmt.Sprintf("webrtc offer_id %x: %v", dcc.OfferId, regularNetConnPeerConnConnString(netConn)),
1837                 },
1838         )
1839         if err != nil {
1840                 t.logger.WithDefaultLevel(log.Error).Printf("error in handshaking webrtc connection: %v", err)
1841                 return
1842         }
1843         if dcc.LocalOffered {
1844                 pc.Discovery = PeerSourceTracker
1845         } else {
1846                 pc.Discovery = PeerSourceIncoming
1847         }
1848         pc.conn.SetWriteDeadline(time.Time{})
1849         t.cl.lock()
1850         defer t.cl.unlock()
1851         err = t.runHandshookConn(pc)
1852         if err != nil {
1853                 t.logger.WithDefaultLevel(log.Debug).Printf("error running handshook webrtc conn: %v", err)
1854         }
1855 }
1856
1857 func (t *Torrent) logRunHandshookConn(pc *PeerConn, logAll bool, level log.Level) {
1858         err := t.runHandshookConn(pc)
1859         if err != nil || logAll {
1860                 t.logger.WithDefaultLevel(level).Levelf(log.ErrorLevel(err), "error running handshook conn: %v", err)
1861         }
1862 }
1863
1864 func (t *Torrent) runHandshookConnLoggingErr(pc *PeerConn) {
1865         t.logRunHandshookConn(pc, false, log.Debug)
1866 }
1867
1868 func (t *Torrent) startWebsocketAnnouncer(u url.URL, shortInfohash [20]byte) torrentTrackerAnnouncer {
1869         wtc, release := t.cl.websocketTrackers.Get(u.String(), shortInfohash)
1870         // This needs to run before the Torrent is dropped from the Client, to prevent a new
1871         // webtorrent.TrackerClient for the same info hash before the old one is cleaned up.
1872         t.onClose = append(t.onClose, release)
1873         wst := websocketTrackerStatus{u, wtc}
1874         go func() {
1875                 err := wtc.Announce(tracker.Started, shortInfohash)
1876                 if err != nil {
1877                         t.logger.WithDefaultLevel(log.Warning).Printf(
1878                                 "error in initial announce to %q: %v",
1879                                 u.String(), err,
1880                         )
1881                 }
1882         }()
1883         return wst
1884 }
1885
1886 func (t *Torrent) startScrapingTracker(_url string) {
1887         if _url == "" {
1888                 return
1889         }
1890         u, err := url.Parse(_url)
1891         if err != nil {
1892                 // URLs with a leading '*' appear to be a uTorrent convention to disable trackers.
1893                 if _url[0] != '*' {
1894                         t.logger.Levelf(log.Warning, "error parsing tracker url: %v", err)
1895                 }
1896                 return
1897         }
1898         if u.Scheme == "udp" {
1899                 u.Scheme = "udp4"
1900                 t.startScrapingTracker(u.String())
1901                 u.Scheme = "udp6"
1902                 t.startScrapingTracker(u.String())
1903                 return
1904         }
1905         if t.infoHash.Ok {
1906                 t.startScrapingTrackerWithInfohash(u, _url, t.infoHash.Value)
1907         }
1908         if t.infoHashV2.Ok {
1909                 t.startScrapingTrackerWithInfohash(u, _url, *t.infoHashV2.Value.ToShort())
1910         }
1911 }
1912
1913 func (t *Torrent) startScrapingTrackerWithInfohash(u *url.URL, urlStr string, shortInfohash [20]byte) {
1914         announcerKey := torrentTrackerAnnouncerKey{
1915                 shortInfohash: shortInfohash,
1916                 url:           urlStr,
1917         }
1918         if _, ok := t.trackerAnnouncers[announcerKey]; ok {
1919                 return
1920         }
1921         sl := func() torrentTrackerAnnouncer {
1922                 switch u.Scheme {
1923                 case "ws", "wss":
1924                         if t.cl.config.DisableWebtorrent {
1925                                 return nil
1926                         }
1927                         return t.startWebsocketAnnouncer(*u, shortInfohash)
1928                 case "udp4":
1929                         if t.cl.config.DisableIPv4Peers || t.cl.config.DisableIPv4 {
1930                                 return nil
1931                         }
1932                 case "udp6":
1933                         if t.cl.config.DisableIPv6 {
1934                                 return nil
1935                         }
1936                 }
1937                 newAnnouncer := &trackerScraper{
1938                         shortInfohash:   shortInfohash,
1939                         u:               *u,
1940                         t:               t,
1941                         lookupTrackerIp: t.cl.config.LookupTrackerIp,
1942                 }
1943                 go newAnnouncer.Run()
1944                 return newAnnouncer
1945         }()
1946         if sl == nil {
1947                 return
1948         }
1949         g.MakeMapIfNil(&t.trackerAnnouncers)
1950         if g.MapInsert(t.trackerAnnouncers, announcerKey, sl).Ok {
1951                 panic("tracker announcer already exists")
1952         }
1953 }
1954
1955 // Adds and starts tracker scrapers for tracker URLs that aren't already
1956 // running.
1957 func (t *Torrent) startMissingTrackerScrapers() {
1958         if t.cl.config.DisableTrackers {
1959                 return
1960         }
1961         t.startScrapingTracker(t.metainfo.Announce)
1962         for _, tier := range t.metainfo.AnnounceList {
1963                 for _, url := range tier {
1964                         t.startScrapingTracker(url)
1965                 }
1966         }
1967 }
1968
1969 // Returns an AnnounceRequest with fields filled out to defaults and current
1970 // values.
1971 func (t *Torrent) announceRequest(
1972         event tracker.AnnounceEvent,
1973         shortInfohash [20]byte,
1974 ) tracker.AnnounceRequest {
1975         // Note that IPAddress is not set. It's set for UDP inside the tracker code, since it's
1976         // dependent on the network in use.
1977         return tracker.AnnounceRequest{
1978                 Event: event,
1979                 NumWant: func() int32 {
1980                         if t.wantPeers() && len(t.cl.dialers) > 0 {
1981                                 // Windozer has UDP packet limit. See:
1982                                 // https://github.com/anacrolix/torrent/issues/764
1983                                 return 200
1984                         } else {
1985                                 return 0
1986                         }
1987                 }(),
1988                 Port:     uint16(t.cl.incomingPeerPort()),
1989                 PeerId:   t.cl.peerID,
1990                 InfoHash: shortInfohash,
1991                 Key:      t.cl.announceKey(),
1992
1993                 // The following are vaguely described in BEP 3.
1994
1995                 Left:     t.bytesLeftAnnounce(),
1996                 Uploaded: t.stats.BytesWrittenData.Int64(),
1997                 // There's no mention of wasted or unwanted download in the BEP.
1998                 Downloaded: t.stats.BytesReadUsefulData.Int64(),
1999         }
2000 }
2001
2002 // Adds peers revealed in an announce until the announce ends, or we have
2003 // enough peers.
2004 func (t *Torrent) consumeDhtAnnouncePeers(pvs <-chan dht.PeersValues) {
2005         cl := t.cl
2006         for v := range pvs {
2007                 cl.lock()
2008                 added := 0
2009                 for _, cp := range v.Peers {
2010                         if cp.Port == 0 {
2011                                 // Can't do anything with this.
2012                                 continue
2013                         }
2014                         if t.addPeer(PeerInfo{
2015                                 Addr:   ipPortAddr{cp.IP, cp.Port},
2016                                 Source: PeerSourceDhtGetPeers,
2017                         }) {
2018                                 added++
2019                         }
2020                 }
2021                 cl.unlock()
2022                 // if added != 0 {
2023                 //      log.Printf("added %v peers from dht for %v", added, t.InfoHash().HexString())
2024                 // }
2025         }
2026 }
2027
2028 // Announce using the provided DHT server. Peers are consumed automatically. done is closed when the
2029 // announce ends. stop will force the announce to end. This interface is really old-school, and
2030 // calls a private one that is much more modern. Both v1 and v2 info hashes are announced if they
2031 // exist.
2032 func (t *Torrent) AnnounceToDht(s DhtServer) (done <-chan struct{}, stop func(), err error) {
2033         var ihs [][20]byte
2034         t.cl.lock()
2035         t.eachShortInfohash(func(short [20]byte) {
2036                 ihs = append(ihs, short)
2037         })
2038         t.cl.unlock()
2039         ctx, stop := context.WithCancel(context.Background())
2040         eg, ctx := errgroup.WithContext(ctx)
2041         for _, ih := range ihs {
2042                 var ann DhtAnnounce
2043                 ann, err = s.Announce(ih, t.cl.incomingPeerPort(), true)
2044                 if err != nil {
2045                         stop()
2046                         return
2047                 }
2048                 eg.Go(func() error {
2049                         return t.dhtAnnounceConsumer(ctx, ann)
2050                 })
2051         }
2052         _done := make(chan struct{})
2053         done = _done
2054         go func() {
2055                 defer stop()
2056                 defer close(_done)
2057                 eg.Wait()
2058         }()
2059         return
2060 }
2061
2062 // Announce using the provided DHT server. Peers are consumed automatically. done is closed when the
2063 // announce ends. stop will force the announce to end.
2064 func (t *Torrent) dhtAnnounceConsumer(
2065         ctx context.Context,
2066         ps DhtAnnounce,
2067 ) (
2068         err error,
2069 ) {
2070         defer ps.Close()
2071         done := make(chan struct{})
2072         go func() {
2073                 defer close(done)
2074                 t.consumeDhtAnnouncePeers(ps.Peers())
2075         }()
2076         select {
2077         case <-ctx.Done():
2078                 return context.Cause(ctx)
2079         case <-done:
2080                 return nil
2081         }
2082 }
2083
2084 func (t *Torrent) timeboxedAnnounceToDht(s DhtServer) error {
2085         _, stop, err := t.AnnounceToDht(s)
2086         if err != nil {
2087                 return err
2088         }
2089         select {
2090         case <-t.closed.Done():
2091         case <-time.After(5 * time.Minute):
2092         }
2093         stop()
2094         return nil
2095 }
2096
2097 func (t *Torrent) dhtAnnouncer(s DhtServer) {
2098         cl := t.cl
2099         cl.lock()
2100         defer cl.unlock()
2101         for {
2102                 for {
2103                         if t.closed.IsSet() {
2104                                 return
2105                         }
2106                         // We're also announcing ourselves as a listener, so we don't just want peer addresses.
2107                         // TODO: We can include the announce_peer step depending on whether we can receive
2108                         // inbound connections. We should probably only announce once every 15 mins too.
2109                         if !t.wantAnyConns() {
2110                                 goto wait
2111                         }
2112                         // TODO: Determine if there's a listener on the port we're announcing.
2113                         if len(cl.dialers) == 0 && len(cl.listeners) == 0 {
2114                                 goto wait
2115                         }
2116                         break
2117                 wait:
2118                         cl.event.Wait()
2119                 }
2120                 func() {
2121                         t.numDHTAnnounces++
2122                         cl.unlock()
2123                         defer cl.lock()
2124                         err := t.timeboxedAnnounceToDht(s)
2125                         if err != nil {
2126                                 t.logger.WithDefaultLevel(log.Warning).Printf("error announcing %q to DHT: %s", t, err)
2127                         }
2128                 }()
2129         }
2130 }
2131
2132 func (t *Torrent) addPeers(peers []PeerInfo) (added int) {
2133         for _, p := range peers {
2134                 if t.addPeer(p) {
2135                         added++
2136                 }
2137         }
2138         return
2139 }
2140
2141 // The returned TorrentStats may require alignment in memory. See
2142 // https://github.com/anacrolix/torrent/issues/383.
2143 func (t *Torrent) Stats() TorrentStats {
2144         t.cl.rLock()
2145         defer t.cl.rUnlock()
2146         return t.statsLocked()
2147 }
2148
2149 func (t *Torrent) statsLocked() (ret TorrentStats) {
2150         ret.ActivePeers = len(t.conns)
2151         ret.HalfOpenPeers = len(t.halfOpen)
2152         ret.PendingPeers = t.peers.Len()
2153         ret.TotalPeers = t.numTotalPeers()
2154         ret.ConnectedSeeders = 0
2155         for c := range t.conns {
2156                 if all, ok := c.peerHasAllPieces(); all && ok {
2157                         ret.ConnectedSeeders++
2158                 }
2159         }
2160         ret.ConnStats = t.stats.Copy()
2161         ret.PiecesComplete = t.numPiecesCompleted()
2162         return
2163 }
2164
2165 // The total number of peers in the torrent.
2166 func (t *Torrent) numTotalPeers() int {
2167         peers := make(map[string]struct{})
2168         for conn := range t.conns {
2169                 ra := conn.conn.RemoteAddr()
2170                 if ra == nil {
2171                         // It's been closed and doesn't support RemoteAddr.
2172                         continue
2173                 }
2174                 peers[ra.String()] = struct{}{}
2175         }
2176         for addr := range t.halfOpen {
2177                 peers[addr] = struct{}{}
2178         }
2179         t.peers.Each(func(peer PeerInfo) {
2180                 peers[peer.Addr.String()] = struct{}{}
2181         })
2182         return len(peers)
2183 }
2184
2185 // Reconcile bytes transferred before connection was associated with a
2186 // torrent.
2187 func (t *Torrent) reconcileHandshakeStats(c *Peer) {
2188         if c._stats != (ConnStats{
2189                 // Handshakes should only increment these fields:
2190                 BytesWritten: c._stats.BytesWritten,
2191                 BytesRead:    c._stats.BytesRead,
2192         }) {
2193                 panic("bad stats")
2194         }
2195         c.postHandshakeStats(func(cs *ConnStats) {
2196                 cs.BytesRead.Add(c._stats.BytesRead.Int64())
2197                 cs.BytesWritten.Add(c._stats.BytesWritten.Int64())
2198         })
2199         c.reconciledHandshakeStats = true
2200 }
2201
2202 // Returns true if the connection is added.
2203 func (t *Torrent) addPeerConn(c *PeerConn) (err error) {
2204         defer func() {
2205                 if err == nil {
2206                         torrent.Add("added connections", 1)
2207                 }
2208         }()
2209         if t.closed.IsSet() {
2210                 return errors.New("torrent closed")
2211         }
2212         for c0 := range t.conns {
2213                 if c.PeerID != c0.PeerID {
2214                         continue
2215                 }
2216                 if !t.cl.config.DropDuplicatePeerIds {
2217                         continue
2218                 }
2219                 if c.hasPreferredNetworkOver(c0) {
2220                         c0.close()
2221                         t.deletePeerConn(c0)
2222                 } else {
2223                         return errors.New("existing connection preferred")
2224                 }
2225         }
2226         if len(t.conns) >= t.maxEstablishedConns {
2227                 numOutgoing := t.numOutgoingConns()
2228                 numIncoming := len(t.conns) - numOutgoing
2229                 c := t.worstBadConn(worseConnLensOpts{
2230                         // We've already established that we have too many connections at this point, so we just
2231                         // need to match what kind we have too many of vs. what we're trying to add now.
2232                         incomingIsBad: (numIncoming-numOutgoing > 1) && c.outgoing,
2233                         outgoingIsBad: (numOutgoing-numIncoming > 1) && !c.outgoing,
2234                 })
2235                 if c == nil {
2236                         return errors.New("don't want conn")
2237                 }
2238                 c.close()
2239                 t.deletePeerConn(c)
2240         }
2241         if len(t.conns) >= t.maxEstablishedConns {
2242                 panic(len(t.conns))
2243         }
2244         t.conns[c] = struct{}{}
2245         t.cl.event.Broadcast()
2246         // We'll never receive the "p" extended handshake parameter.
2247         if !t.cl.config.DisablePEX && !c.PeerExtensionBytes.SupportsExtended() {
2248                 t.pex.Add(c)
2249         }
2250         return nil
2251 }
2252
2253 func (t *Torrent) newConnsAllowed() bool {
2254         if !t.networkingEnabled.Bool() {
2255                 return false
2256         }
2257         if t.closed.IsSet() {
2258                 return false
2259         }
2260         if !t.needData() && (!t.seeding() || !t.haveAnyPieces()) {
2261                 return false
2262         }
2263         return true
2264 }
2265
2266 func (t *Torrent) wantAnyConns() bool {
2267         if !t.networkingEnabled.Bool() {
2268                 return false
2269         }
2270         if t.closed.IsSet() {
2271                 return false
2272         }
2273         if !t.needData() && (!t.seeding() || !t.haveAnyPieces()) {
2274                 return false
2275         }
2276         return len(t.conns) < t.maxEstablishedConns
2277 }
2278
2279 func (t *Torrent) wantOutgoingConns() bool {
2280         if !t.newConnsAllowed() {
2281                 return false
2282         }
2283         if len(t.conns) < t.maxEstablishedConns {
2284                 return true
2285         }
2286         numIncomingConns := len(t.conns) - t.numOutgoingConns()
2287         return t.worstBadConn(worseConnLensOpts{
2288                 incomingIsBad: numIncomingConns-t.numOutgoingConns() > 1,
2289                 outgoingIsBad: false,
2290         }) != nil
2291 }
2292
2293 func (t *Torrent) wantIncomingConns() bool {
2294         if !t.newConnsAllowed() {
2295                 return false
2296         }
2297         if len(t.conns) < t.maxEstablishedConns {
2298                 return true
2299         }
2300         numIncomingConns := len(t.conns) - t.numOutgoingConns()
2301         return t.worstBadConn(worseConnLensOpts{
2302                 incomingIsBad: false,
2303                 outgoingIsBad: t.numOutgoingConns()-numIncomingConns > 1,
2304         }) != nil
2305 }
2306
2307 func (t *Torrent) SetMaxEstablishedConns(max int) (oldMax int) {
2308         t.cl.lock()
2309         defer t.cl.unlock()
2310         oldMax = t.maxEstablishedConns
2311         t.maxEstablishedConns = max
2312         wcs := worseConnSlice{
2313                 conns: t.appendConns(nil, func(*PeerConn) bool {
2314                         return true
2315                 }),
2316         }
2317         wcs.initKeys(worseConnLensOpts{})
2318         heap.Init(&wcs)
2319         for len(t.conns) > t.maxEstablishedConns && wcs.Len() > 0 {
2320                 t.dropConnection(heap.Pop(&wcs).(*PeerConn))
2321         }
2322         t.openNewConns()
2323         return oldMax
2324 }
2325
2326 func (t *Torrent) pieceHashed(piece pieceIndex, passed bool, hashIoErr error) {
2327         t.logger.LazyLog(log.Debug, func() log.Msg {
2328                 return log.Fstr("hashed piece %d (passed=%t)", piece, passed)
2329         })
2330         p := t.piece(piece)
2331         p.numVerifies++
2332         t.cl.event.Broadcast()
2333         if t.closed.IsSet() {
2334                 return
2335         }
2336
2337         // Don't score the first time a piece is hashed, it could be an initial check.
2338         if p.storageCompletionOk {
2339                 if passed {
2340                         pieceHashedCorrect.Add(1)
2341                 } else {
2342                         log.Fmsg(
2343                                 "piece %d failed hash: %d connections contributed", piece, len(p.dirtiers),
2344                         ).AddValues(t, p).LogLevel(log.Info, t.logger)
2345                         pieceHashedNotCorrect.Add(1)
2346                 }
2347         }
2348
2349         p.marking = true
2350         t.publishPieceStateChange(piece)
2351         defer func() {
2352                 p.marking = false
2353                 t.publishPieceStateChange(piece)
2354         }()
2355
2356         if passed {
2357                 if len(p.dirtiers) != 0 {
2358                         // Don't increment stats above connection-level for every involved connection.
2359                         t.allStats((*ConnStats).incrementPiecesDirtiedGood)
2360                 }
2361                 for c := range p.dirtiers {
2362                         c._stats.incrementPiecesDirtiedGood()
2363                 }
2364                 t.clearPieceTouchers(piece)
2365                 hasDirty := p.hasDirtyChunks()
2366                 t.cl.unlock()
2367                 if hasDirty {
2368                         p.Flush() // You can be synchronous here!
2369                 }
2370                 err := p.Storage().MarkComplete()
2371                 if err != nil {
2372                         t.logger.Levelf(log.Warning, "%T: error marking piece complete %d: %s", t.storage, piece, err)
2373                 }
2374                 t.cl.lock()
2375
2376                 if t.closed.IsSet() {
2377                         return
2378                 }
2379                 t.pendAllChunkSpecs(piece)
2380         } else {
2381                 if len(p.dirtiers) != 0 && p.allChunksDirty() && hashIoErr == nil {
2382                         // Peers contributed to all the data for this piece hash failure, and the failure was
2383                         // not due to errors in the storage (such as data being dropped in a cache).
2384
2385                         // Increment Torrent and above stats, and then specific connections.
2386                         t.allStats((*ConnStats).incrementPiecesDirtiedBad)
2387                         for c := range p.dirtiers {
2388                                 // Y u do dis peer?!
2389                                 c.stats().incrementPiecesDirtiedBad()
2390                         }
2391
2392                         bannableTouchers := make([]*Peer, 0, len(p.dirtiers))
2393                         for c := range p.dirtiers {
2394                                 if !c.trusted {
2395                                         bannableTouchers = append(bannableTouchers, c)
2396                                 }
2397                         }
2398                         t.clearPieceTouchers(piece)
2399                         slices.Sort(bannableTouchers, connLessTrusted)
2400
2401                         if t.cl.config.Debug {
2402                                 t.logger.Printf(
2403                                         "bannable conns by trust for piece %d: %v",
2404                                         piece,
2405                                         func() (ret []connectionTrust) {
2406                                                 for _, c := range bannableTouchers {
2407                                                         ret = append(ret, c.trust())
2408                                                 }
2409                                                 return
2410                                         }(),
2411                                 )
2412                         }
2413
2414                         if len(bannableTouchers) >= 1 {
2415                                 c := bannableTouchers[0]
2416                                 if len(bannableTouchers) != 1 {
2417                                         t.logger.Levelf(log.Debug, "would have banned %v for touching piece %v after failed piece check", c.remoteIp(), piece)
2418                                 } else {
2419                                         // Turns out it's still useful to ban peers like this because if there's only a
2420                                         // single peer for a piece, and we never progress that piece to completion, we
2421                                         // will never smart-ban them. Discovered in
2422                                         // https://github.com/anacrolix/torrent/issues/715.
2423                                         t.logger.Levelf(log.Warning, "banning %v for being sole dirtier of piece %v after failed piece check", c, piece)
2424                                         c.ban()
2425                                 }
2426                         }
2427                 }
2428                 t.onIncompletePiece(piece)
2429                 p.Storage().MarkNotComplete()
2430         }
2431         t.updatePieceCompletion(piece)
2432 }
2433
2434 func (t *Torrent) cancelRequestsForPiece(piece pieceIndex) {
2435         start := t.pieceRequestIndexOffset(piece)
2436         end := start + t.pieceNumChunks(piece)
2437         for ri := start; ri < end; ri++ {
2438                 t.cancelRequest(ri)
2439         }
2440 }
2441
2442 func (t *Torrent) onPieceCompleted(piece pieceIndex) {
2443         t.pendAllChunkSpecs(piece)
2444         t.cancelRequestsForPiece(piece)
2445         t.piece(piece).readerCond.Broadcast()
2446         for conn := range t.conns {
2447                 conn.have(piece)
2448                 t.maybeDropMutuallyCompletePeer(conn)
2449         }
2450 }
2451
2452 // Called when a piece is found to be not complete.
2453 func (t *Torrent) onIncompletePiece(piece pieceIndex) {
2454         if t.pieceAllDirty(piece) {
2455                 t.pendAllChunkSpecs(piece)
2456         }
2457         if !t.wantPieceIndex(piece) {
2458                 // t.logger.Printf("piece %d incomplete and unwanted", piece)
2459                 return
2460         }
2461         // We could drop any connections that we told we have a piece that we
2462         // don't here. But there's a test failure, and it seems clients don't care
2463         // if you request pieces that you already claim to have. Pruning bad
2464         // connections might just remove any connections that aren't treating us
2465         // favourably anyway.
2466
2467         // for c := range t.conns {
2468         //      if c.sentHave(piece) {
2469         //              c.drop()
2470         //      }
2471         // }
2472         t.iterPeers(func(conn *Peer) {
2473                 if conn.peerHasPiece(piece) {
2474                         conn.updateRequests("piece incomplete")
2475                 }
2476         })
2477 }
2478
2479 func (t *Torrent) tryCreateMorePieceHashers() {
2480         for !t.closed.IsSet() && t.activePieceHashes < t.cl.config.PieceHashersPerTorrent && t.tryCreatePieceHasher() {
2481         }
2482 }
2483
2484 func (t *Torrent) tryCreatePieceHasher() bool {
2485         if t.storage == nil {
2486                 return false
2487         }
2488         pi, ok := t.getPieceToHash()
2489         if !ok {
2490                 return false
2491         }
2492         p := t.piece(pi)
2493         t.piecesQueuedForHash.Remove(bitmap.BitIndex(pi))
2494         p.hashing = true
2495         t.publishPieceStateChange(pi)
2496         t.updatePiecePriority(pi, "Torrent.tryCreatePieceHasher")
2497         t.storageLock.RLock()
2498         t.activePieceHashes++
2499         go t.pieceHasher(pi)
2500         return true
2501 }
2502
2503 func (t *Torrent) getPieceToHash() (ret pieceIndex, ok bool) {
2504         t.piecesQueuedForHash.IterTyped(func(i pieceIndex) bool {
2505                 if t.piece(i).hashing {
2506                         return true
2507                 }
2508                 ret = i
2509                 ok = true
2510                 return false
2511         })
2512         return
2513 }
2514
2515 func (t *Torrent) dropBannedPeers() {
2516         t.iterPeers(func(p *Peer) {
2517                 remoteIp := p.remoteIp()
2518                 if remoteIp == nil {
2519                         if p.bannableAddr.Ok {
2520                                 t.logger.WithDefaultLevel(log.Debug).Printf("can't get remote ip for peer %v", p)
2521                         }
2522                         return
2523                 }
2524                 netipAddr := netip.MustParseAddr(remoteIp.String())
2525                 if Some(netipAddr) != p.bannableAddr {
2526                         t.logger.WithDefaultLevel(log.Debug).Printf(
2527                                 "peer remote ip does not match its bannable addr [peer=%v, remote ip=%v, bannable addr=%v]",
2528                                 p, remoteIp, p.bannableAddr)
2529                 }
2530                 if _, ok := t.cl.badPeerIPs[netipAddr]; ok {
2531                         // Should this be a close?
2532                         p.drop()
2533                         t.logger.WithDefaultLevel(log.Debug).Printf("dropped %v for banned remote IP %v", p, netipAddr)
2534                 }
2535         })
2536 }
2537
2538 func (t *Torrent) pieceHasher(index pieceIndex) {
2539         p := t.piece(index)
2540         // Do we really need to spell out that it's a copy error? If it's a failure to hash the hash
2541         // will just be wrong.
2542         correct, failedPeers, copyErr := t.hashPiece(index)
2543         switch copyErr {
2544         case nil, io.EOF:
2545         default:
2546                 t.logger.Levelf(
2547                         log.Warning,
2548                         "error hashing piece %v: %v", index, copyErr)
2549         }
2550         t.storageLock.RUnlock()
2551         t.cl.lock()
2552         defer t.cl.unlock()
2553         if correct {
2554                 for peer := range failedPeers {
2555                         t.cl.banPeerIP(peer.AsSlice())
2556                         t.logger.WithDefaultLevel(log.Debug).Printf("smart banned %v for piece %v", peer, index)
2557                 }
2558                 t.dropBannedPeers()
2559                 for ri := t.pieceRequestIndexOffset(index); ri < t.pieceRequestIndexOffset(index+1); ri++ {
2560                         t.smartBanCache.ForgetBlock(ri)
2561                 }
2562         }
2563         p.hashing = false
2564         t.pieceHashed(index, correct, copyErr)
2565         t.updatePiecePriority(index, "Torrent.pieceHasher")
2566         t.activePieceHashes--
2567         t.tryCreateMorePieceHashers()
2568 }
2569
2570 // Return the connections that touched a piece, and clear the entries while doing it.
2571 func (t *Torrent) clearPieceTouchers(pi pieceIndex) {
2572         p := t.piece(pi)
2573         for c := range p.dirtiers {
2574                 delete(c.peerTouchedPieces, pi)
2575                 delete(p.dirtiers, c)
2576         }
2577 }
2578
2579 func (t *Torrent) peersAsSlice() (ret []*Peer) {
2580         t.iterPeers(func(p *Peer) {
2581                 ret = append(ret, p)
2582         })
2583         return
2584 }
2585
2586 func (t *Torrent) queueInitialPieceCheck(i pieceIndex) {
2587         if !t.initialPieceCheckDisabled && !t.piece(i).storageCompletionOk {
2588                 t.queuePieceCheck(i)
2589         }
2590 }
2591
2592 func (t *Torrent) queuePieceCheck(pieceIndex pieceIndex) {
2593         piece := t.piece(pieceIndex)
2594         if piece.hash == nil && !piece.hashV2.Ok {
2595                 return
2596         }
2597         if piece.queuedForHash() {
2598                 return
2599         }
2600         t.piecesQueuedForHash.Add(bitmap.BitIndex(pieceIndex))
2601         t.publishPieceStateChange(pieceIndex)
2602         t.updatePiecePriority(pieceIndex, "Torrent.queuePieceCheck")
2603         t.tryCreateMorePieceHashers()
2604 }
2605
2606 // Forces all the pieces to be re-hashed. See also Piece.VerifyData. This should not be called
2607 // before the Info is available.
2608 func (t *Torrent) VerifyData() {
2609         for i := pieceIndex(0); i < t.NumPieces(); i++ {
2610                 t.Piece(i).VerifyData()
2611         }
2612 }
2613
2614 func (t *Torrent) connectingToPeerAddr(addrStr string) bool {
2615         return len(t.halfOpen[addrStr]) != 0
2616 }
2617
2618 func (t *Torrent) hasPeerConnForAddr(x PeerRemoteAddr) bool {
2619         addrStr := x.String()
2620         for c := range t.conns {
2621                 ra := c.RemoteAddr
2622                 if ra.String() == addrStr {
2623                         return true
2624                 }
2625         }
2626         return false
2627 }
2628
2629 func (t *Torrent) getHalfOpenPath(
2630         addrStr string,
2631         attemptKey outgoingConnAttemptKey,
2632 ) nestedmaps.Path[*PeerInfo] {
2633         return nestedmaps.Next(nestedmaps.Next(nestedmaps.Begin(&t.halfOpen), addrStr), attemptKey)
2634 }
2635
2636 func (t *Torrent) addHalfOpen(addrStr string, attemptKey *PeerInfo) {
2637         path := t.getHalfOpenPath(addrStr, attemptKey)
2638         if path.Exists() {
2639                 panic("should be unique")
2640         }
2641         path.Set(attemptKey)
2642         t.cl.numHalfOpen++
2643 }
2644
2645 // Start the process of connecting to the given peer for the given torrent if appropriate. I'm not
2646 // sure all the PeerInfo fields are being used.
2647 func initiateConn(
2648         opts outgoingConnOpts,
2649         ignoreLimits bool,
2650 ) {
2651         t := opts.t
2652         peer := opts.peerInfo
2653         if peer.Id == t.cl.peerID {
2654                 return
2655         }
2656         if t.cl.badPeerAddr(peer.Addr) && !peer.Trusted {
2657                 return
2658         }
2659         addr := peer.Addr
2660         addrStr := addr.String()
2661         if !ignoreLimits {
2662                 if t.connectingToPeerAddr(addrStr) {
2663                         return
2664                 }
2665         }
2666         if t.hasPeerConnForAddr(addr) {
2667                 return
2668         }
2669         attemptKey := &peer
2670         t.addHalfOpen(addrStr, attemptKey)
2671         go t.cl.outgoingConnection(
2672                 opts,
2673                 attemptKey,
2674         )
2675 }
2676
2677 // Adds a trusted, pending peer for each of the given Client's addresses. Typically used in tests to
2678 // quickly make one Client visible to the Torrent of another Client.
2679 func (t *Torrent) AddClientPeer(cl *Client) int {
2680         return t.AddPeers(func() (ps []PeerInfo) {
2681                 for _, la := range cl.ListenAddrs() {
2682                         ps = append(ps, PeerInfo{
2683                                 Addr:    la,
2684                                 Trusted: true,
2685                         })
2686                 }
2687                 return
2688         }())
2689 }
2690
2691 // All stats that include this Torrent. Useful when we want to increment ConnStats but not for every
2692 // connection.
2693 func (t *Torrent) allStats(f func(*ConnStats)) {
2694         f(&t.stats)
2695         f(&t.cl.connStats)
2696 }
2697
2698 func (t *Torrent) hashingPiece(i pieceIndex) bool {
2699         return t.pieces[i].hashing
2700 }
2701
2702 func (t *Torrent) pieceQueuedForHash(i pieceIndex) bool {
2703         return t.piecesQueuedForHash.Get(bitmap.BitIndex(i))
2704 }
2705
2706 func (t *Torrent) dialTimeout() time.Duration {
2707         return reducedDialTimeout(t.cl.config.MinDialTimeout, t.cl.config.NominalDialTimeout, t.cl.config.HalfOpenConnsPerTorrent, t.peers.Len())
2708 }
2709
2710 func (t *Torrent) piece(i int) *Piece {
2711         return &t.pieces[i]
2712 }
2713
2714 func (t *Torrent) onWriteChunkErr(err error) {
2715         if t.userOnWriteChunkErr != nil {
2716                 go t.userOnWriteChunkErr(err)
2717                 return
2718         }
2719         t.logger.WithDefaultLevel(log.Critical).Printf("default chunk write error handler: disabling data download")
2720         t.disallowDataDownloadLocked()
2721 }
2722
2723 func (t *Torrent) DisallowDataDownload() {
2724         t.cl.lock()
2725         defer t.cl.unlock()
2726         t.disallowDataDownloadLocked()
2727 }
2728
2729 func (t *Torrent) disallowDataDownloadLocked() {
2730         t.dataDownloadDisallowed.Set()
2731         t.iterPeers(func(p *Peer) {
2732                 // Could check if peer request state is empty/not interested?
2733                 p.updateRequests("disallow data download")
2734                 p.cancelAllRequests()
2735         })
2736 }
2737
2738 func (t *Torrent) AllowDataDownload() {
2739         t.cl.lock()
2740         defer t.cl.unlock()
2741         t.dataDownloadDisallowed.Clear()
2742         t.iterPeers(func(p *Peer) {
2743                 p.updateRequests("allow data download")
2744         })
2745 }
2746
2747 // Enables uploading data, if it was disabled.
2748 func (t *Torrent) AllowDataUpload() {
2749         t.cl.lock()
2750         defer t.cl.unlock()
2751         t.dataUploadDisallowed = false
2752         t.iterPeers(func(p *Peer) {
2753                 p.updateRequests("allow data upload")
2754         })
2755 }
2756
2757 // Disables uploading data, if it was enabled.
2758 func (t *Torrent) DisallowDataUpload() {
2759         t.cl.lock()
2760         defer t.cl.unlock()
2761         t.dataUploadDisallowed = true
2762         for c := range t.conns {
2763                 // TODO: This doesn't look right. Shouldn't we tickle writers to choke peers or something instead?
2764                 c.updateRequests("disallow data upload")
2765         }
2766 }
2767
2768 // Sets a handler that is called if there's an error writing a chunk to local storage. By default,
2769 // or if nil, a critical message is logged, and data download is disabled.
2770 func (t *Torrent) SetOnWriteChunkError(f func(error)) {
2771         t.cl.lock()
2772         defer t.cl.unlock()
2773         t.userOnWriteChunkErr = f
2774 }
2775
2776 func (t *Torrent) iterPeers(f func(p *Peer)) {
2777         for pc := range t.conns {
2778                 f(&pc.Peer)
2779         }
2780         for _, ws := range t.webSeeds {
2781                 f(ws)
2782         }
2783 }
2784
2785 func (t *Torrent) callbacks() *Callbacks {
2786         return &t.cl.config.Callbacks
2787 }
2788
2789 type AddWebSeedsOpt func(*webseed.Client)
2790
2791 // Sets the WebSeed trailing path escaper for a webseed.Client.
2792 func WebSeedPathEscaper(custom webseed.PathEscaper) AddWebSeedsOpt {
2793         return func(c *webseed.Client) {
2794                 c.PathEscaper = custom
2795         }
2796 }
2797
2798 func (t *Torrent) AddWebSeeds(urls []string, opts ...AddWebSeedsOpt) {
2799         t.cl.lock()
2800         defer t.cl.unlock()
2801         for _, u := range urls {
2802                 t.addWebSeed(u, opts...)
2803         }
2804 }
2805
2806 func (t *Torrent) addWebSeed(url string, opts ...AddWebSeedsOpt) {
2807         if t.cl.config.DisableWebseeds {
2808                 return
2809         }
2810         if _, ok := t.webSeeds[url]; ok {
2811                 return
2812         }
2813         // I don't think Go http supports pipelining requests. However, we can have more ready to go
2814         // right away. This value should be some multiple of the number of connections to a host. I
2815         // would expect that double maxRequests plus a bit would be appropriate. This value is based on
2816         // downloading Sintel (08ada5a7a6183aae1e09d831df6748d566095a10) from
2817         // "https://webtorrent.io/torrents/".
2818         const maxRequests = 16
2819         ws := webseedPeer{
2820                 peer: Peer{
2821                         t:                        t,
2822                         outgoing:                 true,
2823                         Network:                  "http",
2824                         reconciledHandshakeStats: true,
2825                         // This should affect how often we have to recompute requests for this peer. Note that
2826                         // because we can request more than 1 thing at a time over HTTP, we will hit the low
2827                         // requests mark more often, so recomputation is probably sooner than with regular peer
2828                         // conns. ~4x maxRequests would be about right.
2829                         PeerMaxRequests: 128,
2830                         // TODO: Set ban prefix?
2831                         RemoteAddr: remoteAddrFromUrl(url),
2832                         callbacks:  t.callbacks(),
2833                 },
2834                 client: webseed.Client{
2835                         HttpClient: t.cl.httpClient,
2836                         Url:        url,
2837                         ResponseBodyWrapper: func(r io.Reader) io.Reader {
2838                                 return &rateLimitedReader{
2839                                         l: t.cl.config.DownloadRateLimiter,
2840                                         r: r,
2841                                 }
2842                         },
2843                 },
2844                 activeRequests: make(map[Request]webseed.Request, maxRequests),
2845         }
2846         ws.peer.initRequestState()
2847         for _, opt := range opts {
2848                 opt(&ws.client)
2849         }
2850         ws.peer.initUpdateRequestsTimer()
2851         ws.requesterCond.L = t.cl.locker()
2852         for i := 0; i < maxRequests; i += 1 {
2853                 go ws.requester(i)
2854         }
2855         for _, f := range t.callbacks().NewPeer {
2856                 f(&ws.peer)
2857         }
2858         ws.peer.logger = t.logger.WithContextValue(&ws)
2859         ws.peer.peerImpl = &ws
2860         if t.haveInfo() {
2861                 ws.onGotInfo(t.info)
2862         }
2863         t.webSeeds[url] = &ws.peer
2864 }
2865
2866 func (t *Torrent) peerIsActive(p *Peer) (active bool) {
2867         t.iterPeers(func(p1 *Peer) {
2868                 if p1 == p {
2869                         active = true
2870                 }
2871         })
2872         return
2873 }
2874
2875 func (t *Torrent) requestIndexToRequest(ri RequestIndex) Request {
2876         index := t.pieceIndexOfRequestIndex(ri)
2877         return Request{
2878                 pp.Integer(index),
2879                 t.piece(index).chunkIndexSpec(ri % t.chunksPerRegularPiece()),
2880         }
2881 }
2882
2883 func (t *Torrent) requestIndexFromRequest(r Request) RequestIndex {
2884         return t.pieceRequestIndexOffset(pieceIndex(r.Index)) + RequestIndex(r.Begin/t.chunkSize)
2885 }
2886
2887 func (t *Torrent) pieceRequestIndexOffset(piece pieceIndex) RequestIndex {
2888         return RequestIndex(piece) * t.chunksPerRegularPiece()
2889 }
2890
2891 func (t *Torrent) updateComplete() {
2892         t.Complete.SetBool(t.haveAllPieces())
2893 }
2894
2895 func (t *Torrent) cancelRequest(r RequestIndex) *Peer {
2896         p := t.requestingPeer(r)
2897         if p != nil {
2898                 p.cancel(r)
2899         }
2900         // TODO: This is a check that an old invariant holds. It can be removed after some testing.
2901         //delete(t.pendingRequests, r)
2902         if _, ok := t.requestState[r]; ok {
2903                 panic("expected request state to be gone")
2904         }
2905         return p
2906 }
2907
2908 func (t *Torrent) requestingPeer(r RequestIndex) *Peer {
2909         return t.requestState[r].peer
2910 }
2911
2912 func (t *Torrent) addConnWithAllPieces(p *Peer) {
2913         if t.connsWithAllPieces == nil {
2914                 t.connsWithAllPieces = make(map[*Peer]struct{}, t.maxEstablishedConns)
2915         }
2916         t.connsWithAllPieces[p] = struct{}{}
2917 }
2918
2919 func (t *Torrent) deleteConnWithAllPieces(p *Peer) bool {
2920         _, ok := t.connsWithAllPieces[p]
2921         delete(t.connsWithAllPieces, p)
2922         return ok
2923 }
2924
2925 func (t *Torrent) numActivePeers() int {
2926         return len(t.conns) + len(t.webSeeds)
2927 }
2928
2929 func (t *Torrent) hasStorageCap() bool {
2930         f := t.storage.Capacity
2931         if f == nil {
2932                 return false
2933         }
2934         _, ok := (*f)()
2935         return ok
2936 }
2937
2938 func (t *Torrent) pieceIndexOfRequestIndex(ri RequestIndex) pieceIndex {
2939         return pieceIndex(ri / t.chunksPerRegularPiece())
2940 }
2941
2942 func (t *Torrent) iterUndirtiedRequestIndexesInPiece(
2943         reuseIter *typedRoaring.Iterator[RequestIndex],
2944         piece pieceIndex,
2945         f func(RequestIndex),
2946 ) {
2947         reuseIter.Initialize(&t.dirtyChunks)
2948         pieceRequestIndexOffset := t.pieceRequestIndexOffset(piece)
2949         iterBitmapUnsetInRange(
2950                 reuseIter,
2951                 pieceRequestIndexOffset, pieceRequestIndexOffset+t.pieceNumChunks(piece),
2952                 f,
2953         )
2954 }
2955
2956 type requestState struct {
2957         peer *Peer
2958         when time.Time
2959 }
2960
2961 // Returns an error if a received chunk is out of bounds in someway.
2962 func (t *Torrent) checkValidReceiveChunk(r Request) error {
2963         if !t.haveInfo() {
2964                 return errors.New("torrent missing info")
2965         }
2966         if int(r.Index) >= t.numPieces() {
2967                 return fmt.Errorf("chunk index %v, torrent num pieces %v", r.Index, t.numPieces())
2968         }
2969         pieceLength := t.pieceLength(pieceIndex(r.Index))
2970         if r.Begin >= pieceLength {
2971                 return fmt.Errorf("chunk begins beyond end of piece (%v >= %v)", r.Begin, pieceLength)
2972         }
2973         // We could check chunk lengths here, but chunk request size is not changed often, and tricky
2974         // for peers to manipulate as they need to send potentially large buffers to begin with. There
2975         // should be considerable checks elsewhere for this case due to the network overhead. We should
2976         // catch most of the overflow manipulation stuff by checking index and begin above.
2977         return nil
2978 }
2979
2980 func (t *Torrent) peerConnsWithDialAddrPort(target netip.AddrPort) (ret []*PeerConn) {
2981         for pc := range t.conns {
2982                 dialAddr, err := pc.remoteDialAddrPort()
2983                 if err != nil {
2984                         continue
2985                 }
2986                 if dialAddr != target {
2987                         continue
2988                 }
2989                 ret = append(ret, pc)
2990         }
2991         return
2992 }
2993
2994 func wrapUtHolepunchMsgForPeerConn(
2995         recipient *PeerConn,
2996         msg utHolepunch.Msg,
2997 ) pp.Message {
2998         extendedPayload, err := msg.MarshalBinary()
2999         if err != nil {
3000                 panic(err)
3001         }
3002         return pp.Message{
3003                 Type:            pp.Extended,
3004                 ExtendedID:      MapMustGet(recipient.PeerExtensionIDs, utHolepunch.ExtensionName),
3005                 ExtendedPayload: extendedPayload,
3006         }
3007 }
3008
3009 func sendUtHolepunchMsg(
3010         pc *PeerConn,
3011         msgType utHolepunch.MsgType,
3012         addrPort netip.AddrPort,
3013         errCode utHolepunch.ErrCode,
3014 ) {
3015         holepunchMsg := utHolepunch.Msg{
3016                 MsgType:  msgType,
3017                 AddrPort: addrPort,
3018                 ErrCode:  errCode,
3019         }
3020         incHolepunchMessagesSent(holepunchMsg)
3021         ppMsg := wrapUtHolepunchMsgForPeerConn(pc, holepunchMsg)
3022         pc.write(ppMsg)
3023 }
3024
3025 func incHolepunchMessages(msg utHolepunch.Msg, verb string) {
3026         torrent.Add(
3027                 fmt.Sprintf(
3028                         "holepunch %v %v messages %v",
3029                         msg.MsgType,
3030                         addrPortProtocolStr(msg.AddrPort),
3031                         verb,
3032                 ),
3033                 1,
3034         )
3035 }
3036
3037 func incHolepunchMessagesReceived(msg utHolepunch.Msg) {
3038         incHolepunchMessages(msg, "received")
3039 }
3040
3041 func incHolepunchMessagesSent(msg utHolepunch.Msg) {
3042         incHolepunchMessages(msg, "sent")
3043 }
3044
3045 func (t *Torrent) handleReceivedUtHolepunchMsg(msg utHolepunch.Msg, sender *PeerConn) error {
3046         incHolepunchMessagesReceived(msg)
3047         switch msg.MsgType {
3048         case utHolepunch.Rendezvous:
3049                 t.logger.Printf("got holepunch rendezvous request for %v from %p", msg.AddrPort, sender)
3050                 sendMsg := sendUtHolepunchMsg
3051                 senderAddrPort, err := sender.remoteDialAddrPort()
3052                 if err != nil {
3053                         sender.logger.Levelf(
3054                                 log.Warning,
3055                                 "error getting ut_holepunch rendezvous sender's dial address: %v",
3056                                 err,
3057                         )
3058                         // There's no better error code. The sender's address itself is invalid. I don't see
3059                         // this error message being appropriate anywhere else anyway.
3060                         sendMsg(sender, utHolepunch.Error, msg.AddrPort, utHolepunch.NoSuchPeer)
3061                 }
3062                 targets := t.peerConnsWithDialAddrPort(msg.AddrPort)
3063                 if len(targets) == 0 {
3064                         sendMsg(sender, utHolepunch.Error, msg.AddrPort, utHolepunch.NotConnected)
3065                         return nil
3066                 }
3067                 for _, pc := range targets {
3068                         if !pc.supportsExtension(utHolepunch.ExtensionName) {
3069                                 sendMsg(sender, utHolepunch.Error, msg.AddrPort, utHolepunch.NoSupport)
3070                                 continue
3071                         }
3072                         sendMsg(sender, utHolepunch.Connect, msg.AddrPort, 0)
3073                         sendMsg(pc, utHolepunch.Connect, senderAddrPort, 0)
3074                 }
3075                 return nil
3076         case utHolepunch.Connect:
3077                 holepunchAddr := msg.AddrPort
3078                 t.logger.Printf("got holepunch connect request for %v from %p", holepunchAddr, sender)
3079                 if g.MapContains(t.cl.undialableWithoutHolepunch, holepunchAddr) {
3080                         setAdd(&t.cl.undialableWithoutHolepunchDialedAfterHolepunchConnect, holepunchAddr)
3081                         if g.MapContains(t.cl.accepted, holepunchAddr) {
3082                                 setAdd(&t.cl.probablyOnlyConnectedDueToHolepunch, holepunchAddr)
3083                         }
3084                 }
3085                 opts := outgoingConnOpts{
3086                         peerInfo: PeerInfo{
3087                                 Addr:         msg.AddrPort,
3088                                 Source:       PeerSourceUtHolepunch,
3089                                 PexPeerFlags: sender.pex.remoteLiveConns[msg.AddrPort].UnwrapOrZeroValue(),
3090                         },
3091                         t: t,
3092                         // Don't attempt to start our own rendezvous if we fail to connect.
3093                         skipHolepunchRendezvous:  true,
3094                         receivedHolepunchConnect: true,
3095                         // Assume that the other end initiated the rendezvous, and will use our preferred
3096                         // encryption. So we will act normally.
3097                         HeaderObfuscationPolicy: t.cl.config.HeaderObfuscationPolicy,
3098                 }
3099                 initiateConn(opts, true)
3100                 return nil
3101         case utHolepunch.Error:
3102                 torrent.Add("holepunch error messages received", 1)
3103                 t.logger.Levelf(log.Debug, "received ut_holepunch error message from %v: %v", sender, msg.ErrCode)
3104                 return nil
3105         default:
3106                 return fmt.Errorf("unhandled msg type %v", msg.MsgType)
3107         }
3108 }
3109
3110 func addrPortProtocolStr(addrPort netip.AddrPort) string {
3111         addr := addrPort.Addr()
3112         switch {
3113         case addr.Is4():
3114                 return "ipv4"
3115         case addr.Is6():
3116                 return "ipv6"
3117         default:
3118                 panic(addrPort)
3119         }
3120 }
3121
3122 func (t *Torrent) trySendHolepunchRendezvous(addrPort netip.AddrPort) error {
3123         rzsSent := 0
3124         for pc := range t.conns {
3125                 if !pc.supportsExtension(utHolepunch.ExtensionName) {
3126                         continue
3127                 }
3128                 if pc.supportsExtension(pp.ExtensionNamePex) {
3129                         if !g.MapContains(pc.pex.remoteLiveConns, addrPort) {
3130                                 continue
3131                         }
3132                 }
3133                 t.logger.Levelf(log.Debug, "sent ut_holepunch rendezvous message to %v for %v", pc, addrPort)
3134                 sendUtHolepunchMsg(pc, utHolepunch.Rendezvous, addrPort, 0)
3135                 rzsSent++
3136         }
3137         if rzsSent == 0 {
3138                 return errors.New("no eligible relays")
3139         }
3140         return nil
3141 }
3142
3143 func (t *Torrent) numHalfOpenAttempts() (num int) {
3144         for _, attempts := range t.halfOpen {
3145                 num += len(attempts)
3146         }
3147         return
3148 }
3149
3150 func (t *Torrent) getDialTimeoutUnlocked() time.Duration {
3151         cl := t.cl
3152         cl.rLock()
3153         defer cl.rUnlock()
3154         return t.dialTimeout()
3155 }
3156
3157 func (t *Torrent) canonicalShortInfohash() *infohash.T {
3158         if t.infoHash.Ok {
3159                 return &t.infoHash.Value
3160         }
3161         return t.infoHashV2.UnwrapPtr().ToShort()
3162 }
3163
3164 func (t *Torrent) eachShortInfohash(each func(short [20]byte)) {
3165         if t.infoHash.Value == *t.infoHashV2.Value.ToShort() {
3166                 // This includes zero values, since they both should not be zero. Plus Option should not
3167                 // allow non-zero values for None.
3168                 panic("v1 and v2 info hashes should not be the same")
3169         }
3170         if t.infoHash.Ok {
3171                 each(t.infoHash.Value)
3172         }
3173         if t.infoHashV2.Ok {
3174                 v2Short := *t.infoHashV2.Value.ToShort()
3175                 each(v2Short)
3176         }
3177 }
3178
3179 func (t *Torrent) getFileByPiecesRoot(hash [32]byte) *File {
3180         for _, f := range *t.files {
3181                 if f.piecesRoot.Unwrap() == hash {
3182                         return f
3183                 }
3184         }
3185         return nil
3186 }
3187
3188 func (t *Torrent) pieceLayers() (pieceLayers map[string]string) {
3189         if t.files == nil {
3190                 return
3191         }
3192         files := *t.files
3193         g.MakeMapWithCap(&pieceLayers, len(files))
3194 file:
3195         for _, f := range files {
3196                 if !f.piecesRoot.Ok {
3197                         continue
3198                 }
3199                 key := f.piecesRoot.Value
3200                 var value strings.Builder
3201                 for i := f.BeginPieceIndex(); i < f.EndPieceIndex(); i++ {
3202                         hashOpt := t.piece(i).hashV2
3203                         if !hashOpt.Ok {
3204                                 // All hashes must be present. This implementation should handle missing files, so move on to the next file.
3205                                 continue file
3206                         }
3207                         value.Write(hashOpt.Value[:])
3208                 }
3209                 if value.Len() == 0 {
3210                         // Non-empty files are not recorded in piece layers.
3211                         continue
3212                 }
3213                 // If multiple files have the same root that shouldn't matter.
3214                 pieceLayers[string(key[:])] = value.String()
3215         }
3216         return
3217 }