Fix shift in Yul AST native src locations due to code snippets in debug info

Changelog.md

@@ -9,6 +9,8 @@ Compiler Features:
 
 Bugfixes:
  * SMTChecker: Fix SMT logic error when assigning to an array of addresses.
+ * Yul AST: Fix shifted native source locations when debug info selection included code snippets.
+
 
 ### 0.8.27 (2024-09-04)
 

libsolidity/codegen/ir/IRGenerator.cpp

@@ -30,7 +30,7 @@
 #include <libsolidity/codegen/ABIFunctions.h>
 #include <libsolidity/codegen/CompilerUtils.h>
 
-#include <libyul/YulStack.h>
+#include <libyul/Object.h>
 #include <libyul/Utilities.h>
 
 #include <libsolutil/Algorithms.h>

libsolidity/experimental/codegen/IRGenerator.cpp

@@ -27,7 +27,6 @@
 
 #include <libsolidity/experimental/ast/TypeSystemHelper.h>
 
-#include <libyul/YulStack.h>
 #include <libyul/AsmPrinter.h>
 #include <libyul/AST.h>
 #include <libyul/optimiser/ASTCopier.h>

libsolidity/experimental/codegen/IRGeneratorForStatements.cpp

@@ -25,9 +25,9 @@
 
 #include <libsolidity/experimental/ast/TypeSystemHelper.h>
 
-#include <libyul/YulStack.h>
 #include <libyul/AsmPrinter.h>
 #include <libyul/AST.h>
+#include <libyul/backends/evm/EVMDialect.h>
 #include <libyul/optimiser/ASTCopier.h>
 
 #include <libsolidity/experimental/codegen/Common.h>

libsolidity/interface/CompilerStack.cpp

@@ -1522,6 +1522,7 @@ void CompilerStack::generateIR(ContractDefinition const& _contract, bool _unopti
 		YulStack::Language::StrictAssembly,
 		m_optimiserSettings,
 		m_debugInfoSelection,
+		this, // _soliditySourceProvider
 		m_objectOptimizer
 	);
 	bool yulAnalysisSuccessful = stack.parseAndAnalyze("", compiledContract.yulIR);
@@ -1537,7 +1538,7 @@ void CompilerStack::generateIR(ContractDefinition const& _contract, bool _unopti
 	if (!_unoptimizedOnly)
 	{
 		stack.optimize();
-		compiledContract.yulIROptimized = stack.print(this);
+		compiledContract.yulIROptimized = stack.print();
 		compiledContract.yulIROptimizedAst = stack.astJson();
 	}
 }
@@ -1561,6 +1562,7 @@ void CompilerStack::generateEVMFromIR(ContractDefinition const& _contract)
 		yul::YulStack::Language::StrictAssembly,
 		m_optimiserSettings,
 		m_debugInfoSelection,
+		this, // _soliditySourceProvider
 		m_objectOptimizer
 	);
 	bool analysisSuccessful = stack.parseAndAnalyze("", compiledContract.yulIROptimized);

libyul/YulStack.cpp

@@ -211,12 +211,20 @@ void YulStack::reparse()
 	yulAssert(m_parserResult);
 	yulAssert(m_charStream);
 
-	// NOTE: Without passing in _soliditySourceProvider, printed debug info will not include code
-	// snippets, but it does not matter - we'll still get the same AST after we parse it. Snippets
-	// are not stored in the AST and the other info that is (location, AST ID, etc) will still be present.
-	std::string source = print(nullptr /* _soliditySourceProvider */);
-
-	YulStack cleanStack(m_evmVersion, m_eofVersion, m_language, m_optimiserSettings, m_debugInfoSelection, m_objectOptimizer);
+	// NOTE: it is important for the source printed here to exactly match what the compiler will
+	// eventually output to the user. In particular, debug info must be exactly the same.
+	// Otherwise source locations will be off.
+	std::string source = print();
+
+	YulStack cleanStack(
+		m_evmVersion,
+		m_eofVersion,
+		m_language,
+		m_optimiserSettings,
+		m_debugInfoSelection,
+		m_soliditySourceProvider,
+		m_objectOptimizer
+	);
 	bool reanalysisSuccessful = cleanStack.parseAndAnalyze(m_charStream->name(), source);
 	yulAssert(
 		reanalysisSuccessful,
@@ -348,16 +356,14 @@ YulStack::assembleEVMWithDeployed(std::optional<std::string_view> _deployName)
 	return {std::make_shared<evmasm::Assembly>(assembly), {}};
 }
 
-std::string YulStack::print(
-	CharStreamProvider const* _soliditySourceProvider
-) const
+std::string YulStack::print() const
 {
 	yulAssert(m_stackState >= Parsed);
 	yulAssert(m_parserResult, "");
 	yulAssert(m_parserResult->hasCode(), "");
 	return m_parserResult->toString(
 		m_debugInfoSelection,
-		_soliditySourceProvider
+		m_soliditySourceProvider
 	) + "\n";
 }
 

libyul/YulStack.h

@@ -90,13 +90,15 @@ class YulStack: public langutil::CharStreamProvider
 		Language _language,
 		solidity::frontend::OptimiserSettings _optimiserSettings,
 		langutil::DebugInfoSelection const& _debugInfoSelection,
+		langutil::CharStreamProvider const* _soliditySourceProvider = nullptr,
 		std::shared_ptr<ObjectOptimizer> _objectOptimizer = nullptr
 	):
 		m_language(_language),
 		m_evmVersion(_evmVersion),
 		m_eofVersion(_eofVersion),
 		m_optimiserSettings(std::move(_optimiserSettings)),
 		m_debugInfoSelection(_debugInfoSelection),
+		m_soliditySourceProvider(_soliditySourceProvider),
 		m_errorReporter(m_errors),
 		m_objectOptimizer(_objectOptimizer ? std::move(_objectOptimizer) : std::make_shared<ObjectOptimizer>())
 	{}
@@ -137,9 +139,7 @@ class YulStack: public langutil::CharStreamProvider
 	bool hasErrors() const { return m_errorReporter.hasErrors(); }
 
 	/// Pretty-print the input after having parsed it.
-	std::string print(
-		langutil::CharStreamProvider const* _soliditySourceProvider = nullptr
-	) const;
+	std::string print() const;
 	Json astJson() const;
 
 	// return the JSON representation of the YuL CFG (experimental)
@@ -172,6 +172,11 @@ class YulStack: public langutil::CharStreamProvider
 	solidity::frontend::OptimiserSettings m_optimiserSettings;
 	langutil::DebugInfoSelection m_debugInfoSelection{};
 
+	/// Provider of the Solidity sources that the Yul code was generated from.
+	/// Necessary when code snippets are requested as a part of debug info. When null, code snippets are omitted.
+	/// NOTE: Not owned by YulStack, the user must ensure that it is not destroyed before the stack is.
+	langutil::CharStreamProvider const* m_soliditySourceProvider{};
+
 	std::unique_ptr<langutil::CharStream> m_charStream;
 
 	State m_stackState = Empty;