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 LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H
17 #include "AsmPrinterHandler.h"
18 #include "DbgValueHistoryCalculator.h"
19 #include "DebugLocEntry.h"
20 #include "DebugLocList.h"
21 #include "DwarfAccelTable.h"
22 #include "DwarfFile.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/FoldingSet.h"
25 #include "llvm/ADT/MapVector.h"
26 #include "llvm/ADT/SmallPtrSet.h"
27 #include "llvm/ADT/StringMap.h"
28 #include "llvm/CodeGen/DIE.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/MCDwarf.h"
34 #include "llvm/MC/MachineLocation.h"
35 #include "llvm/Support/Allocator.h"
44 class DwarfCompileUnit;
48 class MachineModuleInfo;
50 //===----------------------------------------------------------------------===//
51 /// \brief This class is used to record source line correspondence.
53 unsigned Line; // Source line number.
54 unsigned Column; // Source column.
55 unsigned SourceID; // Source ID number.
56 MCSymbol *Label; // Label in code ID number.
58 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
59 : Line(L), Column(C), SourceID(S), Label(label) {}
62 unsigned getLine() const { return Line; }
63 unsigned getColumn() const { return Column; }
64 unsigned getSourceID() const { return SourceID; }
65 MCSymbol *getLabel() const { return Label; }
68 //===----------------------------------------------------------------------===//
69 /// \brief This class is used to track local variable information.
71 /// - Variables whose location changes over time have a DotDebugLocOffset and
72 /// the other fields are not used.
74 /// - Variables that are described by multiple MMI table entries have multiple
75 /// expressions and frame indices.
77 DIVariable Var; /// Variable Descriptor.
78 SmallVector<DIExpression, 1> Expr; /// Complex address location expression.
79 DIE *TheDIE; /// Variable DIE.
80 unsigned DotDebugLocOffset; /// Offset in DotDebugLocEntries.
81 const MachineInstr *MInsn; /// DBG_VALUE instruction of the variable.
82 SmallVector<int, 1> FrameIndex; /// Frame index of the variable.
86 /// Construct a DbgVariable from a DIVariable.
87 DbgVariable(DIVariable V, DIExpression E, DwarfDebug *DD, int FI = ~0)
88 : Var(V), Expr(1, E), TheDIE(nullptr), DotDebugLocOffset(~0U),
89 MInsn(nullptr), DD(DD) {
90 FrameIndex.push_back(FI);
91 assert(Var.Verify() && E.Verify());
94 /// Construct a DbgVariable from a DEBUG_VALUE.
95 /// AbstractVar may be NULL.
96 DbgVariable(const MachineInstr *DbgValue, DwarfDebug *DD)
97 : Var(DbgValue->getDebugVariable()),
98 Expr(1, DbgValue->getDebugExpression()), TheDIE(nullptr),
99 DotDebugLocOffset(~0U), MInsn(DbgValue), DD(DD) {
100 FrameIndex.push_back(~0);
104 DIVariable getVariable() const { return Var; }
105 const ArrayRef<DIExpression> getExpression() const { return Expr; }
106 void setDIE(DIE &D) { TheDIE = &D; }
107 DIE *getDIE() const { return TheDIE; }
108 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
109 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
110 StringRef getName() const { return Var.getName(); }
111 const MachineInstr *getMInsn() const { return MInsn; }
112 const ArrayRef<int> getFrameIndex() const { return FrameIndex; }
114 void addMMIEntry(const DbgVariable &V) {
115 assert( DotDebugLocOffset == ~0U && !MInsn && "not an MMI entry");
116 assert(V.DotDebugLocOffset == ~0U && !V.MInsn && "not an MMI entry");
117 assert(V.Var == Var && "conflicting DIVariable");
119 if (V.getFrameIndex().back() != ~0) {
120 auto E = V.getExpression();
121 auto FI = V.getFrameIndex();
122 Expr.append(E.begin(), E.end());
123 FrameIndex.append(FI.begin(), FI.end());
125 assert(Expr.size() > 1
126 ? std::all_of(Expr.begin(), Expr.end(),
127 [](DIExpression &E) { return E.isBitPiece(); })
128 : (true && "conflicting locations for variable"));
131 // Translate tag to proper Dwarf tag.
132 dwarf::Tag getTag() const {
133 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
134 return dwarf::DW_TAG_formal_parameter;
136 return dwarf::DW_TAG_variable;
138 /// \brief Return true if DbgVariable is artificial.
139 bool isArtificial() const {
140 if (Var.isArtificial())
142 if (getType().isArtificial())
147 bool isObjectPointer() const {
148 if (Var.isObjectPointer())
150 if (getType().isObjectPointer())
155 bool variableHasComplexAddress() const {
156 assert(Var.isVariable() && "Invalid complex DbgVariable!");
157 assert(Expr.size() == 1 &&
158 "variableHasComplexAddress() invoked on multi-FI variable");
159 return Expr.back().getNumElements() > 0;
161 bool isBlockByrefVariable() const;
162 DIType getType() const;
165 /// resolve - Look in the DwarfDebug map for the MDNode that
166 /// corresponds to the reference.
167 template <typename T> T resolve(DIRef<T> Ref) const;
171 /// \brief Helper used to pair up a symbol and its DWARF compile unit.
173 SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
175 DwarfCompileUnit *CU;
178 /// \brief Collects and handles dwarf debug information.
179 class DwarfDebug : public AsmPrinterHandler {
180 // Target of Dwarf emission.
183 // Collected machine module information.
184 MachineModuleInfo *MMI;
186 // All DIEValues are allocated through this allocator.
187 BumpPtrAllocator DIEValueAllocator;
189 // Maps MDNode with its corresponding DwarfCompileUnit.
190 MapVector<const MDNode *, DwarfCompileUnit *> CUMap;
192 // Maps subprogram MDNode with its corresponding DwarfCompileUnit.
193 MapVector<const MDNode *, DwarfCompileUnit *> SPMap;
195 // Maps a CU DIE with its corresponding DwarfCompileUnit.
196 DenseMap<const DIE *, DwarfCompileUnit *> CUDieMap;
198 // List of all labels used in aranges generation.
199 std::vector<SymbolCU> ArangeLabels;
201 // Size of each symbol emitted (for those symbols that have a specific size).
202 DenseMap<const MCSymbol *, uint64_t> SymSize;
204 LexicalScopes LScopes;
206 // Collection of abstract variables.
207 DenseMap<const MDNode *, std::unique_ptr<DbgVariable>> AbstractVariables;
208 SmallVector<std::unique_ptr<DbgVariable>, 64> ConcreteVariables;
210 // Collection of DebugLocEntry. Stored in a linked list so that DIELocLists
211 // can refer to them in spite of insertions into this list.
212 SmallVector<DebugLocList, 4> DotDebugLocEntries;
214 // This is a collection of subprogram MDNodes that are processed to
216 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
218 // Maps instruction with label emitted before instruction.
219 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
221 // Maps instruction with label emitted after instruction.
222 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
224 // History of DBG_VALUE and clobber instructions for each user variable.
225 // Variables are listed in order of appearance.
226 DbgValueHistoryMap DbgValues;
228 // Previous instruction's location information. This is used to determine
229 // label location to indicate scope boundries in dwarf debug info.
230 DebugLoc PrevInstLoc;
233 // This location indicates end of function prologue and beginning of function
235 DebugLoc PrologEndLoc;
237 // If nonnull, stores the current machine function we're processing.
238 const MachineFunction *CurFn;
240 // If nonnull, stores the current machine instruction we're processing.
241 const MachineInstr *CurMI;
243 // If nonnull, stores the CU in which the previous subprogram was contained.
244 const DwarfCompileUnit *PrevCU;
246 // As an optimization, there is no need to emit an entry in the directory
247 // table for the same directory as DW_AT_comp_dir.
248 StringRef CompilationDir;
250 // Counter for assigning globally unique IDs for ranges.
251 unsigned GlobalRangeCount;
253 // Holder for the file specific debug information.
254 DwarfFile InfoHolder;
256 // Holders for the various debug information flags that we might need to
257 // have exposed. See accessor functions below for description.
259 // Holder for imported entities.
260 typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
262 ImportedEntityMap ScopesWithImportedEntities;
264 // Map from MDNodes for user-defined types to the type units that describe
266 DenseMap<const MDNode *, const DwarfTypeUnit *> DwarfTypeUnits;
268 SmallVector<std::pair<std::unique_ptr<DwarfTypeUnit>, DICompositeType>, 1>
269 TypeUnitsUnderConstruction;
271 // Whether to emit the pubnames/pubtypes sections.
272 bool HasDwarfPubSections;
274 // Whether or not to use AT_ranges for compilation units.
277 // Whether we emitted a function into a section other than the default
279 bool UsedNonDefaultText;
281 // Whether to use the GNU TLS opcode (instead of the standard opcode).
282 bool UseGNUTLSOpcode;
284 // Version of dwarf we're emitting.
285 unsigned DwarfVersion;
287 // Maps from a type identifier to the actual MDNode.
288 DITypeIdentifierMap TypeIdentifierMap;
290 // DWARF5 Experimental Options
291 bool HasDwarfAccelTables;
294 // Separated Dwarf Variables
295 // In general these will all be for bits that are left in the
296 // original object file, rather than things that are meant
297 // to be in the .dwo sections.
299 // Holder for the skeleton information.
300 DwarfFile SkeletonHolder;
302 /// Store file names for type units under fission in a line table header that
303 /// will be emitted into debug_line.dwo.
304 // FIXME: replace this with a map from comp_dir to table so that we can emit
305 // multiple tables during LTO each of which uses directory 0, referencing the
306 // comp_dir of all the type units that use it.
307 MCDwarfDwoLineTable SplitTypeUnitFileTable;
309 // True iff there are multiple CUs in this module.
314 AddressPool AddrPool;
316 DwarfAccelTable AccelNames;
317 DwarfAccelTable AccelObjC;
318 DwarfAccelTable AccelNamespace;
319 DwarfAccelTable AccelTypes;
321 DenseMap<const Function *, DISubprogram> FunctionDIs;
323 MCDwarfDwoLineTable *getDwoLineTable(const DwarfCompileUnit &);
325 const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() {
326 return InfoHolder.getUnits();
329 /// \brief Find abstract variable associated with Var.
330 DbgVariable *getExistingAbstractVariable(const DIVariable &DV,
331 DIVariable &Cleansed);
332 DbgVariable *getExistingAbstractVariable(const DIVariable &DV);
333 void createAbstractVariable(const DIVariable &DV, LexicalScope *Scope);
334 void ensureAbstractVariableIsCreated(const DIVariable &Var,
335 const MDNode *Scope);
336 void ensureAbstractVariableIsCreatedIfScoped(const DIVariable &Var,
337 const MDNode *Scope);
339 /// \brief Construct a DIE for this abstract scope.
340 void constructAbstractSubprogramScopeDIE(LexicalScope *Scope);
342 /// \brief Compute the size and offset of a DIE given an incoming Offset.
343 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
345 /// \brief Compute the size and offset of all the DIEs.
346 void computeSizeAndOffsets();
348 /// \brief Collect info for variables that were optimized out.
349 void collectDeadVariables();
351 void finishVariableDefinitions();
353 void finishSubprogramDefinitions();
355 /// \brief Finish off debug information after all functions have been
357 void finalizeModuleInfo();
359 /// \brief Emit the debug info section.
360 void emitDebugInfo();
362 /// \brief Emit the abbreviation section.
363 void emitAbbreviations();
365 /// \brief Emit the last address of the section and the end of
367 void emitEndOfLineMatrix(unsigned SectionEnd);
369 /// \brief Emit a specified accelerator table.
370 void emitAccel(DwarfAccelTable &Accel, const MCSection *Section,
371 StringRef TableName);
373 /// \brief Emit visible names into a hashed accelerator table section.
374 void emitAccelNames();
376 /// \brief Emit objective C classes and categories into a hashed
377 /// accelerator table section.
378 void emitAccelObjC();
380 /// \brief Emit namespace dies into a hashed accelerator table.
381 void emitAccelNamespaces();
383 /// \brief Emit type dies into a hashed accelerator table.
384 void emitAccelTypes();
386 /// \brief Emit visible names into a debug pubnames section.
387 /// \param GnuStyle determines whether or not we want to emit
388 /// additional information into the table ala newer gcc for gdb
390 void emitDebugPubNames(bool GnuStyle = false);
392 /// \brief Emit visible types into a debug pubtypes section.
393 /// \param GnuStyle determines whether or not we want to emit
394 /// additional information into the table ala newer gcc for gdb
396 void emitDebugPubTypes(bool GnuStyle = false);
398 void emitDebugPubSection(
399 bool GnuStyle, const MCSection *PSec, StringRef Name,
400 const StringMap<const DIE *> &(DwarfCompileUnit::*Accessor)() const);
402 /// \brief Emit visible names into a debug str section.
405 /// \brief Emit visible names into a debug loc section.
408 /// \brief Emit visible names into a debug loc dwo section.
409 void emitDebugLocDWO();
411 /// \brief Emit visible names into a debug aranges section.
412 void emitDebugARanges();
414 /// \brief Emit visible names into a debug ranges section.
415 void emitDebugRanges();
417 /// \brief Emit inline info using custom format.
418 void emitDebugInlineInfo();
420 /// DWARF 5 Experimental Split Dwarf Emitters
422 /// \brief Initialize common features of skeleton units.
423 void initSkeletonUnit(const DwarfUnit &U, DIE &Die,
424 std::unique_ptr<DwarfUnit> NewU);
426 /// \brief Construct the split debug info compile unit for the debug info
428 DwarfCompileUnit &constructSkeletonCU(const DwarfCompileUnit &CU);
430 /// \brief Construct the split debug info compile unit for the debug info
432 DwarfTypeUnit &constructSkeletonTU(DwarfTypeUnit &TU);
434 /// \brief Emit the debug info dwo section.
435 void emitDebugInfoDWO();
437 /// \brief Emit the debug abbrev dwo section.
438 void emitDebugAbbrevDWO();
440 /// \brief Emit the debug line dwo section.
441 void emitDebugLineDWO();
443 /// \brief Emit the debug str dwo section.
444 void emitDebugStrDWO();
446 /// Flags to let the linker know we have emitted new style pubnames. Only
447 /// emit it here if we don't have a skeleton CU for split dwarf.
448 void addGnuPubAttributes(DwarfUnit &U, DIE &D) const;
450 /// \brief Create new DwarfCompileUnit for the given metadata node with tag
451 /// DW_TAG_compile_unit.
452 DwarfCompileUnit &constructDwarfCompileUnit(DICompileUnit DIUnit);
454 /// \brief Construct imported_module or imported_declaration DIE.
455 void constructAndAddImportedEntityDIE(DwarfCompileUnit &TheCU,
458 /// \brief Register a source line with debug info. Returns the unique
459 /// label that was emitted and which provides correspondence to the
460 /// source line list.
461 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
464 /// \brief Indentify instructions that are marking the beginning of or
465 /// ending of a scope.
466 void identifyScopeMarkers();
468 /// \brief Populate LexicalScope entries with variables' info.
469 void collectVariableInfo(DwarfCompileUnit &TheCU, DISubprogram SP,
470 SmallPtrSetImpl<const MDNode *> &ProcessedVars);
472 /// \brief Build the location list for all DBG_VALUEs in the
473 /// function that describe the same variable.
474 void buildLocationList(SmallVectorImpl<DebugLocEntry> &DebugLoc,
475 const DbgValueHistoryMap::InstrRanges &Ranges);
477 /// \brief Collect variable information from the side table maintained
479 void collectVariableInfoFromMMITable(SmallPtrSetImpl<const MDNode *> &P);
481 /// \brief Ensure that a label will be emitted before MI.
482 void requestLabelBeforeInsn(const MachineInstr *MI) {
483 LabelsBeforeInsn.insert(std::make_pair(MI, nullptr));
486 /// \brief Ensure that a label will be emitted after MI.
487 void requestLabelAfterInsn(const MachineInstr *MI) {
488 LabelsAfterInsn.insert(std::make_pair(MI, nullptr));
492 //===--------------------------------------------------------------------===//
493 // Main entry points.
495 DwarfDebug(AsmPrinter *A, Module *M);
497 ~DwarfDebug() override;
499 /// \brief Emit all Dwarf sections that should come prior to the
503 /// \brief Emit all Dwarf sections that should come after the content.
504 void endModule() override;
506 /// \brief Gather pre-function debug information.
507 void beginFunction(const MachineFunction *MF) override;
509 /// \brief Gather and emit post-function debug information.
510 void endFunction(const MachineFunction *MF) override;
512 /// \brief Process beginning of an instruction.
513 void beginInstruction(const MachineInstr *MI) override;
515 /// \brief Process end of an instruction.
516 void endInstruction() override;
518 /// \brief Add a DIE to the set of types that we're going to pull into
520 void addDwarfTypeUnitType(DwarfCompileUnit &CU, StringRef Identifier,
521 DIE &Die, DICompositeType CTy);
523 /// \brief Add a label so that arange data can be generated for it.
524 void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
526 /// \brief For symbols that have a size designated (e.g. common symbols),
527 /// this tracks that size.
528 void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override {
532 /// \brief Returns whether to use DW_OP_GNU_push_tls_address, instead of the
533 /// standard DW_OP_form_tls_address opcode
534 bool useGNUTLSOpcode() const { return UseGNUTLSOpcode; }
536 // Experimental DWARF5 features.
538 /// \brief Returns whether or not to emit tables that dwarf consumers can
539 /// use to accelerate lookup.
540 bool useDwarfAccelTables() const { return HasDwarfAccelTables; }
542 /// \brief Returns whether or not to change the current debug info for the
543 /// split dwarf proposal support.
544 bool useSplitDwarf() const { return HasSplitDwarf; }
546 /// Returns the Dwarf Version.
547 unsigned getDwarfVersion() const { return DwarfVersion; }
549 /// Returns the previous CU that was being updated
550 const DwarfCompileUnit *getPrevCU() const { return PrevCU; }
551 void setPrevCU(const DwarfCompileUnit *PrevCU) { this->PrevCU = PrevCU; }
553 /// Returns the entries for the .debug_loc section.
554 const SmallVectorImpl<DebugLocList> &
555 getDebugLocEntries() const {
556 return DotDebugLocEntries;
559 /// \brief Emit an entry for the debug loc section. This can be used to
560 /// handle an entry that's going to be emitted into the debug loc section.
561 void emitDebugLocEntry(ByteStreamer &Streamer,
562 const DebugLocEntry &Entry);
563 /// \brief emit a single value for the debug loc section.
564 void emitDebugLocValue(ByteStreamer &Streamer,
565 const DebugLocEntry::Value &Value,
566 unsigned PieceOffsetInBits = 0);
567 /// Emits an optimal (=sorted) sequence of DW_OP_pieces.
568 void emitLocPieces(ByteStreamer &Streamer,
569 const DITypeIdentifierMap &Map,
570 ArrayRef<DebugLocEntry::Value> Values);
572 /// Emit the location for a debug loc entry, including the size header.
573 void emitDebugLocEntryLocation(const DebugLocEntry &Entry);
575 /// Find the MDNode for the given reference.
576 template <typename T> T resolve(DIRef<T> Ref) const {
577 return Ref.resolve(TypeIdentifierMap);
580 /// \brief Return the TypeIdentifierMap.
581 const DITypeIdentifierMap &getTypeIdentifierMap() const {
582 return TypeIdentifierMap;
585 /// Find the DwarfCompileUnit for the given CU Die.
586 DwarfCompileUnit *lookupUnit(const DIE *CU) const {
587 return CUDieMap.lookup(CU);
589 /// isSubprogramContext - Return true if Context is either a subprogram
590 /// or another context nested inside a subprogram.
591 bool isSubprogramContext(const MDNode *Context);
593 void addSubprogramNames(DISubprogram SP, DIE &Die);
595 AddressPool &getAddressPool() { return AddrPool; }
597 void addAccelName(StringRef Name, const DIE &Die);
599 void addAccelObjC(StringRef Name, const DIE &Die);
601 void addAccelNamespace(StringRef Name, const DIE &Die);
603 void addAccelType(StringRef Name, const DIE &Die, char Flags);
605 const MachineFunction *getCurrentFunction() const { return CurFn; }
607 iterator_range<ImportedEntityMap::const_iterator>
608 findImportedEntitiesForScope(const MDNode *Scope) const {
609 return make_range(std::equal_range(
610 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
611 std::pair<const MDNode *, const MDNode *>(Scope, nullptr),
615 /// \brief A helper function to check whether the DIE for a given Scope is
616 /// going to be null.
617 bool isLexicalScopeDIENull(LexicalScope *Scope);
619 /// \brief Return Label preceding the instruction.
620 MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
622 /// \brief Return Label immediately following the instruction.
623 MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
625 // FIXME: Consider rolling ranges up into DwarfDebug since we use a single
626 // range_base anyway, so there's no need to keep them as separate per-CU range
627 // lists. (though one day we might end up with a range.dwo section, in which
628 // case it'd go to DwarfFile)
629 unsigned getNextRangeNumber() { return GlobalRangeCount++; }
631 // FIXME: Sink these functions down into DwarfFile/Dwarf*Unit.
633 SmallPtrSet<const MDNode *, 16> &getProcessedSPNodes() {
634 return ProcessedSPNodes;
637 } // End of namespace llvm