aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/codegen/CompilerContext.cpp
blob: 47333046673b06a37a5888a72b9f20d7fb25b60a (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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
/*
    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/>.
*/
/**
 * @author Christian <c@ethdev.com>
 * @date 2014
 * Utilities for the solidity compiler.
 */

#include <libsolidity/codegen/CompilerContext.h>
#include <libsolidity/codegen/CompilerUtils.h>
#include <libsolidity/ast/AST.h>
#include <libsolidity/codegen/Compiler.h>
#include <libsolidity/interface/Version.h>
#include <libsolidity/interface/ErrorReporter.h>
#include <libsolidity/interface/SourceReferenceFormatter.h>
#include <libsolidity/parsing/Scanner.h>
#include <libsolidity/inlineasm/AsmParser.h>
#include <libsolidity/inlineasm/AsmCodeGen.h>
#include <libsolidity/inlineasm/AsmAnalysis.h>
#include <libsolidity/inlineasm/AsmAnalysisInfo.h>

#include <boost/algorithm/string/replace.hpp>

#include <utility>
#include <numeric>

// Change to "define" to output all intermediate code
#undef SOL_OUTPUT_ASM
#ifdef SOL_OUTPUT_ASM
#include <libsolidity/inlineasm/AsmPrinter.h>
#endif


using namespace std;

namespace dev
{
namespace solidity
{

void CompilerContext::addStateVariable(
    VariableDeclaration const& _declaration,
    u256 const& _storageOffset,
    unsigned _byteOffset
)
{
    m_stateVariables[&_declaration] = make_pair(_storageOffset, _byteOffset);
}

void CompilerContext::startFunction(Declaration const& _function)
{
    m_functionCompilationQueue.startFunction(_function);
    *this << functionEntryLabel(_function);
}

void CompilerContext::callLowLevelFunction(
    string const& _name,
    unsigned _inArgs,
    unsigned _outArgs,
    function<void(CompilerContext&)> const& _generator
)
{
    eth::AssemblyItem retTag = pushNewTag();
    CompilerUtils(*this).moveIntoStack(_inArgs);

    *this << lowLevelFunctionTag(_name, _inArgs, _outArgs, _generator);

    appendJump(eth::AssemblyItem::JumpType::IntoFunction);
    adjustStackOffset(int(_outArgs) - 1 - _inArgs);
    *this << retTag.tag();
}

eth::AssemblyItem CompilerContext::lowLevelFunctionTag(
    string const& _name,
    unsigned _inArgs,
    unsigned _outArgs,
    function<void(CompilerContext&)> const& _generator
)
{
    auto it = m_lowLevelFunctions.find(_name);
    if (it == m_lowLevelFunctions.end())
    {
        eth::AssemblyItem tag = newTag().pushTag();
        m_lowLevelFunctions.insert(make_pair(_name, tag));
        m_lowLevelFunctionGenerationQueue.push(make_tuple(_name, _inArgs, _outArgs, _generator));
        return tag;
    }
    else
        return it->second;
}

void CompilerContext::appendMissingLowLevelFunctions()
{
    while (!m_lowLevelFunctionGenerationQueue.empty())
    {
        string name;
        unsigned inArgs;
        unsigned outArgs;
        function<void(CompilerContext&)> generator;
        tie(name, inArgs, outArgs, generator) = m_lowLevelFunctionGenerationQueue.front();
        m_lowLevelFunctionGenerationQueue.pop();

        setStackOffset(inArgs + 1);
        *this << m_lowLevelFunctions.at(name).tag();
        generator(*this);
        CompilerUtils(*this).moveToStackTop(outArgs);
        appendJump(eth::AssemblyItem::JumpType::OutOfFunction);
        solAssert(stackHeight() == outArgs, "Invalid stack height in low-level function " + name + ".");
    }
}

void CompilerContext::addVariable(VariableDeclaration const& _declaration,
                                  unsigned _offsetToCurrent)
{
    solAssert(m_asm->deposit() >= 0 && unsigned(m_asm->deposit()) >= _offsetToCurrent, "");
    m_localVariables[&_declaration].push_back(unsigned(m_asm->deposit()) - _offsetToCurrent);
}

void CompilerContext::removeVariable(VariableDeclaration const& _declaration)
{
    solAssert(m_localVariables.count(&_declaration) && !m_localVariables[&_declaration].empty(), "");
    m_localVariables[&_declaration].pop_back();
    if (m_localVariables[&_declaration].empty())
        m_localVariables.erase(&_declaration);
}

eth::Assembly const& CompilerContext::compiledContract(const ContractDefinition& _contract) const
{
    auto ret = m_compiledContracts.find(&_contract);
    solAssert(ret != m_compiledContracts.end(), "Compiled contract not found.");
    return *ret->second;
}

bool CompilerContext::isLocalVariable(Declaration const* _declaration) const
{
    return !!m_localVariables.count(_declaration);
}

eth::AssemblyItem CompilerContext::functionEntryLabel(Declaration const& _declaration)
{
    return m_functionCompilationQueue.entryLabel(_declaration, *this);
}

eth::AssemblyItem CompilerContext::functionEntryLabelIfExists(Declaration const& _declaration) const
{
    return m_functionCompilationQueue.entryLabelIfExists(_declaration);
}

FunctionDefinition const& CompilerContext::resolveVirtualFunction(FunctionDefinition const& _function)
{
    // Libraries do not allow inheritance and their functions can be inlined, so we should not
    // search the inheritance hierarchy (which will be the wrong one in case the function
    // is inlined).
    if (auto scope = dynamic_cast<ContractDefinition const*>(_function.scope()))
        if (scope->isLibrary())
            return _function;
    solAssert(!m_inheritanceHierarchy.empty(), "No inheritance hierarchy set.");
    return resolveVirtualFunction(_function, m_inheritanceHierarchy.begin());
}

FunctionDefinition const& CompilerContext::superFunction(FunctionDefinition const& _function, ContractDefinition const& _base)
{
    solAssert(!m_inheritanceHierarchy.empty(), "No inheritance hierarchy set.");
    return resolveVirtualFunction(_function, superContract(_base));
}

FunctionDefinition const* CompilerContext::nextConstructor(ContractDefinition const& _contract) const
{
    vector<ContractDefinition const*>::const_iterator it = superContract(_contract);
    for (; it != m_inheritanceHierarchy.end(); ++it)
        if ((*it)->constructor())
            return (*it)->constructor();

    return nullptr;
}

Declaration const* CompilerContext::nextFunctionToCompile() const
{
    return m_functionCompilationQueue.nextFunctionToCompile();
}

ModifierDefinition const& CompilerContext::resolveVirtualFunctionModifier(
    ModifierDefinition const& _modifier
) const
{
    // Libraries do not allow inheritance and their functions can be inlined, so we should not
    // search the inheritance hierarchy (which will be the wrong one in case the function
    // is inlined).
    if (auto scope = dynamic_cast<ContractDefinition const*>(_modifier.scope()))
        if (scope->isLibrary())
            return _modifier;
    solAssert(!m_inheritanceHierarchy.empty(), "No inheritance hierarchy set.");
    for (ContractDefinition const* contract: m_inheritanceHierarchy)
        for (ModifierDefinition const* modifier: contract->functionModifiers())
            if (modifier->name() == _modifier.name())
                return *modifier;
    solAssert(false, "Function modifier " + _modifier.name() + " not found in inheritance hierarchy.");
}

unsigned CompilerContext::baseStackOffsetOfVariable(Declaration const& _declaration) const
{
    auto res = m_localVariables.find(&_declaration);
    solAssert(res != m_localVariables.end(), "Variable not found on stack.");
    solAssert(!res->second.empty(), "");
    return res->second.back();
}

unsigned CompilerContext::baseToCurrentStackOffset(unsigned _baseOffset) const
{
    return m_asm->deposit() - _baseOffset - 1;
}

unsigned CompilerContext::currentToBaseStackOffset(unsigned _offset) const
{
    return m_asm->deposit() - _offset - 1;
}

pair<u256, unsigned> CompilerContext::storageLocationOfVariable(const Declaration& _declaration) const
{
    auto it = m_stateVariables.find(&_declaration);
    solAssert(it != m_stateVariables.end(), "Variable not found in storage.");
    return it->second;
}

CompilerContext& CompilerContext::appendJump(eth::AssemblyItem::JumpType _jumpType)
{
    eth::AssemblyItem item(Instruction::JUMP);
    item.setJumpType(_jumpType);
    return *this << item;
}

CompilerContext& CompilerContext::appendInvalid()
{
    return *this << Instruction::INVALID;
}

CompilerContext& CompilerContext::appendConditionalInvalid()
{
    *this << Instruction::ISZERO;
    eth::AssemblyItem afterTag = appendConditionalJump();
    *this << Instruction::INVALID;
    *this << afterTag;
    return *this;
}

CompilerContext& CompilerContext::appendRevert()
{
    return *this << u256(0) << u256(0) << Instruction::REVERT;
}

CompilerContext& CompilerContext::appendConditionalRevert()
{
    *this << Instruction::ISZERO;
    eth::AssemblyItem afterTag = appendConditionalJump();
    appendRevert();
    *this << afterTag;
    return *this;
}

void CompilerContext::resetVisitedNodes(ASTNode const* _node)
{
    stack<ASTNode const*> newStack;
    newStack.push(_node);
    std::swap(m_visitedNodes, newStack);
    updateSourceLocation();
}

void CompilerContext::appendInlineAssembly(
    string const& _assembly,
    vector<string> const& _localVariables,
    bool _system
)
{
    int startStackHeight = stackHeight();

    julia::ExternalIdentifierAccess identifierAccess;
    identifierAccess.resolve = [&](
        assembly::Identifier const& _identifier,
        julia::IdentifierContext,
        bool
    )
    {
        auto it = std::find(_localVariables.begin(), _localVariables.end(), _identifier.name);
        return it == _localVariables.end() ? size_t(-1) : 1;
    };
    identifierAccess.generateCode = [&](
        assembly::Identifier const& _identifier,
        julia::IdentifierContext _context,
        julia::AbstractAssembly& _assembly
    )
    {
        auto it = std::find(_localVariables.begin(), _localVariables.end(), _identifier.name);
        solAssert(it != _localVariables.end(), "");
        int stackDepth = _localVariables.end() - it;
        int stackDiff = _assembly.stackHeight() - startStackHeight + stackDepth;
        if (_context == julia::IdentifierContext::LValue)
            stackDiff -= 1;
        if (stackDiff < 1 || stackDiff > 16)
            BOOST_THROW_EXCEPTION(
                CompilerError() <<
                errinfo_sourceLocation(_identifier.location) <<
                errinfo_comment("Stack too deep (" + to_string(stackDiff) + "), try removing local variables.")
            );
        if (_context == julia::IdentifierContext::RValue)
            _assembly.appendInstruction(dupInstruction(stackDiff));
        else
        {
            _assembly.appendInstruction(swapInstruction(stackDiff));
            _assembly.appendInstruction(Instruction::POP);
        }
    };

    ErrorList errors;
    ErrorReporter errorReporter(errors);
    auto scanner = make_shared<Scanner>(CharStream(_assembly), "--CODEGEN--");
    auto parserResult = assembly::Parser(errorReporter, assembly::AsmFlavour::Strict).parse(scanner, false);
#ifdef SOL_OUTPUT_ASM
    cout << assembly::AsmPrinter()(*parserResult) << endl;
#endif
    assembly::AsmAnalysisInfo analysisInfo;
    bool analyzerResult = false;
    if (parserResult)
        analyzerResult = assembly::AsmAnalyzer(
            analysisInfo,
            errorReporter,
            m_evmVersion,
            boost::none,
            assembly::AsmFlavour::Strict,
            identifierAccess.resolve
        ).analyze(*parserResult);
    if (!parserResult || !errorReporter.errors().empty() || !analyzerResult)
    {
        string message =
            "Error parsing/analyzing inline assembly block:\n"
            "------------------ Input: -----------------\n" +
            _assembly + "\n"
            "------------------ Errors: ----------------\n";
        for (auto const& error: errorReporter.errors())
            message += SourceReferenceFormatter::formatExceptionInformation(
                *error,
                (error->type() == Error::Type::Warning) ? "Warning" : "Error",
                [&](string const&) -> Scanner const& { return *scanner; }
            );
        message += "-------------------------------------------\n";

        solAssert(false, message);
    }

    solAssert(errorReporter.errors().empty(), "Failed to analyze inline assembly block.");
    assembly::CodeGenerator::assemble(*parserResult, analysisInfo, *m_asm, identifierAccess, _system);

    // Reset the source location to the one of the node (instead of the CODEGEN source location)
    updateSourceLocation();
}

FunctionDefinition const& CompilerContext::resolveVirtualFunction(
    FunctionDefinition const& _function,
    vector<ContractDefinition const*>::const_iterator _searchStart
)
{
    string name = _function.name();
    FunctionType functionType(_function);
    auto it = _searchStart;
    for (; it != m_inheritanceHierarchy.end(); ++it)
        for (FunctionDefinition const* function: (*it)->definedFunctions())
            if (
                function->name() == name &&
                !function->isConstructor() &&
                FunctionType(*function).hasEqualArgumentTypes(functionType)
            )
                return *function;
    solAssert(false, "Super function " + name + " not found.");
    return _function; // not reached
}

vector<ContractDefinition const*>::const_iterator CompilerContext::superContract(ContractDefinition const& _contract) const
{
    solAssert(!m_inheritanceHierarchy.empty(), "No inheritance hierarchy set.");
    auto it = find(m_inheritanceHierarchy.begin(), m_inheritanceHierarchy.end(), &_contract);
    solAssert(it != m_inheritanceHierarchy.end(), "Base not found in inheritance hierarchy.");
    return ++it;
}

void CompilerContext::updateSourceLocation()
{
    m_asm->setSourceLocation(m_visitedNodes.empty() ? SourceLocation() : m_visitedNodes.top()->location());
}

eth::AssemblyItem CompilerContext::FunctionCompilationQueue::entryLabel(
    Declaration const& _declaration,
    CompilerContext& _context
)
{
    auto res = m_entryLabels.find(&_declaration);
    if (res == m_entryLabels.end())
    {
        eth::AssemblyItem tag(_context.newTag());
        m_entryLabels.insert(make_pair(&_declaration, tag));
        m_functionsToCompile.push(&_declaration);
        return tag.tag();
    }
    else
        return res->second.tag();

}

eth::AssemblyItem CompilerContext::FunctionCompilationQueue::entryLabelIfExists(Declaration const& _declaration) const
{
    auto res = m_entryLabels.find(&_declaration);
    return res == m_entryLabels.end() ? eth::AssemblyItem(eth::UndefinedItem) : res->second.tag();
}

Declaration const* CompilerContext::FunctionCompilationQueue::nextFunctionToCompile() const
{
    while (!m_functionsToCompile.empty())
    {
        if (m_alreadyCompiledFunctions.count(m_functionsToCompile.front()))
            m_functionsToCompile.pop();
        else
            return m_functionsToCompile.front();
    }
    return nullptr;
}

void CompilerContext::FunctionCompilationQueue::startFunction(Declaration const& _function)
{
    if (!m_functionsToCompile.empty() && m_functionsToCompile.front() == &_function)
        m_functionsToCompile.pop();
    m_alreadyCompiledFunctions.insert(&_function);
}

}
}