Add --repeat to examples

Author: fkondej

Cargo.toml

@@ -75,7 +75,7 @@ thiserror = "2.0.3"
 transpose = "0.2.2"
 tracing = "0.1.38"
 tracing-subscriber = { version = "0.3.18", features = ["env-filter", "fmt"] }
-tracing-profile = "0.10.9"
+tracing-profile = { git = "https://github.com/IrreducibleOSS/tracing-profile.git", branch = "fkondej/eng2-260-trace-filename-builder" }
 trait-set = "0.3.0"
 z3 = "0.13.3"
 

crates/examples/README.md

@@ -113,11 +113,10 @@ impl ExampleCircuit for MyCircuitExample {
 }
 
 fn main() -> Result<()> {
-    let _tracing_guard = tracing_profile::init_tracing()?;
-    
     // Create and run the CLI - this is all you need!
     Cli::<MyCircuitExample>::new("my_circuit")
         .about("Description of what your circuit does")
+        .with_repeat()  // Optional: Enable --repeat flag to run multiple iterations
         .run()
 }
 ```
@@ -272,6 +271,12 @@ cargo run --release --example my_circuit -- --help
 
 # Run with increased verbosity
 RUST_LOG=info cargo run --release --example my_circuit
+
+# Run multiple iterations (useful for benchmarking, testing consistency, etc.)
+cargo run --release --example my_circuit -- --repeat 3
+
+# With perfetto feature, each iteration creates a separate trace file
+cargo run --release --example my_circuit --features perfetto -- --repeat 3
 ```
 
 ## CLI subcommands

crates/examples/examples/blake2s.rs

@@ -14,15 +14,15 @@ struct Blake2sExample {
 }
 
 /// Circuit parameters that affect structure (compile-time configuration)
-#[derive(Args, Debug)]
+#[derive(Args, Debug, Clone)]
 struct Params {
 	/// Maximum message length in bytes that the circuit can handle.
 	#[arg(long, default_value_t = 128)]
 	max_bytes: usize,
 }
 
 /// Instance data for witness population (runtime values)
-#[derive(Args, Debug)]
+#[derive(Args, Debug, Clone)]
 #[group(multiple = false)]
 struct Instance {
 	/// Length of the randomly generated message, in bytes (defaults to half of --max-message-len).
@@ -85,11 +85,9 @@ impl ExampleCircuit for Blake2sExample {
 }
 
 fn main() -> Result<()> {
-	let _tracing_guard = tracing_profile::init_tracing()?;
-
-	// Create and run the CLI
 	Cli::<Blake2sExample>::new("blake2s")
 		.about("Blake2s hash function circuit example")
+		.with_repeat()
 		.long_about(
 			"Blake2s cryptographic hash function circuit implementation.\n\
             \n\

crates/examples/examples/ethsign.rs

@@ -2,9 +2,8 @@ use anyhow::Result;
 use binius_examples::{Cli, circuits::ethsign::EthSignExample};
 
 fn main() -> Result<()> {
-	let _tracing_guard = tracing_profile::init_tracing()?;
-
 	Cli::<EthSignExample>::new("ethsign")
 		.about("Ethereum-style signing example")
+		.with_repeat()
 		.run()
 }

crates/examples/examples/hash_based_sig.rs

@@ -29,7 +29,7 @@ struct HashBasedSigExample {
 	hashers: XmssMultisigHashers,
 }
 
-#[derive(Args, Debug)]
+#[derive(Args, Debug, Clone)]
 struct Params {
 	/// Number of validators in the multi-signature
 	#[arg(short = 'n', long, default_value_t = 3)]
@@ -44,7 +44,7 @@ struct Params {
 	spec: u8,
 }
 
-#[derive(Args, Debug)]
+#[derive(Args, Debug, Clone)]
 struct Instance {}
 
 impl ExampleCircuit for HashBasedSigExample {
@@ -193,12 +193,15 @@ impl ExampleCircuit for HashBasedSigExample {
 
 		Ok(())
 	}
+
+	fn param_summary(params: &Self::Params) -> Option<String> {
+		Some(format!("{}v-{}t-s{}", params.num_validators, params.tree_height, params.spec))
+	}
 }
 
 fn main() -> Result<()> {
-	let _tracing_guard = tracing_profile::init_tracing()?;
-
 	Cli::<HashBasedSigExample>::new("hash_based_sig")
 		.about("Hash-based multi-signature (XMSS) verification example")
+		.with_repeat()
 		.run()
 }

crates/examples/examples/keccak.rs

@@ -2,9 +2,8 @@ use anyhow::Result;
 use binius_examples::{Cli, circuits::keccak::KeccakExample};
 
 fn main() -> Result<()> {
-	let _tracing_guard = tracing_profile::init_tracing()?;
-
 	Cli::<KeccakExample>::new("keccak")
 		.about("Keccak-f[1600] permutation example - chains multiple permutations together")
+		.with_repeat()
 		.run()
 }

crates/examples/examples/sha256.rs

@@ -2,9 +2,8 @@ use anyhow::Result;
 use binius_examples::{Cli, circuits::sha256::Sha256Example};
 
 fn main() -> Result<()> {
-	let _tracing_guard = tracing_profile::init_tracing()?;
-
 	Cli::<Sha256Example>::new("sha256")
 		.about("SHA256 compression function example")
+		.with_repeat()
 		.run()
 }

crates/examples/examples/sha512.rs

@@ -2,9 +2,8 @@ use anyhow::Result;
 use binius_examples::{Cli, circuits::sha512::Sha512Example};
 
 fn main() -> Result<()> {
-	let _tracing_guard = tracing_profile::init_tracing()?;
-
 	Cli::<Sha512Example>::new("sha512")
 		.about("SHA512 compression function example")
+		.with_repeat()
 		.run()
 }

crates/examples/examples/zklogin.rs

@@ -2,9 +2,8 @@ use anyhow::Result;
 use binius_examples::{Cli, circuits::zklogin::ZkLoginExample};
 
 fn main() -> Result<()> {
-	let _tracing_guard = tracing_profile::init_tracing()?;
-
 	Cli::<ZkLoginExample>::new("zklogin")
 		.about("Circuit verifying knowledge of a valid OpenID Connect login")
+		.with_repeat()
 		.run()
 }

crates/examples/src/circuits/blake2s.rs

@@ -59,4 +59,8 @@ impl ExampleCircuit for Blake2sExample {
 
 		Ok(())
 	}
+
+	fn param_summary(params: &Self::Params) -> Option<String> {
+		Some(format!("{}b", params.max_bytes))
+	}
 }