aboutsummaryrefslogtreecommitdiffstats
path: root/libevmasm/ControlFlowGraph.cpp
blob: 86f16d481de0f8daa9369ad0bd50a1c088c165b1 (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
/*
    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/>.
*/
/**
 * @file ControlFlowGraph.cpp
 * @author Christian <c@ethdev.com>
 * @date 2015
 * Control flow analysis for the optimizer.
 */

#include <libevmasm/ControlFlowGraph.h>
#include <map>
#include <memory>
#include <algorithm>
#include <libevmasm/Exceptions.h>
#include <libevmasm/AssemblyItem.h>
#include <libevmasm/SemanticInformation.h>
#include <libevmasm/KnownState.h>

using namespace std;
using namespace dev;
using namespace dev::eth;

BlockId::BlockId(u256 const& _id):
    m_id(unsigned(_id))
{
    assertThrow( _id < initial().m_id, OptimizerException, "Tag number too large.");
}

BasicBlocks ControlFlowGraph::optimisedBlocks()
{
    if (m_items.empty())
        return BasicBlocks();

    findLargestTag();
    splitBlocks();
    resolveNextLinks();
    removeUnusedBlocks();
    setPrevLinks();
    gatherKnowledge();

    return rebuildCode();
}

void ControlFlowGraph::findLargestTag()
{
    m_lastUsedId = 0;
    for (auto const& item: m_items)
        if (item.type() == Tag || item.type() == PushTag)
        {
            // Assert that it can be converted.
            BlockId(item.data());
            m_lastUsedId = max(unsigned(item.data()), m_lastUsedId);
        }
}

void ControlFlowGraph::splitBlocks()
{
    m_blocks.clear();
    BlockId id = BlockId::initial();
    m_blocks[id].begin = 0;
    for (size_t index = 0; index < m_items.size(); ++index)
    {
        AssemblyItem const& item = m_items.at(index);
        if (item.type() == Tag)
        {
            if (id)
                m_blocks[id].end = index;
            id = BlockId::invalid();
        }
        if (!id)
        {
            id = item.type() == Tag ? BlockId(item.data()) : generateNewId();
            m_blocks[id].begin = index;
        }
        if (item.type() == PushTag)
            m_blocks[id].pushedTags.push_back(BlockId(item.data()));
        if (SemanticInformation::altersControlFlow(item))
        {
            m_blocks[id].end = index + 1;
            if (item == Instruction::JUMP)
                m_blocks[id].endType = BasicBlock::EndType::JUMP;
            else if (item == Instruction::JUMPI)
                m_blocks[id].endType = BasicBlock::EndType::JUMPI;
            else
                m_blocks[id].endType = BasicBlock::EndType::STOP;
            id = BlockId::invalid();
        }
    }
    if (id)
    {
        m_blocks[id].end = m_items.size();
        if (m_blocks[id].endType == BasicBlock::EndType::HANDOVER)
            m_blocks[id].endType = BasicBlock::EndType::STOP;
    }
}

void ControlFlowGraph::resolveNextLinks()
{
    map<unsigned, BlockId> blockByBeginPos;
    for (auto const& idAndBlock: m_blocks)
        if (idAndBlock.second.begin != idAndBlock.second.end)
            blockByBeginPos[idAndBlock.second.begin] = idAndBlock.first;

    for (auto& idAndBlock: m_blocks)
    {
        BasicBlock& block = idAndBlock.second;
        switch (block.endType)
        {
        case BasicBlock::EndType::JUMPI:
        case BasicBlock::EndType::HANDOVER:
            assertThrow(
                blockByBeginPos.count(block.end),
                OptimizerException,
                "Successor block not found."
            );
            block.next = blockByBeginPos.at(block.end);
            break;
        default:
            break;
        }
    }
}

void ControlFlowGraph::removeUnusedBlocks()
{
    vector<BlockId> blocksToProcess{BlockId::initial()};
    set<BlockId> neededBlocks{BlockId::initial()};
    while (!blocksToProcess.empty())
    {
        BasicBlock const& block = m_blocks.at(blocksToProcess.back());
        blocksToProcess.pop_back();
        for (BlockId tag: block.pushedTags)
            if (!neededBlocks.count(tag) && m_blocks.count(tag))
            {
                neededBlocks.insert(tag);
                blocksToProcess.push_back(tag);
            }
        if (block.next && !neededBlocks.count(block.next))
        {
            neededBlocks.insert(block.next);
            blocksToProcess.push_back(block.next);
        }
    }
    for (auto it = m_blocks.begin(); it != m_blocks.end();)
        if (neededBlocks.count(it->first))
            ++it;
        else
            m_blocks.erase(it++);
}

void ControlFlowGraph::setPrevLinks()
{
    for (auto& idAndBlock: m_blocks)
    {
        BasicBlock& block = idAndBlock.second;
        switch (block.endType)
        {
        case BasicBlock::EndType::JUMPI:
        case BasicBlock::EndType::HANDOVER:
            assertThrow(
                !m_blocks.at(block.next).prev,
                OptimizerException,
                "Successor already has predecessor."
            );
            m_blocks[block.next].prev = idAndBlock.first;
            break;
        default:
            break;
        }
    }
    // If block ends with jump to not yet linked block, link them removing the jump
    for (auto& idAndBlock: m_blocks)
    {
        BlockId blockId = idAndBlock.first;
        BasicBlock& block = idAndBlock.second;
        if (block.endType != BasicBlock::EndType::JUMP || block.end - block.begin < 2)
            continue;
        AssemblyItem const& push = m_items.at(block.end - 2);
        if (push.type() != PushTag)
            continue;
        BlockId nextId(push.data());
        if (m_blocks.count(nextId) && m_blocks.at(nextId).prev)
            continue;
        bool hasLoop = false;
        for (BlockId id = nextId; id && m_blocks.count(id) && !hasLoop; id = m_blocks.at(id).next)
            hasLoop = (id == blockId);
        if (hasLoop || !m_blocks.count(nextId))
            continue;

        m_blocks[nextId].prev = blockId;
        block.next = nextId;
        block.end -= 2;
        assertThrow(
            !block.pushedTags.empty() && block.pushedTags.back() == nextId,
            OptimizerException,
            "Last pushed tag not at end of pushed list."
        );
        block.pushedTags.pop_back();
        block.endType = BasicBlock::EndType::HANDOVER;
    }
}

void ControlFlowGraph::gatherKnowledge()
{
    // @todo actually we know that memory is filled with zeros at the beginning,
    // we could make use of that.
    KnownStatePointer emptyState = make_shared<KnownState>();
    bool unknownJumpEncountered = false;

    struct WorkQueueItem {
        BlockId blockId;
        KnownStatePointer state;
        set<BlockId> blocksSeen;
    };

    vector<WorkQueueItem> workQueue{WorkQueueItem{BlockId::initial(), emptyState->copy(), set<BlockId>()}};
    auto addWorkQueueItem = [&](WorkQueueItem const& _currentItem, BlockId _to, KnownStatePointer const& _state)
    {
        WorkQueueItem item;
        item.blockId = _to;
        item.state = _state->copy();
        item.blocksSeen = _currentItem.blocksSeen;
        item.blocksSeen.insert(_currentItem.blockId);
        workQueue.push_back(move(item));
    };

    while (!workQueue.empty())
    {
        WorkQueueItem item = move(workQueue.back());
        workQueue.pop_back();
        //@todo we might have to do something like incrementing the sequence number for each JUMPDEST
        assertThrow(!!item.blockId, OptimizerException, "");
        if (!m_blocks.count(item.blockId))
            continue; // too bad, we do not know the tag, probably an invalid jump
        BasicBlock& block = m_blocks.at(item.blockId);
        KnownStatePointer state = item.state;
        if (block.startState)
        {
            // We call reduceToCommonKnowledge even in the non-join setting to get the correct
            // sequence number
            if (!m_joinKnowledge)
                state->reset();
            state->reduceToCommonKnowledge(*block.startState, !item.blocksSeen.count(item.blockId));
            if (*state == *block.startState)
                continue;
        }

        block.startState = state->copy();

        // Feed all items except for the final jump yet because it will erase the target tag.
        unsigned pc = block.begin;
        while (pc < block.end && !SemanticInformation::altersControlFlow(m_items.at(pc)))
            state->feedItem(m_items.at(pc++));

        if (
            block.endType == BasicBlock::EndType::JUMP ||
            block.endType == BasicBlock::EndType::JUMPI
        )
        {
            assertThrow(block.begin <= pc && pc == block.end - 1, OptimizerException, "");
            //@todo in the case of JUMPI, add knowledge about the condition to the state
            // (for both values of the condition)
            set<u256> tags = state->tagsInExpression(
                state->stackElement(state->stackHeight(), SourceLocation())
            );
            state->feedItem(m_items.at(pc++));

            if (tags.empty())
            {
                if (!unknownJumpEncountered)
                {
                    // We do not know the target of this jump, so we have to reset the states of all
                    // JUMPDESTs.
                    unknownJumpEncountered = true;
                    for (auto const& it: m_blocks)
                        if (it.second.begin < it.second.end && m_items[it.second.begin].type() == Tag)
                            workQueue.push_back(WorkQueueItem{it.first, emptyState->copy(), set<BlockId>()});
                }
            }
            else
                for (auto tag: tags)
                    addWorkQueueItem(item, BlockId(tag), state);
        }
        else if (block.begin <= pc && pc < block.end)
            state->feedItem(m_items.at(pc++));
        assertThrow(block.end <= block.begin || pc == block.end, OptimizerException, "");

        block.endState = state;

        if (
            block.endType == BasicBlock::EndType::HANDOVER ||
            block.endType == BasicBlock::EndType::JUMPI
        )
            addWorkQueueItem(item, block.next, state);
    }

    // Remove all blocks we never visited here. This might happen because a tag is pushed but
    // never used for a JUMP.
    // Note that this invalidates some contents of pushedTags
    for (auto it = m_blocks.begin(); it != m_blocks.end();)
        if (!it->second.startState)
            it = m_blocks.erase(it);
        else
            it++;
}

BasicBlocks ControlFlowGraph::rebuildCode()
{
    map<BlockId, unsigned> pushes;
    for (auto& idAndBlock: m_blocks)
        for (BlockId ref: idAndBlock.second.pushedTags)
            if (m_blocks.count(ref))
                pushes[ref]++;

    set<BlockId> blocksToAdd;
    for (auto it: m_blocks)
        blocksToAdd.insert(it.first);
    set<BlockId> blocksAdded;
    BasicBlocks blocks;

    for (
        BlockId blockId = BlockId::initial();
        blockId;
        blockId = blocksToAdd.empty() ? BlockId::invalid() : *blocksToAdd.begin()
    )
    {
        bool previousHandedOver = (blockId == BlockId::initial());
        while (m_blocks.at(blockId).prev)
            blockId = m_blocks.at(blockId).prev;
        for (; blockId; blockId = m_blocks.at(blockId).next)
        {
            BasicBlock& block = m_blocks.at(blockId);
            blocksToAdd.erase(blockId);
            blocksAdded.insert(blockId);

            if (block.begin == block.end)
                continue;
            // If block starts with unused tag, skip it.
            if (previousHandedOver && !pushes[blockId] && m_items[block.begin].type() == Tag)
                ++block.begin;
            if (block.begin < block.end)
            {
                blocks.push_back(block);
                blocks.back().startState->clearTagUnions();
                blocks.back().endState->clearTagUnions();
            }
            previousHandedOver = (block.endType == BasicBlock::EndType::HANDOVER);
        }
    }

    return blocks;
}

BlockId ControlFlowGraph::generateNewId()
{
    BlockId id = BlockId(++m_lastUsedId);
    assertThrow(id < BlockId::initial(), OptimizerException, "Out of block IDs.");
    return id;
}