2017-11-22 10:11:48 +00:00
|
|
|
/*
|
|
|
|
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/>.
|
|
|
|
*/
|
2020-07-17 14:54:12 +00:00
|
|
|
// SPDX-License-Identifier: GPL-3.0
|
2017-11-22 10:11:48 +00:00
|
|
|
/**
|
|
|
|
* Specific AST walkers that collect semantical facts.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2023-05-15 12:19:40 +00:00
|
|
|
#include <libyul/AST.h>
|
|
|
|
#include <libyul/Object.h>
|
2019-08-13 12:40:26 +00:00
|
|
|
#include <libyul/SideEffects.h>
|
2023-05-15 12:19:40 +00:00
|
|
|
#include <libyul/optimiser/ASTWalker.h>
|
2019-12-02 11:33:24 +00:00
|
|
|
#include <libyul/optimiser/CallGraphGenerator.h>
|
2017-11-22 10:11:48 +00:00
|
|
|
|
|
|
|
#include <set>
|
|
|
|
|
2019-12-11 16:31:36 +00:00
|
|
|
namespace solidity::yul
|
2017-11-22 10:11:48 +00:00
|
|
|
{
|
2018-12-20 17:55:32 +00:00
|
|
|
struct Dialect;
|
2017-11-22 10:11:48 +00:00
|
|
|
|
|
|
|
/**
|
2019-05-27 11:11:00 +00:00
|
|
|
* Specific AST walker that determines side-effect free-ness and movability of code.
|
|
|
|
* Enters into function definitions.
|
2017-11-22 10:11:48 +00:00
|
|
|
*/
|
2019-05-27 11:11:00 +00:00
|
|
|
class SideEffectsCollector: public ASTWalker
|
2017-11-22 10:11:48 +00:00
|
|
|
{
|
|
|
|
public:
|
2019-08-13 16:38:11 +00:00
|
|
|
explicit SideEffectsCollector(
|
|
|
|
Dialect const& _dialect,
|
|
|
|
std::map<YulString, SideEffects> const* _functionSideEffects = nullptr
|
|
|
|
): m_dialect(_dialect), m_functionSideEffects(_functionSideEffects) {}
|
2019-08-29 13:26:36 +00:00
|
|
|
SideEffectsCollector(
|
|
|
|
Dialect const& _dialect,
|
|
|
|
Expression const& _expression,
|
|
|
|
std::map<YulString, SideEffects> const* _functionSideEffects = nullptr
|
|
|
|
);
|
2019-05-27 11:11:00 +00:00
|
|
|
SideEffectsCollector(Dialect const& _dialect, Statement const& _statement);
|
2019-09-02 12:22:53 +00:00
|
|
|
SideEffectsCollector(
|
|
|
|
Dialect const& _dialect,
|
|
|
|
Block const& _ast,
|
|
|
|
std::map<YulString, SideEffects> const* _functionSideEffects = nullptr
|
|
|
|
);
|
2020-07-03 13:10:29 +00:00
|
|
|
SideEffectsCollector(
|
|
|
|
Dialect const& _dialect,
|
|
|
|
ForLoop const& _ast,
|
|
|
|
std::map<YulString, SideEffects> const* _functionSideEffects = nullptr
|
|
|
|
);
|
2017-11-22 10:11:48 +00:00
|
|
|
|
2019-05-27 11:11:00 +00:00
|
|
|
using ASTWalker::operator();
|
2018-11-16 01:09:04 +00:00
|
|
|
void operator()(FunctionCall const& _functionCall) override;
|
2017-11-22 10:11:48 +00:00
|
|
|
|
2019-08-13 12:40:26 +00:00
|
|
|
bool movable() const { return m_sideEffects.movable; }
|
2020-07-03 13:10:29 +00:00
|
|
|
|
|
|
|
bool movableRelativeTo(SideEffects const& _other, bool _codeContainsMSize)
|
|
|
|
{
|
|
|
|
if (!m_sideEffects.cannotLoop)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
if (m_sideEffects.movable)
|
|
|
|
return true;
|
|
|
|
|
|
|
|
if (
|
|
|
|
!m_sideEffects.movableApartFromEffects ||
|
|
|
|
m_sideEffects.storage == SideEffects::Write ||
|
|
|
|
m_sideEffects.otherState == SideEffects::Write ||
|
|
|
|
m_sideEffects.memory == SideEffects::Write
|
|
|
|
)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
if (m_sideEffects.otherState == SideEffects::Read)
|
|
|
|
if (_other.otherState == SideEffects::Write)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
if (m_sideEffects.storage == SideEffects::Read)
|
|
|
|
if (_other.storage == SideEffects::Write)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
if (m_sideEffects.memory == SideEffects::Read)
|
|
|
|
if (_codeContainsMSize || _other.memory == SideEffects::Write)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2020-07-01 10:07:00 +00:00
|
|
|
bool canBeRemoved(bool _allowMSizeModification = false) const
|
2019-05-27 11:42:50 +00:00
|
|
|
{
|
|
|
|
if (_allowMSizeModification)
|
2020-07-01 10:07:00 +00:00
|
|
|
return m_sideEffects.canBeRemovedIfNoMSize;
|
2019-05-27 11:42:50 +00:00
|
|
|
else
|
2020-07-01 10:07:00 +00:00
|
|
|
return m_sideEffects.canBeRemoved;
|
2019-05-27 11:42:50 +00:00
|
|
|
}
|
2020-07-01 10:07:00 +00:00
|
|
|
bool cannotLoop() const { return m_sideEffects.cannotLoop; }
|
|
|
|
bool invalidatesStorage() const { return m_sideEffects.storage == SideEffects::Write; }
|
|
|
|
bool invalidatesMemory() const { return m_sideEffects.memory == SideEffects::Write; }
|
|
|
|
|
2020-07-03 13:10:29 +00:00
|
|
|
SideEffects sideEffects() { return m_sideEffects; }
|
2017-11-22 10:11:48 +00:00
|
|
|
|
|
|
|
private:
|
2018-12-20 17:55:32 +00:00
|
|
|
Dialect const& m_dialect;
|
2019-08-13 16:38:11 +00:00
|
|
|
std::map<YulString, SideEffects> const* m_functionSideEffects = nullptr;
|
2019-08-13 12:40:26 +00:00
|
|
|
SideEffects m_sideEffects;
|
2019-05-27 11:11:00 +00:00
|
|
|
};
|
|
|
|
|
2019-08-13 14:25:12 +00:00
|
|
|
/**
|
|
|
|
* This class can be used to determine the side-effects of user-defined functions.
|
|
|
|
*
|
|
|
|
* It is given a dialect and a mapping that represents the direct calls from user-defined
|
|
|
|
* functions to other user-defined functions and built-in functions.
|
|
|
|
*/
|
|
|
|
class SideEffectsPropagator
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
static std::map<YulString, SideEffects> sideEffects(
|
|
|
|
Dialect const& _dialect,
|
2019-12-02 11:33:24 +00:00
|
|
|
CallGraph const& _directCallGraph
|
2019-08-13 14:25:12 +00:00
|
|
|
);
|
|
|
|
};
|
|
|
|
|
2019-08-13 11:34:33 +00:00
|
|
|
/**
|
2021-03-17 18:37:39 +00:00
|
|
|
* Class that can be used to find out if certain code contains the MSize instruction
|
|
|
|
* or a verbatim bytecode builtin (which is always assumed that it could contain MSize).
|
2019-08-13 11:34:33 +00:00
|
|
|
*
|
|
|
|
* Note that this is a purely syntactic property meaning that even if this is false,
|
|
|
|
* the code can still contain calls to functions that contain the msize instruction.
|
|
|
|
*
|
|
|
|
* The only safe way to determine this is by passing the full AST.
|
|
|
|
*/
|
|
|
|
class MSizeFinder: public ASTWalker
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
static bool containsMSize(Dialect const& _dialect, Block const& _ast);
|
2023-05-15 12:19:40 +00:00
|
|
|
static bool containsMSize(Dialect const& _dialect, Object const& _object);
|
2019-08-13 11:34:33 +00:00
|
|
|
|
|
|
|
using ASTWalker::operator();
|
2020-03-31 23:58:22 +00:00
|
|
|
void operator()(FunctionCall const& _funCall) override;
|
2019-08-13 11:34:33 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
MSizeFinder(Dialect const& _dialect): m_dialect(_dialect) {}
|
|
|
|
Dialect const& m_dialect;
|
|
|
|
bool m_msizeFound = false;
|
|
|
|
};
|
|
|
|
|
2019-10-28 14:25:02 +00:00
|
|
|
/**
|
|
|
|
* Class that can be used to find out if the given function contains the ``leave`` statement.
|
|
|
|
*
|
|
|
|
* Returns true even in the case where the function definition contains another function definition
|
|
|
|
* that contains the leave statement.
|
|
|
|
*/
|
|
|
|
class LeaveFinder: public ASTWalker
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
static bool containsLeave(FunctionDefinition const& _fun)
|
|
|
|
{
|
|
|
|
LeaveFinder f;
|
|
|
|
f(_fun);
|
|
|
|
return f.m_leaveFound;
|
|
|
|
}
|
|
|
|
|
|
|
|
using ASTWalker::operator();
|
2020-03-31 23:58:22 +00:00
|
|
|
void operator()(Leave const&) override { m_leaveFound = true; }
|
2019-10-28 14:25:02 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
LeaveFinder() = default;
|
|
|
|
|
|
|
|
bool m_leaveFound = false;
|
|
|
|
};
|
|
|
|
|
2019-05-27 11:11:00 +00:00
|
|
|
/**
|
|
|
|
* Specific AST walker that determines whether an expression is movable
|
|
|
|
* and collects the referenced variables.
|
|
|
|
* Can only be used on expressions.
|
|
|
|
*/
|
|
|
|
class MovableChecker: public SideEffectsCollector
|
|
|
|
{
|
|
|
|
public:
|
2019-08-13 16:38:11 +00:00
|
|
|
explicit MovableChecker(
|
|
|
|
Dialect const& _dialect,
|
|
|
|
std::map<YulString, SideEffects> const* _functionSideEffects = nullptr
|
|
|
|
): SideEffectsCollector(_dialect, _functionSideEffects) {}
|
2019-05-27 11:11:00 +00:00
|
|
|
MovableChecker(Dialect const& _dialect, Expression const& _expression);
|
|
|
|
|
|
|
|
void operator()(Identifier const& _identifier) override;
|
|
|
|
|
|
|
|
/// Disallow visiting anything apart from Expressions (this throws).
|
|
|
|
void visit(Statement const&) override;
|
|
|
|
using ASTWalker::visit;
|
|
|
|
|
|
|
|
std::set<YulString> const& referencedVariables() const { return m_variableReferences; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
/// Which variables the current expression references.
|
|
|
|
std::set<YulString> m_variableReferences;
|
2017-11-22 10:11:48 +00:00
|
|
|
};
|
|
|
|
|
2021-10-05 16:46:49 +00:00
|
|
|
struct ControlFlowSideEffects;
|
2019-05-27 11:11:00 +00:00
|
|
|
|
2019-05-13 09:00:45 +00:00
|
|
|
/**
|
|
|
|
* Helper class to find "irregular" control flow.
|
2021-10-05 16:46:49 +00:00
|
|
|
* This includes termination, break, continue and leave.
|
|
|
|
* In general, it is applied only to "simple" statements. The control-flow
|
|
|
|
* of loops, switches and if statements is always "FlowOut" with the assumption
|
|
|
|
* that the caller will descend into them.
|
2019-05-13 09:00:45 +00:00
|
|
|
*/
|
|
|
|
class TerminationFinder
|
|
|
|
{
|
|
|
|
public:
|
2021-10-05 16:46:49 +00:00
|
|
|
/// "Terminate" here means that there is no continuing control-flow.
|
|
|
|
/// If this is applied to a function that can revert or stop, but can also
|
|
|
|
/// exit regularly, the property is set to "FlowOut".
|
2019-10-28 14:25:02 +00:00
|
|
|
enum class ControlFlow { FlowOut, Break, Continue, Terminate, Leave };
|
2019-05-13 09:00:45 +00:00
|
|
|
|
2021-10-05 16:46:49 +00:00
|
|
|
TerminationFinder(
|
|
|
|
Dialect const& _dialect,
|
|
|
|
std::map<YulString, ControlFlowSideEffects> const* _functionSideEffects = nullptr
|
|
|
|
): m_dialect(_dialect), m_functionSideEffects(_functionSideEffects) {}
|
2019-05-20 12:30:32 +00:00
|
|
|
|
2019-05-13 09:00:45 +00:00
|
|
|
/// @returns the index of the first statement in the provided sequence
|
2019-10-28 14:25:02 +00:00
|
|
|
/// that is an unconditional ``break``, ``continue``, ``leave`` or a
|
2021-10-05 16:46:49 +00:00
|
|
|
/// call to a terminating function.
|
2019-05-13 09:00:45 +00:00
|
|
|
/// If control flow can continue at the end of the list,
|
|
|
|
/// returns `FlowOut` and ``size_t(-1)``.
|
|
|
|
/// The function might return ``FlowOut`` even though control
|
|
|
|
/// flow cannot actually continue.
|
2019-05-20 12:30:32 +00:00
|
|
|
std::pair<ControlFlow, size_t> firstUnconditionalControlFlowChange(
|
2019-05-13 09:00:45 +00:00
|
|
|
std::vector<Statement> const& _statements
|
|
|
|
);
|
|
|
|
|
|
|
|
/// @returns the control flow type of the given statement.
|
|
|
|
/// This function could return FlowOut even if control flow never continues.
|
2019-05-20 12:30:32 +00:00
|
|
|
ControlFlow controlFlowKind(Statement const& _statement);
|
2019-05-13 09:00:45 +00:00
|
|
|
|
2021-10-05 16:46:49 +00:00
|
|
|
/// @returns true if the expression contains a
|
|
|
|
/// call to a terminating function, i.e. a function that does not have
|
|
|
|
/// a regular "flow out" control-flow (it might also be recursive).
|
|
|
|
bool containsNonContinuingFunctionCall(Expression const& _expr);
|
2019-05-20 12:30:32 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
Dialect const& m_dialect;
|
2021-10-05 16:46:49 +00:00
|
|
|
std::map<YulString, ControlFlowSideEffects> const* m_functionSideEffects;
|
2019-05-13 09:00:45 +00:00
|
|
|
};
|
|
|
|
|
2017-11-22 10:11:48 +00:00
|
|
|
}
|