LLVM  4.0.0
DwarfCompileUnit.h
Go to the documentation of this file.
1 //===-- llvm/CodeGen/DwarfCompileUnit.h - Dwarf Compile Unit ---*- C++ -*--===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains support for writing dwarf compile unit.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
16 
17 #include "DwarfUnit.h"
18 #include "llvm/IR/DebugInfo.h"
19 #include "llvm/Support/Dwarf.h"
20 
21 namespace llvm {
22 
23 class StringRef;
24 class AsmPrinter;
25 class DIE;
26 class DwarfDebug;
27 class DwarfFile;
28 class MCSymbol;
29 class LexicalScope;
30 
31 class DwarfCompileUnit : public DwarfUnit {
32  /// A numeric ID unique among all CUs in the module
33  unsigned UniqueID;
34 
35  /// The attribute index of DW_AT_stmt_list in the compile unit DIE, avoiding
36  /// the need to search for it in applyStmtList.
37  DIE::value_iterator StmtListValue;
38 
39  /// Skeleton unit associated with this unit.
40  DwarfCompileUnit *Skeleton;
41 
42  /// The start of the unit within its section.
43  MCSymbol *LabelBegin;
44 
45  /// The start of the unit macro info within macro section.
46  MCSymbol *MacroLabelBegin;
47 
51 
52  ImportedEntityMap ImportedEntities;
53 
54  /// GlobalNames - A map of globally visible named entities for this unit.
55  StringMap<const DIE *> GlobalNames;
56 
57  /// GlobalTypes - A map of globally visible types for this unit.
58  StringMap<const DIE *> GlobalTypes;
59 
60  // List of range lists for a given compile unit, separate from the ranges for
61  // the CU itself.
62  SmallVector<RangeSpanList, 1> CURangeLists;
63 
64  // List of ranges for a given compile unit.
66 
67  // The base address of this unit, if any. Used for relative references in
68  // ranges/locs.
69  const MCSymbol *BaseAddress;
70 
71  /// \brief Construct a DIE for the given DbgVariable without initializing the
72  /// DbgVariable's DIE reference.
73  DIE *constructVariableDIEImpl(const DbgVariable &DV, bool Abstract);
74 
75  bool isDwoUnit() const override;
76 
77  bool includeMinimalInlineScopes() const;
78 
79 public:
80  DwarfCompileUnit(unsigned UID, const DICompileUnit *Node, AsmPrinter *A,
81  DwarfDebug *DW, DwarfFile *DWU);
82 
83  unsigned getUniqueID() const { return UniqueID; }
84 
86  return Skeleton;
87  }
88 
89  void initStmtList();
90 
91  /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
92  void applyStmtList(DIE &D);
93 
94  /// A pair of GlobalVariable and DIExpression.
95  struct GlobalExpr {
98  };
99 
100  /// Get or create global variable DIE.
101  DIE *
103  ArrayRef<GlobalExpr> GlobalExprs);
104 
105  /// addLabelAddress - Add a dwarf label attribute data and value using
106  /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
108  const MCSymbol *Label);
109 
110  /// addLocalLabelAddress - Add a dwarf label attribute data and value using
111  /// DW_FORM_addr only.
113  const MCSymbol *Label);
114 
115  /// addSectionDelta - Add a label delta attribute data and value.
117  const MCSymbol *Hi, const MCSymbol *Lo);
118 
119  DwarfCompileUnit &getCU() override { return *this; }
120 
121  unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
122 
124  DIScope *Scope = IE->getScope();
125  assert(Scope && "Invalid Scope encoding!");
126  if (!isa<DILocalScope>(Scope))
127  // No need to add imported enities that are not local declaration.
128  return;
129 
130  auto *LocalScope = cast<DILocalScope>(Scope)->getNonLexicalBlockFileScope();
131  ImportedEntities[LocalScope].push_back(IE);
132  }
133 
134  /// addRange - Add an address range to the list of ranges for this unit.
135  void addRange(RangeSpan Range);
136 
137  void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
138 
139  /// addSectionLabel - Add a Dwarf section label attribute data and value.
140  ///
142  const MCSymbol *Label,
143  const MCSymbol *Sec);
144 
145  /// \brief Find DIE for the given subprogram and attach appropriate
146  /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
147  /// variables in this scope then create and insert DIEs for these
148  /// variables.
150 
151  void constructScopeDIE(LexicalScope *Scope,
152  SmallVectorImpl<DIE *> &FinalChildren);
153 
154  /// \brief A helper function to construct a RangeSpanList for a given
155  /// lexical scope.
156  void addScopeRangeList(DIE &ScopeDIE, SmallVector<RangeSpan, 2> Range);
157 
159 
161  const SmallVectorImpl<InsnRange> &Ranges);
162  /// \brief This scope represents inlined body of a function. Construct
163  /// DIE to represent this concrete inlined copy of the function.
165 
166  /// \brief Construct new DW_TAG_lexical_block for this scope and
167  /// attach DW_AT_low_pc/DW_AT_high_pc labels.
169 
170  /// constructVariableDIE - Construct a DIE for the given DbgVariable.
171  DIE *constructVariableDIE(DbgVariable &DV, bool Abstract = false);
172 
174  DIE *&ObjectPointer);
175 
176  /// A helper function to create children of a Scope DIE.
178  SmallVectorImpl<DIE *> &Children,
179  unsigned *ChildScopeCount = nullptr);
180 
181  /// \brief Construct a DIE for this subprogram scope.
182  void constructSubprogramScopeDIE(const DISubprogram *Sub, LexicalScope *Scope);
183 
184  DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
185 
187 
188  /// \brief Construct import_module DIE.
190 
192 
193  /// Set the skeleton unit associated with this unit.
194  void setSkeleton(DwarfCompileUnit &Skel) { Skeleton = &Skel; }
195 
196  unsigned getLength() {
197  return sizeof(uint32_t) + // Length field
199  }
200 
201  void emitHeader(bool UseOffsets) override;
202 
204  assert(getSection());
205  return LabelBegin;
206  }
207 
209  return MacroLabelBegin;
210  }
211 
212  /// Add a new global name to the compile unit.
213  void addGlobalName(StringRef Name, DIE &Die, const DIScope *Context) override;
214 
215  /// Add a new global type to the compile unit.
216  void addGlobalType(const DIType *Ty, const DIE &Die,
217  const DIScope *Context) override;
218 
219  const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
220  const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
221 
222  /// Add DW_AT_location attribute for a DbgVariable based on provided
223  /// MachineLocation.
224  void addVariableAddress(const DbgVariable &DV, DIE &Die,
225  MachineLocation Location);
226  /// Add an address attribute to a die based on the location provided.
228  const MachineLocation &Location);
229 
230  /// Start with the address based on the location provided, and generate the
231  /// DWARF information necessary to find the actual variable (navigating the
232  /// extra location information encoded in the type) based on the starting
233  /// location. Add the DWARF information to the die.
234  void addComplexAddress(const DbgVariable &DV, DIE &Die,
236  const MachineLocation &Location);
237 
238  /// Add a Dwarf loclistptr attribute data and value.
239  void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
240  void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
241 
242  /// Add a Dwarf expression attribute data and value.
243  void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
244 
246  DIE &SPDie);
247 
248  /// getRangeLists - Get the vector of range lists.
250  return (Skeleton ? Skeleton : this)->CURangeLists;
251  }
252 
253  /// getRanges - Get the list of ranges for this unit.
254  const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
255  SmallVector<RangeSpan, 2> takeRanges() { return std::move(CURanges); }
256 
257  void setBaseAddress(const MCSymbol *Base) { BaseAddress = Base; }
258  const MCSymbol *getBaseAddress() const { return BaseAddress; }
259 };
260 
261 } // end llvm namespace
262 
263 #endif
DIE * getOrCreateGlobalVariableDIE(const DIGlobalVariable *GV, ArrayRef< GlobalExpr > GlobalExprs)
Get or create global variable DIE.
LLVMContext & Context
DIELoc - Represents an expression location.
Definition: DIE.h:829
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:39
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:52
void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End)
Attribute
Attributes.
Definition: Dwarf.h:94
Collects and handles dwarf debug information.
Definition: DwarfDebug.h:196
DwarfCompileUnit & getCU() override
LexicalScope - This class is used to track scope information.
Definition: LexicalScopes.h:45
MCSymbol * getMacroLabelBegin() const
DIE & updateSubprogramScopeDIE(const DISubprogram *SP)
Find DIE for the given subprogram and attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes...
DIE * constructLexicalScopeDIE(LexicalScope *Scope)
Construct new DW_TAG_lexical_block for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels...
const StringMap< const DIE * > & getGlobalTypes() const
void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie)
DIE * createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE)
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: APFloat.h:32
static GCRegistry::Add< StatepointGC > D("statepoint-example","an example strategy for statepoint")
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:34
void attachRangesOrLowHighPC(DIE &D, SmallVector< RangeSpan, 2 > Ranges)
DwarfCompileUnit * getSkeleton() const
void addScopeRangeList(DIE &ScopeDIE, SmallVector< RangeSpan, 2 > Range)
A helper function to construct a RangeSpanList for a given lexical scope.
Subprogram description.
void constructScopeDIE(LexicalScope *Scope, SmallVectorImpl< DIE * > &FinalChildren)
void addComplexAddress(const DbgVariable &DV, DIE &Die, dwarf::Attribute Attribute, const MachineLocation &Location)
Start with the address based on the location provided, and generate the DWARF information necessary t...
void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr)
Add a Dwarf expression attribute data and value.
This class is used to track local variable information.
Definition: DwarfDebug.h:64
void setBaseAddress(const MCSymbol *Base)
void applySubprogramAttributesToDefinition(const DISubprogram *SP, DIE &SPDie)
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:33
DwarfCompileUnit(unsigned UID, const DICompileUnit *Node, AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU)
virtual unsigned getHeaderSize() const
Compute the size of a header for this unit, not including the initial length field.
Definition: DwarfUnit.h:282
MCSymbol * getLabelBegin() const
void addAddress(DIE &Die, dwarf::Attribute Attribute, const MachineLocation &Location)
Add an address attribute to a die based on the location provided.
DIScope * getScope() const
This dwarf writer support class manages information associated with a source file.
Definition: DwarfUnit.h:68
void applyStmtList(DIE &D)
Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
const SmallVectorImpl< RangeSpanList > & getRangeLists() const
getRangeLists - Get the vector of range lists.
A structured debug information entry.
Definition: DIE.h:655
const MCSymbol * getBaseAddress() const
DIE & getUnitDie()
Definition: DIE.h:821
This class is intended to be used as a driving class for all asm writers.
Definition: AsmPrinter.h:67
unsigned getSize() const
Definition: DIE.h:695
static const unsigned End
void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Label)
addLocalLabelAddress - Add a dwarf label attribute data and value using DW_FORM_addr only...
void constructAbstractSubprogramScopeDIE(LexicalScope *Scope)
DIE::value_iterator addSectionLabel(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Label, const MCSymbol *Sec)
addSectionLabel - Add a Dwarf section label attribute data and value.
A pair of GlobalVariable and DIExpression.
DIE * constructImportedEntityDIE(const DIImportedEntity *Module)
Construct import_module DIE.
DIE * constructVariableDIE(DbgVariable &DV, bool Abstract=false)
constructVariableDIE - Construct a DIE for the given DbgVariable.
An imported module (C++ using directive or similar).
void setSkeleton(DwarfCompileUnit &Skel)
Set the skeleton unit associated with this unit.
Base class for scope-like contexts.
SmallVector< RangeSpan, 2 > takeRanges()
unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override
Look up the source ID with the given directory and source file names.
DIE * constructInlinedScopeDIE(LexicalScope *Scope)
This scope represents inlined body of a function.
Base class for types.
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:843
const SmallVectorImpl< RangeSpan > & getRanges() const
getRanges - Get the list of ranges for this unit.
const StringMap< const DIE * > & getGlobalNames() const
DWARF expression.
StringMap - This is an unconventional map that is specialized for handling keys that are "strings"...
Definition: StringMap.h:223
void addRange(RangeSpan Range)
addRange - Add an address range to the list of ranges for this unit.
void addImportedEntity(const DIImportedEntity *IE)
void constructSubprogramScopeDIE(const DISubprogram *Sub, LexicalScope *Scope)
Construct a DIE for this subprogram scope.
void addVariableAddress(const DbgVariable &DV, DIE &Die, MachineLocation Location)
Add DW_AT_location attribute for a DbgVariable based on provided MachineLocation. ...
DIE::value_iterator addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi, const MCSymbol *Lo)
addSectionDelta - Add a label delta attribute data and value.
MCSection * getSection() const
Return the section that this DIEUnit will be emitted into.
Definition: DIE.h:814
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
std::string DirName(const std::string &FileName)
void addGlobalName(StringRef Name, DIE &Die, const DIScope *Context) override
Add a new global name to the compile unit.
void addGlobalType(const DIType *Ty, const DIE &Die, const DIScope *Context) override
Add a new global type to the compile unit.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:47
void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index)
Add a Dwarf loclistptr attribute data and value.
unsigned getUniqueID() const
static GCRegistry::Add< ErlangGC > A("erlang","erlang-compatible garbage collector")
void finishSubprogramDefinition(const DISubprogram *SP)
void emitHeader(bool UseOffsets) override
Emit the header for this unit, not including the initial length field.
void addLabelAddress(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Label)
addLabelAddress - Add a dwarf label attribute data and value using either DW_FORM_addr or DW_FORM_GNU...
DIE * createScopeChildrenDIE(LexicalScope *Scope, SmallVectorImpl< DIE * > &Children, unsigned *ChildScopeCount=nullptr)
A helper function to create children of a Scope DIE.