feat: release v1.4.0-rc.0 (#1887)

Co-authored-by: Zhang Zhuo <[email protected]>
Co-authored-by: Ayush Shukla <[email protected]>
Co-authored-by: Valery Cherepanov <[email protected]>
Co-authored-by: Jonathan Wang <[email protected]>
Co-authored-by: Avaneesh Kulkarni <[email protected]>

Author: 6 people

.github/workflows/versioning.yml

@@ -37,7 +37,7 @@ jobs:
 
       # Build and test from base branch
       - name: Build base branch CLI
-        run: cargo install --force --path crates/cli
+        run: cargo install --force --locked --path crates/cli
 
       - name: Run setup from base branch and snapshot ~/.openvm
         run: |
@@ -81,12 +81,11 @@ jobs:
           clean: false
 
       - name: Build tagged CLI
-        run: cargo install --force --path crates/cli
+        run: cargo install --force --locked --path crates/cli
 
       - name: Run setup from tagged version
         run: |
-          # TODO: Add --evm after v1.3.0 release
-          cargo openvm setup
+          cargo openvm setup --evm
 
       # - name: Build and keygen examples from tagged version
       #   run: |
@@ -97,9 +96,8 @@ jobs:
       #         echo "Building and generating keys for example: $example_name"
       #         cd "$example"
       #         cargo openvm build --no-transpile
-      #         # TODO(yi): Change --vk-output to --output-dir after v1.3.0 release
       #         mkdir -p "../../tagged-outputs/examples/$example_name"
-      #         cargo openvm keygen --vk-output "../../tagged-outputs/examples/$example_name/app.vk"
+      #         cargo openvm keygen --output-dir "../../tagged-outputs/examples/$example_name/app.vk"
       #         cd ../..
       #       fi
       #     done
@@ -113,9 +111,8 @@ jobs:
               echo "Building and generating keys for benchmark: $benchmark_name"
               cd "$benchmark"
               cargo openvm build --no-transpile
-              # TODO(yi): Change --vk-output to --output-dir after v1.3.0 release
               mkdir -p "../../../tagged-outputs/benchmarks/$benchmark_name"
-              cargo openvm keygen --vk-output "../../../tagged-outputs/benchmarks/$benchmark_name/app.vk"
+              cargo openvm keygen --output-dir "../../../tagged-outputs/benchmarks/$benchmark_name"
               cd ../../..
             fi
           done
@@ -167,19 +164,25 @@ jobs:
           fi
 
       # Compare all outputs
-      # TODO: After v1.3.0 release, just compare the contents of ~/.openvm-base
-      # and ~/.openvm
       - name: Compare ~/.openvm contents
         run: |
           echo "🔍 Comparing ~/.openvm agg and halo2 outputs between base branch and ${{ env.version }}..."
 
           failed=0
 
-          # Compare agg.pk with agg_halo2.pk
-          if cmp ~/.openvm-base/agg.pk ~/.openvm/agg_halo2.pk; then
-            echo "✅ agg.pk and agg_halo2.pk are identical"
+          # Compare agg_stark.pk
+          if cmp ~/.openvm-base/agg_stark.pk ~/.openvm/agg_stark.pk; then
+            echo "✅ agg_stark.pk are identical"
+          else
+            echo "❌ agg_stark.pk differ"
+            failed=1
+          fi
+
+          # Compare agg_halo2.pk
+          if cmp ~/.openvm-base/agg_halo2.pk ~/.openvm/agg_halo2.pk; then
+            echo "✅ agg_halo2.pk are identical"
           else
-            echo "❌ agg.pk and agg_halo2.pk differ"
+            echo "❌ agg_halo2.pk differ"
             failed=1
           fi
 

benchmarks/guest/ecrecover/openvm_init.rs

@@ -1,3 +1,3 @@
 // This file is automatically generated by cargo openvm. Do not rename or edit.
 openvm_algebra_guest::moduli_macros::moduli_init! { "115792089237316195423570985008687907853269984665640564039457584007908834671663", "115792089237316195423570985008687907852837564279074904382605163141518161494337" }
-openvm_ecc_guest::sw_macros::sw_init! { Secp256k1Point }
+openvm_ecc_guest::sw_macros::sw_init! { "Secp256k1Point" }

benchmarks/guest/kitchen-sink/openvm_init.rs

@@ -1,4 +1,4 @@
 // This file is automatically generated by cargo openvm. Do not rename or edit.
 openvm_algebra_guest::moduli_macros::moduli_init! { "1000000000000000003", "115792089237316195423570985008687907853269984665640564039457584007908834671663", "115792089237316195423570985008687907852837564279074904382605163141518161494337", "115792089210356248762697446949407573530086143415290314195533631308867097853951", "115792089210356248762697446949407573529996955224135760342422259061068512044369", "21888242871839275222246405745257275088696311157297823662689037894645226208583", "21888242871839275222246405745257275088548364400416034343698204186575808495617", "4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787", "52435875175126190479447740508185965837690552500527637822603658699938581184513", "2305843009213693951", "7" }
-openvm_algebra_guest::complex_macros::complex_init! { Bn254Fp2 { mod_idx = 5 }, Bls12_381Fp2 { mod_idx = 7 } }
-openvm_ecc_guest::sw_macros::sw_init! { Secp256k1Point, P256Point, Bn254G1Affine, Bls12_381G1Affine }
+openvm_algebra_guest::complex_macros::complex_init! { "Bn254Fp2" { mod_idx = 5 }, "Bls12_381Fp2" { mod_idx = 7 } }
+openvm_ecc_guest::sw_macros::sw_init! { "Secp256k1Point", "P256Point", "Bn254G1Affine", "Bls12_381G1Affine" }

benchmarks/guest/pairing/openvm_init.rs

@@ -1,4 +1,4 @@
 // This file is automatically generated by cargo openvm. Do not rename or edit.
 openvm_algebra_guest::moduli_macros::moduli_init! { "21888242871839275222246405745257275088696311157297823662689037894645226208583", "21888242871839275222246405745257275088548364400416034343698204186575808495617" }
-openvm_algebra_guest::complex_macros::complex_init! { Bn254Fp2 { mod_idx = 0 } }
-openvm_ecc_guest::sw_macros::sw_init! { Bn254G1Affine }
+openvm_algebra_guest::complex_macros::complex_init! { "Bn254Fp2" { mod_idx = 0 } }
+openvm_ecc_guest::sw_macros::sw_init! { "Bn254G1Affine" }

book/src/custom-extensions/algebra.md

@@ -80,7 +80,7 @@ moduli_init! {
     "21888242871839275222246405745257275088696311157297823662689037894645226208583"
 }
 complex_init! {
-    Bn254Fp2 { mod_idx = 0 },
+    "Bn254Fp2" { mod_idx = 0 },
 }
 */
 ```

book/src/custom-extensions/ecc.md

@@ -49,7 +49,7 @@ This creates `Bls12_381G1Affine` and `P256Affine` structs which implement the `G
 openvm::init!();
 /* This expands to
 sw_init! {
-    Bls12_381G1Affine, P256Affine,
+    "Bls12_381G1Affine", "P256Affine",
 }
 */
 ```

crates/cli/src/lib.rs

@@ -6,8 +6,7 @@ pub mod util;
 use std::process::{Command, Stdio};
 
 use eyre::{Context, Result};
-
-pub const RUSTUP_TOOLCHAIN_NAME: &str = "nightly-2025-02-14";
+pub use openvm_build::{get_rustup_toolchain_name, DEFAULT_RUSTUP_TOOLCHAIN_NAME};
 
 pub const OPENVM_VERSION_MESSAGE: &str = concat!(
     "v",

crates/toolchain/build/src/lib.rs

@@ -21,7 +21,13 @@ mod config;
 
 /// The rustc compiler [target](https://doc.rust-lang.org/rustc/targets/index.html).
 pub const RUSTC_TARGET: &str = "riscv32im-risc0-zkvm-elf";
-const RUSTUP_TOOLCHAIN_NAME: &str = "nightly-2025-02-14";
+/// The default Rust toolchain name to use if OPENVM_RUST_TOOLCHAIN is not set
+pub const DEFAULT_RUSTUP_TOOLCHAIN_NAME: &str = "nightly-2025-02-14";
+
+/// Get the Rust toolchain name from environment variable or default
+pub fn get_rustup_toolchain_name() -> String {
+    env::var("OPENVM_RUST_TOOLCHAIN").unwrap_or_else(|_| DEFAULT_RUSTUP_TOOLCHAIN_NAME.to_string())
+}
 const BUILD_LOCKED_ENV: &str = "OPENVM_BUILD_LOCKED";
 const SKIP_BUILD_ENV: &str = "OPENVM_SKIP_BUILD";
 const GUEST_LOGFILE_ENV: &str = "OPENVM_GUEST_LOGFILE";
@@ -240,7 +246,7 @@ fn sanitized_cmd(tool: &str) -> Command {
 /// Creates a std::process::Command to execute the given cargo
 /// command in an environment suitable for targeting the zkvm guest.
 pub fn cargo_command(subcmd: &str, rust_flags: &[&str]) -> Command {
-    let toolchain = format!("+{RUSTUP_TOOLCHAIN_NAME}");
+    let toolchain = format!("+{}", get_rustup_toolchain_name());
 
     let rustc = sanitized_cmd("rustup")
         .args([&toolchain, "which", "rustc"])
@@ -382,7 +388,7 @@ pub fn build_generic(guest_opts: &GuestOptions) -> Result<PathBuf, Option<i32>>
 
     // Check if the required toolchain and rust-src component are installed, and if not, install
     // them. This requires that `rustup` is installed.
-    if let Err(code) = ensure_toolchain_installed(RUSTUP_TOOLCHAIN_NAME, &["rust-src"]) {
+    if let Err(code) = ensure_toolchain_installed(&get_rustup_toolchain_name(), &["rust-src"]) {
         eprintln!("rustup toolchain commands failed. Please ensure rustup is installed (https://www.rust-lang.org/tools/install)");
         return Err(Some(code));
     }

crates/toolchain/platform/src/alloc.rs

@@ -0,0 +1,64 @@
+extern crate alloc;
+
+use alloc::alloc::{alloc, dealloc, handle_alloc_error, Layout};
+use core::ptr::NonNull;
+
+/// Bytes allocated according to the given Layout
+pub struct AlignedBuf {
+    pub ptr: *mut u8,
+    pub layout: Layout,
+}
+
+impl AlignedBuf {
+    /// Allocate a new buffer whose start address is aligned to `align` bytes.
+    /// *NOTE* if `len` is zero then a creates new `NonNull` that is dangling and 16-byte aligned.
+    pub fn uninit(len: usize, align: usize) -> Self {
+        let layout = Layout::from_size_align(len, align).unwrap();
+        if layout.size() == 0 {
+            return Self {
+                ptr: NonNull::<u128>::dangling().as_ptr() as *mut u8,
+                layout,
+            };
+        }
+        // TODO[jpw]: replace `alloc` with `allocate` once the `Allocator` trait is stabilized.
+        //            (see https://doc.rust-lang.org/alloc/alloc/fn.alloc.html)
+        // SAFETY: `len` is nonzero
+        let ptr = unsafe { alloc(layout) };
+        if ptr.is_null() {
+            handle_alloc_error(layout);
+        }
+        AlignedBuf { ptr, layout }
+    }
+
+    /// Allocate a new buffer whose start address is aligned to `align` bytes
+    /// and copy the given data into it.
+    ///
+    /// # Safety
+    /// - `bytes` must not be null
+    /// - `len` should not be zero
+    ///
+    /// See [alloc]. In particular `data` should not be empty.
+    pub unsafe fn new(bytes: *const u8, len: usize, align: usize) -> Self {
+        let buf = Self::uninit(len, align);
+        // SAFETY:
+        // - src and dst are not null
+        // - src and dst are allocated for size
+        // - no alignment requirements on u8
+        // - non-overlapping since ptr is newly allocated
+        unsafe {
+            core::ptr::copy_nonoverlapping(bytes, buf.ptr, len);
+        }
+
+        buf
+    }
+}
+
+impl Drop for AlignedBuf {
+    fn drop(&mut self) {
+        if self.layout.size() != 0 {
+            unsafe {
+                dealloc(self.ptr, self.layout);
+            }
+        }
+    }
+}

crates/toolchain/platform/src/lib.rs

@@ -4,12 +4,15 @@
 #![deny(rustdoc::broken_intra_doc_links)]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
-#[cfg(all(feature = "rust-runtime", target_os = "zkvm"))]
+#[cfg(target_os = "zkvm")]
 pub use openvm_custom_insn::{custom_insn_i, custom_insn_r};
+#[cfg(target_os = "zkvm")]
+pub mod alloc;
 #[cfg(all(feature = "rust-runtime", target_os = "zkvm"))]
 pub mod heap;
 #[cfg(all(feature = "export-libm", target_os = "zkvm"))]
 mod libm_extern;
+
 pub mod memory;
 pub mod print;
 #[cfg(feature = "rust-runtime")]
@@ -19,9 +22,6 @@ pub mod rust_rt;
 /// 4 bytes (i.e. 32 bits) as the zkVM is an implementation of the rv32im ISA.
 pub const WORD_SIZE: usize = core::mem::size_of::<u32>();
 
-/// Size of a zkVM memory page.
-pub const PAGE_SIZE: usize = 1024;
-
 /// Standard IO file descriptors for use with sys_read and sys_write.
 pub mod fileno {
     pub const STDIN: u32 = 0;