solidity/libyul/optimiser/StackCompressor.cpp

203 lines
5.8 KiB
C++
Raw Normal View History

2019-02-04 16:30:29 +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/>.
*/
/**
* Optimisation stage that aggressively rematerializes certain variables ina a function to free
* space on the stack until it is compilable.
*/
#include <libyul/optimiser/StackCompressor.h>
#include <libyul/optimiser/NameCollector.h>
#include <libyul/optimiser/Rematerialiser.h>
#include <libyul/optimiser/UnusedPruner.h>
#include <libyul/optimiser/Metrics.h>
#include <libyul/optimiser/Semantics.h>
#include <libyul/CompilabilityChecker.h>
#include <libyul/AST.h>
2019-02-04 16:30:29 +00:00
using namespace std;
2019-12-11 16:31:36 +00:00
using namespace solidity;
using namespace solidity::yul;
2019-02-04 16:30:29 +00:00
namespace
{
/**
* Class that discovers all variables that can be fully eliminated by rematerialization,
* and the corresponding approximate costs.
*/
class RematCandidateSelector: public DataFlowAnalyzer
2019-02-04 16:30:29 +00:00
{
public:
explicit RematCandidateSelector(Dialect const& _dialect): DataFlowAnalyzer(_dialect) {}
2019-05-22 15:55:36 +00:00
/// @returns a set of tuples of rematerialisation costs, variable to rematerialise
/// and variables that occur in its expression.
/// Note that this set is sorted by cost.
2019-05-22 15:55:36 +00:00
set<tuple<size_t, YulString, set<YulString>>> candidates()
{
2019-05-22 15:55:36 +00:00
set<tuple<size_t, YulString, set<YulString>>> cand;
for (auto const& codeCost: m_expressionCodeCost)
{
size_t numRef = m_numReferences[codeCost.first];
cand.emplace(make_tuple(codeCost.second * numRef, codeCost.first, m_references[codeCost.first]));
}
return cand;
}
using DataFlowAnalyzer::operator();
void operator()(VariableDeclaration& _varDecl) override
{
DataFlowAnalyzer::operator()(_varDecl);
if (_varDecl.variables.size() == 1)
{
YulString varName = _varDecl.variables.front().name;
if (m_value.count(varName))
2019-11-28 13:22:17 +00:00
m_expressionCodeCost[varName] = CodeCost::codeCost(m_dialect, *m_value[varName].value);
}
}
2019-02-04 16:30:29 +00:00
void operator()(Assignment& _assignment) override
{
for (auto const& var: _assignment.variableNames)
rematImpossible(var.name);
DataFlowAnalyzer::operator()(_assignment);
}
// We use visit(Expression) because operator()(Identifier) would also
// get called on left-hand-sides of assignments.
void visit(Expression& _e) override
{
if (holds_alternative<Identifier>(_e))
{
YulString name = std::get<Identifier>(_e).name;
if (m_expressionCodeCost.count(name))
{
if (!m_value.count(name))
rematImpossible(name);
else
++m_numReferences[name];
}
}
DataFlowAnalyzer::visit(_e);
}
2019-02-04 16:30:29 +00:00
/// Remove the variable from the candidate set.
void rematImpossible(YulString _variable)
2019-02-04 16:30:29 +00:00
{
m_numReferences.erase(_variable);
m_expressionCodeCost.erase(_variable);
2019-02-04 16:30:29 +00:00
}
/// Candidate variables and the code cost of their value.
map<YulString, size_t> m_expressionCodeCost;
/// Number of references to each candidate variable.
map<YulString, size_t> m_numReferences;
};
template <typename ASTNode>
void eliminateVariables(
Dialect const& _dialect,
ASTNode& _node,
size_t _numVariables,
bool _allowMSizeOptimization
)
{
RematCandidateSelector selector{_dialect};
selector(_node);
2019-02-04 16:30:29 +00:00
// Select at most _numVariables
set<YulString> varsToEliminate;
for (auto const& costs: selector.candidates())
2019-02-04 16:30:29 +00:00
{
if (varsToEliminate.size() >= _numVariables)
break;
2019-05-22 15:55:36 +00:00
// If a variable we would like to eliminate references another one
// we already selected for elimination, then stop selecting
// candidates. If we would add that variable, then the cost calculation
// for the previous variable would be off. Furthermore, we
// do not skip the variable because it would be better to properly re-compute
// the costs of all other variables instead.
bool referencesVarToEliminate = false;
for (YulString const& referencedVar: get<2>(costs))
if (varsToEliminate.count(referencedVar))
{
referencesVarToEliminate = true;
break;
}
if (referencesVarToEliminate)
break;
varsToEliminate.insert(get<1>(costs));
2019-02-04 16:30:29 +00:00
}
Rematerialiser::run(_dialect, _node, std::move(varsToEliminate));
UnusedPruner::runUntilStabilised(_dialect, _node, _allowMSizeOptimization);
2019-02-04 16:30:29 +00:00
}
}
bool StackCompressor::run(
Dialect const& _dialect,
Object& _object,
bool _optimizeStackAllocation,
size_t _maxIterations
)
2019-02-04 16:30:29 +00:00
{
yulAssert(
_object.code &&
_object.code->statements.size() > 0 && holds_alternative<Block>(_object.code->statements.at(0)),
2019-02-04 16:30:29 +00:00
"Need to run the function grouper before the stack compressor."
);
bool allowMSizeOptimzation = !MSizeFinder::containsMSize(_dialect, *_object.code);
for (size_t iterations = 0; iterations < _maxIterations; iterations++)
2019-02-04 16:30:29 +00:00
{
2020-07-02 10:48:20 +00:00
map<YulString, int> stackSurplus = CompilabilityChecker(_dialect, _object, _optimizeStackAllocation).stackDeficit;
2019-02-04 16:30:29 +00:00
if (stackSurplus.empty())
return true;
if (stackSurplus.count(YulString{}))
{
yulAssert(stackSurplus.at({}) > 0, "Invalid surplus value.");
eliminateVariables(
_dialect,
std::get<Block>(_object.code->statements.at(0)),
static_cast<size_t>(stackSurplus.at({})),
allowMSizeOptimzation
);
2019-02-04 16:30:29 +00:00
}
for (size_t i = 1; i < _object.code->statements.size(); ++i)
2019-02-04 16:30:29 +00:00
{
auto& fun = std::get<FunctionDefinition>(_object.code->statements[i]);
2019-02-04 16:30:29 +00:00
if (!stackSurplus.count(fun.name))
continue;
yulAssert(stackSurplus.at(fun.name) > 0, "Invalid surplus value.");
eliminateVariables(
_dialect,
fun,
static_cast<size_t>(stackSurplus.at(fun.name)),
allowMSizeOptimzation
);
2019-02-04 16:30:29 +00:00
}
}
return false;
}