e490de7729
ICMP errors like "Destination unreachable" can be sent by both ends of a network connection. For DNS resources, handling these packets requires special care as we also need to translate the failed packet embedded within these ICMP messages such that the recipient can correctly relate them to the network socket that has sent the original packet. We do this for inbound ICMP errors already to alert the Client of e.g. unreachable paths such as unreachable IPv6 networks. Outbound ICMP errors, that is, ICMP errors generated by the Client for a packet sent by a resource are currently not handled and result in warnings such as: > Failed to translate outbound packet: Unsupported ICMPv4 type: DestinationUnreachable(Port) Whilst it is possible to correctly handle and translate these packets, doing so requires a fair amount of work and changes to a very critical part of the Gateway. As such, we simply drop these packets for now as "unroutable packets" which downgrades their log level to DEBUG. Resolves: #10983
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.