update readme and makefile

Author: prajwolrg

.gitignore

@@ -2,6 +2,5 @@ target/
 elf/
 cache/
 
-*.pb
-*.trace
+*.trace_profile
 *.proof

Makefile

@@ -14,6 +14,12 @@ CARGO_INSTALL_EXTRA_FLAGS ?=
 # List of features to use for building
 FEATURES ?=
 
+# List of programs
+PROGRAMS ?= fibonacci,sha2-chain,schnorr-sig-verify
+
+# ZkVm to use
+ZKVM ?= sp1
+
 ##@ Help
 
 .PHONY: help
@@ -57,29 +63,24 @@ sec: ## Check for security advisories on any dependencies.
 ##@ Prover
 
 .PHONY: report
-report: prover-clean ## Generate proof report for programs
-	cargo run --release -- --programs fibonacci,sha2-chain,schnorr-sig-verify
+report: prover-clean ## Generate proof report for programs for all supported ZkVm
+	cargo run --release -- --programs $(PROGRAMS)
 
 .PHONY: report-sp1
-report-sp1: prover-clean ## Generate SP1 proof report for programs
-	cargo run --release --no-default-features -F sp1-mock -- --programs fibonacci,sha2-chain,schnorr-sig-verify
+report-sp1: prover-clean ## Generate SP1 proof report for given programs
+	cargo run --release --no-default-features -F sp1-mock -- --programs $(PROGRAMS)
 
 .PHONY: report-risc0
-report-risc0: prover-clean ## Generate Risc0 proof report for programs
-	cargo run --release --no-default-features -F risc0-mock -- --programs fibonacci,sha2-chain,schnorr-sig-verify
-
-.PHONY: proof-sp1-fibonacci
-proof-sp1-fibonacci: prover-clean ## Generate SP1 Groth16 proof for fibonacci program
-	cargo run --release --no-default-features -F sp1 -- --programs fibonacci
-
-.PHONY: proof-risc0-fibonacci
-proof-risc0-fibonacci: prover-clean ## Generate Risc0 Groth16 proof for fibonacci program
-	cargo run --release --no-default-features -F risc0 -- --programs fibonacci
+report-risc0: prover-clean ## Generate Risc0 proof report for given programs
+	cargo run --release --no-default-features -F risc0-mock -- --programs $(PROGRAMS)
 
+.PHONY: proof
+proof: ## Generate proof for the given program using the given ZkVm
+	ZKVM_PROOF_DUMP=1 cargo run --release --no-default-features -F $(ZKVM) -- --programs $(PROGRAMS)
 
 .PHONY: prover-clean
 prover-clean: ## Cleans up proofs and profiling data generated
-	rm -rf *.trace
+	rm -rf *.trace_profile
 	rm -rf *.proof
 
 ##@ Code Quality

README.md

@@ -26,13 +26,134 @@ Currently, the repository supports the following ZKVMs:
 
 ---
 
-## Usage
+# Usage Guide
 
-### Generating report of cycle count of different programs
+## Generating Report of Cycle Counts for Programs
+
+To generate a report of cycle counts for one or more programs, use the following command:
+
+```bash
+make report PROGRAMS=<PROGRAM_NAME>
+```
+
+### Notes:
+- **Multiple Programs Supported:** You can specify multiple programs by separating them with commas.
+- **Example Commands:**
+  ```bash
+  make report PROGRAMS=fibonacci
+  make report PROGRAMS=fibonacci,sha2-chain
+  ```
+- **Optional Parameter:** If `PROGRAMS` is left empty, the report will be generated for all supported programs.
+
+### Supported Programs
+Here is the list of currently supported programs:
+- `fibonacci`
+- `sha2-chain`
+- `schnorr-sig-verify`
+
+## Generating Report for a Specific ZKVM
+
+To generate profiling data for a specific ZKVM, use the following commands:
+
+```bash
+make report-<ZkVm>
+```
+
+### Example Commands:
+- For Risc0:
+  ```bash
+  make report-risc0
+  ```
+- For SP1:
+  ```bash
+  make report-sp1
+  ```
+- Similar to the general `make report`, you can also pass the `PROGRAMS` parameter:
+  ```bash
+  make report-risc0 PROGRAMS=fibonacci
+  make report-sp1 PROGRAMS=fibonacci,sha2-chain
+  ```
+
+
+## Generating Profile Data
+
+To dump profiling data, set the environment variable `ZKVM_PROFILING_DUMP=1` while running any of the above command.
+
+```bash
+ZKVM_PROFILING_DUMP=1 make report
+```
+
+
+### Viewing SP1 Profile
+
+The profiling data for SP1 can be viewed using [Samply](https://github.com/mstange/samply). To view the profile:
+
+```bash
+samply load <FILENAME>.trace_profile
+```
+
+### Viewing Risc0 Profile
+
+The profiling data for Risc0 can be viewed using [pprof](https://github.com/google/pprof). To view the profile:
+
+```bash
+go tool pprof -http=127.0.0.1:8000 <FILENAME>.trace_profile
+```
+
+## Generating Proof for Program
+
+If proof is required, use the folloing command:
 
 ```bash
-make report
+make proof ZKVM=<ZKVM_NAME> PROGRAMS=<PROGRAM_NAME>
 ```
+> The proofs are dumped by default
+
+### Additional Options:
+- **Dump Profiling Data:** To dump proofs, set the environment variable `ZKVM_PROOF_DUMP=1` while running the command:
+
+## Cleaning Up Generated Data
+To clean up generated proofs and profiling data, run:
+
+```bash
+make prover-clean
+```
+This will remove all `.trace_profile` and `.proof` files from the current directory.
+
+---
+
+### Example Workflow
+1. **Generate Report for All Programs:**
+   ```bash
+   make report
+   ```
+
+2. **Generate Report for Specific Programs:**
+   ```bash
+   make report PROGRAMS=fibonacci,sha2-chain
+   ```
+
+3. **Generate SP1 Report for Specific Programs:**
+   ```bash
+   make report-sp1 PROGRAMS=schnorr-sig-verify
+   ```
+
+4. **Dump Profiling Data for Risc0:**
+   ```bash
+   ZKVM_PROFILING_DUMP=1 make report-risc0 PROGRAMS=fibonacci
+   ```
+
+5. **Generate and dump Risc0 Proof**
+   ```bash
+  make proof ZKVM=risc0 PROGRAMS=fibonacci
+   ```
+
+
+5. **Clean Up Generated Data:**
+   ```bash
+   make prover-clean
+   ```
+
 
 ---
 

crates/risc0/src/host.rs

@@ -70,7 +70,8 @@ impl ZkVmHost for Risc0Host {
             .map(|v| v == "1" || v.to_lowercase() == "true")
             .unwrap_or(false)
         {
-            std::env::set_var("RISC0_PPROF_OUT", "risc0.trace");
+            let profiling_file_name = format!("{:?}.trace_profile", self);
+            std::env::set_var("RISC0_PPROF_OUT", profiling_file_name);
         }
 
         // TODO: handle error

crates/sp1/src/host.rs

@@ -76,11 +76,16 @@ impl ZkVmHost for SP1Host {
             .map(|v| v == "1" || v.to_lowercase() == "true")
             .unwrap_or(false)
         {
-            std::env::set_var("TRACE_FILE", "sp1.trace");
+            let profiling_file_name = format!("{:?}.trace_profile", self);
+            std::env::set_var("TRACE_FILE", profiling_file_name);
         }
 
         let (output, report) = client.execute(self.get_elf(), &prover_input).run().unwrap();
 
+        // Remove the variable after execution to avoid duplication of trace generation in perf
+        // report
+        std::env::remove_var("TRACE_FILE");
+
         let public_values = PublicValues::new(output.to_vec());
         let total_cycles = report.total_instruction_count();
 

crates/zkvm/src/host.rs

@@ -23,7 +23,6 @@ pub trait ZkVmHost: Send + Sync + Clone + Debug + 'static {
         proof_type: ProofType,
     ) -> ZkVmResult<Self::ZkVmProofReceipt>;
 
-    /// Executes the guest code within the VM, generating and returning [`ProofReceipt`].
     fn prove<'a>(
         &self,
         input: <Self::Input<'a> as ZkVmInputBuilder<'a>>::Input,
@@ -33,7 +32,12 @@ pub trait ZkVmHost: Send + Sync + Clone + Debug + 'static {
         receipt.try_into().map_err(ZkVmError::InvalidProofReceipt)
     }
 
-    /// Executes the guest code within the VM, generating and returning [`ProofReceipt`].
+    /// Executes the guest code within the VM.
+    ///
+    /// # Returns
+    /// A tuple containing:
+    /// * `PublicValues` - The public values generated during proof execution.
+    /// * `u64` - The cycle count for the execution
     fn execute<'a>(
         &self,
         input: <Self::Input<'a> as ZkVmInputBuilder<'a>>::Input,

crates/zkvm/src/prover.rs

@@ -64,15 +64,6 @@ pub trait ZkVmProver {
         let (_, cycles) = host.execute(zkvm_input)?;
         let execution_time = start.elapsed().as_millis();
 
-        if std::env::var("ZKVM_PROFILING_DUMP")
-            .map(|v| v == "1" || v.to_lowercase() == "true")
-            .unwrap_or(false)
-        {
-            let from = format!("{:?}.profle", host);
-            let to = format!("{}_{:?}.profile", Self::name(), host);
-            std::fs::rename(from, to).unwrap();
-        }
-
         let _ = Self::prove(input, host)?;
         let proving_time = start.elapsed().as_millis();
 

runner/README.md

@@ -19,12 +19,12 @@ pub fn format_header(args: &EvalArgs) -> String {
 pub fn format_results(results: &[PerformanceReport], host_name: String) -> String {
     let mut table_text = String::new();
     table_text.push('\n');
-    table_text.push_str("| program           | cycles      | success  |\n");
-    table_text.push_str("|-------------------|-------------|----------|");
+    table_text.push_str("| program             | cycles      | success  |\n");
+    table_text.push_str("|---------------------|-------------|----------|");
 
     for result in results.iter() {
         table_text.push_str(&format!(
-            "\n| {:<17} | {:>11} | {:<7} |",
+            "\n| {:<19} | {:>11} | {:<7} |",
             result.program,
             result.cycles.to_formatted_string(&Locale::en),
             if result.success { "✅" } else { "❌" }

runner/src/format.rs

@@ -3,7 +3,6 @@ use strata_zkvm::{ProofReport, ZkVmHost, ZkVmProver};
 
 fn sha2_prover_perf_report(host: &impl ZkVmHost) -> ProofReport {
     let input = 5;
-    ShaChainProver::prove(&input, host).unwrap();
     ShaChainProver::perf_report(&input, host).unwrap()
 }