Mirror of tailscale/tailscale@github.com
Go to file
Joe Tsai 9d0c86b6ec
util/deephash: remove unnecessary formatting for structs and slices (#2571)
The index for every struct field or slice element and
the number of fields for the struct is unncessary.

The hashing of Go values is unambiguous because every type (except maps)
encodes in a parsable manner. So long as we know the type information,
we could theoretically decode every value (except for maps).

At a high level:
* numbers are encoded as fixed-width records according to precision.
* strings (and AppendTo output) are encoded with a fixed-width length,
followed by the contents of the buffer.
* slices are prefixed by a fixed-width length, followed by the encoding
of each value. So long as we know the type of each element, we could
theoretically decode each element.
* arrays are encoded just like slices, but elide the length
since it is determined from the Go type.
* maps are encoded first with a byte indicating whether it is a cycle.
If a cycle, it is followed by a fixed-width index for the pointer,
otherwise followed by the SHA-256 hash of its contents. The encoding of maps
is not decodeable, but a SHA-256 hash is sufficient to avoid ambiguities.
* interfaces are encoded first with a byte indicating whether it is nil.
If not nil, it is followed by a fixed-width index for the type,
and then the encoding for the underlying value. Having the type be encoded
first ensures that the value could theoretically be decoded next.
* pointers are encoded first with a byte indicating whether it is
1) nil, 2) a cycle, or 3) newly seen. If a cycle, it is followed by
a fixed-width index for the pointer. If newly seen, it is followed by
the encoding for the pointed-at value.

Removing unnecessary details speeds up hashing:

	name              old time/op    new time/op    delta
	Hash-8              76.0µs ± 1%    55.8µs ± 2%  -26.62%        (p=0.000 n=10+10)
	HashMapAcyclic-8    61.9µs ± 0%    62.0µs ± 0%     ~             (p=0.666 n=9+9)
	TailcfgNode-8       10.2µs ± 1%     7.5µs ± 1%  -26.90%         (p=0.000 n=10+9)
	HashArray-8         1.07µs ± 1%    0.70µs ± 1%  -34.67%         (p=0.000 n=10+9)

Signed-off-by: Joe Tsai <joetsai@digital-static.net>
2021-08-03 20:35:57 -07:00
.github disable vm tests on every commit to main 2021-07-26 16:42:56 -07:00
atomicfile atomicfile: don't Chmod on windows 2020-07-15 12:31:40 -07:00
client/tailscale cmd/tailscale: make netcheck use active DERP map, delete static copy 2021-06-28 14:08:47 -07:00
cmd cmd/tailscaled: let portmap debug mode have an gateway/IP override knob 2021-08-03 19:34:58 -07:00
control control/controlclient: report whether we're in a snap package 2021-07-26 15:16:40 -07:00
derp derp: reduce server memory by 30% by removing persistent bufio.Writer 2021-08-02 10:17:56 -07:00
disco all: adapt to opaque netaddr types 2021-05-16 14:52:00 -07:00
health wgengine/magicsock: always run ReceiveIPv6 2021-04-28 11:07:14 -07:00
hostinfo netns_linux: remove special handling for tests. 2021-07-14 10:01:14 -07:00
internal/tooldeps util/deephash: move internal/deephash to util/deephash 2021-07-02 21:33:02 -07:00
ipn ipnlocal: allow access to guest VMs/containers while using an exit node 2021-07-29 13:31:09 -07:00
log log/filelogger: move our Windows disk file writing+rotation package here 2020-10-29 14:59:44 -07:00
logpolicy logpolicy: only log panics when running under systemd 2021-08-03 08:25:06 -07:00
logtail logtail: fix typo in comment 2021-08-02 14:32:02 -07:00
metrics metrics: add LabelMap.GetFloat 2020-07-19 12:31:12 -07:00
net net/dns: correct log message. 2021-08-03 13:58:29 -07:00
packages/deb packages/deb: add package to extract metadata from .deb files. 2021-06-07 16:22:23 -07:00
paths cmd/tailscale/web: restrict web access to synology admins. 2021-06-03 08:41:47 +05:00
portlist staticcheck.conf: turn off noisy lint errors 2021-06-18 15:48:20 -07:00
safesocket safesocket: print full lsof command on failure 2021-07-20 13:35:31 -07:00
scripts scripts: remove special case for _strings.go files in check license headers 2021-07-19 15:31:56 -07:00
smallzstd smallzstd: new package that constructs zstd small encoders/decoders. 2020-07-02 16:13:06 -07:00
syncs wgengine/{monitor,router}: restore Linux ip rules when systemd deletes them 2021-07-20 15:52:22 -07:00
tailcfg tailcfg: add Node.PrimaryRoutes 2021-07-27 12:09:40 -07:00
tempfork tempfork/wireguard-windows: remove unnecessary build tag 2021-07-19 15:31:56 -07:00
tsconst net/netns: add windows support. 2020-09-14 16:28:49 -07:00
tsnet all: adapt to opaque netaddr types 2021-05-16 14:52:00 -07:00
tstest tstest/integration: update test deps 2021-08-02 22:15:34 -07:00
tstime tstime/rate: new package 2021-07-29 12:56:58 -07:00
tsweb tsweb: add float64 to logged metrics 2021-07-25 21:02:36 -07:00
types control/{controlknobs,controlclient}: simplify knobs API, fix controlclient crash 2021-07-15 22:34:50 -07:00
util util/deephash: remove unnecessary formatting for structs and slices (#2571) 2021-08-03 20:35:57 -07:00
version version: bump date 2021-07-27 08:05:17 -07:00
wf wf: loopback condition should use MatchTypeFlagsAllSet. 2021-06-16 12:57:57 +05:00
wgengine derp,wgengine/magicsock: don't assume stringer is in $PATH for go:generate 2021-08-01 19:14:08 -07: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 Dockerfile: remove extra COPY step (#2355) 2021-07-28 11:07:50 -07: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 v1.13.0. 2021-07-27 07:15:59 -07:00
api.md api.md: update preview example 2021-07-02 08:24:19 -07:00
build_dist.sh build_dist.sh: add a command to output the shell vars. 2021-06-05 19:02:42 -07:00
build_docker.sh build_docker.sh: use build_dist.sh to inject version information 2021-07-07 06:38:04 -07:00
go.mod cmd/tsshd: switch from github.com/kr/pty to github.com/creack/pty 2021-07-28 09:14:47 -07:00
go.sum cmd/tsshd: switch from github.com/kr/pty to github.com/creack/pty 2021-07-28 09:14:47 -07:00
shell.nix add nix-shell boilerplate (#1028) 2020-12-29 12:17:03 -05:00
staticcheck.conf staticcheck.conf: remove unnecessary warning 2021-06-22 12:26:13 -07: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.