aboutsummaryrefslogtreecommitdiffstats
path: root/libsolidity/analysis/ViewPureChecker.cpp
blob: 1112d6825fb62a8357e21cb6374c4f17ffc5df64 (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
/*
    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/ViewPureChecker.h>

#include <libevmasm/SemanticInformation.h>

#include <libsolidity/ast/ExperimentalFeatures.h>
#include <libyul/AsmData.h>

#include <liblangutil/ErrorReporter.h>

#include <functional>

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

namespace
{

class AssemblyViewPureChecker: public boost::static_visitor<void>
{
public:
    explicit AssemblyViewPureChecker(std::function<void(StateMutability, SourceLocation const&)> _reportMutability):
        m_reportMutability(_reportMutability) {}

    void operator()(yul::Label const&) { }
    void operator()(yul::Instruction const& _instruction)
    {
        checkInstruction(_instruction.location, _instruction.instruction);
    }
    void operator()(yul::Literal const&) {}
    void operator()(yul::Identifier const&) {}
    void operator()(yul::FunctionalInstruction const& _instr)
    {
        checkInstruction(_instr.location, _instr.instruction);
        for (auto const& arg: _instr.arguments)
            boost::apply_visitor(*this, arg);
    }
    void operator()(yul::ExpressionStatement const& _expr)
    {
        boost::apply_visitor(*this, _expr.expression);
    }
    void operator()(yul::StackAssignment const&) {}
    void operator()(yul::Assignment const& _assignment)
    {
        boost::apply_visitor(*this, *_assignment.value);
    }
    void operator()(yul::VariableDeclaration const& _varDecl)
    {
        if (_varDecl.value)
            boost::apply_visitor(*this, *_varDecl.value);
    }
    void operator()(yul::FunctionDefinition const& _funDef)
    {
        (*this)(_funDef.body);
    }
    void operator()(yul::FunctionCall const& _funCall)
    {
        for (auto const& arg: _funCall.arguments)
            boost::apply_visitor(*this, arg);
    }
    void operator()(yul::If const& _if)
    {
        boost::apply_visitor(*this, *_if.condition);
        (*this)(_if.body);
    }
    void operator()(yul::Switch const& _switch)
    {
        boost::apply_visitor(*this, *_switch.expression);
        for (auto const& _case: _switch.cases)
        {
            if (_case.value)
                (*this)(*_case.value);
            (*this)(_case.body);
        }
    }
    void operator()(yul::ForLoop const& _for)
    {
        (*this)(_for.pre);
        boost::apply_visitor(*this, *_for.condition);
        (*this)(_for.body);
        (*this)(_for.post);
    }
    void operator()(yul::Block const& _block)
    {
        for (auto const& s: _block.statements)
            boost::apply_visitor(*this, s);
    }

private:
    std::function<void(StateMutability, SourceLocation const&)> m_reportMutability;
    void checkInstruction(SourceLocation _location, solidity::Instruction _instruction)
    {
        if (eth::SemanticInformation::invalidInViewFunctions(_instruction))
            m_reportMutability(StateMutability::NonPayable, _location);
        else if (eth::SemanticInformation::invalidInPureFunctions(_instruction))
            m_reportMutability(StateMutability::View, _location);
    }
};

}

bool ViewPureChecker::check()
{
    vector<ContractDefinition const*> contracts;

    for (auto const& node: m_ast)
    {
        SourceUnit const* source = dynamic_cast<SourceUnit const*>(node.get());
        solAssert(source, "");
        contracts += source->filteredNodes<ContractDefinition>(source->nodes());
    }

    // Check modifiers first to infer their state mutability.
    for (auto const& contract: contracts)
        for (ModifierDefinition const* mod: contract->functionModifiers())
            mod->accept(*this);

    for (auto const& contract: contracts)
        contract->accept(*this);

    return !m_errors;
}



bool ViewPureChecker::visit(FunctionDefinition const& _funDef)
{
    solAssert(!m_currentFunction, "");
    m_currentFunction = &_funDef;
    m_bestMutabilityAndLocation = {StateMutability::Pure, _funDef.location()};
    return true;
}

void ViewPureChecker::endVisit(FunctionDefinition const& _funDef)
{
    solAssert(m_currentFunction == &_funDef, "");
    if (
        m_bestMutabilityAndLocation.mutability < _funDef.stateMutability() &&
        _funDef.stateMutability() != StateMutability::Payable &&
        _funDef.isImplemented() &&
        !_funDef.isConstructor() &&
        !_funDef.isFallback() &&
        !_funDef.annotation().superFunction
    )
        m_errorReporter.warning(
            _funDef.location(),
            "Function state mutability can be restricted to " + stateMutabilityToString(m_bestMutabilityAndLocation.mutability)
        );
    m_currentFunction = nullptr;
}

bool ViewPureChecker::visit(ModifierDefinition const& _modifier)
{
    solAssert(m_currentFunction == nullptr, "");
    m_bestMutabilityAndLocation = {StateMutability::Pure, _modifier.location()};
    return true;
}

void ViewPureChecker::endVisit(ModifierDefinition const& _modifierDef)
{
    solAssert(m_currentFunction == nullptr, "");
    m_inferredMutability[&_modifierDef] = std::move(m_bestMutabilityAndLocation);
}

void ViewPureChecker::endVisit(Identifier const& _identifier)
{
    Declaration const* declaration = _identifier.annotation().referencedDeclaration;
    solAssert(declaration, "");

    StateMutability mutability = StateMutability::Pure;

    bool writes = _identifier.annotation().lValueRequested;
    if (VariableDeclaration const* varDecl = dynamic_cast<VariableDeclaration const*>(declaration))
    {
        if (varDecl->isStateVariable() && !varDecl->isConstant())
            mutability = writes ? StateMutability::NonPayable : StateMutability::View;
    }
    else if (MagicVariableDeclaration const* magicVar = dynamic_cast<MagicVariableDeclaration const*>(declaration))
    {
        switch (magicVar->type()->category())
        {
        case Type::Category::Contract:
            solAssert(_identifier.name() == "this" || _identifier.name() == "super", "");
            if (!dynamic_cast<ContractType const&>(*magicVar->type()).isSuper())
                // reads the address
                mutability = StateMutability::View;
            break;
        case Type::Category::Integer:
            solAssert(_identifier.name() == "now", "");
            mutability = StateMutability::View;
            break;
        default:
            break;
        }
    }

    reportMutability(mutability, _identifier.location());
}

void ViewPureChecker::endVisit(InlineAssembly const& _inlineAssembly)
{
    AssemblyViewPureChecker{
        [=](StateMutability _mutability, SourceLocation const& _location) { reportMutability(_mutability, _location); }
    }(_inlineAssembly.operations());
}

void ViewPureChecker::reportMutability(
    StateMutability _mutability,
    SourceLocation const& _location,
    boost::optional<SourceLocation> const& _nestedLocation
)
{
    if (_mutability > m_bestMutabilityAndLocation.mutability)
        m_bestMutabilityAndLocation = MutabilityAndLocation{_mutability, _location};
    if (!m_currentFunction || _mutability <= m_currentFunction->stateMutability())
        return;

    // Check for payable here, because any occurrence of `msg.value`
    // will set mutability to payable.
    if (_mutability == StateMutability::View || (
        _mutability == StateMutability::Payable &&
        m_currentFunction->stateMutability() == StateMutability::Pure
    ))
    {
        m_errorReporter.typeError(
            _location,
            "Function declared as pure, but this expression (potentially) reads from the "
            "environment or state and thus requires \"view\"."
        );
        m_errors = true;
    }
    else if (_mutability == StateMutability::NonPayable)
    {
        m_errorReporter.typeError(
            _location,
            "Function declared as " +
            stateMutabilityToString(m_currentFunction->stateMutability()) +
            ", but this expression (potentially) modifies the state and thus "
            "requires non-payable (the default) or payable."
        );
        m_errors = true;
    }
    else if (_mutability == StateMutability::Payable)
    {
        // We do not warn for library functions because they cannot be payable anyway.
        // Also internal functions should be allowed to use `msg.value`.
        if (m_currentFunction->isPublic() && m_currentFunction->inContractKind() != ContractDefinition::ContractKind::Library)
        {
            if (_nestedLocation)
                m_errorReporter.typeError(
                    _location,
                    SecondarySourceLocation().append("\"msg.value\" appears here inside the modifier.", *_nestedLocation),
                    "This modifier uses \"msg.value\" and thus the function has to be payable or internal."
                );
            else
                m_errorReporter.typeError(
                    _location,
                    "\"msg.value\" can only be used in payable public functions. Make the function "
                    "\"payable\" or use an internal function to avoid this error."
                );
            m_errors = true;
        }
    }
    else
        solAssert(false, "");

    solAssert(
        m_currentFunction->stateMutability() == StateMutability::View ||
        m_currentFunction->stateMutability() == StateMutability::Pure ||
        m_currentFunction->stateMutability() == StateMutability::NonPayable,
        ""
    );
}

void ViewPureChecker::endVisit(FunctionCall const& _functionCall)
{
    if (_functionCall.annotation().kind != FunctionCallKind::FunctionCall)
        return;

    StateMutability mutability = dynamic_cast<FunctionType const&>(*_functionCall.expression().annotation().type).stateMutability();
    // We only require "nonpayable" to call a payble function.
    if (mutability == StateMutability::Payable)
        mutability = StateMutability::NonPayable;
    reportMutability(mutability, _functionCall.location());
}

bool ViewPureChecker::visit(MemberAccess const& _memberAccess)
{
    // Catch the special case of `this.f.selector` which is a pure expression.
    ASTString const& member = _memberAccess.memberName();
    if (
        _memberAccess.expression().annotation().type->category() == Type::Category::Function &&
        member == "selector"
    )
        if (auto const* expr = dynamic_cast<MemberAccess const*>(&_memberAccess.expression()))
            if (auto const* exprInt = dynamic_cast<Identifier const*>(&expr->expression()))
                if (exprInt->name() == "this")
                    // Do not continue visiting.
                    return false;
    return true;
}

void ViewPureChecker::endVisit(MemberAccess const& _memberAccess)
{
    StateMutability mutability = StateMutability::Pure;
    bool writes = _memberAccess.annotation().lValueRequested;

    ASTString const& member = _memberAccess.memberName();
    switch (_memberAccess.expression().annotation().type->category())
    {
    case Type::Category::Address:
        if (member == "balance")
            mutability = StateMutability::View;
        break;
    case Type::Category::Magic:
    {
        using MagicMember = pair<MagicType::Kind, string>;
        set<MagicMember> static const pureMembers{
            {MagicType::Kind::ABI, "decode"},
            {MagicType::Kind::ABI, "encode"},
            {MagicType::Kind::ABI, "encodePacked"},
            {MagicType::Kind::ABI, "encodeWithSelector"},
            {MagicType::Kind::ABI, "encodeWithSignature"},
            {MagicType::Kind::Block, "blockhash"},
            {MagicType::Kind::Message, "data"},
            {MagicType::Kind::Message, "sig"}
        };
        set<MagicMember> static const payableMembers{
            {MagicType::Kind::Message, "value"}
        };

        auto const& type = dynamic_cast<MagicType const&>(*_memberAccess.expression().annotation().type);
        MagicMember magicMember(type.kind(), member);

        if (!pureMembers.count(magicMember))
            mutability = StateMutability::View;
        if (payableMembers.count(magicMember))
            mutability = StateMutability::Payable;
        break;
    }
    case Type::Category::Struct:
    {
        if (_memberAccess.expression().annotation().type->dataStoredIn(DataLocation::Storage))
            mutability = writes ? StateMutability::NonPayable : StateMutability::View;
        break;
    }
    case Type::Category::Array:
    {
        auto const& type = dynamic_cast<ArrayType const&>(*_memberAccess.expression().annotation().type);
        if (member == "length" && type.isDynamicallySized() && type.dataStoredIn(DataLocation::Storage))
            mutability = writes ? StateMutability::NonPayable : StateMutability::View;
        break;
    }
    default:
        break;
    }
    reportMutability(mutability, _memberAccess.location());
}

void ViewPureChecker::endVisit(IndexAccess const& _indexAccess)
{
    if (!_indexAccess.indexExpression())
        solAssert(_indexAccess.annotation().type->category() == Type::Category::TypeType, "");
    else
    {
        bool writes = _indexAccess.annotation().lValueRequested;
        if (_indexAccess.baseExpression().annotation().type->dataStoredIn(DataLocation::Storage))
            reportMutability(writes ? StateMutability::NonPayable : StateMutability::View, _indexAccess.location());
    }
}

void ViewPureChecker::endVisit(ModifierInvocation const& _modifier)
{
    solAssert(_modifier.name(), "");
    if (ModifierDefinition const* mod = dynamic_cast<decltype(mod)>(_modifier.name()->annotation().referencedDeclaration))
    {
        solAssert(m_inferredMutability.count(mod), "");
        auto const& mutAndLocation = m_inferredMutability.at(mod);
        reportMutability(mutAndLocation.mutability, _modifier.location(), mutAndLocation.location);
    }
    else
        solAssert(dynamic_cast<ContractDefinition const*>(_modifier.name()->annotation().referencedDeclaration), "");
}