mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
76e55e6138
Closes #5589. Refs #5571 Improves upload speeds on my Windows 11 VM from 2 Mbps to 10.5 Mbps. On the resource-constrained VM it improved from 3 to 7 Mbps. ```[tasklist] ### Tasks - [x] Open for review - [x] Manual test on resource-constrained VM - [x] Run 5x replication steps from #5571 and make sure it doesn't deadlock again - [x] Merge - [ ] https://github.com/firezone/firezone/issues/5601 ``` Sorted by decreasing speed, M = macOS host, W = Windows guest in Parallels, RC = Resource-constrained Windows guest in VirtualBox: - M, Internet - 16 Mbps - W, Internet - 13 Mbps - M, Firezone - 12 Mbps - RC, Internet - 12 Mbps - W, Firezone, after this PR - 10.5 Mbps - RC, Firezone, after this PR - 8.5 Mbps - RC, Firezone, before this PR - 4 Mbps - W, Firezone, before this PR - 2 Mbps So it's not perfect but the worst part is fixed. The slow upload speeds were probably a regression from #5571. The MPSC channel only has a few spots in it, so if connlib doesn't pick up every packet immediately (which would be impossible under load), we drop packets. I measured 25% packet drops in an earlier commit. I first tried increasing the channel size from 5 to 64, and that worked. But this solution is simpler. I switch back to `blocking_send` so if connlib isn't clearing the MPSC channel, Wintun will just queue up packets in its internal ring buffers, and we aren't responsible for buffering. Getting rid of `blocking_send` was a defense-in-depth thing to fix the deadlock yesterday, but we still close the MPSC channel inside `Tun::drop`, and I confirmed in a manual test that this will kick the worker thread out of `blocking_send`, so the deadlock won't come back.
Rust development guide
Firezone uses Rust for all data plane components. This directory contains the Linux and Windows clients, and low-level networking implementations related to STUN/TURN.
We target the last stable release of Rust using rust-toolchain.toml.
If you are using rustup, that is automatically handled for you.
Otherwise, ensure you have the latest stable version of Rust installed.
Reading Client logs
The Client logs are written as JSONL for machine-readability.
To make them more human-friendly, pipe them through jq like this:
cd path/to/logs # e.g. `$HOME/.cache/dev.firezone.client/data/logs` on Linux
cat *.log | jq -r '"\(.time) \(.severity) \(.message)"'
Resulting in, e.g.
2024-04-01T18:25:47.237661392Z INFO started log
2024-04-01T18:25:47.238193266Z INFO GIT_VERSION = 1.0.0-pre.11-35-gcc0d43531
2024-04-01T18:25:48.295243016Z INFO No token / actor_name on disk, starting in signed-out state
2024-04-01T18:25:48.295360641Z INFO null