Skip to content

Commit 9e234d9

Browse files
author
Jason Zheng
authored
Add mapping for DWARF language codes to SourceLanguage (#1074)
When translating from LLVM IR to SPIR-V, the SourceLanguage is currently set to the DWARF language value, which is wrong. This PR adds a mapping from DWARF language codes to the correct value in the SourceLanguage enum. Also comment out a test referring to C++ for OpenCL.
1 parent b3d0112 commit 9e234d9

File tree

6 files changed

+157
-2
lines changed

6 files changed

+157
-2
lines changed

‎lib/SPIRV/LLVMToSPIRVDbgTran.cpp‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,9 @@ LLVMToSPIRVDbgTran::transDbgCompilationUnit(const DICompileUnit *CU) {
496496
Ops[SPIRVDebugInfoVersionIdx] = SPIRVDebug::DebugInfoVersion;
497497
Ops[DWARFVersionIdx] = M->getDwarfVersion();
498498
Ops[SourceIdx] = getSource(CU)->getId();
499-
Ops[LanguageIdx] = CU->getSourceLanguage();
499+
auto DwarfLang =
500+
static_cast<llvm::dwarf::SourceLanguage>(CU->getSourceLanguage());
501+
Ops[LanguageIdx] = convertDWARFSourceLangToSPIRV(DwarfLang);
500502
BM->addModuleProcessed(SPIRVDebug::ProducerPrefix + CU->getProducer().str());
501503
// Cache CU in a member.
502504
SPIRVCU = static_cast<SPIRVExtInst *>(

‎lib/SPIRV/SPIRVToLLVMDbgTran.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ SPIRVToLLVMDbgTran::transCompileUnit(const SPIRVExtInst *DebugInst) {
126126
using namespace SPIRVDebug::Operand::CompilationUnit;
127127
assert(Ops.size() == OperandCount && "Invalid number of operands");
128128
M->addModuleFlag(llvm::Module::Max, "Dwarf Version", Ops[DWARFVersionIdx]);
129-
unsigned SourceLang = Ops[LanguageIdx];
129+
unsigned SourceLang = convertSPIRVSourceLangToDWARF(Ops[LanguageIdx]);
130130
auto Producer = findModuleProducer();
131131
CU = Builder.createCompileUnit(SourceLang, getFile(Ops[SourceIdx]), Producer,
132132
false, "", 0);

‎lib/SPIRV/libSPIRV/SPIRV.debug.h‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#ifndef SPIRV_DEBUG_H
22
#define SPIRV_DEBUG_H
33
#include "SPIRVUtil.h"
4+
#include "spirv.hpp"
45
#include "llvm/BinaryFormat/Dwarf.h"
56

67
namespace SPIRVDebug {
@@ -790,6 +791,44 @@ enum {
790791

791792
using namespace llvm;
792793

794+
inline spv::SourceLanguage convertDWARFSourceLangToSPIRV(dwarf::SourceLanguage DwarfLang) {
795+
switch (DwarfLang) {
796+
// When updating this function, make sure to also
797+
// update convertSPIRVSourceLangToDWARF()
798+
799+
// LLVM does not yet define DW_LANG_C_plus_plus_17
800+
// case dwarf::SourceLanguage::DW_LANG_C_plus_plus_17:
801+
case dwarf::SourceLanguage::DW_LANG_C_plus_plus_14:
802+
case dwarf::SourceLanguage::DW_LANG_C_plus_plus:
803+
return spv::SourceLanguage::SourceLanguageCPP_for_OpenCL;
804+
case dwarf::SourceLanguage::DW_LANG_C99:
805+
case dwarf::SourceLanguage::DW_LANG_OpenCL:
806+
return spv::SourceLanguage::SourceLanguageOpenCL_C;
807+
default:
808+
return spv::SourceLanguage::SourceLanguageUnknown;
809+
}
810+
}
811+
812+
inline dwarf::SourceLanguage convertSPIRVSourceLangToDWARF(unsigned SourceLang) {
813+
switch (SourceLang) {
814+
// When updating this function, make sure to also
815+
// update convertDWARFSourceLangToSPIRV()
816+
case spv::SourceLanguage::SourceLanguageOpenCL_CPP:
817+
return dwarf::SourceLanguage::DW_LANG_C_plus_plus_14;
818+
case spv::SourceLanguage::SourceLanguageCPP_for_OpenCL:
819+
// LLVM does not yet define DW_LANG_C_plus_plus_17
820+
// SourceLang = dwarf::SourceLanguage::DW_LANG_C_plus_plus_17;
821+
return dwarf::SourceLanguage::DW_LANG_C_plus_plus_14;
822+
case spv::SourceLanguage::SourceLanguageOpenCL_C:
823+
case spv::SourceLanguage::SourceLanguageESSL:
824+
case spv::SourceLanguage::SourceLanguageGLSL:
825+
case spv::SourceLanguage::SourceLanguageHLSL:
826+
case spv::SourceLanguage::SourceLanguageUnknown:
827+
default:
828+
return dwarf::DW_LANG_OpenCL;
829+
}
830+
}
831+
793832
namespace SPIRV {
794833
typedef SPIRVMap<dwarf::TypeKind, SPIRVDebug::EncodingTag> DbgEncodingMap;
795834
template <>

‎test/DebugInfo/SourceLanguageLLVMToSPIRV.ll‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
; Test checks that DW_LANG_C99 and DW_LANG_OpenCL are mapped to OpenCL C
2+
; in the SourceLanguage enum, and also that DW_LANG_C_plus_plus and
3+
; DW_LANG_C_plus_plus_14 are mapped to C++ for OpenCL.
4+
5+
; LLVM does not yet define DW_LANG_C_plus_plus_17. A test case that
6+
; checks DW_LANG_C_plus_plus_17 is mapped to C++ for OpenCL should be
7+
; added once this is defined.
8+
9+
; RUN: sed -e 's/INPUT_LANGUAGE/DW_LANG_C99/' %s | llvm-as - -o %t.bc
10+
; RUN: llvm-spirv -spirv-text %t.bc -o - | FileCheck %s --check-prefix=CHECK-OPENCLC
11+
12+
; RUN: sed -e 's/INPUT_LANGUAGE/DW_LANG_OpenCL/' %s | llvm-as - -o %t.bc
13+
; RUN: llvm-spirv -spirv-text %t.bc -o - | FileCheck %s --check-prefix=CHECK-OPENCLC
14+
15+
; RUN: sed -e 's/INPUT_LANGUAGE/DW_LANG_C_plus_plus/' %s | llvm-as - -o %t.bc
16+
; RUN: llvm-spirv -spirv-text %t.bc -o - | FileCheck %s --check-prefix=CHECK-CPP4OPENCL
17+
18+
; RUN: sed -e 's/INPUT_LANGUAGE/DW_LANG_C_plus_plus_14/' %s | llvm-as - -o %t.bc
19+
; RUN: llvm-spirv -spirv-text %t.bc -o - | FileCheck %s --check-prefix=CHECK-CPP4OPENCL
20+
21+
target datalayout = "e-i64:64-v16:16-v24:32-v32:32-v48:64-v96:128-v192:256-v256:256-v512:512-v1024:1024"
22+
target triple = "spir64-unknown-unknown"
23+
24+
define dso_local spir_kernel void @func() local_unnamed_addr !dbg !7 !kernel_arg_addr_space !2 !kernel_arg_access_qual !2 !kernel_arg_type !2 !kernel_arg_base_type !2 !kernel_arg_type_qual !2 {
25+
entry:
26+
ret void
27+
}
28+
29+
!llvm.dbg.cu = !{!0}
30+
!llvm.module.flags = !{!3, !4, !5}
31+
32+
!0 = distinct !DICompileUnit(language: INPUT_LANGUAGE, file: !1)
33+
!1 = !DIFile(filename: "test.cl", directory: "/tmp", checksumkind: CSK_MD5, checksum: "18aa9ce738eaafc7b7b7181c19092815")
34+
!2 = !{}
35+
!3 = !{i32 7, !"Dwarf Version", i32 5}
36+
!4 = !{i32 2, !"Debug Info Version", i32 3}
37+
!5 = !{i32 1, !"wchar_size", i32 4}
38+
!6 = !{i32 2, i32 0}
39+
!7 = distinct !DISubprogram(name: "func", scope: !8, file: !8, line: 1, scopeLine: 2, flags: DIFlagPrototyped | DIFlagAllCallsDescribed, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !0, retainedNodes: !2)
40+
!8 = !DIFile(filename: "test.cl", directory: "/tmp", checksumkind: CSK_MD5, checksum: "18aa9ce738eaafc7b7b7181c19092815")
41+
42+
; CHECK-OPENCLC: DebugCompileUnit {{[0-9]+}} {{[0-9]+}} {{[0-9]+}} 3
43+
; CHECK-CPP4OPENCL: DebugCompileUnit {{[0-9]+}} {{[0-9]+}} {{[0-9]+}} 6

‎test/DebugInfo/SourceLanguageSPIRVToLLVM.spvasm‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
; Test checks that:
2+
; - OpenCL_CPP is mapped to DW_LANG_C_plus_plus_14
3+
; - CPP_for_OpenCL is mapped to DW_LANG_C_plus_plus_17
4+
; - OpenCL_C, GLSL, ESSL, HLSL, and Unknown are mapped to DW_LANG_OpenCL
5+
6+
; LLVM does not yet define DW_LANG_C_plus_plus_17. When it is defined, the
7+
; test case for C++ for OpenCL should be updated to check that CPP_for_OpenCL
8+
; is mapped to DW_LANG_C_plus_plus_17, not DW_LANG_C_plus_plus_14.
9+
10+
; REQUIRES: spirv-as
11+
12+
; RUN: sed -e 's/SOURCE_LANGUAGE/OpenCL_CPP/' %s | spirv-as --target-env spv1.3 - -o %t.spv
13+
; RUN: llvm-spirv -r %t.spv -o - | llvm-dis | FileCheck %s --check-prefix=CHECK-CPP14
14+
15+
; COM: TODO: Enable this test when the version of SPIRV-Tools used by buildbot is updated to
16+
; COM: recognise CPP_for_OpenCL as a valid source language.
17+
; COM: sed -e 's/SOURCE_LANGUAGE/CPP_for_OpenCL/' %s | spirv-as --target-env spv1.3 - -o %t.spv
18+
; COM: llvm-spirv -r %t.spv -o - | llvm-dis | FileCheck %s --check-prefix=CHECK-CPP14
19+
20+
; RUN: sed -e 's/SOURCE_LANGUAGE/OpenCL_C/' %s | spirv-as --target-env spv1.3 - -o %t.spv
21+
; RUN: llvm-spirv -r %t.spv -o - | llvm-dis | FileCheck %s --check-prefix=CHECK-OPENCL
22+
23+
; RUN: sed -e 's/SOURCE_LANGUAGE/GLSL/' %s | spirv-as --target-env spv1.3 - -o %t.spv
24+
; RUN: llvm-spirv -r %t.spv -o - | llvm-dis | FileCheck %s --check-prefix=CHECK-OPENCL
25+
26+
; RUN: sed -e 's/SOURCE_LANGUAGE/HLSL/' %s | spirv-as --target-env spv1.3 - -o %t.spv
27+
; RUN: llvm-spirv -r %t.spv -o - | llvm-dis | FileCheck %s --check-prefix=CHECK-OPENCL
28+
29+
; RUN: sed -e 's/SOURCE_LANGUAGE/ESSL/' %s | spirv-as --target-env spv1.3 - -o %t.spv
30+
; RUN: llvm-spirv -r %t.spv -o - | llvm-dis | FileCheck %s --check-prefix=CHECK-OPENCL
31+
32+
; RUN: sed -e 's/SOURCE_LANGUAGE/Unknown/' %s | spirv-as --target-env spv1.3 - -o %t.spv
33+
; RUN: llvm-spirv -r %t.spv -o - | llvm-dis | FileCheck %s --check-prefix=CHECK-OPENCL
34+
35+
; SPIR-V
36+
; Version: 1.1
37+
; Generator: Khronos LLVM/SPIR-V Translator; 14
38+
; Bound: 16
39+
; Schema: 0
40+
OpCapability Addresses
41+
OpCapability Kernel
42+
%1 = OpExtInstImport "OpenCL.std"
43+
%2 = OpExtInstImport "OpenCL.DebugInfo.100"
44+
OpMemoryModel Physical64 OpenCL
45+
OpEntryPoint Kernel %5 "func"
46+
%7 = OpString "kernel_arg_type.func."
47+
%8 = OpString "/tmp/test.cl"
48+
%9 = OpString "//__CSK_MD5:18aa9ce738eaafc7b7b7181c19092815"
49+
%12 = OpString "func"
50+
%14 = OpString ""
51+
OpSource Unknown 0
52+
OpName %entry "entry"
53+
OpModuleProcessed "Debug info producer: "
54+
%void = OpTypeVoid
55+
%4 = OpTypeFunction %void
56+
%10 = OpExtInst %void %2 DebugSource %8 %9
57+
%11 = OpExtInst %void %2 DebugCompilationUnit 65536 5 %10 SOURCE_LANGUAGE
58+
%13 = OpExtInst %void %2 DebugInfoNone
59+
%15 = OpExtInst %void %2 DebugFunction %12 %13 %10 1 0 %11 %14 FlagIsDefinition|FlagPrototyped|FlagIsOptimized 2 %5 %13
60+
%5 = OpFunction %void None %4
61+
%entry = OpLabel
62+
OpReturn
63+
OpFunctionEnd
64+
65+
; CHECK-OPENCL: !DICompileUnit(language: DW_LANG_OpenCL,
66+
; CHECK-CPP14: !DICompileUnit(language: DW_LANG_C_plus_plus_14,

‎test/FortranArray.ll‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
; RUN: llvm-spirv -r %t.spv -o %t.rev.bc
66
; RUN: llvm-dis %t.rev.bc -o - | FileCheck %s --check-prefix=CHECK-LLVM
77

8+
; XFAIL: *
9+
; The language ID is not preserved when translating from .ll to .spv
10+
; and back to .ll. This causes the LLVM IR verifier to fail as there
11+
; are different rules for valid DISubRange depending on language ID.
12+
813
; CHECK-LLVM: !DISubrange(lowerBound: 1)
914

1015
source_filename = "llvm-link"

0 commit comments

Comments
 (0)