From 44da81d04154f845cc9166e9bf47852d04bffbb6 Mon Sep 17 00:00:00 2001 From: Viktoria Maximova Date: Fri, 9 Jun 2023 14:05:37 +0200 Subject: [PATCH] [PATCH 61/79] [DebugInfo] Adjust TypeInheritance for NonSemantic spec (#2039) It does not have Child parameter comparing to OpenCL specification. https://github.com/KhronosGroup/SPIRV-Registry/blob/main/nonsemantic/NonSemantic.Shader.DebugInfo.100.asciidoc#DebugTypeInheritance Gbp-Pq: Name 0061-DebugInfo-Adjust-TypeInheritance-for-NonSemantic-spe.patch --- lib/SPIRV/LLVMToSPIRVDbgTran.cpp | 20 +++--- lib/SPIRV/SPIRVToLLVMDbgTran.cpp | 33 ++++++--- lib/SPIRV/SPIRVToLLVMDbgTran.h | 3 +- lib/SPIRV/libSPIRV/SPIRV.debug.h | 14 ++-- test/DebugInfo/DebugInfoTypeInheritance.ll | 83 ++++++++++++++++++++++ 5 files changed, 129 insertions(+), 24 deletions(-) create mode 100644 test/DebugInfo/DebugInfoTypeInheritance.ll diff --git a/lib/SPIRV/LLVMToSPIRVDbgTran.cpp b/lib/SPIRV/LLVMToSPIRVDbgTran.cpp index d3daa26..0562e80 100644 --- a/lib/SPIRV/LLVMToSPIRVDbgTran.cpp +++ b/lib/SPIRV/LLVMToSPIRVDbgTran.cpp @@ -1043,16 +1043,20 @@ LLVMToSPIRVDbgTran::transDbgMemberTypeNonSemantic(const DIDerivedType *MT) { SPIRVEntry *LLVMToSPIRVDbgTran::transDbgInheritance(const DIDerivedType *DT) { using namespace SPIRVDebug::Operand::TypeInheritance; - SPIRVWordVec Ops(OperandCount); - Ops[ChildIdx] = transDbgEntry(DT->getScope())->getId(); - Ops[ParentIdx] = transDbgEntry(DT->getBaseType())->getId(); - ConstantInt *Offset = getUInt(M, DT->getOffsetInBits()); - Ops[OffsetIdx] = SPIRVWriter->transValue(Offset, nullptr)->getId(); + const SPIRVWord Offset = isNonSemanticDebugInfo() ? 1 : 0; + SPIRVWordVec Ops(OperandCount - Offset); + // There is no Child operand in NonSemantic debug spec + if (!isNonSemanticDebugInfo()) + Ops[ChildIdx] = transDbgEntry(DT->getScope())->getId(); + Ops[ParentIdx - Offset] = transDbgEntry(DT->getBaseType())->getId(); + ConstantInt *OffsetInBits = getUInt(M, DT->getOffsetInBits()); + Ops[OffsetIdx - Offset] = + SPIRVWriter->transValue(OffsetInBits, nullptr)->getId(); ConstantInt *Size = getUInt(M, DT->getSizeInBits()); - Ops[SizeIdx] = SPIRVWriter->transValue(Size, nullptr)->getId(); - Ops[FlagsIdx] = transDebugFlags(DT); + Ops[SizeIdx - Offset] = SPIRVWriter->transValue(Size, nullptr)->getId(); + Ops[FlagsIdx - Offset] = transDebugFlags(DT); if (isNonSemanticDebugInfo()) - transformToConstant(Ops, {FlagsIdx}); + transformToConstant(Ops, {FlagsIdx - Offset}); return BM->addDebugInfo(SPIRVDebug::TypeInheritance, getVoidTy(), Ops); } diff --git a/lib/SPIRV/SPIRVToLLVMDbgTran.cpp b/lib/SPIRV/SPIRVToLLVMDbgTran.cpp index 6fffc4b..978068e 100644 --- a/lib/SPIRV/SPIRVToLLVMDbgTran.cpp +++ b/lib/SPIRV/SPIRVToLLVMDbgTran.cpp @@ -543,6 +543,11 @@ SPIRVToLLVMDbgTran::transTypeComposite(const SPIRVExtInst *DebugInst) { transTypeMember(SPVMemberInst, DebugInst, cast(CT)); EltTys.push_back(MemberMD); DebugInstCache[SPVMemberInst] = MemberMD; + } else if (MemberInst->getExtOp() == SPIRVDebug::TypeInheritance) { + auto *SPVMemberInst = BM->get(Ops[I]); + DINode *MemberMD = transTypeInheritance(SPVMemberInst, cast(CT)); + EltTys.push_back(MemberMD); + DebugInstCache[SPVMemberInst] = MemberMD; } else { EltTys.emplace_back(transDebugInst(BM->get(Ops[I]))); } @@ -1148,25 +1153,35 @@ DINode *SPIRVToLLVMDbgTran::transTypedef(const SPIRVExtInst *DebugInst) { return getDIBuilder(DebugInst).createTypedef(Ty, Alias, File, LineNo, Scope); } -DINode * -SPIRVToLLVMDbgTran::transTypeInheritance(const SPIRVExtInst *DebugInst) { +DINode *SPIRVToLLVMDbgTran::transTypeInheritance(const SPIRVExtInst *DebugInst, + DIType *ChildClass) { + if (isNonSemanticDebugInfo(DebugInst->getExtSetKind()) && !ChildClass) { + // Will be translated later when processing TypeMember's parent + return nullptr; + } using namespace SPIRVDebug::Operand::TypeInheritance; const SPIRVWordVec &Ops = DebugInst->getArguments(); - assert(Ops.size() >= OperandCount && "Invalid number of operands"); + assert(Ops.size() >= MinOperandCount && "Invalid number of operands"); + // No Child operand for NonSemantic debug spec + SPIRVWord Offset = isNonSemanticDebugInfo(DebugInst->getExtSetKind()) ? 1 : 0; DIType *Parent = - transDebugInst(BM->get(Ops[ParentIdx])); - DIType *Child = transDebugInst(BM->get(Ops[ChildIdx])); + transDebugInst(BM->get(Ops[ParentIdx - Offset])); + DIType *Child = + isNonSemanticDebugInfo(DebugInst->getExtSetKind()) + ? ChildClass + : transDebugInst(BM->get(Ops[ChildIdx])); DINode::DIFlags Flags = DINode::FlagZero; - SPIRVWord SPIRVFlags = - getConstantValueOrLiteral(Ops, FlagsIdx, DebugInst->getExtSetKind()); + SPIRVWord SPIRVFlags = getConstantValueOrLiteral(Ops, FlagsIdx - Offset, + DebugInst->getExtSetKind()); if ((SPIRVFlags & SPIRVDebug::FlagAccess) == SPIRVDebug::FlagIsPublic) Flags |= llvm::DINode::FlagPublic; if ((SPIRVFlags & SPIRVDebug::FlagAccess) == SPIRVDebug::FlagIsProtected) Flags |= llvm::DINode::FlagProtected; if ((SPIRVFlags & SPIRVDebug::FlagAccess) == SPIRVDebug::FlagIsPrivate) Flags |= llvm::DINode::FlagPrivate; - uint64_t Offset = BM->get(Ops[OffsetIdx])->getZExtIntValue(); - return getDIBuilder(DebugInst).createInheritance(Child, Parent, Offset, 0, + uint64_t OffsetVal = + BM->get(Ops[OffsetIdx - Offset])->getZExtIntValue(); + return getDIBuilder(DebugInst).createInheritance(Child, Parent, OffsetVal, 0, Flags); } diff --git a/lib/SPIRV/SPIRVToLLVMDbgTran.h b/lib/SPIRV/SPIRVToLLVMDbgTran.h index 48d7ea6..05e1506 100644 --- a/lib/SPIRV/SPIRVToLLVMDbgTran.h +++ b/lib/SPIRV/SPIRVToLLVMDbgTran.h @@ -166,7 +166,8 @@ private: DINode *transTypedef(const SPIRVExtInst *DebugInst); - DINode *transTypeInheritance(const SPIRVExtInst *DebugInst); + DINode *transTypeInheritance(const SPIRVExtInst *DebugInst, + DIType *ChildClass = nullptr); DINode *transImportedEntry(const SPIRVExtInst *DebugInst); diff --git a/lib/SPIRV/libSPIRV/SPIRV.debug.h b/lib/SPIRV/libSPIRV/SPIRV.debug.h index 4f3ce37..d482325 100644 --- a/lib/SPIRV/libSPIRV/SPIRV.debug.h +++ b/lib/SPIRV/libSPIRV/SPIRV.debug.h @@ -501,12 +501,14 @@ enum { namespace TypeInheritance { enum { - ChildIdx = 0, - ParentIdx = 1, - OffsetIdx = 2, - SizeIdx = 3, - FlagsIdx = 4, - OperandCount = 5 + ChildIdx = 0, + ParentIdx = 1, + OffsetIdx = 2, + SizeIdx = 3, + FlagsIdx = 4, + // NonSemantic + MinOperandCount = 4, + OperandCount = 5 }; } diff --git a/test/DebugInfo/DebugInfoTypeInheritance.ll b/test/DebugInfo/DebugInfoTypeInheritance.ll new file mode 100644 index 0000000..8096b0c --- /dev/null +++ b/test/DebugInfo/DebugInfoTypeInheritance.ll @@ -0,0 +1,83 @@ +; RUN: llvm-as %s -o %t.bc +; RUN: llvm-spirv %t.bc -spirv-text -o %t.spt +; RUN: FileCheck %s --input-file %t.spt --check-prefixes=CHECK-SPIRV,CHECK-SPIRV-OCL +; RUN: llvm-spirv %t.bc -o %t.spv +; RUN: llvm-spirv -r %t.spv -o %t.rev.bc +; RUN: llvm-dis %t.rev.bc -o %t.rev.ll +; RUN: FileCheck %s --input-file %t.rev.ll --check-prefix CHECK-LLVM + +; RUN: llvm-spirv %t.bc -spirv-text --spirv-debug-info-version=nonsemantic-shader-100 -o %t.spt +; RUN: FileCheck %s --input-file %t.spt --check-prefixes=CHECK-SPIRV,CHECK-SPIRV-NONSEM +; RUN: llvm-spirv %t.bc --spirv-debug-info-version=nonsemantic-shader-100 -o %t.spv +; RUN: llvm-spirv -r -emit-opaque-pointers %t.spv -o %t.rev.bc +; RUN: llvm-dis %t.rev.bc -o %t.rev.ll +; RUN: FileCheck %s --input-file %t.rev.ll --check-prefix CHECK-LLVM + +; CHECK-SPIRV: String [[#Str_C:]] "C" +; CHECK-SPIRV: String [[#Str_B:]] "B" +; CHECK-SPIRV: String [[#Str_A:]] "A" + +; CHECK-SPIRV: [[#Class_A:]] [[#]] DebugTypeComposite [[#Str_A]] + +; CHECK-SPIRV-OCL: [[#B_inherits_A:]] [[#]] DebugTypeInheritance [[#Class_B:]] [[#Class_A]] [[#]] [[#]] [[#]] {{$}} +; CHECK-SPIRV-NONSEM: [[#B_inherits_A:]] [[#]] DebugTypeInheritance [[#Class_A]] [[#]] [[#]] [[#]] {{$}} +; CHECK-SPIRV: [[#Class_B:]] [[#]] DebugTypeComposite [[#Str_B]] {{.*}} [[#B_inherits_A]] + +; CHECK-SPIRV-OCL: [[#C_inherits_B:]] [[#]] DebugTypeInheritance [[#Class_C:]] [[#Class_B]] [[#]] [[#]] [[#]] {{$}} +; CHECK-SPIRV-NONSEM: [[#C_inherits_B:]] [[#]] DebugTypeInheritance [[#Class_B]] [[#]] [[#]] [[#]] {{$}} +; CHECK-SPIRV: [[#Class_C:]] [[#]] DebugTypeComposite [[#Str_C]] {{.*}} [[#C_inherits_B]] + +; CHECK-LLVM: ![[#Class_C:]] = distinct !DICompositeType(tag: DW_TAG_class_type, name: "C"{{.*}}identifier: "_ZTS1C") +; CHECK-LLVM: !DIDerivedType(tag: DW_TAG_inheritance, scope: ![[#Class_C]], baseType: ![[#Class_B:]] +; CHECK-LLVM: ![[#Class_B]] = distinct !DICompositeType(tag: DW_TAG_class_type, name: "B"{{.*}}identifier: "_ZTS1B") +; CHECK-LLVM: !DIDerivedType(tag: DW_TAG_inheritance, scope: ![[#Class_B]], baseType: ![[#Class_A:]] +; CHECK-LLVM: ![[#Class_A]] = distinct !DICompositeType(tag: DW_TAG_class_type, name: "A"{{.*}}identifier: "_ZTS1A") + +target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128" +target triple = "spir64-unknown-unknown" + +%class.C = type { i8 } + +; Function Attrs: mustprogress noinline nounwind optnone uwtable +define dso_local noundef i32 @_Z3foov() #0 !dbg !10 { + %1 = alloca %class.C, align 1 + call void @llvm.dbg.declare(metadata %class.C* %1, metadata !16, metadata !DIExpression()), !dbg !24 + ret i32 0, !dbg !25 +} + +; Function Attrs: nocallback nofree nosync nounwind speculatable willreturn memory(none) +declare void @llvm.dbg.declare(metadata, metadata, metadata) #1 + +attributes #0 = { mustprogress noinline } +attributes #1 = { willreturn } + +!llvm.dbg.cu = !{!0} +!llvm.module.flags = !{!2, !3, !4, !5, !6, !7, !8} +!llvm.ident = !{!9} + +!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !1, producer: "clang version 17.0.0 (https://github.com/llvm/llvm-project.git 1f8a33c19c79fd4649a07eb70ea394c60a8ce316)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None) +!1 = !DIFile(filename: "/app/example.cpp", directory: "/app") +!2 = !{i32 7, !"Dwarf Version", i32 4} +!3 = !{i32 2, !"Debug Info Version", i32 3} +!4 = !{i32 1, !"wchar_size", i32 4} +!5 = !{i32 8, !"PIC Level", i32 2} +!6 = !{i32 7, !"PIE Level", i32 2} +!7 = !{i32 7, !"uwtable", i32 2} +!8 = !{i32 7, !"frame-pointer", i32 2} +!9 = !{!"clang version 17.0.0 (https://github.com/llvm/llvm-project.git 1f8a33c19c79fd4649a07eb70ea394c60a8ce316)"} +!10 = distinct !DISubprogram(name: "foo", linkageName: "_Z3foov", scope: !11, file: !11, line: 4, type: !12, scopeLine: 4, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !0, retainedNodes: !15) +!11 = !DIFile(filename: "example.cpp", directory: "/app") +!12 = !DISubroutineType(types: !13) +!13 = !{!14} +!14 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed) +!15 = !{} +!16 = !DILocalVariable(name: "c", scope: !10, file: !11, line: 7, type: !17) +!17 = distinct !DICompositeType(tag: DW_TAG_class_type, name: "C", file: !11, line: 3, size: 8, flags: DIFlagTypePassByValue, elements: !18, identifier: "_ZTS1C") +!18 = !{!19} +!19 = !DIDerivedType(tag: DW_TAG_inheritance, scope: !17, baseType: !20, flags: DIFlagPublic, extraData: i32 0) +!20 = distinct !DICompositeType(tag: DW_TAG_class_type, name: "B", file: !11, line: 2, size: 8, flags: DIFlagTypePassByValue, elements: !21, identifier: "_ZTS1B") +!21 = !{!22} +!22 = !DIDerivedType(tag: DW_TAG_inheritance, scope: !20, baseType: !23, flags: DIFlagPublic, extraData: i32 0) +!23 = distinct !DICompositeType(tag: DW_TAG_class_type, name: "A", file: !11, line: 1, size: 8, flags: DIFlagTypePassByValue, elements: !15, identifier: "_ZTS1A") +!24 = !DILocation(line: 7, column: 11, scope: !10) +!25 = !DILocation(line: 8, column: 3, scope: !10) -- 2.30.2