Add benchmark for simple transaction

Makefile.toml

@@ -94,7 +94,14 @@ description = "Build using no-std"
 command = "cargo"
 args = ["build", "--no-default-features", "--target", "wasm32-unknown-unknown", "--workspace", "--exclude", "miden-mock"]
 
-# --- utilities ----------------------------------------------------------------------------------------
+# --- benchmarking --------------------------------------------------------------------------------
+[tasks.bench-simple]
+description = "Run transaction benchmark with default transaction script and notes"
+workspace = false
+command = "cargo"
+args = ["run", "--bin", "benchmarks", "--features", "executable", "simple"]
+
+# --- utilities -----------------------------------------------------------------------------------
 [tasks.watch]
 description = "Watch for changes and rebuild"
 workspace = false

miden-lib/asm/kernels/transaction/main.masm

@@ -5,6 +5,40 @@ use.miden::kernels::tx::memory
 use.miden::kernels::tx::note
 use.miden::kernels::tx::prologue
 
+# TRACES
+# =================================================================================================
+
+# Trace emitted to signal that an execution of the transaction prologue has started.
+const.PROLOGUE_START=131072
+# Trace emitted to signal that an execution of the transaction prologue has ended.
+const.PROLOGUE_END=131073
+
+# Trace emitted to signal that the notes processing has started.
+const.NOTES_PROCESSING_START=131074
+# Trace emitted to signal that the notes processing has ended.
+const.NOTES_PROCESSING_END=131075
+
+# Trace emitted to signal that the note consuming has started.
+const.NOTE_CONSUMING_START=131076
+# Trace emitted to signal that the note consuming has ended.
+const.NOTE_CONSUMING_END=131077
+
+# Trace emitted to signal that the transaction script processing has started.
+const.TX_SCRIPT_PROCESSING_START=131078
+# Trace emitted to signal that the transaction script processing has ended.
+const.TX_SCRIPT_PROCESSING_END=131079
+
+# Trace emitted to signal that an execution of the transaction epilogue has started.
+const.EPILOGUE_START=131080
+# Trace emitted to signal that an execution of the transaction epilogue has ended.
+const.EPILOGUE_END=131081
+
+# Trace emmited to signal that an execution of the program has ended.
+const.EXECUTION_END=196607
+
+# MAIN
+# =================================================================================================
+
 #! This is the entrypoint for the transaction kernel program. It is composed of the following
 #! program sections:
 #!
@@ -64,13 +98,25 @@ proc.main.1
     # Prologue
     # ---------------------------------------------------------------------------------------------
 
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.PROLOGUE_START
+
     # execute the transaction prologue
     exec.prologue::prepare_transaction
     # => []
 
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.PROLOGUE_END
+
     # Note Processing
     # ---------------------------------------------------------------------------------------------
 
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.NOTES_PROCESSING_START
+
     # get the total number of consumed notes
     exec.memory::get_total_num_consumed_notes
     # => [num_consumed_notes]
@@ -86,6 +132,10 @@ proc.main.1
 
     # loop while we have notes to consume
     while.true
+        # add redundant instructions to make span non-empty
+        push.0 drop
+        trace.NOTE_CONSUMING_START
+
         # execute the note setup script
         exec.note::prepare_note
         # => [NOTE_SCRIPT_HASH, NOTE_ARGS]
@@ -103,15 +153,27 @@ proc.main.1
         loc_load.0
         neq
         # => [should_loop]
+
+        # add redundant instructions to make span non-empty
+        push.0 drop
+        trace.NOTE_CONSUMING_END
     end
 
     # execute note processing teardown
     exec.note::note_processing_teardown
     # => []
 
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.NOTES_PROCESSING_END
+
     # Transaction Script Processing
     # ---------------------------------------------------------------------------------------------
 
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.TX_SCRIPT_PROCESSING_START
+
     # execute the transaction script
     exec.memory::get_tx_script_root
     # => [TX_SCRIPT_ROOT]
@@ -133,14 +195,30 @@ proc.main.1
         # => []
     end
 
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.TX_SCRIPT_PROCESSING_END
+
     # Epilogue
     # ---------------------------------------------------------------------------------------------
 
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.EPILOGUE_START
+
     # execute the transaction epilogue
     exec.epilogue::finalize_transaction
     # => [TX_SCRIPT_ROOT, CREATED_NOTES_COMMITMENT, FINAL_ACCOUNT_HASH]
+
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.EPILOGUE_END
 end
 
 begin
     exec.main
+
+    # add redundant instructions to make span non-empty
+    push.0 drop
+    trace.EXECUTION_END
 end

miden-lib/src/transaction/errors.rs

@@ -105,3 +105,28 @@ impl fmt::Display for TransactionEventParsingError {
 
 #[cfg(feature = "std")]
 impl std::error::Error for TransactionEventParsingError {}
+
+// TRANSACTION TRACE PARSING ERROR
+// ================================================================================================
+
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub enum TransactionTraceParsingError {
+    InvalidTransactionTrace(u32),
+    NotTransactionTrace(u32),
+}
+
+impl fmt::Display for TransactionTraceParsingError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Self::InvalidTransactionTrace(trace_id) => {
+                write!(f, "trace {trace_id} is invalid")
+            },
+            Self::NotTransactionTrace(trace_id) => {
+                write!(f, "trace {trace_id} is not a transaction kernel trace")
+            },
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for TransactionTraceParsingError {}

miden-lib/src/transaction/events.rs

@@ -1,6 +1,12 @@
 use core::fmt;
 
-use super::TransactionEventParsingError;
+use super::{TransactionEventParsingError, TransactionTraceParsingError};
+
+// CONSTANTS
+// ================================================================================================
+
+/// Value of the top 16 bits of a transaction kernel event ID.
+pub const EVENT_ID_PREFIX: u32 = 2;
 
 // TRANSACTION EVENT
 // ================================================================================================
@@ -30,11 +36,6 @@ pub enum TransactionEvent {
     NoteCreated = NOTE_CREATED,
 }
 
-impl TransactionEvent {
-    /// Value of the top 16 bits of a transaction kernel event ID.
-    pub const EVENT_ID_PREFIX: u16 = 2;
-}
-
 impl fmt::Display for TransactionEvent {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         write!(f, "{self:?}")
@@ -45,7 +46,7 @@ impl TryFrom<u32> for TransactionEvent {
     type Error = TransactionEventParsingError;
 
     fn try_from(value: u32) -> Result<Self, Self::Error> {
-        if value >> 16 != Self::EVENT_ID_PREFIX as u32 {
+        if value >> 16 != EVENT_ID_PREFIX {
             return Err(TransactionEventParsingError::NotTransactionEvent(value));
         }
 
@@ -60,3 +61,54 @@ impl TryFrom<u32> for TransactionEvent {
         }
     }
 }
+
+// TRANSACTION TRACE
+// ================================================================================================
+
+#[repr(u32)]
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub enum TransactionTrace {
+    PrologueStart = 0x2_0000,           // 131072
+    PrologueEnd = 0x2_0001,             // 131073
+    NotesProcessingStart = 0x2_0002,    // 131074
+    NotesProcessingEnd = 0x2_0003,      // 131075
+    NoteConsumingStart = 0x2_0004,      // 131076
+    NoteConsumingEnd = 0x2_0005,        // 131077
+    TxScriptProcessingStart = 0x2_0006, // 131078
+    TxScriptProcessingEnd = 0x2_0007,   // 131079
+    EpilogueStart = 0x2_0008,           // 131080
+    EpilogueEnd = 0x2_0009,             // 131081
+
+    ExecutionEnd = 0x2_FFFF, // 196607
+}
+
+impl fmt::Display for TransactionTrace {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "{self:?}")
+    }
+}
+
+impl TryFrom<u32> for TransactionTrace {
+    type Error = TransactionTraceParsingError;
+
+    fn try_from(value: u32) -> Result<Self, Self::Error> {
+        if value >> 16 != EVENT_ID_PREFIX {
+            return Err(TransactionTraceParsingError::NotTransactionTrace(value));
+        }
+
+        match value {
+            0x2_0000 => Ok(TransactionTrace::PrologueStart),
+            0x2_0001 => Ok(TransactionTrace::PrologueEnd),
+            0x2_0002 => Ok(TransactionTrace::NotesProcessingStart),
+            0x2_0003 => Ok(TransactionTrace::NotesProcessingEnd),
+            0x2_0004 => Ok(TransactionTrace::NoteConsumingStart),
+            0x2_0005 => Ok(TransactionTrace::NoteConsumingEnd),
+            0x2_0006 => Ok(TransactionTrace::TxScriptProcessingStart),
+            0x2_0007 => Ok(TransactionTrace::TxScriptProcessingEnd),
+            0x2_0008 => Ok(TransactionTrace::EpilogueStart),
+            0x2_0009 => Ok(TransactionTrace::EpilogueEnd),
+            0x2_FFFF => Ok(TransactionTrace::ExecutionEnd),
+            _ => Err(TransactionTraceParsingError::InvalidTransactionTrace(value)),
+        }
+    }
+}

miden-lib/src/transaction/mod.rs

@@ -15,7 +15,7 @@ use super::MidenLib;
 pub mod memory;
 
 mod events;
-pub use events::TransactionEvent;
+pub use events::{TransactionEvent, TransactionTrace};
 
 mod inputs;
 pub use inputs::ToTransactionKernelInputs;
@@ -27,7 +27,9 @@ pub use outputs::{
 };
 
 mod errors;
-pub use errors::{TransactionEventParsingError, TransactionKernelError};
+pub use errors::{
+    TransactionEventParsingError, TransactionKernelError, TransactionTraceParsingError,
+};
 
 // TRANSACTION KERNEL
 // ================================================================================================

miden-tx/Cargo.toml

@@ -12,6 +12,13 @@ repository.workspace = true
 rust-version.workspace = true
 edition.workspace = true
 
+[[bin]]
+name = "benchmarks"
+path = "src/tx_benches/mod.rs"
+bench = false
+doctest = false
+required-features = ["executable"]
+
 [[test]]
 name = "miden-tx"
 path = "tests/integration/main.rs"
@@ -20,14 +27,16 @@ path = "tests/integration/main.rs"
 concurrent = ["miden-lib/concurrent", "miden-objects/concurrent", "miden-prover/concurrent", "std"]
 default = ["std"]
 std = ["miden-lib/std", "miden-objects/std", "miden-prover/std", "miden-verifier/std", "vm-processor/std"]
+executable = ["std", "dep:clap"]
 
 [dependencies]
+clap = { version = "4.4", features = ["derive"], optional = true }
 miden-lib = { package = "miden-lib", path = "../miden-lib", version = "0.3", default-features = false }
 miden-objects = { package = "miden-objects", path = "../objects", version = "0.3", default-features = false }
 miden-prover = { workspace = true }
 miden-verifier = { workspace = true }
+mock = { package = "miden-mock", path = "../mock", default-features = false }
 vm-processor = { workspace = true }
 
 [dev-dependencies]
-mock = { package = "miden-mock", path = "../mock", default-features = false }
 rand_chacha = { version = "0.3", default-features = false }

miden-tx/src/executor/mod.rs

@@ -43,6 +43,7 @@ pub struct TransactionExecutor<D: DataStore> {
 impl<D: DataStore> TransactionExecutor<D> {
     // CONSTRUCTOR
     // --------------------------------------------------------------------------------------------
+
     /// Creates a new [TransactionExecutor] instance with the specified [DataStore].
     pub fn new(data_store: D) -> Self {
         Self {
@@ -52,6 +53,12 @@ impl<D: DataStore> TransactionExecutor<D> {
         }
     }
 
+    /// Enables tracing for the created instance of [TransactionExecutor].
+    pub fn with_tracing(mut self) -> Self {
+        self.exec_options = self.exec_options.with_tracing();
+        self
+    }
+
     // STATE MUTATORS
     // --------------------------------------------------------------------------------------------
 
@@ -179,7 +186,7 @@ impl<D: DataStore> TransactionExecutor<D> {
     /// Returns an error if:
     /// - If required data can not be fetched from the [DataStore].
     /// - If the transaction can not be compiled.
-    fn prepare_transaction(
+    pub fn prepare_transaction(
         &self,
         account_id: AccountId,
         block_ref: u32,

miden-tx/src/tests.rs

@@ -357,7 +357,7 @@ fn test_tx_script() {
 // ================================================================================================
 
 #[derive(Clone)]
-struct MockDataStore {
+pub struct MockDataStore {
     pub account: Account,
     pub block_header: BlockHeader,
     pub block_chain: ChainMmr,