[PATCH 63/79] [DebugInfo] Add debug info for bitfield members (#1907)

Signed-off-by: Arvind Sudarsanam <arvind.sudarsanam@intel.com>
Gbp-Pq: Name 0063-DebugInfo-Add-debug-info-for-bitfield-members-1907.patch

diff --git a/lib/SPIRV/LLVMToSPIRVDbgTran.cpp b/lib/SPIRV/LLVMToSPIRVDbgTran.cpp
index 8945daedd5405f442a5defc0fc6f7655ad72a930..3937e18db4b01e04960d3a1e926edf30e2023453 100644 (file)
--- a/lib/SPIRV/LLVMToSPIRVDbgTran.cpp
+++ b/lib/SPIRV/LLVMToSPIRVDbgTran.cpp
@@ -454,7 +454,7 @@ void LLVMToSPIRVDbgTran::transformToConstant(std::vector<SPIRVWord> &Ops,
   }
 }
 
-SPIRVWord mapDebugFlags(DINode::DIFlags DFlags) {
+SPIRVWord LLVMToSPIRVDbgTran::mapDebugFlags(DINode::DIFlags DFlags) {
   SPIRVWord Flags = 0;
   if ((DFlags & DINode::FlagAccessibility) == DINode::FlagPublic)
     Flags |= SPIRVDebug::FlagIsPublic;
@@ -484,10 +484,13 @@ SPIRVWord mapDebugFlags(DINode::DIFlags DFlags) {
     Flags |= SPIRVDebug::FlagTypePassByValue;
   if (DFlags & DINode::FlagTypePassByReference)
     Flags |= SPIRVDebug::FlagTypePassByReference;
+  if (BM->getDebugInfoEIS() == SPIRVEIS_NonSemantic_Shader_DebugInfo_200)
+    if (DFlags & DINode::FlagBitField)
+      Flags |= SPIRVDebug::FlagBitField;
   return Flags;
 }
 
-SPIRVWord transDebugFlags(const DINode *DN) {
+SPIRVWord LLVMToSPIRVDbgTran::transDebugFlags(const DINode *DN) {
   SPIRVWord Flags = 0;
   if (const DIGlobalVariable *GV = dyn_cast<DIGlobalVariable>(DN)) {
     if (GV->isLocalToUnit())

diff --git a/lib/SPIRV/LLVMToSPIRVDbgTran.h b/lib/SPIRV/LLVMToSPIRVDbgTran.h
index fa1e8cf7a2cf3f520ee8738da4daddfa9c4a422d..7738e1ecd8faf80caf736790d20bbdf95cd822a0 100644 (file)
--- a/lib/SPIRV/LLVMToSPIRVDbgTran.h
+++ b/lib/SPIRV/LLVMToSPIRVDbgTran.h
@@ -165,6 +165,10 @@ private:
   // A module in programming language. Example - Fortran module, clang module.
   SPIRVEntry *transDbgModule(const DIModule *IE);
 
+  // Flags
+  SPIRVWord mapDebugFlags(DINode::DIFlags DFlags);
+  SPIRVWord transDebugFlags(const DINode *DN);
+
   SPIRVModule *BM;
   Module *M;
   LLVMToSPIRVBase *SPIRVWriter;

diff --git a/lib/SPIRV/SPIRVToLLVMDbgTran.cpp b/lib/SPIRV/SPIRVToLLVMDbgTran.cpp
index ed61b4f6bed02dc9ba75f859a44a20b1f019c3ac..a50b42266ebda23b6cca0e6e9edb360cc3f5d884 100644 (file)
--- a/lib/SPIRV/SPIRVToLLVMDbgTran.cpp
+++ b/lib/SPIRV/SPIRVToLLVMDbgTran.cpp
@@ -668,7 +668,6 @@ SPIRVToLLVMDbgTran::transTypeMemberOpenCL(const SPIRVExtInst *DebugInst) {
   }
   if (SPIRVFlags & SPIRVDebug::FlagIsStaticMember)
     Flags |= DINode::FlagStaticMember;
-
   if (Flags & DINode::FlagStaticMember && Ops.size() > MinOperandCount) {
     SPIRVValue *ConstVal = BM->get<SPIRVValue>(Ops[ValueIdx]);
     assert(isConstantOpCode(ConstVal->getOpCode()) &&
@@ -716,6 +715,8 @@ SPIRVToLLVMDbgTran::transTypeMemberNonSemantic(const SPIRVExtInst *DebugInst,
   }
   if (SPIRVFlags & SPIRVDebug::FlagIsStaticMember)
     Flags |= DINode::FlagStaticMember;
+  if (SPIRVFlags & SPIRVDebug::FlagBitField)
+    Flags |= DINode::FlagBitField;
 
   if (Flags & DINode::FlagStaticMember && Ops.size() > MinOperandCount) {
     SPIRVValue *ConstVal = BM->get<SPIRVValue>(Ops[ValueIdx]);

diff --git a/lib/SPIRV/libSPIRV/SPIRV.debug.h b/lib/SPIRV/libSPIRV/SPIRV.debug.h
index ff0bb548babc84ee4aefb62de4b935a1efa092f3..f951209d22bb82638361d48075668b5bd9301a49 100644 (file)
--- a/lib/SPIRV/libSPIRV/SPIRV.debug.h
+++ b/lib/SPIRV/libSPIRV/SPIRV.debug.h
@@ -70,26 +70,27 @@ enum Instruction {
 };
 
 enum Flag {
-  FlagIsProtected            = 1 << 0,
-  FlagIsPrivate              = 1 << 1,
-  FlagIsPublic               = FlagIsPrivate | FlagIsProtected,
-  FlagAccess                 = FlagIsPublic,
-  FlagIsLocal                = 1 << 2,
-  FlagIsDefinition           = 1 << 3,
-  FlagIsFwdDecl              = 1 << 4,
-  FlagIsArtificial           = 1 << 5,
-  FlagIsExplicit             = 1 << 6,
-  FlagIsPrototyped           = 1 << 7,
-  FlagIsObjectPointer        = 1 << 8,
-  FlagIsStaticMember         = 1 << 9,
-  FlagIsIndirectVariable     = 1 << 10,
-  FlagIsLValueReference      = 1 << 11,
-  FlagIsRValueReference      = 1 << 12,
-  FlagIsOptimized            = 1 << 13,
-  FlagIsEnumClass            = 1 << 14,
-  FlagTypePassByValue        = 1 << 15,
-  FlagTypePassByReference    = 1 << 16,
-  FlagUnknownPhysicalLayout  = 1 << 17,
+  FlagIsProtected           = 1 << 0,
+  FlagIsPrivate             = 1 << 1,
+  FlagIsPublic              = FlagIsPrivate | FlagIsProtected,
+  FlagAccess                = FlagIsPublic,
+  FlagIsLocal               = 1 << 2,
+  FlagIsDefinition          = 1 << 3,
+  FlagIsFwdDecl             = 1 << 4,
+  FlagIsArtificial          = 1 << 5,
+  FlagIsExplicit            = 1 << 6,
+  FlagIsPrototyped          = 1 << 7,
+  FlagIsObjectPointer       = 1 << 8,
+  FlagIsStaticMember        = 1 << 9,
+  FlagIsIndirectVariable    = 1 << 10,
+  FlagIsLValueReference     = 1 << 11,
+  FlagIsRValueReference     = 1 << 12,
+  FlagIsOptimized           = 1 << 13,
+  FlagIsEnumClass           = 1 << 14,
+  FlagTypePassByValue       = 1 << 15,
+  FlagTypePassByReference   = 1 << 16,
+  FlagUnknownPhysicalLayout = 1 << 17,
+  FlagBitField              = 1 << 18
 };
 
 enum EncodingTag {

diff --git a/test/DebugInfo/bitfields_packed.ll b/test/DebugInfo/bitfields_packed.ll
new file mode 100644 (file)
index 0000000..5446e10
--- /dev/null
+++ b/test/DebugInfo/bitfields_packed.ll
@@ -0,0 +1,142 @@
+; RUN: llvm-as %s -o %t.bc
+; RUN: llvm-spirv --spirv-debug-info-version=ocl-100 %t.bc
+; RUN: llvm-spirv %t.spv -o %t.spt --to-text
+; RUN: FileCheck %s --input-file %t.spt -check-prefixes=CHECK-SPIRV,CHECK-SPIRV-NO-BITFIELD
+; RUN: llvm-spirv -r %t.spv -o %t_1.bc
+; RUN: llvm-dis %t_1.bc -o %t_1.ll
+; RUN: FileCheck %s --input-file %t_1.ll  -check-prefixes=CHECK-LLVM,CHECK-LLVM-NO-BITFIELD
+
+; RUN: llvm-spirv --spirv-ext=+SPV_KHR_non_semantic_info --spirv-debug-info-version=nonsemantic-shader-100 %t.bc
+; RUN: llvm-spirv %t.spv -o %t.spt --to-text
+; RUN: FileCheck %s --input-file %t.spt -check-prefixes=CHECK-SPIRV,CHECK-SPIRV-BITFIELD
+; RUN: llvm-spirv -r %t.spv -o %t_1.bc
+; RUN: llvm-dis %t_1.bc -o %t_1.ll
+; RUN: FileCheck %s --input-file %t_1.ll  -check-prefixes=CHECK-LLVM,CHECK-LLVM-NO-BITFIELD
+
+; RUN: llvm-spirv --spirv-debug-info-version=nonsemantic-shader-200 %t.bc -o %t.spv
+; RUN: llvm-spirv %t.spv -o %t.spt --to-text
+; RUN: FileCheck %s --input-file %t.spt -check-prefixes=CHECK-SPIRV,CHECK-SPIRV-BITFIELD
+; RUN: llvm-spirv -r %t.spv -o %t_1.bc
+; RUN: llvm-dis %t_1.bc -o %t_1.ll
+; RUN: FileCheck %s --input-file %t_1.ll  -check-prefixes=CHECK-LLVM,CHECK-LLVM-BITFIELD
+
+; CHECK-SPIRV: String [[#A:]] "a"
+; CHECK-SPIRV: String [[#B:]] "b"
+; CHECK-SPIRV: String [[#C:]] "c"
+; CHECK-SPIRV: String [[#D:]] "d"
+; CHECK-SPIRV: String [[#E:]] "e"
+; CHECK-SPIRV: String [[#F:]] "f"
+
+; CHECK-SPIRV-DAG: Constant [[#]] [[#THREE:]] 3 {{$}}
+; CHECK-SPIRV-DAG: Constant [[#]] [[#ONE:]] 1 {{$}}
+
+; CHECK-SPIRV-NO-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#A]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#]]
+; CHECK-SPIRV-NO-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#B]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#]]
+; CHECK-SPIRV-NO-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#C]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#]]
+; CHECK-SPIRV-NO-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#D]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#]]
+; CHECK-SPIRV-NO-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#E]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#]]
+; CHECK-SPIRV-NO-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#F]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#]]
+
+; CHECK-SPIRV-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#A]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#THREE]] [[#]]
+; CHECK-SPIRV-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#B]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#THREE]] [[#]]
+; CHECK-SPIRV-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#C]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#THREE]] [[#]]
+; CHECK-SPIRV-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#D]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#THREE]] [[#]]
+; CHECK-SPIRV-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#E]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#THREE]] [[#]]
+; CHECK-SPIRV-BITFIELD: ExtInst [[#]] [[#]] [[#]] DebugTypeMember [[#F]] [[#]] [[#]] [[#]] [[#]] [[#]] [[#ONE]] [[#]]
+
+target datalayout = "e-i64:64-v16:16-v24:32-v32:32-v48:64-v96:128-v192:256-v256:256-v512:512-v1024:1024-n8:16:32:64"
+target triple = "spir64-unknown-unknown"
+
+%struct.struct_bit_fields1 = type { i16 }
+
+@__const._Z3fooii.arr_bf1 = private unnamed_addr addrspace(1) constant [1 x { i8, i8 }] [{ i8, i8 } { i8 -47, i8 8 }], align 2
+
+; Function Attrs: convergent mustprogress noinline norecurse nounwind optnone
+define dso_local spir_func noundef i32 @_Z3fooii(i32 noundef %0, i32 noundef %1) #0 !dbg !10 {
+  %3 = alloca i32, align 4
+  %4 = alloca i32, align 4
+  %5 = alloca i32, align 4
+  %6 = alloca [1 x %struct.struct_bit_fields1], align 2
+  %7 = alloca i32, align 4
+  %8 = addrspacecast i32* %3 to i32 addrspace(4)*
+  %9 = addrspacecast i32* %4 to i32 addrspace(4)*
+  %10 = addrspacecast i32* %5 to i32 addrspace(4)*
+  %11 = addrspacecast [1 x %struct.struct_bit_fields1]* %6 to [1 x %struct.struct_bit_fields1] addrspace(4)*
+  %12 = addrspacecast i32* %7 to i32 addrspace(4)*
+  store i32 %0, i32 addrspace(4)* %9, align 4
+  call void @llvm.dbg.declare(metadata i32* %4, metadata !15, metadata !DIExpression()), !dbg !16
+  store i32 %1, i32 addrspace(4)* %10, align 4
+  call void @llvm.dbg.declare(metadata i32* %5, metadata !17, metadata !DIExpression()), !dbg !18
+  call void @llvm.dbg.declare(metadata [1 x %struct.struct_bit_fields1]* %6, metadata !19, metadata !DIExpression()), !dbg !32
+  %13 = bitcast [1 x %struct.struct_bit_fields1] addrspace(4)* %11 to i8 addrspace(4)*, !dbg !32
+  call void @llvm.memcpy.p4i8.p1i8.i64(i8 addrspace(4)* align 2 %13, i8 addrspace(1)* align 2 getelementptr inbounds ([1 x { i8, i8 }], [1 x { i8, i8 }] addrspace(1)* @__const._Z3fooii.arr_bf1, i32 0, i32 0, i32 0), i64 2, i1 false), !dbg !32
+  call void @llvm.dbg.declare(metadata i32* %7, metadata !33, metadata !DIExpression()), !dbg !34
+  store i32 0, i32 addrspace(4)* %12, align 4, !dbg !34
+  %14 = load i32, i32 addrspace(4)* %12, align 4, !dbg !35
+  ret i32 %14, !dbg !36
+}
+
+; Function Attrs: nocallback nofree nosync nounwind speculatable willreturn memory(none)
+declare void @llvm.dbg.declare(metadata, metadata, metadata) #1
+
+; Function Attrs: nocallback nofree nounwind willreturn memory(argmem: readwrite)
+declare void @llvm.memcpy.p4i8.p1i8.i64(i8 addrspace(4)* noalias nocapture writeonly, i8 addrspace(1)* noalias nocapture readonly, i64, i1 immarg) #2
+
+attributes #0 = { convergent mustprogress noinline norecurse nounwind optnone "approx-func-fp-math"="true" "frame-pointer"="all" "min-legal-vector-width"="0" "no-infs-fp-math"="true" "no-nans-fp-math"="true" "no-signed-zeros-fp-math"="true" "no-trapping-math"="true" "stack-protector-buffer-size"="8" "sycl-module-id"="bitfields-packed.cpp" "unsafe-fp-math"="true" }
+attributes #1 = { nocallback nofree nosync nounwind speculatable willreturn }
+attributes #2 = { nocallback nofree nounwind willreturn }
+
+!llvm.dbg.cu = !{!0}
+!opencl.spir.version = !{!2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2, !2}
+!spirv.Source = !{!3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3, !3}
+!opencl.compiler.options = !{!4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4, !4}
+!llvm.ident = !{!5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5, !5}
+!llvm.module.flags = !{!6, !7, !8, !9}
+
+!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !1, producer: "clang", isOptimized: false, flags: "", runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None)
+!1 = !DIFile(filename: "bitfields-packed.cpp", directory: "/tmp")
+!2 = !{i32 1, i32 2}
+!3 = !{i32 4, i32 100000}
+!4 = !{}
+!5 = !{!"Compiler"}
+!6 = !{i32 7, !"Dwarf Version", i32 4}
+!7 = !{i32 2, !"Debug Info Version", i32 3}
+!8 = !{i32 1, !"wchar_size", i32 4}
+!9 = !{i32 7, !"frame-pointer", i32 2}
+!10 = distinct !DISubprogram(name: "foo", linkageName: "_Z3fooii", scope: !11, file: !11, line: 29, type: !12, scopeLine: 29, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !0, retainedNodes: !4)
+!11 = !DIFile(filename: "bitfields-packed.cpp", directory: "/tmp")
+!12 = !DISubroutineType(cc: DW_CC_LLVM_SpirFunction, types: !13)
+!13 = !{!14, !14, !14}
+!14 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
+!15 = !DILocalVariable(name: "a", arg: 1, scope: !10, file: !11, line: 29, type: !14)
+!16 = !DILocation(line: 29, column: 43, scope: !10)
+!17 = !DILocalVariable(name: "b", arg: 2, scope: !10, file: !11, line: 29, type: !14)
+!18 = !DILocation(line: 29, column: 50, scope: !10)
+; CHECK-LLVM: !DILocalVariable(name: "arr_bf1", {{.*}}, type: ![[#ARRAY_TYPE:]])
+!19 = !DILocalVariable(name: "arr_bf1", scope: !10, file: !11, line: 33, type: !20)
+; CHECK-LLVM: ![[#ARRAY_TYPE]] = {{.*}}!DICompositeType(tag: DW_TAG_array_type, baseType: ![[#BITFIELD_STRUCT:]], {{.*}}) 
+!20 = !DICompositeType(tag: DW_TAG_array_type, baseType: !21, size: 16, elements: !30)
+; CHECK-LLVM: ![[#BITFIELD_STRUCT]] = {{.*}}!DICompositeType(tag: DW_TAG_structure_type, name: "struct_bit_fields1", {{.*}}, identifier: "_ZTS18struct_bit_fields1")
+!21 = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "struct_bit_fields1", file: !11, line: 19, size: 16, flags: DIFlagTypePassByValue, elements: !22, identifier: "_ZTS18struct_bit_fields1")
+!22 = !{!23, !25, !26, !27, !28, !29}
+; CHECK-LLVM-BITFIELD: !DIDerivedType(tag: DW_TAG_member, name: "a", scope: ![[#BITFIELD_STRUCT]], {{.*}}, size: 3, flags: {{.*}}DIFlagBitField{{.*}})
+; CHECK-LLVM-BITFIELD: !DIDerivedType(tag: DW_TAG_member, name: "b", scope: ![[#BITFIELD_STRUCT]], {{.*}}, size: 3, offset: 3, flags: {{.*}}DIFlagBitField{{.*}})
+; CHECK-LLVM-BITFIELD: !DIDerivedType(tag: DW_TAG_member, name: "c", scope: ![[#BITFIELD_STRUCT]], {{.*}}, size: 3, offset: 6, flags: {{.*}}DIFlagBitField{{.*}})
+; CHECK-LLVM-BITFIELD: !DIDerivedType(tag: DW_TAG_member, name: "d", scope: ![[#BITFIELD_STRUCT]], {{.*}}, size: 3, offset: 9, flags: {{.*}}DIFlagBitField{{.*}})
+; CHECK-LLVM-BITFIELD: !DIDerivedType(tag: DW_TAG_member, name: "e", scope: ![[#BITFIELD_STRUCT]], {{.*}}, size: 3, offset: 12, flags: {{.*}}DIFlagBitField{{.*}})
+; CHECK-LLVM-BITFIELD: !DIDerivedType(tag: DW_TAG_member, name: "f", scope: ![[#BITFIELD_STRUCT]], {{.*}}, size: 1, offset: 15, flags: {{.*}}DIFlagBitField{{.*}})
+; CHECK-LLVM-NO-BITFIELD-NOT: DIFlagBitField
+!23 = !DIDerivedType(tag: DW_TAG_member, name: "a", scope: !21, file: !11, line: 21, baseType: !24, size: 3, flags: DIFlagBitField, extraData: i64 0)
+!24 = !DIBasicType(name: "unsigned short", size: 16, encoding: DW_ATE_unsigned)
+!25 = !DIDerivedType(tag: DW_TAG_member, name: "b", scope: !21, file: !11, line: 22, baseType: !24, size: 3, offset: 3, flags: DIFlagBitField, extraData: i64 0)
+!26 = !DIDerivedType(tag: DW_TAG_member, name: "c", scope: !21, file: !11, line: 23, baseType: !24, size: 3, offset: 6, flags: DIFlagBitField, extraData: i64 0)
+!27 = !DIDerivedType(tag: DW_TAG_member, name: "d", scope: !21, file: !11, line: 24, baseType: !24, size: 3, offset: 9, flags: DIFlagBitField, extraData: i64 0)
+!28 = !DIDerivedType(tag: DW_TAG_member, name: "e", scope: !21, file: !11, line: 25, baseType: !24, size: 3, offset: 12, flags: DIFlagBitField, extraData: i64 0)
+!29 = !DIDerivedType(tag: DW_TAG_member, name: "f", scope: !21, file: !11, line: 26, baseType: !24, size: 1, offset: 15, flags: DIFlagBitField, extraData: i64 0)
+!30 = !{!31}
+!31 = !DISubrange(count: 1)
+!32 = !DILocation(line: 33, column: 22, scope: !10)
+!33 = !DILocalVariable(name: "ans", scope: !10, file: !11, line: 35, type: !14)
+!34 = !DILocation(line: 35, column: 7, scope: !10)
+!35 = !DILocation(line: 36, column: 10, scope: !10)
+!36 = !DILocation(line: 36, column: 3, scope: !10)