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