-
Notifications
You must be signed in to change notification settings - Fork 124
/
cairo_run.rs
303 lines (263 loc) · 10.9 KB
/
cairo_run.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
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
use crate::{
hint_processor::hint_processor_definition::HintProcessor,
types::program::Program,
vm::{
errors::{cairo_run_errors::CairoRunError, vm_exception::VmException},
runners::cairo_runner::CairoRunner,
security::verify_secure_runner,
vm_core::VirtualMachine,
},
};
use bincode::enc::write::Writer;
use felt::Felt252;
#[cfg(feature = "std")]
use thiserror::Error;
#[cfg(not(feature = "std"))]
use thiserror_no_std::Error;
pub struct CairoRunConfig<'a> {
pub entrypoint: &'a str,
pub trace_enabled: bool,
pub relocate_mem: bool,
pub layout: &'a str,
pub proof_mode: bool,
pub secure_run: Option<bool>,
}
impl<'a> Default for CairoRunConfig<'a> {
fn default() -> Self {
CairoRunConfig {
entrypoint: "main",
trace_enabled: false,
relocate_mem: false,
layout: "plain",
proof_mode: false,
secure_run: None,
}
}
}
pub fn cairo_run(
program_content: &[u8],
cairo_run_config: &CairoRunConfig,
hint_executor: &mut dyn HintProcessor,
) -> Result<(CairoRunner, VirtualMachine), CairoRunError> {
let program = Program::from_bytes(program_content, Some(cairo_run_config.entrypoint))?;
let secure_run = cairo_run_config
.secure_run
.unwrap_or(!cairo_run_config.proof_mode);
let mut cairo_runner = CairoRunner::new(
&program,
cairo_run_config.layout,
cairo_run_config.proof_mode,
)?;
let mut vm = VirtualMachine::new(cairo_run_config.trace_enabled);
let end = cairo_runner.initialize(&mut vm)?;
// check step calculation
cairo_runner
.run_until_pc(end, &mut vm, hint_executor)
.map_err(|err| VmException::from_vm_error(&cairo_runner, &vm, err))?;
cairo_runner.end_run(false, false, &mut vm, hint_executor)?;
vm.verify_auto_deductions()?;
cairo_runner.read_return_values(&mut vm)?;
if cairo_run_config.proof_mode {
cairo_runner.finalize_segments(&mut vm)?;
}
if secure_run {
verify_secure_runner(&cairo_runner, true, None, &mut vm)?;
}
cairo_runner.relocate(&mut vm, cairo_run_config.relocate_mem)?;
Ok((cairo_runner, vm))
}
#[derive(Debug, Error)]
#[error("Failed to encode trace at position {0}, serialize error: {1}")]
pub struct EncodeTraceError(usize, bincode::error::EncodeError);
/// Writes the trace binary representation.
///
/// Bincode encodes to little endian by default and each trace entry is composed of
/// 3 usize values that are padded to always reach 64 bit size.
pub fn write_encoded_trace(
relocated_trace: &[crate::vm::trace::trace_entry::TraceEntry],
dest: &mut impl Writer,
) -> Result<(), EncodeTraceError> {
for (i, entry) in relocated_trace.iter().enumerate() {
dest.write(&((entry.ap as u64).to_le_bytes()))
.map_err(|e| EncodeTraceError(i, e))?;
dest.write(&((entry.fp as u64).to_le_bytes()))
.map_err(|e| EncodeTraceError(i, e))?;
dest.write(&((entry.pc as u64).to_le_bytes()))
.map_err(|e| EncodeTraceError(i, e))?;
}
Ok(())
}
/// Writes a binary representation of the relocated memory.
///
/// The memory pairs (address, value) are encoded and concatenated:
/// * address -> 8-byte encoded
/// * value -> 32-byte encoded
pub fn write_encoded_memory(
relocated_memory: &[Option<Felt252>],
dest: &mut impl Writer,
) -> Result<(), EncodeTraceError> {
for (i, memory_cell) in relocated_memory.iter().enumerate() {
match memory_cell {
None => continue,
Some(unwrapped_memory_cell) => {
dest.write(&(i as u64).to_le_bytes())
.map_err(|e| EncodeTraceError(i, e))?;
dest.write(&unwrapped_memory_cell.to_le_bytes())
.map_err(|e| EncodeTraceError(i, e))?;
}
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use crate::stdlib::prelude::*;
use crate::{
hint_processor::{
builtin_hint_processor::builtin_hint_processor_definition::BuiltinHintProcessor,
hint_processor_definition::HintProcessor,
},
utils::test_utils::*,
};
use bincode::enc::write::SliceWriter;
use felt::Felt252;
#[cfg(target_arch = "wasm32")]
use wasm_bindgen_test::*;
fn run_test_program(
program_content: &[u8],
hint_processor: &mut dyn HintProcessor,
) -> Result<(CairoRunner, VirtualMachine), CairoRunError> {
let program = Program::from_bytes(program_content, Some("main")).unwrap();
let mut cairo_runner = cairo_runner!(program);
let mut vm = vm!(true);
let end = cairo_runner
.initialize(&mut vm)
.map_err(CairoRunError::Runner)?;
assert!(cairo_runner
.run_until_pc(end, &mut vm, hint_processor)
.is_ok());
Ok((cairo_runner, vm))
}
#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn cairo_run_custom_entry_point() {
let program = Program::from_bytes(
include_bytes!("../../cairo_programs/not_main.json"),
Some("not_main"),
)
.unwrap();
let mut vm = vm!();
let mut hint_processor = BuiltinHintProcessor::new_empty();
let mut cairo_runner = cairo_runner!(program);
let end = cairo_runner.initialize(&mut vm).unwrap();
assert!(cairo_runner
.run_until_pc(end, &mut vm, &mut hint_processor)
.is_ok());
assert!(cairo_runner.relocate(&mut vm, true).is_ok());
// `main` returns without doing nothing, but `not_main` sets `[ap]` to `1`
// Memory location was found empirically and simply hardcoded
assert_eq!(cairo_runner.relocated_memory[2], Some(Felt252::new(123)));
}
#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn cairo_run_with_no_data_program() {
// a compiled program with no `data` key.
// it should fail when the program is loaded.
let mut hint_processor = BuiltinHintProcessor::new_empty();
let no_data_program_path =
include_bytes!("../../cairo_programs/manually_compiled/no_data_program.json");
let cairo_run_config = CairoRunConfig::default();
assert!(cairo_run(no_data_program_path, &cairo_run_config, &mut hint_processor,).is_err());
}
#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn cairo_run_with_no_main_program() {
// a compiled program with no main scope
// it should fail when trying to run initialize_main_entrypoint.
let mut hint_processor = BuiltinHintProcessor::new_empty();
let no_main_program =
include_bytes!("../../cairo_programs/manually_compiled/no_main_program.json");
let cairo_run_config = CairoRunConfig::default();
assert!(cairo_run(no_main_program, &cairo_run_config, &mut hint_processor,).is_err());
}
#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn cairo_run_with_invalid_memory() {
// the program invalid_memory.json has an invalid memory cell and errors when trying to
// decode the instruction.
let mut hint_processor = BuiltinHintProcessor::new_empty();
let invalid_memory =
include_bytes!("../../cairo_programs/manually_compiled/invalid_memory.json");
let cairo_run_config = CairoRunConfig::default();
assert!(cairo_run(invalid_memory, &cairo_run_config, &mut hint_processor,).is_err());
}
#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn write_output_program() {
let program_content = include_bytes!("../../cairo_programs/bitwise_output.json");
let mut hint_processor = BuiltinHintProcessor::new_empty();
let (_, mut vm) = run_test_program(program_content, &mut hint_processor)
.expect("Couldn't initialize cairo runner");
let mut output_buffer = String::new();
vm.write_output(&mut output_buffer).unwrap();
assert_eq!(&output_buffer, "0\n");
}
#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn write_binary_trace_file() {
let program_content = include_bytes!("../../cairo_programs/struct.json");
let expected_encoded_trace =
include_bytes!("../../cairo_programs/trace_memory/cairo_trace_struct");
// run test program until the end
let mut hint_processor = BuiltinHintProcessor::new_empty();
let cairo_runner_result = run_test_program(program_content, &mut hint_processor);
let (mut cairo_runner, mut vm) = cairo_runner_result.unwrap();
// relocate memory so we can dump it to file
assert!(cairo_runner.relocate(&mut vm, false).is_ok());
let trace_entries = vm.get_relocated_trace().unwrap();
let mut buffer = [0; 24];
let mut buff_writer = SliceWriter::new(&mut buffer);
// write cairo_rs vm trace file
write_encoded_trace(trace_entries, &mut buff_writer).unwrap();
// compare that the original cairo vm trace file and cairo_rs vm trace files are equal
assert_eq!(buffer, *expected_encoded_trace);
}
#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn write_binary_memory_file() {
let program_content = include_bytes!("../../cairo_programs/struct.json");
let expected_encoded_memory =
include_bytes!("../../cairo_programs/trace_memory/cairo_memory_struct");
// run test program until the end
let mut hint_processor = BuiltinHintProcessor::new_empty();
let cairo_runner_result = run_test_program(program_content, &mut hint_processor);
let (mut cairo_runner, mut vm) = cairo_runner_result.unwrap();
// relocate memory so we can dump it to file
assert!(cairo_runner.relocate(&mut vm, true).is_ok());
let mut buffer = [0; 120];
let mut buff_writer = SliceWriter::new(&mut buffer);
// write cairo_rs vm memory file
write_encoded_memory(&cairo_runner.relocated_memory, &mut buff_writer).unwrap();
// compare that the original cairo vm memory file and cairo_rs vm memory files are equal
assert_eq!(*expected_encoded_memory, buffer);
}
#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn run_with_no_trace() {
let program = Program::from_bytes(
include_bytes!("../../cairo_programs/struct.json"),
Some("main"),
)
.unwrap();
let mut hint_processor = BuiltinHintProcessor::new_empty();
let mut cairo_runner = cairo_runner!(program);
let mut vm = vm!();
let end = cairo_runner.initialize(&mut vm).unwrap();
assert!(cairo_runner
.run_until_pc(end, &mut vm, &mut hint_processor)
.is_ok());
assert!(cairo_runner.relocate(&mut vm, false).is_ok());
assert!(vm.get_relocated_trace().is_err());
}
}