Escape object/data names in Yul serializer (#16517)

Author: msooseth

Changelog.md

@@ -13,6 +13,7 @@ Compiler Features:
 * Yul Optimizer: Improve performance of control flow side effects collector and function references resolver.
 
 Bugfixes:
+* Yul: Fix incorrect serialization of Yul object names containing double quotes and escape sequences, producing output that could not be parsed as valid Yul.
 * Yul EVM Code Transform: Improve stack shuffler performance by fixing a BFS deduplication issue.
 
 

libyul/Object.cpp

@@ -40,7 +40,7 @@ using namespace solidity::yul;
 
 std::string Data::toString(DebugInfoSelection const&, CharStreamProvider const*) const
 {
-	return "data \"" + name + "\" hex\"" + util::toHex(data) + "\"";
+	return "data " + util::escapeAndQuoteString(name) + " hex\"" + util::toHex(data) + "\"";
 }
 
 std::string Object::toString(
@@ -64,7 +64,7 @@ std::string Object::toString(
 
 	return
 		debugData->formatUseSrcComment() +
-		"object \"" + name + "\" {\n" +
+		"object " + util::escapeAndQuoteString(name) + " {\n" +
 		indent(inner) + "\n" +
 		"}";
 }

test/libyul/yulSyntaxTests/objects/data_name_with_literal_newline.yul

@@ -0,0 +1,9 @@
+object "A" {
+  code {
+    sstore(0, datasize("B\nC"))
+  }
+  data "B
+C" hex"1234"
+}
+// ----
+// ParserError 2314: (65-67): Expected 'StringLiteral' but got 'ILLEGAL'

test/libyul/yulSyntaxTests/objects/data_name_with_special_chars.yul

@@ -0,0 +1,7 @@
+object "a" {
+  code {
+    pop(datasize("my\"data"))
+  }
+  data "my\"data" hex"deadbeef"
+}
+// ----

test/libyul/yulSyntaxTests/objects/object_name_with_all_special_chars.yul

@@ -0,0 +1,7 @@
+object "outer" {
+  code {
+    pop(datasize("a\\b\"c\nd\re\tf\x01g"))
+  }
+  data "a\\b\"c\nd\re\tf\x01g" hex"deadbeef"
+}
+// ----

test/libyul/yulSyntaxTests/objects/object_name_with_special_chars.yul

@@ -0,0 +1,4 @@
+object "3\"{code{}}e0003" {
+  code { {} }
+}
+// ----