dad78f31f3
The addition of WaitGroup.Go in the standard library has been repeatedly proposed and rejected. See golang/go#18022, golang/go#23538, and golang/go#39863 In summary, the argument for WaitGroup.Go is that it avoids bugs like: go func() { wg.Add(1) defer wg.Done() ... }() where the increment happens after execution (not before) and also (to a lesser degree) because: wg.Go(func() { ... }) is shorter and more readble. The argument against WaitGroup.Go is that the provided function takes no arguments and so inputs and outputs must closed over by the provided function. The most common race bug for goroutines is that the caller forgot to capture the loop iteration variable, so this pattern may make it easier to be accidentally racy. However, that is changing with golang/go#57969. In my experience the probability of race bugs due to the former still outwighs the latter, but I have no concrete evidence to prove it. The existence of errgroup.Group.Go and frequent utility of the method at least proves that this is a workable pattern and the possibility of accidental races do not appear to manifest as frequently as feared. A reason *not* to use errgroup.Group everywhere is that there are many situations where it doesn't make sense for the goroutine to return an error since the error is handled in a different mechanism (e.g., logged and ignored, formatted and printed to the frontend, etc.). While you can use errgroup.Group by always returning nil, the fact that you *can* return nil makes it easy to accidentally return an error when nothing is checking the return of group.Wait. This is not a hypothetical problem, but something that has bitten us in usages that was only using errgroup.Group without intending to use the error reporting part of it. Thus, add a (yet another) variant of WaitGroup here that is identical to sync.WaitGroup, but with an extra method. Signed-off-by: Joe Tsai <joetsai@digital-static.net> |
||
---|---|---|
.bencher | ||
.github | ||
atomicfile | ||
chirp | ||
client/tailscale | ||
cmd | ||
control | ||
derp | ||
disco | ||
docs | ||
doctor | ||
envknob | ||
health | ||
hostinfo | ||
internal/tooldeps | ||
ipn | ||
jsondb | ||
kube | ||
licenses | ||
log | ||
logpolicy | ||
logtail | ||
metrics | ||
net | ||
packages/deb | ||
paths | ||
portlist | ||
prober | ||
release | ||
safesocket | ||
scripts | ||
smallzstd | ||
ssh/tailssh | ||
syncs | ||
tailcfg | ||
tempfork | ||
tka | ||
tool | ||
tsconst | ||
tsnet | ||
tstest | ||
tstime | ||
tsweb | ||
types | ||
util | ||
version | ||
wf | ||
wgengine | ||
words | ||
.gitattributes | ||
.gitignore | ||
ALPINE.txt | ||
api.md | ||
AUTHORS | ||
build_dist.sh | ||
build_docker.sh | ||
CODE_OF_CONDUCT.md | ||
Dockerfile | ||
Dockerfile.base | ||
flake.lock | ||
flake.nix | ||
go.mod | ||
go.mod.sri | ||
go.sum | ||
go.toolchain.branch | ||
go.toolchain.rev | ||
LICENSE | ||
Makefile | ||
PATENTS | ||
pull-toolchain.sh | ||
README.md | ||
SECURITY.md | ||
shell.nix | ||
staticcheck.conf | ||
update-flake.sh | ||
version_test.go | ||
version-embed.go | ||
VERSION.txt |
Tailscale
Private WireGuard® networks made easy
Overview
This repository contains the majority of Tailscale's open source code.
Notably, it includes the tailscaled
daemon and
the tailscale
CLI tool. The tailscaled
daemon runs on Linux, Windows,
macOS, and to varying degrees
on FreeBSD and OpenBSD. The Tailscale iOS and Android apps use this repo's
code, but this repo doesn't contain the mobile GUI code.
Other Tailscale repos of note:
- the Android app is at https://github.com/tailscale/tailscale-android
- the Synology package is at https://github.com/tailscale/tailscale-synology
- the QNAP package is at https://github.com/tailscale/tailscale-qpkg
- the Chocolatey packaging is at https://github.com/tailscale/tailscale-chocolatey
For background on which parts of Tailscale are open source and why, see https://tailscale.com/opensource/.
Using
We serve packages for a variety of distros and platforms 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. The GUI wrappers on non-open source platforms are themselves not open source.
Building
We always require the latest Go release, currently Go 1.20. (While we build releases with our Go fork, its use is not required.)
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.
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.
See git log
for our commit message style. It's basically the same as
Go's style.
About Us
Tailscale is primarily developed by the people at https://github.com/orgs/tailscale/people. For other contributors, see:
- https://github.com/tailscale/tailscale/graphs/contributors
- https://github.com/tailscale/tailscale-android/graphs/contributors
Legal
WireGuard is a registered trademark of Jason A. Donenfeld.