aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/formal/SMTChecker.cpp
blob: 7c8c089e338eb72639cc9f401dede82ba1139591 (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
587
588
589
590
591
592
593
594
595
596
597
598
/*
    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/>.
*/

#include <libsolidity/formal/SMTChecker.h>

#ifdef HAVE_Z3
#include <libsolidity/formal/Z3Interface.h>
#else
#include <libsolidity/formal/SMTLib2Interface.h>
#endif

#include <libsolidity/interface/ErrorReporter.h>

#include <boost/range/adaptor/map.hpp>

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

SMTChecker::SMTChecker(ErrorReporter& _errorReporter, ReadCallback::Callback const& _readFileCallback):
#ifdef HAVE_Z3
    m_interface(make_shared<smt::Z3Interface>()),
#else
    m_interface(make_shared<smt::SMTLib2Interface>(_readFileCallback)),
#endif
    m_errorReporter(_errorReporter)
{
    (void)_readFileCallback;
}

void SMTChecker::analyze(SourceUnit const& _source)
{
    if (_source.annotation().experimentalFeatures.count(ExperimentalFeature::SMTChecker))
    {
        m_interface->reset();
        m_currentSequenceCounter.clear();
        m_nextFreeSequenceCounter.clear();
        _source.accept(*this);
    }
}

void SMTChecker::endVisit(VariableDeclaration const& _varDecl)
{
    if (_varDecl.value())
    {
        m_errorReporter.warning(
            _varDecl.location(),
            "Assertion checker does not yet support this."
        );
    }
    else if (_varDecl.isLocalOrReturn())
        createVariable(_varDecl, true);
    else if (_varDecl.isCallableParameter())
        createVariable(_varDecl, false);
}

bool SMTChecker::visit(FunctionDefinition const& _function)
{
    if (!_function.modifiers().empty() || _function.isConstructor())
        m_errorReporter.warning(
            _function.location(),
            "Assertion checker does not yet support constructors and functions with modifiers."
        );
    // TODO actually we probably also have to reset all local variables and similar things.
    m_currentFunction = &_function;
    m_interface->push();
    return true;
}

void SMTChecker::endVisit(FunctionDefinition const&)
{
    // TOOD we could check for "reachability", i.e. satisfiability here.
    // We only handle local variables, so we clear everything.
    // If we add storage variables, those should be cleared differently.
    m_currentSequenceCounter.clear();
    m_nextFreeSequenceCounter.clear();
    m_interface->pop();
    m_currentFunction = nullptr;
}

bool SMTChecker::visit(IfStatement const& _node)
{
    _node.condition().accept(*this);

    // TODO Check if condition is always true

    auto countersAtStart = m_currentSequenceCounter;
    m_interface->push();
    m_interface->addAssertion(expr(_node.condition()));
    _node.trueStatement().accept(*this);
    auto countersAtEndOfTrue = m_currentSequenceCounter;
    m_interface->pop();

    decltype(m_currentSequenceCounter) countersAtEndOfFalse;
    if (_node.falseStatement())
    {
        m_currentSequenceCounter = countersAtStart;
        m_interface->push();
        m_interface->addAssertion(!expr(_node.condition()));
        _node.falseStatement()->accept(*this);
        countersAtEndOfFalse = m_currentSequenceCounter;
        m_interface->pop();
    }
    else
        countersAtEndOfFalse = countersAtStart;

    // Reset all values that have been touched.

    // TODO this should use a previously generated side-effect structure

    solAssert(countersAtEndOfFalse.size() == countersAtEndOfTrue.size(), "");
    for (auto const& declCounter: countersAtEndOfTrue)
    {
        solAssert(countersAtEndOfFalse.count(declCounter.first), "");
        auto decl = declCounter.first;
        int trueCounter = countersAtEndOfTrue.at(decl);
        int falseCounter = countersAtEndOfFalse.at(decl);
        if (trueCounter == falseCounter)
            continue; // Was not modified
        newValue(*decl);
        setValue(*decl, 0);
    }
    return false;
}

bool SMTChecker::visit(WhileStatement const& _node)
{
    _node.condition().accept(*this);

    //m_interface->push();
    //m_interface->addAssertion(expr(_node.condition()));
    // TDOO clear knowledge (increment sequence numbers and add bounds assertions   ) apart from assertions

    // TODO combine similar to if
    return true;
}

void SMTChecker::endVisit(VariableDeclarationStatement const& _varDecl)
{
    if (_varDecl.declarations().size() != 1)
        m_errorReporter.warning(
            _varDecl.location(),
            "Assertion checker does not yet support such variable declarations."
        );
    else if (knownVariable(*_varDecl.declarations()[0]))
    {
        if (_varDecl.initialValue())
            // TODO more checks?
            // TODO add restrictions about type (might be assignment from smaller type)
            m_interface->addAssertion(newValue(*_varDecl.declarations()[0]) == expr(*_varDecl.initialValue()));
    }
    else
        m_errorReporter.warning(
            _varDecl.location(),
            "Assertion checker does not yet implement such variable declarations."
        );
}

void SMTChecker::endVisit(ExpressionStatement const&)
{
}

void SMTChecker::endVisit(Assignment const& _assignment)
{
    if (_assignment.assignmentOperator() != Token::Value::Assign)
        m_errorReporter.warning(
            _assignment.location(),
            "Assertion checker does not yet implement compound assignment."
        );
    else if (_assignment.annotation().type->category() != Type::Category::Integer)
        m_errorReporter.warning(
            _assignment.location(),
            "Assertion checker does not yet implement type " + _assignment.annotation().type->toString()
        );
    else if (Identifier const* identifier = dynamic_cast<Identifier const*>(&_assignment.leftHandSide()))
    {
        Declaration const* decl = identifier->annotation().referencedDeclaration;
        if (knownVariable(*decl))
            // TODO more checks?
            // TODO add restrictions about type (might be assignment from smaller type)
            m_interface->addAssertion(newValue(*decl) == expr(_assignment.rightHandSide()));
        else
            m_errorReporter.warning(
                _assignment.location(),
                "Assertion checker does not yet implement such assignments."
            );
    }
    else
        m_errorReporter.warning(
            _assignment.location(),
            "Assertion checker does not yet implement such assignments."
        );
}

void SMTChecker::endVisit(TupleExpression const& _tuple)
{
    if (_tuple.isInlineArray() || _tuple.components().size() != 1)
        m_errorReporter.warning(
            _tuple.location(),
            "Assertion checker does not yet implement tules and inline arrays."
        );
    else
        m_interface->addAssertion(expr(_tuple) == expr(*_tuple.components()[0]));
}

void SMTChecker::endVisit(BinaryOperation const& _op)
{
    if (Token::isArithmeticOp(_op.getOperator()))
        arithmeticOperation(_op);
    else if (Token::isCompareOp(_op.getOperator()))
        compareOperation(_op);
    else if (Token::isBooleanOp(_op.getOperator()))
        booleanOperation(_op);
    else
        m_errorReporter.warning(
            _op.location(),
            "Assertion checker does not yet implement this operator."
        );
}

void SMTChecker::endVisit(FunctionCall const& _funCall)
{
    solAssert(_funCall.annotation().kind != FunctionCallKind::Unset, "");
    if (_funCall.annotation().kind != FunctionCallKind::FunctionCall)
    {
        m_errorReporter.warning(
            _funCall.location(),
            "Assertion checker does not yet implement this expression."
        );
        return;
    }

    FunctionType const& funType = dynamic_cast<FunctionType const&>(*_funCall.expression().annotation().type);

    std::vector<ASTPointer<Expression const>> const args = _funCall.arguments();
    if (funType.kind() == FunctionType::Kind::Assert)
    {
        solAssert(args.size() == 1, "");
        solAssert(args[0]->annotation().type->category() == Type::Category::Bool, "");
        checkCondition(!(expr(*args[0])), _funCall.location(), "Assertion violation");
        m_interface->addAssertion(expr(*args[0]));
    }
    else if (funType.kind() == FunctionType::Kind::Require)
    {
        solAssert(args.size() == 1, "");
        solAssert(args[0]->annotation().type->category() == Type::Category::Bool, "");
        m_interface->addAssertion(expr(*args[0]));
        checkCondition(!(expr(*args[0])), _funCall.location(), "Unreachable code");
        // TODO is there something meaningful we can check here?
        // We can check whether the condition is always fulfilled or never fulfilled.
    }
}

void SMTChecker::endVisit(Identifier const& _identifier)
{
    Declaration const* decl = _identifier.annotation().referencedDeclaration;
    solAssert(decl, "");
    if (dynamic_cast<IntegerType const*>(_identifier.annotation().type.get()))
    {
        m_interface->addAssertion(expr(_identifier) == currentValue(*decl));
        return;
    }
    else if (FunctionType const* fun = dynamic_cast<FunctionType const*>(_identifier.annotation().type.get()))
    {
        if (fun->kind() == FunctionType::Kind::Assert || fun->kind() == FunctionType::Kind::Require)
            return;
        // TODO for others, clear our knowledge about storage and memory
    }
    m_errorReporter.warning(
        _identifier.location(),
        "Assertion checker does not yet support the type of this expression (" +
        _identifier.annotation().type->toString() +
        ")."
    );
}

void SMTChecker::endVisit(Literal const& _literal)
{
    Type const& type = *_literal.annotation().type;
    if (type.category() == Type::Category::Integer || type.category() == Type::Category::RationalNumber)
    {
        if (RationalNumberType const* rational = dynamic_cast<RationalNumberType const*>(&type))
            solAssert(!rational->isFractional(), "");

        m_interface->addAssertion(expr(_literal) == smt::Expression(type.literalValue(&_literal)));
    }
    else
        m_errorReporter.warning(
            _literal.location(),
            "Assertion checker does not yet support the type of this expression (" +
            _literal.annotation().type->toString() +
            ")."
        );
}

void SMTChecker::arithmeticOperation(BinaryOperation const& _op)
{
    switch (_op.getOperator())
    {
    case Token::Add:
    case Token::Sub:
    case Token::Mul:
    {
        solAssert(_op.annotation().commonType, "");
        solAssert(_op.annotation().commonType->category() == Type::Category::Integer, "");
        smt::Expression left(expr(_op.leftExpression()));
        smt::Expression right(expr(_op.rightExpression()));
        Token::Value op = _op.getOperator();
        smt::Expression value(
            op == Token::Add ? left + right :
            op == Token::Sub ? left - right :
            /*op == Token::Mul*/ left * right
        );

        // Overflow check
        auto const& intType = dynamic_cast<IntegerType const&>(*_op.annotation().commonType);
        checkCondition(
            value < minValue(intType),
            _op.location(),
            "Underflow (resulting value less than " + formatNumber(intType.minValue()) + ")",
            "value",
            &value
        );
        checkCondition(
            value > maxValue(intType),
            _op.location(),
            "Overflow (resulting value larger than " + formatNumber(intType.maxValue()) + ")",
            "value",
            &value
        );

        m_interface->addAssertion(expr(_op) == value);
        break;
    }
    default:
        m_errorReporter.warning(
            _op.location(),
            "Assertion checker does not yet implement this operator."
        );
    }
}

void SMTChecker::compareOperation(BinaryOperation const& _op)
{
    solAssert(_op.annotation().commonType, "");
    if (_op.annotation().commonType->category() == Type::Category::Integer)
    {
        smt::Expression left(expr(_op.leftExpression()));
        smt::Expression right(expr(_op.rightExpression()));
        Token::Value op = _op.getOperator();
        smt::Expression value = (
            op == Token::Equal ? (left == right) :
            op == Token::NotEqual ? (left != right) :
            op == Token::LessThan ? (left < right) :
            op == Token::LessThanOrEqual ? (left <= right) :
            op == Token::GreaterThan ? (left > right) :
            /*op == Token::GreaterThanOrEqual*/ (left >= right)
        );
        // TODO: check that other values for op are not possible.
        m_interface->addAssertion(expr(_op) == value);
    }
    else
        m_errorReporter.warning(
            _op.location(),
            "Assertion checker does not yet implement the type " + _op.annotation().commonType->toString() + " for comparisons"
        );
}

void SMTChecker::booleanOperation(BinaryOperation const& _op)
{
    solAssert(_op.getOperator() == Token::And || _op.getOperator() == Token::Or, "");
    solAssert(_op.annotation().commonType, "");
    if (_op.annotation().commonType->category() == Type::Category::Bool)
    {
        if (_op.getOperator() == Token::And)
            m_interface->addAssertion(expr(_op) == expr(_op.leftExpression()) && expr(_op.rightExpression()));
        else
            m_interface->addAssertion(expr(_op) == expr(_op.leftExpression()) || expr(_op.rightExpression()));
    }
    else
        m_errorReporter.warning(
            _op.location(),
            "Assertion checker does not yet implement the type " + _op.annotation().commonType->toString() + " for boolean operations"
        );
}

void SMTChecker::checkCondition(
    smt::Expression _condition,
    SourceLocation const& _location,
    string const& _description,
    string const& _additionalValueName,
    smt::Expression* _additionalValue
)
{
    m_interface->push();
    m_interface->addAssertion(_condition);

    vector<smt::Expression> expressionsToEvaluate;
    vector<string> expressionNames;
    if (m_currentFunction)
    {
        if (_additionalValue)
        {
            expressionsToEvaluate.emplace_back(*_additionalValue);
            expressionNames.push_back(_additionalValueName);
        }
        for (auto const& param: m_currentFunction->parameters())
            if (knownVariable(*param))
            {
                expressionsToEvaluate.emplace_back(currentValue(*param));
                expressionNames.push_back(param->name());
            }
        for (auto const& var: m_currentFunction->localVariables())
            if (knownVariable(*var))
            {
                expressionsToEvaluate.emplace_back(currentValue(*var));
                expressionNames.push_back(var->name());
            }
    }
    smt::CheckResult result;
    vector<string> values;
    try
    {
        tie(result, values) = m_interface->check(expressionsToEvaluate);
    }
    catch (smt::SolverError const& _e)
    {
        string description("Error querying SMT solver");
        if (_e.comment())
            description += ": " + *_e.comment();
        m_errorReporter.warning(_location, description);
        return;
    }

    switch (result)
    {
    case smt::CheckResult::SATISFIABLE:
    {
        std::ostringstream message;
        message << _description << " happens here";
        if (m_currentFunction)
        {
            message << " for:\n";
            solAssert(values.size() == expressionNames.size(), "");
            for (size_t i = 0; i < values.size(); ++i)
            {
                string formattedValue = values.at(i);
                try
                {
                    // Parse and re-format nicely
                    formattedValue = formatNumber(bigint(formattedValue));
                }
                catch (...) { }

                message << "  " << expressionNames.at(i) << " = " << formattedValue << "\n";
            }
        }
        else
            message << ".";
        m_errorReporter.warning(_location, message.str());
        break;
    }
    case smt::CheckResult::UNSATISFIABLE:
        break;
    case smt::CheckResult::UNKNOWN:
        m_errorReporter.warning(_location, _description + " might happen here.");
        break;
    case smt::CheckResult::ERROR:
        m_errorReporter.warning(_location, "Error trying to invoke SMT solver.");
        break;
    default:
        solAssert(false, "");
    }
    m_interface->pop();
}

void SMTChecker::createVariable(VariableDeclaration const& _varDecl, bool _setToZero)
{
    if (dynamic_cast<IntegerType const*>(_varDecl.type().get()))
    {
        solAssert(m_currentSequenceCounter.count(&_varDecl) == 0, "");
        solAssert(m_nextFreeSequenceCounter.count(&_varDecl) == 0, "");
        solAssert(m_Variables.count(&_varDecl) == 0, "");
        m_currentSequenceCounter[&_varDecl] = 0;
        m_nextFreeSequenceCounter[&_varDecl] = 1;
        m_Variables.emplace(&_varDecl, m_interface->newFunction(uniqueSymbol(_varDecl), smt::Sort::Int, smt::Sort::Int));
        setValue(_varDecl, _setToZero);
    }
    else
        m_errorReporter.warning(
            _varDecl.location(),
            "Assertion checker does not yet support the type of this variable."
        );
}

string SMTChecker::uniqueSymbol(Declaration const& _decl)
{
    return _decl.name() + "_" + to_string(_decl.id());
}

string SMTChecker::uniqueSymbol(Expression const& _expr)
{
    return "expr_" + to_string(_expr.id());
}

bool SMTChecker::knownVariable(Declaration const& _decl)
{
    return m_currentSequenceCounter.count(&_decl);
}

smt::Expression SMTChecker::currentValue(Declaration const& _decl)
{
    solAssert(m_currentSequenceCounter.count(&_decl), "");
    return valueAtSequence(_decl, m_currentSequenceCounter.at(&_decl));
}

smt::Expression SMTChecker::valueAtSequence(const Declaration& _decl, int _sequence)
{
    return var(_decl)(_sequence);
}

smt::Expression SMTChecker::newValue(Declaration const& _decl)
{
    solAssert(m_currentSequenceCounter.count(&_decl), "");
    solAssert(m_nextFreeSequenceCounter.count(&_decl), "");
    m_currentSequenceCounter[&_decl] = m_nextFreeSequenceCounter[&_decl]++;
    return currentValue(_decl);
}

void SMTChecker::setValue(Declaration const& _decl, bool _setToZero)
{
    auto const& intType = dynamic_cast<IntegerType const&>(*_decl.type());

    if (_setToZero)
        m_interface->addAssertion(currentValue(_decl) == 0);
    else
    {
        m_interface->addAssertion(currentValue(_decl) >= minValue(intType));
        m_interface->addAssertion(currentValue(_decl) <= maxValue(intType));
    }
}

smt::Expression SMTChecker::minValue(IntegerType const& _t)
{
    return smt::Expression(_t.minValue());
}

smt::Expression SMTChecker::maxValue(IntegerType const& _t)
{
    return smt::Expression(_t.maxValue());
}

smt::Expression SMTChecker::expr(Expression const& _e)
{
    if (!m_Expressions.count(&_e))
    {
        solAssert(_e.annotation().type, "");
        switch (_e.annotation().type->category())
        {
        case Type::Category::RationalNumber:
        {
            if (RationalNumberType const* rational = dynamic_cast<RationalNumberType const*>(_e.annotation().type.get()))
                solAssert(!rational->isFractional(), "");
            m_Expressions.emplace(&_e, m_interface->newInteger(uniqueSymbol(_e)));
            break;
        }
        case Type::Category::Integer:
            m_Expressions.emplace(&_e, m_interface->newInteger(uniqueSymbol(_e)));
            break;
        case Type::Category::Bool:
            m_Expressions.emplace(&_e, m_interface->newBool(uniqueSymbol(_e)));
            break;
        default:
            solAssert(false, "Type not implemented.");
        }
    }
    return m_Expressions.at(&_e);
}

smt::Expression SMTChecker::var(Declaration const& _decl)
{
    solAssert(m_Variables.count(&_decl), "");
    return m_Variables.at(&_decl);
}