msg-sim revamp, Linux support only

Cargo.toml

@@ -1,11 +1,11 @@
 [workspace]
 members = [
-    "msg",
-    "msg-socket",
-    "msg-wire",
-    "msg-transport",
-    "msg-common",
-    "msg-sim",
+  "msg",
+  "msg-socket",
+  "msg-wire",
+  "msg-transport",
+  "msg-common",
+  "msg-sim",
 ]
 resolver = "2"
 
@@ -19,19 +19,19 @@ authors = ["Chainbound Developers <dev@chainbound.io>"]
 homepage = "https://github.com/chainbound/msg-rs"
 repository = "https://github.com/chainbound/msg-rs"
 keywords = [
-    "messaging",
-    "distributed",
-    "systems",
-    "networking",
-    "quic",
-    "quinn",
-    "tokio",
-    "async",
-    "simulation",
-    "pnet",
-    "udp",
-    "tcp",
-    "socket",
+  "messaging",
+  "distributed",
+  "systems",
+  "networking",
+  "quic",
+  "quinn",
+  "tokio",
+  "async",
+  "simulation",
+  "pnet",
+  "udp",
+  "tcp",
+  "socket",
 ]
 
 [workspace.dependencies]
@@ -44,11 +44,11 @@ msg-sim = { path = "./msg-sim" }
 # async
 async-trait = "0.1"
 tokio = { version = "1", features = [
-    "rt",
-    "rt-multi-thread",
-    "net",
-    "io-util",
-    "macros",
+  "rt",
+  "rt-multi-thread",
+  "net",
+  "io-util",
+  "macros",
 ] }
 tokio-util = { version = "0.7", features = ["codec"] }
 tokio-stream = { version = "0.1", features = ["sync"] }
@@ -64,12 +64,13 @@ rustc-hash = "2"
 rand = "0.9"
 libc = "0.2"
 derive_more = { version = "2.1.1", features = [
-    "from",
-    "into",
-    "deref",
-    "deref_mut",
+  "from",
+  "into",
+  "deref",
+  "deref_mut",
 ] }
 arc-swap = "1.8.0"
+nix = { version = "0.30.1" }
 
 # networking
 quinn = "0.11.9"

msg-sim/Cargo.toml

@@ -12,4 +12,18 @@ repository.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+msg-socket.workspace = true
+msg-transport.workspace = true
+
 pnet.workspace = true
+nix.workspace = true
+thiserror.workspace = true
+tracing.workspace = true
+derive_more.workspace = true
+tokio.workspace = true
+futures.workspace = true
+rtnetlink = { version = "0.19.0" }
+
+
+[dev-dependencies]
+tracing-subscriber = "0.3"

msg-sim/README.md

@@ -1,65 +1,15 @@
 # `msg-sim`
 
-## Overview
-This crate provides functionality to simulate real-world network conditions
-locally to and from a specific endpoint for testing and benchmarking purposes.
-It only works on MacOS and Linux.
+todo: update README.md
 
-## Implementation
+#### How to run tests
 
-### MacOS
-On MacOS, we use a combination of the `pfctl` and `dnctl` tools.
-[`pfctl`](https://man.freebsd.org/cgi/man.cgi?query=pfctl&apropos=0&sektion=8&manpath=FreeBSD+14.0-RELEASE+and+Ports&arch=default&format=html) is a tool to manage the packet filter device. [`dnctl`](https://man.freebsd.org/cgi/man.cgi?query=dnctl&sektion=8&format=html) can manage
-the [dummynet](http://info.iet.unipi.it/~luigi/papers/20100304-ccr.pdf) traffic shaper.
+Given that the tests require root privileges to modify the networking stack,
+you can run them with the following command:
 
-The general flow is as follows:
-
-* Create a dummynet pipe with `dnctl` and configure it with `bw`, `delay`, `plr`
-
-Example:
-```bash
-sudo dnctl pipe 1 config bw 10Kbit/s delay 50 plr 0.1
-```
-
-* Create a loopback alias with `ifconfig` to simulate a different endpoint and
-set the MTU to the usual value (1500)
-
-Example:
-```bash
-sudo ifconfig lo0 alias 127.0.0.3 up
-sudo ifconfig lo0 mtu 1500
-```
-
-* Use `pfctl` to create a rule to match traffic and send it through the pipe
-
-Example:
-```bash
-# Create an anchor (a named container for rules, close to a namespace)
-(cat /etc/pf.conf && echo "dummynet-anchor \"msg-sim\"" && \
-echo "anchor \"msg-sim\"") | sudo pfctl -f -
-
-# Create a rule to match traffic from any to the alias and send it through the pipe
-echo 'dummynet in from any to 127.0.0.3 pipe 1' | sudo pfctl -a msg-sim -f -
-
-# Enable the packet filter
-sudo pfctl -E
-```
-
-* Remove the rules and the pipe
 ```bash
-# Apply the default configuration
-sudo pfctl -f /etc/pf.conf
-# Disable the packet filter
-sudo pfctl -d
-# Remove the alias & reset the MTU
-sudo ifconfig lo0 -alias 127.0.0.3
-sudo ifconfig lo0 mtu 16384
-# Remove the dummynet pipes
-sudo dnctl pipe delete 1
+sudo HOME=$HOME $(which cargo) test # add your arguments here
 ```
 
-### Questions
-- Do we need to create 2 pipes to simulate a bidirectional link? MAN page seems to say so.
-
-### Linux
-On Linux, we use dummy interfaces and `tc` with `netem` to simulate and shape traffic.
+We need to provide the `$HOME` environment variable to `sudo` to ensure that
+it can find the Rust toolchain, and then we also need to provide the path of `cargo`.