Parse struct name in sw_init as string

Author: Avaneesh-axiom

extensions/ecc/circuit/src/weierstrass_extension.rs

@@ -84,7 +84,7 @@ impl WeierstrassExtension {
         let supported_curves = self
             .supported_curves
             .iter()
-            .map(|curve_config| curve_config.struct_name.to_string())
+            .map(|curve_config| format!("\"{}\"", curve_config.struct_name))
             .collect::<Vec<String>>()
             .join(", ");
 

extensions/ecc/sw-macros/src/lib.rs

@@ -5,7 +5,8 @@ use proc_macro::TokenStream;
 use quote::format_ident;
 use syn::{
     parse::{Parse, ParseStream},
-    parse_macro_input, Expr, ExprPath, Path, Token,
+    parse_macro_input, ExprPath, Token,
+    LitStr,
 };
 
 /// This macro generates the code to setup the elliptic curve for a given modular type. Also it
@@ -28,9 +29,8 @@ pub fn sw_declare(input: TokenStream) -> TokenStream {
     let span = proc_macro::Span::call_site();
 
     for item in items.into_iter() {
-        let struct_name = item.name.to_string();
-        let struct_name = syn::Ident::new(&struct_name, span.into());
-        let struct_path: syn::Path = syn::parse_quote!(#struct_name);
+        let struct_name_str = item.name.to_string();
+        let struct_name = syn::Ident::new(&struct_name_str, span.into());
         let mut intmod_type: Option<syn::Path> = None;
         let mut const_a: Option<syn::Expr> = None;
         let mut const_b: Option<syn::Expr> = None;
@@ -74,12 +74,7 @@ pub fn sw_declare(input: TokenStream) -> TokenStream {
                     &format!(
                         "{}_{}",
                         stringify!($name),
-                        struct_path
-                            .segments
-                            .iter()
-                            .map(|x| x.ident.to_string())
-                            .collect::<Vec<_>>()
-                            .join("_")
+                        struct_name_str
                     ),
                     span.into(),
                 );
@@ -89,13 +84,13 @@ pub fn sw_declare(input: TokenStream) -> TokenStream {
         create_extern_func!(sw_double_extern_func);
         create_extern_func!(sw_setup_extern_func);
 
-        let group_ops_mod_name = format_ident!("{}_ops", struct_name.to_string().to_lowercase());
+        let group_ops_mod_name = format_ident!("{}_ops", struct_name_str.to_lowercase());
 
         let result = TokenStream::from(quote::quote_spanned! { span.into() =>
             extern "C" {
                 fn #sw_add_ne_extern_func(rd: usize, rs1: usize, rs2: usize);
                 fn #sw_double_extern_func(rd: usize, rs1: usize);
-                fn #sw_setup_extern_func();
+                fn #sw_setup_extern_func(uninit: *mut core::ffi::c_void, p1: *const u8, p2: *const u8);
             }
 
             #[derive(Eq, PartialEq, Clone, Debug, serde::Serialize, serde::Deserialize)]
@@ -196,8 +191,21 @@ pub fn sw_declare(input: TokenStream) -> TokenStream {
                 #[cfg(target_os = "zkvm")]
                 fn set_up_once() {
                     static is_setup: ::openvm_ecc_guest::once_cell::race::OnceBool = ::openvm_ecc_guest::once_cell::race::OnceBool::new();
+
                     is_setup.get_or_init(|| {
-                        unsafe { #sw_setup_extern_func(); }
+                        // p1 is (x1, y1), and x1 must be the modulus.
+                        // y1 can be anything for SetupEcAdd, but must equal `a` for SetupEcDouble
+                        let modulus_bytes = <<Self as openvm_ecc_guest::weierstrass::WeierstrassPoint>::Coordinate as openvm_algebra_guest::IntMod>::MODULUS;
+                        let mut one = [0u8; <<Self as openvm_ecc_guest::weierstrass::WeierstrassPoint>::Coordinate as openvm_algebra_guest::IntMod>::NUM_LIMBS];
+                        one[0] = 1;
+                        let curve_a_bytes = openvm_algebra_guest::IntMod::as_le_bytes(&<#struct_name as openvm_ecc_guest::weierstrass::WeierstrassPoint>::CURVE_A);
+                        // p1 should be (p, a)
+                        let p1 = [modulus_bytes.as_ref(), curve_a_bytes.as_ref()].concat();
+                        // (EcAdd only) p2 is (x2, y2), and x1 - x2 has to be non-zero to avoid division over zero in add.
+                        let p2 = [one.as_ref(), one.as_ref()].concat();
+                        let mut uninit: core::mem::MaybeUninit<[Self; 2]> = core::mem::MaybeUninit::uninit();
+ 
+                        unsafe { #sw_setup_extern_func(uninit.as_mut_ptr() as *mut core::ffi::c_void, p1.as_ptr(), p2.as_ptr()); }
                         <#intmod_type as openvm_algebra_guest::IntMod>::set_up_once();
                         true
                     });
@@ -410,23 +418,14 @@ pub fn sw_declare(input: TokenStream) -> TokenStream {
 }
 
 struct SwDefine {
-    items: Vec<Path>,
+    items: Vec<String>,
 }
 
 impl Parse for SwDefine {
     fn parse(input: ParseStream) -> syn::Result<Self> {
-        let items = input.parse_terminated(<Expr as Parse>::parse, Token![,])?;
+        let items = input.parse_terminated(<LitStr as Parse>::parse, Token![,])?;
         Ok(Self {
-            items: items
-                .into_iter()
-                .map(|e| {
-                    if let Expr::Path(p) = e {
-                        p.path
-                    } else {
-                        panic!("expected path");
-                    }
-                })
-                .collect(),
+            items: items.into_iter().map(|e| e.value()).collect()
         })
     }
 }
@@ -439,19 +438,15 @@ pub fn sw_init(input: TokenStream) -> TokenStream {
 
     let span = proc_macro::Span::call_site();
 
-    for (ec_idx, item) in items.into_iter().enumerate() {
-        let str_path = item
-            .segments
-            .iter()
-            .map(|x| x.ident.to_string())
-            .collect::<Vec<_>>()
-            .join("_");
+    for (ec_idx, struct_id) in items.into_iter().enumerate() {
+        // Unique identifier shared by sw_define! and sw_init! used for naming the extern funcs.
+        // Currently it's just the struct type name.
         let add_ne_extern_func =
-            syn::Ident::new(&format!("sw_add_ne_extern_func_{}", str_path), span.into());
+            syn::Ident::new(&format!("sw_add_ne_extern_func_{}", struct_id), span.into());
         let double_extern_func =
-            syn::Ident::new(&format!("sw_double_extern_func_{}", str_path), span.into());
+            syn::Ident::new(&format!("sw_double_extern_func_{}", struct_id), span.into());
         let setup_extern_func =
-            syn::Ident::new(&format!("sw_setup_extern_func_{}", str_path), span.into());
+            syn::Ident::new(&format!("sw_setup_extern_func_{}", struct_id), span.into());
 
         externs.push(quote::quote_spanned! { span.into() =>
             #[no_mangle]
@@ -481,41 +476,31 @@ pub fn sw_init(input: TokenStream) -> TokenStream {
             }
 
             #[no_mangle]
-            extern "C" fn #setup_extern_func() {
+            extern "C" fn #setup_extern_func(uninit: *mut core::ffi::c_void, p1: *const u8, p2: *const u8) {
                 #[cfg(target_os = "zkvm")]
                 {
-                    use super::#item;
-                    // p1 is (x1, y1), and x1 must be the modulus.
-                    // y1 can be anything for SetupEcAdd, but must equal `a` for SetupEcDouble
-                    let modulus_bytes = <<#item as openvm_ecc_guest::weierstrass::WeierstrassPoint>::Coordinate as openvm_algebra_guest::IntMod>::MODULUS;
-                    let mut one = [0u8; <<#item as openvm_ecc_guest::weierstrass::WeierstrassPoint>::Coordinate as openvm_algebra_guest::IntMod>::NUM_LIMBS];
-                    one[0] = 1;
-                    let curve_a_bytes = openvm_algebra_guest::IntMod::as_le_bytes(&<#item as openvm_ecc_guest::weierstrass::WeierstrassPoint>::CURVE_A);
-                    // p1 should be (p, a)
-                    let p1 = [modulus_bytes.as_ref(), curve_a_bytes.as_ref()].concat();
-                    // (EcAdd only) p2 is (x2, y2), and x1 - x2 has to be non-zero to avoid division over zero in add.
-                    let p2 = [one.as_ref(), one.as_ref()].concat();
-                    let mut uninit: core::mem::MaybeUninit<[#item; 2]> = core::mem::MaybeUninit::uninit();
                     openvm::platform::custom_insn_r!(
                         opcode = ::openvm_ecc_guest::OPCODE,
                         funct3 = ::openvm_ecc_guest::SW_FUNCT3 as usize,
                         funct7 = ::openvm_ecc_guest::SwBaseFunct7::SwSetup as usize
                             + #ec_idx
                                 * (::openvm_ecc_guest::SwBaseFunct7::SHORT_WEIERSTRASS_MAX_KINDS as usize),
-                        rd = In uninit.as_mut_ptr(),
-                        rs1 = In p1.as_ptr(),
-                        rs2 = In p2.as_ptr()
+                        rd = In uninit,
+                        rs1 = In p1,
+                        rs2 = In p2
                     );
                     openvm::platform::custom_insn_r!(
                         opcode = ::openvm_ecc_guest::OPCODE,
                         funct3 = ::openvm_ecc_guest::SW_FUNCT3 as usize,
                         funct7 = ::openvm_ecc_guest::SwBaseFunct7::SwSetup as usize
                             + #ec_idx
                                 * (::openvm_ecc_guest::SwBaseFunct7::SHORT_WEIERSTRASS_MAX_KINDS as usize),
-                        rd = In uninit.as_mut_ptr(),
-                        rs1 = In p1.as_ptr(),
+                        rd = In uninit,
+                        rs1 = In p1,
                         rs2 = Const "x0" // will be parsed as 0 and therefore transpiled to SETUP_EC_DOUBLE
                     );
+ 
+
                 }
             }
         });

extensions/ecc/tests/programs/examples/invalid_setup.rs

@@ -14,8 +14,8 @@ openvm_algebra_moduli_macros::moduli_init! {
 
 // the order of the curves here does not match the order in supported_curves
 openvm_ecc_sw_macros::sw_init! {
-    P256Point,
-    Secp256k1Point,
+    "P256Point",
+    "Secp256k1Point",
 }
 
 openvm::entry!(main);

extensions/ecc/tests/programs/openvm_init_decompress_k256.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", "115792089237316195423570985008687907853269984665640564039457584007913129639501", "1000000007", "26959946667150639794667015087019630673557916260026308143510066298881", "26959946667150639794667015087019625940457807714424391721682722368061" }
-openvm_ecc_guest::sw_macros::sw_init! { Secp256k1Point, CurvePoint5mod8, CurvePoint1mod4 }
+openvm_ecc_guest::sw_macros::sw_init! { "Secp256k1Point", "CurvePoint5mod8", "CurvePoint1mod4" }

extensions/ecc/tests/programs/openvm_init_ec_k256.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" }

extensions/ecc/tests/programs/openvm_init_ec_nonzero_a_p256.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! { "115792089210356248762697446949407573530086143415290314195533631308867097853951", "115792089210356248762697446949407573529996955224135760342422259061068512044369" }
-openvm_ecc_guest::sw_macros::sw_init! { P256Point }
+openvm_ecc_guest::sw_macros::sw_init! { "P256Point" }

extensions/ecc/tests/programs/openvm_init_ec_two_curves_k256_p256.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", "115792089210356248762697446949407573530086143415290314195533631308867097853951", "115792089210356248762697446949407573529996955224135760342422259061068512044369" }
-openvm_ecc_guest::sw_macros::sw_init! { Secp256k1Point, P256Point }
+openvm_ecc_guest::sw_macros::sw_init! { "Secp256k1Point", "P256Point" }

extensions/ecc/tests/programs/openvm_init_ecdsa_k256.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" }

guest-libs/k256/tests/programs/examples/add.rs

@@ -10,7 +10,7 @@ use openvm_k256::Secp256k1Point;
 mod test_vectors;
 use test_vectors::ADD_TEST_VECTORS;
 
-openvm::init!("openvm_init_simple.rs");
+openvm::init!("openvm_init_add.rs");
 
 openvm::entry!(main);
 

guest-libs/k256/tests/programs/examples/mul.rs

@@ -10,7 +10,7 @@ use openvm_k256::Secp256k1Point;
 mod test_vectors;
 use test_vectors::{ADD_TEST_VECTORS, MUL_TEST_VECTORS};
 
-openvm::init!("openvm_init_simple.rs");
+openvm::init!("openvm_init_mul.rs");
 
 openvm::entry!(main);