aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/interface/AssemblyStack.cpp
blob: b97e00ae5475ddb873f1f8582c59816775be6d8c (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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/*
    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.
 */


#include <libsolidity/interface/AssemblyStack.h>

#include <libsolidity/codegen/AsmCodeGen.h>

#include <liblangutil/Scanner.h>
#include <libyul/AsmPrinter.h>
#include <libyul/AsmParser.h>
#include <libyul/AsmAnalysis.h>
#include <libyul/AsmAnalysisInfo.h>
#include <libyul/backends/evm/EVMObjectCompiler.h>
#include <libyul/backends/evm/EVMCodeTransform.h>
#include <libyul/backends/evm/EVMAssembly.h>
#include <libyul/backends/evm/EVMDialect.h>
#include <libyul/ObjectParser.h>

#include <libevmasm/Assembly.h>

#include <libyul/optimiser/Suite.h>

using namespace std;
using namespace dev;
using namespace langutil;
using namespace dev::solidity;

namespace
{
shared_ptr<yul::Dialect> languageToDialect(AssemblyStack::Language _language)
{
    switch (_language)
    {
    case AssemblyStack::Language::Assembly:
        return yul::EVMDialect::looseAssemblyForEVM();
    case AssemblyStack::Language::StrictAssembly:
        return yul::EVMDialect::strictAssemblyForEVMObjects();
    case AssemblyStack::Language::Yul:
        return yul::Dialect::yul();
    }
    solAssert(false, "");
    return yul::Dialect::yul();
}

}


Scanner const& AssemblyStack::scanner() const
{
    solAssert(m_scanner, "");
    return *m_scanner;
}

bool AssemblyStack::parseAndAnalyze(std::string const& _sourceName, std::string const& _source)
{
    m_errors.clear();
    m_analysisSuccessful = false;
    m_scanner = make_shared<Scanner>(CharStream(_source, _sourceName));
    m_parserResult = yul::ObjectParser(m_errorReporter, languageToDialect(m_language)).parse(m_scanner, false);
    if (!m_errorReporter.errors().empty())
        return false;
    solAssert(m_parserResult, "");
    solAssert(m_parserResult->code, "");

    return analyzeParsed();
}

void AssemblyStack::optimize()
{
    solAssert(m_language != Language::Assembly, "Optimization requested for loose assembly.");
    solAssert(m_analysisSuccessful, "Analysis was not successful.");
    m_analysisSuccessful = false;
    optimize(*m_parserResult);
    solAssert(analyzeParsed(), "Invalid source code after optimization.");
}

bool AssemblyStack::analyzeParsed()
{
    solAssert(m_parserResult, "");
    m_analysisSuccessful = analyzeParsed(*m_parserResult);
    return m_analysisSuccessful;
}

bool AssemblyStack::analyzeParsed(yul::Object& _object)
{
    solAssert(_object.code, "");
    _object.analysisInfo = make_shared<yul::AsmAnalysisInfo>();
    yul::AsmAnalyzer analyzer(*_object.analysisInfo, m_errorReporter, m_evmVersion, boost::none, languageToDialect(m_language));
    bool success = analyzer.analyze(*_object.code);
    for (auto& subNode: _object.subObjects)
        if (auto subObject = dynamic_cast<yul::Object*>(subNode.get()))
            if (!analyzeParsed(*subObject))
                success = false;
    return success;
}

void AssemblyStack::compileEVM(yul::AbstractAssembly& _assembly, bool _evm15, bool _optimize) const
{
    shared_ptr<yul::EVMDialect> dialect;

    if (m_language == Language::Assembly)
        dialect = yul::EVMDialect::looseAssemblyForEVM();
    else if (m_language == AssemblyStack::Language::StrictAssembly)
        dialect = yul::EVMDialect::strictAssemblyForEVMObjects();
    else if (m_language == AssemblyStack::Language::Yul)
        dialect = yul::EVMDialect::yulForEVM();
    else
        solAssert(false, "Invalid language.");

    yul::EVMObjectCompiler::compile(*m_parserResult, _assembly, *dialect, _evm15, _optimize);
}

void AssemblyStack::optimize(yul::Object& _object)
{
    solAssert(_object.code, "");
    solAssert(_object.analysisInfo, "");
    for (auto& subNode: _object.subObjects)
        if (auto subObject = dynamic_cast<yul::Object*>(subNode.get()))
            optimize(*subObject);
    yul::OptimiserSuite::run(*_object.code, *_object.analysisInfo);
}

MachineAssemblyObject AssemblyStack::assemble(Machine _machine, bool _optimize) const
{
    solAssert(m_analysisSuccessful, "");
    solAssert(m_parserResult, "");
    solAssert(m_parserResult->code, "");
    solAssert(m_parserResult->analysisInfo, "");

    switch (_machine)
    {
    case Machine::EVM:
    {
        MachineAssemblyObject object;
        eth::Assembly assembly;
        EthAssemblyAdapter adapter(assembly);
        compileEVM(adapter, false, _optimize);
        object.bytecode = make_shared<eth::LinkerObject>(assembly.assemble());
        object.assembly = assembly.assemblyString();
        return object;
    }
    case Machine::EVM15:
    {
        MachineAssemblyObject object;
        yul::EVMAssembly assembly(true);
        compileEVM(assembly, true, _optimize);
        object.bytecode = make_shared<eth::LinkerObject>(assembly.finalize());
        /// TODO: fill out text representation
        return object;
    }
    case Machine::eWasm:
        solUnimplemented("eWasm backend is not yet implemented.");
    }
    // unreachable
    return MachineAssemblyObject();
}

string AssemblyStack::print() const
{
    solAssert(m_parserResult, "");
    solAssert(m_parserResult->code, "");
    return m_parserResult->toString(m_language == Language::Yul) + "\n";
}