Merge pull request #69 from niccantieni/qlog

qlog: initial setup

Author: lbrndnr

.gitignore

@@ -3,4 +3,5 @@
 .envrc
 .clangd
 __pycache__
-static_dependencies/
+static_dependencies/
+qlog

Cargo.lock

@@ -54,10 +54,16 @@ export NQ_LIBS="quinn quiche neqo"
 script/dashboard.sh
 # update run.sh to the correct CPU-range; if you are running a bare-metal
 # benchmark, enable NESQUIC_BENACHMARK=1.
+
 # run the test scenarios for a given library
-# the label can be used later to identify past runs. If no value is supplied,
+# NESQUIC_RUN_LABEL can be used later to identify past runs. If no value is supplied,
 # the label is set to "default".
-NESQUIC_RUN_LABEL=firstRun script/run.sh quinn quiche
+
+# if QLOG_DIR is set, qlog-traces will be written to that directory
+# if QLOG_DIR is unset, no qlog-traces are written
+# currently, only quiche, quinn and neqo produce qlog.
+# For neqo, the flag is ignored.
+NESQUIC_RUN_LABEL=firstRun QLOG_DIR="qlog" script/run.sh quinn quiche noq neqo
 ```
 
 This starts the Grafana dashboard and executes a performance test. The dashboard is hosted at `http://localhost:3000`

README.md

@@ -23,7 +23,12 @@ impl bin::Client for Client {
 
         client_crypto.alpn_protocols = vec![b"perf".to_vec()];
 
-        let config = ClientConfig::new(Arc::new(QuicClientConfig::try_from(client_crypto)?));
+        let mut config = ClientConfig::new(Arc::new(QuicClientConfig::try_from(client_crypto)?));
+
+        if let Some(ref dir) = args.qlog {
+            let transport = crate::setup_qlog_transport(dir, "client")?;
+            config.transport_config(Arc::new(transport));
+        }
 
         Ok(Client {
             args,

iut/common/quinn-noq/client.rs

@@ -26,7 +26,12 @@ impl bin::Server for Server {
             .with_single_cert(certs, key)?;
         server_crypto.alpn_protocols = vec![b"perf".to_vec()];
 
-        let config = ServerConfig::with_crypto(Arc::new(QuicServerConfig::try_from(server_crypto)?));
+        let mut config = ServerConfig::with_crypto(Arc::new(QuicServerConfig::try_from(server_crypto)?));
+
+        if let Some(ref dir) = args.qlog {
+            let transport = crate::setup_qlog_transport(dir, "server")?;
+            config.transport_config(Arc::new(transport));
+        }
 
         Ok(Server { args, config })
     }

iut/common/quinn-noq/server.rs

@@ -7,7 +7,7 @@ edition = "2021"
 anyhow = "1.0.102"
 bytes = "1.11.1"
 tracing = "0.1.44"
-noq = "0.17.0"
+noq = { version = "0.17.0", features = ["qlog"] }
 rustls = { version = "0.23.38", default-features = false, features = ["ring"] }
 socket2 = "0.6.3"
 tokio = { version = "1.51.1", features = ["macros", "full"] }

iut/noq/Cargo.toml

@@ -6,6 +6,12 @@ pub(crate) mod backend {
 pub(crate) const CLIENT_TARGET: &str = "noq::client";
 pub(crate) const SERVER_TARGET: &str = "noq::server";
 
+pub(crate) fn setup_qlog_transport(dir: &str, _role: &str) -> anyhow::Result<noq::TransportConfig> {
+    let mut transport = noq::TransportConfig::default();
+    transport.qlog_from_path(std::path::Path::new(dir), "");
+    Ok(transport)
+}
+
 #[path = "../../common/quinn-noq/mod.rs"]
 mod common;
 

iut/noq/src/lib.rs

@@ -51,6 +51,8 @@ impl bin::Client for Client {
         let mut params = ConnectionParams::default();
         params.settings.alpn = vec![b"perf".to_vec()];
 
+        params.settings.qlog_dir = self.args.qlog.clone();
+        
         let (benchmark, send) = Benchmark::new();
         let Ok(qconn) = quic::connect_with_config(socket, None, &params, benchmark).await else {
             bail!("Failed to establish connection");

iut/quiche/src/client.rs

@@ -25,6 +25,8 @@ impl bin::Server for Server {
             kind: tokio_quiche::settings::CertificateKind::X509,
         });
 
+        params.settings.qlog_dir = self.args.qlog.clone();
+
         let mut listeners = tokio_quiche::listen([socket], params, DefaultMetrics)?;
         let accept = &mut listeners[0];
 

iut/quiche/src/server.rs

@@ -7,7 +7,7 @@ edition = "2021"
 anyhow = "1.0.102"
 bytes = "1.11.1"
 tracing = "0.1.44"
-quinn = { version = "0.11.9", features = ["rustls"] }
+quinn = { version = "0.11.9", features = ["rustls", "qlog"] }
 quinn-proto = "0.11.14"
 rustls = { version = "0.23.38", default-features = false, features = ["ring"] }
 socket2 = "0.6.3"