lib/CodeGen/AsmPrinter/DwarfCompileUnit.h

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