Emit the special stdlib builtin types into full dwarf metadata

Author: augusto2112

lib/IRGen/IRGenDebugInfo.cpp

@@ -15,6 +15,7 @@
 //===----------------------------------------------------------------------===//
 
 #include "IRGenDebugInfo.h"
+#include "GenEnum.h"
 #include "GenOpaque.h"
 #include "GenStruct.h"
 #include "GenType.h"
@@ -1525,7 +1526,9 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
                                ? 0
                                : DbgTy.getAlignment().getValue() * SizeOfByte;
     unsigned Encoding = 0;
-    uint32_t NumExtraInhabitants = 0;
+    uint32_t NumExtraInhabitants =
+        DbgTy.getNumExtraInhabitants() ? *DbgTy.getNumExtraInhabitants() : 0;
+
     llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
 
     TypeBase *BaseTy = DbgTy.getType();
@@ -1549,17 +1552,13 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
       Encoding = llvm::dwarf::DW_ATE_unsigned;
       if (auto CompletedDbgTy = CompletedDebugTypeInfo::get(DbgTy))
         SizeInBits = getSizeOfBasicType(*CompletedDbgTy);
-      if (auto DbgTyNumExtraInhabitants = DbgTy.getNumExtraInhabitants())
-        NumExtraInhabitants = *DbgTyNumExtraInhabitants;
       break;
     }
 
     case TypeKind::BuiltinIntegerLiteral: {
       Encoding = llvm::dwarf::DW_ATE_unsigned; // ?
       if (auto CompletedDbgTy = CompletedDebugTypeInfo::get(DbgTy))
         SizeInBits = getSizeOfBasicType(*CompletedDbgTy);
-      if (auto DbgTyNumExtraInhabitants = DbgTy.getNumExtraInhabitants())
-        NumExtraInhabitants = *DbgTyNumExtraInhabitants;
       break;
     }
 
@@ -1568,48 +1567,30 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
       // Assuming that the bitwidth and FloatTy->getFPKind() are identical.
       SizeInBits = FloatTy->getBitWidth();
       Encoding = llvm::dwarf::DW_ATE_float;
-      if (auto DbgTyNumExtraInhabitants = DbgTy.getNumExtraInhabitants())
-        NumExtraInhabitants = *DbgTyNumExtraInhabitants;
       break;
     }
 
-    case TypeKind::BuiltinNativeObject: {
-      unsigned PtrSize = CI.getTargetInfo().getPointerWidth(clang::LangAS::Default);
-      auto PTy = DBuilder.createPointerType(nullptr, PtrSize, 0,
-                                            /* DWARFAddressSpace */ llvm::None,
-                                            MangledName);
-      return DBuilder.createObjectPointerType(PTy);
-    }
-
-    case TypeKind::BuiltinBridgeObject: {
-      unsigned PtrSize = CI.getTargetInfo().getPointerWidth(clang::LangAS::Default);
-      auto PTy = DBuilder.createPointerType(nullptr, PtrSize, 0,
-                                            /* DWARFAddressSpace */ llvm::None,
-                                            MangledName);
-      return DBuilder.createObjectPointerType(PTy);
-    }
-
-    case TypeKind::BuiltinRawPointer: {
-      unsigned PtrSize = CI.getTargetInfo().getPointerWidth(clang::LangAS::Default);
-      return DBuilder.createPointerType(nullptr, PtrSize, 0,
-                                        /* DWARFAddressSpace */ llvm::None,
-                                        MangledName);
-    }
+    case TypeKind::BuiltinNativeObject: 
+    case TypeKind::BuiltinBridgeObject:
+    case TypeKind::BuiltinRawPointer:
+    case TypeKind::BuiltinRawUnsafeContinuation:
+    case TypeKind::BuiltinJob: {
+      unsigned PtrSize =
+          CI.getTargetInfo().getPointerWidth(clang::LangAS::Default);
+      if (Opts.DebugInfoLevel > IRGenDebugInfoLevel::ASTTypes) {
+        Flags |= llvm::DINode::FlagArtificial;
+        llvm::DICompositeType *PTy = DBuilder.createStructType(
+            Scope, MangledName, File, 0, PtrSize, 0, Flags, nullptr, nullptr,
+            llvm::dwarf::DW_LANG_Swift, nullptr, {}, NumExtraInhabitants);
+        return PTy;
 
-    case TypeKind::BuiltinRawUnsafeContinuation: {
-      unsigned PtrSize = CI.getTargetInfo().getPointerWidth(clang::LangAS::Default);
-      return DBuilder.createPointerType(nullptr, PtrSize, 0,
-                                        /* DWARFAddressSpace */ llvm::None,
-                                        MangledName);
-    }
+      }
+      llvm::DIDerivedType *PTy = DBuilder.createPointerType(
+          nullptr, PtrSize, 0,
+          /* DWARFAddressSpace */ llvm::None, MangledName);
 
-    case TypeKind::BuiltinJob: {
-      unsigned PtrSize = CI.getTargetInfo().getPointerWidth(clang::LangAS::Default);
-      return DBuilder.createPointerType(nullptr, PtrSize, 0,
-                                        /* DWARFAddressSpace */ llvm::None,
-                                        MangledName);
+      return DBuilder.createObjectPointerType(PTy);
     }
-
     case TypeKind::BuiltinExecutor: {
       return createDoublePointerSizedStruct(
           Scope, "Builtin.Executor", nullptr, MainFile, 0,
@@ -2033,6 +2014,20 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
   }
 #endif
 
+  /// Emits the special builtin types into the debug info. These types are the
+  /// ones that are unconditionally emitted into the stdlib's metadata and are
+  /// needed to correctly calculate the layout of more complex types built on
+  /// top of them.
+  void createSpecialStlibBuiltinTypes() {
+    if (Opts.DebugInfoLevel <= IRGenDebugInfoLevel::ASTTypes) 
+      return;
+    for (auto BuiltinType: IGM.getSpecialBuiltinTypes()) {
+      auto DbgTy = DebugTypeInfo::getFromTypeInfo(
+          BuiltinType, IGM.getTypeInfoForUnlowered(BuiltinType), IGM, false);
+      DBuilder.retainType(getOrCreateType(DbgTy));
+    }
+  }
+
   llvm::DIType *getOrCreateType(DebugTypeInfo DbgTy) {
     // Is this an empty type?
     if (DbgTy.isNull())
@@ -2079,6 +2074,8 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
       TypeDecl = ND;
       Context = ND->getParent();
       ClangDecl = ND->getClangDecl();
+    } else if (auto BNO = dyn_cast<BuiltinType>(DbgTy.getType())) {
+      Context = BNO->getASTContext().TheBuiltinModule;
     }
     if (ClangDecl) {
       clang::ASTReader &Reader = *CI.getClangInstance().getASTReader();
@@ -2255,6 +2252,7 @@ IRGenDebugInfoImpl::IRGenDebugInfoImpl(const IRGenOptions &Opts,
       }
     OS << '"';
   }
+  createSpecialStlibBuiltinTypes();
 }
 
 void IRGenDebugInfoImpl::finalize() {

test/DebugInfo/BuiltinStdlibTypes.swift

@@ -0,0 +1,28 @@
+// RUN: %target-swift-frontend %s -Onone -emit-ir -gdwarf-types -o - | %FileCheck %s
+
+// File is empty as this test check for the builtin stdlib types that should 
+// always be emitted.
+
+// CHECK: !DICompositeType(tag: DW_TAG_structure_type, name: "$sBoD", 
+// CHECK-SAME: size: 64, num_extra_inhabitants: 2147483647, flags: DIFlagArtificial, 
+// CHECK-SAME: runtimeLang: DW_LANG_Swift)
+
+// CHECK: !DICompositeType(tag: DW_TAG_structure_type, name: "$syXlD", 
+// CHECK-SAME: size: 64,
+
+// CHECK: !DICompositeType(tag: DW_TAG_structure_type, name: "$sBbD", 
+// CHECK-SAME: size: 64, num_extra_inhabitants: 2147483647, flags: DIFlagArtificial, 
+// CHECK-SAME: runtimeLang: DW_LANG_Swift)
+
+// CHECK: !DICompositeType(tag: DW_TAG_structure_type, name: "$sBpD", 
+// CHECK-SAME: size: 64, num_extra_inhabitants: 1, flags: DIFlagArtificial, 
+// CHECK-SAME: runtimeLang: DW_LANG_Swift)
+
+// CHECK: !DICompositeType(tag: DW_TAG_structure_type, name: "$syyXfD", 
+// CHECK-SAME: size: 64, 
+// CHECK-SAME: runtimeLang: DW_LANG_Swift
+
+// CHECK: !DICompositeType(tag: DW_TAG_structure_type, name: "$sypXpD", size: 64,
+// CHECK-SAME: flags: DIFlagArtificial, runtimeLang: DW_LANG_Swift, identifier: "$sypXpD")
+
+