Skip to content

fix: Remove panics in the interpreter when a builtin fails to type check #5382

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

Merged
TomAFrench merged 1 commit into from
Jul 2, 2024
Merged

fix: Remove panics in the interpreter when a builtin fails to type check #5382

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
130 changes: 86 additions & 44 deletions compiler/noirc_frontend/src/hir/comptime/interpreter/builtin.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,62 +16,102 @@ pub(super) fn call_builtin(
location: Location,
) -> IResult<Value> {
match name {
"array_len" => array_len(&arguments),
"as_slice" => as_slice(arguments),
"slice_push_back" => slice_push_back(arguments),
"struct_def_as_type" => struct_def_as_type(interner, arguments),
"struct_def_generics" => struct_def_generics(interner, arguments),
"struct_def_fields" => struct_def_fields(interner, arguments),
"array_len" => array_len(interner, arguments, location),
"as_slice" => as_slice(interner, arguments, location),
"slice_push_back" => slice_push_back(interner, arguments, location),
"struct_def_as_type" => struct_def_as_type(interner, arguments, location),
"struct_def_generics" => struct_def_generics(interner, arguments, location),
"struct_def_fields" => struct_def_fields(interner, arguments, location),
_ => {
let item = format!("Comptime evaluation for builtin function {name}");
Err(InterpreterError::Unimplemented { item, location })
}
}
}

fn array_len(arguments: &[(Value, Location)]) -> IResult<Value> {
assert_eq!(arguments.len(), 1, "ICE: `array_len` should only receive a single argument");
match &arguments[0].0 {
fn check_argument_count(
expected: usize,
arguments: &[(Value, Location)],
location: Location,
) -> IResult<()> {
if arguments.len() == expected {
Ok(())
} else {
let actual = arguments.len();
Err(InterpreterError::ArgumentCountMismatch { expected, actual, location })
}
}

fn array_len(
interner: &NodeInterner,
mut arguments: Vec<(Value, Location)>,
location: Location,
) -> IResult<Value> {
check_argument_count(1, &arguments, location)?;

match arguments.pop().unwrap().0 {
Value::Array(values, _) | Value::Slice(values, _) => Ok(Value::U32(values.len() as u32)),
// Type checking should prevent this branch being taken.
_ => unreachable!("ICE: Cannot query length of types other than arrays or slices"),
value => {
let type_var = Box::new(interner.next_type_variable());
let expected = Type::Array(type_var.clone(), type_var);
Err(InterpreterError::TypeMismatch { expected, value, location })
}
}
}

fn as_slice(mut arguments: Vec<(Value, Location)>) -> IResult<Value> {
assert_eq!(arguments.len(), 1, "ICE: `as_slice` should only receive a single argument");
fn as_slice(
interner: &NodeInterner,
mut arguments: Vec<(Value, Location)>,
location: Location,
) -> IResult<Value> {
check_argument_count(1, &arguments, location)?;

let (array, _) = arguments.pop().unwrap();
match array {
Value::Array(values, Type::Array(_, typ)) => Ok(Value::Slice(values, Type::Slice(typ))),
// Type checking should prevent this branch being taken.
_ => unreachable!("ICE: Cannot convert types other than arrays into slices"),
value => {
let type_var = Box::new(interner.next_type_variable());
let expected = Type::Array(type_var.clone(), type_var);
Err(InterpreterError::TypeMismatch { expected, value, location })
}
}
}

fn slice_push_back(mut arguments: Vec<(Value, Location)>) -> IResult<Value> {
assert_eq!(arguments.len(), 2, "ICE: `slice_push_back` should only receive two arguments");
fn slice_push_back(
interner: &NodeInterner,
mut arguments: Vec<(Value, Location)>,
location: Location,
) -> IResult<Value> {
check_argument_count(2, &arguments, location)?;

let (element, _) = arguments.pop().unwrap();
let (slice, _) = arguments.pop().unwrap();
match slice {
Value::Slice(mut values, typ) => {
values.push_back(element);
Ok(Value::Slice(values, typ))
}
// Type checking should prevent this branch being taken.
_ => unreachable!("ICE: `slice_push_back` expects a slice as its first argument"),
value => {
let type_var = Box::new(interner.next_type_variable());
let expected = Type::Slice(type_var);
Err(InterpreterError::TypeMismatch { expected, value, location })
}
}
}

/// fn as_type(self) -> Quoted
fn struct_def_as_type(
interner: &NodeInterner,
mut arguments: Vec<(Value, Location)>,
location: Location,
) -> IResult<Value> {
assert_eq!(arguments.len(), 1, "ICE: `generics` should only receive a single argument");
let (struct_def, span) = match arguments.pop() {
Some((Value::StructDefinition(id), location)) => (id, location.span),
other => {
unreachable!("ICE: `as_type` expected a `StructDefinition` argument, found {other:?}")
check_argument_count(1, &arguments, location)?;

let (struct_def, span) = match arguments.pop().unwrap() {
(Value::StructDefinition(id), location) => (id, location.span),
value => {
let expected = Type::Quoted(QuotedType::StructDefinition);
return Err(InterpreterError::TypeMismatch { expected, location, value: value.0 });
}
};

Expand All @@ -95,42 +135,44 @@ fn struct_def_as_type(
fn struct_def_generics(
interner: &NodeInterner,
mut arguments: Vec<(Value, Location)>,
location: Location,
) -> IResult<Value> {
assert_eq!(arguments.len(), 1, "ICE: `generics` should only receive a single argument");
let (struct_def, span) = match arguments.pop() {
Some((Value::StructDefinition(id), location)) => (id, location.span),
other => {
unreachable!("ICE: `as_type` expected a `StructDefinition` argument, found {other:?}")
check_argument_count(1, &arguments, location)?;

let (struct_def, span) = match arguments.pop().unwrap() {
(Value::StructDefinition(id), location) => (id, location.span),
value => {
let expected = Type::Quoted(QuotedType::StructDefinition);
return Err(InterpreterError::TypeMismatch { expected, location, value: value.0 });
}
};

let struct_def = interner.get_struct(struct_def);
let struct_def = struct_def.borrow();

let generics = struct_def
.borrow()
.generics
.iter()
.map(|generic| {
let name = SpannedToken::new(Token::Ident(generic.type_var.borrow().to_string()), span);
Value::Code(Rc::new(Tokens(vec![name])))
})
.collect();
let generics = struct_def.generics.iter().map(|generic| {
let name = SpannedToken::new(Token::Ident(generic.type_var.borrow().to_string()), span);
Value::Code(Rc::new(Tokens(vec![name])))
});

let typ = Type::Slice(Box::new(Type::Quoted(QuotedType::Quoted)));
Ok(Value::Slice(generics, typ))
Ok(Value::Slice(generics.collect(), typ))
}

/// fn fields(self) -> [(Quoted, Quoted)]
/// Returns (name, type) pairs of each field of this StructDefinition
fn struct_def_fields(
interner: &mut NodeInterner,
mut arguments: Vec<(Value, Location)>,
location: Location,
) -> IResult<Value> {
assert_eq!(arguments.len(), 1, "ICE: `generics` should only receive a single argument");
let (struct_def, span) = match arguments.pop() {
Some((Value::StructDefinition(id), location)) => (id, location.span),
other => {
unreachable!("ICE: `as_type` expected a `StructDefinition` argument, found {other:?}")
check_argument_count(1, &arguments, location)?;

let (struct_def, span) = match arguments.pop().unwrap() {
(Value::StructDefinition(id), location) => (id, location.span),
value => {
let expected = Type::Quoted(QuotedType::StructDefinition);
return Err(InterpreterError::TypeMismatch { expected, location, value: value.0 });
}
};

Expand Down