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 return t.pieces[piece].Storage().Completion()
249 // There's a connection to that address already.
250 func (t *Torrent) addrActive(addr string) bool {
251 if _, ok := t.halfOpen[addr]; ok {
254 for c := range t.conns {
256 if ra.String() == addr {
263 func (t *Torrent) appendUnclosedConns(ret []*PeerConn) []*PeerConn {
264 return t.appendConns(ret, func(conn *PeerConn) bool {
265 return !conn.closed.IsSet()
269 func (t *Torrent) appendConns(ret []*PeerConn, f func(*PeerConn) bool) []*PeerConn {
270 for c := range t.conns {
278 func (t *Torrent) addPeer(p PeerInfo) (added bool) {
280 torrent.Add(fmt.Sprintf("peers added by source %q", p.Source), 1)
281 if t.closed.IsSet() {
284 if ipAddr, ok := tryIpPortFromNetAddr(p.Addr); ok {
285 if cl.badPeerIPPort(ipAddr.IP, ipAddr.Port) {
286 torrent.Add("peers not added because of bad addr", 1)
287 // cl.logger.Printf("peers not added because of bad addr: %v", p)
291 if replaced, ok := t.peers.AddReturningReplacedPeer(p); ok {
292 torrent.Add("peers replaced", 1)
293 if !replaced.equal(p) {
294 t.logger.WithDefaultLevel(log.Debug).Printf("added %v replacing %v", p, replaced)
301 for t.peers.Len() > cl.config.TorrentPeersHighWater {
302 _, ok := t.peers.DeleteMin()
304 torrent.Add("excess reserve peers discarded", 1)
310 func (t *Torrent) invalidateMetadata() {
311 for i := 0; i < len(t.metadataCompletedChunks); i++ {
312 t.metadataCompletedChunks[i] = false
315 t.gotMetainfoC = make(chan struct{})
320 func (t *Torrent) saveMetadataPiece(index int, data []byte) {
324 if index >= len(t.metadataCompletedChunks) {
325 t.logger.Printf("%s: ignoring metadata piece %d", t, index)
328 copy(t.metadataBytes[(1<<14)*index:], data)
329 t.metadataCompletedChunks[index] = true
332 func (t *Torrent) metadataPieceCount() int {
333 return (len(t.metadataBytes) + (1 << 14) - 1) / (1 << 14)
336 func (t *Torrent) haveMetadataPiece(piece int) bool {
338 return (1<<14)*piece < len(t.metadataBytes)
340 return piece < len(t.metadataCompletedChunks) && t.metadataCompletedChunks[piece]
344 func (t *Torrent) metadataSize() int {
345 return len(t.metadataBytes)
348 func infoPieceHashes(info *metainfo.Info) (ret [][]byte) {
349 for i := 0; i < len(info.Pieces); i += sha1.Size {
350 ret = append(ret, info.Pieces[i:i+sha1.Size])
355 func (t *Torrent) makePieces() {
356 hashes := infoPieceHashes(t.info)
357 t.pieces = make([]Piece, len(hashes))
358 for i, hash := range hashes {
359 piece := &t.pieces[i]
361 piece.index = pieceIndex(i)
362 piece.noPendingWrites.L = &piece.pendingWritesMutex
363 piece.hash = (*metainfo.Hash)(unsafe.Pointer(&hash[0]))
365 beginFile := pieceFirstFileIndex(piece.torrentBeginOffset(), files)
366 endFile := pieceEndFileIndex(piece.torrentEndOffset(), files)
367 piece.files = files[beginFile:endFile]
368 piece.undirtiedChunksIter = undirtiedChunksIter{
369 TorrentDirtyChunks: &t.dirtyChunks,
370 StartRequestIndex: piece.requestIndexOffset(),
371 EndRequestIndex: piece.requestIndexOffset() + piece.numChunks(),
376 // Returns the index of the first file containing the piece. files must be
377 // ordered by offset.
378 func pieceFirstFileIndex(pieceOffset int64, files []*File) int {
379 for i, f := range files {
380 if f.offset+f.length > pieceOffset {
387 // Returns the index after the last file containing the piece. files must be
388 // ordered by offset.
389 func pieceEndFileIndex(pieceEndOffset int64, files []*File) int {
390 for i, f := range files {
391 if f.offset+f.length >= pieceEndOffset {
398 func (t *Torrent) cacheLength() {
400 for _, f := range t.info.UpvertedFiles() {
406 // TODO: This shouldn't fail for storage reasons. Instead we should handle storage failure
408 func (t *Torrent) setInfo(info *metainfo.Info) error {
409 if err := validateInfo(info); err != nil {
410 return fmt.Errorf("bad info: %s", err)
412 if t.storageOpener != nil {
414 t.storage, err = t.storageOpener.OpenTorrent(info, t.infoHash)
416 return fmt.Errorf("error opening torrent storage: %s", err)
423 t.fileIndex = segments.NewIndex(common.LengthIterFromUpvertedFiles(info.UpvertedFiles()))
424 t.displayName = "" // Save a few bytes lol.
431 func (t *Torrent) pieceRequestOrderKey(i int) request_strategy.PieceRequestOrderKey {
432 return request_strategy.PieceRequestOrderKey{
433 InfoHash: t.infoHash,
438 // This seems to be all the follow-up tasks after info is set, that can't fail.
439 func (t *Torrent) onSetInfo() {
440 t.initPieceRequestOrder()
441 for i := range t.pieces {
443 // Need to add availability before updating piece completion, as that may result in conns
445 if p.availability != 0 {
446 panic(p.availability)
448 p.availability = int64(t.pieceAvailabilityFromPeers(i))
449 t.addRequestOrderPiece(i)
450 t.updatePieceCompletion(pieceIndex(i))
451 if !t.initialPieceCheckDisabled && !p.storageCompletionOk {
452 // t.logger.Printf("piece %s completion unknown, queueing check", p)
453 t.queuePieceCheck(pieceIndex(i))
456 t.cl.event.Broadcast()
457 close(t.gotMetainfoC)
458 t.updateWantPeersEvent()
459 t.pendingRequests = make(map[RequestIndex]*Peer)
460 t.lastRequested = make(map[RequestIndex]time.Time)
461 t.tryCreateMorePieceHashers()
462 t.iterPeers(func(p *Peer) {
464 p.updateRequests("onSetInfo")
468 // Called when metadata for a torrent becomes available.
469 func (t *Torrent) setInfoBytesLocked(b []byte) error {
470 if metainfo.HashBytes(b) != t.infoHash {
471 return errors.New("info bytes have wrong hash")
473 var info metainfo.Info
474 if err := bencode.Unmarshal(b, &info); err != nil {
475 return fmt.Errorf("error unmarshalling info bytes: %s", err)
478 t.metadataCompletedChunks = nil
482 if err := t.setInfo(&info); err != nil {
489 func (t *Torrent) haveAllMetadataPieces() bool {
493 if t.metadataCompletedChunks == nil {
496 for _, have := range t.metadataCompletedChunks {
504 // TODO: Propagate errors to disconnect peer.
505 func (t *Torrent) setMetadataSize(size int) (err error) {
507 // We already know the correct metadata size.
510 if uint32(size) > maxMetadataSize {
511 return errors.New("bad size")
513 if len(t.metadataBytes) == size {
516 t.metadataBytes = make([]byte, size)
517 t.metadataCompletedChunks = make([]bool, (size+(1<<14)-1)/(1<<14))
518 t.metadataChanged.Broadcast()
519 for c := range t.conns {
520 c.requestPendingMetadata()
525 // The current working name for the torrent. Either the name in the info dict,
526 // or a display name given such as by the dn value in a magnet link, or "".
527 func (t *Torrent) name() string {
529 defer t.nameMu.RUnlock()
533 if t.displayName != "" {
536 return "infohash:" + t.infoHash.HexString()
539 func (t *Torrent) pieceState(index pieceIndex) (ret PieceState) {
540 p := &t.pieces[index]
541 ret.Priority = t.piecePriority(index)
542 ret.Completion = p.completion()
543 ret.QueuedForHash = p.queuedForHash()
544 ret.Hashing = p.hashing
545 ret.Checking = ret.QueuedForHash || ret.Hashing
546 ret.Marking = p.marking
547 if !ret.Complete && t.piecePartiallyDownloaded(index) {
553 func (t *Torrent) metadataPieceSize(piece int) int {
554 return metadataPieceSize(len(t.metadataBytes), piece)
557 func (t *Torrent) newMetadataExtensionMessage(c *PeerConn, msgType pp.ExtendedMetadataRequestMsgType, piece int, data []byte) pp.Message {
560 ExtendedID: c.PeerExtensionIDs[pp.ExtensionNameMetadata],
561 ExtendedPayload: append(bencode.MustMarshal(pp.ExtendedMetadataRequestMsg{
563 TotalSize: len(t.metadataBytes),
569 type pieceAvailabilityRun struct {
574 func (me pieceAvailabilityRun) String() string {
575 return fmt.Sprintf("%v(%v)", me.count, me.availability)
578 func (t *Torrent) pieceAvailabilityRuns() (ret []pieceAvailabilityRun) {
579 rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
580 ret = append(ret, pieceAvailabilityRun{availability: el.(int64), count: int(count)})
582 for i := range t.pieces {
583 rle.Append(t.pieces[i].availability, 1)
589 func (t *Torrent) pieceStateRuns() (ret PieceStateRuns) {
590 rle := missinggo.NewRunLengthEncoder(func(el interface{}, count uint64) {
591 ret = append(ret, PieceStateRun{
592 PieceState: el.(PieceState),
596 for index := range t.pieces {
597 rle.Append(t.pieceState(pieceIndex(index)), 1)
603 // Produces a small string representing a PieceStateRun.
604 func (psr PieceStateRun) String() (ret string) {
605 ret = fmt.Sprintf("%d", psr.Length)
606 ret += func() string {
607 switch psr.Priority {
608 case PiecePriorityNext:
610 case PiecePriorityNormal:
612 case PiecePriorityReadahead:
614 case PiecePriorityNow:
616 case PiecePriorityHigh:
625 if psr.QueuedForHash {
643 func (t *Torrent) writeStatus(w io.Writer) {
644 fmt.Fprintf(w, "Infohash: %s\n", t.infoHash.HexString())
645 fmt.Fprintf(w, "Metadata length: %d\n", t.metadataSize())
647 fmt.Fprintf(w, "Metadata have: ")
648 for _, h := range t.metadataCompletedChunks {
649 fmt.Fprintf(w, "%c", func() rune {
659 fmt.Fprintf(w, "Piece length: %s\n",
662 return fmt.Sprintf("%v (%v chunks)",
664 float64(t.usualPieceSize())/float64(t.chunkSize))
671 fmt.Fprintf(w, "Num Pieces: %d (%d completed)\n", t.numPieces(), t.numPiecesCompleted())
672 fmt.Fprintf(w, "Piece States: %s\n", t.pieceStateRuns())
673 fmt.Fprintf(w, "Piece availability: %v\n", strings.Join(func() (ret []string) {
674 for _, run := range t.pieceAvailabilityRuns() {
675 ret = append(ret, run.String())
680 fmt.Fprintf(w, "Reader Pieces:")
681 t.forReaderOffsetPieces(func(begin, end pieceIndex) (again bool) {
682 fmt.Fprintf(w, " %d:%d", begin, end)
687 fmt.Fprintf(w, "Enabled trackers:\n")
689 tw := tabwriter.NewWriter(w, 0, 0, 2, ' ', 0)
690 fmt.Fprintf(tw, " URL\tExtra\n")
691 for _, ta := range slices.Sort(slices.FromMapElems(t.trackerAnnouncers), func(l, r torrentTrackerAnnouncer) bool {
694 var luns, runs url.URL = *lu, *ru
697 var ml missinggo.MultiLess
698 ml.StrictNext(luns.String() == runs.String(), luns.String() < runs.String())
699 ml.StrictNext(lu.String() == ru.String(), lu.String() < ru.String())
701 }).([]torrentTrackerAnnouncer) {
702 fmt.Fprintf(tw, " %q\t%v\n", ta.URL(), ta.statusLine())
707 fmt.Fprintf(w, "DHT Announces: %d\n", t.numDHTAnnounces)
709 spew.NewDefaultConfig()
710 spew.Fdump(w, t.statsLocked())
712 peers := t.peersAsSlice()
713 sort.Slice(peers, func(_i, _j int) bool {
716 if less, ok := multiless.New().EagerSameLess(
717 i.downloadRate() == j.downloadRate(), i.downloadRate() < j.downloadRate(),
721 return worseConn(i, j)
723 for i, c := range peers {
724 fmt.Fprintf(w, "%2d. ", i+1)
729 func (t *Torrent) haveInfo() bool {
733 // Returns a run-time generated MetaInfo that includes the info bytes and
734 // announce-list as currently known to the client.
735 func (t *Torrent) newMetaInfo() metainfo.MetaInfo {
736 return metainfo.MetaInfo{
737 CreationDate: time.Now().Unix(),
738 Comment: "dynamic metainfo from client",
739 CreatedBy: "go.torrent",
740 AnnounceList: t.metainfo.UpvertedAnnounceList().Clone(),
741 InfoBytes: func() []byte {
743 return t.metadataBytes
748 UrlList: func() []string {
749 ret := make([]string, 0, len(t.webSeeds))
750 for url := range t.webSeeds {
751 ret = append(ret, url)
759 func (t *Torrent) BytesMissing() (n int64) {
761 n = t.bytesMissingLocked()
766 func (t *Torrent) bytesMissingLocked() int64 {
770 func iterFlipped(b *roaring.Bitmap, end uint64, cb func(uint32) bool) {
771 roaring.Flip(b, 0, end).Iterate(cb)
774 func (t *Torrent) bytesLeft() (left int64) {
775 iterFlipped(&t._completedPieces, uint64(t.numPieces()), func(x uint32) bool {
776 p := t.piece(pieceIndex(x))
777 left += int64(p.length() - p.numDirtyBytes())
783 // Bytes left to give in tracker announces.
784 func (t *Torrent) bytesLeftAnnounce() int64 {
792 func (t *Torrent) piecePartiallyDownloaded(piece pieceIndex) bool {
793 if t.pieceComplete(piece) {
796 if t.pieceAllDirty(piece) {
799 return t.pieces[piece].hasDirtyChunks()
802 func (t *Torrent) usualPieceSize() int {
803 return int(t.info.PieceLength)
806 func (t *Torrent) numPieces() pieceIndex {
807 return pieceIndex(t.info.NumPieces())
810 func (t *Torrent) numPiecesCompleted() (num pieceIndex) {
811 return pieceIndex(t._completedPieces.GetCardinality())
814 func (t *Torrent) close(wg *sync.WaitGroup) (err error) {
816 if t.storage != nil {
821 defer t.storageLock.Unlock()
822 if f := t.storage.Close; f != nil {
825 t.logger.WithDefaultLevel(log.Warning).Printf("error closing storage: %v", err1)
830 t.iterPeers(func(p *Peer) {
833 if t.storage != nil {
834 t.deletePieceRequestOrder()
837 t.cl.event.Broadcast()
838 t.pieceStateChanges.Close()
839 t.updateWantPeersEvent()
843 func (t *Torrent) requestOffset(r Request) int64 {
844 return torrentRequestOffset(*t.length, int64(t.usualPieceSize()), r)
847 // Return the request that would include the given offset into the torrent data. Returns !ok if
848 // there is no such request.
849 func (t *Torrent) offsetRequest(off int64) (req Request, ok bool) {
850 return torrentOffsetRequest(*t.length, t.info.PieceLength, int64(t.chunkSize), off)
853 func (t *Torrent) writeChunk(piece int, begin int64, data []byte) (err error) {
854 defer perf.ScopeTimerErr(&err)()
855 n, err := t.pieces[piece].Storage().WriteAt(data, begin)
856 if err == nil && n != len(data) {
857 err = io.ErrShortWrite
862 func (t *Torrent) bitfield() (bf []bool) {
863 bf = make([]bool, t.numPieces())
864 t._completedPieces.Iterate(func(piece uint32) (again bool) {
871 func (t *Torrent) pieceNumChunks(piece pieceIndex) chunkIndexType {
872 return chunkIndexType((t.pieceLength(piece) + t.chunkSize - 1) / t.chunkSize)
875 func (t *Torrent) chunksPerRegularPiece() uint32 {
876 return uint32((pp.Integer(t.usualPieceSize()) + t.chunkSize - 1) / t.chunkSize)
879 func (t *Torrent) numRequests() RequestIndex {
880 if t.numPieces() == 0 {
883 return uint32(t.numPieces()-1)*t.chunksPerRegularPiece() + t.pieceNumChunks(t.numPieces()-1)
886 func (t *Torrent) pendAllChunkSpecs(pieceIndex pieceIndex) {
887 t.dirtyChunks.RemoveRange(
888 uint64(t.pieceRequestIndexOffset(pieceIndex)),
889 uint64(t.pieceRequestIndexOffset(pieceIndex+1)))
892 func (t *Torrent) pieceLength(piece pieceIndex) pp.Integer {
893 if t.info.PieceLength == 0 {
894 // There will be no variance amongst pieces. Only pain.
897 if piece == t.numPieces()-1 {
898 ret := pp.Integer(*t.length % t.info.PieceLength)
903 return pp.Integer(t.info.PieceLength)
906 func (t *Torrent) hashPiece(piece pieceIndex) (ret metainfo.Hash, err error) {
908 p.waitNoPendingWrites()
909 storagePiece := t.pieces[piece].Storage()
911 // Does the backend want to do its own hashing?
912 if i, ok := storagePiece.PieceImpl.(storage.SelfHashing); ok {
913 var sum metainfo.Hash
914 // log.Printf("A piece decided to self-hash: %d", piece)
915 sum, err = i.SelfHash()
916 missinggo.CopyExact(&ret, sum)
920 hash := pieceHash.New()
921 const logPieceContents = false
922 if logPieceContents {
923 var examineBuf bytes.Buffer
924 _, err = storagePiece.WriteTo(io.MultiWriter(hash, &examineBuf))
925 log.Printf("hashed %q with copy err %v", examineBuf.Bytes(), err)
927 _, err = storagePiece.WriteTo(hash)
929 missinggo.CopyExact(&ret, hash.Sum(nil))
933 func (t *Torrent) haveAnyPieces() bool {
934 return !t._completedPieces.IsEmpty()
937 func (t *Torrent) haveAllPieces() bool {
941 return t._completedPieces.GetCardinality() == bitmap.BitRange(t.numPieces())
944 func (t *Torrent) havePiece(index pieceIndex) bool {
945 return t.haveInfo() && t.pieceComplete(index)
948 func (t *Torrent) maybeDropMutuallyCompletePeer(
949 // I'm not sure about taking peer here, not all peer implementations actually drop. Maybe that's
953 if !t.cl.config.DropMutuallyCompletePeers {
956 if !t.haveAllPieces() {
959 if all, known := p.peerHasAllPieces(); !(known && all) {
965 t.logger.WithDefaultLevel(log.Debug).Printf("dropping %v, which is mutually complete", p)
969 func (t *Torrent) haveChunk(r Request) (ret bool) {
971 // log.Println("have chunk", r, ret)
976 if t.pieceComplete(pieceIndex(r.Index)) {
979 p := &t.pieces[r.Index]
980 return !p.pendingChunk(r.ChunkSpec, t.chunkSize)
983 func chunkIndexFromChunkSpec(cs ChunkSpec, chunkSize pp.Integer) chunkIndexType {
984 return chunkIndexType(cs.Begin / chunkSize)
987 func (t *Torrent) wantPieceIndex(index pieceIndex) bool {
988 return t._pendingPieces.Contains(uint32(index))
991 // A pool of []*PeerConn, to reduce allocations in functions that need to index or sort Torrent
992 // conns (which is a map).
993 var peerConnSlices sync.Pool
995 func getPeerConnSlice(cap int) []*PeerConn {
996 getInterface := peerConnSlices.Get()
997 if getInterface == nil {
998 return make([]*PeerConn, 0, cap)
1000 return getInterface.([]*PeerConn)[:0]
1004 // The worst connection is one that hasn't been sent, or sent anything useful for the longest. A bad
1005 // connection is one that usually sends us unwanted pieces, or has been in the worse half of the
1006 // established connections for more than a minute. This is O(n log n). If there was a way to not
1007 // consider the position of a conn relative to the total number, it could be reduced to O(n).
1008 func (t *Torrent) worstBadConn() (ret *PeerConn) {
1009 wcs := worseConnSlice{conns: t.appendUnclosedConns(getPeerConnSlice(len(t.conns)))}
1010 defer peerConnSlices.Put(wcs.conns)
1013 for wcs.Len() != 0 {
1014 c := heap.Pop(&wcs).(*PeerConn)
1015 if c._stats.ChunksReadWasted.Int64() >= 6 && c._stats.ChunksReadWasted.Int64() > c._stats.ChunksReadUseful.Int64() {
1018 // If the connection is in the worst half of the established
1019 // connection quota and is older than a minute.
1020 if wcs.Len() >= (t.maxEstablishedConns+1)/2 {
1021 // Give connections 1 minute to prove themselves.
1022 if time.Since(c.completedHandshake) > time.Minute {
1030 type PieceStateChange struct {
1035 func (t *Torrent) publishPieceChange(piece pieceIndex) {
1036 t.cl._mu.Defer(func() {
1037 cur := t.pieceState(piece)
1038 p := &t.pieces[piece]
1039 if cur != p.publicPieceState {
1040 p.publicPieceState = cur
1041 t.pieceStateChanges.Publish(PieceStateChange{
1049 func (t *Torrent) pieceNumPendingChunks(piece pieceIndex) pp.Integer {
1050 if t.pieceComplete(piece) {
1053 return pp.Integer(t.pieceNumChunks(piece) - t.pieces[piece].numDirtyChunks())
1056 func (t *Torrent) pieceAllDirty(piece pieceIndex) bool {
1057 return t.pieces[piece].allChunksDirty()
1060 func (t *Torrent) readersChanged() {
1061 t.updateReaderPieces()
1062 t.updateAllPiecePriorities("Torrent.readersChanged")
1065 func (t *Torrent) updateReaderPieces() {
1066 t._readerNowPieces, t._readerReadaheadPieces = t.readerPiecePriorities()
1069 func (t *Torrent) readerPosChanged(from, to pieceRange) {
1073 t.updateReaderPieces()
1074 // Order the ranges, high and low.
1076 if l.begin > h.begin {
1079 if l.end < h.begin {
1080 // Two distinct ranges.
1081 t.updatePiecePriorities(l.begin, l.end, "Torrent.readerPosChanged")
1082 t.updatePiecePriorities(h.begin, h.end, "Torrent.readerPosChanged")
1089 t.updatePiecePriorities(l.begin, end, "Torrent.readerPosChanged")
1093 func (t *Torrent) maybeNewConns() {
1094 // Tickle the accept routine.
1095 t.cl.event.Broadcast()
1099 func (t *Torrent) piecePriorityChanged(piece pieceIndex, reason string) {
1100 if t._pendingPieces.Contains(uint32(piece)) {
1101 t.iterPeers(func(c *Peer) {
1102 // if c.requestState.Interested {
1105 if !c.isLowOnRequests() {
1108 if !c.peerHasPiece(piece) {
1111 if c.peerChoking && !c.peerAllowedFast.Contains(uint32(piece)) {
1114 c.updateRequests(reason)
1118 t.publishPieceChange(piece)
1121 func (t *Torrent) updatePiecePriority(piece pieceIndex, reason string) {
1122 if !t.closed.IsSet() {
1123 // It would be possible to filter on pure-priority changes here to avoid churning the piece
1125 t.updatePieceRequestOrder(piece)
1127 p := &t.pieces[piece]
1128 newPrio := p.uncachedPriority()
1129 // t.logger.Printf("torrent %p: piece %d: uncached priority: %v", t, piece, newPrio)
1130 if newPrio == PiecePriorityNone {
1131 if !t._pendingPieces.CheckedRemove(uint32(piece)) {
1135 if !t._pendingPieces.CheckedAdd(uint32(piece)) {
1139 t.piecePriorityChanged(piece, reason)
1142 func (t *Torrent) updateAllPiecePriorities(reason string) {
1143 t.updatePiecePriorities(0, t.numPieces(), reason)
1146 // Update all piece priorities in one hit. This function should have the same
1147 // output as updatePiecePriority, but across all pieces.
1148 func (t *Torrent) updatePiecePriorities(begin, end pieceIndex, reason string) {
1149 for i := begin; i < end; i++ {
1150 t.updatePiecePriority(i, reason)
1154 // Returns the range of pieces [begin, end) that contains the extent of bytes.
1155 func (t *Torrent) byteRegionPieces(off, size int64) (begin, end pieceIndex) {
1156 if off >= *t.length {
1166 begin = pieceIndex(off / t.info.PieceLength)
1167 end = pieceIndex((off + size + t.info.PieceLength - 1) / t.info.PieceLength)
1168 if end > pieceIndex(t.info.NumPieces()) {
1169 end = pieceIndex(t.info.NumPieces())
1174 // Returns true if all iterations complete without breaking. Returns the read regions for all
1175 // readers. The reader regions should not be merged as some callers depend on this method to
1176 // enumerate readers.
1177 func (t *Torrent) forReaderOffsetPieces(f func(begin, end pieceIndex) (more bool)) (all bool) {
1178 for r := range t.readers {
1180 if p.begin >= p.end {
1183 if !f(p.begin, p.end) {
1190 func (t *Torrent) piecePriority(piece pieceIndex) piecePriority {
1191 return t.piece(piece).uncachedPriority()
1194 func (t *Torrent) pendRequest(req RequestIndex) {
1195 t.piece(int(req / t.chunksPerRegularPiece())).pendChunkIndex(req % t.chunksPerRegularPiece())
1198 func (t *Torrent) pieceCompletionChanged(piece pieceIndex, reason string) {
1199 t.cl.event.Broadcast()
1200 if t.pieceComplete(piece) {
1201 t.onPieceCompleted(piece)
1203 t.onIncompletePiece(piece)
1205 t.updatePiecePriority(piece, reason)
1208 func (t *Torrent) numReceivedConns() (ret int) {
1209 for c := range t.conns {
1210 if c.Discovery == PeerSourceIncoming {
1217 func (t *Torrent) maxHalfOpen() int {
1218 // Note that if we somehow exceed the maximum established conns, we want
1219 // the negative value to have an effect.
1220 establishedHeadroom := int64(t.maxEstablishedConns - len(t.conns))
1221 extraIncoming := int64(t.numReceivedConns() - t.maxEstablishedConns/2)
1222 // We want to allow some experimentation with new peers, and to try to
1223 // upset an oversupply of received connections.
1224 return int(min(max(5, extraIncoming)+establishedHeadroom, int64(t.cl.config.HalfOpenConnsPerTorrent)))
1227 func (t *Torrent) openNewConns() (initiated int) {
1228 defer t.updateWantPeersEvent()
1229 for t.peers.Len() != 0 {
1233 if len(t.halfOpen) >= t.maxHalfOpen() {
1236 if len(t.cl.dialers) == 0 {
1239 if t.cl.numHalfOpen >= t.cl.config.TotalHalfOpenConns {
1242 p := t.peers.PopMax()
1249 func (t *Torrent) updatePieceCompletion(piece pieceIndex) bool {
1251 uncached := t.pieceCompleteUncached(piece)
1252 cached := p.completion()
1253 changed := cached != uncached
1254 complete := uncached.Complete
1255 p.storageCompletionOk = uncached.Ok
1258 t._completedPieces.Add(x)
1261 t._completedPieces.Remove(x)
1263 p.t.updatePieceRequestOrder(piece)
1265 if complete && len(p.dirtiers) != 0 {
1266 t.logger.Printf("marked piece %v complete but still has dirtiers", piece)
1269 log.Fstr("piece %d completion changed: %+v -> %+v", piece, cached, uncached).SetLevel(log.Debug).Log(t.logger)
1270 t.pieceCompletionChanged(piece, "Torrent.updatePieceCompletion")
1275 // Non-blocking read. Client lock is not required.
1276 func (t *Torrent) readAt(b []byte, off int64) (n int, err error) {
1278 p := &t.pieces[off/t.info.PieceLength]
1279 p.waitNoPendingWrites()
1281 n1, err = p.Storage().ReadAt(b, off-p.Info().Offset())
1292 // Returns an error if the metadata was completed, but couldn't be set for some reason. Blame it on
1293 // the last peer to contribute. TODO: Actually we shouldn't blame peers for failure to open storage
1294 // etc. Also we should probably cached metadata pieces per-Peer, to isolate failure appropriately.
1295 func (t *Torrent) maybeCompleteMetadata() error {
1300 if !t.haveAllMetadataPieces() {
1301 // Don't have enough metadata pieces.
1304 err := t.setInfoBytesLocked(t.metadataBytes)
1306 t.invalidateMetadata()
1307 return fmt.Errorf("error setting info bytes: %s", err)
1309 if t.cl.config.Debug {
1310 t.logger.Printf("%s: got metadata from peers", t)
1315 func (t *Torrent) readerPiecePriorities() (now, readahead bitmap.Bitmap) {
1316 t.forReaderOffsetPieces(func(begin, end pieceIndex) bool {
1318 now.Add(bitmap.BitIndex(begin))
1319 readahead.AddRange(bitmap.BitRange(begin)+1, bitmap.BitRange(end))
1326 func (t *Torrent) needData() bool {
1327 if t.closed.IsSet() {
1333 return !t._pendingPieces.IsEmpty()
1336 func appendMissingStrings(old, new []string) (ret []string) {
1339 for _, n := range new {
1340 for _, o := range old {
1345 ret = append(ret, n)
1350 func appendMissingTrackerTiers(existing [][]string, minNumTiers int) (ret [][]string) {
1352 for minNumTiers > len(ret) {
1353 ret = append(ret, nil)
1358 func (t *Torrent) addTrackers(announceList [][]string) {
1359 fullAnnounceList := &t.metainfo.AnnounceList
1360 t.metainfo.AnnounceList = appendMissingTrackerTiers(*fullAnnounceList, len(announceList))
1361 for tierIndex, trackerURLs := range announceList {
1362 (*fullAnnounceList)[tierIndex] = appendMissingStrings((*fullAnnounceList)[tierIndex], trackerURLs)
1364 t.startMissingTrackerScrapers()
1365 t.updateWantPeersEvent()
1368 // Don't call this before the info is available.
1369 func (t *Torrent) bytesCompleted() int64 {
1373 return *t.length - t.bytesLeft()
1376 func (t *Torrent) SetInfoBytes(b []byte) (err error) {
1379 return t.setInfoBytesLocked(b)
1382 // Returns true if connection is removed from torrent.Conns.
1383 func (t *Torrent) deletePeerConn(c *PeerConn) (ret bool) {
1384 if !c.closed.IsSet() {
1385 panic("connection is not closed")
1386 // There are behaviours prevented by the closed state that will fail
1387 // if the connection has been deleted.
1391 // Avoid adding a drop event more than once. Probably we should track whether we've generated
1392 // the drop event against the PexConnState instead.
1394 if !t.cl.config.DisablePEX {
1398 torrent.Add("deleted connections", 1)
1399 c.deleteAllRequests()
1400 t.assertPendingRequests()
1404 func (t *Torrent) decPeerPieceAvailability(p *Peer) {
1408 p.newPeerPieces().Iterate(func(i uint32) bool {
1409 p.t.decPieceAvailability(pieceIndex(i))
1414 func (t *Torrent) assertPendingRequests() {
1418 // var actual pendingRequests
1419 // if t.haveInfo() {
1420 // actual.m = make([]int, t.numRequests())
1422 // t.iterPeers(func(p *Peer) {
1423 // p.requestState.Requests.Iterate(func(x uint32) bool {
1428 // diff := cmp.Diff(actual.m, t.pendingRequests.m)
1434 func (t *Torrent) dropConnection(c *PeerConn) {
1435 t.cl.event.Broadcast()
1437 if t.deletePeerConn(c) {
1442 // Peers as in contact information for dialing out.
1443 func (t *Torrent) wantPeers() bool {
1444 if t.closed.IsSet() {
1447 if t.peers.Len() > t.cl.config.TorrentPeersLowWater {
1450 return t.wantConns()
1453 func (t *Torrent) updateWantPeersEvent() {
1455 t.wantPeersEvent.Set()
1457 t.wantPeersEvent.Clear()
1461 // Returns whether the client should make effort to seed the torrent.
1462 func (t *Torrent) seeding() bool {
1464 if t.closed.IsSet() {
1467 if t.dataUploadDisallowed {
1470 if cl.config.NoUpload {
1473 if !cl.config.Seed {
1476 if cl.config.DisableAggressiveUpload && t.needData() {
1482 func (t *Torrent) onWebRtcConn(
1483 c datachannel.ReadWriteCloser,
1484 dcc webtorrent.DataChannelContext,
1487 pc, err := t.cl.initiateProtocolHandshakes(
1488 context.Background(),
1489 webrtcNetConn{c, dcc},
1493 webrtcNetAddr{dcc.Remote},
1495 fmt.Sprintf("webrtc offer_id %x", dcc.OfferId),
1498 t.logger.WithDefaultLevel(log.Error).Printf("error in handshaking webrtc connection: %v", err)
1501 if dcc.LocalOffered {
1502 pc.Discovery = PeerSourceTracker
1504 pc.Discovery = PeerSourceIncoming
1506 pc.conn.SetWriteDeadline(time.Time{})
1509 err = t.cl.runHandshookConn(pc, t)
1511 t.logger.WithDefaultLevel(log.Critical).Printf("error running handshook webrtc conn: %v", err)
1515 func (t *Torrent) logRunHandshookConn(pc *PeerConn, logAll bool, level log.Level) {
1516 err := t.cl.runHandshookConn(pc, t)
1517 if err != nil || logAll {
1518 t.logger.WithDefaultLevel(level).Printf("error running handshook conn: %v", err)
1522 func (t *Torrent) runHandshookConnLoggingErr(pc *PeerConn) {
1523 t.logRunHandshookConn(pc, false, log.Debug)
1526 func (t *Torrent) startWebsocketAnnouncer(u url.URL) torrentTrackerAnnouncer {
1527 wtc, release := t.cl.websocketTrackers.Get(u.String())
1532 wst := websocketTrackerStatus{u, wtc}
1534 err := wtc.Announce(tracker.Started, t.infoHash)
1536 t.logger.WithDefaultLevel(log.Warning).Printf(
1537 "error in initial announce to %q: %v",
1545 func (t *Torrent) startScrapingTracker(_url string) {
1549 u, err := url.Parse(_url)
1551 // URLs with a leading '*' appear to be a uTorrent convention to
1552 // disable trackers.
1554 log.Str("error parsing tracker url").AddValues("url", _url).Log(t.logger)
1558 if u.Scheme == "udp" {
1560 t.startScrapingTracker(u.String())
1562 t.startScrapingTracker(u.String())
1565 if _, ok := t.trackerAnnouncers[_url]; ok {
1568 sl := func() torrentTrackerAnnouncer {
1571 if t.cl.config.DisableWebtorrent {
1574 return t.startWebsocketAnnouncer(*u)
1576 if t.cl.config.DisableIPv4Peers || t.cl.config.DisableIPv4 {
1580 if t.cl.config.DisableIPv6 {
1584 newAnnouncer := &trackerScraper{
1587 lookupTrackerIp: t.cl.config.LookupTrackerIp,
1589 go newAnnouncer.Run()
1595 if t.trackerAnnouncers == nil {
1596 t.trackerAnnouncers = make(map[string]torrentTrackerAnnouncer)
1598 t.trackerAnnouncers[_url] = sl
1601 // Adds and starts tracker scrapers for tracker URLs that aren't already
1603 func (t *Torrent) startMissingTrackerScrapers() {
1604 if t.cl.config.DisableTrackers {
1607 t.startScrapingTracker(t.metainfo.Announce)
1608 for _, tier := range t.metainfo.AnnounceList {
1609 for _, url := range tier {
1610 t.startScrapingTracker(url)
1615 // Returns an AnnounceRequest with fields filled out to defaults and current
1617 func (t *Torrent) announceRequest(event tracker.AnnounceEvent) tracker.AnnounceRequest {
1618 // Note that IPAddress is not set. It's set for UDP inside the tracker code, since it's
1619 // dependent on the network in use.
1620 return tracker.AnnounceRequest{
1622 NumWant: func() int32 {
1623 if t.wantPeers() && len(t.cl.dialers) > 0 {
1629 Port: uint16(t.cl.incomingPeerPort()),
1630 PeerId: t.cl.peerID,
1631 InfoHash: t.infoHash,
1632 Key: t.cl.announceKey(),
1634 // The following are vaguely described in BEP 3.
1636 Left: t.bytesLeftAnnounce(),
1637 Uploaded: t.stats.BytesWrittenData.Int64(),
1638 // There's no mention of wasted or unwanted download in the BEP.
1639 Downloaded: t.stats.BytesReadUsefulData.Int64(),
1643 // Adds peers revealed in an announce until the announce ends, or we have
1645 func (t *Torrent) consumeDhtAnnouncePeers(pvs <-chan dht.PeersValues) {
1647 for v := range pvs {
1650 for _, cp := range v.Peers {
1652 // Can't do anything with this.
1655 if t.addPeer(PeerInfo{
1656 Addr: ipPortAddr{cp.IP, cp.Port},
1657 Source: PeerSourceDhtGetPeers,
1664 // log.Printf("added %v peers from dht for %v", added, t.InfoHash().HexString())
1669 // Announce using the provided DHT server. Peers are consumed automatically. done is closed when the
1670 // announce ends. stop will force the announce to end.
1671 func (t *Torrent) AnnounceToDht(s DhtServer) (done <-chan struct{}, stop func(), err error) {
1672 ps, err := s.Announce(t.infoHash, t.cl.incomingPeerPort(), true)
1676 _done := make(chan struct{})
1680 t.consumeDhtAnnouncePeers(ps.Peers())
1686 func (t *Torrent) timeboxedAnnounceToDht(s DhtServer) error {
1687 _, stop, err := t.AnnounceToDht(s)
1692 case <-t.closed.Done():
1693 case <-time.After(5 * time.Minute):
1699 func (t *Torrent) dhtAnnouncer(s DhtServer) {
1705 if t.closed.IsSet() {
1708 // We're also announcing ourselves as a listener, so we don't just want peer addresses.
1709 // TODO: We can include the announce_peer step depending on whether we can receive
1710 // inbound connections. We should probably only announce once every 15 mins too.
1714 // TODO: Determine if there's a listener on the port we're announcing.
1715 if len(cl.dialers) == 0 && len(cl.listeners) == 0 {
1726 err := t.timeboxedAnnounceToDht(s)
1728 t.logger.WithDefaultLevel(log.Warning).Printf("error announcing %q to DHT: %s", t, err)
1734 func (t *Torrent) addPeers(peers []PeerInfo) (added int) {
1735 for _, p := range peers {
1743 // The returned TorrentStats may require alignment in memory. See
1744 // https://github.com/anacrolix/torrent/issues/383.
1745 func (t *Torrent) Stats() TorrentStats {
1747 defer t.cl.rUnlock()
1748 return t.statsLocked()
1751 func (t *Torrent) statsLocked() (ret TorrentStats) {
1752 ret.ActivePeers = len(t.conns)
1753 ret.HalfOpenPeers = len(t.halfOpen)
1754 ret.PendingPeers = t.peers.Len()
1755 ret.TotalPeers = t.numTotalPeers()
1756 ret.ConnectedSeeders = 0
1757 for c := range t.conns {
1758 if all, ok := c.peerHasAllPieces(); all && ok {
1759 ret.ConnectedSeeders++
1762 ret.ConnStats = t.stats.Copy()
1763 ret.PiecesComplete = t.numPiecesCompleted()
1767 // The total number of peers in the torrent.
1768 func (t *Torrent) numTotalPeers() int {
1769 peers := make(map[string]struct{})
1770 for conn := range t.conns {
1771 ra := conn.conn.RemoteAddr()
1773 // It's been closed and doesn't support RemoteAddr.
1776 peers[ra.String()] = struct{}{}
1778 for addr := range t.halfOpen {
1779 peers[addr] = struct{}{}
1781 t.peers.Each(func(peer PeerInfo) {
1782 peers[peer.Addr.String()] = struct{}{}
1787 // Reconcile bytes transferred before connection was associated with a
1789 func (t *Torrent) reconcileHandshakeStats(c *PeerConn) {
1790 if c._stats != (ConnStats{
1791 // Handshakes should only increment these fields:
1792 BytesWritten: c._stats.BytesWritten,
1793 BytesRead: c._stats.BytesRead,
1797 c.postHandshakeStats(func(cs *ConnStats) {
1798 cs.BytesRead.Add(c._stats.BytesRead.Int64())
1799 cs.BytesWritten.Add(c._stats.BytesWritten.Int64())
1801 c.reconciledHandshakeStats = true
1804 // Returns true if the connection is added.
1805 func (t *Torrent) addPeerConn(c *PeerConn) (err error) {
1808 torrent.Add("added connections", 1)
1811 if t.closed.IsSet() {
1812 return errors.New("torrent closed")
1814 for c0 := range t.conns {
1815 if c.PeerID != c0.PeerID {
1818 if !t.cl.config.DropDuplicatePeerIds {
1821 if left, ok := c.hasPreferredNetworkOver(c0); ok && left {
1823 t.deletePeerConn(c0)
1825 return errors.New("existing connection preferred")
1828 if len(t.conns) >= t.maxEstablishedConns {
1829 c := t.worstBadConn()
1831 return errors.New("don't want conns")
1836 if len(t.conns) >= t.maxEstablishedConns {
1839 t.conns[c] = struct{}{}
1840 if !t.cl.config.DisablePEX && !c.PeerExtensionBytes.SupportsExtended() {
1841 t.pex.Add(c) // as no further extended handshake expected
1846 func (t *Torrent) wantConns() bool {
1847 if !t.networkingEnabled.Bool() {
1850 if t.closed.IsSet() {
1853 if !t.needData() && (!t.seeding() || !t.haveAnyPieces()) {
1856 return len(t.conns) < t.maxEstablishedConns || t.worstBadConn() != nil
1859 func (t *Torrent) SetMaxEstablishedConns(max int) (oldMax int) {
1862 oldMax = t.maxEstablishedConns
1863 t.maxEstablishedConns = max
1864 wcs := worseConnSlice{
1865 conns: t.appendConns(nil, func(*PeerConn) bool {
1871 for len(t.conns) > t.maxEstablishedConns && wcs.Len() > 0 {
1872 t.dropConnection(heap.Pop(&wcs).(*PeerConn))
1878 func (t *Torrent) pieceHashed(piece pieceIndex, passed bool, hashIoErr error) {
1879 t.logger.Log(log.Fstr("hashed piece %d (passed=%t)", piece, passed).SetLevel(log.Debug))
1882 t.cl.event.Broadcast()
1883 if t.closed.IsSet() {
1887 // Don't score the first time a piece is hashed, it could be an initial check.
1888 if p.storageCompletionOk {
1890 pieceHashedCorrect.Add(1)
1893 "piece %d failed hash: %d connections contributed", piece, len(p.dirtiers),
1894 ).AddValues(t, p).SetLevel(log.Debug).Log(t.logger)
1895 pieceHashedNotCorrect.Add(1)
1900 t.publishPieceChange(piece)
1903 t.publishPieceChange(piece)
1907 if len(p.dirtiers) != 0 {
1908 // Don't increment stats above connection-level for every involved connection.
1909 t.allStats((*ConnStats).incrementPiecesDirtiedGood)
1911 for c := range p.dirtiers {
1912 c._stats.incrementPiecesDirtiedGood()
1914 t.clearPieceTouchers(piece)
1916 err := p.Storage().MarkComplete()
1918 t.logger.Printf("%T: error marking piece complete %d: %s", t.storage, piece, err)
1922 if t.closed.IsSet() {
1925 t.pendAllChunkSpecs(piece)
1927 if len(p.dirtiers) != 0 && p.allChunksDirty() && hashIoErr == nil {
1928 // Peers contributed to all the data for this piece hash failure, and the failure was
1929 // not due to errors in the storage (such as data being dropped in a cache).
1931 // Increment Torrent and above stats, and then specific connections.
1932 t.allStats((*ConnStats).incrementPiecesDirtiedBad)
1933 for c := range p.dirtiers {
1934 // Y u do dis peer?!
1935 c.stats().incrementPiecesDirtiedBad()
1938 bannableTouchers := make([]*Peer, 0, len(p.dirtiers))
1939 for c := range p.dirtiers {
1941 bannableTouchers = append(bannableTouchers, c)
1944 t.clearPieceTouchers(piece)
1945 slices.Sort(bannableTouchers, connLessTrusted)
1947 if t.cl.config.Debug {
1949 "bannable conns by trust for piece %d: %v",
1951 func() (ret []connectionTrust) {
1952 for _, c := range bannableTouchers {
1953 ret = append(ret, c.trust())
1960 if len(bannableTouchers) >= 1 {
1961 c := bannableTouchers[0]
1962 t.cl.banPeerIP(c.remoteIp())
1966 t.onIncompletePiece(piece)
1967 p.Storage().MarkNotComplete()
1969 t.updatePieceCompletion(piece)
1972 func (t *Torrent) cancelRequestsForPiece(piece pieceIndex) {
1973 // TODO: Make faster
1974 for cn := range t.conns {
1979 func (t *Torrent) onPieceCompleted(piece pieceIndex) {
1980 t.pendAllChunkSpecs(piece)
1981 t.cancelRequestsForPiece(piece)
1982 t.piece(piece).readerCond.Broadcast()
1983 for conn := range t.conns {
1985 t.maybeDropMutuallyCompletePeer(&conn.Peer)
1989 // Called when a piece is found to be not complete.
1990 func (t *Torrent) onIncompletePiece(piece pieceIndex) {
1991 if t.pieceAllDirty(piece) {
1992 t.pendAllChunkSpecs(piece)
1994 if !t.wantPieceIndex(piece) {
1995 // t.logger.Printf("piece %d incomplete and unwanted", piece)
1998 // We could drop any connections that we told we have a piece that we
1999 // don't here. But there's a test failure, and it seems clients don't care
2000 // if you request pieces that you already claim to have. Pruning bad
2001 // connections might just remove any connections that aren't treating us
2002 // favourably anyway.
2004 // for c := range t.conns {
2005 // if c.sentHave(piece) {
2009 t.iterPeers(func(conn *Peer) {
2010 if conn.peerHasPiece(piece) {
2011 conn.updateRequests("piece incomplete")
2016 func (t *Torrent) tryCreateMorePieceHashers() {
2017 for !t.closed.IsSet() && t.activePieceHashes < 2 && t.tryCreatePieceHasher() {
2021 func (t *Torrent) tryCreatePieceHasher() bool {
2022 if t.storage == nil {
2025 pi, ok := t.getPieceToHash()
2030 t.piecesQueuedForHash.Remove(bitmap.BitIndex(pi))
2032 t.publishPieceChange(pi)
2033 t.updatePiecePriority(pi, "Torrent.tryCreatePieceHasher")
2034 t.storageLock.RLock()
2035 t.activePieceHashes++
2036 go t.pieceHasher(pi)
2040 func (t *Torrent) getPieceToHash() (ret pieceIndex, ok bool) {
2041 t.piecesQueuedForHash.IterTyped(func(i pieceIndex) bool {
2042 if t.piece(i).hashing {
2052 func (t *Torrent) pieceHasher(index pieceIndex) {
2054 sum, copyErr := t.hashPiece(index)
2055 correct := sum == *p.hash
2059 log.Fmsg("piece %v (%s) hash failure copy error: %v", p, p.hash.HexString(), copyErr).Log(t.logger)
2061 t.storageLock.RUnlock()
2065 t.pieceHashed(index, correct, copyErr)
2066 t.updatePiecePriority(index, "Torrent.pieceHasher")
2067 t.activePieceHashes--
2068 t.tryCreateMorePieceHashers()
2071 // Return the connections that touched a piece, and clear the entries while doing it.
2072 func (t *Torrent) clearPieceTouchers(pi pieceIndex) {
2074 for c := range p.dirtiers {
2075 delete(c.peerTouchedPieces, pi)
2076 delete(p.dirtiers, c)
2080 func (t *Torrent) peersAsSlice() (ret []*Peer) {
2081 t.iterPeers(func(p *Peer) {
2082 ret = append(ret, p)
2087 func (t *Torrent) queuePieceCheck(pieceIndex pieceIndex) {
2088 piece := t.piece(pieceIndex)
2089 if piece.queuedForHash() {
2092 t.piecesQueuedForHash.Add(bitmap.BitIndex(pieceIndex))
2093 t.publishPieceChange(pieceIndex)
2094 t.updatePiecePriority(pieceIndex, "Torrent.queuePieceCheck")
2095 t.tryCreateMorePieceHashers()
2098 // Forces all the pieces to be re-hashed. See also Piece.VerifyData. This should not be called
2099 // before the Info is available.
2100 func (t *Torrent) VerifyData() {
2101 for i := pieceIndex(0); i < t.NumPieces(); i++ {
2102 t.Piece(i).VerifyData()
2106 // Start the process of connecting to the given peer for the given torrent if appropriate.
2107 func (t *Torrent) initiateConn(peer PeerInfo) {
2108 if peer.Id == t.cl.peerID {
2111 if t.cl.badPeerAddr(peer.Addr) && !peer.Trusted {
2115 if t.addrActive(addr.String()) {
2119 t.halfOpen[addr.String()] = peer
2120 go t.cl.outgoingConnection(t, addr, peer.Source, peer.Trusted)
2123 // Adds a trusted, pending peer for each of the given Client's addresses. Typically used in tests to
2124 // quickly make one Client visible to the Torrent of another Client.
2125 func (t *Torrent) AddClientPeer(cl *Client) int {
2126 return t.AddPeers(func() (ps []PeerInfo) {
2127 for _, la := range cl.ListenAddrs() {
2128 ps = append(ps, PeerInfo{
2137 // All stats that include this Torrent. Useful when we want to increment ConnStats but not for every
2139 func (t *Torrent) allStats(f func(*ConnStats)) {
2144 func (t *Torrent) hashingPiece(i pieceIndex) bool {
2145 return t.pieces[i].hashing
2148 func (t *Torrent) pieceQueuedForHash(i pieceIndex) bool {
2149 return t.piecesQueuedForHash.Get(bitmap.BitIndex(i))
2152 func (t *Torrent) dialTimeout() time.Duration {
2153 return reducedDialTimeout(t.cl.config.MinDialTimeout, t.cl.config.NominalDialTimeout, t.cl.config.HalfOpenConnsPerTorrent, t.peers.Len())
2156 func (t *Torrent) piece(i int) *Piece {
2160 func (t *Torrent) onWriteChunkErr(err error) {
2161 if t.userOnWriteChunkErr != nil {
2162 go t.userOnWriteChunkErr(err)
2165 t.logger.WithDefaultLevel(log.Critical).Printf("default chunk write error handler: disabling data download")
2166 t.disallowDataDownloadLocked()
2169 func (t *Torrent) DisallowDataDownload() {
2170 t.disallowDataDownloadLocked()
2173 func (t *Torrent) disallowDataDownloadLocked() {
2174 t.dataDownloadDisallowed.Set()
2177 func (t *Torrent) AllowDataDownload() {
2178 t.dataDownloadDisallowed.Clear()
2181 // Enables uploading data, if it was disabled.
2182 func (t *Torrent) AllowDataUpload() {
2185 t.dataUploadDisallowed = false
2186 for c := range t.conns {
2187 c.updateRequests("allow data upload")
2191 // Disables uploading data, if it was enabled.
2192 func (t *Torrent) DisallowDataUpload() {
2195 t.dataUploadDisallowed = true
2196 for c := range t.conns {
2197 c.updateRequests("disallow data upload")
2201 // Sets a handler that is called if there's an error writing a chunk to local storage. By default,
2202 // or if nil, a critical message is logged, and data download is disabled.
2203 func (t *Torrent) SetOnWriteChunkError(f func(error)) {
2206 t.userOnWriteChunkErr = f
2209 func (t *Torrent) iterPeers(f func(p *Peer)) {
2210 for pc := range t.conns {
2213 for _, ws := range t.webSeeds {
2218 func (t *Torrent) callbacks() *Callbacks {
2219 return &t.cl.config.Callbacks
2222 func (t *Torrent) addWebSeed(url string) {
2223 if t.cl.config.DisableWebseeds {
2226 if _, ok := t.webSeeds[url]; ok {
2229 // I don't think Go http supports pipelining requests. However, we can have more ready to go
2230 // right away. This value should be some multiple of the number of connections to a host. I
2231 // would expect that double maxRequests plus a bit would be appropriate. This value is based on
2232 // downloading Sintel (08ada5a7a6183aae1e09d831df6748d566095a10) from
2233 // "https://webtorrent.io/torrents/".
2234 const maxRequests = 16
2240 reconciledHandshakeStats: true,
2241 // This should affect how often we have to recompute requests for this peer. Note that
2242 // because we can request more than 1 thing at a time over HTTP, we will hit the low
2243 // requests mark more often, so recomputation is probably sooner than with regular peer
2244 // conns. ~4x maxRequests would be about right.
2245 PeerMaxRequests: 128,
2246 RemoteAddr: remoteAddrFromUrl(url),
2247 callbacks: t.callbacks(),
2249 client: webseed.Client{
2250 HttpClient: t.cl.webseedHttpClient,
2253 activeRequests: make(map[Request]webseed.Request, maxRequests),
2254 maxRequests: maxRequests,
2256 ws.peer.initUpdateRequestsTimer()
2257 ws.requesterCond.L = t.cl.locker()
2258 for i := 0; i < maxRequests; i += 1 {
2261 for _, f := range t.callbacks().NewPeer {
2264 ws.peer.logger = t.logger.WithContextValue(&ws)
2265 ws.peer.peerImpl = &ws
2267 ws.onGotInfo(t.info)
2269 t.webSeeds[url] = &ws.peer
2272 func (t *Torrent) peerIsActive(p *Peer) (active bool) {
2273 t.iterPeers(func(p1 *Peer) {
2281 func (t *Torrent) requestIndexToRequest(ri RequestIndex) Request {
2282 index := ri / t.chunksPerRegularPiece()
2285 t.piece(int(index)).chunkIndexSpec(ri % t.chunksPerRegularPiece()),
2289 func (t *Torrent) requestIndexFromRequest(r Request) RequestIndex {
2290 return t.pieceRequestIndexOffset(pieceIndex(r.Index)) + uint32(r.Begin/t.chunkSize)
2293 func (t *Torrent) pieceRequestIndexOffset(piece pieceIndex) RequestIndex {
2294 return RequestIndex(piece) * t.chunksPerRegularPiece()
2297 func (t *Torrent) updateComplete() {
2298 t.Complete.SetBool(t.haveAllPieces())
2301 func (t *Torrent) cancelRequest(r RequestIndex) *Peer {
2302 p := t.pendingRequests[r]
2306 delete(t.pendingRequests, r)
2310 func (t *Torrent) requestingPeer(r RequestIndex) *Peer {
2311 return t.pendingRequests[r]