2019-03-18 10:21:41 +00:00
/*
This file is part of solidity .
solidity 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 .
solidity 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 solidity . If not , see < http : //www.gnu.org/licenses/>.
*/
/**
* Component that translates Solidity code into Yul at statement level and below .
*/
# include <libsolidity/codegen/ir/IRGeneratorForStatements.h>
2019-04-30 17:08:02 +00:00
# include <libsolidity/codegen/ABIFunctions.h>
2019-03-18 10:21:41 +00:00
# include <libsolidity/codegen/ir/IRGenerationContext.h>
2019-04-30 16:32:56 +00:00
# include <libsolidity/codegen/ir/IRLValue.h>
2020-02-06 13:05:25 +00:00
# include <libsolidity/codegen/ir/IRVariable.h>
2019-03-18 10:21:41 +00:00
# include <libsolidity/codegen/YulUtilFunctions.h>
2019-05-02 20:33:47 +00:00
# include <libsolidity/codegen/ABIFunctions.h>
2019-04-30 17:08:02 +00:00
# include <libsolidity/codegen/CompilerUtils.h>
2020-02-10 10:58:36 +00:00
# include <libsolidity/codegen/ReturnInfo.h>
2019-04-24 22:01:13 +00:00
# include <libsolidity/ast/TypeProvider.h>
2019-03-18 10:21:41 +00:00
2019-05-06 17:48:31 +00:00
# include <libevmasm/GasMeter.h>
2019-04-11 10:58:27 +00:00
# include <libyul/AsmPrinter.h>
# include <libyul/AsmData.h>
2019-05-22 14:46:04 +00:00
# include <libyul/Dialect.h>
2019-04-11 10:58:27 +00:00
# include <libyul/optimiser/ASTCopier.h>
2019-12-11 16:31:36 +00:00
# include <libsolutil/Whiskers.h>
# include <libsolutil/StringUtils.h>
# include <libsolutil/Keccak256.h>
2020-02-06 13:05:25 +00:00
# include <libsolutil/Visitor.h>
# include <boost/range/adaptor/transformed.hpp>
2019-04-02 10:37:48 +00:00
2019-03-18 10:21:41 +00:00
using namespace std ;
2019-12-11 16:31:36 +00:00
using namespace solidity ;
using namespace solidity : : util ;
using namespace solidity : : frontend ;
2020-03-03 11:18:26 +00:00
using namespace std : : string_literals ;
2019-03-18 10:21:41 +00:00
2019-04-11 10:58:27 +00:00
namespace
{
struct CopyTranslate : public yul : : ASTCopier
{
using ExternalRefsMap = std : : map < yul : : Identifier const * , InlineAssemblyAnnotation : : ExternalIdentifierInfo > ;
2019-05-22 14:46:04 +00:00
CopyTranslate ( yul : : Dialect const & _dialect , IRGenerationContext & _context , ExternalRefsMap const & _references ) :
m_dialect ( _dialect ) , m_context ( _context ) , m_references ( _references ) { }
2019-04-11 10:58:27 +00:00
using ASTCopier : : operator ( ) ;
2019-06-20 12:50:39 +00:00
yul : : Expression operator ( ) ( yul : : Identifier const & _identifier ) override
{
if ( m_references . count ( & _identifier ) )
{
auto const & reference = m_references . at ( & _identifier ) ;
auto const varDecl = dynamic_cast < VariableDeclaration const * > ( reference . declaration ) ;
solUnimplementedAssert ( varDecl , " " ) ;
if ( reference . isOffset | | reference . isSlot )
{
solAssert ( reference . isOffset ! = reference . isSlot , " " ) ;
pair < u256 , unsigned > slot_offset = m_context . storageLocationOfVariable ( * varDecl ) ;
string const value = reference . isSlot ?
slot_offset . first . str ( ) :
to_string ( slot_offset . second ) ;
return yul : : Literal {
_identifier . location ,
2019-06-13 15:22:24 +00:00
yul : : LiteralKind : : Number ,
yul : : YulString { value } ,
2019-12-19 16:58:20 +00:00
{ }
2019-06-20 12:50:39 +00:00
} ;
}
}
return ASTCopier : : operator ( ) ( _identifier ) ;
}
2019-04-11 10:58:27 +00:00
yul : : YulString translateIdentifier ( yul : : YulString _name ) override
{
2019-05-22 14:46:04 +00:00
// Strictly, the dialect used by inline assembly (m_dialect) could be different
// from the Yul dialect we are compiling to. So we are assuming here that the builtin
// functions are identical. This should not be a problem for now since everything
// is EVM anyway.
if ( m_dialect . builtin ( _name ) )
return _name ;
else
return yul : : YulString { " usr$ " + _name . str ( ) } ;
2019-04-11 10:58:27 +00:00
}
yul : : Identifier translate ( yul : : Identifier const & _identifier ) override
{
if ( ! m_references . count ( & _identifier ) )
return ASTCopier : : translate ( _identifier ) ;
auto const & reference = m_references . at ( & _identifier ) ;
auto const varDecl = dynamic_cast < VariableDeclaration const * > ( reference . declaration ) ;
solUnimplementedAssert ( varDecl , " " ) ;
2019-06-20 12:50:39 +00:00
solAssert (
2019-04-11 10:58:27 +00:00
reference . isOffset = = false & & reference . isSlot = = false ,
2019-06-20 12:50:39 +00:00
" Should not be called for offset/slot "
2019-04-11 10:58:27 +00:00
) ;
2020-05-04 12:21:48 +00:00
auto const & var = m_context . localVariable ( * varDecl ) ;
solAssert ( var . type ( ) . sizeOnStack ( ) = = 1 , " " ) ;
2019-04-11 10:58:27 +00:00
return yul : : Identifier {
_identifier . location ,
2020-05-04 12:21:48 +00:00
yul : : YulString { var . commaSeparatedList ( ) }
2019-04-11 10:58:27 +00:00
} ;
}
private :
2019-05-22 14:46:04 +00:00
yul : : Dialect const & m_dialect ;
2019-04-11 10:58:27 +00:00
IRGenerationContext & m_context ;
ExternalRefsMap const & m_references ;
} ;
}
2019-04-30 16:32:56 +00:00
string IRGeneratorForStatements : : code ( ) const
{
solAssert ( ! m_currentLValue , " LValue not reset! " ) ;
return m_code . str ( ) ;
}
2019-05-20 10:01:47 +00:00
void IRGeneratorForStatements : : initializeStateVar ( VariableDeclaration const & _varDecl )
{
2020-04-02 18:06:52 +00:00
solAssert ( _varDecl . immutable ( ) | | m_context . isStateVariable ( _varDecl ) , " Must be immutable or a state variable. " ) ;
2019-05-20 10:01:47 +00:00
solAssert ( ! _varDecl . isConstant ( ) , " " ) ;
2020-04-02 18:06:52 +00:00
if ( ! _varDecl . value ( ) )
return ;
_varDecl . value ( ) - > accept ( * this ) ;
writeToLValue (
_varDecl . immutable ( ) ?
IRLValue { * _varDecl . annotation ( ) . type , IRLValue : : Immutable { & _varDecl } } :
IRLValue { * _varDecl . annotation ( ) . type , IRLValue : : Storage {
util : : toCompactHexWithPrefix ( m_context . storageLocationOfVariable ( _varDecl ) . first ) ,
m_context . storageLocationOfVariable ( _varDecl ) . second
} } ,
* _varDecl . value ( )
) ;
2019-05-20 10:01:47 +00:00
}
2020-03-02 20:42:46 +00:00
void IRGeneratorForStatements : : initializeLocalVar ( VariableDeclaration const & _varDecl )
{
solAssert ( m_context . isLocalVariable ( _varDecl ) , " Must be a local variable. " ) ;
auto const * type = _varDecl . type ( ) ;
if ( auto const * refType = dynamic_cast < ReferenceType const * > ( type ) )
if ( refType - > dataStoredIn ( DataLocation : : Storage ) & & refType - > isPointer ( ) )
return ;
IRVariable zero = zeroValue ( * type ) ;
assign ( m_context . localVariable ( _varDecl ) , zero ) ;
}
2020-04-06 15:26:59 +00:00
IRVariable IRGeneratorForStatements : : evaluateExpression ( Expression const & _expression , Type const & _targetType )
{
_expression . accept ( * this ) ;
IRVariable variable { m_context . newYulVariable ( ) , _targetType } ;
define ( variable , _expression ) ;
return variable ;
}
2020-04-20 21:05:14 +00:00
string IRGeneratorForStatements : : constantValueFunction ( VariableDeclaration const & _constant )
{
string functionName = " constant_ " + _constant . name ( ) + " _ " + to_string ( _constant . id ( ) ) ;
return m_context . functionCollector ( ) . createFunction ( functionName , [ & ] {
Whiskers templ ( R " (
function < functionName > ( ) - > < ret > {
< code >
< ret > : = < value >
}
) " );
templ ( " functionName " , functionName ) ;
IRGeneratorForStatements generator ( m_context , m_utils ) ;
solAssert ( _constant . value ( ) , " " ) ;
Type const & constantType = * _constant . type ( ) ;
templ ( " value " , generator . evaluateExpression ( * _constant . value ( ) , constantType ) . commaSeparatedList ( ) ) ;
templ ( " code " , generator . code ( ) ) ;
templ ( " ret " , IRVariable ( " ret " , constantType ) . commaSeparatedList ( ) ) ;
return templ . render ( ) ;
} ) ;
}
2019-05-02 19:22:23 +00:00
void IRGeneratorForStatements : : endVisit ( VariableDeclarationStatement const & _varDeclStatement )
2019-03-18 10:21:41 +00:00
{
if ( Expression const * expression = _varDeclStatement . initialValue ( ) )
{
2020-02-06 13:05:25 +00:00
if ( _varDeclStatement . declarations ( ) . size ( ) > 1 )
{
auto const * tupleType = dynamic_cast < TupleType const * > ( expression - > annotation ( ) . type ) ;
solAssert ( tupleType , " Expected expression of tuple type. " ) ;
solAssert ( _varDeclStatement . declarations ( ) . size ( ) = = tupleType - > components ( ) . size ( ) , " Invalid number of tuple components. " ) ;
for ( size_t i = 0 ; i < _varDeclStatement . declarations ( ) . size ( ) ; + + i )
if ( auto const & decl = _varDeclStatement . declarations ( ) [ i ] )
{
solAssert ( tupleType - > components ( ) [ i ] , " " ) ;
define ( m_context . addLocalVariable ( * decl ) , IRVariable ( * expression ) . tupleComponent ( i ) ) ;
}
}
else
{
VariableDeclaration const & varDecl = * _varDeclStatement . declarations ( ) . front ( ) ;
define ( m_context . addLocalVariable ( varDecl ) , * expression ) ;
}
2019-03-18 10:21:41 +00:00
}
else
for ( auto const & decl : _varDeclStatement . declarations ( ) )
if ( decl )
2020-03-02 20:42:46 +00:00
{
2020-02-06 13:05:25 +00:00
declare ( m_context . addLocalVariable ( * decl ) ) ;
2020-03-02 20:42:46 +00:00
initializeLocalVar ( * decl ) ;
}
2019-03-18 10:21:41 +00:00
}
2020-02-13 19:42:16 +00:00
bool IRGeneratorForStatements : : visit ( Conditional const & _conditional )
{
_conditional . condition ( ) . accept ( * this ) ;
string condition = expressionAsType ( _conditional . condition ( ) , * TypeProvider : : boolean ( ) ) ;
declare ( _conditional ) ;
m_code < < " switch " < < condition < < " \n " " case 0 { \n " ;
_conditional . falseExpression ( ) . accept ( * this ) ;
assign ( _conditional , _conditional . falseExpression ( ) ) ;
m_code < < " } \n " " default { \n " ;
_conditional . trueExpression ( ) . accept ( * this ) ;
assign ( _conditional , _conditional . trueExpression ( ) ) ;
m_code < < " } \n " ;
return false ;
}
2019-03-18 10:21:41 +00:00
bool IRGeneratorForStatements : : visit ( Assignment const & _assignment )
{
_assignment . rightHandSide ( ) . accept ( * this ) ;
2020-04-20 21:16:42 +00:00
Token assignmentOperator = _assignment . assignmentOperator ( ) ;
Token binaryOperator =
assignmentOperator = = Token : : Assign ?
assignmentOperator :
TokenTraits : : AssignmentToBinaryOp ( assignmentOperator ) ;
Type const * rightIntermediateType =
TokenTraits : : isShiftOp ( binaryOperator ) ?
type ( _assignment . rightHandSide ( ) ) . mobileType ( ) :
type ( _assignment . rightHandSide ( ) ) . closestTemporaryType (
& type ( _assignment . leftHandSide ( ) )
) ;
solAssert ( rightIntermediateType , " " ) ;
IRVariable value = convert ( _assignment . rightHandSide ( ) , * rightIntermediateType ) ;
2019-04-30 16:32:56 +00:00
_assignment . leftHandSide ( ) . accept ( * this ) ;
solAssert ( ! ! m_currentLValue , " LValue not retrieved. " ) ;
2019-04-15 16:10:36 +00:00
2020-04-20 21:16:42 +00:00
if ( assignmentOperator ! = Token : : Assign )
2019-05-23 18:17:20 +00:00
{
2020-04-20 21:16:42 +00:00
solAssert ( type ( _assignment . leftHandSide ( ) ) . isValueType ( ) , " Compound operators only available for value types. " ) ;
solAssert ( rightIntermediateType - > isValueType ( ) , " Compound operators only available for value types. " ) ;
2020-02-06 13:05:25 +00:00
IRVariable leftIntermediate = readFromLValue ( * m_currentLValue ) ;
2020-04-20 21:16:42 +00:00
if ( TokenTraits : : isShiftOp ( binaryOperator ) )
{
solAssert ( type ( _assignment ) = = leftIntermediate . type ( ) , " " ) ;
solAssert ( type ( _assignment ) = = type ( _assignment . leftHandSide ( ) ) , " " ) ;
define ( _assignment ) < < shiftOperation ( binaryOperator , leftIntermediate , value ) ;
writeToLValue ( * m_currentLValue , IRVariable ( _assignment ) ) ;
m_currentLValue . reset ( ) ;
return false ;
}
else
{
solAssert ( type ( _assignment . leftHandSide ( ) ) = = * rightIntermediateType , " " ) ;
m_code < < value . name ( ) < < " := " < < binaryOperation (
binaryOperator ,
* rightIntermediateType ,
leftIntermediate . name ( ) ,
value . name ( )
) ;
}
2019-05-23 18:17:20 +00:00
}
2020-02-06 13:05:25 +00:00
writeToLValue ( * m_currentLValue , value ) ;
2020-04-20 21:16:42 +00:00
2019-05-23 18:17:20 +00:00
m_currentLValue . reset ( ) ;
2020-02-06 13:05:25 +00:00
if ( * _assignment . annotation ( ) . type ! = * TypeProvider : : emptyTuple ( ) )
define ( _assignment , value ) ;
2019-04-15 16:10:36 +00:00
2019-03-18 10:21:41 +00:00
return false ;
}
2019-05-02 16:28:33 +00:00
bool IRGeneratorForStatements : : visit ( TupleExpression const & _tuple )
{
if ( _tuple . isInlineArray ( ) )
solUnimplementedAssert ( false , " " ) ;
else
{
2020-04-09 10:48:57 +00:00
bool willBeWrittenTo = _tuple . annotation ( ) . willBeWrittenTo ;
if ( willBeWrittenTo )
2020-02-06 13:05:25 +00:00
solAssert ( ! m_currentLValue , " " ) ;
if ( _tuple . components ( ) . size ( ) = = 1 )
{
solAssert ( _tuple . components ( ) . front ( ) , " " ) ;
_tuple . components ( ) . front ( ) - > accept ( * this ) ;
2020-04-09 10:48:57 +00:00
if ( willBeWrittenTo )
2020-02-06 13:05:25 +00:00
solAssert ( ! ! m_currentLValue , " " ) ;
else
define ( _tuple , * _tuple . components ( ) . front ( ) ) ;
}
else
{
vector < optional < IRLValue > > lvalues ;
for ( size_t i = 0 ; i < _tuple . components ( ) . size ( ) ; + + i )
if ( auto const & component = _tuple . components ( ) [ i ] )
{
component - > accept ( * this ) ;
2020-04-09 10:48:57 +00:00
if ( willBeWrittenTo )
2020-02-06 13:05:25 +00:00
{
solAssert ( ! ! m_currentLValue , " " ) ;
lvalues . emplace_back ( std : : move ( m_currentLValue ) ) ;
m_currentLValue . reset ( ) ;
}
else
define ( IRVariable ( _tuple ) . tupleComponent ( i ) , * component ) ;
}
2020-04-09 10:48:57 +00:00
else if ( willBeWrittenTo )
2020-02-06 13:05:25 +00:00
lvalues . emplace_back ( ) ;
2020-04-09 10:48:57 +00:00
if ( _tuple . annotation ( ) . willBeWrittenTo )
2020-02-06 13:05:25 +00:00
m_currentLValue . emplace ( IRLValue {
* _tuple . annotation ( ) . type ,
IRLValue : : Tuple { std : : move ( lvalues ) }
} ) ;
}
2019-05-02 16:28:33 +00:00
}
return false ;
}
2019-05-09 09:09:28 +00:00
bool IRGeneratorForStatements : : visit ( IfStatement const & _ifStatement )
{
_ifStatement . condition ( ) . accept ( * this ) ;
string condition = expressionAsType ( _ifStatement . condition ( ) , * TypeProvider : : boolean ( ) ) ;
if ( _ifStatement . falseStatement ( ) )
{
m_code < < " switch " < < condition < < " \n " " case 0 { \n " ;
_ifStatement . falseStatement ( ) - > accept ( * this ) ;
m_code < < " } \n " " default { \n " ;
}
else
m_code < < " if " < < condition < < " { \n " ;
_ifStatement . trueStatement ( ) . accept ( * this ) ;
m_code < < " } \n " ;
return false ;
}
2019-05-08 11:27:36 +00:00
bool IRGeneratorForStatements : : visit ( ForStatement const & _forStatement )
2019-04-24 22:01:13 +00:00
{
2019-05-08 11:27:36 +00:00
generateLoop (
_forStatement . body ( ) ,
_forStatement . condition ( ) ,
_forStatement . initializationExpression ( ) ,
_forStatement . loopExpression ( )
) ;
return false ;
}
bool IRGeneratorForStatements : : visit ( WhileStatement const & _whileStatement )
{
generateLoop (
_whileStatement . body ( ) ,
& _whileStatement . condition ( ) ,
nullptr ,
nullptr ,
_whileStatement . isDoWhile ( )
) ;
2019-04-24 22:01:13 +00:00
return false ;
}
bool IRGeneratorForStatements : : visit ( Continue const & )
{
m_code < < " continue \n " ;
return false ;
}
bool IRGeneratorForStatements : : visit ( Break const & )
{
m_code < < " break \n " ;
return false ;
}
2019-05-02 19:22:23 +00:00
void IRGeneratorForStatements : : endVisit ( Return const & _return )
2019-04-15 16:11:05 +00:00
{
2019-04-24 21:48:12 +00:00
if ( Expression const * value = _return . expression ( ) )
{
solAssert ( _return . annotation ( ) . functionReturnParameters , " Invalid return parameters pointer. " ) ;
vector < ASTPointer < VariableDeclaration > > const & returnParameters =
_return . annotation ( ) . functionReturnParameters - > parameters ( ) ;
2020-02-06 13:05:25 +00:00
if ( returnParameters . size ( ) > 1 )
for ( size_t i = 0 ; i < returnParameters . size ( ) ; + + i )
assign ( m_context . localVariable ( * returnParameters [ i ] ) , IRVariable ( * value ) . tupleComponent ( i ) ) ;
else if ( returnParameters . size ( ) = = 1 )
assign ( m_context . localVariable ( * returnParameters . front ( ) ) , * value ) ;
2019-04-24 21:48:12 +00:00
}
2019-10-24 17:23:56 +00:00
m_code < < " leave \n " ;
2019-04-15 16:11:05 +00:00
}
2019-05-02 12:25:15 +00:00
void IRGeneratorForStatements : : endVisit ( UnaryOperation const & _unaryOperation )
{
2019-05-13 13:26:55 +00:00
Type const & resultType = type ( _unaryOperation ) ;
Token const op = _unaryOperation . getOperator ( ) ;
2019-05-22 10:25:00 +00:00
if ( op = = Token : : Delete )
{
solAssert ( ! ! m_currentLValue , " LValue not retrieved. " ) ;
2020-02-06 13:05:25 +00:00
std : : visit (
util : : GenericVisitor {
[ & ] ( IRLValue : : Storage const & _storage ) {
m_code < <
m_utils . storageSetToZeroFunction ( m_currentLValue - > type ) < <
" ( " < <
_storage . slot < <
" , " < <
_storage . offsetString ( ) < <
" ) \n " ;
m_currentLValue . reset ( ) ;
} ,
[ & ] ( auto const & ) {
IRVariable zeroValue ( m_context . newYulVariable ( ) , m_currentLValue - > type ) ;
define ( zeroValue ) < < m_utils . zeroValueFunction ( m_currentLValue - > type ) < < " () \n " ;
writeToLValue ( * m_currentLValue , zeroValue ) ;
m_currentLValue . reset ( ) ;
}
} ,
m_currentLValue - > kind
) ;
2019-05-22 10:25:00 +00:00
}
else if ( resultType . category ( ) = = Type : : Category : : RationalNumber )
2020-02-06 13:05:25 +00:00
define ( _unaryOperation ) < < formatNumber ( resultType . literalValue ( nullptr ) ) < < " \n " ;
2019-05-13 13:26:55 +00:00
else if ( resultType . category ( ) = = Type : : Category : : Integer )
{
solAssert ( resultType = = type ( _unaryOperation . subExpression ( ) ) , " Result type doesn't match! " ) ;
if ( op = = Token : : Inc | | op = = Token : : Dec )
{
solAssert ( ! ! m_currentLValue , " LValue not retrieved. " ) ;
2020-02-06 13:05:25 +00:00
IRVariable modifiedValue ( m_context . newYulVariable ( ) , resultType ) ;
IRVariable originalValue = readFromLValue ( * m_currentLValue ) ;
2019-05-13 13:26:55 +00:00
2020-02-06 13:05:25 +00:00
define ( modifiedValue ) < <
2019-05-13 13:26:55 +00:00
( op = = Token : : Inc ?
m_utils . incrementCheckedFunction ( resultType ) :
m_utils . decrementCheckedFunction ( resultType )
) < <
" ( " < <
2020-02-06 13:05:25 +00:00
originalValue . name ( ) < <
2019-05-16 16:59:29 +00:00
" ) \n " ;
2020-02-06 13:05:25 +00:00
writeToLValue ( * m_currentLValue , modifiedValue ) ;
2019-05-16 16:59:29 +00:00
m_currentLValue . reset ( ) ;
2019-05-13 13:26:55 +00:00
2020-02-06 13:05:25 +00:00
define ( _unaryOperation , _unaryOperation . isPrefixOperation ( ) ? modifiedValue : originalValue ) ;
2019-05-13 13:26:55 +00:00
}
else if ( op = = Token : : BitNot )
appendSimpleUnaryOperation ( _unaryOperation , _unaryOperation . subExpression ( ) ) ;
2019-05-16 16:59:29 +00:00
else if ( op = = Token : : Add )
// According to SyntaxChecker...
solAssert ( false , " Use of unary + is disallowed. " ) ;
else if ( op = = Token : : Sub )
{
IntegerType const & intType = * dynamic_cast < IntegerType const * > ( & resultType ) ;
2020-02-06 13:05:25 +00:00
define ( _unaryOperation ) < <
2019-05-16 16:59:29 +00:00
m_utils . negateNumberCheckedFunction ( intType ) < <
" ( " < <
2020-02-06 13:05:25 +00:00
IRVariable ( _unaryOperation . subExpression ( ) ) . name ( ) < <
2019-05-16 16:59:29 +00:00
" ) \n " ;
}
2019-05-13 13:26:55 +00:00
else
solUnimplementedAssert ( false , " Unary operator not yet implemented " ) ;
}
else if ( resultType . category ( ) = = Type : : Category : : Bool )
{
2019-05-16 16:59:29 +00:00
solAssert (
_unaryOperation . getOperator ( ) ! = Token : : BitNot ,
" Bitwise Negation can't be done on bool! "
) ;
appendSimpleUnaryOperation ( _unaryOperation , _unaryOperation . subExpression ( ) ) ;
2019-05-13 13:26:55 +00:00
}
2019-05-02 12:25:15 +00:00
else
2019-05-13 13:26:55 +00:00
solUnimplementedAssert ( false , " Unary operator not yet implemented " ) ;
}
2019-05-02 16:09:19 +00:00
bool IRGeneratorForStatements : : visit ( BinaryOperation const & _binOp )
2019-03-18 10:21:41 +00:00
{
2019-04-24 22:10:29 +00:00
solAssert ( ! ! _binOp . annotation ( ) . commonType , " " ) ;
TypePointer commonType = _binOp . annotation ( ) . commonType ;
2019-05-02 12:25:23 +00:00
langutil : : Token op = _binOp . getOperator ( ) ;
2019-04-24 22:10:29 +00:00
2019-05-02 12:25:23 +00:00
if ( op = = Token : : And | | op = = Token : : Or )
2019-05-02 16:09:19 +00:00
{
// This can short-circuit!
appendAndOrOperatorCode ( _binOp ) ;
return false ;
}
_binOp . leftExpression ( ) . accept ( * this ) ;
_binOp . rightExpression ( ) . accept ( * this ) ;
if ( commonType - > category ( ) = = Type : : Category : : RationalNumber )
2020-02-06 13:05:25 +00:00
define ( _binOp ) < < toCompactHexWithPrefix ( commonType - > literalValue ( nullptr ) ) < < " \n " ;
2019-05-02 12:25:23 +00:00
else if ( TokenTraits : : isCompareOp ( op ) )
{
2019-05-21 12:40:28 +00:00
if ( auto type = dynamic_cast < FunctionType const * > ( commonType ) )
{
solAssert ( op = = Token : : Equal | | op = = Token : : NotEqual , " Invalid function pointer comparison! " ) ;
solAssert ( type - > kind ( ) ! = FunctionType : : Kind : : External , " External function comparison not allowed! " ) ;
}
2019-05-02 12:25:23 +00:00
solAssert ( commonType - > isValueType ( ) , " " ) ;
bool isSigned = false ;
if ( auto type = dynamic_cast < IntegerType const * > ( commonType ) )
isSigned = type - > isSigned ( ) ;
string args =
2020-05-05 11:06:01 +00:00
expressionAsType ( _binOp . leftExpression ( ) , * commonType , true ) +
2019-05-02 12:25:23 +00:00
" , " +
2020-05-05 11:06:01 +00:00
expressionAsType ( _binOp . rightExpression ( ) , * commonType , true ) ;
2019-05-02 12:25:23 +00:00
string expr ;
if ( op = = Token : : Equal )
expr = " eq( " + move ( args ) + " ) " ;
else if ( op = = Token : : NotEqual )
expr = " iszero(eq( " + move ( args ) + " )) " ;
else if ( op = = Token : : GreaterThanOrEqual )
expr = " iszero( " + string ( isSigned ? " slt( " : " lt( " ) + move ( args ) + " )) " ;
else if ( op = = Token : : LessThanOrEqual )
expr = " iszero( " + string ( isSigned ? " sgt( " : " gt( " ) + move ( args ) + " )) " ;
else if ( op = = Token : : GreaterThan )
expr = ( isSigned ? " sgt( " : " gt( " ) + move ( args ) + " ) " ;
else if ( op = = Token : : LessThan )
expr = ( isSigned ? " slt( " : " lt( " ) + move ( args ) + " ) " ;
else
solAssert ( false , " Unknown comparison operator. " ) ;
2020-02-06 13:05:25 +00:00
define ( _binOp ) < < expr < < " \n " ;
2019-05-02 12:25:23 +00:00
}
2020-04-20 21:16:42 +00:00
else if ( TokenTraits : : isShiftOp ( op ) )
{
IRVariable left = convert ( _binOp . leftExpression ( ) , * commonType ) ;
IRVariable right = convert ( _binOp . rightExpression ( ) , * type ( _binOp . rightExpression ( ) ) . mobileType ( ) ) ;
define ( _binOp ) < < shiftOperation ( _binOp . getOperator ( ) , left , right ) < < " \n " ;
}
2019-03-18 10:21:41 +00:00
else
2019-04-24 22:10:29 +00:00
{
2019-05-23 18:17:20 +00:00
string left = expressionAsType ( _binOp . leftExpression ( ) , * commonType ) ;
string right = expressionAsType ( _binOp . rightExpression ( ) , * commonType ) ;
2020-02-06 13:05:25 +00:00
define ( _binOp ) < < binaryOperation ( _binOp . getOperator ( ) , * commonType , left , right ) < < " \n " ;
2019-04-24 22:10:29 +00:00
}
2019-05-02 16:09:19 +00:00
return false ;
2019-03-18 10:21:41 +00:00
}
2019-05-02 19:22:23 +00:00
void IRGeneratorForStatements : : endVisit ( FunctionCall const & _functionCall )
2019-04-02 10:37:48 +00:00
{
2019-04-16 10:25:30 +00:00
solUnimplementedAssert (
_functionCall . annotation ( ) . kind = = FunctionCallKind : : FunctionCall | |
_functionCall . annotation ( ) . kind = = FunctionCallKind : : TypeConversion ,
" This type of function call is not yet implemented "
) ;
2019-05-06 09:09:50 +00:00
Type const & funcType = type ( _functionCall . expression ( ) ) ;
2019-04-16 10:25:30 +00:00
if ( _functionCall . annotation ( ) . kind = = FunctionCallKind : : TypeConversion )
{
2019-05-06 09:09:50 +00:00
solAssert ( funcType . category ( ) = = Type : : Category : : TypeType , " Expected category to be TypeType " ) ;
2019-04-16 10:25:30 +00:00
solAssert ( _functionCall . arguments ( ) . size ( ) = = 1 , " Expected one argument for type conversion " ) ;
2020-02-06 13:05:25 +00:00
define ( _functionCall , * _functionCall . arguments ( ) . front ( ) ) ;
2019-05-02 19:22:23 +00:00
return ;
2019-04-16 10:25:30 +00:00
}
2019-05-06 09:09:50 +00:00
FunctionTypePointer functionType = dynamic_cast < FunctionType const * > ( & funcType ) ;
2019-04-02 10:37:48 +00:00
TypePointers parameterTypes = functionType - > parameterTypes ( ) ;
vector < ASTPointer < Expression const > > const & callArguments = _functionCall . arguments ( ) ;
vector < ASTPointer < ASTString > > const & callArgumentNames = _functionCall . names ( ) ;
if ( ! functionType - > takesArbitraryParameters ( ) )
solAssert ( callArguments . size ( ) = = parameterTypes . size ( ) , " " ) ;
vector < ASTPointer < Expression const > > arguments ;
if ( callArgumentNames . empty ( ) )
// normal arguments
arguments = callArguments ;
else
// named arguments
for ( auto const & parameterName : functionType - > parameterNames ( ) )
{
auto const it = std : : find_if ( callArgumentNames . cbegin ( ) , callArgumentNames . cend ( ) , [ & ] ( ASTPointer < ASTString > const & _argName ) {
return * _argName = = parameterName ;
} ) ;
solAssert ( it ! = callArgumentNames . cend ( ) , " " ) ;
arguments . push_back ( callArguments [ std : : distance ( callArgumentNames . begin ( ) , it ) ] ) ;
}
2020-04-23 13:59:42 +00:00
if ( auto memberAccess = dynamic_cast < MemberAccess const * > ( & _functionCall . expression ( ) ) )
if ( auto expressionType = dynamic_cast < TypeType const * > ( memberAccess - > expression ( ) . annotation ( ) . type ) )
if ( auto contractType = dynamic_cast < ContractType const * > ( expressionType - > actualType ( ) ) )
solUnimplementedAssert (
! contractType - > contractDefinition ( ) . isLibrary ( ) | | functionType - > kind ( ) = = FunctionType : : Kind : : Internal ,
" Only internal function calls implemented for libraries "
) ;
2019-04-02 10:37:48 +00:00
solUnimplementedAssert ( ! functionType - > bound ( ) , " " ) ;
switch ( functionType - > kind ( ) )
{
2020-04-27 11:03:44 +00:00
case FunctionType : : Kind : : Declaration :
solAssert ( false , " Attempted to generate code for calling a function definition. " ) ;
break ;
2019-04-02 10:37:48 +00:00
case FunctionType : : Kind : : Internal :
{
2020-04-20 21:21:09 +00:00
optional < FunctionDefinition const * > functionDef ;
if ( auto memberAccess = dynamic_cast < MemberAccess const * > ( & _functionCall . expression ( ) ) )
2019-04-02 10:37:48 +00:00
{
2020-04-23 13:59:42 +00:00
solUnimplementedAssert ( ! functionType - > bound ( ) , " Internal calls to bound functions are not yet implemented for libraries and not allowed for contracts " ) ;
2020-04-20 21:21:09 +00:00
functionDef = dynamic_cast < FunctionDefinition const * > ( memberAccess - > annotation ( ) . referencedDeclaration ) ;
if ( functionDef . value ( ) ! = nullptr )
solAssert ( functionType - > declaration ( ) = = * memberAccess - > annotation ( ) . referencedDeclaration , " " ) ;
else
2019-04-02 10:37:48 +00:00
{
2020-04-20 21:21:09 +00:00
solAssert ( dynamic_cast < VariableDeclaration const * > ( memberAccess - > annotation ( ) . referencedDeclaration ) , " " ) ;
solAssert ( ! functionType - > hasDeclaration ( ) , " " ) ;
2019-04-02 10:37:48 +00:00
}
}
2020-04-20 21:21:09 +00:00
else if ( auto identifier = dynamic_cast < Identifier const * > ( & _functionCall . expression ( ) ) )
{
solAssert ( ! functionType - > bound ( ) , " " ) ;
2019-04-02 10:37:48 +00:00
2020-04-20 21:21:09 +00:00
if ( auto unresolvedFunctionDef = dynamic_cast < FunctionDefinition const * > ( identifier - > annotation ( ) . referencedDeclaration ) )
{
functionDef = & unresolvedFunctionDef - > resolveVirtual ( m_context . mostDerivedContract ( ) ) ;
solAssert ( functionType - > declaration ( ) = = * identifier - > annotation ( ) . referencedDeclaration , " " ) ;
}
else
{
functionDef = nullptr ;
solAssert ( dynamic_cast < VariableDeclaration const * > ( identifier - > annotation ( ) . referencedDeclaration ) , " " ) ;
solAssert ( ! functionType - > hasDeclaration ( ) , " " ) ;
}
}
else
// Not a simple expression like x or A.x
functionDef = nullptr ;
solAssert ( functionDef . has_value ( ) , " " ) ;
solAssert ( functionDef . value ( ) = = nullptr | | functionDef . value ( ) - > isImplemented ( ) , " " ) ;
2020-05-07 15:29:42 +00:00
vector < string > args ;
for ( size_t i = 0 ; i < arguments . size ( ) ; + + i )
if ( functionType - > takesArbitraryParameters ( ) )
args + = IRVariable ( * arguments [ i ] ) . stackSlots ( ) ;
else
args + = convert ( * arguments [ i ] , * parameterTypes [ i ] ) . stackSlots ( ) ;
2020-04-20 21:21:09 +00:00
if ( functionDef . value ( ) ! = nullptr )
define ( _functionCall ) < <
m_context . enqueueFunctionForCodeGeneration ( * functionDef . value ( ) ) < <
" ( " < <
joinHumanReadable ( args ) < <
" ) \n " ;
else
define ( _functionCall ) < <
// NOTE: internalDispatch() takes care of adding the function to function generation queue
m_context . internalDispatch (
TupleType ( functionType - > parameterTypes ( ) ) . sizeOnStack ( ) ,
TupleType ( functionType - > returnParameterTypes ( ) ) . sizeOnStack ( )
) < <
" ( " < <
IRVariable ( _functionCall . expression ( ) ) . part ( " functionIdentifier " ) . name ( ) < <
joinHumanReadablePrefixed ( args ) < <
" ) \n " ;
2019-04-02 10:37:48 +00:00
break ;
}
2019-05-06 17:48:31 +00:00
case FunctionType : : Kind : : External :
case FunctionType : : Kind : : DelegateCall :
case FunctionType : : Kind : : BareCall :
case FunctionType : : Kind : : BareDelegateCall :
case FunctionType : : Kind : : BareStaticCall :
appendExternalFunctionCall ( _functionCall , arguments ) ;
break ;
case FunctionType : : Kind : : BareCallCode :
solAssert ( false , " Callcode has been removed. " ) ;
2019-05-02 20:33:47 +00:00
case FunctionType : : Kind : : Event :
{
auto const & event = dynamic_cast < EventDefinition const & > ( functionType - > declaration ( ) ) ;
TypePointers paramTypes = functionType - > parameterTypes ( ) ;
2020-01-22 14:48:56 +00:00
ABIFunctions abi ( m_context . evmVersion ( ) , m_context . revertStrings ( ) , m_context . functionCollector ( ) ) ;
2019-05-02 20:33:47 +00:00
2020-02-06 13:05:25 +00:00
vector < IRVariable > indexedArgs ;
2020-05-07 15:29:42 +00:00
vector < string > nonIndexedArgs ;
2019-05-02 20:33:47 +00:00
TypePointers nonIndexedArgTypes ;
TypePointers nonIndexedParamTypes ;
if ( ! event . isAnonymous ( ) )
2020-02-06 13:05:25 +00:00
define ( indexedArgs . emplace_back ( m_context . newYulVariable ( ) , * TypeProvider : : uint256 ( ) ) ) < <
formatNumber ( u256 ( h256 : : Arith ( keccak256 ( functionType - > externalSignature ( ) ) ) ) ) < < " \n " ;
2019-05-02 20:33:47 +00:00
for ( size_t i = 0 ; i < event . parameters ( ) . size ( ) ; + + i )
{
Expression const & arg = * arguments [ i ] ;
if ( event . parameters ( ) [ i ] - > isIndexed ( ) )
{
string value ;
if ( auto const & referenceType = dynamic_cast < ReferenceType const * > ( paramTypes [ i ] ) )
2020-02-06 13:05:25 +00:00
define ( indexedArgs . emplace_back ( m_context . newYulVariable ( ) , * TypeProvider : : uint256 ( ) ) ) < <
m_utils . packedHashFunction ( { arg . annotation ( ) . type } , { referenceType } ) < <
" ( " < <
IRVariable ( arg ) . commaSeparatedList ( ) < <
2019-05-02 20:33:47 +00:00
" ) " ;
else
2020-02-06 13:05:25 +00:00
indexedArgs . emplace_back ( convert ( arg , * paramTypes [ i ] ) ) ;
2019-05-02 20:33:47 +00:00
}
else
{
2020-05-07 15:29:42 +00:00
nonIndexedArgs + = IRVariable ( arg ) . stackSlots ( ) ;
2019-05-02 20:33:47 +00:00
nonIndexedArgTypes . push_back ( arg . annotation ( ) . type ) ;
nonIndexedParamTypes . push_back ( paramTypes [ i ] ) ;
}
}
solAssert ( indexedArgs . size ( ) < = 4 , " Too many indexed arguments. " ) ;
Whiskers templ ( R " ({
2020-02-10 10:44:52 +00:00
let < pos > : = < freeMemory >
2019-05-02 20:33:47 +00:00
let < end > : = < encode > ( < pos > < nonIndexedArgs > )
< log > ( < pos > , sub ( < end > , < pos > ) < indexedArgs > )
} ) " );
templ ( " pos " , m_context . newYulVariable ( ) ) ;
templ ( " end " , m_context . newYulVariable ( ) ) ;
2020-02-10 10:44:52 +00:00
templ ( " freeMemory " , freeMemory ( ) ) ;
2019-05-02 20:33:47 +00:00
templ ( " encode " , abi . tupleEncoder ( nonIndexedArgTypes , nonIndexedParamTypes ) ) ;
2020-05-07 15:29:42 +00:00
templ ( " nonIndexedArgs " , joinHumanReadablePrefixed ( nonIndexedArgs ) ) ;
2019-05-02 20:33:47 +00:00
templ ( " log " , " log " + to_string ( indexedArgs . size ( ) ) ) ;
2020-02-06 13:05:25 +00:00
templ ( " indexedArgs " , joinHumanReadablePrefixed ( indexedArgs | boost : : adaptors : : transformed ( [ & ] ( auto const & _arg ) {
return _arg . commaSeparatedList ( ) ;
} ) ) ) ;
2019-05-02 20:33:47 +00:00
m_code < < templ . render ( ) ;
break ;
}
2019-04-30 17:08:02 +00:00
case FunctionType : : Kind : : Assert :
case FunctionType : : Kind : : Require :
{
solAssert ( arguments . size ( ) > 0 , " Expected at least one parameter for require/assert " ) ;
solAssert ( arguments . size ( ) < = 2 , " Expected no more than two parameters for require/assert " ) ;
2019-06-06 11:17:08 +00:00
Type const * messageArgumentType = arguments . size ( ) > 1 ? arguments [ 1 ] - > annotation ( ) . type : nullptr ;
2019-04-30 17:08:02 +00:00
string requireOrAssertFunction = m_utils . requireOrAssertFunction (
functionType - > kind ( ) = = FunctionType : : Kind : : Assert ,
2019-06-06 11:17:08 +00:00
messageArgumentType
2019-04-30 17:08:02 +00:00
) ;
2020-02-06 13:05:25 +00:00
m_code < < move ( requireOrAssertFunction ) < < " ( " < < IRVariable ( * arguments [ 0 ] ) . name ( ) ;
2019-06-06 11:17:08 +00:00
if ( messageArgumentType & & messageArgumentType - > sizeOnStack ( ) > 0 )
2020-02-06 13:05:25 +00:00
m_code < < " , " < < IRVariable ( * arguments [ 1 ] ) . commaSeparatedList ( ) ;
2019-04-30 17:08:02 +00:00
m_code < < " ) \n " ;
break ;
}
2020-04-30 15:17:29 +00:00
case FunctionType : : Kind : : Revert :
{
solAssert ( arguments . size ( ) = = parameterTypes . size ( ) , " " ) ;
if ( arguments . empty ( ) )
m_code < < " revert(0, 0) \n " ;
else
2020-05-04 21:04:03 +00:00
{
solAssert ( arguments . size ( ) = = 1 , " " ) ;
if ( m_context . revertStrings ( ) = = RevertStrings : : Strip )
m_code < < " revert(0, 0) \n " ;
else
{
solAssert ( type ( * arguments . front ( ) ) . isImplicitlyConvertibleTo ( * TypeProvider : : stringMemory ( ) ) , " " ) ;
Whiskers templ ( R " ({
let < pos > : = < allocateTemporary > ( )
mstore ( < pos > , < hash > )
let < end > : = < encode > ( add ( < pos > , 4 ) < argumentVars > )
revert ( < pos > , sub ( < end > , < pos > ) )
} ) " );
templ ( " pos " , m_context . newYulVariable ( ) ) ;
templ ( " end " , m_context . newYulVariable ( ) ) ;
templ (
" hash " ,
( u256 ( util : : FixedHash < 4 > : : Arith ( util : : FixedHash < 4 > ( util : : keccak256 ( " Error(string) " ) ) ) ) < < ( 256 - 32 ) ) . str ( )
) ;
templ ( " allocateTemporary " , m_utils . allocationTemporaryMemoryFunction ( ) ) ;
templ (
" argumentVars " ,
2020-05-07 15:29:42 +00:00
joinHumanReadablePrefixed ( IRVariable { * arguments . front ( ) } . stackSlots ( ) )
2020-05-04 21:04:03 +00:00
) ;
templ ( " encode " , m_context . abiFunctions ( ) . tupleEncoder (
{ & type ( * arguments . front ( ) ) } ,
{ TypeProvider : : stringMemory ( ) }
) ) ;
m_code < < templ . render ( ) ;
}
}
2020-04-30 15:17:29 +00:00
break ;
}
2019-06-27 11:36:06 +00:00
// Array creation using new
case FunctionType : : Kind : : ObjectCreation :
{
ArrayType const & arrayType = dynamic_cast < ArrayType const & > ( * _functionCall . annotation ( ) . type ) ;
solAssert ( arguments . size ( ) = = 1 , " " ) ;
2020-02-06 13:05:25 +00:00
IRVariable value = convert ( * arguments [ 0 ] , * TypeProvider : : uint256 ( ) ) ;
define ( _functionCall ) < <
2020-03-02 20:42:46 +00:00
m_utils . allocateAndInitializeMemoryArrayFunction ( arrayType ) < <
2019-06-27 11:36:06 +00:00
" ( " < <
2020-02-06 13:05:25 +00:00
value . commaSeparatedList ( ) < <
2019-06-27 11:36:06 +00:00
" ) \n " ;
break ;
}
2019-07-08 19:57:02 +00:00
case FunctionType : : Kind : : KECCAK256 :
{
solAssert ( arguments . size ( ) = = 1 , " " ) ;
ArrayType const * arrayType = TypeProvider : : bytesMemory ( ) ;
2020-02-06 13:05:25 +00:00
auto array = convert ( * arguments [ 0 ] , * arrayType ) ;
2019-07-08 19:57:02 +00:00
2020-02-06 13:05:25 +00:00
define ( _functionCall ) < <
2019-07-08 19:57:02 +00:00
" keccak256( " < <
2020-02-06 13:05:25 +00:00
m_utils . arrayDataAreaFunction ( * arrayType ) < <
" ( " < <
array . commaSeparatedList ( ) < <
2019-07-08 19:57:02 +00:00
" ), " < <
m_utils . arrayLengthFunction ( * arrayType ) < <
" ( " < <
2020-02-06 13:05:25 +00:00
array . commaSeparatedList ( ) < <
2019-07-08 19:57:02 +00:00
" )) \n " ;
2020-02-06 13:05:25 +00:00
break ;
2019-11-07 20:22:58 +00:00
}
2020-04-20 21:26:00 +00:00
case FunctionType : : Kind : : ECRecover :
case FunctionType : : Kind : : SHA256 :
case FunctionType : : Kind : : RIPEMD160 :
{
solAssert ( ! _functionCall . annotation ( ) . tryCall , " " ) ;
appendExternalFunctionCall ( _functionCall , arguments ) ;
break ;
}
2019-11-07 20:22:58 +00:00
case FunctionType : : Kind : : ArrayPop :
{
2020-02-06 13:05:25 +00:00
auto const & memberAccessExpression = dynamic_cast < MemberAccess const & > ( _functionCall . expression ( ) ) . expression ( ) ;
ArrayType const & arrayType = dynamic_cast < ArrayType const & > ( * memberAccessExpression . annotation ( ) . type ) ;
define ( _functionCall ) < <
2019-11-07 20:22:58 +00:00
m_utils . storageArrayPopFunction ( arrayType ) < <
" ( " < <
2020-02-06 13:05:25 +00:00
IRVariable ( _functionCall . expression ( ) ) . commaSeparatedList ( ) < <
2019-11-07 20:22:58 +00:00
" ) \n " ;
break ;
}
case FunctionType : : Kind : : ArrayPush :
{
2020-02-06 13:05:25 +00:00
auto const & memberAccessExpression = dynamic_cast < MemberAccess const & > ( _functionCall . expression ( ) ) . expression ( ) ;
ArrayType const & arrayType = dynamic_cast < ArrayType const & > ( * memberAccessExpression . annotation ( ) . type ) ;
2019-11-28 17:05:11 +00:00
if ( arguments . empty ( ) )
{
auto slotName = m_context . newYulVariable ( ) ;
auto offsetName = m_context . newYulVariable ( ) ;
m_code < < " let " < < slotName < < " , " < < offsetName < < " := " < <
m_utils . storageArrayPushZeroFunction ( arrayType ) < <
2020-02-06 13:05:25 +00:00
" ( " < < IRVariable ( _functionCall . expression ( ) ) . commaSeparatedList ( ) < < " ) \n " ;
setLValue ( _functionCall , IRLValue {
* arrayType . baseType ( ) ,
IRLValue : : Storage {
slotName ,
offsetName ,
}
} ) ;
2019-11-28 17:05:11 +00:00
}
else
2020-02-06 13:05:25 +00:00
{
IRVariable argument = convert ( * arguments . front ( ) , * arrayType . baseType ( ) ) ;
2019-11-28 17:05:11 +00:00
m_code < <
m_utils . storageArrayPushFunction ( arrayType ) < <
" ( " < <
2020-02-06 13:05:25 +00:00
IRVariable ( _functionCall . expression ( ) ) . commaSeparatedList ( ) < <
2019-11-28 17:05:11 +00:00
" , " < <
2020-02-06 13:05:25 +00:00
argument . commaSeparatedList ( ) < <
2019-11-28 17:05:11 +00:00
" ) \n " ;
2020-02-06 13:05:25 +00:00
}
2019-07-08 19:57:02 +00:00
break ;
}
2020-04-08 22:08:49 +00:00
case FunctionType : : Kind : : MetaType :
{
break ;
}
2020-04-26 00:18:10 +00:00
case FunctionType : : Kind : : AddMod :
case FunctionType : : Kind : : MulMod :
2020-04-23 22:14:03 +00:00
{
2020-04-26 00:18:10 +00:00
static map < FunctionType : : Kind , string > functions = {
{ FunctionType : : Kind : : AddMod , " addmod " } ,
{ FunctionType : : Kind : : MulMod , " mulmod " } ,
} ;
solAssert ( functions . find ( functionType - > kind ( ) ) ! = functions . end ( ) , " " ) ;
solAssert ( arguments . size ( ) = = 3 & & parameterTypes . size ( ) = = 3 , " " ) ;
IRVariable modulus ( m_context . newYulVariable ( ) , * ( parameterTypes [ 2 ] ) ) ;
define ( modulus , * arguments [ 2 ] ) ;
Whiskers templ ( " if iszero(<modulus>) { invalid ( ) } \ n " );
m_code < < templ ( " modulus " , modulus . name ( ) ) . render ( ) ;
string args ;
for ( size_t i = 0 ; i < 2 ; + + i )
args + = expressionAsType ( * arguments [ i ] , * ( parameterTypes [ i ] ) ) + " , " ;
args + = modulus . name ( ) ;
define ( _functionCall ) < < functions [ functionType - > kind ( ) ] < < " ( " < < args < < " ) \n " ;
2020-04-23 22:14:03 +00:00
break ;
}
2020-04-26 00:18:10 +00:00
case FunctionType : : Kind : : GasLeft :
2020-04-24 22:03:41 +00:00
case FunctionType : : Kind : : Selfdestruct :
2020-04-26 00:18:10 +00:00
case FunctionType : : Kind : : BlockHash :
2020-04-24 22:03:41 +00:00
{
2020-04-26 00:18:10 +00:00
static map < FunctionType : : Kind , string > functions = {
{ FunctionType : : Kind : : GasLeft , " gas " } ,
{ FunctionType : : Kind : : Selfdestruct , " selfdestruct " } ,
{ FunctionType : : Kind : : BlockHash , " blockhash " } ,
} ;
solAssert ( functions . find ( functionType - > kind ( ) ) ! = functions . end ( ) , " " ) ;
string args ;
for ( size_t i = 0 ; i < arguments . size ( ) ; + + i )
args + = ( args . empty ( ) ? " " : " , " ) + expressionAsType ( * arguments [ i ] , * ( parameterTypes [ i ] ) ) ;
define ( _functionCall ) < < functions [ functionType - > kind ( ) ] < < " ( " < < args < < " ) \n " ;
2020-04-24 22:03:41 +00:00
break ;
}
2020-04-24 21:33:43 +00:00
case FunctionType : : Kind : : Log0 :
case FunctionType : : Kind : : Log1 :
case FunctionType : : Kind : : Log2 :
case FunctionType : : Kind : : Log3 :
case FunctionType : : Kind : : Log4 :
{
unsigned logNumber = int ( functionType - > kind ( ) ) - int ( FunctionType : : Kind : : Log0 ) ;
solAssert ( arguments . size ( ) = = logNumber + 1 , " " ) ;
ABIFunctions abi ( m_context . evmVersion ( ) , m_context . revertStrings ( ) , m_context . functionCollector ( ) ) ;
string indexedArgs ;
for ( unsigned arg = 0 ; arg < logNumber ; + + arg )
indexedArgs + = " , " + expressionAsType ( * arguments [ arg + 1 ] , * ( parameterTypes [ arg + 1 ] ) ) ;
Whiskers templ ( R " ({
let < pos > : = < freeMemory >
let < end > : = < encode > ( < pos > , < nonIndexedArgs > )
< log > ( < pos > , sub ( < end > , < pos > ) < indexedArgs > )
} ) " );
templ ( " pos " , m_context . newYulVariable ( ) ) ;
templ ( " end " , m_context . newYulVariable ( ) ) ;
templ ( " freeMemory " , freeMemory ( ) ) ;
2020-04-09 19:59:17 +00:00
templ ( " encode " , abi . tupleEncoder ( { arguments . front ( ) - > annotation ( ) . type } , { parameterTypes . front ( ) } ) ) ;
2020-04-24 21:33:43 +00:00
templ ( " nonIndexedArgs " , IRVariable ( * arguments . front ( ) ) . commaSeparatedList ( ) ) ;
templ ( " log " , " log " + to_string ( logNumber ) ) ;
templ ( " indexedArgs " , indexedArgs ) ;
m_code < < templ . render ( ) ;
2020-04-09 19:59:17 +00:00
break ;
}
case FunctionType : : Kind : : Creation :
{
solAssert ( ! functionType - > gasSet ( ) , " Gas limit set for contract creation. " ) ;
solAssert (
functionType - > returnParameterTypes ( ) . size ( ) = = 1 ,
" Constructor should return only one type "
) ;
TypePointers argumentTypes ;
2020-05-07 15:29:42 +00:00
vector < string > constructorParams ;
2020-04-09 19:59:17 +00:00
for ( ASTPointer < Expression const > const & arg : arguments )
{
argumentTypes . push_back ( arg - > annotation ( ) . type ) ;
2020-05-07 15:29:42 +00:00
constructorParams + = IRVariable { * arg } . stackSlots ( ) ;
2020-04-09 19:59:17 +00:00
}
ContractDefinition const * contract =
& dynamic_cast < ContractType const & > ( * functionType - > returnParameterTypes ( ) . front ( ) ) . contractDefinition ( ) ;
m_context . subObjectsCreated ( ) . insert ( contract ) ;
Whiskers t ( R " (
let < memPos > : = < allocateTemporaryMemory > ( )
let < memEnd > : = add ( < memPos > , datasize ( " <object> " ) )
if or ( gt ( < memEnd > , 0xffffffffffffffff ) , lt ( < memEnd > , < memPos > ) ) { revert ( 0 , 0 ) }
datacopy ( < memPos > , dataoffset ( " <object> " ) , datasize ( " <object> " ) )
< memEnd > : = < abiEncode > ( < memEnd > < constructorParams > )
< ? saltSet >
let < retVars > : = create2 ( < value > , < memPos > , sub ( < memEnd > , < memPos > ) , < salt > )
< ! saltSet >
let < retVars > : = create ( < value > , < memPos > , sub ( < memEnd > , < memPos > ) )
< / saltSet >
< releaseTemporaryMemory > ( )
) " );
t ( " memPos " , m_context . newYulVariable ( ) ) ;
t ( " memEnd " , m_context . newYulVariable ( ) ) ;
t ( " allocateTemporaryMemory " , m_utils . allocationTemporaryMemoryFunction ( ) ) ;
t ( " releaseTemporaryMemory " , m_utils . releaseTemporaryMemoryFunction ( ) ) ;
t ( " object " , m_context . creationObjectName ( * contract ) ) ;
t ( " abiEncode " ,
2020-05-06 23:55:30 +00:00
m_context . abiFunctions ( ) . tupleEncoder ( argumentTypes , functionType - > parameterTypes ( ) , false )
2020-04-09 19:59:17 +00:00
) ;
2020-05-07 15:29:42 +00:00
t ( " constructorParams " , joinHumanReadablePrefixed ( constructorParams ) ) ;
2020-04-09 19:59:17 +00:00
t ( " value " , functionType - > valueSet ( ) ? IRVariable ( _functionCall . expression ( ) ) . part ( " value " ) . name ( ) : " 0 " ) ;
t ( " saltSet " , functionType - > saltSet ( ) ) ;
if ( functionType - > saltSet ( ) )
t ( " salt " , IRVariable ( _functionCall . expression ( ) ) . part ( " salt " ) . name ( ) ) ;
t ( " retVars " , IRVariable ( _functionCall ) . commaSeparatedList ( ) ) ;
m_code < < t . render ( ) ;
2020-04-24 21:33:43 +00:00
break ;
}
2020-04-30 15:17:29 +00:00
case FunctionType : : Kind : : Send :
case FunctionType : : Kind : : Transfer :
{
solAssert ( arguments . size ( ) = = 1 & & parameterTypes . size ( ) = = 1 , " " ) ;
string address { IRVariable ( _functionCall . expression ( ) ) . part ( " address " ) . name ( ) } ;
string value { expressionAsType ( * arguments [ 0 ] , * ( parameterTypes [ 0 ] ) ) } ;
Whiskers templ ( R " (
let < gas > : = 0
if iszero ( < value > ) { < gas > : = < callStipend > }
let < success > : = call ( < gas > , < address > , < value > , 0 , 0 , 0 , 0 )
< ? isTransfer >
if iszero ( < success > ) { < forwardingRevert > ( ) }
< / isTransfer >
) " );
templ ( " gas " , m_context . newYulVariable ( ) ) ;
templ ( " callStipend " , toString ( evmasm : : GasCosts : : callStipend ) ) ;
templ ( " address " , address ) ;
templ ( " value " , value ) ;
if ( functionType - > kind ( ) = = FunctionType : : Kind : : Transfer )
templ ( " success " , m_context . newYulVariable ( ) ) ;
else
templ ( " success " , IRVariable ( _functionCall ) . commaSeparatedList ( ) ) ;
templ ( " isTransfer " , functionType - > kind ( ) = = FunctionType : : Kind : : Transfer ) ;
templ ( " forwardingRevert " , m_utils . forwardingRevertFunction ( ) ) ;
m_code < < templ . render ( ) ;
break ;
}
2019-04-02 10:37:48 +00:00
default :
2019-06-27 11:36:06 +00:00
solUnimplemented ( " FunctionKind " + toString ( static_cast < int > ( functionType - > kind ( ) ) ) + " not yet implemented " ) ;
2019-04-02 10:37:48 +00:00
}
}
2020-01-23 09:53:04 +00:00
void IRGeneratorForStatements : : endVisit ( FunctionCallOptions const & _options )
{
FunctionType const & previousType = dynamic_cast < FunctionType const & > ( * _options . expression ( ) . annotation ( ) . type ) ;
solUnimplementedAssert ( ! previousType . bound ( ) , " " ) ;
// Copy over existing values.
for ( auto const & item : previousType . stackItems ( ) )
define ( IRVariable ( _options ) . part ( get < 0 > ( item ) ) , IRVariable ( _options . expression ( ) ) . part ( get < 0 > ( item ) ) ) ;
for ( size_t i = 0 ; i < _options . names ( ) . size ( ) ; + + i )
{
string const & name = * _options . names ( ) [ i ] ;
solAssert ( name = = " salt " | | name = = " gas " | | name = = " value " , " " ) ;
define ( IRVariable ( _options ) . part ( name ) , * _options . options ( ) [ i ] ) ;
}
}
2019-05-02 19:17:06 +00:00
void IRGeneratorForStatements : : endVisit ( MemberAccess const & _memberAccess )
{
ASTString const & member = _memberAccess . memberName ( ) ;
if ( auto funType = dynamic_cast < FunctionType const * > ( _memberAccess . annotation ( ) . type ) )
if ( funType - > bound ( ) )
{
solUnimplementedAssert ( false , " " ) ;
}
switch ( _memberAccess . expression ( ) . annotation ( ) . type - > category ( ) )
{
case Type : : Category : : Contract :
{
ContractType const & type = dynamic_cast < ContractType const & > ( * _memberAccess . expression ( ) . annotation ( ) . type ) ;
if ( type . isSuper ( ) )
{
solUnimplementedAssert ( false , " " ) ;
}
// ordinary contract type
else if ( Declaration const * declaration = _memberAccess . annotation ( ) . referencedDeclaration )
{
u256 identifier ;
if ( auto const * variable = dynamic_cast < VariableDeclaration const * > ( declaration ) )
identifier = FunctionType ( * variable ) . externalIdentifier ( ) ;
else if ( auto const * function = dynamic_cast < FunctionDefinition const * > ( declaration ) )
identifier = FunctionType ( * function ) . externalIdentifier ( ) ;
else
solAssert ( false , " Contract member is neither variable nor function. " ) ;
2019-05-06 17:48:31 +00:00
2020-02-06 13:05:25 +00:00
define ( IRVariable ( _memberAccess ) . part ( " address " ) , _memberAccess . expression ( ) ) ;
define ( IRVariable ( _memberAccess ) . part ( " functionIdentifier " ) ) < < formatNumber ( identifier ) < < " \n " ;
2019-05-02 19:17:06 +00:00
}
else
solAssert ( false , " Invalid member access in contract " ) ;
break ;
}
case Type : : Category : : Integer :
{
solAssert ( false , " Invalid member access to integer " ) ;
break ;
}
case Type : : Category : : Address :
{
if ( member = = " balance " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < <
2019-05-02 19:17:06 +00:00
" balance( " < <
expressionAsType ( _memberAccess . expression ( ) , * TypeProvider : : address ( ) ) < <
" ) \n " ;
else if ( set < string > { " send " , " transfer " } . count ( member ) )
{
solAssert ( dynamic_cast < AddressType const & > ( * _memberAccess . expression ( ) . annotation ( ) . type ) . stateMutability ( ) = = StateMutability : : Payable , " " ) ;
2020-02-06 13:05:25 +00:00
define ( IRVariable { _memberAccess } . part ( " address " ) , _memberAccess . expression ( ) ) ;
2019-05-02 19:17:06 +00:00
}
else if ( set < string > { " call " , " callcode " , " delegatecall " , " staticcall " } . count ( member ) )
2020-02-06 13:05:25 +00:00
define ( IRVariable { _memberAccess } . part ( " address " ) , _memberAccess . expression ( ) ) ;
2019-05-02 19:17:06 +00:00
else
solAssert ( false , " Invalid member access to address " ) ;
break ;
}
case Type : : Category : : Function :
if ( member = = " selector " )
{
2020-04-16 11:42:58 +00:00
FunctionType const & functionType = dynamic_cast < FunctionType const & > (
* _memberAccess . expression ( ) . annotation ( ) . type
2020-03-05 18:26:30 +00:00
) ;
2020-04-16 11:42:58 +00:00
if ( functionType . kind ( ) = = FunctionType : : Kind : : External )
define ( IRVariable { _memberAccess } , IRVariable ( _memberAccess . expression ( ) ) . part ( " functionIdentifier " ) ) ;
else if ( functionType . kind ( ) = = FunctionType : : Kind : : Declaration )
{
solAssert ( functionType . hasDeclaration ( ) , " " ) ;
define ( IRVariable { _memberAccess } ) < < formatNumber ( functionType . externalIdentifier ( ) < < 224 ) < < " \n " ;
}
else
solAssert ( false , " Invalid use of .selector " ) ;
2019-05-02 19:17:06 +00:00
}
2019-08-15 11:57:12 +00:00
else if ( member = = " address " )
{
2020-03-05 18:26:30 +00:00
solUnimplementedAssert (
dynamic_cast < FunctionType const & > ( * _memberAccess . expression ( ) . annotation ( ) . type ) . kind ( ) = =
FunctionType : : Kind : : External , " "
) ;
define ( IRVariable { _memberAccess } , IRVariable ( _memberAccess . expression ( ) ) . part ( " address " ) ) ;
2019-08-15 11:57:12 +00:00
}
2019-05-02 19:17:06 +00:00
else
solAssert (
! ! _memberAccess . expression ( ) . annotation ( ) . type - > memberType ( member ) ,
" Invalid member access to function. "
) ;
break ;
case Type : : Category : : Magic :
// we can ignore the kind of magic and only look at the name of the member
if ( member = = " coinbase " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " coinbase() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " timestamp " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " timestamp() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " difficulty " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " difficulty() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " number " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " number() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " gaslimit " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " gaslimit() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " sender " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " caller() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " value " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " callvalue() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " origin " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " origin() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " gasprice " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < " gasprice() \n " ;
2019-05-02 19:17:06 +00:00
else if ( member = = " data " )
2020-02-11 16:43:43 +00:00
{
IRVariable var ( _memberAccess ) ;
declare ( var ) ;
define ( var . part ( " offset " ) ) < < " 0 \n " ;
define ( var . part ( " length " ) ) < < " calldatasize() \n " ;
}
2019-05-02 19:17:06 +00:00
else if ( member = = " sig " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < <
2019-05-02 19:17:06 +00:00
" and(calldataload(0), " < <
formatNumber ( u256 ( 0xffffffff ) < < ( 256 - 32 ) ) < <
" ) \n " ;
else if ( member = = " gas " )
solAssert ( false , " Gas has been removed. " ) ;
else if ( member = = " blockhash " )
solAssert ( false , " Blockhash has been removed. " ) ;
else if ( member = = " creationCode " | | member = = " runtimeCode " )
{
solUnimplementedAssert ( false , " " ) ;
}
else if ( member = = " name " )
{
solUnimplementedAssert ( false , " " ) ;
}
2020-04-08 22:08:49 +00:00
else if ( member = = " interfaceId " )
{
TypePointer arg = dynamic_cast < MagicType const & > ( * _memberAccess . expression ( ) . annotation ( ) . type ) . typeArgument ( ) ;
ContractDefinition const & contract = dynamic_cast < ContractType const & > ( * arg ) . contractDefinition ( ) ;
uint64_t result { 0 } ;
for ( auto const & function : contract . interfaceFunctionList ( false ) )
result ^ = fromBigEndian < uint64_t > ( function . first . ref ( ) ) ;
define ( _memberAccess ) < < formatNumber ( u256 { result } < < ( 256 - 32 ) ) < < " \n " ;
}
2019-05-02 19:17:06 +00:00
else if ( set < string > { " encode " , " encodePacked " , " encodeWithSelector " , " encodeWithSignature " , " decode " } . count ( member ) )
{
// no-op
}
else
solAssert ( false , " Unknown magic member. " ) ;
break ;
case Type : : Category : : Struct :
{
solUnimplementedAssert ( false , " " ) ;
}
case Type : : Category : : Enum :
{
EnumType const & type = dynamic_cast < EnumType const & > ( * _memberAccess . expression ( ) . annotation ( ) . type ) ;
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < to_string ( type . memberValue ( _memberAccess . memberName ( ) ) ) < < " \n " ;
2019-05-02 19:17:06 +00:00
break ;
}
case Type : : Category : : Array :
{
2019-06-06 12:07:40 +00:00
auto const & type = dynamic_cast < ArrayType const & > ( * _memberAccess . expression ( ) . annotation ( ) . type ) ;
2019-11-07 20:22:58 +00:00
if ( member = = " length " )
{
if ( ! type . isDynamicallySized ( ) )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < type . length ( ) < < " \n " ;
2019-11-07 20:22:58 +00:00
else
switch ( type . location ( ) )
{
case DataLocation : : CallData :
2020-02-11 16:43:43 +00:00
define ( _memberAccess , IRVariable ( _memberAccess . expression ( ) ) . part ( " length " ) ) ;
2019-11-07 20:22:58 +00:00
break ;
case DataLocation : : Storage :
{
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < <
m_utils . arrayLengthFunction ( type ) < <
" ( " < <
IRVariable ( _memberAccess . expression ( ) ) . commaSeparatedList ( ) < <
" ) \n " ;
2019-11-07 20:22:58 +00:00
break ;
}
case DataLocation : : Memory :
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < <
2019-11-07 20:22:58 +00:00
" mload( " < <
2020-02-06 13:05:25 +00:00
IRVariable ( _memberAccess . expression ( ) ) . commaSeparatedList ( ) < <
2019-11-07 20:22:58 +00:00
" ) \n " ;
break ;
}
}
2020-02-06 13:05:25 +00:00
else if ( member = = " pop " | | member = = " push " )
2019-11-07 20:22:58 +00:00
{
solAssert ( type . location ( ) = = DataLocation : : Storage , " " ) ;
2020-02-06 13:05:25 +00:00
define ( IRVariable { _memberAccess } . part ( " slot " ) , IRVariable { _memberAccess . expression ( ) } . part ( " slot " ) ) ;
2019-11-07 20:22:58 +00:00
}
2019-06-06 12:07:40 +00:00
else
2019-11-07 20:22:58 +00:00
solAssert ( false , " Invalid array member access. " ) ;
2019-06-06 12:07:40 +00:00
break ;
2019-05-02 19:17:06 +00:00
}
case Type : : Category : : FixedBytes :
{
auto const & type = dynamic_cast < FixedBytesType const & > ( * _memberAccess . expression ( ) . annotation ( ) . type ) ;
if ( member = = " length " )
2020-02-06 13:05:25 +00:00
define ( _memberAccess ) < < to_string ( type . numBytes ( ) ) < < " \n " ;
2019-05-02 19:17:06 +00:00
else
solAssert ( false , " Illegal fixed bytes member. " ) ;
break ;
}
2020-04-16 11:42:58 +00:00
case Type : : Category : : TypeType :
{
2020-04-16 12:21:12 +00:00
Type const & actualType = * dynamic_cast < TypeType const & > (
* _memberAccess . expression ( ) . annotation ( ) . type
) . actualType ( ) ;
if ( actualType . category ( ) = = Type : : Category : : Contract )
{
if ( auto const * variable = dynamic_cast < VariableDeclaration const * > ( _memberAccess . annotation ( ) . referencedDeclaration ) )
handleVariableReference ( * variable , _memberAccess ) ;
else if ( auto const * funType = dynamic_cast < FunctionType const * > ( _memberAccess . annotation ( ) . type ) )
{
switch ( funType - > kind ( ) )
{
case FunctionType : : Kind : : Declaration :
break ;
case FunctionType : : Kind : : Internal :
if ( auto const * function = dynamic_cast < FunctionDefinition const * > ( _memberAccess . annotation ( ) . referencedDeclaration ) )
define ( _memberAccess ) < < to_string ( function - > id ( ) ) < < " \n " ;
else
solAssert ( false , " Function not found in member access " ) ;
break ;
case FunctionType : : Kind : : Event :
solAssert (
dynamic_cast < EventDefinition const * > ( _memberAccess . annotation ( ) . referencedDeclaration ) ,
" Event not found "
) ;
// the call will do the resolving
break ;
case FunctionType : : Kind : : DelegateCall :
define ( IRVariable ( _memberAccess ) . part ( " address " ) , _memberAccess . expression ( ) ) ;
define ( IRVariable ( _memberAccess ) . part ( " functionIdentifier " ) ) < < formatNumber ( funType - > externalIdentifier ( ) ) < < " \n " ;
break ;
case FunctionType : : Kind : : External :
case FunctionType : : Kind : : Creation :
case FunctionType : : Kind : : Send :
case FunctionType : : Kind : : BareCall :
case FunctionType : : Kind : : BareCallCode :
case FunctionType : : Kind : : BareDelegateCall :
case FunctionType : : Kind : : BareStaticCall :
case FunctionType : : Kind : : Transfer :
case FunctionType : : Kind : : Log0 :
case FunctionType : : Kind : : Log1 :
case FunctionType : : Kind : : Log2 :
case FunctionType : : Kind : : Log3 :
case FunctionType : : Kind : : Log4 :
case FunctionType : : Kind : : ECRecover :
case FunctionType : : Kind : : SHA256 :
case FunctionType : : Kind : : RIPEMD160 :
default :
solAssert ( false , " unsupported member function " ) ;
}
}
else if ( dynamic_cast < TypeType const * > ( _memberAccess . annotation ( ) . type ) )
{
// no-op
}
else
// The old code generator had a generic "else" case here
// without any specific code being generated,
// but it would still be better to have an exhaustive list.
solAssert ( false , " " ) ;
}
else if ( EnumType const * enumType = dynamic_cast < EnumType const * > ( & actualType ) )
define ( _memberAccess ) < < to_string ( enumType - > memberValue ( _memberAccess . memberName ( ) ) ) < < " \n " ;
else
// The old code generator had a generic "else" case here
// without any specific code being generated,
// but it would still be better to have an exhaustive list.
solAssert ( false , " " ) ;
2020-04-16 11:42:58 +00:00
break ;
}
2019-05-02 19:17:06 +00:00
default :
solAssert ( false , " Member access to unknown type. " ) ;
}
}
2019-04-11 10:58:27 +00:00
bool IRGeneratorForStatements : : visit ( InlineAssembly const & _inlineAsm )
{
2019-05-22 14:46:04 +00:00
CopyTranslate bodyCopier { _inlineAsm . dialect ( ) , m_context , _inlineAsm . annotation ( ) . externalReferences } ;
2019-04-11 10:58:27 +00:00
yul : : Statement modified = bodyCopier ( _inlineAsm . operations ( ) ) ;
2019-11-19 15:42:49 +00:00
solAssert ( holds_alternative < yul : : Block > ( modified ) , " " ) ;
2019-04-11 10:58:27 +00:00
2020-01-16 11:03:19 +00:00
// Do not provide dialect so that we get the full type information.
2020-04-23 10:13:26 +00:00
m_code < < yul : : AsmPrinter ( ) ( std : : get < yul : : Block > ( modified ) ) < < " \n " ;
2019-04-11 10:58:27 +00:00
return false ;
}
2019-05-02 10:48:34 +00:00
void IRGeneratorForStatements : : endVisit ( IndexAccess const & _indexAccess )
{
Type const & baseType = * _indexAccess . baseExpression ( ) . annotation ( ) . type ;
if ( baseType . category ( ) = = Type : : Category : : Mapping )
{
solAssert ( _indexAccess . indexExpression ( ) , " Index expression expected. " ) ;
MappingType const & mappingType = dynamic_cast < MappingType const & > ( baseType ) ;
Type const & keyType = * _indexAccess . indexExpression ( ) - > annotation ( ) . type ;
solAssert ( keyType . sizeOnStack ( ) < = 1 , " " ) ;
string slot = m_context . newYulVariable ( ) ;
2020-05-07 15:29:42 +00:00
Whiskers templ ( " let <slot> := <indexAccess>(<base><?+key>,<key></+key>) \ n " ) ;
2019-05-02 10:48:34 +00:00
templ ( " slot " , slot ) ;
templ ( " indexAccess " , m_utils . mappingIndexAccessFunction ( mappingType , keyType ) ) ;
2020-02-06 13:05:25 +00:00
templ ( " base " , IRVariable ( _indexAccess . baseExpression ( ) ) . commaSeparatedList ( ) ) ;
2020-05-07 15:29:42 +00:00
templ ( " key " , IRVariable ( * _indexAccess . indexExpression ( ) ) . commaSeparatedList ( ) ) ;
2019-05-02 10:48:34 +00:00
m_code < < templ . render ( ) ;
2020-02-06 13:05:25 +00:00
setLValue ( _indexAccess , IRLValue {
* _indexAccess . annotation ( ) . type ,
IRLValue : : Storage {
slot ,
2020-02-17 17:14:29 +00:00
0u
2020-02-06 13:05:25 +00:00
}
} ) ;
2019-05-02 10:48:34 +00:00
}
2020-03-06 19:59:34 +00:00
else if ( baseType . category ( ) = = Type : : Category : : Array | | baseType . category ( ) = = Type : : Category : : ArraySlice )
2019-06-13 15:22:24 +00:00
{
2020-03-06 19:59:34 +00:00
ArrayType const & arrayType =
baseType . category ( ) = = Type : : Category : : Array ?
dynamic_cast < ArrayType const & > ( baseType ) :
dynamic_cast < ArraySliceType const & > ( baseType ) . arrayType ( ) ;
if ( baseType . category ( ) = = Type : : Category : : ArraySlice )
solAssert ( arrayType . dataStoredIn ( DataLocation : : CallData ) & & arrayType . isDynamicallySized ( ) , " " ) ;
2019-06-13 15:22:24 +00:00
solAssert ( _indexAccess . indexExpression ( ) , " Index expression expected. " ) ;
switch ( arrayType . location ( ) )
{
case DataLocation : : Storage :
{
string slot = m_context . newYulVariable ( ) ;
string offset = m_context . newYulVariable ( ) ;
m_code < < Whiskers ( R " (
let < slot > , < offset > : = < indexFunc > ( < array > , < index > )
) " )
( " slot " , slot )
( " offset " , offset )
( " indexFunc " , m_utils . storageArrayIndexAccessFunction ( arrayType ) )
2020-02-06 13:05:25 +00:00
( " array " , IRVariable ( _indexAccess . baseExpression ( ) ) . part ( " slot " ) . name ( ) )
( " index " , IRVariable ( * _indexAccess . indexExpression ( ) ) . name ( ) )
2019-06-13 15:22:24 +00:00
. render ( ) ;
2020-02-06 13:05:25 +00:00
setLValue ( _indexAccess , IRLValue {
* _indexAccess . annotation ( ) . type ,
IRLValue : : Storage { slot , offset }
} ) ;
2019-06-13 15:22:24 +00:00
break ;
}
case DataLocation : : Memory :
2019-06-27 11:36:06 +00:00
{
string const memAddress =
m_utils . memoryArrayIndexAccessFunction ( arrayType ) +
" ( " +
2020-02-06 13:05:25 +00:00
IRVariable ( _indexAccess . baseExpression ( ) ) . part ( " mpos " ) . name ( ) +
2019-06-27 11:36:06 +00:00
" , " +
expressionAsType ( * _indexAccess . indexExpression ( ) , * TypeProvider : : uint256 ( ) ) +
" ) " ;
2020-02-06 13:05:25 +00:00
setLValue ( _indexAccess , IRLValue {
* arrayType . baseType ( ) ,
IRLValue : : Memory { memAddress }
} ) ;
2019-06-13 15:22:24 +00:00
break ;
2019-06-27 11:36:06 +00:00
}
2019-06-13 15:22:24 +00:00
case DataLocation : : CallData :
2019-06-27 11:36:06 +00:00
{
2020-02-11 16:43:43 +00:00
IRVariable var ( m_context . newYulVariable ( ) , * arrayType . baseType ( ) ) ;
define ( var ) < <
m_utils . calldataArrayIndexAccessFunction ( arrayType ) < <
" ( " < <
IRVariable ( _indexAccess . baseExpression ( ) ) . commaSeparatedList ( ) < <
" , " < <
expressionAsType ( * _indexAccess . indexExpression ( ) , * TypeProvider : : uint256 ( ) ) < <
" ) \n " ;
if ( arrayType . isByteArray ( ) )
define ( _indexAccess ) < <
m_utils . cleanupFunction ( * arrayType . baseType ( ) ) < <
" (calldataload( " < <
var . name ( ) < <
" )) \n " ;
else if ( arrayType . baseType ( ) - > isValueType ( ) )
define ( _indexAccess ) < <
m_utils . readFromCalldata ( * arrayType . baseType ( ) ) < <
" ( " < <
var . commaSeparatedList ( ) < <
" ) \n " ;
else
define ( _indexAccess , var ) ;
break ;
2019-06-27 11:36:06 +00:00
}
}
2019-06-13 15:22:24 +00:00
}
2019-05-02 10:48:34 +00:00
else if ( baseType . category ( ) = = Type : : Category : : FixedBytes )
solUnimplementedAssert ( false , " " ) ;
else if ( baseType . category ( ) = = Type : : Category : : TypeType )
{
solAssert ( baseType . sizeOnStack ( ) = = 0 , " " ) ;
solAssert ( _indexAccess . annotation ( ) . type - > sizeOnStack ( ) = = 0 , " " ) ;
// no-op - this seems to be a lone array type (`structType[];`)
}
else
solAssert ( false , " Index access only allowed for mappings or arrays. " ) ;
}
2020-03-06 19:59:34 +00:00
void IRGeneratorForStatements : : endVisit ( IndexRangeAccess const & _indexRangeAccess )
2019-09-03 16:30:00 +00:00
{
2020-03-06 19:59:34 +00:00
Type const & baseType = * _indexRangeAccess . baseExpression ( ) . annotation ( ) . type ;
solAssert (
baseType . category ( ) = = Type : : Category : : Array | | baseType . category ( ) = = Type : : Category : : ArraySlice ,
" Index range accesses is available only on arrays and array slices. "
) ;
ArrayType const & arrayType =
baseType . category ( ) = = Type : : Category : : Array ?
dynamic_cast < ArrayType const & > ( baseType ) :
dynamic_cast < ArraySliceType const & > ( baseType ) . arrayType ( ) ;
switch ( arrayType . location ( ) )
{
case DataLocation : : CallData :
{
solAssert ( baseType . isDynamicallySized ( ) , " " ) ;
IRVariable sliceStart { m_context . newYulVariable ( ) , * TypeProvider : : uint256 ( ) } ;
if ( _indexRangeAccess . startExpression ( ) )
define ( sliceStart , IRVariable { * _indexRangeAccess . startExpression ( ) } ) ;
else
define ( sliceStart ) < < u256 ( 0 ) < < " \n " ;
IRVariable sliceEnd {
m_context . newYulVariable ( ) ,
* TypeProvider : : uint256 ( )
} ;
if ( _indexRangeAccess . endExpression ( ) )
define ( sliceEnd , IRVariable { * _indexRangeAccess . endExpression ( ) } ) ;
else
define ( sliceEnd , IRVariable { _indexRangeAccess . baseExpression ( ) } . part ( " length " ) ) ;
IRVariable range { _indexRangeAccess } ;
define ( range ) < <
m_utils . calldataArrayIndexRangeAccess ( arrayType ) < < " ( " < <
IRVariable { _indexRangeAccess . baseExpression ( ) } . commaSeparatedList ( ) < < " , " < <
sliceStart . name ( ) < < " , " < <
sliceEnd . name ( ) < < " ) \n " ;
break ;
}
default :
solUnimplementedAssert ( false , " Index range accesses is implemented only on calldata arrays. " ) ;
}
2019-09-03 16:30:00 +00:00
}
2019-05-02 19:17:06 +00:00
void IRGeneratorForStatements : : endVisit ( Identifier const & _identifier )
2019-03-18 10:21:41 +00:00
{
2019-04-02 10:37:48 +00:00
Declaration const * declaration = _identifier . annotation ( ) . referencedDeclaration ;
2019-05-02 19:17:06 +00:00
if ( MagicVariableDeclaration const * magicVar = dynamic_cast < MagicVariableDeclaration const * > ( declaration ) )
{
switch ( magicVar - > type ( ) - > category ( ) )
{
case Type : : Category : : Contract :
if ( dynamic_cast < ContractType const & > ( * magicVar - > type ( ) ) . isSuper ( ) )
solAssert ( _identifier . name ( ) = = " super " , " " ) ;
else
{
solAssert ( _identifier . name ( ) = = " this " , " " ) ;
2020-02-06 13:05:25 +00:00
define ( _identifier ) < < " address() \n " ;
2019-05-02 19:17:06 +00:00
}
break ;
case Type : : Category : : Integer :
solAssert ( _identifier . name ( ) = = " now " , " " ) ;
2020-02-06 13:05:25 +00:00
define ( _identifier ) < < " timestamp() \n " ;
2019-05-02 19:17:06 +00:00
break ;
default :
break ;
}
return ;
}
else if ( FunctionDefinition const * functionDef = dynamic_cast < FunctionDefinition const * > ( declaration ) )
2020-03-24 17:25:59 +00:00
define ( _identifier ) < < to_string ( functionDef - > resolveVirtual ( m_context . mostDerivedContract ( ) ) . id ( ) ) < < " \n " ;
2019-04-02 10:37:48 +00:00
else if ( VariableDeclaration const * varDecl = dynamic_cast < VariableDeclaration const * > ( declaration ) )
2020-04-16 12:21:12 +00:00
handleVariableReference ( * varDecl , _identifier ) ;
2020-04-23 13:59:42 +00:00
else if ( dynamic_cast < ContractDefinition const * > ( declaration ) )
2019-05-02 20:33:47 +00:00
{
2020-04-23 13:59:42 +00:00
// no-op
2019-05-02 20:33:47 +00:00
}
else if ( dynamic_cast < EventDefinition const * > ( declaration ) )
{
// no-op
}
else if ( dynamic_cast < EnumDefinition const * > ( declaration ) )
{
// no-op
}
else if ( dynamic_cast < StructDefinition const * > ( declaration ) )
{
// no-op
}
2019-05-02 19:17:06 +00:00
else
2019-05-02 20:33:47 +00:00
{
solAssert ( false , " Identifier type not expected in expression context. " ) ;
}
2019-04-02 10:37:48 +00:00
}
bool IRGeneratorForStatements : : visit ( Literal const & _literal )
{
2019-05-06 09:09:50 +00:00
Type const & literalType = type ( _literal ) ;
2019-04-02 10:37:48 +00:00
2019-05-06 09:09:50 +00:00
switch ( literalType . category ( ) )
2019-04-02 10:37:48 +00:00
{
case Type : : Category : : RationalNumber :
case Type : : Category : : Bool :
case Type : : Category : : Address :
2020-02-06 13:05:25 +00:00
define ( _literal ) < < toCompactHexWithPrefix ( literalType . literalValue ( & _literal ) ) < < " \n " ;
2019-04-02 10:37:48 +00:00
break ;
case Type : : Category : : StringLiteral :
break ; // will be done during conversion
default :
solUnimplemented ( " Only integer, boolean and string literals implemented for now. " ) ;
}
2019-03-18 10:21:41 +00:00
return false ;
}
2019-04-15 16:10:36 +00:00
2020-04-16 12:21:12 +00:00
void IRGeneratorForStatements : : handleVariableReference (
VariableDeclaration const & _variable ,
Expression const & _referencingExpression
)
{
2020-04-20 21:05:14 +00:00
if ( _variable . isStateVariable ( ) & & _variable . isConstant ( ) )
define ( _referencingExpression ) < < constantValueFunction ( _variable ) < < " () \n " ;
else if ( _variable . isStateVariable ( ) & & _variable . immutable ( ) )
2020-04-02 18:06:52 +00:00
setLValue ( _referencingExpression , IRLValue {
* _variable . annotation ( ) . type ,
IRLValue : : Immutable { & _variable }
} ) ;
else if ( m_context . isLocalVariable ( _variable ) )
2020-04-16 12:21:12 +00:00
setLValue ( _referencingExpression , IRLValue {
* _variable . annotation ( ) . type ,
IRLValue : : Stack { m_context . localVariable ( _variable ) }
} ) ;
else if ( m_context . isStateVariable ( _variable ) )
setLValue ( _referencingExpression , IRLValue {
* _variable . annotation ( ) . type ,
IRLValue : : Storage {
toCompactHexWithPrefix ( m_context . storageLocationOfVariable ( _variable ) . first ) ,
m_context . storageLocationOfVariable ( _variable ) . second
}
} ) ;
else
solAssert ( false , " Invalid variable kind. " ) ;
}
2019-05-06 17:48:31 +00:00
void IRGeneratorForStatements : : appendExternalFunctionCall (
FunctionCall const & _functionCall ,
vector < ASTPointer < Expression const > > const & _arguments
)
{
FunctionType const & funType = dynamic_cast < FunctionType const & > ( type ( _functionCall . expression ( ) ) ) ;
solAssert (
funType . takesArbitraryParameters ( ) | |
_arguments . size ( ) = = funType . parameterTypes ( ) . size ( ) , " "
) ;
solUnimplementedAssert ( ! funType . bound ( ) , " " ) ;
2020-02-10 10:58:36 +00:00
FunctionType : : Kind const funKind = funType . kind ( ) ;
2019-05-06 17:48:31 +00:00
solAssert ( funKind ! = FunctionType : : Kind : : BareStaticCall | | m_context . evmVersion ( ) . hasStaticCall ( ) , " " ) ;
solAssert ( funKind ! = FunctionType : : Kind : : BareCallCode , " Callcode has been removed. " ) ;
2020-02-10 10:58:36 +00:00
bool const isDelegateCall = funKind = = FunctionType : : Kind : : BareDelegateCall | | funKind = = FunctionType : : Kind : : DelegateCall ;
bool const useStaticCall = funKind = = FunctionType : : Kind : : BareStaticCall | | ( funType . stateMutability ( ) < = StateMutability : : View & & m_context . evmVersion ( ) . hasStaticCall ( ) ) ;
2019-05-06 17:48:31 +00:00
2020-02-10 10:58:36 +00:00
ReturnInfo const returnInfo { m_context . evmVersion ( ) , funType } ;
2019-05-06 17:48:31 +00:00
TypePointers argumentTypes ;
2020-02-06 13:05:25 +00:00
vector < string > argumentStrings ;
2019-05-06 17:48:31 +00:00
for ( auto const & arg : _arguments )
{
argumentTypes . emplace_back ( & type ( * arg ) ) ;
2020-05-07 15:29:42 +00:00
argumentStrings + = IRVariable ( * arg ) . stackSlots ( ) ;
2019-05-06 17:48:31 +00:00
}
solUnimplementedAssert ( funKind ! = FunctionType : : Kind : : ECRecover , " " ) ;
if ( ! m_context . evmVersion ( ) . canOverchargeGasForCall ( ) )
{
// Touch the end of the output area so that we do not pay for memory resize during the call
// (which we would have to subtract from the gas left)
// We could also just use MLOAD; POP right before the gas calculation, but the optimizer
// would remove that, so we use MSTORE here.
2020-02-10 10:58:36 +00:00
if ( ! funType . gasSet ( ) & & returnInfo . estimatedReturnSize > 0 )
m_code < < " mstore(add( " < < freeMemory ( ) < < " , " < < to_string ( returnInfo . estimatedReturnSize ) < < " ), 0) \n " ;
2019-05-06 17:48:31 +00:00
}
2020-01-22 14:48:56 +00:00
ABIFunctions abi ( m_context . evmVersion ( ) , m_context . revertStrings ( ) , m_context . functionCollector ( ) ) ;
2019-05-06 17:48:31 +00:00
Whiskers templ ( R " (
< ? checkExistence >
if iszero ( extcodesize ( < address > ) ) { revert ( 0 , 0 ) }
< / checkExistence >
2020-02-10 10:58:36 +00:00
// storage for arguments and returned data
2020-02-10 10:44:52 +00:00
let < pos > : = < freeMemory >
2020-04-20 21:26:00 +00:00
< ? bareCall >
< ! bareCall >
mstore ( < pos > , < shl28 > ( < funId > ) )
< / bareCall >
let < end > : = < encodeArgs > (
< ? bareCall >
< pos >
< ! bareCall >
add ( < pos > , 4 )
< / bareCall >
< argumentString >
)
2019-05-06 17:48:31 +00:00
2020-02-10 10:58:36 +00:00
let < success > : = < call > ( < gas > , < address > , < ? hasValue > < value > , < / hasValue > < pos > , sub ( < end > , < pos > ) , < pos > , < reservedReturnSize > )
< ? noTryCall >
if iszero ( < success > ) { < forwardingRevert > ( ) }
< / noTryCall >
< ? hasRetVars > let < retVars > < / hasRetVars >
if < success > {
< ? dynamicReturnSize >
// copy dynamic return data out
returndatacopy ( < pos > , 0 , returndatasize ( ) )
< / dynamicReturnSize >
// update freeMemoryPointer according to dynamic return size
mstore ( < freeMemoryPointer > , add ( < pos > , < roundUp > ( < returnSize > ) ) )
// decode return parameters from external try-call into retVars
< ? hasRetVars > < retVars > : = < / hasRetVars > < abiDecode > ( < pos > , add ( < pos > , < returnSize > ) )
}
2019-05-06 17:48:31 +00:00
) " );
templ ( " pos " , m_context . newYulVariable ( ) ) ;
templ ( " end " , m_context . newYulVariable ( ) ) ;
2020-04-20 21:26:00 +00:00
templ ( " bareCall " , funType . isBareCall ( ) ) ;
2020-02-10 10:58:36 +00:00
if ( _functionCall . annotation ( ) . tryCall )
templ ( " success " , m_context . trySuccessConditionVariable ( _functionCall ) ) ;
else
templ ( " success " , m_context . newYulVariable ( ) ) ;
2020-02-10 10:44:52 +00:00
templ ( " freeMemory " , freeMemory ( ) ) ;
2019-05-06 17:48:31 +00:00
templ ( " shl28 " , m_utils . shiftLeftFunction ( 8 * ( 32 - 4 ) ) ) ;
2020-04-20 21:26:00 +00:00
if ( ! funType . isBareCall ( ) )
templ ( " funId " , IRVariable ( _functionCall . expression ( ) ) . part ( " functionIdentifier " ) . name ( ) ) ;
if ( funKind = = FunctionType : : Kind : : ECRecover )
templ ( " address " , " 1 " ) ;
else if ( funKind = = FunctionType : : Kind : : SHA256 )
templ ( " address " , " 2 " ) ;
else if ( funKind = = FunctionType : : Kind : : RIPEMD160 )
templ ( " address " , " 3 " ) ;
else
templ ( " address " , IRVariable ( _functionCall . expression ( ) ) . part ( " address " ) . name ( ) ) ;
2019-05-06 17:48:31 +00:00
2020-02-10 10:58:36 +00:00
// Always use the actual return length, and not our calculated expected length, if returndatacopy is supported.
// This ensures it can catch badly formatted input from external calls.
if ( m_context . evmVersion ( ) . supportsReturndata ( ) )
templ ( " returnSize " , " returndatasize() " ) ;
else
templ ( " returnSize " , to_string ( returnInfo . estimatedReturnSize ) ) ;
templ ( " reservedReturnSize " , returnInfo . dynamicReturnSize ? " 0 " : to_string ( returnInfo . estimatedReturnSize ) ) ;
string const retVars = IRVariable ( _functionCall ) . commaSeparatedList ( ) ;
templ ( " retVars " , retVars ) ;
templ ( " hasRetVars " , ! retVars . empty ( ) ) ;
solAssert ( retVars . empty ( ) = = returnInfo . returnTypes . empty ( ) , " " ) ;
templ ( " roundUp " , m_utils . roundUpFunction ( ) ) ;
templ ( " abiDecode " , abi . tupleDecoder ( returnInfo . returnTypes , true ) ) ;
templ ( " dynamicReturnSize " , returnInfo . dynamicReturnSize ) ;
templ ( " freeMemoryPointer " , to_string ( CompilerUtils : : freeMemoryPointer ) ) ;
templ ( " noTryCall " , ! _functionCall . annotation ( ) . tryCall ) ;
2019-05-06 17:48:31 +00:00
// If the function takes arbitrary parameters or is a bare call, copy dynamic length data in place.
// Move arguments to memory, will not update the free memory pointer (but will update the memory
// pointer on the stack).
bool encodeInPlace = funType . takesArbitraryParameters ( ) | | funType . isBareCall ( ) ;
if ( funType . kind ( ) = = FunctionType : : Kind : : ECRecover )
// This would be the only combination of padding and in-place encoding,
// but all parameters of ecrecover are value types anyway.
encodeInPlace = false ;
bool encodeForLibraryCall = funKind = = FunctionType : : Kind : : DelegateCall ;
2020-04-20 21:26:00 +00:00
solUnimplementedAssert ( encodeInPlace = = ! funType . padArguments ( ) , " " ) ;
if ( encodeInPlace )
{
solUnimplementedAssert ( ! encodeForLibraryCall , " " ) ;
templ ( " encodeArgs " , abi . tupleEncoderPacked ( argumentTypes , funType . parameterTypes ( ) ) ) ;
}
else
templ ( " encodeArgs " , abi . tupleEncoder ( argumentTypes , funType . parameterTypes ( ) , encodeForLibraryCall ) ) ;
2020-05-07 15:29:42 +00:00
templ ( " argumentString " , joinHumanReadablePrefixed ( argumentStrings ) ) ;
2019-05-06 17:48:31 +00:00
// Output data will replace input data, unless we have ECRecover (then, output
// area will be 32 bytes just before input area).
solUnimplementedAssert ( funKind ! = FunctionType : : Kind : : ECRecover , " " ) ;
2020-02-10 10:44:52 +00:00
solAssert ( ! isDelegateCall | | ! funType . valueSet ( ) , " Value set for delegatecall " ) ;
solAssert ( ! useStaticCall | | ! funType . valueSet ( ) , " Value set for staticcall " ) ;
templ ( " hasValue " , ! isDelegateCall & & ! useStaticCall ) ;
templ ( " value " , funType . valueSet ( ) ? IRVariable ( _functionCall . expression ( ) ) . part ( " value " ) . name ( ) : " 0 " ) ;
2019-05-06 17:48:31 +00:00
// Check that the target contract exists (has code) for non-low-level calls.
bool checkExistence = ( funKind = = FunctionType : : Kind : : External | | funKind = = FunctionType : : Kind : : DelegateCall ) ;
templ ( " checkExistence " , checkExistence ) ;
if ( funType . gasSet ( ) )
2020-02-06 13:05:25 +00:00
templ ( " gas " , IRVariable ( _functionCall . expression ( ) ) . part ( " gas " ) . name ( ) ) ;
2019-05-06 17:48:31 +00:00
else if ( m_context . evmVersion ( ) . canOverchargeGasForCall ( ) )
// Send all gas (requires tangerine whistle EVM)
templ ( " gas " , " gas() " ) ;
else
{
// send all gas except the amount needed to execute "SUB" and "CALL"
// @todo this retains too much gas for now, needs to be fine-tuned.
2019-12-11 16:31:36 +00:00
u256 gasNeededByCaller = evmasm : : GasCosts : : callGas ( m_context . evmVersion ( ) ) + 10 ;
2019-05-06 17:48:31 +00:00
if ( funType . valueSet ( ) )
2019-12-11 16:31:36 +00:00
gasNeededByCaller + = evmasm : : GasCosts : : callValueTransferGas ;
2019-05-06 17:48:31 +00:00
if ( ! checkExistence )
2019-12-11 16:31:36 +00:00
gasNeededByCaller + = evmasm : : GasCosts : : callNewAccountGas ; // we never know
2019-05-06 17:48:31 +00:00
templ ( " gas " , " sub(gas(), " + formatNumber ( gasNeededByCaller ) + " ) " ) ;
}
// Order is important here, STATICCALL might overlap with DELEGATECALL.
if ( isDelegateCall )
templ ( " call " , " delegatecall " ) ;
else if ( useStaticCall )
templ ( " call " , " staticcall " ) ;
else
templ ( " call " , " call " ) ;
templ ( " forwardingRevert " , m_utils . forwardingRevertFunction ( ) ) ;
solUnimplementedAssert ( funKind ! = FunctionType : : Kind : : RIPEMD160 , " " ) ;
solUnimplementedAssert ( funKind ! = FunctionType : : Kind : : ECRecover , " " ) ;
2020-02-10 10:44:52 +00:00
m_code < < templ . render ( ) ;
2019-05-06 17:48:31 +00:00
}
2020-02-10 10:44:52 +00:00
string IRGeneratorForStatements : : freeMemory ( )
2019-05-06 17:48:31 +00:00
{
return " mload( " + to_string ( CompilerUtils : : freeMemoryPointer ) + " ) " ;
}
2020-02-06 13:05:25 +00:00
IRVariable IRGeneratorForStatements : : convert ( IRVariable const & _from , Type const & _to )
2019-04-15 16:10:36 +00:00
{
2020-02-06 13:05:25 +00:00
if ( _from . type ( ) = = _to )
return _from ;
2019-04-15 16:10:36 +00:00
else
2019-05-02 14:24:54 +00:00
{
2020-02-06 13:05:25 +00:00
IRVariable converted ( m_context . newYulVariable ( ) , _to ) ;
define ( converted , _from ) ;
return converted ;
2019-05-02 14:24:54 +00:00
}
2019-04-15 16:10:36 +00:00
}
2019-04-24 22:21:00 +00:00
2020-05-05 11:06:01 +00:00
std : : string IRGeneratorForStatements : : expressionAsType ( Expression const & _expression , Type const & _to , bool _forceCleanup )
2019-04-24 22:21:00 +00:00
{
2020-02-06 13:05:25 +00:00
IRVariable from ( _expression ) ;
if ( from . type ( ) = = _to )
2020-05-05 11:06:01 +00:00
{
if ( _forceCleanup )
return m_utils . cleanupFunction ( _to ) + " ( " + from . commaSeparatedList ( ) + " ) " ;
else
return from . commaSeparatedList ( ) ;
}
2020-02-06 13:05:25 +00:00
else
return m_utils . conversionFunction ( from . type ( ) , _to ) + " ( " + from . commaSeparatedList ( ) + " ) " ;
2019-04-24 22:21:00 +00:00
}
2019-04-30 16:32:56 +00:00
2020-02-06 13:05:25 +00:00
std : : ostream & IRGeneratorForStatements : : define ( IRVariable const & _var )
2019-05-06 17:48:31 +00:00
{
2020-02-06 13:05:25 +00:00
if ( _var . type ( ) . sizeOnStack ( ) > 0 )
m_code < < " let " < < _var . commaSeparatedList ( ) < < " := " ;
return m_code ;
2019-05-06 17:48:31 +00:00
}
2020-03-02 20:42:46 +00:00
void IRGeneratorForStatements : : declare ( IRVariable const & _var )
{
if ( _var . type ( ) . sizeOnStack ( ) > 0 )
m_code < < " let " < < _var . commaSeparatedList ( ) < < " \n " ;
}
2020-02-06 13:05:25 +00:00
void IRGeneratorForStatements : : declareAssign ( IRVariable const & _lhs , IRVariable const & _rhs , bool _declare )
{
string output ;
if ( _lhs . type ( ) = = _rhs . type ( ) )
for ( auto const & [ stackItemName , stackItemType ] : _lhs . type ( ) . stackItems ( ) )
if ( stackItemType )
declareAssign ( _lhs . part ( stackItemName ) , _rhs . part ( stackItemName ) , _declare ) ;
else
m_code < < ( _declare ? " let " : " " ) < < _lhs . part ( stackItemName ) . name ( ) < < " := " < < _rhs . part ( stackItemName ) . name ( ) < < " \n " ;
else
2020-04-15 07:41:36 +00:00
{
if ( _lhs . type ( ) . sizeOnStack ( ) > 0 )
m_code < <
( _declare ? " let " : " " ) < <
_lhs . commaSeparatedList ( ) < <
" := " ;
m_code < < m_context . utils ( ) . conversionFunction ( _rhs . type ( ) , _lhs . type ( ) ) < <
2020-02-06 13:05:25 +00:00
" ( " < <
_rhs . commaSeparatedList ( ) < <
" ) \n " ;
2020-04-15 07:41:36 +00:00
}
2020-02-06 13:05:25 +00:00
}
2020-03-02 20:42:46 +00:00
IRVariable IRGeneratorForStatements : : zeroValue ( Type const & _type , bool _splitFunctionTypes )
2020-02-06 13:05:25 +00:00
{
2020-03-02 20:42:46 +00:00
IRVariable irVar {
" zero_value_for_type_ " + _type . identifier ( ) + m_context . newYulVariable ( ) ,
_type
} ;
define ( irVar ) < < m_utils . zeroValueFunction ( _type , _splitFunctionTypes ) < < " () \n " ;
return irVar ;
2020-02-06 13:05:25 +00:00
}
2019-05-23 18:17:20 +00:00
void IRGeneratorForStatements : : appendSimpleUnaryOperation ( UnaryOperation const & _operation , Expression const & _expr )
{
string func ;
if ( _operation . getOperator ( ) = = Token : : Not )
func = " iszero " ;
else if ( _operation . getOperator ( ) = = Token : : BitNot )
func = " not " ;
else
solAssert ( false , " Invalid Token! " ) ;
2020-02-06 13:05:25 +00:00
define ( _operation ) < <
2019-05-23 18:17:20 +00:00
m_utils . cleanupFunction ( type ( _expr ) ) < <
" ( " < <
func < <
" ( " < <
2020-02-06 13:05:25 +00:00
IRVariable ( _expr ) . commaSeparatedList ( ) < <
2019-05-23 18:17:20 +00:00
" ) " < <
" ) \n " ;
}
string IRGeneratorForStatements : : binaryOperation (
langutil : : Token _operator ,
Type const & _type ,
string const & _left ,
string const & _right
)
{
2020-04-20 21:16:42 +00:00
solAssert (
! TokenTraits : : isShiftOp ( _operator ) ,
" Have to use specific shift operation function for shifts. "
) ;
2019-05-23 18:17:20 +00:00
if ( IntegerType const * type = dynamic_cast < IntegerType const * > ( & _type ) )
{
string fun ;
2019-06-12 09:24:19 +00:00
// TODO: Implement all operations for signed and unsigned types.
switch ( _operator )
2019-05-23 14:12:32 +00:00
{
2019-06-12 09:24:19 +00:00
case Token : : Add :
fun = m_utils . overflowCheckedIntAddFunction ( * type ) ;
break ;
case Token : : Sub :
2019-06-12 11:07:06 +00:00
fun = m_utils . overflowCheckedIntSubFunction ( * type ) ;
2019-06-12 09:24:19 +00:00
break ;
case Token : : Mul :
2019-06-12 12:06:13 +00:00
fun = m_utils . overflowCheckedIntMulFunction ( * type ) ;
2019-06-12 09:24:19 +00:00
break ;
case Token : : Div :
fun = m_utils . overflowCheckedIntDivFunction ( * type ) ;
break ;
2019-06-12 14:27:26 +00:00
case Token : : Mod :
fun = m_utils . checkedIntModFunction ( * type ) ;
break ;
2020-04-15 22:33:32 +00:00
case Token : : BitOr :
fun = " or " ;
break ;
case Token : : BitXor :
fun = " xor " ;
break ;
case Token : : BitAnd :
fun = " and " ;
break ;
2019-06-12 09:24:19 +00:00
default :
break ;
2019-05-23 14:12:32 +00:00
}
2019-06-12 09:24:19 +00:00
2019-05-23 14:12:32 +00:00
solUnimplementedAssert ( ! fun . empty ( ) , " " ) ;
2019-05-23 18:17:20 +00:00
return fun + " ( " + _left + " , " + _right + " ) \n " ;
}
else
solUnimplementedAssert ( false , " " ) ;
return { } ;
}
2020-04-20 21:16:42 +00:00
std : : string IRGeneratorForStatements : : shiftOperation (
langutil : : Token _operator ,
IRVariable const & _value ,
IRVariable const & _amountToShift
)
{
IntegerType const * amountType = dynamic_cast < IntegerType const * > ( & _amountToShift . type ( ) ) ;
solAssert ( amountType , " " ) ;
solAssert ( _operator = = Token : : SHL | | _operator = = Token : : SAR , " " ) ;
return
Whiskers ( R " (
< shift > ( < value > , < amount > )
) " )
( " shift " ,
_operator = = Token : : SHL ?
m_utils . typedShiftLeftFunction ( _value . type ( ) , * amountType ) :
m_utils . typedShiftRightFunction ( _value . type ( ) , * amountType )
)
( " value " , _value . name ( ) )
( " amount " , _amountToShift . name ( ) )
. render ( ) ;
}
2019-05-02 16:09:19 +00:00
void IRGeneratorForStatements : : appendAndOrOperatorCode ( BinaryOperation const & _binOp )
{
langutil : : Token const op = _binOp . getOperator ( ) ;
solAssert ( op = = Token : : Or | | op = = Token : : And , " " ) ;
_binOp . leftExpression ( ) . accept ( * this ) ;
2020-02-06 13:05:25 +00:00
IRVariable value ( _binOp ) ;
define ( value , _binOp . leftExpression ( ) ) ;
2019-05-02 16:09:19 +00:00
if ( op = = Token : : Or )
2020-02-06 13:05:25 +00:00
m_code < < " if iszero( " < < value . name ( ) < < " ) { \n " ;
2019-05-02 16:09:19 +00:00
else
2020-02-06 13:05:25 +00:00
m_code < < " if " < < value . name ( ) < < " { \n " ;
2019-05-02 16:09:19 +00:00
_binOp . rightExpression ( ) . accept ( * this ) ;
2020-02-06 13:05:25 +00:00
assign ( value , _binOp . rightExpression ( ) ) ;
2019-05-02 16:09:19 +00:00
m_code < < " } \n " ;
}
2020-02-06 13:05:25 +00:00
void IRGeneratorForStatements : : writeToLValue ( IRLValue const & _lvalue , IRVariable const & _value )
{
std : : visit (
util : : GenericVisitor {
[ & ] ( IRLValue : : Storage const & _storage ) {
std : : optional < unsigned > offset ;
if ( std : : holds_alternative < unsigned > ( _storage . offset ) )
offset = std : : get < unsigned > ( _storage . offset ) ;
m_code < <
m_utils . updateStorageValueFunction ( _lvalue . type , offset ) < <
" ( " < <
_storage . slot < <
(
std : : holds_alternative < string > ( _storage . offset ) ?
( " , " + std : : get < string > ( _storage . offset ) ) :
" "
) < <
_value . commaSeparatedListPrefixed ( ) < <
" ) \n " ;
} ,
[ & ] ( IRLValue : : Memory const & _memory ) {
if ( _lvalue . type . isValueType ( ) )
{
IRVariable prepared ( m_context . newYulVariable ( ) , _lvalue . type ) ;
define ( prepared , _value ) ;
if ( _memory . byteArrayElement )
{
solAssert ( _lvalue . type = = * TypeProvider : : byte ( ) , " " ) ;
m_code < < " mstore8( " + _memory . address + " , byte(0, " + prepared . commaSeparatedList ( ) + " )) \n " ;
}
else
m_code < < m_utils . writeToMemoryFunction ( _lvalue . type ) < <
" ( " < <
_memory . address < <
" , " < <
prepared . commaSeparatedList ( ) < <
" ) \n " ;
}
else
{
solAssert ( _lvalue . type . sizeOnStack ( ) = = 1 , " " ) ;
solAssert ( dynamic_cast < ReferenceType const * > ( & _lvalue . type ) , " " ) ;
auto const * valueReferenceType = dynamic_cast < ReferenceType const * > ( & _value . type ( ) ) ;
solAssert ( valueReferenceType & & valueReferenceType - > dataStoredIn ( DataLocation : : Memory ) , " " ) ;
2020-03-20 16:52:51 +00:00
m_code < < " mstore( " + _memory . address + " , " + _value . part ( " mpos " ) . name ( ) + " ) \n " ;
2020-02-06 13:05:25 +00:00
}
} ,
[ & ] ( IRLValue : : Stack const & _stack ) { assign ( _stack . variable , _value ) ; } ,
2020-04-02 18:06:52 +00:00
[ & ] ( IRLValue : : Immutable const & _immutable )
{
solUnimplementedAssert ( _lvalue . type . isValueType ( ) , " " ) ;
solUnimplementedAssert ( _lvalue . type . sizeOnStack ( ) = = 1 , " " ) ;
solAssert ( _lvalue . type = = * _immutable . variable - > type ( ) , " " ) ;
size_t memOffset = m_context . immutableMemoryOffset ( * _immutable . variable ) ;
IRVariable prepared ( m_context . newYulVariable ( ) , _lvalue . type ) ;
define ( prepared , _value ) ;
m_code < < " mstore( " < < to_string ( memOffset ) < < " , " < < prepared . commaSeparatedList ( ) < < " ) \n " ;
} ,
2020-02-06 13:05:25 +00:00
[ & ] ( IRLValue : : Tuple const & _tuple ) {
auto components = std : : move ( _tuple . components ) ;
for ( size_t i = 0 ; i < components . size ( ) ; i + + )
{
size_t idx = components . size ( ) - i - 1 ;
if ( components [ idx ] )
writeToLValue ( * components [ idx ] , _value . tupleComponent ( idx ) ) ;
}
}
} ,
_lvalue . kind
) ;
}
IRVariable IRGeneratorForStatements : : readFromLValue ( IRLValue const & _lvalue )
{
IRVariable result { m_context . newYulVariable ( ) , _lvalue . type } ;
std : : visit ( GenericVisitor {
[ & ] ( IRLValue : : Storage const & _storage ) {
if ( ! _lvalue . type . isValueType ( ) )
define ( result ) < < _storage . slot < < " \n " ;
else if ( std : : holds_alternative < string > ( _storage . offset ) )
define ( result ) < <
m_utils . readFromStorageDynamic ( _lvalue . type , false ) < <
" ( " < <
_storage . slot < <
" , " < <
std : : get < string > ( _storage . offset ) < <
" ) \n " ;
else
define ( result ) < <
m_utils . readFromStorage ( _lvalue . type , std : : get < unsigned > ( _storage . offset ) , false ) < <
" ( " < <
_storage . slot < <
" ) \n " ;
} ,
[ & ] ( IRLValue : : Memory const & _memory ) {
2020-05-04 12:21:48 +00:00
if ( _lvalue . type . isValueType ( ) )
2020-02-06 13:05:25 +00:00
define ( result ) < <
m_utils . readFromMemory ( _lvalue . type ) < <
" ( " < <
_memory . address < <
" ) \n " ;
else
define ( result ) < < " mload( " < < _memory . address < < " ) \n " ;
} ,
[ & ] ( IRLValue : : Stack const & _stack ) {
define ( result , _stack . variable ) ;
} ,
2020-04-02 18:06:52 +00:00
[ & ] ( IRLValue : : Immutable const & _immutable ) {
solUnimplementedAssert ( _lvalue . type . isValueType ( ) , " " ) ;
solUnimplementedAssert ( _lvalue . type . sizeOnStack ( ) = = 1 , " " ) ;
solAssert ( _lvalue . type = = * _immutable . variable - > type ( ) , " " ) ;
define ( result ) < < " loadimmutable( \" " < < to_string ( _immutable . variable - > id ( ) ) < < " \" ) \n " ;
} ,
2020-02-06 13:05:25 +00:00
[ & ] ( IRLValue : : Tuple const & ) {
solAssert ( false , " Attempted to read from tuple lvalue. " ) ;
}
} , _lvalue . kind ) ;
return result ;
}
void IRGeneratorForStatements : : setLValue ( Expression const & _expression , IRLValue _lvalue )
2019-04-30 16:32:56 +00:00
{
solAssert ( ! m_currentLValue , " " ) ;
2020-04-09 10:48:57 +00:00
if ( _expression . annotation ( ) . willBeWrittenTo )
2020-02-11 16:43:43 +00:00
{
2020-02-06 13:05:25 +00:00
m_currentLValue . emplace ( std : : move ( _lvalue ) ) ;
2020-02-11 16:43:43 +00:00
solAssert ( ! _lvalue . type . dataStoredIn ( DataLocation : : CallData ) , " " ) ;
}
2019-04-30 16:32:56 +00:00
else
2020-02-06 13:05:25 +00:00
// Only define the expression, if it will not be written to.
define ( _expression , readFromLValue ( _lvalue ) ) ;
2019-04-30 16:32:56 +00:00
}
2019-05-06 09:09:50 +00:00
2019-05-08 11:27:36 +00:00
void IRGeneratorForStatements : : generateLoop (
Statement const & _body ,
Expression const * _conditionExpression ,
Statement const * _initExpression ,
ExpressionStatement const * _loopExpression ,
bool _isDoWhile
)
{
string firstRun ;
if ( _isDoWhile )
{
solAssert ( _conditionExpression , " Expected condition for doWhile " ) ;
firstRun = m_context . newYulVariable ( ) ;
m_code < < " let " < < firstRun < < " := 1 \n " ;
}
m_code < < " for { \n " ;
if ( _initExpression )
_initExpression - > accept ( * this ) ;
2019-10-24 17:23:56 +00:00
m_code < < " } 1 { \n " ;
2019-05-08 11:27:36 +00:00
if ( _loopExpression )
_loopExpression - > accept ( * this ) ;
m_code < < " } \n " ;
m_code < < " { \n " ;
if ( _conditionExpression )
{
if ( _isDoWhile )
m_code < < " if iszero( " < < firstRun < < " ) { \n " ;
_conditionExpression - > accept ( * this ) ;
m_code < <
" if iszero( " < <
expressionAsType ( * _conditionExpression , * TypeProvider : : boolean ( ) ) < <
" ) { break } \n " ;
if ( _isDoWhile )
m_code < < " } \n " < < firstRun < < " := 0 \n " ;
}
_body . accept ( * this ) ;
m_code < < " } \n " ;
}
2019-05-06 09:09:50 +00:00
Type const & IRGeneratorForStatements : : type ( Expression const & _expression )
{
solAssert ( _expression . annotation ( ) . type , " Type of expression not set. " ) ;
return * _expression . annotation ( ) . type ;
}
2020-02-10 10:58:36 +00:00
bool IRGeneratorForStatements : : visit ( TryStatement const & _tryStatement )
{
Expression const & externalCall = _tryStatement . externalCall ( ) ;
externalCall . accept ( * this ) ;
m_code < < " switch iszero( " < < m_context . trySuccessConditionVariable ( externalCall ) < < " ) \n " ;
m_code < < " case 0 { // success case \n " ;
TryCatchClause const & successClause = * _tryStatement . clauses ( ) . front ( ) ;
if ( successClause . parameters ( ) )
{
size_t i = 0 ;
for ( ASTPointer < VariableDeclaration > const & varDecl : successClause . parameters ( ) - > parameters ( ) )
{
solAssert ( varDecl , " " ) ;
define ( m_context . addLocalVariable ( * varDecl ) ,
successClause . parameters ( ) - > parameters ( ) . size ( ) = = 1 ?
IRVariable ( externalCall ) :
IRVariable ( externalCall ) . tupleComponent ( i + + )
) ;
}
}
successClause . block ( ) . accept ( * this ) ;
m_code < < " } \n " ;
m_code < < " default { // failure case \n " ;
handleCatch ( _tryStatement ) ;
m_code < < " } \n " ;
return false ;
}
void IRGeneratorForStatements : : handleCatch ( TryStatement const & _tryStatement )
{
if ( _tryStatement . structuredClause ( ) )
handleCatchStructuredAndFallback ( * _tryStatement . structuredClause ( ) , _tryStatement . fallbackClause ( ) ) ;
else if ( _tryStatement . fallbackClause ( ) )
handleCatchFallback ( * _tryStatement . fallbackClause ( ) ) ;
else
rethrow ( ) ;
}
void IRGeneratorForStatements : : handleCatchStructuredAndFallback (
TryCatchClause const & _structured ,
TryCatchClause const * _fallback
)
{
solAssert (
_structured . parameters ( ) & &
_structured . parameters ( ) - > parameters ( ) . size ( ) = = 1 & &
_structured . parameters ( ) - > parameters ( ) . front ( ) & &
* _structured . parameters ( ) - > parameters ( ) . front ( ) - > annotation ( ) . type = = * TypeProvider : : stringMemory ( ) ,
" "
) ;
solAssert ( m_context . evmVersion ( ) . supportsReturndata ( ) , " " ) ;
// Try to decode the error message.
// If this fails, leaves 0 on the stack, otherwise the pointer to the data string.
string const dataVariable = m_context . newYulVariable ( ) ;
m_code < < " let " < < dataVariable < < " := " < < m_utils . tryDecodeErrorMessageFunction ( ) < < " () \n " ;
m_code < < " switch iszero( " < < dataVariable < < " ) \n " ;
m_code < < " case 0 { // decoding success \n " ;
if ( _structured . parameters ( ) )
{
solAssert ( _structured . parameters ( ) - > parameters ( ) . size ( ) = = 1 , " " ) ;
IRVariable const & var = m_context . addLocalVariable ( * _structured . parameters ( ) - > parameters ( ) . front ( ) ) ;
define ( var ) < < dataVariable < < " \n " ;
}
_structured . accept ( * this ) ;
m_code < < " } \n " ;
m_code < < " default { // decoding failure \n " ;
if ( _fallback )
handleCatchFallback ( * _fallback ) ;
else
rethrow ( ) ;
m_code < < " } \n " ;
}
void IRGeneratorForStatements : : handleCatchFallback ( TryCatchClause const & _fallback )
{
if ( _fallback . parameters ( ) )
{
solAssert ( m_context . evmVersion ( ) . supportsReturndata ( ) , " " ) ;
solAssert (
_fallback . parameters ( ) - > parameters ( ) . size ( ) = = 1 & &
_fallback . parameters ( ) - > parameters ( ) . front ( ) & &
* _fallback . parameters ( ) - > parameters ( ) . front ( ) - > annotation ( ) . type = = * TypeProvider : : bytesMemory ( ) ,
" "
) ;
VariableDeclaration const & paramDecl = * _fallback . parameters ( ) - > parameters ( ) . front ( ) ;
define ( m_context . addLocalVariable ( paramDecl ) ) < < m_utils . extractReturndataFunction ( ) < < " () \n " ;
}
_fallback . accept ( * this ) ;
}
void IRGeneratorForStatements : : rethrow ( )
{
if ( m_context . evmVersion ( ) . supportsReturndata ( ) )
m_code < < R " (
returndatacopy ( 0 , 0 , returndatasize ( ) )
revert ( 0 , returndatasize ( ) )
) " s;
else
m_code < < " revert(0, 0) // rethrow \n " s ;
}
bool IRGeneratorForStatements : : visit ( TryCatchClause const & _clause )
{
_clause . block ( ) . accept ( * this ) ;
return false ;
}