Merge pull request #15712 from ethereum/make-clash-with-yul-builtin-non-fatal

Make name clash with a builtin non-fatal in Yul parser

Author: cameel

Changelog.md

@@ -6,6 +6,7 @@ Language Features:
 Compiler Features:
  * Error Reporting: Errors reported during code generation now point at the location of the contract when more fine-grained location is not available.
  * SMTChecker: Z3 is now a runtime dependency, not a build dependency (except for emscripten build).
+ * Yul Parser: Make name clash with a builtin a non-fatal error.
 
 
 Bugfixes:

libyul/AsmParser.cpp

@@ -755,7 +755,13 @@ YulName Parser::expectAsmIdentifier()
 {
 	YulName name{currentLiteral()};
 	if (currentToken() == Token::Identifier && m_dialect.findBuiltin(name.str()))
-		fatalParserError(5568_error, "Cannot use builtin function name \"" + name.str() + "\" as identifier name.");
+		// Non-fatal. We'll continue and wrongly parse it as an identifier. May lead to some spurious
+		// errors after this point, but likely also much more useful ones.
+		m_errorReporter.parserError(
+			5568_error,
+			currentLocation(),
+			"Cannot use builtin function name \"" + name.str() + "\" as identifier name."
+		);
 	// NOTE: We keep the expectation here to ensure the correct source location for the error above.
 	expectToken(Token::Identifier);
 	return name;

test/libsolidity/syntaxTests/inlineAssembly/basefee_reserved_london.sol

@@ -10,3 +10,4 @@ contract C {
 // EVMVersion: =london
 // ----
 // ParserError 5568: (98-105): Cannot use builtin function name "basefee" as identifier name.
+// ParserError 7104: (137-144): Builtin function "basefee" must be called.

test/libsolidity/syntaxTests/inlineAssembly/blobbasefee_reserved_cancun.sol

@@ -10,3 +10,4 @@ contract C {
 // EVMVersion: >=cancun
 // ----
 // ParserError 5568: (98-109): Cannot use builtin function name "blobbasefee" as identifier name.
+// ParserError 7104: (141-152): Builtin function "blobbasefee" must be called.

test/libsolidity/syntaxTests/inlineAssembly/clash_with_non_reserved_pure_yul_builtin.sol

@@ -0,0 +1,10 @@
+contract C {
+    function f() public pure {
+        // NOTE: memoryguard is a builtin but only in pure Yul, not inline assembly.
+        // NOTE: memoryguard is not a reserved identifier.
+        assembly { function memoryguard() {} }
+        assembly { function f(memoryguard) {} }
+        assembly { function f() -> memoryguard {} }
+        assembly { let memoryguard }
+    }
+}

test/libsolidity/syntaxTests/inlineAssembly/clash_with_reserved_builtin.sol

@@ -0,0 +1,15 @@
+contract C {
+    function f() public view {
+        assembly {
+            // NOTE: All EVM instruction names are reserved identifiers in Yul.
+            // NOTE: We do provide builtins corresponding to these instructions.
+            function add(mstore) -> sstore {}
+            let coinbase
+        }
+    }
+}
+// ----
+// ParserError 5568: (245-248): Cannot use builtin function name "add" as identifier name.
+// ParserError 5568: (249-255): Cannot use builtin function name "mstore" as identifier name.
+// ParserError 5568: (260-266): Cannot use builtin function name "sstore" as identifier name.
+// ParserError 5568: (286-294): Cannot use builtin function name "coinbase" as identifier name.

test/libsolidity/syntaxTests/inlineAssembly/clash_with_reserved_non_builtin.sol

@@ -0,0 +1,15 @@
+contract C {
+    function f() public pure {
+        assembly {
+            // NOTE: All EVM instruction names are reserved identifiers in Yul.
+            // NOTE: We don't provide builtins corresponding to these instructions.
+            function dup1(dup2) -> dup3 {}
+            let dup4
+        }
+    }
+}
+// ----
+// DeclarationError 5017: (239-269): The identifier "dup1" is reserved and can not be used.
+// DeclarationError 5017: (253-257): The identifier "dup2" is reserved and can not be used.
+// DeclarationError 5017: (262-266): The identifier "dup3" is reserved and can not be used.
+// DeclarationError 5017: (286-290): The identifier "dup4" is reserved and can not be used.

test/libsolidity/syntaxTests/inlineAssembly/clash_with_reserved_pure_yul_builtin.sol

@@ -0,0 +1,15 @@
+contract C {
+    function f() public view {
+        assembly {
+            // NOTE: These are builtins but only in pure Yul, not inline assembly.
+            // NOTE: Names of these builtins are also reserved identifiers.
+            function loadimmutable(setimmutable) -> datasize {}
+            let dataoffset
+        }
+    }
+}
+// ----
+// DeclarationError 5017: (234-285): The identifier "loadimmutable" is reserved and can not be used.
+// DeclarationError 5017: (257-269): The identifier "setimmutable" is reserved and can not be used.
+// DeclarationError 5017: (274-282): The identifier "datasize" is reserved and can not be used.
+// DeclarationError 5017: (302-312): The identifier "dataoffset" is reserved and can not be used.

test/libsolidity/syntaxTests/inlineAssembly/difficulty_disallowed_function_pre_paris.sol

@@ -19,3 +19,4 @@ contract C {
 // EVMVersion: <paris
 // ----
 // ParserError 5568: (101-111): Cannot use builtin function name "difficulty" as identifier name.
+// ParserError 7104: (143-153): Builtin function "difficulty" must be called.

test/libsolidity/syntaxTests/inlineAssembly/mcopy_reserved_cancun.sol

@@ -19,3 +19,4 @@ contract C {
 // EVMVersion: >=cancun
 // ----
 // ParserError 5568: (101-106): Cannot use builtin function name "mcopy" as identifier name.
+// ParserError 7104: (134-139): Builtin function "mcopy" must be called.