1 //===-- llvm/CodeGen/DwarfDebug.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 // This file contains support for writing dwarf debug info into asm files.
12 //===----------------------------------------------------------------------===//
14 #ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__
15 #define CODEGEN_ASMPRINTER_DWARFDEBUG_H__
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/FoldingSet.h"
20 #include "llvm/ADT/SetVector.h"
21 #include "llvm/ADT/SmallPtrSet.h"
22 #include "llvm/ADT/StringMap.h"
23 #include "llvm/CodeGen/AsmPrinter.h"
24 #include "llvm/CodeGen/LexicalScopes.h"
25 #include "llvm/DebugInfo.h"
26 #include "llvm/MC/MachineLocation.h"
27 #include "llvm/Support/Allocator.h"
28 #include "llvm/Support/DebugLoc.h"
36 class MachineFrameInfo;
37 class MachineModuleInfo;
40 class MCObjectFileInfo;
46 //===----------------------------------------------------------------------===//
47 /// \brief This class is used to record source line correspondence.
49 unsigned Line; // Source line number.
50 unsigned Column; // Source column.
51 unsigned SourceID; // Source ID number.
52 MCSymbol *Label; // Label in code ID number.
54 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
55 : Line(L), Column(C), SourceID(S), Label(label) {}
58 unsigned getLine() const { return Line; }
59 unsigned getColumn() const { return Column; }
60 unsigned getSourceID() const { return SourceID; }
61 MCSymbol *getLabel() const { return Label; }
64 /// \brief This struct describes location entries emitted in the .debug_loc
66 class DotDebugLocEntry {
67 // Begin and end symbols for the address range that this location is valid.
68 const MCSymbol *Begin;
71 // Type of entry that this represents.
78 enum EntryType EntryKind;
82 const ConstantFP *CFP;
83 const ConstantInt *CIP;
86 // The location in the machine frame.
89 // The variable to which this location entry corresponds.
90 const MDNode *Variable;
92 // Whether this location has been merged.
96 DotDebugLocEntry() : Begin(0), End(0), Variable(0), Merged(false) {
99 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L,
101 : Begin(B), End(E), Loc(L), Variable(V), Merged(false) {
103 EntryKind = E_Location;
105 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, int64_t i)
106 : Begin(B), End(E), Variable(0), Merged(false) {
108 EntryKind = E_Integer;
110 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, const ConstantFP *FPtr)
111 : Begin(B), End(E), Variable(0), Merged(false) {
112 Constants.CFP = FPtr;
113 EntryKind = E_ConstantFP;
115 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E,
116 const ConstantInt *IPtr)
117 : Begin(B), End(E), Variable(0), Merged(false) {
118 Constants.CIP = IPtr;
119 EntryKind = E_ConstantInt;
122 /// \brief Empty entries are also used as a trigger to emit temp label. Such
123 /// labels are referenced is used to find debug_loc offset for a given DIE.
124 bool isEmpty() { return Begin == 0 && End == 0; }
125 bool isMerged() { return Merged; }
126 void Merge(DotDebugLocEntry *Next) {
127 if (!(Begin && Loc == Next->Loc && End == Next->Begin))
132 bool isLocation() const { return EntryKind == E_Location; }
133 bool isInt() const { return EntryKind == E_Integer; }
134 bool isConstantFP() const { return EntryKind == E_ConstantFP; }
135 bool isConstantInt() const { return EntryKind == E_ConstantInt; }
136 int64_t getInt() const { return Constants.Int; }
137 const ConstantFP *getConstantFP() const { return Constants.CFP; }
138 const ConstantInt *getConstantInt() const { return Constants.CIP; }
139 const MDNode *getVariable() const { return Variable; }
140 const MCSymbol *getBeginSym() const { return Begin; }
141 const MCSymbol *getEndSym() const { return End; }
142 MachineLocation getLoc() const { return Loc; }
145 //===----------------------------------------------------------------------===//
146 /// \brief This class is used to track local variable information.
148 DIVariable Var; // Variable Descriptor.
149 DIE *TheDIE; // Variable DIE.
150 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
151 DbgVariable *AbsVar; // Corresponding Abstract variable, if any.
152 const MachineInstr *MInsn; // DBG_VALUE instruction of the variable.
156 // AbsVar may be NULL.
157 DbgVariable(DIVariable V, DbgVariable *AV, DwarfDebug *DD)
158 : Var(V), TheDIE(0), DotDebugLocOffset(~0U), AbsVar(AV), MInsn(0),
159 FrameIndex(~0), DD(DD) {}
162 DIVariable getVariable() const { return Var; }
163 void setDIE(DIE *D) { TheDIE = D; }
164 DIE *getDIE() const { return TheDIE; }
165 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
166 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
167 StringRef getName() const { return Var.getName(); }
168 DbgVariable *getAbstractVariable() const { return AbsVar; }
169 const MachineInstr *getMInsn() const { return MInsn; }
170 void setMInsn(const MachineInstr *M) { MInsn = M; }
171 int getFrameIndex() const { return FrameIndex; }
172 void setFrameIndex(int FI) { FrameIndex = FI; }
173 // Translate tag to proper Dwarf tag.
174 uint16_t getTag() const {
175 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
176 return dwarf::DW_TAG_formal_parameter;
178 return dwarf::DW_TAG_variable;
180 /// \brief Return true if DbgVariable is artificial.
181 bool isArtificial() const {
182 if (Var.isArtificial())
184 if (getType().isArtificial())
189 bool isObjectPointer() const {
190 if (Var.isObjectPointer())
192 if (getType().isObjectPointer())
197 bool variableHasComplexAddress() const {
198 assert(Var.isVariable() && "Invalid complex DbgVariable!");
199 return Var.hasComplexAddress();
201 bool isBlockByrefVariable() const {
202 assert(Var.isVariable() && "Invalid complex DbgVariable!");
203 return Var.isBlockByrefVariable();
205 unsigned getNumAddrElements() const {
206 assert(Var.isVariable() && "Invalid complex DbgVariable!");
207 return Var.getNumAddrElements();
209 uint64_t getAddrElement(unsigned i) const {
210 return Var.getAddrElement(i);
212 DIType getType() const;
215 /// resolve - Look in the DwarfDebug map for the MDNode that
216 /// corresponds to the reference.
217 template <typename T> T resolve(DIRef<T> Ref) const;
220 /// \brief Collects and handles information specific to a particular
221 /// collection of units.
223 // Target of Dwarf emission, used for sizing of abbreviations.
226 // Used to uniquely define abbreviations.
227 FoldingSet<DIEAbbrev> *AbbreviationsSet;
229 // A list of all the unique abbreviations in use.
230 std::vector<DIEAbbrev *> &Abbreviations;
232 // A pointer to all units in the section.
233 SmallVector<CompileUnit *, 1> CUs;
235 // Collection of strings for this unit and assorted symbols.
236 // A String->Symbol mapping of strings used by indirect
238 typedef StringMap<std::pair<MCSymbol*, unsigned>,
239 BumpPtrAllocator&> StrPool;
241 unsigned NextStringPoolNumber;
242 std::string StringPref;
244 // Collection of addresses for this unit and assorted labels.
245 // A Symbol->unsigned mapping of addresses used by indirect
247 typedef DenseMap<const MCExpr *, unsigned> AddrPool;
248 AddrPool AddressPool;
249 unsigned NextAddrPoolNumber;
252 DwarfUnits(AsmPrinter *AP, FoldingSet<DIEAbbrev> *AS,
253 std::vector<DIEAbbrev *> &A, const char *Pref,
254 BumpPtrAllocator &DA)
255 : Asm(AP), AbbreviationsSet(AS), Abbreviations(A), StringPool(DA),
256 NextStringPoolNumber(0), StringPref(Pref), AddressPool(),
257 NextAddrPoolNumber(0) {}
261 const SmallVectorImpl<CompileUnit *> &getUnits() { return CUs; }
263 /// \brief Compute the size and offset of a DIE given an incoming Offset.
264 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
266 /// \brief Compute the size and offset of all the DIEs.
267 void computeSizeAndOffsets();
269 /// \brief Define a unique number for the abbreviation.
270 void assignAbbrevNumber(DIEAbbrev &Abbrev);
272 /// \brief Add a unit to the list of CUs.
273 void addUnit(CompileUnit *CU) { CUs.push_back(CU); }
275 /// \brief Emit all of the units to the section listed with the given
276 /// abbreviation section.
277 void emitUnits(DwarfDebug *DD, const MCSection *USection,
278 const MCSection *ASection, const MCSymbol *ASectionSym);
280 /// \brief Emit all of the strings to the section given.
281 void emitStrings(const MCSection *StrSection, const MCSection *OffsetSection,
282 const MCSymbol *StrSecSym);
284 /// \brief Emit all of the addresses to the section given.
285 void emitAddresses(const MCSection *AddrSection);
287 /// \brief Returns the entry into the start of the pool.
288 MCSymbol *getStringPoolSym();
290 /// \brief Returns an entry into the string pool with the given
292 MCSymbol *getStringPoolEntry(StringRef Str);
294 /// \brief Returns the index into the string pool with the given
296 unsigned getStringPoolIndex(StringRef Str);
298 /// \brief Returns the string pool.
299 StrPool *getStringPool() { return &StringPool; }
301 /// \brief Returns the index into the address pool with the given
303 unsigned getAddrPoolIndex(const MCExpr *Sym);
304 unsigned getAddrPoolIndex(const MCSymbol *Sym);
306 /// \brief Returns the address pool.
307 AddrPool *getAddrPool() { return &AddressPool; }
310 /// \brief Helper used to pair up a symbol and its DWARF compile unit.
312 SymbolCU(CompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
317 /// \brief Collects and handles dwarf debug information.
319 // Target of Dwarf emission.
322 // Collected machine module information.
323 MachineModuleInfo *MMI;
325 // All DIEValues are allocated through this allocator.
326 BumpPtrAllocator DIEValueAllocator;
328 // Handle to the a compile unit used for the inline extension handling.
329 CompileUnit *FirstCU;
331 // Maps MDNode with its corresponding CompileUnit.
332 DenseMap <const MDNode *, CompileUnit *> CUMap;
334 // Maps subprogram MDNode with its corresponding CompileUnit.
335 DenseMap <const MDNode *, CompileUnit *> SPMap;
337 // Maps a CU DIE with its corresponding CompileUnit.
338 DenseMap <const DIE *, CompileUnit *> CUDieMap;
340 /// Maps MDNodes for type sysstem with the corresponding DIEs. These DIEs can
341 /// be shared across CUs, that is why we keep the map here instead
342 /// of in CompileUnit.
343 DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
345 // Used to uniquely define abbreviations.
346 FoldingSet<DIEAbbrev> AbbreviationsSet;
348 // A list of all the unique abbreviations in use.
349 std::vector<DIEAbbrev *> Abbreviations;
351 // Stores the current file ID for a given compile unit.
352 DenseMap <unsigned, unsigned> FileIDCUMap;
353 // Source id map, i.e. CUID, source filename and directory,
354 // separated by a zero byte, mapped to a unique id.
355 StringMap<unsigned, BumpPtrAllocator&> SourceIdMap;
357 // List of all labels used in aranges generation.
358 std::vector<SymbolCU> ArangeLabels;
360 // Size of each symbol emitted (for those symbols that have a specific size).
361 DenseMap <const MCSymbol *, uint64_t> SymSize;
363 // Provides a unique id per text section.
364 typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
365 SectionMapType SectionMap;
367 // List of arguments for current function.
368 SmallVector<DbgVariable *, 8> CurrentFnArguments;
370 LexicalScopes LScopes;
372 // Collection of abstract subprogram DIEs.
373 DenseMap<const MDNode *, DIE *> AbstractSPDies;
375 // Collection of dbg variables of a scope.
376 typedef DenseMap<LexicalScope *,
377 SmallVector<DbgVariable *, 8> > ScopeVariablesMap;
378 ScopeVariablesMap ScopeVariables;
380 // Collection of abstract variables.
381 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
383 // Collection of DotDebugLocEntry.
384 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
386 // Collection of subprogram DIEs that are marked (at the end of the module)
388 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
390 // This is a collection of subprogram MDNodes that are processed to
392 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
394 // Maps instruction with label emitted before instruction.
395 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
397 // Maps instruction with label emitted after instruction.
398 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
400 // Every user variable mentioned by a DBG_VALUE instruction in order of
402 SmallVector<const MDNode*, 8> UserVariables;
404 // For each user variable, keep a list of DBG_VALUE instructions in order.
405 // The list can also contain normal instructions that clobber the previous
407 typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
409 DbgValueHistoryMap DbgValues;
411 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
413 // Previous instruction's location information. This is used to determine
414 // label location to indicate scope boundries in dwarf debug info.
415 DebugLoc PrevInstLoc;
418 // This location indicates end of function prologue and beginning of function
420 DebugLoc PrologEndLoc;
422 // Section Symbols: these are assembler temporary labels that are emitted at
423 // the beginning of each supported dwarf section. These are used to form
424 // section offsets and are created by EmitSectionLabels.
425 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
426 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
427 MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
428 MCSymbol *FunctionBeginSym, *FunctionEndSym;
429 MCSymbol *DwarfAbbrevDWOSectionSym, *DwarfStrDWOSectionSym;
430 MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
432 // As an optimization, there is no need to emit an entry in the directory
433 // table for the same directory as DW_AT_comp_dir.
434 StringRef CompilationDir;
436 // Counter for assigning globally unique IDs for CUs.
437 unsigned GlobalCUIndexCount;
439 // Holder for the file specific debug information.
440 DwarfUnits InfoHolder;
442 // Holders for the various debug information flags that we might need to
443 // have exposed. See accessor functions below for description.
445 // Holder for imported entities.
446 typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
448 ImportedEntityMap ScopesWithImportedEntities;
450 // Map from type MDNodes to a pair used as a union. If the pointer is
451 // non-null, proxy DIEs in CUs meant to reference this type should be stored
452 // in the vector. The hash will be added to these DIEs once it is computed. If
453 // the pointer is null, the hash is immediately available in the uint64_t and
454 // should be directly used for proxy DIEs.
455 DenseMap<const MDNode *, std::pair<uint64_t, SmallVectorImpl<DIE *> *> >
458 // Whether to emit the pubnames/pubtypes sections.
459 bool HasDwarfPubSections;
461 // Version of dwarf we're emitting.
462 unsigned DwarfVersion;
464 // Maps from a type identifier to the actual MDNode.
465 DITypeIdentifierMap TypeIdentifierMap;
467 // DWARF5 Experimental Options
468 bool HasDwarfAccelTables;
471 // Separated Dwarf Variables
472 // In general these will all be for bits that are left in the
473 // original object file, rather than things that are meant
474 // to be in the .dwo sections.
476 // Used to uniquely define abbreviations for the skeleton emission.
477 FoldingSet<DIEAbbrev> SkeletonAbbrevSet;
479 // A list of all the unique abbreviations in use.
480 std::vector<DIEAbbrev *> SkeletonAbbrevs;
482 // Holder for the skeleton information.
483 DwarfUnits SkeletonHolder;
485 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
487 const SmallVectorImpl<CompileUnit *> &getUnits() {
488 return InfoHolder.getUnits();
491 /// \brief Find abstract variable associated with Var.
492 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
494 /// \brief Find DIE for the given subprogram and attach appropriate
495 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
496 /// variables in this scope then create and insert DIEs for these
498 DIE *updateSubprogramScopeDIE(CompileUnit *SPCU, DISubprogram SP);
500 /// \brief Construct new DW_TAG_lexical_block for this scope and
501 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
502 DIE *constructLexicalScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
503 /// A helper function to check whether the DIE for a given Scope is going
505 bool isLexicalScopeDIENull(LexicalScope *Scope);
507 /// \brief This scope represents inlined body of a function. Construct
508 /// DIE to represent this concrete inlined copy of the function.
509 DIE *constructInlinedScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
511 /// \brief Construct a DIE for this scope.
512 DIE *constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
513 /// A helper function to create children of a Scope DIE.
514 DIE *createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
515 SmallVectorImpl<DIE*> &Children);
517 /// \brief Emit initial Dwarf sections with a label at the start of each one.
518 void emitSectionLabels();
520 /// \brief Compute the size and offset of a DIE given an incoming Offset.
521 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
523 /// \brief Compute the size and offset of all the DIEs.
524 void computeSizeAndOffsets();
526 /// \brief Attach DW_AT_inline attribute with inlined subprogram DIEs.
527 void computeInlinedDIEs();
529 /// \brief Collect info for variables that were optimized out.
530 void collectDeadVariables();
532 /// \brief Finish off debug information after all functions have been
534 void finalizeModuleInfo();
536 /// \brief Emit labels to close any remaining sections that have been left
540 /// \brief Emit a set of abbreviations to the specific section.
541 void emitAbbrevs(const MCSection *, std::vector<DIEAbbrev*> *);
543 /// \brief Emit the debug info section.
544 void emitDebugInfo();
546 /// \brief Emit the abbreviation section.
547 void emitAbbreviations();
549 /// \brief Emit the last address of the section and the end of
551 void emitEndOfLineMatrix(unsigned SectionEnd);
553 /// \brief Emit visible names into a hashed accelerator table section.
554 void emitAccelNames();
556 /// \brief Emit objective C classes and categories into a hashed
557 /// accelerator table section.
558 void emitAccelObjC();
560 /// \brief Emit namespace dies into a hashed accelerator table.
561 void emitAccelNamespaces();
563 /// \brief Emit type dies into a hashed accelerator table.
564 void emitAccelTypes();
566 /// \brief Emit visible names into a debug pubnames section.
567 /// \param GnuStyle determines whether or not we want to emit
568 /// additional information into the table ala newer gcc for gdb
570 void emitDebugPubNames(bool GnuStyle = false);
572 /// \brief Emit visible types into a debug pubtypes section.
573 /// \param GnuStyle determines whether or not we want to emit
574 /// additional information into the table ala newer gcc for gdb
576 void emitDebugPubTypes(bool GnuStyle = false);
578 /// \brief Emit visible names into a debug str section.
581 /// \brief Emit visible names into a debug loc section.
584 /// \brief Emit visible names into a debug aranges section.
585 void emitDebugARanges();
587 /// \brief Emit visible names into a debug ranges section.
588 void emitDebugRanges();
590 /// \brief Emit visible names into a debug macinfo section.
591 void emitDebugMacInfo();
593 /// \brief Emit inline info using custom format.
594 void emitDebugInlineInfo();
596 /// DWARF 5 Experimental Split Dwarf Emitters
598 /// \brief Construct the split debug info compile unit for the debug info
600 CompileUnit *constructSkeletonCU(const CompileUnit *CU);
602 /// \brief Emit the local split abbreviations.
603 void emitSkeletonAbbrevs(const MCSection *);
605 /// \brief Emit the debug info dwo section.
606 void emitDebugInfoDWO();
608 /// \brief Emit the debug abbrev dwo section.
609 void emitDebugAbbrevDWO();
611 /// \brief Emit the debug str dwo section.
612 void emitDebugStrDWO();
614 /// \brief Create new CompileUnit for the given metadata node with tag
615 /// DW_TAG_compile_unit.
616 CompileUnit *constructCompileUnit(DICompileUnit DIUnit);
618 /// \brief Construct subprogram DIE.
619 void constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N);
621 /// \brief Construct imported_module or imported_declaration DIE.
622 void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N);
624 /// \brief Construct import_module DIE.
625 void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
628 /// \brief Construct import_module DIE.
629 void constructImportedEntityDIE(CompileUnit *TheCU,
630 const DIImportedEntity &Module,
633 /// \brief Register a source line with debug info. Returns the unique
634 /// label that was emitted and which provides correspondence to the
635 /// source line list.
636 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
639 /// \brief Indentify instructions that are marking the beginning of or
640 /// ending of a scope.
641 void identifyScopeMarkers();
643 /// \brief If Var is an current function argument that add it in
644 /// CurrentFnArguments list.
645 bool addCurrentFnArgument(const MachineFunction *MF,
646 DbgVariable *Var, LexicalScope *Scope);
648 /// \brief Populate LexicalScope entries with variables' info.
649 void collectVariableInfo(const MachineFunction *,
650 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
652 /// \brief Collect variable information from the side table maintained
654 void collectVariableInfoFromMMITable(const MachineFunction * MF,
655 SmallPtrSet<const MDNode *, 16> &P);
657 /// \brief Ensure that a label will be emitted before MI.
658 void requestLabelBeforeInsn(const MachineInstr *MI) {
659 LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
662 /// \brief Return Label preceding the instruction.
663 MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
665 /// \brief Ensure that a label will be emitted after MI.
666 void requestLabelAfterInsn(const MachineInstr *MI) {
667 LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
670 /// \brief Return Label immediately following the instruction.
671 MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
674 //===--------------------------------------------------------------------===//
675 // Main entry points.
677 DwarfDebug(AsmPrinter *A, Module *M);
679 void insertDIE(const MDNode *TypeMD, DIE *Die) {
680 MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
682 DIE *getDIE(const MDNode *TypeMD) {
683 return MDTypeNodeToDieMap.lookup(TypeMD);
686 /// \brief Emit all Dwarf sections that should come prior to the
690 /// \brief Emit all Dwarf sections that should come after the content.
693 /// \brief Gather pre-function debug information.
694 void beginFunction(const MachineFunction *MF);
696 /// \brief Gather and emit post-function debug information.
697 void endFunction(const MachineFunction *MF);
699 /// \brief Process beginning of an instruction.
700 void beginInstruction(const MachineInstr *MI);
702 /// \brief Process end of an instruction.
703 void endInstruction(const MachineInstr *MI);
705 /// \brief Add a DIE to the set of types that we're going to pull into
707 void addTypeUnitType(DIE *Die, DICompositeType CTy);
709 /// \brief Add a label so that arange data can be generated for it.
710 void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
712 /// \brief For symbols that have a size designated (e.g. common symbols),
713 /// this tracks that size.
714 void setSymbolSize(const MCSymbol *Sym, uint64_t Size) { SymSize[Sym] = Size;}
716 /// \brief Look up the source id with the given directory and source file
717 /// names. If none currently exists, create a new id and insert it in the
719 unsigned getOrCreateSourceID(StringRef DirName, StringRef FullName,
722 /// \brief Recursively Emits a debug information entry.
723 void emitDIE(DIE *Die, ArrayRef<DIEAbbrev *> Abbrevs);
725 // Experimental DWARF5 features.
727 /// \brief Returns whether or not to emit tables that dwarf consumers can
728 /// use to accelerate lookup.
729 bool useDwarfAccelTables() { return HasDwarfAccelTables; }
731 /// \brief Returns whether or not to change the current debug info for the
732 /// split dwarf proposal support.
733 bool useSplitDwarf() { return HasSplitDwarf; }
735 /// Returns the Dwarf Version.
736 unsigned getDwarfVersion() const { return DwarfVersion; }
738 /// Find the MDNode for the given reference.
739 template <typename T> T resolve(DIRef<T> Ref) const {
740 return Ref.resolve(TypeIdentifierMap);
743 /// isSubprogramContext - Return true if Context is either a subprogram
744 /// or another context nested inside a subprogram.
745 bool isSubprogramContext(const MDNode *Context);
748 } // End of namespace llvm