Skip to content

Commit 996c0f3

Browse files
bwlodarczSterling-Augustine
bwlodarcz
authored and
Sterling-Augustine
committed
[SPIR-V] Support for multiple DebugCompilationUnit in DI (llvm#109645)
The module in LLVM can have more then one CompilationUnit when e.g. modules are combined by llvm-linker. This property also needs to be handled in DI.
1 parent 41398fa commit 996c0f3

File tree

3 files changed

+86
-35
lines changed

3 files changed

+86
-35
lines changed

‎llvm/lib/Target/SPIRV/SPIRVEmitNonSemanticDI.cpp‎

Lines changed: 63 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,22 @@ enum BaseTypeAttributeEncoding {
7373
UnsignedChar = 7
7474
};
7575

76+
enum SourceLanguage {
77+
Unknown = 0,
78+
ESSL = 1,
79+
GLSL = 2,
80+
OpenCL_C = 3,
81+
OpenCL_CPP = 4,
82+
HLSL = 5,
83+
CPP_for_OpenCL = 6,
84+
SYCL = 7,
85+
HERO_C = 8,
86+
NZSL = 9,
87+
WGSL = 10,
88+
Slang = 11,
89+
Zig = 12
90+
};
91+
7692
bool SPIRVEmitNonSemanticDI::emitGlobalDI(MachineFunction &MF) {
7793
// If this MachineFunction doesn't have any BB repeat procedure
7894
// for the next
@@ -83,8 +99,8 @@ bool SPIRVEmitNonSemanticDI::emitGlobalDI(MachineFunction &MF) {
8399

84100
// Required variables to get from metadata search
85101
LLVMContext *Context;
86-
SmallString<128> FilePath;
87-
unsigned SourceLanguage = 0;
102+
SmallVector<SmallString<128>> FilePaths;
103+
SmallVector<int64_t> LLVMSourceLanguages;
88104
int64_t DwarfVersion = 0;
89105
int64_t DebugInfoVersion = 0;
90106
SmallPtrSet<DIBasicType *, 12> BasicTypes;
@@ -101,9 +117,10 @@ bool SPIRVEmitNonSemanticDI::emitGlobalDI(MachineFunction &MF) {
101117
for (const auto *Op : DbgCu->operands()) {
102118
if (const auto *CompileUnit = dyn_cast<DICompileUnit>(Op)) {
103119
DIFile *File = CompileUnit->getFile();
104-
sys::path::append(FilePath, File->getDirectory(), File->getFilename());
105-
SourceLanguage = CompileUnit->getSourceLanguage();
106-
break;
120+
FilePaths.emplace_back();
121+
sys::path::append(FilePaths.back(), File->getDirectory(),
122+
File->getFilename());
123+
LLVMSourceLanguages.push_back(CompileUnit->getSourceLanguage());
107124
}
108125
}
109126
const NamedMDNode *ModuleFlags = M->getNamedMetadata("llvm.module.flags");
@@ -160,9 +177,6 @@ bool SPIRVEmitNonSemanticDI::emitGlobalDI(MachineFunction &MF) {
160177
return StrReg;
161178
};
162179

163-
// Emit OpString with FilePath which is required by DebugSource
164-
const Register FilePathStrReg = EmitOpString(FilePath);
165-
166180
const SPIRVType *VoidTy =
167181
GR->getOrCreateSPIRVType(Type::getVoidTy(*Context), MIRBuilder);
168182

@@ -187,27 +201,54 @@ bool SPIRVEmitNonSemanticDI::emitGlobalDI(MachineFunction &MF) {
187201
return InstReg;
188202
};
189203

190-
// Emit DebugSource which is required by DebugCompilationUnit
191-
const Register DebugSourceResIdReg = EmitDIInstruction(
192-
SPIRV::NonSemanticExtInst::DebugSource, {FilePathStrReg});
193-
194204
const SPIRVType *I32Ty =
195205
GR->getOrCreateSPIRVType(Type::getInt32Ty(*Context), MIRBuilder);
196206

197-
// Convert DwarfVersion, DebugInfo and SourceLanguage integers to OpConstant
198-
// instructions required by DebugCompilationUnit
199207
const Register DwarfVersionReg =
200208
GR->buildConstantInt(DwarfVersion, MIRBuilder, I32Ty, false);
201209
const Register DebugInfoVersionReg =
202210
GR->buildConstantInt(DebugInfoVersion, MIRBuilder, I32Ty, false);
203-
const Register SourceLanguageReg =
204-
GR->buildConstantInt(SourceLanguage, MIRBuilder, I32Ty, false);
205-
206-
[[maybe_unused]]
207-
const Register DebugCompUnitResIdReg =
208-
EmitDIInstruction(SPIRV::NonSemanticExtInst::DebugCompilationUnit,
209-
{DebugInfoVersionReg, DwarfVersionReg,
210-
DebugSourceResIdReg, SourceLanguageReg});
211+
212+
for (unsigned Idx = 0; Idx < LLVMSourceLanguages.size(); ++Idx) {
213+
const Register FilePathStrReg = EmitOpString(FilePaths[Idx]);
214+
215+
const Register DebugSourceResIdReg = EmitDIInstruction(
216+
SPIRV::NonSemanticExtInst::DebugSource, {FilePathStrReg});
217+
218+
SourceLanguage SpirvSourceLanguage = SourceLanguage::Unknown;
219+
switch (LLVMSourceLanguages[Idx]) {
220+
case dwarf::DW_LANG_OpenCL:
221+
SpirvSourceLanguage = SourceLanguage::OpenCL_C;
222+
break;
223+
case dwarf::DW_LANG_OpenCL_CPP:
224+
SpirvSourceLanguage = SourceLanguage::OpenCL_CPP;
225+
break;
226+
case dwarf::DW_LANG_CPP_for_OpenCL:
227+
SpirvSourceLanguage = SourceLanguage::CPP_for_OpenCL;
228+
break;
229+
case dwarf::DW_LANG_GLSL:
230+
SpirvSourceLanguage = SourceLanguage::GLSL;
231+
break;
232+
case dwarf::DW_LANG_HLSL:
233+
SpirvSourceLanguage = SourceLanguage::HLSL;
234+
break;
235+
case dwarf::DW_LANG_SYCL:
236+
SpirvSourceLanguage = SourceLanguage::SYCL;
237+
break;
238+
case dwarf::DW_LANG_Zig:
239+
SpirvSourceLanguage = SourceLanguage::Zig;
240+
break;
241+
}
242+
243+
const Register SourceLanguageReg =
244+
GR->buildConstantInt(SpirvSourceLanguage, MIRBuilder, I32Ty, false);
245+
246+
[[maybe_unused]]
247+
const Register DebugCompUnitResIdReg =
248+
EmitDIInstruction(SPIRV::NonSemanticExtInst::DebugCompilationUnit,
249+
{DebugInfoVersionReg, DwarfVersionReg,
250+
DebugSourceResIdReg, SourceLanguageReg});
251+
}
211252

212253
// We aren't extracting any DebugInfoFlags now so we
213254
// emitting zero to use as <id>Flags argument for DebugBasicType

‎llvm/test/CodeGen/SPIRV/debug-info/debug-compilation-unit.ll‎

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,29 @@
66
; CHECK-MIR-DAG: [[type_void:%[0-9]+\:type]] = OpTypeVoid
77
; CHECK-MIR-DAG: [[type_i64:%[0-9]+\:type\(s64\)]] = OpTypeInt 32, 0
88
; CHECK-MIR-DAG: [[dwarf_version:%[0-9]+\:iid\(s32\)]] = OpConstantI [[type_i64]], 5
9-
; CHECK-MIR-DAG: [[source_language:%[0-9]+\:iid\(s32\)]] = OpConstantI [[type_i64]], 3
10-
; CHECK-MIR-DAG: [[debug_info_version:%[0-9]+\:iid\(s32\)]] = OpConstantI [[type_i64]], 21
11-
; CHECK-MIR-DAG: [[filename_str:%[0-9]+\:id\(s32\)]] = OpString 1094795567, 1094795585, 792805697, 1111638594, 1111638594, 1128481583, 1128481603, {{1697596227|1700545347}}, 1886216568, 1663985004, 0
12-
; CHECK-MIR-DAG: [[debug_source:%[0-9]+\:id\(s32\)]] = OpExtInst [[type_void]], 3, 35, [[filename_str]]
13-
; CHECK-MIR-DAG: [[debug_compilation_unit:%[0-9]+\:id\(s32\)]] = OpExtInst [[type_void]], 3, 1, [[source_language]], [[dwarf_version]], [[debug_source]], [[debug_info_version]]
9+
; CHECK-MIR-DAG: [[debug_info_version:%[0-9]+\:iid\(s32\)]] = OpConstantI [[type_i64]], 3
10+
; CHECK-MIR-DAG: [[source_language_sycl:%[0-9]+\:iid\(s32\)]] = OpConstantI [[type_i64]], 7
11+
; CHECK-MIR-DAG: [[source_language_cpp:%[0-9]+\:iid\(s32\)]] = OpConstantI [[type_i64]], 4
12+
; CHECK-MIR-DAG: [[filename_str_sycl:%[0-9]+\:id\(s32\)]] = OpString 1094795567, 1094795585, 792805697, 1111638594, 1111638594, 1128481583, 1128481603, {{1697596227|1700545347}}, 1886216568, 1663985004, 0
13+
; CHECK-MIR-DAG: [[filename_str_cpp:%[0-9]+\:id\(s32\)]] = OpString 1145324591, 1145324612, 793003076, 1162167621, 1162167621, 1179010607, 1179010630, 1697596998, 1886216568, 774989164, 7368803
14+
; CHECK-MIR-DAG: [[debug_source_sycl:%[0-9]+\:id\(s32\)]] = OpExtInst [[type_void]], 3, 35, [[filename_str_sycl]]
15+
; CHECK-MIR-DAG: OpExtInst [[type_void]], 3, 1, [[debug_info_version]], [[dwarf_version]], [[debug_source_sycl]], [[source_language_sycl]]
16+
; CHECK-MIR-DAG: [[debug_source_cpp:%[0-9]+\:id\(s32\)]] = OpExtInst [[type_void]], 3, 35, [[filename_str_cpp]]
17+
; CHECK-MIR-DAG: OpExtInst [[type_void]], 3, 1, [[debug_info_version]], [[dwarf_version]], [[debug_source_cpp]], [[source_language_cpp]]
1418

1519
; CHECK-SPIRV: [[ext_inst_non_semantic:%[0-9]+]] = OpExtInstImport "NonSemantic.Shader.DebugInfo.100"
16-
; CHECK-SPIRV: [[filename_str:%[0-9]+]] = OpString "/AAAAAAAAAA/BBBBBBBB/CCCCCCCCC{{[/\\]}}example.c"
20+
; CHECK-SPIRV: [[filename_str_sycl:%[0-9]+]] = OpString "/AAAAAAAAAA/BBBBBBBB/CCCCCCCCC{{[/\\]}}example.c"
21+
; CHECK-SPIRV: [[filename_str_cpp:%[0-9]+]] = OpString "/DDDDDDDDDD/EEEEEEEE/FFFFFFFFF{{[/\\]}}example1.cpp"
1722
; CHECK-SPIRV-DAG: [[type_void:%[0-9]+]] = OpTypeVoid
1823
; CHECK-SPIRV-DAG: [[type_i32:%[0-9]+]] = OpTypeInt 32 0
1924
; CHECK-SPIRV-DAG: [[dwarf_version:%[0-9]+]] = OpConstant [[type_i32]] 5
20-
; CHECK-SPIRV-DAG: [[debug_info_version:%[0-9]+]] = OpConstant [[type_i32]] 21
21-
; CHECK-SPIRV-DAG: [[source_language:%[0-9]+]] = OpConstant [[type_i32]] 3
22-
; CHECK-SPIRV: [[debug_source:%[0-9]+]] = OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugSource [[filename_str]]
23-
; CHECK-SPIRV: [[debug_compiation_unit:%[0-9]+]] = OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugCompilationUnit [[source_language]] [[dwarf_version]] [[debug_source]] [[debug_info_version]]
25+
; CHECK-SPIRV-DAG: [[source_language_sycl:%[0-9]+]] = OpConstant [[type_i32]] 7
26+
; CHECK-SPIRV-DAG: [[source_language_cpp:%[0-9]+]] = OpConstant [[type_i32]] 4
27+
; CHECK-SPIRV-DAG: [[debug_info_version:%[0-9]+]] = OpConstant [[type_i32]] 3
28+
; CHECK-SPIRV: [[debug_source_sycl:%[0-9]+]] = OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugSource [[filename_str_sycl]]
29+
; CHECK-SPIRV: OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugCompilationUnit [[debug_info_version]] [[dwarf_version]] [[debug_source_sycl]] [[source_language_sycl]]
30+
; CHECK-SPIRV: [[debug_source_cpp:%[0-9]+]] = OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugSource [[filename_str_cpp]]
31+
; CHECK-SPIRV: OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugCompilationUnit [[debug_info_version]] [[dwarf_version]] [[debug_source_cpp]] [[source_language_cpp]]
2432

2533
; CHECK-OPTION-NOT: OpExtInstImport "NonSemantic.Shader.DebugInfo.100"
2634
; CHECK-OPTION-NOT: OpString "/AAAAAAAAAA/BBBBBBBB/CCCCCCCCC{{[/\\]}}example.c"
@@ -37,12 +45,14 @@ entry:
3745
}
3846
; CHECK-SPIRV-NOT: Lfunc_end1:
3947

40-
!llvm.dbg.cu = !{!0}
48+
!llvm.dbg.cu = !{!0, !6}
4149
!llvm.module.flags = !{!2, !3, !4, !5}
4250

43-
!0 = distinct !DICompileUnit(language: DW_LANG_OpenCL, file: !1, producer: "clang version XX.X.XXXX (FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None)
51+
!0 = distinct !DICompileUnit(language: DW_LANG_SYCL, file: !1, producer: "clang version XX.X.XXXX (FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None)
4452
!1 = !DIFile(filename: "example.c", directory: "/AAAAAAAAAA/BBBBBBBB/CCCCCCCCC", checksumkind: CSK_MD5, checksum: "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF")
4553
!2 = !{i32 7, !"Dwarf Version", i32 5}
4654
!3 = !{i32 2, !"Debug Info Version", i32 3}
4755
!4 = !{i32 1, !"wchar_size", i32 4}
4856
!5 = !{i32 7, !"frame-pointer", i32 2}
57+
!6 = distinct !DICompileUnit(language: DW_LANG_OpenCL_CPP, file: !7, producer: "clang version XX.X.XXXX (FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None)
58+
!7 = !DIFile(filename: "example1.cpp", directory: "/DDDDDDDDDD/EEEEEEEE/FFFFFFFFF", checksumkind: CSK_MD5, checksum: "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF")

‎llvm/test/CodeGen/SPIRV/debug-info/debug-type-basic.ll‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ entry:
163163
!llvm.dbg.cu = !{!0}
164164
!llvm.module.flags = !{!2, !3, !4, !5}
165165

166-
!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !1, producer: "clang version XX.X.XXXX (FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None)
166+
!0 = distinct !DICompileUnit(language: DW_LANG_Zig, file: !1, producer: "clang version XX.X.XXXX (FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None)
167167
!1 = !DIFile(filename: "example.cpp", directory: "/AAAAAAAAAA/BBBBBBBB/CCCCCCCCC", checksumkind: CSK_MD5, checksum: "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF")
168168
!2 = !{i32 7, !"Dwarf Version", i32 5}
169169
!3 = !{i32 2, !"Debug Info Version", i32 3}

0 commit comments

Comments
 (0)