blob: 5d19a8d765e3751a84907afec1e8aed3b0e06be3 [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
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//===----------------------------------------------------------------------===//
Chris Lattner6cde3e62010-03-09 00:39:24 +000013
Devang Patele4b27562009-08-28 23:24:31 +000014#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000015#include "DwarfDebug.h"
Chris Lattner74e41f92010-04-05 05:24:55 +000016#include "DIE.h"
Eric Christopher09ac3d82011-11-07 09:24:32 +000017#include "DwarfAccelTable.h"
Devang Patel8b9df622011-04-12 17:40:32 +000018#include "DwarfCompileUnit.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000019#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/Statistic.h"
21#include "llvm/ADT/StringExtras.h"
22#include "llvm/ADT/Triple.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000023#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000024#include "llvm/CodeGen/MachineModuleInfo.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000025#include "llvm/DIBuilder.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000026#include "llvm/DebugInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000027#include "llvm/IR/Constants.h"
28#include "llvm/IR/DataLayout.h"
29#include "llvm/IR/Instructions.h"
30#include "llvm/IR/Module.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000031#include "llvm/MC/MCAsmInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000032#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000033#include "llvm/MC/MCStreamer.h"
Chris Lattnerb7db7332010-03-09 01:58:53 +000034#include "llvm/MC/MCSymbol.h"
Devang Pateleac9c072010-04-27 19:46:33 +000035#include "llvm/Support/CommandLine.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000036#include "llvm/Support/Debug.h"
37#include "llvm/Support/ErrorHandling.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000038#include "llvm/Support/FormattedStream.h"
Michael J. Spencer1f6efa32010-11-29 18:16:10 +000039#include "llvm/Support/Path.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000040#include "llvm/Support/Timer.h"
41#include "llvm/Support/ValueHandle.h"
42#include "llvm/Target/TargetFrameLowering.h"
43#include "llvm/Target/TargetLoweringObjectFile.h"
44#include "llvm/Target/TargetMachine.h"
45#include "llvm/Target/TargetOptions.h"
46#include "llvm/Target/TargetRegisterInfo.h"
Bill Wendling0310d762009-05-15 09:23:25 +000047using namespace llvm;
48
Jim Grosbach1e20b962010-07-21 21:21:52 +000049static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
Devang Patel61409622010-07-07 20:12:52 +000050 cl::Hidden,
Devang Pateleac9c072010-04-27 19:46:33 +000051 cl::desc("Disable debug info printing"));
52
Dan Gohman281d65d2010-05-07 01:08:53 +000053static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
Chris Lattner7a2bdde2011-04-15 05:18:47 +000054 cl::desc("Make an absence of debug location information explicit."),
Dan Gohman281d65d2010-05-07 01:08:53 +000055 cl::init(false));
56
Eric Christopher20f47ab2012-08-23 22:36:40 +000057namespace {
58 enum DefaultOnOff {
59 Default, Enable, Disable
60 };
61}
Eric Christopher09ac3d82011-11-07 09:24:32 +000062
Eric Christopher20f47ab2012-08-23 22:36:40 +000063static cl::opt<DefaultOnOff> DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
64 cl::desc("Output prototype dwarf accelerator tables."),
65 cl::values(
66 clEnumVal(Default, "Default for platform"),
67 clEnumVal(Enable, "Enabled"),
68 clEnumVal(Disable, "Disabled"),
69 clEnumValEnd),
70 cl::init(Default));
71
72static cl::opt<DefaultOnOff> DarwinGDBCompat("darwin-gdb-compat", cl::Hidden,
Eric Christopher10cb7442012-08-23 07:10:46 +000073 cl::desc("Compatibility with Darwin gdb."),
Eric Christopher20f47ab2012-08-23 22:36:40 +000074 cl::values(
75 clEnumVal(Default, "Default for platform"),
76 clEnumVal(Enable, "Enabled"),
77 clEnumVal(Disable, "Disabled"),
78 clEnumValEnd),
79 cl::init(Default));
Eric Christopher10cb7442012-08-23 07:10:46 +000080
Eric Christopher4daaed12012-12-10 19:51:21 +000081static cl::opt<DefaultOnOff> SplitDwarf("split-dwarf", cl::Hidden,
82 cl::desc("Output prototype dwarf split debug info."),
Eric Christopherf5b6dcd2012-11-12 22:22:20 +000083 cl::values(
84 clEnumVal(Default, "Default for platform"),
85 clEnumVal(Enable, "Enabled"),
86 clEnumVal(Disable, "Disabled"),
87 clEnumValEnd),
88 cl::init(Default));
89
Bill Wendling5f017e82010-04-07 09:28:04 +000090namespace {
91 const char *DWARFGroupName = "DWARF Emission";
92 const char *DbgTimerName = "DWARF Debug Writer";
93} // end anonymous namespace
94
Bill Wendling0310d762009-05-15 09:23:25 +000095//===----------------------------------------------------------------------===//
96
Eric Christopherb6dc8652012-11-27 22:43:45 +000097// Configuration values for initial hash set sizes (log2).
98//
Bill Wendling0310d762009-05-15 09:23:25 +000099static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendling0310d762009-05-15 09:23:25 +0000100
101namespace llvm {
102
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000103DIType DbgVariable::getType() const {
Devang Patel3cbee302011-04-12 22:53:02 +0000104 DIType Ty = Var.getType();
105 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
106 // addresses instead.
107 if (Var.isBlockByrefVariable()) {
108 /* Byref variables, in Blocks, are declared by the programmer as
109 "SomeType VarName;", but the compiler creates a
110 __Block_byref_x_VarName struct, and gives the variable VarName
111 either the struct, or a pointer to the struct, as its type. This
112 is necessary for various behind-the-scenes things the compiler
113 needs to do with by-reference variables in blocks.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000114
Devang Patel3cbee302011-04-12 22:53:02 +0000115 However, as far as the original *programmer* is concerned, the
116 variable should still have type 'SomeType', as originally declared.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000117
Devang Patel3cbee302011-04-12 22:53:02 +0000118 The following function dives into the __Block_byref_x_VarName
119 struct to find the original type of the variable. This will be
120 passed back to the code generating the type for the Debug
121 Information Entry for the variable 'VarName'. 'VarName' will then
122 have the original type 'SomeType' in its debug information.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000123
Devang Patel3cbee302011-04-12 22:53:02 +0000124 The original type 'SomeType' will be the type of the field named
125 'VarName' inside the __Block_byref_x_VarName struct.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000126
Devang Patel3cbee302011-04-12 22:53:02 +0000127 NOTE: In order for this to not completely fail on the debugger
128 side, the Debug Information Entry for the variable VarName needs to
129 have a DW_AT_location that tells the debugger how to unwind through
130 the pointers and __Block_byref_x_VarName struct to find the actual
131 value of the variable. The function addBlockByrefType does this. */
132 DIType subType = Ty;
133 unsigned tag = Ty.getTag();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000134
Devang Patel3cbee302011-04-12 22:53:02 +0000135 if (tag == dwarf::DW_TAG_pointer_type) {
136 DIDerivedType DTy = DIDerivedType(Ty);
137 subType = DTy.getTypeDerivedFrom();
138 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000139
Devang Patel3cbee302011-04-12 22:53:02 +0000140 DICompositeType blockStruct = DICompositeType(subType);
141 DIArray Elements = blockStruct.getTypeArray();
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000142
Devang Patel3cbee302011-04-12 22:53:02 +0000143 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
144 DIDescriptor Element = Elements.getElement(i);
145 DIDerivedType DT = DIDerivedType(Element);
146 if (getName() == DT.getName())
147 return (DT.getTypeDerivedFrom());
Devang Patel8bd11de2010-08-09 21:01:39 +0000148 }
Devang Patel8bd11de2010-08-09 21:01:39 +0000149 }
Devang Patel3cbee302011-04-12 22:53:02 +0000150 return Ty;
151}
Bill Wendling0310d762009-05-15 09:23:25 +0000152
Chris Lattnerea761862010-04-05 04:09:20 +0000153} // end llvm namespace
Bill Wendling0310d762009-05-15 09:23:25 +0000154
Chris Lattner49cd6642010-04-05 05:11:15 +0000155DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
Eric Christopher28bd25a2012-12-10 19:51:13 +0000156 : Asm(A), MMI(Asm->MMI), FirstCU(0),
Jim Grosbach1e20b962010-07-21 21:21:52 +0000157 AbbreviationsSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000158 SourceIdMap(DIEValueAllocator),
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000159 PrevLabel(NULL), GlobalCUIndexCount(0),
Eric Christopherb6714222013-01-08 22:22:06 +0000160 InfoHolder(A, &AbbreviationsSet, &Abbreviations, "info_string",
161 DIEValueAllocator),
Eric Christopher6eebe472012-12-19 22:02:53 +0000162 SkeletonAbbrevSet(InitAbbreviationsSetSize),
Eric Christopherb6714222013-01-08 22:22:06 +0000163 SkeletonHolder(A, &SkeletonAbbrevSet, &SkeletonAbbrevs, "skel_string",
164 DIEValueAllocator) {
Jim Grosbach1e20b962010-07-21 21:21:52 +0000165
Rafael Espindolaf2b04232011-05-06 14:56:22 +0000166 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
Chris Lattner4ad1efe2010-04-04 23:10:38 +0000167 DwarfStrSectionSym = TextSectionSym = 0;
Eric Christopher7a0103c2013-02-07 21:19:50 +0000168 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
Eric Christopher64f824c2012-12-27 02:14:01 +0000169 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
Devang Patelc3f5f782010-05-25 23:40:22 +0000170 FunctionBeginSym = FunctionEndSym = 0;
Eric Christopher60777d82012-04-02 17:58:52 +0000171
Eric Christopher10cb7442012-08-23 07:10:46 +0000172 // Turn on accelerator tables and older gdb compatibility
173 // for Darwin.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000174 bool IsDarwin = Triple(M->getTargetTriple()).isOSDarwin();
Eric Christopher20f47ab2012-08-23 22:36:40 +0000175 if (DarwinGDBCompat == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000176 if (IsDarwin)
177 IsDarwinGDBCompat = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000178 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000179 IsDarwinGDBCompat = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000180 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000181 IsDarwinGDBCompat = DarwinGDBCompat == Enable ? true : false;
Eric Christopherc1610fa2012-08-23 22:36:36 +0000182
Eric Christopher20f47ab2012-08-23 22:36:40 +0000183 if (DwarfAccelTables == Default) {
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000184 if (IsDarwin)
185 HasDwarfAccelTables = true;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000186 else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000187 HasDwarfAccelTables = false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000188 } else
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000189 HasDwarfAccelTables = DwarfAccelTables == Enable ? true : false;
Eric Christopher20f47ab2012-08-23 22:36:40 +0000190
Eric Christopher4daaed12012-12-10 19:51:21 +0000191 if (SplitDwarf == Default)
192 HasSplitDwarf = false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000193 else
Eric Christopher4daaed12012-12-10 19:51:21 +0000194 HasSplitDwarf = SplitDwarf == Enable ? true : false;
Eric Christopherf5b6dcd2012-11-12 22:22:20 +0000195
Dan Gohman03c3dc72010-06-18 15:56:31 +0000196 {
197 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
Eric Christopherc4639d62012-11-19 22:42:15 +0000198 beginModule();
Torok Edwin9c421072010-04-07 10:44:46 +0000199 }
Bill Wendling0310d762009-05-15 09:23:25 +0000200}
201DwarfDebug::~DwarfDebug() {
Bill Wendling0310d762009-05-15 09:23:25 +0000202}
203
Eric Christopherb6dc8652012-11-27 22:43:45 +0000204// Switch to the specified MCSection and emit an assembler
205// temporary label to it if SymbolStem is specified.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000206static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
Eric Christopherd8a87522011-11-07 09:18:38 +0000207 const char *SymbolStem = 0) {
208 Asm->OutStreamer.SwitchSection(Section);
209 if (!SymbolStem) return 0;
210
211 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
212 Asm->OutStreamer.EmitLabel(TmpSym);
213 return TmpSym;
214}
215
Eric Christopher2e5d8702012-12-20 21:58:36 +0000216MCSymbol *DwarfUnits::getStringPoolSym() {
Eric Christopher64f824c2012-12-27 02:14:01 +0000217 return Asm->GetTempSymbol(StringPref);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000218}
219
Eric Christopher2e5d8702012-12-20 21:58:36 +0000220MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
221 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000222 StringPool.GetOrCreateValue(Str).getValue();
Chris Lattnerbc733f52010-03-13 02:17:42 +0000223 if (Entry.first) return Entry.first;
224
225 Entry.second = NextStringPoolNumber++;
Eric Christopher64f824c2012-12-27 02:14:01 +0000226 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
Chris Lattnerbc733f52010-03-13 02:17:42 +0000227}
228
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000229unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
230 std::pair<MCSymbol*, unsigned> &Entry =
Eric Christopherb6714222013-01-08 22:22:06 +0000231 StringPool.GetOrCreateValue(Str).getValue();
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000232 if (Entry.first) return Entry.second;
233
234 Entry.second = NextStringPoolNumber++;
235 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
236 return Entry.second;
237}
238
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000239unsigned DwarfUnits::getAddrPoolIndex(MCSymbol *Sym) {
240 std::pair<MCSymbol*, unsigned> &Entry = AddressPool[Sym];
241 if (Entry.first) return Entry.second;
242
243 Entry.second = NextAddrPoolNumber++;
244 Entry.first = Sym;
245 return Entry.second;
246}
247
Eric Christopherb6dc8652012-11-27 22:43:45 +0000248// Define a unique number for the abbreviation.
249//
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000250void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendling0310d762009-05-15 09:23:25 +0000251 // Profile the node so that we can make it unique.
252 FoldingSetNodeID ID;
253 Abbrev.Profile(ID);
254
255 // Check the set for priors.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000256 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000257
258 // If it's newly added.
259 if (InSet == &Abbrev) {
260 // Add to abbreviation list.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000261 Abbreviations->push_back(&Abbrev);
Bill Wendling0310d762009-05-15 09:23:25 +0000262
263 // Assign the vector position + 1 as its number.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000264 Abbrev.setNumber(Abbreviations->size());
Bill Wendling0310d762009-05-15 09:23:25 +0000265 } else {
266 // Assign existing abbreviation number.
267 Abbrev.setNumber(InSet->getNumber());
268 }
269}
270
Eric Christopherb6dc8652012-11-27 22:43:45 +0000271// If special LLVM prefix that is used to inform the asm
272// printer to not emit usual symbol prefix before the symbol name is used then
273// return linkage name after skipping this special LLVM prefix.
Devang Patel351ca332010-01-05 01:46:14 +0000274static StringRef getRealLinkageName(StringRef LinkageName) {
275 char One = '\1';
276 if (LinkageName.startswith(StringRef(&One, 1)))
277 return LinkageName.substr(1);
278 return LinkageName;
279}
280
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000281static bool isObjCClass(StringRef Name) {
282 return Name.startswith("+") || Name.startswith("-");
283}
284
285static bool hasObjCCategory(StringRef Name) {
286 if (!isObjCClass(Name)) return false;
287
288 size_t pos = Name.find(')');
289 if (pos != std::string::npos) {
290 if (Name[pos+1] != ' ') return false;
291 return true;
292 }
293 return false;
294}
295
296static void getObjCClassCategory(StringRef In, StringRef &Class,
297 StringRef &Category) {
298 if (!hasObjCCategory(In)) {
299 Class = In.slice(In.find('[') + 1, In.find(' '));
300 Category = "";
301 return;
302 }
303
304 Class = In.slice(In.find('[') + 1, In.find('('));
305 Category = In.slice(In.find('[') + 1, In.find(' '));
306 return;
307}
308
309static StringRef getObjCMethodName(StringRef In) {
310 return In.slice(In.find(' ') + 1, In.find(']'));
311}
312
313// Add the various names to the Dwarf accelerator table names.
314static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
315 DIE* Die) {
316 if (!SP.isDefinition()) return;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000317
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000318 TheCU->addAccelName(SP.getName(), Die);
319
320 // If the linkage name is different than the name, go ahead and output
321 // that as well into the name table.
322 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
323 TheCU->addAccelName(SP.getLinkageName(), Die);
324
325 // If this is an Objective-C selector name add it to the ObjC accelerator
326 // too.
327 if (isObjCClass(SP.getName())) {
328 StringRef Class, Category;
329 getObjCClassCategory(SP.getName(), Class, Category);
330 TheCU->addAccelObjC(Class, Die);
331 if (Category != "")
332 TheCU->addAccelObjC(Category, Die);
333 // Also add the base method name to the name table.
334 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
335 }
336}
337
Eric Christopherb6dc8652012-11-27 22:43:45 +0000338// Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
339// and DW_AT_high_pc attributes. If there are global variables in this
340// scope then create and insert DIEs for these variables.
Devang Pateld3024342011-08-15 22:24:32 +0000341DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
342 const MDNode *SPNode) {
Devang Patel163a9f72010-05-10 22:49:55 +0000343 DIE *SPDie = SPCU->getDIE(SPNode);
Devang Patel8aa61472010-07-07 22:20:57 +0000344
Chris Lattnerd38fee82010-04-05 00:13:49 +0000345 assert(SPDie && "Unable to find subprogram DIE!");
346 DISubprogram SP(SPNode);
Jim Grosbach1e20b962010-07-21 21:21:52 +0000347
Bill Wendling168c1902012-11-07 05:19:04 +0000348 // If we're updating an abstract DIE, then we will be adding the children and
349 // object pointer later on. But what we don't want to do is process the
350 // concrete DIE twice.
Devang Patel8aa61472010-07-07 22:20:57 +0000351 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
Bill Wendling168c1902012-11-07 05:19:04 +0000352 // Pick up abstract subprogram DIE.
Devang Patel8aa61472010-07-07 22:20:57 +0000353 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel3cbee302011-04-12 22:53:02 +0000354 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
355 dwarf::DW_FORM_ref4, AbsSPDIE);
Devang Patel8aa61472010-07-07 22:20:57 +0000356 SPCU->addDie(SPDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000357 } else {
358 DISubprogram SPDecl = SP.getFunctionDeclaration();
359 if (!SPDecl.isSubprogram()) {
360 // There is not any need to generate specification DIE for a function
361 // defined at compile unit level. If a function is defined inside another
362 // function then gdb prefers the definition at top level and but does not
363 // expect specification DIE in parent function. So avoid creating
364 // specification DIE for a function defined inside a function.
365 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
366 !SP.getContext().isFile() &&
367 !isSubprogramContext(SP.getContext())) {
368 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
369
370 // Add arguments.
371 DICompositeType SPTy = SP.getType();
372 DIArray Args = SPTy.getTypeArray();
373 unsigned SPTag = SPTy.getTag();
374 if (SPTag == dwarf::DW_TAG_subroutine_type)
375 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
376 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
377 DIType ATy = DIType(Args.getElement(i));
378 SPCU->addType(Arg, ATy);
379 if (ATy.isArtificial())
380 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
381 if (ATy.isObjectPointer())
382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer,
383 dwarf::DW_FORM_ref4, Arg);
384 SPDie->addChild(Arg);
385 }
386 DIE *SPDeclDie = SPDie;
387 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000388 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification,
389 dwarf::DW_FORM_ref4, SPDeclDie);
Bill Wendlinga4c76932012-11-07 04:42:18 +0000390 SPCU->addDie(SPDie);
391 }
392 }
Devang Patel8aa61472010-07-07 22:20:57 +0000393 }
394
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000395 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
396 Asm->GetTempSymbol("func_begin",
397 Asm->getFunctionNumber()));
398 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
399 Asm->GetTempSymbol("func_end",
400 Asm->getFunctionNumber()));
Chris Lattnerd38fee82010-04-05 00:13:49 +0000401 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
402 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
Devang Patel3cbee302011-04-12 22:53:02 +0000403 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Devang Patelb4645642010-02-06 01:02:37 +0000404
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000405 // Add name to the name table, we do this here because we're guaranteed
406 // to have concrete versions of our DW_TAG_subprogram nodes.
407 addSubprogramNames(SPCU, SP, SPDie);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000408
Chris Lattnerd38fee82010-04-05 00:13:49 +0000409 return SPDie;
Devang Patel53bb5c92009-11-10 23:06:00 +0000410}
411
Eric Christopherb6dc8652012-11-27 22:43:45 +0000412// Construct new DW_TAG_lexical_block for this scope and attach
413// DW_AT_low_pc/DW_AT_high_pc labels.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000414DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
Devang Pateld3024342011-08-15 22:24:32 +0000415 LexicalScope *Scope) {
Devang Pateleac9c072010-04-27 19:46:33 +0000416 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
417 if (Scope->isAbstractScope())
418 return ScopeDIE;
419
Devang Patelbf47fdb2011-08-10 20:55:27 +0000420 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +0000421 if (Ranges.empty())
422 return 0;
423
Devang Patelbf47fdb2011-08-10 20:55:27 +0000424 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Devang Pateleac9c072010-04-27 19:46:33 +0000425 if (Ranges.size() > 1) {
426 // .debug_range section has not been laid out yet. Emit offset in
Jim Grosbach1e20b962010-07-21 21:21:52 +0000427 // .debug_range as a uint, size 4, for now. emitDIE will handle
Devang Pateleac9c072010-04-27 19:46:33 +0000428 // DW_AT_ranges appropriately.
Devang Patel3cbee302011-04-12 22:53:02 +0000429 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000430 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000431 * Asm->getDataLayout().getPointerSize());
Devang Patelbf47fdb2011-08-10 20:55:27 +0000432 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +0000433 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelc3f5f782010-05-25 23:40:22 +0000434 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
435 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
Devang Pateleac9c072010-04-27 19:46:33 +0000436 }
437 DebugRangeSymbols.push_back(NULL);
438 DebugRangeSymbols.push_back(NULL);
439 return ScopeDIE;
440 }
441
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000442 MCSymbol *Start = getLabelBeforeInsn(RI->first);
443 MCSymbol *End = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +0000444
Devang Patelc3f5f782010-05-25 23:40:22 +0000445 if (End == 0) return 0;
Devang Patel53bb5c92009-11-10 23:06:00 +0000446
Chris Lattnerb7db7332010-03-09 01:58:53 +0000447 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
448 assert(End->isDefined() && "Invalid end label for an inlined scope!");
Jim Grosbach1e20b962010-07-21 21:21:52 +0000449
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000450 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
451 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
Devang Patel53bb5c92009-11-10 23:06:00 +0000452
453 return ScopeDIE;
454}
455
Eric Christopherb6dc8652012-11-27 22:43:45 +0000456// This scope represents inlined body of a function. Construct DIE to
457// represent this concrete inlined copy of the function.
Devang Pateld3024342011-08-15 22:24:32 +0000458DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
459 LexicalScope *Scope) {
Devang Patelbf47fdb2011-08-10 20:55:27 +0000460 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
Nick Lewycky746cb672011-10-26 22:55:33 +0000461 assert(Ranges.empty() == false &&
462 "LexicalScope does not have instruction markers!");
Devang Pateleac9c072010-04-27 19:46:33 +0000463
Devang Patel26a92002011-07-27 00:34:13 +0000464 if (!Scope->getScopeNode())
465 return NULL;
466 DIScope DS(Scope->getScopeNode());
467 DISubprogram InlinedSP = getDISubprogram(DS);
Devang Patel26a92002011-07-27 00:34:13 +0000468 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
469 if (!OriginDIE) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000470 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
Devang Patel26a92002011-07-27 00:34:13 +0000471 return NULL;
472 }
473
Devang Patelbf47fdb2011-08-10 20:55:27 +0000474 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000475 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
476 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +0000477
Devang Patel0afbf232010-07-08 22:39:20 +0000478 if (StartLabel == 0 || EndLabel == 0) {
Bill Wendlinge0aae5b2012-10-30 17:51:02 +0000479 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +0000480 }
Chris Lattnerb7db7332010-03-09 01:58:53 +0000481 assert(StartLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +0000482 "Invalid starting label for an inlined scope!");
Chris Lattnerb7db7332010-03-09 01:58:53 +0000483 assert(EndLabel->isDefined() &&
Chris Lattnera34ec2292010-03-09 01:51:43 +0000484 "Invalid end label for an inlined scope!");
Devang Pateleac9c072010-04-27 19:46:33 +0000485
Devang Pateld96efb82011-05-05 17:54:26 +0000486 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
Devang Patel3cbee302011-04-12 22:53:02 +0000487 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
488 dwarf::DW_FORM_ref4, OriginDIE);
Devang Patel53bb5c92009-11-10 23:06:00 +0000489
Devang Patel26a92002011-07-27 00:34:13 +0000490 if (Ranges.size() > 1) {
491 // .debug_range section has not been laid out yet. Emit offset in
492 // .debug_range as a uint, size 4, for now. emitDIE will handle
493 // DW_AT_ranges appropriately.
494 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000495 DebugRangeSymbols.size()
Chandler Carruth426c2bf2012-11-01 09:14:31 +0000496 * Asm->getDataLayout().getPointerSize());
Devang Patelbf47fdb2011-08-10 20:55:27 +0000497 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Patel26a92002011-07-27 00:34:13 +0000498 RE = Ranges.end(); RI != RE; ++RI) {
499 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
500 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
501 }
502 DebugRangeSymbols.push_back(NULL);
503 DebugRangeSymbols.push_back(NULL);
504 } else {
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000505 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
506 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
Devang Patel26a92002011-07-27 00:34:13 +0000507 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000508
509 InlinedSubprogramDIEs.insert(OriginDIE);
510
511 // Track the start label for this inlined function.
Devang Patel26a92002011-07-27 00:34:13 +0000512 //.debug_inlined section specification does not clearly state how
513 // to emit inlined scope that is split into multiple instruction ranges.
514 // For now, use first instruction range and emit low_pc/high_pc pair and
515 // corresponding .debug_inlined section entry for this pair.
Devang Patele9f8f5e2010-05-07 20:54:48 +0000516 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel2db49d72010-05-07 18:11:54 +0000517 I = InlineInfo.find(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +0000518
519 if (I == InlineInfo.end()) {
Nick Lewycky746cb672011-10-26 22:55:33 +0000520 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel2db49d72010-05-07 18:11:54 +0000521 InlinedSPNodes.push_back(InlinedSP);
Devang Patel53bb5c92009-11-10 23:06:00 +0000522 } else
Chris Lattner6ed0f902010-03-09 00:31:02 +0000523 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
Devang Patel53bb5c92009-11-10 23:06:00 +0000524
Devang Patel53bb5c92009-11-10 23:06:00 +0000525 DILocation DL(Scope->getInlinedAt());
Eric Christopher08212002012-03-26 21:38:38 +0000526 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000527 getOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
Devang Patel3cbee302011-04-12 22:53:02 +0000528 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel53bb5c92009-11-10 23:06:00 +0000529
Eric Christopher309bedd2011-12-04 06:02:38 +0000530 // Add name to the name table, we do this here because we're guaranteed
531 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
532 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000533
Devang Patel53bb5c92009-11-10 23:06:00 +0000534 return ScopeDIE;
535}
536
Eric Christopherb6dc8652012-11-27 22:43:45 +0000537// Construct a DIE for this scope.
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000538DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
Devang Patel3c91b052010-03-08 20:52:55 +0000539 if (!Scope || !Scope->getScopeNode())
540 return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000541
Manman Ren8b15d742013-01-31 20:05:14 +0000542 DIScope DS(Scope->getScopeNode());
543 // Early return to avoid creating dangling variable|scope DIEs.
544 if (!Scope->getInlinedAt() && DS.isSubprogram() && Scope->isAbstractScope() &&
545 !TheCU->getDIE(DS))
546 return NULL;
547
Nick Lewycky746cb672011-10-26 22:55:33 +0000548 SmallVector<DIE *, 8> Children;
Eric Christophere5212782012-09-12 23:36:19 +0000549 DIE *ObjectPointer = NULL;
Devang Patel0478c152011-03-01 22:58:55 +0000550
551 // Collect arguments for current function.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000552 if (LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +0000553 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
554 if (DbgVariable *ArgDV = CurrentFnArguments[i])
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000555 if (DIE *Arg =
Eric Christophere5212782012-09-12 23:36:19 +0000556 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
Devang Patel0478c152011-03-01 22:58:55 +0000557 Children.push_back(Arg);
Eric Christophere5212782012-09-12 23:36:19 +0000558 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
559 }
Devang Patel0478c152011-03-01 22:58:55 +0000560
Eric Christopher1aeb7ac2011-10-03 15:49:16 +0000561 // Collect lexical scope children first.
Devang Patelbf47fdb2011-08-10 20:55:27 +0000562 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000563 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000564 if (DIE *Variable =
Eric Christopher7b451cf2012-09-21 22:18:52 +0000565 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
Devang Patel5bc9fec2011-02-19 01:31:27 +0000566 Children.push_back(Variable);
Eric Christopher7b451cf2012-09-21 22:18:52 +0000567 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
568 }
Devang Patelbf47fdb2011-08-10 20:55:27 +0000569 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
Devang Patel5bc9fec2011-02-19 01:31:27 +0000570 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
Devang Pateld0b5a5e2011-08-15 22:04:40 +0000571 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
Devang Patel5bc9fec2011-02-19 01:31:27 +0000572 Children.push_back(Nested);
Devang Patel3c91b052010-03-08 20:52:55 +0000573 DIE *ScopeDIE = NULL;
574 if (Scope->getInlinedAt())
Devang Pateld3024342011-08-15 22:24:32 +0000575 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
Devang Patel3c91b052010-03-08 20:52:55 +0000576 else if (DS.isSubprogram()) {
Devang Patel0dd45582010-06-28 20:53:04 +0000577 ProcessedSPNodes.insert(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000578 if (Scope->isAbstractScope()) {
Devang Pateld3024342011-08-15 22:24:32 +0000579 ScopeDIE = TheCU->getDIE(DS);
Devang Patel8aa61472010-07-07 22:20:57 +0000580 // Note down abstract DIE.
581 if (ScopeDIE)
582 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
583 }
Devang Patel3c91b052010-03-08 20:52:55 +0000584 else
Devang Pateld3024342011-08-15 22:24:32 +0000585 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
Devang Patel3c91b052010-03-08 20:52:55 +0000586 }
Devang Patel5bc9fec2011-02-19 01:31:27 +0000587 else {
588 // There is no need to emit empty lexical block DIE.
589 if (Children.empty())
590 return NULL;
Devang Pateld3024342011-08-15 22:24:32 +0000591 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
Devang Patel5bc9fec2011-02-19 01:31:27 +0000592 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000593
Devang Patelaead63c2010-03-29 22:59:58 +0000594 if (!ScopeDIE) return NULL;
Jim Grosbach1e20b962010-07-21 21:21:52 +0000595
Devang Patel5bc9fec2011-02-19 01:31:27 +0000596 // Add children
597 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
598 E = Children.end(); I != E; ++I)
599 ScopeDIE->addChild(*I);
Devang Patel193f7202009-11-24 01:14:22 +0000600
Eric Christophere5212782012-09-12 23:36:19 +0000601 if (DS.isSubprogram() && ObjectPointer != NULL)
602 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer,
603 dwarf::DW_FORM_ref4, ObjectPointer);
604
Jim Grosbach1e20b962010-07-21 21:21:52 +0000605 if (DS.isSubprogram())
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000606 TheCU->addPubTypes(DISubprogram(DS));
Jim Grosbach1e20b962010-07-21 21:21:52 +0000607
Eric Christopher0ffe2b42011-11-10 19:25:34 +0000608 return ScopeDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +0000609}
610
Eric Christopherb6dc8652012-11-27 22:43:45 +0000611// Look up the source id with the given directory and source file names.
612// If none currently exists, create a new id and insert it in the
613// SourceIds map. This can update DirectoryNames and SourceFileNames maps
614// as well.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000615unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
Devang Patel23670e52011-03-24 20:30:50 +0000616 StringRef DirName) {
Devang Patel1905a182010-09-16 20:57:49 +0000617 // If FE did not provide a file name, then assume stdin.
618 if (FileName.empty())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +0000619 return getOrCreateSourceID("<stdin>", StringRef());
Devang Patel23670e52011-03-24 20:30:50 +0000620
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000621 // TODO: this might not belong here. See if we can factor this better.
622 if (DirName == CompilationDir)
623 DirName = "";
624
Nick Lewycky44d798d2011-10-17 23:05:28 +0000625 unsigned SrcId = SourceIdMap.size()+1;
Devang Patel1905a182010-09-16 20:57:49 +0000626
Benjamin Kramer74612c22012-03-11 14:56:26 +0000627 // We look up the file/dir pair by concatenating them with a zero byte.
628 SmallString<128> NamePair;
629 NamePair += DirName;
630 NamePair += '\0'; // Zero bytes are not allowed in paths.
631 NamePair += FileName;
632
633 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
634 if (Ent.getValue() != SrcId)
635 return Ent.getValue();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000636
Rafael Espindola5c055632010-11-18 02:04:25 +0000637 // Print out a .file directive to specify files for .loc directives.
Benjamin Kramer74612c22012-03-11 14:56:26 +0000638 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000639
640 return SrcId;
641}
642
Eric Christopher72c16552012-12-20 21:58:40 +0000643// Create new CompileUnit for the given metadata node with tag
644// DW_TAG_compile_unit.
Devang Patel94c7ddb2011-08-16 22:09:43 +0000645CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
Devang Patele4b27562009-08-28 23:24:31 +0000646 DICompileUnit DIUnit(N);
Devang Patel65dbc902009-11-25 17:36:49 +0000647 StringRef FN = DIUnit.getFilename();
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000648 CompilationDir = DIUnit.getDirectory();
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000649 // Call this to emit a .file directive if it wasn't emitted for the source
650 // file this CU comes from yet.
651 getOrCreateSourceID(FN, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000652
653 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +0000654 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher2e5d8702012-12-20 21:58:36 +0000655 DIUnit.getLanguage(), Die, Asm,
656 this, &InfoHolder);
Nick Lewycky390c40d2011-10-27 06:44:11 +0000657 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
Devang Patel3cbee302011-04-12 22:53:02 +0000658 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
659 DIUnit.getLanguage());
Nick Lewycky390c40d2011-10-27 06:44:11 +0000660 NewCU->addString(Die, dwarf::DW_AT_name, FN);
Eric Christopher6635cad2012-08-01 18:19:01 +0000661 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000662 // into an entity. We're using 0 (or a NULL label) for this.
663 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
Manman Ren43213cf2013-02-05 21:52:47 +0000664
665 // Define start line table label for each Compile Unit.
666 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
667 NewCU->getUniqueID());
668 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
669 NewCU->getUniqueID());
670
Devang Patel4a602ca2010-03-22 23:11:36 +0000671 // DW_AT_stmt_list is a offset of line number information for this
Devang Patelaf608bd2010-08-24 00:06:12 +0000672 // compile unit in debug_line section.
Rafael Espindola2241e512012-06-22 13:24:07 +0000673 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Rafael Espindola597a7662011-05-04 17:44:06 +0000674 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Manman Ren43213cf2013-02-05 21:52:47 +0000675 LineTableStartSym);
Manman Ren9c5861f2013-02-06 00:59:41 +0000676 else if (NewCU->getUniqueID() == 0)
677 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Devang Patelae84d5b2010-08-31 23:50:19 +0000678 else
Manman Ren43213cf2013-02-05 21:52:47 +0000679 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Eric Christopher7a0103c2013-02-07 21:19:50 +0000680 LineTableStartSym, DwarfLineSectionSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000681
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000682 if (!CompilationDir.empty())
683 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000684 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000685 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000686
Devang Patel65dbc902009-11-25 17:36:49 +0000687 StringRef Flags = DIUnit.getFlags();
688 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000689 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000690
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000691 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000692 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000693 dwarf::DW_FORM_data1, RVer);
694
Devang Patel163a9f72010-05-10 22:49:55 +0000695 if (!FirstCU)
696 FirstCU = NewCU;
Eric Christopher208cc6f2013-02-05 07:31:55 +0000697
Eric Christopher31fb5da2013-02-05 07:32:03 +0000698 if (useSplitDwarf()) {
699 // This should be a unique identifier when we want to build .dwp files.
Eric Christopher208cc6f2013-02-05 07:31:55 +0000700 NewCU->addUInt(Die, dwarf::DW_AT_GNU_dwo_id, dwarf::DW_FORM_data8, 0);
Eric Christopher31fb5da2013-02-05 07:32:03 +0000701 // Now construct the skeleton CU associated.
702 constructSkeletonCU(N);
703 }
Eric Christopher98e237f2012-11-30 23:59:06 +0000704
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000705 InfoHolder.addUnit(NewCU);
706
Devang Patel163a9f72010-05-10 22:49:55 +0000707 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000708 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000709}
710
Eric Christopherb6dc8652012-11-27 22:43:45 +0000711// Construct subprogram DIE.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000712void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel3655a212011-08-15 23:36:40 +0000713 const MDNode *N) {
Rafael Espindolab0527282011-11-04 19:00:29 +0000714 CompileUnit *&CURef = SPMap[N];
715 if (CURef)
716 return;
717 CURef = TheCU;
718
Devang Patele4b27562009-08-28 23:24:31 +0000719 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000720 if (!SP.isDefinition())
721 // This is a method declaration which will be handled while constructing
722 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +0000723 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000724
Devang Pateldbc64af2011-08-15 17:24:54 +0000725 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings639336e2010-04-06 21:38:29 +0000726
727 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +0000728 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000729
730 // Add to context owner.
Devang Patel3cbee302011-04-12 22:53:02 +0000731 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +0000732
Devang Patel13e16b62009-06-26 01:49:18 +0000733 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000734}
735
Eric Christopherb6dc8652012-11-27 22:43:45 +0000736// Collect debug info from named mdnodes such as llvm.dbg.enum and llvm.dbg.ty.
Eric Christopherc4639d62012-11-19 22:42:15 +0000737void DwarfDebug::collectInfoFromNamedMDNodes(const Module *M) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000738 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
739 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
740 const MDNode *N = NMD->getOperand(i);
741 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
742 constructSubprogramDIE(CU, N);
743 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000744
Devang Patel94c7ddb2011-08-16 22:09:43 +0000745 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
746 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
747 const MDNode *N = NMD->getOperand(i);
748 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel28bea082011-08-18 23:17:55 +0000749 CU->createGlobalVariableDIE(N);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000750 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000751
Devang Patel02e603f2011-08-15 23:47:24 +0000752 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
753 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
754 DIType Ty(NMD->getOperand(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000755 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
756 CU->getOrCreateTypeDIE(Ty);
Devang Patel02e603f2011-08-15 23:47:24 +0000757 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000758
Devang Patel02e603f2011-08-15 23:47:24 +0000759 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
760 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
761 DIType Ty(NMD->getOperand(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000762 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
763 CU->getOrCreateTypeDIE(Ty);
Devang Patel02e603f2011-08-15 23:47:24 +0000764 }
765}
766
Eric Christopherb6dc8652012-11-27 22:43:45 +0000767// Collect debug info using DebugInfoFinder.
768// FIXME - Remove this when dragonegg switches to DIBuilder.
Eric Christopherc4639d62012-11-19 22:42:15 +0000769bool DwarfDebug::collectLegacyDebugInfo(const Module *M) {
Devang Patel02e603f2011-08-15 23:47:24 +0000770 DebugInfoFinder DbgFinder;
771 DbgFinder.processModule(*M);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000772
Devang Patel02e603f2011-08-15 23:47:24 +0000773 bool HasDebugInfo = false;
774 // Scan all the compile-units to see if there are any marked as the main
775 // unit. If not, we do not generate debug info.
776 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
777 E = DbgFinder.compile_unit_end(); I != E; ++I) {
778 if (DICompileUnit(*I).isMain()) {
779 HasDebugInfo = true;
780 break;
781 }
782 }
783 if (!HasDebugInfo) return false;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000784
Eric Christopher7a0103c2013-02-07 21:19:50 +0000785 // Emit initial sections so we can refer to them later.
786 emitSectionLabels();
787
Devang Patel02e603f2011-08-15 23:47:24 +0000788 // Create all the compile unit DIEs.
789 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
790 E = DbgFinder.compile_unit_end(); I != E; ++I)
791 constructCompileUnit(*I);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000792
Devang Patel02e603f2011-08-15 23:47:24 +0000793 // Create DIEs for each global variable.
794 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
795 E = DbgFinder.global_variable_end(); I != E; ++I) {
796 const MDNode *N = *I;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000797 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel28bea082011-08-18 23:17:55 +0000798 CU->createGlobalVariableDIE(N);
Devang Patel02e603f2011-08-15 23:47:24 +0000799 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000800
Devang Patel02e603f2011-08-15 23:47:24 +0000801 // Create DIEs for each subprogram.
802 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
803 E = DbgFinder.subprogram_end(); I != E; ++I) {
804 const MDNode *N = *I;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000805 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
806 constructSubprogramDIE(CU, N);
Devang Patel02e603f2011-08-15 23:47:24 +0000807 }
808
809 return HasDebugInfo;
810}
811
Eric Christopherb6dc8652012-11-27 22:43:45 +0000812// Emit all Dwarf sections that should come prior to the content. Create
813// global DIEs and emit initial debug info sections. This is invoked by
814// the target AsmPrinter.
Eric Christopherc4639d62012-11-19 22:42:15 +0000815void DwarfDebug::beginModule() {
Devang Pateleac9c072010-04-27 19:46:33 +0000816 if (DisableDebugInfoPrinting)
817 return;
818
Eric Christopherc4639d62012-11-19 22:42:15 +0000819 const Module *M = MMI->getModule();
820
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000821 // If module has named metadata anchors then use them, otherwise scan the
822 // module using debug info finder to collect debug info.
Devang Patel30692ab2011-05-03 16:45:22 +0000823 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
824 if (CU_Nodes) {
Eric Christopher7a0103c2013-02-07 21:19:50 +0000825 // Emit initial sections so we can reference labels later.
826 emitSectionLabels();
827
Devang Patel94c7ddb2011-08-16 22:09:43 +0000828 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
829 DICompileUnit CUNode(CU_Nodes->getOperand(i));
830 CompileUnit *CU = constructCompileUnit(CUNode);
831 DIArray GVs = CUNode.getGlobalVariables();
832 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
Devang Patel28bea082011-08-18 23:17:55 +0000833 CU->createGlobalVariableDIE(GVs.getElement(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000834 DIArray SPs = CUNode.getSubprograms();
835 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
836 constructSubprogramDIE(CU, SPs.getElement(i));
837 DIArray EnumTypes = CUNode.getEnumTypes();
838 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
839 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
840 DIArray RetainedTypes = CUNode.getRetainedTypes();
841 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
842 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
843 }
Devang Patel02e603f2011-08-15 23:47:24 +0000844 } else if (!collectLegacyDebugInfo(M))
845 return;
Devang Patel30692ab2011-05-03 16:45:22 +0000846
Devang Patel02e603f2011-08-15 23:47:24 +0000847 collectInfoFromNamedMDNodes(M);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000848
Chris Lattnerd850ac72010-04-05 02:19:28 +0000849 // Tell MMI that we have debug info.
850 MMI->setDebugInfoAvailability(true);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000851
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000852 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +0000853 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000854}
855
Eric Christopher4117bec2012-11-22 00:59:49 +0000856// Attach DW_AT_inline attribute with inlined subprogram DIEs.
857void DwarfDebug::computeInlinedDIEs() {
Devang Patel53bb5c92009-11-10 23:06:00 +0000858 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
859 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000860 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patel53bb5c92009-11-10 23:06:00 +0000861 DIE *ISP = *AI;
Devang Patel3cbee302011-04-12 22:53:02 +0000862 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +0000863 }
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000864 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000865 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000866 DIE *ISP = AI->second;
867 if (InlinedSubprogramDIEs.count(ISP))
868 continue;
869 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
870 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000871}
872
873// Collect info for variables that were optimized out.
874void DwarfDebug::collectDeadVariables() {
875 const Module *M = MMI->getModule();
876 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
877
878 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
879 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
880 DICompileUnit TheCU(CU_Nodes->getOperand(i));
881 DIArray Subprograms = TheCU.getSubprograms();
882 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000883 DISubprogram SP(Subprograms.getElement(i));
884 if (ProcessedSPNodes.count(SP) != 0) continue;
885 if (!SP.Verify()) continue;
886 if (!SP.isDefinition()) continue;
887 DIArray Variables = SP.getVariables();
888 if (Variables.getNumElements() == 0) continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000889
Eric Christopherbdab8002012-11-27 00:13:51 +0000890 LexicalScope *Scope =
891 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
892 DeadFnScopeMap[SP] = Scope;
Eric Christopher4117bec2012-11-22 00:59:49 +0000893
Eric Christopherbdab8002012-11-27 00:13:51 +0000894 // Construct subprogram DIE and add variables DIEs.
895 CompileUnit *SPCU = CUMap.lookup(TheCU);
896 assert(SPCU && "Unable to find Compile Unit!");
897 constructSubprogramDIE(SPCU, SP);
898 DIE *ScopeDIE = SPCU->getDIE(SP);
899 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
900 DIVariable DV(Variables.getElement(vi));
901 if (!DV.Verify()) continue;
902 DbgVariable *NewVar = new DbgVariable(DV, NULL);
903 if (DIE *VariableDIE =
904 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
905 ScopeDIE->addChild(VariableDIE);
906 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000907 }
908 }
909 }
910 DeleteContainerSeconds(DeadFnScopeMap);
911}
912
913void DwarfDebug::finalizeModuleInfo() {
914 // Collect info for variables that were optimized out.
915 collectDeadVariables();
916
917 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
918 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +0000919
Eric Christopher6635cad2012-08-01 18:19:01 +0000920 // Emit DW_AT_containing_type attribute to connect types with their
921 // vtable holding type.
Devang Pateldbc64af2011-08-15 17:24:54 +0000922 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000923 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Pateldbc64af2011-08-15 17:24:54 +0000924 CompileUnit *TheCU = CUI->second;
925 TheCU->constructContainingTypeDIEs();
Devang Patel5d11eb02009-12-03 19:11:07 +0000926 }
927
Eric Christopher4117bec2012-11-22 00:59:49 +0000928 // Compute DIE offsets and sizes.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000929 InfoHolder.computeSizeAndOffsets();
930 if (useSplitDwarf())
931 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher4117bec2012-11-22 00:59:49 +0000932}
933
934void DwarfDebug::endSections() {
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000935 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000936 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000937 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000938 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000939 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000940
941 // End text sections.
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +0000942 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
943 Asm->OutStreamer.SwitchSection(SectionMap[I]);
944 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000945 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000946}
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000947
Eric Christopherb6dc8652012-11-27 22:43:45 +0000948// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +0000949void DwarfDebug::endModule() {
950
951 if (!FirstCU) return;
952
953 // End any existing sections.
954 // TODO: Does this need to happen?
955 endSections();
956
957 // Finalize the debug info for the module.
958 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000959
Eric Christopher4daaed12012-12-10 19:51:21 +0000960 if (!useSplitDwarf()) {
Eric Christopher42885022012-11-27 22:43:42 +0000961 // Emit all the DIEs into a debug info section.
962 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +0000963
Eric Christopher42885022012-11-27 22:43:42 +0000964 // Corresponding abbreviations into a abbrev section.
965 emitAbbreviations();
966
967 // Emit info into a debug loc section.
968 emitDebugLoc();
969
970 // Emit info into a debug aranges section.
971 emitDebugARanges();
972
973 // Emit info into a debug ranges section.
974 emitDebugRanges();
975
976 // Emit info into a debug macinfo section.
977 emitDebugMacInfo();
978
979 // Emit inline info.
980 // TODO: When we don't need the option anymore we
981 // can remove all of the code that this section
982 // depends upon.
983 if (useDarwinGDBCompat())
984 emitDebugInlineInfo();
985 } else {
Eric Christopher0b944ee2012-12-11 19:42:09 +0000986 // TODO: Fill this in for separated debug sections and separate
Eric Christopher42885022012-11-27 22:43:42 +0000987 // out information into new sections.
988
Eric Christopher98e237f2012-11-30 23:59:06 +0000989 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +0000990 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +0000991 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +0000992
993 // Corresponding abbreviations into a abbrev section.
994 emitAbbreviations();
Eric Christopher6eebe472012-12-19 22:02:53 +0000995 emitDebugAbbrevDWO();
Eric Christopher42885022012-11-27 22:43:42 +0000996
997 // Emit info into a debug loc section.
998 emitDebugLoc();
999
1000 // Emit info into a debug aranges section.
1001 emitDebugARanges();
1002
1003 // Emit info into a debug ranges section.
1004 emitDebugRanges();
1005
1006 // Emit info into a debug macinfo section.
1007 emitDebugMacInfo();
1008
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001009 // Emit DWO addresses.
1010 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1011
Eric Christopher42885022012-11-27 22:43:42 +00001012 // Emit inline info.
1013 // TODO: When we don't need the option anymore we
1014 // can remove all of the code that this section
1015 // depends upon.
1016 if (useDarwinGDBCompat())
1017 emitDebugInlineInfo();
1018 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001019
Eric Christopher9d9f5a52012-08-23 07:32:06 +00001020 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001021 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +00001022 emitAccelNames();
1023 emitAccelObjC();
1024 emitAccelNamespaces();
1025 emitAccelTypes();
1026 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001027
Devang Patel193f7202009-11-24 01:14:22 +00001028 // Emit info into a debug pubtypes section.
Eric Christopher360f0062012-08-23 07:10:56 +00001029 // TODO: When we don't need the option anymore we can
1030 // remove all of the code that adds to the table.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001031 if (useDarwinGDBCompat())
Eric Christopher360f0062012-08-23 07:10:56 +00001032 emitDebugPubTypes();
Devang Patel193f7202009-11-24 01:14:22 +00001033
Eric Christopher42885022012-11-27 22:43:42 +00001034 // Finally emit string information into a string table.
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001035 emitDebugStr();
Eric Christopher64f824c2012-12-27 02:14:01 +00001036 if (useSplitDwarf())
1037 emitDebugStrDWO();
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001038
Devang Patele9a1cca2010-08-02 17:32:15 +00001039 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +00001040 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +00001041 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1042 E = CUMap.end(); I != E; ++I)
1043 delete I->second;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001044
Eric Christopher01776a52013-02-06 21:53:56 +00001045 for (SmallVector<CompileUnit *, 1>::iterator I = SkeletonCUs.begin(),
1046 E = SkeletonCUs.end(); I != E; ++I)
1047 delete *I;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001048
Eric Christopher98e237f2012-11-30 23:59:06 +00001049 // Reset these for the next Module if we have one.
1050 FirstCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001051}
1052
Eric Christopherb6dc8652012-11-27 22:43:45 +00001053// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +00001054DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +00001055 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +00001056 LLVMContext &Ctx = DV->getContext();
1057 // More then one inlined variable corresponds to one abstract variable.
1058 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +00001059 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001060 if (AbsDbgVariable)
1061 return AbsDbgVariable;
1062
Devang Patelbf47fdb2011-08-10 20:55:27 +00001063 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00001064 if (!Scope)
1065 return NULL;
1066
Devang Patel5a1a67c2011-08-15 19:01:20 +00001067 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001068 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001069 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001070 return AbsDbgVariable;
1071}
1072
Eric Christopherb6dc8652012-11-27 22:43:45 +00001073// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001074bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001075 DbgVariable *Var, LexicalScope *Scope) {
1076 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001077 return false;
1078 DIVariable DV = Var->getVariable();
1079 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1080 return false;
1081 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001082 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001083 return false;
1084
Devang Patelcb3a6572011-03-03 20:02:02 +00001085 size_t Size = CurrentFnArguments.size();
1086 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001087 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001088 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001089 // arguments does the function have at source level.
1090 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001091 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001092 CurrentFnArguments[ArgNo - 1] = Var;
1093 return true;
1094}
1095
Eric Christopherb6dc8652012-11-27 22:43:45 +00001096// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001097void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001098DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001099 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001100 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1101 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1102 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001103 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001104 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001105 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001106 DIVariable DV(Var);
1107 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001108
Devang Patelbf47fdb2011-08-10 20:55:27 +00001109 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001110
Devang Patelfb0ee432009-11-10 23:20:04 +00001111 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001112 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001113 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001114
Devang Patel26c1e562010-05-20 16:36:41 +00001115 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001116 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001117 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001118 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001119 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001120 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001121 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001122 }
Devang Patelee432862010-05-20 19:57:06 +00001123}
Devang Patel90a48ad2010-03-15 18:33:46 +00001124
Eric Christopherb6dc8652012-11-27 22:43:45 +00001125// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1126// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001127static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001128 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001129 return MI->getNumOperands() == 3 &&
1130 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1131 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patelc3f5f782010-05-25 23:40:22 +00001132}
1133
Eric Christopherb6dc8652012-11-27 22:43:45 +00001134// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001135static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1136 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001137 const MCSymbol *SLabel,
1138 const MachineInstr *MI) {
1139 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1140
1141 if (MI->getNumOperands() != 3) {
1142 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1143 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1144 }
1145 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1146 MachineLocation MLoc;
1147 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1148 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1149 }
1150 if (MI->getOperand(0).isImm())
1151 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1152 if (MI->getOperand(0).isFPImm())
1153 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1154 if (MI->getOperand(0).isCImm())
1155 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1156
Craig Topper5e25ee82012-02-05 08:31:47 +00001157 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001158}
1159
Eric Christopherb6dc8652012-11-27 22:43:45 +00001160// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001161void
Devang Patel78e127d2010-06-25 22:07:34 +00001162DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1163 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001164
Eric Christopherb6dc8652012-11-27 22:43:45 +00001165 // collection info from MMI table.
Devang Patelee432862010-05-20 19:57:06 +00001166 collectVariableInfoFromMMITable(MF, Processed);
1167
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001168 for (SmallVectorImpl<const MDNode*>::const_iterator
1169 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1170 ++UVI) {
1171 const MDNode *Var = *UVI;
1172 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001173 continue;
1174
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001175 // History contains relevant DBG_VALUE instructions for Var and instructions
1176 // clobbering it.
1177 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1178 if (History.empty())
1179 continue;
1180 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001181
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001182 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001183 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001184 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1185 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001186 Scope = LScopes.getCurrentFunctionScope();
Devang Patel40c7e412011-07-20 22:18:50 +00001187 else {
1188 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patelbf47fdb2011-08-10 20:55:27 +00001189 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel40c7e412011-07-20 22:18:50 +00001190 else {
1191 if (MDNode *IA = DV.getInlinedAt())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001192 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel40c7e412011-07-20 22:18:50 +00001193 else
Devang Patelbf47fdb2011-08-10 20:55:27 +00001194 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel40c7e412011-07-20 22:18:50 +00001195 }
1196 }
Devang Patelee432862010-05-20 19:57:06 +00001197 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001198 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001199 continue;
1200
1201 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001202 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001203 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1204 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel0478c152011-03-01 22:58:55 +00001205 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001206 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001207 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001208 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001209
Eric Christopherc56e3f02012-10-08 20:48:54 +00001210 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001211 if (History.size() <= 1 || (History.size() == 2 &&
1212 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001213 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001214 continue;
1215 }
1216
Eric Christopher498703b2013-01-28 17:33:26 +00001217 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001218 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001219
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001220 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1221 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1222 const MachineInstr *Begin = *HI;
1223 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001224
Devang Patel4ada1d72011-06-01 23:00:17 +00001225 // Check if DBG_VALUE is truncating a range.
1226 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1227 && !Begin->getOperand(0).getReg())
1228 continue;
1229
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001230 // Compute the range for a register location.
1231 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1232 const MCSymbol *SLabel = 0;
1233
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001234 if (HI + 1 == HE)
1235 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001236 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001237 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001238 else {
1239 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001240 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001241 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001242 if (End->isDebugValue())
1243 SLabel = getLabelBeforeInsn(End);
1244 else {
1245 // End is a normal instruction clobbering the range.
1246 SLabel = getLabelAfterInsn(End);
1247 assert(SLabel && "Forgot label after clobber instruction");
1248 ++HI;
1249 }
1250 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001251
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001252 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001253 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1254 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001255 }
1256 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001257 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001258
1259 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001260 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1261 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1262 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1263 DIVariable DV(Variables.getElement(i));
1264 if (!DV || !DV.Verify() || !Processed.insert(DV))
1265 continue;
1266 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1267 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel98e1cac2010-05-14 21:01:35 +00001268 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001269}
Devang Patel98e1cac2010-05-14 21:01:35 +00001270
Eric Christopherb6dc8652012-11-27 22:43:45 +00001271// Return Label preceding the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001272MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001273 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1274 assert(Label && "Didn't insert label before instruction");
1275 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001276}
1277
Eric Christopherb6dc8652012-11-27 22:43:45 +00001278// Return Label immediately following the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001279MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001280 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001281}
1282
Eric Christopherb6dc8652012-11-27 22:43:45 +00001283// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001284void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001285 // Check if source location changes, but ignore DBG_VALUE locations.
1286 if (!MI->isDebugValue()) {
1287 DebugLoc DL = MI->getDebugLoc();
1288 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001289 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001290 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001291 if (DL == PrologEndLoc) {
1292 Flags |= DWARF2_FLAG_PROLOGUE_END;
1293 PrologEndLoc = DebugLoc();
1294 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001295 if (PrologEndLoc.isUnknown())
1296 Flags |= DWARF2_FLAG_IS_STMT;
1297
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001298 if (!DL.isUnknown()) {
1299 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001300 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001301 } else
Devang Patel4243e672011-05-11 19:22:19 +00001302 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001303 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001304 }
Devang Patelaead63c2010-03-29 22:59:58 +00001305
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001306 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001307 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1308 LabelsBeforeInsn.find(MI);
1309
1310 // No label needed.
1311 if (I == LabelsBeforeInsn.end())
1312 return;
1313
1314 // Label already assigned.
1315 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001316 return;
Devang Patel553881b2010-03-29 17:20:31 +00001317
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001318 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001319 PrevLabel = MMI->getContext().CreateTempSymbol();
1320 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001321 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001322 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001323}
1324
Eric Christopherb6dc8652012-11-27 22:43:45 +00001325// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001326void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001327 // Don't create a new label after DBG_VALUE instructions.
1328 // They don't generate code.
1329 if (!MI->isDebugValue())
1330 PrevLabel = 0;
1331
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001332 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1333 LabelsAfterInsn.find(MI);
1334
1335 // No label needed.
1336 if (I == LabelsAfterInsn.end())
1337 return;
1338
1339 // Label already assigned.
1340 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001341 return;
1342
1343 // We need a label after this instruction.
1344 if (!PrevLabel) {
1345 PrevLabel = MMI->getContext().CreateTempSymbol();
1346 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001347 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001348 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001349}
1350
Eric Christopherb6dc8652012-11-27 22:43:45 +00001351// Each LexicalScope has first instruction and last instruction to mark
1352// beginning and end of a scope respectively. Create an inverse map that list
1353// scopes starts (and ends) with an instruction. One instruction may start (or
1354// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001355void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001356 SmallVector<LexicalScope *, 4> WorkList;
1357 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001358 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001359 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001360
Devang Patelbf47fdb2011-08-10 20:55:27 +00001361 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001362 if (!Children.empty())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001363 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001364 SE = Children.end(); SI != SE; ++SI)
1365 WorkList.push_back(*SI);
1366
Devang Patel53bb5c92009-11-10 23:06:00 +00001367 if (S->isAbstractScope())
1368 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001369
Devang Patelbf47fdb2011-08-10 20:55:27 +00001370 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001371 if (Ranges.empty())
1372 continue;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001373 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001374 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001375 assert(RI->first && "InsnRange does not have first instruction!");
1376 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001377 requestLabelBeforeInsn(RI->first);
1378 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001379 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001380 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001381}
1382
Eric Christopherb6dc8652012-11-27 22:43:45 +00001383// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001384static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1385 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1386 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1387 return DL.getScope(Ctx);
1388}
1389
Eric Christopherb6dc8652012-11-27 22:43:45 +00001390// Walk up the scope chain of given debug loc and find line number info
1391// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001392static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1393 const MDNode *Scope = getScopeNode(DL, Ctx);
1394 DISubprogram SP = getDISubprogram(Scope);
Eric Christopher6126a1e2012-04-03 00:43:49 +00001395 if (SP.Verify()) {
1396 // Check for number of operands since the compatibility is
1397 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001398 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001399 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1400 else
1401 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1402 }
1403
Devang Patel4243e672011-05-11 19:22:19 +00001404 return DebugLoc();
1405}
1406
Eric Christopherb6dc8652012-11-27 22:43:45 +00001407// Gather pre-function debug information. Assumes being called immediately
1408// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001409void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001410 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001411 LScopes.initialize(*MF);
1412 if (LScopes.empty()) return;
1413 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001414
Manman Ren43213cf2013-02-05 21:52:47 +00001415 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1416 // belongs to.
1417 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1418 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1419 assert(TheCU && "Unable to find compile unit!");
1420 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1421
Devang Pateleac9c072010-04-27 19:46:33 +00001422 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1423 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001424 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001425 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001426
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001427 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1428
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001429 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001430 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001431 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1432
Devang Patelb2b31a62010-05-26 19:37:24 +00001433 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001434 I != E; ++I) {
1435 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001436 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1437 II != IE; ++II) {
1438 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001439
Devang Patelb2b31a62010-05-26 19:37:24 +00001440 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001441 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001442
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001443 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001444 const MDNode *Var =
1445 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001446
1447 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001448 if (isDbgValueInDefinedReg(MI))
1449 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1450
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001451 // Check the history of this variable.
1452 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1453 if (History.empty()) {
1454 UserVariables.push_back(Var);
1455 // The first mention of a function argument gets the FunctionBeginSym
1456 // label, so arguments are visible when breaking at function entry.
1457 DIVariable DV(Var);
1458 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1459 DISubprogram(getDISubprogram(DV.getContext()))
1460 .describes(MF->getFunction()))
1461 LabelsBeforeInsn[MI] = FunctionBeginSym;
1462 } else {
1463 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1464 const MachineInstr *Prev = History.back();
1465 if (Prev->isDebugValue()) {
1466 // Coalesce identical entries at the end of History.
1467 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001468 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001469 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001470 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001471 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001472 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001473 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001474
1475 // Terminate old register assignments that don't reach MI;
1476 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1477 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1478 isDbgValueInDefinedReg(Prev)) {
1479 // Previous register assignment needs to terminate at the end of
1480 // its basic block.
1481 MachineBasicBlock::const_iterator LastMI =
1482 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001483 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001484 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001485 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001486 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001487 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001488 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001489 else {
1490 // Terminate after LastMI.
1491 History.push_back(LastMI);
1492 }
1493 }
1494 }
1495 }
1496 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001497 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001498 // Not a DBG_VALUE instruction.
1499 if (!MI->isLabel())
1500 AtBlockEntry = false;
1501
Eric Christopher0313ced2012-10-04 20:46:14 +00001502 // First known non-DBG_VALUE and non-frame setup location marks
1503 // the beginning of the function body.
1504 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1505 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001506 PrologEndLoc = MI->getDebugLoc();
1507
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001508 // Check if the instruction clobbers any registers with debug vars.
1509 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1510 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1511 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1512 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001513 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1514 AI.isValid(); ++AI) {
1515 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001516 const MDNode *Var = LiveUserVar[Reg];
1517 if (!Var)
1518 continue;
1519 // Reg is now clobbered.
1520 LiveUserVar[Reg] = 0;
1521
1522 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001523 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1524 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001525 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001526 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1527 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001528 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001529 const MachineInstr *Prev = History.back();
1530 // Sanity-check: Register assignments are terminated at the end of
1531 // their block.
1532 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1533 continue;
1534 // Is the variable still in Reg?
1535 if (!isDbgValueInDefinedReg(Prev) ||
1536 Prev->getOperand(0).getReg() != Reg)
1537 continue;
1538 // Var is clobbered. Make sure the next instruction gets a label.
1539 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001540 }
1541 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001542 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001543 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001544 }
1545
1546 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1547 I != E; ++I) {
1548 SmallVectorImpl<const MachineInstr*> &History = I->second;
1549 if (History.empty())
1550 continue;
1551
1552 // Make sure the final register assignments are terminated.
1553 const MachineInstr *Prev = History.back();
1554 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1555 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001556 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001557 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001558 if (LastMI == PrevMBB->end())
1559 // Drop DBG_VALUE for empty range.
1560 History.pop_back();
1561 else {
1562 // Terminate after LastMI.
1563 History.push_back(LastMI);
1564 }
1565 }
1566 // Request labels for the full history.
1567 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1568 const MachineInstr *MI = History[i];
1569 if (MI->isDebugValue())
1570 requestLabelBeforeInsn(MI);
1571 else
1572 requestLabelAfterInsn(MI);
1573 }
1574 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001575
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001576 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001577 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001578
1579 // Record beginning of function.
1580 if (!PrologEndLoc.isUnknown()) {
1581 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1582 MF->getFunction()->getContext());
1583 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1584 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie836cfc42012-12-04 22:02:33 +00001585 // We'd like to list the prologue as "not statements" but GDB behaves
1586 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikieb36c5312012-12-04 21:05:36 +00001587 DWARF2_FLAG_IS_STMT);
Devang Patel4243e672011-05-11 19:22:19 +00001588 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001589}
1590
Devang Patelbf47fdb2011-08-10 20:55:27 +00001591void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1592// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1593 ScopeVariables[LS].push_back(Var);
1594// Vars.push_back(Var);
1595}
1596
Eric Christopherb6dc8652012-11-27 22:43:45 +00001597// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001598void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001599 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001600
Devang Patelbf47fdb2011-08-10 20:55:27 +00001601 // Define end label for subprogram.
1602 FunctionEndSym = Asm->GetTempSymbol("func_end",
1603 Asm->getFunctionNumber());
1604 // Assumes in correct section after the entry point.
1605 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren43213cf2013-02-05 21:52:47 +00001606 // Set DwarfCompileUnitID in MCContext to default value.
1607 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001608
Devang Patelbf47fdb2011-08-10 20:55:27 +00001609 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1610 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001611
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001612 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001613 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001614 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001615
Devang Patelbf47fdb2011-08-10 20:55:27 +00001616 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001617 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1618 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1619 LexicalScope *AScope = AList[i];
1620 DISubprogram SP(AScope->getScopeNode());
Devang Patelbf47fdb2011-08-10 20:55:27 +00001621 if (SP.Verify()) {
1622 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001623 DIArray Variables = SP.getVariables();
1624 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1625 DIVariable DV(Variables.getElement(i));
1626 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1627 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001628 // Check that DbgVariable for DV wasn't created earlier, when
1629 // findAbstractVariable() was called for inlined instance of DV.
1630 LLVMContext &Ctx = DV->getContext();
1631 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1632 if (AbstractVariables.lookup(CleanDV))
1633 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001634 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1635 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel78e127d2010-06-25 22:07:34 +00001636 }
1637 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001638 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001639 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001640 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001641
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001642 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001643
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001644 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001645 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001646
Devang Patelbf47fdb2011-08-10 20:55:27 +00001647 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1648 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001649
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001650 // Clear debug info
Devang Patelbf47fdb2011-08-10 20:55:27 +00001651 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1652 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1653 DeleteContainerPointers(I->second);
1654 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001655 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001656 UserVariables.clear();
1657 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001658 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001659 LabelsBeforeInsn.clear();
1660 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001661 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001662}
1663
Eric Christopherb6dc8652012-11-27 22:43:45 +00001664// Register a source line with debug info. Returns the unique label that was
1665// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001666void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1667 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001668 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001669 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001670 unsigned Src = 1;
1671 if (S) {
1672 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001673
Dan Gohman1cc0d622010-05-05 23:41:32 +00001674 if (Scope.isCompileUnit()) {
1675 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001676 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001677 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001678 } else if (Scope.isFile()) {
1679 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001680 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001681 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001682 } else if (Scope.isSubprogram()) {
1683 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001684 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001685 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001686 } else if (Scope.isLexicalBlockFile()) {
1687 DILexicalBlockFile DBF(S);
1688 Fn = DBF.getFilename();
1689 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001690 } else if (Scope.isLexicalBlock()) {
1691 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001692 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001693 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001694 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001695 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001696
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001697 Src = getOrCreateSourceID(Fn, Dir);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001698 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001699 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001700}
1701
Bill Wendling829e67b2009-05-20 23:22:40 +00001702//===----------------------------------------------------------------------===//
1703// Emit Methods
1704//===----------------------------------------------------------------------===//
1705
Eric Christopherb6dc8652012-11-27 22:43:45 +00001706// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001707unsigned
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001708DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001709 // Get the children.
1710 const std::vector<DIE *> &Children = Die->getChildren();
1711
Bill Wendling94d04b82009-05-20 23:21:38 +00001712 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001713 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001714
1715 // Get the abbreviation for this DIE.
1716 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001717 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001718
1719 // Set DIE offset
1720 Die->setOffset(Offset);
1721
1722 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001723 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001724
1725 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1726 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1727
1728 // Size the DIE attribute values.
1729 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1730 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001731 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001732
1733 // Size the DIE children if any.
1734 if (!Children.empty()) {
1735 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1736 "Children flag not set");
1737
1738 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001739 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001740
1741 // End of children marker.
1742 Offset += sizeof(int8_t);
1743 }
1744
1745 Die->setSize(Offset - Die->getOffset());
1746 return Offset;
1747}
1748
Eric Christopherb6dc8652012-11-27 22:43:45 +00001749// Compute the size and offset of all the DIEs.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001750void DwarfUnits::computeSizeAndOffsets() {
1751 for (SmallVector<CompileUnit *, 1>::iterator I = CUs.begin(),
1752 E = CUs.end(); I != E; ++I) {
Eric Christopher98e237f2012-11-30 23:59:06 +00001753 unsigned Offset =
1754 sizeof(int32_t) + // Length of Compilation Unit Info
1755 sizeof(int16_t) + // DWARF version number
1756 sizeof(int32_t) + // Offset Into Abbrev. Section
1757 sizeof(int8_t); // Pointer Size (in bytes)
1758
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001759 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel163a9f72010-05-10 22:49:55 +00001760 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001761}
1762
Eric Christopherb6dc8652012-11-27 22:43:45 +00001763// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001764void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001765 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001766
Bill Wendling94d04b82009-05-20 23:21:38 +00001767 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001768 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001769 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001770 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001771 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher6eebe472012-12-19 22:02:53 +00001772 if (useSplitDwarf())
1773 DwarfAbbrevDWOSectionSym =
1774 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1775 "section_abbrev_dwo");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001776 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001777
Chris Lattner9c69e285532010-04-04 22:59:04 +00001778 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001779 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001780
Eric Christopher7a0103c2013-02-07 21:19:50 +00001781 DwarfLineSectionSym =
1782 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001783 emitSectionSym(Asm, TLOF.getDwarfLocSection());
1784 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001785 DwarfStrSectionSym =
Eric Christopher64f824c2012-12-27 02:14:01 +00001786 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
1787 if (useSplitDwarf())
1788 DwarfStrDWOSectionSym =
1789 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001790 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00001791 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00001792
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001793 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00001794 "section_debug_loc");
1795
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001796 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1797 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001798}
1799
Eric Christopherb6dc8652012-11-27 22:43:45 +00001800// Recursively emits a debug information entry.
Eric Christopher6eebe472012-12-19 22:02:53 +00001801void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001802 // Get the abbreviation for this DIE.
1803 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher6eebe472012-12-19 22:02:53 +00001804 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001805
Bill Wendling94d04b82009-05-20 23:21:38 +00001806 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00001807 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00001808 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1809 Twine::utohexstr(Die->getOffset()) + ":0x" +
1810 Twine::utohexstr(Die->getSize()) + " " +
1811 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001812 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001813
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00001814 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00001815 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1816
1817 // Emit the DIE attribute values.
1818 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1819 unsigned Attr = AbbrevData[i].getAttribute();
1820 unsigned Form = AbbrevData[i].getForm();
1821 assert(Form && "Too many attributes for DIE (check abbreviation)");
1822
Chris Lattner3f53c832010-04-04 18:52:31 +00001823 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00001824 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001825
Bill Wendling94d04b82009-05-20 23:21:38 +00001826 switch (Attr) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001827 case dwarf::DW_AT_abstract_origin: {
1828 DIEEntry *E = cast<DIEEntry>(Values[i]);
1829 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00001830 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00001831 Asm->EmitInt32(Addr);
1832 break;
1833 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001834 case dwarf::DW_AT_ranges: {
1835 // DW_AT_range Value encodes offset in debug_range section.
1836 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001837
Nick Lewyckyffccd922012-06-22 01:25:12 +00001838 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001839 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1840 V->getValue(),
1841 4);
1842 } else {
1843 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1844 V->getValue(),
1845 DwarfDebugRangeSectionSym,
1846 4);
1847 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001848 break;
1849 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001850 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00001851 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1852 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1853 Asm->EmitLabelReference(L->getValue(), 4);
1854 else
1855 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1856 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00001857 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00001858 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001859 break;
1860 }
Devang Patel2a361602010-09-29 19:08:08 +00001861 case dwarf::DW_AT_accessibility: {
1862 if (Asm->isVerbose()) {
1863 DIEInteger *V = cast<DIEInteger>(Values[i]);
1864 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1865 }
1866 Values[i]->EmitValue(Asm, Form);
1867 break;
1868 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001869 default:
1870 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001871 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00001872 break;
1873 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001874 }
1875
1876 // Emit the DIE children if any.
1877 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1878 const std::vector<DIE *> &Children = Die->getChildren();
1879
1880 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher6eebe472012-12-19 22:02:53 +00001881 emitDIE(Children[j], Abbrevs);
Bill Wendling94d04b82009-05-20 23:21:38 +00001882
Chris Lattner3f53c832010-04-04 18:52:31 +00001883 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00001884 Asm->OutStreamer.AddComment("End Of Children Mark");
1885 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00001886 }
1887}
1888
Eric Christopherb1e66d02012-12-15 00:04:07 +00001889// Emit the various dwarf units to the unit section USection with
1890// the abbreviations going into ASection.
1891void DwarfUnits::emitUnits(DwarfDebug *DD,
1892 const MCSection *USection,
1893 const MCSection *ASection,
1894 const MCSymbol *ASectionSym) {
1895 Asm->OutStreamer.SwitchSection(USection);
1896 for (SmallVector<CompileUnit *, 1>::iterator I = CUs.begin(),
1897 E = CUs.end(); I != E; ++I) {
1898 CompileUnit *TheCU = *I;
Devang Patel163a9f72010-05-10 22:49:55 +00001899 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001900
Devang Patel163a9f72010-05-10 22:49:55 +00001901 // Emit the compile units header.
Eric Christopherb1e66d02012-12-15 00:04:07 +00001902 Asm->OutStreamer
1903 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
1904 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001905
Devang Patel163a9f72010-05-10 22:49:55 +00001906 // Emit size of content not including length itself
1907 unsigned ContentSize = Die->getSize() +
1908 sizeof(int16_t) + // DWARF version number
1909 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00001910 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00001911
Devang Patel163a9f72010-05-10 22:49:55 +00001912 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1913 Asm->EmitInt32(ContentSize);
1914 Asm->OutStreamer.AddComment("DWARF version number");
1915 Asm->EmitInt16(dwarf::DWARF_VERSION);
1916 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christopherb1e66d02012-12-15 00:04:07 +00001917 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
1918 ASectionSym);
Devang Patel163a9f72010-05-10 22:49:55 +00001919 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001920 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001921
Eric Christopher6eebe472012-12-19 22:02:53 +00001922 DD->emitDIE(Die, Abbreviations);
Eric Christopherb1e66d02012-12-15 00:04:07 +00001923 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00001924 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00001925 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001926}
1927
Eric Christopher98e237f2012-11-30 23:59:06 +00001928// Emit the debug info section.
1929void DwarfDebug::emitDebugInfo() {
Eric Christopherb1e66d02012-12-15 00:04:07 +00001930 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1931
1932 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
1933 Asm->getObjFileLowering().getDwarfAbbrevSection(),
1934 DwarfAbbrevSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00001935}
1936
Eric Christopherb6dc8652012-11-27 22:43:45 +00001937// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00001938void DwarfDebug::emitAbbreviations() {
Eric Christopher6eebe472012-12-19 22:02:53 +00001939 if (!useSplitDwarf())
1940 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
1941 &Abbreviations);
1942 else
1943 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
1944}
Bill Wendling94d04b82009-05-20 23:21:38 +00001945
Eric Christopher6eebe472012-12-19 22:02:53 +00001946void DwarfDebug::emitAbbrevs(const MCSection *Section,
1947 std::vector<DIEAbbrev *> *Abbrevs) {
1948 // Check to see if it is worth the effort.
1949 if (!Abbrevs->empty()) {
1950 // Start the debug abbrev section.
1951 Asm->OutStreamer.SwitchSection(Section);
1952
1953 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher44fedba2012-12-13 03:00:38 +00001954 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling94d04b82009-05-20 23:21:38 +00001955
1956 // For each abbrevation.
Eric Christopher6eebe472012-12-19 22:02:53 +00001957 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001958 // Get abbreviation data
Eric Christopher6eebe472012-12-19 22:02:53 +00001959 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling94d04b82009-05-20 23:21:38 +00001960
1961 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001962 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00001963
1964 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001965 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00001966 }
1967
1968 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001969 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00001970
Eric Christopher6eebe472012-12-19 22:02:53 +00001971 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher44fedba2012-12-13 03:00:38 +00001972 Asm->OutStreamer.EmitLabel(End);
Bill Wendling94d04b82009-05-20 23:21:38 +00001973 }
1974}
1975
Eric Christopherb6dc8652012-11-27 22:43:45 +00001976// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001977void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001978 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00001979 Asm->OutStreamer.AddComment("Extended Op");
1980 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001981
Chris Lattner233f52b2010-03-09 23:52:58 +00001982 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001983 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00001984 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1985 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1986
1987 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00001988
Chris Lattnerc0215722010-04-04 19:25:43 +00001989 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherca1dd052013-01-09 01:35:34 +00001990 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00001991
1992 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00001993 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1994 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00001995 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00001996 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001997}
1998
Eric Christopherb6dc8652012-11-27 22:43:45 +00001999// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002000void DwarfDebug::emitAccelNames() {
2001 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2002 dwarf::DW_FORM_data4));
2003 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2004 E = CUMap.end(); I != E; ++I) {
2005 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002006 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2007 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002008 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2009 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002010 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002011 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2012 DE = Entities.end(); DI != DE; ++DI)
2013 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002014 }
2015 }
2016
2017 AT.FinalizeTable(Asm, "Names");
2018 Asm->OutStreamer.SwitchSection(
2019 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2020 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2021 Asm->OutStreamer.EmitLabel(SectionBegin);
2022
2023 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002024 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002025}
2026
Eric Christopher72c16552012-12-20 21:58:40 +00002027// Emit objective C classes and categories into a hashed accelerator table
2028// section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002029void DwarfDebug::emitAccelObjC() {
2030 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2031 dwarf::DW_FORM_data4));
2032 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2033 E = CUMap.end(); I != E; ++I) {
2034 CompileUnit *TheCU = I->second;
2035 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2036 for (StringMap<std::vector<DIE*> >::const_iterator
2037 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2038 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002039 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00002040 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2041 DE = Entities.end(); DI != DE; ++DI)
2042 AT.AddName(Name, (*DI));
2043 }
2044 }
2045
2046 AT.FinalizeTable(Asm, "ObjC");
2047 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2048 .getDwarfAccelObjCSection());
2049 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2050 Asm->OutStreamer.EmitLabel(SectionBegin);
2051
2052 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002053 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002054}
2055
Eric Christopherb6dc8652012-11-27 22:43:45 +00002056// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002057void DwarfDebug::emitAccelNamespaces() {
2058 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2059 dwarf::DW_FORM_data4));
2060 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2061 E = CUMap.end(); I != E; ++I) {
2062 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002063 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2064 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002065 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2066 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002067 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002068 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2069 DE = Entities.end(); DI != DE; ++DI)
2070 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002071 }
2072 }
2073
2074 AT.FinalizeTable(Asm, "namespac");
2075 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2076 .getDwarfAccelNamespaceSection());
2077 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2078 Asm->OutStreamer.EmitLabel(SectionBegin);
2079
2080 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002081 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002082}
2083
Eric Christopherb6dc8652012-11-27 22:43:45 +00002084// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002085void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00002086 std::vector<DwarfAccelTable::Atom> Atoms;
2087 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2088 dwarf::DW_FORM_data4));
2089 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
2090 dwarf::DW_FORM_data2));
2091 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2092 dwarf::DW_FORM_data1));
2093 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002094 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2095 E = CUMap.end(); I != E; ++I) {
2096 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002097 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2098 = TheCU->getAccelTypes();
2099 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002100 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2101 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002102 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002103 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2104 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2105 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002106 }
2107 }
2108
2109 AT.FinalizeTable(Asm, "types");
2110 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2111 .getDwarfAccelTypesSection());
2112 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2113 Asm->OutStreamer.EmitLabel(SectionBegin);
2114
2115 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002116 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002117}
2118
Devang Patel193f7202009-11-24 01:14:22 +00002119void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00002120 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2121 E = CUMap.end(); I != E; ++I) {
2122 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002123 // Start the dwarf pubtypes section.
Devang Patel163a9f72010-05-10 22:49:55 +00002124 Asm->OutStreamer.SwitchSection(
2125 Asm->getObjFileLowering().getDwarfPubTypesSection());
2126 Asm->OutStreamer.AddComment("Length of Public Types Info");
2127 Asm->EmitLabelDifference(
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002128 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2129 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002130
Devang Patel163a9f72010-05-10 22:49:55 +00002131 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002132 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002133
Devang Patel163a9f72010-05-10 22:49:55 +00002134 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2135 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002136
Devang Patel163a9f72010-05-10 22:49:55 +00002137 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002138 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2139 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002140 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002141 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002142
Devang Patel163a9f72010-05-10 22:49:55 +00002143 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002144 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002145 TheCU->getUniqueID()),
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002146 Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002147 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002148 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002149
Devang Patel163a9f72010-05-10 22:49:55 +00002150 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2151 for (StringMap<DIE*>::const_iterator
2152 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2153 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002154 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002155
Devang Patel163a9f72010-05-10 22:49:55 +00002156 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2157 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002158
Devang Patel163a9f72010-05-10 22:49:55 +00002159 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer983c4572011-11-09 18:16:11 +00002160 // Emit the name with a terminating null byte.
Eric Christopher68ca5622013-01-09 01:57:54 +00002161 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Devang Patel163a9f72010-05-10 22:49:55 +00002162 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002163
Devang Patel163a9f72010-05-10 22:49:55 +00002164 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002165 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00002166 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002167 TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002168 }
Devang Patel193f7202009-11-24 01:14:22 +00002169}
2170
Eric Christopher64f824c2012-12-27 02:14:01 +00002171// Emit strings into a string section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002172void DwarfUnits::emitStrings(const MCSection *StrSection,
2173 const MCSection *OffsetSection = NULL,
2174 const MCSymbol *StrSecSym = NULL) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002175
Eric Christopherb6714222013-01-08 22:22:06 +00002176 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002177
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002178 // Start the dwarf str section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002179 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling94d04b82009-05-20 23:21:38 +00002180
Chris Lattnerbc733f52010-03-13 02:17:42 +00002181 // Get all of the string pool entries and put them in an array by their ID so
2182 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002183 SmallVector<std::pair<unsigned,
Eric Christopherff348452013-01-07 22:40:45 +00002184 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002185
Chris Lattnerbc733f52010-03-13 02:17:42 +00002186 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopherb6714222013-01-08 22:22:06 +00002187 I = StringPool.begin(), E = StringPool.end();
Eric Christopher72c16552012-12-20 21:58:40 +00002188 I != E; ++I)
Chris Lattnerbc733f52010-03-13 02:17:42 +00002189 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002190
Chris Lattnerbc733f52010-03-13 02:17:42 +00002191 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002192
Chris Lattnerbc733f52010-03-13 02:17:42 +00002193 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002194 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002195 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002196
Benjamin Kramer983c4572011-11-09 18:16:11 +00002197 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002198 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherca1dd052013-01-09 01:35:34 +00002199 Entries[i].second->getKeyLength()+1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002200 }
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002201
2202 // If we've got an offset section go ahead and emit that now as well.
2203 if (OffsetSection) {
2204 Asm->OutStreamer.SwitchSection(OffsetSection);
2205 unsigned offset = 0;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002206 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002207 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopher1ced2082013-01-09 03:52:05 +00002208 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002209 offset += Entries[i].second->getKeyLength() + 1;
2210 }
2211 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002212}
2213
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002214// Emit strings into a string section.
2215void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2216
2217 if (AddressPool.empty()) return;
2218
2219 // Start the dwarf addr section.
2220 Asm->OutStreamer.SwitchSection(AddrSection);
2221
2222 // Get all of the string pool entries and put them in an array by their ID so
2223 // we can sort them.
2224 SmallVector<std::pair<unsigned,
2225 std::pair<MCSymbol*, unsigned>* >, 64> Entries;
2226
2227 for (DenseMap<MCSymbol*, std::pair<MCSymbol*, unsigned> >::iterator
2228 I = AddressPool.begin(), E = AddressPool.end();
2229 I != E; ++I)
2230 Entries.push_back(std::make_pair(I->second.second, &(I->second)));
2231
2232 array_pod_sort(Entries.begin(), Entries.end());
2233
2234 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2235 // Emit a label for reference from debug information entries.
2236 MCSymbol *Sym = Entries[i].second->first;
2237 if (Sym)
2238 Asm->EmitLabelReference(Entries[i].second->first,
2239 Asm->getDataLayout().getPointerSize());
2240 else
2241 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2242 }
2243
2244}
2245
Eric Christopher64f824c2012-12-27 02:14:01 +00002246// Emit visible names into a debug str section.
2247void DwarfDebug::emitDebugStr() {
2248 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2249 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2250}
2251
Eric Christopherb6dc8652012-11-27 22:43:45 +00002252// Emit visible names into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002253void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002254 if (DotDebugLocEntries.empty())
2255 return;
2256
Devang Patel6c3ea902011-02-04 22:57:18 +00002257 for (SmallVector<DotDebugLocEntry, 4>::iterator
2258 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2259 I != E; ++I) {
2260 DotDebugLocEntry &Entry = *I;
2261 if (I + 1 != DotDebugLocEntries.end())
2262 Entry.Merge(I+1);
2263 }
2264
Daniel Dunbar83320a02011-03-16 22:16:39 +00002265 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002266 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002267 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002268 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002269 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2270 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002271 for (SmallVector<DotDebugLocEntry, 4>::iterator
2272 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002273 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002274 DotDebugLocEntry &Entry = *I;
2275 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002276 if (Entry.isEmpty()) {
Eric Christopherca1dd052013-01-09 01:35:34 +00002277 Asm->OutStreamer.EmitIntValue(0, Size);
2278 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel80250682010-05-26 23:55:23 +00002279 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002280 } else {
Eric Christopher1ced2082013-01-09 03:52:05 +00002281 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size);
2282 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size);
Devang Patelc26f5442011-04-28 02:22:40 +00002283 DIVariable DV(Entry.Variable);
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002284 Asm->OutStreamer.AddComment("Loc expr size");
2285 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2286 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2287 Asm->EmitLabelDifference(end, begin, 2);
2288 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002289 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002290 DIBasicType BTy(DV.getType());
2291 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002292 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002293 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2294 Asm->OutStreamer.AddComment("DW_OP_consts");
2295 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002296 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002297 } else {
2298 Asm->OutStreamer.AddComment("DW_OP_constu");
2299 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002300 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002301 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002302 } else if (Entry.isLocation()) {
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002303 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002304 // Regular entry.
Devang Patelc26f5442011-04-28 02:22:40 +00002305 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Patel80efd4e2011-07-08 16:49:43 +00002306 else {
2307 // Complex address entry.
2308 unsigned N = DV.getNumAddrElements();
2309 unsigned i = 0;
2310 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2311 if (Entry.Loc.getOffset()) {
2312 i = 2;
2313 Asm->EmitDwarfRegOp(Entry.Loc);
2314 Asm->OutStreamer.AddComment("DW_OP_deref");
2315 Asm->EmitInt8(dwarf::DW_OP_deref);
2316 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2317 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2318 Asm->EmitSLEB128(DV.getAddrElement(1));
2319 } else {
2320 // If first address element is OpPlus then emit
2321 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2322 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2323 Asm->EmitDwarfRegOp(Loc);
2324 i = 2;
2325 }
2326 } else {
2327 Asm->EmitDwarfRegOp(Entry.Loc);
2328 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002329
Devang Patel80efd4e2011-07-08 16:49:43 +00002330 // Emit remaining complex address elements.
2331 for (; i < N; ++i) {
2332 uint64_t Element = DV.getAddrElement(i);
2333 if (Element == DIBuilder::OpPlus) {
2334 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2335 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002336 } else if (Element == DIBuilder::OpDeref) {
Eric Christophera80f2d12012-05-08 21:24:39 +00002337 if (!Entry.Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002338 Asm->EmitInt8(dwarf::DW_OP_deref);
2339 } else
2340 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002341 }
Devang Patelc26f5442011-04-28 02:22:40 +00002342 }
Devang Patelc26f5442011-04-28 02:22:40 +00002343 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002344 // else ... ignore constant fp. There is not any good way to
2345 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002346 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002347 }
2348 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002349}
2350
Eric Christopherb6dc8652012-11-27 22:43:45 +00002351// Emit visible names into a debug aranges section.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002352void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002353 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002354 Asm->OutStreamer.SwitchSection(
2355 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002356}
2357
Eric Christopherb6dc8652012-11-27 22:43:45 +00002358// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002359void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002360 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002361 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00002362 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002363 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Pateleac9c072010-04-27 19:46:33 +00002364 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002365 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002366 I != E; ++I) {
2367 if (*I)
Eric Christopher1ced2082013-01-09 03:52:05 +00002368 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002369 else
Eric Christopherca1dd052013-01-09 01:35:34 +00002370 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002371 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002372}
2373
Eric Christopherb6dc8652012-11-27 22:43:45 +00002374// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002375void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002376 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002377 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002378 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002379 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002380 }
2381}
2382
Eric Christopherb6dc8652012-11-27 22:43:45 +00002383// Emit inline info using following format.
2384// Section Header:
2385// 1. length of section
2386// 2. Dwarf version number
2387// 3. address size.
2388//
2389// Entries (one "entry" for each function that was inlined):
2390//
2391// 1. offset into __debug_str section for MIPS linkage name, if exists;
2392// otherwise offset into __debug_str for regular function name.
2393// 2. offset into __debug_str section for regular function name.
2394// 3. an unsigned LEB128 number indicating the number of distinct inlining
2395// instances for the function.
2396//
2397// The rest of the entry consists of a {die_offset, low_pc} pair for each
2398// inlined instance; the die_offset points to the inlined_subroutine die in the
2399// __debug_info section, and the low_pc is the starting address for the
2400// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002401void DwarfDebug::emitDebugInlineInfo() {
Eric Christopherb83e2bb2012-03-02 02:11:47 +00002402 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002403 return;
2404
Devang Patel163a9f72010-05-10 22:49:55 +00002405 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002406 return;
2407
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002408 Asm->OutStreamer.SwitchSection(
2409 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00002410
Chris Lattner233f52b2010-03-09 23:52:58 +00002411 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00002412 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2413 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00002414
Chris Lattnerc0215722010-04-04 19:25:43 +00002415 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002416
Chris Lattner233f52b2010-03-09 23:52:58 +00002417 Asm->OutStreamer.AddComment("Dwarf Version");
2418 Asm->EmitInt16(dwarf::DWARF_VERSION);
2419 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002420 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002421
Devang Patele9f8f5e2010-05-07 20:54:48 +00002422 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00002423 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002424
Devang Patele9f8f5e2010-05-07 20:54:48 +00002425 const MDNode *Node = *I;
2426 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002427 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00002428 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002429 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002430 StringRef LName = SP.getLinkageName();
2431 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002432
Chris Lattner233f52b2010-03-09 23:52:58 +00002433 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher50e26612012-03-02 01:57:52 +00002434 if (LName.empty())
Eric Christopher2e5d8702012-12-20 21:58:36 +00002435 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2436 DwarfStrSectionSym);
Eric Christopher50e26612012-03-02 01:57:52 +00002437 else
Eric Christopher2e5d8702012-12-20 21:58:36 +00002438 Asm->EmitSectionOffset(InfoHolder
2439 .getStringPoolEntry(getRealLinkageName(LName)),
Chris Lattner6189ed12010-04-04 23:25:33 +00002440 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00002441
Chris Lattner233f52b2010-03-09 23:52:58 +00002442 Asm->OutStreamer.AddComment("Function name");
Eric Christopher2e5d8702012-12-20 21:58:36 +00002443 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2444 DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002445 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00002446
Devang Patel53bb5c92009-11-10 23:06:00 +00002447 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002448 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00002449 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00002450 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002451
Chris Lattner3f53c832010-04-04 18:52:31 +00002452 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00002453 Asm->OutStreamer.EmitSymbolValue(LI->first,
Eric Christopher1ced2082013-01-09 03:52:05 +00002454 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002455 }
2456 }
2457
Chris Lattnerc0215722010-04-04 19:25:43 +00002458 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002459}
Eric Christopher98e237f2012-11-30 23:59:06 +00002460
Eric Christopher0b944ee2012-12-11 19:42:09 +00002461// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher98e237f2012-11-30 23:59:06 +00002462
2463// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2464// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2465// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2466// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
Eric Christopher4daaed12012-12-10 19:51:21 +00002467CompileUnit *DwarfDebug::constructSkeletonCU(const MDNode *N) {
Eric Christopher98e237f2012-11-30 23:59:06 +00002468 DICompileUnit DIUnit(N);
Eric Christopher98e237f2012-11-30 23:59:06 +00002469 CompilationDir = DIUnit.getDirectory();
Eric Christopher98e237f2012-11-30 23:59:06 +00002470
2471 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002472 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher2e5d8702012-12-20 21:58:36 +00002473 DIUnit.getLanguage(), Die, Asm,
Eric Christopher64f824c2012-12-27 02:14:01 +00002474 this, &SkeletonHolder);
Eric Christopher446b88f2013-01-17 03:00:04 +00002475
2476 SmallString<16> T(DIUnit.getFilename());
2477 sys::path::replace_extension(T, ".dwo");
2478 StringRef FN = sys::path::filename(T);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002479 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name, FN);
Eric Christopher98e237f2012-11-30 23:59:06 +00002480
Eric Christopher208cc6f2013-02-05 07:31:55 +00002481 // This should be a unique identifier when we want to build .dwp files.
2482 NewCU->addUInt(Die, dwarf::DW_AT_GNU_dwo_id, dwarf::DW_FORM_data8, 0);
Eric Christopherd96c72a2013-01-17 02:59:59 +00002483
2484 // FIXME: The addr base should be relative for each compile unit, however,
2485 // this one is going to be 0 anyhow.
2486 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002487
2488 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002489 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher98e237f2012-11-30 23:59:06 +00002490 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002491
Eric Christopher98e237f2012-11-30 23:59:06 +00002492 // DW_AT_stmt_list is a offset of line number information for this
2493 // compile unit in debug_line section.
2494 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher446b88f2013-01-17 03:00:04 +00002495 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher7a0103c2013-02-07 21:19:50 +00002496 DwarfLineSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002497 else
Eric Christopher446b88f2013-01-17 03:00:04 +00002498 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002499
2500 if (!CompilationDir.empty())
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002501 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher98e237f2012-11-30 23:59:06 +00002502
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002503 SkeletonHolder.addUnit(NewCU);
Eric Christopher01776a52013-02-06 21:53:56 +00002504 SkeletonCUs.push_back(NewCU);
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002505
Eric Christopher98e237f2012-11-30 23:59:06 +00002506 return NewCU;
2507}
2508
Eric Christopher6eebe472012-12-19 22:02:53 +00002509void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2510 assert(useSplitDwarf() && "No split dwarf debug info?");
2511 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher98e237f2012-11-30 23:59:06 +00002512}
2513
Eric Christopher0b944ee2012-12-11 19:42:09 +00002514// Emit the .debug_info.dwo section for separated dwarf. This contains the
2515// compile units that would normally be in debug_info.
Eric Christopher98e237f2012-11-30 23:59:06 +00002516void DwarfDebug::emitDebugInfoDWO() {
Eric Christopher4daaed12012-12-10 19:51:21 +00002517 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002518 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher6eebe472012-12-19 22:02:53 +00002519 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2520 DwarfAbbrevDWOSectionSym);
2521}
2522
2523// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2524// abbreviations for the .debug_info.dwo section.
2525void DwarfDebug::emitDebugAbbrevDWO() {
2526 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher72c16552012-12-20 21:58:40 +00002527 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2528 &Abbreviations);
Eric Christopher98e237f2012-11-30 23:59:06 +00002529}
Eric Christopher64f824c2012-12-27 02:14:01 +00002530
2531// Emit the .debug_str.dwo section for separated dwarf. This contains the
2532// string section and is identical in format to traditional .debug_str
2533// sections.
2534void DwarfDebug::emitDebugStrDWO() {
2535 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherff348452013-01-07 22:40:45 +00002536 const MCSection *OffSec = Asm->getObjFileLowering()
2537 .getDwarfStrOffDWOSection();
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002538 const MCSymbol *StrSym = DwarfStrSectionSym;
2539 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2540 OffSec, StrSym);
Eric Christopher64f824c2012-12-27 02:14:01 +00002541}