Merge pull request #15610 from ethereum/fix-code-generation-error-rep…

…orting-in-yul

Fix code generation error reporting in Yul

Changelog.md

@@ -10,6 +10,7 @@ Compiler Features:
 Bugfixes:
 * General: Fix internal compiler error when requesting IR AST outputs for interfaces and abstract contracts.
 * Standard JSON Interface: Fix ``generatedSources`` and ``sourceMap`` being generated internally even when not requested.
+* Yul: Fix internal compiler error when a code generation error should be reported instead.
 
 
 ### 0.8.28 (2024-10-09)

liblangutil/ErrorReporter.cpp

@@ -273,6 +273,23 @@ void ErrorReporter::unimplementedFeatureError(ErrorId _error, SourceLocation con
 	);
 }
 
+void ErrorReporter::codeGenerationError(ErrorId _error, SourceLocation const& _location, std::string const& _description)
+{
+	error(_error, Error::Type::CodeGenerationError, _location, _description);
+}
+
+void ErrorReporter::codeGenerationError(Error const& _error)
+{
+	solAssert(_error.type() == Error::Type::CodeGenerationError);
+	solAssert(_error.comment(), "Errors must include a message for the user.");
+	solUnimplementedAssert(!_error.secondarySourceLocation(), "Secondary locations not supported yet.");
+	codeGenerationError(
+		_error.errorId(),
+		_error.sourceLocation() ?  *_error.sourceLocation() : SourceLocation{},
+		*_error.comment()
+	);
+}
+
 void ErrorReporter::info(
 	ErrorId _error,
 	SourceLocation const& _location,

liblangutil/ErrorReporter.h

@@ -120,6 +120,9 @@ class ErrorReporter
 
 	void unimplementedFeatureError(ErrorId _error, SourceLocation const& _location, std::string const& _description);
 
+	void codeGenerationError(ErrorId _error, SourceLocation const& _location, std::string const& _description);
+	void codeGenerationError(Error const& _error);
+
 	ErrorList const& errors() const;
 
 	void clear();

libsolidity/interface/CompilerStack.cpp

@@ -779,11 +779,7 @@ bool CompilerStack::compile(State _stopAfter)
 					}
 					catch (Error const& _error)
 					{
-						// Since codegen has no access to the error reporter, the only way for it to
-						// report an error is to throw. In most cases it uses dedicated exceptions,
-						// but CodeGenerationError is one case where someone decided to just throw Error.
-						solAssert(_error.type() == Error::Type::CodeGenerationError);
-						m_errorReporter.error(_error.errorId(), _error.type(), SourceLocation(), _error.what());
+						m_errorReporter.codeGenerationError(_error);
 					}
 					catch (UnimplementedFeatureError const& _error)
 					{

libyul/YulStack.cpp

@@ -287,6 +287,11 @@ YulStack::assembleWithDeployed(std::optional<std::string_view> _deployName)
 			);
 		}
 	}
+	catch (Error const& _error)
+	{
+		m_errorReporter.codeGenerationError(_error);
+		return {MachineAssemblyObject{}, MachineAssemblyObject{}};
+	}
 	catch (UnimplementedFeatureError const& _error)
 	{
 		reportUnimplementedFeatureError(_error);
@@ -344,6 +349,11 @@ YulStack::assembleEVMWithDeployed(std::optional<std::string_view> _deployName)
 			return {std::make_shared<evmasm::Assembly>(assembly), std::make_shared<evmasm::Assembly>(runtimeAssembly)};
 		}
 	}
+	catch (Error const& _error)
+	{
+		m_errorReporter.codeGenerationError(_error);
+		return {nullptr, nullptr};
+	}
 	catch (UnimplementedFeatureError const& _error)
 	{
 		reportUnimplementedFeatureError(_error);

libyul/YulStack.h

@@ -25,6 +25,8 @@
 #include <liblangutil/DebugInfoSelection.h>
 #include <liblangutil/ErrorReporter.h>
 #include <liblangutil/EVMVersion.h>
+#include <liblangutil/Exceptions.h>
+
 #include <libsolutil/JSON.h>
 
 #include <libyul/Object.h>

test/cmdlineTests/standard_yul_code_generation_error/args

@@ -0,0 +1 @@
+--allow-paths .

test/cmdlineTests/standard_yul_code_generation_error/in.yul

@@ -0,0 +1,9 @@
+object "C" {
+    code {}
+
+    object "C_deployed" {
+        code {
+            sstore(0, loadimmutable("1"))
+        }
+    }
+}

test/cmdlineTests/standard_yul_code_generation_error/input.json

@@ -0,0 +1,6 @@
+{
+	"language": "Yul",
+	"sources": {
+		"C": {"urls": ["standard_yul_code_generation_error/in.yul"]}
+	}
+}

test/cmdlineTests/standard_yul_code_generation_error/output.json

@@ -0,0 +1,13 @@
+{
+    "errors": [
+        {
+            "component": "general",
+            "formattedMessage": "CodeGenerationError: Some immutables were read from but never assigned, possibly because of optimization.
+
+",
+            "message": "Some immutables were read from but never assigned, possibly because of optimization.",
+            "severity": "error",
+            "type": "CodeGenerationError"
+        }
+    ]
+}

test/cmdlineTests/strict_asm_code_generation_error/args

@@ -0,0 +1 @@
+--strict-assembly --bin

test/cmdlineTests/strict_asm_code_generation_error/err

@@ -0,0 +1 @@
+Error: Some immutables were read from but never assigned, possibly because of optimization.

test/cmdlineTests/strict_asm_code_generation_error/exit

@@ -0,0 +1 @@
+1

test/cmdlineTests/strict_asm_code_generation_error/input.yul

@@ -0,0 +1,9 @@
+object "C" {
+    code {}
+
+    object "C_deployed" {
+        code {
+            sstore(0, loadimmutable("1"))
+        }
+    }
+}