16 "github.com/RoaringBitmap/roaring"
17 "github.com/anacrolix/log"
18 "github.com/anacrolix/missinggo/iter"
19 "github.com/anacrolix/missinggo/v2/bitmap"
20 "github.com/anacrolix/multiless"
22 "github.com/anacrolix/chansync"
23 "github.com/anacrolix/torrent/bencode"
24 "github.com/anacrolix/torrent/metainfo"
25 "github.com/anacrolix/torrent/mse"
26 pp "github.com/anacrolix/torrent/peer_protocol"
27 request_strategy "github.com/anacrolix/torrent/request-strategy"
30 type PeerSource string
33 PeerSourceTracker = "Tr"
34 PeerSourceIncoming = "I"
35 PeerSourceDhtGetPeers = "Hg" // Peers we found by searching a DHT.
36 PeerSourceDhtAnnouncePeer = "Ha" // Peers that were announced to us by a DHT.
38 // The peer was given directly, such as through a magnet link.
39 PeerSourceDirect = "M"
42 type peerRequestState struct {
46 type PeerRemoteAddr interface {
50 // Since we have to store all the requests in memory, we can't reasonably exceed what would be
51 // indexable with the memory space available.
54 requestState = request_strategy.PeerNextRequestState
58 // First to ensure 64-bit alignment for atomics. See #262.
68 RemoteAddr PeerRemoteAddr
69 // True if the connection is operating over MSE obfuscation.
71 cryptoMethod mse.CryptoMethod
74 closed chansync.SetOnce
75 // Set true after we've added our ConnStats generated during handshake to
76 // other ConnStat instances as determined when the *Torrent became known.
77 reconciledHandshakeStats bool
79 lastMessageReceived time.Time
80 completedHandshake time.Time
81 lastUsefulChunkReceived time.Time
82 lastChunkSent time.Time
84 // Stuff controlled by the local peer.
85 needRequestUpdate string
86 actualRequestState requestState
87 updateRequestsTimer *time.Timer
88 cancelledRequests roaring.Bitmap
89 lastBecameInterested time.Time
90 priorInterest time.Duration
92 lastStartedExpectingToReceiveChunks time.Time
93 cumulativeExpectedToReceiveChunks time.Duration
94 _chunksReceivedWhileExpecting int64
97 piecesReceivedSinceLastRequestUpdate maxRequests
98 maxPiecesReceivedBetweenRequestUpdates maxRequests
99 // Chunks that we might reasonably expect to receive from the peer. Due to
100 // latency, buffering, and implementation differences, we may receive
101 // chunks that are no longer in the set of requests actually want.
102 validReceiveChunks map[RequestIndex]int
103 // Indexed by metadata piece, set to true if posted and pending a
105 metadataRequests []bool
106 sentHaves bitmap.Bitmap
108 // Stuff controlled by the remote peer.
111 peerRequests map[Request]*peerRequestState
112 PeerPrefersEncryption bool // as indicated by 'e' field in extension handshake
114 // The pieces the peer has claimed to have.
115 _peerPieces roaring.Bitmap
116 // The peer has everything. This can occur due to a special message, when
117 // we may not even know the number of pieces in the torrent yet.
119 // The highest possible number of pieces the torrent could have based on
120 // communication with the peer. Generally only useful until we have the
122 peerMinPieces pieceIndex
123 // Pieces we've accepted chunks for from the peer.
124 peerTouchedPieces map[pieceIndex]struct{}
125 peerAllowedFast roaring.Bitmap
127 PeerMaxRequests maxRequests // Maximum pending requests the peer allows.
128 PeerExtensionIDs map[pp.ExtensionName]pp.ExtensionNumber
129 PeerClientName string
134 // Maintains the state of a BitTorrent-protocol based connection with a peer.
135 type PeerConn struct {
138 // A string that should identify the PeerConn's net.Conn endpoints. The net.Conn could
139 // be wrapping WebRTC, uTP, or TCP etc. Used in writing the conn status for peers.
144 PeerExtensionBytes pp.PeerExtensionBits
146 // The actual Conn, used for closing, and setting socket options.
148 // The Reader and Writer for this Conn, with hooks installed for stats,
149 // limiting, deadlines etc.
153 messageWriter peerConnMsgWriter
155 uploadTimer *time.Timer
159 func (cn *PeerConn) connStatusString() string {
160 return fmt.Sprintf("%+-55q %s %s", cn.PeerID, cn.PeerExtensionBytes, cn.connString)
163 func (cn *Peer) updateExpectingChunks() {
164 if cn.expectingChunks() {
165 if cn.lastStartedExpectingToReceiveChunks.IsZero() {
166 cn.lastStartedExpectingToReceiveChunks = time.Now()
169 if !cn.lastStartedExpectingToReceiveChunks.IsZero() {
170 cn.cumulativeExpectedToReceiveChunks += time.Since(cn.lastStartedExpectingToReceiveChunks)
171 cn.lastStartedExpectingToReceiveChunks = time.Time{}
176 func (cn *Peer) expectingChunks() bool {
177 if cn.actualRequestState.Requests.IsEmpty() {
180 if !cn.actualRequestState.Interested {
186 haveAllowedFastRequests := false
187 cn.peerAllowedFast.Iterate(func(i uint32) bool {
188 haveAllowedFastRequests = roaringBitmapRangeCardinality(
189 &cn.actualRequestState.Requests,
190 cn.t.pieceRequestIndexOffset(pieceIndex(i)),
191 cn.t.pieceRequestIndexOffset(pieceIndex(i+1)),
193 return !haveAllowedFastRequests
195 return haveAllowedFastRequests
198 func (cn *Peer) remoteChokingPiece(piece pieceIndex) bool {
199 return cn.peerChoking && !cn.peerAllowedFast.Contains(bitmap.BitIndex(piece))
202 // Returns true if the connection is over IPv6.
203 func (cn *PeerConn) ipv6() bool {
208 return len(ip) == net.IPv6len
211 // Returns true the if the dialer/initiator has the lower client peer ID. TODO: Find the
212 // specification for this.
213 func (cn *PeerConn) isPreferredDirection() bool {
214 return bytes.Compare(cn.t.cl.peerID[:], cn.PeerID[:]) < 0 == cn.outgoing
217 // Returns whether the left connection should be preferred over the right one,
218 // considering only their networking properties. If ok is false, we can't
220 func (l *PeerConn) hasPreferredNetworkOver(r *PeerConn) (left, ok bool) {
222 ml.NextBool(l.isPreferredDirection(), r.isPreferredDirection())
223 ml.NextBool(!l.utp(), !r.utp())
224 ml.NextBool(l.ipv6(), r.ipv6())
228 func (cn *Peer) cumInterest() time.Duration {
229 ret := cn.priorInterest
230 if cn.actualRequestState.Interested {
231 ret += time.Since(cn.lastBecameInterested)
236 func (cn *Peer) peerHasAllPieces() (all bool, known bool) {
237 if cn.peerSentHaveAll {
240 if !cn.t.haveInfo() {
243 return roaring.Flip(&cn._peerPieces, 0, bitmap.BitRange(cn.t.numPieces())).IsEmpty(), true
246 func (cn *PeerConn) locker() *lockWithDeferreds {
247 return cn.t.cl.locker()
250 func (cn *Peer) supportsExtension(ext pp.ExtensionName) bool {
251 _, ok := cn.PeerExtensionIDs[ext]
255 // The best guess at number of pieces in the torrent for this peer.
256 func (cn *Peer) bestPeerNumPieces() pieceIndex {
258 return cn.t.numPieces()
260 return cn.peerMinPieces
263 func (cn *Peer) completedString() string {
264 have := pieceIndex(cn._peerPieces.GetCardinality())
265 if cn.peerSentHaveAll {
266 have = cn.bestPeerNumPieces()
268 return fmt.Sprintf("%d/%d", have, cn.bestPeerNumPieces())
271 func (cn *PeerConn) onGotInfo(info *metainfo.Info) {
272 cn.setNumPieces(info.NumPieces())
275 // Correct the PeerPieces slice length. Return false if the existing slice is invalid, such as by
276 // receiving badly sized BITFIELD, or invalid HAVE messages.
277 func (cn *PeerConn) setNumPieces(num pieceIndex) {
278 cn._peerPieces.RemoveRange(bitmap.BitRange(num), bitmap.ToEnd)
279 cn.peerPiecesChanged()
282 func eventAgeString(t time.Time) string {
286 return fmt.Sprintf("%.2fs ago", time.Since(t).Seconds())
289 func (cn *PeerConn) connectionFlags() (ret string) {
291 ret += string([]byte{b})
293 if cn.cryptoMethod == mse.CryptoMethodRC4 {
295 } else if cn.headerEncrypted {
298 ret += string(cn.Discovery)
305 func (cn *PeerConn) utp() bool {
306 return parseNetworkString(cn.Network).Udp
309 // Inspired by https://github.com/transmission/transmission/wiki/Peer-Status-Text.
310 func (cn *Peer) statusFlags() (ret string) {
312 ret += string([]byte{b})
314 if cn.actualRequestState.Interested {
321 ret += cn.connectionFlags()
323 if cn.peerInterested {
332 func (cn *Peer) downloadRate() float64 {
333 num := cn._stats.BytesReadUsefulData.Int64()
337 return float64(num) / cn.totalExpectingTime().Seconds()
340 func (cn *Peer) numRequestsByPiece() (ret map[pieceIndex]int) {
341 ret = make(map[pieceIndex]int)
342 cn.actualRequestState.Requests.Iterate(func(x uint32) bool {
343 ret[pieceIndex(x/cn.t.chunksPerRegularPiece())]++
349 func (cn *Peer) writeStatus(w io.Writer, t *Torrent) {
350 // \t isn't preserved in <pre> blocks?
351 if cn.closed.IsSet() {
352 fmt.Fprint(w, "CLOSED: ")
354 fmt.Fprintln(w, cn.connStatusString())
355 prio, err := cn.peerPriority()
356 prioStr := fmt.Sprintf("%08x", prio)
358 prioStr += ": " + err.Error()
360 fmt.Fprintf(w, " bep40-prio: %v\n", prioStr)
361 fmt.Fprintf(w, " last msg: %s, connected: %s, last helpful: %s, itime: %s, etime: %s\n",
362 eventAgeString(cn.lastMessageReceived),
363 eventAgeString(cn.completedHandshake),
364 eventAgeString(cn.lastHelpful()),
366 cn.totalExpectingTime(),
369 " %s completed, %d pieces touched, good chunks: %v/%v:%v reqq: %d-%v/(%d/%d):%d/%d, flags: %s, dr: %.1f KiB/s\n",
370 cn.completedString(),
371 len(cn.peerTouchedPieces),
372 &cn._stats.ChunksReadUseful,
373 &cn._stats.ChunksRead,
374 &cn._stats.ChunksWritten,
375 cn.actualRequestState.Requests.GetCardinality(),
376 cn.cancelledRequests.GetCardinality(),
377 cn.nominalMaxRequests(),
379 len(cn.peerRequests),
382 cn.downloadRate()/(1<<10),
384 fmt.Fprintf(w, " requested pieces:")
385 type pieceNumRequestsType struct {
389 var pieceNumRequests []pieceNumRequestsType
390 for piece, count := range cn.numRequestsByPiece() {
391 pieceNumRequests = append(pieceNumRequests, pieceNumRequestsType{piece, count})
393 sort.Slice(pieceNumRequests, func(i, j int) bool {
394 return pieceNumRequests[i].piece < pieceNumRequests[j].piece
396 for _, elem := range pieceNumRequests {
397 fmt.Fprintf(w, " %v(%v)", elem.piece, elem.numRequests)
402 func (p *Peer) close() {
408 p.t.decPeerPieceAvailability(p)
410 for _, f := range p.callbacks.PeerClosed {
415 func (cn *PeerConn) onClose() {
416 if cn.pex.IsEnabled() {
419 if cn.updateRequestsTimer != nil {
420 cn.updateRequestsTimer.Stop()
426 if cb := cn.callbacks.PeerConnClosed; cb != nil {
431 func (cn *Peer) peerHasPiece(piece pieceIndex) bool {
432 return cn.peerSentHaveAll || cn._peerPieces.Contains(bitmap.BitIndex(piece))
435 // 64KiB, but temporarily less to work around an issue with WebRTC. TODO: Update when
436 // https://github.com/pion/datachannel/issues/59 is fixed.
437 const writeBufferHighWaterLen = 1 << 15
439 // Writes a message into the write buffer. Returns whether it's okay to keep writing. Writing is
440 // done asynchronously, so it may be that we're not able to honour backpressure from this method.
441 func (cn *PeerConn) write(msg pp.Message) bool {
442 torrent.Add(fmt.Sprintf("messages written of type %s", msg.Type.String()), 1)
443 // We don't need to track bytes here because the connection's Writer has that behaviour injected
444 // (although there's some delay between us buffering the message, and the connection writer
445 // flushing it out.).
446 notFull := cn.messageWriter.write(msg)
447 // Last I checked only Piece messages affect stats, and we don't write those.
453 func (cn *PeerConn) requestMetadataPiece(index int) {
454 eID := cn.PeerExtensionIDs[pp.ExtensionNameMetadata]
455 if eID == pp.ExtensionDeleteNumber {
458 if index < len(cn.metadataRequests) && cn.metadataRequests[index] {
461 cn.logger.WithDefaultLevel(log.Debug).Printf("requesting metadata piece %d", index)
462 cn.write(pp.MetadataExtensionRequestMsg(eID, index))
463 for index >= len(cn.metadataRequests) {
464 cn.metadataRequests = append(cn.metadataRequests, false)
466 cn.metadataRequests[index] = true
469 func (cn *PeerConn) requestedMetadataPiece(index int) bool {
470 return index < len(cn.metadataRequests) && cn.metadataRequests[index]
473 // The actual value to use as the maximum outbound requests.
474 func (cn *Peer) nominalMaxRequests() (ret maxRequests) {
475 return maxRequests(clamp(1, int64(cn.PeerMaxRequests), 2048))
478 func (cn *Peer) totalExpectingTime() (ret time.Duration) {
479 ret = cn.cumulativeExpectedToReceiveChunks
480 if !cn.lastStartedExpectingToReceiveChunks.IsZero() {
481 ret += time.Since(cn.lastStartedExpectingToReceiveChunks)
487 func (cn *PeerConn) onPeerSentCancel(r Request) {
488 if _, ok := cn.peerRequests[r]; !ok {
489 torrent.Add("unexpected cancels received", 1)
492 if cn.fastEnabled() {
495 delete(cn.peerRequests, r)
499 func (cn *PeerConn) choke(msg messageWriter) (more bool) {
504 more = msg(pp.Message{
507 if cn.fastEnabled() {
508 for r := range cn.peerRequests {
509 // TODO: Don't reject pieces in allowed fast set.
513 cn.peerRequests = nil
518 func (cn *PeerConn) unchoke(msg func(pp.Message) bool) bool {
523 return msg(pp.Message{
528 func (cn *Peer) setInterested(interested bool) bool {
529 if cn.actualRequestState.Interested == interested {
532 cn.actualRequestState.Interested = interested
534 cn.lastBecameInterested = time.Now()
535 } else if !cn.lastBecameInterested.IsZero() {
536 cn.priorInterest += time.Since(cn.lastBecameInterested)
538 cn.updateExpectingChunks()
539 // log.Printf("%p: setting interest: %v", cn, interested)
540 return cn.writeInterested(interested)
543 func (pc *PeerConn) writeInterested(interested bool) bool {
544 return pc.write(pp.Message{
545 Type: func() pp.MessageType {
549 return pp.NotInterested
555 // The function takes a message to be sent, and returns true if more messages
557 type messageWriter func(pp.Message) bool
559 func (cn *Peer) shouldRequest(r RequestIndex) error {
560 pi := pieceIndex(r / cn.t.chunksPerRegularPiece())
561 if !cn.peerHasPiece(pi) {
562 return errors.New("requesting piece peer doesn't have")
564 if !cn.t.peerIsActive(cn) {
565 panic("requesting but not in active conns")
567 if cn.closed.IsSet() {
568 panic("requesting when connection is closed")
570 if cn.t.hashingPiece(pi) {
571 panic("piece is being hashed")
573 if cn.t.pieceQueuedForHash(pi) {
574 panic("piece is queued for hash")
576 if cn.peerChoking && !cn.peerAllowedFast.Contains(bitmap.BitIndex(pi)) {
577 panic("peer choking and piece not allowed fast")
582 func (cn *Peer) request(r RequestIndex) (more bool, err error) {
583 if err := cn.shouldRequest(r); err != nil {
586 if cn.actualRequestState.Requests.Contains(r) {
589 if maxRequests(cn.actualRequestState.Requests.GetCardinality()) >= cn.nominalMaxRequests() {
590 return true, errors.New("too many outstanding requests")
592 cn.actualRequestState.Requests.Add(r)
593 if cn.validReceiveChunks == nil {
594 cn.validReceiveChunks = make(map[RequestIndex]int)
596 cn.validReceiveChunks[r]++
597 cn.t.pendingRequests.Inc(r)
598 cn.updateExpectingChunks()
599 ppReq := cn.t.requestIndexToRequest(r)
600 for _, f := range cn.callbacks.SentRequest {
601 f(PeerRequestEvent{cn, ppReq})
603 return cn.peerImpl._request(ppReq), nil
606 func (me *PeerConn) _request(r Request) bool {
607 return me.write(pp.Message{
615 func (me *Peer) cancel(r RequestIndex) bool {
616 if !me.actualRequestState.Requests.Contains(r) {
622 func (me *PeerConn) _cancel(r RequestIndex) bool {
623 if me.cancelledRequests.Contains(r) {
624 // Already cancelled and waiting for a response.
627 if me.fastEnabled() {
628 me.cancelledRequests.Add(r)
630 if !me.deleteRequest(r) {
631 panic("request not existing should have been guarded")
633 if me.actualRequestState.Requests.IsEmpty() {
634 me.updateRequests("Peer.cancel")
637 return me.write(makeCancelMessage(me.t.requestIndexToRequest(r)))
640 func (cn *PeerConn) fillWriteBuffer() {
641 if !cn.applyNextRequestState() {
644 if cn.pex.IsEnabled() {
645 if flow := cn.pex.Share(cn.write); !flow {
652 func (cn *PeerConn) have(piece pieceIndex) {
653 if cn.sentHaves.Get(bitmap.BitIndex(piece)) {
658 Index: pp.Integer(piece),
660 cn.sentHaves.Add(bitmap.BitIndex(piece))
663 func (cn *PeerConn) postBitfield() {
664 if cn.sentHaves.Len() != 0 {
665 panic("bitfield must be first have-related message sent")
667 if !cn.t.haveAnyPieces() {
672 Bitfield: cn.t.bitfield(),
674 cn.sentHaves = bitmap.Bitmap{cn.t._completedPieces.Clone()}
677 func (cn *PeerConn) updateRequests(reason string) {
678 if cn.needRequestUpdate != "" {
681 cn.needRequestUpdate = reason
685 // Emits the indices in the Bitmaps bms in order, never repeating any index.
686 // skip is mutated during execution, and its initial values will never be
688 func iterBitmapsDistinct(skip *bitmap.Bitmap, bms ...bitmap.Bitmap) iter.Func {
689 return func(cb iter.Callback) {
690 for _, bm := range bms {
692 func(_i interface{}) bool {
694 if skip.Contains(bitmap.BitIndex(i)) {
697 skip.Add(bitmap.BitIndex(i))
708 func (cn *Peer) peerPiecesChanged() {
709 cn.t.maybeDropMutuallyCompletePeer(cn)
712 func (cn *PeerConn) raisePeerMinPieces(newMin pieceIndex) {
713 if newMin > cn.peerMinPieces {
714 cn.peerMinPieces = newMin
718 func (cn *PeerConn) peerSentHave(piece pieceIndex) error {
719 if cn.t.haveInfo() && piece >= cn.t.numPieces() || piece < 0 {
720 return errors.New("invalid piece")
722 if cn.peerHasPiece(piece) {
725 cn.raisePeerMinPieces(piece + 1)
726 if !cn.peerHasPiece(piece) {
727 cn.t.incPieceAvailability(piece)
729 cn._peerPieces.Add(uint32(piece))
730 if cn.t.wantPieceIndex(piece) {
731 cn.updateRequests("have")
733 cn.peerPiecesChanged()
737 func (cn *PeerConn) peerSentBitfield(bf []bool) error {
739 panic("expected bitfield length divisible by 8")
741 // We know that the last byte means that at most the last 7 bits are wasted.
742 cn.raisePeerMinPieces(pieceIndex(len(bf) - 7))
743 if cn.t.haveInfo() && len(bf) > int(cn.t.numPieces()) {
744 // Ignore known excess pieces.
745 bf = bf[:cn.t.numPieces()]
747 pp := cn.newPeerPieces()
748 cn.peerSentHaveAll = false
749 for i, have := range bf {
751 cn.raisePeerMinPieces(pieceIndex(i) + 1)
752 if !pp.Contains(bitmap.BitIndex(i)) {
753 cn.t.incPieceAvailability(i)
756 if pp.Contains(bitmap.BitIndex(i)) {
757 cn.t.decPieceAvailability(i)
761 cn._peerPieces.Add(uint32(i))
762 if cn.t.wantPieceIndex(i) {
763 cn.updateRequests("bitfield")
766 cn._peerPieces.Remove(uint32(i))
769 cn.peerPiecesChanged()
773 func (cn *Peer) onPeerHasAllPieces() {
776 npp, pc := cn.newPeerPieces(), t.numPieces()
777 for i := 0; i < pc; i += 1 {
778 if !npp.Contains(bitmap.BitIndex(i)) {
779 t.incPieceAvailability(i)
783 cn.peerSentHaveAll = true
784 cn._peerPieces.Clear()
785 if !cn.t._pendingPieces.IsEmpty() {
786 cn.updateRequests("Peer.onPeerHasAllPieces")
788 cn.peerPiecesChanged()
791 func (cn *PeerConn) onPeerSentHaveAll() error {
792 cn.onPeerHasAllPieces()
796 func (cn *PeerConn) peerSentHaveNone() error {
797 cn.t.decPeerPieceAvailability(&cn.Peer)
798 cn._peerPieces.Clear()
799 cn.peerSentHaveAll = false
800 cn.peerPiecesChanged()
804 func (c *PeerConn) requestPendingMetadata() {
808 if c.PeerExtensionIDs[pp.ExtensionNameMetadata] == 0 {
809 // Peer doesn't support this.
812 // Request metadata pieces that we don't have in a random order.
814 for index := 0; index < c.t.metadataPieceCount(); index++ {
815 if !c.t.haveMetadataPiece(index) && !c.requestedMetadataPiece(index) {
816 pending = append(pending, index)
819 rand.Shuffle(len(pending), func(i, j int) { pending[i], pending[j] = pending[j], pending[i] })
820 for _, i := range pending {
821 c.requestMetadataPiece(i)
825 func (cn *PeerConn) wroteMsg(msg *pp.Message) {
826 torrent.Add(fmt.Sprintf("messages written of type %s", msg.Type.String()), 1)
827 if msg.Type == pp.Extended {
828 for name, id := range cn.PeerExtensionIDs {
829 if id != msg.ExtendedID {
832 torrent.Add(fmt.Sprintf("Extended messages written for protocol %q", name), 1)
835 cn.allStats(func(cs *ConnStats) { cs.wroteMsg(msg) })
838 // After handshake, we know what Torrent and Client stats to include for a
840 func (cn *Peer) postHandshakeStats(f func(*ConnStats)) {
846 // All ConnStats that include this connection. Some objects are not known
847 // until the handshake is complete, after which it's expected to reconcile the
849 func (cn *Peer) allStats(f func(*ConnStats)) {
851 if cn.reconciledHandshakeStats {
852 cn.postHandshakeStats(f)
856 func (cn *PeerConn) wroteBytes(n int64) {
857 cn.allStats(add(n, func(cs *ConnStats) *Count { return &cs.BytesWritten }))
860 func (cn *PeerConn) readBytes(n int64) {
861 cn.allStats(add(n, func(cs *ConnStats) *Count { return &cs.BytesRead }))
864 // Returns whether the connection could be useful to us. We're seeding and
865 // they want data, we don't have metainfo and they can provide it, etc.
866 func (c *Peer) useful() bool {
868 if c.closed.IsSet() {
872 return c.supportsExtension("ut_metadata")
874 if t.seeding() && c.peerInterested {
877 if c.peerHasWantedPieces() {
883 func (c *Peer) lastHelpful() (ret time.Time) {
884 ret = c.lastUsefulChunkReceived
885 if c.t.seeding() && c.lastChunkSent.After(ret) {
886 ret = c.lastChunkSent
891 func (c *PeerConn) fastEnabled() bool {
892 return c.PeerExtensionBytes.SupportsFast() && c.t.cl.config.Extensions.SupportsFast()
895 func (c *PeerConn) reject(r Request) {
896 if !c.fastEnabled() {
897 panic("fast not enabled")
899 c.write(r.ToMsg(pp.Reject))
900 delete(c.peerRequests, r)
903 func (c *PeerConn) onReadRequest(r Request) error {
904 requestedChunkLengths.Add(strconv.FormatUint(r.Length.Uint64(), 10), 1)
905 if _, ok := c.peerRequests[r]; ok {
906 torrent.Add("duplicate requests received", 1)
910 torrent.Add("requests received while choking", 1)
912 torrent.Add("requests rejected while choking", 1)
917 // TODO: What if they've already requested this?
918 if len(c.peerRequests) >= localClientReqq {
919 torrent.Add("requests received while queue full", 1)
923 // BEP 6 says we may close here if we choose.
926 if !c.t.havePiece(pieceIndex(r.Index)) {
927 // This isn't necessarily them screwing up. We can drop pieces
928 // from our storage, and can't communicate this to peers
929 // except by reconnecting.
930 requestsReceivedForMissingPieces.Add(1)
931 return fmt.Errorf("peer requested piece we don't have: %v", r.Index.Int())
933 // Check this after we know we have the piece, so that the piece length will be known.
934 if r.Begin+r.Length > c.t.pieceLength(pieceIndex(r.Index)) {
935 torrent.Add("bad requests received", 1)
936 return errors.New("bad Request")
938 if c.peerRequests == nil {
939 c.peerRequests = make(map[Request]*peerRequestState, localClientReqq)
941 value := &peerRequestState{}
942 c.peerRequests[r] = value
943 go c.peerRequestDataReader(r, value)
948 func (c *PeerConn) peerRequestDataReader(r Request, prs *peerRequestState) {
949 b, err := readPeerRequestData(r, c)
951 defer c.locker().Unlock()
953 c.peerRequestDataReadFailed(err, r)
956 panic("data must be non-nil to trigger send")
963 // If this is maintained correctly, we might be able to support optional synchronous reading for
964 // chunk sending, the way it used to work.
965 func (c *PeerConn) peerRequestDataReadFailed(err error, r Request) {
966 c.logger.WithDefaultLevel(log.Warning).Printf("error reading chunk for peer Request %v: %v", r, err)
967 i := pieceIndex(r.Index)
968 if c.t.pieceComplete(i) {
969 // There used to be more code here that just duplicated the following break. Piece
970 // completions are currently cached, so I'm not sure how helpful this update is, except to
971 // pull any completion changes pushed to the storage backend in failed reads that got us
973 c.t.updatePieceCompletion(i)
975 // If we failed to send a chunk, choke the peer to ensure they flush all their requests. We've
976 // probably dropped a piece from storage, but there's no way to communicate this to the peer. If
977 // they ask for it again, we'll kick them to allow us to send them an updated bitfield on the
978 // next connect. TODO: Support rejecting here too.
980 c.logger.WithDefaultLevel(log.Warning).Printf("already choking peer, requests might not be rejected correctly")
985 func readPeerRequestData(r Request, c *PeerConn) ([]byte, error) {
986 b := make([]byte, r.Length)
987 p := c.t.info.Piece(int(r.Index))
988 n, err := c.t.readAt(b, p.Offset()+int64(r.Begin))
995 panic("expected error")
1001 func runSafeExtraneous(f func()) {
1009 func (c *PeerConn) logProtocolBehaviour(level log.Level, format string, arg ...interface{}) {
1010 c.logger.WithLevel(level).WithContextText(fmt.Sprintf(
1011 "peer id %q, ext v %q", c.PeerID, c.PeerClientName,
1012 )).Printf(format, arg...)
1015 // Processes incoming BitTorrent wire-protocol messages. The client lock is held upon entry and
1016 // exit. Returning will end the connection.
1017 func (c *PeerConn) mainReadLoop() (err error) {
1020 torrent.Add("connection.mainReadLoop returned with error", 1)
1022 torrent.Add("connection.mainReadLoop returned with no error", 1)
1028 decoder := pp.Decoder{
1029 R: bufio.NewReaderSize(c.r, 1<<17),
1030 MaxLength: 256 * 1024,
1038 err = decoder.Decode(&msg)
1040 if cb := c.callbacks.ReadMessage; cb != nil && err == nil {
1043 if t.closed.IsSet() || c.closed.IsSet() {
1049 c.lastMessageReceived = time.Now()
1051 receivedKeepalives.Add(1)
1054 messageTypesReceived.Add(msg.Type.String(), 1)
1055 if msg.Type.FastExtension() && !c.fastEnabled() {
1056 runSafeExtraneous(func() { torrent.Add("fast messages received when extension is disabled", 1) })
1057 return fmt.Errorf("received fast extension message (type=%v) but extension is disabled", msg.Type)
1064 if !c.fastEnabled() {
1065 c.deleteAllRequests()
1067 c.actualRequestState.Requests.Iterate(func(x uint32) bool {
1068 if !c.peerAllowedFast.Contains(x / c.t.chunksPerRegularPiece()) {
1069 c.t.pendingRequests.Dec(x)
1074 c.peerChoking = true
1075 // We can then reset our interest.
1076 c.updateRequests("choked")
1077 c.updateExpectingChunks()
1080 // Some clients do this for some reason. Transmission doesn't error on this, so we
1081 // won't for consistency.
1082 c.logProtocolBehaviour(log.Info, "received unchoke when already unchoked")
1085 c.peerChoking = false
1087 c.actualRequestState.Requests.Iterate(func(x uint32) bool {
1088 if !c.peerAllowedFast.Contains(x / c.t.chunksPerRegularPiece()) {
1090 c.t.pendingRequests.Inc(x)
1094 if preservedCount != 0 {
1095 // TODO: Yes this is a debug log but I'm not happy with the state of the logging lib
1098 "%v requests were preserved while being choked (fast=%v)",
1101 torrent.Add("requestsPreservedThroughChoking", int64(preservedCount))
1103 c.updateRequests("unchoked")
1104 c.updateExpectingChunks()
1106 c.peerInterested = true
1108 case pp.NotInterested:
1109 c.peerInterested = false
1110 // We don't clear their requests since it isn't clear in the spec.
1111 // We'll probably choke them for this, which will clear them if
1112 // appropriate, and is clearly specified.
1114 err = c.peerSentHave(pieceIndex(msg.Index))
1116 err = c.peerSentBitfield(msg.Bitfield)
1118 r := newRequestFromMessage(&msg)
1119 err = c.onReadRequest(r)
1121 c.doChunkReadStats(int64(len(msg.Piece)))
1122 err = c.receiveChunk(&msg)
1123 if len(msg.Piece) == int(t.chunkSize) {
1124 t.chunkPool.Put(&msg.Piece)
1127 err = fmt.Errorf("receiving chunk: %w", err)
1130 req := newRequestFromMessage(&msg)
1131 c.onPeerSentCancel(req)
1133 ipa, ok := tryIpPortFromNetAddr(c.RemoteAddr)
1137 pingAddr := net.UDPAddr{
1142 pingAddr.Port = int(msg.Port)
1144 cl.eachDhtServer(func(s DhtServer) {
1145 go s.Ping(&pingAddr)
1148 torrent.Add("suggests received", 1)
1149 log.Fmsg("peer suggested piece %d", msg.Index).AddValues(c, msg.Index).SetLevel(log.Debug).Log(c.t.logger)
1150 c.updateRequests("suggested")
1152 err = c.onPeerSentHaveAll()
1154 err = c.peerSentHaveNone()
1156 c.remoteRejectedRequest(c.t.requestIndexFromRequest(newRequestFromMessage(&msg)))
1157 case pp.AllowedFast:
1158 torrent.Add("allowed fasts received", 1)
1159 log.Fmsg("peer allowed fast: %d", msg.Index).AddValues(c).SetLevel(log.Debug).Log(c.t.logger)
1160 pieceIndex := msg.Index.Int()
1161 // If we have outstanding requests that aren't currently counted toward the combined
1162 // outstanding request count, increment them.
1163 if c.peerAllowedFast.CheckedAdd(msg.Index.Uint32()) && c.peerChoking &&
1164 // The check here could be against having the info, but really what we need to know
1165 // is if there are any existing requests.
1166 !c.actualRequestState.Requests.IsEmpty() {
1168 i := c.actualRequestState.Requests.Iterator()
1169 i.AdvanceIfNeeded(t.pieceRequestIndexOffset(pieceIndex))
1172 if r >= t.pieceRequestIndexOffset(pieceIndex+1) {
1175 c.t.pendingRequests.Inc(r)
1178 c.updateRequests("PeerConn.mainReadLoop allowed fast")
1180 err = c.onReadExtendedMsg(msg.ExtendedID, msg.ExtendedPayload)
1182 err = fmt.Errorf("received unknown message type: %#v", msg.Type)
1190 func (c *Peer) remoteRejectedRequest(r RequestIndex) {
1191 if c.deleteRequest(r) {
1192 if c.actualRequestState.Requests.IsEmpty() {
1193 c.updateRequests("Peer.remoteRejectedRequest")
1195 c.decExpectedChunkReceive(r)
1199 func (c *Peer) decExpectedChunkReceive(r RequestIndex) {
1200 count := c.validReceiveChunks[r]
1202 delete(c.validReceiveChunks, r)
1203 } else if count > 1 {
1204 c.validReceiveChunks[r] = count - 1
1210 func (c *PeerConn) onReadExtendedMsg(id pp.ExtensionNumber, payload []byte) (err error) {
1212 // TODO: Should we still do this?
1214 // These clients use their own extension IDs for outgoing message
1215 // types, which is incorrect.
1216 if bytes.HasPrefix(c.PeerID[:], []byte("-SD0100-")) || strings.HasPrefix(string(c.PeerID[:]), "-XL0012-") {
1224 case pp.HandshakeExtendedID:
1225 var d pp.ExtendedHandshakeMessage
1226 if err := bencode.Unmarshal(payload, &d); err != nil {
1227 c.logger.Printf("error parsing extended handshake message %q: %s", payload, err)
1228 return fmt.Errorf("unmarshalling extended handshake payload: %w", err)
1230 if cb := c.callbacks.ReadExtendedHandshake; cb != nil {
1233 //c.logger.WithDefaultLevel(log.Debug).Printf("received extended handshake message:\n%s", spew.Sdump(d))
1235 c.PeerMaxRequests = d.Reqq
1237 c.PeerClientName = d.V
1238 if c.PeerExtensionIDs == nil {
1239 c.PeerExtensionIDs = make(map[pp.ExtensionName]pp.ExtensionNumber, len(d.M))
1241 c.PeerListenPort = d.Port
1242 c.PeerPrefersEncryption = d.Encryption
1243 for name, id := range d.M {
1244 if _, ok := c.PeerExtensionIDs[name]; !ok {
1245 peersSupportingExtension.Add(string(name), 1)
1247 c.PeerExtensionIDs[name] = id
1249 if d.MetadataSize != 0 {
1250 if err = t.setMetadataSize(d.MetadataSize); err != nil {
1251 return fmt.Errorf("setting metadata size to %d: %w", d.MetadataSize, err)
1254 c.requestPendingMetadata()
1255 if !t.cl.config.DisablePEX {
1256 t.pex.Add(c) // we learnt enough now
1260 case metadataExtendedId:
1261 err := cl.gotMetadataExtensionMsg(payload, t, c)
1263 return fmt.Errorf("handling metadata extension message: %w", err)
1267 if !c.pex.IsEnabled() {
1268 return nil // or hang-up maybe?
1270 return c.pex.Recv(payload)
1272 return fmt.Errorf("unexpected extended message ID: %v", id)
1276 // Set both the Reader and Writer for the connection from a single ReadWriter.
1277 func (cn *PeerConn) setRW(rw io.ReadWriter) {
1282 // Returns the Reader and Writer as a combined ReadWriter.
1283 func (cn *PeerConn) rw() io.ReadWriter {
1290 func (c *Peer) doChunkReadStats(size int64) {
1291 c.allStats(func(cs *ConnStats) { cs.receivedChunk(size) })
1294 // Handle a received chunk from a peer.
1295 func (c *Peer) receiveChunk(msg *pp.Message) error {
1296 chunksReceived.Add("total", 1)
1298 ppReq := newRequestFromMessage(msg)
1299 req := c.t.requestIndexFromRequest(ppReq)
1302 chunksReceived.Add("while choked", 1)
1305 if c.validReceiveChunks[req] <= 0 {
1306 chunksReceived.Add("unexpected", 1)
1307 return errors.New("received unexpected chunk")
1309 c.decExpectedChunkReceive(req)
1311 if c.peerChoking && c.peerAllowedFast.Contains(bitmap.BitIndex(ppReq.Index)) {
1312 chunksReceived.Add("due to allowed fast", 1)
1315 // The request needs to be deleted immediately to prevent cancels occurring asynchronously when
1316 // have actually already received the piece, while we have the Client unlocked to write the data
1318 deletedRequest := false
1320 if c.actualRequestState.Requests.Contains(req) {
1321 for _, f := range c.callbacks.ReceivedRequested {
1322 f(PeerMessageEvent{c, msg})
1325 // Request has been satisfied.
1326 if c.deleteRequest(req) {
1327 deletedRequest = true
1329 c._chunksReceivedWhileExpecting++
1331 if c.actualRequestState.Requests.IsEmpty() {
1332 c.updateRequests("Peer.receiveChunk deleted request")
1335 chunksReceived.Add("unwanted", 1)
1342 // Do we actually want this chunk?
1343 if t.haveChunk(ppReq) {
1344 chunksReceived.Add("wasted", 1)
1345 c.allStats(add(1, func(cs *ConnStats) *Count { return &cs.ChunksReadWasted }))
1349 piece := &t.pieces[ppReq.Index]
1351 c.allStats(add(1, func(cs *ConnStats) *Count { return &cs.ChunksReadUseful }))
1352 c.allStats(add(int64(len(msg.Piece)), func(cs *ConnStats) *Count { return &cs.BytesReadUsefulData }))
1354 c.piecesReceivedSinceLastRequestUpdate++
1355 c.allStats(add(int64(len(msg.Piece)), func(cs *ConnStats) *Count { return &cs.BytesReadUsefulIntendedData }))
1357 for _, f := range c.t.cl.config.Callbacks.ReceivedUsefulData {
1358 f(ReceivedUsefulDataEvent{c, msg})
1360 c.lastUsefulChunkReceived = time.Now()
1362 // Need to record that it hasn't been written yet, before we attempt to do
1363 // anything with it.
1364 piece.incrementPendingWrites()
1365 // Record that we have the chunk, so we aren't trying to download it while
1366 // waiting for it to be written to storage.
1367 piece.unpendChunkIndex(chunkIndexFromChunkSpec(ppReq.ChunkSpec, t.chunkSize))
1369 // Cancel pending requests for this chunk from *other* peers.
1370 t.iterPeers(func(p *Peer) {
1377 err := func() error {
1380 concurrentChunkWrites.Add(1)
1381 defer concurrentChunkWrites.Add(-1)
1382 // Write the chunk out. Note that the upper bound on chunk writing concurrency will be the
1383 // number of connections. We write inline with receiving the chunk (with this lock dance),
1384 // because we want to handle errors synchronously and I haven't thought of a nice way to
1385 // defer any concurrency to the storage and have that notify the client of errors. TODO: Do
1387 return t.writeChunk(int(msg.Index), int64(msg.Begin), msg.Piece)
1390 piece.decrementPendingWrites()
1393 c.logger.WithDefaultLevel(log.Error).Printf("writing received chunk %v: %v", req, err)
1395 // Necessary to pass TestReceiveChunkStorageFailureSeederFastExtensionDisabled. I think a
1396 // request update runs while we're writing the chunk that just failed. Then we never do a
1397 // fresh update after pending the failed request.
1398 c.updateRequests("Peer.receiveChunk error writing chunk")
1399 t.onWriteChunkErr(err)
1403 c.onDirtiedPiece(pieceIndex(ppReq.Index))
1405 // We need to ensure the piece is only queued once, so only the last chunk writer gets this job.
1406 if t.pieceAllDirty(pieceIndex(ppReq.Index)) && piece.pendingWrites == 0 {
1407 t.queuePieceCheck(pieceIndex(ppReq.Index))
1408 // We don't pend all chunks here anymore because we don't want code dependent on the dirty
1409 // chunk status (such as the haveChunk call above) to have to check all the various other
1410 // piece states like queued for hash, hashing etc. This does mean that we need to be sure
1411 // that chunk pieces are pended at an appropriate time later however.
1414 cl.event.Broadcast()
1415 // We do this because we've written a chunk, and may change PieceState.Partial.
1416 t.publishPieceChange(pieceIndex(ppReq.Index))
1421 func (c *Peer) onDirtiedPiece(piece pieceIndex) {
1422 if c.peerTouchedPieces == nil {
1423 c.peerTouchedPieces = make(map[pieceIndex]struct{})
1425 c.peerTouchedPieces[piece] = struct{}{}
1426 ds := &c.t.pieces[piece].dirtiers
1428 *ds = make(map[*Peer]struct{})
1430 (*ds)[c] = struct{}{}
1433 func (c *PeerConn) uploadAllowed() bool {
1434 if c.t.cl.config.NoUpload {
1437 if c.t.dataUploadDisallowed {
1443 if !c.peerHasWantedPieces() {
1446 // Don't upload more than 100 KiB more than we download.
1447 if c._stats.BytesWrittenData.Int64() >= c._stats.BytesReadData.Int64()+100<<10 {
1453 func (c *PeerConn) setRetryUploadTimer(delay time.Duration) {
1454 if c.uploadTimer == nil {
1455 c.uploadTimer = time.AfterFunc(delay, c.tickleWriter)
1457 c.uploadTimer.Reset(delay)
1461 // Also handles choking and unchoking of the remote peer.
1462 func (c *PeerConn) upload(msg func(pp.Message) bool) bool {
1463 // Breaking or completing this loop means we don't want to upload to the
1464 // peer anymore, and we choke them.
1466 for c.uploadAllowed() {
1467 // We want to upload to the peer.
1468 if !c.unchoke(msg) {
1471 for r, state := range c.peerRequests {
1472 if state.data == nil {
1475 res := c.t.cl.config.UploadRateLimiter.ReserveN(time.Now(), int(r.Length))
1477 panic(fmt.Sprintf("upload rate limiter burst size < %d", r.Length))
1479 delay := res.Delay()
1482 c.setRetryUploadTimer(delay)
1483 // Hard to say what to return here.
1486 more := c.sendChunk(r, msg, state)
1487 delete(c.peerRequests, r)
1498 func (cn *PeerConn) drop() {
1499 cn.t.dropConnection(cn)
1502 func (cn *Peer) netGoodPiecesDirtied() int64 {
1503 return cn._stats.PiecesDirtiedGood.Int64() - cn._stats.PiecesDirtiedBad.Int64()
1506 func (c *Peer) peerHasWantedPieces() bool {
1507 if c.peerSentHaveAll {
1508 return !c.t.haveAllPieces()
1510 if !c.t.haveInfo() {
1511 return !c._peerPieces.IsEmpty()
1513 return c._peerPieces.Intersects(&c.t._pendingPieces)
1516 func (c *Peer) deleteRequest(r RequestIndex) bool {
1517 if !c.actualRequestState.Requests.CheckedRemove(r) {
1520 c.cancelledRequests.Remove(r)
1521 for _, f := range c.callbacks.DeletedRequest {
1522 f(PeerRequestEvent{c, c.t.requestIndexToRequest(r)})
1524 c.updateExpectingChunks()
1525 if !c.peerChoking || c.peerAllowedFast.Contains(r/c.t.chunksPerRegularPiece()) {
1526 c.t.pendingRequests.Dec(r)
1531 func (c *Peer) deleteAllRequests() {
1532 c.actualRequestState.Requests.Clone().Iterate(func(x uint32) bool {
1536 if !c.actualRequestState.Requests.IsEmpty() {
1537 panic(c.actualRequestState.Requests.GetCardinality())
1539 // for c := range c.t.conns {
1544 // This is called when something has changed that should wake the writer, such as putting stuff into
1545 // the writeBuffer, or changing some state that the writer can act on.
1546 func (c *PeerConn) tickleWriter() {
1547 c.messageWriter.writeCond.Broadcast()
1550 func (c *PeerConn) sendChunk(r Request, msg func(pp.Message) bool, state *peerRequestState) (more bool) {
1551 c.lastChunkSent = time.Now()
1552 return msg(pp.Message{
1560 func (c *PeerConn) setTorrent(t *Torrent) {
1562 panic("connection already associated with a torrent")
1565 c.logger.WithDefaultLevel(log.Debug).Printf("set torrent=%v", t)
1566 t.reconcileHandshakeStats(c)
1569 func (c *Peer) peerPriority() (peerPriority, error) {
1570 return bep40Priority(c.remoteIpPort(), c.t.cl.publicAddr(c.remoteIp()))
1573 func (c *Peer) remoteIp() net.IP {
1574 host, _, _ := net.SplitHostPort(c.RemoteAddr.String())
1575 return net.ParseIP(host)
1578 func (c *Peer) remoteIpPort() IpPort {
1579 ipa, _ := tryIpPortFromNetAddr(c.RemoteAddr)
1580 return IpPort{ipa.IP, uint16(ipa.Port)}
1583 func (c *PeerConn) pexPeerFlags() pp.PexPeerFlags {
1584 f := pp.PexPeerFlags(0)
1585 if c.PeerPrefersEncryption {
1586 f |= pp.PexPrefersEncryption
1589 f |= pp.PexOutgoingConn
1592 f |= pp.PexSupportsUtp
1597 // This returns the address to use if we want to dial the peer again. It incorporates the peer's
1598 // advertised listen port.
1599 func (c *PeerConn) dialAddr() PeerRemoteAddr {
1600 if !c.outgoing && c.PeerListenPort != 0 {
1601 switch addr := c.RemoteAddr.(type) {
1604 dialAddr.Port = c.PeerListenPort
1608 dialAddr.Port = c.PeerListenPort
1615 func (c *PeerConn) pexEvent(t pexEventType) pexEvent {
1616 f := c.pexPeerFlags()
1617 addr := c.dialAddr()
1618 return pexEvent{t, addr, f}
1621 func (c *PeerConn) String() string {
1622 return fmt.Sprintf("connection %p", c)
1625 func (c *Peer) trust() connectionTrust {
1626 return connectionTrust{c.trusted, c.netGoodPiecesDirtied()}
1629 type connectionTrust struct {
1631 NetGoodPiecesDirted int64
1634 func (l connectionTrust) Less(r connectionTrust) bool {
1635 return multiless.New().Bool(l.Implicit, r.Implicit).Int64(l.NetGoodPiecesDirted, r.NetGoodPiecesDirted).Less()
1638 // Returns the pieces the peer could have based on their claims. If we don't know how many pieces
1639 // are in the torrent, it could be a very large range the peer has sent HaveAll.
1640 func (cn *PeerConn) PeerPieces() *roaring.Bitmap {
1642 defer cn.locker().RUnlock()
1643 return cn.newPeerPieces()
1646 // Returns a new Bitmap that includes bits for all pieces the peer could have based on their claims.
1647 func (cn *Peer) newPeerPieces() *roaring.Bitmap {
1648 // TODO: Can we use copy on write?
1649 ret := cn._peerPieces.Clone()
1650 if cn.peerSentHaveAll {
1651 if cn.t.haveInfo() {
1652 ret.AddRange(0, bitmap.BitRange(cn.t.numPieces()))
1654 ret.AddRange(0, bitmap.ToEnd)
1660 func (cn *Peer) stats() *ConnStats {
1664 func (p *Peer) TryAsPeerConn() (*PeerConn, bool) {
1665 pc, ok := p.peerImpl.(*PeerConn)
1669 func (p *PeerConn) onNextRequestStateChanged() {