aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/interface/AssemblyStack.h
blob: 01db6b617de7b5a97d67d2a65bd443de2635d3e7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/*
    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/>.
*/
/**
 * Full assembly stack that can support EVM-assembly and Yul as input and EVM, EVM1.5 and
 * eWasm as output.
 */

#pragma once

#include <liblangutil/ErrorReporter.h>
#include <liblangutil/EVMVersion.h>

#include <libyul/Object.h>
#include <libyul/ObjectParser.h>

#include <libevmasm/LinkerObject.h>

#include <memory>
#include <string>

namespace langutil
{
class Scanner;
}
namespace yul
{
class AbstractAssembly;
}

namespace dev
{
namespace solidity
{

struct MachineAssemblyObject
{
    std::shared_ptr<eth::LinkerObject> bytecode;
    std::string assembly;
};

/*
 * Full assembly stack that can support EVM-assembly and Yul as input and EVM, EVM1.5 and
 * eWasm as output.
 */
class AssemblyStack
{
public:
    enum class Language { Yul, Assembly, StrictAssembly };
    enum class Machine { EVM, EVM15, eWasm };

    explicit AssemblyStack(EVMVersion _evmVersion = EVMVersion(), Language _language = Language::Assembly):
        m_language(_language), m_evmVersion(_evmVersion), m_errorReporter(m_errors)
    {}

    /// @returns the scanner used during parsing
    langutil::Scanner const& scanner() const;

    /// Runs parsing and analysis steps, returns false if input cannot be assembled.
    /// Multiple calls overwrite the previous state.
    bool parseAndAnalyze(std::string const& _sourceName, std::string const& _source);

    /// Run the optimizer suite. Can only be used with Yul or strict assembly.
    void optimize();

    /// Run the assembly step (should only be called after parseAndAnalyze).
    /// @param _optimize does not run the optimizer but performs optimized code generation.
    MachineAssemblyObject assemble(Machine _machine, bool _optimize = false) const;

    /// @returns the errors generated during parsing, analysis (and potentially assembly).
    langutil::ErrorList const& errors() const { return m_errors; }

    /// Pretty-print the input after having parsed it.
    std::string print() const;

private:
    bool analyzeParsed();
    bool analyzeParsed(yul::Object& _object);

    void compileEVM(yul::AbstractAssembly& _assembly, bool _evm15, bool _optimize) const;

    void optimize(yul::Object& _object);

    Language m_language = Language::Assembly;
    EVMVersion m_evmVersion;

    std::shared_ptr<langutil::Scanner> m_scanner;

    bool m_analysisSuccessful = false;
    std::shared_ptr<yul::Object> m_parserResult;
    langutil::ErrorList m_errors;
    langutil::ErrorReporter m_errorReporter;
};

}
}