e5fb6adbb4
When we create a new connection, we seed the local ICE agent with all known local candidates, i.e. host addresses and allocations on relays. Server-reflexive candidates are never added to the local agent because you cannot send directly from a server-reflexive addresses. Instead, an agent sends from the _base_ of a server-reflexive candidate which in turn is known as a host candidate. The server-reflexive candidate is however signaled to the remote so it can try and send packets to it. Those will then be mapped by the NAT to our host candidate. In case we have just performed a network reset, our own server-reflexive candidate may not be known yet and therefore the seeding doesn't add an candidates. With no candidates being seeded, we also can't signal them to the remote. For candidates discovered later in this process, the signalling happens as part of adding them to the local agent. Because server-reflexive candidates are not added to the local agent, we currently miss out on signaling those to the remote IF they weren't already present when the ICE agent got created. This scenario can happen right after a network reset. In practice, it shouldn't be much of an issue though. As soon as we start sending from our host candidate, the remote will create a peer-reflexive candidate for it. It is however cleaner to directly send the server-reflexive candidate once we discover it.
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.