Merge pull request #9007 from a3d4/fix-8727-no-return-optimizer-error

Report an error if immutables not assigned

Changelog.md

@@ -34,6 +34,7 @@ Bugfixes:
  * SMTChecker: Fix internal error when assigning to a 1-tuple.
  * State Mutability: Constant public state variables are considered ``pure`` functions.
  * Type Checker: Fixing deduction issues on function types when function call has named arguments.
+ * Immutables: Fix internal compiler error when immutables are not assigned.
 
 
 ### 0.6.12 (2020-07-22)

libevmasm/Assembly.cpp

@@ -30,6 +30,8 @@
 #include <libevmasm/ConstantOptimiser.h>
 #include <libevmasm/GasMeter.h>
 
+#include <liblangutil/Exceptions.h>
+
 #include <fstream>
 #include <json/json.h>
 
@@ -699,12 +701,10 @@ LinkerObject const& Assembly::assemble() const
 		}
 	}
 
-	assertThrow(
+	if (!immutableReferencesBySub.empty())
-		immutableReferencesBySub.empty(),
+		throw
-		AssemblyException,
+			langutil::Error(1284_error, langutil::Error::Type::CodeGenerationError) <<
-		"Some immutables were read from but never assigned."
+			util::errinfo_comment("Some immutables were read from but never assigned, possibly because of optimization.");
-	);
-
 
 	if (!m_subs.empty() || !m_data.empty() || !m_auxiliaryData.empty())
 		// Append an INVALID here to help tests find miscompilation.

liblangutil/Exceptions.cpp

@@ -33,6 +33,9 @@ Error::Error(ErrorId _errorId, Type _type, SourceLocation const& _location, stri
 {
 	switch (m_type)
 	{
+	case Type::CodeGenerationError:
+		m_typeName = "CodeGenerationError";
+		break;
 	case Type::DeclarationError:
 		m_typeName = "DeclarationError";
 		break;

liblangutil/Exceptions.h

@@ -78,6 +78,7 @@ class Error: virtual public util::Exception
 public:
 	enum class Type
 	{
+		CodeGenerationError,
 		DeclarationError,
 		DocstringParsingError,
 		ParserError,

libsolidity/interface/CompilerStack.cpp

@@ -516,7 +516,17 @@ bool CompilerStack::compile()
 			if (auto contract = dynamic_cast<ContractDefinition const*>(node.get()))
 				if (isRequestedContract(*contract))
 				{
-					compileContract(*contract, otherCompilers);
+					try
+					{
+						compileContract(*contract, otherCompilers);
+					}
+					catch (Error const& _error)
+					{
+						if (_error.type() != Error::Type::CodeGenerationError)
+							throw;
+						m_errorReporter.error(_error.errorId(), _error.type(), SourceLocation(), _error.what());
+						return false;
+					}
 					if (m_generateIR || m_generateEwasm)
 						generateIR(*contract);
 					if (m_generateEwasm)

test/libsolidity/SyntaxTest.cpp

@@ -74,7 +74,19 @@ void SyntaxTest::parseAndAnalyze()
 		try
 		{
 			if (!compiler().compile())
-				BOOST_THROW_EXCEPTION(runtime_error("Compilation failed even though analysis was successful."));
+			{
+				ErrorList const& errors = compiler().errors();
+				auto codeGeneretionErrorCount = count_if(errors.cbegin(), errors.cend(), [](auto const& error) {
+					return error->type() == Error::Type::CodeGenerationError;
+				});
+				auto errorCount = count_if(errors.cbegin(), errors.cend(), [](auto const& error) {
+					return error->type() != Error::Type::Warning;
+				});
+				// failing compilation after successful analysis is a rare case,
+				// it assumes that errors contain exactly one error, and the error is of type Error::Type::CodeGenerationError
+				if (codeGeneretionErrorCount != 1 || errorCount != 1)
+					BOOST_THROW_EXCEPTION(runtime_error("Compilation failed even though analysis was successful."));
+			}
 		}
 		catch (UnimplementedFeatureError const& _e)
 		{

test/libsolidity/syntaxTests/immutable/no_assignments.sol

@@ -0,0 +1,13 @@
+contract C {
+    uint immutable x;
+    constructor() {
+        x = 0;
+        while (true)
+        {}
+    }
+    function f() external view returns(uint) { return x; }
+}
+// ====
+// optimize-yul: true
+// ----
+// CodeGenerationError 1284: Some immutables were read from but never assigned, possibly because of optimization.