mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
121 lines
3.3 KiB
C++
121 lines
3.3 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/>.
|
|
*/
|
|
// SPDX-License-Identifier: GPL-3.0
|
|
|
|
#pragma once
|
|
|
|
#include <libyul/optimiser/NameDispenser.h>
|
|
#include <libyul/AST.h>
|
|
|
|
#include <liblangutil/Exceptions.h>
|
|
|
|
#include <cstddef>
|
|
#include <optional>
|
|
#include <ostream>
|
|
#include <set>
|
|
#include <string>
|
|
#include <variant>
|
|
#include <vector>
|
|
|
|
namespace solidity::langutil
|
|
{
|
|
|
|
class CharStream;
|
|
class Scanner;
|
|
|
|
}
|
|
|
|
namespace solidity::yul
|
|
{
|
|
|
|
struct AsmAnalysisInfo;
|
|
struct Dialect;
|
|
struct CodeWeights;
|
|
|
|
}
|
|
|
|
namespace solidity::phaser
|
|
{
|
|
|
|
/**
|
|
* Class representing parsed and analysed Yul program that we can apply optimisations to.
|
|
* The program is already disambiguated and has several prerequisite optimiser steps applied to it
|
|
* so that the requirements of any possible step that could be later applied by the user are
|
|
* already satisfied.
|
|
*
|
|
* The class allows the user to apply extra optimisations and obtain metrics and general
|
|
* information about the resulting syntax tree.
|
|
*/
|
|
class Program
|
|
{
|
|
public:
|
|
Program(Program const& program);
|
|
Program(Program&& program):
|
|
m_ast(std::move(program.m_ast)),
|
|
m_dialect{program.m_dialect},
|
|
m_nameDispenser(std::move(program.m_nameDispenser))
|
|
{}
|
|
Program operator=(Program const& program) = delete;
|
|
Program operator=(Program&& program) = delete;
|
|
|
|
static std::variant<Program, langutil::ErrorList> load(langutil::CharStream& _sourceCode);
|
|
void optimise(std::vector<std::string> const& _optimisationSteps);
|
|
|
|
size_t codeSize(yul::CodeWeights const& _weights) const { return computeCodeSize(*m_ast, _weights); }
|
|
yul::Block const& ast() const { return *m_ast; }
|
|
|
|
friend std::ostream& operator<<(std::ostream& _stream, Program const& _program);
|
|
std::string toJson() const;
|
|
|
|
private:
|
|
Program(
|
|
yul::Dialect const& _dialect,
|
|
std::unique_ptr<yul::Block> _ast
|
|
):
|
|
m_ast(std::move(_ast)),
|
|
m_dialect{_dialect},
|
|
m_nameDispenser(_dialect, *m_ast, {})
|
|
{}
|
|
|
|
static std::variant<std::unique_ptr<yul::Block>, langutil::ErrorList> parseObject(
|
|
yul::Dialect const& _dialect,
|
|
langutil::CharStream _source
|
|
);
|
|
static std::variant<std::unique_ptr<yul::AsmAnalysisInfo>, langutil::ErrorList> analyzeAST(
|
|
yul::Dialect const& _dialect,
|
|
yul::Block const& _ast
|
|
);
|
|
static std::unique_ptr<yul::Block> disambiguateAST(
|
|
yul::Dialect const& _dialect,
|
|
yul::Block const& _ast,
|
|
yul::AsmAnalysisInfo const& _analysisInfo
|
|
);
|
|
static std::unique_ptr<yul::Block> applyOptimisationSteps(
|
|
yul::Dialect const& _dialect,
|
|
yul::NameDispenser& _nameDispenser,
|
|
std::unique_ptr<yul::Block> _ast,
|
|
std::vector<std::string> const& _optimisationSteps
|
|
);
|
|
static size_t computeCodeSize(yul::Block const& _ast, yul::CodeWeights const& _weights);
|
|
|
|
std::unique_ptr<yul::Block> m_ast;
|
|
yul::Dialect const& m_dialect;
|
|
yul::NameDispenser m_nameDispenser;
|
|
};
|
|
|
|
}
|