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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
use rand::{random, thread_rng, Rng};
use std::collections::HashMap;
use twenty_first::shared_math::b_field_element::BFieldElement;
use twenty_first::shared_math::other::random_elements;

use crate::rust_shadowing_helper_functions::safe_list::{safe_insert_random_list, safe_list_set};
use crate::snippet::{DataType, Snippet};
use crate::snippet_state::SnippetState;
use crate::{get_init_tvm_stack, ExecutionState};

#[derive(Clone, Debug)]
pub struct SafeSet(pub DataType);

impl Snippet for SafeSet {
    fn inputs(&self) -> Vec<String> {
        // See: https://github.com/TritonVM/tasm-snippets/issues/13
        // _ elem{{N - 1}}, elem{{N - 2}}, ..., elem{{0}} *list index
        vec![
            vec!["element".to_string(); self.0.get_size()],
            vec!["*list".to_string(), "index".to_string()],
        ]
        .concat()
    }

    fn outputs(&self) -> Vec<String> {
        vec![]
    }

    fn input_types(&self) -> Vec<crate::snippet::DataType> {
        vec![
            self.0.clone(),
            DataType::List(Box::new(self.0.clone())),
            DataType::U32,
        ]
    }

    fn output_types(&self) -> Vec<crate::snippet::DataType> {
        vec![]
    }

    fn crash_conditions(&self) -> Vec<String> {
        vec![]
    }

    fn gen_input_states(&self) -> Vec<ExecutionState> {
        let capacity = 100u32;
        vec![
            prepare_state(
                &self.0,
                capacity,
                thread_rng().gen_range(1..capacity) as usize,
            ),
            prepare_state(
                &self.0,
                capacity,
                thread_rng().gen_range(1..capacity) as usize,
            ),
            prepare_state(
                &self.0,
                capacity,
                thread_rng().gen_range(1..capacity) as usize,
            ),
        ]
    }

    fn stack_diff(&self) -> isize {
        -2 - self.0.get_size() as isize
    }

    fn entrypoint(&self) -> String {
        format!(
            "tasm_list_safe_u32_set_element_{}",
            self.0.label_friendly_name()
        )
    }

    fn function_code(&self, _library: &mut SnippetState) -> String {
        let entrypoint = self.entrypoint();
        let element_size = self.0.get_size();

        let mut write_elements_to_memory_code = String::default();
        for i in 0..element_size {
            write_elements_to_memory_code.push_str("swap 1\n");
            write_elements_to_memory_code.push_str("write_mem\n");
            if i != element_size - 1 {
                // Prepare for next write. Not needed for last iteration.
                write_elements_to_memory_code.push_str("push 1\n");
                write_elements_to_memory_code.push_str("add\n");
            }
        }

        // Code to multiply with size. If size is 1, do nothing to save two clock cycles.
        let mul_with_size = if element_size != 1 {
            format!("push {element_size}\n mul\n")
        } else {
            String::default()
        };

        format!(
            "
                // BEFORE: _ elem{{N - 1}}, elem{{N - 2}}, ..., elem{{0}} *list index
                // AFTER: _
                {entrypoint}:
                    // Verify that index is less than length
                    swap 1
                    read_mem
                    // _ elem{{N - 1}}, elem{{N - 2}}, ..., elem{{0}} index *list length

                    dup 2 lt
                    // _ elem{{N - 1}}, elem{{N - 2}}, ..., elem{{0}} index *list length < index

                    assert
                    // _ elem{{N - 1}}, elem{{N - 2}}, ..., elem{{0}} index *list

                    swap 1
                    // _ elem{{N - 1}}, elem{{N - 2}}, ..., elem{{0}} *list index

                    {mul_with_size}
                    push 2
                    add
                    add

                    // stack: _ elem{{N - 1}}, elem{{N - 2}}, ..., elem{{0}} *list + offset

                    {write_elements_to_memory_code}
                    // stack: _ *list + offset
                    pop

                    return
                    "
        )
    }

    fn rust_shadowing(
        &self,
        stack: &mut Vec<BFieldElement>,
        _std_in: Vec<BFieldElement>,
        _secret_in: Vec<BFieldElement>,
        memory: &mut HashMap<BFieldElement, BFieldElement>,
    ) {
        let index: u32 = stack.pop().unwrap().try_into().unwrap();
        let list_pointer = stack.pop().unwrap();
        let list_length: u32 = memory[&list_pointer].value().try_into().unwrap();
        assert!(index < list_length, "Index must be within list bounds");

        let mut element: Vec<BFieldElement> = vec![BFieldElement::new(0); self.0.get_size()];
        for ee in element.iter_mut() {
            *ee = stack.pop().unwrap();
        }

        safe_list_set(
            list_pointer,
            index as usize,
            element,
            memory,
            self.0.get_size(),
        );
    }

    fn common_case_input_state(&self) -> ExecutionState {
        prepare_state(&self.0, 1000, 1 << 5)
    }

    fn worst_case_input_state(&self) -> ExecutionState {
        prepare_state(&self.0, 1000, 1 << 6)
    }
}

fn prepare_state(data_type: &DataType, capacity: u32, list_length: usize) -> ExecutionState {
    let index: usize = thread_rng().gen_range(0..list_length);
    let mut stack = get_init_tvm_stack();
    let mut push_value: Vec<BFieldElement> = random_elements(data_type.get_size());
    while let Some(element) = push_value.pop() {
        stack.push(element);
    }

    let list_pointer: u32 = random();
    let list_pointer_bfe = BFieldElement::new(list_pointer as u64);
    stack.push(list_pointer_bfe);
    stack.push(BFieldElement::new(index as u64));

    let mut memory = HashMap::default();
    safe_insert_random_list(
        data_type,
        list_pointer_bfe,
        capacity,
        list_length,
        &mut memory,
    );
    ExecutionState::with_stack_and_memory(stack, memory, 0)
}

#[cfg(test)]
mod tests {
    use twenty_first::shared_math::b_field_element::BFieldElement;

    use crate::get_init_tvm_stack;

    use crate::test_helpers::{
        test_rust_equivalence_given_input_values, test_rust_equivalence_multiple,
    };

    use super::*;

    #[test]
    fn new_snippet_test() {
        for _ in 0..6 {
            test_rust_equivalence_multiple(&SafeSet(DataType::Bool), true);
            test_rust_equivalence_multiple(&SafeSet(DataType::BFE), true);
            test_rust_equivalence_multiple(&SafeSet(DataType::U32), true);
            test_rust_equivalence_multiple(&SafeSet(DataType::U64), true);
            test_rust_equivalence_multiple(&SafeSet(DataType::XFE), true);
            test_rust_equivalence_multiple(&SafeSet(DataType::Digest), true);
        }
    }

    #[test]
    fn list_u32_n_is_one_set() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![BFieldElement::new(1337)];
        let index = 2;
        prop_set(DataType::BFE, list_address, 20, insert_value, index, 21);
    }

    #[test]
    fn list_u32_n_is_one_set_at_edge_a() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![BFieldElement::new(1337)];
        let index = 19;
        prop_set(DataType::BFE, list_address, 20, insert_value, index, 21);
    }

    #[test]
    fn list_u32_n_is_one_set_at_edge_b() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![BFieldElement::new(1337)];
        let index = 19;
        prop_set(DataType::BFE, list_address, 20, insert_value, index, 21);
    }

    #[should_panic]
    #[test]
    fn list_u32_n_is_one_set_out_of_bounds_a() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![BFieldElement::new(1337)];
        let index = 20;
        prop_set(DataType::BFE, list_address, 20, insert_value, index, 21);
    }

    #[should_panic]
    #[test]
    fn list_u32_n_is_one_set_out_of_bounds_b() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![BFieldElement::new(1337)];
        let index = 21;
        prop_set(DataType::BFE, list_address, 20, insert_value, index, 21);
    }

    #[test]
    fn list_u32_n_is_three_set() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![
            BFieldElement::new(1337),
            BFieldElement::new(1337),
            BFieldElement::new(1337),
        ];
        let index = 2;
        prop_set(DataType::XFE, list_address, 20, insert_value, index, 20);
    }

    #[test]
    fn list_u32_n_is_two_set() {
        let list_address = BFieldElement::new(1841);
        let push_value = vec![BFieldElement::new(133700), BFieldElement::new(32)];
        let index = 0;
        prop_set(DataType::U64, list_address, 20, push_value, index, 20);
    }

    #[should_panic]
    #[test]
    fn list_u32_n_is_two_set_out_of_bounds_a() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![BFieldElement::new(1337)];
        let index = 20;
        prop_set(DataType::U64, list_address, 20, insert_value, index, 21);
    }

    #[test]
    fn list_u32_n_is_five_set() {
        let list_address = BFieldElement::new(558);
        let push_value = vec![
            BFieldElement::new(133700),
            BFieldElement::new(32),
            BFieldElement::new(133700),
            BFieldElement::new(19990),
            BFieldElement::new(88888888),
        ];
        prop_set(DataType::Digest, list_address, 233, push_value, 58, 3000);
    }

    #[should_panic]
    #[test]
    fn list_u32_n_is_five_set_out_of_bounds_a() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![BFieldElement::new(1337)];
        let index = 20;
        prop_set(DataType::U64, list_address, 20, insert_value, index, 21);
    }

    #[should_panic]
    #[test]
    fn list_u32_n_is_five_set_out_of_bounds_b() {
        let list_address = BFieldElement::new(48);
        let insert_value = vec![BFieldElement::new(1337)];
        let index = 21;
        prop_set(DataType::U64, list_address, 20, insert_value, index, 22);
    }

    fn prop_set(
        data_type: DataType,
        list_address: BFieldElement,
        init_list_length: u32,
        push_value: Vec<BFieldElement>,
        index: u32,
        capacity: u32,
    ) {
        let expected_end_stack = vec![get_init_tvm_stack()].concat();
        let mut init_stack = get_init_tvm_stack();

        for i in 0..data_type.get_size() {
            init_stack.push(push_value[data_type.get_size() - 1 - i]);
        }
        init_stack.push(list_address);
        init_stack.push(BFieldElement::new(index as u64));

        let mut vm_memory = HashMap::default();

        // Insert length indicator of list, lives on offset = 0 from `list_address`
        safe_insert_random_list(
            &data_type,
            list_address,
            capacity,
            init_list_length as usize,
            &mut vm_memory,
        );

        test_rust_equivalence_given_input_values::<SafeSet>(
            &SafeSet(data_type.clone()),
            &init_stack,
            &[],
            &[],
            &mut vm_memory,
            0,
            Some(&expected_end_stack),
        );

        // Verify that length indicator is unchanged
        assert_eq!(
            BFieldElement::new((init_list_length) as u64),
            vm_memory[&list_address]
        );

        // verify that value was inserted at expected place
        for i in 0..data_type.get_size() {
            assert_eq!(
                push_value[i],
                vm_memory[&BFieldElement::new(
                    list_address.value()
                        + 2
                        + data_type.get_size() as u64 * index as u64
                        + i as u64
                )]
            );
        }
    }
}

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

    #[test]
    fn safe_set_benchmark() {
        bench_and_write(SafeSet(DataType::Digest));
    }
}