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 /// \brief Construct a DIE for the given DbgVariable without initializing the
40 /// DbgVariable's DIE reference.
41 std::unique_ptr<DIE> constructVariableDIEImpl(const DbgVariable &DV,
45 DwarfCompileUnit(unsigned UID, DICompileUnit Node, AsmPrinter *A,
46 DwarfDebug *DW, DwarfFile *DWU);
48 DwarfCompileUnit *getSkeleton() const {
52 void initStmtList(MCSymbol *DwarfLineSectionSym);
54 /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
55 void applyStmtList(DIE &D);
57 /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
58 DIE *getOrCreateGlobalVariableDIE(DIGlobalVariable GV);
60 /// addLabelAddress - Add a dwarf label attribute data and value using
61 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
62 void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
63 const MCSymbol *Label);
65 /// addLocalLabelAddress - Add a dwarf label attribute data and value using
66 /// DW_FORM_addr only.
67 void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
68 const MCSymbol *Label);
70 /// addSectionDelta - Add a label delta attribute data and value.
71 void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
74 DwarfCompileUnit &getCU() override { return *this; }
76 unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
78 /// addRange - Add an address range to the list of ranges for this unit.
79 void addRange(RangeSpan Range);
81 void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
83 /// addSectionLabel - Add a Dwarf section label attribute data and value.
85 void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
86 const MCSymbol *Label, const MCSymbol *Sec);
88 /// \brief Find DIE for the given subprogram and attach appropriate
89 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
90 /// variables in this scope then create and insert DIEs for these
92 DIE &updateSubprogramScopeDIE(DISubprogram SP);
94 void constructScopeDIE(LexicalScope *Scope,
95 SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
97 /// \brief A helper function to construct a RangeSpanList for a given
99 void addScopeRangeList(DIE &ScopeDIE,
100 const SmallVectorImpl<InsnRange> &Range);
102 void attachRangesOrLowHighPC(DIE &D,
103 const SmallVectorImpl<InsnRange> &Ranges);
105 /// \brief This scope represents inlined body of a function. Construct
106 /// DIE to represent this concrete inlined copy of the function.
107 std::unique_ptr<DIE> constructInlinedScopeDIE(LexicalScope *Scope);
109 /// \brief Construct new DW_TAG_lexical_block for this scope and
110 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
111 std::unique_ptr<DIE> constructLexicalScopeDIE(LexicalScope *Scope);
113 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
114 std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
115 bool Abstract = false);
117 std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
118 const LexicalScope &Scope,
119 DIE *&ObjectPointer);
121 /// A helper function to create children of a Scope DIE.
122 DIE *createScopeChildrenDIE(LexicalScope *Scope,
123 SmallVectorImpl<std::unique_ptr<DIE>> &Children,
124 unsigned *ChildScopeCount = nullptr);
126 /// \brief Construct a DIE for this subprogram scope.
127 void constructSubprogramScopeDIE(LexicalScope *Scope);
129 DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
131 void constructAbstractSubprogramScopeDIE(LexicalScope *Scope);
133 /// \brief Construct import_module DIE.
135 constructImportedEntityDIE(const DIImportedEntity &Module);
137 void finishSubprogramDefinition(DISubprogram SP);
139 void collectDeadVariables(DISubprogram SP);
141 /// If there's a skeleton then return the begin label for the skeleton unit,
142 /// otherwise return the local label for this unit.
143 MCSymbol *getLocalLabelBegin() const {
145 return Skeleton->getLabelBegin();
146 return getLabelBegin();
149 /// If there's a skeleton then return the section symbol for the skeleton
150 /// unit, otherwise return the section symbol for this unit.
151 MCSymbol *getLocalSectionSym() const {
153 return Skeleton->getSectionSym();
154 return getSectionSym();
157 /// Set the skeleton unit associated with this unit.
158 void setSkeleton(DwarfCompileUnit &Skel) { Skeleton = &Skel; }
161 } // end llvm namespace