aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/analysis/ControlFlowBuilder.cpp
blob: 35d7687c26d8743986b1b3f8e386d11ec32c1332 (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
/*
    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/analysis/ControlFlowBuilder.h>

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

ControlFlowBuilder::ControlFlowBuilder(CFG::NodeContainer& _nodeContainer, FunctionFlow const& _functionFlow):
    m_nodeContainer(_nodeContainer), m_currentFunctionFlow(_functionFlow), m_currentNode(_functionFlow.entry)
{
}

unique_ptr<FunctionFlow> ControlFlowBuilder::createFunctionFlow(
    CFG::NodeContainer& _nodeContainer,
    FunctionDefinition const& _function
)
{
    auto functionFlow = unique_ptr<FunctionFlow>(new FunctionFlow());
    functionFlow->entry = _nodeContainer.newNode();
    functionFlow->exit = _nodeContainer.newNode();
    functionFlow->revert = _nodeContainer.newNode();
    ControlFlowBuilder builder(_nodeContainer, *functionFlow);
    builder.appendControlFlow(_function);
    connect(builder.m_currentNode, functionFlow->exit);
    return functionFlow;
}


unique_ptr<ModifierFlow> ControlFlowBuilder::createModifierFlow(
    CFG::NodeContainer& _nodeContainer,
    ModifierDefinition const& _modifier
)
{
    auto modifierFlow = unique_ptr<ModifierFlow>(new ModifierFlow());
    modifierFlow->entry = _nodeContainer.newNode();
    modifierFlow->exit = _nodeContainer.newNode();
    modifierFlow->revert = _nodeContainer.newNode();
    modifierFlow->placeholderEntry = _nodeContainer.newNode();
    modifierFlow->placeholderExit = _nodeContainer.newNode();
    ControlFlowBuilder builder(_nodeContainer, *modifierFlow);
    builder.appendControlFlow(_modifier);
    connect(builder.m_currentNode, modifierFlow->exit);
    return modifierFlow;
}

bool ControlFlowBuilder::visit(BinaryOperation const& _operation)
{
    solAssert(!!m_currentNode, "");

    switch(_operation.getOperator())
    {
        case Token::Or:
        case Token::And:
        {
            appendControlFlow(_operation.leftExpression());

            auto nodes = splitFlow<2>();
            nodes[0] = createFlow(nodes[0], _operation.rightExpression());
            mergeFlow(nodes, nodes[1]);

            return false;
        }
        default:
            break;
    }
    return ASTConstVisitor::visit(_operation);
}

bool ControlFlowBuilder::visit(Conditional const& _conditional)
{
    solAssert(!!m_currentNode, "");

    _conditional.condition().accept(*this);

    auto nodes = splitFlow<2>();

    nodes[0] = createFlow(nodes[0], _conditional.trueExpression());
    nodes[1] = createFlow(nodes[1], _conditional.falseExpression());

    mergeFlow(nodes);

    return false;
}

bool ControlFlowBuilder::visit(IfStatement const& _ifStatement)
{
    solAssert(!!m_currentNode, "");

    _ifStatement.condition().accept(*this);

    auto nodes = splitFlow<2>();
    nodes[0] = createFlow(nodes[0], _ifStatement.trueStatement());

    if (_ifStatement.falseStatement())
    {
        nodes[1] = createFlow(nodes[1], *_ifStatement.falseStatement());
        mergeFlow(nodes);
    }
    else
        mergeFlow(nodes, nodes[1]);

    return false;
}

bool ControlFlowBuilder::visit(ForStatement const& _forStatement)
{
    solAssert(!!m_currentNode, "");

    if (_forStatement.initializationExpression())
        _forStatement.initializationExpression()->accept(*this);

    auto condition = createLabelHere();

    if (_forStatement.condition())
        appendControlFlow(*_forStatement.condition());

    auto loopExpression = newLabel();
    auto nodes = splitFlow<2>();
    auto afterFor = nodes[1];
    m_currentNode = nodes[0];

    {
        BreakContinueScope scope(*this, afterFor, loopExpression);
        appendControlFlow(_forStatement.body());
    }

    placeAndConnectLabel(loopExpression);

    if (auto expression = _forStatement.loopExpression())
        appendControlFlow(*expression);

    connect(m_currentNode, condition);
    m_currentNode = afterFor;

    return false;
}

bool ControlFlowBuilder::visit(WhileStatement const& _whileStatement)
{
    solAssert(!!m_currentNode, "");

    if (_whileStatement.isDoWhile())
    {
        auto afterWhile = newLabel();
        auto whileBody = createLabelHere();

        {
            // Note that "continue" in this case currently indeed jumps to whileBody
            // and not to the condition. This is inconsistent with JavaScript and C and
            // therefore a bug. This will be fixed in the future (planned for 0.5.0)
            // and the Control Flow Graph will have to be adjusted accordingly.
            BreakContinueScope scope(*this, afterWhile, whileBody);
            appendControlFlow(_whileStatement.body());
        }
        appendControlFlow(_whileStatement.condition());

        connect(m_currentNode, whileBody);
        placeAndConnectLabel(afterWhile);
    }
    else
    {
        auto whileCondition = createLabelHere();

        appendControlFlow(_whileStatement.condition());

        auto nodes = splitFlow<2>();

        auto whileBody = nodes[0];
        auto afterWhile = nodes[1];

        m_currentNode = whileBody;
        {
            BreakContinueScope scope(*this, afterWhile, whileCondition);
            appendControlFlow(_whileStatement.body());
        }

        connect(m_currentNode, whileCondition);

        m_currentNode = afterWhile;
    }


    return false;
}

bool ControlFlowBuilder::visit(Break const&)
{
    solAssert(!!m_currentNode, "");
    solAssert(!!m_breakJump, "");
    connect(m_currentNode, m_breakJump);
    m_currentNode = newLabel();
    return false;
}

bool ControlFlowBuilder::visit(Continue const&)
{
    solAssert(!!m_currentNode, "");
    solAssert(!!m_continueJump, "");
    connect(m_currentNode, m_continueJump);
    m_currentNode = newLabel();
    return false;
}

bool ControlFlowBuilder::visit(Throw const&)
{
    solAssert(!!m_currentNode, "");
    solAssert(!!m_currentFunctionFlow.revert, "");
    connect(m_currentNode, m_currentFunctionFlow.revert);
    m_currentNode = newLabel();
    return false;
}

bool ControlFlowBuilder::visit(Block const&)
{
    solAssert(!!m_currentNode, "");
    createLabelHere();
    return true;
}

void ControlFlowBuilder::endVisit(Block const&)
{
    solAssert(!!m_currentNode, "");
    createLabelHere();
}

bool ControlFlowBuilder::visit(Return const& _return)
{
    solAssert(!!m_currentNode, "");
    solAssert(!!m_currentFunctionFlow.exit, "");
    solAssert(!m_currentNode->block.returnStatement, "");
    m_currentNode->block.returnStatement = &_return;
    connect(m_currentNode, m_currentFunctionFlow.exit);
    m_currentNode = newLabel();
    return true;
}


bool ControlFlowBuilder::visit(PlaceholderStatement const&)
{
    solAssert(!!m_currentNode, "");
    auto modifierFlow = dynamic_cast<ModifierFlow const*>(&m_currentFunctionFlow);
    solAssert(!!modifierFlow, "");

    connect(m_currentNode, modifierFlow->placeholderEntry);

    m_currentNode = newLabel();

    connect(modifierFlow->placeholderExit, m_currentNode);
    return false;
}

bool ControlFlowBuilder::visitNode(ASTNode const& node)
{
    solAssert(!!m_currentNode, "");
    if (auto const* expression = dynamic_cast<Expression const*>(&node))
        m_currentNode->block.expressions.emplace_back(expression);
    else if (auto const* variableDeclaration = dynamic_cast<VariableDeclaration const*>(&node))
        m_currentNode->block.variableDeclarations.emplace_back(variableDeclaration);
    else if (auto const* assembly = dynamic_cast<InlineAssembly const*>(&node))
        m_currentNode->block.inlineAssemblyStatements.emplace_back(assembly);

    return true;
}

bool ControlFlowBuilder::visit(FunctionCall const& _functionCall)
{
    solAssert(!!m_currentNode, "");
    solAssert(!!_functionCall.expression().annotation().type, "");

    if (auto functionType = dynamic_pointer_cast<FunctionType const>(_functionCall.expression().annotation().type))
        switch (functionType->kind())
        {
            case FunctionType::Kind::Revert:
                solAssert(!!m_currentFunctionFlow.revert, "");
                _functionCall.expression().accept(*this);
                ASTNode::listAccept(_functionCall.arguments(), *this);
                connect(m_currentNode, m_currentFunctionFlow.revert);
                m_currentNode = newLabel();
                return false;
            case FunctionType::Kind::Require:
            case FunctionType::Kind::Assert:
            {
                solAssert(!!m_currentFunctionFlow.revert, "");
                _functionCall.expression().accept(*this);
                ASTNode::listAccept(_functionCall.arguments(), *this);
                connect(m_currentNode, m_currentFunctionFlow.revert);
                auto nextNode = newLabel();
                connect(m_currentNode, nextNode);
                m_currentNode = nextNode;
                return false;
            }
            default:
                break;
        }
    return ASTConstVisitor::visit(_functionCall);
}

void ControlFlowBuilder::appendControlFlow(ASTNode const& _node)
{
    _node.accept(*this);
}

CFGNode* ControlFlowBuilder::createFlow(CFGNode* _entry, ASTNode const& _node)
{
    auto oldCurrentNode = m_currentNode;
    m_currentNode = _entry;
    appendControlFlow(_node);
    auto endNode = m_currentNode;
    m_currentNode = oldCurrentNode;
    return endNode;
}

void ControlFlowBuilder::connect(CFGNode* _from, CFGNode* _to)
{
    solAssert(_from, "");
    solAssert(_to, "");
    _from->exits.push_back(_to);
    _to->entries.push_back(_from);
}

CFGNode* ControlFlowBuilder::newLabel()
{
    return m_nodeContainer.newNode();
}

CFGNode* ControlFlowBuilder::createLabelHere()
{
    auto label = m_nodeContainer.newNode();
    connect(m_currentNode, label);
    m_currentNode = label;
    return label;
}

void ControlFlowBuilder::placeAndConnectLabel(CFGNode* _node)
{
    connect(m_currentNode, _node);
    m_currentNode = _node;
}

ControlFlowBuilder::BreakContinueScope::BreakContinueScope(
    ControlFlowBuilder& _parser,
    CFGNode* _breakJump,
    CFGNode* _continueJump
): m_parser(_parser), m_origBreakJump(_parser.m_breakJump), m_origContinueJump(_parser.m_continueJump)
{
    m_parser.m_breakJump = _breakJump;
    m_parser.m_continueJump = _continueJump;
}

ControlFlowBuilder::BreakContinueScope::~BreakContinueScope()
{
    m_parser.m_breakJump = m_origBreakJump;
    m_parser.m_continueJump = m_origContinueJump;
}