2018-01-22 22:56:10 +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/>.
|
|
|
|
*/
|
|
|
|
/**
|
|
|
|
* Module providing metrics for the optimizer.
|
|
|
|
*/
|
|
|
|
|
2018-10-15 09:52:35 +00:00
|
|
|
#include <libyul/optimiser/Metrics.h>
|
2021-04-22 10:46:25 +00:00
|
|
|
#include <libyul/optimiser/OptimizerUtilities.h>
|
2022-11-23 10:51:34 +00:00
|
|
|
#include <libyul/backends/evm/EVMDialect.h>
|
2018-01-22 22:56:10 +00:00
|
|
|
|
2020-10-29 14:00:27 +00:00
|
|
|
#include <libyul/AST.h>
|
2018-12-05 22:42:55 +00:00
|
|
|
#include <libyul/Exceptions.h>
|
2019-05-14 14:09:52 +00:00
|
|
|
#include <libyul/Utilities.h>
|
2018-12-05 22:42:55 +00:00
|
|
|
|
|
|
|
#include <libevmasm/Instruction.h>
|
2018-01-22 22:56:10 +00:00
|
|
|
|
2020-01-06 10:52:23 +00:00
|
|
|
#include <libsolutil/CommonData.h>
|
2019-01-09 15:50:41 +00:00
|
|
|
|
2019-12-11 16:31:36 +00:00
|
|
|
using namespace solidity;
|
|
|
|
using namespace solidity::yul;
|
|
|
|
using namespace solidity::util;
|
2018-01-22 22:56:10 +00:00
|
|
|
|
2020-02-29 18:53:58 +00:00
|
|
|
size_t CodeWeights::costOf(Statement const& _statement) const
|
2018-01-22 22:56:10 +00:00
|
|
|
{
|
2023-08-23 02:03:44 +00:00
|
|
|
if (std::holds_alternative<ExpressionStatement>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return expressionStatementCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<Assignment>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return assignmentCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<VariableDeclaration>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return variableDeclarationCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<FunctionDefinition>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return functionDefinitionCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<If>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return ifCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<Switch>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return switchCost + caseCost * std::get<Switch>(_statement).cases.size();
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<ForLoop>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return forLoopCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<Break>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return breakCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<Continue>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return continueCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<Leave>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return leaveCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<Block>(_statement))
|
2020-02-29 18:53:58 +00:00
|
|
|
return blockCost;
|
|
|
|
else
|
|
|
|
yulAssert(false, "If you add a new statement type, you must update CodeWeights.");
|
|
|
|
}
|
|
|
|
|
|
|
|
size_t CodeWeights::costOf(Expression const& _expression) const
|
|
|
|
{
|
2023-08-23 02:03:44 +00:00
|
|
|
if (std::holds_alternative<FunctionCall>(_expression))
|
2020-02-29 18:53:58 +00:00
|
|
|
return functionCallCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (std::holds_alternative<Identifier>(_expression))
|
2020-02-29 18:53:58 +00:00
|
|
|
return identifierCost;
|
2023-08-23 02:03:44 +00:00
|
|
|
else if (Literal const* literal = std::get_if<Literal>(&_expression))
|
2021-04-13 10:13:45 +00:00
|
|
|
{
|
|
|
|
// Avoid strings because they could be longer than 32 bytes.
|
|
|
|
if (literal->kind != LiteralKind::String && valueOfLiteral(*literal) == 0)
|
|
|
|
return literalZeroCost;
|
|
|
|
else
|
|
|
|
return literalCost;
|
|
|
|
}
|
2020-02-29 18:53:58 +00:00
|
|
|
else
|
|
|
|
yulAssert(false, "If you add a new expression type, you must update CodeWeights.");
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
size_t CodeSize::codeSize(Statement const& _statement, CodeWeights const& _weights)
|
|
|
|
{
|
|
|
|
CodeSize cs(true, _weights);
|
2018-01-22 22:56:10 +00:00
|
|
|
cs.visit(_statement);
|
|
|
|
return cs.m_size;
|
|
|
|
}
|
|
|
|
|
2020-02-29 18:53:58 +00:00
|
|
|
size_t CodeSize::codeSize(Expression const& _expression, CodeWeights const& _weights)
|
2018-01-22 22:56:10 +00:00
|
|
|
{
|
2020-02-29 18:53:58 +00:00
|
|
|
CodeSize cs(true, _weights);
|
2018-01-22 22:56:10 +00:00
|
|
|
cs.visit(_expression);
|
|
|
|
return cs.m_size;
|
|
|
|
}
|
|
|
|
|
2020-02-29 18:53:58 +00:00
|
|
|
size_t CodeSize::codeSize(Block const& _block, CodeWeights const& _weights)
|
2018-01-22 23:06:55 +00:00
|
|
|
{
|
2020-02-29 18:53:58 +00:00
|
|
|
CodeSize cs(true, _weights);
|
2019-01-11 11:47:45 +00:00
|
|
|
cs(_block);
|
2018-01-22 23:06:55 +00:00
|
|
|
return cs.m_size;
|
|
|
|
}
|
|
|
|
|
2020-02-29 18:53:58 +00:00
|
|
|
size_t CodeSize::codeSizeIncludingFunctions(Block const& _block, CodeWeights const& _weights)
|
2019-03-04 17:50:55 +00:00
|
|
|
{
|
2020-02-29 18:53:58 +00:00
|
|
|
CodeSize cs(false, _weights);
|
2019-03-04 17:50:55 +00:00
|
|
|
cs(_block);
|
|
|
|
return cs.m_size;
|
|
|
|
}
|
|
|
|
|
2018-01-22 22:56:10 +00:00
|
|
|
void CodeSize::visit(Statement const& _statement)
|
|
|
|
{
|
2023-08-23 02:03:44 +00:00
|
|
|
if (std::holds_alternative<FunctionDefinition>(_statement) && m_ignoreFunctions)
|
2018-12-12 17:56:02 +00:00
|
|
|
return;
|
|
|
|
|
2020-02-29 18:53:58 +00:00
|
|
|
m_size += m_weights.costOf(_statement);
|
2018-01-22 22:56:10 +00:00
|
|
|
ASTWalker::visit(_statement);
|
|
|
|
}
|
|
|
|
|
|
|
|
void CodeSize::visit(Expression const& _expression)
|
|
|
|
{
|
2020-02-29 18:53:58 +00:00
|
|
|
m_size += m_weights.costOf(_expression);
|
2018-01-22 22:56:10 +00:00
|
|
|
ASTWalker::visit(_expression);
|
|
|
|
}
|
2018-12-05 22:42:55 +00:00
|
|
|
|
|
|
|
|
2019-05-20 12:30:32 +00:00
|
|
|
size_t CodeCost::codeCost(Dialect const& _dialect, Expression const& _expr)
|
2018-12-05 22:42:55 +00:00
|
|
|
{
|
2019-05-20 12:30:32 +00:00
|
|
|
CodeCost cc(_dialect);
|
2018-12-05 22:42:55 +00:00
|
|
|
cc.visit(_expr);
|
|
|
|
return cc.m_cost;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void CodeCost::operator()(FunctionCall const& _funCall)
|
|
|
|
{
|
|
|
|
ASTWalker::operator()(_funCall);
|
2019-05-20 12:30:32 +00:00
|
|
|
|
2021-04-22 10:46:25 +00:00
|
|
|
if (auto instruction = toEVMInstruction(m_dialect, _funCall.functionName.name))
|
|
|
|
{
|
|
|
|
addInstructionCost(*instruction);
|
|
|
|
return;
|
|
|
|
}
|
2019-05-20 12:30:32 +00:00
|
|
|
|
|
|
|
m_cost += 49;
|
2018-12-05 22:42:55 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
void CodeCost::operator()(Literal const& _literal)
|
|
|
|
{
|
|
|
|
yulAssert(m_cost >= 1, "Should assign cost one in visit(Expression).");
|
|
|
|
size_t cost = 0;
|
|
|
|
switch (_literal.kind)
|
|
|
|
{
|
|
|
|
case LiteralKind::Boolean:
|
|
|
|
break;
|
|
|
|
case LiteralKind::Number:
|
|
|
|
for (u256 n = u256(_literal.value.str()); n >= 0x100; n >>= 8)
|
|
|
|
cost++;
|
2023-08-04 10:27:18 +00:00
|
|
|
if (valueOfLiteral(_literal) == 0)
|
|
|
|
if (auto evmDialect = dynamic_cast<EVMDialect const*>(&m_dialect))
|
|
|
|
if (evmDialect->evmVersion().hasPush0())
|
|
|
|
--m_cost;
|
2018-12-05 22:42:55 +00:00
|
|
|
break;
|
|
|
|
case LiteralKind::String:
|
|
|
|
cost = _literal.value.str().size();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
m_cost += cost;
|
|
|
|
}
|
|
|
|
|
|
|
|
void CodeCost::visit(Statement const& _statement)
|
|
|
|
{
|
|
|
|
++m_cost;
|
|
|
|
ASTWalker::visit(_statement);
|
|
|
|
}
|
|
|
|
|
|
|
|
void CodeCost::visit(Expression const& _expression)
|
|
|
|
{
|
|
|
|
++m_cost;
|
|
|
|
ASTWalker::visit(_expression);
|
|
|
|
}
|
2019-01-17 15:11:55 +00:00
|
|
|
|
2019-12-11 16:31:36 +00:00
|
|
|
void CodeCost::addInstructionCost(evmasm::Instruction _instruction)
|
2019-05-20 12:30:32 +00:00
|
|
|
{
|
2022-11-23 10:51:34 +00:00
|
|
|
evmasm::Tier gasPriceTier = evmasm::instructionInfo(_instruction, evmVersionFromDialect(m_dialect)).gasPriceTier;
|
2019-12-11 16:31:36 +00:00
|
|
|
if (gasPriceTier < evmasm::Tier::VeryLow)
|
2019-05-20 12:30:32 +00:00
|
|
|
m_cost -= 1;
|
2019-12-11 16:31:36 +00:00
|
|
|
else if (gasPriceTier < evmasm::Tier::High)
|
2019-05-20 12:30:32 +00:00
|
|
|
m_cost += 1;
|
|
|
|
else
|
|
|
|
m_cost += 49;
|
|
|
|
}
|
|
|
|
|
2019-01-17 15:11:55 +00:00
|
|
|
void AssignmentCounter::operator()(Assignment const& _assignment)
|
|
|
|
{
|
|
|
|
for (auto const& variable: _assignment.variableNames)
|
|
|
|
++m_assignmentCounters[variable.name];
|
|
|
|
}
|
|
|
|
|
|
|
|
size_t AssignmentCounter::assignmentCount(YulString _name) const
|
|
|
|
{
|
|
|
|
auto it = m_assignmentCounters.find(_name);
|
|
|
|
return (it == m_assignmentCounters.end()) ? 0 : it->second;
|
|
|
|
}
|