Merge pull request #10552 from ethereum/gettersSol2Yul

[Sol->Yul] Implementing getter for struct with bytes member

libsolidity/codegen/YulUtilFunctions.cpp

@@ -2271,8 +2271,25 @@ string YulUtilFunctions::readFromStorage(Type const& _type, size_t _offset, bool
 
 string YulUtilFunctions::readFromStorageDynamic(Type const& _type, bool _splitFunctionTypes)
 {
-	solAssert(_type.isValueType(), "");
+	if (_type.isValueType())
-	return readFromStorageValueType(_type, {}, _splitFunctionTypes);
+		return readFromStorageValueType(_type, {}, _splitFunctionTypes);
+	string functionName =
+		"read_from_storage__dynamic_" +
+		string(_splitFunctionTypes ? "split_" : "") +
+		_type.identifier();
+
+	return m_functionCollector.createFunction(functionName, [&] {
+		return Whiskers(R"(
+			function <functionName>(slot, offset) -> value {
+				if gt(offset, 0) { <panic>() }
+				value := <readFromStorage>(slot)
+			}
+		)")
+		("functionName", functionName)
+		("panic", panicFunction(util::PanicCode::Generic))
+		("readFromStorage", readFromStorageReferenceType(_type))
+		.render();
+	});
 }
 
 string YulUtilFunctions::readFromStorageValueType(Type const& _type, optional<size_t> _offset, bool _splitFunctionTypes)
@@ -2315,7 +2332,15 @@ string YulUtilFunctions::readFromStorageValueType(Type const& _type, optional<si
 
 string YulUtilFunctions::readFromStorageReferenceType(Type const& _type)
 {
-	solUnimplementedAssert(_type.category() == Type::Category::Struct, "");
+	if (auto const* arrayType = dynamic_cast<ArrayType const*>(&_type))
+	{
+		solAssert(arrayType->dataStoredIn(DataLocation::Memory), "");
+		return copyArrayFromStorageToMemoryFunction(
+			dynamic_cast<ArrayType const&>(*arrayType->copyForLocation(DataLocation::Storage, false)),
+			*arrayType
+		);
+	}
+	solAssert(_type.category() == Type::Category::Struct, "");
 
 	string functionName = "read_from_storage_reference_type_" + _type.identifier();
 
@@ -2326,24 +2351,19 @@ string YulUtilFunctions::readFromStorageReferenceType(Type const& _type)
 	for (size_t i = 0; i < structMembers.size(); ++i)
 	{
 		auto const& [memberSlotDiff, memberStorageOffset] = structType.storageOffsetsOfMember(structMembers[i].name);
+		solAssert(structMembers[i].type->isValueType() || memberStorageOffset == 0, "");
 
 		memberSetValues[i]["setMember"] = Whiskers(R"(
 			{
-				let <memberValues> := <readFromStorage>(add(slot, <memberSlotDiff>)<?hasOffset>, <memberStorageOffset></hasOffset>)
+				let <memberValues> := <readFromStorage>(add(slot, <memberSlotDiff>))
 				<writeToMemory>(add(value, <memberMemoryOffset>), <memberValues>)
 			}
 		)")
 		("memberValues", suffixedVariableNameList("memberValue_", 0, structMembers[i].type->stackItems().size()))
 		("memberMemoryOffset", structType.memoryOffsetOfMember(structMembers[i].name).str())
 		("memberSlotDiff",  memberSlotDiff.str())
-		("memberStorageOffset", to_string(memberStorageOffset))
+		("readFromStorage", readFromStorage(*structMembers[i].type, memberStorageOffset, true))
-		("readFromStorage",
-			structMembers[i].type->isValueType() ?
-				readFromStorageDynamic(*structMembers[i].type, true) :
-				readFromStorage(*structMembers[i].type, memberStorageOffset, true)
-		)
 		("writeToMemory", writeToMemoryFunction(*structMembers[i].type))
-		("hasOffset", structMembers[i].type->isValueType())
 		.render();
 	}
 

libsolidity/codegen/ir/IRGenerator.cpp

@@ -511,11 +511,12 @@ string IRGenerator::generateGetter(VariableDeclaration const& _varDecl)
 			{
 				if (returnTypes[i]->category() == Type::Category::Mapping)
 					continue;
-				if (auto arrayType = dynamic_cast<ArrayType const*>(returnTypes[i]))
+				if (
-					if (!arrayType->isByteArray())
+					auto const* arrayType = dynamic_cast<ArrayType const*>(returnTypes[i]);
-						continue;
+					arrayType && !arrayType->isByteArray()
+				)
+					continue;
 
-				// TODO conversion from storage byte arrays is not yet implemented.
 				pair<u256, unsigned> const& offsets = structType->storageOffsetsOfMember(names[i]);
 				vector<string> retVars = IRVariable("ret_" + to_string(returnVariables.size()), *returnTypes[i]).stackSlots();
 				returnVariables += retVars;
@@ -531,9 +532,11 @@ string IRGenerator::generateGetter(VariableDeclaration const& _varDecl)
 		else
 		{
 			solAssert(returnTypes.size() == 1, "");
+			auto const* arrayType = dynamic_cast<ArrayType const*>(returnTypes.front());
+			if (arrayType)
+				solAssert(arrayType->isByteArray(), "");
 			vector<string> retVars = IRVariable("ret", *returnTypes.front()).stackSlots();
 			returnVariables += retVars;
-			// TODO conversion from storage byte arrays is not yet implemented.
 			code += Whiskers(R"(
 				<ret> := <readStorage>(slot, offset)
 			)")

test/libsolidity/semanticTests/array/copying/storage_memory_nested_struct.sol

@@ -2,7 +2,7 @@ contract C {
     struct T { uint8 x; uint8 y; uint[] z; }
     T[3][] a;
 
-    function f() public returns (uint8, uint8, uint, uint, uint, uint8, uint8, uint, uint, uint) {
+    function f() public returns (uint8, uint8, uint, uint8, uint8, uint) {
         a.push();
         a.push();
         a[0][1].x = 11;
@@ -17,10 +17,12 @@ contract C {
         a[1][2].z.push(6);
         T[3][] memory m = a;
         return (
-            m[0][1].x, m[0][1].y, m[0][1].z[0], m[0][1].z[1], m[0][1].z[2],
+            m[0][1].x, m[0][1].y, m[0][1].z[0],
-            m[1][2].x, m[1][2].y, m[1][2].z[0], m[1][2].z[1], m[1][2].z[2]
+            m[1][2].x, m[1][2].y, m[1][2].z[0]
         );
     }
 }
+// ====
+// compileViaYul: also
 // ----
-// f() -> 11, 0x0c, 1, 2, 3, 0x15, 22, 4, 5, 6
+// f() -> 11, 0x0c, 1, 0x15, 22, 4

test/libsolidity/semanticTests/array/indexAccess/inline_array_index_access_strings.sol

@@ -10,6 +10,8 @@ contract C {
     }
 }
 
+// ====
+// compileViaYul: also
 // ----
 // test() ->
 // tester() -> 0x20, 0x3, "abc"

test/libsolidity/semanticTests/array/invalid_encoding_for_storage_byte_array.sol

@@ -23,6 +23,8 @@ contract C {
     function arrayPushEmpty() public { x.push(); }
     function del() public { delete x; }
 }
+// ====
+// compileViaYul: also
 // ----
 // x() -> 0x20, 3, 0x6162630000000000000000000000000000000000000000000000000000000000
 // abiEncode() -> 0x20, 3, 0x6162630000000000000000000000000000000000000000000000000000000000

test/libsolidity/semanticTests/array/string_allocation_bug.sol

@@ -16,5 +16,7 @@ contract Sample {
         p[0] = m;
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // p(uint256): 0x0 -> 0xbbbb, 0xcccc, 0x80, 0xc0, 0x05, "hello", 0x05, "world"

test/libsolidity/semanticTests/array/strings_in_struct.sol

@@ -28,6 +28,8 @@ contract buggystruct {
         return bug.last;
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // getFirst() -> 0x0a
 // getSecond() -> 0x14

test/libsolidity/semanticTests/constructor/bytes_in_constructors_unpacker.sol

@@ -6,6 +6,8 @@ contract Test {
         m_s = s;
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // constructor(): 7, 0x40, 78, "abcdefghijklmnopqrstuvwxyzabcdef", "ghijklmnopqrstuvwxyzabcdefghijkl", "mnopqrstuvwxyz" ->
 // m_x() -> 7

test/libsolidity/semanticTests/fallback/fallback_argument_to_storage.sol

@@ -10,6 +10,7 @@ contract A {
     }
 }
 // ====
+// compileViaYul: also
 // EVMVersion: >=byzantium
 // ----
 // f() -> 0x01, 0x40, 0x00

test/libsolidity/semanticTests/getters/bytes.sol

@@ -0,0 +1,10 @@
+contract C {
+    bytes public b;
+    constructor() {
+        b = "abc";
+    }
+}
+// ====
+// compileViaYul: also
+// ----
+// b() -> 0x20, 0x03, 0x6162630000000000000000000000000000000000000000000000000000000000

test/libsolidity/semanticTests/getters/string_and_bytes.sol

@@ -2,13 +2,17 @@ contract C {
     string public a;
     string public b;
     bytes public c;
+    string public d = "abcd";
     constructor() {
         a = "hello world";
         b = hex"41424344";
         c = hex"ff077fff";
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // a() -> 0x20, 11, "hello world"
 // b() -> 0x20, 4, "ABCD"
 // c() -> 0x20, 4, -439061522557375173052089223601630338202760422010735733633791622124826263552
+// d() -> 0x20, 4, "abcd"

test/libsolidity/semanticTests/getters/struct_with_bytes.sol

@@ -14,5 +14,7 @@ contract C {
         s.d.push(10);
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // s() -> 7, 0x40, 3, 0x6162630000000000000000000000000000000000000000000000000000000000

test/libsolidity/semanticTests/getters/struct_with_bytes_simple.sol

@@ -13,5 +13,7 @@ contract C {
         s.c[0] = 9;
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // s() -> 0x07, 0x40, 0x03, 0x6162630000000000000000000000000000000000000000000000000000000000

test/libsolidity/semanticTests/smoke/fallback.sol

@@ -8,6 +8,8 @@ contract A {
         externalData = msg.data;
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // data() -> 0
 // ()

test/libsolidity/semanticTests/structs/conversion/recursive_storage_memory.sol

@@ -21,5 +21,7 @@ contract CopyTest {
         return (memoryTree.children.length, memoryTree.children[0].children.length, memoryTree.children[1].children.length);
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // run() -> 2, 23, 42

test/libsolidity/semanticTests/structs/conversion/recursive_storage_memory_complex.sol

@@ -46,5 +46,7 @@ contract CopyTest {
         return result;
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // run() -> 0x20, 10, 0x42, 0x4200, 0x420000, 0x420001, 0x420002, 0x4201, 0x420100, 0x420101, 0x420102, 0x420103

test/libsolidity/semanticTests/structs/memory_structs_nested_load.sol

@@ -64,6 +64,8 @@ contract Test {
         a2 = m_x.a[1];
     }
 }
+// ====
+// compileViaYul: also
 // ----
 // load() -> 0x01, 0x02, 0x03, 0x04, 0x05, 0x06
 // store() -> 0x01, 0x02, 0x03, 0x04, 0x05, 0x06

test/libsolidity/semanticTests/structs/memory_structs_read_write.sol

@@ -50,6 +50,8 @@ contract Test {
     }
 }
 
+// ====
+// compileViaYul: also
 // ----
 // testInit() -> 0, 0, 0, 0, true
 // testCopyRead() -> 1, 2, 3, 4

test/libsolidity/semanticTests/variables/public_state_overridding_dynamic_struct.sol

@@ -18,6 +18,8 @@ contract X is A
 }
 
 
+// ====
+// compileViaYul: also
 // ----
 // test() -> 0, 64, 0
 // set() ->

test/libsolidity/semanticTests/variables/public_state_overridding_mapping_to_dynamic_struct.sol

@@ -18,6 +18,8 @@ contract X is A
 }
 
 
+// ====
+// compileViaYul: also
 // ----
 // test(uint256): 0 -> 0, 64, 0
 // test(uint256): 42 -> 0, 64, 0

test/libsolidity/semanticTests/various/address_code.sol

@@ -12,6 +12,8 @@ contract C {
     function g() public view returns (uint) { return address(0).code.length; }
     function h() public view returns (uint) { return address(1).code.length; }
 }
+// ====
+// compileViaYul: also
 // ----
 // constructor() ->
 // initCode() -> 0x20, 0

test/libsolidity/semanticTests/various/skip_dynamic_types_for_structs.sol

@@ -18,5 +18,7 @@ contract C {
     }
 }
 
+// ====
+// compileViaYul: also
 // ----
 // g() -> 2, 6