Merge pull request #15954 from ethereum/ossfuzz_use_ast_over_block

clonker · web-flow · commit 6326b8673ec1 · 2025-03-22T06:31:54.000+01:00
ossfuzz and Yul interpreter use ast over block
diff --git a/test/libyul/YulInterpreterTest.cpp b/test/libyul/YulInterpreterTest.cpp
@@ -80,8 +80,7 @@ std::string YulInterpreterTest::interpret(std::shared_ptr<Object const> const& _
 	{
 		Interpreter::run(
 			state,
-			*_object->dialect(),
-			_object->code()->root(),
+			*_object->code(),
 			/*disableExternalCalls=*/ !m_simulateExternalCallsToSelf,
 			/*disableMemoryTracing=*/ false
 		);
diff --git a/test/tools/ossfuzz/strictasm_diff_ossfuzz.cpp b/test/tools/ossfuzz/strictasm_diff_ossfuzz.cpp
@@ -90,8 +90,7 @@ extern "C" int LLVMFuzzerTestOneInput(uint8_t const* _data, size_t _size)
 	// TODO: Add EOF support
 	yulFuzzerUtil::TerminationReason termReason = yulFuzzerUtil::interpret(
 		os1,
-		stack.parserResult()->code()->root(),
-		EVMDialect::strictAssemblyForEVMObjects(langutil::EVMVersion(), std::nullopt),
+		*stack.parserResult()->code(),
 		/*disableMemoryTracing=*/true
 	);
 	if (yulFuzzerUtil::resourceLimitsExceeded(termReason))
@@ -100,8 +99,7 @@ extern "C" int LLVMFuzzerTestOneInput(uint8_t const* _data, size_t _size)
 	stack.optimize();
 	termReason = yulFuzzerUtil::interpret(
 		os2,
-		stack.parserResult()->code()->root(),
-		EVMDialect::strictAssemblyForEVMObjects(langutil::EVMVersion(), std::nullopt),
+		*stack.parserResult()->code(),
 		/*disableMemoryTracing=*/true
 	);
 
diff --git a/test/tools/ossfuzz/yulFuzzerCommon.cpp b/test/tools/ossfuzz/yulFuzzerCommon.cpp
@@ -23,8 +23,7 @@ using namespace solidity::yul::test::yul_fuzzer;
 
 yulFuzzerUtil::TerminationReason yulFuzzerUtil::interpret(
 	std::ostream& _os,
-	yul::Block const& _astRoot,
-	Dialect const& _dialect,
+	AST const& _ast,
 	bool _disableMemoryTracing,
 	bool _outputStorageOnly,
 	size_t _maxSteps,
@@ -52,7 +51,7 @@ yulFuzzerUtil::TerminationReason yulFuzzerUtil::interpret(
 	TerminationReason reason = TerminationReason::None;
 	try
 	{
-		Interpreter::run(state, _dialect, _astRoot, true, _disableMemoryTracing);
+		Interpreter::run(state, _ast, true, _disableMemoryTracing);
 	}
 	catch (StepLimitReached const&)
 	{
diff --git a/test/tools/ossfuzz/yulFuzzerCommon.h b/test/tools/ossfuzz/yulFuzzerCommon.h
@@ -40,8 +40,7 @@ struct yulFuzzerUtil
 	/// eliminator.
 	static TerminationReason interpret(
 		std::ostream& _os,
-		yul::Block const& _astRoot,
-		Dialect const& _dialect,
+		AST const& _ast,
 		bool _disableMemoryTracing = false,
 		bool _outputStorageOnly = false,
 		size_t _maxSteps = maxSteps,
diff --git a/test/tools/ossfuzz/yulProto_diff_ossfuzz.cpp b/test/tools/ossfuzz/yulProto_diff_ossfuzz.cpp
@@ -90,8 +90,7 @@ DEFINE_PROTO_FUZZER(Program const& _input)
 	// TODO: Add EOF support
 	yulFuzzerUtil::TerminationReason termReason = yulFuzzerUtil::interpret(
 		os1,
-		stack.parserResult()->code()->root(),
-		EVMDialect::strictAssemblyForEVMObjects(version, std::nullopt),
+		*stack.parserResult()->code(),
 		/*disableMemoryTracing=*/true
 	);
 
@@ -106,8 +105,7 @@ DEFINE_PROTO_FUZZER(Program const& _input)
 	// TODO: Add EOF support
 	termReason = yulFuzzerUtil::interpret(
 		os2,
-		*astRoot,
-		EVMDialect::strictAssemblyForEVMObjects(version, std::nullopt),
+		*optimizerTest.optimizedObject()->code(),
 		true
 	);
 	if (yulFuzzerUtil::resourceLimitsExceeded(termReason))
diff --git a/test/tools/yulInterpreter/Inspector.cpp b/test/tools/yulInterpreter/Inspector.cpp
@@ -31,9 +31,9 @@ using namespace solidity::yul::test;
 namespace
 {
 
-void printVariable(YulString const& _name, u256 const& _value)
+void printVariable(std::string_view const _name, u256 const& _value)
 {
-	std::cout << "\t" << _name.str() << " = " << _value.str();
+	std::cout << "\t" << _name << " = " << _value.str();
 
 	if (_value != 0)
 		std::cout << " (" << toCompactHexWithPrefix(_value) << ")";
@@ -46,17 +46,16 @@ void printVariable(YulString const& _name, u256 const& _value)
 void InspectedInterpreter::run(
 	std::shared_ptr<Inspector> _inspector,
 	InterpreterState& _state,
-	Dialect const& _dialect,
-	Block const& _ast,
+	AST const& _ast,
 	bool _disableExternalCalls,
 	bool _disableMemoryTrace
 )
 {
 	Scope scope;
-	InspectedInterpreter{_inspector, _state, _dialect, scope, _disableExternalCalls, _disableMemoryTrace}(_ast);
+	InspectedInterpreter{_inspector, _state, _ast.dialect(), scope, _disableExternalCalls, _disableMemoryTrace}(_ast.root());
 }
 
-Inspector::NodeAction Inspector::queryUser(langutil::DebugData const& _data, std::map<YulString, u256> const& _variables)
+Inspector::NodeAction Inspector::queryUser(langutil::DebugData const& _data, std::map<YulName, u256> const& _variables)
 {
 	if (m_stepMode == NodeAction::RunNode)
 	{
@@ -99,7 +98,7 @@ Inspector::NodeAction Inspector::queryUser(langutil::DebugData const& _data, std
 		else if (input == "variables" || input == "v")
 		{
 			for (auto &&[yulStr, val]: _variables)
-				printVariable(yulStr, val);
+				printVariable(yulStr.str(), val);
 			std::cout << std::endl;
 		}
 		else if (
@@ -120,7 +119,7 @@ Inspector::NodeAction Inspector::queryUser(langutil::DebugData const& _data, std
 			for (auto &&[yulStr, val]: _variables)
 				if (yulStr.str() == varname)
 				{
-					printVariable(yulStr, val);
+					printVariable(varname, val);
 					found = true;
 					break;
 				}
diff --git a/test/tools/yulInterpreter/Inspector.h b/test/tools/yulInterpreter/Inspector.h
@@ -103,8 +103,7 @@ class InspectedInterpreter: public Interpreter
 	static void run(
 		std::shared_ptr<Inspector> _inspector,
 		InterpreterState& _state,
-		Dialect const& _dialect,
-		Block const& _ast,
+		AST const& _ast,
 		bool _disableExternalCalls,
 		bool _disableMemoryTracing
 	);
diff --git a/test/tools/yulInterpreter/Interpreter.cpp b/test/tools/yulInterpreter/Interpreter.cpp
@@ -109,14 +109,13 @@ void InterpreterState::dumpTraceAndState(std::ostream& _out, bool _disableMemory
 
 void Interpreter::run(
 	InterpreterState& _state,
-	Dialect const& _dialect,
-	Block const& _ast,
+	AST const& _ast,
 	bool _disableExternalCalls,
 	bool _disableMemoryTrace
 )
 {
 	Scope scope;
-	Interpreter{_state, _dialect, scope, _disableExternalCalls, _disableMemoryTrace}(_ast);
+	Interpreter{_state, _ast.dialect(), scope, _disableExternalCalls, _disableMemoryTrace}(_ast.root());
 }
 
 void Interpreter::operator()(ExpressionStatement const& _expressionStatement)
diff --git a/test/tools/yulInterpreter/Interpreter.h b/test/tools/yulInterpreter/Interpreter.h
@@ -22,6 +22,7 @@
 #pragma once
 
 #include <libyul/ASTForward.h>
+#include <libyul/backends/evm/EVMDialect.h>
 #include <libyul/optimiser/ASTWalker.h>
 
 #include <libevmasm/Instruction.h>
@@ -162,8 +163,7 @@ class Interpreter: public ASTWalker
 	/// activated e.g., Redundant store eliminator, Equal store eliminator.
 	static void run(
 		InterpreterState& _state,
-		Dialect const& _dialect,
-		Block const& _ast,
+		AST const& _ast,
 		bool _disableExternalCalls,
 		bool _disableMemoryTracing
 	);
diff --git a/test/tools/yulrun.cpp b/test/tools/yulrun.cpp
@@ -63,6 +63,9 @@ std::pair<std::shared_ptr<AST const>, std::shared_ptr<AsmAnalysisInfo>> parse(st
 		solidity::frontend::OptimiserSettings::none(),
 		DebugInfoSelection::Default()
 	);
+	auto const* evmDialect = dynamic_cast<EVMDialect const*>(&stack.dialect());
+	// TODO: Add EOF support
+	solUnimplementedAssert(evmDialect && !evmDialect->eofVersion(), "No EOF support for yulrun yet.");
 	if (stack.parseAndAnalyze("--INPUT--", _source))
 	{
 		yulAssert(!Error::hasErrorsWarningsOrInfos(stack.errors()), "Parsed successfully but had errors.");
@@ -87,13 +90,10 @@ void interpret(std::string const& _source, bool _inspect, bool _disableExternalC
 	state.maxTraceSize = 10000;
 	try
 	{
-		Dialect const& dialect(EVMDialect::strictAssemblyForEVMObjects(langutil::EVMVersion{}, std::nullopt));
-
 		if (_inspect)
-			InspectedInterpreter::run(std::make_shared<Inspector>(_source, state), state, dialect, ast->root(), _disableExternalCalls, /*disableMemoryTracing=*/false);
-
+			InspectedInterpreter::run(std::make_shared<Inspector>(_source, state), state, *ast, _disableExternalCalls, /*disableMemoryTracing=*/false);
 		else
-			Interpreter::run(state, dialect, ast->root(), _disableExternalCalls, /*disableMemoryTracing=*/false);
+			Interpreter::run(state, *ast, _disableExternalCalls, /*disableMemoryTracing=*/false);
 	}
 	catch (InterpreterTerminatedGeneric const&)
 	{

Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,7 @@ using namespace solidity::yul::test::yul_fuzzer;`
`23`	`23`
`24`	`24`	`yulFuzzerUtil::TerminationReason yulFuzzerUtil::interpret(`
`25`	`25`	`std::ostream& _os,`
`26`		`- yul::Block const& _astRoot,`
`27`		`- Dialect const& _dialect,`
	`26`	`+ AST const& _ast,`
`28`	`27`	`bool _disableMemoryTracing,`
`29`	`28`	`bool _outputStorageOnly,`
`30`	`29`	`size_t _maxSteps,`
`@@ -52,7 +51,7 @@ yulFuzzerUtil::TerminationReason yulFuzzerUtil::interpret(`
`52`	`51`	`TerminationReason reason = TerminationReason::None;`
`53`	`52`	`try`
`54`	`53`	`{`
`55`		`- Interpreter::run(state, _dialect, _astRoot, true, _disableMemoryTracing);`
	`54`	`+ Interpreter::run(state, _ast, true, _disableMemoryTracing);`
`56`	`55`	`}`
`57`	`56`	`catch (StepLimitReached const&)`
`58`	`57`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,9 @@ using namespace solidity::yul::test;`
`31`	`31`	`namespace`
`32`	`32`	`{`
`33`	`33`
`34`		`-void printVariable(YulString const& _name, u256 const& _value)`
	`34`	`+void printVariable(std::string_view const _name, u256 const& _value)`
`35`	`35`	`{`
`36`		`- std::cout << "\t" << _name.str() << " = " << _value.str();`
	`36`	`+ std::cout << "\t" << _name << " = " << _value.str();`
`37`	`37`
`38`	`38`	`if (_value != 0)`
`39`	`39`	`std::cout << " (" << toCompactHexWithPrefix(_value) << ")";`
`@@ -46,17 +46,16 @@ void printVariable(YulString const& _name, u256 const& _value)`
`46`	`46`	`void InspectedInterpreter::run(`
`47`	`47`	`std::shared_ptr<Inspector> _inspector,`
`48`	`48`	`InterpreterState& _state,`
`49`		`- Dialect const& _dialect,`
`50`		`- Block const& _ast,`
	`49`	`+ AST const& _ast,`
`51`	`50`	`bool _disableExternalCalls,`
`52`	`51`	`bool _disableMemoryTrace`
`53`	`52`	`)`
`54`	`53`	`{`
`55`	`54`	`Scope scope;`
`56`		`- InspectedInterpreter{_inspector, _state, _dialect, scope, _disableExternalCalls, _disableMemoryTrace}(_ast);`
	`55`	`+ InspectedInterpreter{_inspector, _state, _ast.dialect(), scope, _disableExternalCalls, _disableMemoryTrace}(_ast.root());`
`57`	`56`	`}`
`58`	`57`
`59`		`-Inspector::NodeAction Inspector::queryUser(langutil::DebugData const& _data, std::map<YulString, u256> const& _variables)`
	`58`	`+Inspector::NodeAction Inspector::queryUser(langutil::DebugData const& _data, std::map<YulName, u256> const& _variables)`
`60`	`59`	`{`
`61`	`60`	`if (m_stepMode == NodeAction::RunNode)`
`62`	`61`	`{`
`@@ -99,7 +98,7 @@ Inspector::NodeAction Inspector::queryUser(langutil::DebugData const& _data, std`
`99`	`98`	`else if (input == "variables" \|\| input == "v")`
`100`	`99`	`{`
`101`	`100`	`for (auto &&[yulStr, val]: _variables)`
`102`		`- printVariable(yulStr, val);`
	`101`	`+ printVariable(yulStr.str(), val);`
`103`	`102`	`std::cout << std::endl;`
`104`	`103`	`}`
`105`	`104`	`else if (`
`@@ -120,7 +119,7 @@ Inspector::NodeAction Inspector::queryUser(langutil::DebugData const& _data, std`
`120`	`119`	`for (auto &&[yulStr, val]: _variables)`
`121`	`120`	`if (yulStr.str() == varname)`
`122`	`121`	`{`
`123`		`- printVariable(yulStr, val);`
	`122`	`+ printVariable(varname, val);`
`124`	`123`	`found = true;`
`125`	`124`	`break;`
`126`	`125`	`}`
Original file line number	Diff line number	Diff line change
`@@ -109,14 +109,13 @@ void InterpreterState::dumpTraceAndState(std::ostream& _out, bool _disableMemory`
`109`	`109`
`110`	`110`	`void Interpreter::run(`
`111`	`111`	`InterpreterState& _state,`
`112`		`- Dialect const& _dialect,`
`113`		`- Block const& _ast,`
	`112`	`+ AST const& _ast,`
`114`	`113`	`bool _disableExternalCalls,`
`115`	`114`	`bool _disableMemoryTrace`
`116`	`115`	`)`
`117`	`116`	`{`
`118`	`117`	`Scope scope;`
`119`		`- Interpreter{_state, _dialect, scope, _disableExternalCalls, _disableMemoryTrace}(_ast);`
	`118`	`+ Interpreter{_state, _ast.dialect(), scope, _disableExternalCalls, _disableMemoryTrace}(_ast.root());`
`120`	`119`	`}`
`121`	`120`
`122`	`121`	`void Interpreter::operator()(ExpressionStatement const& _expressionStatement)`