Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use hint_location upon hint failure #195

Merged
merged 3 commits into from
Jan 3, 2023
Merged

Use hint_location upon hint failure #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7aa198c
Update toml + fix test + fix PyLocation::to_string_with_contents()
fmoletta Dec 29, 2022
1a3fc35
Add hint_location logic to as_vm_exception
fmoletta Jan 2, 2023
d99b832
Merge branch 'main' into hint-location
fmoletta Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = "2021"

[dependencies]
pyo3 = { version = "0.16.5", features = ["num-bigint"] }
cairo-rs = { git = "https://github.com/lambdaclass/cairo-rs.git", rev = "7b02b272d6c2b19dbd271d070eb25a072423c403" }
cairo-rs = { git = "https://github.com/lambdaclass/cairo-rs.git", rev = "8e3541768cf8a01b4b8e50e427cef19cae56c9e2" }
num-bigint = "0.4"
lazy_static = "1.4.0"

Expand Down
4 changes: 2 additions & 2 deletions src/cairo_runner.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -635,8 +635,8 @@ pyo3::import_exception!(starkware.cairo.lang.vm.vm_exceptions, VmException);
impl PyCairoRunner {
fn as_vm_exception(&self, error: PyErr) -> PyErr {
let pc = self.pyvm.vm.borrow().get_pc().offset;
let instruction_location =
get_location(pc, &self.inner, None).map(InstructionLocation::from);
let instruction_location = get_location(pc, &self.inner, self.pyvm.failed_hint_index)
.map(InstructionLocation::from);
let error_attribute = get_error_attr_value(pc, &self.inner);
let traceback = get_traceback(&self.pyvm.vm.borrow(), &self.inner);
VmException::new_err((
Expand Down
2 changes: 1 addition & 1 deletion src/instruction_location.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ impl PyLocation {
}
pub fn to_string_with_content(&self, message: String) -> String {
let loc = Into::<Location>::into(self.clone());
loc.to_string(&message)
loc.to_string_with_content(&message)
}
}

Expand Down
67 changes: 36 additions & 31 deletions src/vm_core.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ const GLOBAL_NAMES: [&str; 18] = [
#[pyclass(unsendable)]
pub struct PyVM {
pub(crate) vm: Rc<RefCell<VirtualMachine>>,
pub(crate) failed_hint_index: Option<usize>,
}

#[pymethods]
Expand All @@ -74,6 +75,7 @@ impl PyVM {
trace_enabled,
error_message_attributes,
))),
failed_hint_index: None,
}
}

Expand All @@ -82,7 +84,7 @@ impl PyVM {
}

pub(crate) fn execute_hint(
&self,
&mut self,
hint_data: &HintProcessorData,
hint_locals: &mut HashMap<String, PyObject>,
exec_scopes: &mut ExecutionScopes,
Expand Down Expand Up @@ -164,7 +166,7 @@ impl PyVM {

#[allow(clippy::too_many_arguments)]
pub(crate) fn step_hint(
&self,
&mut self,
hint_executor: &mut dyn HintProcessor,
hint_locals: &mut HashMap<String, PyObject>,
exec_scopes: &mut ExecutionScopes,
Expand All @@ -176,7 +178,7 @@ impl PyVM {
let pc_offset = (*self.vm).borrow().get_pc().offset;

if let Some(hint_list) = hint_data_dictionary.get(&pc_offset) {
for hint_data in hint_list.iter() {
for (hint_index, hint_data) in hint_list.iter().enumerate() {
if self
.should_run_py_hint(hint_executor, exec_scopes, hint_data, constants)
.map_err(to_py_error)?
Expand All @@ -186,14 +188,17 @@ impl PyVM {
.ok_or(VirtualMachineError::WrongHintData)
.map_err(to_py_error)?;

self.execute_hint(
if let Err(hint_error) = self.execute_hint(
hint_data,
hint_locals,
exec_scopes,
constants,
Rc::clone(&struct_types),
static_locals,
)?;
) {
self.failed_hint_index = Some(hint_index);
return Err(hint_error);
}
}
}
}
Expand All @@ -203,7 +208,7 @@ impl PyVM {

#[allow(clippy::too_many_arguments)]
pub(crate) fn step(
&self,
&mut self,
hint_executor: &mut dyn HintProcessor,
hint_locals: &mut HashMap<String, PyObject>,
exec_scopes: &mut ExecutionScopes,
Expand Down Expand Up @@ -296,7 +301,7 @@ mod test {

#[test]
fn execute_print_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -317,7 +322,7 @@ mod test {

#[test]
fn set_memory_item_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -338,7 +343,7 @@ mod test {

#[test]
fn ids_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -378,7 +383,7 @@ mod test {
#[test]
// Test the availability of cairo constants in ids
fn const_ids() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -419,7 +424,7 @@ mod test {
#[test]
// This test is analogous to the `test_step_for_preset_memory` unit test in the cairo-rs crate.
fn test_step_with_no_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -463,7 +468,7 @@ mod test {

#[test]
fn test_step_with_print_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -513,7 +518,7 @@ mod test {

#[test]
fn scopes_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -552,7 +557,7 @@ mod test {

#[test]
fn scopes_hint_modify() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -614,7 +619,7 @@ mod test {

#[test]
fn modify_hint_locals() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -646,7 +651,7 @@ print(word)";

#[test]
fn exit_main_scope_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -667,7 +672,7 @@ print(word)";

#[test]
fn enter_scope_empty_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -690,7 +695,7 @@ print(word)";

#[test]
fn enter_exit_scope_same_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -714,7 +719,7 @@ vm_exit_scope()";

#[test]
fn enter_exit_scope_separate_hints() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -750,7 +755,7 @@ vm_exit_scope()";

#[test]
fn enter_exit_enter_scope_same_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -775,7 +780,7 @@ vm_enter_scope()";

#[test]
fn list_comprehension() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -798,7 +803,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn enter_scope_non_empty_hint() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -834,7 +839,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn access_relocatable_segment_index() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -856,7 +861,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn to_felt_or_relocatable_number() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -890,7 +895,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn to_felt_or_relocatable_list_should_fail() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand All @@ -912,7 +917,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn to_felt_or_relocatable_relocatable() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -953,7 +958,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn test_get_range() {
let pyvm = PyVM::new(
let mut pyvm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -1002,7 +1007,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn test_segments_memory_get_range() {
let pyvm = PyVM::new(
let mut pyvm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -1045,7 +1050,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn run_hint_with_static_locals() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -1081,7 +1086,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn run_hint_with_static_locals_shouldnt_change_its_value() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down Expand Up @@ -1115,7 +1120,7 @@ lista_b = [lista_a[k] for k in range(2)]";

#[test]
fn run_hint_with_static_locals_shouldnt_affect_scope_or_hint_locals() {
let vm = PyVM::new(
let mut vm = PyVM::new(
BigInt::new(Sign::Plus, vec![1, 0, 0, 0, 0, 0, 17, 134217728]),
false,
Vec::new(),
Expand Down