25 "github.com/anacrolix/missinggo"
26 . "github.com/anacrolix/missinggo"
27 "github.com/anacrolix/missinggo/perf"
28 "github.com/anacrolix/missinggo/pubsub"
29 "github.com/anacrolix/sync"
30 "github.com/anacrolix/utp"
31 "github.com/bradfitz/iter"
32 "github.com/edsrzf/mmap-go"
34 "github.com/anacrolix/torrent/bencode"
35 filePkg "github.com/anacrolix/torrent/data/file"
36 "github.com/anacrolix/torrent/dht"
37 "github.com/anacrolix/torrent/internal/pieceordering"
38 "github.com/anacrolix/torrent/iplist"
39 "github.com/anacrolix/torrent/metainfo"
40 "github.com/anacrolix/torrent/mse"
41 pp "github.com/anacrolix/torrent/peer_protocol"
42 "github.com/anacrolix/torrent/tracker"
46 unwantedChunksReceived = expvar.NewInt("chunksReceivedUnwanted")
47 unexpectedChunksReceived = expvar.NewInt("chunksReceivedUnexpected")
48 chunksReceived = expvar.NewInt("chunksReceived")
50 peersAddedBySource = expvar.NewMap("peersAddedBySource")
52 uploadChunksPosted = expvar.NewInt("uploadChunksPosted")
53 unexpectedCancels = expvar.NewInt("unexpectedCancels")
54 postedCancels = expvar.NewInt("postedCancels")
55 duplicateConnsAvoided = expvar.NewInt("duplicateConnsAvoided")
57 pieceHashedCorrect = expvar.NewInt("pieceHashedCorrect")
58 pieceHashedNotCorrect = expvar.NewInt("pieceHashedNotCorrect")
60 unsuccessfulDials = expvar.NewInt("dialSuccessful")
61 successfulDials = expvar.NewInt("dialUnsuccessful")
63 acceptUTP = expvar.NewInt("acceptUTP")
64 acceptTCP = expvar.NewInt("acceptTCP")
65 acceptReject = expvar.NewInt("acceptReject")
67 peerExtensions = expvar.NewMap("peerExtensions")
68 completedHandshakeConnectionFlags = expvar.NewMap("completedHandshakeConnectionFlags")
69 // Count of connections to peer with same client ID.
70 connsToSelf = expvar.NewInt("connsToSelf")
71 // Number of completed connections to a client we're already connected with.
72 duplicateClientConns = expvar.NewInt("duplicateClientConns")
73 receivedMessageTypes = expvar.NewMap("receivedMessageTypes")
74 supportedExtensionMessages = expvar.NewMap("supportedExtensionMessages")
78 // Justification for set bits follows.
80 // Extension protocol ([5]|=0x10):
81 // http://www.bittorrent.org/beps/bep_0010.html
83 // Fast Extension ([7]|=0x04):
84 // http://bittorrent.org/beps/bep_0006.html.
85 // Disabled until AllowedFast is implemented.
88 // http://www.bittorrent.org/beps/bep_0005.html
89 defaultExtensionBytes = "\x00\x00\x00\x00\x00\x10\x00\x01"
91 socketsPerTorrent = 80
92 torrentPeersHighWater = 200
93 torrentPeersLowWater = 50
95 // Limit how long handshake can take. This is to reduce the lingering
96 // impact of a few bad apples. 4s loses 1% of successful handshakes that
97 // are obtained with 60s timeout, and 5% of unsuccessful handshakes.
98 btHandshakeTimeout = 4 * time.Second
99 handshakesTimeout = 20 * time.Second
101 // These are our extended message IDs.
102 metadataExtendedId = iota + 1 // 0 is reserved for deleting keys
105 // Updated occasionally to when there's been some changes to client
106 // behaviour in case other clients are assuming anything of us. See also
108 extendedHandshakeClientVersion = "go.torrent dev 20150624"
111 // Currently doesn't really queue, but should in the future.
112 func (cl *Client) queuePieceCheck(t *torrent, pieceIndex pp.Integer) {
113 piece := &t.Pieces[pieceIndex]
114 if piece.QueuedForHash {
117 piece.QueuedForHash = true
118 t.publishPieceChange(int(pieceIndex))
119 go cl.verifyPiece(t, pieceIndex)
122 // Queue a piece check if one isn't already queued, and the piece has never
123 // been checked before.
124 func (cl *Client) queueFirstHash(t *torrent, piece int) {
125 p := &t.Pieces[piece]
126 if p.EverHashed || p.Hashing || p.QueuedForHash || t.pieceComplete(piece) {
129 cl.queuePieceCheck(t, pp.Integer(piece))
132 // Clients contain zero or more Torrents. A client manages a blocklist, the
133 // TCP/UDP protocol ports, and DHT as desired.
137 listeners []net.Listener
140 ipBlockList iplist.Ranger
141 bannedTorrents map[InfoHash]struct{}
143 pruneTimer *time.Timer
144 extensionBytes peerExtensionBytes
145 // Set of addresses that have our client ID. This intentionally will
146 // include ourselves if we end up trying to connect to our own address
147 // through legitimate channels.
148 dopplegangerAddrs map[string]struct{}
150 torrentDataOpener TorrentDataOpener
156 torrents map[InfoHash]*torrent
159 func (me *Client) IPBlockList() iplist.Ranger {
162 return me.ipBlockList
165 func (me *Client) SetIPBlockList(list iplist.Ranger) {
168 me.ipBlockList = list
170 me.dHT.SetIPBlockList(list)
174 func (me *Client) PeerID() string {
175 return string(me.peerID[:])
178 func (me *Client) ListenAddr() (addr net.Addr) {
179 for _, l := range me.listeners {
186 type hashSorter struct {
190 func (me hashSorter) Len() int {
191 return len(me.Hashes)
194 func (me hashSorter) Less(a, b int) bool {
195 return (&big.Int{}).SetBytes(me.Hashes[a][:]).Cmp((&big.Int{}).SetBytes(me.Hashes[b][:])) < 0
198 func (me hashSorter) Swap(a, b int) {
199 me.Hashes[a], me.Hashes[b] = me.Hashes[b], me.Hashes[a]
202 func (cl *Client) sortedTorrents() (ret []*torrent) {
204 for ih := range cl.torrents {
205 hs.Hashes = append(hs.Hashes, ih)
208 for _, ih := range hs.Hashes {
209 ret = append(ret, cl.torrent(ih))
214 // Writes out a human readable status of the client, such as for writing to a
216 func (cl *Client) WriteStatus(_w io.Writer) {
218 defer cl.mu.RUnlock()
219 w := bufio.NewWriter(_w)
221 if addr := cl.ListenAddr(); addr != nil {
222 fmt.Fprintf(w, "Listening on %s\n", cl.ListenAddr())
224 fmt.Fprintln(w, "Not listening!")
226 fmt.Fprintf(w, "Peer ID: %+q\n", cl.peerID)
228 dhtStats := cl.dHT.Stats()
229 fmt.Fprintf(w, "DHT nodes: %d (%d good, %d banned)\n", dhtStats.Nodes, dhtStats.GoodNodes, dhtStats.BadNodes)
230 fmt.Fprintf(w, "DHT Server ID: %x\n", cl.dHT.ID())
231 fmt.Fprintf(w, "DHT port: %d\n", addrPort(cl.dHT.Addr()))
232 fmt.Fprintf(w, "DHT announces: %d\n", dhtStats.ConfirmedAnnounces)
233 fmt.Fprintf(w, "Outstanding transactions: %d\n", dhtStats.OutstandingTransactions)
235 fmt.Fprintf(w, "# Torrents: %d\n", len(cl.torrents))
237 for _, t := range cl.sortedTorrents() {
239 fmt.Fprint(w, "<unknown name>")
241 fmt.Fprint(w, t.Name())
245 fmt.Fprintf(w, "%f%% of %d bytes", 100*(1-float32(t.bytesLeft())/float32(t.Length())), t.Length())
247 w.WriteString("<missing metainfo>")
255 func dataReadAt(d Data, b []byte, off int64) (n int, err error) {
257 // if err == io.ErrUnexpectedEOF && n != 0 {
261 // log.Println("data read at", len(b), off)
262 return d.ReadAt(b, off)
265 // Calculates the number of pieces to set to Readahead priority, after the
266 // Now, and Next pieces.
267 func readaheadPieces(readahead, pieceLength int64) (ret int) {
268 // Expand the readahead to fit any partial pieces. Subtract 1 for the
269 // "next" piece that is assigned.
270 ret = int((readahead+pieceLength-1)/pieceLength - 1)
271 // Lengthen the "readahead tail" to smooth blockiness that occurs when the
272 // piece length is much larger than the readahead.
279 func (cl *Client) readRaisePiecePriorities(t *torrent, off, readaheadBytes int64) {
280 index := int(off / int64(t.usualPieceSize()))
281 cl.raisePiecePriority(t, index, PiecePriorityNow)
283 if index >= t.numPieces() {
286 cl.raisePiecePriority(t, index, PiecePriorityNext)
287 for range iter.N(readaheadPieces(readaheadBytes, t.Info.PieceLength)) {
289 if index >= t.numPieces() {
292 cl.raisePiecePriority(t, index, PiecePriorityReadahead)
296 func (cl *Client) addUrgentRequests(t *torrent, off int64, n int) {
298 req, ok := t.offsetRequest(off)
302 if _, ok := t.urgent[req]; !ok && !t.haveChunk(req) {
304 t.urgent = make(map[request]struct{}, (n+int(t.chunkSize)-1)/int(t.chunkSize))
306 t.urgent[req] = struct{}{}
307 cl.event.Broadcast() // Why?
308 index := int(req.Index)
309 cl.queueFirstHash(t, index)
310 cl.pieceChanged(t, index)
312 reqOff := t.requestOffset(req)
313 n1 := req.Length - pp.Integer(off-reqOff)
317 // log.Print(t.urgent)
320 func (cl *Client) configDir() string {
321 if cl.config.ConfigDir == "" {
322 return filepath.Join(os.Getenv("HOME"), ".config/torrent")
324 return cl.config.ConfigDir
327 // The directory where the Client expects to find and store configuration
328 // data. Defaults to $HOME/.config/torrent.
329 func (cl *Client) ConfigDir() string {
330 return cl.configDir()
333 func (t *torrent) connPendPiece(c *connection, piece int) {
334 c.pendPiece(piece, t.Pieces[piece].Priority, t)
337 func (cl *Client) raisePiecePriority(t *torrent, piece int, priority piecePriority) {
338 if t.Pieces[piece].Priority < priority {
339 cl.prioritizePiece(t, piece, priority)
343 func (cl *Client) prioritizePiece(t *torrent, piece int, priority piecePriority) {
344 if t.havePiece(piece) {
345 priority = PiecePriorityNone
347 if priority != PiecePriorityNone {
348 cl.queueFirstHash(t, piece)
350 p := &t.Pieces[piece]
351 if p.Priority != priority {
352 p.Priority = priority
353 cl.pieceChanged(t, piece)
357 func loadPackedBlocklist(filename string) (ret iplist.Ranger, err error) {
358 f, err := os.Open(filename)
359 if os.IsNotExist(err) {
367 mm, err := mmap.Map(f, mmap.RDONLY, 0)
371 ret = iplist.NewFromPacked(mm)
375 func (cl *Client) setEnvBlocklist() (err error) {
376 filename := os.Getenv("TORRENT_BLOCKLIST_FILE")
377 defaultBlocklist := filename == ""
378 if defaultBlocklist {
379 cl.ipBlockList, err = loadPackedBlocklist(filepath.Join(cl.configDir(), "packed-blocklist"))
383 if cl.ipBlockList != nil {
386 filename = filepath.Join(cl.configDir(), "blocklist")
388 f, err := os.Open(filename)
390 if defaultBlocklist {
396 cl.ipBlockList, err = iplist.NewFromReader(f)
400 func (cl *Client) initBannedTorrents() error {
401 f, err := os.Open(filepath.Join(cl.configDir(), "banned_infohashes"))
403 if os.IsNotExist(err) {
406 return fmt.Errorf("error opening banned infohashes file: %s", err)
409 scanner := bufio.NewScanner(f)
410 cl.bannedTorrents = make(map[InfoHash]struct{})
412 if strings.HasPrefix(strings.TrimSpace(scanner.Text()), "#") {
416 n, err := fmt.Sscanf(scanner.Text(), "%x", &ihs)
418 return fmt.Errorf("error reading infohash: %s", err)
424 return errors.New("bad infohash")
428 cl.bannedTorrents[ih] = struct{}{}
430 if err := scanner.Err(); err != nil {
431 return fmt.Errorf("error scanning file: %s", err)
436 // Creates a new client.
437 func NewClient(cfg *Config) (cl *Client, err error) {
448 halfOpenLimit: socketsPerTorrent,
450 torrentDataOpener: func(md *metainfo.Info) Data {
451 return filePkg.TorrentData(md, cfg.DataDir)
453 dopplegangerAddrs: make(map[string]struct{}),
455 quit: make(chan struct{}),
456 torrents: make(map[InfoHash]*torrent),
458 CopyExact(&cl.extensionBytes, defaultExtensionBytes)
460 if cfg.TorrentDataOpener != nil {
461 cl.torrentDataOpener = cfg.TorrentDataOpener
464 if cfg.IPBlocklist != nil {
465 cl.ipBlockList = cfg.IPBlocklist
466 } else if !cfg.NoDefaultBlocklist {
467 err = cl.setEnvBlocklist()
473 if err = cl.initBannedTorrents(); err != nil {
474 err = fmt.Errorf("error initing banned torrents: %s", err)
478 if cfg.PeerID != "" {
479 CopyExact(&cl.peerID, cfg.PeerID)
481 o := copy(cl.peerID[:], bep20)
482 _, err = rand.Read(cl.peerID[o:])
484 panic("error generating peer id")
488 // Returns the laddr string to listen on for the next Listen call.
489 listenAddr := func() string {
490 if addr := cl.ListenAddr(); addr != nil {
493 if cfg.ListenAddr == "" {
496 return cfg.ListenAddr
498 if !cl.config.DisableTCP {
500 l, err = net.Listen(func() string {
501 if cl.config.DisableIPv6 {
510 cl.listeners = append(cl.listeners, l)
511 go cl.acceptConnections(l, false)
513 if !cl.config.DisableUTP {
514 cl.utpSock, err = utp.NewSocket(func() string {
515 if cl.config.DisableIPv6 {
524 cl.listeners = append(cl.listeners, cl.utpSock)
525 go cl.acceptConnections(cl.utpSock, true)
528 dhtCfg := cfg.DHTConfig
530 dhtCfg = &dht.ServerConfig{}
532 if dhtCfg.IPBlocklist == nil {
533 dhtCfg.IPBlocklist = cl.ipBlockList
535 if dhtCfg.Addr == "" {
536 dhtCfg.Addr = listenAddr()
538 if dhtCfg.Conn == nil && cl.utpSock != nil {
539 dhtCfg.Conn = cl.utpSock
541 cl.dHT, err = dht.NewServer(dhtCfg)
550 func (cl *Client) stopped() bool {
559 // Stops the client. All connections to peers are closed and all activity will
561 func (me *Client) Close() {
573 for _, l := range me.listeners {
576 for _, t := range me.torrents {
582 var ipv6BlockRange = iplist.Range{Description: "non-IPv4 address"}
584 func (cl *Client) ipBlockRange(ip net.IP) (r iplist.Range, blocked bool) {
585 if cl.ipBlockList == nil {
589 // If blocklists are enabled, then block non-IPv4 addresses, because
590 // blocklists do not yet support IPv6.
592 if missinggo.CryHeard() {
593 log.Printf("blocking non-IPv4 address: %s", ip)
599 return cl.ipBlockList.Lookup(ip4)
602 func (cl *Client) waitAccept() {
606 for _, t := range cl.torrents {
620 func (cl *Client) acceptConnections(l net.Listener, utp bool) {
623 // We accept all connections immediately, because we don't know what
624 // torrent they're for.
625 conn, err := l.Accept()
644 doppleganger := cl.dopplegangerAddr(conn.RemoteAddr().String())
645 _, blocked := cl.ipBlockRange(AddrIP(conn.RemoteAddr()))
647 if blocked || doppleganger {
649 // log.Printf("inbound connection from %s blocked by %s", conn.RemoteAddr(), blockRange)
653 go cl.incomingConnection(conn, utp)
657 func (cl *Client) incomingConnection(nc net.Conn, utp bool) {
659 if tc, ok := nc.(*net.TCPConn); ok {
665 c.Discovery = peerSourceIncoming
667 err := cl.runReceivedConn(c)
673 // Returns a handle to the given torrent, if it's present in the client.
674 func (cl *Client) Torrent(ih InfoHash) (T Download, ok bool) {
677 t, ok := cl.torrents[ih]
685 func (me *Client) torrent(ih InfoHash) *torrent {
686 return me.torrents[ih]
689 type dialResult struct {
694 func doDial(dial func(addr string, t *torrent) (net.Conn, error), ch chan dialResult, utp bool, addr string, t *torrent) {
695 conn, err := dial(addr, t)
700 conn = nil // Pedantic
702 ch <- dialResult{conn, utp}
704 successfulDials.Add(1)
707 unsuccessfulDials.Add(1)
710 func reducedDialTimeout(max time.Duration, halfOpenLimit int, pendingPeers int) (ret time.Duration) {
711 ret = max / time.Duration((pendingPeers+halfOpenLimit)/halfOpenLimit)
712 if ret < minDialTimeout {
718 // Returns whether an address is known to connect to a client with our own ID.
719 func (me *Client) dopplegangerAddr(addr string) bool {
720 _, ok := me.dopplegangerAddrs[addr]
724 // Start the process of connecting to the given peer for the given torrent if
726 func (me *Client) initiateConn(peer Peer, t *torrent) {
727 if peer.Id == me.peerID {
730 addr := net.JoinHostPort(peer.IP.String(), fmt.Sprintf("%d", peer.Port))
731 if me.dopplegangerAddr(addr) || t.addrActive(addr) {
732 duplicateConnsAvoided.Add(1)
735 if r, ok := me.ipBlockRange(peer.IP); ok {
736 log.Printf("outbound connect to %s blocked by IP blocklist rule %s", peer.IP, r)
739 t.HalfOpen[addr] = struct{}{}
740 go me.outgoingConnection(t, addr, peer.Source)
743 func (me *Client) dialTimeout(t *torrent) time.Duration {
745 pendingPeers := len(t.Peers)
747 return reducedDialTimeout(nominalDialTimeout, me.halfOpenLimit, pendingPeers)
750 func (me *Client) dialTCP(addr string, t *torrent) (c net.Conn, err error) {
751 c, err = net.DialTimeout("tcp", addr, me.dialTimeout(t))
753 c.(*net.TCPConn).SetLinger(0)
758 func (me *Client) dialUTP(addr string, t *torrent) (c net.Conn, err error) {
759 return me.utpSock.DialTimeout(addr, me.dialTimeout(t))
762 // Returns a connection over UTP or TCP, whichever is first to connect.
763 func (me *Client) dialFirst(addr string, t *torrent) (conn net.Conn, utp bool) {
764 // Initiate connections via TCP and UTP simultaneously. Use the first one
767 if !me.config.DisableUTP {
770 if !me.config.DisableTCP {
773 resCh := make(chan dialResult, left)
774 if !me.config.DisableUTP {
775 go doDial(me.dialUTP, resCh, true, addr, t)
777 if !me.config.DisableTCP {
778 go doDial(me.dialTCP, resCh, false, addr, t)
781 // Wait for a successful connection.
782 for ; left > 0 && res.Conn == nil; left-- {
786 // There are still incompleted dials.
788 for ; left > 0; left-- {
789 conn := (<-resCh).Conn
801 func (me *Client) noLongerHalfOpen(t *torrent, addr string) {
802 if _, ok := t.HalfOpen[addr]; !ok {
803 panic("invariant broken")
805 delete(t.HalfOpen, addr)
809 // Performs initiator handshakes and returns a connection.
810 func (me *Client) handshakesConnection(nc net.Conn, t *torrent, encrypted, utp bool) (c *connection, err error) {
814 c.encrypted = encrypted
816 err = nc.SetDeadline(time.Now().Add(handshakesTimeout))
820 ok, err := me.initiateHandshakes(c, t)
827 // Returns nil connection and nil error if no connection could be established
828 // for valid reasons.
829 func (me *Client) establishOutgoingConn(t *torrent, addr string) (c *connection, err error) {
830 nc, utp := me.dialFirst(addr, t)
834 c, err = me.handshakesConnection(nc, t, !me.config.DisableEncryption, utp)
842 if me.config.DisableEncryption {
843 // We already tried without encryption.
846 // Try again without encryption, using whichever protocol type worked last
849 nc, err = me.dialUTP(addr, t)
851 nc, err = me.dialTCP(addr, t)
854 err = fmt.Errorf("error dialing for unencrypted connection: %s", err)
857 c, err = me.handshakesConnection(nc, t, false, utp)
864 // Called to dial out and run a connection. The addr we're given is already
865 // considered half-open.
866 func (me *Client) outgoingConnection(t *torrent, addr string, ps peerSource) {
867 c, err := me.establishOutgoingConn(t, addr)
870 // Don't release lock between here and addConnection, unless it's for
872 me.noLongerHalfOpen(t, addr)
881 err = me.runInitiatedHandshookConn(c, t)
887 // The port number for incoming peer connections. 0 if the client isn't
889 func (cl *Client) incomingPeerPort() int {
890 listenAddr := cl.ListenAddr()
891 if listenAddr == nil {
894 return addrPort(listenAddr)
897 // Convert a net.Addr to its compact IP representation. Either 4 or 16 bytes
898 // per "yourip" field of http://www.bittorrent.org/beps/bep_0010.html.
899 func addrCompactIP(addr net.Addr) (string, error) {
900 host, _, err := net.SplitHostPort(addr.String())
904 ip := net.ParseIP(host)
905 if v4 := ip.To4(); v4 != nil {
909 return string(v4), nil
911 return string(ip.To16()), nil
914 func handshakeWriter(w io.Writer, bb <-chan []byte, done chan<- error) {
926 peerExtensionBytes [8]byte
930 func (me *peerExtensionBytes) SupportsExtended() bool {
931 return me[5]&0x10 != 0
934 func (me *peerExtensionBytes) SupportsDHT() bool {
935 return me[7]&0x01 != 0
938 func (me *peerExtensionBytes) SupportsFast() bool {
939 return me[7]&0x04 != 0
942 type handshakeResult struct {
948 // ih is nil if we expect the peer to declare the InfoHash, such as when the
949 // peer initiated the connection. Returns ok if the handshake was successful,
950 // and err if there was an unexpected condition other than the peer simply
951 // abandoning the handshake.
952 func handshake(sock io.ReadWriter, ih *InfoHash, peerID [20]byte, extensions peerExtensionBytes) (res handshakeResult, ok bool, err error) {
953 // Bytes to be sent to the peer. Should never block the sender.
954 postCh := make(chan []byte, 4)
955 // A single error value sent when the writer completes.
956 writeDone := make(chan error, 1)
957 // Performs writes to the socket and ensures posts don't block.
958 go handshakeWriter(sock, postCh, writeDone)
961 close(postCh) // Done writing.
968 // Wait until writes complete before returning from handshake.
971 err = fmt.Errorf("error writing: %s", err)
975 post := func(bb []byte) {
979 panic("mustn't block while posting")
983 post([]byte(pp.Protocol))
985 if ih != nil { // We already know what we want.
990 _, err = io.ReadFull(sock, b[:68])
995 if string(b[:20]) != pp.Protocol {
998 CopyExact(&res.peerExtensionBytes, b[20:28])
999 CopyExact(&res.InfoHash, b[28:48])
1000 CopyExact(&res.peerID, b[48:68])
1001 peerExtensions.Add(hex.EncodeToString(res.peerExtensionBytes[:]), 1)
1003 // TODO: Maybe we can just drop peers here if we're not interested. This
1004 // could prevent them trying to reconnect, falsely believing there was
1006 if ih == nil { // We were waiting for the peer to tell us what they wanted.
1007 post(res.InfoHash[:])
1015 // Wraps a raw connection and provides the interface we want for using the
1016 // connection in the message loop.
1017 type deadlineReader struct {
1022 func (me deadlineReader) Read(b []byte) (n int, err error) {
1023 // Keep-alives should be received every 2 mins. Give a bit of gracetime.
1024 err = me.nc.SetReadDeadline(time.Now().Add(150 * time.Second))
1026 err = fmt.Errorf("error setting read deadline: %s", err)
1028 n, err = me.r.Read(b)
1029 // Convert common errors into io.EOF.
1031 // if opError, ok := err.(*net.OpError); ok && opError.Op == "read" && opError.Err == syscall.ECONNRESET {
1033 // } else if netErr, ok := err.(net.Error); ok && netErr.Timeout() {
1043 type readWriter struct {
1048 func maybeReceiveEncryptedHandshake(rw io.ReadWriter, skeys [][]byte) (ret io.ReadWriter, encrypted bool, err error) {
1049 var protocol [len(pp.Protocol)]byte
1050 _, err = io.ReadFull(rw, protocol[:])
1055 io.MultiReader(bytes.NewReader(protocol[:]), rw),
1058 if string(protocol[:]) == pp.Protocol {
1062 ret, err = mse.ReceiveHandshake(ret, skeys)
1066 func (cl *Client) receiveSkeys() (ret [][]byte) {
1067 for ih := range cl.torrents {
1068 ret = append(ret, ih[:])
1073 func (me *Client) initiateHandshakes(c *connection, t *torrent) (ok bool, err error) {
1075 c.rw, err = mse.InitiateHandshake(c.rw, t.InfoHash[:], nil)
1080 ih, ok, err := me.connBTHandshake(c, &t.InfoHash)
1081 if ih != t.InfoHash {
1087 // Do encryption and bittorrent handshakes as receiver.
1088 func (cl *Client) receiveHandshakes(c *connection) (t *torrent, err error) {
1090 skeys := cl.receiveSkeys()
1092 if !cl.config.DisableEncryption {
1093 c.rw, c.encrypted, err = maybeReceiveEncryptedHandshake(c.rw, skeys)
1095 if err == mse.ErrNoSecretKeyMatch {
1101 ih, ok, err := cl.connBTHandshake(c, nil)
1103 err = fmt.Errorf("error during bt handshake: %s", err)
1115 // Returns !ok if handshake failed for valid reasons.
1116 func (cl *Client) connBTHandshake(c *connection, ih *InfoHash) (ret InfoHash, ok bool, err error) {
1117 res, ok, err := handshake(c.rw, ih, cl.peerID, cl.extensionBytes)
1118 if err != nil || !ok {
1122 c.PeerExtensionBytes = res.peerExtensionBytes
1123 c.PeerID = res.peerID
1124 c.completedHandshake = time.Now()
1128 func (cl *Client) runInitiatedHandshookConn(c *connection, t *torrent) (err error) {
1129 if c.PeerID == cl.peerID {
1130 // Only if we initiated the connection is the remote address a
1131 // listen addr for a doppleganger.
1133 addr := c.conn.RemoteAddr().String()
1134 cl.dopplegangerAddrs[addr] = struct{}{}
1137 return cl.runHandshookConn(c, t)
1140 func (cl *Client) runReceivedConn(c *connection) (err error) {
1141 err = c.conn.SetDeadline(time.Now().Add(handshakesTimeout))
1145 t, err := cl.receiveHandshakes(c)
1147 err = fmt.Errorf("error receiving handshakes: %s", err)
1154 defer cl.mu.Unlock()
1155 if c.PeerID == cl.peerID {
1158 return cl.runHandshookConn(c, t)
1161 func (cl *Client) runHandshookConn(c *connection, t *torrent) (err error) {
1162 c.conn.SetWriteDeadline(time.Time{})
1164 deadlineReader{c.conn, c.rw},
1167 completedHandshakeConnectionFlags.Add(c.connectionFlags(), 1)
1168 if !cl.addConnection(t, c) {
1171 defer cl.dropConnection(t, c)
1173 go c.writeOptimizer(time.Minute)
1174 cl.sendInitialMessages(c, t)
1176 t.initRequestOrdering(c)
1178 err = cl.connectionLoop(t, c)
1180 err = fmt.Errorf("error during connection loop: %s", err)
1185 func (me *Client) sendInitialMessages(conn *connection, torrent *torrent) {
1186 if conn.PeerExtensionBytes.SupportsExtended() && me.extensionBytes.SupportsExtended() {
1187 conn.Post(pp.Message{
1189 ExtendedID: pp.HandshakeExtendedID,
1190 ExtendedPayload: func() []byte {
1191 d := map[string]interface{}{
1192 "m": func() (ret map[string]int) {
1193 ret = make(map[string]int, 2)
1194 ret["ut_metadata"] = metadataExtendedId
1195 if !me.config.DisablePEX {
1196 ret["ut_pex"] = pexExtendedId
1200 "v": extendedHandshakeClientVersion,
1201 // No upload queue is implemented yet.
1204 if !me.config.DisableEncryption {
1207 if torrent.metadataSizeKnown() {
1208 d["metadata_size"] = torrent.metadataSize()
1210 if p := me.incomingPeerPort(); p != 0 {
1213 yourip, err := addrCompactIP(conn.remoteAddr())
1215 log.Printf("error calculating yourip field value in extension handshake: %s", err)
1217 d["yourip"] = yourip
1219 // log.Printf("sending %v", d)
1220 b, err := bencode.Marshal(d)
1228 if torrent.haveAnyPieces() {
1229 conn.Post(pp.Message{
1231 Bitfield: torrent.bitfield(),
1233 } else if me.extensionBytes.SupportsFast() && conn.PeerExtensionBytes.SupportsFast() {
1234 conn.Post(pp.Message{
1238 if conn.PeerExtensionBytes.SupportsDHT() && me.extensionBytes.SupportsDHT() && me.dHT != nil {
1239 conn.Post(pp.Message{
1241 Port: uint16(AddrPort(me.dHT.Addr())),
1246 // Randomizes the piece order for this connection. Every connection will be
1247 // given a different ordering. Having it stored per connection saves having to
1248 // randomize during request filling, and constantly recalculate the ordering
1249 // based on piece priorities.
1250 func (t *torrent) initRequestOrdering(c *connection) {
1251 if c.pieceRequestOrder != nil || c.piecePriorities != nil {
1252 panic("double init of request ordering")
1254 c.pieceRequestOrder = pieceordering.New()
1255 for i := range iter.N(t.Info.NumPieces()) {
1256 if !c.PeerHasPiece(i) {
1259 if !t.wantPiece(i) {
1262 t.connPendPiece(c, i)
1266 func (me *Client) peerGotPiece(t *torrent, c *connection, piece int) error {
1269 if c.PeerPieces == nil {
1270 c.PeerPieces = make([]bool, t.numPieces())
1273 for piece >= len(c.PeerPieces) {
1274 c.PeerPieces = append(c.PeerPieces, false)
1277 if piece >= len(c.PeerPieces) {
1278 return errors.New("peer got out of range piece index")
1280 c.PeerPieces[piece] = true
1282 if t.wantPiece(piece) {
1283 t.connPendPiece(c, piece)
1284 me.replenishConnRequests(t, c)
1289 func (me *Client) peerUnchoked(torrent *torrent, conn *connection) {
1290 me.replenishConnRequests(torrent, conn)
1293 func (cl *Client) connCancel(t *torrent, cn *connection, r request) (ok bool) {
1296 postedCancels.Add(1)
1301 func (cl *Client) connDeleteRequest(t *torrent, cn *connection, r request) bool {
1302 if !cn.RequestPending(r) {
1305 delete(cn.Requests, r)
1309 func (cl *Client) requestPendingMetadata(t *torrent, c *connection) {
1313 if c.PeerExtensionIDs["ut_metadata"] == 0 {
1314 // Peer doesn't support this.
1317 // Request metadata pieces that we don't have in a random order.
1319 for index := 0; index < t.metadataPieceCount(); index++ {
1320 if !t.haveMetadataPiece(index) && !c.requestedMetadataPiece(index) {
1321 pending = append(pending, index)
1324 for _, i := range mathRand.Perm(len(pending)) {
1325 c.requestMetadataPiece(pending[i])
1329 func (cl *Client) completedMetadata(t *torrent) {
1333 CopyExact(&ih, h.Sum(nil))
1334 if ih != t.InfoHash {
1335 log.Print("bad metadata")
1336 t.invalidateMetadata()
1339 var info metainfo.Info
1340 err := bencode.Unmarshal(t.MetaData, &info)
1342 log.Printf("error unmarshalling metadata: %s", err)
1343 t.invalidateMetadata()
1346 // TODO(anacrolix): If this fails, I think something harsher should be
1348 err = cl.setMetaData(t, &info, t.MetaData)
1350 log.Printf("error setting metadata: %s", err)
1351 t.invalidateMetadata()
1354 if cl.config.Debug {
1355 log.Printf("%s: got metadata from peers", t)
1359 // Process incoming ut_metadata message.
1360 func (cl *Client) gotMetadataExtensionMsg(payload []byte, t *torrent, c *connection) (err error) {
1361 var d map[string]int
1362 err = bencode.Unmarshal(payload, &d)
1364 err = fmt.Errorf("error unmarshalling payload: %s: %q", err, payload)
1367 msgType, ok := d["msg_type"]
1369 err = errors.New("missing msg_type field")
1374 case pp.DataMetadataExtensionMsgType:
1378 begin := len(payload) - metadataPieceSize(d["total_size"], piece)
1379 if begin < 0 || begin >= len(payload) {
1380 log.Printf("got bad metadata piece")
1383 if !c.requestedMetadataPiece(piece) {
1384 log.Printf("got unexpected metadata piece %d", piece)
1387 c.metadataRequests[piece] = false
1388 t.saveMetadataPiece(piece, payload[begin:])
1389 c.UsefulChunksReceived++
1390 c.lastUsefulChunkReceived = time.Now()
1391 if !t.haveAllMetadataPieces() {
1394 cl.completedMetadata(t)
1395 case pp.RequestMetadataExtensionMsgType:
1396 if !t.haveMetadataPiece(piece) {
1397 c.Post(t.newMetadataExtensionMessage(c, pp.RejectMetadataExtensionMsgType, d["piece"], nil))
1400 start := (1 << 14) * piece
1401 c.Post(t.newMetadataExtensionMessage(c, pp.DataMetadataExtensionMsgType, piece, t.MetaData[start:start+t.metadataPieceSize(piece)]))
1402 case pp.RejectMetadataExtensionMsgType:
1404 err = errors.New("unknown msg_type value")
1409 // Extracts the port as an integer from an address string.
1410 func addrPort(addr net.Addr) int {
1411 return AddrPort(addr)
1414 func (cl *Client) peerHasAll(t *torrent, cn *connection) {
1415 cn.peerHasAll = true
1418 for i := 0; i < t.numPieces(); i++ {
1419 cl.peerGotPiece(t, cn, i)
1424 func (me *Client) upload(t *torrent, c *connection) {
1425 if me.config.NoUpload {
1428 if !c.PeerInterested {
1431 seeding := me.seeding(t)
1432 if !seeding && !t.connHasWantedPieces(c) {
1436 for seeding || c.chunksSent < c.UsefulChunksReceived+6 {
1438 for r := range c.PeerRequests {
1439 err := me.sendChunk(t, c, r)
1441 log.Printf("error sending chunk %+v to peer: %s", r, err)
1443 delete(c.PeerRequests, r)
1451 func (me *Client) sendChunk(t *torrent, c *connection, r request) error {
1452 // Count the chunk being sent, even if it isn't.
1454 b := make([]byte, r.Length)
1455 tp := &t.Pieces[r.Index]
1456 tp.pendingWritesMutex.Lock()
1457 for tp.pendingWrites != 0 {
1458 tp.noPendingWrites.Wait()
1460 tp.pendingWritesMutex.Unlock()
1461 p := t.Info.Piece(int(r.Index))
1462 n, err := dataReadAt(t.data, b, p.Offset()+int64(r.Begin))
1475 uploadChunksPosted.Add(1)
1476 c.lastChunkSent = time.Now()
1480 // Processes incoming bittorrent messages. The client lock is held upon entry
1482 func (me *Client) connectionLoop(t *torrent, c *connection) error {
1483 decoder := pp.Decoder{
1484 R: bufio.NewReader(c.rw),
1485 MaxLength: 256 * 1024,
1490 err := decoder.Decode(&msg)
1491 receivedMessageTypes.Add(strconv.FormatInt(int64(msg.Type), 10), 1)
1493 c.lastMessageReceived = time.Now()
1500 if me.stopped() || err == io.EOF {
1511 for r := range c.Requests {
1512 me.connDeleteRequest(t, c, r)
1514 // We can then reset our interest.
1515 me.replenishConnRequests(t, c)
1517 me.connDeleteRequest(t, c, newRequest(msg.Index, msg.Begin, msg.Length))
1518 me.replenishConnRequests(t, c)
1520 c.PeerChoked = false
1521 me.peerUnchoked(t, c)
1523 c.PeerInterested = true
1525 case pp.NotInterested:
1526 c.PeerInterested = false
1529 me.peerGotPiece(t, c, int(msg.Index))
1534 if !c.PeerInterested {
1535 err = errors.New("peer sent request but isn't interested")
1538 if c.PeerRequests == nil {
1539 c.PeerRequests = make(map[request]struct{}, maxRequests)
1541 c.PeerRequests[newRequest(msg.Index, msg.Begin, msg.Length)] = struct{}{}
1544 req := newRequest(msg.Index, msg.Begin, msg.Length)
1545 if !c.PeerCancel(req) {
1546 unexpectedCancels.Add(1)
1549 if c.PeerPieces != nil || c.peerHasAll {
1550 err = errors.New("received unexpected bitfield")
1554 if len(msg.Bitfield) < t.numPieces() {
1555 err = errors.New("received invalid bitfield")
1558 msg.Bitfield = msg.Bitfield[:t.numPieces()]
1560 c.PeerPieces = msg.Bitfield
1561 for index, has := range c.PeerPieces {
1563 me.peerGotPiece(t, c, index)
1567 if c.PeerPieces != nil || c.peerHasAll {
1568 err = errors.New("unexpected have-all")
1573 if c.peerHasAll || c.PeerPieces != nil {
1574 err = errors.New("unexpected have-none")
1577 c.PeerPieces = make([]bool, func() int {
1579 return t.numPieces()
1585 err = me.downloadedChunk(t, c, &msg)
1587 switch msg.ExtendedID {
1588 case pp.HandshakeExtendedID:
1589 // TODO: Create a bencode struct for this.
1590 var d map[string]interface{}
1591 err = bencode.Unmarshal(msg.ExtendedPayload, &d)
1593 err = fmt.Errorf("error decoding extended message payload: %s", err)
1596 // log.Printf("got handshake from %q: %#v", c.Socket.RemoteAddr().String(), d)
1597 if reqq, ok := d["reqq"]; ok {
1598 if i, ok := reqq.(int64); ok {
1599 c.PeerMaxRequests = int(i)
1602 if v, ok := d["v"]; ok {
1603 c.PeerClientName = v.(string)
1607 err = errors.New("handshake missing m item")
1610 mTyped, ok := m.(map[string]interface{})
1612 err = errors.New("handshake m value is not dict")
1615 if c.PeerExtensionIDs == nil {
1616 c.PeerExtensionIDs = make(map[string]byte, len(mTyped))
1618 for name, v := range mTyped {
1621 log.Printf("bad handshake m item extension ID type: %T", v)
1625 delete(c.PeerExtensionIDs, name)
1627 if c.PeerExtensionIDs[name] == 0 {
1628 supportedExtensionMessages.Add(name, 1)
1630 c.PeerExtensionIDs[name] = byte(id)
1633 metadata_sizeUntyped, ok := d["metadata_size"]
1635 metadata_size, ok := metadata_sizeUntyped.(int64)
1637 log.Printf("bad metadata_size type: %T", metadata_sizeUntyped)
1639 t.setMetadataSize(metadata_size, me)
1642 if _, ok := c.PeerExtensionIDs["ut_metadata"]; ok {
1643 me.requestPendingMetadata(t, c)
1645 case metadataExtendedId:
1646 err = me.gotMetadataExtensionMsg(msg.ExtendedPayload, t, c)
1648 err = fmt.Errorf("error handling metadata extension message: %s", err)
1651 if me.config.DisablePEX {
1654 var pexMsg peerExchangeMessage
1655 err := bencode.Unmarshal(msg.ExtendedPayload, &pexMsg)
1657 err = fmt.Errorf("error unmarshalling PEX message: %s", err)
1662 me.addPeers(t, func() (ret []Peer) {
1663 for i, cp := range pexMsg.Added {
1665 IP: make([]byte, 4),
1667 Source: peerSourcePEX,
1669 if i < len(pexMsg.AddedFlags) && pexMsg.AddedFlags[i]&0x01 != 0 {
1670 p.SupportsEncryption = true
1672 CopyExact(p.IP, cp.IP[:])
1673 ret = append(ret, p)
1680 err = fmt.Errorf("unexpected extended message ID: %v", msg.ExtendedID)
1683 // That client uses its own extension IDs for outgoing message
1684 // types, which is incorrect.
1685 if bytes.HasPrefix(c.PeerID[:], []byte("-SD0100-")) ||
1686 strings.HasPrefix(string(c.PeerID[:]), "-XL0012-") {
1694 pingAddr, err := net.ResolveUDPAddr("", c.remoteAddr().String())
1699 pingAddr.Port = int(msg.Port)
1701 _, err = me.dHT.Ping(pingAddr)
1703 err = fmt.Errorf("received unknown message type: %#v", msg.Type)
1711 // Returns true if connection is removed from torrent.Conns.
1712 func (me *Client) deleteConnection(t *torrent, c *connection) bool {
1713 for i0, _c := range t.Conns {
1717 i1 := len(t.Conns) - 1
1719 t.Conns[i0] = t.Conns[i1]
1721 t.Conns = t.Conns[:i1]
1727 func (me *Client) dropConnection(t *torrent, c *connection) {
1728 me.event.Broadcast()
1730 if c.piecePriorities != nil {
1731 t.connPiecePriorites.Put(c.piecePriorities)
1732 // I wonder if it's safe to set it to nil. Probably not. Since it's
1733 // only read, it doesn't particularly matter if a closing connection
1734 // shares the slice with another connection.
1736 if me.deleteConnection(t, c) {
1741 // Returns true if the connection is added.
1742 func (me *Client) addConnection(t *torrent, c *connection) bool {
1747 case <-t.ceasingNetworking:
1751 if !me.wantConns(t) {
1754 for _, c0 := range t.Conns {
1755 if c.PeerID == c0.PeerID {
1756 // Already connected to a client with that ID.
1757 duplicateClientConns.Add(1)
1761 if len(t.Conns) >= socketsPerTorrent {
1762 c := t.worstBadConn(me)
1766 if me.config.Debug && missinggo.CryHeard() {
1767 log.Printf("%s: dropping connection to make room for new one:\n %s", t, c)
1770 me.deleteConnection(t, c)
1772 if len(t.Conns) >= socketsPerTorrent {
1775 t.Conns = append(t.Conns, c)
1779 func (t *torrent) needData() bool {
1783 if len(t.urgent) != 0 {
1786 for i := range t.Pieces {
1788 if p.Priority != PiecePriorityNone {
1795 func (cl *Client) usefulConn(t *torrent, c *connection) bool {
1802 return c.supportsExtension("ut_metadata")
1805 return c.PeerInterested
1807 return t.connHasWantedPieces(c)
1810 func (me *Client) wantConns(t *torrent) bool {
1811 if !me.seeding(t) && !t.needData() {
1814 if len(t.Conns) < socketsPerTorrent {
1817 return t.worstBadConn(me) != nil
1820 func (me *Client) openNewConns(t *torrent) {
1822 case <-t.ceasingNetworking:
1826 for len(t.Peers) != 0 {
1827 if !me.wantConns(t) {
1830 if len(t.HalfOpen) >= me.halfOpenLimit {
1837 for k, p = range t.Peers {
1841 me.initiateConn(p, t)
1843 t.wantPeers.Broadcast()
1846 func (me *Client) addPeers(t *torrent, peers []Peer) {
1847 for _, p := range peers {
1848 if me.dopplegangerAddr(net.JoinHostPort(
1850 strconv.FormatInt(int64(p.Port), 10),
1854 if _, ok := me.ipBlockRange(p.IP); ok {
1858 // The spec says to scrub these yourselves. Fine.
1865 func (cl *Client) cachedMetaInfoFilename(ih InfoHash) string {
1866 return filepath.Join(cl.configDir(), "torrents", ih.HexString()+".torrent")
1869 func (cl *Client) saveTorrentFile(t *torrent) error {
1870 path := cl.cachedMetaInfoFilename(t.InfoHash)
1871 os.MkdirAll(filepath.Dir(path), 0777)
1872 f, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0666)
1874 return fmt.Errorf("error opening file: %s", err)
1877 e := bencode.NewEncoder(f)
1878 err = e.Encode(t.MetaInfo())
1880 return fmt.Errorf("error marshalling metainfo: %s", err)
1882 mi, err := cl.torrentCacheMetaInfo(t.InfoHash)
1884 // For example, a script kiddy makes us load too many files, and we're
1885 // able to save the torrent, but not load it again to check it.
1888 if !bytes.Equal(mi.Info.Hash, t.InfoHash[:]) {
1889 log.Fatalf("%x != %x", mi.Info.Hash, t.InfoHash[:])
1894 func (cl *Client) startTorrent(t *torrent) {
1895 if t.Info == nil || t.data == nil {
1898 // If the client intends to upload, it needs to know what state pieces are
1900 if !cl.config.NoUpload {
1901 // Queue all pieces for hashing. This is done sequentially to avoid
1902 // spamming goroutines.
1903 for i := range t.Pieces {
1904 t.Pieces[i].QueuedForHash = true
1907 for i := range t.Pieces {
1908 cl.verifyPiece(t, pp.Integer(i))
1914 // Storage cannot be changed once it's set.
1915 func (cl *Client) setStorage(t *torrent, td Data) (err error) {
1916 err = t.setStorage(td)
1917 cl.event.Broadcast()
1925 type TorrentDataOpener func(*metainfo.Info) Data
1927 func (cl *Client) setMetaData(t *torrent, md *metainfo.Info, bytes []byte) (err error) {
1928 err = t.setMetadata(md, bytes)
1932 if !cl.config.DisableMetainfoCache {
1933 if err := cl.saveTorrentFile(t); err != nil {
1934 log.Printf("error saving torrent file for %s: %s", t, err)
1937 cl.event.Broadcast()
1938 close(t.gotMetainfo)
1939 td := cl.torrentDataOpener(md)
1940 err = cl.setStorage(t, td)
1944 // Prepare a Torrent without any attachment to a Client. That means we can
1945 // initialize fields all fields that don't require the Client without locking
1947 func newTorrent(ih InfoHash) (t *torrent, err error) {
1950 chunkSize: defaultChunkSize,
1951 Peers: make(map[peersKey]Peer),
1953 closing: make(chan struct{}),
1954 ceasingNetworking: make(chan struct{}),
1956 gotMetainfo: make(chan struct{}),
1958 HalfOpen: make(map[string]struct{}),
1959 pieceStateChanges: pubsub.NewPubSub(),
1961 t.wantPeers.L = &t.stateMu
1966 // For shuffling the tracker tiers.
1967 mathRand.Seed(time.Now().Unix())
1970 // The trackers within each tier must be shuffled before use.
1971 // http://stackoverflow.com/a/12267471/149482
1972 // http://www.bittorrent.org/beps/bep_0012.html#order-of-processing
1973 func shuffleTier(tier []tracker.Client) {
1974 for i := range tier {
1975 j := mathRand.Intn(i + 1)
1976 tier[i], tier[j] = tier[j], tier[i]
1980 func copyTrackers(base [][]tracker.Client) (copy [][]tracker.Client) {
1981 for _, tier := range base {
1982 copy = append(copy, append([]tracker.Client{}, tier...))
1987 func mergeTier(tier []tracker.Client, newURLs []string) []tracker.Client {
1989 for _, url := range newURLs {
1990 for _, tr := range tier {
1991 if tr.URL() == url {
1995 tr, err := tracker.New(url)
1997 // log.Printf("error creating tracker client for %q: %s", url, err)
2000 tier = append(tier, tr)
2005 func (t *torrent) addTrackers(announceList [][]string) {
2006 newTrackers := copyTrackers(t.Trackers)
2007 for tierIndex, tier := range announceList {
2008 if tierIndex < len(newTrackers) {
2009 newTrackers[tierIndex] = mergeTier(newTrackers[tierIndex], tier)
2011 newTrackers = append(newTrackers, mergeTier(nil, tier))
2013 shuffleTier(newTrackers[tierIndex])
2015 t.Trackers = newTrackers
2018 // Don't call this before the info is available.
2019 func (t *torrent) bytesCompleted() int64 {
2023 return t.Info.TotalLength() - t.bytesLeft()
2026 // A file-like handle to some torrent data resource.
2027 type Handle interface {
2034 // Returns handles to the files in the torrent. This requires the metainfo is
2036 func (t Torrent) Files() (ret []File) {
2044 for _, fi := range info.UpvertedFiles() {
2045 ret = append(ret, File{
2047 strings.Join(append([]string{info.Name}, fi.Path...), "/"),
2057 // Marks the pieces in the given region for download.
2058 func (t Torrent) SetRegionPriority(off, len int64) {
2060 defer t.cl.mu.Unlock()
2061 pieceSize := int64(t.usualPieceSize())
2062 for i := off / pieceSize; i*pieceSize < off+len; i++ {
2063 t.cl.raisePiecePriority(t.torrent, int(i), PiecePriorityNormal)
2067 func (t Torrent) AddPeers(pp []Peer) error {
2070 defer cl.mu.Unlock()
2071 cl.addPeers(t.torrent, pp)
2075 // Marks the entire torrent for download. Requires the info first, see
2077 func (t Torrent) DownloadAll() {
2079 defer t.cl.mu.Unlock()
2080 for i := range iter.N(t.numPieces()) {
2081 t.cl.raisePiecePriority(t.torrent, i, PiecePriorityNormal)
2083 // Nice to have the first and last pieces sooner for various interactive
2085 t.cl.raisePiecePriority(t.torrent, 0, PiecePriorityReadahead)
2086 t.cl.raisePiecePriority(t.torrent, t.numPieces()-1, PiecePriorityReadahead)
2089 // Returns nil metainfo if it isn't in the cache. Checks that the retrieved
2090 // metainfo has the correct infohash.
2091 func (cl *Client) torrentCacheMetaInfo(ih InfoHash) (mi *metainfo.MetaInfo, err error) {
2092 if cl.config.DisableMetainfoCache {
2095 f, err := os.Open(cl.cachedMetaInfoFilename(ih))
2097 if os.IsNotExist(err) {
2103 dec := bencode.NewDecoder(f)
2104 err = dec.Decode(&mi)
2108 if !bytes.Equal(mi.Info.Hash, ih[:]) {
2109 err = fmt.Errorf("cached torrent has wrong infohash: %x != %x", mi.Info.Hash, ih[:])
2115 // Specifies a new torrent for adding to a client. There are helpers for
2116 // magnet URIs and torrent metainfo files.
2117 type TorrentSpec struct {
2118 // The tiered tracker URIs.
2121 Info *metainfo.InfoEx
2122 // The name to use if the Name field from the Info isn't available.
2124 // The chunk size to use for outbound requests. Defaults to 16KiB if not
2129 func TorrentSpecFromMagnetURI(uri string) (spec *TorrentSpec, err error) {
2130 m, err := ParseMagnetURI(uri)
2134 spec = &TorrentSpec{
2135 Trackers: [][]string{m.Trackers},
2136 DisplayName: m.DisplayName,
2137 InfoHash: m.InfoHash,
2142 func TorrentSpecFromMetaInfo(mi *metainfo.MetaInfo) (spec *TorrentSpec) {
2143 spec = &TorrentSpec{
2144 Trackers: mi.AnnounceList,
2146 DisplayName: mi.Info.Name,
2149 if len(spec.Trackers) == 0 {
2150 spec.Trackers = [][]string{[]string{mi.Announce}}
2152 spec.Trackers[0] = append(spec.Trackers[0], mi.Announce)
2155 CopyExact(&spec.InfoHash, &mi.Info.Hash)
2159 // Add or merge a torrent spec. If the torrent is already present, the
2160 // trackers will be merged with the existing ones. If the Info isn't yet
2161 // known, it will be set. The display name is replaced if the new spec
2162 // provides one. Returns new if the torrent wasn't already in the client.
2163 func (cl *Client) AddTorrentSpec(spec *TorrentSpec) (D Download, new bool, err error) {
2168 defer cl.mu.Unlock()
2170 t, ok := cl.torrents[spec.InfoHash]
2174 if _, ok := cl.bannedTorrents[spec.InfoHash]; ok {
2175 err = errors.New("banned torrent")
2179 t, err = newTorrent(spec.InfoHash)
2183 if spec.ChunkSize != 0 {
2184 t.chunkSize = pp.Integer(spec.ChunkSize)
2187 if spec.DisplayName != "" {
2188 t.setDisplayName(spec.DisplayName)
2190 // Try to merge in info we have on the torrent. Any err left will
2191 // terminate the function.
2193 if spec.Info != nil {
2194 err = cl.setMetaData(t, &spec.Info.Info, spec.Info.Bytes)
2196 var mi *metainfo.MetaInfo
2197 mi, err = cl.torrentCacheMetaInfo(spec.InfoHash)
2199 log.Printf("error getting cached metainfo: %s", err)
2201 } else if mi != nil {
2202 t.addTrackers(mi.AnnounceList)
2203 err = cl.setMetaData(t, &mi.Info.Info, mi.Info.Bytes)
2210 t.addTrackers(spec.Trackers)
2212 cl.torrents[spec.InfoHash] = t
2215 // From this point onwards, we can consider the torrent a part of the
2218 if !cl.config.DisableTrackers {
2219 go cl.announceTorrentTrackers(T.torrent)
2222 go cl.announceTorrentDHT(T.torrent, true)
2228 func (me *Client) dropTorrent(infoHash InfoHash) (err error) {
2229 t, ok := me.torrents[infoHash]
2231 err = fmt.Errorf("no such torrent")
2238 delete(me.torrents, infoHash)
2242 // Returns true when peers are required, or false if the torrent is closing.
2243 func (cl *Client) waitWantPeers(t *torrent) bool {
2245 defer cl.mu.Unlock()
2247 defer t.stateMu.Unlock()
2250 case <-t.ceasingNetworking:
2254 if len(t.Peers) > torrentPeersLowWater {
2257 if t.needData() || cl.seeding(t) {
2269 // Returns whether the client should make effort to seed the torrent.
2270 func (cl *Client) seeding(t *torrent) bool {
2271 if cl.config.NoUpload {
2274 if !cl.config.Seed {
2283 func (cl *Client) announceTorrentDHT(t *torrent, impliedPort bool) {
2284 for cl.waitWantPeers(t) {
2285 // log.Printf("getting peers for %q from DHT", t)
2286 ps, err := cl.dHT.Announce(string(t.InfoHash[:]), cl.incomingPeerPort(), impliedPort)
2288 log.Printf("error getting peers from dht: %s", err)
2291 // Count all the unique addresses we got during this announce.
2292 allAddrs := make(map[string]struct{})
2296 case v, ok := <-ps.Peers:
2300 addPeers := make([]Peer, 0, len(v.Peers))
2301 for _, cp := range v.Peers {
2303 // Can't do anything with this.
2306 addPeers = append(addPeers, Peer{
2309 Source: peerSourceDHT,
2311 key := (&net.UDPAddr{
2315 allAddrs[key] = struct{}{}
2318 cl.addPeers(t, addPeers)
2319 numPeers := len(t.Peers)
2321 if numPeers >= torrentPeersHighWater {
2324 case <-t.ceasingNetworking:
2330 // log.Printf("finished DHT peer scrape for %s: %d peers", t, len(allAddrs))
2334 func (cl *Client) trackerBlockedUnlocked(tr tracker.Client) (blocked bool, err error) {
2335 url_, err := url.Parse(tr.URL())
2339 host, _, err := net.SplitHostPort(url_.Host)
2343 addr, err := net.ResolveIPAddr("ip", host)
2348 _, blocked = cl.ipBlockRange(addr.IP)
2353 func (cl *Client) announceTorrentSingleTracker(tr tracker.Client, req *tracker.AnnounceRequest, t *torrent) error {
2354 blocked, err := cl.trackerBlockedUnlocked(tr)
2356 return fmt.Errorf("error determining if tracker blocked: %s", err)
2359 return fmt.Errorf("tracker blocked: %s", tr)
2361 if err := tr.Connect(); err != nil {
2362 return fmt.Errorf("error connecting: %s", err)
2364 resp, err := tr.Announce(req)
2366 return fmt.Errorf("error announcing: %s", err)
2369 for _, peer := range resp.Peers {
2370 peers = append(peers, Peer{
2376 cl.addPeers(t, peers)
2379 // log.Printf("%s: %d new peers from %s", t, len(peers), tr)
2381 time.Sleep(time.Second * time.Duration(resp.Interval))
2385 func (cl *Client) announceTorrentTrackersFastStart(req *tracker.AnnounceRequest, trackers [][]tracker.Client, t *torrent) (atLeastOne bool) {
2386 oks := make(chan bool)
2388 for _, tier := range trackers {
2389 for _, tr := range tier {
2391 go func(tr tracker.Client) {
2392 err := cl.announceTorrentSingleTracker(tr, req, t)
2397 for outstanding > 0 {
2407 // Announce torrent to its trackers.
2408 func (cl *Client) announceTorrentTrackers(t *torrent) {
2409 req := tracker.AnnounceRequest{
2410 Event: tracker.Started,
2412 Port: uint16(cl.incomingPeerPort()),
2414 InfoHash: t.InfoHash,
2416 if !cl.waitWantPeers(t) {
2420 req.Left = uint64(t.bytesLeft())
2421 trackers := t.Trackers
2423 if cl.announceTorrentTrackersFastStart(&req, trackers, t) {
2424 req.Event = tracker.None
2427 for cl.waitWantPeers(t) {
2429 req.Left = uint64(t.bytesLeft())
2430 trackers = t.Trackers
2432 numTrackersTried := 0
2433 for _, tier := range trackers {
2434 for trIndex, tr := range tier {
2436 err := cl.announceTorrentSingleTracker(tr, &req, t)
2437 if err != nil && missinggo.CryHeard() {
2438 log.Printf("%s: error announcing to %s: %s", t, tr, err)
2441 // Float the successful announce to the top of the tier. If
2442 // the trackers list has been changed, we'll be modifying an
2443 // old copy so it won't matter.
2445 tier[0], tier[trIndex] = tier[trIndex], tier[0]
2448 req.Event = tracker.None
2449 continue newAnnounce
2452 if numTrackersTried != 0 {
2453 log.Printf("%s: all trackers failed", t)
2455 // TODO: Wait until trackers are added if there are none.
2456 time.Sleep(10 * time.Second)
2460 func (cl *Client) allTorrentsCompleted() bool {
2461 for _, t := range cl.torrents {
2465 if t.numPiecesCompleted() != t.numPieces() {
2472 // Returns true when all torrents are completely downloaded and false if the
2473 // client is stopped before that.
2474 func (me *Client) WaitAll() bool {
2476 defer me.mu.Unlock()
2477 for !me.allTorrentsCompleted() {
2486 func (me *Client) fillRequests(t *torrent, c *connection) {
2491 if len(c.Requests) > c.requestsLowWater {
2495 addRequest := func(req request) (again bool) {
2496 // TODO: Couldn't this check also be done *after* the request?
2497 if len(c.Requests) >= 64 {
2500 return c.Request(req)
2502 for req := range t.urgent {
2503 if !addRequest(req) {
2507 for e := c.pieceRequestOrder.First(); e != nil; e = e.Next() {
2508 pieceIndex := e.Piece()
2509 if !c.PeerHasPiece(pieceIndex) {
2510 panic("piece in request order but peer doesn't have it")
2512 if !t.wantPiece(pieceIndex) {
2513 log.Printf("unwanted piece %d in connection request order\n%s", pieceIndex, c)
2514 c.pieceRequestOrder.DeletePiece(pieceIndex)
2517 piece := &t.Pieces[pieceIndex]
2518 for _, cs := range piece.shuffledPendingChunkSpecs(t.pieceLength(pieceIndex), pp.Integer(t.chunkSize)) {
2519 r := request{pp.Integer(pieceIndex), cs}
2528 func (me *Client) replenishConnRequests(t *torrent, c *connection) {
2532 me.fillRequests(t, c)
2533 if len(c.Requests) == 0 && !c.PeerChoked {
2534 // So we're not choked, but we don't want anything right now. We may
2535 // have completed readahead, and the readahead window has not rolled
2536 // over to the next piece. Better to stay interested in case we're
2537 // going to want data in the near future.
2538 c.SetInterested(!t.haveAllPieces())
2542 // Handle a received chunk from a peer.
2543 func (me *Client) downloadedChunk(t *torrent, c *connection, msg *pp.Message) error {
2544 chunksReceived.Add(1)
2546 req := newRequest(msg.Index, msg.Begin, pp.Integer(len(msg.Piece)))
2548 // Request has been satisfied.
2549 if me.connDeleteRequest(t, c, req) {
2550 defer me.replenishConnRequests(t, c)
2552 unexpectedChunksReceived.Add(1)
2555 piece := &t.Pieces[req.Index]
2557 // Do we actually want this chunk?
2558 if !t.wantChunk(req) {
2559 unwantedChunksReceived.Add(1)
2560 c.UnwantedChunksReceived++
2564 c.UsefulChunksReceived++
2565 c.lastUsefulChunkReceived = time.Now()
2569 piece.pendingWritesMutex.Lock()
2570 piece.pendingWrites++
2571 piece.pendingWritesMutex.Unlock()
2574 piece.pendingWritesMutex.Lock()
2575 piece.pendingWrites--
2576 if piece.pendingWrites == 0 {
2577 piece.noPendingWrites.Broadcast()
2579 piece.pendingWritesMutex.Unlock()
2581 // Write the chunk out.
2582 tr := perf.NewTimer()
2583 err := t.writeChunk(int(msg.Index), int64(msg.Begin), msg.Piece)
2585 log.Printf("error writing chunk: %s", err)
2588 tr.Stop("write chunk")
2590 if c.peerTouchedPieces == nil {
2591 c.peerTouchedPieces = make(map[int]struct{})
2593 c.peerTouchedPieces[int(req.Index)] = struct{}{}
2597 // log.Println("got chunk", req)
2598 me.event.Broadcast()
2599 defer t.publishPieceChange(int(req.Index))
2600 // Record that we have the chunk.
2601 piece.unpendChunkIndex(chunkIndex(req.chunkSpec, t.chunkSize))
2602 delete(t.urgent, req)
2603 // It's important that the piece is potentially queued before we check if
2604 // the piece is still wanted, because if it is queued, it won't be wanted.
2605 if piece.numPendingChunks() == 0 {
2606 me.queuePieceCheck(t, req.Index)
2608 if !t.wantPiece(int(req.Index)) {
2609 for _, c := range t.Conns {
2610 c.pieceRequestOrder.DeletePiece(int(req.Index))
2614 // Cancel pending requests for this chunk.
2615 for _, c := range t.Conns {
2616 if me.connCancel(t, c, req) {
2617 me.replenishConnRequests(t, c)
2624 // Return the connections that touched a piece, and clear the entry while
2626 func (me *Client) reapPieceTouches(t *torrent, piece int) (ret []*connection) {
2627 for _, c := range t.Conns {
2628 if _, ok := c.peerTouchedPieces[piece]; ok {
2629 ret = append(ret, c)
2630 delete(c.peerTouchedPieces, piece)
2636 func (me *Client) pieceHashed(t *torrent, piece pp.Integer, correct bool) {
2637 p := &t.Pieces[piece]
2639 // Don't score the first time a piece is hashed, it could be an
2642 pieceHashedCorrect.Add(1)
2644 log.Printf("%s: piece %d failed hash", t, piece)
2645 pieceHashedNotCorrect.Add(1)
2649 touchers := me.reapPieceTouches(t, int(piece))
2651 err := t.data.PieceCompleted(int(piece))
2653 log.Printf("error completing piece: %s", err)
2656 } else if len(touchers) != 0 {
2657 log.Printf("dropping %d conns that touched piece", len(touchers))
2658 for _, c := range touchers {
2659 me.dropConnection(t, c)
2662 me.pieceChanged(t, int(piece))
2665 // TODO: Check this isn't called more than once for each piece being correct.
2666 func (me *Client) pieceChanged(t *torrent, piece int) {
2667 correct := t.pieceComplete(piece)
2668 p := &t.Pieces[piece]
2669 defer t.publishPieceChange(piece)
2670 defer me.event.Broadcast()
2672 p.Priority = PiecePriorityNone
2673 p.PendingChunkSpecs = nil
2674 for req := range t.urgent {
2675 if int(req.Index) == piece {
2676 delete(t.urgent, req)
2680 if p.numPendingChunks() == 0 {
2681 t.pendAllChunkSpecs(int(piece))
2683 if t.wantPiece(piece) {
2687 for _, conn := range t.Conns {
2689 conn.Post(pp.Message{
2691 Index: pp.Integer(piece),
2693 // TODO: Cancel requests for this piece.
2694 for r := range conn.Requests {
2695 if int(r.Index) == piece {
2699 conn.pieceRequestOrder.DeletePiece(int(piece))
2701 } else if t.wantPiece(piece) && conn.PeerHasPiece(piece) {
2702 t.connPendPiece(conn, int(piece))
2703 me.replenishConnRequests(t, conn)
2706 me.event.Broadcast()
2709 func (cl *Client) verifyPiece(t *torrent, index pp.Integer) {
2711 defer cl.mu.Unlock()
2712 p := &t.Pieces[index]
2713 for p.Hashing || t.data == nil {
2716 p.QueuedForHash = false
2717 if t.isClosed() || t.pieceComplete(int(index)) {
2722 sum := t.hashPiece(index)
2730 cl.pieceHashed(t, index, sum == p.Hash)
2733 // Returns handles to all the torrents loaded in the Client.
2734 func (me *Client) Torrents() (ret []Download) {
2736 for _, t := range me.torrents {
2737 ret = append(ret, Torrent{me, t})
2743 func (me *Client) AddMagnet(uri string) (T Download, err error) {
2744 spec, err := TorrentSpecFromMagnetURI(uri)
2748 T, _, err = me.AddTorrentSpec(spec)
2752 func (me *Client) AddTorrent(mi *metainfo.MetaInfo) (T Download, err error) {
2753 T, _, err = me.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
2757 func (me *Client) AddTorrentFromFile(filename string) (T Download, err error) {
2758 mi, err := metainfo.LoadFromFile(filename)
2762 T, _, err = me.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
2766 func (me *Client) DHT() *dht.Server {