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/Support/Dwarf.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/IR/DebugInfo.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   unsigned stmtListIndex;
35 
36   /// \brief Construct a DIE for the given DbgVariable without initializing the
37   /// DbgVariable's DIE reference.
38   std::unique_ptr<DIE> constructVariableDIEImpl(const DbgVariable &DV,
39                                                 bool Abstract);
40 
41 public:
42   DwarfCompileUnit(unsigned UID, DICompileUnit Node, AsmPrinter *A,
43                    DwarfDebug *DW, DwarfFile *DWU);
44 
45   void initStmtList(MCSymbol *DwarfLineSectionSym);
46 
47   /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
48   void applyStmtList(DIE &D);
49 
50   /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
51   DIE *getOrCreateGlobalVariableDIE(DIGlobalVariable GV);
52 
53   /// addLabelAddress - Add a dwarf label attribute data and value using
54   /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
55   void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
56                        const MCSymbol *Label);
57 
58   /// addLocalLabelAddress - Add a dwarf label attribute data and value using
59   /// DW_FORM_addr only.
60   void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
61                             const MCSymbol *Label);
62 
63   /// addSectionDelta - Add a label delta attribute data and value.
64   void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
65                        const MCSymbol *Lo);
66 
67   DwarfCompileUnit &getCU() override { return *this; }
68 
69   unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
70 
71   /// addRange - Add an address range to the list of ranges for this unit.
72   void addRange(RangeSpan Range);
73 
74   void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
75 
76   /// addSectionLabel - Add a Dwarf section label attribute data and value.
77   ///
78   void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
79                        const MCSymbol *Label, const MCSymbol *Sec);
80 
81   /// \brief Find DIE for the given subprogram and attach appropriate
82   /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
83   /// variables in this scope then create and insert DIEs for these
84   /// variables.
85   DIE &updateSubprogramScopeDIE(DISubprogram SP);
86 
87   void constructScopeDIE(LexicalScope *Scope,
88                          SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
89 
90   /// \brief A helper function to construct a RangeSpanList for a given
91   /// lexical scope.
92   void addScopeRangeList(DIE &ScopeDIE,
93                          const SmallVectorImpl<InsnRange> &Range);
94 
95   void attachRangesOrLowHighPC(DIE &D,
96                                const SmallVectorImpl<InsnRange> &Ranges);
97 
98   /// \brief This scope represents inlined body of a function. Construct
99   /// DIE to represent this concrete inlined copy of the function.
100   std::unique_ptr<DIE> constructInlinedScopeDIE(LexicalScope *Scope);
101 
102   /// \brief Construct new DW_TAG_lexical_block for this scope and
103   /// attach DW_AT_low_pc/DW_AT_high_pc labels.
104   std::unique_ptr<DIE> constructLexicalScopeDIE(LexicalScope *Scope);
105 
106   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
107   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
108                                             bool Abstract = false);
109 
110   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
111                                             const LexicalScope &Scope,
112                                             DIE *&ObjectPointer);
113 
114   /// A helper function to create children of a Scope DIE.
115   DIE *createScopeChildrenDIE(LexicalScope *Scope,
116                               SmallVectorImpl<std::unique_ptr<DIE>> &Children,
117                               unsigned *ChildScopeCount = nullptr);
118 
119   /// \brief Construct a DIE for this subprogram scope.
120   void constructSubprogramScopeDIE(LexicalScope *Scope);
121 
122   DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
123 
124   DIE &constructAbstractSubprogramScopeDIE(LexicalScope *Scope);
125 
126   /// \brief Construct import_module DIE.
127   std::unique_ptr<DIE>
128   constructImportedEntityDIE(const DIImportedEntity &Module);
129 
130   void finishSubprogramDefinition(DISubprogram SP);
131 };
132 
133 } // end llvm namespace
134 
135 #endif
136