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   /// Skeleton unit associated with this unit.
  37   DwarfUnit *Skeleton;
  38
  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,
  42                                                 bool Abstract);
  43
  44 public:
  45   DwarfCompileUnit(unsigned UID, DICompileUnit Node, AsmPrinter *A,
  46                    DwarfDebug *DW, DwarfFile *DWU);
  47
  48   DwarfCompileUnit *getSkeleton() const {
  49     return static_cast<DwarfCompileUnit *>(Skeleton);
  50   }
  51
  52   void initStmtList(MCSymbol *DwarfLineSectionSym);
  53
  54   /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
  55   void applyStmtList(DIE &D);
  56
  57   /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
  58   DIE *getOrCreateGlobalVariableDIE(DIGlobalVariable GV);
  59
  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);
  64
  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);
  69
  70   /// addSectionDelta - Add a label delta attribute data and value.
  71   void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
  72                        const MCSymbol *Lo);
  73
  74   DwarfCompileUnit &getCU() override { return *this; }
  75
  76   unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
  77
  78   /// addRange - Add an address range to the list of ranges for this unit.
  79   void addRange(RangeSpan Range);
  80
  81   void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
  82
  83   /// addSectionLabel - Add a Dwarf section label attribute data and value.
  84   ///
  85   void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
  86                        const MCSymbol *Label, const MCSymbol *Sec);
  87
  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
  91   /// variables.
  92   DIE &updateSubprogramScopeDIE(DISubprogram SP);
  93
  94   void constructScopeDIE(LexicalScope *Scope,
  95                          SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
  96
  97   /// \brief A helper function to construct a RangeSpanList for a given
  98   /// lexical scope.
  99   void addScopeRangeList(DIE &ScopeDIE,
 100                          const SmallVectorImpl<InsnRange> &Range);
 101
 102   void attachRangesOrLowHighPC(DIE &D,
 103                                const SmallVectorImpl<InsnRange> &Ranges);
 104
 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);
 108
 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);
 112
 113   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 114   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
 115                                             bool Abstract = false);
 116
 117   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
 118                                             const LexicalScope &Scope,
 119                                             DIE *&ObjectPointer);
 120
 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);
 125
 126   /// \brief Construct a DIE for this subprogram scope.
 127   void constructSubprogramScopeDIE(LexicalScope *Scope);
 128
 129   DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
 130
 131   void constructAbstractSubprogramScopeDIE(LexicalScope *Scope);
 132
 133   /// \brief Construct import_module DIE.
 134   std::unique_ptr<DIE>
 135   constructImportedEntityDIE(const DIImportedEntity &Module);
 136
 137   void finishSubprogramDefinition(DISubprogram SP);
 138
 139   void collectDeadVariables(DISubprogram SP);
 140
 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 {
 144     if (Skeleton)
 145       return Skeleton->getLabelBegin();
 146     return getLabelBegin();
 147   }
 148
 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 {
 152     if (Skeleton)
 153       return Skeleton->getSectionSym();
 154     return getSectionSym();
 155   }
 156
 157   /// Set the skeleton unit associated with this unit.
 158   void setSkeleton(DwarfUnit &Skel) { Skeleton = &Skel; }
 159 };
 160
 161 } // end llvm namespace
 162
 163 #endif