tasm_lib/arithmetic/u128/
shift_left.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
use std::collections::HashMap;

use triton_vm::prelude::*;

use crate::arithmetic::u128::shift_right::ShiftRight;
use crate::prelude::*;
use crate::traits::basic_snippet::Reviewer;
use crate::traits::basic_snippet::SignOffFingerprint;

/// [Shift left][shl] for unsigned 128-bit integers.
///
/// # Behavior
///
/// ```text
/// BEFORE: _ [arg: u128] shift_amount
/// AFTER:  _ [result: u128]
/// ```
///
/// # Preconditions
///
/// - input argument `arg` is properly [`BFieldCodec`] encoded
/// - input argument `shift_amount` is in `0..128`
///
/// # Postconditions
///
/// - the output is the input argument `arg` bit-shifted to the left by
///   input argument `shift_amount`
/// - the output is properly [`BFieldCodec`] encoded
///
/// [shl]: core::ops::Shl
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Hash)]
pub struct ShiftLeft;

impl ShiftLeft {
    pub const SHIFT_AMOUNT_TOO_BIG_ERROR_ID: i128 = 530;
}

impl BasicSnippet for ShiftLeft {
    fn inputs(&self) -> Vec<(DataType, String)> {
        ShiftRight.inputs()
    }

    fn outputs(&self) -> Vec<(DataType, String)> {
        ShiftRight.outputs()
    }

    fn entrypoint(&self) -> String {
        "tasmlib_arithmetic_u128_shift_left".to_string()
    }

    fn code(&self, _: &mut Library) -> Vec<LabelledInstruction> {
        let entrypoint = self.entrypoint();
        let shift_amount_gt_32 = format!("{entrypoint}_shift_amount_gt_32");

        triton_asm!(
            // BEFORE: _ v_3 v_2 v_1 v_0 s
            // AFTER:  _ (value << s)_3 (value << s)_2 (value << s)_1 (value << s)_0
            {entrypoint}:
                /* bounds check */
                push 128
                dup 1
                lt
                assert error_id {Self::SHIFT_AMOUNT_TOO_BIG_ERROR_ID}
                            // _ v_3 v_2 v_1 v_0 s

                /* special case if shift amount is greater than 32 */
                dup 0
                push 32
                lt
                skiz
                    call {shift_amount_gt_32}
                            // _ v_3 v_2 v_1 v_0 s

                push 2
                pow         // _ v_3 v_2 v_1 v_0 (2^s)

                dup 0
                pick 5      // _ v_2 v_1 v_0 (2^s) (2^s) v_3
                mul
                place 4     // _ v_3<<s v_2 v_1 v_0 (2^s)
                xb_mul      // _ v_3<<s v_2<<s v_1<<s v_0<<s

                pick 3
                split
                pick 4
                split
                pick 5
                split
                pick 6
                split       // _ v_3s_hi v_3s_lo v_2s_hi v_2s_lo v_1s_hi v_1s_lo v_0s_hi v_0s_lo
                            // _ ╰─ 🗑 ╯ ╰──── w_3 ────╯ ╰──── w_2 ────╯ ╰──── w_1 ────╯ ╰ w_0 ╯
                place 7
                add
                place 6
                add
                place 5
                add
                place 4
                pop 1

                return

            // BEFORE: _ [v: u128] s
            // AFTER:  _ [v << i·32: u128] (s - i·32)
            // such that i·32 <= s < (i+1)·32
            {shift_amount_gt_32}:
                addi -32    // _ v_3 v_2 v_1 v_0 (s - 32)
                pick 4
                pop 1       // _ v_2 v_1 v_0 (s - 32)
                push 0
                place 1     // _ v_2 v_1 v_0 0 (s - 32)

                dup 0
                push 32
                lt
                skiz
                    recurse
                return
        )
    }

    fn sign_offs(&self) -> HashMap<Reviewer, SignOffFingerprint> {
        let mut sign_offs = HashMap::new();
        sign_offs.insert(Reviewer("ferdinand"), 0x4898e915d48c39b7.into());
        sign_offs
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_prelude::*;
    use rand::rngs::StdRng;

    impl Closure for ShiftLeft {
        type Args = <ShiftRight as Closure>::Args;

        fn rust_shadow(&self, stack: &mut Vec<BFieldElement>) {
            let (arg, shift_amount) = pop_encodable::<Self::Args>(stack);
            assert!(shift_amount < 128);
            push_encodable(stack, &(arg << shift_amount));
        }

        fn pseudorandom_args(
            &self,
            seed: [u8; 32],
            bench_case: Option<BenchmarkCase>,
        ) -> Self::Args {
            let mut rng = StdRng::from_seed(seed);

            match bench_case {
                Some(BenchmarkCase::CommonCase) => (0x1282, 15),
                Some(BenchmarkCase::WorstCase) => (0x123456789abcdef, 125),
                None => (rng.random(), rng.random_range(0..128)),
            }
        }

        fn corner_case_args(&self) -> Vec<Self::Args> {
            ShiftRight.corner_case_args()
        }
    }

    #[test]
    fn rust_shadow() {
        ShadowedClosure::new(ShiftLeft).test();
    }

    #[proptest]
    fn too_large_shift_crashes_vm(arg: u128, #[strategy(128_u32..)] shift_amount: u32) {
        test_assertion_failure(
            &ShadowedClosure::new(ShiftLeft),
            InitVmState::with_stack(ShiftLeft.set_up_test_stack((arg, shift_amount))),
            &[ShiftLeft::SHIFT_AMOUNT_TOO_BIG_ERROR_ID],
        )
    }
}

#[cfg(test)]
mod benches {
    use super::*;
    use crate::test_prelude::*;

    #[test]
    fn benchmark() {
        ShadowedClosure::new(ShiftLeft).bench();
    }
}