blob: f5344b103ea67fe3e3f83304ad7062a40e83b53f [file] [log] [blame]
Bill Wendling0310d762009-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
Bill Wendling0bcbd1d2012-06-28 00:05:13 +000017#include "DIE.h"
Devang Patel622b0262010-01-19 06:19:05 +000018#include "llvm/ADT/DenseMap.h"
Bill Wendling0310d762009-05-15 09:23:25 +000019#include "llvm/ADT/FoldingSet.h"
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +000020#include "llvm/ADT/SetVector.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000021#include "llvm/ADT/SmallPtrSet.h"
Bill Wendling0310d762009-05-15 09:23:25 +000022#include "llvm/ADT/StringMap.h"
Chandler Carrutha1514e22012-12-04 07:12:27 +000023#include "llvm/CodeGen/AsmPrinter.h"
24#include "llvm/CodeGen/LexicalScopes.h"
25#include "llvm/DebugInfo.h"
26#include "llvm/MC/MachineLocation.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000027#include "llvm/Support/Allocator.h"
Benjamin Kramer12ea7652010-09-13 20:04:49 +000028#include "llvm/Support/DebugLoc.h"
Bill Wendling0310d762009-05-15 09:23:25 +000029
30namespace llvm {
31
32class CompileUnit;
Chris Lattner5b676ce2012-01-26 20:44:57 +000033class ConstantInt;
34class ConstantFP;
Nick Lewycky381afae2009-11-17 09:17:08 +000035class DbgVariable;
Bill Wendling0310d762009-05-15 09:23:25 +000036class MachineFrameInfo;
37class MachineModuleInfo;
Devang Patela43098d2010-04-28 01:03:09 +000038class MachineOperand;
Chris Lattneraf76e592009-08-22 20:48:53 +000039class MCAsmInfo;
Chris Lattner74e41f92010-04-05 05:24:55 +000040class DIEAbbrev;
41class DIE;
42class DIEBlock;
43class DIEEntry;
Bill Wendling0310d762009-05-15 09:23:25 +000044
45//===----------------------------------------------------------------------===//
Eric Christopherb6dc8652012-11-27 22:43:45 +000046/// \brief This class is used to record source line correspondence.
Nick Lewycky381afae2009-11-17 09:17:08 +000047class SrcLineInfo {
Bill Wendling0310d762009-05-15 09:23:25 +000048 unsigned Line; // Source line number.
49 unsigned Column; // Source column.
50 unsigned SourceID; // Source ID number.
Chris Lattner25b68c62010-03-14 08:15:55 +000051 MCSymbol *Label; // Label in code ID number.
Bill Wendling0310d762009-05-15 09:23:25 +000052public:
Chris Lattner25b68c62010-03-14 08:15:55 +000053 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
54 : Line(L), Column(C), SourceID(S), Label(label) {}
Bill Wendling0310d762009-05-15 09:23:25 +000055
56 // Accessors
57 unsigned getLine() const { return Line; }
58 unsigned getColumn() const { return Column; }
59 unsigned getSourceID() const { return SourceID; }
Chris Lattner25b68c62010-03-14 08:15:55 +000060 MCSymbol *getLabel() const { return Label; }
Bill Wendling0310d762009-05-15 09:23:25 +000061};
62
Eric Christopherb6dc8652012-11-27 22:43:45 +000063/// \brief This struct describes location entries emitted in the .debug_loc
64/// section.
Eric Christopher0d0782a2013-07-03 22:40:18 +000065class DotDebugLocEntry {
66 // Begin and end symbols for the address range that this location is valid.
Devang Patel6c3ea902011-02-04 22:57:18 +000067 const MCSymbol *Begin;
68 const MCSymbol *End;
Eric Christopher0d0782a2013-07-03 22:40:18 +000069
70 // Type of entry that this represents.
Devang Patel80efd4e2011-07-08 16:49:43 +000071 enum EntryType {
72 E_Location,
73 E_Integer,
74 E_ConstantFP,
75 E_ConstantInt
76 };
77 enum EntryType EntryKind;
78
79 union {
80 int64_t Int;
81 const ConstantFP *CFP;
82 const ConstantInt *CIP;
83 } Constants;
Eric Christopher0d0782a2013-07-03 22:40:18 +000084
85 // The location in the machine frame.
86 MachineLocation Loc;
87
88 // The variable to which this location entry corresponds.
89 const MDNode *Variable;
90
91 // Whether this location has been merged.
92 bool Merged;
93
94public:
Eric Christopher52f5a652013-07-03 08:26:07 +000095 DotDebugLocEntry() : Begin(0), End(0), Variable(0), Merged(false) {
96 Constants.Int = 0;
97 }
Devang Patelc26f5442011-04-28 02:22:40 +000098 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L,
Eric Christopherc82fbf42012-11-21 00:03:28 +000099 const MDNode *V)
Eric Christopher52f5a652013-07-03 08:26:07 +0000100 : Begin(B), End(E), Loc(L), Variable(V), Merged(false) {
101 Constants.Int = 0;
102 EntryKind = E_Location;
103 }
Devang Patelc4329072011-06-01 22:03:25 +0000104 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, int64_t i)
Eric Christopher52f5a652013-07-03 08:26:07 +0000105 : Begin(B), End(E), Variable(0), Merged(false) {
106 Constants.Int = i;
107 EntryKind = E_Integer;
108 }
Devang Patel80efd4e2011-07-08 16:49:43 +0000109 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, const ConstantFP *FPtr)
Eric Christopher52f5a652013-07-03 08:26:07 +0000110 : Begin(B), End(E), Variable(0), Merged(false) {
111 Constants.CFP = FPtr;
112 EntryKind = E_ConstantFP;
113 }
Eric Christopher4984e012012-09-10 23:34:03 +0000114 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E,
115 const ConstantInt *IPtr)
Eric Christopher52f5a652013-07-03 08:26:07 +0000116 : Begin(B), End(E), Variable(0), Merged(false) {
117 Constants.CIP = IPtr;
118 EntryKind = E_ConstantInt;
119 }
Devang Patelc4329072011-06-01 22:03:25 +0000120
Eric Christopherb6dc8652012-11-27 22:43:45 +0000121 /// \brief Empty entries are also used as a trigger to emit temp label. Such
Devang Patel6c3ea902011-02-04 22:57:18 +0000122 /// labels are referenced is used to find debug_loc offset for a given DIE.
123 bool isEmpty() { return Begin == 0 && End == 0; }
124 bool isMerged() { return Merged; }
125 void Merge(DotDebugLocEntry *Next) {
126 if (!(Begin && Loc == Next->Loc && End == Next->Begin))
127 return;
128 Next->Begin = Begin;
129 Merged = true;
130 }
Devang Patel80efd4e2011-07-08 16:49:43 +0000131 bool isLocation() const { return EntryKind == E_Location; }
132 bool isInt() const { return EntryKind == E_Integer; }
133 bool isConstantFP() const { return EntryKind == E_ConstantFP; }
134 bool isConstantInt() const { return EntryKind == E_ConstantInt; }
Eric Christopher6af85ae2013-07-03 08:13:55 +0000135 int64_t getInt() const { return Constants.Int; }
136 const ConstantFP *getConstantFP() const { return Constants.CFP; }
137 const ConstantInt *getConstantInt() const { return Constants.CIP; }
Eric Christopher0d0782a2013-07-03 22:40:18 +0000138 const MDNode *getVariable() const { return Variable; }
139 const MCSymbol *getBeginSym() const { return Begin; }
140 const MCSymbol *getEndSym() const { return End; }
141 MachineLocation getLoc() const { return Loc; }
142};
Devang Patel6c3ea902011-02-04 22:57:18 +0000143
Devang Patel3cbee302011-04-12 22:53:02 +0000144//===----------------------------------------------------------------------===//
Eric Christopherb6dc8652012-11-27 22:43:45 +0000145/// \brief This class is used to track local variable information.
Devang Patel3cbee302011-04-12 22:53:02 +0000146class DbgVariable {
147 DIVariable Var; // Variable Descriptor.
148 DIE *TheDIE; // Variable DIE.
149 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
Devang Patel5a1a67c2011-08-15 19:01:20 +0000150 DbgVariable *AbsVar; // Corresponding Abstract variable, if any.
Devang Patelff9dd0a2011-08-15 21:24:36 +0000151 const MachineInstr *MInsn; // DBG_VALUE instruction of the variable.
152 int FrameIndex;
Devang Patel3cbee302011-04-12 22:53:02 +0000153public:
154 // AbsVar may be NULL.
Eric Christopherc82fbf42012-11-21 00:03:28 +0000155 DbgVariable(DIVariable V, DbgVariable *AV)
Devang Patelff9dd0a2011-08-15 21:24:36 +0000156 : Var(V), TheDIE(0), DotDebugLocOffset(~0U), AbsVar(AV), MInsn(0),
Devang Patelc890b192011-08-15 21:35:16 +0000157 FrameIndex(~0) {}
Devang Patel3cbee302011-04-12 22:53:02 +0000158
159 // Accessors.
160 DIVariable getVariable() const { return Var; }
161 void setDIE(DIE *D) { TheDIE = D; }
162 DIE *getDIE() const { return TheDIE; }
163 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
164 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
165 StringRef getName() const { return Var.getName(); }
Devang Patel5a1a67c2011-08-15 19:01:20 +0000166 DbgVariable *getAbstractVariable() const { return AbsVar; }
Devang Patelff9dd0a2011-08-15 21:24:36 +0000167 const MachineInstr *getMInsn() const { return MInsn; }
168 void setMInsn(const MachineInstr *M) { MInsn = M; }
169 int getFrameIndex() const { return FrameIndex; }
170 void setFrameIndex(int FI) { FrameIndex = FI; }
Eric Christopherc82fbf42012-11-21 00:03:28 +0000171 // Translate tag to proper Dwarf tag.
Eric Christopher31667622013-08-08 01:41:00 +0000172 uint16_t getTag() const {
Devang Patel59bc4092011-08-15 18:35:42 +0000173 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
174 return dwarf::DW_TAG_formal_parameter;
Eric Christopherc82fbf42012-11-21 00:03:28 +0000175
Devang Patel59bc4092011-08-15 18:35:42 +0000176 return dwarf::DW_TAG_variable;
177 }
Eric Christopherb6dc8652012-11-27 22:43:45 +0000178 /// \brief Return true if DbgVariable is artificial.
Devang Patela098c502011-08-15 18:40:16 +0000179 bool isArtificial() const {
180 if (Var.isArtificial())
181 return true;
Eric Christopher7b451cf2012-09-21 22:18:52 +0000182 if (getType().isArtificial())
Devang Patela098c502011-08-15 18:40:16 +0000183 return true;
184 return false;
185 }
Eric Christophere5212782012-09-12 23:36:19 +0000186
187 bool isObjectPointer() const {
188 if (Var.isObjectPointer())
189 return true;
Eric Christopher7b451cf2012-09-21 22:18:52 +0000190 if (getType().isObjectPointer())
Eric Christophere5212782012-09-12 23:36:19 +0000191 return true;
192 return false;
193 }
Eric Christopherc82fbf42012-11-21 00:03:28 +0000194
Devang Patel3cbee302011-04-12 22:53:02 +0000195 bool variableHasComplexAddress() const {
Manman Rend03d2b22013-07-08 18:33:29 +0000196 assert(Var.isVariable() && "Invalid complex DbgVariable!");
Devang Patel3cbee302011-04-12 22:53:02 +0000197 return Var.hasComplexAddress();
198 }
199 bool isBlockByrefVariable() const {
Manman Rend03d2b22013-07-08 18:33:29 +0000200 assert(Var.isVariable() && "Invalid complex DbgVariable!");
Devang Patel3cbee302011-04-12 22:53:02 +0000201 return Var.isBlockByrefVariable();
202 }
Eric Christopherc82fbf42012-11-21 00:03:28 +0000203 unsigned getNumAddrElements() const {
Manman Rend03d2b22013-07-08 18:33:29 +0000204 assert(Var.isVariable() && "Invalid complex DbgVariable!");
Devang Patel3cbee302011-04-12 22:53:02 +0000205 return Var.getNumAddrElements();
206 }
207 uint64_t getAddrElement(unsigned i) const {
208 return Var.getAddrElement(i);
209 }
210 DIType getType() const;
211};
212
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000213/// \brief Collects and handles information specific to a particular
214/// collection of units.
215class DwarfUnits {
216 // Target of Dwarf emission, used for sizing of abbreviations.
217 AsmPrinter *Asm;
218
219 // Used to uniquely define abbreviations.
220 FoldingSet<DIEAbbrev> *AbbreviationsSet;
221
222 // A list of all the unique abbreviations in use.
223 std::vector<DIEAbbrev *> *Abbreviations;
224
225 // A pointer to all units in the section.
226 SmallVector<CompileUnit *, 1> CUs;
227
Eric Christopher64f824c2012-12-27 02:14:01 +0000228 // Collection of strings for this unit and assorted symbols.
Eric Christopher08ebdc72013-07-03 20:36:36 +0000229 // A String->Symbol mapping of strings used by indirect
230 // references.
231 typedef StringMap<std::pair<MCSymbol*, unsigned>,
232 BumpPtrAllocator&> StrPool;
Eric Christopherb6714222013-01-08 22:22:06 +0000233 StrPool StringPool;
Eric Christopher2e5d8702012-12-20 21:58:36 +0000234 unsigned NextStringPoolNumber;
Eric Christopher64f824c2012-12-27 02:14:01 +0000235 std::string StringPref;
Eric Christopher2e5d8702012-12-20 21:58:36 +0000236
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000237 // Collection of addresses for this unit and assorted labels.
Eric Christopher08ebdc72013-07-03 20:36:36 +0000238 // A Symbol->unsigned mapping of addresses used by indirect
239 // references.
240 typedef DenseMap<const MCExpr *, unsigned> AddrPool;
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000241 AddrPool AddressPool;
242 unsigned NextAddrPoolNumber;
243
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000244public:
245 DwarfUnits(AsmPrinter *AP, FoldingSet<DIEAbbrev> *AS,
Eric Christopherb6714222013-01-08 22:22:06 +0000246 std::vector<DIEAbbrev *> *A, const char *Pref,
Eric Christopher3a1812d2013-07-03 21:23:59 +0000247 BumpPtrAllocator &DA)
248 : Asm(AP), AbbreviationsSet(AS), Abbreviations(A), StringPool(DA),
249 NextStringPoolNumber(0), StringPref(Pref), AddressPool(),
250 NextAddrPoolNumber(0) {}
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000251
252 /// \brief Compute the size and offset of a DIE given an incoming Offset.
253 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
254
255 /// \brief Compute the size and offset of all the DIEs.
256 void computeSizeAndOffsets();
257
258 /// \brief Define a unique number for the abbreviation.
259 void assignAbbrevNumber(DIEAbbrev &Abbrev);
260
261 /// \brief Add a unit to the list of CUs.
262 void addUnit(CompileUnit *CU) { CUs.push_back(CU); }
Eric Christopherb1e66d02012-12-15 00:04:07 +0000263
264 /// \brief Emit all of the units to the section listed with the given
265 /// abbreviation section.
Eric Christopher3a1812d2013-07-03 21:23:59 +0000266 void emitUnits(DwarfDebug *DD, const MCSection *USection,
267 const MCSection *ASection, const MCSymbol *ASectionSym);
Eric Christopher2e5d8702012-12-20 21:58:36 +0000268
Eric Christopher64f824c2012-12-27 02:14:01 +0000269 /// \brief Emit all of the strings to the section given.
Eric Christopher3a1812d2013-07-03 21:23:59 +0000270 void emitStrings(const MCSection *StrSection, const MCSection *OffsetSection,
271 const MCSymbol *StrSecSym);
Eric Christopher64f824c2012-12-27 02:14:01 +0000272
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000273 /// \brief Emit all of the addresses to the section given.
Eric Christopher3a1812d2013-07-03 21:23:59 +0000274 void emitAddresses(const MCSection *AddrSection);
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000275
Eric Christopher2e5d8702012-12-20 21:58:36 +0000276 /// \brief Returns the entry into the start of the pool.
277 MCSymbol *getStringPoolSym();
278
279 /// \brief Returns an entry into the string pool with the given
280 /// string text.
281 MCSymbol *getStringPoolEntry(StringRef Str);
282
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000283 /// \brief Returns the index into the string pool with the given
284 /// string text.
285 unsigned getStringPoolIndex(StringRef Str);
286
Eric Christopher2e5d8702012-12-20 21:58:36 +0000287 /// \brief Returns the string pool.
Eric Christopherb6714222013-01-08 22:22:06 +0000288 StrPool *getStringPool() { return &StringPool; }
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000289
290 /// \brief Returns the index into the address pool with the given
291 /// label/symbol.
Eric Christopher3a1812d2013-07-03 21:23:59 +0000292 unsigned getAddrPoolIndex(const MCExpr *Sym);
293 unsigned getAddrPoolIndex(const MCSymbol *Sym);
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000294
295 /// \brief Returns the address pool.
296 AddrPool *getAddrPool() { return &AddressPool; }
Manman Renbc3e96f2013-03-12 18:27:15 +0000297
298 /// \brief for a given compile unit DIE, returns offset from beginning of
299 /// debug info.
300 unsigned getCUOffset(DIE *Die);
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000301};
302
Eric Christopherb6dc8652012-11-27 22:43:45 +0000303/// \brief Collects and handles dwarf debug information.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000304class DwarfDebug {
Eric Christopherb6dc8652012-11-27 22:43:45 +0000305 // Target of Dwarf emission.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000306 AsmPrinter *Asm;
Chris Lattner105d6972010-04-05 05:31:04 +0000307
Eric Christopherb6dc8652012-11-27 22:43:45 +0000308 // Collected machine module information.
Chris Lattnerd38fee82010-04-05 00:13:49 +0000309 MachineModuleInfo *MMI;
310
Eric Christopherb6dc8652012-11-27 22:43:45 +0000311 // All DIEValues are allocated through this allocator.
Benjamin Kramerf33a79c2012-06-09 10:34:15 +0000312 BumpPtrAllocator DIEValueAllocator;
313
Eric Christopher4d138ba2013-07-14 22:23:54 +0000314 // Handle to the a compile unit used for the inline extension handling.
Devang Patel163a9f72010-05-10 22:49:55 +0000315 CompileUnit *FirstCU;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000316
Eric Christopherb6dc8652012-11-27 22:43:45 +0000317 // Maps MDNode with its corresponding CompileUnit.
Devang Patel163a9f72010-05-10 22:49:55 +0000318 DenseMap <const MDNode *, CompileUnit *> CUMap;
Bill Wendling0310d762009-05-15 09:23:25 +0000319
Eric Christopherb6dc8652012-11-27 22:43:45 +0000320 // Maps subprogram MDNode with its corresponding CompileUnit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000321 DenseMap <const MDNode *, CompileUnit *> SPMap;
322
Eric Christopherb6dc8652012-11-27 22:43:45 +0000323 // Used to uniquely define abbreviations.
Bill Wendling0310d762009-05-15 09:23:25 +0000324 FoldingSet<DIEAbbrev> AbbreviationsSet;
325
Eric Christopherb6dc8652012-11-27 22:43:45 +0000326 // A list of all the unique abbreviations in use.
Bill Wendling0310d762009-05-15 09:23:25 +0000327 std::vector<DIEAbbrev *> Abbreviations;
328
Manman Ren3de61b42013-03-07 01:42:00 +0000329 // Stores the current file ID for a given compile unit.
330 DenseMap <unsigned, unsigned> FileIDCUMap;
331 // Source id map, i.e. CUID, source filename and directory,
Eric Christopherb6dc8652012-11-27 22:43:45 +0000332 // separated by a zero byte, mapped to a unique id.
Benjamin Kramerf33a79c2012-06-09 10:34:15 +0000333 StringMap<unsigned, BumpPtrAllocator&> SourceIdMap;
Bill Wendling0310d762009-05-15 09:23:25 +0000334
Eric Christopherb6dc8652012-11-27 22:43:45 +0000335 // Provides a unique id per text section.
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +0000336 SetVector<const MCSection*> SectionMap;
Bill Wendling0310d762009-05-15 09:23:25 +0000337
Eric Christophercced2122013-07-08 21:16:18 +0000338 // List of arguments for current function.
Devang Patel0478c152011-03-01 22:58:55 +0000339 SmallVector<DbgVariable *, 8> CurrentFnArguments;
340
Devang Patelbf47fdb2011-08-10 20:55:27 +0000341 LexicalScopes LScopes;
Devang Patel2ddefec2010-03-25 15:09:44 +0000342
Eric Christopherb6dc8652012-11-27 22:43:45 +0000343 // Collection of abstract subprogram DIEs.
Devang Patel8aa61472010-07-07 22:20:57 +0000344 DenseMap<const MDNode *, DIE *> AbstractSPDies;
345
Eric Christopherb6dc8652012-11-27 22:43:45 +0000346 // Collection of dbg variables of a scope.
Craig Topper01eb99a2013-07-03 04:40:27 +0000347 typedef DenseMap<LexicalScope *,
348 SmallVector<DbgVariable *, 8> > ScopeVariablesMap;
349 ScopeVariablesMap ScopeVariables;
Devang Patel53bb5c92009-11-10 23:06:00 +0000350
Eric Christopherb6dc8652012-11-27 22:43:45 +0000351 // Collection of abstract variables.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000352 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
Devang Patel53bb5c92009-11-10 23:06:00 +0000353
Eric Christopherb6dc8652012-11-27 22:43:45 +0000354 // Collection of DotDebugLocEntry.
Devang Patelc3f5f782010-05-25 23:40:22 +0000355 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
356
Eric Christopherb6dc8652012-11-27 22:43:45 +0000357 // Collection of subprogram DIEs that are marked (at the end of the module)
358 // as DW_AT_inline.
Devang Patel53bb5c92009-11-10 23:06:00 +0000359 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
360
Eric Christopherb6dc8652012-11-27 22:43:45 +0000361 // Keep track of inlined functions and their location. This
362 // information is used to populate the debug_inlined section.
Devang Patelc3f5f782010-05-25 23:40:22 +0000363 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
Craig Topper01eb99a2013-07-03 04:40:27 +0000364 typedef DenseMap<const MDNode *,
365 SmallVector<InlineInfoLabels, 4> > InlineInfoMap;
366 InlineInfoMap InlineInfo;
Devang Patele9f8f5e2010-05-07 20:54:48 +0000367 SmallVector<const MDNode *, 4> InlinedSPNodes;
Bill Wendling0310d762009-05-15 09:23:25 +0000368
Eric Christopher72c16552012-12-20 21:58:40 +0000369 // This is a collection of subprogram MDNodes that are processed to
370 // create DIEs.
Devang Patel4a1cad62010-06-28 18:25:03 +0000371 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
372
Eric Christopherb6dc8652012-11-27 22:43:45 +0000373 // Maps instruction with label emitted before instruction.
Devang Pateleac9c072010-04-27 19:46:33 +0000374 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
Devang Patel1c246352010-04-08 16:50:29 +0000375
Eric Christopherb6dc8652012-11-27 22:43:45 +0000376 // Maps instruction with label emitted after instruction.
Devang Pateleac9c072010-04-27 19:46:33 +0000377 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
Devang Patel1c246352010-04-08 16:50:29 +0000378
Eric Christopherb6dc8652012-11-27 22:43:45 +0000379 // Every user variable mentioned by a DBG_VALUE instruction in order of
380 // appearance.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +0000381 SmallVector<const MDNode*, 8> UserVariables;
Devang Patelb2b31a62010-05-26 19:37:24 +0000382
Eric Christopherb6dc8652012-11-27 22:43:45 +0000383 // For each user variable, keep a list of DBG_VALUE instructions in order.
384 // The list can also contain normal instructions that clobber the previous
385 // DBG_VALUE.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +0000386 typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
387 DbgValueHistoryMap;
388 DbgValueHistoryMap DbgValues;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +0000389
Devang Patelf2548ca2010-04-16 23:33:45 +0000390 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
Devang Patelc04d5452010-04-22 20:56:35 +0000391
Eric Christopherb6dc8652012-11-27 22:43:45 +0000392 // Previous instruction's location information. This is used to determine
393 // label location to indicate scope boundries in dwarf debug info.
Chris Lattnerde4845c2010-04-02 19:42:39 +0000394 DebugLoc PrevInstLoc;
Devang Patelf2548ca2010-04-16 23:33:45 +0000395 MCSymbol *PrevLabel;
Devang Patel553881b2010-03-29 17:20:31 +0000396
Eric Christopherb6dc8652012-11-27 22:43:45 +0000397 // This location indicates end of function prologue and beginning of function
398 // body.
Devang Patel4243e672011-05-11 19:22:19 +0000399 DebugLoc PrologEndLoc;
400
Chris Lattner9c69e285532010-04-04 22:59:04 +0000401 // Section Symbols: these are assembler temporary labels that are emitted at
402 // the beginning of each supported dwarf section. These are used to form
403 // section offsets and are created by EmitSectionLabels.
Rafael Espindolaf2b04232011-05-06 14:56:22 +0000404 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
Devang Patelf2548ca2010-04-16 23:33:45 +0000405 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
Eric Christopher9a9e73b2013-04-07 03:43:09 +0000406 MCSymbol *DwarfDebugLocSectionSym, *DwarfLineSectionSym, *DwarfAddrSectionSym;
Devang Patelc3f5f782010-05-25 23:40:22 +0000407 MCSymbol *FunctionBeginSym, *FunctionEndSym;
Eric Christopher64f824c2012-12-27 02:14:01 +0000408 MCSymbol *DwarfAbbrevDWOSectionSym, *DwarfStrDWOSectionSym;
Devang Patelca76f6f2010-07-08 20:10:35 +0000409
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000410 // As an optimization, there is no need to emit an entry in the directory
Eric Christopheraa30a0c2013-07-03 01:57:23 +0000411 // table for the same directory as DW_AT_comp_dir.
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000412 StringRef CompilationDir;
413
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000414 // Counter for assigning globally unique IDs for CUs.
415 unsigned GlobalCUIndexCount;
416
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000417 // Holder for the file specific debug information.
418 DwarfUnits InfoHolder;
419
Eric Christopher617d1832012-12-10 22:25:41 +0000420 // Holders for the various debug information flags that we might need to
421 // have exposed. See accessor functions below for description.
422
423 // Whether or not we're emitting info for older versions of gdb on darwin.
424 bool IsDarwinGDBCompat;
425
Eric Christopherc9c17a82013-07-03 01:57:26 +0000426 // Holder for imported entities.
427 typedef SmallVector<std::pair<const MDNode *, const MDNode *>, 32>
428 ImportedEntityMap;
429 ImportedEntityMap ScopesWithImportedEntities;
430
Eric Christopher3dee5752013-07-26 17:02:41 +0000431 // Holder for types that are going to be extracted out into a type unit.
432 std::vector<DIE *> TypeUnits;
433
Eric Christopher5cf823c2012-11-29 22:56:13 +0000434 // DWARF5 Experimental Options
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000435 bool HasDwarfAccelTables;
Eric Christopher4daaed12012-12-10 19:51:21 +0000436 bool HasSplitDwarf;
Eric Christopher28bd25a2012-12-10 19:51:13 +0000437
Manman Ren0e6783f2013-07-02 23:40:10 +0000438 unsigned DwarfVersion;
439
Eric Christopher0b944ee2012-12-11 19:42:09 +0000440 // Separated Dwarf Variables
Eric Christopher28bd25a2012-12-10 19:51:13 +0000441 // In general these will all be for bits that are left in the
442 // original object file, rather than things that are meant
443 // to be in the .dwo sections.
444
Eric Christopher01776a52013-02-06 21:53:56 +0000445 // The CUs left in the original object file for separated debug info.
446 SmallVector<CompileUnit *, 1> SkeletonCUs;
Eric Christopher6eebe472012-12-19 22:02:53 +0000447
Eric Christopher64f824c2012-12-27 02:14:01 +0000448 // Used to uniquely define abbreviations for the skeleton emission.
Eric Christopher6eebe472012-12-19 22:02:53 +0000449 FoldingSet<DIEAbbrev> SkeletonAbbrevSet;
450
451 // A list of all the unique abbreviations in use.
452 std::vector<DIEAbbrev *> SkeletonAbbrevs;
453
Eric Christopher64f824c2012-12-27 02:14:01 +0000454 // Holder for the skeleton information.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000455 DwarfUnits SkeletonHolder;
Eric Christopher28bd25a2012-12-10 19:51:13 +0000456
Devang Patele62dfcf2011-03-31 16:53:49 +0000457private:
Bill Wendling0310d762009-05-15 09:23:25 +0000458
Devang Patelbf47fdb2011-08-10 20:55:27 +0000459 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
Devang Patel53bb5c92009-11-10 23:06:00 +0000460
Eric Christopherb6dc8652012-11-27 22:43:45 +0000461 /// \brief Find abstract variable associated with Var.
Devang Patel26c1e562010-05-20 16:36:41 +0000462 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
Devang Patel53bb5c92009-11-10 23:06:00 +0000463
Eric Christopherb6dc8652012-11-27 22:43:45 +0000464 /// \brief Find DIE for the given subprogram and attach appropriate
465 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
466 /// variables in this scope then create and insert DIEs for these
467 /// variables.
Devang Pateld3024342011-08-15 22:24:32 +0000468 DIE *updateSubprogramScopeDIE(CompileUnit *SPCU, const MDNode *SPNode);
Bill Wendling0310d762009-05-15 09:23:25 +0000469
Eric Christopherb6dc8652012-11-27 22:43:45 +0000470 /// \brief Construct new DW_TAG_lexical_block for this scope and
471 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
Devang Pateld3024342011-08-15 22:24:32 +0000472 DIE *constructLexicalScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
Bill Wendling0310d762009-05-15 09:23:25 +0000473
Eric Christopherb6dc8652012-11-27 22:43:45 +0000474 /// \brief This scope represents inlined body of a function. Construct
475 /// DIE to represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000476 DIE *constructInlinedScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000477
Eric Christopherb6dc8652012-11-27 22:43:45 +0000478 /// \brief Construct a DIE for this scope.
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000479 DIE *constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
Devang Patel2c4ceb12009-11-21 02:48:08 +0000480
Eric Christopherb6dc8652012-11-27 22:43:45 +0000481 /// \brief Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000482 void emitSectionLabels();
Bill Wendling0310d762009-05-15 09:23:25 +0000483
Eric Christopherb6dc8652012-11-27 22:43:45 +0000484 /// \brief Compute the size and offset of a DIE given an incoming Offset.
Eric Christopherfbd19752012-11-20 22:14:13 +0000485 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset);
Bill Wendling0310d762009-05-15 09:23:25 +0000486
Eric Christopherb6dc8652012-11-27 22:43:45 +0000487 /// \brief Compute the size and offset of all the DIEs.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000488 void computeSizeAndOffsets();
Bill Wendling0310d762009-05-15 09:23:25 +0000489
Eric Christopherb6dc8652012-11-27 22:43:45 +0000490 /// \brief Attach DW_AT_inline attribute with inlined subprogram DIEs.
Eric Christopher4117bec2012-11-22 00:59:49 +0000491 void computeInlinedDIEs();
492
Eric Christopherb6dc8652012-11-27 22:43:45 +0000493 /// \brief Collect info for variables that were optimized out.
Eric Christopher4117bec2012-11-22 00:59:49 +0000494 void collectDeadVariables();
495
Eric Christopherb6dc8652012-11-27 22:43:45 +0000496 /// \brief Finish off debug information after all functions have been
497 /// processed.
Eric Christopher4117bec2012-11-22 00:59:49 +0000498 void finalizeModuleInfo();
499
Eric Christopherb6dc8652012-11-27 22:43:45 +0000500 /// \brief Emit labels to close any remaining sections that have been left
501 /// open.
Eric Christopher4117bec2012-11-22 00:59:49 +0000502 void endSections();
503
Eric Christopher6eebe472012-12-19 22:02:53 +0000504 /// \brief Emit a set of abbreviations to the specific section.
505 void emitAbbrevs(const MCSection *, std::vector<DIEAbbrev*> *);
506
Eric Christopherb6dc8652012-11-27 22:43:45 +0000507 /// \brief Emit the debug info section.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000508 void emitDebugInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000509
Eric Christopherb6dc8652012-11-27 22:43:45 +0000510 /// \brief Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +0000511 void emitAbbreviations();
Bill Wendling0310d762009-05-15 09:23:25 +0000512
Eric Christopherb6dc8652012-11-27 22:43:45 +0000513 /// \brief Emit the last address of the section and the end of
Bill Wendling0310d762009-05-15 09:23:25 +0000514 /// the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000515 void emitEndOfLineMatrix(unsigned SectionEnd);
Bill Wendling0310d762009-05-15 09:23:25 +0000516
Eric Christopherb6dc8652012-11-27 22:43:45 +0000517 /// \brief Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +0000518 void emitAccelNames();
Eric Christopherc82fbf42012-11-21 00:03:28 +0000519
Eric Christopherb6dc8652012-11-27 22:43:45 +0000520 /// \brief Emit objective C classes and categories into a hashed
Eric Christopher09ac3d82011-11-07 09:24:32 +0000521 /// accelerator table section.
522 void emitAccelObjC();
523
Eric Christopherb6dc8652012-11-27 22:43:45 +0000524 /// \brief Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +0000525 void emitAccelNamespaces();
526
Eric Christopherb6dc8652012-11-27 22:43:45 +0000527 /// \brief Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +0000528 void emitAccelTypes();
Eric Christopherc82fbf42012-11-21 00:03:28 +0000529
Krzysztof Parzyszekc5ef7ee2013-02-12 18:00:14 +0000530 /// \brief Emit visible names into a debug pubnames section.
531 void emitDebugPubnames();
532
Eric Christopherb6dc8652012-11-27 22:43:45 +0000533 /// \brief Emit visible types into a debug pubtypes section.
Devang Patel193f7202009-11-24 01:14:22 +0000534 void emitDebugPubTypes();
535
Eric Christopherb6dc8652012-11-27 22:43:45 +0000536 /// \brief Emit visible names into a debug str section.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000537 void emitDebugStr();
Bill Wendling0310d762009-05-15 09:23:25 +0000538
Eric Christopherb6dc8652012-11-27 22:43:45 +0000539 /// \brief Emit visible names into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000540 void emitDebugLoc();
Bill Wendling0310d762009-05-15 09:23:25 +0000541
Eric Christopherb6dc8652012-11-27 22:43:45 +0000542 /// \brief Emit visible names into a debug aranges section.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000543 void emitDebugARanges();
Bill Wendling0310d762009-05-15 09:23:25 +0000544
Eric Christopherb6dc8652012-11-27 22:43:45 +0000545 /// \brief Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000546 void emitDebugRanges();
Bill Wendling0310d762009-05-15 09:23:25 +0000547
Eric Christopherb6dc8652012-11-27 22:43:45 +0000548 /// \brief Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000549 void emitDebugMacInfo();
Bill Wendling0310d762009-05-15 09:23:25 +0000550
Eric Christopherb6dc8652012-11-27 22:43:45 +0000551 /// \brief Emit inline info using custom format.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000552 void emitDebugInlineInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000553
Eric Christopher4daaed12012-12-10 19:51:21 +0000554 /// DWARF 5 Experimental Split Dwarf Emitters
Eric Christopher98e237f2012-11-30 23:59:06 +0000555
Eric Christopher4daaed12012-12-10 19:51:21 +0000556 /// \brief Construct the split debug info compile unit for the debug info
557 /// section.
558 CompileUnit *constructSkeletonCU(const MDNode *);
Eric Christopher98e237f2012-11-30 23:59:06 +0000559
Eric Christopher6eebe472012-12-19 22:02:53 +0000560 /// \brief Emit the local split abbreviations.
561 void emitSkeletonAbbrevs(const MCSection *);
562
Eric Christopher98e237f2012-11-30 23:59:06 +0000563 /// \brief Emit the debug info dwo section.
564 void emitDebugInfoDWO();
565
Eric Christopher6eebe472012-12-19 22:02:53 +0000566 /// \brief Emit the debug abbrev dwo section.
567 void emitDebugAbbrevDWO();
568
Eric Christopher64f824c2012-12-27 02:14:01 +0000569 /// \brief Emit the debug str dwo section.
570 void emitDebugStrDWO();
571
Eric Christopherb6dc8652012-11-27 22:43:45 +0000572 /// \brief Create new CompileUnit for the given metadata node with tag
573 /// DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000574 CompileUnit *constructCompileUnit(const MDNode *N);
Devang Patel163a9f72010-05-10 22:49:55 +0000575
Eric Christopherb6dc8652012-11-27 22:43:45 +0000576 /// \brief Construct subprogram DIE.
Devang Patel3655a212011-08-15 23:36:40 +0000577 void constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000578
David Blaikie20d9e412013-05-07 21:35:53 +0000579 /// \brief Construct imported_module or imported_declaration DIE.
580 void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N);
David Blaikiec462db62013-04-22 06:12:31 +0000581
David Blaikied2e0f7e2013-05-06 23:33:07 +0000582 /// \brief Construct import_module DIE.
David Blaikied1221e32013-05-08 06:01:38 +0000583 void constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000584 DIE *Context);
585
586 /// \brief Construct import_module DIE.
David Blaikied1221e32013-05-08 06:01:38 +0000587 void constructImportedEntityDIE(CompileUnit *TheCU,
David Blaikie20d9e412013-05-07 21:35:53 +0000588 const DIImportedEntity &Module,
David Blaikied2e0f7e2013-05-06 23:33:07 +0000589 DIE *Context);
590
Eric Christopherb6dc8652012-11-27 22:43:45 +0000591 /// \brief Register a source line with debug info. Returns the unique
592 /// label that was emitted and which provides correspondence to the
593 /// source line list.
Devang Patel4243e672011-05-11 19:22:19 +0000594 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
595 unsigned Flags);
Eric Christopherc82fbf42012-11-21 00:03:28 +0000596
Eric Christopherb6dc8652012-11-27 22:43:45 +0000597 /// \brief Indentify instructions that are marking the beginning of or
598 /// ending of a scope.
Devang Patele37b0c62010-04-08 18:43:56 +0000599 void identifyScopeMarkers();
Devang Patel6122a4d2010-04-08 15:37:09 +0000600
Eric Christopherb6dc8652012-11-27 22:43:45 +0000601 /// \brief If Var is an current function argument that add it in
602 /// CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +0000603 bool addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +0000604 DbgVariable *Var, LexicalScope *Scope);
Devang Patel0478c152011-03-01 22:58:55 +0000605
Eric Christopherb6dc8652012-11-27 22:43:45 +0000606 /// \brief Populate LexicalScope entries with variables' info.
Devang Patel78e127d2010-06-25 22:07:34 +0000607 void collectVariableInfo(const MachineFunction *,
608 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
Eric Christopherc82fbf42012-11-21 00:03:28 +0000609
Eric Christopherb6dc8652012-11-27 22:43:45 +0000610 /// \brief Collect variable information from the side table maintained
611 /// by MMI.
Devang Patelee432862010-05-20 19:57:06 +0000612 void collectVariableInfoFromMMITable(const MachineFunction * MF,
613 SmallPtrSet<const MDNode *, 16> &P);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +0000614
Eric Christopherb6dc8652012-11-27 22:43:45 +0000615 /// \brief Ensure that a label will be emitted before MI.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +0000616 void requestLabelBeforeInsn(const MachineInstr *MI) {
617 LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
618 }
619
Eric Christopherb6dc8652012-11-27 22:43:45 +0000620 /// \brief Return Label preceding the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000621 MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +0000622
Eric Christopherb6dc8652012-11-27 22:43:45 +0000623 /// \brief Ensure that a label will be emitted after MI.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +0000624 void requestLabelAfterInsn(const MachineInstr *MI) {
625 LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
626 }
627
Eric Christopherb6dc8652012-11-27 22:43:45 +0000628 /// \brief Return Label immediately following the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000629 MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +0000630
Bill Wendling0310d762009-05-15 09:23:25 +0000631public:
632 //===--------------------------------------------------------------------===//
633 // Main entry points.
634 //
Chris Lattner49cd6642010-04-05 05:11:15 +0000635 DwarfDebug(AsmPrinter *A, Module *M);
Chris Lattner2b1b3312010-04-05 05:32:45 +0000636 ~DwarfDebug();
Bill Wendling0310d762009-05-15 09:23:25 +0000637
Eric Christopherb6dc8652012-11-27 22:43:45 +0000638 /// \brief Emit all Dwarf sections that should come prior to the
Bill Wendling0310d762009-05-15 09:23:25 +0000639 /// content.
Eric Christopherc4639d62012-11-19 22:42:15 +0000640 void beginModule();
Bill Wendling0310d762009-05-15 09:23:25 +0000641
Eric Christopherb6dc8652012-11-27 22:43:45 +0000642 /// \brief Emit all Dwarf sections that should come after the content.
Devang Patel2c4ceb12009-11-21 02:48:08 +0000643 void endModule();
Bill Wendling0310d762009-05-15 09:23:25 +0000644
Eric Christopherb6dc8652012-11-27 22:43:45 +0000645 /// \brief Gather pre-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +0000646 void beginFunction(const MachineFunction *MF);
Bill Wendling0310d762009-05-15 09:23:25 +0000647
Eric Christopherb6dc8652012-11-27 22:43:45 +0000648 /// \brief Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +0000649 void endFunction(const MachineFunction *MF);
Bill Wendling0310d762009-05-15 09:23:25 +0000650
Eric Christopherb6dc8652012-11-27 22:43:45 +0000651 /// \brief Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +0000652 void beginInstruction(const MachineInstr *MI);
Bill Wendling0310d762009-05-15 09:23:25 +0000653
Eric Christopherb6dc8652012-11-27 22:43:45 +0000654 /// \brief Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +0000655 void endInstruction(const MachineInstr *MI);
Devang Patel3cbee302011-04-12 22:53:02 +0000656
Eric Christopher3dee5752013-07-26 17:02:41 +0000657 /// \brief Add a DIE to the set of types that we're going to pull into
658 /// type units.
659 void addTypeUnitType(DIE *Die) { TypeUnits.push_back(Die); }
660
Eric Christopherb6dc8652012-11-27 22:43:45 +0000661 /// \brief Look up the source id with the given directory and source file
662 /// names. If none currently exists, create a new id and insert it in the
663 /// SourceIds map.
Manman Ren3de61b42013-03-07 01:42:00 +0000664 unsigned getOrCreateSourceID(StringRef DirName, StringRef FullName,
665 unsigned CUID);
Devang Patel3cbee302011-04-12 22:53:02 +0000666
Eric Christopherb1e66d02012-12-15 00:04:07 +0000667 /// \brief Recursively Emits a debug information entry.
Eric Christopher6eebe472012-12-19 22:02:53 +0000668 void emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs);
Eric Christopherb1e66d02012-12-15 00:04:07 +0000669
Eric Christopherb6dc8652012-11-27 22:43:45 +0000670 /// \brief Returns whether or not to limit some of our debug
Eric Christopherc1610fa2012-08-23 22:36:36 +0000671 /// output to the limitations of darwin gdb.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000672 bool useDarwinGDBCompat() { return IsDarwinGDBCompat; }
Eric Christophere6ad6ac2012-11-21 00:03:31 +0000673
674 // Experimental DWARF5 features.
675
Eric Christopherb6dc8652012-11-27 22:43:45 +0000676 /// \brief Returns whether or not to emit tables that dwarf consumers can
677 /// use to accelerate lookup.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000678 bool useDwarfAccelTables() { return HasDwarfAccelTables; }
Eric Christophere6ad6ac2012-11-21 00:03:31 +0000679
Eric Christopherb6dc8652012-11-27 22:43:45 +0000680 /// \brief Returns whether or not to change the current debug info for the
Eric Christopher4daaed12012-12-10 19:51:21 +0000681 /// split dwarf proposal support.
682 bool useSplitDwarf() { return HasSplitDwarf; }
Manman Ren0e6783f2013-07-02 23:40:10 +0000683
684 /// Returns the Dwarf Version.
685 unsigned getDwarfVersion() const { return DwarfVersion; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000686};
Bill Wendling0310d762009-05-15 09:23:25 +0000687} // End of namespace llvm
688
689#endif