-
Notifications
You must be signed in to change notification settings - Fork 661
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.
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
Fix futures #28469
Open
mikebenfield
wants to merge
3
commits into
mainnet
Choose a base branch
from
fix-futures
base: mainnet
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Fix futures #28469
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
// 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::TypeTable; | ||
|
||
use leo_ast::{CoreFunction, Expression, ExpressionVisitor, Function, Node, StatementVisitor, Type}; | ||
use leo_errors::{StaticAnalyzerError, emitter::Handler}; | ||
|
||
/// Error if futures are used improperly. | ||
/// | ||
/// This prevents, for instance, a bare call which creates an unused future. | ||
pub fn future_check_function(function: &Function, type_table: &TypeTable, handler: &Handler) { | ||
let mut future_checker = FutureChecker { type_table, handler }; | ||
future_checker.visit_block(&function.block); | ||
} | ||
|
||
#[derive(Clone, Copy, Debug, Default)] | ||
enum Position { | ||
#[default] | ||
Misc, | ||
Await, | ||
TupleAccess, | ||
Return, | ||
FunctionArgument, | ||
LastTupleLiteral, | ||
Definition, | ||
} | ||
|
||
struct FutureChecker<'a> { | ||
type_table: &'a TypeTable, | ||
handler: &'a Handler, | ||
} | ||
|
||
impl<'a> FutureChecker<'a> { | ||
fn emit_err(&self, err: StaticAnalyzerError) { | ||
self.handler.emit_err(err); | ||
} | ||
} | ||
|
||
impl<'a> ExpressionVisitor<'a> for FutureChecker<'a> { | ||
type AdditionalInput = Position; | ||
type Output = (); | ||
|
||
fn visit_expression(&mut self, input: &'a Expression, additional: &Self::AdditionalInput) -> Self::Output { | ||
use Position::*; | ||
let is_call = matches!(input, Expression::Call(..)); | ||
match self.type_table.get(&input.id()) { | ||
Some(Type::Future(..)) if is_call => { | ||
// A call producing a Future may appear in any of these positions. | ||
if !matches!(additional, Await | Return | FunctionArgument | LastTupleLiteral | Definition) { | ||
self.emit_err(StaticAnalyzerError::misplaced_future(input.span())); | ||
} | ||
} | ||
Some(Type::Future(..)) => { | ||
// A Future expression that's not a call may appear in any of these positions. | ||
if !matches!(additional, Await | Return | FunctionArgument | LastTupleLiteral | TupleAccess) { | ||
self.emit_err(StaticAnalyzerError::misplaced_future(input.span())); | ||
} | ||
} | ||
Some(Type::Tuple(tuple)) if !matches!(tuple.elements().last(), Some(Type::Future(_))) => {} | ||
Some(Type::Tuple(..)) if is_call => { | ||
// A call producing a Tuple ending in a Future may appear in any of these positions. | ||
if !matches!(additional, Return | Definition) { | ||
self.emit_err(StaticAnalyzerError::misplaced_future(input.span())); | ||
} | ||
} | ||
Some(Type::Tuple(..)) => { | ||
// A Tuple ending in a Future that's not a call may appear in any of these positions. | ||
if !matches!(additional, Return | TupleAccess) { | ||
self.emit_err(StaticAnalyzerError::misplaced_future(input.span())); | ||
} | ||
} | ||
_ => {} | ||
} | ||
|
||
match input { | ||
Expression::Access(access) => self.visit_access(access, &Position::Misc), | ||
Expression::Array(array) => self.visit_array(array, &Position::Misc), | ||
Expression::Binary(binary) => self.visit_binary(binary, &Position::Misc), | ||
Expression::Call(call) => self.visit_call(call, &Position::Misc), | ||
Expression::Cast(cast) => self.visit_cast(cast, &Position::Misc), | ||
Expression::Struct(struct_) => self.visit_struct_init(struct_, &Position::Misc), | ||
Expression::Err(err) => self.visit_err(err, &Position::Misc), | ||
Expression::Identifier(identifier) => self.visit_identifier(identifier, &Position::Misc), | ||
Expression::Literal(literal) => self.visit_literal(literal, &Position::Misc), | ||
Expression::Locator(locator) => self.visit_locator(locator, &Position::Misc), | ||
Expression::Ternary(ternary) => self.visit_ternary(ternary, &Position::Misc), | ||
Expression::Tuple(tuple) => self.visit_tuple(tuple, additional), | ||
Expression::Unary(unary) => self.visit_unary(unary, &Position::Misc), | ||
Expression::Unit(unit) => self.visit_unit(unit, &Position::Misc), | ||
} | ||
} | ||
|
||
fn visit_access( | ||
&mut self, | ||
input: &'a leo_ast::AccessExpression, | ||
_additional: &Self::AdditionalInput, | ||
) -> Self::Output { | ||
match input { | ||
leo_ast::AccessExpression::Array(array) => { | ||
self.visit_expression(&array.array, &Position::Misc); | ||
self.visit_expression(&array.index, &Position::Misc); | ||
} | ||
leo_ast::AccessExpression::AssociatedFunction(function) => { | ||
let core_function = CoreFunction::from_symbols(function.variant.name, function.name.name) | ||
.expect("Typechecking guarantees that this function exists."); | ||
let position = | ||
if core_function == CoreFunction::FutureAwait { Position::Await } else { Position::Misc }; | ||
function.arguments.iter().for_each(|arg| { | ||
self.visit_expression(arg, &position); | ||
}); | ||
} | ||
leo_ast::AccessExpression::Member(member) => { | ||
self.visit_expression(&member.inner, &Position::Misc); | ||
} | ||
leo_ast::AccessExpression::Tuple(tuple) => { | ||
self.visit_expression(&tuple.tuple, &Position::TupleAccess); | ||
} | ||
_ => {} | ||
} | ||
|
||
Default::default() | ||
} | ||
|
||
fn visit_call(&mut self, input: &'a leo_ast::CallExpression, _additional: &Self::AdditionalInput) -> Self::Output { | ||
input.arguments.iter().for_each(|expr| { | ||
self.visit_expression(expr, &Position::FunctionArgument); | ||
}); | ||
Default::default() | ||
} | ||
|
||
fn visit_tuple(&mut self, input: &'a leo_ast::TupleExpression, additional: &Self::AdditionalInput) -> Self::Output { | ||
let next_position = match additional { | ||
Position::Definition | Position::Return => Position::LastTupleLiteral, | ||
_ => Position::Misc, | ||
}; | ||
let mut iter = input.elements.iter().peekable(); | ||
while let Some(expr) = iter.next() { | ||
let position = if iter.peek().is_some() { &Position::Misc } else { &next_position }; | ||
self.visit_expression(expr, position); | ||
} | ||
Default::default() | ||
} | ||
} | ||
|
||
impl<'a> StatementVisitor<'a> for FutureChecker<'a> { | ||
fn visit_definition(&mut self, input: &'a leo_ast::DefinitionStatement) { | ||
self.visit_expression(&input.value, &Position::Definition); | ||
} | ||
|
||
fn visit_return(&mut self, input: &'a leo_ast::ReturnStatement) { | ||
self.visit_expression(&input.expression, &Position::Return); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit. Could we use the
unreachable
macro here? This helps us look back on those sorts of invariants.