Test cases for SWAPN, DUPN and related stack shuffling.

Author: ekpyron

test/libyul/StackLayoutGeneratorTest.cpp

@@ -232,13 +232,10 @@ TestCase::TestResult StackLayoutGeneratorTest::run(std::ostream& _stream, std::s
 		yulStack.parserResult()->code()->root()
 	);
 
-	bool simulateFunctionsWithJumps = true;
-	size_t reachableStackDepth = 16;
-	if (auto const* evmDialect = dynamic_cast<EVMDialect const*>(&yulStack.dialect()))
-	{
-		simulateFunctionsWithJumps = !evmDialect->eofVersion().has_value();
-		reachableStackDepth = evmDialect->reachableStackDepth();
-	}
+	auto const* evmDialect = dynamic_cast<EVMDialect const*>(&yulStack.dialect());
+	solAssert(evmDialect, "StackLayoutGenerator can only be run on EVM dialects.");
+	bool simulateFunctionsWithJumps = !evmDialect->eofVersion().has_value();
+	size_t reachableStackDepth = evmDialect->reachableStackDepth();
 
 	StackLayout stackLayout = StackLayoutGenerator::run(*cfg, simulateFunctionsWithJumps, reachableStackDepth);
 

test/libyul/StackShufflingTest.cpp

@@ -24,6 +24,7 @@
 
 #include <liblangutil/Scanner.h>
 #include <libsolutil/AnsiColorized.h>
+#include <libsolutil/StringUtils.h>
 
 using namespace solidity::test;
 using namespace solidity::util;
@@ -136,10 +137,20 @@ bool StackShufflingTest::parse(std::string const& _source)
 StackShufflingTest::StackShufflingTest(std::string const& _filename):
 	TestCase(_filename)
 {
+	processSettings();
 	m_source = m_reader.source();
 	m_expectation = m_reader.simpleExpectations();
 }
 
+void StackShufflingTest::processSettings()
+{
+	std::string depthString = m_reader.stringSetting("maximumStackDepth", "16");
+	std::optional<unsigned> depth = toUnsignedInt(depthString);
+	if (!depth.has_value())
+		BOOST_THROW_EXCEPTION(std::runtime_error{"Invalid maximum stack depth: \"" + depthString + "\""});
+	m_maximumStackDepth = *depth;
+}
+
 TestCase::TestResult StackShufflingTest::run(std::ostream& _stream, std::string const& _linePrefix, bool _formatted)
 {
 	auto const& dialect = CommonOptions::get().evmDialect();
@@ -150,16 +161,19 @@ TestCase::TestResult StackShufflingTest::run(std::ostream& _stream, std::string
 	}
 
 	std::ostringstream output;
+	size_t operations = 0;
 	createStackLayout(
 		m_sourceStack,
 		m_targetStack,
 		[&](unsigned _swapDepth) // swap
 		{
+			++operations;
 			output << stackToString(m_sourceStack, dialect) << std::endl;
 			output << "SWAP" << _swapDepth << std::endl;
 		},
 		[&](StackSlot const& _slot) // dupOrPush
 		{
+			++operations;
 			output << stackToString(m_sourceStack, dialect) << std::endl;
 			if (canBeFreelyGenerated(_slot))
 				output << "PUSH " << stackSlotToString(_slot, dialect) << std::endl;
@@ -172,13 +186,15 @@ TestCase::TestResult StackShufflingTest::run(std::ostream& _stream, std::string
 			}
 		},
 		[&](){ // pop
+			++operations;
 			output << stackToString(m_sourceStack, dialect) << std::endl;
 			output << "POP" << std::endl;
 		},
-		16u // TODO: make it a test setting
+		m_maximumStackDepth
     );
 
 	output << stackToString(m_sourceStack, dialect) << std::endl;
+	output << operations << " operations" << std::endl;
 	m_obtainedResult = output.str();
 
 	return checkResult(_stream, _linePrefix, _formatted);

test/libyul/StackShufflingTest.h

@@ -37,8 +37,10 @@ class StackShufflingTest: public TestCase
 	explicit StackShufflingTest(std::string const& _filename);
 	TestResult run(std::ostream& _stream, std::string const& _linePrefix = "", bool const _formatted = false) override;
 private:
+	void processSettings();
 	bool parse(std::string const& _source);
 
+	size_t m_maximumStackDepth{};
 	Stack m_sourceStack;
 	Stack m_targetStack;
 	std::map<YulName, yul::FunctionCall> m_functions;