Do not run StackCompressor and StackLimitEvader on EOF.

ekpyron · ekpyron · commit 4d38789c12fe · 2025-02-26T20:03:38.000+01:00
diff --git a/libyul/optimiser/StackCompressor.cpp b/libyul/optimiser/StackCompressor.cpp
@@ -249,15 +249,14 @@ std::tuple<bool, Block> StackCompressor::run(
 	);
 	bool usesOptimizedCodeGenerator = false;
 	bool simulateFunctionsWithJumps = true;
-	size_t reachableStackDepth = 16;
 	if (auto evmDialect = dynamic_cast<EVMDialect const*>(_object.dialect()))
 	{
+		yulAssert(!evmDialect->eofVersion().has_value(), "StackCompressor does not support EOF.");
 		usesOptimizedCodeGenerator =
 			_optimizeStackAllocation &&
 			evmDialect->evmVersion().canOverchargeGasForCall() &&
 			evmDialect->providesObjectAccess();
 		simulateFunctionsWithJumps = !evmDialect->eofVersion().has_value();
-		reachableStackDepth = evmDialect->reachableStackDepth();
 	}
 	bool allowMSizeOptimization = !MSizeFinder::containsMSize(*_object.dialect(), _object.code()->root());
 	Block astRoot = std::get<Block>(ASTCopier{}(_object.code()->root()));
@@ -272,7 +271,7 @@ std::tuple<bool, Block> StackCompressor::run(
 		eliminateVariablesOptimizedCodegen(
 			*_object.dialect(),
 			astRoot,
-			StackLayoutGenerator::reportStackTooDeep(*cfg, simulateFunctionsWithJumps, reachableStackDepth),
+			StackLayoutGenerator::reportStackTooDeep(*cfg, simulateFunctionsWithJumps, 16u),
 			allowMSizeOptimization
 		);
 	}
diff --git a/libyul/optimiser/StackLimitEvader.cpp b/libyul/optimiser/StackLimitEvader.cpp
@@ -132,6 +132,10 @@ Block StackLimitEvader::run(
 		evmDialect && evmDialect->providesObjectAccess(),
 		"StackLimitEvader can only be run on objects using the EVMDialect with object access."
 	);
+	yulAssert(
+		!evmDialect->eofVersion().has_value(),
+		"StackLimitEvader does not support EOF."
+	);
 	auto astRoot = std::get<Block>(ASTCopier{}(_object.code()->root()));
 	if (evmDialect && evmDialect->evmVersion().canOverchargeGasForCall())
 	{
@@ -159,6 +163,15 @@ void StackLimitEvader::run(
 	std::map<YulName, std::vector<StackLayoutGenerator::StackTooDeep>> const& _stackTooDeepErrors
 )
 {
+	auto const* evmDialect = dynamic_cast<EVMDialect const*>(&_context.dialect);
+	yulAssert(
+		evmDialect && evmDialect->providesObjectAccess(),
+		"StackLimitEvader can only be run on objects using the EVMDialect with object access."
+	);
+	yulAssert(
+		!evmDialect->eofVersion().has_value(),
+		"StackLimitEvader does not support EOF."
+	);
 	std::map<YulName, std::vector<YulName>> unreachableVariables;
 	for (auto&& [function, stackTooDeepErrors]: _stackTooDeepErrors)
 	{
@@ -183,6 +196,10 @@ void StackLimitEvader::run(
 		evmDialect && evmDialect->providesObjectAccess(),
 		"StackLimitEvader can only be run on objects using the EVMDialect with object access."
 	);
+	yulAssert(
+		!evmDialect->eofVersion().has_value(),
+		"StackLimitEvader does not support EOF."
+	);
 
 	std::vector<FunctionCall*> memoryGuardCalls = findFunctionCalls(_astRoot, "memoryguard", *evmDialect);
 	// Do not optimise, if no ``memoryguard`` call is found.
diff --git a/libyul/optimiser/Suite.cpp b/libyul/optimiser/Suite.cpp
@@ -163,25 +163,29 @@ void OptimiserSuite::run(
 		}
 		if (usesOptimizedCodeGenerator)
 		{
+			if (!evmDialect->eofVersion().has_value())
 			{
-				PROFILER_PROBE("StackCompressor", probe);
-				_object.setCode(std::make_shared<AST>(dialect, std::move(astRoot)));
-				astRoot = std::get<1>(StackCompressor::run(
-					_object,
-					_optimizeStackAllocation,
-					stackCompressorMaxIterations
-				));
-			}
-			if (evmDialect->providesObjectAccess())
-			{
-				PROFILER_PROBE("StackLimitEvader", probe);
-				_object.setCode(std::make_shared<AST>(dialect, std::move(astRoot)));
-				astRoot = StackLimitEvader::run(suite.m_context, _object);
+				{
+					PROFILER_PROBE("StackCompressor", probe);
+					_object.setCode(std::make_shared<AST>(dialect, std::move(astRoot)));
+					astRoot = std::get<1>(StackCompressor::run(
+						_object,
+						_optimizeStackAllocation,
+						stackCompressorMaxIterations
+					));
+				}
+				if (evmDialect->providesObjectAccess())
+				{
+					PROFILER_PROBE("StackLimitEvader", probe);
+					_object.setCode(std::make_shared<AST>(dialect, std::move(astRoot)));
+					astRoot = StackLimitEvader::run(suite.m_context, _object);
+				}
 			}
 		}
 		else if (evmDialect->providesObjectAccess() && _optimizeStackAllocation)
 		{
 			PROFILER_PROBE("StackLimitEvader", probe);
+			yulAssert(!evmDialect->eofVersion().has_value(), "");
 			_object.setCode(std::make_shared<AST>(dialect, std::move(astRoot)));
 			astRoot = StackLimitEvader::run(suite.m_context, _object);
 		}
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/connected.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/connected.yul
@@ -20,6 +20,8 @@
 	sstore(0, f())
 	let x, y := g()
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/function_arg.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/function_arg.yul
@@ -7,6 +7,8 @@
 	}
 	sstore(1, h(32))
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/multi_variable_declaration_without_value.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/multi_variable_declaration_without_value.yul
@@ -7,6 +7,8 @@
     let z, $w
   }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/outer_block.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/outer_block.yul
@@ -3,6 +3,8 @@
     let $x := 42
     sstore(42, $x)
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/return_leave.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/return_leave.yul
@@ -14,6 +14,8 @@
     }
 
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/return_one.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/return_one.yul
@@ -12,6 +12,8 @@
     }
 
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/return_one_with_args.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/return_one_with_args.yul
@@ -12,6 +12,8 @@
     }
 
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/same_variable_in_lhs_and_rhs.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/same_variable_in_lhs_and_rhs.yul
@@ -5,6 +5,8 @@
     let $z := 42
     $z := f($z)
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/fakeStackLimitEvader/stub.yul b/test/libyul/yulOptimizerTests/fakeStackLimitEvader/stub.yul
@@ -23,6 +23,8 @@
     g(0)
     h(1, 2, 3, 4)
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: fakeStackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackCompressor/noInline.yul b/test/libyul/yulOptimizerTests/stackCompressor/noInline.yul
@@ -2,6 +2,8 @@
   let x := 8
   function f() { let y := 9 }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackCompressor
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/cycle.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/cycle.yul
@@ -44,6 +44,8 @@
         sstore(23, g(sload(42)))
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_after.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_after.yul
@@ -44,6 +44,8 @@
         v := h()
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_after_2.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_after_2.yul
@@ -47,6 +47,8 @@
         v := h()
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_before.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_before.yul
@@ -49,6 +49,8 @@
         sstore(mul(1,4), a1)
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_before_2.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_before_2.yul
@@ -52,6 +52,8 @@
         sstore(mul(1,4), a1)
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_before_after.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/cycle_before_after.yul
@@ -53,6 +53,8 @@
         v := h()
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/function_arg.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/function_arg.yul
@@ -40,6 +40,8 @@
 	sstore(mul(1,4), a1)
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/stub.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/stub.yul
@@ -45,6 +45,8 @@
 	sstore(mul(1,4), a1)
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_args_14.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_args_14.yul
@@ -15,6 +15,8 @@
     }
 
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_args_15.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_args_15.yul
@@ -17,6 +17,8 @@
     }
 
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_args_16.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_args_16.yul
@@ -17,6 +17,8 @@
     }
 
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_returns_15.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_returns_15.yul
@@ -13,6 +13,8 @@
     }
 
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_returns_16.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/too_many_returns_16.yul
@@ -13,6 +13,8 @@
     }
 
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/tree.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/tree.yul
@@ -164,6 +164,8 @@
         v := sload(mul(42,8))
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/verbatim_many_arguments.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/verbatim_many_arguments.yul
@@ -24,6 +24,8 @@
         verbatim_20i_0o("test", a_1, a_2, a_3, a_4, a_5, a_6, a_7, a_8, a_9, a_10, a_11, a_12, a_13, a_14, a_15, a_16, a_17, a_18, a_19, a_20)
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/verbatim_many_arguments_and_returns.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/verbatim_many_arguments_and_returns.yul
@@ -45,6 +45,8 @@
 
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //
diff --git a/test/libyul/yulOptimizerTests/stackLimitEvader/verbatim_many_returns.yul b/test/libyul/yulOptimizerTests/stackLimitEvader/verbatim_many_returns.yul
@@ -7,6 +7,8 @@
         sstore(a18, 20)
     }
 }
+// ====
+// bytecodeFormat: legacy
 // ----
 // step: stackLimitEvader
 //

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`sstore(0, f())`
`21`	`21`	`let x, y := g()`
`22`	`22`	`}`
	`23`	`+// ====`
	`24`	`+// bytecodeFormat: legacy`
`23`	`25`	`// ----`
`24`	`26`	`// step: fakeStackLimitEvader`
`25`	`27`	`//`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`	`}`
`8`	`8`	`sstore(1, h(32))`
`9`	`9`	`}`
	`10`	`+// ====`
	`11`	`+// bytecodeFormat: legacy`
`10`	`12`	`// ----`
`11`	`13`	`// step: fakeStackLimitEvader`
`12`	`14`	`//`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`	`let z, $w`
`8`	`8`	`}`
`9`	`9`	`}`
	`10`	`+// ====`
	`11`	`+// bytecodeFormat: legacy`
`10`	`12`	`// ----`
`11`	`13`	`// step: fakeStackLimitEvader`
`12`	`14`	`//`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`let $x := 42`
`4`	`4`	`sstore(42, $x)`
`5`	`5`	`}`
	`6`	`+// ====`
	`7`	`+// bytecodeFormat: legacy`
`6`	`8`	`// ----`
`7`	`9`	`// step: fakeStackLimitEvader`
`8`	`10`	`//`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`}`
	`17`	`+// ====`
	`18`	`+// bytecodeFormat: legacy`
`17`	`19`	`// ----`
`18`	`20`	`// step: fakeStackLimitEvader`
`19`	`21`	`//`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`}`
	`15`	`+// ====`
	`16`	`+// bytecodeFormat: legacy`
`15`	`17`	`// ----`
`16`	`18`	`// step: fakeStackLimitEvader`
`17`	`19`	`//`