1 //===-- llvm/CodeGen/DwarfFile.h - Dwarf Debug Framework -------*- 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 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H
11 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H
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"
36 // Target of Dwarf emission, used for sizing of abbreviations.
39 // Used to uniquely define abbreviations.
40 FoldingSet<DIEAbbrev> AbbreviationsSet;
42 // A list of all the unique abbreviations in use.
43 std::vector<DIEAbbrev *> Abbreviations;
45 // A pointer to all units in the section.
46 SmallVector<std::unique_ptr<DwarfUnit>, 1> CUs;
48 DwarfStringPool StrPool;
50 // Collection of dbg variables of a scope.
51 DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8>> ScopeVariables;
53 // Collection of abstract subprogram DIEs.
54 DenseMap<const MDNode *, DIE *> AbstractSPDies;
56 /// Maps MDNodes for type system with the corresponding DIEs. These DIEs can
57 /// be shared across CUs, that is why we keep the map here instead
58 /// of in DwarfCompileUnit.
59 DenseMap<const MDNode *, DIE *> DITypeNodeToDieMap;
62 DwarfFile(AsmPrinter *AP, StringRef Pref, BumpPtrAllocator &DA);
66 const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() { return CUs; }
68 /// \brief Compute the size and offset of a DIE given an incoming Offset.
69 unsigned computeSizeAndOffset(DIE &Die, unsigned Offset);
71 /// \brief Compute the size and offset of all the DIEs.
72 void computeSizeAndOffsets();
74 /// \brief Define a unique number for the abbreviation.
75 void assignAbbrevNumber(DIEAbbrev &Abbrev);
77 /// \brief Add a unit to the list of CUs.
78 void addUnit(std::unique_ptr<DwarfUnit> U);
80 /// \brief Emit all of the units to the section listed with the given
81 /// abbreviation section.
82 void emitUnits(bool UseOffsets);
84 /// \brief Emit a set of abbreviations to the specific section.
85 void emitAbbrevs(const MCSection *);
87 /// \brief Emit all of the strings to the section given.
88 void emitStrings(const MCSection *StrSection,
89 const MCSection *OffsetSection = nullptr);
91 /// \brief Returns the string pool.
92 DwarfStringPool &getStringPool() { return StrPool; }
94 /// \returns false if the variable was merged with a previous one.
95 bool addScopeVariable(LexicalScope *LS, DbgVariable *Var);
97 DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8>> &getScopeVariables() {
98 return ScopeVariables;
101 DenseMap<const MDNode *, DIE *> &getAbstractSPDies() {
102 return AbstractSPDies;
105 void insertDIE(const MDNode *TypeMD, DIE *Die) {
106 DITypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
108 DIE *getDIE(const MDNode *TypeMD) {
109 return DITypeNodeToDieMap.lookup(TypeMD);