1 //===-- llvm/CodeGen/DwarfFile.h - Dwarf Debug Framework -------*- 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 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H 11 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H 12 13 #include "AddressPool.h" 14 #include "DwarfStringPool.h" 15 #include "llvm/ADT/DenseMap.h" 16 #include "llvm/ADT/FoldingSet.h" 17 #include "llvm/ADT/SmallVector.h" 18 #include "llvm/ADT/StringMap.h" 19 #include "llvm/Support/Allocator.h" 20 #include <memory> 21 #include <string> 22 #include <vector> 23 24 namespace llvm { 25 class AsmPrinter; 26 class DbgVariable; 27 class DwarfUnit; 28 class DIEAbbrev; 29 class MCSymbol; 30 class DIE; 31 class LexicalScope; 32 class StringRef; 33 class DwarfDebug; 34 class MCSection; 35 class MDNode; 36 class DwarfFile { 37 // Target of Dwarf emission, used for sizing of abbreviations. 38 AsmPrinter *Asm; 39 40 BumpPtrAllocator AbbrevAllocator; 41 42 // Used to uniquely define abbreviations. 43 FoldingSet<DIEAbbrev> AbbreviationsSet; 44 45 // A list of all the unique abbreviations in use. 46 std::vector<DIEAbbrev *> Abbreviations; 47 48 // A pointer to all units in the section. 49 SmallVector<std::unique_ptr<DwarfUnit>, 1> CUs; 50 51 DwarfStringPool StrPool; 52 53 // Collection of dbg variables of a scope. 54 DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8>> ScopeVariables; 55 56 // Collection of abstract subprogram DIEs. 57 DenseMap<const MDNode *, DIE *> AbstractSPDies; 58 59 /// Maps MDNodes for type system with the corresponding DIEs. These DIEs can 60 /// be shared across CUs, that is why we keep the map here instead 61 /// of in DwarfCompileUnit. 62 DenseMap<const MDNode *, DIE *> DITypeNodeToDieMap; 63 64 public: 65 DwarfFile(AsmPrinter *AP, StringRef Pref, BumpPtrAllocator &DA); 66 67 ~DwarfFile(); 68 69 const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() { return CUs; } 70 71 /// \brief Compute the size and offset of a DIE given an incoming Offset. 72 unsigned computeSizeAndOffset(DIE &Die, unsigned Offset); 73 74 /// \brief Compute the size and offset of all the DIEs. 75 void computeSizeAndOffsets(); 76 77 /// Define a unique number for the abbreviation. 78 /// 79 /// Compute the abbreviation for \c Die, look up its unique number, and 80 /// return a reference to it in the uniquing table. 81 DIEAbbrev &assignAbbrevNumber(DIE &Die); 82 83 /// \brief Add a unit to the list of CUs. 84 void addUnit(std::unique_ptr<DwarfUnit> U); 85 86 /// \brief Emit all of the units to the section listed with the given 87 /// abbreviation section. 88 void emitUnits(bool UseOffsets); 89 90 /// \brief Emit a set of abbreviations to the specific section. 91 void emitAbbrevs(MCSection *); 92 93 /// \brief Emit all of the strings to the section given. 94 void emitStrings(MCSection *StrSection, MCSection *OffsetSection = nullptr); 95 96 /// \brief Returns the string pool. 97 DwarfStringPool &getStringPool() { return StrPool; } 98 99 /// \returns false if the variable was merged with a previous one. 100 bool addScopeVariable(LexicalScope *LS, DbgVariable *Var); 101 102 DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8>> &getScopeVariables() { 103 return ScopeVariables; 104 } 105 106 DenseMap<const MDNode *, DIE *> &getAbstractSPDies() { 107 return AbstractSPDies; 108 } 109 110 void insertDIE(const MDNode *TypeMD, DIE *Die) { 111 DITypeNodeToDieMap.insert(std::make_pair(TypeMD, Die)); 112 } 113 DIE *getDIE(const MDNode *TypeMD) { 114 return DITypeNodeToDieMap.lookup(TypeMD); 115 } 116 }; 117 } 118 #endif 119
