use rand::{thread_rng, Rng};
use twenty_first::shared_math::b_field_element::BFieldElement;
use crate::{
get_init_tvm_stack,
snippet::{DataType, Snippet},
ExecutionState,
};
#[derive(Clone, Debug)]
pub struct SafeMul;
impl Snippet for SafeMul {
fn entrypoint(&self) -> String {
"tasm_arithmetic_u32_u32_safe_mul".to_string()
}
fn inputs(&self) -> Vec<String> {
vec!["lhs".to_string(), "rhs".to_string()]
}
fn input_types(&self) -> Vec<DataType> {
vec![DataType::U32, DataType::U32]
}
fn output_types(&self) -> Vec<DataType> {
vec![DataType::U32]
}
fn outputs(&self) -> Vec<String> {
vec!["lhs * rhs".to_string()]
}
fn stack_diff(&self) -> isize {
-1
}
fn function_code(&self, _library: &mut crate::snippet_state::SnippetState) -> String {
let entrypoint = self.entrypoint();
format!(
"
// BEFORE: _ rhs lhs
// AFTER: _ (lhs * rhs)
{entrypoint}:
mul
dup 0 // _ (lhs * rhs) (lhs * rhs)
split // _ (lhs * rhs) hi lo
pop // _ (lhs * rhs) hi
push 0 // _ (lhs * rhs) hi 0
eq // _ (lhs * rhs) (hi == 0)
assert // _ (lhs * rhs)
return
"
)
}
fn crash_conditions(&self) -> Vec<String> {
vec!["result overflows u32".to_string()]
}
fn gen_input_states(&self) -> Vec<ExecutionState> {
let mut ret: Vec<ExecutionState> = vec![];
for _ in 0..10 {
let mut stack = get_init_tvm_stack();
let lhs = thread_rng().gen_range(0..(1 << 16));
let rhs = thread_rng().gen_range(0..(1 << 16));
let lhs = BFieldElement::new(lhs as u64);
let rhs = BFieldElement::new(rhs as u64);
stack.push(lhs);
stack.push(rhs);
ret.push(ExecutionState::with_stack(stack));
}
ret
}
fn rust_shadowing(
&self,
stack: &mut Vec<BFieldElement>,
_std_in: Vec<BFieldElement>,
_secret_in: Vec<BFieldElement>,
_memory: &mut std::collections::HashMap<BFieldElement, BFieldElement>,
) {
let lhs: u32 = stack.pop().unwrap().try_into().unwrap();
let rhs: u32 = stack.pop().unwrap().try_into().unwrap();
let prod = lhs * rhs;
stack.push(BFieldElement::new(prod as u64));
}
fn common_case_input_state(&self) -> ExecutionState {
ExecutionState::with_stack(
vec![
get_init_tvm_stack(),
vec![BFieldElement::new(1 << 8), BFieldElement::new(1 << 9)],
]
.concat(),
)
}
fn worst_case_input_state(&self) -> ExecutionState {
ExecutionState::with_stack(
vec![
get_init_tvm_stack(),
vec![
BFieldElement::new((1 << 15) - 1),
BFieldElement::new((1 << 16) - 1),
],
]
.concat(),
)
}
}
#[cfg(test)]
mod tests {
use std::collections::HashMap;
use num::Zero;
use crate::test_helpers::{
test_rust_equivalence_given_input_values, test_rust_equivalence_multiple,
};
use super::*;
#[test]
fn snippet_test() {
test_rust_equivalence_multiple(&SafeMul, true);
}
#[test]
fn safe_sub_simple_test() {
prop_safe_mul(1000, 1, Some(1000));
prop_safe_mul(10_000, 900, Some(9_000_000));
prop_safe_mul(1, 1, Some(1));
prop_safe_mul(10_000, 10_000, Some(100_000_000));
prop_safe_mul(u32::MAX, 1, Some(u32::MAX));
prop_safe_mul(1, u32::MAX, Some(u32::MAX));
}
#[should_panic]
#[test]
fn overflow_test() {
prop_safe_mul(1 << 16, 1 << 16, None);
}
#[should_panic]
#[test]
fn overflow_test_2() {
prop_safe_mul(1 << 31, 2, None);
}
#[should_panic]
#[test]
fn overflow_test_3() {
prop_safe_mul(2, 1 << 31, None);
}
fn prop_safe_mul(lhs: u32, rhs: u32, _expected: Option<u32>) {
let mut init_stack = get_init_tvm_stack();
init_stack.push(BFieldElement::new(rhs as u64));
init_stack.push(BFieldElement::new(lhs as u64));
let expected = lhs.checked_mul(rhs);
let expected = vec![
get_init_tvm_stack(),
vec![expected
.map(|x| BFieldElement::new(x as u64))
.unwrap_or_else(BFieldElement::zero)],
]
.concat();
test_rust_equivalence_given_input_values(
&SafeMul,
&init_stack,
&[],
&[],
&mut HashMap::default(),
0,
Some(&expected),
);
}
}
#[cfg(test)]
mod benches {
use super::*;
use crate::snippet_bencher::bench_and_write;
#[test]
fn safe_mul_benchmark() {
bench_and_write(SafeMul);
}
}