Tracking PR for v0.8.0 release

.editorconfig

@@ -0,0 +1,20 @@
+# Documentation available at editorconfig.org
+
+root=true
+
+[*]
+ident_style = space
+ident_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.rs]
+max_line_length = 100
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+ident_size = 2

.github/dependabot.yml

@@ -3,4 +3,4 @@ updates:
   - package-ecosystem: "cargo"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "weekly"

.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on:
     branches:
       - main
   pull_request:
-    types: [opened, repoened, synchronize]
+    types: [opened, reopened, synchronize]
 
 jobs:
   check:

.gitignore

@@ -17,3 +17,9 @@ stdlib/assets/std.masl
 
 # These are files generated by MacOS
 **/.DS_Store
+
+# File present in Intellij IDE's.
+.idea/
+
+# VS Code
+.vscode/

CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 0.8.0 (TBD)
+
+#### Assembly
+- Expanded capabilities of the `debug` decorator. Added `debug.mem` and `debug.local` variations (#1103).
+- Introduced the `emit.<event_id>` assembly instruction (#1119).
+- Introduced the `procref.<proc_name>` assembly instruction (#1113).
+- Added the ability to use constants as counters in `repeat` loops (#1124). 
+- All `checked` versions of the u32 instructions were removed. All `unchecked` versions were renamed: this mode specification was removed from their titles (#1115).
+- Introduced the `u32clz`, `u32ctz`, `u32clo`, `u32cto` and `ilog2` assembly instructions (#1176).
+- Added support for hexadecimal values in constants (#1199).
+- Added the `RCombBase` instruction (#1216).
+
+#### Stdlib
+- Introduced `std::utils` module with `is_empty_word` procedure.  Refactored `std::collections::smt`
+  and `std::collections::smt64` to use the procedure (#1107).
+- Removed `checked` versions of the instructions in the `std::math::u64` module (#1142). 
+- Introduced `clz`, `ctz`, `clo` and `cto` instructions in the `std::math::u64` module (#1179).
+- Removed `std::collections::smt64` (#1249)
+
+#### VM Internals
+- Introduced the `Event` decorator and an associated `on_event` handler on the `Host` trait (#1119).
+- Updated Winterfell dependency to v0.7 (#1121).
+- Added methods `StackOutputs::get_stack_item()` and `StackOutputs::get_stack_word()` (#1155).
+- Added [Tracing](https://crates.io/crates/tracing) logger to the VM (#1139).
+- Added `on_assert_failed()` method to the Host trait (#1197).
+- Added support for handling `trace` instruction in the `Host` interface (#1198).
+
+#### CLI
+- Introduced the `!use` command for the Miden REPL (#1162).
+- Introduced a `BLAKE3` hashing example (#1180).
+
 ## 0.7.0 (2023-10-11)
 
 #### Assembly
@@ -17,16 +48,16 @@
 
 #### VM Internals
 - Simplified range checker and removed 1 main and 1 auxiliary trace column (#949).
-- Migrated range checker lookups to use LogUp and reduced the number of trace columns to 2 main and 
+- Migrated range checker lookups to use LogUp and reduced the number of trace columns to 2 main and
   1 auxiliary (#1027).
 - Added `get_mapped_values()` and `get_store_subset()` methods to the `AdviceProvider` trait (#987).
 - [BREAKING] Added options to specify maximum number of cycles and expected number of cycles for a program (#998).
 - Improved handling of invalid/incomplete parameters in `StackOutputs` constructors (#1010).
 - Allowed the assembler to produce programs with "phantom" calls (#1019).
 - Added `TraceLenSummary` struct which holds information about traces lengths to the `ExecutionTrace` (#1029).
-- Imposed the 2^32 limit for the memory addresses used in the memory chiplet (#1049). 
+- Imposed the 2^32 limit for the memory addresses used in the memory chiplet (#1049).
 - Supported `PartialMerkleTree` as a secret input in `.input` file (#1072).
-- [BREAKING] Refactored `AdviceProvider` interface into [Host] interface (#1082).
+- [BREAKING] Refactored `AdviceProvider` interface into `Host` interface (#1082).
 
 #### Stdlib
 - Completed `std::collections::smt` module by implementing `insert` and `set` procedures (#1036, #1038, #1046).

Makefile

@@ -1,6 +1,6 @@
 FEATURES_INTERNALS=--features internals
 FEATURES_CONCURRENT_EXEC=--features concurrent,executable
-FEATURES_GRAVITON_EXEC=--features concurrent,executable,sve
+FEATURES_LOG_TREE=--features concurrent,executable,tracing-forest
 FEATURES_METAL_EXEC=--features concurrent,executable,metal
 PROFILE_OPTIMIZED=--profile optimized
 PROFILE_TEST=--profile test-release
@@ -14,8 +14,14 @@ exec:
 exec-metal:
 	cargo build $(PROFILE_OPTIMIZED) $(FEATURES_METAL_EXEC)
 
-exec-graviton:
-	RUSTFLAGS="-C target-cpu=native" cargo build $(PROFILE_OPTIMIZED) $(FEATURES_GRAVITON_EXEC)
+exec-avx2:
+	RUSTFLAGS="-C target-feature=+avx2" cargo build $(PROFILE_OPTIMIZED) $(FEATURES_CONCURRENT_EXEC)
+
+exec-sve:
+	RUSTFLAGS="-C target-feature=+sve" cargo build $(PROFILE_OPTIMIZED) $(FEATURES_CONCURRENT_EXEC)
+
+exec-info:
+	cargo build $(PROFILE_OPTIMIZED) $(FEATURES_LOG_TREE)
 
 test:
 	cargo test $(PROFILE_TEST) $(FEATURES_INTERNALS)

README.md

@@ -16,7 +16,7 @@ Miden VM is a zero-knowledge virtual machine written in Rust. For any program ex
 * If you'd like to learn more about STARKs, check out the [references](#references) section.
 
 ### Status and features
-Miden VM is currently on release v0.7. In this release, most of the core features of the VM have been stabilized, and most of the STARK proof generation has been implemented. While we expect to keep making changes to the VM internals, the external interfaces should remain relatively stable, and we will do our best to minimize the amount of breaking changes going forward.
+Miden VM is currently on release v0.8. In this release, most of the core features of the VM have been stabilized, and most of the STARK proof generation has been implemented. While we expect to keep making changes to the VM internals, the external interfaces should remain relatively stable, and we will do our best to minimize the amount of breaking changes going forward.
 
 The next version of the VM is being developed in the [next](https://github.com/0xPolygonMiden/miden-vm/tree/next) branch. There is also a documentation for the latest features and changes in the next branch [documentation next branch](https://0xpolygonmiden.github.io/miden-vm/intro/main.html).
 

air/Cargo.toml

@@ -1,11 +1,12 @@
 [package]
 name = "miden-air"
-version = "0.7.0"
+version = "0.8.0"
 description = "Algebraic intermediate representation of Miden VM processor"
 authors = ["miden contributors"]
 readme = "README.md"
 license = "MIT"
 repository = "https://github.com/0xPolygonMiden/miden-vm"
+documentation = "https://docs.rs/miden-air/0.8.0"
 categories = ["cryptography", "no-std"]
 keywords = ["air", "arithmetization", "crypto", "miden"]
 edition = "2021"
@@ -26,12 +27,14 @@ harness = false
 [features]
 default = ["std"]
 std = ["vm-core/std", "winter-air/std"]
+internals = []
 
 [dependencies]
-vm-core = { package = "miden-core", path = "../core", version = "0.7", default-features = false }
-winter-air = { package = "winter-air", version = "0.6", default-features = false }
+vm-core = { package = "miden-core", path = "../core", version = "0.8", default-features = false }
+winter-air = { package = "winter-air", version = "0.8", default-features = false }
+winter-prover = { package = "winter-prover", version = "0.8", default-features = false }
 
 [dev-dependencies]
 criterion = "0.5"
 proptest = "1.3"
-rand-utils = { package = "winter-rand-utils", version = "0.6" }
+rand-utils = { package = "winter-rand-utils", version = "0.8" }

air/src/constraints/chiplets/bitwise/mod.rs

@@ -1,11 +1,11 @@
-use super::{EvaluationFrame, Felt, FieldElement, Vec};
+use super::{EvaluationFrame, Felt, FieldElement};
 use crate::{
     trace::chiplets::{
         bitwise::{NUM_DECOMP_BITS, NUM_SELECTORS, OP_CYCLE_LEN},
         BITWISE_A_COL_IDX, BITWISE_A_COL_RANGE, BITWISE_B_COL_IDX, BITWISE_B_COL_RANGE,
         BITWISE_OUTPUT_COL_IDX, BITWISE_PREV_OUTPUT_COL_IDX, BITWISE_SELECTOR_COL_IDX,
     },
-    utils::{are_equal, binary_not, is_binary, is_zero, EvaluationResult},
+    utils::{are_equal, binary_not, collections::*, is_binary, is_zero, EvaluationResult},
     ONE, ZERO,
 };
 use winter_air::TransitionConstraintDegree;
@@ -232,7 +232,7 @@ pub fn bitwise_and<E: FieldElement>(decomposed_values: &[E]) -> E {
     for idx in 0..NUM_DECOMP_BITS {
         let a = decomposed_values[idx];
         let b = decomposed_values[idx + NUM_DECOMP_BITS];
-        result += E::from(2_u64.pow(idx as u32)) * a * b
+        result += E::from(2_u32.pow(idx as u32)) * a * b
     }
     result
 }
@@ -245,7 +245,7 @@ pub fn bitwise_xor<E: FieldElement>(decomposed_values: &[E]) -> E {
     for idx in 0..NUM_DECOMP_BITS {
         let a = decomposed_values[idx];
         let b = decomposed_values[idx + NUM_DECOMP_BITS];
-        result += E::from(2_u64.pow(idx as u32)) * (a + b - E::from(2_u8) * a * b)
+        result += E::from(2_u32.pow(idx as u32)) * (a + b - E::from(2_u8) * a * b)
     }
     result
 }
@@ -407,7 +407,7 @@ pub fn agg_bits<E: FieldElement>(row: &[E], start_idx: usize) -> E {
     // thus, in theory, we could just aggregate results in a 128-bit integer and perform only a
     // single reduction in the end. This works only when we are in the base field."
     for bit_idx in 0..NUM_DECOMP_BITS {
-        result += E::from(2_u64.pow(bit_idx as u32)) * row[start_idx + bit_idx];
+        result += E::from(2_u32.pow(bit_idx as u32)) * row[start_idx + bit_idx];
     }
     result
 }

air/src/constraints/chiplets/hasher/mod.rs

@@ -1,12 +1,13 @@
-use super::{EvaluationFrame, Felt, FieldElement, TransitionConstraintDegree, Vec};
-use crate::trace::chiplets::{
-    hasher::{
-        Hasher, CAPACITY_LEN, DIGEST_LEN, DIGEST_RANGE, HASH_CYCLE_LEN, NUM_SELECTORS, STATE_WIDTH,
-    },
-    HASHER_NODE_INDEX_COL_IDX, HASHER_SELECTOR_COL_RANGE, HASHER_STATE_COL_RANGE,
-};
+use super::{EvaluationFrame, Felt, FieldElement, TransitionConstraintDegree};
 use crate::{
-    utils::{are_equal, binary_not, is_binary, EvaluationResult},
+    trace::chiplets::{
+        hasher::{
+            Hasher, CAPACITY_LEN, DIGEST_LEN, DIGEST_RANGE, HASH_CYCLE_LEN, NUM_SELECTORS,
+            STATE_WIDTH,
+        },
+        HASHER_NODE_INDEX_COL_IDX, HASHER_SELECTOR_COL_RANGE, HASHER_STATE_COL_RANGE,
+    },
+    utils::{are_equal, binary_not, collections::*, is_binary, EvaluationResult},
     ONE, ZERO,
 };
 
@@ -344,9 +345,11 @@ trait EvaluationFrameExt<E: FieldElement> {
     // --- Flags ----------------------------------------------------------------------------------
 
     /// Set to 1 on the first 7 steps of every 8-step cycle. This flag is degree 1.
+    #[allow(dead_code)]
     fn f_rpr(&self, k: &[E]) -> E;
     /// Set to 1 when selector flags are (1,0,0) on rows which are multiples of 8. This flag is
     /// degree 4.
+    #[allow(dead_code)]
     fn f_bp(&self, k: &[E]) -> E;
     /// Set to 1 when selector flags are (1,0,1) on rows which are multiples of 8. This flag is
     /// degree 4.
@@ -359,9 +362,11 @@ trait EvaluationFrameExt<E: FieldElement> {
     fn f_mu(&self, k: &[E]) -> E;
     /// Set to 1 when selector flags are (0,0,0) on rows which are 1 less than a multiple of 8. This
     /// flag is degree 4.
+    #[allow(dead_code)]
     fn f_hout(&self, k: &[E]) -> E;
     /// Set to 1 when selector flags are (0,0,1) on rows which are 1 less than a multiple of 8. This
     /// flag is degree 4.
+    #[allow(dead_code)]
     fn f_sout(&self, k: &[E]) -> E;
     /// This flag will be set to 1 when either f_hout=1 or f_sout=1 in the current row. This flag is
     /// degree 3.

air/src/constraints/chiplets/hasher/tests.rs

@@ -4,10 +4,11 @@ use super::{
 };
 use crate::{
     trace::chiplets::hasher::{Selectors, LINEAR_HASH, STATE_WIDTH},
+    utils::collections::*,
     Felt, TRACE_WIDTH,
 };
 use rand_utils::rand_array;
-use vm_core::{chiplets::hasher::apply_round, utils::collections::Vec};
+use vm_core::chiplets::hasher::apply_round;
 use winter_air::EvaluationFrame;
 
 // UNIT TESTS

air/src/constraints/chiplets/memory/mod.rs

@@ -1,10 +1,12 @@
-use super::{EvaluationFrame, FieldElement, Vec};
-use crate::trace::chiplets::{
-    memory::NUM_ELEMENTS, MEMORY_ADDR_COL_IDX, MEMORY_CLK_COL_IDX, MEMORY_CTX_COL_IDX,
-    MEMORY_D0_COL_IDX, MEMORY_D1_COL_IDX, MEMORY_D_INV_COL_IDX, MEMORY_TRACE_OFFSET,
-    MEMORY_V_COL_RANGE,
+use super::{EvaluationFrame, FieldElement};
+use crate::{
+    trace::chiplets::{
+        memory::NUM_ELEMENTS, MEMORY_ADDR_COL_IDX, MEMORY_CLK_COL_IDX, MEMORY_CTX_COL_IDX,
+        MEMORY_D0_COL_IDX, MEMORY_D1_COL_IDX, MEMORY_D_INV_COL_IDX, MEMORY_TRACE_OFFSET,
+        MEMORY_V_COL_RANGE,
+    },
+    utils::{binary_not, collections::*, is_binary, EvaluationResult},
 };
-use crate::utils::{binary_not, is_binary, EvaluationResult};
 use winter_air::TransitionConstraintDegree;
 
 #[cfg(test)]
@@ -174,12 +176,16 @@ trait EvaluationFrameExt<E: FieldElement> {
     /// Gets the value of the specified selector column in the next row.
     fn selector_next(&self, idx: usize) -> E;
     /// The current context value.
+    #[allow(dead_code)]
     fn ctx(&self) -> E;
     /// The current address.
+    #[allow(dead_code)]
     fn addr(&self) -> E;
     /// The current clock cycle.
+    #[allow(dead_code)]
     fn clk(&self) -> E;
     /// The next clock cycle.
+    #[allow(dead_code)]
     fn clk_next(&self) -> E;
     /// The value from the specified index of the values (0, 1, 2, 3) in the current row.
     fn v(&self, index: usize) -> E;

air/src/constraints/chiplets/memory/tests.rs

@@ -9,9 +9,8 @@ use crate::trace::{
     },
     TRACE_WIDTH,
 };
-use crate::{chiplets::memory, Felt, FieldElement, ONE, ZERO};
+use crate::{chiplets::memory, utils::collections::*, Felt, FieldElement, ONE, ZERO};
 use rand_utils::rand_value;
-use vm_core::utils::collections::Vec;
 
 // UNIT TESTS
 // ================================================================================================

air/src/constraints/chiplets/mod.rs

@@ -1,7 +1,7 @@
 use super::super::{
-    EvaluationFrame, Felt, FieldElement, TransitionConstraintDegree, Vec, CHIPLETS_OFFSET,
+    EvaluationFrame, Felt, FieldElement, TransitionConstraintDegree, CHIPLETS_OFFSET,
 };
-use crate::utils::{are_equal, binary_not, is_binary};
+use crate::utils::{are_equal, binary_not, collections::*, is_binary};
 
 mod bitwise;
 mod hasher;

air/src/constraints/range.rs

@@ -2,10 +2,10 @@ use crate::{
     chiplets::ChipletsFrameExt,
     constraints::MainFrameExt,
     trace::range::{B_RANGE_COL_IDX, M_COL_IDX, V_COL_IDX},
-    utils::are_equal,
+    utils::{are_equal, collections::*},
     Assertion, EvaluationFrame, Felt, FieldElement, TransitionConstraintDegree,
 };
-use vm_core::{utils::collections::Vec, ExtensionOf, ZERO};
+use vm_core::{ExtensionOf, ZERO};
 use winter_air::AuxTraceRandElements;
 
 // CONSTANTS

air/src/constraints/stack/field_ops/mod.rs

@@ -1,10 +1,8 @@
-use super::{op_flags::OpFlags, EvaluationFrame, Vec};
+use super::{op_flags::OpFlags, EvaluationFrame, FieldElement, TransitionConstraintDegree};
 use crate::{
     stack::EvaluationFrameExt,
-    utils::{are_equal, is_binary},
+    utils::{are_equal, collections::*, is_binary},
 };
-use vm_core::FieldElement;
-use winter_air::TransitionConstraintDegree;
 
 #[cfg(test)]
 pub mod tests;

air/src/constraints/stack/field_ops/tests.rs

@@ -6,7 +6,7 @@ use crate::stack::op_flags::{generate_evaluation_frame, OpFlags};
 use crate::trace::decoder::USER_OP_HELPERS_OFFSET;
 use core::ops::Neg;
 use rand_utils::rand_value;
-use vm_core::{Felt, FieldElement, Operation, StarkField, ONE, ZERO};
+use vm_core::{Felt, FieldElement, Operation, ONE, ZERO};
 
 use proptest::prelude::*;
 

air/src/constraints/stack/io_ops/mod.rs

@@ -1,7 +1,8 @@
-use super::{op_flags::OpFlags, EvaluationFrame, Vec};
-use crate::{stack::EvaluationFrameExt, utils::are_equal};
-use vm_core::FieldElement;
-use winter_air::TransitionConstraintDegree;
+use super::{op_flags::OpFlags, EvaluationFrame, FieldElement, TransitionConstraintDegree};
+use crate::{
+    stack::EvaluationFrameExt,
+    utils::{are_equal, collections::*},
+};
 
 #[cfg(test)]
 pub mod tests;