18 "github.com/RoaringBitmap/roaring"
19 "github.com/anacrolix/chansync"
20 "github.com/anacrolix/chansync/events"
21 "github.com/anacrolix/dht/v2"
22 "github.com/anacrolix/log"
23 "github.com/anacrolix/missinggo/perf"
24 "github.com/anacrolix/missinggo/pubsub"
25 "github.com/anacrolix/missinggo/slices"
26 "github.com/anacrolix/missinggo/v2"
27 "github.com/anacrolix/missinggo/v2/bitmap"
28 "github.com/anacrolix/multiless"
29 "github.com/anacrolix/sync"
30 request_strategy "github.com/anacrolix/torrent/request-strategy"
31 "github.com/davecgh/go-spew/spew"
32 "github.com/pion/datachannel"
34 "github.com/anacrolix/torrent/bencode"
35 "github.com/anacrolix/torrent/common"
36 "github.com/anacrolix/torrent/metainfo"
37 pp "github.com/anacrolix/torrent/peer_protocol"
38 "github.com/anacrolix/torrent/segments"
39 "github.com/anacrolix/torrent/storage"
40 "github.com/anacrolix/torrent/tracker"
41 "github.com/anacrolix/torrent/webseed"
42 "github.com/anacrolix/torrent/webtorrent"
45 // Maintains state of torrent within a Client. Many methods should not be called before the info is
46 // available, see .Info and .GotInfo.
48 // Torrent-level aggregate statistics. First in struct to ensure 64-bit
49 // alignment. See #262.
54 networkingEnabled chansync.Flag
55 dataDownloadDisallowed chansync.Flag
56 dataUploadDisallowed bool
57 userOnWriteChunkErr func(error)
59 closed chansync.SetOnce
60 infoHash metainfo.Hash
62 // Values are the piece indices that changed.
63 pieceStateChanges *pubsub.PubSub
64 // The size of chunks to request from peers over the wire. This is
65 // normally 16KiB by convention these days.
68 // Total length of the torrent in bytes. Stored because it's not O(1) to
69 // get this from the info dict.
72 // The storage to open when the info dict becomes available.
73 storageOpener *storage.Client
74 // Storage for torrent data.
75 storage *storage.Torrent
76 // Read-locked for using storage, and write-locked for Closing.
77 storageLock sync.RWMutex
79 // TODO: Only announce stuff is used?
80 metainfo metainfo.MetaInfo
82 // The info dict. nil if we don't have it (yet).
84 fileIndex segments.Index
87 webSeeds map[string]*Peer
88 // Active peer connections, running message stream loops. TODO: Make this
89 // open (not-closed) connections only.
90 conns map[*PeerConn]struct{}
91 maxEstablishedConns int
92 // Set of addrs to which we're attempting to connect. Connections are
93 // half-open until all handshakes are completed.
94 halfOpen map[string]PeerInfo
96 // Reserve of peers to connect to. A peer can be both here and in the
97 // active connections if were told about the peer after connecting with
98 // them. That encourages us to reconnect to peers that are well known in
100 peers prioritizedPeers
101 // Whether we want to know to know more peers.
102 wantPeersEvent missinggo.Event
103 // An announcer for each tracker URL.
104 trackerAnnouncers map[string]torrentTrackerAnnouncer
105 // How many times we've initiated a DHT announce. TODO: Move into stats.
108 // Name used if the info name isn't available. Should be cleared when the
109 // Info does become available.
113 // The bencoded bytes of the info dict. This is actively manipulated if
114 // the info bytes aren't initially available, and we try to fetch them
117 // Each element corresponds to the 16KiB metadata pieces. If true, we have
118 // received that piece.
119 metadataCompletedChunks []bool
120 metadataChanged sync.Cond
122 // Closed when .Info is obtained.
123 gotMetainfoC chan struct{}
125 readers map[*reader]struct{}
126 _readerNowPieces bitmap.Bitmap
127 _readerReadaheadPieces bitmap.Bitmap
129 // A cache of pieces we need to get. Calculated from various piece and
130 // file priorities and completion states elsewhere.
131 _pendingPieces roaring.Bitmap
132 // A cache of completed piece indices.
133 _completedPieces roaring.Bitmap
134 // Pieces that need to be hashed.
135 piecesQueuedForHash bitmap.Bitmap
136 activePieceHashes int
137 initialPieceCheckDisabled bool
139 connsWithAllPieces map[*Peer]struct{}
140 // Count of each request across active connections.
141 pendingRequests map[RequestIndex]*Peer
142 lastRequested map[RequestIndex]time.Time
143 // Chunks we've written to since the corresponding piece was last checked.
144 dirtyChunks roaring.Bitmap
148 // Is On when all pieces are complete.
149 Complete chansync.Flag
152 func (t *Torrent) selectivePieceAvailabilityFromPeers(i pieceIndex) (count int) {
153 // This could be done with roaring.BitSliceIndexing.
154 t.iterPeers(func(peer *Peer) {
155 if _, ok := t.connsWithAllPieces[peer]; ok {
158 if peer.peerHasPiece(i) {
165 func (t *Torrent) decPieceAvailability(i pieceIndex) {
170 if p.relativeAvailability <= 0 {
171 panic(p.relativeAvailability)
173 p.relativeAvailability--
174 t.updatePieceRequestOrder(i)
177 func (t *Torrent) incPieceAvailability(i pieceIndex) {
178 // If we don't the info, this should be reconciled when we do.
181 p.relativeAvailability++
182 t.updatePieceRequestOrder(i)
186 func (t *Torrent) readerNowPieces() bitmap.Bitmap {
187 return t._readerNowPieces
190 func (t *Torrent) readerReadaheadPieces() bitmap.Bitmap {
191 return t._readerReadaheadPieces
194 func (t *Torrent) ignorePieceForRequests(i pieceIndex) bool {
195 return !t.wantPieceIndex(i)
198 // Returns a channel that is closed when the Torrent is closed.
199 func (t *Torrent) Closed() events.Done {
200 return t.closed.Done()
203 // KnownSwarm returns the known subset of the peers in the Torrent's swarm, including active,
204 // pending, and half-open peers.
205 func (t *Torrent) KnownSwarm() (ks []PeerInfo) {
206 // Add pending peers to the list
207 t.peers.Each(func(peer PeerInfo) {
208 ks = append(ks, peer)
211 // Add half-open peers to the list
212 for _, peer := range t.halfOpen {
213 ks = append(ks, peer)
216 // Add active peers to the list
217 for conn := range t.conns {
218 ks = append(ks, PeerInfo{
220 Addr: conn.RemoteAddr,
221 Source: conn.Discovery,
222 // > If the connection is encrypted, that's certainly enough to set SupportsEncryption.
223 // > But if we're not connected to them with an encrypted connection, I couldn't say
224 // > what's appropriate. We can carry forward the SupportsEncryption value as we
225 // > received it from trackers/DHT/PEX, or just use the encryption state for the
226 // > connection. It's probably easiest to do the latter for now.
227 // https://github.com/anacrolix/torrent/pull/188
228 SupportsEncryption: conn.headerEncrypted,
235 func (t *Torrent) setChunkSize(size pp.Integer) {
237 t.chunkPool = sync.Pool{
238 New: func() interface{} {
239 b := make([]byte, size)
245 func (t *Torrent) pieceComplete(piece pieceIndex) bool {
246 return t._completedPieces.Contains(bitmap.BitIndex(piece))
249 func (t *Torrent) pieceCompleteUncached(piece pieceIndex) storage.Completion {
250 if t.storage == nil {
251 return storage.Completion{Complete: false, Ok: true}
253 return t.pieces[piece].Storage().Completion()
256 // There's a connection to that address already.
257 func (t *Torrent) addrActive(addr string) bool {
258 if _, ok := t.halfOpen[addr]; ok {
261 for c := range t.conns {
263 if ra.String() == addr {
270 func (t *Torrent) appendUnclosedConns(ret []*PeerConn) []*PeerConn {
271 return t.appendConns(ret, func(conn *PeerConn) bool {
272 return !conn.closed.IsSet()
276 func (t *Torrent) appendConns(ret []*PeerConn, f func(*PeerConn) bool) []*PeerConn {
277 for c := range t.conns {
285 func (t *Torrent) addPeer(p PeerInfo) (added bool) {
287 torrent.Add(fmt.Sprintf("peers added by source %q", p.Source), 1)
288 if t.closed.IsSet() {
291 if ipAddr, ok := tryIpPortFromNetAddr(p.Addr); ok {
292 if cl.badPeerIPPort(ipAddr.IP, ipAddr.Port) {
293 torrent.Add("peers not added because of bad addr", 1)
294 // cl.logger.Printf("peers not added because of bad addr: %v", p)
298 if replaced, ok := t.peers.AddReturningReplacedPeer(p); ok {
299 torrent.Add("peers replaced", 1)
300 if !replaced.equal(p) {
301 t.logger.WithDefaultLevel(log.Debug).Printf("added %v replacing %v", p, replaced)
308 for t.peers.Len() > cl.config.TorrentPeersHighWater {
309 _, ok := t.peers.DeleteMin()
311 torrent.Add("excess reserve peers discarded", 1)
317 func (t *Torrent) invalidateMetadata() {
318 for i := 0; i < len(t.metadataCompletedChunks); i++ {
319 t.metadataCompletedChunks[i] = false
322 t.gotMetainfoC = make(chan struct{})
327 func (t *Torrent) saveMetadataPiece(index int, data []byte) {
331 if index >= len(t.metadataCompletedChunks) {
332 t.logger.Printf("%s: ignoring metadata piece %d", t, index)
335 copy(t.metadataBytes[(1<<14)*index:], data)
336 t.metadataCompletedChunks[index] = true
339 func (t *Torrent) metadataPieceCount() int {
340 return (len(t.metadataBytes) + (1 << 14) - 1) / (1 << 14)
343 func (t *Torrent) haveMetadataPiece(piece int) bool {
345 return (1<<14)*piece < len(t.metadataBytes)
347 return piece < len(t.metadataCompletedChunks) && t.metadataCompletedChunks[piece]
351 func (t *Torrent) metadataSize() int {
352 return len(t.metadataBytes)
355 func infoPieceHashes(info *metainfo.Info) (ret [][]byte) {
356 for i := 0; i < len(info.Pieces); i += sha1.Size {
357 ret = append(ret, info.Pieces[i:i+sha1.Size])
362 func (t *Torrent) makePieces() {
363 hashes := infoPieceHashes(t.info)
364 t.pieces = make([]Piece, len(hashes))
365 for i, hash := range hashes {
366 piece := &t.pieces[i]
368 piece.index = pieceIndex(i)
369 piece.noPendingWrites.L = &piece.pendingWritesMutex
370 piece.hash = (*metainfo.Hash)(unsafe.Pointer(&hash[0]))
372 beginFile := pieceFirstFileIndex(piece.torrentBeginOffset(), files)
373 endFile := pieceEndFileIndex(piece.torrentEndOffset(), files)
374 piece.files = files[beginFile:endFile]
375 piece.undirtiedChunksIter = undirtiedChunksIter{
376 TorrentDirtyChunks: &t.dirtyChunks,
377 StartRequestIndex: piece.requestIndexOffset(),
378 EndRequestIndex: piece.requestIndexOffset() + piece.numChunks(),
383 // Returns the index of the first file containing the piece. files must be
384 // ordered by offset.
385 func pieceFirstFileIndex(pieceOffset int64, files []*File) int {
386 for i, f := range files {
387 if f.offset+f.length > pieceOffset {
394 // Returns the index after the last file containing the piece. files must be
395 // ordered by offset.
396 func pieceEndFileIndex(pieceEndOffset int64, files []*File) int {
397 for i, f := range files {
398 if f.offset+f.length >= pieceEndOffset {
405 func (t *Torrent) cacheLength() {
407 for _, f := range t.info.UpvertedFiles() {
413 // TODO: This shouldn't fail for storage reasons. Instead we should handle storage failure
415 func (t *Torrent) setInfo(info *metainfo.Info) error {
416 if err := validateInfo(info); err != nil {
417 return fmt.Errorf("bad info: %s", err)
419 if t.storageOpener != nil {
421 t.storage, err = t.storageOpener.OpenTorrent(info, t.infoHash)
423 return fmt.Errorf("error opening torrent storage: %s", err)
430 t.fileIndex = segments.NewIndex(common.LengthIterFromUpvertedFiles(info.UpvertedFiles()))
431 t.displayName = "" // Save a few bytes lol.
438 func (t *Torrent) pieceRequestOrderKey(i int) request_strategy.PieceRequestOrderKey {
439 return request_strategy.PieceRequestOrderKey{
440 InfoHash: t.infoHash,
445 // This seems to be all the follow-up tasks after info is set, that can't fail.
446 func (t *Torrent) onSetInfo() {
447 t.initPieceRequestOrder()
448 for i := range t.pieces {
450 // Need to add relativeAvailability before updating piece completion, as that may result in conns
452 if p.relativeAvailability != 0 {
453 panic(p.relativeAvailability)
455 p.relativeAvailability = t.selectivePieceAvailabilityFromPeers(i)
456 t.addRequestOrderPiece(i)
457 t.updatePieceCompletion(pieceIndex(i))
458 if !t.initialPieceCheckDisabled && !p.storageCompletionOk {
459 // t.logger.Printf("piece %s completion unknown, queueing check", p)
460 t.queuePieceCheck(pieceIndex(i))
463 t.cl.event.Broadcast()
464 close(t.gotMetainfoC)
465 t.updateWantPeersEvent()
466 t.pendingRequests = make(map[RequestIndex]*Peer)
467 t.lastRequested = make(map[RequestIndex]time.Time)
468 t.tryCreateMorePieceHashers()
469 t.iterPeers(func(p *Peer) {
471 p.updateRequests("onSetInfo")
475 // Called when metadata for a torrent becomes available.
476 func (t *Torrent) setInfoBytesLocked(b []byte) error {
477 if metainfo.HashBytes(b) != t.infoHash {
478 return errors.New("info bytes have wrong hash")
480 var info metainfo.Info
481 if err := bencode.Unmarshal(b, &info); err != nil {
482 return fmt.Errorf("error unmarshalling info bytes: %s", err)
485 t.metadataCompletedChunks = nil
489 if err := t.setInfo(&info); err != nil {
496 func (t *Torrent) haveAllMetadataPieces() bool {
500 if t.metadataCompletedChunks == nil {
503 for _, have := range t.metadataCompletedChunks {
511 // TODO: Propagate errors to disconnect peer.
512 func (t *Torrent) setMetadataSize(size int) (err error) {
514 // We already know the correct metadata size.
517 if uint32(size) > maxMetadataSize {
518 return errors.New("bad size")
520 if len(t.metadataBytes) == size {
523 t.metadataBytes = make([]byte, size)
524 t.metadataCompletedChunks = make([]bool, (size+(1<<14)-1)/(1<<14))
525 t.metadataChanged.Broadcast()
526 for c := range t.conns {
527 c.requestPendingMetadata()
532 // The current working name for the torrent. Either the name in the info dict,
533 // or a display name given such as by the dn value in a magnet link, or "".
534 func (t *Torrent) name() string {
536 defer t.nameMu.RUnlock()
540 if t.displayName != "" {
543 return "infohash:" + t.infoHash.HexString()
546 func (t *Torrent) pieceState(index pieceIndex) (ret PieceState) {
547 p := &t.pieces[index]
548 ret.Priority = t.piecePriority(index)
549 ret.Completion = p.completion()
550 ret.QueuedForHash = p.queuedForHash()
551 ret.Hashing = p.hashing
552 ret.Checking = ret.QueuedForHash || ret.Hashing
553 ret.Marking = p.marking
554 if !ret.Complete && t.piecePartiallyDownloaded(index) {
560 func (t *Torrent) metadataPieceSize(piece int) int {
561 return metadataPieceSize(len(t.metadataBytes), piece)
564 func (t *Torrent) newMetadataExtensionMessage(c *PeerConn, msgType pp.ExtendedMetadataRequestMsgType, piece int, data []byte) pp.Message {
567 ExtendedID: c.PeerExtensionIDs[pp.ExtensionNameMetadata],
568 ExtendedPayload: append(bencode.MustMarshal(pp.ExtendedMetadataRequestMsg{
570 TotalSize: len(t.metadataBytes),
576 type pieceAvailabilityRun struct {
581 func (me pieceAvailabilityRun) String() string {
582 return fmt.Sprintf("%v(%v)", me.Count, me.Availability)
585 func (t *Torrent) pieceAvailabilityRuns() (ret []pieceAvailabilityRun) {
586 rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
587 ret = append(ret, pieceAvailabilityRun{Availability: el.(int), Count: int(count)})
589 for i := range t.pieces {
590 rle.Append(t.pieces[i].availability(), 1)
596 func (t *Torrent) pieceStateRuns() (ret PieceStateRuns) {
597 rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
598 ret = append(ret, PieceStateRun{
599 PieceState: el.(PieceState),
603 for index := range t.pieces {
604 rle.Append(t.pieceState(pieceIndex(index)), 1)
610 // Produces a small string representing a PieceStateRun.
611 func (psr PieceStateRun) String() (ret string) {
612 ret = fmt.Sprintf("%d", psr.Length)
613 ret += func() string {
614 switch psr.Priority {
615 case PiecePriorityNext:
617 case PiecePriorityNormal:
619 case PiecePriorityReadahead:
621 case PiecePriorityNow:
623 case PiecePriorityHigh:
632 if psr.QueuedForHash {
650 func (t *Torrent) writeStatus(w io.Writer) {
651 fmt.Fprintf(w, "Infohash: %s\n", t.infoHash.HexString())
652 fmt.Fprintf(w, "Metadata length: %d\n", t.metadataSize())
654 fmt.Fprintf(w, "Metadata have: ")
655 for _, h := range t.metadataCompletedChunks {
656 fmt.Fprintf(w, "%c", func() rune {
666 fmt.Fprintf(w, "Piece length: %s\n",
669 return fmt.Sprintf("%v (%v chunks)",
671 float64(t.usualPieceSize())/float64(t.chunkSize))
678 fmt.Fprintf(w, "Num Pieces: %d (%d completed)\n", t.numPieces(), t.numPiecesCompleted())
679 fmt.Fprintf(w, "Piece States: %s\n", t.pieceStateRuns())
680 fmt.Fprintf(w, "Piece availability: %v\n", strings.Join(func() (ret []string) {
681 for _, run := range t.pieceAvailabilityRuns() {
682 ret = append(ret, run.String())
687 fmt.Fprintf(w, "Reader Pieces:")
688 t.forReaderOffsetPieces(func(begin, end pieceIndex) (again bool) {
689 fmt.Fprintf(w, " %d:%d", begin, end)
694 fmt.Fprintf(w, "Enabled trackers:\n")
696 tw := tabwriter.NewWriter(w, 0, 0, 2, ' ', 0)
697 fmt.Fprintf(tw, " URL\tExtra\n")
698 for _, ta := range slices.Sort(slices.FromMapElems(t.trackerAnnouncers), func(l, r torrentTrackerAnnouncer) bool {
701 var luns, runs url.URL = *lu, *ru
704 var ml missinggo.MultiLess
705 ml.StrictNext(luns.String() == runs.String(), luns.String() < runs.String())
706 ml.StrictNext(lu.String() == ru.String(), lu.String() < ru.String())
708 }).([]torrentTrackerAnnouncer) {
709 fmt.Fprintf(tw, " %q\t%v\n", ta.URL(), ta.statusLine())
714 fmt.Fprintf(w, "DHT Announces: %d\n", t.numDHTAnnounces)
716 spew.NewDefaultConfig()
717 spew.Fdump(w, t.statsLocked())
719 peers := t.peersAsSlice()
720 sort.Slice(peers, func(_i, _j int) bool {
723 if less, ok := multiless.New().EagerSameLess(
724 i.downloadRate() == j.downloadRate(), i.downloadRate() < j.downloadRate(),
728 return worseConn(i, j)
730 for i, c := range peers {
731 fmt.Fprintf(w, "%2d. ", i+1)
736 func (t *Torrent) haveInfo() bool {
740 // Returns a run-time generated MetaInfo that includes the info bytes and
741 // announce-list as currently known to the client.
742 func (t *Torrent) newMetaInfo() metainfo.MetaInfo {
743 return metainfo.MetaInfo{
744 CreationDate: time.Now().Unix(),
745 Comment: "dynamic metainfo from client",
746 CreatedBy: "go.torrent",
747 AnnounceList: t.metainfo.UpvertedAnnounceList().Clone(),
748 InfoBytes: func() []byte {
750 return t.metadataBytes
755 UrlList: func() []string {
756 ret := make([]string, 0, len(t.webSeeds))
757 for url := range t.webSeeds {
758 ret = append(ret, url)
766 func (t *Torrent) BytesMissing() (n int64) {
768 n = t.bytesMissingLocked()
773 func (t *Torrent) bytesMissingLocked() int64 {
777 func iterFlipped(b *roaring.Bitmap, end uint64, cb func(uint32) bool) {
778 roaring.Flip(b, 0, end).Iterate(cb)
781 func (t *Torrent) bytesLeft() (left int64) {
782 iterFlipped(&t._completedPieces, uint64(t.numPieces()), func(x uint32) bool {
783 p := t.piece(pieceIndex(x))
784 left += int64(p.length() - p.numDirtyBytes())
790 // Bytes left to give in tracker announces.
791 func (t *Torrent) bytesLeftAnnounce() int64 {
799 func (t *Torrent) piecePartiallyDownloaded(piece pieceIndex) bool {
800 if t.pieceComplete(piece) {
803 if t.pieceAllDirty(piece) {
806 return t.pieces[piece].hasDirtyChunks()
809 func (t *Torrent) usualPieceSize() int {
810 return int(t.info.PieceLength)
813 func (t *Torrent) numPieces() pieceIndex {
814 return pieceIndex(t.info.NumPieces())
817 func (t *Torrent) numPiecesCompleted() (num pieceIndex) {
818 return pieceIndex(t._completedPieces.GetCardinality())
821 func (t *Torrent) close(wg *sync.WaitGroup) (err error) {
823 if t.storage != nil {
828 defer t.storageLock.Unlock()
829 if f := t.storage.Close; f != nil {
832 t.logger.WithDefaultLevel(log.Warning).Printf("error closing storage: %v", err1)
837 t.iterPeers(func(p *Peer) {
840 if t.storage != nil {
841 t.deletePieceRequestOrder()
843 for i := range t.pieces {
845 if p.relativeAvailability != 0 {
846 panic(fmt.Sprintf("piece %v has relative availability %v", i, p.relativeAvailability))
850 t.cl.event.Broadcast()
851 t.pieceStateChanges.Close()
852 t.updateWantPeersEvent()
856 func (t *Torrent) requestOffset(r Request) int64 {
857 return torrentRequestOffset(*t.length, int64(t.usualPieceSize()), r)
860 // Return the request that would include the given offset into the torrent data. Returns !ok if
861 // there is no such request.
862 func (t *Torrent) offsetRequest(off int64) (req Request, ok bool) {
863 return torrentOffsetRequest(*t.length, t.info.PieceLength, int64(t.chunkSize), off)
866 func (t *Torrent) writeChunk(piece int, begin int64, data []byte) (err error) {
867 defer perf.ScopeTimerErr(&err)()
868 n, err := t.pieces[piece].Storage().WriteAt(data, begin)
869 if err == nil && n != len(data) {
870 err = io.ErrShortWrite
875 func (t *Torrent) bitfield() (bf []bool) {
876 bf = make([]bool, t.numPieces())
877 t._completedPieces.Iterate(func(piece uint32) (again bool) {
884 func (t *Torrent) pieceNumChunks(piece pieceIndex) chunkIndexType {
885 return chunkIndexType((t.pieceLength(piece) + t.chunkSize - 1) / t.chunkSize)
888 func (t *Torrent) chunksPerRegularPiece() uint32 {
889 return uint32((pp.Integer(t.usualPieceSize()) + t.chunkSize - 1) / t.chunkSize)
892 func (t *Torrent) numRequests() RequestIndex {
893 if t.numPieces() == 0 {
896 return uint32(t.numPieces()-1)*t.chunksPerRegularPiece() + t.pieceNumChunks(t.numPieces()-1)
899 func (t *Torrent) pendAllChunkSpecs(pieceIndex pieceIndex) {
900 t.dirtyChunks.RemoveRange(
901 uint64(t.pieceRequestIndexOffset(pieceIndex)),
902 uint64(t.pieceRequestIndexOffset(pieceIndex+1)))
905 func (t *Torrent) pieceLength(piece pieceIndex) pp.Integer {
906 if t.info.PieceLength == 0 {
907 // There will be no variance amongst pieces. Only pain.
910 if piece == t.numPieces()-1 {
911 ret := pp.Integer(*t.length % t.info.PieceLength)
916 return pp.Integer(t.info.PieceLength)
919 func (t *Torrent) hashPiece(piece pieceIndex) (ret metainfo.Hash, err error) {
921 p.waitNoPendingWrites()
922 storagePiece := t.pieces[piece].Storage()
924 // Does the backend want to do its own hashing?
925 if i, ok := storagePiece.PieceImpl.(storage.SelfHashing); ok {
926 var sum metainfo.Hash
927 // log.Printf("A piece decided to self-hash: %d", piece)
928 sum, err = i.SelfHash()
929 missinggo.CopyExact(&ret, sum)
933 hash := pieceHash.New()
934 const logPieceContents = false
935 if logPieceContents {
936 var examineBuf bytes.Buffer
937 _, err = storagePiece.WriteTo(io.MultiWriter(hash, &examineBuf))
938 log.Printf("hashed %q with copy err %v", examineBuf.Bytes(), err)
940 _, err = storagePiece.WriteTo(hash)
942 missinggo.CopyExact(&ret, hash.Sum(nil))
946 func (t *Torrent) haveAnyPieces() bool {
947 return !t._completedPieces.IsEmpty()
950 func (t *Torrent) haveAllPieces() bool {
954 return t._completedPieces.GetCardinality() == bitmap.BitRange(t.numPieces())
957 func (t *Torrent) havePiece(index pieceIndex) bool {
958 return t.haveInfo() && t.pieceComplete(index)
961 func (t *Torrent) maybeDropMutuallyCompletePeer(
962 // I'm not sure about taking peer here, not all peer implementations actually drop. Maybe that's
966 if !t.cl.config.DropMutuallyCompletePeers {
969 if !t.haveAllPieces() {
972 if all, known := p.peerHasAllPieces(); !(known && all) {
978 t.logger.WithDefaultLevel(log.Debug).Printf("dropping %v, which is mutually complete", p)
982 func (t *Torrent) haveChunk(r Request) (ret bool) {
984 // log.Println("have chunk", r, ret)
989 if t.pieceComplete(pieceIndex(r.Index)) {
992 p := &t.pieces[r.Index]
993 return !p.pendingChunk(r.ChunkSpec, t.chunkSize)
996 func chunkIndexFromChunkSpec(cs ChunkSpec, chunkSize pp.Integer) chunkIndexType {
997 return chunkIndexType(cs.Begin / chunkSize)
1000 func (t *Torrent) wantPieceIndex(index pieceIndex) bool {
1001 return t._pendingPieces.Contains(uint32(index))
1004 // A pool of []*PeerConn, to reduce allocations in functions that need to index or sort Torrent
1005 // conns (which is a map).
1006 var peerConnSlices sync.Pool
1008 func getPeerConnSlice(cap int) []*PeerConn {
1009 getInterface := peerConnSlices.Get()
1010 if getInterface == nil {
1011 return make([]*PeerConn, 0, cap)
1013 return getInterface.([]*PeerConn)[:0]
1017 // The worst connection is one that hasn't been sent, or sent anything useful for the longest. A bad
1018 // connection is one that usually sends us unwanted pieces, or has been in the worse half of the
1019 // established connections for more than a minute. This is O(n log n). If there was a way to not
1020 // consider the position of a conn relative to the total number, it could be reduced to O(n).
1021 func (t *Torrent) worstBadConn() (ret *PeerConn) {
1022 wcs := worseConnSlice{conns: t.appendUnclosedConns(getPeerConnSlice(len(t.conns)))}
1023 defer peerConnSlices.Put(wcs.conns)
1026 for wcs.Len() != 0 {
1027 c := heap.Pop(&wcs).(*PeerConn)
1028 if c._stats.ChunksReadWasted.Int64() >= 6 && c._stats.ChunksReadWasted.Int64() > c._stats.ChunksReadUseful.Int64() {
1031 // If the connection is in the worst half of the established
1032 // connection quota and is older than a minute.
1033 if wcs.Len() >= (t.maxEstablishedConns+1)/2 {
1034 // Give connections 1 minute to prove themselves.
1035 if time.Since(c.completedHandshake) > time.Minute {
1043 type PieceStateChange struct {
1048 func (t *Torrent) publishPieceChange(piece pieceIndex) {
1049 t.cl._mu.Defer(func() {
1050 cur := t.pieceState(piece)
1051 p := &t.pieces[piece]
1052 if cur != p.publicPieceState {
1053 p.publicPieceState = cur
1054 t.pieceStateChanges.Publish(PieceStateChange{
1062 func (t *Torrent) pieceNumPendingChunks(piece pieceIndex) pp.Integer {
1063 if t.pieceComplete(piece) {
1066 return pp.Integer(t.pieceNumChunks(piece) - t.pieces[piece].numDirtyChunks())
1069 func (t *Torrent) pieceAllDirty(piece pieceIndex) bool {
1070 return t.pieces[piece].allChunksDirty()
1073 func (t *Torrent) readersChanged() {
1074 t.updateReaderPieces()
1075 t.updateAllPiecePriorities("Torrent.readersChanged")
1078 func (t *Torrent) updateReaderPieces() {
1079 t._readerNowPieces, t._readerReadaheadPieces = t.readerPiecePriorities()
1082 func (t *Torrent) readerPosChanged(from, to pieceRange) {
1086 t.updateReaderPieces()
1087 // Order the ranges, high and low.
1089 if l.begin > h.begin {
1092 if l.end < h.begin {
1093 // Two distinct ranges.
1094 t.updatePiecePriorities(l.begin, l.end, "Torrent.readerPosChanged")
1095 t.updatePiecePriorities(h.begin, h.end, "Torrent.readerPosChanged")
1102 t.updatePiecePriorities(l.begin, end, "Torrent.readerPosChanged")
1106 func (t *Torrent) maybeNewConns() {
1107 // Tickle the accept routine.
1108 t.cl.event.Broadcast()
1112 func (t *Torrent) piecePriorityChanged(piece pieceIndex, reason string) {
1113 if t._pendingPieces.Contains(uint32(piece)) {
1114 t.iterPeers(func(c *Peer) {
1115 // if c.requestState.Interested {
1118 if !c.isLowOnRequests() {
1121 if !c.peerHasPiece(piece) {
1124 if c.requestState.Interested && c.peerChoking && !c.peerAllowedFast.Contains(uint32(piece)) {
1127 c.updateRequests(reason)
1131 t.publishPieceChange(piece)
1134 func (t *Torrent) updatePiecePriority(piece pieceIndex, reason string) {
1135 if !t.closed.IsSet() {
1136 // It would be possible to filter on pure-priority changes here to avoid churning the piece
1138 t.updatePieceRequestOrder(piece)
1140 p := &t.pieces[piece]
1141 newPrio := p.uncachedPriority()
1142 // t.logger.Printf("torrent %p: piece %d: uncached priority: %v", t, piece, newPrio)
1143 if newPrio == PiecePriorityNone {
1144 if !t._pendingPieces.CheckedRemove(uint32(piece)) {
1148 if !t._pendingPieces.CheckedAdd(uint32(piece)) {
1152 t.piecePriorityChanged(piece, reason)
1155 func (t *Torrent) updateAllPiecePriorities(reason string) {
1156 t.updatePiecePriorities(0, t.numPieces(), reason)
1159 // Update all piece priorities in one hit. This function should have the same
1160 // output as updatePiecePriority, but across all pieces.
1161 func (t *Torrent) updatePiecePriorities(begin, end pieceIndex, reason string) {
1162 for i := begin; i < end; i++ {
1163 t.updatePiecePriority(i, reason)
1167 // Returns the range of pieces [begin, end) that contains the extent of bytes.
1168 func (t *Torrent) byteRegionPieces(off, size int64) (begin, end pieceIndex) {
1169 if off >= *t.length {
1179 begin = pieceIndex(off / t.info.PieceLength)
1180 end = pieceIndex((off + size + t.info.PieceLength - 1) / t.info.PieceLength)
1181 if end > pieceIndex(t.info.NumPieces()) {
1182 end = pieceIndex(t.info.NumPieces())
1187 // Returns true if all iterations complete without breaking. Returns the read regions for all
1188 // readers. The reader regions should not be merged as some callers depend on this method to
1189 // enumerate readers.
1190 func (t *Torrent) forReaderOffsetPieces(f func(begin, end pieceIndex) (more bool)) (all bool) {
1191 for r := range t.readers {
1193 if p.begin >= p.end {
1196 if !f(p.begin, p.end) {
1203 func (t *Torrent) piecePriority(piece pieceIndex) piecePriority {
1204 return t.piece(piece).uncachedPriority()
1207 func (t *Torrent) pendRequest(req RequestIndex) {
1208 t.piece(int(req / t.chunksPerRegularPiece())).pendChunkIndex(req % t.chunksPerRegularPiece())
1211 func (t *Torrent) pieceCompletionChanged(piece pieceIndex, reason string) {
1212 t.cl.event.Broadcast()
1213 if t.pieceComplete(piece) {
1214 t.onPieceCompleted(piece)
1216 t.onIncompletePiece(piece)
1218 t.updatePiecePriority(piece, reason)
1221 func (t *Torrent) numReceivedConns() (ret int) {
1222 for c := range t.conns {
1223 if c.Discovery == PeerSourceIncoming {
1230 func (t *Torrent) maxHalfOpen() int {
1231 // Note that if we somehow exceed the maximum established conns, we want
1232 // the negative value to have an effect.
1233 establishedHeadroom := int64(t.maxEstablishedConns - len(t.conns))
1234 extraIncoming := int64(t.numReceivedConns() - t.maxEstablishedConns/2)
1235 // We want to allow some experimentation with new peers, and to try to
1236 // upset an oversupply of received connections.
1237 return int(min(max(5, extraIncoming)+establishedHeadroom, int64(t.cl.config.HalfOpenConnsPerTorrent)))
1240 func (t *Torrent) openNewConns() (initiated int) {
1241 defer t.updateWantPeersEvent()
1242 for t.peers.Len() != 0 {
1246 if len(t.halfOpen) >= t.maxHalfOpen() {
1249 if len(t.cl.dialers) == 0 {
1252 if t.cl.numHalfOpen >= t.cl.config.TotalHalfOpenConns {
1255 p := t.peers.PopMax()
1262 func (t *Torrent) updatePieceCompletion(piece pieceIndex) bool {
1264 uncached := t.pieceCompleteUncached(piece)
1265 cached := p.completion()
1266 changed := cached != uncached
1267 complete := uncached.Complete
1268 p.storageCompletionOk = uncached.Ok
1271 t._completedPieces.Add(x)
1274 t._completedPieces.Remove(x)
1276 p.t.updatePieceRequestOrder(piece)
1278 if complete && len(p.dirtiers) != 0 {
1279 t.logger.Printf("marked piece %v complete but still has dirtiers", piece)
1282 log.Fstr("piece %d completion changed: %+v -> %+v", piece, cached, uncached).SetLevel(log.Debug).Log(t.logger)
1283 t.pieceCompletionChanged(piece, "Torrent.updatePieceCompletion")
1288 // Non-blocking read. Client lock is not required.
1289 func (t *Torrent) readAt(b []byte, off int64) (n int, err error) {
1291 p := &t.pieces[off/t.info.PieceLength]
1292 p.waitNoPendingWrites()
1294 n1, err = p.Storage().ReadAt(b, off-p.Info().Offset())
1305 // Returns an error if the metadata was completed, but couldn't be set for some reason. Blame it on
1306 // the last peer to contribute. TODO: Actually we shouldn't blame peers for failure to open storage
1307 // etc. Also we should probably cached metadata pieces per-Peer, to isolate failure appropriately.
1308 func (t *Torrent) maybeCompleteMetadata() error {
1313 if !t.haveAllMetadataPieces() {
1314 // Don't have enough metadata pieces.
1317 err := t.setInfoBytesLocked(t.metadataBytes)
1319 t.invalidateMetadata()
1320 return fmt.Errorf("error setting info bytes: %s", err)
1322 if t.cl.config.Debug {
1323 t.logger.Printf("%s: got metadata from peers", t)
1328 func (t *Torrent) readerPiecePriorities() (now, readahead bitmap.Bitmap) {
1329 t.forReaderOffsetPieces(func(begin, end pieceIndex) bool {
1331 now.Add(bitmap.BitIndex(begin))
1332 readahead.AddRange(bitmap.BitRange(begin)+1, bitmap.BitRange(end))
1339 func (t *Torrent) needData() bool {
1340 if t.closed.IsSet() {
1346 return !t._pendingPieces.IsEmpty()
1349 func appendMissingStrings(old, new []string) (ret []string) {
1352 for _, n := range new {
1353 for _, o := range old {
1358 ret = append(ret, n)
1363 func appendMissingTrackerTiers(existing [][]string, minNumTiers int) (ret [][]string) {
1365 for minNumTiers > len(ret) {
1366 ret = append(ret, nil)
1371 func (t *Torrent) addTrackers(announceList [][]string) {
1372 fullAnnounceList := &t.metainfo.AnnounceList
1373 t.metainfo.AnnounceList = appendMissingTrackerTiers(*fullAnnounceList, len(announceList))
1374 for tierIndex, trackerURLs := range announceList {
1375 (*fullAnnounceList)[tierIndex] = appendMissingStrings((*fullAnnounceList)[tierIndex], trackerURLs)
1377 t.startMissingTrackerScrapers()
1378 t.updateWantPeersEvent()
1381 // Don't call this before the info is available.
1382 func (t *Torrent) bytesCompleted() int64 {
1386 return *t.length - t.bytesLeft()
1389 func (t *Torrent) SetInfoBytes(b []byte) (err error) {
1392 return t.setInfoBytesLocked(b)
1395 // Returns true if connection is removed from torrent.Conns.
1396 func (t *Torrent) deletePeerConn(c *PeerConn) (ret bool) {
1397 if !c.closed.IsSet() {
1398 panic("connection is not closed")
1399 // There are behaviours prevented by the closed state that will fail
1400 // if the connection has been deleted.
1404 // Avoid adding a drop event more than once. Probably we should track whether we've generated
1405 // the drop event against the PexConnState instead.
1407 if !t.cl.config.DisablePEX {
1411 torrent.Add("deleted connections", 1)
1412 if !c.deleteAllRequests().IsEmpty() {
1413 t.iterPeers(func(p *Peer) {
1414 if p.isLowOnRequests() {
1415 p.updateRequests("Torrent.deletePeerConn")
1419 t.assertPendingRequests()
1420 if t.numActivePeers() == 0 && len(t.connsWithAllPieces) != 0 {
1421 panic(t.connsWithAllPieces)
1426 func (t *Torrent) decPeerPieceAvailability(p *Peer) {
1427 if t.deleteConnWithAllPieces(p) {
1433 p.peerPieces().Iterate(func(i uint32) bool {
1434 p.t.decPieceAvailability(pieceIndex(i))
1439 func (t *Torrent) assertPendingRequests() {
1443 // var actual pendingRequests
1444 // if t.haveInfo() {
1445 // actual.m = make([]int, t.numRequests())
1447 // t.iterPeers(func(p *Peer) {
1448 // p.requestState.Requests.Iterate(func(x uint32) bool {
1453 // diff := cmp.Diff(actual.m, t.pendingRequests.m)
1459 func (t *Torrent) dropConnection(c *PeerConn) {
1460 t.cl.event.Broadcast()
1462 if t.deletePeerConn(c) {
1467 // Peers as in contact information for dialing out.
1468 func (t *Torrent) wantPeers() bool {
1469 if t.closed.IsSet() {
1472 if t.peers.Len() > t.cl.config.TorrentPeersLowWater {
1475 return t.wantConns()
1478 func (t *Torrent) updateWantPeersEvent() {
1480 t.wantPeersEvent.Set()
1482 t.wantPeersEvent.Clear()
1486 // Returns whether the client should make effort to seed the torrent.
1487 func (t *Torrent) seeding() bool {
1489 if t.closed.IsSet() {
1492 if t.dataUploadDisallowed {
1495 if cl.config.NoUpload {
1498 if !cl.config.Seed {
1501 if cl.config.DisableAggressiveUpload && t.needData() {
1507 func (t *Torrent) onWebRtcConn(
1508 c datachannel.ReadWriteCloser,
1509 dcc webtorrent.DataChannelContext,
1512 pc, err := t.cl.initiateProtocolHandshakes(
1513 context.Background(),
1514 webrtcNetConn{c, dcc},
1518 webrtcNetAddr{dcc.Remote},
1520 fmt.Sprintf("webrtc offer_id %x", dcc.OfferId),
1523 t.logger.WithDefaultLevel(log.Error).Printf("error in handshaking webrtc connection: %v", err)
1526 if dcc.LocalOffered {
1527 pc.Discovery = PeerSourceTracker
1529 pc.Discovery = PeerSourceIncoming
1531 pc.conn.SetWriteDeadline(time.Time{})
1534 err = t.cl.runHandshookConn(pc, t)
1536 t.logger.WithDefaultLevel(log.Critical).Printf("error running handshook webrtc conn: %v", err)
1540 func (t *Torrent) logRunHandshookConn(pc *PeerConn, logAll bool, level log.Level) {
1541 err := t.cl.runHandshookConn(pc, t)
1542 if err != nil || logAll {
1543 t.logger.WithDefaultLevel(level).Printf("error running handshook conn: %v", err)
1547 func (t *Torrent) runHandshookConnLoggingErr(pc *PeerConn) {
1548 t.logRunHandshookConn(pc, false, log.Debug)
1551 func (t *Torrent) startWebsocketAnnouncer(u url.URL) torrentTrackerAnnouncer {
1552 wtc, release := t.cl.websocketTrackers.Get(u.String())
1557 wst := websocketTrackerStatus{u, wtc}
1559 err := wtc.Announce(tracker.Started, t.infoHash)
1561 t.logger.WithDefaultLevel(log.Warning).Printf(
1562 "error in initial announce to %q: %v",
1570 func (t *Torrent) startScrapingTracker(_url string) {
1574 u, err := url.Parse(_url)
1576 // URLs with a leading '*' appear to be a uTorrent convention to
1577 // disable trackers.
1579 log.Str("error parsing tracker url").AddValues("url", _url).Log(t.logger)
1583 if u.Scheme == "udp" {
1585 t.startScrapingTracker(u.String())
1587 t.startScrapingTracker(u.String())
1590 if _, ok := t.trackerAnnouncers[_url]; ok {
1593 sl := func() torrentTrackerAnnouncer {
1596 if t.cl.config.DisableWebtorrent {
1599 return t.startWebsocketAnnouncer(*u)
1601 if t.cl.config.DisableIPv4Peers || t.cl.config.DisableIPv4 {
1605 if t.cl.config.DisableIPv6 {
1609 newAnnouncer := &trackerScraper{
1612 lookupTrackerIp: t.cl.config.LookupTrackerIp,
1614 go newAnnouncer.Run()
1620 if t.trackerAnnouncers == nil {
1621 t.trackerAnnouncers = make(map[string]torrentTrackerAnnouncer)
1623 t.trackerAnnouncers[_url] = sl
1626 // Adds and starts tracker scrapers for tracker URLs that aren't already
1628 func (t *Torrent) startMissingTrackerScrapers() {
1629 if t.cl.config.DisableTrackers {
1632 t.startScrapingTracker(t.metainfo.Announce)
1633 for _, tier := range t.metainfo.AnnounceList {
1634 for _, url := range tier {
1635 t.startScrapingTracker(url)
1640 // Returns an AnnounceRequest with fields filled out to defaults and current
1642 func (t *Torrent) announceRequest(event tracker.AnnounceEvent) tracker.AnnounceRequest {
1643 // Note that IPAddress is not set. It's set for UDP inside the tracker code, since it's
1644 // dependent on the network in use.
1645 return tracker.AnnounceRequest{
1647 NumWant: func() int32 {
1648 if t.wantPeers() && len(t.cl.dialers) > 0 {
1654 Port: uint16(t.cl.incomingPeerPort()),
1655 PeerId: t.cl.peerID,
1656 InfoHash: t.infoHash,
1657 Key: t.cl.announceKey(),
1659 // The following are vaguely described in BEP 3.
1661 Left: t.bytesLeftAnnounce(),
1662 Uploaded: t.stats.BytesWrittenData.Int64(),
1663 // There's no mention of wasted or unwanted download in the BEP.
1664 Downloaded: t.stats.BytesReadUsefulData.Int64(),
1668 // Adds peers revealed in an announce until the announce ends, or we have
1670 func (t *Torrent) consumeDhtAnnouncePeers(pvs <-chan dht.PeersValues) {
1672 for v := range pvs {
1675 for _, cp := range v.Peers {
1677 // Can't do anything with this.
1680 if t.addPeer(PeerInfo{
1681 Addr: ipPortAddr{cp.IP, cp.Port},
1682 Source: PeerSourceDhtGetPeers,
1689 // log.Printf("added %v peers from dht for %v", added, t.InfoHash().HexString())
1694 // Announce using the provided DHT server. Peers are consumed automatically. done is closed when the
1695 // announce ends. stop will force the announce to end.
1696 func (t *Torrent) AnnounceToDht(s DhtServer) (done <-chan struct{}, stop func(), err error) {
1697 ps, err := s.Announce(t.infoHash, t.cl.incomingPeerPort(), true)
1701 _done := make(chan struct{})
1705 t.consumeDhtAnnouncePeers(ps.Peers())
1711 func (t *Torrent) timeboxedAnnounceToDht(s DhtServer) error {
1712 _, stop, err := t.AnnounceToDht(s)
1717 case <-t.closed.Done():
1718 case <-time.After(5 * time.Minute):
1724 func (t *Torrent) dhtAnnouncer(s DhtServer) {
1730 if t.closed.IsSet() {
1733 // We're also announcing ourselves as a listener, so we don't just want peer addresses.
1734 // TODO: We can include the announce_peer step depending on whether we can receive
1735 // inbound connections. We should probably only announce once every 15 mins too.
1739 // TODO: Determine if there's a listener on the port we're announcing.
1740 if len(cl.dialers) == 0 && len(cl.listeners) == 0 {
1751 err := t.timeboxedAnnounceToDht(s)
1753 t.logger.WithDefaultLevel(log.Warning).Printf("error announcing %q to DHT: %s", t, err)
1759 func (t *Torrent) addPeers(peers []PeerInfo) (added int) {
1760 for _, p := range peers {
1768 // The returned TorrentStats may require alignment in memory. See
1769 // https://github.com/anacrolix/torrent/issues/383.
1770 func (t *Torrent) Stats() TorrentStats {
1772 defer t.cl.rUnlock()
1773 return t.statsLocked()
1776 func (t *Torrent) statsLocked() (ret TorrentStats) {
1777 ret.ActivePeers = len(t.conns)
1778 ret.HalfOpenPeers = len(t.halfOpen)
1779 ret.PendingPeers = t.peers.Len()
1780 ret.TotalPeers = t.numTotalPeers()
1781 ret.ConnectedSeeders = 0
1782 for c := range t.conns {
1783 if all, ok := c.peerHasAllPieces(); all && ok {
1784 ret.ConnectedSeeders++
1787 ret.ConnStats = t.stats.Copy()
1788 ret.PiecesComplete = t.numPiecesCompleted()
1792 // The total number of peers in the torrent.
1793 func (t *Torrent) numTotalPeers() int {
1794 peers := make(map[string]struct{})
1795 for conn := range t.conns {
1796 ra := conn.conn.RemoteAddr()
1798 // It's been closed and doesn't support RemoteAddr.
1801 peers[ra.String()] = struct{}{}
1803 for addr := range t.halfOpen {
1804 peers[addr] = struct{}{}
1806 t.peers.Each(func(peer PeerInfo) {
1807 peers[peer.Addr.String()] = struct{}{}
1812 // Reconcile bytes transferred before connection was associated with a
1814 func (t *Torrent) reconcileHandshakeStats(c *PeerConn) {
1815 if c._stats != (ConnStats{
1816 // Handshakes should only increment these fields:
1817 BytesWritten: c._stats.BytesWritten,
1818 BytesRead: c._stats.BytesRead,
1822 c.postHandshakeStats(func(cs *ConnStats) {
1823 cs.BytesRead.Add(c._stats.BytesRead.Int64())
1824 cs.BytesWritten.Add(c._stats.BytesWritten.Int64())
1826 c.reconciledHandshakeStats = true
1829 // Returns true if the connection is added.
1830 func (t *Torrent) addPeerConn(c *PeerConn) (err error) {
1833 torrent.Add("added connections", 1)
1836 if t.closed.IsSet() {
1837 return errors.New("torrent closed")
1839 for c0 := range t.conns {
1840 if c.PeerID != c0.PeerID {
1843 if !t.cl.config.DropDuplicatePeerIds {
1846 if left, ok := c.hasPreferredNetworkOver(c0); ok && left {
1848 t.deletePeerConn(c0)
1850 return errors.New("existing connection preferred")
1853 if len(t.conns) >= t.maxEstablishedConns {
1854 c := t.worstBadConn()
1856 return errors.New("don't want conns")
1861 if len(t.conns) >= t.maxEstablishedConns {
1864 t.conns[c] = struct{}{}
1865 if !t.cl.config.DisablePEX && !c.PeerExtensionBytes.SupportsExtended() {
1866 t.pex.Add(c) // as no further extended handshake expected
1871 func (t *Torrent) wantConns() bool {
1872 if !t.networkingEnabled.Bool() {
1875 if t.closed.IsSet() {
1878 if !t.needData() && (!t.seeding() || !t.haveAnyPieces()) {
1881 return len(t.conns) < t.maxEstablishedConns || t.worstBadConn() != nil
1884 func (t *Torrent) SetMaxEstablishedConns(max int) (oldMax int) {
1887 oldMax = t.maxEstablishedConns
1888 t.maxEstablishedConns = max
1889 wcs := worseConnSlice{
1890 conns: t.appendConns(nil, func(*PeerConn) bool {
1896 for len(t.conns) > t.maxEstablishedConns && wcs.Len() > 0 {
1897 t.dropConnection(heap.Pop(&wcs).(*PeerConn))
1903 func (t *Torrent) pieceHashed(piece pieceIndex, passed bool, hashIoErr error) {
1904 t.logger.Log(log.Fstr("hashed piece %d (passed=%t)", piece, passed).SetLevel(log.Debug))
1907 t.cl.event.Broadcast()
1908 if t.closed.IsSet() {
1912 // Don't score the first time a piece is hashed, it could be an initial check.
1913 if p.storageCompletionOk {
1915 pieceHashedCorrect.Add(1)
1918 "piece %d failed hash: %d connections contributed", piece, len(p.dirtiers),
1919 ).AddValues(t, p).SetLevel(log.Debug).Log(t.logger)
1920 pieceHashedNotCorrect.Add(1)
1925 t.publishPieceChange(piece)
1928 t.publishPieceChange(piece)
1932 if len(p.dirtiers) != 0 {
1933 // Don't increment stats above connection-level for every involved connection.
1934 t.allStats((*ConnStats).incrementPiecesDirtiedGood)
1936 for c := range p.dirtiers {
1937 c._stats.incrementPiecesDirtiedGood()
1939 t.clearPieceTouchers(piece)
1941 err := p.Storage().MarkComplete()
1943 t.logger.Printf("%T: error marking piece complete %d: %s", t.storage, piece, err)
1947 if t.closed.IsSet() {
1950 t.pendAllChunkSpecs(piece)
1952 if len(p.dirtiers) != 0 && p.allChunksDirty() && hashIoErr == nil {
1953 // Peers contributed to all the data for this piece hash failure, and the failure was
1954 // not due to errors in the storage (such as data being dropped in a cache).
1956 // Increment Torrent and above stats, and then specific connections.
1957 t.allStats((*ConnStats).incrementPiecesDirtiedBad)
1958 for c := range p.dirtiers {
1959 // Y u do dis peer?!
1960 c.stats().incrementPiecesDirtiedBad()
1963 bannableTouchers := make([]*Peer, 0, len(p.dirtiers))
1964 for c := range p.dirtiers {
1966 bannableTouchers = append(bannableTouchers, c)
1969 t.clearPieceTouchers(piece)
1970 slices.Sort(bannableTouchers, connLessTrusted)
1972 if t.cl.config.Debug {
1974 "bannable conns by trust for piece %d: %v",
1976 func() (ret []connectionTrust) {
1977 for _, c := range bannableTouchers {
1978 ret = append(ret, c.trust())
1985 if len(bannableTouchers) >= 1 {
1986 c := bannableTouchers[0]
1987 t.cl.banPeerIP(c.remoteIp())
1991 t.onIncompletePiece(piece)
1992 p.Storage().MarkNotComplete()
1994 t.updatePieceCompletion(piece)
1997 func (t *Torrent) cancelRequestsForPiece(piece pieceIndex) {
1998 for ri := t.pieceRequestIndexOffset(piece); ri < t.pieceRequestIndexOffset(piece+1); ri++ {
2003 func (t *Torrent) onPieceCompleted(piece pieceIndex) {
2004 t.pendAllChunkSpecs(piece)
2005 t.cancelRequestsForPiece(piece)
2006 t.piece(piece).readerCond.Broadcast()
2007 for conn := range t.conns {
2009 t.maybeDropMutuallyCompletePeer(&conn.Peer)
2013 // Called when a piece is found to be not complete.
2014 func (t *Torrent) onIncompletePiece(piece pieceIndex) {
2015 if t.pieceAllDirty(piece) {
2016 t.pendAllChunkSpecs(piece)
2018 if !t.wantPieceIndex(piece) {
2019 // t.logger.Printf("piece %d incomplete and unwanted", piece)
2022 // We could drop any connections that we told we have a piece that we
2023 // don't here. But there's a test failure, and it seems clients don't care
2024 // if you request pieces that you already claim to have. Pruning bad
2025 // connections might just remove any connections that aren't treating us
2026 // favourably anyway.
2028 // for c := range t.conns {
2029 // if c.sentHave(piece) {
2033 t.iterPeers(func(conn *Peer) {
2034 if conn.peerHasPiece(piece) {
2035 conn.updateRequests("piece incomplete")
2040 func (t *Torrent) tryCreateMorePieceHashers() {
2041 for !t.closed.IsSet() && t.activePieceHashes < 2 && t.tryCreatePieceHasher() {
2045 func (t *Torrent) tryCreatePieceHasher() bool {
2046 if t.storage == nil {
2049 pi, ok := t.getPieceToHash()
2054 t.piecesQueuedForHash.Remove(bitmap.BitIndex(pi))
2056 t.publishPieceChange(pi)
2057 t.updatePiecePriority(pi, "Torrent.tryCreatePieceHasher")
2058 t.storageLock.RLock()
2059 t.activePieceHashes++
2060 go t.pieceHasher(pi)
2064 func (t *Torrent) getPieceToHash() (ret pieceIndex, ok bool) {
2065 t.piecesQueuedForHash.IterTyped(func(i pieceIndex) bool {
2066 if t.piece(i).hashing {
2076 func (t *Torrent) pieceHasher(index pieceIndex) {
2078 sum, copyErr := t.hashPiece(index)
2079 correct := sum == *p.hash
2083 log.Fmsg("piece %v (%s) hash failure copy error: %v", p, p.hash.HexString(), copyErr).Log(t.logger)
2085 t.storageLock.RUnlock()
2089 t.pieceHashed(index, correct, copyErr)
2090 t.updatePiecePriority(index, "Torrent.pieceHasher")
2091 t.activePieceHashes--
2092 t.tryCreateMorePieceHashers()
2095 // Return the connections that touched a piece, and clear the entries while doing it.
2096 func (t *Torrent) clearPieceTouchers(pi pieceIndex) {
2098 for c := range p.dirtiers {
2099 delete(c.peerTouchedPieces, pi)
2100 delete(p.dirtiers, c)
2104 func (t *Torrent) peersAsSlice() (ret []*Peer) {
2105 t.iterPeers(func(p *Peer) {
2106 ret = append(ret, p)
2111 func (t *Torrent) queuePieceCheck(pieceIndex pieceIndex) {
2112 piece := t.piece(pieceIndex)
2113 if piece.queuedForHash() {
2116 t.piecesQueuedForHash.Add(bitmap.BitIndex(pieceIndex))
2117 t.publishPieceChange(pieceIndex)
2118 t.updatePiecePriority(pieceIndex, "Torrent.queuePieceCheck")
2119 t.tryCreateMorePieceHashers()
2122 // Forces all the pieces to be re-hashed. See also Piece.VerifyData. This should not be called
2123 // before the Info is available.
2124 func (t *Torrent) VerifyData() {
2125 for i := pieceIndex(0); i < t.NumPieces(); i++ {
2126 t.Piece(i).VerifyData()
2130 // Start the process of connecting to the given peer for the given torrent if appropriate.
2131 func (t *Torrent) initiateConn(peer PeerInfo) {
2132 if peer.Id == t.cl.peerID {
2135 if t.cl.badPeerAddr(peer.Addr) && !peer.Trusted {
2139 if t.addrActive(addr.String()) {
2143 t.halfOpen[addr.String()] = peer
2144 go t.cl.outgoingConnection(t, addr, peer.Source, peer.Trusted)
2147 // Adds a trusted, pending peer for each of the given Client's addresses. Typically used in tests to
2148 // quickly make one Client visible to the Torrent of another Client.
2149 func (t *Torrent) AddClientPeer(cl *Client) int {
2150 return t.AddPeers(func() (ps []PeerInfo) {
2151 for _, la := range cl.ListenAddrs() {
2152 ps = append(ps, PeerInfo{
2161 // All stats that include this Torrent. Useful when we want to increment ConnStats but not for every
2163 func (t *Torrent) allStats(f func(*ConnStats)) {
2168 func (t *Torrent) hashingPiece(i pieceIndex) bool {
2169 return t.pieces[i].hashing
2172 func (t *Torrent) pieceQueuedForHash(i pieceIndex) bool {
2173 return t.piecesQueuedForHash.Get(bitmap.BitIndex(i))
2176 func (t *Torrent) dialTimeout() time.Duration {
2177 return reducedDialTimeout(t.cl.config.MinDialTimeout, t.cl.config.NominalDialTimeout, t.cl.config.HalfOpenConnsPerTorrent, t.peers.Len())
2180 func (t *Torrent) piece(i int) *Piece {
2184 func (t *Torrent) onWriteChunkErr(err error) {
2185 if t.userOnWriteChunkErr != nil {
2186 go t.userOnWriteChunkErr(err)
2189 t.logger.WithDefaultLevel(log.Critical).Printf("default chunk write error handler: disabling data download")
2190 t.disallowDataDownloadLocked()
2193 func (t *Torrent) DisallowDataDownload() {
2194 t.disallowDataDownloadLocked()
2197 func (t *Torrent) disallowDataDownloadLocked() {
2198 t.dataDownloadDisallowed.Set()
2201 func (t *Torrent) AllowDataDownload() {
2202 t.dataDownloadDisallowed.Clear()
2205 // Enables uploading data, if it was disabled.
2206 func (t *Torrent) AllowDataUpload() {
2209 t.dataUploadDisallowed = false
2210 for c := range t.conns {
2211 c.updateRequests("allow data upload")
2215 // Disables uploading data, if it was enabled.
2216 func (t *Torrent) DisallowDataUpload() {
2219 t.dataUploadDisallowed = true
2220 for c := range t.conns {
2221 c.updateRequests("disallow data upload")
2225 // Sets a handler that is called if there's an error writing a chunk to local storage. By default,
2226 // or if nil, a critical message is logged, and data download is disabled.
2227 func (t *Torrent) SetOnWriteChunkError(f func(error)) {
2230 t.userOnWriteChunkErr = f
2233 func (t *Torrent) iterPeers(f func(p *Peer)) {
2234 for pc := range t.conns {
2237 for _, ws := range t.webSeeds {
2242 func (t *Torrent) callbacks() *Callbacks {
2243 return &t.cl.config.Callbacks
2246 func (t *Torrent) addWebSeed(url string) {
2247 if t.cl.config.DisableWebseeds {
2250 if _, ok := t.webSeeds[url]; ok {
2253 // I don't think Go http supports pipelining requests. However, we can have more ready to go
2254 // right away. This value should be some multiple of the number of connections to a host. I
2255 // would expect that double maxRequests plus a bit would be appropriate. This value is based on
2256 // downloading Sintel (08ada5a7a6183aae1e09d831df6748d566095a10) from
2257 // "https://webtorrent.io/torrents/".
2258 const maxRequests = 16
2264 reconciledHandshakeStats: true,
2265 // This should affect how often we have to recompute requests for this peer. Note that
2266 // because we can request more than 1 thing at a time over HTTP, we will hit the low
2267 // requests mark more often, so recomputation is probably sooner than with regular peer
2268 // conns. ~4x maxRequests would be about right.
2269 PeerMaxRequests: 128,
2270 RemoteAddr: remoteAddrFromUrl(url),
2271 callbacks: t.callbacks(),
2273 client: webseed.Client{
2274 HttpClient: t.cl.webseedHttpClient,
2277 activeRequests: make(map[Request]webseed.Request, maxRequests),
2278 maxRequests: maxRequests,
2280 ws.peer.initUpdateRequestsTimer()
2281 ws.requesterCond.L = t.cl.locker()
2282 for i := 0; i < maxRequests; i += 1 {
2285 for _, f := range t.callbacks().NewPeer {
2288 ws.peer.logger = t.logger.WithContextValue(&ws)
2289 ws.peer.peerImpl = &ws
2291 ws.onGotInfo(t.info)
2293 t.webSeeds[url] = &ws.peer
2296 func (t *Torrent) peerIsActive(p *Peer) (active bool) {
2297 t.iterPeers(func(p1 *Peer) {
2305 func (t *Torrent) requestIndexToRequest(ri RequestIndex) Request {
2306 index := ri / t.chunksPerRegularPiece()
2309 t.piece(int(index)).chunkIndexSpec(ri % t.chunksPerRegularPiece()),
2313 func (t *Torrent) requestIndexFromRequest(r Request) RequestIndex {
2314 return t.pieceRequestIndexOffset(pieceIndex(r.Index)) + uint32(r.Begin/t.chunkSize)
2317 func (t *Torrent) pieceRequestIndexOffset(piece pieceIndex) RequestIndex {
2318 return RequestIndex(piece) * t.chunksPerRegularPiece()
2321 func (t *Torrent) updateComplete() {
2322 t.Complete.SetBool(t.haveAllPieces())
2325 func (t *Torrent) cancelRequest(r RequestIndex) *Peer {
2326 p := t.pendingRequests[r]
2330 delete(t.pendingRequests, r)
2334 func (t *Torrent) requestingPeer(r RequestIndex) *Peer {
2335 return t.pendingRequests[r]
2338 func (t *Torrent) addConnWithAllPieces(p *Peer) {
2339 if t.connsWithAllPieces == nil {
2340 t.connsWithAllPieces = make(map[*Peer]struct{}, t.maxEstablishedConns)
2342 t.connsWithAllPieces[p] = struct{}{}
2345 func (t *Torrent) deleteConnWithAllPieces(p *Peer) bool {
2346 _, ok := t.connsWithAllPieces[p]
2347 delete(t.connsWithAllPieces, p)
2351 func (t *Torrent) numActivePeers() int {
2352 return len(t.conns) + len(t.webSeeds)