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 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
// Copyright (C) 2019-2024 Aleo Systems Inc.
// This file is part of the Leo library.
// The Leo library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// The Leo library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.
use crate::{DiGraphError, TypeChecker};
use leo_ast::{Type, *};
use leo_errors::{TypeCheckerError, TypeCheckerWarning};
use leo_span::sym;
use snarkvm::console::network::Network;
use std::collections::HashSet;
// TODO: Cleanup logic for tuples.
impl<'a, N: Network> ProgramVisitor<'a> for TypeChecker<'a, N> {
fn visit_program(&mut self, input: &'a Program) {
// Typecheck the program's stubs.
input.stubs.iter().for_each(|(symbol, stub)| {
// Check that naming and ordering is consistent.
if symbol != &stub.stub_id.name.name {
self.emit_err(TypeCheckerError::stub_name_mismatch(
symbol,
stub.stub_id.name,
stub.stub_id.network.span,
));
}
self.visit_stub(stub)
});
self.scope_state.is_stub = false;
// Typecheck the program scopes.
input.program_scopes.values().for_each(|scope| self.visit_program_scope(scope));
}
fn visit_program_scope(&mut self, input: &'a ProgramScope) {
// Set the current program name.
self.scope_state.program_name = Some(input.program_id.name.name);
// Typecheck each const definition, and append to symbol table.
input.consts.iter().for_each(|(_, c)| self.visit_const(c));
// Typecheck each struct definition.
input.structs.iter().for_each(|(_, function)| self.visit_struct(function));
// Check that the struct dependency graph does not have any cycles.
if let Err(DiGraphError::CycleDetected(path)) = self.struct_graph.post_order() {
self.emit_err(TypeCheckerError::cyclic_struct_dependency(path));
}
// Typecheck each mapping definition.
let mut mapping_count = 0;
for (_, mapping) in input.mappings.iter() {
self.visit_mapping(mapping);
mapping_count += 1;
}
// Check that the number of mappings does not exceed the maximum.
if mapping_count > N::MAX_MAPPINGS {
self.emit_err(TypeCheckerError::too_many_mappings(
N::MAX_MAPPINGS,
input.program_id.name.span + input.program_id.network.span,
));
}
// Typecheck each function definitions.
let mut transition_count = 0;
for (_, function) in input.functions.iter() {
self.visit_function(function);
if function.variant.is_transition() {
transition_count += 1;
}
}
// Check that the call graph does not have any cycles.
if let Err(DiGraphError::CycleDetected(path)) = self.call_graph.post_order() {
self.emit_err(TypeCheckerError::cyclic_function_dependency(path));
}
// TODO: Need similar checks for structs (all in separate PR)
// Check that the number of transitions does not exceed the maximum.
if transition_count > N::MAX_FUNCTIONS {
self.emit_err(TypeCheckerError::too_many_transitions(
N::MAX_FUNCTIONS,
input.program_id.name.span + input.program_id.network.span,
));
}
// Check that each program has at least one transition function.
// This is a snarkvm requirement.
else if transition_count == 0 {
self.emit_err(TypeCheckerError::no_transitions(input.program_id.name.span + input.program_id.network.span));
}
}
fn visit_stub(&mut self, input: &'a Stub) {
// Set the current program name.
self.scope_state.program_name = Some(input.stub_id.name.name);
// Cannot have constant declarations in stubs.
if !input.consts.is_empty() {
self.emit_err(TypeCheckerError::stubs_cannot_have_const_declarations(input.consts.first().unwrap().1.span));
}
// Typecheck the program's structs.
input.structs.iter().for_each(|(_, function)| self.visit_struct_stub(function));
// Typecheck the program's functions.
input.functions.iter().for_each(|(_, function)| self.visit_function_stub(function));
}
fn visit_struct(&mut self, input: &'a Composite) {
// Check for conflicting struct/record member names.
let mut used = HashSet::new();
// TODO: Better span to target duplicate member.
if !input.members.iter().all(|Member { identifier, type_, span, .. }| {
// Check that the member types are defined.
self.assert_type_is_valid(type_, *span);
used.insert(identifier.name)
}) {
self.emit_err(if input.is_record {
TypeCheckerError::duplicate_record_variable(input.name(), input.span())
} else {
TypeCheckerError::duplicate_struct_member(input.name(), input.span())
});
}
// For records, enforce presence of the `owner: Address` member.
if input.is_record {
let check_has_field =
|need, expected_ty: Type| match input.members.iter().find_map(|Member { identifier, type_, .. }| {
(identifier.name == need).then_some((identifier, type_))
}) {
Some((_, actual_ty)) if expected_ty.eq_flat_relaxed(actual_ty) => {} // All good, found + right type!
Some((field, _)) => {
self.emit_err(TypeCheckerError::record_var_wrong_type(field, expected_ty, input.span()));
}
None => {
self.emit_err(TypeCheckerError::required_record_variable(need, expected_ty, input.span()));
}
};
check_has_field(sym::owner, Type::Address);
}
// For structs, check that there is at least one member.
else if input.members.is_empty() {
self.emit_err(TypeCheckerError::empty_struct(input.span()));
}
if !(input.is_record && self.scope_state.is_stub) {
for Member { mode, identifier, type_, span, .. } in input.members.iter() {
// Check that the member type is not a tuple.
if matches!(type_, Type::Tuple(_)) {
self.emit_err(TypeCheckerError::composite_data_type_cannot_contain_tuple(
if input.is_record { "record" } else { "struct" },
identifier.span,
));
}
// Ensure that there are no record members.
self.assert_member_is_not_record(identifier.span, input.identifier.name, type_);
// If the member is a struct, add it to the struct dependency graph.
// Note that we have already checked that each member is defined and valid.
if let Type::Composite(struct_member_type) = type_ {
// Note that since there are no cycles in the program dependency graph, there are no cycles in the struct dependency graph caused by external structs.
self.struct_graph.add_edge(input.identifier.name, struct_member_type.id.name);
} else if let Type::Array(array_type) = type_ {
// Get the base element type.
let base_element_type = array_type.base_element_type();
// If the base element type is a struct, then add it to the struct dependency graph.
if let Type::Composite(member_type) = base_element_type {
self.struct_graph.add_edge(input.identifier.name, member_type.id.name);
}
}
// If the input is a struct, then check that the member does not have a mode.
if !input.is_record && !matches!(mode, Mode::None) {
self.emit_err(TypeCheckerError::struct_cannot_have_member_mode(*span));
}
}
}
}
fn visit_mapping(&mut self, input: &'a Mapping) {
// Check that a mapping's key type is valid.
self.assert_type_is_valid(&input.key_type, input.span);
// Check that a mapping's key type is not a tuple, record, or mapping.
match input.key_type.clone() {
Type::Tuple(_) => self.emit_err(TypeCheckerError::invalid_mapping_type("key", "tuple", input.span)),
Type::Composite(struct_type) => {
if let Some(struct_) = self.lookup_struct(struct_type.program, struct_type.id.name) {
if struct_.is_record {
self.emit_err(TypeCheckerError::invalid_mapping_type("key", "record", input.span));
}
}
}
// Note that this is not possible since the parser does not currently accept mapping types.
Type::Mapping(_) => self.emit_err(TypeCheckerError::invalid_mapping_type("key", "mapping", input.span)),
_ => {}
}
// Check that a mapping's value type is valid.
self.assert_type_is_valid(&input.value_type, input.span);
// Check that a mapping's value type is not a tuple, record or mapping.
match input.value_type.clone() {
Type::Tuple(_) => self.emit_err(TypeCheckerError::invalid_mapping_type("value", "tuple", input.span)),
Type::Composite(struct_type) => {
if let Some(struct_) = self.lookup_struct(struct_type.program, struct_type.id.name) {
if struct_.is_record {
self.emit_err(TypeCheckerError::invalid_mapping_type("value", "record", input.span));
}
}
}
// Note that this is not possible since the parser does not currently accept mapping types.
Type::Mapping(_) => self.emit_err(TypeCheckerError::invalid_mapping_type("value", "mapping", input.span)),
_ => {}
}
}
fn visit_function(&mut self, function: &'a Function) {
// Check that the function's annotations are valid.
// Note that Leo does not natively support any specific annotations.
for annotation in function.annotations.iter() {
// TODO: Change to compiler warning.
self.emit_err(TypeCheckerError::unknown_annotation(annotation, annotation.span))
}
// Set type checker variables for function variant details.
self.scope_state.initialize_function_state(function.variant);
// Lookup function metadata in the symbol table.
// Note that this unwrap is safe since function metadata is stored in a prior pass.
let function_index = self
.symbol_table
.borrow()
.lookup_fn_symbol(Location::new(self.scope_state.program_name, function.identifier.name))
.unwrap()
.id;
// Enter the function's scope.
self.enter_scope(function_index);
// The function's body does not have a return statement.
self.scope_state.has_return = false;
// Store the name of the function.
self.scope_state.function = Some(function.name());
// Create a new child scope for the function's parameters and body.
let scope_index = self.create_child_scope();
// Query helper function to type check function parameters and outputs.
self.check_function_signature(function);
if self.scope_state.variant == Some(Variant::AsyncFunction) {
// Async functions cannot have empty blocks
if function.block.statements.is_empty() {
self.emit_err(TypeCheckerError::finalize_block_must_not_be_empty(function.block.span));
}
// Initialize the list of input futures. Each one must be awaited before the end of the function.
self.await_checker.set_futures(
function
.input
.iter()
.filter_map(|input| {
if let Type::Future(_) = input.type_.clone() { Some(input.identifier.name) } else { None }
})
.collect(),
);
}
self.visit_block(&function.block);
// If the function has a return type, then check that it has a return.
if function.output_type != Type::Unit && !self.scope_state.has_return {
self.emit_err(TypeCheckerError::missing_return(function.span));
}
// Exit the scope for the function's parameters and body.
self.exit_scope(scope_index);
// Exit the function's scope.
self.exit_scope(function_index);
// Make sure that async transitions call finalize.
if self.scope_state.variant == Some(Variant::AsyncTransition) && !self.scope_state.has_called_finalize {
self.emit_err(TypeCheckerError::async_transition_must_call_async_function(function.span));
}
// Check that all futures were awaited exactly once.
if self.scope_state.variant == Some(Variant::AsyncFunction) {
// Throw error if not all futures awaits even appear once.
if !self.await_checker.static_to_await.is_empty() {
self.emit_err(TypeCheckerError::future_awaits_missing(
self.await_checker
.static_to_await
.clone()
.iter()
.map(|f| f.to_string())
.collect::<Vec<String>>()
.join(", "),
function.span(),
));
} else if self.await_checker.enabled && !self.await_checker.to_await.is_empty() {
// Tally up number of paths that are unawaited and number of paths that are awaited more than once.
let (num_paths_unawaited, num_paths_duplicate_awaited, num_perfect) =
self.await_checker.to_await.iter().fold((0, 0, 0), |(unawaited, duplicate, perfect), path| {
(
unawaited + if !path.elements.is_empty() { 1 } else { 0 },
duplicate + if path.counter > 0 { 1 } else { 0 },
perfect + if path.counter > 0 || !path.elements.is_empty() { 0 } else { 1 },
)
});
// Throw error if there does not exist a path in which all futures are awaited exactly once.
if num_perfect == 0 {
self.emit_err(TypeCheckerError::no_path_awaits_all_futures_exactly_once(
self.await_checker.to_await.len(),
function.span(),
));
}
// Throw warning if some futures are awaited more than once in some paths.
if num_paths_unawaited > 0 {
self.emit_warning(TypeCheckerWarning::some_paths_do_not_await_all_futures(
self.await_checker.to_await.len(),
num_paths_unawaited,
function.span(),
));
}
// Throw warning if not all futures are awaited in some paths.
if num_paths_duplicate_awaited > 0 {
self.emit_warning(TypeCheckerWarning::some_paths_contain_duplicate_future_awaits(
self.await_checker.to_await.len(),
num_paths_duplicate_awaited,
function.span(),
));
}
}
}
}
fn visit_function_stub(&mut self, input: &'a FunctionStub) {
// Must not be an inline function
if input.variant == Variant::Inline {
self.emit_err(TypeCheckerError::stub_functions_must_not_be_inlines(input.span));
}
// Lookup function metadata in the symbol table.
// Note that this unwrap is safe since function metadata is stored in a prior pass.
let function_index = self
.symbol_table
.borrow()
.lookup_fn_symbol(Location::new(self.scope_state.program_name, input.identifier.name))
.unwrap()
.id;
// Enter the function's scope.
self.enter_scope(function_index);
// Create a new child scope for the function's parameters and body.
let scope_index = self.create_child_scope();
// Create future stubs.
if input.variant == Variant::AsyncFunction {
let finalize_input_map = &mut self.async_function_input_types;
let resolved_inputs: Vec<Type> = input
.input
.iter()
.map(|input| {
match &input.type_ {
Type::Future(f) => {
// Since we traverse stubs in post-order, we can assume that the corresponding finalize stub has already been traversed.
Type::Future(FutureType::new(
finalize_input_map.get(&f.location.clone().unwrap()).unwrap().clone(),
f.location.clone(),
true,
))
}
_ => input.clone().type_,
}
})
.collect();
finalize_input_map
.insert(Location::new(self.scope_state.program_name, input.identifier.name), resolved_inputs);
}
// Query helper function to type check function parameters and outputs.
self.check_function_signature(&Function::from(input.clone()));
// Exit the scope for the function's parameters and body.
self.exit_scope(scope_index);
// Exit the function's scope.
self.exit_scope(function_index);
}
fn visit_struct_stub(&mut self, input: &'a Composite) {
self.visit_struct(input);
}
}