aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/inlineasm/AsmAnalysis.cpp
blob: a7f764a5b9258bbd1b2376744640d3a3227b235d (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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
/*
    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/>.
*/
/**
 * Analyzer part of inline assembly.
 */

#include <libsolidity/inlineasm/AsmAnalysis.h>

#include <libsolidity/inlineasm/AsmData.h>
#include <libsolidity/inlineasm/AsmScopeFiller.h>
#include <libsolidity/inlineasm/AsmScope.h>
#include <libsolidity/inlineasm/AsmAnalysisInfo.h>

#include <libsolidity/interface/ErrorReporter.h>

#include <boost/range/adaptor/reversed.hpp>
#include <boost/algorithm/string.hpp>

#include <memory>
#include <functional>

using namespace std;
using namespace dev;
using namespace dev::solidity;
using namespace dev::solidity::assembly;

namespace {

set<string> const builtinTypes{"bool", "u8", "s8", "u32", "s32", "u64", "s64", "u128", "s128", "u256", "s256"};

}

bool AsmAnalyzer::analyze(Block const& _block)
{
    if (!(ScopeFiller(m_info, m_errorReporter))(_block))
        return false;

    return (*this)(_block);
}

bool AsmAnalyzer::operator()(Label const& _label)
{
    solAssert(m_flavour == AsmFlavour::Loose, "");
    m_info.stackHeightInfo[&_label] = m_stackHeight;
    warnOnInstructions(solidity::Instruction::JUMPDEST, _label.location);
    return true;
}

bool AsmAnalyzer::operator()(assembly::Instruction const& _instruction)
{
    solAssert(m_flavour == AsmFlavour::Loose, "");
    auto const& info = instructionInfo(_instruction.instruction);
    m_stackHeight += info.ret - info.args;
    m_info.stackHeightInfo[&_instruction] = m_stackHeight;
    warnOnInstructions(_instruction.instruction, _instruction.location);
    return true;
}

bool AsmAnalyzer::operator()(assembly::Literal const& _literal)
{
    expectValidType(_literal.type, _literal.location);
    ++m_stackHeight;
    if (_literal.kind == assembly::LiteralKind::String && _literal.value.size() > 32)
    {
        m_errorReporter.typeError(
            _literal.location,
            "String literal too long (" + boost::lexical_cast<std::string>(_literal.value.size()) + " > 32)"
        );
        return false;
    }
    else if (_literal.kind == assembly::LiteralKind::Number && bigint(_literal.value) > u256(-1))
    {
        m_errorReporter.typeError(
            _literal.location,
            "Number literal too large (> 256 bits)"
        );
        return false;
    }
    else if (_literal.kind == assembly::LiteralKind::Boolean)
    {
        solAssert(m_flavour == AsmFlavour::IULIA, "");
        solAssert(_literal.value == "true" || _literal.value == "false", "");
    }
    m_info.stackHeightInfo[&_literal] = m_stackHeight;
    return true;
}

bool AsmAnalyzer::operator()(assembly::Identifier const& _identifier)
{
    size_t numErrorsBefore = m_errorReporter.errors().size();
    bool success = true;
    if (m_currentScope->lookup(_identifier.name, Scope::Visitor(
        [&](Scope::Variable const& _var)
        {
            if (!m_activeVariables.count(&_var))
            {
                m_errorReporter.declarationError(
                    _identifier.location,
                    "Variable " + _identifier.name + " used before it was declared."
                );
                success = false;
            }
            ++m_stackHeight;
        },
        [&](Scope::Label const&)
        {
            ++m_stackHeight;
        },
        [&](Scope::Function const&)
        {
            m_errorReporter.typeError(
                _identifier.location,
                "Function " + _identifier.name + " used without being called."
            );
            success = false;
        }
    )))
    {
    }
    else
    {
        size_t stackSize(-1);
        if (m_resolver)
        {
            bool insideFunction = m_currentScope->insideFunction();
            stackSize = m_resolver(_identifier, julia::IdentifierContext::RValue, insideFunction);
        }
        if (stackSize == size_t(-1))
        {
            // Only add an error message if the callback did not do it.
            if (numErrorsBefore == m_errorReporter.errors().size())
                m_errorReporter.declarationError(_identifier.location, "Identifier not found.");
            success = false;
        }
        m_stackHeight += stackSize == size_t(-1) ? 1 : stackSize;
    }
    m_info.stackHeightInfo[&_identifier] = m_stackHeight;
    return success;
}

bool AsmAnalyzer::operator()(FunctionalInstruction const& _instr)
{
    solAssert(m_flavour != AsmFlavour::IULIA, "");
    bool success = true;
    for (auto const& arg: _instr.arguments | boost::adaptors::reversed)
        if (!expectExpression(arg))
            success = false;
    // Parser already checks that the number of arguments is correct.
    auto const& info = instructionInfo(_instr.instruction);
    solAssert(info.args == int(_instr.arguments.size()), "");
    m_stackHeight += info.ret - info.args;
    m_info.stackHeightInfo[&_instr] = m_stackHeight;
    warnOnInstructions(_instr.instruction, _instr.location);
    return success;
}

bool AsmAnalyzer::operator()(assembly::ExpressionStatement const& _statement)
{
    size_t initialStackHeight = m_stackHeight;
    bool success = boost::apply_visitor(*this, _statement.expression);
    if (m_flavour != AsmFlavour::Loose)
        if (!expectDeposit(0, initialStackHeight, _statement.location))
            success = false;
    m_info.stackHeightInfo[&_statement] = m_stackHeight;
    return success;
}

bool AsmAnalyzer::operator()(assembly::StackAssignment const& _assignment)
{
    solAssert(m_flavour == AsmFlavour::Loose, "");
    bool success = checkAssignment(_assignment.variableName, size_t(-1));
    m_info.stackHeightInfo[&_assignment] = m_stackHeight;
    return success;
}

bool AsmAnalyzer::operator()(assembly::Assignment const& _assignment)
{
    int const expectedItems = _assignment.variableNames.size();
    solAssert(expectedItems >= 1, "");
    int const stackHeight = m_stackHeight;
    bool success = boost::apply_visitor(*this, *_assignment.value);
    if ((m_stackHeight - stackHeight) != expectedItems)
    {
        m_errorReporter.declarationError(
            _assignment.location,
            "Variable count does not match number of values (" +
            to_string(expectedItems) +
            " vs. " +
            to_string(m_stackHeight - stackHeight) +
            ")"
        );
        return false;
    }
    for (auto const& variableName: _assignment.variableNames)
        if (!checkAssignment(variableName, 1))
            success = false;
    m_info.stackHeightInfo[&_assignment] = m_stackHeight;
    return success;
}

bool AsmAnalyzer::operator()(assembly::VariableDeclaration const& _varDecl)
{
    bool success = true;
    int const numVariables = _varDecl.variables.size();
    if (_varDecl.value)
    {
        int const stackHeight = m_stackHeight;
        success = boost::apply_visitor(*this, *_varDecl.value);
        if ((m_stackHeight - stackHeight) != numVariables)
        {
            m_errorReporter.declarationError(_varDecl.location, "Variable count mismatch.");
            return false;
        }
    }
    else
        m_stackHeight += numVariables;

    for (auto const& variable: _varDecl.variables)
    {
        expectValidType(variable.type, variable.location);
        m_activeVariables.insert(&boost::get<Scope::Variable>(m_currentScope->identifiers.at(variable.name)));
    }
    m_info.stackHeightInfo[&_varDecl] = m_stackHeight;
    return success;
}

bool AsmAnalyzer::operator()(assembly::FunctionDefinition const& _funDef)
{
    Block const* virtualBlock = m_info.virtualBlocks.at(&_funDef).get();
    solAssert(virtualBlock, "");
    Scope& varScope = scope(virtualBlock);
    for (auto const& var: _funDef.parameters + _funDef.returnVariables)
    {
        expectValidType(var.type, var.location);
        m_activeVariables.insert(&boost::get<Scope::Variable>(varScope.identifiers.at(var.name)));
    }

    int const stackHeight = m_stackHeight;
    m_stackHeight = _funDef.parameters.size() + _funDef.returnVariables.size();

    bool success = (*this)(_funDef.body);

    m_stackHeight = stackHeight;
    m_info.stackHeightInfo[&_funDef] = m_stackHeight;
    return success;
}

bool AsmAnalyzer::operator()(assembly::FunctionCall const& _funCall)
{
    bool success = true;
    size_t arguments = 0;
    size_t returns = 0;
    if (!m_currentScope->lookup(_funCall.functionName.name, Scope::Visitor(
        [&](Scope::Variable const&)
        {
            m_errorReporter.typeError(
                _funCall.functionName.location,
                "Attempt to call variable instead of function."
            );
            success = false;
        },
        [&](Scope::Label const&)
        {
            m_errorReporter.typeError(
                _funCall.functionName.location,
                "Attempt to call label instead of function."
            );
            success = false;
        },
        [&](Scope::Function const& _fun)
        {
            /// TODO: compare types too
            arguments = _fun.arguments.size();
            returns = _fun.returns.size();
        }
    )))
    {
        m_errorReporter.declarationError(_funCall.functionName.location, "Function not found.");
        success = false;
    }
    if (success)
    {
        if (_funCall.arguments.size() != arguments)
        {
            m_errorReporter.typeError(
                _funCall.functionName.location,
                "Expected " + boost::lexical_cast<string>(arguments) + " arguments but got " +
                boost::lexical_cast<string>(_funCall.arguments.size()) + "."
            );
            success = false;
        }
    }
    for (auto const& arg: _funCall.arguments | boost::adaptors::reversed)
        if (!expectExpression(arg))
            success = false;
    m_stackHeight += int(returns) - int(arguments);
    m_info.stackHeightInfo[&_funCall] = m_stackHeight;
    return success;
}

bool AsmAnalyzer::operator()(If const& _if)
{
    bool success = true;

    if (!expectExpression(*_if.condition))
        success = false;
    m_stackHeight--;

    if (!(*this)(_if.body))
        success = false;

    m_info.stackHeightInfo[&_if] = m_stackHeight;

    return success;
}

bool AsmAnalyzer::operator()(Switch const& _switch)
{
    bool success = true;

    if (!expectExpression(*_switch.expression))
        success = false;

    set<tuple<LiteralKind, string>> cases;
    for (auto const& _case: _switch.cases)
    {
        if (_case.value)
        {
            int const initialStackHeight = m_stackHeight;
            // We cannot use "expectExpression" here because *_case.value is not a
            // Statement and would be converted to a Statement otherwise.
            if (!(*this)(*_case.value))
                success = false;
            expectDeposit(1, initialStackHeight, _case.value->location);
            m_stackHeight--;

            /// Note: the parser ensures there is only one default case
            auto val = make_tuple(_case.value->kind, _case.value->value);
            if (!cases.insert(val).second)
            {
                m_errorReporter.declarationError(
                    _case.location,
                    "Duplicate case defined"
                );
                success = false;
            }
        }

        if (!(*this)(_case.body))
            success = false;
    }

    m_stackHeight--;
    m_info.stackHeightInfo[&_switch] = m_stackHeight;

    return success;
}

bool AsmAnalyzer::operator()(assembly::ForLoop const& _for)
{
    Scope* originalScope = m_currentScope;

    bool success = true;
    if (!(*this)(_for.pre))
        success = false;
    // The block was closed already, but we re-open it again and stuff the
    // condition, the body and the post part inside.
    m_stackHeight += scope(&_for.pre).numberOfVariables();
    m_currentScope = &scope(&_for.pre);

    if (!expectExpression(*_for.condition))
        success = false;
    m_stackHeight--;
    if (!(*this)(_for.body))
        success = false;
    if (!(*this)(_for.post))
        success = false;

    m_stackHeight -= scope(&_for.pre).numberOfVariables();
    m_info.stackHeightInfo[&_for] = m_stackHeight;
    m_currentScope = originalScope;

    return success;
}

bool AsmAnalyzer::operator()(Block const& _block)
{
    bool success = true;
    auto previousScope = m_currentScope;
    m_currentScope = &scope(&_block);

    int const initialStackHeight = m_stackHeight;

    for (auto const& s: _block.statements)
        if (!boost::apply_visitor(*this, s))
            success = false;

    m_stackHeight -= scope(&_block).numberOfVariables();

    int const stackDiff = m_stackHeight - initialStackHeight;
    if (stackDiff != 0)
    {
        m_errorReporter.declarationError(
            _block.location,
            "Unbalanced stack at the end of a block: " +
            (
                stackDiff > 0 ?
                to_string(stackDiff) + string(" surplus item(s).") :
                to_string(-stackDiff) + string(" missing item(s).")
            )
        );
        success = false;
    }

    m_info.stackHeightInfo[&_block] = m_stackHeight;
    m_currentScope = previousScope;
    return success;
}

bool AsmAnalyzer::expectExpression(Expression const& _expr)
{
    bool success = true;
    int const initialHeight = m_stackHeight;
    if (!boost::apply_visitor(*this, _expr))
        success = false;
    if (!expectDeposit(1, initialHeight, locationOf(_expr)))
        success = false;
    return success;
}

bool AsmAnalyzer::expectDeposit(int _deposit, int _oldHeight, SourceLocation const& _location)
{
    if (m_stackHeight - _oldHeight != _deposit)
    {
        m_errorReporter.typeError(
            _location,
            "Expected expression to return one item to the stack, but did return " +
            boost::lexical_cast<string>(m_stackHeight - _oldHeight) +
            " items."
        );
        return false;
    }
    return true;
}

bool AsmAnalyzer::checkAssignment(assembly::Identifier const& _variable, size_t _valueSize)
{
    bool success = true;
    size_t numErrorsBefore = m_errorReporter.errors().size();
    size_t variableSize(-1);
    if (Scope::Identifier const* var = m_currentScope->lookup(_variable.name))
    {
        // Check that it is a variable
        if (var->type() != typeid(Scope::Variable))
        {
            m_errorReporter.typeError(_variable.location, "Assignment requires variable.");
            success = false;
        }
        else if (!m_activeVariables.count(&boost::get<Scope::Variable>(*var)))
        {
            m_errorReporter.declarationError(
                _variable.location,
                "Variable " + _variable.name + " used before it was declared."
            );
            success = false;
        }
        variableSize = 1;
    }
    else if (m_resolver)
    {
        bool insideFunction = m_currentScope->insideFunction();
        variableSize = m_resolver(_variable, julia::IdentifierContext::LValue, insideFunction);
    }
    if (variableSize == size_t(-1))
    {
        // Only add message if the callback did not.
        if (numErrorsBefore == m_errorReporter.errors().size())
            m_errorReporter.declarationError(_variable.location, "Variable not found or variable not lvalue.");
        success = false;
    }
    if (_valueSize == size_t(-1))
        _valueSize = variableSize == size_t(-1) ? 1 : variableSize;

    m_stackHeight -= _valueSize;

    if (_valueSize != variableSize && variableSize != size_t(-1))
    {
        m_errorReporter.typeError(
            _variable.location,
            "Variable size (" +
            to_string(variableSize) +
            ") and value size (" +
            to_string(_valueSize) +
            ") do not match."
        );
        success = false;
    }
    return success;
}

Scope& AsmAnalyzer::scope(Block const* _block)
{
    solAssert(m_info.scopes.count(_block) == 1, "Scope requested but not present.");
    auto scopePtr = m_info.scopes.at(_block);
    solAssert(scopePtr, "Scope requested but not present.");
    return *scopePtr;
}
void AsmAnalyzer::expectValidType(string const& type, SourceLocation const& _location)
{
    if (m_flavour != AsmFlavour::IULIA)
        return;

    if (!builtinTypes.count(type))
        m_errorReporter.typeError(
            _location,
            "\"" + type + "\" is not a valid type (user defined types are not yet supported)."
        );
}

void AsmAnalyzer::warnOnInstructions(solidity::Instruction _instr, SourceLocation const& _location)
{
    // We assume that returndatacopy, returndatasize and staticcall are either all available
    // or all not available.
    solAssert(m_evmVersion.supportsReturndata() == m_evmVersion.hasStaticCall(), "");

    if (_instr == solidity::Instruction::CREATE2)
        m_errorReporter.warning(
            _location,
            "The \"" +
            boost::to_lower_copy(instructionInfo(_instr).name)
            + "\" instruction is not supported by the VM version \"" +
            "" + m_evmVersion.name() +
            "\" you are currently compiling for. " +
            "It will be interpreted as an invalid instruction on this VM."
        );
    else if ((
        _instr == solidity::Instruction::RETURNDATACOPY ||
        _instr == solidity::Instruction::RETURNDATASIZE ||
        _instr == solidity::Instruction::STATICCALL
    ) && !m_evmVersion.supportsReturndata())
        m_errorReporter.warning(
            _location,
            "The \"" +
            boost::to_lower_copy(instructionInfo(_instr).name)
            + "\" instruction is only available for Byzantium-compatible VMs. " +
            "You are currently compiling for \"" +
            m_evmVersion.name() +
            "\", where it will be interpreted as an invalid instruction."
        );
    else if ((
        _instr == solidity::Instruction::SHL ||
        _instr == solidity::Instruction::SHR ||
        _instr == solidity::Instruction::SAR
    ) && !m_evmVersion.hasBitwiseShifting())
        m_errorReporter.warning(
            _location,
            "The \"" +
            boost::to_lower_copy(instructionInfo(_instr).name)
            + "\" instruction is only available for Constantinople-compatible VMs. " +
            "You are currently compiling for \"" +
            m_evmVersion.name() +
            "\", where it will be interpreted as an invalid instruction."
        );

    if (_instr == solidity::Instruction::JUMP || _instr == solidity::Instruction::JUMPI || _instr == solidity::Instruction::JUMPDEST)
        m_errorReporter.warning(
            _location,
            "Jump instructions and labels are low-level EVM features that can lead to "
            "incorrect stack access. Because of that they are discouraged. "
            "Please consider using \"switch\", \"if\" or \"for\" statements instead."
        );
}