solidity/libyul/optimiser/Suite.h

104 lines
3.0 KiB
C
Raw Normal View History

2018-10-16 19:39:22 +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
2018-10-16 19:39:22 +00:00
/**
* Optimiser suite that combines all steps and also provides the settings for the heuristics.
*/
#pragma once
#include <libyul/ASTForward.h>
#include <libyul/YulString.h>
2019-09-23 14:32:50 +00:00
#include <libyul/optimiser/OptimiserStep.h>
#include <libyul/optimiser/NameDispenser.h>
2019-02-21 20:56:30 +00:00
#include <liblangutil/EVMVersion.h>
2018-10-16 19:39:22 +00:00
#include <set>
2019-09-23 14:32:50 +00:00
#include <string>
#include <memory>
2018-10-16 19:39:22 +00:00
2019-12-11 16:31:36 +00:00
namespace solidity::yul
2018-10-16 19:39:22 +00:00
{
struct AsmAnalysisInfo;
2018-12-20 17:55:32 +00:00
struct Dialect;
2019-05-15 08:33:35 +00:00
class GasMeter;
struct Object;
2018-10-16 19:39:22 +00:00
/**
* Optimiser suite that combines all steps and also provides the settings for the heuristics.
* Only optimizes the code of the provided object, does not descend into the sub-objects.
2018-10-16 19:39:22 +00:00
*/
class OptimiserSuite
{
public:
static constexpr size_t MaxRounds = 12;
/// Special characters that do not represent optimiser steps but are allowed in abbreviation sequences.
/// Some of them (like whitespace) are ignored, others (like brackets) are a part of the syntax.
static constexpr char NonStepAbbreviations[] = " \n[]";
2019-09-23 14:32:50 +00:00
enum class Debug
{
None,
2019-10-07 06:16:28 +00:00
PrintStep,
PrintChanges
2019-09-23 14:32:50 +00:00
};
2018-10-16 19:39:22 +00:00
static void run(
Dialect const& _dialect,
2019-05-29 21:14:06 +00:00
GasMeter const* _meter,
Object& _object,
bool _optimizeStackAllocation,
std::string const& _optimisationSequence,
std::set<YulString> const& _externallyUsedIdentifiers = {}
2018-10-16 19:39:22 +00:00
);
2019-09-23 14:32:50 +00:00
/// Ensures that specified sequence of step abbreviations is well-formed and can be executed.
/// @throw OptimizerException if the sequence is invalid
static void validateSequence(std::string const& _stepAbbreviations);
2019-09-23 14:32:50 +00:00
void runSequence(std::vector<std::string> const& _steps, Block& _ast);
void runSequence(std::string const& _stepAbbreviations, Block& _ast);
void runSequenceUntilStable(
std::vector<std::string> const& _steps,
Block& _ast,
size_t maxRounds = MaxRounds
);
2019-09-23 14:32:50 +00:00
static std::map<std::string, std::unique_ptr<OptimiserStep>> const& allSteps();
static std::map<std::string, char> const& stepNameToAbbreviationMap();
static std::map<char, std::string> const& stepAbbreviationToNameMap();
2019-09-23 14:32:50 +00:00
private:
OptimiserSuite(
Dialect const& _dialect,
std::set<YulString> const& _externallyUsedIdentifiers,
Debug _debug,
Block& _ast
):
m_dispenser{_dialect, _ast, _externallyUsedIdentifiers},
m_context{_dialect, m_dispenser, _externallyUsedIdentifiers},
m_debug(_debug)
{}
NameDispenser m_dispenser;
OptimiserStepContext m_context;
Debug m_debug;
2018-10-16 19:39:22 +00:00
};
}