Merge pull request #5271 from ethereum/fullSuite

[Yul] Full suite tests.

4 files changed, 197 insertions, 0 deletions

diff --git a/libyul/optimiser/Suite.cpp b/libyul/optimiser/Suite.cpp
new file mode 100644
index 00000000..5b325afd
--- /dev/null
+++ b/libyul/optimiser/Suite.cpp
@@ -0,0 +1,113 @@
+/*
+	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/>.
+*/
+/**
+ * Optimiser suite that combines all steps and also provides the settings for the heuristics.
+ */
+
+#include <libyul/optimiser/Suite.h>
+
+#include <libyul/optimiser/Disambiguator.h>
+#include <libyul/optimiser/FunctionGrouper.h>
+#include <libyul/optimiser/FunctionHoister.h>
+#include <libyul/optimiser/ExpressionSplitter.h>
+#include <libyul/optimiser/ExpressionJoiner.h>
+#include <libyul/optimiser/ExpressionInliner.h>
+#include <libyul/optimiser/FullInliner.h>
+#include <libyul/optimiser/Rematerialiser.h>
+#include <libyul/optimiser/UnusedPruner.h>
+#include <libyul/optimiser/ExpressionSimplifier.h>
+#include <libyul/optimiser/CommonSubexpressionEliminator.h>
+#include <libyul/optimiser/SSATransform.h>
+#include <libyul/optimiser/RedundantAssignEliminator.h>
+
+#include <libsolidity/inlineasm/AsmAnalysisInfo.h>
+#include <libsolidity/inlineasm/AsmData.h>
+
+#include <libsolidity/inlineasm/AsmPrinter.h>
+
+#include <libdevcore/CommonData.h>
+
+using namespace std;
+using namespace dev;
+using namespace dev::yul;
+
+void OptimiserSuite::run(
+	Block& _ast,
+	solidity::assembly::AsmAnalysisInfo const& _analysisInfo,
+	set<string> const& _externallyUsedIdentifiers
+)
+{
+	set<string> reservedIdentifiers = _externallyUsedIdentifiers;
+
+	Block ast = boost::get<Block>(Disambiguator(_analysisInfo, reservedIdentifiers)(_ast));
+
+	(FunctionHoister{})(ast);
+	(FunctionGrouper{})(ast);
+
+	NameDispenser dispenser{ast};
+
+	for (size_t i = 0; i < 4; i++)
+	{
+		ExpressionSplitter{dispenser}(ast);
+		SSATransform::run(ast, dispenser);
+		RedundantAssignEliminator::run(ast);
+		RedundantAssignEliminator::run(ast);
+
+		CommonSubexpressionEliminator{}(ast);
+		ExpressionSimplifier::run(ast);
+		SSATransform::run(ast, dispenser);
+		RedundantAssignEliminator::run(ast);
+		RedundantAssignEliminator::run(ast);
+		UnusedPruner::runUntilStabilised(ast, reservedIdentifiers);
+		CommonSubexpressionEliminator{}(ast);
+		UnusedPruner::runUntilStabilised(ast, reservedIdentifiers);
+		SSATransform::run(ast, dispenser);
+		RedundantAssignEliminator::run(ast);
+		RedundantAssignEliminator::run(ast);
+
+		ExpressionJoiner::run(ast);
+		ExpressionJoiner::run(ast);
+		ExpressionInliner(ast).run();
+		UnusedPruner::runUntilStabilised(ast);
+
+		ExpressionSplitter{dispenser}(ast);
+		SSATransform::run(ast, dispenser);
+		RedundantAssignEliminator::run(ast);
+		RedundantAssignEliminator::run(ast);
+		CommonSubexpressionEliminator{}(ast);
+		FullInliner{ast, dispenser}.run();
+		SSATransform::run(ast, dispenser);
+		RedundantAssignEliminator::run(ast);
+		RedundantAssignEliminator::run(ast);
+		ExpressionSimplifier::run(ast);
+		CommonSubexpressionEliminator{}(ast);
+		SSATransform::run(ast, dispenser);
+		RedundantAssignEliminator::run(ast);
+		RedundantAssignEliminator::run(ast);
+		UnusedPruner::runUntilStabilised(ast, reservedIdentifiers);
+	}
+	ExpressionJoiner::run(ast);
+	UnusedPruner::runUntilStabilised(ast);
+	ExpressionJoiner::run(ast);
+	UnusedPruner::runUntilStabilised(ast);
+	ExpressionJoiner::run(ast);
+	UnusedPruner::runUntilStabilised(ast);
+	ExpressionJoiner::run(ast);
+	UnusedPruner::runUntilStabilised(ast);
+
+	_ast = std::move(ast);
+}
diff --git a/libyul/optimiser/Suite.h b/libyul/optimiser/Suite.h
new file mode 100644
index 00000000..bb6274bd
--- /dev/null
+++ b/libyul/optimiser/Suite.h
@@ -0,0 +1,55 @@
+/*
+	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/>.
+*/
+/**
+ * Optimiser suite that combines all steps and also provides the settings for the heuristics.
+ */
+
+#pragma once
+
+#include <libyul/ASTDataForward.h>
+
+#include <string>
+#include <map>
+#include <set>
+
+namespace dev
+{
+namespace solidity
+{
+namespace assembly
+{
+struct AsmAnalysisInfo;
+}
+}
+namespace yul
+{
+
+/**
+ * Optimiser suite that combines all steps and also provides the settings for the heuristics
+ */
+class OptimiserSuite
+{
+public:
+	static void run(
+		Block& _ast,
+		solidity::assembly::AsmAnalysisInfo const& _analysisInfo,
+		std::set<std::string> const& _externallyUsedIdentifiers = std::set<std::string>()
+	);
+};
+
+}
+}
diff --git a/test/libyul/YulOptimizerTest.cpp b/test/libyul/YulOptimizerTest.cpp
index 67715ac1..0378764d 100644
--- a/test/libyul/YulOptimizerTest.cpp
+++ b/test/libyul/YulOptimizerTest.cpp
@@ -37,6 +37,7 @@
 #include <libyul/optimiser/ExpressionJoiner.h>
 #include <libyul/optimiser/SSATransform.h>
 #include <libyul/optimiser/RedundantAssignEliminator.h>
+#include <libyul/optimiser/Suite.h>
 
 #include <libsolidity/parsing/Scanner.h>
 #include <libsolidity/inlineasm/AsmPrinter.h>
@@ -191,6 +192,8 @@ bool YulOptimizerTest::run(ostream& _stream, string const& _linePrefix, bool con
 		SSATransform::run(*m_ast, nameDispenser);
 		RedundantAssignEliminator::run(*m_ast);
 	}
+	else if (m_optimizerStep == "fullSuite")
+		OptimiserSuite::run(*m_ast, *m_analysisInfo);
 	else
 	{
 		FormattedScope(_stream, _formatted, {formatting::BOLD, formatting::RED}) << _linePrefix << "Invalid optimizer step: " << m_optimizerStep << endl;
diff --git a/test/libyul/yulOptimizerTests/fullSuite/medium.yul b/test/libyul/yulOptimizerTests/fullSuite/medium.yul
new file mode 100644
index 00000000..45cc555d
--- /dev/null
+++ b/test/libyul/yulOptimizerTests/fullSuite/medium.yul
@@ -0,0 +1,26 @@
+{
+    function allocate(size) -> p {
+        p := mload(0x40)
+        mstore(0x40, add(p, size))
+    }
+    function array_index_access(array, index) -> p {
+        p := add(array, mul(index, 0x20))
+    }
+    pop(allocate(0x20))
+    let x := allocate(0x40)
+    mstore(array_index_access(x, 3), 2)
+}
+// ----
+// fullSuite
+// {
+//     {
+//         let _12 := 0x20
+//         let allocate__7 := 0x40
+//         let allocate_p_2 := mload(allocate__7)
+//         mstore(allocate__7, add(allocate_p_2, _12))
+//         pop(allocate_p_2)
+//         let allocate_p_2_1 := mload(allocate__7)
+//         mstore(allocate__7, add(allocate_p_2_1, allocate__7))
+//         mstore(add(allocate_p_2_1, 96), 2)
+//     }
+// }