blob: 6d3759d19a7792349853f37ab8cba12cdf1f9597 [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.
Manman Renf2d89ff2013-02-09 00:41:44 +0000673 // The line table entries are not always emitted in assembly, so it
674 // is not okay to use line_table_start here.
Rafael Espindola2241e512012-06-22 13:24:07 +0000675 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Rafael Espindola597a7662011-05-04 17:44:06 +0000676 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Manman Renf2d89ff2013-02-09 00:41:44 +0000677 NewCU->getUniqueID() == 0 ?
678 Asm->GetTempSymbol("section_line") : LineTableStartSym);
Manman Ren9c5861f2013-02-06 00:59:41 +0000679 else if (NewCU->getUniqueID() == 0)
680 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
Devang Patelae84d5b2010-08-31 23:50:19 +0000681 else
Manman Ren43213cf2013-02-05 21:52:47 +0000682 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Eric Christopher7a0103c2013-02-07 21:19:50 +0000683 LineTableStartSym, DwarfLineSectionSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000684
Nick Lewycky6c1a7032011-11-02 20:55:33 +0000685 if (!CompilationDir.empty())
686 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000687 if (DIUnit.isOptimized())
Eric Christopher873cf0a2012-08-24 01:14:27 +0000688 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000689
Devang Patel65dbc902009-11-25 17:36:49 +0000690 StringRef Flags = DIUnit.getFlags();
691 if (!Flags.empty())
Nick Lewycky390c40d2011-10-27 06:44:11 +0000692 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000693
Nick Lewyckyd5d52132011-10-17 23:27:36 +0000694 if (unsigned RVer = DIUnit.getRunTimeVersion())
Devang Patel3cbee302011-04-12 22:53:02 +0000695 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000696 dwarf::DW_FORM_data1, RVer);
697
Devang Patel163a9f72010-05-10 22:49:55 +0000698 if (!FirstCU)
699 FirstCU = NewCU;
Eric Christopher208cc6f2013-02-05 07:31:55 +0000700
Eric Christopher31fb5da2013-02-05 07:32:03 +0000701 if (useSplitDwarf()) {
702 // This should be a unique identifier when we want to build .dwp files.
Eric Christopher208cc6f2013-02-05 07:31:55 +0000703 NewCU->addUInt(Die, dwarf::DW_AT_GNU_dwo_id, dwarf::DW_FORM_data8, 0);
Eric Christopher31fb5da2013-02-05 07:32:03 +0000704 // Now construct the skeleton CU associated.
705 constructSkeletonCU(N);
706 }
Eric Christopher98e237f2012-11-30 23:59:06 +0000707
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000708 InfoHolder.addUnit(NewCU);
709
Devang Patel163a9f72010-05-10 22:49:55 +0000710 CUMap.insert(std::make_pair(N, NewCU));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000711 return NewCU;
Devang Patel163a9f72010-05-10 22:49:55 +0000712}
713
Eric Christopherb6dc8652012-11-27 22:43:45 +0000714// Construct subprogram DIE.
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000715void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
Devang Patel3655a212011-08-15 23:36:40 +0000716 const MDNode *N) {
Rafael Espindolab0527282011-11-04 19:00:29 +0000717 CompileUnit *&CURef = SPMap[N];
718 if (CURef)
719 return;
720 CURef = TheCU;
721
Devang Patele4b27562009-08-28 23:24:31 +0000722 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000723 if (!SP.isDefinition())
724 // This is a method declaration which will be handled while constructing
725 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +0000726 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000727
Devang Pateldbc64af2011-08-15 17:24:54 +0000728 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
Stuart Hastings639336e2010-04-06 21:38:29 +0000729
730 // Add to map.
Devang Patel163a9f72010-05-10 22:49:55 +0000731 TheCU->insertDIE(N, SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000732
733 // Add to context owner.
Devang Patel3cbee302011-04-12 22:53:02 +0000734 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
Devang Patel0000fad2009-12-08 23:21:45 +0000735
Devang Patel13e16b62009-06-26 01:49:18 +0000736 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000737}
738
Eric Christopherb6dc8652012-11-27 22:43:45 +0000739// Collect debug info from named mdnodes such as llvm.dbg.enum and llvm.dbg.ty.
Eric Christopherc4639d62012-11-19 22:42:15 +0000740void DwarfDebug::collectInfoFromNamedMDNodes(const Module *M) {
Devang Patel94c7ddb2011-08-16 22:09:43 +0000741 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
742 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
743 const MDNode *N = NMD->getOperand(i);
744 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
745 constructSubprogramDIE(CU, N);
746 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000747
Devang Patel94c7ddb2011-08-16 22:09:43 +0000748 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
749 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
750 const MDNode *N = NMD->getOperand(i);
751 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel28bea082011-08-18 23:17:55 +0000752 CU->createGlobalVariableDIE(N);
Devang Patel94c7ddb2011-08-16 22:09:43 +0000753 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000754
Devang Patel02e603f2011-08-15 23:47:24 +0000755 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
756 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
757 DIType Ty(NMD->getOperand(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000758 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
759 CU->getOrCreateTypeDIE(Ty);
Devang Patel02e603f2011-08-15 23:47:24 +0000760 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000761
Devang Patel02e603f2011-08-15 23:47:24 +0000762 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
763 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
764 DIType Ty(NMD->getOperand(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000765 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
766 CU->getOrCreateTypeDIE(Ty);
Devang Patel02e603f2011-08-15 23:47:24 +0000767 }
768}
769
Eric Christopherb6dc8652012-11-27 22:43:45 +0000770// Collect debug info using DebugInfoFinder.
771// FIXME - Remove this when dragonegg switches to DIBuilder.
Eric Christopherc4639d62012-11-19 22:42:15 +0000772bool DwarfDebug::collectLegacyDebugInfo(const Module *M) {
Devang Patel02e603f2011-08-15 23:47:24 +0000773 DebugInfoFinder DbgFinder;
774 DbgFinder.processModule(*M);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000775
Devang Patel02e603f2011-08-15 23:47:24 +0000776 bool HasDebugInfo = false;
777 // Scan all the compile-units to see if there are any marked as the main
778 // unit. If not, we do not generate debug info.
779 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
780 E = DbgFinder.compile_unit_end(); I != E; ++I) {
781 if (DICompileUnit(*I).isMain()) {
782 HasDebugInfo = true;
783 break;
784 }
785 }
786 if (!HasDebugInfo) return false;
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000787
Eric Christopher7a0103c2013-02-07 21:19:50 +0000788 // Emit initial sections so we can refer to them later.
789 emitSectionLabels();
790
Devang Patel02e603f2011-08-15 23:47:24 +0000791 // Create all the compile unit DIEs.
792 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
793 E = DbgFinder.compile_unit_end(); I != E; ++I)
794 constructCompileUnit(*I);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000795
Devang Patel02e603f2011-08-15 23:47:24 +0000796 // Create DIEs for each global variable.
797 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
798 E = DbgFinder.global_variable_end(); I != E; ++I) {
799 const MDNode *N = *I;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000800 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
Devang Patel28bea082011-08-18 23:17:55 +0000801 CU->createGlobalVariableDIE(N);
Devang Patel02e603f2011-08-15 23:47:24 +0000802 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000803
Devang Patel02e603f2011-08-15 23:47:24 +0000804 // Create DIEs for each subprogram.
805 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
806 E = DbgFinder.subprogram_end(); I != E; ++I) {
807 const MDNode *N = *I;
Devang Patel94c7ddb2011-08-16 22:09:43 +0000808 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
809 constructSubprogramDIE(CU, N);
Devang Patel02e603f2011-08-15 23:47:24 +0000810 }
811
812 return HasDebugInfo;
813}
814
Eric Christopherb6dc8652012-11-27 22:43:45 +0000815// Emit all Dwarf sections that should come prior to the content. Create
816// global DIEs and emit initial debug info sections. This is invoked by
817// the target AsmPrinter.
Eric Christopherc4639d62012-11-19 22:42:15 +0000818void DwarfDebug::beginModule() {
Devang Pateleac9c072010-04-27 19:46:33 +0000819 if (DisableDebugInfoPrinting)
820 return;
821
Eric Christopherc4639d62012-11-19 22:42:15 +0000822 const Module *M = MMI->getModule();
823
Nick Lewycky3bbb6f72011-07-29 03:49:23 +0000824 // If module has named metadata anchors then use them, otherwise scan the
825 // module using debug info finder to collect debug info.
Devang Patel30692ab2011-05-03 16:45:22 +0000826 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
827 if (CU_Nodes) {
Eric Christopher7a0103c2013-02-07 21:19:50 +0000828 // Emit initial sections so we can reference labels later.
829 emitSectionLabels();
830
Devang Patel94c7ddb2011-08-16 22:09:43 +0000831 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
832 DICompileUnit CUNode(CU_Nodes->getOperand(i));
833 CompileUnit *CU = constructCompileUnit(CUNode);
834 DIArray GVs = CUNode.getGlobalVariables();
835 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
Devang Patel28bea082011-08-18 23:17:55 +0000836 CU->createGlobalVariableDIE(GVs.getElement(i));
Devang Patel94c7ddb2011-08-16 22:09:43 +0000837 DIArray SPs = CUNode.getSubprograms();
838 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
839 constructSubprogramDIE(CU, SPs.getElement(i));
840 DIArray EnumTypes = CUNode.getEnumTypes();
841 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
842 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
843 DIArray RetainedTypes = CUNode.getRetainedTypes();
844 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
845 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
846 }
Devang Patel02e603f2011-08-15 23:47:24 +0000847 } else if (!collectLegacyDebugInfo(M))
848 return;
Devang Patel30692ab2011-05-03 16:45:22 +0000849
Devang Patel02e603f2011-08-15 23:47:24 +0000850 collectInfoFromNamedMDNodes(M);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000851
Chris Lattnerd850ac72010-04-05 02:19:28 +0000852 // Tell MMI that we have debug info.
853 MMI->setDebugInfoAvailability(true);
Eric Christopher0f1c7f62012-11-19 22:42:10 +0000854
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000855 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +0000856 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000857}
858
Eric Christopher4117bec2012-11-22 00:59:49 +0000859// Attach DW_AT_inline attribute with inlined subprogram DIEs.
860void DwarfDebug::computeInlinedDIEs() {
Devang Patel53bb5c92009-11-10 23:06:00 +0000861 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
862 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000863 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
Devang Patel53bb5c92009-11-10 23:06:00 +0000864 DIE *ISP = *AI;
Devang Patel3cbee302011-04-12 22:53:02 +0000865 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel53bb5c92009-11-10 23:06:00 +0000866 }
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000867 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000868 AE = AbstractSPDies.end(); AI != AE; ++AI) {
Rafael Espindolad1ac3a42011-11-12 01:57:54 +0000869 DIE *ISP = AI->second;
870 if (InlinedSubprogramDIEs.count(ISP))
871 continue;
872 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
873 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000874}
875
876// Collect info for variables that were optimized out.
877void DwarfDebug::collectDeadVariables() {
878 const Module *M = MMI->getModule();
879 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
880
881 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
882 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
883 DICompileUnit TheCU(CU_Nodes->getOperand(i));
884 DIArray Subprograms = TheCU.getSubprograms();
885 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
Eric Christopherbdab8002012-11-27 00:13:51 +0000886 DISubprogram SP(Subprograms.getElement(i));
887 if (ProcessedSPNodes.count(SP) != 0) continue;
888 if (!SP.Verify()) continue;
889 if (!SP.isDefinition()) continue;
890 DIArray Variables = SP.getVariables();
891 if (Variables.getNumElements() == 0) continue;
Eric Christopher4117bec2012-11-22 00:59:49 +0000892
Eric Christopherbdab8002012-11-27 00:13:51 +0000893 LexicalScope *Scope =
894 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
895 DeadFnScopeMap[SP] = Scope;
Eric Christopher4117bec2012-11-22 00:59:49 +0000896
Eric Christopherbdab8002012-11-27 00:13:51 +0000897 // Construct subprogram DIE and add variables DIEs.
898 CompileUnit *SPCU = CUMap.lookup(TheCU);
899 assert(SPCU && "Unable to find Compile Unit!");
900 constructSubprogramDIE(SPCU, SP);
901 DIE *ScopeDIE = SPCU->getDIE(SP);
902 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
903 DIVariable DV(Variables.getElement(vi));
904 if (!DV.Verify()) continue;
905 DbgVariable *NewVar = new DbgVariable(DV, NULL);
906 if (DIE *VariableDIE =
907 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
908 ScopeDIE->addChild(VariableDIE);
909 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000910 }
911 }
912 }
913 DeleteContainerSeconds(DeadFnScopeMap);
914}
915
916void DwarfDebug::finalizeModuleInfo() {
917 // Collect info for variables that were optimized out.
918 collectDeadVariables();
919
920 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
921 computeInlinedDIEs();
Devang Patel53bb5c92009-11-10 23:06:00 +0000922
Eric Christopher6635cad2012-08-01 18:19:01 +0000923 // Emit DW_AT_containing_type attribute to connect types with their
924 // vtable holding type.
Devang Pateldbc64af2011-08-15 17:24:54 +0000925 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
Eric Christopherbdab8002012-11-27 00:13:51 +0000926 CUE = CUMap.end(); CUI != CUE; ++CUI) {
Devang Pateldbc64af2011-08-15 17:24:54 +0000927 CompileUnit *TheCU = CUI->second;
928 TheCU->constructContainingTypeDIEs();
Devang Patel5d11eb02009-12-03 19:11:07 +0000929 }
930
Eric Christopher4117bec2012-11-22 00:59:49 +0000931 // Compute DIE offsets and sizes.
Eric Christopher0e3e9b72012-12-10 23:34:43 +0000932 InfoHolder.computeSizeAndOffsets();
933 if (useSplitDwarf())
934 SkeletonHolder.computeSizeAndOffsets();
Eric Christopher4117bec2012-11-22 00:59:49 +0000935}
936
937void DwarfDebug::endSections() {
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000938 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000939 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000940 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
Chris Lattner6c2f9e12009-08-19 05:49:37 +0000941 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Chris Lattnerc0215722010-04-04 19:25:43 +0000942 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000943
944 // End text sections.
Benjamin Kramerb4c9d9c2012-10-31 13:45:49 +0000945 for (unsigned I = 0, E = SectionMap.size(); I != E; ++I) {
946 Asm->OutStreamer.SwitchSection(SectionMap[I]);
947 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", I+1));
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000948 }
Eric Christopher4117bec2012-11-22 00:59:49 +0000949}
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000950
Eric Christopherb6dc8652012-11-27 22:43:45 +0000951// Emit all Dwarf sections that should come after the content.
Eric Christopher4117bec2012-11-22 00:59:49 +0000952void DwarfDebug::endModule() {
953
954 if (!FirstCU) return;
955
956 // End any existing sections.
957 // TODO: Does this need to happen?
958 endSections();
959
960 // Finalize the debug info for the module.
961 finalizeModuleInfo();
Bill Wendlingf0fb9872009-05-20 23:19:06 +0000962
Eric Christopher4daaed12012-12-10 19:51:21 +0000963 if (!useSplitDwarf()) {
Eric Christopher42885022012-11-27 22:43:42 +0000964 // Emit all the DIEs into a debug info section.
965 emitDebugInfo();
Eric Christopher74802f72012-11-27 00:41:54 +0000966
Eric Christopher42885022012-11-27 22:43:42 +0000967 // Corresponding abbreviations into a abbrev section.
968 emitAbbreviations();
969
970 // Emit info into a debug loc section.
971 emitDebugLoc();
972
973 // Emit info into a debug aranges section.
974 emitDebugARanges();
975
976 // Emit info into a debug ranges section.
977 emitDebugRanges();
978
979 // Emit info into a debug macinfo section.
980 emitDebugMacInfo();
981
982 // Emit inline info.
983 // TODO: When we don't need the option anymore we
984 // can remove all of the code that this section
985 // depends upon.
986 if (useDarwinGDBCompat())
987 emitDebugInlineInfo();
988 } else {
Eric Christopher0b944ee2012-12-11 19:42:09 +0000989 // TODO: Fill this in for separated debug sections and separate
Eric Christopher42885022012-11-27 22:43:42 +0000990 // out information into new sections.
991
Eric Christopher98e237f2012-11-30 23:59:06 +0000992 // Emit the debug info section and compile units.
Eric Christopher42885022012-11-27 22:43:42 +0000993 emitDebugInfo();
Eric Christopher98e237f2012-11-30 23:59:06 +0000994 emitDebugInfoDWO();
Eric Christopher42885022012-11-27 22:43:42 +0000995
996 // Corresponding abbreviations into a abbrev section.
997 emitAbbreviations();
Eric Christopher6eebe472012-12-19 22:02:53 +0000998 emitDebugAbbrevDWO();
Eric Christopher42885022012-11-27 22:43:42 +0000999
1000 // Emit info into a debug loc section.
1001 emitDebugLoc();
1002
1003 // Emit info into a debug aranges section.
1004 emitDebugARanges();
1005
1006 // Emit info into a debug ranges section.
1007 emitDebugRanges();
1008
1009 // Emit info into a debug macinfo section.
1010 emitDebugMacInfo();
1011
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001012 // Emit DWO addresses.
1013 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1014
Eric Christopher42885022012-11-27 22:43:42 +00001015 // Emit inline info.
1016 // TODO: When we don't need the option anymore we
1017 // can remove all of the code that this section
1018 // depends upon.
1019 if (useDarwinGDBCompat())
1020 emitDebugInlineInfo();
1021 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001022
Eric Christopher9d9f5a52012-08-23 07:32:06 +00001023 // Emit info into the dwarf accelerator table sections.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001024 if (useDwarfAccelTables()) {
Eric Christopher09ac3d82011-11-07 09:24:32 +00001025 emitAccelNames();
1026 emitAccelObjC();
1027 emitAccelNamespaces();
1028 emitAccelTypes();
1029 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001030
Devang Patel193f7202009-11-24 01:14:22 +00001031 // Emit info into a debug pubtypes section.
Eric Christopher360f0062012-08-23 07:10:56 +00001032 // TODO: When we don't need the option anymore we can
1033 // remove all of the code that adds to the table.
Eric Christopher20f47ab2012-08-23 22:36:40 +00001034 if (useDarwinGDBCompat())
Eric Christopher360f0062012-08-23 07:10:56 +00001035 emitDebugPubTypes();
Devang Patel193f7202009-11-24 01:14:22 +00001036
Eric Christopher42885022012-11-27 22:43:42 +00001037 // Finally emit string information into a string table.
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001038 emitDebugStr();
Eric Christopher64f824c2012-12-27 02:14:01 +00001039 if (useSplitDwarf())
1040 emitDebugStrDWO();
Eric Christopherfcdbecb2012-11-27 06:49:23 +00001041
Devang Patele9a1cca2010-08-02 17:32:15 +00001042 // clean up.
Devang Patel94c7ddb2011-08-16 22:09:43 +00001043 SPMap.clear();
Devang Patel163a9f72010-05-10 22:49:55 +00001044 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1045 E = CUMap.end(); I != E; ++I)
1046 delete I->second;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001047
Eric Christopher01776a52013-02-06 21:53:56 +00001048 for (SmallVector<CompileUnit *, 1>::iterator I = SkeletonCUs.begin(),
1049 E = SkeletonCUs.end(); I != E; ++I)
1050 delete *I;
Eric Christopher9ec87b32012-12-10 19:51:18 +00001051
Eric Christopher98e237f2012-11-30 23:59:06 +00001052 // Reset these for the next Module if we have one.
1053 FirstCU = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001054}
1055
Eric Christopherb6dc8652012-11-27 22:43:45 +00001056// Find abstract variable, if any, associated with Var.
Devang Patelb549bcf2011-08-10 21:50:54 +00001057DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
Chris Lattnerde4845c2010-04-02 19:42:39 +00001058 DebugLoc ScopeLoc) {
Devang Patelb549bcf2011-08-10 21:50:54 +00001059 LLVMContext &Ctx = DV->getContext();
1060 // More then one inlined variable corresponds to one abstract variable.
1061 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
Devang Patel2db49d72010-05-07 18:11:54 +00001062 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00001063 if (AbsDbgVariable)
1064 return AbsDbgVariable;
1065
Devang Patelbf47fdb2011-08-10 20:55:27 +00001066 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
Devang Patel53bb5c92009-11-10 23:06:00 +00001067 if (!Scope)
1068 return NULL;
1069
Devang Patel5a1a67c2011-08-15 19:01:20 +00001070 AbsDbgVariable = new DbgVariable(Var, NULL);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001071 addScopeVariable(Scope, AbsDbgVariable);
Devang Patel2db49d72010-05-07 18:11:54 +00001072 AbstractVariables[Var] = AbsDbgVariable;
Devang Patel53bb5c92009-11-10 23:06:00 +00001073 return AbsDbgVariable;
1074}
1075
Eric Christopherb6dc8652012-11-27 22:43:45 +00001076// If Var is a current function argument then add it to CurrentFnArguments list.
Devang Patel0478c152011-03-01 22:58:55 +00001077bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
Devang Patelbf47fdb2011-08-10 20:55:27 +00001078 DbgVariable *Var, LexicalScope *Scope) {
1079 if (!LScopes.isCurrentFunctionScope(Scope))
Devang Patel0478c152011-03-01 22:58:55 +00001080 return false;
1081 DIVariable DV = Var->getVariable();
1082 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1083 return false;
1084 unsigned ArgNo = DV.getArgNumber();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001085 if (ArgNo == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001086 return false;
1087
Devang Patelcb3a6572011-03-03 20:02:02 +00001088 size_t Size = CurrentFnArguments.size();
1089 if (Size == 0)
Devang Patel0478c152011-03-01 22:58:55 +00001090 CurrentFnArguments.resize(MF->getFunction()->arg_size());
Devang Patelbbd0f452011-03-03 21:49:41 +00001091 // llvm::Function argument size is not good indicator of how many
Devang Patel6f676be2011-03-03 20:08:10 +00001092 // arguments does the function have at source level.
1093 if (ArgNo > Size)
Devang Patelcb3a6572011-03-03 20:02:02 +00001094 CurrentFnArguments.resize(ArgNo * 2);
Devang Patel0478c152011-03-01 22:58:55 +00001095 CurrentFnArguments[ArgNo - 1] = Var;
1096 return true;
1097}
1098
Eric Christopherb6dc8652012-11-27 22:43:45 +00001099// Collect variable information from side table maintained by MMI.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001100void
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001101DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
Devang Patelee432862010-05-20 19:57:06 +00001102 SmallPtrSet<const MDNode *, 16> &Processed) {
Devang Patele717faa2009-10-06 01:26:37 +00001103 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1104 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1105 VE = VMap.end(); VI != VE; ++VI) {
Devang Patele9f8f5e2010-05-07 20:54:48 +00001106 const MDNode *Var = VI->first;
Devang Patel53bb5c92009-11-10 23:06:00 +00001107 if (!Var) continue;
Devang Patel98e1cac2010-05-14 21:01:35 +00001108 Processed.insert(Var);
Chris Lattnerde4845c2010-04-02 19:42:39 +00001109 DIVariable DV(Var);
1110 const std::pair<unsigned, DebugLoc> &VP = VI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00001111
Devang Patelbf47fdb2011-08-10 20:55:27 +00001112 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001113
Devang Patelfb0ee432009-11-10 23:20:04 +00001114 // If variable scope is not found then skip this variable.
Chris Lattnerde4845c2010-04-02 19:42:39 +00001115 if (Scope == 0)
Devang Patelfb0ee432009-11-10 23:20:04 +00001116 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00001117
Devang Patel26c1e562010-05-20 16:36:41 +00001118 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001119 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
Devang Patelff9dd0a2011-08-15 21:24:36 +00001120 RegVar->setFrameIndex(VP.first);
Devang Patel0478c152011-03-01 22:58:55 +00001121 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001122 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001123 if (AbsDbgVariable)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001124 AbsDbgVariable->setFrameIndex(VP.first);
Devang Patele717faa2009-10-06 01:26:37 +00001125 }
Devang Patelee432862010-05-20 19:57:06 +00001126}
Devang Patel90a48ad2010-03-15 18:33:46 +00001127
Eric Christopherb6dc8652012-11-27 22:43:45 +00001128// Return true if debug value, encoded by DBG_VALUE instruction, is in a
1129// defined reg.
Devang Patelc3f5f782010-05-25 23:40:22 +00001130static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001131 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001132 return MI->getNumOperands() == 3 &&
1133 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1134 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
Devang Patelc3f5f782010-05-25 23:40:22 +00001135}
1136
Eric Christopherb6dc8652012-11-27 22:43:45 +00001137// Get .debug_loc entry for the instruction range starting at MI.
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001138static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1139 const MCSymbol *FLabel,
Devang Patel90b40412011-07-08 17:09:57 +00001140 const MCSymbol *SLabel,
1141 const MachineInstr *MI) {
1142 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1143
1144 if (MI->getNumOperands() != 3) {
1145 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
1146 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1147 }
1148 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
1149 MachineLocation MLoc;
1150 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1151 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1152 }
1153 if (MI->getOperand(0).isImm())
1154 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1155 if (MI->getOperand(0).isFPImm())
1156 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1157 if (MI->getOperand(0).isCImm())
1158 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1159
Craig Topper5e25ee82012-02-05 08:31:47 +00001160 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
Devang Patel90b40412011-07-08 17:09:57 +00001161}
1162
Eric Christopherb6dc8652012-11-27 22:43:45 +00001163// Find variables for each lexical scope.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001164void
Devang Patel78e127d2010-06-25 22:07:34 +00001165DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1166 SmallPtrSet<const MDNode *, 16> &Processed) {
Jim Grosbach1e20b962010-07-21 21:21:52 +00001167
Eric Christopherb6dc8652012-11-27 22:43:45 +00001168 // collection info from MMI table.
Devang Patelee432862010-05-20 19:57:06 +00001169 collectVariableInfoFromMMITable(MF, Processed);
1170
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001171 for (SmallVectorImpl<const MDNode*>::const_iterator
1172 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1173 ++UVI) {
1174 const MDNode *Var = *UVI;
1175 if (Processed.count(Var))
Devang Patelee432862010-05-20 19:57:06 +00001176 continue;
1177
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001178 // History contains relevant DBG_VALUE instructions for Var and instructions
1179 // clobbering it.
1180 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1181 if (History.empty())
1182 continue;
1183 const MachineInstr *MInsn = History.front();
Devang Patelc3f5f782010-05-25 23:40:22 +00001184
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001185 DIVariable DV(Var);
Devang Patelbf47fdb2011-08-10 20:55:27 +00001186 LexicalScope *Scope = NULL;
Devang Pateld8720f42010-05-27 20:25:04 +00001187 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1188 DISubprogram(DV.getContext()).describes(MF->getFunction()))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001189 Scope = LScopes.getCurrentFunctionScope();
Devang Patel40c7e412011-07-20 22:18:50 +00001190 else {
1191 if (DV.getVersion() <= LLVMDebugVersion9)
Devang Patelbf47fdb2011-08-10 20:55:27 +00001192 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
Devang Patel40c7e412011-07-20 22:18:50 +00001193 else {
1194 if (MDNode *IA = DV.getInlinedAt())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001195 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
Devang Patel40c7e412011-07-20 22:18:50 +00001196 else
Devang Patelbf47fdb2011-08-10 20:55:27 +00001197 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
Devang Patel40c7e412011-07-20 22:18:50 +00001198 }
1199 }
Devang Patelee432862010-05-20 19:57:06 +00001200 // If variable scope is not found then skip this variable.
Devang Patelc0c5a262010-05-21 00:10:20 +00001201 if (!Scope)
Devang Patelee432862010-05-20 19:57:06 +00001202 continue;
1203
1204 Processed.insert(DV);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001205 assert(MInsn->isDebugValue() && "History must begin with debug value");
Devang Patel5a1a67c2011-08-15 19:01:20 +00001206 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1207 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
Devang Patel0478c152011-03-01 22:58:55 +00001208 if (!addCurrentFnArgument(MF, RegVar, Scope))
Devang Patelbf47fdb2011-08-10 20:55:27 +00001209 addScopeVariable(Scope, RegVar);
Devang Patel5a1a67c2011-08-15 19:01:20 +00001210 if (AbsVar)
Devang Patelff9dd0a2011-08-15 21:24:36 +00001211 AbsVar->setMInsn(MInsn);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001212
Eric Christopherc56e3f02012-10-08 20:48:54 +00001213 // Simplify ranges that are fully coalesced.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001214 if (History.size() <= 1 || (History.size() == 2 &&
1215 MInsn->isIdenticalTo(History.back()))) {
Devang Patelff9dd0a2011-08-15 21:24:36 +00001216 RegVar->setMInsn(MInsn);
Devang Patelc3f5f782010-05-25 23:40:22 +00001217 continue;
1218 }
1219
Eric Christopher498703b2013-01-28 17:33:26 +00001220 // Handle multiple DBG_VALUE instructions describing one variable.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001221 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001222
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001223 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1224 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1225 const MachineInstr *Begin = *HI;
1226 assert(Begin->isDebugValue() && "Invalid History entry");
Jakob Stoklund Olesene17232e2011-03-22 00:21:41 +00001227
Devang Patel4ada1d72011-06-01 23:00:17 +00001228 // Check if DBG_VALUE is truncating a range.
1229 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1230 && !Begin->getOperand(0).getReg())
1231 continue;
1232
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001233 // Compute the range for a register location.
1234 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1235 const MCSymbol *SLabel = 0;
1236
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001237 if (HI + 1 == HE)
1238 // If Begin is the last instruction in History then its value is valid
Chris Lattner7a2bdde2011-04-15 05:18:47 +00001239 // until the end of the function.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001240 SLabel = FunctionEndSym;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001241 else {
1242 const MachineInstr *End = HI[1];
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001243 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
Devang Patel476df5f2011-07-07 21:44:42 +00001244 << "\t" << *Begin << "\t" << *End << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001245 if (End->isDebugValue())
1246 SLabel = getLabelBeforeInsn(End);
1247 else {
1248 // End is a normal instruction clobbering the range.
1249 SLabel = getLabelAfterInsn(End);
1250 assert(SLabel && "Forgot label after clobber instruction");
1251 ++HI;
1252 }
1253 }
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001254
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001255 // The value is valid until the next DBG_VALUE or clobber.
Eric Christopherabbb2002011-12-16 23:42:31 +00001256 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1257 Begin));
Devang Patelc3f5f782010-05-25 23:40:22 +00001258 }
1259 DotDebugLocEntries.push_back(DotDebugLocEntry());
Devang Patel90a48ad2010-03-15 18:33:46 +00001260 }
Devang Patel98e1cac2010-05-14 21:01:35 +00001261
1262 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001263 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1264 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1265 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1266 DIVariable DV(Variables.getElement(i));
1267 if (!DV || !DV.Verify() || !Processed.insert(DV))
1268 continue;
1269 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1270 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel98e1cac2010-05-14 21:01:35 +00001271 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001272}
Devang Patel98e1cac2010-05-14 21:01:35 +00001273
Eric Christopherb6dc8652012-11-27 22:43:45 +00001274// Return Label preceding the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001275MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001276 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1277 assert(Label && "Didn't insert label before instruction");
1278 return Label;
Devang Patelc3f5f782010-05-25 23:40:22 +00001279}
1280
Eric Christopherb6dc8652012-11-27 22:43:45 +00001281// Return Label immediately following the instruction.
Eric Christopher72f7bfb2013-01-15 23:56:56 +00001282MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001283 return LabelsAfterInsn.lookup(MI);
Devang Patele717faa2009-10-06 01:26:37 +00001284}
1285
Eric Christopherb6dc8652012-11-27 22:43:45 +00001286// Process beginning of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001287void DwarfDebug::beginInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001288 // Check if source location changes, but ignore DBG_VALUE locations.
1289 if (!MI->isDebugValue()) {
1290 DebugLoc DL = MI->getDebugLoc();
1291 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
Eric Christopher60b35f42012-04-05 20:39:05 +00001292 unsigned Flags = 0;
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001293 PrevInstLoc = DL;
Devang Patel4243e672011-05-11 19:22:19 +00001294 if (DL == PrologEndLoc) {
1295 Flags |= DWARF2_FLAG_PROLOGUE_END;
1296 PrologEndLoc = DebugLoc();
1297 }
Eric Christopher60b35f42012-04-05 20:39:05 +00001298 if (PrologEndLoc.isUnknown())
1299 Flags |= DWARF2_FLAG_IS_STMT;
1300
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001301 if (!DL.isUnknown()) {
1302 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
Devang Patel4243e672011-05-11 19:22:19 +00001303 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001304 } else
Devang Patel4243e672011-05-11 19:22:19 +00001305 recordSourceLine(0, 0, 0, 0);
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001306 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001307 }
Devang Patelaead63c2010-03-29 22:59:58 +00001308
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001309 // Insert labels where requested.
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001310 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1311 LabelsBeforeInsn.find(MI);
1312
1313 // No label needed.
1314 if (I == LabelsBeforeInsn.end())
1315 return;
1316
1317 // Label already assigned.
1318 if (I->second)
Devang Patelb2b31a62010-05-26 19:37:24 +00001319 return;
Devang Patel553881b2010-03-29 17:20:31 +00001320
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001321 if (!PrevLabel) {
Devang Patel77051f52010-05-26 21:23:46 +00001322 PrevLabel = MMI->getContext().CreateTempSymbol();
1323 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patelb2b31a62010-05-26 19:37:24 +00001324 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001325 I->second = PrevLabel;
Devang Patel0d20ac82009-10-06 01:50:42 +00001326}
1327
Eric Christopherb6dc8652012-11-27 22:43:45 +00001328// Process end of an instruction.
Devang Patelcbbe2872010-10-26 17:49:02 +00001329void DwarfDebug::endInstruction(const MachineInstr *MI) {
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001330 // Don't create a new label after DBG_VALUE instructions.
1331 // They don't generate code.
1332 if (!MI->isDebugValue())
1333 PrevLabel = 0;
1334
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001335 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1336 LabelsAfterInsn.find(MI);
1337
1338 // No label needed.
1339 if (I == LabelsAfterInsn.end())
1340 return;
1341
1342 // Label already assigned.
1343 if (I->second)
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001344 return;
1345
1346 // We need a label after this instruction.
1347 if (!PrevLabel) {
1348 PrevLabel = MMI->getContext().CreateTempSymbol();
1349 Asm->OutStreamer.EmitLabel(PrevLabel);
Devang Patel1c246352010-04-08 16:50:29 +00001350 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001351 I->second = PrevLabel;
Devang Patel53bb5c92009-11-10 23:06:00 +00001352}
1353
Eric Christopherb6dc8652012-11-27 22:43:45 +00001354// Each LexicalScope has first instruction and last instruction to mark
1355// beginning and end of a scope respectively. Create an inverse map that list
1356// scopes starts (and ends) with an instruction. One instruction may start (or
1357// end) multiple scopes. Ignore scopes that are not reachable.
Devang Patele37b0c62010-04-08 18:43:56 +00001358void DwarfDebug::identifyScopeMarkers() {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001359 SmallVector<LexicalScope *, 4> WorkList;
1360 WorkList.push_back(LScopes.getCurrentFunctionScope());
Devang Patel42aafd72010-01-20 02:05:23 +00001361 while (!WorkList.empty()) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001362 LexicalScope *S = WorkList.pop_back_val();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001363
Devang Patelbf47fdb2011-08-10 20:55:27 +00001364 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001365 if (!Children.empty())
Devang Patelbf47fdb2011-08-10 20:55:27 +00001366 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
Devang Patel42aafd72010-01-20 02:05:23 +00001367 SE = Children.end(); SI != SE; ++SI)
1368 WorkList.push_back(*SI);
1369
Devang Patel53bb5c92009-11-10 23:06:00 +00001370 if (S->isAbstractScope())
1371 continue;
Jim Grosbach1e20b962010-07-21 21:21:52 +00001372
Devang Patelbf47fdb2011-08-10 20:55:27 +00001373 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
Devang Pateleac9c072010-04-27 19:46:33 +00001374 if (Ranges.empty())
1375 continue;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001376 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
Devang Pateleac9c072010-04-27 19:46:33 +00001377 RE = Ranges.end(); RI != RE; ++RI) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001378 assert(RI->first && "InsnRange does not have first instruction!");
1379 assert(RI->second && "InsnRange does not have second instruction!");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001380 requestLabelBeforeInsn(RI->first);
1381 requestLabelAfterInsn(RI->second);
Devang Pateleac9c072010-04-27 19:46:33 +00001382 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001383 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001384}
1385
Eric Christopherb6dc8652012-11-27 22:43:45 +00001386// Get MDNode for DebugLoc's scope.
Devang Patela3f48672011-05-09 22:14:49 +00001387static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1388 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1389 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1390 return DL.getScope(Ctx);
1391}
1392
Eric Christopherb6dc8652012-11-27 22:43:45 +00001393// Walk up the scope chain of given debug loc and find line number info
1394// for the function.
Devang Patel4243e672011-05-11 19:22:19 +00001395static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1396 const MDNode *Scope = getScopeNode(DL, Ctx);
1397 DISubprogram SP = getDISubprogram(Scope);
Eric Christopher6126a1e2012-04-03 00:43:49 +00001398 if (SP.Verify()) {
1399 // Check for number of operands since the compatibility is
1400 // cheap here.
Eric Christopherfa5b0502012-04-03 17:55:42 +00001401 if (SP->getNumOperands() > 19)
Eric Christopher6126a1e2012-04-03 00:43:49 +00001402 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1403 else
1404 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1405 }
1406
Devang Patel4243e672011-05-11 19:22:19 +00001407 return DebugLoc();
1408}
1409
Eric Christopherb6dc8652012-11-27 22:43:45 +00001410// Gather pre-function debug information. Assumes being called immediately
1411// after the function entry point has been emitted.
Chris Lattnereec791a2010-01-26 23:18:02 +00001412void DwarfDebug::beginFunction(const MachineFunction *MF) {
Chris Lattner994cb122010-04-05 03:52:55 +00001413 if (!MMI->hasDebugInfo()) return;
Devang Patelbf47fdb2011-08-10 20:55:27 +00001414 LScopes.initialize(*MF);
1415 if (LScopes.empty()) return;
1416 identifyScopeMarkers();
Devang Patel60b35bd2009-10-06 18:37:31 +00001417
Manman Ren43213cf2013-02-05 21:52:47 +00001418 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1419 // belongs to.
1420 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1421 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1422 assert(TheCU && "Unable to find compile unit!");
1423 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1424
Devang Pateleac9c072010-04-27 19:46:33 +00001425 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1426 Asm->getFunctionNumber());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001427 // Assumes in correct section after the entry point.
Devang Pateleac9c072010-04-27 19:46:33 +00001428 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001429
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001430 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1431
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001432 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
Eric Christopherb6dc8652012-11-27 22:43:45 +00001433 // LiveUserVar - Map physreg numbers to the MDNode they contain.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001434 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1435
Devang Patelb2b31a62010-05-26 19:37:24 +00001436 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001437 I != E; ++I) {
1438 bool AtBlockEntry = true;
Devang Patelb2b31a62010-05-26 19:37:24 +00001439 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1440 II != IE; ++II) {
1441 const MachineInstr *MI = II;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001442
Devang Patelb2b31a62010-05-26 19:37:24 +00001443 if (MI->isDebugValue()) {
Nick Lewycky746cb672011-10-26 22:55:33 +00001444 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001445
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001446 // Keep track of user variables.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001447 const MDNode *Var =
1448 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001449
1450 // Variable is in a register, we need to check for clobbers.
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001451 if (isDbgValueInDefinedReg(MI))
1452 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1453
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001454 // Check the history of this variable.
1455 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1456 if (History.empty()) {
1457 UserVariables.push_back(Var);
1458 // The first mention of a function argument gets the FunctionBeginSym
1459 // label, so arguments are visible when breaking at function entry.
1460 DIVariable DV(Var);
1461 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1462 DISubprogram(getDISubprogram(DV.getContext()))
1463 .describes(MF->getFunction()))
1464 LabelsBeforeInsn[MI] = FunctionBeginSym;
1465 } else {
1466 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1467 const MachineInstr *Prev = History.back();
1468 if (Prev->isDebugValue()) {
1469 // Coalesce identical entries at the end of History.
1470 if (History.size() >= 2 &&
Devang Patel79862892011-07-07 00:14:27 +00001471 Prev->isIdenticalTo(History[History.size() - 2])) {
Eric Christopher02c1a642012-10-08 20:48:49 +00001472 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001473 << "\t" << *Prev
Devang Patel79862892011-07-07 00:14:27 +00001474 << "\t" << *History[History.size() - 2] << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001475 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001476 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001477
1478 // Terminate old register assignments that don't reach MI;
1479 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1480 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1481 isDbgValueInDefinedReg(Prev)) {
1482 // Previous register assignment needs to terminate at the end of
1483 // its basic block.
1484 MachineBasicBlock::const_iterator LastMI =
1485 PrevMBB->getLastNonDebugInstr();
Devang Patel79862892011-07-07 00:14:27 +00001486 if (LastMI == PrevMBB->end()) {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001487 // Drop DBG_VALUE for empty range.
Eric Christopher02c1a642012-10-08 20:48:49 +00001488 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
Devang Patel79862892011-07-07 00:14:27 +00001489 << "\t" << *Prev << "\n");
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001490 History.pop_back();
Devang Patel79862892011-07-07 00:14:27 +00001491 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001492 else {
1493 // Terminate after LastMI.
1494 History.push_back(LastMI);
1495 }
1496 }
1497 }
1498 }
1499 History.push_back(MI);
Devang Patelb2b31a62010-05-26 19:37:24 +00001500 } else {
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001501 // Not a DBG_VALUE instruction.
1502 if (!MI->isLabel())
1503 AtBlockEntry = false;
1504
Eric Christopher0313ced2012-10-04 20:46:14 +00001505 // First known non-DBG_VALUE and non-frame setup location marks
1506 // the beginning of the function body.
1507 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1508 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
Devang Patel4243e672011-05-11 19:22:19 +00001509 PrologEndLoc = MI->getDebugLoc();
1510
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001511 // Check if the instruction clobbers any registers with debug vars.
1512 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1513 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1514 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1515 continue;
Jakob Stoklund Olesen396618b2012-06-01 23:28:30 +00001516 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1517 AI.isValid(); ++AI) {
1518 unsigned Reg = *AI;
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001519 const MDNode *Var = LiveUserVar[Reg];
1520 if (!Var)
1521 continue;
1522 // Reg is now clobbered.
1523 LiveUserVar[Reg] = 0;
1524
1525 // Was MD last defined by a DBG_VALUE referring to Reg?
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001526 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1527 if (HistI == DbgValues.end())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001528 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001529 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1530 if (History.empty())
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001531 continue;
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001532 const MachineInstr *Prev = History.back();
1533 // Sanity-check: Register assignments are terminated at the end of
1534 // their block.
1535 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1536 continue;
1537 // Is the variable still in Reg?
1538 if (!isDbgValueInDefinedReg(Prev) ||
1539 Prev->getOperand(0).getReg() != Reg)
1540 continue;
1541 // Var is clobbered. Make sure the next instruction gets a label.
1542 History.push_back(MI);
Jakob Stoklund Olesen28cf1152011-03-22 22:33:08 +00001543 }
1544 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001545 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001546 }
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001547 }
1548
1549 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1550 I != E; ++I) {
1551 SmallVectorImpl<const MachineInstr*> &History = I->second;
1552 if (History.empty())
1553 continue;
1554
1555 // Make sure the final register assignments are terminated.
1556 const MachineInstr *Prev = History.back();
1557 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1558 const MachineBasicBlock *PrevMBB = Prev->getParent();
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001559 MachineBasicBlock::const_iterator LastMI =
Devang Patel5bc942c2011-08-10 23:58:09 +00001560 PrevMBB->getLastNonDebugInstr();
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001561 if (LastMI == PrevMBB->end())
1562 // Drop DBG_VALUE for empty range.
1563 History.pop_back();
1564 else {
1565 // Terminate after LastMI.
1566 History.push_back(LastMI);
1567 }
1568 }
1569 // Request labels for the full history.
1570 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1571 const MachineInstr *MI = History[i];
1572 if (MI->isDebugValue())
1573 requestLabelBeforeInsn(MI);
1574 else
1575 requestLabelAfterInsn(MI);
1576 }
1577 }
Devang Patelb2b31a62010-05-26 19:37:24 +00001578
Jakob Stoklund Olesen15a3ea02011-03-25 17:20:59 +00001579 PrevInstLoc = DebugLoc();
Devang Patelb2b31a62010-05-26 19:37:24 +00001580 PrevLabel = FunctionBeginSym;
Devang Patel4243e672011-05-11 19:22:19 +00001581
1582 // Record beginning of function.
1583 if (!PrologEndLoc.isUnknown()) {
1584 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1585 MF->getFunction()->getContext());
1586 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1587 FnStartDL.getScope(MF->getFunction()->getContext()),
David Blaikie836cfc42012-12-04 22:02:33 +00001588 // We'd like to list the prologue as "not statements" but GDB behaves
1589 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
David Blaikieb36c5312012-12-04 21:05:36 +00001590 DWARF2_FLAG_IS_STMT);
Devang Patel4243e672011-05-11 19:22:19 +00001591 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001592}
1593
Devang Patelbf47fdb2011-08-10 20:55:27 +00001594void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1595// SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1596 ScopeVariables[LS].push_back(Var);
1597// Vars.push_back(Var);
1598}
1599
Eric Christopherb6dc8652012-11-27 22:43:45 +00001600// Gather and emit post-function debug information.
Chris Lattnereec791a2010-01-26 23:18:02 +00001601void DwarfDebug::endFunction(const MachineFunction *MF) {
Devang Patelbf47fdb2011-08-10 20:55:27 +00001602 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
Devang Patel70d75ca2009-11-12 19:02:56 +00001603
Devang Patelbf47fdb2011-08-10 20:55:27 +00001604 // Define end label for subprogram.
1605 FunctionEndSym = Asm->GetTempSymbol("func_end",
1606 Asm->getFunctionNumber());
1607 // Assumes in correct section after the entry point.
1608 Asm->OutStreamer.EmitLabel(FunctionEndSym);
Manman Ren43213cf2013-02-05 21:52:47 +00001609 // Set DwarfCompileUnitID in MCContext to default value.
1610 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001611
Devang Patelbf47fdb2011-08-10 20:55:27 +00001612 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1613 collectVariableInfo(MF, ProcessedVars);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001614
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001615 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
Devang Patel94c7ddb2011-08-16 22:09:43 +00001616 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
Nick Lewycky746cb672011-10-26 22:55:33 +00001617 assert(TheCU && "Unable to find compile unit!");
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001618
Devang Patelbf47fdb2011-08-10 20:55:27 +00001619 // Construct abstract scopes.
Devang Patelcd9f6c52011-08-12 18:10:19 +00001620 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1621 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1622 LexicalScope *AScope = AList[i];
1623 DISubprogram SP(AScope->getScopeNode());
Devang Patelbf47fdb2011-08-10 20:55:27 +00001624 if (SP.Verify()) {
1625 // Collect info for variables that were optimized out.
Devang Patel93d39be2011-08-19 23:28:12 +00001626 DIArray Variables = SP.getVariables();
1627 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1628 DIVariable DV(Variables.getElement(i));
1629 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1630 continue;
Alexey Samsonovb67bd332012-07-06 08:45:08 +00001631 // Check that DbgVariable for DV wasn't created earlier, when
1632 // findAbstractVariable() was called for inlined instance of DV.
1633 LLVMContext &Ctx = DV->getContext();
1634 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1635 if (AbstractVariables.lookup(CleanDV))
1636 continue;
Devang Patel93d39be2011-08-19 23:28:12 +00001637 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1638 addScopeVariable(Scope, new DbgVariable(DV, NULL));
Devang Patel78e127d2010-06-25 22:07:34 +00001639 }
1640 }
Devang Patelcd9f6c52011-08-12 18:10:19 +00001641 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001642 constructScopeDIE(TheCU, AScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001643 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001644
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001645 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
Eric Christopher0f1c7f62012-11-19 22:42:10 +00001646
Nick Lewycky8a8d4792011-12-02 22:16:29 +00001647 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
Eric Christopher873cf0a2012-08-24 01:14:27 +00001648 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
Devang Pateld0b5a5e2011-08-15 22:04:40 +00001649
Devang Patelbf47fdb2011-08-10 20:55:27 +00001650 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1651 MMI->getFrameMoves()));
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001652
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001653 // Clear debug info
Devang Patelbf47fdb2011-08-10 20:55:27 +00001654 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1655 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1656 DeleteContainerPointers(I->second);
1657 ScopeVariables.clear();
Devang Pateleac0c9d2011-04-22 18:09:57 +00001658 DeleteContainerPointers(CurrentFnArguments);
Jakob Stoklund Olesenadb877d2011-03-26 02:19:36 +00001659 UserVariables.clear();
1660 DbgValues.clear();
Jeffrey Yasskin5c213dc2010-03-12 17:45:06 +00001661 AbstractVariables.clear();
Devang Pateleac9c072010-04-27 19:46:33 +00001662 LabelsBeforeInsn.clear();
1663 LabelsAfterInsn.clear();
Devang Patelf2548ca2010-04-16 23:33:45 +00001664 PrevLabel = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001665}
1666
Eric Christopherb6dc8652012-11-27 22:43:45 +00001667// Register a source line with debug info. Returns the unique label that was
1668// emitted and which provides correspondence to the source line list.
Devang Patel4243e672011-05-11 19:22:19 +00001669void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1670 unsigned Flags) {
Devang Patel65dbc902009-11-25 17:36:49 +00001671 StringRef Fn;
Devang Patel23670e52011-03-24 20:30:50 +00001672 StringRef Dir;
Dan Gohman1cc0d622010-05-05 23:41:32 +00001673 unsigned Src = 1;
1674 if (S) {
1675 DIDescriptor Scope(S);
Devang Patelf84548d2009-10-05 18:03:19 +00001676
Dan Gohman1cc0d622010-05-05 23:41:32 +00001677 if (Scope.isCompileUnit()) {
1678 DICompileUnit CU(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001679 Fn = CU.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001680 Dir = CU.getDirectory();
Devang Patel3cabc9d2010-10-28 17:30:52 +00001681 } else if (Scope.isFile()) {
1682 DIFile F(S);
Devang Patel3cabc9d2010-10-28 17:30:52 +00001683 Fn = F.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001684 Dir = F.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001685 } else if (Scope.isSubprogram()) {
1686 DISubprogram SP(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001687 Fn = SP.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001688 Dir = SP.getDirectory();
Eric Christopher6618a242011-10-11 22:59:11 +00001689 } else if (Scope.isLexicalBlockFile()) {
1690 DILexicalBlockFile DBF(S);
1691 Fn = DBF.getFilename();
1692 Dir = DBF.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001693 } else if (Scope.isLexicalBlock()) {
1694 DILexicalBlock DB(S);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001695 Fn = DB.getFilename();
Devang Patel23670e52011-03-24 20:30:50 +00001696 Dir = DB.getDirectory();
Dan Gohman1cc0d622010-05-05 23:41:32 +00001697 } else
Craig Topper5e25ee82012-02-05 08:31:47 +00001698 llvm_unreachable("Unexpected scope info");
Dan Gohman1cc0d622010-05-05 23:41:32 +00001699
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001700 Src = getOrCreateSourceID(Fn, Dir);
Dan Gohman1cc0d622010-05-05 23:41:32 +00001701 }
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00001702 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001703}
1704
Bill Wendling829e67b2009-05-20 23:22:40 +00001705//===----------------------------------------------------------------------===//
1706// Emit Methods
1707//===----------------------------------------------------------------------===//
1708
Eric Christopherb6dc8652012-11-27 22:43:45 +00001709// Compute the size and offset of a DIE.
Jim Grosbach7ab38df2009-11-22 19:20:36 +00001710unsigned
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001711DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001712 // Get the children.
1713 const std::vector<DIE *> &Children = Die->getChildren();
1714
Bill Wendling94d04b82009-05-20 23:21:38 +00001715 // Record the abbreviation.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001716 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling94d04b82009-05-20 23:21:38 +00001717
1718 // Get the abbreviation for this DIE.
1719 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001720 const DIEAbbrev *Abbrev = Abbreviations->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001721
1722 // Set DIE offset
1723 Die->setOffset(Offset);
1724
1725 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00001726 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001727
1728 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1729 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1730
1731 // Size the DIE attribute values.
1732 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1733 // Size attribute value.
Chris Lattnera37d5382010-04-05 00:18:22 +00001734 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
Bill Wendling94d04b82009-05-20 23:21:38 +00001735
1736 // Size the DIE children if any.
1737 if (!Children.empty()) {
1738 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1739 "Children flag not set");
1740
1741 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopherfbd19752012-11-20 22:14:13 +00001742 Offset = computeSizeAndOffset(Children[j], Offset);
Bill Wendling94d04b82009-05-20 23:21:38 +00001743
1744 // End of children marker.
1745 Offset += sizeof(int8_t);
1746 }
1747
1748 Die->setSize(Offset - Die->getOffset());
1749 return Offset;
1750}
1751
Eric Christopherb6dc8652012-11-27 22:43:45 +00001752// Compute the size and offset of all the DIEs.
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001753void DwarfUnits::computeSizeAndOffsets() {
1754 for (SmallVector<CompileUnit *, 1>::iterator I = CUs.begin(),
1755 E = CUs.end(); I != E; ++I) {
Eric Christopher98e237f2012-11-30 23:59:06 +00001756 unsigned Offset =
1757 sizeof(int32_t) + // Length of Compilation Unit Info
1758 sizeof(int16_t) + // DWARF version number
1759 sizeof(int32_t) + // Offset Into Abbrev. Section
1760 sizeof(int8_t); // Pointer Size (in bytes)
1761
Eric Christopher0e3e9b72012-12-10 23:34:43 +00001762 computeSizeAndOffset((*I)->getCUDie(), Offset);
Devang Patel163a9f72010-05-10 22:49:55 +00001763 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001764}
1765
Eric Christopherb6dc8652012-11-27 22:43:45 +00001766// Emit initial Dwarf sections with a label at the start of each one.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001767void DwarfDebug::emitSectionLabels() {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001768 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001769
Bill Wendling94d04b82009-05-20 23:21:38 +00001770 // Dwarf sections base addresses.
Jim Grosbach1e20b962010-07-21 21:21:52 +00001771 DwarfInfoSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001772 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
Jim Grosbach1e20b962010-07-21 21:21:52 +00001773 DwarfAbbrevSectionSym =
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001774 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
Eric Christopher6eebe472012-12-19 22:02:53 +00001775 if (useSplitDwarf())
1776 DwarfAbbrevDWOSectionSym =
1777 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1778 "section_abbrev_dwo");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001779 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001780
Chris Lattner9c69e285532010-04-04 22:59:04 +00001781 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001782 emitSectionSym(Asm, MacroInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00001783
Eric Christopher7a0103c2013-02-07 21:19:50 +00001784 DwarfLineSectionSym =
1785 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001786 emitSectionSym(Asm, TLOF.getDwarfLocSection());
1787 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001788 DwarfStrSectionSym =
Eric Christopher64f824c2012-12-27 02:14:01 +00001789 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
1790 if (useSplitDwarf())
1791 DwarfStrDWOSectionSym =
1792 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001793 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
Devang Patelf2548ca2010-04-16 23:33:45 +00001794 "debug_range");
Bill Wendling94d04b82009-05-20 23:21:38 +00001795
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001796 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
Devang Patelc3f5f782010-05-25 23:40:22 +00001797 "section_debug_loc");
1798
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00001799 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1800 emitSectionSym(Asm, TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00001801}
1802
Eric Christopherb6dc8652012-11-27 22:43:45 +00001803// Recursively emits a debug information entry.
Eric Christopher6eebe472012-12-19 22:02:53 +00001804void DwarfDebug::emitDIE(DIE *Die, std::vector<DIEAbbrev *> *Abbrevs) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001805 // Get the abbreviation for this DIE.
1806 unsigned AbbrevNumber = Die->getAbbrevNumber();
Eric Christopher6eebe472012-12-19 22:02:53 +00001807 const DIEAbbrev *Abbrev = Abbrevs->at(AbbrevNumber - 1);
Bill Wendling94d04b82009-05-20 23:21:38 +00001808
Bill Wendling94d04b82009-05-20 23:21:38 +00001809 // Emit the code (index) for the abbreviation.
Chris Lattner3f53c832010-04-04 18:52:31 +00001810 if (Asm->isVerbose())
Chris Lattner894d75a2010-01-22 23:18:42 +00001811 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1812 Twine::utohexstr(Die->getOffset()) + ":0x" +
1813 Twine::utohexstr(Die->getSize()) + " " +
1814 dwarf::TagString(Abbrev->getTag()));
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001815 Asm->EmitULEB128(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00001816
Jeffrey Yasskin638fe8d2010-03-22 18:47:14 +00001817 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
Bill Wendling94d04b82009-05-20 23:21:38 +00001818 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1819
1820 // Emit the DIE attribute values.
1821 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1822 unsigned Attr = AbbrevData[i].getAttribute();
1823 unsigned Form = AbbrevData[i].getForm();
1824 assert(Form && "Too many attributes for DIE (check abbreviation)");
1825
Chris Lattner3f53c832010-04-04 18:52:31 +00001826 if (Asm->isVerbose())
Chris Lattnera8013622010-01-24 18:54:17 +00001827 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001828
Bill Wendling94d04b82009-05-20 23:21:38 +00001829 switch (Attr) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001830 case dwarf::DW_AT_abstract_origin: {
1831 DIEEntry *E = cast<DIEEntry>(Values[i]);
1832 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00001833 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00001834 Asm->EmitInt32(Addr);
1835 break;
1836 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001837 case dwarf::DW_AT_ranges: {
1838 // DW_AT_range Value encodes offset in debug_range section.
1839 DIEInteger *V = cast<DIEInteger>(Values[i]);
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001840
Nick Lewyckyffccd922012-06-22 01:25:12 +00001841 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
Devang Patelb1fcfbe2010-09-02 16:43:44 +00001842 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1843 V->getValue(),
1844 4);
1845 } else {
1846 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1847 V->getValue(),
1848 DwarfDebugRangeSectionSym,
1849 4);
1850 }
Devang Patelf2548ca2010-04-16 23:33:45 +00001851 break;
1852 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001853 case dwarf::DW_AT_location: {
Nick Lewyckyffccd922012-06-22 01:25:12 +00001854 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
1855 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1856 Asm->EmitLabelReference(L->getValue(), 4);
1857 else
1858 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1859 } else {
Devang Patelc3f5f782010-05-25 23:40:22 +00001860 Values[i]->EmitValue(Asm, Form);
Nick Lewyckyffccd922012-06-22 01:25:12 +00001861 }
Devang Patelc3f5f782010-05-25 23:40:22 +00001862 break;
1863 }
Devang Patel2a361602010-09-29 19:08:08 +00001864 case dwarf::DW_AT_accessibility: {
1865 if (Asm->isVerbose()) {
1866 DIEInteger *V = cast<DIEInteger>(Values[i]);
1867 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1868 }
1869 Values[i]->EmitValue(Asm, Form);
1870 break;
1871 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001872 default:
1873 // Emit an attribute using the defined form.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001874 Values[i]->EmitValue(Asm, Form);
Bill Wendling94d04b82009-05-20 23:21:38 +00001875 break;
1876 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001877 }
1878
1879 // Emit the DIE children if any.
1880 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1881 const std::vector<DIE *> &Children = Die->getChildren();
1882
1883 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Eric Christopher6eebe472012-12-19 22:02:53 +00001884 emitDIE(Children[j], Abbrevs);
Bill Wendling94d04b82009-05-20 23:21:38 +00001885
Chris Lattner3f53c832010-04-04 18:52:31 +00001886 if (Asm->isVerbose())
Chris Lattner233f52b2010-03-09 23:52:58 +00001887 Asm->OutStreamer.AddComment("End Of Children Mark");
1888 Asm->EmitInt8(0);
Bill Wendling94d04b82009-05-20 23:21:38 +00001889 }
1890}
1891
Eric Christopherb1e66d02012-12-15 00:04:07 +00001892// Emit the various dwarf units to the unit section USection with
1893// the abbreviations going into ASection.
1894void DwarfUnits::emitUnits(DwarfDebug *DD,
1895 const MCSection *USection,
1896 const MCSection *ASection,
1897 const MCSymbol *ASectionSym) {
1898 Asm->OutStreamer.SwitchSection(USection);
1899 for (SmallVector<CompileUnit *, 1>::iterator I = CUs.begin(),
1900 E = CUs.end(); I != E; ++I) {
1901 CompileUnit *TheCU = *I;
Devang Patel163a9f72010-05-10 22:49:55 +00001902 DIE *Die = TheCU->getCUDie();
Jim Grosbach1e20b962010-07-21 21:21:52 +00001903
Devang Patel163a9f72010-05-10 22:49:55 +00001904 // Emit the compile units header.
Eric Christopherb1e66d02012-12-15 00:04:07 +00001905 Asm->OutStreamer
1906 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
1907 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00001908
Devang Patel163a9f72010-05-10 22:49:55 +00001909 // Emit size of content not including length itself
1910 unsigned ContentSize = Die->getSize() +
1911 sizeof(int16_t) + // DWARF version number
1912 sizeof(int32_t) + // Offset Into Abbrev. Section
Devang Patel65705d52011-04-13 19:41:17 +00001913 sizeof(int8_t); // Pointer Size (in bytes)
Jim Grosbach1e20b962010-07-21 21:21:52 +00001914
Devang Patel163a9f72010-05-10 22:49:55 +00001915 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1916 Asm->EmitInt32(ContentSize);
1917 Asm->OutStreamer.AddComment("DWARF version number");
1918 Asm->EmitInt16(dwarf::DWARF_VERSION);
1919 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
Eric Christopherb1e66d02012-12-15 00:04:07 +00001920 Asm->EmitSectionOffset(Asm->GetTempSymbol(ASection->getLabelBeginName()),
1921 ASectionSym);
Devang Patel163a9f72010-05-10 22:49:55 +00001922 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001923 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Jim Grosbach1e20b962010-07-21 21:21:52 +00001924
Eric Christopher6eebe472012-12-19 22:02:53 +00001925 DD->emitDIE(Die, Abbreviations);
Eric Christopherb1e66d02012-12-15 00:04:07 +00001926 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00001927 TheCU->getUniqueID()));
Devang Patel163a9f72010-05-10 22:49:55 +00001928 }
Bill Wendling94d04b82009-05-20 23:21:38 +00001929}
1930
Eric Christopher98e237f2012-11-30 23:59:06 +00001931// Emit the debug info section.
1932void DwarfDebug::emitDebugInfo() {
Eric Christopherb1e66d02012-12-15 00:04:07 +00001933 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1934
1935 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
1936 Asm->getObjFileLowering().getDwarfAbbrevSection(),
1937 DwarfAbbrevSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00001938}
1939
Eric Christopherb6dc8652012-11-27 22:43:45 +00001940// Emit the abbreviation section.
Eric Christopher7dc68db2012-11-20 23:30:11 +00001941void DwarfDebug::emitAbbreviations() {
Eric Christopher6eebe472012-12-19 22:02:53 +00001942 if (!useSplitDwarf())
1943 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
1944 &Abbreviations);
1945 else
1946 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
1947}
Bill Wendling94d04b82009-05-20 23:21:38 +00001948
Eric Christopher6eebe472012-12-19 22:02:53 +00001949void DwarfDebug::emitAbbrevs(const MCSection *Section,
1950 std::vector<DIEAbbrev *> *Abbrevs) {
1951 // Check to see if it is worth the effort.
1952 if (!Abbrevs->empty()) {
1953 // Start the debug abbrev section.
1954 Asm->OutStreamer.SwitchSection(Section);
1955
1956 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
Eric Christopher44fedba2012-12-13 03:00:38 +00001957 Asm->OutStreamer.EmitLabel(Begin);
Bill Wendling94d04b82009-05-20 23:21:38 +00001958
1959 // For each abbrevation.
Eric Christopher6eebe472012-12-19 22:02:53 +00001960 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001961 // Get abbreviation data
Eric Christopher6eebe472012-12-19 22:02:53 +00001962 const DIEAbbrev *Abbrev = Abbrevs->at(i);
Bill Wendling94d04b82009-05-20 23:21:38 +00001963
1964 // Emit the abbrevations code (base 1 index.)
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001965 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
Bill Wendling94d04b82009-05-20 23:21:38 +00001966
1967 // Emit the abbreviations data.
Chris Lattnerd38fee82010-04-05 00:13:49 +00001968 Abbrev->Emit(Asm);
Bill Wendling94d04b82009-05-20 23:21:38 +00001969 }
1970
1971 // Mark end of abbreviations.
Chris Lattner7e1a8f82010-04-04 19:09:29 +00001972 Asm->EmitULEB128(0, "EOM(3)");
Bill Wendling94d04b82009-05-20 23:21:38 +00001973
Eric Christopher6eebe472012-12-19 22:02:53 +00001974 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
Eric Christopher44fedba2012-12-13 03:00:38 +00001975 Asm->OutStreamer.EmitLabel(End);
Bill Wendling94d04b82009-05-20 23:21:38 +00001976 }
1977}
1978
Eric Christopherb6dc8652012-11-27 22:43:45 +00001979// Emit the last address of the section and the end of the line matrix.
Devang Patel2c4ceb12009-11-21 02:48:08 +00001980void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling94d04b82009-05-20 23:21:38 +00001981 // Define last address of section.
Chris Lattner233f52b2010-03-09 23:52:58 +00001982 Asm->OutStreamer.AddComment("Extended Op");
1983 Asm->EmitInt8(0);
Jim Grosbach1e20b962010-07-21 21:21:52 +00001984
Chris Lattner233f52b2010-03-09 23:52:58 +00001985 Asm->OutStreamer.AddComment("Op size");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00001986 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
Chris Lattner233f52b2010-03-09 23:52:58 +00001987 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1988 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1989
1990 Asm->OutStreamer.AddComment("Section end label");
Chris Lattnerd85fc6e2010-03-10 01:17:49 +00001991
Chris Lattnerc0215722010-04-04 19:25:43 +00001992 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
Eric Christopherca1dd052013-01-09 01:35:34 +00001993 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00001994
1995 // Mark end of matrix.
Chris Lattner233f52b2010-03-09 23:52:58 +00001996 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1997 Asm->EmitInt8(0);
Chris Lattner0ad9c912010-01-22 22:09:00 +00001998 Asm->EmitInt8(1);
Chris Lattner894d75a2010-01-22 23:18:42 +00001999 Asm->EmitInt8(1);
Bill Wendling94d04b82009-05-20 23:21:38 +00002000}
2001
Eric Christopherb6dc8652012-11-27 22:43:45 +00002002// Emit visible names into a hashed accelerator table section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002003void DwarfDebug::emitAccelNames() {
2004 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2005 dwarf::DW_FORM_data4));
2006 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2007 E = CUMap.end(); I != E; ++I) {
2008 CompileUnit *TheCU = I->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002009 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2010 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002011 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2012 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002013 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher0ffe2b42011-11-10 19:25:34 +00002014 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2015 DE = Entities.end(); DI != DE; ++DI)
2016 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002017 }
2018 }
2019
2020 AT.FinalizeTable(Asm, "Names");
2021 Asm->OutStreamer.SwitchSection(
2022 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2023 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2024 Asm->OutStreamer.EmitLabel(SectionBegin);
2025
2026 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002027 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002028}
2029
Eric Christopher72c16552012-12-20 21:58:40 +00002030// Emit objective C classes and categories into a hashed accelerator table
2031// section.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002032void DwarfDebug::emitAccelObjC() {
2033 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2034 dwarf::DW_FORM_data4));
2035 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2036 E = CUMap.end(); I != E; ++I) {
2037 CompileUnit *TheCU = I->second;
2038 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2039 for (StringMap<std::vector<DIE*> >::const_iterator
2040 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2041 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002042 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher09ac3d82011-11-07 09:24:32 +00002043 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2044 DE = Entities.end(); DI != DE; ++DI)
2045 AT.AddName(Name, (*DI));
2046 }
2047 }
2048
2049 AT.FinalizeTable(Asm, "ObjC");
2050 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2051 .getDwarfAccelObjCSection());
2052 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2053 Asm->OutStreamer.EmitLabel(SectionBegin);
2054
2055 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002056 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002057}
2058
Eric Christopherb6dc8652012-11-27 22:43:45 +00002059// Emit namespace dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002060void DwarfDebug::emitAccelNamespaces() {
2061 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2062 dwarf::DW_FORM_data4));
2063 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2064 E = CUMap.end(); I != E; ++I) {
2065 CompileUnit *TheCU = I->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002066 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2067 for (StringMap<std::vector<DIE*> >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002068 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2069 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002070 const std::vector<DIE *> &Entities = GI->second;
Eric Christopher8bd36ea2011-11-10 21:47:55 +00002071 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2072 DE = Entities.end(); DI != DE; ++DI)
2073 AT.AddName(Name, (*DI));
Eric Christopher09ac3d82011-11-07 09:24:32 +00002074 }
2075 }
2076
2077 AT.FinalizeTable(Asm, "namespac");
2078 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2079 .getDwarfAccelNamespaceSection());
2080 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2081 Asm->OutStreamer.EmitLabel(SectionBegin);
2082
2083 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002084 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002085}
2086
Eric Christopherb6dc8652012-11-27 22:43:45 +00002087// Emit type dies into a hashed accelerator table.
Eric Christopher09ac3d82011-11-07 09:24:32 +00002088void DwarfDebug::emitAccelTypes() {
Eric Christopherc36145f2012-01-06 04:35:23 +00002089 std::vector<DwarfAccelTable::Atom> Atoms;
2090 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
2091 dwarf::DW_FORM_data4));
2092 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
2093 dwarf::DW_FORM_data2));
2094 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
2095 dwarf::DW_FORM_data1));
2096 DwarfAccelTable AT(Atoms);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002097 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2098 E = CUMap.end(); I != E; ++I) {
2099 CompileUnit *TheCU = I->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002100 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2101 = TheCU->getAccelTypes();
2102 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
Eric Christopher09ac3d82011-11-07 09:24:32 +00002103 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2104 const char *Name = GI->getKeyData();
Eric Christopherfa03db02012-01-06 23:03:34 +00002105 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
Eric Christopherc36145f2012-01-06 04:35:23 +00002106 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2107 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2108 AT.AddName(Name, (*DI).first, (*DI).second);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002109 }
2110 }
2111
2112 AT.FinalizeTable(Asm, "types");
2113 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2114 .getDwarfAccelTypesSection());
2115 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2116 Asm->OutStreamer.EmitLabel(SectionBegin);
2117
2118 // Emit the full data.
Eric Christopher2e5d8702012-12-20 21:58:36 +00002119 AT.Emit(Asm, SectionBegin, &InfoHolder);
Eric Christopher09ac3d82011-11-07 09:24:32 +00002120}
2121
Devang Patel193f7202009-11-24 01:14:22 +00002122void DwarfDebug::emitDebugPubTypes() {
Devang Patel163a9f72010-05-10 22:49:55 +00002123 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2124 E = CUMap.end(); I != E; ++I) {
2125 CompileUnit *TheCU = I->second;
Eric Christopher63701182011-11-07 09:18:35 +00002126 // Start the dwarf pubtypes section.
Devang Patel163a9f72010-05-10 22:49:55 +00002127 Asm->OutStreamer.SwitchSection(
2128 Asm->getObjFileLowering().getDwarfPubTypesSection());
2129 Asm->OutStreamer.AddComment("Length of Public Types Info");
2130 Asm->EmitLabelDifference(
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002131 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2132 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002133
Devang Patel163a9f72010-05-10 22:49:55 +00002134 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002135 TheCU->getUniqueID()));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002136
Devang Patel163a9f72010-05-10 22:49:55 +00002137 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
2138 Asm->EmitInt16(dwarf::DWARF_VERSION);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002139
Devang Patel163a9f72010-05-10 22:49:55 +00002140 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002141 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2142 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002143 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002144 DwarfInfoSectionSym);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002145
Devang Patel163a9f72010-05-10 22:49:55 +00002146 Asm->OutStreamer.AddComment("Compilation Unit Length");
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002147 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002148 TheCU->getUniqueID()),
Eric Christophercf6b8ad2012-12-15 00:04:04 +00002149 Asm->GetTempSymbol(ISec->getLabelBeginName(),
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002150 TheCU->getUniqueID()),
Devang Patel163a9f72010-05-10 22:49:55 +00002151 4);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002152
Devang Patel163a9f72010-05-10 22:49:55 +00002153 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
2154 for (StringMap<DIE*>::const_iterator
2155 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2156 const char *Name = GI->getKeyData();
Nick Lewycky3bbb6f72011-07-29 03:49:23 +00002157 DIE *Entity = GI->second;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002158
Devang Patel163a9f72010-05-10 22:49:55 +00002159 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2160 Asm->EmitInt32(Entity->getOffset());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002161
Devang Patel163a9f72010-05-10 22:49:55 +00002162 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
Benjamin Kramer983c4572011-11-09 18:16:11 +00002163 // Emit the name with a terminating null byte.
Eric Christopher68ca5622013-01-09 01:57:54 +00002164 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
Devang Patel163a9f72010-05-10 22:49:55 +00002165 }
Jim Grosbach1e20b962010-07-21 21:21:52 +00002166
Devang Patel163a9f72010-05-10 22:49:55 +00002167 Asm->OutStreamer.AddComment("End Mark");
Jim Grosbach1e20b962010-07-21 21:21:52 +00002168 Asm->EmitInt32(0);
Devang Patel163a9f72010-05-10 22:49:55 +00002169 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002170 TheCU->getUniqueID()));
Devang Patel193f7202009-11-24 01:14:22 +00002171 }
Devang Patel193f7202009-11-24 01:14:22 +00002172}
2173
Eric Christopher64f824c2012-12-27 02:14:01 +00002174// Emit strings into a string section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002175void DwarfUnits::emitStrings(const MCSection *StrSection,
2176 const MCSection *OffsetSection = NULL,
2177 const MCSymbol *StrSecSym = NULL) {
Eric Christopher64f824c2012-12-27 02:14:01 +00002178
Eric Christopherb6714222013-01-08 22:22:06 +00002179 if (StringPool.empty()) return;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002180
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002181 // Start the dwarf str section.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002182 Asm->OutStreamer.SwitchSection(StrSection);
Bill Wendling94d04b82009-05-20 23:21:38 +00002183
Chris Lattnerbc733f52010-03-13 02:17:42 +00002184 // Get all of the string pool entries and put them in an array by their ID so
2185 // we can sort them.
Jim Grosbach1e20b962010-07-21 21:21:52 +00002186 SmallVector<std::pair<unsigned,
Eric Christopherff348452013-01-07 22:40:45 +00002187 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002188
Chris Lattnerbc733f52010-03-13 02:17:42 +00002189 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
Eric Christopherb6714222013-01-08 22:22:06 +00002190 I = StringPool.begin(), E = StringPool.end();
Eric Christopher72c16552012-12-20 21:58:40 +00002191 I != E; ++I)
Chris Lattnerbc733f52010-03-13 02:17:42 +00002192 Entries.push_back(std::make_pair(I->second.second, &*I));
Jim Grosbach1e20b962010-07-21 21:21:52 +00002193
Chris Lattnerbc733f52010-03-13 02:17:42 +00002194 array_pod_sort(Entries.begin(), Entries.end());
Jim Grosbach1e20b962010-07-21 21:21:52 +00002195
Chris Lattnerbc733f52010-03-13 02:17:42 +00002196 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Chris Lattner0d9d70f2010-03-09 23:38:23 +00002197 // Emit a label for reference from debug information entries.
Chris Lattnerbc733f52010-03-13 02:17:42 +00002198 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
Jim Grosbach1e20b962010-07-21 21:21:52 +00002199
Benjamin Kramer983c4572011-11-09 18:16:11 +00002200 // Emit the string itself with a terminating null byte.
Benjamin Kramer0c45f7d2011-11-09 12:12:04 +00002201 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
Eric Christopherca1dd052013-01-09 01:35:34 +00002202 Entries[i].second->getKeyLength()+1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002203 }
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002204
2205 // If we've got an offset section go ahead and emit that now as well.
2206 if (OffsetSection) {
2207 Asm->OutStreamer.SwitchSection(OffsetSection);
2208 unsigned offset = 0;
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002209 unsigned size = 4; // FIXME: DWARF64 is 8.
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002210 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
Eric Christopher1ced2082013-01-09 03:52:05 +00002211 Asm->OutStreamer.EmitIntValue(offset, size);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002212 offset += Entries[i].second->getKeyLength() + 1;
2213 }
2214 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002215}
2216
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002217// Emit strings into a string section.
2218void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2219
2220 if (AddressPool.empty()) return;
2221
2222 // Start the dwarf addr section.
2223 Asm->OutStreamer.SwitchSection(AddrSection);
2224
2225 // Get all of the string pool entries and put them in an array by their ID so
2226 // we can sort them.
2227 SmallVector<std::pair<unsigned,
2228 std::pair<MCSymbol*, unsigned>* >, 64> Entries;
2229
2230 for (DenseMap<MCSymbol*, std::pair<MCSymbol*, unsigned> >::iterator
2231 I = AddressPool.begin(), E = AddressPool.end();
2232 I != E; ++I)
2233 Entries.push_back(std::make_pair(I->second.second, &(I->second)));
2234
2235 array_pod_sort(Entries.begin(), Entries.end());
2236
2237 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2238 // Emit a label for reference from debug information entries.
2239 MCSymbol *Sym = Entries[i].second->first;
2240 if (Sym)
2241 Asm->EmitLabelReference(Entries[i].second->first,
2242 Asm->getDataLayout().getPointerSize());
2243 else
2244 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2245 }
2246
2247}
2248
Eric Christopher64f824c2012-12-27 02:14:01 +00002249// Emit visible names into a debug str section.
2250void DwarfDebug::emitDebugStr() {
2251 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2252 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2253}
2254
Eric Christopherb6dc8652012-11-27 22:43:45 +00002255// Emit visible names into a debug loc section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002256void DwarfDebug::emitDebugLoc() {
Devang Patel80250682010-05-26 23:55:23 +00002257 if (DotDebugLocEntries.empty())
2258 return;
2259
Devang Patel6c3ea902011-02-04 22:57:18 +00002260 for (SmallVector<DotDebugLocEntry, 4>::iterator
2261 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2262 I != E; ++I) {
2263 DotDebugLocEntry &Entry = *I;
2264 if (I + 1 != DotDebugLocEntries.end())
2265 Entry.Merge(I+1);
2266 }
2267
Daniel Dunbar83320a02011-03-16 22:16:39 +00002268 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002269 Asm->OutStreamer.SwitchSection(
Devang Patelc3f5f782010-05-25 23:40:22 +00002270 Asm->getObjFileLowering().getDwarfLocSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002271 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Patel80250682010-05-26 23:55:23 +00002272 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2273 unsigned index = 1;
Jim Grosbach1e20b962010-07-21 21:21:52 +00002274 for (SmallVector<DotDebugLocEntry, 4>::iterator
2275 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
Devang Patel61409622010-07-07 20:12:52 +00002276 I != E; ++I, ++index) {
Devang Patel6c3ea902011-02-04 22:57:18 +00002277 DotDebugLocEntry &Entry = *I;
2278 if (Entry.isMerged()) continue;
Devang Patelc3f5f782010-05-25 23:40:22 +00002279 if (Entry.isEmpty()) {
Eric Christopherca1dd052013-01-09 01:35:34 +00002280 Asm->OutStreamer.EmitIntValue(0, Size);
2281 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patel80250682010-05-26 23:55:23 +00002282 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
Devang Patelc3f5f782010-05-25 23:40:22 +00002283 } else {
Eric Christopher1ced2082013-01-09 03:52:05 +00002284 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size);
2285 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size);
Devang Patelc26f5442011-04-28 02:22:40 +00002286 DIVariable DV(Entry.Variable);
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002287 Asm->OutStreamer.AddComment("Loc expr size");
2288 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2289 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2290 Asm->EmitLabelDifference(end, begin, 2);
2291 Asm->OutStreamer.EmitLabel(begin);
Devang Patel80efd4e2011-07-08 16:49:43 +00002292 if (Entry.isInt()) {
Devang Patelc4329072011-06-01 22:03:25 +00002293 DIBasicType BTy(DV.getType());
2294 if (BTy.Verify() &&
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002295 (BTy.getEncoding() == dwarf::DW_ATE_signed
Devang Patelc4329072011-06-01 22:03:25 +00002296 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2297 Asm->OutStreamer.AddComment("DW_OP_consts");
2298 Asm->EmitInt8(dwarf::DW_OP_consts);
Devang Patel80efd4e2011-07-08 16:49:43 +00002299 Asm->EmitSLEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002300 } else {
2301 Asm->OutStreamer.AddComment("DW_OP_constu");
2302 Asm->EmitInt8(dwarf::DW_OP_constu);
Devang Patel80efd4e2011-07-08 16:49:43 +00002303 Asm->EmitULEB128(Entry.getInt());
Devang Patelc4329072011-06-01 22:03:25 +00002304 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002305 } else if (Entry.isLocation()) {
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002306 if (!DV.hasComplexAddress())
Devang Patel80efd4e2011-07-08 16:49:43 +00002307 // Regular entry.
Devang Patelc26f5442011-04-28 02:22:40 +00002308 Asm->EmitDwarfRegOp(Entry.Loc);
Devang Patel80efd4e2011-07-08 16:49:43 +00002309 else {
2310 // Complex address entry.
2311 unsigned N = DV.getNumAddrElements();
2312 unsigned i = 0;
2313 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2314 if (Entry.Loc.getOffset()) {
2315 i = 2;
2316 Asm->EmitDwarfRegOp(Entry.Loc);
2317 Asm->OutStreamer.AddComment("DW_OP_deref");
2318 Asm->EmitInt8(dwarf::DW_OP_deref);
2319 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2320 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2321 Asm->EmitSLEB128(DV.getAddrElement(1));
2322 } else {
2323 // If first address element is OpPlus then emit
2324 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2325 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2326 Asm->EmitDwarfRegOp(Loc);
2327 i = 2;
2328 }
2329 } else {
2330 Asm->EmitDwarfRegOp(Entry.Loc);
2331 }
Eric Christopher0f1c7f62012-11-19 22:42:10 +00002332
Devang Patel80efd4e2011-07-08 16:49:43 +00002333 // Emit remaining complex address elements.
2334 for (; i < N; ++i) {
2335 uint64_t Element = DV.getAddrElement(i);
2336 if (Element == DIBuilder::OpPlus) {
2337 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2338 Asm->EmitULEB128(DV.getAddrElement(++i));
Eric Christopher50120762012-05-08 18:56:00 +00002339 } else if (Element == DIBuilder::OpDeref) {
Eric Christophera80f2d12012-05-08 21:24:39 +00002340 if (!Entry.Loc.isReg())
Eric Christopher50120762012-05-08 18:56:00 +00002341 Asm->EmitInt8(dwarf::DW_OP_deref);
2342 } else
2343 llvm_unreachable("unknown Opcode found in complex address");
Devang Patel80efd4e2011-07-08 16:49:43 +00002344 }
Devang Patelc26f5442011-04-28 02:22:40 +00002345 }
Devang Patelc26f5442011-04-28 02:22:40 +00002346 }
Devang Patel80efd4e2011-07-08 16:49:43 +00002347 // else ... ignore constant fp. There is not any good way to
2348 // to represent them here in dwarf.
Rafael Espindola5b23b7f2011-05-27 22:05:41 +00002349 Asm->OutStreamer.EmitLabel(end);
Devang Patelc3f5f782010-05-25 23:40:22 +00002350 }
2351 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002352}
2353
Eric Christopherb6dc8652012-11-27 22:43:45 +00002354// Emit visible names into a debug aranges section.
Eric Christopher7ee5f5d2012-11-21 00:34:35 +00002355void DwarfDebug::emitDebugARanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002356 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002357 Asm->OutStreamer.SwitchSection(
2358 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002359}
2360
Eric Christopherb6dc8652012-11-27 22:43:45 +00002361// Emit visible names into a debug ranges section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002362void DwarfDebug::emitDebugRanges() {
Bill Wendling94d04b82009-05-20 23:21:38 +00002363 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002364 Asm->OutStreamer.SwitchSection(
Devang Patelf2548ca2010-04-16 23:33:45 +00002365 Asm->getObjFileLowering().getDwarfRangesSection());
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002366 unsigned char Size = Asm->getDataLayout().getPointerSize();
Devang Pateleac9c072010-04-27 19:46:33 +00002367 for (SmallVector<const MCSymbol *, 8>::iterator
Jim Grosbach1e20b962010-07-21 21:21:52 +00002368 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
Devang Pateleac9c072010-04-27 19:46:33 +00002369 I != E; ++I) {
2370 if (*I)
Eric Christopher1ced2082013-01-09 03:52:05 +00002371 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002372 else
Eric Christopherca1dd052013-01-09 01:35:34 +00002373 Asm->OutStreamer.EmitIntValue(0, Size);
Devang Patelf2548ca2010-04-16 23:33:45 +00002374 }
Bill Wendling94d04b82009-05-20 23:21:38 +00002375}
2376
Eric Christopherb6dc8652012-11-27 22:43:45 +00002377// Emit visible names into a debug macinfo section.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002378void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002379 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00002380 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00002381 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002382 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00002383 }
2384}
2385
Eric Christopherb6dc8652012-11-27 22:43:45 +00002386// Emit inline info using following format.
2387// Section Header:
2388// 1. length of section
2389// 2. Dwarf version number
2390// 3. address size.
2391//
2392// Entries (one "entry" for each function that was inlined):
2393//
2394// 1. offset into __debug_str section for MIPS linkage name, if exists;
2395// otherwise offset into __debug_str for regular function name.
2396// 2. offset into __debug_str section for regular function name.
2397// 3. an unsigned LEB128 number indicating the number of distinct inlining
2398// instances for the function.
2399//
2400// The rest of the entry consists of a {die_offset, low_pc} pair for each
2401// inlined instance; the die_offset points to the inlined_subroutine die in the
2402// __debug_info section, and the low_pc is the starting address for the
2403// inlining instance.
Devang Patel2c4ceb12009-11-21 02:48:08 +00002404void DwarfDebug::emitDebugInlineInfo() {
Eric Christopherb83e2bb2012-03-02 02:11:47 +00002405 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002406 return;
2407
Devang Patel163a9f72010-05-10 22:49:55 +00002408 if (!FirstCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00002409 return;
2410
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002411 Asm->OutStreamer.SwitchSection(
2412 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattner0ad9c912010-01-22 22:09:00 +00002413
Chris Lattner233f52b2010-03-09 23:52:58 +00002414 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
Chris Lattnera6437182010-04-04 19:58:12 +00002415 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2416 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
Bill Wendling94d04b82009-05-20 23:21:38 +00002417
Chris Lattnerc0215722010-04-04 19:25:43 +00002418 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002419
Chris Lattner233f52b2010-03-09 23:52:58 +00002420 Asm->OutStreamer.AddComment("Dwarf Version");
2421 Asm->EmitInt16(dwarf::DWARF_VERSION);
2422 Asm->OutStreamer.AddComment("Address Size (in bytes)");
Chandler Carruth426c2bf2012-11-01 09:14:31 +00002423 Asm->EmitInt8(Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002424
Devang Patele9f8f5e2010-05-07 20:54:48 +00002425 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
Devang Patel53bb5c92009-11-10 23:06:00 +00002426 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach31ef40e2009-11-21 23:12:12 +00002427
Devang Patele9f8f5e2010-05-07 20:54:48 +00002428 const MDNode *Node = *I;
2429 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbach7ab38df2009-11-22 19:20:36 +00002430 = InlineInfo.find(Node);
Devang Patel53bb5c92009-11-10 23:06:00 +00002431 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00002432 DISubprogram SP(Node);
Devang Patel65dbc902009-11-25 17:36:49 +00002433 StringRef LName = SP.getLinkageName();
2434 StringRef Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00002435
Chris Lattner233f52b2010-03-09 23:52:58 +00002436 Asm->OutStreamer.AddComment("MIPS linkage name");
Eric Christopher50e26612012-03-02 01:57:52 +00002437 if (LName.empty())
Eric Christopher2e5d8702012-12-20 21:58:36 +00002438 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2439 DwarfStrSectionSym);
Eric Christopher50e26612012-03-02 01:57:52 +00002440 else
Eric Christopher2e5d8702012-12-20 21:58:36 +00002441 Asm->EmitSectionOffset(InfoHolder
2442 .getStringPoolEntry(getRealLinkageName(LName)),
Chris Lattner6189ed12010-04-04 23:25:33 +00002443 DwarfStrSectionSym);
Devang Patel53bb5c92009-11-10 23:06:00 +00002444
Chris Lattner233f52b2010-03-09 23:52:58 +00002445 Asm->OutStreamer.AddComment("Function name");
Eric Christopher2e5d8702012-12-20 21:58:36 +00002446 Asm->EmitSectionOffset(InfoHolder.getStringPoolEntry(Name),
2447 DwarfStrSectionSym);
Chris Lattner7e1a8f82010-04-04 19:09:29 +00002448 Asm->EmitULEB128(Labels.size(), "Inline count");
Bill Wendling94d04b82009-05-20 23:21:38 +00002449
Devang Patel53bb5c92009-11-10 23:06:00 +00002450 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00002451 LE = Labels.end(); LI != LE; ++LI) {
Chris Lattner3f53c832010-04-04 18:52:31 +00002452 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
Chris Lattner6ed0f902010-03-09 00:31:02 +00002453 Asm->EmitInt32(LI->second->getOffset());
Bill Wendling94d04b82009-05-20 23:21:38 +00002454
Chris Lattner3f53c832010-04-04 18:52:31 +00002455 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
Chris Lattnerd38fee82010-04-05 00:13:49 +00002456 Asm->OutStreamer.EmitSymbolValue(LI->first,
Eric Christopher1ced2082013-01-09 03:52:05 +00002457 Asm->getDataLayout().getPointerSize());
Bill Wendling94d04b82009-05-20 23:21:38 +00002458 }
2459 }
2460
Chris Lattnerc0215722010-04-04 19:25:43 +00002461 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));
Bill Wendling94d04b82009-05-20 23:21:38 +00002462}
Eric Christopher98e237f2012-11-30 23:59:06 +00002463
Eric Christopher0b944ee2012-12-11 19:42:09 +00002464// DWARF5 Experimental Separate Dwarf emitters.
Eric Christopher98e237f2012-11-30 23:59:06 +00002465
2466// This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2467// DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2468// DW_AT_ranges_base, DW_AT_addr_base. If DW_AT_ranges is present,
2469// DW_AT_low_pc and DW_AT_high_pc are not used, and vice versa.
Eric Christopher4daaed12012-12-10 19:51:21 +00002470CompileUnit *DwarfDebug::constructSkeletonCU(const MDNode *N) {
Eric Christopher98e237f2012-11-30 23:59:06 +00002471 DICompileUnit DIUnit(N);
Eric Christopher98e237f2012-11-30 23:59:06 +00002472 CompilationDir = DIUnit.getDirectory();
Eric Christopher98e237f2012-11-30 23:59:06 +00002473
2474 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Eli Benderskyd4a05e02012-12-03 18:45:45 +00002475 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++,
Eric Christopher2e5d8702012-12-20 21:58:36 +00002476 DIUnit.getLanguage(), Die, Asm,
Eric Christopher64f824c2012-12-27 02:14:01 +00002477 this, &SkeletonHolder);
Eric Christopher446b88f2013-01-17 03:00:04 +00002478
2479 SmallString<16> T(DIUnit.getFilename());
2480 sys::path::replace_extension(T, ".dwo");
2481 StringRef FN = sys::path::filename(T);
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002482 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name, FN);
Eric Christopher98e237f2012-11-30 23:59:06 +00002483
Eric Christopher208cc6f2013-02-05 07:31:55 +00002484 // This should be a unique identifier when we want to build .dwp files.
2485 NewCU->addUInt(Die, dwarf::DW_AT_GNU_dwo_id, dwarf::DW_FORM_data8, 0);
Eric Christopherd96c72a2013-01-17 02:59:59 +00002486
2487 // FIXME: The addr base should be relative for each compile unit, however,
2488 // this one is going to be 0 anyhow.
2489 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002490
2491 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002492 // into an entity. We're using 0, or a NULL label for this.
Eric Christopher98e237f2012-11-30 23:59:06 +00002493 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
Eric Christopher72f7bfb2013-01-15 23:56:56 +00002494
Eric Christopher98e237f2012-11-30 23:59:06 +00002495 // DW_AT_stmt_list is a offset of line number information for this
2496 // compile unit in debug_line section.
2497 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
Eric Christopher446b88f2013-01-17 03:00:04 +00002498 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
Eric Christopher7a0103c2013-02-07 21:19:50 +00002499 DwarfLineSectionSym);
Eric Christopher98e237f2012-11-30 23:59:06 +00002500 else
Eric Christopher446b88f2013-01-17 03:00:04 +00002501 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
Eric Christopher98e237f2012-11-30 23:59:06 +00002502
2503 if (!CompilationDir.empty())
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002504 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
Eric Christopher98e237f2012-11-30 23:59:06 +00002505
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002506 SkeletonHolder.addUnit(NewCU);
Eric Christopher01776a52013-02-06 21:53:56 +00002507 SkeletonCUs.push_back(NewCU);
Eric Christopher0e3e9b72012-12-10 23:34:43 +00002508
Eric Christopher98e237f2012-11-30 23:59:06 +00002509 return NewCU;
2510}
2511
Eric Christopher6eebe472012-12-19 22:02:53 +00002512void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
2513 assert(useSplitDwarf() && "No split dwarf debug info?");
2514 emitAbbrevs(Section, &SkeletonAbbrevs);
Eric Christopher98e237f2012-11-30 23:59:06 +00002515}
2516
Eric Christopher0b944ee2012-12-11 19:42:09 +00002517// Emit the .debug_info.dwo section for separated dwarf. This contains the
2518// compile units that would normally be in debug_info.
Eric Christopher98e237f2012-11-30 23:59:06 +00002519void DwarfDebug::emitDebugInfoDWO() {
Eric Christopher4daaed12012-12-10 19:51:21 +00002520 assert(useSplitDwarf() && "No split dwarf debug info?");
Eric Christopherb1e66d02012-12-15 00:04:07 +00002521 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
Eric Christopher6eebe472012-12-19 22:02:53 +00002522 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2523 DwarfAbbrevDWOSectionSym);
2524}
2525
2526// Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2527// abbreviations for the .debug_info.dwo section.
2528void DwarfDebug::emitDebugAbbrevDWO() {
2529 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopher72c16552012-12-20 21:58:40 +00002530 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2531 &Abbreviations);
Eric Christopher98e237f2012-11-30 23:59:06 +00002532}
Eric Christopher64f824c2012-12-27 02:14:01 +00002533
2534// Emit the .debug_str.dwo section for separated dwarf. This contains the
2535// string section and is identical in format to traditional .debug_str
2536// sections.
2537void DwarfDebug::emitDebugStrDWO() {
2538 assert(useSplitDwarf() && "No split dwarf?");
Eric Christopherff348452013-01-07 22:40:45 +00002539 const MCSection *OffSec = Asm->getObjFileLowering()
2540 .getDwarfStrOffDWOSection();
Eric Christopherdd8e9f32013-01-07 19:32:41 +00002541 const MCSymbol *StrSym = DwarfStrSectionSym;
2542 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2543 OffSec, StrSym);
Eric Christopher64f824c2012-12-27 02:14:01 +00002544}