mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
307 lines
8.7 KiB
C++
307 lines
8.7 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/>.
|
|
*/
|
|
/**
|
|
* Interactive yul optimizer
|
|
*/
|
|
|
|
#include <libsolutil/CommonIO.h>
|
|
#include <liblangutil/ErrorReporter.h>
|
|
#include <liblangutil/Scanner.h>
|
|
#include <libyul/AsmAnalysis.h>
|
|
#include <libyul/AsmAnalysisInfo.h>
|
|
#include <libsolidity/parsing/Parser.h>
|
|
#include <libyul/AsmData.h>
|
|
#include <libyul/AsmParser.h>
|
|
#include <libyul/AsmPrinter.h>
|
|
#include <libyul/Object.h>
|
|
#include <liblangutil/SourceReferenceFormatter.h>
|
|
|
|
#include <libyul/optimiser/BlockFlattener.h>
|
|
#include <libyul/optimiser/Disambiguator.h>
|
|
#include <libyul/optimiser/CallGraphGenerator.h>
|
|
#include <libyul/optimiser/CommonSubexpressionEliminator.h>
|
|
#include <libyul/optimiser/ConditionalSimplifier.h>
|
|
#include <libyul/optimiser/ConditionalUnsimplifier.h>
|
|
#include <libyul/optimiser/ControlFlowSimplifier.h>
|
|
#include <libyul/optimiser/NameCollector.h>
|
|
#include <libyul/optimiser/EquivalentFunctionCombiner.h>
|
|
#include <libyul/optimiser/ExpressionSplitter.h>
|
|
#include <libyul/optimiser/FunctionGrouper.h>
|
|
#include <libyul/optimiser/FunctionHoister.h>
|
|
#include <libyul/optimiser/ExpressionInliner.h>
|
|
#include <libyul/optimiser/FullInliner.h>
|
|
#include <libyul/optimiser/ForLoopConditionIntoBody.h>
|
|
#include <libyul/optimiser/ForLoopConditionOutOfBody.h>
|
|
#include <libyul/optimiser/ForLoopInitRewriter.h>
|
|
#include <libyul/optimiser/MainFunction.h>
|
|
#include <libyul/optimiser/Rematerialiser.h>
|
|
#include <libyul/optimiser/ExpressionSimplifier.h>
|
|
#include <libyul/optimiser/UnusedPruner.h>
|
|
#include <libyul/optimiser/DeadCodeEliminator.h>
|
|
#include <libyul/optimiser/ExpressionJoiner.h>
|
|
#include <libyul/optimiser/OptimiserStep.h>
|
|
#include <libyul/optimiser/RedundantAssignEliminator.h>
|
|
#include <libyul/optimiser/SSAReverser.h>
|
|
#include <libyul/optimiser/SSATransform.h>
|
|
#include <libyul/optimiser/StackCompressor.h>
|
|
#include <libyul/optimiser/StructuralSimplifier.h>
|
|
#include <libyul/optimiser/Semantics.h>
|
|
#include <libyul/optimiser/VarDeclInitializer.h>
|
|
#include <libyul/optimiser/VarNameCleaner.h>
|
|
#include <libyul/optimiser/LoadResolver.h>
|
|
#include <libyul/optimiser/LoopInvariantCodeMotion.h>
|
|
|
|
#include <libyul/backends/evm/EVMDialect.h>
|
|
|
|
#include <libsolutil/JSON.h>
|
|
|
|
#include <boost/program_options.hpp>
|
|
|
|
#include <string>
|
|
#include <sstream>
|
|
#include <iostream>
|
|
#include <variant>
|
|
|
|
using namespace std;
|
|
using namespace solidity;
|
|
using namespace solidity::util;
|
|
using namespace solidity::langutil;
|
|
using namespace solidity::frontend;
|
|
using namespace solidity::yul;
|
|
|
|
namespace po = boost::program_options;
|
|
|
|
class YulOpti
|
|
{
|
|
public:
|
|
void printErrors()
|
|
{
|
|
SourceReferenceFormatter formatter(cout);
|
|
|
|
for (auto const& error: m_errors)
|
|
formatter.printErrorInformation(*error);
|
|
}
|
|
|
|
bool parse(string const& _input)
|
|
{
|
|
ErrorReporter errorReporter(m_errors);
|
|
shared_ptr<Scanner> scanner = make_shared<Scanner>(CharStream(_input, ""));
|
|
m_ast = yul::Parser(errorReporter, m_dialect).parse(scanner, false);
|
|
if (!m_ast || !errorReporter.errors().empty())
|
|
{
|
|
cout << "Error parsing source." << endl;
|
|
printErrors();
|
|
return false;
|
|
}
|
|
m_analysisInfo = make_shared<yul::AsmAnalysisInfo>();
|
|
AsmAnalyzer analyzer(
|
|
*m_analysisInfo,
|
|
errorReporter,
|
|
m_dialect
|
|
);
|
|
if (!analyzer.analyze(*m_ast) || !errorReporter.errors().empty())
|
|
{
|
|
cout << "Error analyzing source." << endl;
|
|
printErrors();
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void runInteractive(string source)
|
|
{
|
|
bool disambiguated = false;
|
|
while (true)
|
|
{
|
|
cout << "----------------------" << endl;
|
|
cout << source << endl;
|
|
if (!parse(source))
|
|
return;
|
|
set<YulString> reservedIdentifiers;
|
|
if (!disambiguated)
|
|
{
|
|
*m_ast = std::get<yul::Block>(Disambiguator(m_dialect, *m_analysisInfo)(*m_ast));
|
|
m_analysisInfo.reset();
|
|
m_nameDispenser = make_shared<NameDispenser>(m_dialect, *m_ast, reservedIdentifiers);
|
|
disambiguated = true;
|
|
}
|
|
cout << "(q)quit/(f)latten/(c)se/initialize var(d)ecls/(x)plit/(j)oin/(g)rouper/(h)oister/" << endl;
|
|
cout << " (e)xpr inline/(i)nline/(s)implify/varname c(l)eaner/(u)nusedprune/ss(a) transform/" << endl;
|
|
cout << " (r)edundant assign elim./re(m)aterializer/f(o)r-loop-init-rewriter/for-loop-condition-(I)nto-body/" << endl;
|
|
cout << " for-loop-condition-(O)ut-of-body/s(t)ructural simplifier/equi(v)alent function combiner/ssa re(V)erser/" << endl;
|
|
cout << " co(n)trol flow simplifier/stack com(p)ressor/(D)ead code eliminator/(L)oad resolver/" << endl;
|
|
cout << " (C)onditional simplifier/conditional (U)nsimplifier/loop-invariant code (M)otion?" << endl;
|
|
cout.flush();
|
|
int option = readStandardInputChar();
|
|
cout << ' ' << char(option) << endl;
|
|
|
|
OptimiserStepContext context{m_dialect, *m_nameDispenser, reservedIdentifiers};
|
|
switch (option)
|
|
{
|
|
case 'q':
|
|
return;
|
|
case 'f':
|
|
BlockFlattener::run(context, *m_ast);
|
|
break;
|
|
case 'o':
|
|
ForLoopInitRewriter::run(context, *m_ast);
|
|
break;
|
|
case 'O':
|
|
ForLoopConditionOutOfBody::run(context, *m_ast);
|
|
break;
|
|
case 'I':
|
|
ForLoopConditionIntoBody::run(context, *m_ast);
|
|
break;
|
|
case 'c':
|
|
CommonSubexpressionEliminator::run(context, *m_ast);
|
|
break;
|
|
case 'C':
|
|
ConditionalSimplifier::run(context, *m_ast);
|
|
break;
|
|
case 'U':
|
|
ConditionalUnsimplifier::run(context, *m_ast);
|
|
break;
|
|
case 'd':
|
|
VarDeclInitializer::run(context, *m_ast);
|
|
break;
|
|
case 'l':
|
|
VarNameCleaner::run(context, *m_ast);
|
|
break;
|
|
case 'x':
|
|
ExpressionSplitter::run(context, *m_ast);
|
|
break;
|
|
case 'j':
|
|
ExpressionJoiner::run(context, *m_ast);
|
|
break;
|
|
case 'g':
|
|
FunctionGrouper::run(context, *m_ast);
|
|
break;
|
|
case 'h':
|
|
FunctionHoister::run(context, *m_ast);
|
|
break;
|
|
case 'e':
|
|
ExpressionInliner::run(context, *m_ast);
|
|
break;
|
|
case 'i':
|
|
FullInliner::run(context, *m_ast);
|
|
break;
|
|
case 's':
|
|
ExpressionSimplifier::run(context, *m_ast);
|
|
break;
|
|
case 't':
|
|
StructuralSimplifier::run(context, *m_ast);
|
|
break;
|
|
case 'T':
|
|
LiteralRematerialiser::run(context, *m_ast);
|
|
break;
|
|
case 'n':
|
|
ControlFlowSimplifier::run(context, *m_ast);
|
|
break;
|
|
case 'u':
|
|
UnusedPruner::run(context, *m_ast);
|
|
break;
|
|
case 'D':
|
|
DeadCodeEliminator::run(context, *m_ast);
|
|
break;
|
|
case 'a':
|
|
SSATransform::run(context, *m_ast);
|
|
break;
|
|
case 'r':
|
|
RedundantAssignEliminator::run(context, *m_ast);
|
|
break;
|
|
case 'm':
|
|
Rematerialiser::run(context, *m_ast);
|
|
break;
|
|
case 'v':
|
|
EquivalentFunctionCombiner::run(context, *m_ast);
|
|
break;
|
|
case 'V':
|
|
SSAReverser::run(context, *m_ast);
|
|
break;
|
|
case 'p':
|
|
{
|
|
Object obj;
|
|
obj.code = m_ast;
|
|
StackCompressor::run(m_dialect, obj, true, 16);
|
|
break;
|
|
}
|
|
case 'L':
|
|
LoadResolver::run(context, *m_ast);
|
|
break;
|
|
case 'M':
|
|
LoopInvariantCodeMotion::run(context, *m_ast);
|
|
break;
|
|
default:
|
|
cout << "Unknown option." << endl;
|
|
}
|
|
source = AsmPrinter{}(*m_ast);
|
|
}
|
|
}
|
|
|
|
private:
|
|
ErrorList m_errors;
|
|
shared_ptr<yul::Block> m_ast;
|
|
Dialect const& m_dialect{EVMDialect::strictAssemblyForEVMObjects(EVMVersion{})};
|
|
shared_ptr<AsmAnalysisInfo> m_analysisInfo;
|
|
shared_ptr<NameDispenser> m_nameDispenser;
|
|
};
|
|
|
|
int main(int argc, char** argv)
|
|
{
|
|
po::options_description options(
|
|
R"(yulopti, yul optimizer exploration tool.
|
|
Usage: yulopti [Options] <file>
|
|
Reads <file> as yul code and applies optimizer steps to it,
|
|
interactively read from stdin.
|
|
|
|
Allowed options)",
|
|
po::options_description::m_default_line_length,
|
|
po::options_description::m_default_line_length - 23);
|
|
options.add_options()
|
|
(
|
|
"input-file",
|
|
po::value<string>(),
|
|
"input file"
|
|
)
|
|
("help", "Show this help screen.");
|
|
|
|
// All positional options should be interpreted as input files
|
|
po::positional_options_description filesPositions;
|
|
filesPositions.add("input-file", 1);
|
|
|
|
po::variables_map arguments;
|
|
try
|
|
{
|
|
po::command_line_parser cmdLineParser(argc, argv);
|
|
cmdLineParser.options(options).positional(filesPositions);
|
|
po::store(cmdLineParser.run(), arguments);
|
|
}
|
|
catch (po::error const& _exception)
|
|
{
|
|
cerr << _exception.what() << endl;
|
|
return 1;
|
|
}
|
|
|
|
string input;
|
|
if (arguments.count("input-file"))
|
|
YulOpti{}.runInteractive(readFileAsString(arguments["input-file"].as<string>()));
|
|
else
|
|
cout << options;
|
|
|
|
return 0;
|
|
}
|