refactor: improve analyze tool

miden/src/tools/mod.rs

@@ -2,7 +2,7 @@ use super::{cli::InputFile, ProgramError};
 use clap::Parser;
 use core::fmt;
 use miden::{utils::collections::Vec, Assembler, DefaultHost, Host, Operation, StackInputs};
-use processor::AsmOpInfo;
+use processor::{AsmOpInfo, TraceLenSummary};
 use std::{fs, path::PathBuf};
 use stdlib::StdLibrary;
 
@@ -49,20 +49,15 @@ impl Analyze {
 /// Contains details of executing a program, used for program analysis.
 #[derive(Debug, Default, Eq, PartialEq)]
 pub struct ExecutionDetails {
-    /// Number of VM cycles it took to execute the entire program.
-    total_vm_cycles: u32,
     /// Number of noops executed as part of a program.
     total_noops: usize,
     /// Statistics about individual assembly operations executed by the VM, see [AsmOpStats].
     asm_op_stats: Vec<AsmOpStats>,
+    /// Information about VM components trace lengths.
+    trace_len_summary: TraceLenSummary,
 }
 
 impl ExecutionDetails {
-    /// Returns total vm cycles to execute a program
-    pub fn total_vm_cycles(&self) -> u32 {
-        self.total_vm_cycles
-    }
-
     /// Returns total noops executed as part of a program
     pub fn total_noops(&self) -> usize {
         self.total_noops
@@ -74,6 +69,11 @@ impl ExecutionDetails {
         &self.asm_op_stats
     }
 
+    /// Returns [TraceLenSummary] that contains the data about lengths of the trace parts.
+    pub fn trace_len_summary(&self) -> TraceLenSummary {
+        self.trace_len_summary
+    }
+
     // STATE MUTATORS
     // --------------------------------------------------------------------------------------------
 
@@ -82,11 +82,6 @@ impl ExecutionDetails {
         self.total_noops += 1;
     }
 
-    /// Sets the total vm cycles to the provided value
-    pub fn set_total_vm_cycles(&mut self, total_vm_cycles: u32) {
-        self.total_vm_cycles = total_vm_cycles;
-    }
-
     /// Records a new occurrence of asmop in the sorted asmop stats vector of this program info.
     /// If the asmop is already in the list, increments its frequency by one.
     /// If the asmop is not already in the list, add it at the appropriate index to keep the
@@ -115,28 +110,72 @@ impl ExecutionDetails {
             }
         }
     }
+
+    /// Sets the information about lengths of the trace parts.
+    pub fn set_trace_len_summary(&mut self, extended_cycles_info: &TraceLenSummary) {
+        self.trace_len_summary = *extended_cycles_info;
+    }
 }
 
 impl fmt::Display for ExecutionDetails {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        let total_vm_cycles = self.total_vm_cycles();
+        // calculate the percentage of padded rows
+        let padding_percentage = (self.trace_len_summary().padded_trace_len()
+            - self.trace_len_summary().trace_len())
+            * 100
+            / self.trace_len_summary().padded_trace_len();
+
+        writeln!(
+            f,
+            "\nVM cycles: {} extended to {} steps ({}% padding).
+├── Stack rows: {}
+├── Range checker rows: {}
+└── Chiplets rows: {}
+    ├── Hash chiplet rows: {}
+    ├── Bitwise chiplet rows: {}
+    ├── Memory chiplet rows: {}
+    └── Kernel ROM rows: {}",
+            self.trace_len_summary().trace_len(),
+            self.trace_len_summary().padded_trace_len(),
+            padding_percentage,
+            self.trace_len_summary().main_trace_len(),
+            self.trace_len_summary().range_trace_len(),
+            self.trace_len_summary().chiplets_trace_len().trace_len(),
+            self.trace_len_summary().chiplets_trace_len().hash_chiplet_len(),
+            self.trace_len_summary().chiplets_trace_len().bitwise_chiplet_len(),
+            self.trace_len_summary().chiplets_trace_len().memory_chiplet_len(),
+            self.trace_len_summary().chiplets_trace_len().kernel_rom_len(),
+        )?;
         let total_noops = self.total_noops();
         let asm_op_stats = self.asm_op_stats();
-        writeln!(f, "Total Number of VM Cycles: {}\n", total_vm_cycles)?;
         writeln!(f, "Total Number of NOOPs executed: {}\n", total_noops)?;
+
+        // calculate the total length of pading for the `AsmOp` column
+        let padding =
+            asm_op_stats.iter().try_fold(20, |max, value| Ok(value.op().len().max(max)))?;
+
         writeln!(
             f,
-            "{0: <20} | {1: <20} | {2: <20} | {3: <20}",
-            "AsmOp", "Frequency", "Total Cycles", "Avg Instruction Cycles"
+            "{0: <width$} | {1: <20} | {2: <20} | {3:}",
+            "AsmOp",
+            "Frequency",
+            "Total Cycles",
+            "Avg Instruction Cycles",
+            width = padding,
         )?;
+
+        let delimeter = "-".repeat(padding + 71);
+        writeln!(f, "{delimeter}")?;
+
         for op_info in asm_op_stats {
             writeln!(
                 f,
-                "{0: <20} | {1: <20} | {2: <20} | {3: <20.2}",
+                "{0: <width$} | {1: <20} | {2: <20} | {3:.2}",
                 op_info.op(),
                 op_info.frequency(),
                 op_info.total_vm_cycles(),
-                op_info.total_vm_cycles() as f64 / op_info.frequency() as f64
+                op_info.total_vm_cycles() as f64 / op_info.frequency() as f64,
+                width = padding,
             )?;
         }
         Ok(())
@@ -158,9 +197,11 @@ where
         .map_err(ProgramError::AssemblyError)?
         .compile(program)
         .map_err(ProgramError::AssemblyError)?;
-    let vm_state_iterator = processor::execute_iter(&program, stack_inputs, host);
     let mut execution_details = ExecutionDetails::default();
 
+    let vm_state_iterator = processor::execute_iter(&program, stack_inputs, host);
+    execution_details.set_trace_len_summary(vm_state_iterator.trace_len_summary());
+
     for state in vm_state_iterator {
         let vm_state = state.map_err(ProgramError::ExecutionError)?;
         if matches!(vm_state.op, Some(Operation::Noop)) {
@@ -169,7 +210,6 @@ where
         if let Some(asmop_info) = vm_state.asmop {
             execution_details.record_asmop(asmop_info);
         }
-        execution_details.set_total_vm_cycles(vm_state.clk);
     }
 
     Ok(execution_details)
@@ -233,7 +273,7 @@ impl AsmOpStats {
 mod tests {
     use super::{AsmOpStats, ExecutionDetails, StackInputs};
     use miden::MemAdviceProvider;
-    use processor::DefaultHost;
+    use processor::{ChipletsLengths, DefaultHost, TraceLenSummary};
 
     #[test]
     fn analyze_test() {
@@ -244,7 +284,6 @@ mod tests {
         let execution_details =
             super::analyze(source, stack_inputs, host).expect("analyze_test: Unexpected Error");
         let expected_details = ExecutionDetails {
-            total_vm_cycles: 23,
             total_noops: 2,
             asm_op_stats: vec![
                 AsmOpStats::new("dropw".to_string(), 1, 4),
@@ -253,6 +292,11 @@ mod tests {
                 AsmOpStats::new("movdn.2".to_string(), 1, 1),
                 AsmOpStats::new("push".to_string(), 2, 3),
             ],
+            trace_len_summary: TraceLenSummary::new(
+                23,
+                39,
+                ChipletsLengths::from_parts(8, 0, 2, 0),
+            ),
         };
         assert_eq!(execution_details, expected_details);
     }

processor/src/debug.rs

@@ -1,5 +1,6 @@
 use crate::{
-    Chiplets, Decoder, ExecutionError, Felt, Host, Process, Stack, StarkField, System, Vec,
+    range::RangeChecker, Chiplets, ChipletsLengths, Decoder, ExecutionError, Felt, Host, Process,
+    Stack, StarkField, System, TraceLenSummary, Vec,
 };
 use core::fmt;
 use vm_core::{
@@ -55,14 +56,17 @@ pub struct VmStateIterator {
     clk: u32,
     asmop_idx: usize,
     forward: bool,
+    trace_len_summary: TraceLenSummary,
 }
 
 impl VmStateIterator {
     pub(super) fn new<H>(process: Process<H>, result: Result<StackOutputs, ExecutionError>) -> Self
     where
         H: Host,
     {
-        let (system, decoder, stack, _, chiplets, _) = process.into_parts();
+        let (system, decoder, stack, mut range, chiplets, _) = process.into_parts();
+        let trace_len_summary = Self::build_trace_len_summary(&system, &mut range, &chiplets);
+
         Self {
             chiplets,
             decoder,
@@ -72,6 +76,7 @@ impl VmStateIterator {
             clk: 0,
             asmop_idx: 0,
             forward: true,
+            trace_len_summary,
         }
     }
 
@@ -171,6 +176,23 @@ impl VmStateIterator {
     pub fn into_parts(self) -> (System, Decoder, Stack, Chiplets, Option<ExecutionError>) {
         (self.system, self.decoder, self.stack, self.chiplets, self.error)
     }
+
+    pub fn trace_len_summary(&self) -> &TraceLenSummary {
+        &self.trace_len_summary
+    }
+
+    /// Returns an instance of [TraceLenSummary] based on provided data.
+    fn build_trace_len_summary(
+        system: &System,
+        range: &mut RangeChecker,
+        chiplets: &Chiplets,
+    ) -> TraceLenSummary {
+        let clk = system.clk();
+        let range_table_len = range.get_number_range_checker_rows();
+        chiplets.append_range_checks(range);
+
+        TraceLenSummary::new(clk as usize, range_table_len, ChipletsLengths::new(chiplets))
+    }
 }
 
 impl Iterator for VmStateIterator {

processor/src/lib.rs

@@ -51,8 +51,8 @@ mod chiplets;
 use chiplets::Chiplets;
 
 mod trace;
-pub use trace::ExecutionTrace;
 use trace::TraceFragment;
+pub use trace::{ChipletsLengths, ExecutionTrace, TraceLenSummary};
 
 mod errors;
 pub use errors::{ExecutionError, Ext2InttError};

processor/src/trace/utils.rs

@@ -247,7 +247,7 @@ impl HintCycle for u64 {
 /// - `range_trace_len` contains the length of the range checker trace.
 /// - `chiplets_trace_len` contains the trace lengths of the all chiplets (hash, bitwise, memory,
 /// kernel ROM)
-#[derive(Debug)]
+#[derive(Debug, Default, Eq, PartialEq, Clone, Copy)]
 pub struct TraceLenSummary {
     main_trace_len: usize,
     range_trace_len: usize,
@@ -297,7 +297,7 @@ impl TraceLenSummary {
 
 /// Contains trace lengths of all chilplets: hash, bitwise, memory and kernel ROM trace
 /// lengths.
-#[derive(Clone, Copy, Debug)]
+#[derive(Default, Clone, Copy, Debug, PartialEq, Eq)]
 pub struct ChipletsLengths {
     hash_chiplet_len: usize,
     bitwise_chiplet_len: usize,
@@ -315,6 +315,21 @@ impl ChipletsLengths {
         }
     }
 
+    #[cfg(test)]
+    pub fn from_parts(
+        hash_len: usize,
+        bitwise_len: usize,
+        memory_len: usize,
+        kernel_len: usize,
+    ) -> Self {
+        ChipletsLengths {
+            hash_chiplet_len: hash_len,
+            bitwise_chiplet_len: bitwise_len,
+            memory_chiplet_len: memory_len,
+            kernel_rom_len: kernel_len,
+        }
+    }
+
     /// Returns the length of the hash chiplet trace
     pub fn hash_chiplet_len(&self) -> usize {
         self.hash_chiplet_len