Mirror of tailscale/tailscale@github.com
Go to file
Avery Pennarun a92b9647c5 wgengine/bench: speed test for channels, sockets, and wireguard-go.
This tries to generate traffic at a rate that will saturate the
receiver, without overdoing it, even in the event of packet loss. It's
unrealistically more aggressive than TCP (which will back off quickly
in case of packet loss) but less silly than a blind test that just
generates packets as fast as it can (which can cause all the CPU to be
absorbed by the transmitter, giving an incorrect impression of how much
capacity the total system has).

Initial indications are that a syscall about every 10 packets (TCP bulk
delivery) is roughly the same speed as sending every packet through a
channel. A syscall per packet is about 5x-10x slower than that.

The whole tailscale wireguard-go + magicsock + packet filter
combination is about 4x slower again, which is better than I thought
we'd do, but probably has room for improvement.

Note that in "full" tailscale, there is also a tundev read/write for
every packet, effectively doubling the syscall overhead per packet.

Given these numbers, it seems like read/write syscalls are only 25-40%
of the total CPU time used in tailscale proper, so we do have
significant non-syscall optimization work to do too.

Sample output:

$ GOMAXPROCS=2 go test -bench . -benchtime 5s ./cmd/tailbench
goos: linux
goarch: amd64
pkg: tailscale.com/cmd/tailbench
cpu: Intel(R) Core(TM) i7-4785T CPU @ 2.20GHz
BenchmarkTrivialNoAlloc/32-2         	56340248	        93.85 ns/op	 340.98 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkTrivialNoAlloc/124-2        	57527490	        99.27 ns/op	1249.10 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkTrivialNoAlloc/1024-2       	52537773	       111.3 ns/op	9200.39 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkTrivial/32-2                	41878063	       135.6 ns/op	 236.04 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkTrivial/124-2               	41270439	       138.4 ns/op	 896.02 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkTrivial/1024-2              	36337252	       154.3 ns/op	6635.30 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkBlockingChannel/32-2           12171654	       494.3 ns/op	  64.74 MB/s	         0 %lost	    1791 B/op	       0 allocs/op
BenchmarkBlockingChannel/124-2          12149956	       507.8 ns/op	 244.17 MB/s	         0 %lost	    1792 B/op	       1 allocs/op
BenchmarkBlockingChannel/1024-2         11034754	       528.8 ns/op	1936.42 MB/s	         0 %lost	    1792 B/op	       1 allocs/op
BenchmarkNonlockingChannel/32-2          8960622	      2195 ns/op	  14.58 MB/s	         8.825 %lost	    1792 B/op	       1 allocs/op
BenchmarkNonlockingChannel/124-2         3014614	      2224 ns/op	  55.75 MB/s	        11.18 %lost	    1792 B/op	       1 allocs/op
BenchmarkNonlockingChannel/1024-2        3234915	      1688 ns/op	 606.53 MB/s	         3.765 %lost	    1792 B/op	       1 allocs/op
BenchmarkDoubleChannel/32-2          	 8457559	       764.1 ns/op	  41.88 MB/s	         5.945 %lost	    1792 B/op	       1 allocs/op
BenchmarkDoubleChannel/124-2         	 5497726	      1030 ns/op	 120.38 MB/s	        12.14 %lost	    1792 B/op	       1 allocs/op
BenchmarkDoubleChannel/1024-2        	 7985656	      1360 ns/op	 752.86 MB/s	        13.57 %lost	    1792 B/op	       1 allocs/op
BenchmarkUDP/32-2                    	 1652134	      3695 ns/op	   8.66 MB/s	         0 %lost	     176 B/op	       3 allocs/op
BenchmarkUDP/124-2                   	 1621024	      3765 ns/op	  32.94 MB/s	         0 %lost	     176 B/op	       3 allocs/op
BenchmarkUDP/1024-2                  	 1553750	      3825 ns/op	 267.72 MB/s	         0 %lost	     176 B/op	       3 allocs/op
BenchmarkTCP/32-2                    	11056336	       503.2 ns/op	  63.60 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkTCP/124-2                   	11074869	       533.7 ns/op	 232.32 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkTCP/1024-2                  	 8934968	       671.4 ns/op	1525.20 MB/s	         0 %lost	       0 B/op	       0 allocs/op
BenchmarkWireGuardTest/32-2          	 1403702	      4547 ns/op	   7.04 MB/s	        14.37 %lost	     467 B/op	       3 allocs/op
BenchmarkWireGuardTest/124-2         	  780645	      7927 ns/op	  15.64 MB/s	         1.537 %lost	     420 B/op	       3 allocs/op
BenchmarkWireGuardTest/1024-2        	  512671	     11791 ns/op	  86.85 MB/s	         0.5206 %lost	     411 B/op	       3 allocs/op
PASS
ok  	tailscale.com/wgengine/bench	195.724s

Updates #414.

Signed-off-by: Avery Pennarun <apenwarr@tailscale.com>
2021-04-26 03:51:13 -04:00
.github .github/workflows: add --race tests on Linux and Windows 2021-04-20 21:50:26 -07:00
atomicfile atomicfile: don't Chmod on windows 2020-07-15 12:31:40 -07:00
client/tailscale ipn/ipnlocal, etc: require file sharing capability to send/recv files 2021-04-16 10:58:19 -07:00
cmd net/dns: don't use NM+resolved for NM >=1.26.6. 2021-04-23 21:13:19 -07:00
control/controlclient control/controlclient: fix signRegisterRequest log suppression check on Windows 2021-04-22 11:59:19 -07:00
derp derp/derpmap: add São Paulo (derp11) 2021-04-21 11:04:47 -07:00
disco Added 2 fuzzers 2021-04-10 11:40:10 -07:00
health health, wgenegine: fix receive func health checks yet again 2021-04-23 08:42:04 -07:00
internal wgengine: move DNS configuration out of wgengine/router. 2021-04-05 10:55:35 -07:00
ipn ipn/ipnlocal: add file sharing to windows shell 2021-04-23 13:32:33 -07:00
log log/filelogger: move our Windows disk file writing+rotation package here 2020-10-29 14:59:44 -07:00
logpolicy logpolicy: set log target on windows based on a registry key (#1542) 2021-03-18 13:23:56 -04:00
logtail logtail: reduce PublicID.UnmarshalText from 2 allocs to 0 2021-04-15 10:42:12 -07:00
metrics metrics: add LabelMap.GetFloat 2020-07-19 12:31:12 -07:00
net wgengine/bench: speed test for channels, sockets, and wireguard-go. 2021-04-26 03:51:13 -04:00
paths ipn, paths, cmd/tailscaled: remove LegacyConfigPath, relaynode migration 2021-04-07 10:15:45 -07:00
portlist portlist: de-dup services on same (proto, port) on both IPv4/IPv6 2021-04-13 14:40:33 -07:00
safesocket safesocket: remove/update some old TODOs 2021-04-19 11:35:02 -07:00
scripts Allow 2021 in LICENSE header. 2021-01-08 10:23:32 -08:00
smallzstd smallzstd: new package that constructs zstd small encoders/decoders. 2020-07-02 16:13:06 -07:00
syncs syncs: disable TestWatchMultipleValues on Windows CI builds 2021-03-27 13:25:33 -07:00
tailcfg control/controlclient, tailcfg: add Debug.SleepSeconds (mapver 19) 2021-04-21 22:05:41 -07:00
tempfork tempfork/wireguard-windows/firewall: add. 2021-03-01 19:37:22 -08:00
tsconst net/netns: add windows support. 2020-09-14 16:28:49 -07:00
tstest tstest/natlab: use net.ErrClosed 2021-03-24 09:46:36 -07:00
tstime tstime: add RandomDurationBetween helper 2021-01-21 07:54:14 -08:00
tsweb tsweb: add num_goroutines expvar 2021-02-01 14:38:59 -08:00
types types/netmap: remove some old TODOs 2021-04-18 19:30:13 -07:00
util util/cmpver: move into OSS from corp repo. 2021-04-23 20:55:45 -07:00
version version: simplify iOS detection now that we require Go 1.16 2021-04-19 21:59:55 -07:00
wgengine wgengine/bench: speed test for channels, sockets, and wireguard-go. 2021-04-26 03:51:13 -04:00
.gitattributes .gitattributes: add a smudge filter for go.mod. 2020-02-19 20:02:02 -05:00
.gitignore Revert "cmd/tailscaled: split package main into main shim + package" 2021-03-25 09:06:00 -07:00
AUTHORS Move Linux client & common packages into a public repo. 2020-02-09 09:32:57 -08:00
CODE_OF_CONDUCT.md Add a code of conduct. 2020-02-10 22:16:30 -08:00
Dockerfile build_docker.sh, Dockerfile: fix bug with shell quoting 2021-03-05 10:38:32 -08:00
LICENSE LICENSE: Reformat for Github 2021-01-24 16:20:22 -08:00
Makefile wgengine/netstack: fix 32-bit build broken from prior commit 2021-03-01 11:19:31 -08:00
PATENTS Move Linux client & common packages into a public repo. 2020-02-09 09:32:57 -08:00
README.md Switch to Go 1.16. 2021-02-19 13:18:31 -08:00
SECURITY.md Add a SECURITY.md for vulnerability reports. 2020-02-11 10:26:41 -08:00
VERSION.txt VERSION.txt: this is 1.7.0. 2021-03-16 19:04:55 -07:00
api.md api.md: clarify response behaviour for ACL POST endpoint 2021-04-10 11:38:12 -07:00
build_dist.sh build_dist: fix after version refactor. 2020-11-03 14:40:09 -08:00
build_docker.sh build_docker.sh, Dockerfile: fix bug with shell quoting 2021-03-05 10:38:32 -08:00
go.mod go.mod: upgrade to latest wireguard-go 2021-04-19 13:30:43 -07:00
go.sum go.mod: upgrade to latest wireguard-go 2021-04-19 13:30:43 -07:00
shell.nix add nix-shell boilerplate (#1028) 2020-12-29 12:17:03 -05:00

README.md

Tailscale

https://tailscale.com

Private WireGuard® networks made easy

Overview

This repository contains all the open source Tailscale client code and the tailscaled daemon and tailscale CLI tool. The tailscaled daemon runs primarily on Linux; it also works to varying degrees on FreeBSD, OpenBSD, Darwin, and Windows.

The Android app is at https://github.com/tailscale/tailscale-android

Using

We serve packages for a variety of distros at https://pkgs.tailscale.com .

Other clients

The macOS, iOS, and Windows clients use the code in this repository but additionally include small GUI wrappers that are not open source.

Building

go install tailscale.com/cmd/tailscale{,d}

If you're packaging Tailscale for distribution, use build_dist.sh instead, to burn commit IDs and version info into the binaries:

./build_dist.sh tailscale.com/cmd/tailscale
./build_dist.sh tailscale.com/cmd/tailscaled

If your distro has conventions that preclude the use of build_dist.sh, please do the equivalent of what it does in your distro's way, so that bug reports contain useful version information.

We only guarantee to support the latest Go release and any Go beta or release candidate builds (currently Go 1.16) in module mode. It might work in earlier Go versions or in GOPATH mode, but we're making no effort to keep those working.

Bugs

Please file any issues about this code or the hosted service on the issue tracker.

Contributing

PRs welcome! But please file bugs. Commit messages should reference bugs.

We require Developer Certificate of Origin Signed-off-by lines in commits.

About Us

Tailscale is primarily developed by the people at https://github.com/orgs/tailscale/people. For other contributors, see:

WireGuard is a registered trademark of Jason A. Donenfeld.