1 //===-- llvm/CodeGen/DwarfDebug.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 // This file contains support for writing dwarf debug info into asm files.
11 //
12 //===----------------------------------------------------------------------===//
14 #ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__
15 #define CODEGEN_ASMPRINTER_DWARFDEBUG_H__
17 #include "DwarfFile.h"
18 #include "AsmPrinterHandler.h"
19 #include "DIE.h"
20 #include "DbgValueHistoryCalculator.h"
21 #include "DebugLocEntry.h"
22 #include "DebugLocList.h"
23 #include "DwarfAccelTable.h"
24 #include "llvm/ADT/DenseMap.h"
25 #include "llvm/ADT/MapVector.h"
26 #include "llvm/ADT/SmallPtrSet.h"
27 #include "llvm/ADT/StringMap.h"
28 #include "llvm/ADT/FoldingSet.h"
29 #include "llvm/CodeGen/LexicalScopes.h"
30 #include "llvm/CodeGen/MachineInstr.h"
31 #include "llvm/IR/DebugInfo.h"
32 #include "llvm/IR/DebugLoc.h"
33 #include "llvm/MC/MachineLocation.h"
34 #include "llvm/MC/MCDwarf.h"
35 #include "llvm/Support/Allocator.h"
37 #include <memory>
39 namespace llvm {
41 class AsmPrinter;
42 class ByteStreamer;
43 class ConstantInt;
44 class ConstantFP;
45 class DwarfCompileUnit;
46 class DwarfDebug;
47 class DwarfTypeUnit;
48 class DwarfUnit;
49 class MachineModuleInfo;
51 //===----------------------------------------------------------------------===//
52 /// \brief This class is used to record source line correspondence.
53 class SrcLineInfo {
54 unsigned Line; // Source line number.
55 unsigned Column; // Source column.
56 unsigned SourceID; // Source ID number.
57 MCSymbol *Label; // Label in code ID number.
58 public:
59 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
60 : Line(L), Column(C), SourceID(S), Label(label) {}
62 // Accessors
63 unsigned getLine() const { return Line; }
64 unsigned getColumn() const { return Column; }
65 unsigned getSourceID() const { return SourceID; }
66 MCSymbol *getLabel() const { return Label; }
67 };
69 //===----------------------------------------------------------------------===//
70 /// \brief This class is used to track local variable information.
71 class DbgVariable {
72 DIVariable Var; // Variable Descriptor.
73 DIE *TheDIE; // Variable DIE.
74 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
75 const MachineInstr *MInsn; // DBG_VALUE instruction of the variable.
76 int FrameIndex;
77 DwarfDebug *DD;
79 public:
80 /// Construct a DbgVariable from a DIVariable.
81 DbgVariable(DIVariable V, DwarfDebug *DD)
82 : Var(V), TheDIE(nullptr), DotDebugLocOffset(~0U), MInsn(nullptr),
83 FrameIndex(~0), DD(DD) {}
85 /// Construct a DbgVariable from a DEBUG_VALUE.
86 /// AbstractVar may be NULL.
87 DbgVariable(const MachineInstr *DbgValue, DwarfDebug *DD)
88 : Var(DbgValue->getDebugVariable()), TheDIE(nullptr),
89 DotDebugLocOffset(~0U), MInsn(DbgValue), FrameIndex(~0), DD(DD) {}
91 // Accessors.
92 DIVariable getVariable() const { return Var; }
93 void setDIE(DIE &D) { TheDIE = &D; }
94 DIE *getDIE() const { return TheDIE; }
95 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
96 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
97 StringRef getName() const { return Var.getName(); }
98 const MachineInstr *getMInsn() const { return MInsn; }
99 int getFrameIndex() const { return FrameIndex; }
100 void setFrameIndex(int FI) { FrameIndex = FI; }
101 // Translate tag to proper Dwarf tag.
102 dwarf::Tag getTag() const {
103 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
104 return dwarf::DW_TAG_formal_parameter;
106 return dwarf::DW_TAG_variable;
107 }
108 /// \brief Return true if DbgVariable is artificial.
109 bool isArtificial() const {
110 if (Var.isArtificial())
111 return true;
112 if (getType().isArtificial())
113 return true;
114 return false;
115 }
117 bool isObjectPointer() const {
118 if (Var.isObjectPointer())
119 return true;
120 if (getType().isObjectPointer())
121 return true;
122 return false;
123 }
125 bool variableHasComplexAddress() const {
126 assert(Var.isVariable() && "Invalid complex DbgVariable!");
127 return Var.hasComplexAddress();
128 }
129 bool isBlockByrefVariable() const;
130 unsigned getNumAddrElements() const {
131 assert(Var.isVariable() && "Invalid complex DbgVariable!");
132 return Var.getNumAddrElements();
133 }
134 uint64_t getAddrElement(unsigned i) const { return Var.getAddrElement(i); }
135 DIType getType() const;
137 private:
138 /// resolve - Look in the DwarfDebug map for the MDNode that
139 /// corresponds to the reference.
140 template <typename T> T resolve(DIRef<T> Ref) const;
141 };
144 /// \brief Helper used to pair up a symbol and its DWARF compile unit.
145 struct SymbolCU {
146 SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
147 const MCSymbol *Sym;
148 DwarfCompileUnit *CU;
149 };
151 /// \brief Collects and handles dwarf debug information.
152 class DwarfDebug : public AsmPrinterHandler {
153 // Target of Dwarf emission.
154 AsmPrinter *Asm;
156 // Collected machine module information.
157 MachineModuleInfo *MMI;
159 // All DIEValues are allocated through this allocator.
160 BumpPtrAllocator DIEValueAllocator;
162 // Handle to the compile unit used for the inline extension handling,
163 // this is just so that the DIEValue allocator has a place to store
164 // the particular elements.
165 // FIXME: Store these off of DwarfDebug instead?
166 DwarfCompileUnit *FirstCU;
168 // Maps MDNode with its corresponding DwarfCompileUnit.
169 MapVector<const MDNode *, DwarfCompileUnit *> CUMap;
171 // Maps subprogram MDNode with its corresponding DwarfCompileUnit.
172 DenseMap<const MDNode *, DwarfCompileUnit *> SPMap;
174 // Maps a CU DIE with its corresponding DwarfCompileUnit.
175 DenseMap<const DIE *, DwarfCompileUnit *> CUDieMap;
177 /// Maps MDNodes for type system with the corresponding DIEs. These DIEs can
178 /// be shared across CUs, that is why we keep the map here instead
179 /// of in DwarfCompileUnit.
180 DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
182 // List of all labels used in aranges generation.
183 std::vector<SymbolCU> ArangeLabels;
185 // Size of each symbol emitted (for those symbols that have a specific size).
186 DenseMap<const MCSymbol *, uint64_t> SymSize;
188 // Provides a unique id per text section.
189 typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
190 SectionMapType SectionMap;
192 // List of arguments for current function.
193 SmallVector<DbgVariable *, 8> CurrentFnArguments;
195 LexicalScopes LScopes;
197 // Collection of abstract subprogram DIEs.
198 DenseMap<const MDNode *, DIE *> AbstractSPDies;
200 // Collection of dbg variables of a scope.
201 typedef DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >
202 ScopeVariablesMap;
203 ScopeVariablesMap ScopeVariables;
205 // Collection of abstract variables.
206 DenseMap<const MDNode *, std::unique_ptr<DbgVariable>> AbstractVariables;
207 SmallVector<std::unique_ptr<DbgVariable>, 64> ConcreteVariables;
209 // Collection of DebugLocEntry. Stored in a linked list so that DIELocLists
210 // can refer to them in spite of insertions into this list.
211 SmallVector<DebugLocList, 4> DotDebugLocEntries;
213 // Collection of subprogram DIEs that are marked (at the end of the module)
214 // as DW_AT_inline.
215 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
217 // This is a collection of subprogram MDNodes that are processed to
218 // create DIEs.
219 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
221 // Maps instruction with label emitted before instruction.
222 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
224 // Maps instruction with label emitted after instruction.
225 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
227 // History of DBG_VALUE and clobber instructions for each user variable.
228 // Variables are listed in order of appearance.
229 DbgValueHistoryMap DbgValues;
231 // Previous instruction's location information. This is used to determine
232 // label location to indicate scope boundries in dwarf debug info.
233 DebugLoc PrevInstLoc;
234 MCSymbol *PrevLabel;
236 // This location indicates end of function prologue and beginning of function
237 // body.
238 DebugLoc PrologEndLoc;
240 // If nonnull, stores the current machine function we're processing.
241 const MachineFunction *CurFn;
243 // If nonnull, stores the current machine instruction we're processing.
244 const MachineInstr *CurMI;
246 // If nonnull, stores the section that the previous function was allocated to
247 // emitting.
248 const MCSection *PrevSection;
250 // If nonnull, stores the CU in which the previous subprogram was contained.
251 const DwarfCompileUnit *PrevCU;
253 // Section Symbols: these are assembler temporary labels that are emitted at
254 // the beginning of each supported dwarf section. These are used to form
255 // section offsets and are created by EmitSectionLabels.
256 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
257 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
258 MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
259 MCSymbol *FunctionBeginSym, *FunctionEndSym;
260 MCSymbol *DwarfInfoDWOSectionSym, *DwarfAbbrevDWOSectionSym;
261 MCSymbol *DwarfTypesDWOSectionSym;
262 MCSymbol *DwarfStrDWOSectionSym;
263 MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
265 // As an optimization, there is no need to emit an entry in the directory
266 // table for the same directory as DW_AT_comp_dir.
267 StringRef CompilationDir;
269 // Counter for assigning globally unique IDs for ranges.
270 unsigned GlobalRangeCount;
272 // Holder for the file specific debug information.
273 DwarfFile InfoHolder;
275 // Holders for the various debug information flags that we might need to
276 // have exposed. See accessor functions below for description.
278 // Holder for imported entities.
279 typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
280 ImportedEntityMap;
281 ImportedEntityMap ScopesWithImportedEntities;
283 // Map from MDNodes for user-defined types to the type units that describe
284 // them.
285 DenseMap<const MDNode *, const DwarfTypeUnit *> DwarfTypeUnits;
287 SmallVector<std::pair<std::unique_ptr<DwarfTypeUnit>, DICompositeType>, 1> TypeUnitsUnderConstruction;
289 // Whether to emit the pubnames/pubtypes sections.
290 bool HasDwarfPubSections;
292 // Whether or not to use AT_ranges for compilation units.
293 bool HasCURanges;
295 // Whether we emitted a function into a section other than the default
296 // text.
297 bool UsedNonDefaultText;
299 // Version of dwarf we're emitting.
300 unsigned DwarfVersion;
302 // Maps from a type identifier to the actual MDNode.
303 DITypeIdentifierMap TypeIdentifierMap;
305 // DWARF5 Experimental Options
306 bool HasDwarfAccelTables;
307 bool HasSplitDwarf;
309 // Separated Dwarf Variables
310 // In general these will all be for bits that are left in the
311 // original object file, rather than things that are meant
312 // to be in the .dwo sections.
314 // Holder for the skeleton information.
315 DwarfFile SkeletonHolder;
317 /// Store file names for type units under fission in a line table header that
318 /// will be emitted into debug_line.dwo.
319 // FIXME: replace this with a map from comp_dir to table so that we can emit
320 // multiple tables during LTO each of which uses directory 0, referencing the
321 // comp_dir of all the type units that use it.
322 MCDwarfDwoLineTable SplitTypeUnitFileTable;
324 // True iff there are multiple CUs in this module.
325 bool SingleCU;
327 AddressPool AddrPool;
329 DwarfAccelTable AccelNames;
330 DwarfAccelTable AccelObjC;
331 DwarfAccelTable AccelNamespace;
332 DwarfAccelTable AccelTypes;
334 DenseMap<const Function *, DISubprogram> FunctionDIs;
336 MCDwarfDwoLineTable *getDwoLineTable(const DwarfCompileUnit &);
338 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
340 const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() {
341 return InfoHolder.getUnits();
342 }
344 /// \brief Find abstract variable associated with Var.
345 DbgVariable *getExistingAbstractVariable(const DIVariable &DV,
346 DIVariable &Cleansed);
347 DbgVariable *getExistingAbstractVariable(const DIVariable &DV);
348 void createAbstractVariable(const DIVariable &DV, LexicalScope *Scope);
349 void ensureAbstractVariableIsCreated(const DIVariable &Var,
350 const MDNode *Scope);
351 void ensureAbstractVariableIsCreatedIfScoped(const DIVariable &Var,
352 const MDNode *Scope);
354 /// \brief Find DIE for the given subprogram and attach appropriate
355 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
356 /// variables in this scope then create and insert DIEs for these
357 /// variables.
358 DIE &updateSubprogramScopeDIE(DwarfCompileUnit &SPCU, DISubprogram SP);
360 /// \brief A helper function to check whether the DIE for a given Scope is
361 /// going to be null.
362 bool isLexicalScopeDIENull(LexicalScope *Scope);
364 /// \brief A helper function to construct a RangeSpanList for a given
365 /// lexical scope.
366 void addScopeRangeList(DwarfCompileUnit &TheCU, DIE &ScopeDIE,
367 const SmallVectorImpl<InsnRange> &Range);
369 /// \brief Construct new DW_TAG_lexical_block for this scope and
370 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
371 std::unique_ptr<DIE> constructLexicalScopeDIE(DwarfCompileUnit &TheCU,
372 LexicalScope *Scope);
374 /// \brief This scope represents inlined body of a function. Construct
375 /// DIE to represent this concrete inlined copy of the function.
376 std::unique_ptr<DIE> constructInlinedScopeDIE(DwarfCompileUnit &TheCU,
377 LexicalScope *Scope);
379 /// \brief Construct a DIE for this scope.
380 std::unique_ptr<DIE> constructScopeDIE(DwarfCompileUnit &TheCU,
381 LexicalScope *Scope);
382 void createAndAddScopeChildren(DwarfCompileUnit &TheCU, LexicalScope *Scope,
383 DIE &ScopeDIE);
384 /// \brief Construct a DIE for this abstract scope.
385 void constructAbstractSubprogramScopeDIE(DwarfCompileUnit &TheCU,
386 LexicalScope *Scope);
387 /// \brief Construct a DIE for this subprogram scope.
388 DIE &constructSubprogramScopeDIE(DwarfCompileUnit &TheCU,
389 LexicalScope *Scope);
390 /// A helper function to create children of a Scope DIE.
391 DIE *createScopeChildrenDIE(DwarfCompileUnit &TheCU, LexicalScope *Scope,
392 SmallVectorImpl<std::unique_ptr<DIE>> &Children);
394 /// \brief Emit initial Dwarf sections with a label at the start of each one.
395 void emitSectionLabels();
397 /// \brief Compute the size and offset of a DIE given an incoming Offset.
398 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
400 /// \brief Compute the size and offset of all the DIEs.
401 void computeSizeAndOffsets();
403 /// \brief Collect info for variables that were optimized out.
404 void collectDeadVariables();
406 void finishVariableDefinitions();
408 void finishSubprogramDefinitions();
410 /// \brief Finish off debug information after all functions have been
411 /// processed.
412 void finalizeModuleInfo();
414 /// \brief Emit labels to close any remaining sections that have been left
415 /// open.
416 void endSections();
418 /// \brief Emit the debug info section.
419 void emitDebugInfo();
421 /// \brief Emit the abbreviation section.
422 void emitAbbreviations();
424 /// \brief Emit the last address of the section and the end of
425 /// the line matrix.
426 void emitEndOfLineMatrix(unsigned SectionEnd);
428 /// \brief Emit visible names into a hashed accelerator table section.
429 void emitAccelNames();
431 /// \brief Emit objective C classes and categories into a hashed
432 /// accelerator table section.
433 void emitAccelObjC();
435 /// \brief Emit namespace dies into a hashed accelerator table.
436 void emitAccelNamespaces();
438 /// \brief Emit type dies into a hashed accelerator table.
439 void emitAccelTypes();
441 /// \brief Emit visible names into a debug pubnames section.
442 /// \param GnuStyle determines whether or not we want to emit
443 /// additional information into the table ala newer gcc for gdb
444 /// index.
445 void emitDebugPubNames(bool GnuStyle = false);
447 /// \brief Emit visible types into a debug pubtypes section.
448 /// \param GnuStyle determines whether or not we want to emit
449 /// additional information into the table ala newer gcc for gdb
450 /// index.
451 void emitDebugPubTypes(bool GnuStyle = false);
453 void
454 emitDebugPubSection(bool GnuStyle, const MCSection *PSec, StringRef Name,
455 const StringMap<const DIE *> &(DwarfUnit::*Accessor)()
456 const);
458 /// \brief Emit visible names into a debug str section.
459 void emitDebugStr();
461 /// \brief Emit visible names into a debug loc section.
462 void emitDebugLoc();
464 /// \brief Emit visible names into a debug loc dwo section.
465 void emitDebugLocDWO();
467 /// \brief Emit visible names into a debug aranges section.
468 void emitDebugARanges();
470 /// \brief Emit visible names into a debug ranges section.
471 void emitDebugRanges();
473 /// \brief Emit inline info using custom format.
474 void emitDebugInlineInfo();
476 /// DWARF 5 Experimental Split Dwarf Emitters
478 /// \brief Initialize common features of skeleton units.
479 void initSkeletonUnit(const DwarfUnit &U, DIE &Die,
480 std::unique_ptr<DwarfUnit> NewU);
482 /// \brief Construct the split debug info compile unit for the debug info
483 /// section.
484 DwarfCompileUnit &constructSkeletonCU(const DwarfCompileUnit &CU);
486 /// \brief Construct the split debug info compile unit for the debug info
487 /// section.
488 DwarfTypeUnit &constructSkeletonTU(DwarfTypeUnit &TU);
490 /// \brief Emit the debug info dwo section.
491 void emitDebugInfoDWO();
493 /// \brief Emit the debug abbrev dwo section.
494 void emitDebugAbbrevDWO();
496 /// \brief Emit the debug line dwo section.
497 void emitDebugLineDWO();
499 /// \brief Emit the debug str dwo section.
500 void emitDebugStrDWO();
502 /// Flags to let the linker know we have emitted new style pubnames. Only
503 /// emit it here if we don't have a skeleton CU for split dwarf.
504 void addGnuPubAttributes(DwarfUnit &U, DIE &D) const;
506 /// \brief Create new DwarfCompileUnit for the given metadata node with tag
507 /// DW_TAG_compile_unit.
508 DwarfCompileUnit &constructDwarfCompileUnit(DICompileUnit DIUnit);
510 /// \brief Construct imported_module or imported_declaration DIE.
511 void constructImportedEntityDIE(DwarfCompileUnit &TheCU, const MDNode *N);
513 /// \brief Construct import_module DIE.
514 void constructImportedEntityDIE(DwarfCompileUnit &TheCU, const MDNode *N,
515 DIE &Context);
517 /// \brief Construct import_module DIE.
518 void constructImportedEntityDIE(DwarfCompileUnit &TheCU,
519 const DIImportedEntity &Module, DIE &Context);
521 /// \brief Register a source line with debug info. Returns the unique
522 /// label that was emitted and which provides correspondence to the
523 /// source line list.
524 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
525 unsigned Flags);
527 /// \brief Indentify instructions that are marking the beginning of or
528 /// ending of a scope.
529 void identifyScopeMarkers();
531 /// \brief If Var is an current function argument that add it in
532 /// CurrentFnArguments list.
533 bool addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope);
535 /// \brief Populate LexicalScope entries with variables' info.
536 void collectVariableInfo(SmallPtrSet<const MDNode *, 16> &ProcessedVars);
538 /// \brief Build the location list for all DBG_VALUEs in the
539 /// function that describe the same variable.
540 void buildLocationList(SmallVectorImpl<DebugLocEntry> &DebugLoc,
541 const DbgValueHistoryMap::InstrRanges &Ranges);
543 /// \brief Collect variable information from the side table maintained
544 /// by MMI.
545 void collectVariableInfoFromMMITable(SmallPtrSet<const MDNode *, 16> &P);
547 /// \brief Ensure that a label will be emitted before MI.
548 void requestLabelBeforeInsn(const MachineInstr *MI) {
549 LabelsBeforeInsn.insert(std::make_pair(MI, nullptr));
550 }
552 /// \brief Return Label preceding the instruction.
553 MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
555 /// \brief Ensure that a label will be emitted after MI.
556 void requestLabelAfterInsn(const MachineInstr *MI) {
557 LabelsAfterInsn.insert(std::make_pair(MI, nullptr));
558 }
560 /// \brief Return Label immediately following the instruction.
561 MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
563 void attachRangesOrLowHighPC(DwarfCompileUnit &Unit, DIE &D,
564 const SmallVectorImpl<InsnRange> &Ranges);
565 void attachLowHighPC(DwarfCompileUnit &Unit, DIE &D, MCSymbol *Begin,
566 MCSymbol *End);
568 public:
569 //===--------------------------------------------------------------------===//
570 // Main entry points.
571 //
572 DwarfDebug(AsmPrinter *A, Module *M);
574 ~DwarfDebug() override;
576 void insertDIE(const MDNode *TypeMD, DIE *Die) {
577 MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
578 }
579 DIE *getDIE(const MDNode *TypeMD) {
580 return MDTypeNodeToDieMap.lookup(TypeMD);
581 }
583 /// \brief Emit all Dwarf sections that should come prior to the
584 /// content.
585 void beginModule();
587 /// \brief Emit all Dwarf sections that should come after the content.
588 void endModule() override;
590 /// \brief Gather pre-function debug information.
591 void beginFunction(const MachineFunction *MF) override;
593 /// \brief Gather and emit post-function debug information.
594 void endFunction(const MachineFunction *MF) override;
596 /// \brief Process beginning of an instruction.
597 void beginInstruction(const MachineInstr *MI) override;
599 /// \brief Process end of an instruction.
600 void endInstruction() override;
602 /// \brief Add a DIE to the set of types that we're going to pull into
603 /// type units.
604 void addDwarfTypeUnitType(DwarfCompileUnit &CU, StringRef Identifier,
605 DIE &Die, DICompositeType CTy);
607 /// \brief Add a label so that arange data can be generated for it.
608 void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
610 /// \brief For symbols that have a size designated (e.g. common symbols),
611 /// this tracks that size.
612 void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override {
613 SymSize[Sym] = Size;
614 }
616 /// \brief Recursively Emits a debug information entry.
617 void emitDIE(DIE &Die);
619 // Experimental DWARF5 features.
621 /// \brief Returns whether or not to emit tables that dwarf consumers can
622 /// use to accelerate lookup.
623 bool useDwarfAccelTables() const { return HasDwarfAccelTables; }
625 /// \brief Returns whether or not to change the current debug info for the
626 /// split dwarf proposal support.
627 bool useSplitDwarf() const { return HasSplitDwarf; }
629 /// Returns the Dwarf Version.
630 unsigned getDwarfVersion() const { return DwarfVersion; }
632 /// Returns the section symbol for the .debug_loc section.
633 MCSymbol *getDebugLocSym() const { return DwarfDebugLocSectionSym; }
635 /// Returns the previous section that was emitted into.
636 const MCSection *getPrevSection() const { return PrevSection; }
638 /// Returns the previous CU that was being updated
639 const DwarfCompileUnit *getPrevCU() const { return PrevCU; }
641 /// Returns the entries for the .debug_loc section.
642 const SmallVectorImpl<DebugLocList> &
643 getDebugLocEntries() const {
644 return DotDebugLocEntries;
645 }
647 /// \brief Emit an entry for the debug loc section. This can be used to
648 /// handle an entry that's going to be emitted into the debug loc section.
649 void emitDebugLocEntry(ByteStreamer &Streamer, const DebugLocEntry &Entry);
650 /// \brief emit a single value for the debug loc section.
651 void emitDebugLocValue(ByteStreamer &Streamer,
652 const DebugLocEntry::Value &Value);
653 /// Emits an optimal (=sorted) sequence of DW_OP_pieces.
654 void emitLocPieces(ByteStreamer &Streamer,
655 const DITypeIdentifierMap &Map,
656 ArrayRef<DebugLocEntry::Value> Values);
658 /// Emit the location for a debug loc entry, including the size header.
659 void emitDebugLocEntryLocation(const DebugLocEntry &Entry);
661 /// Find the MDNode for the given reference.
662 template <typename T> T resolve(DIRef<T> Ref) const {
663 return Ref.resolve(TypeIdentifierMap);
664 }
666 /// \brief Return the TypeIdentifierMap.
667 const DITypeIdentifierMap &getTypeIdentifierMap() const {
668 return TypeIdentifierMap;
669 }
671 /// Find the DwarfCompileUnit for the given CU Die.
672 DwarfCompileUnit *lookupUnit(const DIE *CU) const {
673 return CUDieMap.lookup(CU);
674 }
675 /// isSubprogramContext - Return true if Context is either a subprogram
676 /// or another context nested inside a subprogram.
677 bool isSubprogramContext(const MDNode *Context);
679 void addSubprogramNames(DISubprogram SP, DIE &Die);
681 AddressPool &getAddressPool() { return AddrPool; }
683 void addAccelName(StringRef Name, const DIE &Die);
685 void addAccelObjC(StringRef Name, const DIE &Die);
687 void addAccelNamespace(StringRef Name, const DIE &Die);
689 void addAccelType(StringRef Name, const DIE &Die, char Flags);
690 };
691 } // End of namespace llvm
693 #endif