1 //===-- llvm/CodeGen/DwarfCompileUnit.h - Dwarf Compile Unit ---*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf compile unit.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
17 #include "DwarfUnit.h"
18 #include "llvm/Support/Dwarf.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/IR/DebugInfo.h"
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 unsigned stmtListIndex;
36 /// Skeleton unit associated with this unit.
37 DwarfCompileUnit *Skeleton;
39 /// A label at the start of the non-dwo section related to this unit.
42 /// The start of the unit within its section.
45 /// \brief Construct a DIE for the given DbgVariable without initializing the
46 /// DbgVariable's DIE reference.
47 std::unique_ptr<DIE> constructVariableDIEImpl(const DbgVariable &DV,
51 DwarfCompileUnit(unsigned UID, DICompileUnit Node, AsmPrinter *A,
52 DwarfDebug *DW, DwarfFile *DWU);
54 DwarfCompileUnit *getSkeleton() const {
58 void initStmtList(MCSymbol *DwarfLineSectionSym);
60 /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
61 void applyStmtList(DIE &D);
63 /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
64 DIE *getOrCreateGlobalVariableDIE(DIGlobalVariable GV);
66 /// addLabelAddress - Add a dwarf label attribute data and value using
67 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
68 void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
69 const MCSymbol *Label);
71 /// addLocalLabelAddress - Add a dwarf label attribute data and value using
72 /// DW_FORM_addr only.
73 void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
74 const MCSymbol *Label);
76 /// addSectionDelta - Add a label delta attribute data and value.
77 void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
80 DwarfCompileUnit &getCU() override { return *this; }
82 unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
84 /// addRange - Add an address range to the list of ranges for this unit.
85 void addRange(RangeSpan Range);
87 void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
89 /// addSectionLabel - Add a Dwarf section label attribute data and value.
91 void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
92 const MCSymbol *Label, const MCSymbol *Sec);
94 /// \brief Find DIE for the given subprogram and attach appropriate
95 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
96 /// variables in this scope then create and insert DIEs for these
98 DIE &updateSubprogramScopeDIE(DISubprogram SP);
100 void constructScopeDIE(LexicalScope *Scope,
101 SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
103 /// \brief A helper function to construct a RangeSpanList for a given
105 void addScopeRangeList(DIE &ScopeDIE,
106 const SmallVectorImpl<InsnRange> &Range);
108 void attachRangesOrLowHighPC(DIE &D,
109 const SmallVectorImpl<InsnRange> &Ranges);
111 /// \brief This scope represents inlined body of a function. Construct
112 /// DIE to represent this concrete inlined copy of the function.
113 std::unique_ptr<DIE> constructInlinedScopeDIE(LexicalScope *Scope);
115 /// \brief Construct new DW_TAG_lexical_block for this scope and
116 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
117 std::unique_ptr<DIE> constructLexicalScopeDIE(LexicalScope *Scope);
119 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
120 std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
121 bool Abstract = false);
123 std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
124 const LexicalScope &Scope,
125 DIE *&ObjectPointer);
127 /// A helper function to create children of a Scope DIE.
128 DIE *createScopeChildrenDIE(LexicalScope *Scope,
129 SmallVectorImpl<std::unique_ptr<DIE>> &Children,
130 unsigned *ChildScopeCount = nullptr);
132 /// \brief Construct a DIE for this subprogram scope.
133 void constructSubprogramScopeDIE(LexicalScope *Scope);
135 DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
137 void constructAbstractSubprogramScopeDIE(LexicalScope *Scope);
139 /// \brief Construct import_module DIE.
141 constructImportedEntityDIE(const DIImportedEntity &Module);
143 void finishSubprogramDefinition(DISubprogram SP);
145 void collectDeadVariables(DISubprogram SP);
147 /// Set the skeleton unit associated with this unit.
148 void setSkeleton(DwarfCompileUnit &Skel) { Skeleton = &Skel; }
150 MCSymbol *getSectionSym() const {
155 /// Pass in the SectionSym even though we could recreate it in every compile
156 /// unit (type units will have actually distinct symbols once they're in
157 /// comdat sections).
158 void initSection(const MCSection *Section, MCSymbol *SectionSym) {
159 DwarfUnit::initSection(Section);
160 this->SectionSym = SectionSym;
162 Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
165 unsigned getLength() {
166 return sizeof(uint32_t) + // Length field
167 getHeaderSize() + UnitDie.getSize();
170 void emitHeader(const MCSymbol *ASectionSym) const override;
172 MCSymbol *getLabelBegin() const {
178 } // end llvm namespace