aboutsummaryrefslogtreecommitdiffstats
path: root/CompilerStack.cpp
blob: 11d90d08bdc2cc34a02b1da973e709706a595f7c (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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/*
    This file is part of cpp-ethereum.

    cpp-ethereum 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.

    cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @author Gav Wood <g@ethdev.com>
 * @date 2014
 * Full-stack compiler that converts a source code string to bytecode.
 */

#include <libsolidity/AST.h>
#include <libsolidity/Scanner.h>
#include <libsolidity/Parser.h>
#include <libsolidity/GlobalContext.h>
#include <libsolidity/NameAndTypeResolver.h>
#include <libsolidity/Compiler.h>
#include <libsolidity/CompilerStack.h>
#include <libsolidity/InterfaceHandler.h>

#include <libdevcrypto/SHA3.h>

using namespace std;

namespace dev
{
namespace solidity
{

bool CompilerStack::addSource(string const& _name, string const& _content)
{
    bool existed = m_sources.count(_name);
    reset(true);
    m_sources[_name].scanner = make_shared<Scanner>(CharStream(_content), _name);
    return existed;
}

void CompilerStack::setSource(string const& _sourceCode)
{
    reset();
    addSource("", _sourceCode);
}

void CompilerStack::parse()
{
    for (auto& sourcePair: m_sources)
    {
        sourcePair.second.scanner->reset();
        sourcePair.second.ast = Parser().parse(sourcePair.second.scanner);
    }
    resolveImports();

    m_globalContext = make_shared<GlobalContext>();
    NameAndTypeResolver resolver(m_globalContext->getDeclarations());
    for (Source const* source: m_sourceOrder)
        resolver.registerDeclarations(*source->ast);
    for (Source const* source: m_sourceOrder)
        for (ASTPointer<ASTNode> const& node: source->ast->getNodes())
            if (ContractDefinition* contract = dynamic_cast<ContractDefinition*>(node.get()))
            {
                m_globalContext->setCurrentContract(*contract);
                resolver.updateDeclaration(*m_globalContext->getCurrentThis());
                resolver.resolveNamesAndTypes(*contract);
                m_contracts[contract->getName()].contract = contract;
            }
    for (Source const* source: m_sourceOrder)
        for (ASTPointer<ASTNode> const& node: source->ast->getNodes())
            if (ContractDefinition* contract = dynamic_cast<ContractDefinition*>(node.get()))
            {
                m_globalContext->setCurrentContract(*contract);
                resolver.updateDeclaration(*m_globalContext->getCurrentThis());
                resolver.checkTypeRequirements(*contract);
                m_contracts[contract->getName()].contract = contract;
            }
    m_parseSuccessful = true;
}

void CompilerStack::parse(string const& _sourceCode)
{
    setSource(_sourceCode);
    parse();
}

vector<string> CompilerStack::getContractNames() const
{
    if (!m_parseSuccessful)
        BOOST_THROW_EXCEPTION(CompilerError() << errinfo_comment("Parsing was not successful."));
    vector<string> contractNames;
    for (auto const& contract: m_contracts)
        contractNames.push_back(contract.first);
    return contractNames;
}

void CompilerStack::compile(bool _optimize)
{
    if (!m_parseSuccessful)
        parse();

    map<ContractDefinition const*, bytes const*> contractBytecode;
    for (Source const* source: m_sourceOrder)
        for (ASTPointer<ASTNode> const& node: source->ast->getNodes())
            if (ContractDefinition* contract = dynamic_cast<ContractDefinition*>(node.get()))
            {
                m_globalContext->setCurrentContract(*contract);
                shared_ptr<Compiler> compiler = make_shared<Compiler>(_optimize);
                compiler->compileContract(*contract, m_globalContext->getMagicVariables(),
                                          contractBytecode);
                Contract& compiledContract = m_contracts[contract->getName()];
                compiledContract.bytecode = compiler->getAssembledBytecode();
                compiledContract.runtimeBytecode = compiler->getRuntimeBytecode();
                compiledContract.compiler = move(compiler);
                contractBytecode[compiledContract.contract] = &compiledContract.bytecode;
            }
}

bytes const& CompilerStack::compile(string const& _sourceCode, bool _optimize)
{
    parse(_sourceCode);
    compile(_optimize);
    return getBytecode();
}

bytes const& CompilerStack::getBytecode(string const& _contractName) const
{
    return getContract(_contractName).bytecode;
}

bytes const& CompilerStack::getRuntimeBytecode(string const& _contractName) const
{
    return getContract(_contractName).runtimeBytecode;
}

dev::h256 CompilerStack::getContractCodeHash(string const& _contractName) const
{
    return dev::sha3(getRuntimeBytecode(_contractName));
}

void CompilerStack::streamAssembly(ostream& _outStream, string const& _contractName) const
{
    getContract(_contractName).compiler->streamAssembly(_outStream);
}

string const& CompilerStack::getInterface(string const& _contractName) const
{
    return getMetadata(_contractName, DocumentationType::ABI_INTERFACE);
}

string const& CompilerStack::getSolidityInterface(string const& _contractName) const
{
    return getMetadata(_contractName, DocumentationType::ABI_SOLIDITY_INTERFACE);
}

string const& CompilerStack::getMetadata(string const& _contractName, DocumentationType _type) const
{
    if (!m_parseSuccessful)
        BOOST_THROW_EXCEPTION(CompilerError() << errinfo_comment("Parsing was not successful."));

    Contract const& contract = getContract(_contractName);

    std::unique_ptr<string const>* doc;
    switch (_type)
    {
    case DocumentationType::NATSPEC_USER:
        doc = &contract.userDocumentation;
        break;
    case DocumentationType::NATSPEC_DEV:
        doc = &contract.devDocumentation;
        break;
    case DocumentationType::ABI_INTERFACE:
        doc = &contract.interface;
        break;
    case DocumentationType::ABI_SOLIDITY_INTERFACE:
        doc = &contract.solidityInterface;
        break;
    default:
        BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Illegal documentation type."));
    }
    if (!*doc)
        *doc = contract.interfaceHandler->getDocumentation(*contract.contract, _type);
    return *(*doc);
}

Scanner const& CompilerStack::getScanner(string const& _sourceName) const
{
    return *getSource(_sourceName).scanner;
}

SourceUnit const& CompilerStack::getAST(string const& _sourceName) const
{
    return *getSource(_sourceName).ast;
}

ContractDefinition const& CompilerStack::getContractDefinition(string const& _contractName) const
{
    return *getContract(_contractName).contract;
}

bytes CompilerStack::staticCompile(std::string const& _sourceCode, bool _optimize)
{
    CompilerStack stack;
    return stack.compile(_sourceCode, _optimize);
}

void CompilerStack::reset(bool _keepSources)
{
    m_parseSuccessful = false;
    if (_keepSources)
        for (auto sourcePair: m_sources)
            sourcePair.second.reset();
    else
        m_sources.clear();
    m_globalContext.reset();
    m_sourceOrder.clear();
    m_contracts.clear();
}

void CompilerStack::resolveImports()
{
    // topological sorting (depth first search) of the import graph, cutting potential cycles
    vector<Source const*> sourceOrder;
    set<Source const*> sourcesSeen;

    function<void(Source const*)> toposort = [&](Source const* _source)
    {
        if (sourcesSeen.count(_source))
            return;
        sourcesSeen.insert(_source);
        for (ASTPointer<ASTNode> const& node: _source->ast->getNodes())
            if (ImportDirective const* import = dynamic_cast<ImportDirective*>(node.get()))
            {
                string const& id = import->getIdentifier();
                if (!m_sources.count(id))
                    BOOST_THROW_EXCEPTION(ParserError()
                                          << errinfo_sourceLocation(import->getLocation())
                                          << errinfo_comment("Source not found."));
                toposort(&m_sources[id]);
            }
        sourceOrder.push_back(_source);
    };

    for (auto const& sourcePair: m_sources)
        toposort(&sourcePair.second);

    swap(m_sourceOrder, sourceOrder);
}

CompilerStack::Contract const& CompilerStack::getContract(string const& _contractName) const
{
    if (m_contracts.empty())
        BOOST_THROW_EXCEPTION(CompilerError() << errinfo_comment("No compiled contracts found."));
    string contractName = _contractName;
    if (_contractName.empty())
        // try to find the "last contract"
        for (ASTPointer<ASTNode> const& node: m_sourceOrder.back()->ast->getNodes())
            if (auto contract = dynamic_cast<ContractDefinition const*>(node.get()))
                contractName = contract->getName();
    auto it = m_contracts.find(contractName);
    if (it == m_contracts.end())
        BOOST_THROW_EXCEPTION(CompilerError() << errinfo_comment("Contract " + _contractName + " not found."));
    return it->second;
}

CompilerStack::Source const& CompilerStack::getSource(string const& _sourceName) const
{
    auto it = m_sources.find(_sourceName);
    if (it == m_sources.end())
        BOOST_THROW_EXCEPTION(CompilerError() << errinfo_comment("Given source file not found."));
    return it->second;
}

CompilerStack::Contract::Contract(): interfaceHandler(make_shared<InterfaceHandler>()) {}

}
}