Support for more backends

ff-macros/src/montgomery/mod.rs

@@ -23,6 +23,7 @@ use sum_of_products::sum_of_products_impl;
 use crate::utils;
 
 pub fn mont_config_helper(
+    // The modulus p of the field
     modulus: BigUint,
     generator: BigUint,
     small_subgroup_base: Option<u32>,
@@ -38,12 +39,14 @@ pub fn mont_config_helper(
         }
     }
 
-    // modulus - 1 = 2^s * t
+    // Compute trace t and 2-adicity s such that p - 1 = 2^s * t
     let mut trace = &modulus - BigUint::from_str("1").unwrap();
     while !trace.bit(0) {
         trace >>= 1u8;
     }
 
+    let two_adicity = (&modulus - 1u8).trailing_zeros().expect("two_adicity should fit in u32") as u32;
+
     // Compute 2^s root of unity given the generator
     let remaining_subgroup_size = match (small_subgroup_base, small_subgroup_power) {
         (Some(base), Some(power)) => Some(&trace / BigUint::from(base).pow(power)),
@@ -54,9 +57,37 @@ pub fn mont_config_helper(
     let large_subgroup_generator = remaining_subgroup_size
         .as_ref()
         .map(|e| generator.modpow(e, &modulus).to_string());
+
+    // Compute R = 2**(64 * limbs) mod m
+    let r = (BigUint::one() << (limbs * 64)) % &modulus;
+    let r_squared = ((&r * &r) % &modulus).to_string();
+    let r = r.to_string();
+    let modulus_mod_4 = (&modulus % 4u64).try_into().unwrap();
+
+    let modulus_plus_one_div_four = ((&modulus + 1u8) / 4u8).to_u64_digits();
+    let trace_minus_one_div_two = ((&trace - 1u8) / 2u8).to_u64_digits();
+    let sqrt_precomp = match modulus_mod_4 {
+        3 => quote::quote!(Some(SqrtPrecomputation::Case3Mod4 {
+            modulus_plus_one_div_four: &[ #( #modulus_plus_one_div_four ),* ]
+        })),
+        1 => quote::quote!(Some(SqrtPrecomputation::TonelliShanks  {
+            two_adicity: Self::TWO_ADICITY,
+            quadratic_nonresidue_to_trace: Self::TWO_ADIC_ROOT_OF_UNITY,
+            trace_of_modulus_minus_one_div_two: &[ #( #trace_minus_one_div_two ),* ]
+        })),
+        _ => panic!("Modulus must be odd"),
+    };
+
+    let modulus_plus_one_div_four = if modulus_mod_4 == 3u8 {
+        quote::quote! { Some(BigInt([ #( #modulus_plus_one_div_four  ),* ])) }
+    } else {
+        quote::quote! { None }
+    };
+
     let modulus = modulus.to_string();
     let generator = generator.to_string();
     let two_adic_root_of_unity = two_adic_root_of_unity.to_string();
+
     let modulus_limbs = utils::str_to_limbs_u64(&modulus).1;
     let modulus_has_spare_bit = modulus_limbs.last().unwrap() >> 63 == 0;
     let can_use_no_carry_mul_opt = {
@@ -67,6 +98,14 @@ pub fn mont_config_helper(
             first_limb_check
         }
     };
+
+    let mut inv = 1u64;
+    for _ in 0..63 {
+        inv = inv.wrapping_mul(inv);
+        inv = inv.wrapping_mul(modulus_limbs[0]);
+    }
+    inv = inv.wrapping_neg();
+
     let modulus = quote::quote! { BigInt([ #( #modulus_limbs ),* ]) };
 
     let add_with_carry = add_with_carry_impl(limbs);
@@ -113,8 +152,32 @@ pub fn mont_config_helper(
 
                 const GENERATOR: F = ark_ff::MontFp!(#generator);
 
+                const TWO_ADICITY: u32 = #two_adicity;
+
                 const TWO_ADIC_ROOT_OF_UNITY: F = ark_ff::MontFp!(#two_adic_root_of_unity);
 
+                const R: B = ark_ff::BigInt!(#r);
+
+                const R2: B = ark_ff::BigInt!(#r_squared);
+
+                const INV: u64 = #inv;
+
+                #[doc(hidden)]
+                const CAN_USE_NO_CARRY_MUL_OPT: bool = #can_use_no_carry_mul_opt;
+
+                #[doc(hidden)]
+                const CAN_USE_NO_CARRY_SQUARE_OPT: bool = #can_use_no_carry_mul_opt;
+
+                #[doc(hidden)]
+                const MODULUS_HAS_SPARE_BIT: bool = #modulus_has_spare_bit;
+
+
+                /// (MODULUS + 1) / 4 when MODULUS % 4 == 3. Used for square root precomputations.
+                #[doc(hidden)]
+                const MODULUS_PLUS_ONE_DIV_FOUR: Option<B> = #modulus_plus_one_div_four; 
+
+                const SQRT_PRECOMP: Option<SqrtPrecomputation<F>> = #sqrt_precomp;
+
                 #mixed_radix
 
                 #[inline(always)]

ff/src/biginteger/mod.rs

@@ -9,7 +9,7 @@
 };
 use ark_std::{
     borrow::Borrow,
     convert::TryFrom,
     fmt::{Debug, Display, UpperHex},
     io::{Read, Write},
     ops::{
@@ -21,7 +21,7 @@
         Rng,
     },
     str::FromStr,
     vec::Vec,
 };
 use num_bigint::BigUint;
 use zeroize::Zeroize;
@@ -290,6 +290,44 @@
             crate::const_helpers::R2Buffer::<N>([0u64; N], [0u64; N], 1);
         const_modulo!(two_pow_n_times_64_square, self)
     }
+
+    /// Compute `-self^{-1}` mod 2^64.
+    pub const fn montgomery_inv(&self) -> u64 {
+        // We compute this as follows.
+        // First, MODULUS mod 2^64 is just the lower 64 bits of MODULUS.
+        // Hence MODULUS mod 2^64 = MODULUS.0[0] mod 2^64.
+        //
+        // Next, computing the inverse mod 2^64 involves exponentiating by
+        // the multiplicative group order, which is euler_totient(2^64) - 1.
+        // Now, euler_totient(2^64) = 1 << 63, and so
+        // euler_totient(2^64) - 1 = (1 << 63) - 1 = 1111111... (63 digits).
+        // We compute this powering via standard square and multiply.
+        let mut inv = 1u64;
+        crate::const_for!((_i in 0..63) {
+            // Square
+            inv = inv.wrapping_mul(inv);
+            // Multiply
+            inv = inv.wrapping_mul(self.0[0]);
+        });
+        inv.wrapping_neg()
+    }
+
+    pub const fn msb(&self) -> bool {
+        self.0[N - 1] >> 63 == 1
+    }
+
+    pub const fn plus_one_div_four(&self) -> Option<Self> {
+        if self.mod_4() == 3 {
+            let (modulus_plus_one, carry) = self.const_add_with_carry(&BigInt::<N>::one());
+            let mut result = modulus_plus_one.divide_by_2_round_down();
+            // Since modulus_plus_one is even, dividing by 2 results in a MSB of 0.
+            // Thus we can set MSB to `carry` to get the correct result of (MODULUS + 1) // 2:
+            result.0[N - 1] |= (carry as u64) << 63;
+            Some(result.divide_by_2_round_down())
+        } else {
+            None
+        }
+    }
 }
 
 impl<const N: usize> BigInteger for BigInt<N> {

ff/src/const_helpers.rs

@@ -4,6 +4,7 @@ use ark_std::ops::{Index, IndexMut};
 use crate::BigInt;
 
 /// A helper macro for emulating `for` loops in a `const` context.
+/// 
 /// # Usage
 /// ```rust
 /// # use ark_ff::const_for;

ff/src/fields/models/fp/mod.rs

@@ -7,7 +7,7 @@
     CanonicalSerializeWithFlags, Compress, EmptyFlags, Flags, SerializationError, Valid, Validate,
 };
 use ark_std::{
     cmp::{Ord, Ordering, PartialOrd},
     fmt::{Display, Formatter, Result as FmtResult},
     marker::PhantomData,
     ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Sub, SubAssign},
@@ -17,8 +17,8 @@
 use core::iter;
 
 #[macro_use]
-mod montgomery_backend;
-pub use montgomery_backend::*;
+mod montgomery;
+pub use montgomery::*;
 
 /// A trait that specifies the configuration of a prime field.
 /// Also specifies how to perform arithmetic on field elements.