LLVM 20.0.0git
DwarfFile.h
Go to the documentation of this file.
1//===- llvm/CodeGen/DwarfFile.h - Dwarf Debug Framework ---------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H
10#define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H
11
12#include "DwarfStringPool.h"
13#include "llvm/ADT/DenseMap.h"
15#include "llvm/ADT/StringRef.h"
16#include "llvm/CodeGen/DIE.h"
18#include <map>
19#include <memory>
20#include <utility>
21
22namespace llvm {
23
24class AsmPrinter;
25class DbgEntity;
26class DbgVariable;
27class DbgLabel;
28class DINode;
29class DILocalScope;
30class DwarfCompileUnit;
31class DwarfUnit;
32class LexicalScope;
33class MCSection;
34class MDNode;
35
36// Data structure to hold a range for range lists.
37struct RangeSpan {
39 const MCSymbol *End;
40
41 bool operator==(const RangeSpan &Other) const {
42 return Begin == Other.Begin && End == Other.End;
43 }
44};
45
47 // Index for locating within the debug_range section this particular span.
50 // List of ranges.
52};
53
54class DwarfFile {
55 // Target of Dwarf emission, used for sizing of abbreviations.
56 AsmPrinter *Asm;
57
58 BumpPtrAllocator AbbrevAllocator;
59
60 // Used to uniquely define abbreviations.
61 DIEAbbrevSet Abbrevs;
62
63 // A pointer to all units in the section.
65
66 DwarfStringPool StrPool;
67
68 // List of range lists for a given compile unit, separate from the ranges for
69 // the CU itself.
71
72 /// DWARF v5: The symbol that designates the start of the contribution to
73 /// the string offsets table. The contribution is shared by all units.
74 MCSymbol *StringOffsetsStartSym = nullptr;
75
76 /// DWARF v5: The symbol that designates the base of the range list table.
77 /// The table is shared by all units.
78 MCSymbol *RnglistsTableBaseSym = nullptr;
79
80 /// The variables of a lexical scope.
81 struct ScopeVars {
82 /// We need to sort Args by ArgNo and check for duplicates. This could also
83 /// be implemented as a list or vector + std::lower_bound().
84 std::map<unsigned, DbgVariable *> Args;
86 };
87 /// Collection of DbgVariables of each lexical scope.
89
90 /// Collection of DbgLabels of each lexical scope.
93
94 // Collection of abstract subprogram DIEs.
95 DenseMap<const DILocalScope *, DIE *> AbstractLocalScopeDIEs;
97
98 /// Maps MDNodes for type system with the corresponding DIEs. These DIEs can
99 /// be shared across CUs, that is why we keep the map here instead
100 /// of in DwarfCompileUnit.
101 DenseMap<const MDNode *, DIE *> DITypeNodeToDieMap;
102
103public:
105
107 return CUs;
108 }
109
110 std::pair<uint32_t, RangeSpanList *> addRange(const DwarfCompileUnit &CU,
112
113 /// getRangeLists - Get the vector of range lists.
115 return CURangeLists;
116 }
117
118 /// Compute the size and offset of a DIE given an incoming Offset.
119 unsigned computeSizeAndOffset(DIE &Die, unsigned Offset);
120
121 /// Compute the size and offset of all the DIEs.
123
124 /// Compute the size and offset of all the DIEs in the given unit.
125 /// \returns The size of the root DIE.
127
128 /// Add a unit to the list of CUs.
129 void addUnit(std::unique_ptr<DwarfCompileUnit> U);
130
131 /// Emit all of the units to the section listed with the given
132 /// abbreviation section.
133 void emitUnits(bool UseOffsets);
134
135 /// Emit the given unit to its section.
136 void emitUnit(DwarfUnit *TheU, bool UseOffsets);
137
138 /// Emit a set of abbreviations to the specific section.
139 void emitAbbrevs(MCSection *);
140
141 /// Emit all of the strings to the section given. If OffsetSection is
142 /// non-null, emit a table of string offsets to it. If UseRelativeOffsets
143 /// is false, emit absolute offsets to the strings. Otherwise, emit
144 /// relocatable references to the strings if they are supported by the target.
145 void emitStrings(MCSection *StrSection, MCSection *OffsetSection = nullptr,
146 bool UseRelativeOffsets = false);
147
148 /// Returns the string pool.
149 DwarfStringPool &getStringPool() { return StrPool; }
150
151 MCSymbol *getStringOffsetsStartSym() const { return StringOffsetsStartSym; }
152 void setStringOffsetsStartSym(MCSymbol *Sym) { StringOffsetsStartSym = Sym; }
153
154 MCSymbol *getRnglistsTableBaseSym() const { return RnglistsTableBaseSym; }
155 void setRnglistsTableBaseSym(MCSymbol *Sym) { RnglistsTableBaseSym = Sym; }
156
158
159 void addScopeLabel(LexicalScope *LS, DbgLabel *Label);
160
162 return ScopeVariables;
163 }
164
166 return ScopeLabels;
167 }
168
170 return AbstractLocalScopeDIEs;
171 }
172
174 return AbstractEntities;
175 }
176
177 void insertDIE(const MDNode *TypeMD, DIE *Die) {
178 DITypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
179 }
180
181 DIE *getDIE(const MDNode *TypeMD) {
182 return DITypeNodeToDieMap.lookup(TypeMD);
183 }
184};
185
186} // end namespace llvm
187
188#endif // LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H
This file defines the BumpPtrAllocator interface.
This file defines the DenseMap class.
Symbol * Sym
Definition: ELF_riscv.cpp:479
This file defines the SmallVector class.
This class is intended to be used as a driving class for all asm writers.
Definition: AsmPrinter.h:86
Allocate memory in an ever growing pool, as if by bump-pointer.
Definition: Allocator.h:66
Helps unique DIEAbbrev objects and assigns abbreviation numbers.
Definition: DIE.h:140
A structured debug information entry.
Definition: DIE.h:819
This class is used to track label information.
Definition: DwarfDebug.h:289
This class is used to track local variable information.
Definition: DwarfDebug.h:214
ValueT lookup(const_arg_type_t< KeyT > Val) const
lookup - Return the entry for the specified key, or a default constructed value if no such entry exis...
Definition: DenseMap.h:194
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition: DenseMap.h:211
unsigned computeSizeAndOffset(DIE &Die, unsigned Offset)
Compute the size and offset of a DIE given an incoming Offset.
Definition: DwarfFile.cpp:92
void addScopeLabel(LexicalScope *LS, DbgLabel *Label)
Definition: DwarfFile.cpp:117
void addUnit(std::unique_ptr< DwarfCompileUnit > U)
Add a unit to the list of CUs.
Definition: DwarfFile.cpp:23
void computeSizeAndOffsets()
Compute the size and offset of all the DIEs.
Definition: DwarfFile.cpp:57
void setRnglistsTableBaseSym(MCSymbol *Sym)
Definition: DwarfFile.h:155
DenseMap< LexicalScope *, ScopeVars > & getScopeVariables()
Definition: DwarfFile.h:161
DenseMap< const DINode *, std::unique_ptr< DbgEntity > > & getAbstractEntities()
Definition: DwarfFile.h:173
unsigned computeSizeAndOffsetsForUnit(DwarfUnit *TheU)
Compute the size and offset of all the DIEs in the given unit.
Definition: DwarfFile.cpp:80
void emitUnits(bool UseOffsets)
Emit all of the units to the section listed with the given abbreviation section.
Definition: DwarfFile.cpp:29
void emitUnit(DwarfUnit *TheU, bool UseOffsets)
Emit the given unit to its section.
Definition: DwarfFile.cpp:34
const SmallVectorImpl< RangeSpanList > & getRangeLists() const
getRangeLists - Get the vector of range lists.
Definition: DwarfFile.h:114
MCSymbol * getStringOffsetsStartSym() const
Definition: DwarfFile.h:151
MCSymbol * getRnglistsTableBaseSym() const
Definition: DwarfFile.h:154
DwarfStringPool & getStringPool()
Returns the string pool.
Definition: DwarfFile.h:149
void emitAbbrevs(MCSection *)
Emit a set of abbreviations to the specific section.
Definition: DwarfFile.cpp:97
void emitStrings(MCSection *StrSection, MCSection *OffsetSection=nullptr, bool UseRelativeOffsets=false)
Emit all of the strings to the section given.
Definition: DwarfFile.cpp:100
DenseMap< LexicalScope *, LabelList > & getScopeLabels()
Definition: DwarfFile.h:165
void addScopeVariable(LexicalScope *LS, DbgVariable *Var)
Definition: DwarfFile.cpp:105
std::pair< uint32_t, RangeSpanList * > addRange(const DwarfCompileUnit &CU, SmallVector< RangeSpan, 2 > R)
Definition: DwarfFile.cpp:123
DenseMap< const DILocalScope *, DIE * > & getAbstractScopeDIEs()
Definition: DwarfFile.h:169
void setStringOffsetsStartSym(MCSymbol *Sym)
Definition: DwarfFile.h:152
const SmallVectorImpl< std::unique_ptr< DwarfCompileUnit > > & getUnits()
Definition: DwarfFile.h:106
void insertDIE(const MDNode *TypeMD, DIE *Die)
Definition: DwarfFile.h:177
DIE * getDIE(const MDNode *TypeMD)
Definition: DwarfFile.h:181
This dwarf writer support class manages information associated with a source file.
Definition: DwarfUnit.h:35
LexicalScope - This class is used to track scope information.
Definition: LexicalScopes.h:44
Instances of this class represent a uniqued identifier for a section in the current translation unit.
Definition: MCSection.h:36
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
Metadata node.
Definition: Metadata.h:1069
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: SmallVector.h:573
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1196
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:51
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Offset
Definition: DWP.cpp:480
@ Other
Any other memory.
const DwarfCompileUnit * CU
Definition: DwarfFile.h:49
SmallVector< RangeSpan, 2 > Ranges
Definition: DwarfFile.h:51
MCSymbol * Label
Definition: DwarfFile.h:48
bool operator==(const RangeSpan &Other) const
Definition: DwarfFile.h:41
const MCSymbol * End
Definition: DwarfFile.h:39
const MCSymbol * Begin
Definition: DwarfFile.h:38