Go to file
Matt Joiner 8c9a308c9a Only steal an odd request if the stealer more recently received a chunk
This helps break the stealing cycle during endgame, and lets us trickle the request to the peer conn with the best record. It might not be sufficient but works nice in testing so far.
2021-12-12 18:35:01 +11:00
.circleci Don't bench with -race 2021-02-24 13:48:05 +11:00
.github/workflows Don't fail-fast on go versions 2021-12-07 12:42:35 +11:00
analysis Add peer upload order analysis 2021-01-28 16:31:13 +11:00
bencode Add failing bencode fuzz input 2021-12-12 16:56:01 +11:00
cmd gofumpt 2021-11-19 16:19:32 +11:00
common Got file storage working with segment index 2020-06-01 00:14:51 +10:00
fs Generate full sintel magnet link in fs test 2021-12-12 15:01:50 +11:00
internal Extract chansync to github.com/anacrolix/chansync 2021-06-07 13:01:40 +10:00
iplist gofumpt 2021-11-08 14:47:01 +11:00
logonce Add a prefix to logonce logger output 2018-09-03 11:48:31 +10:00
metainfo Comment that BEP 19 is WebSeeds 2021-11-12 10:45:47 +11:00
mmap_span gofumpt 2021-11-08 14:47:01 +11:00
mse gofumpt 2021-11-08 14:47:01 +11:00
peer_protocol [fuzz] Put +build tags to support go1.16 as well 2021-11-01 11:26:58 +11:00
request-strategy Improve panic message 2021-12-12 18:35:01 +11:00
segments gofumpt 2021-11-08 14:47:01 +11:00
storage Fix wasm build 2021-12-07 13:08:06 +11:00
test gofumpt 2021-11-08 14:47:01 +11:00
testdata Add sintel.torrent 2021-12-12 15:01:50 +11:00
tracker bencode: Enforce dict key ordering 2021-12-12 16:56:01 +11:00
types Extract request strategy stuff into a separate module 2021-06-07 13:01:39 +10:00
util/dirwatch Add linter CI (#542) 2021-08-16 11:11:31 +10:00
version Update and expose default client identifiers 2021-06-25 11:29:59 +10:00
webseed Handle 503 returns from webseed peer endpoints 2021-12-06 15:24:28 +11:00
webtorrent Add generalized decodeJsonByteString and a fuzz target for it 2021-12-12 16:56:01 +11:00
.deepsource.toml fixed code quality issues using DeepSource 2021-01-30 15:23:49 +11:00
.gitignore Ignore request strategy run gobs and envrcs 2021-10-19 14:08:56 +11:00
.golangci.yml Update staticcheck go target to 1.16 2021-08-19 16:06:24 +10:00
LICENSE Update LICENSE 2018-01-27 11:21:33 +11:00
NOTES.md Add NOTES 2021-09-20 12:31:44 +10:00
README.md Revert "Link to godocs.io for documentation" 2021-12-12 17:20:02 +11:00
SECURITY.md Create SECURITY.md 2021-05-14 10:17:19 +10:00
TODO Update TODO file 2018-04-14 21:44:50 +10:00
bad_storage.go Rework storage.TorrentImpl to support shared capacity key 2021-06-07 13:01:39 +10:00
bep40.go Move IpPort to missinggo 2018-11-16 10:35:30 +11:00
bep40_test.go fixes various vet errors 2020-01-14 09:09:09 +10:00
callbacks.go Expose more callbacks and Request and ChunkSpec 2021-01-28 14:23:22 +11:00
client-nowasm_test.go Revert "Remove old-style build tags" 2021-11-01 11:26:58 +11:00
client.go Implement piece request ordering with retained state 2021-12-12 18:35:01 +11:00
client_test.go gofumpt 2021-11-08 14:47:01 +11:00
config.go gofumpt 2021-11-08 14:47:01 +11:00
conn_stats.go Track chunks read for webseed peers too 2021-06-07 13:01:40 +10:00
deferrwl.go lockWithDeferreds: inlineable Unlock() (#603) 2021-09-17 13:08:00 +10:00
dht.go Expose AnacrolixDhtServerWrapper 2021-06-07 13:01:40 +10:00
dialer.go Tidy up the Dialer interface 2021-06-21 13:29:26 +10:00
doc.go BEP27 isn't implemented 2020-05-24 17:47:16 +10:00
example_test.go Add File.NewReader 2018-01-06 16:37:13 +11:00
file.go Add reasons for updateRequests to be triggered 2021-10-19 14:08:56 +11:00
file_test.go gofumpt 2021-11-08 14:47:01 +11:00
global.go go fmt ./... 2021-10-05 17:48:52 +11:00
go.mod Retract last few minor versions with peer-requesting issues 2021-12-12 18:34:31 +11:00
go.sum PEX: use new NodeAddr search methods in krpc 2021-12-11 19:18:30 +00:00
handshake.go Add the ReceiveEncryptedHandshakeSkeys callback 2020-11-05 13:28:45 +11:00
handshake_test.go Support AllowedFast and enable fast extension 2018-02-05 00:18:38 +11:00
ipport.go Possible fix for GitHub code scanning warning 2021-05-14 15:43:13 +10:00
issue97_test.go Avoid allocation putting undirtiedChunksIter into interface 2021-10-19 14:08:56 +11:00
issue211_test.go Revert "Remove old-style build tags" 2021-11-01 11:26:58 +11:00
listen.go Optimize `LoopbackListenHost()` (#615) 2021-09-14 21:54:37 +10:00
main_test.go Replace internal/tmproot with Testing.TB.TempDir 2021-02-22 14:30:09 +11:00
misc.go Rework Reader waiting 2021-09-04 23:07:32 +10:00
misc_test.go Drop bradfitz/iter dependency (#605) 2021-09-14 13:46:50 +10:00
multiless.go Fixes for wasm 2021-06-23 17:24:50 +10:00
network_test.go Fixes for wasm 2021-06-23 17:24:50 +10:00
networks.go Improve network handling and only listen networks we will use 2018-11-28 10:30:21 +11:00
peer-conn-msg-writer.go Avoid reallocating keep alive timer on each pass 2021-08-22 20:05:53 +10:00
peer-impl.go Update peer cancel assumptions and return 2021-12-12 18:35:01 +11:00
peer_info.go Don't expose Peer network through RemoteAddr 2021-01-25 15:49:48 +11:00
peer_infos.go Rename Peer to PeerInfo, and unexport PeerInfos 2020-05-29 19:44:48 +10:00
peerconn.go Add Torrent-level request cancel for consistency 2021-12-12 18:35:01 +11:00
peerconn_test.go PEX: fluid event log 2021-12-12 00:27:28 +11:00
peerid.go Rename Peer to PeerInfo, and unexport PeerInfos 2020-05-29 19:44:48 +10:00
peerid_test.go Change a bunch of Stringer and status stuff 2018-02-05 17:47:47 +11:00
pending-requests.go Revert "Use a flat slice for pending request counts" 2021-11-25 22:55:02 +11:00
pending-requests_test.go Comment out pending requests tests and asserts 2021-11-25 22:59:20 +11:00
pex.go PEX: remove workaround for krpc marshaller 2021-12-11 19:44:42 +00:00
pex_test.go PEX: fluid event log 2021-12-12 00:27:28 +11:00
pexconn.go PEX: fluid event log 2021-12-12 00:27:28 +11:00
pexconn_test.go Create default constructor for Client (#567) 2021-09-14 23:01:20 +10:00
piece.go Implement piece request ordering with retained state 2021-12-12 18:35:01 +11:00
piecestate.go Track piece marking state separately 2020-11-21 13:44:23 +11:00
portfwd.go Big logging cleanup to improve experience from README 2021-05-04 12:44:51 +10:00
prioritized_peers.go Rename Peer to PeerInfo, and unexport PeerInfos 2020-05-29 19:44:48 +10:00
prioritized_peers_test.go Rename Peer to PeerInfo, and unexport PeerInfos 2020-05-29 19:44:48 +10:00
protocol.go Expose more callbacks and Request and ChunkSpec 2021-01-28 14:23:22 +11:00
ratelimitreader.go Fix download rate limiter and add test 2018-01-28 15:28:45 +11:00
reader.go Provide context to readahead func 2021-11-15 00:53:42 +11:00
reader_test.go Replace internal/tmproot with Testing.TB.TempDir 2021-02-22 14:30:09 +11:00
request-strategy-impls.go Use interfaces to lazily expose the bare minimum inputs to GetRequestablePieces 2021-12-12 18:35:01 +11:00
requesting.go Only steal an odd request if the stealer more recently received a chunk 2021-12-12 18:35:01 +11:00
requesting_test.go Shuffle duplicate requests 2021-12-12 16:56:00 +11:00
rlreader_test.go Drop bradfitz/iter dependency (#605) 2021-09-14 13:46:50 +10:00
roaring.go Track dirty chunks in a single bitmap on Torrent 2021-09-20 18:52:54 +10:00
socket.go Fixes for wasm 2021-06-23 17:24:50 +10:00
spec.go Make TorrentSpecFromMetaInfoErr still usable on info error 2021-11-12 10:46:35 +11:00
struct_test.go Export Peer 2021-01-25 15:49:48 +11:00
t.go Provide context to readahead func 2021-11-15 00:53:42 +11:00
testing.go Support minimum peer extensions 2021-10-25 20:52:44 +11:00
torrent-piece-request-order.go Implement piece request ordering with retained state 2021-12-12 18:35:01 +11:00
torrent.go Add Torrent-level request cancel for consistency 2021-12-12 18:35:01 +11:00
torrent_mmap_test.go Revert "Remove old-style build tags" 2021-11-01 11:26:58 +11:00
torrent_stats.go Add TorrentStats.PiecesComplete 2021-10-07 13:50:13 +11:00
torrent_test.go Support minimum peer extensions 2021-10-25 20:52:44 +11:00
tracker_scraper.go Fix races using resources on Close 2021-12-12 15:01:50 +11:00
url-net-addr.go Generate a RemoteAddr for webseed Peers 2021-01-25 15:49:48 +11:00
utp.go Add support for disabling IPv4 and IPv4 peers 2018-02-16 10:46:11 +11:00
utp_go.go Fix go:build directives 2021-07-14 14:35:52 +10:00
utp_libutp.go Revert "Remove old-style build tags" 2021-11-01 11:26:58 +11:00
utp_test.go Use the new firewall callback support in go-libutp 2018-07-25 17:11:09 +10:00
webrtc.go Upgrade to pion/webrtc@v3 2021-02-21 13:46:37 -08:00
webseed-peer.go Update peer cancel assumptions and return 2021-12-12 18:35:01 +11:00
worse-conns.go Optimize the use of worstConnSlice again 2021-11-29 10:07:48 +11:00
worse-conns_test.go Optimize the use of worstConnSlice again 2021-11-29 10:07:48 +11:00
wstracker.go Fix race running and closing webtorrent tracker clients 2021-10-25 16:15:42 +11:00

README.md

torrent

PkgGoDev

This repository implements BitTorrent-related packages and command-line utilities in Go. The emphasis is on use as a library from other projects. It's been used 24/7 in production by downstream services since late 2014. The implementation was specifically created to explore Go's concurrency capabilities, and to include the ability to stream data directly from the BitTorrent network. To this end it supports seeking, readaheads and other features exposing torrents and their files with the various Go idiomatic io package interfaces. This is also demonstrated through torrentfs.

There is support for protocol encryption, DHT, PEX, uTP, and various extensions. There are several data storage backends provided: blob, file, bolt, mmap, and sqlite, to name a few. You can write your own to store data for example on S3, or in a database.

Some noteworthy package dependencies that can be used for other purposes include:

Installation

Install the library package with go get github.com/anacrolix/torrent, or the provided cmds with go install github.com/anacrolix/torrent/cmd/...@latest.

Library examples

There are some small examples in the package documentation.

Mentions

Downstream projects

There are several web-frontends and Android clients among the known public projects:

Help

Communication about the project is primarily through Discussions and the issue tracker.

Command packages

Here I'll describe what some of the packages in ./cmd do. See installation to make them available.

torrent

torrent download

Downloads torrents from the command-line.

$ torrent download 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
... lots of jibba jabber ...
downloading "ubuntu-14.04.2-desktop-amd64.iso": 1.0 GB/1.0 GB, 1989/1992 pieces completed (1 partial)
2015/04/01 02:08:20 main.go:137: downloaded ALL the torrents
$ md5sum ubuntu-14.04.2-desktop-amd64.iso
1b305d585b1918f297164add46784116  ubuntu-14.04.2-desktop-amd64.iso
$ echo such amaze
wow

torrent metainfo magnet

Creates a magnet link from a torrent file. Note the extracted trackers, display name, and info hash.

$ torrent metainfo testdata/debian-10.8.0-amd64-netinst.iso.torrent magnet
magnet:?xt=urn:btih:4090c3c2a394a49974dfbbf2ce7ad0db3cdeddd7&dn=debian-10.8.0-amd64-netinst.iso&tr=http%3A%2F%2Fbttracker.debian.org%3A6969%2Fannounce

See torrent metainfo --help for other metainfo related commands.

torrentfs

torrentfs mounts a FUSE filesystem at -mountDir. The contents are the torrents described by the torrent files and magnet links at -metainfoDir. Data for read requests is fetched only as required from the torrent network, and stored at -downloadDir.

$ mkdir mnt torrents
$ torrentfs -mountDir=mnt -metainfoDir=torrents &
$ cd torrents
$ wget http://releases.ubuntu.com/14.04.2/ubuntu-14.04.2-desktop-amd64.iso.torrent
$ cd ..
$ ls mnt
ubuntu-14.04.2-desktop-amd64.iso
$ pv mnt/ubuntu-14.04.2-desktop-amd64.iso | md5sum
996MB 0:04:40 [3.55MB/s] [========================================>] 100%
1b305d585b1918f297164add46784116  -