[CodeView] Emit the correct TypeIndex for std::nullptr_t

[zturner]

Summary

The TypeIndex used by cl.exe is 0x103, which indicates a SimpleTypeMode of NearPointer (note the absence of the bitness, normally pointers use a mode of SimpleTypeMode::NearPointer32 or SimpleTypeMode::NearPointer64) and a SimpleTypeKind of void. So this is basically a void*, but without a specified size, which makes sense given how std::nullptr_t is defined.

Anyway, we were actually not emitting *anything* for this. When we encountered std::nullptr_t in a DIType, we would actually just emit a TypeIndex of 0, which is obviously wrong.

The check for this whether we're looking at std::nullptr_t looks hacky, but apparently this is the "official" way to do this in DWARF.

I had to udpate some tests in LLDB since they now start working after this change (meaning the old test with broken output would start failing)

[rnk]

Looks good, thanks for the fix.

llvm/lib/CodeGen/AsmPrinter/CodeViewDebug.cpp

1518 ↗

(On Diff #172043)

I'd reverse this, so we have a special case for nullptr_t, and then the general case of "unspecified type" gives a type index of zero.

llvm/trunk/include/llvm/DebugInfo/CodeView/TypeIndex.h

public:
   static TypeIndex Void() { return TypeIndex(SimpleTypeKind::Void); }
   static TypeIndex VoidPointer32() {
     return TypeIndex(SimpleTypeKind::Void, SimpleTypeMode::NearPointer32);
   }
   static TypeIndex VoidPointer64() {
     return TypeIndex(SimpleTypeKind::Void, SimpleTypeMode::NearPointer64);
   }
 
+  static TypeIndex NullptrT() {
+    // std::nullptr_t uses the pointer mode that doesn't indicate bit-width,
+    // presumably because std::nullptr_t is intended to be compatible with any
+    // pointer type.
+    return TypeIndex(SimpleTypeKind::Void, SimpleTypeMode::NearPointer);
+  }
+
   static TypeIndex SignedCharacter() {
     return TypeIndex(SimpleTypeKind::SignedCharacter);
   }
   static TypeIndex UnsignedCharacter() {
     return TypeIndex(SimpleTypeKind::UnsignedCharacter);
   }
   static TypeIndex NarrowCharacter() {
     return TypeIndex(SimpleTypeKind::NarrowCharacter);

llvm/trunk/lib/CodeGen/AsmPrinter/CodeViewDebug.cpp

TypeIndex CodeViewDebug::lowerType(const DIType *Ty, const DIType *ClassTy) {
   case dwarf::DW_TAG_enumeration_type:
     return lowerTypeEnum(cast<DICompositeType>(Ty));
   case dwarf::DW_TAG_class_type:
   case dwarf::DW_TAG_structure_type:
     return lowerTypeClass(cast<DICompositeType>(Ty));
   case dwarf::DW_TAG_union_type:
     return lowerTypeUnion(cast<DICompositeType>(Ty));
   case dwarf::DW_TAG_unspecified_type:
+    if (Ty->getName() == "decltype(nullptr)")
+      return TypeIndex::NullptrT();
     return TypeIndex::None();
   default:
     // Use the null type index.
     return TypeIndex();
   }
 }
 
 TypeIndex CodeViewDebug::lowerTypeAlias(const DIDerivedType *Ty) {

llvm/trunk/lib/DebugInfo/CodeView/TypeIndex.cpp

 } // namespace
 
 StringRef TypeIndex::simpleTypeName(TypeIndex TI) {
   assert(TI.isNoneType() || TI.isSimple());
 
   if (TI.isNoneType())
     return "<no type>";
 
+  if (TI == TypeIndex::NullptrT())
+    return "std::nullptr_t";
+
   // This is a simple type.
   for (const auto &SimpleTypeName : SimpleTypeNames) {
     if (SimpleTypeName.Kind == TI.getSimpleKind()) {
       if (TI.getSimpleMode() == SimpleTypeMode::Direct)
         return SimpleTypeName.Name.drop_back(1);
       // Otherwise, this is a pointer type. We gloss over the distinction
       // between near, far, 64, 32, etc, and just give a pointer type.
       return SimpleTypeName.Name;

llvm/trunk/test/DebugInfo/COFF/types-std-nullptr-t.ll

+; RUN: llc < %s -filetype=obj | llvm-readobj - -codeview | FileCheck %s
+
+; C++ source to regenerate:
+; $ cat foo.cpp
+; decltype(nullptr) NullPtr = nullptr;
+; $ clang hello.cpp -S -emit-llvm -g -gcodeview -o t.ll
+
+; CHECK: CodeViewDebugInfo [
+; CHECK:   Subsection [
+; CHECK:     SubSectionType: Symbols (0xF1)
+; CHECK:     GlobalData {
+; CHECK:       Kind: S_GDATA32 (0x110D)
+; CHECK:       DataOffset: ?NullPtr@@3$$TA+0x0
+; CHECK:       Type: std::nullptr_t (0x103)
+; CHECK:       DisplayName: NullPtr
+; CHECK:       LinkageName: ?NullPtr@@3$$TA
+; CHECK:     }
+
+
+; ModuleID = 'foo.cpp'
+source_filename = "foo.cpp"
+target datalayout = "e-m:w-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-pc-windows-msvc19.15.26730"
+
+@"?NullPtr@@3$$TA" = dso_local global i8* null, align 8, !dbg !0
+
+!llvm.dbg.cu = !{!2}
+!llvm.module.flags = !{!7, !8, !9, !10}
+!llvm.ident = !{!11}
+
+!0 = !DIGlobalVariableExpression(var: !1, expr: !DIExpression())
+!1 = distinct !DIGlobalVariable(name: "NullPtr", linkageName: "?NullPtr@@3$$TA", scope: !2, file: !3, line: 1, type: !6, isLocal: false, isDefinition: true)
+!2 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, file: !3, producer: "clang version 8.0.0 ", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, enums: !4, globals: !5, nameTableKind: None)
+!3 = !DIFile(filename: "foo.cpp", directory: "D:\5Csrc\5Cllvmbuild\5Ccl\5CDebug\5Cx64", checksumkind: CSK_MD5, checksum: "0d5c7c9860a17e584808c03a24a135e6")
+!4 = !{}
+!5 = !{!0}
+!6 = !DIBasicType(tag: DW_TAG_unspecified_type, name: "decltype(nullptr)")
+!7 = !{i32 2, !"CodeView", i32 1}
+!8 = !{i32 2, !"Debug Info Version", i32 3}
+!9 = !{i32 1, !"wchar_size", i32 2}
+!10 = !{i32 7, !"PIC Level", i32 2}
+!11 = !{!"clang version 8.0.0 "}