Home | History | Annotate | Download | only in AsmPrinter
      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 CODEGEN_ASMPRINTER_DWARFFILE_H__
     11 #define CODEGEN_ASMPRINTER_DWARFFILE_H__
     12 
     13 #include "llvm/ADT/DenseMap.h"
     14 #include "llvm/ADT/FoldingSet.h"
     15 #include "llvm/ADT/SmallVector.h"
     16 #include "llvm/ADT/StringMap.h"
     17 #include "llvm/Support/Allocator.h"
     18 #include "AddressPool.h"
     19 #include "DwarfStringPool.h"
     20 
     21 #include <vector>
     22 #include <string>
     23 #include <memory>
     24 
     25 namespace llvm {
     26 class AsmPrinter;
     27 class DwarfUnit;
     28 class DIEAbbrev;
     29 class MCSymbol;
     30 class DIE;
     31 class StringRef;
     32 class DwarfDebug;
     33 class MCSection;
     34 class DwarfFile {
     35   // Target of Dwarf emission, used for sizing of abbreviations.
     36   AsmPrinter *Asm;
     37 
     38   // Used to uniquely define abbreviations.
     39   FoldingSet<DIEAbbrev> AbbreviationsSet;
     40 
     41   // A list of all the unique abbreviations in use.
     42   std::vector<DIEAbbrev *> Abbreviations;
     43 
     44   // A pointer to all units in the section.
     45   SmallVector<std::unique_ptr<DwarfUnit>, 1> CUs;
     46 
     47   DwarfStringPool StrPool;
     48 
     49 public:
     50   DwarfFile(AsmPrinter *AP, StringRef Pref, BumpPtrAllocator &DA);
     51 
     52   ~DwarfFile();
     53 
     54   const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() { return CUs; }
     55 
     56   /// \brief Compute the size and offset of a DIE given an incoming Offset.
     57   unsigned computeSizeAndOffset(DIE &Die, unsigned Offset);
     58 
     59   /// \brief Compute the size and offset of all the DIEs.
     60   void computeSizeAndOffsets();
     61 
     62   /// \brief Define a unique number for the abbreviation.
     63   void assignAbbrevNumber(DIEAbbrev &Abbrev);
     64 
     65   /// \brief Add a unit to the list of CUs.
     66   void addUnit(std::unique_ptr<DwarfUnit> U);
     67 
     68   /// \brief Emit all of the units to the section listed with the given
     69   /// abbreviation section.
     70   void emitUnits(DwarfDebug *DD, const MCSymbol *ASectionSym);
     71 
     72   /// \brief Emit a set of abbreviations to the specific section.
     73   void emitAbbrevs(const MCSection *);
     74 
     75   /// \brief Emit all of the strings to the section given.
     76   void emitStrings(const MCSection *StrSection,
     77                    const MCSection *OffsetSection = nullptr,
     78                    const MCSymbol *StrSecSym = nullptr);
     79 
     80   /// \brief Returns the string pool.
     81   DwarfStringPool &getStringPool() { return StrPool; }
     82 };
     83 }
     84 #endif
     85