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
89 // Active peer connections, running message stream loops. TODO: Make this
90 // open (not-closed) connections only.
91 conns map[*PeerConn]struct{}
92 maxEstablishedConns int
93 // Set of addrs to which we're attempting to connect. Connections are
94 // half-open until all handshakes are completed.
95 halfOpen map[string]PeerInfo
97 // Reserve of peers to connect to. A peer can be both here and in the
98 // active connections if were told about the peer after connecting with
99 // them. That encourages us to reconnect to peers that are well known in
101 peers prioritizedPeers
102 // Whether we want to know to know more peers.
103 wantPeersEvent missinggo.Event
104 // An announcer for each tracker URL.
105 trackerAnnouncers map[string]torrentTrackerAnnouncer
106 // How many times we've initiated a DHT announce. TODO: Move into stats.
109 // Name used if the info name isn't available. Should be cleared when the
110 // Info does become available.
114 // The bencoded bytes of the info dict. This is actively manipulated if
115 // the info bytes aren't initially available, and we try to fetch them
118 // Each element corresponds to the 16KiB metadata pieces. If true, we have
119 // received that piece.
120 metadataCompletedChunks []bool
121 metadataChanged sync.Cond
123 // Closed when .Info is obtained.
124 gotMetainfoC chan struct{}
126 readers map[*reader]struct{}
127 _readerNowPieces bitmap.Bitmap
128 _readerReadaheadPieces bitmap.Bitmap
130 // A cache of pieces we need to get. Calculated from various piece and
131 // file priorities and completion states elsewhere.
132 _pendingPieces roaring.Bitmap
133 // A cache of completed piece indices.
134 _completedPieces roaring.Bitmap
135 // Pieces that need to be hashed.
136 piecesQueuedForHash bitmap.Bitmap
137 activePieceHashes int
138 initialPieceCheckDisabled bool
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) pieceAvailabilityFromPeers(i pieceIndex) (count int) {
153 t.iterPeers(func(peer *Peer) {
154 if peer.peerHasPiece(i) {
161 func (t *Torrent) decPieceAvailability(i pieceIndex) {
166 if p.availability <= 0 {
167 panic(p.availability)
170 t.updatePieceRequestOrder(i)
173 func (t *Torrent) incPieceAvailability(i pieceIndex) {
174 // If we don't the info, this should be reconciled when we do.
178 t.updatePieceRequestOrder(i)
182 func (t *Torrent) readerNowPieces() bitmap.Bitmap {
183 return t._readerNowPieces
186 func (t *Torrent) readerReadaheadPieces() bitmap.Bitmap {
187 return t._readerReadaheadPieces
190 func (t *Torrent) ignorePieceForRequests(i pieceIndex) bool {
191 return !t.wantPieceIndex(i)
194 // Returns a channel that is closed when the Torrent is closed.
195 func (t *Torrent) Closed() events.Done {
196 return t.closed.Done()
199 // KnownSwarm returns the known subset of the peers in the Torrent's swarm, including active,
200 // pending, and half-open peers.
201 func (t *Torrent) KnownSwarm() (ks []PeerInfo) {
202 // Add pending peers to the list
203 t.peers.Each(func(peer PeerInfo) {
204 ks = append(ks, peer)
207 // Add half-open peers to the list
208 for _, peer := range t.halfOpen {
209 ks = append(ks, peer)
212 // Add active peers to the list
213 for conn := range t.conns {
214 ks = append(ks, PeerInfo{
216 Addr: conn.RemoteAddr,
217 Source: conn.Discovery,
218 // > If the connection is encrypted, that's certainly enough to set SupportsEncryption.
219 // > But if we're not connected to them with an encrypted connection, I couldn't say
220 // > what's appropriate. We can carry forward the SupportsEncryption value as we
221 // > received it from trackers/DHT/PEX, or just use the encryption state for the
222 // > connection. It's probably easiest to do the latter for now.
223 // https://github.com/anacrolix/torrent/pull/188
224 SupportsEncryption: conn.headerEncrypted,
231 func (t *Torrent) setChunkSize(size pp.Integer) {
233 t.chunkPool = sync.Pool{
234 New: func() interface{} {
235 b := make([]byte, size)
241 func (t *Torrent) pieceComplete(piece pieceIndex) bool {
242 return t._completedPieces.Contains(bitmap.BitIndex(piece))
245 func (t *Torrent) pieceCompleteUncached(piece pieceIndex) storage.Completion {
246 if t.storage == nil {
247 return storage.Completion{Complete: false, Ok: true}
249 return t.pieces[piece].Storage().Completion()
252 // There's a connection to that address already.
253 func (t *Torrent) addrActive(addr string) bool {
254 if _, ok := t.halfOpen[addr]; ok {
257 for c := range t.conns {
259 if ra.String() == addr {
266 func (t *Torrent) appendUnclosedConns(ret []*PeerConn) []*PeerConn {
267 return t.appendConns(ret, func(conn *PeerConn) bool {
268 return !conn.closed.IsSet()
272 func (t *Torrent) appendConns(ret []*PeerConn, f func(*PeerConn) bool) []*PeerConn {
273 for c := range t.conns {
281 func (t *Torrent) addPeer(p PeerInfo) (added bool) {
283 torrent.Add(fmt.Sprintf("peers added by source %q", p.Source), 1)
284 if t.closed.IsSet() {
287 if ipAddr, ok := tryIpPortFromNetAddr(p.Addr); ok {
288 if cl.badPeerIPPort(ipAddr.IP, ipAddr.Port) {
289 torrent.Add("peers not added because of bad addr", 1)
290 // cl.logger.Printf("peers not added because of bad addr: %v", p)
294 if replaced, ok := t.peers.AddReturningReplacedPeer(p); ok {
295 torrent.Add("peers replaced", 1)
296 if !replaced.equal(p) {
297 t.logger.WithDefaultLevel(log.Debug).Printf("added %v replacing %v", p, replaced)
304 for t.peers.Len() > cl.config.TorrentPeersHighWater {
305 _, ok := t.peers.DeleteMin()
307 torrent.Add("excess reserve peers discarded", 1)
313 func (t *Torrent) invalidateMetadata() {
314 for i := 0; i < len(t.metadataCompletedChunks); i++ {
315 t.metadataCompletedChunks[i] = false
318 t.gotMetainfoC = make(chan struct{})
323 func (t *Torrent) saveMetadataPiece(index int, data []byte) {
327 if index >= len(t.metadataCompletedChunks) {
328 t.logger.Printf("%s: ignoring metadata piece %d", t, index)
331 copy(t.metadataBytes[(1<<14)*index:], data)
332 t.metadataCompletedChunks[index] = true
335 func (t *Torrent) metadataPieceCount() int {
336 return (len(t.metadataBytes) + (1 << 14) - 1) / (1 << 14)
339 func (t *Torrent) haveMetadataPiece(piece int) bool {
341 return (1<<14)*piece < len(t.metadataBytes)
343 return piece < len(t.metadataCompletedChunks) && t.metadataCompletedChunks[piece]
347 func (t *Torrent) metadataSize() int {
348 return len(t.metadataBytes)
351 func infoPieceHashes(info *metainfo.Info) (ret [][]byte) {
352 for i := 0; i < len(info.Pieces); i += sha1.Size {
353 ret = append(ret, info.Pieces[i:i+sha1.Size])
358 func (t *Torrent) makePieces() {
359 hashes := infoPieceHashes(t.info)
360 t.pieces = make([]Piece, len(hashes))
361 for i, hash := range hashes {
362 piece := &t.pieces[i]
364 piece.index = pieceIndex(i)
365 piece.noPendingWrites.L = &piece.pendingWritesMutex
366 piece.hash = (*metainfo.Hash)(unsafe.Pointer(&hash[0]))
368 beginFile := pieceFirstFileIndex(piece.torrentBeginOffset(), files)
369 endFile := pieceEndFileIndex(piece.torrentEndOffset(), files)
370 piece.files = files[beginFile:endFile]
371 piece.undirtiedChunksIter = undirtiedChunksIter{
372 TorrentDirtyChunks: &t.dirtyChunks,
373 StartRequestIndex: piece.requestIndexOffset(),
374 EndRequestIndex: piece.requestIndexOffset() + piece.numChunks(),
379 // Returns the index of the first file containing the piece. files must be
380 // ordered by offset.
381 func pieceFirstFileIndex(pieceOffset int64, files []*File) int {
382 for i, f := range files {
383 if f.offset+f.length > pieceOffset {
390 // Returns the index after the last file containing the piece. files must be
391 // ordered by offset.
392 func pieceEndFileIndex(pieceEndOffset int64, files []*File) int {
393 for i, f := range files {
394 if f.offset+f.length >= pieceEndOffset {
401 func (t *Torrent) cacheLength() {
403 for _, f := range t.info.UpvertedFiles() {
409 // TODO: This shouldn't fail for storage reasons. Instead we should handle storage failure
411 func (t *Torrent) setInfo(info *metainfo.Info) error {
412 if err := validateInfo(info); err != nil {
413 return fmt.Errorf("bad info: %s", err)
415 if t.storageOpener != nil {
417 t.storage, err = t.storageOpener.OpenTorrent(info, t.infoHash)
419 return fmt.Errorf("error opening torrent storage: %s", err)
426 t.fileIndex = segments.NewIndex(common.LengthIterFromUpvertedFiles(info.UpvertedFiles()))
427 t.displayName = "" // Save a few bytes lol.
434 func (t *Torrent) pieceRequestOrderKey(i int) request_strategy.PieceRequestOrderKey {
435 return request_strategy.PieceRequestOrderKey{
436 InfoHash: t.infoHash,
441 // This seems to be all the follow-up tasks after info is set, that can't fail.
442 func (t *Torrent) onSetInfo() {
443 t.initPieceRequestOrder()
444 for i := range t.pieces {
446 // Need to add availability before updating piece completion, as that may result in conns
448 if p.availability != 0 {
449 panic(p.availability)
451 p.availability = int64(t.pieceAvailabilityFromPeers(i))
452 t.addRequestOrderPiece(i)
453 t.updatePieceCompletion(pieceIndex(i))
454 if !t.initialPieceCheckDisabled && !p.storageCompletionOk {
455 // t.logger.Printf("piece %s completion unknown, queueing check", p)
456 t.queuePieceCheck(pieceIndex(i))
459 t.cl.event.Broadcast()
460 close(t.gotMetainfoC)
461 t.updateWantPeersEvent()
462 t.pendingRequests = make(map[RequestIndex]*Peer)
463 t.lastRequested = make(map[RequestIndex]time.Time)
464 t.tryCreateMorePieceHashers()
465 t.iterPeers(func(p *Peer) {
467 p.updateRequests("onSetInfo")
471 // Called when metadata for a torrent becomes available.
472 func (t *Torrent) setInfoBytesLocked(b []byte) error {
473 if metainfo.HashBytes(b) != t.infoHash {
474 return errors.New("info bytes have wrong hash")
476 var info metainfo.Info
477 if err := bencode.Unmarshal(b, &info); err != nil {
478 return fmt.Errorf("error unmarshalling info bytes: %s", err)
481 t.metadataCompletedChunks = nil
485 if err := t.setInfo(&info); err != nil {
492 func (t *Torrent) haveAllMetadataPieces() bool {
496 if t.metadataCompletedChunks == nil {
499 for _, have := range t.metadataCompletedChunks {
507 // TODO: Propagate errors to disconnect peer.
508 func (t *Torrent) setMetadataSize(size int) (err error) {
510 // We already know the correct metadata size.
513 if uint32(size) > maxMetadataSize {
514 return errors.New("bad size")
516 if len(t.metadataBytes) == size {
519 t.metadataBytes = make([]byte, size)
520 t.metadataCompletedChunks = make([]bool, (size+(1<<14)-1)/(1<<14))
521 t.metadataChanged.Broadcast()
522 for c := range t.conns {
523 c.requestPendingMetadata()
528 // The current working name for the torrent. Either the name in the info dict,
529 // or a display name given such as by the dn value in a magnet link, or "".
530 func (t *Torrent) name() string {
532 defer t.nameMu.RUnlock()
536 if t.displayName != "" {
539 return "infohash:" + t.infoHash.HexString()
542 func (t *Torrent) pieceState(index pieceIndex) (ret PieceState) {
543 p := &t.pieces[index]
544 ret.Priority = t.piecePriority(index)
545 ret.Completion = p.completion()
546 ret.QueuedForHash = p.queuedForHash()
547 ret.Hashing = p.hashing
548 ret.Checking = ret.QueuedForHash || ret.Hashing
549 ret.Marking = p.marking
550 if !ret.Complete && t.piecePartiallyDownloaded(index) {
556 func (t *Torrent) metadataPieceSize(piece int) int {
557 return metadataPieceSize(len(t.metadataBytes), piece)
560 func (t *Torrent) newMetadataExtensionMessage(c *PeerConn, msgType pp.ExtendedMetadataRequestMsgType, piece int, data []byte) pp.Message {
563 ExtendedID: c.PeerExtensionIDs[pp.ExtensionNameMetadata],
564 ExtendedPayload: append(bencode.MustMarshal(pp.ExtendedMetadataRequestMsg{
566 TotalSize: len(t.metadataBytes),
572 type pieceAvailabilityRun struct {
577 func (me pieceAvailabilityRun) String() string {
578 return fmt.Sprintf("%v(%v)", me.count, me.availability)
581 func (t *Torrent) pieceAvailabilityRuns() (ret []pieceAvailabilityRun) {
582 rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
583 ret = append(ret, pieceAvailabilityRun{availability: el.(int64), count: int(count)})
585 for i := range t.pieces {
586 rle.Append(t.pieces[i].availability, 1)
592 func (t *Torrent) pieceStateRuns() (ret PieceStateRuns) {
593 rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
594 ret = append(ret, PieceStateRun{
595 PieceState: el.(PieceState),
599 for index := range t.pieces {
600 rle.Append(t.pieceState(pieceIndex(index)), 1)
606 // Produces a small string representing a PieceStateRun.
607 func (psr PieceStateRun) String() (ret string) {
608 ret = fmt.Sprintf("%d", psr.Length)
609 ret += func() string {
610 switch psr.Priority {
611 case PiecePriorityNext:
613 case PiecePriorityNormal:
615 case PiecePriorityReadahead:
617 case PiecePriorityNow:
619 case PiecePriorityHigh:
628 if psr.QueuedForHash {
646 func (t *Torrent) writeStatus(w io.Writer) {
647 fmt.Fprintf(w, "Infohash: %s\n", t.infoHash.HexString())
648 fmt.Fprintf(w, "Metadata length: %d\n", t.metadataSize())
650 fmt.Fprintf(w, "Metadata have: ")
651 for _, h := range t.metadataCompletedChunks {
652 fmt.Fprintf(w, "%c", func() rune {
662 fmt.Fprintf(w, "Piece length: %s\n",
665 return fmt.Sprintf("%v (%v chunks)",
667 float64(t.usualPieceSize())/float64(t.chunkSize))
674 fmt.Fprintf(w, "Num Pieces: %d (%d completed)\n", t.numPieces(), t.numPiecesCompleted())
675 fmt.Fprintf(w, "Piece States: %s\n", t.pieceStateRuns())
676 fmt.Fprintf(w, "Piece availability: %v\n", strings.Join(func() (ret []string) {
677 for _, run := range t.pieceAvailabilityRuns() {
678 ret = append(ret, run.String())
683 fmt.Fprintf(w, "Reader Pieces:")
684 t.forReaderOffsetPieces(func(begin, end pieceIndex) (again bool) {
685 fmt.Fprintf(w, " %d:%d", begin, end)
690 fmt.Fprintf(w, "Enabled trackers:\n")
692 tw := tabwriter.NewWriter(w, 0, 0, 2, ' ', 0)
693 fmt.Fprintf(tw, " URL\tExtra\n")
694 for _, ta := range slices.Sort(slices.FromMapElems(t.trackerAnnouncers), func(l, r torrentTrackerAnnouncer) bool {
697 var luns, runs url.URL = *lu, *ru
700 var ml missinggo.MultiLess
701 ml.StrictNext(luns.String() == runs.String(), luns.String() < runs.String())
702 ml.StrictNext(lu.String() == ru.String(), lu.String() < ru.String())
704 }).([]torrentTrackerAnnouncer) {
705 fmt.Fprintf(tw, " %q\t%v\n", ta.URL(), ta.statusLine())
710 fmt.Fprintf(w, "DHT Announces: %d\n", t.numDHTAnnounces)
712 spew.NewDefaultConfig()
713 spew.Fdump(w, t.statsLocked())
715 peers := t.peersAsSlice()
716 sort.Slice(peers, func(_i, _j int) bool {
719 if less, ok := multiless.New().EagerSameLess(
720 i.downloadRate() == j.downloadRate(), i.downloadRate() < j.downloadRate(),
724 return worseConn(i, j)
726 for i, c := range peers {
727 fmt.Fprintf(w, "%2d. ", i+1)
732 func (t *Torrent) haveInfo() bool {
736 // Returns a run-time generated MetaInfo that includes the info bytes and
737 // announce-list as currently known to the client.
738 func (t *Torrent) newMetaInfo() metainfo.MetaInfo {
739 return metainfo.MetaInfo{
740 CreationDate: time.Now().Unix(),
741 Comment: "dynamic metainfo from client",
742 CreatedBy: "go.torrent",
743 AnnounceList: t.metainfo.UpvertedAnnounceList().Clone(),
744 InfoBytes: func() []byte {
746 return t.metadataBytes
751 UrlList: func() []string {
752 ret := make([]string, 0, len(t.webSeeds))
753 for url := range t.webSeeds {
754 ret = append(ret, url)
762 func (t *Torrent) BytesMissing() (n int64) {
764 n = t.bytesMissingLocked()
769 func (t *Torrent) bytesMissingLocked() int64 {
773 func iterFlipped(b *roaring.Bitmap, end uint64, cb func(uint32) bool) {
774 roaring.Flip(b, 0, end).Iterate(cb)
777 func (t *Torrent) bytesLeft() (left int64) {
778 iterFlipped(&t._completedPieces, uint64(t.numPieces()), func(x uint32) bool {
779 p := t.piece(pieceIndex(x))
780 left += int64(p.length() - p.numDirtyBytes())
786 // Bytes left to give in tracker announces.
787 func (t *Torrent) bytesLeftAnnounce() int64 {
795 func (t *Torrent) piecePartiallyDownloaded(piece pieceIndex) bool {
796 if t.pieceComplete(piece) {
799 if t.pieceAllDirty(piece) {
802 return t.pieces[piece].hasDirtyChunks()
805 func (t *Torrent) usualPieceSize() int {
806 return int(t.info.PieceLength)
809 func (t *Torrent) numPieces() pieceIndex {
810 return pieceIndex(t.info.NumPieces())
813 func (t *Torrent) numPiecesCompleted() (num pieceIndex) {
814 return pieceIndex(t._completedPieces.GetCardinality())
817 func (t *Torrent) close(wg *sync.WaitGroup) (err error) {
819 if t.storage != nil {
824 defer t.storageLock.Unlock()
825 if f := t.storage.Close; f != nil {
828 t.logger.WithDefaultLevel(log.Warning).Printf("error closing storage: %v", err1)
833 t.iterPeers(func(p *Peer) {
836 if t.storage != nil {
837 t.deletePieceRequestOrder()
840 t.cl.event.Broadcast()
841 t.pieceStateChanges.Close()
842 t.updateWantPeersEvent()
846 func (t *Torrent) requestOffset(r Request) int64 {
847 return torrentRequestOffset(*t.length, int64(t.usualPieceSize()), r)
850 // Return the request that would include the given offset into the torrent data. Returns !ok if
851 // there is no such request.
852 func (t *Torrent) offsetRequest(off int64) (req Request, ok bool) {
853 return torrentOffsetRequest(*t.length, t.info.PieceLength, int64(t.chunkSize), off)
856 func (t *Torrent) writeChunk(piece int, begin int64, data []byte) (err error) {
857 defer perf.ScopeTimerErr(&err)()
858 n, err := t.pieces[piece].Storage().WriteAt(data, begin)
859 if err == nil && n != len(data) {
860 err = io.ErrShortWrite
865 func (t *Torrent) bitfield() (bf []bool) {
866 bf = make([]bool, t.numPieces())
867 t._completedPieces.Iterate(func(piece uint32) (again bool) {
874 func (t *Torrent) pieceNumChunks(piece pieceIndex) chunkIndexType {
875 return chunkIndexType((t.pieceLength(piece) + t.chunkSize - 1) / t.chunkSize)
878 func (t *Torrent) chunksPerRegularPiece() uint32 {
879 return uint32((pp.Integer(t.usualPieceSize()) + t.chunkSize - 1) / t.chunkSize)
882 func (t *Torrent) numRequests() RequestIndex {
883 if t.numPieces() == 0 {
886 return uint32(t.numPieces()-1)*t.chunksPerRegularPiece() + t.pieceNumChunks(t.numPieces()-1)
889 func (t *Torrent) pendAllChunkSpecs(pieceIndex pieceIndex) {
890 t.dirtyChunks.RemoveRange(
891 uint64(t.pieceRequestIndexOffset(pieceIndex)),
892 uint64(t.pieceRequestIndexOffset(pieceIndex+1)))
895 func (t *Torrent) pieceLength(piece pieceIndex) pp.Integer {
896 if t.info.PieceLength == 0 {
897 // There will be no variance amongst pieces. Only pain.
900 if piece == t.numPieces()-1 {
901 ret := pp.Integer(*t.length % t.info.PieceLength)
906 return pp.Integer(t.info.PieceLength)
909 func (t *Torrent) hashPiece(piece pieceIndex) (ret metainfo.Hash, err error) {
911 p.waitNoPendingWrites()
912 storagePiece := t.pieces[piece].Storage()
914 // Does the backend want to do its own hashing?
915 if i, ok := storagePiece.PieceImpl.(storage.SelfHashing); ok {
916 var sum metainfo.Hash
917 // log.Printf("A piece decided to self-hash: %d", piece)
918 sum, err = i.SelfHash()
919 missinggo.CopyExact(&ret, sum)
923 hash := pieceHash.New()
924 const logPieceContents = false
925 if logPieceContents {
926 var examineBuf bytes.Buffer
927 _, err = storagePiece.WriteTo(io.MultiWriter(hash, &examineBuf))
928 log.Printf("hashed %q with copy err %v", examineBuf.Bytes(), err)
930 _, err = storagePiece.WriteTo(hash)
932 missinggo.CopyExact(&ret, hash.Sum(nil))
936 func (t *Torrent) haveAnyPieces() bool {
937 return !t._completedPieces.IsEmpty()
940 func (t *Torrent) haveAllPieces() bool {
944 return t._completedPieces.GetCardinality() == bitmap.BitRange(t.numPieces())
947 func (t *Torrent) havePiece(index pieceIndex) bool {
948 return t.haveInfo() && t.pieceComplete(index)
951 func (t *Torrent) maybeDropMutuallyCompletePeer(
952 // I'm not sure about taking peer here, not all peer implementations actually drop. Maybe that's
956 if !t.cl.config.DropMutuallyCompletePeers {
959 if !t.haveAllPieces() {
962 if all, known := p.peerHasAllPieces(); !(known && all) {
968 t.logger.WithDefaultLevel(log.Debug).Printf("dropping %v, which is mutually complete", p)
972 func (t *Torrent) haveChunk(r Request) (ret bool) {
974 // log.Println("have chunk", r, ret)
979 if t.pieceComplete(pieceIndex(r.Index)) {
982 p := &t.pieces[r.Index]
983 return !p.pendingChunk(r.ChunkSpec, t.chunkSize)
986 func chunkIndexFromChunkSpec(cs ChunkSpec, chunkSize pp.Integer) chunkIndexType {
987 return chunkIndexType(cs.Begin / chunkSize)
990 func (t *Torrent) wantPieceIndex(index pieceIndex) bool {
991 return t._pendingPieces.Contains(uint32(index))
994 // A pool of []*PeerConn, to reduce allocations in functions that need to index or sort Torrent
995 // conns (which is a map).
996 var peerConnSlices sync.Pool
998 func getPeerConnSlice(cap int) []*PeerConn {
999 getInterface := peerConnSlices.Get()
1000 if getInterface == nil {
1001 return make([]*PeerConn, 0, cap)
1003 return getInterface.([]*PeerConn)[:0]
1007 // The worst connection is one that hasn't been sent, or sent anything useful for the longest. A bad
1008 // connection is one that usually sends us unwanted pieces, or has been in the worse half of the
1009 // established connections for more than a minute. This is O(n log n). If there was a way to not
1010 // consider the position of a conn relative to the total number, it could be reduced to O(n).
1011 func (t *Torrent) worstBadConn() (ret *PeerConn) {
1012 wcs := worseConnSlice{conns: t.appendUnclosedConns(getPeerConnSlice(len(t.conns)))}
1013 defer peerConnSlices.Put(wcs.conns)
1016 for wcs.Len() != 0 {
1017 c := heap.Pop(&wcs).(*PeerConn)
1018 if c._stats.ChunksReadWasted.Int64() >= 6 && c._stats.ChunksReadWasted.Int64() > c._stats.ChunksReadUseful.Int64() {
1021 // If the connection is in the worst half of the established
1022 // connection quota and is older than a minute.
1023 if wcs.Len() >= (t.maxEstablishedConns+1)/2 {
1024 // Give connections 1 minute to prove themselves.
1025 if time.Since(c.completedHandshake) > time.Minute {
1033 type PieceStateChange struct {
1038 func (t *Torrent) publishPieceChange(piece pieceIndex) {
1039 t.cl._mu.Defer(func() {
1040 cur := t.pieceState(piece)
1041 p := &t.pieces[piece]
1042 if cur != p.publicPieceState {
1043 p.publicPieceState = cur
1044 t.pieceStateChanges.Publish(PieceStateChange{
1052 func (t *Torrent) pieceNumPendingChunks(piece pieceIndex) pp.Integer {
1053 if t.pieceComplete(piece) {
1056 return pp.Integer(t.pieceNumChunks(piece) - t.pieces[piece].numDirtyChunks())
1059 func (t *Torrent) pieceAllDirty(piece pieceIndex) bool {
1060 return t.pieces[piece].allChunksDirty()
1063 func (t *Torrent) readersChanged() {
1064 t.updateReaderPieces()
1065 t.updateAllPiecePriorities("Torrent.readersChanged")
1068 func (t *Torrent) updateReaderPieces() {
1069 t._readerNowPieces, t._readerReadaheadPieces = t.readerPiecePriorities()
1072 func (t *Torrent) readerPosChanged(from, to pieceRange) {
1076 t.updateReaderPieces()
1077 // Order the ranges, high and low.
1079 if l.begin > h.begin {
1082 if l.end < h.begin {
1083 // Two distinct ranges.
1084 t.updatePiecePriorities(l.begin, l.end, "Torrent.readerPosChanged")
1085 t.updatePiecePriorities(h.begin, h.end, "Torrent.readerPosChanged")
1092 t.updatePiecePriorities(l.begin, end, "Torrent.readerPosChanged")
1096 func (t *Torrent) maybeNewConns() {
1097 // Tickle the accept routine.
1098 t.cl.event.Broadcast()
1102 func (t *Torrent) piecePriorityChanged(piece pieceIndex, reason string) {
1103 if t._pendingPieces.Contains(uint32(piece)) {
1104 t.iterPeers(func(c *Peer) {
1105 // if c.requestState.Interested {
1108 if !c.isLowOnRequests() {
1111 if !c.peerHasPiece(piece) {
1114 if c.requestState.Interested && c.peerChoking && !c.peerAllowedFast.Contains(uint32(piece)) {
1117 c.updateRequests(reason)
1121 t.publishPieceChange(piece)
1124 func (t *Torrent) updatePiecePriority(piece pieceIndex, reason string) {
1125 if !t.closed.IsSet() {
1126 // It would be possible to filter on pure-priority changes here to avoid churning the piece
1128 t.updatePieceRequestOrder(piece)
1130 p := &t.pieces[piece]
1131 newPrio := p.uncachedPriority()
1132 // t.logger.Printf("torrent %p: piece %d: uncached priority: %v", t, piece, newPrio)
1133 if newPrio == PiecePriorityNone {
1134 if !t._pendingPieces.CheckedRemove(uint32(piece)) {
1138 if !t._pendingPieces.CheckedAdd(uint32(piece)) {
1142 t.piecePriorityChanged(piece, reason)
1145 func (t *Torrent) updateAllPiecePriorities(reason string) {
1146 t.updatePiecePriorities(0, t.numPieces(), reason)
1149 // Update all piece priorities in one hit. This function should have the same
1150 // output as updatePiecePriority, but across all pieces.
1151 func (t *Torrent) updatePiecePriorities(begin, end pieceIndex, reason string) {
1152 for i := begin; i < end; i++ {
1153 t.updatePiecePriority(i, reason)
1157 // Returns the range of pieces [begin, end) that contains the extent of bytes.
1158 func (t *Torrent) byteRegionPieces(off, size int64) (begin, end pieceIndex) {
1159 if off >= *t.length {
1169 begin = pieceIndex(off / t.info.PieceLength)
1170 end = pieceIndex((off + size + t.info.PieceLength - 1) / t.info.PieceLength)
1171 if end > pieceIndex(t.info.NumPieces()) {
1172 end = pieceIndex(t.info.NumPieces())
1177 // Returns true if all iterations complete without breaking. Returns the read regions for all
1178 // readers. The reader regions should not be merged as some callers depend on this method to
1179 // enumerate readers.
1180 func (t *Torrent) forReaderOffsetPieces(f func(begin, end pieceIndex) (more bool)) (all bool) {
1181 for r := range t.readers {
1183 if p.begin >= p.end {
1186 if !f(p.begin, p.end) {
1193 func (t *Torrent) piecePriority(piece pieceIndex) piecePriority {
1194 return t.piece(piece).uncachedPriority()
1197 func (t *Torrent) pendRequest(req RequestIndex) {
1198 t.piece(int(req / t.chunksPerRegularPiece())).pendChunkIndex(req % t.chunksPerRegularPiece())
1201 func (t *Torrent) pieceCompletionChanged(piece pieceIndex, reason string) {
1202 t.cl.event.Broadcast()
1203 if t.pieceComplete(piece) {
1204 t.onPieceCompleted(piece)
1206 t.onIncompletePiece(piece)
1208 t.updatePiecePriority(piece, reason)
1211 func (t *Torrent) numReceivedConns() (ret int) {
1212 for c := range t.conns {
1213 if c.Discovery == PeerSourceIncoming {
1220 func (t *Torrent) maxHalfOpen() int {
1221 // Note that if we somehow exceed the maximum established conns, we want
1222 // the negative value to have an effect.
1223 establishedHeadroom := int64(t.maxEstablishedConns - len(t.conns))
1224 extraIncoming := int64(t.numReceivedConns() - t.maxEstablishedConns/2)
1225 // We want to allow some experimentation with new peers, and to try to
1226 // upset an oversupply of received connections.
1227 return int(min(max(5, extraIncoming)+establishedHeadroom, int64(t.cl.config.HalfOpenConnsPerTorrent)))
1230 func (t *Torrent) openNewConns() (initiated int) {
1231 defer t.updateWantPeersEvent()
1232 for t.peers.Len() != 0 {
1236 if len(t.halfOpen) >= t.maxHalfOpen() {
1239 if len(t.cl.dialers) == 0 {
1242 if t.cl.numHalfOpen >= t.cl.config.TotalHalfOpenConns {
1245 p := t.peers.PopMax()
1252 func (t *Torrent) updatePieceCompletion(piece pieceIndex) bool {
1254 uncached := t.pieceCompleteUncached(piece)
1255 cached := p.completion()
1256 changed := cached != uncached
1257 complete := uncached.Complete
1258 p.storageCompletionOk = uncached.Ok
1261 t._completedPieces.Add(x)
1264 t._completedPieces.Remove(x)
1266 p.t.updatePieceRequestOrder(piece)
1268 if complete && len(p.dirtiers) != 0 {
1269 t.logger.Printf("marked piece %v complete but still has dirtiers", piece)
1272 log.Fstr("piece %d completion changed: %+v -> %+v", piece, cached, uncached).SetLevel(log.Debug).Log(t.logger)
1273 t.pieceCompletionChanged(piece, "Torrent.updatePieceCompletion")
1278 // Non-blocking read. Client lock is not required.
1279 func (t *Torrent) readAt(b []byte, off int64) (n int, err error) {
1281 p := &t.pieces[off/t.info.PieceLength]
1282 p.waitNoPendingWrites()
1284 n1, err = p.Storage().ReadAt(b, off-p.Info().Offset())
1295 // Returns an error if the metadata was completed, but couldn't be set for some reason. Blame it on
1296 // the last peer to contribute. TODO: Actually we shouldn't blame peers for failure to open storage
1297 // etc. Also we should probably cached metadata pieces per-Peer, to isolate failure appropriately.
1298 func (t *Torrent) maybeCompleteMetadata() error {
1303 if !t.haveAllMetadataPieces() {
1304 // Don't have enough metadata pieces.
1307 err := t.setInfoBytesLocked(t.metadataBytes)
1309 t.invalidateMetadata()
1310 return fmt.Errorf("error setting info bytes: %s", err)
1312 if t.cl.config.Debug {
1313 t.logger.Printf("%s: got metadata from peers", t)
1318 func (t *Torrent) readerPiecePriorities() (now, readahead bitmap.Bitmap) {
1319 t.forReaderOffsetPieces(func(begin, end pieceIndex) bool {
1321 now.Add(bitmap.BitIndex(begin))
1322 readahead.AddRange(bitmap.BitRange(begin)+1, bitmap.BitRange(end))
1329 func (t *Torrent) needData() bool {
1330 if t.closed.IsSet() {
1336 return !t._pendingPieces.IsEmpty()
1339 func appendMissingStrings(old, new []string) (ret []string) {
1342 for _, n := range new {
1343 for _, o := range old {
1348 ret = append(ret, n)
1353 func appendMissingTrackerTiers(existing [][]string, minNumTiers int) (ret [][]string) {
1355 for minNumTiers > len(ret) {
1356 ret = append(ret, nil)
1361 func (t *Torrent) addTrackers(announceList [][]string) {
1362 fullAnnounceList := &t.metainfo.AnnounceList
1363 t.metainfo.AnnounceList = appendMissingTrackerTiers(*fullAnnounceList, len(announceList))
1364 for tierIndex, trackerURLs := range announceList {
1365 (*fullAnnounceList)[tierIndex] = appendMissingStrings((*fullAnnounceList)[tierIndex], trackerURLs)
1367 t.startMissingTrackerScrapers()
1368 t.updateWantPeersEvent()
1371 // Don't call this before the info is available.
1372 func (t *Torrent) bytesCompleted() int64 {
1376 return *t.length - t.bytesLeft()
1379 func (t *Torrent) SetInfoBytes(b []byte) (err error) {
1382 return t.setInfoBytesLocked(b)
1385 // Returns true if connection is removed from torrent.Conns.
1386 func (t *Torrent) deletePeerConn(c *PeerConn) (ret bool) {
1387 if !c.closed.IsSet() {
1388 panic("connection is not closed")
1389 // There are behaviours prevented by the closed state that will fail
1390 // if the connection has been deleted.
1394 // Avoid adding a drop event more than once. Probably we should track whether we've generated
1395 // the drop event against the PexConnState instead.
1397 if !t.cl.config.DisablePEX {
1401 torrent.Add("deleted connections", 1)
1402 if !c.deleteAllRequests().IsEmpty() {
1403 t.iterPeers(func(p *Peer) {
1404 if p.isLowOnRequests() {
1405 p.updateRequests("Torrent.deletePeerConn")
1409 t.assertPendingRequests()
1413 func (t *Torrent) decPeerPieceAvailability(p *Peer) {
1417 p.newPeerPieces().Iterate(func(i uint32) bool {
1418 p.t.decPieceAvailability(pieceIndex(i))
1423 func (t *Torrent) assertPendingRequests() {
1427 // var actual pendingRequests
1428 // if t.haveInfo() {
1429 // actual.m = make([]int, t.numRequests())
1431 // t.iterPeers(func(p *Peer) {
1432 // p.requestState.Requests.Iterate(func(x uint32) bool {
1437 // diff := cmp.Diff(actual.m, t.pendingRequests.m)
1443 func (t *Torrent) dropConnection(c *PeerConn) {
1444 t.cl.event.Broadcast()
1446 if t.deletePeerConn(c) {
1451 // Peers as in contact information for dialing out.
1452 func (t *Torrent) wantPeers() bool {
1453 if t.closed.IsSet() {
1456 if t.peers.Len() > t.cl.config.TorrentPeersLowWater {
1459 return t.wantConns()
1462 func (t *Torrent) updateWantPeersEvent() {
1464 t.wantPeersEvent.Set()
1466 t.wantPeersEvent.Clear()
1470 // Returns whether the client should make effort to seed the torrent.
1471 func (t *Torrent) seeding() bool {
1473 if t.closed.IsSet() {
1476 if t.dataUploadDisallowed {
1479 if cl.config.NoUpload {
1482 if !cl.config.Seed {
1485 if cl.config.DisableAggressiveUpload && t.needData() {
1491 func (t *Torrent) onWebRtcConn(
1492 c datachannel.ReadWriteCloser,
1493 dcc webtorrent.DataChannelContext,
1496 pc, err := t.cl.initiateProtocolHandshakes(
1497 context.Background(),
1498 webrtcNetConn{c, dcc},
1502 webrtcNetAddr{dcc.Remote},
1504 fmt.Sprintf("webrtc offer_id %x", dcc.OfferId),
1507 t.logger.WithDefaultLevel(log.Error).Printf("error in handshaking webrtc connection: %v", err)
1510 if dcc.LocalOffered {
1511 pc.Discovery = PeerSourceTracker
1513 pc.Discovery = PeerSourceIncoming
1515 pc.conn.SetWriteDeadline(time.Time{})
1518 err = t.cl.runHandshookConn(pc, t)
1520 t.logger.WithDefaultLevel(log.Critical).Printf("error running handshook webrtc conn: %v", err)
1524 func (t *Torrent) logRunHandshookConn(pc *PeerConn, logAll bool, level log.Level) {
1525 err := t.cl.runHandshookConn(pc, t)
1526 if err != nil || logAll {
1527 t.logger.WithDefaultLevel(level).Printf("error running handshook conn: %v", err)
1531 func (t *Torrent) runHandshookConnLoggingErr(pc *PeerConn) {
1532 t.logRunHandshookConn(pc, false, log.Debug)
1535 func (t *Torrent) startWebsocketAnnouncer(u url.URL) torrentTrackerAnnouncer {
1536 wtc, release := t.cl.websocketTrackers.Get(u.String())
1541 wst := websocketTrackerStatus{u, wtc}
1543 err := wtc.Announce(tracker.Started, t.infoHash)
1545 t.logger.WithDefaultLevel(log.Warning).Printf(
1546 "error in initial announce to %q: %v",
1554 func (t *Torrent) startScrapingTracker(_url string) {
1558 u, err := url.Parse(_url)
1560 // URLs with a leading '*' appear to be a uTorrent convention to
1561 // disable trackers.
1563 log.Str("error parsing tracker url").AddValues("url", _url).Log(t.logger)
1567 if u.Scheme == "udp" {
1569 t.startScrapingTracker(u.String())
1571 t.startScrapingTracker(u.String())
1574 if _, ok := t.trackerAnnouncers[_url]; ok {
1577 sl := func() torrentTrackerAnnouncer {
1580 if t.cl.config.DisableWebtorrent {
1583 return t.startWebsocketAnnouncer(*u)
1585 if t.cl.config.DisableIPv4Peers || t.cl.config.DisableIPv4 {
1589 if t.cl.config.DisableIPv6 {
1593 newAnnouncer := &trackerScraper{
1596 lookupTrackerIp: t.cl.config.LookupTrackerIp,
1598 go newAnnouncer.Run()
1604 if t.trackerAnnouncers == nil {
1605 t.trackerAnnouncers = make(map[string]torrentTrackerAnnouncer)
1607 t.trackerAnnouncers[_url] = sl
1610 // Adds and starts tracker scrapers for tracker URLs that aren't already
1612 func (t *Torrent) startMissingTrackerScrapers() {
1613 if t.cl.config.DisableTrackers {
1616 t.startScrapingTracker(t.metainfo.Announce)
1617 for _, tier := range t.metainfo.AnnounceList {
1618 for _, url := range tier {
1619 t.startScrapingTracker(url)
1624 // Returns an AnnounceRequest with fields filled out to defaults and current
1626 func (t *Torrent) announceRequest(event tracker.AnnounceEvent) tracker.AnnounceRequest {
1627 // Note that IPAddress is not set. It's set for UDP inside the tracker code, since it's
1628 // dependent on the network in use.
1629 return tracker.AnnounceRequest{
1631 NumWant: func() int32 {
1632 if t.wantPeers() && len(t.cl.dialers) > 0 {
1638 Port: uint16(t.cl.incomingPeerPort()),
1639 PeerId: t.cl.peerID,
1640 InfoHash: t.infoHash,
1641 Key: t.cl.announceKey(),
1643 // The following are vaguely described in BEP 3.
1645 Left: t.bytesLeftAnnounce(),
1646 Uploaded: t.stats.BytesWrittenData.Int64(),
1647 // There's no mention of wasted or unwanted download in the BEP.
1648 Downloaded: t.stats.BytesReadUsefulData.Int64(),
1652 // Adds peers revealed in an announce until the announce ends, or we have
1654 func (t *Torrent) consumeDhtAnnouncePeers(pvs <-chan dht.PeersValues) {
1656 for v := range pvs {
1659 for _, cp := range v.Peers {
1661 // Can't do anything with this.
1664 if t.addPeer(PeerInfo{
1665 Addr: ipPortAddr{cp.IP, cp.Port},
1666 Source: PeerSourceDhtGetPeers,
1673 // log.Printf("added %v peers from dht for %v", added, t.InfoHash().HexString())
1678 // Announce using the provided DHT server. Peers are consumed automatically. done is closed when the
1679 // announce ends. stop will force the announce to end.
1680 func (t *Torrent) AnnounceToDht(s DhtServer) (done <-chan struct{}, stop func(), err error) {
1681 ps, err := s.Announce(t.infoHash, t.cl.incomingPeerPort(), true)
1685 _done := make(chan struct{})
1689 t.consumeDhtAnnouncePeers(ps.Peers())
1695 func (t *Torrent) timeboxedAnnounceToDht(s DhtServer) error {
1696 _, stop, err := t.AnnounceToDht(s)
1701 case <-t.closed.Done():
1702 case <-time.After(5 * time.Minute):
1708 func (t *Torrent) dhtAnnouncer(s DhtServer) {
1714 if t.closed.IsSet() {
1717 // We're also announcing ourselves as a listener, so we don't just want peer addresses.
1718 // TODO: We can include the announce_peer step depending on whether we can receive
1719 // inbound connections. We should probably only announce once every 15 mins too.
1723 // TODO: Determine if there's a listener on the port we're announcing.
1724 if len(cl.dialers) == 0 && len(cl.listeners) == 0 {
1735 err := t.timeboxedAnnounceToDht(s)
1737 t.logger.WithDefaultLevel(log.Warning).Printf("error announcing %q to DHT: %s", t, err)
1743 func (t *Torrent) addPeers(peers []PeerInfo) (added int) {
1744 for _, p := range peers {
1752 // The returned TorrentStats may require alignment in memory. See
1753 // https://github.com/anacrolix/torrent/issues/383.
1754 func (t *Torrent) Stats() TorrentStats {
1756 defer t.cl.rUnlock()
1757 return t.statsLocked()
1760 func (t *Torrent) statsLocked() (ret TorrentStats) {
1761 ret.ActivePeers = len(t.conns)
1762 ret.HalfOpenPeers = len(t.halfOpen)
1763 ret.PendingPeers = t.peers.Len()
1764 ret.TotalPeers = t.numTotalPeers()
1765 ret.ConnectedSeeders = 0
1766 for c := range t.conns {
1767 if all, ok := c.peerHasAllPieces(); all && ok {
1768 ret.ConnectedSeeders++
1771 ret.ConnStats = t.stats.Copy()
1772 ret.PiecesComplete = t.numPiecesCompleted()
1776 // The total number of peers in the torrent.
1777 func (t *Torrent) numTotalPeers() int {
1778 peers := make(map[string]struct{})
1779 for conn := range t.conns {
1780 ra := conn.conn.RemoteAddr()
1782 // It's been closed and doesn't support RemoteAddr.
1785 peers[ra.String()] = struct{}{}
1787 for addr := range t.halfOpen {
1788 peers[addr] = struct{}{}
1790 t.peers.Each(func(peer PeerInfo) {
1791 peers[peer.Addr.String()] = struct{}{}
1796 // Reconcile bytes transferred before connection was associated with a
1798 func (t *Torrent) reconcileHandshakeStats(c *PeerConn) {
1799 if c._stats != (ConnStats{
1800 // Handshakes should only increment these fields:
1801 BytesWritten: c._stats.BytesWritten,
1802 BytesRead: c._stats.BytesRead,
1806 c.postHandshakeStats(func(cs *ConnStats) {
1807 cs.BytesRead.Add(c._stats.BytesRead.Int64())
1808 cs.BytesWritten.Add(c._stats.BytesWritten.Int64())
1810 c.reconciledHandshakeStats = true
1813 // Returns true if the connection is added.
1814 func (t *Torrent) addPeerConn(c *PeerConn) (err error) {
1817 torrent.Add("added connections", 1)
1820 if t.closed.IsSet() {
1821 return errors.New("torrent closed")
1823 for c0 := range t.conns {
1824 if c.PeerID != c0.PeerID {
1827 if !t.cl.config.DropDuplicatePeerIds {
1830 if left, ok := c.hasPreferredNetworkOver(c0); ok && left {
1832 t.deletePeerConn(c0)
1834 return errors.New("existing connection preferred")
1837 if len(t.conns) >= t.maxEstablishedConns {
1838 c := t.worstBadConn()
1840 return errors.New("don't want conns")
1845 if len(t.conns) >= t.maxEstablishedConns {
1848 t.conns[c] = struct{}{}
1849 if !t.cl.config.DisablePEX && !c.PeerExtensionBytes.SupportsExtended() {
1850 t.pex.Add(c) // as no further extended handshake expected
1855 func (t *Torrent) wantConns() bool {
1856 if !t.networkingEnabled.Bool() {
1859 if t.closed.IsSet() {
1862 if !t.needData() && (!t.seeding() || !t.haveAnyPieces()) {
1865 return len(t.conns) < t.maxEstablishedConns || t.worstBadConn() != nil
1868 func (t *Torrent) SetMaxEstablishedConns(max int) (oldMax int) {
1871 oldMax = t.maxEstablishedConns
1872 t.maxEstablishedConns = max
1873 wcs := worseConnSlice{
1874 conns: t.appendConns(nil, func(*PeerConn) bool {
1880 for len(t.conns) > t.maxEstablishedConns && wcs.Len() > 0 {
1881 t.dropConnection(heap.Pop(&wcs).(*PeerConn))
1887 func (t *Torrent) pieceHashed(piece pieceIndex, passed bool, hashIoErr error) {
1888 t.logger.Log(log.Fstr("hashed piece %d (passed=%t)", piece, passed).SetLevel(log.Debug))
1891 t.cl.event.Broadcast()
1892 if t.closed.IsSet() {
1896 // Don't score the first time a piece is hashed, it could be an initial check.
1897 if p.storageCompletionOk {
1899 pieceHashedCorrect.Add(1)
1902 "piece %d failed hash: %d connections contributed", piece, len(p.dirtiers),
1903 ).AddValues(t, p).SetLevel(log.Debug).Log(t.logger)
1904 pieceHashedNotCorrect.Add(1)
1909 t.publishPieceChange(piece)
1912 t.publishPieceChange(piece)
1916 if len(p.dirtiers) != 0 {
1917 // Don't increment stats above connection-level for every involved connection.
1918 t.allStats((*ConnStats).incrementPiecesDirtiedGood)
1920 for c := range p.dirtiers {
1921 c._stats.incrementPiecesDirtiedGood()
1923 t.clearPieceTouchers(piece)
1925 err := p.Storage().MarkComplete()
1927 t.logger.Printf("%T: error marking piece complete %d: %s", t.storage, piece, err)
1931 if t.closed.IsSet() {
1934 t.pendAllChunkSpecs(piece)
1936 if len(p.dirtiers) != 0 && p.allChunksDirty() && hashIoErr == nil {
1937 // Peers contributed to all the data for this piece hash failure, and the failure was
1938 // not due to errors in the storage (such as data being dropped in a cache).
1940 // Increment Torrent and above stats, and then specific connections.
1941 t.allStats((*ConnStats).incrementPiecesDirtiedBad)
1942 for c := range p.dirtiers {
1943 // Y u do dis peer?!
1944 c.stats().incrementPiecesDirtiedBad()
1947 bannableTouchers := make([]*Peer, 0, len(p.dirtiers))
1948 for c := range p.dirtiers {
1950 bannableTouchers = append(bannableTouchers, c)
1953 t.clearPieceTouchers(piece)
1954 slices.Sort(bannableTouchers, connLessTrusted)
1956 if t.cl.config.Debug {
1958 "bannable conns by trust for piece %d: %v",
1960 func() (ret []connectionTrust) {
1961 for _, c := range bannableTouchers {
1962 ret = append(ret, c.trust())
1969 if len(bannableTouchers) >= 1 {
1970 c := bannableTouchers[0]
1971 t.cl.banPeerIP(c.remoteIp())
1975 t.onIncompletePiece(piece)
1976 p.Storage().MarkNotComplete()
1978 t.updatePieceCompletion(piece)
1981 func (t *Torrent) cancelRequestsForPiece(piece pieceIndex) {
1982 // TODO: Make faster
1983 for cn := range t.conns {
1988 func (t *Torrent) onPieceCompleted(piece pieceIndex) {
1989 t.pendAllChunkSpecs(piece)
1990 t.cancelRequestsForPiece(piece)
1991 t.piece(piece).readerCond.Broadcast()
1992 for conn := range t.conns {
1994 t.maybeDropMutuallyCompletePeer(&conn.Peer)
1998 // Called when a piece is found to be not complete.
1999 func (t *Torrent) onIncompletePiece(piece pieceIndex) {
2000 if t.pieceAllDirty(piece) {
2001 t.pendAllChunkSpecs(piece)
2003 if !t.wantPieceIndex(piece) {
2004 // t.logger.Printf("piece %d incomplete and unwanted", piece)
2007 // We could drop any connections that we told we have a piece that we
2008 // don't here. But there's a test failure, and it seems clients don't care
2009 // if you request pieces that you already claim to have. Pruning bad
2010 // connections might just remove any connections that aren't treating us
2011 // favourably anyway.
2013 // for c := range t.conns {
2014 // if c.sentHave(piece) {
2018 t.iterPeers(func(conn *Peer) {
2019 if conn.peerHasPiece(piece) {
2020 conn.updateRequests("piece incomplete")
2025 func (t *Torrent) tryCreateMorePieceHashers() {
2026 for !t.closed.IsSet() && t.activePieceHashes < 2 && t.tryCreatePieceHasher() {
2030 func (t *Torrent) tryCreatePieceHasher() bool {
2031 if t.storage == nil {
2034 pi, ok := t.getPieceToHash()
2039 t.piecesQueuedForHash.Remove(bitmap.BitIndex(pi))
2041 t.publishPieceChange(pi)
2042 t.updatePiecePriority(pi, "Torrent.tryCreatePieceHasher")
2043 t.storageLock.RLock()
2044 t.activePieceHashes++
2045 go t.pieceHasher(pi)
2049 func (t *Torrent) getPieceToHash() (ret pieceIndex, ok bool) {
2050 t.piecesQueuedForHash.IterTyped(func(i pieceIndex) bool {
2051 if t.piece(i).hashing {
2061 func (t *Torrent) pieceHasher(index pieceIndex) {
2063 sum, copyErr := t.hashPiece(index)
2064 correct := sum == *p.hash
2068 log.Fmsg("piece %v (%s) hash failure copy error: %v", p, p.hash.HexString(), copyErr).Log(t.logger)
2070 t.storageLock.RUnlock()
2074 t.pieceHashed(index, correct, copyErr)
2075 t.updatePiecePriority(index, "Torrent.pieceHasher")
2076 t.activePieceHashes--
2077 t.tryCreateMorePieceHashers()
2080 // Return the connections that touched a piece, and clear the entries while doing it.
2081 func (t *Torrent) clearPieceTouchers(pi pieceIndex) {
2083 for c := range p.dirtiers {
2084 delete(c.peerTouchedPieces, pi)
2085 delete(p.dirtiers, c)
2089 func (t *Torrent) peersAsSlice() (ret []*Peer) {
2090 t.iterPeers(func(p *Peer) {
2091 ret = append(ret, p)
2096 func (t *Torrent) queuePieceCheck(pieceIndex pieceIndex) {
2097 piece := t.piece(pieceIndex)
2098 if piece.queuedForHash() {
2101 t.piecesQueuedForHash.Add(bitmap.BitIndex(pieceIndex))
2102 t.publishPieceChange(pieceIndex)
2103 t.updatePiecePriority(pieceIndex, "Torrent.queuePieceCheck")
2104 t.tryCreateMorePieceHashers()
2107 // Forces all the pieces to be re-hashed. See also Piece.VerifyData. This should not be called
2108 // before the Info is available.
2109 func (t *Torrent) VerifyData() {
2110 for i := pieceIndex(0); i < t.NumPieces(); i++ {
2111 t.Piece(i).VerifyData()
2115 // Start the process of connecting to the given peer for the given torrent if appropriate.
2116 func (t *Torrent) initiateConn(peer PeerInfo) {
2117 if peer.Id == t.cl.peerID {
2120 if t.cl.badPeerAddr(peer.Addr) && !peer.Trusted {
2124 if t.addrActive(addr.String()) {
2128 t.halfOpen[addr.String()] = peer
2129 go t.cl.outgoingConnection(t, addr, peer.Source, peer.Trusted)
2132 // Adds a trusted, pending peer for each of the given Client's addresses. Typically used in tests to
2133 // quickly make one Client visible to the Torrent of another Client.
2134 func (t *Torrent) AddClientPeer(cl *Client) int {
2135 return t.AddPeers(func() (ps []PeerInfo) {
2136 for _, la := range cl.ListenAddrs() {
2137 ps = append(ps, PeerInfo{
2146 // All stats that include this Torrent. Useful when we want to increment ConnStats but not for every
2148 func (t *Torrent) allStats(f func(*ConnStats)) {
2153 func (t *Torrent) hashingPiece(i pieceIndex) bool {
2154 return t.pieces[i].hashing
2157 func (t *Torrent) pieceQueuedForHash(i pieceIndex) bool {
2158 return t.piecesQueuedForHash.Get(bitmap.BitIndex(i))
2161 func (t *Torrent) dialTimeout() time.Duration {
2162 return reducedDialTimeout(t.cl.config.MinDialTimeout, t.cl.config.NominalDialTimeout, t.cl.config.HalfOpenConnsPerTorrent, t.peers.Len())
2165 func (t *Torrent) piece(i int) *Piece {
2169 func (t *Torrent) onWriteChunkErr(err error) {
2170 if t.userOnWriteChunkErr != nil {
2171 go t.userOnWriteChunkErr(err)
2174 t.logger.WithDefaultLevel(log.Critical).Printf("default chunk write error handler: disabling data download")
2175 t.disallowDataDownloadLocked()
2178 func (t *Torrent) DisallowDataDownload() {
2179 t.disallowDataDownloadLocked()
2182 func (t *Torrent) disallowDataDownloadLocked() {
2183 t.dataDownloadDisallowed.Set()
2186 func (t *Torrent) AllowDataDownload() {
2187 t.dataDownloadDisallowed.Clear()
2190 // Enables uploading data, if it was disabled.
2191 func (t *Torrent) AllowDataUpload() {
2194 t.dataUploadDisallowed = false
2195 for c := range t.conns {
2196 c.updateRequests("allow data upload")
2200 // Disables uploading data, if it was enabled.
2201 func (t *Torrent) DisallowDataUpload() {
2204 t.dataUploadDisallowed = true
2205 for c := range t.conns {
2206 c.updateRequests("disallow data upload")
2210 // Sets a handler that is called if there's an error writing a chunk to local storage. By default,
2211 // or if nil, a critical message is logged, and data download is disabled.
2212 func (t *Torrent) SetOnWriteChunkError(f func(error)) {
2215 t.userOnWriteChunkErr = f
2218 func (t *Torrent) iterPeers(f func(p *Peer)) {
2219 for pc := range t.conns {
2222 for _, ws := range t.webSeeds {
2227 func (t *Torrent) callbacks() *Callbacks {
2228 return &t.cl.config.Callbacks
2231 func (t *Torrent) addWebSeed(url string) {
2232 if t.cl.config.DisableWebseeds {
2235 if _, ok := t.webSeeds[url]; ok {
2238 // I don't think Go http supports pipelining requests. However, we can have more ready to go
2239 // right away. This value should be some multiple of the number of connections to a host. I
2240 // would expect that double maxRequests plus a bit would be appropriate. This value is based on
2241 // downloading Sintel (08ada5a7a6183aae1e09d831df6748d566095a10) from
2242 // "https://webtorrent.io/torrents/".
2243 const maxRequests = 16
2249 reconciledHandshakeStats: true,
2250 // This should affect how often we have to recompute requests for this peer. Note that
2251 // because we can request more than 1 thing at a time over HTTP, we will hit the low
2252 // requests mark more often, so recomputation is probably sooner than with regular peer
2253 // conns. ~4x maxRequests would be about right.
2254 PeerMaxRequests: 128,
2255 RemoteAddr: remoteAddrFromUrl(url),
2256 callbacks: t.callbacks(),
2258 client: webseed.Client{
2259 HttpClient: t.cl.webseedHttpClient,
2262 activeRequests: make(map[Request]webseed.Request, maxRequests),
2263 maxRequests: maxRequests,
2265 ws.peer.initUpdateRequestsTimer()
2266 ws.requesterCond.L = t.cl.locker()
2267 for i := 0; i < maxRequests; i += 1 {
2270 for _, f := range t.callbacks().NewPeer {
2273 ws.peer.logger = t.logger.WithContextValue(&ws)
2274 ws.peer.peerImpl = &ws
2276 ws.onGotInfo(t.info)
2278 t.webSeeds[url] = &ws.peer
2281 func (t *Torrent) peerIsActive(p *Peer) (active bool) {
2282 t.iterPeers(func(p1 *Peer) {
2290 func (t *Torrent) requestIndexToRequest(ri RequestIndex) Request {
2291 index := ri / t.chunksPerRegularPiece()
2294 t.piece(int(index)).chunkIndexSpec(ri % t.chunksPerRegularPiece()),
2298 func (t *Torrent) requestIndexFromRequest(r Request) RequestIndex {
2299 return t.pieceRequestIndexOffset(pieceIndex(r.Index)) + uint32(r.Begin/t.chunkSize)
2302 func (t *Torrent) pieceRequestIndexOffset(piece pieceIndex) RequestIndex {
2303 return RequestIndex(piece) * t.chunksPerRegularPiece()
2306 func (t *Torrent) updateComplete() {
2307 t.Complete.SetBool(t.haveAllPieces())
2310 func (t *Torrent) cancelRequest(r RequestIndex) *Peer {
2311 p := t.pendingRequests[r]
2315 delete(t.pendingRequests, r)
2319 func (t *Torrent) requestingPeer(r RequestIndex) *Peer {
2320 return t.pendingRequests[r]