solidity/libyul/optimiser/Metrics.h

72 lines
2.0 KiB
C++

/*
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.
*/
#pragma once
#include <libyul/optimiser/ASTWalker.h>
namespace yul
{
/**
* Metric for the size of code.
* More specifically, the number of AST nodes.
* Ignores function definitions while traversing the AST.
* If you want to know the size of a function, you have to invoke this on its body.
*/
class CodeSize: public ASTWalker
{
public:
static size_t codeSize(Statement const& _statement);
static size_t codeSize(Expression const& _expression);
static size_t codeSize(Block const& _block);
private:
void visit(Statement const& _statement) override;
void visit(Expression const& _expression) override;
private:
size_t m_size = 0;
};
/**
* Very rough cost that takes the size and execution cost of code into account.
* The cost per AST element is one, except for literals where it is the byte size.
* Function calls cost 50. Instructions cost 0 for 3 or less gas (same as DUP),
* 2 for up to 10 and 50 otherwise.
*/
class CodeCost: public ASTWalker
{
public:
static size_t codeCost(Expression const& _expression);
private:
void operator()(FunctionCall const& _funCall) override;
void operator()(FunctionalInstruction const& _instr) override;
void operator()(Literal const& _literal) override;
void visit(Statement const& _statement) override;
void visit(Expression const& _expression) override;
private:
size_t m_cost = 0;
};
}