[Codeview] Add a class for LF_UDT_MOD_SRC_LINE.

[ruiu]

Summary

I'm going to use this class for the visitor to verify
TPI hash records.

[ruiu]

• Added UdtModSourceLineRecord class.

[zturner]

Since a class is added, you will need to update TypeRecords.def and change this line:

CV_TYPE(LF_UDT_MOD_SRC_LINE, 0x1607)

to this:

TYPE_RECORD(LF_UDT_MOD_SRC_LINE, 0x1607, UdtModSourceLine)

Then you can add the following method to TypeDumper.cpp

void CVTypeDumper::visitUdtModSourceLine(TypeLeafKind Leaf,
                                          UdtModSourceLineRecord &SrcLine) {
}

You can do this now or in a subsequent patch if you like.

[zturner]

Ahh I see you made that change already. Does the test still pass with this? If it was previously dumping a record that had an LF_UDT_MOD_SRC_LINE, then the format will be different now.

[ruiu]

• Updated the test.

[zturner]

lgtm

include/llvm/DebugInfo/CodeView/TypeRecord.h

struct Layout {
     ulittle32_t LineNumber;
   };
 
   TypeIndex UDT;
   TypeIndex SourceFile;
   uint32_t LineNumber;
 };
 
+// LF_UDT_MOD_SRC_LINE
+class UdtModSourceLineRecord : public TypeRecord {
+public:
+  UdtModSourceLineRecord(TypeIndex UDT, TypeIndex SourceFile,
+                         uint32_t LineNumber, uint16_t Module)
+      : TypeRecord(TypeRecordKind::UdtSourceLine), UDT(UDT),
+        SourceFile(SourceFile), LineNumber(LineNumber), Module(Module) {}
+
+  bool remapTypeIndices(ArrayRef<TypeIndex> IndexMap);
+
+  static ErrorOr<UdtModSourceLineRecord> deserialize(TypeRecordKind Kind,
+                                                     ArrayRef<uint8_t> &Data) {
+    const Layout *L = nullptr;
+    CV_DESERIALIZE(Data, L);
+
+    return UdtModSourceLineRecord(L->UDT, L->SourceFile, L->LineNumber,
+                                  L->Module);
+  }
+
+  TypeIndex getUDT() const { return UDT; }
+  TypeIndex getSourceFile() const { return SourceFile; }
+  uint32_t getLineNumber() const { return LineNumber; }
+  uint16_t getModule() const { return Module; }
+
+private:
+  struct Layout {
+    TypeIndex UDT;        // The user-defined type
+    TypeIndex SourceFile; // StringID containing the source filename
+    ulittle32_t LineNumber;
+    ulittle16_t Module; // Module that contributes this UDT definition
+  };
+
+  TypeIndex UDT;
+  TypeIndex SourceFile;
+  uint32_t LineNumber;
+  uint16_t Module;
+};
+
 // LF_BUILDINFO
 class BuildInfoRecord : public TypeRecord {
 public:
   BuildInfoRecord(ArrayRef<TypeIndex> ArgIndices)
       : TypeRecord(TypeRecordKind::BuildInfo),
         ArgIndices(ArgIndices.begin(), ArgIndices.end()) {}
 
   /// Rewrite member type indices with IndexMap. Returns false if a type index

include/llvm/DebugInfo/CodeView/TypeRecords.def

 TYPE_RECORD(LF_FUNC_ID, 0x1601, FuncId)
 TYPE_RECORD(LF_MFUNC_ID, 0x1602, MemberFuncId)
 TYPE_RECORD(LF_BUILDINFO, 0x1603, BuildInfo)
 // FIXME: We reuse the structure of ArgListRecord for substring lists, but it
 // makes for confusing dumper output.
 TYPE_RECORD_ALIAS(LF_SUBSTR_LIST, 0x1604, StringList, ArgList)
 TYPE_RECORD(LF_STRING_ID, 0x1605, StringId)
 TYPE_RECORD(LF_UDT_SRC_LINE, 0x1606, UdtSourceLine)
+TYPE_RECORD(LF_UDT_MOD_SRC_LINE, 0x1607, UdtModSourceLine)
 
 TYPE_RECORD(LF_METHODLIST, 0x1206, MethodOverloadList)
 
 
 // 16 bit type records.
 CV_TYPE(LF_MODIFIER_16t, 0x0001)
 CV_TYPE(LF_POINTER_16t, 0x0002)
 CV_TYPE(LF_ARRAY_16t, 0x0003)

 CV_TYPE(LF_MEMBERMODIFY, 0x1513)
 CV_TYPE(LF_MANAGED, 0x1514)
 CV_TYPE(LF_STRIDED_ARRAY, 0x1516)
 CV_TYPE(LF_HLSL, 0x1517)
 CV_TYPE(LF_MODIFIER_EX, 0x1518)
 CV_TYPE(LF_VECTOR, 0x151b)
 CV_TYPE(LF_MATRIX, 0x151c)
 
-// ID leaf records. Subsequent leaf types may be referenced from .debug$S.
-
-CV_TYPE(LF_UDT_MOD_SRC_LINE, 0x1607)
-
 // Numeric leaf types. These are generally contained in other records, and not
 // encountered in the main type stream.
 
 CV_TYPE(LF_NUMERIC, 0x8000)
 CV_TYPE(LF_CHAR, 0x8000)
 CV_TYPE(LF_SHORT, 0x8001)
 CV_TYPE(LF_USHORT, 0x8002)
 CV_TYPE(LF_LONG, 0x8003)

include/llvm/DebugInfo/CodeView/TypeTableBuilder.h

public:
   TypeIndex writeClass(const ClassRecord &Record);
   TypeIndex writeUnion(const UnionRecord &Record);
   TypeIndex writeEnum(const EnumRecord &Record);
   TypeIndex writeBitField(const BitFieldRecord &Record);
   TypeIndex writeVFTableShape(const VFTableShapeRecord &Record);
   TypeIndex writeStringId(const StringIdRecord &Record);
   TypeIndex writeVFTable(const VFTableRecord &Record);
   TypeIndex writeUdtSourceLine(const UdtSourceLineRecord &Record);
+  TypeIndex writeUdtModSourceLine(const UdtModSourceLineRecord &Record);
   TypeIndex writeFuncId(const FuncIdRecord &Record);
   TypeIndex writeMemberFuncId(const MemberFuncIdRecord &Record);
   TypeIndex writeBuildInfo(const BuildInfoRecord &Record);
   TypeIndex writeMethodOverloadList(const MethodOverloadListRecord &Record);
   TypeIndex writeTypeServer2(const TypeServer2Record &Record);
 
   TypeIndex writeFieldList(FieldListRecordBuilder &FieldList);
 
   TypeIndex writeRecord(TypeRecordBuilder &builder);
 
   virtual TypeIndex writeRecord(llvm::StringRef record) = 0;
 };
 }
 }
 
 #endif

lib/DebugInfo/CodeView/TypeDumper.cpp

 
 void CVTypeDumperImpl::visitUdtSourceLine(TypeLeafKind Leaf,
                                           UdtSourceLineRecord &Line) {
   printTypeIndex("UDT", Line.getUDT());
   printTypeIndex("SourceFile", Line.getSourceFile());
   W.printNumber("LineNumber", Line.getLineNumber());
 }
 
+void CVTypeDumperImpl::visitUdtModSourceLine(TypeLeafKind Leaf,
+                                             UdtModSourceLineRecord &Line) {
+  printTypeIndex("UDT", Line.getUDT());
+  printTypeIndex("SourceFile", Line.getSourceFile());
+  W.printNumber("LineNumber", Line.getLineNumber());
+  W.printNumber("Module", Line.getModule());
+}
+
 void CVTypeDumperImpl::visitBuildInfo(TypeLeafKind Leaf,
                                       BuildInfoRecord &Args) {
   W.printNumber("NumArgs", static_cast<uint32_t>(Args.getArgs().size()));
 
   ListScope Arguments(W, "Arguments");
   for (auto Arg : Args.getArgs()) {
     printTypeIndex("ArgType", Arg);
   }

lib/DebugInfo/CodeView/TypeRecord.cpp

 
 bool UdtSourceLineRecord::remapTypeIndices(ArrayRef<TypeIndex> IndexMap) {
   bool Success = true;
   Success &= remapIndex(IndexMap, UDT);
   Success &= remapIndex(IndexMap, SourceFile);
   return Success;
 }
 
+bool UdtModSourceLineRecord::remapTypeIndices(ArrayRef<TypeIndex> IndexMap) {
+  bool Success = true;
+  Success &= remapIndex(IndexMap, UDT);
+  Success &= remapIndex(IndexMap, SourceFile);
+  return Success;
+}
+
 bool BuildInfoRecord::remapTypeIndices(ArrayRef<TypeIndex> IndexMap) {
   bool Success = true;
   for (TypeIndex &Arg : ArgIndices)
     Success &= remapIndex(IndexMap, Arg);
   return Success;
 }
 
 bool VFTableRecord::remapTypeIndices(ArrayRef<TypeIndex> IndexMap) {

lib/DebugInfo/CodeView/TypeTableBuilder.cpp

TypeTableBuilder::writeUdtSourceLine(const UdtSourceLineRecord &Record) {
   TypeRecordBuilder Builder(Record.getKind());
   Builder.writeTypeIndex(Record.getUDT());
   Builder.writeTypeIndex(Record.getSourceFile());
   Builder.writeUInt32(Record.getLineNumber());
   return writeRecord(Builder);
 }
 
 TypeIndex
-TypeTableBuilder::writeFuncId(const FuncIdRecord &Record) {
+TypeTableBuilder::writeUdtModSourceLine(const UdtModSourceLineRecord &Record) {
+  TypeRecordBuilder Builder(Record.getKind());
+  Builder.writeTypeIndex(Record.getUDT());
+  Builder.writeTypeIndex(Record.getSourceFile());
+  Builder.writeUInt32(Record.getLineNumber());
+  Builder.writeUInt16(Record.getModule());
+  return writeRecord(Builder);
+}
+
+TypeIndex TypeTableBuilder::writeFuncId(const FuncIdRecord &Record) {
   TypeRecordBuilder Builder(Record.getKind());
   Builder.writeTypeIndex(Record.getParentScope());
   Builder.writeTypeIndex(Record.getFunctionType());
   Builder.writeNullTerminatedString(Record.getName());
   return writeRecord(Builder);
 }
 
 TypeIndex

test/DebugInfo/PDB/pdbdump-headers.test

 ; EMPTY-NEXT:       Type Index Offsets: [{4096, 0}]
 ; EMPTY-NEXT:       Hash Adjustments: []
 ; EMPTY-NEXT:     }
 ; EMPTY:        Type Info Stream (IPI) {
 ; EMPTY-NEXT:     IPI Version: 20040203
 ; EMPTY-NEXT:     Record count: 15
 ; EMPTY-NEXT:     Records [
 ; EMPTY-NEXT:       {
-; EMPTY-NEXT:         UnknownLeaf (0x104B) {
+; EMPTY-NEXT:         UdtModSourceLine (0x104B) {
 ; EMPTY-NEXT:           TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:           UnknownType {
-; EMPTY-NEXT:             Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:             Length: 16
-; EMPTY-NEXT:           }
+; EMPTY-NEXT:           UDT: __vc_attributes::threadingAttribute (0x100B)
+; EMPTY-NEXT:           SourceFile: <unknown simple type> (0x1)
+; EMPTY-NEXT:           LineNumber: 481
+; EMPTY-NEXT:           Module: 1
 ; EMPTY-NEXT:         }
 ; EMPTY-NEXT:         Bytes (
 ; EMPTY-NEXT:           0000: 0B100000 01000000 E1010000 0100F2F1  |................|
 ; EMPTY-NEXT:         )
 ; EMPTY-NEXT:       }
 ; EMPTY-NEXT:       {
-; EMPTY-NEXT:         UnknownLeaf (0x104C) {
+; EMPTY-NEXT:         UdtModSourceLine (0x104C) {
 ; EMPTY-NEXT:           TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:           UnknownType {
-; EMPTY-NEXT:             Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:             Length: 16
-; EMPTY-NEXT:           }
+; EMPTY-NEXT:           UDT: __vc_attributes::event_receiverAttribute (0x1017)
+; EMPTY-NEXT:           SourceFile: <unknown simple type> (0x1)
+; EMPTY-NEXT:           LineNumber: 194
+; EMPTY-NEXT:           Module: 1
 ; EMPTY-NEXT:         }
 ; EMPTY-NEXT:         Bytes (
 ; EMPTY-NEXT:           0000: 17100000 01000000 C2000000 0100F2F1  |................|
 ; EMPTY-NEXT:         )
 ; EMPTY-NEXT:       }
 ; EMPTY-NEXT:       {
-; EMPTY-NEXT:         UnknownLeaf (0x104D) {
+; EMPTY-NEXT:         UdtModSourceLine (0x104D) {
 ; EMPTY-NEXT:           TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:           UnknownType {
-; EMPTY-NEXT:             Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:             Length: 16
-; EMPTY-NEXT:           }
+; EMPTY-NEXT:           UDT: __vc_attributes::aggregatableAttribute (0x1021)
+; EMPTY-NEXT:           SourceFile: <unknown simple type> (0x1)
+; EMPTY-NEXT:           LineNumber: 603
+; EMPTY-NEXT:           Module: 1
 ; EMPTY-NEXT:         }
 ; EMPTY-NEXT:         Bytes (
 ; EMPTY-NEXT:           0000: 21100000 01000000 5B020000 0100F2F1  |!.......[.......|
 ; EMPTY-NEXT:         )
 ; EMPTY-NEXT:       }
 ; EMPTY-NEXT:       {
-; EMPTY-NEXT:         UnknownLeaf (0x104E) {
+; EMPTY-NEXT:         UdtModSourceLine (0x104E) {
 ; EMPTY-NEXT:           TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:           UnknownType {
-; EMPTY-NEXT:             Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:             Length: 16
-; EMPTY-NEXT:           }
+; EMPTY-NEXT:           UDT: __vc_attributes::event_sourceAttribute (0x102C)
+; EMPTY-NEXT:           SourceFile: <unknown simple type> (0x1)
+; EMPTY-NEXT:           LineNumber: 1200
+; EMPTY-NEXT:           Module: 1
 ; EMPTY-NEXT:         }
 ; EMPTY-NEXT:         Bytes (
 ; EMPTY-NEXT:           0000: 2C100000 01000000 B0040000 0100F2F1  |,...............|
 ; EMPTY-NEXT:         )
 ; EMPTY-NEXT:       }
 ; EMPTY-NEXT:       {
-; EMPTY-NEXT:         UnknownLeaf (0x104F) {
+; EMPTY-NEXT:         UdtModSourceLine (0x104F) {
 ; EMPTY-NEXT:           TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:           UnknownType {
-; EMPTY-NEXT:             Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:             Length: 16
-; EMPTY-NEXT:           }
+; EMPTY-NEXT:           UDT: __vc_attributes::moduleAttribute (0x103A)
+; EMPTY-NEXT:           SourceFile: <unknown simple type> (0x1)
+; EMPTY-NEXT:           LineNumber: 540
+; EMPTY-NEXT:           Module: 1
 ; EMPTY-NEXT:         }
 ; EMPTY-NEXT:         Bytes (
 ; EMPTY-NEXT:           0000: 3A100000 01000000 1C020000 0100F2F1  |:...............|
 ; EMPTY-NEXT:         )
 ; EMPTY-NEXT:       }
 ; EMPTY-NEXT:       {
-; EMPTY-NEXT:         UnknownLeaf (0x1050) {
+; EMPTY-NEXT:         UdtModSourceLine (0x1050) {
 ; EMPTY-NEXT:           TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:           UnknownType {
-; EMPTY-NEXT:             Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; EMPTY-NEXT:             Length: 16
-; EMPTY-NEXT:           }
+; EMPTY-NEXT:           UDT: __vc_attributes::helper_attributes::usageAttribute (0x1042)
+; EMPTY-NEXT:           SourceFile: <unknown simple type> (0x1)
+; EMPTY-NEXT:           LineNumber: 108
+; EMPTY-NEXT:           Module: 1
 ; EMPTY-NEXT:         }
 ; EMPTY-NEXT:         Bytes (
 ; EMPTY-NEXT:           0000: 42100000 01000000 6C000000 0100F2F1  |B.......l.......|
 ; EMPTY-NEXT:         )
 ; EMPTY-NEXT:       }
 ; EMPTY:          Hash {
 ; EMPTY-NEXT:       Number of Hash Buckets: 262143
 ; EMPTY-NEXT:       Hash Key Size: 4

 ; ALL:   Age: 1
 ; ALL:   Guid: {0B355641-86A0-A249-896F-9988FAE52FF0}
 ; ALL: }
 ; ALL: Type Info Stream (IPI) {
 ; ALL:   IPI Version: 20040203
 ; ALL:   Record count: 15
 ; ALL:   Records [
 ; ALL:     {
-; ALL:       UnknownLeaf (0x104B) {
+; ALL:       UdtModSourceLine (0x104B) {
 ; ALL:         TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:         UnknownType {
-; ALL:           Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:           Length: 16
-; ALL:         }
+; ALL:         UDT: __vc_attributes::threadingAttribute (0x100B)
+; ALL:         SourceFile: <unknown simple type> (0x1)
+; ALL:         LineNumber: 481
+; ALL:         Module: 1
 ; ALL:       }
 ; ALL:     }
 ; ALL:     {
-; ALL:       UnknownLeaf (0x104C) {
+; ALL:       UdtModSourceLine (0x104C) {
 ; ALL:         TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:         UnknownType {
-; ALL:           Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:           Length: 16
-; ALL:         }
+; ALL:         UDT: __vc_attributes::event_receiverAttribute (0x1017)
+; ALL:         SourceFile: <unknown simple type> (0x1)
+; ALL:         LineNumber: 194
+; ALL:         Module: 1
 ; ALL:       }
 ; ALL:     }
 ; ALL:     {
-; ALL:       UnknownLeaf (0x104D) {
+; ALL:       UdtModSourceLine (0x104D) {
 ; ALL:         TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:         UnknownType {
-; ALL:           Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:           Length: 16
-; ALL:         }
+; ALL:         UDT: __vc_attributes::aggregatableAttribute (0x1021)
+; ALL:         SourceFile: <unknown simple type> (0x1)
+; ALL:         LineNumber: 603
+; ALL:         Module: 1
 ; ALL:       }
 ; ALL:     }
 ; ALL:     {
-; ALL:       UnknownLeaf (0x104E) {
+; ALL:       UdtModSourceLine (0x104E) {
 ; ALL:         TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:         UnknownType {
-; ALL:           Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:           Length: 16
-; ALL:         }
+; ALL:         UDT: __vc_attributes::event_sourceAttribute (0x102C)
+; ALL:         SourceFile: <unknown simple type> (0x1)
+; ALL:         LineNumber: 1200
+; ALL:         Module: 1
 ; ALL:       }
 ; ALL:     }
 ; ALL:     {
-; ALL:       UnknownLeaf (0x104F) {
+; ALL:       UdtModSourceLine (0x104F) {
 ; ALL:         TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:         UnknownType {
-; ALL:           Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:           Length: 16
-; ALL:         }
+; ALL:         UDT: __vc_attributes::moduleAttribute (0x103A)
+; ALL:         SourceFile: <unknown simple type> (0x1)
+; ALL:         LineNumber: 540
+; ALL:         Module: 1
 ; ALL:       }
 ; ALL:     }
 ; ALL:     {
-; ALL:       UnknownLeaf (0x1050) {
+; ALL:       UdtModSourceLine (0x1050) {
 ; ALL:         TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:         UnknownType {
-; ALL:           Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:           Length: 16
-; ALL:         }
+; ALL:         UDT: __vc_attributes::helper_attributes::usageAttribute (0x1042)
+; ALL:         SourceFile: <unknown simple type> (0x1)
+; ALL:         LineNumber: 108
+; ALL:         Module: 1
 ; ALL:       }
 ; ALL:     }
 ; ALL:     {
-; ALL:       UnknownLeaf (0x1051) {
+; ALL:       UdtModSourceLine (0x1051) {
 ; ALL:         TypeLeafKind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:         UnknownType {
-; ALL:           Kind: LF_UDT_MOD_SRC_LINE (0x1607)
-; ALL:           Length: 16
-; ALL:         }
+; ALL:         UDT: __vc_attributes::helper_attributes::v1_alttypeAttribute (0x104A)
+; ALL:         SourceFile: <unknown simple type> (0x1)
+; ALL:         LineNumber: 96
+; ALL:         Module: 1
 ; ALL:       }
 ; ALL:     }
 ; ALL:     {
 ; ALL:       StringId (0x1052) {
 ; ALL:         TypeLeafKind: LF_STRING_ID (0x1605)
 ; ALL:         Id: 0x0
 ; ALL:         StringData: d:\src\llvm\test\DebugInfo\PDB\Inputs
 ; ALL:       }