LLVM  3.7.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/ADT/StringRef.h"
19 #include "llvm/IR/DebugInfo.h"
20 #include "llvm/Support/Dwarf.h"
21 
22 namespace llvm {
23 
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  /// The attribute index of DW_AT_stmt_list in the compile unit DIE, avoiding
33  /// the need to search for it in applyStmtList.
34  DIE::value_iterator StmtListValue;
35 
36  /// Skeleton unit associated with this unit.
37  DwarfCompileUnit *Skeleton;
38 
39  /// The start of the unit within its section.
40  MCSymbol *LabelBegin;
41 
42  /// GlobalNames - A map of globally visible named entities for this unit.
43  StringMap<const DIE *> GlobalNames;
44 
45  /// GlobalTypes - A map of globally visible types for this unit.
46  StringMap<const DIE *> GlobalTypes;
47 
48  // List of range lists for a given compile unit, separate from the ranges for
49  // the CU itself.
50  SmallVector<RangeSpanList, 1> CURangeLists;
51 
52  // List of ranges for a given compile unit.
54 
55  // The base address of this unit, if any. Used for relative references in
56  // ranges/locs.
57  const MCSymbol *BaseAddress;
58 
59  /// \brief Construct a DIE for the given DbgVariable without initializing the
60  /// DbgVariable's DIE reference.
61  DIE *constructVariableDIEImpl(const DbgVariable &DV, bool Abstract);
62 
63  bool isDwoUnit() const override;
64 
65  bool includeMinimalInlineScopes() const;
66 
67 public:
68  DwarfCompileUnit(unsigned UID, const DICompileUnit *Node, AsmPrinter *A,
69  DwarfDebug *DW, DwarfFile *DWU);
70 
72  return Skeleton;
73  }
74 
75  void initStmtList();
76 
77  /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
78  void applyStmtList(DIE &D);
79 
80  /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
82 
83  /// addLabelAddress - Add a dwarf label attribute data and value using
84  /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
86  const MCSymbol *Label);
87 
88  /// addLocalLabelAddress - Add a dwarf label attribute data and value using
89  /// DW_FORM_addr only.
91  const MCSymbol *Label);
92 
93  /// addSectionDelta - Add a label delta attribute data and value.
95  const MCSymbol *Hi, const MCSymbol *Lo);
96 
97  DwarfCompileUnit &getCU() override { return *this; }
98 
99  unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
100 
101  /// addRange - Add an address range to the list of ranges for this unit.
102  void addRange(RangeSpan Range);
103 
104  void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
105 
106  /// addSectionLabel - Add a Dwarf section label attribute data and value.
107  ///
109  const MCSymbol *Label,
110  const MCSymbol *Sec);
111 
112  /// \brief Find DIE for the given subprogram and attach appropriate
113  /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
114  /// variables in this scope then create and insert DIEs for these
115  /// variables.
117 
118  void constructScopeDIE(LexicalScope *Scope,
119  SmallVectorImpl<DIE *> &FinalChildren);
120 
121  /// \brief A helper function to construct a RangeSpanList for a given
122  /// lexical scope.
123  void addScopeRangeList(DIE &ScopeDIE, SmallVector<RangeSpan, 2> Range);
124 
126 
129  /// \brief This scope represents inlined body of a function. Construct
130  /// DIE to represent this concrete inlined copy of the function.
132 
133  /// \brief Construct new DW_TAG_lexical_block for this scope and
134  /// attach DW_AT_low_pc/DW_AT_high_pc labels.
136 
137  /// constructVariableDIE - Construct a DIE for the given DbgVariable.
138  DIE *constructVariableDIE(DbgVariable &DV, bool Abstract = false);
139 
141  DIE *&ObjectPointer);
142 
143  /// A helper function to create children of a Scope DIE.
145  SmallVectorImpl<DIE *> &Children,
146  unsigned *ChildScopeCount = nullptr);
147 
148  /// \brief Construct a DIE for this subprogram scope.
150 
151  DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
152 
154 
155  /// \brief Construct import_module DIE.
157 
159 
160  void collectDeadVariables(const DISubprogram *SP);
161 
162  /// Set the skeleton unit associated with this unit.
163  void setSkeleton(DwarfCompileUnit &Skel) { Skeleton = &Skel; }
164 
165  const MCSymbol *getSectionSym() const {
166  assert(Section);
167  return Section->getBeginSymbol();
168  }
169 
170  unsigned getLength() {
171  return sizeof(uint32_t) + // Length field
173  }
174 
175  void emitHeader(bool UseOffsets) override;
176 
178  assert(Section);
179  return LabelBegin;
180  }
181 
182  /// Add a new global name to the compile unit.
183  void addGlobalName(StringRef Name, DIE &Die, const DIScope *Context) override;
184 
185  /// Add a new global type to the compile unit.
186  void addGlobalType(const DIType *Ty, const DIE &Die,
187  const DIScope *Context) override;
188 
189  const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
190  const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
191 
192  /// Add DW_AT_location attribute for a DbgVariable based on provided
193  /// MachineLocation.
194  void addVariableAddress(const DbgVariable &DV, DIE &Die,
195  MachineLocation Location);
196  /// Add an address attribute to a die based on the location provided.
198  const MachineLocation &Location);
199 
200  /// Start with the address based on the location provided, and generate the
201  /// DWARF information necessary to find the actual variable (navigating the
202  /// extra location information encoded in the type) based on the starting
203  /// location. Add the DWARF information to the die.
204  void addComplexAddress(const DbgVariable &DV, DIE &Die,
206  const MachineLocation &Location);
207 
208  /// Add a Dwarf loclistptr attribute data and value.
209  void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
210  void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
211 
212  /// Add a Dwarf expression attribute data and value.
213  void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
214 
216  DIE &SPDie);
217 
218  /// getRangeLists - Get the vector of range lists.
220  return (Skeleton ? Skeleton : this)->CURangeLists;
221  }
222 
223  /// getRanges - Get the list of ranges for this unit.
224  const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
225  SmallVector<RangeSpan, 2> takeRanges() { return std::move(CURanges); }
226 
227  void setBaseAddress(const MCSymbol *Base) { BaseAddress = Base; }
228  const MCSymbol *getBaseAddress() const { return BaseAddress; }
229 };
230 
231 } // end llvm namespace
232 
233 #endif
MCSection * Section
The section this unit will be emitted in.
Definition: DwarfUnit.h:111
DIELoc - Represents an expression location.
Definition: DIE.h:748
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:114
void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End)
Collects and handles dwarf debug information.
Definition: DwarfDebug.h:207
void collectDeadVariables(const DISubprogram *SP)
DwarfCompileUnit & getCU() override
LexicalScope - This class is used to track scope information.
Definition: LexicalScopes.h:45
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: APInt.h:33
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:33
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:81
void setBaseAddress(const MCSymbol *Base)
void applySubprogramAttributesToDefinition(const DISubprogram *SP, DIE &SPDie)
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:321
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.
DIE * getOrCreateGlobalVariableDIE(const DIGlobalVariable *GV)
getOrCreateGlobalVariableDIE - get or create global variable DIE.
const MCSymbol * getSectionSym() 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.
DIE - A structured debug information entry.
Definition: DIE.h:623
const MCSymbol * getBaseAddress() const
This class is intended to be used as a driving class for all asm writers.
Definition: AsmPrinter.h:66
unsigned getSize() const
Definition: DIE.h:665
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.
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.
void constructSubprogramScopeDIE(LexicalScope *Scope)
Construct a DIE for this subprogram scope.
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:861
const SmallVectorImpl< RangeSpan > & getRanges() const
getRanges - Get the list of ranges for this unit.
MCSymbol * getBeginSymbol()
Definition: MCSection.h:113
const StringMap< const DIE * > & getGlobalNames() const
StringMap - This is an unconventional map that is specialized for handling keys that are "strings"...
Definition: StringMap.h:214
void addRange(RangeSpan Range)
addRange - Add an address range to the list of ranges for this unit.
SI Fix SGPR Live Ranges
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.
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.
DIE & UnitDie
Unit debug information entry.
Definition: DwarfUnit.h:80
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:40
void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index)
Add a Dwarf loclistptr attribute data and value.
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.