d1eb1961dc
Firezone needs to deterministically handle overlapping CIDR routes. The way we handle this is that more specific routes are preferred over less specific one. In case of an exact overlap, the sorting of the resource ID acts as a tie-breaker: "Smaller" resource IDs preferred over "larger" ones. This ensures that regardless of which order the resources are added / enabled in, Firezone behaves deterministically. In addition to the above rules, existing connections to Gateways always have precedence: In other words, if we are connected to resource A via Gateway 1 and resource B exactly overlaps with A yet needs to be routed to Gateway B and B < A, we still retain resource A in order to not interrupt existing connections. When a connection to a Gateway fails, these mappings are cleaned up. The proptests seeds added in this PR identify a routing mismatch in case a (relayed) connection is cut, followed by adding a non-CIDR resource: `connlib` recalculated the CIDR routes as part of adding the new resource, even though the CIDR resources didn't actually change. This could potentially result in a connection suddenly being routed to a different Gateway despite nothing about that resource changing. To fix this, we add a check for updating the CIDR routes and only perform it in case CIDR resources get changed.
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
Benchmarking on Linux
The recommended way for benchmarking any of the Rust components is Linux' perf utility.
For example, to attach to a running application, do:
- Ensure the binary you are profiling is compiled with the
releaseprofile. sudo perf record -g --freq 10000 --pid $(pgrep <your-binary>).- Run the speed test or whatever load-inducing task you want to measure.
sudo perf script > profile.perf- Open profiler.firefox.com and load
profile.perf
Instead of attaching to a process with --pid, you can also specify the path to executable directly.
That is useful if you want to capture perf data for a test or a micro-benchmark.