Skip to content

Commit c4d599d

Browse files
committed
[llvm-debuginfo-analyzer] Add support for parsing DWARF / CodeView source language
1 parent d401987 commit c4d599d

25 files changed

+106
-3
lines changed

llvm/include/llvm/DebugInfo/LogicalView/Core/LVElement.h

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,13 @@
1414
#ifndef LLVM_DEBUGINFO_LOGICALVIEW_CORE_LVELEMENT_H
1515
#define LLVM_DEBUGINFO_LOGICALVIEW_CORE_LVELEMENT_H
1616

17+
#include "llvm/BinaryFormat/Dwarf.h"
18+
#include "llvm/DebugInfo/CodeView/CodeView.h"
1719
#include "llvm/DebugInfo/LogicalView/Core/LVObject.h"
1820
#include "llvm/Support/Casting.h"
1921
#include <map>
2022
#include <set>
23+
#include <variant>
2124
#include <vector>
2225

2326
namespace llvm {
@@ -64,6 +67,22 @@ using LVElementKindSet = std::set<LVElementKind>;
6467
using LVElementDispatch = std::map<LVElementKind, LVElementGetFunction>;
6568
using LVElementRequest = std::vector<LVElementGetFunction>;
6669

70+
/// A source language supported by any of the debug info representations.
71+
struct LVSourceLanguage {
72+
LVSourceLanguage() = default;
73+
LVSourceLanguage(llvm::dwarf::SourceLanguage SL) : Language(SL) {}
74+
LVSourceLanguage(llvm::codeview::SourceLanguage SL) : Language(SL) {}
75+
76+
bool isValid() const { return Language.index() != 0; }
77+
template <typename T> T getAs() { return std::get<T>(Language); }
78+
StringRef getName() const;
79+
80+
private:
81+
std::variant<std::monostate, llvm::dwarf::SourceLanguage,
82+
llvm::codeview::SourceLanguage>
83+
Language;
84+
};
85+
6786
class LVElement : public LVObject {
6887
enum class Property {
6988
IsLine, // A logical line.
@@ -214,6 +233,9 @@ class LVElement : public LVObject {
214233
virtual StringRef getProducer() const { return StringRef(); }
215234
virtual void setProducer(StringRef ProducerName) {}
216235

236+
virtual LVSourceLanguage getSourceLanguage() const { return {}; }
237+
virtual void setSourceLanguage(LVSourceLanguage SL) {}
238+
217239
virtual bool isCompileUnit() const { return false; }
218240
virtual bool isRoot() const { return false; }
219241

llvm/include/llvm/DebugInfo/LogicalView/Core/LVScope.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,9 @@ class LVScopeCompileUnit final : public LVScope {
407407
// Toolchain producer.
408408
size_t ProducerIndex = 0;
409409

410+
// Source language.
411+
LVSourceLanguage SourceLanguage{};
412+
410413
// Compilation directory name.
411414
size_t CompilationDirectoryIndex = 0;
412415

@@ -540,6 +543,9 @@ class LVScopeCompileUnit final : public LVScope {
540543
ProducerIndex = getStringPool().getIndex(ProducerName);
541544
}
542545

546+
LVSourceLanguage getSourceLanguage() const override { return SourceLanguage; }
547+
void setSourceLanguage(LVSourceLanguage SL) override { SourceLanguage = SL; }
548+
543549
void setCPUType(codeview::CPUType Type) { CompilationCPUType = Type; }
544550
codeview::CPUType getCPUType() { return CompilationCPUType; }
545551

llvm/lib/DebugInfo/LogicalView/Core/LVElement.cpp

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
//===----------------------------------------------------------------------===//
1212

1313
#include "llvm/DebugInfo/LogicalView/Core/LVElement.h"
14+
#include "llvm/DebugInfo/CodeView/EnumTables.h"
1415
#include "llvm/DebugInfo/LogicalView/Core/LVReader.h"
1516
#include "llvm/DebugInfo/LogicalView/Core/LVScope.h"
1617
#include "llvm/DebugInfo/LogicalView/Core/LVSymbol.h"
@@ -20,6 +21,23 @@ using namespace llvm;
2021
using namespace llvm::codeview;
2122
using namespace llvm::logicalview;
2223

24+
StringRef LVSourceLanguage::getName() const {
25+
if (!isValid())
26+
return {};
27+
switch (Language.index()) {
28+
case 1: // DWARF
29+
return llvm::dwarf::LanguageString(
30+
std::get<llvm::dwarf::SourceLanguage>(Language));
31+
case 2: // CodeView
32+
{
33+
static auto LangNames = llvm::codeview::getSourceLanguageNames();
34+
return LangNames[std::get<llvm::codeview::SourceLanguage>(Language)].Name;
35+
}
36+
default:
37+
llvm_unreachable("Unsupported language");
38+
}
39+
}
40+
2341
#define DEBUG_TYPE "Element"
2442

2543
LVElementDispatch LVElement::Dispatch = {

llvm/lib/DebugInfo/LogicalView/Core/LVScope.cpp

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1707,11 +1707,17 @@ void LVScopeCompileUnit::print(raw_ostream &OS, bool Full) const {
17071707

17081708
void LVScopeCompileUnit::printExtra(raw_ostream &OS, bool Full) const {
17091709
OS << formattedKind(kind()) << " '" << getName() << "'\n";
1710-
if (options().getPrintFormatting() && options().getAttributeProducer())
1710+
if (options().getPrintFormatting() && options().getAttributeProducer()) {
17111711
printAttributes(OS, Full, "{Producer} ",
17121712
const_cast<LVScopeCompileUnit *>(this), getProducer(),
17131713
/*UseQuotes=*/true,
17141714
/*PrintRef=*/false);
1715+
if (auto SL = getSourceLanguage(); SL.isValid())
1716+
printAttributes(OS, Full, "{Language} ",
1717+
const_cast<LVScopeCompileUnit *>(this), SL.getName(),
1718+
/*UseQuotes=*/true,
1719+
/*PrintRef=*/false);
1720+
}
17151721

17161722
// Reset file index, to allow its children to print the correct filename.
17171723
options().resetFilenameIndex();

llvm/lib/DebugInfo/LogicalView/Readers/LVCodeViewVisitor.cpp

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -960,8 +960,11 @@ Error LVSymbolVisitor::visitKnownRecord(CVSymbol &Record,
960960
// The name of the CU, was extracted from the 'BuildInfo' subsection.
961961
Reader->setCompileUnitCPUType(Compile2.Machine);
962962
Scope->setName(CurrentObjectName);
963-
if (options().getAttributeProducer())
963+
if (options().getAttributeProducer()) {
964964
Scope->setProducer(Compile2.Version);
965+
Scope->setSourceLanguage(LVSourceLanguage{
966+
static_cast<llvm::codeview::SourceLanguage>(Compile2.getLanguage())});
967+
}
965968
getReader().isSystemEntry(Scope, CurrentObjectName);
966969

967970
// The line records in CodeView are recorded per Module ID. Update
@@ -1005,8 +1008,11 @@ Error LVSymbolVisitor::visitKnownRecord(CVSymbol &Record,
10051008
// The name of the CU, was extracted from the 'BuildInfo' subsection.
10061009
Reader->setCompileUnitCPUType(Compile3.Machine);
10071010
Scope->setName(CurrentObjectName);
1008-
if (options().getAttributeProducer())
1011+
if (options().getAttributeProducer()) {
10091012
Scope->setProducer(Compile3.Version);
1013+
Scope->setSourceLanguage(LVSourceLanguage{
1014+
static_cast<llvm::codeview::SourceLanguage>(Compile3.getLanguage())});
1015+
}
10101016
getReader().isSystemEntry(Scope, CurrentObjectName);
10111017

10121018
// The line records in CodeView are recorded per Module ID. Update

llvm/lib/DebugInfo/LogicalView/Readers/LVDWARFReader.cpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -377,6 +377,11 @@ void LVDWARFReader::processOneAttribute(const DWARFDie &Die,
377377
if (options().getAttributeProducer())
378378
CurrentElement->setProducer(dwarf::toStringRef(FormValue));
379379
break;
380+
case dwarf::DW_AT_language:
381+
if (options().getAttributeProducer())
382+
CurrentElement->setSourceLanguage(LVSourceLanguage{
383+
static_cast<llvm::dwarf::SourceLanguage>(GetAsUnsignedConstant())});
384+
break;
380385
case dwarf::DW_AT_upper_bound:
381386
CurrentElement->setUpperBound(GetBoundValue(FormValue));
382387
break;

llvm/test/tools/llvm-debuginfo-analyzer/COFF/02-coff-logical-lines.test

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
; ONE-EMPTY:
2727
; ONE-NEXT: [001] {CompileUnit} 'hello-world.cpp'
2828
; ONE-NEXT: [002] {Producer} 'clang version 15.0.0 {{.*}}'
29+
; ONE-NEXT: [002] {Language} 'Cpp'
2930
; ONE-NEXT: [002] {Function} extern not_inlined 'main' -> 'int'
3031
; ONE-NEXT: [003] 4 {Line}
3132
; ONE-NEXT: [003] {Code} 'subq $0x28, %rsp'
@@ -43,6 +44,7 @@
4344
; ONE-EMPTY:
4445
; ONE-NEXT: [001] {CompileUnit} 'hello-world.cpp'
4546
; ONE-NEXT: [002] {Producer} 'Microsoft (R) Optimizing Compiler'
47+
; ONE-NEXT: [002] {Language} 'Cpp'
4648
; ONE-NEXT: [002] {Function} extern not_inlined 'main' -> 'int'
4749
; ONE-NEXT: [003] 4 {Line}
4850
; ONE-NEXT: [003] {Code} 'subq $0x28, %rsp'

llvm/test/tools/llvm-debuginfo-analyzer/COFF/03-coff-incorrect-lexical-scope-typedef.test

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
; ONE-EMPTY:
4343
; ONE-NEXT: [001] {CompileUnit} 'pr-44884.cpp'
4444
; ONE-NEXT: [002] {Producer} 'clang version 15.0.0 {{.*}}'
45+
; ONE-NEXT: [002] {Language} 'Cpp'
4546
; ONE-NEXT: [002] {Function} extern not_inlined 'bar' -> 'int'
4647
; ONE-NEXT: [003] {Parameter} 'Input' -> 'float'
4748
; ONE-NEXT: [003] 1 {Line}
@@ -63,6 +64,7 @@
6364
; ONE-EMPTY:
6465
; ONE-NEXT: [001] {CompileUnit} 'pr-44884.cpp'
6566
; ONE-NEXT: [002] {Producer} 'Microsoft (R) Optimizing Compiler'
67+
; ONE-NEXT: [002] {Language} 'Cpp'
6668
; ONE-NEXT: [002] {Function} extern not_inlined 'bar' -> 'int'
6769
; ONE-NEXT: [003] {Variable} 'Input' -> 'float'
6870
; ONE-NEXT: [003] 1 {Line}

llvm/test/tools/llvm-debuginfo-analyzer/COFF/04-coff-missing-nested-enumerators.test

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
; ONE-EMPTY:
3838
; ONE-NEXT: [001] {CompileUnit} 'pr-46466.cpp'
3939
; ONE-NEXT: [002] {Producer} 'clang version 15.0.0 {{.*}}'
40+
; ONE-NEXT: [002] {Language} 'Cpp'
4041
; ONE-NEXT: [002] {Variable} extern 'S' -> 'Struct'
4142
; ONE-NEXT: [002] 1 {Struct} 'Struct'
4243
; ONE-NEXT: [003] {Member} public 'U' -> 'Union'
@@ -50,6 +51,7 @@
5051
; ONE-EMPTY:
5152
; ONE-NEXT: [001] {CompileUnit} 'pr-46466.cpp'
5253
; ONE-NEXT: [002] {Producer} 'Microsoft (R) Optimizing Compiler'
54+
; ONE-NEXT: [002] {Language} 'Cpp'
5355
; ONE-NEXT: [002] {Variable} extern 'S' -> 'Struct'
5456
; ONE-NEXT: [002] 1 {Struct} 'Struct'
5557
; ONE-NEXT: [003] {Member} public 'U' -> 'Union'

llvm/test/tools/llvm-debuginfo-analyzer/COFF/05-coff-incorrect-lexical-scope-variable.test

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
; ONE-EMPTY:
4444
; ONE-NEXT: [001] {CompileUnit} 'pr-43860.cpp'
4545
; ONE-NEXT: [002] {Producer} 'clang version 15.0.0 {{.*}}'
46+
; ONE-NEXT: [002] {Language} 'Cpp'
4647
; ONE-NEXT: [002] 2 {Function} inlined 'InlineFunction' -> 'int'
4748
; ONE-NEXT: [003] {Parameter} '' -> 'int'
4849
; ONE-NEXT: [002] {Function} extern not_inlined 'test' -> 'int'
@@ -59,6 +60,7 @@
5960
; ONE-EMPTY:
6061
; ONE-NEXT: [001] {CompileUnit} 'pr-43860.cpp'
6162
; ONE-NEXT: [002] {Producer} 'Microsoft (R) Optimizing Compiler'
63+
; ONE-NEXT: [002] {Language} 'Cpp'
6264
; ONE-NEXT: [002] {Function} extern declared_inlined 'InlineFunction' -> 'int'
6365
; ONE-NEXT: [003] {Block}
6466
; ONE-NEXT: [004] {Variable} 'Var_2' -> 'int'

0 commit comments

Comments
 (0)