blob: d7359a3105ee01de921848973d4e0ed567802d1a [file] [log] [blame]
Bill Wendling2f921f82009-05-15 09:23:25 +00001//===-- 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//===----------------------------------------------------------------------===//
13
14#ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__
15#define CODEGEN_ASMPRINTER_DWARFDEBUG_H__
16
David Blaikie85f80d72014-04-23 18:54:00 +000017#include "DwarfFile.h"
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +000018#include "AsmPrinterHandler.h"
Bill Wendlinge38859d2012-06-28 00:05:13 +000019#include "DIE.h"
David Blaikie1275e4f2014-04-01 21:49:04 +000020#include "DebugLocEntry.h"
David Blaikie0a456de2014-04-02 01:43:18 +000021#include "DebugLocList.h"
David Blaikie2406a0622014-04-23 23:37:35 +000022#include "DwarfAccelTable.h"
Devang Patel018b29b2010-01-19 06:19:05 +000023#include "llvm/ADT/DenseMap.h"
Eric Christopheracbe42b2014-03-18 20:58:35 +000024#include "llvm/ADT/MapVector.h"
25#include "llvm/ADT/SmallPtrSet.h"
26#include "llvm/ADT/StringMap.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000027#include "llvm/ADT/FoldingSet.h"
Chandler Carruth802d7552012-12-04 07:12:27 +000028#include "llvm/CodeGen/LexicalScopes.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000029#include "llvm/IR/DebugInfo.h"
Eric Christopheracbe42b2014-03-18 20:58:35 +000030#include "llvm/IR/DebugLoc.h"
Chandler Carruth802d7552012-12-04 07:12:27 +000031#include "llvm/MC/MachineLocation.h"
David Blaikie4a2f95f2014-03-18 01:17:26 +000032#include "llvm/MC/MCDwarf.h"
Chris Lattner3f3fb972010-04-05 05:24:55 +000033#include "llvm/Support/Allocator.h"
Bill Wendling2f921f82009-05-15 09:23:25 +000034
David Blaikief9b6a552014-04-22 22:39:41 +000035#include <memory>
36
Bill Wendling2f921f82009-05-15 09:23:25 +000037namespace llvm {
38
Adrian Prantl702bf5a2014-03-18 02:34:52 +000039class AsmPrinter;
Eric Christopher29e874d2014-03-07 22:40:37 +000040class ByteStreamer;
Chris Lattner88fce102012-01-26 20:44:57 +000041class ConstantInt;
42class ConstantFP;
Eric Christopherce4a9442014-03-18 20:37:10 +000043class DwarfCompileUnit;
44class DwarfDebug;
45class DwarfTypeUnit;
46class DwarfUnit;
Bill Wendling2f921f82009-05-15 09:23:25 +000047class MachineModuleInfo;
Bill Wendling2f921f82009-05-15 09:23:25 +000048
49//===----------------------------------------------------------------------===//
Eric Christopheracdcbdb2012-11-27 22:43:45 +000050/// \brief This class is used to record source line correspondence.
Benjamin Kramer079b96e2013-09-11 18:05:11 +000051class SrcLineInfo {
Eric Christophera5a79422013-12-09 23:32:48 +000052 unsigned Line; // Source line number.
53 unsigned Column; // Source column.
54 unsigned SourceID; // Source ID number.
55 MCSymbol *Label; // Label in code ID number.
Bill Wendling2f921f82009-05-15 09:23:25 +000056public:
Chris Lattnerb4666f42010-03-14 08:15:55 +000057 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
Eric Christophera5a79422013-12-09 23:32:48 +000058 : Line(L), Column(C), SourceID(S), Label(label) {}
Bill Wendling2f921f82009-05-15 09:23:25 +000059
60 // Accessors
61 unsigned getLine() const { return Line; }
62 unsigned getColumn() const { return Column; }
63 unsigned getSourceID() const { return SourceID; }
Chris Lattnerb4666f42010-03-14 08:15:55 +000064 MCSymbol *getLabel() const { return Label; }
Bill Wendling2f921f82009-05-15 09:23:25 +000065};
66
Devang Patelf20c4f72011-04-12 22:53:02 +000067//===----------------------------------------------------------------------===//
Eric Christopheracdcbdb2012-11-27 22:43:45 +000068/// \brief This class is used to track local variable information.
Benjamin Kramer079b96e2013-09-11 18:05:11 +000069class DbgVariable {
Eric Christophera5a79422013-12-09 23:32:48 +000070 DIVariable Var; // Variable Descriptor.
71 DIE *TheDIE; // Variable DIE.
72 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
73 DbgVariable *AbsVar; // Corresponding Abstract variable, if any.
74 const MachineInstr *MInsn; // DBG_VALUE instruction of the variable.
Devang Patel3e4a9652011-08-15 21:24:36 +000075 int FrameIndex;
Manman Renb3388602013-10-05 01:43:03 +000076 DwarfDebug *DD;
Eric Christophera5a79422013-12-09 23:32:48 +000077
Devang Patelf20c4f72011-04-12 22:53:02 +000078public:
79 // AbsVar may be NULL.
Manman Renb3388602013-10-05 01:43:03 +000080 DbgVariable(DIVariable V, DbgVariable *AV, DwarfDebug *DD)
Craig Toppere73658d2014-04-28 04:05:08 +000081 : Var(V), TheDIE(nullptr), DotDebugLocOffset(~0U), AbsVar(AV),
82 MInsn(nullptr), FrameIndex(~0), DD(DD) {}
Devang Patelf20c4f72011-04-12 22:53:02 +000083
84 // Accessors.
Eric Christophera5a79422013-12-09 23:32:48 +000085 DIVariable getVariable() const { return Var; }
David Blaikiee071fc82014-04-25 17:32:19 +000086 void setDIE(DIE &D) { TheDIE = &D; }
Eric Christophera5a79422013-12-09 23:32:48 +000087 DIE *getDIE() const { return TheDIE; }
88 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
89 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
90 StringRef getName() const { return Var.getName(); }
Devang Patel99819b52011-08-15 19:01:20 +000091 DbgVariable *getAbstractVariable() const { return AbsVar; }
Eric Christophera5a79422013-12-09 23:32:48 +000092 const MachineInstr *getMInsn() const { return MInsn; }
93 void setMInsn(const MachineInstr *M) { MInsn = M; }
94 int getFrameIndex() const { return FrameIndex; }
95 void setFrameIndex(int FI) { FrameIndex = FI; }
Eric Christopher27527b22012-11-21 00:03:28 +000096 // Translate tag to proper Dwarf tag.
David Blaikieefc403b2014-04-12 02:24:04 +000097 dwarf::Tag getTag() const {
Devang Patel6e4d2c92011-08-15 18:35:42 +000098 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
99 return dwarf::DW_TAG_formal_parameter;
Eric Christopher27527b22012-11-21 00:03:28 +0000100
Devang Patel6e4d2c92011-08-15 18:35:42 +0000101 return dwarf::DW_TAG_variable;
102 }
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000103 /// \brief Return true if DbgVariable is artificial.
Eric Christophera5a79422013-12-09 23:32:48 +0000104 bool isArtificial() const {
Devang Pateld7d80aa2011-08-15 18:40:16 +0000105 if (Var.isArtificial())
106 return true;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000107 if (getType().isArtificial())
Devang Pateld7d80aa2011-08-15 18:40:16 +0000108 return true;
109 return false;
110 }
Eric Christophere3417762012-09-12 23:36:19 +0000111
Eric Christophera5a79422013-12-09 23:32:48 +0000112 bool isObjectPointer() const {
Eric Christophere3417762012-09-12 23:36:19 +0000113 if (Var.isObjectPointer())
114 return true;
Eric Christopherc1c8a1b2012-09-21 22:18:52 +0000115 if (getType().isObjectPointer())
Eric Christophere3417762012-09-12 23:36:19 +0000116 return true;
117 return false;
118 }
Eric Christopher27527b22012-11-21 00:03:28 +0000119
Eric Christophera5a79422013-12-09 23:32:48 +0000120 bool variableHasComplexAddress() const {
Manman Ren7504ed42013-07-08 18:33:29 +0000121 assert(Var.isVariable() && "Invalid complex DbgVariable!");
Devang Patelf20c4f72011-04-12 22:53:02 +0000122 return Var.hasComplexAddress();
123 }
Adrian Prantl1a1647c2014-03-18 02:34:58 +0000124 bool isBlockByrefVariable() const;
Eric Christophera5a79422013-12-09 23:32:48 +0000125 unsigned getNumAddrElements() const {
Manman Ren7504ed42013-07-08 18:33:29 +0000126 assert(Var.isVariable() && "Invalid complex DbgVariable!");
Devang Patelf20c4f72011-04-12 22:53:02 +0000127 return Var.getNumAddrElements();
128 }
Eric Christophera5a79422013-12-09 23:32:48 +0000129 uint64_t getAddrElement(unsigned i) const { return Var.getAddrElement(i); }
Devang Patelf20c4f72011-04-12 22:53:02 +0000130 DIType getType() const;
Manman Renbe5576f2013-10-08 19:07:44 +0000131
132private:
133 /// resolve - Look in the DwarfDebug map for the MDNode that
134 /// corresponds to the reference.
135 template <typename T> T resolve(DIRef<T> Ref) const;
Devang Patelf20c4f72011-04-12 22:53:02 +0000136};
137
Eric Christopherc8a310e2012-12-10 23:34:43 +0000138
Eric Christopher670ee0e2013-10-24 21:20:23 +0000139/// \brief Helper used to pair up a symbol and its DWARF compile unit.
Richard Mitton21101b32013-09-19 23:21:01 +0000140struct SymbolCU {
Eric Christopher4287a492013-12-09 23:57:44 +0000141 SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
Richard Mitton21101b32013-09-19 23:21:01 +0000142 const MCSymbol *Sym;
Eric Christopher4287a492013-12-09 23:57:44 +0000143 DwarfCompileUnit *CU;
Richard Mitton21101b32013-09-19 23:21:01 +0000144};
145
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000146/// \brief Collects and handles dwarf debug information.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000147class DwarfDebug : public AsmPrinterHandler {
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000148 // Target of Dwarf emission.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000149 AsmPrinter *Asm;
Chris Lattneracda87b2010-04-05 05:31:04 +0000150
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000151 // Collected machine module information.
Chris Lattner3a383cb2010-04-05 00:13:49 +0000152 MachineModuleInfo *MMI;
153
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000154 // All DIEValues are allocated through this allocator.
Benjamin Kramer07480082012-06-09 10:34:15 +0000155 BumpPtrAllocator DIEValueAllocator;
156
Eric Christopherbfe7d292013-12-03 22:05:55 +0000157 // Handle to the compile unit used for the inline extension handling,
158 // this is just so that the DIEValue allocator has a place to store
159 // the particular elements.
160 // FIXME: Store these off of DwarfDebug instead?
Eric Christopher4287a492013-12-09 23:57:44 +0000161 DwarfCompileUnit *FirstCU;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000162
Eric Christopher4287a492013-12-09 23:57:44 +0000163 // Maps MDNode with its corresponding DwarfCompileUnit.
Eric Christopher179fba12014-01-29 22:06:23 +0000164 MapVector<const MDNode *, DwarfCompileUnit *> CUMap;
Bill Wendling2f921f82009-05-15 09:23:25 +0000165
Eric Christopher4287a492013-12-09 23:57:44 +0000166 // Maps subprogram MDNode with its corresponding DwarfCompileUnit.
167 DenseMap<const MDNode *, DwarfCompileUnit *> SPMap;
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000168
Eric Christopher4287a492013-12-09 23:57:44 +0000169 // Maps a CU DIE with its corresponding DwarfCompileUnit.
170 DenseMap<const DIE *, DwarfCompileUnit *> CUDieMap;
Manman Rence20d462013-10-29 22:57:10 +0000171
Eric Christopher47f2be82014-03-20 19:16:20 +0000172 /// Maps MDNodes for type system with the corresponding DIEs. These DIEs can
Manman Ren4dbdc902013-10-31 17:54:35 +0000173 /// be shared across CUs, that is why we keep the map here instead
Eric Christopher4287a492013-12-09 23:57:44 +0000174 /// of in DwarfCompileUnit.
Manman Ren4dbdc902013-10-31 17:54:35 +0000175 DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
176
Alexey Samsonov4436bf02013-10-03 08:54:43 +0000177 // List of all labels used in aranges generation.
178 std::vector<SymbolCU> ArangeLabels;
Richard Mitton21101b32013-09-19 23:21:01 +0000179
Richard Mitton089ed892013-09-23 17:56:20 +0000180 // Size of each symbol emitted (for those symbols that have a specific size).
Eric Christophera5a79422013-12-09 23:32:48 +0000181 DenseMap<const MCSymbol *, uint64_t> SymSize;
Richard Mitton089ed892013-09-23 17:56:20 +0000182
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000183 // Provides a unique id per text section.
Richard Mitton21101b32013-09-19 23:21:01 +0000184 typedef DenseMap<const MCSection *, SmallVector<SymbolCU, 8> > SectionMapType;
185 SectionMapType SectionMap;
Bill Wendling2f921f82009-05-15 09:23:25 +0000186
Eric Christopheraba20dd2013-07-08 21:16:18 +0000187 // List of arguments for current function.
David Blaikieafd2c6b2014-04-22 05:41:06 +0000188 SmallVector<DbgVariable *, 8> CurrentFnArguments;
Devang Patel6c622ef2011-03-01 22:58:55 +0000189
Devang Patel7e623022011-08-10 20:55:27 +0000190 LexicalScopes LScopes;
Devang Patel95cd4b92010-03-25 15:09:44 +0000191
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000192 // Collection of abstract subprogram DIEs.
Devang Patela37a95e2010-07-07 22:20:57 +0000193 DenseMap<const MDNode *, DIE *> AbstractSPDies;
194
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000195 // Collection of dbg variables of a scope.
David Blaikieafd2c6b2014-04-22 05:41:06 +0000196 typedef DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >
Eric Christophera5a79422013-12-09 23:32:48 +0000197 ScopeVariablesMap;
Craig Topper2b4a2012013-07-03 04:40:27 +0000198 ScopeVariablesMap ScopeVariables;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000199
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000200 // Collection of abstract variables.
Devang Patel32cc43c2010-05-07 20:54:48 +0000201 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000202
David Blaikie0a456de2014-04-02 01:43:18 +0000203 // Collection of DebugLocEntry. Stored in a linked list so that DIELocLists
204 // can refer to them in spite of insertions into this list.
205 SmallVector<DebugLocList, 4> DotDebugLocEntries;
Devang Patel9fc11702010-05-25 23:40:22 +0000206
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000207 // Collection of subprogram DIEs that are marked (at the end of the module)
208 // as DW_AT_inline.
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000209 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
210
Eric Christopher48fef592012-12-20 21:58:40 +0000211 // This is a collection of subprogram MDNodes that are processed to
212 // create DIEs.
Devang Patelf3b2db62010-06-28 18:25:03 +0000213 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
214
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000215 // Maps instruction with label emitted before instruction.
Devang Patel6c74a872010-04-27 19:46:33 +0000216 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
Devang Patel3ebd8932010-04-08 16:50:29 +0000217
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000218 // Maps instruction with label emitted after instruction.
Devang Patel6c74a872010-04-27 19:46:33 +0000219 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
Devang Patel3ebd8932010-04-08 16:50:29 +0000220
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000221 // Every user variable mentioned by a DBG_VALUE instruction in order of
222 // appearance.
Eric Christophera5a79422013-12-09 23:32:48 +0000223 SmallVector<const MDNode *, 8> UserVariables;
Devang Patel002d54d2010-05-26 19:37:24 +0000224
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000225 // For each user variable, keep a list of DBG_VALUE instructions in order.
226 // The list can also contain normal instructions that clobber the previous
227 // DBG_VALUE.
Eric Christophera5a79422013-12-09 23:32:48 +0000228 typedef DenseMap<const MDNode *, SmallVector<const MachineInstr *, 4> >
229 DbgValueHistoryMap;
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000230 DbgValueHistoryMap DbgValues;
Jakob Stoklund Olesenec0ac3c2011-03-22 22:33:08 +0000231
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000232 // Previous instruction's location information. This is used to determine
233 // label location to indicate scope boundries in dwarf debug info.
Chris Lattner915c5f92010-04-02 19:42:39 +0000234 DebugLoc PrevInstLoc;
Devang Patel12563b32010-04-16 23:33:45 +0000235 MCSymbol *PrevLabel;
Devang Patelbd477be2010-03-29 17:20:31 +0000236
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000237 // This location indicates end of function prologue and beginning of function
238 // body.
Devang Patel34a66202011-05-11 19:22:19 +0000239 DebugLoc PrologEndLoc;
240
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000241 // If nonnull, stores the current machine function we're processing.
242 const MachineFunction *CurFn;
243
244 // If nonnull, stores the current machine instruction we're processing.
245 const MachineInstr *CurMI;
246
Eric Christopher384f3fe2014-03-20 19:16:16 +0000247 // If nonnull, stores the section that the previous function was allocated to
248 // emitting.
249 const MCSection *PrevSection;
250
251 // If nonnull, stores the CU in which the previous subprogram was contained.
252 const DwarfCompileUnit *PrevCU;
253
Chris Lattner6629ca92010-04-04 22:59:04 +0000254 // Section Symbols: these are assembler temporary labels that are emitted at
255 // the beginning of each supported dwarf section. These are used to form
256 // section offsets and are created by EmitSectionLabels.
Rafael Espindolaa7160962011-05-06 14:56:22 +0000257 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
Devang Patel12563b32010-04-16 23:33:45 +0000258 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
Eric Christopher55863be2013-04-07 03:43:09 +0000259 MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
Devang Patel9fc11702010-05-25 23:40:22 +0000260 MCSymbol *FunctionBeginSym, *FunctionEndSym;
Eric Christopherd8667202013-12-30 17:22:27 +0000261 MCSymbol *DwarfInfoDWOSectionSym, *DwarfAbbrevDWOSectionSym;
David Blaikiee12ab122014-04-01 16:09:49 +0000262 MCSymbol *DwarfStrDWOSectionSym;
Eric Christopher39eebfa2013-09-30 23:14:16 +0000263 MCSymbol *DwarfGnuPubNamesSectionSym, *DwarfGnuPubTypesSectionSym;
Devang Patel9c160e12010-07-08 20:10:35 +0000264
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000265 // As an optimization, there is no need to emit an entry in the directory
Eric Christopher808fd7b2013-07-03 01:57:23 +0000266 // table for the same directory as DW_AT_comp_dir.
Nick Lewyckyd1ee7f82011-11-02 20:55:33 +0000267 StringRef CompilationDir;
268
Eric Christopher0f63d062013-12-03 00:45:45 +0000269 // Counter for assigning globally unique IDs for ranges.
270 unsigned GlobalRangeCount;
271
Eric Christopherc8a310e2012-12-10 23:34:43 +0000272 // Holder for the file specific debug information.
Eric Christopherf8194852013-12-05 18:06:10 +0000273 DwarfFile InfoHolder;
Eric Christopherc8a310e2012-12-10 23:34:43 +0000274
Eric Christopher0aa4a672012-12-10 22:25:41 +0000275 // Holders for the various debug information flags that we might need to
276 // have exposed. See accessor functions below for description.
277
Eric Christopher070bf162013-07-03 01:57:26 +0000278 // Holder for imported entities.
279 typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
Eric Christophera5a79422013-12-09 23:32:48 +0000280 ImportedEntityMap;
Eric Christopher070bf162013-07-03 01:57:26 +0000281 ImportedEntityMap ScopesWithImportedEntities;
282
David Blaikie47f615e2013-12-17 23:32:35 +0000283 // Map from MDNodes for user-defined types to the type units that describe
284 // them.
285 DenseMap<const MDNode *, const DwarfTypeUnit *> DwarfTypeUnits;
Eric Christopher67646432013-07-26 17:02:41 +0000286
David Blaikiee12b49a2014-04-26 17:27:38 +0000287 SmallVector<std::pair<std::unique_ptr<DwarfTypeUnit>, DICompositeType>, 1> TypeUnitsUnderConstruction;
288
Eric Christopher4d36ca02013-08-26 23:24:35 +0000289 // Whether to emit the pubnames/pubtypes sections.
290 bool HasDwarfPubSections;
291
Eric Christopher1ad84572014-01-15 00:04:29 +0000292 // Whether or not to use AT_ranges for compilation units.
293 bool HasCURanges;
294
Eric Christopher2037caf2014-01-28 00:49:26 +0000295 // Whether we emitted a function into a section other than the default
296 // text.
297 bool UsedNonDefaultText;
298
Eric Christopher4d36ca02013-08-26 23:24:35 +0000299 // Version of dwarf we're emitting.
300 unsigned DwarfVersion;
301
Eric Christopher0a13eb32013-11-21 22:56:11 +0000302 // Maps from a type identifier to the actual MDNode.
303 DITypeIdentifierMap TypeIdentifierMap;
304
Eric Christopher42e39942012-11-29 22:56:13 +0000305 // DWARF5 Experimental Options
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000306 bool HasDwarfAccelTables;
Eric Christophercdf218d2012-12-10 19:51:21 +0000307 bool HasSplitDwarf;
Manman Renac8062b2013-07-02 23:40:10 +0000308
Eric Christopherd692c1d2012-12-11 19:42:09 +0000309 // Separated Dwarf Variables
Eric Christopherd79f5482012-12-10 19:51:13 +0000310 // 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.
313
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000314 // Holder for the skeleton information.
Eric Christopherf8194852013-12-05 18:06:10 +0000315 DwarfFile SkeletonHolder;
Eric Christopherd79f5482012-12-10 19:51:13 +0000316
David Blaikie47f4b822014-03-19 00:11:28 +0000317 /// 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.
David Blaikie8287aff2014-03-18 02:13:23 +0000322 MCDwarfDwoLineTable SplitTypeUnitFileTable;
David Blaikie4a2f95f2014-03-18 01:17:26 +0000323
David Blaikie47f4b822014-03-19 00:11:28 +0000324 // True iff there are multiple CUs in this module.
325 bool SingleCU;
326
David Blaikied75fb282014-04-23 21:20:10 +0000327 AddressPool AddrPool;
328
David Blaikie2406a0622014-04-23 23:37:35 +0000329 DwarfAccelTable AccelNames;
David Blaikie0ee82b92014-04-24 00:53:32 +0000330 DwarfAccelTable AccelObjC;
David Blaikieecf04152014-04-24 01:02:42 +0000331 DwarfAccelTable AccelNamespace;
David Blaikie18d33752014-04-24 01:23:49 +0000332 DwarfAccelTable AccelTypes;
David Blaikie2406a0622014-04-23 23:37:35 +0000333
David Blaikie47f4b822014-03-19 00:11:28 +0000334 MCDwarfDwoLineTable *getDwoLineTable(const DwarfCompileUnit &);
335
David Blaikieafd2c6b2014-04-22 05:41:06 +0000336 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000337
David Blaikiec33b3cd2014-04-22 21:27:37 +0000338 const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() {
Eric Christophera5a79422013-12-09 23:32:48 +0000339 return InfoHolder.getUnits();
340 }
David Blaikiefd1eff52013-11-26 19:14:34 +0000341
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000342 /// \brief Find abstract variable associated with Var.
Devang Patele1c53f22010-05-20 16:36:41 +0000343 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000344
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000345 /// \brief Find DIE for the given subprogram and attach appropriate
346 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
347 /// variables in this scope then create and insert DIEs for these
348 /// variables.
David Blaikiee872a6e2014-04-29 15:58:35 +0000349 DIE &updateSubprogramScopeDIE(DwarfCompileUnit &SPCU, DISubprogram SP);
Bill Wendling2f921f82009-05-15 09:23:25 +0000350
Eric Christopher44e66c12013-12-03 00:45:56 +0000351 /// \brief A helper function to check whether the DIE for a given Scope is
352 /// going to be null.
Manman Ren2312ed32013-09-10 18:40:41 +0000353 bool isLexicalScopeDIENull(LexicalScope *Scope);
Bill Wendling2f921f82009-05-15 09:23:25 +0000354
Eric Christopherbe2513e2013-12-03 00:45:59 +0000355 /// \brief A helper function to construct a RangeSpanList for a given
356 /// lexical scope.
David Blaikie65a74662014-04-25 18:26:14 +0000357 void addScopeRangeList(DwarfCompileUnit &TheCU, DIE &ScopeDIE,
Eric Christopherbe2513e2013-12-03 00:45:59 +0000358 const SmallVectorImpl<InsnRange> &Range);
359
Eric Christopher77913e0392013-12-03 00:45:54 +0000360 /// \brief Construct new DW_TAG_lexical_block for this scope and
361 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
David Blaikief2449222014-04-28 20:36:45 +0000362 std::unique_ptr<DIE> constructLexicalScopeDIE(DwarfCompileUnit &TheCU,
363 LexicalScope *Scope);
Eric Christopher77913e0392013-12-03 00:45:54 +0000364
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000365 /// \brief This scope represents inlined body of a function. Construct
366 /// DIE to represent this concrete inlined copy of the function.
David Blaikief2449222014-04-28 20:36:45 +0000367 std::unique_ptr<DIE> constructInlinedScopeDIE(DwarfCompileUnit &TheCU,
368 LexicalScope *Scope);
Devang Patel930143b2009-11-21 02:48:08 +0000369
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000370 /// \brief Construct a DIE for this scope.
David Blaikief2449222014-04-28 20:36:45 +0000371 std::unique_ptr<DIE> constructScopeDIE(DwarfCompileUnit &TheCU,
372 LexicalScope *Scope);
David Blaikiee872a6e2014-04-29 15:58:35 +0000373 void createAndAddScopeChildren(DwarfCompileUnit &TheCU, LexicalScope *Scope,
374 DIE &ScopeDIE);
375 /// \brief Construct a DIE for this abstract scope.
David Blaikie4c1089d2014-04-29 23:43:06 +0000376 void constructAbstractSubprogramScopeDIE(DwarfCompileUnit &TheCU,
377 LexicalScope *Scope);
David Blaikiee872a6e2014-04-29 15:58:35 +0000378 /// \brief Construct a DIE for this subprogram scope.
David Blaikie4c1089d2014-04-29 23:43:06 +0000379 DIE &constructSubprogramScopeDIE(DwarfCompileUnit &TheCU,
380 LexicalScope *Scope);
Manman Ren2312ed32013-09-10 18:40:41 +0000381 /// A helper function to create children of a Scope DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000382 DIE *createScopeChildrenDIE(DwarfCompileUnit &TheCU, LexicalScope *Scope,
David Blaikie914046e2014-04-25 20:00:34 +0000383 SmallVectorImpl<std::unique_ptr<DIE>> &Children);
Devang Patel930143b2009-11-21 02:48:08 +0000384
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000385 /// \brief Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000386 void emitSectionLabels();
Bill Wendling2f921f82009-05-15 09:23:25 +0000387
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000388 /// \brief Compute the size and offset of a DIE given an incoming Offset.
Eric Christopher1f0cbb82012-11-20 22:14:13 +0000389 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
Bill Wendling2f921f82009-05-15 09:23:25 +0000390
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000391 /// \brief Compute the size and offset of all the DIEs.
Devang Patel930143b2009-11-21 02:48:08 +0000392 void computeSizeAndOffsets();
Bill Wendling2f921f82009-05-15 09:23:25 +0000393
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000394 /// \brief Attach DW_AT_inline attribute with inlined subprogram DIEs.
Eric Christopher960ac372012-11-22 00:59:49 +0000395 void computeInlinedDIEs();
396
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000397 /// \brief Collect info for variables that were optimized out.
Eric Christopher960ac372012-11-22 00:59:49 +0000398 void collectDeadVariables();
399
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000400 /// \brief Finish off debug information after all functions have been
401 /// processed.
Eric Christopher960ac372012-11-22 00:59:49 +0000402 void finalizeModuleInfo();
403
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000404 /// \brief Emit labels to close any remaining sections that have been left
405 /// open.
Eric Christopher960ac372012-11-22 00:59:49 +0000406 void endSections();
407
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000408 /// \brief Emit the debug info section.
Devang Patel930143b2009-11-21 02:48:08 +0000409 void emitDebugInfo();
Bill Wendling2f921f82009-05-15 09:23:25 +0000410
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000411 /// \brief Emit the abbreviation section.
Eric Christopher38371952012-11-20 23:30:11 +0000412 void emitAbbreviations();
Bill Wendling2f921f82009-05-15 09:23:25 +0000413
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000414 /// \brief Emit the last address of the section and the end of
Bill Wendling2f921f82009-05-15 09:23:25 +0000415 /// the line matrix.
Devang Patel930143b2009-11-21 02:48:08 +0000416 void emitEndOfLineMatrix(unsigned SectionEnd);
Bill Wendling2f921f82009-05-15 09:23:25 +0000417
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000418 /// \brief Emit visible names into a hashed accelerator table section.
Eric Christopher4996c702011-11-07 09:24:32 +0000419 void emitAccelNames();
Eric Christopher27527b22012-11-21 00:03:28 +0000420
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000421 /// \brief Emit objective C classes and categories into a hashed
Eric Christopher4996c702011-11-07 09:24:32 +0000422 /// accelerator table section.
423 void emitAccelObjC();
424
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000425 /// \brief Emit namespace dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +0000426 void emitAccelNamespaces();
427
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000428 /// \brief Emit type dies into a hashed accelerator table.
Eric Christopher4996c702011-11-07 09:24:32 +0000429 void emitAccelTypes();
Eric Christopher27527b22012-11-21 00:03:28 +0000430
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +0000431 /// \brief Emit visible names into a debug pubnames section.
Eric Christopherdd1a0122013-09-13 00:35:05 +0000432 /// \param GnuStyle determines whether or not we want to emit
433 /// additional information into the table ala newer gcc for gdb
434 /// index.
435 void emitDebugPubNames(bool GnuStyle = false);
Krzysztof Parzyszek228daa62013-02-12 18:00:14 +0000436
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000437 /// \brief Emit visible types into a debug pubtypes section.
Eric Christopherdd1a0122013-09-13 00:35:05 +0000438 /// \param GnuStyle determines whether or not we want to emit
439 /// additional information into the table ala newer gcc for gdb
440 /// index.
441 void emitDebugPubTypes(bool GnuStyle = false);
Devang Patel04d2f2d2009-11-24 01:14:22 +0000442
David Blaikie0f55e832014-03-11 23:18:15 +0000443 void
444 emitDebugPubSection(bool GnuStyle, const MCSection *PSec, StringRef Name,
445 const StringMap<const DIE *> &(DwarfUnit::*Accessor)()
446 const);
447
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000448 /// \brief Emit visible names into a debug str section.
Devang Patel930143b2009-11-21 02:48:08 +0000449 void emitDebugStr();
Bill Wendling2f921f82009-05-15 09:23:25 +0000450
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000451 /// \brief Emit visible names into a debug loc section.
Devang Patel930143b2009-11-21 02:48:08 +0000452 void emitDebugLoc();
Bill Wendling2f921f82009-05-15 09:23:25 +0000453
David Blaikie94c1d7f2014-04-02 01:50:20 +0000454 /// \brief Emit visible names into a debug loc dwo section.
455 void emitDebugLocDWO();
456
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000457 /// \brief Emit visible names into a debug aranges section.
Eric Christopher7b30f2e42012-11-21 00:34:35 +0000458 void emitDebugARanges();
Bill Wendling2f921f82009-05-15 09:23:25 +0000459
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000460 /// \brief Emit visible names into a debug ranges section.
Devang Patel930143b2009-11-21 02:48:08 +0000461 void emitDebugRanges();
Bill Wendling2f921f82009-05-15 09:23:25 +0000462
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000463 /// \brief Emit inline info using custom format.
Devang Patel930143b2009-11-21 02:48:08 +0000464 void emitDebugInlineInfo();
Bill Wendling2b128d72009-05-20 23:19:06 +0000465
Eric Christophercdf218d2012-12-10 19:51:21 +0000466 /// DWARF 5 Experimental Split Dwarf Emitters
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000467
David Blaikie38fe6342014-01-09 04:28:46 +0000468 /// \brief Initialize common features of skeleton units.
David Blaikie65a74662014-04-25 18:26:14 +0000469 void initSkeletonUnit(const DwarfUnit &U, DIE &Die,
David Blaikief9b6a552014-04-22 22:39:41 +0000470 std::unique_ptr<DwarfUnit> NewU);
David Blaikie38fe6342014-01-09 04:28:46 +0000471
Eric Christophercdf218d2012-12-10 19:51:21 +0000472 /// \brief Construct the split debug info compile unit for the debug info
473 /// section.
David Blaikief9b6a552014-04-22 22:39:41 +0000474 DwarfCompileUnit &constructSkeletonCU(const DwarfCompileUnit &CU);
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000475
David Blaikie15ed5eb2014-01-10 01:38:41 +0000476 /// \brief Construct the split debug info compile unit for the debug info
477 /// section.
David Blaikief9b6a552014-04-22 22:39:41 +0000478 DwarfTypeUnit &constructSkeletonTU(DwarfTypeUnit &TU);
David Blaikie15ed5eb2014-01-10 01:38:41 +0000479
Eric Christopher9c2ecd92012-11-30 23:59:06 +0000480 /// \brief Emit the debug info dwo section.
481 void emitDebugInfoDWO();
482
Eric Christopher3c5a1912012-12-19 22:02:53 +0000483 /// \brief Emit the debug abbrev dwo section.
484 void emitDebugAbbrevDWO();
485
David Blaikie4a2f95f2014-03-18 01:17:26 +0000486 /// \brief Emit the debug line dwo section.
487 void emitDebugLineDWO();
488
Eric Christopher3bf29fd2012-12-27 02:14:01 +0000489 /// \brief Emit the debug str dwo section.
490 void emitDebugStrDWO();
491
David Blaikie3c842622013-12-04 21:31:26 +0000492 /// Flags to let the linker know we have emitted new style pubnames. Only
493 /// emit it here if we don't have a skeleton CU for split dwarf.
David Blaikie65a74662014-04-25 18:26:14 +0000494 void addGnuPubAttributes(DwarfUnit &U, DIE &D) const;
David Blaikie3c842622013-12-04 21:31:26 +0000495
Eric Christopher4287a492013-12-09 23:57:44 +0000496 /// \brief Create new DwarfCompileUnit for the given metadata node with tag
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000497 /// DW_TAG_compile_unit.
David Blaikief9b6a552014-04-22 22:39:41 +0000498 DwarfCompileUnit &constructDwarfCompileUnit(DICompileUnit DIUnit);
Devang Patel1a0df9a2010-05-10 22:49:55 +0000499
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000500 /// \brief Construct subprogram DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000501 void constructSubprogramDIE(DwarfCompileUnit &TheCU, const MDNode *N);
Bill Wendling2b128d72009-05-20 23:19:06 +0000502
David Blaikie1fd43652013-05-07 21:35:53 +0000503 /// \brief Construct imported_module or imported_declaration DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000504 void constructImportedEntityDIE(DwarfCompileUnit &TheCU, const MDNode *N);
David Blaikief55abea2013-04-22 06:12:31 +0000505
David Blaikie684fc532013-05-06 23:33:07 +0000506 /// \brief Construct import_module DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000507 void constructImportedEntityDIE(DwarfCompileUnit &TheCU, const MDNode *N,
David Blaikief2449222014-04-28 20:36:45 +0000508 DIE &Context);
David Blaikie684fc532013-05-06 23:33:07 +0000509
510 /// \brief Construct import_module DIE.
David Blaikief9b6a552014-04-22 22:39:41 +0000511 void constructImportedEntityDIE(DwarfCompileUnit &TheCU,
David Blaikief2449222014-04-28 20:36:45 +0000512 const DIImportedEntity &Module, DIE &Context);
David Blaikie684fc532013-05-06 23:33:07 +0000513
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000514 /// \brief Register a source line with debug info. Returns the unique
515 /// label that was emitted and which provides correspondence to the
516 /// source line list.
Devang Patel34a66202011-05-11 19:22:19 +0000517 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
518 unsigned Flags);
Eric Christopher27527b22012-11-21 00:03:28 +0000519
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000520 /// \brief Indentify instructions that are marking the beginning of or
521 /// ending of a scope.
Devang Patel359b0132010-04-08 18:43:56 +0000522 void identifyScopeMarkers();
Devang Patelf1d5a1e2010-04-08 15:37:09 +0000523
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000524 /// \brief If Var is an current function argument that add it in
525 /// CurrentFnArguments list.
David Blaikieafd2c6b2014-04-22 05:41:06 +0000526 bool addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope);
Devang Patel6c622ef2011-03-01 22:58:55 +0000527
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000528 /// \brief Populate LexicalScope entries with variables' info.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000529 void collectVariableInfo(SmallPtrSet<const MDNode *, 16> &ProcessedVars);
Eric Christopher27527b22012-11-21 00:03:28 +0000530
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000531 /// \brief Collect variable information from the side table maintained
532 /// by MMI.
Timur Iskhodzhanov1cd14442013-12-03 15:10:23 +0000533 void collectVariableInfoFromMMITable(SmallPtrSet<const MDNode *, 16> &P);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000534
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000535 /// \brief Ensure that a label will be emitted before MI.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000536 void requestLabelBeforeInsn(const MachineInstr *MI) {
Craig Toppere73658d2014-04-28 04:05:08 +0000537 LabelsBeforeInsn.insert(std::make_pair(MI, nullptr));
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000538 }
539
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000540 /// \brief Return Label preceding the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +0000541 MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000542
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000543 /// \brief Ensure that a label will be emitted after MI.
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000544 void requestLabelAfterInsn(const MachineInstr *MI) {
Craig Toppere73658d2014-04-28 04:05:08 +0000545 LabelsAfterInsn.insert(std::make_pair(MI, nullptr));
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000546 }
547
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000548 /// \brief Return Label immediately following the instruction.
Eric Christopher962c9082013-01-15 23:56:56 +0000549 MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
Jakob Stoklund Olesen9a624fa2011-03-26 02:19:36 +0000550
David Blaikie65a74662014-04-25 18:26:14 +0000551 void attachLowHighPC(DwarfCompileUnit &Unit, DIE &D, MCSymbol *Begin,
David Blaikie4bd13b72014-03-07 18:49:45 +0000552 MCSymbol *End);
553
Bill Wendling2f921f82009-05-15 09:23:25 +0000554public:
555 //===--------------------------------------------------------------------===//
556 // Main entry points.
557 //
Chris Lattnerf0d6bd32010-04-05 05:11:15 +0000558 DwarfDebug(AsmPrinter *A, Module *M);
Bill Wendling2f921f82009-05-15 09:23:25 +0000559
Reid Klecknerdd2647e2014-04-30 20:34:31 +0000560 ~DwarfDebug() override;
561
Manman Ren4dbdc902013-10-31 17:54:35 +0000562 void insertDIE(const MDNode *TypeMD, DIE *Die) {
563 MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
564 }
565 DIE *getDIE(const MDNode *TypeMD) {
566 return MDTypeNodeToDieMap.lookup(TypeMD);
567 }
568
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000569 /// \brief Emit all Dwarf sections that should come prior to the
Bill Wendling2f921f82009-05-15 09:23:25 +0000570 /// content.
Eric Christopher58f41952012-11-19 22:42:15 +0000571 void beginModule();
Bill Wendling2f921f82009-05-15 09:23:25 +0000572
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000573 /// \brief Emit all Dwarf sections that should come after the content.
Craig Topper7b883b32014-03-08 06:31:39 +0000574 void endModule() override;
Bill Wendling2f921f82009-05-15 09:23:25 +0000575
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000576 /// \brief Gather pre-function debug information.
Craig Topper7b883b32014-03-08 06:31:39 +0000577 void beginFunction(const MachineFunction *MF) override;
Bill Wendling2f921f82009-05-15 09:23:25 +0000578
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000579 /// \brief Gather and emit post-function debug information.
Craig Topper7b883b32014-03-08 06:31:39 +0000580 void endFunction(const MachineFunction *MF) override;
Bill Wendling2f921f82009-05-15 09:23:25 +0000581
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000582 /// \brief Process beginning of an instruction.
Craig Topper7b883b32014-03-08 06:31:39 +0000583 void beginInstruction(const MachineInstr *MI) override;
Bill Wendling2f921f82009-05-15 09:23:25 +0000584
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000585 /// \brief Process end of an instruction.
Craig Topper7b883b32014-03-08 06:31:39 +0000586 void endInstruction() override;
Devang Patelf20c4f72011-04-12 22:53:02 +0000587
Eric Christopher67646432013-07-26 17:02:41 +0000588 /// \brief Add a DIE to the set of types that we're going to pull into
589 /// type units.
David Blaikie15632ae2014-02-12 00:31:30 +0000590 void addDwarfTypeUnitType(DwarfCompileUnit &CU, StringRef Identifier,
David Blaikie65a74662014-04-25 18:26:14 +0000591 DIE &Die, DICompositeType CTy);
Eric Christopher67646432013-07-26 17:02:41 +0000592
Richard Mitton21101b32013-09-19 23:21:01 +0000593 /// \brief Add a label so that arange data can be generated for it.
Alexey Samsonov4436bf02013-10-03 08:54:43 +0000594 void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
Richard Mitton21101b32013-09-19 23:21:01 +0000595
Richard Mitton089ed892013-09-23 17:56:20 +0000596 /// \brief For symbols that have a size designated (e.g. common symbols),
597 /// this tracks that size.
Craig Topper7b883b32014-03-08 06:31:39 +0000598 void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override {
Eric Christophera5a79422013-12-09 23:32:48 +0000599 SymSize[Sym] = Size;
600 }
Richard Mitton089ed892013-09-23 17:56:20 +0000601
Eric Christophera2de8262012-12-15 00:04:07 +0000602 /// \brief Recursively Emits a debug information entry.
David Blaikieb8184182014-04-14 22:45:02 +0000603 void emitDIE(DIE &Die);
Eric Christophera2de8262012-12-15 00:04:07 +0000604
Eric Christopher55c51812012-11-21 00:03:31 +0000605 // Experimental DWARF5 features.
606
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000607 /// \brief Returns whether or not to emit tables that dwarf consumers can
608 /// use to accelerate lookup.
Eric Christopher411bd592014-03-06 00:00:53 +0000609 bool useDwarfAccelTables() const { return HasDwarfAccelTables; }
Eric Christopher55c51812012-11-21 00:03:31 +0000610
Eric Christopheracdcbdb2012-11-27 22:43:45 +0000611 /// \brief Returns whether or not to change the current debug info for the
Eric Christophercdf218d2012-12-10 19:51:21 +0000612 /// split dwarf proposal support.
Eric Christopher411bd592014-03-06 00:00:53 +0000613 bool useSplitDwarf() const { return HasSplitDwarf; }
Manman Renac8062b2013-07-02 23:40:10 +0000614
615 /// Returns the Dwarf Version.
616 unsigned getDwarfVersion() const { return DwarfVersion; }
Manman Ren60352032013-09-05 18:48:31 +0000617
Eric Christophera27220f2014-03-05 22:41:20 +0000618 /// Returns the section symbol for the .debug_loc section.
619 MCSymbol *getDebugLocSym() const { return DwarfDebugLocSectionSym; }
620
Eric Christopher384f3fe2014-03-20 19:16:16 +0000621 /// Returns the previous section that was emitted into.
622 const MCSection *getPrevSection() const { return PrevSection; }
623
624 /// Returns the previous CU that was being updated
625 const DwarfCompileUnit *getPrevCU() const { return PrevCU; }
626
Eric Christopher4f17ee02014-03-08 00:29:41 +0000627 /// Returns the entries for the .debug_loc section.
David Blaikie0a456de2014-04-02 01:43:18 +0000628 const SmallVectorImpl<DebugLocList> &
David Blaikie84d8e182014-03-24 22:38:38 +0000629 getDebugLocEntries() const {
Eric Christopher4f17ee02014-03-08 00:29:41 +0000630 return DotDebugLocEntries;
631 }
632
633 /// \brief Emit an entry for the debug loc section. This can be used to
634 /// handle an entry that's going to be emitted into the debug loc section.
Eric Christopher05135fb2014-03-18 02:18:24 +0000635 void emitDebugLocEntry(ByteStreamer &Streamer, const DebugLocEntry &Entry);
Eric Christopher4f17ee02014-03-08 00:29:41 +0000636
David Blaikie0e84adc2014-04-01 16:17:41 +0000637 /// Emit the location for a debug loc entry, including the size header.
638 void emitDebugLocEntryLocation(const DebugLocEntry &Entry);
639
Eric Christopher87b9c492013-10-05 00:32:34 +0000640 /// Find the MDNode for the given reference.
641 template <typename T> T resolve(DIRef<T> Ref) const {
Manman Ren34b3dcc2013-09-10 18:30:07 +0000642 return Ref.resolve(TypeIdentifierMap);
643 }
Manman Ren60352032013-09-05 18:48:31 +0000644
Adrian Prantl1a1647c2014-03-18 02:34:58 +0000645 /// \brief Return the TypeIdentifierMap.
Eric Christopherc0bd5f82014-03-18 20:39:54 +0000646 const DITypeIdentifierMap &getTypeIdentifierMap() const {
Adrian Prantl1a1647c2014-03-18 02:34:58 +0000647 return TypeIdentifierMap;
648 }
649
Eric Christopherdd508382014-03-06 00:00:56 +0000650 /// Find the DwarfCompileUnit for the given CU Die.
651 DwarfCompileUnit *lookupUnit(const DIE *CU) const {
652 return CUDieMap.lookup(CU);
653 }
Manman Ren3eb9dff2013-09-09 19:05:21 +0000654 /// isSubprogramContext - Return true if Context is either a subprogram
655 /// or another context nested inside a subprogram.
656 bool isSubprogramContext(const MDNode *Context);
David Blaikied75fb282014-04-23 21:20:10 +0000657
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000658 void addSubprogramNames(DISubprogram SP, DIE &Die);
David Blaikie2406a0622014-04-23 23:37:35 +0000659
David Blaikied75fb282014-04-23 21:20:10 +0000660 AddressPool &getAddressPool() { return AddrPool; }
David Blaikie2406a0622014-04-23 23:37:35 +0000661
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000662 void addAccelName(StringRef Name, const DIE &Die);
David Blaikie0ee82b92014-04-24 00:53:32 +0000663
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000664 void addAccelObjC(StringRef Name, const DIE &Die);
David Blaikieecf04152014-04-24 01:02:42 +0000665
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000666 void addAccelNamespace(StringRef Name, const DIE &Die);
David Blaikie18d33752014-04-24 01:23:49 +0000667
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000668 void addAccelType(StringRef Name, const DIE &Die, char Flags);
Devang Patelf6eeaeb2009-11-10 23:06:00 +0000669};
Bill Wendling2f921f82009-05-15 09:23:25 +0000670} // End of namespace llvm
671
672#endif