Merge pull request #27704 from apple/fix_memory_offset_of_tail_allocated_c_array

IRGen: Fix MemoryLayout::offset(of:) for tail allocated C arrays

Author: aschwaighofer

lib/IRGen/GenHeap.cpp

@@ -317,6 +317,7 @@ HeapNonFixedOffsets::HeapNonFixedOffsets(IRGenFunction &IGF,
                                     elt.getType().getAlignmentMask(IGF, eltTy));
         LLVM_FALLTHROUGH;
       case ElementLayout::Kind::Empty:
+      case ElementLayout::Kind::EmptyTailAllocatedCType:
       case ElementLayout::Kind::Fixed:
         // Don't need to dynamically calculate this offset.
         Offsets.push_back(nullptr);

lib/IRGen/GenStruct.cpp

@@ -185,6 +185,7 @@ namespace {
       switch (fieldInfo.getKind()) {
       case ElementLayout::Kind::Fixed:
       case ElementLayout::Kind::Empty:
+      case ElementLayout::Kind::EmptyTailAllocatedCType:
         return MemberAccessStrategy::getDirectFixed(
                                                fieldInfo.getFixedByteOffset());
       case ElementLayout::Kind::InitialNonFixedSize:
@@ -278,6 +279,7 @@ namespace {
           break;
         }
         case ElementLayout::Kind::Empty:
+        case ElementLayout::Kind::EmptyTailAllocatedCType:
         case ElementLayout::Kind::InitialNonFixedSize:
         case ElementLayout::Kind::NonFixed:
           continue;
@@ -789,7 +791,8 @@ class ClangRecordLowering {
     ElementLayout layout = ElementLayout::getIncomplete(fieldType);
     auto isEmpty = fieldType.isKnownEmpty(ResilienceExpansion::Maximal);
     if (isEmpty)
-      layout.completeEmpty(fieldType.isPOD(ResilienceExpansion::Maximal));
+      layout.completeEmptyTailAllocatedCType(
+          fieldType.isPOD(ResilienceExpansion::Maximal), NextOffset);
     else
       layout.completeFixed(fieldType.isPOD(ResilienceExpansion::Maximal),
                            NextOffset, LLVMFields.size());

lib/IRGen/GenTuple.cpp

@@ -149,6 +149,7 @@ namespace {
       const TupleFieldInfo &field = asImpl().getFields()[fieldNo];
       switch (field.getKind()) {
       case ElementLayout::Kind::Empty:
+      case ElementLayout::Kind::EmptyTailAllocatedCType:
       case ElementLayout::Kind::Fixed:
         return field.getFixedByteOffset();
       case ElementLayout::Kind::InitialNonFixedSize:
@@ -194,6 +195,7 @@ namespace {
         }
 
         case ElementLayout::Kind::Empty:
+        case ElementLayout::Kind::EmptyTailAllocatedCType:
         case ElementLayout::Kind::InitialNonFixedSize:
         case ElementLayout::Kind::NonFixed:
           continue;

lib/IRGen/StructLayout.cpp

@@ -156,6 +156,7 @@ Address ElementLayout::project(IRGenFunction &IGF, Address baseAddr,
                                const llvm::Twine &suffix) const {
   switch (getKind()) {
   case Kind::Empty:
+  case Kind::EmptyTailAllocatedCType:
     return getType().getUndefAddress();
 
   case Kind::Fixed:

lib/IRGen/StructLayout.h

@@ -84,6 +84,11 @@ class ElementLayout {
     /// Its offset in the aggregate is always statically zero.
     Empty,
 
+    /// The element is known to require no storage in the aggregate.
+    /// But it has an offset in the aggregate. This is to support getting the
+    /// offset of tail allocated storage using MemoryLayout<>.offset(of:).
+    EmptyTailAllocatedCType,
+
     /// The element can be positioned at a fixed offset within the
     /// aggregate.
     Fixed,
@@ -163,6 +168,15 @@ class ElementLayout {
     assert(getByteOffset() == byteOffset);
   }
 
+  void completeEmptyTailAllocatedCType(IsPOD_t isPOD, Size byteOffset) {
+    TheKind = unsigned(Kind::EmptyTailAllocatedCType);
+    IsPOD = unsigned(isPOD);
+    ByteOffset = byteOffset.getValue();
+    Index = 0;
+
+    assert(getByteOffset() == byteOffset);
+  }
+
   /// Complete this element layout with a non-fixed offset.
   ///
   /// \param nonFixedElementIndex - the index into the elements array
@@ -181,7 +195,8 @@ class ElementLayout {
 
   /// Is this element known to be empty?
   bool isEmpty() const {
-    return getKind() == Kind::Empty;
+    return getKind() == Kind::Empty ||
+           getKind() == Kind::EmptyTailAllocatedCType;
   }
 
   /// Is this element known to be POD?
@@ -194,6 +209,7 @@ class ElementLayout {
   bool hasByteOffset() const {
     switch (getKind()) {
     case Kind::Empty:
+    case Kind::EmptyTailAllocatedCType:
     case Kind::Fixed:
       return true;
 

test/IRGen/Inputs/tail_allocated_c_array.h

@@ -0,0 +1,7 @@
+#include <stdint.h>
+
+typedef struct foo {
+  uint8_t a;
+  uint16_t b;
+  uint8_t  tailallocatedarray[0];
+} foo;

test/IRGen/tail_allocated_c_array.swift

@@ -0,0 +1,6 @@
+// RUN: %target-swift-frontend -import-objc-header  %S/Inputs/tail_allocated_c_array.h -primary-file %s -emit-ir -o - | %FileCheck %s
+
+// 25165828 = 0x1800004 The bottom bits designate the offset = 4
+// CHECK: @keypath = private global <{{.*}}i32 0, i32 -2147483644, i32 25165828 }>
+
+_ = MemoryLayout<foo>.offset(of: \foo.tailallocatedarray)!

test/stdlib/Inputs/tail_allocated_c_array.h

@@ -0,0 +1,7 @@
+#include <stdint.h>
+
+typedef struct foo {
+  uint8_t a;
+  uint16_t b;
+  uint8_t  tailallocatedarray[0];
+} foo;

test/stdlib/KeyPath.swift

@@ -1,5 +1,5 @@
 // RUN: %empty-directory(%t)
-// RUN: %target-build-swift -swift-version 5 -g %s -o %t/a.out
+// RUN: %target-build-swift -import-objc-header %S/Inputs/tail_allocated_c_array.h -swift-version 5 -g %s -o %t/a.out
 // RUN: %target-codesign %t/a.out
 // RUN: %target-run %t/a.out
 // REQUIRES: executable_test
@@ -1019,5 +1019,10 @@ keyPath.test("nested generics") {
   expectTrue(nestedKeyPath is KeyPath<DictType, DictType.Values>)
 }
 
+keyPath.test("tail allocated c array") {
+  let offset = MemoryLayout<foo>.offset(of: \foo.tailallocatedarray)!
+  expectEqual(4, offset)
+}
+
 runAllTests()