llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT--> @llvm/pr-subscribers-backend-spir-v Author: Diego Novillo (dnovillo) <details> <summary>Changes</summary> This adds two related changes to HLSL debug info support in the SPIR-V backend. It's a first small step towards the plan I described in https://discourse.llvm.org/t/hlsl-spirv-nsdi-debug-info-support-for-clang-dxc/90149. ## Tag HLSL shaders with `DW_LANG_HLSL` in the front-end `GetSourceLanguage()` in `clang/lib/CodeGen/CGDebugInfo.cpp` checked `LO.CPlusPlus` before `LO.HLSL`. Since HLSL is compiled as C++, the HLSL check was never reached. Shaders compiled with `-g` were tagged with `DW_LANG_C_plus_plus_14` instead of `DW_LANG_HLSL`. The NSDI pass already had the correct mapping for `DW_LANG_HLSL` but it was never triggered. This fixes #<!-- -->136929 and #<!-- -->136995. ## Make `SPIRVEmitNonSemanticDI` activate automatically when `-g` is used `SPIRVPassConfig::addPreEmitPass()` only scheduled `SPIRVEmitNonSemanticDI` when `--spv-emit-nonsemantic-debug-info` was set or the target vendor was AMD. Passing `-g` to clang had no effect on the SPIR-V backend pass. The pass is now added unconditionally and self-activates by checking for `llvm.dbg.cu` in the module. When no debug metadata is present it exits early with no effect. This avoids the need to inspect module metadata at pass-configuration time, which is not reliably available. `--spv-emit-nonsemantic-debug-info` is now a deprecated synonym for `-g`. The alternative to the unconditional pass approach is to check at pass-configuration time whether the module was compiled with debug info (e.g. via `TargetOptions::DebugInfoForProfiling` or a similar flag forwarded from the driver). I went with the unconditional approach because it is simpler and the pass is cheap to enter and exit when no `llvm.dbg.cu` is present. I'm not sure whether adding a pass unconditionally is acceptable. Does this sound reasonable, or would it be better to implement the flag-forwarding approach? Changes to tests: - `clang/test/CodeGenHLSL/` (new): verifies that `-g` on an HLSL SPIR-V target produces `DebugCompilationUnit` with language code 5 (`DW_LANG_HLSL`). - `llvm/test/CodeGen/SPIRV/debug-info/hlsl-debug-info-auto-activation.ll` (new): verifies that a module with `llvm.dbg.cu` and `DW_LANG_HLSL` produces `DebugCompilationUnit` without `--spv-emit-nonsemantic-debug-info`. - Existing `debug-compilation-unit.ll`, `debug-type-basic.ll`, `debug-type-pointer.ll`: updated to verify NSDI is emitted whenever debug metadata is present. - `llc-pipeline.ll`: updated to reflect that `SPIRVEmitNonSemanticDI` is now always in the pipeline. --- Full diff: https://github.com/llvm/llvm-project/pull/187051.diff 10 Files Affected: - (modified) clang/lib/CodeGen/CGDebugInfo.cpp (+6-2) - (added) clang/test/CodeGenHLSL/debug/source-language.hlsl (+19) - (modified) llvm/docs/SPIRVUsage.rst (+5-3) - (modified) llvm/lib/Target/SPIRV/SPIRVTargetMachine.cpp (+6-5) - (modified) llvm/test/CodeGen/SPIRV/debug-info/debug-compilation-unit.ll (+2-2) - (modified) llvm/test/CodeGen/SPIRV/debug-info/debug-type-basic.ll (+1-1) - (modified) llvm/test/CodeGen/SPIRV/debug-info/debug-type-pointer.ll (+1-1) - (added) llvm/test/CodeGen/SPIRV/debug-info/hlsl-debug-info-auto-activation.ll (+32) - (modified) llvm/test/CodeGen/SPIRV/hlsl-resources/SampleErrorsDebug.ll (+1-1) - (modified) llvm/test/CodeGen/SPIRV/llc-pipeline.ll (+2) ``````````diff diff --git a/clang/lib/CodeGen/CGDebugInfo.cpp b/clang/lib/CodeGen/CGDebugInfo.cpp index 0fd17b98570fc..449997ed41af0 100644 --- a/clang/lib/CodeGen/CGDebugInfo.cpp +++ b/clang/lib/CodeGen/CGDebugInfo.cpp @@ -694,7 +694,9 @@ static llvm::dwarf::SourceLanguage GetSourceLanguage(const CodeGenModule &CGM) { llvm::dwarf::SourceLanguage LangTag; if (LO.CPlusPlus) { - if (LO.HIP) + if (LO.HLSL) + LangTag = llvm::dwarf::DW_LANG_HLSL; + else if (LO.HIP) LangTag = llvm::dwarf::DW_LANG_HIP; else if (LO.ObjC) LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus; @@ -732,7 +734,9 @@ GetDISourceLanguageName(const CodeGenModule &CGM) { uint32_t LangVersion = 0; llvm::dwarf::SourceLanguageName LangTag; if (LO.CPlusPlus) { - if (LO.HIP) { + if (LO.HLSL) { + LangTag = llvm::dwarf::DW_LNAME_HLSL; + } else if (LO.HIP) { LangTag = llvm::dwarf::DW_LNAME_HIP; } else if (LO.ObjC) { LangTag = llvm::dwarf::DW_LNAME_ObjC_plus_plus; diff --git a/clang/test/CodeGenHLSL/debug/source-language.hlsl b/clang/test/CodeGenHLSL/debug/source-language.hlsl new file mode 100644 index 0000000000000..1cdf29b854eed --- /dev/null +++ b/clang/test/CodeGenHLSL/debug/source-language.hlsl @@ -0,0 +1,19 @@ +// Verify that HLSL shaders are tagged with DW_LANG_HLSL in the debug compile +// unit. + +// DXIL target +// RUN: %clang_cc1 -triple dxil-pc-shadermodel6.3-compute -x hlsl -emit-llvm \ +// RUN: -disable-llvm-passes -hlsl-entry main \ +// RUN: -debug-info-kind=standalone -dwarf-version=4 -o - %s \ +// RUN: | FileCheck %s + +// SPIR-V target +// RUN: %clang_cc1 -triple spirv-unknown-vulkan-compute -x hlsl -emit-llvm \ +// RUN: -disable-llvm-passes -hlsl-entry main \ +// RUN: -debug-info-kind=standalone -dwarf-version=4 -o - %s \ +// RUN: | FileCheck %s + +// CHECK: !DICompileUnit(language: DW_LANG_HLSL, +// CHECK-NOT: !DICompileUnit(language: DW_LANG_C_plus_plus + +[numthreads(1, 1, 1)] void main() {} diff --git a/llvm/docs/SPIRVUsage.rst b/llvm/docs/SPIRVUsage.rst index 9a4478f57e802..75a477b86da05 100644 --- a/llvm/docs/SPIRVUsage.rst +++ b/llvm/docs/SPIRVUsage.rst @@ -33,9 +33,11 @@ Static Compiler Commands Command: `llc -O1 -mtriple=spirv64-unknown-unknown --spirv-ext=+SPV_ALTERA_arbitrary_precision_integers input.ll -o output.spvt` Description: Compiles an LLVM IL file to SPIR-V with (`-O1`) optimizations, targeting a 64-bit architecture. It enables the SPV_ALTERA_arbitrary_precision_integers extension. -3. **Compilation with experimental NonSemantic.Shader.DebugInfo.100 support** - Command: `llc --spv-emit-nonsemantic-debug-info --spirv-ext=+SPV_KHR_non_semantic_info input.ll -o output.spvt` - Description: Compiles an LLVM IL file to SPIR-V with additional NonSemantic.Shader.DebugInfo.100 instructions. It enables the required SPV_KHR_non_semantic_info extension. +3. **Compilation with NonSemantic.Shader.DebugInfo support** + Command: `llc -g --spirv-ext=+SPV_KHR_non_semantic_info input.ll -o output.spvt` + Description: Compiles an LLVM IL file to SPIR-V with NonSemantic.Shader.DebugInfo.100 instructions. The ``-g`` flag causes the backend to emit NSDI instructions when the module contains debug metadata. The required SPV_KHR_non_semantic_info extension must be enabled explicitly. + + Note: ``--spv-emit-nonsemantic-debug-info`` is a deprecated synonym for ``-g`` and will be removed in a future release. 4. **SPIR-V Binary Generation** Command: `llc -O0 -mtriple=spirv64-unknown-unknown -filetype=obj input.ll -o output.spvt` diff --git a/llvm/lib/Target/SPIRV/SPIRVTargetMachine.cpp b/llvm/lib/Target/SPIRV/SPIRVTargetMachine.cpp index 1759b34af3e90..fa436af596b27 100644 --- a/llvm/lib/Target/SPIRV/SPIRVTargetMachine.cpp +++ b/llvm/lib/Target/SPIRV/SPIRVTargetMachine.cpp @@ -258,14 +258,15 @@ bool SPIRVPassConfig::addRegBankSelect() { static cl::opt<bool> SPVEnableNonSemanticDI( "spv-emit-nonsemantic-debug-info", - cl::desc("Emit SPIR-V NonSemantic.Shader.DebugInfo.100 instructions"), + cl::desc("Deprecated. Use -g to emit SPIR-V NonSemantic.Shader.DebugInfo " + "instructions"), cl::Optional, cl::init(false)); void SPIRVPassConfig::addPreEmitPass() { - if (SPVEnableNonSemanticDI || - getSPIRVTargetMachine().getTargetTriple().getVendor() == Triple::AMD) { - addPass(createSPIRVEmitNonSemanticDIPass(&getTM<SPIRVTargetMachine>())); - } + // The SPIRVEmitNonSemanticDI pass self-activates when the module contains + // debug info (llvm.dbg.cu). --spv-emit-nonsemantic-debug-info is a + // deprecated synonym for -g. + addPass(createSPIRVEmitNonSemanticDIPass(&getTM<SPIRVTargetMachine>())); } namespace { diff --git a/llvm/test/CodeGen/SPIRV/debug-info/debug-compilation-unit.ll b/llvm/test/CodeGen/SPIRV/debug-info/debug-compilation-unit.ll index 54eb0e45dccee..fd2f46590f103 100644 --- a/llvm/test/CodeGen/SPIRV/debug-info/debug-compilation-unit.ll +++ b/llvm/test/CodeGen/SPIRV/debug-info/debug-compilation-unit.ll @@ -30,8 +30,8 @@ ; CHECK-SPIRV: [[debug_source_cpp:%[0-9]+]] = OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugSource [[filename_str_cpp]] ; CHECK-SPIRV: OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugCompilationUnit [[debug_info_version]] [[dwarf_version]] [[debug_source_cpp]] [[source_language_cpp]] -; CHECK-OPTION-NOT: OpExtInstImport "NonSemantic.Shader.DebugInfo.100" -; CHECK-OPTION-NOT: OpString "/AAAAAAAAAA/BBBBBBBB/CCCCCCCCC{{[/\\]}}example.c" +; CHECK-OPTION: OpExtInstImport "NonSemantic.Shader.DebugInfo.100" +; CHECK-OPTION: OpString "/AAAAAAAAAA/BBBBBBBB/CCCCCCCCC{{[/\\]}}example.c" define spir_func void @foo() { entry: diff --git a/llvm/test/CodeGen/SPIRV/debug-info/debug-type-basic.ll b/llvm/test/CodeGen/SPIRV/debug-info/debug-type-basic.ll index c678d9ce350a2..04aa85008d47c 100644 --- a/llvm/test/CodeGen/SPIRV/debug-info/debug-type-basic.ll +++ b/llvm/test/CodeGen/SPIRV/debug-info/debug-type-basic.ll @@ -82,7 +82,7 @@ ; CHECK-SPIRV-DAG: OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugTypeBasic [[str_float]] [[size_32bit]] [[encoding_float]] [[flag_zero]] ; CHECK-SPIRV-DAG: OpExtInst [[type_void]] [[ext_inst_non_semantic]] DebugTypeBasic [[str_double]] [[size_64bit]] [[encoding_float]] [[flag_zero]] -; CHECK-OPTION-NOT: DebugTypeBasic +; CHECK-OPTION: DebugTypeBasic define spir_func void @test1() !dbg !9 { entry: diff --git a/llvm/test/CodeGen/SPIRV/debug-info/debug-type-pointer.ll b/llvm/test/CodeGen/SPIRV/debug-info/debug-type-pointer.ll index 9cdcd6db6cde8..f2d7440ae7a65 100644 --- a/llvm/test/CodeGen/SPIRV/debug-info/debug-type-pointer.ll +++ b/llvm/test/CodeGen/SPIRV/debug-info/debug-type-pointer.ll @@ -81,7 +81,7 @@ ; CHECK-SPIRV-DAG: [[debug_info_none:%[0-9]+]] = OpExtInst {{%[0-9]+ %[0-9]+}} DebugInfoNone ; CHECK-SPIRV-DAG: OpExtInst {{%[0-9]+ %[0-9]+}} DebugTypePointer [[debug_info_none]] [[i32_5]] [[i32_0]] -; CHECK-OPTION-NOT: DebugTypePointer +; CHECK-OPTION: DebugTypePointer @gi0 = dso_local addrspace(1) global ptr addrspace(4) null, align 4, !dbg !0 @gv0 = dso_local addrspace(1) global ptr addrspace(4) null, align 4, !dbg !5 diff --git a/llvm/test/CodeGen/SPIRV/debug-info/hlsl-debug-info-auto-activation.ll b/llvm/test/CodeGen/SPIRV/debug-info/hlsl-debug-info-auto-activation.ll new file mode 100644 index 0000000000000..1f123dd4b317a --- /dev/null +++ b/llvm/test/CodeGen/SPIRV/debug-info/hlsl-debug-info-auto-activation.ll @@ -0,0 +1,32 @@ +; Verify that the NSDI pass activates automatically when the module contains +; debug info (llvm.dbg.cu) without requiring --spv-emit-nonsemantic-debug-info. +; The language constant in DebugCompilationUnit must be 5 (HLSL). + +; RUN: llc --verify-machineinstrs --spirv-ext=+SPV_KHR_non_semantic_info \ +; RUN: -O0 -mtriple=spirv64-unknown-unknown %s -o - \ +; RUN: | FileCheck %s +; RUN: %if spirv-tools %{ llc --verify-machineinstrs \ +; RUN: --spirv-ext=+SPV_KHR_non_semantic_info \ +; RUN: -O0 -mtriple=spirv64-unknown-unknown %s -o - -filetype=obj \ +; RUN: | spirv-val %} + +; CHECK: OpExtension "SPV_KHR_non_semantic_info" +; CHECK: [[ext_inst:%[0-9]+]] = OpExtInstImport "NonSemantic.Shader.DebugInfo.100" +; CHECK-DAG: [[type_void:%[0-9]+]] = OpTypeVoid +; CHECK-DAG: [[type_i32:%[0-9]+]] = OpTypeInt 32 0 +; CHECK-DAG: [[lang_hlsl:%[0-9]+]] = OpConstant [[type_i32]] 5 +; CHECK: OpExtInst [[type_void]] [[ext_inst]] DebugCompilationUnit +; CHECK-SAME: [[lang_hlsl]] + +define spir_func void @main() { +entry: + ret void +} + +!llvm.dbg.cu = !{!0} +!llvm.module.flags = !{!2, !3} + +!0 = distinct !DICompileUnit(language: DW_LANG_HLSL, file: !1, producer: "clang", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None) +!1 = !DIFile(filename: "shader.hlsl", directory: "/src") +!2 = !{i32 7, !"Dwarf Version", i32 5} +!3 = !{i32 2, !"Debug Info Version", i32 3} diff --git a/llvm/test/CodeGen/SPIRV/hlsl-resources/SampleErrorsDebug.ll b/llvm/test/CodeGen/SPIRV/hlsl-resources/SampleErrorsDebug.ll index 26f7194104e18..b443c70e7b17e 100644 --- a/llvm/test/CodeGen/SPIRV/hlsl-resources/SampleErrorsDebug.ll +++ b/llvm/test/CodeGen/SPIRV/hlsl-resources/SampleErrorsDebug.ll @@ -1,4 +1,4 @@ -; RUN: not llc -O0 -mtriple=spirv-vulkan-compute %s -o /dev/null 2>&1 | FileCheck %s +; RUN: not llc -O0 -mtriple=spirv-vulkan-compute --spirv-ext=+SPV_KHR_non_semantic_info %s -o /dev/null 2>&1 | FileCheck %s ; CHECK: error: SampleErrorsDebug.ll:24:10: Non-constant offsets are not supported in sample instructions. diff --git a/llvm/test/CodeGen/SPIRV/llc-pipeline.ll b/llvm/test/CodeGen/SPIRV/llc-pipeline.ll index cad07e2557614..2654e146fd69b 100644 --- a/llvm/test/CodeGen/SPIRV/llc-pipeline.ll +++ b/llvm/test/CodeGen/SPIRV/llc-pipeline.ll @@ -77,6 +77,7 @@ ; SPIRV-O0-NEXT: Analyze Machine Code For Garbage Collection ; SPIRV-O0-NEXT: Insert fentry calls ; SPIRV-O0-NEXT: Insert XRay ops +; SPIRV-O0-NEXT: SPIRV NonSemantic.Shader.DebugInfo.100 emitter ; SPIRV-O0-NEXT: Machine Sanitizer Binary Metadata ; SPIRV-O0-NEXT: Lazy Machine Block Frequency Analysis ; SPIRV-O0-NEXT: Machine Optimization Remark Emitter @@ -215,6 +216,7 @@ ; SPIRV-Opt-NEXT: Analyze Machine Code For Garbage Collection ; SPIRV-Opt-NEXT: Insert fentry calls ; SPIRV-Opt-NEXT: Insert XRay ops +; SPIRV-Opt-NEXT: SPIRV NonSemantic.Shader.DebugInfo.100 emitter ; SPIRV-Opt-NEXT: Machine Sanitizer Binary Metadata ; SPIRV-Opt-NEXT: Lazy Machine Block Frequency Analysis ; SPIRV-Opt-NEXT: Machine Optimization Remark Emitter `````````` </details> https://github.com/llvm/llvm-project/pull/187051 _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
