aboutsummaryrefslogtreecommitdiffstats
path: root/libjulia/optimiser/Rematerialiser.cpp
blob: bf7d7d16ffe3707dac188ed47fcf05f66ee21c39 (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
/*(
    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/>.
*/
/**
 * Optimisation stage that replaces variables by their most recently assigned expressions.
 */

#include <libjulia/optimiser/Rematerialiser.h>

#include <libjulia/optimiser/ASTCopier.h>
#include <libjulia/optimiser/NameCollector.h>

#include <libsolidity/inlineasm/AsmData.h>

#include <libjulia/optimiser/Semantics.h>

#include <libdevcore/CommonData.h>

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

using namespace std;
using namespace dev;
using namespace dev::julia;

void Rematerialiser::operator()(Assignment& _assignment)
{
    set<string> names;
    for (auto const& var: _assignment.variableNames)
        names.insert(var.name);
    handleAssignment(names, _assignment.value.get());
}

void Rematerialiser::operator()(VariableDeclaration& _varDecl)
{
    set<string> names;
    for (auto const& var: _varDecl.variables)
        names.insert(var.name);
    m_variableScopes.back().first += names;
    handleAssignment(names, _varDecl.value.get());
}

void Rematerialiser::operator()(If& _if)
{
    ASTModifier::operator()(_if);

    Assignments ass;
    ass(_if.body);
    handleAssignment(ass.names(), nullptr);
}

void Rematerialiser::operator()(Switch& _switch)
{
    boost::apply_visitor(*this, *_switch.expression);
    set<string> assignedVariables;
    for (auto& _case: _switch.cases)
    {
        (*this)(_case.body);
        Assignments ass;
        ass(_case.body);
        assignedVariables += ass.names();
        // This is a little too destructive, we could retain the old replacements.
        handleAssignment(ass.names(), nullptr);
    }
    handleAssignment(assignedVariables, nullptr);
}

void Rematerialiser::operator()(FunctionDefinition& _fun)
{
    m_variableScopes.push_back(make_pair(set<string>(), true));
    for (auto const& parameter: _fun.parameters)
        m_variableScopes.back().first.insert(parameter.name);
    for (auto const& var: _fun.returnVariables)
        m_variableScopes.back().first.insert(var.name);
    ASTModifier::operator()(_fun);
    m_variableScopes.pop_back();
}

void Rematerialiser::operator()(ForLoop& _for)
{
    // Special scope handling of the pre block.
    m_variableScopes.push_back(make_pair(set<string>(), false));
    for (auto& statement: _for.pre.statements)
        visit(statement);

    Assignments ass;
    ass(_for.body);
    ass(_for.post);
    handleAssignment(ass.names(), nullptr);

    visit(*_for.condition);
    (*this)(_for.body);
    (*this)(_for.post);

    handleAssignment(ass.names(), nullptr);

    m_variableScopes.pop_back();
}

void Rematerialiser::operator()(Block& _block)
{
    size_t numScopes = m_variableScopes.size();
    m_variableScopes.push_back(make_pair(set<string>(), false));
    ASTModifier::operator()(_block);
    m_variableScopes.pop_back();
    solAssert(numScopes == m_variableScopes.size(), "");
}

void Rematerialiser::handleAssignment(set<string> const& _variables, Expression* _value)
{
    MovableChecker movableChecker;
    if (_value)
    {
        visit(*_value);
        movableChecker.visit(*_value);
    }
    if (_variables.size() == 1)
    {
        string const& name = *_variables.begin();
        if (movableChecker.movable() && _value)
            // TODO Plus heuristic about size of value
            // TODO If _value is null, we could use zero.
            m_substitutions[name] = _value;
        else
            m_substitutions.erase(name);
    }
    else
        for (auto const& name: _variables)
            m_substitutions.erase(name);

    // Disallow substitutions that use a variable that will be reassigned by this assignment.
    for (auto const& name: _variables)
        for (auto const& ref: m_referencedBy[name])
            m_substitutions.erase(ref);
    // Update the fact which variables are referenced by the newly assigned variables
    for (auto const& name: _variables)
    {
        for (auto const& ref: m_references[name])
            m_referencedBy[ref].erase(name);
        m_references[name].clear();
    }
    auto const& referencedVariables = movableChecker.referencedVariables();
    for (auto const& name: _variables)
    {
        m_references[name] = referencedVariables;
        for (auto const& ref: referencedVariables)
            m_referencedBy[ref].insert(name);
    }
}

bool Rematerialiser::inScope(string const& _variableName) const
{
    for (auto const& scope: m_variableScopes | boost::adaptors::reversed)
    {
        if (scope.first.count(_variableName))
            return true;
        if (scope.second)
            return false;
    }
    return false;
}

void Rematerialiser::visit(Expression& _e)
{
    if (_e.type() == typeid(Identifier))
    {
        Identifier& identifier = boost::get<Identifier>(_e);
        if (m_substitutions.count(identifier.name))
        {
            string name = identifier.name;
            bool doSubstitute = true;
            for (auto const& ref: m_references[name])
                if (!inScope(ref))
                {
                    doSubstitute = false;
                    break;
                }
            if (doSubstitute)
                _e = (ASTCopier{}).translate(*m_substitutions.at(name));
        }
    }
    ASTModifier::visit(_e);
}