Control flow side-effects for user-defined functions.

2023-10-03 13:03:40 +00:00 · 2021-10-14 17:46:07 +02:00
parent d443fe415d
commit 9417d6775f
20 changed files with 637 additions and 32 deletions
@@ -0,0 +1,79 @@
+/*
+	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/>.
+*/
+// SPDX-License-Identifier: GPL-3.0
+
+#include <test/libyul/ControlFlowSideEffectsTest.h>
+
+#include <test/Common.h>
+#include <test/libyul/Common.h>
+
+#include <libyul/Object.h>
+#include <libyul/ControlFlowSideEffects.h>
+#include <libyul/ControlFlowSideEffectsCollector.h>
+#include <libyul/backends/evm/EVMDialect.h>
+
+using namespace std;
+using namespace solidity;
+using namespace solidity::yul;
+using namespace solidity::yul::test;
+using namespace solidity::frontend::test;
+
+namespace
+{
+string toString(ControlFlowSideEffects const& _sideEffects)
+{
+	vector<string> r;
+	if (_sideEffects.canTerminate)
+		r.emplace_back("can terminate");
+	if (_sideEffects.canRevert)
+		r.emplace_back("can revert");
+	if (_sideEffects.canContinue)
+		r.emplace_back("can continue");
+	return util::joinHumanReadable(r);
+}
+}
+
+ControlFlowSideEffectsTest::ControlFlowSideEffectsTest(string const& _filename):
+	TestCase(_filename)
+{
+	m_source = m_reader.source();
+	m_expectation = m_reader.simpleExpectations();
+}
+
+TestCase::TestResult ControlFlowSideEffectsTest::run(ostream& _stream, string const& _linePrefix, bool _formatted)
+{
+	Object obj;
+	std::tie(obj.code, obj.analysisInfo) = yul::test::parse(m_source, false);
+	if (!obj.code)
+		BOOST_THROW_EXCEPTION(runtime_error("Parsing input failed."));
+
+	std::map<YulString, ControlFlowSideEffects> sideEffects =
+		ControlFlowSideEffectsCollector(
+			EVMDialect::strictAssemblyForEVMObjects(langutil::EVMVersion()),
+			*obj.code
+		).functionSideEffects();
+
+	std::map<std::string, std::string> controlFlowSideEffectsStr;
+	for (auto&& [fun, effects]: sideEffects)
+		controlFlowSideEffectsStr[fun.str()] = toString(effects);
+
+	m_obtainedResult.clear();
+	for (auto&& [functionName, effect]: controlFlowSideEffectsStr)
+		m_obtainedResult += functionName + (effect.empty() ? ":" : ": " + effect) + "\n";
+
+	return checkResult(_stream, _linePrefix, _formatted);
+}