solidity/libyul/optimiser/ExpressionInliner.h

75 lines
2.3 KiB
C
Raw Normal View History

2017-11-22 10:11:48 +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/>.
*/
// SPDX-License-Identifier: GPL-3.0
2017-11-22 10:11:48 +00:00
/**
* Optimiser component that performs function inlining.
*/
#pragma once
2018-10-15 09:52:35 +00:00
#include <libyul/optimiser/ASTWalker.h>
#include <libyul/ASTForward.h>
2017-11-22 10:11:48 +00:00
#include <optional>
2017-11-22 10:11:48 +00:00
#include <set>
2019-12-11 16:31:36 +00:00
namespace solidity::yul
2017-11-22 10:11:48 +00:00
{
2018-12-20 17:55:32 +00:00
struct Dialect;
2019-09-23 14:32:50 +00:00
struct OptimiserStepContext;
2017-11-22 10:11:48 +00:00
/**
* Optimiser component that modifies an AST in place, inlining functions that can be
* inlined inside functional expressions, i.e. functions that
* - return a single value
* - have a body like r := <functional expression>
* - neither reference themselves nor r in the right hand side
*
* Furthermore, for all parameters, all of the following need to be true
* - the argument is movable
* - the parameter is either referenced less than twice in the function body, or the argument is rather cheap
* ("cost" of at most 1 like a constant up to 0xff)
2017-11-22 10:11:48 +00:00
*
* This component can only be used on sources with unique names.
*/
2018-02-06 14:30:36 +00:00
class ExpressionInliner: public ASTModifier
2017-11-22 10:11:48 +00:00
{
public:
2019-09-23 14:32:50 +00:00
static constexpr char const* name{"ExpressionInliner"};
static void run(OptimiserStepContext&, Block& _ast);
2017-11-22 10:11:48 +00:00
2018-02-06 14:30:36 +00:00
using ASTModifier::operator();
void operator()(FunctionDefinition& _fun) override;
2018-02-06 14:30:36 +00:00
void visit(Expression& _expression) override;
2017-11-22 10:11:48 +00:00
2018-02-06 14:30:36 +00:00
private:
2019-09-23 14:32:50 +00:00
ExpressionInliner(
Dialect const& _dialect,
std::map<YulString, FunctionDefinition const*> const& _inlinableFunctions
): m_dialect(_dialect), m_inlinableFunctions(_inlinableFunctions)
{}
Dialect const& m_dialect;
std::map<YulString, FunctionDefinition const*> const& m_inlinableFunctions;
std::map<YulString, YulString> m_varReplacements;
2018-02-06 14:30:36 +00:00
/// Set of functions we are currently visiting inside.
std::set<YulString> m_currentFunctions;
2017-11-22 10:11:48 +00:00
};
}